lldbbridge.py 61.9 KB
Newer Older
1
2
############################################################################
#
3
# Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
# Contact: http://www.qt-project.org/legal
#
# This file is part of Qt Creator.
#
# Commercial License Usage
# Licensees holding valid commercial Qt licenses may use this file in
# accordance with the commercial license agreement provided with the
# Software or, alternatively, in accordance with the terms contained in
# a written agreement between you and Digia.  For licensing terms and
# conditions see http://qt.digia.com/licensing.  For further information
# use the contact form at http://qt.digia.com/contact-us.
#
# GNU Lesser General Public License Usage
# Alternatively, this file may be used under the terms of the GNU Lesser
# General Public License version 2.1 as published by the Free Software
# Foundation and appearing in the file LICENSE.LGPL included in the
# packaging of this file.  Please review the following information to
# ensure the GNU Lesser General Public License version 2.1 requirements
# will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
#
# In addition, as a special exception, Digia gives you certain additional
# rights.  These rights are described in the Digia Qt LGPL Exception
# version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
#
#############################################################################
29

30
import atexit
31
import inspect
32
import json
33
import os
34
import re
35
36
import select
import sys
37
import subprocess
38
import threading
39

40
41
42
43
44
currentDir = os.path.dirname(os.path.abspath(inspect.getfile(inspect.currentframe())))
sys.path.insert(1, currentDir)

from dumper import *
from qttypes import *
hjk's avatar
hjk committed
45
46
47
from stdtypes import *
from misctypes import *
from boosttypes import *
48
from creatortypes import *
49

50
51
52
lldbCmd = 'lldb'
if len(sys.argv) > 1:
    lldbCmd = sys.argv[1]
53

54
proc = subprocess.Popen(args=[lldbCmd, '-P'], stdout=subprocess.PIPE, stderr=subprocess.PIPE)
55
(path, error) = proc.communicate()
56

57
if error.startswith('lldb: invalid option -- P'):
58
    sys.stdout.write('msg=\'Could not run "%s -P". Trying to find lldb.so from Xcode.\'@\n' % lldbCmd)
59
60
61
62
63
    proc = subprocess.Popen(args=['xcode-select', '--print-path'],
        stdout=subprocess.PIPE, stderr=subprocess.PIPE)
    (path, error) = proc.communicate()
    if len(error):
        path = '/Applications/Xcode.app/Contents/SharedFrameworks/LLDB.framework/Versions/A/Resources/Python/'
64
65
        sys.stdout.write('msg=\'Could not run "xcode-select --print-path"@\n')
        sys.stdout.write('msg=\'Using hardcoded fallback at %s\'@\n' % path)
66
67
    else:
        path = path.strip() + '/../SharedFrameworks/LLDB.framework/Versions/A/Resources/Python/'
68
        sys.stdout.write('msg=\'Using fallback at %s\'@\n' % path)
69

70
sys.path.insert(1, path.strip())
71
72

import lldb
73
74
75
76
77
78
79

#######################################################################
#
# Helpers
#
#######################################################################

80
qqWatchpointOffset = 10000
81

82
lldb.theDumper = None
83
84

def warn(message):
85
    print('\n\nWARNING="%s",\n' % message.encode("latin1").replace('"', "'"))
86
87
88

def showException(msg, exType, exValue, exTraceback):
    warn("**** CAUGHT EXCEPTION: %s ****" % msg)
89
90
91
    import traceback
    lines = [line for line in traceback.format_exception(exType, exValue, exTraceback)]
    warn('\n'.join(lines))
92
93
94
95

def fileName(file):
    return str(file) if file.IsValid() else ''

96

97
98
99
100
101
102
103
104
105
106
# Breakpoints. Keep synchronized with BreakpointType in breakpoint.h
UnknownType = 0
BreakpointByFileAndLine = 1
BreakpointByFunction = 2
BreakpointByAddress = 3
BreakpointAtThrow = 4
BreakpointAtCatch = 5
BreakpointAtMain = 6
BreakpointAtFork = 7
BreakpointAtExec = 8
107
108
109
110
111
BreakpointAtSysCall = 9
WatchpointAtAddress = 10
WatchpointAtExpression = 11
BreakpointOnQmlSignalEmit = 12
BreakpointAtJavaScriptThrow = 13
112

113
114
115
# See db.StateType
stateNames = ["invalid", "unloaded", "connected", "attaching", "launching", "stopped",
    "running", "stepping", "crashed", "detached", "exited", "suspended" ]
116

117
118
119
def loggingCallback(args):
    s = args.strip()
    s = s.replace('"', "'")
120
    sys.stdout.write('log="%s"@\n' % s)
121

hjk's avatar
hjk committed
122
123
124
125
def check(exp):
    if not exp:
        raise RuntimeError("Check failed")

126
127
Value = lldb.SBValue

128
129
def impl_SBValue__add__(self, offset):
    if self.GetType().IsPointerType():
130
131
132
133
        if isinstance(offset, int) or isinstance(offset, long):
            pass
        else:
            offset = offset.GetValueAsSigned()
134
        itemsize = self.GetType().GetPointeeType().GetByteSize()
135
        address = self.GetValueAsUnsigned() + offset * itemsize
136
        address = address & 0xFFFFFFFFFFFFFFFF  # Force unsigned
137
138
        return self.CreateValueFromAddress(None, address,
                self.GetType().GetPointeeType()).AddressOf()
hjk's avatar
hjk committed
139

140
    raise RuntimeError("SBValue.__add__ not implemented: %s" % self.GetType())
141
142
    return NotImplemented

143
def impl_SBValue__sub__(self, other):
144
    if self.GetType().IsPointerType():
