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
  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
  72 #define ioc_priority ioc_u32[0]
  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         struct list_head 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 = */ LIST_HEAD_INIT(ident.item),       \
 104                 /* .handle_ioctl = */ func                      \
 105         }
 106
 107 #endif
 108
 109 /* 'f' ioctls are defined in lustre_ioctl.h and lustre_user.h except for: */
 110 #define LIBCFS_IOC_DEBUG_MASK             _IOWR('f', 250, long)
 111 #define IOCTL_LIBCFS_TYPE                 long
 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_MEMHOG                  _IOWR('e', 36, IOCTL_LIBCFS_TYPE)
 121 #define IOC_LIBCFS_PING_TEST               _IOWR('e', 37, IOCTL_LIBCFS_TYPE)
 122 /* lnet ioctls */
 123 #define IOC_LIBCFS_GET_NI                  _IOWR('e', 50, IOCTL_LIBCFS_TYPE)
 124 #define IOC_LIBCFS_FAIL_NID                _IOWR('e', 51, IOCTL_LIBCFS_TYPE)
 125 #define IOC_LIBCFS_ADD_ROUTE               _IOWR('e', 52, IOCTL_LIBCFS_TYPE)
 126 #define IOC_LIBCFS_DEL_ROUTE               _IOWR('e', 53, IOCTL_LIBCFS_TYPE)
 127 #define IOC_LIBCFS_GET_ROUTE               _IOWR('e', 54, IOCTL_LIBCFS_TYPE)
 128 #define IOC_LIBCFS_NOTIFY_ROUTER           _IOWR('e', 55, IOCTL_LIBCFS_TYPE)
 129 #define IOC_LIBCFS_UNCONFIGURE             _IOWR('e', 56, IOCTL_LIBCFS_TYPE)
 130 #define IOC_LIBCFS_PORTALS_COMPATIBILITY   _IOWR('e', 57, IOCTL_LIBCFS_TYPE)
 131 #define IOC_LIBCFS_LNET_DIST               _IOWR('e', 58, IOCTL_LIBCFS_TYPE)
 132 #define IOC_LIBCFS_CONFIGURE               _IOWR('e', 59, IOCTL_LIBCFS_TYPE)
 133 #define IOC_LIBCFS_TESTPROTOCOMPAT         _IOWR('e', 60, IOCTL_LIBCFS_TYPE)
 134 #define IOC_LIBCFS_PING                    _IOWR('e', 61, IOCTL_LIBCFS_TYPE)
 135 #define IOC_LIBCFS_DEBUG_PEER              _IOWR('e', 62, IOCTL_LIBCFS_TYPE)
 136 #define IOC_LIBCFS_LNETST                  _IOWR('e', 63, IOCTL_LIBCFS_TYPE)
 137 /* lnd ioctls */
 138 #define IOC_LIBCFS_REGISTER_MYNID          _IOWR('e', 70, IOCTL_LIBCFS_TYPE)
 139 #define IOC_LIBCFS_CLOSE_CONNECTION        _IOWR('e', 71, IOCTL_LIBCFS_TYPE)
 140 #define IOC_LIBCFS_PUSH_CONNECTION         _IOWR('e', 72, IOCTL_LIBCFS_TYPE)
 141 #define IOC_LIBCFS_GET_CONN                _IOWR('e', 73, IOCTL_LIBCFS_TYPE)
 142 #define IOC_LIBCFS_DEL_PEER                _IOWR('e', 74, IOCTL_LIBCFS_TYPE)
 143 #define IOC_LIBCFS_ADD_PEER                _IOWR('e', 75, IOCTL_LIBCFS_TYPE)
 144 #define IOC_LIBCFS_GET_PEER                _IOWR('e', 76, IOCTL_LIBCFS_TYPE)
 145 #define IOC_LIBCFS_GET_TXDESC              _IOWR('e', 77, IOCTL_LIBCFS_TYPE)
 146 #define IOC_LIBCFS_ADD_INTERFACE           _IOWR('e', 78, IOCTL_LIBCFS_TYPE)
 147 #define IOC_LIBCFS_DEL_INTERFACE           _IOWR('e', 79, IOCTL_LIBCFS_TYPE)
 148 #define IOC_LIBCFS_GET_INTERFACE           _IOWR('e', 80, IOCTL_LIBCFS_TYPE)
 149
 150 #define IOC_LIBCFS_MAX_NR                             80
 151
 152 static inline int libcfs_ioctl_packlen(struct libcfs_ioctl_data *data)
 153 {
 154         int len = sizeof(*data);
 155         len += cfs_size_round(data->ioc_inllen1);
 156         len += cfs_size_round(data->ioc_inllen2);
 157         return len;
 158 }
 159
 160 static inline int libcfs_ioctl_is_invalid(struct libcfs_ioctl_data *data)
 161 {
 162         if (data->ioc_len > (1<<30)) {
 163                 CERROR ("LIBCFS ioctl: ioc_len larger than 1<<30\n");
 164                 return 1;
 165         }
 166         if (data->ioc_inllen1 > (1<<30)) {
 167                 CERROR ("LIBCFS ioctl: ioc_inllen1 larger than 1<<30\n");
 168                 return 1;
 169         }
 170         if (data->ioc_inllen2 > (1<<30)) {
 171                 CERROR ("LIBCFS ioctl: ioc_inllen2 larger than 1<<30\n");
 172                 return 1;
 173         }
 174         if (data->ioc_inlbuf1 && !data->ioc_inllen1) {
 175                 CERROR ("LIBCFS ioctl: inlbuf1 pointer but 0 length\n");
 176                 return 1;
 177         }
 178         if (data->ioc_inlbuf2 && !data->ioc_inllen2) {
 179                 CERROR ("LIBCFS ioctl: inlbuf2 pointer but 0 length\n");
 180                 return 1;
 181         }
 182         if (data->ioc_pbuf1 && !data->ioc_plen1) {
 183                 CERROR ("LIBCFS ioctl: pbuf1 pointer but 0 length\n");
 184                 return 1;
 185         }
 186         if (data->ioc_pbuf2 && !data->ioc_plen2) {
 187                 CERROR ("LIBCFS ioctl: pbuf2 pointer but 0 length\n");
 188                 return 1;
 189         }
 190         if (data->ioc_plen1 && !data->ioc_pbuf1) {
 191                 CERROR ("LIBCFS ioctl: plen1 nonzero but no pbuf1 pointer\n");
 192                 return 1;
 193         }
 194         if (data->ioc_plen2 && !data->ioc_pbuf2) {
 195                 CERROR ("LIBCFS ioctl: plen2 nonzero but no pbuf2 pointer\n");
 196                 return 1;
 197         }
 198         if ((__u32)libcfs_ioctl_packlen(data) != data->ioc_len ) {
 199                 CERROR ("LIBCFS ioctl: packlen != ioc_len\n");
 200                 return 1;
 201         }
 202         if (data->ioc_inllen1 &&
 203             data->ioc_bulk[data->ioc_inllen1 - 1] != '\0') {
 204                 CERROR ("LIBCFS ioctl: inlbuf1 not 0 terminated\n");
 205                 return 1;
 206         }
 207         if (data->ioc_inllen2 &&
 208             data->ioc_bulk[cfs_size_round(data->ioc_inllen1) +
 209                            data->ioc_inllen2 - 1] != '\0') {
 210                 CERROR ("LIBCFS ioctl: inlbuf2 not 0 terminated\n");
 211                 return 1;
 212         }
 213         return 0;
 214 }
 215
 216 #ifdef __KERNEL__
 217
 218 extern int libcfs_register_ioctl(struct libcfs_ioctl_handler *hand);
 219 extern int libcfs_deregister_ioctl(struct libcfs_ioctl_handler *hand);
 220 extern int libcfs_ioctl_getdata(char *buf, char *end, void *arg);
 221 extern int libcfs_ioctl_popdata(void *arg, void *buf, int size);
 222
 223 #endif
 224
 225 #endif /* __LIBCFS_IOCTL_H__ */