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