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

import sys
import gdb
5
import base64
6
import __builtin__
7
import os
8

9

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

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

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

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

hjk's avatar
hjk committed
46 47 48
verbosity = 0
verbosity = 1

49 50 51 52 53
# Some "Enums"

# Encodings

Unencoded8Bit, \
54 55 56 57 58 59 60 61 62 63 64 65
Base64Encoded8BitWithQuotes, \
Base64Encoded16BitWithQuotes, \
Base64Encoded32BitWithQuotes, \
Base64Encoded16Bit, \
Base64Encoded8Bit, \
Hex2EncodedLatin1, \
Hex4EncodedLittleEndian, \
Hex8EncodedLittleEndian, \
Hex2EncodedUtf8, \
Hex8EncodedBigEndian, \
Hex4EncodedBigEndian \
    = range(12)
66 67

# Display modes
68 69 70 71 72 73
StopDisplay, \
DisplayImage1, \
DisplayString, \
DisplayImage, \
DisplayProcess \
    = range(5)
74 75


76 77 78 79 80
def select(condition, if_expr, else_expr):
    if condition:
        return if_expr
    return else_expr

81 82 83 84 85
def qmin(n, m):
    if n < m:
        return n
    return m

hjk's avatar
hjk committed
86
def isGoodGdb():
87 88
    #return gdb.VERSION.startswith("6.8.50.2009") \
    #   and gdb.VERSION != "6.8.50.20090630-cvs"
89
    return 'parse_and_eval' in __builtin__.dir(gdb)
hjk's avatar
hjk committed
90

91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128
typeCache = {}

def lookupType(typestring):
    type = typeCache.get(typestring)
    #warn("LOOKUP 1: %s -> %s" % (typestring, type))
    if type is None:
        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[-5:]
            elif ts.endswith("volatile"):
                ts = ts[-8:]
            else:
                break
        try:
            #warn("LOOKING UP '%s'" % ts)
            type = gdb.lookup_type(ts)
        except:
            # Can throw "RuntimeError: No type named class Foo."
            #warn("LOOKING UP '%s' FAILED" % ts)
            pass
        #warn("  RESULT: '%s'" % type)
        #if not type is None:
        #    warn("  FIELDS: '%s'" % type.fields())
        typeCache[typestring] = type
    return type

129 130 131
def cleanType(type):
    return lookupType(str(type))

132
def cleanAddress(addr):
133 134
    if addr is None:
        return "<no address>"
135 136
    # We cannot use str(addr) as it yields rubbish for char pointers
    # that might trigger Unicode encoding errors.
137
    return addr.cast(lookupType("void").pointer())
138

hjk's avatar
hjk committed
139 140 141 142
# Workaround for gdb < 7.1
def numericTemplateArgument(type, position):
    try:
        return int(type.template_argument(position))
143
    except RuntimeError, error:
hjk's avatar
hjk committed
144 145 146 147
        # ": No type named 30."
        msg = str(error)
        return int(msg[14:-1])

148
def parseAndEvaluate(exp):
hjk's avatar
hjk committed
149
    if isGoodGdb():
150 151 152 153
        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")
154 155 156 157
    try:
        gdb.execute("print %s" % exp)
    except:
        gdb.execute("set logging off")
158
        gdb.execute("set logging redirect off")
159
        return None
160
    gdb.execute("set logging off")
161
    gdb.execute("set logging redirect off")
162 163
    return gdb.history(0)

164

165
def catchCliOutput(command):
166
    filename, file = createTempFile()
167 168 169 170 171 172 173 174
    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")
175
    temp = open(filename, "r")
176
    lines = []
177
    for line in temp:
178
        lines.append(line)
179 180
    temp.close()
    removeTempFile(filename, file)
181 182 183
    return lines


184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225
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
226
        self.d.currentValue = "<not accessible>"
227
        self.d.currentValuePriority = -100
228 229
        self.d.currentValueEncoding = None
        self.d.currentType = ""
230
        self.d.currentTypePriority = -100
231 232 233 234 235 236

    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)
237 238 239 240 241 242 243
        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:
244
                self.d.put('valueencoded="%d",' % self.d.currentValueEncoding)
245
            if not self.d.currentValue is None:
246
                self.d.put('value="%s",' % self.d.currentValue)
247 248
        except:
            pass
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 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311
        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


312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335
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"
336
    #6       breakpoint     keep y   0xb6cf18e5 <__cxa_throw+5>\n"
337
    lines = catchCliOutput("info break")
338 339 340 341

    lines.reverse()
    bp = Breakpoint()
    for line in lines:
