【C++】グローバル変数が0のまま・main前に落ちる原因とは?|静的初期化順序問題を、リンクの順番を変えて実測して直す

【C++】グローバル変数が0のまま・main前に落ちる原因とは?|静的初期化順序問題を、リンクの順番を変えて実測して直す C++

グローバル変数g_bを、g_a * 2で初期化しました。g_aは10なので、g_bは20になるはずです。ところが、実行すると0になります。コードは1行も変えていません。変えたのは、ビルドに渡す、ファイルの順番だけです。

これは、静的初期化順序問題(Static Initialization Order Fiasco、SIOF)と呼ばれる現象です。実際に、ファイルの順番を入れ替えて動かし、値が変わる様子と、mainに入る前に落ちる場合を確かめました。直し方として、関数内のstaticとconstinitも試しています。

検証は、Visual Studio 2022付属のMSVC(19.44、x64)を、Release(/O2 /MD)で動かして行いました。constinitを使う実験だけ、C++20でビルドしています。

静的初期化順序問題とは?

・別々の.cppファイルにあるグローバル変数どうしは、初期化される順番が決まっていない(同じファイルの中は、書いた順)

「g_bは、g_aが初期化されたあとに、初期化されるだろう」と思って書いたコードが、実際には、逆の順番で動くことがあります。そのとき、g_aは、まだ初期化される前で、メモリは、0で埋められているだけです。

実験①:リンクの順番を入れ替える

a.cppでg_aを、b.cppでg_b = g_a * 2を、それぞれ関数の結果で初期化します。初期化の関数は、呼ばれたときに、メッセージを出します。

▼a.cpp
// a.cpp: g_a を、関数の結果で初期化する
#include <cstdio>

int computeA()
{
    std::printf("[a.cpp] g_a を初期化します\n");
    return 10;
}

int g_a = computeA();
▼b.cpp
// b.cpp: g_b を、別のファイルの g_a から計算して初期化する
#include <cstdio>

extern int g_a;

int computeB()
{
    std::printf("[b.cpp] g_b を初期化します (このとき g_a = %d)\n", g_a);
    return g_a * 2;
}

int g_b = computeB();
▼main.cpp
// main.cpp
#include <cstdio>

extern int g_a;
extern int g_b;

int main()
{
    std::printf("main: g_a = %d, g_b = %d  (g_b は 20 のはず)\n", g_a, g_b);
    return 0;
}

同じ3つのファイルを、コンパイラに渡す順番だけ変えて、2回ビルドしました。

同じソースを、リンクする順番だけ変えて実行した結果。g_bの値が20と0に変わった
`a.cpp b.cpp`の順では、g_b=20。`b.cpp a.cpp`の順では、a.cppより先にb.cppが動き、g_b=0になった

a.cpp b.cpp main.cppの順では、a.cppが先に初期化されて、g_bは20でした。ところが、b.cpp a.cpp main.cppの順にしただけで、b.cppが先に動き、そのときg_aは0、結果のg_bも0になりました。ソースは、1文字も、変わっていません。

このMSVCでは、コンパイラに渡したファイルの順番に、初期化が動きました。ただし、これは、標準で保証された動きではありません。Visual Studioのプロジェクトで、ファイルを追加したり、並べ替えたり、別のビルド方法に変えたりして、順番が変わると、同じコードの動きが変わります。

【重要】実験②:mainに入る前に、落ちる

値が0になるだけなら、気づきやすい方です。ゲームでよく使う、「各ファイルが、起動時に、自分を表に登録する」仕組みで、同じ問題を起こしてみました。

▼registry.h
// registry.h: 敵の名前と番号を登録する表
#pragma once
#include <map>
#include <string>

extern std::map<std::string, int> g_table;    // 実体は registry.cpp

struct Registrar
{
    Registrar(const char* name, int id) { g_table[name] = id; }
};
▼registry.cpp
#include "registry.h"

std::map<std::string, int> g_table;
▼slime.cpp(goblin.cppも同じ形)
#include "registry.h"

static Registrar s_slime("slime", 1);      // 起動時に、自分で表へ登録する
▼main.cpp
#include <cstdio>
#include "registry.h"

int main()
{
    std::printf("登録された敵: %zu 体 (2体のはず)\n", g_table.size());
    for (const auto& kv : g_table) std::printf("  - %s (番号 %d)\n", kv.first.c_str(), kv.second);
    return 0;
}
ビルドに渡す順番結果
registry.cpp slime.cpp goblin.cpp main.cpp登録された敵: 2体(goblin・slime)。正常
slime.cpp goblin.cpp registry.cpp main.cpp何も表示されないまま、終了コード0xC0000005(アクセス違反)で落ちた
どちらも、同じソースを、Release(/O2 /MD)で実行した結果
登録された敵: 2 体 (2体のはず)
  - goblin (番号 2)
  - slime (番号 1)

2行目の順番では、mainの最初のprintfすら、実行されませんでした。slime.cppの登録が、先に動き、まだ初期化されていないg_table(std::map)に、書き込もうとして、落ちたためです。mainより前に落ちるので、デバッガーでmainから追っても、原因に、たどり着けません。

