gdbbridge.py 75 KB
Newer Older
hjk's avatar
hjk committed
1

2
3
4
5
6
7
8
9
10
try:
    import __builtin__
except:
    import builtins
try:
    import gdb
except:
    pass

hjk's avatar
hjk committed
11
import os
12
import os.path
13
import sys
14
import struct
15
import types
16

17
import importlib
hjk's avatar
hjk committed
18

19
20
def warn(message):
    print("XXX: %s\n" % message.encode("latin1"))
21

22
from dumper import *
23
24
25
26
27
28
29
30
31
32
33
34

dumpermodules = [
    "qttypes",
    "stdtypes",
    "misctypes",
    "boosttypes",
    "creatortypes",
    "personaltypes",
]

for mod in dumpermodules:
    importlib.import_module(mod)
hjk's avatar
hjk committed
35

36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130

#######################################################################
#
# Infrastructure
#
#######################################################################

def savePrint(output):
    try:
        print(output)
    except:
        out = ""
        for c in output:
            cc = ord(c)
            if cc > 127:
                out += "\\\\%d" % cc
            elif cc < 0:
                out += "\\\\%d" % (cc + 256)
            else:
                out += c
        print(out)

def registerCommand(name, func):

    class Command(gdb.Command):
        def __init__(self):
            super(Command, self).__init__(name, gdb.COMMAND_OBSCURE)
        def invoke(self, args, from_tty):
            savePrint(func(args))

    Command()



#######################################################################
#
# Types
#
#######################################################################

PointerCode = gdb.TYPE_CODE_PTR
ArrayCode = gdb.TYPE_CODE_ARRAY
StructCode = gdb.TYPE_CODE_STRUCT
UnionCode = gdb.TYPE_CODE_UNION
EnumCode = gdb.TYPE_CODE_ENUM
FlagsCode = gdb.TYPE_CODE_FLAGS
FunctionCode = gdb.TYPE_CODE_FUNC
IntCode = gdb.TYPE_CODE_INT
FloatCode = gdb.TYPE_CODE_FLT # Parts of GDB assume that this means complex.
VoidCode = gdb.TYPE_CODE_VOID
#SetCode = gdb.TYPE_CODE_SET
RangeCode = gdb.TYPE_CODE_RANGE
StringCode = gdb.TYPE_CODE_STRING
#BitStringCode = gdb.TYPE_CODE_BITSTRING
#ErrorTypeCode = gdb.TYPE_CODE_ERROR
MethodCode = gdb.TYPE_CODE_METHOD
MethodPointerCode = gdb.TYPE_CODE_METHODPTR
MemberPointerCode = gdb.TYPE_CODE_MEMBERPTR
ReferenceCode = gdb.TYPE_CODE_REF
CharCode = gdb.TYPE_CODE_CHAR
BoolCode = gdb.TYPE_CODE_BOOL
ComplexCode = gdb.TYPE_CODE_COMPLEX
TypedefCode = gdb.TYPE_CODE_TYPEDEF
NamespaceCode = gdb.TYPE_CODE_NAMESPACE
#Code = gdb.TYPE_CODE_DECFLOAT # Decimal floating point.
#Code = gdb.TYPE_CODE_MODULE # Fortran
#Code = gdb.TYPE_CODE_INTERNAL_FUNCTION


#######################################################################
#
# Convenience
#
#######################################################################

# Just convienience for 'python print ...'
class PPCommand(gdb.Command):
    def __init__(self):
        super(PPCommand, self).__init__("pp", gdb.COMMAND_OBSCURE)
    def invoke(self, args, from_tty):
        print(eval(args))

PPCommand()

# Just convienience for 'python print gdb.parse_and_eval(...)'
class PPPCommand(gdb.Command):
    def __init__(self):
        super(PPPCommand, self).__init__("ppp", gdb.COMMAND_OBSCURE)
    def invoke(self, args, from_tty):
        print(gdb.parse_and_eval(args))

PPPCommand()


def scanStack(p, n):
131
    p = int(p)
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
    r = []
    for i in xrange(n):
        f = gdb.parse_and_eval("{void*}%s" % p)
        m = gdb.execute("info symbol %s" % f, to_string=True)
        if not m.startswith("No symbol matches"):
            r.append(m)
        p += f.type.sizeof
    return r

class ScanStackCommand(gdb.Command):
    def __init__(self):
        super(ScanStackCommand, self).__init__("scanStack", gdb.COMMAND_OBSCURE)
    def invoke(self, args, from_tty):
        if len(args) == 0:
            args = 20
        savePrint(scanStack(gdb.parse_and_eval("$sp"), int(args)))

ScanStackCommand()

hjk's avatar
hjk committed
151

152
def bbsetup(args = ''):
153
154
    theDumper.bbsetup()
    print(theDumper.reportDumpers())
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169

registerCommand("bbsetup", bbsetup)


#######################################################################
#
# Import plain gdb pretty printers
#
#######################################################################

class PlainDumper:
    def __init__(self, printer):
        self.printer = printer

    def __call__(self, d, value):
170
        printer = self.printer.invoke(value)
171
172
173
        lister = getattr(printer, "children", None)
        children = [] if lister is None else list(lister())
        d.putType(self.printer.name)
174
175
176
177
178
179
        val = printer.to_string()
        if isinstance(val, str):
            d.putValue(val)
        else: # Assuming LazyString
            d.putStdStringHelper(val.address, val.length, val.type.sizeof)

180
181
182
183
184
185
186
        d.putNumChild(len(children))
        if d.isExpanded():
            with Children(d):
                for child in children:
                    d.putSubItem(child[0], child[1])

def importPlainDumpers(args):
187
188
189
190
    if args == "off":
        gdb.execute("disable pretty-printer .* .*")
    else:
        theDumper.importPlainDumpers()
191
192
193
194

