dumper.py 58.6 KB
Newer Older
1
from __future__ import with_statement
hjk's avatar
hjk committed
2
3
4

import sys
import gdb
5
import base64
6
import __builtin__
7
import os
8

9
10
11
12
13
14
# Fails on Windows.
try:
    import curses.ascii
    def printableChar(ucs):
        return select(curses.ascii.isprint(ucs), ucs, '?')
except:
15
16
17
18
    def printableChar(ucs):
        if ucs >= 32 and ucs <= 126:
            return ucs
        return '?'
hjk's avatar
hjk committed
19

20
# Fails on SimulatorQt.
21
tempFileCounter = 0
22
23
try:
    import tempfile
24
25
26
#   Test if 2.6 is used (Windows), trigger exception and default
#   to 2nd version.
    tempfile.NamedTemporaryFile(prefix="gdbpy_",delete=True)
27
    def createTempFile():
28
        file = tempfile.NamedTemporaryFile(prefix="gdbpy_",delete=False)
29
        file.close()
30
        return file.name, file
31

32
33
except:
    def createTempFile():
34
35
36
37
        global tempFileCounter
        tempFileCounter += 1
        fileName = "%s/gdbpy_tmp_%d_%d" % (tempfile.gettempdir(), os.getpid(), tempFileCounter)
        return fileName, None
38

39
40
41
42
def removeTempFile(name, file):
    try:
        os.remove(name)
    except:
43
        pass
44

45
46
47
48
49
try:
    import binascii
except:
    pass

hjk's avatar
hjk committed
50
51
52
verbosity = 0
verbosity = 1

53
54
55
56
57
# Some "Enums"

# Encodings

Unencoded8Bit, \
58
59
60
61
62
63
64
65
66
67
Base64Encoded8BitWithQuotes, \
Base64Encoded16BitWithQuotes, \
Base64Encoded32BitWithQuotes, \
Base64Encoded16Bit, \
Base64Encoded8Bit, \
Hex2EncodedLatin1, \
Hex4EncodedLittleEndian, \
Hex8EncodedLittleEndian, \
Hex2EncodedUtf8, \
Hex8EncodedBigEndian, \
Arvid Ephraim Picciani's avatar
Arvid Ephraim Picciani committed
68
69
70
Hex4EncodedBigEndian, \
Hex4EncodedLittleEndianWithoutQuotes \
    = range(13)
71
72

# Display modes
73
74
75
76
77
78
StopDisplay, \
DisplayImage1, \
DisplayString, \
DisplayImage, \
DisplayProcess \
    = range(5)
79
80


81
82
83
84
85
def select(condition, if_expr, else_expr):
    if condition:
        return if_expr
    return else_expr

86
87
88
89
90
def qmin(n, m):
    if n < m:
        return n
    return m

hjk's avatar
hjk committed
91
def isGoodGdb():
92
93
    #return gdb.VERSION.startswith("6.8.50.2009") \
    #   and gdb.VERSION != "6.8.50.20090630-cvs"
94
    return 'parse_and_eval' in __builtin__.dir(gdb)
hjk's avatar
hjk committed
95

96
97
98
99
100
101
102
def hasInferiorThreadList():
    try:
        a= gdb.inferiors()[0].threads()
        return True
    except:
        return False

103
104
105
106
typeCache = {}

def lookupType(typestring):
    type = typeCache.get(typestring)
hjk's avatar
hjk committed
107
    #warn("LOOKUP 1: %s -> %s" % (typestring, type))
108
    if type is None:
hjk's avatar
hjk committed
109
110
111
112
113
114
115
116
117
118
119
        ts = typestring
        while True:
            #WARN("ts: '%s'" % ts)
            if ts.startswith("class "):
                ts = ts[6:]
            elif ts.startswith("struct "):
                ts = ts[7:]
            elif ts.startswith("const "):
                ts = ts[6:]
            elif ts.startswith("volatile "):
                ts = ts[9:]
120
121
            elif ts.startswith("enum "):
                ts = ts[5:]
hjk's avatar
hjk committed
122
123
124
125
126
127
128
129
130
            elif ts.endswith("const"):
                ts = ts[-5:]
            elif ts.endswith("volatile"):
                ts = ts[-8:]
            else:
                break
        try:
            #warn("LOOKING UP '%s'" % ts)
            type = gdb.lookup_type(ts)
131
        except RuntimeError, error:
132
            #warn("LOOKING UP '%s': %s" % (ts, error))
133
            # See http://sourceware.org/bugzilla/show_bug.cgi?id=11912
134
            exp = "(class '%s'*)0" % ts
135
136
137
138
139
            try:
                type = parseAndEvaluate(exp).type.target()
            except:
                # Can throw "RuntimeError: No type named class Foo."
                pass
140
        except:
hjk's avatar
hjk committed
141
142
143
144
145
            #warn("LOOKING UP '%s' FAILED" % ts)
            pass
        #warn("  RESULT: '%s'" % type)
        #if not type is None:
        #    warn("  FIELDS: '%s'" % type.fields())
