lldbbridge.py 59.8 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
def impl_SBValue__getitem__(value, index):
    if isinstance(index, int):
        type = value.GetType()
        if type.IsPointerType():
            innertype = value.Dereference().GetType()
            address = value.GetValueAsUnsigned() + index * innertype.GetByteSize()
            address = address & 0xFFFFFFFFFFFFFFFF  # Force unsigned
            return value.CreateValueFromAddress(None, address, innertype)
        return value.GetChildAtIndex(index)
186
187
188
189
190
191
192
193
194
195
    result = value.GetChildMemberWithName(index)
    if int(result.GetLoadAddress()) == 0xffffffffffffffff:
        options = lldb.SBExpressionOptions()
        typeClass = child.GetType().GetTypeClass()
        if typeClass != lldb.eTypeClassBuiltin:
            i = value.GetIndexOfChildWithName(index)
            field = value.GetType().GetFieldAtIndex(i)
            addr = value.GetLoadAddress() + field.GetOffsetInBytes()
            child = value.CreateValueFromAddress(child.GetName(), addr, child.GetType())
    return result
196

197
198
199
200
def impl_SBValue__deref(value):
    result = value.Dereference()
    if result.IsValid():
        return result
201
202
203
    #warn("RESULT.LOADADDRESS A: 0x%x" % result.GetLoadAddress())
    result = value.CreateValueFromAddress(None, value.GetValueAsUnsigned(), value.GetType().GetPointerType())
    #warn("RESULT.LOADADDRESS B: 0x%x" % result.GetLoadAddress())
204
205
    return result

206
lldb.SBValue.__add__ = impl_SBValue__add__
207
lldb.SBValue.__sub__ = impl_SBValue__sub__
208
lldb.SBValue.__le__ = impl_SBValue__le__
209

210
211
lldb.SBValue.__getitem__ = impl_SBValue__getitem__
lldb.SBValue.__int__ = impl_SBValue__int__
212
lldb.SBValue.__float__ = impl_SBValue__float__
213
214
lldb.SBValue.__long__ = lambda self: long(self.GetValue(), 0)

215
lldb.SBValue.code = lambda self: self.GetTypeClass()
216
lldb.SBValue.cast = lambda self, typeObj: self.Cast(typeObj)
217
lldb.SBValue.dereference = impl_SBValue__deref
218
lldb.SBValue.address = property(lambda self: self.GetLoadAddress())
219
220

lldb.SBType.pointer = lambda self: self.GetPointerType()
hjk's avatar
hjk committed
221
lldb.SBType.target = lambda self: self.GetPointeeType()
222
lldb.SBType.code = lambda self: self.GetTypeClass()
223
lldb.SBType.sizeof = property(lambda self: self.GetByteSize())
224
225


hjk's avatar
hjk committed
226
227
lldb.SBType.unqualified = \
    lambda self: self.GetUnqualifiedType() if hasattr(self, 'GetUnqualifiedType') else self
228
229
lldb.SBType.strip_typedefs = \
    lambda self: self.GetCanonicalType() if hasattr(self, 'GetCanonicalType') else self
230

hjk's avatar
hjk committed
231
232
233
lldb.SBType.__orig__str__ = lldb.SBType.__str__
lldb.SBType.__str__ = lldb.SBType.GetName

234
235
236
237
def simpleEncoding(typeobj):
    code = typeobj.GetTypeClass()
    size = typeobj.sizeof
    if code == lldb.eTypeClassBuiltin:
hjk's avatar
hjk committed
238
239
240
241
242
243
        name = str(typeobj)
        if name == "float":
            return Hex2EncodedFloat4
        if name == "double":
            return Hex2EncodedFloat8
        if name.find("unsigned") >= 0:
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
            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
262

263
class Dumper(DumperBase):
264
    def __init__(self):
265
266
        DumperBase.__init__(self)

267
        self.debugger = lldb.SBDebugger.Create()
268
        #self.debugger.SetLoggingCallback(loggingCallback)
269
270
271
272
273
274
        #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")
275
276
277
278
279
280
281
282
283
284

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

285
        self.isLldb = True
286
287
288
289
        self.process = None
        self.target = None
        self.eventState = lldb.eStateInvalid
        self.expandedINames = {}
290
        self.passExceptions = False
291
        self.useLldbDumpers = False
hjk's avatar
hjk committed
292
        self.autoDerefPointers = True
293
        self.useDynamicType = True
hjk's avatar
hjk committed
294
        self.useFancy = True
hjk's avatar
hjk committed
295
296
        self.formats = {}
        self.typeformats = {}
297
298
299
300
301
302

        self.currentIName = None
        self.currentValuePriority = -100
        self.currentValueEncoding = None
        self.currentType = ""
        self.currentTypePriority = -100
303
        self.currentValue = None