342 343
        if len(line) == 0 or line.startswith(" "):
            continue
344 345 346 347 348 349 350 351 352 353
        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")
354
        posin = line.find(" in ", pos0x)
355
        poslt = line.find(" <", pos0x)
356
        posat = line.find(" at ", posin)
357
        poscol = line.find(":", posat)
358 359 360 361 362 363
        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)]
364 365 366
        # Take "no address" as indication that the bp is pending.
        #if line.find("<PENDING>") >= 0:
        #    bp.address.append("<PENDING>")
367 368 369 370 371 372 373 374 375 376 377 378
        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
379 380 381 382
        d.put('bkpt={number="%s",' % bp.number)
        d.put('type="breakpoint",')
        d.put('disp="keep",')
        d.put('enabled="y",')
383
        for address in bp.address:
hjk's avatar
hjk committed
384
            d.put('addr="%s",' % address)
385
        if not bp.function is None:
hjk's avatar
hjk committed
386
            d.put('func="%s",' % bp.function)
387
        if not bp.filename is None:
hjk's avatar
hjk committed
388
            d.put('file="%s",' % bp.filename)
389
        if not bp.fullname is None:
hjk's avatar
hjk committed
390
            d.put('fullname="%s",' % bp.fullname)
391
        if not bp.linenumber is None:
hjk's avatar
hjk committed
392
            d.put('line="%s",' % bp.linenumber)
393
        if not bp.condition is None:
hjk's avatar
hjk committed
394
            d.put('cond="%s",' % bp.condition)
395
        if not bp.fullname is None:
hjk's avatar
hjk committed
396
            d.put('fullname="%s",' % bt.fullname)
397
        if not bp.times is None:
hjk's avatar
hjk committed
398
            d.put('times="1",' % bp.times)
399
        #d.put('original-location="-"')
hjk's avatar
hjk committed
400
        d.put('},')
401 402 403
        bp = Breakpoint()


404 405 406 407 408 409 410 411 412 413 414
# 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


415
def listOfLocals(varList):
416 417 418 419
    try:
        frame = gdb.selected_frame()
        #warn("FRAME %s: " % frame)
    except RuntimeError:
420
        warn("FRAME NOT ACCESSIBLE")
hjk's avatar
hjk committed
421
        return []
422

423
    # gdb-6.8-symbianelf fails here
424
    hasBlock = 'block' in __builtin__.dir(frame)
425

426
    items = []
427 428
    #warn("HAS BLOCK: %s" % hasBlock);
    #warn("IS GOOD GDB: %s" % isGoodGdb());
429
    if hasBlock and isGoodGdb():
430
        #warn("IS GOOD: %s " % varList)
431 432 433 434 435 436 437
        try:
            block = frame.block()
            #warn("BLOCK: %s " % block)
        except:
            warn("BLOCK NOT ACCESSIBLE")
            return items

438 439 440 441 442 443
        while True:
            if block is None:
                warn("UNEXPECTED 'None' BLOCK")
                break
            for symbol in block:
                name = symbol.print_name
444

445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467
                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
468
        # Assuming gdb 7.0 release or 6.8-symbianelf.
469
        filename, file = createTempFile()
470
        #warn("VARLIST: %s " % varList)
471
        #warn("FILENAME: %s " % filename)
hjk's avatar
hjk committed
472 473
        gdb.execute("set logging off")
        gdb.execute("set logging redirect off")
474 475 476
        gdb.execute("set logging file %s" % filename)
        gdb.execute("set logging redirect on")
        gdb.execute("set logging on")
477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493
        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
494 495
        gdb.execute("set logging off")
        gdb.execute("set logging redirect off")
496

497 498 499 500 501 502 503 504 505 506 507 508 509
        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
510
        removeTempFile(filename, file)
511 512 513
        #warn("VARLIST: %s " % varList)
        for name in varList:
            #warn("NAME %s " % name)
514 515 516 517
            item = Item(0, "local", name, name)
            try:
                item.value = frame.read_var(name)  # this is a gdb value
            except RuntimeError:
518 519
                pass
                #continue
520 521 522 523 524
            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 [...]
525
                # that break subsequent parsing. Chicken out and take the
526 527
                # next "usable" line.
                continue
528 529 530 531 532
            items.append(item)

    return items


533
def value(expr):
534
    value = parseAndEvaluate(expr)
535 536 537 538 539
    try:
        return int(value)
    except:
        return str(value)

540

hjk's avatar
hjk committed
541
def isSimpleType(typeobj):
542 543
    if typeobj.code == gdb.TYPE_CODE_PTR:
        return False
