do {...} while (0) 的用途汇总

转自：http://www.cnblogs.com/lanxuezaipiao/p/3535674.html

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

1 2 3

do {       ...  } while (0)

该代码片段并非循环，这样想想似乎使用do…while没有任何意义，那么为什么还要使用它呢？

实际上，do{...}while(0)的用途并不仅仅是优化你的代码。经过一系列的调研和探索，我们总结出它的一些用途如下。

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

如果你是一名C程序员，你肯定很熟悉宏，它们非常强大，如果正确使用可以让你的工作事半功倍。然而，如果你在定义宏时很随意没有认真检查，那么它们可能使你发狂，浪费N多时间。在很多的C程序中，你可能会看到许多看起来不是那么直接的较特殊的宏定义。下面就是一个例子：

1 2	#define __set_task_state(tsk, state_value)      \      do  { (tsk)->state = (state_value); }  while  (0)

在Linux内核和其它一些著名的C库中有许多使用do{...}while(0)的宏定义。这种宏的用途是什么？有什么好处？

Google的Robert Love（先前从事Linux内核开发）给我们解答如下：

do{...}while(0)在C中是唯一的构造程序，让你定义的宏总是以相同的方式工作，这样不管怎么使用宏（尤其在没有用大括号包围调用宏的语句），宏后面的分号也是相同的效果。

这句话听起来可能有些拗口，其实用一句话概括就是：使用do{...}while(0)构造后的宏定义不会受到大括号、分号等的影响，总是会按你期望的方式调用运行。

例如：

1	#define foo(x) bar(x); baz(x)

然后你可能这样调用：

1	foo(wolf);

这将被宏扩展为：

1	bar(wolf); baz(wolf);

这的确是我们期望的正确输出。下面看看如果我们这样调用：

1 2	if  (!feral)      foo(wolf);

那么扩展后可能就不是你所期望的结果。上面语句将扩展为:

1 2 3

if  (!feral)      bar(wolf); baz(wolf);

显而易见，这是错误的，也是大家经常易犯的错误之一。

 

几乎在所有的情况下，期望写多语句宏来达到正确的结果是不可能的。你不能让宏像函数一样行为——在没有do/while(0)的情况下。

如果我们使用do{...}while(0)来重新定义宏，即：

1	#define foo(x) do { bar(x); baz(x); } while (0)

现在，该语句功能上等价于前者，do能确保大括号里的逻辑能被执行，而while(0)能确保该逻辑只被执行一次，即与没有循环时一样。

对于上面的if语句，将会被扩展为：

1 2	if  (!feral)      do  { bar(wolf); baz(wolf); }  while  (0);

从语义上讲，它与下面的语句是等价的：

1 2 3 4

if  (!feral) {      bar(wolf);      baz(wolf); }

这里你可能感到迷惑不解了，为什么不用大括号直接把宏包围起来呢？为什么非得使用do/while(0)逻辑呢？

例如，我们用大括号来定义宏如下：

1	#define foo(x)  { bar(x); baz(x); }

这对于上面举的if语句的确能被正确扩展，但是如果我们有下面的语句调用呢：

1 2 3 4

if  (!feral)      foo(wolf); else      bin(wolf);

宏扩展后将变成：

1 2 3 4 5 6

if  (!feral) {      bar(wolf);      baz(wolf); }; else      bin(wolf);

大家可以看出，这就有语法错误了。

 

总结：Linux和其它代码库里的宏都用do/while(0)来包围执行逻辑，因为它能确保宏的行为总是相同的，而不管在调用代码中使用了多少分号和大括号。

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

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

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22

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)来解决这一问题：

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24

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，代码的可读性增强了。

 

三. 避免由宏引起的警告

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

1	#define EMPTYMICRO do{}while(0)

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

 

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

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