gdbbridge.py 62.8 KB
Newer Older
hjk's avatar
hjk committed
1

2 3 4 5 6 7 8 9 10
try:
    import __builtin__
except:
    import builtins
try:
    import gdb
except:
    pass

hjk's avatar
hjk committed
11
import os
12
import os.path
13
import sys
14 15
import struct

hjk's avatar
hjk committed
16

17 18
def warn(message):
    print("XXX: %s\n" % message.encode("latin1"))
19

20 21
from dumper import *
from qttypes import *
hjk's avatar
hjk committed
22 23 24
from stdtypes import *
from misctypes import *
from boosttypes import *
25
from creatortypes import *
26
from personaltypes import *
hjk's avatar
hjk committed
27

28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66

#######################################################################
#
# Infrastructure
#
#######################################################################

def savePrint(output):
    try:
        print(output)
    except:
        out = ""
        for c in output:
            cc = ord(c)
            if cc > 127:
                out += "\\\\%d" % cc
            elif cc < 0:
                out += "\\\\%d" % (cc + 256)
            else:
                out += c
        print(out)

def registerCommand(name, func):

    class Command(gdb.Command):
        def __init__(self):
            super(Command, self).__init__(name, gdb.COMMAND_OBSCURE)
        def invoke(self, args, from_tty):
            savePrint(func(args))

    Command()


def listOfLocals(varList):
    frame = gdb.selected_frame()

    try:
        block = frame.block()
        #warn("BLOCK: %s " % block)
67
    except RuntimeError as error:
68
        #warn("BLOCK IN FRAME NOT ACCESSIBLE: %s" % error)
69
        return []
70 71
    except:
        warn("BLOCK NOT ACCESSIBLE FOR UNKNOWN REASONS")
72
        return []
73 74 75 76 77 78 79 80 81 82

    items = []
    shadowed = {}
    while True:
        if block is None:
            warn("UNEXPECTED 'None' BLOCK")
            break
        for symbol in block:
            name = symbol.print_name

83
            if name == "__in_chrg" or name == "__PRETTY_FUNCTION__":
84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207
                continue

            # "NotImplementedError: Symbol type not yet supported in
            # Python scripts."
            #warn("SYMBOL %s  (%s): " % (symbol, name))
            if name in shadowed:
                level = shadowed[name]
                name1 = "%s@%s" % (name, level)
                shadowed[name] = level + 1
            else:
                name1 = name
                shadowed[name] = 1
            #warn("SYMBOL %s  (%s, %s)): " % (symbol, name, symbol.name))
            item = LocalItem()
            item.iname = "local." + name1
            item.name = name1
            try:
                item.value = frame.read_var(name, block)
                #warn("READ 1: %s" % item.value)
                if not item.value.is_optimized_out:
                    #warn("ITEM 1: %s" % item.value)
                    items.append(item)
                    continue
            except:
                pass

            try:
                item.value = frame.read_var(name)
                #warn("READ 2: %s" % item.value)
                if not item.value.is_optimized_out:
                    #warn("ITEM 2: %s" % item.value)
                    items.append(item)
                    continue
            except:
                # RuntimeError: happens for
                #     void foo() { std::string s; std::wstring w; }
                # ValueError: happens for (as of 2010/11/4)
                #     a local struct as found e.g. in
                #     gcc sources in gcc.c, int execute()
                pass

            try:
                #warn("READ 3: %s %s" % (name, item.value))
                item.value = gdb.parse_and_eval(name)
                #warn("ITEM 3: %s" % item.value)
                items.append(item)
            except:
                # Can happen in inlined code (see last line of
                # RowPainter::paintChars(): "RuntimeError:
                # No symbol \"__val\" in current context.\n"
                pass

        # 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

    return items



#######################################################################
#
# Types
#
#######################################################################

PointerCode = gdb.TYPE_CODE_PTR
ArrayCode = gdb.TYPE_CODE_ARRAY
StructCode = gdb.TYPE_CODE_STRUCT
UnionCode = gdb.TYPE_CODE_UNION
EnumCode = gdb.TYPE_CODE_ENUM
FlagsCode = gdb.TYPE_CODE_FLAGS
FunctionCode = gdb.TYPE_CODE_FUNC
IntCode = gdb.TYPE_CODE_INT
FloatCode = gdb.TYPE_CODE_FLT # Parts of GDB assume that this means complex.
VoidCode = gdb.TYPE_CODE_VOID
#SetCode = gdb.TYPE_CODE_SET
RangeCode = gdb.TYPE_CODE_RANGE
StringCode = gdb.TYPE_CODE_STRING
#BitStringCode = gdb.TYPE_CODE_BITSTRING
#ErrorTypeCode = gdb.TYPE_CODE_ERROR
MethodCode = gdb.TYPE_CODE_METHOD
MethodPointerCode = gdb.TYPE_CODE_METHODPTR
MemberPointerCode = gdb.TYPE_CODE_MEMBERPTR
ReferenceCode = gdb.TYPE_CODE_REF
CharCode = gdb.TYPE_CODE_CHAR
BoolCode = gdb.TYPE_CODE_BOOL
ComplexCode = gdb.TYPE_CODE_COMPLEX
TypedefCode = gdb.TYPE_CODE_TYPEDEF
NamespaceCode = gdb.TYPE_CODE_NAMESPACE
#Code = gdb.TYPE_CODE_DECFLOAT # Decimal floating point.
#Code = gdb.TYPE_CODE_MODULE # Fortran
#Code = gdb.TYPE_CODE_INTERNAL_FUNCTION


