GCC的C语言扩展笔记（二）-- linux gcc的属性解析

时间 2019-11-05

标签 gcc c语言扩展笔记 linux 属性解析栏目 GCC 繁體版

原文原文链接

原本打算接着摘抄《GCC参考手册》关于属性扩展(__attribute__)的说明，不过因为翻译太差，许多地方看得莫名其妙，就到网上找了下，下面是一篇关于属性的文章，讲得不错，转帖于下。html

不敢掠美，附上原文地址：http://blog.eastmoney.com/stcu/blog_150699657.htmllinux

linux gcc的属性解析 数组

GNU C的一大特点（却不被初学者所知）就是__attribute__机制。__attribute__能够设置函数属性（Function Attribute）、变量属性（Variable Attribute）和类型属性（Type Attribute）。函数

__attribute__书写特征是：__attribute__先后都有两个下划线，并切后面会紧跟一对原括弧，括弧里面是相应的__attribute__参数。测试

__attribute__语法格式为：优化

__attribute__ ((attribute-list))ui

其位置约束为：this

放于声明的尾部“；”以前。spa

函数属性（Function Attribute）

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

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，代码以下：
1：

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

3：

4：void test()

5：{

6：  myprint("i=%d\",6);

7：  myprint("i=%s\",6);

8：  myprint("i=%s\","abc");

9：  myprint("%s,%d,%d\",1,2);

10：} 
运行$gcc –Wall –c attribute.c attribute后，输出结果为：

attribute.c: In function `test':

attribute.c:7: warning: format argument is not a pointer (arg 2)

attribute.c:9: warning: format argument is not a pointer (arg 2)

attribute.c:9: warning: too few arguments for format

若是在attribute.c中的函数声明去掉__attribute__((format(printf,1,2)))，再从新编译，既运行$gcc –Wall –c attribute.c attribute后，则并不会输出任何警告信息。

注意，默认状况下，编译器是能识别相似printf的“标准”库函数。

__attribute__ noreturn

该属性通知编译器函数从不返回值，当遇到相似函数须要返回值而却不可能运行到返回值处就已经退出来的状况，该属性能够避免出现错误信息。C库函数中的abort（）和exit（）的声明格式就采用了这种格式，以下所示：

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

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

为了方便理解，你们能够参考以下的例子：

//name: noreturn.c  ；测试__attribute__((noreturn))

extern void myexit();

int test(int n)
{
     if ( n > 0 )
     {
         myexit();
         /* 程序不可能到达这里*/
     }
     else
          return 0;
}

编译显示的输出信息为：

$ gcc –Wall –c noreturn.c

noreturn.c: In function `test':

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

警告信息也很好理解，由于你定义了一个有返回值的函数test却有可能没有返回值，程序固然不知道怎么办了！

加上__attribute__((noreturn))则能够很好的处理相似这种问题。把

extern void myexit();

修改成：

extern void myexit() __attribute__((noreturn));

以后，编译不会再出现警告信息。

__attribute__ const

该属性只能用于带有数值类型参数的函数上。当重复调用带有数值参数的函数时，因为返回值是相同的，因此此时编译器能够进行优化处理，除第一次须要运算外，其它只须要返回第一次的结果就能够了，进而能够提升效率。该属性主要适用于没有静态状态（static state）和反作用的一些函数，而且返回值仅仅依赖输入的参数。

为了说明问题，下面举个很是“糟糕”的例子，该例子将重复调用一个带有相同参数值的函数，具体以下：
extern int square(int n) __attribute__((const));
...
    for (i = 0; i < 100; i++ )
    {
         total += square(5) + i;
    }
经过添加__attribute__((const))声明，编译器只调用了函数一次，之后只是直接获得了相同的一个返回值。

事实上，const参数不能用在带有指针类型参数的函数中，由于该属性不但影响函数的参数值，一样也影响到了参数指向的数据，它可能会对代码自己产生严重甚至是不可恢复的严重后果。

而且，带有该属性的函数不能有任何反作用或者是访问全局或静态变量，因此，相似getchar（）或time（）的函数是不适合使用该属性的。

-finstrument-functions

该参数可使程序在编译时，在函数的入口和出口处生成instrumentation调用。刚好在函数入口以后并刚好在函数出口以前，将使用当前函数的地址和调用地址来调用下面的 profiling 函数。（在一些平台上，__builtin_return_address不能在超过当前函数范围以外正常工做，因此调用地址信息可能对profiling函数是无效的。）

void __cyg_profile_func_enter(void *this_fn, void *call_site);

void __cyg_profile_func_exit(void *this_fn, void *call_site);

其中，第一个参数this_fn是当前函数的起始地址，可在符号表中找到；第二个参数call_site是指调用处地址。

instrumentation 也可用于在其它函数中展开的内联函数。从概念上来讲，profiling调用将指出在哪里进入和退出内联函数。这就意味着这种函数必须具备可寻址形式。若是函数包含内联，而全部使用到该函数的程序都要把该内联展开，这会额外地增长代码长度。若是要在C 代码中使用extern inline声明，必须提供这种函数的可寻址形式。

可对函数指定no_instrument_function属性，在这种状况下不会进行instrumentation操做。例如，能够在如下状况下使用no_instrument_function属性：上面列出的profiling函数、高优先级的中断例程以及任何不能保证profiling正常调用的函数。

no_instrument_function

若是使用了-finstrument-functions ，将在绝大多数用户编译的函数的入口和出口点调用profiling函数。使用该属性，将不进行instrument操做。

constructor/destructor

若函数被设定为constructor属性，则该函数会在main（）函数执行以前被自动的执行。相似的，若函数被设定为destructor属性，则该函数会在main（）函数执行以后或者exit（）被调用后被自动的执行。拥有此类属性的函数常常隐式的用在程序的初始化数据方面。

这两个属性尚未在面向对象C中实现。

同时使用多个属性

能够在同一个函数声明里使用多个__attribute__，而且实际应用中这种状况是十分常见的。使用方式上，你能够选择两个单独的__attribute__，或者把它们写在一块儿，能够参考下面的例子：

/* 把相似printf的消息传递给stderr 并退出 */

extern void die(const char *format, ...)

__attribute__((noreturn))

__attribute__((format(printf, 1, 2)));

或者写成

extern void die(const char *format, ...)

__attribute__((noreturn, format(printf, 1, 2)));

若是带有该属性的自定义函数追加到库的头文件里，那么因此调用该函数的程序都要作相应的检查。

和非GNU编译器的兼容性

庆幸的是，__attribute__设计的很是巧妙，很容易做到和其它编译器保持兼容，也就是说，若是工做在其它的非GNU编译器上，能够很容易的忽略该属性。即便__attribute__使用了多个参数，也能够很容易的使用一对圆括弧进行处理，例如：

/* 若是使用的是非GNU C, 那么就忽略__attribute__ */

#ifndef __GNUC__

# define __attribute__(x) /*NOTHING*/

#endif

须要说明的是，__attribute__适用于函数的声明而不是函数的定义。因此，当须要使用该属性的函数时，必须在同一个文件里进行声明，例如：

/* 函数声明 */

void die(const char *format, ...) __attribute__((noreturn))

__attribute__((format(printf,1,2)));

void die(const char *format, ...)

{

/* 函数定义 */

}

更多的属性含义参考：

http://gcc.gnu.org/onlinedocs/gcc-4.0.0/gcc/Function-Attributes.html

变量属性（Variable Attributes）

关键字__attribute__也能够对变量（variable）或结构体成员（structure field）进行属性设置。这里给出几个经常使用的参数的解释，更多的参数可参考本文给出的链接。

在使用__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字节对齐也是无济于事的。

packed

使用该属性可使得变量或者结构体成员使用最小的对齐方式，即对变量是一字节对齐，对域（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等，详细信息可参考：

http://gcc.gnu.org/onlinedocs/gcc-4.0.0/gcc/Variable-Attributes.html#Variable-Attributes

类型属性（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字节对齐也是无济于事的。

packed

使用该属性对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__));

其它属性的含义见：

http://gcc.gnu.org/onlinedocs/gcc-4.0.0/gcc/Type-Attributes.html#Type-Attributes

变量属性与类型属性举例

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

程序代码为：
struct p
{
    int a;
    char b;
    char c;
}__attribute__((aligned(4))) pp;

 
struct q
{
    int a;
    char b;
    struct p qn;
    char c;
}__attribute__((aligned(8))) qq;

int main()
{       
    printf("sizeof(int)=%d,sizeof(short)=%d.sizeof(char)=%d\n",
        sizeof(int),sizeof(short),sizeof(char));

    printf("pp=%d,qq=%d \n", sizeof(pp),sizeof(qq));

    return 0;
}
输出结果：

sizeof(int)=4,sizeof(short)=2.sizeof(char)=1

pp=8,qq=24

分析：

sizeof(pp):

sizeof(a)+ sizeof(b)+ sizeof(c)=4+1+1=6<2 ³ =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<2⁴+8=24= sizeof(qq)

更详细的介绍见：http://gcc.gnu.org

下面是一些便捷的链接：GCC 4.0 Function Attributes；GCC 4.0 Variable Attributes ；GCC 4.0 Type Attributes ；GCC 3.2 Function Attributes ；GCC 3.2 Variable Attributes ；GCC 3.2 Type Attributes ；GCC 3.1 Function Attributes ；GCC 3.1 Variable Attributes

Reference：

1．有关__attribute__的相对简单的介绍：http://www.unixwiz.net/techtips/gnu-c-attributes.html 2．__attribute__详细介绍：http://gcc.gnu.org