Allocator API

include/mem/alloc.h View source View on GitHub

Enums

alloc_flags

enum alloc_flags : uint16_t {
    ALLOC_FLAG_PREFER_CACHE_ALIGNED = (1 << 0),
    ALLOC_FLAG_NO_CACHE_ALIGN = 0,
    ALLOC_FLAG_FLEXIBLE_LOCALITY = (1 << 1),
    ALLOC_FLAG_STRICT_LOCALITY = 0,
    ALLOC_FLAG_PAGEABLE = (1 << 2),
    ALLOC_FLAG_NONPAGEABLE = 0,
    ALLOC_FLAG_MOVABLE = (1 << 3),
    ALLOC_FLAG_NONMOVABLE = 0,
    ALLOC_FLAG_CONTIGUOUS = (1 << 4),
    ALLOC_FLAG_NONCONTIGUOUS = 0,
    ALLOC_FLAG_ZERO_ON_ALLOC = (1 << 5),
    ALLOC_FLAG_NON_ZERO = 0,
    ALLOC_FLAG_CLASS_DEFAULT = (1 << ALLOC_CLASS_SHIFT),
    ALLOC_FLAG_CLASS_INTERLEAVED = (2 << ALLOC_CLASS_SHIFT),
    ALLOC_FLAG_CLASS_HIGH_BANDWIDTH = (3 << ALLOC_CLASS_SHIFT),
};

alloc_behavior

enum alloc_behavior : uint16_t {
    ALLOC_BEHAVIOR_NORMAL,
    ALLOC_BEHAVIOR_ATOMIC,
    ALLOC_BEHAVIOR_NO_WAIT,
    ALLOC_BEHAVIOR_NO_RECLAIM,
    ALLOC_BEHAVIOR_FAULT_SAFE,
    ALLOC_BEHAVIOR_FLAG_FAST = 1 << ALLOC_BEHAVIOR_FLAG_SHIFT,
    ALLOC_BEHAVIOR_FLAG_MINIMAL = 1 << (ALLOC_BEHAVIOR_FLAG_SHIFT + 1),
};

Functions

alloc_flags_valid

bool alloc_flags_valid(enum alloc_flags flags);

alloc_behavior_base

enum alloc_behavior alloc_behavior_base(enum alloc_behavior raw);

alloc_behavior_may_fault

bool alloc_behavior_may_fault(enum alloc_behavior raw);

alloc_behavior_may_block

bool alloc_behavior_may_block(enum alloc_behavior raw);

alloc_behavior_is_isr_safe

bool alloc_behavior_is_isr_safe(enum alloc_behavior raw);

alloc_behavior_no_reclaim

bool alloc_behavior_no_reclaim(enum alloc_behavior raw);

alloc_behavior_is_fast

bool alloc_behavior_is_fast(enum alloc_behavior raw);

alloc_flag_behavior_verify

bool alloc_flag_behavior_verify(enum alloc_flags f, enum alloc_behavior behavior);

alloc_request_sanitize

void alloc_request_sanitize(enum alloc_flags *f, enum alloc_behavior *b);

kmalloc_new

void * kmalloc_new(size_t size, enum alloc_flags flags, enum alloc_behavior behavior);

kfree_new

void kfree_new(void *ptr, enum alloc_behavior behavior);

kmalloc_from_domain

void * kmalloc_from_domain(size_t domain, size_t size);

kmalloc_internal

void * kmalloc_internal(size_t size, enum alloc_flags flags, enum alloc_behavior behavior);

krealloc_internal

void * krealloc_internal(void *ptr, size_t size, enum alloc_flags flags, enum alloc_behavior behavior);

kfree_internal

void kfree_internal(void *ptr, enum alloc_behavior behavior);

ksize

size_t ksize(void *ptr);

kmalloc_aligned_internal

void * kmalloc_aligned_internal(size_t size, size_t align, enum alloc_flags flags, enum alloc_behavior behavior);

kfree_aligned_internal

void kfree_aligned_internal(void *ptr, enum alloc_behavior behavior);

kfree_defer_irq

void kfree_defer_irq(void *ptr);

Macros

ALLOC_LOCALITY_SHIFT

#define ALLOC_LOCALITY_SHIFT 9

ALLOC_CLASS_SHIFT

#define ALLOC_CLASS_SHIFT 12

ALLOC_CLASS_MASK

#define ALLOC_CLASS_MASK 0xF

ALLOC_LOCALITY_MAX

#define ALLOC_LOCALITY_MAX 7

ALLOC_LOCALITY_MIN

#define ALLOC_LOCALITY_MIN 0

ALLOC_LOCALITY_MASK

#define ALLOC_LOCALITY_MASK 0x7

ALLOC_LOCALITY_FROM_FLAGS

#define ALLOC_LOCALITY_FROM_FLAGS(flags) \
    (((flags) >> ALLOC_LOCALITY_SHIFT) & ALLOC_LOCALITY_MASK)

ALLOC_LOCALITY_TO_FLAGS

#define ALLOC_LOCALITY_TO_FLAGS(locality) \
    (((locality) & ALLOC_LOCALITY_MASK) << ALLOC_LOCALITY_SHIFT)

ALLOC_FLAG_TEST

#define ALLOC_FLAG_TEST(flags, mask) (flags & mask)

ALLOC_FLAG_CLASS

#define ALLOC_FLAG_CLASS(flags) \
    ((flags >> ALLOC_CLASS_SHIFT) & ALLOC_CLASS_MASK)

ALLOC_FLAGS_NONE

#define ALLOC_FLAGS_NONE 0

ALLOC_FLAGS_UNAVAILABLE_BITS

#define ALLOC_FLAGS_UNAVAILABLE_BITS 0x40

ALLOC_FLAGS_DEFAULT

#define ALLOC_FLAGS_DEFAULT \
    (ALLOC_FLAG_CLASS_DEFAULT | ALLOC_FLAG_FLEXIBLE_LOCALITY | \
     ALLOC_FLAG_NONMOVABLE | ALLOC_FLAG_NONPAGEABLE | \
     ALLOC_FLAG_NO_CACHE_ALIGN | ALLOC_LOCALITY_TO_FLAGS(ALLOC_LOCALITY_MIN))

ALLOC_FLAGS_ZERO

#define ALLOC_FLAGS_ZERO (ALLOC_FLAGS_DEFAULT | ALLOC_FLAG_ZERO_ON_ALLOC)

ALLOC_FLAGS_PAGEABLE

#define ALLOC_FLAGS_PAGEABLE \
    ALLOC_FLAG_PAGEABLE | ALLOC_FLAG_CLASS_DEFAULT | \
        ALLOC_FLAG_FLEXIBLE_LOCALITY

ALLOC_BEHAVIOR_FLAG_SHIFT

#define ALLOC_BEHAVIOR_FLAG_SHIFT 4

ALLOC_BEHAVIOR_MASK

#define ALLOC_BEHAVIOR_MASK (0xF)

ALLOC_BEHAVIOR_AVAILABLE_SHIFT

#define ALLOC_BEHAVIOR_AVAILABLE_SHIFT 12

ALLOC_BEHAVIOR_DEFAULT

#define ALLOC_BEHAVIOR_DEFAULT ALLOC_BEHAVIOR_NORMAL

---