マクロとプリプロセッサの落とし穴

C言語で広く使われる#defineは、可読性の高いコード記述や実行時の高速化に寄与する一方で、予期しないバグの温床になりかねない機能です。プリプロセッサとマクロの基本的な機能を整理した上で、安全に活用するための留意点を解説します。

マクロとプリプロセッサの役割

マクロがプリプロセッサで展開される流れを3段階で示した図。1.ソースコード(人が書く)… #define MAX 100 と #define SQUARE(x) ((x) * (x)) を定義し、for文の中で SQUARE(i) を使う。2.プリプロセッサ(コンパイル前に変換)… #defineなどをコンパイルされるコードへ単純置換で展開する。3.展開後のコード(コンパイルされる)… MAXが100に、SQUARE(i)が((i) * (i))に置き換わる。下段にメリット(実行時コストがなく高速・軽量、意味のある名前でコードがすっきり、定義を変えるだけで修正が一括反映)と、注意すべき点(単純な置換でコンパイル時のチェックは行われない、かっこ不足や多重評価がバグの原因になる、展開後のコードを意識する必要がありデバッグが大変)を示している。

C言語におけるプリプロセッサは、コンパイル前にソースコードを前処理する仕組みです。代表例として挙げられるのが#defineによるマクロ定義です。

#defineの概要(詳細は後述)

#defineで定数や繰り返し出てくる処理に名称を付けることで、コードをわかりやすく整理できます。

ただし#defineは単純なテキスト置換のため、マクロ引数に対する型チェックはおこなわれず、展開結果次第で意図しないコードになり得ます。

#defineのメリット

#defineによるマクロ定義を使うメリットを挙げます。

プログラムがわかりやすくなる

#defineを用いると、特定のコードや定数に意味のある名称(マクロ名)を付けられます。たとえば、ループカウンタの終了条件に特定の数字が入っていたとき、その数字の意味をすぐに理解するのが難しいケースがあります。プログラムを注意深く読めば理解できますが、その作業自体が煩雑です。マクロ定義で適切な命名がされていれば、カウンタの意図が理解でき、プログラムを書いた人しかわからないマジックナンバーを作り出すことを避けられます。

パフォーマンスが上がる

#defineによるマクロは呼び出しの形をとらず、その場に展開されます。そのため、関数呼び出しに伴うオーバーヘッドを回避でき、パフォーマンスの向上が期待できます。ただし、展開のたびにコードが複製されるため、呼び出し箇所が多いとコードサイズが増える点には注意が必要です。

特に繰り返し出てくる簡単な処理をマクロ定義とすると、都度、関数呼び出しに伴うオーバーヘッドが発生しません。コード自体も簡潔に記載でき、先述した意味のある命名もできるため、可読性の高いコードを書くことにもつながります。

#defineの落とし穴

#define は単純にテキスト置換するため、展開後のコードが文法的に正しければ、意図しない動作であってもコンパイルエラーとして検出されません。結果が期待どおりでない場合、展開したマクロ定義をコンパイルオプションや開発環境で確認して、値の変化を追っていくことになります。

かっこ不足

演算優先順位の誤りにつながります。プリプロセッサは単純に展開するだけのため、かっこが無いと、演算子の優先順位に従って、意図とは異なる結合で計算されます。期待する優先順位どおり計算されないときは、かっこ不足の可能性を考えます。

マクロ定義の引数にもかっこが足りないと同様の事象が発生します。マクロを定義する際は、常に引数と式全体をかっこで囲むよう徹底する必要があります。

多重評価

マクロの引数にインクリメント(++)や関数呼び出しなどの副作用を伴う式を渡した場合、マクロ定義内でその引数が複数回使用されていると、意図せず複数回実行(評価)されます。マクロは引数をそのまま展開するためです。たとえば次のマクロを考えます。

#define MAX(a,b) ((a) > (b) ? (a) : (b))

これをMAX(i++,j)のように呼ぶとi++が複数回評価され得ます。エラーとしてプログラムが停止することなく、計算結果だけが意図とずれるため、発見しづらい不具合になります。

マクロの引数にインクリメントや関数呼び出しを渡す場合は、複数回評価されるリスクを考慮する必要があります。

安全に利用するためには

#defineのメリットを享受するには特性を理解し、適切な場面で利用することが求められます。定数の定義や同様の処理が続く場合の効率化には大きな効力を発揮します。修正箇所を集約できるため、ソースコードのメンテナンス性向上も同時に期待できます。

ただし、定数を表すマクロは、C99以降であれば const定数や列挙定数(enum)へ、関数形式のマクロはインライン関数(static inline関数)へ置き換えることがコーディング規約(MISRA Cなど)で推奨されています。ヘッダで提供する場合は、重複定義を避けるためstatic inlineとする設計が一般的です。あわせて、これらの規約違反を検出する静的解析ツールを併用すると、安全性をさらに高められます。

これらの留意点を念頭に置き、場合によってはプリプロセッサによる展開後のコードを確認しながらコーディングを進めることで、安全に#defineが利用できます。

組み込みソフトの世界 トップへ戻る