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