304
305
306
307
308
        self.currentNumChild = None
        self.currentMaxNumChild = None
        self.currentPrintsAddress = None
        self.currentChildType = None
        self.currentChildNumChild = None
309
        self.currentWatchers = {}
310

hjk's avatar
hjk committed
311
        self.executable_ = None
312
313
314
315
        self.startMode_ = None
        self.processArgs_ = None
        self.attachPid_ = None

316
317
        self.charType_ = None
        self.intType_ = None
318
        self.int64Type_ = None
319
320
        self.sizetType_ = None
        self.charPtrType_ = None
hjk's avatar
hjk committed
321
        self.voidPtrType_ = None
322
        self.isShuttingDown_ = False
323
        self.isInterrupting_ = False
324
        self.dummyValue = None
325
        self.types_ = {}
326

327
328
329
330
331
332
333
334
335
    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
336
337
        if not item.iname:
            item.iname = "%s.%s" % (self.currentIName, item.name)
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
364
365
366
367
368
369
        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:
370
                    self.put('valueencoded="%s",' % self.currentValueEncoding)
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
                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
387
388
389
    def childWithName(self, value, name):
        child = value.GetChildMemberWithName(name)
        return child if child.IsValid() else None
390

391
392
393
394
395
396
397
398
399
    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()

400
401
402
403
404
    def enumExpression(self, enumType, enumValue):
        ns = self.qtNamespace()
        return ns + "Qt::" + enumType + "(" \
            + ns + "Qt::" + enumType + "::" + enumValue + ")"

405
406
407
408
409
410
411
412
413
414
415
    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

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

426
427
428
429
430
    def parseAndEvaluate(self, expr):
        thread = self.currentThread()
        frame = thread.GetFrameAtIndex(0)
        return frame.EvaluateExpression(expr)

431
432
433
434
435
436
437
438
439
440
441
442
443
    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)

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

hjk's avatar
hjk committed
455
456
457
458
459
460
    def isReferenceType(self, typeobj):
        return typeobj.IsReferenceType()

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

461
462
    def qtVersionAndNamespace(self):
        self.cachedQtNamespace = ""
463
        self.cachedQtVersion = 0x0
464

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

488
489
490
491
492
493
494
495
496
497

                # 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
498
                break
499
500

        # Memoize good results.
501
        self.qtNamespace = lambda: self.cachedQtNamespace
502
        self.qtVersion = lambda: self.cachedQtVersion
503
504
505
506
507
508

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

    def qtVersion(self):
509
        self.qtVersionAndNamespace()
510
        return self.cachedQtVersion
511

hjk's avatar
hjk committed
512
513
514
    def intSize(self):
        return 4

515
516
    def intType(self):
        if self.intType_ is None:
hjk's avatar
hjk committed
517
             self.intType_ = self.target.FindFirstType('int')
518
519
        return self.intType_

520
521
522
523
524
    def int64Type(self):
        if self.int64Type_ is None:
             self.int64Type_ = self.target.FindFirstType('long long int')
        return self.int64Type_

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

hjk's avatar
hjk committed
540
    def ptrSize(self):
541
542
543
544
545
546
547
        return self.charPtrType().GetByteSize()

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

548
549
550
    def addressOf(self, value):
        return int(value.GetLoadAddress())

hjk's avatar
hjk committed
551
552
553
554
555
556
557
558
559
    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()))

560
561
562
    def extractInt64(self, address):
        return int(self.createValue(address, self.int64Type()))

563
564
565
    def extractByte(self, address):
        return int(self.createValue(address, self.charType())) & 0xFF

566
567
568
569
570
571
    def handleCommand(self, command):
        result = lldb.SBCommandReturnObject()
        self.debugger.GetCommandInterpreter().HandleCommand(command, result)
        success = result.Succeeded()
        if success:
            self.report('output="%s"' % result.GetOutput())
572
        else:
573
574
575
576
577
578
            self.report('error="%s"' % result.GetError())
        self.reportData()

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

579
    def isMovableType(self, type):
580
        if type.GetTypeClass() in (lldb.eTypeClassBuiltin, lldb.eTypeClassPointer):
581
            return True
582
        return self.isKnownMovableType(self.stripNamespaceFromType(type.GetName()))
583

584
585
    def putNumChild(self, numchild):
        #warn("NUM CHILD: '%s' '%s'" % (numchild, self.currentChildNumChild))
hjk's avatar
hjk committed
586
587
        #if numchild != self.currentChildNumChild:
        self.put('numchild="%s",' % numchild)
588

589
590
591
592
593
594
595
    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
596
597
598
    def putSimpleValue(self, value, encoding = None, priority = 0):
        self.putValue(value.GetValue(), encoding, priority)

599
    def tryPutArrayContents(self, typeobj, base, n):
600
        if not self.isSimpleType(typeobj):
