dumper.py 21.7 KB
Newer Older
hjk's avatar
hjk committed
1
2
3
4
5
6
7
8
9
10
11
12
13

#Note: Keep name-type-value-numchild-extra order

#return

import sys
import traceback
import gdb
import curses.ascii

verbosity = 0
verbosity = 1

14
15
16
17
18
def select(condition, if_expr, else_expr):
    if condition:
        return if_expr
    return else_expr

19
20
21
22
23
def qmin(n, m):
    if n < m:
        return n
    return m

hjk's avatar
hjk committed
24
25
26
27
28
29
30
31
32
33
34
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
def isSimpleType(typeobj):
    type = str(typeobj)
    return type == "bool" \
        or type == "char" \
        or type == "double" \
        or type == "float" \
        or type == "int" \
        or type == "long" or type.startswith("long ") \
        or type == "short" or type.startswith("short ") \
        or type == "signed" or  type.startswith("signed ") \
        or type == "unsigned" or type.startswith("unsigned ")

def isStringType(d, typeobj):
    type = str(typeobj)
    return type == d.ns + "QString" \
        or type == d.ns + "QByteArray" \
        or type == "std::string" \
        or type == "std::wstring" \
        or type == "wstring"

def warn(message):
    if verbosity > 0:
        print "XXX: %s " % message.encode("latin1")
    pass

def check(exp):
    if not exp:
        raise RuntimeError("Check failed")

#def couldBePointer(p, align):
#    type = gdb.lookup_type("unsigned int")
#    ptr = gdb.Value(p).cast(type)
#    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)


def checkAccess(p, align = 1):
    return p.dereference()

def checkContents(p, expected, align = 1):
    if int(p.dereference()) != expected:
        raise RuntimeError("Contents check failed")

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


def isNull(p):
    s = str(p)
    return s == "0x0" or s.startswith("0x0 ")

movableTypes = set([
    "QBrush", "QBitArray", "QByteArray",
    "QCustomTypeInfo", "QChar",
    "QDate", "QDateTime",
    "QFileInfo", "QFixed", "QFixedPoint", "QFixedSize",
    "QHashDummyValue",
    "QIcon", "QImage",
    "QLine", "QLineF", "QLatin1Char", "QLocal",
    "QMatrix", "QModelIndex",
    "QPoint", "QPointF", "QPen", "QPersistentModelIndex",
    "QResourceRoot", "QRect", "QRectF", "QRegExp",
    "QSize", "QSizeF", "QString",
    "QTime", "QTextBlock",
    "QUrl",
    "QVariant",
    "QXmlStreamAttribute", "QXmlStreamNamespaceDeclaration",
    "QXmlStreamNotationDeclaration", "QXmlStreamEntityDeclaration"])


def stripClassTag(type):
    if type.startswith("class "):
        return type[6:]
    return type

def checkPointerRange(p, n):
    for i in xrange(0, n):
        checkPointer(p)
        ++p

def call(value, func):
    #warn("CALL: %s -> %s" % (value, func))
    type = stripClassTag(str(value.type))
    if type.find(':') >= 0:
        type = "'" + type + "'"
    exp = "((%s*)%s)->%s" % (type, value.address, func)
    #warn("CALL: %s" % exp)
    result = gdb.parse_and_eval(exp)
    #warn("  -> %s" % result)
    return result

117
118
119
120
121
122
def qtNamespace():
    try:
        type = str(gdb.parse_and_eval("&QString::null").type.target().unqualified())
        return type[0:len(type) - len("QString::null")]
    except RuntimeError:
        return ""
hjk's avatar
hjk committed
123

124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
def encodeByteArray(value):
    d_ptr = value['d'].dereference()
    data = d_ptr['data']
    size = d_ptr['size']
    alloc = d_ptr['alloc']
    check(0 <= size and size <= alloc and alloc <= 100*1000*1000)
    check(d_ptr["ref"]["_q_value"] > 0)
    if size > 0:
        checkAccess(data, 4)
        checkAccess(data + size) == 0

    innerType = gdb.lookup_type("char")
    p = gdb.Value(data.cast(innerType.pointer()))
    s = ""
    for i in xrange(0, size):
        s += "%02x" % int(p.dereference())
        p += 1
    return s

def encodeString(value):
    d_ptr = value['d'].dereference()
    data = d_ptr['data']
    size = d_ptr['size']
    alloc = d_ptr['alloc']
    check(0 <= size and size <= alloc and alloc <= 100*1000*1000)
    if size > 0:
        checkAccess(data, 4)
        checkAccess(data + size * 2) == 0
    check(d_ptr["ref"]["_q_value"] > 0)
    p = gdb.Value(d_ptr["data"])
    s = ""
    for i in xrange(0, size):
        val = int(p.dereference())
        s += "%02x" % (val % 256)
        s += "%02x" % (val / 256)
        p += 1
    return s

