コンテンツにスキップ

C言語/noreturn

リンクを追加
出典: フリー教科書『ウィキブックス（Wikibooks）』

noreturn属性の概要

[編集]

C23規格では、関数の振る舞いをより明確に表現するための属性の一つとして、noreturn属性が標準化されました。この属性は、関数が呼び出し元に制御を返さないことを明示的に示すためのものです。つまり、その関数が呼び出されると、プログラムの実行フローが正常に戻ることはないことを意味します。

noreturn属性は、C11で導入された_Noreturnキーワードと同等の機能を提供しますが、標準的な属性構文を使用することで、コードの一貫性と可読性が向上します。C23では両方の形式がサポートされていますが、新しいコードではnoreturn属性の使用が推奨されています。

構文と基本的な使用方法

[編集]

noreturn属性の基本的な構文は次のとおりです： 

[[noreturn]] 戻り値の型 関数名(パラメータリスト);

この属性は関数宣言に適用され、その関数が呼び出し元に制御を返さないことを示します。

以下に、基本的な使用例を示します： 

#include <stdio.h>
#include <stdlib.h>
// 致命的なエラーが発生した場合にプログラムを終了する関数
[[noreturn]] void fatal_error(const char* message) {
    fprintf(stderr, "致命的エラー: %s\n", message);
    exit(EXIT_FAILURE);
}

int main(void) {
    int x = -1;
    
    if (x < 0) {
        fatal_error("xは負の値であってはなりません");
    }
    
    // このコードは実行されない
    printf("x = %d\n", x);
    
    return 0;
}

この例では、fatal_error関数にnoreturn属性が付与されています。この関数はexit関数を呼び出してプログラムを終了するため、呼び出し元に制御を返すことはありません。コンパイラはこの情報を利用して最適化を行い、fatal_error呼び出し後のコードが到達不能であることを認識します。

C11の_Noreturnキーワードとの比較

[編集]

C11では、関数が戻らないことを示すために_Noreturnキーワードが導入されました。C23では互換性のために両方の形式がサポートされていますが、属性構文の方が一貫性があり、将来的な拡張性が高いため推奨されています。 

#include <stdio.h>
#include <stdlib.h>
// C11の_Noreturnキーワードを使用した宣言
_Noreturn void abort_program_c11(const char* message) {
    fprintf(stderr, "プログラム中断 (C11): %s\n", message);
    exit(EXIT_FAILURE);
}

// C23の[[noreturn]]属性を使用した宣言
[[noreturn]] void abort_program_c23(const char* message) {
    fprintf(stderr, "プログラム中断 (C23): %s\n", message);
    exit(EXIT_FAILURE);
}

// <stdnoreturn.h>のマクロを使用した宣言（C11以降）
#include <stdnoreturn.h>
noreturn void abort_program_macro(const char* message) {
    fprintf(stderr, "プログラム中断 (マクロ): %s\n", message);
    exit(EXIT_FAILURE);
}

int main(void) {
    int status_code = -1;
    
    if (status_code == -1) {
        // 3つの関数はすべて同等の機能を提供
        abort_program_c23("エラーコード -1");
        
        // 以下のコードは到達不能
        printf("このメッセージは表示されません\n");
    }
    
    return 0;
}

以下の表で、noreturn属性と_Noreturnキーワードの違いを比較します：

特徴 [[noreturn]] 属性 _Noreturn キーワード
導入された規格 C23 C11
構文 属性構文 [[noreturn]] キーワード _Noreturn
他の属性との組み合わせ 容易（属性リスト内で指定可能） 困難（特殊な構文が必要）
可読性 高い（他の属性と一貫した構文） やや低い（特殊な構文）
互換性 C++との互換性が高い C++との互換性がない
推奨 C23以降の新規コードで推奨 古いコードとの互換性のために維持

実践的な使用例

[編集]

エラー処理関数

[編集]

noreturn属性の最も一般的な使用例の一つは、致命的なエラーが発生した場合にプログラムを終了する関数です。 

#include <stdio.h>
#include <stdlib.h>
#include <stdarg.h>
[[noreturn]] void fatal_error(const char* format, ...) {
    va_list args;
    va_start(args, format);
    
    fprintf(stderr, "致命的エラー: ");
    vfprintf(stderr, format, args);
    fprintf(stderr, "\n");
    
    va_end(args);
    
    // クリーンアップ処理
    // ...
    
    exit(EXIT_FAILURE);
}

int divide(int a, int b) {
    if (b == 0) {
        fatal_error("ゼロによる除算 (a=%d, b=%d)", a, b);
    }
    return a / b;
}

アサーション関数

[編集]

