被 C# 的 ThreadStatic 標記的靜態變量,都存放在哪裡了?

2021-02-16 DotNet

（給DotNet加星標，提升.Net技能）

cnblogs.com/huangxincheng/p/14028567.html

一、背景

1、講故事

有一位朋友留言說，你windbg玩的溜，能幫我分析下被 ThreadStatic 修飾的變量到底存放在哪裡嗎？能不能幫我挖出來，其實這個問題問的挺深的，玩高級語言的朋友相信很少有接觸到這個的，雖然很多朋友都知道這個特性怎麼用，當然我也沒特別研究這個，既然要回答這個問題，我得研究研究回答之！為了更好的普適性，先從簡單的說起！

二、ThreadStatic 的用法

1、普通的 static 變量

相信很多朋友在代碼中都使用過 static 變量，它的好處多多，比如說我經常會用 static 去做一個進程級緩存，從而提高程序的性能，當然你也可以作為一個非常好的一級緩存，如下代碼：

public class Test
{
public static Dictionary<int, string> cachedDict = new Dictionary<int, string>();
}

剛才我也說到了，這是一個進程級的緩存，多個線程都看得見，所以在多線程的環境下，你需要特別注意同步的問題。要麼使用鎖，要麼使用 ConcurrentDictionary，我覺得這也是一個思維定式，很多時候思維總是在現有基礎上去修補，去亡羊補牢，而沒有跳出這個思維從根基上去處理，說這麼多是什麼意思呢？我舉一個例子：

在市面上常見的鏈式跟蹤框架中，比如說：Zikpin，SkyWalking，會使用一些集合去存儲跟蹤當前線程的一些鏈路信息，比如說 A -> B -> C -> D -> B -> A，常規的思維就像上面說的一樣，定義一個全局 cachedDict，然後使用各種同步機制，其實你也可以降低 cachedDict 的訪問作用域，將 全局訪問 改成 Thread級訪問，這難道不是更好的解決思路嗎？

2、用 ThreadStatic 標記 static 變量

要想做到 Thread級作用域，實現起來非常簡單，在 cachedDict 上打一個 ThreadStatic 特性即可，修改代碼如下：

public class Test
{
[ThreadStatic]
public static Dictionary<int, string> cachedDict = new Dictionary<int, string>();
}

接下來可以開多個線程給 cachedDict 灌數據，看看 dict 是不是 Thread級作用域，實現代碼如下：

class Program
{
static void Main(string[] args)
{
var task1 = Task.Run(() =>
{
if (Test.cachedDict == null) Test.cachedDict = new Dictionary<int, string>();
Test.cachedDict.Add(1, "mary");
Test.cachedDict.Add(2, "john");
Console.WriteLine($"thread={Thread.CurrentThread.ManagedThreadId} 的 dict 有記錄: {Test.cachedDict.Count}");
});
var task2 = Task.Run(() =>
{
if (Test.cachedDict == null) Test.cachedDict = new Dictionary<int, string>();
Test.cachedDict.Add(3, "python");
Test.cachedDict.Add(4, "jaskson");
Test.cachedDict.Add(5, "elen");
Console.WriteLine($"thread={Thread.CurrentThread.ManagedThreadId} 的 dict 有記錄: {Test.cachedDict.Count}");
});
Console.ReadLine();
}
}
public class Test
{
[ThreadStatic]
public static Dictionary<int, string> cachedDict = new Dictionary<int, string>();
}

從結果來看，確實是一個 Thread 級，而且還避免了線程間同步開銷，哈哈😄，這麼神奇的東西，難怪有讀者想看看底層到底是怎麼實現的。

三、用 Windbg 挖 ThreadStatic

1、對 TEB 和 TLS 的認識

每一個線程都有一份屬於自己專屬的私有數據，這些數據就放在 Thread 的 TEB 中，如果你想看的話，可以在 windbg 中列印出來。

