dumper.py 40.1 KB
Newer Older
hjk's avatar
hjk committed
1 2 3 4 5 6 7 8

#Note: Keep name-type-value-numchild-extra order

#return

import sys
import traceback
import gdb
9
import base64
10 11 12 13
import os

if os.name != "nt":
    import curses.ascii
hjk's avatar
hjk committed
14

15
# only needed for gdb 7.0/7.0.1 that do not implement parse_and_eval
16 17 18
import os
import tempfile

hjk's avatar
hjk committed
19 20 21
verbosity = 0
verbosity = 1

22 23 24 25 26
def select(condition, if_expr, else_expr):
    if condition:
        return if_expr
    return else_expr

27 28 29 30 31
def qmin(n, m):
    if n < m:
        return n
    return m

hjk's avatar
hjk committed
32
def isGoodGdb():
33 34 35
    #return gdb.VERSION.startswith("6.8.50.2009") \
    #   and gdb.VERSION != "6.8.50.20090630-cvs"
    return 'parse_and_eval' in dir(gdb)
hjk's avatar
hjk committed
36

37
def cleanAddress(addr):
38 39
    # We cannot use str(addr) as it yields rubbish for char pointers
    # that might trigger Unicode encoding errors.
40
    return addr.cast(gdb.lookup_type("void").pointer())
41

hjk's avatar
hjk committed
42 43 44 45
# Workaround for gdb < 7.1
def numericTemplateArgument(type, position):
    try:
        return int(type.template_argument(position))
46
    except RuntimeError, error:
hjk's avatar
hjk committed
47 48 49 50
        # ": No type named 30."
        msg = str(error)
        return int(msg[14:-1])

51
def parseAndEvaluate(exp):
hjk's avatar
hjk committed
52
    if isGoodGdb():
53 54 55 56
        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")
57 58 59 60 61
    try:
        gdb.execute("print %s" % exp)
    except:
        gdb.execute("set logging off")
        return None
62 63 64
    gdb.execute("set logging off")
    return gdb.history(0)

65

66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88
def catchCliOutput(command):
    file = tempfile.mkstemp(prefix="gdbpy_")
    filename = file[1]
    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()
    try:  # files may still be locked by gdb on Windows
        os.remove(filename)
    except:
        pass
    return lines


89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112
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"
113
    #6       breakpoint     keep y   0xb6cf18e5 <__cxa_throw+5>\n"
114
    lines = catchCliOutput("info break")
115 116 117 118

    lines.reverse()
    bp = Breakpoint()
    for line in lines:
119 120
        if len(line) == 0 or line.startswith(" "):
            continue
121 122 123 124 125 126 127 128 129 130
        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")
131
        posin = line.find(" in ", pos0x)
132
        poslt = line.find(" <", pos0x)
133
        posat = line.find(" at ", posin)
134
        poscol = line.find(":", posat)
135 136 137 138 139 140
        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)]
141 142 143
        # Take "no address" as indication that the bp is pending.
        #if line.find("<PENDING>") >= 0:
        #    bp.address.append("<PENDING>")
144 145 146 147 148 149 150 151 152 153 154 155
        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
156 157 158 159
        d.put('bkpt={number="%s",' % bp.number)
        d.put('type="breakpoint",')
        d.put('disp="keep",')
        d.put('enabled="y",')
160
        for address in bp.address:
hjk's avatar
hjk committed
161
            d.put('addr="%s",' % address)
162
        if not bp.function is None:
hjk's avatar
hjk committed
163
            d.put('func="%s",' % bp.function)
164
        if not bp.filename is None:
hjk's avatar
hjk committed
165
            d.put('file="%s",' % bp.filename)
166
        if not bp.fullname is None:
hjk's avatar
hjk committed
167
            d.put('fullname="%s",' % bp.fullname)
168
        if not bp.linenumber is None:
hjk's avatar
hjk committed
169
            d.put('line="%s",' % bp.linenumber)
170
        if not bp.condition is None:
hjk's avatar
hjk committed
171
            d.put('cond="%s",' % bp.condition)
172
        if not bp.fullname is None:
hjk's avatar
hjk committed
173
            d.put('fullname="%s",' % bt.fullname)
174
        if not bp.times is None:
