lldbbridge.py 64.4 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 platform
35
import re
36
37
import select
import sys
38
import subprocess
39
import threading
40

41
42
43
44
45
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
46
47
48
from stdtypes import *
from misctypes import *
from boosttypes import *
49
from creatortypes import *
50

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

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

58
if error.startswith('lldb: invalid option -- P'):
59
    sys.stdout.write('msg=\'Could not run "%s -P". Trying to find lldb.so from Xcode.\'@\n' % lldbCmd)
60
61
62
63
64
    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/'
65
66
        sys.stdout.write('msg=\'Could not run "xcode-select --print-path"@\n')
        sys.stdout.write('msg=\'Using hardcoded fallback at %s\'@\n' % path)
67
68
    else:
        path = path.strip() + '/../SharedFrameworks/LLDB.framework/Versions/A/Resources/Python/'
69
        sys.stdout.write('msg=\'Using fallback at %s\'@\n' % path)
70

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

import lldb
74
75
76
77
78
79
80

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

81
qqWatchpointOffset = 10000
82

83
lldb.theDumper = None
84
85

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

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

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

97

98
99
100
101
102
103
104
105
106
107
# 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
108
109
110
111
112
BreakpointAtSysCall = 9
WatchpointAtAddress = 10
WatchpointAtExpression = 11
BreakpointOnQmlSignalEmit = 12
BreakpointAtJavaScriptThrow = 13
113

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

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

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

127
128
Value = lldb.SBValue

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

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

144
def impl_SBValue__sub__(self, other):
145
    if self.GetType().IsPointerType():
146
147
148
149
        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())
150
        if other.GetType().IsPointerType():
151
152
            itemsize = self.GetType().GetPointeeType().GetByteSize()
            return (self.GetValueAsUnsigned() - other.GetValueAsUnsigned()) / itemsize
153
    raise RuntimeError("SBValue.__sub__ not implemented: %s" % self.GetType())
154
155
    return NotImplemented

156
157
158
159
160
161
162
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):
163
    return self.GetValueAsSigned()
164
165
166
167
168
169
170
171
172
173

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
174

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

178
179
180
181
182
183
184
185
186
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)
187
    return value.GetChildMemberWithName(index)
188

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

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

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

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

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


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

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

224
225
226
227
def simpleEncoding(typeobj):
    code = typeobj.GetTypeClass()
    size = typeobj.sizeof
    if code == lldb.eTypeClassBuiltin:
hjk's avatar
hjk committed
228
229
230
231
232
233
        name = str(typeobj)
        if name == "float":
            return Hex2EncodedFloat4
        if name == "double":
            return Hex2EncodedFloat8
        if name.find("unsigned") >= 0:
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
            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
252

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

257
258
        lldb.theDumper = self

259
        self.debugger = lldb.SBDebugger.Create()
260
        #self.debugger.SetLoggingCallback(loggingCallback)
261
262
263
264
265
266
        #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")
267
268
269
270
271
272
273
274
275
276

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

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

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

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

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

320
321
322
323
    def enterSubItem(self, item):
        if isinstance(item.name, lldb.SBValue):
            # Avoid $$__synth__ suffix on Mac.
            value = item.name
hjk's avatar
hjk committed
324
325
            if self.isGoodLldb:
                value.SetPreferSyntheticValue(False)
326
327
328
329
            item.name = value.GetName()
            if item.name is None:
                self.anonNumber += 1
                item.name = "#%d" % self.anonNumber
330
331
        if not item.iname:
            item.iname = "%s.%s" % (self.currentIName, item.name)
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
363
        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:
364
                    self.put('valueencoded="%s",' % self.currentValueEncoding)
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
                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
381
382
383
    def childWithName(self, value, name):
        child = value.GetChildMemberWithName(name)
        return child if child.IsValid() else None
384

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

388
389
390
391
392
393
394
395
396
    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()

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

402
403
404
405
406
407
408
    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)
409
        result = value.CreateValueFromExpression('', exp)
410
411
412
        #warn("  -> %s" % result)
        return result

413
414
415
416
417
418
419
420
421
422
    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

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

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

441
    def templateArgument(self, typeobj, index):
442
        type = typeobj.GetTemplateArgumentType(index)