0:000> !teb
TEB at 0000001e1cdd3000
ExceptionList: 0000000000000000
StackBase: 0000001e1cf80000
StackLimit: 0000001e1cf6e000
SubSystemTib: 0000000000000000
FiberData: 0000000000001e00
ArbitraryUserPointer: 0000000000000000
Self: 0000001e1cdd3000
EnvironmentPointer: 0000000000000000
ClientId: 0000000000005980 . 0000000000005aa8
RpcHandle: 0000000000000000
Tls Storage: 000001b599d06db0
PEB Address: 0000001e1cdd2000
LastErrorValue: 0
LastStatusValue: c0000139
Count Owned Locks: 0
HardErrorMode: 0

從 teb 的結構中可以看出，既有 線程本地存儲(TLS)，也有異常相關信息的存儲 (ExceptionList) 等等相關信息。

進程會在啟動後給 TLS 分配總共 1088 個槽位，每個線程都會分配一個專屬的 tlsindex 索引，並且擁有一組 slots 槽位，可以用 windbg 去驗證一下。

0:000> !tls
Usage:
tls <slot> [teb]
slot: -1 to dump all allocated slots
{0-0n1088} to dump specific slot
teb: <empty> for current thread
0 for all threads in this process
<teb address> (not threadid) to dump for specific thread.
0:000> !tls -1
TLS slots on thread: 5980.5aa8
0x0000 : 0000000000000000
0x0001 : 0000000000000000
0x0002 : 0000000000000000
0x0003 : 0000000000000000
0x0004 : 0000000000000000
...
0x0019 : 0000000000000000
0x0040 : 0000000000000000
0:000> !t Lock
DBG ID OSID ThreadOBJ State GC Mode GC Alloc Context Domain Count Apt Exception
0 1 5aa8 000001B599CEED90 2a020 Preemptive 000001B59B9042F8:000001B59B905358 000001b599cdb130 1 MTA
5 2 90c 000001B599CF4930 2b220 Preemptive 0000000000000000:0000000000000000 000001b599cdb130 0 MTA (Finalizer)
7 3 74 000001B59B7272A0 102a220 Preemptive 0000000000000000:0000000000000000 000001b599cdb130 0 MTA (Threadpool Worker)
9 4 2058 000001B59B7BAFF0 1029220 Preemptive 0000000000000000:0000000000000000 000001b599cdb130 0 MTA (Threadpool Worker)

從上面的 {0-0n1088} to dump specific slot 中可以看出，進程中總會有 1088 個槽位，而且當前主線程 5aa8 擁有 27 個 slot 槽位。

好了，基本概念介紹完了，接下來準備分析一下彙編代碼了。

2、從彙編代碼中尋找答案

為了更好的用 windbg 去挖，我就定義一個簡單的 ThreadStatic int 變量，代碼如下：

class Program
{
[ThreadStatic]
public static int i = 0;
static void Main(string[] args)
{
i = 10; // 12 line
var num = i;
Console.ReadLine();
}
}

接下來用 !U 反彙編一下 Main 函數的代碼，著重看一下第 12 行代碼的 i = 10;。

