dumper.py 57.1 KB
Newer Older
hjk's avatar
hjk committed
1
import sys
2
import base64
3
import __builtin__
4
import os
hjk's avatar
hjk committed
5
import tempfile
6

7 8 9 10
# Fails on Windows.
try:
    import curses.ascii
    def printableChar(ucs):
11 12 13
        if curses.ascii.isprint(ucs):
            return ucs
        return '?'
14
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
try:
23 24 25
    # Test if 2.6 is used (Windows), trigger exception and default
    # to 2nd version.
    tempfile.NamedTemporaryFile(prefix="py_",delete=True)
26
    def createTempFile():
27
        file = tempfile.NamedTemporaryFile(prefix="py_",delete=False)
28
        file.close()
29
        return file.name, file
30

31 32
except:
    def createTempFile():
33 34
        global tempFileCounter
        tempFileCounter += 1
35
        fileName = "%s/py_tmp_%d_%d" \
hjk's avatar
hjk committed
36
            % (tempfile.gettempdir(), os.getpid(), tempFileCounter)
37
        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
# Some "Enums"

# Encodings
Unencoded8Bit, \
57 58 59 60 61 62 63 64 65 66
Base64Encoded8BitWithQuotes, \
Base64Encoded16BitWithQuotes, \
Base64Encoded32BitWithQuotes, \
Base64Encoded16Bit, \
Base64Encoded8Bit, \
Hex2EncodedLatin1, \
Hex4EncodedLittleEndian, \
Hex8EncodedLittleEndian, \
Hex2EncodedUtf8, \
Hex8EncodedBigEndian, \
Arvid Ephraim Picciani's avatar
Arvid Ephraim Picciani committed
67
Hex4EncodedBigEndian, \
68
Hex4EncodedLittleEndianWithoutQuotes, \
69 70 71 72 73
Hex2EncodedLocal8Bit, \
JulianDate, \
MillisecondsSinceMidnight, \
JulianDateAndMillisecondsSinceMidnight \
    = range(17)
74 75

# Display modes
76 77 78 79 80 81
StopDisplay, \
DisplayImage1, \
DisplayString, \
DisplayImage, \
DisplayProcess \
    = range(5)
82 83


84
def hasInferiorThreadList():
85
    #return False
86
    try:
87
        a = gdb.inferiors()[0].threads()
88 89 90 91
        return True
    except:
        return False

92 93 94 95 96 97 98
def upcast(value):
    try:
        type = value.dynamic_type
        return value.cast(type)
    except:
        return value

99 100
typeCache = {}

101 102 103 104 105 106 107
class TypeInfo:
    def __init__(self, type):
        self.size = type.sizeof
        self.reported = False

typeInfoCache = {}

108 109
def lookupType(typestring):
    type = typeCache.get(typestring)
hjk's avatar
hjk committed
110
    #warn("LOOKUP 1: %s -> %s" % (typestring, type))
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139
    if not type is None:
        return type

    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:]
        elif ts.startswith("enum "):
            ts = ts[5:]
        elif ts.endswith(" const"):
            ts = ts[:-6]
        elif ts.endswith(" volatile"):
            ts = ts[:-9]
        elif ts.endswith("*const"):
            ts = ts[:-5]
        elif ts.endswith("*volatile"):
            ts = ts[:-8]
        else:
            break

    if ts.endswith('*'):
        type = lookupType(ts[0:-1])
hjk's avatar
hjk committed
140 141 142
        if not type is None:
            type = type.pointer()
            typeCache[typestring] = type
143 144 145 146 147 148 149
            return type

    try:
        #warn("LOOKING UP '%s'" % ts)
        type = gdb.lookup_type(ts)
    except RuntimeError, error:
        #warn("LOOKING UP '%s': %s" % (ts, error))
150 151 152 153 154
        if type is None:
            pos = typestring.find("<unnamed>")
            if pos != -1:
                # See http://sourceware.org/bugzilla/show_bug.cgi?id=13269
                return lookupType(typestring.replace("<unnamed>", "(anonymous namespace)"))
