dumper.py 31.5 KB
Newer Older
hjk's avatar
hjk committed
1
2
3
4
5
6
7
8

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

#return

import sys
import traceback
import gdb
9
import base64
hjk's avatar
hjk committed
10
11
import curses.ascii

12
13
14
15
# only needed for gdb 7.0
import os
import tempfile

hjk's avatar
hjk committed
16
17
18
verbosity = 0
verbosity = 1

19
20
21
22
23
def select(condition, if_expr, else_expr):
    if condition:
        return if_expr
    return else_expr

24
25
26
27
28
def qmin(n, m):
    if n < m:
        return n
    return m

hjk's avatar
hjk committed
29
def isGoodGdb():
30
31
32
    #return gdb.VERSION.startswith("6.8.50.2009") \
    #   and gdb.VERSION != "6.8.50.20090630-cvs"
    return 'parse_and_eval' in dir(gdb)
hjk's avatar
hjk committed
33

34
def cleanAddress(addr):
35
36
37
    # we cannot use str(addr) as it yields rubbish for char pointers
    # that might trigger Unicode encoding errors
    return addr.cast(gdb.lookup_type("void").pointer())
38

39
def parseAndEvaluate(exp):
hjk's avatar
hjk committed
40
    if isGoodGdb():
41
42
43
44
45
46
47
48
49
50
51
52
53
        return gdb.parse_and_eval(exp)
    # Work around non-existing gdb.parse_and_eval as in released 7.0
    gdb.execute("set logging redirect on")
    gdb.execute("set logging on")
    gdb.execute("print %s" % exp)
    gdb.execute("set logging off")
    return gdb.history(0)

def listOfLocals():
    try:
        frame = gdb.selected_frame()
        #warn("FRAME %s: " % frame)
    except RuntimeError:
hjk's avatar
hjk committed
54
        return []
55
56

    items = []
hjk's avatar
hjk committed
57
    if isGoodGdb():
58
59
60
61
62
63
64
65
        # archer-tromey-python
        block = frame.block()
        while True:
            if block is None:
                warn("UNEXPECTED 'None' BLOCK")
                break
            for symbol in block:
                name = symbol.print_name
66

67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
                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)
                items.append(item)
            # 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
    else:
hjk's avatar
hjk committed
90
        # Assuming gdb 7.0 release or 6.8-symbianelf.
91
92
        file = tempfile.mkstemp(prefix="gdbpy_")
        filename = file[1]
hjk's avatar
hjk committed
93
94
        gdb.execute("set logging off")
        gdb.execute("set logging redirect off")
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
        gdb.execute("set logging file %s" % filename)
        gdb.execute("set logging redirect on")
        gdb.execute("set logging on")
        gdb.execute("info locals")
        gdb.execute("info args")
        gdb.execute("set logging off")
        gdb.execute("set logging redirect off")
        file = open(filename, "r")
        for line in file:
            if len(line) == 0 or line.startswith(" "):
                continue
            pos = line.find(" = ")
            if pos < 0:
                continue
            name = line[0:pos]
            item = Item(0, "local", name, name)
            try:
                item.value = frame.read_var(name)  # this is a gdb value
            except RuntimeError:
                continue
            items.append(item)
        file.close()
        os.remove(filename)

    return items


122
def value(expr):
123
    value = parseAndEvaluate(expr)
124
125
126
127
128
    try:
        return int(value)
    except:
        return str(value)

129

hjk's avatar
hjk committed
130
def isSimpleType(typeobj):
131
132
    if typeobj.code == gdb.TYPE_CODE_PTR:
        return False
hjk's avatar
hjk committed
133
134
135
136
137
138
139
140
    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 ") \
141
        or type == "signed" or type.startswith("signed ") \
hjk's avatar
hjk committed
142
143
        or type == "unsigned" or type.startswith("unsigned ")

144

hjk's avatar
hjk committed
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
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")

162
163
164
165
166
def checkRef(ref):
    count = ref["_q_value"]
    check(count > 0)
    check(count < 1000000) # assume there aren't a million references to any object

hjk's avatar
hjk committed
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
#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):
188
189
190
191
    # 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 ")