hjk's avatar
hjk committed
175
            d.put('times="1",' % bp.times)
176
        #d.put('original-location="-"')
hjk's avatar
hjk committed
177
        d.put('},')
178 179 180
        bp = Breakpoint()


181 182 183 184 185 186 187 188 189 190 191
# 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


192
def listOfLocals(varList):
193 194 195 196
    try:
        frame = gdb.selected_frame()
        #warn("FRAME %s: " % frame)
    except RuntimeError:
197
        warn("FRAME NOT ACCESSIBLE")
hjk's avatar
hjk committed
198
        return []
199

200 201 202
    # gdb-6.8-symbianelf fails here
    hasBlock = 'block' in dir(frame)

203
    items = []
204 205 206 207 208 209 210 211 212
    if hasBlock and isGoodGdb():
        warn("IS GOOD: %s " % varList)
        try:
            block = frame.block()
            #warn("BLOCK: %s " % block)
        except:
            warn("BLOCK NOT ACCESSIBLE")
            return items

213 214 215 216 217 218
        while True:
            if block is None:
                warn("UNEXPECTED 'None' BLOCK")
                break
            for symbol in block:
                name = symbol.print_name
219

220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242
                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
243
        # Assuming gdb 7.0 release or 6.8-symbianelf.
244 245
        file = tempfile.mkstemp(prefix="gdbpy_")
        filename = file[1]
246 247
        #warn("VARLIST: %s " % varList)
        #warn("VARLIST: %s " % len(varList))
hjk's avatar
hjk committed
248 249
        gdb.execute("set logging off")
        gdb.execute("set logging redirect off")
250 251 252
        gdb.execute("set logging file %s" % filename)
        gdb.execute("set logging redirect on")
        gdb.execute("set logging on")
253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269
        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
270 271
        gdb.execute("set logging off")
        gdb.execute("set logging redirect off")
272

273 274 275 276
        file = open(filename, "r")
        for line in file:
            if len(line) == 0 or line.startswith(" "):
                continue
277
            # The function parameters
278 279 280
            pos = line.find(" = ")
            if pos < 0:
                continue
281 282
            varList.append(line[0:pos])
        file.close()
283 284 285 286
        try:  # files may still be locked by gdb on Windows
            os.remove(filename)
        except:
            pass
287 288 289
        #warn("VARLIST: %s " % varList)
        for name in varList:
            #warn("NAME %s " % name)
290 291 292 293
            item = Item(0, "local", name, name)
            try:
                item.value = frame.read_var(name)  # this is a gdb value
            except RuntimeError:
294 295
                pass
                #continue
296 297 298 299 300
            items.append(item)

    return items


301
def value(expr):
302
    value = parseAndEvaluate(expr)
303 304 305 306 307
    try:
        return int(value)
    except:
        return str(value)

308

hjk's avatar
hjk committed
309
def isSimpleType(typeobj):
310 311
    if typeobj.code == gdb.TYPE_CODE_PTR:
        return False
hjk's avatar
hjk committed
312 313 314 315 316 317 318 319
    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 ") \
320
        or type == "signed" or type.startswith("signed ") \
hjk's avatar
hjk committed
321 322
        or type == "unsigned" or type.startswith("unsigned ")

323

hjk's avatar
hjk committed
324 325 326 327 328 329 330 331 332
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):
333 334
    if True or verbosity > 0:
        print "XXX: %s\n" % message.encode("latin1")
hjk's avatar
hjk committed
335 336 337 338 339 340
    pass

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

341 342 343 344 345
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
346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366
#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):
367 368 369 370
    # 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 ")
371
    return p.cast(gdb.lookup_type("void").pointer()) == 0
hjk's avatar
hjk committed
372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397

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):
398
    for i in xrange(n):
hjk's avatar
hjk committed
399 400 401 402 403 404
        checkPointer(p)
        ++p

def call(value, func):
    #warn("CALL: %s -> %s" % (value, func))
    type = stripClassTag(str(value.type))
405
    if type.find(":") >= 0:
hjk's avatar
hjk committed
406 407 408
        type = "'" + type + "'"
    exp = "((%s*)%s)->%s" % (type, value.address, func)
    #warn("CALL: %s" % exp)
409
    result = parseAndEvaluate(exp)
