Bài 54.126 phút đọc

Macro hàm và các bẫy

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

Bọc ngoặc đúng chỗ cho mọi tham số và cho cả biểu thức
Nhận ra bẫy đánh giá nhiều lần
Dùng do while (0) cho macro dạng câu lệnh
Biết khi nào static inline tốt hơn macro

Macro không phải hàm. Nó là phép thay thế văn bản, và bốn cái bẫy trong bài này đều đến từ chính điều đó. Ba cái đầu có cách chữa cơ học, cái thứ tư thì không.

#Bẫy một: thiếu ngoặc

Thiếu ngoặc

#define BINH(x) x * x

BINH(3 + 1)        /* bung ra: 3 + 1 * 3 + 1  =  7, khong phai 16 */

#define NUA(x) (x) / 2

10 / NUA(4)        /* bung ra: 10 / (4) / 2  =  1, khong phai 5 */

#define TOI_DA 10 + 5

int a[TOI_DA];     /* int a[10 + 5], tinh co dung */
int b = TOI_DA * 2;  /* 10 + 5 * 2 = 20, khong phai 30 */

Ngoặc đầy đủ

#define BINH(x) ((x) * (x))

BINH(3 + 1)        /* ((3 + 1) * (3 + 1)) = 16 */

#define NUA(x) ((x) / 2)

10 / NUA(4)        /* 10 / ((4) / 2) = 5 */

#define TOI_DA (10 + 5)

int b = TOI_DA * 2;  /* (10 + 5) * 2 = 30 */

Quy tắc: hai lớp ngoặc

#define TEN(a, b) ((a) op (b))
                    ^  ^^^    ^^^  ^
                    |   |      |   |
                    |   +------+---+--- ngoac quanh MOI THAM SO
                    |                   -> chong loi do uu tien BEN TRONG
                    +------------------- ngoac quanh CA BIEU THUC
                                         -> chong loi do uu tien BEN NGOAI

/* Vi du day du: */
#define TOI_DA_HAI(a, b) ((a) > (b) ? (a) : (b))
#define TRUNG_BINH(a, b) (((a) + (b)) / 2.0)
#define LA_CHAN(n)       (((n) % 2) == 0)
#define BIT(n)           (1u << (n))

/* Ngoai le duy nhat: khi tham so nam trong dau ngoac san */
#define IN(x) printf("%d\n", x)      /* doi so ham, khong can ngoac */
#define CHUOI(x) #x                   /* toan tu #, khong can ngoac */
#define NOI(a, b) a##b                /* toan tu ##, KHONG DUOC co ngoac */

terminal

# Xem macro bung ra thành gì

gcc -E -P macro.c

int main(void) {
    int a = 3 + 1 * 3 + 1;
    int b = ((3 + 1) * (3 + 1));
    return a + b;
}

Cạm bẫy tinh vi: dấu trừ một ngôi

#define AM(x) -x

AM(-5)             /* bung ra: --5, tuc toan tu giam! Loi cu phap
                      hoac dich duoc voi nghia hoan toan khac */

#define AM(x) (-(x))
AM(-5)             /* (-(-5)) = 5, dung */

/* Va truong hop nay: */
#define TRU(a, b) ((a) - (b))
TRU(x, -y)         /* ((x) - (-y)) = x + y, dung */

/* Neu thieu ngoac quanh b: */
#define TRU(a, b) ((a) - b)
TRU(x, -y)         /* ((x) - -y), van dung o day nhung: */
TRU(x, y + 1)      /* ((x) - y + 1) = x - y + 1, SAI */

#Bẫy hai: đánh giá nhiều lần

Ngoặc đủ vẫn sai

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

int i = 0;
int x = TOI_DA(i++, 5);

/* Bung ra:
     int x = ((i++) > (5) ? (i++) : (5));

   i++ chay HAI lan neu nhanh dau duoc chon.
   Va day cung la sua i nhieu lan trong mot cau lenh, tuc UB
   theo Bai 33.5. */

int y = TOI_DA(f(), g());
/* f() co the chay hai lan. Neu f doc mot dong tu tep
   thi ban vua mat mot dong du lieu. */

