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

#return

import sys
import gdb
8
import base64
9
import __builtin__
10
import os
11 12
import cProfile

13 14 15 16 17 18 19

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

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

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

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

hjk's avatar
hjk committed
50 51 52
verbosity = 0
verbosity = 1

53 54 55 56 57
# Some "Enums"

# Encodings

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

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


80 81 82 83 84
def select(condition, if_expr, else_expr):
    if condition:
        return if_expr
    return else_expr

85 86 87 88 89
def qmin(n, m):
    if n < m:
        return n
    return m

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

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

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

111
def parseAndEvaluate(exp):
hjk's avatar
hjk committed
112
    if isGoodGdb():
113 114 115 116
        return gdb.parse_and_eval(exp)
    # Work around non-existing gdb.parse_and_eval as in released 7.0
    gdb.execute("set logging redirect on")
    gdb.execute("set logging on")
117 118 119 120
    try:
        gdb.execute("print %s" % exp)
    except:
        gdb.execute("set logging off")
121
        gdb.execute("set logging redirect off")
122
        return None
123
    gdb.execute("set logging off")
124
    gdb.execute("set logging redirect off")
125 126
    return gdb.history(0)

127

128
def catchCliOutput(command):
129
    filename, file = createTempFile()
130 131 132 133 134 135 136 137
    gdb.execute("set logging off")
    gdb.execute("set logging redirect off")
    gdb.execute("set logging file %s" % filename)
    gdb.execute("set logging redirect on")
    gdb.execute("set logging on")
    gdb.execute(command)
    gdb.execute("set logging off")
    gdb.execute("set logging redirect off")
138
    temp = open(filename, "r")
139
    lines = []
140
    for line in temp:
141
        lines.append(line)
142 143
    temp.close()
    removeTempFile(filename, file)
144 145 146
    return lines


147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188
def showException(msg, exType, exValue, exTraceback):
    warn("**** CAUGHT EXCEPTION: %s ****" % msg)
    try:
        import traceback
        for line in traceback.format_exception(exType, exValue, exTraceback):
            warn("%s" % line)
    except:
        pass


class OutputSafer:
    def __init__(self, d, pre = "", post = ""):
        self.d = d
        self.pre = pre
        self.post = post

    def __enter__(self):
        self.d.put(self.pre)
        self.savedOutput = self.d.output
        self.d.output = ""

    def __exit__(self, exType, exValue, exTraceBack):
        self.d.put(self.post)
        if self.d.passExceptions and not exType is None:
            showException("OUTPUTSAFER", exType, exValue, exTraceBack)
            self.d.output = self.savedOutput
        else:
            self.d.output = self.savedOutput + self.d.output
        return False


class SubItem:
    def __init__(self, d):
        self.d = d

    def __enter__(self):
        self.d.put('{')
        self.savedValue = self.d.currentValue
        self.savedValuePriority = self.d.currentValuePriority
        self.savedValueEncoding = self.d.currentValueEncoding
        self.savedType = self.d.currentType
        self.savedTypePriority = self.d.currentTypePriority
hjk's avatar
hjk committed
189
        self.d.currentValue = "<not accessible>"
190
        self.d.currentValuePriority = -100
191 192
        self.d.currentValueEncoding = None
        self.d.currentType = ""
193
        self.d.currentTypePriority = -100
194 195 196 197 198 199

    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)
200 201 202 203 204 205 206 207 208 209 210 211
        try:
            #warn("TYPE CURRENT: %s" % self.d.currentType)
            type = stripClassTag(str(self.d.currentType))
            #warn("TYPE: '%s'  DEFAULT: '%s'" % (type, self.d.currentChildType))
            if len(type) > 0 and type != self.d.currentChildType:
                self.d.put('type="%s",' % type) # str(type.unqualified()) ?
            if not self.d.currentValueEncoding is None:
                self.d.putField("valueencoded", self.d.currentValueEncoding)
            if not self.d.currentValue is None:
                self.d.putField("value", self.d.currentValue)
        except:
            pass
