CERT C++: EXP61-CPP

A lambda object must not outlive any of its reference captured objects

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

説明

ルール定義

A lambda object must not outlive any of its reference captured objects.¹

Polyspace 実装

ルールチェッカーは、"オブジェクトがラムダ式によってスコープをエスケープする" をチェックします。

例

すべて展開する

オブジェクトがラムダ式によってスコープをエスケープする

問題

この問題は、ラムダ式が "参照によって" オブジェクトを取得しており、そのラムダ式オブジェクトが取得元オブジェクトよりも長く存続する場合に発生します。たとえば、取得元オブジェクトがローカル変数であるのに、ラムダ式オブジェクトがより大きなスコープをもつ場合です。

リスク

自身のいずれかの参照取得オブジェクトよりもラムダ式オブジェクトが長く存続する場合、取得元のオブジェクトがスコープ外からアクセス可能になります。

たとえば、関数 createFunction を考えます。

std::function<std::int32_t()> createFunction() {
   std::int32_t localVar = 0;
   return ([&localVar]() -> std::int32_t {
       localVar = 1;
       return localVar;
   });
}

createFunction は、"参照によって" ローカル変数 localVar を取得するラムダ式オブジェクトを返します。localVar のスコープは createFunction に制限されますが、返されたラムダ式オブジェクトはより大きなスコープをもちます。

このような状況では、スコープの外でローカルオブジェクトである localVar に対するアクセスが行われる可能性があります。たとえば、次のように、createFunction を呼び出し、返されたラムダ式オブジェクトを別のオブジェクト aFunction に割り当てるとします。

auto aFunction = createFunction();

次いで、新しいオブジェクトaFunction を呼び出します。

std::int32_t someValue = aFunction();

取得元の変数 localVar はスコープ外です。したがって、aFunction から返される値は未定義となります。

修正方法

関数がラムダ式を返す場合、取得オブジェクトに対するスコープ外アクセスを防ぐため、そのラムダ式がすべてのオブジェクトをコピーによって取得するようにします。たとえば、createFunction を次のように書き換えることができます。

std::function<std::int32_t()> createFunction() {
   std::int32_t localVar = 0;
   return ([localVar]() mutable -> std::int32_t {
       localVar = 1;
       return localVar;
   });
}

例 – ローカル変数を指すポインターがラムダ式によってエスケープされる

auto createAdder(int amountToAdd) {
  int addThis = amountToAdd; //Noncompliant
  auto adder = [&] (int initialAmount) {
      return (initialAmount + addThis);
  };
  return adder;
}
 
void func() {
  auto AddByTwo = createAdder(2);
  int res = AddByTwo(10);
}

この例では、関数 createAdder で、参照によってローカル変数 addThis を取得するラムダ式 adder を定義しています。addThis のスコープは関数 createAdder に制限されます。createAdder によって返されたオブジェクトが呼び出されると、変数 addThis に対する参照がスコープ外からアクセスされます。この方法でアクセスが行われると、addThis の値は未定義となります。

修正 – 参照ではなくラムダ式でのコピーによってローカル変数を取得

関数がラムダ式オブジェクトを返す場合は、ラムダ式でローカル変数を参照によって取得しないようにします。代わりにコピーによって変数を取得します。

auto createAdder(int amountToAdd) {
  int addThis = amountToAdd;
  auto adder = [=] (int initialAmount) {
      return (initialAmount + addThis);
  };
  return adder;
}
 
void func() {
  auto AddByTwo = createAdder(2);
  int res = AddByTwo(10);
}

チェック情報

グループ: 02.式 (EXP)

バージョン履歴

R2019b で導入

参考

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

トピック

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

外部の Web サイト

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