hjk's avatar
hjk committed
544 545 546 547 548 549 550 551
    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 ") \
552
        or type == "signed" or type.startswith("signed ") \
hjk's avatar
hjk committed
553 554
        or type == "unsigned" or type.startswith("unsigned ")

555

hjk's avatar
hjk committed
556 557 558 559 560 561 562 563 564
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):
565 566
    if True or verbosity > 0:
        print "XXX: %s\n" % message.encode("latin1")
hjk's avatar
hjk committed
567 568 569 570 571 572
    pass

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

573 574 575 576 577
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
578
#def couldBePointer(p, align):
579
#    type = lookupType("unsigned int")
hjk's avatar
hjk committed
580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598
#    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):
599 600 601 602
    # 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 ")
603
    return p.cast(lookupType("void").pointer()) == 0
hjk's avatar
hjk committed
604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626

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:]
627 628
    elif type.startswith("struct "):
        return type[7:]
hjk's avatar
hjk committed
629 630 631
    return type

def checkPointerRange(p, n):
632
    for i in xrange(n):
hjk's avatar
hjk committed
633 634 635 636 637 638
        checkPointer(p)
        ++p

def call(value, func):
    #warn("CALL: %s -> %s" % (value, func))
    type = stripClassTag(str(value.type))
639
    if type.find(":") >= 0:
hjk's avatar
hjk committed
640 641 642
        type = "'" + type + "'"
    exp = "((%s*)%s)->%s" % (type, value.address, func)
    #warn("CALL: %s" % exp)
643 644 645 646 647
    result = None
    try:
        result = parseAndEvaluate(exp)
    except:
        pass
hjk's avatar
hjk committed
648 649 650
    #warn("  -> %s" % result)
    return result

651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672
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

673 674
def qtNamespace():
    try:
675
        type = str(parseAndEvaluate("&QString::null").type.target().unqualified())
676 677 678
        return type[0:len(type) - len("QString::null")]
    except RuntimeError:
        return ""
679 680 681
    except AttributeError:
        # Happens for none-Qt applications
        return ""
hjk's avatar
hjk committed
682

683 684 685 686 687 688 689
def findFirstZero(p, max):
    for i in xrange(max):
        if p.dereference() == 0:
            return i
        p = p + 1
    return -1

690 691

def extractCharArray(p, maxsize):
692
    t = lookupType("unsigned char").pointer()
693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715
    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)

716
def encodeCharArray(p, maxsize, size = -1):
717
    t = lookupType("unsigned char").pointer()
718
    p = p.cast(t)
719 720 721 722
    if size == -1:
        i = findFirstZero(p, maxsize)
    else:
        i = size
723
    limit = select(i < 0, maxsize, i)
724
    s = ""
725
    for i in xrange(limit):
726 727
        s += "%02x" % int(p.dereference())
        p += 1
728 729 730 731 732
    if i == maxsize:
        s += "2e2e2e"
    return s

def encodeChar2Array(p, maxsize):
733
    t = lookupType("unsigned short").pointer()
734 735 736 737 738 739 740 741 742 743 744 745
    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):
746
    t = lookupType("unsigned int").pointer()
747 748 749 750 751 752 753 754 755
    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"
756 757
    return s

758 759 760 761 762 763
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)
764
    checkRef(d_ptr["ref"])
765 766 767
    if size > 0:
        checkAccess(data, 4)
        checkAccess(data + size) == 0
768
    return encodeCharArray(data, size)
769 770 771 772 773 774 775 776 777

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
778
        checkAccess(data + size) == 0
779
    checkRef(d_ptr["ref"])
780 781
    p = gdb.Value(d_ptr["data"])
    s = ""
782
    for i in xrange(size):
783 784 785 786 787 788
        val = int(p.dereference())
        s += "%02x" % (val % 256)
        s += "%02x" % (val / 256)
        p += 1
    return s

789 790
def stripTypedefs(type):
    type = type.unqualified()
791 792 793 794
    while type.code == gdb.TYPE_CODE_TYPEDEF:
        type = type.strip_typedefs().unqualified()
    return type

795 796 797 798 799 800 801 802 803 804 805 806 807 808 809
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.
    #warn("TYPE 0: %s" % type)
    type = stripTypedefs(type)
    #warn("TYPE 1: %s" % type)
    type = lookupType(str(type))
    #warn("TYPE 2: %s" % type)
    fields = type.fields()
    #warn("FIELDS: %s" % fields)
    return fields

