1. 自定義LLDB命令 Value和內(nèi)存

1.1 內(nèi)存布局

為了真正理解SBValue類的強(qiáng)大功能僵朗，我們將探索分配器應(yīng)用程序中三個(gè)對(duì)象的內(nèi)存布局。從一個(gè)Objective-C類開(kāi)始，然后探索一個(gè)沒(méi)有超類的Swift類保檐，最后探索一個(gè)繼承自NSObject的Swift類。

這三個(gè)類都有三個(gè)屬性，其順序如下：

• 名為eyeColor的UIColor街夭。
• 名為firstName的字符串（string/NSString）。
• 名為lastName的字符串（string/NSString）躏筏。

這些類的每個(gè)實(shí)例都使用相同的值初始化：

• eyeColor是UIColor.brown或[UIColor brownColor]板丽。
• firstName是"Derek"或@"Derek"。
• lastName為"Selander"或@"Selander"趁尼。

Objective-C內(nèi)存布局

@interface DSObjectiveCObject : NSObject
@property (nonatomic, strong) UIColor *eyeColor;
@property (nonatomic, strong) NSString *firstName;
@property (nonatomic, strong) NSString *lastName;
@end

@implementation DSObjectiveCObject
- (instancetype)init
{
  self = [super init];
  if (self) {
    self.eyeColor = [UIColor brownColor];
    self.firstName = @"Derek";
    self.lastName = @"Selander";
  }
  return self;
}
@end

編譯后埃碱，這個(gè)Objective-C類實(shí)際上看起來(lái)像一個(gè)C結(jié)構(gòu)。編譯器將創(chuàng)建類似于以下偽代碼的結(jié)構(gòu)：

struct DSObjectiveCObject {
    Class isa;
    UIColor *eyeColor;
    NSString *firstName
    NSString *lastName
}

注意第一個(gè)參數(shù)Class isa酥泞。這就是將Objective-C類視為Objective-C類背后的魔力砚殿。isa始終是對(duì)象實(shí)例的內(nèi)存布局中的第一個(gè)值，并且是指向該對(duì)象是其實(shí)例的類的指針芝囤。之后似炎，這些屬性將按照它們?cè)谠创a中的寫(xiě)入順序添加到此結(jié)構(gòu)中。

//項(xiàng)目打印的對(duì)象
<DSObjectiveCObject: 0x600003865180>
//lldb打印的對(duì)象
(lldb) po 0x600003865180
<DSObjectiveCObject: 0x600003865180>
//將內(nèi)存地址轉(zhuǎn)成id指針凡人，再取出指針里面的值名党，我們就訪問(wèn)到了isa指針
(lldb) po *(id *)(0x600003865180)
DSObjectiveCObject

//通過(guò)內(nèi)存讀取可以獲得一樣的效果
(lldb) x/gx 0x600003865180
0x600003865180: 0x000000010c2d55d8
(lldb) po 0x000000010c2d55d8
DSObjectiveCObject

//偏移一個(gè)指針的大小，就是我們的eyeColor
(lldb) po *(id *)(0x600003865180 + 0x8)
UIExtendedSRGBColorSpace 0.6 0.4 0.2 1
//繼續(xù)偏移指針的大小挠轴，就是我們的firstName
(lldb) po *(id *)(0x600003865180 + 0x10)
Derek
//繼續(xù)偏移指針的大小传睹，就是我們的lastName
(lldb) po *(id *)(0x600003865180 + 0x18)
Selander

沒(méi)有父類的Swift內(nèi)存布局

class ASwiftClass {
  let eyeColor = UIColor.brown
  let firstName = "Derek"
  let lastName = "Selander"
  required init() { }  
}

同樣，我們可以將這個(gè)Swift類想象為一個(gè)C結(jié)構(gòu)岸晦，它與Objective-C對(duì)應(yīng)的類有一些有趣的區(qū)別：

struct ASwiftClass {
  Class isa;
  // Simplified, see "InlineRefCounts"
  // in https://github.com/apple/swift
  uintptr_t refCounts;
  