#######################################################################
#
# Convenience
#
#######################################################################

# Just convienience for 'python print ...'
class PPCommand(gdb.Command):
    def __init__(self):
        super(PPCommand, self).__init__("pp", gdb.COMMAND_OBSCURE)
    def invoke(self, args, from_tty):
        print(eval(args))

PPCommand()

# Just convienience for 'python print gdb.parse_and_eval(...)'
class PPPCommand(gdb.Command):
    def __init__(self):
        super(PPPCommand, self).__init__("ppp", gdb.COMMAND_OBSCURE)
    def invoke(self, args, from_tty):
        print(gdb.parse_and_eval(args))

PPPCommand()


def scanStack(p, n):
208
    p = int(p)
209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227
    r = []
    for i in xrange(n):
        f = gdb.parse_and_eval("{void*}%s" % p)
        m = gdb.execute("info symbol %s" % f, to_string=True)
        if not m.startswith("No symbol matches"):
            r.append(m)
        p += f.type.sizeof
    return r

class ScanStackCommand(gdb.Command):
    def __init__(self):
        super(ScanStackCommand, self).__init__("scanStack", gdb.COMMAND_OBSCURE)
    def invoke(self, args, from_tty):
        if len(args) == 0:
            args = 20
        savePrint(scanStack(gdb.parse_and_eval("$sp"), int(args)))

ScanStackCommand()

hjk's avatar
hjk committed
228

229
def bbsetup(args = ''):
230 231
    theDumper.bbsetup()
    print(theDumper.reportDumpers())
232 233 234 235 236 237 238 239 240 241 242 243 244 245 246

registerCommand("bbsetup", bbsetup)


#######################################################################
#
# Import plain gdb pretty printers
#
#######################################################################

class PlainDumper:
    def __init__(self, printer):
        self.printer = printer

    def __call__(self, d, value):
247
        printer = self.printer.invoke(value)
248 249 250 251 252 253 254 255 256 257 258 259 260
        lister = getattr(printer, "children", None)
        children = [] if lister is None else list(lister())
        d.putType(self.printer.name)
        val = printer.to_string().encode("hex")
        d.putValue(val, Hex2EncodedLatin1)
        d.putValue(printer.to_string())
        d.putNumChild(len(children))
        if d.isExpanded():
            with Children(d):
                for child in children:
                    d.putSubItem(child[0], child[1])

def importPlainDumpers(args):
261
    theDumper.importPlainDumpers()
262 263 264 265

registerCommand("importPlainDumpers", importPlainDumpers)


266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297

class OutputSafer:
    def __init__(self, d):
        self.d = d

    def __enter__(self):
        self.savedOutput = self.d.output
        self.d.output = []

    def __exit__(self, exType, exValue, exTraceBack):
        if self.d.passExceptions and not exType is None:
            showException("OUTPUTSAFER", exType, exValue, exTraceBack)
            self.d.output = self.savedOutput
        else:
            self.savedOutput.extend(self.d.output)
            self.d.output = self.savedOutput
        return False



#def couldBePointer(p, align):
#    type = lookupType("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)


Value = gdb.Value



298 299 300 301 302
def stripTypedefs(typeobj):
    typeobj = typeobj.unqualified()
    while typeobj.code == TypedefCode:
        typeobj = typeobj.strip_typedefs().unqualified()
    return typeobj
303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322


#######################################################################
#
# LocalItem
#
#######################################################################

# Contains iname, name, and value.
class LocalItem:
    pass


#######################################################################
#
# Edit Command
#
#######################################################################

def bbedit(args):
323
    theDumper.bbedit(args)
324 325 326 327 328 329 330 331 332 333

registerCommand("bbedit", bbedit)


#######################################################################
#
# Frame Command
#
#######################################################################

334

335
def bb(args):
336 337 338 339 340
    try:
        print(theDumper.run(args))
    except:
        import traceback
        traceback.print_exc()
341 342

registerCommand("bb", bb)
343

344 345 346 347 348 349 350
#######################################################################
#
# The Dumper Class
#
#######################################################################


351 352
class Dumper(DumperBase):

353
    def __init__(self):
354 355
        DumperBase.__init__(self)

356
        # These values will be kept between calls to 'run'.
357
        self.isGdb = True
358
        self.childEventAddress = None
359 360
        self.typesReported = {}
        self.typesToReport = {}
361
        self.qtNamespaceToReport = None
362

363
    def prepare(self, args):
364 365 366 367 368 369 370
        self.output = []
        self.currentIName = ""
        self.currentPrintsAddress = True
        self.currentChildType = ""
        self.currentChildNumChild = -1
        self.currentMaxNumChild = -1
        self.currentNumChild = -1
371 372
        self.currentValue = ReportItem()
        self.currentType = ReportItem()
373 374 375 376 377 378
        self.currentAddress = None
        self.typeformats = {}
        self.formats = {}
        self.useDynamicType = True
        self.expandedINames = {}

379 380 381 382 383
        # The guess does not need to be updated during a run()
        # as the result is fixed during that time (ignoring "active"
        # dumpers causing loading of shared objects etc).
        self.currentQtNamespaceGuess = None

384 385 386 387
        self.watchers = ""
        self.resultVarName = ""
        self.varList = []
        self.options = []
388 389 390 391

        for arg in args.split(' '):
            pos = arg.find(":") + 1
            if arg.startswith("options:"):
392
                self.options = arg[pos:].split(",")
393 394
            elif arg.startswith("vars:"):
                if len(arg[pos:]) > 0:
