GNU C中不为人知的特色：__attribute__机制

Posted 2022-11-25 xuhao_xuhao

 十一放假放的不亦乐乎啊，今天才静下来看看技术，偶然碰到了__attribute__，虽然之前在看Linux内核代码时见过很多次，但还是对它熟视无睹，罪过啊，下面的文章是从源码网上转载的，原文在这里:http://www.yuanma.org/data/2006/0625/article_948.htm，此处只是做简单阐述，共同进步。

    GNU C的一大特色（却不被初学者所知）就是__attribute__机制。__attribute__可以设置函数属性（Function Attribute）、变量属性（Variable Attribute）和类型属性（Type Attribute）。它的书写特征是：__attribute__前后都有两个下划线，并切后面会紧跟一对原括弧，括弧里面是相应的__attribute__参数，语法格式如下：

__attribute__ ((attribute-list))

    另外，它必须放于声明的尾部“；”之前。

函数属性

    函数属性可以帮助开发者把一些特性添加到函数声明中，从而可以使编译器在错误检查方面的功能更强大。__attribute__机制也很容易同非GNU应用程序做到兼容之功效。

    GNU CC需要使用 –Wall编译器来击活该功能，这是控制警告信息的一个很好的方式。下面介绍几个常见的属性参数。

    __attribute__ format。该__attribute__属性可以给被声明的函数加上类似printf或者scanf的特征，它可以使编译器检查函数声明和函数实际调用参数之间的格式化字符串是否匹配。该功能十分有用，尤其是处理一些很难发现的bug。format的语法格式为：

format (archetype, string-index, first-to-check)

format属性告诉编译器，按照printf, scanf, strftime或strfmon的参数表格式规则对该函数的参数进行检查。“archetype”指定是哪种风格；“string-index”指定传入函数的第几个参数是格式化字符串；“first-to-check”指定从函数的第几个参数开始按上述规则进行检查。

具体使用格式如下：

__attribute__((format(printf,m,n)))

__attribute__((format(scanf,m,n)))

其中参数m与n的含义为：

m：第几个参数为格式化字符串（format string）；

n：参数集合中的第一个，即参数“…”里的第一个参数在函数参数总数排在第几，注意，有时函数参数里还有“隐身”的呢，后面会提到；

    在使用上，__attribute__((format(printf,m,n)))是常用的，而另一种却很少见到。下面举例说明，其中myprint为自己定义的一个带有可变参数的函数，其功能类似于printf：

//m=1；n=2

extern void myprint(const char *format,...) __attribute__((format(printf,1,2)));

//m=2；n=3

extern void myprint(int l，const char *format,...) __attribute__((format(printf,2,3)));

需要特别注意的是，如果myprint是一个函数的成员函数，那么m和n的值可有点“悬乎”了，例如：

//m=3；n=4

extern void myprint(int l，const char *format,...) __attribute__((format(printf,3,4)));

    其原因是，类成员函数的第一个参数实际上一个“隐身”的“this”指针。（有点C++基础的都知道点this指针，不知道你在这里还知道吗？）

    这里给出测试用例：attribute.c，代码如下：

[cpp]

  view plain  copy

1. extern void myprint(const char *format,...) __attribute__((format(printf,1,2)));  
2.     void test()  
3.       
4.         myprint("i=%d\\n",6);  
5.         myprint("i=%s\\n",6);  
6.         myprint("i=%s\\n","abc");  
7.         myprint("%s,%d,%d\\n",1,2);  
8.       

    gcc编译后会提示format argument is not a pointer的警告。若去掉__attribute__((format(printf,1,2)))，则会正常编译。需要注意的是，编译器只能识别类似printf的标准输出库函数。

    还有一个__attribute__ noreturn，该属性通知编译器函数从不返回值，当遇到类似函数需要返回值而却不可能运行到返回值处就已经退出来的情况，该属性可以避免出现错误信息。C库函数中的abort()和exit()的声明格式就采用了这种格式，如下所示： 

extern void exit(int)   __attribute__((noreturn));

extern void abort(void) __attribute__((noreturn));

为了方便理解，大家可以参考如下的例子：

[cpp]

  view plain  copy

1. //name: noreturn.c  ；测试__attribute__((noreturn))  
2.     extern void myexit();  
3.     int test(int n)       
4.       
5.         if ( n > 0 )  
6.           
7.             myexit();  
8.             /* 程序不可能到达这里*/  
9.           
10.         else  
11.             return 0;  
12.       

编译后的输出结果如下：

$gcc –Wall –c noreturn.c

