iOS 中weak的实现代码示例

struct SideTable {
  // 自旋锁，用来保证线程安全
  spinlock_t slock;
  // 引用计数表
  RefcountMap refcnts;
  // weak 表
  weak_table_t weak_table;

  ...
};

struct weak_table_t {
  // 保存了所有指向指定对象的 weak 指针
  weak_entry_t *weak_entries;
  // 存储空间，即 entries 的数目
  size_t  num_entries;
  // 参与判断引用计数辅助量
  uintptr_t mask;
  // hash key 最大偏移量
  uintptr_t max_hash_displacement;
};

// 存储在弱引用表中的一个内部结构体
#define WEAK_INLINE_COUNT 4
struct weak_entry_t {
  DisguisedPtr<objc_object> referent;         // 封装 objc_object 指针，即 weak 修饰的变量指向的对象
  union {
    struct {
      weak_referrer_t *referrers;
      uintptr_t    out_of_line : 1;      // LSB 最低有效元 当标志位为0时，增加引用表指针纬度，
                            // 当其为0的时候， weak_referrer_t 成员将扩展为静态数组型的 hash table
      uintptr_t    num_refs : PTR_MINUS_1;  // 引用数值，这里记录弱引用表中引用有效数字，即里面元素的数量
      uintptr_t    mask;
      uintptr_t    max_hash_displacement;   // hash 元素上限阀值
    };
    struct {
      // out_of_line=0 is LSB of one of these (don't care which)
      weak_referrer_t inline_referrers[WEAK_INLINE_COUNT];   
    };
  };
};

{
  id obj1 = [[NSObject alloc] init];
  id __weak obj2 = obj1;
}

id objc_initWeak(id *location, id newObj)
{
  // 查看对象实例是否有效
  // 无效对象直接导致指针释放
  if (!newObj) {
    *location = nil;
    return nil;
  }
  // 这里传递了三个 bool 数值
  // 使用 template 进行常量参数传递是为了优化性能
  return storeWeak<false/*old*/, true/*new*/, true/*crash*/>
    (location, (objc_object*)newObj);
}

void objc_destroyWeak(id *location)
{
  (void)storeWeak<true/*old*/, false/*new*/, false/*crash*/>
    (location, nil);
}

// 更新一个弱引用变量
// 如果 HaveOld 是 true, 变量是个有效值，需要被及时清理。变量可以为 nil。
// 如果 HaveNew 是 true, 需要一个新的 value 来替换变量。变量可以为 nil
// 如果crashifdeallocation 是 ture ，那么如果 newObj 是 deallocating，或者 newObj 的类不支持弱引用，则该进程就会停止。
// 如果crashifdeallocation 是 false，那么 nil 会被存储。

template <bool HaveOld, bool HaveNew, bool CrashIfDeallocating>
static id storeWeak(id *location, objc_object *newObj)
{
  assert(HaveOld || HaveNew);
  if (!HaveNew) assert(newObj == nil);

  Class previouslyInitializedClass = nil;
  id oldObj;
  
  // 创建新旧散列表
  SideTable *oldTable;
  SideTable *newTable;

  // Acquire locks for old and new values.
  // 获得新值和旧值的锁存位置 (用地址作为唯一标示)
  // Order by lock address to prevent lock ordering problems.
  // 通过地址来建立索引标志，防止桶重复
  // Retry if the old value changes underneath us.
  // 下面指向的操作会改变旧值
 retry:
  if (HaveOld) {
  // 如果 HaveOld 为 true ，更改指针，获得以 oldObj 为索引所存储的值地址
    oldObj = *location;
    oldTable = &SideTables()[oldObj];
  } else {
    oldTable = nil;
  }
  if (HaveNew) {
  // 获得以 newObj 为索引所存储的值对象
    newTable = &SideTables()[newObj];
  } else {
    newTable = nil;
  }
  
// 对两个 table 进行加锁操作，防止多线程中竞争冲突
  SideTable::lockTwo<HaveOld, HaveNew>(oldTable, newTable);

// location 应该与 oldObj 保持一致，如果不同，说明当前的 location 已经处理过 oldObj 可是又被其他线程所修改, 保证线程安全，这个判断用来避免线程冲突重处理问题
  if (HaveOld && *location != oldObj) {
    SideTable::unlockTwo<HaveOld, HaveNew>(oldTable, newTable);
    goto retry;
  }

  // Prevent a deadlock between the weak reference machinery
  // and the +initialize machinery by ensuring that no 
  // weakly-referenced object has an un-+initialized isa.
  // 防止弱引用之间发生死锁，并且通过 +initialize 初始化构造器保证所有弱引用的 isa 非空指向
  if (HaveNew && newObj) {
    // 获得新对象的 isa 指针
    Class cls = newObj->getIsa();
    // 判断 isa 非空且已经初始化
    if (cls != previouslyInitializedClass && 
      !((objc_class *)cls)->isInitialized()) 
    {
      // 对两个表解锁
      SideTable::unlockTwo<HaveOld, HaveNew>(oldTable, newTable);
      _class_initialize(_class_getNonMetaClass(cls, (id)newObj));

      // If this class is finished with +initialize then we're good.
      // If this class is still running +initialize on this thread 
      // (i.e. +initialize called storeWeak on an instance of itself)
      // then we may proceed but it will appear initializing and 
      // not yet initialized to the check above.
      // Instead set previouslyInitializedClass to recognize it on retry.
      // 如果该类已经完成执行 +initialize 方法是最好的，如果该类 + initialize 在线程中，例如 +initialize 正在调用storeWeak 方法，那么则需要手动对其增加保护策略，并设置 previouslyInitializedClass 指针进行标记然后重新尝试
      previouslyInitializedClass = cls;

      goto retry;
    }
  }

  // Clean up old value, if any. 清除旧值
  if (HaveOld) {
    weak_unregister_no_lock(&oldTable->weak_table, oldObj, location);
  }

  // Assign new value, if any. 分配新值
  if (HaveNew) {
    newObj = (objc_object *)weak_register_no_lock(&newTable->weak_table, 
                           (id)newObj, location, 
                           CrashIfDeallocating);
    // weak_register_no_lock returns nil if weak store should be rejected
    // 如果弱引用被释放则该方法返回 nil
    // Set is-weakly-referenced bit in refcount table.
    // 在引用计数表中设置弱引用标记位
    if (newObj && !newObj->isTaggedPointer()) {
      newObj->setWeaklyReferenced_nolock();
    }

    // Do not set *location anywhere else. That would introduce a race.
    *location = (id)newObj;
  }
  else {
    // No new value. The storage is not changed.
  }
  
  SideTable::unlockTwo<HaveOld, HaveNew>(oldTable, newTable);

  return (id)newObj;
}