hjk's avatar
hjk committed
162
163
164
165
166
167
168
169
170
#######################################################################
#
# Item
#
#######################################################################

class Item:
    def __init__(self, value, parentiname, iname, name):
        self.value = value
171
172
173
174
        if iname is None:
            self.iname = parentiname
        else:
            self.iname = "%s.%s" % (parentiname, iname)
hjk's avatar
hjk committed
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
        self.name = name


#######################################################################
#
# FrameCommand
#
#######################################################################

class FrameCommand(gdb.Command):
    """Do fancy stuff. Usage bb --verbose expandedINames"""

    def __init__(self):
        super(FrameCommand, self).__init__("bb", gdb.COMMAND_OBSCURE)

    def invoke(self, arg, from_tty):
        args = arg.split(' ')
        #warn("ARG: %s" % arg)
        #warn("ARGS: %s" % args)
        useFancy = int(args[0])
        passExceptions = int(args[1])
        expandedINames = set()
        if len(args) > 2:
            expandedINames = set(args[2].split(','))
        watchers = set()
        if len(args) > 3:
            watchers = set(args[3].split(','))
        #warn("EXPANDED INAMES: %s" % expandedINames)
        #warn("WATCHERS: %s" % watchers)
        module = sys.modules[__name__]
        self.dumpers = {}

hjk's avatar
hjk committed
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
        if useFancy == -1:
            output = "dumpers=["
            for key, value in module.__dict__.items():
                if key.startswith("qqDump"):
                    if output != "dumpers=[":
                        output += ","
                    output += '"' + key[6:] + '"'
            output += "],"
            #output += "qtversion=[%d,%d,%d]"
            output += "qtversion=[4,6,0],"
            output += "namespace=\"%s\"," % qtNamespace()
            output += "dumperversion=\"2.0\","
            output += "sizes=[],"
            output += "expressions=[]"
            output += "]"
            print output
            return
  
hjk's avatar
hjk committed
225
226
227
228
229
230
231
        if useFancy:
            for key, value in module.__dict__.items():
                #if callable(value):
                if key.startswith("qqDump"):
                    self.dumpers[key[6:]] = value
        try:
            frame = gdb.selected_frame()
232
        except RuntimeError:
hjk's avatar
hjk committed
233
234
235
236
237
            return ""

        d = Dumper()
        d.dumpers = self.dumpers
        d.passExceptions = passExceptions
238
        d.ns = qtNamespace()
hjk's avatar
hjk committed
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
        block = frame.block()
        #warn(" NAMESPACE IS: '%s'" % d.ns)
        #warn("FRAME %s: " % frame)

        while True:
            if block is None:
                warn("UNEXPECTED 'None' BLOCK")
                break
            for symbol in block:
                name = symbol.print_name
                
                if name == "__in_chrg":
                    continue

                # "NotImplementedError: Symbol type not yet supported in
                # Python scripts."
                #warn("SYMBOL %s: " % symbol.value)
                #warn("SYMBOL %s  (%s): " % (symbol, name))
                item = Item(0, "local", name, name)
                try:
                    item.value = frame.read_var(name)  # this is a gdb value
                except RuntimeError:
                    # happens for  void foo() { std::string s; std::wstring w; }
                    #warn("  FRAME READ VAR ERROR: %s (%s): " % (symbol, name))
                    continue
                #warn("ITEM %s: " % item.value)

                d.expandedINames = expandedINames
                d.useFancy = useFancy
                d.beginHash()
269
                d.put('iname="%s",' % item.iname)
hjk's avatar
hjk committed
270
271
272
273
274
275
276
277
278
                d.safePutItemHelper(item)
                d.endHash()

            # 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
279
            #warn("BLOCK %s: " % block)
hjk's avatar
hjk committed
280
281

        d.pushOutput()
282
283
284

        print('locals={iname="local",name="Locals",value=" ",type=" ",'
            + 'children=[%s]}' % d.safeoutput)
hjk's avatar
hjk committed
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331

FrameCommand()



#######################################################################
#
# The Dumper Class
#
#######################################################################

