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