Whamcloud - gitweb
f08d2efafb462c7f629f980120e054d56e60d7b3
[fs/lustre-release.git] / libcfs / include / libcfs / libcfs_ioctl.h
1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2  * vim:expandtab:shiftwidth=8:tabstop=8:
3  *
4  * GPL HEADER START
5  *
6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License version 2 only,
10  * as published by the Free Software Foundation.
11  *
12  * This program is distributed in the hope that it will be useful, but
13  * WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * General Public License version 2 for more details (a copy is included
16  * in the LICENSE file that accompanied this code).
17  *
18  * You should have received a copy of the GNU General Public License
19  * version 2 along with this program; If not, see
20  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
21  *
22  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
23  * CA 95054 USA or visit www.sun.com if you need additional information or
24  * have any questions.
25  *
26  * GPL HEADER END
27  */
28 /*
29  * Copyright  2008 Sun Microsystems, Inc. All rights reserved
30  * Use is subject to license terms.
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 libcfsutil_ioctl.h.
40  *
41  */
42
43 #ifndef __LIBCFS_IOCTL_H__
44 #define __LIBCFS_IOCTL_H__
45
46
47 #define LIBCFS_IOCTL_VERSION 0x0001000a
48
49 struct libcfs_ioctl_data {
50         __u32 ioc_len;
51         __u32 ioc_version;
52
53         __u64 ioc_nid;
54         __u64 ioc_u64[1];
55
56         __u32 ioc_flags;
57         __u32 ioc_count;
58         __u32 ioc_net;
59         __u32 ioc_u32[7];
60
61         __u32 ioc_inllen1;
62         char *ioc_inlbuf1;
63         __u32 ioc_inllen2;
64         char *ioc_inlbuf2;
65
66         __u32 ioc_plen1; /* buffers in userspace */
67         char *ioc_pbuf1;
68         __u32 ioc_plen2; /* buffers in userspace */
69         char *ioc_pbuf2;
70
71         char ioc_bulk[0];
72 };
73
74
75 struct libcfs_ioctl_hdr {
76         __u32 ioc_len;
77         __u32 ioc_version;
78 };
79
80 struct libcfs_debug_ioctl_data
81 {
82         struct libcfs_ioctl_hdr hdr;
83         unsigned int subs;
84         unsigned int debug;
85 };
86
87 #define LIBCFS_IOC_INIT(data)                           \
88 do {                                                    \
89         memset(&data, 0, sizeof(data));                 \
90         data.ioc_version = LIBCFS_IOCTL_VERSION;        \
91         data.ioc_len = sizeof(data);                    \
92 } while (0)
93
94 #ifdef __KERNEL__
95
96 struct libcfs_ioctl_handler {
97         cfs_list_t item;
98         int (*handle_ioctl)(unsigned int cmd, struct libcfs_ioctl_data *data);
99 };
100
101 #define DECLARE_IOCTL_HANDLER(ident, func)                      \
102         struct libcfs_ioctl_handler ident = {                   \
103                 /* .item = */ CFS_LIST_HEAD_INIT(ident.item),   \
104                 /* .handle_ioctl = */ func                      \
105         }
106
107 #endif
108
109 /* FIXME check conflict with lustre_lib.h */
110 #define LIBCFS_IOC_DEBUG_MASK             _IOWR('f', 250, long)
111
112
113 /* ioctls for manipulating snapshots 30- */
114 #define IOC_LIBCFS_TYPE                   'e'
115 #define IOC_LIBCFS_MIN_NR                 30
116 /* libcfs ioctls */
117 #define IOC_LIBCFS_PANIC                   _IOWR('e', 30, IOCTL_LIBCFS_TYPE)
118 #define IOC_LIBCFS_CLEAR_DEBUG             _IOWR('e', 31, IOCTL_LIBCFS_TYPE)
119 #define IOC_LIBCFS_MARK_DEBUG              _IOWR('e', 32, IOCTL_LIBCFS_TYPE)
120 #define IOC_LIBCFS_LWT_CONTROL             _IOWR('e', 33, IOCTL_LIBCFS_TYPE)
121 #define IOC_LIBCFS_LWT_SNAPSHOT            _IOWR('e', 34, IOCTL_LIBCFS_TYPE)
122 #define IOC_LIBCFS_LWT_LOOKUP_STRING       _IOWR('e', 35, IOCTL_LIBCFS_TYPE)
123 #define IOC_LIBCFS_MEMHOG                  _IOWR('e', 36, IOCTL_LIBCFS_TYPE)
124 #define IOC_LIBCFS_PING_TEST               _IOWR('e', 37, IOCTL_LIBCFS_TYPE)
125 /* lnet ioctls */
126 #define IOC_LIBCFS_GET_NI                  _IOWR('e', 50, IOCTL_LIBCFS_TYPE)
127 #define IOC_LIBCFS_FAIL_NID                _IOWR('e', 51, IOCTL_LIBCFS_TYPE)
128 #define IOC_LIBCFS_ADD_ROUTE               _IOWR('e', 52, IOCTL_LIBCFS_TYPE)
129 #define IOC_LIBCFS_DEL_ROUTE               _IOWR('e', 53, IOCTL_LIBCFS_TYPE)
130 #define IOC_LIBCFS_GET_ROUTE               _IOWR('e', 54, IOCTL_LIBCFS_TYPE)
131 #define IOC_LIBCFS_NOTIFY_ROUTER           _IOWR('e', 55, IOCTL_LIBCFS_TYPE)
132 #define IOC_LIBCFS_UNCONFIGURE             _IOWR('e', 56, IOCTL_LIBCFS_TYPE)
133 #define IOC_LIBCFS_PORTALS_COMPATIBILITY   _IOWR('e', 57, IOCTL_LIBCFS_TYPE)
134 #define IOC_LIBCFS_LNET_DIST               _IOWR('e', 58, IOCTL_LIBCFS_TYPE)
135 #define IOC_LIBCFS_CONFIGURE               _IOWR('e', 59, IOCTL_LIBCFS_TYPE)
136 #define IOC_LIBCFS_TESTPROTOCOMPAT         _IOWR('e', 60, IOCTL_LIBCFS_TYPE)
137 #define IOC_LIBCFS_PING                    _IOWR('e', 61, IOCTL_LIBCFS_TYPE)
138 #define IOC_LIBCFS_DEBUG_PEER              _IOWR('e', 62, IOCTL_LIBCFS_TYPE)
139 #define IOC_LIBCFS_LNETST                  _IOWR('e', 63, IOCTL_LIBCFS_TYPE)
140 /* lnd ioctls */
141 #define IOC_LIBCFS_REGISTER_MYNID          _IOWR('e', 70, IOCTL_LIBCFS_TYPE)
142 #define IOC_LIBCFS_CLOSE_CONNECTION        _IOWR('e', 71, IOCTL_LIBCFS_TYPE)
143 #define IOC_LIBCFS_PUSH_CONNECTION         _IOWR('e', 72, IOCTL_LIBCFS_TYPE)
144 #define IOC_LIBCFS_GET_CONN                _IOWR('e', 73, IOCTL_LIBCFS_TYPE)
145 #define IOC_LIBCFS_DEL_PEER                _IOWR('e', 74, IOCTL_LIBCFS_TYPE)
146 #define IOC_LIBCFS_ADD_PEER                _IOWR('e', 75, IOCTL_LIBCFS_TYPE)
147 #define IOC_LIBCFS_GET_PEER                _IOWR('e', 76, IOCTL_LIBCFS_TYPE)
148 #define IOC_LIBCFS_GET_TXDESC              _IOWR('e', 77, IOCTL_LIBCFS_TYPE)
149 #define IOC_LIBCFS_ADD_INTERFACE           _IOWR('e', 78, IOCTL_LIBCFS_TYPE)
150 #define IOC_LIBCFS_DEL_INTERFACE           _IOWR('e', 79, IOCTL_LIBCFS_TYPE)
151 #define IOC_LIBCFS_GET_INTERFACE           _IOWR('e', 80, IOCTL_LIBCFS_TYPE)
152 #define IOC_LIBCFS_GET_GMID                _IOWR('e', 81, IOCTL_LIBCFS_TYPE)
153
154 #define IOC_LIBCFS_MAX_NR                             81
155
156 static inline int libcfs_ioctl_packlen(struct libcfs_ioctl_data *data)
157 {
158         int len = sizeof(*data);
159         len += cfs_size_round(data->ioc_inllen1);
160         len += cfs_size_round(data->ioc_inllen2);
161         return len;
162 }
163
164 static inline int libcfs_ioctl_is_invalid(struct libcfs_ioctl_data *data)
165 {
166         if (data->ioc_len > (1<<30)) {
167                 CERROR ("LIBCFS ioctl: ioc_len larger than 1<<30\n");
168                 return 1;
169         }
170         if (data->ioc_inllen1 > (1<<30)) {
171                 CERROR ("LIBCFS ioctl: ioc_inllen1 larger than 1<<30\n");
172                 return 1;
173         }
174         if (data->ioc_inllen2 > (1<<30)) {
175                 CERROR ("LIBCFS ioctl: ioc_inllen2 larger than 1<<30\n");
176                 return 1;
177         }
178         if (data->ioc_inlbuf1 && !data->ioc_inllen1) {
179                 CERROR ("LIBCFS ioctl: inlbuf1 pointer but 0 length\n");
180                 return 1;
181         }
182         if (data->ioc_inlbuf2 && !data->ioc_inllen2) {
183                 CERROR ("LIBCFS ioctl: inlbuf2 pointer but 0 length\n");
184                 return 1;
185         }
186         if (data->ioc_pbuf1 && !data->ioc_plen1) {
187                 CERROR ("LIBCFS ioctl: pbuf1 pointer but 0 length\n");
188                 return 1;
189         }
190         if (data->ioc_pbuf2 && !data->ioc_plen2) {
191                 CERROR ("LIBCFS ioctl: pbuf2 pointer but 0 length\n");
192                 return 1;
193         }
194         if (data->ioc_plen1 && !data->ioc_pbuf1) {
195                 CERROR ("LIBCFS ioctl: plen1 nonzero but no pbuf1 pointer\n");
196                 return 1;
197         }
198         if (data->ioc_plen2 && !data->ioc_pbuf2) {
199                 CERROR ("LIBCFS ioctl: plen2 nonzero but no pbuf2 pointer\n");
200                 return 1;
201         }
202         if ((__u32)libcfs_ioctl_packlen(data) != data->ioc_len ) {
203                 CERROR ("LIBCFS ioctl: packlen != ioc_len\n");
204                 return 1;
205         }
206         if (data->ioc_inllen1 &&
207             data->ioc_bulk[data->ioc_inllen1 - 1] != '\0') {
208                 CERROR ("LIBCFS ioctl: inlbuf1 not 0 terminated\n");
209                 return 1;
210         }
211         if (data->ioc_inllen2 &&
212             data->ioc_bulk[cfs_size_round(data->ioc_inllen1) +
213                            data->ioc_inllen2 - 1] != '\0') {
214                 CERROR ("LIBCFS ioctl: inlbuf2 not 0 terminated\n");
215                 return 1;
216         }
217         return 0;
218 }
219
220 #ifdef __KERNEL__
221
222 extern int libcfs_register_ioctl(struct libcfs_ioctl_handler *hand);
223 extern int libcfs_deregister_ioctl(struct libcfs_ioctl_handler *hand);
224 extern int libcfs_ioctl_getdata(char *buf, char *end, void *arg);
225 extern int libcfs_ioctl_popdata(void *arg, void *buf, int size);
226
227 #endif 
228
229 #endif /* __LIBCFS_IOCTL_H__ */