155 156 157 158 159 160 161 162 163
        # See http://sourceware.org/bugzilla/show_bug.cgi?id=11912
        exp = "(class '%s'*)0" % ts
        try:
            type = parseAndEvaluate(exp).type.target()
        except:
            # Can throw "RuntimeError: No type named class Foo."
            pass
    except:
        #warn("LOOKING UP '%s' FAILED" % ts)
164
        pass
165 166 167

    # This could still be None as gdb.lookup_type("char[3]") generates
    # "RuntimeError: No type named char[3]"
168 169
    return type

170
def cleanAddress(addr):
171 172
    if addr is None:
        return "<no address>"
173 174
    # We cannot use str(addr) as it yields rubbish for char pointers
    # that might trigger Unicode encoding errors.
175
    #return addr.cast(lookupType("void").pointer())
176 177
    # We do not use "hex(...)" as it (sometimes?) adds a "L" suffix.
    return "0x%x" % long(addr)
178

179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208
def extractTemplateArgument(type, position):
    level = 0
    skipSpace = False
    inner = ""
    type = str(type)
    for c in type[type.find('<') + 1 : -1]:
        if c == '<':
            inner += c
            level += 1
        elif c == '>':
            level -= 1
            inner += c
        elif c == ',':
            if level == 0:
                if position == 0:
                    return inner
                position -= 1
                inner = ""
            else:
                inner += c
                skipSpace = True
        else:
            if skipSpace and c == ' ':
                pass
            else:
                inner += c
                skipSpace = False
    return inner

def templateArgument(type, position):
209 210 211 212 213 214
    try:
        # This fails on stock 7.2 with
        # "RuntimeError: No type named myns::QObject.\n"
        return type.template_argument(position)
    except:
        # That's something like "myns::QList<...>"
215
        return lookupType(extractTemplateArgument(type.strip_typedefs(), position))
216

217

hjk's avatar
hjk committed
218 219 220 221
# Workaround for gdb < 7.1
def numericTemplateArgument(type, position):
    try:
        return int(type.template_argument(position))
222
    except RuntimeError, error:
hjk's avatar
hjk committed
223 224 225 226
        # ": No type named 30."
        msg = str(error)
        return int(msg[14:-1])

227

228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246
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
hjk's avatar
hjk committed
247
        self.d.output = []
248 249 250 251 252 253 254

    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:
hjk's avatar
hjk committed
255 256
            self.savedOutput.extend(self.d.output)
            self.d.output = self.savedOutput
257 258 259
        return False


260 261 262 263 264
class NoAddress:
    def __init__(self, d):
        self.d = d

    def __enter__(self):
hjk's avatar
hjk committed
265 266
        self.savedPrintsAddress = self.d.currentPrintsAddress
        self.d.currentPrintsAddress = False
267 268

    def __exit__(self, exType, exValue, exTraceBack):
hjk's avatar
hjk committed
269
        self.d.currentPrintsAddress = self.savedPrintsAddress
270 271


272
class SubItem:
hjk's avatar
hjk committed
273
    def __init__(self, d, component):
274
        self.d = d
hjk's avatar
hjk committed
275 276
        self.iname = "%s.%s" % (d.currentIName, component)
        self.name = component
277 278 279

    def __enter__(self):
        self.d.put('{')
hjk's avatar
hjk committed
280 281 282 283
        #if not self.name is None:
        if isinstance(self.name, str):
            self.d.put('name="%s",' % self.name)
        self.savedIName = self.d.currentIName
284 285 286 287 288
        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
289
        self.d.currentIName = self.iname
290
        self.d.currentValuePriority = -100
291 292
        self.d.currentValueEncoding = None
        self.d.currentType = ""
293
        self.d.currentTypePriority = -100
294 295 296 297 298 299

    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)
300
        try:
301
            #warn("TYPE VALUE: %s" % self.d.currentValue)
hjk's avatar
hjk committed
302 303 304 305 306 307 308 309
            typeName = stripClassTag(self.d.currentType)
            #warn("TYPE: '%s'  DEFAULT: '%s' % (typeName, self.d.currentChildType))

            if len(typeName) > 0 and typeName != self.d.currentChildType:
                self.d.put('type="%s",' % typeName) # str(type.unqualified()) ?
                if not typeName in typeInfoCache \
                        and typeName != " ": # FIXME: Move to lookupType
                    typeObj = lookupType(typeName)
