dumper.py 59.5 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 99 100 101 102 103
def dynamicTypeName(value):
    #vtbl = str(parseAndEvaluate("{int(*)(int)}%s" % long(value.address)))
    vtbl = gdb.execute("info symbol {int*}%s" % long(value.address),
        to_string = True)
    pos1 = vtbl.find("vtable ")
    if pos1 != -1:
        pos1 += 11
        pos2 = vtbl.find(" +", pos1)
        if pos2 != -1:
            return vtbl[pos1 : pos2]
    return str(value.type)

104 105
def upcast(value):
    try:
106 107 108 109 110 111 112 113 114 115 116 117
        return value.cast(value.dynamic_type)
    except:
        pass
    #try:
    #    return value.cast(lookupType(dynamicTypeName(value)))
    #except:
    #    pass
    return value

def expensiveUpcast(value):
    try:
        return value.cast(value.dynamic_type)
118
    except:
119 120 121 122 123 124
        pass
    try:
        return value.cast(lookupType(dynamicTypeName(value)))
    except:
        pass
    return value
125

126 127
typeCache = {}

128 129 130 131 132 133 134
class TypeInfo:
    def __init__(self, type):
        self.size = type.sizeof
        self.reported = False

typeInfoCache = {}

135 136
def lookupType(typestring):
    type = typeCache.get(typestring)
hjk's avatar
hjk committed
137
    #warn("LOOKUP 1: %s -> %s" % (typestring, type))
138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166
    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
167 168 169
        if not type is None:
            type = type.pointer()
            typeCache[typestring] = type
170 171 172 173 174 175 176
            return type

    try:
        #warn("LOOKING UP '%s'" % ts)
        type = gdb.lookup_type(ts)
    except RuntimeError, error:
        #warn("LOOKING UP '%s': %s" % (ts, error))
177 178 179 180 181
        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)"))
182 183 184 185 186 187 188 189 190
        # 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)
191
        pass
192 193 194

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

197
def cleanAddress(addr):
198 199
    if addr is None:
        return "<no address>"
200 201
    # We cannot use str(addr) as it yields rubbish for char pointers
    # that might trigger Unicode encoding errors.
202
    #return addr.cast(lookupType("void").pointer())
203 204
    # We do not use "hex(...)" as it (sometimes?) adds a "L" suffix.
    return "0x%x" % long(addr)
205

206 207 208 209 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
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):
236 237 238 239 240 241
    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<...>"
242
        return lookupType(extractTemplateArgument(type.strip_typedefs(), position))
243

244

hjk's avatar
hjk committed
245 246 247 248
# Workaround for gdb < 7.1
def numericTemplateArgument(type, position):
    try:
        return int(type.template_argument(position))
249
    except RuntimeError, error:
hjk's avatar
hjk committed
250 251 252 253
        # ": No type named 30."
        msg = str(error)
        return int(msg[14:-1])

254

255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273
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
274
        self.d.output = []
275 276 277 278 279 280 281

    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
282 283
            self.savedOutput.extend(self.d.output)
            self.d.output = self.savedOutput
284 285 286
        return False


287 288 289 290 291
class NoAddress:
    def __init__(self, d):
        self.d = d

    def __enter__(self):
hjk's avatar
hjk committed
292 293
        self.savedPrintsAddress = self.d.currentPrintsAddress
        self.d.currentPrintsAddress = False
294 295

    def __exit__(self, exType, exValue, exTraceBack):
hjk's avatar
hjk committed
296
        self.d.currentPrintsAddress = self.savedPrintsAddress
297 298


299
class SubItem:
hjk's avatar
hjk committed
300
    def __init__(self, d, component):
301
        self.d = d
hjk's avatar
hjk committed
302 303
        self.iname = "%s.%s" % (d.currentIName, component)
        self.name = component
304 305 306

    def __enter__(self):
        self.d.put('{')
hjk's avatar
hjk committed
307 308 309 310
        #if not self.name is None:
        if isinstance(self.name, str):
            self.d.put('name="%s",' % self.name)
        self.savedIName = self.d.currentIName
311 312 313 314 315
        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
316
        self.d.currentIName = self.iname
317
        self.d.currentValuePriority = -100
318 319
        self.d.currentValueEncoding = None
        self.d.currentType = ""
320
        self.d.currentTypePriority = -100
321 322 323 324 325 326

    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)
327
        try:
328
            #warn("TYPE VALUE: %s" % self.d.currentValue)
hjk's avatar
hjk committed
329 330 331 332 333 334 335 336
            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)
337
                    if not typeObj is None:
hjk's avatar
hjk committed
338 339 340 341 342 343
                        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)