212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274
        self.d.put('},')
        self.d.currentValue = self.savedValue
        self.d.currentValuePriority = self.savedValuePriority
        self.d.currentValueEncoding = self.savedValueEncoding
        self.d.currentType = self.savedType
        self.d.currentTypePriority = self.savedTypePriority
        return True


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

    def __enter__(self):
        childType = ""
        childNumChild = -1
        if type(self.numChild) is list:
            numChild = self.numChild[0]
            maxNumChild = self.numChild[1]
        else:
            numChild = self.numChild
            maxNumChild = self.numChild
        if numChild == 0:
            self.childType = None
        if not self.childType is None:
            childType = stripClassTag(str(self.childType))
            self.d.put('childtype="%s",' % childType)
            if isSimpleType(self.childType) or isStringType(self.d, self.childType):
                self.d.put('childnumchild="0",')
                childNumChild = 0
            elif self.childType.code == gdb.TYPE_CODE_PTR:
                self.d.put('childnumchild="1",')
                childNumChild = 1
        if not self.childNumChild is None:
            self.d.put('childnumchild="%s",' % self.childNumChild)
            childNumChild = self.childNumChild
        self.savedChildType = self.d.currentChildType
        self.savedChildNumChild = self.d.currentChildNumChild
        self.savedNumChilds = self.d.currentNumChilds
        self.savedMaxNumChilds = self.d.currentNumChilds
        self.d.currentChildType = childType
        self.d.currentChildNumChild = childNumChild
        self.d.currentNumChilds = numChild
        self.d.currentMaxNumChilds = maxNumChild
        self.d.put("children=[")

    def __exit__(self, exType, exValue, exTraceBack):
        if self.d.passExceptions and not exType is None:
            showException("CHILDREN", exType, exValue, exTraceBack)
        if self.d.currentMaxNumChilds < self.d.currentNumChilds:
            self.d.putEllipsis();
        self.d.currentChildType = self.savedChildType
        self.d.currentChildNumChild = self.savedChildNumChild
        self.d.currentNumChilds = self.savedNumChilds
        self.d.currentMaxNumChilds = self.savedMaxNumChilds
        self.d.put('],')
        return True


275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298
class Breakpoint:
    def __init__(self):
        self.number = None
        self.filename = None
        self.linenumber = None
        self.address = []
        self.function = None
        self.fullname = None
        self.condition = None
        self.times = None

def listOfBreakpoints(d):
    # [bkpt={number="1",type="breakpoint",disp="keep",enabled="y",
    #addr="0x0804da6d",func="testHidden()",file="../app.cpp",
    #fullname="...",line="1292",times="1",original-location="\"app.cpp\":1292"},
    # Num     Type           Disp Enb Address    What\n"
    #1       breakpoint     keep y   0x0804da6d in testHidden() at app.cpp:1292
    #\tbreakpoint already hit 1 time
    #2       breakpoint     keep y   0x080564d3 in espace::..doit(int) at ../app.cpp:1210\n"
    #3       breakpoint     keep y   <PENDING>  \"plugin.cpp\":38\n"
    #4       breakpoint     keep y   <MULTIPLE> \n"
    #4.1                         y     0x08056673 in Foo at ../app.cpp:126\n"
    #4.2                         y     0x0805678b in Foo at ../app.cpp:126\n"
    #5       hw watchpoint  keep y              &main\n"
299
    #6       breakpoint     keep y   0xb6cf18e5 <__cxa_throw+5>\n"
300
    lines = catchCliOutput("info break")
301 302 303 304

    lines.reverse()
    bp = Breakpoint()
    for line in lines:
305 306
        if len(line) == 0 or line.startswith(" "):
            continue
307 308 309 310 311 312 313 314 315 316
        if line[0] < '0' or line[0] > '9':
            continue
        if line.startswith("\tstop only if "):
            bp.condition = line[14:]
            continue
        if line.startswith("\tbreakpoint already hit "):
            bp.times = line[24:]
            continue
        number = line[0:5]
        pos0x = line.find(" 0x")
317
        posin = line.find(" in ", pos0x)
318
        poslt = line.find(" <", pos0x)
319
        posat = line.find(" at ", posin)
320
        poscol = line.find(":", posat)
321 322 323 324 325 326
        if pos0x != -1:
            if pos0x < posin:
                bp.address.append(line[pos0x + 1 : posin])
            elif pos0x < poslt:
                bp.address.append(line[pos0x + 1 : poslt])
                bp.function = line[poslt + 2 : line.find('>', poslt)]
327 328 329
        # Take "no address" as indication that the bp is pending.
        #if line.find("<PENDING>") >= 0:
        #    bp.address.append("<PENDING>")
330 331 332 333 334 335 336 337 338 339 340 341
        if posin < posat and posin != -1:
            bp.function = line[posin + 4 : posat]
        if posat < poscol and poscol != -1:
            bp.filename = line[posat + 4 : poscol]
        if poscol != -1:
            bp.linenumber = line[poscol + 1 : -1]

        if '.' in number: # Part of multiple breakpoint.
            continue

        # A breakpoint of its own
        bp.number = int(number)
