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

import sys
4
import base64
5
import __builtin__
6
import os
hjk's avatar
hjk committed
7
import tempfile
8

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

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

33 34
except:
    def createTempFile():
35 36
        global tempFileCounter
        tempFileCounter += 1
37
        fileName = "%s/py_tmp_%d_%d" \
hjk's avatar
hjk committed
38
            % (tempfile.gettempdir(), os.getpid(), tempFileCounter)
39
        return fileName, None
40

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

47 48 49 50 51
try:
    import binascii
except:
    pass

hjk's avatar
hjk committed
52 53 54
verbosity = 0
verbosity = 1

55 56 57 58
# Some "Enums"

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

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


82
def hasInferiorThreadList():
hjk's avatar
hjk committed
83
    return False
84
    try:
85
        a = gdb.inferiors()[0].threads()
86 87 88 89
        return True
    except:
        return False

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

97 98
typeCache = {}

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

typeInfoCache = {}

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

163
def cleanAddress(addr):
164 165
    if addr is None:
        return "<no address>"
166 167
    # We cannot use str(addr) as it yields rubbish for char pointers
    # that might trigger Unicode encoding errors.
168 169
    #return addr.cast(lookupType("void").pointer())
    return hex(long(addr))
170

171 172 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
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):
201 202 203 204 205 206
    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<...>"
207
        return lookupType(extractTemplateArgument(type.strip_typedefs(), position))
208

209

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

219

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

    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
247 248
            self.savedOutput.extend(self.d.output)
            self.d.output = self.savedOutput
249 250 251
        return False


252 253 254 255 256 257 258 259 260 261 262 263
class NoAddress:
    def __init__(self, d):
        self.d = d

    def __enter__(self):
        self.savedPrintsAddress = self.d.printsAddress
        self.d.printsAddress = False

    def __exit__(self, exType, exValue, exTraceBack):
        self.d.printsAddress = self.savedPrintsAddress


264 265 266 267 268 269 270 271 272 273 274
class SubItem:
    def __init__(self, d):
        self.d = d

    def __enter__(self):
        self.d.put('{')
        self.savedValue = self.d.currentValue
        self.savedValuePriority = self.d.currentValuePriority
        self.savedValueEncoding = self.d.currentValueEncoding
        self.savedType = self.d.currentType
        self.savedTypePriority = self.d.currentTypePriority
hjk's avatar
hjk committed
275
        self.d.currentValue = "<not accessible>"
276
        self.d.currentValuePriority = -100
277 278
        self.d.currentValueEncoding = None
        self.d.currentType = ""
279
        self.d.currentTypePriority = -100
280 281 282 283 284 285

    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)
286
        try:
287
            #warn("TYPE VALUE: %s" % self.d.currentValue)
288 289
            type = stripClassTag(str(self.d.currentType))
            #warn("TYPE: '%s'  DEFAULT: '%s'" % (type, self.d.currentChildType))
290

291 292
            if len(type) > 0 and type != self.d.currentChildType:
                self.d.put('type="%s",' % type) # str(type.unqualified()) ?
293 294 295 296
                if not type in typeInfoCache:
                    typeObj = lookupType(type)
                    if not typeObj is None:
                        typeInfoCache[type] = TypeInfo(typeObj)
297
            if not self.d.currentValueEncoding is None:
298
                self.d.put('valueencoded="%d",' % self.d.currentValueEncoding)
299
            if not self.d.currentValue is None:
300
                self.d.put('value="%s",' % self.d.currentValue)
301 302
        except:
            pass
303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333
        self.d.put('},')
        self.d.currentValue = self.savedValue
        self.d.currentValuePriority = self.savedValuePriority
        self.d.currentValueEncoding = self.savedValueEncoding
        self.d.currentType = self.savedType
        self.d.currentTypePriority = self.savedTypePriority
        return True


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

    def __enter__(self):
        childType = ""
        childNumChild = -1
        if type(self.numChild) is list:
            numChild = self.numChild[0]
            maxNumChild = self.numChild[1]
        else:
            numChild = self.numChild
            maxNumChild = self.numChild
        if numChild == 0:
            self.childType = None
        if not self.childType is None:
            childType = stripClassTag(str(self.childType))
            self.d.put('childtype="%s",' % childType)