  UIColor *eyeColor;
  
  // Simplified, see "_StringGuts"
  // in https://github.com/apple/swift
  struct _StringCore {
    uintptr_t _object;  // packed bits for string type
    uintptr_t rawBits;  // raw data
  } firstName;
  
  struct _StringCore {
    uintptr_t _object;  // packed bits for string type
    uintptr_t rawBits;  // raw data
  } lastName;
}

Swift仍然將isa變量作為第一個(gè)參數(shù)欧啤。在isa變量之后，有一個(gè)8字節(jié)的變量被保留用于引用計(jì)數(shù)和對(duì)齊启上，稱為refCounts邢隧。這與典型的Objective-C對(duì)象不同，后者在此偏移處不包含此變量冈在。

接下來(lái)倒慧，一個(gè)普通的UIColor，但這就是ASwiftClass結(jié)構(gòu)完全偏離軌道的地方。

Swift字符串是一個(gè)非常有趣的“對(duì)象”纫谅。實(shí)際上炫贤，Swift字符串是ASwiftClass結(jié)構(gòu)中的一個(gè)結(jié)構(gòu)「讹酰可以將Swift字符串看作是一種外觀設(shè)計(jì)模式兰珍，它隱藏不同類型的Swift字符串類型，這取決于它們是否是硬編碼的询吴、Cocoa掠河、使用ASCII的等等。如果Swift是為32位或64位平臺(tái)編譯的猛计，則類型和布局會(huì)有所不同唠摹。為了簡(jiǎn)單起見(jiàn)，只討論64位平臺(tái)有滑。

對(duì)于64位平臺(tái)跃闹，Swift字符串的內(nèi)存布局由16個(gè)字節(jié)組成，結(jié)構(gòu)布局取決于字符串的類型毛好。也就是說(shuō)望艺，首先需要確定字符串的類型，然后才能正確分析字符串的內(nèi)容肌访。

那么怎樣才能確定類型呢找默？下面的文檔摘自Swift 4.2 https://github.com/apple/swift/blob/master/stdlib/public/core/StringObject.swift

// ## _StringObject bit layout //
// x86-64 and arm64: (one 64-bit word)
// +---+---+---|---+------+------------------------------------------+
// + t | v | o | w | uuuu | payload (56 bits)                        |
// +---+---+---|---+------+------------------------------------------+
// most significant bit                         least significatn bit
//
// where t: is-a-value, i.e. a tag bit that says not to perform ARC
//       v: sub-variant bit, i.e. set for isCocoa or isSmall
//       o: is-opaque, i.e. opaque vs contiguously stored strings
//       w: width indicator bit (0: ASCII, 1: UTF-16)
//       u: unused bits
//
// payload is:
//   isNative: the native StringStorage object
//   isCocoa: the Cocoa object
//   isOpaque & !isCocoa: the _OpaqueString object
// isUnmanaged: the pointer to code units
// isSmall: opaque bits used for inline storage // TODO: use them!
//

在文檔中，t吼驶、v惩激、o、w位用于幫助確定Swift字符串的類型蟹演。后面4個(gè)u位將由特定字符串類型使用风钻。也就是說(shuō)，上面提到的StringCore結(jié)構(gòu)的對(duì)象變量的前4位將提供此信息酒请。

Swift字符串結(jié)構(gòu)的布局使程序匯編調(diào)用約定變得相當(dāng)有趣骡技。如果向函數(shù)傳遞字符串，它實(shí)際上將傳入兩個(gè)參數(shù)（并使用兩個(gè)寄存器）羞反，而不是指向包含這兩個(gè)參數(shù)（在一個(gè)寄存器中）的結(jié)構(gòu)的指針布朦。

像OC一樣，我們?cè)贚LDB中查看一下昼窗。

<ASwiftClass: 0x60000313bcc0>