void weak_unregister_no_lock(weak_table_t *weak_table, id referent_id, 
            id *referrer_id)
{
  objc_object *referent = (objc_object *)referent_id;
  objc_object **referrer = (objc_object **)referrer_id;

  weak_entry_t *entry;

  if (!referent) return;

  if ((entry = weak_entry_for_referent(weak_table, referent))) {
    remove_referrer(entry, referrer);
    bool empty = true;
    if (entry->out_of_line && entry->num_refs != 0) {
      empty = false;
    }
    else {
      for (size_t i = 0; i < WEAK_INLINE_COUNT; i++) {
        if (entry->inline_referrers[i]) {
          empty = false; 
          break;
        }
      }
    }

    if (empty) {
      weak_entry_remove(weak_table, entry);
    }
  }

  // Do not set *referrer = nil. objc_storeWeak() requires that the 
  // value not change.
}

static weak_entry_t *weak_entry_for_referent(weak_table_t *weak_table, objc_object *referent)
{
  assert(referent);

  weak_entry_t *weak_entries = weak_table->weak_entries;

  if (!weak_entries) return nil;

  size_t index = hash_pointer(referent) & weak_table->mask;
  size_t hash_displacement = 0;
  while (weak_table->weak_entries[index].referent != referent) {
    index = (index+1) & weak_table->mask;
    hash_displacement++;
    if (hash_displacement > weak_table->max_hash_displacement) {
      return nil;
    }
  }

  return &weak_table->weak_entries[index];
}

static void remove_referrer(weak_entry_t *entry, objc_object **old_referrer)
{
  if (! entry->out_of_line) {
    for (size_t i = 0; i < WEAK_INLINE_COUNT; i++) {
      if (entry->inline_referrers[i] == old_referrer) {
        entry->inline_referrers[i] = nil;
        return;
      }
    }
    _objc_inform("Attempted to unregister unknown __weak variable "
           "at %p. This is probably incorrect use of "
           "objc_storeWeak() and objc_loadWeak(). "
           "Break on objc_weak_error to debug.\n", 
           old_referrer);
    objc_weak_error();
    return;
  }

  size_t index = w_hash_pointer(old_referrer) & (entry->mask);
  size_t hash_displacement = 0;
  while (entry->referrers[index] != old_referrer) {
    index = (index+1) & entry->mask;
    hash_displacement++;
    if (hash_displacement > entry->max_hash_displacement) {
      _objc_inform("Attempted to unregister unknown __weak variable "
             "at %p. This is probably incorrect use of "
             "objc_storeWeak() and objc_loadWeak(). "
             "Break on objc_weak_error to debug.\n", 
             old_referrer);
      objc_weak_error();
      return;
    }
  }
  entry->referrers[index] = nil;
  entry->num_refs--;
}

