ロック解除が重複しています

ロック関数はタスク中 2 回呼び出されますが、間にロック解除関数の呼び出しはありません。

説明

このチェッカーは、既定の Polyspace^® as You Code 解析では非アクティブにされます。Polyspace as You Code 解析で非アクティブにされるチェッカー (Polyspace Access)を参照してください。

この欠陥は、以下の場合に発生します。

タスクはロック関数 my_lock を呼び出します。
タスクは対応するロック解除関数 my_unlock を呼び出します。
タスクは再度 my_unlock を呼び出します。タスクは my_unlock の2 回の呼び出しの間で my_lock を 2 回目は呼び出しません。

マルチタスキングコードでは、ロック関数はコードのクリティカルセクションを開始し、ロック解除関数はそれを終了させます。タスク task1 がロック関数 my_lock を呼び出すとき、my_lock を呼び出し中の他のタスクは task1 が対応するロック解除関数を呼び出すまで待たなくてはなりません。

この欠陥を検出するには、次のいずれかのメソッドを使用してロック関数とロック解除関数を指定します。

Polyspace Bug Finder™ で自動的に検出できるいずれかの同時実行プリミティブ型を呼び出します。Polyspace でのスレッド作成とクリティカルセクションの自動検出を参照してください。
ロック関数およびロック解除関数は、解析前に構成オプションとして明示的に指定します。Polyspace ではロック関数およびロック解除関数の両方が void func(void) 形式に準拠しなくてはなりません。クリティカルセクション詳細 (-critical-section-begin -critical-section-end) を参照してください。

リスク

ロック解除の重複の欠陥は、コーディングエラーを示す可能性があります。別のクリティカルセクションを終了するために異なるロック解除関数を呼び出す必要があった可能性もあります。最初のロック解除関数を途中で呼び出しているが、2 番目の呼び出しだけがクリティカルセクションの終了を意図していた可能性もあります。

修正方法

修正方法は欠陥の根本原因によって異なります。

コードの各クリティカルセクション、つまり、Atomic ブロックとして実行するセクションを特定します。セクションの最初でロック関数を呼び出します。セクションの最後でのみ、ロック関数に対応するロック解除関数を呼び出します。ロック解除関数のそれ以外の冗長な呼び出しはすべて削除します。

以下の修正例を参照してください。この問題を回避するには、同じモジュール内のロック関数とロック解除関数を同じ抽象化レベルで呼び出す手法に従うことをお勧めします。次の例の場合、func はロック関数とロック解除関数を同じレベルで呼び出していますが、func2 はそうではありません。

void func() {
  my_lock();
  {
    ...
  }
  my_unlock();
}

void func2() {
  {
   my_lock();
   ...
  }
  my_unlock();
}

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

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

チェッカーの拡張

Polyspace でサポートされていないロック解除関数を使用する場合があります。その場合、ロック解除関数を、POSIX^® の既知の同等の関数にマッピングすることで、このチェッカーを拡張します。サポートされていないマルチスレッド環境への同時実行欠陥チェッカーの拡張を参照してください。

例

すべて展開する

ロック解除が重複しています



int global_var;

void BEGIN_CRITICAL_SECTION(void);
void END_CRITICAL_SECTION(void);

void task1(void)
{
    BEGIN_CRITICAL_SECTION();
    global_var += 1;
    END_CRITICAL_SECTION();
    global_var += 1;
    END_CRITICAL_SECTION();
}

void task2(void)
{
    BEGIN_CRITICAL_SECTION();
    global_var += 1;
    END_CRITICAL_SECTION();
}

この例では、マルチタスクの動作をエミュレートするため、以下のオプションを指定しなければなりません。

オプション	値
`マルチタスクを手動で構成`
`タスク (-entry-points)`	`task1` `task2`
`クリティカルセクション詳細 (-critical-section-begin -critical-section-end)`	開始ルーチン	終了ルーチン
	`BEGIN_CRITICAL_SECTION`	`END_CRITICAL_SECTION`

コマンドラインでは以下を使用できます。

 polyspace-bug-finder
   -entry-points task1,task2
   -critical-section-begin BEGIN_CRITICAL_SECTION:cs1
   -critical-section-end END_CRITICAL_SECTION:cs1

task1 は BEGIN_CRITICAL_SECTION(); でクリティカルセクションを開始します。task1 は END_CRITICAL_SECTION(); を呼び出してクリティカルセクションを離れます。task1 は END_CRITICAL_SECTION を再度呼び出しますが、その間 BEGIN_CRITICAL_SECTION を呼び出しません。

