dumper.py 48.3 KB
Newer Older
1
from __future__ import with_statement
hjk's avatar
hjk committed
2
3
4
5
6
7
#Note: Keep name-type-value-numchild-extra order

#return

import sys
import gdb
8
import base64
9
import __builtin__
10
import os
11
12
13
14
15
16
17

# Fails on Windows.
try:
    import curses.ascii
    def printableChar(ucs):
        return select(curses.ascii.isprint(ucs), ucs, '?')
except:
18
19
20
21
    def printableChar(ucs):
        if ucs >= 32 and ucs <= 126:
            return ucs
        return '?'
hjk's avatar
hjk committed
22

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

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

42
43
44
45
def removeTempFile(name, file):
    try:
        os.remove(name)
    except:
46
        pass
47

hjk's avatar
hjk committed
48
49
50
verbosity = 0
verbosity = 1

51
52
53
54
55
# Some "Enums"

# Encodings

Unencoded8Bit, \
56
57
58
59
60
61
62
63
64
65
66
67
Base64Encoded8BitWithQuotes, \
Base64Encoded16BitWithQuotes, \
Base64Encoded32BitWithQuotes, \
Base64Encoded16Bit, \
Base64Encoded8Bit, \
Hex2EncodedLatin1, \
Hex4EncodedLittleEndian, \
Hex8EncodedLittleEndian, \
Hex2EncodedUtf8, \
Hex8EncodedBigEndian, \
Hex4EncodedBigEndian \
    = range(12)
68
69

# Display modes
70
71
72
73
74
75
StopDisplay, \
DisplayImage1, \
DisplayString, \
DisplayImage, \
DisplayProcess \
    = range(5)
76
77


78
79
80
81
82
def select(condition, if_expr, else_expr):
    if condition:
        return if_expr
    return else_expr

83
84
85
86
87
def qmin(n, m):
    if n < m:
        return n
    return m

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

93
def cleanAddress(addr):
94
95
    if addr is None:
        return "<no address>"
96
97
    # We cannot use str(addr) as it yields rubbish for char pointers
    # that might trigger Unicode encoding errors.
98
    return addr.cast(gdb.lookup_type("void").pointer())
99

hjk's avatar
hjk committed
100
101
102
103
# Workaround for gdb < 7.1
def numericTemplateArgument(type, position):
    try:
        return int(type.template_argument(position))
104
    except RuntimeError, error:
hjk's avatar
hjk committed
105
106
107
108
        # ": No type named 30."
        msg = str(error)
        return int(msg[14:-1])

109
def parseAndEvaluate(exp):
hjk's avatar
hjk committed
110
    if isGoodGdb():
111
112
113
114
        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")
115
116
117
118
    try:
        gdb.execute("print %s" % exp)
    except:
        gdb.execute("set logging off")
119
        gdb.execute("set logging redirect off")
120
        return None
121
    gdb.execute("set logging off")
122
    gdb.execute("set logging redirect off")
123
124
    return gdb.history(0)

125

126
def catchCliOutput(command):
127
    filename, file = createTempFile()
128
129
130
131
132
133
134
135
    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")
136
    temp = open(filename, "r")
137
    lines = []
138
    for line in temp:
139
        lines.append(line)
140
141
    temp.close()
    removeTempFile(filename, file)
142
143
144
    return lines


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
176
177
178
179
180
181
182
183
184
185
186
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
187
        self.d.currentValue = "<not accessible>"
188
        self.d.currentValuePriority = -100
189
190
        self.d.currentValueEncoding = None
        self.d.currentType = ""
191
        self.d.currentTypePriority = -100
192
193
194
195
196
197

    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)
198
199
200
201
202
203
204
205
206
207
208
209
        try:
            #warn("TYPE CURRENT: %s" % self.d.currentType)
            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:
                self.d.putField("valueencoded", self.d.currentValueEncoding)
            if not self.d.currentValue is None:
                self.d.putField("value", self.d.currentValue)
        except:
            pass