145
146
147
148
        if isinstance(other, int) or isinstance(other, long):
            address = self.GetValueAsUnsigned() - offset.GetValueAsSigned()
            address = address & 0xFFFFFFFFFFFFFFFF  # Force unsigned
            return self.CreateValueFromAddress(None, address, self.GetType())
149
        if other.GetType().IsPointerType():
150
151
            itemsize = self.GetType().GetPointeeType().GetByteSize()
            return (self.GetValueAsUnsigned() - other.GetValueAsUnsigned()) / itemsize
152
    raise RuntimeError("SBValue.__sub__ not implemented: %s" % self.GetType())
153
154
    return NotImplemented

155
156
157
158
159
160
161
def impl_SBValue__le__(self, other):
    if self.GetType().IsPointerType() and other.GetType().IsPointerType():
        return int(self) <= int(other)
    raise RuntimeError("SBValue.__le__ not implemented")
    return NotImplemented

def impl_SBValue__int__(self):
162
    return self.GetValueAsSigned()
163
164
165
166
167
168
169
170
171
172

def impl_SBValue__float__(self):
    error = lldb.SBError()
    if self.GetType().GetByteSize() == 4:
        result = self.GetData().GetFloat(error, 0)
    else:
        result = self.GetData().GetDouble(error, 0)
    if error.Success():
        return result
    return NotImplemented
173

174
175
176
def impl_SBValue__long__(self):
    return int(self.GetValue(), 0)

177
178
179
180
181
182
183
184
185
def impl_SBValue__getitem__(value, index):
    if isinstance(index, int):
        type = value.GetType()
        if type.IsPointerType():
            innertype = value.Dereference().GetType()
            address = value.GetValueAsUnsigned() + index * innertype.GetByteSize()
            address = address & 0xFFFFFFFFFFFFFFFF  # Force unsigned
            return value.CreateValueFromAddress(None, address, innertype)
        return value.GetChildAtIndex(index)
186
    return value.GetChildMemberWithName(index)
187

188
189
190
191
def impl_SBValue__deref(value):
    result = value.Dereference()
    if result.IsValid():
        return result
192
193
    exp = "*(class %s*)0x%x" % (value.GetType().GetPointeeType(), value.GetValueAsUnsigned())
    return value.CreateValueFromExpression(None, exp)
194

195
lldb.SBValue.__add__ = impl_SBValue__add__
196
lldb.SBValue.__sub__ = impl_SBValue__sub__
197
lldb.SBValue.__le__ = impl_SBValue__le__
198

199
200
lldb.SBValue.__getitem__ = impl_SBValue__getitem__
lldb.SBValue.__int__ = impl_SBValue__int__
201
lldb.SBValue.__float__ = impl_SBValue__float__
202
203
lldb.SBValue.__long__ = lambda self: long(self.GetValue(), 0)

204
lldb.SBValue.code = lambda self: self.GetTypeClass()
205
lldb.SBValue.cast = lambda self, typeObj: self.Cast(typeObj)
206
lldb.SBValue.dereference = impl_SBValue__deref
207
lldb.SBValue.address = property(lambda self: self.GetLoadAddress())
208
209

lldb.SBType.pointer = lambda self: self.GetPointerType()
hjk's avatar
hjk committed
210
lldb.SBType.target = lambda self: self.GetPointeeType()
211
lldb.SBType.code = lambda self: self.GetTypeClass()
212
lldb.SBType.sizeof = property(lambda self: self.GetByteSize())
213
214


hjk's avatar
hjk committed
215
216
lldb.SBType.unqualified = \
    lambda self: self.GetUnqualifiedType() if hasattr(self, 'GetUnqualifiedType') else self
217
218
lldb.SBType.strip_typedefs = \
    lambda self: self.GetCanonicalType() if hasattr(self, 'GetCanonicalType') else self
219

hjk's avatar
hjk committed
220
221
222
lldb.SBType.__orig__str__ = lldb.SBType.__str__
lldb.SBType.__str__ = lldb.SBType.GetName

223
224
225
226
def simpleEncoding(typeobj):
    code = typeobj.GetTypeClass()
    size = typeobj.sizeof
    if code == lldb.eTypeClassBuiltin:
hjk's avatar
hjk committed
227
228
229
230
231
232
        name = str(typeobj)
        if name == "float":
            return Hex2EncodedFloat4
        if name == "double":
            return Hex2EncodedFloat8
        if name.find("unsigned") >= 0:
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
            if size == 1:
                return Hex2EncodedUInt1
            if size == 2:
                return Hex2EncodedUInt2
            if size == 4:
                return Hex2EncodedUInt4
            if size == 8:
                return Hex2EncodedUInt8
        else:
            if size == 1:
                return Hex2EncodedInt1
            if size == 2:
                return Hex2EncodedInt2
            if size == 4:
                return Hex2EncodedInt4
            if size == 8:
                return Hex2EncodedInt8
    return None
hjk's avatar
hjk committed
251

252
class Dumper(DumperBase):
253
    def __init__(self):
254
255
        DumperBase.__init__(self)

256
257
        lldb.theDumper = self

258
        self.debugger = lldb.SBDebugger.Create()
259
        #self.debugger.SetLoggingCallback(loggingCallback)
260
261
262
263
264
265
        #Same as: self.debugger.HandleCommand("log enable lldb dyld step")
        #self.debugger.EnableLog("lldb", ["dyld", "step", "process", "state", "thread", "events",
        #    "communication", "unwind", "commands"])
        #self.debugger.EnableLog("lldb", ["all"])
        self.debugger.Initialize()
        self.debugger.HandleCommand("settings set auto-confirm on")