395
                    self.varList = arg[pos:].split(",")
396
            elif arg.startswith("resultvarname:"):
397
                self.resultVarName = arg[pos:]
398 399
            elif arg.startswith("expanded:"):
                self.expandedINames = set(arg[pos:].split(","))
400 401
            elif arg.startswith("stringcutoff:"):
                self.stringCutOff = int(arg[pos:])
402 403
            elif arg.startswith("displaystringlimit:"):
                self.displayStringLimit = int(arg[pos:])
404 405 406 407
            elif arg.startswith("typeformats:"):
                for f in arg[pos:].split(","):
                    pos = f.find("=")
                    if pos != -1:
408 409
                        typeName = self.hexdecode(f[0:pos])
                        self.typeformats[typeName] = int(f[pos+1:])
410 411 412 413 414 415
            elif arg.startswith("formats:"):
                for f in arg[pos:].split(","):
                    pos = f.find("=")
                    if pos != -1:
                        self.formats[f[0:pos]] = int(f[pos+1:])
            elif arg.startswith("watchers:"):
416
                self.watchers = self.hexdecode(arg[pos:])
417

418 419 420 421
        self.useDynamicType = "dyntype" in self.options
        self.useFancy = "fancy" in self.options
        self.forceQtNamespace = "forcens" in self.options
        self.passExceptions = "pe" in self.options
422
        #self.passExceptions = True
423 424 425
        self.autoDerefPointers = "autoderef" in self.options
        self.partialUpdate = "partial" in self.options
        self.tooltipOnly = "tooltiponly" in self.options
426
        self.fallbackQtVersion = 0x50200
427
        #warn("NAMESPACE: '%s'" % self.qtNamespace())
428
        #warn("VARIABLES: %s" % self.varList)
429
        #warn("EXPANDED INAMES: %s" % self.expandedINames)
430
        #warn("WATCHERS: %s" % self.watchers)
431 432
        #warn("PARTIAL: %s" % self.partialUpdate)

433 434 435 436 437 438 439 440 441 442
    def handleWatches(self):
        with OutputSafer(self):
            if len(self.watchers) > 0:
                for watcher in self.watchers.split("##"):
                    (exp, iname) = watcher.split("#")
                    self.handleWatch(exp, exp, iname)

    def run(self, args):
        self.prepare(args)

443 444 445
        #
        # Locals
        #
446
        self.output.append('data=[')
447 448
        locals = []
        fullUpdateNeeded = True
449 450 451
        if self.partialUpdate and len(self.varList) == 1 and not self.tooltipOnly:
            #warn("PARTIAL: %s" % self.varList)
            parts = self.varList[0].split('.')
452 453 454 455 456 457 458 459 460 461 462
            #warn("PARTIAL PARTS: %s" % parts)
            name = parts[1]
            #warn("PARTIAL VAR: %s" % name)
            #fullUpdateNeeded = False
            try:
                frame = gdb.selected_frame()
                item = LocalItem()
                item.iname = "local." + name
                item.name = name
                item.value = frame.read_var(name)
                locals = [item]
hjk's avatar
hjk committed
463
                #warn("PARTIAL LOCALS: %s" % locals)
464 465 466
                fullUpdateNeeded = False
            except:
                pass
467
            self.varList = []
468

469
        if fullUpdateNeeded and not self.tooltipOnly:
470
            locals = listOfLocals(self.varList)
471 472

        # Take care of the return value of the last function call.
473
        if len(self.resultVarName) > 0:
474 475
            try:
                item = LocalItem()
476 477 478
                item.name = self.resultVarName
                item.iname = "return." + self.resultVarName
                item.value = self.parseAndEvaluate(self.resultVarName)
479 480 481 482 483 484
                locals.append(item)
            except:
                # Don't bother. It's only supplementary information anyway.
                pass

        for item in locals:
485
            value = self.downcast(item.value) if self.useDynamicType else item.value
486 487 488
            with OutputSafer(self):
                self.anonNumber = -1

489 490
                if item.iname == "local.argv" and str(value.type) == "char **":
                    self.putSpecialArgv(value)
491 492 493 494 495 496 497
                else:
                    # A "normal" local variable or parameter.
                    with TopLevelItem(self, item.iname):
                        self.put('iname="%s",' % item.iname)
                        self.put('name="%s",' % item.name)
                        self.putItem(value)

498
        self.handleWatches()
499

500
        #print('data=[' + locals + sep + self.watchers + ']\n')
501

502 503
        self.output.append('],typeinfo=[')
        for name in self.typesToReport.keys():
504
            typeobj = self.typesToReport[name]
505
            # Happens e.g. for '(anonymous namespace)::InsertDefOperation'
506
            if not typeobj is None:
507
                self.output.append('{name="%s",size="%s"}'
508
                    % (self.hexencode(name), typeobj.sizeof))
509 510
        self.output.append(']')
        self.typesToReport = {}
511

512
        if "forcens" in self.options:
513 514
            self.qtNamepaceToRport = self.qtNamespace()

515 516 517 518
        if self.qtNamespaceToReport:
            self.output.append(',qtnamespace="%s"' % self.qtNamespaceToReport)
            self.qtNamespaceToReport = None

519
        return "".join(self.output)
520

521 522 523 524 525 526 527 528 529 530 531 532 533
    def enterSubItem(self, item):
        if not item.iname:
            item.iname = "%s.%s" % (self.currentIName, item.name)
        #warn("INAME %s" % item.iname)
        self.put('{')
        #if not item.name is None:
        if isinstance(item.name, str):
            self.put('name="%s",' % item.name)
        item.savedIName = self.currentIName
        item.savedValue = self.currentValue
        item.savedType = self.currentType
        item.savedCurrentAddress = self.currentAddress
        self.currentIName = item.iname