hjk's avatar
hjk committed
342 343 344 345
        d.put('bkpt={number="%s",' % bp.number)
        d.put('type="breakpoint",')
        d.put('disp="keep",')
        d.put('enabled="y",')
346
        for address in bp.address:
hjk's avatar
hjk committed
347
            d.put('addr="%s",' % address)
348
        if not bp.function is None:
hjk's avatar
hjk committed
349
            d.put('func="%s",' % bp.function)
350
        if not bp.filename is None:
hjk's avatar
hjk committed
351
            d.put('file="%s",' % bp.filename)
352
        if not bp.fullname is None:
hjk's avatar
hjk committed
353
            d.put('fullname="%s",' % bp.fullname)
354
        if not bp.linenumber is None:
hjk's avatar
hjk committed
355
            d.put('line="%s",' % bp.linenumber)
356
        if not bp.condition is None:
hjk's avatar
hjk committed
357
            d.put('cond="%s",' % bp.condition)
358
        if not bp.fullname is None:
hjk's avatar
hjk committed
359
            d.put('fullname="%s",' % bt.fullname)
360
        if not bp.times is None:
hjk's avatar
hjk committed
361
            d.put('times="1",' % bp.times)
362
        #d.put('original-location="-"')
hjk's avatar
hjk committed
363
        d.put('},')
364 365 366
        bp = Breakpoint()


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


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

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

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

401 402 403 404 405 406
        while True:
            if block is None:
                warn("UNEXPECTED 'None' BLOCK")
                break
            for symbol in block:
                name = symbol.print_name
407

408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430
                if name == "__in_chrg":
                    continue

                # "NotImplementedError: Symbol type not yet supported in
                # Python scripts."
                #warn("SYMBOL %s: " % symbol.value)
                #warn("SYMBOL %s  (%s): " % (symbol, name))
                item = Item(0, "local", name, name)
                try:
                    item.value = frame.read_var(name)  # this is a gdb value
                except RuntimeError:
                    # happens for  void foo() { std::string s; std::wstring w; }
                    #warn("  FRAME READ VAR ERROR: %s (%s): " % (symbol, name))
                    continue
                #warn("ITEM %s: " % item.value)
                items.append(item)
            # The outermost block in a function has the function member
            # FIXME: check whether this is guaranteed.
            if not block.function is None:
                break

            block = block.superblock
    else:
hjk's avatar
hjk committed
431
        # Assuming gdb 7.0 release or 6.8-symbianelf.
432
        filename, file = createTempFile()
433
        #warn("VARLIST: %s " % varList)
434
        #warn("FILENAME: %s " % filename)
hjk's avatar
hjk committed
435 436
        gdb.execute("set logging off")
        gdb.execute("set logging redirect off")
437 438 439
        gdb.execute("set logging file %s" % filename)
        gdb.execute("set logging redirect on")
        gdb.execute("set logging on")
440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456
        try:
            gdb.execute("info args")
            # We cannot use "info locals" as at least 6.8-symbianelf
            # aborts as soon as we hit unreadable memory.
            # gdb.execute("interpreter mi '-stack-list-locals 0'")
            # results in &"Recursive internal problem.\n", so we have
            # the frontend pass us the list of locals.

            # There are two cases, either varList is empty, so we have
            # to fetch the list here, or it is not empty with the
            # first entry being a dummy.
            if len(varList) == 0:
                gdb.execute("info locals")
            else:
                varList = varList[1:]
        except:
            pass
457 458
        gdb.execute("set logging off")
        gdb.execute("set logging redirect off")
459

460 461 462 463 464 465 466 467 468 469 470 471 472
        try:
            temp = open(filename, "r")
            for line in temp:
                if len(line) == 0 or line.startswith(" "):
                    continue
                # The function parameters
                pos = line.find(" = ")
                if pos < 0:
                    continue
                varList.append(line[0:pos])
            temp.close()
        except:
            pass
473
        removeTempFile(filename, file)
474 475 476
        #warn("VARLIST: %s " % varList)
        for name in varList:
            #warn("NAME %s " % name)
477 478 479 480
            item = Item(0, "local", name, name)
            try:
                item.value = frame.read_var(name)  # this is a gdb value
            except RuntimeError:
481 482
                pass
                #continue
483 484 485 486 487
            except:
                # Something breaking the list, like intermediate gdb warnings
                # like 'Warning: can't find linker symbol for virtual table for
                # `std::less<char const*>' value\n\nwarning:  found
                # `myns::QHashData::shared_null' instead [...]
488
                # that break subsequent parsing. Chicken out and take the
489 490
                # next "usable" line.
                continue
