lustre/include/linux/lustre_cfg.h

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  *
   4  *  Copyright (C) 2001 Cluster File Systems, Inc. <braam@clusterfs.com>
   5  *
   6  *   This file is part of Lustre, http://www.lustre.org.
   7  *
   8  *   Lustre is free software; you can redistribute it and/or
   9  *   modify it under the terms of version 2 of the GNU General Public
  10  *   License as published by the Free Software Foundation.
  11  *
  12  *   Lustre is distributed in the hope that it will be useful,
  13  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  *   GNU General Public License for more details.
  16  *
  17  *   You should have received a copy of the GNU General Public License
  18  *   along with Lustre; if not, write to the Free Software
  19  *   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  20  *
  21  */
  22
  23 #ifndef _LUSTRE_CFG_H
  24 #define _LUSTRE_CFG_H
  25
  26 /*
  27  * 1cf6
  28  * lcfG
  29  */
  30 #define LUSTRE_CFG_VERSION 0x1cf60001
  31 #define LUSTRE_CFG_MAX_BUFCOUNT 8
  32
  33 #define LCFG_HDR_SIZE(count) \
  34     size_round(offsetof (struct lustre_cfg, lcfg_buflens[(count)]))
  35
  36 /* If not LCFG_REQUIRED, we can ignore this cmd and go on. */
  37 #define LCFG_REQUIRED         0x0001000
  38
  39 enum lcfg_command_type {
  40         LCFG_ATTACH         = 0x00cf001,
  41         LCFG_DETACH         = 0x00cf002,
  42         LCFG_SETUP          = 0x00cf003,
  43         LCFG_CLEANUP        = 0x00cf004,
  44         LCFG_ADD_UUID       = 0x00cf005,
  45         LCFG_DEL_UUID       = 0x00cf006,
  46         LCFG_MOUNTOPT       = 0x00cf007,
  47         LCFG_DEL_MOUNTOPT   = 0x00cf008,
  48         LCFG_SET_TIMEOUT    = 0x00cf009,
  49         LCFG_SET_UPCALL     = 0x00cf00a,
  50         LCFG_ADD_CONN       = 0x00cf00b,
  51         LCFG_DEL_CONN       = 0x00cf00c,
  52         LCFG_LOV_ADD_OBD    = 0x00cf00d,
  53         LCFG_LOV_DEL_OBD    = 0x00cf00e,
  54         LCFG_PARAM          = 0x00ce00f,
  55         LCFG_MARKER         = 0x00ce010,
  56         LCFG_LOG_START      = 0x00ce011,
  57         LCFG_LOG_END        = 0x00ce012,
  58         LCFG_LOV_ADD_INA    = 0x00ce013,
  59         LCFG_ADD_MDC        = 0x00cf014,
  60         LCFG_DEL_MDC        = 0x00cf015,
  61 };
  62
  63 struct lustre_cfg_bufs {
  64         void    *lcfg_buf[LUSTRE_CFG_MAX_BUFCOUNT];
  65         uint32_t lcfg_buflen[LUSTRE_CFG_MAX_BUFCOUNT];
  66         uint32_t lcfg_bufcount;
  67 };
  68
  69 /* Mountconf transitional hack, should go away after 1.6 */
  70 #define LCFG_FLG_MOUNTCONF 0x400
  71
  72 struct lustre_cfg {
  73         uint32_t lcfg_version;
  74         uint32_t lcfg_command;
  75
  76         uint32_t lcfg_num;
  77         uint32_t lcfg_flags;
  78         uint64_t lcfg_nid;
  79         uint32_t lcfg_nal;                      /* not used any more */
  80
  81         uint32_t lcfg_bufcount;
  82         uint32_t lcfg_buflens[0];
  83 };
  84
  85 #define LUSTRE_CFG_BUFLEN(lcfg, idx)            \
  86         ((lcfg)->lcfg_bufcount <= (idx)         \
  87          ? 0                                    \
  88          : (lcfg)->lcfg_buflens[(idx)])
  89
  90 static inline void lustre_cfg_bufs_set(struct lustre_cfg_bufs *bufs,
  91                                        uint32_t                index,
  92                                        void                   *buf,
  93                                        uint32_t                buflen)
  94 {
  95         if (index >= LUSTRE_CFG_MAX_BUFCOUNT)
  96                 return;
  97         if (bufs == NULL)
  98                 return;
  99
 100         if (bufs->lcfg_bufcount <= index)
 101                 bufs->lcfg_bufcount = index + 1;
 102
 103         bufs->lcfg_buf[index]    = buf;
 104         bufs->lcfg_buflen[index] = buflen;
 105 }
 106
 107 static inline void lustre_cfg_bufs_set_string(struct lustre_cfg_bufs *bufs,
 108                                               uint32_t index,
 109                                               char *str)
 110 {
 111         lustre_cfg_bufs_set(bufs, index, str, str ? strlen(str) + 1 : 0);
 112 }
 113
 114 static inline void lustre_cfg_bufs_reset(struct lustre_cfg_bufs *bufs, char *name)
 115 {
 116         memset((bufs), 0, sizeof(*bufs));
 117         if (name)
 118                 lustre_cfg_bufs_set_string(bufs, 0, name);
 119 }
 120
 121 static inline void *lustre_cfg_buf(struct lustre_cfg *lcfg, int index)
 122 {
 123         int i;
 124         int offset;
 125         int bufcount;
 126         LASSERT (lcfg != NULL);
 127         LASSERT (index >= 0);
 128
 129         bufcount = lcfg->lcfg_bufcount;
 130         if (index >= bufcount)
 131                 return NULL;
 132
 133         offset = LCFG_HDR_SIZE(lcfg->lcfg_bufcount);
 134         for (i = 0; i < index; i++)
 135                 offset += size_round(lcfg->lcfg_buflens[i]);
 136         return (char *)lcfg + offset;
 137 }
 138
 139 static inline void lustre_cfg_bufs_init(struct lustre_cfg_bufs *bufs,
 140                                         struct lustre_cfg *lcfg)
 141 {
 142         int i;
 143         bufs->lcfg_bufcount = lcfg->lcfg_bufcount;
 144         for (i = 0; i < bufs->lcfg_bufcount; i++) {
 145                 bufs->lcfg_buflen[i] = lcfg->lcfg_buflens[i];
 146                 bufs->lcfg_buf[i] = lustre_cfg_buf(lcfg, i);
 147         }
 148 }
 149
 150 static inline char *lustre_cfg_string(struct lustre_cfg *lcfg, int index)
 151 {
 152         char *s;
 153
 154         if (!lcfg->lcfg_buflens[index])
 155                 return NULL;
 156
 157         s = lustre_cfg_buf(lcfg, index);
 158         if (!s)
 159                 return NULL;
 160
 161         /* make sure it's NULL terminated, even if this kills a char
 162          * of data.  Try to use the padding first though.
 163          */
 164         if (s[lcfg->lcfg_buflens[index] - 1] != '\0') {
 165                 int last = min((int)lcfg->lcfg_buflens[index],
 166                                size_round(lcfg->lcfg_buflens[index]) - 1);
 167                 s[last] = '\0';
 168                 CWARN("Truncating buf %d to '%s'\n", index, s);
 169         }
 170         return s;
 171 }
 172
 173 static inline int lustre_cfg_len(uint32_t bufcount, uint32_t *buflens)
 174 {
 175         int i;
 176         int len;
 177         ENTRY;
 178
 179         len = LCFG_HDR_SIZE(bufcount);
 180         for (i = 0; i < bufcount; i++)
 181                 len += size_round(buflens[i]);
 182
 183         RETURN(size_round(len));
 184 }
 185
 186
 187 #include <linux/obd_support.h>
 188
 189 static inline struct lustre_cfg *lustre_cfg_new(int cmd,
 190                                                 struct lustre_cfg_bufs *bufs)
 191 {
 192         struct lustre_cfg *lcfg;
 193         char *ptr;
 194         int i;
 195
 196         ENTRY;
 197
 198         OBD_ALLOC(lcfg, lustre_cfg_len(bufs->lcfg_bufcount,
 199                                        bufs->lcfg_buflen));
 200         if (!lcfg)
 201                 RETURN(lcfg);
 202
 203         lcfg->lcfg_version = LUSTRE_CFG_VERSION;
 204         lcfg->lcfg_command = cmd;
 205         lcfg->lcfg_bufcount = bufs->lcfg_bufcount;
 206
 207         ptr = (char *)lcfg + LCFG_HDR_SIZE(lcfg->lcfg_bufcount);
 208         for (i = 0; i < lcfg->lcfg_bufcount; i++) {
 209                 lcfg->lcfg_buflens[i] = bufs->lcfg_buflen[i];
 210                 LOGL((char *)bufs->lcfg_buf[i], bufs->lcfg_buflen[i], ptr);
 211         }
 212         RETURN(lcfg);
 213 }
 214
 215 static inline void lustre_cfg_free(struct lustre_cfg *lcfg)
 216 {
 217         int len;
 218
 219         len = lustre_cfg_len(lcfg->lcfg_bufcount, lcfg->lcfg_buflens);
 220
 221         OBD_FREE(lcfg, len);
 222         EXIT;
 223         return;
 224 }
 225
 226 static inline int lustre_cfg_sanity_check(void *buf, int len)
 227 {
 228         struct lustre_cfg *lcfg = (struct lustre_cfg *)buf;
 229         ENTRY;
 230         if (!lcfg)
 231                 RETURN(-EINVAL);
 232
 233         /* check that the first bits of the struct are valid */
 234         if (len < LCFG_HDR_SIZE(0))
 235                 RETURN(-EINVAL);
 236
 237         if (lcfg->lcfg_version != LUSTRE_CFG_VERSION)
 238                 RETURN(-EINVAL);
 239
 240         if (lcfg->lcfg_bufcount >= LUSTRE_CFG_MAX_BUFCOUNT)
 241                 RETURN(-EINVAL);
 242
 243         /* check that the buflens are valid */
 244         if (len < LCFG_HDR_SIZE(lcfg->lcfg_bufcount))
 245                 RETURN(-EINVAL);
 246
 247         /* make sure all the pointers point inside the data */
 248         if (len < lustre_cfg_len(lcfg->lcfg_bufcount, lcfg->lcfg_buflens))
 249                 RETURN(-EINVAL);
 250
 251         RETURN(0);
 252 }
 253
 254 #endif // _LUSTRE_CFG_H