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 #ifndef num_present_cpus
  75 # define cfs_num_present_cpus() 1
  76 #else
  77 # define cfs_num_present_cpus() num_present_cpus()
  78 #endif
  79 /*
  80  * Wait Queue.
  81  */
  82
  83 typedef struct cfs_waitlink {
  84         cfs_list_t sleeping;
  85         void *process;
  86 } cfs_waitlink_t;
  87
  88 typedef struct cfs_waitq {
  89         cfs_list_t sleepers;
  90 } cfs_waitq_t;
  91
  92 /*
  93  * Task states
  94  */
  95 typedef long cfs_task_state_t;
  96
  97 #define CFS_TASK_INTERRUPTIBLE  (0)
  98 #define CFS_TASK_UNINT          (1)
  99 #define CFS_TASK_RUNNING        (2)
 100
 101 static inline void cfs_schedule(void)                   {}
 102 static inline void cfs_schedule_timeout(int64_t t)      {}
 103
 104 /*
 105  * Lproc
 106  */
 107 typedef int (cfs_read_proc_t)(char *page, char **start, off_t off,
 108                           int count, int *eof, void *data);
 109
 110 struct file; /* forward ref */
 111 typedef int (cfs_write_proc_t)(struct file *file, const char *buffer,
 112                                unsigned long count, void *data);
 113
 114 /*
 115  * Signal
 116  */
 117 typedef sigset_t                        cfs_sigset_t;
 118
 119 /*
 120  * Timer
 121  */
 122
 123 typedef struct {
 124         cfs_list_t tl_list;
 125         void (*function)(ulong_ptr_t unused);
 126         ulong_ptr_t data;
 127         long expires;
 128 } cfs_timer_t;
 129
 130
 131 #define cfs_in_interrupt()    (0)
 132
 133 typedef void cfs_psdev_t;
 134
 135 static inline int cfs_psdev_register(cfs_psdev_t *foo)
 136 {
 137         return 0;
 138 }
 139
 140 static inline int cfs_psdev_deregister(cfs_psdev_t *foo)
 141 {
 142         return 0;
 143 }
 144
 145 #define cfs_sigfillset(l)               do {} while (0)
 146 #define cfs_recalc_sigpending(l)        do {} while (0)
 147 /* Fine, crash, but stop giving me compile warnings */
 148 #define cfs_kthread_run(fn,d,fmt,...)   LBUG()
 149
 150 #define CFS_DAEMON_FLAGS                0
 151
 152 #define CFS_L1_CACHE_ALIGN(x)           (x)
 153
 154 #ifdef HAVE_LIBPTHREAD
 155 typedef int (*cfs_thread_t)(void *);
 156 int cfs_create_thread(cfs_thread_t func, void *arg, unsigned long flags);
 157 #else
 158 #define cfs_create_thread(l,m) LBUG()
 159 #endif
 160
 161 uid_t cfs_curproc_uid(void);
 162 gid_t cfs_curproc_gid(void);
 163 uid_t cfs_curproc_fsuid(void);
 164 gid_t cfs_curproc_fsgid(void);
 165
 166 #ifndef HAVE_STRLCPY /* not in glibc for RHEL 5.x, remove when obsolete */
 167 size_t strlcpy(char *tgt, const char *src, size_t tgt_len);
 168 #endif
 169
 170 #ifndef HAVE_STRLCAT /* not in glibc for RHEL 5.x, remove when obsolete */
 171 size_t strlcat(char *tgt, const char *src, size_t tgt_len);
 172 #endif
 173
 174 #define LIBCFS_REALLOC(ptr, size) realloc(ptr, size)
 175
 176 #define cfs_online_cpus() sysconf(_SC_NPROCESSORS_ONLN)
 177
 178 // static inline void local_irq_save(unsigned long flag) {return;}
 179 // static inline void local_irq_restore(unsigned long flag) {return;}
 180
 181 enum {
 182         CFS_STACK_TRACE_DEPTH = 16
 183 };
 184
 185 struct cfs_stack_trace {
 186         void *frame[CFS_STACK_TRACE_DEPTH];
 187 };
 188
 189 /*
 190  * arithmetic
 191  */
 192 #ifndef do_div /* gcc only, platform-specific will override */
 193 #define do_div(a,b)                     \
 194         ({                              \
 195                 unsigned long remainder;\
 196                 remainder = (a) % (b);  \
 197                 (a) = (a) / (b);        \
 198                 (remainder);            \
 199         })
 200 #endif
 201
 202 /*
 203  * Groups
 204  */
 205 typedef struct cfs_group_info {
 206
 207 } cfs_group_info_t;
 208
 209 #ifndef min
 210 # define min(x,y) ((x)<(y) ? (x) : (y))
 211 #endif
 212
 213 #ifndef max
 214 # define max(x,y) ((x)>(y) ? (x) : (y))
 215 #endif
 216
 217 #define cfs_get_random_bytes_prim(val, size)     (*val) = 0
 218
 219 /* utility libcfs init/fini entries */
 220 #ifdef __WINNT__
 221 extern int libcfs_arch_init(void);
 222 extern void libcfs_arch_cleanup(void);
 223 #else /* !__WINNT__ */
 224 static inline int libcfs_arch_init(void) {
 225         return 0;
 226 }
 227 static inline void libcfs_arch_cleanup(void) {
 228 }
 229 /* __WINNT__ */
 230 #endif
 231
 232 /* proc interface wrappers for non-win OS */
 233 #ifndef __WINNT__
 234 #define cfs_proc_open   open
 235 #define cfs_proc_mknod  mknod
 236 #define cfs_proc_ioctl  ioctl
 237 #define cfs_proc_close  close
 238 #define cfs_proc_read   read
 239 #define cfs_proc_write  write
 240 #define cfs_proc_fopen  fopen
 241 #define cfs_proc_fclose fclose
 242 #define cfs_proc_fgets  fgets
 243 /* !__WINNT__ */
 244 #endif
 245
 246 /* !__KERNEL__ */
 247 #endif
 248
 249 /* __LIBCFS_USER_PRIM_H__ */
 250 #endif
 251 /*
 252  * Local variables:
 253  * c-indentation-style: "K&R"
 254  * c-basic-offset: 8
 255  * tab-width: 8
 256  * fill-column: 80
 257  * scroll-step: 1
 258  * End:
 259  */