266
267
268
269
270
271
272
273
274
275

        # FIXME: warn("DISABLING DEFAULT FORMATTERS")
        # It doesn't work at all with 179.5 and we have some bad
        # interactonn in 3000
        # if not hasattr(lldb.SBType, 'GetCanonicalType'): # "Test" for 179.5
        self.debugger.HandleCommand('type category delete gnu-libstdc++')
        self.debugger.HandleCommand('type category delete libcxx')
        #for i in range(self.debugger.GetNumCategories()):
        #    self.debugger.GetCategoryAtIndex(i).SetEnabled(False)

276
        self.isLldb = True
hjk's avatar
hjk committed
277
        self.isGoodLldb = hasattr(lldb.SBValue, "SetPreferDynamicValue")
278
279
280
281
        self.process = None
        self.target = None
        self.eventState = lldb.eStateInvalid
        self.expandedINames = {}
282
        self.passExceptions = False
283
        self.useLldbDumpers = False
hjk's avatar
hjk committed
284
        self.autoDerefPointers = True
285
        self.useDynamicType = True
hjk's avatar
hjk committed
286
        self.useFancy = True
hjk's avatar
hjk committed
287
288
        self.formats = {}
        self.typeformats = {}
289
290
291
292
293
294

        self.currentIName = None
        self.currentValuePriority = -100
        self.currentValueEncoding = None
        self.currentType = ""
        self.currentTypePriority = -100
295
        self.currentValue = None
296
297
298
299
300
        self.currentNumChild = None
        self.currentMaxNumChild = None
        self.currentPrintsAddress = None
        self.currentChildType = None
        self.currentChildNumChild = None
301
        self.currentWatchers = {}
302

hjk's avatar
hjk committed
303
        self.executable_ = None
304
305
306
307
        self.startMode_ = None
        self.processArgs_ = None
        self.attachPid_ = None

308
309
        self.charType_ = None
        self.intType_ = None
310
        self.int64Type_ = None
311
312
        self.sizetType_ = None
        self.charPtrType_ = None
hjk's avatar
hjk committed
313
        self.voidPtrType_ = None
314
        self.isShuttingDown_ = False
315
        self.isInterrupting_ = False
316
        self.dummyValue = None
317
        self.types_ = {}
318

319
320
321
322
    def enterSubItem(self, item):
        if isinstance(item.name, lldb.SBValue):
            # Avoid $$__synth__ suffix on Mac.
            value = item.name
hjk's avatar
hjk committed
323
324
            if self.isGoodLldb:
                value.SetPreferSyntheticValue(False)
325
326
327
328
            item.name = value.GetName()
            if item.name is None:
                self.anonNumber += 1
                item.name = "#%d" % self.anonNumber
329
330
        if not item.iname:
            item.iname = "%s.%s" % (self.currentIName, item.name)
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
        self.put('{')
        #if not item.name is None:
        if isinstance(item.name, str):
            if item.name == '**&':
                item.name = '*'
            self.put('name="%s",' % item.name)
        item.savedIName = self.currentIName
        item.savedValue = self.currentValue
        item.savedValuePriority = self.currentValuePriority
        item.savedValueEncoding = self.currentValueEncoding
        item.savedType = self.currentType
        item.savedTypePriority = self.currentTypePriority
        self.currentIName = item.iname
        self.currentValuePriority = -100
        self.currentValueEncoding = None
        self.currentType = ""
        self.currentTypePriority = -100

    def exitSubItem(self, item, exType, exValue, exTraceBack):
        if not exType is None:
            if self.passExceptions:
                showException("SUBITEM", exType, exValue, exTraceBack)
            self.putNumChild(0)
            self.putValue("<not accessible>")
        try:
            typeName = self.currentType
            if len(typeName) > 0 and typeName != self.currentChildType:
                self.put('type="%s",' % typeName) # str(type.unqualified()) ?
            if  self.currentValue is None:
                self.put('value="<not accessible>",numchild="0",')
            else:
                if not self.currentValueEncoding is None:
363
                    self.put('valueencoded="%s",' % self.currentValueEncoding)
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
                self.put('value="%s",' % self.currentValue)
        except:
            pass
        self.put('},')
        self.currentIName = item.savedIName
        self.currentValue = item.savedValue
        self.currentValuePriority = item.savedValuePriority
        self.currentValueEncoding = item.savedValueEncoding
        self.currentType = item.savedType
        self.currentTypePriority = item.savedTypePriority
        return True

    def isSimpleType(self, typeobj):
        typeClass = typeobj.GetTypeClass()
        return typeClass == lldb.eTypeClassBuiltin

hjk's avatar
hjk committed
380
381
382
    def childWithName(self, value, name):
        child = value.GetChildMemberWithName(name)
        return child if child.IsValid() else None
383

384
385
386
    def simpleValue(self, value):
        return str(value.value)

387
388
389
390
391
392
393
394
395
    def childAt(self, value, index):
        return value.GetChildAtIndex(index)

    def fieldAt(self, type, index):
        return type.GetFieldAtIndex(index)

    def pointerValue(self, value):
        return value.GetValueAsUnsigned()

396
397
398
399
400
    def enumExpression(self, enumType, enumValue):
        ns = self.qtNamespace()
        return ns + "Qt::" + enumType + "(" \
            + ns + "Qt::" + enumType + "::" + enumValue + ")"

401
402
403
404
405
406
407
    def call2(self, value, func, args):
        # args is a tuple.
        arg = ','.join(args)
        #warn("CALL: %s -> %s(%s)" % (value, func, arg))
        type = value.type.name
        exp = "((%s*)%s)->%s(%s)" % (type, value.address, func, arg)
        #warn("CALL: %s" % exp)
