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