registerCommand("importPlainDumpers", importPlainDumpers)


195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215

class OutputSafer:
    def __init__(self, d):
        self.d = d

    def __enter__(self):
        self.savedOutput = self.d.output
        self.d.output = []

    def __exit__(self, exType, exValue, exTraceBack):
        if self.d.passExceptions and not exType is None:
            showException("OUTPUTSAFER", exType, exValue, exTraceBack)
            self.d.output = self.savedOutput
        else:
            self.savedOutput.extend(self.d.output)
            self.d.output = self.savedOutput
        return False



#def couldBePointer(p, align):
216
217
#    typeobj = lookupType("unsigned int")
#    ptr = gdb.Value(p).cast(typeobj)
218
219
220
221
222
223
224
225
226
#    d = int(str(ptr))
#    warn("CHECKING : %s %d " % (p, ((d & 3) == 0 and (d > 1000 or d == 0))))
#    return (d & (align - 1)) and (d > 1000 or d == 0)


Value = gdb.Value



227
228
229
230
231
def stripTypedefs(typeobj):
    typeobj = typeobj.unqualified()
    while typeobj.code == TypedefCode:
        typeobj = typeobj.strip_typedefs().unqualified()
    return typeobj
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251


#######################################################################
#
# LocalItem
#
#######################################################################

# Contains iname, name, and value.
class LocalItem:
    pass


#######################################################################
#
# Edit Command
#
#######################################################################

def bbedit(args):
252
    theDumper.bbedit(args)
253
254
255
256
257
258
259
260
261
262

registerCommand("bbedit", bbedit)


#######################################################################
#
# Frame Command
#
#######################################################################

263

264
def bb(args):
265
266
267
268
269
    try:
        print(theDumper.run(args))
    except:
        import traceback
        traceback.print_exc()
270
271

registerCommand("bb", bb)
272

273
274
275
276
277
278
279
#######################################################################
#
# The Dumper Class
#
#######################################################################


280
281
class Dumper(DumperBase):

282
    def __init__(self):
283
284
        DumperBase.__init__(self)

285
        # These values will be kept between calls to 'run'.
286
        self.isGdb = True
287
        self.childEventAddress = None
288
289
        self.typesReported = {}
        self.typesToReport = {}
290
        self.qtNamespaceToReport = None
291
        self.qmlEngines = []
292

293
    def prepare(self, args):
294
295
296
297
298
299
300
        self.output = []
        self.currentIName = ""
        self.currentPrintsAddress = True
        self.currentChildType = ""
        self.currentChildNumChild = -1
        self.currentMaxNumChild = -1
        self.currentNumChild = -1
301
302
        self.currentValue = ReportItem()
        self.currentType = ReportItem()
303
304
305
306
307
        self.currentAddress = None
        self.typeformats = {}
        self.formats = {}
        self.useDynamicType = True
        self.expandedINames = {}
308
        self.qmlcontext = ""
309

310
311
312
313
314
        # The guess does not need to be updated during a run()
        # as the result is fixed during that time (ignoring "active"
        # dumpers causing loading of shared objects etc).
        self.currentQtNamespaceGuess = None

315
316
317
318
        self.watchers = ""
        self.resultVarName = ""
        self.varList = []
        self.options = []
319
320
321
322

        for arg in args.split(' '):
            pos = arg.find(":") + 1
            if arg.startswith("options:"):
323
                self.options = arg[pos:].split(",")
324
325
            elif arg.startswith("vars:"):
                if len(arg[pos:]) > 0:
326
                    self.varList = arg[pos:].split(",")
327
            elif arg.startswith("resultvarname:"):
328
                self.resultVarName = arg[pos:]
329
330
            elif arg.startswith("expanded:"):
                self.expandedINames = set(arg[pos:].split(","))
331
332
            elif arg.startswith("stringcutoff:"):
                self.stringCutOff = int(arg[pos:])
333
334
            elif arg.startswith("displaystringlimit:"):
                self.displayStringLimit = int(arg[pos:])
335
336
337
338
            elif arg.startswith("typeformats:"):
                for f in arg[pos:].split(","):
                    pos = f.find("=")
                    if pos != -1:
339
340
                        typeName = self.hexdecode(f[0:pos])
                        self.typeformats[typeName] = int(f[pos+1:])
341
342
343
344
345
346
            elif arg.startswith("formats:"):
                for f in arg[pos:].split(","):
                    pos = f.find("=")
                    if pos != -1:
                        self.formats[f[0:pos]] = int(f[pos+1:])
            elif arg.startswith("watchers:"):
347
                self.watchers = self.hexdecode(arg[pos:])
348
349
            elif arg.startswith("qmlcontext:"):
                self.qmlcontext = int(arg[pos:], 0)
350

351
352
353
354
        self.useDynamicType = "dyntype" in self.options
        self.useFancy = "fancy" in self.options
        self.forceQtNamespace = "forcens" in self.options
        self.passExceptions = "pe" in self.options
355
        self.nativeMixed = "nativemixed" in self.options
356
357
358
        self.autoDerefPointers = "autoderef" in self.options
        self.partialUpdate = "partial" in self.options
        self.tooltipOnly = "tooltiponly" in self.options
359
        self.fallbackQtVersion = 0x50200
360
        #warn("NAMESPACE: '%s'" % self.qtNamespace())
361
        #warn("VARIABLES: %s" % self.varList)
362
        #warn("EXPANDED INAMES: %s" % self.expandedINames)
363
        #warn("WATCHERS: %s" % self.watchers)
364
365
        #warn("PARTIAL: %s" % self.partialUpdate)

366
367
368
369
370
371
372
    def handleWatches(self):
        with OutputSafer(self):
            if len(self.watchers) > 0:
                for watcher in self.watchers.split("##"):
                    (exp, iname) = watcher.split("#")
                    self.handleWatch(exp, exp, iname)

