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