dumper.py 49.9 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 13 14 15 16 17

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

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

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

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

hjk's avatar
hjk committed
48 49 50
verbosity = 0
verbosity = 1

51 52 53 54 55
# Some "Enums"

# Encodings

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

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


78 79 80 81 82
def select(condition, if_expr, else_expr):
    if condition:
        return if_expr
    return else_expr

83 84 85 86 87
def qmin(n, m):
    if n < m:
        return n
    return m

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

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

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

109
def parseAndEvaluate(exp):
hjk's avatar
hjk committed
110
    if isGoodGdb():
111 112 113 114
        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")
115 116 117 118
    try:
        gdb.execute("print %s" % exp)
    except:
        gdb.execute("set logging off")
119
        gdb.execute("set logging redirect off")
120
        return None
121
    gdb.execute("set logging off")
122
    gdb.execute("set logging redirect off")
123 124
    return gdb.history(0)

125

126
def catchCliOutput(command):
127
    filename, file = createTempFile()
128 129 130 131 132 133 134 135
    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")
136
    temp = open(filename, "r")
137
    lines = []
138
    for line in temp:
139
        lines.append(line)
140 141
    temp.close()
    removeTempFile(filename, file)
142 143 144
    return lines


145 146 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
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
187
        self.d.currentValue = "<not accessible>"
188
        self.d.currentValuePriority = -100
189 190
        self.d.currentValueEncoding = None
        self.d.currentType = ""
191
        self.d.currentTypePriority = -100
192 193 194 195 196 197

    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)
198 199 200 201 202 203 204 205 206 207 208 209
        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
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 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
        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


273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296
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"
297
    #6       breakpoint     keep y   0xb6cf18e5 <__cxa_throw+5>\n"
298
    lines = catchCliOutput("info break")
299 300 301 302

    lines.reverse()
    bp = Breakpoint()
    for line in lines:
303 304
        if len(line) == 0 or line.startswith(" "):
            continue
305 306 307 308 309 310 311 312 313 314
        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")
315
        posin = line.find(" in ", pos0x)
316
        poslt = line.find(" <", pos0x)
317
        posat = line.find(" at ", posin)
318
        poscol = line.find(":", posat)
319 320 321 322 323 324
        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)]
325 326 327
        # Take "no address" as indication that the bp is pending.
        #if line.find("<PENDING>") >= 0:
        #    bp.address.append("<PENDING>")
328 329 330 331 332 333 334 335 336 337 338 339
        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
340 341 342 343
        d.put('bkpt={number="%s",' % bp.number)
        d.put('type="breakpoint",')
        d.put('disp="keep",')
        d.put('enabled="y",')
344
        for address in bp.address:
hjk's avatar
hjk committed
345
            d.put('addr="%s",' % address)
346
        if not bp.function is None:
hjk's avatar
hjk committed
347
            d.put('func="%s",' % bp.function)
348
        if not bp.filename is None:
hjk's avatar
hjk committed
349
            d.put('file="%s",' % bp.filename)
350
        if not bp.fullname is None:
hjk's avatar
hjk committed
351
            d.put('fullname="%s",' % bp.fullname)
352
        if not bp.linenumber is None:
hjk's avatar
hjk committed
353
            d.put('line="%s",' % bp.linenumber)
354
        if not bp.condition is None:
hjk's avatar
hjk committed
355
            d.put('cond="%s",' % bp.condition)
356
        if not bp.fullname is None:
hjk's avatar
hjk committed
357
            d.put('fullname="%s",' % bt.fullname)
358
        if not bp.times is None:
hjk's avatar
hjk committed
359
            d.put('times="1",' % bp.times)
360
        #d.put('original-location="-"')
hjk's avatar
hjk committed
361
        d.put('},')
362 363 364
        bp = Breakpoint()


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


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

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

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

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

406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428
                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
429
        # Assuming gdb 7.0 release or 6.8-symbianelf.
