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.sun.com/software/products/lustre/docs/GPLv2.pdf
20 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21 * CA 95054 USA or visit www.sun.com if you need additional information or
27 * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
30 * Copyright (c) 2012, 2014, Intel Corporation.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
40 #include <libcfs/libcfs.h>
41 #include <lustre/lustre_user.h>
44 # include <obd_support.h>
45 #else /* !__KERNEL__ */
48 #endif /* __KERNEL__ */
59 #define LUSTRE_CFG_VERSION 0x1cf60001
60 #define LUSTRE_CFG_MAX_BUFCOUNT 8
62 #define LCFG_HDR_SIZE(count) \
63 cfs_size_round(offsetof (struct lustre_cfg, lcfg_buflens[(count)]))
65 /** If the LCFG_REQUIRED bit is set in a configuration command,
66 * then the client is required to understand this parameter
67 * in order to mount the filesystem. If it does not understand
68 * a REQUIRED command the client mount will fail. */
69 #define LCFG_REQUIRED 0x0001000
71 enum lcfg_command_type {
72 LCFG_ATTACH = 0x00cf001, /**< create a new obd instance */
73 LCFG_DETACH = 0x00cf002, /**< destroy obd instance */
74 LCFG_SETUP = 0x00cf003, /**< call type-specific setup */
75 LCFG_CLEANUP = 0x00cf004, /**< call type-specific cleanup */
76 LCFG_ADD_UUID = 0x00cf005, /**< add a nid to a niduuid */
77 LCFG_DEL_UUID = 0x00cf006, /**< remove a nid from a niduuid */
78 LCFG_MOUNTOPT = 0x00cf007, /**< create a profile (mdc, osc) */
79 LCFG_DEL_MOUNTOPT = 0x00cf008, /**< destroy a profile */
80 LCFG_SET_TIMEOUT = 0x00cf009, /**< set obd_timeout */
81 LCFG_SET_UPCALL = 0x00cf00a, /**< deprecated */
82 LCFG_ADD_CONN = 0x00cf00b, /**< add a failover niduuid to an obd */
83 LCFG_DEL_CONN = 0x00cf00c, /**< remove a failover niduuid */
84 LCFG_LOV_ADD_OBD = 0x00cf00d, /**< add an osc to a lov */
85 LCFG_LOV_DEL_OBD = 0x00cf00e, /**< remove an osc from a lov */
86 LCFG_PARAM = 0x00cf00f, /**< set a proc parameter */
87 LCFG_MARKER = 0x00cf010, /**< metadata about next cfg rec */
88 LCFG_LOG_START = 0x00ce011, /**< mgc only, process a cfg log */
89 LCFG_LOG_END = 0x00ce012, /**< stop processing updates */
90 LCFG_LOV_ADD_INA = 0x00ce013, /**< like LOV_ADD_OBD, inactive */
91 LCFG_ADD_MDC = 0x00cf014, /**< add an mdc to a lmv */
92 LCFG_DEL_MDC = 0x00cf015, /**< remove an mdc from a lmv */
93 LCFG_SPTLRPC_CONF = 0x00ce016, /**< security */
94 LCFG_POOL_NEW = 0x00ce020, /**< create an ost pool name */
95 LCFG_POOL_ADD = 0x00ce021, /**< add an ost to a pool */
96 LCFG_POOL_REM = 0x00ce022, /**< remove an ost from a pool */
97 LCFG_POOL_DEL = 0x00ce023, /**< destroy an ost pool name */
98 LCFG_SET_LDLM_TIMEOUT = 0x00ce030, /**< set ldlm_timeout */
99 LCFG_PRE_CLEANUP = 0x00cf031, /**< call type-specific pre
101 LCFG_SET_PARAM = 0x00ce032, /**< use set_param syntax to set
102 *a proc parameters */
103 LCFG_NODEMAP_ADD = 0x00ce040, /**< create a cluster */
104 LCFG_NODEMAP_DEL = 0x00ce041, /**< destroy a cluster */
105 LCFG_NODEMAP_ADD_RANGE = 0x00ce042, /**< add a nid range */
106 LCFG_NODEMAP_DEL_RANGE = 0x00ce043, /**< delete an nid range */
107 LCFG_NODEMAP_ADD_UIDMAP = 0x00ce044, /**< add a uidmap */
108 LCFG_NODEMAP_DEL_UIDMAP = 0x00ce045, /**< delete a uidmap */
109 LCFG_NODEMAP_ADD_GIDMAP = 0x00ce046, /**< add a gidmap */
110 LCFG_NODEMAP_DEL_GIDMAP = 0x00ce047, /**< delete a gidmap */
111 LCFG_NODEMAP_ACTIVATE = 0x00ce048, /**< activate cluster id mapping */
112 LCFG_NODEMAP_ADMIN = 0x00ce049, /**< allow cluster to use id 0 */
113 LCFG_NODEMAP_TRUSTED = 0x00ce050, /**< trust a clusters ids */
114 LCFG_NODEMAP_SQUASH_UID = 0x00ce051, /**< default map uid */
115 LCFG_NODEMAP_SQUASH_GID = 0x00ce052, /**< default map gid */
116 LCFG_NODEMAP_ADD_SHKEY = 0x00ce053, /**< add shared key to cluster */
117 LCFG_NODEMAP_DEL_SHKEY = 0x00ce054, /**< delete shared key from cluster */
118 LCFG_NODEMAP_TEST_NID = 0x00ce055, /**< test for nodemap membership */
119 LCFG_NODEMAP_TEST_ID = 0x00ce056, /**< test uid/gid mapping */
122 struct lustre_cfg_bufs {
123 void *lcfg_buf[LUSTRE_CFG_MAX_BUFCOUNT];
124 __u32 lcfg_buflen[LUSTRE_CFG_MAX_BUFCOUNT];
135 __u32 lcfg_nal; /* not used any more */
138 __u32 lcfg_buflens[0];
141 enum cfg_record_type {
142 PORTALS_CFG_TYPE = 1,
143 LUSTRE_CFG_TYPE = 123,
146 #define LUSTRE_CFG_BUFLEN(lcfg, idx) \
147 ((lcfg)->lcfg_bufcount <= (idx) \
149 : (lcfg)->lcfg_buflens[(idx)])
151 static inline void lustre_cfg_bufs_set(struct lustre_cfg_bufs *bufs,
156 if (index >= LUSTRE_CFG_MAX_BUFCOUNT)
161 if (bufs->lcfg_bufcount <= index)
162 bufs->lcfg_bufcount = index + 1;
164 bufs->lcfg_buf[index] = buf;
165 bufs->lcfg_buflen[index] = buflen;
168 static inline void lustre_cfg_bufs_set_string(struct lustre_cfg_bufs *bufs,
172 lustre_cfg_bufs_set(bufs, index, str, str ? strlen(str) + 1 : 0);
175 static inline void lustre_cfg_bufs_reset(struct lustre_cfg_bufs *bufs, char *name)
177 memset((bufs), 0, sizeof(*bufs));
179 lustre_cfg_bufs_set_string(bufs, 0, name);
182 static inline void *lustre_cfg_buf(struct lustre_cfg *lcfg, __u32 index)
187 LASSERT (lcfg != NULL);
189 bufcount = lcfg->lcfg_bufcount;
190 if (index >= bufcount)
193 offset = LCFG_HDR_SIZE(lcfg->lcfg_bufcount);
194 for (i = 0; i < index; i++)
195 offset += cfs_size_round(lcfg->lcfg_buflens[i]);
196 return (char *)lcfg + offset;
199 static inline void lustre_cfg_bufs_init(struct lustre_cfg_bufs *bufs,
200 struct lustre_cfg *lcfg)
203 bufs->lcfg_bufcount = lcfg->lcfg_bufcount;
204 for (i = 0; i < bufs->lcfg_bufcount; i++) {
205 bufs->lcfg_buflen[i] = lcfg->lcfg_buflens[i];
206 bufs->lcfg_buf[i] = lustre_cfg_buf(lcfg, i);
210 static inline char *lustre_cfg_string(struct lustre_cfg *lcfg, __u32 index)
214 if (lcfg->lcfg_buflens[index] == 0)
217 s = lustre_cfg_buf(lcfg, index);
222 * make sure it's NULL terminated, even if this kills a char
223 * of data. Try to use the padding first though.
225 if (s[lcfg->lcfg_buflens[index] - 1] != '\0') {
226 size_t last = cfs_size_round(lcfg->lcfg_buflens[index]) - 1;
229 /* Use the smaller value */
230 if (last > lcfg->lcfg_buflens[index])
231 last = lcfg->lcfg_buflens[index];
236 CWARN("Truncated buf %d to '%s' (lost '%c'...)\n",
243 static inline __u32 lustre_cfg_len(__u32 bufcount, __u32 *buflens)
249 len = LCFG_HDR_SIZE(bufcount);
250 for (i = 0; i < bufcount; i++)
251 len += cfs_size_round(buflens[i]);
253 RETURN(cfs_size_round(len));
256 static inline void lustre_cfg_init(struct lustre_cfg *lcfg, int cmd,
257 struct lustre_cfg_bufs *bufs)
262 lcfg->lcfg_version = LUSTRE_CFG_VERSION;
263 lcfg->lcfg_command = cmd;
264 lcfg->lcfg_bufcount = bufs->lcfg_bufcount;
266 ptr = (char *)lcfg + LCFG_HDR_SIZE(lcfg->lcfg_bufcount);
267 for (i = 0; i < lcfg->lcfg_bufcount; i++) {
268 lcfg->lcfg_buflens[i] = bufs->lcfg_buflen[i];
269 LOGL((char *)bufs->lcfg_buf[i], bufs->lcfg_buflen[i], ptr);
273 static inline struct lustre_cfg *lustre_cfg_new(int cmd,
274 struct lustre_cfg_bufs *bufs)
276 struct lustre_cfg *lcfg;
279 OBD_ALLOC(lcfg, lustre_cfg_len(bufs->lcfg_bufcount, bufs->lcfg_buflen));
280 #else /* !__KERNEL__ */
281 lcfg = malloc(lustre_cfg_len(bufs->lcfg_bufcount, bufs->lcfg_buflen));
282 #endif /* __KERNEL__ */
285 lustre_cfg_init(lcfg, cmd, bufs);
290 static inline void lustre_cfg_free(struct lustre_cfg *lcfg)
293 OBD_FREE(lcfg, lustre_cfg_len(lcfg->lcfg_bufcount, lcfg->lcfg_buflens));
294 #else /* ! __KERNEL__ */
296 #endif /* __KERNEL__ */
299 static inline int lustre_cfg_sanity_check(void *buf, size_t len)
301 struct lustre_cfg *lcfg = (struct lustre_cfg *)buf;
306 /* check that the first bits of the struct are valid */
307 if (len < LCFG_HDR_SIZE(0))
310 if (lcfg->lcfg_version != LUSTRE_CFG_VERSION)
313 if (lcfg->lcfg_bufcount >= LUSTRE_CFG_MAX_BUFCOUNT)
316 /* check that the buflens are valid */
317 if (len < LCFG_HDR_SIZE(lcfg->lcfg_bufcount))
320 /* make sure all the pointers point inside the data */
321 if (len < lustre_cfg_len(lcfg->lcfg_bufcount, lcfg->lcfg_buflens))
329 #endif /* _LUSTRE_CFG_H */