lustre/include/lustre_lib.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  * lustre/include/lustre_lib.h
  37  *
  38  * Basic Lustre library routines.
  39  */
  40
  41 #ifndef _LUSTRE_LIB_H
  42 #define _LUSTRE_LIB_H
  43
  44 #include <libcfs/libcfs.h>
  45 #include <lustre/lustre_idl.h>
  46 #include <lustre_ver.h>
  47 #include <lustre_cfg.h>
  48 #if defined(__linux__)
  49 #include <linux/lustre_lib.h>
  50 #elif defined(__APPLE__)
  51 #include <darwin/lustre_lib.h>
  52 #elif defined(__WINNT__)
  53 #include <winnt/lustre_lib.h>
  54 #else
  55 #error Unsupported operating system.
  56 #endif
  57
  58 /* prng.c */
  59 unsigned int ll_rand(void);        /* returns a random 32-bit integer */
  60 void ll_srand(unsigned int, unsigned int);     /* seed the generator */
  61 void ll_get_random_bytes(void *buf, int size);
  62
  63 /* target.c */
  64 struct ptlrpc_request;
  65 struct recovd_data;
  66 struct recovd_obd;
  67 struct obd_export;
  68 #include <lustre_ha.h>
  69 #include <lustre_net.h>
  70 #include <lvfs.h>
  71
  72 void target_client_add_cb(struct obd_device *obd, __u64 transno, void *cb_data,
  73                           int error);
  74 int target_handle_connect(struct ptlrpc_request *req);
  75 int target_handle_disconnect(struct ptlrpc_request *req);
  76 void target_destroy_export(struct obd_export *exp);
  77 int target_pack_pool_reply(struct ptlrpc_request *req);
  78 int target_handle_ping(struct ptlrpc_request *req);
  79 void target_committed_to_req(struct ptlrpc_request *req);
  80
  81 /* quotacheck callback, dqacq/dqrel callback handler */
  82 int target_handle_qc_callback(struct ptlrpc_request *req);
  83 #ifdef HAVE_QUOTA_SUPPORT
  84 int target_handle_dqacq_callback(struct ptlrpc_request *req);
  85 #else
  86 #define target_handle_dqacq_callback(req) ldlm_callback_reply(req, -ENOTSUPP)
  87 #endif
  88
  89 #define OBD_RECOVERY_MAX_TIME (obd_timeout * 18) /* b13079 */
  90
  91 void target_cancel_recovery_timer(struct obd_device *obd);
  92 int target_start_recovery_thread(struct obd_device *obd,
  93                                  svc_handler_t handler);
  94 void target_stop_recovery_thread(struct obd_device *obd);
  95 void target_cleanup_recovery(struct obd_device *obd);
  96 int target_queue_recovery_request(struct ptlrpc_request *req,
  97                                   struct obd_device *obd);
  98 void target_send_reply(struct ptlrpc_request *req, int rc, int fail_id);
  99
 100 /* client.c */
 101
 102 int client_sanobd_setup(struct obd_device *obddev, struct lustre_cfg* lcfg);
 103 struct client_obd *client_conn2cli(struct lustre_handle *conn);
 104
 105 struct md_open_data;
 106 struct obd_client_handle {
 107         struct lustre_handle  och_fh;
 108         struct lu_fid         och_fid;
 109         struct md_open_data *och_mod;
 110         __u32 och_magic;
 111         int och_flags;
 112 };
 113 #define OBD_CLIENT_HANDLE_MAGIC 0xd15ea5ed
 114
 115 /* statfs_pack.c */
 116 void statfs_pack(struct obd_statfs *osfs, struct kstatfs *sfs);
 117 void statfs_unpack(struct kstatfs *sfs, struct obd_statfs *osfs);
 118
 119 /* l_lock.c */
 120 struct lustre_lock {
 121         int l_depth;
 122         cfs_task_t *l_owner;
 123         struct semaphore l_sem;
 124         spinlock_t l_spin;
 125 };
 126
 127 void l_lock_init(struct lustre_lock *);
 128 void l_lock(struct lustre_lock *);
 129 void l_unlock(struct lustre_lock *);
 130 int l_has_lock(struct lustre_lock *);
 131
 132
 133 /*
 134  *   OBD IOCTLS
 135  */
 136 #define OBD_IOCTL_VERSION 0x00010004
 137
 138 struct obd_ioctl_data {
 139         __u32 ioc_len;
 140         __u32 ioc_version;
 141
 142         __u64 ioc_cookie;
 143         __u32 ioc_conn1;
 144         __u32 ioc_conn2;
 145
 146         struct obdo ioc_obdo1;
 147         struct obdo ioc_obdo2;
 148
 149         obd_size ioc_count;
 150         obd_off  ioc_offset;
 151         __u32    ioc_dev;
 152         __u32    ioc_command;
 153
 154         __u64 ioc_nid;
 155         __u32 ioc_nal;
 156         __u32 ioc_type;
 157
 158         /* buffers the kernel will treat as user pointers */
 159         __u32  ioc_plen1;
 160         char  *ioc_pbuf1;
 161         __u32  ioc_plen2;
 162         char  *ioc_pbuf2;
 163
 164         /* inline buffers for various arguments */
 165         __u32  ioc_inllen1;
 166         char  *ioc_inlbuf1;
 167         __u32  ioc_inllen2;
 168         char  *ioc_inlbuf2;
 169         __u32  ioc_inllen3;
 170         char  *ioc_inlbuf3;
 171         __u32  ioc_inllen4;
 172         char  *ioc_inlbuf4;
 173
 174         char    ioc_bulk[0];
 175 };
 176
 177 struct obd_ioctl_hdr {
 178         __u32 ioc_len;
 179         __u32 ioc_version;
 180 };
 181
 182 static inline int obd_ioctl_packlen(struct obd_ioctl_data *data)
 183 {
 184         int len = size_round(sizeof(struct obd_ioctl_data));
 185         len += size_round(data->ioc_inllen1);
 186         len += size_round(data->ioc_inllen2);
 187         len += size_round(data->ioc_inllen3);
 188         len += size_round(data->ioc_inllen4);
 189         return len;
 190 }
 191
 192
 193 static inline int obd_ioctl_is_invalid(struct obd_ioctl_data *data)
 194 {
 195         if (data->ioc_len > (1<<30)) {
 196                 CERROR("OBD ioctl: ioc_len larger than 1<<30\n");
 197                 return 1;
 198         }
 199         if (data->ioc_inllen1 > (1<<30)) {
 200                 CERROR("OBD ioctl: ioc_inllen1 larger than 1<<30\n");
 201                 return 1;
 202         }
 203         if (data->ioc_inllen2 > (1<<30)) {
 204                 CERROR("OBD ioctl: ioc_inllen2 larger than 1<<30\n");
 205                 return 1;
 206         }
 207         if (data->ioc_inllen3 > (1<<30)) {
 208                 CERROR("OBD ioctl: ioc_inllen3 larger than 1<<30\n");
 209                 return 1;
 210         }
 211         if (data->ioc_inllen4 > (1<<30)) {
 212                 CERROR("OBD ioctl: ioc_inllen4 larger than 1<<30\n");
 213                 return 1;
 214         }
 215         if (data->ioc_inlbuf1 && !data->ioc_inllen1) {
 216                 CERROR("OBD ioctl: inlbuf1 pointer but 0 length\n");
 217                 return 1;
 218         }
 219         if (data->ioc_inlbuf2 && !data->ioc_inllen2) {
 220                 CERROR("OBD ioctl: inlbuf2 pointer but 0 length\n");
 221                 return 1;
 222         }
 223         if (data->ioc_inlbuf3 && !data->ioc_inllen3) {
 224                 CERROR("OBD ioctl: inlbuf3 pointer but 0 length\n");
 225                 return 1;
 226         }
 227         if (data->ioc_inlbuf4 && !data->ioc_inllen4) {
 228                 CERROR("OBD ioctl: inlbuf4 pointer but 0 length\n");
 229                 return 1;
 230         }
 231         if (data->ioc_pbuf1 && !data->ioc_plen1) {
 232                 CERROR("OBD ioctl: pbuf1 pointer but 0 length\n");
 233                 return 1;
 234         }
 235         if (data->ioc_pbuf2 && !data->ioc_plen2) {
 236                 CERROR("OBD ioctl: pbuf2 pointer but 0 length\n");
 237                 return 1;
 238         }
 239         if (data->ioc_plen1 && !data->ioc_pbuf1) {
 240                 CERROR("OBD ioctl: plen1 set but NULL pointer\n");
 241                 return 1;
 242         }
 243         if (data->ioc_plen2 && !data->ioc_pbuf2) {
 244                 CERROR("OBD ioctl: plen2 set but NULL pointer\n");
 245                 return 1;
 246         }
 247         if (obd_ioctl_packlen(data) > data->ioc_len) {
 248                 CERROR("OBD ioctl: packlen exceeds ioc_len (%d > %d)\n",
 249                        obd_ioctl_packlen(data), data->ioc_len);
 250                 return 1;
 251         }
 252         return 0;
 253 }
 254
 255 #ifndef __KERNEL__
 256 static inline int obd_ioctl_pack(struct obd_ioctl_data *data, char **pbuf,
 257                                  int max)
 258 {
 259         char *ptr;
 260         struct obd_ioctl_data *overlay;
 261         data->ioc_len = obd_ioctl_packlen(data);
 262         data->ioc_version = OBD_IOCTL_VERSION;
 263
 264         if (*pbuf && data->ioc_len > max)
 265                 return -EINVAL;
 266         if (*pbuf == NULL) {
 267                 *pbuf = malloc(data->ioc_len);
 268         }
 269         if (!*pbuf)
 270                 return -ENOMEM;
 271         overlay = (struct obd_ioctl_data *)*pbuf;
 272         memcpy(*pbuf, data, sizeof(*data));
 273
 274         ptr = overlay->ioc_bulk;
 275         if (data->ioc_inlbuf1)
 276                 LOGL(data->ioc_inlbuf1, data->ioc_inllen1, ptr);
 277         if (data->ioc_inlbuf2)
 278                 LOGL(data->ioc_inlbuf2, data->ioc_inllen2, ptr);
 279         if (data->ioc_inlbuf3)
 280                 LOGL(data->ioc_inlbuf3, data->ioc_inllen3, ptr);
 281         if (data->ioc_inlbuf4)
 282                 LOGL(data->ioc_inlbuf4, data->ioc_inllen4, ptr);
 283         if (obd_ioctl_is_invalid(overlay))
 284                 return -EINVAL;
 285
 286         return 0;
 287 }
 288
 289 static inline int obd_ioctl_unpack(struct obd_ioctl_data *data, char *pbuf,
 290                                    int max)
 291 {
 292         char *ptr;
 293         struct obd_ioctl_data *overlay;
 294
 295         if (!pbuf)
 296                 return 1;
 297         overlay = (struct obd_ioctl_data *)pbuf;
 298
 299         /* Preserve the caller's buffer pointers */
 300         overlay->ioc_inlbuf1 = data->ioc_inlbuf1;
 301         overlay->ioc_inlbuf2 = data->ioc_inlbuf2;
 302         overlay->ioc_inlbuf3 = data->ioc_inlbuf3;
 303         overlay->ioc_inlbuf4 = data->ioc_inlbuf4;
 304
 305         memcpy(data, pbuf, sizeof(*data));
 306
 307         ptr = overlay->ioc_bulk;
 308         if (data->ioc_inlbuf1)
 309                 LOGU(data->ioc_inlbuf1, data->ioc_inllen1, ptr);
 310         if (data->ioc_inlbuf2)
 311                 LOGU(data->ioc_inlbuf2, data->ioc_inllen2, ptr);
 312         if (data->ioc_inlbuf3)
 313                 LOGU(data->ioc_inlbuf3, data->ioc_inllen3, ptr);
 314         if (data->ioc_inlbuf4)
 315                 LOGU(data->ioc_inlbuf4, data->ioc_inllen4, ptr);
 316
 317         return 0;
 318 }
 319 #endif
 320
 321 #include <obd_support.h>
 322
 323 #ifdef __KERNEL__
 324 /* function defined in lustre/obdclass/<platform>/<platform>-module.c */
 325 int obd_ioctl_getdata(char **buf, int *len, void *arg);
 326 int obd_ioctl_popdata(void *arg, void *data, int len);
 327 #else
 328 /* buffer MUST be at least the size of obd_ioctl_hdr */
 329 static inline int obd_ioctl_getdata(char **buf, int *len, void *arg)
 330 {
 331         struct obd_ioctl_hdr hdr;
 332         struct obd_ioctl_data *data;
 333         int err;
 334         int offset = 0;
 335         ENTRY;
 336
 337         err = copy_from_user(&hdr, (void *)arg, sizeof(hdr));
 338         if (err)
 339                 RETURN(err);
 340
 341         if (hdr.ioc_version != OBD_IOCTL_VERSION) {
 342                 CERROR("Version mismatch kernel vs application\n");
 343                 RETURN(-EINVAL);
 344         }
 345
 346         if (hdr.ioc_len > OBD_MAX_IOCTL_BUFFER) {
 347                 CERROR("User buffer len %d exceeds %d max buffer\n",
 348                        hdr.ioc_len, OBD_MAX_IOCTL_BUFFER);
 349                 RETURN(-EINVAL);
 350         }
 351
 352         if (hdr.ioc_len < sizeof(struct obd_ioctl_data)) {
 353                 CERROR("User buffer too small for ioctl (%d)\n", hdr.ioc_len);
 354                 RETURN(-EINVAL);
 355         }
 356
 357         /* XXX allocate this more intelligently, using kmalloc when
 358          * appropriate */
 359         OBD_VMALLOC(*buf, hdr.ioc_len);
 360         if (*buf == NULL) {
 361                 CERROR("Cannot allocate control buffer of len %d\n",
 362                        hdr.ioc_len);
 363                 RETURN(-EINVAL);
 364         }
 365         *len = hdr.ioc_len;
 366         data = (struct obd_ioctl_data *)*buf;
 367
 368         err = copy_from_user(*buf, (void *)arg, hdr.ioc_len);
 369         if (err) {
 370                 OBD_VFREE(*buf, hdr.ioc_len);
 371                 RETURN(err);
 372         }
 373
 374         if (obd_ioctl_is_invalid(data)) {
 375                 CERROR("ioctl not correctly formatted\n");
 376                 OBD_VFREE(*buf, hdr.ioc_len);
 377                 RETURN(-EINVAL);
 378         }
 379
 380         if (data->ioc_inllen1) {
 381                 data->ioc_inlbuf1 = &data->ioc_bulk[0];
 382                 offset += size_round(data->ioc_inllen1);
 383         }
 384
 385         if (data->ioc_inllen2) {
 386                 data->ioc_inlbuf2 = &data->ioc_bulk[0] + offset;
 387                 offset += size_round(data->ioc_inllen2);
 388         }
 389
 390         if (data->ioc_inllen3) {
 391                 data->ioc_inlbuf3 = &data->ioc_bulk[0] + offset;
 392                 offset += size_round(data->ioc_inllen3);
 393         }
 394
 395         if (data->ioc_inllen4) {
 396                 data->ioc_inlbuf4 = &data->ioc_bulk[0] + offset;
 397         }
 398
 399         RETURN(0);
 400 }
 401
 402 static inline int obd_ioctl_popdata(void *arg, void *data, int len)
 403 {
 404         int err = copy_to_user(arg, data, len);
 405         if (err)
 406                 err = -EFAULT;
 407         return err;
 408 }
 409 #endif
 410
 411 static inline void obd_ioctl_freedata(char *buf, int len)
 412 {
 413         ENTRY;
 414
 415         OBD_VFREE(buf, len);
 416         EXIT;
 417         return;
 418 }
 419
 420 /*
 421  * BSD ioctl description:
 422  * #define IOC_V1       _IOR(g, n1, long)
 423  * #define IOC_V2       _IOW(g, n2, long)
 424  *
 425  * ioctl(f, IOC_V1, arg);
 426  * arg will be treated as a long value,
 427  *
 428  * ioctl(f, IOC_V2, arg)
 429  * arg will be treated as a pointer, bsd will call
 430  * copyin(buf, arg, sizeof(long))
 431  *
 432  * To make BSD ioctl handles argument correctly and simplely,
 433  * we change _IOR to _IOWR so BSD will copyin obd_ioctl_data
 434  * for us. Does this change affect Linux?  (XXX Liang)
 435  */
 436 #define OBD_IOC_CREATE                 _IOWR('f', 101, OBD_IOC_DATA_TYPE)
 437 #define OBD_IOC_DESTROY                _IOW ('f', 104, OBD_IOC_DATA_TYPE)
 438 #define OBD_IOC_PREALLOCATE            _IOWR('f', 105, OBD_IOC_DATA_TYPE)
 439
 440 #define OBD_IOC_SETATTR                _IOW ('f', 107, OBD_IOC_DATA_TYPE)
 441 #define OBD_IOC_GETATTR                _IOWR ('f', 108, OBD_IOC_DATA_TYPE)
 442 #define OBD_IOC_READ                   _IOWR('f', 109, OBD_IOC_DATA_TYPE)
 443 #define OBD_IOC_WRITE                  _IOWR('f', 110, OBD_IOC_DATA_TYPE)
 444
 445
 446 #define OBD_IOC_STATFS                 _IOWR('f', 113, OBD_IOC_DATA_TYPE)
 447 #define OBD_IOC_SYNC                   _IOW ('f', 114, OBD_IOC_DATA_TYPE)
 448 #define OBD_IOC_READ2                  _IOWR('f', 115, OBD_IOC_DATA_TYPE)
 449 #define OBD_IOC_FORMAT                 _IOWR('f', 116, OBD_IOC_DATA_TYPE)
 450 #define OBD_IOC_PARTITION              _IOWR('f', 117, OBD_IOC_DATA_TYPE)
 451 #define OBD_IOC_COPY                   _IOWR('f', 120, OBD_IOC_DATA_TYPE)
 452 #define OBD_IOC_MIGR                   _IOWR('f', 121, OBD_IOC_DATA_TYPE)
 453 #define OBD_IOC_PUNCH                  _IOWR('f', 122, OBD_IOC_DATA_TYPE)
 454
 455 #define OBD_IOC_MODULE_DEBUG           _IOWR('f', 124, OBD_IOC_DATA_TYPE)
 456 #define OBD_IOC_BRW_READ               _IOWR('f', 125, OBD_IOC_DATA_TYPE)
 457 #define OBD_IOC_BRW_WRITE              _IOWR('f', 126, OBD_IOC_DATA_TYPE)
 458 #define OBD_IOC_NAME2DEV               _IOWR('f', 127, OBD_IOC_DATA_TYPE)
 459 #define OBD_IOC_UUID2DEV               _IOWR('f', 130, OBD_IOC_DATA_TYPE)
 460 #define OBD_IOC_GETNAME                _IOWR('f', 131, OBD_IOC_DATA_TYPE)
 461
 462 #define OBD_IOC_LOV_GET_CONFIG         _IOWR('f', 132, OBD_IOC_DATA_TYPE)
 463 #define OBD_IOC_CLIENT_RECOVER         _IOW ('f', 133, OBD_IOC_DATA_TYPE)
 464 #define OBD_IOC_PING_TARGET            _IOW ('f', 136, OBD_IOC_DATA_TYPE)
 465
 466 #define OBD_IOC_DEC_FS_USE_COUNT       _IO  ('f', 139      )
 467 #define OBD_IOC_NO_TRANSNO             _IOW ('f', 140, OBD_IOC_DATA_TYPE)
 468 #define OBD_IOC_SET_READONLY           _IOW ('f', 141, OBD_IOC_DATA_TYPE)
 469 #define OBD_IOC_ABORT_RECOVERY         _IOR ('f', 142, OBD_IOC_DATA_TYPE)
 470
 471 #define OBD_IOC_ROOT_SQUASH            _IOWR('f', 143, OBD_IOC_DATA_TYPE)
 472
 473 #define OBD_GET_VERSION                _IOWR ('f', 144, OBD_IOC_DATA_TYPE)
 474
 475 #define OBD_IOC_GSS_SUPPORT            _IOWR('f', 145, OBD_IOC_DATA_TYPE)
 476
 477 #define OBD_IOC_CLOSE_UUID             _IOWR ('f', 147, OBD_IOC_DATA_TYPE)
 478
 479 #define OBD_IOC_GETDEVICE              _IOWR ('f', 149, OBD_IOC_DATA_TYPE)
 480 #define OBD_IOC_FID2PATH               _IOWR ('f', 150, OBD_IOC_DATA_TYPE)
 481
 482 #define OBD_IOC_LOV_SETSTRIPE          _IOW ('f', 154, OBD_IOC_DATA_TYPE)
 483 #define OBD_IOC_LOV_GETSTRIPE          _IOW ('f', 155, OBD_IOC_DATA_TYPE)
 484 #define OBD_IOC_LOV_SETEA              _IOW ('f', 156, OBD_IOC_DATA_TYPE)
 485
 486 #define OBD_IOC_QUOTACHECK             _IOW ('f', 160, int)
 487 #define OBD_IOC_POLL_QUOTACHECK        _IOR ('f', 161, struct if_quotacheck *)
 488 #define OBD_IOC_QUOTACTL               _IOWR('f', 162, struct if_quotactl *)
 489
 490 #define OBD_IOC_MOUNTOPT               _IOWR('f', 170, OBD_IOC_DATA_TYPE)
 491
 492 #define OBD_IOC_RECORD                 _IOWR('f', 180, OBD_IOC_DATA_TYPE)
 493 #define OBD_IOC_ENDRECORD              _IOWR('f', 181, OBD_IOC_DATA_TYPE)
 494 #define OBD_IOC_PARSE                  _IOWR('f', 182, OBD_IOC_DATA_TYPE)
 495 #define OBD_IOC_DORECORD               _IOWR('f', 183, OBD_IOC_DATA_TYPE)
 496 #define OBD_IOC_PROCESS_CFG            _IOWR('f', 184, OBD_IOC_DATA_TYPE)
 497 #define OBD_IOC_DUMP_LOG               _IOWR('f', 185, OBD_IOC_DATA_TYPE)
 498 #define OBD_IOC_CLEAR_LOG              _IOWR('f', 186, OBD_IOC_DATA_TYPE)
 499 #define OBD_IOC_PARAM                  _IOW ('f', 187, OBD_IOC_DATA_TYPE)
 500 #define OBD_IOC_POOL                   _IOWR('f', 188, OBD_IOC_DATA_TYPE)
 501
 502 #define OBD_IOC_CATLOGLIST             _IOWR('f', 190, OBD_IOC_DATA_TYPE)
 503 #define OBD_IOC_LLOG_INFO              _IOWR('f', 191, OBD_IOC_DATA_TYPE)
 504 #define OBD_IOC_LLOG_PRINT             _IOWR('f', 192, OBD_IOC_DATA_TYPE)
 505 #define OBD_IOC_LLOG_CANCEL            _IOWR('f', 193, OBD_IOC_DATA_TYPE)
 506 #define OBD_IOC_LLOG_REMOVE            _IOWR('f', 194, OBD_IOC_DATA_TYPE)
 507 #define OBD_IOC_LLOG_CHECK             _IOWR('f', 195, OBD_IOC_DATA_TYPE)
 508 #define OBD_IOC_LLOG_CATINFO           _IOWR('f', 196, OBD_IOC_DATA_TYPE)
 509
 510 #define ECHO_IOC_GET_STRIPE            _IOWR('f', 200, OBD_IOC_DATA_TYPE)
 511 #define ECHO_IOC_SET_STRIPE            _IOWR('f', 201, OBD_IOC_DATA_TYPE)
 512 #define ECHO_IOC_ENQUEUE               _IOWR('f', 202, OBD_IOC_DATA_TYPE)
 513 #define ECHO_IOC_CANCEL                _IOWR('f', 203, OBD_IOC_DATA_TYPE)
 514
 515 /* XXX _IOWR('f', 250, long) has been defined in
 516  * libcfs/include/libcfs/libcfs_private.h for debug, don't use it
 517  */
 518
 519 /* Until such time as we get_info the per-stripe maximum from the OST,
 520  * we define this to be 2T - 4k, which is the ext3 maxbytes. */
 521 #define LUSTRE_STRIPE_MAXBYTES 0x1fffffff000ULL
 522
 523 /* #define POISON_BULK 0 */
 524
 525 /*
 526  * l_wait_event is a flexible sleeping function, permitting simple caller
 527  * configuration of interrupt and timeout sensitivity along with actions to
 528  * be performed in the event of either exception.
 529  *
 530  * The first form of usage looks like this:
 531  *
 532  * struct l_wait_info lwi = LWI_TIMEOUT_INTR(timeout, timeout_handler,
 533  *                                           intr_handler, callback_data);
 534  * rc = l_wait_event(waitq, condition, &lwi);
 535  *
 536  * l_wait_event() makes the current process wait on 'waitq' until 'condition'
 537  * is TRUE or a "killable" signal (SIGTERM, SIKGILL, SIGINT) is pending.  It
 538  * returns 0 to signify 'condition' is TRUE, but if a signal wakes it before
 539  * 'condition' becomes true, it optionally calls the specified 'intr_handler'
 540  * if not NULL, and returns -EINTR.
 541  *
 542  * If a non-zero timeout is specified, signals are ignored until the timeout
 543  * has expired.  At this time, if 'timeout_handler' is not NULL it is called.
 544  * If it returns FALSE l_wait_event() continues to wait as described above with
 545  * signals enabled.  Otherwise it returns -ETIMEDOUT.
 546  *
 547  * LWI_INTR(intr_handler, callback_data) is shorthand for
 548  * LWI_TIMEOUT_INTR(0, NULL, intr_handler, callback_data)
 549  *
 550  * The second form of usage looks like this:
 551  *
 552  * struct l_wait_info lwi = LWI_TIMEOUT(timeout, timeout_handler);
 553  * rc = l_wait_event(waitq, condition, &lwi);
 554  *
 555  * This form is the same as the first except that it COMPLETELY IGNORES
 556  * SIGNALS.  The caller must therefore beware that if 'timeout' is zero, or if
 557  * 'timeout_handler' is not NULL and returns FALSE, then the ONLY thing that
 558  * can unblock the current process is 'condition' becoming TRUE.
 559  *
 560  * Another form of usage is:
 561  * struct l_wait_info lwi = LWI_TIMEOUT_INTERVAL(timeout, interval,
 562  *                                               timeout_handler);
 563  * rc = l_wait_event(waitq, condition, &lwi);
 564  * This is the same as previous case, but condition is checked once every
 565  * 'interval' jiffies (if non-zero).
 566  *
 567  * Subtle synchronization point: this macro does *not* necessary takes
 568  * wait-queue spin-lock before returning, and, hence, following idiom is safe
 569  * ONLY when caller provides some external locking:
 570  *
 571  *             Thread1                            Thread2
 572  *
 573  *   l_wait_event(&obj->wq, ....);                                       (1)
 574  *
 575  *                                    wake_up(&obj->wq):                 (2)
 576  *                                         spin_lock(&q->lock);          (2.1)
 577  *                                         __wake_up_common(q, ...);     (2.2)
 578  *                                         spin_unlock(&q->lock, flags); (2.3)
 579  *
 580  *   OBD_FREE_PTR(obj);                                                  (3)
 581  *
 582  * As l_wait_event() may "short-cut" execution and return without taking
 583  * wait-queue spin-lock, some additional synchronization is necessary to
 584  * guarantee that step (3) can begin only after (2.3) finishes.
 585  *
 586  * XXX nikita: some ptlrpc daemon threads have races of that sort.
 587  *
 588  */
 589
 590 #define LWI_ON_SIGNAL_NOOP ((void (*)(void *))(-1))
 591
 592 struct l_wait_info {
 593         cfs_duration_t lwi_timeout;
 594         cfs_duration_t lwi_interval;
 595         int  (*lwi_on_timeout)(void *);
 596         void (*lwi_on_signal)(void *);
 597         void  *lwi_cb_data;
 598 };
 599
 600 /* NB: LWI_TIMEOUT ignores signals completely */
 601 #define LWI_TIMEOUT(time, cb, data)             \
 602 ((struct l_wait_info) {                         \
 603         .lwi_timeout    = time,                 \
 604         .lwi_on_timeout = cb,                   \
 605         .lwi_cb_data    = data,                 \
 606         .lwi_interval   = 0                     \
 607 })
 608
 609 #define LWI_TIMEOUT_INTERVAL(time, interval, cb, data)  \
 610 ((struct l_wait_info) {                                 \
 611         .lwi_timeout    = time,                         \
 612         .lwi_on_timeout = cb,                           \
 613         .lwi_cb_data    = data,                         \
 614         .lwi_interval   = interval                      \
 615 })
 616
 617 #define LWI_TIMEOUT_INTR(time, time_cb, sig_cb, data)   \
 618 ((struct l_wait_info) {                                 \
 619         .lwi_timeout    = time,                         \
 620         .lwi_on_timeout = time_cb,                      \
 621         .lwi_on_signal = sig_cb,                        \
 622         .lwi_cb_data    = data,                         \
 623         .lwi_interval    = 0                            \
 624 })
 625
 626 #define LWI_INTR(cb, data)  LWI_TIMEOUT_INTR(0, NULL, cb, data)
 627
 628 #ifdef __KERNEL__
 629
 630 /*
 631  * wait for @condition to become true, but no longer than timeout, specified
 632  * by @info.
 633  */
 634 #define __l_wait_event(wq, condition, info, ret, excl)                         \
 635 do {                                                                           \
 636         cfs_waitlink_t __wait;                                                 \
 637         cfs_duration_t __timeout = info->lwi_timeout;                          \
 638         cfs_sigset_t   __blocked;                                              \
 639                                                                                \
 640         ret = 0;                                                               \
 641         if (condition)                                                         \
 642                 break;                                                         \
 643                                                                                \
 644         cfs_waitlink_init(&__wait);                                            \
 645         if (excl)                                                              \
 646                 cfs_waitq_add_exclusive(&wq, &__wait);                         \
 647         else                                                                   \
 648                 cfs_waitq_add(&wq, &__wait);                                   \
 649                                                                                \
 650         /* Block all signals (just the non-fatal ones if no timeout). */       \
 651         if (info->lwi_on_signal != NULL && __timeout == 0)                     \
 652                 __blocked = l_w_e_set_sigs(LUSTRE_FATAL_SIGS);                 \
 653         else                                                                   \
 654                 __blocked = l_w_e_set_sigs(0);                                 \
 655                                                                                \
 656         for (;;) {                                                             \
 657                 set_current_state(TASK_INTERRUPTIBLE);                         \
 658                                                                                \
 659                 if (condition)                                                 \
 660                         break;                                                 \
 661                                                                                \
 662                 if (__timeout == 0) {                                          \
 663                         cfs_waitq_wait(&__wait, CFS_TASK_INTERRUPTIBLE);       \
 664                 } else {                                                       \
 665                         cfs_duration_t interval = info->lwi_interval?          \
 666                                              min_t(cfs_duration_t,             \
 667                                                  info->lwi_interval,__timeout):\
 668                                              __timeout;                        \
 669                         cfs_duration_t remaining = cfs_waitq_timedwait(&__wait,\
 670                                                    CFS_TASK_INTERRUPTIBLE,     \
 671                                                    interval);                  \
 672                         __timeout = cfs_time_sub(__timeout,                    \
 673                                             cfs_time_sub(interval, remaining));\
 674                         if (__timeout == 0) {                                  \
 675                                 if (info->lwi_on_timeout == NULL ||            \
 676                                     info->lwi_on_timeout(info->lwi_cb_data)) { \
 677                                         ret = -ETIMEDOUT;                      \
 678                                         break;                                 \
 679                                 }                                              \
 680                                 /* Take signals after the timeout expires. */  \
 681                                 if (info->lwi_on_signal != NULL)               \
 682                                     (void)l_w_e_set_sigs(LUSTRE_FATAL_SIGS);   \
 683                         }                                                      \
 684                 }                                                              \
 685                                                                                \
 686                 if (condition)                                                 \
 687                         break;                                                 \
 688                 if (cfs_signal_pending()) {                                    \
 689                         if (info->lwi_on_signal != NULL && __timeout == 0) {   \
 690                                 if (info->lwi_on_signal != LWI_ON_SIGNAL_NOOP) \
 691                                         info->lwi_on_signal(info->lwi_cb_data);\
 692                                 ret = -EINTR;                                  \
 693                                 break;                                         \
 694                         }                                                      \
 695                         /* We have to do this here because some signals */     \
 696                         /* are not blockable - ie from strace(1).       */     \
 697                         /* In these cases we want to schedule_timeout() */     \
 698                         /* again, because we don't want that to return  */     \
 699                         /* -EINTR when the RPC actually succeeded.      */     \
 700                         /* the RECALC_SIGPENDING below will deliver the */     \
 701                         /* signal properly.                             */     \
 702                         cfs_clear_sigpending();                                \
 703                 }                                                              \
 704         }                                                                      \
 705                                                                                \
 706         cfs_block_sigs(__blocked);                                             \
 707                                                                                \
 708         set_current_state(TASK_RUNNING);                                       \
 709         cfs_waitq_del(&wq, &__wait);                                           \
 710 } while (0)
 711
 712 #else /* !__KERNEL__ */
 713 #define __l_wait_event(wq, condition, info, ret, excl)                  \
 714 do {                                                                    \
 715         long __timeout = info->lwi_timeout;                             \
 716         long __now;                                                     \
 717         long __then = 0;                                                \
 718         int  __timed_out = 0;                                           \
 719         int  __interval = obd_timeout;                                  \
 720                                                                         \
 721         ret = 0;                                                        \
 722         if (condition)                                                  \
 723                 break;                                                  \
 724                                                                         \
 725         if (__timeout != 0)                                             \
 726                 __then = time(NULL);                                    \
 727                                                                         \
 728         if (__timeout && __timeout < __interval)                        \
 729                 __interval = __timeout;                                 \
 730         if (info->lwi_interval && info->lwi_interval < __interval)      \
 731                 __interval = info->lwi_interval;                        \
 732                                                                         \
 733         while (!(condition)) {                                          \
 734                 liblustre_wait_event(__interval);                       \
 735                 if (condition)                                          \
 736                         break;                                          \
 737                                                                         \
 738                 if (!__timed_out && info->lwi_timeout != 0) {           \
 739                         __now = time(NULL);                             \
 740                         __timeout -= __now - __then;                    \
 741                         __then = __now;                                 \
 742                                                                         \
 743                         if (__timeout > 0)                              \
 744                                 continue;                               \
 745                                                                         \
 746                         __timeout = 0;                                  \
 747                         __timed_out = 1;                                \
 748                         if (info->lwi_on_timeout == NULL ||             \
 749                             info->lwi_on_timeout(info->lwi_cb_data)) {  \
 750                                 ret = -ETIMEDOUT;                       \
 751                                 break;                                  \
 752                         }                                               \
 753                 }                                                       \
 754         }                                                               \
 755 } while (0)
 756
 757 #endif /* __KERNEL__ */
 758
 759
 760 #define l_wait_event(wq, condition, info)                       \
 761 ({                                                              \
 762         int                 __ret;                              \
 763         struct l_wait_info *__info = (info);                    \
 764                                                                 \
 765         __l_wait_event(wq, condition, __info, __ret, 0);        \
 766         __ret;                                                  \
 767 })
 768
 769 #define l_wait_event_exclusive(wq, condition, info)             \
 770 ({                                                              \
 771         int                 __ret;                              \
 772         struct l_wait_info *__info = (info);                    \
 773                                                                 \
 774         __l_wait_event(wq, condition, __info, __ret, 1);        \
 775         __ret;                                                  \
 776 })
 777
 778 #define cfs_wait_event(wq, condition)                          \
 779 ({                                                              \
 780         struct l_wait_info lwi = { 0 };                         \
 781         l_wait_event(wq, condition, &lwi);                      \
 782 })
 783
 784 #ifdef __KERNEL__
 785 #define LIBLUSTRE_CLIENT (0)
 786 #else
 787 #define LIBLUSTRE_CLIENT (1)
 788 #endif
 789
 790 #endif /* _LUSTRE_LIB_H */