//雖然Swift隱藏了description和debugDescription是趴，我們進(jìn)行類型轉(zhuǎn)換仍可以調(diào)用
(lldb) po 0x60000313bcc0

//在OC上下文中我們甚至可以查看它的父類，雖然我們沒(méi)有聲明
(lldb) po [0x60000313bcc0 superclass]
SwiftObject

//查看Swift類的isa指針
(lldb) po *(id *)0x60000313bcc0
Allocator.ASwiftClass

結(jié)構(gòu)中的引用計(jì)數(shù)是Swift獨(dú)有的澄惊，我們?cè)敿?xì)看看唆途。

//查看引用計(jì)數(shù)
(lldb) po *(id *)(0x60000313bcc0 + 0x8)
0x0000000000000002

(lldb) po [0x60000313bcc0 retain]
(lldb) po *(id *)(0x60000313bcc0 + 0x8)
0x0000000200000002

(lldb) po [0x60000313bcc0 release]
(lldb) po *(id *)(0x60000313bcc0 + 0x8)
0x0000000000000002

注意retain時(shí)中間的十六進(jìn)制值增加了2富雅。這個(gè)地址實(shí)際上應(yīng)該被視為兩個(gè)獨(dú)立的32位字段，而不是一個(gè)64位字段肛搬。我們接著看下面的屬性：

//和OC一樣吹榴，是我們的UIColor brown
(lldb) po *(id *)(0x60000313bcc0 + 0x10)
UIExtendedSRGBColorSpace 0.6 0.4 0.2 1

注意，我們下面開(kāi)始研究Swift的字符串滚婉，它的前4個(gè)比特決定了它的類型。

(lldb) x/gt '0x60000313bcc0 + 0x18'
0x60000313bcd8: 0b1110010100000000000000000000000000000000000000000000000000000000

看看最左邊的前四位：

• 比特0(t)：該對(duì)象不使用ARC計(jì)算引用帅刀。這解釋了為什么在前面執(zhí)行retain方法時(shí)让腹，該值最初為零。
• 比特1(v)：isSmall扣溺，在這種情況下骇窍，字符串在內(nèi)部稱為Swift small String。
• 比特2(o)：實(shí)例存儲(chǔ)為不透明字符串
• 比特3(w)：未設(shè)置該值锥余，這意味著此引用使用了ASCII腹纳。

這個(gè)字符串引用是一個(gè)small String，它是一個(gè)占用少于15字節(jié)的Swift字符串驱犹。這意味著所有的內(nèi)容都可以在Swift String結(jié)構(gòu)中引用嘲恍。如果字符串大于15字節(jié)，則需要一個(gè)指針來(lái)引用數(shù)據(jù)雄驹，而不只是將其打包到16字節(jié)的結(jié)構(gòu)中佃牛。關(guān)于small String，詳細(xì)信息可以在這里查看：
https://github.com/apple/swift/blob/master/stdlib/public/core/SmallString.swift

下面是UTF-8 small Swift String的簡(jiǎn)化C布局：

typedef struct {
  char spillover[7];
  char bits; // msb (tvow) bit types, lsb (uuuu) string length
  char start[8]; // start address of String
} SmallUTF8String;

在這個(gè)結(jié)構(gòu)中医舆，如果字符串的長(zhǎng)度大于8字節(jié)俘侠，則spillover是剩余的字符的開(kāi)始。還有一個(gè)bits值蔬将，它存儲(chǔ)類型和計(jì)數(shù)(較低的4位)爷速。

下面探索firstName變量的布局：

 (lldb) x/s '0x60000313bcc0 + 0x20'
0x60000313bce0: "Derek"

那它的長(zhǎng)度呢？

//對(duì)應(yīng)SmallUTF8String
//char bits; // msb (tvow) bit types, lsb (uuuu) string length
(lldb) x/gx '0x60000313bcc0 + 0x18'
0x000060000313bcd8: 0xe500000000000000
//可以多驗(yàn)證一下
(lldb) p/d *(int *)(0x60000313bcc0 + 0x18 + 7) & 0xf
(int) $10 = 5

