C++のグローバル静的変数の初期化とattribute/declspecによる関数の呼び出し順序の制御
初めに
C++ではグローバルな静的変数が宣言されているとmainの前に初期化されます。
GCCには__attribute__((constructor))という拡張があり、この属性を関数の前に付けるとその関数がmainの前に呼ばれます。
それでは両方使うとどういう順序でなるのか? C++的には未定義ですが実験してみました。
単一ファイルにおける順序
#include <stdio.h>
static struct X1 {
X1() { puts("X1 cstr"); }
} x1;
static void __attribute__((constructor)) initMain()
{
puts("initMain");
}
static struct X2 {
X2() { puts("X2 cstr"); }
} x2;
int main()
{
puts("main");
}
static struct X3 {
X3() { puts("X3 cstr"); }
} x3;
静的変数x1, x2, x3をぞれぞれmainの前、initMainの前、mainの後ろに置いてみました。
% g++ main.cpp && ./a.out
initMain
X1 cstr
X2 cstr
X3 cstr
main
実行するとまず__attribute__((constructor))による関数呼出しが行われてから、（C++の規格で決まってる）変数の宣言順序で変数が初期化され、main関数に突入しました。
変数の初期化順序を変更する
実はGCCには__attribute__((init_priority (priority)))という変数の初期化順序を制御する拡張もあります。
priorityには101から65535までの数値を指定でき、値が小さいほど先に初期化されます。先程のx1, x2, x3に1030, 1010, 1020というpriorityを与えてみましょう。
属性は変数の後ろにつけるのに注意してください。
前節のファイルからの差分
diff --git a/static-cstr/main.cpp b/static-cstr/main.cpp
index 85619fa..7e11da5 100644
--- a/static-cstr/main.cpp
+++ b/static-cstr/main.cpp
@@ -10,7 +10,7 @@ namespace {
static struct X1 {
X1() { puts("X1 cstr"); }
-} x1;
+} x1 __attribute__((init_priority(1030)));
static void __attribute__((constructor)) initMain()
{
@@ -24,7 +24,7 @@ __declspec(allocate(".CRT$XCU")) void(*ptr_initMain)() = initMain;
static struct X2 {
X2() { puts("X2 cstr"); }
-} x2;
+} x2 __attribute__((init_priority(1010)));
}
@@ -38,6 +38,6 @@ namespace {
static struct X3 {
X3() { puts("X3 cstr"); }
-} x3;
+} x3 __attribute__((init_priority(1020)));
}
% g++ main.cpp && ./a.out
X2 cstr # 1010
X3 cstr # 1020
X1 cstr # 1030
initMain # 後ろに来た
main
ファイル内の宣言順序ではなく、与えたpriorityの小さい順にx2, x3, x1と初期化されました。
それから前節とことなりinitMainよりも先になったことに注意してください。__attribute__((constructor))のデフォルトpriorityは65535のようです。
関数の呼び出し順序を変更する
なお、そのpriorityも変更できます。
// # define PRIORITY 101
static void __attribute__((constructor(PRIORITY))) initMain()
PRIORITY=101とconstructorにx1, x2, x3よりも小さいpriorityを与えてみます。
すると
% g++ main.cpp -DPRIORITY=101 && ./a.out
initMain # 101 前に来た
X2 cstr # 1010
X3 cstr # 1020
X1 cstr # 1030
main
PRIORITY=1025なら
% g++ main.cpp -DPRIORITY=1025 && ./a.out
X2 cstr # 1010
X3 cstr # 1020
initMain # 1025
X1 cstr # 1030
main
Windows (Visual Studio) の場合
Visual Studioには残念ながら__attribute__((constructor))相当の拡張がありません。
代わりに次の方法が使われることがあります。
.CRT$XCUというセクションに動的な初期化変数のコードが置かれます。（CRTの初期化）
__declspec(allocate(".CRT$XCU"))を用いて、ここに呼び出してほしい関数を追加するのです。
static void initMain()
{
puts("initMain");
}
#ifdef _MSC_VER
#pragma section(".CRT$XCU", read)
__declspec(allocate(".CRT$XCU")) void(*ptr_initMain)() = initMain;
#endif
cl /O2 /EHsc main.cpp && main
X1 cstr
X2 cstr
X3 cstr
initMain # 最後に追加された
main
このようにするとVisual Studioでも__attribute__((constructor))相当のことができます。initMainは最後に追加されています。
GCCのpriorityのような順序付けはできないのですが、CRTセクションのサブセクションはアルファベット順に並べられるのでXCUの辞書的順序で一つ前のXCT（アルファベットUの前はT）に追加すればGCCのpriorityを設定しないデフォルト挙動に近い形にできます。
かつ、XCUへの追加は推奨されないようですので、この方がより安全です。
#ifdef _MSC_VER
#pragma section(".CRT$XCT", read)
__declspec(allocate(".CRT$XCT")) void(*ptr_initMain)() = initMain;
#endif
cl /O2 /EHsc main.cpp && main
initMain # 前に来た
X1 cstr
X2 cstr
X3 cstr
main
最後に追加したい場合はXCUの次のXCV（アルファベットUの次はV）を使います。
将来万一、マイクロソフトがXCTサブセクションを追加して、ぶつかったときのために
#pragma warning(default:5247) // セクション 'section-name' は C++ 動的初期化用に予約されています。
#pragma warning(default:5248)
を付けて警告を有効にしておくとよいかもしれません（まあ当分は無いでしょうが）。
複数ファイルの場合
複数のオブジェクトファイルでそれぞれ初期化コードを実行する場合、上記ルールに「リンク時のオブジェクトファイル順に処理される」というルールに従います。
GCCの場合にファイルごとに異なるpriorityを指定するとそれが優先されます。
Visual Studioでは同名のサブセクションごとにまとめられてから実行されます。
したがって、
- 全てのファイルで
.CRT$XCUを用いた場合は、「C++の動的初期化→__declspecで登録した関数」をobjごとの順に - 全てのファイルで
.CRT$XCTを用いた場合は、「__declspecで登録した関数をobjごとの順」→「C++の動的初期化をobjごとの順」
となります。
gcc -c main1.exe main.o sub1.o sub2.o # initMain, X cstr, initSub1, sub1 X cstr, initSub2, sub2 X cstrの順
gcc -c main2.exe sub2.o main.o sub1.o # initSub2, sub2 X cstr, initMain, X cstr, initSub1, sub1 X cstrの順
などとなります。
詳細はstatic-cstrにサンプルコードを置いたので試してみてください。
まとめ
ライブラリの実装で初期化関数をC++の規格に従わずに__attribute__((constructor))などを使ってどうしても呼び出したい場面というのはありえるでしょう。
その場合はC++の動的初期化の枠組みよりも先に呼びたいでしょうから__attribute__((constructor(101)))などとpriorityを上げた状態でライブラリの初期化関数を呼び出し、その中でファイルごとの初期化関数を明示的に呼ぶとオブジェクトファイルの順序に寄らずに制御できます（完全ではありませんが）。
そしてWindowsでは.CRT$XCTを使うとLinuxとほぼ同じ制御ができるので都合がよいです。
Discussion