dumper.py 53.1 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
typeCache = {}

def lookupType(typestring):
    type = typeCache.get(typestring)
hjk's avatar
hjk committed
95
    #warn("LOOKUP 1: %s -> %s" % (typestring, type))
96
    if type is None:
hjk's avatar
hjk committed
97 98 99 100 101 102 103 104 105 106 107
        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:]
108 109
            elif ts.startswith("enum "):
                ts = ts[5:]
hjk's avatar
hjk committed
110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125
            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())
126
        typeCache[typestring] = type
127 128 129 130
    if type is None:
        # could be gdb.lookup_type("char[3]") generating
        # "RuntimeError: No type named char[3]"
        pass
131 132
    return type

hjk's avatar
hjk committed
133 134 135
def cleanType(type):
    return lookupType(str(type))

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

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

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

168

169
def catchCliOutput(command):
170
    filename, file = createTempFile()
171 172 173 174 175
    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")
176 177 178 179 180 181 182 183 184
    msg = ""
    try:
        gdb.execute(command)
    except RuntimeError, error:
        # For the first phase of core file loading this yield
        # "No symbol table is loaded.  Use the \"file\" command."
        msg = str(error)
    except:
        msg = "Unknown error";
185 186
    gdb.execute("set logging off")
    gdb.execute("set logging redirect off")
187 188
    if len(msg):
        warn("CLI ERROR: %s " % msg)
189
    temp = open(filename, "r")
190
    lines = []
191
    for line in temp:
192
        lines.append(line)
193 194
    temp.close()
    removeTempFile(filename, file)
195 196 197
    return lines


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 226 227 228 229 230 231 232 233 234 235 236 237 238 239
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
240
        self.d.currentValue = "<not accessible>"
241
        self.d.currentValuePriority = -100
242 243
        self.d.currentValueEncoding = None
        self.d.currentType = ""
244
        self.d.currentTypePriority = -100
245 246 247 248 249 250

    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)
251
        try:
252
            #warn("TYPE VALUE: %s" % self.d.currentValue)
253 254 255 256 257
            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:
258
                self.d.put('valueencoded="%d",' % self.d.currentValueEncoding)
259
            if not self.d.currentValue is None:
260
                self.d.put('value="%s",' % self.d.currentValue)
261 262
        except:
            pass
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 312 313 314 315 316 317 318 319 320 321 322 323 324 325
        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


326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349
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"
350
    #6       breakpoint     keep y   0xb6cf18e5 <__cxa_throw+5>\n"
351
    lines = catchCliOutput("info break")
352 353 354 355

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


418 419 420 421 422 423 424 425 426 427 428
# 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


429
def listOfLocals(varList):
430 431 432 433
    try:
        frame = gdb.selected_frame()
        #warn("FRAME %s: " % frame)
    except RuntimeError:
434
        warn("FRAME NOT ACCESSIBLE")
hjk's avatar
hjk committed
435
        return []
436

437
    # gdb-6.8-symbianelf fails here
438
    hasBlock = 'block' in __builtin__.dir(frame)
439

440
    items = []
441 442
    #warn("HAS BLOCK: %s" % hasBlock);
    #warn("IS GOOD GDB: %s" % isGoodGdb());
443
    if hasBlock and isGoodGdb():
444
        #warn("IS GOOD: %s " % varList)
445 446 447 448 449 450 451
        try:
            block = frame.block()
            #warn("BLOCK: %s " % block)
        except:
            warn("BLOCK NOT ACCESSIBLE")
            return items

452 453 454 455 456 457
        while True:
            if block is None:
                warn("UNEXPECTED 'None' BLOCK")
                break
            for symbol in block:
                name = symbol.print_name
458

459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481
                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
482
        # Assuming gdb 7.0 release or 6.8-symbianelf.
483
        filename, file = createTempFile()
484
        #warn("VARLIST: %s " % varList)
485
        #warn("FILENAME: %s " % filename)
hjk's avatar
hjk committed
486 487
        gdb.execute("set logging off")
        gdb.execute("set logging redirect off")
488 489 490
        gdb.execute("set logging file %s" % filename)
        gdb.execute("set logging redirect on")
        gdb.execute("set logging on")
491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507
        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
508 509
        gdb.execute("set logging off")
        gdb.execute("set logging redirect off")
510

511 512 513 514 515 516 517 518 519 520 521 522 523
        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
524
        removeTempFile(filename, file)
525 526 527
        #warn("VARLIST: %s " % varList)
        for name in varList:
            #warn("NAME %s " % name)