534 535
        self.currentValue = ReportItem();
        self.currentType = ReportItem();
536 537 538
        self.currentAddress = None

    def exitSubItem(self, item, exType, exValue, exTraceBack):
hjk's avatar
hjk committed
539
        #warn("CURRENT VALUE: %s: %s %s" % (self.currentIName, self.currentValue, self.currentType))
540 541 542 543 544 545
        if not exType is None:
            if self.passExceptions:
                showException("SUBITEM", exType, exValue, exTraceBack)
            self.putNumChild(0)
            self.putValue("<not accessible>")
        try:
hjk's avatar
hjk committed
546 547 548 549
            if self.currentType.value:
                typeName = stripClassTag(self.currentType.value)
                if len(typeName) > 0 and typeName != self.currentChildType:
                    self.put('type="%s",' % typeName) # str(type.unqualified()) ?
550

551
            if  self.currentValue.value is None:
552 553
                self.put('value="<not accessible>",numchild="0",')
            else:
554 555 556 557 558
                if not self.currentValue.encoding is None:
                    self.put('valueencoded="%d",' % self.currentValue.encoding)
                if self.currentValue.elided:
                    self.put('valueelided="%d",' % self.currentValue.elided)
                self.put('value="%s",' % self.currentValue.value)
559 560 561 562 563 564 565 566 567 568 569
        except:
            pass
        if not self.currentAddress is None:
            self.put(self.currentAddress)
        self.put('},')
        self.currentIName = item.savedIName
        self.currentValue = item.savedValue
        self.currentType = item.savedType
        self.currentAddress = item.savedCurrentAddress
        return True

570 571 572
    def parseAndEvaluate(self, exp):
        return gdb.parse_and_eval(exp)

573
    def callHelper(self, value, func, args):
574 575 576 577 578 579 580 581 582 583 584 585
        # args is a tuple.
        arg = ""
        for i in range(len(args)):
            if i:
                arg += ','
            a = args[i]
            if (':' in a) and not ("'" in a):
                arg = "'%s'" % a
            else:
                arg += a

        #warn("CALL: %s -> %s(%s)" % (value, func, arg))
586 587 588
        typeName = stripClassTag(str(value.type))
        if typeName.find(":") >= 0:
            typeName = "'" + typeName + "'"
589
        # 'class' is needed, see http://sourceware.org/bugzilla/show_bug.cgi?id=11912
590 591 592
        #exp = "((class %s*)%s)->%s(%s)" % (typeName, value.address, func, arg)
        ptr = value.address if value.address else self.pokeValue(value)
        exp = "((%s*)%s)->%s(%s)" % (typeName, ptr, func, arg)
593
        #warn("CALL: %s" % exp)
594
        result = gdb.parse_and_eval(exp)
595
        #warn("  -> %s" % result)
596 597
        if not value.address:
            gdb.parse_and_eval("free(0x%x)" % ptr)
598 599
        return result

hjk's avatar
hjk committed
600
    def childWithName(self, value, name):
601
        try:
hjk's avatar
hjk committed
602
            return value[name]
603
        except:
hjk's avatar
hjk committed
604
            return None
605

hjk's avatar
hjk committed
606 607 608 609 610
    def makeValue(self, type, init):
        type = "::" + stripClassTag(str(type));
        # Avoid malloc symbol clash with QVector.
        gdb.execute("set $d = (%s*)calloc(sizeof(%s), 1)" % (type, type))
        gdb.execute("set *$d = {%s}" % init)
hjk's avatar
hjk committed
611
        value = gdb.parse_and_eval("$d").dereference()
hjk's avatar
hjk committed
612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629
        #warn("  TYPE: %s" % value.type)
        #warn("  ADDR: %s" % value.address)
        #warn("  VALUE: %s" % value)
        return value

    def makeExpression(self, value):
        type = "::" + stripClassTag(str(value.type))
        #warn("  TYPE: %s" % type)
        #exp = "(*(%s*)(&%s))" % (type, value.address)
        exp = "(*(%s*)(%s))" % (type, value.address)
        #warn("  EXP: %s" % exp)
        return exp

    def makeStdString(init):
        # Works only for small allocators, but they are usually empty.
        gdb.execute("set $d=(std::string*)calloc(sizeof(std::string), 2)");
        gdb.execute("call($d->basic_string(\"" + init +
            "\",*(std::allocator<char>*)(1+$d)))")
hjk's avatar
hjk committed
630
        value = gdb.parse_and_eval("$d").dereference()
hjk's avatar
hjk committed
631 632 633 634 635
        #warn("  TYPE: %s" % value.type)
        #warn("  ADDR: %s" % value.address)
        #warn("  VALUE: %s" % value)
        return value

636 637
    def childAt(self, value, index):
        field = value.type.fields()[index]
638 639 640 641 642 643 644 645 646 647 648 649 650
        try:
            # Official access in GDB 7.6 or later.
            return value[field]
        except:
            pass

        try:
            # Won't work with anon entities, tradionally with empty
            # field name, but starting with GDB 7.7 commit b5b08fb4
            # with None field name.
            return value[field.name]
        except:
            pass
651

652 653 654 655 656 657 658 659 660
        # FIXME: Cheat. There seems to be no official way to access
        # the real item, so we pass back the value. That at least
        # enables later ...["name"] style accesses as gdb handles
        # them transparently.
        return value

    def fieldAt(self, type, index):
        return type.fields()[index]

