【muduo】base篇---ThreadLocal

一、线程特定数据和线程本地存储

  线程本地数据（局部数据/私有数据/线程中特有的线程存储），和__thread类似，虽然__thread简单，但容易不正确使用。

  线程存储：每个线程都有各自的线程存储，直到线程被销毁(或者主动调用函数销毁)。线程存储既不是全局变量（不同的线程有各自的线程存储，而且也不能相互访问）、也不是static变量（线程函数中的static变量可以被多个线程修改）也不是局部变量（局部变量过了作用域之后就失效了）。

二、ThreadLocal源码

#ifndef MUDUO_BASE_THREADLOCAL_H
#define MUDUO_BASE_THREADLOCAL_H

#include <muduo/base/Mutex.h>  // MCHECK
#include <muduo/base/noncopyable.h>

#include <pthread.h>

namespace muduo
{

template<typename T>
class ThreadLocal : noncopyable
{
 public:
  ThreadLocal()
  {
  	// 构造函数创建key，ThreadLocal::destructor为销毁的回调函数
  	// 不论哪个线程调用 pthread_key_create()，所创建的 key 都是所有线程可访问，每个线程都有一份
  	// 但各个线程可根据自己的需要往 key 中填入不同的值，相当于提供了一个同名不同值的变量。
    MCHECK(pthread_key_create(&pkey_, &ThreadLocal::destructor));
  }

  ~ThreadLocal()
  {
    MCHECK(pthread_key_delete(pkey_));
  }
  
 
  T& value()
  {
  	//获取线程特定数据
    T* perThreadValue = static_cast<T*>(pthread_getspecific(pkey_));
    // 返回指针如果是空，说明特定数据还没有创建，则创建特定数据
    if (!perThreadValue) 
    {
      T* newObj = new T();
      MCHECK(pthread_setspecific(pkey_, newObj));
      perThreadValue = newObj;
    }
    // 返回特定数据
    return *perThreadValue;
  }

 private:

  // pthread_key_create函数中设置的清理函数，用来销毁实际数据
  static void destructor(void *x)
  {
    T* obj = static_cast<T*>(x);
    // 检测是否是完全类型
    typedef char T_must_be_complete_type[sizeof(T) == 0 ? -1 : 1];
    T_must_be_complete_type dummy; (void) dummy;
    delete obj;
  }

 private:
  pthread_key_t pkey_;
};

}  // namespace muduo

#endif  // MUDUO_BASE_THREADLOCAL_H

//线程本地存储测试程序
#include <muduo/base/ThreadLocal.h>
#include <muduo/base/CurrentThread.h>
#include <muduo/base/Thread.h>

#include <boost/noncopyable.hpp>
#include <stdio.h>

class Test : boost::noncopyable
{
 public:
  Test()
  {
    printf("tid=%d, constructing %p\n", muduo::CurrentThread::tid(), this);
  }

  ~Test()
  {
    printf("tid=%d, destructing %p %s\n", muduo::CurrentThread::tid(), this, name_.c_str());
  }

  const std::string& name() const { return name_; }
  void setName(const std::string& n) { name_ = n; }

 private:
  std::string name_;
};
//定义两个线程特定数据对象，每个线程都有这样的对象
muduo::ThreadLocal<Test> testObj1;
muduo::ThreadLocal<Test> testObj2;

void print()//打印函数
{
  printf("tid=%d, obj1 %p name=%s\n",muduo::CurrentThread::tid(),&testObj1.value(),testObj1.value().name().c_str());
  printf("tid=%d, obj2 %p name=%s\n",muduo::CurrentThread::tid(),&testObj2.value(),testObj2.value().name().c_str());
}

void threadFunc()
{
  print();
  //testObj1.value()返回的是Test类型的引用
  testObj1.value().setName("changed 1");
  testObj2.value().setName("changed 42");
  print();
}

int main()
{
  testObj1.value().setName("main one");
  print();
  //创建线程，每个线程都有自己的testObj1，testObj2
  muduo::Thread t1(threadFunc);
  t1.start();//启动线程
  t1.join();
  testObj2.value().setName("main two");
  print();

  pthread_exit(0);//退出主线程
}