lustre/include/uapi/linux/lustre/lustre_ioctl.h

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