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