661 662 663
    def simpleValue(self, value):
        return str(value)

664
    def directBaseClass(self, typeobj, index = 0):
665 666 667 668 669
        for f in typeobj.fields():
            if f.is_base_class:
                if index == 0:
                    return f.type
                index -= 1;
hjk's avatar
hjk committed
670 671 672 673 674 675 676 677
        return None

    def directBaseObject(self, value, index = 0):
        for f in value.type.fields():
            if f.is_base_class:
                if index == 0:
                    return value.cast(f.type)
                index -= 1;
678
        return None
679 680 681 682 683 684 685 686 687 688 689 690 691 692 693

    def checkPointer(self, p, align = 1):
        if not self.isNull(p):
            p.dereference()

    def pointerValue(self, p):
        return toInteger(p)

    def isNull(self, p):
        # 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 ")
        #try:
        #    # Can fail with: "RuntimeError: Cannot access memory at address 0x5"
hjk's avatar
hjk committed
694
        #    return p.cast(self.lookupType("void").pointer()) == 0
695 696 697 698 699 700 701 702
        #except:
        #    return False
        try:
            # Can fail with: "RuntimeError: Cannot access memory at address 0x5"
            return toInteger(p) == 0
        except:
            return False

703
    def templateArgument(self, typeobj, position):
704 705 706 707 708 709 710
        try:
            # This fails on stock 7.2 with
            # "RuntimeError: No type named myns::QObject.\n"
            return typeobj.template_argument(position)
        except:
            # That's something like "myns::QList<...>"
            return self.lookupType(self.extractTemplateArgument(str(typeobj.strip_typedefs()), position))
711 712

    def numericTemplateArgument(self, typeobj, position):
713 714 715 716 717 718 719 720 721 722 723 724
        # Workaround for gdb < 7.1
        try:
            return int(typeobj.template_argument(position))
        except RuntimeError as error:
            # ": No type named 30."
            msg = str(error)
            msg = msg[14:-1]
            # gdb at least until 7.4 produces for std::array<int, 4u>
            # for template_argument(1): RuntimeError: No type named 4u.
            if msg[-1] == 'u':
               msg = msg[0:-1]
            return int(msg)
725

726
    def intType(self):
727 728 729
        self.cachedIntType = self.lookupType('int')
        self.intType = lambda: self.cachedIntType
        return self.cachedIntType
730 731

    def charType(self):
hjk's avatar
hjk committed
732
        return self.lookupType('char')
733 734

    def sizetType(self):
hjk's avatar
hjk committed
735
        return self.lookupType('size_t')
736 737

    def charPtrType(self):
hjk's avatar
hjk committed
738
        return self.lookupType('char*')
739 740

    def voidPtrType(self):
hjk's avatar
hjk committed
741
        return self.lookupType('void*')
742

743
    def addressOf(self, value):
744
        return toInteger(value.address)
745

746
    def createPointerValue(self, address, pointeeType):
747 748 749 750 751 752 753 754
        # This might not always work:
        # a Python 3 based GDB due to the bug addressed in
        # https://sourceware.org/ml/gdb-patches/2013-09/msg00571.html
        try:
            return gdb.Value(address).cast(pointeeType.pointer())
        except:
            # Try _some_ fallback (good enough for the std::complex dumper)
            return gdb.parse_and_eval("(%s*)%s" % (pointeeType, address))
755 756 757 758 759

    def intSize(self):
        return 4

    def ptrSize(self):
760 761 762
        self.cachedPtrSize = self.lookupType('void*').sizeof
        self.ptrSize = lambda: self.cachedPtrSize
        return self.cachedPtrSize
763

764 765 766 767 768 769 770 771 772 773 774 775 776 777
    def pokeValue(self, value):
        """
        Allocates inferior memory and copies the contents of value.
        Returns a pointer to the copy.
        """
        # Avoid malloc symbol clash with QVector
        size = value.type.sizeof
        data = value.cast(gdb.lookup_type("unsigned char").array(0, int(size - 1)))
        string = ''.join("\\x%02x" % int(data[i]) for i in range(size))
        exp = '(%s*)memcpy(calloc(%s, 1), "%s", %s)' % (value.type, size, string, size)
        #warn("EXP: %s" % exp)
        return toInteger(gdb.parse_and_eval(exp))


778
    def createValue(self, address, referencedType):
779 780 781 782 783
        try:
            return gdb.Value(address).cast(referencedType.pointer()).dereference()
        except:
            # Try _some_ fallback (good enough for the std::complex dumper)
            return gdb.parse_and_eval("{%s}%s" % (referencedType, address))
784

785 786 787 788 789 790 791 792 793
    def setValue(self, address, type, value):
        cmd = "set {%s}%s=%s" % (type, address, value)
        gdb.execute(cmd)

    def setValues(self, address, type, values):
        cmd = "set {%s[%s]}%s={%s}" \
            % (type, len(values), address, ','.join(map(str, values)))
        gdb.execute(cmd)

794 795
    def selectedInferior(self):
        try:
796
            # gdb.Inferior is new in gdb 7.2
797
            self.cachedInferior = gdb.selected_inferior()
798 799
        except:
            # Pre gdb 7.4. Right now we don't have more than one inferior anyway.
800 801 802 803 804
            self.cachedInferior = gdb.inferiors()[0]

        # Memoize result.
        self.selectedInferior = lambda: self.cachedInferior
        return self.cachedInferior
805

806
    def readRawMemory(self, addr, size):
