Whamcloud - gitweb
LU-5577 libcfs: fix warnings in libcfs/curproc.h
[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 /*
31  * This file is part of Lustre, http://www.lustre.org/
32  * Lustre is a trademark of Sun Microsystems, Inc.
33  *
34  * libcfs/include/libcfs/libcfs_ioctl.h
35  *
36  * Low-level ioctl data structures. Kernel ioctl functions declared here,
37  * and user space functions are in libcfsutil_ioctl.h.
38  *
39  */
40
41 #ifndef __LIBCFS_IOCTL_H__
42 #define __LIBCFS_IOCTL_H__
43
44 #define LIBCFS_IOCTL_VERSION 0x0001000a
45 #define LIBCFS_IOCTL_VERSION2 0x0001000b
46
47 struct libcfs_ioctl_hdr {
48         __u32 ioc_len;
49         __u32 ioc_version;
50 };
51
52 /** max size to copy from userspace */
53 #define LIBCFS_IOC_DATA_MAX     (128 * 1024)
54
55 struct libcfs_ioctl_data {
56         struct libcfs_ioctl_hdr ioc_hdr;
57
58         __u64 ioc_nid;
59         __u64 ioc_u64[1];
60
61         __u32 ioc_flags;
62         __u32 ioc_count;
63         __u32 ioc_net;
64         __u32 ioc_u32[7];
65
66         __u32 ioc_inllen1;
67         char *ioc_inlbuf1;
68         __u32 ioc_inllen2;
69         char *ioc_inlbuf2;
70
71         __u32 ioc_plen1; /* buffers in userspace */
72         char __user *ioc_pbuf1;
73         __u32 ioc_plen2; /* buffers in userspace */
74         char __user *ioc_pbuf2;
75
76         char ioc_bulk[0];
77 };
78
79 #define ioc_priority ioc_u32[0]
80
81 struct libcfs_debug_ioctl_data
82 {
83         struct libcfs_ioctl_hdr hdr;
84         unsigned int subs;
85         unsigned int debug;
86 };
87
88 #define LIBCFS_IOC_INIT(data)                           \
89 do {                                                    \
90         memset(&data, 0, sizeof(data));                 \
91         data.ioc_hdr.ioc_version = LIBCFS_IOCTL_VERSION;        \
92         data.ioc_hdr.ioc_len = sizeof(data);            \
93 } while (0)
94
95 #define LIBCFS_IOC_INIT_V2(data, hdr)                   \
96 do {                                                    \
97         memset(&(data), 0, sizeof(data));                       \
98         (data).hdr.ioc_version = LIBCFS_IOCTL_VERSION2; \
99         (data).hdr.ioc_len = sizeof(data);              \
100 } while (0)
101
102
103 #ifdef __KERNEL__
104
105 struct libcfs_ioctl_handler {
106         struct list_head item;
107         int (*handle_ioctl)(unsigned int cmd, struct libcfs_ioctl_hdr *hdr);
108 };
109
110 #define DECLARE_IOCTL_HANDLER(ident, func)                      \
111         struct libcfs_ioctl_handler ident = {                   \
112                 /* .item = */ LIST_HEAD_INIT(ident.item),       \
113                 /* .handle_ioctl = */ func                      \
114         }
115
116 #endif
117
118 /* 'f' ioctls are defined in lustre_ioctl.h and lustre_user.h except for: */
119 #define LIBCFS_IOC_DEBUG_MASK             _IOWR('f', 250, long)
120 #define IOCTL_LIBCFS_TYPE                 long
121
122 /* ioctls for manipulating snapshots 30- */
123 #define IOC_LIBCFS_TYPE                               ('e')
124 #define IOC_LIBCFS_MIN_NR                             30
125 /* libcfs ioctls */
126 #define IOC_LIBCFS_PANIC                   _IOWR('e', 30, IOCTL_LIBCFS_TYPE)
127 #define IOC_LIBCFS_CLEAR_DEBUG             _IOWR('e', 31, IOCTL_LIBCFS_TYPE)
128 #define IOC_LIBCFS_MARK_DEBUG              _IOWR('e', 32, IOCTL_LIBCFS_TYPE)
129 #define IOC_LIBCFS_MEMHOG                  _IOWR('e', 36, IOCTL_LIBCFS_TYPE)
130 /* lnet ioctls */
131 #define IOC_LIBCFS_GET_NI                  _IOWR('e', 50, IOCTL_LIBCFS_TYPE)
132 #define IOC_LIBCFS_FAIL_NID                _IOWR('e', 51, IOCTL_LIBCFS_TYPE)
133 #define IOC_LIBCFS_NOTIFY_ROUTER           _IOWR('e', 55, IOCTL_LIBCFS_TYPE)
134 #define IOC_LIBCFS_UNCONFIGURE             _IOWR('e', 56, IOCTL_LIBCFS_TYPE)
135 #define IOC_LIBCFS_PORTALS_COMPATIBILITY   _IOWR('e', 57, IOCTL_LIBCFS_TYPE)
136 #define IOC_LIBCFS_LNET_DIST               _IOWR('e', 58, IOCTL_LIBCFS_TYPE)
137 #define IOC_LIBCFS_CONFIGURE               _IOWR('e', 59, IOCTL_LIBCFS_TYPE)
138 #define IOC_LIBCFS_TESTPROTOCOMPAT         _IOWR('e', 60, IOCTL_LIBCFS_TYPE)
139 #define IOC_LIBCFS_PING                    _IOWR('e', 61, IOCTL_LIBCFS_TYPE)
140 #define IOC_LIBCFS_DEBUG_PEER              _IOWR('e', 62, IOCTL_LIBCFS_TYPE)
141 #define IOC_LIBCFS_LNETST                  _IOWR('e', 63, IOCTL_LIBCFS_TYPE)
142 #define IOC_LIBCFS_LNET_FAULT              _IOWR('e', 64, IOCTL_LIBCFS_TYPE)
143 /* lnd ioctls */
144 #define IOC_LIBCFS_REGISTER_MYNID          _IOWR('e', 70, IOCTL_LIBCFS_TYPE)
145 #define IOC_LIBCFS_CLOSE_CONNECTION        _IOWR('e', 71, IOCTL_LIBCFS_TYPE)
146 #define IOC_LIBCFS_PUSH_CONNECTION         _IOWR('e', 72, IOCTL_LIBCFS_TYPE)
147 #define IOC_LIBCFS_GET_CONN                _IOWR('e', 73, IOCTL_LIBCFS_TYPE)
148 #define IOC_LIBCFS_DEL_PEER                _IOWR('e', 74, IOCTL_LIBCFS_TYPE)
149 #define IOC_LIBCFS_ADD_PEER                _IOWR('e', 75, IOCTL_LIBCFS_TYPE)
150 #define IOC_LIBCFS_GET_PEER                _IOWR('e', 76, IOCTL_LIBCFS_TYPE)
151 #define IOC_LIBCFS_GET_TXDESC              _IOWR('e', 77, IOCTL_LIBCFS_TYPE)
152 #define IOC_LIBCFS_ADD_INTERFACE           _IOWR('e', 78, IOCTL_LIBCFS_TYPE)
153 #define IOC_LIBCFS_DEL_INTERFACE           _IOWR('e', 79, IOCTL_LIBCFS_TYPE)
154 #define IOC_LIBCFS_GET_INTERFACE           _IOWR('e', 80, IOCTL_LIBCFS_TYPE)
155
156
157 /*
158  * DLC Speicif IOCTL numbers.
159  * In order to maintain backward compatibility with any possible external
160  * tools which might be accessing the IOCTL numbers, a new group of IOCTL
161  * number have been allocated.
162  */
163 #define IOCTL_CONFIG_SIZE                  struct lnet_ioctl_config_data
164 #define IOC_LIBCFS_ADD_ROUTE               _IOWR(IOC_LIBCFS_TYPE, 81, \
165                                                  IOCTL_CONFIG_SIZE)
166 #define IOC_LIBCFS_DEL_ROUTE               _IOWR(IOC_LIBCFS_TYPE, 82, \
167                                                  IOCTL_CONFIG_SIZE)
168 #define IOC_LIBCFS_GET_ROUTE               _IOWR(IOC_LIBCFS_TYPE, 83, \
169                                                  IOCTL_CONFIG_SIZE)
170 #define IOC_LIBCFS_ADD_NET                 _IOWR(IOC_LIBCFS_TYPE, 84, \
171                                                  IOCTL_CONFIG_SIZE)
172 #define IOC_LIBCFS_DEL_NET                 _IOWR(IOC_LIBCFS_TYPE, 85, \
173                                                  IOCTL_CONFIG_SIZE)
174 #define IOC_LIBCFS_GET_NET                 _IOWR(IOC_LIBCFS_TYPE, 86, \
175                                                  IOCTL_CONFIG_SIZE)
176 #define IOC_LIBCFS_CONFIG_RTR              _IOWR(IOC_LIBCFS_TYPE, 87, \
177                                                  IOCTL_CONFIG_SIZE)
178 #define IOC_LIBCFS_ADD_BUF                 _IOWR(IOC_LIBCFS_TYPE, 88, \
179                                                  IOCTL_CONFIG_SIZE)
180 #define IOC_LIBCFS_GET_BUF                 _IOWR(IOC_LIBCFS_TYPE, 89, \
181                                                  IOCTL_CONFIG_SIZE)
182 #define IOC_LIBCFS_GET_PEER_INFO           _IOWR(IOC_LIBCFS_TYPE, 90, \
183                                                  IOCTL_CONFIG_SIZE)
184 #define IOC_LIBCFS_GET_LNET_STATS          _IOWR(IOC_LIBCFS_TYPE, 91, \
185                                                  IOCTL_CONFIG_SIZE)
186 #define IOC_LIBCFS_MAX_NR                             91
187
188 static inline int libcfs_ioctl_packlen(struct libcfs_ioctl_data *data)
189 {
190         int len = sizeof(*data);
191         len += cfs_size_round(data->ioc_inllen1);
192         len += cfs_size_round(data->ioc_inllen2);
193         return len;
194 }
195
196 static inline bool libcfs_ioctl_is_invalid(struct libcfs_ioctl_data *data)
197 {
198         if (data->ioc_hdr.ioc_len > (1<<30)) {
199                 CERROR("LIBCFS ioctl: ioc_len larger than 1<<30\n");
200                 return 1;
201         }
202         if (data->ioc_inllen1 > (1<<30)) {
203                 CERROR("LIBCFS ioctl: ioc_inllen1 larger than 1<<30\n");
204                 return 1;
205         }
206         if (data->ioc_inllen2 > (1<<30)) {
207                 CERROR("LIBCFS ioctl: ioc_inllen2 larger than 1<<30\n");
208                 return 1;
209         }
210         if (data->ioc_inlbuf1 && data->ioc_inllen1 == 0) {
211                 CERROR("LIBCFS ioctl: inlbuf1 pointer but 0 length\n");
212                 return 1;
213         }
214         if (data->ioc_inlbuf2 && data->ioc_inllen2 == 0) {
215                 CERROR("LIBCFS ioctl: inlbuf2 pointer but 0 length\n");
216                 return 1;
217         }
218         if (data->ioc_pbuf1 && data->ioc_plen1 == 0) {
219                 CERROR("LIBCFS ioctl: pbuf1 pointer but 0 length\n");
220                 return 1;
221         }
222         if (data->ioc_pbuf2 && data->ioc_plen2 == 0) {
223                 CERROR("LIBCFS ioctl: pbuf2 pointer but 0 length\n");
224                 return 1;
225         }
226         if (data->ioc_plen1 && data->ioc_pbuf1 == 0) {
227                 CERROR("LIBCFS ioctl: plen1 nonzero but no pbuf1 pointer\n");
228                 return 1;
229         }
230         if (data->ioc_plen2 && data->ioc_pbuf2 == 0) {
231                 CERROR("LIBCFS ioctl: plen2 nonzero but no pbuf2 pointer\n");
232                 return 1;
233         }
234         if ((__u32)libcfs_ioctl_packlen(data) != data->ioc_hdr.ioc_len) {
235                 CERROR("LIBCFS ioctl: packlen != ioc_len\n");
236                 return 1;
237         }
238         if (data->ioc_inllen1 &&
239             data->ioc_bulk[data->ioc_inllen1 - 1] != '\0') {
240                 CERROR("LIBCFS ioctl: inlbuf1 not 0 terminated\n");
241                 return 1;
242         }
243         if (data->ioc_inllen2 &&
244             data->ioc_bulk[cfs_size_round(data->ioc_inllen1) +
245                            data->ioc_inllen2 - 1] != '\0') {
246                 CERROR("LIBCFS ioctl: inlbuf2 not 0 terminated\n");
247                 return 1;
248         }
249         return 0;
250 }
251
252 #ifdef __KERNEL__
253
254 extern int libcfs_register_ioctl(struct libcfs_ioctl_handler *hand);
255 extern int libcfs_deregister_ioctl(struct libcfs_ioctl_handler *hand);
256 extern int libcfs_ioctl_getdata(struct libcfs_ioctl_hdr **hdr_pp,
257                                 struct libcfs_ioctl_hdr __user *uparam);
258
259 static inline int libcfs_ioctl_popdata(struct libcfs_ioctl_hdr *hdr,
260                                        struct libcfs_ioctl_hdr __user *uparam)
261 {
262          if (copy_to_user(uparam, hdr, hdr->ioc_len))
263                 return -EFAULT;
264          return 0;
265 }
266
267 static inline void libcfs_ioctl_freedata(struct libcfs_ioctl_hdr *hdr)
268 {
269         LIBCFS_FREE(hdr, hdr->ioc_len);
270 }
271
272 #endif
273
274 extern int libcfs_ioctl_data_adjust(struct libcfs_ioctl_data *data);
275
276 #endif /* __LIBCFS_IOCTL_H__ */