408
        result = value.CreateValueFromExpression('', exp)
409
410
411
        #warn("  -> %s" % result)
        return result

412
413
414
415
416
417
418
419
420
421
    def makeValue(self, type, *args):
        thread = self.currentThread()
        frame = thread.GetFrameAtIndex(0)
        inner = ','.join(args)
        value = frame.EvaluateExpression(type + '{' + inner + '}')
        #warn("  TYPE: %s" % value.type)
        #warn("  ADDR: 0x%x" % value.address)
        #warn("  VALUE: %s" % value)
        return value

422
423
424
425
426
    def parseAndEvaluate(self, expr):
        thread = self.currentThread()
        frame = thread.GetFrameAtIndex(0)
        return frame.EvaluateExpression(expr)

427
428
429
430
431
432
433
434
435
436
437
438
439
    def call(self, value, func, *args):
        return self.call2(value, func, args)

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

    def isNull(self, p):
        return p.GetValueAsUnsigned() == 0

    def directBaseClass(self, typeobj, index = 0):
        return typeobj.GetDirectBaseClassAtIndex(index)

440
    def templateArgument(self, typeobj, index):
441
        type = typeobj.GetTemplateArgumentType(index)
hjk's avatar
hjk committed
442
        if type.IsValid():
443
444
445
446
447
448
449
            return type
        inner = self.extractTemplateArgument(typeobj.GetName(), index)
        return self.lookupType(inner)

    def numericTemplateArgument(self, typeobj, index):
        inner = self.extractTemplateArgument(typeobj.GetName(), index)
        return int(inner)
450

hjk's avatar
hjk committed
451
452
453
454
455
456
    def isReferenceType(self, typeobj):
        return typeobj.IsReferenceType()

    def isStructType(self, typeobj):
        return typeobj.GetTypeClass() in (lldb.eTypeClassStruct, lldb.eTypeClassClass)

457
458
    def qtVersionAndNamespace(self):
        self.cachedQtNamespace = ""
459
        self.cachedQtVersion = 0x0
460

461
462
463
        coreExpression = re.compile(r"(lib)?Qt5?Core")
        for n in range(0, self.target.GetNumModules()):
            module = self.target.GetModuleAtIndex(n)
464
465
            fileName = module.GetFileSpec().GetFilename()
            if coreExpression.match(fileName):
466
                # Extract version.
467
                reverseVersion = module.GetVersion()
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
                if len(reverseVersion):
                    # Mac, Clang?
                    reverseVersion.reverse()
                    shift = 0
                    for v in reverseVersion:
                        self.cachedQtVersion += v << shift
                        shift += 8
                else:
                    # Linux, gcc?
                    if fileName.endswith(".5"):
                        self.cachedQtVersion = 0x50000
                    elif fileName.endswith(".4"):
                        self.cachedQtVersion = 0x40800
                    else:
                        warn("CANNOT GUESS QT VERSION")

484
485
486
487
488
489
490
491
492
493

                # Look for some Qt symbol to extract namespace.
                for symbol in module.symbols:
                    name = symbol.GetName()
                    pos = name.find("QString")
                    if pos >= 0:
                        name = name[:pos]
                        if name.endswith("::"):
                            self.cachedQtNamespace = re.sub('^.*[^\w]([\w]+)::$', '\\1', name) + '::'
                        break
494
                break
495
496

        # Memoize good results.
497
        self.qtNamespace = lambda: self.cachedQtNamespace
498
        self.qtVersion = lambda: self.cachedQtVersion
499
500
501
502
503
504

    def qtNamespace(self):
        self.qtVersionAndNamespace()
        return self.cachedQtNamespace

    def qtVersion(self):
505
        self.qtVersionAndNamespace()
506
        return self.cachedQtVersion
507

hjk's avatar
hjk committed
508
509
510
    def intSize(self):
        return 4

511
512
    def intType(self):
        if self.intType_ is None:
hjk's avatar
hjk committed
513
             self.intType_ = self.target.FindFirstType('int')
514
515
        return self.intType_

516
517
518
519
520
    def int64Type(self):
        if self.int64Type_ is None:
             self.int64Type_ = self.target.FindFirstType('long long int')
        return self.int64Type_

521
522
    def charType(self):
        if self.charType_ is None:
hjk's avatar
hjk committed
523
             self.charType_ = self.target.FindFirstType('char')
524
525
526
527
528
529
530
531
        return self.charType_

    def charPtrType(self):
        if self.charPtrType_ is None:
             self.charPtrType_ = self.charType().GetPointerType()
        return self.charPtrType_

    def voidPtrType(self):
hjk's avatar
hjk committed
532
533
534
        if self.voidPtrType_ is None:
             self.voidPtrType_ = self.target.FindFirstType('void').GetPointerType()
        return self.voidPtrType_
535

hjk's avatar
hjk committed
536
    def ptrSize(self):
537
538
539
540
541
542
543
        return self.charPtrType().GetByteSize()

    def sizetType(self):
        if self.sizetType_ is None:
             self.sizetType_ = self.lookupType('size_t')
        return self.sizetType_

544
545
546
    def addressOf(self, value):
        return int(value.GetLoadAddress())

hjk's avatar
hjk committed
547
548
549
    def extractInt(self, address):
        return int(self.createValue(address, self.intType()))

550
551
552
    def extractInt64(self, address):
        return int(self.createValue(address, self.int64Type()))

553
554
555
    def extractByte(self, address):
        return int(self.createValue(address, self.charType())) & 0xFF

556
557
558
559
560
561
    def handleCommand(self, command):
        result = lldb.SBCommandReturnObject()
        self.debugger.GetCommandInterpreter().HandleCommand(command, result)
        success = result.Succeeded()
        if success:
            self.report('output="%s"' % result.GetOutput())