334
            if isSimpleType(self.childType):
335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356
                self.d.put('childnumchild="0",')
                childNumChild = 0
            elif self.childType.code == gdb.TYPE_CODE_PTR:
                self.d.put('childnumchild="1",')
                childNumChild = 1
        if not self.childNumChild is None:
            self.d.put('childnumchild="%s",' % self.childNumChild)
            childNumChild = self.childNumChild
        self.savedChildType = self.d.currentChildType
        self.savedChildNumChild = self.d.currentChildNumChild
        self.savedNumChilds = self.d.currentNumChilds
        self.savedMaxNumChilds = self.d.currentNumChilds
        self.d.currentChildType = childType
        self.d.currentChildNumChild = childNumChild
        self.d.currentNumChilds = numChild
        self.d.currentMaxNumChilds = maxNumChild
        self.d.put("children=[")

    def __exit__(self, exType, exValue, exTraceBack):
        if self.d.passExceptions and not exType is None:
            showException("CHILDREN", exType, exValue, exTraceBack)
        if self.d.currentMaxNumChilds < self.d.currentNumChilds:
hjk's avatar
hjk committed
357
            self.d.putEllipsis()
358 359 360 361 362 363 364 365
        self.d.currentChildType = self.savedChildType
        self.d.currentChildNumChild = self.savedChildNumChild
        self.d.currentNumChilds = self.savedNumChilds
        self.d.currentMaxNumChilds = self.savedMaxNumChilds
        self.d.put('],')
        return True


366 367 368 369 370 371 372 373 374 375 376
# Creates a list of field names of an anon union or struct
def listOfFields(type):
    fields = []
    for field in type.fields():
        if len(field.name) > 0:
            fields += field.name
        else:
            fields += listOfFields(field.type)
    return fields


377
def value(expr):
378
    value = parseAndEvaluate(expr)
379 380 381 382 383
    try:
        return int(value)
    except:
        return str(value)

hjk's avatar
hjk committed
384
def isSimpleType(typeobj):
385 386 387 388 389
    code = typeobj.code
    return code == gdb.TYPE_CODE_BOOL \
        or code == gdb.TYPE_CODE_CHAR \
        or code == gdb.TYPE_CODE_INT \
        or code == gdb.TYPE_CODE_FLT \
390
        or code == gdb.TYPE_CODE_ENUM
391

hjk's avatar
hjk committed
392 393 394 395 396 397 398 399 400
def isStringType(d, typeobj):
    type = str(typeobj)
    return type == d.ns + "QString" \
        or type == d.ns + "QByteArray" \
        or type == "std::string" \
        or type == "std::wstring" \
        or type == "wstring"

def warn(message):
401 402
    if True or verbosity > 0:
        print "XXX: %s\n" % message.encode("latin1")
hjk's avatar
hjk committed
403 404 405 406 407 408
    pass

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

409 410 411 412 413
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
414
#def couldBePointer(p, align):
415
#    type = lookupType("unsigned int")
hjk's avatar
hjk committed
416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434
#    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):
435 436 437 438
    # 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 ")
439 440 441 442 443 444
    #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
445 446 447 448 449 450 451 452

movableTypes = set([
    "QBrush", "QBitArray", "QByteArray",
    "QCustomTypeInfo", "QChar",
    "QDate", "QDateTime",
    "QFileInfo", "QFixed", "QFixedPoint", "QFixedSize",
    "QHashDummyValue",
    "QIcon", "QImage",
hjk's avatar
hjk committed
453
    "QLine", "QLineF", "QLatin1Char", "QLocale",
hjk's avatar
hjk committed
454 455 456 457 458 459 460 461 462 463 464 465 466 467
    "QMatrix", "QModelIndex",
    "QPoint", "QPointF", "QPen", "QPersistentModelIndex",
    "QResourceRoot", "QRect", "QRectF", "QRegExp",
    "QSize", "QSizeF", "QString",
    "QTime", "QTextBlock",
    "QUrl",
    "QVariant",
    "QXmlStreamAttribute", "QXmlStreamNamespaceDeclaration",
    "QXmlStreamNotationDeclaration", "QXmlStreamEntityDeclaration"])


