dumper.py 44.9 KB
Newer Older
hjk's avatar
hjk committed
1 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

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 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46
# Fails on SimulatorQt.
try:
    import os
    def removeFile(name):
        try:  # files may still be locked by gdb on Windows
            os.remove(filename)
        except:
            pass
except:
    def removeFile(name):
        pass

# Fails on SimulatorQt.
try:
    import tempfile
    def createTempFile():
        file = tempfile.mkstemp(prefix="gdbpy_")
        return file[1]
except:
    fileCounter = 0
    def createTempFile():
        fileCounter += 1
        return "gdbpy_tmp%d" % fileCounter

47

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

51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72
# Some "Enums"

# Encodings

Unencoded8Bit, \
    Base64Encoded8BitWithQuotes, \
    Base64Encoded16BitWithQuotes, \
    Base64Encoded32BitWithQuotes, \
    Base64Encoded16Bit, \
    Base64Encoded8Bit, \
    Hex2EncodedLatin1, \
    Hex4EncodedLittleEndian, \
    Hex8EncodedLittleEndian, \
    Hex2EncodedUtf8, \
    Hex8EncodedBigEndian, \
    Hex4EncodedBigEndian \
        = range(12)

# Display modes
StopDisplay, DisplayImage1, DisplayString, DisplayImage, DisplayProcess = range(5)


73 74 75 76 77
def select(condition, if_expr, else_expr):
    if condition:
        return if_expr
    return else_expr

78 79 80 81 82
def qmin(n, m):
    if n < m:
        return n
    return m

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

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

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

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

120

121
def catchCliOutput(command):
122
    filename = createTempFile()
123 124 125 126 127 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")
    file = open(filename, "r")
    lines = []
    for line in file:
        lines.append(line)
    file.close()
136
    removeFile(filename)
137 138 139
    return lines


140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163
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"
164
    #6       breakpoint     keep y   0xb6cf18e5 <__cxa_throw+5>\n"
165
    lines = catchCliOutput("info break")
166 167 168 169

    lines.reverse()
    bp = Breakpoint()
    for line in lines:
170 171
        if len(line) == 0 or line.startswith(" "):
            continue
172 173 174 175 176 177 178 179 180 181
        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")
182
        posin = line.find(" in ", pos0x)
183
        poslt = line.find(" <", pos0x)
184
        posat = line.find(" at ", posin)
185
        poscol = line.find(":", posat)
186 187 188 189 190 191
        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)]
192 193 194
        # Take "no address" as indication that the bp is pending.
        #if line.find("<PENDING>") >= 0:
        #    bp.address.append("<PENDING>")
195 196 197 198 199 200 201 202 203 204 205 206
        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
207 208 209 210
        d.put('bkpt={number="%s",' % bp.number)
        d.put('type="breakpoint",')
        d.put('disp="keep",')
        d.put('enabled="y",')
211
        for address in bp.address:
hjk's avatar
hjk committed
212
            d.put('addr="%s",' % address)
213
        if not bp.function is None:
hjk's avatar
hjk committed
214
            d.put('func="%s",' % bp.function)
215
        if not bp.filename is None:
hjk's avatar
hjk committed
216
            d.put('file="%s",' % bp.filename)
217
        if not bp.fullname is None:
hjk's avatar
hjk committed
218
            d.put('fullname="%s",' % bp.fullname)
219
        if not bp.linenumber is None:
hjk's avatar
hjk committed
220
            d.put('line="%s",' % bp.linenumber)
221
        if not bp.condition is None:
hjk's avatar
hjk committed
222
            d.put('cond="%s",' % bp.condition)
223
        if not bp.fullname is None:
hjk's avatar
hjk committed
224
            d.put('fullname="%s",' % bt.fullname)
225
        if not bp.times is None:
hjk's avatar
hjk committed
226
            d.put('times="1",' % bp.times)
227
        #d.put('original-location="-"')