hjk's avatar
hjk committed
443
        if type.IsValid():
444
445
446
447
448
449
450
            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)
451

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

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

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

462
463
464
        coreExpression = re.compile(r"(lib)?Qt5?Core")
        for n in range(0, self.target.GetNumModules()):
            module = self.target.GetModuleAtIndex(n)
465
466
            fileName = module.GetFileSpec().GetFilename()
            if coreExpression.match(fileName):
467
                # Extract version.
468
                reverseVersion = module.GetVersion()
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
                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")

485
486
487
488
489
490
491
492
493
494

                # 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
495
                break
496
497

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

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

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

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

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

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

522
523
    def charType(self):
        if self.charType_ is None:
hjk's avatar
hjk committed
524
             self.charType_ = self.target.FindFirstType('char')
525
526
527
528
529
530
531
532
        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
533
534
535
        if self.voidPtrType_ is None:
             self.voidPtrType_ = self.target.FindFirstType('void').GetPointerType()
        return self.voidPtrType_
536

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

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

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

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

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

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

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

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

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

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

580
581
582
583
584
585
586
    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
587
588
589
    def putSimpleValue(self, value, encoding = None, priority = 0):
        self.putValue(value.GetValue(), encoding, priority)

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

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

612
613
614
615
616
617
618
619
    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)

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

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

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

633
    def lookupType(self, name):
hjk's avatar
hjk committed
634
        #warn("LOOKUP TYPE NAME: %s" % name)
hjk's avatar
hjk committed
635
        if name.endswith('*'):
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
            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
656

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

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

669
670
        if self.platform_:
            self.debugger.SetCurrentPlatform(self.platform_)
Fawzi Mohamed's avatar
Fawzi Mohamed committed
671
672
673
        # sysroot has to be set *after* the platform
        if self.sysRoot_:
            self.debugger.SetCurrentPlatformSDKRoot(self.sysRoot_)
674
675
676
677
678

        if os.path.isfile(self.executable_):
            self.target = self.debugger.CreateTarget(self.executable_, None, None, True, error)
        else:
            self.target = self.debugger.CreateTarget(None, None, None, True, error)
679
680
        self.importDumpers()

681
682
        state = "inferiorsetupok" if self.target.IsValid() else "inferiorsetupfailed"
        self.report('state="%s",msg="%s",exe="%s"' % (state, error, self.executable_))
683

684
    def runEngine(self, _):
hjk's avatar
hjk committed
685
686
687
688
        s = threading.Thread(target=self.loop, args=[])
        s.start()

    def loop(self):
689
        error = lldb.SBError()
hjk's avatar
hjk committed
690
691
        listener = self.debugger.GetListener()

692
693
694
        if self.attachPid_ > 0:
            attachInfo = lldb.SBAttachInfo(self.attachPid_)
            self.process = self.target.Attach(attachInfo, error)
695
            if not error.Success():
Fawzi Mohamed's avatar
Fawzi Mohamed committed
696
697
698
                self.report('state="inferiorrunfailed"')
                return
            self.report('pid="%s"' % self.process.GetProcessID())
699
700
701
702
            # 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
703
704
705
706
        elif len(self.remoteChannel_) > 0:
            self.process = self.target.ConnectRemote(
            self.debugger.GetListener(),
            self.remoteChannel_, None, error)
707
708
709
            if not error.Success():
                self.report('state="inferiorrunfailed"')
                return
710
711
712
713
            # 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"')
714
        else:
715
            launchInfo = lldb.SBLaunchInfo(self.processArgs_)
716
            launchInfo.SetWorkingDirectory(os.getcwd())
717
718
            environmentList = [key + "=" + value for key,value in os.environ.items()]
            launchInfo.SetEnvironmentEntries(environmentList, False)
719
            self.process = self.target.Launch(launchInfo, error)
720
            if not error.Success():
721
722
                self.reportError(error)
                self.report('state="enginerunfailed"')
Fawzi Mohamed's avatar
Fawzi Mohamed committed
723
724
725
                return
            self.report('pid="%s"' % self.process.GetProcessID())
            self.report('state="enginerunandinferiorrunok"')
726

