Peng Tao | d7e09d0 | 2013-05-02 16:46:55 +0800 | [diff] [blame] | 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 | |
| 45 | #define LIBCFS_IOCTL_VERSION 0x0001000a |
| 46 | |
| 47 | struct libcfs_ioctl_data { |
| 48 | __u32 ioc_len; |
| 49 | __u32 ioc_version; |
| 50 | |
| 51 | __u64 ioc_nid; |
| 52 | __u64 ioc_u64[1]; |
| 53 | |
| 54 | __u32 ioc_flags; |
| 55 | __u32 ioc_count; |
| 56 | __u32 ioc_net; |
| 57 | __u32 ioc_u32[7]; |
| 58 | |
| 59 | __u32 ioc_inllen1; |
| 60 | char *ioc_inlbuf1; |
| 61 | __u32 ioc_inllen2; |
| 62 | char *ioc_inlbuf2; |
| 63 | |
| 64 | __u32 ioc_plen1; /* buffers in userspace */ |
| 65 | char *ioc_pbuf1; |
| 66 | __u32 ioc_plen2; /* buffers in userspace */ |
| 67 | char *ioc_pbuf2; |
| 68 | |
| 69 | char ioc_bulk[0]; |
| 70 | }; |
| 71 | |
Doug Oucharek | e75fb87 | 2013-12-09 22:56:54 +0800 | [diff] [blame] | 72 | #define ioc_priority ioc_u32[0] |
Peng Tao | d7e09d0 | 2013-05-02 16:46:55 +0800 | [diff] [blame] | 73 | |
| 74 | struct libcfs_ioctl_hdr { |
| 75 | __u32 ioc_len; |
| 76 | __u32 ioc_version; |
| 77 | }; |
| 78 | |
| 79 | struct libcfs_debug_ioctl_data |
| 80 | { |
| 81 | struct libcfs_ioctl_hdr hdr; |
| 82 | unsigned int subs; |
| 83 | unsigned int debug; |
| 84 | }; |
| 85 | |
| 86 | #define LIBCFS_IOC_INIT(data) \ |
| 87 | do { \ |
| 88 | memset(&data, 0, sizeof(data)); \ |
| 89 | data.ioc_version = LIBCFS_IOCTL_VERSION; \ |
| 90 | data.ioc_len = sizeof(data); \ |
| 91 | } while (0) |
| 92 | |
| 93 | |
| 94 | struct libcfs_ioctl_handler { |
| 95 | struct list_head item; |
| 96 | int (*handle_ioctl)(unsigned int cmd, struct libcfs_ioctl_data *data); |
| 97 | }; |
| 98 | |
| 99 | #define DECLARE_IOCTL_HANDLER(ident, func) \ |
| 100 | struct libcfs_ioctl_handler ident = { \ |
| 101 | /* .item = */ LIST_HEAD_INIT(ident.item), \ |
| 102 | /* .handle_ioctl = */ func \ |
| 103 | } |
| 104 | |
| 105 | |
| 106 | /* FIXME check conflict with lustre_lib.h */ |
| 107 | #define LIBCFS_IOC_DEBUG_MASK _IOWR('f', 250, long) |
| 108 | |
| 109 | |
| 110 | /* ioctls for manipulating snapshots 30- */ |
| 111 | #define IOC_LIBCFS_TYPE 'e' |
| 112 | #define IOC_LIBCFS_MIN_NR 30 |
| 113 | /* libcfs ioctls */ |
Peng Tao | 6be9684 | 2013-11-19 22:38:42 +0800 | [diff] [blame] | 114 | #define IOC_LIBCFS_PANIC _IOWR('e', 30, long) |
| 115 | #define IOC_LIBCFS_CLEAR_DEBUG _IOWR('e', 31, long) |
| 116 | #define IOC_LIBCFS_MARK_DEBUG _IOWR('e', 32, long) |
Peng Tao | 6be9684 | 2013-11-19 22:38:42 +0800 | [diff] [blame] | 117 | #define IOC_LIBCFS_MEMHOG _IOWR('e', 36, long) |
| 118 | #define IOC_LIBCFS_PING_TEST _IOWR('e', 37, long) |
Peng Tao | d7e09d0 | 2013-05-02 16:46:55 +0800 | [diff] [blame] | 119 | /* lnet ioctls */ |
Peng Tao | 6be9684 | 2013-11-19 22:38:42 +0800 | [diff] [blame] | 120 | #define IOC_LIBCFS_GET_NI _IOWR('e', 50, long) |
| 121 | #define IOC_LIBCFS_FAIL_NID _IOWR('e', 51, long) |
| 122 | #define IOC_LIBCFS_ADD_ROUTE _IOWR('e', 52, long) |
| 123 | #define IOC_LIBCFS_DEL_ROUTE _IOWR('e', 53, long) |
| 124 | #define IOC_LIBCFS_GET_ROUTE _IOWR('e', 54, long) |
| 125 | #define IOC_LIBCFS_NOTIFY_ROUTER _IOWR('e', 55, long) |
| 126 | #define IOC_LIBCFS_UNCONFIGURE _IOWR('e', 56, long) |
| 127 | #define IOC_LIBCFS_PORTALS_COMPATIBILITY _IOWR('e', 57, long) |
| 128 | #define IOC_LIBCFS_LNET_DIST _IOWR('e', 58, long) |
| 129 | #define IOC_LIBCFS_CONFIGURE _IOWR('e', 59, long) |
| 130 | #define IOC_LIBCFS_TESTPROTOCOMPAT _IOWR('e', 60, long) |
| 131 | #define IOC_LIBCFS_PING _IOWR('e', 61, long) |
| 132 | #define IOC_LIBCFS_DEBUG_PEER _IOWR('e', 62, long) |
| 133 | #define IOC_LIBCFS_LNETST _IOWR('e', 63, long) |
Peng Tao | d7e09d0 | 2013-05-02 16:46:55 +0800 | [diff] [blame] | 134 | /* lnd ioctls */ |
Peng Tao | 6be9684 | 2013-11-19 22:38:42 +0800 | [diff] [blame] | 135 | #define IOC_LIBCFS_REGISTER_MYNID _IOWR('e', 70, long) |
| 136 | #define IOC_LIBCFS_CLOSE_CONNECTION _IOWR('e', 71, long) |
| 137 | #define IOC_LIBCFS_PUSH_CONNECTION _IOWR('e', 72, long) |
| 138 | #define IOC_LIBCFS_GET_CONN _IOWR('e', 73, long) |
| 139 | #define IOC_LIBCFS_DEL_PEER _IOWR('e', 74, long) |
| 140 | #define IOC_LIBCFS_ADD_PEER _IOWR('e', 75, long) |
| 141 | #define IOC_LIBCFS_GET_PEER _IOWR('e', 76, long) |
| 142 | #define IOC_LIBCFS_GET_TXDESC _IOWR('e', 77, long) |
| 143 | #define IOC_LIBCFS_ADD_INTERFACE _IOWR('e', 78, long) |
| 144 | #define IOC_LIBCFS_DEL_INTERFACE _IOWR('e', 79, long) |
| 145 | #define IOC_LIBCFS_GET_INTERFACE _IOWR('e', 80, long) |
Peng Tao | d7e09d0 | 2013-05-02 16:46:55 +0800 | [diff] [blame] | 146 | |
| 147 | #define IOC_LIBCFS_MAX_NR 80 |
| 148 | |
| 149 | static inline int libcfs_ioctl_packlen(struct libcfs_ioctl_data *data) |
| 150 | { |
| 151 | int len = sizeof(*data); |
| 152 | len += cfs_size_round(data->ioc_inllen1); |
| 153 | len += cfs_size_round(data->ioc_inllen2); |
| 154 | return len; |
| 155 | } |
| 156 | |
| 157 | static inline int libcfs_ioctl_is_invalid(struct libcfs_ioctl_data *data) |
| 158 | { |
| 159 | if (data->ioc_len > (1<<30)) { |
| 160 | CERROR ("LIBCFS ioctl: ioc_len larger than 1<<30\n"); |
| 161 | return 1; |
| 162 | } |
| 163 | if (data->ioc_inllen1 > (1<<30)) { |
| 164 | CERROR ("LIBCFS ioctl: ioc_inllen1 larger than 1<<30\n"); |
| 165 | return 1; |
| 166 | } |
| 167 | if (data->ioc_inllen2 > (1<<30)) { |
| 168 | CERROR ("LIBCFS ioctl: ioc_inllen2 larger than 1<<30\n"); |
| 169 | return 1; |
| 170 | } |
| 171 | if (data->ioc_inlbuf1 && !data->ioc_inllen1) { |
| 172 | CERROR ("LIBCFS ioctl: inlbuf1 pointer but 0 length\n"); |
| 173 | return 1; |
| 174 | } |
| 175 | if (data->ioc_inlbuf2 && !data->ioc_inllen2) { |
| 176 | CERROR ("LIBCFS ioctl: inlbuf2 pointer but 0 length\n"); |
| 177 | return 1; |
| 178 | } |
| 179 | if (data->ioc_pbuf1 && !data->ioc_plen1) { |
| 180 | CERROR ("LIBCFS ioctl: pbuf1 pointer but 0 length\n"); |
| 181 | return 1; |
| 182 | } |
| 183 | if (data->ioc_pbuf2 && !data->ioc_plen2) { |
| 184 | CERROR ("LIBCFS ioctl: pbuf2 pointer but 0 length\n"); |
| 185 | return 1; |
| 186 | } |
| 187 | if (data->ioc_plen1 && !data->ioc_pbuf1) { |
| 188 | CERROR ("LIBCFS ioctl: plen1 nonzero but no pbuf1 pointer\n"); |
| 189 | return 1; |
| 190 | } |
| 191 | if (data->ioc_plen2 && !data->ioc_pbuf2) { |
| 192 | CERROR ("LIBCFS ioctl: plen2 nonzero but no pbuf2 pointer\n"); |
| 193 | return 1; |
| 194 | } |
| 195 | if ((__u32)libcfs_ioctl_packlen(data) != data->ioc_len ) { |
| 196 | CERROR ("LIBCFS ioctl: packlen != ioc_len\n"); |
| 197 | return 1; |
| 198 | } |
| 199 | if (data->ioc_inllen1 && |
| 200 | data->ioc_bulk[data->ioc_inllen1 - 1] != '\0') { |
| 201 | CERROR ("LIBCFS ioctl: inlbuf1 not 0 terminated\n"); |
| 202 | return 1; |
| 203 | } |
| 204 | if (data->ioc_inllen2 && |
| 205 | data->ioc_bulk[cfs_size_round(data->ioc_inllen1) + |
| 206 | data->ioc_inllen2 - 1] != '\0') { |
| 207 | CERROR ("LIBCFS ioctl: inlbuf2 not 0 terminated\n"); |
| 208 | return 1; |
| 209 | } |
| 210 | return 0; |
| 211 | } |
| 212 | |
| 213 | |
| 214 | extern int libcfs_register_ioctl(struct libcfs_ioctl_handler *hand); |
| 215 | extern int libcfs_deregister_ioctl(struct libcfs_ioctl_handler *hand); |
| 216 | extern int libcfs_ioctl_getdata(char *buf, char *end, void *arg); |
| 217 | extern int libcfs_ioctl_popdata(void *arg, void *buf, int size); |
| 218 | |
| 219 | |
| 220 | #endif /* __LIBCFS_IOCTL_H__ */ |