Bài 56.430 phút đọc

Xử lý lỗi

Sau bài này bạn sẽ làm được

So sánh bốn chiến lược trả lỗi
Viết hàm dọn dẹp bằng goto một cách đúng
Truyền lỗi lên trên mà không mất thông tin
Biết khi nào dừng chương trình là đúng

C không có ngoại lệ, nên xử lý lỗi là một quyết định thiết kế bạn phải đưa ra một cách có ý thức. Bài này so sánh bốn chiến lược bằng cách chạy cả bốn trên cùng một dữ liệu, và hai trong số đó cho ra kết quả sai trong im lặng.

#Bốn chiến lược

Chiến lược	Hình thức	Ví dụ trong thư viện chuẩn
Mã lỗi trả về, kết quả qua tham số ra	int f(const char s, int ra)	Không có, nhưng là kiểu của nhiều thư viện hiện đại
Giá trị canh gác	int f(const char *s), trả về INT_MIN nếu lỗi	atoi, strchr trả về NULL, malloc trả về NULL
Biến lỗi toàn cục	Trả về giá trị, đặt errno	strtol, fopen, mọi lời gọi hệ thống POSIX
Cấu trúc lỗi giàu thông tin	int f(const char s, int ra, Loi *l)	SQLite với sqlite3_errmsg, libcurl với CURLcode

Cách 1: mã lỗi và tham số ra

enum { OK = 0, LOI_NULL = -1, LOI_DINH_DANG = -2, LOI_TRAN = -3 };

static const char *ten_loi(int ma) {
    switch (ma) {
        case OK:            return "OK";
        case LOI_NULL:      return "doi so NULL";
        case LOI_DINH_DANG: return "khong phai so";
        case LOI_TRAN:      return "tran pham vi int";
        default:            return "khong biet";
    }
}

static int doc_so_1(const char *s, int *ra) {
    if (s == NULL || ra == NULL) return LOI_NULL;
    errno = 0;
    char *cuoi;
    long v = strtol(s, &cuoi, 10);
    if (cuoi == s || *cuoi != '\0')            return LOI_DINH_DANG;
    if (errno == ERANGE || v < INT_MIN || v > INT_MAX) return LOI_TRAN;
    *ra = (int)v;
    return OK;
}

Cách 2 và cách 3: canh gác, và biến toàn cục

/* Cach 2: gia tri canh gac */
static int doc_so_2(const char *s) {
    char *cuoi;
    long v = strtol(s, &cuoi, 10);
    if (cuoi == s || *cuoi != '\0') return INT_MIN;   /* canh gac */
    return (int)v;
}

/* Cach 3: bien loi toan cuc kieu errno */
static int loi_cuoi = 0;
static int doc_so_3(const char *s) {
    loi_cuoi = 0;
    char *cuoi;
    long v = strtol(s, &cuoi, 10);
    if (cuoi == s || *cuoi != '\0') { loi_cuoi = LOI_DINH_DANG; return 0; }
    return (int)v;
}

Cách 4: cấu trúc lỗi

typedef struct {
    int         ma;
    char        thong_diep[128];
    const char *tep;
    int         dong;
} Loi;

#define DAT_LOI(l, m, ...)                                          \
    do { (l)->ma = (m); (l)->tep = __FILE__; (l)->dong = __LINE__;  \
         snprintf((l)->thong_diep, sizeof (l)->thong_diep,          \
                  __VA_ARGS__); } while (0)

static int doc_so_4(const char *s, int *ra, Loi *l) {
    char *cuoi;
    errno = 0;
    long v = strtol(s, &cuoi, 10);
    if (cuoi == s || *cuoi != '\0') {
        DAT_LOI(l, LOI_DINH_DANG, "\"%s\" khong phai so nguyen", s);
        return -1;
    }
    if (errno == ERANGE || v < INT_MIN || v > INT_MAX) {
        DAT_LOI(l, LOI_TRAN, "\"%s\" vuot pham vi int (%d..%d)",
                s, INT_MIN, INT_MAX);
        return -1;
    }
    *ra = (int)v;
    return 0;
}

#Chạy thử cả bốn

terminal

