dumper.py 40.8 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
10
import os
11
import __builtin__
12
13
14

if os.name != "nt":
    import curses.ascii
hjk's avatar
hjk committed
15

16
# only needed for gdb 7.0/7.0.1 that do not implement parse_and_eval
17
18
19
import os
import tempfile

hjk's avatar
hjk committed
20
21
22
verbosity = 0
verbosity = 1

23
24
25
26
27
def select(condition, if_expr, else_expr):
    if condition:
        return if_expr
    return else_expr

28
29
30
31
32
def qmin(n, m):
    if n < m:
        return n
    return m

hjk's avatar
hjk committed
33
def isGoodGdb():
34
35
    #return gdb.VERSION.startswith("6.8.50.2009") \
    #   and gdb.VERSION != "6.8.50.20090630-cvs"
36
    return 'parse_and_eval' in __builtin__.dir(gdb)
hjk's avatar
hjk committed
37

38
def cleanAddress(addr):
39
40
    if addr is None:
        return "<no address>"
41
42
    # We cannot use str(addr) as it yields rubbish for char pointers
    # that might trigger Unicode encoding errors.
43
    return addr.cast(gdb.lookup_type("void").pointer())
44

hjk's avatar
hjk committed
45
46
47
48
# Workaround for gdb < 7.1
def numericTemplateArgument(type, position):
    try:
        return int(type.template_argument(position))
49
    except RuntimeError, error:
hjk's avatar
hjk committed
50
51
52
53
        # ": No type named 30."
        msg = str(error)
        return int(msg[14:-1])

54
def parseAndEvaluate(exp):
hjk's avatar
hjk committed
55
    if isGoodGdb():
56
57
58
59
        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")
60
61
62
63
    try:
        gdb.execute("print %s" % exp)
    except:
        gdb.execute("set logging off")
64
        gdb.execute("set logging redirect off")
65
        return None
66
    gdb.execute("set logging off")
67
    gdb.execute("set logging redirect off")
68
69
    return gdb.history(0)

70

71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
def catchCliOutput(command):
    file = tempfile.mkstemp(prefix="gdbpy_")
    filename = file[1]
    gdb.execute("set logging off")
    gdb.execute("set logging redirect off")
    gdb.execute("set logging file %s" % filename)
    gdb.execute("set logging redirect on")
    gdb.execute("set logging on")
    gdb.execute(command)
    gdb.execute("set logging off")
    gdb.execute("set logging redirect off")
    file = open(filename, "r")
    lines = []
    for line in file:
        lines.append(line)
    file.close()
    try:  # files may still be locked by gdb on Windows
        os.remove(filename)
    except:
        pass
    return lines


94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
class Breakpoint:
    def __init__(self):
        self.number = None
        self.filename = None
        self.linenumber = None
        self.address = []
        self.function = None
        self.fullname = None
        self.condition = None
        self.times = None

def listOfBreakpoints(d):
    # [bkpt={number="1",type="breakpoint",disp="keep",enabled="y",
    #addr="0x0804da6d",func="testHidden()",file="../app.cpp",
    #fullname="...",line="1292",times="1",original-location="\"app.cpp\":1292"},
    # Num     Type           Disp Enb Address    What\n"
    #1       breakpoint     keep y   0x0804da6d in testHidden() at app.cpp:1292
    #\tbreakpoint already hit 1 time
    #2       breakpoint     keep y   0x080564d3 in espace::..doit(int) at ../app.cpp:1210\n"
    #3       breakpoint     keep y   <PENDING>  \"plugin.cpp\":38\n"
    #4       breakpoint     keep y   <MULTIPLE> \n"
    #4.1                         y     0x08056673 in Foo at ../app.cpp:126\n"
    #4.2                         y     0x0805678b in Foo at ../app.cpp:126\n"
    #5       hw watchpoint  keep y              &main\n"
118
    #6       breakpoint     keep y   0xb6cf18e5 <__cxa_throw+5>\n"
119
    lines = catchCliOutput("info break")
120
121
122
123

    lines.reverse()
    bp = Breakpoint()
    for line in lines:
124
125
        if len(line) == 0 or line.startswith(" "):
            continue
