在Dynamic-Link程式庫中使用執行緒本機儲存體

發行項
06/13/2023

本節說明如何使用 DLL 進入點函式來設定執行緒本機儲存體 (TLS) 索引，為多執行緒進程的每個執行緒提供私人儲存體。

TLS 索引會儲存在全域變數中，使其可供所有 DLL 函式使用。此範例假設 DLL 的全域資料不會共用，因為載入 DLL 的每個進程不一定都一樣 TLS 索引。

進入點函式會使用 TlsAlloc 函式，在進程載入 DLL 時配置 TLS 索引。然後，每個執行緒都可以使用此索引來儲存其本身記憶體區塊的指標。

使用 DLL_PROCESS_ATTACH 值呼叫進入點函式時，程式碼會執行下列動作：

使用 TlsAlloc 函式來配置 TLS 索引。
配置記憶體區塊，供進程的初始執行緒獨佔使用。
使用 TlsSetValue 函式呼叫中的 TLS 索引，將記憶體區塊的位址儲存在與索引相關聯的 TLS 位置中。

每次進程建立新的執行緒時，都會使用 DLL_THREAD_ATTACH 值呼叫進入點函式。進入點函式接著會配置新執行緒的記憶體區塊，並使用 TLS 索引來儲存其指標。

當函式需要存取與 TLS 索引相關聯的資料時，請在 對 TlsGetValue 函式的呼叫中指定索引。這會擷取呼叫執行緒的 TLS 位置內容，在此情況下是資料的記憶體區塊指標。當進程使用此 DLL 的載入時間連結時，進入點函式就足以管理執行緒本機儲存體。使用執行時間連結的程式可能會發生問題，因為呼叫 LoadLibrary 函式之前，不會針對存在的執行緒呼叫進入點函式，因此不會為這些執行緒配置 TLS 記憶體。如果值指出未設定此執行緒的 TLS 位置，則此範例會檢查 TlsGetValue 函式傳回的值，並配置記憶體，以解決此問題。

當每個執行緒不再需要使用 TLS 索引時，它必須釋放其指標儲存在 TLS 位置中的記憶體。當所有線程都使用 TLS 索引完成時，請使用 TlsFree 函式釋放索引。

當執行緒終止時，會使用DLL_THREAD_DETACH值呼叫進入點函式，並釋放該執行緒的記憶體。當進程終止時，會使用DLL_PROCESS_DETACH值呼叫進入點函式，並釋放 TLS 索引中指標所參考的記憶體。

// The DLL code

#include <windows.h>

static DWORD dwTlsIndex; // address of shared memory
 
// DllMain() is the entry-point function for this DLL. 
 
BOOL WINAPI DllMain(HINSTANCE hinstDLL, // DLL module handle
    DWORD fdwReason,                    // reason called
    LPVOID lpvReserved)                 // reserved
{ 
    LPVOID lpvData; 
    BOOL fIgnore; 
 
    switch (fdwReason) 
    { 
        // The DLL is loading due to process 
        // initialization or a call to LoadLibrary. 
 
        case DLL_PROCESS_ATTACH: 
 
            // Allocate a TLS index.
 
            if ((dwTlsIndex = TlsAlloc()) == TLS_OUT_OF_INDEXES) 
                return FALSE; 
 
            // No break: Initialize the index for first thread.
 
        // The attached process creates a new thread. 
 
        case DLL_THREAD_ATTACH: 
 
            // Initialize the TLS index for this thread.
 
            lpvData = (LPVOID) LocalAlloc(LPTR, 256); 
            if (lpvData != NULL) 
                fIgnore = TlsSetValue(dwTlsIndex, lpvData); 
 
            break; 
 
        // The thread of the attached process terminates.
 
        case DLL_THREAD_DETACH: 
 
            // Release the allocated memory for this thread.
 
            lpvData = TlsGetValue(dwTlsIndex); 
            if (lpvData != NULL) 
                LocalFree((HLOCAL) lpvData); 
 
            break; 
 
        // DLL unload due to process termination or FreeLibrary. 
 
        case DLL_PROCESS_DETACH: 
 
            // Release the allocated memory for this thread.
 
            lpvData = TlsGetValue(dwTlsIndex); 
            if (lpvData != NULL) 
                LocalFree((HLOCAL) lpvData); 
 
            // Release the TLS index.
 
            TlsFree(dwTlsIndex); 
            break; 
 
        default: 
            break; 
    } 
 
    return TRUE; 
    UNREFERENCED_PARAMETER(hinstDLL); 
    UNREFERENCED_PARAMETER(lpvReserved); 
}

