lldbbridge.py 58.3 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 binascii
32
import inspect
33
import json
34
import os
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
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
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)
    return value.GetChildMemberWithName(index)
187

188
189
190
191
192
193
194
def impl_SBValue__deref(value):
    result = value.Dereference()
    if result.IsValid():
        return result
    result = value.CreateValueFromExpression(None, '*' + value.get_expr_path())
    return result

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

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

274
        self.isLldb = True
275
276
277
278
        self.process = None
        self.target = None
        self.eventState = lldb.eStateInvalid
        self.expandedINames = {}
279
        self.passExceptions = False
280
        self.useLldbDumpers = False
hjk's avatar
hjk committed
281
        self.autoDerefPointers = True
282
        self.useDynamicType = True
hjk's avatar
hjk committed
283
        self.useFancy = True
hjk's avatar
hjk committed
284
285
286
        self.formats = {}
        self.typeformats = {}
        self.currentAddress = None
287
288
289
290
291
292

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

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

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

317
318
319
320
321
322
323
324
325
    def enterSubItem(self, item):
        if isinstance(item.name, lldb.SBValue):
            # Avoid $$__synth__ suffix on Mac.
            value = item.name
            value.SetPreferSyntheticValue(False)
            item.name = value.GetName()
            if item.name is None:
                self.anonNumber += 1
                item.name = "#%d" % self.anonNumber
326
327
        if not item.iname:
            item.iname = "%s.%s" % (self.currentIName, item.name)
328
329
330
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
        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.savedCurrentAddress = self.currentAddress
        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:
361
                    self.put('valueencoded="%s",' % self.currentValueEncoding)
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
                self.put('value="%s",' % self.currentValue)
        except:
            pass
        if not self.currentAddress is None:
            self.put(self.currentAddress)
        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
        self.currentAddress = item.savedCurrentAddress
        return True

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

381
382
383
    def hasChildWithName(self, value, name):
        return value.GetChildMemberWithName(name).IsValid()

384
385
386
387
388
389
390
391
392
    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()

393
394
395
396
397
    def enumExpression(self, enumType, enumValue):
        ns = self.qtNamespace()
        return ns + "Qt::" + enumType + "(" \
            + ns + "Qt::" + enumType + "::" + enumValue + ")"

398
399
400
401
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)
        result = value.CreateValueFromExpression('$tmp', exp)
        #warn("  -> %s" % result)
        return result

409
410
411
412
413
    def parseAndEvaluate(self, expr):
        thread = self.currentThread()
        frame = thread.GetFrameAtIndex(0)
        return frame.EvaluateExpression(expr)

414
415
416
417
418
419
420
421
422
423
424
425
426
    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)

427
    def templateArgument(self, typeobj, index):
428
        type = typeobj.GetTemplateArgumentType(index)
hjk's avatar
hjk committed
429
        if type.IsValid():
430
431
432
433
434
435
436
            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)
437

hjk's avatar
hjk committed
438
439
440
441
442
443
    def isReferenceType(self, typeobj):
        return typeobj.IsReferenceType()

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

444
445
    def qtVersionAndNamespace(self):
        self.cachedQtNamespace = ""
446
        self.cachedQtVersion = 0x0
447

448
449
450
        coreExpression = re.compile(r"(lib)?Qt5?Core")
        for n in range(0, self.target.GetNumModules()):
            module = self.target.GetModuleAtIndex(n)
451
452
            fileName = module.GetFileSpec().GetFilename()
            if coreExpression.match(fileName):
453
                # Extract version.
454
                reverseVersion = module.GetVersion()
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
                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")

471
472
473
474
475
476
477
478
479
480

                # 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
481
                break
482
483

        # Memoize good results.
484
        self.qtNamespace = lambda: self.cachedQtNamespace
485
        self.qtVersion = lambda: self.cachedQtVersion
486
487
488
489
490
491

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

    def qtVersion(self):
492
        self.qtVersionAndNamespace()
493
        return self.cachedQtVersion
494

hjk's avatar
hjk committed
495
496
497
    def intSize(self):
        return 4

498
499
    def intType(self):
        if self.intType_ is None:
hjk's avatar
hjk committed
500
             self.intType_ = self.target.FindFirstType('int')
501
502
        return self.intType_

503
504
505
506
507
    def int64Type(self):
        if self.int64Type_ is None:
             self.int64Type_ = self.target.FindFirstType('long long int')
        return self.int64Type_

