4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
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.
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).
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
23 * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Use is subject to license terms.
26 * Copyright (c) 2012, 2014, Intel Corporation.
29 * This file is part of Lustre, http://www.lustre.org/
30 * Lustre is a trademark of Sun Microsystems, Inc.
33 #ifndef _UAPI_LUSTRE_CFG_H
34 #define _UAPI_LUSTRE_CFG_H
36 #include <linux/errno.h>
37 #include <linux/kernel.h>
38 #include <linux/types.h>
39 #include <linux/lustre/lustre_user.h>
50 #define LUSTRE_CFG_VERSION 0x1cf60001
51 #define LUSTRE_CFG_MAX_BUFCOUNT 8
53 #define LCFG_HDR_SIZE(count) \
54 __ALIGN_KERNEL(offsetof(struct lustre_cfg, lcfg_buflens[(count)]), 8)
56 /** If the LCFG_REQUIRED bit is set in a configuration command,
57 * then the client is required to understand this parameter
58 * in order to mount the filesystem. If it does not understand
59 * a REQUIRED command the client mount will fail.
61 #define LCFG_REQUIRED 0x0001000
63 enum lcfg_command_type {
64 LCFG_ATTACH = 0x00cf001, /**< create a new obd instance */
65 LCFG_DETACH = 0x00cf002, /**< destroy obd instance */
66 LCFG_SETUP = 0x00cf003, /**< call type-specific setup */
67 LCFG_CLEANUP = 0x00cf004, /**< call type-specific cleanup
69 LCFG_ADD_UUID = 0x00cf005, /**< add a nid to a niduuid */
70 LCFG_DEL_UUID = 0x00cf006, /**< remove a nid from
73 LCFG_MOUNTOPT = 0x00cf007, /**< create a profile
76 LCFG_DEL_MOUNTOPT = 0x00cf008, /**< destroy a profile */
77 LCFG_SET_TIMEOUT = 0x00cf009, /**< set obd_timeout */
78 LCFG_SET_UPCALL = 0x00cf00a, /**< deprecated */
79 LCFG_ADD_CONN = 0x00cf00b, /**< add a failover niduuid to
82 LCFG_DEL_CONN = 0x00cf00c, /**< remove a failover niduuid */
83 LCFG_LOV_ADD_OBD = 0x00cf00d, /**< add an osc to a lov */
84 LCFG_LOV_DEL_OBD = 0x00cf00e, /**< remove an osc from a lov */
85 LCFG_PARAM = 0x00cf00f, /**< set a proc parameter */
86 LCFG_MARKER = 0x00cf010, /**< metadata about next
89 LCFG_LOG_START = 0x00ce011, /**< mgc only, process a
92 LCFG_LOG_END = 0x00ce012, /**< stop processing updates */
93 LCFG_LOV_ADD_INA = 0x00ce013, /**< like LOV_ADD_OBD,
96 LCFG_ADD_MDC = 0x00cf014, /**< add an mdc to a lmv */
97 LCFG_DEL_MDC = 0x00cf015, /**< remove an mdc from a lmv */
98 LCFG_SPTLRPC_CONF = 0x00ce016, /**< security */
99 LCFG_POOL_NEW = 0x00ce020, /**< create an ost pool name */
100 LCFG_POOL_ADD = 0x00ce021, /**< add an ost to a pool */
101 LCFG_POOL_REM = 0x00ce022, /**< remove an ost from a pool */
102 LCFG_POOL_DEL = 0x00ce023, /**< destroy an ost pool name */
103 LCFG_SET_LDLM_TIMEOUT = 0x00ce030, /**< set ldlm_timeout */
104 LCFG_PRE_CLEANUP = 0x00cf031, /**< call type-specific pre
107 LCFG_SET_PARAM = 0x00ce032, /**< use set_param syntax to set
110 LCFG_NODEMAP_ADD = 0x00ce040, /**< create a cluster */
111 LCFG_NODEMAP_DEL = 0x00ce041, /**< destroy a cluster */
112 LCFG_NODEMAP_ADD_RANGE = 0x00ce042, /**< add a nid range */
113 LCFG_NODEMAP_DEL_RANGE = 0x00ce043, /**< delete an nid range */
114 LCFG_NODEMAP_ADD_UIDMAP = 0x00ce044, /**< add a uidmap */
115 LCFG_NODEMAP_DEL_UIDMAP = 0x00ce045, /**< delete a uidmap */
116 LCFG_NODEMAP_ADD_GIDMAP = 0x00ce046, /**< add a gidmap */
117 LCFG_NODEMAP_DEL_GIDMAP = 0x00ce047, /**< delete a gidmap */
118 LCFG_NODEMAP_ACTIVATE = 0x00ce048, /**< activate cluster
121 LCFG_NODEMAP_ADMIN = 0x00ce049, /**< allow cluster to use id 0 */
122 LCFG_NODEMAP_TRUSTED = 0x00ce050, /**< trust a clusters ids */
123 LCFG_NODEMAP_SQUASH_UID = 0x00ce051, /**< default map uid */
124 LCFG_NODEMAP_SQUASH_GID = 0x00ce052, /**< default map gid */
125 LCFG_NODEMAP_ADD_SHKEY = 0x00ce053, /**< add shared key to cluster */
126 LCFG_NODEMAP_DEL_SHKEY = 0x00ce054, /**< delete shared key from
129 LCFG_NODEMAP_TEST_NID = 0x00ce055, /**< test for nodemap
132 LCFG_NODEMAP_TEST_ID = 0x00ce056, /**< test uid/gid mapping */
133 LCFG_NODEMAP_SET_FILESET = 0x00ce057, /**< set fileset */
134 LCFG_NODEMAP_DENY_UNKNOWN = 0x00ce058, /**< deny squashed nodemap
137 LCFG_NODEMAP_MAP_MODE = 0x00ce059, /**< set the mapping mode */
138 LCFG_NODEMAP_AUDIT_MODE = 0x00ce05a, /**< set the audit mode */
139 LCFG_NODEMAP_SET_SEPOL = 0x00ce05b, /**< set SELinux policy */
140 LCFG_NODEMAP_FORBID_ENCRYPT = 0x00ce05c, /**< forbid encryption */
143 struct lustre_cfg_bufs {
144 void *lcfg_buf[LUSTRE_CFG_MAX_BUFCOUNT];
145 __u32 lcfg_buflen[LUSTRE_CFG_MAX_BUFCOUNT];
156 __u32 lcfg_nal; /* not used any more */
159 __u32 lcfg_buflens[0];
162 struct lcfg_type_data {
168 static struct lcfg_type_data lcfg_data_table[] = {
169 { LCFG_ATTACH, "attach", { "type", "UUID", "3", "4" } },
170 { LCFG_DETACH, "detach", { "1", "2", "3", "4" } },
171 { LCFG_SETUP, "setup", { "UUID", "node", "options", "failout" } },
172 { LCFG_CLEANUP, "cleanup", { "1", "2", "3", "4" } },
173 { LCFG_ADD_UUID, "add_uuid", { "node", "2", "3", "4" } },
174 { LCFG_DEL_UUID, "del_uuid", { "1", "2", "3", "4" } },
175 { LCFG_MOUNTOPT, "new_profile", { "name", "lov", "lmv", "4" } },
176 { LCFG_DEL_MOUNTOPT, "del_mountopt", { "1", "2", "3", "4" } },
177 { LCFG_SET_TIMEOUT, "set_timeout", { "parameter", "2", "3", "4" } },
178 { LCFG_SET_UPCALL, "set_upcall", { "1", "2", "3", "4" } },
179 { LCFG_ADD_CONN, "add_conn", { "node", "2", "3", "4" } },
180 { LCFG_DEL_CONN, "del_conn", { "1", "2", "3", "4" } },
181 { LCFG_LOV_ADD_OBD, "add_osc", { "ost", "index", "gen", "UUID" } },
182 { LCFG_LOV_DEL_OBD, "del_osc", { "1", "2", "3", "4" } },
183 { LCFG_PARAM, "conf_param", { "parameter", "value", "3", "4" } },
184 { LCFG_MARKER, "marker", { "1", "2", "3", "4" } },
185 { LCFG_LOG_START, "log_start", { "1", "2", "3", "4" } },
186 { LCFG_LOG_END, "log_end", { "1", "2", "3", "4" } },
187 { LCFG_LOV_ADD_INA, "add_osc_inactive", { "1", "2", "3", "4" } },
188 { LCFG_ADD_MDC, "add_mdc", { "mdt", "index", "gen", "UUID" } },
189 { LCFG_DEL_MDC, "del_mdc", { "1", "2", "3", "4" } },
190 { LCFG_SPTLRPC_CONF, "security", { "parameter", "2", "3", "4" } },
191 { LCFG_POOL_NEW, "new_pool", { "fsname", "pool", "3", "4" } },
192 { LCFG_POOL_ADD, "add_pool", { "fsname", "pool", "ost", "4" } },
193 { LCFG_POOL_REM, "remove_pool", { "fsname", "pool", "ost", "4" } },
194 { LCFG_POOL_DEL, "del_pool", { "fsname", "pool", "3", "4" } },
195 { LCFG_SET_LDLM_TIMEOUT, "set_ldlm_timeout",
196 { "parameter", "2", "3", "4" } },
197 { LCFG_SET_PARAM, "set_param", { "parameter", "value", "3", "4" } },
198 { 0, NULL, { NULL, NULL, NULL, NULL } }
201 static inline struct lcfg_type_data *lcfg_cmd2data(__u32 cmd)
205 while (lcfg_data_table[i].ltd_type != 0) {
206 if (lcfg_data_table[i].ltd_type == cmd)
207 return &lcfg_data_table[i];
213 enum cfg_record_type {
214 PORTALS_CFG_TYPE = 1,
215 LUSTRE_CFG_TYPE = 123,
218 #define LUSTRE_CFG_BUFLEN(lcfg, idx) \
219 ((lcfg)->lcfg_bufcount <= (idx) ? 0 : (lcfg)->lcfg_buflens[(idx)])
221 static inline void lustre_cfg_bufs_set(struct lustre_cfg_bufs *bufs,
222 __u32 index, void *buf, __u32 buflen)
224 if (index >= LUSTRE_CFG_MAX_BUFCOUNT)
230 if (bufs->lcfg_bufcount <= index)
231 bufs->lcfg_bufcount = index + 1;
233 bufs->lcfg_buf[index] = buf;
234 bufs->lcfg_buflen[index] = buflen;
237 static inline void lustre_cfg_bufs_set_string(struct lustre_cfg_bufs *bufs,
238 __u32 index, char *str)
240 lustre_cfg_bufs_set(bufs, index, str, str ? strlen(str) + 1 : 0);
243 static inline void lustre_cfg_bufs_reset(struct lustre_cfg_bufs *bufs,
246 memset((bufs), 0, sizeof(*bufs));
248 lustre_cfg_bufs_set_string(bufs, 0, name);
251 static inline void *lustre_cfg_buf(struct lustre_cfg *lcfg, __u32 index)
254 __kernel_size_t offset;
260 bufcount = lcfg->lcfg_bufcount;
261 if (index >= bufcount)
264 offset = LCFG_HDR_SIZE(lcfg->lcfg_bufcount);
265 for (i = 0; i < index; i++)
266 offset += __ALIGN_KERNEL(lcfg->lcfg_buflens[i], 8);
267 return (char *)lcfg + offset;
270 static inline void lustre_cfg_bufs_init(struct lustre_cfg_bufs *bufs,
271 struct lustre_cfg *lcfg)
275 bufs->lcfg_bufcount = lcfg->lcfg_bufcount;
276 for (i = 0; i < bufs->lcfg_bufcount; i++) {
277 bufs->lcfg_buflen[i] = lcfg->lcfg_buflens[i];
278 bufs->lcfg_buf[i] = lustre_cfg_buf(lcfg, i);
282 static inline __u32 lustre_cfg_len(__u32 bufcount, __u32 *buflens)
287 len = LCFG_HDR_SIZE(bufcount);
288 for (i = 0; i < bufcount; i++)
289 len += __ALIGN_KERNEL(buflens[i], 8);
291 return __ALIGN_KERNEL(len, 8);
294 static inline void lustre_cfg_init(struct lustre_cfg *lcfg, int cmd,
295 struct lustre_cfg_bufs *bufs)
300 lcfg->lcfg_version = LUSTRE_CFG_VERSION;
301 lcfg->lcfg_command = cmd;
302 lcfg->lcfg_bufcount = bufs->lcfg_bufcount;
304 ptr = (char *)lcfg + LCFG_HDR_SIZE(lcfg->lcfg_bufcount);
305 for (i = 0; i < lcfg->lcfg_bufcount; i++) {
306 lcfg->lcfg_buflens[i] = bufs->lcfg_buflen[i];
307 if (bufs->lcfg_buf[i]) {
308 memcpy(ptr, bufs->lcfg_buf[i], bufs->lcfg_buflen[i]);
309 ptr += __ALIGN_KERNEL(bufs->lcfg_buflen[i], 8);
314 static inline int lustre_cfg_sanity_check(void *buf, __kernel_size_t len)
316 struct lustre_cfg *lcfg = (struct lustre_cfg *)buf;
321 /* check that the first bits of the struct are valid */
322 if (len < LCFG_HDR_SIZE(0))
325 if (lcfg->lcfg_version != LUSTRE_CFG_VERSION)
328 if (lcfg->lcfg_bufcount >= LUSTRE_CFG_MAX_BUFCOUNT)
331 /* check that the buflens are valid */
332 if (len < LCFG_HDR_SIZE(lcfg->lcfg_bufcount))
335 /* make sure all the pointers point inside the data */
336 if (len < lustre_cfg_len(lcfg->lcfg_bufcount, lcfg->lcfg_buflens))
344 #endif /* _UAPI_LUSTRE_CFG_H */