dumper.py 39.2 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
def listOfLocals(varList):
182 183 184 185
    try:
        frame = gdb.selected_frame()
        #warn("FRAME %s: " % frame)
    except RuntimeError:
186
        warn("FRAME NOT ACCESSIBLE")
hjk's avatar
hjk committed
187
        return []
188

189 190 191
    # gdb-6.8-symbianelf fails here
    hasBlock = 'block' in dir(frame)

192
    items = []
193 194 195 196 197 198 199 200 201
    if hasBlock and isGoodGdb():
        warn("IS GOOD: %s " % varList)
        try:
            block = frame.block()
            #warn("BLOCK: %s " % block)
        except:
            warn("BLOCK NOT ACCESSIBLE")
            return items

202 203 204 205 206 207
        while True:
            if block is None:
                warn("UNEXPECTED 'None' BLOCK")
                break
            for symbol in block:
                name = symbol.print_name
208

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

262 263 264 265
        file = open(filename, "r")
        for line in file:
            if len(line) == 0 or line.startswith(" "):
                continue
266
            # The function parameters
267 268 269
            pos = line.find(" = ")
            if pos < 0:
                continue
270 271
            varList.append(line[0:pos])
        file.close()
272 273 274 275
        try:  # files may still be locked by gdb on Windows
            os.remove(filename)
        except:
            pass
276 277 278
        #warn("VARLIST: %s " % varList)
        for name in varList:
            #warn("NAME %s " % name)
279 280 281 282
            item = Item(0, "local", name, name)
            try:
                item.value = frame.read_var(name)  # this is a gdb value
            except RuntimeError:
283 284
                pass
                #continue
285 286 287 288 289
            items.append(item)

    return items


290
def value(expr):
291
    value = parseAndEvaluate(expr)
292 293 294 295 296
    try:
        return int(value)
    except:
        return str(value)

297

hjk's avatar
hjk committed
298
def isSimpleType(typeobj):
299 300
    if typeobj.code == gdb.TYPE_CODE_PTR:
        return False
hjk's avatar
hjk committed
301 302 303 304 305 306 307 308
    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 ") \
309
        or type == "signed" or type.startswith("signed ") \
hjk's avatar
hjk committed
310 311
        or type == "unsigned" or type.startswith("unsigned ")

312

hjk's avatar
hjk committed
313 314 315 316 317 318 319 320 321
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):
322 323
    if True or verbosity > 0:
        print "XXX: %s\n" % message.encode("latin1")
hjk's avatar
hjk committed
324 325 326 327 328 329
    pass

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

330 331 332 333 334
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
335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355
#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):
356 357 358 359
    # 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 ")
360
    return p.cast(gdb.lookup_type("void").pointer()) == 0
hjk's avatar
hjk committed
361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386

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):
387
    for i in xrange(n):
hjk's avatar
hjk committed
388 389 390 391 392 393
        checkPointer(p)
        ++p

def call(value, func):
    #warn("CALL: %s -> %s" % (value, func))
    type = stripClassTag(str(value.type))
394
    if type.find(":") >= 0:
hjk's avatar
hjk committed
395 396 397
        type = "'" + type + "'"
    exp = "((%s*)%s)->%s" % (type, value.address, func)
    #warn("CALL: %s" % exp)
398
    result = parseAndEvaluate(exp)
hjk's avatar
hjk committed
399 400 401
    #warn("  -> %s" % result)
    return result

402 403
def qtNamespace():
    try:
404
        type = str(parseAndEvaluate("&QString::null").type.target().unqualified())
405 406 407
        return type[0:len(type) - len("QString::null")]
    except RuntimeError:
        return ""
408 409 410
    except AttributeError:
        # Happens for none-Qt applications
        return ""
hjk's avatar
hjk committed
411

412 413
def encodeCharArray(p, size):
    s = ""
414
    p = p.cast(gdb.lookup_type("unsigned char").pointer())
415
    for i in xrange(size):
416 417 418 419
        s += "%02x" % int(p.dereference())
        p += 1
    return s

420 421 422 423 424 425
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)
426
    checkRef(d_ptr["ref"])
