C++ 线程局部变量thread_local

　　本文转自：https://blog.csdn.net/aguoxin/article/details/103968031

Linux中的线程局部存储（一）

　　本章节转自：https://blog.csdn.net/cywosp/article/details/26469435

　　在Linux系统中使用C/C++进行多线程编程时，我们遇到最多的就是对同一变量的多线程读写问题，大多情况下遇到这类问题都是通过锁机制来处理，但这对程序的性能带来了很大的影响，当然对于那些系统原生支持原子操作的数据类型来说，我们可以使用原子操作来处理，这能对程序的性能会得到一定的提高。

　　那么对于那些系统不支持原子操作的自定义数据类型，在不使用锁的情况下如何做到线程安全呢？本文将从线程局部存储方面，简单讲解处理这一类线程安全问题的方法。

一、数据类型

　　在C/C++程序中常存在全局变量、函数内定义的静态变量以及局部变量，对于局部变量来说，其不存在线程安全问题，因此不在本文讨论的范围之内。全局变量和函数内定义的静态变量，是同一进程中各个线程都可以访问的共享变量，因此它们存在多线程读写问题。

　　在一个线程中修改了变量中的内容，其他线程都能感知并且能读取已更改过的内容，这对数据交换来说是非常快捷的，但是由于多线程的存在，对于同一个变量可能存在两个或两个以上的线程同时修改变量所在的内存内容，同时又存在多个线程在变量在修改的时去读取该内存值，如果没有使用相应的同步机制来保护该内存的话，那么所读取到的数据将是不可预知的，甚至可能导致程序崩溃。

　　如果需要在一个线程内部的各个函数调用都能访问、但其它线程不能访问的变量，这就需要新的机制来实现，我们称之为Static memory local to a thread (线程局部静态变量)，同时也可称之为线程特有数据（TSD: Thread-Specific Data）或者线程局部存储（TLS: Thread-Local Storage）。这一类型的数据，在程序中每个线程都会分别维护一份变量的副本(copy)，并且长期存在于该线程中，对此类变量的操作不影响其他线程。如下图：

二、一次性初始化

　　在讲解线程特有数据之前，先让我们来了解一下一次性初始化。多线程程序有时有这样的需求：不管创建多少个线程，有些数据的初始化只能发生一次。列如：在C++程序中某个类在整个进程的生命周期内只能存在一个实例对象，在多线程的情况下，为了能让该对象能够安全的初始化，一次性初始化机制就显得尤为重要了。——在设计模式中这种实现常常被称之为单例模式（Singleton）。

　　Linux中提供了如下函数来实现一次性初始化：

#include <pthread.h>

// Returns 0 on success, or a positive error number on error

int pthread_once (pthread_once_t *once_control, void (*init) (void));

　　利用参数once_control的状态，函数pthread_once()可以确保无论有多少个线程调用多少次该函数，也只会执行一次由init所指向的由调用者定义的函数。init所指向的函数没有任何参数，形式如下：

void init (void)

{

   // some variables initializtion in here

}

　　另外，参数once_control必须是pthread_once_t类型变量的指针，指向初始化为PTHRAD_ONCE_INIT的静态变量。在C++0x以后提供了类似功能的函数std::call_once ()，用法与该函数类似。使用实例请参考https://github.com/ApusApp/Swift/blob/master/swift/base/singleton.hpp实现。

三、线程局部数据API

　　在Linux中提供了如下函数来对线程局部数据进行操作

#include <pthread.h>

// Returns 0 on success, or a positive error number on error

int pthread_key_create (pthread_key_t *key, void (*destructor)(void *));

 

// Returns 0 on success, or a positive error number on error

int pthread_key_delete (pthread_key_t key);

 

// Returns 0 on success, or a positive error number on error

int pthread_setspecific (pthread_key_t key, const void *value);

 

// Returns pointer, or NULL if no thread-specific data is associated with key

void *pthread_getspecific (pthread_key_t key);

　　函数pthread_key_create()为线程局部数据创建一个新键，并通过key指向新创建的键缓冲区。因为所有线程都可以使用返回的新键，所以参数key可以是一个全局变量（在C++多线程编程中一般不使用全局变量，而是使用单独的类对线程局部数据进行封装，每个变量使用一个独立的pthread_key_t）。destructor所指向的是一个自定义的函数，其格式如下：

void Dest (void *value)

{

    // Release storage pointed to by 'value'

}

　　只要线程终止时与key关联的值不为NULL，则destructor所指的函数将会自动被调用。如果一个线程中有多个线程局部存储变量，那么对各个变量所对应的destructor函数的调用顺序是不确定的，因此，每个变量的destructor函数的设计应该相互独立。

