浅谈chromium中的指针管理

转载自：http://www.starwd.com/?p=164

前言

在大型C++系统中对指针的管理通常至关重要，这跟对象的生命周期相关，存在如下方面的考虑：

• 如何确保指针所指向的对象是在适当范围内是始终存在的？
• 如何构建一种机制，确保能正确检测指针所指向对象是否有效？

在chromium中对这类问题分别采用智能指针Scoped_refptr和弱指针WeakPtr来实现。

Scoped_refptr

Scoped_refptr 在智能指针scoped_ptr基础之上增加了引用计数功能，但尤其需要注意的是，引用计数的功能并不是由scoped_refptr提供的，而是由scoped_refptr对象本身提供的，也就说使用scoped_refptr的对象必须具备引用计数功能。Chromium中的引用计数功能由RefCouneted类提供，获取引用计数功能可以如下定义该类：

Class MyClass ： public RefCounted { ….}

Scoped_refptr 实现大致如下：

• 重载了*、-> 操作符，使之具备指针一样的功能，即像使用指针一样的使用Scoped_refptr对象，但Scoped_refptr对象一般在在栈中分配，在其作用域外自动释放；
• 重载了 = 赋值运算符，这样确保每次scoped_refptr 的每次传递、或者其所指对象被赋值给新的scoped_refptr对象时都能导致计数加1；
• 一般来说scoped_refptr 所包含的对象初始引用计数为0；但将其放入scoped_refptr时会导致引用计数+1；
• Release()函数代表所有权的转移；即scoped_refptr里保存的对象指针被赋值为NULL；返回对象指向的引用计数维持不变；
• 引用计数为0是删除scoped_refptr所包含的对象

Chromium 中Scoped_refptr使用场景一般为明确为某一线程所拥有的对象、或者某一类聚合的另一个类。对于跨线程使用的对象场合，一般使用弱指针。

Weakptr

在chromium的多线程模型里，对象通常被不同的线程访问，这就牵涉到线程同步问题；传统方法采用锁机制，关于锁机制的优劣参见Chrome源码剖析。 chromium的多线程模型实现的一个基本原则是：尽量规避锁；采取的策略则是task机制。见下图：

假设如下场景，A线程需要B线程做一些事情，然后回到A线程继续做一些事情；在chromium下你可以这样来做：生成一个Task，放到B线程的队列中，在该Task的Run方法最后，会生成另一个Task，这个Task会放回到A的线程队列，由A来执行。在该模型中一个最核心的问题就是task传递、运行过程中所涉及的对象、数据的安全性问题。在考虑上述的场景，线程A委托给线程B task1 ，task1运行需要访问对象object1；同样，线程B委托给线程A task2，task2 需要访问对象object2. 由于线程都采用消息队列机制，即轮询task队列方式实现。这就可能存在如下问题：

• 线程B 运行 task1时 object1已经被其他线程销毁；
• 线程A运行task2是 object2已经被其他线程销毁；

这里你可以说如果我使用引用计数机制，确保object1和object2都不会被销毁当然可以解决问题。但更多的情况下我们可能需要的另一种情况，即取消task1、task2的运行。例如UI线程委托IO线程下载某个资源时，用户刷新了当前网页，显然这时IO线程的下载task应取消。这个问题的核心就是：如何构建一种机制，确保能正确监测指针所指向对象是否有效；也就是如果其实线程B检测到Object1已经无效了，则自动取消task1的运行。这实质也是weakptr 弱指针的所需要解决的问题。

在谈论weakptr之前，我们先来探讨现实中一般如何解决这类问题。如果这个时候，存在一个第三方认证机构C，A和B能够通过向机构C来查询获取某个object的状态来确定是否执行某个task，这样问题就既然就得以解决了。实质上，这也是weakptr所采取的方法。先看weakptr的定义：

Template<class T>  
Class  Weakptr : public internal::WeakPtrBase {
// …….
T* ptr；
}；
Class WeakPtrBase {
Protected：
WeakReference ref_;
}

