Bài 19.328 phút đọc

Macro hàm và ba cạm bẫy

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

Chỉ ra kết quả sai khi macro thiếu ngoặc quanh tham số và quanh cả biểu thức
Giải thích vì sao đối số có tác dụng phụ làm macro chạy sai
Bọc macro nhiều câu lệnh bằng do while không và nói được lý do
Đọc kết quả gcc -E để kiểm tra macro bung ra thành gì

Macro hàm trông giống hàm, được gọi giống hàm, và cư xử hoàn toàn không giống hàm. Ba cạm bẫy trong bài này là ba cách khác nhau mà sự khác biệt đó cắn bạn, và cả ba đều là những lỗi im lặng.

#Macro hàm

#define BINH_PHUONG(x) ((x) * (x))
#define MAX(a, b)      ((a) > (b) ? (a) : (b))

Macro hàm

Macro có danh sách tham số. Preprocessor thay tên macro cùng danh sách đối số bằng phần thân, sau khi thay mỗi tên tham số bằng đúng những token của đối số tương ứng.

Dấu ngoặc mở phải dính liền tên macro

#define TONG(a, b) ((a) + (b))     /* macro HAM */
#define TONG (a, b) ((a) + (b))    /* macro DOI TUONG, than la "(a, b) ((a) + (b))" */

/* Mot khoang trang duy nhat doi han y nghia.
   Ban se thay loi la o moi cho dung TONG, va dinh nghia
   trong khong co gi sai. */

	Hàm	Macro
Kiểm kiểu đối số	Có	Không
Đối số được tính đúng một lần	Có	Không
Có địa chỉ, lấy con trỏ được	Có	Không
Xuất hiện trong trình gỡ lỗi	Có	Không
Làm việc với mọi kiểu	Không	Có
Truy cập được FILE và LINE của nơi gọi	Không	Có
Chắc chắn không có chi phí gọi hàm	Không đảm bảo	Có

#Cạm bẫy một: thiếu ngoặc

Preprocessor thay token, không thay giá trị. Dấu ngoặc là thứ duy nhất giữ lại ý định của bạn.

terminal

cat p2.c

#define SQ_XAU(x)  x * x
#define SQ(x)      ((x) * (x))

int main(void) {
    int a = SQ_XAU(2 + 3);
    int b = SQ(2 + 3);
    int c = 100 / SQ_XAU(5);
    int d = 100 / SQ(5);
    return a + b + c + d;
}

gcc -E -P p2.c

int main(void) {
    int a = 2 + 3 * 2 + 3;
    int b = ((2 + 3) * (2 + 3));
    int c = 100 / 5 * 5;
    int d = 100 / ((5) * (5));
    return a + b + c + d;
}

Biểu thức	Kết quả	Mong đợi
SQ_XAU(2 + 3)	11	25
SQ(2 + 3)	25	25
100 / SQ_XAU(5)	100	4
100 / SQ(5)	4	4

Hai chỗ thiếu ngoặc, hai loại lỗi khác nhau

#define SQ_XAU(x) x * x

/* THIEU NGOAC QUANH THAM SO:
     SQ_XAU(2 + 3)  ->  2 + 3 * 2 + 3
   Doi so la mot bieu thuc, va no bi xe ra. */

#define SQ_NUA(x) (x) * (x)

/* Da bo ngoac quanh tham so, nhung THIEU NGOAC QUANH CA THAN:
     100 / SQ_NUA(5)  ->  100 / (5) * (5)  ->  100
   Bieu thuc xung quanh xe macro ra. */

#define SQ(x) ((x) * (x))

/* Ca hai lop ngoac. Bay gio dung o moi ngu canh. */

Quy tắc bốn dấu ngoặc

#define TEN(a, b)  ( (a) op (b) )
                     ^  ^     ^
                     |  |     +-- ngoac quanh MOI tham so
                     |  +-------- ngoac quanh MOI tham so
                     +----------- ngoac quanh CA than macro

/* Vi du day du: */
#define TRUNG_BINH(a, b)  (((a) + (b)) / 2)
#define AM(x)             (-(x))
#define TRONG_KHOANG(x, lo, hi)  ((x) >= (lo) && (x) <= (hi))

