lustre/include/lustre_cfg.h

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  *
   4  * GPL HEADER START
   5  *
   6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License version 2 only,
  10  * as published by the Free Software Foundation.
  11  *
  12  * This program is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * General Public License version 2 for more details (a copy is included
  16  * in the LICENSE file that accompanied this code).
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * version 2 along with this program; If not, see
  20  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
  21  *
  22  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  23  * CA 95054 USA or visit www.sun.com if you need additional information or
  24  * have any questions.
  25  *
  26  * GPL HEADER END
  27  */
  28 /*
  29  * Copyright  2008 Sun Microsystems, Inc. All rights reserved
  30  * Use is subject to license terms.
  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,
  63         LCFG_DETACH             = 0x00cf002,
  64         LCFG_SETUP              = 0x00cf003,
  65         LCFG_CLEANUP            = 0x00cf004,
  66         LCFG_ADD_UUID           = 0x00cf005,
  67         LCFG_DEL_UUID           = 0x00cf006,
  68         LCFG_MOUNTOPT           = 0x00cf007,
  69         LCFG_DEL_MOUNTOPT       = 0x00cf008,
  70         LCFG_SET_TIMEOUT        = 0x00cf009,
  71         LCFG_SET_UPCALL         = 0x00cf00a,
  72         LCFG_ADD_CONN           = 0x00cf00b,
  73         LCFG_DEL_CONN           = 0x00cf00c,
  74         LCFG_LOV_ADD_OBD        = 0x00cf00d,
  75         LCFG_LOV_DEL_OBD        = 0x00cf00e,
  76         LCFG_PARAM              = 0x00cf00f,
  77         LCFG_MARKER             = 0x00cf010,
  78         LCFG_LOG_START          = 0x00ce011,
  79         LCFG_LOG_END            = 0x00ce012,
  80         LCFG_LOV_ADD_INA        = 0x00ce013,
  81         LCFG_ADD_MDC            = 0x00cf014,
  82         LCFG_DEL_MDC            = 0x00cf015,
  83         LCFG_SPTLRPC_CONF       = 0x00ce016,
  84         LCFG_POOL_NEW           = 0x00ce020,
  85         LCFG_POOL_ADD           = 0x00ce021,
  86         LCFG_POOL_REM           = 0x00ce022,
  87         LCFG_POOL_DEL           = 0x00ce023,
  88         LCFG_SET_LDLM_TIMEOUT   = 0x00ce030,
  89 };
  90
  91 struct lustre_cfg_bufs {
  92         void    *lcfg_buf[LUSTRE_CFG_MAX_BUFCOUNT];
  93         __u32    lcfg_buflen[LUSTRE_CFG_MAX_BUFCOUNT];
  94         __u32    lcfg_bufcount;
  95 };
  96
  97 struct lustre_cfg {
  98         __u32 lcfg_version;
  99         __u32 lcfg_command;
 100
 101         __u32 lcfg_num;
 102         __u32 lcfg_flags;
 103         __u64 lcfg_nid;
 104         __u32 lcfg_nal;                      /* not used any more */
 105
 106         __u32 lcfg_bufcount;
 107         __u32 lcfg_buflens[0];
 108 };
 109
 110 enum cfg_record_type {
 111         PORTALS_CFG_TYPE = 1,
 112         LUSTRE_CFG_TYPE = 123,
 113 };
 114
 115 #define LUSTRE_CFG_BUFLEN(lcfg, idx)            \
 116         ((lcfg)->lcfg_bufcount <= (idx)         \
 117          ? 0                                    \
 118          : (lcfg)->lcfg_buflens[(idx)])
 119
 120 static inline void lustre_cfg_bufs_set(struct lustre_cfg_bufs *bufs,
 121                                        __u32                   index,
 122                                        void                   *buf,
 123                                        __u32                   buflen)
 124 {
 125         if (index >= LUSTRE_CFG_MAX_BUFCOUNT)
 126                 return;
 127         if (bufs == NULL)
 128                 return;
 129
 130         if (bufs->lcfg_bufcount <= index)
 131                 bufs->lcfg_bufcount = index + 1;
 132
 133         bufs->lcfg_buf[index]    = buf;
 134         bufs->lcfg_buflen[index] = buflen;
 135 }
 136
 137 static inline void lustre_cfg_bufs_set_string(struct lustre_cfg_bufs *bufs,
 138                                               __u32 index,
 139                                               char *str)
 140 {
 141         lustre_cfg_bufs_set(bufs, index, str, str ? strlen(str) + 1 : 0);
 142 }
 143
 144 static inline void lustre_cfg_bufs_reset(struct lustre_cfg_bufs *bufs, char *name)
 145 {
 146         memset((bufs), 0, sizeof(*bufs));
 147         if (name)
 148                 lustre_cfg_bufs_set_string(bufs, 0, name);
 149 }
 150
 151 static inline void *lustre_cfg_buf(struct lustre_cfg *lcfg, int index)
 152 {
 153         int i;
 154         int offset;
 155         int bufcount;
 156         LASSERT (lcfg != NULL);
 157         LASSERT (index >= 0);
 158
 159         bufcount = lcfg->lcfg_bufcount;
 160         if (index >= bufcount)
 161                 return NULL;
 162
 163         offset = LCFG_HDR_SIZE(lcfg->lcfg_bufcount);
 164         for (i = 0; i < index; i++)
 165                 offset += cfs_size_round(lcfg->lcfg_buflens[i]);
 166         return (char *)lcfg + offset;
 167 }
 168
 169 static inline void lustre_cfg_bufs_init(struct lustre_cfg_bufs *bufs,
 170                                         struct lustre_cfg *lcfg)
 171 {
 172         int i;
 173         bufs->lcfg_bufcount = lcfg->lcfg_bufcount;
 174         for (i = 0; i < bufs->lcfg_bufcount; i++) {
 175                 bufs->lcfg_buflen[i] = lcfg->lcfg_buflens[i];
 176                 bufs->lcfg_buf[i] = lustre_cfg_buf(lcfg, i);
 177         }
 178 }
 179
 180 static inline char *lustre_cfg_string(struct lustre_cfg *lcfg, int index)
 181 {
 182         char *s;
 183
 184         if (!lcfg->lcfg_buflens[index])
 185                 return NULL;
 186
 187         s = lustre_cfg_buf(lcfg, index);
 188         if (!s)
 189                 return NULL;
 190
 191         /* make sure it's NULL terminated, even if this kills a char
 192          * of data.  Try to use the padding first though.
 193          */
 194         if (s[lcfg->lcfg_buflens[index] - 1] != '\0') {
 195                 int last = min((int)lcfg->lcfg_buflens[index],
 196                                cfs_size_round(lcfg->lcfg_buflens[index]) - 1);
 197                 char lost = s[last];
 198                 s[last] = '\0';
 199                 if (lost != '\0') {
 200                         CWARN("Truncated buf %d to '%s' (lost '%c'...)\n",
 201                               index, s, lost);
 202                 }
 203         }
 204         return s;
 205 }
 206
 207 static inline int lustre_cfg_len(__u32 bufcount, __u32 *buflens)
 208 {
 209         int i;
 210         int len;
 211         ENTRY;
 212
 213         len = LCFG_HDR_SIZE(bufcount);
 214         for (i = 0; i < bufcount; i++)
 215                 len += cfs_size_round(buflens[i]);
 216
 217         RETURN(cfs_size_round(len));
 218 }
 219
 220
 221 #include <obd_support.h>
 222
 223 static inline struct lustre_cfg *lustre_cfg_new(int cmd,
 224                                                 struct lustre_cfg_bufs *bufs)
 225 {
 226         struct lustre_cfg *lcfg;
 227         char *ptr;
 228         int i;
 229
 230         ENTRY;
 231
 232         OBD_ALLOC(lcfg, lustre_cfg_len(bufs->lcfg_bufcount,
 233                                        bufs->lcfg_buflen));
 234         if (!lcfg)
 235                 RETURN(ERR_PTR(-ENOMEM));
 236
 237         lcfg->lcfg_version = LUSTRE_CFG_VERSION;
 238         lcfg->lcfg_command = cmd;
 239         lcfg->lcfg_bufcount = bufs->lcfg_bufcount;
 240
 241         ptr = (char *)lcfg + LCFG_HDR_SIZE(lcfg->lcfg_bufcount);
 242         for (i = 0; i < lcfg->lcfg_bufcount; i++) {
 243                 lcfg->lcfg_buflens[i] = bufs->lcfg_buflen[i];
 244                 LOGL((char *)bufs->lcfg_buf[i], bufs->lcfg_buflen[i], ptr);
 245         }
 246         RETURN(lcfg);
 247 }
 248
 249 static inline void lustre_cfg_free(struct lustre_cfg *lcfg)
 250 {
 251         int len;
 252
 253         len = lustre_cfg_len(lcfg->lcfg_bufcount, lcfg->lcfg_buflens);
 254
 255         OBD_FREE(lcfg, len);
 256         EXIT;
 257         return;
 258 }
 259
 260 static inline int lustre_cfg_sanity_check(void *buf, int len)
 261 {
 262         struct lustre_cfg *lcfg = (struct lustre_cfg *)buf;
 263         ENTRY;
 264         if (!lcfg)
 265                 RETURN(-EINVAL);
 266
 267         /* check that the first bits of the struct are valid */
 268         if (len < LCFG_HDR_SIZE(0))
 269                 RETURN(-EINVAL);
 270
 271         if (lcfg->lcfg_version != LUSTRE_CFG_VERSION)
 272                 RETURN(-EINVAL);
 273
 274         if (lcfg->lcfg_bufcount >= LUSTRE_CFG_MAX_BUFCOUNT)
 275                 RETURN(-EINVAL);
 276
 277         /* check that the buflens are valid */
 278         if (len < LCFG_HDR_SIZE(lcfg->lcfg_bufcount))
 279                 RETURN(-EINVAL);
 280
 281         /* make sure all the pointers point inside the data */
 282         if (len < lustre_cfg_len(lcfg->lcfg_bufcount, lcfg->lcfg_buflens))
 283                 RETURN(-EINVAL);
 284
 285         RETURN(0);
 286 }
 287
 288 #include <lustre/lustre_user.h>
 289
 290 #define INVALID_UID     (-1)
 291
 292 /** @} cfg */
 293
 294 #endif // _LUSTRE_CFG_H