lustre/include/uapi/linux/lustre/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) 2014, 2017, Intel Corporation.
  27  */
  28 #ifndef _UAPI_LUSTRE_IOCTL_H
  29 #define _UAPI_LUSTRE_IOCTL_H
  30
  31 #include <linux/ioctl.h>
  32 #include <linux/kernel.h>
  33 #include <linux/types.h>
  34 /*
  35  * This is due to us being out of kernel and the way the OpenSFS branch
  36  * handles CFLAGS.
  37  */
  38 #ifdef __KERNEL__
  39 # include <uapi/linux/lustre/lustre_idl.h>
  40 #else
  41 # include <linux/lustre/lustre_idl.h>
  42 # define __user
  43 #endif
  44
  45 #if !defined(__KERNEL__) && !defined(LUSTRE_UTILS)
  46 # error This file is for Lustre internal use only.
  47 #endif
  48
  49 /* Handle older distros */
  50 #ifndef __ALIGN_KERNEL
  51 # define __ALIGN_KERNEL(x, a)   __ALIGN_KERNEL_MASK(x, (typeof(x))(a) - 1)
  52 # define __ALIGN_KERNEL_MASK(x, mask)   (((x) + (mask)) & ~(mask))
  53 #endif
  54
  55 enum md_echo_cmd {
  56         ECHO_MD_CREATE          = 1, /* Open/Create file on MDT */
  57         ECHO_MD_MKDIR           = 2, /* Mkdir on MDT */
  58         ECHO_MD_DESTROY         = 3, /* Unlink file on MDT */
  59         ECHO_MD_RMDIR           = 4, /* Rmdir on MDT */
  60         ECHO_MD_LOOKUP          = 5, /* Lookup on MDT */
  61         ECHO_MD_GETATTR         = 6, /* Getattr on MDT */
  62         ECHO_MD_SETATTR         = 7, /* Setattr on MDT */
  63         ECHO_MD_ALLOC_FID       = 8, /* Get FIDs from MDT */
  64 };
  65
  66 #define OBD_DEV_ID 1
  67 #define OBD_DEV_NAME "obd"
  68 #define OBD_DEV_PATH "/dev/" OBD_DEV_NAME
  69
  70 #define OBD_IOCTL_VERSION       0x00010004
  71 #define OBD_DEV_BY_DEVNAME      0xffffd0de
  72
  73 struct obd_ioctl_data {
  74         __u32           ioc_len;
  75         __u32           ioc_version;
  76
  77         union {
  78                 __u64   ioc_cookie;
  79                 __u64   ioc_u64_1;
  80         };
  81         union {
  82                 __u32   ioc_conn1;
  83                 __u32   ioc_u32_1;
  84         };
  85         union {
  86                 __u32   ioc_conn2;
  87                 __u32   ioc_u32_2;
  88         };
  89
  90         struct obdo     ioc_obdo1;
  91         struct obdo     ioc_obdo2;
  92
  93         __u64           ioc_count;
  94         __u64           ioc_offset;
  95         __u32           ioc_dev;
  96         __u32           ioc_command;
  97
  98         __u64           ioc_nid;
  99         __u32           ioc_nal;
 100         __u32           ioc_type;
 101
 102         /* buffers the kernel will treat as user pointers */
 103         __u32           ioc_plen1;
 104         char __user    *ioc_pbuf1;
 105         __u32           ioc_plen2;
 106         char __user    *ioc_pbuf2;
 107
 108         /* inline buffers for various arguments */
 109         __u32           ioc_inllen1;
 110         char           *ioc_inlbuf1;
 111         __u32           ioc_inllen2;
 112         char           *ioc_inlbuf2;
 113         __u32           ioc_inllen3;
 114         char           *ioc_inlbuf3;
 115         __u32           ioc_inllen4;
 116         char           *ioc_inlbuf4;
 117
 118         char            ioc_bulk[0];
 119 };
 120
 121 struct obd_ioctl_hdr {
 122         __u32           ioc_len;
 123         __u32           ioc_version;
 124 };
 125
 126 static inline __u32 obd_ioctl_packlen(struct obd_ioctl_data *data)
 127 {
 128         __u32 len = __ALIGN_KERNEL(sizeof(*data), 8);
 129
 130         len += __ALIGN_KERNEL(data->ioc_inllen1, 8);
 131         len += __ALIGN_KERNEL(data->ioc_inllen2, 8);
 132         len += __ALIGN_KERNEL(data->ioc_inllen3, 8);
 133         len += __ALIGN_KERNEL(data->ioc_inllen4, 8);
 134
 135         return len;
 136 }
 137
 138 /*
 139  * OBD_IOC_DATA_TYPE is only for compatibility reasons with older
 140  * Linux Lustre user tools. New ioctls should NOT use this macro as
 141  * the ioctl "size". Instead the ioctl should get a "size" argument
 142  * which is the actual data type used by the ioctl, to ensure the
 143  * ioctl interface is versioned correctly.
 144  */
 145 #define OBD_IOC_DATA_TYPE       long
 146
 147 /*      IOC_LDLM_TEST           _IOWR('f', 40, long) */
 148 /*      IOC_LDLM_DUMP           _IOWR('f', 41, long) */
 149 /*      IOC_LDLM_REGRESS_START  _IOWR('f', 42, long) */
 150 /*      IOC_LDLM_REGRESS_STOP   _IOWR('f', 43, long) */
 151
 152 #define OBD_IOC_CREATE          _IOWR('f', 101, OBD_IOC_DATA_TYPE)
 153 #define OBD_IOC_DESTROY         _IOW('f', 104, OBD_IOC_DATA_TYPE)
 154 /*      OBD_IOC_PREALLOCATE     _IOWR('f', 105, OBD_IOC_DATA_TYPE) */
 155
 156 #define OBD_IOC_SETATTR         _IOW('f', 107, OBD_IOC_DATA_TYPE)
 157 #define OBD_IOC_GETATTR         _IOWR('f', 108, OBD_IOC_DATA_TYPE)
 158 #define OBD_IOC_READ            _IOWR('f', 109, OBD_IOC_DATA_TYPE)
 159 #define OBD_IOC_WRITE           _IOWR('f', 110, OBD_IOC_DATA_TYPE)
 160
 161 #define OBD_IOC_STATFS          _IOWR('f', 113, OBD_IOC_DATA_TYPE)
 162 #define OBD_IOC_SYNC            _IOW('f', 114, OBD_IOC_DATA_TYPE)
 163 /*      OBD_IOC_READ2           _IOWR('f', 115, OBD_IOC_DATA_TYPE) */
 164 /*      OBD_IOC_FORMAT          _IOWR('f', 116, OBD_IOC_DATA_TYPE) */
 165 /*      OBD_IOC_PARTITION       _IOWR('f', 117, OBD_IOC_DATA_TYPE) */
 166 /*      OBD_IOC_COPY            _IOWR('f', 120, OBD_IOC_DATA_TYPE) */
 167 /*      OBD_IOC_MIGR            _IOWR('f', 121, OBD_IOC_DATA_TYPE) */
 168 /*      OBD_IOC_PUNCH           _IOWR('f', 122, OBD_IOC_DATA_TYPE) */
 169
 170 /*      OBD_IOC_MODULE_DEBUG    _IOWR('f', 124, OBD_IOC_DATA_TYPE) */
 171 #define OBD_IOC_BRW_READ        _IOWR('f', 125, OBD_IOC_DATA_TYPE)
 172 #define OBD_IOC_BRW_WRITE       _IOWR('f', 126, OBD_IOC_DATA_TYPE)
 173 #define OBD_IOC_NAME2DEV        _IOWR('f', 127, OBD_IOC_DATA_TYPE)
 174 #define OBD_IOC_UUID2DEV        _IOWR('f', 130, OBD_IOC_DATA_TYPE)
 175 #define OBD_IOC_GETNAME         _IOWR('f', 131, OBD_IOC_DATA_TYPE)
 176 #define OBD_IOC_GETMDNAME       _IOR('f', 131, char[MAX_OBD_NAME])
 177 #define OBD_IOC_GETDTNAME       OBD_IOC_GETNAME
 178 #define OBD_IOC_LOV_GET_CONFIG  _IOWR('f', 132, OBD_IOC_DATA_TYPE)
 179 #define OBD_IOC_CLIENT_RECOVER  _IOW('f', 133, OBD_IOC_DATA_TYPE)
 180 /* was  OBD_IOC_PING_TARGET     _IOW('f', 136, OBD_IOC_DATA_TYPE) until 2.11 */
 181
 182 /*      OBD_IOC_DEC_FS_USE_COUNT _IO('f', 139) */
 183 #define OBD_IOC_NO_TRANSNO      _IOW('f', 140, OBD_IOC_DATA_TYPE)
 184 #define OBD_IOC_SET_READONLY    _IOW('f', 141, OBD_IOC_DATA_TYPE)
 185 #define OBD_IOC_ABORT_RECOVERY  _IOR('f', 142, OBD_IOC_DATA_TYPE)
 186 /*      OBD_IOC_ROOT_SQUASH     _IOWR('f', 143, OBD_IOC_DATA_TYPE) */
 187 #define OBD_GET_VERSION         _IOWR('f', 144, OBD_IOC_DATA_TYPE)
 188 /*      OBD_IOC_GSS_SUPPORT     _IOWR('f', 145, OBD_IOC_DATA_TYPE) */
 189 /*      OBD_IOC_CLOSE_UUID      _IOWR('f', 147, OBD_IOC_DATA_TYPE) */
 190 /*      OBD_IOC_CHANGELOG_SEND  _IOW('f', 148, OBD_IOC_DATA_TYPE) */
 191 #define OBD_IOC_GETDEVICE       _IOWR('f', 149, OBD_IOC_DATA_TYPE)
 192 #define OBD_IOC_FID2PATH        _IOWR('f', 150, OBD_IOC_DATA_TYPE)
 193 /*      lustre/lustre_user.h    151-153 */
 194 /*      OBD_IOC_LOV_SETSTRIPE   154 LL_IOC_LOV_SETSTRIPE */
 195 /*      OBD_IOC_LOV_GETSTRIPE   155 LL_IOC_LOV_GETSTRIPE */
 196 /*      OBD_IOC_LOV_SETEA       156 LL_IOC_LOV_SETEA */
 197 /*      lustre/lustre_user.h    157-159 */
 198 /*      OBD_IOC_QUOTACHECK      _IOW('f', 160, int) */
 199 /*      OBD_IOC_POLL_QUOTACHECK _IOR('f', 161, struct if_quotacheck *) */
 200 #define OBD_IOC_QUOTACTL        _IOWR('f', 162, struct if_quotactl)
 201 /*      lustre/lustre_user.h    163-176 */
 202 #define OBD_IOC_CHANGELOG_REG   _IOW('f', 177, struct obd_ioctl_data)
 203 #define OBD_IOC_CHANGELOG_DEREG _IOW('f', 178, struct obd_ioctl_data)
 204 #define OBD_IOC_CHANGELOG_CLEAR _IOW('f', 179, struct obd_ioctl_data)
 205 /*      OBD_IOC_RECORD          _IOWR('f', 180, OBD_IOC_DATA_TYPE) */
 206 /*      OBD_IOC_ENDRECORD       _IOWR('f', 181, OBD_IOC_DATA_TYPE) */
 207 /*      OBD_IOC_PARSE           _IOWR('f', 182, OBD_IOC_DATA_TYPE) */
 208 /*      OBD_IOC_DORECORD        _IOWR('f', 183, OBD_IOC_DATA_TYPE) */
 209 #define OBD_IOC_PROCESS_CFG     _IOWR('f', 184, OBD_IOC_DATA_TYPE)
 210 /*      OBD_IOC_DUMP_LOG        _IOWR('f', 185, OBD_IOC_DATA_TYPE) */
 211 /*      OBD_IOC_CLEAR_LOG       _IOWR('f', 186, OBD_IOC_DATA_TYPE) */
 212 #define OBD_IOC_PARAM           _IOW('f', 187, OBD_IOC_DATA_TYPE)
 213 #define OBD_IOC_POOL            _IOWR('f', 188, OBD_IOC_DATA_TYPE)
 214 #define OBD_IOC_REPLACE_NIDS    _IOWR('f', 189, OBD_IOC_DATA_TYPE)
 215
 216 #define OBD_IOC_CATLOGLIST      _IOWR('f', 190, OBD_IOC_DATA_TYPE)
 217 #define OBD_IOC_LLOG_INFO       _IOWR('f', 191, OBD_IOC_DATA_TYPE)
 218 #define OBD_IOC_LLOG_PRINT      _IOWR('f', 192, OBD_IOC_DATA_TYPE)
 219 #define OBD_IOC_LLOG_CANCEL     _IOWR('f', 193, OBD_IOC_DATA_TYPE)
 220 #define OBD_IOC_LLOG_REMOVE     _IOWR('f', 194, OBD_IOC_DATA_TYPE)
 221 #define OBD_IOC_LLOG_CHECK      _IOWR('f', 195, OBD_IOC_DATA_TYPE)
 222 /*      OBD_IOC_LLOG_CATINFO    _IOWR('f', 196, OBD_IOC_DATA_TYPE) */
 223 #define OBD_IOC_NODEMAP         _IOWR('f', 197, OBD_IOC_DATA_TYPE)
 224 #define OBD_IOC_CLEAR_CONFIGS   _IOWR('f', 198, OBD_IOC_DATA_TYPE)
 225
 226 /*      ECHO_IOC_GET_STRIPE     _IOWR('f', 200, OBD_IOC_DATA_TYPE) */
 227 /*      ECHO_IOC_SET_STRIPE     _IOWR('f', 201, OBD_IOC_DATA_TYPE) */
 228 /*      ECHO_IOC_ENQUEUE        _IOWR('f', 202, OBD_IOC_DATA_TYPE) */
 229 /*      ECHO_IOC_CANCEL         _IOWR('f', 203, OBD_IOC_DATA_TYPE) */
 230
 231 #define OBD_IOC_LCFG_FORK       _IOWR('f', 208, OBD_IOC_DATA_TYPE)
 232 #define OBD_IOC_LCFG_ERASE      _IOWR('f', 209, OBD_IOC_DATA_TYPE)
 233 #define OBD_IOC_GET_OBJ_VERSION _IOR('f', 210, OBD_IOC_DATA_TYPE)
 234
 235 /*      lustre/lustre_user.h    211-220 */
 236 /* was #define OBD_IOC_GET_MNTOPT       _IOW('f', 220, mntopt_t) until 2.11 */
 237 #define OBD_IOC_ECHO_MD         _IOR('f', 221, struct obd_ioctl_data)
 238 #define OBD_IOC_ECHO_ALLOC_SEQ  _IOWR('f', 222, struct obd_ioctl_data)
 239 #define OBD_IOC_START_LFSCK     _IOWR('f', 230, OBD_IOC_DATA_TYPE)
 240 #define OBD_IOC_STOP_LFSCK      _IOW('f', 231, OBD_IOC_DATA_TYPE)
 241 #define OBD_IOC_QUERY_LFSCK     _IOR('f', 232, struct obd_ioctl_data)
 242 /*      lustre/lustre_user.h    240-249 */
 243 /*      LIBCFS_IOC_DEBUG_MASK   250 */
 244
 245 #define OBD_IOC_BARRIER         _IOWR('f', 261, OBD_IOC_DATA_TYPE)
 246
 247 #define IOC_OSC_SET_ACTIVE      _IOWR('h', 21, void *)
 248
 249 #endif /* _UAPI_LUSTRE_IOCTL_H */