hjk's avatar
hjk committed
228
        d.put('},')
229 230 231
        bp = Breakpoint()


232 233 234 235 236 237 238 239 240 241 242
# 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


243
def listOfLocals(varList):
244 245 246 247
    try:
        frame = gdb.selected_frame()
        #warn("FRAME %s: " % frame)
    except RuntimeError:
248
        warn("FRAME NOT ACCESSIBLE")
hjk's avatar
hjk committed
249
        return []
250

251
    # gdb-6.8-symbianelf fails here
252
    hasBlock = 'block' in __builtin__.dir(frame)
253

254
    items = []
255 256 257 258 259 260 261 262 263
    if hasBlock and isGoodGdb():
        warn("IS GOOD: %s " % varList)
        try:
            block = frame.block()
            #warn("BLOCK: %s " % block)
        except:
            warn("BLOCK NOT ACCESSIBLE")
            return items

264 265 266 267 268 269
        while True:
            if block is None:
                warn("UNEXPECTED 'None' BLOCK")
                break
            for symbol in block:
                name = symbol.print_name
270

271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293
                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
294
        # Assuming gdb 7.0 release or 6.8-symbianelf.
295
        filename = createTempFile()
296 297
        #warn("VARLIST: %s " % varList)
        #warn("VARLIST: %s " % len(varList))
hjk's avatar
hjk committed
298 299
        gdb.execute("set logging off")
        gdb.execute("set logging redirect off")
300 301 302
        gdb.execute("set logging file %s" % filename)
        gdb.execute("set logging redirect on")
        gdb.execute("set logging on")
303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319
        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
320 321
        gdb.execute("set logging off")
        gdb.execute("set logging redirect off")
322

323 324 325 326
        file = open(filename, "r")
        for line in file:
            if len(line) == 0 or line.startswith(" "):
                continue
327
            # The function parameters
328 329 330
            pos = line.find(" = ")
            if pos < 0:
                continue
331 332
            varList.append(line[0:pos])
        file.close()
333
        removeFile(filename)
334 335 336
        #warn("VARLIST: %s " % varList)
        for name in varList:
            #warn("NAME %s " % name)
337 338 339 340
            item = Item(0, "local", name, name)
            try:
                item.value = frame.read_var(name)  # this is a gdb value
            except RuntimeError:
341 342
                pass
                #continue
343 344 345 346 347
            items.append(item)

    return items


348
def value(expr):
349
    value = parseAndEvaluate(expr)
350 351 352 353 354
    try:
        return int(value)
    except:
        return str(value)

355

hjk's avatar
hjk committed
356
def isSimpleType(typeobj):
357 358
    if typeobj.code == gdb.TYPE_CODE_PTR:
        return False
hjk's avatar
hjk committed
359 360 361 362 363 364 365 366
    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 ") \
367
        or type == "signed" or type.startswith("signed ") \
hjk's avatar
hjk committed
368 369
        or type == "unsigned" or type.startswith("unsigned ")

370

hjk's avatar
hjk committed
371 372 373 374 375 376 377 378 379
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):
380 381
    if True or verbosity > 0:
        print "XXX: %s\n" % message.encode("latin1")
hjk's avatar
hjk committed
382 383 384 385 386 387
    pass

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

388 389 390 391 392
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
393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413
#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):
414 415 416 417
    # 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 ")
418
    return p.cast(gdb.lookup_type("void").pointer()) == 0
hjk's avatar
hjk committed
419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444

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:]
    return type

def checkPointerRange(p, n):
445
    for i in xrange(n):
hjk's avatar
hjk committed
446 447 448 449 450 451
        checkPointer(p)
        ++p

def call(value, func):
    #warn("CALL: %s -> %s" % (value, func))
    type = stripClassTag(str(value.type))
452
    if type.find(":") >= 0:
hjk's avatar
hjk committed
453 454 455
        type = "'" + type + "'"
    exp = "((%s*)%s)->%s" % (type, value.address, func)
    #warn("CALL: %s" % exp)