210
211
212
213
214
215
216
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
259
260
261
262
263
264
265
266
267
268
269
270
271
272
        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:
            self.d.putEllipsis();
        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


273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
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"
297
    #6       breakpoint     keep y   0xb6cf18e5 <__cxa_throw+5>\n"
298
    lines = catchCliOutput("info break")
299
300
301
302

    lines.reverse()
    bp = Breakpoint()
    for line in lines:
303
304
        if len(line) == 0 or line.startswith(" "):
            continue
305
306
307
308
309
310
311
312
313
314
        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")
315
        posin = line.find(" in ", pos0x)
316
        poslt = line.find(" <", pos0x)
317
        posat = line.find(" at ", posin)
318
        poscol = line.find(":", posat)
319
320
321
322
323
324
        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)]
325
326
327
        # Take "no address" as indication that the bp is pending.
        #if line.find("<PENDING>") >= 0:
        #    bp.address.append("<PENDING>")
328
329
330
331
332
333
334
335
336
337
338
339
        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
340
341
342
343
        d.put('bkpt={number="%s",' % bp.number)
        d.put('type="breakpoint",')
        d.put('disp="keep",')
        d.put('enabled="y",')
344
        for address in bp.address:
hjk's avatar
hjk committed
345
            d.put('addr="%s",' % address)
346
        if not bp.function is None:
hjk's avatar
hjk committed
347
            d.put('func="%s",' % bp.function)
348
        if not bp.filename is None:
hjk's avatar
hjk committed
349
            d.put('file="%s",' % bp.filename)
350
        if not bp.fullname is None:
hjk's avatar
hjk committed
351
            d.put('fullname="%s",' % bp.fullname)
352
        if not bp.linenumber is None:
hjk's avatar
hjk committed
353
            d.put('line="%s",' % bp.linenumber)
354
        if not bp.condition is None:
hjk's avatar
hjk committed
355
            d.put('cond="%s",' % bp.condition)
356
        if not bp.fullname is None:
hjk's avatar
hjk committed
357
            d.put('fullname="%s",' % bt.fullname)
358
        if not bp.times is None:
hjk's avatar
hjk committed
359
            d.put('times="1",' % bp.times)
360
        #d.put('original-location="-"')
hjk's avatar
hjk committed
361
        d.put('},')
362
363
364
        bp = Breakpoint()


365
366
367
368
369
370
371
372
373
374
375
# 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


376
def listOfLocals(varList):
377
378
379
380
    try:
        frame = gdb.selected_frame()
        #warn("FRAME %s: " % frame)
    except RuntimeError:
381
        warn("FRAME NOT ACCESSIBLE")
hjk's avatar
hjk committed
382
        return []
383

384
    # gdb-6.8-symbianelf fails here
385
    hasBlock = 'block' in __builtin__.dir(frame)
386

387
    items = []
388
    if hasBlock and isGoodGdb():
389
        #warn("IS GOOD: %s " % varList)
390
391
392
393
394
395
396
        try:
            block = frame.block()
            #warn("BLOCK: %s " % block)
        except:
            warn("BLOCK NOT ACCESSIBLE")
            return items

397
398
399
400
401
402
        while True:
            if block is None:
                warn("UNEXPECTED 'None' BLOCK")
                break
            for symbol in block:
                name = symbol.print_name
403

404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
                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
427
        # Assuming gdb 7.0 release or 6.8-symbianelf.
428
        filename, file = createTempFile()
429
        #warn("VARLIST: %s " % varList)
430
        #warn("FILENAME: %s " % filename)
hjk's avatar
hjk committed
431
432
        gdb.execute("set logging off")
        gdb.execute("set logging redirect off")
433
434
435
        gdb.execute("set logging file %s" % filename)
        gdb.execute("set logging redirect on")
        gdb.execute("set logging on")
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
        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
453
454
        gdb.execute("set logging off")
        gdb.execute("set logging redirect off")
455

456
457
458
459
460
461
462
463
464
465
466
467
468
        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
469
        removeTempFile(filename, file)
