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