456
    result = parseAndEvaluate(exp)
hjk's avatar
hjk committed
457 458 459
    #warn("  -> %s" % result)
    return result

460 461
def qtNamespace():
    try:
462
        type = str(parseAndEvaluate("&QString::null").type.target().unqualified())
463 464 465
        return type[0:len(type) - len("QString::null")]
    except RuntimeError:
        return ""
466 467 468
    except AttributeError:
        # Happens for none-Qt applications
        return ""
hjk's avatar
hjk committed
469

470 471 472 473 474 475 476
def findFirstZero(p, max):
    for i in xrange(max):
        if p.dereference() == 0:
            return i
        p = p + 1
    return -1

477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502

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)

503
def encodeCharArray(p, maxsize, size = -1):
504 505
    t = gdb.lookup_type("unsigned char").pointer()
    p = p.cast(t)
506 507 508 509
    if size == -1:
        i = findFirstZero(p, maxsize)
    else:
        i = size
510
    limit = select(i < 0, maxsize, i)
511
    s = ""
512
    for i in xrange(limit):
513 514
        s += "%02x" % int(p.dereference())
        p += 1
515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542
    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"
543 544
    return s

545 546 547 548 549 550
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)
551
    checkRef(d_ptr["ref"])
552 553 554
    if size > 0:
        checkAccess(data, 4)
        checkAccess(data + size) == 0
555
    return encodeCharArray(data, size)
556 557 558 559 560 561 562 563 564 565

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)
        checkAccess(data + size * 2) == 0
566
    checkRef(d_ptr["ref"])
567 568
    p = gdb.Value(d_ptr["data"])
    s = ""
569
    for i in xrange(size):
570 571 572 573 574 575
        val = int(p.dereference())
        s += "%02x" % (val % 256)
        s += "%02x" % (val / 256)
        p += 1
    return s

hjk's avatar
hjk committed
576 577 578 579 580 581 582
#######################################################################
#
# Item
#
#######################################################################

class Item:
583
    def __init__(self, value, parentiname, iname, name = None):
hjk's avatar
hjk committed
584
        self.value = value
585 586 587 588
        if iname is None:
            self.iname = parentiname
        else:
            self.iname = "%s.%s" % (parentiname, iname)
hjk's avatar
hjk committed
589 590 591 592 593 594 595 596 597 598 599 600 601 602 603
        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)

604 605 606 607 608
    def invoke(self, args, from_tty):
        options = []
        varList = []
        typeformats = {}
        formats = {}
609
        watchers = ""
610
        expandedINames = ""
611 612 613 614 615
        for arg in args.split(' '):
            pos = arg.find(":") + 1
            if arg.startswith("options:"):
                options = arg[pos:].split(",")
            elif arg.startswith("vars:"):
616 617
                if len(arg[pos:]) > 0:
                    varList = arg[pos:].split(",")
618 619 620 621 622 623 624 625 626 627 628 629 630 631 632
            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)
633

634
        useFancy = "fancy" in options
635 636

        #warn("VARIABLES: %s" % varList)
hjk's avatar
hjk committed
637 638 639 640
        #warn("EXPANDED INAMES: %s" % expandedINames)
        module = sys.modules[__name__]
        self.dumpers = {}

641 642 643
        if False:
            dumpers = ""
            typeformats = ""
hjk's avatar
hjk committed
644
            for key, value in module.__dict__.items():
645
                if key.startswith("qdump__"):
646 647
                    dumpers += '"' + key[7:] + '",'
            output = "dumpers=[%s]," % dumpers
hjk's avatar
hjk committed
648
            #output += "qtversion=[%d,%d,%d]"
649
            #output += "qtversion=[4,6,0],"
hjk's avatar
hjk committed
650 651 652 653 654 655 656
            output += "namespace=\"%s\"," % qtNamespace()
            output += "dumperversion=\"2.0\","
            output += "sizes=[],"
            output += "expressions=[]"
            output += "]"
            print output
            return