def stripClassTag(type):
    if type.startswith("class "):
        return type[6:]
hjk's avatar
hjk committed
468
    if type.startswith("struct "):
469
        return type[7:]
hjk's avatar
hjk committed
470
    if type.startswith("const "):
hjk's avatar
hjk committed
471
        return type[6:]
hjk's avatar
hjk committed
472
    if type.startswith("volatile "):
hjk's avatar
hjk committed
473
        return type[9:]
hjk's avatar
hjk committed
474 475 476
    return type

def checkPointerRange(p, n):
477
    for i in xrange(n):
hjk's avatar
hjk committed
478 479 480
        checkPointer(p)
        ++p

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

hjk's avatar
hjk committed
508 509 510
def call(value, func, *args):
    return call2(value, func, args)

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

534 535
qqNs = None

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

556 557
def findFirstZero(p, maximum):
    for i in xrange(maximum):
558 559 560
        if p.dereference() == 0:
            return i
        p = p + 1
561
    return maximum + 1
562

563
def extractCharArray(p, maxsize):
564
    t = lookupType("unsigned char").pointer()
565
    p = p.cast(t)
566
    limit = findFirstZero(p, maxsize)
567 568 569 570
    s = ""
    for i in xrange(limit):
        s += "%c" % int(p.dereference())
        p += 1
571
    if i > maxsize:
572 573 574 575 576 577 578 579 580 581 582 583 584
        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
585
    return extractCharArray(data, min(100, size))
586

587
def encodeCharArray(p, maxsize, limit = -1):
588
    t = lookupType("unsigned char").pointer()
589
    p = p.cast(t)
590 591
    if limit == -1:
        limit = findFirstZero(p, maxsize)
592
    s = ""
593 594 595 596 597 598 599 600
    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
601
    if limit > maxsize:
602 603 604 605
        s += "2e2e2e"
    return s

def encodeChar2Array(p, maxsize):
606
    t = lookupType("unsigned short").pointer()
607
    p = p.cast(t)
608
    limit = findFirstZero(p, maxsize)
609 610 611 612 613 614 615 616 617
    s = ""
    for i in xrange(limit):
        s += "%04x" % int(p.dereference())
        p += 1
    if i == maxsize:
        s += "2e002e002e00"
    return s

def encodeChar4Array(p, maxsize):
618
    t = lookupType("unsigned int").pointer()
619
    p = p.cast(t)
620
    limit = findFirstZero(p, maxsize)
621 622 623 624
    s = ""
    for i in xrange(limit):
        s += "%08x" % int(p.dereference())
        p += 1
625
    if i > maxsize:
626
        s += "2e0000002e0000002e000000"
627 628
    return s

629 630 631 632 633 634
def encodeByteArray(value):
    d_ptr = value['d'].dereference()
    data = d_ptr['data']
    size = d_ptr['size']
    alloc = d_ptr['alloc']
    check(0 <= size and size <= alloc and alloc <= 100*1000*1000)
635
    checkRef(d_ptr["ref"])
636 637 638
    if size > 0:
        checkAccess(data, 4)
        checkAccess(data + size) == 0
639
    return encodeCharArray(data, 100, size)
640 641 642 643 644 645 646 647 648

def encodeString(value):
    d_ptr = value['d'].dereference()
    data = d_ptr['data']
    size = d_ptr['size']
    alloc = d_ptr['alloc']
    check(0 <= size and size <= alloc and alloc <= 100*1000*1000)
    if size > 0:
        checkAccess(data, 4)
hjk's avatar
hjk committed
649
        checkAccess(data + size) == 0
650
    checkRef(d_ptr["ref"])
651 652
    p = gdb.Value(d_ptr["data"])
    s = ""
653
    limit = min(size, 1000)
654 655 656
    try:
        # gdb.Inferior is new in gdb 7.2
        inferior = gdb.inferiors()[0]
657
        s = binascii.hexlify(inferior.read_memory(p, 2 * limit))