146
        typeCache[typestring] = type
147
148
149
150
    if type is None:
        # could be gdb.lookup_type("char[3]") generating
        # "RuntimeError: No type named char[3]"
        pass
151
152
    return type

153
def cleanAddress(addr):
154
155
    if addr is None:
        return "<no address>"
156
157
    # We cannot use str(addr) as it yields rubbish for char pointers
    # that might trigger Unicode encoding errors.
158
    return addr.cast(lookupType("void").pointer())
159

hjk's avatar
hjk committed
160
161
162
163
# Workaround for gdb < 7.1
def numericTemplateArgument(type, position):
    try:
        return int(type.template_argument(position))
164
    except RuntimeError, error:
hjk's avatar
hjk committed
165
166
167
168
        # ": No type named 30."
        msg = str(error)
        return int(msg[14:-1])

169
def parseAndEvaluate(exp):
hjk's avatar
hjk committed
170
    if isGoodGdb():
171
172
173
174
        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")
175
176
177
178
    try:
        gdb.execute("print %s" % exp)
    except:
        gdb.execute("set logging off")
179
        gdb.execute("set logging redirect off")
180
        return None
181
    gdb.execute("set logging off")
182
    gdb.execute("set logging redirect off")
183
184
    return gdb.history(0)

185

186
def catchCliOutput(command):
187
    filename, file = createTempFile()
188
189
190
191
192
    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")
193
194
195
196
197
198
199
200
    msg = ""
    try:
        gdb.execute(command)
    except RuntimeError, error:
        # For the first phase of core file loading this yield
        # "No symbol table is loaded.  Use the \"file\" command."
        msg = str(error)
    except:
hjk's avatar
hjk committed
201
        msg = "Unknown error"
202
203
    gdb.execute("set logging off")
    gdb.execute("set logging redirect off")
204
    if len(msg):
hjk's avatar
hjk committed
205
206
207
        # Having that might confuse result handlers in the gdbengine.
        #warn("CLI ERROR: %s " % msg)
        return "CLI ERROR: %s " % msg
208
    temp = open(filename, "r")
209
    lines = []
210
    for line in temp:
211
        lines.append(line)
212
213
    temp.close()
    removeTempFile(filename, file)
214
215
216
    return lines


217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
def showException(msg, exType, exValue, exTraceback):
    warn("**** CAUGHT EXCEPTION: %s ****" % msg)
    try:
        import traceback
        for line in traceback.format_exception(exType, exValue, exTraceback):
            warn("%s" % line)
    except:
        pass


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

    def __enter__(self):
        self.d.put(self.pre)
        self.savedOutput = self.d.output
        self.d.output = ""

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


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

    def __enter__(self):
        self.d.put('{')
        self.savedValue = self.d.currentValue
        self.savedValuePriority = self.d.currentValuePriority
        self.savedValueEncoding = self.d.currentValueEncoding
        self.savedType = self.d.currentType
        self.savedTypePriority = self.d.currentTypePriority
hjk's avatar
hjk committed
259
        self.d.currentValue = "<not accessible>"
260
        self.d.currentValuePriority = -100
261
262
        self.d.currentValueEncoding = None
        self.d.currentType = ""
263
        self.d.currentTypePriority = -100
264
265
266
267
268
269

    def __exit__(self, exType, exValue, exTraceBack):
        #warn(" CURRENT VALUE: %s %s %s" % (self.d.currentValue,
        #    self.d.currentValueEncoding, self.d.currentValuePriority))
        if self.d.passExceptions and not exType is None:
            showException("SUBITEM", exType, exValue, exTraceBack)
270
        try:
271
            #warn("TYPE VALUE: %s" % self.d.currentValue)
272
273
274
275
276
            type = stripClassTag(str(self.d.currentType))
            #warn("TYPE: '%s'  DEFAULT: '%s'" % (type, self.d.currentChildType))
            if len(type) > 0 and type != self.d.currentChildType:
                self.d.put('type="%s",' % type) # str(type.unqualified()) ?
            if not self.d.currentValueEncoding is None:
277
                self.d.put('valueencoded="%d",' % self.d.currentValueEncoding)
278
            if not self.d.currentValue is None:
279
                self.d.put('value="%s",' % self.d.currentValue)
280
281
        except:
            pass
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
        self.d.put('},')
        self.d.currentValue = self.savedValue
        self.d.currentValuePriority = self.savedValuePriority
        self.d.currentValueEncoding = self.savedValueEncoding
        self.d.currentType = self.savedType
        self.d.currentTypePriority = self.savedTypePriority
        return True


