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