491 492 493 494 495
            items.append(item)

    return items


496
def value(expr):
497
    value = parseAndEvaluate(expr)
498 499 500 501 502
    try:
        return int(value)
    except:
        return str(value)

503

hjk's avatar
hjk committed
504
def isSimpleType(typeobj):
505 506
    if typeobj.code == gdb.TYPE_CODE_PTR:
        return False
hjk's avatar
hjk committed
507 508 509 510 511 512 513 514
    type = str(typeobj)
    return type == "bool" \
        or type == "char" \
        or type == "double" \
        or type == "float" \
        or type == "int" \
        or type == "long" or type.startswith("long ") \
        or type == "short" or type.startswith("short ") \
515
        or type == "signed" or type.startswith("signed ") \
hjk's avatar
hjk committed
516 517
        or type == "unsigned" or type.startswith("unsigned ")

518

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

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

536 537 538 539 540
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
541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561
#def couldBePointer(p, align):
#    type = gdb.lookup_type("unsigned int")
#    ptr = gdb.Value(p).cast(type)
#    d = int(str(ptr))
#    warn("CHECKING : %s %d " % (p, ((d & 3) == 0 and (d > 1000 or d == 0))))
#    return (d & (align - 1)) and (d > 1000 or d == 0)


def checkAccess(p, align = 1):
    return p.dereference()

def checkContents(p, expected, align = 1):
    if int(p.dereference()) != expected:
        raise RuntimeError("Contents check failed")

def checkPointer(p, align = 1):
    if not isNull(p):
        p.dereference()


def isNull(p):
562 563 564 565
    # 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 ")
566
    return p.cast(gdb.lookup_type("void").pointer()) == 0
hjk's avatar
hjk committed
567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589

movableTypes = set([
    "QBrush", "QBitArray", "QByteArray",
    "QCustomTypeInfo", "QChar",
    "QDate", "QDateTime",
    "QFileInfo", "QFixed", "QFixedPoint", "QFixedSize",
    "QHashDummyValue",
    "QIcon", "QImage",
    "QLine", "QLineF", "QLatin1Char", "QLocal",
    "QMatrix", "QModelIndex",
    "QPoint", "QPointF", "QPen", "QPersistentModelIndex",
    "QResourceRoot", "QRect", "QRectF", "QRegExp",
    "QSize", "QSizeF", "QString",
    "QTime", "QTextBlock",
    "QUrl",
    "QVariant",
    "QXmlStreamAttribute", "QXmlStreamNamespaceDeclaration",
    "QXmlStreamNotationDeclaration", "QXmlStreamEntityDeclaration"])


def stripClassTag(type):
    if type.startswith("class "):
        return type[6:]
590 591
    elif type.startswith("struct "):
        return type[7:]
hjk's avatar
hjk committed
592 593 594
    return type

def checkPointerRange(p, n):
595
    for i in xrange(n):
hjk's avatar
hjk committed
596 597 598 599 600 601
        checkPointer(p)
        ++p

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

614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635
def makeValue(type, init):
    type = stripClassTag(type)
    if type.find(":") >= 0:
        type = "'" + type + "'"
    gdb.execute("set $d = (%s*)malloc(sizeof(%s))" % (type, type))
    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

636 637
def qtNamespace():
    try:
638
        type = str(parseAndEvaluate("&QString::null").type.target().unqualified())
639 640 641
        return type[0:len(type) - len("QString::null")]
    except RuntimeError:
        return ""
642 643 644
    except AttributeError:
        # Happens for none-Qt applications
        return ""
hjk's avatar
hjk committed
645

646 647 648 649 650 651 652
def findFirstZero(p, max):
    for i in xrange(max):
        if p.dereference() == 0:
            return i
        p = p + 1
    return -1

653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678

def extractCharArray(p, maxsize):
    t = gdb.lookup_type("unsigned char").pointer()
    p = p.cast(t)
    i = findFirstZero(p, maxsize)
    limit = select(i < 0, maxsize, i)
    s = ""
    for i in xrange(limit):
        s += "%c" % int(p.dereference())
        p += 1
    if i == maxsize:
        s += "..."
    return s

def extractByteArray(value):
    d_ptr = value['d'].dereference()
    data = d_ptr['data']
    size = d_ptr['size']
    alloc = d_ptr['alloc']
    check(0 <= size and size <= alloc and alloc <= 100*1000*1000)
    checkRef(d_ptr["ref"])
    if size > 0:
        checkAccess(data, 4)
        checkAccess(data + size) == 0
    return extractCharArray(data, 100)