310
                    if not typeObj is None:
hjk's avatar
hjk committed
311 312 313 314 315 316
                        typeInfoCache[typeName] = TypeInfo(typeObj)
            if  self.d.currentValue is None:
                self.d.put('value="<not accessible>",numchild="0",')
            else:
                if not self.d.currentValueEncoding is None:
                    self.d.put('valueencoded="%d",' % self.d.currentValueEncoding)
317
                self.d.put('value="%s",' % self.d.currentValue)
318 319
        except:
            pass
320
        self.d.put('},')
hjk's avatar
hjk committed
321
        self.d.currentIName = self.savedIName
322 323 324 325 326 327 328
        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

hjk's avatar
hjk committed
329 330 331 332 333 334 335 336 337 338 339
class TopLevelItem(SubItem):
    def __init__(self, d, iname):
        self.d = d
        self.iname = iname
        self.name = None

class UnnamedSubItem(SubItem):
    def __init__(self, d, component):
        self.d = d
        self.iname = "%s.%s" % (self.d.currentIName, component)
        self.name = None
340 341

class Children:
hjk's avatar
hjk committed
342 343
    def __init__(self, d, numChild = 1, childType = None, childNumChild = None,
            maxNumChild = None, addrBase = None, addrStep = None):
344 345 346
        self.d = d
        self.numChild = numChild
        self.childNumChild = childNumChild
hjk's avatar
hjk committed
347 348 349 350
        self.maxNumChild = maxNumChild
        self.addrBase = addrBase
        self.addrStep = addrStep
        self.printsAddress = True
351 352 353
        if childType is None:
            self.childType = None
        else:
hjk's avatar
hjk committed
354 355
            self.childType = stripClassTag(str(childType))
            self.d.put('childtype="%s",' % self.childType)
356 357 358 359 360 361 362 363 364 365
            if childNumChild is None:
                if isSimpleType(childType):
                    self.d.put('childnumchild="0",')
                    self.childNumChild = 0
                elif childType.code == PointerCode:
                    self.d.put('childnumchild="1",')
                    self.childNumChild = 1
            else:
                self.d.put('childnumchild="%s",' % childNumChild)
                self.childNumChild = childNumChild
hjk's avatar
hjk committed
366 367 368 369 370 371 372
        try:
            if not addrBase is None and not addrStep is None:
                self.d.put('addrbase="0x%x",' % long(addrBase))
                self.d.put('addrstep="0x%x",' % long(addrStep))
                self.printsAddress = False
        except:
            warn("ADDRBASE: %s" % addrBase)
373 374 375 376 377
        #warn("CHILDREN: %s %s %s" % (numChild, childType, childNumChild))

    def __enter__(self):
        self.savedChildType = self.d.currentChildType
        self.savedChildNumChild = self.d.currentChildNumChild
hjk's avatar
hjk committed
378 379 380 381 382 383 384 385
        self.savedNumChild = self.d.currentNumChild
        self.savedMaxNumChild = self.d.currentMaxNumChild
        self.savedPrintsAddress = self.d.currentPrintsAddress
        self.d.currentChildType = self.childType
        self.d.currentChildNumChild = self.childNumChild
        self.d.currentNumChild = self.numChild
        self.d.currentMaxNumChild = self.maxNumChild
        self.d.currentPrintsAddress = self.printsAddress
386 387 388 389 390
        self.d.put("children=[")

    def __exit__(self, exType, exValue, exTraceBack):
        if self.d.passExceptions and not exType is None:
            showException("CHILDREN", exType, exValue, exTraceBack)
hjk's avatar
hjk committed
391 392 393
        if not self.d.currentMaxNumChild is None:
            if self.d.currentMaxNumChild < self.d.currentNumChild:
                self.d.put('{name="<incomplete>",value="",type="",numchild="0"},')
394 395
        self.d.currentChildType = self.savedChildType
        self.d.currentChildNumChild = self.savedChildNumChild
