適合コード

以下の適合コードでは、EXEC_BUMP() マクロをインライン関数 exec_bump() に置き換えている。aFunc 呼出しは今度は count の値を 0 から 9 まで (正しく) 出力する。

size_t count = 0;

void g(void) {
  printf("Called g, count = %zu.\n", count);
}

typedef void (*exec_func)(void);
inline void exec_bump(exec_func f) {
  f();
  ++count;
}

void aFunc(void) {
  size_t count = 0;
  while (count++ < 10) {
    exec_bump(g);
  }
}

インライン関数を使うことで、識別子 count は関数本体がコンパイルされるときにグローバル変数にバインドされる。関数呼出し時に、同じ名前を持つ別の変数にバインドされることはない。

違反コード

関数と違ってマクロの実行はインターリーブすることがある。そのため、個々には問題ないふたつのマクロが、ひとつの式のなかで組み合わされると未定義の動作を起こすことがある。以下の例では、F() と G() の両方がグローバル変数 operations をインクリメントしている。これは、ふたつのマクロが一緒に使われるとき問題をひきおこす。

int operations = 0, calls_to_F = 0, calls_to_G = 0;

#define F(x) (++operations, ++calls_to_F, 2 * x)
#define G(x) (++operations, ++calls_to_G, x + 1)

void func(int x) {
  int y = F(x) + G(x);

}

変数 operations は同じ式のなかで2回、値の読み込みと変更がなされる。例えば以下のような実行順序になった場合に、間違った値になるかもしれない。

operations を レジスタ0 に読み込む
operations を レジスタ1 に読み込む
レジスタ0 をインクリメント
レジスタ1 をインクリメント
レジスタ0 を operations にストア
レジスタ1 を operations にストア

このコード例は「EXP30-C. 副作用の評価順序に依存しない」にも違反している。

適合コード

インライン関数も含め、関数の実行はインターリーブされない。そのため、問題となる実行順序になることはない。

int operations = 0, calls_to_F = 0, calls_to_G = 0;

inline int f(int x) {
  ++operations;
  ++calls_to_F;
  return 2 * x;
}

inline int g(int x) {
  ++operations;
  ++calls_to_G;
  return x + 1;
}


void func(int x) {
  int y = f(x) + g(x);

}

プラットフォーム固有の詳細

GNU C (とその他いくつかのコンパイラ)は、C 言語仕様に追加される前からインライン関数をサポートしており、C 言語仕様と大きく異なるセマンティクスを持つ。C99 と GNU C におけるセマンティクスの違いについては、Richard Kettlewell による優れた解説がある[Kettlewell 2003]。

例外

PRE00-C-EX1: マクロを使うと、ローカル関数(そのスコープ内の自動変数にアクセスするコード)を実装できるが、これはインライン関数では実現できない。

PRE00-C-EX2: マクロを使うと、トークンの連結や文字列化を実装できる。例えば、

enum Color { Color_Red, Color_Green, Color_Blue };
static const struct {
  enum Color  color;
  const char *name;
} colors[] = {
#define COLOR(color)   { Color_ ## color, #color }
  COLOR(Red), COLOR(Green), COLOR(Blue)
};

COLOR(Red) は {Color_Red, "Red"} に、COLOR(Green) は {Color_Green, "Green"} に、COLOR(Blue) は {Color_Blue, "Blue"} に、それぞれ展開される。詳しくは、「PRE05-C. 字句の結合や文字列化を行う際のマクロ置換動作をよく理解する」を参照のこと。

PRE00-C-EX3: マクロを使うと、コンパイル時定数を得ることができる。これは、インライン関数では必ずしも実現できるとは限らない。

#define ADD_M(a, b) ((a) + (b))
static inline int add_f(int a, int b) {
  return a + b;
}

この例では、ADD_M(3,4) マクロ呼出しは定数式を生成するが、add_f(3,4) 関数呼出しではそうならない。

PRE00-C-EX4: マクロを使えば、C 言語では実装できない (C++ のテンプレートの機能などを使わなければ実現できないような) 型総称関数の機能を実装できる。

関数形式マクロを使って型総称関数を作る例は、「MEM02-C. メモリ割り当て関数の結果は、割り当てた型へのポインタに即座にキャストする」で紹介している。

型総称マクロを使うと例えば、ふたつの同じ型の変数の値を入れ換える操作を行なうことができる。

PRE00-C-EX5: マクロの引数は名前呼出し(call-by-name)で評価されるが、関数では値呼出し(call-by-value)で評価される。名前呼出し(call-by-name)のセマンティクスが要求されるときはマクロを使う必要がある。

リスク評価

マクロの不適切な使用は未定義の動作を引き起こす可能性がある。

自動検出（最新の情報はこちら）

関連するガイドライン

参考資料

翻訳元

これは以下のページを翻訳したものです。

PRE00-C. Prefer inline or static functions to function-like macros (revision 135)

Top へ