iOS原理探索03--isa与类的关联原理

本文的主要介绍如何理解isa与类的关系，在介绍之前我们首先要知道OC对象的本质是什么？这里我们先插曲一个Clang编译器。

一、下面是Clang介绍

Clang是⼀个C语⾔、C++、Objective-C语⾔的轻量级编译器。源代码发布于BSD协议下。
Clang将⽀持其普通lambda表达式、返回类型的简化处理以及更好的处理constexpr关键字。
Clang是⼀个由apple主导编写，基于LLVM的C/C++/Objective-C编译器。
2013年4⽉,Clang已经全⾯⽀持C++11标准，并开始实现C++1y特性（也就是C++14，这是C++的下⼀个⼩更新版本）。Clang将⽀持其普通lambda表达式、返回类型的简化处理以及更好的处理constexpr关键字。
Clang是⼀个C++编写、基于LLVM、发布于LLVM BSD许可证下的C/C++/Objective-C/Objective-C++编译器。它与GNU C语⾔规范⼏乎完全兼容（当然，也有部分不兼容的内容，包括编译命令选项也会有点差异），并在此基础上增加了额外的语法特性，⽐如C函数重载（通过__attribute__((overloadable))来修饰函数），其⽬标（之⼀）就是超越GCC。

• 如何将OC文件编译为C++文件呢？
  clang -rewrite-objc main.m -o main.cpp 把⽬标⽂件编译成c++⽂件
• UIKit报错问题处理

clang -rewrite-objc -fobjc-arc -fobjc-runtime=ios-13.0.0 -isysroot /
Applications/Xcode.app/Contents/Developer/Platforms/
iPhoneSimulator.platform/Developer/SDKs/iPhoneSimulator13.0.sdk main.m 

xcode安装的时候顺带安装了xcrun命令，xcrun命令在clang的基础上进⾏了⼀些封装，要更好⽤⼀些

• 模拟器编译
  xcrun -sdk iphonesimulator clang -arch arm64 -rewrite-objc main.m -o main-arm64.cpp (模拟器)
• 真机编译
  xcrun -sdk iphoneos clang -arch arm64 -rewrite-objc main.m -o main�-arm64.cpp (⼿机)

二、什么是对象？？？？

• 我们先使用clang将下面这段代码编译为cpp文件，在main中自定义一个类LGPerson，有一个属性name。

@interface LGPerson : NSObject
@property (nonatomic, copy) NSString *name;
@end

@implementation LGPerson
@end

int main(int argc, const char * argv[]) {
    @autoreleasepool {
        // insert code here...
        NSLog(@"Hello, World!");
    }
    return 0;
}

编译后的文件

#ifndef _REWRITER_typedef_LGPerson
#define _REWRITER_typedef_LGPerson
typedef struct objc_object LGPerson;
typedef struct {} _objc_exc_LGPerson;
#endif

extern "C" unsigned long OBJC_IVAR_$_LGPerson$_name;
struct LGPerson_IMPL {
    struct NSObject_IMPL NSObject_IVARS;
    NSString *_name;
};

// @property (nonatomic, copy) NSString *name;
/* @end */


// @implementation LGPerson

static NSString * _I_LGPerson_name(LGPerson * self, SEL _cmd) { return (*(NSString **)((char *)self + OBJC_IVAR_$_LGPerson$_name)); }
extern "C" __declspec(dllimport) void objc_setProperty (id, SEL, long, id, bool, bool);

static void _I_LGPerson_setName_(LGPerson * self, SEL _cmd, NSString *name) { objc_setProperty (self, _cmd, __OFFSETOFIVAR__(struct LGPerson, _name), (id)name, 0, 1); }
// @end

int main(int argc, const char * argv[]) {
    /* @autoreleasepool */ { __AtAutoreleasePool __autoreleasepool; 

        NSLog((NSString *)&__NSConstantStringImpl__var_folders_99_79b11sqx7xd67mxf4rx5g0tr0000gn_T_main_949408_mi_0);
    }
    return 0;
}

• 从编译的main.cpp这段代码，我们可以看出，源代码的LGPerson编译后是个结构体struct。
  • LGPerson_IMPL中的第一个属性 其实就是 isa，是继承自NSObject，属于伪继承， 伪继承的方式 是直接将 LGPerson作为结构体的第一个属性，意味着LGPerson拥有 NSObject中的所有成员变量。
  • LGPerson中的第一个属性 NSObject_IVARS等效于NSObject中的isa。

结论：对象的本质是一个结构体。

三、类的源码分析

@interface NSObject <NSObject> {

    Class isa  OBJC_ISA_AVAILABILITY;
}

