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, 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 <uapi/linux/lustre/lustre_user.h>
49 #define LUSTRE_CFG_VERSION 0x1cf60001
50 #define LUSTRE_CFG_MAX_BUFCOUNT 8
52 #define LCFG_HDR_SIZE(count) \
53 __ALIGN_KERNEL(offsetof(struct lustre_cfg, lcfg_buflens[(count)]), 8)
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.
60 #define LCFG_REQUIRED 0x0001000
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
68 LCFG_ADD_UUID = 0x00cf005, /**< add a nid to a niduuid */
69 LCFG_DEL_UUID = 0x00cf006, /**< remove a nid from
72 LCFG_MOUNTOPT = 0x00cf007, /**< create a profile
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
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
88 LCFG_LOG_START = 0x00ce011, /**< mgc only, process a
91 LCFG_LOG_END = 0x00ce012, /**< stop processing updates */
92 LCFG_LOV_ADD_INA = 0x00ce013, /**< like LOV_ADD_OBD,
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
106 LCFG_SET_PARAM = 0x00ce032, /**< use set_param syntax to set
111 struct lustre_cfg_bufs {
112 void *lcfg_buf[LUSTRE_CFG_MAX_BUFCOUNT];
113 __u32 lcfg_buflen[LUSTRE_CFG_MAX_BUFCOUNT];
124 __u32 lcfg_nal; /* not used any more */
127 __u32 lcfg_buflens[0];
130 enum cfg_record_type {
131 PORTALS_CFG_TYPE = 1,
132 LUSTRE_CFG_TYPE = 123,
135 #define LUSTRE_CFG_BUFLEN(lcfg, idx) \
136 ((lcfg)->lcfg_bufcount <= (idx) ? 0 : (lcfg)->lcfg_buflens[(idx)])
138 static inline void lustre_cfg_bufs_set(struct lustre_cfg_bufs *bufs,
139 __u32 index, void *buf, __u32 buflen)
141 if (index >= LUSTRE_CFG_MAX_BUFCOUNT)
147 if (bufs->lcfg_bufcount <= index)
148 bufs->lcfg_bufcount = index + 1;
150 bufs->lcfg_buf[index] = buf;
151 bufs->lcfg_buflen[index] = buflen;
154 static inline void lustre_cfg_bufs_set_string(struct lustre_cfg_bufs *bufs,
155 __u32 index, char *str)
157 lustre_cfg_bufs_set(bufs, index, str, str ? strlen(str) + 1 : 0);
160 static inline void lustre_cfg_bufs_reset(struct lustre_cfg_bufs *bufs,
163 memset((bufs), 0, sizeof(*bufs));
165 lustre_cfg_bufs_set_string(bufs, 0, name);
168 static inline void *lustre_cfg_buf(struct lustre_cfg *lcfg, __u32 index)
177 bufcount = lcfg->lcfg_bufcount;
178 if (index >= bufcount)
181 offset = LCFG_HDR_SIZE(lcfg->lcfg_bufcount);
182 for (i = 0; i < index; i++)
183 offset += __ALIGN_KERNEL(lcfg->lcfg_buflens[i], 8);
184 return (char *)lcfg + offset;
187 static inline void lustre_cfg_bufs_init(struct lustre_cfg_bufs *bufs,
188 struct lustre_cfg *lcfg)
192 bufs->lcfg_bufcount = lcfg->lcfg_bufcount;
193 for (i = 0; i < bufs->lcfg_bufcount; i++) {
194 bufs->lcfg_buflen[i] = lcfg->lcfg_buflens[i];
195 bufs->lcfg_buf[i] = lustre_cfg_buf(lcfg, i);
199 static inline __u32 lustre_cfg_len(__u32 bufcount, __u32 *buflens)
204 len = LCFG_HDR_SIZE(bufcount);
205 for (i = 0; i < bufcount; i++)
206 len += __ALIGN_KERNEL(buflens[i], 8);
208 return __ALIGN_KERNEL(len, 8);
211 static inline void lustre_cfg_init(struct lustre_cfg *lcfg, int cmd,
212 struct lustre_cfg_bufs *bufs)
217 lcfg->lcfg_version = LUSTRE_CFG_VERSION;
218 lcfg->lcfg_command = cmd;
219 lcfg->lcfg_bufcount = bufs->lcfg_bufcount;
221 ptr = (char *)lcfg + LCFG_HDR_SIZE(lcfg->lcfg_bufcount);
222 for (i = 0; i < lcfg->lcfg_bufcount; i++) {
223 lcfg->lcfg_buflens[i] = bufs->lcfg_buflen[i];
224 if (bufs->lcfg_buf[i]) {
225 memcpy(ptr, bufs->lcfg_buf[i], bufs->lcfg_buflen[i]);
226 ptr += __ALIGN_KERNEL(bufs->lcfg_buflen[i], 8);
231 static inline int lustre_cfg_sanity_check(void *buf, size_t len)
233 struct lustre_cfg *lcfg = (struct lustre_cfg *)buf;
238 /* check that the first bits of the struct are valid */
239 if (len < LCFG_HDR_SIZE(0))
242 if (lcfg->lcfg_version != LUSTRE_CFG_VERSION)
245 if (lcfg->lcfg_bufcount >= LUSTRE_CFG_MAX_BUFCOUNT)
248 /* check that the buflens are valid */
249 if (len < LCFG_HDR_SIZE(lcfg->lcfg_bufcount))
252 /* make sure all the pointers point inside the data */
253 if (len < lustre_cfg_len(lcfg->lcfg_bufcount, lcfg->lcfg_buflens))
261 #endif /* _UAPI_LUSTRE_CFG_H_ */