hjk's avatar
hjk committed
810 811 812 813 814 815 816
#######################################################################
#
# Item
#
#######################################################################

class Item:
817
    def __init__(self, value, parentiname, iname = None, name = None):
hjk's avatar
hjk committed
818
        self.value = value
819 820 821 822
        if iname is None:
            self.iname = parentiname
        else:
            self.iname = "%s.%s" % (parentiname, iname)
hjk's avatar
hjk committed
823 824 825
        self.name = name


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

# This is a mapping from 'type name' to 'display alternatives'.

qqDumpers = {}
qqFormats = {}


class SetupCommand(gdb.Command):
    """Setup Creator Pretty Printing"""

    def __init__(self):
        super(SetupCommand, self).__init__("bbsetup", gdb.COMMAND_OBSCURE)

    def invoke(self, args, from_tty):
        module = sys.modules[__name__]
        for key, value in module.__dict__.items():
            if key.startswith("qdump__"):
                name = key[7:]
                qqDumpers[name] = value
                qqFormats[name] = qqFormats.get(name, "");
            elif key.startswith("qform__"):
                name = key[7:]
                formats = ""
                try:
                    formats = value()
                except:
                    pass
                qqFormats[name] = formats
        result = "dumpers=["
        # Too early: ns = qtNamespace()
        for key, value in qqFormats.items():
            result += '{type="%s",formats="%s"},' % (key, value)
        result += ']'
        #result += '],namespace="%s"' % ns
        print(result)

SetupCommand()


hjk's avatar
hjk committed
870 871 872 873 874 875 876
#######################################################################
#
# FrameCommand
#
#######################################################################

class FrameCommand(gdb.Command):
877
    """Do fancy stuff."""
hjk's avatar
hjk committed
878 879 880 881

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

882 883 884 885 886
    def invoke(self, args, from_tty):
        options = []
        varList = []
        typeformats = {}
        formats = {}
887
        watchers = ""
888
        expandedINames = ""
889 890 891 892 893
        for arg in args.split(' '):
            pos = arg.find(":") + 1
            if arg.startswith("options:"):
                options = arg[pos:].split(",")
            elif arg.startswith("vars:"):
894 895
                if len(arg[pos:]) > 0:
                    varList = arg[pos:].split(",")
896 897 898 899 900 901 902 903 904 905 906 907 908 909 910
            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)
911

912
        useFancy = "fancy" in options
913 914

        #warn("VARIABLES: %s" % varList)
hjk's avatar
hjk committed
915 916 917 918
        #warn("EXPANDED INAMES: %s" % expandedINames)
        module = sys.modules[__name__]
        self.dumpers = {}

919 920 921
        if False:
            dumpers = ""
            typeformats = ""
hjk's avatar
hjk committed
922
            for key, value in module.__dict__.items():
923
                if key.startswith("qdump__"):
924 925
                    dumpers += '"' + key[7:] + '",'
            output = "dumpers=[%s]," % dumpers
hjk's avatar
hjk committed
926
            #output += "qtversion=[%d,%d,%d]"
927
            #output += "qtversion=[4,6,0],"
hjk's avatar
hjk committed
928 929 930 931 932 933 934
            output += "namespace=\"%s\"," % qtNamespace()
            output += "dumperversion=\"2.0\","
            output += "sizes=[],"
            output += "expressions=[]"
            output += "]"
            print output
            return
935

936

hjk's avatar
hjk committed
937 938
        if useFancy:
            for key, value in module.__dict__.items():
939 940
                if key.startswith("qdump__"):
                    self.dumpers[key[7:]] = value
hjk's avatar
hjk committed
941 942 943

        d = Dumper()
        d.dumpers = self.dumpers
944 945
        d.typeformats = typeformats
        d.formats = formats
946
        d.useFancy = useFancy
947
        d.passExceptions = "pe" in options
948
        d.autoDerefPointers = "autoderef" in options
949
        d.ns = qtNamespace()
950
        d.expandedINames = expandedINames
hjk's avatar
hjk committed
951 952
        #warn(" NAMESPACE IS: '%s'" % d.ns)

953 954 955
        #
        # Locals
        #
956
        for item in listOfLocals(varList):
957
          with OutputSafer(d, "", ""):
958
            d.anonNumber = -1
959
            #warn("ITEM NAME %s: " % item.name)
960 961 962
            try:
                #warn("ITEM VALUE %s: " % item.value)
                # Throw on funny stuff, catch below.
hjk's avatar
hjk committed
963 964 965 966
                # Unfortunately, this fails also with a "Unicode encoding error"
                # in testArray().
                #dummy = str(item.value)
                pass
