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.sun.com/software/products/lustre/docs/GPLv2.pdf
20 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21 * CA 95054 USA or visit www.sun.com if you need additional information or
27 * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
30 * Copyright (c) 2013, 2014, Intel Corporation.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
36 * libcfs/include/libcfs/libcfs_ioctl.h
38 * Low-level ioctl data structures. Kernel ioctl functions declared here,
39 * and user space functions are in libcfsutil_ioctl.h.
43 #ifndef __LIBCFS_IOCTL_H__
44 #define __LIBCFS_IOCTL_H__
46 #define LIBCFS_IOCTL_VERSION 0x0001000a
47 #define LIBCFS_IOCTL_VERSION2 0x0001000b
49 struct libcfs_ioctl_hdr {
54 /** max size to copy from userspace */
55 #define LIBCFS_IOC_DATA_MAX (128 * 1024)
57 struct libcfs_ioctl_data {
58 struct libcfs_ioctl_hdr ioc_hdr;
73 __u32 ioc_plen1; /* buffers in userspace */
74 char __user *ioc_pbuf1;
75 __u32 ioc_plen2; /* buffers in userspace */
76 char __user *ioc_pbuf2;
81 #define ioc_priority ioc_u32[0]
83 struct libcfs_debug_ioctl_data
85 struct libcfs_ioctl_hdr hdr;
90 #define LIBCFS_IOC_INIT(data) \
92 memset(&data, 0, sizeof(data)); \
93 data.ioc_hdr.ioc_version = LIBCFS_IOCTL_VERSION; \
94 data.ioc_hdr.ioc_len = sizeof(data); \
97 #define LIBCFS_IOC_INIT_V2(data, hdr) \
99 memset(&(data), 0, sizeof(data)); \
100 (data).hdr.ioc_version = LIBCFS_IOCTL_VERSION2; \
101 (data).hdr.ioc_len = sizeof(data); \
107 struct libcfs_ioctl_handler {
108 struct list_head item;
109 int (*handle_ioctl)(unsigned int cmd, struct libcfs_ioctl_hdr *hdr);
112 #define DECLARE_IOCTL_HANDLER(ident, func) \
113 struct libcfs_ioctl_handler ident = { \
114 /* .item = */ LIST_HEAD_INIT(ident.item), \
115 /* .handle_ioctl = */ func \
120 /* 'f' ioctls are defined in lustre_ioctl.h and lustre_user.h except for: */
121 #define LIBCFS_IOC_DEBUG_MASK _IOWR('f', 250, long)
122 #define IOCTL_LIBCFS_TYPE long
124 /* ioctls for manipulating snapshots 30- */
125 #define IOC_LIBCFS_TYPE ('e')
126 #define IOC_LIBCFS_MIN_NR 30
128 #define IOC_LIBCFS_PANIC _IOWR('e', 30, IOCTL_LIBCFS_TYPE)
129 #define IOC_LIBCFS_CLEAR_DEBUG _IOWR('e', 31, IOCTL_LIBCFS_TYPE)
130 #define IOC_LIBCFS_MARK_DEBUG _IOWR('e', 32, IOCTL_LIBCFS_TYPE)
131 #define IOC_LIBCFS_MEMHOG _IOWR('e', 36, IOCTL_LIBCFS_TYPE)
133 #define IOC_LIBCFS_GET_NI _IOWR('e', 50, IOCTL_LIBCFS_TYPE)
134 #define IOC_LIBCFS_FAIL_NID _IOWR('e', 51, IOCTL_LIBCFS_TYPE)
135 #define IOC_LIBCFS_NOTIFY_ROUTER _IOWR('e', 55, IOCTL_LIBCFS_TYPE)
136 #define IOC_LIBCFS_UNCONFIGURE _IOWR('e', 56, IOCTL_LIBCFS_TYPE)
137 #define IOC_LIBCFS_PORTALS_COMPATIBILITY _IOWR('e', 57, IOCTL_LIBCFS_TYPE)
138 #define IOC_LIBCFS_LNET_DIST _IOWR('e', 58, IOCTL_LIBCFS_TYPE)
139 #define IOC_LIBCFS_CONFIGURE _IOWR('e', 59, IOCTL_LIBCFS_TYPE)
140 #define IOC_LIBCFS_TESTPROTOCOMPAT _IOWR('e', 60, IOCTL_LIBCFS_TYPE)
141 #define IOC_LIBCFS_PING _IOWR('e', 61, IOCTL_LIBCFS_TYPE)
142 #define IOC_LIBCFS_DEBUG_PEER _IOWR('e', 62, IOCTL_LIBCFS_TYPE)
143 #define IOC_LIBCFS_LNETST _IOWR('e', 63, IOCTL_LIBCFS_TYPE)
144 #define IOC_LIBCFS_LNET_FAULT _IOWR('e', 64, IOCTL_LIBCFS_TYPE)
146 #define IOC_LIBCFS_REGISTER_MYNID _IOWR('e', 70, IOCTL_LIBCFS_TYPE)
147 #define IOC_LIBCFS_CLOSE_CONNECTION _IOWR('e', 71, IOCTL_LIBCFS_TYPE)
148 #define IOC_LIBCFS_PUSH_CONNECTION _IOWR('e', 72, IOCTL_LIBCFS_TYPE)
149 #define IOC_LIBCFS_GET_CONN _IOWR('e', 73, IOCTL_LIBCFS_TYPE)
150 #define IOC_LIBCFS_DEL_PEER _IOWR('e', 74, IOCTL_LIBCFS_TYPE)
151 #define IOC_LIBCFS_ADD_PEER _IOWR('e', 75, IOCTL_LIBCFS_TYPE)
152 #define IOC_LIBCFS_GET_PEER _IOWR('e', 76, IOCTL_LIBCFS_TYPE)
153 #define IOC_LIBCFS_GET_TXDESC _IOWR('e', 77, IOCTL_LIBCFS_TYPE)
154 #define IOC_LIBCFS_ADD_INTERFACE _IOWR('e', 78, IOCTL_LIBCFS_TYPE)
155 #define IOC_LIBCFS_DEL_INTERFACE _IOWR('e', 79, IOCTL_LIBCFS_TYPE)
156 #define IOC_LIBCFS_GET_INTERFACE _IOWR('e', 80, IOCTL_LIBCFS_TYPE)
160 * DLC Speicif IOCTL numbers.
161 * In order to maintain backward compatibility with any possible external
162 * tools which might be accessing the IOCTL numbers, a new group of IOCTL
163 * number have been allocated.
165 #define IOCTL_CONFIG_SIZE struct lnet_ioctl_config_data
166 #define IOC_LIBCFS_ADD_ROUTE _IOWR(IOC_LIBCFS_TYPE, 81, \
168 #define IOC_LIBCFS_DEL_ROUTE _IOWR(IOC_LIBCFS_TYPE, 82, \
170 #define IOC_LIBCFS_GET_ROUTE _IOWR(IOC_LIBCFS_TYPE, 83, \
172 #define IOC_LIBCFS_ADD_NET _IOWR(IOC_LIBCFS_TYPE, 84, \
174 #define IOC_LIBCFS_DEL_NET _IOWR(IOC_LIBCFS_TYPE, 85, \
176 #define IOC_LIBCFS_GET_NET _IOWR(IOC_LIBCFS_TYPE, 86, \
178 #define IOC_LIBCFS_CONFIG_RTR _IOWR(IOC_LIBCFS_TYPE, 87, \
180 #define IOC_LIBCFS_ADD_BUF _IOWR(IOC_LIBCFS_TYPE, 88, \
182 #define IOC_LIBCFS_GET_BUF _IOWR(IOC_LIBCFS_TYPE, 89, \
184 #define IOC_LIBCFS_GET_PEER_INFO _IOWR(IOC_LIBCFS_TYPE, 90, \
186 #define IOC_LIBCFS_GET_LNET_STATS _IOWR(IOC_LIBCFS_TYPE, 91, \
188 #define IOC_LIBCFS_MAX_NR 91
190 static inline int libcfs_ioctl_packlen(struct libcfs_ioctl_data *data)
192 int len = sizeof(*data);
193 len += cfs_size_round(data->ioc_inllen1);
194 len += cfs_size_round(data->ioc_inllen2);
198 static inline bool libcfs_ioctl_is_invalid(struct libcfs_ioctl_data *data)
200 if (data->ioc_hdr.ioc_len > (1<<30)) {
201 CERROR("LIBCFS ioctl: ioc_len larger than 1<<30\n");
204 if (data->ioc_inllen1 > (1<<30)) {
205 CERROR("LIBCFS ioctl: ioc_inllen1 larger than 1<<30\n");
208 if (data->ioc_inllen2 > (1<<30)) {
209 CERROR("LIBCFS ioctl: ioc_inllen2 larger than 1<<30\n");
212 if (data->ioc_inlbuf1 && data->ioc_inllen1 == 0) {
213 CERROR("LIBCFS ioctl: inlbuf1 pointer but 0 length\n");
216 if (data->ioc_inlbuf2 && data->ioc_inllen2 == 0) {
217 CERROR("LIBCFS ioctl: inlbuf2 pointer but 0 length\n");
220 if (data->ioc_pbuf1 && data->ioc_plen1 == 0) {
221 CERROR("LIBCFS ioctl: pbuf1 pointer but 0 length\n");
224 if (data->ioc_pbuf2 && data->ioc_plen2 == 0) {
225 CERROR("LIBCFS ioctl: pbuf2 pointer but 0 length\n");
228 if (data->ioc_plen1 && data->ioc_pbuf1 == 0) {
229 CERROR("LIBCFS ioctl: plen1 nonzero but no pbuf1 pointer\n");
232 if (data->ioc_plen2 && data->ioc_pbuf2 == 0) {
233 CERROR("LIBCFS ioctl: plen2 nonzero but no pbuf2 pointer\n");
236 if ((__u32)libcfs_ioctl_packlen(data) != data->ioc_hdr.ioc_len) {
237 CERROR("LIBCFS ioctl: packlen != ioc_len\n");
240 if (data->ioc_inllen1 &&
241 data->ioc_bulk[data->ioc_inllen1 - 1] != '\0') {
242 CERROR("LIBCFS ioctl: inlbuf1 not 0 terminated\n");
245 if (data->ioc_inllen2 &&
246 data->ioc_bulk[cfs_size_round(data->ioc_inllen1) +
247 data->ioc_inllen2 - 1] != '\0') {
248 CERROR("LIBCFS ioctl: inlbuf2 not 0 terminated\n");
256 extern int libcfs_register_ioctl(struct libcfs_ioctl_handler *hand);
257 extern int libcfs_deregister_ioctl(struct libcfs_ioctl_handler *hand);
258 extern int libcfs_ioctl_getdata(struct libcfs_ioctl_hdr **hdr_pp,
259 struct libcfs_ioctl_hdr __user *uparam);
261 static inline int libcfs_ioctl_popdata(struct libcfs_ioctl_hdr *hdr,
262 struct libcfs_ioctl_hdr __user *uparam)
264 if (copy_to_user(uparam, hdr, hdr->ioc_len))
269 static inline void libcfs_ioctl_freedata(struct libcfs_ioctl_hdr *hdr)
271 LIBCFS_FREE(hdr, hdr->ioc_len);
276 extern int libcfs_ioctl_data_adjust(struct libcfs_ioctl_data *data);
278 #endif /* __LIBCFS_IOCTL_H__ */