gcc -std=c11 -O2 -Wall -Wextra -D__USE_MINGW_ANSI_STDIO=1 bon.c -o bon.exe

./bon.exe

dau vao: "42"
  cach 1: ma=0  (OK) gia tri=42
  cach 2: 42
  cach 3: 42, loi_cuoi=0
  cach 4: 42

dau vao: "abc"
  cach 1: ma=-2 (khong phai so)
  cach 2: -2147483648  (canh gac hay gia tri that?)
  cach 3: 0, loi_cuoi=-2
  cach 4: "abc" khong phai so nguyen  [bon.c:67]

dau vao: "99999999999999"
  cach 1: ma=-3 (tran pham vi int)
  cach 2: 2147483647
  cach 3: 2147483647, loi_cuoi=0
  cach 4: "99999999999999" vuot pham vi int (-2147483648..2147483647)  [bon.c:71]

dau vao: ""
  cach 1: ma=-2 (khong phai so)
  cach 2: -2147483648  (canh gac hay gia tri that?)
  cach 3: 0, loi_cuoi=-2
  cach 4: "" khong phai so nguyen  [bon.c:67]

Đọc kỹ khối thứ ba: hai chiến lược cho kết quả sai trong im lặng

dau vao: "99999999999999"
  cach 2: 2147483647
  cach 3: 2147483647, loi_cuoi=0        <- loi_cuoi = 0, tuc "khong loi"!

/* Vi sao: doc_so_2 va doc_so_3 chi kiem tra dinh dang, khong
   kiem tra ERANGE. strtol da cat gia tri xuong LONG_MAX va dat
   errno = ERANGE, nhung ca hai ham deu bo qua.

   Ket qua: chuong trinh nhan 2147483647 va tin do la so nguoi
   dung nhap. Khong co canh bao nao.

   Bai hoc KHONG phai la "cach 2 va 3 xau". Bai hoc la: voi cac
   chien luoc do, viec kiem tra du loi la TU NGUYEN, va nguoi
   viet rat de bo sot. Voi cach 1 va cach 4, ban PHAI xu ly gia
   tri tra ve, nen trinh bien dich va nguoi doc ma deu nhac ban. */

Vấn đề riêng của giá trị canh gác

dau vao: "abc"
  cach 2: -2147483648  (canh gac hay gia tri that?)

/* INT_MIN duoc chon lam canh gac. Nhung INT_MIN cung la mot
   gia tri hop le ma nguoi dung go duoc:

     ./ct -2147483648        <- so that, khong phai loi

   Nen ham khong phan biet duoc. Do la nhuoc diem co ban cua
   moi gia tri canh gac: no lay mot phan MIEN GIA TRI HOP LE
   de lam ma loi.

   Canh gac dung duoc khi mien gia tri co mot vung KHONG BAO GIO
   hop le:
     con tro     NULL khong bao gio la dia chi hop le  -> tot
     do dai      -1 khong bao gio la do dai hop le     -> tot
     chi so      -1 khi mien la 0..n-1                 -> tot
     so nguyen   moi gia tri deu hop le                -> XAU
     nhiet do    -273.15 la gia tri that               -> XAU */

Vấn đề riêng của biến lỗi toàn cục

/* 1. Phai xoa truoc khi goi.
      Nhieu ham chi DAT errno khi co loi, khong xoa khi thanh cong.
      Nen ban phai: */
errno = 0;
long v = strtol(s, &cuoi, 10);
if (errno == ERANGE) { ... }

/* 2. Bi ghi de boi lan goi khac.
      Doan nay hong: */
if (f() < 0) {
    ghi_nhat_ky("f that bai");      /* ghi_nhat_ky co the goi write,
                                       va write dat lai errno */
    printf("loi: %s\n", strerror(errno));   /* errno da khong con
                                                cua f nua */
}
/* Dung: luu lai NGAY */
if (f() < 0) {
    int e = errno;
    ghi_nhat_ky("f that bai");
    printf("loi: %s\n", strerror(e));
}

/* 3. Da luong.
      errno la bien rieng cho tung luong tren moi he hien dai,
      nen an toan. Nhung bien loi toan cuc CUA BAN thi khong,
      tru khi ban khai bao: */
