[malloc] Add cache discard mechanism
[gpxe.git] / src / include / gpxe / malloc.h
1 #ifndef _GPXE_MALLOC_H
2 #define _GPXE_MALLOC_H
3
4 #include <stdint.h>
5
6 /** @file
7  *
8  * Dynamic memory allocation
9  *
10  */
11
12 FILE_LICENCE ( GPL2_OR_LATER );
13
14 /*
15  * Prototypes for the standard functions (malloc() et al) are in
16  * stdlib.h.  Include <gpxe/malloc.h> only if you need the
17  * non-standard functions, such as malloc_dma().
18  *
19  */
20 #include <stdlib.h>
21 #include <gpxe/tables.h>
22
23 extern size_t freemem;
24
25 extern void * __malloc alloc_memblock ( size_t size, size_t align );
26 extern void free_memblock ( void *ptr, size_t size );
27 extern void mpopulate ( void *start, size_t len );
28 extern void mdumpfree ( void );
29
30 /**
31  * Allocate memory for DMA
32  *
33  * @v size              Requested size
34  * @v align             Physical alignment
35  * @ret ptr             Memory, or NULL
36  *
37  * Allocates physically-aligned memory for DMA.
38  *
39  * @c align must be a power of two.  @c size may not be zero.
40  */
41 static inline void * __malloc malloc_dma ( size_t size, size_t phys_align ) {
42         return alloc_memblock ( size, phys_align );
43 }
44
45 /**
46  * Free memory allocated with malloc_dma()
47  *
48  * @v ptr               Memory allocated by malloc_dma(), or NULL
49  * @v size              Size of memory, as passed to malloc_dma()
50  *
51  * Memory allocated with malloc_dma() can only be freed with
52  * free_dma(); it cannot be freed with the standard free().
53  *
54  * If @c ptr is NULL, no action is taken.
55  */
56 static inline void free_dma ( void *ptr, size_t size ) {
57         free_memblock ( ptr, size );
58 }
59
60 /** A cache discarder */
61 struct cache_discarder {
62         /**
63          * Discard some cached data
64          *
65          * @ret discarded       Number of cached items discarded
66          */
67         unsigned int ( * discard ) ( void );
68 };
69
70 /** Cache discarder table */
71 #define CACHE_DISCARDERS __table ( struct cache_discarder, "cache_discarders" )
72
73 /** Declare a cache discarder */
74 #define __cache_discarder __table_entry ( CACHE_DISCARDERS, 01 )
75
76 #endif /* _GPXE_MALLOC_H */