373
374
375
    def listOfLocals(self):
        frame = gdb.selected_frame()

376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
        if self.qmlcontext:
            items = []

            contextType = self.lookupQtType("QV4::Heap::CallContext")
            context = self.createPointerValue(self.qmlcontext, contextType)

            contextItem = LocalItem()
            contextItem.iname = "local.@context"
            contextItem.name = "[context]"
            contextItem.value = context.dereference()
            items.append(contextItem)

            argsItem = LocalItem()
            argsItem.iname = "local.@args"
            argsItem.name = "[args]"
            argsItem.value = context["callData"]
            items.append(argsItem)

            functionObject = context["function"].dereference()
            functionPtr = functionObject["function"]
            if not self.isNull(functionPtr):
                compilationUnit = context["compilationUnit"]
                compiledFunction = functionPtr["compiledFunction"]
                base = int(compiledFunction)

                formalsOffset = int(compiledFunction["formalsOffset"])
                formalsCount = int(compiledFunction["nFormals"])
                for index in range(formalsCount):
                    stringIndex = self.extractInt(base + formalsOffset + 4 * index)
                    name = self.extractQmlRuntimeString(compilationUnit, stringIndex)
                    item = LocalItem()
                    item.iname = "local." + name
                    item.name = name
                    item.value = argsItem.value["args"][index]
                    items.append(item)

                localsOffset = int(compiledFunction["localsOffset"])
                localsCount = int(compiledFunction["nLocals"])
                for index in range(localsCount):
                    stringIndex = self.extractInt(base + localsOffset + 4 * index)
                    name = self.extractQmlRuntimeString(compilationUnit, stringIndex)
                    item = LocalItem()
                    item.iname = "local." + name
                    item.name = name
                    item.value = contextData["locals"][index]
                    items.append(item)

            for engine in self.qmlEngines:
                engineItem = LocalItem()
                engineItem.iname = "local.@qmlengine"
                engineItem.name = "[engine]"
                engineItem.value = engine
                items.append(engineItem)

                rootContext = LocalItem()
                rootContext.iname = "local.@rootContext"
                rootContext.name = "[rootContext]"
                rootContext.value = engine["d_ptr"]
                items.append(rootContext)
                break

            return items
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516

        try:
            block = frame.block()
            #warn("BLOCK: %s " % block)
        except RuntimeError as error:
            #warn("BLOCK IN FRAME NOT ACCESSIBLE: %s" % error)
            return []
        except:
            warn("BLOCK NOT ACCESSIBLE FOR UNKNOWN REASONS")
            return []

        items = []
        shadowed = {}
        while True:
            if block is None:
                warn("UNEXPECTED 'None' BLOCK")
                break
            for symbol in block:
                name = symbol.print_name

                if name == "__in_chrg" or name == "__PRETTY_FUNCTION__":
                    continue

                # "NotImplementedError: Symbol type not yet supported in
                # Python scripts."
                #warn("SYMBOL %s  (%s): " % (symbol, name))
                if name in shadowed:
                    level = shadowed[name]
                    name1 = "%s@%s" % (name, level)
                    shadowed[name] = level + 1
                else:
                    name1 = name
                    shadowed[name] = 1
                #warn("SYMBOL %s  (%s, %s)): " % (symbol, name, symbol.name))
                item = LocalItem()
                item.iname = "local." + name1
                item.name = name1
                try:
                    item.value = frame.read_var(name, block)
                    #warn("READ 1: %s" % item.value)
                    items.append(item)
                    continue
                except:
                    pass

                try:
                    #warn("READ 2: %s" % item.value)
                    item.value = frame.read_var(name)
                    items.append(item)
                    continue
                except:
                    # RuntimeError: happens for
                    #     void foo() { std::string s; std::wstring w; }
                    # ValueError: happens for (as of 2010/11/4)
                    #     a local struct as found e.g. in
                    #     gcc sources in gcc.c, int execute()
                    pass

                try:
                    #warn("READ 3: %s %s" % (name, item.value))
                    item.value = gdb.parse_and_eval(name)
                    #warn("ITEM 3: %s" % item.value)
                    items.append(item)
                except:
                    # Can happen in inlined code (see last line of
                    # RowPainter::paintChars(): "RuntimeError:
                    # No symbol \"__val\" in current context.\n"
                    pass

            # The outermost block in a function has the function member
            # FIXME: check whether this is guaranteed.
            if not block.function is None:
                break

            block = block.superblock

        return items


517
518
519
    def run(self, args):
        self.prepare(args)

520
521
522
        #
        # Locals
        #
523
        self.output.append('data=[')
524
525
        if self.partialUpdate and len(self.varList) == 1 \
                and not self.qmlcontext:
526
527
            #warn("PARTIAL: %s" % self.varList)
            parts = self.varList[0].split('.')
528
529
530
            #warn("PARTIAL PARTS: %s" % parts)
            name = parts[1]
            #warn("PARTIAL VAR: %s" % name)
531
532
533
            item = LocalItem()
            item.iname = parts[0] + '.' + name
            item.name = name
534
            try:
535
536
537
538
539
540
541
542
                if parts[0] == 'local':
                    frame = gdb.selected_frame()
                    item.value = frame.read_var(name)
                else:
                    item.name = self.hexdecode(name)
                    item.value = gdb.parse_and_eval(item.name)
            except RuntimeError as error:
                item.value = error
543
            except:
544
545
546
547
                item.value = "<no value>"
            locals = [item]
            #warn("PARTIAL LOCALS: %s" % locals)
        else:
548
            locals = self.listOfLocals()
549
550

        # Take care of the return value of the last function call.
551
        if len(self.resultVarName) > 0:
552
553
            try:
                item = LocalItem()
554
555
556
                item.name = self.resultVarName
                item.iname = "return." + self.resultVarName
                item.value = self.parseAndEvaluate(self.resultVarName)