126
127
128
129
130
131
132
133
134
135
        if line[0] < '0' or line[0] > '9':
            continue
        if line.startswith("\tstop only if "):
            bp.condition = line[14:]
            continue
        if line.startswith("\tbreakpoint already hit "):
            bp.times = line[24:]
            continue
        number = line[0:5]
        pos0x = line.find(" 0x")
136
        posin = line.find(" in ", pos0x)
137
        poslt = line.find(" <", pos0x)
138
        posat = line.find(" at ", posin)
139
        poscol = line.find(":", posat)
140
141
142
143
144
145
        if pos0x != -1:
            if pos0x < posin:
                bp.address.append(line[pos0x + 1 : posin])
            elif pos0x < poslt:
                bp.address.append(line[pos0x + 1 : poslt])
                bp.function = line[poslt + 2 : line.find('>', poslt)]
146
147
148
        # Take "no address" as indication that the bp is pending.
        #if line.find("<PENDING>") >= 0:
        #    bp.address.append("<PENDING>")
149
150
151
152
153
154
155
156
157
158
159
160
        if posin < posat and posin != -1:
            bp.function = line[posin + 4 : posat]
        if posat < poscol and poscol != -1:
            bp.filename = line[posat + 4 : poscol]
        if poscol != -1:
            bp.linenumber = line[poscol + 1 : -1]

        if '.' in number: # Part of multiple breakpoint.
            continue

        # A breakpoint of its own
        bp.number = int(number)
hjk's avatar
hjk committed
161
162
163
164
        d.put('bkpt={number="%s",' % bp.number)
        d.put('type="breakpoint",')
        d.put('disp="keep",')
        d.put('enabled="y",')
165
        for address in bp.address:
hjk's avatar
hjk committed
166
            d.put('addr="%s",' % address)
167
        if not bp.function is None:
hjk's avatar
hjk committed
168
            d.put('func="%s",' % bp.function)
169
        if not bp.filename is None:
hjk's avatar
hjk committed
170
            d.put('file="%s",' % bp.filename)
171
        if not bp.fullname is None:
hjk's avatar
hjk committed
172
            d.put('fullname="%s",' % bp.fullname)
173
        if not bp.linenumber is None:
hjk's avatar
hjk committed
174
            d.put('line="%s",' % bp.linenumber)
175
        if not bp.condition is None:
hjk's avatar
hjk committed
176
            d.put('cond="%s",' % bp.condition)
177
        if not bp.fullname is None:
hjk's avatar
hjk committed
178
            d.put('fullname="%s",' % bt.fullname)
179
        if not bp.times is None:
hjk's avatar
hjk committed
180
            d.put('times="1",' % bp.times)
181
        #d.put('original-location="-"')
hjk's avatar
hjk committed
182
        d.put('},')
183
184
185
        bp = Breakpoint()


186
187
188
189
190
191
192
193
194
195
196
# Creates a list of field names of an anon union or struct
def listOfFields(type):
    fields = []
    for field in type.fields():
        if len(field.name) > 0:
            fields += field.name
        else:
            fields += listOfFields(field.type)
    return fields


197
def listOfLocals(varList):
198
199
200
201
    try:
        frame = gdb.selected_frame()
        #warn("FRAME %s: " % frame)
    except RuntimeError:
202
        warn("FRAME NOT ACCESSIBLE")
hjk's avatar
hjk committed
203
        return []
204

205
    # gdb-6.8-symbianelf fails here
206
    hasBlock = 'block' in __builtin__.dir(frame)
207

208
    items = []
209
210
211
212
213
214
215
216
217
    if hasBlock and isGoodGdb():
        warn("IS GOOD: %s " % varList)
        try:
            block = frame.block()
            #warn("BLOCK: %s " % block)
        except:
            warn("BLOCK NOT ACCESSIBLE")
            return items

218
219
220
221
222
223
        while True:
            if block is None:
                warn("UNEXPECTED 'None' BLOCK")
                break
            for symbol in block:
                name = symbol.print_name
224

225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
                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
248
        # Assuming gdb 7.0 release or 6.8-symbianelf.
249
250
        file = tempfile.mkstemp(prefix="gdbpy_")
        filename = file[1]
251
252
        #warn("VARLIST: %s " % varList)
        #warn("VARLIST: %s " % len(varList))
