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