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, Whamcloud, Inc.
  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 #if !defined(__WINNT__) && !defined(__KERNEL__)
  45 #include <libcfs/posix/libcfs.h>
  46 #elif defined(__linux__)
  47 #include <libcfs/linux/libcfs.h>
  48 #elif defined(__APPLE__)
  49 #include <libcfs/darwin/libcfs.h>
  50 #elif defined(__WINNT__)
  51 #include <libcfs/winnt/libcfs.h>
  52 #else
  53 #error Unsupported operating system.
  54 #endif
  55
  56 #include "curproc.h"
  57
  58 #ifndef offsetof
  59 # define offsetof(typ,memb) ((long)(long_ptr_t)((char *)&(((typ *)0)->memb)))
  60 #endif
  61
  62 #ifndef ARRAY_SIZE
  63 #define ARRAY_SIZE(a) ((sizeof (a)) / (sizeof ((a)[0])))
  64 #endif
  65
  66 #if !defined(container_of)
  67 /* given a pointer @ptr to the field @member embedded into type (usually
  68  * struct) @type, return pointer to the embedding instance of @type. */
  69 #define container_of(ptr, type, member) \
  70         ((type *)((char *)(ptr)-(char *)(&((type *)0)->member)))
  71 #endif
  72
  73 static inline int __is_po2(unsigned long long val)
  74 {
  75         return !(val & (val - 1));
  76 }
  77
  78 #define IS_PO2(val) __is_po2((unsigned long long)(val))
  79
  80 #define LOWEST_BIT_SET(x)       ((x) & ~((x) - 1))
  81
  82 /*
  83  * Lustre Error Checksum: calculates checksum
  84  * of Hex number by XORing each bit.
  85  */
  86 #define LERRCHKSUM(hexnum) (((hexnum) & 0xf) ^ ((hexnum) >> 4 & 0xf) ^ \
  87                            ((hexnum) >> 8 & 0xf))
  88
  89
  90 /*
  91  * Some (nomina odiosa sunt) platforms define NULL as naked 0. This confuses
  92  * Lustre RETURN(NULL) macro.
  93  */
  94 #if defined(NULL)
  95 #undef NULL
  96 #endif
  97
  98 #define NULL ((void *)0)
  99
 100 #define LUSTRE_SRV_LNET_PID      LUSTRE_LNET_PID
 101
 102 #ifdef __KERNEL__
 103
 104 #include <libcfs/list.h>
 105
 106 #ifndef cfs_for_each_possible_cpu
 107 #  error cfs_for_each_possible_cpu is not supported by kernel!
 108 #endif
 109
 110 /* libcfs tcpip */
 111 int libcfs_ipif_query(char *name, int *up, __u32 *ip, __u32 *mask);
 112 int libcfs_ipif_enumerate(char ***names);
 113 void libcfs_ipif_free_enumeration(char **names, int n);
 114 int libcfs_sock_listen(cfs_socket_t **sockp, __u32 ip, int port, int backlog);
 115 int libcfs_sock_accept(cfs_socket_t **newsockp, cfs_socket_t *sock);
 116 void libcfs_sock_abort_accept(cfs_socket_t *sock);
 117 int libcfs_sock_connect(cfs_socket_t **sockp, int *fatal,
 118                         __u32 local_ip, int local_port,
 119                         __u32 peer_ip, int peer_port);
 120 int libcfs_sock_setbuf(cfs_socket_t *socket, int txbufsize, int rxbufsize);
 121 int libcfs_sock_getbuf(cfs_socket_t *socket, int *txbufsize, int *rxbufsize);
 122 int libcfs_sock_getaddr(cfs_socket_t *socket, int remote, __u32 *ip, int *port);
 123 int libcfs_sock_write(cfs_socket_t *sock, void *buffer, int nob, int timeout);
 124 int libcfs_sock_read(cfs_socket_t *sock, void *buffer, int nob, int timeout);
 125 void libcfs_sock_release(cfs_socket_t *sock);
 126
 127 /* libcfs watchdogs */
 128 struct lc_watchdog;
 129
 130 /* Add a watchdog which fires after "time" milliseconds of delay.  You have to
 131  * touch it once to enable it. */
 132 struct lc_watchdog *lc_watchdog_add(int time,
 133                                     void (*cb)(pid_t pid, void *),
 134                                     void *data);
 135
 136 /* Enables a watchdog and resets its timer. */
 137 void lc_watchdog_touch(struct lc_watchdog *lcw, int timeout);
 138 #define CFS_GET_TIMEOUT(svc) (max_t(int, obd_timeout,                   \
 139                           AT_OFF ? 0 : at_get(&svc->srv_at_estimate)) * \
 140                           svc->srv_watchdog_factor)
 141
 142 /* Disable a watchdog; touch it to restart it. */
 143 void lc_watchdog_disable(struct lc_watchdog *lcw);
 144
 145 /* Clean up the watchdog */
 146 void lc_watchdog_delete(struct lc_watchdog *lcw);
 147
 148 /* Dump a debug log */
 149 void lc_watchdog_dumplog(pid_t pid, void *data);
 150
 151 #endif /* __KERNEL__ */
 152
 153 /* need both kernel and user-land acceptor */
 154 #define LNET_ACCEPTOR_MIN_RESERVED_PORT    512
 155 #define LNET_ACCEPTOR_MAX_RESERVED_PORT    1023
 156
 157 /*
 158  * libcfs pseudo device operations
 159  *
 160  * struct cfs_psdev_t and
 161  * cfs_psdev_register() and
 162  * cfs_psdev_deregister() are declared in
 163  * libcfs/<os>/<os>-prim.h
 164  *
 165  * It's just draft now.
 166  */
 167
 168 struct cfs_psdev_file {
 169         unsigned long   off;
 170         void            *private_data;
 171         unsigned long   reserved1;
 172         unsigned long   reserved2;
 173 };
 174
 175 struct cfs_psdev_ops {
 176         int (*p_open)(unsigned long, void *);
 177         int (*p_close)(unsigned long, void *);
 178         int (*p_read)(struct cfs_psdev_file *, char *, unsigned long);
 179         int (*p_write)(struct cfs_psdev_file *, char *, unsigned long);
 180         int (*p_ioctl)(struct cfs_psdev_file *, unsigned long, void *);
 181 };
 182
 183 /*
 184  * Universal memory allocator API
 185  */
 186 enum cfs_alloc_flags {
 187         /* allocation is not allowed to block */
 188         CFS_ALLOC_ATOMIC = 0x1,
 189         /* allocation is allowed to block */
 190         CFS_ALLOC_WAIT   = 0x2,
 191         /* allocation should return zeroed memory */
 192         CFS_ALLOC_ZERO   = 0x4,
 193         /* allocation is allowed to call file-system code to free/clean
 194          * memory */
 195         CFS_ALLOC_FS     = 0x8,
 196         /* allocation is allowed to do io to free/clean memory */
 197         CFS_ALLOC_IO     = 0x10,
 198         /* don't report allocation failure to the console */
 199         CFS_ALLOC_NOWARN = 0x20,
 200         /* standard allocator flag combination */
 201         CFS_ALLOC_STD    = CFS_ALLOC_FS | CFS_ALLOC_IO,
 202         CFS_ALLOC_USER   = CFS_ALLOC_WAIT | CFS_ALLOC_FS | CFS_ALLOC_IO,
 203         CFS_ALLOC_NOFS   = CFS_ALLOC_WAIT | CFS_ALLOC_IO,
 204         CFS_ALLOC_KERNEL = CFS_ALLOC_WAIT | CFS_ALLOC_IO | CFS_ALLOC_FS,
 205 };
 206
 207 /* flags for cfs_page_alloc() in addition to enum cfs_alloc_flags */
 208 enum cfs_alloc_page_flags {
 209         /* allow to return page beyond KVM. It has to be mapped into KVM by
 210          * cfs_kmap() and unmapped with cfs_kunmap(). */
 211         CFS_ALLOC_HIGHMEM  = 0x40,
 212         CFS_ALLOC_HIGHUSER = CFS_ALLOC_WAIT | CFS_ALLOC_FS | CFS_ALLOC_IO |
 213                              CFS_ALLOC_HIGHMEM,
 214 };
 215
 216 /*
 217  * Drop into debugger, if possible. Implementation is provided by platform.
 218  */
 219
 220 void cfs_enter_debugger(void);
 221
 222 /*
 223  * Defined by platform
 224  */
 225 void cfs_daemonize(char *str);
 226 int cfs_daemonize_ctxt(char *str);
 227 cfs_sigset_t cfs_get_blocked_sigs(void);
 228 cfs_sigset_t cfs_block_allsigs(void);
 229 cfs_sigset_t cfs_block_sigs(unsigned long sigs);
 230 cfs_sigset_t cfs_block_sigsinv(unsigned long sigs);
 231 void cfs_restore_sigs(cfs_sigset_t);
 232 int cfs_signal_pending(void);
 233 void cfs_clear_sigpending(void);
 234
 235 /*
 236  * XXX Liang:
 237  * these macros should be removed in the future,
 238  * we keep them just for keeping libcfs compatible
 239  * with other branches.
 240  */
 241 #define libcfs_daemonize(s)     cfs_daemonize(s)
 242 #define cfs_sigmask_lock(f)     do { f= 0; } while (0)
 243 #define cfs_sigmask_unlock(f)   do { f= 0; } while (0)
 244
 245 int convert_server_error(__u64 ecode);
 246 int convert_client_oflag(int cflag, int *result);
 247
 248 /*
 249  * Stack-tracing filling.
 250  */
 251
 252 /*
 253  * Platform-dependent data-type to hold stack frames.
 254  */
 255 struct cfs_stack_trace;
 256
 257 /*
 258  * Fill @trace with current back-trace.
 259  */
 260 void cfs_stack_trace_fill(struct cfs_stack_trace *trace);
 261
 262 /*
 263  * Return instruction pointer for frame @frame_no. NULL if @frame_no is
 264  * invalid.
 265  */
 266 void *cfs_stack_trace_frame(struct cfs_stack_trace *trace, int frame_no);
 267
 268 #ifndef O_NOACCESS
 269 #define O_NOACCESS O_NONBLOCK
 270 #endif
 271
 272 /*
 273  * Universal open flags.
 274  */
 275 #define CFS_O_NOACCESS          0003
 276 #define CFS_O_ACCMODE           CFS_O_NOACCESS
 277 #define CFS_O_CREAT             0100
 278 #define CFS_O_EXCL              0200
 279 #define CFS_O_NOCTTY            0400
 280 #define CFS_O_TRUNC             01000
 281 #define CFS_O_APPEND            02000
 282 #define CFS_O_NONBLOCK          04000
 283 #define CFS_O_NDELAY            CFS_O_NONBLOCK
 284 #define CFS_O_SYNC              010000
 285 #define CFS_O_ASYNC             020000
 286 #define CFS_O_DIRECT            040000
 287 #define CFS_O_LARGEFILE         0100000
 288 #define CFS_O_DIRECTORY         0200000
 289 #define CFS_O_NOFOLLOW          0400000
 290 #define CFS_O_NOATIME           01000000
 291
 292 /* convert local open flags to universal open flags */
 293 int cfs_oflags2univ(int flags);
 294 /* convert universal open flags to local open flags */
 295 int cfs_univ2oflags(int flags);
 296
 297 /*
 298  * Random number handling
 299  */
 300
 301 /* returns a random 32-bit integer */
 302 unsigned int cfs_rand(void);
 303 /* seed the generator */
 304 void cfs_srand(unsigned int, unsigned int);
 305 void cfs_get_random_bytes(void *buf, int size);
 306
 307 #include <libcfs/libcfs_debug.h>
 308 #include <libcfs/libcfs_cpu.h>
 309 #include <libcfs/libcfs_private.h>
 310 #include <libcfs/libcfs_ioctl.h>
 311 #include <libcfs/libcfs_prim.h>
 312 #include <libcfs/libcfs_time.h>
 313 #include <libcfs/libcfs_string.h>
 314 #include <libcfs/libcfs_kernelcomm.h>
 315 #include <libcfs/libcfs_workitem.h>
 316 #include <libcfs/libcfs_hash.h>
 317 #include <libcfs/libcfs_fail.h>
 318 #include <libcfs/params_tree.h>
 319 #include <libcfs/libcfs_crypto.h>
 320
 321 /* container_of depends on "likely" which is defined in libcfs_private.h */
 322 static inline void *__container_of(void *ptr, unsigned long shift)
 323 {
 324         if (unlikely(IS_ERR(ptr) || ptr == NULL))
 325                 return ptr;
 326         else
 327                 return (char *)ptr - shift;
 328 }
 329
 330 #define container_of0(ptr, type, member) \
 331         ((type *)__container_of((void *)(ptr), offsetof(type, member)))
 332
 333 #define SET_BUT_UNUSED(a) do { } while(sizeof(a) - sizeof(a))
 334
 335 #define _LIBCFS_H
 336
 337 #endif /* _LIBCFS_H */