hjk's avatar
hjk committed
410 411 412
    #warn("  -> %s" % result)
    return result

413 414
def qtNamespace():
    try:
415
        type = str(parseAndEvaluate("&QString::null").type.target().unqualified())
416 417 418
        return type[0:len(type) - len("QString::null")]
    except RuntimeError:
        return ""
419 420 421
    except AttributeError:
        # Happens for none-Qt applications
        return ""
hjk's avatar
hjk committed
422

423 424
def encodeCharArray(p, size):
    s = ""
425
    p = p.cast(gdb.lookup_type("unsigned char").pointer())
426
    for i in xrange(size):
427 428 429 430
        s += "%02x" % int(p.dereference())
        p += 1
    return s

431 432 433 434 435 436
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)
437
    checkRef(d_ptr["ref"])
438 439 440 441 442 443
    if size > 0:
        checkAccess(data, 4)
        checkAccess(data + size) == 0

    innerType = gdb.lookup_type("char")
    p = gdb.Value(data.cast(innerType.pointer()))
444
    return encodeCharArray(p, size)
445 446 447 448 449 450 451 452 453 454

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
455
    checkRef(d_ptr["ref"])
456 457
    p = gdb.Value(d_ptr["data"])
    s = ""
458
    for i in xrange(size):
459 460 461 462 463 464
        val = int(p.dereference())
        s += "%02x" % (val % 256)
        s += "%02x" % (val / 256)
        p += 1
    return s

hjk's avatar
hjk committed
465 466 467 468 469 470 471
#######################################################################
#
# Item
#
#######################################################################

class Item:
472
    def __init__(self, value, parentiname, iname, name = None):
hjk's avatar
hjk committed
473
        self.value = value
474 475 476 477
        if iname is None:
            self.iname = parentiname
        else:
            self.iname = "%s.%s" % (parentiname, iname)
hjk's avatar
hjk committed
478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494
        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)

    def invoke(self, arg, from_tty):
        args = arg.split(' ')
495

hjk's avatar
hjk committed
496 497
        #warn("ARG: %s" % arg)
        #warn("ARGS: %s" % args)
498
        options = args[0].split(",")
499 500 501 502 503 504 505 506 507 508 509
        varList = args[1][1:]
        if len(varList) == 0:
            varList = []
        else:
            varList = varList.split(",")
        expandedINames = set(args[2].split(","))
        watchers = ""
        if len(args) > 3:
            watchers = base64.b16decode(args[3], True)
        #warn("WATCHERS: %s" % watchers)

510
        useFancy = "fancy" in options
511 512

        #warn("VARIABLES: %s" % varList)
hjk's avatar
hjk committed
513 514 515 516
        #warn("EXPANDED INAMES: %s" % expandedINames)
        module = sys.modules[__name__]
        self.dumpers = {}

hjk's avatar
hjk committed
517 518 519
        if useFancy == -1:
            output = "dumpers=["
            for key, value in module.__dict__.items():
520
                if key.startswith("qdump__"):
hjk's avatar
hjk committed
521 522
                    if output != "dumpers=[":
                        output += ","
523
                    output += '"' + key[7:] + '"'
hjk's avatar
hjk committed
524 525
            output += "],"
            #output += "qtversion=[%d,%d,%d]"
526
            #output += "qtversion=[4,6,0],"
hjk's avatar
hjk committed
527 528 529 530 531 532 533
            output += "namespace=\"%s\"," % qtNamespace()
            output += "dumperversion=\"2.0\","
            output += "sizes=[],"
            output += "expressions=[]"
            output += "]"
            print output
            return
534

535

hjk's avatar
hjk committed
536 537
        if useFancy:
            for key, value in module.__dict__.items():
538 539
                if key.startswith("qdump__"):
                    self.dumpers[key[7:]] = value
hjk's avatar
hjk committed
540 541 542

        d = Dumper()
        d.dumpers = self.dumpers
543 544 545
        d.useFancy = useFancy
        d.passExceptions = "passexceptions" in options
        d.autoDerefPointers = "autoderef" in options
546
        d.ns = qtNamespace()
547
        d.expandedINames = expandedINames
hjk's avatar
hjk committed
548 549
        #warn(" NAMESPACE IS: '%s'" % d.ns)