192
    return p.cast(gdb.lookup_type("void").pointer()) == 0
hjk's avatar
hjk committed
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218

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):
219
    for i in xrange(n):
hjk's avatar
hjk committed
220
221
222
223
224
225
        checkPointer(p)
        ++p

def call(value, func):
    #warn("CALL: %s -> %s" % (value, func))
    type = stripClassTag(str(value.type))
226
    if type.find(":") >= 0:
hjk's avatar
hjk committed
227
228
229
        type = "'" + type + "'"
    exp = "((%s*)%s)->%s" % (type, value.address, func)
    #warn("CALL: %s" % exp)
230
    result = parseAndEvaluate(exp)
hjk's avatar
hjk committed
231
232
233
    #warn("  -> %s" % result)
    return result

234
235
def qtNamespace():
    try:
236
        type = str(parseAndEvaluate("&QString::null").type.target().unqualified())
237
238
239
        return type[0:len(type) - len("QString::null")]
    except RuntimeError:
        return ""
hjk's avatar
hjk committed
240

241
242
def encodeCharArray(p, size):
    s = ""
243
    p = p.cast(gdb.lookup_type("unsigned char").pointer())
244
    for i in xrange(size):
245
246
247
248
        s += "%02x" % int(p.dereference())
        p += 1
    return s

249
250
251
252
253
254
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)
255
    checkRef(d_ptr["ref"])
256
257
258
259
260
261
    if size > 0:
        checkAccess(data, 4)
        checkAccess(data + size) == 0

    innerType = gdb.lookup_type("char")
    p = gdb.Value(data.cast(innerType.pointer()))
262
    return encodeCharArray(p, size)
263
264
265
266
267
268
269
270
271
272

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
273
    checkRef(d_ptr["ref"])
274
275
    p = gdb.Value(d_ptr["data"])
    s = ""
276
    for i in xrange(size):
277
278
279
280
281
282
        val = int(p.dereference())
        s += "%02x" % (val % 256)
        s += "%02x" % (val / 256)
        p += 1
    return s

hjk's avatar
hjk committed
283
284
285
286
287
288
289
#######################################################################
#
# Item
#
#######################################################################

class Item:
290
    def __init__(self, value, parentiname, iname, name = None):
hjk's avatar
hjk committed
291
        self.value = value
292
293
294
295
        if iname is None:
            self.iname = parentiname
        else:
            self.iname = "%s.%s" % (parentiname, iname)
hjk's avatar
hjk committed
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
        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)
315
316
        options = args[0].split(",")
        useFancy = "fancy" in options
hjk's avatar
hjk committed
317
        expandedINames = set()
318
319
        if len(args) > 1:
            expandedINames = set(args[1].split(","))
hjk's avatar
hjk committed
320
321
322
323
        #warn("EXPANDED INAMES: %s" % expandedINames)
        module = sys.modules[__name__]
        self.dumpers = {}

hjk's avatar
hjk committed
324
325
326
        if useFancy == -1:
            output = "dumpers=["
            for key, value in module.__dict__.items():
327
                if key.startswith("qdump__"):
hjk's avatar
hjk committed
328
329
                    if output != "dumpers=[":
                        output += ","
330
                    output += '"' + key[7:] + '"'
hjk's avatar
hjk committed
331
332
333
334
335
336
337
338
339
340
            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
341

342

hjk's avatar
hjk committed
343
344
345
        if useFancy:
            for key, value in module.__dict__.items():
                #if callable(value):
346
347
                if key.startswith("qdump__"):
                    self.dumpers[key[7:]] = value
hjk's avatar
hjk committed
348
349
350

        d = Dumper()
        d.dumpers = self.dumpers
351
352
353
        d.useFancy = useFancy
        d.passExceptions = "passexceptions" in options
        d.autoDerefPointers = "autoderef" in options
354
        d.ns = qtNamespace()
355
        d.expandedINames = expandedINames
hjk's avatar
hjk committed
356
357
        #warn(" NAMESPACE IS: '%s'" % d.ns)

358
359
360
        #
        # Locals
        #
361
        for item in listOfLocals():