我们跟进源码，发现NSObject的定义，我们发现了本文要讨论的isa，由代码可以看出isa是class类型，那么这是为什么呢？为什么isa不是其他的类型呢？
紧接着我们通过源码调试，找到了ISA()方法，这是isa的get方法。

inline Class 
objc_object::ISA() 
{
    ASSERT(!isTaggedPointer()); 
#if SUPPORT_INDEXED_ISA
    if (isa.nonpointer) {
        uintptr_t slot = isa.indexcls;
        return classForIndex((unsigned)slot);
    }
    return (Class)isa.bits;
#else
    return (Class)(isa.bits & ISA_MASK);
#endif
}

结论：从下面代码(Class)isa.bits或(Class)(isa.bits & ISA_MASK)我们可以看出，这两步操作都是对ISA进行了Class的强制转换，所以isa是class类型。

四、 objc_setProperty()方法解析

我们从什么是对象这一段的源码编译的cpp文件代码可以看出，在添加属性name之后，通过Clang编译后多了两个方法，代码如下：

static NSString * _I_LGPerson_name(LGPerson * self, SEL _cmd) { return (*(NSString **)((char *)self + OBJC_IVAR_$_LGPerson$_name)); }
extern "C" __declspec(dllimport) void objc_setProperty (id, SEL, long, id, bool, bool);

static void _I_LGPerson_setName_(LGPerson * self, SEL _cmd, NSString *name) { objc_setProperty (self, _cmd, __OFFSETOFIVAR__(struct LGPerson, _name), (id)name, 0, 1); }

这里我们可以得知通过设置属性，系统自己会添加属性的set和get方法，并且是通过objc_setProperty方法来设置的，那么我们就来追踪一下它的源码，

//objc_setProperty的接口实现
void objc_setProperty(id self, SEL _cmd, ptrdiff_t offset, id newValue, BOOL atomic, signed char shouldCopy) 
{
    bool copy = (shouldCopy && shouldCopy != MUTABLE_COPY);
    bool mutableCopy = (shouldCopy == MUTABLE_COPY);
    reallySetProperty(self, _cmd, newValue, offset, atomic, copy, mutableCopy);
}


//reallySetProperty()接口实现
static inline void reallySetProperty(id self, SEL _cmd, id newValue, ptrdiff_t offset, bool atomic, bool copy, bool mutableCopy)
{
    if (offset == 0) {
        object_setClass(self, newValue);
        return;
    }

    id oldValue;
    id *slot = (id*) ((char*)self + offset);

    if (copy) {
        newValue = [newValue copyWithZone:nil];
    } else if (mutableCopy) {
        newValue = [newValue mutableCopyWithZone:nil];
    } else {
        if (*slot == newValue) return;
        newValue = objc_retain(newValue);
    }

    if (!atomic) {
        oldValue = *slot;
        *slot = newValue;
    } else {
        spinlock_t& slotlock = PropertyLocks[slot];
        slotlock.lock();
        oldValue = *slot;
        *slot = newValue;        
        slotlock.unlock();
    }

    objc_release(oldValue);
}

通过reallySetProperty()接口实现我们发现属性的设置，只是newValue = objc_retain(newValue);新值的retain，和objc_release(oldValue);旧值的release。

五、cls与 类 的关联原理

探索一下通过initInstanceIsa是如何将cls与isa关联的，在此之前，需要先了解什么是联合体？？？？

联合体与结构体知识小拓展

• 结构体(struct)中所有变量是共存的
  • 优点是有容乃⼤，全⾯；
  • 缺点是struct内存空间的分配是粗放的，不管⽤不⽤，全分配。
• 联合体(union)中是各变量是互斥的
  • 缺点就是不够包容；
  • 优点是内存使⽤更为精细灵活，也节省了内存空间

• 首先我们来看一下isa_t的结构

union isa_t {
    isa_t() { }
    isa_t(uintptr_t value) : bits(value) { }

    Class cls;
    uintptr_t bits;
#if defined(ISA_BITFIELD)
    struct {
        ISA_BITFIELD;  // defined in isa.h
    };
#endif
};

我们可以看出isa_t是通过union联合体来构造的，从isa_t的定义中可以看出：

• 提供了两个成员，cls 和 bits，由联合体的定义所知，这两个成员是互斥的，也就意味着，当初始化isa指针时，有两种初始化方式

  • 通过cls初始化，bits无默认值

  • 通过bits初始化，cls有默认值

除此之外它还提供了一个结构体定义的位域，用于存储类信息及其他信息，结构体的成员ISA_BITFIELD，这是一个宏定义，有两个版本 __arm64__（对应ios 移动端） 和 __x86_64__（对应macOS），以下是它们的一些宏定义，具体的宏定义代码如下：

