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