Merge branch 'charm' of charmgit:charm into charm
[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 static      size_t     expand_mem = 1024ll*1024*16;
28
29 mempool_type *mempool_init(size_t pool_size, mempool_newblockfn allocfn, mempool_freeblock freefn)
30 {
31     mempool_type *mptr;
32     mempool_header *header;
33     gni_mem_handle_t  mem_hndl;
34
35     void *pool = allocfn(pool_size, &mem_hndl);
36     mptr = (mempool_type*)pool;
37     mptr->newblockfn = allocfn;
38     mptr->freeblockfn = freefn;
39     mptr->mempools_head.mempool_ptr = pool;
40     mptr->mempools_head.mem_hndl = mem_hndl;
41     mptr->mempools_head.size = pool_size;
42     mptr->mempools_head.next = NULL;
43     header = (mempool_header *) ((char*)pool+sizeof(mempool_type));
44     mptr->freelist_head = sizeof(mempool_type);
45 //printf("[%d] pool: %p  free: %p\n", myrank, pool, header);
46     header->size = pool_size-sizeof(mempool_type)-sizeof(mempool_header);
47     header->mem_hndl = mem_hndl;
48     header->next_free = 0;
49     return mptr;
50 }
51
52 void mempool_destroy(mempool_type *mptr)
53 {
54     mempool_block *current, *mempools_head;
55     mempool_freeblock   freefn = mptr->freeblockfn;
56
57     current = mempools_head = &(mptr->mempools_head);
58
59     while(mempools_head!= NULL)
60     {
61         //printf("[%d] free mempool:%p\n", CmiMyPe(), mempools_head->mempool_ptr);
62         current=mempools_head;
63         mempools_head = mempools_head->next;
64         freefn(current->mempool_ptr, current->mem_hndl);
65     }
66 }
67
68 // append size before the real memory buffer
69 void*  mempool_malloc(mempool_type *mptr, int size, int expand)
70 {
71     int     bestfit_size = MAX_INT; //most close size 
72     size_t    *freelist_head = &mptr->freelist_head;
73     mempool_header    *freelist_head_ptr = mptr->freelist_head?(mempool_header*)((char*)mptr+mptr->freelist_head):NULL;
74     mempool_header    *current = freelist_head_ptr;
75     mempool_header    *previous = NULL;
76     mempool_header    *bestfit = NULL;
77     mempool_header    *bestfit_previous = NULL;
78     mempool_block     *mempools_head = &(mptr->mempools_head);
79
80 #if  MEMPOOL_DEBUG
81     CmiPrintf("[%d] request malloc from pool: %p  free_head: %p %d for size %d, \n", CmiMyPe(), mptr, freelist_head_ptr, mptr->freelist_head, size);
82 #endif
83
84 #if 1
85     while(current!= NULL)     /* best fit */
86     {
87 #if  MEMPOOL_DEBUG
88         CmiPrintf("[%d] current=%p size:%d \n", CmiMyPe(), current, current->size);
89 #endif
90         if(current->size >= size && current->size < bestfit_size)
91         {
92             bestfit_size = current->size;
93             bestfit = current;
94             bestfit_previous = previous;
95         }
96         previous = current;
97         current = current->next_free?(mempool_header*)((char*)mptr + current->next_free):NULL;
98     }
99 #else
100     while(current!= NULL)             /*  first fit */
101     {
102 #if  MEMPOOL_DEBUG
103         CmiPrintf("[%d] current=%p size:%d ->%p \n", CmiMyPe(), current, current->size, (char*)current+current->size);
104 #endif
105         CmiAssert(current->size != 0);
106         if(current->size >= size)
107         {
108             bestfit_size = current->size;
109             bestfit = current;
110             bestfit_previous = previous;
111             break;
112         }
113         previous = current;
114         current = current->next_free?(mempool_header*)((char*)mptr + current->next_free):NULL;
115     }
116 #endif
117
118     if(bestfit == NULL)
119     {
120         void *pool;
121         mempool_block   *expand_pool;
122         size_t   expand_size;
123         gni_mem_handle_t  mem_hndl;
124
125         if (!expand) return NULL;
126
127         expand_size = expand_mem>size ? expand_mem:2*size; 
128         pool = mptr->newblockfn(&expand_size, &mem_hndl);
129         expand_pool = (mempool_block*)pool;
130         expand_pool->mempool_ptr = pool;
131         expand_pool->mem_hndl = mem_hndl;
132         expand_pool->size = expand_size;
133         expand_pool->next = NULL;
134         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);
135           // FIXME: go to the end of link list
136         while (mempools_head->next != NULL) mempools_head = mempools_head->next;
137         mempools_head->next = expand_pool;
138
139         bestfit = (mempool_header*)((char*)expand_pool->mempool_ptr + sizeof(mempool_block));
140         bestfit->size = expand_size-sizeof(mempool_block);
141         bestfit->mem_hndl = expand_pool->mem_hndl;
142         bestfit->next_free = 0;
143         bestfit_size = expand_size-sizeof(mempool_block);
144 #if 0
145         current = freelist_head;
146         while(current!= NULL && current < bestfit )
147         {
148           previous = current;
149           current = current->next;
150         }
151 #else
152         CmiAssert(bestfit > previous);
153 #endif
154         bestfit_previous = previous;
155         if (previous == NULL) {
156            *freelist_head = (char*)bestfit - (char*)mptr;
157            freelist_head_ptr =  bestfit;
158         }
159         else
160            previous->next_free = (char*)bestfit-(char*)mptr;
161     }
162
163     bestfit->size = size;
164     if(bestfit_size > size + sizeof(mempool_header)) //deduct this entry 
165     {
166         mempool_header *ptr = (mempool_header *)((char*)bestfit + size);
167         ptr->size = bestfit_size - size;
168         ptr->mem_hndl = bestfit->mem_hndl;
169         ptr->next_free = bestfit->next_free;
170         if(bestfit == freelist_head_ptr)
171            *freelist_head = (char*)ptr - (char*)mptr;
172         if(bestfit_previous != NULL)
173            bestfit_previous->next_free = (char*)ptr - (char*)mptr;
174     }
175     else {  
176           //delete this free entry
177         if (bestfit_size > size) {
178            bestfit->size = bestfit_size;
179         }
180         if(bestfit == freelist_head_ptr)
181             *freelist_head = freelist_head_ptr->next_free;
182         else
183             bestfit_previous->next_free = bestfit->next_free;
184     }
185 #if  MEMPOOL_DEBUG
186     printf("[%d] ++MALLOC served: %d, ptr:%p\n", CmiMyPe(), size, bestfit);
187 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);
188 #endif
189     CmiAssert(*freelist_head >= 0);
190     return (char*)bestfit;
191 }
192
193 //sorted free_list and merge it if it become continous 
194 void mempool_free(mempool_type *mptr, void *ptr_free)
195 {
196     int i;
197     int merged = 0;
198     int free_size;
199     void *free_lastbytes_pos;
200     mempool_block     *mempools_head;
201     size_t    *freelist_head;
202     mempool_header    *freelist_head_ptr;
203     mempool_header    *current;
204     mempool_header *previous = NULL;
205     mempool_header *to_free = (mempool_header *)ptr_free;
206
207     mempools_head = &(mptr->mempools_head);
208     freelist_head = &mptr->freelist_head;
209     freelist_head_ptr = mptr->freelist_head?(mempool_header*)((char*)mptr+mptr->freelist_head):NULL;
210     current = freelist_head_ptr;
211
212     free_size = to_free->size;
213     free_lastbytes_pos = (char*)ptr_free +free_size;
214
215 #if  MEMPOOL_DEBUG
216     printf("[%d] INSIDE FREE ptr=%p, size=%d freehead=%p mutex: %p\n", CmiMyPe(), ptr_free, free_size, freelist_head, mptr->mutex);
217 #endif
218     
219     while(current!= NULL && current < to_free )
220     {
221 #if  MEMPOOL_DEBUG
222         CmiPrintf("[%d] previous=%p, current=%p size:%d %p\n", CmiMyPe(), previous, current, current->size, (char*)current+current->size);
223 #endif
224         previous = current;
225         current = current->next_free?(mempool_header*)((char*)mptr + current->next_free):NULL;
226     }
227 #if  MEMPOOL_DEBUG
228     if (current) CmiPrintf("[%d] previous=%p, current=%p size:%d %p\n", CmiMyPe(), previous, current, current->size, free_lastbytes_pos);
229 #endif
230     //continuos with previous free space 
231     if(previous!= NULL && (char*)previous+previous->size == ptr_free &&  memcmp(&previous->mem_hndl, &to_free->mem_hndl, sizeof(gni_mem_handle_t))==0 )
232     {
233         previous->size +=  free_size;
234         merged = 1;
235     }
236     else if(current!= NULL && free_lastbytes_pos == current && memcmp(&current->mem_hndl, &to_free->mem_hndl, sizeof(gni_mem_handle_t))==0)
237     {
238         to_free->size += current->size;
239         to_free->next_free = current->next_free;
240         current = to_free;
241         merged = 1;
242         if(previous == NULL)
243             *freelist_head = (char*)current - (char*)mptr;
244         else
245             previous->next_free = (char*)to_free - (char*)mptr;
246     }
247     //continous, merge
248     if(merged) {
249        if (previous!= NULL && current!= NULL && (char*)previous + previous->size  == (char *)current && memcmp(&previous->mem_hndl, &current->mem_hndl, sizeof(gni_mem_handle_t))==0)
250       {
251          previous->size += current->size;
252          previous->next_free = current->next_free;
253       }
254     }
255     else {
256           // no merge to previous, current, create new entry
257         to_free->next_free = current?(char*)current - (char*)mptr: 0;
258         if(previous == NULL)
259             *freelist_head = (char*)to_free - (char*)mptr;
260         else
261             previous->next_free = (char*)to_free - (char*)mptr;
262     }
263 #if  MEMPOOL_DEBUG
264     printf("[%d] Memory free done %p, freelist_head=%p\n", CmiMyPe(), ptr_free,  freelist_head);
265 #endif
266
267     CmiAssert(*freelist_head >= 0);
268 }
269