lustre/include/lustre_ioctl.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.gnu.org/licenses/gpl-2.0.html
  19  *
  20  * GPL HEADER END
  21  */
  22 /*
  23  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
  24  * Use is subject to license terms.
  25  *
  26  * Copyright (c) 2011, 2015, Intel Corporation.
  27  */
  28 #ifndef LUSTRE_IOCTL_H_
  29 #define LUSTRE_IOCTL_H_
  30
  31 #include <libcfs/libcfs.h>
  32 #include <lustre/lustre_idl.h>
  33
  34 #ifdef __KERNEL__
  35 # include <linux/ioctl.h>
  36 # include <linux/string.h>
  37 # include <obd_support.h>
  38 #else /* __KERNEL__ */
  39 # include <malloc.h>
  40 # include <string.h>
  41 #endif /* !__KERNEL__ */
  42
  43 #if !defined(__KERNEL__) && !defined(LUSTRE_UTILS)
  44 # error This file is for Lustre internal use only.
  45 #endif
  46
  47 enum md_echo_cmd {
  48         ECHO_MD_CREATE          = 1, /* Open/Create file on MDT */
  49         ECHO_MD_MKDIR           = 2, /* Mkdir on MDT */
  50         ECHO_MD_DESTROY         = 3, /* Unlink file on MDT */
  51         ECHO_MD_RMDIR           = 4, /* Rmdir on MDT */
  52         ECHO_MD_LOOKUP          = 5, /* Lookup on MDT */
  53         ECHO_MD_GETATTR         = 6, /* Getattr on MDT */
  54         ECHO_MD_SETATTR         = 7, /* Setattr on MDT */
  55         ECHO_MD_ALLOC_FID       = 8, /* Get FIDs from MDT */
  56 };
  57
  58 #define OBD_DEV_ID 1
  59 #define OBD_DEV_NAME "obd"
  60 #define OBD_DEV_PATH "/dev/" OBD_DEV_NAME
  61 #define OBD_DEV_MAJOR 10
  62 #define OBD_DEV_MINOR 241
  63
  64 #define OBD_IOCTL_VERSION       0x00010004
  65 #define OBD_DEV_BY_DEVNAME      0xffffd0de
  66 #define OBD_MAX_IOCTL_BUFFER    CONFIG_LUSTRE_OBD_MAX_IOCTL_BUFFER
  67
  68 struct obd_ioctl_data {
  69         __u32           ioc_len;
  70         __u32           ioc_version;
  71
  72         union {
  73                 __u64   ioc_cookie;
  74                 __u64   ioc_u64_1;
  75         };
  76         union {
  77                 __u32   ioc_conn1;
  78                 __u32   ioc_u32_1;
  79         };
  80         union {
  81                 __u32   ioc_conn2;
  82                 __u32   ioc_u32_2;
  83         };
  84
  85         struct obdo     ioc_obdo1;
  86         struct obdo     ioc_obdo2;
  87
  88         __u64           ioc_count;
  89         __u64           ioc_offset;
  90         __u32           ioc_dev;
  91         __u32           ioc_command;
  92
  93         __u64           ioc_nid;
  94         __u32           ioc_nal;
  95         __u32           ioc_type;
  96
  97         /* buffers the kernel will treat as user pointers */
  98         __u32           ioc_plen1;
  99         char __user    *ioc_pbuf1;
 100         __u32           ioc_plen2;
 101         char __user    *ioc_pbuf2;
 102
 103         /* inline buffers for various arguments */
 104         __u32           ioc_inllen1;
 105         char           *ioc_inlbuf1;
 106         __u32           ioc_inllen2;
 107         char           *ioc_inlbuf2;
 108         __u32           ioc_inllen3;
 109         char           *ioc_inlbuf3;
 110         __u32           ioc_inllen4;
 111         char           *ioc_inlbuf4;
 112
 113         char            ioc_bulk[0];
 114 };
 115
 116 struct obd_ioctl_hdr {
 117         __u32           ioc_len;
 118         __u32           ioc_version;
 119 };
 120
 121 static inline __u32 obd_ioctl_packlen(struct obd_ioctl_data *data)
 122 {
 123         __u32 len = cfs_size_round(sizeof(*data));
 124
 125         len += cfs_size_round(data->ioc_inllen1);
 126         len += cfs_size_round(data->ioc_inllen2);
 127         len += cfs_size_round(data->ioc_inllen3);
 128         len += cfs_size_round(data->ioc_inllen4);
 129
 130         return len;
 131 }
 132
 133 static inline int obd_ioctl_is_invalid(struct obd_ioctl_data *data)
 134 {
 135         if (data->ioc_len > (1 << 30)) {
 136                 CERROR("OBD ioctl: ioc_len larger than 1<<30\n");
 137                 return 1;
 138         }
 139
 140         if (data->ioc_inllen1 > (1 << 30)) {
 141                 CERROR("OBD ioctl: ioc_inllen1 larger than 1<<30\n");
 142                 return 1;
 143         }
 144
 145         if (data->ioc_inllen2 > (1 << 30)) {
 146                 CERROR("OBD ioctl: ioc_inllen2 larger than 1<<30\n");
 147                 return 1;
 148         }
 149
 150         if (data->ioc_inllen3 > (1 << 30)) {
 151                 CERROR("OBD ioctl: ioc_inllen3 larger than 1<<30\n");
 152                 return 1;
 153         }
 154
 155         if (data->ioc_inllen4 > (1 << 30)) {
 156                 CERROR("OBD ioctl: ioc_inllen4 larger than 1<<30\n");
 157                 return 1;
 158         }
 159
 160         if (data->ioc_inlbuf1 != NULL && data->ioc_inllen1 == 0) {
 161                 CERROR("OBD ioctl: inlbuf1 pointer but 0 length\n");
 162                 return 1;
 163         }
 164
 165         if (data->ioc_inlbuf2 != NULL && data->ioc_inllen2 == 0) {
 166                 CERROR("OBD ioctl: inlbuf2 pointer but 0 length\n");
 167                 return 1;
 168         }
 169
 170         if (data->ioc_inlbuf3 != NULL && data->ioc_inllen3 == 0) {
 171                 CERROR("OBD ioctl: inlbuf3 pointer but 0 length\n");
 172                 return 1;
 173         }
 174
 175         if (data->ioc_inlbuf4 != NULL && data->ioc_inllen4 == 0) {
 176                 CERROR("OBD ioctl: inlbuf4 pointer but 0 length\n");
 177                 return 1;
 178         }
 179
 180         if (data->ioc_pbuf1 != NULL && data->ioc_plen1 == 0) {
 181                 CERROR("OBD ioctl: pbuf1 pointer but 0 length\n");
 182                 return 1;
 183         }
 184
 185         if (data->ioc_pbuf2 != NULL && data->ioc_plen2 == 0) {
 186                 CERROR("OBD ioctl: pbuf2 pointer but 0 length\n");
 187                 return 1;
 188         }
 189
 190         if (data->ioc_pbuf1 == NULL && data->ioc_plen1 != 0) {
 191                 CERROR("OBD ioctl: plen1 set but NULL pointer\n");
 192                 return 1;
 193         }
 194
 195         if (data->ioc_pbuf2 == NULL && data->ioc_plen2 != 0) {
 196                 CERROR("OBD ioctl: plen2 set but NULL pointer\n");
 197                 return 1;
 198         }
 199
 200         if (obd_ioctl_packlen(data) > data->ioc_len) {
 201                 CERROR("OBD ioctl: packlen exceeds ioc_len (%d > %d)\n",
 202                        obd_ioctl_packlen(data), data->ioc_len);
 203                 return 1;
 204         }
 205
 206         return 0;
 207 }
 208
 209 #ifdef __KERNEL__
 210
 211 int obd_ioctl_getdata(char **buf, int *len, void __user *arg);
 212 int obd_ioctl_popdata(void __user *arg, void *data, int len);
 213
 214 static inline void obd_ioctl_freedata(char *buf, size_t len)
 215 {
 216         ENTRY;
 217
 218         OBD_FREE_LARGE(buf, len);
 219         EXIT;
 220 }
 221
 222 #else /* __KERNEL__ */
 223
 224 static inline int obd_ioctl_pack(struct obd_ioctl_data *data, char **pbuf,
 225                                  int max_len)
 226 {
 227         char *ptr;
 228         struct obd_ioctl_data *overlay;
 229
 230         data->ioc_len = obd_ioctl_packlen(data);
 231         data->ioc_version = OBD_IOCTL_VERSION;
 232
 233         if (*pbuf != NULL && data->ioc_len > max_len) {
 234                 fprintf(stderr, "pbuf = %p, ioc_len = %u, max_len = %d\n",
 235                         *pbuf, data->ioc_len, max_len);
 236                 return -EINVAL;
 237         }
 238
 239         if (*pbuf == NULL)
 240                 *pbuf = malloc(data->ioc_len);
 241
 242         if (*pbuf == NULL)
 243                 return -ENOMEM;
 244
 245         overlay = (struct obd_ioctl_data *)*pbuf;
 246         memcpy(*pbuf, data, sizeof(*data));
 247
 248         ptr = overlay->ioc_bulk;
 249         if (data->ioc_inlbuf1 != NULL)
 250                 LOGL(data->ioc_inlbuf1, data->ioc_inllen1, ptr);
 251
 252         if (data->ioc_inlbuf2 != NULL)
 253                 LOGL(data->ioc_inlbuf2, data->ioc_inllen2, ptr);
 254
 255         if (data->ioc_inlbuf3 != NULL)
 256                 LOGL(data->ioc_inlbuf3, data->ioc_inllen3, ptr);
 257
 258         if (data->ioc_inlbuf4 != NULL)
 259                 LOGL(data->ioc_inlbuf4, data->ioc_inllen4, ptr);
 260
 261         if (obd_ioctl_is_invalid(overlay)) {
 262                 fprintf(stderr, "invalid ioctl data: ioc_len = %u, "
 263                         "max_len = %d\n",
 264                         data->ioc_len, max_len);
 265                 return -EINVAL;
 266         }
 267
 268         return 0;
 269 }
 270
 271 static inline int
 272 obd_ioctl_unpack(struct obd_ioctl_data *data, char *pbuf, int max_len)
 273 {
 274         char *ptr;
 275         struct obd_ioctl_data *overlay;
 276
 277         if (pbuf == NULL)
 278                 return 1;
 279
 280         overlay = (struct obd_ioctl_data *)pbuf;
 281
 282         /* Preserve the caller's buffer pointers */
 283         overlay->ioc_inlbuf1 = data->ioc_inlbuf1;
 284         overlay->ioc_inlbuf2 = data->ioc_inlbuf2;
 285         overlay->ioc_inlbuf3 = data->ioc_inlbuf3;
 286         overlay->ioc_inlbuf4 = data->ioc_inlbuf4;
 287
 288         memcpy(data, pbuf, sizeof(*data));
 289
 290         ptr = overlay->ioc_bulk;
 291         if (data->ioc_inlbuf1 != NULL)
 292                 LOGU(data->ioc_inlbuf1, data->ioc_inllen1, ptr);
 293
 294         if (data->ioc_inlbuf2 != NULL)
 295                 LOGU(data->ioc_inlbuf2, data->ioc_inllen2, ptr);
 296
 297         if (data->ioc_inlbuf3 != NULL)
 298                 LOGU(data->ioc_inlbuf3, data->ioc_inllen3, ptr);
 299
 300         if (data->ioc_inlbuf4 != NULL)
 301                 LOGU(data->ioc_inlbuf4, data->ioc_inllen4, ptr);
 302
 303         return 0;
 304 }
 305
 306 #endif /* !__KERNEL__ */
 307
 308 /* OBD_IOC_DATA_TYPE is only for compatibility reasons with older
 309  * Linux Lustre user tools. New ioctls should NOT use this macro as
 310  * the ioctl "size". Instead the ioctl should get a "size" argument
 311  * which is the actual data type used by the ioctl, to ensure the
 312  * ioctl interface is versioned correctly. */
 313 #define OBD_IOC_DATA_TYPE       long
 314
 315 /*      IOC_LDLM_TEST           _IOWR('f', 40, long) */
 316 /*      IOC_LDLM_DUMP           _IOWR('f', 41, long) */
 317 /*      IOC_LDLM_REGRESS_START  _IOWR('f', 42, long) */
 318 /*      IOC_LDLM_REGRESS_STOP   _IOWR('f', 43, long) */
 319
 320 #define OBD_IOC_CREATE          _IOWR('f', 101, OBD_IOC_DATA_TYPE)
 321 #define OBD_IOC_DESTROY         _IOW ('f', 104, OBD_IOC_DATA_TYPE)
 322 /*      OBD_IOC_PREALLOCATE     _IOWR('f', 105, OBD_IOC_DATA_TYPE) */
 323
 324 #define OBD_IOC_SETATTR         _IOW ('f', 107, OBD_IOC_DATA_TYPE)
 325 #define OBD_IOC_GETATTR         _IOWR('f', 108, OBD_IOC_DATA_TYPE)
 326 #define OBD_IOC_READ            _IOWR('f', 109, OBD_IOC_DATA_TYPE)
 327 #define OBD_IOC_WRITE           _IOWR('f', 110, OBD_IOC_DATA_TYPE)
 328
 329 #define OBD_IOC_STATFS          _IOWR('f', 113, OBD_IOC_DATA_TYPE)
 330 #define OBD_IOC_SYNC            _IOW ('f', 114, OBD_IOC_DATA_TYPE)
 331 /*      OBD_IOC_READ2           _IOWR('f', 115, OBD_IOC_DATA_TYPE) */
 332 /*      OBD_IOC_FORMAT          _IOWR('f', 116, OBD_IOC_DATA_TYPE) */
 333 /*      OBD_IOC_PARTITION       _IOWR('f', 117, OBD_IOC_DATA_TYPE) */
 334 /*      OBD_IOC_COPY            _IOWR('f', 120, OBD_IOC_DATA_TYPE) */
 335 /*      OBD_IOC_MIGR            _IOWR('f', 121, OBD_IOC_DATA_TYPE) */
 336 /*      OBD_IOC_PUNCH           _IOWR('f', 122, OBD_IOC_DATA_TYPE) */
 337
 338 /*      OBD_IOC_MODULE_DEBUG    _IOWR('f', 124, OBD_IOC_DATA_TYPE) */
 339 #define OBD_IOC_BRW_READ        _IOWR('f', 125, OBD_IOC_DATA_TYPE)
 340 #define OBD_IOC_BRW_WRITE       _IOWR('f', 126, OBD_IOC_DATA_TYPE)
 341 #define OBD_IOC_NAME2DEV        _IOWR('f', 127, OBD_IOC_DATA_TYPE)
 342 #define OBD_IOC_UUID2DEV        _IOWR('f', 130, OBD_IOC_DATA_TYPE)
 343 #define OBD_IOC_GETNAME         _IOWR('f', 131, OBD_IOC_DATA_TYPE)
 344 #define OBD_IOC_GETMDNAME       _IOR ('f', 131, char[MAX_OBD_NAME])
 345 #define OBD_IOC_GETDTNAME       OBD_IOC_GETNAME
 346 #define OBD_IOC_LOV_GET_CONFIG  _IOWR('f', 132, OBD_IOC_DATA_TYPE)
 347 #define OBD_IOC_CLIENT_RECOVER  _IOW ('f', 133, OBD_IOC_DATA_TYPE)
 348 #define OBD_IOC_PING_TARGET     _IOW ('f', 136, OBD_IOC_DATA_TYPE)
 349
 350 /*      OBD_IOC_DEC_FS_USE_COUNT _IO('f', 139) */
 351 #define OBD_IOC_NO_TRANSNO      _IOW ('f', 140, OBD_IOC_DATA_TYPE)
 352 #define OBD_IOC_SET_READONLY    _IOW ('f', 141, OBD_IOC_DATA_TYPE)
 353 #define OBD_IOC_ABORT_RECOVERY  _IOR ('f', 142, OBD_IOC_DATA_TYPE)
 354 /*      OBD_IOC_ROOT_SQUASH     _IOWR('f', 143, OBD_IOC_DATA_TYPE) */
 355 #define OBD_GET_VERSION         _IOWR('f', 144, OBD_IOC_DATA_TYPE)
 356 /*      OBD_IOC_GSS_SUPPORT     _IOWR('f', 145, OBD_IOC_DATA_TYPE) */
 357 /*      OBD_IOC_CLOSE_UUID      _IOWR('f', 147, OBD_IOC_DATA_TYPE) */
 358 #define OBD_IOC_CHANGELOG_SEND  _IOW ('f', 148, OBD_IOC_DATA_TYPE)
 359 #define OBD_IOC_GETDEVICE       _IOWR('f', 149, OBD_IOC_DATA_TYPE)
 360 #define OBD_IOC_FID2PATH        _IOWR('f', 150, OBD_IOC_DATA_TYPE)
 361 /*      lustre/lustre_user.h    151-153 */
 362 /*      OBD_IOC_LOV_SETSTRIPE   154 LL_IOC_LOV_SETSTRIPE */
 363 /*      OBD_IOC_LOV_GETSTRIPE   155 LL_IOC_LOV_GETSTRIPE */
 364 /*      OBD_IOC_LOV_SETEA       156 LL_IOC_LOV_SETEA */
 365 /*      lustre/lustre_user.h    157-159 */
 366 /*      OBD_IOC_QUOTACHECK      _IOW ('f', 160, int) */
 367 /*      OBD_IOC_POLL_QUOTACHECK _IOR ('f', 161, struct if_quotacheck *) */
 368 #define OBD_IOC_QUOTACTL        _IOWR('f', 162, struct if_quotactl)
 369 /*      lustre/lustre_user.h    163-176 */
 370 #define OBD_IOC_CHANGELOG_REG   _IOW ('f', 177, struct obd_ioctl_data)
 371 #define OBD_IOC_CHANGELOG_DEREG _IOW ('f', 178, struct obd_ioctl_data)
 372 #define OBD_IOC_CHANGELOG_CLEAR _IOW ('f', 179, struct obd_ioctl_data)
 373 /*      OBD_IOC_RECORD          _IOWR('f', 180, OBD_IOC_DATA_TYPE) */
 374 /*      OBD_IOC_ENDRECORD       _IOWR('f', 181, OBD_IOC_DATA_TYPE) */
 375 /*      OBD_IOC_PARSE           _IOWR('f', 182, OBD_IOC_DATA_TYPE) */
 376 /*      OBD_IOC_DORECORD        _IOWR('f', 183, OBD_IOC_DATA_TYPE) */
 377 #define OBD_IOC_PROCESS_CFG     _IOWR('f', 184, OBD_IOC_DATA_TYPE)
 378 /*      OBD_IOC_DUMP_LOG        _IOWR('f', 185, OBD_IOC_DATA_TYPE) */
 379 /*      OBD_IOC_CLEAR_LOG       _IOWR('f', 186, OBD_IOC_DATA_TYPE) */
 380 #define OBD_IOC_PARAM           _IOW ('f', 187, OBD_IOC_DATA_TYPE)
 381 #define OBD_IOC_POOL            _IOWR('f', 188, OBD_IOC_DATA_TYPE)
 382 #define OBD_IOC_REPLACE_NIDS    _IOWR('f', 189, OBD_IOC_DATA_TYPE)
 383
 384 #define OBD_IOC_CATLOGLIST      _IOWR('f', 190, OBD_IOC_DATA_TYPE)
 385 #define OBD_IOC_LLOG_INFO       _IOWR('f', 191, OBD_IOC_DATA_TYPE)
 386 #define OBD_IOC_LLOG_PRINT      _IOWR('f', 192, OBD_IOC_DATA_TYPE)
 387 #define OBD_IOC_LLOG_CANCEL     _IOWR('f', 193, OBD_IOC_DATA_TYPE)
 388 #define OBD_IOC_LLOG_REMOVE     _IOWR('f', 194, OBD_IOC_DATA_TYPE)
 389 #define OBD_IOC_LLOG_CHECK      _IOWR('f', 195, OBD_IOC_DATA_TYPE)
 390 /*      OBD_IOC_LLOG_CATINFO    _IOWR('f', 196, OBD_IOC_DATA_TYPE) */
 391 #define OBD_IOC_NODEMAP         _IOWR('f', 197, OBD_IOC_DATA_TYPE)
 392
 393 /*      ECHO_IOC_GET_STRIPE     _IOWR('f', 200, OBD_IOC_DATA_TYPE) */
 394 /*      ECHO_IOC_SET_STRIPE     _IOWR('f', 201, OBD_IOC_DATA_TYPE) */
 395 /*      ECHO_IOC_ENQUEUE        _IOWR('f', 202, OBD_IOC_DATA_TYPE) */
 396 /*      ECHO_IOC_CANCEL         _IOWR('f', 203, OBD_IOC_DATA_TYPE) */
 397
 398 #define OBD_IOC_GET_OBJ_VERSION _IOR ('f', 210, OBD_IOC_DATA_TYPE)
 399
 400 /*      lustre/lustre_user.h    212-217 */
 401 #define OBD_IOC_GET_MNTOPT      _IOW ('f', 220, mntopt_t)
 402 #define OBD_IOC_ECHO_MD         _IOR ('f', 221, struct obd_ioctl_data)
 403 #define OBD_IOC_ECHO_ALLOC_SEQ  _IOWR('f', 222, struct obd_ioctl_data)
 404 #define OBD_IOC_START_LFSCK     _IOWR('f', 230, OBD_IOC_DATA_TYPE)
 405 #define OBD_IOC_STOP_LFSCK      _IOW ('f', 231, OBD_IOC_DATA_TYPE)
 406 #define OBD_IOC_QUERY_LFSCK     _IOR('f', 232, struct obd_ioctl_data)
 407 /*      lustre/lustre_user.h    240-249 */
 408 /*      LIBCFS_IOC_DEBUG_MASK   250 */
 409
 410 #define IOC_OSC_SET_ACTIVE      _IOWR('h', 21, void *)
 411
 412 #endif /* LUSTRE_IOCTL_H_ */