libcfs/include/libcfs/user-mem.h

   1 #ifndef __LIBCFS_USER_MEM_H__
   2 #define __LIBCFS_USER_MEM_H__
   3
   4 #ifndef __LIBCFS_LIBCFS_H__
   5 #error Do not #include this file directly. #include <libcfs/libcfs.h> instead
   6 #endif
   7
   8 #ifdef __KERNEL__
   9 #error "This is only for user space."
  10 #endif
  11
  12
  13 /* XXX
  14  * for this moment, liblusre will not rely OST for non-page-aligned write
  15  */
  16 #define LIBLUSTRE_HANDLE_UNALIGNED_PAGE
  17
  18 typedef struct page {
  19         void   *addr;
  20         unsigned long index;
  21         cfs_list_t list;
  22         unsigned long private;
  23
  24         /* internally used by liblustre file i/o */
  25         int     _offset;
  26         int     _count;
  27 #ifdef LIBLUSTRE_HANDLE_UNALIGNED_PAGE
  28         int     _managed;
  29 #endif
  30         cfs_list_t _node;
  31 } cfs_page_t;
  32
  33
  34 /* 4K */
  35 #define CFS_PAGE_SHIFT 12
  36 #define CFS_PAGE_SIZE (1UL << CFS_PAGE_SHIFT)
  37 #define CFS_PAGE_MASK (~((__u64)CFS_PAGE_SIZE-1))
  38
  39 cfs_page_t *cfs_alloc_pages(int mask, unsigned long order);
  40 void cfs_free_pages(cfs_page_t *pg, int what);
  41 cfs_page_t *cfs_alloc_page(unsigned int flags);
  42 void cfs_free_page(cfs_page_t *pg);
  43 void *cfs_page_address(cfs_page_t *pg);
  44 void *cfs_kmap(cfs_page_t *pg);
  45 void cfs_kunmap(cfs_page_t *pg);
  46
  47 #define __cfs_free_pages(pg, what) cfs_free_pages((pg), (what))
  48
  49 #define cfs_get_page(p)                 __I_should_not_be_called__(at_all)
  50 #define cfs_page_count(p)               __I_should_not_be_called__(at_all)
  51 #define cfs_page_index(p)               ((p)->index)
  52 #define cfs_page_pin(page) do {} while (0)
  53 #define cfs_page_unpin(page) do {} while (0)
  54
  55 /*
  56  * Memory allocator
  57  * Inline function, so utils can use them without linking of libcfs
  58  */
  59 #define __ALLOC_ZERO    (1 << 2)
  60 static inline void *cfs_alloc(size_t nr_bytes, u_int32_t flags)
  61 {
  62         void *result;
  63
  64         result = malloc(nr_bytes);
  65         if (result != NULL && (flags & __ALLOC_ZERO))
  66                 memset(result, 0, nr_bytes);
  67         return result;
  68 }
  69
  70 #define cfs_free(addr)  free(addr)
  71 #define cfs_alloc_large(nr_bytes) cfs_alloc(nr_bytes, 0)
  72 #define cfs_free_large(addr) cfs_free(addr)
  73
  74 #define CFS_ALLOC_ATOMIC_TRY   (0)
  75 /*
  76  * SLAB allocator
  77  */
  78 typedef struct {
  79          int size;
  80 } cfs_mem_cache_t;
  81
  82 #define CFS_SLAB_HWCACHE_ALIGN 0
  83 #define CFS_SLAB_DESTROY_BY_RCU 0
  84 #define CFS_SLAB_KERNEL 0
  85 #define CFS_SLAB_NOFS 0
  86
  87 cfs_mem_cache_t *
  88 cfs_mem_cache_create(const char *, size_t, size_t, unsigned long);
  89 int cfs_mem_cache_destroy(cfs_mem_cache_t *c);
  90 void *cfs_mem_cache_alloc(cfs_mem_cache_t *c, int gfp);
  91 void cfs_mem_cache_free(cfs_mem_cache_t *c, void *addr);
  92 int cfs_mem_is_in_cache(const void *addr, const cfs_mem_cache_t *kmem);
  93
  94 /*
  95  * Copy to/from user
  96  */
  97 static inline int cfs_copy_from_user(void *a,void *b, int c)
  98 {
  99         memcpy(a,b,c);
 100         return 0;
 101 }
 102
 103 static inline int cfs_copy_to_user(void *a,void *b, int c)
 104 {
 105         memcpy(a,b,c);
 106         return 0;
 107 }
 108
 109 #endif