lustre/include/uapi/linux/lustre_cfg.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.gnu.org/licenses/gpl-2.0.html
  19  *
  20  * GPL HEADER END
  21  */
  22 /*
  23  * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
  24  * Use is subject to license terms.
  25  *
  26  * Copyright (c) 2012, 2014, Intel Corporation.
  27  */
  28 /*
  29  * This file is part of Lustre, http://www.lustre.org/
  30  * Lustre is a trademark of Sun Microsystems, Inc.
  31  */
  32
  33 #ifndef _UAPI_LUSTRE_CFG_H
  34 #define _UAPI_LUSTRE_CFG_H
  35
  36 #include <linux/kernel.h>
  37 #include <lustre/lustre_user.h>
  38
  39 /* Handle older distros */
  40 #ifndef __ALIGN_KERNEL
  41 # define __ALIGN_KERNEL(x, a)           __ALIGN_KERNEL_MASK(x, (typeof(x))(a) - 1)
  42 # define __ALIGN_KERNEL_MASK(x, mask)   (((x) + (mask)) & ~(mask))
  43 #endif
  44
  45 /** \defgroup cfg cfg
  46  *
  47  * @{
  48  */
  49
  50 /*
  51  * 1cf6
  52  * lcfG
  53  */
  54 #define LUSTRE_CFG_VERSION 0x1cf60001
  55 #define LUSTRE_CFG_MAX_BUFCOUNT 8
  56
  57 #define LCFG_HDR_SIZE(count) \
  58         __ALIGN_KERNEL(offsetof(struct lustre_cfg, lcfg_buflens[(count)]), 8)
  59
  60 /** If the LCFG_REQUIRED bit is set in a configuration command,
  61  * then the client is required to understand this parameter
  62  * in order to mount the filesystem. If it does not understand
  63  * a REQUIRED command the client mount will fail.
  64  */
  65 #define LCFG_REQUIRED   0x0001000
  66
  67 enum lcfg_command_type {
  68         LCFG_ATTACH               = 0x00cf001, /**< create a new obd instance */
  69         LCFG_DETACH               = 0x00cf002, /**< destroy obd instance */
  70         LCFG_SETUP                = 0x00cf003, /**< call type-specific setup */
  71         LCFG_CLEANUP              = 0x00cf004, /**< call type-specific cleanup
  72                                                  */
  73         LCFG_ADD_UUID             = 0x00cf005, /**< add a nid to a niduuid */
  74         LCFG_DEL_UUID             = 0x00cf006, /**< remove a nid from
  75                                                  *  a niduuid
  76                                                  */
  77         LCFG_MOUNTOPT             = 0x00cf007, /**< create a profile
  78                                                  * (mdc, osc)
  79                                                  */
  80         LCFG_DEL_MOUNTOPT         = 0x00cf008, /**< destroy a profile */
  81         LCFG_SET_TIMEOUT          = 0x00cf009, /**< set obd_timeout */
  82         LCFG_SET_UPCALL           = 0x00cf00a, /**< deprecated */
  83         LCFG_ADD_CONN             = 0x00cf00b, /**< add a failover niduuid to
  84                                                  *  an obd
  85                                                  */
  86         LCFG_DEL_CONN             = 0x00cf00c, /**< remove a failover niduuid */
  87         LCFG_LOV_ADD_OBD          = 0x00cf00d, /**< add an osc to a lov */
  88         LCFG_LOV_DEL_OBD          = 0x00cf00e, /**< remove an osc from a lov */
  89         LCFG_PARAM                = 0x00cf00f, /**< set a proc parameter */
  90         LCFG_MARKER               = 0x00cf010, /**< metadata about next
  91                                                  *  cfg rec
  92                                                  */
  93         LCFG_LOG_START            = 0x00ce011, /**< mgc only, process a
  94                                                  *  cfg log
  95                                                  */
  96         LCFG_LOG_END              = 0x00ce012, /**< stop processing updates */
  97         LCFG_LOV_ADD_INA          = 0x00ce013, /**< like LOV_ADD_OBD,
  98                                                  *  inactive
  99                                                  */
 100         LCFG_ADD_MDC              = 0x00cf014, /**< add an mdc to a lmv */
 101         LCFG_DEL_MDC              = 0x00cf015, /**< remove an mdc from a lmv */
 102         LCFG_SPTLRPC_CONF         = 0x00ce016, /**< security */
 103         LCFG_POOL_NEW             = 0x00ce020, /**< create an ost pool name */
 104         LCFG_POOL_ADD             = 0x00ce021, /**< add an ost to a pool */
 105         LCFG_POOL_REM             = 0x00ce022, /**< remove an ost from a pool */
 106         LCFG_POOL_DEL             = 0x00ce023, /**< destroy an ost pool name */
 107         LCFG_SET_LDLM_TIMEOUT     = 0x00ce030, /**< set ldlm_timeout */
 108         LCFG_PRE_CLEANUP          = 0x00cf031, /**< call type-specific pre
 109                                                  * cleanup cleanup
 110                                                  */
 111         LCFG_SET_PARAM            = 0x00ce032, /**< use set_param syntax to set
 112                                                  * a proc parameters
 113                                                  */
 114         LCFG_NODEMAP_ADD          = 0x00ce040, /**< create a cluster */
 115         LCFG_NODEMAP_DEL          = 0x00ce041, /**< destroy a cluster */
 116         LCFG_NODEMAP_ADD_RANGE    = 0x00ce042, /**< add a nid range */
 117         LCFG_NODEMAP_DEL_RANGE    = 0x00ce043, /**< delete an nid range */
 118         LCFG_NODEMAP_ADD_UIDMAP   = 0x00ce044, /**< add a uidmap */
 119         LCFG_NODEMAP_DEL_UIDMAP   = 0x00ce045, /**< delete a uidmap */
 120         LCFG_NODEMAP_ADD_GIDMAP   = 0x00ce046, /**< add a gidmap */
 121         LCFG_NODEMAP_DEL_GIDMAP   = 0x00ce047, /**< delete a gidmap */
 122         LCFG_NODEMAP_ACTIVATE     = 0x00ce048, /**< activate cluster
 123                                                  *  id mapping
 124                                                  */
 125         LCFG_NODEMAP_ADMIN        = 0x00ce049, /**< allow cluster to use id 0 */
 126         LCFG_NODEMAP_TRUSTED      = 0x00ce050, /**< trust a clusters ids */
 127         LCFG_NODEMAP_SQUASH_UID   = 0x00ce051, /**< default map uid */
 128         LCFG_NODEMAP_SQUASH_GID   = 0x00ce052, /**< default map gid */
 129         LCFG_NODEMAP_ADD_SHKEY    = 0x00ce053, /**< add shared key to cluster */
 130         LCFG_NODEMAP_DEL_SHKEY    = 0x00ce054, /**< delete shared key from
 131                                                  *  cluster
 132                                                  */
 133         LCFG_NODEMAP_TEST_NID     = 0x00ce055, /**< test for nodemap
 134                                                  *  membership
 135                                                  */
 136         LCFG_NODEMAP_TEST_ID      = 0x00ce056, /**< test uid/gid mapping */
 137         LCFG_NODEMAP_SET_FILESET  = 0x00ce057, /**< set fileset */
 138         LCFG_NODEMAP_DENY_UNKNOWN = 0x00ce058, /**< deny squashed nodemap
 139                                                  *  users
 140                                                  */
 141         LCFG_NODEMAP_MAP_MODE     = 0x00ce059, /**< set the mapping mode */
 142 };
 143
 144 struct lustre_cfg_bufs {
 145         void  *lcfg_buf[LUSTRE_CFG_MAX_BUFCOUNT];
 146         __u32 lcfg_buflen[LUSTRE_CFG_MAX_BUFCOUNT];
 147         __u32 lcfg_bufcount;
 148 };
 149
 150 struct lustre_cfg {
 151         __u32 lcfg_version;
 152         __u32 lcfg_command;
 153
 154         __u32 lcfg_num;
 155         __u32 lcfg_flags;
 156         __u64 lcfg_nid;
 157         __u32 lcfg_nal;         /* not used any more */
 158
 159         __u32 lcfg_bufcount;
 160         __u32 lcfg_buflens[0];
 161 };
 162
 163 enum cfg_record_type {
 164         PORTALS_CFG_TYPE        = 1,
 165         LUSTRE_CFG_TYPE         = 123,
 166 };
 167
 168 #define LUSTRE_CFG_BUFLEN(lcfg, idx)                                    \
 169         ((lcfg)->lcfg_bufcount <= (idx) ? 0 : (lcfg)->lcfg_buflens[(idx)])
 170
 171 static inline void lustre_cfg_bufs_set(struct lustre_cfg_bufs *bufs,
 172                                        __u32 index, void *buf, __u32 buflen)
 173 {
 174         if (index >= LUSTRE_CFG_MAX_BUFCOUNT)
 175                 return;
 176
 177         if (!bufs)
 178                 return;
 179
 180         if (bufs->lcfg_bufcount <= index)
 181                 bufs->lcfg_bufcount = index + 1;
 182
 183         bufs->lcfg_buf[index] = buf;
 184         bufs->lcfg_buflen[index] = buflen;
 185 }
 186
 187 static inline void lustre_cfg_bufs_set_string(struct lustre_cfg_bufs *bufs,
 188                                               __u32 index, char *str)
 189 {
 190         lustre_cfg_bufs_set(bufs, index, str, str ? strlen(str) + 1 : 0);
 191 }
 192
 193 static inline void lustre_cfg_bufs_reset(struct lustre_cfg_bufs *bufs,
 194                                          char *name)
 195 {
 196         memset((bufs), 0, sizeof(*bufs));
 197         if (name)
 198                 lustre_cfg_bufs_set_string(bufs, 0, name);
 199 }
 200
 201 static inline void *lustre_cfg_buf(struct lustre_cfg *lcfg, __u32 index)
 202 {
 203         __u32 i;
 204         size_t offset;
 205         __u32 bufcount;
 206
 207         if (!lcfg)
 208                 return NULL;
 209
 210         bufcount = lcfg->lcfg_bufcount;
 211         if (index >= bufcount)
 212                 return NULL;
 213
 214         offset = LCFG_HDR_SIZE(lcfg->lcfg_bufcount);
 215         for (i = 0; i < index; i++)
 216                 offset += __ALIGN_KERNEL(lcfg->lcfg_buflens[i], 8);
 217         return (char *)lcfg + offset;
 218 }
 219
 220 static inline void lustre_cfg_bufs_init(struct lustre_cfg_bufs *bufs,
 221                                         struct lustre_cfg *lcfg)
 222 {
 223         __u32 i;
 224
 225         bufs->lcfg_bufcount = lcfg->lcfg_bufcount;
 226         for (i = 0; i < bufs->lcfg_bufcount; i++) {
 227                 bufs->lcfg_buflen[i] = lcfg->lcfg_buflens[i];
 228                 bufs->lcfg_buf[i] = lustre_cfg_buf(lcfg, i);
 229         }
 230 }
 231
 232 static inline __u32 lustre_cfg_len(__u32 bufcount, __u32 *buflens)
 233 {
 234         __u32 i;
 235         __u32 len;
 236
 237         len = LCFG_HDR_SIZE(bufcount);
 238         for (i = 0; i < bufcount; i++)
 239                 len += __ALIGN_KERNEL(buflens[i], 8);
 240
 241         return __ALIGN_KERNEL(len, 8);
 242 }
 243
 244 static inline void lustre_cfg_init(struct lustre_cfg *lcfg, int cmd,
 245                                    struct lustre_cfg_bufs *bufs)
 246 {
 247         char *ptr;
 248         __u32 i;
 249
 250         lcfg->lcfg_version = LUSTRE_CFG_VERSION;
 251         lcfg->lcfg_command = cmd;
 252         lcfg->lcfg_bufcount = bufs->lcfg_bufcount;
 253
 254         ptr = (char *)lcfg + LCFG_HDR_SIZE(lcfg->lcfg_bufcount);
 255         for (i = 0; i < lcfg->lcfg_bufcount; i++) {
 256                 lcfg->lcfg_buflens[i] = bufs->lcfg_buflen[i];
 257                 if (bufs->lcfg_buf[i]) {
 258                         memcpy(ptr, bufs->lcfg_buf[i], bufs->lcfg_buflen[i]);
 259                         ptr += __ALIGN_KERNEL(bufs->lcfg_buflen[i], 8);
 260                 }
 261         }
 262 }
 263
 264 static inline int lustre_cfg_sanity_check(void *buf, size_t len)
 265 {
 266         struct lustre_cfg *lcfg = (struct lustre_cfg *)buf;
 267
 268         if (!lcfg)
 269                 return -EINVAL;
 270
 271         /* check that the first bits of the struct are valid */
 272         if (len < LCFG_HDR_SIZE(0))
 273                 return -EINVAL;
 274
 275         if (lcfg->lcfg_version != LUSTRE_CFG_VERSION)
 276                 return -EINVAL;
 277
 278         if (lcfg->lcfg_bufcount >= LUSTRE_CFG_MAX_BUFCOUNT)
 279                 return -EINVAL;
 280
 281         /* check that the buflens are valid */
 282         if (len < LCFG_HDR_SIZE(lcfg->lcfg_bufcount))
 283                 return -EINVAL;
 284
 285         /* make sure all the pointers point inside the data */
 286         if (len < lustre_cfg_len(lcfg->lcfg_bufcount, lcfg->lcfg_buflens))
 287                 return -EINVAL;
 288
 289         return 0;
 290 }
 291
 292 /** @} cfg */
 293
 294 #endif /* _UAPI_LUSTRE_CFG_H */