508
509
    def charType(self):
        if self.charType_ is None:
hjk's avatar
hjk committed
510
             self.charType_ = self.target.FindFirstType('char')
511
512
513
514
515
516
517
518
        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
519
520
521
        if self.voidPtrType_ is None:
             self.voidPtrType_ = self.target.FindFirstType('void').GetPointerType()
        return self.voidPtrType_
522

hjk's avatar
hjk committed
523
    def ptrSize(self):
524
525
526
527
528
529
530
        return self.charPtrType().GetByteSize()

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

531
532
533
    def addressOf(self, value):
        return int(value.GetLoadAddress())

hjk's avatar
hjk committed
534
535
536
537
538
539
540
541
542
    def dereferenceValue(self, value):
        return long(value.Cast(self.voidPtrType()))

    def dereference(self, address):
        return long(self.createValue(address, self.voidPtrType()))

    def extractInt(self, address):
        return int(self.createValue(address, self.intType()))

543
544
545
    def extractInt64(self, address):
        return int(self.createValue(address, self.int64Type()))

546
547
548
    def extractByte(self, address):
        return int(self.createValue(address, self.charType())) & 0xFF

549
550
551
552
553
554
    def handleCommand(self, command):
        result = lldb.SBCommandReturnObject()
        self.debugger.GetCommandInterpreter().HandleCommand(command, result)
        success = result.Succeeded()
        if success:
            self.report('output="%s"' % result.GetOutput())
555
        else:
556
557
558
559
560
561
            self.report('error="%s"' % result.GetError())
        self.reportData()

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

562
    def isMovableType(self, type):
563
        if type.GetTypeClass() in (lldb.eTypeClassBuiltin, lldb.eTypeClassPointer):
564
            return True
565
        return self.isKnownMovableType(self.stripNamespaceFromType(type.GetName()))
566

567
568
    def putNumChild(self, numchild):
        #warn("NUM CHILD: '%s' '%s'" % (numchild, self.currentChildNumChild))
hjk's avatar
hjk committed
569
570
        #if numchild != self.currentChildNumChild:
        self.put('numchild="%s",' % numchild)
571

hjk's avatar
hjk committed
572
573
574
    def putSimpleValue(self, value, encoding = None, priority = 0):
        self.putValue(value.GetValue(), encoding, priority)

575
    def tryPutArrayContents(self, typeobj, base, n):
576
        if not self.isSimpleType(typeobj):
577
578
579
            return False
        size = n * typeobj.sizeof
        self.put('childtype="%s",' % typeobj)
580
581
        self.put('addrbase="0x%x",' % int(base))
        self.put('addrstep="%d",' % typeobj.sizeof)
582
583
        self.put('arrayencoding="%s",' % simpleEncoding(typeobj))
        self.put('arraydata="')
584
        self.put(self.readMemory(base, size))
585
586
587
588
589
590
        self.put('",')
        return True

    def putArrayData(self, type, base, n,
            childNumChild = None, maxNumChild = 10000):
        if not self.tryPutArrayContents(type, base, n):
591
            base = self.createPointerValue(base, type)
592
593
594
595
596
            with Children(self, n, type, childNumChild, maxNumChild,
                    base, type.GetByteSize()):
                for i in self.childRange():
                    self.putSubItem(i, (base + i).dereference())

597
598
599
    def parseAndEvalute(self, expr):
        return expr

600
601
602
603
604
605
606
607
    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)

608
    def putCallItem(self, name, value, func, *args):
609
        result = self.call2(value, func, args)
610
611
612
        with SubItem(self, name):
            self.putItem(result)

613
614
615
616
617
    def childRange(self):
        if self.currentMaxNumChild is None:
            return xrange(0, self.currentNumChild)
        return xrange(min(self.currentMaxNumChild, self.currentNumChild))

618
619
620
    def canonicalTypeName(self, name):
        return re.sub('\\bconst\\b', '', name).replace(' ', '')

621
    def lookupType(self, name):
hjk's avatar
hjk committed
622
        #warn("LOOKUP TYPE NAME: %s" % name)
hjk's avatar
hjk committed
623
        if name.endswith('*'):
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
            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
644

645
    def setupInferior(self, args):
646
        error = lldb.SBError()
647
648

        self.executable_ = args['executable']
649
650
651
        self.startMode_ = args.get('startMode', 1)
        self.processArgs_ = args.get('processArgs', '')
        self.attachPid_ = args.get('attachPid', 0)