528 529 530 531
            item = Item(0, "local", name, name)
            try:
                item.value = frame.read_var(name)  # this is a gdb value
            except RuntimeError:
532 533
                pass
                #continue
534 535 536 537 538
            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 [...]
539
                # that break subsequent parsing. Chicken out and take the
540 541
                # next "usable" line.
                continue
542 543 544 545 546
            items.append(item)

    return items


547
def value(expr):
548
    value = parseAndEvaluate(expr)
549 550 551 552 553
    try:
        return int(value)
    except:
        return str(value)

554

hjk's avatar
hjk committed
555
def isSimpleType(typeobj):
556 557
    if typeobj.code == gdb.TYPE_CODE_PTR:
        return False
hjk's avatar
hjk committed
558 559 560 561 562 563 564 565
    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 ") \
566
        or type == "signed" or type.startswith("signed ") \
hjk's avatar
hjk committed
567 568
        or type == "unsigned" or type.startswith("unsigned ")

569

hjk's avatar
hjk committed
570 571 572 573 574 575 576 577 578
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):
579 580
    if True or verbosity > 0:
        print "XXX: %s\n" % message.encode("latin1")
hjk's avatar
hjk committed
581 582 583 584 585 586
    pass

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

587 588 589 590 591
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
592
#def couldBePointer(p, align):
593
#    type = lookupType("unsigned int")
hjk's avatar
hjk committed
594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612
#    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):
613 614 615 616
    # 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 ")
617 618 619 620 621
    try:
        # Can fail with: "RuntimeError: Cannot access memory at address 0x5"
        return p.cast(lookupType("void").pointer()) == 0
    except:
        return False
hjk's avatar
hjk committed
622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644

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:]
hjk's avatar
hjk committed
645
    if type.startswith("struct "):
646
        return type[7:]
hjk's avatar
hjk committed
647
    if type.startswith("const "):
hjk's avatar
hjk committed
648
        return type[6:]
hjk's avatar
hjk committed
649
    if type.startswith("volatile "):
hjk's avatar
hjk committed
650
        return type[9:]
hjk's avatar
hjk committed
651 652 653
    return type

def checkPointerRange(p, n):
654
    for i in xrange(n):
hjk's avatar
hjk committed
655 656 657 658 659 660
        checkPointer(p)
        ++p

def call(value, func):
    #warn("CALL: %s -> %s" % (value, func))
    type = stripClassTag(str(value.type))
661
    if type.find(":") >= 0:
hjk's avatar
hjk committed
662 663 664
        type = "'" + type + "'"
    exp = "((%s*)%s)->%s" % (type, value.address, func)
    #warn("CALL: %s" % exp)
665 666 667 668 669
    result = None
    try:
        result = parseAndEvaluate(exp)
    except:
        pass
hjk's avatar
hjk committed
670 671 672
    #warn("  -> %s" % result)
    return result

673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694
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

695 696
def qtNamespace():
    try:
697
        str = catchCliOutput("ptype QString::Null")[0]
hjk's avatar
hjk committed
698
        # The result looks like:
699 700 701 702 703 704 705
        # "type = const struct myns::QString::Null {"
        # "    <no data fields>"
        # "}"
        pos1 = str.find("struct") + 7
        pos2 = str.find("QString::Null")
        return str[pos1:pos2]
    except:
706
        return ""
hjk's avatar
hjk committed
707

708 709 710 711 712 713 714
def findFirstZero(p, max):
    for i in xrange(max):
        if p.dereference() == 0:
            return i
        p = p + 1
    return -1

715
def extractCharArray(p, maxsize):
716
    t = lookupType("unsigned char").pointer()
717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739
    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)

740
def encodeCharArray(p, maxsize, size = -1):
741
    t = lookupType("unsigned char").pointer()
742
    p = p.cast(t)
743 744 745 746
    if size == -1:
        i = findFirstZero(p, maxsize)
    else:
        i = size
747
    limit = select(i < 0, maxsize, i)
748
    s = ""
749
    for i in xrange(limit):
750 751
        s += "%02x" % int(p.dereference())
        p += 1
752 753 754 755 756
    if i == maxsize:
        s += "2e2e2e"
    return s

def encodeChar2Array(p, maxsize):
757
    t = lookupType("unsigned short").pointer()
758 759 760 761 762 763 764 765 766 767 768 769
    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):
770
    t = lookupType("unsigned int").pointer()
771 772 773 774 775 776 777 778 779
    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"
780 781
    return s

782 783 784 785 786 787
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)
788
    checkRef(d_ptr["ref"])
