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