dumper.py 39 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
11
12
13
import os

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

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

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

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

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

hjk's avatar
hjk committed
32
def isGoodGdb():
33
34
35
    #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
36

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

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

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

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
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")
    gdb.execute("set logging file \"\"")
    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


90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
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"
114
    lines = catchCliOutput("info break")
115
116
117
118

    lines.reverse()
    bp = Breakpoint()
    for line in lines:
119
120
        if len(line) == 0 or line.startswith(" "):
            continue
121
122
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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
        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")
        posin = line.find(" in ")
        posat = line.find(" at ")
        poscol = line.find(":", posat)
        if pos0x < posin and pos0x != -1:
            bp.address.append(line[pos0x + 1 : posin])
        if line.find("<PENDING>") >= 0:
            bp.address.append("<PENDING>")
        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)
        d.putCommaIfNeeded()
        d.put('bkpt={number="%s"' % bp.number)
        d.put(',type="breakpoint"')
        d.put(',disp="keep"')
        d.put(',enabled="y"')
        for address in bp.address:
            d.put(',addr="%s"' % address)
        if not bp.function is None:
            d.put(',func="%s"' % bp.function)
        if not bp.filename is None:
            d.put(',file="%s"' % bp.filename)
        if not bp.fullname is None:
            d.put(',fullname="%s"' % bp.fullname)
        if not bp.linenumber is None:
            d.put(',line="%s"' % bp.linenumber)
        if not bp.condition is None:
            d.put(',cond="%s"' % bp.condition)
        if not bp.fullname is None:
            d.put(',fullname="%s"' % bt.fullname)
        if not bp.times is None:
            d.put(',times="1"' % bp.times)
        #d.put('original-location="-"')
        d.put('}')
        bp = Breakpoint()


176
def listOfLocals(varList):
177
178
179
180
    try:
        frame = gdb.selected_frame()
        #warn("FRAME %s: " % frame)
    except RuntimeError:
181
        warn("FRAME NOT ACCESSIBLE")
hjk's avatar
hjk committed
182
        return []
183

184
185
186
    # gdb-6.8-symbianelf fails here
    hasBlock = 'block' in dir(frame)

187
    items = []
188
189
190
191
192
193
194
195
196
    if hasBlock and isGoodGdb():
        warn("IS GOOD: %s " % varList)
        try:
            block = frame.block()
            #warn("BLOCK: %s " % block)
        except:
            warn("BLOCK NOT ACCESSIBLE")
            return items

197
198
199
200
201
202
        while True:
            if block is None:
                warn("UNEXPECTED 'None' BLOCK")
                break
            for symbol in block:
                name = symbol.print_name
203

204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
                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
227
        # Assuming gdb 7.0 release or 6.8-symbianelf.
228
229
        file = tempfile.mkstemp(prefix="gdbpy_")
        filename = file[1]
230
231
        #warn("VARLIST: %s " % varList)
        #warn("VARLIST: %s " % len(varList))
hjk's avatar
hjk committed
232
233
        gdb.execute("set logging off")
        gdb.execute("set logging redirect off")
234
235
236
        gdb.execute("set logging file %s" % filename)
        gdb.execute("set logging redirect on")
        gdb.execute("set logging on")
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
        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
254
255
        gdb.execute("set logging off")
        gdb.execute("set logging redirect off")
256

257
258
259
260
        file = open(filename, "r")
        for line in file:
            if len(line) == 0 or line.startswith(" "):
                continue
261
            # The function parameters
262
263
264
            pos = line.find(" = ")
            if pos < 0:
                continue
265
266
            varList.append(line[0:pos])
        file.close()
267
268
269
270
        try:  # files may still be locked by gdb on Windows
            os.remove(filename)
        except:
            pass
271
272
273
        #warn("VARLIST: %s " % varList)
        for name in varList:
            #warn("NAME %s " % name)
274
275
276
277
            item = Item(0, "local", name, name)
            try:
                item.value = frame.read_var(name)  # this is a gdb value
            except RuntimeError:
278
279
                pass
                #continue
280
281
282
283
284
            items.append(item)

    return items


285
def value(expr):
286
    value = parseAndEvaluate(expr)
287
288
289
290
291
    try:
        return int(value)
    except:
        return str(value)

292

hjk's avatar
hjk committed
293
def isSimpleType(typeobj):
294
295
    if typeobj.code == gdb.TYPE_CODE_PTR:
        return False
hjk's avatar
hjk committed
296
297
298
299
300
301
302
303
    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 ") \
304
        or type == "signed" or type.startswith("signed ") \