557
558
559
560
561
562
                locals.append(item)
            except:
                # Don't bother. It's only supplementary information anyway.
                pass

        for item in locals:
563
            value = self.downcast(item.value) if self.useDynamicType else item.value
564
565
566
            with OutputSafer(self):
                self.anonNumber = -1

567
568
                if item.iname == "local.argv" and str(value.type) == "char **":
                    self.putSpecialArgv(value)
569
570
571
572
573
574
575
                else:
                    # A "normal" local variable or parameter.
                    with TopLevelItem(self, item.iname):
                        self.put('iname="%s",' % item.iname)
                        self.put('name="%s",' % item.name)
                        self.putItem(value)

576
        self.handleWatches()
577

578
        #print('data=[' + locals + sep + self.watchers + ']\n')
579

580
581
        self.output.append('],typeinfo=[')
        for name in self.typesToReport.keys():
582
            typeobj = self.typesToReport[name]
583
            # Happens e.g. for '(anonymous namespace)::InsertDefOperation'
584
            if not typeobj is None:
585
                self.output.append('{name="%s",size="%s"}'
586
                    % (self.hexencode(name), typeobj.sizeof))
587
588
        self.output.append(']')
        self.typesToReport = {}
589

590
        if "forcens" in self.options:
591
            self.qtNamepaceToReport = self.qtNamespace()
592

593
594
595
596
        if self.qtNamespaceToReport:
            self.output.append(',qtnamespace="%s"' % self.qtNamespaceToReport)
            self.qtNamespaceToReport = None

597
        return "".join(self.output)
598

599
600
601
602
603
604
605
606
607
608
609
610
611
    def enterSubItem(self, item):
        if not item.iname:
            item.iname = "%s.%s" % (self.currentIName, item.name)
        #warn("INAME %s" % item.iname)
        self.put('{')
        #if not item.name is None:
        if isinstance(item.name, str):
            self.put('name="%s",' % item.name)
        item.savedIName = self.currentIName
        item.savedValue = self.currentValue
        item.savedType = self.currentType
        item.savedCurrentAddress = self.currentAddress
        self.currentIName = item.iname
612
613
        self.currentValue = ReportItem();
        self.currentType = ReportItem();
614
615
616
        self.currentAddress = None

    def exitSubItem(self, item, exType, exValue, exTraceBack):
hjk's avatar
hjk committed
617
        #warn("CURRENT VALUE: %s: %s %s" % (self.currentIName, self.currentValue, self.currentType))
618
619
620
621
622
623
        if not exType is None:
            if self.passExceptions:
                showException("SUBITEM", exType, exValue, exTraceBack)
            self.putNumChild(0)
            self.putValue("<not accessible>")
        try:
hjk's avatar
hjk committed
624
            if self.currentType.value:
625
                typeName = self.stripClassTag(self.currentType.value)
hjk's avatar
hjk committed
626
627
                if len(typeName) > 0 and typeName != self.currentChildType:
                    self.put('type="%s",' % typeName) # str(type.unqualified()) ?
628

629
            if  self.currentValue.value is None:
630
631
                self.put('value="<not accessible>",numchild="0",')
            else:
632
633
634
635
636
                if not self.currentValue.encoding is None:
                    self.put('valueencoded="%d",' % self.currentValue.encoding)
                if self.currentValue.elided:
                    self.put('valueelided="%d",' % self.currentValue.elided)
                self.put('value="%s",' % self.currentValue.value)
637
638
639
640
641
642
643
644
645
646
647
        except:
            pass
        if not self.currentAddress is None:
            self.put(self.currentAddress)
        self.put('},')
        self.currentIName = item.savedIName
        self.currentValue = item.savedValue
        self.currentType = item.savedType
        self.currentAddress = item.savedCurrentAddress
        return True

648
649
650
    def parseAndEvaluate(self, exp):
        return gdb.parse_and_eval(exp)

651
    def callHelper(self, value, func, args):
652
653
654
655
656
657
658
659
660
661
662
663
        # args is a tuple.
        arg = ""
        for i in range(len(args)):
            if i:
                arg += ','
            a = args[i]
            if (':' in a) and not ("'" in a):
                arg = "'%s'" % a
            else:
                arg += a

        #warn("CALL: %s -> %s(%s)" % (value, func, arg))
664
        typeName = self.stripClassTag(str(value.type))
665
666
        if typeName.find(":") >= 0:
            typeName = "'" + typeName + "'"
667
        # 'class' is needed, see http://sourceware.org/bugzilla/show_bug.cgi?id=11912
668
669
670
        #exp = "((class %s*)%s)->%s(%s)" % (typeName, value.address, func, arg)
        ptr = value.address if value.address else self.pokeValue(value)
        exp = "((%s*)%s)->%s(%s)" % (typeName, ptr, func, arg)
671
        #warn("CALL: %s" % exp)
672
        result = gdb.parse_and_eval(exp)
673
        #warn("  -> %s" % result)
674
675
        if not value.address:
            gdb.parse_and_eval("free(0x%x)" % ptr)
676
677
        return result

hjk's avatar
hjk committed
678
    def childWithName(self, value, name):
679
        try:
hjk's avatar
hjk committed
680
            return value[name]
681
        except:
hjk's avatar
hjk committed
682
            return None
683

684
685
    def makeValue(self, typeobj, init):
        typename = "::" + self.stripClassTag(str(typeobj));
hjk's avatar
hjk committed
686
        # Avoid malloc symbol clash with QVector.
687
        gdb.execute("set $d = (%s*)calloc(sizeof(%s), 1)" % (typename, typename))
hjk's avatar
hjk committed
688
        gdb.execute("set *$d = {%s}" % init)
hjk's avatar
hjk committed
689
        value = gdb.parse_and_eval("$d").dereference()
