Linux kernel中常见的宏整理【转】
转自：https://www.cnblogs.com/linhaostudy/p/12052673.html
阅读目录
- 0x00 宏的基本知识
- Linux内核中do{...}while(0)意义：
- 0x01 常见宏整理
- __CONCAT宏
- BUG_ON(condition)
- BUILD_BUG_ON宏
- typecheck宏
- min宏
- __is_constexpr宏
- max宏
- roundup宏
- clamp 宏
- abs宏
- swap 宏
- container_of宏
- likely和unlikely宏
- ALIGN对齐宏
- __get_unaligned_le(ptr)宏
- __put_unaligned_le宏
- ACCESS_ONCE 宏
- ACCESS_OK宏
- mdelay宏
- 系统调用宏
- barrier()宏
- force_o_largefile宏
- 错误码相关的宏
- 额外有意思的宏
正文
回到顶部https://gaomf.cn/2017/10/06/C_Macro/以下是整理的一些linux kernel中的常见宏，由于不同体系架构，或者不同模块的宏定义不同，只挑选了其中容易看懂的宏作为记录，实现的功能大体一样。
回到顶部https://stackoverflow.com/questions/49481217/linux-kernels-is-constexpr-macro
描述：此函数为GNU扩展，用来判断两个类型是否相同，如果type_a与 type_b相同的话，就会返回1，否则的话，返回0。
int __builtin_choose_expr(exp, e1, e2);
https://blog.csdn.net/ganggexiongqi/article/details/24603363
ACCESS_OK宏
CVE-2017-5123（waitid系统调用）,检查指针是不是属于用户空间的，x86架构下ACCESS_OK宏的实现：
/**
* access_ok: - Checks if a user space pointer is valid
* @addr: User space pointer to start of block to check
* @size: Size of block to check
*
* Context: User context only. This function may sleep if pagefaults are
* enabled.
*
* Checks if a pointer to a block of memory in user space is valid.
*
* Returns true (nonzero) if the memory block may be valid, false (zero)
* if it is definitely invalid.
*
* Note that, depending on architecture, this function probably just
* checks that the pointer is in the user space range - after calling
* this function, memory access functions may still return -EFAULT.
*/
#define access_ok(addr, size) \
({ \
WARN_ON_IN_IRQ(); \
likely(!__range_not_ok(addr, size, user_addr_max())); \
})
/*__range_not_ok返回0才能验证通过
#define __range_not_ok(addr, size, limit) \
({ \
__chk_user_ptr(addr); \
__chk_range_not_ok((unsigned long __force)(addr), size, limit); \
})
/*
* Test whether a block of memory is a valid user space address.
* Returns 0 if the range is valid, nonzero otherwise.
*/
static inline bool __chk_range_not_ok(unsigned long addr, unsigned long size, unsigned long limit)
{
/*
* If we have used "sizeof()" for the size,
* we know it won't overflow the limit (but
* it might overflow the 'addr', so it's
* important to subtract the size from the
* limit, not add it to the address).
*/
if (__builtin_constant_p(size))
return unlikely(addr > limit - size);
/*__builtin_constant_p判断编译时是否为常数，如果是则返回1 */
/* Arbitrary sizes? Be careful about overflow */
addr += size;
if (unlikely(addr < size))
return true;
return unlikely(addr > limit);
}
mdelay宏
忙等待函数，在延迟过程中无法运行其他任务，会占用CPU时间，延迟时间是准确的。
msleep是休眠函数，它不涉及忙等待．用msleep（200）的时候实际上延迟的时间，大部分时候是要多于200ms，是个不定的时间值。
#define MAX_UDELAY_MS 5
#define mdelay(n) (\ /*延迟毫秒级*/
(__builtin_constant_p(n) && (n)<=MAX_UDELAY_MS) ? udelay((n)*1000) : \
({unsigned long __ms=(n); while (__ms--) udelay(1000);}))
static void udelay(int loops) /*延迟微秒级 */
{
while (loops--)
io_delay(); /* Approximately 1 us */
}
static inline void io_delay(void)
{
const u16 DELAY_PORT = 0x80;
asm volatile("outb %%al,%0" : : "dN" (DELAY_PORT));
}
/*对 I/O 端口 0x80 写入任何的字节都将得到 1 us 的延时*/
系统调用宏
linux 内核中最常见的宏使用之一，系统调用：
#define SYSCALL_DEFINE1(name, ...) SYSCALL_DEFINEx(1, _##name, __VA_ARGS__)
#define SYSCALL_DEFINE2(name, ...) SYSCALL_DEFINEx(2, _##name, __VA_ARGS__)
#define SYSCALL_DEFINE3(name, ...) SYSCALL_DEFINEx(3, _##name, __VA_ARGS__)
#define SYSCALL_DEFINE4(name, ...) SYSCALL_DEFINEx(4, _##name, __VA_ARGS__)
#define SYSCALL_DEFINE5(name, ...) SYSCALL_DEFINEx(5, _##name, __VA_ARGS__)
#define SYSCALL_DEFINE6(name, ...) SYSCALL_DEFINEx(6, _##name, __VA_ARGS__)
/*…：省略号代表可变的部分，用__VA_AEGS__ 代表省略的变长部分*/
#define SYSCALL_DEFINE_MAXARGS 6 /*系统调用最多可以带6个参数*/
以open系统调用为例：
SYSCALL_DEFINE
后面跟系统调用所带的参数个数n，第一个参数为系统调用的名字，然后接2*n个参数，每一对指明系统调用的参数类型及名字。
SYSCALL_DEFINE3(open, const char __user *, filename, int, flags, umode_t, mode)
{
if (force_o_largefile())
flags |= O_LARGEFILE;
return do_sys_open(AT_FDCWD, filename, flags, mode);
}
SYSCALL_DEFINE3(open, const char __user *, filename, int, flags, umode_t, mode)
展开之后是：
SYSCALL_DEFINEx(3, _open, __VA_ARGS__)
再次展开为：
__SYSCALL_DEFINEx(3, _open, __VA_ARGS__)
#define __SYSCALL_DEFINEx(x, name, ...) \
asmlinkage long sys##name(__MAP(x,__SC_DECL,__VA_ARGS__)) \
最后展开为：
asmlinkage long sys_open(__MAP(3,__SC_DECL,__VA_ARGS__))
#define __MAP0(m,...)
#define __MAP1(m,t,a) m(t,a)
#define __MAP2(m,t,a,...) m(t,a), __MAP1(m,__VA_ARGS__)
#define __MAP3(m,t,a,...) m(t,a), __MAP2(m,__VA_ARGS__)
#define __MAP4(m,t,a,...) m(t,a), __MAP3(m,__VA_ARGS__)
#define __MAP5(m,t,a,...) m(t,a), __MAP4(m,__VA_ARGS__)
#define __MAP6(m,t,a,...) m(t,a), __MAP5(m,__VA_ARGS__)
#define __MAP(n,...) __MAP##n(__VA_ARGS__)
#define __SC_DECL(t, a) t a
__MAP(3,__SC_DECL,__VA_ARGS__)
-->__MAP3(__SC_DECL,const char __user *, filename, int, flags, umode_t, mode)
-->__SC_DECL(const char __user *, filename), __MAP2(__SC_DECL,__VA_ARGS__)
-->const char __user * filename,__SC_DECL(int, flags),__MAP1(__SC_DECL,__VA_ARGS__)
-->const char __user * filename, int flags, __SC_DECL(umode_t, mode)
-->const char __user * filename, int flags, umode_t mode
最后调用asmlinkage long sys_open(const char __user *filename,int flags, umode_t mode);
为什么要将系统调用定义成宏？CVE-2009-0029，CVE-2010-3301，Linux 2.6.28及以前版本的内核中，将系统调用中32位参数传入64位的寄存器时无法作符号扩展，可能导致系统崩溃或提权漏洞。
内核开发者通过将系统调用的所有输入参数都先转化成long类型（64位），再强制转化到相应的类型来规避这个漏洞。
asmlinkage long __se_sys##name(__MAP(x,__SC_LONG,__VA_ARGS__)) \
{ \
long ret = __do_sys##name(__MAP(x,__SC_CAST,__VA_ARGS__));\
__MAP(x,__SC_TEST,__VA_ARGS__); \
__PROTECT(x, ret,__MAP(x,__SC_ARGS,__VA_ARGS__)); \
return ret; \
} \
#define __TYPE_AS(t, v) __same_type((__force t)0, v) /*判断t和v是否是同一个类型*/
#define __TYPE_IS_L(t) (__TYPE_AS(t, 0L)) /*判断t是否是long 类型,是返回1*/
#define __TYPE_IS_UL(t) (__TYPE_AS(t, 0UL)) /*判断t是否是unsigned long 类型,是返回1*/
#define __TYPE_IS_LL(t) (__TYPE_AS(t, 0LL) || __TYPE_AS(t, 0ULL))/*是long类型就返回1*/
#define __SC_LONG(t, a) __typeof(__builtin_choose_expr(__TYPE_IS_LL(t), 0LL, 0L)) a
/*将参数转换成long类型*/
#define __SC_CAST(t, a) (__force t) a /*转成成原来的类型*/
# define __force __attribute__((force))
表示所定义的变量类型可以做强制类型转换
barrier()宏
内存屏障，该语句不产生任何代码，但是执行后刷新寄存器对变量的分配。
/* Optimization barrier */
/* The "volatile" is due to gcc bugs */
#define barrier() __asm__ __volatile__("": : :"memory")
执行该语句后cpu中的寄存器和cache中已缓存的数据将作废，重新读取内存中的数据。这就阻止了cpu将寄存器和cache中的数据用于去优化指令，而避免去访问内存。例如：
int a = 5, b = 6;
barrier();
a = b;
第三行中，GCC不会用存放b的寄存器给a赋值，而是invalidate b 的cache line，重新读取内存中的b值给a赋值。
另外的内存屏障宏定义：
-
mfence：在mfence指令前的读写操作当必须在mfence指令后的读写操作前完成。
-
lfence：在lfence指令前的读操作当必须在lfence指令后的读操作前完成，不影响写操作
-
sfence：在sfence指令前的写操作当必须在sfence指令后的写操作前完成，不影响读操作
-
lock 前缀（或cpuid、xchg等指令）使得本CPU的Cache写入内存，该写入动作也会引起别的CPU invalidate其Cache。用来修饰当前指令操作的内存只能由当前CPU使用
内存对于缓存更新策略，要区分Write-Through和Write-Back两种策略。前者更新内容直接写内存并不同时更新Cache，但要置Cache失效，后者先更新Cache，随后异步更新内存。通常X86 CPU更新内存都使用Write-Back策略。
ifdef ASSEMBLY宏
一些常量宏同时在汇编和C中使用，然而，我们不能像注释C的常量宏那样加一个“UL”或其他后缀。所以我们需要使用以下的宏解决这个问题。
例如调用：#define DEMO_MACRO _AT(1， UL)：在C中会被解释为 #define DEMO_MACRO 1UL； 而在汇编中什么都不做，就是：#define DEMO_MACRO 1
#ifdef __ASSEMBLY__
#define _AC(X,Y) X
#define _AT(T,X) X
#else
#define __AC(X,Y) (X##Y)
#define _AC(X,Y) __AC(X,Y)
#define _AT(T,X) ((T)(X))
#endif
#define _UL(x) (_AC(x, UL))
#define _ULL(x) (_AC(x, ULL))
force_o_largefile宏
判断是否支持大文件。
define force_o_largefile() \
(personality(current->personality) != PER_LINUX32)
PER_LINUX32 = 0x0008,
PER_MASK = 0x00ff,
/*，
- Return the base personality without flags.
*/
define personality(pers) (pers & PER_MASK)
逻辑地址和物理地址互相转换
#define __pa(x) __virt_to_phys((unsigned long)(x))
#define __va(x) ((void *)__phys_to_virt((unsigned long)(x)))
错误码相关的宏
linux 内核的一些错误码，以它们的负数来作为函数返回值，简单地使用大于等于-4095的虚拟地址来分别表示相应的错误码。
在32位系统上，-4095转换成unsigned long类型的值为0xFFFFF001，也就是说地址区间[0xFFFFF001, 0xFFFFFFFF]被分别用来表示错误码从-4095到-1。
判断一个函数返回的指针到底是有效地址还是错误码：
#define MAX_ERRNO 4095
#define IS_ERR_VALUE(x) unlikely((x) >= (unsigned long)-MAX_ERRNO)
static inline long __must_check IS_ERR(const void *ptr)
{
return IS_ERR_VALUE((unsigned long)ptr);
}
错误码与相应地址的互换：
static inline void * __must_check ERR_PTR(long error)
{
return (void *) error;
}
长整型转化为指针
static inline long __must_check PTR_ERR(const void *ptr)
{
return (long) ptr;
}
指针转化为长整型
额外有意思的宏
递归宏，颠倒字节：
#define BSWAP_8(x) ((x) & 0xff)
#define BSWAP_16(x) ((BSWAP_8(x) << 8) | BSWAP_8((x) >> 8))
#define BSWAP_32(x) ((BSWAP_16(x) << 16) | BSWAP_16((x) >> 16))
#define BSWAP_64(x) ((BSWAP_32(x) << 32) | BSWAP_32((x) >> 32))
交换宏，不需要额外定义变量
#define swap(a, b) \
(((a) ^= (b)), ((b) ^= (a)), ((a) ^= (b)))
如果您觉得阅读本文对您有帮助，请点一下“推荐”按钮，您的“推荐”将是我最大的写作动力！