550 551 552
        #
        # Locals
        #
553
        for item in listOfLocals(varList):
554
            #warn("ITEM NAME %s: " % item.name)
555 556 557 558 559 560 561 562 563 564 565 566 567 568 569
            try:
                #warn("ITEM VALUE %s: " % item.value)
                # Throw on funny stuff, catch below.
                dummy = str(item.value)
            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
570 571 572 573

            type = item.value.type
            if type.code == gdb.TYPE_CODE_PTR \
                    and item.name == "argv" and str(type) == "char **":
574
                # Special handling for char** argv.
575 576
                n = 0
                p = item.value
577 578 579 580 581
                # p is 0 for "optimized out" cases.
                if not isNull(p):
                    while not isNull(p.dereference()) and n <= 100:
                        p += 1
                        n += 1
582 583 584 585 586 587 588 589

                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):
590
                    p = item.value
591
                    d.beginChildren(n)
592
                    for i in xrange(n):
593 594
                        value = p.dereference()
                        d.putItem(Item(value, item.iname, i, None))
595
                        p += 1
596 597 598 599 600 601
                    if n > 100:
                        d.putEllipsis()
                    d.endChildren()
                d.endHash()

            else:
602
                # A "normal" local variable or parameter.
603 604 605 606 607 608 609 610
                try:
                    addr = cleanAddress(item.value.address)
                    d.beginHash()
                    d.put('iname="%s",' % item.iname)
                    d.put('addr="%s",' % addr)
                    d.safePutItemHelper(item)
                    d.endHash()
                except AttributeError:
611 612
                    # Thrown by cleanAddress with message "'NoneType' object
                    # has no attribute 'cast'" for optimized-out values.
613 614 615 616 617 618 619
                    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
620

621 622 623 624
        d.pushOutput()
        locals = d.safeoutput


625 626 627
        #
        # Watchers
        #
628
        d.safeoutput = ""
629
        if len(watchers) > 0:
630
            for watcher in watchers.split("##"):
631 632
                (exp, iname) = watcher.split("#")
                self.handleWatch(d, exp, iname)
633 634 635
        d.pushOutput()
        watchers = d.safeoutput

hjk's avatar
hjk committed
636 637 638 639
        sep = ""
        if len(locals) and len(watchers):
            sep = ","

640 641 642
        #
        # Breakpoints
        #
643
        breakpoints = ""
644 645 646 647
        d.safeoutput = ""
        listOfBreakpoints(d)
        d.pushOutput()
        breakpoints = d.safeoutput
648 649

        print('data=[' + locals + sep + watchers + '],bkpts=[' + breakpoints + ']\n')
hjk's avatar
hjk committed
650
        #print('data=[' + locals + sep + watchers + ']\n')
651

652

653 654
    def handleWatch(self, d, exp, iname):
        #warn("HANDLING WATCH %s, INAME: '%s'" % (exp, iname))
655
        if exp.startswith("["):
656
            warn("EVAL: EXP: %s" % exp)
657
            d.beginHash()
658
            d.put('iname="%s",' % iname)
659
            d.put('name="%s",' % exp)
660
            d.put('exp="%s",' % exp)
661 662
            try:
                list = eval(exp)
663
                #warn("EVAL: LIST: %s" % list)
664 665 666 667 668 669 670
                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:
671
                    self.handleWatch(d, item, "%s.%d" % (iname, itemNumber))
672 673 674 675 676 677 678 679 680 681 682 683 684
                    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()
685
        d.put('iname="%s",' % iname)
686
        d.put('name="%s",' % exp)
687
        d.put('exp="%s",' % exp)
688 689
        handled = False
        if exp == "<Edit>":
hjk's avatar
hjk committed
690
            d.put('value=" ",type=" ",numchild="0",')
691
        else:
692
            try:
693
                value = parseAndEvaluate(exp)
694
                item = Item(value, iname, None, None)
695
                d.putItemHelper(item)
696
            except RuntimeError:
hjk's avatar
hjk committed
697
                d.put('value="<invalid>",type="<unknown>",numchild="0",')
698
        d.endHash()
699

hjk's avatar
hjk committed
700 701 702 703

FrameCommand()


