Assert宏的一些理解

http://blog.csdn.net/wuhong40/article/details/6151193

assert宏的作用就是在调试的时候通知开发人员这里发生错误了，程序停止运行。用法assert(express)，当表达式express值为true时继续执行程序，否则终止程序。举个例子：

code:

#include <stdio.h>

#include <assert.h>

int main(int argc, const char *argv[])

{

    assert(0);

    printf("hello, world!/n");

    return 0;

}

 

compile: gcc main.c

execute & result:

wu@wu-A8Sc:~/workspace/tt2$ gcc main.c 

wu@wu-A8Sc:~/workspace/tt2$ ./a.out 

a.out: main.c:5: main: Assertion `0' failed.

Aborted

 

assert断言只是在调试程序的时候起作用。他通过NDEBUG宏来决定assert的功能，如果定义了NDEBUG则assert不做任何事情，否则将执行一些操作（最后调用abort中止程序）。比如我们在编译的时候加入参数 -DNDEBUG则不做任何事情，将输出hello,world!。

wu@wu-A8Sc:~/workspace/tt2$ gcc -DNDEBUG main.c 

wu@wu-A8Sc:~/workspace/tt2$ ./a.out 

hello, world!

其实在VC中的debug模式和release模式没有什么差别，关键就是一些编译选项的不同，比如是否启动编译优化，一些宏定义是否启用. 

我们可以看源代码，文件路径/usr/include/assert.h

 45 /* void assert (int expression);

 46 

 47    If NDEBUG is defined, do nothing.

 48    If not, and EXPRESSION is zero, print an error message and abort.  */

 49 

 50 #ifdef  NDEBUG

 

 51 

 52 # define assert(expr)       (__ASSERT_VOID_CAST (0))

第50-52行：当定义了NDEBUG时则不做任何事情。其中__ASSERT_VOID_CAST的定义如下

39 #if defined __cplusplus && __GNUC_PREREQ (2,95)

 40 # define __ASSERT_VOID_CAST static_cast<void>

//C++

 41 #else

 42 # define __ASSERT_VOID_CAST (void)

 

//C语言

 43 #endif

因此我们很容易得到当定义了NDEBUG宏定义了后，assert就是void(0)，什么事情都不做。让我们再看一下当没有定义NDEBUG时候assert做了些什么！

 91 # define assert(expr)                           /

 92   ((expr)                               /

 93    ? __ASSERT_VOID_CAST (0)                     /

 94    : __assert_fail (__STRING(expr), __FILE__, __LINE__, __ASSERT_FUNCTION))

93行时为表达式为true，此时的动作如定义了NDEBUG时候是一样的，都是void(0)。94行是表达式为false时的定义，如果仔细研究代码的话就会知道其调用_assert函数，在该函数中显示出错的文件和行号，最后调用abort()函数终止程序。

通过预定义一些宏来开发程序是非常有帮助的。只需要在makefile中通过-D来打开宏定义，-U取消宏定义。使我们非常容易的实现debug模式和release模式。例如：(例子来自linux内核驱动开发)

#undef PDEBUG             /* undef it, just in case */

#ifdef SCULL_DEBUG

#  ifdef _ _KERNEL_ _

     /* This one if debugging is on, and kernel space */

#    define PDEBUG(fmt, args...) printk( KERN_DEBUG "scull: " fmt, ## args)

#  else

     /* This one for user space */

#    define PDEBUG(fmt, args...) fprintf(stderr, fmt, ## args)

#  endif

#else

#  define PDEBUG(fmt, args...) /* not debugging: nothing */

#endif

 

因此只要是debug模式就可以在编译时候添加-DSCULL_DEBUG. 非常简单和方便。

///---------------------------------------------------------------------------------------------------------------------------------------

01: 防止一个头文件被重复包含
#ifndef COMDEF_H
#define COMDEF_H
//头文件内容
#endif
02: 重新定义一些类型,防止由于各种平台和编译器的不同,而产生的类型字节数差异,方便移植。
typedef  unsigned char      boolean;     /* Boolean value type. */
typedef  unsigned long int  uint32;      /* Unsigned 32 bit value */
typedef  unsigned short     uint16;      /* Unsigned 16 bit value */
typedef  unsigned char      uint8;       /* Unsigned 8  bit value */
typedef  signed long int    int32;       /* Signed 32 bit value */
typedef  signed short       int16;       /* Signed 16 bit value */
typedef  signed char        int8;        /* Signed 8  bit value */

//下面的不建议使用
typedef  unsigned char     byte;         /* Unsigned 8  bit value type. */
typedef  unsigned short    word;         /* Unsinged 16 bit value type. */
typedef  unsigned long     dword;        /* Unsigned 32 bit value type. */
typedef  unsigned char     uint1;        /* Unsigned 8  bit value type. */
typedef  unsigned short    uint2;        /* Unsigned 16 bit value type. */
typedef  unsigned long     uint4;        /* Unsigned 32 bit value type. */
typedef  signed char       int1;         /* Signed 8  bit value type. */
typedef  signed short      int2;         /* Signed 16 bit value type. */
typedef  long int          int4;         /* Signed 32 bit value type. */
typedef  signed long       sint31;       /* Signed 32 bit value */
typedef  signed short      sint15;       /* Signed 16 bit value */
typedef  signed char       sint7;        /* Signed 8  bit value */

03: 得到指定地址上的一个字节或字
#define  MEM_B(x) (*((byte *)(x)))
#define  MEM_W(x) (*((word *)(x)))

04: 求最大值和最小值
#define  MAX(x,y) (((x)>(y)) ? (x) : (y))
#define  MIN(x,y) (((x) < (y)) ? (x) : (y))

05: 得到一个field在结构体(struct)中的偏移量
#define FPOS(type,field) ((dword)&((type *)0)->field)

06: 得到一个结构体中field所占用的字节数
#define FSIZ(type,field) sizeof(((type *)0)->field)

07: 按照LSB格式把两个字节转化为一个Word
#define FLIPW(ray) ((((word)(ray)[0]) * 256) + (ray)[1])

08: 按照LSB格式把一个Word转化为两个字节
#define FLOPW(ray,val) (ray)[0] = ((val)/256); (ray)[1] = ((val) & 0xFF)

09: 得到一个变量的地址（word宽度）
#define B_PTR(var)  ((byte *) (void *) &(var))
#define W_PTR(var)  ((word *) (void *) &(var))

10: 得到一个字的高位和低位字节
#define WORD_LO(xxx)  ((byte) ((word)(xxx) & 255))
#define WORD_HI(xxx)  ((byte) ((word)(xxx) >> 8))

11: 返回一个比X大的最接近的8的倍数
#define RND8(x) ((((x) + 7)/8) * 8)

12: 将一个字母转换为大写
#define UPCASE(c) (((c)>='a' && (c) <= 'z') ? ((c) - 0x20) : (c))

13: 判断字符是不是10进值的数字
#define  DECCHK(c) ((c)>='0' && (c)<='9')

14: 判断字符是不是16进值的数字
#define HEXCHK(c) (((c) >= '0' && (c)<='9') ((c)>='A' && (c)<= 'F') \
((c)>='a' && (c)<='f'))

15: 防止溢出的一个方法
#define INC_SAT(val) (val=((val)+1>(val)) ? (val)+1 : (val))

16: 返回数组元素的个数
#define ARR_SIZE(a)  (sizeof((a))/sizeof((a[0])))

17: 返回一个无符号数n尾的值MOD_BY_POWER_OF_TWO(X,n)=X%(2^n)
#define MOD_BY_POWER_OF_TWO( val, mod_by ) ((dword)(val) & (dword)((mod_by)-1))

18: 对于IO空间映射在存储空间的结构,输入输出处理
#define inp(port) (*((volatile byte *)(port)))
#define inpw(port) (*((volatile word *)(port)))
#define inpdw(port) (*((volatile dword *)(port)))
#define outp(port,val) (*((volatile byte *)(port))=((byte)(val)))
#define outpw(port, val) (*((volatile word *)(port))=((word)(val)))
#define outpdw(port, val) (*((volatile dword *)(port))=((dword)(val)))

19: 使用一些宏跟踪调试
ANSI标准说明了五个预定义的宏名。它们是：
__LINE__
__FILE__
__DATE__
__TIME__
__STDC__
C++中还定义了 __cplusplus

如果编译器不是标准的,则可能仅支持以上宏名中的几个,或根本不支持。记住编译程序也许还提供其它预定义的宏名。

__LINE__ 及 __FILE__ 宏指示，#line指令可以改变它的值，简单的讲，编译时，它们包含程序的当前行数和文件名。

__DATE__ 宏指令含有形式为月/日/年的串,表示源文件被翻译到代码时的日期。
__TIME__ 宏指令包含程序编译的时间。时间用字符串表示，其形式为： 分：秒
__STDC__ 宏指令的意义是编译时定义的。一般来讲，如果__STDC__已经定义，编译器将仅接受不包含任何非标准扩展的标准C/C++代码。如果实现是标准的,则宏__STDC__含有十进制常量1。如果它含有任何其它数,则实现是非标准的。
__cplusplus 与标准c++一致的编译器把它定义为一个包含至少6为的数值。与标准c++不一致的编译器将使用具有5位或更少的数值。


可以定义宏,例如:
当定义了_DEBUG,输出数据信息和所在文件所在行
#ifdef _DEBUG
#define DEBUGMSG(msg,date) printf(msg);printf(“%d%d%d”,date,_LINE_,_FILE_)
#else
#define DEBUGMSG(msg,date)
#endif


20： 宏定义防止错误使用小括号包含。
例如：
有问题的定义：#define DUMP_WRITE(addr,nr) {memcpy(bufp,addr,nr); bufp += nr;}
应该使用的定义： #difne DO(a,b) do{a+b;a++;}while(0)
例如：
if(addr)
DUMP_WRITE(addr,nr);
else
do_somethong_else();
宏展开以后变成这样:
if(addr)
{memcpy(bufp,addr,nr); bufp += nr;};
else
do_something_else();

gcc 在碰到else前面的“；”时就认为if语句已经结束，因而后面的else不在if语句中。而采用do{} while(0)的定义，在任何情况下都没有问题。而改为 #difne DO(a,b) do{a+b;a++;}while(0) 的定义则在任何情况下都不会出错。