601
602
603
            return False
        size = n * typeobj.sizeof
        self.put('childtype="%s",' % typeobj)
604
605
        self.put('addrbase="0x%x",' % int(base))
        self.put('addrstep="%d",' % typeobj.sizeof)
606
607
        self.put('arrayencoding="%s",' % simpleEncoding(typeobj))
        self.put('arraydata="')
608
        self.put(self.readMemory(base, size))
609
610
611
612
613
614
        self.put('",')
        return True

    def putArrayData(self, type, base, n,
            childNumChild = None, maxNumChild = 10000):
        if not self.tryPutArrayContents(type, base, n):
615
            base = self.createPointerValue(base, type)
616
617
618
619
620
            with Children(self, n, type, childNumChild, maxNumChild,
                    base, type.GetByteSize()):
                for i in self.childRange():
                    self.putSubItem(i, (base + i).dereference())

621
622
623
624
625
626
627
628
    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)

629
    def putCallItem(self, name, value, func, *args):
630
        result = self.call2(value, func, args)
631
632
633
        with SubItem(self, name):
            self.putItem(result)

634
635
636
637
638
    def childRange(self):
        if self.currentMaxNumChild is None:
            return xrange(0, self.currentNumChild)
        return xrange(min(self.currentMaxNumChild, self.currentNumChild))

639
640
641
    def canonicalTypeName(self, name):
        return re.sub('\\bconst\\b', '', name).replace(' ', '')

642
    def lookupType(self, name):
hjk's avatar
hjk committed
643
        #warn("LOOKUP TYPE NAME: %s" % name)
hjk's avatar
hjk committed
644
        if name.endswith('*'):
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
            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
665

666
    def setupInferior(self, args):
667
        error = lldb.SBError()
668
669

        self.executable_ = args['executable']
670
671
672
        self.startMode_ = args.get('startMode', 1)
        self.processArgs_ = args.get('processArgs', '')
        self.attachPid_ = args.get('attachPid', 0)
Fawzi Mohamed's avatar
Fawzi Mohamed committed
673
        self.sysRoot_ = args.get('sysRoot', '')
Fawzi Mohamed's avatar
Fawzi Mohamed committed
674
        self.remoteChannel_ = args.get('remoteChannel', '')
675
        self.platform_ = args.get('platform', '')
676

677
678
        if self.platform_:
            self.debugger.SetCurrentPlatform(self.platform_)
Fawzi Mohamed's avatar
Fawzi Mohamed committed
679
680
681
        # sysroot has to be set *after* the platform
        if self.sysRoot_:
            self.debugger.SetCurrentPlatformSDKRoot(self.sysRoot_)
682
        self.target = self.debugger.CreateTarget(self.executable_, None, None, True, error)
683
684
        self.importDumpers()

685
686
        state = "inferiorsetupok" if self.target.IsValid() else "inferiorsetupfailed"
        self.report('state="%s",msg="%s",exe="%s"' % (state, error, self.executable_))
687

688
    def runEngine(self, _):
hjk's avatar
hjk committed
689
690
691
692
        s = threading.Thread(target=self.loop, args=[])
        s.start()

    def loop(self):
693
        error = lldb.SBError()
hjk's avatar
hjk committed
694
695
        listener = self.debugger.GetListener()

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

hjk's avatar
hjk committed
731
732
733
734
735
736
        event = lldb.SBEvent()
        while True:
            if listener.WaitForEvent(10000000, event):
                self.handleEvent(event)
            else:
                warn('TIMEOUT')
737

738
    def describeError(self, error):
739
740
741
742
743
744
        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()
745
746
747
748
        return result

    def reportError(self, error):
        self.report(self.describeError(error))
749
750

    def currentThread(self):
751
        return self.process.GetSelectedThread()
752
753
754
755
756
757

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

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

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

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

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

hjk's avatar
hjk committed
812
    def reportStack(self, _ = None):
813
        if not self.process:
814
            self.report('msg="No process"')
815
816
817
818
819
820
821
822
            return
        thread = self.currentThread()
        if not thread:
            self.report('msg="No thread"')
            return
        frame = thread.GetSelectedFrame()
        if frame:
            frameId = frame.GetFrameID()
823
        else:
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
            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)
844

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

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

hjk's avatar
hjk committed
862
863
864
865
866
867
868
869
870
871
872
    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

873
874
875
    def stripNamespaceFromType(self, typeName):
        #type = stripClassTag(typeName)
        type = typeName
876
877
878
        ns = self.qtNamespace()
        if len(ns) > 0 and type.startswith(ns):
            type = type[len(ns):]
879
880
881
882
883
884
        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
885
886
887
888
        if type.startswith("const "):
            type = type[6:]
        if type.startswith("volatile "):
            type = type[9:]
889
890
891
        return type

    def putSubItem(self, component, value, tryDynamic=True):
