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 /*
  31  * This file is part of Lustre, http://www.lustre.org/
  32  * Lustre is a trademark of Sun Microsystems, Inc.
  33  */
  34
  35 #ifndef _LUSTRE_CFG_H
  36 #define _LUSTRE_CFG_H
  37
  38 /** \defgroup cfg cfg
  39  *
  40  * @{
  41  */
  42
  43 /*
  44  * 1cf6
  45  * lcfG
  46  */
  47 #define LUSTRE_CFG_VERSION 0x1cf60001
  48 #define LUSTRE_CFG_MAX_BUFCOUNT 8
  49
  50 #define LCFG_HDR_SIZE(count) \
  51     cfs_size_round(offsetof (struct lustre_cfg, lcfg_buflens[(count)]))
  52
  53 /** If the LCFG_REQUIRED bit is set in a configuration command,
  54  * then the client is required to understand this parameter
  55  * in order to mount the filesystem. If it does not understand
  56  * a REQUIRED command the client mount will fail. */
  57 #define LCFG_REQUIRED         0x0001000
  58
  59 enum lcfg_command_type {
  60         LCFG_ATTACH             = 0x00cf001, /**< create a new obd instance */
  61         LCFG_DETACH             = 0x00cf002, /**< destroy obd instance */
  62         LCFG_SETUP              = 0x00cf003, /**< call type-specific setup */
  63         LCFG_CLEANUP            = 0x00cf004, /**< call type-specific cleanup */
  64         LCFG_ADD_UUID           = 0x00cf005, /**< add a nid to a niduuid */
  65         LCFG_DEL_UUID           = 0x00cf006, /**< remove a nid from a niduuid */
  66         LCFG_MOUNTOPT           = 0x00cf007, /**< create a profile (mdc, osc) */
  67         LCFG_DEL_MOUNTOPT       = 0x00cf008, /**< destroy a profile */
  68         LCFG_SET_TIMEOUT        = 0x00cf009, /**< set obd_timeout */
  69         LCFG_SET_UPCALL         = 0x00cf00a, /**< deprecated */
  70         LCFG_ADD_CONN           = 0x00cf00b, /**< add a failover niduuid to an obd */
  71         LCFG_DEL_CONN           = 0x00cf00c, /**< remove a failover niduuid */
  72         LCFG_LOV_ADD_OBD        = 0x00cf00d, /**< add an osc to a lov */
  73         LCFG_LOV_DEL_OBD        = 0x00cf00e, /**< remove an osc from a lov */
  74         LCFG_PARAM              = 0x00cf00f, /**< set a proc parameter */
  75         LCFG_MARKER             = 0x00cf010, /**< metadata about next cfg rec */
  76         LCFG_LOG_START          = 0x00ce011, /**< mgc only, process a cfg log */
  77         LCFG_LOG_END            = 0x00ce012, /**< stop processing updates */
  78         LCFG_LOV_ADD_INA        = 0x00ce013, /**< like LOV_ADD_OBD, inactive */
  79         LCFG_ADD_MDC            = 0x00cf014, /**< add an mdc to a lmv */
  80         LCFG_DEL_MDC            = 0x00cf015, /**< remove an mdc from a lmv */
  81         LCFG_SPTLRPC_CONF       = 0x00ce016, /**< security */
  82         LCFG_POOL_NEW           = 0x00ce020, /**< create an ost pool name */
  83         LCFG_POOL_ADD           = 0x00ce021, /**< add an ost to a pool */
  84         LCFG_POOL_REM           = 0x00ce022, /**< remove an ost from a pool */
  85         LCFG_POOL_DEL           = 0x00ce023, /**< destroy an ost pool name */
  86         LCFG_SET_LDLM_TIMEOUT   = 0x00ce030, /**< set ldlm_timeout */
  87 };
  88
  89 struct lustre_cfg_bufs {
  90         void    *lcfg_buf[LUSTRE_CFG_MAX_BUFCOUNT];
  91         __u32    lcfg_buflen[LUSTRE_CFG_MAX_BUFCOUNT];
  92         __u32    lcfg_bufcount;
  93 };
  94
  95 struct lustre_cfg {
  96         __u32 lcfg_version;
  97         __u32 lcfg_command;
  98
  99         __u32 lcfg_num;
 100         __u32 lcfg_flags;
 101         __u64 lcfg_nid;
 102         __u32 lcfg_nal;         /* not used any more */
 103
 104         __u32 lcfg_bufcount;
 105         __u32 lcfg_buflens[0];
 106 };
 107
 108 enum cfg_record_type {
 109         PORTALS_CFG_TYPE = 1,
 110         LUSTRE_CFG_TYPE = 123,
 111 };
 112
 113 #define LUSTRE_CFG_BUFLEN(lcfg, idx)            \
 114         ((lcfg)->lcfg_bufcount <= (idx)         \
 115          ? 0                                    \
 116          : (lcfg)->lcfg_buflens[(idx)])
 117
 118 static inline void lustre_cfg_bufs_set(struct lustre_cfg_bufs *bufs,
 119                                        __u32                   index,
 120                                        void                   *buf,
 121                                        __u32                   buflen)
 122 {
 123         if (index >= LUSTRE_CFG_MAX_BUFCOUNT)
 124                 return;
 125         if (bufs == NULL)
 126                 return;
 127
 128         if (bufs->lcfg_bufcount <= index)
 129                 bufs->lcfg_bufcount = index + 1;
 130
 131         bufs->lcfg_buf[index]    = buf;
 132         bufs->lcfg_buflen[index] = buflen;
 133 }
 134
 135 static inline void lustre_cfg_bufs_set_string(struct lustre_cfg_bufs *bufs,
 136                                               __u32 index,
 137                                               char *str)
 138 {
 139         lustre_cfg_bufs_set(bufs, index, str, str ? strlen(str) + 1 : 0);
 140 }
 141
 142 static inline void lustre_cfg_bufs_reset(struct lustre_cfg_bufs *bufs, char *name)
 143 {
 144         memset((bufs), 0, sizeof(*bufs));
 145         if (name)
 146                 lustre_cfg_bufs_set_string(bufs, 0, name);
 147 }
 148
 149 static inline void *lustre_cfg_buf(struct lustre_cfg *lcfg, int index)
 150 {
 151         int i;
 152         int offset;
 153         int bufcount;
 154         LASSERT (lcfg != NULL);
 155         LASSERT (index >= 0);
 156
 157         bufcount = lcfg->lcfg_bufcount;
 158         if (index >= bufcount)
 159                 return NULL;
 160
 161         offset = LCFG_HDR_SIZE(lcfg->lcfg_bufcount);
 162         for (i = 0; i < index; i++)
 163                 offset += cfs_size_round(lcfg->lcfg_buflens[i]);
 164         return (char *)lcfg + offset;
 165 }
 166
 167 static inline void lustre_cfg_bufs_init(struct lustre_cfg_bufs *bufs,
 168                                         struct lustre_cfg *lcfg)
 169 {
 170         int i;
 171         bufs->lcfg_bufcount = lcfg->lcfg_bufcount;
 172         for (i = 0; i < bufs->lcfg_bufcount; i++) {
 173                 bufs->lcfg_buflen[i] = lcfg->lcfg_buflens[i];
 174                 bufs->lcfg_buf[i] = lustre_cfg_buf(lcfg, i);
 175         }
 176 }
 177
 178 static inline char *lustre_cfg_string(struct lustre_cfg *lcfg, int index)
 179 {
 180         char *s;
 181
 182         if (lcfg->lcfg_buflens[index] == 0)
 183                 return NULL;
 184
 185         s = lustre_cfg_buf(lcfg, index);
 186         if (s == NULL)
 187                 return NULL;
 188
 189         /*
 190          * make sure it's NULL terminated, even if this kills a char
 191          * of data.  Try to use the padding first though.
 192          */
 193         if (s[lcfg->lcfg_buflens[index] - 1] != '\0') {
 194                 int last = min((int)lcfg->lcfg_buflens[index],
 195                                cfs_size_round(lcfg->lcfg_buflens[index]) - 1);
 196                 char lost = s[last];
 197                 s[last] = '\0';
 198                 if (lost != '\0') {
 199                         CWARN("Truncated buf %d to '%s' (lost '%c'...)\n",
 200                               index, s, lost);
 201                 }
 202         }
 203         return s;
 204 }
 205
 206 static inline int lustre_cfg_len(__u32 bufcount, __u32 *buflens)
 207 {
 208         int i;
 209         int len;
 210         ENTRY;
 211
 212         len = LCFG_HDR_SIZE(bufcount);
 213         for (i = 0; i < bufcount; i++)
 214                 len += cfs_size_round(buflens[i]);
 215
 216         RETURN(cfs_size_round(len));
 217 }
 218
 219
 220 #include <obd_support.h>
 221
 222 static inline struct lustre_cfg *lustre_cfg_new(int cmd,
 223                                                 struct lustre_cfg_bufs *bufs)
 224 {
 225         struct lustre_cfg *lcfg;
 226         char *ptr;
 227         int i;
 228
 229         ENTRY;
 230
 231         OBD_ALLOC(lcfg, lustre_cfg_len(bufs->lcfg_bufcount,
 232                                        bufs->lcfg_buflen));
 233         if (!lcfg)
 234                 RETURN(ERR_PTR(-ENOMEM));
 235
 236         lcfg->lcfg_version = LUSTRE_CFG_VERSION;
 237         lcfg->lcfg_command = cmd;
 238         lcfg->lcfg_bufcount = bufs->lcfg_bufcount;
 239
 240         ptr = (char *)lcfg + LCFG_HDR_SIZE(lcfg->lcfg_bufcount);
 241         for (i = 0; i < lcfg->lcfg_bufcount; i++) {
 242                 lcfg->lcfg_buflens[i] = bufs->lcfg_buflen[i];
 243                 LOGL((char *)bufs->lcfg_buf[i], bufs->lcfg_buflen[i], ptr);
 244         }
 245         RETURN(lcfg);
 246 }
 247
 248 static inline void lustre_cfg_free(struct lustre_cfg *lcfg)
 249 {
 250         int len;
 251
 252         len = lustre_cfg_len(lcfg->lcfg_bufcount, lcfg->lcfg_buflens);
 253
 254         OBD_FREE(lcfg, len);
 255         EXIT;
 256         return;
 257 }
 258
 259 static inline int lustre_cfg_sanity_check(void *buf, int len)
 260 {
 261         struct lustre_cfg *lcfg = (struct lustre_cfg *)buf;
 262         ENTRY;
 263         if (!lcfg)
 264                 RETURN(-EINVAL);
 265
 266         /* check that the first bits of the struct are valid */
 267         if (len < LCFG_HDR_SIZE(0))
 268                 RETURN(-EINVAL);
 269
 270         if (lcfg->lcfg_version != LUSTRE_CFG_VERSION)
 271                 RETURN(-EINVAL);
 272
 273         if (lcfg->lcfg_bufcount >= LUSTRE_CFG_MAX_BUFCOUNT)
 274                 RETURN(-EINVAL);
 275
 276         /* check that the buflens are valid */
 277         if (len < LCFG_HDR_SIZE(lcfg->lcfg_bufcount))
 278                 RETURN(-EINVAL);
 279
 280         /* make sure all the pointers point inside the data */
 281         if (len < lustre_cfg_len(lcfg->lcfg_bufcount, lcfg->lcfg_buflens))
 282                 RETURN(-EINVAL);
 283
 284         RETURN(0);
 285 }
 286
 287 #include <lustre/lustre_user.h>
 288
 289 #define INVALID_UID     (-1)
 290
 291 /** @} cfg */
 292
 293 #endif // _LUSTRE_CFG_H