807
        mem = self.selectedInferior().read_memory(addr, size)
808 809 810 811
        if sys.version_info[0] >= 3:
            mem.tobytes()
        return mem

812 813 814
    def extractInt64(self, addr):
        return struct.unpack("q", self.readRawMemory(addr, 8))[0]

815
    def extractInt(self, addr):
816
        return struct.unpack("i", self.readRawMemory(addr, 4))[0]
817

818
    def extractByte(self, addr):
819
        return struct.unpack("b", self.readRawMemory(addr, 1))[0]
820

821 822 823
    def findStaticMetaObject(self, typeName):
        return self.findSymbol(typeName + "::staticMetaObject")

824 825 826 827 828 829 830 831
    def findSymbol(self, symbolName):
        try:
            result = gdb.lookup_global_symbol(symbolName)
            return result.value() if result else 0
        except:
            pass
        # Older GDB ~7.4
        try:
832 833 834
            address = gdb.parse_and_eval("&'%s'" % symbolName)
            type = gdb.lookup_type(self.qtNamespace() + "QMetaObject")
            return self.createPointerValue(address, type)
835 836
        except:
            return 0
837

838 839 840 841 842
    def put(self, value):
        self.output.append(value)

    def childRange(self):
        if self.currentMaxNumChild is None:
843 844
            return xrange(0, toInteger(self.currentNumChild))
        return xrange(min(toInteger(self.currentMaxNumChild), toInteger(self.currentNumChild)))
845

846 847 848 849 850 851
    def isArmArchitecture(self):
        return 'arm' in gdb.TARGET_CONFIG.lower()

    def isQnxTarget(self):
        return 'qnx' in gdb.TARGET_CONFIG.lower()

852 853 854 855
    def isWindowsTarget(self):
        # We get i686-w64-mingw32
        return 'mingw' in gdb.TARGET_CONFIG.lower()

hjk's avatar
hjk committed
856 857 858 859 860
    def qtVersionString(self):
        try:
            return str(gdb.lookup_symbol("qVersion")[0].value()())
        except:
            pass
861
        try:
862
            ns = self.qtNamespace()
hjk's avatar
hjk committed
863 864 865 866 867 868 869 870
            return str(gdb.parse_and_eval("((const char*(*)())'%sqVersion')()" % ns))
        except:
            pass
        return None

    def qtVersion(self):
        try:
            version = self.qtVersionString()
871
            (major, minor, patch) = version[version.find('"')+1:version.rfind('"')].split('.')
hjk's avatar
hjk committed
872 873 874
            qtversion = 0x10000 * int(major) + 0x100 * int(minor) + int(patch)
            self.qtVersion = lambda: qtversion
            return qtversion
875
        except:
876 877
            # Use fallback until we have a better answer.
            return self.fallbackQtVersion
878

879 880 881 882 883 884 885 886 887 888 889 890 891 892 893
    def isQt3Support(self):
        if self.qtVersion() >= 0x050000:
            return False
        else:
            try:
                # This will fail on Qt 4 without Qt 3 support
                gdb.execute("ptype QChar::null", to_string=True)
                self.cachedIsQt3Suport = True
            except:
                self.cachedIsQt3Suport = False

        # Memoize good results.
        self.isQt3Support = lambda: self.cachedIsQt3Suport
        return self.cachedIsQt3Suport

894
    def putAddress(self, addr):
895
        if self.currentPrintsAddress and not self.isCli:
896
            try:
897 898 899
                # addr can be "None", int(None) fails.
                #self.put('addr="0x%x",' % int(addr))
                self.currentAddress = 'addr="0x%x",' % toInteger(addr)
900 901 902 903 904 905 906 907
            except:
                pass

    def putNumChild(self, numchild):
        #warn("NUM CHILD: '%s' '%s'" % (numchild, self.currentChildNumChild))
        if numchild != self.currentChildNumChild:
            self.put('numchild="%s",' % numchild)

hjk's avatar
hjk committed
908 909 910
    def putSimpleValue(self, value, encoding = None, priority = 0):
        self.putValue(value, encoding, priority)

911 912 913 914 915 916
    def putPointerValue(self, value):
        # Use a lower priority
        if value is None:
            self.putEmptyValue(-1)
        else:
            self.putValue("0x%x" % value.cast(
hjk's avatar
hjk committed
917
                self.lookupType("unsigned long")), None, -1)
918 919 920

    def stripNamespaceFromType(self, typeName):
        type = stripClassTag(typeName)
921 922 923
        ns = self.qtNamespace()
        if len(ns) > 0 and type.startswith(ns):
            type = type[len(ns):]
924 925 926 927 928 929 930 931 932 933 934
        pos = type.find("<")
        # 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("<")
        return type

    def isMovableType(self, type):
        if type.code == PointerCode:
            return True
935
        if self.isSimpleType(type):
936
            return True
937
        return self.isKnownMovableType(self.stripNamespaceFromType(str(type)))
938 939 940 941 942

    def putSubItem(self, component, value, tryDynamic=True):
        with SubItem(self, component):
            self.putItem(value, tryDynamic)

943 944 945 946 947 948
    def isSimpleType(self, typeobj):
        code = typeobj.code
        return code == BoolCode \
            or code == CharCode \
            or code == IntCode \
            or code == FloatCode \
949
            or code == EnumCode