hjk's avatar
hjk committed
727
728
729
730
731
732
        event = lldb.SBEvent()
        while True:
            if listener.WaitForEvent(10000000, event):
                self.handleEvent(event)
            else:
                warn('TIMEOUT')
733

734
    def describeError(self, error):
735
736
737
738
739
        desc = lldb.SBStream()
        error.GetDescription(desc)
        result = 'error={type="%s"' % error.GetType()
        result += ',code="%s"' % error.GetError()
        result += ',desc="%s"}' % desc.GetData()
740
741
742
743
        return result

    def reportError(self, error):
        self.report(self.describeError(error))
hjk's avatar
hjk committed
744
745
        if error.GetType():
            self.reportStatus(error.GetCString())
746
747

    def currentThread(self):
748
        return None if self.process is None else self.process.GetSelectedThread()
749
750

    def currentFrame(self):
751
752
        thread = self.currentThread()
        return None if thread is None else thread.GetSelectedFrame()
753
754
755

    def reportLocation(self):
        thread = self.currentThread()
756
        frame = thread.GetSelectedFrame()
757
758
759
760
        file = fileName(frame.line_entry.file)
        line = frame.line_entry.line
        self.report('location={file="%s",line="%s",addr="%s"}' % (file, line, frame.pc))

761
762
763
    def firstStoppedThread(self):
        for i in xrange(0, self.process.GetNumThreads()):
            thread = self.process.GetThreadAtIndex(i)
764
765
766
767
768
769
            reason = thread.GetStopReason()
            if (reason == lldb.eStopReasonBreakpoint or
                    reason == lldb.eStopReasonException or
                    reason == lldb.eStopReasonPlanComplete or
                    reason == lldb.eStopReasonSignal or
                    reason == lldb.eStopReasonWatchpoint):
770
771
772
                return thread
        return None

773
    def reportThreads(self):
774
775
        reasons = ['None', 'Trace', 'Breakpoint', 'Watchpoint', 'Signal', 'Exception',
            'Exec', 'PlanComplete']
776
        result = 'threads={threads=['
777
        for i in xrange(0, self.process.GetNumThreads()):
778
            thread = self.process.GetThreadAtIndex(i)
779
            stopReason = thread.GetStopReason()
780
781
            result += '{id="%d"' % thread.GetThreadID()
            result += ',index="%s"' % i
782
            result += ',details="%s"' % thread.GetQueueName()
783
784
785
            result += ',stop-reason="%s"' % stopReason
            if stopReason >= 0 and stopReason < len(reasons):
                result += ',state="%s"' % reasons[stopReason]
786
            result += ',name="%s"' % thread.GetName()
787
788
789
790
791
            result += ',frame={'
            frame = thread.GetFrameAtIndex(0)
            result += 'pc="0x%x"' % frame.pc
            result += ',addr="0x%x"' % frame.pc
            result += ',fp="0x%x"' % frame.fp
792
            result += ',func="%s"' % frame.GetFunctionName()
793
794
795
796
797
798
799
800
            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)

801
    def firstUsableFrame(self, thread):
hjk's avatar
hjk committed
802
        for i in xrange(10):
hjk's avatar
hjk committed
803
804
805
806
807
808
809
            frame = thread.GetFrameAtIndex(i)
            lineEntry = frame.GetLineEntry()
            line = lineEntry.GetLine()
            if line != 0:
                return i
        return None

810
    def reportStack(self, args = {}):
811
        if not self.process:
812
            self.report('msg="No process"')
813
814
            return
        thread = self.currentThread()
815
        limit = args.get('stacklimit', -1)
816
817
818
819
820
821
        if not thread:
            self.report('msg="No thread"')
            return
        frame = thread.GetSelectedFrame()
        if frame:
            frameId = frame.GetFrameID()
822
        else:
823
            frameId = 0;
824
825
826

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

827
828
829
830
831
        result = 'stack={current-frame="%s"' % frameId
        result += ',current-thread="%s"' % thread.GetThreadID()
        result += ',frames=['
        for i in xrange(n):
            frame = thread.GetFrameAtIndex(i)
832
833
834
            if not frame.IsValid():
                isLimited = False
                break
835
836
837
838
839
840
841
842
843
844
845
            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)
