copy_to_user和copy_from_user两个函数的分析

在内核的学习中会遇到很多挺有意思的函数,而且能沿着一个函数扯出来很多个相关的函数。copy_to_usercopy_from_user就是在进行驱动相关程序设计的时候,要经常遇到的两个函数。由于内核空间与用户空间的内存不能直接互访,因此借助函数copy_to_user()完成内核空间到用户空间的复制,函数copy_from_user()完成用户空间到内核空间的复制。下面我们来仔细的理一下这两个函数的来龙去脉。

首先,我们来看一下这两个函数的在源码文件中是如何定义的:

~/arch/i386/lib/usercopy.c

unsigned long

copy_to_user(void __user *to, const void *from, unsigned long n)

{

       might_sleep();

       BUG_ON((long) n < 0);

       if (access_ok(VERIFY_WRITE, to, n))

              n = __copy_to_user(to, from, n);

       return n;

}

EXPORT_SYMBOL(copy_to_user);

从注释中就可以看出,这个函数的主要作用就是从内核空间拷贝一块儿数据到用户空间,由于这个函数有可能睡眠,所以只能用于用户空间。它有如下三个参数,

       To 目标地址,这个地址是用户空间的地址

       From 源地址,这个地址是内核空间的地址

       N 将要拷贝的数据的字节数

如果数据拷贝成功,则返回零;否则,返回没有拷贝成功的数据字节数。

以上是对函数的一些说明,接下来让我们看看这个函数的内部面目:

参数to的时候有个__user限定,这个在~/include/linux/compiler.h中有如下定义:

# define __user     __attribute__((noderef, address_space(1)))

表示这是一个用户空间的地址,即其指向的为用户空间的内存

大家可能对这个__attribute__感到比较迷惑,不过没关系,google一下嘛

__attribute__是gnu c编译器的一个功能,它用来让开发者使用此功能给所声明的函数或者变量附加一个属性,以方便编译器进行错误检查,其实就是一个内核检查器。

具体可以参考如下:

http://unixwiz.net/techtips/gnu-c-attributes.html

接下来我们看一下

might_sleep();它有两个实现版本,debug版本和非debug版本:

在debug版本中,在有可能引起sleep的函数中会给出相应的提示,如果是在原子的上下文中执行,则会打印出栈跟踪的信息,这是通过__might_sleep(__FILE__, __LINE__);函数来实现的,并且接着调用might_resched()函数进行重新调度。

在非debug版本中直接调用might_resched()函数进行重新调度。

其实现方式为,在~/ include/linux/kernel.h中:

#ifdef CONFIG_DEBUG_SPINLOCK_SLEEP

void __might_sleep(char *file, int line);

# define might_sleep() \

do { __might_sleep(__FILE__, __LINE__); might_resched(); } while (0)

#else

# define might_sleep() do { might_resched(); } while (0)

#endif

接下来是一个检查参数合法性的宏:

BUG_ON((long) n < 0);

其实现为如下(在~/include/asm-generic/bug.h):

它通过检查条件,根据结果来决定是否打印相应的提示信息;

#ifdef CONFIG_BUG

#ifndef HAVE_ARCH_BUG

#define BUG() do { \

    printk("BUG: failure at %s:%d/%s()!\n", __FILE__, __LINE__, __FUNCTION__); \

    panic("BUG!"); \

} while (0)

#endif

#ifndef HAVE_ARCH_BUG_ON

#define BUG_ON(condition) do { if (unlikely((condition)!=0)) BUG(); } while(0)

#endif

    接下来是一个宏

        access_ok(VERIFY_WRITE, to, n)

它是用来检查参数中一个指向用户空间数据块的指针是否有效,如果有效返回非零,否则返回零。其实现如下(在/include/asm-i386/uaccess.h中):

#define access_ok(type,addr,size) (likely(__range_ok(addr,size) == 0))

其中__range_ok(addr,size)的实现是通过内嵌汇编来实现的,内容如下(在/include/asm-i386/uaccess.h中):

#define __range_ok(addr,size) ({ \

    unsigned long flag,sum; \

    __chk_user_ptr(addr); \

    asm("addl %3,%1 ; sbbl %0,%0; cmpl %1,%4; sbbl $0,%0" \

        :"=&r" (flag), "=r" (sum) \

        :"1" (addr),"g" ((int)(size)),"g" (current_thread_info()->addr_limit.seg)); \

flag; })

其实现的功能为:

(u33)addr + (u33)size >= (u33)current->addr_limit.seg

    判断上式是否成立,若不成立则表示地址有效,返回零;否则返回非零