5就是我們想要的值霞怀。

NSObject為父類的Swift內(nèi)存布局

class ASwiftNSObjectClass: NSObject {
  let eyeColor = UIColor.brown
  let firstName = "Derek"
  let lastName = "Selander"
  required override init() { }
}

那么生成的C結(jié)構(gòu)偽代碼有什么區(qū)別嗎惫东？

struct ASwiftNSObjectClass {
  Class isa;
  UIColor *eyeColor;
  struct _StringCore {
    uintptr_t _object;
    uintptr_t rawBits;
  } firstName;
  struct _StringCore {
    uintptr_t _object;
    uintptr_t rawBits;
  } lastName;
}

唯一的區(qū)別是ASwiftNSObjectClass實(shí)例在偏移量0x8處缺少refCounts變量，內(nèi)存中的其余布局將相同里烦。因?yàn)镺bjective-C有自己的retain/release實(shí)現(xiàn)凿蒜，它不同于Swift實(shí)現(xiàn)。

1.2 SBValue

SBValue負(fù)責(zé)解釋來(lái)自JIT代碼的表達(dá)式解析胁黑。把SBValue看作是一種表示废封，它允許我們像上面那樣探索對(duì)象中的成員。在SBValue實(shí)例中丧蘸，可以輕松訪問(wèn)結(jié)構(gòu)的所有成員(Objective-C或Swift類)漂洋。

在SBTarget和SBFrame類中怜珍，有一個(gè)名為EvaluateExpression的方法，接受Python字符串表達(dá)式并返回一個(gè)SBValue實(shí)例址儒。此外蜒秤，還有一個(gè)可選的參數(shù)，用于指定希望如何解析代碼贝咙。

在么我們的在LLDB中進(jìn)行探索样悟。

(lldb) po [DSObjectiveCObject new]
<DSObjectiveCObject: 0x6000014794e0>

//用這節(jié)提到的方式執(zhí)行一次
(lldb) script lldb.frame.EvaluateExpression('[DSObjectiveCObject new]')
<lldb.SBValue; proxy of <Swig Object of type 'lldb::SBValue *' at 0x1087105a0> >

//上面的結(jié)果可能有點(diǎn)看不懂，打印一下
(lldb) script print(lldb.target.EvaluateExpression('[DSObjectiveCObject new]'))
(DSObjectiveCObject *) $2 = 0x000060000147bc60

//通過(guò)使用變量的方式
(lldb) script a = lldb.target.EvaluateExpression('[DSObjectiveCObject new]')
(lldb) script print(a)
(DSObjectiveCObject *) $3 = 0x000060000147bca0

很好庭猩，現(xiàn)在我們有一個(gè)存儲(chǔ)在a的SBValue實(shí)例窟她，并且已經(jīng)知道了DSObjectiveCObject的內(nèi)存布局。

我們知道a保存的SBValue是指向DSObjectiveCObject類的指針蔼水≌鹛牵可以使用GetDescription()或更簡(jiǎn)單的SBValue的description屬性獲取DSObjectiveCObject類的描述。同樣我們可以通過(guò)value獲得這個(gè)對(duì)象的地址趴腋。

//打印描述
(lldb) script print(a.description)
<DSObjectiveCObject: 0x60000147bca0>
//得到str類型的地址
(lldb) script print(a.value)
0x000060000147bca0
(lldb) po 0x000060000147bca0
<DSObjectiveCObject: 0x60000147bca0>

//得到signed類型的地址
(lldb) script print(a.signed)
105553137745056
(lldb) p/x 105553137745056
(long) $5 = 0x000060000147bca0

通過(guò)SBValue偏移量探索屬性

(lldb) script print(a.GetNumChildren())
4

我們可以將其理解為一個(gè)數(shù)組吊说，用一個(gè)特殊的APIGetChildAtIndex來(lái)遍歷類中的項(xiàng)目。我們得到了4优炬，因此可以在LLDB中探索索引0~3颁井。

