CERT C: Rec.DCL01-C

Do not reuse variable names in subscopes

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

説明

ルール定義

サブスコープで変数名を再利用しないようにします。¹

Polyspace 実装

ルールチェッカーは、"変数のシャドウイング" をチェックします。

例

すべて展開する

変数のシャドウイング

問題

変数のシャドウイングは、外側のスコープで変数が同じ名前の別の変数を隠す場合に発生します。

たとえば、ローカル変数の名前がグローバル変数と同じ名前である場合、ローカル変数はその有効期間の間、グローバル変数を隠します。

リスク

内側のスコープと外側のスコープに同じ名前の 2 つの変数が存在する場合、その変数名を参照すると、内側のスコープの変数が使用されます。しかし、開発者またはコードレビュー担当者は、外側のスコープの変数が使用されるという誤った想定をする可能性があります。

修正方法

修正方法は欠陥の根本原因によって異なります。たとえば、関数をリファクタリングして、ローカルの静的変数をグローバル変数の代わりに使用するとします。この場合、グローバル変数は冗長であり、その宣言を削除できます。または、グローバル変数が他の場所で使用されているか不明な場合、ローカルの静的変数の名前とその関数内のすべての参照を変更できます。

シャドウイングが意図したもので、問題を修正しない場合は、改めてレビューされないように結果またはコードにコメントを追加します。詳細は、以下を参照してください。

Polyspace ユーザーインターフェイスでのバグ修正または正当化による結果への対処(Polyspace ユーザーインターフェイスで結果をレビューする場合)
Polyspace Access でのバグ修正または正当化による結果への対処 (Polyspace Access)(Web ブラウザーで結果をレビューする場合)。
コードへの注釈付けと既知の結果または許容可能な結果の非表示 (IDE で結果をレビューする場合)

例 - 変数のシャドウイングエラー

#include <stdio.h>

int fact[5]={1,2,6,24,120};

int factorial(int n)
 {
  int fact=1;  //Noncompliant
  /*Defect: Local variable hides global array with same name */

  for(int i=1;i<=n;i++)
    fact*=i;

  return(fact);
 }

関数 factorial 内で、整数変数 fact がグローバル整数配列 fact を隠しています。

修正 — 変数名を変更

1 つの修正方法として、いずれかの変数、できればよりローカルなスコープをもつ変数の名前を変更することができます。

#include <stdio.h>

int fact[5]={1,2,6,24,120};

int factorial(int n)
 {
  /* Fix: Change name of local variable */
  int f=1; 

  for(int i=1;i<=n;i++)
    f*=i;

  return(f);
 }

チェック情報

グループ: Rec.02.宣言と初期化 (DCL)

バージョン履歴

R2019a で導入

参考

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

トピック

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

外部の Web サイト

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