Một ngoại lệ: đối số không được bọc khi dùng với # hoặc ##

#define IN_TEN(x)  printf(#x " = %d\n", (x))

/* Cho #x thi KHONG duoc bo ngoac, vi ban muon chuoi la ten goc.
   Nhung cho (x) thu hai thi van bo ngoac binh thuong.
   Bai 19.5 se noi ky ve toan tu nay. */

IN_TEN(a + b);      /* -> printf("a + b" " = %d\n", (a + b)); */

#Cạm bẫy hai: đánh giá nhiều lần

p3.c

#include <stdio.h>

#define SQ(x) ((x) * (x))

static int dem_goi = 0;
static int f(void) { ++dem_goi; return 3; }

int main(void) {
    int i = 5;
    int r = SQ(i++);

    printf("i sau SQ(i++) = %d   (mong doi 6)\n", i);
    printf("r = %d\n", r);

    dem_goi = 0;

    int m = ((f()) > (2) ? (f()) : (2));      /* chinh la MAX(f(), 2) */

    printf("MAX(f(), 2): f() duoc goi %d lan, ket qua %d\n", dem_goi, m);

    return 0;
}

terminal

gcc -std=c11 -o p3 p3.c && ./p3

i sau SQ(i++) = 7   (mong doi 6)
r = 30
MAX(f(), 2): f() duoc goi 2 lan, ket qua 3

Đối số có tác dụng phụ

#define MAX(a, b) ((a) > (b) ? (a) : (b))

int m = MAX(f(), g());       /* f va g moi cai chay hai lan */
int n = MAX(*p++, *q++);     /* hai con tro nhay hai buoc */
int k = MAX(doc_adc(), 0);   /* doc phan cung hai lan, hai gia tri khac nhau */

Hàm nội tuyến, hoặc tính trước

static inline int imax(int a, int b) { return a > b ? a : b; }

int m = imax(f(), g());      /* moi cai chay dung mot lan */

/* Hoac neu buoc phai dung macro, tinh truoc: */
int fa = f(), gb = g();
int m2 = MAX(fa, gb);        /* gio doi so la bien thuan tuy */

Trên GCC và Clang có mẹo chỉ đánh giá một lần

#define MAX(a, b)                     \
    __extension__ ({                  \
        __auto_type _a = (a);         \
        __auto_type _b = (b);         \
        _a > _b ? _a : _b;            \
    })

/* Bieu thuc khoi ({ ... }) va __auto_type deu la MO RONG GNU,
   khong co trong chuan C. Chung giai quyet triet de van de:
   moi doi so duoc tinh dung mot lan, va macro van lam viec
   voi moi kieu.

   Danh doi: ma khong chay tren MSVC. Chi dung khi ban chac
   chan du an chi bien dich bang GCC hoac Clang. */

Dấu gạch dưới trong _a và _b là để giảm khả năng trùng với tên biến của người gọi. Nếu người gọi viết MAX(_a, x) thì macro vẫn hỏng, và đó là một lý do nữa để thích hàm hơn.

#Cạm bẫy ba: nhiều câu lệnh

p4.c

#include <stdio.h>

#define HOAN_DOI_XAU(a, b) t = a; a = b; b = t;

int main(void) {
    int p = 1, q = 2, t = 0;
    int x = 0;                     /* dieu kien SAI */

    if (x) HOAN_DOI_XAU(p, q);

    printf("p = %d, q = %d, t = %d\n", p, q, t);

    return 0;
}

terminal

gcc -std=c11 -Wall -o p4 p4.c

p4.c:3:28: warning: macro expands to multiple statements [-Wmultistatement-macros]
    3 | #define HOAN_DOI_XAU(a, b) t = a; a = b; b = t;
      |                            ^
p4.c:9:12: note: in expansion of macro 'HOAN_DOI_XAU'

./p4

p = 2, q = 0, t = 0

Điều kiện sai mà hai câu lệnh vẫn chạy

if (x) HOAN_DOI_XAU(p, q);