344
                self.d.put('value="%s",' % self.d.currentValue)
345 346
        except:
            pass
347
        self.d.put('},')
hjk's avatar
hjk committed
348
        self.d.currentIName = self.savedIName
349 350 351 352 353 354 355
        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
356 357 358 359 360 361 362 363 364 365 366
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
367 368

class Children:
hjk's avatar
hjk committed
369 370
    def __init__(self, d, numChild = 1, childType = None, childNumChild = None,
            maxNumChild = None, addrBase = None, addrStep = None):
371 372 373
        self.d = d
        self.numChild = numChild
        self.childNumChild = childNumChild
hjk's avatar
hjk committed
374 375 376 377
        self.maxNumChild = maxNumChild
        self.addrBase = addrBase
        self.addrStep = addrStep
        self.printsAddress = True
378 379 380
        if childType is None:
            self.childType = None
        else:
hjk's avatar
hjk committed
381 382
            self.childType = stripClassTag(str(childType))
            self.d.put('childtype="%s",' % self.childType)
383 384 385 386 387 388 389 390 391 392
            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
393 394 395 396 397 398 399
        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)
400 401 402 403 404
        #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
405 406 407 408 409 410 411 412
        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
413 414 415 416 417
        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
418 419 420
        if not self.d.currentMaxNumChild is None:
            if self.d.currentMaxNumChild < self.d.currentNumChild:
                self.d.put('{name="<incomplete>",value="",type="",numchild="0"},')
421 422
        self.d.currentChildType = self.savedChildType
        self.d.currentChildNumChild = self.savedChildNumChild
hjk's avatar
hjk committed
423 424 425
        self.d.currentNumChild = self.savedNumChild
        self.d.currentMaxNumChild = self.savedMaxNumChild
        self.d.currentPrintsAddress = self.savedPrintsAddress
426 427 428 429
        self.d.put('],')
        return True


430
def value(expr):
431
    value = parseAndEvaluate(expr)
432 433 434 435 436
    try:
        return int(value)
    except:
        return str(value)

hjk's avatar
hjk committed
437
def isSimpleType(typeobj):
438
    code = typeobj.code
439 440 441 442 443
    return code == BoolCode \
        or code == CharCode \
        or code == IntCode \
        or code == FloatCode \
        or code == EnumCode
hjk's avatar
hjk committed
444 445

def warn(message):
446 447
    if True or verbosity > 0:
        print "XXX: %s\n" % message.encode("latin1")
hjk's avatar
hjk committed
448 449 450 451 452 453
    pass

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

454
def checkRef(ref):
455 456 457 458 459
    count = 0
    if qtMajorVersion() >= 5:
        count = ref["atomic"]["_q_value"]
    else:
        count = ref["_q_value"]
460 461 462
    check(count > 0)
    check(count < 1000000) # assume there aren't a million references to any object

hjk's avatar
hjk committed
463
#def couldBePointer(p, align):
464
#    type = lookupType("unsigned int")
hjk's avatar
hjk committed
465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481
#    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()

482 483 484 485 486 487
def isAccessible(p):
    try:
        long(p)
        return True
    except:
        return False
hjk's avatar
hjk committed
488 489

def isNull(p):
490 491 492 493
    # 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 ")
494 495 496 497 498
    #try:
    #    # Can fail with: "RuntimeError: Cannot access memory at address 0x5"
    #    return p.cast(lookupType("void").pointer()) == 0
    #except:
    #    return False
499 500 501 502 503
    try:
        # Can fail with: "RuntimeError: Cannot access memory at address 0x5"
        return long(p) == 0
    except:
        return False
hjk's avatar
hjk committed
504 505

