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