704 705 706 707 708 709 710 711 712 713 714 715 716 717
#######################################################################
#
# 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):
718 719
        (cmd, addr) = arg.split(",")
        lines = catchCliOutput("info line *" + addr)
720 721 722 723 724 725 726 727 728 729
        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]
730
        gdb.execute("maint packet sal%s,%s,%s" % (cmd,fromAddr, toAddr))
731 732

SalCommand()
hjk's avatar
hjk committed
733

734

hjk's avatar
hjk committed
735 736 737 738 739 740 741 742 743 744 745 746
#######################################################################
#
# The Dumper Class
#
#######################################################################

class Dumper:
    def __init__(self):
        self.output = ""
        self.safeoutput = ""
        self.childTypes = [""]
        self.childNumChilds = [-1]
747 748
        self.maxNumChilds = [-1]
        self.numChilds = [-1]
hjk's avatar
hjk committed
749 750 751 752 753

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

    def putField(self, name, value):
hjk's avatar
hjk committed
754
        self.put('%s="%s",' % (name, value))
hjk's avatar
hjk committed
755 756 757 758 759

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

    def endHash(self):
hjk's avatar
hjk committed
760
        self.put('},')
hjk's avatar
hjk committed
761 762

    def beginItem(self, name):
hjk's avatar
hjk committed
763
        self.put('%s="' %s)
hjk's avatar
hjk committed
764 765

    def endItem(self):
hjk's avatar
hjk committed
766
        self.put('",')
hjk's avatar
hjk committed
767

768
    def beginChildren(self, numChild_ = 1, childType_ = None, childNumChild_ = None):
hjk's avatar
hjk committed
769 770
        childType = ""
        childNumChild = -1
771 772 773 774 775 776
        if type(numChild_) is list:
            numChild = numChild_[0]
            maxNumChild = numChild_[1]
        else:
            numChild = numChild_
            maxNumChild = numChild_
777
        if numChild == 0:
778 779 780
            childType_ = None
        if not childType_ is None:
            childType = stripClassTag(str(childType_))
781
            self.put('childtype="%s",' % childType)
782
            if isSimpleType(childType_) or isStringType(self, childType_):
783
                self.put('childnumchild="0",')
hjk's avatar
hjk committed
784
                childNumChild = 0
785
            elif childType_.code == gdb.TYPE_CODE_PTR:
786
                self.put('childnumchild="1",')
hjk's avatar
hjk committed
787
                childNumChild = 1
788 789 790
        if not childNumChild_ is None:
            self.put('childnumchild="%s",' % childNumChild_)
            childNumChild = childNumChild_
hjk's avatar
hjk committed
791 792
        self.childTypes.append(childType)
        self.childNumChilds.append(childNumChild)
793 794
        self.numChilds.append(numChild)
        self.maxNumChilds.append(maxNumChild)
hjk's avatar
hjk committed
795 796 797 798 799
        #warn("BEGIN: %s" % self.childTypes)
        self.put("children=[")

    def endChildren(self):
        #warn("END: %s" % self.childTypes)
800 801 802 803
        numChild = self.numChilds.pop()
        maxNumChild = self.maxNumChilds.pop()
        if maxNumChild < numChild:
            self.putEllipsis();
hjk's avatar
hjk committed
804 805
        self.childTypes.pop()
        self.childNumChilds.pop()
hjk's avatar
hjk committed
806
        self.put('],')
hjk's avatar
hjk committed
807

808 809 810
    def childRange(self):
        return xrange(qmin(self.maxNumChilds[-1], self.numChilds[-1]))

hjk's avatar
hjk committed
811 812
    # convenience
    def putItemCount(self, count):
hjk's avatar
hjk committed
813
        self.put('value="<%s items>",' % count)
hjk's avatar
hjk committed
814 815

    def putEllipsis(self):
hjk's avatar
hjk committed
816
        self.put('{name="<incomplete>",value="",type="",numchild="0"},')
hjk's avatar
hjk committed
817 818 819 820 821 822

    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
823
            self.put('type="%s",' % type) # str(type.unqualified()) ?
hjk's avatar
hjk committed
824 825 826

    def putNumChild(self, numchild):
        #warn("NUM CHILD: '%s' '%s'" % (numchild, self.childNumChilds[-1]))