static _Thread_local int loi_cuoi;      /* C11 */

Chọn cái nào

Mặc định: cách 1. Mã lỗi trả về, kết quả qua tham số ra. Rõ ràng, không có trạng thái toàn cục, và trình biên dịch giúp được bạn với warn_unused_result.
Cách 2 khi có giá trị không hợp lệ tự nhiên. Trả NULL cho con trỏ, -1 cho chỉ số. Đừng ép một giá trị hợp lệ làm canh gác.
Cách 3 chỉ khi bạn phải khớp với API sẵn có. Nếu bạn viết lớp bọc quanh POSIX, dùng errno cho nhất quán.
Cách 4 cho thư viện công khai và cho lỗi người dùng thấy. Khi thông điệp lỗi là một phần của sản phẩm, mã lỗi trần không đủ.

/* Va quan trong nhat: CHON MOT va dung nhat quan trong ca du an.
   Tron lan la nguon loi that su:

     if (mo_tep(dd))    ...      /* 0 = thanh cong -> nhanh nay la LOI */
     if (kiem_tra(x))   ...      /* 1 = thanh cong -> nhanh nay la OK */

   Hai dong doc giong het nhau, nghia nguoc nhau. */

Bắt trình biên dịch nhắc bạn kiểm tra

/* GCC va Clang */
__attribute__((warn_unused_result))
int ds_them(Ds *d, int x);

/* Dung cho ca du an: */
#if defined(__GNUC__)
  #define PHAI_DUNG __attribute__((warn_unused_result))
#else
  #define PHAI_DUNG
#endif

PHAI_DUNG int ds_them(Ds *d, int x);

/* Bay gio: */
ds_them(d, 5);
/* warning: ignoring return value of 'ds_them',
   declared with attribute warn_unused_result */

/* Va khi ban CO Y bo qua, noi ro y dinh: */
(void)ds_them(d, 5);        /* van canh bao voi GCC */
if (ds_them(d, 5) != 0) { /* xu ly */ }     /* cach dung */

#Dọn dẹp bằng goto

dondep.c, bốn tài nguyên

static int lam_viec(void) {
    int ma = -1;
    char *a = NULL, *b = NULL, *c = NULL, *d = NULL;

    a = cap(16, "a"); if (!a) goto het;
    b = cap(16, "b"); if (!b) goto tha_a;
    c = cap(16, "c"); if (!c) goto tha_b;
    d = cap(16, "d"); if (!d) goto tha_c;

    printf("  lam viec that\n");
    ma = 0;

    tha(d, "d");            /* duong ra binh thuong roi vao chuoi nhan */
tha_c:
    tha(c, "c");
tha_b:
    tha(b, "b");
tha_a:
    tha(a, "a");
het:
    return ma;
}

terminal

./dd.exe

=== buoc hong = 0 ===
  a: cap
  b: cap
  c: cap
  d: cap
  lam viec that
  d: tha
  c: tha
  b: tha
  a: tha
  ket qua=0, con lai 0 vung chua tha

=== buoc hong = 2 ===
  a: cap
  b: CO Y that bai
  a: tha
  ket qua=-1, con lai 0 vung chua tha

=== buoc hong = 4 ===
  a: cap
  b: cap
  c: cap
  d: CO Y that bai
  c: tha
  b: tha
  a: tha
  ket qua=-1, con lai 0 vung chua tha

Không dùng goto

int lam_viec(void) { char *a = malloc(16); if (!a) return -1; char *b = malloc(16); if (!b) { free(a); return -1; } char *c = malloc(16); if (!c) { free(b); free(a); return -1; } char *d = malloc(16); if (!d) { free(c); free(b); free(a); return -1; } /* Voi 4 tai nguyen: 1+2+3 = 6 lenh free trong nhanh loi. Voi 8 tai nguyen: 28 lenh free. Them mot tai nguyen o giua = sua moi nhanh ben duoi. Day la noi ro ri bo nho sinh ra. */ ... }

Dùng goto

