2 * ircd-ratbox: A slightly useful ircd.
3 * balloc.c: A block allocator.
5 * Copyright (C) 1990 Jarkko Oikarinen and University of Oulu, Co Center
6 * Copyright (C) 1996-2002 Hybrid Development Team
7 * Copyright (C) 2002-2006 ircd-ratbox development team
9 * Below are the orignal headers from the old blalloc.c
12 * Owner: Wohali (Joan Touzet)
14 * Modified 2001/11/29 for mmap() support by Aaron Sethman <androsyn@ratbox.org>
16 * This program is free software; you can redistribute it and/or modify
17 * it under the terms of the GNU General Public License as published by
18 * the Free Software Foundation; either version 2 of the License, or
19 * (at your option) any later version.
21 * This program is distributed in the hope that it will be useful,
22 * but WITHOUT ANY WARRANTY; without even the implied warranty of
23 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 * GNU General Public License for more details.
26 * You should have received a copy of the GNU General Public License
27 * along with this program; if not, write to the Free Software
28 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
31 * $Id: balloc.c 26100 2008-09-20 01:27:19Z androsyn $
35 * About the block allocator
37 * Basically we have three ways of getting memory off of the operating
38 * system. Below are this list of methods and the order of preference.
40 * 1. mmap() anonymous pages with the MMAP_ANON flag.
41 * 2. mmap() via the /dev/zero trick.
42 * 3. HeapCreate/HeapAlloc (on win32)
45 * The advantages of 1 and 2 are this. We can munmap() the pages which will
46 * return the pages back to the operating system, thus reducing the size
47 * of the process as the memory is unused. malloc() on many systems just keeps
48 * a heap of memory to itself, which never gets given back to the OS, except on
49 * exit. This of course is bad, if say we have an event that causes us to allocate
50 * say, 200MB of memory, while our normal memory consumption would be 15MB. In the
51 * malloc() case, the amount of memory allocated to our process never goes down, as
52 * malloc() has it locked up in its heap. With the mmap() method, we can munmap()
53 * the block and return it back to the OS, thus causing our memory consumption to go
54 * down after we no longer need it.
59 #include <librb_config.h>
62 static uintptr_t offset_pad
;
64 /* status information for an allocated block in heap */
69 unsigned long free_count
;
70 void *elems
; /* Points to allocated memory */
72 typedef struct rb_heap_block rb_heap_block
;
74 /* information for the root node of the heap */
78 size_t elemSize
; /* Size of each element to be stored */
79 unsigned long elemsPerBlock
; /* Number of elements per block */
80 rb_dlink_list block_list
;
81 rb_dlink_list free_list
;
85 static rb_dlink_list
*heap_lists
;
87 #define rb_bh_fail(x) _rb_bh_fail(x, __FILE__, __LINE__)
90 _rb_bh_fail(const char *reason
, const char *file
, int line
)
92 rb_lib_log("rb_heap_blockheap failure: %s (%s:%d)", reason
, file
, line
);
97 * void rb_init_bh(void)
101 * Side Effects: Initializes the block heap
107 heap_lists
= rb_malloc(sizeof(rb_dlink_list
));
108 offset_pad
= sizeof(void *);
109 /* XXX if you get SIGBUS when trying to use a long long..here is where you need to
113 if((offset_pad
% __alignof__(long long)) != 0)
115 offset_pad
+= __alignof__(long long);
116 offset_pad
&= ~(__alignof__(long long) - 1);
121 /* ************************************************************************ */
122 /* FUNCTION DOCUMENTATION: */
125 /* Creates a new blockheap from which smaller blocks can be allocated. */
126 /* Intended to be used instead of multiple calls to malloc() when */
127 /* performance is an issue. */
129 /* elemsize (IN): Size of the basic element to be stored */
130 /* elemsperblock (IN): Number of elements to be stored in a single block */
131 /* of memory. When the blockheap runs out of free memory, it will */
132 /* allocate elemsize * elemsperblock more. */
134 /* Pointer to new rb_bh, or NULL if unsuccessful */
135 /* ************************************************************************ */
137 rb_bh_create(size_t elemsize
, int elemsperblock
, const char *desc
)
140 lrb_assert(elemsize
> 0 && elemsperblock
> 0);
141 lrb_assert(elemsize
>= sizeof(rb_dlink_node
));
143 /* Catch idiotic requests up front */
144 if((elemsize
== 0) || (elemsperblock
<= 0))
146 rb_bh_fail("Attempting to rb_bh_create idiotic sizes");
149 if(elemsize
< sizeof(rb_dlink_node
))
150 rb_bh_fail("Attempt to rb_bh_create smaller than sizeof(rb_dlink_node)");
152 /* Allocate our new rb_bh */
153 bh
= rb_malloc(sizeof(rb_bh
));
154 bh
->elemSize
= elemsize
;
155 bh
->elemsPerBlock
= elemsperblock
;
157 bh
->desc
= rb_strdup(desc
);
161 rb_bh_fail("bh == NULL when it shouldn't be");
163 rb_dlinkAdd(bh
, &bh
->hlist
, heap_lists
);
167 /* ************************************************************************ */
168 /* FUNCTION DOCUMENTATION: */
171 /* Returns a pointer to a struct within our rb_bh that's free for */
174 /* bh (IN): Pointer to the Blockheap. */
176 /* Pointer to a structure (void *), or NULL if unsuccessful. */
177 /* ************************************************************************ */
180 rb_bh_alloc(rb_bh
*bh
)
182 lrb_assert(bh
!= NULL
);
183 if(rb_unlikely(bh
== NULL
))
185 rb_bh_fail("Cannot allocate if bh == NULL");
188 return (rb_malloc(bh
->elemSize
));
192 /* ************************************************************************ */
193 /* FUNCTION DOCUMENTATION: */
196 /* Returns an element to the free pool, does not free() */
198 /* bh (IN): Pointer to rb_bh containing element */
199 /* ptr (in): Pointer to element to be "freed" */
201 /* 0 if successful, 1 if element not contained within rb_bh. */
202 /* ************************************************************************ */
204 rb_bh_free(rb_bh
*bh
, void *ptr
)
206 lrb_assert(bh
!= NULL
);
207 lrb_assert(ptr
!= NULL
);
209 if(rb_unlikely(bh
== NULL
))
211 rb_lib_log("balloc.c:rb_bhFree() bh == NULL");
215 if(rb_unlikely(ptr
== NULL
))
217 rb_lib_log("balloc.rb_bhFree() ptr == NULL");
226 /* ************************************************************************ */
227 /* FUNCTION DOCUMENTATION: */
230 /* Completely free()s a rb_bh. Use for cleanup. */
232 /* bh (IN): Pointer to the rb_bh to be destroyed. */
234 /* 0 if successful, 1 if bh == NULL */
235 /* ************************************************************************ */
237 rb_bh_destroy(rb_bh
*bh
)
242 rb_dlinkDelete(&bh
->hlist
, heap_lists
);
250 rb_bh_usage(rb_bh
*bh
, size_t *bused
, size_t *bfree
, size_t *bmemusage
, const char **desc
)
256 if(bmemusage
!= NULL
)
259 *desc
= "no blockheap";
263 rb_bh_usage_all(rb_bh_usage_cb
*cb
, void *data
)
267 size_t used
, freem
, memusage
, heapalloc
;
268 static const char *unnamed
= "(unnamed_heap)";
269 const char *desc
= unnamed
;
274 RB_DLINK_FOREACH(ptr
, heap_lists
->head
)
276 bh
= (rb_bh
*)ptr
->data
;
277 freem
= rb_dlink_list_length(&bh
->free_list
);
278 used
= (rb_dlink_list_length(&bh
->block_list
) * bh
->elemsPerBlock
) - freem
;
279 memusage
= used
* bh
->elemSize
;
280 heapalloc
= (freem
+ used
) * bh
->elemSize
;
283 cb(used
, freem
, memusage
, heapalloc
, desc
, data
);
289 rb_bh_total_usage(size_t *total_alloc
, size_t *total_used
)
292 size_t total_memory
= 0, used_memory
= 0, used
, freem
;
295 RB_DLINK_FOREACH(ptr
, heap_lists
->head
)
297 bh
= (rb_bh
*)ptr
->data
;
298 freem
= rb_dlink_list_length(&bh
->free_list
);
299 used
= (rb_dlink_list_length(&bh
->block_list
) * bh
->elemsPerBlock
) - freem
;
300 used_memory
+= used
* bh
->elemSize
;
301 total_memory
+= (freem
+ used
) * bh
->elemSize
;
304 if(total_alloc
!= NULL
)
305 *total_alloc
= total_memory
;
306 if(total_used
!= NULL
)
307 *total_used
= used_memory
;