827
        if numchild != self.childNumChilds[-1]:
hjk's avatar
hjk committed
828
            self.put('numchild="%s",' % numchild)
hjk's avatar
hjk committed
829

830 831 832 833 834 835
    def putValue(self, value, encoding = None):
        if not encoding is None:
            self.putField("valueencoded", encoding)
        self.putField("value", value)

    def putStringValue(self, value):
836
        if value is None:
hjk's avatar
hjk committed
837
            self.put('value="<not available>",')
838 839
        else:
            str = encodeString(value)
hjk's avatar
hjk committed
840
            self.put('valueencoded="%d",value="%s",' % (7, str))
841 842 843

    def putByteArrayValue(self, value):
        str = encodeByteArray(value)
hjk's avatar
hjk committed
844
        self.put('valueencoded="%d",value="%s",' % (6, str))
845

846
    def putName(self, name):
hjk's avatar
hjk committed
847
        self.put('name="%s",' % name)
848

hjk's avatar
hjk committed
849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866
    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):
867 868 869 870 871
        # 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
872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889
        # FIXME: pass ns from plugin
        type = stripClassTag(str(typeobj))
        if len(self.ns) > 0 and type.startswith(self.ns):
            type = type[len(self.ns):]
        pos = type.find("<")
        if pos != -1:
            type = type[0:pos]
        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()
890 891
        self.putName(name)
        self.putValue(value)
hjk's avatar
hjk committed
892 893 894 895 896 897
        self.putType("int")
        self.putNumChild(0)
        self.endHash()

    def putBoolItem(self, name, value):
        self.beginHash()
898 899
        self.putName(name)
        self.putValue(value)
hjk's avatar
hjk committed
900 901 902 903 904 905 906 907 908
        self.putType("bool")
        self.putNumChild(0)
        self.endHash()

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

909
    def dumpInnerValueHelper(self, item):
hjk's avatar
hjk committed
910
        if isSimpleType(item.value.type):
911
            self.safePutItemHelper(item)
hjk's avatar
hjk committed
912

913 914 915 916 917
    def safePutItem(self, item):
        self.beginHash()
        self.safePutItemHelper(item)
        self.endHash()

hjk's avatar
hjk committed
918 919 920 921 922 923 924 925 926 927 928 929
    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)

930
            except RuntimeError:
hjk's avatar
hjk committed
931 932 933 934
                self.output = ""
                # FIXME: Only catch debugger related exceptions
                #exType, exValue, exTraceback = sys.exc_info()
                #tb = traceback.format_exception(exType, exValue, exTraceback)
935
                #warn("Exception: %s" % ex.message)
hjk's avatar
hjk committed
936 937 938 939 940
                # DeprecationWarning: BaseException.message
                # has been deprecated
                #warn("Exception.")
                #for line in tb:
                #    warn("%s" % line)
941 942 943 944
                self.putName(item.name)
                self.putValue("<invalid>")
                self.putType(str(item.value.type))
                self.putNumChild(0)
hjk's avatar
hjk committed
945 946 947 948 949 950 951
                #if self.isExpanded(item):
                self.beginChildren()
                self.endChildren()
        self.pushOutput()

    def putItem(self, item):
        self.beginHash()
hjk's avatar
hjk committed
952
        self.safePutItemHelper(item)
hjk's avatar
hjk committed
953 954 955
        self.endHash()

    def putCallItem(self, name, item, func):
956 957 958 959 960
        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
961

962
    def putItemHelper(self, item):
hjk's avatar
hjk committed
963 964
        name = getattr(item, "name", None)
        if not name is None:
965
            self.putName(name)
hjk's avatar
hjk committed
966

967 968 969 970 971 972 973 974
        if item.value is None:
            # Happens for non-available watchers in gdb versions that
            # need to use gdb.execute instead of gdb.parse_and_eval
            self.putValue("<not available>")
            self.putType("<unknown>")
            self.putNumChild(0)
            return

hjk's avatar
hjk committed
975
        # FIXME: Gui shows references stripped?
976
        #warn(" ");
hjk's avatar
hjk committed
977
        #warn("REAL INAME: %s " % item.iname)
978
        #warn("REAL NAME: %s " % name)
hjk's avatar
hjk committed
979
        #warn("REAL TYPE: %s " % item.value.type)