470
471
472
        #warn("VARLIST: %s " % varList)
        for name in varList:
            #warn("NAME %s " % name)
473
474
475
476
            item = Item(0, "local", name, name)
            try:
                item.value = frame.read_var(name)  # this is a gdb value
            except RuntimeError:
477
478
                pass
                #continue
479
480
481
482
483
            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 [...]
484
                # that break subsequent parsing. Chicken out and take the
485
486
                # next "usable" line.
                continue
487
488
489
490
491
            items.append(item)

    return items


492
def value(expr):
493
    value = parseAndEvaluate(expr)
494
495
496
497
498
    try:
        return int(value)
    except:
        return str(value)

499

hjk's avatar
hjk committed
500
def isSimpleType(typeobj):
501
502
    if typeobj.code == gdb.TYPE_CODE_PTR:
        return False
hjk's avatar
hjk committed
503
504
505
506
507
508
509
510
    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 ") \
511
        or type == "signed" or type.startswith("signed ") \
hjk's avatar
hjk committed
512
513
        or type == "unsigned" or type.startswith("unsigned ")

514

hjk's avatar
hjk committed
515
516
517
518
519
520
521
522
523
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):
524
525
    if True or verbosity > 0:
        print "XXX: %s\n" % message.encode("latin1")
hjk's avatar
hjk committed
526
527
528
529
530
531
    pass

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

532
533
534
535
536
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
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
#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):
558
559
560
561
    # 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 ")
562
    return p.cast(gdb.lookup_type("void").pointer()) == 0
hjk's avatar
hjk committed
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585

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:]
586
587
    elif type.startswith("struct "):
        return type[7:]
hjk's avatar
hjk committed
588
589
590
    return type

def checkPointerRange(p, n):
591
    for i in xrange(n):
hjk's avatar
hjk committed
592
593
594
595
596
597
        checkPointer(p)
        ++p

def call(value, func):
    #warn("CALL: %s -> %s" % (value, func))
    type = stripClassTag(str(value.type))
598
    if type.find(":") >= 0:
hjk's avatar
hjk committed
599
600
601
        type = "'" + type + "'"
    exp = "((%s*)%s)->%s" % (type, value.address, func)
    #warn("CALL: %s" % exp)
602
603
604
605
606
    result = None
    try:
        result = parseAndEvaluate(exp)
    except:
        pass
hjk's avatar
hjk committed
607
608
609
    #warn("  -> %s" % result)
    return result

610
611
def qtNamespace():
    try:
612
        type = str(parseAndEvaluate("&QString::null").type.target().unqualified())
613
614
615
        return type[0:len(type) - len("QString::null")]
    except RuntimeError:
        return ""
616
617
618
    except AttributeError:
        # Happens for none-Qt applications
        return ""
hjk's avatar
hjk committed
619

620
621
622
623
624
625
626
def findFirstZero(p, max):
    for i in xrange(max):
        if p.dereference() == 0:
            return i
        p = p + 1
    return -1

627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652

def extractCharArray(p, maxsize):
    t = gdb.lookup_type("unsigned char").pointer()
    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
    return extractCharArray(data, 100)

653
def encodeCharArray(p, maxsize, size = -1):
654
655
    t = gdb.lookup_type("unsigned char").pointer()
    p = p.cast(t)
656
657
658
659
    if size == -1:
        i = findFirstZero(p, maxsize)
    else:
        i = size
660
    limit = select(i < 0, maxsize, i)
661
    s = ""
662
    for i in xrange(limit):
663
664
        s += "%02x" % int(p.dereference())
        p += 1
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
    if i == maxsize:
        s += "2e2e2e"
    return s

def encodeChar2Array(p, maxsize):
    t = gdb.lookup_type("unsigned short").pointer()
    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):
    t = gdb.lookup_type("unsigned int").pointer()
    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"
693
694
    return s

695
696
697
698
699
700
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)
701
    checkRef(d_ptr["ref"])
702
703
704
    if size > 0:
        checkAccess(data, 4)
        checkAccess(data + size) == 0