# if __arm64__
#   define ISA_MASK        0x0000000ffffffff8ULL
#   define ISA_MAGIC_MASK  0x000003f000000001ULL
#   define ISA_MAGIC_VALUE 0x000001a000000001ULL
#   define ISA_BITFIELD                                                      \
      uintptr_t nonpointer        : 1;                                       \
      uintptr_t has_assoc         : 1;                                       \
      uintptr_t has_cxx_dtor      : 1;                                       \
      uintptr_t shiftcls          : 33; /*MACH_VM_MAX_ADDRESS 0x1000000000*/ \
      uintptr_t magic             : 6;                                       \
      uintptr_t weakly_referenced : 1;                                       \
      uintptr_t deallocating      : 1;                                       \
      uintptr_t has_sidetable_rc  : 1;                                       \
      uintptr_t extra_rc          : 19
#   define RC_ONE   (1ULL<<45)
#   define RC_HALF  (1ULL<<18)

# elif __x86_64__
#   define ISA_MASK        0x00007ffffffffff8ULL
#   define ISA_MAGIC_MASK  0x001f800000000001ULL
#   define ISA_MAGIC_VALUE 0x001d800000000001ULL
#   define ISA_BITFIELD                                                        \
      uintptr_t nonpointer        : 1;                                     \
      uintptr_t has_assoc         : 1;                                        \
      uintptr_t has_cxx_dtor      : 1;                                        \
      uintptr_t shiftcls          : 44; /*MACH_VM_MAX_ADDRESS 0x7fffffe00000*/ \
      uintptr_t magic             : 6;                                         \
      uintptr_t weakly_referenced : 1;                                         \
      uintptr_t deallocating      : 1;                                         \
      uintptr_t has_sidetable_rc  : 1;                                         \
      uintptr_t extra_rc          : 8
#   define RC_ONE   (1ULL<<56)
#   define RC_HALF  (1ULL<<7)

# else
#   error unknown architecture for packed isa
# endif

// SUPPORT_PACKED_ISA
#endif

先简单介绍一下每个宏的意义：

nonpointer：表示是否对 isa 指针开启指针优化；0：纯isa指针，1：不⽌是类对象地址,isa 中包含了类信息、对象的引⽤计数等。

