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_SET_LDLM_TIMEOUT   = 0x00cf011,
  71         LCFG_LOG_START          = 0x00ce011,
  72         LCFG_LOG_END            = 0x00ce012,
  73         LCFG_LOV_ADD_INA        = 0x00ce013,
  74         LCFG_ADD_MDC            = 0x00cf014,
  75         LCFG_DEL_MDC            = 0x00cf015,
  76         LCFG_SPTLRPC_CONF       = 0x00ce016,
  77         LCFG_POOL_NEW           = 0x00ce020,
  78         LCFG_POOL_ADD           = 0x00ce021,
  79         LCFG_POOL_REM           = 0x00ce022,
  80         LCFG_POOL_DEL           = 0x00ce023,
  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 enum cfg_record_type {
 106         PORTALS_CFG_TYPE = 1,
 107         LUSTRE_CFG_TYPE = 123,
 108 };
 109
 110 #define LUSTRE_CFG_BUFLEN(lcfg, idx)            \
 111         ((lcfg)->lcfg_bufcount <= (idx)         \
 112          ? 0                                    \
 113          : (lcfg)->lcfg_buflens[(idx)])
 114
 115 static inline void lustre_cfg_bufs_set(struct lustre_cfg_bufs *bufs,
 116                                        __u32                   index,
 117                                        void                   *buf,
 118                                        __u32                   buflen)
 119 {
 120         if (index >= LUSTRE_CFG_MAX_BUFCOUNT)
 121                 return;
 122         if (bufs == NULL)
 123                 return;
 124
 125         if (bufs->lcfg_bufcount <= index)
 126                 bufs->lcfg_bufcount = index + 1;
 127
 128         bufs->lcfg_buf[index]    = buf;
 129         bufs->lcfg_buflen[index] = buflen;
 130 }
 131
 132 static inline void lustre_cfg_bufs_set_string(struct lustre_cfg_bufs *bufs,
 133                                               __u32 index,
 134                                               char *str)
 135 {
 136         lustre_cfg_bufs_set(bufs, index, str, str ? strlen(str) + 1 : 0);
 137 }
 138
 139 static inline void lustre_cfg_bufs_reset(struct lustre_cfg_bufs *bufs, char *name)
 140 {
 141         memset((bufs), 0, sizeof(*bufs));
 142         if (name)
 143                 lustre_cfg_bufs_set_string(bufs, 0, name);
 144 }
 145
 146 static inline void *lustre_cfg_buf(struct lustre_cfg *lcfg, int index)
 147 {
 148         int i;
 149         int offset;
 150         int bufcount;
 151         LASSERT (lcfg != NULL);
 152         LASSERT (index >= 0);
 153
 154         bufcount = lcfg->lcfg_bufcount;
 155         if (index >= bufcount)
 156                 return NULL;
 157
 158         offset = LCFG_HDR_SIZE(lcfg->lcfg_bufcount);
 159         for (i = 0; i < index; i++)
 160                 offset += size_round(lcfg->lcfg_buflens[i]);
 161         return (char *)lcfg + offset;
 162 }
 163
 164 static inline void lustre_cfg_bufs_init(struct lustre_cfg_bufs *bufs,
 165                                         struct lustre_cfg *lcfg)
 166 {
 167         int i;
 168         bufs->lcfg_bufcount = lcfg->lcfg_bufcount;
 169         for (i = 0; i < bufs->lcfg_bufcount; i++) {
 170                 bufs->lcfg_buflen[i] = lcfg->lcfg_buflens[i];
 171                 bufs->lcfg_buf[i] = lustre_cfg_buf(lcfg, i);
 172         }
 173 }
 174
 175 static inline char *lustre_cfg_string(struct lustre_cfg *lcfg, int index)
 176 {
 177         char *s;
 178
 179         if (!lcfg->lcfg_buflens[index])
 180                 return NULL;
 181
 182         s = lustre_cfg_buf(lcfg, index);
 183         if (!s)
 184                 return NULL;
 185
 186         /* make sure it's NULL terminated, even if this kills a char
 187          * of data.  Try to use the padding first though.
 188          */
 189         if (s[lcfg->lcfg_buflens[index] - 1] != '\0') {
 190                 int last = min((int)lcfg->lcfg_buflens[index],
 191                                size_round(lcfg->lcfg_buflens[index]) - 1);
 192                 char lost = s[last];
 193                 s[last] = '\0';
 194                 if (lost != '\0') {
 195                         CWARN("Truncated buf %d to '%s' (lost '%c'...)\n",
 196                               index, s, lost);
 197                 }
 198         }
 199         return s;
 200 }
 201
 202 static inline int lustre_cfg_len(__u32 bufcount, __u32 *buflens)
 203 {
 204         int i;
 205         int len;
 206         ENTRY;
 207
 208         len = LCFG_HDR_SIZE(bufcount);
 209         for (i = 0; i < bufcount; i++)
 210                 len += size_round(buflens[i]);
 211
 212         RETURN(size_round(len));
 213 }
 214
 215
 216 #include <obd_support.h>
 217
 218 static inline struct lustre_cfg *lustre_cfg_new(int cmd,
 219                                                 struct lustre_cfg_bufs *bufs)
 220 {
 221         struct lustre_cfg *lcfg;
 222         char *ptr;
 223         int i;
 224
 225         ENTRY;
 226
 227         OBD_ALLOC(lcfg, lustre_cfg_len(bufs->lcfg_bufcount,
 228                                        bufs->lcfg_buflen));
 229         if (!lcfg)
 230                 RETURN(ERR_PTR(-ENOMEM));
 231
 232         lcfg->lcfg_version = LUSTRE_CFG_VERSION;
 233         lcfg->lcfg_command = cmd;
 234         lcfg->lcfg_bufcount = bufs->lcfg_bufcount;
 235
 236         ptr = (char *)lcfg + LCFG_HDR_SIZE(lcfg->lcfg_bufcount);
 237         for (i = 0; i < lcfg->lcfg_bufcount; i++) {
 238                 lcfg->lcfg_buflens[i] = bufs->lcfg_buflen[i];
 239                 LOGL((char *)bufs->lcfg_buf[i], bufs->lcfg_buflen[i], ptr);
 240         }
 241         RETURN(lcfg);
 242 }
 243
 244 static inline void lustre_cfg_free(struct lustre_cfg *lcfg)
 245 {
 246         int len;
 247
 248         len = lustre_cfg_len(lcfg->lcfg_bufcount, lcfg->lcfg_buflens);
 249
 250         OBD_FREE(lcfg, len);
 251         EXIT;
 252         return;
 253 }
 254
 255 static inline int lustre_cfg_sanity_check(void *buf, int len)
 256 {
 257         struct lustre_cfg *lcfg = (struct lustre_cfg *)buf;
 258         ENTRY;
 259         if (!lcfg)
 260                 RETURN(-EINVAL);
 261
 262         /* check that the first bits of the struct are valid */
 263         if (len < LCFG_HDR_SIZE(0))
 264                 RETURN(-EINVAL);
 265
 266         if (lcfg->lcfg_version != LUSTRE_CFG_VERSION)
 267                 RETURN(-EINVAL);
 268
 269         if (lcfg->lcfg_bufcount >= LUSTRE_CFG_MAX_BUFCOUNT)
 270                 RETURN(-EINVAL);
 271
 272         /* check that the buflens are valid */
 273         if (len < LCFG_HDR_SIZE(lcfg->lcfg_bufcount))
 274                 RETURN(-EINVAL);
 275
 276         /* make sure all the pointers point inside the data */
 277         if (len < lustre_cfg_len(lcfg->lcfg_bufcount, lcfg->lcfg_buflens))
 278                 RETURN(-EINVAL);
 279
 280         RETURN(0);
 281 }
 282
 283 #include <lustre/lustre_user.h>
 284
 285 #define INVALID_UID     (-1)
 286
 287 #endif // _LUSTRE_CFG_H