class Dumper:
    def __init__(self):
        self.output = ""
        self.safeoutput = ""
        self.childTypes = [""]
        self.childNumChilds = [-1]

    def put(self, value):
        self.output += value

    def putCommaIfNeeded(self):
        c = self.output[-1:]
        if c == '}' or c == '"' or c == ']' or c == '\n':
            self.put(',')
        #warn("C:'%s' COND:'%d' OUT:'%s'" %
        #    (c, c == '}' or c == '"' or c == ']' or c == '\n', self.output))

    def putField(self, name, value):
        self.putCommaIfNeeded()
        self.put('%s="%s"' % (name, value))

    def beginHash(self):
        self.putCommaIfNeeded()
        self.put('{')

    def endHash(self):
        self.put('}')

    def beginItem(self, name):
        self.putCommaIfNeeded()
        self.put(name)
        self.put('="')

    def endItem(self):
        self.put('"')

332
    def beginChildren(self, numChild = 1, type = None, children = None):
hjk's avatar
hjk committed
333
334
        childType = ""
        childNumChild = -1
335
336
        if numChild == 0:
            type = None
337
        self.putCommaIfNeeded()
hjk's avatar
hjk committed
338
339
        if not type is None:
            childType = stripClassTag(str(type))
340
            self.put('childtype="%s",' % childType)
hjk's avatar
hjk committed
341
            if isSimpleType(type) or isStringType(self, type):
342
                self.put('childnumchild="0",')
hjk's avatar
hjk committed
343
344
                childNumChild = 0
            elif type.code == gdb.TYPE_CODE_PTR:
345
                self.put('childnumchild="1",')
hjk's avatar
hjk committed
346
347
                childNumChild = 1
        if not children is None:
348
            self.put('childnumchild="%s",' % children)
hjk's avatar
hjk committed
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
            childNumChild = children
        self.childTypes.append(childType)
        self.childNumChilds.append(childNumChild)
        #warn("BEGIN: %s" % self.childTypes)
        self.put("children=[")

    def endChildren(self):
        #warn("END: %s" % self.childTypes)
        self.childTypes.pop()
        self.childNumChilds.pop()
        self.put(']')

    # convenience
    def putItemCount(self, count):
        self.putCommaIfNeeded()
        self.put('value="<%s items>"' % count)

    def putEllipsis(self):
        self.putCommaIfNeeded()
        self.put('{name="<incomplete>",value="",type="",numchild="0"}')

    def putType(self, type):
        #warn("TYPES: '%s' '%s'" % (type, self.childTypes))
        #warn("  EQUAL 2: %s " % (str(type) == self.childTypes[-1]))
        type = stripClassTag(str(type))
        if len(type) > 0 and type != self.childTypes[-1]:
375
376
            self.putCommaIfNeeded()
            self.put('type="%s"' % type) # str(type.unqualified()) ?
hjk's avatar
hjk committed
377
378
379

    def putNumChild(self, numchild):
        #warn("NUM CHILD: '%s' '%s'" % (numchild, self.childNumChilds[-1]))
380
381
        if numchild != self.childNumChilds[-1]:
            self.put(',numchild="%s"' % numchild)
hjk's avatar
hjk committed
382

383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
    def putValue(self, value, encoding = None):
        if not encoding is None:
            self.putField("valueencoded", encoding)
        self.putField("value", value)

    def putStringValue(self, value):
        str = encodeString(value)
        self.putCommaIfNeeded()
        self.put('valueencoded="%d",value="%s"' % (7, str))

    def putByteArrayValue(self, value):
        str = encodeByteArray(value)
        self.putCommaIfNeeded()
        self.put('valueencoded="%d",value="%s"' % (6, str))

    
    def putName(self, name):
        self.putCommaIfNeeded()
        self.put('name="%s"' % name)

hjk's avatar
hjk committed
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
438
    def isExpanded(self, item):
        #warn("IS EXPANDED: %s in %s" % (item.iname, self.expandedINames))
        if item.iname is None:
            raise "Illegal iname 'None'"
        if item.iname.startswith("None"):
            raise "Illegal iname '%s'" % item.iname
        #warn("   --> %s" % (item.iname in self.expandedINames))
        return item.iname in self.expandedINames

    def isExpandedIName(self, iname):
        return iname in self.expandedINames

    def unputField(self, name):
        pos = self.output.rfind(",")
        if self.output[pos + 1:].startswith(name):
            self.output = self.output[0:pos]

    def stripNamespaceFromType(self, typeobj):
        # FIXME: pass ns from plugin
        type = stripClassTag(str(typeobj))
        if len(self.ns) > 0 and type.startswith(self.ns):
            type = type[len(self.ns):]
        pos = type.find("<")
        if pos != -1:
            type = type[0:pos]
        return type

    def isMovableType(self, type):
        if type.code == gdb.TYPE_CODE_PTR:
            return True
        if isSimpleType(type):
            return True
        return self.stripNamespaceFromType(type) in movableTypes

    def putIntItem(self, name, value):
        self.beginHash()