362
363
            #warn("ITEM NAME %s: " % item.name)
            #warn("ITEM VALUE %s: " % item.value)
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381

            type = item.value.type
            if type.code == gdb.TYPE_CODE_PTR \
                    and item.name == "argv" and str(type) == "char **":
                # Special handling for char** argv:
                n = 0
                p = item.value
                while not isNull(p.dereference()) and n <= 100:
                    p += 1
                    n += 1

                d.beginHash()
                d.put('iname="%s",' % item.iname)
                d.putName(item.name)
                d.putItemCount(select(n <= 100, n, "> 100"))
                d.putType(type)
                d.putNumChild(n)
                if d.isExpanded(item):
382
                    p = item.value
383
                    d.beginChildren(n)
384
                    for i in xrange(n):
385
386
                        value = p.dereference()
                        d.putItem(Item(value, item.iname, i, None))
387
                        p += 1
388
389
390
391
392
393
394
                    if n > 100:
                        d.putEllipsis()
                    d.endChildren()
                d.endHash()

            else:
                # A "normal" local variable or parameter
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
                try:
                    addr = cleanAddress(item.value.address)
                    d.beginHash()
                    d.put('iname="%s",' % item.iname)
                    d.put('addr="%s",' % addr)
                    d.safePutItemHelper(item)
                    d.endHash()
                except AttributeError:
                    # thrown by cleanAddreas with message
                    # "'NoneType' object has no attribute 'cast'"
                    # for optimized-out values
                    d.beginHash()
                    d.put('iname="%s",' % item.iname)
                    d.put('name="%s",' % item.name)
                    d.put('addr="<optimized out>",')
                    d.put('value="<optimized out>",')
                    d.put('type="%s"' % item.value.type)
                    d.endHash()
hjk's avatar
hjk committed
413

414
415
416
417
        d.pushOutput()
        locals = d.safeoutput


418
419
420
        #
        # Watchers
        #
421
422
        d.safeoutput = ""
        watchers = ""
423
424
        if len(args) > 2:
            watchers = base64.b16decode(args[2], True)
425
        if len(watchers) > 0:
426
427
            for watcher in watchers.split("##"):
                (exp, name) = watcher.split("#")
428
                self.handleWatch(d, exp, name)
429
430
431
432
        d.pushOutput()
        watchers = d.safeoutput

        print('locals={iname="local",name="Locals",value=" ",type=" ",'
433
434
435
436
            + 'children=[' + locals + ']},'
            + 'watchers={iname="watch",name="Watchers",value=" ",type=" ",'
            + 'children=[' + watchers + ']}\n')

437
438

    def handleWatch(self, d, exp, name):
439
        #warn("HANDLING WATCH %s, NAME: %s" % (exp, name))
440
441
442
443
444
445
446
447
448
449
        if not isGoodGdb():
            d.beginHash()
            d.put('iname="watch.%s",' % name)
            d.put('name="%s",' % exp)
            d.put('exp="%s",' % exp)
            d.put('value="<unsupported gdb version>"',)
            d.put('type="<unknown>",numchild="0"')
            d.endHash()
            return

450
        if exp.startswith("["):
451
            #warn("EVAL: EXP: %s" % exp)
452
453
454
            d.beginHash()
            d.put('iname="watch.%s",' % name)
            d.put('name="%s",' % exp)
455
            d.put('exp="%s",' % exp)
456
457
            try:
                list = eval(exp)
458
                #warn("EVAL: LIST: %s" % list)
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
                d.put('value=" "')
                d.put('type=" "')
                d.put('numchild="%d"' % len(list))
                # This is a list of expressions to evaluate
                d.beginChildren(len(list))
                itemNumber = 0
                for item in list:
                    self.handleWatch(d, item, "%s.%d" % (name, itemNumber))
                    itemNumber += 1
                d.endChildren()
            except:
                warn("EVAL: ERROR CAUGHT")
                d.put('value="<syntax error>"')
                d.put('type=" "')
                d.put('numchild="0"')
                d.beginChildren(0)
                d.endChildren()
            d.endHash()
            return

        d.beginHash()
        d.put('iname="watch.%s",' % name)
        d.put('name="%s",' % exp)
482
        d.put('exp="%s",' % exp)