movableTypes = set([
hjk's avatar
hjk committed
506 507 508 509 510 511
    "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
512
    "QXmlStreamAttribute", "QXmlStreamNamespaceDeclaration",
hjk's avatar
hjk committed
513 514 515 516 517 518 519 520 521 522 523 524 525
    "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
526 527

def checkPointerRange(p, n):
528
    for i in xrange(n):
hjk's avatar
hjk committed
529 530 531
        checkPointer(p)
        ++p

hjk's avatar
hjk committed
532 533 534 535 536 537 538 539 540 541 542 543 544
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
545
    type = stripClassTag(str(value.type))
546
    if type.find(":") >= 0:
hjk's avatar
hjk committed
547
        type = "'" + type + "'"
548
    # 'class' is needed, see http://sourceware.org/bugzilla/show_bug.cgi?id=11912
hjk's avatar
hjk committed
549
    exp = "((class %s*)%s)->%s(%s)" % (type, value.address, func, arg)
hjk's avatar
hjk committed
550
    #warn("CALL: %s" % exp)
551 552 553 554 555
    result = None
    try:
        result = parseAndEvaluate(exp)
    except:
        pass
hjk's avatar
hjk committed
556 557 558
    #warn("  -> %s" % result)
    return result

hjk's avatar
hjk committed
559 560 561
def call(value, func, *args):
    return call2(value, func, args)

562 563 564 565
def makeValue(type, init):
    type = stripClassTag(type)
    if type.find(":") >= 0:
        type = "'" + type + "'"
hjk's avatar
hjk committed
566
    # Avoid malloc symbol clash with QVector.
567
    gdb.execute("set $d = (%s*)calloc(sizeof(%s), 1)" % (type, type))
568 569 570 571 572 573 574
    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

575 576 577 578 579 580 581 582 583 584 585 586
def makeStdString(init):
    # Works only for small allocators, but they are usually empty.
    gdb.execute("set $d=(std::string*)calloc(sizeof(std::string), 2)");
    gdb.execute("call($d->basic_string(\"" + init +
        "\",*(std::allocator<char>*)(1+$d)))")
    value = parseAndEvaluate("$d").dereference()
    #warn("  TYPE: %s" % value.type)
    #warn("  ADDR: %s" % value.address)
    #warn("  VALUE: %s" % value)
    return value


587 588 589 590 591 592 593 594 595 596
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

597 598
qqNs = None

599
def qtNamespace():
600
    # FIXME: This only works when call from inside a Qt function frame.
601
    global qqNs
602 603
    if not qqNs is None:
        return qqNs
604
    try:
605
        str = catchCliOutput("ptype QString::Null")[0]
hjk's avatar
hjk committed
606
        # The result looks like:
607 608 609 610 611
        # "type = const struct myns::QString::Null {"
        # "    <no data fields>"
        # "}"
        pos1 = str.find("struct") + 7
        pos2 = str.find("QString::Null")
612 613 614 615
        if pos1 > -1 and pos2 > -1:
            qqNs = str[pos1:pos2]
            return qqNs
        return ""
616
    except:
617
        return ""
hjk's avatar
hjk committed
618

619 620 621 622 623 624 625 626 627 628
# --  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'
629 630 631 632 633
        v = int(parseAndEvaluate("*(char*)qVersion()"))
        if v >= 51:
            qqMajorVersion = v - 48
            return qqMajorVersion
        return 0
634 635 636
    except:
        return 0

637 638
def findFirstZero(p, maximum):
    for i in xrange(maximum):
639 640 641
        if p.dereference() == 0:
            return i
        p = p + 1
642
    return maximum + 1
643

644
def extractCharArray(p, maxsize):
645
    p = p.cast(lookupType("unsigned char").pointer())
646
    s = ""
647 648 649 650 651 652
    i = 0
    while i < maxsize:
        c = int(p.dereference())
        if c == 0:
            return s
        s += "%c" % c
653
        p += 1
654
        i += 1
655 656 657
    if p.dereference() != 0:
        s += "..."
    return s
658 659 660 661 662 663 664 665 666 667 668

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
669
    return extractCharArray(data, min(100, size))
670

671
def encodeCharArray(p, maxsize, limit = -1):
672
    t = lookupType("unsigned char").pointer()
673
    p = p.cast(t)
674 675
    if limit == -1:
        limit = findFirstZero(p, maxsize)
676
    s = ""
677 678 679 680 681 682 683 684
    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
685
    if limit > maxsize:
686 687 688 689
        s += "2e2e2e"
    return s

def encodeChar2Array(p, maxsize):
690
    t = lookupType("unsigned short").pointer()
691
    p = p.cast(t)
692
    limit = findFirstZero(p, maxsize)
693 694 695 696 697 698 699 700 701
    s = ""
    for i in xrange(limit):
        s += "%04x" % int(p.dereference())
        p += 1
    if i == maxsize:
        s += "2e002e002e00"
    return s

def encodeChar4Array(p, maxsize):
702
    t = lookupType("unsigned int").pointer()
703
    p = p.cast(t)
704
    limit = findFirstZero(p, maxsize)
705 706 707 708
    s = ""
    for i in xrange(limit):
        s += "%08x" % int(p.dereference())
        p += 1
709
    if i > maxsize:
710
        s += "2e0000002e0000002e000000"
711 712
    return s

713 714 715 716 717 718 719 720 721 722 723 724
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']
725
        charPointerType = lookupType('char *')
hjk's avatar
hjk committed
726 727
        data = qByteArrayData['d'].cast(charPointerType) \
             + qByteArrayData['offset'] + charPointerType.sizeof
728 729
        return data, size, alloc

730
def encodeByteArray(value):
731
    data, size, alloc = qByteArrayData(value)
732 733 734 735
    check(0 <= size and size <= alloc and alloc <= 100*1000*1000)
    if size > 0:
        checkAccess(data, 4)
        checkAccess(data + size) == 0
736
    return encodeCharArray(data, 100, size)
737

738 739 740 741
def qQStringData(value):
    if qtMajorVersion() < 5:
        d_ptr = value['d'].dereference()
        checkRef(d_ptr['ref'])
hjk's avatar
hjk committed
742
        return d_ptr['data'], int(d_ptr['size']), int(d_ptr['alloc'])
743 744
    else: # Qt5: Implement the QStringArrayData::data() accessor.
        qStringData = value['d'].dereference()
745
        ushortPointerType = lookupType('ushort *')
hjk's avatar
hjk committed
746 747 748
        data = qStringData['d'].cast(ushortPointerType) \
            + ushortPointerType.sizeof / 2 + qStringData['offset']
        return data, int(qStringData['size']), int(qStringData['alloc'])
749

750
def encodeString(value):
751 752
    data, size, alloc = qQStringData(value)

753 754 755
    check(0 <= size and size <= alloc and alloc <= 100*1000*1000)
    if size > 0:
        checkAccess(data, 4)
hjk's avatar
hjk committed
756
        checkAccess(data + size) == 0
757
    s = ""
758
    limit = min(size, 1000)
759 760 761
    try:
        # gdb.Inferior is new in gdb 7.2
        inferior = gdb.inferiors()[0]
762
        s = binascii.hexlify(inferior.read_memory(data, 2 * limit))
763
    except:
764
        p = data
765
        for i in xrange(limit):
766 767 768 769
            val = int(p.dereference())
            s += "%02x" % (val % 256)
            s += "%02x" % (val / 256)
            p += 1
770 771
    if limit < size:
        s += "2e002e002e00"
772 773
    return s

hjk's avatar
hjk committed
774 775
def stripTypedefs(type):
    type = type.unqualified()
hjk's avatar
hjk committed
776
    while type.code == TypedefCode:
777 778 779
        type = type.strip_typedefs().unqualified()
    return type

hjk's avatar
hjk committed
780 781
def extractFields(type):
    # Insufficient, see http://sourceware.org/bugzilla/show_bug.cgi?id=10953:
hjk's avatar
hjk committed
782
    #fields = type.fields()
hjk's avatar
hjk committed
783
    # Insufficient, see http://sourceware.org/bugzilla/show_bug.cgi?id=11777:
hjk's avatar
hjk committed
784
    #fields = defsype).fields()
hjk's avatar
hjk committed
785
    # This seems to work.
hjk's avatar
hjk committed
786
    #warn("TYPE 0: %s" % type)
hjk's avatar
hjk committed
787
    type = stripTypedefs(type)
788 789 790
    fields = type.fields()
    if len(fields):
        return fields
hjk's avatar
hjk committed
791
    #warn("TYPE 1: %s" % type)
792
    # This fails for arrays. See comment in lookupType.
793 794 795
    type0 = lookupType(str(type))
    if not type0 is None:
        type = type0
hjk's avatar
hjk committed
796
    if type.code == FunctionCode:
797
        return []
hjk's avatar
hjk committed
798 799
    #warn("TYPE 2: %s" % type)
    fields = type.fields()
hjk's avatar
hjk committed
800
    #warn("FIELDS: %s" % fields)
hjk's avatar
hjk committed
801 802
    return fields

hjk's avatar
hjk committed
803 804
#######################################################################
#
805
# LocalItem
hjk's avatar
hjk committed
806 807 808
#
#######################################################################

809
# Contains iname, name, and value.
hjk's avatar
hjk committed
810
class LocalItem:
811
    pass
hjk's avatar
hjk committed
812

813 814 815 816 817 818
#######################################################################
#
# SetupCommand
#
#######################################################################

819
# This is a cache mapping from 'type name' to 'display alternatives'.
820
qqFormats = {}
821 822

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

825 826 827
# This is a cache of all dumpers that support writing.
qqEditable = {}

828 829 830 831 832
# 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
833
qqQObjectCache = {}
834

835
def bbsetup(args):
836 837 838 839 840
    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
841
            qqFormats[name] = qqFormats.get(name, "")
842 843 844 845 846 847 848 849
        elif key.startswith("qform__"):
            name = key[7:]
            formats = ""
            try:
                formats = value()
            except:
                pass
            qqFormats[name] = formats
850 851 852 853 854 855
        elif key.startswith("qedit__"):
            name = key[7:]
            try:
                qqEditable[name] = value
            except:
                pass
856
    result = "dumpers=["
857
    #qqNs = qtNamespace() # This is too early
858
    for key, value in qqFormats.items():
859 860 861 862
        if qqEditable.has_key(key):
            result += '{type="%s",formats="%s",editable="true"},' % (key, value)
        else:
            result += '{type="%s",formats="%s"},' % (key, value)
863 864
    result += ']'
    #result += ',namespace="%s"' % qqNs
865
    result += ',hasInferiorThreadList="%s"' % int(hasInferiorThreadList())
866 867
    return result

868 869
registerCommand("bbsetup", bbsetup)

870

871 872 873 874 875 876 877
#######################################################################
#
# Edit Command
#
#######################################################################

def bbedit(args):
878 879
    (type, expr, value) = args.split(",")
    type = base64.b16decode(type, True)
880
    ns = qtNamespace()
881 882
    if type.startswith(ns):
        type = type[len(ns):]
883
    type = type.replace("::", "__")
884 885 886 887 888 889
    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))
