introduce-linux-ia64-port-20010806
[openafs.git] / src / afs / LINUX / osi_alloc.c
1 /*
2  * Copyright 2000, International Business Machines Corporation and others.
3  * All Rights Reserved.
4  * 
5  * This software has been released under the terms of the IBM Public
6  * License.  For details, see the LICENSE file in the top-level source
7  * directory or online at http://www.openafs.org/dl/license10.html
8  */
9
10 /*
11  * osi_alloc.c - Linux memory allocation routines.
12  *
13  */
14 #include <afsconfig.h>
15 #include "../afs/param.h"
16
17 RCSID("$Header$");
18
19 #include "../afs/sysincludes.h"
20 #include "../afs/afsincludes.h"
21 #include "../h/mm.h"
22 #include "../h/slab.h"
23
24 #include "../afs/afs_atomlist.h"
25 #include "../afs/afs_lhash.h"
26
27 #define MAX_KMALLOC_SIZE (131072-16) /* Max we can alloc in physmem */
28 #define MAX_BUCKET_LEN 30 /* max. no. of entries per buckets we expect to see */
29 #define STAT_INTERVAL 8192 /* we collect stats once every STAT_INTERVAL allocs*/
30
31 /* types of alloc */
32 #define KM_TYPE 1        /* kmalloc */
33 #define VM_TYPE 2        /* vmalloc */
34
35 struct osi_linux_mem {
36     void *chunk;
37 };
38
39 /* These assume 32-bit pointers */
40 #define MEMTYPE(A) (((unsigned long)A) & 0x3)
41 #define MEMADDR(A) (void *)((unsigned long)(A) & (~0x3))
42
43 /* globals */
44 afs_atomlist *al_mem_pool; /* pool of osi_linux_mem structures */
45 afs_lhash    *lh_mem_htab; /* mem hash table */
46 unsigned int allocator_init = 0; /* has the allocator been initialized? */
47 unsigned int afs_linux_cur_allocs = 0;
48 unsigned int afs_linux_total_allocs = 0;
49 unsigned int afs_linux_hash_verify_count = 0; /* used by hash_verify */
50 struct afs_lhash_stat afs_linux_lsb; /* hash table statistics */
51 unsigned int afs_linux_hash_bucket_dist[MAX_BUCKET_LEN]; /* bucket population distribution in our hash table */
52
53 #if defined(AFS_LINUX24_ENV)
54 #include "../h/vmalloc.h"
55 #else
56 /* externs : can we do this in a better way. Including vmalloc.h causes other
57  * problems.*/
58 extern void vfree(void * addr);
59 extern void *vmalloc(unsigned long size);
60 #endif
61
62 /* Allocator support functions (static) */
63
64 static int hash_equal(const void *a, const void *b) 
65 {
66     return ( MEMADDR(((struct osi_linux_mem *)a)->chunk) == 
67             MEMADDR(((struct osi_linux_mem *)b)->chunk) );
68
69 }
70
71 /* linux_alloc : Allocates memory from the linux kernel. It uses 
72  *               kmalloc if possible. Otherwise, we use vmalloc. 
73  * Input:
74  *  asize - size of memory required in bytes
75  * Return Values:
76  *  returns NULL if we failed to allocate memory.
77  *  or pointer to memory if we succeeded.
78  */
79 static void *linux_alloc(unsigned int asize)
80 {
81     void *new = NULL;
82     int has_afs_glock = ISAFS_GLOCK();
83
84     /* if global lock has been held save this info and unlock it. */
85     if (has_afs_glock)
86         AFS_GUNLOCK();
87
88     /*  if we can use kmalloc use it to allocate the required memory. */
89     if (asize <  MAX_KMALLOC_SIZE) {
90         new = (void *)(unsigned long)kmalloc(asize, GFP_KERNEL);
91         if (new) /* piggy back alloc type */
92             (unsigned long)new |= KM_TYPE;
93     }
94     if (!new) { /* otherwise use vmalloc  */
95         int max_wait = 10;
96         while (!(new = (void *)vmalloc(asize))) {
97             if (--max_wait <=0) {
98                 break;
99             }
100             schedule();
101         }
102         if (new) /* piggy back alloc type */
103             (unsigned long)new |= VM_TYPE;
104     }
105     if (new)
106         memset(MEMADDR(new), 0, asize);
107
108     /* if the global lock had been held, lock it again. */
109     if (has_afs_glock)
110         AFS_GLOCK();
111
112     return new;
113 }
114
115 static void linux_free(void *p)
116 {
117     
118     /* mask out the type information from the pointer and
119      *  use the appropriate free routine to free the chunk.
120      */
121     switch(MEMTYPE(p)) {
122       case KM_TYPE:
123         kfree(MEMADDR(p));
124         break;
125       case VM_TYPE:
126         vfree(MEMADDR(p));
127         break;
128       default:
129         printf("afs_osi_Free: Asked to free unknown type %d at 0x%x\n",
130                MEMTYPE(p), MEMADDR(p));
131         break;
132     }
133
134 }
135
136 /* hash_chunk() receives a pointer to a chunk and hashes it to produce a
137  *            key that the hashtable can use. The key is obtained by 
138  *            right shifting out the 2 LSBs and then multiplying the
139  *            result by a constant no. and dividing it with a large prime.
140  */
141 #define HASH_CONST   32786
142 #define HASH_PRIME   79367
143 static unsigned hash_chunk(void *p)
144 {
145     unsigned int key;
146
147     key = (unsigned int)(long)p >> 2;
148     key = (key * HASH_CONST)%HASH_PRIME;
149
150     return key;
151 }
152
153 /* hash_free() : Invoked by osi_linux_free_afs_memory(), thru 
154  *          afs_lhash_iter(), this function is called by the lhash
155  *          module for every entry in the hash table. hash_free
156  *          frees the memory associated with the entry as well
157  *          as returning the osi_linux_mem struct to its pool.
158  */
159 static void
160 hash_free(size_t index, unsigned key, void *data)
161 {
162     linux_free(((struct osi_linux_mem *)data)->chunk);
163     afs_atomlist_put(al_mem_pool, data);
164 }
165
166 /* hash_verify() is invoked by osi_linux_verify_alloced_memory() thru
167  *   afs_lhash_iter() and is called by the lhash module for every element
168  *   in the hash table. 
169  *  hash_verify() verifies (within limits) that the memory passed to it is
170  *  valid.
171  */
172 static void
173 hash_verify(size_t index, unsigned key, void *data)
174 {
175     struct osi_linux_mem *lmp = (struct osi_linux_mem *)data;
176     int memtype;
177
178     memtype = MEMTYPE(lmp->chunk);
179     if ((memtype == KM_TYPE) && (AFS_LINUX_MAP_NR(lmp->chunk) > max_mapnr)) {
180         printf("osi_linux_verify_alloced_memory: address 0x%x outside range, index=%d, key=%d\n", lmp->chunk, index, key);
181     }
182     
183     if (memtype != KM_TYPE && memtype != VM_TYPE) {
184         printf("osi_linux_verify_alloced_memory: unknown type %d at 0x%x, index=%d\n",    memtype, lmp->chunk, index);
185     }
186     afs_linux_hash_verify_count++;
187 }
188
189
190 /* local_free() : wrapper for vfree(), to deal with incompatible protoypes */
191 static void local_free(void *p, size_t n)
192 {
193     vfree(p);
194 }
195
196 /* linux_alloc_init(): Initializes the kernel memory allocator. As part
197  *    of this process, it also initializes a pool of osi_linux_mem
198  *    structures as well as the hash table itself.
199  *  Return values:
200  *    0 - failure
201  *    1 - success
202  */
203 static int linux_alloc_init()
204 {
205     /* initiate our pool of osi_linux_mem structs */
206     al_mem_pool = afs_atomlist_create(sizeof(struct osi_linux_mem),
207                                       sizeof(long)*1024, (void *)vmalloc, 
208                                       local_free);
209     if (!al_mem_pool) {
210         printf("afs_osi_Alloc: Error in initialization(atomlist_create)\n");
211         return 0;
212     }
213
214     /* initialize the hash table to hold references to alloc'ed chunks */
215     lh_mem_htab = afs_lhash_create(hash_equal, (void *)vmalloc, local_free);
216     if (!lh_mem_htab) {
217         printf("afs_osi_Alloc: Error in initialization(lhash_create)\n");
218         return 0;
219     }
220     
221     return 1;
222     
223 }
224
225 /* hash_bucket_stat() : Counts the no. of elements in each bucket and
226  *   stores results in our bucket stats vector.
227  */
228 static unsigned int cur_bucket, cur_bucket_len;
229 static void hash_bucket_stat(size_t index, unsigned key, void *data)
230 {
231     if (index == cur_bucket) { 
232         /* while still on the same bucket, inc len & return */
233         cur_bucket_len++;
234         return;
235     }
236     else { /* if we're on the next bucket, store the distribution */
237         if (cur_bucket_len < MAX_BUCKET_LEN)
238             afs_linux_hash_bucket_dist[cur_bucket_len]++;
239         else
240             printf("afs_get_hash_stats: Warning! exceeded max bucket len %d\n", cur_bucket_len);
241         cur_bucket = index;
242         cur_bucket_len = 1;
243     }
244 }
245 /* get_hash_stats() : get hash table statistics */
246 static void get_hash_stats()
247 {
248     int i;
249
250     afs_lhash_stat(lh_mem_htab, &afs_linux_lsb);
251
252     /* clear out the bucket stat vector */
253     for(i=0;i<MAX_BUCKET_LEN;i++, afs_linux_hash_bucket_dist[i]=0);
254     cur_bucket = cur_bucket_len = 00;
255
256     /* populate the bucket stat vector */
257     afs_lhash_iter(lh_mem_htab, hash_bucket_stat);
258 }
259
260 /************** Linux memory allocator interface functions **********/
261
262 #if defined(AFS_LINUX24_ENV)
263 DECLARE_MUTEX(afs_linux_alloc_sem);
264 #else
265 struct semaphore afs_linux_alloc_sem = MUTEX;
266 #endif
267
268 void *osi_linux_alloc(unsigned int asize)
269 {
270     void *new = NULL;
271     struct osi_linux_mem *lmem;
272
273     down(&afs_linux_alloc_sem);
274
275     if (allocator_init == 0) { /* allocator hasn't been initialized yet */
276         if (linux_alloc_init() == 0) {
277             goto error;
278          }
279         allocator_init = 1; /* initialization complete */
280     }
281
282     new = linux_alloc(asize); /* get a chunk of memory of size asize */
283     if (!new) {
284         printf("afs_osi_Alloc: Can't vmalloc %d bytes.\n", asize);
285         goto error;
286     }
287     
288     /* get an atom to store the pointer to the chunk */
289     lmem = (struct osi_linux_mem *)afs_atomlist_get(al_mem_pool);
290     if (!lmem) {
291         printf("afs_osi_Alloc: atomlist_get() failed.");
292         goto free_error;
293     }
294     /* store the chunk reference */
295     lmem->chunk = new;
296
297     /* hash in the chunk */
298     if (afs_lhash_enter(lh_mem_htab, hash_chunk(new), lmem) != 0) {
299         printf("afs_osi_Alloc: lhash_enter failed\n");
300         goto free_error;
301     }
302     afs_linux_cur_allocs++;   /* no. of current allocations */
303     afs_linux_total_allocs++; /* total no. of allocations done so far */
304     if ((afs_linux_cur_allocs % STAT_INTERVAL) == 0) {
305         get_hash_stats();
306     }
307   error:
308     up(&afs_linux_alloc_sem);
309     return MEMADDR(new);
310
311   free_error:
312     if (new)
313         linux_free(new);
314     new = NULL;
315     goto error;
316
317     
318 }
319
320 /* osi_linux_free() - free chunk of memory passed to us.
321  */
322 void osi_linux_free(void *addr)
323 {
324     struct osi_linux_mem lmem, *lmp;
325
326     down(&afs_linux_alloc_sem);
327     
328     lmem.chunk = addr;
329     /* remove this chunk from our hash table */
330     if ( lmp = (struct osi_linux_mem *)afs_lhash_remove(lh_mem_htab, hash_chunk(addr), &lmem)) {
331         linux_free(lmp->chunk); /* this contains the piggybacked type info*/
332         afs_atomlist_put(al_mem_pool, lmp); /* return osi_linux_mem struct to pool*/
333         afs_linux_cur_allocs--;
334     }
335     else   {
336         printf("osi_linux_free: failed to remove chunk from hashtable\n");
337     }
338
339     up(&afs_linux_alloc_sem);
340 }
341
342 /* osi_linux_free_afs_memory() - free all chunks of memory allocated.
343  */
344 void osi_linux_free_afs_memory(void)
345 {
346     down(&afs_linux_alloc_sem);
347
348     if (allocator_init) {
349         /* iterate through all elements in the hash table and free both 
350          * the chunk and the atom associated with it.
351          */
352         afs_lhash_iter(lh_mem_htab, hash_free);
353
354         /*  free the atomlist. */
355         afs_atomlist_destroy(al_mem_pool);
356
357         /* free the hashlist. */
358         afs_lhash_destroy(lh_mem_htab);
359         
360         /* change the state so that the allocator is now uninitialized. */
361         allocator_init = 0;
362     }
363     up(&afs_linux_alloc_sem);    
364 }
365
366 /* osi_linux_verify_alloced_memory(): verify all chunks of alloced memory in
367  *          our hash table.
368  */
369 void osi_linux_verify_alloced_memory()
370 {
371     down(&afs_linux_alloc_sem);
372     
373     /* count of times hash_verify was called. reset it to 0 before iteration */
374     afs_linux_hash_verify_count = 0;
375
376     /* iterate thru elements in the hash table */
377     afs_lhash_iter(lh_mem_htab, hash_verify);
378
379     if (afs_linux_hash_verify_count != afs_linux_cur_allocs) {
380         /* hmm, some pieces of memory are missing. */
381         printf("osi_linux_verify_alloced_memory: %d chunks of memory are not accounted for during verify!\n", afs_linux_hash_verify_count - afs_linux_cur_allocs);
382     }
383
384     up(&afs_linux_alloc_sem);
385     return;
386 }
387