【技术分享】线程本地存储（Thread Local Storage, TLS）

开源项目：https://girakoo.com/

官方文档：https://learn.microsoft.com/en-us/windows/win32/procthread/using-thread-local-storage

简介

线程本地存储（TLS），可以使多个线程，通过TlsGetValue函数，获得各自线程独立的数据。

即，在进程中通过TlsAlloc，可以申请一个索引值（index）。
在不同的线程中，通过TlsSetValue/TlsGetValue，可以获得不同的数据。
注：TlsSetValue/TlsGetValue内部可能是通过线程ID进行了绑定，实现的功能。

官方示例（改）

#include <windows.h>
#include <stdio.h>

#define THREADCOUNT 4
DWORD dwTlsIndex;

VOID ErrorExit(LPCSTR message);
VOID CommonFunc(VOID);
DWORD WINAPI ThreadFunc(VOID);

// main入口函数
int main(VOID)
{
    DWORD IDThread;
    HANDLE hThread[THREADCOUNT];
    int i;

    // 通过TlsAlloc函数，创建进程的tls索引，保存在dwTlsIndex
    if ((dwTlsIndex = TlsAlloc()) == TLS_OUT_OF_INDEXES)
    {
        // 如果返回TLS_OUT_OF_INDEXES，说明创建失败
        ErrorExit("TlsAlloc failed");
    }    

    // 通过for循环创建多个线程
    for (i = 0; i < THREADCOUNT; i++)
    {
        hThread[i] = CreateThread(NULL,                               // 默认security属性
                                  0,                                  // 默认stack size
                                  (LPTHREAD_START_ROUTINE)ThreadFunc, // 线程处理函数
                                  NULL,                               // no thread function argument
                                  0,                                  // use default creation flags
                                  &IDThread);                         // returns thread identifier

        // 判定创建线程结果
        if (hThread[i] == NULL)
            ErrorExit("CreateThread error\n");
    }

    // 等待所有线程执行完毕，退出循环
    for (i = 0; i < THREADCOUNT; i++)
        WaitForSingleObject(hThread[i], INFINITE);

    TlsFree(dwTlsIndex);

    return 0;
}

VOID ErrorExit(LPCSTR message)
{
    // 输出线程错误消息，并退出进程
    fprintf(stderr, "%s\n", message);
    ExitProcess(0);
}

VOID CommonFunc(VOID)
{
    LPVOID lpvData;

    // 取得dwTlsIndex指向的空间（此时获得的数据是各自线程通过TlsSetValue设置进去的）
    lpvData = TlsGetValue(dwTlsIndex);
    if ((lpvData == 0) && (GetLastError() != ERROR_SUCCESS))
        ErrorExit("TlsGetValue error");

    // 可以使用该空间数据
    printf("common: thread %d: lpvData=%lx\n",
           GetCurrentThreadId(), lpvData);

    Sleep(5000);
}

DWORD WINAPI ThreadFunc(VOID)
{
    LPVOID lpvData;

    // 申请动态空间，每个线程创建独自的空间。
    lpvData = (LPVOID)LocalAlloc(LPTR, 256);

    // 将动态空间绑定到Tls对应的Index空间上
    if (!TlsSetValue(dwTlsIndex, lpvData))
        ErrorExit("TlsSetValue error");

    printf("thread %d: lpvData=%lx\n", GetCurrentThreadId(), lpvData);

    // 通用处理函数，可以在内部使用TlsGetValue获得的数值
    CommonFunc();

    // 释放动态空间，每个线程创建独自的空间。
    lpvData = TlsGetValue(dwTlsIndex);
    
    if (lpvData != 0)
        LocalFree((HLOCAL)lpvData);

    return 0;
}