Fawzi Mohamed's avatar
Fawzi Mohamed committed
652
        self.sysRoot_ = args.get('sysRoot', '')
Fawzi Mohamed's avatar
Fawzi Mohamed committed
653
        self.remoteChannel_ = args.get('remoteChannel', '')
654
        self.platform_ = args.get('platform', '')
655

656
657
        if self.platform_:
            self.debugger.SetCurrentPlatform(self.platform_)
Fawzi Mohamed's avatar
Fawzi Mohamed committed
658
659
660
        # sysroot has to be set *after* the platform
        if self.sysRoot_:
            self.debugger.SetCurrentPlatformSDKRoot(self.sysRoot_)
661
        self.target = self.debugger.CreateTarget(self.executable_, None, None, True, error)
662
663
        self.importDumpers()

664
665
        state = "inferiorsetupok" if self.target.IsValid() else "inferiorsetupfailed"
        self.report('state="%s",msg="%s",exe="%s"' % (state, error, self.executable_))
666

667
    def runEngine(self, _):
hjk's avatar
hjk committed
668
669
670
671
        s = threading.Thread(target=self.loop, args=[])
        s.start()

    def loop(self):
672
        error = lldb.SBError()
hjk's avatar
hjk committed
673
674
        listener = self.debugger.GetListener()

675
676
677
        if self.attachPid_ > 0:
            attachInfo = lldb.SBAttachInfo(self.attachPid_)
            self.process = self.target.Attach(attachInfo, error)
678
            if not error.Success():
Fawzi Mohamed's avatar
Fawzi Mohamed committed
679
680
681
                self.report('state="inferiorrunfailed"')
                return
            self.report('pid="%s"' % self.process.GetProcessID())
682
683
684
685
            # 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
686
687
688
689
        elif len(self.remoteChannel_) > 0:
            self.process = self.target.ConnectRemote(
            self.debugger.GetListener(),
            self.remoteChannel_, None, error)
690
691
692
            if not error.Success():
                self.report('state="inferiorrunfailed"')
                return
693
694
695
696
            # 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"')
697
        else:
698
            launchInfo = lldb.SBLaunchInfo(self.processArgs_.split())
699
            launchInfo.SetWorkingDirectory(os.getcwd())
700
701
            environmentList = [key + "=" + value for key,value in os.environ.items()]
            launchInfo.SetEnvironmentEntries(environmentList, False)
702
            self.process = self.target.Launch(launchInfo, error)
703
            if not error.Success():
704
705
                self.reportError(error)
                self.report('state="enginerunfailed"')
Fawzi Mohamed's avatar
Fawzi Mohamed committed
706
707
708
                return
            self.report('pid="%s"' % self.process.GetProcessID())
            self.report('state="enginerunandinferiorrunok"')
709

hjk's avatar
hjk committed
710
711
712
713
714
715
        event = lldb.SBEvent()
        while True:
            if listener.WaitForEvent(10000000, event):
                self.handleEvent(event)
            else:
                warn('TIMEOUT')
716

717
    def describeError(self, error):
718
719
720
721
722
723
        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()
724
725
726
727
        return result

    def reportError(self, error):
        self.report(self.describeError(error))
728
729

    def currentThread(self):
730
        return self.process.GetSelectedThread()
731
732
733
734
735
736

    def currentFrame(self):
        return self.currentThread().GetSelectedFrame()

    def reportLocation(self):
        thread = self.currentThread()
737
        frame = thread.GetSelectedFrame()
738
739
740
741
        file = fileName(frame.line_entry.file)
        line = frame.line_entry.line
        self.report('location={file="%s",line="%s",addr="%s"}' % (file, line, frame.pc))

742
743
744
    def firstStoppedThread(self):
        for i in xrange(0, self.process.GetNumThreads()):
            thread = self.process.GetThreadAtIndex(i)
745
746
747
748
749
750
            reason = thread.GetStopReason()
            if (reason == lldb.eStopReasonBreakpoint or
                    reason == lldb.eStopReasonException or
                    reason == lldb.eStopReasonPlanComplete or
                    reason == lldb.eStopReasonSignal or
                    reason == lldb.eStopReasonWatchpoint):
751
752
753
                return thread
        return None

754
    def reportThreads(self):
755
756
        reasons = ['None', 'Trace', 'Breakpoint', 'Watchpoint', 'Signal', 'Exception',
            'Exec', 'PlanComplete']