has_assoc：关联对象标志位，0没有，1存在`。

has_cxx_dtor：该对象是否有 C++ 或者 Objc 的析构器,如果有析构函数,则需要做析构逻辑, 如果没有,则可以更快的释放对象。

shiftcls：存储类指针的值。开启指针优化的情况下，在arm64 架构中有 33 位⽤来存储类指针。

magic：⽤于调试器判断当前对象是真的对象还是没有初始化的空间。

weakly_referenced：标志对象是否被指向或者曾经指向⼀个 ARC 的弱变量，没有弱引⽤的对象可以更快释放。

deallocating：标志对象是否正在释放内存。

has_sidetable_rc：当对象引⽤技术⼤于 10时，则需要借⽤该变量存储进位。

extra_rc：当表示该对象的引⽤计数值，实际上是引⽤计数值减 1，例如，如果对象的引⽤计数为 10，那么extra_rc为 9。如果引⽤计数⼤于 10，则需要使⽤到下⾯的 has_sidetable_rc。

源码追踪

通过alloc --> _objc_rootAlloc --> callAlloc --> _objc_rootAllocWithZone --> _class_createInstanceFromZone方法路径，查找到initInstanceIsa，并进入其原理实现。

inline void 
objc_object::initInstanceIsa(Class cls, bool hasCxxDtor)
{
    ASSERT(!cls->instancesRequireRawIsa());
    ASSERT(hasCxxDtor == cls->hasCxxDtor());

    initIsa(cls, true, hasCxxDtor);
}

inline void 
objc_object::initIsa(Class cls, bool nonpointer, bool hasCxxDtor) 
{ 
    ASSERT(!isTaggedPointer()); 
    
    if (!nonpointer) {
        //初始化isa指针
        isa = isa_t((uintptr_t)cls);
    } else {
        ASSERT(!DisableNonpointerIsa);
        ASSERT(!cls->instancesRequireRawIsa());

        isa_t newisa(0);
#if SUPPORT_INDEXED_ISA
        ASSERT(cls->classArrayIndex() > 0);
        newisa.bits = ISA_INDEX_MAGIC_VALUE;
        // isa.magic is part of ISA_MAGIC_VALUE
        // isa.nonpointer is part of ISA_MAGIC_VALUE
        newisa.has_cxx_dtor = hasCxxDtor;
        newisa.indexcls = (uintptr_t)cls->classArrayIndex();
#else
        newisa.bits = ISA_MAGIC_VALUE;
        // isa.magic is part of ISA_MAGIC_VALUE
        // isa.nonpointer is part of ISA_MAGIC_VALUE
        newisa.has_cxx_dtor = hasCxxDtor;
        newisa.shiftcls = (uintptr_t)cls >> 3;
#endif
        // This write must be performed in a single store in some cases
        // (for example when realizing a class because other threads
        // may simultaneously try to use the class).
        // fixme use atomics here to guarantee single-store and to
        // guarantee memory order w.r.t. the class index table
        // ...but not too atomic because we don't want to hurt instantiation
        isa = newisa;
    }
}

六、isa与类的关联

isa与类的关联，主要是通过initInstanceIsa方法中的calloc指针和当前类的cls相关联，用isa指针中的shiftcls位域来存储类的相关信息，我们可以有以下几种验证方式：

【方式一】通过initIsa方法中的newisa.shiftcls = (uintptr_t)cls >> 3;验证
我们通过initInstanceIsa->initIsa->newisa.shiftcls -> (uintptr_t)cls >> 3，打印查看isa指针以及查看newisa.shiftcls存储信息来验证是否shiftcls位域中存储着isa指针。

打印(uintptr_t)cls >> 3和newisa.shiftcls 通过控制台的输出结果可以看出步骤一和步骤二的信息是一致的，这就验证我们想法。

• 我们再来比较一下bits赋值前后的结果，bits的位域中有两处变化cls由默认值，变成了LGPerson，将isa与cls完美关联shiftcls由0变成了536871965。

  图片来自Style_月月简书----isa成员值变化过程

• 下面我们在提出疑问为什么在shiftcls赋值时需要类型强转？

因为内存的存储不能存储字符串，机器码只能识别0 、1这两种数字，所以需要将其转换为uintptr_t数据类型，这样shiftcls中存储的类信息才能被机器码理解， 其中uintptr_t是long。

• 为什么需要右移3位？

主要是由于shiftcls的信息处于isa指针地址的中间部分，前面还有3个位域，为了不影响前面的3个位域的数据，需要右移将其抹零。

【方式二】通过isa指针地址与ISA_MSAK 的值 & 来验证
cla与isa关联后，我们通过lldb，x/4gx 在控制台输出obj的存储信息，在通过obj的isa指针&MASK，结果一样的是LGPerson

isa指针&MASK结果

• 注意

  • arm64中，ISA_MASK 宏定义的值为0x0000000ffffffff8ULL

  • x86_64中，ISA_MASK 宏定义的值为0x00007ffffffffff8ULL

【方式三】通过runtime的方法object_getClass验证
通过查看object_getClass的源码实现，同样可以验证isa与类关联的原理，通过runtime的api，即object_getClass函数获取类信息，下面我们来查看一下源码

/***********************************************************************
* object_getClass.
* Locking: None. If you add locking, tell gdb (rdar://7516456).
**********************************************************************/
Class object_getClass(id obj)
{
    if (obj) return obj->getIsa();
    else return Nil;
}

//接着往下走
inline Class 
objc_object::getIsa() 
{
    if (fastpath(!isTaggedPointer())) return ISA();

    extern objc_class OBJC_CLASS_$___NSUnrecognizedTaggedPointer;
    uintptr_t slot, ptr = (uintptr_t)this;
    Class cls;

    slot = (ptr >> _OBJC_TAG_SLOT_SHIFT) & _OBJC_TAG_SLOT_MASK;
    cls = objc_tag_classes[slot];
    if (slowpath(cls == (Class)&OBJC_CLASS_$___NSUnrecognizedTaggedPointer)) {
        slot = (ptr >> _OBJC_TAG_EXT_SLOT_SHIFT) & _OBJC_TAG_EXT_SLOT_MASK;
        cls = objc_tag_ext_classes[slot];
    }
    return cls;
}

//往下走到 ISA()

inline Class 
objc_object::ISA() 
{
    ASSERT(!isTaggedPointer()); 
#if SUPPORT_INDEXED_ISA
    if (isa.nonpointer) {
        uintptr_t slot = isa.indexcls;
        return classForIndex((unsigned)slot);
    }
    return (Class)isa.bits;
#else
    return (Class)(isa.bits & ISA_MASK);
#endif
}

我们发现源码一样的是使用的isa.bits & ISA_MASK，在用Class类型做了强制转换的。

【方式四】通过位运算验证
回到_class_createInstanceFromZone方法。通过x/4gx obj 得到obj的存储信息，当前类的信息存储在isa指针中，且isa中的shiftcls此时占44位（因为处于macOS环境）

• 将右边3位，和左边除去44位以外的部分都抹零，其相对位置是不变的;
  • 将isa地址右移3位
  • 在将得到的结果左移20位
  • 再右移17位
    操作步骤以及结果输出 我们可以看出同样的可以的此结论：isa与类的关联，主要是通过initInstanceIsa方法中的calloc指针和当前类的cls相关联，用isa指针中的shiftcls位域来存储类的相关信息！