789 790 791
    if size > 0:
        checkAccess(data, 4)
        checkAccess(data + size) == 0
792
    return encodeCharArray(data, size)
793 794 795 796 797 798 799 800 801

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
802
        checkAccess(data + size) == 0
803
    checkRef(d_ptr["ref"])
804 805
    p = gdb.Value(d_ptr["data"])
    s = ""
806
    for i in xrange(size):
807 808 809 810 811 812
        val = int(p.dereference())
        s += "%02x" % (val % 256)
        s += "%02x" % (val / 256)
        p += 1
    return s

hjk's avatar
hjk committed
813 814
def stripTypedefs(type):
    type = type.unqualified()
815 816 817 818
    while type.code == gdb.TYPE_CODE_TYPEDEF:
        type = type.strip_typedefs().unqualified()
    return type

hjk's avatar
hjk committed
819 820 821 822 823 824
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
825
    #warn("TYPE 0: %s" % type)
hjk's avatar
hjk committed
826 827
    type = stripTypedefs(type)
    #warn("TYPE 1: %s" % type)
828 829 830 831
    # This fails for arrays. See comment in lookupType.
    type2 = lookupType(str(type))
    if not type2 is None:
        type = type2
hjk's avatar
hjk committed
832 833
    #warn("TYPE 2: %s" % type)
    fields = type.fields()
hjk's avatar
hjk committed
834
    #warn("FIELDS: %s" % fields)
hjk's avatar
hjk committed
835 836
    return fields

hjk's avatar
hjk committed
837 838 839 840 841 842 843
#######################################################################
#
# Item
#
#######################################################################

class Item:
844
    def __init__(self, value, parentiname, iname = None, name = None):
hjk's avatar
hjk committed
845
        self.value = value
846 847 848 849
        if iname is None:
            self.iname = parentiname
        else:
            self.iname = "%s.%s" % (parentiname, iname)
hjk's avatar
hjk committed
850 851 852
        self.name = name


853 854 855 856 857 858 859 860 861 862
#######################################################################
#
# SetupCommand
#
#######################################################################

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

qqDumpers = {}
qqFormats = {}
863
qqNs = ""
864 865 866 867 868 869 870 871 872


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):
873
        print bbsetup()
874 875 876

SetupCommand()

877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898
def bbsetup():
    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=["
    qqNs = qtNamespace()
    for key, value in qqFormats.items():
        result += '{type="%s",formats="%s"},' % (key, value)
    result += '],namespace="%s"' % qqNs
    return result

899

hjk's avatar
hjk committed
900 901 902 903 904 905 906
#######################################################################
#
# FrameCommand
#
#######################################################################

class FrameCommand(gdb.Command):
907
    """Do fancy stuff."""
hjk's avatar
hjk committed
908 909 910 911

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

912
    def invoke(self, args, from_tty):
913
        if args.startswith("options:profile,"):
914 915
            import cProfile
            cProfile.run('bb("%s")' % args, "/tmp/bbprof")
916 917 918
            # Examine with:
            # import bstats
            # pstats.Stats('bbprof').sort_stats('time').print_stats()
919 920
        else:
            bb(args)
921

922
FrameCommand()
923

924
def bb(args):
925
    Dumper(args)
hjk's avatar
hjk committed
926 927


928 929 930 931 932 933 934 935 936 937 938 939 940 941
#######################################################################
#
# 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):
942 943
        (cmd, addr) = arg.split(",")
        lines = catchCliOutput("info line *" + addr)
944 945 946 947 948 949 950 951 952 953
        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]
954
        gdb.execute("maint packet sal%s,%s,%s" % (cmd,fromAddr, toAddr))
955 956

SalCommand()
hjk's avatar
hjk committed
957

958

hjk's avatar
hjk committed
959 960 961 962 963 964
#######################################################################
#
# The Dumper Class
#
#######################################################################

965

hjk's avatar
hjk committed
966
class Dumper:
967
    def __init__(self, args):
hjk's avatar
hjk committed
968
        self.output = ""
969 970 971 972 973 974 975 976 977
        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
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 1009 1010 1011 1012 1013 1014
        self.typeformats = {}
        self.formats = {}
        self.expandedINames = ""

        options = []
        varList = []
        watchers = ""
        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:"):
                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
1015 1016
        #self.ns = qqNs
        self.ns = qtNamespace()
1017 1018 1019 1020 1021 1022 1023 1024 1025 1026

        #warn("NAMESPACE: '%s'" % self.ns)
        #warn("VARIABLES: %s" % varList)
        #warn("EXPANDED INAMES: %s" % self.expandedINames)
        module = sys.modules[__name__]

        #
        # Locals
        #
        locals = listOfLocals(varList);
