Trivial user access API implementations

User access API implementations that can be used by environments in which virtual addresses allow access to all of memory. More...

Functions
static __always_inline userptr_t	trivial_virt_to_user (volatile const void *addr)
	Convert virtual address to user pointer. More...
static __always_inline void *	trivial_user_to_virt (userptr_t userptr, off_t offset)
	Convert user pointer to virtual address. More...
static __always_inline userptr_t	trivial_userptr_add (userptr_t userptr, off_t offset)
	Add offset to user pointer. More...
static __always_inline off_t	trivial_userptr_sub (userptr_t userptr, userptr_t subtrahend)
	Subtract user pointers. More...
static __always_inline void	trivial_memcpy_user (userptr_t dest, off_t dest_off, userptr_t src, off_t src_off, size_t len)
	Copy data between user buffers. More...
static __always_inline void	trivial_memmove_user (userptr_t dest, off_t dest_off, userptr_t src, off_t src_off, size_t len)
	Copy data between user buffers, allowing for overlap. More...
static __always_inline int	trivial_memcmp_user (userptr_t first, off_t first_off, userptr_t second, off_t second_off, size_t len)
	Compare data between user buffers. More...
static __always_inline void	trivial_memset_user (userptr_t buffer, off_t offset, int c, size_t len)
	Fill user buffer with a constant byte. More...
static __always_inline size_t	trivial_strlen_user (userptr_t buffer, off_t offset)
	Find length of NUL-terminated string in user buffer. More...
static __always_inline off_t	trivial_memchr_user (userptr_t buffer, off_t offset, int c, size_t len)
	Find character in user buffer. More...

Detailed Description

User access API implementations that can be used by environments in which virtual addresses allow access to all of memory.

Function Documentation

trivial_virt_to_user()

static __always_inline userptr_t trivial_virt_to_user ( volatile const void *  addr )

inlinestatic

Convert virtual address to user pointer.

Parameters

addr	Virtual address

Return values

userptr

User pointer

Definition at line 55 of file uaccess.h.

                                                   {
        return ( ( userptr_t ) addr );
}

References addr.

Referenced by UACCESS_INLINE().

trivial_user_to_virt()

static __always_inline void* trivial_user_to_virt ( userptr_t  userptr, off_t  offset  )

inlinestatic

Convert user pointer to virtual address.

Parameters

userptr	User pointer
offset	Offset from user pointer

Return values

addr	Virtual address

This operation is not available under all memory models.

Definition at line 69 of file uaccess.h.

                                                         {
        return ( ( void * ) userptr + offset );
}

References offset.

trivial_userptr_add()

static __always_inline userptr_t trivial_userptr_add ( userptr_t  userptr, off_t  offset  )

inlinestatic

Add offset to user pointer.

Parameters

userptr	User pointer
offset	Offset

Return values

userptr

New pointer value

Definition at line 81 of file uaccess.h.

                                                        {
        return ( userptr + offset );
}

References offset.

trivial_userptr_sub()

static __always_inline off_t trivial_userptr_sub ( userptr_t  userptr, userptr_t  subtrahend  )

inlinestatic

Subtract user pointers.

Parameters

userptr	User pointer
subtrahend	User pointer to be subtracted

Return values

offset

Offset

Definition at line 93 of file uaccess.h.

                                                                {
        return ( userptr - subtrahend );
}

References subtrahend.

trivial_memcpy_user()

static __always_inline void trivial_memcpy_user ( userptr_t  dest, off_t  dest_off, userptr_t  src, off_t  src_off, size_t  len  )

inlinestatic

Copy data between user buffers.

Parameters

dest	Destination
dest_off	Destination offset
src	Source
src_off	Source offset
len	Length

Definition at line 107 of file uaccess.h.

                                                                 {
        memcpy ( ( ( void * ) dest + dest_off ),
                 ( ( void * ) src + src_off ), len );
}

References dest, dest_off, len, memcpy(), src, and src_off.

trivial_memmove_user()

static __always_inline void trivial_memmove_user ( userptr_t  dest, off_t  dest_off, userptr_t  src, off_t  src_off, size_t  len  )

inlinestatic

Copy data between user buffers, allowing for overlap.

Parameters

dest	Destination
dest_off	Destination offset
src	Source
src_off	Source offset
len	Length

Definition at line 123 of file uaccess.h.

                                                                  {
        memmove ( ( ( void * ) dest + dest_off ),
                  ( ( void * ) src + src_off ), len );
}

References dest, dest_off, len, memmove(), src, and src_off.

trivial_memcmp_user()

static __always_inline int trivial_memcmp_user ( userptr_t  first, off_t  first_off, userptr_t  second, off_t  second_off, size_t  len  )

inlinestatic

Compare data between user buffers.

Parameters

first	First buffer
first_off	First buffer offset
second	Second buffer
second_off	Second buffer offset
len	Length

Return values

diff	Difference

Definition at line 140 of file uaccess.h.

                                                                       {
        return memcmp ( ( ( void * ) first + first_off ),
                        ( ( void * ) second + second_off ), len );
}

References first, first_off, len, memcmp(), second, and second_off.

trivial_memset_user()

static __always_inline void trivial_memset_user ( userptr_t  buffer, off_t  offset, int  c, size_t  len  )

inlinestatic

Fill user buffer with a constant byte.

Parameters

buffer	User buffer
offset	Offset within buffer
c	Constant byte with which to fill
len	Length

Definition at line 155 of file uaccess.h.

                                                                          {
        memset ( ( ( void * ) buffer + offset ), c, len );
}

References buffer, c, len, memset(), and offset.

trivial_strlen_user()

static __always_inline size_t trivial_strlen_user ( userptr_t  buffer, off_t  offset  )

inlinestatic

Find length of NUL-terminated string in user buffer.

Parameters

buffer	User buffer
offset	Offset within buffer

Return values

len	Length of string (excluding NUL)

Definition at line 167 of file uaccess.h.

                                                       {
        return strlen ( ( void * ) buffer + offset );
}

References buffer, offset, and strlen().

trivial_memchr_user()

static __always_inline off_t trivial_memchr_user ( userptr_t  buffer, off_t  offset, int  c, size_t  len  )

inlinestatic

Find character in user buffer.

Parameters

buffer	User buffer
offset	Starting offset within buffer
c	Character to search for
len	Length of user buffer

Return values

offset

Offset of character, or <0 if not found

Definition at line 181 of file uaccess.h.

                                                                          {
        void *found;

        found = memchr ( ( ( void * ) buffer + offset ), c, len );
        return ( found ? ( found - ( void * ) buffer ) : -1 );
}

References buffer, c, len, memchr(), and offset.