427 428 429 430 431 432
    if size > 0:
        checkAccess(data, 4)
        checkAccess(data + size) == 0

    innerType = gdb.lookup_type("char")
    p = gdb.Value(data.cast(innerType.pointer()))
433
    return encodeCharArray(p, size)
434 435 436 437 438 439 440 441 442 443

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
444
    checkRef(d_ptr["ref"])
445 446
    p = gdb.Value(d_ptr["data"])
    s = ""
447
    for i in xrange(size):
448 449 450 451 452 453
        val = int(p.dereference())
        s += "%02x" % (val % 256)
        s += "%02x" % (val / 256)
        p += 1
    return s

hjk's avatar
hjk committed
454 455 456 457 458 459 460
#######################################################################
#
# Item
#
#######################################################################

class Item:
461
    def __init__(self, value, parentiname, iname, name = None):
hjk's avatar
hjk committed
462
        self.value = value
463 464 465 466
        if iname is None:
            self.iname = parentiname
        else:
            self.iname = "%s.%s" % (parentiname, iname)
hjk's avatar
hjk committed
467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483
        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(' ')
484

hjk's avatar
hjk committed
485 486
        #warn("ARG: %s" % arg)
        #warn("ARGS: %s" % args)
487
        options = args[0].split(",")
488 489 490 491 492 493 494 495 496 497 498
        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)

499
        useFancy = "fancy" in options
500 501

        #warn("VARIABLES: %s" % varList)
hjk's avatar
hjk committed
502 503 504 505
        #warn("EXPANDED INAMES: %s" % expandedINames)
        module = sys.modules[__name__]
        self.dumpers = {}

hjk's avatar
hjk committed
506 507 508
        if useFancy == -1:
            output = "dumpers=["
            for key, value in module.__dict__.items():
509
                if key.startswith("qdump__"):
hjk's avatar
hjk committed
510 511
                    if output != "dumpers=[":
                        output += ","
512
                    output += '"' + key[7:] + '"'
hjk's avatar
hjk committed
513 514
            output += "],"
            #output += "qtversion=[%d,%d,%d]"
515
            #output += "qtversion=[4,6,0],"
hjk's avatar
hjk committed
516 517 518 519 520 521 522
            output += "namespace=\"%s\"," % qtNamespace()
            output += "dumperversion=\"2.0\","
            output += "sizes=[],"
            output += "expressions=[]"
            output += "]"
            print output
            return
523

524

hjk's avatar
hjk committed
525 526
        if useFancy:
            for key, value in module.__dict__.items():
527 528
                if key.startswith("qdump__"):
                    self.dumpers[key[7:]] = value
hjk's avatar
hjk committed
529 530 531

        d = Dumper()
        d.dumpers = self.dumpers
532 533 534
        d.useFancy = useFancy
        d.passExceptions = "passexceptions" in options
        d.autoDerefPointers = "autoderef" in options
535
        d.ns = qtNamespace()
536
        d.expandedINames = expandedINames
hjk's avatar
hjk committed
537 538
        #warn(" NAMESPACE IS: '%s'" % d.ns)

539 540 541
        #
        # Locals
        #
542
        for item in listOfLocals(varList):
543
            #warn("ITEM NAME %s: " % item.name)
544 545 546 547 548 549 550 551 552 553 554 555 556 557 558
            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
559 560 561 562

            type = item.value.type
            if type.code == gdb.TYPE_CODE_PTR \
                    and item.name == "argv" and str(type) == "char **":
563
                # Special handling for char** argv.
564 565
                n = 0
                p = item.value
566 567 568 569 570
                # p is 0 for "optimized out" cases.
                if not isNull(p):
                    while not isNull(p.dereference()) and n <= 100:
                        p += 1
                        n += 1
571 572 573 574 575 576 577 578

                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):
579
                    p = item.value
580
                    d.beginChildren(n)
581
                    for i in xrange(n):
582 583
                        value = p.dereference()
                        d.putItem(Item(value, item.iname, i, None))
584
                        p += 1
585 586 587 588 589 590
                    if n > 100:
                        d.putEllipsis()
                    d.endChildren()
                d.endHash()

            else:
591
                # A "normal" local variable or parameter.
592 593 594 595 596 597 598 599
                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:
600 601
                    # Thrown by cleanAddress with message "'NoneType' object
                    # has no attribute 'cast'" for optimized-out values.
602 603 604 605 606 607 608
                    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
609

610 611 612 613
        d.pushOutput()
        locals = d.safeoutput


614 615 616
        #
        # Watchers
        #
617
        d.safeoutput = ""
618
        if len(watchers) > 0:
619
            for watcher in watchers.split("##"):
620 621
                (exp, iname) = watcher.split("#")
                self.handleWatch(d, exp, iname)
622 623 624
        d.pushOutput()
        watchers = d.safeoutput

hjk's avatar
hjk committed
625 626 627 628
        sep = ""
        if len(locals) and len(watchers):
            sep = ","

629 630 631
        #
        # Breakpoints
        #
632
        breakpoints = ""
633 634 635 636
        d.safeoutput = ""
        listOfBreakpoints(d)
        d.pushOutput()
        breakpoints = d.safeoutput
637 638

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

641

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

hjk's avatar
hjk committed
689 690 691 692

FrameCommand()


693 694 695 696 697 698 699 700 701 702 703 704 705 706
#######################################################################
#
# 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):
707 708
        (cmd, addr) = arg.split(",")
        lines = catchCliOutput("info line *" + addr)
709 710 711 712 713 714 715 716 717 718
        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]
719
        gdb.execute("maint packet sal%s,%s,%s" % (cmd,fromAddr, toAddr))
720 721

SalCommand()
hjk's avatar
hjk committed
722

723

hjk's avatar
hjk committed
724 725 726 727 728 729 730 731 732 733 734 735
#######################################################################
#
# The Dumper Class
#
#######################################################################

class Dumper:
    def __init__(self):
        self.output = ""
        self.safeoutput = ""
        self.childTypes = [""]
        self.childNumChilds = [-1]
736 737
        self.maxNumChilds = [-1]
        self.numChilds = [-1]
hjk's avatar
hjk committed
738 739 740 741 742

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

    def putField(self, name, value):
hjk's avatar
hjk committed
743
        self.put('%s="%s",' % (name, value))
hjk's avatar
hjk committed
744 745 746 747 748

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

    def endHash(self):
hjk's avatar
hjk committed
749
        self.put('},')
hjk's avatar
hjk committed
750 751

    def beginItem(self, name):
hjk's avatar
hjk committed
752
        self.put('%s="' %s)
hjk's avatar
hjk committed
753 754

    def endItem(self):
hjk's avatar
hjk committed
755
        self.put('",')
hjk's avatar
hjk committed
756

757
    def beginChildren(self, numChild_ = 1, childType_ = None, childNumChild_ = None):
hjk's avatar
hjk committed
758 759
        childType = ""
        childNumChild = -1
760 761 762 763 764 765
        if type(numChild_) is list:
            numChild = numChild_[0]
            maxNumChild = numChild_[1]
        else:
            numChild = numChild_
            maxNumChild = numChild_
766
        if numChild == 0:
767 768 769
            childType_ = None
        if not childType_ is None:
            childType = stripClassTag(str(childType_))
770
            self.put('childtype="%s",' % childType)
771
            if isSimpleType(childType_) or isStringType(self, childType_):
772
                self.put('childnumchild="0",')
hjk's avatar
hjk committed
773
                childNumChild = 0
774
            elif childType_.code == gdb.TYPE_CODE_PTR:
775
                self.put('childnumchild="1",')
hjk's avatar
hjk committed
776
                childNumChild = 1
777 778 779
        if not childNumChild_ is None:
            self.put('childnumchild="%s",' % childNumChild_)
            childNumChild = childNumChild_
hjk's avatar
hjk committed
780 781
        self.childTypes.append(childType)
        self.childNumChilds.append(childNumChild)
782 783
        self.numChilds.append(numChild)
        self.maxNumChilds.append(maxNumChild)
hjk's avatar
hjk committed
784 785 786 787 788
        #warn("BEGIN: %s" % self.childTypes)
        self.put("children=[")

    def endChildren(self):
        #warn("END: %s" % self.childTypes)