hjk's avatar
hjk committed
305
306
        or type == "unsigned" or type.startswith("unsigned ")

307

hjk's avatar
hjk committed
308
309
310
311
312
313
314
315
316
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):
317
318
    if True or verbosity > 0:
        print "XXX: %s\n" % message.encode("latin1")
hjk's avatar
hjk committed
319
320
321
322
323
324
    pass

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

325
326
327
328
329
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
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
#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):
351
352
353
354
    # 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 ")
355
    return p.cast(gdb.lookup_type("void").pointer()) == 0
hjk's avatar
hjk committed
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381

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):
382
    for i in xrange(n):
hjk's avatar
hjk committed
383
384
385
386
387
388
        checkPointer(p)
        ++p

def call(value, func):
    #warn("CALL: %s -> %s" % (value, func))
    type = stripClassTag(str(value.type))
389
    if type.find(":") >= 0:
hjk's avatar
hjk committed
390
391
392
        type = "'" + type + "'"
    exp = "((%s*)%s)->%s" % (type, value.address, func)
    #warn("CALL: %s" % exp)
393
    result = parseAndEvaluate(exp)
hjk's avatar
hjk committed
394
395
396
    #warn("  -> %s" % result)
    return result

397
398
def qtNamespace():
    try:
399
        type = str(parseAndEvaluate("&QString::null").type.target().unqualified())
400
401
402
        return type[0:len(type) - len("QString::null")]
    except RuntimeError:
        return ""
403
404
405
    except AttributeError:
        # Happens for none-Qt applications
        return ""
hjk's avatar
hjk committed
406

407
408
def encodeCharArray(p, size):
    s = ""
409
    p = p.cast(gdb.lookup_type("unsigned char").pointer())
410
    for i in xrange(size):
411
412
413
414
        s += "%02x" % int(p.dereference())
        p += 1
    return s

415
416
417
418
419
420
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)
421
    checkRef(d_ptr["ref"])
422
423
424
425
426
427
    if size > 0:
        checkAccess(data, 4)
        checkAccess(data + size) == 0

    innerType = gdb.lookup_type("char")
    p = gdb.Value(data.cast(innerType.pointer()))
428
    return encodeCharArray(p, size)
429
430
431
432
433
434
435
436
437
438

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
439
    checkRef(d_ptr["ref"])
440
441
    p = gdb.Value(d_ptr["data"])
    s = ""
442
    for i in xrange(size):
443
444
445
446
447
448
        val = int(p.dereference())
        s += "%02x" % (val % 256)
        s += "%02x" % (val / 256)
        p += 1
    return s

hjk's avatar
hjk committed
449
450
451
452
453
454
455
#######################################################################
#
# Item
#
#######################################################################

class Item:
456
    def __init__(self, value, parentiname, iname, name = None):
hjk's avatar
hjk committed
457
        self.value = value
458
459
460
461
        if iname is None:
            self.iname = parentiname
        else:
            self.iname = "%s.%s" % (parentiname, iname)
hjk's avatar
hjk committed
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
        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(' ')
479

hjk's avatar
hjk committed
480
481
        #warn("ARG: %s" % arg)
        #warn("ARGS: %s" % args)
482
        options = args[0].split(",")
483
484
485
486
487
488
489
490
491
492
493
        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)

494
        useFancy = "fancy" in options
495
496

        #warn("VARIABLES: %s" % varList)
hjk's avatar
hjk committed
497
498
499
500
        #warn("EXPANDED INAMES: %s" % expandedINames)
        module = sys.modules[__name__]
        self.dumpers = {}

hjk's avatar
hjk committed
501
502
503
        if useFancy == -1:
            output = "dumpers=["
            for key, value in module.__dict__.items():
504
                if key.startswith("qdump__"):
hjk's avatar
hjk committed
505
506
                    if output != "dumpers=[":
                        output += ","
507
                    output += '"' + key[7:] + '"'
hjk's avatar
hjk committed
508
509
            output += "],"
            #output += "qtversion=[%d,%d,%d]"
510
            #output += "qtversion=[4,6,0],"
hjk's avatar
hjk committed
511
512
513
514
515
516
517
            output += "namespace=\"%s\"," % qtNamespace()
            output += "dumperversion=\"2.0\","
            output += "sizes=[],"
            output += "expressions=[]"
            output += "]"
            print output
            return
518

519

hjk's avatar
hjk committed
520
521
        if useFancy:
            for key, value in module.__dict__.items():
522
523
                if key.startswith("qdump__"):
                    self.dumpers[key[7:]] = value