int lam_viec(void) { int ma = -1; char *a = NULL, *b = NULL, *c = NULL, *d = NULL; a = malloc(16); if (!a) goto het; b = malloc(16); if (!b) goto tha_a; c = malloc(16); if (!c) goto tha_b; d = malloc(16); if (!d) goto tha_c; ma = 0; free(d); tha_c: free(c); tha_b: free(b); tha_a: free(a); het: return ma; } /* Them mot tai nguyen = them mot dong va mot nhan. Day la mau chuan cua nhan Linux, cua OpenSSL, va cua gan nhu moi ma C nghiem tuc. */

Bốn quy tắc bắt buộc khi dùng goto để dọn dẹp

/* 1. CHI nhay VE PHIA TRUOC, va chi ra khoi ham.
      goto nhay nguoc len la vong lap tra hinh, va la thu
      lam goto mang tieng xau. */

/* 2. Khoi tao MOI con tro thanh NULL truoc.
      Neu buoc 2 hong, nhan tha_c van chay va free(c) voi c
      chua duoc gan. free(NULL) an toan; free(rac) thi khong. */
char *c = NULL;

/* 3. Ten nhan noi ro no lam gi, khong phai no o dau. */
tha_a:              /* tot */
loi2:               /* xau: doc xong khong biet no don gi */

/* 4. Khong nhay QUA mot khai bao co khoi tao. */
goto het;
int x = tinh();     /* C99: nhay qua day la loi bien dich */
het:
/* Cach chua: khai bao het o dau vung, hoac bo vao khoi rieng. */

GCC và Clang có cleanup, nhưng nó không chuẩn

#define TU_DONG_THA __attribute__((cleanup(tha_con_tro)))

static void tha_con_tro(void *p) { free(*(void **)p); }

void f(void) {
    TU_DONG_THA char *a = malloc(16);
    TU_DONG_THA char *b = malloc(16);
    if (!a || !b) return;           /* ca hai tu dong duoc tha */
    ...
}                                    /* tha khi ra khoi pham vi */

/* Uu: khong the quen. Nhuoc:
     - khong nam trong chuan C, chi GCC va Clang
     - kho doc voi nguoi chua biet
     - thu tu tha la nguoc thu tu khai bao, phai nho
   systemd dung rat nhieu; nhan Linux thi khong.

   Neu ma cua ban chi chay tren GCC va Clang thi day la mot cong cu
   tot. Neu can di dong thi dung goto. */

#Truyền lỗi lên trên

Ba tầng, và thông tin mất dần

/* Tang thap */
int tep_doc(const char *dd, char **ra, size_t *co) {
    FILE *t = fopen(dd, "rb");
    if (!t) return -1;              /* mat: LY DO khong mo duoc */
    ...
}

/* Tang giua */
int cau_hinh_nap(const char *dd, CauHinh *c) {
    char *noi_dung; size_t co;
    if (tep_doc(dd, &noi_dung, &co) != 0) return -1;   /* mat: TEP NAO */
    ...
}

/* Tang cao */
int khoi_dong(void) {
    CauHinh c;
    if (cau_hinh_nap("/etc/ct.conf", &c) != 0) {
        fprintf(stderr, "khong khoi dong duoc\n");    /* vo dung */
        return 1;
    }
}

/* Nguoi dung nhan duoc: "khong khoi dong duoc".
   Nguyen nhan that: khong co quyen doc /etc/ct.conf.
   Ho khong the tu sua. */

Ba cách giữ thông tin khi truyền lên

/* Cach 1: giu errno, va bo sung ngu canh o tang tren */
int cau_hinh_nap(const char *dd, CauHinh *c) {
    if (tep_doc(dd, &noi_dung, &co) != 0) {
        /* errno van con nguyen tu fopen */
        return -1;
    }
}
int khoi_dong(void) {
    if (cau_hinh_nap(DUONG_DAN, &c) != 0) {
        fprintf(stderr, "khong doc duoc %s: %s\n",
                DUONG_DAN, strerror(errno));
        return 1;
    }
}
/* -> "khong doc duoc /etc/ct.conf: Permission denied" */