658
    except:
659
        for i in xrange(limit):
660 661 662 663
            val = int(p.dereference())
            s += "%02x" % (val % 256)
            s += "%02x" % (val / 256)
            p += 1
664 665
    if limit < size:
        s += "2e002e002e00"
666 667
    return s

hjk's avatar
hjk committed
668 669
def stripTypedefs(type):
    type = type.unqualified()
670 671 672 673
    while type.code == gdb.TYPE_CODE_TYPEDEF:
        type = type.strip_typedefs().unqualified()
    return type

hjk's avatar
hjk committed
674 675 676 677 678 679
def extractFields(type):
    # Insufficient, see http://sourceware.org/bugzilla/show_bug.cgi?id=10953:
    #fields = value.type.fields()
    # Insufficient, see http://sourceware.org/bugzilla/show_bug.cgi?id=11777:
    #fields = stripTypedefs(value.type).fields()
    # This seems to work.
hjk's avatar
hjk committed
680
    #warn("TYPE 0: %s" % type)
hjk's avatar
hjk committed
681
    type = stripTypedefs(type)
682 683 684
    fields = type.fields()
    if len(fields):
        return fields
hjk's avatar
hjk committed
685
    #warn("TYPE 1: %s" % type)
686
    # This fails for arrays. See comment in lookupType.
687 688 689
    type0 = lookupType(str(type))
    if not type0 is None:
        type = type0
690 691
    if type.code == gdb.TYPE_CODE_FUNC:
        return []
hjk's avatar
hjk committed
692 693
    #warn("TYPE 2: %s" % type)
    fields = type.fields()
hjk's avatar
hjk committed
694
    #warn("FIELDS: %s" % fields)
hjk's avatar
hjk committed
695 696
    return fields

hjk's avatar
hjk committed
697 698 699 700 701 702 703
#######################################################################
#
# Item
#
#######################################################################

class Item:
704
    def __init__(self, value, parentiname, iname = None, name = None):
hjk's avatar
hjk committed
705
        self.value = value
706 707 708 709
        if iname is None:
            self.iname = parentiname
        else:
            self.iname = "%s.%s" % (parentiname, iname)
hjk's avatar
hjk committed
710 711 712
        self.name = name


713 714 715 716 717 718
#######################################################################
#
# SetupCommand
#
#######################################################################

719
# This is a cache mapping from 'type name' to 'display alternatives'.
720
qqFormats = {}
721 722

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

725 726 727
# This is a cache of all dumpers that support writing.
qqEditable = {}

728 729 730 731 732
# 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
733
qqQObjectCache = {}
734

735
def bbsetup(args):
736 737 738 739 740
    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
741
            qqFormats[name] = qqFormats.get(name, "")
742 743 744 745 746 747 748 749
        elif key.startswith("qform__"):
            name = key[7:]
            formats = ""
            try:
                formats = value()
            except:
                pass
            qqFormats[name] = formats
750 751 752 753 754 755
        elif key.startswith("qedit__"):
            name = key[7:]
            try:
                qqEditable[name] = value
            except:
                pass
756
    result = "dumpers=["
757
    #qqNs = qtNamespace() # This is too early
758
    for key, value in qqFormats.items():
759 760 761 762
        if qqEditable.has_key(key):
            result += '{type="%s",formats="%s",editable="true"},' % (key, value)
        else:
            result += '{type="%s",formats="%s"},' % (key, value)
763 764
    result += ']'
    #result += ',namespace="%s"' % qqNs
765
    result += ',hasInferiorThreadList="%s"' % int(hasInferiorThreadList())
766 767
    return result

768 769
registerCommand("bbsetup", bbsetup)

770

771 772 773 774 775 776 777
#######################################################################
#
# Edit Command
#
#######################################################################

def bbedit(args):
778 779
    (type, expr, value) = args.split(",")
    type = base64.b16decode(type, True)
780
    ns = qtNamespace()
781 782
    if type.startswith(ns):
        type = type[len(ns):]
783
    type = type.replace("::", "__")
784 785 786 787 788 789
    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))
