CERT C: Rule FIO41-C

二次的影響があるストリーム引数を使用して getc()、putc()、getwc()、putwc() を呼び出さない

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

説明

ルール定義

二次的影響があるストリーム引数を使用して getc()、putc()、getwc()、putwc() を呼び出さないようにします。¹

Polyspace 実装

ルールチェッカーは、"意図しない二次的影響の可能性があるストリーム引数" をチェックします。

例

すべて展開する

意図しない二次的影響の可能性があるストリーム引数

問題

[意図しない二次的影響の可能性があるストリーム引数] は、二次的影響のあるストリーム引数を使用して getc()、putc()、getwc()、または putwc() を呼び出す場合に発生します。

[意図しない二次的影響の可能性があるストリーム引数] は、以下をストリームの二次的影響と見なします。

FILE * など、ストリームの変数の代入、または FILE * の配列など、より深いストリームタイプの変数の代入。
ストリームまたはより深いストリームタイプを操作する関数の呼び出し。

報告される欠陥数は検出された二次的影響の数と一致します。マクロとして実装された関数でストリーム引数が複数回評価される場合、二次的影響のある各評価に対して欠陥が報告されます。

マクロとして実装されていないが、別のオペレーティングシステムでマクロとして実装される可能性がある関数でも、欠陥が報告されます。

リスク

安全でないマクロとして関数が実装されている場合、ストリーム引数が複数回評価される可能性があり、そのストリームの二次的影響が複数回発生します。たとえば、fopen() を呼び出すストリーム引数では同じファイルを複数回開く可能性があり、これは未指定の動作です。

修正方法

ストリームの二次的影響が 1 回のみ発生するように、ストリーム引数に個別のステートメントを使用します。

例 - getc() のストリーム引数の二次的影響 fopen()

#include <stddef.h>
#include <stdio.h>
#include <stdlib.h>

#define fatal_error() abort()

const char* myfile = "my_file.log";

void func(void)
{
    int c;
    FILE* fptr;
    /* getc() has stream argument fptr with
    * 2 side effects: call to fopen(), and assignment
    * of fptr
    */
    c = getc(fptr = fopen(myfile, "r")); //Noncompliant
    if (c == EOF) {
        /* Handle error */
        (void)fclose(fptr);
        fatal_error();
    }
    if (fclose(fptr) == EOF) {
        /* Handle error */
        fatal_error();
    }
}

void main(void)
{
    func();

}

この例では、ストリーム引数 fptr を使用して getc() が呼び出されています。このストリーム引数には、fopen() の呼び出しと fptr の代入という 2 つの二次的影響があります。安全でないマクロとして getc() が実装されている場合、二次的影響が複数回発生します。

修正 — fopen() に個別のステートメントを使用

1 つの修正方法として、fopen() に個別のステートメントを使用します。fopen() の呼び出しと fptr の代入はこのステートメントで発生するため、fptr を getc() に渡すときに二次的影響がありません。

#include <stddef.h>
#include <stdio.h>
#include <stdlib.h>

#define fatal_error() abort()


const char* myfile = "my_file.log";

void func(void)
{
    int c;
    FILE* fptr;

    /* Separate statement for fopen()
    * before call to getc()
    */
    fptr = fopen(myfile, "r");
    if (fptr == NULL) {
        /* Handle error */
        fatal_error();
    }
    c = getc(fptr);
    if (c == EOF) {
        /* Handle error */
        (void)fclose(fptr);
        fatal_error();
    }
    if (fclose(fptr) == EOF) {
        /* Handle error */
        fatal_error();
    }
}

void main(void)
{
    func();

}

チェック情報

グループ: Rule 09.入出力 (FIO)

バージョン履歴

R2019a で導入

参考

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

トピック

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

外部の Web サイト

FIO41-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.