483
484
485
486
487
        handled = False
        if exp == "<Edit>":
            d.put(',value=" ",')
            d.put('type=" ",numchild="0"')
        else:
488
            try:
489
                value = parseAndEvaluate(exp)
490
                item = Item(value, "watch.%s" % name, None, None)
491
                d.putItemHelper(item)
492
            except RuntimeError:
493
494
495
                d.put(',value="<invalid>",')
                d.put('type="<unknown>",numchild="0"')
        d.endHash()
496

hjk's avatar
hjk committed
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513

FrameCommand()



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

class Dumper:
    def __init__(self):
        self.output = ""
        self.safeoutput = ""
        self.childTypes = [""]
        self.childNumChilds = [-1]
514
515
        self.maxNumChilds = [-1]
        self.numChilds = [-1]
hjk's avatar
hjk committed
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545

    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('"')

546
    def beginChildren(self, numChild_ = 1, childType_ = None, childNumChild_ = None):
hjk's avatar
hjk committed
547
548
        childType = ""
        childNumChild = -1
549
550
551
552
553
554
        if type(numChild_) is list:
            numChild = numChild_[0]
            maxNumChild = numChild_[1]
        else:
            numChild = numChild_
            maxNumChild = numChild_
555
        if numChild == 0:
556
            childType_ = None
557
        self.putCommaIfNeeded()
558
559
        if not childType_ is None:
            childType = stripClassTag(str(childType_))
560
            self.put('childtype="%s",' % childType)
561
            if isSimpleType(childType_) or isStringType(self, childType_):
562
                self.put('childnumchild="0",')
hjk's avatar
hjk committed
563
                childNumChild = 0
564
            elif childType_.code == gdb.TYPE_CODE_PTR:
565
                self.put('childnumchild="1",')
hjk's avatar
hjk committed
566
                childNumChild = 1
567
568
569
        if not childNumChild_ is None:
            self.put('childnumchild="%s",' % childNumChild_)
            childNumChild = childNumChild_
hjk's avatar
hjk committed
570
571
        self.childTypes.append(childType)
        self.childNumChilds.append(childNumChild)
572
573
        self.numChilds.append(numChild)
        self.maxNumChilds.append(maxNumChild)
hjk's avatar
hjk committed
574
575
576
577
578
        #warn("BEGIN: %s" % self.childTypes)
        self.put("children=[")

    def endChildren(self):
        #warn("END: %s" % self.childTypes)
579
580
581
582
        numChild = self.numChilds.pop()
        maxNumChild = self.maxNumChilds.pop()
        if maxNumChild < numChild:
            self.putEllipsis();
hjk's avatar
hjk committed
583
584
585
586
        self.childTypes.pop()
        self.childNumChilds.pop()
        self.put(']')

587
588
589
    def childRange(self):
        return xrange(qmin(self.maxNumChilds[-1], self.numChilds[-1]))

hjk's avatar
hjk committed
590
591
592
593
594
595
596
597
598
599
600
601
602
603
    # 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]:
604
605
            self.putCommaIfNeeded()
            self.put('type="%s"' % type) # str(type.unqualified()) ?
hjk's avatar
hjk committed
606
607
608

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

612
613
614
615
616
617
618
619
620
621
622
623
624
625
    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))
626

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

hjk's avatar
hjk committed
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
    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):
649
650
651
652
653
        # This breaks for dumpers type names containing '__star'.
        # But this should not happen as identifiers containing two
        # subsequent underscores are reserved for the implemention.
        if typeobj.code == gdb.TYPE_CODE_PTR:
            return self.stripNamespaceFromType(typeobj.target()) + "__star"
hjk's avatar
hjk committed
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
        # 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()
672
673
        self.putName(name)
        self.putValue(value)
hjk's avatar
hjk committed
674
675
676
677
678
679
        self.putType("int")
        self.putNumChild(0)
        self.endHash()

    def putBoolItem(self, name, value):
        self.beginHash()
680
681
        self.putName(name)
        self.putValue(value)
hjk's avatar
hjk committed
682
683
684
685
686
687
688
689
690
        self.putType("bool")
        self.putNumChild(0)
        self.endHash()

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

