linux中ERR_PTR、PTR_ERR、IS_ERR和IS_ERR_OR_NULL

判断返回指针是否错误的内联函数

  linux内核中判断返回指针是否错误的内联函数主要有:ERR_PTR、PTR_ERR、IS_ERR和IS_ERR_OR_NULL等。
  其源代码见include/linux/err.h

#include <linux/compiler.h>
#include <linux/types.h>

#include <asm/errno.h>

/*
 * Kernel pointers have redundant information, so we can use a
 * scheme where we can return either an error code or a normal
 * pointer with the same return value.
 *
 * This should be a per-architecture thing, to allow different
 * error and pointer decisions.
 */
#define MAX_ERRNO   4095

#ifndef __ASSEMBLY__

#define IS_ERR_VALUE(x) unlikely((x) >= (unsigned long)-MAX_ERRNO)

static inline void * __must_check ERR_PTR(long error)
{
    return (void *) error;
}

static inline long __must_check PTR_ERR(__force const void *ptr)
{
    return (long) ptr;
}

static inline bool __must_check IS_ERR(__force const void *ptr)
{
    return IS_ERR_VALUE((unsigned long)ptr);
}

static inline bool __must_check IS_ERR_OR_NULL(__force const void *ptr)
{
    return !ptr || IS_ERR_VALUE((unsigned long)ptr);
}

  理解IS_ERR(),首先理解要内核空间。所有的驱动程序都是运行在内核空间,内核空间虽然很大,但总是有限的,而在这有限的空间中,其最后一个page是专门保留的,也就是说一般人不可能用到内核空间最后一个page的指针。换句话说,你在写设备驱动程序的过程中,涉及到的任何一个指针,必然有三种情况:
1,有效指针
2,NULL,空指针
3,错误指针,或者说无效指针
  所谓的错误指针就是指其已经到达了最后一个page,即内核用最后一页捕捉错误。比如对于32bit的系统来说,内核空间最高地址0xffffffff,那么最后一个page就是指的0xfffff000~0xffffffff(假设4k一个page),这段地址是被保留的。
  内核空间为什么留出最后一个page?我们知道一个page可能是4k,也可能是更多,比如8k,但至少它也是4k,所以留出一个page出来就可以让我们把内核空间的指针来记录错误了。内核返回的指针一般是指向页面的边界(4k边界),即ptr & 0xfff == 0。如果你发现你的一个指针指向这个范围中的某个地址,那么你的代码肯定出错了。
  IS_ERR( )就是判断指针是否有错,如果指针并不是指向最后一个page,那么没有问题;如果指针指向了最后一个page,那么说明实际上这不是一个有效的指针,这个指针里保存的实际上是一种错误代码。
  通常很常用的方法就是先用IS_ERR()来判断是否是错误,然后如果是,那么就调用PTR_ERR()来返回这个错误代码。因此,判断一个指针是不是有效的,可用如下的方式:

#define IS_ERR_VALUE(x) unlikely((x) >= (unsigned long)-MAX_ERRNO))

  MAX_ERRNO是4095即0xfff,注意(unsigned long)-MAX_ERRNO并不是(unsigned long)减去MAX_ERRNO,而是对负数-MAX_ERRNO进行强制类型转化,即上面应该等价于为(unsigned long)(-MAX_ERRNO),-0xfff转换为无符号long型是0xfffff000,即:

#define IS_ERR_VALUE(x) unlikely(x >= 0xfffff000)

  即判断是不是在(0xfffff000,0xffffffff)之间,在这个区间的话就是错误指针。因此,可以用IS_ERR()来判断内核函数的返回值是不是一个有效的指针。所以经常在内核中看见返回错误码的时候加个负号如 -ENOSYS。注意这里的unlikely意思是括号内的值很有可能是假,具体likely和unlikely用法见likely和unlikely
  ERR_PTR、PTR_ERR只是对错误进行转换。
  IS_ERR_OR_NULL是判断指针是空指针或是错误指针,即上述2和3类型的指针。
  注意函数前面还用到了__must_check ,__must_check 函数是指调用函数一定要处理该函数的返回值,否则编译器会给出警告。即返回的指针有可能是错误指针,一定要对返回的指针进行处理。