class Children:
    def __init__(self, d, numChild = 1, childType = None, childNumChild = None):
        self.d = d
        self.numChild = numChild
        self.childType = childType
        self.childNumChild = childNumChild
        #warn("CHILDREN: %s %s %s" % (numChild, childType, childNumChild))

    def __enter__(self):
        childType = ""
        childNumChild = -1
        if type(self.numChild) is list:
            numChild = self.numChild[0]
            maxNumChild = self.numChild[1]
        else:
            numChild = self.numChild
            maxNumChild = self.numChild
        if numChild == 0:
            self.childType = None
        if not self.childType is None:
            childType = stripClassTag(str(self.childType))
            self.d.put('childtype="%s",' % childType)
            if isSimpleType(self.childType) or isStringType(self.d, self.childType):
                self.d.put('childnumchild="0",')
                childNumChild = 0
            elif self.childType.code == gdb.TYPE_CODE_PTR:
                self.d.put('childnumchild="1",')
                childNumChild = 1
        if not self.childNumChild is None:
            self.d.put('childnumchild="%s",' % self.childNumChild)
            childNumChild = self.childNumChild
        self.savedChildType = self.d.currentChildType
        self.savedChildNumChild = self.d.currentChildNumChild
        self.savedNumChilds = self.d.currentNumChilds
        self.savedMaxNumChilds = self.d.currentNumChilds
        self.d.currentChildType = childType
        self.d.currentChildNumChild = childNumChild
        self.d.currentNumChilds = numChild
        self.d.currentMaxNumChilds = maxNumChild
        self.d.put("children=[")

    def __exit__(self, exType, exValue, exTraceBack):
        if self.d.passExceptions and not exType is None:
            showException("CHILDREN", exType, exValue, exTraceBack)
        if self.d.currentMaxNumChilds < self.d.currentNumChilds:
hjk's avatar
hjk committed
336
            self.d.putEllipsis()
337
338
339
340
341
342
343
344
        self.d.currentChildType = self.savedChildType
        self.d.currentChildNumChild = self.savedChildNumChild
        self.d.currentNumChilds = self.savedNumChilds
        self.d.currentMaxNumChilds = self.savedMaxNumChilds
        self.d.put('],')
        return True


345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
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"
369
    #6       breakpoint     keep y   0xb6cf18e5 <__cxa_throw+5>\n"
370
    lines = catchCliOutput("info break")
371
372
373
374

    lines.reverse()
    bp = Breakpoint()
    for line in lines:
375
376
        if len(line) == 0 or line.startswith(" "):
            continue
377
378
379
380
381
382
383
384
385
386
        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")
387
        posin = line.find(" in ", pos0x)
388
        poslt = line.find(" <", pos0x)
389
        posat = line.find(" at ", posin)
390
        poscol = line.find(":", posat)
391
392
393
394
395
396
        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)]
397
398
399
        # Take "no address" as indication that the bp is pending.
        #if line.find("<PENDING>") >= 0:
        #    bp.address.append("<PENDING>")
400
401
402
403
404
405
406
407
408
409
410
411
        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
412
413
414
415
        d.put('bkpt={number="%s",' % bp.number)
        d.put('type="breakpoint",')
        d.put('disp="keep",')
        d.put('enabled="y",')
416
        for address in bp.address:
hjk's avatar
hjk committed
417
            d.put('addr="%s",' % address)
418
        if not bp.function is None:
hjk's avatar
hjk committed
419
            d.put('func="%s",' % bp.function)
420
        if not bp.filename is None:
hjk's avatar
hjk committed
421
            d.put('file="%s",' % bp.filename)
422
        if not bp.fullname is None:
hjk's avatar
hjk committed
423
            d.put('fullname="%s",' % bp.fullname)
424
        if not bp.linenumber is None:
hjk's avatar
hjk committed
425
            d.put('line="%s",' % bp.linenumber)
426
        if not bp.condition is None:
hjk's avatar
hjk committed
427
            d.put('cond="%s",' % bp.condition)
428
        if not bp.fullname is None:
hjk's avatar
hjk committed
429
            d.put('fullname="%s",' % bt.fullname)
430
        if not bp.times is None:
hjk's avatar
hjk committed
431
            d.put('times="1",' % bp.times)
432
        #d.put('original-location="-"')
hjk's avatar
hjk committed
433
        d.put('},')
434
435
436
        bp = Breakpoint()


437
438
439
440
441
442
443
444
445
446
447
# 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


448
def listOfLocals(varList):
449
450
451
    try:
        frame = gdb.selected_frame()
        #warn("FRAME %s: " % frame)
452
453
454
455
456
    except RuntimeError, error:
        warn("FRAME NOT ACCESSIBLE: %s" % error)
        return []
    except:
        warn("FRAME NOT ACCESSIBLE FOR UNKNOWN REASONS")
hjk's avatar
hjk committed
457
        return []
458

459
    # gdb-6.8-symbianelf fails here
460
    hasBlock = 'block' in __builtin__.dir(frame)
461

462
    items = []
hjk's avatar
hjk committed
463
464
    #warn("HAS BLOCK: %s" % hasBlock)
    #warn("IS GOOD GDB: %s" % isGoodGdb())
465
    if hasBlock and isGoodGdb():
466
        #warn("IS GOOD: %s " % varList)
467
468
469
        try:
            block = frame.block()
            #warn("BLOCK: %s " % block)