hjk's avatar
hjk committed
396 397 398
        self.d.currentNumChild = self.savedNumChild
        self.d.currentMaxNumChild = self.savedMaxNumChild
        self.d.currentPrintsAddress = self.savedPrintsAddress
399 400 401 402
        self.d.put('],')
        return True


403
def value(expr):
404
    value = parseAndEvaluate(expr)
405 406 407 408 409
    try:
        return int(value)
    except:
        return str(value)

hjk's avatar
hjk committed
410
def isSimpleType(typeobj):
411
    code = typeobj.code
412 413 414 415 416
    return code == BoolCode \
        or code == CharCode \
        or code == IntCode \
        or code == FloatCode \
        or code == EnumCode
hjk's avatar
hjk committed
417 418

def warn(message):
419 420
    if True or verbosity > 0:
        print "XXX: %s\n" % message.encode("latin1")
hjk's avatar
hjk committed
421 422 423 424 425 426
    pass

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

427
def checkRef(ref):
428 429 430 431 432
    count = 0
    if qtMajorVersion() >= 5:
        count = ref["atomic"]["_q_value"]
    else:
        count = ref["_q_value"]
433 434 435
    check(count > 0)
    check(count < 1000000) # assume there aren't a million references to any object

hjk's avatar
hjk committed
436
#def couldBePointer(p, align):
437
#    type = lookupType("unsigned int")
hjk's avatar
hjk committed
438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454
#    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()

455 456 457 458 459 460
def isAccessible(p):
    try:
        long(p)
        return True
    except:
        return False
hjk's avatar
hjk committed
461 462

def isNull(p):
463 464 465 466
    # 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 ")
467 468 469 470 471
    #try:
    #    # Can fail with: "RuntimeError: Cannot access memory at address 0x5"
    #    return p.cast(lookupType("void").pointer()) == 0
    #except:
    #    return False
472 473 474 475 476
    try:
        # Can fail with: "RuntimeError: Cannot access memory at address 0x5"
        return long(p) == 0
    except:
        return False
hjk's avatar
hjk committed
477 478

movableTypes = set([
hjk's avatar
hjk committed
479 480 481 482 483 484
    "QBrush", "QBitArray", "QByteArray", "QCustomTypeInfo", "QChar", "QDate",
    "QDateTime", "QFileInfo", "QFixed", "QFixedPoint", "QFixedSize",
    "QHashDummyValue", "QIcon", "QImage", "QLine", "QLineF", "QLatin1Char",
    "QLocale", "QMatrix", "QModelIndex", "QPoint", "QPointF", "QPen",
    "QPersistentModelIndex", "QResourceRoot", "QRect", "QRectF", "QRegExp",
    "QSize", "QSizeF", "QString", "QTime", "QTextBlock", "QUrl", "QVariant",
hjk's avatar
hjk committed
485
    "QXmlStreamAttribute", "QXmlStreamNamespaceDeclaration",
hjk's avatar
hjk committed
486 487 488 489 490 491 492 493 494 495 496 497 498
    "QXmlStreamNotationDeclaration", "QXmlStreamEntityDeclaration"
])

def stripClassTag(typeName):
    if typeName.startswith("class "):
        return typeName[6:]
    if typeName.startswith("struct "):
        return typeName[7:]
    if typeName.startswith("const "):
        return typeName[6:]
    if typeName.startswith("volatile "):
        return typeName[9:]
    return typeName
hjk's avatar
hjk committed
499 500

def checkPointerRange(p, n):
501
    for i in xrange(n):
hjk's avatar
hjk committed
502 503 504
        checkPointer(p)
        ++p

hjk's avatar
hjk committed
505 506 507 508 509 510 511 512 513 514 515 516 517
def call2(value, func, args):
    # args is a tuple.
    arg = ""
    for i in range(len(args)):
        if i:
            arg += ','
        a = args[i]
        if (':' in a) and not ("'" in a):
            arg = "'%s'" % a
        else:
            arg += a

    #warn("CALL: %s -> %s(%s)" % (value, func, arg))
hjk's avatar
hjk committed
518
    type = stripClassTag(str(value.type))
519
    if type.find(":") >= 0:
hjk's avatar
hjk committed
520
        type = "'" + type + "'"