679
def encodeCharArray(p, maxsize, size = -1):
680 681
    t = gdb.lookup_type("unsigned char").pointer()
    p = p.cast(t)
682 683 684 685
    if size == -1:
        i = findFirstZero(p, maxsize)
    else:
        i = size
686
    limit = select(i < 0, maxsize, i)
687
    s = ""
688
    for i in xrange(limit):
689 690
        s += "%02x" % int(p.dereference())
        p += 1
691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718
    if i == maxsize:
        s += "2e2e2e"
    return s

def encodeChar2Array(p, maxsize):
    t = gdb.lookup_type("unsigned short").pointer()
    p = p.cast(t)
    i = findFirstZero(p, maxsize)
    limit = select(i < 0, maxsize, i)
    s = ""
    for i in xrange(limit):
        s += "%04x" % int(p.dereference())
        p += 1
    if i == maxsize:
        s += "2e002e002e00"
    return s

def encodeChar4Array(p, maxsize):
    t = gdb.lookup_type("unsigned int").pointer()
    p = p.cast(t)
    i = findFirstZero(p, maxsize)
    limit = select(i < 0, maxsize, i)
    s = ""
    for i in xrange(limit):
        s += "%08x" % int(p.dereference())
        p += 1
    if i == maxsize:
        s += "2e0000002e0000002e000000"
719 720
    return s

721 722 723 724 725 726
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)
727
    checkRef(d_ptr["ref"])
728 729 730
    if size > 0:
        checkAccess(data, 4)
        checkAccess(data + size) == 0
731
    return encodeCharArray(data, size)
732 733 734 735 736 737 738 739 740

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
741
        checkAccess(data + size) == 0
742
    checkRef(d_ptr["ref"])
743 744
    p = gdb.Value(d_ptr["data"])
    s = ""
745
    for i in xrange(size):
746 747 748 749 750 751
        val = int(p.dereference())
        s += "%02x" % (val % 256)
        s += "%02x" % (val / 256)
        p += 1
    return s

hjk's avatar
hjk committed
752 753 754 755 756 757 758
#######################################################################
#
# Item
#
#######################################################################

class Item:
759
    def __init__(self, value, parentiname, iname = None, name = None):
hjk's avatar
hjk committed
760
        self.value = value
761 762 763 764
        if iname is None:
            self.iname = parentiname
        else:
            self.iname = "%s.%s" % (parentiname, iname)
hjk's avatar
hjk committed
765 766 767 768 769 770 771 772 773 774 775 776 777 778 779
        self.name = name


#######################################################################
#
# FrameCommand
#
#######################################################################

class FrameCommand(gdb.Command):
    """Do fancy stuff. Usage bb --verbose expandedINames"""

    def __init__(self):
        super(FrameCommand, self).__init__("bb", gdb.COMMAND_OBSCURE)

780
    def invoke(self, args, from_tty):
781 782 783 784
        #if args.startswith('options:pp'):
        #    cProfile.run('bb("%s")' % args, '/tmp/fooprof')
        #else:
        bb(args)
785

786
FrameCommand()
787 788


789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875
def bb(args):
    options = []
    varList = []
    typeformats = {}
    formats = {}
    watchers = ""
    expandedINames = ""
    resultVarName = ""
    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:"):
            expandedINames = set(arg[pos:].split(","))
        elif arg.startswith("typeformats:"):
            for f in arg[pos:].split(","):
                pos = f.find("=")
                if pos != -1:
                    type = base64.b16decode(f[0:pos], True)
                    typeformats[type] = int(f[pos+1:])
        elif arg.startswith("formats:"):
            for f in arg[pos:].split(","):
                pos = f.find("=")
                if pos != -1:
                    formats[f[0:pos]] = int(f[pos+1:])
        elif arg.startswith("watchers:"):
            watchers = base64.b16decode(arg[pos:], True)

    useFancy = "fancy" in options

    #warn("VARIABLES: %s" % varList)
    #warn("EXPANDED INAMES: %s" % expandedINames)
    module = sys.modules[__name__]
    dumpers = {}

    if False:
        dumpers = ""
        typeformats = ""
        for key, value in module.__dict__.items():
            if key.startswith("qdump__"):
                dumpers += '"' + key[7:] + '",'
        output = "dumpers=[%s]," % dumpers
        #output += "qtversion=[%d,%d,%d]"
        #output += "qtversion=[4,6,0],"
        output += "namespace=\"%s\"," % qtNamespace()
        output += "dumperversion=\"2.0\","
        output += "sizes=[],"
        output += "expressions=[]"
        output += "]"
        print output
        return


    if useFancy:
        for key, value in module.__dict__.items():
            if key.startswith("qdump__"):
                dumpers[key[7:]] = value

    d = Dumper()
    d.dumpers = dumpers
    d.typeformats = typeformats
    d.formats = formats
    d.useFancy = useFancy
    d.passExceptions = "pe" in options
    d.autoDerefPointers = "autoderef" in options
    d.ns = qtNamespace()
    d.expandedINames = expandedINames
    #warn(" NAMESPACE IS: '%s'" % d.ns)

    #
    # Locals
    #
    locals = listOfLocals(varList);

    # 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