470
471
472
        except RuntimeError, error:
            warn("FRAME NOT ACCESSIBLE: %s" % error)
            return items
473
        except:
474
            warn("BLOCK NOT ACCESSIBLE FOR UNKNOWN REASONS")
475
476
            return items

477
478
479
480
481
482
        while True:
            if block is None:
                warn("UNEXPECTED 'None' BLOCK")
                break
            for symbol in block:
                name = symbol.print_name
483

484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
                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
507
        # Assuming gdb 7.0 release or 6.8-symbianelf.
508
        filename, file = createTempFile()
509
        #warn("VARLIST: %s " % varList)
510
        #warn("FILENAME: %s " % filename)
hjk's avatar
hjk committed
511
512
        gdb.execute("set logging off")
        gdb.execute("set logging redirect off")
513
514
515
        gdb.execute("set logging file %s" % filename)
        gdb.execute("set logging redirect on")
        gdb.execute("set logging on")
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
        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
533
534
        gdb.execute("set logging off")
        gdb.execute("set logging redirect off")
535

536
537
538
539
540
541
542
543
544
545
546
547
548
        try:
            temp = open(filename, "r")
            for line in temp:
                if len(line) == 0 or line.startswith(" "):
                    continue
                # The function parameters
                pos = line.find(" = ")
                if pos < 0:
                    continue
                varList.append(line[0:pos])
            temp.close()
        except:
            pass
549
        removeTempFile(filename, file)
550
551
552
        #warn("VARLIST: %s " % varList)
        for name in varList:
            #warn("NAME %s " % name)
553
554
555
556
            item = Item(0, "local", name, name)
            try:
                item.value = frame.read_var(name)  # this is a gdb value
            except RuntimeError:
557
558
                pass
                #continue
559
560
561
562
563
            except:
                # Something breaking the list, like intermediate gdb warnings
                # like 'Warning: can't find linker symbol for virtual table for
                # `std::less<char const*>' value\n\nwarning:  found
                # `myns::QHashData::shared_null' instead [...]
564
                # that break subsequent parsing. Chicken out and take the
565
566
                # next "usable" line.
                continue
567
568
569
570
571
            items.append(item)

    return items


572
def value(expr):
573
    value = parseAndEvaluate(expr)
574
575
576
577
578
    try:
        return int(value)
    except:
        return str(value)

hjk's avatar
hjk committed
579
def isSimpleType(typeobj):
580
581
582
583
584
    code = typeobj.code
    return code == gdb.TYPE_CODE_BOOL \
        or code == gdb.TYPE_CODE_CHAR \
        or code == gdb.TYPE_CODE_INT \
        or code == gdb.TYPE_CODE_FLT \
585
        or code == gdb.TYPE_CODE_ENUM
586

hjk's avatar
hjk committed
587
588
589
590
591
592
593
594
595
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):
596
597
    if True or verbosity > 0:
        print "XXX: %s\n" % message.encode("latin1")
hjk's avatar
hjk committed
598
599
600
601
602
603
    pass

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

604
605
606
607
608
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
609
#def couldBePointer(p, align):
610
#    type = lookupType("unsigned int")
hjk's avatar
hjk committed
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
#    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):
630
631
632
633
    # 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 ")
634
635
636
637
638
639
    #try:
    #    # Can fail with: "RuntimeError: Cannot access memory at address 0x5"
    #    return p.cast(lookupType("void").pointer()) == 0
    #except:
    #    return False
    return long(p) == 0
hjk's avatar
hjk committed
640
641
642
643
644
645
646
647

