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, 2013, 2014, Intel Corporation.
28 #ifndef LUSTRE_IOCTL_H_
29 #define LUSTRE_IOCTL_H_
31 #include <libcfs/libcfs.h>
32 #include <lustre/lustre_idl.h>
35 # include <linux/ioctl.h>
36 # include <linux/string.h>
37 # include <obd_support.h>
38 #else /* __KERNEL__ */
41 #endif /* !__KERNEL__ */
43 #if !defined(__KERNEL__) && !defined(LUSTRE_UTILS)
44 # error This file is for Lustre internal use only.
48 ECHO_MD_CREATE = 1, /* Open/Create file on MDT */
49 ECHO_MD_MKDIR = 2, /* Mkdir on MDT */
50 ECHO_MD_DESTROY = 3, /* Unlink file on MDT */
51 ECHO_MD_RMDIR = 4, /* Rmdir on MDT */
52 ECHO_MD_LOOKUP = 5, /* Lookup on MDT */
53 ECHO_MD_GETATTR = 6, /* Getattr on MDT */
54 ECHO_MD_SETATTR = 7, /* Setattr on MDT */
55 ECHO_MD_ALLOC_FID = 8, /* Get FIDs from MDT */
58 #define OBD_IOCTL_VERSION 0x00010004
59 #define OBD_DEV_BY_DEVNAME 0xffffd0de
60 #define OBD_MAX_IOCTL_BUFFER CONFIG_LUSTRE_OBD_MAX_IOCTL_BUFFER
62 struct obd_ioctl_data {
79 struct obdo ioc_obdo1;
80 struct obdo ioc_obdo2;
91 /* buffers the kernel will treat as user pointers */
93 char __user *ioc_pbuf1;
95 char __user *ioc_pbuf2;
97 /* inline buffers for various arguments */
110 struct obd_ioctl_hdr {
115 static inline __u32 obd_ioctl_packlen(struct obd_ioctl_data *data)
117 __u32 len = cfs_size_round(sizeof(*data));
119 len += cfs_size_round(data->ioc_inllen1);
120 len += cfs_size_round(data->ioc_inllen2);
121 len += cfs_size_round(data->ioc_inllen3);
122 len += cfs_size_round(data->ioc_inllen4);
127 static inline int obd_ioctl_is_invalid(struct obd_ioctl_data *data)
129 if (data->ioc_len > (1 << 30)) {
130 CERROR("OBD ioctl: ioc_len larger than 1<<30\n");
134 if (data->ioc_inllen1 > (1 << 30)) {
135 CERROR("OBD ioctl: ioc_inllen1 larger than 1<<30\n");
139 if (data->ioc_inllen2 > (1 << 30)) {
140 CERROR("OBD ioctl: ioc_inllen2 larger than 1<<30\n");
144 if (data->ioc_inllen3 > (1 << 30)) {
145 CERROR("OBD ioctl: ioc_inllen3 larger than 1<<30\n");
149 if (data->ioc_inllen4 > (1 << 30)) {
150 CERROR("OBD ioctl: ioc_inllen4 larger than 1<<30\n");
154 if (data->ioc_inlbuf1 != NULL && data->ioc_inllen1 == 0) {
155 CERROR("OBD ioctl: inlbuf1 pointer but 0 length\n");
159 if (data->ioc_inlbuf2 != NULL && data->ioc_inllen2 == 0) {
160 CERROR("OBD ioctl: inlbuf2 pointer but 0 length\n");
164 if (data->ioc_inlbuf3 != NULL && data->ioc_inllen3 == 0) {
165 CERROR("OBD ioctl: inlbuf3 pointer but 0 length\n");
169 if (data->ioc_inlbuf4 != NULL && data->ioc_inllen4 == 0) {
170 CERROR("OBD ioctl: inlbuf4 pointer but 0 length\n");
174 if (data->ioc_pbuf1 != NULL && data->ioc_plen1 == 0) {
175 CERROR("OBD ioctl: pbuf1 pointer but 0 length\n");
179 if (data->ioc_pbuf2 != NULL && data->ioc_plen2 == 0) {
180 CERROR("OBD ioctl: pbuf2 pointer but 0 length\n");
184 if (data->ioc_pbuf1 == NULL && data->ioc_plen1 != 0) {
185 CERROR("OBD ioctl: plen1 set but NULL pointer\n");
189 if (data->ioc_pbuf2 == NULL && data->ioc_plen2 != 0) {
190 CERROR("OBD ioctl: plen2 set but NULL pointer\n");
194 if (obd_ioctl_packlen(data) > data->ioc_len) {
195 CERROR("OBD ioctl: packlen exceeds ioc_len (%d > %d)\n",
196 obd_ioctl_packlen(data), data->ioc_len);
205 int obd_ioctl_getdata(char **buf, int *len, void __user *arg);
206 int obd_ioctl_popdata(void __user *arg, void *data, int len);
208 static inline void obd_ioctl_freedata(char *buf, size_t len)
212 OBD_FREE_LARGE(buf, len);
216 #else /* __KERNEL__ */
218 static inline int obd_ioctl_pack(struct obd_ioctl_data *data, char **pbuf,
222 struct obd_ioctl_data *overlay;
224 data->ioc_len = obd_ioctl_packlen(data);
225 data->ioc_version = OBD_IOCTL_VERSION;
227 if (*pbuf != NULL && data->ioc_len > max_len) {
228 fprintf(stderr, "pbuf = %p, ioc_len = %u, max_len = %d\n",
229 *pbuf, data->ioc_len, max_len);
234 *pbuf = malloc(data->ioc_len);
239 overlay = (struct obd_ioctl_data *)*pbuf;
240 memcpy(*pbuf, data, sizeof(*data));
242 ptr = overlay->ioc_bulk;
243 if (data->ioc_inlbuf1 != NULL)
244 LOGL(data->ioc_inlbuf1, data->ioc_inllen1, ptr);
246 if (data->ioc_inlbuf2 != NULL)
247 LOGL(data->ioc_inlbuf2, data->ioc_inllen2, ptr);
249 if (data->ioc_inlbuf3 != NULL)
250 LOGL(data->ioc_inlbuf3, data->ioc_inllen3, ptr);
252 if (data->ioc_inlbuf4 != NULL)
253 LOGL(data->ioc_inlbuf4, data->ioc_inllen4, ptr);
255 if (obd_ioctl_is_invalid(overlay)) {
256 fprintf(stderr, "invalid ioctl data: ioc_len = %u, "
258 data->ioc_len, max_len);
266 obd_ioctl_unpack(struct obd_ioctl_data *data, char *pbuf, int max_len)
269 struct obd_ioctl_data *overlay;
274 overlay = (struct obd_ioctl_data *)pbuf;
276 /* Preserve the caller's buffer pointers */
277 overlay->ioc_inlbuf1 = data->ioc_inlbuf1;
278 overlay->ioc_inlbuf2 = data->ioc_inlbuf2;
279 overlay->ioc_inlbuf3 = data->ioc_inlbuf3;
280 overlay->ioc_inlbuf4 = data->ioc_inlbuf4;
282 memcpy(data, pbuf, sizeof(*data));
284 ptr = overlay->ioc_bulk;
285 if (data->ioc_inlbuf1 != NULL)
286 LOGU(data->ioc_inlbuf1, data->ioc_inllen1, ptr);
288 if (data->ioc_inlbuf2 != NULL)
289 LOGU(data->ioc_inlbuf2, data->ioc_inllen2, ptr);
291 if (data->ioc_inlbuf3 != NULL)
292 LOGU(data->ioc_inlbuf3, data->ioc_inllen3, ptr);
294 if (data->ioc_inlbuf4 != NULL)
295 LOGU(data->ioc_inlbuf4, data->ioc_inllen4, ptr);
300 #endif /* !__KERNEL__ */
302 /* OBD_IOC_DATA_TYPE is only for compatibility reasons with older
303 * Linux Lustre user tools. New ioctls should NOT use this macro as
304 * the ioctl "size". Instead the ioctl should get a "size" argument
305 * which is the actual data type used by the ioctl, to ensure the
306 * ioctl interface is versioned correctly. */
307 #define OBD_IOC_DATA_TYPE long
309 /* IOC_LDLM_TEST _IOWR('f', 40, long) */
310 /* IOC_LDLM_DUMP _IOWR('f', 41, long) */
311 /* IOC_LDLM_REGRESS_START _IOWR('f', 42, long) */
312 /* IOC_LDLM_REGRESS_STOP _IOWR('f', 43, long) */
314 #define OBD_IOC_CREATE _IOWR('f', 101, OBD_IOC_DATA_TYPE)
315 #define OBD_IOC_DESTROY _IOW ('f', 104, OBD_IOC_DATA_TYPE)
316 /* OBD_IOC_PREALLOCATE _IOWR('f', 105, OBD_IOC_DATA_TYPE) */
318 #define OBD_IOC_SETATTR _IOW ('f', 107, OBD_IOC_DATA_TYPE)
319 #define OBD_IOC_GETATTR _IOWR('f', 108, OBD_IOC_DATA_TYPE)
320 #define OBD_IOC_READ _IOWR('f', 109, OBD_IOC_DATA_TYPE)
321 #define OBD_IOC_WRITE _IOWR('f', 110, OBD_IOC_DATA_TYPE)
323 #define OBD_IOC_STATFS _IOWR('f', 113, OBD_IOC_DATA_TYPE)
324 #define OBD_IOC_SYNC _IOW ('f', 114, OBD_IOC_DATA_TYPE)
325 /* OBD_IOC_READ2 _IOWR('f', 115, OBD_IOC_DATA_TYPE) */
326 /* OBD_IOC_FORMAT _IOWR('f', 116, OBD_IOC_DATA_TYPE) */
327 /* OBD_IOC_PARTITION _IOWR('f', 117, OBD_IOC_DATA_TYPE) */
328 /* OBD_IOC_COPY _IOWR('f', 120, OBD_IOC_DATA_TYPE) */
329 /* OBD_IOC_MIGR _IOWR('f', 121, OBD_IOC_DATA_TYPE) */
330 /* OBD_IOC_PUNCH _IOWR('f', 122, OBD_IOC_DATA_TYPE) */
332 /* OBD_IOC_MODULE_DEBUG _IOWR('f', 124, OBD_IOC_DATA_TYPE) */
333 #define OBD_IOC_BRW_READ _IOWR('f', 125, OBD_IOC_DATA_TYPE)
334 #define OBD_IOC_BRW_WRITE _IOWR('f', 126, OBD_IOC_DATA_TYPE)
335 #define OBD_IOC_NAME2DEV _IOWR('f', 127, OBD_IOC_DATA_TYPE)
336 #define OBD_IOC_UUID2DEV _IOWR('f', 130, OBD_IOC_DATA_TYPE)
337 #define OBD_IOC_GETNAME _IOWR('f', 131, OBD_IOC_DATA_TYPE)
338 #define OBD_IOC_GETMDNAME _IOR ('f', 131, char[MAX_OBD_NAME])
339 #define OBD_IOC_GETDTNAME OBD_IOC_GETNAME
340 #define OBD_IOC_LOV_GET_CONFIG _IOWR('f', 132, OBD_IOC_DATA_TYPE)
341 #define OBD_IOC_CLIENT_RECOVER _IOW ('f', 133, OBD_IOC_DATA_TYPE)
342 #define OBD_IOC_PING_TARGET _IOW ('f', 136, OBD_IOC_DATA_TYPE)
344 /* OBD_IOC_DEC_FS_USE_COUNT _IO('f', 139) */
345 #define OBD_IOC_NO_TRANSNO _IOW ('f', 140, OBD_IOC_DATA_TYPE)
346 #define OBD_IOC_SET_READONLY _IOW ('f', 141, OBD_IOC_DATA_TYPE)
347 #define OBD_IOC_ABORT_RECOVERY _IOR ('f', 142, OBD_IOC_DATA_TYPE)
348 /* OBD_IOC_ROOT_SQUASH _IOWR('f', 143, OBD_IOC_DATA_TYPE) */
349 #define OBD_GET_VERSION _IOWR('f', 144, OBD_IOC_DATA_TYPE)
350 /* OBD_IOC_GSS_SUPPORT _IOWR('f', 145, OBD_IOC_DATA_TYPE) */
351 /* OBD_IOC_CLOSE_UUID _IOWR('f', 147, OBD_IOC_DATA_TYPE) */
352 #define OBD_IOC_CHANGELOG_SEND _IOW ('f', 148, OBD_IOC_DATA_TYPE)
353 #define OBD_IOC_GETDEVICE _IOWR('f', 149, OBD_IOC_DATA_TYPE)
354 #define OBD_IOC_FID2PATH _IOWR('f', 150, OBD_IOC_DATA_TYPE)
355 /* lustre/lustre_user.h 151-153 */
356 /* OBD_IOC_LOV_SETSTRIPE 154 LL_IOC_LOV_SETSTRIPE */
357 /* OBD_IOC_LOV_GETSTRIPE 155 LL_IOC_LOV_GETSTRIPE */
358 /* OBD_IOC_LOV_SETEA 156 LL_IOC_LOV_SETEA */
359 /* lustre/lustre_user.h 157-159 */
360 /* OBD_IOC_QUOTACHECK _IOW ('f', 160, int) */
361 /* OBD_IOC_POLL_QUOTACHECK _IOR ('f', 161, struct if_quotacheck *) */
362 #define OBD_IOC_QUOTACTL _IOWR('f', 162, struct if_quotactl)
363 /* lustre/lustre_user.h 163-176 */
364 #define OBD_IOC_CHANGELOG_REG _IOW ('f', 177, struct obd_ioctl_data)
365 #define OBD_IOC_CHANGELOG_DEREG _IOW ('f', 178, struct obd_ioctl_data)
366 #define OBD_IOC_CHANGELOG_CLEAR _IOW ('f', 179, struct obd_ioctl_data)
367 /* OBD_IOC_RECORD _IOWR('f', 180, OBD_IOC_DATA_TYPE) */
368 /* OBD_IOC_ENDRECORD _IOWR('f', 181, OBD_IOC_DATA_TYPE) */
369 /* OBD_IOC_PARSE _IOWR('f', 182, OBD_IOC_DATA_TYPE) */
370 /* OBD_IOC_DORECORD _IOWR('f', 183, OBD_IOC_DATA_TYPE) */
371 #define OBD_IOC_PROCESS_CFG _IOWR('f', 184, OBD_IOC_DATA_TYPE)
372 #define OBD_IOC_DUMP_LOG _IOWR('f', 185, OBD_IOC_DATA_TYPE)
373 /* OBD_IOC_CLEAR_LOG _IOWR('f', 186, OBD_IOC_DATA_TYPE) */
374 #define OBD_IOC_PARAM _IOW ('f', 187, OBD_IOC_DATA_TYPE)
375 #define OBD_IOC_POOL _IOWR('f', 188, OBD_IOC_DATA_TYPE)
376 #define OBD_IOC_REPLACE_NIDS _IOWR('f', 189, OBD_IOC_DATA_TYPE)
378 #define OBD_IOC_CATLOGLIST _IOWR('f', 190, OBD_IOC_DATA_TYPE)
379 #define OBD_IOC_LLOG_INFO _IOWR('f', 191, OBD_IOC_DATA_TYPE)
380 #define OBD_IOC_LLOG_PRINT _IOWR('f', 192, OBD_IOC_DATA_TYPE)
381 #define OBD_IOC_LLOG_CANCEL _IOWR('f', 193, OBD_IOC_DATA_TYPE)
382 #define OBD_IOC_LLOG_REMOVE _IOWR('f', 194, OBD_IOC_DATA_TYPE)
383 #define OBD_IOC_LLOG_CHECK _IOWR('f', 195, OBD_IOC_DATA_TYPE)
384 /* OBD_IOC_LLOG_CATINFO _IOWR('f', 196, OBD_IOC_DATA_TYPE) */
385 #define OBD_IOC_NODEMAP _IOWR('f', 197, OBD_IOC_DATA_TYPE)
387 /* ECHO_IOC_GET_STRIPE _IOWR('f', 200, OBD_IOC_DATA_TYPE) */
388 /* ECHO_IOC_SET_STRIPE _IOWR('f', 201, OBD_IOC_DATA_TYPE) */
389 /* ECHO_IOC_ENQUEUE _IOWR('f', 202, OBD_IOC_DATA_TYPE) */
390 /* ECHO_IOC_CANCEL _IOWR('f', 203, OBD_IOC_DATA_TYPE) */
392 #define OBD_IOC_GET_OBJ_VERSION _IOR ('f', 210, OBD_IOC_DATA_TYPE)
394 /* lustre/lustre_user.h 212-217 */
395 #define OBD_IOC_GET_MNTOPT _IOW ('f', 220, mntopt_t)
396 #define OBD_IOC_ECHO_MD _IOR ('f', 221, struct obd_ioctl_data)
397 #define OBD_IOC_ECHO_ALLOC_SEQ _IOWR('f', 222, struct obd_ioctl_data)
398 #define OBD_IOC_START_LFSCK _IOWR('f', 230, OBD_IOC_DATA_TYPE)
399 #define OBD_IOC_STOP_LFSCK _IOW ('f', 231, OBD_IOC_DATA_TYPE)
400 /* lustre/lustre_user.h 240-246 */
401 /* LIBCFS_IOC_DEBUG_MASK 250 */
403 #define IOC_OSC_SET_ACTIVE _IOWR('h', 21, void *)
405 #endif /* LUSTRE_IOCTL_H_ */