noreturn.c: In function `test':

noreturn.c:12: warning: control reaches end of non-void function

    很显然，这是因为一个被定义为有返回值的函数却没有返回值。加上__attribute__((noreturn))则可以解决此问题的出现。

    后面还有__attribute__const、-finstrument-functions、no_instrument_function等的属性描述，就不多转了，感兴趣的可以看原文。

变量属性(Variable Attribute)

    关键字__attribute__也可以对变量或结构体成员进行属性设置。这里给出几个常用的参数的解释，更多的参数可参考原文给出的连接。

    在使用__attribute__参数时，你也可以在参数的前后都加上“__”（两个下划线），例如，使用__aligned__而不是aligned，这样，你就可以在相应的头文件里使用它而不用关心头文件里是否有重名的宏定义。

aligned (alignment)

该属性规定变量或结构体成员的最小的对齐格式，以字节为单位。例如：

int x __attribute__ ((aligned (16))) = 0;

    编译器将以16字节（注意是字节byte不是位bit）对齐的方式分配一个变量。也可以对结构体成员变量设置该属性，例如，创建一个双字对齐的int对，可以这么写：

struct foo int x[2] __attribute__ ((aligned (8))); ;

    如上所述，你可以手动指定对齐的格式，同样，你也可以使用默认的对齐方式。如果aligned后面不紧跟一个指定的数字值，那么编译器将依据你的目标机器情况使用最大最有益的对齐方式。例如：

short array[3] __attribute__ ((aligned));

    选择针对目标机器最大的对齐方式，可以提高拷贝操作的效率。aligned属性使被设置的对象占用更多的空间，相反的，使用packed可以减小对象占用的空间。

    需要注意的是，attribute属性的效力与你的连接器也有关，如果你的连接器最大只支持16字节对齐，那么你此时定义32字节对齐也是无济于事的。

    使用该属性可以使得变量或者结构体成员使用最小的对齐方式，即对变量是一字节对齐，对域（field）是位对齐。

    下面的例子中，x成员变量使用了该属性，则其值将紧放置在a的后面： 

       struct test

         

            char a;

            int x[2] __attribute__ ((packed));

          ;

    其它可选的属性值还可以是：cleanup，common，nocommon，deprecated，mode，section，shared，tls_model，transparent_union，unused，vector_size，weak，dllimport，dlexport等。

类型属性（Type Attribute）

    关键字__attribute__也可以对结构体（struct）或共用体（union）进行属性设置。大致有六个参数值可以被设定，即：aligned, packed, transparent_union, unused, deprecated 和 may_alias。

    在使用__attribute__参数时，你也可以在参数的前后都加上“__”（两个下划线），例如，使用__aligned__而不是aligned，这样，你就可以在相应的头文件里使用它而不用关心头文件里是否有重名的宏定义。

aligned (alignment)

该属性设定一个指定大小的对齐格式（以字节为单位），例如： 

struct S short f[3]; __attribute__ ((aligned (8)));

typedef int more_aligned_int __attribute__ ((aligned (8)));

    该声明将强制编译器确保（尽它所能）变量类型为struct S或者more-aligned-int的变量在分配空间时采用8字节对齐方式。

    如上所述，你可以手动指定对齐的格式，同样，你也可以使用默认的对齐方式。如果aligned后面不紧跟一个指定的数字值，那么编译器将依据你的目标机器情况使用最大最有益的对齐方式。例如：

struct S short f[3]; __attribute__ ((aligned));

这里，如果sizeof（short）的大小为2（byte），那么，S的大小就为6。取一个2的次方值，使得该值大于等于6，则该值为8，所以编译器将设置S类型的对齐方式为8字节。

aligned属性使被设置的对象占用更多的空间，相反的，使用packed可以减小对象占用的空间。

需要注意的是，attribute属性的效力与你的连接器也有关，如果你的连接器最大只支持16字节对齐，那么你此时定义32字节对齐也是无济于事的。

    使用该属性对struct或者union类型进行定义，设定其类型的每一个变量的内存约束。当用在enum类型定义时，暗示了应该使用最小完整的类型（it indicates that the smallest integral type should be used）。

    下面的例子中，my-packed-struct类型的变量数组中的值将会紧紧的靠在一起，但内部的成员变量s不会被“pack”，如果希望内部的成员变量也被packed的话，my-unpacked-struct也需要使用packed进行相应的约束。 

struct my_unpacked_struct

      char c;

      int i;

;

         

struct my_packed_struct

     char c;

     int  i;

     struct my_unpacked_struct s;

__attribute__ ((__packed__));

变量属性与类型属性举例

下面的例子中使用__attribute__属性定义了一些结构体及其变量，并给出了输出结果和对结果的分析。

[cpp]

  view plain  copy

1. //  程序代码为：  
2.     struct p  
3.       
4.         int a;  
5.         char b;  
6.         char c;  
7.     __attribute__((aligned(4))) pp;  
8.       
9.     struct q  
10.       
11.         int a;  
12.         char b;  
13.         struct n qn;  
14.         char c;  
15.     __attribute__((aligned(8))) qq;  
16.       
17.     int main()  
18.       
19.         printf("sizeof(int)=%d,sizeof(short)=%d.sizeof(char)=%d\\n",sizeof(int),sizeof(short),sizeof(char));  
20.           
21.         printf("pp=%d,qq=%d \\n", sizeof(pp),sizeof(qq));  
22.           
23.         return 0;  
24.       
25.       
26.     //输出结果：  
27.   
28.     sizeof(int)=4,sizeof(short)=2.sizeof(char)=1  
29.     pp=8,qq=24  

分析：

 

sizeof(pp):

sizeof(a)+ sizeof(b)+ sizeof(c)=4+1+1=6<23=8= sizeof(pp)

sizeof(qq):

sizeof(a)+ sizeof(b)=4+1=5

sizeof(qn)=8;即qn是采用8字节对齐的，所以要在a，b后面添3个空余字节，然后才能存储qn，

4+1+（3）+8+1=17

    因为qq采用的对齐是8字节对齐，所以qq的大小必定是8的整数倍，即qq的大小是一个比17大又是8的倍数的一个最小值，由此得到

17<24+8=24= sizeof(qq)