hjk's avatar
hjk committed
690
691
692
693
694
695
        #warn("  TYPE: %s" % value.type)
        #warn("  ADDR: %s" % value.address)
        #warn("  VALUE: %s" % value)
        return value

    def makeExpression(self, value):
696
697
698
699
        typename = "::" + self.stripClassTag(str(value.type))
        #warn("  TYPE: %s" % typename)
        #exp = "(*(%s*)(&%s))" % (typename, value.address)
        exp = "(*(%s*)(%s))" % (typename, value.address)
hjk's avatar
hjk committed
700
701
702
703
704
705
706
707
        #warn("  EXP: %s" % exp)
        return exp

    def makeStdString(init):
        # Works only for small allocators, but they are usually empty.
        gdb.execute("set $d=(std::string*)calloc(sizeof(std::string), 2)");
        gdb.execute("call($d->basic_string(\"" + init +
            "\",*(std::allocator<char>*)(1+$d)))")
hjk's avatar
hjk committed
708
        value = gdb.parse_and_eval("$d").dereference()
hjk's avatar
hjk committed
709
710
711
712
713
        #warn("  TYPE: %s" % value.type)
        #warn("  ADDR: %s" % value.address)
        #warn("  VALUE: %s" % value)
        return value

714
715
    def childAt(self, value, index):
        field = value.type.fields()[index]
716
717
718
719
720
721
722
723
724
725
726
727
728
        try:
            # Official access in GDB 7.6 or later.
            return value[field]
        except:
            pass

        try:
            # Won't work with anon entities, tradionally with empty
            # field name, but starting with GDB 7.7 commit b5b08fb4
            # with None field name.
            return value[field.name]
        except:
            pass
729

730
731
732
733
734
735
        # FIXME: Cheat. There seems to be no official way to access
        # the real item, so we pass back the value. That at least
        # enables later ...["name"] style accesses as gdb handles
        # them transparently.
        return value

736
737
    def fieldAt(self, typeobj, index):
        return typeobj.fields()[index]
738

739
740
741
    def simpleValue(self, value):
        return str(value)

742
    def directBaseClass(self, typeobj, index = 0):
743
744
745
746
747
        for f in typeobj.fields():
            if f.is_base_class:
                if index == 0:
                    return f.type
                index -= 1;
hjk's avatar
hjk committed
748
749
750
751
752
753
754
755
        return None

    def directBaseObject(self, value, index = 0):
        for f in value.type.fields():
            if f.is_base_class:
                if index == 0:
                    return value.cast(f.type)
                index -= 1;
756
        return None
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771

    def checkPointer(self, p, align = 1):
        if not self.isNull(p):
            p.dereference()

    def pointerValue(self, p):
        return toInteger(p)

    def isNull(self, p):
        # The following can cause evaluation to abort with "UnicodeEncodeError"
        # for invalid char *, as their "contents" is being examined
        #s = str(p)
        #return s == "0x0" or s.startswith("0x0 ")
        #try:
        #    # Can fail with: "RuntimeError: Cannot access memory at address 0x5"
hjk's avatar
hjk committed
772
        #    return p.cast(self.lookupType("void").pointer()) == 0
773
774
775
776
777
778
779
780
        #except:
        #    return False
        try:
            # Can fail with: "RuntimeError: Cannot access memory at address 0x5"
            return toInteger(p) == 0
        except:
            return False

781
    def templateArgument(self, typeobj, position):
782
783
784
785
786
787
788
        try:
            # This fails on stock 7.2 with
            # "RuntimeError: No type named myns::QObject.\n"
            return typeobj.template_argument(position)
        except:
            # That's something like "myns::QList<...>"
            return self.lookupType(self.extractTemplateArgument(str(typeobj.strip_typedefs()), position))
789
790

    def numericTemplateArgument(self, typeobj, position):
791
792
793
794
795
796
797
798
799
800
801
802
        # Workaround for gdb < 7.1
        try:
            return int(typeobj.template_argument(position))
        except RuntimeError as error:
            # ": No type named 30."
            msg = str(error)
            msg = msg[14:-1]
            # gdb at least until 7.4 produces for std::array<int, 4u>
            # for template_argument(1): RuntimeError: No type named 4u.
            if msg[-1] == 'u':
               msg = msg[0:-1]
            return int(msg)
803

804
    def intType(self):
805
806
807
        self.cachedIntType = self.lookupType('int')
        self.intType = lambda: self.cachedIntType
        return self.cachedIntType
808
809

    def charType(self):
hjk's avatar
hjk committed
810
        return self.lookupType('char')
811
812

    def sizetType(self):
hjk's avatar
hjk committed
813
        return self.lookupType('size_t')
814
815

    def charPtrType(self):
hjk's avatar
hjk committed
816
        return self.lookupType('char*')
817
818

    def voidPtrType(self):
hjk's avatar
hjk committed
819
        return self.lookupType('void*')
820

821
    def addressOf(self, value):
822
        return toInteger(value.address)
823

824
    def createPointerValue(self, address, pointeeType):
825
826
827
828
829
830
831
832
        # This might not always work:
        # a Python 3 based GDB due to the bug addressed in
        # https://sourceware.org/ml/gdb-patches/2013-09/msg00571.html
        try:
            return gdb.Value(address).cast(pointeeType.pointer())
        except:
            # Try _some_ fallback (good enough for the std::complex dumper)
            return gdb.parse_and_eval("(%s*)%s" % (pointeeType, address))
833
834
835
836
837

    def intSize(self):
        return 4

    def ptrSize(self):
838
839
840
        self.cachedPtrSize = self.lookupType('void*').sizeof
        self.ptrSize = lambda: self.cachedPtrSize
        return self.cachedPtrSize
841

