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