gdbbridge.py 62.6 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

#######################################################################
#
# 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()


61
def listOfLocals():
62 63 64 65 66
    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
                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)
103 104
                items.append(item)
                continue
105 106 107 108 109
            except:
                pass

            try:
                #warn("READ 2: %s" % item.value)
110 111 112
                item.value = frame.read_var(name)
                items.append(item)
                continue
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
            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):
204
    p = int(p)
205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223
    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
224

225
def bbsetup(args = ''):
226 227
    theDumper.bbsetup()
    print(theDumper.reportDumpers())
228 229 230 231 232 233 234 235 236 237 238 239 240 241 242

registerCommand("bbsetup", bbsetup)


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

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

    def __call__(self, d, value):
243
        printer = self.printer.invoke(value)
244 245 246 247 248 249 250 251 252 253 254 255 256
        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):
257
    theDumper.importPlainDumpers()
258 259 260 261

registerCommand("importPlainDumpers", importPlainDumpers)


262 263 264 265 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

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



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


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

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


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

def bbedit(args):
319
    theDumper.bbedit(args)
320 321 322 323 324 325 326 327 328 329

registerCommand("bbedit", bbedit)


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

330

331
def bb(args):
332 333 334 335 336
    try:
        print(theDumper.run(args))
    except:
        import traceback
        traceback.print_exc()
337 338

registerCommand("bb", bb)
339

340 341 342 343 344 345 346
#######################################################################
#
# The Dumper Class
#
#######################################################################


347 348
class Dumper(DumperBase):

349
    def __init__(self):
350 351
        DumperBase.__init__(self)

352
        # These values will be kept between calls to 'run'.
353
        self.isGdb = True
354
        self.childEventAddress = None
355 356
        self.typesReported = {}
        self.typesToReport = {}
357
        self.qtNamespaceToReport = None
358

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

375 376 377 378 379
        # 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

380 381 382 383
        self.watchers = ""
        self.resultVarName = ""
        self.varList = []
        self.options = []
384 385 386 387

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

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

429 430 431 432 433 434 435 436 437 438
    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)

439 440 441
        #
        # Locals
        #
442
        self.output.append('data=[')
443
        if self.partialUpdate and len(self.varList) == 1:
444 445
            #warn("PARTIAL: %s" % self.varList)
            parts = self.varList[0].split('.')
446 447 448
            #warn("PARTIAL PARTS: %s" % parts)
            name = parts[1]
            #warn("PARTIAL VAR: %s" % name)
449 450 451
            item = LocalItem()
            item.iname = parts[0] + '.' + name
            item.name = name
452
            try:
453 454 455 456 457 458 459 460
                if parts[0] == 'local':
                    frame = gdb.selected_frame()
                    item.value = frame.read_var(name)
                else:
                    item.name = self.hexdecode(name)
                    item.value = gdb.parse_and_eval(item.name)
            except RuntimeError as error:
                item.value = error
461
            except:
462 463 464 465 466
                item.value = "<no value>"
            locals = [item]
            #warn("PARTIAL LOCALS: %s" % locals)
        else:
            locals = listOfLocals()
467 468

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

        for item in locals:
481
            value = self.downcast(item.value) if self.useDynamicType else item.value
482 483 484
            with OutputSafer(self):
                self.anonNumber = -1

485 486
                if item.iname == "local.argv" and str(value.type) == "char **":
                    self.putSpecialArgv(value)
487 488 489 490 491 492 493
                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)

494
        self.handleWatches()
495

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

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

508
        if "forcens" in self.options:
509
            self.qtNamepaceToReport = self.qtNamespace()
510

511 512 513 514
        if self.qtNamespaceToReport:
            self.output.append(',qtnamespace="%s"' % self.qtNamespaceToReport)
            self.qtNamespaceToReport = None

515
        return "".join(self.output)
516

517 518 519 520 521 522 523 524 525 526 527 528 529
    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
530 531
        self.currentValue = ReportItem();
        self.currentType = ReportItem();
532 533 534
        self.currentAddress = None

    def exitSubItem(self, item, exType, exValue, exTraceBack):