876

877 878 879 880 881 882 883 884 885 886 887 888 889
    for item in locals:
      with OutputSafer(d, "", ""):
        d.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.
890
            with SubItem(d):
891 892 893 894 895 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 924 925
                d.put('iname="%s",' % item.iname)
                d.put('name="%s",' % item.name)
                d.put('addr="<not accessible>",')
                d.put('value="<not accessible>",')
                d.put('type="%s",' % item.value.type)
                d.put('numchild="0"');
            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
            # p is 0 for "optimized out" cases.
            if not isNull(p):
                while not isNull(p.dereference()) and n <= 100:
                    p += 1
                    n += 1

            with SubItem(d):
                d.put('iname="%s",' % item.iname)
                d.putName(item.name)
                d.putItemCount(select(n <= 100, n, "> 100"))
                d.putType(type)
                d.putNumChild(n)
                if d.isExpanded(item):
                    p = item.value
                    with Children(d, n):
                        for i in xrange(n):
                            value = p.dereference()
                            d.putItem(Item(value, item.iname, i, None))
                            p += 1
                        if n > 100:
                            d.putEllipsis()
926

927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968
        else:
            # A "normal" local variable or parameter.
            try:
               addr = cleanAddress(item.value.address)
               with SubItem(d):
                   d.put('iname="%s",' % item.iname)
                   d.put('addr="%s",' % addr)
                   d.putItemHelper(item)
            except AttributeError:
                # Thrown by cleanAddress with message "'NoneType' object
                # has no attribute 'cast'" for optimized-out values.
                with SubItem(d):
                    d.put('iname="%s",' % item.iname)
                    d.put('name="%s",' % item.name)
                    d.put('addr="<optimized out>",')
                    d.put('value="<optimized out>",')
                    d.put('type="%s"' % item.value.type)

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

    #
    # Breakpoints
    #
    #listOfBreakpoints(d)

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


def handleWatch(d, exp, iname):
    exp = str(exp)
    escapedExp = exp.replace('"', '\\"');
    #warn("HANDLING WATCH %s, INAME: '%s'" % (exp, iname))
    if exp.startswith("[") and exp.endswith("]"):
        #warn("EVAL: EXP: %s" % exp)
969
        with SubItem(d):
970
            d.putField("iname", iname)
971 972
            d.putField("name", escapedExp)
            d.putField("exp", escapedExp)
973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008
            try:
                list = eval(exp)
                d.putValue("")
                d.putType(" ")
                d.putNumChild(len(list))
                # This is a list of expressions to evaluate
                with Children(d, len(list)):
                    itemNumber = 0
                    for item in list:
                        handleWatch(d, item, "%s.%d" % (iname, itemNumber))
                        itemNumber += 1
            except RuntimeError, error:
                warn("EVAL: ERROR CAUGHT %s" % error)
                d.putValue("<syntax error>")
                d.putType(" ")
                d.putNumChild(0)
                with Children(d, 0):
                    pass
        return

    with SubItem(d):
        d.putField("iname", iname)
        d.putField("name", escapedExp)
        d.putField("exp", escapedExp)
        handled = False
        if exp == "<Edit>" or len(exp) == 0:
            d.put('value=" ",type=" ",numchild="0",')
        else:
            try:
                value = parseAndEvaluate(exp)
                item = Item(value, iname, None, None)
                if not value is None:
                    d.putAddress(value.address)
                d.putItemHelper(item)
            except RuntimeError:
                d.put('value="<invalid>",type="<unknown>",numchild="0",')
hjk's avatar
hjk committed
1009 1010 1011



1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025
#######################################################################
#
# Step Command
#
#######################################################################


class SalCommand(gdb.Command):
    """Do fancy stuff."""

    def __init__(self):
        super(SalCommand, self).__init__("sal", gdb.COMMAND_OBSCURE)

    def invoke(self, arg, from_tty):
1026 1027
        (cmd, addr) = arg.split(",")
        lines = catchCliOutput("info line *" + addr)
1028 1029 1030 1031 1032 1033 1034 1035 1036 1037
        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]