hjk's avatar
hjk committed
253
254
        gdb.execute("set logging off")
        gdb.execute("set logging redirect off")
255
256
257
        gdb.execute("set logging file %s" % filename)
        gdb.execute("set logging redirect on")
        gdb.execute("set logging on")
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
        try:
            gdb.execute("info args")
            # We cannot use "info locals" as at least 6.8-symbianelf
            # aborts as soon as we hit unreadable memory.
            # gdb.execute("interpreter mi '-stack-list-locals 0'")
            # results in &"Recursive internal problem.\n", so we have
            # the frontend pass us the list of locals.

            # There are two cases, either varList is empty, so we have
            # to fetch the list here, or it is not empty with the
            # first entry being a dummy.
            if len(varList) == 0:
                gdb.execute("info locals")
            else:
                varList = varList[1:]
        except:
            pass
275
276
        gdb.execute("set logging off")
        gdb.execute("set logging redirect off")
277

278
279
280
281
        file = open(filename, "r")
        for line in file:
            if len(line) == 0 or line.startswith(" "):
                continue
282
            # The function parameters
283
284
285
            pos = line.find(" = ")
            if pos < 0:
                continue
286
287
            varList.append(line[0:pos])
        file.close()
288
289
290
291
        try:  # files may still be locked by gdb on Windows
            os.remove(filename)
        except:
            pass
292
293
294
        #warn("VARLIST: %s " % varList)
        for name in varList:
            #warn("NAME %s " % name)
295
296
297
298
            item = Item(0, "local", name, name)
            try:
                item.value = frame.read_var(name)  # this is a gdb value
            except RuntimeError:
299
300
                pass
                #continue
301
302
303
304
305
            items.append(item)

    return items


306
def value(expr):
307
    value = parseAndEvaluate(expr)
308
309
310
311
312
    try:
        return int(value)
    except:
        return str(value)

313

hjk's avatar
hjk committed
314
def isSimpleType(typeobj):
315
316
    if typeobj.code == gdb.TYPE_CODE_PTR:
        return False
hjk's avatar
hjk committed
317
318
319
320
321
322
323
324
    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 ") \
325
        or type == "signed" or type.startswith("signed ") \
hjk's avatar
hjk committed
326
327
        or type == "unsigned" or type.startswith("unsigned ")

328

hjk's avatar
hjk committed
329
330
331
332
333
334
335
336
337
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):
338
339
    if True or verbosity > 0:
        print "XXX: %s\n" % message.encode("latin1")
hjk's avatar
hjk committed
340
341
342
343
344
345
    pass

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

346
347
348
349
350
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
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
#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):
372
373
374
375
    # 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 ")
376
    return p.cast(gdb.lookup_type("void").pointer()) == 0
hjk's avatar
hjk committed
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

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):
403
    for i in xrange(n):
hjk's avatar
hjk committed
404
405
406
407
408
409
        checkPointer(p)
        ++p

def call(value, func):
    #warn("CALL: %s -> %s" % (value, func))
    type = stripClassTag(str(value.type))
410
    if type.find(":") >= 0:
hjk's avatar
hjk committed
411
412
413
        type = "'" + type + "'"
    exp = "((%s*)%s)->%s" % (type, value.address, func)
    #warn("CALL: %s" % exp)
414
    result = parseAndEvaluate(exp)
hjk's avatar
hjk committed
415
416
417
    #warn("  -> %s" % result)
    return result

418
419
def qtNamespace():
    try:
420
        type = str(parseAndEvaluate("&QString::null").type.target().unqualified())
421
422
423
        return type[0:len(type) - len("QString::null")]
    except RuntimeError:
        return ""
424
425
426
    except AttributeError:
        # Happens for none-Qt applications
        return ""
hjk's avatar
hjk committed
427

428
429
def encodeCharArray(p, size):
    s = ""
430
    p = p.cast(gdb.lookup_type("unsigned char").pointer())
431
    for i in xrange(size):
432
433
434
435
        s += "%02x" % int(p.dereference())
        p += 1
    return s

436
437
438
439
440
441
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)
442
    checkRef(d_ptr["ref"])
443
444
445
446
447
448
    if size > 0:
        checkAccess(data, 4)
        checkAccess(data + size) == 0

    innerType = gdb.lookup_type("char")
    p = gdb.Value(data.cast(innerType.pointer()))
