ee013f41d4f69a2ed0863462ab100134abe13be3
[people/xl0/gpxe.git] / src / include / malloc.h
1 #ifndef _MALLOC_H
2 #define _MALLOC_H
3
4 #include <stdint.h>
5
6 /** @file
7  *
8  * Dynamic memory allocation
9  *
10  */
11
12 extern void * alloc_memblock ( size_t size, size_t align );
13 extern void free_memblock ( void *ptr, size_t size );
14 extern void * realloc ( void *old_ptr, size_t new_size );
15 extern void * malloc ( size_t size );
16 extern void free ( void *ptr );
17 extern void mpopulate ( void *start, size_t len );
18 extern void mdumpfree ( void );
19
20 /**
21  * Allocate memory for DMA
22  *
23  * @v size              Requested size
24  * @v align             Physical alignment
25  * @ret ptr             Memory, or NULL
26  *
27  * Allocates physically-aligned memory for DMA.
28  *
29  * @c align must be a power of two.  @c size may not be zero.
30  */
31 static inline void * malloc_dma ( size_t size, size_t phys_align ) {
32         return alloc_memblock ( size, phys_align );
33 }
34
35 /**
36  * Free memory allocated with malloc_dma()
37  *
38  * @v ptr               Memory allocated by malloc_dma(), or NULL
39  * @v size              Size of memory, as passed to malloc_dma()
40  *
41  * Memory allocated with malloc_dma() can only be freed with
42  * free_dma(); it cannot be freed with the standard free().
43  *
44  * If @c ptr is NULL, no action is taken.
45  */
46 static inline void free_dma ( void *ptr, size_t size ) {
47         free_memblock ( ptr, size );
48 }
49
50 /**
51  * Allocate cleared memory
52  *
53  * @v nmemb             Number of members
54  * @v size              Size of each member
55  * @ret ptr             Allocated memory
56  *
57  * Allocate memory as per malloc(), and zero it.
58  *
59  * Note that malloc() and calloc() are identical, in the interests of
60  * reducing code size.  Callers should not, however, rely on malloc()
61  * clearing memory, since this behaviour may change in future.
62  */
63 static inline void * calloc ( size_t nmemb, size_t size ) {
64         return malloc ( nmemb * size );
65 }
66
67 #endif /* _MALLOC_H */