892
        if not value.IsValid():
hjk's avatar
hjk committed
893
            warn("INVALID SUBITEM")
894
            return
895
896
897
        with SubItem(self, component):
            self.putItem(value, tryDynamic)

hjk's avatar
hjk committed
898
    def putAddress(self, addr):
899
900
901
902
        #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
903

hjk's avatar
hjk committed
904
905
906
    def isFunctionType(self, type):
        return type.IsFunctionType()

907
    def putItem(self, value, tryDynamic=True):
hjk's avatar
hjk committed
908
        #value = value.GetDynamicValue(lldb.eDynamicCanRunTarget)
909
        typeName = value.GetType().GetUnqualifiedType().GetName()
910
        value.SetPreferDynamicValue(tryDynamic)
hjk's avatar
hjk committed
911
        typeClass = value.GetType().GetTypeClass()
912

hjk's avatar
hjk committed
913
        if tryDynamic:
914
            self.putAddress(value.GetLoadAddress())
hjk's avatar
hjk committed
915

916
        # Handle build-in LLDB visualizers if wanted.
917
        if False and self.useLldbDumpers and value.GetTypeSynthetic().IsValid():
918
919
920
921
922
923
924
925
926
927
            # 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
928
            self.put('iname="%s",' % self.currentIName)
hjk's avatar
hjk committed
929
            self.putType(typeName)
hjk's avatar
hjk committed
930
931
            self.put('numchild="%s",' % numchild)
            self.put('addr="0x%x",' % value.GetLoadAddress())
932
            self.putItemCount(numchild)
hjk's avatar
hjk committed
933
934
            if self.currentIName in self.expandedINames:
                with Children(self):
935
936
937
938
939
940
                    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
941
942
        # Typedefs
        if typeClass == lldb.eTypeClassTypedef:
943
            if typeName in self.qqDumpers:
hjk's avatar
hjk committed
944
945
                self.putType(typeName)
                self.context = value
946
                self.qqDumpers[typeName](self, value)
hjk's avatar
hjk committed
947
                return
hjk's avatar
hjk committed
948
949
            realType = value.GetType()
            if hasattr(realType, 'GetCanonicalType'):
950
951
952
953
                baseType = realType.GetCanonicalType()
                baseValue = value.Cast(baseType.unqualified())
                self.putItem(baseValue)
                self.putBetterType(realType)
hjk's avatar
hjk committed
954
                return
hjk's avatar
hjk committed
955

956
        # Our turf now.
957
        value.SetPreferSyntheticValue(False)
958

959
        # Arrays
hjk's avatar
hjk committed
960
        if typeClass == lldb.eTypeClassArray:
961
            self.putCStyleArray(value)
962
963
            return

964
965
        # Vectors like char __attribute__ ((vector_size (8)))
        if typeClass == lldb.eTypeClassVector:
966
            self.putCStyleArray(value)
967
968
            return

969
970
        # References
        if value.GetType().IsReferenceType():
hjk's avatar
hjk committed
971
            origType = value.GetTypeName();
hjk's avatar
hjk committed
972
            type = value.GetType().GetDereferencedType().unqualified()
hjk's avatar
hjk committed
973
            addr = int(value) & 0xFFFFFFFFFFFFFFFF
hjk's avatar
hjk committed
974
            self.putItem(value.CreateValueFromAddress(None, addr, type))
hjk's avatar
hjk committed
975
            self.putBetterType(origType)
976
977
            return

hjk's avatar
hjk committed
978
        # Pointers
hjk's avatar
hjk committed
979
        if value.GetType().IsPointerType():
hjk's avatar
hjk committed
980
981
            self.putFormattedPointer(value)
            return
hjk's avatar
hjk committed
982

983
        #warn("VALUE: %s" % value)
hjk's avatar
hjk committed
984
985
986
987
        #warn("FANCY: %s" % self.useFancy)
        if self.useFancy:
            stripped = self.stripNamespaceFromType(typeName).replace("::", "__")
            #warn("STRIPPED: %s" % stripped)
988
989
            #warn("DUMPABLE: %s" % (stripped in self.qqDumpers))
            if stripped in self.qqDumpers:
hjk's avatar
hjk committed
990
                self.putType(typeName)
hjk's avatar
hjk committed
991
                self.context = value
992
                self.qqDumpers[stripped](self, value)
hjk's avatar
hjk committed
993
                return
994
995
996
997

        # Normal value
        #numchild = 1 if value.MightHaveChildren() else 0
        numchild = value.GetNumChildren()
hjk's avatar
hjk committed
998
        self.putType(typeName)
hjk's avatar
hjk committed
999
1000
        if typeClass == lldb.eTypeClassStruct or typeClass == lldb.eTypeClassClass:
            if self.isQObject(value):
For faster browsing, not all history is shown. View entire blame