C言語のassertマクロ入門 デバッグで不整合を即発見する方法

// 基本のインクルード
#include <assert.h>
#include <stdio.h>

int main(void) {
    int x = 10;
    // xは0以上であるべきだという前提を確認
    assert(x >= 0);
    printf("x = %d\n", x);
    return 0;
}

#include <assert.h>
#include <stdio.h>

int main(void) {
    int value = -1;

    // valueは非負であるべきという前提
    assert(value >= 0);  // 偽なのでここで停止

    // ここには到達しません
    printf("value = %d\n", value);
    return 0;
}

#include <assert.h>
#include <stdio.h>

// 配列の合計を計算する関数
int sum_array(const int *arr, size_t len) {
    // 呼び出し側が満たすべき前提条件
    assert(arr != NULL);     // 配列ポインタはNULLでない
    assert(len > 0);         // 長さは0より大きい

    int sum = 0;
    for (size_t i = 0; i < len; ++i) {
        sum += arr[i];
    }
    return sum;
}

int main(void) {
    int a[] = {1, 2, 3};
    int s = sum_array(a, 3);
    printf("sum = %d\n", s);  // sum = 6
    return 0;
}

#include <assert.h>
#include <stdio.h>

typedef struct {
    int data[4];
    int size;  // 要素数
} Stack;

void stack_init(Stack *s) {
    assert(s != NULL);
    s->size = 0;
    assert(s->size >= 0 && s->size <= 4); // 不変条件
}

void stack_push(Stack *s, int v) {
    assert(s != NULL);
    assert(s->size >= 0 && s->size < 4);  // 空きがある前提
    s->data[s->size++] = v;
    assert(s->size >= 0 && s->size <= 4); // 不変条件
}

int stack_pop(Stack *s) {
    assert(s != NULL);
    assert(s->size > 0);                  // 要素がある前提
    int v = s->data[--s->size];
    assert(s->size >= 0 && s->size <= 4); // 不変条件
    return v;
}

int main(void) {
    Stack s;
    stack_init(&s);
    stack_push(&s, 10);
    stack_push(&s, 20);
    printf("%d\n", stack_pop(&s)); // 20
    return 0;
}

#include <assert.h>
#include <stdio.h>

typedef enum { RED, GREEN, BLUE } Color;

const char *to_name(Color c) {
    switch (c) {
        case RED:   return "RED";
        case GREEN: return "GREEN";
        case BLUE:  return "BLUE";
        default:
            // ここに来るのは想定外
            assert(0 && "unexpected Color value");
            return "UNKNOWN"; // NDEBUG時の保険(実際は到達しない想定)
    }
}

int main(void) {
    // 故意に不正値を渡して検出する
    printf("%s\n", to_name((Color)123));  // ここでassert失敗
    return 0;
}

#include <assert.h>
#include <stdio.h>

int at(const int *arr, size_t len, size_t index) {
    assert(arr != NULL);
    assert(index < len);  // 範囲チェック
    return arr[index];
}

int main(void) {
    int a[3] = {10, 20, 30};
    printf("%d\n", at(a, 3, 1));  // 20
    // printf("%d\n", at(a, 3, 5)); // 有効化するとassertが失敗します
    return 0;
}

#include <assert.h>
#include <stdio.h>

int main(void) {
    int i = 0;
    int n = 5;

    // 悪い例: i++に副作用がある
    assert(i++ < n);

    // デバッグビルド: 上の式が評価され、iは1になる
    // リリースビルド(NDEBUG): 上の式ごと消えるので、iは0のまま
    printf("i = %d\n", i);
    return 0;
}

#include <assert.h>
#include <stdio.h>

int main(void) {
#ifdef NDEBUG
    puts("assert: disabled");
#else
    puts("assert: enabled");
#endif

    int x = -1;
    assert(x >= 0); // NDEBUGが定義されていれば何も生成されない
    puts("continue");
    return 0;
}

# デバッグビルド: アサート有効、デバッグ情報、最適化オフ
gcc -std=c17 -Wall -Wextra -g -O0 -o app_debug main.c

# リリースビルド: アサート無効(NDEBUG定義)、最適化
gcc -std=c17 -O2 -DNDEBUG -s -o app_release main.c

REM デバッグ(例): /MDdはデバッグランタイム、アサート有効
cl /Zi /Od /MDd main.c

REM リリース(例): /DNDEBUGでアサート無効化、最適化
cl /O2 /DNDEBUG /MD main.c

#include <assert.h>
#include <stdio.h>
#include <string.h>

// 文字列の長さを表示する(引数はNULLであってはならない)
void print_len(const char *s) {
    assert(s != NULL); // 呼び出し側契約の確認
    printf("len = %zu\n", strlen(s));
}

int main(void) {
    print_len("hello");     // OK: len = 5
    print_len(NULL);        // NG: ここでassertが失敗
    return 0;
}

#include <assert.h>
#include <stdio.h>

int get_at(const int *arr, size_t len, size_t idx) {
    assert(arr != NULL);
    assert(idx < len);  // 範囲外アクセスを未然に検出
    return arr[idx];
}

int main(void) {
    int a[] = {4, 8, 15, 16, 23, 42};
    printf("%d\n", get_at(a, 6, 3)); // 16
    // printf("%d\n", get_at(a, 6, 99)); // 有効化するとassert失敗
    return 0;
}

#include <assert.h>
#include <stdio.h>

typedef enum { OP_ADD, OP_SUB, OP_MUL } Op;

int apply(Op op, int x, int y) {
    switch (op) {
        case OP_ADD: return x + y;
        case OP_SUB: return x - y;
        case OP_MUL: return x * y;
        default:
            // 列挙の追加漏れ・入力の破損などを検出
            assert(!"unreachable default in apply");
            return 0; // NDEBUG時の保険
    }
}

int main(void) {
    printf("%d\n", apply(OP_ADD, 3, 5));   // 8
    printf("%d\n", apply((Op)777, 3, 5));  // ここでassert失敗
    return 0;
}