hjk's avatar
hjk committed
524
525
526

        d = Dumper()
        d.dumpers = self.dumpers
527
528
529
        d.useFancy = useFancy
        d.passExceptions = "passexceptions" in options
        d.autoDerefPointers = "autoderef" in options
530
        d.ns = qtNamespace()
531
        d.expandedINames = expandedINames
hjk's avatar
hjk committed
532
533
        #warn(" NAMESPACE IS: '%s'" % d.ns)

534
535
536
        #
        # Locals
        #
537
        for item in listOfLocals(varList):
538
            #warn("ITEM NAME %s: " % item.name)
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
            try:
                #warn("ITEM VALUE %s: " % item.value)
                # Throw on funny stuff, catch below.
                dummy = str(item.value)
            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
554
555
556
557

            type = item.value.type
            if type.code == gdb.TYPE_CODE_PTR \
                    and item.name == "argv" and str(type) == "char **":
558
                # Special handling for char** argv.
559
560
                n = 0
                p = item.value
561
562
563
564
565
                # p is 0 for "optimized out" cases.
                if not isNull(p):
                    while not isNull(p.dereference()) and n <= 100:
                        p += 1
                        n += 1
566
567
568
569
570
571
572
573

                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):
574
                    p = item.value
575
                    d.beginChildren(n)
576
                    for i in xrange(n):
577
578
                        value = p.dereference()
                        d.putItem(Item(value, item.iname, i, None))
579
                        p += 1
580
581
582
583
584
585
                    if n > 100:
                        d.putEllipsis()
                    d.endChildren()
                d.endHash()

            else:
586
                # A "normal" local variable or parameter.
587
588
589
590
591
592
593
594
                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:
595
596
                    # Thrown by cleanAddress with message "'NoneType' object
                    # has no attribute 'cast'" for optimized-out values.
597
598
599
600
601
602
603
                    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
604

605
606
607
608
        d.pushOutput()
        locals = d.safeoutput


609
610
611
        #
        # Watchers
        #
612
        d.safeoutput = ""
613
        if len(watchers) > 0:
614
            for watcher in watchers.split("##"):
615
616
                (exp, iname) = watcher.split("#")
                self.handleWatch(d, exp, iname)
617
618
619
        d.pushOutput()
        watchers = d.safeoutput

hjk's avatar
hjk committed
620
621
622
623
        sep = ""
        if len(locals) and len(watchers):
            sep = ","

624
625
626
        #
        # Breakpoints
        #
627
        breakpoints = ""
628
629
630
631
632
633
        #d.safeoutput = ""
        #listOfBreakpoints(d)
        #d.pushOutput()
        #breakpoints = d.safeoutput

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

635

636
637
    def handleWatch(self, d, exp, iname):
        #warn("HANDLING WATCH %s, INAME: '%s'" % (exp, iname))
638
        if exp.startswith("["):
639
            warn("EVAL: EXP: %s" % exp)
640
            d.beginHash()
641
            d.put('iname="%s",' % iname)
642
            d.put('name="%s",' % exp)
643
            d.put('exp="%s",' % exp)
644
645
            try:
                list = eval(exp)
646
                #warn("EVAL: LIST: %s" % list)
647
648
649
650
651
652
653
                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:
654
                    self.handleWatch(d, item, "%s.%d" % (iname, itemNumber))
655
656
657
658
659
660
661
662
663
664
665
666
667
                    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()
668
        d.put('iname="%s",' % iname)
669
        d.put('name="%s",' % exp)
670
        d.put('exp="%s",' % exp)
671
672
673
674
675
        handled = False
        if exp == "<Edit>":
            d.put(',value=" ",')
            d.put('type=" ",numchild="0"')
        else:
676
            try:
677
                value = parseAndEvaluate(exp)
678
                item = Item(value, iname, None, None)
679
                d.putItemHelper(item)
680
            except RuntimeError:
681
682
683
                d.put(',value="<invalid>",')
                d.put('type="<unknown>",numchild="0"')
        d.endHash()
684

hjk's avatar
hjk committed
685
686
687
688

FrameCommand()


689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
#######################################################################
#
# 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):
        lines = catchCliOutput("info line *" + arg)
        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]
        gdb.execute("maint packet sal%s,%s" % (fromAddr, toAddr))

SalCommand()
hjk's avatar
hjk committed
717
718
719
720
721
722
723
724
725
726
727
728
729

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

class Dumper:
    def __init__(self):
        self.output = ""
        self.safeoutput = ""
        self.childTypes = [""]
        self.childNumChilds = [-1]