/* Cach 2: cau truc loi truyen qua moi tang */
int tep_doc(const char *dd, char **ra, size_t *co, Loi *l) {
    FILE *t = fopen(dd, "rb");
    if (!t) { DAT_LOI(l, LOI_TEP, "khong mo duoc %s: %s",
                      dd, strerror(errno)); return -1; }
}
int cau_hinh_nap(const char *dd, CauHinh *c, Loi *l) {
    if (tep_doc(dd, &nd, &co, l) != 0) return -1;   /* l da co noi dung */
}


/* Cach 3: chuoi loi, moi tang them mot dong ngu canh */
typedef struct Loi {
    int ma;
    char thong_diep[128];
    struct Loi *nguyen_nhan;        /* loi tang duoi */
} Loi;

/* -> in ra:
     khong khoi dong duoc
       gay boi: khong nap duoc cau hinh /etc/ct.conf
       gay boi: khong mo duoc tep: Permission denied  */

Đừng ghi nhật ký ở mọi tầng

Không nên

int tep_doc(...) { if (!t) { ghi_nhat_ky("khong mo duoc %s", dd); /* tang 1 ghi */ return -1; } } int cau_hinh_nap(...) { if (tep_doc(...) != 0) { ghi_nhat_ky("nap cau hinh that bai"); /* tang 2 ghi */ return -1; } } int khoi_dong(void) { if (cau_hinh_nap(...) != 0) { ghi_nhat_ky("khoi dong that bai"); /* tang 3 ghi */ return 1; } } /* MOT loi sinh ra BA dong nhat ky. Voi mot he thong 10 tang va nhieu loi cung luc, nhat ky tro thanh vo dung. */

Nên

/* Tang thap: TRA VE loi, khong ghi */ int tep_doc(...) { if (!t) return -1; } /* Tang giua: truyen len, khong ghi */ int cau_hinh_nap(...) { if (tep_doc(...) != 0) return -1; } /* Tang cao NHAT, noi co du ngu canh: ghi MOT lan */ int khoi_dong(void) { if (cau_hinh_nap(DUONG_DAN, &c) != 0) { ghi_nhat_ky("khong khoi dong: khong nap duoc %s: %s", DUONG_DAN, strerror(errno)); return 1; } } /* Quy tac: XU LY hoac TRUYEN LEN, khong lam ca hai. Va noi xu ly la noi biet phai lam gi tiep theo. */

#Khi nào dừng chương trình

Tình huống	Xử lý hay dừng	Vì sao
Tệp người dùng chỉ định không tồn tại	Xử lý	Người dùng gõ nhầm, báo và cho thử lại
Mạng ngắt giữa chừng	Xử lý	Bình thường, thử lại hoặc báo
Dữ liệu vào sai định dạng	Xử lý	Đầu vào không tin được là chuyện thường
malloc trả về NULL	Tuỳ	Xem bên dưới
Bất biến nội bộ bị vi phạm	Dừng	Chương trình đã ở trạng thái không hiểu được
Đối số NULL cho hàm nội bộ	Dừng, bằng assert	Đó là lỗi lập trình, không phải lỗi lúc chạy
Chỉ số vượt mảng trong mã của bạn	Dừng	Tiếp tục là hỏng bộ nhớ

malloc trả về NULL: câu trả lời phụ thuộc vào loại chương trình

/* Cong cu dong lenh chay mot lan:
   Dung ngay la hop ly. Khong co gi de cuu, va nguoi dung
   khoi dong lai duoc. */
void *p = malloc(n);
if (!p) { fprintf(stderr, "het bo nho\n"); exit(EXIT_FAILURE); }

/* Thu vien:
   TUYET DOI khong duoc dung. Ban khong biet nguoi dung thu vien
   dang lam gi. Tra ve loi. */
Ds *ds_tao(size_t n) {
    Ds *d = malloc(sizeof *d);
    if (!d) return NULL;        /* nguoi goi quyet dinh */
    ...
}

/* May chu chay lau:
   Dung la khong chap nhan duoc. Mot yeu cau lon lam sap ca
   dich vu la mot lo hong tu choi dich vu. Phai:
     - tu choi RIENG yeu cau do
     - gioi han kich thuoc yeu cau tu truoc
     - giai phong bo nho khong thiet yeu roi thu lai */