Đối số	Nguy hiểm	Vì sao
Biến thường, x	Không	Đọc nhiều lần vô hại
Hằng số, 5	Không	Vô hại
i++ hoặc ++i	Có	Tác dụng phụ chạy nhiều lần
f()	Có	Hàm chạy nhiều lần
*p++	Có	Con trỏ tiến nhiều lần
a[i++]	Có	Cả hai vấn đề
x + 1	Không, nhưng chậm	Phép cộng tính nhiều lần

Ba cách chữa

/* 1. Bieu thuc khoi cua GNU, danh gia moi doi so DUNG MOT LAN */

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

int x = TOI_DA(i++, 5);      /* i++ chay dung mot lan */

/* Nhuoc diem: chi chay tren GCC va Clang. */

/* 2. Ham static inline, cach chuan va thuong la tot nhat */

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

/* Nhuoc diem: chi lam viec voi mot kieu. Ket hop voi _Generic
   neu can nhieu kieu, Bai 51.3. */

/* 3. Ghi vao TAI LIEU cua macro, va dat ten canh bao */

/* CANH BAO: danh gia doi so nhieu lan.
   Khong truyen bieu thuc co tac dung phu. */
#define TOI_DA_KHONG_AN_TOAN(a, b) ((a) > (b) ? (a) : (b))

/* Cach 3 la cach thu vien chuan lam voi mot vai macro. */

Ví dụ thật: getc và putc là macro

/* Chuan C cho phep getc va putc la macro danh gia doi so
   nhieu lan. Chuan noi ro dieu do:

     "The getc function is equivalent to fgetc, except that if it is
      implemented as a macro, it may evaluate stream more than once,
      so the argument should never be an expression with side effects."

   Nen: */

int c = getc(ds[i++]);       /* NGUY HIEM: i co the tang hai lan */

FILE *f = ds[i++];
int c = getc(f);             /* an toan */

/* Va fgetc thi BAO DAM la ham, nen luon an toan:
     - getc  co the nhanh hon, nhung phai can than doi so
     - fgetc luon an toan, va thuong chi cham hon khong dang ke

   Voi ma binh thuong: dung fgetc va fputc. */

#Bẫy ba: macro dạng câu lệnh

Nhiều câu lệnh không bọc

#define GHI_LOG(tin) \
    dem_log++;       \
    printf("%s\n", tin)

if (co_loi)
    GHI_LOG("co loi");

/* Bung ra:
     if (co_loi)
         dem_log++;
     printf("%s\n", "co loi");     <- LUON chay!

   Va te hon: */

if (co_loi)
    GHI_LOG("co loi");
else
    xu_ly();
/* error: 'else' without a previous 'if' */

do while (0)

#define GHI_LOG(tin) do {   \
    dem_log++;              \
    printf("%s\n", tin);    \
} while (0)

if (co_loi)
    GHI_LOG("co loi");
else
    xu_ly();

/* Bung ra:
     if (co_loi)
         do { dem_log++; printf(...); } while (0);
     else
         xu_ly();

   Dung. Va dau cham phay o cuoi loi goi macro tro thanh
   dau cham phay ket thuc "do while", tuc dung cu phap. */

Vì sao do while (0) chứ không phải ngoặc nhọn

/* Voi ngoac nhon tran: */
#define GHI_LOG(tin) { dem_log++; printf("%s\n", tin); }

if (co_loi)
    GHI_LOG("co loi");     /* bung ra: if (...) { ... } ; */
else                       /* dau cham phay THUA truoc else */
    xu_ly();
/* error: 'else' without a previous 'if' */

/* Voi do while (0): */
#define GHI_LOG(tin) do { ... } while (0)

if (co_loi)
    GHI_LOG("co loi");     /* bung ra: if (...) do {...} while (0); */
else                       /* dau cham phay la mot phan cua cu phap */
    xu_ly();
/* dung */

/* "do { } while (0)" la mot CAU LENH DON can mot dau cham phay,
   giong het mot loi goi ham. Do la ca ly do no ton tai. */

Ba dạng macro và cách bọc từng dạng

/* 1. Macro BIEU THUC: co gia tri, dung ngoac tron */
#define BINH(x) ((x) * (x))
int y = BINH(3) + 1;

/* 2. Macro CAU LENH: khong co gia tri, dung do while (0) */
#define DOI_CHO(a, b) do {          \
    int _t = (a); (a) = (b); (b) = _t; \
} while (0)
DOI_CHO(x, y);