/* Bung ra thanh: */

if (x) t = p;      /* CHI cau lenh nay thuoc if */
p = q;             /* luon chay */
q = t;             /* luon chay */

/* Voi x = 0, p = 1, q = 2, t = 0:
     if (0) t = p;   -> khong chay, t van la 0
     p = q;          -> p = 2
     q = t;          -> q = 0

   Ket qua p = 2, q = 0. Hai bien vua bi pha hong
   trong mot nhanh le ra khong duoc chay. */

GCC có cảnh báo -Wmultistatement-macros nằm trong -Wall cho trường hợp này. Đó là một lý do nữa để luôn bật -Wall -Wextra, như Bài 1.4 đã dặn.

Vì sao dùng do while không

#define HOAN_DOI(a, b)  do {          \
        int t = (a);                  \
        (a) = (b);                    \
        (b) = t;                      \
    } while (0)

Cách bọc	Dùng sau if không ngoặc	Nuốt được dấu chấm phẩy
Không bọc gì	Không	Không
Bọc bằng ngoặc nhọn	Được	Không
do while không	Được	Được

Bọc bằng ngoặc nhọn thôi thì hỏng ở else

#define HOAN_DOI(a, b) { int t = (a); (a) = (b); (b) = t; }

if (x)
    HOAN_DOI(p, q);
else
    printf("khong doi\n");

/* Bung ra: */

if (x)
    { int t = p; p = q; q = t; } ;      /* dau CHAM PHAY thua */
else                                     /* -> else khong con if nao */
    printf("khong doi\n");

/* gcc bao: error: 'else' without a previous 'if' */

/* Voi do while (0): */

if (x)
    do { int t = p; p = q; q = t; } while (0) ;
else
    printf("khong doi\n");

/* "do ... while (0)" la MOT cau lenh, va dau cham phay
   cua nguoi goi chinh la dau cham phay ket thuc no.
   Menh de else noi lien duoc voi if. */

Macro trả về giá trị thì không bọc được bằng do while

#define TANG_ROI_LAY(p) do { ++(p); } while (0)

int x = TANG_ROI_LAY(a);       /* LOI: do-while khong phai bieu thuc */

/* Neu macro can TRA VE gia tri thi:
     - dung mot bieu thuc duy nhat, boc bang ngoac tron
     - hoac dung ham, day la lua chon dung o Bai 19.4
     - hoac dung bieu thuc khoi cua GNU nhu o tren */

#define TANG(p) (++(p))         /* bieu thuc, tra ve gia tri */

#Danh sách kiểm khi viết macro

Câu hỏi	Nếu trả lời sai thì
Mỗi tham số có ngoặc quanh nó chưa	Đối số là biểu thức sẽ bị xé ra
Cả thân macro có ngoặc quanh nó chưa	Biểu thức xung quanh sẽ xé macro ra
Mỗi tham số xuất hiện đúng một lần chưa	Đối số có tác dụng phụ sẽ chạy nhiều lần
Macro nhiều câu lệnh đã bọc do while chưa	Hỏng khi dùng sau if hoặc trước else
Tên macro có viết hoa hết không	Có thể phá tên biến hoặc hàm của người khác
Tên biến bên trong có tiền tố gạch dưới chưa	Có thể che biến cùng tên của người gọi
Có thể viết bằng static inline không	Nếu có thì nên viết bằng hàm, xem Bài 19.4

Cạm bẫy thứ tư ít gặp: biến bên trong che biến bên ngoài

#define HOAN_DOI(a, b) do { int t = (a); (a) = (b); (b) = t; } while (0)

int t = 1, u = 2;

HOAN_DOI(t, u);

/* Bung ra: */
do { int t = (t); (t) = (u); (u) = t; } while (0);
/*          ^^^^^^^^^ bien t moi khoi tao bang CHINH NO,
                      tuc la gia tri rac */

/* Cach giam rui ro: dat ten it dung */
#define HOAN_DOI(a, b) \
    do { int _hd_tam = (a); (a) = (b); (b) = _hd_tam; } while (0)