705
    return encodeCharArray(data, size)
706
707
708
709
710
711
712
713
714

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
715
        checkAccess(data + size) == 0
716
    checkRef(d_ptr["ref"])
717
718
    p = gdb.Value(d_ptr["data"])
    s = ""
719
    for i in xrange(size):
720
721
722
723
724
725
        val = int(p.dereference())
        s += "%02x" % (val % 256)
        s += "%02x" % (val / 256)
        p += 1
    return s

hjk's avatar
hjk committed
726
727
728
729
730
731
732
#######################################################################
#
# Item
#
#######################################################################

class Item:
733
    def __init__(self, value, parentiname, iname, name = None):
hjk's avatar
hjk committed
734
        self.value = value
735
736
737
738
        if iname is None:
            self.iname = parentiname
        else:
            self.iname = "%s.%s" % (parentiname, iname)
hjk's avatar
hjk committed
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
        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)

754
755
756
757
758
    def invoke(self, args, from_tty):
        options = []
        varList = []
        typeformats = {}
        formats = {}
759
        watchers = ""
760
        expandedINames = ""
761
762
763
764
765
        for arg in args.split(' '):
            pos = arg.find(":") + 1
            if arg.startswith("options:"):
                options = arg[pos:].split(",")
            elif arg.startswith("vars:"):
766
767
                if len(arg[pos:]) > 0:
                    varList = arg[pos:].split(",")
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
            elif arg.startswith("expanded:"):
                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)
                        typeformats[type] = int(f[pos+1:])
            elif arg.startswith("formats:"):
                for f in arg[pos:].split(","):
                    pos = f.find("=")
                    if pos != -1:
                        formats[f[0:pos]] = int(f[pos+1:])
            elif arg.startswith("watchers:"):
                watchers = base64.b16decode(arg[pos:], True)
783

784
        useFancy = "fancy" in options
785
786

        #warn("VARIABLES: %s" % varList)
hjk's avatar
hjk committed
787
788
789
790
        #warn("EXPANDED INAMES: %s" % expandedINames)
        module = sys.modules[__name__]
        self.dumpers = {}

791
792
793
        if False:
            dumpers = ""
            typeformats = ""
hjk's avatar
hjk committed
794
            for key, value in module.__dict__.items():
795
                if key.startswith("qdump__"):
796
797
                    dumpers += '"' + key[7:] + '",'
            output = "dumpers=[%s]," % dumpers
hjk's avatar
hjk committed
798
            #output += "qtversion=[%d,%d,%d]"
799
            #output += "qtversion=[4,6,0],"
hjk's avatar
hjk committed
800
801
802
803
804
805
806
            output += "namespace=\"%s\"," % qtNamespace()
            output += "dumperversion=\"2.0\","
            output += "sizes=[],"
            output += "expressions=[]"
            output += "]"
            print output
            return
807

808

hjk's avatar
hjk committed
809
810
        if useFancy:
            for key, value in module.__dict__.items():
811
812
                if key.startswith("qdump__"):
                    self.dumpers[key[7:]] = value
hjk's avatar
hjk committed
813
814
815

        d = Dumper()
        d.dumpers = self.dumpers
816
817
        d.typeformats = typeformats
        d.formats = formats
818
819
820
        d.useFancy = useFancy
        d.passExceptions = "passexceptions" in options
        d.autoDerefPointers = "autoderef" in options
821
        d.ns = qtNamespace()
822
        d.expandedINames = expandedINames
hjk's avatar
hjk committed
823
824
        #warn(" NAMESPACE IS: '%s'" % d.ns)

825
826
827
        #
        # Locals
        #
828
        for item in listOfLocals(varList):
829
          with OutputSafer(d, "", ""):
830
            d.anonNumber = -1
831
            #warn("ITEM NAME %s: " % item.name)
832
833
834
            try:
                #warn("ITEM VALUE %s: " % item.value)
                # Throw on funny stuff, catch below.
hjk's avatar
hjk committed
835
836
837
838
                # Unfortunately, this fails also with a "Unicode encoding error"
                # in testArray().
                #dummy = str(item.value)
                pass