1038
        gdb.execute("maint packet sal%s,%s,%s" % (cmd,fromAddr, toAddr))
1039 1040

SalCommand()
hjk's avatar
hjk committed
1041

1042

hjk's avatar
hjk committed
1043 1044 1045 1046 1047 1048
#######################################################################
#
# The Dumper Class
#
#######################################################################

1049

hjk's avatar
hjk committed
1050 1051 1052
class Dumper:
    def __init__(self):
        self.output = ""
1053 1054 1055 1056 1057 1058 1059 1060 1061
        self.currentChildType = ""
        self.currentChildNumChild = -1
        self.currentMaxNumChilds = -1
        self.currentNumChilds = -1
        self.currentValue = None
        self.currentValuePriority = -100
        self.currentValueEncoding = None
        self.currentType = None
        self.currentTypePriority = -100
hjk's avatar
hjk committed
1062 1063 1064 1065 1066

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

    def putField(self, name, value):
hjk's avatar
hjk committed
1067
        self.put('%s="%s",' % (name, value))
hjk's avatar
hjk committed
1068 1069

    def beginItem(self, name):
1070
        self.put('%s="' % name)
hjk's avatar
hjk committed
1071 1072

    def endItem(self):
hjk's avatar
hjk committed
1073
        self.put('",')
hjk's avatar
hjk committed
1074

1075
    def childRange(self):
1076
        return xrange(qmin(self.currentMaxNumChilds, self.currentNumChilds))
1077

hjk's avatar
hjk committed
1078 1079
    # convenience
    def putItemCount(self, count):
hjk's avatar
hjk committed
1080
        self.put('value="<%s items>",' % count)
hjk's avatar
hjk committed
1081 1082

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

1085 1086 1087 1088 1089
    def putType(self, type, priority = 0):
        # higher priority values override lower ones 
        if priority >= self.currentTypePriority:
            self.currentType = type
            self.currentTypePriority = priority
hjk's avatar
hjk committed
1090

1091 1092 1093
    def putAddress(self, addr):
        self.put('addr="%s",' % cleanAddress(addr))

hjk's avatar
hjk committed
1094
    def putNumChild(self, numchild):
1095 1096
        #warn("NUM CHILD: '%s' '%s'" % (numchild, self.currentChildNumChild))
        if numchild != self.currentChildNumChild:
hjk's avatar
hjk committed
1097
            self.put('numchild="%s",' % numchild)
hjk's avatar
hjk committed
1098

1099 1100 1101 1102 1103 1104
    def putValue(self, value, encoding = None, priority = 0):
        # higher priority values override lower ones 
        if priority >= self.currentValuePriority:
            self.currentValue = value
            self.currentValuePriority = priority
            self.currentValueEncoding = encoding
1105

1106
    def putPointerValue(self, value):
1107
        # Use a lower priority
1108 1109
        self.putValue("0x%x" % value.dereference().cast(
            gdb.lookup_type("unsigned long")), None, -1)
1110

1111
    def putStringValue(self, value):
1112
        if value is None:
hjk's avatar
hjk committed
1113
            self.put('value="<not available>",')
1114 1115
        else:
            str = encodeString(value)
1116
            self.put('valueencoded="%d",value="%s",' % (Hex4EncodedLittleEndian, str))
1117

1118 1119 1120 1121 1122 1123 1124 1125
    def putDisplay(self, format, value = None, cmd = None):
        self.put('editformat="%s",' % format)
        if cmd is None:
            if not value is None:
                self.put('editvalue="%s",' % value)
        else:
            self.put('editvalue="%s|%s",' % (cmd, value))

1126 1127
    def putByteArrayValue(self, value):
        str = encodeByteArray(value)
1128
        self.put('valueencoded="%d",value="%s",' % (Hex2EncodedLatin1, str))
1129

1130
    def putName(self, name):
hjk's avatar
hjk committed
1131
        self.put('name="%s",' % name)
1132

hjk's avatar
hjk committed
1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145
    def isExpanded(self, item):
        #warn("IS EXPANDED: %s in %s" % (item.iname, self.expandedINames))
        if item.iname is None:
            raise "Illegal iname 'None'"
        if item.iname.startswith("None"):
            raise "Illegal iname '%s'" % item.iname
        #warn("   --> %s" % (item.iname in self.expandedINames))
        return item.iname in self.expandedINames

    def isExpandedIName(self, iname):
        return iname in self.expandedINames

    def stripNamespaceFromType(self, typeobj):
