-
Notifications
You must be signed in to change notification settings - Fork 0
/
mavalloc.h
113 lines (94 loc) · 3.21 KB
/
mavalloc.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
/*
Amey Shinde
ID : 1001844387
First Fit, Next Fit , mavalloc_init , mavalloc_free
mavalloc_destroy, mavalloc_size work completely fine.
Issues with Best Fit and Worst Fit
*/
// The MIT License (MIT)
//
// Copyright (c) 2022 Trevor Bakker
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
#include <stddef.h>
#define ALIGN4(s) (((((s) - 1) >> 2) << 2) + 4)
enum ALGORITHM
{
FIRST_FIT = 0,
NEXT_FIT,
BEST_FIT,
WORST_FIT
};
/**
* @brief Initialize the allocation arena and set the algorithm type
*
* This function takes the provided size and calls malloc to allocate a
* memory arena. The size must be aligned to a word boundary.
*
* If the allocation succeeds it returns 0. If the allocation fails or the
* size is less than 0 the function returns -1
*
* \param size The size of the pool to allocate in bytes
* \param algorithm The heap algorithm to implement
* \return 0 on success. -1 on failure
**/
int mavalloc_init( size_t size, enum ALGORITHM algorithm );
/**
* @brief Destroy the arena
*
* This function releases the arena
*
* \return None
**/
void mavalloc_destroy( );
/**
* @brief Allocate memory from the arena
*
* This function allocated memory from the arena. The parameter size
* specifies the number of bytes to allocates. This _must_ be 4 byte aligned using the
* ALIGN4 macro.
*
* The function searches the arena for a free block using the heap allocation algorithm
* specified when the arena was allocated.
*
* If there is no available block of memory the function returns NULL
*
* \return A pointer to the available memory or NULL if no free block is found
**/
void * mavalloc_alloc( size_t size );
/*
* \brief free the pointer
*
* frees the memory block pointed to by pointer. if the block is adjacent
* to another block then coalesce (combine) them
*
* \param ptr the heap memory to free
*
* \return none
*/
void mavalloc_free(void *ptr);
/*
* \brief Allocator size
*
* Return the number of nodes in the allocators linked list
*
* \return The size of the allocator linked list
*/
int mavalloc_size( );