757
        result = 'threads={threads=['
758
        for i in xrange(0, self.process.GetNumThreads()):
759
            thread = self.process.GetThreadAtIndex(i)
760
            stopReason = thread.GetStopReason()
761
762
            result += '{id="%d"' % thread.GetThreadID()
            result += ',index="%s"' % i
763
            result += ',details="%s"' % thread.GetQueueName()
764
765
766
            result += ',stop-reason="%s"' % stopReason
            if stopReason >= 0 and stopReason < len(reasons):
                result += ',state="%s"' % reasons[stopReason]
767
            result += ',name="%s"' % thread.GetName()
768
769
770
771
772
            result += ',frame={'
            frame = thread.GetFrameAtIndex(0)
            result += 'pc="0x%x"' % frame.pc
            result += ',addr="0x%x"' % frame.pc
            result += ',fp="0x%x"' % frame.fp
773
            result += ',func="%s"' % frame.GetFunctionName()
774
775
776
777
778
779
780
781
            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)

782
    def firstUsableFrame(self, thread):
hjk's avatar
hjk committed
783
        for i in xrange(10):
hjk's avatar
hjk committed
784
785
786
787
788
789
790
            frame = thread.GetFrameAtIndex(i)
            lineEntry = frame.GetLineEntry()
            line = lineEntry.GetLine()
            if line != 0:
                return i
        return None

hjk's avatar
hjk committed
791
    def reportStack(self, _ = None):
792
        if not self.process:
793
            self.report('msg="No process"')
794
795
796
797
798
799
800
801
            return
        thread = self.currentThread()
        if not thread:
            self.report('msg="No thread"')
            return
        frame = thread.GetSelectedFrame()
        if frame:
            frameId = frame.GetFrameID()
802
        else:
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
            frameId = 0;
        result = 'stack={current-frame="%s"' % frameId
        result += ',current-thread="%s"' % thread.GetThreadID()
        result += ',frames=['
        n = thread.GetNumFrames()
        for i in xrange(n):
            frame = thread.GetFrameAtIndex(i)
            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)
        result += '],hasmore="0"},'
        self.report(result)
823

824
825
826
827
828
    def putBetterType(self, type):
        try:
            self.currentType = type.GetName()
        except:
            self.currentType = str(type)
829
        self.currentTypePriority = self.currentTypePriority + 1
hjk's avatar
hjk committed
830
        #warn("BETTER TYPE: %s PRIORITY: %s" % (type, self.currentTypePriority))
hjk's avatar
hjk committed
831

832
    def readMemory(self, base, size):
hjk's avatar
hjk committed
833
834
        if size == 0:
            return ""
835
836
        base = int(base) & 0xFFFFFFFFFFFFFFFF
        size = int(size) & 0xFFFFFFFF
hjk's avatar
hjk committed
837
        error = lldb.SBError()
838
        contents = self.process.ReadMemory(base, size, error)
hjk's avatar
hjk committed
839
840
        return binascii.hexlify(contents)

hjk's avatar
hjk committed
841
842
843
844
845
846
847
848
849
850
851
    def isQObject(self, value):
        try:
            vtable = value.Cast(self.voidPtrType().GetPointerType())
            metaObjectEntry = vtable.Dereference()
            addr = lldb.SBAddress(long(metaObjectEntry), self.target)
            symbol = addr.GetSymbol()
            name = symbol.GetMangledName()
            return name.find("10metaObjectEv") > 0
        except:
            return False

852
853
854
    def stripNamespaceFromType(self, typeName):
        #type = stripClassTag(typeName)
        type = typeName
855
856
857
        ns = self.qtNamespace()
        if len(ns) > 0 and type.startswith(ns):
            type = type[len(ns):]
858
859
860
861
862
863
        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
864
865
866
867
        if type.startswith("const "):
            type = type[6:]
        if type.startswith("volatile "):
            type = type[9:]
868
869
870
        return type

    def putSubItem(self, component, value, tryDynamic=True):
871
        if not value.IsValid():
hjk's avatar
hjk committed
872
            warn("INVALID SUBITEM")
873
            return
874
875
876
        with SubItem(self, component):
            self.putItem(value, tryDynamic)

hjk's avatar
hjk committed
877
878
879
880
881
882
883
    def putAddress(self, addr):
        if self.currentPrintsAddress:
            try:
                self.currentAddress = 'addr="0x%s",' % int(addr)
            except:
                pass

