dumper.py 43 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
import os
11
import __builtin__
12

13 14 15 16 17 18
if os.name == "nt":
    def printableChar(ucs):
        if ucs >= 32 and ucs <= 126:
            return ucs
        return '?'
else:
19
    import curses.ascii
20 21
    def printableChar(ucs):
        return select(curses.ascii.isprint(ucs), ucs, '?')
hjk's avatar
hjk committed
22

23
# only needed for gdb 7.0/7.0.1 that do not implement parse_and_eval
24 25 26
import os
import tempfile

hjk's avatar
hjk committed
27 28 29
verbosity = 0
verbosity = 1

30 31 32 33 34
def select(condition, if_expr, else_expr):
    if condition:
        return if_expr
    return else_expr

35 36 37 38 39
def qmin(n, m):
    if n < m:
        return n
    return m

hjk's avatar
hjk committed
40
def isGoodGdb():
41 42
    #return gdb.VERSION.startswith("6.8.50.2009") \
    #   and gdb.VERSION != "6.8.50.20090630-cvs"
43
    return 'parse_and_eval' in __builtin__.dir(gdb)
hjk's avatar
hjk committed
44

45
def cleanAddress(addr):
46 47
    if addr is None:
        return "<no address>"
48 49
    # We cannot use str(addr) as it yields rubbish for char pointers
    # that might trigger Unicode encoding errors.
50
    return addr.cast(gdb.lookup_type("void").pointer())
51

hjk's avatar
hjk committed
52 53 54 55
# Workaround for gdb < 7.1
def numericTemplateArgument(type, position):
    try:
        return int(type.template_argument(position))
56
    except RuntimeError, error:
hjk's avatar
hjk committed
57 58 59 60
        # ": No type named 30."
        msg = str(error)
        return int(msg[14:-1])

61
def parseAndEvaluate(exp):
hjk's avatar
hjk committed
62
    if isGoodGdb():
63 64 65 66
        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")
67 68 69 70
    try:
        gdb.execute("print %s" % exp)
    except:
        gdb.execute("set logging off")
71
        gdb.execute("set logging redirect off")
72
        return None
73
    gdb.execute("set logging off")
74
    gdb.execute("set logging redirect off")
75 76
    return gdb.history(0)

77

78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100
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


101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124
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"
125
    #6       breakpoint     keep y   0xb6cf18e5 <__cxa_throw+5>\n"
126
    lines = catchCliOutput("info break")
127 128 129 130

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


193 194 195 196 197 198 199 200 201 202 203
# 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


204
def listOfLocals(varList):
205 206 207 208
    try:
        frame = gdb.selected_frame()
        #warn("FRAME %s: " % frame)
    except RuntimeError:
209
        warn("FRAME NOT ACCESSIBLE")
hjk's avatar
hjk committed
210
        return []
211

212
    # gdb-6.8-symbianelf fails here
213
    hasBlock = 'block' in __builtin__.dir(frame)
214

215
    items = []
216 217 218 219 220 221 222 223 224
    if hasBlock and isGoodGdb():
        warn("IS GOOD: %s " % varList)
        try:
            block = frame.block()
            #warn("BLOCK: %s " % block)
        except:
            warn("BLOCK NOT ACCESSIBLE")
            return items

225 226 227 228 229 230
        while True:
            if block is None:
                warn("UNEXPECTED 'None' BLOCK")
                break
            for symbol in block:
                name = symbol.print_name
231

232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254
                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
255
        # Assuming gdb 7.0 release or 6.8-symbianelf.
256 257
        file = tempfile.mkstemp(prefix="gdbpy_")
        filename = file[1]
258 259
        #warn("VARLIST: %s " % varList)
        #warn("VARLIST: %s " % len(varList))
hjk's avatar
hjk committed
260 261
        gdb.execute("set logging off")
        gdb.execute("set logging redirect off")
262 263 264
        gdb.execute("set logging file %s" % filename)
        gdb.execute("set logging redirect on")
        gdb.execute("set logging on")
265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281
        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
282 283
        gdb.execute("set logging off")
        gdb.execute("set logging redirect off")
284

