dumper.py 56.3 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():
hjk's avatar
hjk committed
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 150 151 152 153 154 155 156 157 158
            return type

    try:
        #warn("LOOKING UP '%s'" % ts)
        type = gdb.lookup_type(ts)
    except RuntimeError, error:
        #warn("LOOKING UP '%s': %s" % (ts, error))
        # 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)
159
        pass
160 161 162

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

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

174 175 176 177 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
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):
204 205 206 207 208 209
    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<...>"
210
        return lookupType(extractTemplateArgument(type.strip_typedefs(), position))
211

212

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

222

223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241
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
242
        self.d.output = []
243 244 245 246 247 248 249

    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
250 251
            self.savedOutput.extend(self.d.output)
            self.d.output = self.savedOutput
252 253 254
        return False


255 256 257 258 259
class NoAddress:
    def __init__(self, d):
        self.d = d

    def __enter__(self):
hjk's avatar
hjk committed
260 261
        self.savedPrintsAddress = self.d.currentPrintsAddress
        self.d.currentPrintsAddress = False
262 263

    def __exit__(self, exType, exValue, exTraceBack):
hjk's avatar
hjk committed
264
        self.d.currentPrintsAddress = self.savedPrintsAddress
265 266


267
class SubItem:
hjk's avatar
hjk committed
268
    def __init__(self, d, component):
269
        self.d = d
hjk's avatar
hjk committed
270 271
        self.iname = "%s.%s" % (d.currentIName, component)
        self.name = component
272 273 274

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

    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)
295
        try:
296
            #warn("TYPE VALUE: %s" % self.d.currentValue)
hjk's avatar
hjk committed
297 298 299 300 301 302 303 304
            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)
305
                    if not typeObj is None:
hjk's avatar
hjk committed
306 307 308 309 310 311
                        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)
312
                self.d.put('value="%s",' % self.d.currentValue)
313 314
        except:
            pass
315
        self.d.put('},')
hjk's avatar
hjk committed
316
        self.d.currentIName = self.savedIName
317 318 319 320 321 322 323
        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
324 325 326 327 328 329 330 331 332 333 334
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
335 336

class Children:
hjk's avatar
hjk committed
337 338
    def __init__(self, d, numChild = 1, childType = None, childNumChild = None,
            maxNumChild = None, addrBase = None, addrStep = None):
339 340 341
        self.d = d
        self.numChild = numChild
        self.childNumChild = childNumChild
hjk's avatar
hjk committed
342 343 344 345
        self.maxNumChild = maxNumChild
        self.addrBase = addrBase
        self.addrStep = addrStep
        self.printsAddress = True
346 347 348
        if childType is None:
            self.childType = None
        else:
hjk's avatar
hjk committed
349 350
            self.childType = stripClassTag(str(childType))
            self.d.put('childtype="%s",' % self.childType)
351 352 353 354 355 356 357 358 359 360
            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
361 362 363 364 365 366 367
        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)
368 369 370 371 372
        #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
373 374 375 376 377 378 379 380
        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
381 382 383 384 385
        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
386 387 388
        if not self.d.currentMaxNumChild is None:
            if self.d.currentMaxNumChild < self.d.currentNumChild:
                self.d.put('{name="<incomplete>",value="",type="",numchild="0"},')
389 390
        self.d.currentChildType = self.savedChildType
        self.d.currentChildNumChild = self.savedChildNumChild
hjk's avatar
hjk committed
391 392 393
        self.d.currentNumChild = self.savedNumChild
        self.d.currentMaxNumChild = self.savedMaxNumChild
        self.d.currentPrintsAddress = self.savedPrintsAddress
394 395 396 397
        self.d.put('],')
        return True


398
def value(expr):
399
    value = parseAndEvaluate(expr)
400 401 402 403 404
    try:
        return int(value)
    except:
        return str(value)

hjk's avatar
hjk committed
405
def isSimpleType(typeobj):
406
    code = typeobj.code
407 408 409 410 411
    return code == BoolCode \
        or code == CharCode \
        or code == IntCode \
        or code == FloatCode \
        or code == EnumCode