657

658

hjk's avatar
hjk committed
659 660
        if useFancy:
            for key, value in module.__dict__.items():
661 662
                if key.startswith("qdump__"):
                    self.dumpers[key[7:]] = value
hjk's avatar
hjk committed
663 664 665

        d = Dumper()
        d.dumpers = self.dumpers
666 667
        d.typeformats = typeformats
        d.formats = formats
668 669 670
        d.useFancy = useFancy
        d.passExceptions = "passexceptions" in options
        d.autoDerefPointers = "autoderef" in options
671
        d.ns = qtNamespace()
672
        d.expandedINames = expandedINames
hjk's avatar
hjk committed
673 674
        #warn(" NAMESPACE IS: '%s'" % d.ns)

675 676 677
        #
        # Locals
        #
678
        for item in listOfLocals(varList):
679
            #warn("ITEM NAME %s: " % item.name)
680 681 682
            try:
                #warn("ITEM VALUE %s: " % item.value)
                # Throw on funny stuff, catch below.
hjk's avatar
hjk committed
683 684 685 686
                # Unfortunately, this fails also with a "Unicode encoding error"
                # in testArray().
                #dummy = str(item.value)
                pass
687 688 689 690 691 692 693 694 695 696 697
            except:
                # Locals with failing memory access.
                d.beginHash()
                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"');
                d.endHash()
                continue
698 699 700 701

            type = item.value.type
            if type.code == gdb.TYPE_CODE_PTR \
                    and item.name == "argv" and str(type) == "char **":
702
                # Special handling for char** argv.
703 704
                n = 0
                p = item.value
705 706 707 708 709
                # p is 0 for "optimized out" cases.
                if not isNull(p):
                    while not isNull(p.dereference()) and n <= 100:
                        p += 1
                        n += 1
710 711 712 713 714 715 716 717

                d.beginHash()
                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):
718
                    p = item.value
719
                    d.beginChildren(n)
720
                    for i in xrange(n):
721 722
                        value = p.dereference()
                        d.putItem(Item(value, item.iname, i, None))
723
                        p += 1
724 725 726 727 728 729
                    if n > 100:
                        d.putEllipsis()
                    d.endChildren()
                d.endHash()

            else:
730
                # A "normal" local variable or parameter.
731
                try:
732 733 734 735 736 737
                   addr = cleanAddress(item.value.address)
                   d.beginHash()
                   d.put('iname="%s",' % item.iname)
                   d.put('addr="%s",' % addr)
                   d.safePutItemHelper(item)
                   d.endHash()
738
                except AttributeError:
739 740
                    # Thrown by cleanAddress with message "'NoneType' object
                    # has no attribute 'cast'" for optimized-out values.
741 742 743 744 745 746 747
                    d.beginHash()
                    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)
                    d.endHash()
hjk's avatar
hjk committed
748

749 750 751 752
        d.pushOutput()
        locals = d.safeoutput


753 754 755
        #
        # Watchers
        #
756
        d.safeoutput = ""
757
        if len(watchers) > 0:
758
            for watcher in watchers.split("##"):
759 760
                (exp, iname) = watcher.split("#")
                self.handleWatch(d, exp, iname)
761 762 763
        d.pushOutput()
        watchers = d.safeoutput

hjk's avatar
hjk committed
764 765 766 767
        sep = ""
        if len(locals) and len(watchers):
            sep = ","

768 769 770
        #
        # Breakpoints
        #
771 772 773 774 775 776 777 778
        #breakpoints = ""
        #d.safeoutput = ""
        #listOfBreakpoints(d)
        #d.pushOutput()
        #breakpoints = d.safeoutput

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

780

781 782
    def handleWatch(self, d, exp, iname):
        #warn("HANDLING WATCH %s, INAME: '%s'" % (exp, iname))
783
        if exp.startswith("["):