hjk's avatar
hjk committed
535
        #warn("CURRENT VALUE: %s: %s %s" % (self.currentIName, self.currentValue, self.currentType))
536 537 538 539 540 541
        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
542
            if self.currentType.value:
543
                typeName = self.stripClassTag(self.currentType.value)
hjk's avatar
hjk committed
544 545
                if len(typeName) > 0 and typeName != self.currentChildType:
                    self.put('type="%s",' % typeName) # str(type.unqualified()) ?
546

547
            if  self.currentValue.value is None:
548 549
                self.put('value="<not accessible>",numchild="0",')
            else:
550 551 552 553 554
                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)
555 556 557 558 559 560 561 562 563 564 565
        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

566 567 568
    def parseAndEvaluate(self, exp):
        return gdb.parse_and_eval(exp)

569
    def callHelper(self, value, func, args):
570 571 572 573 574 575 576 577 578 579 580 581
        # 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))
582
        typeName = self.stripClassTag(str(value.type))
583 584
        if typeName.find(":") >= 0:
            typeName = "'" + typeName + "'"
585
        # 'class' is needed, see http://sourceware.org/bugzilla/show_bug.cgi?id=11912
586 587 588
        #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)
589
        #warn("CALL: %s" % exp)
590
        result = gdb.parse_and_eval(exp)
591
        #warn("  -> %s" % result)
592 593
        if not value.address:
            gdb.parse_and_eval("free(0x%x)" % ptr)
594 595
        return result

hjk's avatar
hjk committed
596
    def childWithName(self, value, name):
597
        try:
hjk's avatar
hjk committed
598
            return value[name]
599
        except:
hjk's avatar
hjk committed
600
            return None
601

hjk's avatar
hjk committed
602
    def makeValue(self, type, init):
603
        type = "::" + self.stripClassTag(str(type));
hjk's avatar
hjk committed
604 605 606
        # 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
607
        value = gdb.parse_and_eval("$d").dereference()
hjk's avatar
hjk committed
608 609 610 611 612 613
        #warn("  TYPE: %s" % value.type)
        #warn("  ADDR: %s" % value.address)
        #warn("  VALUE: %s" % value)
        return value

    def makeExpression(self, value):
614
        type = "::" + self.stripClassTag(str(value.type))
hjk's avatar
hjk committed
615 616 617 618 619 620 621 622 623 624 625
        #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
626
        value = gdb.parse_and_eval("$d").dereference()
hjk's avatar
hjk committed
627 628 629 630 631
        #warn("  TYPE: %s" % value.type)
        #warn("  ADDR: %s" % value.address)
        #warn("  VALUE: %s" % value)
        return value

632 633
    def childAt(self, value, index):
        field = value.type.fields()[index]
634 635 636 637 638 639 640 641 642 643 644 645 646
        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
647

648 649 650 651 652 653 654 655 656
        # 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]

657 658 659
    def simpleValue(self, value):
        return str(value)

660
    def directBaseClass(self, typeobj, index = 0):
661 662 663 664 665
        for f in typeobj.fields():
            if f.is_base_class:
                if index == 0:
                    return f.type
                index -= 1;
hjk's avatar
hjk committed
666 667 668 669 670 671 672 673
        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;
674
        return None
675 676 677 678 679 680 681 682 683 684 685 686 687 688 689

    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
690
        #    return p.cast(self.lookupType("void").pointer()) == 0
691 692 693 694 695 696 697 698
        #except:
        #    return False
        try:
            # Can fail with: "RuntimeError: Cannot access memory at address 0x5"
            return toInteger(p) == 0
        except:
            return False

699
    def templateArgument(self, typeobj, position):
700 701 702 703 704 705 706
        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))
707 708

    def numericTemplateArgument(self, typeobj, position):
709 710 711 712 713 714 715 716 717 718 719 720
        # 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)
721

722
    def intType(self):
723 724 725
        self.cachedIntType = self.lookupType('int')
        self.intType = lambda: self.cachedIntType
        return self.cachedIntType
