MISRA C:2012 Dir 4.10

Precautions shall be taken in order to prevent the contents of a header file being included more than once

説明

命令の定義

Precautions shall be taken in order to prevent the contents of a header file being included more than once ¹ .

根拠

入れ子にされたヘッダーファイルの複雑な階層が翻訳単位に含まれる場合、特定のヘッダーファイルが 2 回以上インクルードされ、混乱の原因になる可能性があります。複数回のインクルードにより複数の定義または定義の競合が生じる場合、プログラムで未定義の動作または誤動作が発生する可能性があります。

たとえば、ヘッダーファイルに以下が含まれるとします。

#ifdef _WIN64
   int env_var;
#elseif  
   long int env_var;
#endif

ヘッダーファイルが 2 つのインクルードパス (マクロ _WIN64 を定義するパスと定義解除するパス) に含まれる場合、env_var の定義の競合が発生する可能性があります。

Polyspace 実装

コンテンツが複数回のインクルードからガードされていないヘッダーファイルをインクルードする場合、解析ではこの命令への違反を報告します。違反は、ヘッダーファイルの最初に示されます。

複数回のインクルードからヘッダーファイルのコンテンツをガードするための方法がいくつかあります。たとえば、プリプロセッサ命令 ifdef または ifndef をインクルードガードとして使用します。

<start-of-file>
#ifndef <control macro>
#define <control macro>
    /* Contents of file */
#endif
<end-of-file>

または

<start-of-file>
#ifdef <control macro> 
#error ...
#else
#define <control macro>
    /* Contents of file */
#endif
<end-of-file>

トラブルシューティング

ルール違反を想定していてもその違反が表示されない場合、コーディング規約違反が想定どおりに表示されない理由の診断を参照します。

例

すべて展開する

インクルードガード後のコード

ヘッダーファイルがこのコードを含む場合、マクロガードによってヘッダーファイルのコンテンツ全体がカバーされるわけではないため、非準拠です。行 void func2(void) はガードの外部です。

メモ

マクロガードの外にコメントを入力できます。

#ifndef  __MY_MACRO__ 
#define __MY_MACRO__
    void func(void);
#endif
void func2(void);

インクルードガード前のコード

ヘッダーファイルがこのコードを含む場合、マクロガードによってヘッダーファイルのコンテンツ全体がカバーされるわけではないため、非準拠です。行 void func(void) はガードの外部です。

メモ

マクロガードの外にコメントを入力できます。


void func(void);
#ifndef  __MY_MACRO__ 
#define __MY_MACRO__
    void func2(void);
#endif

インクルードガード内の不一致

ヘッダーファイルがこのコードを含む場合、#ifndef ステートメントのマクロ名がその後の #define ステートメントのマクロ名と異なるため、非準拠です。

#ifndef  __MY_MACRO__ 
#define __MY_MARCO__
    void func(void);
    void func2(void);
#endif

分岐されるインクルードガード

分岐されるインクルードガード構造体を使用して、複数回のインクルードに対して保護できます。

#ifndef FOO
#define FOO 1
#else
#undef FOO
#define FOO 2 
/*...Code content */
#endif

このようなインクルードガードはこのルールに準拠しています。

チェック情報

グループ: Code design

カテゴリ: 必要

AGC カテゴリ: 必要

バージョン履歴

R2014b で導入

参考

MISRA C:2012 のチェック (-misra3)

トピック

コーディング規約違反のチェックおよびレビュー

The MISRA coding standards referenced in the Polyspace^® Bug Finder™ documentation are from the following MISRA standards:

MISRA C:2004
MISRA C:2012
MISRA C:2023
MISRA C++:2008
MISRA C++:2023

MISRA and MISRA C are registered trademarks of The MISRA Consortium Limited 2021.