846
847
848
849
        result += ']'
        result += ',hasmore="%d"' % isLimited
        result += ',limit="%d"' % limit
        result += '}'
850
        self.report(result)
851

852
853
854
855
856
    def putBetterType(self, type):
        try:
            self.currentType = type.GetName()
        except:
            self.currentType = str(type)
857
        self.currentTypePriority = self.currentTypePriority + 1
hjk's avatar
hjk committed
858
        #warn("BETTER TYPE: %s PRIORITY: %s" % (type, self.currentTypePriority))
hjk's avatar
hjk committed
859

hjk's avatar
hjk committed
860
    def extractBlob(self, base, size):
hjk's avatar
hjk committed
861
        if size == 0:
hjk's avatar
hjk committed
862
            return Blob("")
863
864
        base = int(base) & 0xFFFFFFFFFFFFFFFF
        size = int(size) & 0xFFFFFFFF
hjk's avatar
hjk committed
865
        error = lldb.SBError()
hjk's avatar
hjk committed
866
        return Blob(self.process.ReadMemory(base, size, error))
hjk's avatar
hjk committed
867

868
869
870
871
872
873
874
875
876
877
    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))

878
879
880
    def extractStaticMetaObjectHelper(self, typeobj):
        if typeobj.GetTypeClass() in (lldb.eTypeClassStruct, lldb.eTypeClassClass):
            needle = typeobj.GetUnqualifiedType().GetName() + "::staticMetaObject"
881
882
883
884
885
886
887
888
            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():
889
890
891
892
893
894
                result = 0
        else:
            result = 0
        self.knownStaticMetaObjects[typeobj.GetName()] = result
        return result

895
    def extractStaticMetaObject(self, typeobj):
hjk's avatar
hjk committed
896
897
        if not self.isGoodLldb:
            return 0
898
899
900
901
902
        result = self.extractStaticMetaObjectHelper(typeobj)
        if result:
            return result
        base = typeobj.GetDirectBaseClassAtIndex(0).GetType()
        return self.extractStaticMetaObjectHelper(base)
hjk's avatar
hjk committed
903

904
905
906
    def stripNamespaceFromType(self, typeName):
        #type = stripClassTag(typeName)
        type = typeName
907
908
909
        ns = self.qtNamespace()
        if len(ns) > 0 and type.startswith(ns):
            type = type[len(ns):]
910
911
912
913
914
915
        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
916
917
918
919
        if type.startswith("const "):
            type = type[6:]
        if type.startswith("volatile "):
            type = type[9:]
920
921
922
        return type

    def putSubItem(self, component, value, tryDynamic=True):
923
        if not value.IsValid():
924
            warn("INVALID SUBITEM: %s" % value.GetName())
925
            return
926
927
928
        with SubItem(self, component):
            self.putItem(value, tryDynamic)

hjk's avatar
hjk committed
929
    def putAddress(self, addr):
930
931
932
933
        #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
934

hjk's avatar
hjk committed
935
936
937
938
939
    def isFunctionType(self, typeobj):
        if self.isGoodLldb:
            return typeobj.IsFunctionType()
        #warn("TYPE: %s" % typeobj)
        return False
hjk's avatar
hjk committed
940

941
    def putItem(self, value, tryDynamic=True):
hjk's avatar
hjk committed
942
        #value = value.GetDynamicValue(lldb.eDynamicCanRunTarget)
943
        typeName = value.GetType().GetUnqualifiedType().GetName()
hjk's avatar
hjk committed
944
945
        if self.isGoodLldb:
            value.SetPreferDynamicValue(tryDynamic)
hjk's avatar
hjk committed
946
        typeClass = value.GetType().GetTypeClass()
947

hjk's avatar
hjk committed
948
        if tryDynamic:
949
            self.putAddress(value.GetLoadAddress())
hjk's avatar
hjk committed
950

951
        # Handle build-in LLDB visualizers if wanted.
952
        if False and self.useLldbDumpers and value.GetTypeSynthetic().IsValid():
953
954
955
956
            # FIXME: print "official" summary?
            summary = value.GetTypeSummary()
            if summary.IsValid():
                warn("DATA: %s" % summary.GetData())
hjk's avatar
hjk committed
957
958
            if self.isGoodLldb:
                value.SetPreferSyntheticValue(False)
