Viewing: lustre_cfg.h
/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
/*
* 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/
*/
#ifndef _UAPI_LUSTRE_CFG_H
#define _UAPI_LUSTRE_CFG_H
#include <linux/errno.h>
#include <linux/kernel.h>
#include <linux/types.h>
#include <linux/lustre/lustre_user.h>
/** \defgroup cfg cfg
*
* @{
*/
/*
* 1cf6
* lcfG
*/
#define LUSTRE_CFG_VERSION 0x1cf60001
#define LUSTRE_CFG_MAX_BUFCOUNT 8
/*
* Target name "general" calls on all targets
* when set at (struct) lustre_cfg_bufs[0].
* See lustre_cfg_bufs_set_string() and lustre_cfg_bufs_reset()
*/
#define LUSTRE_CFG_ALL_TARGETS "general"
#define LCFG_HDR_SIZE(count) \
__ALIGN_KERNEL(offsetof(struct lustre_cfg, lcfg_buflens[(count)]), 8)
/** 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_ADD_PROJIDMAP = 0x00ce04a, /**< add a projidmap */
LCFG_NODEMAP_DEL_PROJIDMAP = 0x00ce04b, /**< delete projidmap */
LCFG_NODEMAP_ADD_OFFSET = 0x00ce04c, /**< UID/GID/PROJID add offset */
LCFG_NODEMAP_DEL_OFFSET = 0x00ce04d, /**< UID/GID/PROJID del offset */
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 */
LCFG_NODEMAP_AUDIT_MODE = 0x00ce05a, /**< set the audit mode */
LCFG_NODEMAP_SET_SEPOL = 0x00ce05b, /**< set SELinux policy */
LCFG_NODEMAP_FORBID_ENCRYPT = 0x00ce05c, /**< forbid encryption */
LCFG_NODEMAP_SQUASH_PROJID = 0x00ce05d, /**< default map projid */
LCFG_NODEMAP_READONLY_MOUNT = 0x00ce05e, /**< read-only mount */
LCFG_NODEMAP_RBAC = 0x00ce05f, /**< rbac */
LCFG_NODEMAP_DENY_MOUNT = 0x00ce060, /**< deny mount */
LCFG_NODEMAP_RAISE_PRIVS = 0x00ce061, /**< sub-nm raise privs */
LCFG_NODEMAP_FILESET_ADD = 0x00ce062, /**< add fileset */
LCFG_NODEMAP_SET_CAPS = 0x00ce063, /**< user capabilities */
LCFG_NODEMAP_FILESET_DEL = 0x00ce064, /**< del fileset */
LCFG_NODEMAP_GSS_IDENTIFY = 0x00ce065, /**< gss identification */
LCFG_NODEMAP_LOOKUP_SHA = 0x00ce066, /**< lookup nm sha */
LCFG_NODEMAP_FILESET_MODIFY = 0x00ce067, /**< modify fileset */
LCFG_NODEMAP_BANLIST_ADD = 0x00ce068, /**< add ban list */
LCFG_NODEMAP_BANLIST_DEL = 0x00ce069, /**< del ban list */
};
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[];
};
struct lcfg_type_data {
__u32 ltd_type;
char *ltd_name;
char *ltd_bufs[4];
};
static struct lcfg_type_data lcfg_data_table[] = {
{ LCFG_ATTACH, "attach", { "type", "UUID", "3", "4" } },
{ LCFG_DETACH, "detach", { "1", "2", "3", "4" } },
{ LCFG_SETUP, "setup", { "UUID", "node", "options", "failout" } },
{ LCFG_CLEANUP, "cleanup", { "1", "2", "3", "4" } },
{ LCFG_ADD_UUID, "add_uuid", { "node", "nid", "3", "4" } },
{ LCFG_DEL_UUID, "del_uuid", { "1", "2", "3", "4" } },
{ LCFG_MOUNTOPT, "new_profile", { "name", "lov", "lmv", "4" } },
{ LCFG_DEL_MOUNTOPT, "del_mountopt", { "1", "2", "3", "4" } },
{ LCFG_SET_TIMEOUT, "set_timeout", { "parameter", "2", "3", "4" } },
{ LCFG_SET_UPCALL, "set_upcall", { "1", "2", "3", "4" } },
{ LCFG_ADD_CONN, "add_conn", { "node", "2", "3", "4" } },
{ LCFG_DEL_CONN, "del_conn", { "1", "2", "3", "4" } },
{ LCFG_LOV_ADD_OBD, "add_osc", { "ost", "index", "gen", "UUID" } },
{ LCFG_LOV_DEL_OBD, "del_osc", { "1", "2", "3", "4" } },
{ LCFG_PARAM, "conf_param", { "parameter", "value", "3", "4" } },
{ LCFG_MARKER, "marker", { "1", "2", "3", "4" } },
{ LCFG_LOG_START, "log_start", { "1", "2", "3", "4" } },
{ LCFG_LOG_END, "log_end", { "1", "2", "3", "4" } },
{ LCFG_LOV_ADD_INA, "add_osc_inactive", { "1", "2", "3", "4" } },
{ LCFG_ADD_MDC, "add_mdc", { "mdt", "index", "gen", "UUID" } },
{ LCFG_DEL_MDC, "del_mdc", { "1", "2", "3", "4" } },
{ LCFG_SPTLRPC_CONF, "security", { "parameter", "2", "3", "4" } },
{ LCFG_POOL_NEW, "new_pool", { "fsname", "pool", "3", "4" } },
{ LCFG_POOL_ADD, "add_pool", { "fsname", "pool", "ost", "4" } },
{ LCFG_POOL_REM, "remove_pool", { "fsname", "pool", "ost", "4" } },
{ LCFG_POOL_DEL, "del_pool", { "fsname", "pool", "3", "4" } },
{ LCFG_SET_LDLM_TIMEOUT, "set_ldlm_timeout",
{ "parameter", "2", "3", "4" } },
{ LCFG_SET_PARAM, "set_param", { "parameter", "value", "3", "4" } },
{ 0, NULL, { NULL, NULL, NULL, NULL } }
};
static inline struct lcfg_type_data *lcfg_cmd2data(__u32 cmd)
{
int i = 0;
while (lcfg_data_table[i].ltd_type != 0) {
if (lcfg_data_table[i].ltd_type == cmd)
return &lcfg_data_table[i];
i++;
}
return NULL;
}
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)
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;
__kernel_size_t offset;
__u32 bufcount;
if (!lcfg)
return NULL;
bufcount = lcfg->lcfg_bufcount;
if (index >= bufcount)
return NULL;
if (!lcfg->lcfg_buflens[index])
return NULL;
offset = LCFG_HDR_SIZE(lcfg->lcfg_bufcount);
for (i = 0; i < index; i++)
offset += __ALIGN_KERNEL(lcfg->lcfg_buflens[i], 8);
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 __u32 lustre_cfg_len(__u32 bufcount, __u32 *buflens)
{
__u32 i;
__u32 len;
len = LCFG_HDR_SIZE(bufcount);
for (i = 0; i < bufcount; i++)
len += __ALIGN_KERNEL(buflens[i], 8);
return __ALIGN_KERNEL(len, 8);
}
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 += __ALIGN_KERNEL(bufs->lcfg_buflen[i], 8);
}
}
}
static inline int lustre_cfg_sanity_check(void *buf, __kernel_size_t len)
{
struct lustre_cfg *lcfg = (struct lustre_cfg *)buf;
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 (LCFG_HDR_SIZE(lcfg->lcfg_bufcount) > len)
return -EINVAL;
/* make sure all the pointers point inside the data */
if (lustre_cfg_len(lcfg->lcfg_bufcount, lcfg->lcfg_buflens) > len)
return -EINVAL;
return 0;
}
/** @} cfg */
#endif /* _UAPI_LUSTRE_CFG_H */
