Merge branch 'charm' of charmgit:charm into isomalloc
[charm.git] / src / arch / util / mempool.c
1
2 /** 
3
4 Memory pool implementation , It is only good for Charm++ usage. The first 64 bytes provides additional information. sizeof(int)- size of this block(free or allocated), next gni_mem_handle_t, then void** point to the next available block. 
5
6 Written by Yanhua Sun 08-27-2011
7 Generalized by Gengbin Zheng  10/5/2011
8
9 */
10
11 #define MEMPOOL_DEBUG   0
12
13 #define POOLS_NUM       2
14 #define MAX_INT        2147483647
15
16 #include "converse.h"
17
18 #include <stdio.h>
19 #include <stdlib.h>
20 #include <string.h>
21 #if CMK_HAS_MALLOC_H
22 #include <malloc.h>
23 #endif
24
25 #include "mempool.h"
26
27 #if USE_MEMPOOL_ISOMALLOC
28 static      size_t     expand_mem = 1024*16;
29 #else
30 static      size_t     expand_mem = 1024ll*1024*16;
31 #endif 
32
33 mempool_type *mempool_init(size_t pool_size, mempool_newblockfn allocfn, mempool_freeblock freefn)
34 {
35     mempool_type *mptr;
36     mempool_header *header;
37     gni_mem_handle_t  mem_hndl;
38
39     void *pool = allocfn(&pool_size, &mem_hndl);
40     mptr = (mempool_type*)pool;
41     mptr->newblockfn = allocfn;
42     mptr->freeblockfn = freefn;
43     mptr->mempools_head.mempool_ptr = pool;
44     mptr->mempools_head.mem_hndl = mem_hndl;
45     mptr->mempools_head.size = pool_size;
46     mptr->mempools_head.next = NULL;
47     header = (mempool_header *) ((char*)pool+sizeof(mempool_type));
48     mptr->freelist_head = sizeof(mempool_type);
49     header->size = pool_size-sizeof(mempool_type)-sizeof(mempool_header);
50     header->mem_hndl = mem_hndl;
51     header->next_free = 0;
52 #if MEMPOOL_DEBUG 
53     printf("[%d] Initiated pool of size %lld at %p\n",CmiMyPe(),pool_size,mptr);
54 #endif
55     return mptr;
56 }
57
58 void mempool_destroy(mempool_type *mptr)
59 {
60     mempool_block *current, *mempools_head;
61     mempool_freeblock   freefn = mptr->freeblockfn;
62
63     current = mempools_head = &(mptr->mempools_head);
64
65     while(mempools_head!= NULL)
66     {
67         current=mempools_head;
68         mempools_head = mempools_head->next;
69         freefn(current->mempool_ptr, current->mem_hndl);
70     }
71 }
72
73 // append size before the real memory buffer
74 void*  mempool_malloc(mempool_type *mptr, int size, int expand)
75 {
76     int     bestfit_size = MAX_INT; //most close size 
77     size_t    *freelist_head = &mptr->freelist_head;
78     mempool_header    *freelist_head_ptr = mptr->freelist_head?(mempool_header*)((char*)mptr+mptr->freelist_head):NULL;
79     mempool_header    *current = freelist_head_ptr;
80     mempool_header    *previous = NULL;
81     mempool_header    *bestfit = NULL;
82     mempool_header    *bestfit_previous = NULL;
83     mempool_block     *mempools_head = &(mptr->mempools_head);
84
85 #if  MEMPOOL_DEBUG
86     CmiPrintf("[%d] request malloc from pool: %p  free_head: %p %d for size %d, \n", CmiMyPe(), mptr, freelist_head_ptr, mptr->freelist_head, size);
87 #endif
88
89     size += sizeof(mempool_header);
90
91 #if 1
92     while(current!= NULL)     /* best fit */
93     {
94 #if  MEMPOOL_DEBUG
95         CmiPrintf("[%d] current=%p size:%d \n", CmiMyPe(), current, current->size);
96 #endif
97         if(current->size >= size && current->size < bestfit_size)
98         {
99             bestfit_size = current->size;
100             bestfit = current;
101             bestfit_previous = previous;
102         }
103         previous = current;
104         current = current->next_free?(mempool_header*)((char*)mptr + current->next_free):NULL;
105     }
106 #else
107     while(current!= NULL)             /*  first fit */
108     {
109 #if  MEMPOOL_DEBUG
110         CmiPrintf("[%d] current=%p size:%d ->%p \n", CmiMyPe(), current, current->size, (char*)current+current->size);
111 #endif
112         CmiAssert(current->size != 0);
113         if(current->size >= size)
114         {
115             bestfit_size = current->size;
116             bestfit = current;
117             bestfit_previous = previous;
118             break;
119         }
120         previous = current;
121         current = current->next_free?(mempool_header*)((char*)mptr + current->next_free):NULL;
122     }
123 #endif
124
125     if(bestfit == NULL)
126     {
127 #if MEMPOOL_DEBUG 
128         printf("[%d] Expanding pool %p by %d\n",CmiMyPe(),mptr,CthSelf());
129 #endif
130         void *pool;
131         mempool_block   *expand_pool;
132         size_t   expand_size;
133         gni_mem_handle_t  mem_hndl;
134
135         if (!expand) return NULL;
136
137         expand_size = expand_mem>size ? expand_mem:2*size; 
138         pool = mptr->newblockfn(&expand_size, &mem_hndl);
139         expand_pool = (mempool_block*)pool;
140         expand_pool->mempool_ptr = pool;
141         expand_pool->mem_hndl = mem_hndl;
142         expand_pool->size = expand_size;
143         expand_pool->next = NULL;
144 #if  MEMPOOL_DEBUG
145         printf("[%d] No memory has such free empty chunck of %d. expanding %p with new size %d\n", CmiMyPe(), size, expand_pool->mempool_ptr, expand_size);
146 #endif
147         // FIXME: go to the end of link list
148         while (mempools_head->next != NULL) mempools_head = mempools_head->next;
149         mempools_head->next = expand_pool;
150
151         bestfit = (mempool_header*)((char*)expand_pool->mempool_ptr + sizeof(mempool_block));
152         bestfit->size = expand_size-sizeof(mempool_block);
153         bestfit->mem_hndl = expand_pool->mem_hndl;
154         bestfit->next_free = 0;
155         bestfit_size = expand_size-sizeof(mempool_block);
156 #if 0
157         current = freelist_head;
158         while(current!= NULL && current < bestfit )
159         {
160           previous = current;
161           current = current->next;
162         }
163 #else
164         CmiAssert(bestfit > previous);
165 #endif
166         bestfit_previous = previous;
167         if (previous == NULL) {
168            *freelist_head = (char*)bestfit - (char*)mptr;
169            freelist_head_ptr =  bestfit;
170         }
171         else
172            previous->next_free = (char*)bestfit-(char*)mptr;
173     }
174
175     bestfit->size = size;
176     if(bestfit_size > size + sizeof(mempool_header)) //deduct this entry 
177     {
178         mempool_header *ptr = (mempool_header *)((char*)bestfit + size);
179         ptr->size = bestfit_size - size;
180         ptr->mem_hndl = bestfit->mem_hndl;
181         ptr->next_free = bestfit->next_free;
182         if(bestfit == freelist_head_ptr)
183            *freelist_head = (char*)ptr - (char*)mptr;
184         if(bestfit_previous != NULL)
185            bestfit_previous->next_free = (char*)ptr - (char*)mptr;
186     }
187     else {  
188           //delete this free entry
189         if (bestfit_size > size) {
190            bestfit->size = bestfit_size;
191         }
192         if(bestfit == freelist_head_ptr)
193             *freelist_head = freelist_head_ptr->next_free;
194         else
195             bestfit_previous->next_free = bestfit->next_free;
196     }
197 #if  MEMPOOL_DEBUG
198     printf("[%d] ++MALLOC served: %d, ptr:%p\n", CmiMyPe(), size, bestfit);
199 printf("[%d] freelist_head in malloc  offset:%d free_head: %ld %ld %d %d\n", myrank, (char*)bestfit-(char*)mptr, *freelist_head, ((mempool_header*)((char*)mptr+*freelist_head))->next_free, bestfit_size, size);
200 #endif
201     CmiAssert(*freelist_head >= 0);
202     return (char*)bestfit + sizeof(mempool_header);
203 }
204
205 //sorted free_list and merge it if it become continous 
206 void mempool_free(mempool_type *mptr, void *ptr_free)
207 {
208     int i;
209     int merged = 0;
210     int free_size;
211     void *free_lastbytes_pos;
212     mempool_block     *mempools_head;
213     size_t    *freelist_head;
214     mempool_header    *freelist_head_ptr;
215     mempool_header    *current;
216     mempool_header *previous = NULL;
217     mempool_header *to_free;
218
219     to_free = (mempool_header *)((char*)ptr_free - sizeof(mempool_header));
220
221     mempools_head = &(mptr->mempools_head);
222     freelist_head = &mptr->freelist_head;
223     freelist_head_ptr = mptr->freelist_head?(mempool_header*)((char*)mptr+mptr->freelist_head):NULL;
224     current = freelist_head_ptr;
225
226     free_size = to_free->size;
227     free_lastbytes_pos = (char*)to_free +free_size;
228
229 #if  MEMPOOL_DEBUG
230     printf("[%d] INSIDE FREE ptr=%p, size=%d freehead=%p mutex: %p\n", CmiMyPe(), to_free, free_size, freelist_head, mptr->mutex);
231 #endif
232     
233     while(current!= NULL && current < to_free )
234     {
235 #if  MEMPOOL_DEBUG
236         CmiPrintf("[%d] previous=%p, current=%p size:%d %p\n", CmiMyPe(), previous, current, current->size, (char*)current+current->size);
237 #endif
238         previous = current;
239         current = current->next_free?(mempool_header*)((char*)mptr + current->next_free):NULL;
240     }
241 #if  MEMPOOL_DEBUG
242     if (current) CmiPrintf("[%d] previous=%p, current=%p size:%d %p\n", CmiMyPe(), previous, current, current->size, free_lastbytes_pos);
243 #endif
244     //continuos with previous free space 
245     if(previous!= NULL && (char*)previous+previous->size == to_free &&  memcmp(&previous->mem_hndl, &to_free->mem_hndl, sizeof(gni_mem_handle_t))==0 )
246     {
247         previous->size +=  free_size;
248         merged = 1;
249     }
250     else if(current!= NULL && free_lastbytes_pos == current && memcmp(&current->mem_hndl, &to_free->mem_hndl, sizeof(gni_mem_handle_t))==0)
251     {
252         to_free->size += current->size;
253         to_free->next_free = current->next_free;
254         current = to_free;
255         merged = 1;
256         if(previous == NULL)
257             *freelist_head = (char*)current - (char*)mptr;
258         else
259             previous->next_free = (char*)to_free - (char*)mptr;
260     }
261     //continous, merge
262     if(merged) {
263        if (previous!= NULL && current!= NULL && (char*)previous + previous->size  == (char *)current && memcmp(&previous->mem_hndl, &current->mem_hndl, sizeof(gni_mem_handle_t))==0)
264       {
265          previous->size += current->size;
266          previous->next_free = current->next_free;
267       }
268     }
269     else {
270           // no merge to previous, current, create new entry
271         to_free->next_free = current?(char*)current - (char*)mptr: 0;
272         if(previous == NULL)
273             *freelist_head = (char*)to_free - (char*)mptr;
274         else
275             previous->next_free = (char*)to_free - (char*)mptr;
276     }
277 #if  MEMPOOL_DEBUG
278     printf("[%d] Memory free done %p, freelist_head=%p\n", CmiMyPe(), to_free,  freelist_head);
279 #endif
280
281     CmiAssert(*freelist_head >= 0);
282 }
283