521
    # 'class' is needed, see http://sourceware.org/bugzilla/show_bug.cgi?id=11912
hjk's avatar
hjk committed
522
    exp = "((class %s*)%s)->%s(%s)" % (type, value.address, func, arg)
hjk's avatar
hjk committed
523
    #warn("CALL: %s" % exp)
524 525 526 527 528
    result = None
    try:
        result = parseAndEvaluate(exp)
    except:
        pass
hjk's avatar
hjk committed
529 530 531
    #warn("  -> %s" % result)
    return result

hjk's avatar
hjk committed
532 533 534
def call(value, func, *args):
    return call2(value, func, args)

535 536 537 538
def makeValue(type, init):
    type = stripClassTag(type)
    if type.find(":") >= 0:
        type = "'" + type + "'"
hjk's avatar
hjk committed
539
    # Avoid malloc symbol clash with QVector.
540
    gdb.execute("set $d = (%s*)calloc(sizeof(%s), 1)" % (type, type))
541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557
    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

558 559
qqNs = None

560
def qtNamespace():
561
    # FIXME: This only works when call from inside a Qt function frame.
562
    global qqNs
563 564
    if not qqNs is None:
        return qqNs
565
    try:
566
        str = catchCliOutput("ptype QString::Null")[0]
hjk's avatar
hjk committed
567
        # The result looks like:
568 569 570 571 572
        # "type = const struct myns::QString::Null {"
        # "    <no data fields>"
        # "}"
        pos1 = str.find("struct") + 7
        pos2 = str.find("QString::Null")
573 574 575 576
        if pos1 > -1 and pos2 > -1:
            qqNs = str[pos1:pos2]
            return qqNs
        return ""
577
    except:
578
        return ""
hjk's avatar
hjk committed
579

580 581 582 583 584 585 586 587 588 589
# --  Determine major Qt version by calling qVersion (cached)

qqMajorVersion = None

def qtMajorVersion():
    global qqMajorVersion
    if not qqMajorVersion is None:
        return qqMajorVersion
    try:
        # -- Result is returned as character, need to subtract '0'
590 591 592 593 594
        v = int(parseAndEvaluate("*(char*)qVersion()"))
        if v >= 51:
            qqMajorVersion = v - 48
            return qqMajorVersion
        return 0
595 596 597
    except:
        return 0

598 599
def findFirstZero(p, maximum):
    for i in xrange(maximum):
600 601 602
        if p.dereference() == 0:
            return i
        p = p + 1
603
    return maximum + 1
604

605
def extractCharArray(p, maxsize):
606
    t = lookupType("unsigned char").pointer()
607
    p = p.cast(t)
608
    limit = findFirstZero(p, maxsize)
609 610 611 612
    s = ""
    for i in xrange(limit):
        s += "%c" % int(p.dereference())
        p += 1
613
    if i > maxsize:
614 615 616 617 618 619 620 621 622 623 624 625 626
        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
627
    return extractCharArray(data, min(100, size))
628

629
def encodeCharArray(p, maxsize, limit = -1):
630
    t = lookupType("unsigned char").pointer()
631
    p = p.cast(t)
632 633
    if limit == -1:
        limit = findFirstZero(p, maxsize)
634
    s = ""
635 636 637 638 639 640 641 642
    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
643
    if limit > maxsize:
644 645 646 647
        s += "2e2e2e"
    return s

def encodeChar2Array(p, maxsize):
648
    t = lookupType("unsigned short").pointer()
649
    p = p.cast(t)
650
    limit = findFirstZero(p, maxsize)
651 652 653 654 655 656 657 658 659
    s = ""
    for i in xrange(limit):
        s += "%04x" % int(p.dereference())
        p += 1
    if i == maxsize:
        s += "2e002e002e00"
    return s

def encodeChar4Array(p, maxsize):
660
    t = lookupType("unsigned int").pointer()
661
    p = p.cast(t)
662
    limit = findFirstZero(p, maxsize)
663 664 665 666
    s = ""
    for i in xrange(limit):
        s += "%08x" % int(p.dereference())
        p += 1
667
    if i > maxsize:
668
        s += "2e0000002e0000002e000000"
669 670
    return s

