# Undefined Behavior Sanitizerを使ったコード品質向上法

## 目次

1. はじめに

2. Undefined Behavior（未定義動作）とは

3. Undefined Behavior Sanitizer（UBSan）とは

4. UBSanのインストール方法

5. UBSanの使用法

    1. 基本的な使用方法

    2. より高度な設定と使用例

6. UBSanによるエラー検出の事例

7. UBSanと他のツールとの比較

8. UBSanがコード品質に与える影響

9. まとめ

## 1. はじめに

ソフトウェア開発において、コード品質の向上はプロジェクトの成功に重要な要素です。特にC/C++言語においては、未定義動作（Undefined Behavior, UB）がバグの原因となり得ます。この問題を解決するために、Undefined Behavior Sanitizer（UBSan）というツールが登場しました。本記事では、UBSanがどのように動作するのか、どのように利用できるのかを具体的に見ていきます。

## 2. Undefined Behavior（未定義動作）とは

未定義動作とは、プログラムが何らかの不正または異例な操作を行ったときに、C/C++標準ではその動作を規定しないために、予測不可能な結果を生じる状況を指します。例えば、バッファオーバーラン、ゼロによる除算、無効なメモリアクセスなどがあります。

例えば、以下のC++コードは未定義動作を引き起こします。

```cpp

int x = 0;

int y = 10 / x;  // 未定義動作：ゼロによる除算

```

未定義動作が発生すると、プログラムが一見正しく動いているように見えたとしても、異なる環境や状況で予期せぬ動作をすることがあります。

## 3. Undefined Behavior Sanitizer（UBSan）とは

UBSanは、C/C++言語で発生する可能性のある未定義動作を検出するためのツールです。コンパイラのオプションとして利用可能で、プログラム内の未定義動作を実行時に検出し、詳細なエラーメッセージを出力します。

UBSanを有効にすると、コンパイル時に特別なコードが挿入され、実行中の未定義動作を監視します。これにより、バグの検出が簡単になり、コードの安全性が高まります。

## 4. UBSanのインストール方法

UBSanは、GCCおよびClangの標準ライブラリに含まれています。特別なインストール手順は必要なく、新しいバージョンのGCCまたはClangをインストールするだけで使用可能です。

### インストール手順（macOSでClangを利用する場合）

1. Homebrewを使用してClangをインストールします。

    ```bash

    brew install llvm

    ```

2. パスを通すために、以下のコマンドを実行します。

    ```bash

    echo 'export PATH="/usr/local/opt/llvm/bin:$PATH"' >> ~/.bash_profile

    source ~/.bash_profile

    ```

3. Clangのバージョンを確認します。

    ```bash

    clang --version

    ```

これでUBSanを利用する準備は整いました。

## 5. UBSanの使用法

### 5.1 基本的な使用方法

UBSanを使用するためには、コンパイル時に特別なフラグを指定します。

```bash

clang -fsanitize=undefined -o my_program my_program.cpp

```

このフラグを指定することで、UBSanが有効になり、未定義動作が発生した場合に警告を出力します。

### 5.2 より高度な設定と使用例

UBSanには多くの設定があり、特定の未定義動作に対してのみ警告を出したり、エラーレポートの詳細さを調整したりできます。

#### 特定の未定義動作のみをチェックする

例えば、整数オーバーフローのみを検出したい場合は以下のように指定します。

```bash

clang -fsanitize=signed-integer-overflow -o my_program my_program.cpp

```

#### すべてのチェックを有効にする

すべての未定義動作をチェックしたい場合は、次のようにします。

```bash

clang -fsanitize=undefined -fsanitize=unsigned-integer-overflow -o my_program my_program.cpp

```

また、コンパイルしたプログラムを実行する際に、環境変数を設定してレポートの詳細度を調整できます。

```bash

UBSAN_OPTIONS=print_stacktrace=1 ./my_program

```

このオプションを利用することで、エラー発生時のスタックトレースを表示し、デバッグを容易にします。

## 6. UBSanによるエラー検出の事例

ここでは、UBSanによるエラー検出の実例をいくつか紹介します。

### 6.1 ゼロによる除算

```cpp

int divide(int a, int b) {

    return a / b;

}

int main() {

    printf("%d\n", divide(10, 0));  // 未定義動作

    return 0;

}

```

このコードをUBSanでコンパイルして実行すると、以下のような警告が表示されます。

```

runtime error: division by zero

```

### 6.2 整数オーバーフロー

```cpp

int main() {

    int a = INT_MAX;

    a++;

}

```

このコードでは、`INT_MAX`を超える整数オーバーフローが発生します。実行時に以下の警告が出力されます。

```

runtime error: signed integer overflow: 2147483647 + 1 cannot be represented in type 'int'

```

## 7. UBSanと他のツールとの比較

UBSanは未定義動作の検出に特化していますが、他にもコード品質を向上させるツールは数多く存在します。

### 7.1 AddressSanitizer (ASan)

ASanは、メモリのバッファオーバーフロー、ダングリングポインタや二重解放といったメモリの誤使用を検出します。UBSanとは異なるアプローチでメモリ関連のバグを監視します。

### 7.2 ThreadSanitizer (TSan)

TSanはデータ競合を検出するためのツールです。並行プログラムにおけるスレッド間のデータ競合を特定し、未定義動作を防ぎます。

### 7.3 比較表

| ツール名     | 検出する不具合                   | 使用例                |

|--------------|---------------------------------|-----------------------|

| UBSan        | 未定義動作                       | 過剰に加算されたint   |

| ASan         | メモリのバッファオーバーフロー   | バッファオーバーラン   |

| TSan         | データ競合                       | 複数スレッド間のアクセス |

この表が示すように、各ツールは異なる懸念事項に焦点を当てているため、複数のツールを組み合わせることで、より包括的なコーディングエラーの検出が可能になります。

## 8. UBSanがコード品質に与える影響

UBSanの導入により、C/C++プログラムのコード品質は大きく向上します。未定義動作は、潜在的なバグの原因となるため、これを早期に検出して対処することは、堅牢なソフトウェアを構築する上で不可欠です。

### コード品質向上のメリット

- **バグの早期発見**: 開発初期の段階で異常を検出することで、修正コストを削減。

- **信頼性の向上**: 未定義動作による予期せぬ挙動を排除し、プログラムの信頼性を向上。

- **開発効率の向上**: 自動検出ツールにより、手作業によるコードレビューの負担を軽減。

## 9. まとめ

Undefined Behavior Sanitizerは、未定義動作を効果的に検出するツールとして、C/C++開発者にとって非常に有益です。UBSanを正しく導入し、未定義動作を排除することで、プログラムの信頼性や安全性を大幅に向上させることができます。他のサニタライザツールと併用することで、さらに包括的なバグ検出が可能となり、より高品質なソフトウェア開発が実現できます。既存のプロジェクトに導入し、潜在的なバグを洗い出し、迅速に対応することをお勧めします。



Undefined Behavior Sanitizerを使ったコード品質向上法

目次

続きを読むには単価診断を受けてください（30秒）