784
            warn("EVAL: EXP: %s" % exp)
785
            d.beginHash()
786
            d.put('iname="%s",' % iname)
787
            d.put('name="%s",' % exp)
788
            d.put('exp="%s",' % exp)
789 790
            try:
                list = eval(exp)
791
                #warn("EVAL: LIST: %s" % list)
792 793 794 795 796 797 798
                d.put('value=" "')
                d.put('type=" "')
                d.put('numchild="%d"' % len(list))
                # This is a list of expressions to evaluate
                d.beginChildren(len(list))
                itemNumber = 0
                for item in list:
799
                    self.handleWatch(d, item, "%s.%d" % (iname, itemNumber))
800 801 802 803 804 805 806 807 808 809 810 811 812
                    itemNumber += 1
                d.endChildren()
            except:
                warn("EVAL: ERROR CAUGHT")
                d.put('value="<syntax error>"')
                d.put('type=" "')
                d.put('numchild="0"')
                d.beginChildren(0)
                d.endChildren()
            d.endHash()
            return

        d.beginHash()
813
        d.put('iname="%s",' % iname)
814
        d.put('name="%s",' % exp)
815
        d.put('exp="%s",' % exp)
816 817
        handled = False
        if exp == "<Edit>":
hjk's avatar
hjk committed
818
            d.put('value=" ",type=" ",numchild="0",')
819
        else:
820
            try:
821
                value = parseAndEvaluate(exp)
822
                item = Item(value, iname, None, None)
823
                d.putItemHelper(item)
824
            except RuntimeError:
hjk's avatar
hjk committed
825
                d.put('value="<invalid>",type="<unknown>",numchild="0",')
826
        d.endHash()
827

hjk's avatar
hjk committed
828 829 830 831

FrameCommand()


832 833 834 835 836 837 838 839 840 841 842 843 844 845
#######################################################################
#
# 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):
846 847
        (cmd, addr) = arg.split(",")
        lines = catchCliOutput("info line *" + addr)
848 849 850 851 852 853 854 855 856 857
        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]
858
        gdb.execute("maint packet sal%s,%s,%s" % (cmd,fromAddr, toAddr))
859 860

SalCommand()
hjk's avatar
hjk committed
861

862

hjk's avatar
hjk committed
863 864 865 866 867 868
#######################################################################
#
# The Dumper Class
#
#######################################################################

869

hjk's avatar
hjk committed
870 871 872 873 874 875
class Dumper:
    def __init__(self):
        self.output = ""
        self.safeoutput = ""
        self.childTypes = [""]
        self.childNumChilds = [-1]
876 877
        self.maxNumChilds = [-1]
        self.numChilds = [-1]
hjk's avatar
hjk committed
878 879 880 881 882

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

    def putField(self, name, value):
hjk's avatar
hjk committed
883
        self.put('%s="%s",' % (name, value))
hjk's avatar
hjk committed
884 885 886 887 888

    def beginHash(self):
        self.put('{')

    def endHash(self):
hjk's avatar
hjk committed
889
        self.put('},')
hjk's avatar
hjk committed
890 891

    def beginItem(self, name):
892
        self.put('%s="' % name)
hjk's avatar
hjk committed
893 894

    def endItem(self):
hjk's avatar
hjk committed
895
        self.put('",')
hjk's avatar
hjk committed
896

897
    def beginChildren(self, numChild_ = 1, childType_ = None, childNumChild_ = None):
hjk's avatar
hjk committed
898 899
        childType = ""
        childNumChild = -1
900 901 902 903 904 905
        if type(numChild_) is list:
            numChild = numChild_[0]
            maxNumChild = numChild_[1]
        else:
            numChild = numChild_
            maxNumChild = numChild_
906
        if numChild == 0:
907 908 909
            childType_ = None
        if not childType_ is None:
            childType = stripClassTag(str(childType_))
910
            self.put('childtype="%s",' % childType)
