CERT C: Rec.PRE06-C

ヘッダーファイルをインクルードガード内に囲む

このページをすべて展開する

説明

ルール定義

ヘッダーファイルをインクルードガード内に囲みます。¹

Polyspace 実装

ルールチェッカーは、"複数回のインクルードからガードされていないヘッダーファイルのコンテンツ" をチェックします。

例

すべて展開する

複数回のインクルードからガードされていないヘッダーファイルのコンテンツ

問題

この問題は、ヘッダーファイルのコンテンツが複数回インクルードされるのを防ぐための安全対策が講じられていない場合に発生します。

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

以下の方法のいずれかを使用して、複数回のインクルードからヘッダーファイルのコンテンツをガードできます。


//<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>

これらの方法のいずれかを使用しない限り、Polyspace^® ではヘッダーファイルのインクルードを非準拠としてフラグを設定します。

リスク

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

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

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

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

例 - マクロガード後のコード

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

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

メモ

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

例 - マクロガード前のコード


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

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

メモ

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

例 - マクロガード内の不一致

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

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

チェック情報

グループ: Rec.01.プリプロセッサ (PRE)

バージョン履歴

R2019a で導入

参考

SEI CERT-C をチェック (-cert-c)

トピック

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

外部の Web サイト

PRE06-C

¹ This software has been created by MathWorks incorporating portions of: the “SEI CERT-C Website,” © 2017 Carnegie Mellon University, the SEI CERT-C++ Web site © 2017 Carnegie Mellon University, ”SEI CERT C Coding Standard – Rules for Developing safe, Reliable and Secure systems – 2016 Edition,” © 2016 Carnegie Mellon University, and “SEI CERT C++ Coding Standard – Rules for Developing safe, Reliable and Secure systems in C++ – 2016 Edition” © 2016 Carnegie Mellon University, with special permission from its Software Engineering Institute.

ANY MATERIAL OF CARNEGIE MELLON UNIVERSITY AND/OR ITS SOFTWARE ENGINEERING INSTITUTE CONTAINED HEREIN IS FURNISHED ON AN "AS-IS" BASIS. CARNEGIE MELLON UNIVERSITY MAKES NO WARRANTIES OF ANY KIND, EITHER EXPRESSED OR IMPLIED, AS TO ANY MATTER INCLUDING, BUT NOT LIMITED TO, WARRANTY OF FITNESS FOR PURPOSE OR MERCHANTABILITY, EXCLUSIVITY, OR RESULTS OBTAINED FROM USE OF THE MATERIAL. CARNEGIE MELLON UNIVERSITY DOES NOT MAKE ANY WARRANTY OF ANY KIND WITH RESPECT TO FREEDOM FROM PATENT, TRADEMARK, OR COPYRIGHT INFRINGEMENT.

This software and associated documentation has not been reviewed nor is it endorsed by Carnegie Mellon University or its Software Engineering Institute.