449
    return encodeCharArray(p, size)
450
451
452
453
454
455
456
457
458
459

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
460
    checkRef(d_ptr["ref"])
461
462
    p = gdb.Value(d_ptr["data"])
    s = ""
463
    for i in xrange(size):
464
465
466
467
468
469
        val = int(p.dereference())
        s += "%02x" % (val % 256)
        s += "%02x" % (val / 256)
        p += 1
    return s

hjk's avatar
hjk committed
470
471
472
473
474
475
476
#######################################################################
#
# Item
#
#######################################################################

class Item:
477
    def __init__(self, value, parentiname, iname, name = None):
hjk's avatar
hjk committed
478
        self.value = value
479
480
481
482
        if iname is None:
            self.iname = parentiname
        else:
            self.iname = "%s.%s" % (parentiname, iname)
hjk's avatar
hjk committed
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
        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(' ')
500

hjk's avatar
hjk committed
501
502
        #warn("ARG: %s" % arg)
        #warn("ARGS: %s" % args)
503
        options = args[0].split(",")
504
505
506
507
508
509
510
511
512
513
514
        varList = args[1][1:]
        if len(varList) == 0:
            varList = []
        else:
            varList = varList.split(",")
        expandedINames = set(args[2].split(","))
        watchers = ""
        if len(args) > 3:
            watchers = base64.b16decode(args[3], True)
        #warn("WATCHERS: %s" % watchers)

515
        useFancy = "fancy" in options
516
517

        #warn("VARIABLES: %s" % varList)
hjk's avatar
hjk committed
518
519
520
521
        #warn("EXPANDED INAMES: %s" % expandedINames)
        module = sys.modules[__name__]
        self.dumpers = {}

hjk's avatar
hjk committed
522
523
524
        if useFancy == -1:
            output = "dumpers=["
            for key, value in module.__dict__.items():
525
                if key.startswith("qdump__"):
hjk's avatar
hjk committed
526
527
                    if output != "dumpers=[":
                        output += ","
528
                    output += '"' + key[7:] + '"'
hjk's avatar
hjk committed
529
530
            output += "],"
            #output += "qtversion=[%d,%d,%d]"
531
            #output += "qtversion=[4,6,0],"
hjk's avatar
hjk committed
532
533
534
535
536
537
538
            output += "namespace=\"%s\"," % qtNamespace()
            output += "dumperversion=\"2.0\","
            output += "sizes=[],"
            output += "expressions=[]"
            output += "]"
            print output
            return
539

540

hjk's avatar
hjk committed
541
542
        if useFancy:
            for key, value in module.__dict__.items():
543
544
                if key.startswith("qdump__"):
                    self.dumpers[key[7:]] = value
hjk's avatar
hjk committed
545
546
547

        d = Dumper()
        d.dumpers = self.dumpers
548
549
550
        d.useFancy = useFancy
        d.passExceptions = "passexceptions" in options
        d.autoDerefPointers = "autoderef" in options
551
        d.ns = qtNamespace()
552
        d.expandedINames = expandedINames
hjk's avatar
hjk committed
553
554
        #warn(" NAMESPACE IS: '%s'" % d.ns)

555
556
557
        #
        # Locals
        #
558
        for item in listOfLocals(varList):
559
            #warn("ITEM NAME %s: " % item.name)
560
561
562
            try:
                #warn("ITEM VALUE %s: " % item.value)
                # Throw on funny stuff, catch below.
hjk's avatar
hjk committed
563
564
565
566
                # Unfortunately, this fails also with a "Unicode encoding error"
                # in testArray().
                #dummy = str(item.value)
                pass
567
568
569
570
571
572
573
574
575
576
577
            except:
                # Locals with failing memory access.
                d.beginHash()
                d.put('iname="%s",' % item.iname)
                d.put('name="%s",' % item.name)
                d.put('addr="<not accessible>",')
                d.put('value="<not accessible>",')
                d.put('type="%s",' % item.value.type)
                d.put('numchild="0"');
                d.endHash()
                continue
578
579
580
581

            type = item.value.type
            if type.code == gdb.TYPE_CODE_PTR \
                    and item.name == "argv" and str(type) == "char **":
582
                # Special handling for char** argv.
