libcfs/include/libcfs/linux/linux-mem.h

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  *
   4  * GPL HEADER START
   5  *
   6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License version 2 only,
  10  * as published by the Free Software Foundation.
  11  *
  12  * This program is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * General Public License version 2 for more details (a copy is included
  16  * in the LICENSE file that accompanied this code).
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * version 2 along with this program; If not, see
  20  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
  21  *
  22  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  23  * CA 95054 USA or visit www.sun.com if you need additional information or
  24  * have any questions.
  25  *
  26  * GPL HEADER END
  27  */
  28 /*
  29  * Copyright  2008 Sun Microsystems, Inc. All rights reserved
  30  * Use is subject to license terms.
  31  */
  32 /*
  33  * This file is part of Lustre, http://www.lustre.org/
  34  * Lustre is a trademark of Sun Microsystems, Inc.
  35  *
  36  * libcfs/include/libcfs/linux/linux-mem.h
  37  *
  38  * Basic library routines.
  39  */
  40
  41 #ifndef __LIBCFS_LINUX_CFS_MEM_H__
  42 #define __LIBCFS_LINUX_CFS_MEM_H__
  43
  44 #ifndef __LIBCFS_LIBCFS_H__
  45 #error Do not #include this file directly. #include <libcfs/libcfs.h> instead
  46 #endif
  47
  48 #ifndef __KERNEL__
  49 #error This include is only for kernel use.
  50 #endif
  51
  52 #include <linux/mm.h>
  53 #include <linux/vmalloc.h>
  54 #include <linux/pagemap.h>
  55 #include <linux/slab.h>
  56 #ifdef HAVE_MM_INLINE
  57 # include <linux/mm_inline.h>
  58 #endif
  59
  60 typedef struct page                     cfs_page_t;
  61 #define CFS_PAGE_SIZE                   PAGE_CACHE_SIZE
  62 #define CFS_PAGE_SHIFT                  PAGE_CACHE_SHIFT
  63 #define CFS_PAGE_MASK                   (~((__u64)CFS_PAGE_SIZE-1))
  64
  65 static inline void *cfs_page_address(cfs_page_t *page)
  66 {
  67         /*
  68          * XXX nikita: do NOT call portals_debug_msg() (CDEBUG/ENTRY/EXIT)
  69          * from here: this will lead to infinite recursion.
  70          */
  71         return page_address(page);
  72 }
  73
  74 static inline void *cfs_kmap(cfs_page_t *page)
  75 {
  76         return kmap(page);
  77 }
  78
  79 static inline void cfs_kunmap(cfs_page_t *page)
  80 {
  81         kunmap(page);
  82 }
  83
  84 static inline void cfs_get_page(cfs_page_t *page)
  85 {
  86         get_page(page);
  87 }
  88
  89 static inline int cfs_page_count(cfs_page_t *page)
  90 {
  91         return page_count(page);
  92 }
  93
  94 #define cfs_page_index(p)       ((p)->index)
  95
  96 /*
  97  * Memory allocator
  98  * XXX Liang: move these declare to public file
  99  */
 100 extern void *cfs_alloc(size_t nr_bytes, u_int32_t flags);
 101 extern void  cfs_free(void *addr);
 102
 103 extern void *cfs_alloc_large(size_t nr_bytes);
 104 extern void  cfs_free_large(void *addr);
 105
 106 extern cfs_page_t *cfs_alloc_pages(unsigned int flags, unsigned int order);
 107 extern void __cfs_free_pages(cfs_page_t *page, unsigned int order);
 108
 109 #define cfs_alloc_page(flags)  cfs_alloc_pages(flags, 0)
 110 #define __cfs_free_page(page)  __cfs_free_pages(page, 0)
 111 #define cfs_free_page(p)       __free_pages(p, 0)
 112
 113 /*
 114  * In Linux there is no way to determine whether current execution context is
 115  * blockable.
 116  */
 117 #define CFS_ALLOC_ATOMIC_TRY   CFS_ALLOC_ATOMIC
 118
 119 /*
 120  * SLAB allocator
 121  * XXX Liang: move these declare to public file
 122  */
 123 #ifdef HAVE_KMEM_CACHE
 124 typedef struct kmem_cache cfs_mem_cache_t;
 125 #else
 126 typedef kmem_cache_t cfs_mem_cache_t;
 127 #endif
 128 extern cfs_mem_cache_t * cfs_mem_cache_create (const char *, size_t, size_t, unsigned long);
 129 extern int cfs_mem_cache_destroy ( cfs_mem_cache_t * );
 130 extern void *cfs_mem_cache_alloc ( cfs_mem_cache_t *, int);
 131 extern void cfs_mem_cache_free ( cfs_mem_cache_t *, void *);
 132
 133 /*
 134  */
 135 #define CFS_DECL_MMSPACE                mm_segment_t __oldfs
 136 #define CFS_MMSPACE_OPEN                do { __oldfs = get_fs(); set_fs(get_ds());} while(0)
 137 #define CFS_MMSPACE_CLOSE               set_fs(__oldfs)
 138
 139 #endif /* __LINUX_CFS_MEM_H__ */