linux_uaccess.h File Reference

iPXE user access API for Linux More...

Go to the source code of this file.

Macros
#define	UACCESS_PREFIX_linux   __linux_

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
static __always_inline unsigned long	UACCESS_INLINE (linux, user_to_phys)(userptr_t userptr
	Convert user pointer to physical address. More...
static __always_inline userptr_t	UACCESS_INLINE (linux, phys_to_user)(physaddr_t phys_addr)
	Convert physical address to user pointer. More...
static __always_inline userptr_t	UACCESS_INLINE (linux, virt_to_user)(volatile const void *addr)
static __always_inline void *	UACCESS_INLINE (linux, user_to_virt)(userptr_t userptr
static __always_inline userptr_t	UACCESS_INLINE (linux, userptr_add)(userptr_t userptr
static __always_inline off_t	UACCESS_INLINE (linux, userptr_sub)(userptr_t userptr
static __always_inline void	UACCESS_INLINE (linux, memcpy_user)(userptr_t dest
static __always_inline void	UACCESS_INLINE (linux, memmove_user)(userptr_t dest
static __always_inline int	UACCESS_INLINE (linux, memcmp_user)(userptr_t first
static __always_inline void	UACCESS_INLINE (linux, memset_user)(userptr_t buffer
static __always_inline size_t	UACCESS_INLINE (linux, strlen_user)(userptr_t buffer
static __always_inline off_t	UACCESS_INLINE (linux, memchr_user)(userptr_t buffer

Variables
static __always_inline unsigned long off_t	offset
static __always_inline off_t userptr_t	subtrahend
static __always_inline void off_t	dest_off
static __always_inline void off_t userptr_t	src
static __always_inline void off_t userptr_t off_t	src_off
static __always_inline void off_t userptr_t off_t size_t	len
static __always_inline int off_t	first_off
static __always_inline int off_t userptr_t	second
static __always_inline int off_t userptr_t off_t	second_off
static __always_inline void off_t int	c

Detailed Description

iPXE user access API for Linux

We run with no distinction between internal and external addresses, so can use trivial_virt_to_user() et al.

We have no concept of the underlying physical addresses, since these are not exposed to userspace. We provide a stub implementation of user_to_phys() since this is required by alloc_memblock(). We provide no implementation of phys_to_user(); any code attempting to access physical addresses will therefore (correctly) fail to link.

Definition in file linux_uaccess.h.

Macro Definition Documentation

UACCESS_PREFIX_linux

#define UACCESS_PREFIX_linux   __linux_

Definition at line 24 of file linux_uaccess.h.

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

UACCESS_INLINE() [1/12]

static __always_inline unsigned long UACCESS_INLINE ( linux  , user_to_phys    )

inlinestatic

Convert user pointer to physical address.

Parameters

userptr	User pointer
offset	Offset from user pointer

Return values

phys_addr

Physical address

UACCESS_INLINE() [2/12]

static __always_inline userptr_t UACCESS_INLINE ( linux  , phys_to_user    )

inlinestatic

Convert physical address to user pointer.

Parameters

phys_addr

Physical address

Return values

userptr

User pointer

Definition at line 56 of file linux_uaccess.h.

                                                                {

        /* For symmetry with the stub user_to_phys() */
        return phys_addr;
}

UACCESS_INLINE() [3/12]

static __always_inline userptr_t UACCESS_INLINE ( linux  , virt_to_user    ) const volatile

inlinestatic

Definition at line 63 of file linux_uaccess.h.

                                                                     {
        return trivial_virt_to_user ( addr );
}

References addr, and trivial_virt_to_user().

UACCESS_INLINE() [4/12]

static __always_inline void* UACCESS_INLINE ( linux  , user_to_virt    )

inlinestatic

UACCESS_INLINE() [5/12]

static __always_inline userptr_t UACCESS_INLINE ( linux  , userptr_add    )

inlinestatic

UACCESS_INLINE() [6/12]

static __always_inline off_t UACCESS_INLINE ( linux  , userptr_sub    )

inlinestatic

UACCESS_INLINE() [7/12]

static __always_inline void UACCESS_INLINE ( linux  , memcpy_user    )

inlinestatic

UACCESS_INLINE() [8/12]

static __always_inline void UACCESS_INLINE ( linux  , memmove_user    )

inlinestatic

UACCESS_INLINE() [9/12]

static __always_inline int UACCESS_INLINE ( linux  , memcmp_user    )

inlinestatic

UACCESS_INLINE() [10/12]

static __always_inline void UACCESS_INLINE ( linux  , memset_user    )

inlinestatic

UACCESS_INLINE() [11/12]

static __always_inline size_t UACCESS_INLINE ( linux  , strlen_user    )

inlinestatic

UACCESS_INLINE() [12/12]

static __always_inline off_t UACCESS_INLINE ( linux  , memchr_user    )

inlinestatic

Variable Documentation

offset

__always_inline off_t off_t offset

Initial value:

{

        
        return ( userptr + offset )

Definition at line 35 of file linux_uaccess.h.

subtrahend

__always_inline off_t userptr_t subtrahend

Initial value:

{
        return trivial_userptr_sub ( userptr, subtrahend )

Definition at line 79 of file linux_uaccess.h.

dest_off

__always_inline void off_t dest_off

Definition at line 84 of file linux_uaccess.h.

src

__always_inline void off_t userptr_t src

Definition at line 84 of file linux_uaccess.h.

src_off

__always_inline void off_t userptr_t off_t src_off

Definition at line 84 of file linux_uaccess.h.

len

__always_inline off_t off_t int size_t len

Initial value:

{
        trivial_memcpy_user ( dest, dest_off, src, src_off, len )

Definition at line 86 of file linux_uaccess.h.

first_off

__always_inline int off_t first_off

Definition at line 98 of file linux_uaccess.h.

second

__always_inline int off_t userptr_t second

Definition at line 98 of file linux_uaccess.h.

second_off

__always_inline int off_t userptr_t off_t second_off

Definition at line 98 of file linux_uaccess.h.

c

__always_inline off_t off_t int c

Definition at line 105 of file linux_uaccess.h.