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