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 <linux/types.h>
32 #include "../../../include/linux/libcfs/libcfs.h"
33 #include "lustre_idl.h"
34
35 #ifdef __KERNEL__
36 # include <linux/ioctl.h>
37 # include <linux/string.h>
38 # include "../obd_support.h"
39 #else /* __KERNEL__ */
40 # include <malloc.h>
41 # include <string.h>
42 #include <libcfs/util/ioctl.h>
43 #endif /* !__KERNEL__ */
44
45 #if !defined(__KERNEL__) && !defined(LUSTRE_UTILS)
46 # error This file is for Lustre internal use only.
47 #endif
48
49 enum md_echo_cmd {
50 ECHO_MD_CREATE = 1, /* Open/Create file on MDT */
51 ECHO_MD_MKDIR = 2, /* Mkdir on MDT */
52 ECHO_MD_DESTROY = 3, /* Unlink file on MDT */
53 ECHO_MD_RMDIR = 4, /* Rmdir on MDT */
54 ECHO_MD_LOOKUP = 5, /* Lookup on MDT */
55 ECHO_MD_GETATTR = 6, /* Getattr on MDT */
56 ECHO_MD_SETATTR = 7, /* Setattr on MDT */
57 ECHO_MD_ALLOC_FID = 8, /* Get FIDs from MDT */
58 };
59
60 #define OBD_DEV_ID 1
61 #define OBD_DEV_NAME "obd"
62 #define OBD_DEV_PATH "/dev/" OBD_DEV_NAME
63 #define OBD_DEV_MAJOR 10
64 #define OBD_DEV_MINOR 241
65
66 #define OBD_IOCTL_VERSION 0x00010004
67 #define OBD_DEV_BY_DEVNAME 0xffffd0de
68 #define OBD_MAX_IOCTL_BUFFER CONFIG_LUSTRE_OBD_MAX_IOCTL_BUFFER
69
70 struct obd_ioctl_data {
71 __u32 ioc_len;
72 __u32 ioc_version;
73
74 union {
75 __u64 ioc_cookie;
76 __u64 ioc_u64_1;
77 };
78 union {
79 __u32 ioc_conn1;
80 __u32 ioc_u32_1;
81 };
82 union {
83 __u32 ioc_conn2;
84 __u32 ioc_u32_2;
85 };
86
87 struct obdo ioc_obdo1;
88 struct obdo ioc_obdo2;
89
90 __u64 ioc_count;
91 __u64 ioc_offset;
92 __u32 ioc_dev;
93 __u32 ioc_command;
94
95 __u64 ioc_nid;
96 __u32 ioc_nal;
97 __u32 ioc_type;
98
99 /* buffers the kernel will treat as user pointers */
100 __u32 ioc_plen1;
101 char __user *ioc_pbuf1;
102 __u32 ioc_plen2;
103 char __user *ioc_pbuf2;
104
105 /* inline buffers for various arguments */
106 __u32 ioc_inllen1;
107 char *ioc_inlbuf1;
108 __u32 ioc_inllen2;
109 char *ioc_inlbuf2;
110 __u32 ioc_inllen3;
111 char *ioc_inlbuf3;
112 __u32 ioc_inllen4;
113 char *ioc_inlbuf4;
114
115 char ioc_bulk[0];
116 };
117
118 struct obd_ioctl_hdr {
119 __u32 ioc_len;
120 __u32 ioc_version;
121 };
122
obd_ioctl_packlen(struct obd_ioctl_data * data)123 static inline __u32 obd_ioctl_packlen(struct obd_ioctl_data *data)
124 {
125 __u32 len = cfs_size_round(sizeof(*data));
126
127 len += cfs_size_round(data->ioc_inllen1);
128 len += cfs_size_round(data->ioc_inllen2);
129 len += cfs_size_round(data->ioc_inllen3);
130 len += cfs_size_round(data->ioc_inllen4);
131
132 return len;
133 }
134
obd_ioctl_is_invalid(struct obd_ioctl_data * data)135 static inline int obd_ioctl_is_invalid(struct obd_ioctl_data *data)
136 {
137 if (data->ioc_len > (1 << 30)) {
138 CERROR("OBD ioctl: ioc_len larger than 1<<30\n");
139 return 1;
140 }
141
142 if (data->ioc_inllen1 > (1 << 30)) {
143 CERROR("OBD ioctl: ioc_inllen1 larger than 1<<30\n");
144 return 1;
145 }
146
147 if (data->ioc_inllen2 > (1 << 30)) {
148 CERROR("OBD ioctl: ioc_inllen2 larger than 1<<30\n");
149 return 1;
150 }
151
152 if (data->ioc_inllen3 > (1 << 30)) {
153 CERROR("OBD ioctl: ioc_inllen3 larger than 1<<30\n");
154 return 1;
155 }
156
157 if (data->ioc_inllen4 > (1 << 30)) {
158 CERROR("OBD ioctl: ioc_inllen4 larger than 1<<30\n");
159 return 1;
160 }
161
162 if (data->ioc_inlbuf1 && !data->ioc_inllen1) {
163 CERROR("OBD ioctl: inlbuf1 pointer but 0 length\n");
164 return 1;
165 }
166
167 if (data->ioc_inlbuf2 && !data->ioc_inllen2) {
168 CERROR("OBD ioctl: inlbuf2 pointer but 0 length\n");
169 return 1;
170 }
171
172 if (data->ioc_inlbuf3 && !data->ioc_inllen3) {
173 CERROR("OBD ioctl: inlbuf3 pointer but 0 length\n");
174 return 1;
175 }
176
177 if (data->ioc_inlbuf4 && !data->ioc_inllen4) {
178 CERROR("OBD ioctl: inlbuf4 pointer but 0 length\n");
179 return 1;
180 }
181
182 if (data->ioc_pbuf1 && !data->ioc_plen1) {
183 CERROR("OBD ioctl: pbuf1 pointer but 0 length\n");
184 return 1;
185 }
186
187 if (data->ioc_pbuf2 && !data->ioc_plen2) {
188 CERROR("OBD ioctl: pbuf2 pointer but 0 length\n");
189 return 1;
190 }
191
192 if (!data->ioc_pbuf1 && data->ioc_plen1) {
193 CERROR("OBD ioctl: plen1 set but NULL pointer\n");
194 return 1;
195 }
196
197 if (!data->ioc_pbuf2 && data->ioc_plen2) {
198 CERROR("OBD ioctl: plen2 set but NULL pointer\n");
199 return 1;
200 }
201
202 if (obd_ioctl_packlen(data) > data->ioc_len) {
203 CERROR("OBD ioctl: packlen exceeds ioc_len (%d > %d)\n",
204 obd_ioctl_packlen(data), data->ioc_len);
205 return 1;
206 }
207
208 return 0;
209 }
210
211 #ifdef __KERNEL__
212
213 int obd_ioctl_getdata(char **buf, int *len, void __user *arg);
214 int obd_ioctl_popdata(void __user *arg, void *data, int len);
215
obd_ioctl_freedata(char * buf,size_t len)216 static inline void obd_ioctl_freedata(char *buf, size_t len)
217 {
218 kvfree(buf);
219 }
220
221 #else /* __KERNEL__ */
222
obd_ioctl_pack(struct obd_ioctl_data * data,char ** pbuf,int max_len)223 static inline int obd_ioctl_pack(struct obd_ioctl_data *data, char **pbuf,
224 int max_len)
225 {
226 char *ptr;
227 struct obd_ioctl_data *overlay;
228
229 data->ioc_len = obd_ioctl_packlen(data);
230 data->ioc_version = OBD_IOCTL_VERSION;
231
232 if (*pbuf && data->ioc_len > max_len) {
233 fprintf(stderr, "pbuf = %p, ioc_len = %u, max_len = %d\n",
234 *pbuf, data->ioc_len, max_len);
235 return -EINVAL;
236 }
237
238 if (!*pbuf)
239 *pbuf = malloc(data->ioc_len);
240
241 if (!*pbuf)
242 return -ENOMEM;
243
244 overlay = (struct obd_ioctl_data *)*pbuf;
245 memcpy(*pbuf, data, sizeof(*data));
246
247 ptr = overlay->ioc_bulk;
248 if (data->ioc_inlbuf1)
249 LOGL(data->ioc_inlbuf1, data->ioc_inllen1, ptr);
250
251 if (data->ioc_inlbuf2)
252 LOGL(data->ioc_inlbuf2, data->ioc_inllen2, ptr);
253
254 if (data->ioc_inlbuf3)
255 LOGL(data->ioc_inlbuf3, data->ioc_inllen3, ptr);
256
257 if (data->ioc_inlbuf4)
258 LOGL(data->ioc_inlbuf4, data->ioc_inllen4, ptr);
259
260 if (obd_ioctl_is_invalid(overlay)) {
261 fprintf(stderr, "invalid ioctl data: ioc_len = %u, max_len = %d\n",
262 data->ioc_len, max_len);
263 return -EINVAL;
264 }
265
266 return 0;
267 }
268
269 static inline int
obd_ioctl_unpack(struct obd_ioctl_data * data,char * pbuf,int max_len)270 obd_ioctl_unpack(struct obd_ioctl_data *data, char *pbuf, int max_len)
271 {
272 char *ptr;
273 struct obd_ioctl_data *overlay;
274
275 if (!pbuf)
276 return 1;
277
278 overlay = (struct obd_ioctl_data *)pbuf;
279
280 /* Preserve the caller's buffer pointers */
281 overlay->ioc_inlbuf1 = data->ioc_inlbuf1;
282 overlay->ioc_inlbuf2 = data->ioc_inlbuf2;
283 overlay->ioc_inlbuf3 = data->ioc_inlbuf3;
284 overlay->ioc_inlbuf4 = data->ioc_inlbuf4;
285
286 memcpy(data, pbuf, sizeof(*data));
287
288 ptr = overlay->ioc_bulk;
289 if (data->ioc_inlbuf1)
290 LOGU(data->ioc_inlbuf1, data->ioc_inllen1, ptr);
291
292 if (data->ioc_inlbuf2)
293 LOGU(data->ioc_inlbuf2, data->ioc_inllen2, ptr);
294
295 if (data->ioc_inlbuf3)
296 LOGU(data->ioc_inlbuf3, data->ioc_inllen3, ptr);
297
298 if (data->ioc_inlbuf4)
299 LOGU(data->ioc_inlbuf4, data->ioc_inllen4, ptr);
300
301 return 0;
302 }
303
304 #endif /* !__KERNEL__ */
305
306 /*
307 * OBD_IOC_DATA_TYPE is only for compatibility reasons with older
308 * Linux Lustre user tools. New ioctls should NOT use this macro as
309 * the ioctl "size". Instead the ioctl should get a "size" argument
310 * which is the actual data type used by the ioctl, to ensure the
311 * ioctl interface is versioned correctly.
312 */
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 #define OBD_IOC_QUOTACHECK _IOW('f', 160, int)
367 #define 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_ */
413