libcfs/include/libcfs/libcfs.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) 2011, 2014, 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
  37 #ifndef __LIBCFS_LIBCFS_H__
  38 #define __LIBCFS_LIBCFS_H__
  39
  40 #include <libcfs/types.h>
  41 #include <libcfs/list.h>
  42
  43 #ifdef __KERNEL__
  44 # include <libcfs/linux/libcfs.h>
  45 #else /* !__KERNEL__ */
  46 # include <assert.h>
  47 # include <ctype.h>
  48 # include <errno.h>
  49 # include <fcntl.h>
  50 # include <limits.h>
  51 # include <signal.h>
  52 # include <stdarg.h>
  53 # include <stdbool.h>
  54 # include <stddef.h>
  55 # include <stdint.h>
  56 # include <stdio.h>
  57 # include <stdlib.h>
  58 # include <string.h>
  59 # include <time.h>
  60 # include <sys/ioctl.h>
  61 # include <sys/socket.h>
  62 # include <sys/stat.h>
  63 # include <sys/time.h>
  64 # include <sys/types.h>
  65 # include <libcfs/user-time.h>
  66 # include <libcfs/user-prim.h>
  67 # include <libcfs/user-mem.h>
  68 # include <libcfs/user-lock.h>
  69 # include <libcfs/user-bitops.h>
  70 #endif /* __KERNEL__ */
  71
  72 #include "curproc.h"
  73
  74 #ifndef ARRAY_SIZE
  75 #define ARRAY_SIZE(a) ((sizeof (a)) / (sizeof ((a)[0])))
  76 #endif
  77
  78 #if !defined(swap)
  79 #define swap(x,y) do { typeof(x) z = x; x = y; y = z; } while (0)
  80 #endif
  81
  82 #if !defined(container_of)
  83 /* given a pointer @ptr to the field @member embedded into type (usually
  84  * struct) @type, return pointer to the embedding instance of @type. */
  85 #define container_of(ptr, type, member) \
  86         ((type *)((char *)(ptr)-(char *)(&((type *)0)->member)))
  87 #endif
  88
  89 static inline int __is_po2(unsigned long long val)
  90 {
  91         return !(val & (val - 1));
  92 }
  93
  94 #define IS_PO2(val) __is_po2((unsigned long long)(val))
  95
  96 #define LOWEST_BIT_SET(x)       ((x) & ~((x) - 1))
  97
  98 /* Sparse annotations */
  99 #ifdef __KERNEL__
 100 # if !defined(__must_hold)
 101 #  ifdef __CHECKER__
 102 #   define __must_hold(x) __attribute__((context(x, 1, 1)))
 103 #  else /* __CHECKER__ */
 104 #   define __must_hold(x)
 105 #  endif /* !__CHECKER__ */
 106 # endif /* !__must_hold */
 107 #else /* __KERNEL__ */
 108 # define __acquires(x)
 109 # define __releases(x)
 110 # define __must_hold(x)
 111 #endif /* !__KERNEL__ */
 112
 113 /*
 114  * Lustre Error Checksum: calculates checksum
 115  * of Hex number by XORing each bit.
 116  */
 117 #define LERRCHKSUM(hexnum) (((hexnum) & 0xf) ^ ((hexnum) >> 4 & 0xf) ^ \
 118                            ((hexnum) >> 8 & 0xf))
 119
 120 /*
 121  * Some (nomina odiosa sunt) platforms define NULL as naked 0. This confuses
 122  * Lustre RETURN(NULL) macro.
 123  */
 124 #if defined(NULL)
 125 #undef NULL
 126 #endif
 127
 128 #define NULL ((void *)0)
 129
 130 #ifdef __KERNEL__
 131
 132 #ifndef cfs_for_each_possible_cpu
 133 #  error cfs_for_each_possible_cpu is not supported by kernel!
 134 #endif
 135
 136 /* libcfs watchdogs */
 137 struct lc_watchdog;
 138
 139 /* Add a watchdog which fires after "time" milliseconds of delay.  You have to
 140  * touch it once to enable it. */
 141 struct lc_watchdog *lc_watchdog_add(int time,
 142                                     void (*cb)(pid_t pid, void *),
 143                                     void *data);
 144
 145 /* Enables a watchdog and resets its timer. */
 146 void lc_watchdog_touch(struct lc_watchdog *lcw, int timeout);
 147 #define CFS_GET_TIMEOUT(svc) (max_t(int, obd_timeout,                   \
 148                           AT_OFF ? 0 : at_get(&svc->srv_at_estimate)) * \
 149                           svc->srv_watchdog_factor)
 150
 151 /* Disable a watchdog; touch it to restart it. */
 152 void lc_watchdog_disable(struct lc_watchdog *lcw);
 153
 154 /* Clean up the watchdog */
 155 void lc_watchdog_delete(struct lc_watchdog *lcw);
 156
 157 /* Dump a debug log */
 158 void lc_watchdog_dumplog(pid_t pid, void *data);
 159
 160 #else /* !__KERNEL__ */
 161 #include <unistd.h>
 162 #ifndef PAGE_SIZE
 163 #define PAGE_SIZE sysconf(_SC_PAGESIZE)
 164 #endif
 165 #endif /* !__KERNEL__ */
 166
 167 /* need both kernel and user-land acceptor */
 168 #define LNET_ACCEPTOR_MIN_RESERVED_PORT    512
 169 #define LNET_ACCEPTOR_MAX_RESERVED_PORT    1023
 170
 171 /*
 172  * libcfs pseudo device operations
 173  *
 174  * struct struct miscdevice and
 175  * misc_register() and
 176  * misc_deregister() are declared in
 177  * libcfs/<os>/<os>-prim.h
 178  *
 179  * It's just draft now.
 180  */
 181
 182 struct cfs_psdev_file {
 183         unsigned long   off;
 184         void            *private_data;
 185         unsigned long   reserved1;
 186         unsigned long   reserved2;
 187 };
 188
 189 struct cfs_psdev_ops {
 190         int (*p_open)(unsigned long, void *);
 191         int (*p_close)(unsigned long, void *);
 192         int (*p_read)(struct cfs_psdev_file *, char *, unsigned long);
 193         int (*p_write)(struct cfs_psdev_file *, char *, unsigned long);
 194         int (*p_ioctl)(struct cfs_psdev_file *, unsigned long, void __user *);
 195 };
 196
 197 /*
 198  * Drop into debugger, if possible. Implementation is provided by platform.
 199  */
 200
 201 void cfs_enter_debugger(void);
 202
 203 /*
 204  * Defined by platform
 205  */
 206 int unshare_fs_struct(void);
 207 sigset_t cfs_block_allsigs(void);
 208 sigset_t cfs_block_sigs(unsigned long sigs);
 209 sigset_t cfs_block_sigsinv(unsigned long sigs);
 210 void cfs_restore_sigs(sigset_t);
 211 int cfs_signal_pending(void);
 212 void cfs_clear_sigpending(void);
 213
 214 int convert_server_error(__u64 ecode);
 215 int convert_client_oflag(int cflag, int *result);
 216
 217 /*
 218  * Stack-tracing filling.
 219  */
 220
 221 /*
 222  * Platform-dependent data-type to hold stack frames.
 223  */
 224 struct cfs_stack_trace;
 225
 226 /*
 227  * Fill @trace with current back-trace.
 228  */
 229 void cfs_stack_trace_fill(struct cfs_stack_trace *trace);
 230
 231 /*
 232  * Return instruction pointer for frame @frame_no. NULL if @frame_no is
 233  * invalid.
 234  */
 235 void *cfs_stack_trace_frame(struct cfs_stack_trace *trace, int frame_no);
 236
 237 /*
 238  * Random number handling
 239  */
 240
 241 /* returns a random 32-bit integer */
 242 unsigned int cfs_rand(void);
 243 /* seed the generator */
 244 void cfs_srand(unsigned int, unsigned int);
 245 void cfs_get_random_bytes(void *buf, int size);
 246
 247 #include <libcfs/byteorder.h>
 248 #include <libcfs/err.h>
 249 #include <libcfs/libcfs_debug.h>
 250 #include <libcfs/libcfs_private.h>
 251 #include <libcfs/bitmap.h>
 252 #include <libcfs/libcfs_cpu.h>
 253 #include <libcfs/libcfs_ioctl.h>
 254 #include <libcfs/libcfs_prim.h>
 255 #include <libcfs/libcfs_time.h>
 256 #include <libcfs/libcfs_string.h>
 257 #include <libcfs/libcfs_kernelcomm.h>
 258 #include <libcfs/libcfs_workitem.h>
 259 #include <libcfs/libcfs_hash.h>
 260 #include <libcfs/libcfs_heap.h>
 261 #include <libcfs/libcfs_fail.h>
 262
 263 /* container_of depends on "likely" which is defined in libcfs_private.h */
 264 static inline void *__container_of(const void *ptr, unsigned long shift)
 265 {
 266         if (unlikely(IS_ERR(ptr) || ptr == NULL))
 267                 return ERR_CAST(ptr);
 268         else
 269                 return (char *)ptr - shift;
 270 }
 271
 272 #define container_of0(ptr, type, member)                                \
 273         ((type *)__container_of((ptr), offsetof(type, member)))
 274
 275 #define _LIBCFS_H
 276
 277 int libcfs_arch_init(void);
 278 void libcfs_arch_cleanup(void);
 279
 280 #endif /* _LIBCFS_H */