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  * Copyright (c) 2012, Intel Corporation.
  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/user-prim.h
  37  *
  38  * Author: Nikita Danilov <nikita@clusterfs.com>
  39  */
  40
  41 #ifndef __LIBCFS_USER_PRIM_H__
  42 #define __LIBCFS_USER_PRIM_H__
  43
  44 #ifndef __LIBCFS_LIBCFS_H__
  45 #error Do not #include this file directly. #include <libcfs/libcfs.h> instead
  46 #endif
  47
  48 /* Implementations of portable APIs for liblustre */
  49
  50 /*
  51  * liblustre is single-threaded, so most "synchronization" APIs are trivial.
  52  */
  53
  54 #ifndef EXPORT_SYMBOL
  55 # define EXPORT_SYMBOL(s)
  56 #endif
  57
  58 #ifndef __KERNEL__
  59
  60 typedef struct proc_dir_entry           cfs_proc_dir_entry_t;
  61
  62 /*
  63  * Just present a single processor until will add thread support.
  64  */
  65 #ifndef smp_processor_id
  66 # define smp_processor_id() 0
  67 #endif
  68 #ifndef num_online_cpus
  69 # define num_online_cpus() 1
  70 #endif
  71 #ifndef num_possible_cpus
  72 # define num_possible_cpus() 1
  73 #endif
  74 #ifndef get_cpu
  75 # define get_cpu() 0
  76 #endif
  77 #ifndef put_cpu
  78 # define put_cpu() do {} while (0)
  79 #endif
  80 #ifndef NR_CPUS
  81 # define NR_CPUS 1
  82 #endif
  83 #ifndef for_each_possible_cpu
  84 # define for_each_possible_cpu(cpu) for ((cpu) = 0; (cpu) < 1; (cpu)++)
  85 #endif
  86
  87 /*
  88  * Wait Queue.
  89  */
  90
  91 typedef struct cfs_waitlink {
  92         cfs_list_t sleeping;
  93         void *process;
  94 } wait_queue_t;
  95
  96 typedef struct cfs_waitq {
  97         cfs_list_t sleepers;
  98 } wait_queue_head_t;
  99
 100 #define CFS_DECL_WAITQ(wq) wait_queue_head_t wq
 101 void init_waitqueue_head(struct cfs_waitq *waitq);
 102 void init_waitqueue_entry_current(struct cfs_waitlink *link);
 103 void add_wait_queue(struct cfs_waitq *waitq, struct cfs_waitlink *link);
 104 void add_wait_queue_exclusive(struct cfs_waitq *waitq, struct cfs_waitlink *link);
 105 void add_wait_queue_exclusive_head(struct cfs_waitq *waitq, struct cfs_waitlink *link);
 106 void remove_wait_queue(struct cfs_waitq *waitq, struct cfs_waitlink *link);
 107 int waitqueue_active(struct cfs_waitq *waitq);
 108 void wake_up(struct cfs_waitq *waitq);
 109 void wake_up_nr(struct cfs_waitq *waitq, int nr);
 110 void wake_up_all(struct cfs_waitq *waitq);
 111 void waitq_wait(struct cfs_waitlink *link, long state);
 112 int64_t waitq_timedwait(struct cfs_waitlink *link, long state, int64_t timeout);
 113 void schedule_timeout_and_set_state(long state, int64_t timeout);
 114 void cfs_pause(cfs_duration_t d);
 115 int need_resched(void);
 116 void cond_resched(void);
 117
 118 /*
 119  * Task states
 120  */
 121 #define TASK_INTERRUPTIBLE  (0)
 122 #define TASK_UNINTERRUPTIBLE          (1)
 123 #define TASK_RUNNING        (2)
 124
 125 static inline void schedule(void)                       {}
 126 static inline void schedule_timeout(int64_t t)  {}
 127
 128 /*
 129  * Lproc
 130  */
 131 typedef int (cfs_read_proc_t)(char *page, char **start, off_t off,
 132                           int count, int *eof, void *data);
 133
 134 struct file; /* forward ref */
 135 typedef int (cfs_write_proc_t)(struct file *file, const char *buffer,
 136                                unsigned long count, void *data);
 137
 138 /*
 139  * Signal
 140  */
 141
 142 /*
 143  * Timer
 144  */
 145
 146 struct timer_list {
 147         cfs_list_t tl_list;
 148         void (*function)(ulong_ptr_t unused);
 149         ulong_ptr_t data;
 150         long expires;
 151 };
 152
 153
 154 #define in_interrupt()    (0)
 155
 156 struct miscdevice{
 157 };
 158
 159 static inline int misc_register(struct miscdevice *foo)
 160 {
 161         return 0;
 162 }
 163
 164 static inline int misc_deregister(struct miscdevice *foo)
 165 {
 166         return 0;
 167 }
 168
 169 #define cfs_sigfillset(l)               do {} while (0)
 170 #define cfs_recalc_sigpending(l)        do {} while (0)
 171
 172 #define DAEMON_FLAGS                0
 173
 174 #define L1_CACHE_ALIGN(x)               (x)
 175
 176 #ifdef HAVE_LIBPTHREAD
 177 typedef int (*cfs_thread_t)(void *);
 178 void *kthread_run(cfs_thread_t func, void *arg, const char namefmt[], ...);
 179 #else
 180 /* Fine, crash, but stop giving me compile warnings */
 181 #define kthread_run(f, a, n, ...) LBUG()
 182 #endif
 183
 184 uid_t current_uid(void);
 185 gid_t current_gid(void);
 186 uid_t current_fsuid(void);
 187 gid_t current_fsgid(void);
 188
 189 #ifndef HAVE_STRLCPY /* not in glibc for RHEL 5.x, remove when obsolete */
 190 size_t strlcpy(char *tgt, const char *src, size_t tgt_len);
 191 #endif
 192
 193 #ifndef HAVE_STRLCAT /* not in glibc for RHEL 5.x, remove when obsolete */
 194 size_t strlcat(char *tgt, const char *src, size_t tgt_len);
 195 #endif
 196
 197 #define LIBCFS_REALLOC(ptr, size) realloc(ptr, size)
 198
 199 #define cfs_online_cpus() sysconf(_SC_NPROCESSORS_ONLN)
 200
 201 // static inline void local_irq_save(unsigned long flag) {return;}
 202 // static inline void local_irq_restore(unsigned long flag) {return;}
 203
 204 enum {
 205         CFS_STACK_TRACE_DEPTH = 16
 206 };
 207
 208 struct cfs_stack_trace {
 209         void *frame[CFS_STACK_TRACE_DEPTH];
 210 };
 211
 212 /*
 213  * arithmetic
 214  */
 215 #ifndef do_div /* gcc only, platform-specific will override */
 216 #define do_div(a,b)                     \
 217         ({                              \
 218                 unsigned long remainder;\
 219                 remainder = (a) % (b);  \
 220                 (a) = (a) / (b);        \
 221                 (remainder);            \
 222         })
 223 #endif
 224
 225 /*
 226  * Groups
 227  */
 228 struct group_info{ };
 229
 230 #ifndef min
 231 # define min(x,y) ((x)<(y) ? (x) : (y))
 232 #endif
 233
 234 #ifndef max
 235 # define max(x,y) ((x)>(y) ? (x) : (y))
 236 #endif
 237
 238 #define get_random_bytes(val, size)     (*val) = 0
 239
 240 /* utility libcfs init/fini entries */
 241 #ifdef __WINNT__
 242 extern int libcfs_arch_init(void);
 243 extern void libcfs_arch_cleanup(void);
 244 #else /* !__WINNT__ */
 245 static inline int libcfs_arch_init(void) {
 246         return 0;
 247 }
 248 static inline void libcfs_arch_cleanup(void) {
 249 }
 250 /* __WINNT__ */
 251 #endif
 252
 253 /* proc interface wrappers for non-win OS */
 254 #ifndef __WINNT__
 255 #define cfs_proc_open   open
 256 #define cfs_proc_mknod  mknod
 257 #define cfs_proc_ioctl  ioctl
 258 #define cfs_proc_close  close
 259 #define cfs_proc_read   read
 260 #define cfs_proc_write  write
 261 #define cfs_proc_fopen  fopen
 262 #define cfs_proc_fclose fclose
 263 #define cfs_proc_fgets  fgets
 264 /* !__WINNT__ */
 265 #endif
 266
 267 /* !__KERNEL__ */
 268 #endif
 269
 270 /* __LIBCFS_USER_PRIM_H__ */
 271 #endif
 272 /*
 273  * Local variables:
 274  * c-indentation-style: "K&R"
 275  * c-basic-offset: 8
 276  * tab-width: 8
 277  * fill-column: 80
 278  * scroll-step: 1
 279  * End:
 280  */