hjk's avatar
hjk committed
412 413

def warn(message):
414 415
    if True or verbosity > 0:
        print "XXX: %s\n" % message.encode("latin1")
hjk's avatar
hjk committed
416 417 418 419 420 421
    pass

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

422 423 424 425 426
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
427
#def couldBePointer(p, align):
428
#    type = lookupType("unsigned int")
hjk's avatar
hjk committed
429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447
#    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):
448 449 450 451
    # 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 ")
452 453 454 455 456 457
    #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
458 459

movableTypes = set([
hjk's avatar
hjk committed
460 461 462 463 464 465
    "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
466
    "QXmlStreamAttribute", "QXmlStreamNamespaceDeclaration",
hjk's avatar
hjk committed
467 468 469 470 471 472 473 474 475 476 477 478 479
    "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
480 481

def checkPointerRange(p, n):
482
    for i in xrange(n):
hjk's avatar
hjk committed
483 484 485
        checkPointer(p)
        ++p

hjk's avatar
hjk committed
486 487 488 489 490 491 492 493 494 495 496 497 498
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
499
    type = stripClassTag(str(value.type))
500
    if type.find(":") >= 0:
hjk's avatar
hjk committed
501
        type = "'" + type + "'"
502
    # 'class' is needed, see http://sourceware.org/bugzilla/show_bug.cgi?id=11912
hjk's avatar
hjk committed
503
    exp = "((class %s*)%s)->%s(%s)" % (type, value.address, func, arg)
hjk's avatar
hjk committed
504
    #warn("CALL: %s" % exp)
505 506 507 508 509
    result = None
    try:
        result = parseAndEvaluate(exp)
    except:
        pass
hjk's avatar
hjk committed
510 511 512
    #warn("  -> %s" % result)
    return result

hjk's avatar
hjk committed
513 514 515
def call(value, func, *args):
    return call2(value, func, args)

516 517 518 519
def makeValue(type, init):
    type = stripClassTag(type)
    if type.find(":") >= 0:
        type = "'" + type + "'"
520 521
    # Avoid malloc symbol clash with QVector
    gdb.execute("set $d = (%s*)calloc(sizeof(%s), 1)" % (type, type))
522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538
    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

539 540
qqNs = None

541
def qtNamespace():
542
    # FIXME: This only works when call from inside a Qt function frame.
543
    global qqNs
544 545
    if not qqNs is None:
        return qqNs
546
    try:
547
        str = catchCliOutput("ptype QString::Null")[0]
hjk's avatar
hjk committed
548
        # The result looks like:
549 550 551 552 553
        # "type = const struct myns::QString::Null {"
        # "    <no data fields>"
        # "}"
        pos1 = str.find("struct") + 7
        pos2 = str.find("QString::Null")
554 555 556 557
        if pos1 > -1 and pos2 > -1:
            qqNs = str[pos1:pos2]
            return qqNs
        return ""
558
    except:
559
        return ""
hjk's avatar
hjk committed
560

561 562 563 564 565 566 567 568 569 570 571 572 573 574 575
# --  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'
        qqMajorVersion = int(parseAndEvaluate(qtNamespace() + "qVersion()[0]")) - 48
        return qqMajorVersion
    except:
        return 0

576 577
def findFirstZero(p, maximum):
    for i in xrange(maximum):
578 579 580
        if p.dereference() == 0:
            return i
        p = p + 1
581
    return maximum + 1
582

583
def extractCharArray(p, maxsize):
584
    t = lookupType("unsigned char").pointer()
585
    p = p.cast(t)
586
    limit = findFirstZero(p, maxsize)
587 588 589 590
    s = ""
    for i in xrange(limit):
        s += "%c" % int(p.dereference())
        p += 1
591
    if i > maxsize:
592 593 594 595 596 597 598 599 600 601 602 603 604
        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
605
    return extractCharArray(data, min(100, size))
606

607
def encodeCharArray(p, maxsize, limit = -1):
608
    t = lookupType("unsigned char").pointer()
609
    p = p.cast(t)
610 611
    if limit == -1:
        limit = findFirstZero(p, maxsize)
612
    s = ""
613 614 615 616 617 618 619 620
    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
621
    if limit > maxsize:
622 623 624 625
        s += "2e2e2e"
    return s

def encodeChar2Array(p, maxsize):
626
    t = lookupType("unsigned short").pointer()
627
    p = p.cast(t)
628
    limit = findFirstZero(p, maxsize)
629 630 631 632 633 634 635 636 637
    s = ""
    for i in xrange(limit):
        s += "%04x" % int(p.dereference())
        p += 1
    if i == maxsize:
        s += "2e002e002e00"
    return s

def encodeChar4Array(p, maxsize):
638
    t = lookupType("unsigned int").pointer()
639
    p = p.cast(t)
640
    limit = findFirstZero(p, maxsize)
641 642 643 644
    s = ""
    for i in xrange(limit):
        s += "%08x" % int(p.dereference())
        p += 1
645
    if i > maxsize:
646
        s += "2e0000002e0000002e000000"
647 648
    return s

649 650 651 652 653 654 655 656 657 658 659 660
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']
661
        charPointerType = lookupType('char *')
hjk's avatar
hjk committed
662 663
        data = qByteArrayData['d'].cast(charPointerType) \
             + qByteArrayData['offset'] + charPointerType.sizeof
664 665
        return data, size, alloc

666
def encodeByteArray(value):
667
    data, size, alloc = qByteArrayData(value)
668 669 670 671
    check(0 <= size and size <= alloc and alloc <= 100*1000*1000)
    if size > 0:
        checkAccess(data, 4)
        checkAccess(data + size) == 0
672
    return encodeCharArray(data, 100, size)
673

674 675 676 677 678 679 680
def qQStringData(value):
    if qtMajorVersion() < 5:
        d_ptr = value['d'].dereference()
        checkRef(d_ptr['ref'])
        return d_ptr['data'], d_ptr['size'], d_ptr['alloc']
    else: # Qt5: Implement the QStringArrayData::data() accessor.
        qStringData = value['d'].dereference()
681 682
        ushortPointerType = lookupType('ushort *')
        data = qStringData['d'].cast(ushortPointerType) + ushortPointerType.sizeof / 2 + qStringData['offset']
683 684
        return data, qStringData['size'], qStringData['alloc']

685
def encodeString(value):
686 687
    data, size, alloc = qQStringData(value)

688 689 690
    check(0 <= size and size <= alloc and alloc <= 100*1000*1000)
    if size > 0:
        checkAccess(data, 4)
hjk's avatar
hjk committed
691
        checkAccess(data + size) == 0
692
    s = ""
693
    limit = min(size, 1000)
694 695 696
    try:
        # gdb.Inferior is new in gdb 7.2
        inferior = gdb.inferiors()[0]
697
        s = binascii.hexlify(inferior.read_memory(data, 2 * limit))
698
    except:
699
        p = data
700
        for i in xrange(limit):
701 702 703 704
            val = int(p.dereference())
            s += "%02x" % (val % 256)
            s += "%02x" % (val / 256)
            p += 1
705 706
    if limit < size:
        s += "2e002e002e00"
707 708
    return s

hjk's avatar
hjk committed
709 710
def stripTypedefs(type):
    type = type.unqualified()
hjk's avatar
hjk committed
711
    while type.code == TypedefCode:
712 713 714
        type = type.strip_typedefs().unqualified()
    return type

hjk's avatar
hjk committed
715 716
def extractFields(type):
    # Insufficient, see http://sourceware.org/bugzilla/show_bug.cgi?id=10953:
hjk's avatar
hjk committed
717
    #fields = type.fields()
hjk's avatar
hjk committed
718
    # Insufficient, see http://sourceware.org/bugzilla/show_bug.cgi?id=11777:
hjk's avatar
hjk committed
719
    #fields = defsype).fields()
hjk's avatar
hjk committed
720
    # This seems to work.
hjk's avatar
hjk committed
721
    #warn("TYPE 0: %s" % type)
hjk's avatar
hjk committed
722
    type = stripTypedefs(type)
723 724 725
    fields = type.fields()
    if len(fields):
        return fields
hjk's avatar
hjk committed
726
    #warn("TYPE 1: %s" % type)
727
    # This fails for arrays. See comment in lookupType.
728 729 730
    type0 = lookupType(str(type))
    if not type0 is None:
        type = type0
hjk's avatar
hjk committed
731
    if type.code == FunctionCode:
732
        return []
hjk's avatar
hjk committed
733 734
    #warn("TYPE 2: %s" % type)
    fields = type.fields()
hjk's avatar
hjk committed
735
    #warn("FIELDS: %s" % fields)
hjk's avatar
hjk committed
736 737
    return fields

hjk's avatar
hjk committed
738 739
#######################################################################
#
740
# LocalItem
hjk's avatar
hjk committed
741 742 743
#
#######################################################################

744
# Contains iname, name, and value.
hjk's avatar
hjk committed
745
class LocalItem:
746
    pass
hjk's avatar
hjk committed
747

748 749 750 751 752 753
#######################################################################
#
# SetupCommand
#
#######################################################################

754
# This is a cache mapping from 'type name' to 'display alternatives'.
755
qqFormats = {}
756 757

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

760 761 762
# This is a cache of all dumpers that support writing.
qqEditable = {}

763 764 765 766 767
# 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
768
qqQObjectCache = {}
769

770
def bbsetup(args):
771 772 773 774 775
    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
776
            qqFormats[name] = qqFormats.get(name, "")
777 778 779 780 781 782 783 784
        elif key.startswith("qform__"):
            name = key[7:]
            formats = ""
            try:
                formats = value()
            except:
                pass
            qqFormats[name] = formats
785 786 787 788 789 790
        elif key.startswith("qedit__"):
            name = key[7:]
            try:
                qqEditable[name] = value
            except:
                pass
791
    result = "dumpers=["
792
    #qqNs = qtNamespace() # This is too early
793
    for key, value in qqFormats.items():
794 795 796 797
        if qqEditable.has_key(key):
            result += '{type="%s",formats="%s",editable="true"},' % (key, value)
        else:
            result += '{type="%s",formats="%s"},' % (key, value)
798 799
    result += ']'
    #result += ',namespace="%s"' % qqNs
800
    result += ',hasInferiorThreadList="%s"' % int(hasInferiorThreadList())
801 802
    return result

803 804
registerCommand("bbsetup", bbsetup)

805

806 807 808 809 810 811 812
#######################################################################
#
# Edit Command
#
#######################################################################

def bbedit(args):
813 814
    (type, expr, value) = args.split(",")
    type = base64.b16decode(type, True)
815
    ns = qtNamespace()
816 817
    if type.startswith(ns):
        type = type[len(ns):]
818
    type = type.replace("::", "__")
819 820 821 822 823 824
    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))