　　函数pthread_key_delete()并不检查当前是否有线程正在使用该线程局部数据变量，也不会调用清理函数destructor，而只是将其释放以供下一次调用pthread_key_create()使用。在Linux线程中，它还会将与之相关的线程数据项设置为NULL。

　　由于系统对每个进程中pthread_key_t类型的个数是有限制的，所以进程中并不能创建无限个的pthread_key_t变量。Linux中可以通过PTHREAD_KEY_MAX（定义于limits.h文件中）或者系统调用sysconf(_SC_THREAD_KEYS_MAX)来确定当前系统最多支持多少个键。Linux中默认是1024个键，这对于大多数程序来说已经足够了。如果一个线程中有多个线程局部存储变量，通常可以将这些变量封装到一个数据结构中，然后使封装后的数据结构与一个线程局部变量相关联，这样就能减少对键值的使用。

　　函数pthread_setspecific()用于将value的副本存储于一数据结构中，并将其与调用线程以及key相关联。参数value通常指向由调用者分配的一块内存，当线程终止时，会将该指针作为参数传递给与key相关联的destructor函数。当线程被创建时，会将所有的线程局部存储变量初始化为NULL，因此第一次使用此类变量前必须先调用pthread_getspecific()函数来确认是否已经于对应的key相关联，如果没有，那么pthread_getspecific()会分配一块内存并通过pthread_setspecific()函数保存指向该内存块的指针。

　　参数value的值也可以不是一个指向调用者分配的内存区域，而是任何可以强制转换为void*的变量值，在这种情况下，先前的pthread_key_create()函数应将参数

　　destructor设置为NULL

　　函数pthread_getspecific()正好与pthread_setspecific()相反，其是将pthread_setspecific()设置的value取出。在使用取出的值前最好是将void*转换成原始数据类型的指针。

四、深入理解线程局部存储机制

　　1. 深入理解线程局部存储的实现有助于对其API的使用。在典型的实现中包含以下数组：

　　一个全局（进程级别）的数组，用于存放线程局部存储的键值信息。pthread_key_create()返回的pthread_key_t类型值只是对全局数组的索引，该全局数组标记为pthread_keys，其格式大概如下：

　　数组的每个元素都是一个包含两个字段的结构，第一个字段标记该数组元素是否在用，第二个字段用于存放针对此键、线程局部存储变的解构函数的一个副本，即destructor函数。

　　每个线程还包含一个数组，存有为每个线程分配的线程特有数据块的指针（通过调用pthread_setspecific()函数来存储的指针，即参数中的value）

　　2. 在常见的存储pthread_setspecific()函数参数value的实现中，大多数都类似于下图的实现。图中假设pthread_keys[1]分配给func1()函数，pthread API为每个函数维护指向线程局部存储数据块的一个指针数组，其中每个数组元素都与图线程局部数据键的实现(上图)中的全局pthread_keys中元素一一对应。

五、小结

　　使用全局变量或者静态变量是导致多线程编程中非线程安全的常见原因。在多线程程序中，保障非线程安全的常用手段之一是使用互斥锁来做保护，这种方法带来了并发性能下降，同时也只能有一个线程对数据进行读写。如果程序中能避免使用全局变量或静态变量，那么这些程序就是线程安全的，性能也可以得到很大的提升。如果有些数据只能有一个线程可以访问，那么这一类数据就可以使用线程局部存储机制来处理，虽然使用这种机制会给程序执行效率上带来一定的影响，但对于使用锁机制来说，这些性能影响将可以忽略。

　　Linux C++的线程局部存储简单实现可参考https://github.com/ApusApp/Swift/blob/master/swift/base/threadlocal.h，更详细且高效的实现可参考Facebook的folly库中的ThreadLocal实现。更高性能的线程局部存储机制就是使用__thread，这将在下一节中讨论。

Linux中的线程局部存储（二）

　　本章节转自：https://blog.csdn.net/cywosp/article/details/26876231

　　在Linux中还有一种更为高效的线程局部存储方法，就是使用关键字__thread来定义变量。__thread是GCC内置的线程局部存储设施（Thread-Local Storage），它的实现非常高效，与pthread_key_t向比较更为快速，其存储性能可以与全局变量相媲美，而且使用方式也更为简单。创建线程局部变量只需简单的在全局或者静态变量的声明中加入__thread说明即可。列如：

    static __thread char t_buf[32] = { '\0'};

    extern __thread int t_val = 0;

