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 libcfsutil_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
 105 #ifdef __KERNEL__
 106
 107 struct libcfs_ioctl_handler {
 108         struct list_head item;
 109         int (*handle_ioctl)(unsigned int cmd, struct libcfs_ioctl_hdr *hdr);
 110 };
 111
 112 #define DECLARE_IOCTL_HANDLER(ident, func)                      \
 113         static struct libcfs_ioctl_handler ident = {            \
 114                 /* .item = */ LIST_HEAD_INIT(ident.item),       \
 115                 /* .handle_ioctl = */ func                      \
 116         }
 117
 118 #endif
 119
 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
 123
 124 /* ioctls for manipulating snapshots 30- */
 125 #define IOC_LIBCFS_TYPE                               ('e')
 126 #define IOC_LIBCFS_MIN_NR                             30
 127 /* libcfs ioctls */
 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)
 132 /* lnet ioctls */
 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)
 145 /* lnd ioctls */
 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 /* ioctl 77 is free for use */
 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)
 157
 158
 159 /*
 160  * DLC Specific 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.
 164  */
 165 #define IOCTL_CONFIG_SIZE                  struct lnet_ioctl_config_data
 166 #define IOC_LIBCFS_ADD_ROUTE               _IOWR(IOC_LIBCFS_TYPE, 81, \
 167                                                  IOCTL_CONFIG_SIZE)
 168 #define IOC_LIBCFS_DEL_ROUTE               _IOWR(IOC_LIBCFS_TYPE, 82, \
 169                                                  IOCTL_CONFIG_SIZE)
 170 #define IOC_LIBCFS_GET_ROUTE               _IOWR(IOC_LIBCFS_TYPE, 83, \
 171                                                  IOCTL_CONFIG_SIZE)
 172 #define IOC_LIBCFS_ADD_NET                 _IOWR(IOC_LIBCFS_TYPE, 84, \
 173                                                  IOCTL_CONFIG_SIZE)
 174 #define IOC_LIBCFS_DEL_NET                 _IOWR(IOC_LIBCFS_TYPE, 85, \
 175                                                  IOCTL_CONFIG_SIZE)
 176 #define IOC_LIBCFS_GET_NET                 _IOWR(IOC_LIBCFS_TYPE, 86, \
 177                                                  IOCTL_CONFIG_SIZE)
 178 #define IOC_LIBCFS_CONFIG_RTR              _IOWR(IOC_LIBCFS_TYPE, 87, \
 179                                                  IOCTL_CONFIG_SIZE)
 180 #define IOC_LIBCFS_ADD_BUF                 _IOWR(IOC_LIBCFS_TYPE, 88, \
 181                                                  IOCTL_CONFIG_SIZE)
 182 #define IOC_LIBCFS_GET_BUF                 _IOWR(IOC_LIBCFS_TYPE, 89, \
 183                                                  IOCTL_CONFIG_SIZE)
 184 #define IOC_LIBCFS_GET_PEER_INFO           _IOWR(IOC_LIBCFS_TYPE, 90, \
 185                                                  IOCTL_CONFIG_SIZE)
 186 #define IOC_LIBCFS_GET_LNET_STATS          _IOWR(IOC_LIBCFS_TYPE, 91, \
 187                                                  IOCTL_CONFIG_SIZE)
 188 #define IOC_LIBCFS_MAX_NR                             91
 189
 190 static inline int libcfs_ioctl_packlen(struct libcfs_ioctl_data *data)
 191 {
 192         int len = sizeof(*data);
 193         len += cfs_size_round(data->ioc_inllen1);
 194         len += cfs_size_round(data->ioc_inllen2);
 195         return len;
 196 }
 197
 198 static inline bool libcfs_ioctl_is_invalid(struct libcfs_ioctl_data *data)
 199 {
 200         if (data->ioc_hdr.ioc_len > (1<<30)) {
 201                 CERROR("LIBCFS ioctl: ioc_len larger than 1<<30\n");
 202                 return 1;
 203         }
 204         if (data->ioc_inllen1 > (1<<30)) {
 205                 CERROR("LIBCFS ioctl: ioc_inllen1 larger than 1<<30\n");
 206                 return 1;
 207         }
 208         if (data->ioc_inllen2 > (1<<30)) {
 209                 CERROR("LIBCFS ioctl: ioc_inllen2 larger than 1<<30\n");
 210                 return 1;
 211         }
 212         if (data->ioc_inlbuf1 && data->ioc_inllen1 == 0) {
 213                 CERROR("LIBCFS ioctl: inlbuf1 pointer but 0 length\n");
 214                 return 1;
 215         }
 216         if (data->ioc_inlbuf2 && data->ioc_inllen2 == 0) {
 217                 CERROR("LIBCFS ioctl: inlbuf2 pointer but 0 length\n");
 218                 return 1;
 219         }
 220         if (data->ioc_pbuf1 && data->ioc_plen1 == 0) {
 221                 CERROR("LIBCFS ioctl: pbuf1 pointer but 0 length\n");
 222                 return 1;
 223         }
 224         if (data->ioc_pbuf2 && data->ioc_plen2 == 0) {
 225                 CERROR("LIBCFS ioctl: pbuf2 pointer but 0 length\n");
 226                 return 1;
 227         }
 228         if (data->ioc_plen1 && data->ioc_pbuf1 == NULL) {
 229                 CERROR("LIBCFS ioctl: plen1 nonzero but no pbuf1 pointer\n");
 230                 return 1;
 231         }
 232         if (data->ioc_plen2 && data->ioc_pbuf2 == NULL) {
 233                 CERROR("LIBCFS ioctl: plen2 nonzero but no pbuf2 pointer\n");
 234                 return 1;
 235         }
 236         if ((__u32)libcfs_ioctl_packlen(data) != data->ioc_hdr.ioc_len) {
 237                 CERROR("LIBCFS ioctl: packlen != ioc_len\n");
 238                 return 1;
 239         }
 240         if (data->ioc_inllen1 &&
 241             data->ioc_bulk[data->ioc_inllen1 - 1] != '\0') {
 242                 CERROR("LIBCFS ioctl: inlbuf1 not 0 terminated\n");
 243                 return 1;
 244         }
 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");
 249                 return 1;
 250         }
 251         return 0;
 252 }
 253
 254 #ifdef __KERNEL__
 255
 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);
 260
 261 static inline int libcfs_ioctl_popdata(struct libcfs_ioctl_hdr *hdr,
 262                                        struct libcfs_ioctl_hdr __user *uparam)
 263 {
 264          if (copy_to_user(uparam, hdr, hdr->ioc_len))
 265                 return -EFAULT;
 266          return 0;
 267 }
 268
 269 static inline void libcfs_ioctl_freedata(struct libcfs_ioctl_hdr *hdr)
 270 {
 271         LIBCFS_FREE(hdr, hdr->ioc_len);
 272 }
 273
 274 #endif
 275
 276 extern int libcfs_ioctl_data_adjust(struct libcfs_ioctl_data *data);
 277
 278 #endif /* __LIBCFS_IOCTL_H__ */