825 826 827
    if qqEditable.has_key(type):
        qqEditable[type](expr, value)

828
registerCommand("bbedit", bbedit)
829 830


hjk's avatar
hjk committed
831 832
#######################################################################
#
833
# Frame Command
hjk's avatar
hjk committed
834 835 836
#
#######################################################################

837
def bb(args):
hjk's avatar
hjk committed
838
    output = 'data=[' + "".join(Dumper(args).output) + '],typeinfo=['
839 840 841 842 843 844 845
    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
846

847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864
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
865 866 867 868 869 870 871

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

872

hjk's avatar
hjk committed
873
class Dumper:
874
    def __init__(self, args):
hjk's avatar
hjk committed
875
        self.output = []
hjk's avatar
hjk committed
876 877
        self.currentIName = ""
        self.currentPrintsAddress = True
878 879
        self.currentChildType = ""
        self.currentChildNumChild = -1
hjk's avatar
hjk committed
880 881
        self.currentMaxNumChild = -1
        self.currentNumChild = -1
882 883 884 885 886
        self.currentValue = None
        self.currentValuePriority = -100
        self.currentValueEncoding = None
        self.currentType = None
        self.currentTypePriority = -100
887 888 889 890 891 892 893 894
        self.typeformats = {}
        self.formats = {}
        self.expandedINames = ""

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