　　凡是带有__thread的变量，每个线程都拥有该变量的一份拷贝，且互不干扰。线程局部存储中的变量将一直存在，直至线程终止，当线程终止时会自动释放这一存储。__thread并不是所有数据类型都可以使用的，因为其只支持POD(Plain old data structure)[1]类型，不支持class类型——其不能自动调用构造函数和析构函数。同时__thread可以用于修饰全局变量、函数内的静态变量，但是不能用于修饰函数的局部变量或者class的普通成员变量。另外，__thread变量的初始化只能用编译期常量，例如：

    __thread std::string t_object_1 ("Swift");                   // 错误，因为不能调用对象的构造函数

    __thread std::string* t_object_2 = new std::string (); // 错误，初始化必须用编译期常量

    __thread std::string* t_object_3 = nullptr;                // 正确，但是需要手工初始化并销毁对象

　　除了以上之外，关于线程局部存储变量的声明和使用还需注意一下几点：

　　如果变量声明中使用量关键字static或者extern，那么关键字__thread必须紧随其后。

　　与一般的全局变量或静态变量一样，线程局部变量在声明时可以设置一个初始化值。

　　可以使用C语言取地址符(&)来获取线程局部变量的地址。

　　__thread的使用例子可参考https://github.com/ApusApp/Swift/blob/master/swift/base/logging.cpp的实现及其单元测试对于那些非POD数据类型，如果想使用线程局部存储机制，可以使用对pthread_key_t封装的类来处理，具体方式可参考https://github.com/ApusApp/Swift/blob/master/swift/base/threadlocal.h的实现以及其的单元测试。

c++ 线程局部变量thread_local

　　本章节转自：https://blog.csdn.net/d_guco/article/details/86562943

　　c++11 中添加了新的关键字thread_local,用来声明新的存储期(线程存储期变量)，即线程局部变量。

　　存储类指定符是名称声明语法的 decl-specifier-seq 的一部分。与名称的作用域一同，它们控制名称的二个独立属性：其“存储期”与其“链接”。auto - 自动存储期(C++11 起)。register - 自动存储期。亦提示编译器将此对象置于处理器的寄存器。C++17 前(弃用),static - 静态或线程存储期和内部链接。extern - 静态或线程存储期和外部链接,thread_local - 线程存储期。

存储期

　　程序中的所有对象拥有下列存储期之一：

　　1 自动存储期。对象的存储在外围代码块开始时分配，而在结束时解分配。除了声明为 static 、 extern 或 thread_local 的所有局部对象拥有此存储期。

　　2 静态存储期。对象的存储在程序开始时分配，而在程序结束时解分配。只存在对象的一个实例。所有声明于命名空间作用域（包含全局命名空间）的对象，加上声明带有 static 或 extern 的对象拥有此存储期。

　　3 线程存储期。对象的存储在线程开始时分配，而在线程结束时解分配。每个线程拥有其自身的对象实例。唯有声明为 thread_local 的对象拥有此存储期。 thread_local 能与 static 或 extern 一同出现，以调整链接。

　　4 (C++11 起)动态存储期。通过使用动态内存分配函数，由请求分配和解分配对象的存储。

什么是thread_local

　　关于thread_local。thread_specific_ptr代表了一个全局的变量,而在每个线程中都各自new一个线程本地的对象交给它进行管理,这样,各个线程就可以各自独立地访问这个全局变量的本地存储版本,线程之间就不会因为访问同一全局对象而引起资源竞争导致性能下降。而线程结束时,这个资源会被自动释放。

　　C++11的thread_local来自于boost thread_specific_ptr。

#include <iostream>

#include <string>

#include <thread>

#include <mutex>

 

thread_local unsigned int rage = 1;

std::mutex cout_mutex;

 

void increase_rage(const std::string& thread_name)

{

    ++rage; // 在锁外修改 OK ；这是线程局域变量

    std::lock_guard<std::mutex> lock(cout_mutex);

    std::cout << "Rage counter for " << thread_name << ": " << rage << '\n';

}

 

int main()

{

    std::thread a(increase_rage, "a"), b(increase_rage, "b");

    {

        std::lock_guard<std::mutex> lock(cout_mutex);

        std::cout << "Rage counter for main: " << rage << '\n';

    }

    a.join();

    b.join();

}

/*

Rage counter for a: 2

Rage counter for main: 1

Rage counter for b: 2

*/

　　我们可以看到，声明为线程存储期的变量，每个线程之间互不影响，通俗的讲我们可以认为每个线程拥有此变量的一个副本，每个线程之前互不影响，其底层的原理Linux中的线程局部存储等提供的api接口。