691
    def dumpInnerValueHelper(self, item):
hjk's avatar
hjk committed
692
        if isSimpleType(item.value.type):
693
            self.safePutItemHelper(item)
hjk's avatar
hjk committed
694

695
696
697
698
699
    def safePutItem(self, item):
        self.beginHash()
        self.safePutItemHelper(item)
        self.endHash()

hjk's avatar
hjk committed
700
701
702
703
704
705
706
707
708
709
710
711
    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)

712
            except RuntimeError:
hjk's avatar
hjk committed
713
714
715
716
                self.output = ""
                # FIXME: Only catch debugger related exceptions
                #exType, exValue, exTraceback = sys.exc_info()
                #tb = traceback.format_exception(exType, exValue, exTraceback)
717
                #warn("Exception: %s" % ex.message)
hjk's avatar
hjk committed
718
719
720
721
722
                # DeprecationWarning: BaseException.message
                # has been deprecated
                #warn("Exception.")
                #for line in tb:
                #    warn("%s" % line)
723
724
725
726
                self.putName(item.name)
                self.putValue("<invalid>")
                self.putType(str(item.value.type))
                self.putNumChild(0)
hjk's avatar
hjk committed
727
728
729
730
731
732
733
                #if self.isExpanded(item):
                self.beginChildren()
                self.endChildren()
        self.pushOutput()

    def putItem(self, item):
        self.beginHash()
hjk's avatar
hjk committed
734
        self.safePutItemHelper(item)
hjk's avatar
hjk committed
735
736
737
738
739
740
        self.endHash()

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

741
    def putItemHelper(self, item):
hjk's avatar
hjk committed
742
743
        name = getattr(item, "name", None)
        if not name is None:
744
            self.putName(name)
hjk's avatar
hjk committed
745
746

        # FIXME: Gui shows references stripped?
747
        #warn(" ");
hjk's avatar
hjk committed
748
        #warn("REAL INAME: %s " % item.iname)
749
        #warn("REAL NAME: %s " % name)
hjk's avatar
hjk committed
750
        #warn("REAL TYPE: %s " % item.value.type)
751
        #warn("REAL VALUE: %s " % item.value)
752
753
754
755
        #try:
        #    warn("REAL VALUE: %s " % item.value)
        #except UnicodeEncodeError:
        #    warn("REAL VALUE: <unprintable>")
hjk's avatar
hjk committed
756
757
758
759
760
761
762
763
764
765
766
767
768

        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("::", "__")
769

hjk's avatar
hjk committed
770
771
772
773
        #warn(" STRIPPED: %s" % strippedType)
        #warn(" DUMPERS: %s" % self.dumpers)
        #warn(" DUMPERS: %s" % (strippedType in self.dumpers))

774
        if isSimpleType(type.unqualified()):
775
776
            #warn("IS SIMPLE: %s " % type)
            self.putType(item.value.type)
777
778
            self.putValue(value)
            self.putNumChild(0)
hjk's avatar
hjk committed
779
780

        elif strippedType in self.dumpers:
781
782
            #warn("IS DUMPABLE: %s " % type)
            self.putType(item.value.type)
hjk's avatar
hjk committed
783
            self.dumpers[strippedType](self, item)
784
            #warn(" RESULT: %s " % self.output)
hjk's avatar
hjk committed
785
786

        elif type.code == gdb.TYPE_CODE_ENUM:
787
            #warn("GENERIC ENUM: %s" % value)
788
            self.putType(item.value.type)
789
            self.putValue(value)
hjk's avatar
hjk committed
790
            self.putNumChild(0)
791

hjk's avatar
hjk committed
792
793

        elif type.code == gdb.TYPE_CODE_PTR:
794
            isHandled = False
795
            #warn("A POINTER: %s" % value.type)
796
797
798
799
800
801
802
            if self.useFancy:
                if isNull(value):
                    self.putValue("0x0")
                    self.putType(item.value.type)
                    self.putNumChild(0)
                    isHandled = True

803
804
                target = str(type.target().strip_typedefs().unqualified())
                if (not isHandled) and target == "void":
805
806
807
808
809
                    self.putType(item.value.type)
                    self.putValue(str(value))
                    self.putNumChild(0)
                    isHandled = True