583
584
                n = 0
                p = item.value
585
586
587
588
589
                # p is 0 for "optimized out" cases.
                if not isNull(p):
                    while not isNull(p.dereference()) and n <= 100:
                        p += 1
                        n += 1
590
591
592
593
594
595
596
597

                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):
598
                    p = item.value
599
                    d.beginChildren(n)
600
                    for i in xrange(n):
601
602
                        value = p.dereference()
                        d.putItem(Item(value, item.iname, i, None))
603
                        p += 1
604
605
606
607
608
609
                    if n > 100:
                        d.putEllipsis()
                    d.endChildren()
                d.endHash()

            else:
610
                # A "normal" local variable or parameter.
611
                try:
612
613
614
615
616
617
                   addr = cleanAddress(item.value.address)
                   d.beginHash()
                   d.put('iname="%s",' % item.iname)
                   d.put('addr="%s",' % addr)
                   d.safePutItemHelper(item)
                   d.endHash()
618
                except AttributeError:
619
620
                    # Thrown by cleanAddress with message "'NoneType' object
                    # has no attribute 'cast'" for optimized-out values.
621
622
623
624
625
626
627
                    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
628

629
630
631
632
        d.pushOutput()
        locals = d.safeoutput


633
634
635
        #
        # Watchers
        #
636
        d.safeoutput = ""
637
        if len(watchers) > 0:
638
            for watcher in watchers.split("##"):
639
640
                (exp, iname) = watcher.split("#")
                self.handleWatch(d, exp, iname)
641
642
643
        d.pushOutput()
        watchers = d.safeoutput

hjk's avatar
hjk committed
644
645
646
647
        sep = ""
        if len(locals) and len(watchers):
            sep = ","

648
649
650
        #
        # Breakpoints
        #
651
652
653
654
655
656
657
658
        #breakpoints = ""
        #d.safeoutput = ""
        #listOfBreakpoints(d)
        #d.pushOutput()
        #breakpoints = d.safeoutput

        #print('data=[' + locals + sep + watchers + '],bkpts=[' + breakpoints + ']\n')
        print('data=[' + locals + sep + watchers + ']\n')
659

660

661
662
    def handleWatch(self, d, exp, iname):
        #warn("HANDLING WATCH %s, INAME: '%s'" % (exp, iname))
663
        if exp.startswith("["):
664
            warn("EVAL: EXP: %s" % exp)
665
            d.beginHash()
666
            d.put('iname="%s",' % iname)
667
            d.put('name="%s",' % exp)
668
            d.put('exp="%s",' % exp)
669
670
            try:
                list = eval(exp)
671
                #warn("EVAL: LIST: %s" % list)
672
673
674
675
676
677
678
                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:
679
                    self.handleWatch(d, item, "%s.%d" % (iname, itemNumber))
680
681
682
683
684
685
686
687
688
689
690
691
692
                    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()
693
        d.put('iname="%s",' % iname)
694
        d.put('name="%s",' % exp)
695
        d.put('exp="%s",' % exp)
696
697
        handled = False
        if exp == "<Edit>":
hjk's avatar
hjk committed
698
            d.put('value=" ",type=" ",numchild="0",')
699
        else:
700
            try:
701
                value = parseAndEvaluate(exp)
702
                item = Item(value, iname, None, None)
703
                d.putItemHelper(item)
704
            except RuntimeError:
hjk's avatar
hjk committed
705
                d.put('value="<invalid>",type="<unknown>",numchild="0",')
706
        d.endHash()
707

hjk's avatar
hjk committed
708
709
710
711

FrameCommand()


712
713
714
715
716
717
718
719
720
721
722
723
724
725
#######################################################################
#
# Step Command
#
#######################################################################


class SalCommand(gdb.Command):
    """Do fancy stuff."""

    def __init__(self):
        super(SalCommand, self).__init__("sal", gdb.COMMAND_OBSCURE)

    def invoke(self, arg, from_tty):
726
727
        (cmd, addr) = arg.split(",")
        lines = catchCliOutput("info line *" + addr)