789 790 791 792
        numChild = self.numChilds.pop()
        maxNumChild = self.maxNumChilds.pop()
        if maxNumChild < numChild:
            self.putEllipsis();
hjk's avatar
hjk committed
793 794
        self.childTypes.pop()
        self.childNumChilds.pop()
hjk's avatar
hjk committed
795
        self.put('],')
hjk's avatar
hjk committed
796

797 798 799
    def childRange(self):
        return xrange(qmin(self.maxNumChilds[-1], self.numChilds[-1]))

hjk's avatar
hjk committed
800 801
    # convenience
    def putItemCount(self, count):
hjk's avatar
hjk committed
802
        self.put('value="<%s items>",' % count)
hjk's avatar
hjk committed
803 804

    def putEllipsis(self):
hjk's avatar
hjk committed
805
        self.put('{name="<incomplete>",value="",type="",numchild="0"},')
hjk's avatar
hjk committed
806 807 808 809 810 811

    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
812
            self.put('type="%s",' % type) # str(type.unqualified()) ?
hjk's avatar
hjk committed
813 814 815

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

819 820 821 822 823 824
    def putValue(self, value, encoding = None):
        if not encoding is None:
            self.putField("valueencoded", encoding)
        self.putField("value", value)

    def putStringValue(self, value):
825
        if value is None:
hjk's avatar
hjk committed
826
            self.put('value="<not available>",')
827 828
        else:
            str = encodeString(value)
hjk's avatar
hjk committed
829
            self.put('valueencoded="%d",value="%s",' % (7, str))
830 831 832

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

835
    def putName(self, name):
hjk's avatar
hjk committed
836
        self.put('name="%s",' % name)
837

hjk's avatar
hjk committed
838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855
    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):
856 857 858 859 860
        # 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
861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878
        # 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()
879 880
        self.putName(name)
        self.putValue(value)
hjk's avatar
hjk committed
881 882 883 884 885 886
        self.putType("int")
        self.putNumChild(0)
        self.endHash()

    def putBoolItem(self, name, value):
        self.beginHash()
887 888
        self.putName(name)
        self.putValue(value)
hjk's avatar
hjk committed
889 890 891 892 893 894 895 896 897
        self.putType("bool")
        self.putNumChild(0)
        self.endHash()

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

898
    def dumpInnerValueHelper(self, item):
hjk's avatar
hjk committed
899
        if isSimpleType(item.value.type):
900
            self.safePutItemHelper(item)
hjk's avatar
hjk committed
901

902 903 904 905 906
    def safePutItem(self, item):
        self.beginHash()
        self.safePutItemHelper(item)
        self.endHash()

hjk's avatar
hjk committed
907 908 909 910 911 912 913 914 915 916 917 918
    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)

919
            except RuntimeError:
hjk's avatar
hjk committed
920 921 922 923
                self.output = ""
                # FIXME: Only catch debugger related exceptions
                #exType, exValue, exTraceback = sys.exc_info()
                #tb = traceback.format_exception(exType, exValue, exTraceback)
924
                #warn("Exception: %s" % ex.message)
hjk's avatar
hjk committed
925 926 927 928 929
                # DeprecationWarning: BaseException.message
                # has been deprecated
                #warn("Exception.")
                #for line in tb:
                #    warn("%s" % line)
930 931 932 933
                self.putName(item.name)
                self.putValue("<invalid>")
                self.putType(str(item.value.type))
                self.putNumChild(0)
hjk's avatar
hjk committed
934 935 936 937 938 939 940
                #if self.isExpanded(item):
                self.beginChildren()
                self.endChildren()
        self.pushOutput()

    def putItem(self, item):
        self.beginHash()
hjk's avatar
hjk committed
941
        self.safePutItemHelper(item)
hjk's avatar
hjk committed
942 943 944
        self.endHash()

    def putCallItem(self, name, item, func):
945 946 947 948 949
        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
950

951
    def putItemHelper(self, item):
hjk's avatar
hjk committed
952 953
        name = getattr(item, "name", None)
        if not name is None:
954
            self.putName(name)
hjk's avatar
hjk committed
955

956 957 958 959 960 961 962 963
        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
964
        # FIXME: Gui shows references stripped?
965
        #warn(" ");