显然WeakPtr 弱指针除了包括所指对象的指针外，还包括一个额外的弱应用 WeakReference ref_。ref_可以看作是对第三方机构C的引用，即通过判断ref_是否有效来判定WeakPtr所保存的指针ptr是否有效。下面是WeakReference的定义：

class WeakReference {
public:
class Flag : public RefCounted, public NonThreadSafe {
public:
Flag(Flag** handle);
~Flag();
 
void AddRef() const;
void Release() const;
void Invalidate() { handle_ = NULL; }
bool is_valid() const { return handle_ != NULL; }
 
void DetachFromThread() { NonThreadSafe::DetachFromThread(); }
 
private:
Flag** handle_;
};
WeakReference();
WeakReference(Flag* flag);
~WeakReference();
 
bool is_valid() const;
 
private:
scoped_refptr flag_;
}

由上面定义可知有效性的检测实质由WeakReference内的Flag对象提供。接下来问题就是第三方机构C如何建立？ WeakReference ref_ 又如何使用它呢？这牵涉到类WeakReferenceOwner和WeakPtrFactory。 这里有一个事实应首先清楚：在上面的场景中 Object1可能被task1所使用、也可能被task2、… taskN所使用，而且这些task可能还在不同的线程中运行。因此为确保所有线程运行这些task时都能检测到Object1是否有效，显然这里要求WeakReference ref_ 所实质引用的对象是同一个，而且要确保该对象的生命周期可能长于Object1，即Object1被销毁了它还存在。 类WeakReferenceOwner 顾名思义，是WeakReference的owner，即它用于保证所有相关WeakPtr 中WeakReference ref_引用的是同一个对象，具体到Chromium中即为同一个Flag对象。见WeakReferenceOwner::GetRef()的实现：

WeakReference WeakReferenceOwner::GetRef() const {
if (!flag_)
flag_ = new WeakReference::Flag(&flag_);
return WeakReference(flag_);
}

接下来的问题就是如何创建WeakPtr对象，显然这里应有如下两个需求：

• 创建出来的WeakPtr跟实质所包含的对象是相关的，即设置ptr指针；
• WeakReference ref_ 最终所引用的flag 是同一个。

这通过WeakPtrFactory 实现，WeakPtrFactory用于创建某个Object的Weakptr，定义如下：

template <typename T>
class WeakPtrFactory {
 public:
  explicit WeakPtrFactory(T* ptr) : ptr_(ptr) {
  }
 
  WeakPtr GetWeakPtr() {
    return WeakPtr(weak_reference_owner_.GetRef(), ptr_);
  }
 
  // Call this method to invalidate all existing weak pointers.
  void InvalidateWeakPtrs() {
    weak_reference_owner_.Invalidate();
  }
 
  // Call this method to determine if any weak pointers exist.
  bool HasWeakPtrs() const {
    return weak_reference_owner_.HasRefs();
  }
 
 private:
  internal::WeakReferenceOwner weak_reference_owner_;
  T* ptr_;
  DISALLOW_IMPLICIT_CONSTRUCTORS(WeakPtrFactory);
}

WeakPtrFactory 聚合了WeakReferenceOwner，用于保证指向同一个Flag。对于WeakPtrFactory的使用，可以在 相关Object中聚合一个该WeakPtrFactory， 这样可以直接通过Object的某个方法来获取其WeakPtr对象，例如：

Object1->weakptrfactory()->GetWeakPtr();

同时在Object的析构函数中调用WeakPtrFactory的InvalidateWeakPtrs函数，来使其Flag无效，最终供WeakPtr使用者检测其有效性。 对于另一个问题，如何确保所有WeakReference ref_ 所引用的Flag对象的生命周期长于Object本身，即Object销毁时它仍然存在，直到所有的WeakReference ref_都销毁时。显然，从Flag的定义可以看出，采用引用计数方式即可。关于WeakPtr的关系见下图：

参考文献

http://www.cnblogs.com/duguguiyu/archive/2008/10/02/1303095.html