728
729
730
731
732
733
734
735
736
737
        fromAddr = "0x0"
        toAddr = "0x0"
        for line in lines:
            pos0from = line.find(" starts at address") + 19
            pos1from = line.find(" ", pos0from)
            pos0to = line.find(" ends at", pos1from) + 9
            pos1to = line.find(" ", pos0to)
            if pos1to > 0:
                fromAddr = line[pos0from : pos1from]
                toAddr = line[pos0to : pos1to]
738
        gdb.execute("maint packet sal%s,%s,%s" % (cmd,fromAddr, toAddr))
739
740

SalCommand()
hjk's avatar
hjk committed
741

742

hjk's avatar
hjk committed
743
744
745
746
747
748
749
750
751
752
753
754
#######################################################################
#
# The Dumper Class
#
#######################################################################

class Dumper:
    def __init__(self):
        self.output = ""
        self.safeoutput = ""
        self.childTypes = [""]
        self.childNumChilds = [-1]
755
756
        self.maxNumChilds = [-1]
        self.numChilds = [-1]
hjk's avatar
hjk committed
757
758
759
760
761

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

    def putField(self, name, value):
hjk's avatar
hjk committed
762
        self.put('%s="%s",' % (name, value))
hjk's avatar
hjk committed
763
764
765
766
767

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

    def endHash(self):
hjk's avatar
hjk committed
768
        self.put('},')
hjk's avatar
hjk committed
769
770

    def beginItem(self, name):
hjk's avatar
hjk committed
771
        self.put('%s="' %s)
hjk's avatar
hjk committed
772
773

    def endItem(self):
hjk's avatar
hjk committed
774
        self.put('",')
hjk's avatar
hjk committed
775

776
    def beginChildren(self, numChild_ = 1, childType_ = None, childNumChild_ = None):
hjk's avatar
hjk committed
777
778
        childType = ""
        childNumChild = -1
779
780
781
782
783
784
        if type(numChild_) is list:
            numChild = numChild_[0]
            maxNumChild = numChild_[1]
        else:
            numChild = numChild_
            maxNumChild = numChild_
785
        if numChild == 0:
786
787
788
            childType_ = None
        if not childType_ is None:
            childType = stripClassTag(str(childType_))
789
            self.put('childtype="%s",' % childType)
790
            if isSimpleType(childType_) or isStringType(self, childType_):
791
                self.put('childnumchild="0",')
hjk's avatar
hjk committed
792
                childNumChild = 0
793
            elif childType_.code == gdb.TYPE_CODE_PTR:
794
                self.put('childnumchild="1",')
hjk's avatar
hjk committed
795
                childNumChild = 1
796
797
798
        if not childNumChild_ is None:
            self.put('childnumchild="%s",' % childNumChild_)
            childNumChild = childNumChild_
hjk's avatar
hjk committed
799
800
        self.childTypes.append(childType)
        self.childNumChilds.append(childNumChild)
801
802
        self.numChilds.append(numChild)
        self.maxNumChilds.append(maxNumChild)
hjk's avatar
hjk committed
803
804
805
806
807
        #warn("BEGIN: %s" % self.childTypes)
        self.put("children=[")

    def endChildren(self):
        #warn("END: %s" % self.childTypes)
808
809
810
811
        numChild = self.numChilds.pop()
        maxNumChild = self.maxNumChilds.pop()
        if maxNumChild < numChild:
            self.putEllipsis();
hjk's avatar
hjk committed
812
813
        self.childTypes.pop()
        self.childNumChilds.pop()
hjk's avatar
hjk committed
814
        self.put('],')
hjk's avatar
hjk committed
815

816
817
818
    def childRange(self):
        return xrange(qmin(self.maxNumChilds[-1], self.numChilds[-1]))

hjk's avatar
hjk committed
819
820
    # convenience
    def putItemCount(self, count):
hjk's avatar
hjk committed
821
        self.put('value="<%s items>",' % count)
hjk's avatar
hjk committed
822
823

    def putEllipsis(self):
hjk's avatar
hjk committed
824
        self.put('{name="<incomplete>",value="",type="",numchild="0"},')
hjk's avatar
hjk committed
825
826
827
828
829
830

    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]:
hjk's avatar
hjk committed
831
            self.put('type="%s",' % type) # str(type.unqualified()) ?
hjk's avatar
hjk committed
832
833
834

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