950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980

    def simpleEncoding(self, typeobj):
        code = typeobj.code
        if code == BoolCode or code == CharCode:
            return Hex2EncodedInt1
        if code == IntCode:
            if str(typeobj).find("unsigned") >= 0:
                if typeobj.sizeof == 1:
                    return Hex2EncodedUInt1
                if typeobj.sizeof == 2:
                    return Hex2EncodedUInt2
                if typeobj.sizeof == 4:
                    return Hex2EncodedUInt4
                if typeobj.sizeof == 8:
                    return Hex2EncodedUInt8
            else:
                if typeobj.sizeof == 1:
                    return Hex2EncodedInt1
                if typeobj.sizeof == 2:
                    return Hex2EncodedInt2
                if typeobj.sizeof == 4:
                    return Hex2EncodedInt4
                if typeobj.sizeof == 8:
                    return Hex2EncodedInt8
        if code == FloatCode:
            if typeobj.sizeof == 4:
                return Hex2EncodedFloat4
            if typeobj.sizeof == 8:
                return Hex2EncodedFloat8
        return None

hjk's avatar
hjk committed
981 982 983 984 985 986
    def isReferenceType(self, typeobj):
        return typeobj.code == gdb.TYPE_CODE_REF

    def isStructType(self, typeobj):
        return typeobj.code == gdb.TYPE_CODE_STRUCT

hjk's avatar
hjk committed
987 988 989
    def isFunctionType(self, type):
        return type.code == MethodCode or type.code == FunctionCode

990 991 992 993 994 995 996 997 998 999 1000 1001
    def putItem(self, value, tryDynamic=True):
        if 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

        type = value.type.unqualified()
        typeName = str(type)
        tryDynamic &= self.useDynamicType
1002
        self.addToCache(type) # Fill type cache
1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015
        if tryDynamic:
            self.putAddress(value.address)

        # FIXME: Gui shows references stripped?
        #warn(" ")
        #warn("REAL INAME: %s " % self.currentIName)
        #warn("REAL TYPE: %s " % value.type)
        #warn("REAL CODE: %s " % value.type.code)
        #warn("REAL VALUE: %s " % value)

        if type.code == ReferenceCode:
            try:
                # Try to recognize null references explicitly.
1016
                if toInteger(value.address) == 0:
1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041
                    self.putValue("<null reference>")
                    self.putType(typeName)
                    self.putNumChild(0)
                    return
            except:
                pass

            if tryDynamic:
                try:
                    # Dynamic references are not supported by gdb, see
                    # http://sourceware.org/bugzilla/show_bug.cgi?id=14077.
                    # Find the dynamic type manually using referenced_type.
                    value = value.referenced_value()
                    value = value.cast(value.dynamic_type)
                    self.putItem(value)
                    self.putBetterType("%s &" % value.type)
                    return
                except:
                    pass

            try:
                # FIXME: This throws "RuntimeError: Attempt to dereference a
                # generic pointer." with MinGW's gcc 4.5 when it "identifies"
                # a "QWidget &" as "void &" and with optimized out code.
                self.putItem(value.cast(type.target().unqualified()))
hjk's avatar
hjk committed
1042
                self.putBetterType("%s &" % self.currentType.value)
1043 1044 1045 1046 1047 1048 1049
                return
            except RuntimeError:
                self.putValue("<optimized out reference>")
                self.putType(typeName)
                self.putNumChild(0)
                return

1050
        if type.code == IntCode or type.code == CharCode:
1051 1052 1053
            self.putType(typeName)
            if value.is_optimized_out:
                self.putValue("<optimized out>")
1054 1055 1056
            elif type.sizeof == 1:
                # Force unadorned value transport for char and Co.
                self.putValue(int(value) & 0xff)
1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089
            else:
                self.putValue(value)
            self.putNumChild(0)
            return

        if type.code == FloatCode or type.code == BoolCode:
            self.putType(typeName)
            if value.is_optimized_out:
                self.putValue("<optimized out>")
            else:
                self.putValue(value)
            self.putNumChild(0)
            return

        if type.code == EnumCode:
            self.putType(typeName)
            if value.is_optimized_out:
                self.putValue("<optimized out>")
            else:
                self.putValue("%s (%d)" % (value, value))
            self.putNumChild(0)
            return

        if type.code == ComplexCode:
            self.putType(typeName)
            if value.is_optimized_out:
                self.putValue("<optimized out>")
            else:
                self.putValue("%s" % value)
            self.putNumChild(0)
            return

        if type.code == TypedefCode:
1090
            if typeName in self.qqDumpers:
1091
                self.putType(typeName)
1092
                self.qqDumpers[typeName](self, value)
1093 1094 1095 1096 1097 1098 1099
                return

            type = stripTypedefs(type)
            # The cast can destroy the address?
            #self.putAddress(value.address)
            # Workaround for http://sourceware.org/bugzilla/show_bug.cgi?id=13380
            if type.code == ArrayCode:
1100
                value = self.parseAndEvaluate("{%s}%s" % (type, value.address))
1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114
            else:
                try:
                    value = value.cast(type)
                except:
                    self.putValue("<optimized out typedef>")
                    self.putType(typeName)
                    self.putNumChild(0)
                    return

            self.putItem(value)
            self.putBetterType(typeName)
            return

        if type.code == ArrayCode:
1115
            self.putCStyleArray(value)
1116 1117 1118 1119 1120 1121 1122 1123 1124
            return

        if type.code == PointerCode:
            # This could still be stored in a register and
            # potentially dereferencable.
            if value.is_optimized_out:
                self.putValue("<optimized out>")
                return

hjk's avatar
hjk committed
1125
            self.putFormattedPointer(value)
