Whamcloud - gitweb
1ed8766896e03db7b165dfba4edbcf19129c66c4
[fs/lustre-release.git] / libcfs / include / libcfs / libcfs_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.sun.com/software/products/lustre/docs/GPLv2.pdf
19  *
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
22  * have any questions.
23  *
24  * GPL HEADER END
25  */
26 /*
27  * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
28  * Use is subject to license terms.
29  *
30  * Copyright (c) 2013, 2014, Intel Corporation.
31  */
32 /*
33  * This file is part of Lustre, http://www.lustre.org/
34  * Lustre is a trademark of Sun Microsystems, Inc.
35  *
36  * libcfs/include/libcfs/libcfs_ioctl.h
37  *
38  * Low-level ioctl data structures. Kernel ioctl functions declared here,
39  * and user space functions are in libcfs/util/ioctl.h.
40  *
41  */
42
43 #ifndef __LIBCFS_IOCTL_H__
44 #define __LIBCFS_IOCTL_H__
45
46 #define LIBCFS_IOCTL_VERSION 0x0001000a
47 #define LIBCFS_IOCTL_VERSION2 0x0001000b
48
49 struct libcfs_ioctl_hdr {
50         __u32 ioc_len;
51         __u32 ioc_version;
52 };
53
54 /** max size to copy from userspace */
55 #define LIBCFS_IOC_DATA_MAX     (128 * 1024)
56
57 struct libcfs_ioctl_data {
58         struct libcfs_ioctl_hdr ioc_hdr;
59
60         __u64 ioc_nid;
61         __u64 ioc_u64[1];
62
63         __u32 ioc_flags;
64         __u32 ioc_count;
65         __u32 ioc_net;
66         __u32 ioc_u32[7];
67
68         __u32 ioc_inllen1;
69         char *ioc_inlbuf1;
70         __u32 ioc_inllen2;
71         char *ioc_inlbuf2;
72
73         __u32 ioc_plen1; /* buffers in userspace */
74         char __user *ioc_pbuf1;
75         __u32 ioc_plen2; /* buffers in userspace */
76         char __user *ioc_pbuf2;
77
78         char ioc_bulk[0];
79 };
80
81 #define ioc_priority ioc_u32[0]
82
83 struct libcfs_debug_ioctl_data
84 {
85         struct libcfs_ioctl_hdr hdr;
86         unsigned int subs;
87         unsigned int debug;
88 };
89
90 #define LIBCFS_IOC_INIT(data)                           \
91 do {                                                    \
92         memset(&data, 0, sizeof(data));                 \
93         data.ioc_hdr.ioc_version = LIBCFS_IOCTL_VERSION;        \
94         data.ioc_hdr.ioc_len = sizeof(data);            \
95 } while (0)
96
97 #define LIBCFS_IOC_INIT_V2(data, hdr)                   \
98 do {                                                    \
99         memset(&(data), 0, sizeof(data));                       \
100         (data).hdr.ioc_version = LIBCFS_IOCTL_VERSION2; \
101         (data).hdr.ioc_len = sizeof(data);              \
102 } while (0)
103
104 /* 'f' ioctls are defined in lustre_ioctl.h and lustre_user.h except for: */
105 #define LIBCFS_IOC_DEBUG_MASK             _IOWR('f', 250, long)
106 #define IOCTL_LIBCFS_TYPE                 long
107
108 /* ioctls for manipulating snapshots 30- */
109 #define IOC_LIBCFS_TYPE                               ('e')
110 #define IOC_LIBCFS_MIN_NR                             30
111 /* libcfs ioctls */
112 #define IOC_LIBCFS_PANIC                   _IOWR('e', 30, IOCTL_LIBCFS_TYPE)
113 #define IOC_LIBCFS_CLEAR_DEBUG             _IOWR('e', 31, IOCTL_LIBCFS_TYPE)
114 #define IOC_LIBCFS_MARK_DEBUG              _IOWR('e', 32, IOCTL_LIBCFS_TYPE)
115 #define IOC_LIBCFS_MEMHOG                  _IOWR('e', 36, IOCTL_LIBCFS_TYPE)
116 /* lnet ioctls */
117 #define IOC_LIBCFS_GET_NI                  _IOWR('e', 50, IOCTL_LIBCFS_TYPE)
118 #define IOC_LIBCFS_FAIL_NID                _IOWR('e', 51, IOCTL_LIBCFS_TYPE)
119 #define IOC_LIBCFS_NOTIFY_ROUTER           _IOWR('e', 55, IOCTL_LIBCFS_TYPE)
120 #define IOC_LIBCFS_UNCONFIGURE             _IOWR('e', 56, IOCTL_LIBCFS_TYPE)
121 #define IOC_LIBCFS_PORTALS_COMPATIBILITY   _IOWR('e', 57, IOCTL_LIBCFS_TYPE)
122 #define IOC_LIBCFS_LNET_DIST               _IOWR('e', 58, IOCTL_LIBCFS_TYPE)
123 #define IOC_LIBCFS_CONFIGURE               _IOWR('e', 59, IOCTL_LIBCFS_TYPE)
124 #define IOC_LIBCFS_TESTPROTOCOMPAT         _IOWR('e', 60, IOCTL_LIBCFS_TYPE)
125 #define IOC_LIBCFS_PING                    _IOWR('e', 61, IOCTL_LIBCFS_TYPE)
126 #define IOC_LIBCFS_DEBUG_PEER              _IOWR('e', 62, IOCTL_LIBCFS_TYPE)
127 #define IOC_LIBCFS_LNETST                  _IOWR('e', 63, IOCTL_LIBCFS_TYPE)
128 #define IOC_LIBCFS_LNET_FAULT              _IOWR('e', 64, IOCTL_LIBCFS_TYPE)
129 /* lnd ioctls */
130 #define IOC_LIBCFS_REGISTER_MYNID          _IOWR('e', 70, IOCTL_LIBCFS_TYPE)
131 #define IOC_LIBCFS_CLOSE_CONNECTION        _IOWR('e', 71, IOCTL_LIBCFS_TYPE)
132 #define IOC_LIBCFS_PUSH_CONNECTION         _IOWR('e', 72, IOCTL_LIBCFS_TYPE)
133 #define IOC_LIBCFS_GET_CONN                _IOWR('e', 73, IOCTL_LIBCFS_TYPE)
134 #define IOC_LIBCFS_DEL_PEER                _IOWR('e', 74, IOCTL_LIBCFS_TYPE)
135 #define IOC_LIBCFS_ADD_PEER                _IOWR('e', 75, IOCTL_LIBCFS_TYPE)
136 #define IOC_LIBCFS_GET_PEER                _IOWR('e', 76, IOCTL_LIBCFS_TYPE)
137 /* ioctl 77 is free for use */
138 #define IOC_LIBCFS_ADD_INTERFACE           _IOWR('e', 78, IOCTL_LIBCFS_TYPE)
139 #define IOC_LIBCFS_DEL_INTERFACE           _IOWR('e', 79, IOCTL_LIBCFS_TYPE)
140 #define IOC_LIBCFS_GET_INTERFACE           _IOWR('e', 80, IOCTL_LIBCFS_TYPE)
141
142
143 /*
144  * DLC Specific IOCTL numbers.
145  * In order to maintain backward compatibility with any possible external
146  * tools which might be accessing the IOCTL numbers, a new group of IOCTL
147  * number have been allocated.
148  */
149 #define IOCTL_CONFIG_SIZE                  struct lnet_ioctl_config_data
150 #define IOC_LIBCFS_ADD_ROUTE               _IOWR(IOC_LIBCFS_TYPE, 81, \
151                                                  IOCTL_CONFIG_SIZE)
152 #define IOC_LIBCFS_DEL_ROUTE               _IOWR(IOC_LIBCFS_TYPE, 82, \
153                                                  IOCTL_CONFIG_SIZE)
154 #define IOC_LIBCFS_GET_ROUTE               _IOWR(IOC_LIBCFS_TYPE, 83, \
155                                                  IOCTL_CONFIG_SIZE)
156 #define IOC_LIBCFS_ADD_NET                 _IOWR(IOC_LIBCFS_TYPE, 84, \
157                                                  IOCTL_CONFIG_SIZE)
158 #define IOC_LIBCFS_DEL_NET                 _IOWR(IOC_LIBCFS_TYPE, 85, \
159                                                  IOCTL_CONFIG_SIZE)
160 #define IOC_LIBCFS_GET_NET                 _IOWR(IOC_LIBCFS_TYPE, 86, \
161                                                  IOCTL_CONFIG_SIZE)
162 #define IOC_LIBCFS_CONFIG_RTR              _IOWR(IOC_LIBCFS_TYPE, 87, \
163                                                  IOCTL_CONFIG_SIZE)
164 #define IOC_LIBCFS_ADD_BUF                 _IOWR(IOC_LIBCFS_TYPE, 88, \
165                                                  IOCTL_CONFIG_SIZE)
166 #define IOC_LIBCFS_GET_BUF                 _IOWR(IOC_LIBCFS_TYPE, 89, \
167                                                  IOCTL_CONFIG_SIZE)
168 #define IOC_LIBCFS_GET_PEER_INFO           _IOWR(IOC_LIBCFS_TYPE, 90, \
169                                                  IOCTL_CONFIG_SIZE)
170 #define IOC_LIBCFS_GET_LNET_STATS          _IOWR(IOC_LIBCFS_TYPE, 91, \
171                                                  IOCTL_CONFIG_SIZE)
172 #define IOC_LIBCFS_MAX_NR                             91
173
174 static inline int libcfs_ioctl_packlen(struct libcfs_ioctl_data *data)
175 {
176         int len = sizeof(*data);
177         len += (data->ioc_inllen1 + 7) & ~7;
178         len += (data->ioc_inllen2 + 7) & ~7;
179         return len;
180 }
181
182 static inline bool libcfs_ioctl_is_invalid(struct libcfs_ioctl_data *data)
183 {
184         if (data->ioc_hdr.ioc_len > (1<<30))
185                 return 1;
186
187         if (data->ioc_inllen1 > (1<<30))
188                 return 1;
189
190         if (data->ioc_inllen2 > (1<<30))
191                 return 1;
192
193         if (data->ioc_inlbuf1 && data->ioc_inllen1 == 0)
194                 return 1;
195
196         if (data->ioc_inlbuf2 && data->ioc_inllen2 == 0)
197                 return 1;
198
199         if (data->ioc_pbuf1 && data->ioc_plen1 == 0)
200                 return 1;
201
202         if (data->ioc_pbuf2 && data->ioc_plen2 == 0)
203                 return 1;
204
205         if (data->ioc_plen1 && data->ioc_pbuf1 == NULL)
206                 return 1;
207
208         if (data->ioc_plen2 && data->ioc_pbuf2 == NULL)
209                 return 1;
210
211         if ((__u32)libcfs_ioctl_packlen(data) != data->ioc_hdr.ioc_len)
212                 return 1;
213
214         if (data->ioc_inllen1 &&
215             data->ioc_bulk[data->ioc_inllen1 - 1] != '\0')
216                 return 1;
217
218         if (data->ioc_inllen2 &&
219             data->ioc_bulk[((data->ioc_inllen1 + 7) & ~7) +
220                            data->ioc_inllen2 - 1] != '\0')
221                 return 1;
222
223         return 0;
224 }
225
226 extern int libcfs_ioctl_data_adjust(struct libcfs_ioctl_data *data);
227
228 #endif /* __LIBCFS_IOCTL_H__ */