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, 2014, Intel Corporation.
  27  */
  28 /*
  29  * This file is part of Lustre, http://www.lustre.org/
  30  */
  31
  32 #ifndef _UAPI_LUSTRE_CFG_H
  33 #define _UAPI_LUSTRE_CFG_H
  34
  35 #include <linux/errno.h>
  36 #include <linux/kernel.h>
  37 #include <linux/types.h>
  38 #include <linux/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                                                  */
  68         LCFG_ADD_UUID             = 0x00cf005, /**< add a nid to a niduuid */
  69         LCFG_DEL_UUID             = 0x00cf006, /**< remove a nid from
  70                                                  *  a niduuid
  71                                                  */
  72         LCFG_MOUNTOPT             = 0x00cf007, /**< create a profile
  73                                                  * (mdc, osc)
  74                                                  */
  75         LCFG_DEL_MOUNTOPT         = 0x00cf008, /**< destroy a profile */
  76         LCFG_SET_TIMEOUT          = 0x00cf009, /**< set obd_timeout */
  77         LCFG_SET_UPCALL           = 0x00cf00a, /**< deprecated */
  78         LCFG_ADD_CONN             = 0x00cf00b, /**< add a failover niduuid to
  79                                                  *  an obd
  80                                                  */
  81         LCFG_DEL_CONN             = 0x00cf00c, /**< remove a failover niduuid */
  82         LCFG_LOV_ADD_OBD          = 0x00cf00d, /**< add an osc to a lov */
  83         LCFG_LOV_DEL_OBD          = 0x00cf00e, /**< remove an osc from a lov */
  84         LCFG_PARAM                = 0x00cf00f, /**< set a proc parameter */
  85         LCFG_MARKER               = 0x00cf010, /**< metadata about next
  86                                                  *  cfg rec
  87                                                  */
  88         LCFG_LOG_START            = 0x00ce011, /**< mgc only, process a
  89                                                  *  cfg log
  90                                                  */
  91         LCFG_LOG_END              = 0x00ce012, /**< stop processing updates */
  92         LCFG_LOV_ADD_INA          = 0x00ce013, /**< like LOV_ADD_OBD,
  93                                                  *  inactive
  94                                                  */
  95         LCFG_ADD_MDC              = 0x00cf014, /**< add an mdc to a lmv */
  96         LCFG_DEL_MDC              = 0x00cf015, /**< remove an mdc from a lmv */
  97         LCFG_SPTLRPC_CONF         = 0x00ce016, /**< security */
  98         LCFG_POOL_NEW             = 0x00ce020, /**< create an ost pool name */
  99         LCFG_POOL_ADD             = 0x00ce021, /**< add an ost to a pool */
 100         LCFG_POOL_REM             = 0x00ce022, /**< remove an ost from a pool */
 101         LCFG_POOL_DEL             = 0x00ce023, /**< destroy an ost pool name */
 102         LCFG_SET_LDLM_TIMEOUT     = 0x00ce030, /**< set ldlm_timeout */
 103         LCFG_PRE_CLEANUP          = 0x00cf031, /**< call type-specific pre
 104                                                  * cleanup cleanup
 105                                                  */
 106         LCFG_SET_PARAM            = 0x00ce032, /**< use set_param syntax to set
 107                                                  * a proc parameters
 108                                                  */
 109         LCFG_NODEMAP_ADD          = 0x00ce040, /**< create a cluster */
 110         LCFG_NODEMAP_DEL          = 0x00ce041, /**< destroy a cluster */
 111         LCFG_NODEMAP_ADD_RANGE    = 0x00ce042, /**< add a nid range */
 112         LCFG_NODEMAP_DEL_RANGE    = 0x00ce043, /**< delete an nid range */
 113         LCFG_NODEMAP_ADD_UIDMAP   = 0x00ce044, /**< add a uidmap */
 114         LCFG_NODEMAP_DEL_UIDMAP   = 0x00ce045, /**< delete a uidmap */
 115         LCFG_NODEMAP_ADD_GIDMAP   = 0x00ce046, /**< add a gidmap */
 116         LCFG_NODEMAP_DEL_GIDMAP   = 0x00ce047, /**< delete a gidmap */
 117         LCFG_NODEMAP_ACTIVATE     = 0x00ce048, /**< activate cluster
 118                                                  *  id mapping
 119                                                  */
 120         LCFG_NODEMAP_ADMIN        = 0x00ce049, /**< allow cluster to use id 0 */
 121         LCFG_NODEMAP_ADD_PROJIDMAP        = 0x00ce04a, /**< add a projidmap */
 122         LCFG_NODEMAP_DEL_PROJIDMAP        = 0x00ce04b, /**< delete a projidmap */
 123         LCFG_NODEMAP_TRUSTED      = 0x00ce050, /**< trust a clusters ids */
 124         LCFG_NODEMAP_SQUASH_UID   = 0x00ce051, /**< default map uid */
 125         LCFG_NODEMAP_SQUASH_GID   = 0x00ce052, /**< default map gid */
 126         LCFG_NODEMAP_ADD_SHKEY    = 0x00ce053, /**< add shared key to cluster */
 127         LCFG_NODEMAP_DEL_SHKEY    = 0x00ce054, /**< delete shared key from
 128                                                  *  cluster
 129                                                  */
 130         LCFG_NODEMAP_TEST_NID     = 0x00ce055, /**< test for nodemap
 131                                                  *  membership
 132                                                  */
 133         LCFG_NODEMAP_TEST_ID      = 0x00ce056, /**< test uid/gid mapping */
 134         LCFG_NODEMAP_SET_FILESET  = 0x00ce057, /**< set fileset */
 135         LCFG_NODEMAP_DENY_UNKNOWN = 0x00ce058, /**< deny squashed nodemap
 136                                                  *  users
 137                                                  */
 138         LCFG_NODEMAP_MAP_MODE     = 0x00ce059, /**< set the mapping mode */
 139         LCFG_NODEMAP_AUDIT_MODE   = 0x00ce05a, /**< set the audit mode */
 140         LCFG_NODEMAP_SET_SEPOL    = 0x00ce05b, /**< set SELinux policy */
 141         LCFG_NODEMAP_FORBID_ENCRYPT     = 0x00ce05c, /**< forbid encryption */
 142         LCFG_NODEMAP_SQUASH_PROJID      = 0x00ce05d, /**< default map projid */
 143         LCFG_NODEMAP_READONLY_MOUNT     = 0x00ce05e, /**< read-only mount */
 144 };
 145
 146 struct lustre_cfg_bufs {
 147         void  *lcfg_buf[LUSTRE_CFG_MAX_BUFCOUNT];
 148         __u32 lcfg_buflen[LUSTRE_CFG_MAX_BUFCOUNT];
 149         __u32 lcfg_bufcount;
 150 };
 151
 152 struct lustre_cfg {
 153         __u32 lcfg_version;
 154         __u32 lcfg_command;
 155
 156         __u32 lcfg_num;
 157         __u32 lcfg_flags;
 158         __u64 lcfg_nid;
 159         __u32 lcfg_nal;         /* not used any more */
 160
 161         __u32 lcfg_bufcount;
 162         __u32 lcfg_buflens[0];
 163 };
 164
 165 struct lcfg_type_data {
 166         __u32    ltd_type;
 167         char    *ltd_name;
 168         char    *ltd_bufs[4];
 169 };
 170
 171 static struct lcfg_type_data lcfg_data_table[] = {
 172         { LCFG_ATTACH, "attach", { "type", "UUID", "3", "4" } },
 173         { LCFG_DETACH, "detach", { "1", "2", "3", "4" } },
 174         { LCFG_SETUP, "setup", { "UUID", "node", "options", "failout" } },
 175         { LCFG_CLEANUP, "cleanup", { "1", "2", "3", "4" } },
 176         { LCFG_ADD_UUID, "add_uuid", { "node", "2", "3", "4" }  },
 177         { LCFG_DEL_UUID, "del_uuid", { "1", "2", "3", "4" }  },
 178         { LCFG_MOUNTOPT, "new_profile", { "name", "lov", "lmv", "4" }  },
 179         { LCFG_DEL_MOUNTOPT, "del_mountopt", { "1", "2", "3", "4" }  },
 180         { LCFG_SET_TIMEOUT, "set_timeout", { "parameter", "2", "3", "4" }  },
 181         { LCFG_SET_UPCALL, "set_upcall", { "1", "2", "3", "4" }  },
 182         { LCFG_ADD_CONN, "add_conn", { "node", "2", "3", "4" }  },
 183         { LCFG_DEL_CONN, "del_conn", { "1", "2", "3", "4" }  },
 184         { LCFG_LOV_ADD_OBD, "add_osc", { "ost", "index", "gen", "UUID" } },
 185         { LCFG_LOV_DEL_OBD, "del_osc", { "1", "2", "3", "4" } },
 186         { LCFG_PARAM, "conf_param", { "parameter", "value", "3", "4" } },
 187         { LCFG_MARKER, "marker", { "1", "2", "3", "4" } },
 188         { LCFG_LOG_START, "log_start", { "1", "2", "3", "4" } },
 189         { LCFG_LOG_END, "log_end", { "1", "2", "3", "4" } },
 190         { LCFG_LOV_ADD_INA, "add_osc_inactive", { "1", "2", "3", "4" }  },
 191         { LCFG_ADD_MDC, "add_mdc", { "mdt", "index", "gen", "UUID" } },
 192         { LCFG_DEL_MDC, "del_mdc", { "1", "2", "3", "4" } },
 193         { LCFG_SPTLRPC_CONF, "security", { "parameter", "2", "3", "4" } },
 194         { LCFG_POOL_NEW, "new_pool", { "fsname", "pool", "3", "4" }  },
 195         { LCFG_POOL_ADD, "add_pool", { "fsname", "pool", "ost", "4" } },
 196         { LCFG_POOL_REM, "remove_pool", { "fsname", "pool", "ost", "4" } },
 197         { LCFG_POOL_DEL, "del_pool", { "fsname", "pool", "3", "4" } },
 198         { LCFG_SET_LDLM_TIMEOUT, "set_ldlm_timeout",
 199           { "parameter", "2", "3", "4" } },
 200         { LCFG_SET_PARAM, "set_param", { "parameter", "value", "3", "4" } },
 201         { 0, NULL, { NULL, NULL, NULL, NULL } }
 202 };
 203
 204 static inline struct lcfg_type_data *lcfg_cmd2data(__u32 cmd)
 205 {
 206         int i = 0;
 207
 208         while (lcfg_data_table[i].ltd_type != 0) {
 209                 if (lcfg_data_table[i].ltd_type == cmd)
 210                         return &lcfg_data_table[i];
 211                 i++;
 212         }
 213         return NULL;
 214 }
 215
 216 enum cfg_record_type {
 217         PORTALS_CFG_TYPE        = 1,
 218         LUSTRE_CFG_TYPE         = 123,
 219 };
 220
 221 #define LUSTRE_CFG_BUFLEN(lcfg, idx)                                    \
 222         ((lcfg)->lcfg_bufcount <= (idx) ? 0 : (lcfg)->lcfg_buflens[(idx)])
 223
 224 static inline void lustre_cfg_bufs_set(struct lustre_cfg_bufs *bufs,
 225                                        __u32 index, void *buf, __u32 buflen)
 226 {
 227         if (index >= LUSTRE_CFG_MAX_BUFCOUNT)
 228                 return;
 229
 230         if (!bufs)
 231                 return;
 232
 233         if (bufs->lcfg_bufcount <= index)
 234                 bufs->lcfg_bufcount = index + 1;
 235
 236         bufs->lcfg_buf[index] = buf;
 237         bufs->lcfg_buflen[index] = buflen;
 238 }
 239
 240 static inline void lustre_cfg_bufs_set_string(struct lustre_cfg_bufs *bufs,
 241                                               __u32 index, char *str)
 242 {
 243         lustre_cfg_bufs_set(bufs, index, str, str ? strlen(str) + 1 : 0);
 244 }
 245
 246 static inline void lustre_cfg_bufs_reset(struct lustre_cfg_bufs *bufs,
 247                                          char *name)
 248 {
 249         memset((bufs), 0, sizeof(*bufs));
 250         if (name)
 251                 lustre_cfg_bufs_set_string(bufs, 0, name);
 252 }
 253
 254 static inline void *lustre_cfg_buf(struct lustre_cfg *lcfg, __u32 index)
 255 {
 256         __u32 i;
 257         __kernel_size_t offset;
 258         __u32 bufcount;
 259
 260         if (!lcfg)
 261                 return NULL;
 262
 263         bufcount = lcfg->lcfg_bufcount;
 264         if (index >= bufcount)
 265                 return NULL;
 266
 267         offset = LCFG_HDR_SIZE(lcfg->lcfg_bufcount);
 268         for (i = 0; i < index; i++)
 269                 offset += __ALIGN_KERNEL(lcfg->lcfg_buflens[i], 8);
 270         return (char *)lcfg + offset;
 271 }
 272
 273 static inline void lustre_cfg_bufs_init(struct lustre_cfg_bufs *bufs,
 274                                         struct lustre_cfg *lcfg)
 275 {
 276         __u32 i;
 277
 278         bufs->lcfg_bufcount = lcfg->lcfg_bufcount;
 279         for (i = 0; i < bufs->lcfg_bufcount; i++) {
 280                 bufs->lcfg_buflen[i] = lcfg->lcfg_buflens[i];
 281                 bufs->lcfg_buf[i] = lustre_cfg_buf(lcfg, i);
 282         }
 283 }
 284
 285 static inline __u32 lustre_cfg_len(__u32 bufcount, __u32 *buflens)
 286 {
 287         __u32 i;
 288         __u32 len;
 289
 290         len = LCFG_HDR_SIZE(bufcount);
 291         for (i = 0; i < bufcount; i++)
 292                 len += __ALIGN_KERNEL(buflens[i], 8);
 293
 294         return __ALIGN_KERNEL(len, 8);
 295 }
 296
 297 static inline void lustre_cfg_init(struct lustre_cfg *lcfg, int cmd,
 298                                    struct lustre_cfg_bufs *bufs)
 299 {
 300         char *ptr;
 301         __u32 i;
 302
 303         lcfg->lcfg_version = LUSTRE_CFG_VERSION;
 304         lcfg->lcfg_command = cmd;
 305         lcfg->lcfg_bufcount = bufs->lcfg_bufcount;
 306
 307         ptr = (char *)lcfg + LCFG_HDR_SIZE(lcfg->lcfg_bufcount);
 308         for (i = 0; i < lcfg->lcfg_bufcount; i++) {
 309                 lcfg->lcfg_buflens[i] = bufs->lcfg_buflen[i];
 310                 if (bufs->lcfg_buf[i]) {
 311                         memcpy(ptr, bufs->lcfg_buf[i], bufs->lcfg_buflen[i]);
 312                         ptr += __ALIGN_KERNEL(bufs->lcfg_buflen[i], 8);
 313                 }
 314         }
 315 }
 316
 317 static inline int lustre_cfg_sanity_check(void *buf, __kernel_size_t len)
 318 {
 319         struct lustre_cfg *lcfg = (struct lustre_cfg *)buf;
 320
 321         if (!lcfg)
 322                 return -EINVAL;
 323
 324         /* check that the first bits of the struct are valid */
 325         if (len < LCFG_HDR_SIZE(0))
 326                 return -EINVAL;
 327
 328         if (lcfg->lcfg_version != LUSTRE_CFG_VERSION)
 329                 return -EINVAL;
 330
 331         if (lcfg->lcfg_bufcount >= LUSTRE_CFG_MAX_BUFCOUNT)
 332                 return -EINVAL;
 333
 334         /* check that the buflens are valid */
 335         if (len < LCFG_HDR_SIZE(lcfg->lcfg_bufcount))
 336                 return -EINVAL;
 337
 338         /* make sure all the pointers point inside the data */
 339         if (len < lustre_cfg_len(lcfg->lcfg_bufcount, lcfg->lcfg_buflens))
 340                 return -EINVAL;
 341
 342         return 0;
 343 }
 344
 345 /** @} cfg */
 346
 347 #endif /* _UAPI_LUSTRE_CFG_H */