842
843
844
845
846
847
848
849
850
851
852
853
854
855
    def pokeValue(self, value):
        """
        Allocates inferior memory and copies the contents of value.
        Returns a pointer to the copy.
        """
        # Avoid malloc symbol clash with QVector
        size = value.type.sizeof
        data = value.cast(gdb.lookup_type("unsigned char").array(0, int(size - 1)))
        string = ''.join("\\x%02x" % int(data[i]) for i in range(size))
        exp = '(%s*)memcpy(calloc(%s, 1), "%s", %s)' % (value.type, size, string, size)
        #warn("EXP: %s" % exp)
        return toInteger(gdb.parse_and_eval(exp))


856
    def createValue(self, address, referencedType):
857
858
859
860
861
        try:
            return gdb.Value(address).cast(referencedType.pointer()).dereference()
        except:
            # Try _some_ fallback (good enough for the std::complex dumper)
            return gdb.parse_and_eval("{%s}%s" % (referencedType, address))
862

863
864
    def setValue(self, address, typename, value):
        cmd = "set {%s}%s=%s" % (typename, address, value)
865
866
        gdb.execute(cmd)

867
    def setValues(self, address, typename, values):
868
        cmd = "set {%s[%s]}%s={%s}" \
869
            % (typename, len(values), address, ','.join(map(str, values)))
870
871
        gdb.execute(cmd)

872
873
    def selectedInferior(self):
        try:
874
            # gdb.Inferior is new in gdb 7.2
875
            self.cachedInferior = gdb.selected_inferior()
876
877
        except:
            # Pre gdb 7.4. Right now we don't have more than one inferior anyway.
878
879
880
881
882
            self.cachedInferior = gdb.inferiors()[0]

        # Memoize result.
        self.selectedInferior = lambda: self.cachedInferior
        return self.cachedInferior
883

884
    def readRawMemory(self, addr, size):
885
        mem = self.selectedInferior().read_memory(addr, size)
886
887
888
889
        if sys.version_info[0] >= 3:
            mem.tobytes()
        return mem

890
891
892
    def extractInt64(self, addr):
        return struct.unpack("q", self.readRawMemory(addr, 8))[0]

893
    def extractInt(self, addr):
894
        return struct.unpack("i", self.readRawMemory(addr, 4))[0]
895

896
    def extractByte(self, addr):
897
        return struct.unpack("b", self.readRawMemory(addr, 1))[0]
898

899
900
    def findStaticMetaObject(self, typename):
        return self.findSymbol(typename + "::staticMetaObject")
901

902
903
904
905
906
907
908
909
    def findSymbol(self, symbolName):
        try:
            result = gdb.lookup_global_symbol(symbolName)
            return result.value() if result else 0
        except:
            pass
        # Older GDB ~7.4
        try:
910
            address = gdb.parse_and_eval("&'%s'" % symbolName)
911
912
            typeobj = gdb.lookup_type(self.qtNamespace() + "QMetaObject")
            return self.createPointerValue(address, typeobj)
913
914
        except:
            return 0
915

916
917
918
919
920
    def put(self, value):
        self.output.append(value)

    def childRange(self):
        if self.currentMaxNumChild is None:
921
922
            return xrange(0, toInteger(self.currentNumChild))
        return xrange(min(toInteger(self.currentMaxNumChild), toInteger(self.currentNumChild)))
923

924
925
926
927
928
929
    def isArmArchitecture(self):
        return 'arm' in gdb.TARGET_CONFIG.lower()

    def isQnxTarget(self):
        return 'qnx' in gdb.TARGET_CONFIG.lower()

930
931
932
933
    def isWindowsTarget(self):
        # We get i686-w64-mingw32
        return 'mingw' in gdb.TARGET_CONFIG.lower()

hjk's avatar
hjk committed
934
935
936
937
938
    def qtVersionString(self):
        try:
            return str(gdb.lookup_symbol("qVersion")[0].value()())
        except:
            pass
939
        try:
940
            ns = self.qtNamespace()
hjk's avatar
hjk committed
941
942
943
944
945
946
947
948
            return str(gdb.parse_and_eval("((const char*(*)())'%sqVersion')()" % ns))
        except:
            pass
        return None

    def qtVersion(self):
        try:
            version = self.qtVersionString()
949
            (major, minor, patch) = version[version.find('"')+1:version.rfind('"')].split('.')
hjk's avatar
hjk committed
950
951
952
            qtversion = 0x10000 * int(major) + 0x100 * int(minor) + int(patch)
            self.qtVersion = lambda: qtversion
            return qtversion
953
        except:
954
955
            # Use fallback until we have a better answer.
            return self.fallbackQtVersion
956

957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
    def isQt3Support(self):
        if self.qtVersion() >= 0x050000:
            return False
        else:
            try:
                # This will fail on Qt 4 without Qt 3 support
                gdb.execute("ptype QChar::null", to_string=True)
                self.cachedIsQt3Suport = True
            except:
                self.cachedIsQt3Suport = False

        # Memoize good results.
        self.isQt3Support = lambda: self.cachedIsQt3Suport
        return self.cachedIsQt3Suport

972
    def putAddress(self, addr):
973
        if self.currentPrintsAddress and not self.isCli:
974
            try:
975
976
977
                # addr can be "None", int(None) fails.
                #self.put('addr="0x%x",' % int(addr))
                self.currentAddress = 'addr="0x%x",' % toInteger(addr)
978
979
980
981
982
983
984
985
            except:
                pass

    def putNumChild(self, numchild):
        #warn("NUM CHILD: '%s' '%s'" % (numchild, self.currentChildNumChild))
        if numchild != self.currentChildNumChild:
            self.put('numchild="%s",' % numchild)

hjk's avatar
hjk committed
986
987
988
    def putSimpleValue(self, value, encoding = None, priority = 0):
        self.putValue(value, encoding, priority)