439
440
        self.putName(name)
        self.putValue(value)
hjk's avatar
hjk committed
441
442
443
444
445
446
        self.putType("int")
        self.putNumChild(0)
        self.endHash()

    def putBoolItem(self, name, value):
        self.beginHash()
447
448
        self.putName(name)
        self.putValue(value)
hjk's avatar
hjk committed
449
450
451
452
453
454
455
456
457
        self.putType("bool")
        self.putNumChild(0)
        self.endHash()

    def pushOutput(self):
        #warn("PUSH OUTPUT: %s " % self.output)
        self.safeoutput += self.output
        self.output = ""

458
    def dumpInnerValueHelper(self, item):
hjk's avatar
hjk committed
459
        if isSimpleType(item.value.type):
460
            self.safePutItemHelper(item)
hjk's avatar
hjk committed
461
462
463
464
465
466
467
468
469
470
471
472
473

    def safePutItemHelper(self, item):
        self.pushOutput()
        # This is only used at the top level to ensure continuation
        # after failures due to uninitialized or corrupted data.
        if self.passExceptions:
            # for debugging reasons propagate errors.
            self.putItemHelper(item)

        else:
            try:
                self.putItemHelper(item)

474
            except RuntimeError:
hjk's avatar
hjk committed
475
476
477
478
                self.output = ""
                # FIXME: Only catch debugger related exceptions
                #exType, exValue, exTraceback = sys.exc_info()
                #tb = traceback.format_exception(exType, exValue, exTraceback)
479
                #warn("Exception: %s" % ex.message)
hjk's avatar
hjk committed
480
481
482
483
484
                # DeprecationWarning: BaseException.message
                # has been deprecated
                #warn("Exception.")
                #for line in tb:
                #    warn("%s" % line)
485
486
487
488
                self.putName(item.name)
                self.putValue("<invalid>")
                self.putType(str(item.value.type))
                self.putNumChild(0)
hjk's avatar
hjk committed
489
490
491
492
493
494
495
                #if self.isExpanded(item):
                self.beginChildren()
                self.endChildren()
        self.pushOutput()

    def putItem(self, item):
        self.beginHash()
hjk's avatar
hjk committed
496
        self.safePutItemHelper(item)
hjk's avatar
hjk committed
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
        self.endHash()

    def putItemOrPointer(self, item):
        self.beginHash()
        self.putItemOrPointerHelper(item)
        self.endHash()
    
    def putCallItem(self, name, item, func):
        result = call(item.value, func)
        self.putItem(Item(result, item.iname, name, name))

    def putItemOrPointerHelper(self, item):
        if item.value.type.code == gdb.TYPE_CODE_PTR \
                and str(item.value.type.unqualified) != "char":
            if not isNull(item.value):
                self.putItemOrPointerHelper(
                    Item(item.value.dereference(), item.iname, None, None))
            else:
515
516
                self.putValue("(null)")
                self.putNumChild(0)
hjk's avatar
hjk committed
517
        else:
hjk's avatar
hjk committed
518
            self.safePutItemHelper(item)
hjk's avatar
hjk committed
519
520


521
    def putItemHelper(self, item):
hjk's avatar
hjk committed
522
523
        name = getattr(item, "name", None)
        if not name is None:
524
            self.putName(name)
hjk's avatar
hjk committed
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549

        self.putType(item.value.type)
        # FIXME: Gui shows references stripped?
        #warn("REAL INAME: %s " % item.iname)
        #warn("REAL TYPE: %s " % item.value.type)
        #warn("REAL VALUE: %s " % item.value)

        value = item.value
        type = value.type

        if type.code == gdb.TYPE_CODE_REF:
            type = type.target()
            value = value.cast(type)

        if type.code == gdb.TYPE_CODE_TYPEDEF:
            type = type.target()

        strippedType = self.stripNamespaceFromType(
            type.strip_typedefs().unqualified()).replace("::", "__")
        
        #warn(" STRIPPED: %s" % strippedType)
        #warn(" DUMPERS: %s" % self.dumpers)
        #warn(" DUMPERS: %s" % (strippedType in self.dumpers))

        if isSimpleType(type):
550
551
            self.putValue(value)
            self.putNumChild(0)
hjk's avatar
hjk committed
552
553
554
555
556
557

        elif strippedType in self.dumpers:
            self.dumpers[strippedType](self, item)

        elif type.code == gdb.TYPE_CODE_ENUM:
            #warn("GENERIC ENUM: %s" % value)
558
            self.putValue(value)
