12.6 线程私有数据

在分配线程私有数据之前，我们需要创建一个key,用于实现与数据的联系。这个key将用于增加对于线程私有数据的访问。我们可以使用函数pthread_key_create来创建这样一个key.

#include <pthread.h>
int pthread_key_create(pthread_key_t *keyp, void (*destructor)(void *));
    Returns: 0 if OK, error number on failure.

函数创建的key存储在keyp指针指定的内存区域，同一个key可以被同一个进程内的所有线程使用，但是每个线程都将会与这个key关联一个不同的线程私有数据地址,当key创建的时候，每个线程的数据地址被初始化为null值;
上述函数不仅创建了一个key,还关联了一个可选的destructor函数。当线程退出的时候，如果数据地址已经被设置为non-nuil数值，destructor函数将会被调用，并使用其数据地址作为唯一的参数。如果destructor指针是null,那么就不会由destructor函数与key相关联。当线程正常退出的时候，无论是调用函数pthrad_exit还是返回，destructor都会被调用，同样地，如果线程被取消，destructor也会被调用，但是是在最后一个cleanup handler返回之后才被调用，但是如果线程调用函数exit,_exit,_Exit或者是abort，或者是其他的异常退出方式，destructor函数并不会被调用。
线程通常使用malloc函数分配线程私有数据的存储空间，destructor函数通常用于释放之前分配的内存。如果线程退出的时候没有释放之前分配的内存，那么内存就会逐渐泄漏。
一个线程可以为线程私有数据分配多个key.每一个key可以由一个destructor与之关联，可能对于每一个key都有一个不同的destructor函数，或者所有的key使用相同的destructor函数，每一个操作系统实现可能会对一个线程可以分配的key数量进行了限制(在12.2节中提到的PTHREAD_KEYS_MAX).
当线程退出的时候，destructor函数将会按照实现定义的顺序进行调用，destructor函数调用另外的函数创建一个新的线程私有数据并将其与key相关联是可能的。在所有的destructor被调用完成之后，系统会检查是否还有与key相关联的非空线程私有数据指针，如果由，就再次调用destructor函数。进程将会重复这一过程，直到所有的key的所有关联的线程私有数据是null的，或者尝试的调用次数达到最大值PTHREAD_DESTRUCTOR_ITERATIONS(图12.1)。
我们可以使用函数pthread_key_delete来删除所有线程私有数据与指定key的联系。

#include <pthread.h>
int pthread_key_delete(pthread_key_t key);
    Returns: 0 if OK, error number on failure.

需要注意的是，调用函数pthread_key_delete并不会调用析构函数destructor,为了释放与key相关联的线程私有数据，我们需要在应用程序中增加一些额外的步骤。
此外，我们还需要注意我们分配的key不能由于竞态的初始化过程而发生改变。如下所示的程序中，两个线程都可能会调用函数pthread_key_create:

void destructor(void *);
pthread_key_t key;
int init_code = 0;
int threadfunc(void *arg)
{
    if(! init_done)
    {
        init_done = 1;
        err = pthread_key_create(&key, destructor);
    }    
}

与操作系统的调度方式有关，一部分线程可能读取到的是一个key值，但是另一些线程可能读取到的是另外一个不同的值，解决这一竞态条件的方式是调用函数pthtread_once.

#include <pthread.h>
pthread_once_t initflag = PTHREAD_ONCE_INIT;
int pthread_once(pthread_once_t *initflag, void (*initfn)(void));
    Returns: 0 if OK, error number on failure.

注意：：：：：：：：：：：：initflag一定不能是本地变量，可以是全局的或者是静态的，并且需要初始化为数值PTHREAD_ONCE_INIT.
如果一个线程调用了函数pthread_once, 系统就会保证初始化函数Initfn仅仅被调用一次，并且仅仅出现在第一次指定函数pthread_once调用的时候，创建一个key的正确的方法是这样的:

void destructor(void *);
pthread_key_t key;
pthread_once_t init_done = PTHREAD_ONCE_INIT;
void thread_init(void)
{
    err = pthread_key_create(&key, destructor);
}
int threadfunc(void *arg)
{
    pthread_once(&init_done, thread_init);
    ...
}

一旦key创建完成，我们就可以将线程私有数据与key进行关联了，这一步骤需要调用函数pthread_setspecific来完成，同时，我们也可以使用函数pthread_getspecific函数来获取线程私有数据的地址;

#include <pthread.h>
void *pthread_getspecific(pthread_key_t key);
    Returns:thread-specific data value or NULL if no value has been associated with the key.
int pthread_setspecific(pthread_key_t key, const void *value);
    Returns: 0 if OK, error number on failure.

如果没有线程私有数据与key相关联，函数pthread_getspecific就会的返回一个空指针，我们可以利用这一点来决定是否需要调用函数pthread_setspecific.

Example

在图12.11中，我们展示了一个函数getenv的假想的实现;在图12.12中，我们使用一个新的接口实现了相同的功能，并且实现了线程安全。但是如果我们不想要修改接口函数就能实现线程安全呢？在这种情况下，我们可以使用线程私有数据来为每一个线程保存返回的字符串数据，这样的程序入图12.13所示。

#include <limits.h>
#include <string.h>
#include <pthread.h>
#include <stdlib.h>
#define MAXSTRINGSZ 4096
static pthread_key_t key;
static pthread_once_t init_done = PTHREAD_ONCE_INIT;
pthread_mutex_t env_mutex = PTHREAD_MUTEX_INITIALIZER;
extern char **environ;
void thread_init(void)
{
        pthread_key_create(&key, free);
}
char *getenv(const char *name)
{
        int             i,len;
        char            *envbuf;
        pthread_once(&init_done, thread_init);
        pthread_mutex_lock(&env_mutex);
        envbuf = (char *)pthread_getspecific(key);
        if(envbuf == NULL)
        {
                envbuf = malloc(MAXSTRINGSZ);
                if(envbuf == NULL)
                {
                        pthread_mutex_unlock(&env_mutex);
                        return NULL;
                }
                pthread_setspecific(key, envbuf);
        }
        len = strlen(name);
        for(i = 0; environ[i] != NULL; i++)
        {
                if((strncmp(name, environ[i], len) == 0) && (environ[i][len] == ‘=‘))
                {
                        strncpy(envbuf, &environ[i][len+1], MAXSTRINGSZ-1);
                        pthread_mutex_unlock(&env_mutex);
                        return (envbuf);
                }
        }
        pthread_mutex_unlock(&env_mutex);
        return (NULL);
}