/* He nhung:
   Thuong khong dung malloc luc chay. Cap phat het luc khoi dong,
   hoac dung be co dinh. Neu cap phat luc khoi dong that bai
   thi dung la dung. */

/* Luu y tren Linux: mac dinh he thong CAM KET QUA (overcommit),
   nen malloc hiem khi tra ve NULL. Thay vao do, tien trinh bi
   OOM killer giet khi thuc su cham vao bo nho. Nghia la ma xu ly
   NULL cua ban co the khong bao gio chay tren Linux, nhung van
   can cho cac he khac va cho gioi han RLIMIT_AS. */

Mẫu abort có thông điệp

#include <stdio.h>
#include <stdlib.h>

#define KHONG_THE_XAY_RA(...)                                   \
    do {                                                        \
        fprintf(stderr, "loi noi bo tai %s:%d trong %s: ",      \
                __FILE__, __LINE__, __func__);                  \
        fprintf(stderr, __VA_ARGS__);                           \
        fprintf(stderr, "\n");                                  \
        abort();                                                \
    } while (0)

/* Dung: */
switch (trang_thai) {
    case DANG_CHO:  ...; break;
    case DANG_CHAY: ...; break;
    case DA_XONG:   ...; break;
    default:
        KHONG_THE_XAY_RA("trang thai khong hop le: %d", trang_thai);
}

/* Vi sao abort chu khong phai exit:
     abort sinh SIGABRT -> he dieu hanh do bo nho ra tep core.
     Ban mo core do bang GDB va thay CHINH XAC ngan xep goi.
     exit thi khong co gi ca.

   Bat do core tren Linux:  ulimit -c unlimited
   Mo:                      gdb ./ct core  */

Ba thứ phải làm trước khi dừng

/* 1. Xa nhat ky. Neu ban dung bo dem, thong diep cuoi cung,
      tuc thong diep quan trong nhat, se bi mat. */
fflush(stderr);
fflush(nhat_ky);

/* 2. Ghi ly do o dang MAY DOC DUOC, khong chi cho nguoi. */
fprintf(stderr, "{\"muc\":\"nghiem trong\",\"ma\":%d,\"tep\":\"%s\","
                "\"dong\":%d}\n", ma, __FILE__, __LINE__);

/* 3. Tra ve ma thoat CO NGHIA. */
exit(EXIT_FAILURE);         /* 1, chung chung */
exit(2);                    /* quy uoc rieng: sai doi so */
exit(77);                   /* quy uoc automake: bo qua kiem thu */

/* KHONG lam:
     - dong so lieu, luu trang thai, ghi tep khi bat bien da hong.
       Neu ban khong tin cau truc du lieu nua thi ghi no ra dia
       la lam hong ca ban luu. Dung ngay, va de cong cu khoi phuc
       lo phan con lai. */

Tự làm thử

Chạy bon.c và giải thích vì sao cách 3 báo loi_cuoi=0 cho đầu vào tràn.
Sửa doc_so_2 và doc_so_3 để chúng phát hiện được tràn.
Viết lại một hàm của bạn có ba return lỗi thành mẫu goto.
Thêm warn_unused_result vào các hàm trả mã lỗi và đếm số cảnh báo mới.
Cài cấu trúc Loi có chuỗi nguyên nhân ba tầng và in ra đầy đủ.
Tìm trong dự án của bạn một chỗ ghi nhật ký ở nhiều tầng cho cùng một lỗi, và dồn về một chỗ.

Trình chấm điểm tự động sẽ được bổ sung ở giai đoạn sau. Hiện tại bạn tự chạy thử trên máy.

Tóm tắt

Bốn chiến lược; mặc định dùng mã lỗi trả về cộng tham số ra.
Giá trị canh gác chỉ dùng được khi miền giá trị có vùng chắc chắn không hợp lệ.
Biến lỗi toàn cục phải được xoá trước khi gọi và lưu lại ngay sau khi lỗi.
goto dọn dẹp: nhảy về phía trước, khởi tạo NULL, tên nhãn nói việc, thả ngược thứ tự cấp.
Xử lý hoặc truyền lên, không làm cả hai; ghi nhật ký một lần ở tầng biết phải làm gì tiếp.