671 672 673 674 675 676 677 678 679 680 681 682
def qByteArrayData(value):
    if qtMajorVersion() < 5:
        d_ptr = value['d'].dereference()
        checkRef(d_ptr["ref"])
        data = d_ptr['data']
        size = d_ptr['size']
        alloc = d_ptr['alloc']
        return data, size, alloc
    else: # Qt5: Implement the QByteArrayData::data() accessor.
        qByteArrayData = value['d'].dereference()
        size = qByteArrayData['size']
        alloc = qByteArrayData['alloc']
683
        charPointerType = lookupType('char *')
hjk's avatar
hjk committed
684 685
        data = qByteArrayData['d'].cast(charPointerType) \
             + qByteArrayData['offset'] + charPointerType.sizeof
686 687
        return data, size, alloc

688
def encodeByteArray(value):
689
    data, size, alloc = qByteArrayData(value)
690 691 692 693
    check(0 <= size and size <= alloc and alloc <= 100*1000*1000)
    if size > 0:
        checkAccess(data, 4)
        checkAccess(data + size) == 0
694
    return encodeCharArray(data, 100, size)
695

696 697 698 699
def qQStringData(value):
    if qtMajorVersion() < 5:
        d_ptr = value['d'].dereference()
        checkRef(d_ptr['ref'])
hjk's avatar
hjk committed
700
        return d_ptr['data'], int(d_ptr['size']), int(d_ptr['alloc'])
701 702
    else: # Qt5: Implement the QStringArrayData::data() accessor.
        qStringData = value['d'].dereference()
703
        ushortPointerType = lookupType('ushort *')
hjk's avatar
hjk committed
704 705 706
        data = qStringData['d'].cast(ushortPointerType) \
            + ushortPointerType.sizeof / 2 + qStringData['offset']
        return data, int(qStringData['size']), int(qStringData['alloc'])
707

708
def encodeString(value):
709 710
    data, size, alloc = qQStringData(value)

711 712 713
    check(0 <= size and size <= alloc and alloc <= 100*1000*1000)
    if size > 0:
        checkAccess(data, 4)
hjk's avatar
hjk committed
714
        checkAccess(data + size) == 0
715
    s = ""
716
    limit = min(size, 1000)
717 718 719
    try:
        # gdb.Inferior is new in gdb 7.2
        inferior = gdb.inferiors()[0]
720
        s = binascii.hexlify(inferior.read_memory(data, 2 * limit))
721
    except:
722
        p = data
723
        for i in xrange(limit):
724 725 726 727
            val = int(p.dereference())
            s += "%02x" % (val % 256)
            s += "%02x" % (val / 256)
            p += 1
728 729
    if limit < size:
        s += "2e002e002e00"
730 731
    return s

hjk's avatar
hjk committed
732 733
def stripTypedefs(type):
    type = type.unqualified()
hjk's avatar
hjk committed
734
    while type.code == TypedefCode:
735 736 737
        type = type.strip_typedefs().unqualified()
    return type

hjk's avatar
hjk committed
738 739
def extractFields(type):
    # Insufficient, see http://sourceware.org/bugzilla/show_bug.cgi?id=10953:
hjk's avatar
hjk committed
740
    #fields = type.fields()
hjk's avatar
hjk committed
741
    # Insufficient, see http://sourceware.org/bugzilla/show_bug.cgi?id=11777:
hjk's avatar
hjk committed
742
    #fields = defsype).fields()
hjk's avatar
hjk committed
743
    # This seems to work.
hjk's avatar
hjk committed
744
    #warn("TYPE 0: %s" % type)
hjk's avatar
hjk committed
745
    type = stripTypedefs(type)
746 747 748
    fields = type.fields()
    if len(fields):
        return fields
hjk's avatar
hjk committed
749
    #warn("TYPE 1: %s" % type)
750
    # This fails for arrays. See comment in lookupType.
751 752 753
    type0 = lookupType(str(type))
    if not type0 is None:
        type = type0
hjk's avatar
hjk committed
754
    if type.code == FunctionCode:
755
        return []
hjk's avatar
hjk committed
756 757
    #warn("TYPE 2: %s" % type)
    fields = type.fields()