810
                #warn("TARGET: %s " % target) 
811
812
                if (not isHandled) and (target == "char"
                        or target == "signed char" or target == "unsigned char"):
813
                    # Display values up to given length directly
814
                    #warn("CHAR AUTODEREF: %s" % value.address)
815
816
817
                    self.putType(item.value.type)
                    firstNul = -1
                    p = value
818
                    found = False
819
                    for i in xrange(100):
820
821
                        if p.dereference() == 0:
                            # Found terminating NUL
822
                            found = True
823
824
                            break
                        p += 1
825
826
827
828
829
830
831
                    if found:
                        self.putValue(encodeCharArray(value, i), "6")
                        self.putNumChild(0)
                    else:
                        self.putValue(encodeCharArray(value, 100) + "2e2e2e", "6")
                        self.putNumChild(0)
                    isHandled = True
832

833
834
835
836
837
            #warn("AUTODEREF: %s" % self.autoDerefPointers)
            #warn("IS HANDLED: %s" % isHandled)
            #warn("RES: %s" % (self.autoDerefPointers and not isHandled))
            if self.autoDerefPointers and not isHandled:
                ## Generic pointer type.
838
                #warn("GENERIC AUTODEREF POINTER: %s" % value.address)
839
840
841
842
843
844
845
846
847
848
849
                innerType = item.value.type.target()
                self.putType(innerType)
                self.childTypes.append(
                    stripClassTag(str(innerType)))
                self.putItemHelper(
                    Item(item.value.dereference(), item.iname, None, None))
                self.childTypes.pop()
                isHandled = True

            # Fall back to plain pointer printing
            if not isHandled:
850
                #warn("GENERIC PLAIN POINTER: %s" % value.type)
851
852
853
854
855
856
857
858
                self.putType(item.value.type)
                self.putValue(str(value.address))
                self.putNumChild(1)
                if self.isExpanded(item):
                    self.beginChildren()
                    self.putItem(
                          Item(item.value.dereference(), item.iname, "*", "*"))
                    self.endChildren()
hjk's avatar
hjk committed
859
860

        else:
861
            #warn("GENERIC STRUCT: %s" % value.type)
hjk's avatar
hjk committed
862
863
            #warn("INAME: %s " % item.iname)
            #warn("INAMES: %s " % self.expandedINames)
864
            #warn("EXPANDED: %s " % (item.iname in self.expandedINames))
hjk's avatar
hjk committed
865
866
867
868
869

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

870
            self.putType(item.value.type)
871
            self.putValue("{...}")
hjk's avatar
hjk committed
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886

            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()
887
                self.beginChildren(1, innerType)
hjk's avatar
hjk committed
888

889
                baseNumber = 0
890
                anonNumber = 0
hjk's avatar
hjk committed
891
892
893
894
895
896
897
898
899
900
901
                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())
902
                        for i in xrange(value.type.sizeof / innerType.sizeof):
hjk's avatar
hjk committed
903
904
905
906
907
908
909
910
911
912
913
                            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)):
914
915
916
917
918
919
920
921
922
923
                        # 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()
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
                    elif field.name == "":
                        # Anonymous union. We need a dummy name to distinguish
                        # multiple anonymous unions in the struct.
                        iname = "%s.#%d" % (item.iname, anonNumber)
                        anonNumber += 1
                        self.beginHash()
                        self.putField("iname", iname)
                        self.putField("name", "<n/a>")
                        self.putField("value", " ")
                        self.putField("type", "<anonymous union>")
                        if self.isExpandedIName(iname):
                            self.beginChildren()
                            for f in field.type.fields():
                                child = Item(item.value[f.name],
                                    item.iname, f.name, f.name)
                                self.safePutItem(child)
                            self.endChildren()
                        self.endHash()
hjk's avatar
hjk committed
942
                    else:
943
944
                        # Named field.
                        self.beginHash()
945
946
947
948
                        child = Item(value[field.name],
                            item.iname, field.name, field.name)
                        self.safePutItemHelper(child)
                        self.endHash()
949

hjk's avatar
hjk committed
950
                self.endChildren()