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