hjk's avatar
hjk committed
758
    #warn("FIELDS: %s" % fields)
hjk's avatar
hjk committed
759 760
    return fields

hjk's avatar
hjk committed
761 762
#######################################################################
#
763
# LocalItem
hjk's avatar
hjk committed
764 765 766
#
#######################################################################

767
# Contains iname, name, and value.
hjk's avatar
hjk committed
768
class LocalItem:
769
    pass
hjk's avatar
hjk committed
770

771 772 773 774 775 776
#######################################################################
#
# SetupCommand
#
#######################################################################

777
# This is a cache mapping from 'type name' to 'display alternatives'.
778
qqFormats = {}
779 780

# This is a cache of all known dumpers.
hjk's avatar
hjk committed
781
qqDumpers = {}
782

783 784 785
# This is a cache of all dumpers that support writing.
qqEditable = {}

786 787 788 789 790
# 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.

# This is a cache of typenames->bool saying whether we are QObject
# derived.
hjk's avatar
hjk committed
791
qqQObjectCache = {}
792

793
def bbsetup(args):
794 795 796 797 798
    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
799
            qqFormats[name] = qqFormats.get(name, "")
800 801 802 803 804 805 806 807
        elif key.startswith("qform__"):
            name = key[7:]
            formats = ""
            try:
                formats = value()
            except:
                pass
            qqFormats[name] = formats
808 809 810 811 812 813
        elif key.startswith("qedit__"):
            name = key[7:]
            try:
                qqEditable[name] = value
            except:
                pass
814
    result = "dumpers=["
815
    #qqNs = qtNamespace() # This is too early
816
    for key, value in qqFormats.items():
817 818 819 820
        if qqEditable.has_key(key):
            result += '{type="%s",formats="%s",editable="true"},' % (key, value)
        else:
            result += '{type="%s",formats="%s"},' % (key, value)
821 822
    result += ']'
    #result += ',namespace="%s"' % qqNs
823
    result += ',hasInferiorThreadList="%s"' % int(hasInferiorThreadList())
824 825
    return result

826 827
registerCommand("bbsetup", bbsetup)

828

829 830 831 832 833 834 835
#######################################################################
#
# Edit Command
#
#######################################################################

def bbedit(args):
836 837
    (type, expr, value) = args.split(",")
    type = base64.b16decode(type, True)
838
    ns = qtNamespace()
839 840
    if type.startswith(ns):
        type = type[len(ns):]
841
    type = type.replace("::", "__")
842 843 844 845 846 847
    pos = type.find('<')
    if pos != -1:
        type = type[0:pos]
    expr = base64.b16decode(expr, True)
    value = base64.b16decode(value, True)
    #warn("EDIT: %s %s %s %s: " % (pos, type, expr, value))
848 849 850
    if qqEditable.has_key(type):
        qqEditable[type](expr, value)

851
registerCommand("bbedit", bbedit)
852 853


hjk's avatar
hjk committed
854 855
#######################################################################
#
856
# Frame Command
hjk's avatar
hjk committed
857 858 859
#
#######################################################################

860
def bb(args):
hjk's avatar
hjk committed
861
    output = 'data=[' + "".join(Dumper(args).output) + '],typeinfo=['
862 863 864 865 866 867 868
    for typeName, typeInfo in typeInfoCache.iteritems():
        if not typeInfo.reported:
            output += '{name="' + base64.b64encode(typeName)
            output += '",size="' + str(typeInfo.size) + '"},'
            typeInfo.reported = True
    output += ']';
    return output
hjk's avatar
hjk committed
869

870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887
registerCommand("bb", bb)

def p1(args):
    import cProfile
    cProfile.run('bb("%s")' % args, "/tmp/bbprof")
    import pstats
    pstats.Stats('/tmp/bbprof').sort_stats('time').print_stats()
    return ""

registerCommand("p1", p1)

def p2(args):
    import timeit
    return timeit.repeat('bb("%s")' % args,
        'from __main__ import bb', number=10)

registerCommand("p2", p2)

hjk's avatar
hjk committed
888 889 890 891 892 893 894

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

895

hjk's avatar
hjk committed
896
class Dumper:
897
    def __init__(self, args):