285 286 287 288
        file = open(filename, "r")
        for line in file:
            if len(line) == 0 or line.startswith(" "):
                continue
289
            # The function parameters
290 291 292
            pos = line.find(" = ")
            if pos < 0:
                continue
293 294
            varList.append(line[0:pos])
        file.close()
295 296 297 298
        try:  # files may still be locked by gdb on Windows
            os.remove(filename)
        except:
            pass
299 300 301
        #warn("VARLIST: %s " % varList)
        for name in varList:
            #warn("NAME %s " % name)
302 303 304 305
            item = Item(0, "local", name, name)
            try:
                item.value = frame.read_var(name)  # this is a gdb value
            except RuntimeError:
306 307
                pass
                #continue
308 309 310 311 312
            items.append(item)

    return items


313
def value(expr):
314
    value = parseAndEvaluate(expr)
315 316 317 318 319
    try:
        return int(value)
    except:
        return str(value)

320

hjk's avatar
hjk committed
321
def isSimpleType(typeobj):
322 323
    if typeobj.code == gdb.TYPE_CODE_PTR:
        return False
hjk's avatar
hjk committed
324 325 326 327 328 329 330 331
    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 ") \
332
        or type == "signed" or type.startswith("signed ") \
hjk's avatar
hjk committed
333 334
        or type == "unsigned" or type.startswith("unsigned ")

335

hjk's avatar
hjk committed
336 337 338 339 340 341 342 343 344
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):
345 346
    if True or verbosity > 0:
        print "XXX: %s\n" % message.encode("latin1")
hjk's avatar
hjk committed
347 348 349 350 351 352
    pass

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

353 354 355 356 357
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
358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378
#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):
379 380 381 382
    # 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 ")
383
    return p.cast(gdb.lookup_type("void").pointer()) == 0
hjk's avatar
hjk committed
384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409

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):
410
    for i in xrange(n):
hjk's avatar
hjk committed
411 412 413 414 415 416
        checkPointer(p)
        ++p

def call(value, func):
    #warn("CALL: %s -> %s" % (value, func))
    type = stripClassTag(str(value.type))
417
    if type.find(":") >= 0:
hjk's avatar
hjk committed
418 419 420
        type = "'" + type + "'"
    exp = "((%s*)%s)->%s" % (type, value.address, func)
    #warn("CALL: %s" % exp)
421
    result = parseAndEvaluate(exp)
hjk's avatar
hjk committed
422 423 424
    #warn("  -> %s" % result)
    return result

425 426
def qtNamespace():
    try:
427
        type = str(parseAndEvaluate("&QString::null").type.target().unqualified())
428 429 430
        return type[0:len(type) - len("QString::null")]
    except RuntimeError:
        return ""
431 432 433
    except AttributeError:
        # Happens for none-Qt applications
        return ""
hjk's avatar
hjk committed
434

435 436 437 438 439 440 441 442 443 444 445 446
def findFirstZero(p, max):
    for i in xrange(max):
        if p.dereference() == 0:
            return i
        p = p + 1
    return -1

def encodeCharArray(p, maxsize):
    t = gdb.lookup_type("unsigned char").pointer()
    p = p.cast(t)
    i = findFirstZero(p, maxsize)
    limit = select(i < 0, maxsize, i)
447
    s = ""
448
    for i in xrange(limit):
449 450
        s += "%02x" % int(p.dereference())
        p += 1
451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478
    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"
479 480
    return s

481 482 483 484 485 486
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)
487
    checkRef(d_ptr["ref"])
488 489 490
    if size > 0:
        checkAccess(data, 4)
        checkAccess(data + size) == 0
491
    return encodeCharArray(data, size)
492 493 494 495 496 497 498 499 500 501

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
502
    checkRef(d_ptr["ref"])
503 504
    p = gdb.Value(d_ptr["data"])
    s = ""
505
    for i in xrange(size):
506 507 508 509 510 511
        val = int(p.dereference())
        s += "%02x" % (val % 256)
        s += "%02x" % (val / 256)
        p += 1
    return s

hjk's avatar
hjk committed
512 513 514 515 516 517 518
#######################################################################
#
# Item
#
#######################################################################