430
        filename, file = createTempFile()
431
        #warn("VARLIST: %s " % varList)
432
        #warn("FILENAME: %s " % filename)
hjk's avatar
hjk committed
433 434
        gdb.execute("set logging off")
        gdb.execute("set logging redirect off")
435 436 437
        gdb.execute("set logging file %s" % filename)
        gdb.execute("set logging redirect on")
        gdb.execute("set logging on")
438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454
        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
455 456
        gdb.execute("set logging off")
        gdb.execute("set logging redirect off")
457

458 459 460 461 462 463 464 465 466 467 468 469 470
        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
471
        removeTempFile(filename, file)
472 473 474
        #warn("VARLIST: %s " % varList)
        for name in varList:
            #warn("NAME %s " % name)
475 476 477 478
            item = Item(0, "local", name, name)
            try:
                item.value = frame.read_var(name)  # this is a gdb value
            except RuntimeError:
479 480
                pass
                #continue
481 482 483 484 485
            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 [...]
486
                # that break subsequent parsing. Chicken out and take the
487 488
                # next "usable" line.
                continue
489 490 491 492 493
            items.append(item)

    return items


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

501

hjk's avatar
hjk committed
502
def isSimpleType(typeobj):
503 504
    if typeobj.code == gdb.TYPE_CODE_PTR:
        return False
hjk's avatar
hjk committed
505 506 507 508 509 510 511 512
    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 ") \
513
        or type == "signed" or type.startswith("signed ") \
hjk's avatar
hjk committed
514 515
        or type == "unsigned" or type.startswith("unsigned ")

516

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

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

534 535 536 537 538
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
539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559
#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):
560 561 562 563
    # 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 ")
564
    return p.cast(gdb.lookup_type("void").pointer()) == 0
hjk's avatar
hjk committed
565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587

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:]
588 589
    elif type.startswith("struct "):
        return type[7:]
hjk's avatar
hjk committed
590 591 592
    return type

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

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

612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633
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

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

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

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

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)

677
def encodeCharArray(p, maxsize, size = -1):
678 679
    t = gdb.lookup_type("unsigned char").pointer()
    p = p.cast(t)
680 681 682 683
    if size == -1:
        i = findFirstZero(p, maxsize)
    else:
        i = size
684
    limit = select(i < 0, maxsize, i)
685
    s = ""
686
    for i in xrange(limit):
687 688
        s += "%02x" % int(p.dereference())
        p += 1
689 690 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
    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"
717 718
    return s

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

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

hjk's avatar
hjk committed
750 751 752 753 754 755 756
#######################################################################
#
# Item
#
#######################################################################

class Item:
757
    def __init__(self, value, parentiname, iname = None, name = None):
hjk's avatar
hjk committed
758
        self.value = value
759 760 761 762
        if iname is None:
            self.iname = parentiname
        else:
            self.iname = "%s.%s" % (parentiname, iname)
hjk's avatar
hjk committed
763 764 765 766 767 768 769 770 771 772 773 774 775 776 777
        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)

778 779 780 781 782
    def invoke(self, args, from_tty):
        options = []
        varList = []
        typeformats = {}
        formats = {}
783
        watchers = ""
784
        expandedINames = ""
785
        resultVarName = ""
786 787 788 789 790
        for arg in args.split(' '):
            pos = arg.find(":") + 1
            if arg.startswith("options:"):
                options = arg[pos:].split(",")
            elif arg.startswith("vars:"):
791 792
                if len(arg[pos:]) > 0:
                    varList = arg[pos:].split(",")
793 794
            elif arg.startswith("resultvarname:"):
                resultVarName = arg[pos:]
795 796 797 798 799 800 801 802 803 804 805 806 807 808 809
            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)
810

811
        useFancy = "fancy" in options
812 813

        #warn("VARIABLES: %s" % varList)
