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