839
840
            except:
                # Locals with failing memory access.
841
842
843
844
845
846
847
                with SubItem(d):
                    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"');
848
                continue
849
850
851
852

            type = item.value.type
            if type.code == gdb.TYPE_CODE_PTR \
                    and item.name == "argv" and str(type) == "char **":
853
                # Special handling for char** argv.
854
855
                n = 0
                p = item.value
856
857
858
859
860
                # p is 0 for "optimized out" cases.
                if not isNull(p):
                    while not isNull(p.dereference()) and n <= 100:
                        p += 1
                        n += 1
861

862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
                with SubItem(d):
                    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):
                        p = item.value
                        with Children(d, n):
                            for i in xrange(n):
                                value = p.dereference()
                                d.putItem(Item(value, item.iname, i, None))
                                p += 1
                            if n > 100:
                                d.putEllipsis()
877
878

            else:
879
                # A "normal" local variable or parameter.
880
                try:
881
                   addr = cleanAddress(item.value.address)
882
883
884
885
                   with SubItem(d):
                       d.put('iname="%s",' % item.iname)
                       d.put('addr="%s",' % addr)
                       d.putItemHelper(item)
886
                except AttributeError:
887
888
                    # Thrown by cleanAddress with message "'NoneType' object
                    # has no attribute 'cast'" for optimized-out values.
889
890
891
892
893
894
                    with SubItem(d):
                        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)
895

896
897
898
        #
        # Watchers
        #
899
900
901
902
903
        with OutputSafer(d, ",", ""):
            if len(watchers) > 0:
                for watcher in watchers.split("##"):
                    (exp, iname) = watcher.split("#")
                    self.handleWatch(d, exp, iname)
hjk's avatar
hjk committed
904

905
906
907
        #
        # Breakpoints
        #
908
909
910
        #listOfBreakpoints(d)

        #print('data=[' + locals + sep + watchers + '],bkpts=[' + breakpoints + ']\n')
911
        print('data=[' + d.output + ']')
912

913

914
    def handleWatch(self, d, exp, iname):
915
        exp = str(exp)
916
        escapedExp = exp.replace('"', '\\"');
917
        #warn("HANDLING WATCH %s, INAME: '%s'" % (exp, iname))
918
919
        if exp.startswith("[") and exp.endswith("]"):
            #warn("EVAL: EXP: %s" % exp)
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
            with SubItem(d):
                d.putField("iname", iname)
                d.putField("name", escapedExp)
                d.putField("exp", escapedExp)
                try:
                    list = eval(exp)
                    d.putValue("")
                    d.putType(" ")
                    d.putNumChild(len(list))
                    # This is a list of expressions to evaluate
                    with Children(d, len(list)):
                        itemNumber = 0
                        for item in list:
                            self.handleWatch(d, item, "%s.%d" % (iname, itemNumber))
                            itemNumber += 1
                except RuntimeError, error:
                    warn("EVAL: ERROR CAUGHT %s" % error)
                    d.putValue("<syntax error>")
                    d.putType(" ")
                    d.putNumChild(0)
                    with Children(d, 0):
                        pass
            return

        with SubItem(d):
945
            d.putField("iname", iname)
946
947
            d.putField("name", escapedExp)
            d.putField("exp", escapedExp)
948
949
950
951
952
953
954
955
956
957
958
959
            handled = False
            if exp == "<Edit>" or len(exp) == 0:
                d.put('value=" ",type=" ",numchild="0",')
            else:
                try:
                    value = parseAndEvaluate(exp)
                    item = Item(value, iname, None, None)
                    if not value is None:
                        d.putAddress(value.address)
                    d.putItemHelper(item)
                except RuntimeError:
                    d.put('value="<invalid>",type="<unknown>",numchild="0",')
960

hjk's avatar
hjk committed
961
962
963
964

FrameCommand()


965
966
967
968
969
970
971
972
973
974
975
976
977
978
#######################################################################
#
# 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):
979
980
        (cmd, addr) = arg.split(",")
        lines = catchCliOutput("info line *" + addr)
