このページの内容は最新ではありません。最新版の英語を参照するには、ここをクリックします。

CERT C++: CON54-CPP

Wrap functions that can spuriously wake up in a loop

説明

ルール定義

誤って起動する可能性のある関数はループ内にラップします。¹

Polyspace 実装

ルール チェッカーは、"誤って起動する可能性のある関数はループでラップされません" をチェックします。

例

誤って起動する可能性のある関数はループでラップされません

問題

誤って起動する可能性のある関数はループでラップされませんは、以下の待機条件関数が、ループの外側から呼び出された場合に発生します。

• C 関数:

  • cnd_wait()

  • cnd_timedwait()

• POSIX 関数:

  • pthread_cond_wait()

  • pthread_cond_timedwait()

• C++ の std::condition_variable および std::condition_variable_any クラス メンバー関数:

  • wait()

  • wait_until()

  • wait_for()

待機条件関数は、指定された条件が満たされた場合に呼び出し元スレッドの実行を一時停止します。そのスレッドは、別のスレッドから cnd_broadcast() または同等の関数を使用して通知されるとすぐに起動および再開されます。起動通知は誤りであったり悪意のものであったりする場合があります。

リスク

スレッドが誤った起動通知を受け取り、そのときに待機条件関数の条件がチェックされていない場合、スレッドが途中で起動する可能性があります。その起動は、予期しない制御フロー、他のスレッドの無期限のブロック、またはサービス拒否の原因になるおそれがあります。

修正方法

誤って起動する可能性のある待機条件関数をループ内にラップします。誤りの可能性がある起動通知後に、ループで起動条件をチェックします。

例 - ループ内にラップされていない std::condition_variable::wait

#include <stdio.h>
#include <stddef.h>
#include <thread>
#include <mutex>

#define THRESHOLD 100

std::mutex myMutex;
std::condition_variable cv;

void func(int input)
{
	std::unique_lock<std::mutex> lk(myMutex);
	// test condition to pause thread 
	if (input > THRESHOLD) {
	//pause current thread
		cv.wait(lk);//Noncompliant
	}
}

この例では、input が THRESHOLD よりも大きい場合、スレッドは std::condition_variable::wait を使用して実行を一時停止します。一時停止したスレッドは、すべてのスレッドに通知を行う std::condition_variable::notify_all が別のスレッドで使用されると再開される可能性があります。この通知により、一時停止条件が true から変わっていない場合でもスレッドが起動することになります。

修正 — std::condition_variable::wait を while ループ内に明示的にラップ

1 つの修正方法として、std::condition_variable::wait の呼び出しを while ループ内にラップします。誤りの可能性がある起動通知をスレッドで受け取った後に、ループで一時停止条件をチェックします。

#include <stdio.h>
#include <stddef.h>
#include <thread>
#include <mutex>

#define THRESHOLD 100

std::mutex myMutex;
std::condition_variable cv;

void func(int input)
{
	std::unique_lock<std::mutex> lk(myMutex);
	// test condition to pause thread 
	while (input > THRESHOLD) {
	//pause current thread
		cv.wait(lk);
	}
}

修正 — std::condition_variable::wait をループ内に暗黙的にラップ

関数 std::condition_variable::wait には、第 2 引数としてラムダ関数を受け入れるオーバーロードが生じます。ラムダ関数の述語は、待機を中止してコード実行に進んでも安全なタイミングを示します。関数 std::condition_variable::wait のこのオーバーロードは、ループ内に暗黙的にラップされているかのように振る舞います。このコードでは、関数 std::condition_variable::wait がラムダ関数を使用して呼び出されます。ここでは、ラムダ関数の述語が真の場合にスレッドが起動するため、スレッドの不要な起動が阻止されます。

#include <stdio.h>
#include <stdio.h>
#include <stddef.h>
#include <thread>
#include <mutex>
#define THRESHOLD 100

std::mutex myMutex;
std::condition_variable cv;

void func(int input)
{
	std::unique_lock<std::mutex> lk(myMutex);
	cv.wait(lk,[&input]{ return !(input>THRESHOLD); });
	
}

チェック情報

グループ: 10.同時実行 (CON)

バージョン履歴

R2019a で導入

参考

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

トピック

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

外部の Web サイト

• CON54-CPP

---

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