/* Van khong triet de. Chi ham moi triet de. */

terminal

./thu-che-bien

t = 1, u = 2   (mong doi t = 2, u = 1)

Không có gì bị đổi cả. Mọi tên t trong thân macro đều trỏ tới biến t mới khai báo bên trong khối, nên biến t của người gọi không hề bị đụng tới. Chương trình chạy, không cảnh báo, và phép hoán đổi lặng lẽ không xảy ra.

Bộ macro tiện ích viết đúng

tien-ich.h

#ifndef TIEN_ICH_H
#define TIEN_ICH_H

#include <stddef.h>
#include <stdlib.h>

/* So phan tu cua mot MANG THAT SU. Xem canh bao ben duoi. */
#define SO_PHAN_TU(a)      (sizeof (a) / sizeof (a)[0])

/* Giai phong roi dat lai NULL, chong giai phong hai lan */
#define GIAI_PHONG(p)      do { free(p); (p) = NULL; } while (0)

/* Danh dau tham so co y khong dung, tat canh bao -Wunused-parameter */
#define KHONG_DUNG(x)      ((void)(x))

/* Kep gia tri vao khoang. Chu y: x duoc tinh NHIEU LAN. */
#define KEP(x, lo, hi)     ((x) < (lo) ? (lo) : ((x) > (hi) ? (hi) : (x)))

#endif /* TIEN_ICH_H */

SO_PHAN_TU im lặng cho kết quả sai với con trỏ

int a[10];
printf("%zu\n", SO_PHAN_TU(a));       /* 10, dung */

void f(int a[10]) {
    printf("%zu\n", SO_PHAN_TU(a));   /* 2 tren may 64 bit!
                                          Tham so mang la CON TRO,
                                          sizeof(int*) / sizeof(int) = 8/4 */
}

/* Bai 9.6 da noi ve viec mang suy bien thanh con tro khi truyen vao ham.
   Macro nay chi dung duoc voi mang khai bao TRONG CUNG PHAM VI.

   May man la gcc co canh bao rieng cho truong hop nay:
     warning: 'sizeof' on array function parameter 'a'
              will return size of 'int *' [-Wsizeof-array-argument]
   Canh bao do nam trong -Wall.

   Tren GCC va Clang co the bat loi nay luc bien dich: */
#define SO_PHAN_TU(a)                                            \
    (sizeof (a) / sizeof (a)[0]                                  \
     + 0 * sizeof(struct {                                       \
         _Static_assert(!__builtin_types_compatible_p(           \
             __typeof__(a), __typeof__(&(a)[0])),                \
             "SO_PHAN_TU dung voi con tro");                     \
         int _x;                                                 \
     }))

Tự làm thử

Viết SQ_XAU và SQ rồi chạy gcc -E -P, so kết quả với bảng ở trên.
Tìm một biểu thức mà #define SQ_NUA(x) (x) * (x) vẫn cho kết quả sai, và giải thích.
Chạy SQ(i++) với i = 5 trên máy bạn và so sánh với kết quả trong bài.
Viết HOAN_DOI_XAU rồi dùng nó sau if với điều kiện sai, xác nhận hai biến vẫn bị đổi.
Bọc lại bằng ngoặc nhọn thôi rồi thêm nhánh else, đọc thông báo lỗi của trình biên dịch.
Gọi HOAN_DOI(t, u) với một biến tên đúng là t và xem kết quả.

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

Macro cần ngoặc quanh mỗi tham số và quanh cả thân, thiếu bên nào cũng có biểu thức làm nó sai.
Tham số xuất hiện nhiều lần trong thân thì đối số được tính nhiều lần, nên i++ tăng hai lần và f() chạy hai lần.
Macro nhiều câu lệnh phải bọc do { ... } while (0), vì chỉ cách đó mới vừa dùng được sau if vừa nuốt được dấu chấm phẩy.
Biến khai báo bên trong macro có thể che biến cùng tên của người gọi, và không có cách nào chữa triệt để.
-Wall bắt được cạm bẫy nhiều câu lệnh, còn hai cạm bẫy kia thì không ai báo cho bạn.