class Item:
519
    def __init__(self, value, parentiname, iname, name = None):
hjk's avatar
hjk committed
520
        self.value = value
521 522 523 524
        if iname is None:
            self.iname = parentiname
        else:
            self.iname = "%s.%s" % (parentiname, iname)
hjk's avatar
hjk committed
525 526 527 528 529 530 531 532 533 534 535 536 537 538 539
        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)

540 541 542 543 544
    def invoke(self, args, from_tty):
        options = []
        varList = []
        typeformats = {}
        formats = {}
545
        watchers = ""
546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566
        for arg in args.split(' '):
            pos = arg.find(":") + 1
            if arg.startswith("options:"):
                options = arg[pos:].split(",")
            elif arg.startswith("vars:"):
                vars = arg[pos:].split(",")
            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)
567

568
        useFancy = "fancy" in options
569 570

        #warn("VARIABLES: %s" % varList)
hjk's avatar
hjk committed
571 572 573 574
        #warn("EXPANDED INAMES: %s" % expandedINames)
        module = sys.modules[__name__]
        self.dumpers = {}

hjk's avatar
hjk committed
575 576 577
        if useFancy == -1:
            output = "dumpers=["
            for key, value in module.__dict__.items():
578
                if key.startswith("qdump__"):
hjk's avatar
hjk committed
579 580
                    if output != "dumpers=[":
                        output += ","
581
                    output += '"' + key[7:] + '"'
hjk's avatar
hjk committed
582 583
            output += "],"
            #output += "qtversion=[%d,%d,%d]"
584
            #output += "qtversion=[4,6,0],"
hjk's avatar
hjk committed
585 586 587 588 589 590 591
            output += "namespace=\"%s\"," % qtNamespace()
            output += "dumperversion=\"2.0\","
            output += "sizes=[],"
            output += "expressions=[]"
            output += "]"
            print output
            return
592

593

hjk's avatar
hjk committed
594 595
        if useFancy:
            for key, value in module.__dict__.items():
596 597
                if key.startswith("qdump__"):
                    self.dumpers[key[7:]] = value
hjk's avatar
hjk committed
598 599 600

        d = Dumper()
        d.dumpers = self.dumpers
601 602
        d.typeformats = typeformats
        d.formats = formats
603 604 605
        d.useFancy = useFancy
        d.passExceptions = "passexceptions" in options
        d.autoDerefPointers = "autoderef" in options
606
        d.ns = qtNamespace()
607
        d.expandedINames = expandedINames
hjk's avatar
hjk committed
608 609
        #warn(" NAMESPACE IS: '%s'" % d.ns)

610 611 612
        #
        # Locals
        #
613
        for item in listOfLocals(varList):
614
            #warn("ITEM NAME %s: " % item.name)
615 616 617
            try:
                #warn("ITEM VALUE %s: " % item.value)
                # Throw on funny stuff, catch below.
hjk's avatar
hjk committed
618 619 620 621
                # Unfortunately, this fails also with a "Unicode encoding error"
                # in testArray().
                #dummy = str(item.value)
                pass
622 623 624 625 626 627 628 629 630 631 632
            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
633 634 635 636

            type = item.value.type
            if type.code == gdb.TYPE_CODE_PTR \
                    and item.name == "argv" and str(type) == "char **":
637
                # Special handling for char** argv.
638 639
                n = 0
                p = item.value
640 641 642 643 644
                # p is 0 for "optimized out" cases.
                if not isNull(p):
                    while not isNull(p.dereference()) and n <= 100:
                        p += 1
                        n += 1
645 646 647 648 649 650 651 652

                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):
653
                    p = item.value
654
                    d.beginChildren(n)
655
                    for i in xrange(n):
656 657
                        value = p.dereference()
                        d.putItem(Item(value, item.iname, i, None))
658
                        p += 1
659 660 661 662 663 664
                    if n > 100:
                        d.putEllipsis()
                    d.endChildren()
                d.endHash()

            else:
665
                # A "normal" local variable or parameter.
666
                try:
