drivers/staging/lustre/include/linux/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 libcfs/util/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         void __user *ioc_pbuf1;
  73         __u32 ioc_plen2; /* buffers in userspace */
  74         void __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         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 struct libcfs_ioctl_handler {
  95         struct list_head item;
  96         int (*handle_ioctl)(unsigned int cmd, struct libcfs_ioctl_hdr *hdr);
  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 /* FIXME check conflict with lustre_lib.h */
 106 #define LIBCFS_IOC_DEBUG_MASK        _IOWR('f', 250, long)
 107
 108 #define IOC_LIBCFS_TYPE            'e'
 109 #define IOC_LIBCFS_MIN_NR                30
 110 /* libcfs ioctls */
 111 #define IOC_LIBCFS_PANIC                   _IOWR('e', 30, long)
 112 #define IOC_LIBCFS_CLEAR_DEBUG       _IOWR('e', 31, long)
 113 #define IOC_LIBCFS_MARK_DEBUG         _IOWR('e', 32, long)
 114 #define IOC_LIBCFS_MEMHOG                 _IOWR('e', 36, long)
 115 /* lnet ioctls */
 116 #define IOC_LIBCFS_GET_NI                 _IOWR('e', 50, long)
 117 #define IOC_LIBCFS_FAIL_NID             _IOWR('e', 51, long)
 118 #define IOC_LIBCFS_NOTIFY_ROUTER           _IOWR('e', 55, long)
 119 #define IOC_LIBCFS_UNCONFIGURE       _IOWR('e', 56, long)
 120 /*      #define IOC_LIBCFS_PORTALS_COMPATIBILITY   _IOWR('e', 57, long) */
 121 #define IOC_LIBCFS_LNET_DIST           _IOWR('e', 58, long)
 122 #define IOC_LIBCFS_CONFIGURE           _IOWR('e', 59, long)
 123 #define IOC_LIBCFS_TESTPROTOCOMPAT       _IOWR('e', 60, long)
 124 #define IOC_LIBCFS_PING             _IOWR('e', 61, long)
 125 /*      #define IOC_LIBCFS_DEBUG_PEER         _IOWR('e', 62, long) */
 126 #define IOC_LIBCFS_LNETST                 _IOWR('e', 63, long)
 127 #define IOC_LIBCFS_LNET_FAULT           _IOWR('e', 64, long)
 128 /* lnd ioctls */
 129 #define IOC_LIBCFS_REGISTER_MYNID         _IOWR('e', 70, long)
 130 #define IOC_LIBCFS_CLOSE_CONNECTION     _IOWR('e', 71, long)
 131 #define IOC_LIBCFS_PUSH_CONNECTION       _IOWR('e', 72, long)
 132 #define IOC_LIBCFS_GET_CONN             _IOWR('e', 73, long)
 133 #define IOC_LIBCFS_DEL_PEER             _IOWR('e', 74, long)
 134 #define IOC_LIBCFS_ADD_PEER             _IOWR('e', 75, long)
 135 #define IOC_LIBCFS_GET_PEER             _IOWR('e', 76, long)
 136 /* ioctl 77 is free for use */
 137 #define IOC_LIBCFS_ADD_INTERFACE           _IOWR('e', 78, long)
 138 #define IOC_LIBCFS_DEL_INTERFACE           _IOWR('e', 79, long)
 139 #define IOC_LIBCFS_GET_INTERFACE           _IOWR('e', 80, long)
 140
 141 /*
 142  * DLC Specific IOCTL numbers.
 143  * In order to maintain backward compatibility with any possible external
 144  * tools which might be accessing the IOCTL numbers, a new group of IOCTL
 145  * number have been allocated.
 146  */
 147 #define IOCTL_CONFIG_SIZE               struct lnet_ioctl_config_data
 148 #define IOC_LIBCFS_ADD_ROUTE            _IOWR(IOC_LIBCFS_TYPE, 81, IOCTL_CONFIG_SIZE)
 149 #define IOC_LIBCFS_DEL_ROUTE            _IOWR(IOC_LIBCFS_TYPE, 82, IOCTL_CONFIG_SIZE)
 150 #define IOC_LIBCFS_GET_ROUTE            _IOWR(IOC_LIBCFS_TYPE, 83, IOCTL_CONFIG_SIZE)
 151 #define IOC_LIBCFS_ADD_NET              _IOWR(IOC_LIBCFS_TYPE, 84, IOCTL_CONFIG_SIZE)
 152 #define IOC_LIBCFS_DEL_NET              _IOWR(IOC_LIBCFS_TYPE, 85, IOCTL_CONFIG_SIZE)
 153 #define IOC_LIBCFS_GET_NET              _IOWR(IOC_LIBCFS_TYPE, 86, IOCTL_CONFIG_SIZE)
 154 #define IOC_LIBCFS_CONFIG_RTR           _IOWR(IOC_LIBCFS_TYPE, 87, IOCTL_CONFIG_SIZE)
 155 #define IOC_LIBCFS_ADD_BUF              _IOWR(IOC_LIBCFS_TYPE, 88, IOCTL_CONFIG_SIZE)
 156 #define IOC_LIBCFS_GET_BUF              _IOWR(IOC_LIBCFS_TYPE, 89, IOCTL_CONFIG_SIZE)
 157 #define IOC_LIBCFS_GET_PEER_INFO        _IOWR(IOC_LIBCFS_TYPE, 90, IOCTL_CONFIG_SIZE)
 158 #define IOC_LIBCFS_GET_LNET_STATS       _IOWR(IOC_LIBCFS_TYPE, 91, IOCTL_CONFIG_SIZE)
 159 #define IOC_LIBCFS_MAX_NR               91
 160
 161 static inline int libcfs_ioctl_packlen(struct libcfs_ioctl_data *data)
 162 {
 163         int len = sizeof(*data);
 164
 165         len += cfs_size_round(data->ioc_inllen1);
 166         len += cfs_size_round(data->ioc_inllen2);
 167         return len;
 168 }
 169
 170 static inline bool libcfs_ioctl_is_invalid(struct libcfs_ioctl_data *data)
 171 {
 172         if (data->ioc_hdr.ioc_len > (1 << 30)) {
 173                 CERROR("LIBCFS ioctl: ioc_len larger than 1<<30\n");
 174                 return 1;
 175         }
 176         if (data->ioc_inllen1 > (1<<30)) {
 177                 CERROR("LIBCFS ioctl: ioc_inllen1 larger than 1<<30\n");
 178                 return 1;
 179         }
 180         if (data->ioc_inllen2 > (1<<30)) {
 181                 CERROR("LIBCFS ioctl: ioc_inllen2 larger than 1<<30\n");
 182                 return 1;
 183         }
 184         if (data->ioc_inlbuf1 && !data->ioc_inllen1) {
 185                 CERROR("LIBCFS ioctl: inlbuf1 pointer but 0 length\n");
 186                 return 1;
 187         }
 188         if (data->ioc_inlbuf2 && !data->ioc_inllen2) {
 189                 CERROR("LIBCFS ioctl: inlbuf2 pointer but 0 length\n");
 190                 return 1;
 191         }
 192         if (data->ioc_pbuf1 && !data->ioc_plen1) {
 193                 CERROR("LIBCFS ioctl: pbuf1 pointer but 0 length\n");
 194                 return 1;
 195         }
 196         if (data->ioc_pbuf2 && !data->ioc_plen2) {
 197                 CERROR("LIBCFS ioctl: pbuf2 pointer but 0 length\n");
 198                 return 1;
 199         }
 200         if (data->ioc_plen1 && !data->ioc_pbuf1) {
 201                 CERROR("LIBCFS ioctl: plen1 nonzero but no pbuf1 pointer\n");
 202                 return 1;
 203         }
 204         if (data->ioc_plen2 && !data->ioc_pbuf2) {
 205                 CERROR("LIBCFS ioctl: plen2 nonzero but no pbuf2 pointer\n");
 206                 return 1;
 207         }
 208         if ((__u32)libcfs_ioctl_packlen(data) != data->ioc_hdr.ioc_len) {
 209                 CERROR("LIBCFS ioctl: packlen != ioc_len\n");
 210                 return 1;
 211         }
 212         if (data->ioc_inllen1 &&
 213             data->ioc_bulk[data->ioc_inllen1 - 1] != '\0') {
 214                 CERROR("LIBCFS ioctl: inlbuf1 not 0 terminated\n");
 215                 return 1;
 216         }
 217         if (data->ioc_inllen2 &&
 218             data->ioc_bulk[cfs_size_round(data->ioc_inllen1) +
 219                            data->ioc_inllen2 - 1] != '\0') {
 220                 CERROR("LIBCFS ioctl: inlbuf2 not 0 terminated\n");
 221                 return 1;
 222         }
 223         return 0;
 224 }
 225
 226 int libcfs_register_ioctl(struct libcfs_ioctl_handler *hand);
 227 int libcfs_deregister_ioctl(struct libcfs_ioctl_handler *hand);
 228 int libcfs_ioctl_getdata(struct libcfs_ioctl_hdr **hdr_pp,
 229                          const struct libcfs_ioctl_hdr __user *uparam);
 230 int libcfs_ioctl_popdata(void __user *arg, void *buf, int size);
 231 int libcfs_ioctl_data_adjust(struct libcfs_ioctl_data *data);
 232
 233 #endif /* __LIBCFS_IOCTL_H__ */