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