C语言中do...while(0)的妙用

最新推荐文章于 2023-01-29 09:13:34 发布

AdolphLua

最新推荐文章于 2023-01-29 09:13:34 发布

阅读量300

点赞数

分类专栏： c/c++语言

c/c++语言专栏收录该内容

36 篇文章

订阅专栏

本文详细介绍了Linux内核代码中do...while(0)宏的多种用途，包括避免goto语句、消除代码冗余、避免编译警告以及在复杂宏中的使用。通过实例分析，展示了如何有效利用此宏提高代码的简洁性和可读性。

在linux内核代码中，经常看到do...while(0)的宏，do...while(0)有很多作用，下面举出几个：

1、避免goto语句：

通常，如果一个函数开始要分配一些资源，然后如果在中途遇到错误则要退出函数，当然，退出前要释放资源，我们的代码可能如下：　

#defien N 10

bool Execute()
{
   // 分配资源
   int *p = (int *)malloc(N * sizeof(int));
   bool bOk = true;

   // 执行并进行错误处理
   bOk = func1();
   if(!bOk) 
   {
      free(p);   
      p = NULL;
      return false;
   }

   bOk = func2();
   if(!bOk) 
   {
      free(p);   
      p = NULL;
      return false;
   }

   bOk = func3();
   if(!bOk) 
   {
      free(p);    
      p = NULL;
      return false;
   }

   // ..........

   // 执行成功，释放资源并返回
    free(p);   
    p = NULL;
    return true;
}

这里最大的问题是代码冗余，每增加一个操作，就要做相应的错误处理，非常不灵活，于是想到了一下的goto：

#defien N 10

bool Execute()
{
   // 分配资源
   int *p = (int *)malloc(N * sizeof(int));
   bool bOk = true;

   // 执行并进行错误处理
   bOk = func1();
   if(!bOk) goto errorhandle;

   bOk = func2();
   if(!bOk) goto errorhandle;

   bOk = func3();
   if(!bOk) goto errorhandle;

   // ..........

   // 执行成功，释放资源并返回
    free(p);   
    p = NULL;
    return true;

    errorhandle:
    free(p);   
    p = NULL;
    return false; 
}

代码冗余是解决了，但是引入了C语言中比较微妙的goto语句，虽然正确的使用goto语句可以大大提高程序的灵活性与简洁性，但是会使我们的程序捉摸不定，为了既避免使用goto语句，又能消除代码冗余，可以考虑使用下面的 do...while(0)：

#defien N 10

bool Execute()
{
    //分配资源
    int *p = (int *)malloc(N * sizeof(int));
    bool bOK = true;


    do {
        //执行并进行错误处理
        bOK = fun1();
        if(!bOK) break;

        bOK = fun2();
        if(!bOK) break;

        bOK = fun3();
        if(!bOK) break;

        //.........
    }  while(0);

    //释放资源
    
    free(p);
    p = NULL;
    return bOK;
}

2、避免空声明在编译时出现警告：

在linux内核源代码中，经常看到如下宏以避免在编译时出现警告：

#define FOO do { } while(0)

3、提供一个声明局部变量的基础块：

你可能经常会使用如下的宏：

#define exch(x,y) { int tmp; tmp=x; x=y; y=tmp; }

然而在某些情况下将会失效，下面的代码使用if...else...

if (x > y)
        exch(x,y);          // 分支 1
else  
        do_something();     // 分支 2

但是将被解释为一个分支的if语句：

if (x > y) {     
        int tmp;            
        tmp = x;            
        x = y;
        y = tmp;
}
;                           // 空语句
else                        // ERROR!!! 
        do_something();

错误出在“;”直接位于代码块的后面，解决的办法是将代码嵌入do...while(0)，于是得到下面的代码：

1 if (x > y)
2         do {
3                 int tmp;
4                 tmp = x;
5                 x = y;
6                 y = tmp;
7         } while(0);
8 else
9         do_something();

于是上面的宏可以修改为：

1 #define exch(x,y)       do {\
2                 int tmp;\
3                 tmp = x;\
4                 x = y;\
5                 y = tmp;\
6         } while(0)

4、在条件语句中使用复杂的宏：

假如一个宏包含类似如下几行代码：

#define FOO(x) \
        printf("arg is %s\n", x); \
        do_something_useful(x);

现在想像一下下面的代码：

if (blah == 2)
        FOO(blah);

这将解释为：

if (blah == 2)
        printf("arg is %s\n", blah);
        do_something_useful(blah);;

我们就会发现，if语句只作用于printf(), do_something_useful() 没按照愿意一起执行，即没有像你预期的那样被包含在if代码中，于是可以使用如下的代码块：

if (blah == 2)
        do {
                printf("arg is %s\n", blah);
                do_something_useful(blah);
        } while (0);

这样上面的宏就可以改为：

1 #define  FOO(x) do { \
2                 printf("arg is %s\n", blah);\
3                 do_something_useful(blah);\
4         } while (0)

PS：以上的第三种和第四种技巧，并不是唯一的方法，有同学留言说用其他的方法也可以实现，反而显得这样的宏定义过于花哨？事实并非如此，这样的宏定义在linux内核代码中非常常见，原因是代码简洁、通用、可移植性好。