989
990
991
992
993
994
    def putPointerValue(self, value):
        # Use a lower priority
        if value is None:
            self.putEmptyValue(-1)
        else:
            self.putValue("0x%x" % value.cast(
hjk's avatar
hjk committed
995
                self.lookupType("unsigned long")), None, -1)
996
997

    def stripNamespaceFromType(self, typeName):
998
        typename = self.stripClassTag(typeName)
999
        ns = self.qtNamespace()
1000
1001
1002
        if len(ns) > 0 and typename.startswith(ns):
            typename = typename[len(ns):]
        pos = typename.find("<")
1003
1004
        # FIXME: make it recognize  foo<A>::bar<B>::iterator?
        while pos != -1:
1005
1006
1007
1008
            pos1 = typename.rfind(">", pos)
            typename = typename[0:pos] + typename[pos1+1:]
            pos = typename.find("<")
        return typename
1009

1010
1011
    def isMovableType(self, typeobj):
        if typeobj.code == PointerCode:
1012
            return True
1013
        if self.isSimpleType(typeobj):
1014
            return True
1015
        return self.isKnownMovableType(self.stripNamespaceFromType(str(typeobj)))
1016
1017
1018
1019
1020

    def putSubItem(self, component, value, tryDynamic=True):
        with SubItem(self, component):
            self.putItem(value, tryDynamic)

1021
1022
1023
1024
1025
1026
    def isSimpleType(self, typeobj):
        code = typeobj.code
        return code == BoolCode \
            or code == CharCode \
            or code == IntCode \
            or code == FloatCode \
1027
            or code == EnumCode
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058

    def simpleEncoding(self, typeobj):
        code = typeobj.code
        if code == BoolCode or code == CharCode:
            return Hex2EncodedInt1
        if code == IntCode:
            if str(typeobj).find("unsigned") >= 0:
                if typeobj.sizeof == 1:
                    return Hex2EncodedUInt1
                if typeobj.sizeof == 2:
                    return Hex2EncodedUInt2
                if typeobj.sizeof == 4:
                    return Hex2EncodedUInt4
                if typeobj.sizeof == 8:
                    return Hex2EncodedUInt8
            else:
                if typeobj.sizeof == 1:
                    return Hex2EncodedInt1
                if typeobj.sizeof == 2:
                    return Hex2EncodedInt2
                if typeobj.sizeof == 4:
                    return Hex2EncodedInt4
                if typeobj.sizeof == 8:
                    return Hex2EncodedInt8
        if code == FloatCode:
            if typeobj.sizeof == 4:
                return Hex2EncodedFloat4
            if typeobj.sizeof == 8:
                return Hex2EncodedFloat8
        return None

hjk's avatar
hjk committed
1059
1060
1061
1062
1063
1064
    def isReferenceType(self, typeobj):
        return typeobj.code == gdb.TYPE_CODE_REF

    def isStructType(self, typeobj):
        return typeobj.code == gdb.TYPE_CODE_STRUCT

1065
1066
    def isFunctionType(self, typeobj):
        return typeobj.code == MethodCode or typeobj.code == FunctionCode
hjk's avatar
hjk committed
1067

1068
1069
1070
1071
1072
1073
1074
1075
1076
    def putItem(self, value, tryDynamic=True):
        if value is None:
            # Happens for non-available watchers in gdb versions that
            # need to use gdb.execute instead of gdb.parse_and_eval
            self.putValue("<not available>")
            self.putType("<unknown>")
            self.putNumChild(0)
            return

1077
1078
        typeobj = value.type.unqualified()
        typeName = str(typeobj)
1079
1080
1081
1082
1083
1084
1085

        if value.is_optimized_out:
            self.putValue("<optimized out>")
            self.putType(typeName)
            self.putNumChild(0)
            return

1086
        tryDynamic &= self.useDynamicType
1087
        self.addToCache(typeobj) # Fill type cache
1088
1089
1090
1091
1092
        if tryDynamic:
            self.putAddress(value.address)

        # FIXME: Gui shows references stripped?
        #warn(" ")
1093
1094
1095
1096
        #warn("REAL INAME: %s" % self.currentIName)
        #warn("REAL TYPE: %s" % value.type)
        #warn("REAL CODE: %s" % value.type.code)
        #warn("REAL VALUE: %s" % value)
1097

1098
        if typeobj.code == ReferenceCode:
1099
1100
            try:
                # Try to recognize null references explicitly.
1101
                if toInteger(value.address) == 0:
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
                    self.putValue("<null reference>")
                    self.putType(typeName)
                    self.putNumChild(0)
                    return
            except:
                pass

            if tryDynamic:
                try:
                    # Dynamic references are not supported by gdb, see
                    # http://sourceware.org/bugzilla/show_bug.cgi?id=14077.
                    # Find the dynamic type manually using referenced_type.
                    value = value.referenced_value()
                    value = value.cast(value.dynamic_type)
                    self.putItem(value)
                    self.putBetterType("%s &" % value.type)
                    return
                except:
                    pass

            try:
                # FIXME: This throws "RuntimeError: Attempt to dereference a
                # generic pointer." with MinGW's gcc 4.5 when it "identifies"
                # a "QWidget &" as "void &" and with optimized out code.
1126
                self.putItem(value.cast(typeobj.target().unqualified()))
hjk's avatar
hjk committed
1127
                self.putBetterType("%s &" % self.currentType.value)
1128
1129
1130
1131
1132
1133
1134
                return
            except RuntimeError:
                self.putValue("<optimized out reference>")
                self.putType(typeName)
                self.putNumChild(0)
                return

1135
        if typeobj.code == IntCode or typeobj.code == CharCode:
1136
            self.putType(typeName)
1137
            if typeobj.sizeof == 1:
1138
1139
                # Force unadorned value transport for char and Co.
                self.putValue(int(value) & 0xff)
1140
1141
1142
1143
1144
            else:
                self.putValue(value)
            self.putNumChild(0)
            return

