C语言的attribute机制

桃扇骨 2023-05-29 14:26 8阅读 0赞

## 1. \_\_attribute\_\_作用及使用方法 ##

在Linux内核中经常会遇到这么一类的定义：就是在函数、变量、或者数据类型里面添加\_\_attribute\_\_，对于内核的初学者来说，往往不懂这些定义是什么意思，遇到此类的定义往往需要查找半天，导致学习进度延误。

下面就从\_\_attribute\_\_的作用，约束方法以及使用方法和使用实例上来给大家讲解。

### 1.1 \_\_attribute\_\_的作用： ###

设置函数、变量以及数据类型的属性。

之前大家可能会遇到过：在C语言中对于函数或者变量重复定义的问题，attribute机制可以很好的解决这类的冲突问题；C语言中使用main函数作为入口函数，通常大家理解的在main函数之前，或者main函数结束之后可能不会再运行什么函数了，引入attribute机制就可以解决这类的问题；对于函数中可能直接终止的执行进行不恰当的调用会引起程序无故终止，attribute机制也可以解决这类的问题。

### 1.2 \_\_attribute\_\_使用方法： ###

在函数、数据、数据类型的定义之后，定义的顿号之前。
    	语法格式为：
    			__attribute__((attr_list))
    			请注意在__attribute__后一定是两组小括号，后面跟着我们要设置属性的关键字。
    			attribute英文字符的下划线是两个。

比如我们可以设置：  
void func(void ) \_\_attribute\_\_((attr\_list));  
int num \_\_attribute\_\_((attr\_list))；  
struct test \{ int number; \} \_\_attribute\_\_((attr\_list))

本文章将会根据\_\_attribute\_\_针对函数属性、变量属性数据类型属性一一用实例讲解。根据gnu的attribute介绍一章，链接如下：[gnu Function attribute][]  
[gnu Variable attribute][]

## 2 函数属性设置 ##

gnu对于函数属性主要设置的关键字如下：

alias:      设置函数别名。
    		aligned:    设置函数对齐方式。
    		always_inline/gnu_inline: 
    					函数是否是内联函数。
    		constructor/destructor:
    					主函数执行之前、之后执行的函数。
    		format:
    					指定变参函数的格式输入字符串所在函数位置以及对应格式输出的位置。
    		noreturn:
    					指定这个函数没有返回值。
    					请注意，这里的没有返回值，并不是返回值是void。而是像_exit/exit/abord那样
    					执行完函数之后进程就结束的函数。
    		weak：指定函数属性为弱属性，而不是全局属性，一旦全局函数名称和指定的函数名称
    			 命名有冲突，使用全局函数名称。

### 2.1 函数的constructor/destructor属性 ###

一般认为，在C语言中，main函数是函数的执行起点和终点，在main函数之前和之后都不会执行什么额外的步骤。但是gnu引入的constructor和destructor的attribute属性关键字，可以让C函数在执行之前，和执行之后分别执行特定的函数。

编译以下实例，然后执行。

//main.c
    #include <stdio.h>
    #include <unistd.h>
    #include <stdlib.h>
    static __attribute__((constructor))
    before(void)
    { 
            printf("before main\n");
    }
    
    static __attribute__((destructor))
    after(void)
    { 
            printf("after main\n");
    }
    
    int main(void)
    { 
            printf("in main\n");
    
            return EXIT_SUCCESS;
    }

我们可以看到以下执行结果：

before main
    in main
    after main

在代码中的main函数里面，我们没有使用before和after两个函数，但是在实际执行中before函数在main函数之前执行，after函数在main函数之后执行。这和before和after函数分别使用了attribute属性有关。

### 2.2 函数的noreturn属性 ###

函数的noreturn属性可以告诉编译器，这个函数是没有返回值的，甚至默认不返回值也是不可以的。

include <stdio.h>
    #include <stdlib.h>
    #include <unistd.h>
    
    
    void noret(void)
    __attribute__((noreturn));
    
    void noret(void)
    { 
    
    }
    
    int main(void)
    { 
            noret();
            return 0;
    }

如以上代码，我们可以看到noret函数在定义的时候使用了noreturn属性，函数里面什么也没有做，相当于是个空函数，但是空函数使用了默认返回值void。如果我们编译的话，会出现以下警告：

main.c: In function ‘noret’:
    main.c:12:1: warning: ‘noreturn’ function does return [enabled by default]
     }
     ^

上述警告告诉我们，这个函数设置的noreturn属性，但是的确返回有返回值。空函数默认返回的void空类型空数据。所以说有返回值。  
如果把noret函数里面增加noreturn类型的库函数，或者把noreturn属性去掉，就不会再出现错误了，修改如下：

void noret(void)
    {
            _exit(0);
    }

### 2.3 函数weak属性 ###

函数的weak属性比较有意思，它的作用在有名称冲突的函数中，如果我们在使用中有两个函数名称是一样的，我们编译器会报告给我们名称冲突的错误。如果其中一个函数使用了weak属性，我们的编译器就会把不含有weak的函数名称编译进入我们的文件里面。  
实例如下：

//test.c
    #include "test.h" 
    #include <stdio.h>
    int weak_func(void)
    { 
            printf("this is in test weak function\n");
            return 0;  
    }

//test.h
    #ifndef __test_h_ 
    
    #define __test_h_
    
    int weak_func(void);
            
    #endif

//main.c
    #include <stdio.h>
    #include "test.h"
    
    
    //extern int weak_func(void) __attribute__((weak));
    int weak_func(void)
    { 
            printf("this is in main weak function\n");
            return 0;
    }
    
    int main(void)
    { 
            weak_func();
            return 0;
    }

上面的函数编译是编译不通过的，编译结果如下：

gcc main.c test.h test.c
    /tmp/cciED8ZA.o: In function `weak_func':
    test.c:(.text+0x0): multiple definition of `weak_func'
    /tmp/ccZwUE37.o:main.c:(.text+0x0): first defined here
    collect2: error: ld returned 1 exit status

显示名称冲突，如果把main.c里面的extern int weak\_func(void) \_\_attribute\_\_((weak));去掉注释，则可以编译过，使用的是test.c文件里面的weak\_func。

### 2.4 函数format属性 ###

format属性是在使用变长参数指定格式化字符串的时候使用的比较多。可以让编辑器检查格式化的字符串使用的是否正确。  
format使用格式如下：

format (archetype, string-index, first-to-check)
    archetype:
    			指定参照哪个函数的格式化字符串：printf、scanf、strftime....
    string-index:
    			指定格式化字符串在函数的第几个参数。
    			比如：“%d  %s\n”这些参数在函数的第几个位置。
    first-to-check:
    			指定格式化输入的字符串在函数参数中开始的位置。

如下代码：

#include <stdio.h>
    
    
    void myprintf(const char * format,...)
    __attribute__((format(printf,1,2)));
    void myprintf(const char * format,...)
    {
            printf("%s", format);
    }
    
    int main(void)
    {
            myprintf("abc%d\n", 1);
            myprintf("abc%s\n", "abc");
            myprintf("abc%s\n", 1);
            myprintf("%s %d\n", 2, 1);
            return 0;
    }

myprintf定义时候指定参照printf的格式化字符串，1代表指定检查格式化字符串的位置，2指定参照字符串开始检查的位置。  
我们

[gnu Function attribute]: https://gcc.gnu.org/onlinedocs/gcc-4.5.0/gcc/Function-Attributes.html#Function-Attributes
[gnu Variable attribute]: https://gcc.gnu.org/onlinedocs/gcc-4.5.0/gcc/Variable-Attributes.html