hjk's avatar
hjk committed
966
        #warn("REAL INAME: %s " % item.iname)
967
        #warn("REAL NAME: %s " % name)
hjk's avatar
hjk committed
968
        #warn("REAL TYPE: %s " % item.value.type)
969
        #warn("REAL VALUE: %s " % item.value)
970 971
        #try:
        #    warn("REAL VALUE: %s " % item.value)
972 973
        #except:
        #    #UnicodeEncodeError:
974
        #    warn("REAL VALUE: <unprintable>")
hjk's avatar
hjk committed
975 976 977 978 979 980 981 982 983 984 985 986 987

        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("::", "__")
988

hjk's avatar
hjk committed
989 990 991 992
        #warn(" STRIPPED: %s" % strippedType)
        #warn(" DUMPERS: %s" % self.dumpers)
        #warn(" DUMPERS: %s" % (strippedType in self.dumpers))

993
        if isSimpleType(type.unqualified()):
994 995
            #warn("IS SIMPLE: %s " % type)
            self.putType(item.value.type)
996 997
            self.putValue(value)
            self.putNumChild(0)
hjk's avatar
hjk committed
998 999

        elif strippedType in self.dumpers:
1000 1001
            #warn("IS DUMPABLE: %s " % type)
            self.putType(item.value.type)
hjk's avatar
hjk committed
1002
            self.dumpers[strippedType](self, item)
1003
            #warn(" RESULT: %s " % self.output)
hjk's avatar
hjk committed
1004 1005

        elif type.code == gdb.TYPE_CODE_ENUM:
1006
            #warn("GENERIC ENUM: %s" % value)
1007
            self.putType(item.value.type)
1008
            self.putValue(value)
hjk's avatar
hjk committed
1009
            self.putNumChild(0)
1010

hjk's avatar
hjk committed
1011 1012

        elif type.code == gdb.TYPE_CODE_PTR:
1013
            isHandled = False
1014
            #warn("A POINTER: %s" % value.type)
1015 1016 1017 1018 1019 1020 1021
            if self.useFancy:
                if isNull(value):
                    self.putValue("0x0")
                    self.putType(item.value.type)
                    self.putNumChild(0)
                    isHandled = True

1022 1023
                target = str(type.target().strip_typedefs().unqualified())
                if (not isHandled) and target == "void":
1024 1025 1026 1027 1028
                    self.putType(item.value.type)
                    self.putValue(str(value))
                    self.putNumChild(0)
                    isHandled = True

1029
                #warn("TARGET: %s " % target)
1030 1031
                if (not isHandled) and (target == "char"
                        or target == "signed char" or target == "unsigned char"):
1032
                    # Display values up to given length directly
1033
                    #warn("CHAR AUTODEREF: %s" % value.address)
1034 1035 1036
                    self.putType(item.value.type)
                    firstNul = -1
                    p = value
1037
                    found = False
1038
                    for i in xrange(100):
1039 1040
                        if p.dereference() == 0:
                            # Found terminating NUL
1041
                            found = True
1042 1043
                            break
                        p += 1
1044 1045 1046 1047 1048 1049 1050
                    if found:
                        self.putValue(encodeCharArray(value, i), "6")
                        self.putNumChild(0)
                    else:
                        self.putValue(encodeCharArray(value, 100) + "2e2e2e", "6")
                        self.putNumChild(0)
                    isHandled = True
1051

1052 1053 1054 1055 1056
            #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.
1057
                #warn("GENERIC AUTODEREF POINTER: %s" % value.address)
1058 1059 1060 1061 1062 1063 1064 1065 1066
                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

1067
            # Fall back to plain pointer printing.
1068
            if not isHandled:
1069
                #warn("GENERIC PLAIN POINTER: %s" % value.type)
1070 1071 1072 1073 1074 1075 1076 1077
                self.putType(item.value.type)
                self.putValue(str(value.address))
                self.putNumChild(1)
                if self.isExpanded(item):
                    self.beginChildren()
                    self.putItem(
                          Item(item.value.dereference(), item.iname, "*", "*"))
                    self.endChildren()
hjk's avatar
hjk committed
1078 1079

        else:
hjk's avatar