0:000> !U /d 00007ffbe0ae0ffb
E:\net5\ConsoleApp5\ConsoleApp5\Program.cs @ 12:
00007ffb`e0ae0fd6 48b9b0fbb7e0fb7f0000 mov rcx,7FFBE0B7FBB0h
00007ffb`e0ae0fe0 ba01000000 mov edx,1
00007ffb`e0ae0fe5 e89657a95f call coreclr!JIT_GetSharedNonGCThreadStaticBase (00007ffc`40576780)
00007ffb`e0ae0fea c7401c0a000000 mov dword ptr [rax+1Ch],0Ah

從彙編指令上來看，最後的 10 賦給了 rax+1Ch 的低32位，那 rax 的地址從哪裡來的呢？可以看出核心邏輯在 JIT_GetSharedNonGCThreadStaticBase 方法內，接下來就得研究一下這個方法都幹嘛了。

3、調試核心函數 JIT_GetSharedNonGCThreadStaticBase

接下來在第 12 處設置一個斷點 !bpmd Program.cs:12 處，方法的簡化彙編代碼如下：

coreclr!JIT_GetSharedNonGCThreadStaticBase:
00007ffc`2c38679a 448b0dd7894300 mov r9d, dword ptr [coreclr!_tls_index (00007ffc`2c7bf178)]
00007ffc`2c3867a1 654c8b042558000000 mov r8, qword ptr gs:[58h]
00007ffc`2c3867aa b908000000 mov ecx, 8
00007ffc`2c3867af 4f8b04c8 mov r8, qword ptr [r8+r9*8]
00007ffc`2c3867b3 4e8b0401 mov r8, qword ptr [rcx+r8]
00007ffc`2c3867b7 493b8060040000 cmp rax, qword ptr [r8+460h]
00007ffc`2c3867be 732b jae coreclr!JIT_GetSharedNonGCThreadStaticBase+0x6b (00007ffc`2c3867eb)
00007ffc`2c3867c0 4d8b8058040000 mov r8, qword ptr [r8+458h]
00007ffc`2c3867c7 498b04c0 mov rax, qword ptr [r8+rax*8]
00007ffc`2c3867cb 4885c0 test rax, rax
00007ffc`2c3867ce 741b je coreclr!JIT_GetSharedNonGCThreadStaticBase+0x6b (00007ffc`2c3867eb)
00007ffc`2c3867d0 8bca mov ecx, edx
00007ffc`2c3867d2 f644011801 test byte ptr [rcx+rax+18h], 1
00007ffc`2c3867d7 7412 je coreclr!JIT_GetSharedNonGCThreadStaticBase+0x6b (00007ffc`2c3867eb)
00007ffc`2c3867d9 488b4c2420 mov rcx, qword ptr [rsp+20h]
00007ffc`2c3867de 4833cc xor rcx, rsp
00007ffc`2c3867e1 e89a170600 call coreclr!__security_check_cookie (00007ffc`2c3e7f80)
00007ffc`2c3867e6 4883c438 add rsp, 38h
00007ffc`2c3867ea c3 ret

接下來我仔細分析下這裡的 mov 操作。

1) dword ptr [coreclr!_tls_index (00007ffc`2c7bf178)]

這個很簡單，獲取該線程專屬的 tls_index 索引

2) qword ptr gs:[58h]

這裡的 gs:[58h] 是什麼意思呢？應該有朋友知道，gs寄存器 是專門用於存放當前線程的 teb 地址，後面的 58 表示在 teb 地址上的偏移量，那問題來了，這個地址到底指向誰了呢？其實你可以把 teb 的數據結構給列印出來就明白了。

0:000> dt teb
coreclr!TEB
+0x000 NtTib : _NT_TIB
+0x038 EnvironmentPointer : Ptr64 Void
+0x040 ClientId : _CLIENT_ID
+0x050 ActiveRpcHandle : Ptr64 Void
+0x058 ThreadLocalStoragePointer : Ptr64 Void
+0x060 ProcessEnvironmentBlock : Ptr64 _PEB
...

上面這句 +0x058 ThreadLocalStoragePointer : Ptr64 Void 可以看出，其實就是指向 ThreadLocalStoragePointer 。

3) qword ptr [r8+r9*8]

有了前兩步的基礎，這句彙編就很簡單了，它做了一個索引操作: ThreadLocalStoragePointer[tls_index] ，對不對，從而獲取屬於該線程的 tls 內容，這個 ThreadStatic 的變量就會存放在這個數組的某一個內存塊中。

後續還有一些計算偏移的邏輯運算都基於這個 ThreadLocalStoragePointer[tls_index] 之上，方法調用繞來繞去，彙編沒法看哈 

四、總結

總的來說，可以確定 ThreadStatic 變量 確實是存放在 TEB 的 ThreadLocalStoragePointer 數組中，這幾天 NET5 的 CoreCLR 沒有編譯成功，大家如果感興趣，可以 調試 CoreCLR + 彙編 做更深入的挖掘！

- EOF -

看完本文有收穫？請轉發分享給更多人