/*一、本文中包括以下几个类:
	RefCountedBase					
		-->为子类增加引用计数,基类的基类,无线程安全
	RefCountedThreadSafeBase		
		-->为子类增加引用计数,基类的基类,有线程安全	
	RefCounted:public RefCountedBase
		-->为子类增加引用计数,基类，线程安全
	RefCountedThreadSafe:public RefCountedThreadSafeBase 
		-->为子类增加引用计数,基类，线程安全
	DefaultRefCountedThreadSafeTraits
		-->为RefCountedThreadSafe提供析构支持
	RefCountedData : public base::RefCounted< base::RefCountedData<T> >
		-->为其它数据增加引用计数
	scoped_refptr
		-->自身有作用域的、其对象带引用计数的 智能指针。出作用域就析构,
		释放自己对对象的引用。
*/



#ifndef BASE_MEMORY_REF_COUNTED_H_
#define BASE_MEMORY_REF_COUNTED_H_

#include <cassert>

#include "base/atomic_ref_count.h"
#include "base/base_export.h"
#include "base/compiler_specific.h"
#include "base/threading/thread_collision_warner.h"

namespace base {

namespace subtle {

class BASE_EXPORT RefCountedBase {
 public://仅有一个引用时返回true
  bool HasOneRef() const { return ref_count_ == 1; }
 protected:
  RefCountedBase();
  ~RefCountedBase();

  void AddRef() const;//增加引用计数
  // Returns true if the object should self-delete.
  bool Release() const;//减少引用计数
 private:
  mutable int ref_count_;
#ifndef NDEBUG
  mutable bool in_dtor_;
#endif

  DFAKE_MUTEX(add_release_);

  DISALLOW_COPY_AND_ASSIGN(RefCountedBase);
};

class BASE_EXPORT RefCountedThreadSafeBase {
 public:
  bool HasOneRef() const;//仅有一个引用时返回true

 protected:
  RefCountedThreadSafeBase();
  ~RefCountedThreadSafeBase();

  void AddRef() const;//增加引用计数,原子地+=1
  // Returns true if the object should self-delete.
  bool Release() const;//增加引用计数,原子地-=1

 private:
  mutable AtomicRefCount ref_count_;
#ifndef NDEBUG
  mutable bool in_dtor_;
#endif

  DISALLOW_COPY_AND_ASSIGN(RefCountedThreadSafeBase);
};

}  // namespace subtle
/*
	对父类接口进行包装，在release时释放自己的内存
*/
template <class T>
class RefCounted : public subtle::RefCountedBase {
 public:
  RefCounted() {}

  void AddRef() const {//直接调用父类的
    subtle::RefCountedBase::AddRef();
  }

  void Release() const {
    if (subtle::RefCountedBase::Release()) {
		//释放内存,引用为0时父类Release返回True
		//会释放内存
      delete static_cast<const T*>(this);
    }
  }

 protected:
  ~RefCounted() {}

 private:
  DISALLOW_COPY_AND_ASSIGN(RefCounted<T>);
};

// Forward declaration.
template <class T, typename Traits> class RefCountedThreadSafe;

/*
	在多线程情况下，用户可通过Traits来确定对象release时的操作,而
	下面这个结构是默认的操作，它将调用RefCountedThreadSafe的
	DeleteInternal来删除RefCountedThreadSafe子类对象，这个有点绕。
 */
template<typename T>
struct DefaultRefCountedThreadSafeTraits {
  static void Destruct(const T* x) { 
    RefCountedThreadSafe<T,
                         DefaultRefCountedThreadSafeTraits>::DeleteInternal(x);
  }
};
 
template <class T, typename Traits = DefaultRefCountedThreadSafeTraits<T> >
class RefCountedThreadSafe : public subtle::RefCountedThreadSafeBase {
 public:
  RefCountedThreadSafe() {}

  void AddRef() const {
	//直接调用父类的
    subtle::RefCountedThreadSafeBase::AddRef();
  }