890 891 892
    if qqEditable.has_key(type):
        qqEditable[type](expr, value)

893
registerCommand("bbedit", bbedit)
894 895


hjk's avatar
hjk committed
896 897
#######################################################################
#
898
# Frame Command
hjk's avatar
hjk committed
899 900 901
#
#######################################################################

902
def bb(args):
hjk's avatar
hjk committed
903
    output = 'data=[' + "".join(Dumper(args).output) + '],typeinfo=['
904 905 906 907 908 909 910
    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
911

912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929
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
930 931 932 933 934 935 936

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

937

hjk's avatar
hjk committed
938
class Dumper:
939
    def __init__(self, args):
hjk's avatar
hjk committed
940
        self.output = []
hjk's avatar
hjk committed
941 942
        self.currentIName = ""
        self.currentPrintsAddress = True
943 944
        self.currentChildType = ""
        self.currentChildNumChild = -1
hjk's avatar
hjk committed
945 946
        self.currentMaxNumChild = -1
        self.currentNumChild = -1
947 948 949 950 951
        self.currentValue = None
        self.currentValuePriority = -100
        self.currentValueEncoding = None
        self.currentType = None
        self.currentTypePriority = -100
952 953 954 955 956 957 958 959
        self.typeformats = {}
        self.formats = {}
        self.expandedINames = ""

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

