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 #include <linux/lustre/lustre_idl.h>
  35 #include <linux/lustre/lustre_ver.h>
  36
  37 /*
  38  * sparse kernel source annotations
  39  */
  40 #ifndef __user
  41 #define __user
  42 #endif
  43
  44 enum md_echo_cmd {
  45         ECHO_MD_CREATE          = 1, /* Open/Create file on MDT */
  46         ECHO_MD_MKDIR           = 2, /* Mkdir on MDT */
  47         ECHO_MD_DESTROY         = 3, /* Unlink file on MDT */
  48         ECHO_MD_RMDIR           = 4, /* Rmdir on MDT */
  49         ECHO_MD_LOOKUP          = 5, /* Lookup on MDT */
  50         ECHO_MD_GETATTR         = 6, /* Getattr on MDT */
  51         ECHO_MD_SETATTR         = 7, /* Setattr on MDT */
  52         ECHO_MD_ALLOC_FID       = 8, /* Get FIDs from MDT */
  53 };
  54
  55 #define OBD_DEV_ID 1
  56 #define OBD_DEV_NAME "obd"
  57 #define OBD_DEV_PATH "/dev/" OBD_DEV_NAME
  58
  59 #define OBD_IOCTL_VERSION       0x00010004
  60 #define OBD_DEV_BY_DEVNAME      0xffffd0de
  61
  62 struct obd_ioctl_data {
  63         __u32           ioc_len;
  64         __u32           ioc_version;
  65
  66         union {
  67                 __u64   ioc_cookie;
  68                 __u64   ioc_u64_1;
  69         };
  70         union {
  71                 __u32   ioc_conn1;
  72                 __u32   ioc_u32_1;
  73         };
  74         union {
  75                 __u32   ioc_conn2;
  76                 __u32   ioc_u32_2;
  77         };
  78
  79         struct obdo     ioc_obdo1;
  80         struct obdo     ioc_obdo2;
  81
  82         __u64           ioc_count;
  83         __u64           ioc_offset;
  84         __u32           ioc_dev;
  85         __u32           ioc_command;
  86
  87         __u64           ioc_nid;
  88         __u32           ioc_nal;
  89         __u32           ioc_type;
  90
  91         /* buffers the kernel will treat as user pointers */
  92         __u32           ioc_plen1;
  93         char __user    *ioc_pbuf1;
  94         __u32           ioc_plen2;
  95         char __user    *ioc_pbuf2;
  96
  97         /* inline buffers for various arguments */
  98         __u32           ioc_inllen1;
  99         char           *ioc_inlbuf1;
 100         __u32           ioc_inllen2;
 101         char           *ioc_inlbuf2;
 102         __u32           ioc_inllen3;
 103         char           *ioc_inlbuf3;
 104         __u32           ioc_inllen4;
 105         char           *ioc_inlbuf4;
 106
 107         char            ioc_bulk[0];
 108 };
 109
 110 struct obd_ioctl_hdr {
 111         __u32           ioc_len;
 112         __u32           ioc_version;
 113 };
 114
 115 static inline __u32 obd_ioctl_packlen(struct obd_ioctl_data *data)
 116 {
 117         __u32 len = __ALIGN_KERNEL(sizeof(*data), 8);
 118
 119         len += __ALIGN_KERNEL(data->ioc_inllen1, 8);
 120         len += __ALIGN_KERNEL(data->ioc_inllen2, 8);
 121         len += __ALIGN_KERNEL(data->ioc_inllen3, 8);
 122         len += __ALIGN_KERNEL(data->ioc_inllen4, 8);
 123
 124         return len;
 125 }
 126
 127 /*
 128  * OBD_IOC_DATA_TYPE is only for compatibility reasons with older
 129  * Linux Lustre user tools. New ioctls should NOT use this macro as
 130  * the ioctl "size". Instead the ioctl should get a "size" argument
 131  * which is the actual data type used by the ioctl, to ensure the
 132  * ioctl interface is versioned correctly.
 133  */
 134 #define OBD_IOC_DATA_TYPE       long
 135
 136 #define OBD_IOC_CREATE          _IOWR('f', 101, OBD_IOC_DATA_TYPE)
 137 #define OBD_IOC_DESTROY         _IOW('f', 104, OBD_IOC_DATA_TYPE)
 138 #define OBD_IOC_BARRIER_V2      _IOW('f', 105, struct obd_ioctl_data)
 139 #define OBD_IOC_SET_ACTIVE      _IOW('f', 106, struct obd_ioctl_data)
 140 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 19, 53, 0)
 141 /* for API compatibility until 2.19.x, but prefer to use new IOC values above */
 142 /* OBD_IOC_BARRIER wrongly defined as _IOWR('f', 261, OBD_IOC_DATA_TYPE) */
 143 #define OBD_IOC_BARRIER         _IOWR('g', 5, OBD_IOC_DATA_TYPE) /* < 2.16 */
 144 #define IOC_OSC_SET_ACTIVE      _IOWR('h', 21, void *) /* deprecated 2.16 */
 145 #endif
 146
 147 #define OBD_IOC_SETATTR         _IOW('f', 107, OBD_IOC_DATA_TYPE)
 148 #define OBD_IOC_GETATTR         _IOWR('f', 108, OBD_IOC_DATA_TYPE)
 149 #define OBD_IOC_READ            _IOWR('f', 109, OBD_IOC_DATA_TYPE)
 150 #define OBD_IOC_WRITE           _IOWR('f', 110, OBD_IOC_DATA_TYPE)
 151
 152 #define OBD_IOC_STATFS          _IOWR('f', 113, OBD_IOC_DATA_TYPE)
 153 #define OBD_IOC_SYNC            _IOW('f', 114, OBD_IOC_DATA_TYPE)
 154
 155 #define OBD_IOC_BRW_READ        _IOWR('f', 125, OBD_IOC_DATA_TYPE)
 156 #define OBD_IOC_BRW_WRITE       _IOWR('f', 126, OBD_IOC_DATA_TYPE)
 157 #define OBD_IOC_NAME2DEV        _IOWR('f', 127, OBD_IOC_DATA_TYPE)
 158 #define OBD_IOC_GETDTNAME       _IOR('f', 127, char[MAX_OBD_NAME])
 159 /* ioctl codes 128-143 are reserved for fsverity */
 160 #define OBD_IOC_UUID2DEV        _IOWR('f', 130, OBD_IOC_DATA_TYPE)
 161 #define OBD_IOC_GETMDNAME       _IOR('f', 131, char[MAX_OBD_NAME])
 162 #define OBD_IOC_CLIENT_RECOVER  _IOW('f', 133, OBD_IOC_DATA_TYPE)
 163 /* ioctl codes 128-143 are reserved for fsverity */
 164 #define OBD_IOC_SET_READONLY    _IOW('f', 141, OBD_IOC_DATA_TYPE)
 165 #define OBD_IOC_ABORT_RECOVERY  _IOR('f', 142, OBD_IOC_DATA_TYPE)
 166 enum obd_abort_recovery_flags {
 167         OBD_FLG_ABORT_RECOV_OST = 0x00008, /* LMD_FLG_ABORT_RECOV */
 168         OBD_FLG_ABORT_RECOV_MDT = 0x40000, /* LMD_FLG_ABORT_RECOV_MDT */
 169 };
 170 /* ioctl codes 128-143 are reserved for fsverity */
 171 #define OBD_IOC_GETDEVICE       _IOWR('f', 149, OBD_IOC_DATA_TYPE)
 172 #define OBD_IOC_FID2PATH        _IOWR('f', 150, OBD_IOC_DATA_TYPE)
 173 /*      lustre/lustre_user.h    151-159 */
 174 #define OBD_IOC_QUOTACTL        _IOWR('f', 162, struct if_quotactl)
 175 /*      lustre/lustre_user.h    163-176 */
 176 #define OBD_IOC_CHANGELOG_REG   _IOW('f', 177, struct obd_ioctl_data)
 177 #define OBD_IOC_CHANGELOG_DEREG _IOW('f', 178, struct obd_ioctl_data)
 178 #define OBD_IOC_CHANGELOG_CLEAR _IOW('f', 179, struct obd_ioctl_data)
 179 #define OBD_IOC_PROCESS_CFG     _IOWR('f', 184, OBD_IOC_DATA_TYPE)
 180 #define OBD_IOC_PARAM           _IOW('f', 187, OBD_IOC_DATA_TYPE)
 181 #define OBD_IOC_POOL            _IOWR('f', 188, OBD_IOC_DATA_TYPE)
 182 #define OBD_IOC_REPLACE_NIDS    _IOWR('f', 189, OBD_IOC_DATA_TYPE)
 183
 184 #define OBD_IOC_CATLOGLIST      _IOWR('f', 190, OBD_IOC_DATA_TYPE)
 185 #define OBD_IOC_LLOG_INFO       _IOWR('f', 191, OBD_IOC_DATA_TYPE)
 186 #define OBD_IOC_LLOG_PRINT      _IOWR('f', 192, OBD_IOC_DATA_TYPE)
 187 #define OBD_IOC_LLOG_CANCEL     _IOWR('f', 193, OBD_IOC_DATA_TYPE)
 188 #define OBD_IOC_LLOG_REMOVE     _IOWR('f', 194, OBD_IOC_DATA_TYPE)
 189 #define OBD_IOC_LLOG_CHECK      _IOWR('f', 195, OBD_IOC_DATA_TYPE)
 190 #define OBD_IOC_NODEMAP         _IOWR('f', 197, OBD_IOC_DATA_TYPE)
 191 #define OBD_IOC_CLEAR_CONFIGS   _IOWR('f', 198, OBD_IOC_DATA_TYPE)
 192 #define OBD_IOC_LCFG_FORK       _IOWR('f', 208, OBD_IOC_DATA_TYPE)
 193 #define OBD_IOC_LCFG_ERASE      _IOWR('f', 209, OBD_IOC_DATA_TYPE)
 194 #define OBD_IOC_GET_OBJ_VERSION _IOR('f', 210, OBD_IOC_DATA_TYPE)
 195 /*      lustre/lustre_user.h    211-220 */
 196 #define OBD_IOC_ECHO_MD         _IOR('f', 221, struct obd_ioctl_data)
 197 #define OBD_IOC_ECHO_ALLOC_SEQ  _IOWR('f', 222, struct obd_ioctl_data)
 198 #define OBD_IOC_START_LFSCK     _IOWR('f', 230, OBD_IOC_DATA_TYPE)
 199 #define OBD_IOC_STOP_LFSCK      _IOW('f', 231, OBD_IOC_DATA_TYPE)
 200 #define OBD_IOC_QUERY_LFSCK     _IOR('f', 232, struct obd_ioctl_data)
 201 #define OBD_IOC_CHLG_SET_FLAGS  _IOR('f', 233, long)
 202 /* for compatibility issues with old apps */
 203 #define OBD_IOC_CHLG_POLL OBD_IOC_CHLG_SET_FLAGS
 204 /*      lustre/lustre_user.h    240-253 */
 205
 206 #endif /* _UAPI_LUSTRE_IOCTL_H */