1146 1147 1148 1149 1150
        # This breaks for dumpers type names containing '__star'.
        # But this should not happen as identifiers containing two
        # subsequent underscores are reserved for the implemention.
        if typeobj.code == gdb.TYPE_CODE_PTR:
            return self.stripNamespaceFromType(typeobj.target()) + "__star"
hjk's avatar
hjk committed
1151 1152 1153 1154
        type = stripClassTag(str(typeobj))
        if len(self.ns) > 0 and type.startswith(self.ns):
            type = type[len(self.ns):]
        pos = type.find("<")
1155 1156 1157 1158 1159
        # FIXME: make it recognize  foo<A>::bar<B>::iterator?
        while pos != -1:
            pos1 = type.rfind(">", pos)
            type = type[0:pos] + type[pos1+1:]
            pos = type.find("<")
hjk's avatar
hjk committed
1160 1161 1162 1163 1164 1165 1166 1167 1168 1169
        return type

    def isMovableType(self, type):
        if type.code == gdb.TYPE_CODE_PTR:
            return True
        if isSimpleType(type):
            return True
        return self.stripNamespaceFromType(type) in movableTypes

    def putIntItem(self, name, value):
1170 1171 1172 1173 1174
        with SubItem(self):
            self.putName(name)
            self.putValue(value)
            self.putType("int")
            self.putNumChild(0)
hjk's avatar
hjk committed
1175 1176

    def putBoolItem(self, name, value):
1177 1178 1179 1180 1181
        with SubItem(self):
            self.putName(name)
            self.putValue(value)
            self.putType("bool")
            self.putNumChild(0)
hjk's avatar
hjk committed
1182

1183
    def itemFormat(self, item):
1184
        format = self.formats.get(str(cleanAddress(item.value.address)))
1185 1186 1187 1188
        if format is None:
            format = self.typeformats.get(stripClassTag(str(item.value.type)))
        return format

hjk's avatar
hjk committed
1189
    def putItem(self, item):
1190 1191
        with SubItem(self):
            self.putItemHelper(item)
hjk's avatar
hjk committed
1192 1193

    def putCallItem(self, name, item, func):
1194 1195
        result = call(item.value, func)
        self.putItem(Item(result, item.iname, name, name))
hjk's avatar
hjk committed
1196

1197
    def putItemHelper(self, item):
hjk's avatar
hjk committed
1198 1199
        name = getattr(item, "name", None)
        if not name is None:
1200
            self.putName(name)
hjk's avatar
hjk committed
1201

1202 1203 1204 1205 1206 1207 1208 1209
        if item.value is None:
            # Happens for non-available watchers in gdb versions that
            # need to use gdb.execute instead of gdb.parse_and_eval
            self.putValue("<not available>")
            self.putType("<unknown>")
            self.putNumChild(0)
            return

hjk's avatar
hjk committed
1210
        # FIXME: Gui shows references stripped?
1211
        #warn(" ");
hjk's avatar
hjk committed
1212
        #warn("REAL INAME: %s " % item.iname)
1213
        #warn("REAL NAME: %s " % name)
hjk's avatar
hjk committed
1214
        #warn("REAL TYPE: %s " % item.value.type)
1215
        #warn("REAL VALUE: %s " % item.value)
1216 1217
        #try:
        #    warn("REAL VALUE: %s " % item.value)
1218 1219
        #except:
        #    #UnicodeEncodeError:
1220
        #    warn("REAL VALUE: <unprintable>")
hjk's avatar
hjk committed
1221 1222 1223 1224 1225

        value = item.value
        type = value.type

        if type.code == gdb.TYPE_CODE_REF:
1226 1227 1228 1229 1230 1231 1232 1233 1234
            try:
                # This throws "RuntimeError: Attempt to dereference a
                # generic pointer." with MinGW's gcc 4.5 when it "identifies"
                # a "QWidget &" as "void &".
                type = type.target()
                value = value.cast(type)
            except RuntimeError:
                value = item.value
                type = value.type
hjk's avatar
hjk committed
1235 1236 1237 1238 1239 1240

        if type.code == gdb.TYPE_CODE_TYPEDEF:
            type = type.target()

        strippedType = self.stripNamespaceFromType(
            type.strip_typedefs().unqualified()).replace("::", "__")
1241

hjk's avatar
hjk committed
1242 1243 1244 1245
        #warn(" STRIPPED: %s" % strippedType)
        #warn(" DUMPERS: %s" % self.dumpers)
        #warn(" DUMPERS: %s" % (strippedType in self.dumpers))

1246
        if isSimpleType(type.unqualified()):
1247 1248
            #warn("IS SIMPLE: %s " % type)
            self.putType(item.value.type)
1249 1250