1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146
            return

        if type.code == MethodPointerCode \
                or type.code == MethodCode \
                or type.code == FunctionCode \
                or type.code == MemberPointerCode:
            self.putType(typeName)
            self.putValue(value)
            self.putNumChild(0)
            return

        if typeName.startswith("<anon"):
            # Anonymous union. We need a dummy name to distinguish
            # multiple anonymous unions in the struct.
            self.putType(type)
            self.putValue("{...}")
            self.anonNumber += 1
            with Children(self, 1):
                self.listAnonymous(value, "#%d" % self.anonNumber, type)
            return

1147 1148 1149
        if type.code == StringCode:
            # FORTRAN strings
            size = type.sizeof
1150
            data = self.readMemory(value.address, size)
1151 1152 1153
            self.putValue(data, Hex2EncodedLatin1, 1)
            self.putType(type)

1154 1155 1156 1157 1158 1159
        if type.code != StructCode and type.code != UnionCode:
            warn("WRONG ASSUMPTION HERE: %s " % type.code)
            check(False)


        if tryDynamic:
1160
            self.putItem(self.expensiveDowncast(value), False)
1161 1162
            return

1163
        format = self.currentItemFormat(typeName)
1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182

        if self.useFancy and (format is None or format >= 1):
            self.putType(typeName)

            nsStrippedType = self.stripNamespaceFromType(typeName)\
                .replace("::", "__")

            # The following block is only needed for D.
            if nsStrippedType.startswith("_A"):
                # DMD v2.058 encodes string[] as _Array_uns long long.
                # With spaces.
                if nsStrippedType.startswith("_Array_"):
                    qdump_Array(self, value)
                    return
                if nsStrippedType.startswith("_AArray_"):
                    qdump_AArray(self, value)
                    return

            #warn(" STRIPPED: %s" % nsStrippedType)
1183 1184 1185
            #warn(" DUMPERS: %s" % self.qqDumpers)
            #warn(" DUMPERS: %s" % (nsStrippedType in self.qqDumpers))
            dumper = self.qqDumpers.get(nsStrippedType, None)
1186 1187
            if not dumper is None:
                if tryDynamic:
1188
                    dumper(self, self.expensiveDowncast(value))
1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206
                else:
                    dumper(self, value)
                return

        # D arrays, gdc compiled.
        if typeName.endswith("[]"):
            n = value["length"]
            base = value["ptr"]
            self.putType(typeName)
            self.putItemCount(n)
            if self.isExpanded():
                self.putArrayData(base.type.target(), base, n)
            return

        #warn("GENERIC STRUCT: %s" % type)
        #warn("INAME: %s " % self.currentIName)
        #warn("INAMES: %s " % self.expandedINames)
        #warn("EXPANDED: %s " % (self.currentIName in self.expandedINames))
1207 1208 1209
        staticMetaObject = self.extractStaticMetaObject(value.type)
        if staticMetaObject:
            self.putQObjectNameValue(value)
1210 1211
        self.putType(typeName)
        self.putEmptyValue()
1212
        self.putNumChild(len(type.fields()))
1213 1214 1215 1216 1217

        if self.currentIName in self.expandedINames:
            innerType = None
            with Children(self, 1, childType=innerType):
                self.putFields(value)
1218 1219
                if staticMetaObject:
                    self.putQObjectGuts(value, staticMetaObject)
hjk's avatar
hjk committed
1220

1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233
    def toBlob(self, value):
        size = toInteger(value.type.sizeof)
        if value.address:
            return self.extractBlob(value.address, size)

        # No address. Possibly the result of an inferior call.
        y = value.cast(gdb.lookup_type("unsigned char").array(0, int(size - 1)))
        buf = bytearray(struct.pack('x' * size))
        for i in range(size):
            buf[i] = int(y[i])

        return Blob(bytes(buf))

hjk's avatar
hjk committed
1234
    def extractBlob(self, base, size):
1235
        inferior = self.selectedInferior()
hjk's avatar
hjk committed
1236
        return Blob(inferior.read_memory(base, size))
1237

hjk's avatar
hjk committed
1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250
    def readCString(self, base):
        inferior = self.selectedInferior()
        mem = ""
        while True:
            char = inferior.read_memory(base, 1)[0]
            if not char:
                break
            mem += char
            base += 1
        #if sys.version_info[0] >= 3:
        #    return mem.tobytes()
        return mem

1251
    def putFields(self, value, dumpBase = True):
1252
            fields = value.type.fields()
1253

hjk's avatar
hjk committed
1254
            #warn("TYPE: %s" % value.type)
1255 1256 1257 1258 1259 1260 1261
            #warn("FIELDS: %s" % fields)
            baseNumber = 0
            for field in fields:
                #warn("FIELD: %s" % field)
                #warn("  BITSIZE: %s" % field.bitsize)
                #warn("  ARTIFICIAL: %s" % field.artificial)

hjk's avatar
hjk committed
1262 1263
                # Since GDB commit b5b08fb4 anonymous structs get also reported
                # with a 'None' name.
1264
                if field.name is None:
hjk's avatar
hjk committed
1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278
                    if value.type.code == ArrayCode:
                        # An array.
                        type = stripTypedefs(value.type)
                        innerType = type.target()
                        p = value.cast(innerType.pointer())
                        for i in xrange(int(type.sizeof / innerType.sizeof)):
                            with SubItem(self, i):
                                self.putItem(p.dereference())
                            p = p + 1
                    else:
                        # Something without a name.
                        self.anonNumber += 1
                        with SubItem(self, str(self.anonNumber)):
                            self.putItem(value[field])