do{...}while的意义和用法

Posted 2020-10-08 abc_begin

linux内核和其他一些开源的代码中，经常会遇到这样的代码：

1 do{
2  ...
3 }while(0)

这样的代码一看就不是一个循环，do..while表面上在这里一点意义都没有，那么为什么要这么用呢？

实际上，do{...}while(0)的作用远大于美化你的代码。查了些资料，总结起来这样写主要有以下几点好处：

1、辅助定义复杂的宏，避免引用的时候出错：

举例来说，假设你需要定义这样一个宏：

1 #define DOSOMETHING()2                foo1();3                foo2();

这个宏的本意是，当调用DOSOMETHING()时，函数foo1()和foo2()都会被调用。但是如果你在调用的时候这么写：

1 if(a>0)
2     DOSOMETHING();

因为宏在预处理的时候会直接被展开，你实际上写的代码是这个样子的：

1 if(a>0)
2     foo1();
3 foo2();

这就出现了问题，因为无论a是否大于0，foo2()都会被执行，导致程序出错。

那么仅仅使用{}将foo1()和foo2()包起来行么？

我们在写代码的时候都习惯在语句右面加上分号，如果在宏中使用{}，代码里就相当于这样写了：“{...};”，展开后就是这个样子：

1 if(a>0)
2 {
3     foo1();
4     foo2();
5 };

这样甚至不会编译通过。所以，很多人才采用了do{...}while(0);

 1 #define DOSOMETHING()  2         do{  3           foo1(); 4           foo2(); 5         }while(0) 6     
 7 ...
 8  
 9 if(a>0)
10     DOSOMETHING();
11  
12 ...

这样，宏被展开后，才会保留初始的语义。GCC提供了Statement-Expressions用以替代do{...}while(0); 所以你也可以这样定义宏：

1 #define DOSOMETHING() ({2         foo1(); 3         foo2(); 4 })

 

2、避免使用goto对程序流进行统一的控制：

有些函数中，在函数return之前我们经常会进行一些收尾的工作，比如free掉一块函数开始malloc的内存，goto一直都是一个比较简便的方法：

 1 int foo()
 2 {
 3     somestruct* ptr = malloc(...);
 4  
 5     dosomething...;
 6     if(error)
 7     {
 8         goto END;
 9     }
10  
11     dosomething...;
12     if(error)
13     {
14         goto END;
15     }
16     dosomething...;
17  
18 END:
19     free(ptr);
20     return 0;
21  
22 }

由于goto不符合软件工程的结构化，而且有可能使得代码难懂，所以很多人都不倡导使用，那这个时候就可以用do{}while(0)来进行统一的管理：

 1 int foo()
 2 {
 3  
 4     somestruct* ptr = malloc(...);
 5  
 6     do{
 7         dosomething...;
 8         if(error)
 9         {
10             break;
11         }
12  
13         dosomething...;
14         if(error)
15         {
16             break;
17         }
18         dosomething...;
19     }while(0);
20  
21     free(ptr);
22     return 0;
23  
24 }

这里将函数主体使用do()while(0)包含起来，使用break来代替goto，后续的处理工作在while之后，就能够达到同样的效果。

 

3、避免空宏引起的warning：

内核中由于不同架构的限制，很多时候会用到空宏，在编译的时候，空宏会给出warning，为了避免这样的warning，就可以使用do{}while(0)来定义空宏：

1 #define EMPTYMICRO do{}while(0)

 

4、定义一个单独的函数块来实现复杂的操作：

当你的功能很复杂，变量很多你又不愿意增加一个函数的时候，使用do{}while(0);，将你的代码写在里面，里面可以定义变量而不用考虑变量名会同函数之前或者之后的重复。

 

参考自：http://www.spongeliu.com/415.html