838
839
840
841
842
843
    def putValue(self, value, encoding = None):
        if not encoding is None:
            self.putField("valueencoded", encoding)
        self.putField("value", value)

    def putStringValue(self, value):
844
        if value is None:
hjk's avatar
hjk committed
845
            self.put('value="<not available>",')
846
847
        else:
            str = encodeString(value)
hjk's avatar
hjk committed
848
            self.put('valueencoded="%d",value="%s",' % (7, str))
849
850
851

    def putByteArrayValue(self, value):
        str = encodeByteArray(value)
hjk's avatar
hjk committed
852
        self.put('valueencoded="%d",value="%s",' % (6, str))
853

854
    def putName(self, name):
hjk's avatar
hjk committed
855
        self.put('name="%s",' % name)
856

hjk's avatar
hjk committed
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
    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):
875
876
877
878
879
        # 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
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
        # 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()
898
899
        self.putName(name)
        self.putValue(value)
hjk's avatar
hjk committed
900
901
902
903
904
905
        self.putType("int")
        self.putNumChild(0)
        self.endHash()

    def putBoolItem(self, name, value):
        self.beginHash()
906
907
        self.putName(name)
        self.putValue(value)
hjk's avatar
hjk committed
908
909
910
911
912
913
914
915
916
        self.putType("bool")
        self.putNumChild(0)
        self.endHash()

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

917
    def dumpInnerValueHelper(self, item):
hjk's avatar
hjk committed
918
        if isSimpleType(item.value.type):
919
            self.safePutItemHelper(item)
hjk's avatar
hjk committed
920

921
922
923
924
925
    def safePutItem(self, item):
        self.beginHash()
        self.safePutItemHelper(item)
        self.endHash()

hjk's avatar
hjk committed
926
927
928
929
930
931
932
933
934
935
936
937
    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)

938
            except RuntimeError:
hjk's avatar
hjk committed
939
940
941
942
                self.output = ""
                # FIXME: Only catch debugger related exceptions
                #exType, exValue, exTraceback = sys.exc_info()
                #tb = traceback.format_exception(exType, exValue, exTraceback)
943
                #warn("Exception: %s" % ex.message)
hjk's avatar
hjk committed
944
945
946
947
948
                # DeprecationWarning: BaseException.message
                # has been deprecated
                #warn("Exception.")
                #for line in tb:
                #    warn("%s" % line)
949
950
951
952
                self.putName(item.name)
                self.putValue("<invalid>")
                self.putType(str(item.value.type))
                self.putNumChild(0)
hjk's avatar
hjk committed
953
954
955
956
957
958
959
                #if self.isExpanded(item):
                self.beginChildren()
                self.endChildren()
        self.pushOutput()

    def putItem(self, item):
        self.beginHash()
hjk's avatar
hjk committed
960
        self.safePutItemHelper(item)
hjk's avatar
hjk committed
961
962
963
        self.endHash()

    def putCallItem(self, name, item, func):
964
965
966
967
968
        try:
            result = call(item.value, func)
            self.safePutItem(Item(result, item.iname, name, name))
        except:
            self.safePutItem(Item(None, item.iname))
hjk's avatar
hjk committed
969

970
    def putItemHelper(self, item):
hjk's avatar
hjk committed
971
972
        name = getattr(item, "name", None)
        if not name is None:
973
            self.putName(name)
hjk's avatar
hjk committed
974

975
976
977
978
979
980
981
982
        if item.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

hjk's avatar
hjk committed
983
        # FIXME: Gui shows references stripped?
984
        #warn(" ");
hjk's avatar
hjk committed
985
        #warn("REAL INAME: %s " % item.iname)
986
        #warn("REAL NAME: %s " % name)
hjk's avatar
hjk committed
987
        #warn("REAL TYPE: %s " % item.value.type)
988
        #warn("REAL VALUE: %s " % item.value)
989
990
        #try:
        #    warn("REAL VALUE: %s " % item.value)
991
992
        #except:
        #    #UnicodeEncodeError:
993
        #    warn("REAL VALUE: <unprintable>")
hjk's avatar
hjk committed
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006

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

hjk's avatar
hjk committed
1008
1009
1010
1011
        #warn(" STRIPPED: %s" % strippedType)
        #warn(" DUMPERS: %s" % self.dumpers)
        #warn(" DUMPERS: %s" % (strippedType in self.dumpers))