667 668 669 670 671 672
                   addr = cleanAddress(item.value.address)
                   d.beginHash()
                   d.put('iname="%s",' % item.iname)
                   d.put('addr="%s",' % addr)
                   d.safePutItemHelper(item)
                   d.endHash()
673
                except AttributeError:
674 675
                    # Thrown by cleanAddress with message "'NoneType' object
                    # has no attribute 'cast'" for optimized-out values.
676 677 678 679 680 681 682
                    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
683

684 685 686 687
        d.pushOutput()
        locals = d.safeoutput


688 689 690
        #
        # Watchers
        #
691
        d.safeoutput = ""
692
        if len(watchers) > 0:
693
            for watcher in watchers.split("##"):
694 695
                (exp, iname) = watcher.split("#")
                self.handleWatch(d, exp, iname)
696 697 698
        d.pushOutput()
        watchers = d.safeoutput

hjk's avatar
hjk committed
699 700 701 702
        sep = ""
        if len(locals) and len(watchers):
            sep = ","

703 704 705
        #
        # Breakpoints
        #
706 707 708 709 710 711 712 713
        #breakpoints = ""
        #d.safeoutput = ""
        #listOfBreakpoints(d)
        #d.pushOutput()
        #breakpoints = d.safeoutput

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

715

716 717
    def handleWatch(self, d, exp, iname):
        #warn("HANDLING WATCH %s, INAME: '%s'" % (exp, iname))
718
        if exp.startswith("["):
719
            warn("EVAL: EXP: %s" % exp)
720
            d.beginHash()
721
            d.put('iname="%s",' % iname)
722
            d.put('name="%s",' % exp)
723
            d.put('exp="%s",' % exp)
724 725
            try:
                list = eval(exp)
726
                #warn("EVAL: LIST: %s" % list)
727 728 729 730 731 732 733
                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:
734
                    self.handleWatch(d, item, "%s.%d" % (iname, itemNumber))
735 736 737 738 739 740 741 742 743 744 745 746 747
                    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()
748
        d.put('iname="%s",' % iname)
749
        d.put('name="%s",' % exp)
750
        d.put('exp="%s",' % exp)
751 752
        handled = False
        if exp == "<Edit>":
hjk's avatar
hjk committed
753
            d.put('value=" ",type=" ",numchild="0",')
754
        else:
755
            try:
756
                value = parseAndEvaluate(exp)
757
                item = Item(value, iname, None, None)
758
                d.putItemHelper(item)
759
            except RuntimeError:
hjk's avatar
hjk committed
760
                d.put('value="<invalid>",type="<unknown>",numchild="0",')
761
        d.endHash()
762

hjk's avatar
hjk committed
763 764 765 766

FrameCommand()


767 768 769 770 771 772 773 774 775 776 777 778 779 780
#######################################################################
#
# 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):
781 782
        (cmd, addr) = arg.split(",")
        lines = catchCliOutput("info line *" + addr)
783 784 785 786 787 788 789 790 791 792
        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]
793
        gdb.execute("maint packet sal%s,%s,%s" % (cmd,fromAddr, toAddr))
794 795

SalCommand()
hjk's avatar
hjk committed
796

797

hjk's avatar
hjk committed
798 799 800 801 802 803 804 805 806 807 808 809
#######################################################################
#
# The Dumper Class
#
#######################################################################

class Dumper:
    def __init__(self):
        self.output = ""
        self.safeoutput = ""
        self.childTypes = [""]
        self.childNumChilds = [-1]
810 811
        self.maxNumChilds = [-1]
        self.numChilds = [-1]
hjk's avatar
hjk committed
812 813 814 815 816

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

    def putField(self, name, value):
hjk's avatar
hjk committed
817
        self.put('%s="%s",' % (name, value))
hjk's avatar
hjk committed
818 819 820 821 822

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

    def endHash(self):
hjk's avatar
hjk committed
823
        self.put('},')
hjk's avatar
hjk committed
824 825

    def beginItem(self, name):
hjk's avatar
hjk committed
826
        self.put('%s="' %s)
hjk's avatar
hjk committed
827 828

    def endItem(self):
hjk's avatar
hjk committed
829
        self.put('",')
hjk's avatar
hjk committed
830