959
960
961
962
963
            provider = value.GetTypeSynthetic()
            data = provider.GetData()
            formatter = eval(data)(value, {})
            formatter.update()
            numchild = formatter.num_children()
hjk's avatar
hjk committed
964
            self.put('iname="%s",' % self.currentIName)
hjk's avatar
hjk committed
965
            self.putType(typeName)
hjk's avatar
hjk committed
966
967
            self.put('numchild="%s",' % numchild)
            self.put('addr="0x%x",' % value.GetLoadAddress())
968
            self.putItemCount(numchild)
hjk's avatar
hjk committed
969
970
            if self.currentIName in self.expandedINames:
                with Children(self):
971
972
973
974
975
976
                    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
977
978
        # Typedefs
        if typeClass == lldb.eTypeClassTypedef:
979
            if typeName in self.qqDumpers:
hjk's avatar
hjk committed
980
981
                self.putType(typeName)
                self.context = value
982
                self.qqDumpers[typeName](self, value)
hjk's avatar
hjk committed
983
                return
hjk's avatar
hjk committed
984
985
            realType = value.GetType()
            if hasattr(realType, 'GetCanonicalType'):
986
987
988
989
                baseType = realType.GetCanonicalType()
                baseValue = value.Cast(baseType.unqualified())
                self.putItem(baseValue)
                self.putBetterType(realType)
hjk's avatar
hjk committed
990
                return
hjk's avatar
hjk committed
991

992
        # Our turf now.
hjk's avatar
hjk committed
993
994
        if self.isGoodLldb:
            value.SetPreferSyntheticValue(False)
995

996
        # Arrays
hjk's avatar
hjk committed
997
        if typeClass == lldb.eTypeClassArray:
998
            self.putCStyleArray(value)
999
1000
            return

1001
1002
        # Vectors like char __attribute__ ((vector_size (8)))
        if typeClass == lldb.eTypeClassVector:
1003
            self.putCStyleArray(value)
1004
1005
            return

1006
1007
        # References
        if value.GetType().IsReferenceType():
hjk's avatar
hjk committed
1008
            origType = value.GetTypeName();
hjk's avatar
hjk committed
1009
            type = value.GetType().GetDereferencedType().unqualified()
hjk's avatar
hjk committed
1010
            addr = int(value) & 0xFFFFFFFFFFFFFFFF
hjk's avatar
hjk committed
1011
            self.putItem(value.CreateValueFromAddress(None, addr, type))
hjk's avatar
hjk committed
1012
            self.putBetterType(origType)
1013
1014
            return

hjk's avatar
hjk committed
1015
        # Pointers
hjk's avatar
hjk committed
1016
        if value.GetType().IsPointerType():
hjk's avatar
hjk committed
1017
1018
            self.putFormattedPointer(value)
            return
hjk's avatar
hjk committed
1019

1020
        #warn("VALUE: %s" % value)
hjk's avatar
hjk committed
1021
1022
1023
1024
        #warn("FANCY: %s" % self.useFancy)
        if self.useFancy:
            stripped = self.stripNamespaceFromType(typeName).replace("::", "__")
            #warn("STRIPPED: %s" % stripped)
1025
1026
            #warn("DUMPABLE: %s" % (stripped in self.qqDumpers))
            if stripped in self.qqDumpers:
hjk's avatar
hjk committed
1027
                self.putType(typeName)
hjk's avatar
hjk committed
1028
                self.context = value
1029
                self.qqDumpers[stripped](self, value)
hjk's avatar
hjk committed
1030
                return
1031
1032
1033
1034

        # Normal value
        #numchild = 1 if value.MightHaveChildren() else 0
        numchild = value.GetNumChildren()
hjk's avatar
hjk committed
1035
        self.putType(typeName)
1036
1037
1038
1039
1040
        self.putEmptyValue(-1)
        staticMetaObject = self.extractStaticMetaObject(value.GetType())
        if staticMetaObject:
            self.context = value
            self.putQObjectNameValue(value)
hjk's avatar
hjk committed
1041
1042
1043
1044
1045
        else:
            v = value.GetValue()
            if v:
                self.putValue(v)

hjk's avatar