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