980
        #warn("REAL VALUE: %s " % item.value)
981 982
        #try:
        #    warn("REAL VALUE: %s " % item.value)
983 984
        #except:
        #    #UnicodeEncodeError:
985
        #    warn("REAL VALUE: <unprintable>")
hjk's avatar
hjk committed
986 987 988 989 990 991 992 993 994 995 996 997 998

        value = item.value
        type = value.type

        if type.code == gdb.TYPE_CODE_REF:
            type = type.target()
            value = value.cast(type)

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

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

hjk's avatar
hjk committed
1000 1001 1002 1003
        #warn(" STRIPPED: %s" % strippedType)
        #warn(" DUMPERS: %s" % self.dumpers)
        #warn(" DUMPERS: %s" % (strippedType in self.dumpers))

1004
        if isSimpleType(type.unqualified()):
1005 1006
            #warn("IS SIMPLE: %s " % type)
            self.putType(item.value.type)
1007 1008
            self.putValue(value)
            self.putNumChild(0)
hjk's avatar
hjk committed
1009 1010

        elif strippedType in self.dumpers:
1011 1012
            #warn("IS DUMPABLE: %s " % type)
            self.putType(item.value.type)
hjk's avatar
hjk committed
1013
            self.dumpers[strippedType](self, item)
1014
            #warn(" RESULT: %s " % self.output)
hjk's avatar
hjk committed
1015 1016

        elif type.code == gdb.TYPE_CODE_ENUM:
1017
            #warn("GENERIC ENUM: %s" % value)
1018
            self.putType(item.value.type)
1019
            self.putValue(value)
hjk's avatar
hjk committed
1020
            self.putNumChild(0)
1021

hjk's avatar
hjk committed
1022 1023

        elif type.code == gdb.TYPE_CODE_PTR:
1024
            isHandled = False
1025
            #warn("A POINTER: %s" % value.type)
1026 1027 1028 1029 1030 1031 1032
            if self.useFancy:
                if isNull(value):
                    self.putValue("0x0")
                    self.putType(item.value.type)
                    self.putNumChild(0)
                    isHandled = True

1033 1034
                target = str(type.target().strip_typedefs().unqualified())
                if (not isHandled) and target == "void":
1035 1036 1037 1038 1039
                    self.putType(item.value.type)
                    self.putValue(str(value))
                    self.putNumChild(0)
                    isHandled = True

1040
                #warn("TARGET: %s " % target)
1041 1042
                if (not isHandled) and (target == "char"
                        or target == "signed char" or target == "unsigned char"):
1043
                    # Display values up to given length directly
1044
                    #warn("CHAR AUTODEREF: %s" % value.address)
1045 1046 1047
                    self.putType(item.value.type)
                    firstNul = -1
                    p = value
1048
                    found = False
1049
                    for i in xrange(100):
1050 1051
                        if p.dereference() == 0:
                            # Found terminating NUL
1052
                            found = True
1053 1054
                            break
                        p += 1
1055 1056 1057 1058 1059 1060 1061
                    if found:
                        self.putValue(encodeCharArray(value, i), "6")
                        self.putNumChild(0)
                    else:
                        self.putValue(encodeCharArray(value, 100) + "2e2e2e", "6")
                        self.putNumChild(0)
                    isHandled = True
1062

1063 1064 1065 1066 1067
            #warn("AUTODEREF: %s" % self.autoDerefPointers)
            #warn("IS HANDLED: %s" % isHandled)
            #warn("RES: %s" % (self.autoDerefPointers and not isHandled))
            if self.autoDerefPointers and not isHandled:
                ## Generic pointer type.
1068
                #warn("GENERIC AUTODEREF POINTER: %s" % value.address)
1069 1070 1071 1072 1073 1074 1075 1076 1077
                innerType = item.value.type.target()
                self.putType(innerType)
                self.childTypes.append(
                    stripClassTag(str(innerType)))
                self.putItemHelper(
                    Item(item.value.dereference(), item.iname, None, None))
                self.childTypes.pop()
                isHandled = True

1078
            # Fall back to plain pointer printing.
1079
            if not isHandled:
1080
                #warn("GENERIC PLAIN POINTER: %s" % value.type)
1081 1082