变量(Ivar)

上一篇文章Method介绍过，编译期生成的方法都存放在class_ro_t中，同样地，可以发现ivar存放在class_ro_t中的const ivar_list_t ivars中。

typedef struct ivar_t *Ivar;
struct ivar_t{
  int32_t *offset; // 偏移
  const char *name; // 变量名
  const char *type; // encode
  uint32_t alignment_raw; // 对齐
  uint32_t size; // 大小
}

Ivar结构体如上，我们主要探讨下offset这个偏移属性。

Ivar的offset

在之前的文章中NSObject与isa说过，函数realizeClass是用来初始化类的，里面有一段这样的代码:

static Class realizeClass(Class cls){
  // Reconcile instance variable offsets / layout
  if(supcls && !isMeta){
      reconcileInstanceVariables(cls, supercls, ro);
  }
}

通过官方的注释，我们可以猜到reconcileInstanceVariables是用来调整Ivar的offset的，接下来看一下简化过的这个函数：

static void reconcileInstanceVariables(Class cls, Class supercls, const class_ro_t *&ro){
  class_rw_t *rw = cls->data();
  const class_ro_t *super_ro = supercls->data()->ro();

  if(ro->instanceStart >= super-ro->instanceSize){
    return;
  }

  if(ro->instanceStart < super_ro->instanceSize){
    moveIvars(ro_w, super_ro->instanceSize);
  }
}

其中，instanceStart代表当前类的成员变量开始的偏移量，instanceSize表示当前类的成员变量的大小(包括父类的)。发现当子类的开始偏移量小于父类的变量大小的时候，也就是说此时两个类的变量地址是有可能重叠在一起的，这个时候需要调用moveIvars来调整子类的开始偏移量。moveIvars主要通过以下步骤来调整偏移量：
static void moveIvars(class_ro_t *ro, uint32_t superSize)

1.获取最大的对齐字节

uint32_t maxAlignment = 1;
for(const auto &ivar : *ro-ivars){
  if(!ivar.offset) continue;
  uint32_t alignment = ivar.alignment();
  if(alignment  > maxAlignment ){
    maxAlignment  = alignment;
  }
}

2.调整所有变量的偏移

uint32_t diff = superSize - ro->instanceStart;
uint32_t alignMask = maxAlignment  - 1;
diff = (diff + alignMask) & ~alignMask ; // 通过该位操作可得到应该在diff的位置以maxAlignment 对齐时偏移的字节数

// 调整所有的offset
for(const auto &ivar : *ro-ivars){
  if(!ivar.offset) continue;

  *ivar.offset = *ivar.offset + diff; 
}

这段代码主要就是把子类的所有成员变量的偏移量调整到父类的后面。

3.调整子类的instanceStart和instanceSize

*(uint32_t *)&ro->instanceStart += diff;
*(uint32_t *)&ro->instanceSize += diff;

在用代码验证之前，我们再看一个获取Ivar的函数:

id object_getIvar(id obj, Ivar ivar){
  ptrdiff_t offset;
  objc_ivar_memory_management_t memoryManagement;
  _class_lookUpIvar(obj->ISA(), ivar, offset, memoryManagement);
  id *location = (id *)((char *)obj + offset);
  return *location;
}

可以看到，获取变量的方法直接就是通过(id *)((char *)obj + offset)偏移地址去获取对象，而offset就是ivar.offset，这样的话类的结构就比较明显了，接下来我们用代码来验证下，首先添加一个子类：

@interface TestIvar : NSObject{
  NSString *_ivarStr;
}
@property(nonatomic, assign) NSInteger propertyInt;
@end

在通过reconcileInstanceVariables调整了TestIvar的变量偏移量之后，首先来看父类NSObject的变量：

NSObject

TestIvar

IvarLayout

class_ro_t中有两个变量ivarLayout和weakIvarLayout，是用来记录变量那些是strong的，哪些是weak的，在object_getIvar中有通过_class_lookUpIvar获取变量的objc_ivar_memory_management_t:

static void _class_lookUpIvar(Class cls, Ivar ivar, ptrdiff_t& ivarOffset, objc_ivar_memory_management_t& memoryManagement){
  ...
  ptrdiff_t localOffset = ivarOffset - ivarCls->alignedInstanceStart();
  if(isScanned(localOffset, class_getIvarLayout(ivarLayout))){
      memoryManagement = objc_ivar_memoryStrong;
  }
  if(isScanned(localOffset, class_getWeakIvarLayout(ivarLayout))){
      memoryManagement = objc_ivar_memoryWeak;
  }
  ...
}

通过判断变量的偏移量localOffset跟ivarLayout和weakIvarLayout来对比，来判断是strong还是weak的。

static bool isScanned(ptrdiff_t ivar_offset, const uint8 *layout){
  ptrdiff_t index = 0, ivar_index = ivar_offset / sizeof(void *);
  uint_t byte;
  while(byte = *layout++){
    unsigned skips = (byte >> 4);
    unsigned scans = (byte & 0x0F);
    index += skips;
    if(index > ivar_index) return NO;
    index += scans;
    if (index > ivar_index) return YES;
  }
  return NO;
}

我们先新增加一个类：

@interface TestIvarLayout : NSObject{
  NSString *ivar1;
  NSString *ivar2;
  __weak NSString *ivar3;
  __weak NSString *ivar4;
  NSString *ivar5;
  NSString *ivar6;
}
@end

通过lldb命令可以获取到ivarLayout和weakIvarLayout的值如下:

1. 对于ivar1和ivar2，在第一次循环的时候index+=scans，由于满足(index>ivar_index)便判断为strong类型了。
2. 对于ivar3和ivar4，在扫描ivarLayout的时候，判断为非strong类型。在扫描weakIvarLayout，判断为weak类型。
3. 对于ivar5和ivar6，在第二次循环的时候index+=scans，由于满足(index>ivar_index)便判断为strong类型了。
   我们很容易发现，每次循环skips字段是忽略掉的，scans字段是有用的。经过其他资料证明，skips代表当前有多少个连续的非strong(weak)类型的，scans代表当前有多少个连续的strong(weak)类型。
   对于ivarLayout，0x02代表先有0个非strong类型的，后有2个strong类型，这两个刚好是ivar1和ivar2。然后是0x22代表先有2个非strong类型的(ivar3和ivar4)，后有2个strong类型的变量(ivar5和ivar6)。
   对于weakIvarLayout，0x22代表先有2个非weak类型的(ivar1和ivar2)，后有2个weak类型的变量(ivar3和ivar4)。
   这也刚好与类TestIvarLayout符合。

为何不能在编译器动态添加Ivar

假设我们已经有上面的类TestIvarLayout，之后我们在运行期给类NSObject动态添加一个变量A，这样A的内存地址就会紧接着isa。由于这个时候没有调整子类的所有变量offset，那TestIvarLayout.ivar1和NSObject.A就会内存重叠，导致出现错误。这样NSObject的所有子类其实都可能会有这个问题，这也是为什么不能在运行期动态添加Ivar。

小结

1. 变量Ivar都是在编译期间生成的，并且所有子类的变量都排在父类的变量后面，偏移量通过函数moveIvars来调整。
2. ivarLayout和weakIvarLayout分别代表着strong和weak变量的分布。
3. 在运行期动态添加Ivar，可能会导致所有子类无法正常使用。