本文摘自《奔跑吧 Linux 内核(第二版)》2.2 Linux 内核中常用的 C 语言技巧
读到这本书的这一小节时,感觉其中不少技巧在项目中有遇到过,有必要做个笔记,方便以后查阅。
文章目录
- 前言
- 1.语句表达式
- 2.变长数组
- 3. case 的范围
- 4. 标号元素
- 5. 可变参数宏
- 6.函数属性
- 7.变量属性和类型属性
- 8. 内建函数
- 9. asmlinkage
- 10. UL
- 延伸
前言
GCC 的 C 编译器除了支持 ANSI C 标准之外,还对 C 语言进行了很多的扩充。这些扩充为代码优化、目标代码布局以及安全检查等提供了很强的支持,因此支持 GNU 扩展的 C 语言称为 GNU C 语言。Linux 内核采用 GCC 编译器,所以 Linux 内核的代码自然使用了 GCC 的很多新的扩充特性。本节将介绍 GCC C 语言一些扩充的新特性,希望读者在学习 Linux 内核时特别留意。
1.语句表达式
在 GNU C 语言中,括号里的复合语句可以看作表达式,称为语句表达式。在语句表达
式里,可以使用循环、跳转和局部变量等。这个特性通常用在宏定义中,可以让宏定义变得
更安全,如比较两个值的大小。
#define max (a, b) ((a)>(b)?(a):(b))
上述代码会导致安全问题,a 和 b 有可能会计算两次,比如,向 a 传入 i++,向 b 传入 j++ 。在 GNU C 语言中,如果知道 a 和 b 的类型,可以像下面这样写这个宏。
#define maxint(a,b) \
({ int _a = (a), _b = (b); _a > _b? _a:_b; })
如果不知道 a 和 b 的类型,还可以使用 typeof 宏。
<include/linux/kernel.h>
#define min(x, y) ({ \
typeof(x) _min1 = (x); \
typeof(y) _min2 = (y); \
(void) (&_min1 == &_min2); \/*这一句没看懂有什么用,经测试发现删除后的确没有影响*/
_mini < _min2 ? min1: min2; })
typeof 也是 GNU C 语言的一种扩充用法,可以用来构造新的类型,通常和语句表达式一起使用。
下面是一些例子。
typeof (*x) y;
typeof (*x) z[4]):
typeof (typeof (char *) [4]) m;
第一句声明 y 是 x 指针指向的类型。第二包声明 z 是数组,其中数组的类型是 x 指针指向的类型。第三句声明 m 是指针数组,这和 char *m[4] 声明的效果是一样的。( typeof 类似 C++ stl 中萃取器的作用,但 stl 中实现萃取器可不是很简单)
2.变长数组
GNU C 语言允许使用变长数组,这在定义数据结构时非常有用。
<mm/percpu.c>
struct pcpu_chunk {
struct list_head list;
unsigned long populated[]; /* 变长数组*/
};
以上数据结构中的最后一个元素被定义为变长数组,这种数组不占用结构体空间。这样我们就可以根据对象大小动态地分配结构体的大小。
struct line {
int length;
char contents[0];
};
struct line *thisline = malloc(sizeof(struct line) + this_length);
thisline->length = this_length;
如上所示,line 数据结构中定义了变量 length 和变长数组 contents[0],line 数据结构的大小只包含 int 类型的大小,不包含 contents 的大小,也就是 sizeof(struct line) = sizeof(int)。创建结构体对象时,可根据实际需要指定这个变长数组的长度,并分配相应的空间。上述示例代码分配了 this_length 字节的内存,并且可以通过 contents[index] 来访问第 index 个地址的数据。
3. case 的范围
GNU C 语言支持指定 case 的范围为标签,例如:
case low ... high:
case 'A' ... 'Z':
这里指定 case 的范围为 low ~ high、‘A’ ~ ‘z’。下面是Linux 内核中的示例代码。
<arch/x86/platform/uv/tlb_uv.c>
static int local_atoi(const char *name) {
int val = 0;
for (;; name++) {
switch (*name) {
case '0' ... '9';
val = 10*val+ (*name-'O');
break:
default:
return val;
}
}
}
另外,还可以用整型数表示范围,但是这里需要注意 “…” 的两边有空格,否则编译会出错。
<drivers/usb/gadget/udc/at91_udc.c>
static int at91sam9261 udc init (struct at91 udc *ud)
{
for (i = 0; i ≤ NUM_ENDPOINTS; i++) {
ep = &udc->ep[i];
switch (i) {
case 0:
ep->maxpacket = 8;
break;
case 1 ... 3:
ep->maxpacket = 64;
break;
case 4 ... 5:
ep->maxpacket = 256;
break;
}
}
}
4. 标号元素
标准 C 语言要求数组或结构体在初始化时必须以固定顺序出现。但 GNU C 语言可以通过指定索引或结构体成员名来初始化,不必按照原来的固定顺序进行初始化。
结构体成员的初始化在 Linux 内核中经常使用,如在设备驱动中初始化 file_operations 数据结构。下面是 Linux 内核中的一个例子。
<drivers/char/mem.c>
static const struct file_operations zero_fops = {
.llseek = zero_lseek,
.read = new_sync_read,
.write = write_zero,
.read_iter = read_iter_zero,
.aio_write = aio_write_zero,
.mmap = mmap_zero,
};
在上述代码中,zero_ fops 的成员 llseek 被初始化为 zero_Iseek 函数,read 成员被初始化为 new_sync_read 函数。以此类推。 当 file_operations 数据结构的定义发生变化时,这种初始化方法依然能保证已知元素的正确性,未初始化的成员的值为0 或 NULL。
5. 可变参数宏
在 GNU C 语言中,宏可以接受可变数目的参数,这主要运用在输出函数中。
<include/linux/printk.h>
#define pr_debug (fmt, ...) \
aynamic_pr_debug(fmt, ##__VA_ARGS__)
“…” 代表可以变化的参数表,“VA_ARGS” 是编译器保留字段,在进行预处理时把参数传递给宏。当调用宏时,实际参数就被传递给 dynamic_pr_ debug 函数。
6.函数属性
GNU C 语言允许声明函数属性(function attribute)、变量属性 (variable attribute)和类型属性 (type attribute),以便编译器进行特定方面的优化和更仔细的代码检查。以上属性的语法格式如下。
__attribute__ ((attribute-list))
GNU C 语言里定义的函数属性有很多,如 noreturn、format 以及 const 等。此外,还可以定义一些和处理器架构相关的函数属性,如 ARM 架构中可以定义 interrupt、isr 等属性,有兴趣的读者可以阅读 GCC 的相关文档。
下面是 Linux 内核中使用 format 函数属性的一个例子。
<drivers/staging/lustru/include/linux/libcfs/>
int libcfs_debug_msg(struct libcfs_debug_msg_data *msgdata,
const char *format1, ...)
__attribute__ ((format (printf, 2, 3)));
libcfs_debug_msg() 函数里声明了 format 函数属性,用于告诉编译器按照 printf 的参数表中的格式规则对函数参数进行检查。数字 2 表示第 2 个参数为格式化字符串,数字 3 表示参数 “…” 里的第 1 个参数在函数参数总数中排第几。
noretum 函数属性用于通知编译器函数从不返回值,这让编译器屏蔽了不必要的警告信息。比如 die 函数,该函数没有返回值。
void __attribute__ ((noreturn)) die(void);
const 函数属性让编译器只调用函数一次,以后再调用时只需要返回第一次的结果即可,从而提高效率。
static inline u32 __attribute_const__ read_cpuid_cachetype(void)
{
return read_cpuid(CTR_ELO);
}
Linux 还有一些其他的函数属性,它们定义在 compiler-gcc.h 文件中。
7.变量属性和类型属性
变量属性可以对变量或结构体成员进行属性设置。对于类型属性,常见的有 alignment、packed 和sections 等。
alignment 类型属性规定变量或结构体成员的最小对齐格式,以字节为单位。
struct qib_user_info {
__u32 spu_userversion;
__u64 spu_base_info;
} __aligned(8);
在上面这个例子中,编译器以 8 字节对齐的方式来分配数据结构 qib_user_info。packed 类型属性可以使变量或结构体成员使用最小的对齐方式,对变量以字节对齐,对域以位对齐。
struct test {
char a;
int x[2] __attribute__ ((packed));
};
x 成员使用了 packed 类型属性,并且存储在变量 a 的后面,所以结构体 test 一共占用9字节。
8. 内建函数
GNU C 语言提供了一系列内建函数以进行优化,这些内建函数以 “builtin” 作为前缀。下面介绍 Linux 内核中常用的一些内建函数。
- __builtin_constant_p(x):判断 x 是否在编译时就可以被确定为常量。如果 x 为常量,那么返回1;否则,返回0。
#define swab16 (x) \
(__builtin_constant_p((__u16) (x)) ? \
___constant_swab16(x) : \
__fswab16(x))
测试该代码在我的机器上可以 include 这两个头文件(我是用搜索工具在 /usr/include/ 目录下搜索到的,例如用 ag 可以执行以下命令进行搜索: ag __u16 /usr/include/, 如果知道头文件名字,搜索该文件具体路径可以用 find 命令: find /usr/include/ -name swab.h):
#include <asm-generic/int-ll64.h> // for __u16
#include <linux/swab.h> // for __fswab16
该函数是用于交换 16 位数高低字节,测试结果如下
- _builtin expect(exp, c):这里的意思是 exp == c 的概率很大,用来引导 GCC 进行条件分支预测。开发人员知道最可能执行哪个分支,并将最有可能执行的分支告诉编译器,让编译器优化指令序列,使指令尽可能顺序执行,从而提高 CPU 预取指令的正确率。
#define LIKELY(x) __builtin_expect (! ! (x) , 1) // x 很可能为真
#define UNLIKELY(X) __builtin_expect (! ! (x) , 0) // 1/x 很可能为假
- __builtin_pretetch(const void *addr, int rw, int locality):主动进行数据预取,在使用 addr 的值之前就把该值加载到 cache 中,降低读取延时,从而提高性能。该函数可以接受 3 个参数:第1个参数 addr 表示要预取的数据的地址;第2个参数 rw 表示读写属性,1 表示可写,0 表示只读;第3个参数 locality 表示数据在缓存中的时间局部性,其中 0 表示读取完 addr 的值之后不用保留在缓存中,而1~3 表示时间局部性逐渐增强。参考下面的 prefetch() 和 prefetchw() 函数的实现。
<include/linux/prefetch.h>
#define prefetch(x) __builtin_prefetch(x)
#define prefetchw(x) __builtin_prefetch(x,1)
下面是使用 prefetch() 函数进行优化的一个例子。
<mm/page_alloc.c>
void __init __free pages_bootmem(struct page *page, unsigned int order)
{
unsigned int nr_pages = 1 << order;
struct page *p = page;
unsigned int loop;
prefetchw(p);
for (loop = 0; loop < (nr_pages - 1); loop++, p++) {
prefetchw(p + 1);
__ClearPageReserved(p);
set_page_count(p, 0);
}
...
}
在处理 page 数据结构之前,可通过 prefetchw() 预取到缓存中,从而提升性能。
9. asmlinkage
在标准 C 语言中,函数的形参在实际传入参数时会涉及参数存放问题。对于x86 架构,函数参数和局部变量被一起分配到函数的栈 (stack)中。
<arch/x86/include/asm/linkage.h>
#define asmlinkage CPP_ASMLINKAGE __attribute__ ((regparm(0)))
__attribute__(resparm(0))用于告诉编泽器不需要通过任何寄存器求传递参数,只通过栈来传递。
对于 ARM64 来说,函数参数的传递有一套过程调用标准 (Procedure Call Standard, PCS)。ARM64 中的 x0~x7 寄存器存放传入的参数,当参数超过 8 个时,多余的参数被存放在函数的栈中。所以,ARM64 平台没有定义 asmlinkage。
<include/linux/linkage.h>
#define asmlinkage CPP_ASMLINKAGE
#define asmlinkage CPP_ASMLINKAGE
10. UL
在 Linux 内核代码中,我们经常会看到一些数字的定义中使用了 UL 后缀。数字常量会被隐式定义为 int 类型,将两个 int 类型数据相加的结果可能会发生溢出,因此使用 UL 强制把 int 类型的数据转换为 unsigned long 类型,这是为了保证运算过程不会因为 int 的位数不同而导致溢出。
- 1:表示有符号整型数字 1
- 1UL:表示无符号长整型数字 1
延伸
使用 gnu 扩展的程序编译时不能指定普通标准库,例如 gcc -std=c99 ,而需要指定包含 gnu 扩展的标准库,例如 gcc -std=gnu99。