movableTypes = set([
    "QBrush", "QBitArray", "QByteArray",
    "QCustomTypeInfo", "QChar",
    "QDate", "QDateTime",
    "QFileInfo", "QFixed", "QFixedPoint", "QFixedSize",
    "QHashDummyValue",
    "QIcon", "QImage",
hjk's avatar
hjk committed
648
    "QLine", "QLineF", "QLatin1Char", "QLocale",
hjk's avatar
hjk committed
649
650
651
652
653
654
655
656
657
658
659
660
661
662
    "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:]
hjk's avatar
hjk committed
663
    if type.startswith("struct "):
664
        return type[7:]
hjk's avatar
hjk committed
665
    if type.startswith("const "):
hjk's avatar
hjk committed
666
        return type[6:]
hjk's avatar
hjk committed
667
    if type.startswith("volatile "):
hjk's avatar
hjk committed
668
        return type[9:]
hjk's avatar
hjk committed
669
670
671
    return type

def checkPointerRange(p, n):
672
    for i in xrange(n):
hjk's avatar
hjk committed
673
674
675
676
677
678
        checkPointer(p)
        ++p

def call(value, func):
    #warn("CALL: %s -> %s" % (value, func))
    type = stripClassTag(str(value.type))
679
    if type.find(":") >= 0:
hjk's avatar
hjk committed
680
        type = "'" + type + "'"
681
682
    # 'class' is needed, see http://sourceware.org/bugzilla/show_bug.cgi?id=11912
    exp = "((class %s*)%s)->%s" % (type, value.address, func)
hjk's avatar
hjk committed
683
    #warn("CALL: %s" % exp)
684
685
686
687
688
    result = None
    try:
        result = parseAndEvaluate(exp)
    except:
        pass
hjk's avatar
hjk committed
689
690
691
    #warn("  -> %s" % result)
    return result

692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
def makeValue(type, init):
    type = stripClassTag(type)
    if type.find(":") >= 0:
        type = "'" + type + "'"
    gdb.execute("set $d = (%s*)malloc(sizeof(%s))" % (type, type))
    gdb.execute("set *$d = {%s}" % init)
    value = parseAndEvaluate("$d").dereference()
    #warn("  TYPE: %s" % value.type)
    #warn("  ADDR: %s" % value.address)
    #warn("  VALUE: %s" % value)
    return value

def makeExpression(value):
    type = stripClassTag(str(value.type))
    if type.find(":") >= 0:
        type = "'" + type + "'"
    #warn("  TYPE: %s" % type)
    #exp = "(*(%s*)(&%s))" % (type, value.address)
    exp = "(*(%s*)(%s))" % (type, value.address)
    #warn("  EXP: %s" % exp)
    return exp

714
715
def qtNamespace():
    try:
716
        str = catchCliOutput("ptype QString::Null")[0]
hjk's avatar
hjk committed
717
        # The result looks like:
718
719
720
721
722
723
724
        # "type = const struct myns::QString::Null {"
        # "    <no data fields>"
        # "}"
        pos1 = str.find("struct") + 7
        pos2 = str.find("QString::Null")
        return str[pos1:pos2]
    except:
725
        return ""
hjk's avatar
hjk committed
726

727
728
729
730
731
732
733
def findFirstZero(p, max):
    for i in xrange(max):
        if p.dereference() == 0:
            return i
        p = p + 1
    return -1

734
def extractCharArray(p, maxsize):
735
    t = lookupType("unsigned char").pointer()
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
    p = p.cast(t)
    i = findFirstZero(p, maxsize)
    limit = select(i < 0, maxsize, i)
    s = ""
    for i in xrange(limit):
        s += "%c" % int(p.dereference())
        p += 1
    if i == maxsize:
        s += "..."
    return s

def extractByteArray(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)
    checkRef(d_ptr["ref"])
    if size > 0:
        checkAccess(data, 4)
        checkAccess(data + size) == 0
757
    return extractCharArray(data, 1000, size)
758

759
def encodeCharArray(p, maxsize, size = -1):
760
    t = lookupType("unsigned char").pointer()
761
    p = p.cast(t)
762
    if size == -1:
763
764
765
766
767
768
        size = findFirstZero(p, maxsize)
    if size == -1:
        size = maxsize
    limit = size
    if size > maxsize:
        limit = maxsize
769
    s = ""
770
771
772
773
774
775
776
777
778
    try:
        # gdb.Inferior is new in gdb 7.2
        inferior = gdb.inferiors()[0]
        s = binascii.hexlify(inferior.read_memory(p, limit))
    except:
        for i in xrange(limit):
            s += "%02x" % int(p.dereference())
            p += 1
    if maxsize < size:
779
780
781
782
        s += "2e2e2e"
    return s

def encodeChar2Array(p, maxsize):
783
    t = lookupType("unsigned short").pointer()
784
785
786
787
788
789
790
791
792
793
794
795
    p = p.cast(t)
    i = findFirstZero(p, maxsize)
    limit = select(i < 0, maxsize, i)
    s = ""
    for i in xrange(limit):
        s += "%04x" % int(p.dereference())
        p += 1
    if i == maxsize:
        s += "2e002e002e00"
    return s

def encodeChar4Array(p, maxsize):
796
    t = lookupType("unsigned int").pointer()
797
798
799
800
801
802
803
804
805
    p = p.cast(t)
    i = findFirstZero(p, maxsize)
    limit = select(i < 0, maxsize, i)
    s = ""
    for i in xrange(limit):
        s += "%08x" % int(p.dereference())
        p += 1
    if i == maxsize:
        s += "2e0000002e0000002e000000"
806
807
    return s

808
809
810
811
812
813
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)
814
    checkRef(d_ptr["ref"])
815
816
817
    if size > 0:
        checkAccess(data, 4)
        checkAccess(data + size) == 0
818
    return encodeCharArray(data, 1000, size)
819
820
821
822
823
824
825
826
827

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)
hjk's avatar
hjk committed
828
        checkAccess(data + size) == 0
829
    checkRef(d_ptr["ref"])
830
831
    p = gdb.Value(d_ptr["data"])
    s = ""
832
833
834
835
836
837
838
839
840
841
    try:
        # gdb.Inferior is new in gdb 7.2
        inferior = gdb.inferiors()[0]
        s = binascii.hexlify(inferior.read_memory(p, 2 * int(size)))
    except:
        for i in xrange(size):
            val = int(p.dereference())
            s += "%02x" % (val % 256)
            s += "%02x" % (val / 256)
            p += 1