730
731
        self.maxNumChilds = [-1]
        self.numChilds = [-1]
hjk's avatar
hjk committed
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761

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

762
    def beginChildren(self, numChild_ = 1, childType_ = None, childNumChild_ = None):
hjk's avatar
hjk committed
763
764
        childType = ""
        childNumChild = -1
765
766
767
768
769
770
        if type(numChild_) is list:
            numChild = numChild_[0]
            maxNumChild = numChild_[1]
        else:
            numChild = numChild_
            maxNumChild = numChild_
771
        if numChild == 0:
772
            childType_ = None
773
        self.putCommaIfNeeded()
774
775
        if not childType_ is None:
            childType = stripClassTag(str(childType_))
776
            self.put('childtype="%s",' % childType)
777
            if isSimpleType(childType_) or isStringType(self, childType_):
778
                self.put('childnumchild="0",')
hjk's avatar
hjk committed
779
                childNumChild = 0
780
            elif childType_.code == gdb.TYPE_CODE_PTR:
781
                self.put('childnumchild="1",')
hjk's avatar
hjk committed
782
                childNumChild = 1
783
784
785
        if not childNumChild_ is None:
            self.put('childnumchild="%s",' % childNumChild_)
            childNumChild = childNumChild_
hjk's avatar
hjk committed
786
787
        self.childTypes.append(childType)
        self.childNumChilds.append(childNumChild)
788
789
        self.numChilds.append(numChild)
        self.maxNumChilds.append(maxNumChild)
hjk's avatar
hjk committed
790
791
792
793
794
        #warn("BEGIN: %s" % self.childTypes)
        self.put("children=[")

    def endChildren(self):
        #warn("END: %s" % self.childTypes)
795
796
797
798
        numChild = self.numChilds.pop()
        maxNumChild = self.maxNumChilds.pop()
        if maxNumChild < numChild:
            self.putEllipsis();
hjk's avatar
hjk committed
799
800
801
802
        self.childTypes.pop()
        self.childNumChilds.pop()
        self.put(']')

803
804
805
    def childRange(self):
        return xrange(qmin(self.maxNumChilds[-1], self.numChilds[-1]))

hjk's avatar
hjk committed
806
807
808
809
810
811
812
813
814
815
816
817
818
819
    # 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]:
820
821
            self.putCommaIfNeeded()
            self.put('type="%s"' % type) # str(type.unqualified()) ?
hjk's avatar
hjk committed
822
823
824

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

828
829
830
831
832
833
    def putValue(self, value, encoding = None):
        if not encoding is None:
            self.putField("valueencoded", encoding)
        self.putField("value", value)

    def putStringValue(self, value):
834
835
836
837
838
839
840
        if value is None:
            self.putCommaIfNeeded()
            self.put('value="<not available>"')
        else:
            str = encodeString(value)
            self.putCommaIfNeeded()
            self.put('valueencoded="%d",value="%s"' % (7, str))
841
842
843
844
845

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

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

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

    def putBoolItem(self, name, value):
        self.beginHash()
900
901
        self.putName(name)
        self.putValue(value)
hjk's avatar
hjk committed
902
903
904
905
906
907
908
909
910
        self.putType("bool")
        self.putNumChild(0)
        self.endHash()

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

911
    def dumpInnerValueHelper(self, item):
hjk's avatar
hjk committed
912
        if isSimpleType(item.value.type):
913
            self.safePutItemHelper(item)
hjk's avatar
hjk committed
914

915
916
917
918
919
    def safePutItem(self, item):
        self.beginHash()
        self.safePutItemHelper(item)
        self.endHash()

hjk's avatar
hjk committed
920
921
922
923
924
925
926
927
928
929
930
931
    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)

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

    def putItem(self, item):
        self.beginHash()
hjk's avatar
hjk committed
954
        self.safePutItemHelper(item)
hjk's avatar
hjk committed
955
956
957
        self.endHash()

    def putCallItem(self, name, item, func):
958
959
960
961
962
        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
963

964
    def putItemHelper(self, item):
hjk's avatar
hjk committed
965
966
        name = getattr(item, "name", None)
        if not name is None:
967
            self.putName(name)
hjk's avatar
hjk committed
968

969
970
971
972
973
974
975
976
        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
977
        # FIXME: Gui shows references stripped?
978
        #warn(" ");
hjk's avatar
hjk committed
979
        #warn("REAL INAME: %s " % item.iname)
980
        #warn("REAL NAME: %s " % name)
hjk's avatar
hjk committed
981
        #warn("REAL TYPE: %s " % item.value.type)