562
        else:
563
564
565
566
567
568
            self.report('error="%s"' % result.GetError())
        self.reportData()

    def put(self, stuff):
        sys.stdout.write(stuff)

569
    def isMovableType(self, type):
570
        if type.GetTypeClass() in (lldb.eTypeClassBuiltin, lldb.eTypeClassPointer):
571
            return True
572
        return self.isKnownMovableType(self.stripNamespaceFromType(type.GetName()))
573

574
575
    def putNumChild(self, numchild):
        #warn("NUM CHILD: '%s' '%s'" % (numchild, self.currentChildNumChild))
hjk's avatar
hjk committed
576
577
        #if numchild != self.currentChildNumChild:
        self.put('numchild="%s",' % numchild)
578

579
580
581
582
583
584
585
    def putPointerValue(self, value):
        # Use a lower priority
        if value is None:
            self.putEmptyValue(-1)
        else:
            self.putValue("0x%x" % value.Dereference())

hjk's avatar
hjk committed
586
587
588
    def putSimpleValue(self, value, encoding = None, priority = 0):
        self.putValue(value.GetValue(), encoding, priority)

589
    def tryPutArrayContents(self, typeobj, base, n):
590
        if not self.isSimpleType(typeobj):
591
592
593
            return False
        size = n * typeobj.sizeof
        self.put('childtype="%s",' % typeobj)
594
595
        self.put('addrbase="0x%x",' % int(base))
        self.put('addrstep="%d",' % typeobj.sizeof)
596
597
        self.put('arrayencoding="%s",' % simpleEncoding(typeobj))
        self.put('arraydata="')
598
        self.put(self.readMemory(base, size))
599
600
601
602
603
604
        self.put('",')
        return True

    def putArrayData(self, type, base, n,
            childNumChild = None, maxNumChild = 10000):
        if not self.tryPutArrayContents(type, base, n):
605
            base = self.createPointerValue(base, type)
606
607
608
609
610
            with Children(self, n, type, childNumChild, maxNumChild,
                    base, type.GetByteSize()):
                for i in self.childRange():
                    self.putSubItem(i, (base + i).dereference())

611
612
613
614
615
616
617
618
    def createPointerValue(self, address, pointeeType):
        addr = int(address) & 0xFFFFFFFFFFFFFFFF
        return self.context.CreateValueFromAddress(None, addr, pointeeType).AddressOf()

    def createValue(self, address, referencedType):
        addr = int(address) & 0xFFFFFFFFFFFFFFFF
        return self.context.CreateValueFromAddress(None, addr, referencedType)

619
    def putCallItem(self, name, value, func, *args):
620
        result = self.call2(value, func, args)
621
622
623
        with SubItem(self, name):
            self.putItem(result)

624
625
626
627
628
    def childRange(self):
        if self.currentMaxNumChild is None:
            return xrange(0, self.currentNumChild)
        return xrange(min(self.currentMaxNumChild, self.currentNumChild))

629
630
631
    def canonicalTypeName(self, name):
        return re.sub('\\bconst\\b', '', name).replace(' ', '')

632
    def lookupType(self, name):
hjk's avatar
hjk committed
633
        #warn("LOOKUP TYPE NAME: %s" % name)
hjk's avatar
hjk committed
634
        if name.endswith('*'):
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
            typeobj = self.lookupType(name[:-1].strip())
            return typeobj.GetPointerType() if type.IsValid() else None
        typeobj = self.target.FindFirstType(name)
        #warn("LOOKUP RESULT: %s" % typeobj.name)
        #warn("LOOKUP VALID: %s" % typeobj.IsValid())
        if typeobj.IsValid():
            return typeobj
        try:
            if len(self.types_) == 0:
                for i in xrange(self.target.GetNumModules()):
                    module = self.target.GetModuleAtIndex(i)
                    # SBModule.GetType is new somewhere after early 300.x
                    # So this may fail.
                    for t in module.GetTypes():
                        n = self.canonicalTypeName(t.GetName())
                        self.types_[n] = t
            return self.types_.get(self.canonicalTypeName(name))
        except:
            pass
        return None
655

656
    def setupInferior(self, args):
657
        error = lldb.SBError()
658
659

        self.executable_ = args['executable']
660
        self.startMode_ = args.get('startMode', 1)
661
662
        self.processArgs_ = args.get('processArgs', [])
        self.processArgs_ = map(lambda x: self.hexdecode(x), self.processArgs_)
663
        self.attachPid_ = args.get('attachPid', 0)
Fawzi Mohamed's avatar
Fawzi Mohamed committed
664
        self.sysRoot_ = args.get('sysRoot', '')
Fawzi Mohamed's avatar
Fawzi Mohamed committed
665
        self.remoteChannel_ = args.get('remoteChannel', '')
666
        self.platform_ = args.get('platform', '')
667

668
669
        if self.platform_:
            self.debugger.SetCurrentPlatform(self.platform_)
Fawzi Mohamed's avatar
Fawzi Mohamed committed
670
671
672
        # sysroot has to be set *after* the platform
        if self.sysRoot_:
            self.debugger.SetCurrentPlatformSDKRoot(self.sysRoot_)
673
        self.target = self.debugger.CreateTarget(self.executable_, None, None, True, error)
674
675
        self.importDumpers()

676
677
        state = "inferiorsetupok" if self.target.IsValid() else "inferiorsetupfailed"
        self.report('state="%s",msg="%s",exe="%s"' % (state, error, self.executable_))
678

679
    def runEngine(self, _):