hjk's avatar
hjk committed
884
885
886
    def isFunctionType(self, type):
        return type.IsFunctionType()

887
    def putItem(self, value, tryDynamic=True):
hjk's avatar
hjk committed
888
        #value = value.GetDynamicValue(lldb.eDynamicCanRunTarget)
889
        typeName = value.GetType().GetUnqualifiedType().GetName()
890
        value.SetPreferDynamicValue(tryDynamic)
hjk's avatar
hjk committed
891
        typeClass = value.GetType().GetTypeClass()
892

hjk's avatar
hjk committed
893
894
895
        if tryDynamic:
            self.putAddress(value.address)

896
        # Handle build-in LLDB visualizers if wanted.
897
        if self.useLldbDumpers and value.GetTypeSynthetic().IsValid():
898
899
900
901
902
903
904
905
906
907
            # FIXME: print "official" summary?
            summary = value.GetTypeSummary()
            if summary.IsValid():
                warn("DATA: %s" % summary.GetData())
            value.SetPreferSyntheticValue(False)
            provider = value.GetTypeSynthetic()
            data = provider.GetData()
            formatter = eval(data)(value, {})
            formatter.update()
            numchild = formatter.num_children()
hjk's avatar
hjk committed
908
            self.put('iname="%s",' % self.currentIName)
hjk's avatar
hjk committed
909
            self.putType(typeName)
hjk's avatar
hjk committed
910
911
            self.put('numchild="%s",' % numchild)
            self.put('addr="0x%x",' % value.GetLoadAddress())
912
            self.putItemCount(numchild)
hjk's avatar
hjk committed
913
914
            if self.currentIName in self.expandedINames:
                with Children(self):
915
916
917
918
919
920
                    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
921
922
        # Typedefs
        if typeClass == lldb.eTypeClassTypedef:
923
            if typeName in self.qqDumpers:
hjk's avatar
hjk committed
924
925
                self.putType(typeName)
                self.context = value
926
                self.qqDumpers[typeName](self, value)
hjk's avatar
hjk committed
927
                return
hjk's avatar
hjk committed
928
929
            realType = value.GetType()
            if hasattr(realType, 'GetCanonicalType'):
930
931
932
933
                baseType = realType.GetCanonicalType()
                baseValue = value.Cast(baseType.unqualified())
                self.putItem(baseValue)
                self.putBetterType(realType)
hjk's avatar
hjk committed
934
                return
hjk's avatar
hjk committed
935

936
        # Our turf now.
937
        value.SetPreferSyntheticValue(False)
938

939
        # Arrays
hjk's avatar
hjk committed
940
        if typeClass == lldb.eTypeClassArray:
941
            self.putCStyleArray(value)
942
943
            return

944
945
        # Vectors like char __attribute__ ((vector_size (8)))
        if typeClass == lldb.eTypeClassVector:
946
            self.putCStyleArray(value)
947
948
            return

949
950
        # References
        if value.GetType().IsReferenceType():
hjk's avatar
hjk committed
951
            origType = value.GetTypeName();
hjk's avatar
hjk committed
952
            type = value.GetType().GetDereferencedType().unqualified()
hjk's avatar
hjk committed
953
            addr = int(value) & 0xFFFFFFFFFFFFFFFF
hjk's avatar
hjk committed
954
            self.putItem(value.CreateValueFromAddress(None, addr, type))
hjk's avatar
hjk committed
955
            #self.putItem(value.CreateValueFromData(None, value.GetData(), type))
hjk's avatar
hjk committed
956
            self.putBetterType(origType)
957
958
            return

hjk's avatar
hjk committed
959
        # Pointers
hjk's avatar
hjk committed
960
        if value.GetType().IsPointerType():
hjk's avatar
hjk committed
961
962
            self.putFormattedPointer(value)
            return
hjk's avatar
hjk committed
963

964
        #warn("VALUE: %s" % value)
hjk's avatar
hjk committed
965
966
967
968
        #warn("FANCY: %s" % self.useFancy)
        if self.useFancy:
            stripped = self.stripNamespaceFromType(typeName).replace("::", "__")
            #warn("STRIPPED: %s" % stripped)
969
970
            #warn("DUMPABLE: %s" % (stripped in self.qqDumpers))
            if stripped in self.qqDumpers:
hjk's avatar
hjk committed
971
                self.putType(typeName)
hjk's avatar
hjk committed
972
                self.context = value