修正 — 2 番目のロック解除を削除

2 番目の global_var+=1; をクリティカルセクションの外部に置きたい場合、1 つの修正方法として END_CRITICAL_SECTION への 2 番目の呼び出しを削除できます。ただし、他のタスクが global_var を使用している場合、このコードはデータレースエラーを発生させることがあります。



int global_var;

void BEGIN_CRITICAL_SECTION(void);
void END_CRITICAL_SECTION(void);

void task1(void)
{
    BEGIN_CRITICAL_SECTION();
    global_var += 1;
    END_CRITICAL_SECTION();
    global_var += 1;
}

void task2(void)
{
    BEGIN_CRITICAL_SECTION();
    global_var += 1;
    END_CRITICAL_SECTION();
}

修正 — 最初のロック解除を削除

2番目の global_var+=1; をクリティカルセクションの内部に置きたい場合、1 つの修正方法として END_CRITICAL_SECTION の最初の呼び出しを削除できます。



int global_var;

void BEGIN_CRITICAL_SECTION(void);
void END_CRITICAL_SECTION(void);

void task1(void)
{
    BEGIN_CRITICAL_SECTION();
    global_var += 1;
    global_var += 1;
    END_CRITICAL_SECTION();
}

void task2(void)
{
    BEGIN_CRITICAL_SECTION();
    global_var += 1;
    END_CRITICAL_SECTION();
}

修正 — 別のロックを追加

2番目の global_var+=1; をクリティカルセクションの内部に置きたい場合、他の修正方法として BEGIN_CRITICAL_SECTION の呼び出しを別に追加することができます。



int global_var;

void BEGIN_CRITICAL_SECTION(void);
void END_CRITICAL_SECTION(void);

void task1(void)
{
    BEGIN_CRITICAL_SECTION();
    global_var += 1;
    END_CRITICAL_SECTION();
    BEGIN_CRITICAL_SECTION();
    global_var += 1;
    END_CRITICAL_SECTION();
}

void task2(void)
{
    BEGIN_CRITICAL_SECTION();
    global_var += 1;
    END_CRITICAL_SECTION();
}

結果情報

グループ: 同時実行

言語: C | C++

既定値: オン

コマンドライン構文: DOUBLE_UNLOCK

影響度: High

バージョン履歴

R2014b で導入

すべて展開する

R2023b: `std::lock_guard` および `std::try_lock()` を使用すると、ダブルロック解除が検出される

R2023b 以降、Polyspace Bug Finder は以下のケースをロック関数の呼び出しとして自動的に検出できるようになっています。

スレッドが変数 std::mutex をロックするために std::try_lock()、std::try_lock_for()、または std::try_lock_until() を呼び出す。
スレッドが変数 std::mutex のラッパーとして std::lock_guard オブジェクトを作成する。

同様に、ブロック内で std::lock_guard オブジェクトが作成される場合、Polyspace Bug Finder は自動的に、ブロック末尾をロック解除関数の呼び出しと見なします。

たとえば、次の例では、スレッド t が関数 begin_task() によって開始されます。この関数は、ミューテックス shared_var_mutex をロックするために std::lock_guard オブジェクトの lock を作成します。次に、関数は別の関数 increment_shared_var() を呼び出します。その関数により、std::unlock() を使用して shared_var_mutex のロック解除が試行されます。ただし、制御が関数 begin_task() に戻った後、関数が終了して std::lock_guard オブジェクトの lock がスコープ外になると、ミューテックスが再度ロック解除されます。このケースに対し、チェッカーは [ロック解除が重複しています] の欠陥を報告します。

#include <mutex>
#include <thread>

int shared_var = 0;
std::mutex shared_var_mutex;

void do_thread_safe_work();

void increment_shared_var()
{
    while (!shared_var_mutex.try_lock()) 
        {

        }
    shared_var++;
    shared_var_mutex.unlock();
}

void begin_task()
{
    std::lock_guard<std::mutex> lock(shared_var_mutex);
    increment_shared_var();
}

void main()
{
    std::thread t(begin_task);
    increment_shared_var();
    t.join();
}

参考

ロック解除が重複しています

説明

リスク

修正方法

チェッカーの拡張

例

ロック解除が重複しています

結果情報

バージョン履歴

R2023b: std::lock_guard および std::try_lock() を使用すると、ダブル ロック解除が検出される

参考

トピック

R2023b: `std::lock_guard` および `std::try_lock()` を使用すると、ダブルロック解除が検出される