id weak_register_no_lock(weak_table_t *weak_table, id referent_id, 
           id *referrer_id, bool crashIfDeallocating)
{
  objc_object *referent = (objc_object *)referent_id;
  objc_object **referrer = (objc_object **)referrer_id;

  if (!referent || referent->isTaggedPointer()) return referent_id;

  // ensure that the referenced object is viable
  bool deallocating;
  if (!referent->ISA()->hasCustomRR()) {
    deallocating = referent->rootIsDeallocating();
  }
  else {
    BOOL (*allowsWeakReference)(objc_object *, SEL) = 
      (BOOL(*)(objc_object *, SEL))
      object_getMethodImplementation((id)referent, 
                      SEL_allowsWeakReference);
    if ((IMP)allowsWeakReference == _objc_msgForward) {
      return nil;
    }
    deallocating =
      ! (*allowsWeakReference)(referent, SEL_allowsWeakReference);
  }

  if (deallocating) {
    if (crashIfDeallocating) {
      _objc_fatal("Cannot form weak reference to instance (%p) of "
            "class %s. It is possible that this object was "
            "over-released, or is in the process of deallocation.",
            (void*)referent, object_getClassName((id)referent));
    } else {
      return nil;
    }
  }

  // now remember it and where it is being stored
  weak_entry_t *entry;
  if ((entry = weak_entry_for_referent(weak_table, referent))) {
    append_referrer(entry, referrer);
  } 
  else {
    weak_entry_t new_entry;
    new_entry.referent = referent;
    new_entry.out_of_line = 0;
    new_entry.inline_referrers[0] = referrer;
    for (size_t i = 1; i < WEAK_INLINE_COUNT; i++) {
      new_entry.inline_referrers[i] = nil;
    }

    weak_grow_maybe(weak_table);
    weak_entry_insert(weak_table, &new_entry);
  }

  // Do not set *referrer. objc_storeWeak() requires that the 
  // value not change.

  return referent_id;
}

static void append_referrer(weak_entry_t *entry, objc_object **new_referrer)
{
  if (! entry->out_of_line) {
    // Try to insert inline.
    for (size_t i = 0; i < WEAK_INLINE_COUNT; i++) {
      if (entry->inline_referrers[i] == nil) {
        entry->inline_referrers[i] = new_referrer;
        return;
      }
    }

    // Couldn't insert inline. Allocate out of line.
    weak_referrer_t *new_referrers = (weak_referrer_t *)
      calloc(WEAK_INLINE_COUNT, sizeof(weak_referrer_t));
    // This constructed table is invalid, but grow_refs_and_insert
    // will fix it and rehash it.
    for (size_t i = 0; i < WEAK_INLINE_COUNT; i++) {
      new_referrers[i] = entry->inline_referrers[I];
    }
    entry->referrers = new_referrers;
    entry->num_refs = WEAK_INLINE_COUNT;
    entry->out_of_line = 1;
    entry->mask = WEAK_INLINE_COUNT-1;
    entry->max_hash_displacement = 0;
  }

  assert(entry->out_of_line);

  if (entry->num_refs >= TABLE_SIZE(entry) * 3/4) {
    return grow_refs_and_insert(entry, new_referrer);
  }
  size_t index = w_hash_pointer(new_referrer) & (entry->mask);
  size_t hash_displacement = 0;
  while (entry->referrers[index] != NULL) {
    index = (index+1) & entry->mask;
    hash_displacement++;
  }
  if (hash_displacement > entry->max_hash_displacement) {
    entry->max_hash_displacement = hash_displacement;
  }
  weak_referrer_t &ref = entry->referrers[index];
  ref = new_referrer;
  entry->num_refs++;
}

void objc_clear_deallocating(id obj) 
{
  assert(obj);
  assert(!UseGC);

  if (obj->isTaggedPointer()) return;
  obj->clearDeallocating();
}

void objc_object::sidetable_clearDeallocating()
{
  SideTable& table = SideTables()[this];

  // clear any weak table items
  // clear extra retain count and deallocating bit
  // (fixme warn or abort if extra retain count == 0 ?)
  table.lock();
  // 迭代器
  RefcountMap::iterator it = table.refcnts.find(this);
  if (it != table.refcnts.end()) {
    if (it->second & SIDE_TABLE_WEAKLY_REFERENCED) {
      weak_clear_no_lock(&table.weak_table, (id)this);
    }
    table.refcnts.erase(it);
  }
  table.unlock();
}

void weak_clear_no_lock(weak_table_t *weak_table, id referent_id) 
{
  objc_object *referent = (objc_object *)referent_id;

  weak_entry_t *entry = weak_entry_for_referent(weak_table, referent);
  if (entry == nil) {
    /// XXX shouldn't happen, but does with mismatched CF/objc
    //printf("XXX no entry for clear deallocating %p\n", referent);
    return;
  }

  // zero out references
  weak_referrer_t *referrers;
  size_t count;

  if (entry->out_of_line) {
    referrers = entry->referrers;
    count = TABLE_SIZE(entry);
  } 
  else {
    referrers = entry->inline_referrers;
    count = WEAK_INLINE_COUNT;
  }

  for (size_t i = 0; i < count; ++i) {
    objc_object **referrer = referrers[I];
    if (referrer) {
      if (*referrer == referent) {
        *referrer = nil;
      }
      else if (*referrer) {
        _objc_inform("__weak variable at %p holds %p instead of %p. "
               "This is probably incorrect use of "
               "objc_storeWeak() and objc_loadWeak(). "
               "Break on objc_weak_error to debug.\n", 
               referrer, (void*)*referrer, (void*)referent);
        objc_weak_error();
      }
    }
  }

  weak_entry_remove(weak_table, entry);
}