726 727

    def charType(self):
hjk's avatar
hjk committed
728
        return self.lookupType('char')
729 730

    def sizetType(self):
hjk's avatar
hjk committed
731
        return self.lookupType('size_t')
732 733

    def charPtrType(self):
hjk's avatar
hjk committed
734
        return self.lookupType('char*')
735 736

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

739
    def addressOf(self, value):
740
        return toInteger(value.address)
741

742
    def createPointerValue(self, address, pointeeType):
743 744 745 746 747 748 749 750
        # 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))
751 752 753 754 755

    def intSize(self):
        return 4

    def ptrSize(self):
756 757 758
        self.cachedPtrSize = self.lookupType('void*').sizeof
        self.ptrSize = lambda: self.cachedPtrSize
        return self.cachedPtrSize
759

760 761 762 763 764 765 766 767 768 769 770 771 772 773
    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))


774
    def createValue(self, address, referencedType):
775 776 777 778 779
        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))
780

781 782 783 784 785 786 787 788 789
    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)

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

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

802
    def readRawMemory(self, addr, size):
803
        mem = self.selectedInferior().read_memory(addr, size)
804 805 806 807
        if sys.version_info[0] >= 3:
            mem.tobytes()
        return mem

808 809 810
    def extractInt64(self, addr):
        return struct.unpack("q", self.readRawMemory(addr, 8))[0]

811
    def extractInt(self, addr):
812
        return struct.unpack("i", self.readRawMemory(addr, 4))[0]
813

814
    def extractByte(self, addr):
815
        return struct.unpack("b", self.readRawMemory(addr, 1))[0]
816

817 818 819
    def findStaticMetaObject(self, typeName):
        return self.findSymbol(typeName + "::staticMetaObject")

820 821 822 823 824 825 826 827
    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:
828 829 830
            address = gdb.parse_and_eval("&'%s'" % symbolName)
            type = gdb.lookup_type(self.qtNamespace() + "QMetaObject")
            return self.createPointerValue(address, type)
831 832
        except:
            return 0
833

834 835 836 837 838
    def put(self, value):
        self.output.append(value)

    def childRange(self):
        if self.currentMaxNumChild is None:
839 840
            return xrange(0, toInteger(self.currentNumChild))
        return xrange(min(toInteger(self.currentMaxNumChild), toInteger(self.currentNumChild)))
841

842 843 844 845 846 847
    def isArmArchitecture(self):
        return 'arm' in gdb.TARGET_CONFIG.lower()

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

848 849 850 851
    def isWindowsTarget(self):
        # We get i686-w64-mingw32
        return 'mingw' in gdb.TARGET_CONFIG.lower()

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

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

875 876 877 878 879 880 881 882 883 884 885 886 887 888 889
    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

890
    def putAddress(self, addr):
891
        if self.currentPrintsAddress and not self.isCli:
892
            try:
893 894 895
                # addr can be "None", int(None) fails.
                #self.put('addr="0x%x",' % int(addr))
                self.currentAddress = 'addr="0x%x",' % toInteger(addr)
896 897 898 899 900 901 902 903
            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
904 905 906
    def putSimpleValue(self, value, encoding = None, priority = 0):
        self.putValue(value, encoding, priority)

907 908 909 910 911 912
    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
913
                self.lookupType("unsigned long")), None, -1)
914 915

    def stripNamespaceFromType(self, typeName):
916
        type = self.stripClassTag(typeName)
917 918 919
        ns = self.qtNamespace()
        if len(ns) > 0 and type.startswith(ns):
            type = type[len(ns):]
920 921 922 923 924 925 926 927 928 929 930
        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
931
        if self.isSimpleType(type):
932
            return True
933
        return self.isKnownMovableType(self.stripNamespaceFromType(str(type)))
934 935 936 937 938

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

939 940 941 942 943 944
    def isSimpleType(self, typeobj):
        code = typeobj.code
        return code == BoolCode \
            or code == CharCode \
            or code == IntCode \
            or code == FloatCode \
945
            or code == EnumCode
946 947 948 949 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

    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
