4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
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.
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).
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
23 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Use is subject to license terms.
26 * Copyright (c) 2011, 2015, Intel Corporation.
28 #ifndef LUSTRE_IOCTL_H_
29 #define LUSTRE_IOCTL_H_
31 #include <linux/types.h>
32 #include <libcfs/libcfs.h>
33 #include <libcfs/util/ioctl.h>
34 #include <lustre/lustre_idl.h>
37 # include <linux/ioctl.h>
38 # include <linux/string.h>
39 # include <obd_support.h>
40 #else /* __KERNEL__ */
43 #endif /* !__KERNEL__ */
45 #if !defined(__KERNEL__) && !defined(LUSTRE_UTILS)
46 # error This file is for Lustre internal use only.
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 */
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
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
70 struct obd_ioctl_data {
87 struct obdo ioc_obdo1;
88 struct obdo ioc_obdo2;
99 /* buffers the kernel will treat as user pointers */
101 char __user *ioc_pbuf1;
103 char __user *ioc_pbuf2;
105 /* inline buffers for various arguments */
118 struct obd_ioctl_hdr {
123 static inline __u32 obd_ioctl_packlen(struct obd_ioctl_data *data)
125 __u32 len = cfs_size_round(sizeof(*data));
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);
135 static inline int obd_ioctl_is_invalid(struct obd_ioctl_data *data)
137 if (data->ioc_len > (1 << 30)) {
138 CERROR("OBD ioctl: ioc_len larger than 1<<30\n");
142 if (data->ioc_inllen1 > (1 << 30)) {
143 CERROR("OBD ioctl: ioc_inllen1 larger than 1<<30\n");
147 if (data->ioc_inllen2 > (1 << 30)) {
148 CERROR("OBD ioctl: ioc_inllen2 larger than 1<<30\n");
152 if (data->ioc_inllen3 > (1 << 30)) {
153 CERROR("OBD ioctl: ioc_inllen3 larger than 1<<30\n");
157 if (data->ioc_inllen4 > (1 << 30)) {
158 CERROR("OBD ioctl: ioc_inllen4 larger than 1<<30\n");
162 if (data->ioc_inlbuf1 != NULL && data->ioc_inllen1 == 0) {
163 CERROR("OBD ioctl: inlbuf1 pointer but 0 length\n");
167 if (data->ioc_inlbuf2 != NULL && data->ioc_inllen2 == 0) {
168 CERROR("OBD ioctl: inlbuf2 pointer but 0 length\n");
172 if (data->ioc_inlbuf3 != NULL && data->ioc_inllen3 == 0) {
173 CERROR("OBD ioctl: inlbuf3 pointer but 0 length\n");
177 if (data->ioc_inlbuf4 != NULL && data->ioc_inllen4 == 0) {
178 CERROR("OBD ioctl: inlbuf4 pointer but 0 length\n");
182 if (data->ioc_pbuf1 != NULL && data->ioc_plen1 == 0) {
183 CERROR("OBD ioctl: pbuf1 pointer but 0 length\n");
187 if (data->ioc_pbuf2 != NULL && data->ioc_plen2 == 0) {
188 CERROR("OBD ioctl: pbuf2 pointer but 0 length\n");
192 if (data->ioc_pbuf1 == NULL && data->ioc_plen1 != 0) {
193 CERROR("OBD ioctl: plen1 set but NULL pointer\n");
197 if (data->ioc_pbuf2 == NULL && data->ioc_plen2 != 0) {
198 CERROR("OBD ioctl: plen2 set but NULL pointer\n");
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);
213 int obd_ioctl_getdata(char **buf, int *len, void __user *arg);
214 int obd_ioctl_popdata(void __user *arg, void *data, int len);
216 static inline void obd_ioctl_freedata(char *buf, size_t len)
220 OBD_FREE_LARGE(buf, len);
224 #else /* __KERNEL__ */
226 static inline int obd_ioctl_pack(struct obd_ioctl_data *data, char **pbuf,
230 struct obd_ioctl_data *overlay;
232 data->ioc_len = obd_ioctl_packlen(data);
233 data->ioc_version = OBD_IOCTL_VERSION;
235 if (*pbuf != NULL && data->ioc_len > max_len) {
236 fprintf(stderr, "pbuf = %p, ioc_len = %u, max_len = %d\n",
237 *pbuf, data->ioc_len, max_len);
242 *pbuf = malloc(data->ioc_len);
247 overlay = (struct obd_ioctl_data *)*pbuf;
248 memcpy(*pbuf, data, sizeof(*data));
250 ptr = overlay->ioc_bulk;
251 if (data->ioc_inlbuf1 != NULL)
252 LOGL(data->ioc_inlbuf1, data->ioc_inllen1, ptr);
254 if (data->ioc_inlbuf2 != NULL)
255 LOGL(data->ioc_inlbuf2, data->ioc_inllen2, ptr);
257 if (data->ioc_inlbuf3 != NULL)
258 LOGL(data->ioc_inlbuf3, data->ioc_inllen3, ptr);
260 if (data->ioc_inlbuf4 != NULL)
261 LOGL(data->ioc_inlbuf4, data->ioc_inllen4, ptr);
263 if (obd_ioctl_is_invalid(overlay)) {
264 fprintf(stderr, "invalid ioctl data: ioc_len = %u, "
266 data->ioc_len, max_len);
274 obd_ioctl_unpack(struct obd_ioctl_data *data, char *pbuf, int max_len)
277 struct obd_ioctl_data *overlay;
282 overlay = (struct obd_ioctl_data *)pbuf;
284 /* Preserve the caller's buffer pointers */
285 overlay->ioc_inlbuf1 = data->ioc_inlbuf1;
286 overlay->ioc_inlbuf2 = data->ioc_inlbuf2;
287 overlay->ioc_inlbuf3 = data->ioc_inlbuf3;
288 overlay->ioc_inlbuf4 = data->ioc_inlbuf4;
290 memcpy(data, pbuf, sizeof(*data));
292 ptr = overlay->ioc_bulk;
293 if (data->ioc_inlbuf1 != NULL)
294 LOGU(data->ioc_inlbuf1, data->ioc_inllen1, ptr);
296 if (data->ioc_inlbuf2 != NULL)
297 LOGU(data->ioc_inlbuf2, data->ioc_inllen2, ptr);
299 if (data->ioc_inlbuf3 != NULL)
300 LOGU(data->ioc_inlbuf3, data->ioc_inllen3, ptr);
302 if (data->ioc_inlbuf4 != NULL)
303 LOGU(data->ioc_inlbuf4, data->ioc_inllen4, ptr);
308 #endif /* !__KERNEL__ */
310 /* OBD_IOC_DATA_TYPE is only for compatibility reasons with older
311 * Linux Lustre user tools. New ioctls should NOT use this macro as
312 * the ioctl "size". Instead the ioctl should get a "size" argument
313 * which is the actual data type used by the ioctl, to ensure the
314 * ioctl interface is versioned correctly. */
315 #define OBD_IOC_DATA_TYPE long
317 /* IOC_LDLM_TEST _IOWR('f', 40, long) */
318 /* IOC_LDLM_DUMP _IOWR('f', 41, long) */
319 /* IOC_LDLM_REGRESS_START _IOWR('f', 42, long) */
320 /* IOC_LDLM_REGRESS_STOP _IOWR('f', 43, long) */
322 #define OBD_IOC_CREATE _IOWR('f', 101, OBD_IOC_DATA_TYPE)
323 #define OBD_IOC_DESTROY _IOW ('f', 104, OBD_IOC_DATA_TYPE)
324 /* OBD_IOC_PREALLOCATE _IOWR('f', 105, OBD_IOC_DATA_TYPE) */
326 #define OBD_IOC_SETATTR _IOW ('f', 107, OBD_IOC_DATA_TYPE)
327 #define OBD_IOC_GETATTR _IOWR('f', 108, OBD_IOC_DATA_TYPE)
328 #define OBD_IOC_READ _IOWR('f', 109, OBD_IOC_DATA_TYPE)
329 #define OBD_IOC_WRITE _IOWR('f', 110, OBD_IOC_DATA_TYPE)
331 #define OBD_IOC_STATFS _IOWR('f', 113, OBD_IOC_DATA_TYPE)
332 #define OBD_IOC_SYNC _IOW ('f', 114, OBD_IOC_DATA_TYPE)
333 /* OBD_IOC_READ2 _IOWR('f', 115, OBD_IOC_DATA_TYPE) */
334 /* OBD_IOC_FORMAT _IOWR('f', 116, OBD_IOC_DATA_TYPE) */
335 /* OBD_IOC_PARTITION _IOWR('f', 117, OBD_IOC_DATA_TYPE) */
336 /* OBD_IOC_COPY _IOWR('f', 120, OBD_IOC_DATA_TYPE) */
337 /* OBD_IOC_MIGR _IOWR('f', 121, OBD_IOC_DATA_TYPE) */
338 /* OBD_IOC_PUNCH _IOWR('f', 122, OBD_IOC_DATA_TYPE) */
340 /* OBD_IOC_MODULE_DEBUG _IOWR('f', 124, OBD_IOC_DATA_TYPE) */
341 #define OBD_IOC_BRW_READ _IOWR('f', 125, OBD_IOC_DATA_TYPE)
342 #define OBD_IOC_BRW_WRITE _IOWR('f', 126, OBD_IOC_DATA_TYPE)
343 #define OBD_IOC_NAME2DEV _IOWR('f', 127, OBD_IOC_DATA_TYPE)
344 #define OBD_IOC_UUID2DEV _IOWR('f', 130, OBD_IOC_DATA_TYPE)
345 #define OBD_IOC_GETNAME _IOWR('f', 131, OBD_IOC_DATA_TYPE)
346 #define OBD_IOC_GETMDNAME _IOR ('f', 131, char[MAX_OBD_NAME])
347 #define OBD_IOC_GETDTNAME OBD_IOC_GETNAME
348 #define OBD_IOC_LOV_GET_CONFIG _IOWR('f', 132, OBD_IOC_DATA_TYPE)
349 #define OBD_IOC_CLIENT_RECOVER _IOW ('f', 133, OBD_IOC_DATA_TYPE)
350 #define OBD_IOC_PING_TARGET _IOW ('f', 136, OBD_IOC_DATA_TYPE)
352 /* OBD_IOC_DEC_FS_USE_COUNT _IO('f', 139) */
353 #define OBD_IOC_NO_TRANSNO _IOW ('f', 140, OBD_IOC_DATA_TYPE)
354 #define OBD_IOC_SET_READONLY _IOW ('f', 141, OBD_IOC_DATA_TYPE)
355 #define OBD_IOC_ABORT_RECOVERY _IOR ('f', 142, OBD_IOC_DATA_TYPE)
356 /* OBD_IOC_ROOT_SQUASH _IOWR('f', 143, OBD_IOC_DATA_TYPE) */
357 #define OBD_GET_VERSION _IOWR('f', 144, OBD_IOC_DATA_TYPE)
358 /* OBD_IOC_GSS_SUPPORT _IOWR('f', 145, OBD_IOC_DATA_TYPE) */
359 /* OBD_IOC_CLOSE_UUID _IOWR('f', 147, OBD_IOC_DATA_TYPE) */
360 #define OBD_IOC_CHANGELOG_SEND _IOW ('f', 148, OBD_IOC_DATA_TYPE)
361 #define OBD_IOC_GETDEVICE _IOWR('f', 149, OBD_IOC_DATA_TYPE)
362 #define OBD_IOC_FID2PATH _IOWR('f', 150, OBD_IOC_DATA_TYPE)
363 /* lustre/lustre_user.h 151-153 */
364 /* OBD_IOC_LOV_SETSTRIPE 154 LL_IOC_LOV_SETSTRIPE */
365 /* OBD_IOC_LOV_GETSTRIPE 155 LL_IOC_LOV_GETSTRIPE */
366 /* OBD_IOC_LOV_SETEA 156 LL_IOC_LOV_SETEA */
367 /* lustre/lustre_user.h 157-159 */
368 /* OBD_IOC_QUOTACHECK _IOW ('f', 160, int) */
369 /* OBD_IOC_POLL_QUOTACHECK _IOR ('f', 161, struct if_quotacheck *) */
370 #define OBD_IOC_QUOTACTL _IOWR('f', 162, struct if_quotactl)
371 /* lustre/lustre_user.h 163-176 */
372 #define OBD_IOC_CHANGELOG_REG _IOW ('f', 177, struct obd_ioctl_data)
373 #define OBD_IOC_CHANGELOG_DEREG _IOW ('f', 178, struct obd_ioctl_data)
374 #define OBD_IOC_CHANGELOG_CLEAR _IOW ('f', 179, struct obd_ioctl_data)
375 /* OBD_IOC_RECORD _IOWR('f', 180, OBD_IOC_DATA_TYPE) */
376 /* OBD_IOC_ENDRECORD _IOWR('f', 181, OBD_IOC_DATA_TYPE) */
377 /* OBD_IOC_PARSE _IOWR('f', 182, OBD_IOC_DATA_TYPE) */
378 /* OBD_IOC_DORECORD _IOWR('f', 183, OBD_IOC_DATA_TYPE) */
379 #define OBD_IOC_PROCESS_CFG _IOWR('f', 184, OBD_IOC_DATA_TYPE)
380 /* OBD_IOC_DUMP_LOG _IOWR('f', 185, OBD_IOC_DATA_TYPE) */
381 /* OBD_IOC_CLEAR_LOG _IOWR('f', 186, OBD_IOC_DATA_TYPE) */
382 #define OBD_IOC_PARAM _IOW ('f', 187, OBD_IOC_DATA_TYPE)
383 #define OBD_IOC_POOL _IOWR('f', 188, OBD_IOC_DATA_TYPE)
384 #define OBD_IOC_REPLACE_NIDS _IOWR('f', 189, OBD_IOC_DATA_TYPE)
386 #define OBD_IOC_CATLOGLIST _IOWR('f', 190, OBD_IOC_DATA_TYPE)
387 #define OBD_IOC_LLOG_INFO _IOWR('f', 191, OBD_IOC_DATA_TYPE)
388 #define OBD_IOC_LLOG_PRINT _IOWR('f', 192, OBD_IOC_DATA_TYPE)
389 #define OBD_IOC_LLOG_CANCEL _IOWR('f', 193, OBD_IOC_DATA_TYPE)
390 #define OBD_IOC_LLOG_REMOVE _IOWR('f', 194, OBD_IOC_DATA_TYPE)
391 #define OBD_IOC_LLOG_CHECK _IOWR('f', 195, OBD_IOC_DATA_TYPE)
392 /* OBD_IOC_LLOG_CATINFO _IOWR('f', 196, OBD_IOC_DATA_TYPE) */
393 #define OBD_IOC_NODEMAP _IOWR('f', 197, OBD_IOC_DATA_TYPE)
395 /* ECHO_IOC_GET_STRIPE _IOWR('f', 200, OBD_IOC_DATA_TYPE) */
396 /* ECHO_IOC_SET_STRIPE _IOWR('f', 201, OBD_IOC_DATA_TYPE) */
397 /* ECHO_IOC_ENQUEUE _IOWR('f', 202, OBD_IOC_DATA_TYPE) */
398 /* ECHO_IOC_CANCEL _IOWR('f', 203, OBD_IOC_DATA_TYPE) */
400 #define OBD_IOC_GET_OBJ_VERSION _IOR ('f', 210, OBD_IOC_DATA_TYPE)
402 /* lustre/lustre_user.h 212-217 */
403 #define OBD_IOC_GET_MNTOPT _IOW ('f', 220, mntopt_t)
404 #define OBD_IOC_ECHO_MD _IOR ('f', 221, struct obd_ioctl_data)
405 #define OBD_IOC_ECHO_ALLOC_SEQ _IOWR('f', 222, struct obd_ioctl_data)
406 #define OBD_IOC_START_LFSCK _IOWR('f', 230, OBD_IOC_DATA_TYPE)
407 #define OBD_IOC_STOP_LFSCK _IOW ('f', 231, OBD_IOC_DATA_TYPE)
408 #define OBD_IOC_QUERY_LFSCK _IOR('f', 232, struct obd_ioctl_data)
409 /* lustre/lustre_user.h 240-249 */
410 /* LIBCFS_IOC_DEBUG_MASK 250 */
412 #define IOC_OSC_SET_ACTIVE _IOWR('h', 21, void *)
414 #endif /* LUSTRE_IOCTL_H_ */