967 968
            except:
                # Locals with failing memory access.
969 970 971 972 973 974 975
                with SubItem(d):
                    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"');
976
                continue
977 978 979 980

            type = item.value.type
            if type.code == gdb.TYPE_CODE_PTR \
                    and item.name == "argv" and str(type) == "char **":
981
                # Special handling for char** argv.
982 983
                n = 0
                p = item.value
984 985 986 987 988
                # p is 0 for "optimized out" cases.
                if not isNull(p):
                    while not isNull(p.dereference()) and n <= 100:
                        p += 1
                        n += 1
989

990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004
                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()
1005 1006

            else:
1007
                # A "normal" local variable or parameter.
1008
                try:
1009
                   addr = cleanAddress(item.value.address)
1010 1011 1012 1013
                   with SubItem(d):
                       d.put('iname="%s",' % item.iname)
                       d.put('addr="%s",' % addr)
                       d.putItemHelper(item)
1014
                except AttributeError:
1015 1016
                    # Thrown by cleanAddress with message "'NoneType' object
                    # has no attribute 'cast'" for optimized-out values.
1017 1018 1019 1020 1021 1022
                    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)
1023

1024 1025 1026
        #
        # Watchers
        #
1027 1028 1029 1030 1031
        with OutputSafer(d, ",", ""):
            if len(watchers) > 0:
                for watcher in watchers.split("##"):
                    (exp, iname) = watcher.split("#")
                    self.handleWatch(d, exp, iname)
hjk's avatar
hjk committed
1032

1033 1034 1035
        #
        # Breakpoints
        #
1036 1037 1038
        #listOfBreakpoints(d)

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

1041

1042
    def handleWatch(self, d, exp, iname):
1043
        exp = str(exp)
1044
        escapedExp = exp.replace('"', '\\"');
1045
        #warn("HANDLING WATCH %s, INAME: '%s'" % (exp, iname))
1046 1047
        if exp.startswith("[") and exp.endswith("]"):
            #warn("EVAL: EXP: %s" % exp)
1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072
            with SubItem(d):
                d.putField("iname", iname)
                d.putField("name", escapedExp)
                d.putField("exp", escapedExp)
                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:
                            self.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):
1073
            d.putField("iname", iname)
1074 1075
            d.putField("name", escapedExp)
            d.putField("exp", escapedExp)
1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087
            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",')
1088

hjk's avatar
hjk committed
1089 1090 1091 1092

FrameCommand()


1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106
#######################################################################
#
# 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):
1107 1108
        (cmd, addr) = arg.split(",")
        lines = catchCliOutput("info line *" + addr)
1109 1110 1111 1112 1113 1114 1115 1116 1117 1118
        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]
1119
        gdb.execute("maint packet sal%s,%s,%s" % (cmd,fromAddr, toAddr))
1120 1121

SalCommand()
hjk's avatar
hjk committed
1122

1123

hjk's avatar
hjk committed
1124 1125 1126 1127 1128 1129
#######################################################################
#
# The Dumper Class
#
#######################################################################

1130

hjk's avatar
hjk committed
1131 1132 1133
class Dumper:
    def __init__(self):
        self.output = ""
1134 1135 1136 1137 1138 1139 1140 1141 1142
        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
1143 1144 1145 1146 1147

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

    def putField(self, name, value):
hjk's avatar
hjk committed
1148
        self.put('%s="%s",' % (name, value))
hjk's avatar
hjk committed
1149 1150

    def beginItem(self, name):
1151
        self.put('%s="' % name)
hjk's avatar
hjk committed
1152 1153

    def endItem(self):
hjk's avatar
hjk committed
1154
        self.put('",')
hjk's avatar
hjk committed
1155

1156
    def childRange(self):
1157
        return xrange(qmin(self.currentMaxNumChilds, self.currentNumChilds))
1158

1159
    # Convenience function.
hjk's avatar
hjk committed
1160
    def putItemCount(self, count):
1161 1162
        # This needs to override the default value, so don't use 'put' directly.
        self.putValue('<%s items>' % count)
hjk's avatar
hjk committed
1163 1164

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

1167
    def putType(self, type, priority = 0):
1168
        # Higher priority values override lower ones.
1169 1170 1171
        if priority >= self.currentTypePriority:
            self.currentType = type
            self.currentTypePriority = priority
hjk's avatar
hjk committed
1172

1173 1174 1175
    def putAddress(self, addr):
        self.put('addr="%s",' % cleanAddress(addr))

hjk's avatar
hjk committed
1176
    def putNumChild(self, numchild):