790 791 792
    if qqEditable.has_key(type):
        qqEditable[type](expr, value)

793
registerCommand("bbedit", bbedit)
794 795


hjk's avatar
hjk committed
796 797
#######################################################################
#
798
# Frame Command
hjk's avatar
hjk committed
799 800 801
#
#######################################################################

802
def bb(args):
hjk's avatar
hjk committed
803
    output = 'data=[' + "".join(Dumper(args).output) + '],typeinfo=['
804 805 806 807 808 809 810
    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
811

812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829
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
830

831 832 833 834 835 836
#######################################################################
#
# Step Command
#
#######################################################################

837 838 839 840 841 842 843 844 845 846 847 848 849 850
def sal(args):
    (cmd, addr) = arg.split(",")
    lines = catchCliOutput("info line *" + addr)
    fromAddr = "0x0"
    toAddr = "0x0"
    for line in lines:
        pos0from = line.find(" starts at address") + 19
        pos1from = line.find(" ", pos0from)
        pos0to = line.find(" ends at", pos1from) + 9
        pos1to = line.find(" ", pos0to)
        if pos1to > 0:
            fromAddr = line[pos0from : pos1from]
            toAddr = line[pos0to : pos1to]
    gdb.execute("maint packet sal%s,%s,%s" % (cmd,fromAddr, toAddr))
851

852
registerCommand("sal", sal)
hjk's avatar
hjk committed
853

854

hjk's avatar
hjk committed
855 856 857 858 859 860
#######################################################################
#
# The Dumper Class
#
#######################################################################

861

hjk's avatar
hjk committed
862
class Dumper:
863
    def __init__(self, args):
hjk's avatar
hjk committed
864
        self.output = []
865
        self.printsAddress = True
866 867 868 869 870 871 872 873 874
        self.currentChildType = ""
        self.currentChildNumChild = -1
        self.currentMaxNumChilds = -1
        self.currentNumChilds = -1
        self.currentValue = None
        self.currentValuePriority = -100
        self.currentValueEncoding = None
        self.currentType = None
        self.currentTypePriority = -100
875 876 877 878 879 880 881 882
        self.typeformats = {}
        self.formats = {}
        self.expandedINames = ""

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

883
        resultVarName = ""
884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911
        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
912
        self.partialUpdate = "partial" in options
913 914
        self.tooltipOnly = "tooltiponly" in options
        self.noLocals = "nolocals" in options
915
        self.ns = qtNamespace()
916 917 918 919 920
        self.alienSource = False
        #try:
        #    self.alienSource = catchCliOutput("info source")[0][-3:-1]==".d"
        #except:
        #    self.alienSource = False
921 922 923 924

        #warn("NAMESPACE: '%s'" % self.ns)
        #warn("VARIABLES: %s" % varList)
        #warn("EXPANDED INAMES: %s" % self.expandedINames)
925
        #warn("WATCHERS: %s" % watchers)
926 927
        #warn("PARTIAL: %s" % self.partialUpdate)
        #warn("NO LOCALS: %s" % self.noLocals)
928 929 930 931 932
        module = sys.modules[__name__]

        #
        # Locals
        #
933
        locals = []
934
        fullUpdateNeeded = True
935
        if self.partialUpdate and len(varList) == 1 and not self.tooltipOnly:
936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952
            #warn("PARTIAL: %s" % varList)
            parts = varList[0].split('.')
            #warn("PARTIAL PARTS: %s" % parts)
            name = parts[1]
            #warn("PARTIAL VAR: %s" % name)
            #fullUpdateNeeded = False
            try:
                frame = gdb.selected_frame()
                item = Item(0, "local", name, name)
                item.value = frame.read_var(name)
                locals = [item]
                #warn("PARTIAL LOCALS: %s" % locals)
                fullUpdateNeeded = False
            except:
                pass
            varList = []

953
        if fullUpdateNeeded and not self.tooltipOnly and not self.noLocals:
954
            locals = listOfLocals(varList)
955 956 957 958 959 960 961 962 963 964 965

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

        for item in locals:
966
          item.value = upcast(item.value)