831
    def beginChildren(self, numChild_ = 1, childType_ = None, childNumChild_ = None):
hjk's avatar
hjk committed
832 833
        childType = ""
        childNumChild = -1
834 835 836 837 838 839
        if type(numChild_) is list:
            numChild = numChild_[0]
            maxNumChild = numChild_[1]
        else:
            numChild = numChild_
            maxNumChild = numChild_
840
        if numChild == 0:
841 842 843
            childType_ = None
        if not childType_ is None:
            childType = stripClassTag(str(childType_))
844
            self.put('childtype="%s",' % childType)
845
            if isSimpleType(childType_) or isStringType(self, childType_):
846
                self.put('childnumchild="0",')
hjk's avatar
hjk committed
847
                childNumChild = 0
848
            elif childType_.code == gdb.TYPE_CODE_PTR:
849
                self.put('childnumchild="1",')
hjk's avatar
hjk committed
850
                childNumChild = 1
851 852 853
        if not childNumChild_ is None:
            self.put('childnumchild="%s",' % childNumChild_)
            childNumChild = childNumChild_
hjk's avatar
hjk committed
854 855
        self.childTypes.append(childType)
        self.childNumChilds.append(childNumChild)
856 857
        self.numChilds.append(numChild)
        self.maxNumChilds.append(maxNumChild)
hjk's avatar
hjk committed
858 859 860 861 862
        #warn("BEGIN: %s" % self.childTypes)
        self.put("children=[")

    def endChildren(self):
        #warn("END: %s" % self.childTypes)
863 864 865 866
        numChild = self.numChilds.pop()
        maxNumChild = self.maxNumChilds.pop()
        if maxNumChild < numChild:
            self.putEllipsis();
hjk's avatar
hjk committed
867 868
        self.childTypes.pop()
        self.childNumChilds.pop()
hjk's avatar
hjk committed
869
        self.put('],')
hjk's avatar
hjk committed
870

871 872 873
    def childRange(self):
        return xrange(qmin(self.maxNumChilds[-1], self.numChilds[-1]))

hjk's avatar
hjk committed
874 875
    # convenience
    def putItemCount(self, count):
hjk's avatar
hjk committed
876
        self.put('value="<%s items>",' % count)
hjk's avatar
hjk committed
877 878

    def putEllipsis(self):
hjk's avatar
hjk committed
879
        self.put('{name="<incomplete>",value="",type="",numchild="0"},')
hjk's avatar
hjk committed
880 881 882 883 884 885

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

888 889 890
    def putAddress(self, addr):
        self.put('addr="%s",' % cleanAddress(addr))

hjk's avatar
hjk committed
891 892
    def putNumChild(self, numchild):
        #warn("NUM CHILD: '%s' '%s'" % (numchild, self.childNumChilds[-1]))
893
        if numchild != self.childNumChilds[-1]:
hjk's avatar
hjk committed
894
            self.put('numchild="%s",' % numchild)
hjk's avatar
hjk committed
895

896 897 898 899 900 901
    def putValue(self, value, encoding = None):
        if not encoding is None:
            self.putField("valueencoded", encoding)
        self.putField("value", value)

    def putStringValue(self, value):
902
        if value is None:
hjk's avatar
hjk committed
903
            self.put('value="<not available>",')
904 905
        else:
            str = encodeString(value)
hjk's avatar
hjk committed
906
            self.put('valueencoded="%d",value="%s",' % (7, str))
907 908 909

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

912
    def putName(self, name):
hjk's avatar
hjk committed
913
        self.put('name="%s",' % name)
914

hjk's avatar
hjk committed
915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932
    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):
933 934 935 936 937
        # 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
938 939 940 941
        type = stripClassTag(str(typeobj))
        if len(self.ns) > 0 and type.startswith(self.ns):
            type = type[len(self.ns):]
        pos = type.find("<")
942 943 944 945 946
        # 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
947 948 949 950 951 952 953 954 955 956 957
        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()
958 959
        self.putName(name)
        self.putValue(value)
hjk's avatar
hjk committed
960 961 962 963 964 965
        self.putType("int")
        self.putNumChild(0)
        self.endHash()

    def putBoolItem(self, name, value):
        self.beginHash()
