C++形式の共有ライブラリの書き方(gcc編)

この記事はADVENTARの[C++ Advent Calender 2016](http://www.adventar.org/calendars/1527)の7日目の記事です。
明日はyumetodoさんの[KCS_KAIでの高速化の経験をまとめた何か](http://www.adventar.org/calendars/1527#list-2016-12-08)です。KanColleSimulatorの頭文字のようですがKAIってなんだろう？

# １．はじめに
昨日、[C++形式の動的リンク・ライブラリの書き方(msvc編)](http://qiita.com/Chironian/items/462a3bdf271d5f0b00b6)としてVisual C++用の「動的リンク・ライブラリ」のノウハウを書きました。
今日は、「共有ライブラリの書き方」としてます。共有ライブラリと動的リンク・ライブラリ何が違うのでしょうか？　実は良く分かりません（笑）。
大きな括りでは同じものと考えて良さそうです。例えば、CMakeは共有ライブラリも動的リンク・ライブラリもSharedと指定します。同じ用語を割り当ててますし。

さて、昨日と同じく私が今開発している[C++用のオート・シリアライザ（Theolizer）](https://github.com/yossi-tahara/Theolizer)をMinGWとgccで共有ライブラリ化した時に見つけたノウハウのご紹介です。

まず、前提は昨日と同じく、共有ライブラリのメリットとして[隠蔽](http://qiita.com/Chironian/items/462a3bdf271d5f0b00b6#%EF%BC%91%EF%BC%91%E8%87%AA%E4%BD%9C%E3%81%AE%E5%8B%95%E7%9A%84%E3%83%AA%E3%83%B3%E3%82%AF%E3%83%A9%E3%82%A4%E3%83%96%E3%83%A9%E3%83%AA%E3%81%AE%E3%83%A1%E3%83%AA%E3%83%83%E3%83%88%E3%81%AF)を対象としています。そして、[隠蔽は弱点となることがある](http://qiita.com/Chironian/items/462a3bdf271d5f0b00b6#%EF%BC%91%EF%BC%92%E3%81%97%E3%81%8B%E3%81%97%E9%9A%A0%E8%94%BD%E3%81%AF%E5%BC%B1%E7%82%B9%E3%81%AB%E3%81%AA%E3%82%8B%E3%81%93%E3%81%A8%E3%81%8C%E3%81%82%E3%82%8A%E3%81%BE%E3%81%99)のでこれを避ける点も同じ考え方に基いてます。

ですので、昨日と同じく、自作ライブラリが静的リンクするライブラリを隠蔽し、しかし標準ライブラリは共有する前提です。

# ２．隠蔽について
MinGW(gcc)とmsvcでは共有ライブラリの隠蔽の考え方が正反対です。
**msvc**はデフォルト隠蔽で指定したものを公開します。
**MinGW**と**gcc**はデフォルト公開です。もしや隠蔽できないのでは！？と焦りましたが、ちゃんと方法は用意されてました。

## ２－１．シンボルの隠蔽方法
**MinGW**は`__declspec(dllexport)`でシンボルをexportしますが、１つでもexportするとexportしていないシンボルが全て隠蔽されます。
この辺りの詳しいことが[5.8. ld and WIN32 (cygwin/mingw)](https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Linux/4/html/Using_ld_the_GNU_Linker/win32.html)に記載されていました。

> If, however, -export-all-symbols is not given explicitly on the command line, then the default auto-export behavior will be disabled if either of the following are true:
>    ・A DEF file is used.
>    ・Any symbol in any object file was marked with the __declspec(dllexport) attribute.

**gcc**はコンパイルオプションで`-fvisibility=hidden`を指定すると全て隠蔽でき、`__attribute__((visibility ("default")))`を指定したシンボルがexportされます。
この辺りの詳しいことは[Why is the new C++ visibility support so useful?](https://gcc.gnu.org/wiki/Visibility)に書かれています。

ただし、**MinGW**と**gcc**の両方とも「外部リンケージのない」シンボルをexportすることはできないようです。そのようなシンボルに`__declspec(dllexport)`や`__attribute__((visibility ("default")))`を指定すると「外部リンケージが必要」エラーになります。

---
以下、dllの関数や変数をexe側で使えるようexportするために、下記のようなマクロが定義されているとし、かつ、gccは`-fvisibility=hidden`を指定してビルドされているとして解説します。

```
dllのビルド時：  #define DLL_EXPORT  __declspec(dllexport) // MinGW
                #define DLL_EXPORT  __attribute__((visibility ("default"))) // gcc
exeのビルド時：  #define DLL_EXPORT
```

また、個人的にC++11に慣れているので、C++11基準でコードを書いています。

## ２－２．外部リンケージがないシンボルについて
外部リンケージがないとは、他のコンパイル単位（cppファイルとそのcppからインクルードされているヘッダ・ファイル）からアクセスできないことです。

ヘッダは複数のcppからインクルードするためちょっと混乱しやすいです。そこで少し説明させて下さい。
例えば下記のように定義した変数は定義した場所で生成されます。

```C++
const float pi=3.141592;
```

そのため、これをヘッダの中で定義し、そのヘッダを複数のcppからインクルードすると、各cpp毎にpiが定義されてしまいます。そして、このように「普通」に宣言した変数は「外部リンケージ」を持つため、そのコンパイル単位の「外」からもアクセスできます。
その結果「外」に同じ名前で複数の異なる変数が見えてしまい多重定義エラーになります。

これを防ぐために、定数の場合はstaticを付けて対処します。例えば、下記のように定義するわけです。

```C++
static const float pi=3.141592;
```

staticを付けることで「外部リンケージ」がなくなり、実体が複数あるにも関わらず「外」から見えないので多重定義エラーにならないのです。（他に無名namespaceでも外部リンケージをなくせますが、今回の記事には無関係なので割愛します。）

## ２－３．外部リンケージがあるstaticシンボルについて
staticの言語的な意味は静的です。
C言語ではローカル変数にstaticを付けることで静的な記憶領域に配置できます。（関数が終了してもその変数の値が保持されます。）
グローバル変数の場合は常に静的な記憶領域に記録されるため、グローバル変数にstaticを付けると外部リンケージを解除すると言う別の意味に流用されました。
関数内部で用いるローカル変数は元々外部リンケージを持たないため、問題ありませんでした。

ややこしいのはC++のクラス・メンバに指定するstaticです。こちらは外部リンケージを持ちます。

```C++:foo.h
struct Foo
{
    static int static_var;
};
```

と定義して、これをfoo.cppとbar.cppでインクルードします。皆さんご存知のようにFoo::static_varとしてアクセスする変数は全て同じものです。foo.cppで書き込んだ値をbar.cppで読み出せます。つまり「外部リンケージ」を持っています。

この記事を書くにあたって規格書（ドラフトn3337）にもあたってみました。`9.4.2 Static data members`に確かに記載されてます。本の虫の江添亮氏がC++11の解説を書いてます。その[9.8.2 staticデータメンバー（Static data members）](http://ezoeryou.github.io/cpp-book/C++11-Syntax-and-Feature.xhtml#class.static.mfct)に記載があり、規格書の日本語訳になってます。

> 名前空間スコープのクラスのstaticデータメンバーは、外部リンケージを持つ。ローカルクラスのstaticデータメンバーは、リンケージを持たない。

他のクラスの内部で定義されたクラス（ローカルクラス）のstaticメンバ変数と定数は外部リンケージを持たない。そして、最も外側で定義されたクラスのstaticメンバ変数と定数は外部リンケージを持つということです。

例えば、下記のように定義されている時、Foo::InnerClass::static_varとBar::InnerClass::static_varは別物です。そもそもFoo::InnerClassとBar::InnerClassは全く別のクラスですから当たり前ですね。

```C++
struct Foo
{
    struct InnerClass
    {
        static int static_var;
    };
};

struct Bar
{
    struct InnerClass
    {
        static int static_var;
    };
};
```

## ２－４．さて問題です
シングルトンを定義する時、staticを用いることは多いです。その際に大きく２種類の定義方法があります。シングルトン・オブジェクトの実体を、A)staticなメンバ変数でポインタを保持する方法と、B)staticなローカル変数で保持する方法です。下記に抽出したコードを記載しています。

このどちらかはクラス単位でexportすると不具合がでます。さて、それはどちらでしょうか？
[ヒント（マウスを載せると表示されます）](http://theolizer.com/ "外部リンケージのない変数はexportされません")

```C++:メンバ変数版
// ヘッダ定義
class DLL_EXPORT SingletonA
{
    ：
    static SingletonA* mInstance;
public:
    static SingletonA& getInstance()
    {
        if (!mInstance) mInstance=new SingletonA();
        return *mInstance;
    }
    ：
};

// cppで定義
SingletonA* SingletonA::mInstance=nullptr;
```

```C++:ローカル変数版
// ヘッダ定義
class DLL_EXPORT SingletonB
{
    ：
public:
    static SingletonB& getInstance()
    {
        static SingletonB mInstance;
        return mInstance;
    }
    ：
};
```
私は、見やすいし楽なのでローカル変数版が好きです。

[**答え（マウスを載せると表示されます）**](https://github.com/yossi-tahara/Theolizer "SingletonBのローカル変数版です。ローカル変数は外部リンクがないのでmInstanceがexeとdllの両方で定義されます")

## ２－５．検証実験

まず、SingletonAの検証用コードの定義部です。（SingletonBもほぼ同じで、上記で示した部分のみの相違です。）

```C++:dll.h
// メンバ変数版
class DLL_EXPORT SingletonA
{
    int     mVal;
    SingletonA() : mVal(0) { }; // コピー／ムーブの禁止コードは省略
    ~SingletonA() { delete mInstance; }

    static SingletonA* mInstance;
public:
    static SingletonA& getInstance()
    {
        if (!mInstance) mInstance=new SingletonA();
        return *mInstance;
    }

    // ヘッダ内定義関数
    static void setVal(int iVal){ getInstance().mVal=iVal; }
    static int getVal()         { return getInstance().mVal; }

    // dll内定義関数
    static void setValDll(int iVal);
    static int  getValDll();
};
```

下記のmain.cppがexe側、sub.cppがdll側です。SingletonA部を抜粋してます。SingletonBのコードもmInstanceの定義が無いこと以外同じです。

```C++:main.cpp
    // SingletonAテスト
    SingletonA::setVal(10);
    SingletonA::setValDll(20);
    std::cout << "SingletonA::getVal()   =" << SingletonA::getVal() << "\n";
    std::cout << "SingletonA::getValDll()=" << SingletonA::getValDll() << "\n";
```

```C++:sub.cpp
// SingletonA
SingletonA* SingletonA::mInstance=nullptr;

void SingletonA::setValDll(int iVal)
{
    getInstance().mVal=iVal;
}

int  SingletonA::getValDll()
{
    return getInstance().mVal;
}
```

setVal()とgetVal()はヘッダで定義しているので、実体はexeとdllの両方に存在します。
setValDll()とgetValDll()はdll側で定義しているので、実体はdll側のみに存在します。
上記のように単純にsetVal()とgetVal()を呼び出しています。

もし、mInstanceがexeとdllに個別に存在していた場合、setVal()とgetVal()はそれを呼び出した側（exe or dll）のmInstanceを返却します。

さて、exe側（main.cpp）は下記処理を行っています。

1. setVal()とgetVal()を直接呼び出し
2. setValDll()とgetValDll()を呼び出して、dll経由でsetVal()とgetVal()を関節呼び出し

SingletonB側も全く同様に処理してます。

これらの結果を見ればmInstanceがdll側にのみ存在するのか、exeとdllの両方に個別に存在するのか判断できます。

実行結果です。（Windows 10のMinGW 5.4.0、ubuntu 16.04 LTCのgcc 5.4.0で確認してます。）

```txt:実行結果
1: SingletonA::getVal()   =20
1: SingletonA::getValDll()=20
1: SingletonB::getVal()   =10  ←これがまずい！！　他と同じ値になって欲しい。
1: SingletonB::getValDll()=20
```

う～ん、私の好みの方の負けですね。

結局、ローカル変数はstaticにしてもしなくても外部リンケージがありませんから、gccとMinGWはexportしてくれないということです。
もちろん静的リンクした時は、ローカル変数版mInstanceもちゃんと同じものになります。

つまり、悲しいかな**gccとMinGWでは、共有ライブラリの場合と静的リンク・ライブラリの場合でstaticなローカル変数の振る舞いが異なります**。要注意です。

CMakeなら共有リンクと静的リンクを手軽に切り替えることができます。
この実験で使ったソースとCMakeLists.txtとその使い方を最後に説明してますのでやってみて下さい。

## ２－６．対策
分かりさえすれば対策は簡単です。ローカル変数を定義するメンバ関数をヘッダで定義せず、dll側のcpp内で定義するだけです。
問題は、この対策を忘れないことです。

```C++:ローカル変数版
// dll.h
class DLL_EXPORT SingletonB
{
    ：
public:
    static SingletonB& getInstance();
    ：
};

// sub.cpp
SingletonB& SingletonB::getInstance()
{
    static SingletonB mInstance;
    return mInstance;
}
```

# ３．-fPICオプションについて
MinGWでは不要ですが、gccで共有ライブラリをビルドするには-fPICオプションを付けてコンパイルする必要が有ります。
32bitビルドの時は必須ではないけどいろいろメリットがあるようです。
64bitビルドの時は必須のようです。

詳しくは[-fPICオプションについて調査](http://qiita.com/Chironian/items/efdc1f6937fcb08ce164#-fpic%E3%82%AA%E3%83%97%E3%82%B7%E3%83%A7%E3%83%B3%E3%81%AB%E3%81%A4%E3%81%84%E3%81%A6%E8%AA%BF%E6%9F%BB)で説明していますので、そちらを参照して下さい。

# ４．thread_local領域について
[thread_local](https://ja.wikipedia.org/wiki/%E3%82%B9%E3%83%AC%E3%83%83%E3%83%89%E5%B1%80%E6%89%80%E8%A8%98%E6%86%B6)なグローバル変数を定義したいことがあります。（[errno](https://msdn.microsoft.com/ja-jp/library/5814770t.aspx)のような変数はスレッド毎にユニークなグローバル変数にする必要があります。そのような時ですね。）

[msvcはthread_local領域をexportできませんでした。](http://qiita.com/Chironian/items/462a3bdf271d5f0b00b6#%EF%BC%92%EF%BC%94thread_local%E9%A0%98%E5%9F%9F%E3%81%8Cexport%E3%81%A7%E3%81%8D%E3%81%AA%E3%81%84)
なので、gccとMinGWはどうなのかちょっと気になりましたので、調べたところ大丈夫でした。
特にコンパイル・エラーも出ず、dll側だけで定義されました。
（もちろん、外部リンケージがない形式で使った時は、他と同じく共有されない筈です。）

# ５．実験ソースのビルド方法（using CMake)
以上の実験で使ったソースとCMakeLists.txtを[Gist](https://gist.github.com/yossi-tahara/06b42fd6c1d5f2dae9b196fba9c33052)へ上げてます。

CMake 3.5.0以上をインストールしパスを通しておいて下さい。（ここで[手短にCMakeのインストール方法](http://qiita.com/Chironian/items/79001fec1e916b016546#24-cmake-350%E3%81%AE%E3%83%80%E3%82%A6%E3%83%B3%E3%83%AD%E3%83%BC%E3%83%89%E3%81%A8%E3%82%A4%E3%83%B3%E3%82%B9%E3%83%88%E3%83%BC%E3%83%AB%E6%96%B9%E6%B3%95)を書いてます。）

上記Gistからダウンロードして解凍し、下記操作を行うことでビルドと実行できます。

**MinGWの場合***
Windows 10上でMinGW 5.4.0で確認しています。また、MinGWにパスを通しておいて下さい。

> mkdir build
 cd build
 [cmake -G "MinGW Makefiles" ..](http://kumar.hateblo.jp/entry/2014/10/13/204716 "Makefile群を生成します")
 [cmake --build .](http://kumar.hateblo.jp/entry/2014/10/13/204716 "ビルドします。最後の '.'（ドット）をお忘れなく。")
 main.exe

**gccの場合**
ubuntu 16.04 LTC上でgcc 5.4.0で確認しています。

> mkdir build
 cd build
 [cmake -G "MinGW Makefiles" ..](http://kumar.hateblo.jp/entry/2014/10/13/204716 "Makefile群を生成します")
 [cmake --build .](http://kumar.hateblo.jp/entry/2014/10/13/204716 "ビルドします。最後の '.'（ドット）をお忘れなく。")
 ./main

上記コマンドは極限までオプション指定を省略してます。CMakeは超便利ですが、それに応じて使い方も難しいので何か分からない時は当記事のコメントで尋ねて下さい。できるだけ回答します。

# ６．バージョンの相違問題について
dllのみ更新した時、問題を起こさないようにするにはどうすればよいのか？
本当に悩ましいです。でも、良い解は見つかっていません。解について私の見解を[昨日の記事に書いてます。](http://qiita.com/Chironian/items/462a3bdf271d5f0b00b6#%EF%BC%94%E3%83%90%E3%83%BC%E3%82%B8%E3%83%A7%E3%83%B3%E3%81%AE%E7%9B%B8%E9%81%95%E5%95%8F%E9%A1%8C)

# ７．まとめ
dll化する際、見落としがちで問題になりやすいのはメモリ問題でした。
msvcのまとめとほぼ同じですね。

1. ヒープ等のリソースを管理する同じライブラリの実体がexeとdllに分かれると辛い
貸出元へきちんと返却する必要があり、リソース管理がたいへん難しくなります。
exeとdll間でやり取りするリソースを管理するライブラリ（標準ライブラリ含む）は、exeとdllで同じものを動的リンクするのが望ましいです。

2. static変数やグローバル変数はデータ・セグメントに記録されますが、これらは要注意
油断するとexeとdllの両方に領域が獲得されてしまいます。注意深くexportすることで避ける必要があります。
できるだけクラス単位でexportすることが望ましいと思います。
そして、**staticなローカル変数はexportできません。そのような定義をする時、その関数はヘッダではなく、dll側のcppで定義しましょう。**

# ８．さいごに
こちらはmsvcより随分楽な筈と思っていたのですが、結局、大きな記事になってしまいました。
staticと外部リンケージ周りが頭痛かったです。調べれば調べるほど、色々でてきましたので。
MinGWとgccもstaticなローカル変数をexportしてくれれば良いのになと思います。

さて、今回、これを纏めるにあたって追加調査し裏も取りましたが、まだ何か勘違いや見落としがあるかも知れません。
気がついた方は是非コメント下さい。