libcfs/include/libcfs/user-prim.h

   1 /*
   2  * GPL HEADER START
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License version 2 only,
   8  * as published by the Free Software Foundation.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * General Public License version 2 for more details (a copy is included
  14  * in the LICENSE file that accompanied this code).
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * version 2 along with this program; If not, see
  18  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
  19  *
  20  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  21  * CA 95054 USA or visit www.sun.com if you need additional information or
  22  * have any questions.
  23  *
  24  * GPL HEADER END
  25  */
  26 /*
  27  * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
  28  * Use is subject to license terms.
  29  */
  30 /*
  31  * This file is part of Lustre, http://www.lustre.org/
  32  * Lustre is a trademark of Sun Microsystems, Inc.
  33  *
  34  * libcfs/include/libcfs/user-prim.h
  35  *
  36  * Author: Nikita Danilov <nikita@clusterfs.com>
  37  */
  38
  39 #ifndef __LIBCFS_USER_PRIM_H__
  40 #define __LIBCFS_USER_PRIM_H__
  41
  42 #ifndef __LIBCFS_LIBCFS_H__
  43 #error Do not #include this file directly. #include <libcfs/libcfs.h> instead
  44 #endif
  45
  46 /* Implementations of portable APIs for liblustre */
  47
  48 /*
  49  * liblustre is single-threaded, so most "synchronization" APIs are trivial.
  50  */
  51
  52 #ifndef __KERNEL__
  53
  54 typedef struct proc_dir_entry           cfs_proc_dir_entry_t;
  55
  56 /*
  57  * Just present a single processor until will add thread support.
  58  */
  59 #ifndef smp_processor_id
  60 #define cfs_smp_processor_id() 0
  61 #else
  62 #define cfs_smp_processor_id() smp_processor_id()
  63 #endif
  64 #ifndef num_online_cpus
  65 #define cfs_num_online_cpus() 1
  66 #else
  67 #define cfs_num_online_cpus() num_online_cpus()
  68 #endif
  69 #ifndef num_possible_cpus
  70 #define cfs_num_possible_cpus() 1
  71 #else
  72 #define cfs_num_possible_cpus() num_possible_cpus()
  73 #endif
  74
  75 /*
  76  * Wait Queue.
  77  */
  78
  79 typedef struct cfs_waitlink {
  80         cfs_list_t sleeping;
  81         void *process;
  82 } cfs_waitlink_t;
  83
  84 typedef struct cfs_waitq {
  85         cfs_list_t sleepers;
  86 } cfs_waitq_t;
  87
  88 /*
  89  * Task states
  90  */
  91 typedef long cfs_task_state_t;
  92
  93 #define CFS_TASK_INTERRUPTIBLE  (0)
  94 #define CFS_TASK_UNINT          (1)
  95 #define CFS_TASK_RUNNING        (2)
  96
  97
  98 /*
  99  * Lproc
 100  */
 101 typedef int (cfs_read_proc_t)(char *page, char **start, off_t off,
 102                           int count, int *eof, void *data);
 103
 104 struct file; /* forward ref */
 105 typedef int (cfs_write_proc_t)(struct file *file, const char *buffer,
 106                                unsigned long count, void *data);
 107
 108 /*
 109  * Signal
 110  */
 111 typedef sigset_t                        cfs_sigset_t;
 112
 113 /*
 114  * Timer
 115  */
 116
 117 typedef struct {
 118         cfs_list_t tl_list;
 119         void (*function)(ulong_ptr_t unused);
 120         ulong_ptr_t data;
 121         long expires;
 122 } cfs_timer_t;
 123
 124
 125 #define cfs_in_interrupt()    (0)
 126
 127 typedef void cfs_psdev_t;
 128
 129 static inline int cfs_psdev_register(cfs_psdev_t *foo)
 130 {
 131         return 0;
 132 }
 133
 134 static inline int cfs_psdev_deregister(cfs_psdev_t *foo)
 135 {
 136         return 0;
 137 }
 138
 139 #define cfs_sigfillset(l)               do {} while (0)
 140 #define cfs_recalc_sigpending(l)        do {} while (0)
 141 /* Fine, crash, but stop giving me compile warnings */
 142 #define cfs_kthread_run(fn,d,fmt,...)   LBUG()
 143
 144 #define CFS_DAEMON_FLAGS                0
 145
 146 #define CFS_L1_CACHE_ALIGN(x)           (x)
 147
 148 #ifdef HAVE_LIBPTHREAD
 149 typedef int (*cfs_thread_t)(void *);
 150 int cfs_create_thread(cfs_thread_t func, void *arg, unsigned long flags);
 151 #else
 152 #define cfs_create_thread(l,m) LBUG()
 153 #endif
 154
 155 uid_t cfs_curproc_uid(void);
 156 gid_t cfs_curproc_gid(void);
 157 uid_t cfs_curproc_fsuid(void);
 158 gid_t cfs_curproc_fsgid(void);
 159
 160 #define LIBCFS_REALLOC(ptr, size) realloc(ptr, size)
 161
 162 #define cfs_online_cpus() sysconf(_SC_NPROCESSORS_ONLN)
 163
 164 // static inline void local_irq_save(unsigned long flag) {return;}
 165 // static inline void local_irq_restore(unsigned long flag) {return;}
 166
 167 enum {
 168         CFS_STACK_TRACE_DEPTH = 16
 169 };
 170
 171 struct cfs_stack_trace {
 172         void *frame[CFS_STACK_TRACE_DEPTH];
 173 };
 174
 175 /*
 176  * arithmetic
 177  */
 178 #ifndef do_div /* gcc only, platform-specific will override */
 179 #define do_div(a,b)                     \
 180         ({                              \
 181                 unsigned long remainder;\
 182                 remainder = (a) % (b);  \
 183                 (a) = (a) / (b);        \
 184                 (remainder);            \
 185         })
 186 #endif
 187
 188 /*
 189  * Groups
 190  */
 191 typedef struct cfs_group_info {
 192
 193 } cfs_group_info_t;
 194
 195 #ifndef min
 196 # define min(x,y) ((x)<(y) ? (x) : (y))
 197 #endif
 198
 199 #ifndef max
 200 # define max(x,y) ((x)>(y) ? (x) : (y))
 201 #endif
 202
 203 #define cfs_get_random_bytes_prim(val, size)     (*val) = 0
 204
 205 /* utility libcfs init/fini entries */
 206 #ifdef __WINNT__
 207 extern int libcfs_arch_init(void);
 208 extern void libcfs_arch_cleanup(void);
 209 #else /* !__WINNT__ */
 210 static inline int libcfs_arch_init(void) {
 211         return 0;
 212 }
 213 static inline void libcfs_arch_cleanup(void) {
 214 }
 215 /* __WINNT__ */
 216 #endif
 217
 218 /* proc interface wrappers for non-win OS */
 219 #ifndef __WINNT__
 220 #define cfs_proc_open   open
 221 #define cfs_proc_mknod  mknod
 222 #define cfs_proc_ioctl  ioctl
 223 #define cfs_proc_close  close
 224 #define cfs_proc_read   read
 225 #define cfs_proc_write  write
 226 #define cfs_proc_fopen  fopen
 227 #define cfs_proc_fclose fclose
 228 #define cfs_proc_fgets  fgets
 229 /* !__WINNT__ */
 230 #endif
 231
 232 /* !__KERNEL__ */
 233 #endif
 234
 235 /* __LIBCFS_USER_PRIM_H__ */
 236 #endif
 237 /*
 238  * Local variables:
 239  * c-indentation-style: "K&R"
 240  * c-basic-offset: 8
 241  * tab-width: 8
 242  * fill-column: 80
 243  * scroll-step: 1
 244  * End:
 245  */