911
            if isSimpleType(childType_) or isStringType(self, childType_):
912
                self.put('childnumchild="0",')
hjk's avatar
hjk committed
913
                childNumChild = 0
914
            elif childType_.code == gdb.TYPE_CODE_PTR:
915
                self.put('childnumchild="1",')
hjk's avatar
hjk committed
916
                childNumChild = 1
917 918 919
        if not childNumChild_ is None:
            self.put('childnumchild="%s",' % childNumChild_)
            childNumChild = childNumChild_
hjk's avatar
hjk committed
920 921
        self.childTypes.append(childType)
        self.childNumChilds.append(childNumChild)
922 923
        self.numChilds.append(numChild)
        self.maxNumChilds.append(maxNumChild)
hjk's avatar
hjk committed
924 925 926 927 928
        #warn("BEGIN: %s" % self.childTypes)
        self.put("children=[")

    def endChildren(self):
        #warn("END: %s" % self.childTypes)
929 930 931 932
        numChild = self.numChilds.pop()
        maxNumChild = self.maxNumChilds.pop()
        if maxNumChild < numChild:
            self.putEllipsis();
hjk's avatar
hjk committed
933 934
        self.childTypes.pop()
        self.childNumChilds.pop()
hjk's avatar
hjk committed
935
        self.put('],')
hjk's avatar
hjk committed
936

937 938 939
    def childRange(self):
        return xrange(qmin(self.maxNumChilds[-1], self.numChilds[-1]))

hjk's avatar
hjk committed
940 941
    # convenience
    def putItemCount(self, count):
hjk's avatar
hjk committed
942
        self.put('value="<%s items>",' % count)
hjk's avatar
hjk committed
943 944

    def putEllipsis(self):
hjk's avatar
hjk committed
945
        self.put('{name="<incomplete>",value="",type="",numchild="0"},')
hjk's avatar
hjk committed
946 947 948 949 950 951

    def putType(self, type):
        #warn("TYPES: '%s' '%s'" % (type, self.childTypes))
        #warn("  EQUAL 2: %s " % (str(type) == self.childTypes[-1]))
        type = stripClassTag(str(type))
        if len(type) > 0 and type != self.childTypes[-1]:
hjk's avatar
hjk committed
952
            self.put('type="%s",' % type) # str(type.unqualified()) ?
hjk's avatar
hjk committed
953

954 955 956
    def putAddress(self, addr):
        self.put('addr="%s",' % cleanAddress(addr))

hjk's avatar
hjk committed
957 958
    def putNumChild(self, numchild):
        #warn("NUM CHILD: '%s' '%s'" % (numchild, self.childNumChilds[-1]))
959
        if numchild != self.childNumChilds[-1]:
hjk's avatar
hjk committed
960
            self.put('numchild="%s",' % numchild)
hjk's avatar
hjk committed
961

962 963 964 965 966 967
    def putValue(self, value, encoding = None):
        if not encoding is None:
            self.putField("valueencoded", encoding)
        self.putField("value", value)

    def putStringValue(self, value):
968
        if value is None:
hjk's avatar
hjk committed
969
            self.put('value="<not available>",')
970 971
        else:
            str = encodeString(value)
972
            self.put('valueencoded="%d",value="%s",' % (Hex4EncodedLittleEndian, str))
973

974 975 976 977 978 979 980 981
    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))

982 983
    def putByteArrayValue(self, value):
        str = encodeByteArray(value)
984
        self.put('valueencoded="%d",value="%s",' % (Hex2EncodedLatin1, str))
985

986
    def putName(self, name):
hjk's avatar
hjk committed
987
        self.put('name="%s",' % name)
988

hjk's avatar
hjk committed
989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006
    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 unputField(self, name):
        pos = self.output.rfind(",")
        if self.output[pos + 1:].startswith(name):
            self.output = self.output[0:pos]

    def stripNamespaceFromType(self, typeobj):
