umalloc.h File Reference

User memory allocation. More...

#include <ipxe/api.h>
#include <config/umalloc.h>
#include <ipxe/uaccess.h>
#include <ipxe/efi/efi_umalloc.h>
#include <ipxe/linux/linux_umalloc.h>
#include <bits/umalloc.h>

Go to the source code of this file.

Macros
#define	PROVIDE_UMALLOC(_subsys, _api_func, _func)   PROVIDE_SINGLE_API ( UMALLOC_PREFIX_ ## _subsys, _api_func, _func )
	Provide a user memory allocation API implementation. More...

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
userptr_t	urealloc (userptr_t userptr, size_t new_size)
	Reallocate external memory. More...
static __always_inline userptr_t	umalloc (size_t size)
	Allocate external memory. More...
static __always_inline void	ufree (userptr_t userptr)
	Free external memory. More...

Detailed Description

User memory allocation.

Definition in file umalloc.h.

Macro Definition Documentation

PROVIDE_UMALLOC

#define PROVIDE_UMALLOC	(		_subsys,
			_api_func,
			_func
	)		PROVIDE_SINGLE_API ( UMALLOC_PREFIX_ ## _subsys, _api_func, _func )

Provide a user memory allocation API implementation.

Parameters

_prefix	Subsystem prefix
_api_func	API function
_func	Implementing function

Definition at line 24 of file umalloc.h.

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

urealloc()

userptr_t urealloc	(	userptr_t	userptr,
		size_t	new_size
	)

Reallocate external memory.

Parameters

userptr	Memory previously allocated by umalloc(), or UNULL
new_size	Requested size

Return values

userptr

Allocated memory, or UNULL

Calling realloc() with a new size of zero is a valid way to free a memory block.

Referenced by image_set_len(), ufree(), umalloc(), umalloc_test(), and xferbuf_umalloc_realloc().

umalloc()

static __always_inline userptr_t umalloc ( size_t  size )

inlinestatic

Allocate external memory.

Parameters

size	Requested size

Return values

userptr

Memory, or UNULL

Memory is guaranteed to be aligned to a page boundary.

Definition at line 54 of file umalloc.h.

                                                                {
        return urealloc ( UNULL, size );
}

References size, UNULL, and urealloc().

Referenced by alloc_pixbuf(), arbel_alloc_icm(), arbel_start_firmware(), efifb_glyphs(), exanic_probe_port(), fbcon_init(), fbcon_picture_init(), golan_provide_pages(), hermon_map_icm(), hermon_start_firmware(), netvsc_create_buffer(), nii_initialise_flags(), png_image_header(), txnic_alloc(), and umalloc_test().

ufree()

static __always_inline void ufree ( userptr_t  userptr )

inlinestatic

Free external memory.

Parameters

userptr

Memory allocated by umalloc(), or UNULL

If ptr is UNULL, no action is taken.

Definition at line 65 of file umalloc.h.

                                                               {
        urealloc ( userptr, 0 );
}

References urealloc().

Referenced by arbel_free(), efifb_fini(), efifb_glyphs(), efifb_init(), exanic_probe_port(), exanic_remove_port(), fbcon_fini(), fbcon_init(), fbcon_picture_init(), free_image(), free_pixbuf(), golan_free_fw_areas(), hermon_free(), netvsc_create_buffer(), netvsc_destroy_buffer(), nii_initialise_flags(), nii_shutdown(), png_pixbuf(), txnic_alloc(), txnic_free(), and umalloc_test().