STL跨DLL使用

今天在寫一個函數，需要将map作為一個引用參數傳入函數體内部進行指派，結果編譯通過，執行時總是崩潰，在網上找到了一些作者寫的blog，詳細解釋了這種情況發生的原因，特轉載在這裡，便于自己今後查詢。

原文1：有一個功能子產品, 本來是寫在主程式當中. 現在覺得有必要将它寫成一個 DLL. 于是開始代碼的移植. 費了好大的勁. 終于移植完成, 通過編譯了. 這時運作程式, CRASH!

調試之, 發現是在一個 map 的指派出現了問題.

看 vc6 自帶的 STL 的代碼:

map 的指派操作, 也就是其中的樹指派操作.

_Myt& operator=(const _Myt& _X)

{

    _Tr = _X._Tr;

    return (*this);

}

樹的指派操作:

    if (this != &_X)

    {

        erase(begin(), end());

        key_compare = _X.key_compare;

        _Copy(_X);

    }

先删除自己, 然後調用 _Copy(const _Myt&);

void _Copy(const _Myt& _X)

    _Root() = _Copy(_X._Root(), _Head);

    _Size = _X.size();

    if (_Root() != _Nil)

        _Lmost() = _Min(_Root());

        _Rmost() = _Max(_Root());

    else

        _Lmost() = _Head, _Rmost() = _Head;

其中又調用了 _Copy(_Nodeptr, _Nodeptr);

_Nodeptr _Copy(_Nodeptr _X, _Nodeptr _P)

    _Nodeptr _R = _X;

    for (; _X != _Nil; _X = _Left(_X))      // error here

        _Nodeptr _Y = _Buynode(_P, _Color(_X));

        if (_R == _X)

            _R = _Y;

        _Right(_Y) = _Copy(_Right(_X), _Y);

        _Consval(&_Value(_Y), _Value(_X));

        _Left(_P) = _Y;

        _P = _Y;

    _Left(_P) = _Nil;

    return (_R);

看标記的那一行. _X 與 _Nil 比較. 其中的 _Nil 如下:

static _Tree<_K, _Ty, _Kfn, _Pr, _A>::_Nodeptr _Tree<_K, _Ty, _Kfn, _Pr, _A>::_Nil = 0;

是一個靜态變量. 初始值為 0. 在一個 module (注: 這裡的 module 是指的一個exe, 或者 dll. 下同) 中建構第一個 map 執行個體時, 有這樣的代碼:

                if (_Nil == 0)

                        {_Nil = _Buynode(0, _Black);

                        _Left(_Nil) = 0, _Right(_Nil) = 0; }

如果 _Nil 未初始化則建立一個 node, 初始化 _Nil. 然後 map 将内部的 _Head._Parent 指向這個 _Nil.

設想這樣一種情形. 一個 EXE, 一個 DLL. 

EXE:

void main()

 map m;

 func(m);

DLL:

void func(map& m)

 map n = m;

在 EXE 中建構了一個 map 執行個體. 然後傳到 DLL 中做指派操作.

分析執行過程, 首先 EXE 中的 m 初始化, 完成之後 m._Head._Parent  指向了一個 _Nil 節點. 然後這個 m 傳到 dll 中. 此時, n 進行初始化, 又執行這樣的代碼:

注意, 在 DLL 中, 這裡的 _Nil 為 0. 因為這個 _Nil 和 EXE 中的 _Nil 并不是同一份拷貝. 是以又會建立一個 node, 然後讓 _Nil 指向它. 再讓 n._Head._Parent 指向這個 _Nil.

問題在這裡開始出現了. map 的代碼認為其所有的執行個體的 _Head._Parent 都指向同一個 _Nil. 但這裡已經違背了這個原則.

最終的結果就是 crash. 在這個例子中, crash 出現在 _Copy(_Nodeptr, _Nodeptr) 函數中. 

注：原作中還有示例代碼

評論：

Great article!分析得很準确！

話說回來，個人意見：避免類似的錯，是應該養成良好的風格。

1）避免引用調用，而改用Const引用調用。沒有任何理由使用非const的引用調用。

2）如果要取得某個值，使用值傳回。

3）任何跨越Module邊界的記憶體操作（配置設定/釋放/copy),都應該避免。(MAP 的實作就是以這個假設，_buyNode已經配置設定記憶體，即使沒有_Nil的錯，在EXE裡最後map釋放的時候，也可能會Crash)

回到示例，似乎改為這樣，就應該毫無問題：

MapDLL.cpp: 

intmap MAPAPI func()