1145
        if typeobj.code == FloatCode or typeobj.code == BoolCode:
1146
            self.putType(typeName)
1147
            self.putValue(value)
1148
1149
1150
            self.putNumChild(0)
            return

1151
        if typeobj.code == EnumCode:
1152
            self.putType(typeName)
1153
            self.putValue("%s (%d)" % (value, value))
1154
1155
1156
            self.putNumChild(0)
            return

1157
        if typeobj.code == ComplexCode:
1158
            self.putType(typeName)
1159
            self.putValue("%s" % value)
1160
1161
1162
            self.putNumChild(0)
            return

1163
        if typeobj.code == TypedefCode:
1164
            if typeName in self.qqDumpers:
1165
                self.putType(typeName)
1166
                self.qqDumpers[typeName](self, value)
1167
1168
                return

1169
            typeobj = stripTypedefs(typeobj)
1170
1171
1172
            # The cast can destroy the address?
            #self.putAddress(value.address)
            # Workaround for http://sourceware.org/bugzilla/show_bug.cgi?id=13380
1173
1174
            if typeobj.code == ArrayCode:
                value = self.parseAndEvaluate("{%s}%s" % (typeobj, value.address))
1175
1176
            else:
                try:
1177
                    value = value.cast(typeobj)
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
                except:
                    self.putValue("<optimized out typedef>")
                    self.putType(typeName)
                    self.putNumChild(0)
                    return

            self.putItem(value)
            self.putBetterType(typeName)
            return

1188
        if typeobj.code == ArrayCode:
1189
            self.putCStyleArray(value)
1190
1191
            return

1192
        if typeobj.code == PointerCode:
1193
1194
            # This could still be stored in a register and
            # potentially dereferencable.
hjk's avatar
hjk committed
1195
            self.putFormattedPointer(value)
1196
1197
            return

1198
1199
1200
1201
        if typeobj.code == MethodPointerCode \
                or typeobj.code == MethodCode \
                or typeobj.code == FunctionCode \
                or typeobj.code == MemberPointerCode:
1202
1203
1204
1205
1206
1207
1208
1209
            self.putType(typeName)
            self.putValue(value)
            self.putNumChild(0)
            return

        if typeName.startswith("<anon"):
            # Anonymous union. We need a dummy name to distinguish
            # multiple anonymous unions in the struct.
1210
            self.putType(typeobj)
1211
1212
1213
            self.putValue("{...}")
            self.anonNumber += 1
            with Children(self, 1):
1214
                self.listAnonymous(value, "#%d" % self.anonNumber, typeobj)
1215
1216
            return

1217
        if typeobj.code == StringCode:
1218
            # FORTRAN strings
1219
            size = typeobj.sizeof
1220
            data = self.readMemory(value.address, size)
1221
            self.putValue(data, Hex2EncodedLatin1, 1)
1222
            self.putType(typeobj)
1223

1224
1225
        if typeobj.code != StructCode and typeobj.code != UnionCode:
            warn("WRONG ASSUMPTION HERE: %s " % typeobj.code)
1226
1227
1228
1229
            check(False)


        if tryDynamic:
1230
            self.putItem(self.expensiveDowncast(value), False)
1231
1232
            return

1233
        format = self.currentItemFormat(typeName)
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252

        if self.useFancy and (format is None or format >= 1):
            self.putType(typeName)

            nsStrippedType = self.stripNamespaceFromType(typeName)\
                .replace("::", "__")

            # The following block is only needed for D.
            if nsStrippedType.startswith("_A"):
                # DMD v2.058 encodes string[] as _Array_uns long long.
                # With spaces.
                if nsStrippedType.startswith("_Array_"):
                    qdump_Array(self, value)
                    return
                if nsStrippedType.startswith("_AArray_"):
                    qdump_AArray(self, value)
                    return

            #warn(" STRIPPED: %s" % nsStrippedType)
1253
1254
1255
            #warn(" DUMPERS: %s" % self.qqDumpers)
            #warn(" DUMPERS: %s" % (nsStrippedType in self.qqDumpers))
            dumper = self.qqDumpers.get(nsStrippedType, None)
1256
1257
            if not dumper is None:
                if tryDynamic:
1258
                    dumper(self, self.expensiveDowncast(value))
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
                else:
                    dumper(self, value)
                return

        # D arrays, gdc compiled.
        if typeName.endswith("[]"):
            n = value["length"]
            base = value["ptr"]
            self.putType(typeName)
            self.putItemCount(n)
            if self.isExpanded():
                self.putArrayData(base.type.target(), base, n)
            return

1273
        #warn("GENERIC STRUCT: %s" % typeobj)
1274
1275
1276
        #warn("INAME: %s " % self.currentIName)
        #warn("INAMES: %s " % self.expandedINames)
        #warn("EXPANDED: %s " % (self.currentIName in self.expandedINames))
1277
1278
1279
        staticMetaObject = self.extractStaticMetaObject(value.type)
        if staticMetaObject:
            self.putQObjectNameValue(value)
1280
1281
        self.putType(typeName)
        self.putEmptyValue()
1282
        self.putNumChild(len(typeobj.fields()))
1283
1284
1285
1286
1287

        if self.currentIName in self.expandedINames:
            innerType = None
            with Children(self, 1, childType=innerType):
                self.putFields(value)
1288
1289
                if staticMetaObject:
                    self.putQObjectGuts(value, staticMetaObject)
hjk's avatar
hjk committed
1290

1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
    def toBlob(self, value):
        size = toInteger(value.type.sizeof)
        if value.address:
            return self.extractBlob(value.address, size)

        # No address. Possibly the result of an inferior call.
        y = value.cast(gdb.lookup_type("unsigned char").array(0, int(size - 1)))
        buf = bytearray(struct.pack('x' * size))
        for i in range(size):
            buf[i] = int(y[i])

        return Blob(bytes(buf))