compiler-gcc.5中定义如下:

#define __must_check            __attribute__((warn_unused_result))
//警告结果未使用,也即是返回值未被处理
常见错误源定义

  Linux内核中,出错有多种可能.关于Linux内核中的错误,参考include/asm-generic/errno-base.h文件:

   1#ifndef _ASM_GENERIC_ERRNO_BASE_H
   2#define _ASM_GENERIC_ERRNO_BASE_H
   3
   4#define EPERM            1      /* Operation not permitted */操作禁止
   5#define ENOENT           2      /* No such file or directory */文件或者目录不存在
   6#define ESRCH            3      /* No such process */相应的进程不存在
   7#define EINTR            4      /* Interrupted system call */中断系统调用
   8#define EIO              5      /* I/O error */I/O错误
   9#define ENXIO            6      /* No such device or address */相应设备或者地址不存在
  10#define E2BIG            7      /* Argument list too long */参数列表太长
  11#define ENOEXEC          8      /* Exec format error */Exec格式错误
  12#define EBADF            9      /* Bad file number */错误的文档编号
  13#define ECHILD          10      /* No child processes */没有子进程
  14#define EAGAIN          11      /* Try again */ 重试
  15#define ENOMEM          12      /* Out of memory */溢出内存
  16#define EACCES          13      /* Permission denied */没有权限
  17#define EFAULT          14      /* Bad address */错误的地址
  18#define ENOTBLK         15      /* Block device required */块设备需求
  19#define EBUSY           16      /* Device or resource busy */设备或者资源繁忙
  20#define EEXIST          17      /* File exists */文件已经存在
  21#define EXDEV           18      /* Cross-device link */交叉链接设备
  22#define ENODEV          19      /* No such device */没有对应的设备
  23#define ENOTDIR         20      /* Not a directory */不是路径
  24#define EISDIR          21      /* Is a directory */是路径,与上面意思相反
  25#define EINVAL          22      /* Invalid argument */无效参数
  26#define ENFILE          23      /* File table overflow */文件表溢出
  27#define EMFILE          24      /* Too many open files */打开的文件太多了
  28#define ENOTTY          25      /* Not a typewriter */非打印机
  29#define ETXTBSY         26      /* Text file busy */文本文件繁忙
  30#define EFBIG           27      /* File too large */文件太大
  31#define ENOSPC          28      /* No space left on device */没有足够的空间留给设备使用
  32#define ESPIPE          29      /* Illegal seek */非法定位
  33#define EROFS           30      /* Read-only file system */只读文件系统
  34#define EMLINK          31      /* Too many links */太多的链接
  35#define EPIPE           32      /* Broken pipe */管道中断
  36#define EDOM            33      /* Math argument out of domain of func */??
  37#define ERANGE          34      /* Math result not representable */非数字结果
  38
  39#endif 

  最常见的几个是-EBUSY,-EINVAL,-ENODEV,-EPIPE,-EAGAIN,-ENOMEM.这些是每个体系结构里都有的,另外各个体系结构也都定义了自己的一些错误代码.这些东西当然也都是宏,实际上对应的是一些数字,这个数字就叫做错误号.
  对于Linux内核来说,不管任何体系结构,最大的错误号不会超过4095.而4095又正好是比4k小1,即4096减1.而我们知道一个page可能是4k,也可能是更多,比如8k,但至少它也是4k,所以留出一个page出来就可以让我们把内核空间的指针来记录错误了.

  • 3
    点赞
  • 46
    收藏
    觉得还不错? 一键收藏
  • 1
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值