// The export mechanism used here is the __declspec(export)
// method supported by Microsoft Visual Studio, but any
// other export method supported by your development
// environment may be substituted.

#ifdef __cplusplus    // If used by C++ code, 
extern "C" {          // we need to export the C interface
#endif

__declspec(dllexport)
BOOL WINAPI StoreData(DWORD dw)
{
   LPVOID lpvData; 
   DWORD * pData;  // The stored memory pointer 

   lpvData = TlsGetValue(dwTlsIndex); 
   if (lpvData == NULL)
   {
      lpvData = (LPVOID) LocalAlloc(LPTR, 256); 
      if (lpvData == NULL) 
         return FALSE;
      if (!TlsSetValue(dwTlsIndex, lpvData))
         return FALSE;
   }

   pData = (DWORD *) lpvData; // Cast to my data type.
   // In this example, it is only a pointer to a DWORD
   // but it can be a structure pointer to contain more complicated data.

   (*pData) = dw;
   return TRUE;
}

__declspec(dllexport)
BOOL WINAPI GetData(DWORD *pdw)
{
   LPVOID lpvData; 
   DWORD * pData;  // The stored memory pointer 

   lpvData = TlsGetValue(dwTlsIndex); 
   if (lpvData == NULL)
      return FALSE;

   pData = (DWORD *) lpvData;
   (*pdw) = (*pData);
   return TRUE;
}
#ifdef __cplusplus
}
#endif

下列程式碼示範如何使用上一個範例中定義的 DLL 函式。

#include <windows.h> 
#include <stdio.h> 
 
#define THREADCOUNT 4 
#define DLL_NAME TEXT("testdll")

VOID ErrorExit(LPSTR); 

extern "C" BOOL WINAPI StoreData(DWORD dw);
extern "C" BOOL WINAPI GetData(DWORD *pdw);
 
DWORD WINAPI ThreadFunc(VOID) 
{   
   int i;

   if(!StoreData(GetCurrentThreadId()))
      ErrorExit("StoreData error");

   for(i=0; i<THREADCOUNT; i++)
   {
      DWORD dwOut;
      if(!GetData(&dwOut))
         ErrorExit("GetData error");
      if( dwOut != GetCurrentThreadId())
         printf("thread %d: data is incorrect (%d)\n", GetCurrentThreadId(), dwOut);
      else printf("thread %d: data is correct\n", GetCurrentThreadId());
      Sleep(0);
   }
   return 0; 
} 
 
int main(VOID) 
{ 
   DWORD IDThread; 
   HANDLE hThread[THREADCOUNT]; 
   int i; 
   HMODULE hm;
 
// Load the DLL

   hm = LoadLibrary(DLL_NAME);
   if(!hm)
   {
      ErrorExit("DLL failed to load");
   }

// Create multiple threads. 
 
   for (i = 0; i < THREADCOUNT; i++) 
   { 
      hThread[i] = CreateThread(NULL, // default security attributes 
         0,                           // use default stack size 
         (LPTHREAD_START_ROUTINE) ThreadFunc, // thread function 
         NULL,                    // no thread function argument 
         0,                       // use default creation flags 
         &IDThread);              // returns thread identifier 
 
   // Check the return value for success. 
      if (hThread[i] == NULL) 
         ErrorExit("CreateThread error\n"); 
   } 
 
   WaitForMultipleObjects(THREADCOUNT, hThread, TRUE, INFINITE); 

   FreeLibrary(hm);
 
   return 0; 
} 
 
VOID ErrorExit (LPSTR lpszMessage) 
{ 
   fprintf(stderr, "%s\n", lpszMessage); 
   ExitProcess(0); 
}

動態連結程式庫資料
使用執行緒本機儲存體

共用方式為

在Dynamic-Link程式庫中使用執行緒本機儲存體

意見反應

其他資源

共用方式為

在Dynamic-Link程式庫中使用執行緒本機儲存體

相關主題

意見反應

其他資源