981
982
983
984
985
986
987
988
989
990
        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]
991
        gdb.execute("maint packet sal%s,%s,%s" % (cmd,fromAddr, toAddr))
992
993

SalCommand()
hjk's avatar
hjk committed
994

995

hjk's avatar
hjk committed
996
997
998
999
1000
1001
#######################################################################
#
# The Dumper Class
#
#######################################################################

1002

hjk's avatar
hjk committed
1003
1004
1005
class Dumper:
    def __init__(self):
        self.output = ""
1006
1007
1008
1009
1010
1011
1012
1013
1014
        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
hjk's avatar
hjk committed
1015
1016
1017
1018
1019

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

    def putField(self, name, value):
hjk's avatar
hjk committed
1020
        self.put('%s="%s",' % (name, value))
hjk's avatar
hjk committed
1021
1022

    def beginItem(self, name):
1023
        self.put('%s="' % name)
hjk's avatar
hjk committed
1024
1025

    def endItem(self):
hjk's avatar
hjk committed
1026
        self.put('",')
hjk's avatar
hjk committed
1027

1028
    def childRange(self):
1029
        return xrange(qmin(self.currentMaxNumChilds, self.currentNumChilds))
1030

hjk's avatar
hjk committed
1031
1032
    # convenience
    def putItemCount(self, count):
hjk's avatar
hjk committed
1033
        self.put('value="<%s items>",' % count)
hjk's avatar
hjk committed
1034
1035

    def putEllipsis(self):
hjk's avatar
hjk committed
1036
        self.put('{name="<incomplete>",value="",type="",numchild="0"},')
hjk's avatar
hjk committed
1037

1038
1039
1040
1041
1042
    def putType(self, type, priority = 0):
        # higher priority values override lower ones 
        if priority >= self.currentTypePriority:
            self.currentType = type
            self.currentTypePriority = priority
hjk's avatar
hjk committed
1043

1044
1045
1046
    def putAddress(self, addr):
        self.put('addr="%s",' % cleanAddress(addr))

hjk's avatar
hjk committed
1047
    def putNumChild(self, numchild):
1048
1049
        #warn("NUM CHILD: '%s' '%s'" % (numchild, self.currentChildNumChild))
        if numchild != self.currentChildNumChild:
hjk's avatar
hjk committed
1050
            self.put('numchild="%s",' % numchild)
hjk's avatar
hjk committed
1051

1052
1053
1054
1055
1056
1057
    def putValue(self, value, encoding = None, priority = 0):
        # higher priority values override lower ones 
        if priority >= self.currentValuePriority:
            self.currentValue = value
            self.currentValuePriority = priority
            self.currentValueEncoding = encoding
1058

1059
    def putPointerValue(self, value):
1060
        # Use a lower priority
1061
1062
        self.putValue("0x%x" % value.dereference().cast(
            gdb.lookup_type("unsigned long")), None, -1)
1063

1064
    def putStringValue(self, value):
1065
        if value is None:
hjk's avatar
hjk committed
1066
            self.put('value="<not available>",')
1067
1068
        else:
            str = encodeString(value)
1069
            self.put('valueencoded="%d",value="%s",' % (Hex4EncodedLittleEndian, str))
1070

1071
1072
1073
1074
1075
1076
1077
1078
    def putDisplay(self, format, value = None, cmd = None):
        self.put('editformat="%s",' % format)
        if cmd is None:
            if not value is None:
                self.put('editvalue="%s",' % value)
        else:
            self.put('editvalue="%s|%s",' % (cmd, value))

1079
1080
    def putByteArrayValue(self, value):
        str = encodeByteArray(value)
1081
        self.put('valueencoded="%d",value="%s",' % (Hex2EncodedLatin1, str))
1082

1083
    def putName(self, name):
hjk's avatar
hjk committed
1084
        self.put('name="%s",' % name)
1085

hjk's avatar
hjk committed
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
    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 stripNamespaceFromType(self, typeobj):