intmap n ;

n.insert(pair<int,int>(1,2));

return n;

MapEXE: 

intmap& m = func();

原文2：STL跨平台調用會出現很多異常，你可以試試.

STL使用模闆生成，當我們使用模闆的時候，每一個EXE，和DLL都在編譯器産生了自己的代碼，導緻模闆所使用的靜态成員不同步，是以出現資料傳遞的各種問題，下面是詳細解釋。

原因分析：

一句話-----如果任何STL類使用了靜态變量（無論是直接還是間接使用），那麼就不要再寫出跨執行單元通路它的代碼。 除非你能夠确定兩個動态庫使用的都是同樣的STL實作，比如都使用VC同一版本的STL，編譯選項也一樣。強烈建議，不要在動态庫接口中傳遞STL容器！！

STL不一定不能在DLL間傳遞，但你必須徹底搞懂它的内部實作，并懂得為何會出問題。

微軟的解釋：

http://support.microsoft.com/default.aspx?scid=kb%3ben-us%3b172396

微軟給的解決辦法：

http://support.microsoft.com/default.aspx?scid=kb%3ben-us%3b168958

1、微軟的解釋：

大部分C++标準庫裡提供的類直接或間接地使用了靜态變量。由于這些類是通過模闆擴充而來的，是以每個可執行映像（通常是.dll或.exe檔案）就會存在一份隻屬于自己的、給定類的靜态資料成員。當一個需要通路這些靜态成員的類方法執行時，它使用的是“這個方法的代碼目前所在的那份可執行映像”裡的靜态成員變量。由于兩份可執行映像各自的靜态資料成員并未同步，這個行為就可能導緻通路違例，或者資料看起來似乎丢失或被破壞了。

可能不太好懂，我舉個例子：假如類A<T>有個靜态變量m_s，那麼當1.exe使用了2.dll中提供的某個A<int>對象時，由于模闆擴充機制，1.exe和2.dll中會分别存在自己的一份類靜态變量A<int>.m_s。

這樣，假如1.exe中從2.dll中取得了一個的類A<int>的執行個體對象a，那麼當在1.exe中直接通路a.m_s時，其實通路的是 1.exe中的對應拷貝（正确情況應該是通路了2.dll中的a.m_s）。這樣就可能導緻非法通路、應當改變的資料沒有改變、不應改變的資料被錯誤地更改等異常情形。

原文：

Most classes in the Standard C++ Libraries use static data members directly or indirectly. Since these classes are generated through template instantiation, each executable image (usually with DLL or EXE file name extensions) will contain its own copy of the static data member for a given class. When a method of the class that requires the static data member is executed, it uses the static data member in the executable image in which the method code resides. Since the static data members in the executable images are not in sync, this action could result in an access violation or data may appear to be lost or corrupted.

1、保證資源的配置設定/删除操作對等并處于同一個執行單元；

   比如，可以把這些操作（包括構造/析構函數、某些容器自動擴容{這個需要特别注意}時的記憶體再配置設定等）隐藏到接口函數裡面。換句話說：盡量不要直接從dll中輸出stl對象；如果一定要輸出，給它加上一層包裝，然後輸出這個包裝接口而不是原始接口。

2、保證所有的執行單元使用同樣版本的STL運作庫。

   比如，全部使用release庫或debug庫，否則兩個執行單元擴充出來的STL類的記憶體布局就可能會不一樣。

隻要記住關鍵就是：如果任何STL類使用了靜态變量（無論是直接還是間接使用），那麼就不要再寫出跨執行單元通路它的代碼。

解決方法：

1. 一個可以考慮的方案

比如有兩個動态庫L1和L2，L2需要修改L1中的一個map，那麼我在L1中設定如下接口

int modify_map(int key, int new_value);

如果需要指定“某一個map”，則可以考慮實作一種類似于句柄的方式，比如可以傳遞一個DWORD

不過這個DWORD放的是一個位址

那麼modify_map就可以這樣實作：

int modify_map(DWORD map_handle, int key, int new_value)

    std::map<int, int>& themap = *(std::map<int, int>*)map_handle;

    themap[key] = new_value;

map_handle的值也首先由L1“告訴”L2:

DWORD get_map_handle();

L2可以這樣調用:

DWORD h = get_map_handle();

modify_map(h, 1, 2);

2. 加入一個額外的層，就可以解決問題。是以，你需要将你的Map包裝在dll内部，而不是讓它出現在接口當中。動态庫的接口越簡單越好，不好去傳太過複雜的東東是至理名言：）