hjk's avatar
hjk committed
680
681
682
683
        s = threading.Thread(target=self.loop, args=[])
        s.start()

    def loop(self):
684
        error = lldb.SBError()
hjk's avatar
hjk committed
685
686
        listener = self.debugger.GetListener()

687
688
689
        if self.attachPid_ > 0:
            attachInfo = lldb.SBAttachInfo(self.attachPid_)
            self.process = self.target.Attach(attachInfo, error)
690
            if not error.Success():
Fawzi Mohamed's avatar
Fawzi Mohamed committed
691
692
693
                self.report('state="inferiorrunfailed"')
                return
            self.report('pid="%s"' % self.process.GetProcessID())
694
695
696
697
            # even if it stops it seems that lldb assumes it is running and later detects that
            # it did stop after all, so it is be better to mirror that and wait for the spontaneous
            # stop
            self.report('state="enginerunandinferiorrunok"')
Fawzi Mohamed's avatar
Fawzi Mohamed committed
698
699
700
701
        elif len(self.remoteChannel_) > 0:
            self.process = self.target.ConnectRemote(
            self.debugger.GetListener(),
            self.remoteChannel_, None, error)
702
703
704
            if not error.Success():
                self.report('state="inferiorrunfailed"')
                return
705
706
707
708
            # even if it stops it seems that lldb assumes it is running and later detects that
            # it did stop after all, so it is be better to mirror that and wait for the spontaneous
            # stop
            self.report('state="enginerunandinferiorrunok"')
709
        else:
710
            launchInfo = lldb.SBLaunchInfo(self.processArgs_)
711
            launchInfo.SetWorkingDirectory(os.getcwd())
712
713
            environmentList = [key + "=" + value for key,value in os.environ.items()]
            launchInfo.SetEnvironmentEntries(environmentList, False)
714
            self.process = self.target.Launch(launchInfo, error)
715
            if not error.Success():
716
717
                self.reportError(error)
                self.report('state="enginerunfailed"')
Fawzi Mohamed's avatar
Fawzi Mohamed committed
718
719
720
                return
            self.report('pid="%s"' % self.process.GetProcessID())
            self.report('state="enginerunandinferiorrunok"')
721

hjk's avatar
hjk committed
722
723
724
725
726
727
        event = lldb.SBEvent()
        while True:
            if listener.WaitForEvent(10000000, event):
                self.handleEvent(event)
            else:
                warn('TIMEOUT')
728

729
    def describeError(self, error):
730
731
732
733
734
735
        desc = lldb.SBStream()
        error.GetDescription(desc)
        result = 'error={type="%s"' % error.GetType()
        result += ',code="%s"' % error.GetError()
        result += ',msg="%s"' % error.GetCString()
        result += ',desc="%s"}' % desc.GetData()
736
737
738
739
        return result

    def reportError(self, error):
        self.report(self.describeError(error))
740
741

    def currentThread(self):
742
        return None if self.process is None else self.process.GetSelectedThread()
743
744

    def currentFrame(self):
745
746
        thread = self.currentThread()
        return None if thread is None else thread.GetSelectedFrame()
747
748
749

    def reportLocation(self):
        thread = self.currentThread()
750
        frame = thread.GetSelectedFrame()
751
752
753
754
        file = fileName(frame.line_entry.file)
        line = frame.line_entry.line
        self.report('location={file="%s",line="%s",addr="%s"}' % (file, line, frame.pc))

755
756
757
    def firstStoppedThread(self):
        for i in xrange(0, self.process.GetNumThreads()):
            thread = self.process.GetThreadAtIndex(i)
758
759
760
761
762
763
            reason = thread.GetStopReason()
            if (reason == lldb.eStopReasonBreakpoint or
                    reason == lldb.eStopReasonException or
                    reason == lldb.eStopReasonPlanComplete or
                    reason == lldb.eStopReasonSignal or
                    reason == lldb.eStopReasonWatchpoint):
764
765
766
                return thread
        return None

767
    def reportThreads(self):
768
769
        reasons = ['None', 'Trace', 'Breakpoint', 'Watchpoint', 'Signal', 'Exception',
            'Exec', 'PlanComplete']
770
        result = 'threads={threads=['
771
        for i in xrange(0, self.process.GetNumThreads()):
772
            thread = self.process.GetThreadAtIndex(i)
773
            stopReason = thread.GetStopReason()
774
775
            result += '{id="%d"' % thread.GetThreadID()
            result += ',index="%s"' % i
776
            result += ',details="%s"' % thread.GetQueueName()
777
778
779
            result += ',stop-reason="%s"' % stopReason
            if stopReason >= 0 and stopReason < len(reasons):
                result += ',state="%s"' % reasons[stopReason]
780
            result += ',name="%s"' % thread.GetName()
781
782
783
784
785
            result += ',frame={'
            frame = thread.GetFrameAtIndex(0)
            result += 'pc="0x%x"' % frame.pc
            result += ',addr="0x%x"' % frame.pc
            result += ',fp="0x%x"' % frame.fp
786
            result += ',func="%s"' % frame.GetFunctionName()
787
788
789
790
791
792
793
794
            result += ',line="%s"' % frame.line_entry.line
            result += ',fullname="%s"' % fileName(frame.line_entry.file)
            result += ',file="%s"' % fileName(frame.line_entry.file)
            result += '}},'

        result += '],current-thread-id="%s"},' % self.currentThread().id
        self.report(result)

795
    def firstUsableFrame(self, thread):
hjk's avatar
hjk committed
796
        for i in xrange(10):
hjk's avatar
hjk committed
797
798
799
800
801
802
803
            frame = thread.GetFrameAtIndex(i)
            lineEntry = frame.GetLineEntry()
            line = lineEntry.GetLine()
            if line != 0:
                return i
        return None