hjk's avatar
hjk committed
559
560
561
562
563
564
565
            self.putNumChild(0)
            

        elif type.code == gdb.TYPE_CODE_PTR:
            isHandled = False
            #warn("GENERIC POINTER: %s" % value)
            if isNull(value):
566
                self.putValue("0x0")
hjk's avatar
hjk committed
567
568
569
570
571
572
573
574
575
576
577
578
                self.putNumChild(0)
                isHandled = True

            target = str(type.target().unqualified())
            #warn("TARGET: %s" % target)
            if target == "char" and not isHandled:
                # Display values up to given length directly
                firstNul = -1
                p = value
                for i in xrange(0, 10):
                    if p.dereference() == 0:
                        # Found terminating NUL
579
580
                        self.putField("valueencoded", "6")
                        self.put(',value="')
hjk's avatar
hjk committed
581
582
583
584
585
586
587
588
589
590
591
592
593
594
                        p = value
                        for j in xrange(0, i):
                            self.put('%02x' % int(p.dereference()))
                            p += 1
                        self.put('"')
                        self.putNumChild(0)
                        isHandled = True
                        break
                    p += 1

            if not isHandled:
                # Generic pointer type.
                #warn("GENERIC POINTER: %s" % value)
                if self.isExpanded(item):
595
596
597
598
599
                    #warn("GENERIC POINTER: %s" % item.value.type.target())
                    self.put(',')
                    # Temporary change to target type.
                    self.childTypes.append(
                        stripClassTag(str(item.value.type.target())))
600
601
                    self.putItemOrPointerHelper(
                        Item(item.value.dereference(), item.iname, None, None))
602
                    self.childTypes.pop()
603
                else:
604
                    self.putValue(str(value.address))
605
                    self.putNumChild(1)
hjk's avatar
hjk committed
606
607
608
609
610

        else:
            #warn("COMMON TYPE: %s " % value.type)
            #warn("INAME: %s " % item.iname)
            #warn("INAMES: %s " % self.expandedINames)
611
            #warn("EXPANDED: %s " % (item.iname in self.expandedINames))
hjk's avatar
hjk committed
612
613
614
615
616

            # insufficient, see http://sourceware.org/bugzilla/show_bug.cgi?id=10953
            #fields = value.type.fields()
            fields = value.type.strip_typedefs().fields()

617
            self.putValue("{...}")
hjk's avatar
hjk committed
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632

            if False:
                numfields = 0
                for field in fields:
                    bitpos = getattr(field, "bitpos", None)
                    if not bitpos is None:
                        ++numfields
            else:
                numfields = len(fields)
            self.putNumChild(numfields)

            if self.isExpanded(item):
                innerType = None
                if len(fields) == 1 and fields[0].name is None:
                    innerType = value.type.target()
633
                self.beginChildren(1, innerType)
hjk's avatar
hjk committed
634

635
                baseNumber = 0
hjk's avatar
hjk committed
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
                for field in fields:
                    #warn("FIELD: %s" % field)
                    #warn("  BITSIZE: %s" % field.bitsize)
                    #warn("  ARTIFICIAL: %s" % field.artificial)
                    bitpos = getattr(field, "bitpos", None)
                    if bitpos is None: # FIXME: Is check correct?
                        continue  # A static class member(?).

                    if field.name is None:
                        innerType = value.type.target()
                        p = value.cast(innerType.pointer())
                        for i in xrange(0, value.type.sizeof / innerType.sizeof):
                            self.putItem(Item(p.dereference(), item.iname, i, None))
                            p = p + 1
                        continue

                    # ignore vtable pointers for virtual inheritance
                    if field.name.startswith("_vptr."):
                        continue

                    #warn("FIELD NAME: %s" % field.name)
                    #warn("FIELD TYPE: %s" % field.type)
                    if field.name == stripClassTag(str(field.type)):
659
660
661
662
663
664
665
666
667
668
                        # Field is base type. We cannot use field.name as part
                        # of the iname as it might contain spaces and other
                        # strange characters.
                        child = Item(value.cast(field.type),
                            item.iname, "@%d" % baseNumber, field.name)
                        baseNumber += 1
                        self.beginHash()
                        self.putField("iname", child.iname)
                        self.safePutItemHelper(child)
                        self.endHash()
hjk's avatar
hjk committed
669
670
                    else:
                        # Data member.
671
672
673
674
675
676
677
                        child = Item(value[field.name],
                            item.iname, field.name, field.name)
                        if not child.name:
                            child.name = "<anon>"
                        self.beginHash()
                        self.safePutItemHelper(child)
                        self.endHash()
hjk's avatar
hjk committed
678
                self.endChildren()