842
843
    return s

hjk's avatar
hjk committed
844
845
def stripTypedefs(type):
    type = type.unqualified()
846
847
848
849
    while type.code == gdb.TYPE_CODE_TYPEDEF:
        type = type.strip_typedefs().unqualified()
    return type

hjk's avatar
hjk committed
850
851
852
853
854
855
def extractFields(type):
    # Insufficient, see http://sourceware.org/bugzilla/show_bug.cgi?id=10953:
    #fields = value.type.fields()
    # Insufficient, see http://sourceware.org/bugzilla/show_bug.cgi?id=11777:
    #fields = stripTypedefs(value.type).fields()
    # This seems to work.
hjk's avatar
hjk committed
856
    #warn("TYPE 0: %s" % type)
hjk's avatar
hjk committed
857
858
    type = stripTypedefs(type)
    #warn("TYPE 1: %s" % type)
859
    # This fails for arrays. See comment in lookupType.
860
861
862
    type0 = lookupType(str(type))
    if not type0 is None:
        type = type0
863
864
    if type.code == gdb.TYPE_CODE_FUNC:
        return []
hjk's avatar
hjk committed
865
866
    #warn("TYPE 2: %s" % type)
    fields = type.fields()
hjk's avatar
hjk committed
867
    #warn("FIELDS: %s" % fields)
hjk's avatar
hjk committed
868
869
    return fields

hjk's avatar
hjk committed
870
871
872
873
874
875
876
#######################################################################
#
# Item
#
#######################################################################

class Item:
877
    def __init__(self, value, parentiname, iname = None, name = None):
hjk's avatar
hjk committed
878
        self.value = value
879
880
881
882
        if iname is None:
            self.iname = parentiname
        else:
            self.iname = "%s.%s" % (parentiname, iname)
hjk's avatar
hjk committed
883
884
885
        self.name = name


886
887
888
889
890
891
#######################################################################
#
# SetupCommand
#
#######################################################################

892
# This is a cache mapping from 'type name' to 'display alternatives'.
893
qqFormats = {}
894
895

# This is a cache of all known dumpers.
hjk's avatar
hjk committed
896
qqDumpers = {}
897
898
899

# This is a cache of the namespace of the currently used Qt version.
# FIXME: This is not available on 'bbsetup' time, only at 'bb' time.
900
qqNs = ""
901
902
903

# This is a cache of typenames->bool saying whether we are QObject
# derived.
hjk's avatar
hjk committed
904
qqQObjectCache = {}
905
906
907
908
909
910
911
912
913


class SetupCommand(gdb.Command):
    """Setup Creator Pretty Printing"""

    def __init__(self):
        super(SetupCommand, self).__init__("bbsetup", gdb.COMMAND_OBSCURE)

    def invoke(self, args, from_tty):
914
        print bbsetup()
915
916
917

SetupCommand()

918
919
920
921
922
923
def bbsetup():
    module = sys.modules[__name__]
    for key, value in module.__dict__.items():
        if key.startswith("qdump__"):
            name = key[7:]
            qqDumpers[name] = value
hjk's avatar
hjk committed
924
            qqFormats[name] = qqFormats.get(name, "")
925
926
927
928
929
930
931
932
933
934
935
936
937
        elif key.startswith("qform__"):
            name = key[7:]
            formats = ""
            try:
                formats = value()
            except:
                pass
            qqFormats[name] = formats
    result = "dumpers=["
    qqNs = qtNamespace()
    for key, value in qqFormats.items():
        result += '{type="%s",formats="%s"},' % (key, value)
    result += '],namespace="%s"' % qqNs
938
    result += ',hasInferiorThreadList="%s"' % int(hasInferiorThreadList())
939
940
    return result

941

hjk's avatar
hjk committed
942
943
944
945
946
947
948
#######################################################################
#
# FrameCommand
#
#######################################################################

class FrameCommand(gdb.Command):
949
    """Do fancy stuff."""
hjk's avatar
hjk committed
950
951
952
953

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

954
    def invoke(self, args, from_tty):
955
956
957
958
959
960
961
962
963
964
965
        if args.startswith("options:profile"):
            if False:
                import cProfile
                cProfile.run('bb("%s")' % args, "/tmp/bbprof")
                # Examine with:
                # import bstats
                # pstats.Stats('bbprof').sort_stats('time').print_stats()
            if True:
                import timeit
                print timeit.repeat('bb("%s")' % args,
                    'from __main__ import bb', number=100)
966
        else:
967
968
969
970
971
972
973
974
975
976
977
978
979
980
            output =  bb(args)
            try:
                print(output)
            except:
                out = ""
                for c in output:
                    cc = ord(c)
                    if cc > 127:
                        out += "\\\\%d" % cc
                    elif cc < 0:
                        out += "\\\\%d" % (cc + 256)
                    else:
                        out += c
                print(out)
981

982
FrameCommand()
983