接下来的这个函数才是最重要的函数,它实现了拷贝的工作:

    __copy_to_user(to, from, n)

其实现方式如下(在/include/asm-i386/uaccess.h中):

static __always_inline unsigned long __must_check

__copy_to_user(void __user *to, const void *from, unsigned long n)

{

       might_sleep();

       return __copy_to_user_inatomic(to, from, n);

}

有一个__always_inline宏,其内容就是inline,一个__must_check,其内容是在gcc3和gcc4版本里为__attribute__((warn_unused_result))

其中might_sleep同上面__user时候的注释。

最终调用的是__copy_to_user_inatomic(to, from, n)来完成拷贝工作的,此函数的实现如下(在/include/asm-i386/uaccess.h中):

static __always_inline unsigned long __must_check

__copy_to_user_inatomic(void __user *to, const void *from, unsigned long n)

{

    if (__builtin_constant_p(n)) {

        unsigned long ret;

        switch (n) {

        case 1:

            __put_user_size(*(u8 *)from, (u8 __user *)to, 1, ret, 1);

            return ret;

        case 2:

            __put_user_size(*(u16 *)from, (u16 __user *)to, 2, ret, 2);

            return ret;

        case 4:

            __put_user_size(*(u32 *)from, (u32 __user *)to, 4, ret, 4);

            return ret;

        }

    }

    return __copy_to_user_ll(to, from, n);

}

其中__builtin_constant_p(n)为gcc的内建函数,__builtin_constant_p用于判断一个值是否为编译时常熟,如果参数n的值为常数,函数返回1,否则返回0。很多计算或操作在参数为常数时有更优化的实现,在 GNU C 中用上面的方法可以根据参数是否为常数,只编译常数版本或非常数版本,这样既不失通用性,又能在参数是常数时编译出最优化的代码。

如果n为常数1、2或者4,就会选择某个swith来执行拷贝动作,拷贝是通过如下函数来实现的(在/include/asm-i386/uaccess.h中):

#ifdef CONFIG_X86_WP_WORKS_OK

#define __put_user_size(x,ptr,size,retval,errret)           \

do {                                    \

    retval = 0;                         \

    __chk_user_ptr(ptr);                        \

    switch (size) {                         \

    case 1: __put_user_asm(x,ptr,retval,"b","b","iq",errret);break; \

    case 2: __put_user_asm(x,ptr,retval,"w","w","ir",errret);break; \

    case 4: __put_user_asm(x,ptr,retval,"l","","ir",errret); break; \

    case 8: __put_user_u64((__typeof__(*ptr))(x),ptr,retval); break;\

    default: __put_user_bad();                \

    }                               \

} while (0)

#else

#define __put_user_size(x,ptr,size,retval,errret)           \

do {                                    \

    __typeof__(*(ptr)) __pus_tmp = x;               \

    retval = 0;                         \

                                    \

    if(unlikely(__copy_to_user_ll(ptr, &__pus_tmp, size) != 0)) \

        retval = errret;                    \

} while (0)

#endif

其中__put_user_asm为一个宏,拷贝工作是通过如下的内联汇编来实现的(在/include/asm-i386/uaccess.h中):

#define __put_user_asm(x, addr, err, itype, rtype, ltype, errret)   \

    __asm__ __volatile__(                       \

        "1: mov"itype" %"rtype"1,%2\n"          \

        "2:\n"                          \

        ".section .fixup,\"ax\"\n"              \

        "3: movl %3,%0\n"                   \

        "   jmp 2b\n"                   \

        ".previous\n"                       \

        ".section __ex_table,\"a\"\n"               \

        "   .align 4\n"                 \

        "   .long 1b,3b\n"                  \

        ".previous"                     \

        : "=r"(err)                     \

    : ltype (x), "m"(__m(addr)), "i"(errret), "0"(err))

表 1. 用户空间内存访问 API

函数描述
access_ok检查用户空间内存指针的有效性
get_user从用户空间获取一个简单变量
put_user输入一个简单变量到用户空间
clear_user清除用户空间中的一个块,或者将其归零。
copy_to_user将一个数据块从内核复制到用户空间
copy_from_user将一个数据块从用户空间复制到内核
strnlen_user获取内存空间中字符串缓冲区的大小
strncpy_from_user从用户空间复制一个字符串到内核
access_ok 函数

  您可以使用 access_ok 函数在您想要访问的用户空间检查指针的有效性。调用函数提供指向数据块的开始的指针、块大小和访问类型(无论这个区域是用来读还是写的)。函数原型定义如下:

access_ok( type, addr, size ); 

  type 参数可以被指定为 VERIFY_READ 或 VERIFY_WRITE。VERIFY_WRITE 也可以识别内存区域是否可读以及可写(尽管访问仍然会生成 -EFAULT)。该函数简单检查地址可能是在用户空间,而不是内核。

get_user 函数

  要从用户空间读取一个简单变量,可以使用 get_user 函数,该函数适用于简单数据类型,比如,char 和 int,但是像结构体这类较大的数据类型,必须使用 copy_from_user 函数。该原型接受一个变量(存储数据)和一个用户空间地址来进行 Read 操作:

get_user( x, ptr ); 

  get_user 函数将映射到两个内部函数其中的一个。在系统内部,这个函数决定被访问变量的大小(根据提供的变量存储结果)并通过 __get_user_x 形成一个内部调用。成功时该函数返回 0,一般情况下,get_user 和 put_user 函数比它们的块复制副本要快一些,如果是小类型被移动的话,应该用它们。

  put_user 函数

  您可以使用 put_user 函数来将一个简单变量从内核写入用户空间。和 get_user 一样,它接受一个变量(包含要写的值)和一个用户空间地址作为写目标:

put_user( x, ptr ); 

  和 get_user 一样,put_user 函数被内部映射到 put_user_x 函数,成功时,返回 0,出现错误时,返回 -EFAULT。

  clear_user 函数

  clear_user 函数被用于将用户空间的内存块清零。该函数采用一个指针(用户空间中)和一个型号进行清零,这是以字节定义的:

clear_user( ptr, n ); 

  在内部,clear_user 函数首先检查用户空间指针是否可写(通过 access_ok),然后调用内部函数(通过内联组装方式编码)来执行 Clear 操作。使用带有 repeat 前缀的字符串指令将该函数优化成一个非常紧密的循环。它将返回不可清除的字节数,如果操作成功,则返回 0。

  copy_to_user 函数

  copy_to_user 函数将数据块从内核复制到用户空间。该函数接受一个指向用户空间缓冲区的指针、一个指向内存缓冲区的指针、以及一个以字节定义的长度。该函数在成功时,返回 0,否则返回一个非零数,指出不能发送的字节数。

copy_to_user( to, from, n ); 

  检查了向用户缓冲区写入的功能之后(通过 access_ok),内部函数 __copy_to_user 被调用,它反过来调用 __copy_from_user_inatomic(在 ./linux/arch/x86/include/asm/uaccess_XX.h 中。其中 XX 是 32 或者 64 ,具体取决于架构。)在确定了是否执行 1、2 或 4 字节复制之后,该函数调用 __copy_to_user_ll,这就是实际工作进行的地方。在损坏的硬件中(在 i486 之前,WP 位在管理模式下不可用),页表可以随时替换,需要将想要的页面固定到内存,使它们在处理时不被换出。i486 之后,该过程只不过是一个优化的副本。

  copy_from_user 函数

  copy_from_user 函数将数据块从用户空间复制到内核缓冲区。它接受一个目的缓冲区(在内核空间)、一个源缓冲区(从用户空间)和一个以字节定义的长度。和 copy_to_user 一样,该函数在成功时,返回 0 ,否则返回一个非零数,指出不能复制的字节数。

copy_from_user( to, from, n ); 

  该函数首先检查从用户空间源缓冲区读取的能力(通过 access_ok),然后调用 __copy_from_user,最后调用 __copy_from_user_ll。从此开始,根据构架,为执行从用户缓冲区到内核缓冲区的零拷贝(不可用字节)而进行一个调用。优化组装函数包含管理功能。

  strnlen_user 函数

  strnlen_user 函数也能像 strnlen 那样使用,但前提是缓冲区在用户空间可用。strnlen_user 函数带有两个参数:用户空间缓冲区地址和要检查的最大长度。

strnlen_user( src, n ); 

  strnlen_user 函数首先通过调用 access_ok 检查用户缓冲区是否可读。如果是 strlen 函数被调用,max length 参数则被忽略。

  strncpy_from_user 函数

  strncpy_from_user 函数将一个字符串从用户空间复制到一个内核缓冲区,给定一个用户空间源地址和最大长度。

strncpy_from_user( dest, src, n ); 

  由于从用户空间复制,该函数首先使用 access_ok 检查缓冲区是否可读。和 copy_from_user 一样,该函数作为一个优化组装函数(在 ./linux/arch/x86/lib/usercopy_XX.c 中)实现。



转载自:http://hi.baidu.com/perneter/blog/item/8265a7f3e8240ac20b46e000.html

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

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

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值