  void Release() const {
	  //先调用父类的,当引用为0时父类Release函数会返回True
	  //这样的话，会调用释放内存的函数,同时用户可以通过
	  //Traits来参与进来，决定内存怎么释放。
    if (subtle::RefCountedThreadSafeBase::Release()) {
      Traits::Destruct(static_cast<const T*>(this));
    }
  }

 protected:
  ~RefCountedThreadSafe() {}

 private:
  friend struct DefaultRefCountedThreadSafeTraits<T>;
  static void DeleteInternal(const T* x) { delete x; }

  DISALLOW_COPY_AND_ASSIGN(RefCountedThreadSafe);
};

//
// A wrapper for some piece of data so we can place other things in
// scoped_refptrs<>.
// 给一些其它数据增加计数引用
template<typename T>
class RefCountedData : public base::RefCounted< base::RefCountedData<T> > {
 public:
  RefCountedData() : data() {}
  RefCountedData(const T& in_value) : data(in_value) {}

  T data;

 private:
  friend class base::RefCounted<base::RefCountedData<T> >;
  ~RefCountedData() {}
};

}  // namespace base
/*
	scoped_refptr智能指针	
 */
template <class T>
class scoped_refptr {
 public:
  typedef T element_type;
  scoped_refptr() : ptr_(NULL) {//构造
  }
  scoped_refptr(T* p) : ptr_(p) {//构造
    if (ptr_)
      ptr_->AddRef();//子类必须是能引用计数的
  }
  //拷贝构造
  scoped_refptr(const scoped_refptr<T>& r) : ptr_(r.ptr_) {	
    if (ptr_)
      ptr_->AddRef();
  }
  //拷贝构造
  template <typename U>
  scoped_refptr(const scoped_refptr<U>& r) : ptr_(r.get()) {
    if (ptr_)
      ptr_->AddRef();
  }
  //析构,释放本指针的引用,导致对象引用-=1
  ~scoped_refptr() {
    if (ptr_)
      ptr_->Release();
  }
  //返回对象
  T* get() const { return ptr_; }
  operator T*() const { return ptr_; }
  T* operator->() const {
    assert(ptr_ != NULL);
    return ptr_;
  }

  // Release a pointer.
  // The return value is the current pointer held by this object.
  // If this object holds a NULL pointer, the return value is NULL.
  // After this operation, this object will hold a NULL pointer,
  // and will not own the object any more.
  // 本智能指针对象不再拥有object对象指针，将它传给其它智能指针对象
  T* release() WARN_UNUSED_RESULT {
    T* retVal = ptr_;
    ptr_ = NULL;
    return retVal;
  }
  //赋值,接受对象的指针,放弃本智能指针原来拥有的对象,致使原对象引用-=1
  //重新拥有新的对象
  scoped_refptr<T>& operator=(T* p) {
    // AddRef first so that self assignment should work
    if (p)
      p->AddRef();
    T* old_ptr = ptr_;
    ptr_ = p;
    if (old_ptr)
      old_ptr->Release();
    return *this;
  }
  //赋值,复制,将r指针所指的内容赋值给本智能指针
  scoped_refptr<T>& operator=(const scoped_refptr<T>& r) {
    return *this = r.ptr_;
  }
  //赋值,复制,将r指针所指的内容赋值给本智能指针
  template <typename U>
  scoped_refptr<T>& operator=(const scoped_refptr<U>& r) {
    return *this = r.get();
  }
  //swap内部函数
  void swap(T** pp) {
    T* p = ptr_;
    ptr_ = *pp;
    *pp = p;
  }
  //交换两个智能指针内容
  void swap(scoped_refptr<T>& r) {
    swap(&r.ptr_);
  }
  //那个对象,带引用计数的
 protected:
  T* ptr_;
};

// Handy utility for creating a scoped_refptr<T> out of a T* explicitly without
// having to retype all the template arguments
// 返回对象指针的智能指针对象
template <typename T>
scoped_refptr<T> make_scoped_refptr(T* t) {
  return scoped_refptr<T>(t);
}

#endif  // BASE_MEMORY_REF_COUNTED_H_