lustre/include/lustre_lib.h

   1 /*
   2  * GPL HEADER START
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License version 2 only,
   8  * as published by the Free Software Foundation.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * General Public License version 2 for more details (a copy is included
  14  * in the LICENSE file that accompanied this code).
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * version 2 along with this program; If not, see
  18  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
  19  *
  20  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  21  * CA 95054 USA or visit www.sun.com if you need additional information or
  22  * have any questions.
  23  *
  24  * GPL HEADER END
  25  */
  26 /*
  27  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
  28  * Use is subject to license terms.
  29  *
  30  * Copyright (c) 2011, 2012, Whamcloud, Inc.
  31  */
  32 /*
  33  * This file is part of Lustre, http://www.lustre.org/
  34  * Lustre is a trademark of Sun Microsystems, Inc.
  35  *
  36  * 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 /** \defgroup lib lib
  45  *
  46  * @{
  47  */
  48
  49 #include <libcfs/libcfs.h>
  50 #include <lustre/lustre_idl.h>
  51 #include <lustre_ver.h>
  52 #include <lustre_cfg.h>
  53 #if defined(__linux__)
  54 #include <linux/lustre_lib.h>
  55 #elif defined(__APPLE__)
  56 #include <darwin/lustre_lib.h>
  57 #elif defined(__WINNT__)
  58 #include <winnt/lustre_lib.h>
  59 #else
  60 #error Unsupported operating system.
  61 #endif
  62
  63 /* target.c */
  64 struct ptlrpc_request;
  65 struct obd_export;
  66 struct lu_target;
  67 struct l_wait_info;
  68 #include <lustre_ha.h>
  69 #include <lustre_net.h>
  70 #include <lvfs.h>
  71
  72 #ifdef HAVE_SERVER_SUPPORT
  73 void target_client_add_cb(struct obd_device *obd, __u64 transno, void *cb_data,
  74                           int error);
  75 int target_handle_connect(struct ptlrpc_request *req);
  76 int target_handle_disconnect(struct ptlrpc_request *req);
  77 void target_destroy_export(struct obd_export *exp);
  78 int target_handle_ping(struct ptlrpc_request *req);
  79 void target_committed_to_req(struct ptlrpc_request *req);
  80 void target_cancel_recovery_timer(struct obd_device *obd);
  81 void target_stop_recovery_thread(struct obd_device *obd);
  82 void target_cleanup_recovery(struct obd_device *obd);
  83 int target_queue_recovery_request(struct ptlrpc_request *req,
  84                                   struct obd_device *obd);
  85 int target_bulk_io(struct obd_export *exp, struct ptlrpc_bulk_desc *desc,
  86                    struct l_wait_info *lwi);
  87 #endif
  88
  89 int target_pack_pool_reply(struct ptlrpc_request *req);
  90 int do_set_info_async(struct obd_import *imp,
  91                       int opcode, int version,
  92                       obd_count keylen, void *key,
  93                       obd_count vallen, void *val,
  94                       struct ptlrpc_request_set *set);
  95
  96 #define OBD_RECOVERY_MAX_TIME (obd_timeout * 18) /* b13079 */
  97
  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, cfs_kstatfs_t *sfs);
 117 void statfs_unpack(cfs_kstatfs_t *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  * For md echo client
 134  */
 135 enum md_echo_cmd {
 136         ECHO_MD_CREATE       = 1, /* Open/Create file on MDT */
 137         ECHO_MD_MKDIR        = 2, /* Mkdir on MDT */
 138         ECHO_MD_DESTROY      = 3, /* Unlink file on MDT */
 139         ECHO_MD_RMDIR        = 4, /* Rmdir on MDT */
 140         ECHO_MD_LOOKUP       = 5, /* Lookup on MDT */
 141         ECHO_MD_GETATTR      = 6, /* Getattr on MDT */
 142         ECHO_MD_SETATTR      = 7, /* Setattr on MDT */
 143         ECHO_MD_ALLOC_FID    = 8, /* Get FIDs from MDT */
 144 };
 145
 146 /*
 147  *   OBD IOCTLS
 148  */
 149 #define OBD_IOCTL_VERSION 0x00010004
 150
 151 struct obd_ioctl_data {
 152         __u32 ioc_len;
 153         __u32 ioc_version;
 154
 155         union {
 156                 __u64 ioc_cookie;
 157                 __u64 ioc_u64_1;
 158         };
 159         union {
 160                 __u32 ioc_conn1;
 161                 __u32 ioc_u32_1;
 162         };
 163         union {
 164                 __u32 ioc_conn2;
 165                 __u32 ioc_u32_2;
 166         };
 167
 168         struct obdo ioc_obdo1;
 169         struct obdo ioc_obdo2;
 170
 171         obd_size ioc_count;
 172         obd_off  ioc_offset;
 173         __u32    ioc_dev;
 174         __u32    ioc_command;
 175
 176         __u64 ioc_nid;
 177         __u32 ioc_nal;
 178         __u32 ioc_type;
 179
 180         /* buffers the kernel will treat as user pointers */
 181         __u32  ioc_plen1;
 182         char  *ioc_pbuf1;
 183         __u32  ioc_plen2;
 184         char  *ioc_pbuf2;
 185
 186         /* inline buffers for various arguments */
 187         __u32  ioc_inllen1;
 188         char  *ioc_inlbuf1;
 189         __u32  ioc_inllen2;
 190         char  *ioc_inlbuf2;
 191         __u32  ioc_inllen3;
 192         char  *ioc_inlbuf3;
 193         __u32  ioc_inllen4;
 194         char  *ioc_inlbuf4;
 195
 196         char    ioc_bulk[0];
 197 };
 198
 199 struct obd_ioctl_hdr {
 200         __u32 ioc_len;
 201         __u32 ioc_version;
 202 };
 203
 204 static inline int obd_ioctl_packlen(struct obd_ioctl_data *data)
 205 {
 206         int len = cfs_size_round(sizeof(struct obd_ioctl_data));
 207         len += cfs_size_round(data->ioc_inllen1);
 208         len += cfs_size_round(data->ioc_inllen2);
 209         len += cfs_size_round(data->ioc_inllen3);
 210         len += cfs_size_round(data->ioc_inllen4);
 211         return len;
 212 }
 213
 214
 215 static inline int obd_ioctl_is_invalid(struct obd_ioctl_data *data)
 216 {
 217         if (data->ioc_len > (1<<30)) {
 218                 CERROR("OBD ioctl: ioc_len larger than 1<<30\n");
 219                 return 1;
 220         }
 221         if (data->ioc_inllen1 > (1<<30)) {
 222                 CERROR("OBD ioctl: ioc_inllen1 larger than 1<<30\n");
 223                 return 1;
 224         }
 225         if (data->ioc_inllen2 > (1<<30)) {
 226                 CERROR("OBD ioctl: ioc_inllen2 larger than 1<<30\n");
 227                 return 1;
 228         }
 229         if (data->ioc_inllen3 > (1<<30)) {
 230                 CERROR("OBD ioctl: ioc_inllen3 larger than 1<<30\n");
 231                 return 1;
 232         }
 233         if (data->ioc_inllen4 > (1<<30)) {
 234                 CERROR("OBD ioctl: ioc_inllen4 larger than 1<<30\n");
 235                 return 1;
 236         }
 237         if (data->ioc_inlbuf1 && !data->ioc_inllen1) {
 238                 CERROR("OBD ioctl: inlbuf1 pointer but 0 length\n");
 239                 return 1;
 240         }
 241         if (data->ioc_inlbuf2 && !data->ioc_inllen2) {
 242                 CERROR("OBD ioctl: inlbuf2 pointer but 0 length\n");
 243                 return 1;
 244         }
 245         if (data->ioc_inlbuf3 && !data->ioc_inllen3) {
 246                 CERROR("OBD ioctl: inlbuf3 pointer but 0 length\n");
 247                 return 1;
 248         }
 249         if (data->ioc_inlbuf4 && !data->ioc_inllen4) {
 250                 CERROR("OBD ioctl: inlbuf4 pointer but 0 length\n");
 251                 return 1;
 252         }
 253         if (data->ioc_pbuf1 && !data->ioc_plen1) {
 254                 CERROR("OBD ioctl: pbuf1 pointer but 0 length\n");
 255                 return 1;
 256         }
 257         if (data->ioc_pbuf2 && !data->ioc_plen2) {
 258                 CERROR("OBD ioctl: pbuf2 pointer but 0 length\n");
 259                 return 1;
 260         }
 261         if (data->ioc_plen1 && !data->ioc_pbuf1) {
 262                 CERROR("OBD ioctl: plen1 set but NULL pointer\n");
 263                 return 1;
 264         }
 265         if (data->ioc_plen2 && !data->ioc_pbuf2) {
 266                 CERROR("OBD ioctl: plen2 set but NULL pointer\n");
 267                 return 1;
 268         }
 269         if (obd_ioctl_packlen(data) > data->ioc_len) {
 270                 CERROR("OBD ioctl: packlen exceeds ioc_len (%d > %d)\n",
 271                        obd_ioctl_packlen(data), data->ioc_len);
 272                 return 1;
 273         }
 274         return 0;
 275 }
 276
 277 #ifndef __KERNEL__
 278 static inline int obd_ioctl_pack(struct obd_ioctl_data *data, char **pbuf,
 279                                  int max)
 280 {
 281         char *ptr;
 282         struct obd_ioctl_data *overlay;
 283         data->ioc_len = obd_ioctl_packlen(data);
 284         data->ioc_version = OBD_IOCTL_VERSION;
 285
 286         if (*pbuf && data->ioc_len > max) {
 287                 fprintf(stderr, "pbuf %p ioc_len %u max %d\n", *pbuf,
 288                         data->ioc_len, max);
 289                 return -EINVAL;
 290         }
 291         if (*pbuf == NULL) {
 292                 *pbuf = malloc(data->ioc_len);
 293         }
 294         if (!*pbuf)
 295                 return -ENOMEM;
 296         overlay = (struct obd_ioctl_data *)*pbuf;
 297         memcpy(*pbuf, data, sizeof(*data));
 298
 299         ptr = overlay->ioc_bulk;
 300         if (data->ioc_inlbuf1)
 301                 LOGL(data->ioc_inlbuf1, data->ioc_inllen1, ptr);
 302         if (data->ioc_inlbuf2)
 303                 LOGL(data->ioc_inlbuf2, data->ioc_inllen2, ptr);
 304         if (data->ioc_inlbuf3)
 305                 LOGL(data->ioc_inlbuf3, data->ioc_inllen3, ptr);
 306         if (data->ioc_inlbuf4)
 307                 LOGL(data->ioc_inlbuf4, data->ioc_inllen4, ptr);
 308         if (obd_ioctl_is_invalid(overlay)) {
 309                 fprintf(stderr, "ioc_len %u max %d\n",
 310                         data->ioc_len, max);
 311                 return -EINVAL;
 312         }
 313
 314         return 0;
 315 }
 316
 317 static inline int obd_ioctl_unpack(struct obd_ioctl_data *data, char *pbuf,
 318                                    int max)
 319 {
 320         char *ptr;
 321         struct obd_ioctl_data *overlay;
 322
 323         if (!pbuf)
 324                 return 1;
 325         overlay = (struct obd_ioctl_data *)pbuf;
 326
 327         /* Preserve the caller's buffer pointers */
 328         overlay->ioc_inlbuf1 = data->ioc_inlbuf1;
 329         overlay->ioc_inlbuf2 = data->ioc_inlbuf2;
 330         overlay->ioc_inlbuf3 = data->ioc_inlbuf3;
 331         overlay->ioc_inlbuf4 = data->ioc_inlbuf4;
 332
 333         memcpy(data, pbuf, sizeof(*data));
 334
 335         ptr = overlay->ioc_bulk;
 336         if (data->ioc_inlbuf1)
 337                 LOGU(data->ioc_inlbuf1, data->ioc_inllen1, ptr);
 338         if (data->ioc_inlbuf2)
 339                 LOGU(data->ioc_inlbuf2, data->ioc_inllen2, ptr);
 340         if (data->ioc_inlbuf3)
 341                 LOGU(data->ioc_inlbuf3, data->ioc_inllen3, ptr);
 342         if (data->ioc_inlbuf4)
 343                 LOGU(data->ioc_inlbuf4, data->ioc_inllen4, ptr);
 344
 345         return 0;
 346 }
 347 #endif
 348
 349 #include <obd_support.h>
 350
 351 #ifdef __KERNEL__
 352 /* function defined in lustre/obdclass/<platform>/<platform>-module.c */
 353 int obd_ioctl_getdata(char **buf, int *len, void *arg);
 354 int obd_ioctl_popdata(void *arg, void *data, int len);
 355 #else
 356 /* buffer MUST be at least the size of obd_ioctl_hdr */
 357 static inline int obd_ioctl_getdata(char **buf, int *len, void *arg)
 358 {
 359         struct obd_ioctl_hdr hdr;
 360         struct obd_ioctl_data *data;
 361         int err;
 362         int offset = 0;
 363         ENTRY;
 364
 365         err = cfs_copy_from_user(&hdr, (void *)arg, sizeof(hdr));
 366         if (err)
 367                 RETURN(err);
 368
 369         if (hdr.ioc_version != OBD_IOCTL_VERSION) {
 370                 CERROR("Version mismatch kernel vs application\n");
 371                 RETURN(-EINVAL);
 372         }
 373
 374         if (hdr.ioc_len > OBD_MAX_IOCTL_BUFFER) {
 375                 CERROR("User buffer len %d exceeds %d max buffer\n",
 376                        hdr.ioc_len, OBD_MAX_IOCTL_BUFFER);
 377                 RETURN(-EINVAL);
 378         }
 379
 380         if (hdr.ioc_len < sizeof(struct obd_ioctl_data)) {
 381                 CERROR("User buffer too small for ioctl (%d)\n", hdr.ioc_len);
 382                 RETURN(-EINVAL);
 383         }
 384
 385         OBD_ALLOC_LARGE(*buf, hdr.ioc_len);
 386         if (*buf == NULL) {
 387                 CERROR("Cannot allocate control buffer of len %d\n",
 388                        hdr.ioc_len);
 389                 RETURN(-EINVAL);
 390         }
 391         *len = hdr.ioc_len;
 392         data = (struct obd_ioctl_data *)*buf;
 393
 394         err = cfs_copy_from_user(*buf, (void *)arg, hdr.ioc_len);
 395         if (err) {
 396                 OBD_FREE_LARGE(*buf, hdr.ioc_len);
 397                 RETURN(err);
 398         }
 399
 400         if (obd_ioctl_is_invalid(data)) {
 401                 CERROR("ioctl not correctly formatted\n");
 402                 OBD_FREE_LARGE(*buf, hdr.ioc_len);
 403                 RETURN(-EINVAL);
 404         }
 405
 406         if (data->ioc_inllen1) {
 407                 data->ioc_inlbuf1 = &data->ioc_bulk[0];
 408                 offset += cfs_size_round(data->ioc_inllen1);
 409         }
 410
 411         if (data->ioc_inllen2) {
 412                 data->ioc_inlbuf2 = &data->ioc_bulk[0] + offset;
 413                 offset += cfs_size_round(data->ioc_inllen2);
 414         }
 415
 416         if (data->ioc_inllen3) {
 417                 data->ioc_inlbuf3 = &data->ioc_bulk[0] + offset;
 418                 offset += cfs_size_round(data->ioc_inllen3);
 419         }
 420
 421         if (data->ioc_inllen4) {
 422                 data->ioc_inlbuf4 = &data->ioc_bulk[0] + offset;
 423         }
 424
 425         RETURN(0);
 426 }
 427
 428 static inline int obd_ioctl_popdata(void *arg, void *data, int len)
 429 {
 430         int err = cfs_copy_to_user(arg, data, len);
 431         if (err)
 432                 err = -EFAULT;
 433         return err;
 434 }
 435 #endif
 436
 437 static inline void obd_ioctl_freedata(char *buf, int len)
 438 {
 439         ENTRY;
 440
 441         OBD_FREE_LARGE(buf, len);
 442         EXIT;
 443         return;
 444 }
 445
 446 /*
 447  * BSD ioctl description:
 448  * #define IOC_V1       _IOR(g, n1, long)
 449  * #define IOC_V2       _IOW(g, n2, long)
 450  *
 451  * ioctl(f, IOC_V1, arg);
 452  * arg will be treated as a long value,
 453  *
 454  * ioctl(f, IOC_V2, arg)
 455  * arg will be treated as a pointer, bsd will call
 456  * copyin(buf, arg, sizeof(long))
 457  *
 458  * To make BSD ioctl handles argument correctly and simplely,
 459  * we change _IOR to _IOWR so BSD will copyin obd_ioctl_data
 460  * for us. Does this change affect Linux?  (XXX Liang)
 461  */
 462 #define OBD_IOC_CREATE                 _IOWR('f', 101, OBD_IOC_DATA_TYPE)
 463 #define OBD_IOC_DESTROY                _IOW ('f', 104, OBD_IOC_DATA_TYPE)
 464 #define OBD_IOC_PREALLOCATE            _IOWR('f', 105, OBD_IOC_DATA_TYPE)
 465
 466 #define OBD_IOC_SETATTR                _IOW ('f', 107, OBD_IOC_DATA_TYPE)
 467 #define OBD_IOC_GETATTR                _IOWR ('f', 108, OBD_IOC_DATA_TYPE)
 468 #define OBD_IOC_READ                   _IOWR('f', 109, OBD_IOC_DATA_TYPE)
 469 #define OBD_IOC_WRITE                  _IOWR('f', 110, OBD_IOC_DATA_TYPE)
 470
 471
 472 #define OBD_IOC_STATFS                 _IOWR('f', 113, OBD_IOC_DATA_TYPE)
 473 #define OBD_IOC_SYNC                   _IOW ('f', 114, OBD_IOC_DATA_TYPE)
 474 #define OBD_IOC_READ2                  _IOWR('f', 115, OBD_IOC_DATA_TYPE)
 475 #define OBD_IOC_FORMAT                 _IOWR('f', 116, OBD_IOC_DATA_TYPE)
 476 #define OBD_IOC_PARTITION              _IOWR('f', 117, OBD_IOC_DATA_TYPE)
 477 #define OBD_IOC_COPY                   _IOWR('f', 120, OBD_IOC_DATA_TYPE)
 478 #define OBD_IOC_MIGR                   _IOWR('f', 121, OBD_IOC_DATA_TYPE)
 479 #define OBD_IOC_PUNCH                  _IOWR('f', 122, OBD_IOC_DATA_TYPE)
 480
 481 #define OBD_IOC_MODULE_DEBUG           _IOWR('f', 124, OBD_IOC_DATA_TYPE)
 482 #define OBD_IOC_BRW_READ               _IOWR('f', 125, OBD_IOC_DATA_TYPE)
 483 #define OBD_IOC_BRW_WRITE              _IOWR('f', 126, OBD_IOC_DATA_TYPE)
 484 #define OBD_IOC_NAME2DEV               _IOWR('f', 127, OBD_IOC_DATA_TYPE)
 485 #define OBD_IOC_UUID2DEV               _IOWR('f', 130, OBD_IOC_DATA_TYPE)
 486
 487 #define OBD_IOC_GETNAME                _IOWR('f', 131, OBD_IOC_DATA_TYPE)
 488 #define OBD_IOC_GETMDNAME              _IOR('f', 131, char[MAX_OBD_NAME])
 489 #define OBD_IOC_GETDTNAME               OBD_IOC_GETNAME
 490
 491 #define OBD_IOC_LOV_GET_CONFIG         _IOWR('f', 132, OBD_IOC_DATA_TYPE)
 492 #define OBD_IOC_CLIENT_RECOVER         _IOW ('f', 133, OBD_IOC_DATA_TYPE)
 493 #define OBD_IOC_PING_TARGET            _IOW ('f', 136, OBD_IOC_DATA_TYPE)
 494
 495 #define OBD_IOC_DEC_FS_USE_COUNT       _IO  ('f', 139      )
 496 #define OBD_IOC_NO_TRANSNO             _IOW ('f', 140, OBD_IOC_DATA_TYPE)
 497 #define OBD_IOC_SET_READONLY           _IOW ('f', 141, OBD_IOC_DATA_TYPE)
 498 #define OBD_IOC_ABORT_RECOVERY         _IOR ('f', 142, OBD_IOC_DATA_TYPE)
 499
 500 #define OBD_IOC_ROOT_SQUASH            _IOWR('f', 143, OBD_IOC_DATA_TYPE)
 501
 502 #define OBD_GET_VERSION                _IOWR ('f', 144, OBD_IOC_DATA_TYPE)
 503
 504 #define OBD_IOC_GSS_SUPPORT            _IOWR('f', 145, OBD_IOC_DATA_TYPE)
 505
 506 #define OBD_IOC_CLOSE_UUID             _IOWR ('f', 147, OBD_IOC_DATA_TYPE)
 507
 508 #define OBD_IOC_CHANGELOG_SEND         _IOW ('f', 148, OBD_IOC_DATA_TYPE)
 509 #define OBD_IOC_GETDEVICE              _IOWR ('f', 149, OBD_IOC_DATA_TYPE)
 510 #define OBD_IOC_FID2PATH               _IOWR ('f', 150, OBD_IOC_DATA_TYPE)
 511 /* see also <lustre/lustre_user.h> for ioctls 151-153 */
 512 /* OBD_IOC_LOV_SETSTRIPE: See also LL_IOC_LOV_SETSTRIPE */
 513 #define OBD_IOC_LOV_SETSTRIPE          _IOW ('f', 154, OBD_IOC_DATA_TYPE)
 514 /* OBD_IOC_LOV_GETSTRIPE: See also LL_IOC_LOV_GETSTRIPE */
 515 #define OBD_IOC_LOV_GETSTRIPE          _IOW ('f', 155, OBD_IOC_DATA_TYPE)
 516 /* OBD_IOC_LOV_SETEA: See also LL_IOC_LOV_SETEA */
 517 #define OBD_IOC_LOV_SETEA              _IOW ('f', 156, OBD_IOC_DATA_TYPE)
 518 /* see <lustre/lustre_user.h> for ioctls 157-159 */
 519 /* OBD_IOC_QUOTACHECK: See also LL_IOC_QUOTACHECK */
 520 #define OBD_IOC_QUOTACHECK             _IOW ('f', 160, int)
 521 /* OBD_IOC_POLL_QUOTACHECK: See also LL_IOC_POLL_QUOTACHECK */
 522 #define OBD_IOC_POLL_QUOTACHECK        _IOR ('f', 161, struct if_quotacheck *)
 523 /* OBD_IOC_QUOTACTL: See also LL_IOC_QUOTACTL */
 524 #define OBD_IOC_QUOTACTL               _IOWR('f', 162, struct if_quotactl)
 525 /* see  also <lustre/lustre_user.h> for ioctls 163-176 */
 526 #define OBD_IOC_CHANGELOG_REG          _IOW ('f', 177, struct obd_ioctl_data)
 527 #define OBD_IOC_CHANGELOG_DEREG        _IOW ('f', 178, struct obd_ioctl_data)
 528 #define OBD_IOC_CHANGELOG_CLEAR        _IOW ('f', 179, struct obd_ioctl_data)
 529 #define OBD_IOC_RECORD                 _IOWR('f', 180, OBD_IOC_DATA_TYPE)
 530 #define OBD_IOC_ENDRECORD              _IOWR('f', 181, OBD_IOC_DATA_TYPE)
 531 #define OBD_IOC_PARSE                  _IOWR('f', 182, OBD_IOC_DATA_TYPE)
 532 #define OBD_IOC_DORECORD               _IOWR('f', 183, OBD_IOC_DATA_TYPE)
 533 #define OBD_IOC_PROCESS_CFG            _IOWR('f', 184, OBD_IOC_DATA_TYPE)
 534 #define OBD_IOC_DUMP_LOG               _IOWR('f', 185, OBD_IOC_DATA_TYPE)
 535 #define OBD_IOC_CLEAR_LOG              _IOWR('f', 186, OBD_IOC_DATA_TYPE)
 536 #define OBD_IOC_PARAM                  _IOW ('f', 187, OBD_IOC_DATA_TYPE)
 537 #define OBD_IOC_POOL                   _IOWR('f', 188, OBD_IOC_DATA_TYPE)
 538
 539 #define OBD_IOC_CATLOGLIST             _IOWR('f', 190, OBD_IOC_DATA_TYPE)
 540 #define OBD_IOC_LLOG_INFO              _IOWR('f', 191, OBD_IOC_DATA_TYPE)
 541 #define OBD_IOC_LLOG_PRINT             _IOWR('f', 192, OBD_IOC_DATA_TYPE)
 542 #define OBD_IOC_LLOG_CANCEL            _IOWR('f', 193, OBD_IOC_DATA_TYPE)
 543 #define OBD_IOC_LLOG_REMOVE            _IOWR('f', 194, OBD_IOC_DATA_TYPE)
 544 #define OBD_IOC_LLOG_CHECK             _IOWR('f', 195, OBD_IOC_DATA_TYPE)
 545 /* OBD_IOC_LLOG_CATINFO is deprecated */
 546 #define OBD_IOC_LLOG_CATINFO           _IOWR('f', 196, OBD_IOC_DATA_TYPE)
 547
 548 #define ECHO_IOC_GET_STRIPE            _IOWR('f', 200, OBD_IOC_DATA_TYPE)
 549 #define ECHO_IOC_SET_STRIPE            _IOWR('f', 201, OBD_IOC_DATA_TYPE)
 550 #define ECHO_IOC_ENQUEUE               _IOWR('f', 202, OBD_IOC_DATA_TYPE)
 551 #define ECHO_IOC_CANCEL                _IOWR('f', 203, OBD_IOC_DATA_TYPE)
 552
 553 #define OBD_IOC_GET_OBJ_VERSION        _IOR('f', 210, OBD_IOC_DATA_TYPE)
 554
 555 /* <lustre/lustre_user.h> defines ioctl number 218 */
 556 #define OBD_IOC_GET_MNTOPT             _IOW('f', 220, mntopt_t)
 557
 558 #define OBD_IOC_ECHO_MD                _IOR('f', 221, struct obd_ioctl_data)
 559 #define OBD_IOC_ECHO_ALLOC_SEQ         _IOWR('f', 222, struct obd_ioctl_data)
 560
 561 #define OBD_IOC_START_LFSCK            _IOWR('f', 230, OBD_IOC_DATA_TYPE)
 562 #define OBD_IOC_STOP_LFSCK             _IOW('f', 231, OBD_IOC_DATA_TYPE)
 563
 564 /* XXX _IOWR('f', 250, long) has been defined in
 565  * libcfs/include/libcfs/libcfs_private.h for debug, don't use it
 566  */
 567
 568 /* Until such time as we get_info the per-stripe maximum from the OST,
 569  * we define this to be 2T - 4k, which is the ext3 maxbytes. */
 570 #define LUSTRE_STRIPE_MAXBYTES 0x1fffffff000ULL
 571
 572 /* Special values for remove LOV EA from disk */
 573 #define LOVEA_DELETE_VALUES(size, count, offset) (size == 0 && count == 0 && \
 574                                                  offset == (typeof(offset))(-1))
 575
 576 /* #define POISON_BULK 0 */
 577
 578 /*
 579  * l_wait_event is a flexible sleeping function, permitting simple caller
 580  * configuration of interrupt and timeout sensitivity along with actions to
 581  * be performed in the event of either exception.
 582  *
 583  * The first form of usage looks like this:
 584  *
 585  * struct l_wait_info lwi = LWI_TIMEOUT_INTR(timeout, timeout_handler,
 586  *                                           intr_handler, callback_data);
 587  * rc = l_wait_event(waitq, condition, &lwi);
 588  *
 589  * l_wait_event() makes the current process wait on 'waitq' until 'condition'
 590  * is TRUE or a "killable" signal (SIGTERM, SIKGILL, SIGINT) is pending.  It
 591  * returns 0 to signify 'condition' is TRUE, but if a signal wakes it before
 592  * 'condition' becomes true, it optionally calls the specified 'intr_handler'
 593  * if not NULL, and returns -EINTR.
 594  *
 595  * If a non-zero timeout is specified, signals are ignored until the timeout
 596  * has expired.  At this time, if 'timeout_handler' is not NULL it is called.
 597  * If it returns FALSE l_wait_event() continues to wait as described above with
 598  * signals enabled.  Otherwise it returns -ETIMEDOUT.
 599  *
 600  * LWI_INTR(intr_handler, callback_data) is shorthand for
 601  * LWI_TIMEOUT_INTR(0, NULL, intr_handler, callback_data)
 602  *
 603  * The second form of usage looks like this:
 604  *
 605  * struct l_wait_info lwi = LWI_TIMEOUT(timeout, timeout_handler);
 606  * rc = l_wait_event(waitq, condition, &lwi);
 607  *
 608  * This form is the same as the first except that it COMPLETELY IGNORES
 609  * SIGNALS.  The caller must therefore beware that if 'timeout' is zero, or if
 610  * 'timeout_handler' is not NULL and returns FALSE, then the ONLY thing that
 611  * can unblock the current process is 'condition' becoming TRUE.
 612  *
 613  * Another form of usage is:
 614  * struct l_wait_info lwi = LWI_TIMEOUT_INTERVAL(timeout, interval,
 615  *                                               timeout_handler);
 616  * rc = l_wait_event(waitq, condition, &lwi);
 617  * This is the same as previous case, but condition is checked once every
 618  * 'interval' jiffies (if non-zero).
 619  *
 620  * Subtle synchronization point: this macro does *not* necessary takes
 621  * wait-queue spin-lock before returning, and, hence, following idiom is safe
 622  * ONLY when caller provides some external locking:
 623  *
 624  *             Thread1                            Thread2
 625  *
 626  *   l_wait_event(&obj->wq, ....);                                       (1)
 627  *
 628  *                                    wake_up(&obj->wq):                 (2)
 629  *                                         spin_lock(&q->lock);          (2.1)
 630  *                                         __wake_up_common(q, ...);     (2.2)
 631  *                                         spin_unlock(&q->lock, flags); (2.3)
 632  *
 633  *   OBD_FREE_PTR(obj);                                                  (3)
 634  *
 635  * As l_wait_event() may "short-cut" execution and return without taking
 636  * wait-queue spin-lock, some additional synchronization is necessary to
 637  * guarantee that step (3) can begin only after (2.3) finishes.
 638  *
 639  * XXX nikita: some ptlrpc daemon threads have races of that sort.
 640  *
 641  */
 642 static inline int back_to_sleep(void *arg)
 643 {
 644         return 0;
 645 }
 646
 647 #define LWI_ON_SIGNAL_NOOP ((void (*)(void *))(-1))
 648
 649 struct l_wait_info {
 650         cfs_duration_t lwi_timeout;
 651         cfs_duration_t lwi_interval;
 652         int            lwi_allow_intr;
 653         int  (*lwi_on_timeout)(void *);
 654         void (*lwi_on_signal)(void *);
 655         void  *lwi_cb_data;
 656 };
 657
 658 /* NB: LWI_TIMEOUT ignores signals completely */
 659 #define LWI_TIMEOUT(time, cb, data)             \
 660 ((struct l_wait_info) {                         \
 661         .lwi_timeout    = time,                 \
 662         .lwi_on_timeout = cb,                   \
 663         .lwi_cb_data    = data,                 \
 664         .lwi_interval   = 0,                    \
 665         .lwi_allow_intr = 0                     \
 666 })
 667
 668 #define LWI_TIMEOUT_INTERVAL(time, interval, cb, data)  \
 669 ((struct l_wait_info) {                                 \
 670         .lwi_timeout    = time,                         \
 671         .lwi_on_timeout = cb,                           \
 672         .lwi_cb_data    = data,                         \
 673         .lwi_interval   = interval,                     \
 674         .lwi_allow_intr = 0                             \
 675 })
 676
 677 #define LWI_TIMEOUT_INTR(time, time_cb, sig_cb, data)   \
 678 ((struct l_wait_info) {                                 \
 679         .lwi_timeout    = time,                         \
 680         .lwi_on_timeout = time_cb,                      \
 681         .lwi_on_signal  = sig_cb,                       \
 682         .lwi_cb_data    = data,                         \
 683         .lwi_interval   = 0,                            \
 684         .lwi_allow_intr = 0                             \
 685 })
 686
 687 #define LWI_TIMEOUT_INTR_ALL(time, time_cb, sig_cb, data)       \
 688 ((struct l_wait_info) {                                         \
 689         .lwi_timeout    = time,                                 \
 690         .lwi_on_timeout = time_cb,                              \
 691         .lwi_on_signal  = sig_cb,                               \
 692         .lwi_cb_data    = data,                                 \
 693         .lwi_interval   = 0,                                    \
 694         .lwi_allow_intr = 1                                     \
 695 })
 696
 697 #define LWI_INTR(cb, data)  LWI_TIMEOUT_INTR(0, NULL, cb, data)
 698
 699 #ifdef __KERNEL__
 700
 701 /*
 702  * wait for @condition to become true, but no longer than timeout, specified
 703  * by @info.
 704  */
 705 #define __l_wait_event(wq, condition, info, ret, l_add_wait)                   \
 706 do {                                                                           \
 707         cfs_waitlink_t __wait;                                                 \
 708         cfs_duration_t __timeout = info->lwi_timeout;                          \
 709         cfs_sigset_t   __blocked;                                              \
 710         int   __allow_intr = info->lwi_allow_intr;                             \
 711                                                                                \
 712         ret = 0;                                                               \
 713         if (condition)                                                         \
 714                 break;                                                         \
 715                                                                                \
 716         cfs_waitlink_init(&__wait);                                            \
 717         l_add_wait(&wq, &__wait);                                              \
 718                                                                                \
 719         /* Block all signals (just the non-fatal ones if no timeout). */       \
 720         if (info->lwi_on_signal != NULL && (__timeout == 0 || __allow_intr))   \
 721                 __blocked = cfs_block_sigsinv(LUSTRE_FATAL_SIGS);              \
 722         else                                                                   \
 723                 __blocked = cfs_block_sigsinv(0);                              \
 724                                                                                \
 725         for (;;) {                                                             \
 726                 unsigned       __wstate;                                       \
 727                                                                                \
 728                 __wstate = info->lwi_on_signal != NULL &&                      \
 729                            (__timeout == 0 || __allow_intr) ?                  \
 730                         CFS_TASK_INTERRUPTIBLE : CFS_TASK_UNINT;               \
 731                                                                                \
 732                 cfs_set_current_state(CFS_TASK_INTERRUPTIBLE);                 \
 733                                                                                \
 734                 if (condition)                                                 \
 735                         break;                                                 \
 736                                                                                \
 737                 if (__timeout == 0) {                                          \
 738                         cfs_waitq_wait(&__wait, __wstate);                     \
 739                 } else {                                                       \
 740                         cfs_duration_t interval = info->lwi_interval?          \
 741                                              min_t(cfs_duration_t,             \
 742                                                  info->lwi_interval,__timeout):\
 743                                              __timeout;                        \
 744                         cfs_duration_t remaining = cfs_waitq_timedwait(&__wait,\
 745                                                    __wstate,                   \
 746                                                    interval);                  \
 747                         __timeout = cfs_time_sub(__timeout,                    \
 748                                             cfs_time_sub(interval, remaining));\
 749                         if (__timeout == 0) {                                  \
 750                                 if (info->lwi_on_timeout == NULL ||            \
 751                                     info->lwi_on_timeout(info->lwi_cb_data)) { \
 752                                         ret = -ETIMEDOUT;                      \
 753                                         break;                                 \
 754                                 }                                              \
 755                                 /* Take signals after the timeout expires. */  \
 756                                 if (info->lwi_on_signal != NULL)               \
 757                                     (void)cfs_block_sigsinv(LUSTRE_FATAL_SIGS);\
 758                         }                                                      \
 759                 }                                                              \
 760                                                                                \
 761                 if (condition)                                                 \
 762                         break;                                                 \
 763                 if (cfs_signal_pending()) {                                    \
 764                         if (info->lwi_on_signal != NULL &&                     \
 765                             (__timeout == 0 || __allow_intr)) {                \
 766                                 if (info->lwi_on_signal != LWI_ON_SIGNAL_NOOP) \
 767                                         info->lwi_on_signal(info->lwi_cb_data);\
 768                                 ret = -EINTR;                                  \
 769                                 break;                                         \
 770                         }                                                      \
 771                         /* We have to do this here because some signals */     \
 772                         /* are not blockable - ie from strace(1).       */     \
 773                         /* In these cases we want to schedule_timeout() */     \
 774                         /* again, because we don't want that to return  */     \
 775                         /* -EINTR when the RPC actually succeeded.      */     \
 776                         /* the RECALC_SIGPENDING below will deliver the */     \
 777                         /* signal properly.                             */     \
 778                         cfs_clear_sigpending();                                \
 779                 }                                                              \
 780         }                                                                      \
 781                                                                                \
 782         cfs_restore_sigs(__blocked);                                           \
 783                                                                                \
 784         cfs_set_current_state(CFS_TASK_RUNNING);                               \
 785         cfs_waitq_del(&wq, &__wait);                                           \
 786 } while (0)
 787
 788 #else /* !__KERNEL__ */
 789 #define __l_wait_event(wq, condition, info, ret, l_add_wait)            \
 790 do {                                                                    \
 791         long __timeout = info->lwi_timeout;                             \
 792         long __now;                                                     \
 793         long __then = 0;                                                \
 794         int  __timed_out = 0;                                           \
 795         int  __interval = obd_timeout;                                  \
 796                                                                         \
 797         ret = 0;                                                        \
 798         if (condition)                                                  \
 799                 break;                                                  \
 800                                                                         \
 801         if (__timeout != 0)                                             \
 802                 __then = time(NULL);                                    \
 803                                                                         \
 804         if (__timeout && __timeout < __interval)                        \
 805                 __interval = __timeout;                                 \
 806         if (info->lwi_interval && info->lwi_interval < __interval)      \
 807                 __interval = info->lwi_interval;                        \
 808                                                                         \
 809         while (!(condition)) {                                          \
 810                 liblustre_wait_event(__interval);                       \
 811                 if (condition)                                          \
 812                         break;                                          \
 813                                                                         \
 814                 if (!__timed_out && info->lwi_timeout != 0) {           \
 815                         __now = time(NULL);                             \
 816                         __timeout -= __now - __then;                    \
 817                         __then = __now;                                 \
 818                                                                         \
 819                         if (__timeout > 0)                              \
 820                                 continue;                               \
 821                                                                         \
 822                         __timeout = 0;                                  \
 823                         __timed_out = 1;                                \
 824                         if (info->lwi_on_timeout == NULL ||             \
 825                             info->lwi_on_timeout(info->lwi_cb_data)) {  \
 826                                 ret = -ETIMEDOUT;                       \
 827                                 break;                                  \
 828                         }                                               \
 829                 }                                                       \
 830         }                                                               \
 831         SET_BUT_UNUSED(wq);                                             \
 832 } while (0)
 833
 834 #endif /* __KERNEL__ */
 835
 836
 837 #define l_wait_event(wq, condition, info)                       \
 838 ({                                                              \
 839         int                 __ret;                              \
 840         struct l_wait_info *__info = (info);                    \
 841                                                                 \
 842         __l_wait_event(wq, condition, __info,                   \
 843                        __ret, cfs_waitq_add);                   \
 844         __ret;                                                  \
 845 })
 846
 847 #define l_wait_event_exclusive(wq, condition, info)             \
 848 ({                                                              \
 849         int                 __ret;                              \
 850         struct l_wait_info *__info = (info);                    \
 851                                                                 \
 852         __l_wait_event(wq, condition, __info,                   \
 853                        __ret, cfs_waitq_add_exclusive);         \
 854         __ret;                                                  \
 855 })
 856
 857 #define l_wait_event_exclusive_head(wq, condition, info)        \
 858 ({                                                              \
 859         int                 __ret;                              \
 860         struct l_wait_info *__info = (info);                    \
 861                                                                 \
 862         __l_wait_event(wq, condition, __info,                   \
 863                        __ret, cfs_waitq_add_exclusive_head);    \
 864         __ret;                                                  \
 865 })
 866
 867 #define l_wait_condition(wq, condition)                         \
 868 ({                                                              \
 869         struct l_wait_info lwi = { 0 };                         \
 870         l_wait_event(wq, condition, &lwi);                      \
 871 })
 872
 873 #define l_wait_condition_exclusive(wq, condition)               \
 874 ({                                                              \
 875         struct l_wait_info lwi = { 0 };                         \
 876         l_wait_event_exclusive(wq, condition, &lwi);            \
 877 })
 878
 879 #define l_wait_condition_exclusive_head(wq, condition)          \
 880 ({                                                              \
 881         struct l_wait_info lwi = { 0 };                         \
 882         l_wait_event_exclusive_head(wq, condition, &lwi);       \
 883 })
 884
 885 #ifdef __KERNEL__
 886 #define LIBLUSTRE_CLIENT (0)
 887 #else
 888 #define LIBLUSTRE_CLIENT (1)
 889 #endif
 890
 891 /** @} lib */
 892
 893 #endif /* _LUSTRE_LIB_H */