982
        #warn("REAL VALUE: %s " % item.value)
983
984
        #try:
        #    warn("REAL VALUE: %s " % item.value)
985
986
        #except:
        #    #UnicodeEncodeError:
987
        #    warn("REAL VALUE: <unprintable>")
hjk's avatar
hjk committed
988
989
990
991
992
993
994
995
996
997
998
999
1000

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

hjk's avatar
hjk committed
1002
1003
1004
1005
        #warn(" STRIPPED: %s" % strippedType)
        #warn(" DUMPERS: %s" % self.dumpers)
        #warn(" DUMPERS: %s" % (strippedType in self.dumpers))

1006
        if isSimpleType(type.unqualified()):
1007
1008
            #warn("IS SIMPLE: %s " % type)
            self.putType(item.value.type)
1009
1010
            self.putValue(value)
            self.putNumChild(0)
hjk's avatar
hjk committed
1011
1012

        elif strippedType in self.dumpers:
1013
1014
            #warn("IS DUMPABLE: %s " % type)
            self.putType(item.value.type)
hjk's avatar
hjk committed
1015
            self.dumpers[strippedType](self, item)
1016
            #warn(" RESULT: %s " % self.output)
hjk's avatar
hjk committed
1017
1018

        elif type.code == gdb.TYPE_CODE_ENUM:
1019
            #warn("GENERIC ENUM: %s" % value)
1020
            self.putType(item.value.type)
1021
            self.putValue(value)
hjk's avatar
hjk committed
1022
            self.putNumChild(0)
1023

hjk's avatar
hjk committed
1024
1025

        elif type.code == gdb.TYPE_CODE_PTR:
1026
            isHandled = False
1027
            #warn("A POINTER: %s" % value.type)
1028
1029
1030
1031
1032
1033
1034
            if self.useFancy:
                if isNull(value):
                    self.putValue("0x0")
                    self.putType(item.value.type)
                    self.putNumChild(0)
                    isHandled = True

1035
1036
                target = str(type.target().strip_typedefs().unqualified())
                if (not isHandled) and target == "void":
1037
1038
1039
1040
1041
                    self.putType(item.value.type)
                    self.putValue(str(value))
                    self.putNumChild(0)
                    isHandled = True

1042
                #warn("TARGET: %s " % target)
1043
1044
                if (not isHandled) and (target == "char"
                        or target == "signed char" or target == "unsigned char"):
1045
                    # Display values up to given length directly
1046
                    #warn("CHAR AUTODEREF: %s" % value.address)
1047
1048
1049
                    self.putType(item.value.type)
                    firstNul = -1
                    p = value
1050
                    found = False
1051
                    for i in xrange(100):
1052
1053
                        if p.dereference() == 0:
                            # Found terminating NUL
1054
                            found = True
1055
1056
                            break
                        p += 1
1057
1058
1059
1060
1061
1062
1063
                    if found:
                        self.putValue(encodeCharArray(value, i), "6")
                        self.putNumChild(0)
                    else:
                        self.putValue(encodeCharArray(value, 100) + "2e2e2e", "6")
                        self.putNumChild(0)
                    isHandled = True
1064

1065
1066
1067
1068
1069
            #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.
1070
                #warn("GENERIC AUTODEREF POINTER: %s" % value.address)
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
                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:
1082
                #warn("GENERIC PLAIN POINTER: %s" % value.type)
1083
1084
1085
1086
1087
1088
1089
1090
                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
1091
1092

        else:
1093
            #warn("GENERIC STRUCT: %s" % value.type)
hjk's avatar
hjk committed
1094
1095
            #warn("INAME: %s " % item.iname)
            #warn("INAMES: %s " % self.expandedINames)
1096
            #warn("EXPANDED: %s " % (item.iname in self.expandedINames))
hjk's avatar
hjk committed
1097
1098
1099
1100
1101

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

1102
            self.putType(item.value.type)
1103
            self.putValue("{...}")
hjk's avatar
hjk committed
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118

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

1121
                baseNumber = 0
1122
                anonNumber = 0
hjk's avatar
hjk committed
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
                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())
1134
                        for i in xrange(value.type.sizeof / innerType.sizeof):
hjk's avatar
hjk committed
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
                            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)):
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
                        # 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()
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
                    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
1174
                    else:
1175
1176
                        # Named field.
                        self.beginHash()
1177
1178
1179
1180
                        child = Item(value[field.name],
                            item.iname, field.name, field.name)
                        self.safePutItemHelper(child)
                        self.endHash()
1181

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