drivers/staging/lustre/include/uapi/linux/lustre/lustre_cfg.h

   1 /*
   2  * GPL HEADER START
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License version 2 only,
   8  * as published by the Free Software Foundation.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * General Public License version 2 for more details (a copy is included
  14  * in the LICENSE file that accompanied this code).
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * version 2 along with this program; If not, see
  18  * http://www.gnu.org/licenses/gpl-2.0.html
  19  *
  20  * GPL HEADER END
  21  */
  22 /*
  23  * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
  24  * Use is subject to license terms.
  25  *
  26  * Copyright (c) 2012, Intel Corporation.
  27  */
  28 /*
  29  * This file is part of Lustre, http://www.lustre.org/
  30  * Lustre is a trademark of Sun Microsystems, Inc.
  31  */
  32
  33 #ifndef _LUSTRE_CFG_H
  34 #define _LUSTRE_CFG_H
  35
  36 #include <linux/errno.h>
  37 #include <linux/kernel.h>
  38 #include "../../../../lustre/include/lustre/lustre_user.h"
  39
  40 /** \defgroup cfg cfg
  41  *
  42  * @{
  43  */
  44
  45 /*
  46  * 1cf6
  47  * lcfG
  48  */
  49 #define LUSTRE_CFG_VERSION 0x1cf60001
  50 #define LUSTRE_CFG_MAX_BUFCOUNT 8
  51
  52 #define LCFG_HDR_SIZE(count) \
  53         __ALIGN_KERNEL(offsetof(struct lustre_cfg, lcfg_buflens[(count)]), 8)
  54
  55 /** If the LCFG_REQUIRED bit is set in a configuration command,
  56  * then the client is required to understand this parameter
  57  * in order to mount the filesystem. If it does not understand
  58  * a REQUIRED command the client mount will fail.
  59  */
  60 #define LCFG_REQUIRED    0x0001000
  61
  62 enum lcfg_command_type {
  63         LCFG_ATTACH          = 0x00cf001, /**< create a new obd instance */
  64         LCFG_DETACH          = 0x00cf002, /**< destroy obd instance */
  65         LCFG_SETUP            = 0x00cf003, /**< call type-specific setup */
  66         LCFG_CLEANUP        = 0x00cf004, /**< call type-specific cleanup */
  67         LCFG_ADD_UUID      = 0x00cf005, /**< add a nid to a niduuid */
  68         LCFG_DEL_UUID      = 0x00cf006, /**< remove a nid from a niduuid */
  69         LCFG_MOUNTOPT      = 0x00cf007, /**< create a profile (mdc, osc) */
  70         LCFG_DEL_MOUNTOPT       = 0x00cf008, /**< destroy a profile */
  71         LCFG_SET_TIMEOUT        = 0x00cf009, /**< set obd_timeout */
  72         LCFG_SET_UPCALL  = 0x00cf00a, /**< deprecated */
  73         LCFG_ADD_CONN      = 0x00cf00b, /**< add a failover niduuid to an obd */
  74         LCFG_DEL_CONN      = 0x00cf00c, /**< remove a failover niduuid */
  75         LCFG_LOV_ADD_OBD        = 0x00cf00d, /**< add an osc to a lov */
  76         LCFG_LOV_DEL_OBD        = 0x00cf00e, /**< remove an osc from a lov */
  77         LCFG_PARAM            = 0x00cf00f, /**< set a proc parameter */
  78         LCFG_MARKER          = 0x00cf010, /**< metadata about next cfg rec */
  79         LCFG_LOG_START    = 0x00ce011, /**< mgc only, process a cfg log */
  80         LCFG_LOG_END        = 0x00ce012, /**< stop processing updates */
  81         LCFG_LOV_ADD_INA        = 0x00ce013, /**< like LOV_ADD_OBD, inactive */
  82         LCFG_ADD_MDC        = 0x00cf014, /**< add an mdc to a lmv */
  83         LCFG_DEL_MDC        = 0x00cf015, /**< remove an mdc from a lmv */
  84         LCFG_SPTLRPC_CONF       = 0x00ce016, /**< security */
  85         LCFG_POOL_NEW      = 0x00ce020, /**< create an ost pool name */
  86         LCFG_POOL_ADD      = 0x00ce021, /**< add an ost to a pool */
  87         LCFG_POOL_REM      = 0x00ce022, /**< remove an ost from a pool */
  88         LCFG_POOL_DEL      = 0x00ce023, /**< destroy an ost pool name */
  89         LCFG_SET_LDLM_TIMEOUT   = 0x00ce030, /**< set ldlm_timeout */
  90         LCFG_PRE_CLEANUP        = 0x00cf031, /**< call type-specific pre
  91                                               * cleanup cleanup
  92                                               */
  93         LCFG_SET_PARAM          = 0x00ce032, /**< use set_param syntax to set
  94                                               * a proc parameters
  95                                               */
  96 };
  97
  98 struct lustre_cfg_bufs {
  99         void    *lcfg_buf[LUSTRE_CFG_MAX_BUFCOUNT];
 100         __u32    lcfg_buflen[LUSTRE_CFG_MAX_BUFCOUNT];
 101         __u32    lcfg_bufcount;
 102 };
 103
 104 struct lustre_cfg {
 105         __u32 lcfg_version;
 106         __u32 lcfg_command;
 107
 108         __u32 lcfg_num;
 109         __u32 lcfg_flags;
 110         __u64 lcfg_nid;
 111         __u32 lcfg_nal;         /* not used any more */
 112
 113         __u32 lcfg_bufcount;
 114         __u32 lcfg_buflens[0];
 115 };
 116
 117 enum cfg_record_type {
 118         PORTALS_CFG_TYPE = 1,
 119         LUSTRE_CFG_TYPE = 123,
 120 };
 121
 122 #define LUSTRE_CFG_BUFLEN(lcfg, idx)        \
 123         ((lcfg)->lcfg_bufcount <= (idx)  \
 124          ? 0                                \
 125          : (lcfg)->lcfg_buflens[(idx)])
 126
 127 static inline void lustre_cfg_bufs_set(struct lustre_cfg_bufs *bufs,
 128                                        __u32               index,
 129                                        void                *buf,
 130                                        __u32               buflen)
 131 {
 132         if (index >= LUSTRE_CFG_MAX_BUFCOUNT)
 133                 return;
 134         if (!bufs)
 135                 return;
 136
 137         if (bufs->lcfg_bufcount <= index)
 138                 bufs->lcfg_bufcount = index + 1;
 139
 140         bufs->lcfg_buf[index]    = buf;
 141         bufs->lcfg_buflen[index] = buflen;
 142 }
 143
 144 static inline void lustre_cfg_bufs_set_string(struct lustre_cfg_bufs *bufs,
 145                                               __u32 index,
 146                                               char *str)
 147 {
 148         lustre_cfg_bufs_set(bufs, index, str, str ? strlen(str) + 1 : 0);
 149 }
 150
 151 static inline void lustre_cfg_bufs_reset(struct lustre_cfg_bufs *bufs, char *name)
 152 {
 153         memset((bufs), 0, sizeof(*bufs));
 154         if (name)
 155                 lustre_cfg_bufs_set_string(bufs, 0, name);
 156 }
 157
 158 static inline void *lustre_cfg_buf(struct lustre_cfg *lcfg, __u32 index)
 159 {
 160         __u32 i;
 161         size_t offset;
 162         __u32 bufcount;
 163
 164         bufcount = lcfg->lcfg_bufcount;
 165         if (index >= bufcount)
 166                 return NULL;
 167
 168         offset = LCFG_HDR_SIZE(lcfg->lcfg_bufcount);
 169         for (i = 0; i < index; i++)
 170                 offset += __ALIGN_KERNEL(lcfg->lcfg_buflens[i], 8);
 171         return (char *)lcfg + offset;
 172 }
 173
 174 static inline void lustre_cfg_bufs_init(struct lustre_cfg_bufs *bufs,
 175                                         struct lustre_cfg *lcfg)
 176 {
 177         __u32 i;
 178
 179         bufs->lcfg_bufcount = lcfg->lcfg_bufcount;
 180         for (i = 0; i < bufs->lcfg_bufcount; i++) {
 181                 bufs->lcfg_buflen[i] = lcfg->lcfg_buflens[i];
 182                 bufs->lcfg_buf[i] = lustre_cfg_buf(lcfg, i);
 183         }
 184 }
 185
 186 static inline __u32 lustre_cfg_len(__u32 bufcount, __u32 *buflens)
 187 {
 188         __u32 i;
 189         __u32 len;
 190
 191         len = LCFG_HDR_SIZE(bufcount);
 192         for (i = 0; i < bufcount; i++)
 193                 len += __ALIGN_KERNEL(buflens[i], 8);
 194
 195         return __ALIGN_KERNEL(len, 8);
 196 }
 197
 198 static inline void lustre_cfg_init(struct lustre_cfg *lcfg, int cmd,
 199                                    struct lustre_cfg_bufs *bufs)
 200 {
 201         char *ptr;
 202         __u32 i;
 203
 204         lcfg->lcfg_version = LUSTRE_CFG_VERSION;
 205         lcfg->lcfg_command = cmd;
 206         lcfg->lcfg_bufcount = bufs->lcfg_bufcount;
 207
 208         ptr = (char *)lcfg + LCFG_HDR_SIZE(lcfg->lcfg_bufcount);
 209         for (i = 0; i < lcfg->lcfg_bufcount; i++) {
 210                 lcfg->lcfg_buflens[i] = bufs->lcfg_buflen[i];
 211                 if (bufs->lcfg_buf[i]) {
 212                         memcpy(ptr, bufs->lcfg_buf[i], bufs->lcfg_buflen[i]);
 213                         ptr += __ALIGN_KERNEL(bufs->lcfg_buflen[i], 8);
 214                 }
 215         }
 216 }
 217
 218 static inline int lustre_cfg_sanity_check(void *buf, size_t len)
 219 {
 220         struct lustre_cfg *lcfg = (struct lustre_cfg *)buf;
 221
 222         if (!lcfg)
 223                 return -EINVAL;
 224
 225         /* check that the first bits of the struct are valid */
 226         if (len < LCFG_HDR_SIZE(0))
 227                 return -EINVAL;
 228
 229         if (lcfg->lcfg_version != LUSTRE_CFG_VERSION)
 230                 return -EINVAL;
 231
 232         if (lcfg->lcfg_bufcount >= LUSTRE_CFG_MAX_BUFCOUNT)
 233                 return -EINVAL;
 234
 235         /* check that the buflens are valid */
 236         if (len < LCFG_HDR_SIZE(lcfg->lcfg_bufcount))
 237                 return -EINVAL;
 238
 239         /* make sure all the pointers point inside the data */
 240         if (len < lustre_cfg_len(lcfg->lcfg_bufcount, lcfg->lcfg_buflens))
 241                 return -EINVAL;
 242
 243         return 0;
 244 }
 245
 246 /** @} cfg */
 247
 248 #endif /* _LUSTRE_CFG_H */