VILLASnode/include/villas/memory.h

/** Memory allocators.
 *
 * @file
 * @author Steffen Vogel <stvogel@eonerc.rwth-aachen.de>
 * @copyright 2017, Institute for Automation of Complex Power Systems, EONERC
 * @license GNU General Public License (version 3)
 *
 * VILLASnode
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *********************************************************************************/

#include <stddef.h>
#include <stdint.h>

#pragma once

#define HUGEPAGESIZE	(1 << 21)

struct memtype;

typedef void *(*memzone_allocator_t)(struct memtype *mem, size_t len, size_t alignment);
typedef int (*memzone_deallocator_t)(struct memtype *mem, void *ptr, size_t len);

enum memtype_flags {
	MEMORY_MMAP	= (1 << 0),
	MEMORY_DMA	= (1 << 1),
	MEMORY_HUGEPAGE	= (1 << 2),
	MEMORY_HEAP	= (1 << 3)
};

struct memtype {
	const char *name;
	int flags;

	size_t alignment;

	memzone_allocator_t alloc;
	memzone_deallocator_t free;

	void *_vd; /**<Virtual data for possible state */
};

enum memblock_flags {
	MEMBLOCK_USED = 1,
};

/** Descriptor of a memory block. Associated block always starts at
 * &m + sizeof(struct memblock). */
struct memblock {
	struct memblock* prev;
	struct memblock* next;
	size_t len; /**<Length of the block; doesn't include the descriptor itself */
	int flags;
};

/** @todo Unused for now */
struct memzone {
	struct memtype * const type;

	void *addr;
	uintptr_t physaddr;
	size_t len;
};

/** Initilialize memory subsystem */
int memory_init(int hugepages);

/** Allocate \p len bytes memory of type \p m.
 *
 * @retval NULL If allocation failed.
 * @retval <>0  If allocation was successful.
 */
void * memory_alloc(struct memtype *m, size_t len);

void * memory_alloc_aligned(struct memtype *m, size_t len, size_t alignment);

int memory_free(struct memtype *m, void *ptr, size_t len);

struct memtype * memtype_managed_init(void *ptr, size_t len);

extern struct memtype memtype_heap;
extern struct memtype memtype_hugepage;