1027 1028
        if "nolocals" in options:
            locals = []
1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051

        # 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:
          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.
1052
                # FIXME: Isn't this taken care off by the SubItem destructor?
1053
                with SubItem(self):
1054 1055 1056 1057
                    self.put('iname="%s",' % item.iname)
                    self.put('name="%s",' % item.name)
                    self.put('addr="<not accessible>",')
                    self.put('numchild="0"');
1058 1059
                    self.putValue("<not accessible>")
                    self.putType(item.value.type)
1060 1061 1062 1063 1064 1065 1066 1067
                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
1068 1069 1070 1071 1072 1073 1074 1075
                # 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
1076

1077
                with SubItem(self):
1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107
                    self.put('iname="%s",' % item.iname)
                    self.putName(item.name)
                    self.putItemCount(select(n <= 100, n, "> 100"))
                    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()
                                self.putItem(Item(value, item.iname, i, None))
                                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)
                       self.putItemHelper(item)
                except AttributeError:
                    # Thrown by cleanAddress with message "'NoneType' object
                    # has no attribute 'cast'" for optimized-out values.
                    with SubItem(d):
                        self.put('iname="%s",' % item.iname)
                        self.put('name="%s",' % item.name)
                        self.put('addr="<optimized out>",')
1108 1109
                        self.putValue("<optimized out>")
                        self.putType(item.value.type)
1110 1111 1112 1113 1114 1115 1116 1117

        #
        # Watchers
        #
        with OutputSafer(self, ",", ""):
            if len(watchers) > 0:
                for watcher in watchers.split("##"):
                    (exp, iname) = watcher.split("#")
1118
                    self.handleWatch(exp, iname)
1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135

        #
        # Breakpoints
        #
        #listOfBreakpoints(d)

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


    def handleWatch(self, 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)
            with SubItem(d):
1136 1137 1138
                self.put('iname="%s",', iname)
                self.put('name="%s",', escapedExp)
                self.put('exp="%s",', escapedExp)
1139 1140 1141 1142 1143 1144 1145 1146 1147
                try:
                    list = eval(exp)
                    self.putValue("")
                    self.putType(" ")
                    self.putNumChild(len(list))
                    # This is a list of expressions to evaluate
                    with Children(self, len(list)):
                        itemNumber = 0
                        for item in list:
1148
                            self.handleWatch(item, "%s.%d" % (iname, itemNumber))
1149 1150 1151 1152 1153 1154 1155 1156 1157 1158
                            itemNumber += 1
                except RuntimeError, error:
                    warn("EVAL: ERROR CAUGHT %s" % error)
                    self.putValue("<syntax error>")
                    self.putType(" ")
                    self.putNumChild(0)
                    with Children(self, 0):
                        pass
            return

1159
        with SubItem(self):
1160 1161 1162
            self.put('iname="%s",' % iname)
            self.put('name="%s",' % escapedExp)
            self.put('exp="%s",' % escapedExp)
1163 1164
            handled = False
            if exp == "<Edit>" or len(exp) == 0:
1165 1166 1167
                self.putValue(" ")
                self.putType(" ")
                self.putNumChild(0)
1168 1169 1170 1171 1172 1173 1174 1175
            else:
                try:
                    value = parseAndEvaluate(exp)
                    item = Item(value, iname, None, None)
                    if not value is None:
                        self.putAddress(value.address)
                    self.putItemHelper(item)
                except RuntimeError:
1176
                    pass
1177

hjk's avatar
hjk committed
1178 1179 1180 1181 1182

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

    def putField(self, name, value):
hjk's avatar
hjk committed
1183
        self.put('%s="%s",' % (name, value))
hjk's avatar
hjk committed
1184

1185
    def childRange(self):
1186
        return xrange(qmin(self.currentMaxNumChilds, self.currentNumChilds))
1187

1188
    # Convenience function.
hjk's avatar
hjk committed
1189
    def putItemCount(self, count):
1190 1191
        # This needs to override the default value, so don't use 'put' directly.
        self.putValue('<%s items>' % count)
hjk's avatar
hjk committed
1192 1193

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

1196
    def putType(self, type, priority = 0):
1197
        # Higher priority values override lower ones.
1198 1199 1200
        if priority >= self.currentTypePriority:
            self.currentType = type
            self.currentTypePriority = priority
hjk's avatar
hjk committed
1201

1202 1203 1204
    def putAddress(self, addr):
        self.put('addr="%s",' % cleanAddress(addr))