804
    def reportStack(self, args = {}):
805
        if not self.process:
806
            self.report('msg="No process"')
807
808
            return
        thread = self.currentThread()
809
        limit = args.get('stacklimit', -1)
810
811
812
813
814
815
        if not thread:
            self.report('msg="No thread"')
            return
        frame = thread.GetSelectedFrame()
        if frame:
            frameId = frame.GetFrameID()
816
        else:
817
            frameId = 0;
818
819
820

        (n, isLimited) = (limit, True) if limit > 0 else (thread.GetNumFrames(), False)

821
822
823
824
825
        result = 'stack={current-frame="%s"' % frameId
        result += ',current-thread="%s"' % thread.GetThreadID()
        result += ',frames=['
        for i in xrange(n):
            frame = thread.GetFrameAtIndex(i)
826
827
828
            if not frame.IsValid():
                isLimited = False
                break
829
830
831
832
833
834
835
836
837
838
839
            lineEntry = frame.GetLineEntry()
            line = lineEntry.GetLine()
            usable = line != 0
            result += '{pc="0x%x"' % frame.GetPC()
            result += ',level="%d"' % frame.idx
            result += ',addr="0x%x"' % frame.GetPCAddress().GetLoadAddress(self.target)
            result += ',func="%s"' % frame.GetFunctionName()
            result += ',line="%d"' % line
            result += ',fullname="%s"' % fileName(lineEntry.file)
            result += ',usable="%d"' % usable
            result += ',file="%s"},' % fileName(lineEntry.file)
840
841
842
843
        result += ']'
        result += ',hasmore="%d"' % isLimited
        result += ',limit="%d"' % limit
        result += '}'
844
        self.report(result)
845

846
847
848
849
850
    def putBetterType(self, type):
        try:
            self.currentType = type.GetName()
        except:
            self.currentType = str(type)
851
        self.currentTypePriority = self.currentTypePriority + 1
hjk's avatar
hjk committed
852
        #warn("BETTER TYPE: %s PRIORITY: %s" % (type, self.currentTypePriority))
hjk's avatar
hjk committed
853

hjk's avatar
hjk committed
854
    def extractBlob(self, base, size):
hjk's avatar
hjk committed
855
        if size == 0:
hjk's avatar
hjk committed
856
            return Blob("")
857
858
        base = int(base) & 0xFFFFFFFFFFFFFFFF
        size = int(size) & 0xFFFFFFFF
hjk's avatar
hjk committed
859
        error = lldb.SBError()
hjk's avatar
hjk committed
860
        return Blob(self.process.ReadMemory(base, size, error))
hjk's avatar
hjk committed
861

862
863
864
865
866
867
868
869
870
871
    def toBlob(self, value):
        data = value.GetData()
        size = int(data.GetByteSize())
        buf = bytearray(struct.pack('x' * size))
        error = lldb.SBError()
        #data.ReadRawData(error, 0, buf)
        for i in range(size):
            buf[i] = data.GetUnsignedInt8(error, i)
        return Blob(bytes(buf))

872
873
874
    def extractStaticMetaObjectHelper(self, typeobj):
        if typeobj.GetTypeClass() in (lldb.eTypeClassStruct, lldb.eTypeClassClass):
            needle = typeobj.GetUnqualifiedType().GetName() + "::staticMetaObject"
875
876
877
878
879
880
881
882
            options = lldb.SBExpressionOptions()
            result = self.target.EvaluateExpression(needle, options)
            # Surprising results include:
            # (lldb) script print lldb.target.FindFirstGlobalVariable(
            # '::QSharedDataPointer<QDirPrivate>::staticMetaObject')
            # (const QMetaObject) QAbstractAnimation::staticMetaObject = { d = { ... } }
            #if result.GetName() != needle:
            if result is None or not result.IsValid():
883
884
885
886
887
888
                result = 0
        else:
            result = 0
        self.knownStaticMetaObjects[typeobj.GetName()] = result
        return result

889
    def extractStaticMetaObject(self, typeobj):
hjk's avatar
hjk committed
890
891
        if not self.isGoodLldb:
            return 0
892
893
894
895
896
        result = self.extractStaticMetaObjectHelper(typeobj)
        if result:
            return result
        base = typeobj.GetDirectBaseClassAtIndex(0).GetType()
        return self.extractStaticMetaObjectHelper(base)
hjk's avatar
hjk committed
897

898
899
900
    def stripNamespaceFromType(self, typeName):
        #type = stripClassTag(typeName)
        type = typeName
901
902
903
        ns = self.qtNamespace()
        if len(ns) > 0 and type.startswith(ns):
            type = type[len(ns):]
904
905
906
907
908
909
        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("<")
hjk's avatar
hjk committed
910
911
912
913
        if type.startswith("const "):
            type = type[6:]
        if type.startswith("volatile "):
            type = type[9:]
914
915
916
        return type

    def putSubItem(self, component, value, tryDynamic=True):
917
        if not value.IsValid():
918
            warn("INVALID SUBITEM: %s" % value.GetName())
919
            return
920
921
922
        with SubItem(self, component):
            self.putItem(value, tryDynamic)

hjk's avatar
hjk committed
923
    def putAddress(self, addr):
924
925
926
927
        #if int(addr) == 0xffffffffffffffff:
        #    raise RuntimeError("Illegal address")
        if self.currentPrintsAddress and not addr is None:
            self.put('addr="0x%x",' % int(addr))
hjk's avatar
hjk committed
928