推薦關注「DotNet」，提升.Net技能 

點讚和在看就是最大的支持❤️

相關焦點

  • C語言 | static靜態變量
    當然是每天都練習一道C語言題目！！作者閆小林白天搬磚，晚上做夢。我有故事，你有酒麼？例87：學習C語言static定義靜態變量的用法。 解題思路：在C語言中，static 不僅可以用來修飾變量，還可以用來修飾函數，使用 static 修飾的變量，稱為靜態變量。靜態變量的存儲方式與全局變量一樣，都是靜態存儲方式。
  • PHP static局部靜態變量和全局靜態變量總結
    靜態局部變量的特點：1.不會隨著函數的調用和退出而發生變化，不過，儘管該變量還繼續存在，但不能使用它。
  • Java中的static關鍵字和靜態變量、靜態方法
    作者： Java進階者 來源：Java進階學習交流一、static關鍵字使用static修飾的變量和方法分別稱為類變量(或稱靜態變量)和類方法(或稱靜態方法)，沒有使用static修飾的變量和方法分別稱為實例變量和實例方法
  • C語言初學靜態變量的使用
    #C語言初學#在敲代碼時候在定義變量前面有時候會有static修飾，有什麼用呢？我就假假的自問自答一波，畢竟也看過書。在C語言中內存是分了五個區的代碼區，常量區，全局數據區，堆區，棧區。靜態變量就存放在全局數據區。
  • C語言全局變量存放在哪裡?
    全局變量的作用域是從全局變量定義的位置到本源文件結束都有效。我們先看一下全局變量在反彙編中是怎麼體現的，如示例示例代碼CH07_3_4。，佔用靜態的存儲單元。說到靜態的存儲單元，這裡還要提一下全局變量分為：全局變量和靜態全局變量。全局變量的定義請看示例代碼CH07_3_4，而靜態全局變量，只是在int i = 2;前加static關鍵字。書寫形式：static int i =2;全局變量與靜態全局變量有什麼區別？
  • 在.NET中,C#靜態類使用static定義,什麼是靜態?如何使用它?
    如果也將班級號、學校放在實例對象中，則會造成重複浪費，所有的學生個體中都有一個班級號，且值是相同的。此時，為了解決這個浪費的問題，可以使用C#靜態來實現，將所有具體的對象具有共同屬性，且值也相同單獨拿出來，當成靜態的，這樣靜態的可供所有對象訪問，這樣就存在一個班級號即可，所有學生共享。2.
  • 深入理解靜態變量
    static char* msg = "Hello";char* GetMsg(){ return msg;}printf("%s\r\n",GetMsg());編譯器編譯階段將全局靜態變量進行處理，在連結階段時候，其他文件便不能夠訪問本文件中的全局靜態變量了,會產生報錯。
  • 深入分析Java中的關鍵字static
    要理解static為什麼會有上面的特性，首先我們還需要從jvm內存說起。我們先給出一張java的內存結構圖，然後通過案例描述一下static修飾的變量存放在哪？從上圖我們可以發現，靜態變量存放在方法區中，並且是被所有線程所共享的。這裡要說一下java堆，java堆存放的就是我們創建的一個個實例變量。
  • 親妹都能學會的 static 關鍵字
    01、靜態變量「如果在聲明變量的時候使用了 static 關鍵字，那麼這個變量就被稱為靜態變量。靜態變量只在類加載的時候獲取一次內存空間，這使得靜態變量很節省內存空間。」家裡的暖氣有點足，我跑去開了一點窗戶後繼續說道。「來考慮這樣一個 Student 類。」
  • C語言中的變量存儲類型static老手都這樣用
    static老手都這樣用。1、 先來回顧C語言變量C語言中變量值的存儲位置有兩類：CPU的寄存器和內存。下面我們直接講乾貨，static關鍵字用法。2、 Static關鍵字用法C語言中，無論是變量還是函數都可以用static關鍵字來修飾。具體用法我們分別來看。
  • C++中的static關鍵字的總結
    1.面向過程設計中的static1.1靜態全局變量在全局變量前，加上關鍵字static，該變量就被定義成為一個靜態全局變量。• 靜態全局變量在聲明它的整個文件都是可見的，而在文件之外是不可見的；　靜態變量都在全局數據區分配內存，包括後面將要提到的靜態局部變量。
  • 什麼是靜態變量?它與臨時變量有什麼區別?(深入解讀)
    我最早接觸「靜態變量」的概念是在計算機C語言的編程中，清楚的記得它需要用"static"關鍵字來聲明。靜態變量（Static Variable）其實也是一種變量（Variable），因此在介紹靜態變量（Static Variable）之前，我們先來介紹下在計算機和PLC的編程中「變量（Variable）」的概念。
  • C 中 static 的常見作用
    ，存放在這裡。   1．全局靜態變量在全局變量之前加上關鍵字static，全局變量就被定義成為一個全局靜態變量。1）內存中的位置：靜態存儲區（靜態存儲區在整個程序運行期間都存在）2）初始化：未經初始化的全局靜態變量會被程序自動初始化為0（自動對象的值是任意的，除非他被顯示初始化）3）作用域：全局靜態變量在聲明他的文件之外是不可見的。準確地講從定義之處開始到文件結尾。
  • C語言中static的常見作用
    ，存放在這裡。   1）內存中的位置：靜態存儲區（靜態存儲區在整個程序運行期間都存在）2）初始化：未經初始化的全局靜態變量會被程序自動初始化為0（自動對象的值是任意的，除非他被顯示初始化）3）作用域：全局靜態變量在聲明他的文件之外是不可見的。準確地講從定義之處開始到文件結尾。
  • java中棧(stack)堆(heap)靜態區(static area)概念
    堆（heap）：專門用來保存對象的實例(new 創建的對象和數組)，實際上也只是保存對象實例的屬性值，屬性的類型和對象本身的類型標記等，並不保存對象的方法（方法是指令，保存在Stack中）。存儲的全部是對象，每個對象都包含一個與之對應的class的信息。
  • 「原創」為什麼java中一切都是對象,還要有static?
    1）修飾成員變量和成員方法用static修飾成員變量可以說是該關鍵字最常用的一個功能，通常將用static修飾的成員變量稱為類成員或者靜態成員。本文就是通過該使用場景拋磚引玉，描述了static關鍵字的「由來」。
  • static關鍵字有5種用法
    前言說到static，靜態變量和靜態方法大家隨口就來，因為他們在實際開發中應用很廣泛，但他們真正在使用的時候會存在很多問題，而且它的使用不只那兩種：靜態變量靜態方法靜態代碼塊靜態內部類靜態導入靜態變量靜態變量屬於類，內存中只有一個實例，當類被加載，就會為該靜態變量分配內存空間。跟 class 本身在一起存放在方法區中永遠不會被回收，除非 JVM 退出。
  • C語言應用筆記(二):C語言static關鍵字及其使用
    static在C語言中的三大作用：一、隱藏功能，對於static修飾的函數和全局變量而言；二、保持持久性功能，對於static修飾的局部變量而言；三、由於存放在靜態區，全局和局部的static修飾的變量，默認初始化都為0。
  • 一張圖看懂Linux內核中Percpu變量的實現
    所謂thread local變量，就是對於同一個變量，每個線程都有自己的一份，對該變量的訪問是線程隔離的，它們之間不會相互影響，所以也就不會有各種多線程問題。正確的使用thread local變量，能極大的簡化多線程開發。所以不管是c/c++/rust，還是java/c#等，都內置了對thread local變量的支持。
  • 一張圖看懂linux內核中percpu變量的實現
    所謂thread local變量，就是對於同一個變量，每個線程都有自己的一份，對該變量的訪問是線程隔離的，它們之間不會相互影響，所以也就不會有各種多線程問題。正確的使用thread local變量，能極大的簡化多線程開發。所以不管是c/c++/rust，還是java/c#等，都內置了對thread local變量的支持。