977 978 979 980 981 982
    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
983 984 985
    def isFunctionType(self, type):
        return type.code == MethodCode or type.code == FunctionCode

986 987 988 989 990 991 992 993 994 995 996
    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)
997 998 999 1000 1001 1002 1003

        if value.is_optimized_out:
            self.putValue("<optimized out>")
            self.putType(typeName)
            self.putNumChild(0)
            return

1004
        tryDynamic &= self.useDynamicType
1005
        self.addToCache(type) # Fill type cache
1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018
        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.
1019
                if toInteger(value.address) == 0:
1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044
                    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
1045
                self.putBetterType("%s &" % self.currentType.value)
1046 1047 1048 1049 1050 1051 1052
                return
            except RuntimeError:
                self.putValue("<optimized out reference>")
                self.putType(typeName)
                self.putNumChild(0)
                return

1053
        if type.code == IntCode or type.code == CharCode:
1054
            self.putType(typeName)
1055
            if type.sizeof == 1:
1056 1057
                # Force unadorned value transport for char and Co.
                self.putValue(int(value) & 0xff)
1058 1059 1060 1061 1062 1063 1064
            else:
                self.putValue(value)
            self.putNumChild(0)
            return

        if type.code == FloatCode or type.code == BoolCode:
            self.putType(typeName)
1065
            self.putValue(value)
1066 1067 1068 1069 1070
            self.putNumChild(0)
            return

        if type.code == EnumCode:
            self.putType(typeName)
1071
            self.putValue("%s (%d)" % (value, value))
1072 1073 1074 1075 1076
            self.putNumChild(0)
            return

        if type.code == ComplexCode:
            self.putType(typeName)
1077
            self.putValue("%s" % value)
1078 1079 1080 1081
            self.putNumChild(0)
            return

        if type.code == TypedefCode:
1082
            if typeName in self.qqDumpers:
1083
                self.putType(typeName)
1084
                self.qqDumpers[typeName](self, value)
1085 1086 1087 1088 1089 1090 1091
                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:
1092
                value = self.parseAndEvaluate("{%s}%s" % (type, value.address))
1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106
            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:
1107
            self.putCStyleArray(value)
1108 1109 1110 1111 1112
            return

        if type.code == PointerCode:
            # This could still be stored in a register and
            # potentially dereferencable.
hjk's avatar
hjk committed
1113
            self.putFormattedPointer(value)
1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134
            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

1135 1136 1137
        if type.code == StringCode:
            # FORTRAN strings
            size = type.sizeof
1138
            data = self.readMemory(value.address, size)
1139 1140 1141
            self.putValue(data, Hex2EncodedLatin1, 1)
            self.putType(type)

1142 1143 1144 1145 1146 1147
        if type.code != StructCode and type.code != UnionCode:
            warn("WRONG ASSUMPTION HERE: %s " % type.code)
            check(False)


        if tryDynamic:
1148
            self.putItem(self.expensiveDowncast(value), False)
1149 1150
            return

1151
        format = self.currentItemFormat(typeName)
1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170

        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)
1171 1172 1173
            #warn(" DUMPERS: %s" % self.qqDumpers)
            #warn(" DUMPERS: %s" % (nsStrippedType in self.qqDumpers))
            dumper = self.qqDumpers.get(nsStrippedType, None)
1174 1175
            if not dumper is None:
                if tryDynamic:
1176
                    dumper(self, self.expensiveDowncast(value))
1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194
                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))
1195 1196 1197
        staticMetaObject = self.extractStaticMetaObject(value.type)
        if staticMetaObject:
            self.putQObjectNameValue(value)
1198 1199
        self.putType(typeName)
        self.putEmptyValue()
1200
        self.putNumChild(len(type.fields()))
1201 1202 1203 1204 1205

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

1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221
    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
1222
    def extractBlob(self, base, size):
1223
        inferior = self.selectedInferior()
hjk's avatar
hjk committed
1224
        return Blob(inferior.read_memory(base, size))
1225

hjk's avatar
hjk committed
1226 1227 1228 1229