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 [sun.com URL with a
  20  * copy of GPLv2].
  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_ADD_MDC        = 0x00cf014,
  74         LCFG_DEL_MDC        = 0x00cf015,
  75         LCFG_SPTLRPC_CONF   = 0x00ce016,
  76 };
  77
  78 struct lustre_cfg_bufs {
  79         void    *lcfg_buf[LUSTRE_CFG_MAX_BUFCOUNT];
  80         __u32    lcfg_buflen[LUSTRE_CFG_MAX_BUFCOUNT];
  81         __u32    lcfg_bufcount;
  82 };
  83
  84 /* Mountconf transitional hack, should go away after 1.6 */
  85 #define LCFG_FLG_MOUNTCONF 0x400
  86
  87 struct lustre_cfg {
  88         __u32 lcfg_version;
  89         __u32 lcfg_command;
  90
  91         __u32 lcfg_num;
  92         __u32 lcfg_flags;
  93         __u64 lcfg_nid;
  94         __u32 lcfg_nal;                      /* not used any more */
  95
  96         __u32 lcfg_bufcount;
  97         __u32 lcfg_buflens[0];
  98 };
  99
 100 #define LUSTRE_CFG_BUFLEN(lcfg, idx)            \
 101         ((lcfg)->lcfg_bufcount <= (idx)         \
 102          ? 0                                    \
 103          : (lcfg)->lcfg_buflens[(idx)])
 104
 105 static inline void lustre_cfg_bufs_set(struct lustre_cfg_bufs *bufs,
 106                                        __u32                   index,
 107                                        void                   *buf,
 108                                        __u32                   buflen)
 109 {
 110         if (index >= LUSTRE_CFG_MAX_BUFCOUNT)
 111                 return;
 112         if (bufs == NULL)
 113                 return;
 114
 115         if (bufs->lcfg_bufcount <= index)
 116                 bufs->lcfg_bufcount = index + 1;
 117
 118         bufs->lcfg_buf[index]    = buf;
 119         bufs->lcfg_buflen[index] = buflen;
 120 }
 121
 122 static inline void lustre_cfg_bufs_set_string(struct lustre_cfg_bufs *bufs,
 123                                               __u32 index,
 124                                               char *str)
 125 {
 126         lustre_cfg_bufs_set(bufs, index, str, str ? strlen(str) + 1 : 0);
 127 }
 128
 129 static inline void lustre_cfg_bufs_reset(struct lustre_cfg_bufs *bufs, char *name)
 130 {
 131         memset((bufs), 0, sizeof(*bufs));
 132         if (name)
 133                 lustre_cfg_bufs_set_string(bufs, 0, name);
 134 }
 135
 136 static inline void *lustre_cfg_buf(struct lustre_cfg *lcfg, int index)
 137 {
 138         int i;
 139         int offset;
 140         int bufcount;
 141         LASSERT (lcfg != NULL);
 142         LASSERT (index >= 0);
 143
 144         bufcount = lcfg->lcfg_bufcount;
 145         if (index >= bufcount)
 146                 return NULL;
 147
 148         offset = LCFG_HDR_SIZE(lcfg->lcfg_bufcount);
 149         for (i = 0; i < index; i++)
 150                 offset += size_round(lcfg->lcfg_buflens[i]);
 151         return (char *)lcfg + offset;
 152 }
 153
 154 static inline void lustre_cfg_bufs_init(struct lustre_cfg_bufs *bufs,
 155                                         struct lustre_cfg *lcfg)
 156 {
 157         int i;
 158         bufs->lcfg_bufcount = lcfg->lcfg_bufcount;
 159         for (i = 0; i < bufs->lcfg_bufcount; i++) {
 160                 bufs->lcfg_buflen[i] = lcfg->lcfg_buflens[i];
 161                 bufs->lcfg_buf[i] = lustre_cfg_buf(lcfg, i);
 162         }
 163 }
 164
 165 static inline char *lustre_cfg_string(struct lustre_cfg *lcfg, int index)
 166 {
 167         char *s;
 168
 169         if (!lcfg->lcfg_buflens[index])
 170                 return NULL;
 171
 172         s = lustre_cfg_buf(lcfg, index);
 173         if (!s)
 174                 return NULL;
 175
 176         /* make sure it's NULL terminated, even if this kills a char
 177          * of data.  Try to use the padding first though.
 178          */
 179         if (s[lcfg->lcfg_buflens[index] - 1] != '\0') {
 180                 int last = min((int)lcfg->lcfg_buflens[index],
 181                                size_round(lcfg->lcfg_buflens[index]) - 1);
 182                 char lost = s[last];
 183                 s[last] = '\0';
 184                 if (lost != '\0') {
 185                         CWARN("Truncated buf %d to '%s' (lost '%c'...)\n",
 186                               index, s, lost);
 187                 }
 188         }
 189         return s;
 190 }
 191
 192 static inline int lustre_cfg_len(__u32 bufcount, __u32 *buflens)
 193 {
 194         int i;
 195         int len;
 196         ENTRY;
 197
 198         len = LCFG_HDR_SIZE(bufcount);
 199         for (i = 0; i < bufcount; i++)
 200                 len += size_round(buflens[i]);
 201
 202         RETURN(size_round(len));
 203 }
 204
 205
 206 #include <obd_support.h>
 207
 208 static inline struct lustre_cfg *lustre_cfg_new(int cmd,
 209                                                 struct lustre_cfg_bufs *bufs)
 210 {
 211         struct lustre_cfg *lcfg;
 212         char *ptr;
 213         int i;
 214
 215         ENTRY;
 216
 217         OBD_ALLOC(lcfg, lustre_cfg_len(bufs->lcfg_bufcount,
 218                                        bufs->lcfg_buflen));
 219         if (!lcfg)
 220                 RETURN(lcfg);
 221
 222         lcfg->lcfg_version = LUSTRE_CFG_VERSION;
 223         lcfg->lcfg_command = cmd;
 224         lcfg->lcfg_bufcount = bufs->lcfg_bufcount;
 225
 226         ptr = (char *)lcfg + LCFG_HDR_SIZE(lcfg->lcfg_bufcount);
 227         for (i = 0; i < lcfg->lcfg_bufcount; i++) {
 228                 lcfg->lcfg_buflens[i] = bufs->lcfg_buflen[i];
 229                 LOGL((char *)bufs->lcfg_buf[i], bufs->lcfg_buflen[i], ptr);
 230         }
 231         RETURN(lcfg);
 232 }
 233
 234 static inline void lustre_cfg_free(struct lustre_cfg *lcfg)
 235 {
 236         int len;
 237
 238         len = lustre_cfg_len(lcfg->lcfg_bufcount, lcfg->lcfg_buflens);
 239
 240         OBD_FREE(lcfg, len);
 241         EXIT;
 242         return;
 243 }
 244
 245 static inline int lustre_cfg_sanity_check(void *buf, int len)
 246 {
 247         struct lustre_cfg *lcfg = (struct lustre_cfg *)buf;
 248         ENTRY;
 249         if (!lcfg)
 250                 RETURN(-EINVAL);
 251
 252         /* check that the first bits of the struct are valid */
 253         if (len < LCFG_HDR_SIZE(0))
 254                 RETURN(-EINVAL);
 255
 256         if (lcfg->lcfg_version != LUSTRE_CFG_VERSION)
 257                 RETURN(-EINVAL);
 258
 259         if (lcfg->lcfg_bufcount >= LUSTRE_CFG_MAX_BUFCOUNT)
 260                 RETURN(-EINVAL);
 261
 262         /* check that the buflens are valid */
 263         if (len < LCFG_HDR_SIZE(lcfg->lcfg_bufcount))
 264                 RETURN(-EINVAL);
 265
 266         /* make sure all the pointers point inside the data */
 267         if (len < lustre_cfg_len(lcfg->lcfg_bufcount, lcfg->lcfg_buflens))
 268                 RETURN(-EINVAL);
 269
 270         RETURN(0);
 271 }
 272
 273 #include <lustre/lustre_user.h>
 274
 275 #define INVALID_UID     (-1)
 276
 277 #endif // _LUSTRE_CFG_H