/*! \file
 * Provides functions for memory allocation.
 */
#ifndef MEMORY_H
#define MEMORY_H

#include <stdint.h>

typedef uint32_t size_t;

/*!
 * Initialize memory allocator with predefined memory region.
 * \param start Start of malloc memory region.
 * \param end End of malloc memory region.
 * \return Currently always 0.
 */
int malloc_init(void *start, void *end);

/*!
 * Allocates a block of \p size bytes of memory.
 * \param size Size in bytes of the requested block of memory.
 * \return Memory address to the new memory block, or NULL if failed
 */
void* malloc(size_t size);

/*!
 * Reallocates an already allocated block with new size.
 * Contents are preserved. Pointer might change.
 * Will fail if memory block at \p ptr has already been freed.
 * \param ptr Pointer to already allocated memory block
 * \param new_size Size of the new block
 * \return Memory address to the new memory block, or NULL if failed*/
void* realloc(void* ptr, size_t new_size);

/*!
 * Frees a previously allocated block of memory.
 * \param ptr Pointer to the memory block to be freed.
 */
void free(void* ptr);

#endif