967 968 969 970 971 972 973 974 975 976 977 978
          with OutputSafer(self, "", ""):
            self.anonNumber = -1
            #warn("ITEM NAME %s: " % item.name)
            try:
                #warn("ITEM VALUE %s: " % item.value)
                # Throw on funny stuff, catch below.
                # Unfortunately, this fails also with a "Unicode encoding error"
                # in testArray().
                #dummy = str(item.value)
                pass
            except:
                # Locals with failing memory access.
979
                # FIXME: Isn't this taken care off by the SubItem destructor?
980
                with SubItem(self):
981 982 983
                    self.put('iname="%s",' % item.iname)
                    self.put('name="%s",' % item.name)
                    self.put('addr="<not accessible>",')
hjk's avatar
hjk committed
984
                    self.put('numchild="0"')
985 986
                    self.putValue("<not accessible>")
                    self.putType(item.value.type)
987 988 989 990 991 992 993 994
                continue

            type = item.value.type
            if type.code == gdb.TYPE_CODE_PTR \
                    and item.name == "argv" and str(type) == "char **":
                # Special handling for char** argv.
                n = 0
                p = item.value
995 996 997 998 999 1000 1001 1002
                # p is 0 for "optimized out" cases. Or contains rubbish.
                try:
                    if not isNull(p):
                        while not isNull(p.dereference()) and n <= 100:
                            p += 1
                            n += 1
                except:
                    pass
1003

1004
                with SubItem(self):
1005 1006
                    self.put('iname="%s",' % item.iname)
                    self.putName(item.name)
1007
                    self.putItemCount(n, 100)
1008 1009 1010 1011 1012 1013 1014
                    self.putType(type)
                    self.putNumChild(n)
                    if self.isExpanded(item):
                        p = item.value
                        with Children(self, n):
                            for i in xrange(n):
                                value = p.dereference()
1015
                                self.putSubItem(Item(value, item.iname, i, None))
1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026
                                p += 1
                            if n > 100:
                                self.putEllipsis()

            else:
                # A "normal" local variable or parameter.
                try:
                   addr = cleanAddress(item.value.address)
                   with SubItem(self):
                       self.put('iname="%s",' % item.iname)
                       self.put('addr="%s",' % addr)
1027
                       self.putItem(item)
1028 1029 1030
                except AttributeError:
                    # Thrown by cleanAddress with message "'NoneType' object
                    # has no attribute 'cast'" for optimized-out values.
1031
                    with SubItem(self):
1032 1033 1034
                        self.put('iname="%s",' % item.iname)
                        self.put('name="%s",' % item.name)
                        self.put('addr="<optimized out>",')
1035 1036
                        self.putValue("<optimized out>")
                        self.putType(item.value.type)
1037 1038 1039 1040 1041 1042 1043 1044

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

1047
        #print('data=[' + locals + sep + watchers + ']\n')
1048

hjk's avatar
hjk committed
1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062
    def checkForQObjectBase(self, type):
        if type.code != gdb.TYPE_CODE_STRUCT:
            return False
        name = str(type)
        if name in qqQObjectCache:
            return qqQObjectCache[name]
        if name == self.ns + "QObject":
            qqQObjectCache[name] = True
            return True
        fields = type.strip_typedefs().fields()
        if len(fields) == 0:
            qqQObjectCache[name] = False
            return False
        base = fields[0].type.strip_typedefs()
1063 1064 1065
        # Prevent infinite recursion in Qt 3.3.8
        if str(base) == name:
            return False
hjk's avatar
hjk committed
1066 1067 1068 1069
        result = self.checkForQObjectBase(base)
        qqQObjectCache[name] = result
        return result

1070 1071 1072

    def handleWatch(self, exp, iname):
        exp = str(exp)
1073
        escapedExp = base64.b64encode(exp);
1074 1075 1076
        #warn("HANDLING WATCH %s, INAME: '%s'" % (exp, iname))
        if exp.startswith("[") and exp.endswith("]"):
            #warn("EVAL: EXP: %s" % exp)
1077 1078
            with SubItem(self):
                self.put('iname="%s",' % iname)
1079
                self.put('wname="%s",' % escapedExp)