hjk's avatar
hjk committed
814 815 816 817
        #warn("EXPANDED INAMES: %s" % expandedINames)
        module = sys.modules[__name__]
        self.dumpers = {}

818 819 820
        if False:
            dumpers = ""
            typeformats = ""
hjk's avatar
hjk committed
821
            for key, value in module.__dict__.items():
822
                if key.startswith("qdump__"):
823 824
                    dumpers += '"' + key[7:] + '",'
            output = "dumpers=[%s]," % dumpers
hjk's avatar
hjk committed
825
            #output += "qtversion=[%d,%d,%d]"
826
            #output += "qtversion=[4,6,0],"
hjk's avatar
hjk committed
827 828 829 830 831 832 833
            output += "namespace=\"%s\"," % qtNamespace()
            output += "dumperversion=\"2.0\","
            output += "sizes=[],"
            output += "expressions=[]"
            output += "]"
            print output
            return
834

835

hjk's avatar
hjk committed
836 837
        if useFancy:
            for key, value in module.__dict__.items():
838 839
                if key.startswith("qdump__"):
                    self.dumpers[key[7:]] = value
hjk's avatar
hjk committed
840 841 842

        d = Dumper()
        d.dumpers = self.dumpers
843 844
        d.typeformats = typeformats
        d.formats = formats
845
        d.useFancy = useFancy
846
        d.passExceptions = "pe" in options
847
        d.autoDerefPointers = "autoderef" in options
848
        d.ns = qtNamespace()
849
        d.expandedINames = expandedINames
hjk's avatar
hjk committed
850 851
        #warn(" NAMESPACE IS: '%s'" % d.ns)

852 853 854
        #
        # Locals
        #
855 856 857 858 859 860 861 862 863 864 865 866
        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

        for item in locals:
867
          with OutputSafer(d, "", ""):
868
            d.anonNumber = -1
869
            #warn("ITEM NAME %s: " % item.name)
870 871 872
            try:
                #warn("ITEM VALUE %s: " % item.value)
                # Throw on funny stuff, catch below.
hjk's avatar
hjk committed
873 874 875 876
                # Unfortunately, this fails also with a "Unicode encoding error"
                # in testArray().
                #dummy = str(item.value)
                pass
877 878
            except:
                # Locals with failing memory access.
879 880 881 882 883 884 885
                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"');
886
                continue
887 888 889 890

            type = item.value.type
            if type.code == gdb.TYPE_CODE_PTR \
                    and item.name == "argv" and str(type) == "char **":
891
                # Special handling for char** argv.
892 893
                n = 0
                p = item.value
894 895 896 897 898
                # p is 0 for "optimized out" cases.
                if not isNull(p):
                    while not isNull(p.dereference()) and n <= 100:
                        p += 1
                        n += 1
899

900 901 902 903 904 905 906 907 908 909 910 911 912 913 914
                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()
915 916

            else:
917
                # A "normal" local variable or parameter.
918
                try:
919
                   addr = cleanAddress(item.value.address)
920 921 922 923
                   with SubItem(d):
                       d.put('iname="%s",' % item.iname)
                       d.put('addr="%s",' % addr)
                       d.putItemHelper(item)
924
                except AttributeError:
925 926
                    # Thrown by cleanAddress with message "'NoneType' object
                    # has no attribute 'cast'" for optimized-out values.
927 928 929 930 931 932
                    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)
933

934 935 936
        #
        # Watchers
        #
937 938 939 940 941
        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
942

943 944 945
        #
        # Breakpoints
        #
946 947 948
        #listOfBreakpoints(d)

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

951

952
    def handleWatch(self, d, exp, iname):
953
        exp = str(exp)
954
        escapedExp = exp.replace('"', '\\"');
955
        #warn("HANDLING WATCH %s, INAME: '%s'" % (exp, iname))
956 957
        if exp.startswith("[") and exp.endswith("]"):
            #warn("EVAL: EXP: %s" % exp)
958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982
            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):