/* 3. Macro KHAI BAO: khong bo gi ca, va nho KHONG co dau cham phay */
#define KHAI_BAO_VEC(T, ten)                             \
    typedef struct { T *d; size_t n; } ten;              \
    int ten##_them(ten *v, T x);
KHAI_BAO_VEC(int, VecInt)      /* khong dau cham phay */

/* Neu ban muon nguoi dung viet dau cham phay cho dep thi them
   mot khai bao gia o cuoi: */
#define KHAI_BAO_VEC(T, ten)                             \
    typedef struct { T *d; size_t n; } ten;              \
    int ten##_them(ten *v, T x);                         \
    _Static_assert(1, "")            /* nuot dau cham phay */

KHAI_BAO_VEC(int, VecInt);     /* gio co dau cham phay, va dung */

Cạm bẫy của do while (0): không dùng được trong biểu thức

#define DOI_CHO(a, b) do { ... } while (0)

int x = (DOI_CHO(a, b), 5);    /* error: khong phai bieu thuc */

/* Neu ban CAN mot bieu thuc thi phai dung bieu thuc khoi cua GNU: */

#define DOI_CHO(a, b) __extension__({ ... })

/* Hoac tot hon: viet mot ham. */

static inline void doi_cho(int *a, int *b) {
    int t = *a; *a = *b; *b = t;
}

#Bẫy bốn: biến che khuất

Bẫy không có cách chữa cơ học

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

int _t = 5, y = 10;
DOI_CHO(_t, y);

/* Bung ra:
     do { int _t = (_t); (_t) = (y); (y) = _t; } while (0);
              ^^^^^^^^^^^
              bien _t MOI che khuat bien _t cua ban,
              va khoi tao no bang CHINH NO, tuc gia tri rac

   Ket qua: hoan toan sai, va khong canh bao nao. */

terminal

# Hoán đổi im lặng không làm gì cả

gcc -std=c11 -Wall -Wextra -Wshadow -o che.exe che.c && ./che.exe

che.c: In function 'main':
che.c:3:32: warning: declaration of '_t' shadows a previous local [-Wshadow]
 #define DOI_CHO(a, b) do { int _t = (a); (a) = (b); (b) = _t; } while (0)
                                ^~
che.c:8:5: note: in expansion of macro 'DOI_CHO'
     DOI_CHO(_t, y);
     ^~~~~~~
che.c:6:9: note: shadowed declaration is here
5 10

In ra 5 10, tức phép hoán đổi không làm gì cả

/* Bung ra:
     do { int _t = (_t); (_t) = (y); (y) = _t; } while (0);

   Doc tung buoc:
     int _t = (_t)   bien _t MOI, khoi tao bang chinh no -> gia tri rac
     (_t) = (y)      gan 10 vao bien _t MOI, khong dung toi bien cua ban
     (y)  = _t       gan 10 nguoc lai vao y

   Ket qua: ca hai bien khong doi. In ra 5 10 thay vi 10 5.

   Va chu y -Wshadow tro vao dong #define, kem mot dong "note"
   chi ra cho goi. Do la dac diem cua moi canh bao lien quan toi macro,
   va la ly do macro kho go loi hon ham. */

Và một dạng che khuất tinh vi hơn: tên hàm

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

/* Mot tep khac dinh nghia mot ham cung ten: */
int TOI_DA(int a, int b);      /* macro bung ra, thanh loi cu phap */

/* Nen quy tac dat ten macro:
     - CHU HOA cho macro, chu thuong cho ham va bien
     - them tien to du an: ML_TOI_DA thay vi TOI_DA
     - va khi thu vien cua ban co the bi include cung thu vien khac,
       tien to la bat buoc

   Vi du that: <windows.h> dinh nghia macro "min" va "max",
   va chung pha vo rat nhieu thu vien. Chua bang: */

#define NOMINMAX
#include <windows.h>

/* Hoac go bo chung: */
#include <windows.h>
#undef min
#undef max

#Khi nào dùng static inline thay thế

	Macro	static inline