960
        resultVarName = ""
961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985
        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)

986
        self.useDynamicType = "dyntype" in options
987 988 989
        self.useFancy = "fancy" in options
        self.passExceptions = "pe" in options
        self.autoDerefPointers = "autoderef" in options
990
        self.partialUpdate = "partial" in options
991 992
        self.tooltipOnly = "tooltiponly" in options
        self.noLocals = "nolocals" in options
993
        self.ns = qtNamespace()
994 995 996 997

        #warn("NAMESPACE: '%s'" % self.ns)
        #warn("VARIABLES: %s" % varList)
        #warn("EXPANDED INAMES: %s" % self.expandedINames)
998
        #warn("WATCHERS: %s" % watchers)
999 1000
        #warn("PARTIAL: %s" % self.partialUpdate)
        #warn("NO LOCALS: %s" % self.noLocals)
1001 1002 1003 1004 1005
        module = sys.modules[__name__]

        #
        # Locals
        #
1006
        locals = []
1007
        fullUpdateNeeded = True
1008
        if self.partialUpdate and len(varList) == 1 and not self.tooltipOnly:
1009 1010 1011 1012 1013 1014 1015 1016
            #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
1017 1018 1019
                item = LocalItem()
                item.iname = "local." + name
                item.name = name
1020 1021 1022 1023 1024 1025 1026 1027
                item.value = frame.read_var(name)
                locals = [item]
                #warn("PARTIAL LOCALS: %s" % locals)
                fullUpdateNeeded = False
            except:
                pass
            varList = []

1028
        if fullUpdateNeeded and not self.tooltipOnly and not self.noLocals:
1029
            locals = listOfLocals(varList)
1030 1031 1032 1033

        # Take care of the return value of the last function call.
        if len(resultVarName) > 0:
            try:
hjk's avatar
hjk committed
1034 1035 1036 1037 1038
                item = LocalItem()
                item.name = resultVarName
                item.iname = "return." + resultVarName
                item.value = parseAndEvaluate(resultVarName)
                locals.append(item)
1039 1040 1041 1042 1043
            except:
                # Don't bother. It's only supplementary information anyway.
                pass

        for item in locals:
hjk's avatar
hjk committed
1044 1045 1046 1047 1048