1012
        if isSimpleType(type.unqualified()):
1013
1014
            #warn("IS SIMPLE: %s " % type)
            self.putType(item.value.type)
1015
1016
            self.putValue(value)
            self.putNumChild(0)
hjk's avatar
hjk committed
1017
1018

        elif strippedType in self.dumpers:
1019
1020
            #warn("IS DUMPABLE: %s " % type)
            self.putType(item.value.type)
hjk's avatar
hjk committed
1021
            self.dumpers[strippedType](self, item)
1022
            #warn(" RESULT: %s " % self.output)
hjk's avatar
hjk committed
1023
1024

        elif type.code == gdb.TYPE_CODE_ENUM:
1025
            #warn("GENERIC ENUM: %s" % value)
1026
            self.putType(item.value.type)
1027
            self.putValue(value)
hjk's avatar
hjk committed
1028
            self.putNumChild(0)
1029

hjk's avatar
hjk committed
1030
1031

        elif type.code == gdb.TYPE_CODE_PTR:
1032
            #warn("A POINTER: %s" % value.type)
1033
1034
1035
            isHandled = False

            if str(type.strip_typedefs()).find("(") != -1:
1036
                # A function pointer.
1037
1038
1039
1040
1041
1042
1043
                self.putValue(str(item.value))
                self.put('addr="%s",' % cleanAddress(value.address))
                self.putType(item.value.type)
                self.putNumChild(0)
                isHandled = True

            if (not isHandled) and self.useFancy:
1044
1045
1046
1047
1048
1049
                if isNull(value):
                    self.putValue("0x0")
                    self.putType(item.value.type)
                    self.putNumChild(0)
                    isHandled = True

1050
1051
                target = str(type.target().strip_typedefs().unqualified())
                if (not isHandled) and target == "void":
1052
1053
1054
1055
1056
                    self.putType(item.value.type)
                    self.putValue(str(value))
                    self.putNumChild(0)
                    isHandled = True

1057
                #warn("TARGET: %s " % target)
1058
1059
                if (not isHandled) and (target == "char"
                        or target == "signed char" or target == "unsigned char"):
1060
                    # Display values up to given length directly
1061
                    #warn("CHAR AUTODEREF: %s" % value.address)
1062
1063
1064
                    self.putType(item.value.type)
                    firstNul = -1
                    p = value
1065
                    found = False
1066
                    for i in xrange(100):
1067
1068
                        if p.dereference() == 0:
                            # Found terminating NUL
1069
                            found = True
1070
1071
                            break
                        p += 1
1072
1073
1074
1075
1076
1077
1078
                    if found:
                        self.putValue(encodeCharArray(value, i), "6")
                        self.putNumChild(0)
                    else:
                        self.putValue(encodeCharArray(value, 100) + "2e2e2e", "6")
                        self.putNumChild(0)
                    isHandled = True
1079

1080
1081
1082
1083
1084
            #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.
1085
                #warn("GENERIC AUTODEREF POINTER: %s" % value.address)
1086
1087
1088
1089
1090
1091
1092
1093
1094
                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

1095
            # Fall back to plain pointer printing.
1096
            if not isHandled:
1097
                #warn("GENERIC PLAIN POINTER: %s" % value.type)
1098
                self.putType(item.value.type)
1099
1100
                self.putValue(str(value))
                self.put('addr="%s",' % cleanAddress(value.address))
1101
1102
1103
1104
1105
1106
                self.putNumChild(1)
                if self.isExpanded(item):
                    self.beginChildren()
                    self.putItem(
                          Item(item.value.dereference(), item.iname, "*", "*"))
                    self.endChildren()
hjk's avatar
hjk committed
1107
1108

        else:
1109
            #warn("GENERIC STRUCT: %s" % item.value.type)
hjk's avatar
hjk committed
1110
1111
            #warn("INAME: %s " % item.iname)
            #warn("INAMES: %s " % self.expandedINames)
1112
            #warn("EXPANDED: %s " % (item.iname in self.expandedINames))
hjk's avatar
hjk committed
1113
1114
1115
1116
1117

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

1118
            self.putType(item.value.type)
1119
            self.putValue("{...}")
hjk's avatar
hjk committed
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131

            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):
1132