Kiểm tra kiểu	Không	Có
Đánh giá đối số một lần	Không, trừ khi dùng thủ thuật	Có
Gỡ lỗi bằng GDB	Khó, cần -g3	Dễ, bước vào được
Thông báo lỗi	Trỏ vào dòng #define	Trỏ đúng chỗ
Làm việc với nhiều kiểu	Có	Không, trừ khi dùng _Generic
Dùng được trong #if	Có	Không
Dùng làm kích thước mảng	Có, nếu là hằng	Không
Truy cập __FILE__ và __LINE__ của nơi gọi	Có	Không
Tốc độ	Bằng nhau ở -O2	Bằng nhau ở -O2

Bốn trường hợp macro là lựa chọn đúng

/* 1. Can __FILE__ va __LINE__ cua NOI GOI */

#define KIEM(dk) do {                                          \
    if (!(dk)) printf("HONG %s:%d: %s\n",                      \
                      __FILE__, __LINE__, #dk);                \
} while (0)
/* Ham khong lam duoc: __LINE__ trong ham la dong cua HAM. */

/* 2. Can bien bieu thuc thanh CHUOI */

#define TEN_BIEN(x) #x
/* Bai 54.2 */

/* 3. Can lam viec voi nhieu kieu ma khong viet nhieu ham */

#define MANG_LEN(a) (sizeof(a) / sizeof((a)[0]))
/* Ham khong lam duoc: mang bi phan ra thanh con tro. */

/* 4. Can hang so dung duoc trong #if hoac lam kich thuoc mang */

#define BO_DEM_CO 4096
char bo_dem[BO_DEM_CO];
#if BO_DEM_CO > 1024
  ...
#endif
/* Truoc C23, "const int" khong lam duoc. Bai 32.2. */

Và một dấu hiệu nên dừng lại

/* Neu macro cua ban:
     - dai hon nam dong
     - co nhieu hon ba tang macro long nhau
     - can dau gach cheo nguoc o cuoi moi dong
     - va ban phai chay "gcc -E" de hieu no

   thi gan nhu chac chan co cach khac tot hon:

     - static inline, neu chi can mot kieu
     - _Generic bao mot vai ham, neu can vai kieu
     - con tro ham va void *, neu can moi kieu, Bai 30.1
     - hoac mot chuong trinh sinh ma, neu that su phuc tap

   Ngoai le: X Macro. No dai va roi, nhung khong co cach nao khac
   trong C, va no giai quyet mot van de that. Bai 54.3. */

Bốn quy tắc gói lại

/* 1. NGOAC quanh moi tham so VA quanh ca bieu thuc */
#define BINH(x) ((x) * (x))

/* 2. do while (0) cho macro dang cau lenh */
#define DOI_CHO(a, b) do { ... } while (0)

/* 3. TEN VIET HOA, va co tien to neu la thu vien */
#define ML_TOI_DA(a, b) ...

/* 4. Ghi vao chu thich neu macro danh gia doi so nhieu lan */
/* CANH BAO: danh gia a va b hai lan. Khong truyen bieu thuc
   co tac dung phu. */
#define ML_TOI_DA(a, b) ((a) > (b) ? (a) : (b))

Tự làm thử

Viết BINH(3 + 1) không ngoặc và xem nó bung ra bằng gcc -E -P.
Truyền i++ cho một macro đánh giá hai lần và in giá trị i sau đó.
Viết macro nhiều câu lệnh không bọc và dùng nó trong if else.
Đặt tên biến trùng với biến tạm của macro và chạy với -Wshadow.
Viết cùng một thứ bằng macro và bằng static inline, so hợp ngữ ở -O2.
Tìm trong một dự án mọi macro dài hơn năm dòng và xem có thay được bằng hàm không.

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

Ngoặc quanh mọi tham số và quanh cả biểu thức. Hai lớp chống hai loại lỗi ưu tiên khác nhau.
Ngoặc đủ vẫn không cứu được bẫy đánh giá nhiều lần; chỉ biểu thức khối hoặc hàm mới cứu được.
do while (0) biến nhiều câu lệnh thành một câu lệnh đơn cần dấu chấm phẩy, giống hệt lời gọi hàm.
Biến tạm trong macro có thể che khuất biến của người dùng, và không có cách chữa cơ học nào ngoài đặt tên khó trùng.
Bốn trường hợp macro là đúng: cần __LINE__ của nơi gọi, cần chuỗi hóa, cần nhiều kiểu, cần hằng số dùng trong #if.