lustre/include/linux/lustre_lib.h

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  *
   4  *  Copyright (C) 2001 Cluster File Systems, Inc. <braam@clusterfs.com>
   5  *
   6  *   This file is part of Lustre, http://www.lustre.org.
   7  *
   8  *   Lustre is free software; you can redistribute it and/or
   9  *   modify it under the terms of version 2 of the GNU General Public
  10  *   License as published by the Free Software Foundation.
  11  *
  12  *   Lustre is distributed in the hope that it will be useful,
  13  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  *   GNU General Public License for more details.
  16  *
  17  *   You should have received a copy of the GNU General Public License
  18  *   along with Lustre; if not, write to the Free Software
  19  *   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  20  *
  21  * Basic Lustre library routines.
  22  *
  23  */
  24
  25 #ifndef _LUSTRE_LIB_H
  26 #define _LUSTRE_LIB_H
  27
  28 #ifndef __KERNEL__
  29 # include <string.h>
  30 # include <sys/types.h>
  31 #else
  32 # include <asm/semaphore.h>
  33 # include <linux/rwsem.h>
  34 # include <linux/sched.h>
  35 # include <linux/signal.h>
  36 # include <linux/types.h>
  37 #endif
  38 #include <linux/kp30.h>
  39 #include <linux/lustre_idl.h>
  40 #include <linux/lustre_cfg.h>
  41
  42 #ifndef LP_POISON
  43 #if BITS_PER_LONG > 32
  44 # define LI_POISON ((int)0x5a5a5a5a5a5a5a5a)
  45 # define LL_POISON ((long)0x5a5a5a5a5a5a5a5a)
  46 # define LP_POISON ((void *)(long)0x5a5a5a5a5a5a5a5a)
  47 #else
  48 # define LI_POISON ((int)0x5a5a5a5a)
  49 # define LL_POISON ((long)0x5a5a5a5a)
  50 # define LP_POISON ((void *)(long)0x5a5a5a5a)
  51 #endif
  52 #endif
  53
  54 #ifndef LPU64
  55 /* x86_64 has 64bit longs and defines u64 as long long */
  56 #if BITS_PER_LONG > 32 && !defined(__x86_64__)
  57 #define LPU64 "%lu"
  58 #define LPD64 "%ld"
  59 #define LPX64 "%#lx"
  60 #else
  61 #define LPU64 "%Lu"
  62 #define LPD64 "%Ld"
  63 #define LPX64 "%#Lx"
  64 #endif
  65 #endif
  66
  67 /* target.c */
  68 struct ptlrpc_request;
  69 struct recovd_data;
  70 struct recovd_obd;
  71 struct obd_export;
  72 #include <linux/lustre_ha.h>
  73 #include <linux/lustre_net.h>
  74 #include <linux/lustre_compat25.h>
  75 #include <linux/lvfs.h>
  76
  77 int target_handle_connect(struct ptlrpc_request *req);
  78 int target_handle_disconnect(struct ptlrpc_request *req);
  79 void target_destroy_export(struct obd_export *exp);
  80 int target_handle_reconnect(struct lustre_handle *conn, struct obd_export *exp,
  81                             struct obd_uuid *cluuid, int);
  82 int target_handle_ping(struct ptlrpc_request *req);
  83 void target_cancel_recovery_timer(struct obd_device *obd);
  84
  85 #define OBD_RECOVERY_TIMEOUT (obd_timeout * 5 * HZ / 2) /* *waves hands* */
  86 void target_start_recovery_timer(struct obd_device *obd);
  87 int target_start_recovery_thread(struct obd_device *obd,
  88                                   svc_handler_t handler);
  89 void target_stop_recovery_thread(struct obd_device *obd);
  90 void target_cleanup_recovery(struct obd_device *obd);
  91 int target_queue_recovery_request(struct ptlrpc_request *req,
  92                                   struct obd_device *obd);
  93 int target_queue_final_reply(struct ptlrpc_request *req, int rc);
  94 void target_send_reply(struct ptlrpc_request *req, int rc, int fail_id);
  95
  96 /* client.c */
  97
  98 int client_sanobd_setup(struct obd_device *obddev, obd_count len, void *buf);
  99 struct client_obd *client_conn2cli(struct lustre_handle *conn);
 100
 101 struct mdc_open_data;
 102 struct obd_client_handle {
 103         struct lustre_handle och_fh;
 104         struct llog_cookie och_cookie;
 105         struct mdc_open_data *och_mod;
 106         __u32 och_magic;
 107 };
 108 #define OBD_CLIENT_HANDLE_MAGIC 0xd15ea5ed
 109
 110 /* statfs_pack.c */
 111 void statfs_pack(struct obd_statfs *osfs, struct kstatfs *sfs);
 112 void statfs_unpack(struct kstatfs *sfs, struct obd_statfs *osfs);
 113
 114 /* l_lock.c */
 115 struct lustre_lock {
 116         int l_depth;
 117         struct task_struct *l_owner;
 118         struct semaphore l_sem;
 119         spinlock_t l_spin;
 120 };
 121
 122 void l_lock_init(struct lustre_lock *);
 123 void l_lock(struct lustre_lock *);
 124 void l_unlock(struct lustre_lock *);
 125 int l_has_lock(struct lustre_lock *);
 126
 127
 128 /*
 129  *   OBD IOCTLS
 130  */
 131 #define OBD_IOCTL_VERSION 0x00010004
 132
 133 struct obd_ioctl_data {
 134         uint32_t ioc_len;
 135         uint32_t ioc_version;
 136
 137         uint64_t ioc_cookie;
 138         uint32_t ioc_conn1;
 139         uint32_t ioc_conn2;
 140
 141         struct obdo ioc_obdo1;
 142         struct obdo ioc_obdo2;
 143
 144         obd_size         ioc_count;
 145         obd_off          ioc_offset;
 146         uint32_t         ioc_dev;
 147         uint32_t         ioc_command;
 148
 149         uint64_t ioc_nid;
 150         uint32_t ioc_nal;
 151         uint32_t ioc_type;
 152
 153         /* buffers the kernel will treat as user pointers */
 154         uint32_t ioc_plen1;
 155         char    *ioc_pbuf1;
 156         uint32_t ioc_plen2;
 157         char    *ioc_pbuf2;
 158
 159         /* inline buffers for various arguments */
 160         uint32_t ioc_inllen1;
 161         char    *ioc_inlbuf1;
 162         uint32_t ioc_inllen2;
 163         char    *ioc_inlbuf2;
 164         uint32_t ioc_inllen3;
 165         char    *ioc_inlbuf3;
 166         uint32_t ioc_inllen4;
 167         char    *ioc_inlbuf4;
 168
 169         char    ioc_bulk[0];
 170 };
 171
 172 struct obd_ioctl_hdr {
 173         uint32_t ioc_len;
 174         uint32_t ioc_version;
 175 };
 176
 177 static inline int obd_ioctl_packlen(struct obd_ioctl_data *data)
 178 {
 179         int len = size_round(sizeof(struct obd_ioctl_data));
 180         len += size_round(data->ioc_inllen1);
 181         len += size_round(data->ioc_inllen2);
 182         len += size_round(data->ioc_inllen3);
 183         len += size_round(data->ioc_inllen4);
 184         return len;
 185 }
 186
 187
 188 static inline int obd_ioctl_is_invalid(struct obd_ioctl_data *data)
 189 {
 190         if (data->ioc_len > (1<<30)) {
 191                 CERROR("OBD ioctl: ioc_len larger than 1<<30\n");
 192                 return 1;
 193         }
 194         if (data->ioc_inllen1 > (1<<30)) {
 195                 CERROR("OBD ioctl: ioc_inllen1 larger than 1<<30\n");
 196                 return 1;
 197         }
 198         if (data->ioc_inllen2 > (1<<30)) {
 199                 CERROR("OBD ioctl: ioc_inllen2 larger than 1<<30\n");
 200                 return 1;
 201         }
 202         if (data->ioc_inllen3 > (1<<30)) {
 203                 CERROR("OBD ioctl: ioc_inllen3 larger than 1<<30\n");
 204                 return 1;
 205         }
 206         if (data->ioc_inllen4 > (1<<30)) {
 207                 CERROR("OBD ioctl: ioc_inllen4 larger than 1<<30\n");
 208                 return 1;
 209         }
 210         if (data->ioc_inlbuf1 && !data->ioc_inllen1) {
 211                 CERROR("OBD ioctl: inlbuf1 pointer but 0 length\n");
 212                 return 1;
 213         }
 214         if (data->ioc_inlbuf2 && !data->ioc_inllen2) {
 215                 CERROR("OBD ioctl: inlbuf2 pointer but 0 length\n");
 216                 return 1;
 217         }
 218         if (data->ioc_inlbuf3 && !data->ioc_inllen3) {
 219                 CERROR("OBD ioctl: inlbuf3 pointer but 0 length\n");
 220                 return 1;
 221         }
 222         if (data->ioc_inlbuf4 && !data->ioc_inllen4) {
 223                 CERROR("OBD ioctl: inlbuf4 pointer but 0 length\n");
 224                 return 1;
 225         }
 226         if (data->ioc_pbuf1 && !data->ioc_plen1) {
 227                 CERROR("OBD ioctl: pbuf1 pointer but 0 length\n");
 228                 return 1;
 229         }
 230         if (data->ioc_pbuf2 && !data->ioc_plen2) {
 231                 CERROR("OBD ioctl: pbuf2 pointer but 0 length\n");
 232                 return 1;
 233         }
 234         if (data->ioc_plen1 && !data->ioc_pbuf1) {
 235                 CERROR("OBD ioctl: plen1 set but NULL pointer\n");
 236                 return 1;
 237         }
 238         if (data->ioc_plen2 && !data->ioc_pbuf2) {
 239                 CERROR("OBD ioctl: plen2 set but NULL pointer\n");
 240                 return 1;
 241         }
 242         if (obd_ioctl_packlen(data) != data->ioc_len) {
 243                 CERROR("OBD ioctl: packlen exceeds ioc_len (%d != %d)\n",
 244                         obd_ioctl_packlen(data), data->ioc_len);
 245                 return 1;
 246         }
 247         return 0;
 248 }
 249
 250 #ifndef __KERNEL__
 251 static inline int obd_ioctl_pack(struct obd_ioctl_data *data, char **pbuf,
 252                                  int max)
 253 {
 254         char *ptr;
 255         struct obd_ioctl_data *overlay;
 256         data->ioc_len = obd_ioctl_packlen(data);
 257         data->ioc_version = OBD_IOCTL_VERSION;
 258
 259         if (*pbuf && data->ioc_len > max)
 260                 return 1;
 261         if (*pbuf == NULL) {
 262                 *pbuf = malloc(data->ioc_len);
 263         }
 264         if (!*pbuf)
 265                 return 1;
 266         overlay = (struct obd_ioctl_data *)*pbuf;
 267         memcpy(*pbuf, data, sizeof(*data));
 268
 269         ptr = overlay->ioc_bulk;
 270         if (data->ioc_inlbuf1)
 271                 LOGL(data->ioc_inlbuf1, data->ioc_inllen1, ptr);
 272         if (data->ioc_inlbuf2)
 273                 LOGL(data->ioc_inlbuf2, data->ioc_inllen2, ptr);
 274         if (data->ioc_inlbuf3)
 275                 LOGL(data->ioc_inlbuf3, data->ioc_inllen3, ptr);
 276         if (data->ioc_inlbuf4)
 277                 LOGL(data->ioc_inlbuf4, data->ioc_inllen4, ptr);
 278         if (obd_ioctl_is_invalid(overlay))
 279                 return 1;
 280
 281         return 0;
 282 }
 283
 284 static inline int obd_ioctl_unpack(struct obd_ioctl_data *data, char *pbuf,
 285                                    int max)
 286 {
 287         char *ptr;
 288         struct obd_ioctl_data *overlay;
 289
 290         if (!pbuf)
 291                 return 1;
 292         overlay = (struct obd_ioctl_data *)pbuf;
 293
 294         /* Preserve the caller's buffer pointers */
 295         overlay->ioc_inlbuf1 = data->ioc_inlbuf1;
 296         overlay->ioc_inlbuf2 = data->ioc_inlbuf2;
 297         overlay->ioc_inlbuf3 = data->ioc_inlbuf3;
 298         overlay->ioc_inlbuf4 = data->ioc_inlbuf4;
 299
 300         memcpy(data, pbuf, sizeof(*data));
 301
 302         ptr = overlay->ioc_bulk;
 303         if (data->ioc_inlbuf1)
 304                 LOGU(data->ioc_inlbuf1, data->ioc_inllen1, ptr);
 305         if (data->ioc_inlbuf2)
 306                 LOGU(data->ioc_inlbuf2, data->ioc_inllen2, ptr);
 307         if (data->ioc_inlbuf3)
 308                 LOGU(data->ioc_inlbuf3, data->ioc_inllen3, ptr);
 309         if (data->ioc_inlbuf4)
 310                 LOGU(data->ioc_inlbuf4, data->ioc_inllen4, ptr);
 311
 312         return 0;
 313 }
 314 #endif
 315
 316 #include <linux/obd_support.h>
 317
 318 /* buffer MUST be at least the size of obd_ioctl_hdr */
 319 static inline int obd_ioctl_getdata(char **buf, int *len, void *arg)
 320 {
 321         struct obd_ioctl_hdr hdr;
 322         struct obd_ioctl_data *data;
 323         int err;
 324         int offset = 0;
 325         ENTRY;
 326
 327         err = copy_from_user(&hdr, (void *)arg, sizeof(hdr));
 328         if ( err ) {
 329                 EXIT;
 330                 return err;
 331         }
 332
 333         if (hdr.ioc_version != OBD_IOCTL_VERSION) {
 334                 CERROR("Version mismatch kernel vs application\n");
 335                 return -EINVAL;
 336         }
 337
 338         if (hdr.ioc_len > OBD_MAX_IOCTL_BUFFER) {
 339                 CERROR("User buffer len %d exceeds %d max buffer\n",
 340                        hdr.ioc_len, OBD_MAX_IOCTL_BUFFER);
 341                 return -EINVAL;
 342         }
 343
 344         if (hdr.ioc_len < sizeof(struct obd_ioctl_data)) {
 345                 CERROR("OBD: user buffer too small for ioctl\n");
 346                 return -EINVAL;
 347         }
 348
 349         /* XXX allocate this more intelligently, using kmalloc when
 350          * appropriate */
 351         OBD_VMALLOC(*buf, hdr.ioc_len);
 352         if (*buf == NULL) {
 353                 CERROR("Cannot allocate control buffer of len %d\n",
 354                        hdr.ioc_len);
 355                 RETURN(-EINVAL);
 356         }
 357         *len = hdr.ioc_len;
 358         data = (struct obd_ioctl_data *)*buf;
 359
 360         err = copy_from_user(*buf, (void *)arg, hdr.ioc_len);
 361         if ( err ) {
 362                 EXIT;
 363                 return err;
 364         }
 365
 366         if (obd_ioctl_is_invalid(data)) {
 367                 CERROR("ioctl not correctly formatted\n");
 368                 return -EINVAL;
 369         }
 370
 371         if (data->ioc_inllen1) {
 372                 data->ioc_inlbuf1 = &data->ioc_bulk[0];
 373                 offset += size_round(data->ioc_inllen1);
 374         }
 375
 376         if (data->ioc_inllen2) {
 377                 data->ioc_inlbuf2 = &data->ioc_bulk[0] + offset;
 378                 offset += size_round(data->ioc_inllen2);
 379         }
 380
 381         if (data->ioc_inllen3) {
 382                 data->ioc_inlbuf3 = &data->ioc_bulk[0] + offset;
 383                 offset += size_round(data->ioc_inllen3);
 384         }
 385
 386         if (data->ioc_inllen4) {
 387                 data->ioc_inlbuf4 = &data->ioc_bulk[0] + offset;
 388         }
 389
 390         EXIT;
 391         return 0;
 392 }
 393
 394 static inline void obd_ioctl_freedata(char *buf, int len)
 395 {
 396         ENTRY;
 397
 398         OBD_VFREE(buf, len);
 399         EXIT;
 400         return;
 401 }
 402
 403 #define OBD_IOC_CREATE                 _IOR ('f', 101, long)
 404 #define OBD_IOC_DESTROY                _IOW ('f', 104, long)
 405 #define OBD_IOC_PREALLOCATE            _IOWR('f', 105, long)
 406
 407 #define OBD_IOC_SETATTR                _IOW ('f', 107, long)
 408 #define OBD_IOC_GETATTR                _IOR ('f', 108, long)
 409 #define OBD_IOC_READ                   _IOWR('f', 109, long)
 410 #define OBD_IOC_WRITE                  _IOWR('f', 110, long)
 411
 412
 413 #define OBD_IOC_STATFS                 _IOWR('f', 113, long)
 414 #define OBD_IOC_SYNC                   _IOR ('f', 114, long)
 415 #define OBD_IOC_READ2                  _IOWR('f', 115, long)
 416 #define OBD_IOC_FORMAT                 _IOWR('f', 116, long)
 417 #define OBD_IOC_PARTITION              _IOWR('f', 117, long)
 418 #define OBD_IOC_COPY                   _IOWR('f', 120, long)
 419 #define OBD_IOC_MIGR                   _IOWR('f', 121, long)
 420 #define OBD_IOC_PUNCH                  _IOWR('f', 122, long)
 421
 422 #define OBD_IOC_MODULE_DEBUG           _IOWR('f', 124, long)
 423 #define OBD_IOC_BRW_READ               _IOWR('f', 125, long)
 424 #define OBD_IOC_BRW_WRITE              _IOWR('f', 126, long)
 425 #define OBD_IOC_NAME2DEV               _IOWR('f', 127, long)
 426 #define OBD_IOC_UUID2DEV               _IOWR('f', 130, long)
 427
 428 #define OBD_IOC_LOV_GET_CONFIG         _IOWR('f', 132, long)
 429 #define OBD_IOC_CLIENT_RECOVER         _IOW ('f', 133, long)
 430
 431 #define OBD_IOC_PING                   _IOWR('f', 135, long)
 432
 433 #define OBD_IOC_DEC_FS_USE_COUNT       _IO  ('f', 139      )
 434 #define OBD_IOC_NO_TRANSNO             _IOW ('f', 140, long)
 435 #define OBD_IOC_SET_READONLY           _IOW ('f', 141, long)
 436 #define OBD_IOC_ABORT_RECOVERY         _IOR ('f', 142, long)
 437 #define OBD_IOC_ROOT_SQUASH            _IOWR('f', 143, long)
 438
 439 #define OBD_GET_VERSION                _IOWR ('f', 144, long)
 440
 441 #define OBD_IOC_CLOSE_UUID             _IOWR ('f', 147, long)
 442
 443 #define OBD_IOC_LOV_SETSTRIPE            _IOW ('f', 154, long)
 444 #define OBD_IOC_LOV_GETSTRIPE            _IOW ('f', 155, long)
 445 #define OBD_IOC_LOV_SETEA                _IOW ('f', 156, long)
 446
 447 #define OBD_IOC_MOUNTOPT               _IOWR('f', 170, long)
 448
 449 #define OBD_IOC_RECORD                 _IOWR('f', 180, long)
 450 #define OBD_IOC_ENDRECORD              _IOWR('f', 181, long)
 451 #define OBD_IOC_PARSE                  _IOWR('f', 182, long)
 452 #define OBD_IOC_DORECORD               _IOWR('f', 183, long)
 453 #define OBD_IOC_PROCESS_CFG            _IOWR('f', 184, long)
 454 #define OBD_IOC_DUMP_LOG               _IOWR('f', 185, long)
 455 #define OBD_IOC_CLEAR_LOG              _IOWR('f', 186, long)
 456
 457 #define OBD_IOC_CATLOGLIST             _IOWR('f', 190, long)
 458 #define OBD_IOC_LLOG_INFO              _IOWR('f', 191, long)
 459 #define OBD_IOC_LLOG_PRINT             _IOWR('f', 192, long)
 460 #define OBD_IOC_LLOG_CANCEL            _IOWR('f', 193, long)
 461 #define OBD_IOC_LLOG_REMOVE            _IOWR('f', 194, long)
 462 #define OBD_IOC_LLOG_CHECK             _IOWR('f', 195, long)
 463 #define OBD_IOC_LLOG_CATINFO           _IOWR('f', 196, long)
 464
 465 #define ECHO_IOC_GET_STRIPE            _IOWR('f', 200, long)
 466 #define ECHO_IOC_SET_STRIPE            _IOWR('f', 201, long)
 467 #define ECHO_IOC_ENQUEUE               _IOWR('f', 202, long)
 468 #define ECHO_IOC_CANCEL                _IOWR('f', 203, long)
 469
 470 #define OBD_IOC_CMOBD_SYNC             _IOWR('f', 210, long)
 471
 472 #define OBD_IOC_COBD_CON               _IOWR('f', 220, long)
 473 #define OBD_IOC_COBD_COFF              _IOWR('f', 221, long)
 474 #define OBD_IOC_COBD_CFLUSH            _IOWR('f', 222, long)
 475
 476 #define OBD_IOC_SMFS_SNAP_ADD          _IOWR('f', 230, long)
 477
 478 /* XXX _IOWR('f', 250, long) has been defined in
 479  * portals/include/linux/kp30.h for debug, don't use it
 480  */
 481
 482 /* Until such time as we get_info the per-stripe maximum from the OST,
 483  * we define this to be 2T - 4k, which is the ext3 maxbytes. */
 484 #define LUSTRE_STRIPE_MAXBYTES 0x1fffffff000ULL
 485
 486 #define CHECKSUM_BULK 0
 487 #define POISON_BULK 0
 488
 489 #if CHECKSUM_BULK
 490 static inline void ost_checksum(obd_count *cksum, void *addr, int len)
 491 {
 492         unsigned char *ptr = (unsigned char *)addr;
 493         obd_count          sum = 0;
 494
 495         /* very stupid, but means I don't have to think about byte order */
 496         while (len-- > 0)
 497                 sum += *ptr++;
 498
 499         *cksum = (*cksum << 2) + sum;
 500 }
 501 #endif
 502
 503 static inline int ll_insecure_random_int(void)
 504 {
 505         struct timeval t;
 506         do_gettimeofday(&t);
 507         return (int)(t.tv_usec);
 508 }
 509
 510 /*
 511  * l_wait_event is a flexible sleeping function, permitting simple caller
 512  * configuration of interrupt and timeout sensitivity along with actions to
 513  * be performed in the event of either exception.
 514  *
 515  * Common usage looks like this:
 516  *
 517  * struct l_wait_info lwi = LWI_TIMEOUT_INTR(timeout, timeout_handler,
 518  *                                           intr_handler, callback_data);
 519  * rc = l_wait_event(waitq, condition, &lwi);
 520  *
 521  * (LWI_TIMEOUT and LWI_INTR macros are available for timeout- and
 522  * interrupt-only variants, respectively.)
 523  *
 524  * If a timeout is specified, the timeout_handler will be invoked in the event
 525  * that the timeout expires before the process is awakened.  (Note that any
 526  * waking of the process will restart the timeout, even if the condition is
 527  * not satisfied and the process immediately returns to sleep.  This might be
 528  * considered a bug.)  If the timeout_handler returns non-zero, l_wait_event
 529  * will return -ETIMEDOUT and the caller will continue.  If the handler returns
 530  * zero instead, the process will go back to sleep until it is awakened by the
 531  * waitq or some similar mechanism, or an interrupt occurs (if the caller has
 532  * asked for interrupts to be detected).  The timeout will only fire once, so
 533  * callers should take care that a timeout_handler which returns zero will take
 534  * future steps to awaken the process.  N.B. that these steps must include
 535  * making the provided condition become true.
 536  *
 537  * If the interrupt flag (lwi_signals) is non-zero, then the process will be
 538  * interruptible, and will be awakened by any "killable" signal (SIGTERM,
 539  * SIGKILL or SIGINT).  If a timeout is also specified, then the process will
 540  * only become interruptible _after_ the timeout has expired, though it can be
 541  * awakened by a signal that was delivered before the timeout and is still
 542  * pending when the timeout expires.  If a timeout is not specified, the process
 543  * will be interruptible at all times during l_wait_event.
 544  */
 545
 546 struct l_wait_info {
 547         long   lwi_timeout;
 548         int  (*lwi_on_timeout)(void *);
 549         long   lwi_signals;
 550         void (*lwi_on_signal)(void *);
 551         void  *lwi_cb_data;
 552 };
 553
 554 #define LWI_TIMEOUT(time, cb, data)                                            \
 555 ((struct l_wait_info) {                                                        \
 556         lwi_timeout:    time,                                                  \
 557         lwi_on_timeout: cb,                                                    \
 558         lwi_cb_data:    data                                                   \
 559 })
 560
 561 #define LWI_INTR(cb, data)                                                     \
 562 ((struct l_wait_info) {                                                        \
 563         lwi_signals:   1,                                                      \
 564         lwi_on_signal: cb,                                                     \
 565         lwi_cb_data:   data                                                    \
 566 })
 567
 568 #define LWI_TIMEOUT_INTR(time, time_cb, sig_cb, data)                          \
 569 ((struct l_wait_info) {                                                        \
 570         lwi_timeout:    time,                                                  \
 571         lwi_on_timeout: time_cb,                                               \
 572         lwi_signals:    1,                                                     \
 573         lwi_on_signal:  sig_cb,                                                \
 574         lwi_cb_data:    data                                                   \
 575 })
 576
 577 #define LUSTRE_FATAL_SIGS (sigmask(SIGKILL) | sigmask(SIGINT) |                \
 578                            sigmask(SIGTERM) | sigmask(SIGQUIT) |               \
 579                            sigmask(SIGALRM))
 580
 581 #ifdef __KERNEL__
 582 static inline sigset_t l_w_e_set_sigs(int sigs)
 583 {
 584         sigset_t old;
 585         unsigned long irqflags;
 586
 587         SIGNAL_MASK_LOCK(current, irqflags);
 588         old = current->blocked;
 589         siginitsetinv(&current->blocked, sigs);
 590         RECALC_SIGPENDING;
 591         SIGNAL_MASK_UNLOCK(current, irqflags);
 592
 593         return old;
 594 }
 595
 596 #define __l_wait_event(wq, condition, info, ret, excl)                         \
 597 do {                                                                           \
 598         wait_queue_t __wait;                                                   \
 599         int __timed_out = 0;                                                   \
 600         unsigned long irqflags;                                                \
 601         sigset_t blocked;                                                      \
 602                                                                                \
 603         init_waitqueue_entry(&__wait, current);                                \
 604         if (excl)                                                              \
 605             add_wait_queue_exclusive(&wq, &__wait);                            \
 606         else                                                                   \
 607             add_wait_queue(&wq, &__wait);                                      \
 608                                                                                \
 609         /* Block all signals (just the non-fatal ones if no timeout). */       \
 610         if (info->lwi_signals && !info->lwi_timeout)                           \
 611             blocked = l_w_e_set_sigs(LUSTRE_FATAL_SIGS);                       \
 612         else                                                                   \
 613             blocked = l_w_e_set_sigs(0);                                       \
 614                                                                                \
 615         for (;;) {                                                             \
 616             set_current_state(TASK_INTERRUPTIBLE);                             \
 617             if (condition)                                                     \
 618                     break;                                                     \
 619             if (signal_pending(current)) {                                     \
 620                 if (info->lwi_on_signal)                                       \
 621                         info->lwi_on_signal(info->lwi_cb_data);                \
 622                 ret = -EINTR;                                                  \
 623                 break;                                                         \
 624             }                                                                  \
 625             if (info->lwi_timeout && !__timed_out) {                           \
 626                 if (schedule_timeout(info->lwi_timeout) == 0) {                \
 627                     __timed_out = 1;                                           \
 628                     if (!info->lwi_on_timeout ||                               \
 629                         info->lwi_on_timeout(info->lwi_cb_data)) {             \
 630                         ret = -ETIMEDOUT;                                      \
 631                         break;                                                 \
 632                     }                                                          \
 633                     /* We'll take signals after a timeout. */                  \
 634                     if (info->lwi_signals)                                     \
 635                         (void)l_w_e_set_sigs(LUSTRE_FATAL_SIGS);               \
 636                 }                                                              \
 637             } else {                                                           \
 638                 schedule();                                                    \
 639             }                                                                  \
 640         }                                                                      \
 641                                                                                \
 642         SIGNAL_MASK_LOCK(current, irqflags);                                   \
 643         current->blocked = blocked;                                            \
 644         RECALC_SIGPENDING;                                                     \
 645         SIGNAL_MASK_UNLOCK(current, irqflags);                                 \
 646                                                                                \
 647         current->state = TASK_RUNNING;                                         \
 648         remove_wait_queue(&wq, &__wait);                                       \
 649 } while(0)
 650
 651 #else /* !__KERNEL__ */
 652 #define __l_wait_event(wq, condition, info, ret, excl)                         \
 653 do {                                                                           \
 654         int timeout = info->lwi_timeout, elapse;                               \
 655         int __timed_out = 0;                                                   \
 656         long last;                                                             \
 657                                                                                \
 658         last = time(NULL);                                                     \
 659         for (;;) {                                                             \
 660             if (condition)                                                     \
 661                 break;                                                         \
 662             if (liblustre_wait_event(timeout)) {                               \
 663                 if (timeout == 0)                                              \
 664                         continue;                                              \
 665                 elapse = (int) (time(NULL) - last);                            \
 666                 if (elapse) {                                                  \
 667                         last += elapse;                                        \
 668                         timeout -= elapse;                                     \
 669                         if (timeout < 0)                                       \
 670                                 timeout = 0;                                   \
 671                 }                                                              \
 672                 continue;                                                      \
 673             }                                                                 \
 674             if (info->lwi_timeout && !__timed_out) {                           \
 675                 __timed_out = 1;                                               \
 676                 if (info->lwi_on_timeout == NULL ||                            \
 677                     info->lwi_on_timeout(info->lwi_cb_data)) {                 \
 678                     ret = -ETIMEDOUT;                                          \
 679                     break;                                                     \
 680                 }                                                              \
 681             }                                                                  \
 682         }                                                                      \
 683 } while (0)
 684
 685 #endif /* __KERNEL__ */
 686
 687 #define l_wait_event(wq, condition, info)                                      \
 688 ({                                                                             \
 689         int __ret = 0;                                                         \
 690         struct l_wait_info *__info = (info);                                   \
 691         if (!(condition))                                                      \
 692                 __l_wait_event(wq, condition, __info, __ret, 0);               \
 693         __ret;                                                                 \
 694 })
 695
 696 #define l_wait_event_exclusive(wq, condition, info)                            \
 697 ({                                                                             \
 698         int __ret = 0;                                                         \
 699         struct l_wait_info *__info = (info);                                   \
 700         if (!(condition))                                                      \
 701                 __l_wait_event(wq, condition, __info, __ret, 1);               \
 702         __ret;                                                                 \
 703 })
 704
 705 #endif /* _LUSTRE_LIB_H */
 706
 707 #define LMD_MAGIC 0xbdacbdac
 708
 709 #define lmd_bad_magic(LMDP)                                             \
 710 ({                                                                      \
 711         struct lustre_mount_data *_lmd__ = (LMDP);                      \
 712         int _ret__ = 0;                                                 \
 713         if (!_lmd__) {                                                  \
 714                 CERROR("Missing mount data: "                           \
 715                        "check that /sbin/mount.lustre is installed.\n");\
 716                 _ret__ = 1;                                             \
 717         } else if (_lmd__->lmd_magic != LMD_MAGIC) {                    \
 718                 CERROR("Invalid mount data (%#x != %#x): "              \
 719                        "check that /sbin/mount.lustre is installed\n",  \
 720                        _lmd__->lmd_magic, LMD_MAGIC);                   \
 721                 _ret__ = 1;                                             \
 722         }                                                               \
 723         _ret__;                                                         \
 724 })
 725