973
                self.qqDumpers[stripped](self, value)
hjk's avatar
hjk committed
974
                return
975
976
977
978

        # Normal value
        #numchild = 1 if value.MightHaveChildren() else 0
        numchild = value.GetNumChildren()
hjk's avatar
hjk committed
979
        self.putType(typeName)
hjk's avatar
hjk committed
980
981
982
983
984
985
986
987
988
989
990
991
992
993
        if typeClass == lldb.eTypeClassStruct or typeClass == lldb.eTypeClassClass:
            if self.isQObject(value):
                self.context = value
                if not self.putQObjectNameValue(value):  # Is this too expensive?
                    self.putEmptyValue()
            else:
                self.putEmptyValue()
        else:
            v = value.GetValue()
            if v:
                self.putValue(v)
            else:
                self.putEmptyValue()

994
995
996
997
998
        self.put('numchild="%s",' % numchild)
        self.put('addr="0x%x",' % value.GetLoadAddress())
        if self.currentIName in self.expandedINames:
            with Children(self):
                self.putFields(value)
999
1000

    def putFields(self, value):
1001
1002
1003
1004
        # Suppress printing of 'name' field for arrays.
        if value.GetType().GetTypeClass() == lldb.eTypeClassArray:
            for i in xrange(value.GetNumChildren()):
                child = value.GetChildAtIndex(i)
1005
                with UnnamedSubItem(self, str(i)):
1006
1007
1008
                    self.putItem(child)
            return

1009
        n = value.GetNumChildren()
1010
        m = value.GetType().GetNumberOfDirectBaseClasses()
1011
1012
        if n > 10000:
            n = 10000
1013
1014
1015
        # seems to happen in the 'inheritance' autotest
        if m > n:
            m = n
1016
1017
1018
        for i in xrange(m):
            child = value.GetChildAtIndex(i)
            with UnnamedSubItem(self, "@%d" % (i + 1)):
1019
                self.put('iname="%s",' % self.currentIName)
1020
1021
1022
                self.put('name="[%s]",' % child.name)
                self.putItem(child)
        for i in xrange(m, n):
hjk's avatar
hjk committed
1023
            child = value.GetChildAtIndex(i)
hjk's avatar
hjk committed
1024
1025
1026
            if child.IsValid():  # FIXME: Anon members?
                with SubItem(self, child):
                    self.putItem(child)
1027

hjk's avatar
hjk committed
1028
    def reportVariables(self, _ = None):
1029
        frame = self.currentThread().GetSelectedFrame()
1030
        self.currentIName = 'local'
1031
        self.put('data=[')
1032
        self.anonNumber = 0
1033
        shadowed = {}
1034
1035
        ids = {} # Filter out duplicates entries at the same address.
        values = list(frame.GetVariables(True, True, True, False))
1036
1037
        values.reverse() # To get shadowed vars numbered backwards.
        for value in values:
1038
1039
1040
1041
1042
1043
1044
            if not value.IsValid():
                continue
            name = value.GetName()
            id = "%s:0x%x" % (name, value.GetAddress())
            if id in ids:
                continue
            ids[id] = True
1045
1046
            if self.dummyValue is None:
                self.dummyValue = value
1047
1048
1049
            if name is None:
                warn("NO NAME FOR VALUE: %s" % value)
                continue
1050
            if name in shadowed:
1051
1052
1053
1054
1055
1056
1057
1058
                level = shadowed[name]
                shadowed[name] = level + 1
                name += "@%s" % level
            else:
                shadowed[name] = 1
            with SubItem(self, name):
                self.put('iname="%s",' % self.currentIName)
                self.putItem(value)
1059
1060
1061
1062
1063

        # 'watchers':[{'id':'watch.0','exp':'23'},...]
        if not self.dummyValue is None:
            for watcher in self.currentWatchers:
                iname = watcher['iname']
1064
1065
                # could be 'watch.0' or 'tooltip.deadbead'
                (base, component) = iname.split('.')
1066
1067
1068
1069
1070
1071
                exp = binascii.unhexlify(watcher['exp'])
                if exp == "":
                    self.put('type="",value="",exp=""')
                    continue

                value = self.dummyValue.CreateValueFromExpression(iname, exp)
1072
1073
                self.currentIName = base
                with SubItem(self, component):
1074
1075
                    self.put('exp="%s",' % exp)
                    self.put('wname="%s",' % binascii.hexlify(exp))