984
def bb(args):
985
    return 'data=[' + Dumper(args).output + ']'
hjk's avatar
hjk committed
986
987


988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
#######################################################################
#
# 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):
1002
1003
        (cmd, addr) = arg.split(",")
        lines = catchCliOutput("info line *" + addr)
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
        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]
1014
        gdb.execute("maint packet sal%s,%s,%s" % (cmd,fromAddr, toAddr))
1015
1016

SalCommand()
hjk's avatar
hjk committed
1017

1018

hjk's avatar
hjk committed
1019
1020
1021
1022
1023
1024
#######################################################################
#
# The Dumper Class
#
#######################################################################

1025

hjk's avatar
hjk committed
1026
class Dumper:
1027
    def __init__(self, args):
hjk's avatar
hjk committed
1028
        self.output = ""
1029
1030
1031
1032
1033
1034
1035
1036
1037
        self.currentChildType = ""
        self.currentChildNumChild = -1
        self.currentMaxNumChilds = -1
        self.currentNumChilds = -1
        self.currentValue = None
        self.currentValuePriority = -100
        self.currentValueEncoding = None
        self.currentType = None
        self.currentTypePriority = -100
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
        self.typeformats = {}
        self.formats = {}
        self.expandedINames = ""

        options = []
        varList = []
        watchers = ""
        resultVarName = ""

        for arg in args.split(' '):
            pos = arg.find(":") + 1
            if arg.startswith("options:"):
                options = arg[pos:].split(",")
            elif arg.startswith("vars:"):
                if len(arg[pos:]) > 0:
                    varList = arg[pos:].split(",")
            elif arg.startswith("resultvarname:"):
                resultVarName = arg[pos:]
            elif arg.startswith("expanded:"):
                self.expandedINames = set(arg[pos:].split(","))
            elif arg.startswith("typeformats:"):
                for f in arg[pos:].split(","):
                    pos = f.find("=")
                    if pos != -1:
                        type = base64.b16decode(f[0:pos], True)
                        self.typeformats[type] = int(f[pos+1:])
            elif arg.startswith("formats:"):
                for f in arg[pos:].split(","):
                    pos = f.find("=")
                    if pos != -1:
                        self.formats[f[0:pos]] = int(f[pos+1:])
            elif arg.startswith("watchers:"):
                watchers = base64.b16decode(arg[pos:], True)

        self.useFancy = "fancy" in options
        self.passExceptions = "pe" in options
        self.autoDerefPointers = "autoderef" in options
1075
        self.partialUpdate = "partial" in options
1076
1077
        #self.ns = qqNs
        self.ns = qtNamespace()
1078
1079
1080
1081

        #warn("NAMESPACE: '%s'" % self.ns)
        #warn("VARIABLES: %s" % varList)
        #warn("EXPANDED INAMES: %s" % self.expandedINames)
1082
        #warn("WATCHERS: %s" % watchers)
1083
1084
1085
1086
1087
        module = sys.modules[__name__]

        #
        # Locals
        #
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
        fullUpdateNeeded = True
        if self.partialUpdate and len(varList) == 1:
            #warn("PARTIAL: %s" % varList)
            parts = varList[0].split('.')
            #warn("PARTIAL PARTS: %s" % parts)
            name = parts[1]
            #warn("PARTIAL VAR: %s" % name)
            #fullUpdateNeeded = False
            try:
                frame = gdb.selected_frame()
                item = Item(0, "local", name, name)
                item.value = frame.read_var(name)
                locals = [item]
                #warn("PARTIAL LOCALS: %s" % locals)
                fullUpdateNeeded = False
            except:
                pass
            varList = []

        if fullUpdateNeeded:
            locals = listOfLocals(varList)
            if "nolocals" in options:
                locals = []
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133

        # Take care of the return value of the last function call.
        if len(resultVarName) > 0:
            try:
                value = parseAndEvaluate(resultVarName)
                locals.append(Item(value, "return", resultVarName, "return"))
            except:
                # Don't bother. It's only supplementary information anyway.
                pass

        for item in locals:
          with OutputSafer(self, "", ""):
            self.anonNumber = -1
            #warn("ITEM NAME %s: " % item.name)
            try:
                #warn("ITEM VALUE %s: " % item.value)
                # Throw on funny stuff, catch below.
                # Unfortunately, this fails also with a "Unicode encoding error"
                # in testArray().
                #dummy = str(item.value)
                pass
            except:
                # Locals with failing memory access.
1134
                # FIXME: Isn't this taken care off by the SubItem destructor?
1135
                with SubItem(self):
1136
1137
1138
                    self.put('iname="%s",' % item.iname)
                    self.put('name="%s",' % item.name)
                    self.put('addr="<not accessible>",')
hjk's avatar
hjk committed
1139
                    self.put('numchild="0"')
1140
1141
                    self.putValue("<not accessible>")
                    self.putType(item.value.type)
1142
1143
1144
1145
1146
1147
1148
1149
                continue

            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