983
            d.putField("iname", iname)
984 985
            d.putField("name", escapedExp)
            d.putField("exp", escapedExp)
986 987 988 989 990 991 992 993 994 995 996 997
            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",')
998

hjk's avatar
hjk committed
999 1000 1001 1002

FrameCommand()


1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016
#######################################################################
#
# 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):
1017 1018
        (cmd, addr) = arg.split(",")
        lines = catchCliOutput("info line *" + addr)
1019 1020 1021 1022 1023 1024 1025 1026 1027 1028
        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]
1029
        gdb.execute("maint packet sal%s,%s,%s" % (cmd,fromAddr, toAddr))
1030 1031

SalCommand()
hjk's avatar
hjk committed
1032

1033

hjk's avatar
hjk committed
1034 1035 1036 1037 1038 1039
#######################################################################
#
# The Dumper Class
#
#######################################################################

1040

hjk's avatar
hjk committed
1041 1042 1043
class Dumper:
    def __init__(self):
        self.output = ""
1044 1045 1046 1047 1048 1049 1050 1051 1052
        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
1053 1054 1055 1056 1057

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

    def putField(self, name, value):
hjk's avatar
hjk committed
1058
        self.put('%s="%s",' % (name, value))
hjk's avatar
hjk committed
1059 1060

    def beginItem(self, name):
1061
        self.put('%s="' % name)
hjk's avatar
hjk committed
1062 1063

    def endItem(self):
hjk's avatar
hjk committed
1064
        self.put('",')
hjk's avatar
hjk committed
1065

1066
    def childRange(self):
1067
        return xrange(qmin(self.currentMaxNumChilds, self.currentNumChilds))
1068

hjk's avatar
hjk committed
1069 1070
    # convenience
    def putItemCount(self, count):
hjk's avatar
hjk committed
1071
        self.put('value="<%s items>",' % count)
hjk's avatar
hjk committed
1072 1073

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

1076 1077 1078 1079 1080
    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
1081

1082 1083 1084
    def putAddress(self, addr):
        self.put('addr="%s",' % cleanAddress(addr))

hjk's avatar
hjk committed
1085
    def putNumChild(self, numchild):
1086 1087
        #warn("NUM CHILD: '%s' '%s'" % (numchild, self.currentChildNumChild))
        if numchild != self.currentChildNumChild:
hjk's avatar
hjk committed
1088
            self.put('numchild="%s",' % numchild)
hjk's avatar
hjk committed
1089

1090 1091 1092 1093 1094 1095
    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
1096

1097
    def putPointerValue(self, value):
1098
        # Use a lower priority
1099 1100
        self.putValue("0x%x" % value.dereference().cast(
            gdb.lookup_type("unsigned long")), None, -1)
1101

1102
    def putStringValue(self, value):
1103
        if value is None:
hjk's avatar
hjk committed
1104
            self.put('value="<not available>",')
1105 1106
        else:
            str = encodeString(value)
1107
            self.put('valueencoded="%d",value="%s",' % (Hex4EncodedLittleEndian, str))
1108

1109 1110 1111 1112 1113 1114 1115 1116
    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))

1117 1118
    def putByteArrayValue(self, value):
        str = encodeByteArray(value)
1119
        self.put('valueencoded="%d",value="%s",' % (Hex2EncodedLatin1, str))
1120

1121
    def putName(self, name):
hjk's avatar
hjk committed
1122
        self.put('name="%s",' % name)
1123

hjk's avatar
hjk committed
1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136
    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):
1137 1138 1139 1140 1141
        # 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
1142 1143 1144 1145
        type = stripClassTag(str(typeobj))
        if len(self.ns) > 0 and type.startswith(self.ns):
            type = type[len(self.ns):]
        pos = type.find("<")
1146 1147 1148 1149 1150
        # 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
1151 1152 1153 1154 1155 1156 1157 1158 1159 1160
        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):
hjk's avatar