Whamcloud - gitweb
LU-6401 uapi: change lustre_cfg.h into a proper UAPI header
[fs/lustre-release.git] / lustre / include / lustre_cfg.h
diff --git a/lustre/include/lustre_cfg.h b/lustre/include/lustre_cfg.h
deleted file mode 100644 (file)
index bf2a62a..0000000
+++ /dev/null
@@ -1,333 +0,0 @@
-/*
- * GPL HEADER START
- *
- * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License version 2 only,
- * as published by the Free Software Foundation.
- *
- * This program is distributed in the hope that it will be useful, but
- * WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
- * General Public License version 2 for more details (a copy is included
- * in the LICENSE file that accompanied this code).
- *
- * You should have received a copy of the GNU General Public License
- * version 2 along with this program; If not, see
- * http://www.gnu.org/licenses/gpl-2.0.html
- *
- * GPL HEADER END
- */
-/*
- * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
- * Use is subject to license terms.
- *
- * Copyright (c) 2012, 2014, Intel Corporation.
- */
-/*
- * This file is part of Lustre, http://www.lustre.org/
- * Lustre is a trademark of Sun Microsystems, Inc.
- */
-
-#ifndef _LUSTRE_CFG_H
-#define _LUSTRE_CFG_H
-
-#include <libcfs/libcfs.h>
-#include <lustre/lustre_user.h>
-
-#ifdef __KERNEL__
-# include <obd_support.h>
-#else /* !__KERNEL__ */
-# include <malloc.h>
-# include <stdlib.h>
-#endif /* __KERNEL__ */
-
-/** \defgroup cfg cfg
- *
- * @{
- */
-
-/*
- * 1cf6
- * lcfG
- */
-#define LUSTRE_CFG_VERSION 0x1cf60001
-#define LUSTRE_CFG_MAX_BUFCOUNT 8
-
-#define LCFG_HDR_SIZE(count) \
-    cfs_size_round(offsetof (struct lustre_cfg, lcfg_buflens[(count)]))
-
-/** If the LCFG_REQUIRED bit is set in a configuration command,
- * then the client is required to understand this parameter
- * in order to mount the filesystem. If it does not understand
- * a REQUIRED command the client mount will fail. */
-#define LCFG_REQUIRED         0x0001000
-
-enum lcfg_command_type {
-        LCFG_ATTACH             = 0x00cf001, /**< create a new obd instance */
-        LCFG_DETACH             = 0x00cf002, /**< destroy obd instance */
-        LCFG_SETUP              = 0x00cf003, /**< call type-specific setup */
-        LCFG_CLEANUP            = 0x00cf004, /**< call type-specific cleanup */
-        LCFG_ADD_UUID           = 0x00cf005, /**< add a nid to a niduuid */
-        LCFG_DEL_UUID           = 0x00cf006, /**< remove a nid from a niduuid */
-        LCFG_MOUNTOPT           = 0x00cf007, /**< create a profile (mdc, osc) */
-        LCFG_DEL_MOUNTOPT       = 0x00cf008, /**< destroy a profile */
-        LCFG_SET_TIMEOUT        = 0x00cf009, /**< set obd_timeout */
-        LCFG_SET_UPCALL         = 0x00cf00a, /**< deprecated */
-        LCFG_ADD_CONN           = 0x00cf00b, /**< add a failover niduuid to an obd */
-        LCFG_DEL_CONN           = 0x00cf00c, /**< remove a failover niduuid */
-        LCFG_LOV_ADD_OBD        = 0x00cf00d, /**< add an osc to a lov */
-        LCFG_LOV_DEL_OBD        = 0x00cf00e, /**< remove an osc from a lov */
-        LCFG_PARAM              = 0x00cf00f, /**< set a proc parameter */
-        LCFG_MARKER             = 0x00cf010, /**< metadata about next cfg rec */
-        LCFG_LOG_START          = 0x00ce011, /**< mgc only, process a cfg log */
-        LCFG_LOG_END            = 0x00ce012, /**< stop processing updates */
-        LCFG_LOV_ADD_INA        = 0x00ce013, /**< like LOV_ADD_OBD, inactive */
-        LCFG_ADD_MDC            = 0x00cf014, /**< add an mdc to a lmv */
-        LCFG_DEL_MDC            = 0x00cf015, /**< remove an mdc from a lmv */
-        LCFG_SPTLRPC_CONF       = 0x00ce016, /**< security */
-        LCFG_POOL_NEW           = 0x00ce020, /**< create an ost pool name */
-        LCFG_POOL_ADD           = 0x00ce021, /**< add an ost to a pool */
-        LCFG_POOL_REM           = 0x00ce022, /**< remove an ost from a pool */
-        LCFG_POOL_DEL           = 0x00ce023, /**< destroy an ost pool name */
-        LCFG_SET_LDLM_TIMEOUT   = 0x00ce030, /**< set ldlm_timeout */
-       LCFG_PRE_CLEANUP        = 0x00cf031, /**< call type-specific pre
-                                             * cleanup cleanup */
-       LCFG_SET_PARAM          = 0x00ce032, /**< use set_param syntax to set
-                                             *a proc parameters */
-       LCFG_NODEMAP_ADD        = 0x00ce040, /**< create a cluster */
-       LCFG_NODEMAP_DEL        = 0x00ce041, /**< destroy a cluster */
-       LCFG_NODEMAP_ADD_RANGE  = 0x00ce042, /**< add a nid range */
-       LCFG_NODEMAP_DEL_RANGE  = 0x00ce043, /**< delete an nid range */
-       LCFG_NODEMAP_ADD_UIDMAP = 0x00ce044, /**< add a uidmap */
-       LCFG_NODEMAP_DEL_UIDMAP = 0x00ce045, /**< delete a uidmap */
-       LCFG_NODEMAP_ADD_GIDMAP = 0x00ce046, /**< add a gidmap */
-       LCFG_NODEMAP_DEL_GIDMAP = 0x00ce047, /**< delete a gidmap */
-       LCFG_NODEMAP_ACTIVATE   = 0x00ce048, /**< activate cluster id mapping */
-       LCFG_NODEMAP_ADMIN      = 0x00ce049, /**< allow cluster to use id 0 */
-       LCFG_NODEMAP_TRUSTED    = 0x00ce050, /**< trust a clusters ids */
-       LCFG_NODEMAP_SQUASH_UID = 0x00ce051, /**< default map uid */
-       LCFG_NODEMAP_SQUASH_GID = 0x00ce052, /**< default map gid */
-       LCFG_NODEMAP_ADD_SHKEY  = 0x00ce053, /**< add shared key to cluster */
-       LCFG_NODEMAP_DEL_SHKEY  = 0x00ce054, /**< delete shared key from cluster */
-       LCFG_NODEMAP_TEST_NID   = 0x00ce055, /**< test for nodemap membership */
-       LCFG_NODEMAP_TEST_ID    = 0x00ce056, /**< test uid/gid mapping */
-       LCFG_NODEMAP_SET_FILESET   = 0x00ce057, /**< set fileset */
-       LCFG_NODEMAP_DENY_UNKNOWN  = 0x00ce058, /**< deny squashed nodemap users */
-       LCFG_NODEMAP_MAP_MODE  = 0x00ce059, /**< set the mapping mode */
-};
-
-struct lustre_cfg_bufs {
-        void    *lcfg_buf[LUSTRE_CFG_MAX_BUFCOUNT];
-        __u32    lcfg_buflen[LUSTRE_CFG_MAX_BUFCOUNT];
-        __u32    lcfg_bufcount;
-};
-
-struct lustre_cfg {
-       __u32 lcfg_version;
-       __u32 lcfg_command;
-
-       __u32 lcfg_num;
-       __u32 lcfg_flags;
-       __u64 lcfg_nid;
-       __u32 lcfg_nal;         /* not used any more */
-
-       __u32 lcfg_bufcount;
-       __u32 lcfg_buflens[0];
-};
-
-enum cfg_record_type {
-        PORTALS_CFG_TYPE = 1,
-        LUSTRE_CFG_TYPE = 123,
-};
-
-#define LUSTRE_CFG_BUFLEN(lcfg, idx)            \
-        ((lcfg)->lcfg_bufcount <= (idx)         \
-         ? 0                                    \
-         : (lcfg)->lcfg_buflens[(idx)])
-
-static inline void lustre_cfg_bufs_set(struct lustre_cfg_bufs *bufs,
-                                       __u32                   index,
-                                       void                   *buf,
-                                       __u32                   buflen)
-{
-        if (index >= LUSTRE_CFG_MAX_BUFCOUNT)
-                return;
-        if (bufs == NULL)
-                return;
-
-        if (bufs->lcfg_bufcount <= index)
-                bufs->lcfg_bufcount = index + 1;
-
-        bufs->lcfg_buf[index]    = buf;
-        bufs->lcfg_buflen[index] = buflen;
-}
-
-static inline void lustre_cfg_bufs_set_string(struct lustre_cfg_bufs *bufs,
-                                              __u32 index,
-                                              char *str)
-{
-        lustre_cfg_bufs_set(bufs, index, str, str ? strlen(str) + 1 : 0);
-}
-
-static inline void lustre_cfg_bufs_reset(struct lustre_cfg_bufs *bufs, char *name)
-{
-        memset((bufs), 0, sizeof(*bufs));
-        if (name)
-                lustre_cfg_bufs_set_string(bufs, 0, name);
-}
-
-static inline void *lustre_cfg_buf(struct lustre_cfg *lcfg, __u32 index)
-{
-       __u32 i;
-       size_t offset;
-       __u32 bufcount;
-
-       if (!lcfg)
-               return NULL;
-
-        bufcount = lcfg->lcfg_bufcount;
-        if (index >= bufcount)
-                return NULL;
-
-        offset = LCFG_HDR_SIZE(lcfg->lcfg_bufcount);
-        for (i = 0; i < index; i++)
-                offset += cfs_size_round(lcfg->lcfg_buflens[i]);
-        return (char *)lcfg + offset;
-}
-
-static inline void lustre_cfg_bufs_init(struct lustre_cfg_bufs *bufs,
-                                        struct lustre_cfg *lcfg)
-{
-       __u32 i;
-        bufs->lcfg_bufcount = lcfg->lcfg_bufcount;
-        for (i = 0; i < bufs->lcfg_bufcount; i++) {
-                bufs->lcfg_buflen[i] = lcfg->lcfg_buflens[i];
-                bufs->lcfg_buf[i] = lustre_cfg_buf(lcfg, i);
-        }
-}
-
-static inline char *lustre_cfg_string(struct lustre_cfg *lcfg, __u32 index)
-{
-       char *s;
-
-       if (lcfg->lcfg_buflens[index] == 0)
-               return NULL;
-
-       s = lustre_cfg_buf(lcfg, index);
-       if (s == NULL)
-               return NULL;
-
-       /*
-        * make sure it's NULL terminated, even if this kills a char
-        * of data.  Try to use the padding first though.
-        */
-       if (s[lcfg->lcfg_buflens[index] - 1] != '\0') {
-               size_t last = cfs_size_round(lcfg->lcfg_buflens[index]) - 1;
-               char lost;
-
-               /* Use the smaller value */
-               if (last > lcfg->lcfg_buflens[index])
-                       last = lcfg->lcfg_buflens[index];
-
-               lost = s[last];
-               s[last] = '\0';
-               if (lost != '\0') {
-                       CWARN("Truncated buf %d to '%s' (lost '%c'...)\n",
-                             index, s, lost);
-               }
-       }
-       return s;
-}
-
-static inline __u32 lustre_cfg_len(__u32 bufcount, __u32 *buflens)
-{
-       __u32 i;
-       __u32 len;
-        ENTRY;
-
-        len = LCFG_HDR_SIZE(bufcount);
-        for (i = 0; i < bufcount; i++)
-                len += cfs_size_round(buflens[i]);
-
-        RETURN(cfs_size_round(len));
-}
-
-static inline void lustre_cfg_init(struct lustre_cfg *lcfg, int cmd,
-                                  struct lustre_cfg_bufs *bufs)
-{
-       char *ptr;
-       __u32 i;
-
-       lcfg->lcfg_version = LUSTRE_CFG_VERSION;
-       lcfg->lcfg_command = cmd;
-       lcfg->lcfg_bufcount = bufs->lcfg_bufcount;
-
-       ptr = (char *)lcfg + LCFG_HDR_SIZE(lcfg->lcfg_bufcount);
-       for (i = 0; i < lcfg->lcfg_bufcount; i++) {
-               lcfg->lcfg_buflens[i] = bufs->lcfg_buflen[i];
-               if (bufs->lcfg_buf[i]) {
-                       memcpy(ptr, bufs->lcfg_buf[i], bufs->lcfg_buflen[i]);
-                       ptr += cfs_size_round(bufs->lcfg_buflen[i]);
-               }
-       }
-}
-
-static inline struct lustre_cfg *lustre_cfg_new(int cmd,
-                                               struct lustre_cfg_bufs *bufs)
-{
-       struct lustre_cfg       *lcfg;
-
-#ifdef __KERNEL__
-       OBD_ALLOC(lcfg, lustre_cfg_len(bufs->lcfg_bufcount, bufs->lcfg_buflen));
-#else /* !__KERNEL__ */
-       lcfg = malloc(lustre_cfg_len(bufs->lcfg_bufcount, bufs->lcfg_buflen));
-#endif /* __KERNEL__ */
-
-       if (lcfg != NULL)
-               lustre_cfg_init(lcfg, cmd, bufs);
-
-       return lcfg;
-}
-
-static inline void lustre_cfg_free(struct lustre_cfg *lcfg)
-{
-#ifdef __KERNEL__
-       OBD_FREE(lcfg, lustre_cfg_len(lcfg->lcfg_bufcount, lcfg->lcfg_buflens));
-#else /* ! __KERNEL__ */
-       free(lcfg);
-#endif /* __KERNEL__ */
-}
-
-static inline int lustre_cfg_sanity_check(void *buf, size_t len)
-{
-        struct lustre_cfg *lcfg = (struct lustre_cfg *)buf;
-        ENTRY;
-        if (!lcfg)
-                RETURN(-EINVAL);
-
-        /* check that the first bits of the struct are valid */
-        if (len < LCFG_HDR_SIZE(0))
-                RETURN(-EINVAL);
-
-        if (lcfg->lcfg_version != LUSTRE_CFG_VERSION)
-                RETURN(-EINVAL);
-
-        if (lcfg->lcfg_bufcount >= LUSTRE_CFG_MAX_BUFCOUNT)
-                RETURN(-EINVAL);
-
-        /* check that the buflens are valid */
-        if (len < LCFG_HDR_SIZE(lcfg->lcfg_bufcount))
-                RETURN(-EINVAL);
-
-        /* make sure all the pointers point inside the data */
-        if (len < lustre_cfg_len(lcfg->lcfg_bufcount, lcfg->lcfg_buflens))
-                RETURN(-EINVAL);
-
-        RETURN(0);
-}
-
-/** @} cfg */
-
-#endif /* _LUSTRE_CFG_H */