hjk's avatar
hjk committed
929
930
931
932
933
    def isFunctionType(self, typeobj):
        if self.isGoodLldb:
            return typeobj.IsFunctionType()
        #warn("TYPE: %s" % typeobj)
        return False
hjk's avatar
hjk committed
934

935
    def putItem(self, value, tryDynamic=True):
hjk's avatar
hjk committed
936
        #value = value.GetDynamicValue(lldb.eDynamicCanRunTarget)
937
        typeName = value.GetType().GetUnqualifiedType().GetName()
hjk's avatar
hjk committed
938
939
        if self.isGoodLldb:
            value.SetPreferDynamicValue(tryDynamic)
hjk's avatar
hjk committed
940
        typeClass = value.GetType().GetTypeClass()
941

hjk's avatar
hjk committed
942
        if tryDynamic:
943
            self.putAddress(value.GetLoadAddress())
hjk's avatar
hjk committed
944

945
        # Handle build-in LLDB visualizers if wanted.
946
        if False and self.useLldbDumpers and value.GetTypeSynthetic().IsValid():
947
948
949
950
            # FIXME: print "official" summary?
            summary = value.GetTypeSummary()
            if summary.IsValid():
                warn("DATA: %s" % summary.GetData())
hjk's avatar
hjk committed
951
952
            if self.isGoodLldb:
                value.SetPreferSyntheticValue(False)
953
954
955
956
957
            provider = value.GetTypeSynthetic()
            data = provider.GetData()
            formatter = eval(data)(value, {})
            formatter.update()
            numchild = formatter.num_children()
hjk's avatar
hjk committed
958
            self.put('iname="%s",' % self.currentIName)
hjk's avatar
hjk committed
959
            self.putType(typeName)
hjk's avatar
hjk committed
960
961
            self.put('numchild="%s",' % numchild)
            self.put('addr="0x%x",' % value.GetLoadAddress())
962
            self.putItemCount(numchild)
hjk's avatar
hjk committed
963
964
            if self.currentIName in self.expandedINames:
                with Children(self):
965
966
967
968
969
970
                    for i in xrange(numchild):
                        child = formatter.get_child_at_index(i)
                        with SubItem(self, i):
                            self.putItem(child)
            return

hjk's avatar
hjk committed
971
972
        # Typedefs
        if typeClass == lldb.eTypeClassTypedef:
973
            if typeName in self.qqDumpers:
hjk's avatar
hjk committed
974
975
                self.putType(typeName)
                self.context = value
976
                self.qqDumpers[typeName](self, value)
hjk's avatar
hjk committed
977
                return
hjk's avatar
hjk committed
978
979
            realType = value.GetType()
            if hasattr(realType, 'GetCanonicalType'):
980
981
982
983
                baseType = realType.GetCanonicalType()
                baseValue = value.Cast(baseType.unqualified())
                self.putItem(baseValue)
                self.putBetterType(realType)
hjk's avatar
hjk committed
984
                return
hjk's avatar
hjk committed
985

986
        # Our turf now.
hjk's avatar
hjk committed
987
988
        if self.isGoodLldb:
            value.SetPreferSyntheticValue(False)
989

990
        # Arrays
hjk's avatar
hjk committed
991
        if typeClass == lldb.eTypeClassArray:
992
            self.putCStyleArray(value)
993
994
            return

995
996
        # Vectors like char __attribute__ ((vector_size (8)))
        if typeClass == lldb.eTypeClassVector:
997
            self.putCStyleArray(value)
998
999
            return

1000
1001
        # References
        if value.GetType().IsReferenceType():
hjk's avatar
hjk committed
1002
            origType = value.GetTypeName();
hjk's avatar
hjk committed
1003
            type = value.GetType().GetDereferencedType().unqualified()
hjk's avatar
hjk committed
1004
            addr = int(value) & 0xFFFFFFFFFFFFFFFF
hjk's avatar
hjk committed
1005
            self.putItem(value.CreateValueFromAddress(None, addr, type))
hjk's avatar
hjk committed
1006
            self.putBetterType(origType)
1007
1008
            return

hjk's avatar
hjk committed
1009
        # Pointers
hjk's avatar
hjk committed
1010
        if value.GetType().IsPointerType():
hjk's avatar
hjk committed
1011
1012
            self.putFormattedPointer(value)
            return
hjk's avatar
hjk committed
1013

1014
        #warn("VALUE: %s" % value)
hjk's avatar
hjk committed
1015
1016
1017
1018
        #warn("FANCY: %s" % self.useFancy)
        if self.useFancy:
            stripped = self.stripNamespaceFromType(typeName).replace("::", "__")
            #warn("STRIPPED: %s" % stripped)
1019
1020
            #warn("DUMPABLE: %s" % (stripped in self.qqDumpers))
            if stripped in self.qqDumpers:
hjk's avatar
hjk committed
1021
                self.putType(typeName)
hjk's avatar
hjk committed
1022
                self.context = value
1023
                self.qqDumpers[stripped](self, value)
hjk's avatar
hjk committed
1024
                return
1025
1026
1027
1028

        # Normal value
        #numchild = 1 if value.MightHaveChildren() else 0
        numchild = value.GetNumChildren()
hjk's avatar
hjk committed
1029
        self.putType(typeName)
1030
1031
1032
1033
1034
        self.putEmptyValue(-1)
        staticMetaObject = self.extractStaticMetaObject(value.GetType())
        if staticMetaObject:
            self.context = value
            self.putQObjectNameValue(value)
hjk's avatar
hjk committed
1035
1036
1037
1038
1039
        else:
            v = value.GetValue()
            if v:
                self.putValue(v)

1040
        self.put('numchild="%s",' % numchild)
1041

1042
1043
1044
        if self.currentIName in self.