C语言之do{...}while(0)的用途

1,031 阅读3分钟

在一些Linux内核和其它的开源代码中,我们经常看到像下面这样的代码:

do{ 
    ... 
}while(0)

该代码片段并非循环,这样想想似乎使用do…while没有任何意义,那么为什么还要使用它呢? 实际上,do{...}while(0)的用途并不仅仅是优化你的代码。经过一系列的调研和探索,我们总结出它的一些用途如下。

1. 帮助定义复杂的宏以避免错误

使用do{...}while(0)构造后的宏定义不会受到大括号、分号等的影响,总是会按你期望的方式调用运行。

1.1 CASE1

#define foo(x) bar(x); baz(x)
然后你可能这样调用:
foo(wolf);
这将被宏扩展为:
bar(wolf); baz(wolf);
这的确是我们期望的正确输出。下面看看如果我们这样调用:
if (!feral)
    foo(wolf);
那么扩展后可能就不是你所期望的结果。上面语句将扩展为:
if (!feral)
    bar(wolf);
baz(wolf);
显而易见,这是错误的,也是大家经常易犯的错误之一。

使用do{...}while(0)来解决如上问题:

#define foo(x) do { bar(x); baz(x); } while (0)
对于此调用:
if (!feral)
    foo(wolf);
那么扩展后可能就不是你所期望的结果。上面语句将扩展为:
if (!feral)
    do { bar(wolf); baz(wolf); } while (0);
从语义上讲,它与下面的语句是等价的:
if (!feral) {
    bar(wolf);
    baz(wolf);
}

1.2 CASE2

CASE1中解决方法为什么不用大括号直接把宏包围起来呢?为什么非得使用do{...}while(0)逻辑呢?

例如,我们用大括号来定义宏如下:
#define foo(x)  { bar(x); baz(x); }
这对于上面举的if语句:
if (!feral)
    foo(wolf);
能够正确扩展为如下形式:
if (!feral) {
    bar(wolf);
    baz(wolf);
};
但是如果我们有下面的语句调用呢:
if (!feral)
    foo(wolf);
else
    bin(wolf);
宏扩展后将变成:
if (!feral) {
    bar(wolf);
    baz(wolf);
};
else
    bin(wolf);
而通过do{...}while(0)能够进行正确扩展:
if (!feral)
    do { bar(wolf); baz(wolf); } while (0);
else
    bin(wolf)

2. 避免使用goto控制程序流

在一些函数中,我们在return语句之前可能需要做一些工作,比如释放在函数一开始由malloc函数申请的内存空间,使用goto总是一种简单的方法:

int foo() 
{ 
    somestruct* ptr = malloc(...); 
    dosomething...; 
    if(error) 
    { 
        goto END; 
    } 
    
    dosomething...; 
    if(error) 
    { 
        goto END; 
    } 
    dosomething...; 
END: 
    free(ptr); 
    return 0;   
} 

但由于goto关键字可能会使代码不易读,因此许多人都不推荐使用它,那么我们可以使用do{...}while(0)来解决这一问题:

int foo() 
{ 
    somestruct* ptr = malloc(...); 
    do{ 
        dosomething...; 
        if(error) 
        { 
            break; 
        } 
        dosomething...; 
        if(error) 
        { 
            break; 
        } 
        dosomething...; 
    }while(0);  
    free(ptr); 
    return 0; 
} 

这里,我们使用do{...}while(0)来包含函数的主要部分,同时使用break替换goto,代码的可读性增强了。

3. 避免由宏引起的警告

由于内核不同体系结构的限制,我们可能需要多次使用空宏。在编译的时候,这些空宏会产生警告,为了避免这种警告,我们可以使用do{...}while(0)来定义空宏:

#define EMPTYMICRO do{}while(0) 

这样在编译的时候就不会产生警告。

4. 定义单一的函数块来完成复杂的操作

如果你有一个复杂的函数且你不想要创建新的函数,那么使用do{...}while(0),你可以将一些代码放在这里面并定义一些变量,这样你就不必担心do{...}while(0)外面的变量名是否与do{...}while(0)里面的变量名相同造成重复了。

3. 参考文献

do {...} while (0) 在宏定义中的作用
do {...} while (0) 的用途汇总