1150
1151
1152
1153
1154
1155
1156
1157
                # p is 0 for "optimized out" cases. Or contains rubbish.
                try:
                    if not isNull(p):
                        while not isNull(p.dereference()) and n <= 100:
                            p += 1
                            n += 1
                except:
                    pass
1158

1159
                with SubItem(self):
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
                    self.put('iname="%s",' % item.iname)
                    self.putName(item.name)
                    self.putItemCount(select(n <= 100, n, "> 100"))
                    self.putType(type)
                    self.putNumChild(n)
                    if self.isExpanded(item):
                        p = item.value
                        with Children(self, n):
                            for i in xrange(n):
                                value = p.dereference()
                                self.putItem(Item(value, item.iname, i, None))
                                p += 1
                            if n > 100:
                                self.putEllipsis()

            else:
                # A "normal" local variable or parameter.
                try:
                   addr = cleanAddress(item.value.address)
                   with SubItem(self):
                       self.put('iname="%s",' % item.iname)
                       self.put('addr="%s",' % addr)
                       self.putItemHelper(item)
                except AttributeError:
                    # Thrown by cleanAddress with message "'NoneType' object
                    # has no attribute 'cast'" for optimized-out values.
1186
                    with SubItem(self):
1187
1188
1189
                        self.put('iname="%s",' % item.iname)
                        self.put('name="%s",' % item.name)
                        self.put('addr="<optimized out>",')
1190
1191
                        self.putValue("<optimized out>")
                        self.putType(item.value.type)
1192
1193
1194
1195
1196
1197
1198
1199

        #
        # Watchers
        #
        with OutputSafer(self, ",", ""):
            if len(watchers) > 0:
                for watcher in watchers.split("##"):
                    (exp, iname) = watcher.split("#")
1200
                    self.handleWatch(exp, iname)
1201
1202
1203
1204
1205
1206
1207
1208

        #
        # Breakpoints
        #
        #listOfBreakpoints(d)

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

hjk's avatar
hjk committed
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
    def checkForQObjectBase(self, type):
        if type.code != gdb.TYPE_CODE_STRUCT:
            return False
        name = str(type)
        if name in qqQObjectCache:
            return qqQObjectCache[name]
        if name == self.ns + "QObject":
            qqQObjectCache[name] = True
            return True
        fields = type.strip_typedefs().fields()
        if len(fields) == 0:
            qqQObjectCache[name] = False
            return False
        base = fields[0].type.strip_typedefs()
1223
1224
1225
        # Prevent infinite recursion in Qt 3.3.8
        if str(base) == name:
            return False
hjk's avatar
hjk committed
1226
1227
1228
1229
        result = self.checkForQObjectBase(base)
        qqQObjectCache[name] = result
        return result

1230
1231
1232

    def handleWatch(self, exp, iname):
        exp = str(exp)
hjk's avatar
hjk committed
1233
        escapedExp = exp.replace('"', '\\"')
hjk's avatar
hjk committed
1234
        escapedExp = escapedExp.replace('\\', '\\\\')
1235
1236
1237
1238
        #warn("HANDLING WATCH %s, INAME: '%s'" % (exp, iname))
        if exp.startswith("[") and exp.endswith("]"):
            #warn("EVAL: EXP: %s" % exp)
            with SubItem(d):
1239
1240
1241
                self.put('iname="%s",', iname)
                self.put('name="%s",', escapedExp)
                self.put('exp="%s",', escapedExp)
1242
1243
1244
1245
1246
1247
1248
1249
1250
                try:
                    list = eval(exp)
                    self.putValue("")
                    self.putType(" ")
                    self.putNumChild(len(list))
                    # This is a list of expressions to evaluate
                    with Children(self, len(list)):
                        itemNumber = 0
                        for item in list:
1251
                            self.handleWatch(item, "%s.%d" % (iname, itemNumber))
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
                            itemNumber += 1
                except RuntimeError, error:
                    warn("EVAL: ERROR CAUGHT %s" % error)
                    self.putValue("<syntax error>")
                    self.putType(" ")
                    self.putNumChild(0)
                    with Children(self, 0):
                        pass
            return

1262
        with SubItem(self):
1263
1264
1265
            self.put('iname="%s",' % iname)
            self.put('name="%s",' % escapedExp)
            self.put('exp="%s",' % escapedExp)
1266
            handled = False
1267
            if len(exp) == 0: # The <Edit> case
1268
1269
1270
                self.putValue(" ")
                self.putType(" ")
                self.putNumChild(0)
1271
1272
1273
1274
1275
1276
1277
1278
            else:
                try:
                    value = parseAndEvaluate(exp)
                    item = Item(value, iname, None, None)
                    if not value is None:
                        self.putAddress(value.address)
                    self.putItemHelper(item)
                except RuntimeError:
1279
1280
1281
1282
1283
                    self.currentType = " "
                    self.currentValue = "<no such value>"
                    self.currentChildNumChild = -1
                    self.currentNumChilds = 0
                    self.putNumChild(0)
1284