895
        resultVarName = ""
896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923
        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
924
        self.partialUpdate = "partial" in options
925 926
        self.tooltipOnly = "tooltiponly" in options
        self.noLocals = "nolocals" in options
927
        self.ns = qtNamespace()
928 929 930 931

        #warn("NAMESPACE: '%s'" % self.ns)
        #warn("VARIABLES: %s" % varList)
        #warn("EXPANDED INAMES: %s" % self.expandedINames)
932
        #warn("WATCHERS: %s" % watchers)
933 934
        #warn("PARTIAL: %s" % self.partialUpdate)
        #warn("NO LOCALS: %s" % self.noLocals)
935 936 937 938 939
        module = sys.modules[__name__]

        #
        # Locals
        #
940
        locals = []
941
        fullUpdateNeeded = True
942
        if self.partialUpdate and len(varList) == 1 and not self.tooltipOnly:
943 944 945 946 947 948 949 950
            #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
951 952 953
                item = LocalItem()
                item.iname = "local." + name
                item.name = name
954 955 956 957 958 959 960 961
                item.value = frame.read_var(name)
                locals = [item]
                #warn("PARTIAL LOCALS: %s" % locals)
                fullUpdateNeeded = False
            except:
                pass
            varList = []

962
        if fullUpdateNeeded and not self.tooltipOnly and not self.noLocals:
963
            locals = listOfLocals(varList)
964 965 966 967

        # Take care of the return value of the last function call.
        if len(resultVarName) > 0:
            try:
hjk's avatar
hjk committed
968 969 970 971 972
                item = LocalItem()
                item.name = resultVarName
                item.iname = "return." + resultVarName
                item.value = parseAndEvaluate(resultVarName)
                locals.append(item)
973 974 975 976 977
            except:
                # Don't bother. It's only supplementary information anyway.
                pass

        for item in locals:
hjk's avatar
hjk committed
978 979 980 981 982 983 984
            value = upcast(item.value)
            with OutputSafer(self, "", ""):
                self.anonNumber = -1

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

985
                # Special handling for char** argv.
986
                if type.code == PointerCode \
hjk's avatar
hjk committed
987 988 989 990 991 992 993 994
                        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:
995
                                p += 1
hjk's avatar
hjk committed
996 997 998
                                n += 1
                    except:
                        pass
999

hjk's avatar
hjk committed
1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015
                    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):
1016 1017
                        self.put('iname="%s",' % item.iname)
                        self.put('name="%s",' % item.name)
hjk's avatar
hjk committed
1018
                        self.putItem(value)
1019 1020 1021 1022 1023 1024 1025 1026

        #
        # Watchers
        #
        with OutputSafer(self, ",", ""):
            if len(watchers) > 0:
                for watcher in watchers.split("##"):
                    (exp, iname) = watcher.split("#")
1027
                    self.handleWatch(exp, iname)
1028

1029
        #print('data=[' + locals + sep + watchers + ']\n')
1030

hjk's avatar
hjk committed
1031 1032 1033 1034 1035 1036 1037 1038
    def checkForQObjectBase(self, type):
        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()
hjk's avatar
hjk committed
1039
        #fields = extractFields(type)
hjk's avatar
hjk committed
1040 1041 1042 1043
        if len(fields) == 0:
            qqQObjectCache[name] = False
            return False
        base = fields[0].type.strip_typedefs()
hjk's avatar
hjk committed
1044 1045
        if base.code != StructCode:
            return False
1046 1047 1048
        # Prevent infinite recursion in Qt 3.3.8
        if str(base) == name:
            return False
hjk's avatar
hjk committed
1049 1050 1051 1052
        result = self.checkForQObjectBase(base)
        qqQObjectCache[name] = result
        return result