libcfs/include/libcfs/user-prim.h

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  *
   4  * GPL HEADER START
   5  *
   6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License version 2 only,
  10  * as published by the Free Software Foundation.
  11  *
  12  * This program is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * General Public License version 2 for more details (a copy is included
  16  * in the LICENSE file that accompanied this code).
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * version 2 along with this program; If not, see [sun.com URL with a
  20  * copy of GPLv2].
  21  *
  22  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  23  * CA 95054 USA or visit www.sun.com if you need additional information or
  24  * have any questions.
  25  *
  26  * GPL HEADER END
  27  */
  28 /*
  29  * Copyright  2008 Sun Microsystems, Inc. All rights reserved
  30  * Use is subject to license terms.
  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 /*
  72  * Wait Queue.
  73  */
  74
  75 typedef struct cfs_waitlink {
  76         struct list_head sleeping;
  77         void *process;
  78 } cfs_waitlink_t;
  79
  80 typedef struct cfs_waitq {
  81         struct list_head sleepers;
  82 } cfs_waitq_t;
  83
  84 /* XXX: need to replace wake_up with cfs_waitq_signal() */
  85 #define wake_up(q) cfs_waitq_signal(q)
  86
  87 /*
  88  * Task states
  89  */
  90 typedef long cfs_task_state_t;
  91
  92 #define CFS_TASK_INTERRUPTIBLE  (0)
  93 #define CFS_TASK_UNINT          (1)
  94 #define CFS_TASK_RUNNING        (2)
  95
  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 #include <sys/time.h>
 116
 117 typedef struct {
 118         struct list_head tl_list;
 119         void (*function)(unsigned long unused);
 120         unsigned long data;
 121         long expires;
 122 } cfs_timer_t;
 123
 124
 125 #define 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_lock_kernel()               do {} while (0)
 140 #define cfs_sigfillset(l) do {}         while (0)
 141 #define cfs_recalc_sigpending(l)        do {} while (0)
 142 #define cfs_kernel_thread(l,m,n)        LBUG()
 143
 144 #ifdef HAVE_LIBPTHREAD
 145 typedef int (*cfs_thread_t)(void *);
 146 int cfs_create_thread(cfs_thread_t func, void *arg);
 147 #else
 148 #define cfs_create_thread(l,m) LBUG()
 149 #endif
 150
 151 int cfs_parse_int_tunable(int *value, char *name);
 152 uid_t cfs_curproc_uid(void);
 153
 154 #define LIBCFS_REALLOC(ptr, size) realloc(ptr, size)
 155
 156 #define cfs_online_cpus() sysconf(_SC_NPROCESSORS_ONLN)
 157
 158 // static inline void local_irq_save(unsigned long flag) {return;}
 159 // static inline void local_irq_restore(unsigned long flag) {return;}
 160
 161 enum {
 162         CFS_STACK_TRACE_DEPTH = 16
 163 };
 164
 165 struct cfs_stack_trace {
 166         void *frame[CFS_STACK_TRACE_DEPTH];
 167 };
 168
 169 /*
 170  * arithmetic
 171  */
 172 #define do_div(a,b)                     \
 173         ({                              \
 174                 unsigned long remainder;\
 175                 remainder = (a) % (b);  \
 176                 (a) = (a) / (b);        \
 177                 (remainder);            \
 178         })
 179
 180 /* !__KERNEL__ */
 181 #endif
 182
 183 /* __LIBCFS_USER_PRIM_H__ */
 184 #endif
 185 /*
 186  * Local variables:
 187  * c-indentation-style: "K&R"
 188  * c-basic-offset: 8
 189  * tab-width: 8
 190  * fill-column: 80
 191  * scroll-step: 1
 192  * End:
 193  */