1099
1100
1101
1102
1103
        # 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
1104
1105
1106
1107
        type = stripClassTag(str(typeobj))
        if len(self.ns) > 0 and type.startswith(self.ns):
            type = type[len(self.ns):]
        pos = type.find("<")
1108
1109
1110
1111
1112
        # FIXME: make it recognize  foo<A>::bar<B>::iterator?
        while pos != -1:
            pos1 = type.rfind(">", pos)
            type = type[0:pos] + type[pos1+1:]
            pos = type.find("<")
hjk's avatar
hjk committed
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
        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):
1123
1124
1125
1126
1127
        with SubItem(self):
            self.putName(name)
            self.putValue(value)
            self.putType("int")
            self.putNumChild(0)
hjk's avatar
hjk committed
1128
1129

    def putBoolItem(self, name, value):
1130
1131
1132
1133
1134
        with SubItem(self):
            self.putName(name)
            self.putValue(value)
            self.putType("bool")
            self.putNumChild(0)
hjk's avatar
hjk committed
1135

1136
    def itemFormat(self, item):
1137
        format = self.formats.get(str(cleanAddress(item.value.address)))
1138
1139
1140
1141
        if format is None:
            format = self.typeformats.get(stripClassTag(str(item.value.type)))
        return format

hjk's avatar
hjk committed
1142
    def putItem(self, item):
1143
1144
        with SubItem(self):
            self.putItemHelper(item)
hjk's avatar
hjk committed
1145
1146

    def putCallItem(self, name, item, func):
1147
1148
        result = call(item.value, func)
        self.putItem(Item(result, item.iname, name, name))
hjk's avatar
hjk committed
1149

1150
    def putItemHelper(self, item):
hjk's avatar
hjk committed
1151
1152
        name = getattr(item, "name", None)
        if not name is None:
1153
            self.putName(name)
hjk's avatar
hjk committed
1154

1155
1156
1157
1158
1159
1160
1161
1162
        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
1163
        # FIXME: Gui shows references stripped?
1164
        #warn(" ");
hjk's avatar
hjk committed
1165
        #warn("REAL INAME: %s " % item.iname)
1166
        #warn("REAL NAME: %s " % name)
hjk's avatar
hjk committed
1167
        #warn("REAL TYPE: %s " % item.value.type)
1168
        #warn("REAL VALUE: %s " % item.value)
1169
1170
        #try:
        #    warn("REAL VALUE: %s " % item.value)
1171
1172
        #except:
        #    #UnicodeEncodeError:
1173
        #    warn("REAL VALUE: <unprintable>")
hjk's avatar
hjk committed
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186

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

hjk's avatar
hjk committed
1188
1189
1190
1191
        #warn(" STRIPPED: %s" % strippedType)
        #warn(" DUMPERS: %s" % self.dumpers)
        #warn(" DUMPERS: %s" % (strippedType in self.dumpers))

1192
        if isSimpleType(type.unqualified()):
1193
1194
            #warn("IS SIMPLE: %s " % type)
            self.putType(item.value.type)
1195
1196
            self.putValue(value)
            self.putNumChild(0)
hjk's avatar
hjk committed
1197
1198

        elif strippedType in self.dumpers:
1199
1200
            #warn("IS DUMPABLE: %s " % type)
            self.putType(item.value.type)
hjk's avatar
hjk committed
1201
            self.dumpers[strippedType](self, item)
1202
            #warn(" RESULT: %s " % self.output)
hjk's avatar
hjk committed
1203
1204

        elif type.code == gdb.TYPE_CODE_ENUM:
1205
            #warn("GENERIC ENUM: %s" % value)
1206
            self.putType(item.value.type)
1207
            self.putValue(value)
hjk's avatar
hjk committed
1208
            self.putNumChild(0)
1209

hjk's avatar
hjk committed
1210
1211

        elif type.code == gdb.TYPE_CODE_PTR:
1212
1213
            isHandled = False

1214
            format = self.itemFormat(item)
hjk's avatar