libsel4allocman/include/allocman/mspace/vspace_pool.h

/*
 * Copyright 2017, Data61, CSIRO (ABN 41 687 119 230)
 *
 * SPDX-License-Identifier: BSD-2-Clause
 */

#pragma once

#include <autoconf.h>
#include <stdint.h>
#include <sel4/types.h>
#include <allocman/mspace/mspace.h>
#include <allocman/mspace/k_r_malloc.h>
#include <vspace/vspace.h>

/* Performs allocation from a virtual pool of memory. It takes both a vspace
 * manager as well as a virtual range because we need to construct sbrk semantics
 * which requires a contiguous virtual address range. But we will use the vspace
 * manager to ensure we do not accidentally clobber somebody else. This memory manager
 * must *not* be used as a backing memory manager for somethign that is given to
 * the vspace library as the resulting circular dependency is unresolvable
 */

struct mspace_vspace_pool_config {
    uintptr_t vstart;
    reservation_t reservation;
    vspace_t vspace;
};

typedef struct mspace_vspace_pool {
    uintptr_t pool_ptr;
    uintptr_t pool_top;
    /* reservation inside the vspace_t */
    reservation_t reservation;
    vspace_t vspace;
    mspace_k_r_malloc_t k_r_malloc;
    struct allocman *morecore_alloc;
} mspace_vspace_pool_t;

void mspace_vspace_pool_create(mspace_vspace_pool_t *vspace_pool, struct mspace_vspace_pool_config config);

void *_mspace_vspace_pool_alloc(struct allocman *alloc, void *_vspace_pool, size_t bytes, int *error);
void _mspace_vspace_pool_free(struct allocman *alloc, void *_vspace_pool, void *ptr, size_t bytes);

static inline struct mspace_interface mspace_vspace_pool_make_interface(mspace_vspace_pool_t *vspace_pool) {
    return (struct mspace_interface){
        .alloc = _mspace_vspace_pool_alloc,
        .free = _mspace_vspace_pool_free,
        .properties = ALLOCMAN_DEFAULT_PROPERTIES,
        .mspace = vspace_pool
    };
}