(lldb) script print(a.GetChildAtIndex(0))
(NSObject) NSObject = {
  isa = DSObjectiveCObject
}

(lldb) script print(a.GetChildAtIndex(1))
(UICachedDeviceRGBColor *) _eyeColor = 0x00006000001de340

(lldb) script print(a.GetChildAtIndex(2))
(__NSCFConstantString *) _firstName = 0x00000001059b04b0 @"Derek"

(lldb) script print(a.GetChildAtIndex(3))
(__NSCFConstantString *) _lastName = 0x00000001059b04d0 @"Selander"

GetChildAtIndex將返回一個(gè)SBValue。因此如果需要蠢护，可以進(jìn)一步探索該對(duì)象蚤蔓。用firstName舉例：

(lldb) script print(a.GetChildAtIndex(2).description)
Derek

記住Python變量a是指向?qū)ο蟮闹羔?/strong>。

(lldb) script a.size
8

(lldb) script a.deref.size
32

(lldb) script print(a.type.name)
DSObjectiveCObject *
(lldb) script print(a.deref.type.name)
DSObjectiveCObject

//這將輸出指針的地址，注意是大端的
(lldb) script print(a.data)
a0 bc 47 01 00 60 00 00                          ..G..`..
//與上面的值進(jìn)行對(duì)比
(lldb) script print(a.value)
0x000060000147bca0

(lldb) script print(a.deref.data)
d8 25 9b 05 01 00 00 00 40 e3 1d 00 00 60 00 00  .%......@....`..
b0 04 9b 05 01 00 00 00 d0 04 9b 05 01 00 00 00  ................

(lldb) script options = lldb.SBExpressionOptions()
(lldb) script options.SetLanguage(lldb.eLanguageTypeSwift)

(lldb) script options.SetCoerceResultToId()

expression -lswift -O -- your_expression_here

(lldb) e -lswift -O -- ASwiftClass()
error: <EXPR>:3:1: error: use of unresolved identifier 'ASwiftClass'
ASwiftClass()
^~~~~~~~~~~

(lldb) e -lswift -- import Allocator
(lldb) e -lswift -O -- ASwiftClass()
<ASwiftClass: 0x60000238f500>

(lldb) script b = lldb.target.EvaluateExpression('ASwiftClass()', options)

(lldb) script print(b.description)
<ASwiftClass: 0x6000023f4b40>

(lldb) script print(b.GetValueForExpressionPath('.firstName'))
(String) firstName = "Derek"

(lldb) script print(b)
(Allocator.ASwiftClass) $R4 = 0x00006000023f4b40 {
  eyeColor = 0x000060000238f540 {
    ObjectiveC.NSObject = {}
  }
  firstName = "Derek"
  lastName = "Selander"
}

(lldb) script print(b.GetChildAtIndex(0))
(UIColor) eyeColor = 0x000060000238f540 {
  baseUIDeviceRGBColor@0 = {
    baseUIColor@0 = {
      baseNSObject@0 = {
        isa = UICachedDeviceRGBColor
      }
      _systemColorName = 0x000060000363ff80 "brownColor"
      _cachedStyleString = nil
    }
    redComponent = 0.59999999999999998
    greenComponent = 0.40000000000000002
    blueComponent = 0.20000000000000001
    alphaComponent = 1
    _cachedColor = 0x0000000000000000
  }
}

(lldb) script print(b.GetChildAtIndex(0).name)
eyeColor

(lldb) script print(b.GetValueForExpressionPath('.eyeColor'))
(UIColor) eyeColor = 0x000060000238f540 {
  ObjectiveC.NSObject = {}
}

(lldb) script print(b.GetValueForExpressionPath('.eyeColor').description)
UIExtendedSRGBColorSpace 0.6 0.4 0.2 1

(lldb) script c = lldb.value(b)

(lldb) script print(c.firstName)
(String) firstName = "Derek"

(lldb) script print(c.firstName.sbvalue.description)
"Derek"