966 967
        self.putName(name)
        self.putValue(value)
hjk's avatar
hjk committed
968 969 970 971 972 973 974 975 976
        self.putType("bool")
        self.putNumChild(0)
        self.endHash()

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

977
    def dumpInnerValueHelper(self, item):
hjk's avatar
hjk committed
978
        if isSimpleType(item.value.type):
979
            self.safePutItemHelper(item)
hjk's avatar
hjk committed
980

981 982 983 984 985
    def safePutItem(self, item):
        self.beginHash()
        self.safePutItemHelper(item)
        self.endHash()

hjk's avatar
hjk committed
986 987 988 989 990 991 992 993 994 995 996 997
    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)

998
            except RuntimeError:
hjk's avatar
hjk committed
999 1000 1001 1002
                self.output = ""
                # FIXME: Only catch debugger related exceptions
                #exType, exValue, exTraceback = sys.exc_info()
                #tb = traceback.format_exception(exType, exValue, exTraceback)
1003
                #warn("Exception: %s" % ex.message)
hjk's avatar
hjk committed
1004 1005 1006 1007 1008
                # DeprecationWarning: BaseException.message
                # has been deprecated
                #warn("Exception.")
                #for line in tb:
                #    warn("%s" % line)
1009 1010 1011 1012
                self.putName(item.name)
                self.putValue("<invalid>")
                self.putType(str(item.value.type))
                self.putNumChild(0)
hjk's avatar
hjk committed
1013 1014 1015 1016 1017 1018 1019
                #if self.isExpanded(item):
                self.beginChildren()
                self.endChildren()
        self.pushOutput()

    def putItem(self, item):
        self.beginHash()
hjk's avatar
hjk committed
1020
        self.safePutItemHelper(item)
hjk's avatar
hjk committed
1021 1022 1023
        self.endHash()

    def putCallItem(self, name, item, func):
1024 1025 1026 1027 1028
        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
1029

1030
    def putItemHelper(self, item):
hjk's avatar
hjk committed
1031 1032
        name = getattr(item, "name", None)
        if not name is None:
1033
            self.putName(name)
hjk's avatar
hjk committed
1034

1035 1036 1037 1038 1039 1040 1041 1042
        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
1043
        # FIXME: Gui shows references stripped?
1044
        #warn(" ");
hjk's avatar
hjk committed
1045
        #warn("REAL INAME: %s " % item.iname)
1046
        #warn("REAL NAME: %s " % name)
hjk's avatar
hjk committed
1047
        #warn("REAL TYPE: %s " % item.value.type)
1048
        #warn("REAL VALUE: %s " % item.value)
1049 1050
        #try:
        #    warn("REAL VALUE: %s " % item.value)
1051 1052
        #except:
        #    #UnicodeEncodeError:
1053
        #    warn("REAL VALUE: <unprintable>")
hjk's avatar
hjk committed
1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066

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

hjk's avatar
hjk committed
1068 1069 1070 1071
        #warn(" STRIPPED: %s" % strippedType)
        #warn(" DUMPERS: %s" % self.dumpers)
        #warn(" DUMPERS: %s" % (strippedType in self.dumpers))

1072
        if isSimpleType(type.unqualified()):
1073 1074
            #warn("IS SIMPLE: %s " % type)
            self.putType(item.value.type)
1075 1076
            self.putValue(value)
            self.putNumChild(0)
hjk's avatar
hjk committed
1077 1078

        elif strippedType in self.dumpers:
1079 1080
            #warn("IS DUMPABLE: %s " % type)
            self.putType(item.value.type)
hjk's avatar
hjk committed
1081
            self.dumpers[strippedType](self, item)
1082
            #warn(" RESULT: %s " % self.output)
hjk's avatar
hjk committed
1083 1084

        elif type.code == gdb.TYPE_CODE_ENUM:
1085
            #warn("GENERIC ENUM: %s" % value)
1086
            self.putType(item.value.type)
1087
            self.putValue(value)
hjk's avatar
hjk committed
1088
            self.putNumChild(0)
1089

hjk's avatar
hjk committed