なお、同じ実験を、std::mapではなくstd::vectorで行ったときは、どちらの順番でも、正しく登録できました。MSVCのvectorは、起動前の段階で、初期化が済んでいるためとみられます。「自分の環境では、落ちなかった」ことが、安全の証拠にならない、という例です。

直し方①:関数の中のstaticにする

グローバル変数のかわりに、関数の中のstatic変数を、返す関数を作ります。関数内のstaticは、初めてその関数が呼ばれたときに、初期化されます。呼ぶ側は、必ず、その関数を通るので、使う前に、初期化が終わっています。

▼registry.h(関数内staticに変えた版)
// registry.h: 関数の中の static で、「初めて使うとき」に作る
#pragma once
#include <map>
#include <string>

inline std::map<std::string, int>& table()
{
    static std::map<std::string, int> s_table;     // 最初に呼ばれた時点で作られる
    return s_table;
}

struct Registrar
{
    Registrar(const char* name, int id) { table()[name] = id; }
};
登録された敵: 2 体 (2体のはず)
  - goblin (番号 2)
  - slime (番号 1)
登録された敵: 2 体 (2体のはず)
  - goblin (番号 2)
  - slime (番号 1)

どちらの順番でも、2体が、正しく登録できました(mapは、キーの順に並べるので、表示される順番も同じです)。実験②で落ちた書き方(registry.cppを最後にする)の、危険な順番は、そもそも、なくなっています。

直し方②:constinitで、起動前に値を決める

g_aが、定数で初期化できるなら、C++20のconstinitが使えます。constinitは、「起動前に、値が決まる」ことを、コンパイラに保証させる指定です。

▼a_constinit.cpp
// a_constinit.cpp: g_a を constinit にして、起動前(コンパイル時)に値を決める
constinit int g_a = 10;
[b_constinit.cpp] g_b を初期化します (このとき g_a = 10)
main: g_a = 10, g_b = 20  (g_b は 20 のはず)
[b_constinit.cpp] g_b を初期化します (このとき g_a = 10)
main: g_a = 10, g_b = 20  (g_b は 20 のはず)

どちらの順番でも、g_bは、20になりました。g_aは、起動前に10になっているので、b_constinit.cppが先に動いても、g_a = 10を、正しく読めました。

constinitには、さらに、使い方の間違いを見つけてくれる効果があります。実行時にしか決まらない関数の結果で、初期化しようとすると、ビルドが通りません。

▼a_constinit_bad.cpp
// constinit は、「起動前に決まる値」でしか初期化できない
#include <cstdio>

int computeA()
{
    std::printf("[a] g_a を初期化します\n");
    return 10;
}

constinit int g_a = computeA();     // 実行時にしか決まらない関数の結果は、使えない
a_constinit_bad.cpp
a_constinit_bad.cpp(10): error C2127: 'g_a': 非定数式で 'constinit' のエンティティが正しく初期化きません。

C2127で、止まりました。順番に頼ってしまう初期化を、ビルドの段階で、見つけられます。

よくある失敗例と対処法

①別のcppのグローバル変数を使って、グローバル変数を初期化する

実験①のとおり、順番しだいで、0を読みます。関数内staticか、constinitにします。

②起動時に、自分を表へ登録するクラスで、表をグローバル変数にしている

実験②のとおり、main前に落ちることがあります。表は、関数内staticで作る形にします。

③シングルトンを、グローバル変数として持つ

同じ問題が起きます。シングルトンの作り方は、getInstanceの記事で扱っている、関数内staticの形が、この問題に強いやり方です。

④起動時の初期化を、全部コンストラクタに任せる

順番が大事な初期化は、mainの中から、明示的に、Init()を呼ぶ形にすると、順番を、コードに残せます。

注意点

  • 別々の.cppのグローバル変数は、初期化の順番が決まっていない。同じファイルの中は、書いた順
  • 同じソースで、ファイルの順番を入れ替えただけで、g_bが20から0に変わった
  • std::mapの表への登録で、順番が悪いと、mainに入る前に、アクセス違反(0xC0000005)で落ちた
  • std::vectorでは、この環境では落ちなかった。落ちないことは、安全の証拠にならない
  • 関数内staticは、初めて呼ばれたときに初期化される。constinit(C++20)なら、起動前に値が決まる
  • 今回の検証は、MSVC 19.44(Visual Studio 2022付属、x64、/O2 /MD)で行った。順番の決まり方は、コンパイラとリンカーで異なる

この記事のポイント

  • グローバル変数どうしの初期化の順番は、ファイルをまたぐと、保証されない
  • 直し方は、関数内staticか、C++20のconstinit
  • 起動時に動く登録処理は、「表そのもの」が、まだ無いタイミングで動く可能性を、考える
  • mainより前の問題は、mainから追っても、見つからない

値が0になるときも、mainの前で落ちるときも、原因は同じです。「あの変数は、もう使えるはずだ」という前提が、ファイルの順番という、コードに書かれていない条件に、支えられていました。前提を、コードの中に、書き出しておく。それが、関数内staticとconstinitの役割です。

あわせて読みたい