デバッグ用のアサーション関数も、noreturn属性の良い使用例です。 

#include <stdio.h>
#include <stdlib.h>
[[noreturn]] void assertion_failed(const char* expression, const char* file, int line) {
    fprintf(stderr, "アサーション失敗: %s\nファイル: %s, 行: %d\n", 
            expression, file, line);
    abort();
}

#define ASSERT(expr) \
    do { \
        if (!(expr)) { \
            assertion_failed(#expr, __FILE__, __LINE__); \
        } \
    } while (0)

int main(void) {
    int* ptr = NULL;
    
    ASSERT(ptr != NULL);  // アサーション失敗
    
    // このコードは実行されない
    *ptr = 42;
    
    return 0;
}

スレッド終了関数

[編集]

マルチスレッドプログラミングでは、現在のスレッドを終了する関数にnoreturn属性を使用することがあります。 

#include <stdio.h>
#include <threads.h>
[[noreturn]] void thread_exit_with_message(const char* message) {
    printf("スレッド終了: %s\n", message);
    thrd_exit(0);  // 現在のスレッドを終了
}

int thread_function(void* arg) {
    printf("スレッド実行中...\n");
    
    if (*(int*)arg < 0) {
        thread_exit_with_message("引数が負の値です");
    }
    
    printf("スレッド処理完了\n");
    return 0;
}

コンパイラの最適化

[編集]

noreturn属性の最も重要な利点の一つは、コンパイラが関数呼び出し後のコードが到達不能であることを認識し、最適化を行えることです。これにより、コードサイズの削減やパフォーマンスの向上が期待できます。

以下に、コンパイラの最適化がどのように機能するかを示す例を示します： 

int process_data(int value) {
    if (value < 0) {
        fatal_error("値が負です");
        // コンパイラはここに到達しないことを知っているため、
        // リターンステートメントや後続のコードを最適化できる
    }
    
    return value * 2;
}

この例では、fatal_error関数がnoreturnと宣言されているため、コンパイラはifブロック後のコードがvalue >= 0の場合にのみ実行されることを認識します。これにより、より効率的なコード生成が可能になります。

実装上の注意点

[編集]

戻り値型との一貫性

[編集]

noreturn属性を持つ関数でも、戻り値の型を宣言する必要があります。慣習的にはvoidが使用されますが、他の型も技術的には可能です。 

// 推奨される使用法
[[noreturn]] void exit_program(int status);

// 技術的には可能だが混乱を招く可能性がある
[[noreturn]] int terminate_process(int status);

関数の実装

[編集]

noreturn属性を持つ関数は、実際に制御を返さない実装である必要があります。一般的には、以下のいずれかの方法で終了します：

終了方法 例 用途
exit関数 exit(EXIT_FAILURE); 通常のプログラム終了
abort関数 abort(); 異常終了（コアダンプ生成）
_Exit関数 _Exit(EXIT_FAILURE); クリーンアップなしの即時終了
quick_exit関数 quick_exit(EXIT_FAILURE); 高速終了（C11以降）
longjmp関数 longjmp(env, 1); 非ローカルジャンプ
スレッド終了関数 thrd_exit(0); 現在のスレッドのみ終了
無限ループ for(;;) {} 特定の組込みシステム

noreturn属性を持つ関数が実際に制御を返すと、処理系定義の動作となり、通常は未定義動作と見なされます。

コンパイラ対応状況

[編集]

noreturn属性の対応状況は、コンパイラによって異なります。主要なコンパイラの対応状況を以下の表に示します：

コンパイラ バージョン [[noreturn]] _Noreturn 注意事項
GCC 4.8以上 対応 -std=c2xまたは-std=c23フラグが必要
Clang 3.3以上 対応 -std=c2xまたは-std=c23フラグが必要
MSVC 2019以上 対応 部分対応 /std:c23フラグが必要
ICC (Intel) 2021以上 対応 特定のコンパイラオプションが必要

古いコンパイラでの互換性を確保するには、以下のようなマクロを定義することが有効です： 

#include <stdio.h>
#include <stdlib.h>
// 様々なコンパイラで互換性のあるnoreturn定義
#if defined(__STDC_VERSION__) && __STDC_VERSION__ >= 202311L
  // C23標準: 属性構文
  #define NORETURN [[noreturn]]
#elif defined(__STDC_VERSION__) && __STDC_VERSION__ >= 201112L
  // C11標準: _Noreturnキーワード
  #define NORETURN _Noreturn
#elif defined(__GNUC__) || defined(__clang__)
  // GCCおよびClang拡張
  #define NORETURN __attribute__((noreturn))
#elif defined(_MSC_VER)
  // Microsoft Visual C++拡張
  #define NORETURN __declspec(noreturn)
#else
  // 他のコンパイラ（警告抑制はできないが構文エラーは避ける）
  #define NORETURN
#endif
// コンパイラ非依存のnoreturn関数
NORETURN void terminate_program(const char* message) {
    fprintf(stderr, "プログラム終了: %s\n", message);
    exit(EXIT_FAILURE);
}

int main(void) {
    int error_code = 1;
    
    if (error_code != 0) {
        terminate_program("エラーが発生しました");
    }
    
    printf("このコードは実行されません\n");
    
    return 0;
}

C++との互換性

[編集]

noreturn属性はC++11の[[noreturn]]属性と互換性があります。C++では同様の目的で使用され、関数が正常に戻らないことを示します。

以下の表はC23とC++のnoreturn関連機能の比較です：

機能 C23 C++11 C++14 C++17以降
[[noreturn]]属性 対応 ← ← ←
_Noreturnキーワード 対応 非対応 ← ←
<stdnoreturn.h>ヘッダ 対応 非対応 ← ←
<cstdnoreturn>ヘッダ 非対応 対応 ← ←

標準ライブラリのnoreturn関数

[編集]

C標準ライブラリには、noreturn属性を持つ関数がいくつか含まれています。これらの関数は、プログラムの実行を終了させるか、呼び出し元に戻らない特別な処理を行います。

以下の表に、C23でnoreturn属性を持つ標準ライブラリ関数をまとめます：

関数名 ヘッダ 説明
exit <stdlib.h> プログラムを正常終了する
_Exit <stdlib.h> クリーンアップなしでプログラムを即時終了する
abort <stdlib.h> 異常終了し、通常はコアダンプを生成する
quick_exit <stdlib.h> 高速終了処理を行う（C11以降）
thrd_exit <threads.h> 現在のスレッドを終了する（C11以降）
longjmp <setjmp.h> 非ローカルジャンプを実行する

実際のコード例

[編集]

以下に、noreturn属性を活用した実際のコード例を示します。この例では、エラー処理システムを実装しています： 

#include <stdio.h>
#include <stdlib.h>
#include <stdarg.h>
#include <string.h>
#include <errno.h>
// エラーの重大度レベル
typedef enum {
    ERROR_INFO,     // 情報提供
    ERROR_WARNING,  // 警告（続行可能）
    ERROR_ERROR,    // エラー（回復可能）
    ERROR_FATAL     // 致命的エラー（回復不可能）
} ErrorLevel;

// エラーコンテキスト情報
typedef struct {
    const char* file;
    int line;
    const char* function;
    ErrorLevel level;
    int error_code;
} ErrorContext;

// エラーハンドラー型定義
typedef void (*ErrorHandler)(const ErrorContext* context, const char* message);

// グローバルエラーハンドラー
static ErrorHandler global_error_handler = NULL;

// デフォルトのエラーハンドラー
void default_error_handler(const ErrorContext* context, const char* message) {
    FILE* output = context->level >= ERROR_ERROR ? stderr : stdout;
    
    const char* level_str = "";
    switch (context->level) {
        case ERROR_INFO:    level_str = "情報"; break;
        case ERROR_WARNING: level_str = "警告"; break;
        case ERROR_ERROR:   level_str = "エラー"; break;
        case ERROR_FATAL:   level_str = "致命的エラー"; break;
    }
    
    fprintf(output, "%s: %s\n", level_str, message);
    
    if (context->file) {
        fprintf(output, "場所: %s:%d", context->file, context->line);
        if (context->function) {
            fprintf(output, " (%s)", context->function);
        }
        fprintf(output, "\n");
    }
    
    if (context->error_code != 0) {
        fprintf(output, "エラーコード: %d", context->error_code);
        if (context->error_code == errno && errno != 0) {
            fprintf(output, " (%s)", strerror(errno));
        }
        fprintf(output, "\n");
    }
}

// エラーハンドラーの設定
ErrorHandler set_error_handler(ErrorHandler new_handler) {
    ErrorHandler old_handler = global_error_handler;
    global_error_handler = new_handler;
    return old_handler;
}

// エラー報告関数
void report_error(ErrorLevel level, int error_code, 
                  const char* file, int line, const char* function,
                  const char* format, ...) {
    
    // メッセージのフォーマット
    va_list args;
    va_start(args, format);
    
    char message[1024];
    vsnprintf(message, sizeof(message), format, args);
    
    va_end(args);
    
    // エラーコンテキストの設定
    ErrorContext context = {
        .file = file,
        .line = line,
        .function = function,
        .level = level,
        .error_code = error_code
    };
    
    // エラーハンドラーの呼び出し
    ErrorHandler handler = global_error_handler ? global_error_handler : default_error_handler;
    handler(&context, message);
    
    // 致命的エラーの場合はプログラムを終了
    if (level == ERROR_FATAL) {
        exit(EXIT_FAILURE);
    }
}

// 致命的エラー報告関数（noreturn）
[[noreturn]] void report_fatal_error(int error_code,
                                     const char* file, int line, const char* function,
                                     const char* format, ...) {
    
    // メッセージのフォーマット
    va_list args;
    va_start(args, format);
    
    char message[1024];
    vsnprintf(message, sizeof(message), format, args);
    
    va_end(args);
    
    // エラーコンテキストの設定
    ErrorContext context = {
        .file = file,
        .line = line,
        .function = function,
        .level = ERROR_FATAL,
        .error_code = error_code
    };
    
    // エラーハンドラーの呼び出し
    ErrorHandler handler = global_error_handler ? global_error_handler : default_error_handler;
    handler(&context, message);
    
    // クリーンアップ処理（必要に応じて）
    // ...
    
    // プログラムを終了
    exit(EXIT_FAILURE);
}

// 便利なマクロ
#define LOG_INFO(format, ...) \
    report_error(ERROR_INFO, 0, __FILE__, __LINE__, __func__, format, ##__VA_ARGS__)

#define LOG_WARNING(format, ...) \
    report_error(ERROR_WARNING, 0, __FILE__, __LINE__, __func__, format, ##__VA_ARGS__)

#define LOG_ERROR(error_code, format, ...) \
    report_error(ERROR_ERROR, error_code, __FILE__, __LINE__, __func__, format, ##__VA_ARGS__)

#define FATAL_ERROR(error_code, format, ...) \
    report_fatal_error(error_code, __FILE__, __LINE__, __func__, format, ##__VA_ARGS__)

// サンプルのシステム関数
int open_file(const char* filename) {
    if (!filename) {
        LOG_ERROR(EINVAL, "ファイル名がNULLです");
        return -1;
    }
    
    FILE* file = fopen(filename, "r");
    if (!file) {
        LOG_ERROR(errno, "ファイル '%s' を開けませんでした", filename);
        return -1;
    }
    
    LOG_INFO("ファイル '%s' を正常に開きました", filename);
    
    // ファイルハンドルを返す代わりに、ここではファイルを閉じる
    fclose(file);
    return 0;
}

// メイン関数
int main(void) {
    LOG_INFO("プログラムを開始します");
    
    // 正常なファイルオープン
    int result = open_file("existing_file.txt");
    if (result != 0) {
        LOG_WARNING("ファイルオープンに失敗しましたが、続行します");
    }
    
    // エラーケース
    result = open_file(NULL);
    if (result != 0) {
        LOG_WARNING("NULLファイル名でのオープンに失敗しました（予想通り）");
    }
    
    // 存在しないファイル
    result = open_file("non_existent_file.txt");
    if (result != 0) {
        LOG_WARNING("存在しないファイルのオープンに失敗しました（予想通り）");
    }
    
    // 致命的エラーのシミュレーション
    if (rand() % 100 < 10) { // 10%の確率で致命的エラー
        FATAL_ERROR(ENOMEM, "メモリ割り当てに失敗しました");
        // この行は実行されない
    }
    
    LOG_INFO("プログラムを正常に終了します");
    return 0;
}

この例では、report_fatal_error関数にnoreturn属性を使用しています。この関数はエラーメッセージを表示した後、プログラムを終了するため、呼び出し元に制御を返すことはありません。コンパイラはこの情報を利用して、FATAL_ERRORマクロ呼び出し後のコードが到達不能であることを認識し、適切な最適化を行うことができます。

まとめ

[編集]

noreturn属性はC23の標準的な属性の一つであり、関数が呼び出し元に制御を返さないことを示すために使用されます。この属性を適切に使用することで、以下のような利点があります：

  1. コードの意図の明確化
  2. コンパイラの最適化の改善
  3. 静的解析ツールによるコード検証の向上
  4. C++との互換性の向上

noreturn属性は特に、エラー処理関数、アサーション関数、プログラム終了関数などで有用です。C11の_Noreturnキーワードと同等の機能を提供しますが、標準的な属性構文を使用することで、コードの一貫性と可読性が向上します。

最新のC23規格に準拠したコードを書く際は、_Noreturnキーワードではなくnoreturn属性を使用することをお勧めします。これにより、他の属性との一貫性が保たれ、より読みやすく保守しやすいコードになります。

"https://ja.wikibooks.org/w/index.php?title=C言語/noreturn&oldid=270971" より作成