1007 1008 1009 1010 1011
        # 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
1012 1013 1014 1015
        type = stripClassTag(str(typeobj))
        if len(self.ns) > 0 and type.startswith(self.ns):
            type = type[len(self.ns):]
        pos = type.find("<")
1016 1017 1018 1019 1020
        # 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
1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031
        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):
        self.beginHash()
1032 1033
        self.putName(name)
        self.putValue(value)
hjk's avatar
hjk committed
1034 1035 1036 1037 1038 1039
        self.putType("int")
        self.putNumChild(0)
        self.endHash()

    def putBoolItem(self, name, value):
        self.beginHash()
1040 1041
        self.putName(name)
        self.putValue(value)
hjk's avatar
hjk committed
1042 1043 1044 1045 1046 1047 1048 1049 1050
        self.putType("bool")
        self.putNumChild(0)
        self.endHash()

    def pushOutput(self):
        #warn("PUSH OUTPUT: %s " % self.output)
        self.safeoutput += self.output
        self.output = ""

1051
    def dumpInnerValueHelper(self, item):
hjk's avatar
hjk committed
1052
        if isSimpleType(item.value.type):
1053
            self.safePutItemHelper(item)
hjk's avatar
hjk committed
1054

1055 1056 1057 1058 1059 1060
    def itemFormat(self, item):
        format = self.formats.get(item.iname)
        if format is None:
            format = self.typeformats.get(stripClassTag(str(item.value.type)))
        return format

1061 1062 1063 1064 1065
    def safePutItem(self, item):
        self.beginHash()
        self.safePutItemHelper(item)
        self.endHash()

hjk's avatar
hjk committed
1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077
    def safePutItemHelper(self, item):
        self.pushOutput()
        # This is only used at the top level to ensure continuation
        # after failures due to uninitialized or corrupted data.
        if self.passExceptions:
            # for debugging reasons propagate errors.
            self.putItemHelper(item)

        else:
            try:
                self.putItemHelper(item)

1078
            except RuntimeError:
hjk's avatar
hjk committed
1079 1080 1081 1082
                self.output = ""
                # FIXME: Only catch debugger related exceptions
                #exType, exValue, exTraceback = sys.exc_info()
                #tb = traceback.format_exception(exType, exValue, exTraceback)
1083
                #warn("Exception: %s" % ex.message)
hjk's avatar
hjk committed
1084 1085 1086 1087 1088
                # DeprecationWarning: BaseException.message
                # has been deprecated
                #warn("Exception.")
                #for line in tb:
                #    warn("%s" % line)
1089 1090 1091 1092
                self.putName(item.name)
                self.putValue("<invalid>")
                self.putType(str(item.value.type))
                self.putNumChild(0)
hjk's avatar
hjk committed
1093 1094 1095 1096 1097 1098 1099
                #if self.isExpanded(item):
                self.beginChildren()
                self.endChildren()
        self.pushOutput()

    def putItem(self, item):
        self.beginHash()
hjk's avatar
hjk committed
1100
        self.safePutItemHelper(item)
hjk's avatar
hjk committed
1101 1102 1103
        self.endHash()

    def putCallItem(self, name, item, func):
1104 1105 1106 1107 1108
        try:
            result = call(item.value, func)
            self.safePutItem(Item(result, item.iname, name, name))
        except:
            self.safePutItem(Item(None, item.iname))
hjk's avatar
hjk committed
1109

1110
    def putItemHelper(self, item):
hjk's avatar
hjk committed
1111 1112
        name = getattr(item, "name", None)
        if not name is None:
1113
            self.putName(name)
hjk's avatar
hjk committed
1114

1115 1116 1117 1118 1119 1120 1121 1122
        if item.value is None:
            # Happens for non-available watchers in gdb versions that
            # need to use gdb.execute instead of gdb.parse_and_eval
            self.putValue("<not available>")
            self.putType("<unknown>")
            self.putNumChild(0)
            return