56 lines
1.5 KiB
C
Raw Normal View History

2018-03-01 13:03:40 -05:00
/**
* @file heap.h
* A basic memory manager
2018-03-25 21:16:33 -04:00
*
* Copyright (C) 2018 Clyne Sullivan
*
* 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
* (at your option) 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 <https://www.gnu.org/licenses/>.
2018-03-01 13:03:40 -05:00
*/
2018-01-01 17:40:28 -05:00
#ifndef HEAP_H_
#define HEAP_H_
#include <stdint.h>
2018-01-01 17:40:28 -05:00
2018-03-01 13:03:40 -05:00
/**
* Initializes memory management of the given heap.
* No overflow stuff is done, so...
* @param buf the heap to use for allocations
*/
void heap_init(void *buf);
2018-01-01 17:40:28 -05:00
2018-03-01 13:03:40 -05:00
/**
* Allocates a chunk of memory.
* @param size how many bytes to claim
* @return pointer to the allocated buffer
*/
void *malloc(uint32_t size);
2018-03-01 13:03:40 -05:00
/**
* Allocates and zeros a chunk of memory.
* @param count how many of whatever to allocate
* @param size byte count of each whatever
* @return pointer to the allocated buffer
*/
void *calloc(uint32_t count, uint32_t size);
2018-03-01 13:03:40 -05:00
/**
* Frees the buffer allocated through malloc/calloc.
* Please don't double-free.
* @param the buffer to release
*/
void free(void *buf);
2018-01-01 17:40:28 -05:00
#endif // HEAP_H_