hjk's avatar
hjk committed
898
        self.output = []
hjk's avatar
hjk committed
899 900
        self.currentIName = ""
        self.currentPrintsAddress = True
901 902
        self.currentChildType = ""
        self.currentChildNumChild = -1
hjk's avatar
hjk committed
903 904
        self.currentMaxNumChild = -1
        self.currentNumChild = -1
905 906 907 908 909
        self.currentValue = None
        self.currentValuePriority = -100
        self.currentValueEncoding = None
        self.currentType = None
        self.currentTypePriority = -100
910 911 912 913 914 915 916 917
        self.typeformats = {}
        self.formats = {}
        self.expandedINames = ""

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

918
        resultVarName = ""
919 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 945 946
        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
947
        self.partialUpdate = "partial" in options
948 949
        self.tooltipOnly = "tooltiponly" in options
        self.noLocals = "nolocals" in options
950
        self.ns = qtNamespace()
951 952 953 954

        #warn("NAMESPACE: '%s'" % self.ns)
        #warn("VARIABLES: %s" % varList)
        #warn("EXPANDED INAMES: %s" % self.expandedINames)
955
        #warn("WATCHERS: %s" % watchers)
956 957
        #warn("PARTIAL: %s" % self.partialUpdate)
        #warn("NO LOCALS: %s" % self.noLocals)
958 959 960 961 962
        module = sys.modules[__name__]

        #
        # Locals
        #
963
        locals = []
964
        fullUpdateNeeded = True
965
        if self.partialUpdate and len(varList) == 1 and not self.tooltipOnly:
966 967 968 969 970 971 972 973
            #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()
hjk's avatar
hjk committed
974 975 976
                item = LocalItem()
                item.iname = "local." + name
                item.name = name
977 978 979 980 981 982 983 984
                item.value = frame.read_var(name)
                locals = [item]
                #warn("PARTIAL LOCALS: %s" % locals)
                fullUpdateNeeded = False
            except:
                pass
            varList = []

985
        if fullUpdateNeeded and not self.tooltipOnly and not self.noLocals:
986
            locals = listOfLocals(varList)
987 988 989 990

        # Take care of the return value of the last function call.
        if len(resultVarName) > 0:
            try:
hjk's avatar
hjk committed
991 992 993 994 995
                item = LocalItem()
                item.name = resultVarName
                item.iname = "return." + resultVarName
                item.value = parseAndEvaluate(resultVarName)
                locals.append(item)
996 997 998 999 1000
            except:
                # Don't bother. It's only supplementary information anyway.
                pass

        for item in locals:
hjk's avatar
hjk committed
1001 1002 1003 1004 1005 1006 1007
            value = upcast(item.value)
            with OutputSafer(self, "", ""):
                self.anonNumber = -1

                type = value.type.unqualified()
                typeName = str(type)

1008
                # Special handling for char** argv.
1009
                if type.code == PointerCode \
hjk's avatar
hjk committed
1010 1011 1012 1013 1014 1015 1016 1017
                        and item.iname == "local.argv" \
                        and typeName == "char **":
                    n = 0
                    p = value
                    # p is 0 for "optimized out" cases. Or contains rubbish.
                    try:
                        if not isNull(p):
                            while not isNull(p.dereference()) and n <= 100:
1018
                                p += 1
hjk's avatar
hjk committed
1019 1020 1021
                                n += 1
                    except:
                        pass
1022

hjk's avatar
hjk committed
1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038
                    with TopLevelItem(self, item.iname):
                        self.put('iname="local.argv",name="argv",')
                        self.putItemCount(n, 100)
                        self.putType(typeName)
                        self.putNumChild(n)
                        if self.currentIName in self.expandedINames:
                            p = value
                            with Children(self, n):
                                for i in xrange(n):
                                    self.putSubItem(i, p.dereference())
                                    p += 1
                    continue

                else:
                    # A "normal" local variable or parameter.
                    with TopLevelItem(self, item.iname):
1039 1040
                        self.put('iname="%s",' % item.iname)
                        self.put('name="%s",' % item.name)
hjk's avatar
hjk committed
1041
                        self.putItem(value)
1042 1043 10