1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
6 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 only,
10 * as published by the Free Software Foundation.
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License version 2 for more details (a copy is included
16 * in the LICENSE file that accompanied this code).
18 * You should have received a copy of the GNU General Public License
19 * version 2 along with this program; If not, see
20 * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
22 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
23 * CA 95054 USA or visit www.sun.com if you need additional information or
29 * Copyright 2008 Sun Microsystems, Inc. All rights reserved
30 * Use is subject to license terms.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
49 #define LUSTRE_CFG_VERSION 0x1cf60001
50 #define LUSTRE_CFG_MAX_BUFCOUNT 8
52 #define LCFG_HDR_SIZE(count) \
53 cfs_size_round(offsetof (struct lustre_cfg, lcfg_buflens[(count)]))
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. */
59 #define LCFG_REQUIRED 0x0001000
61 enum lcfg_command_type {
62 LCFG_ATTACH = 0x00cf001,
63 LCFG_DETACH = 0x00cf002,
64 LCFG_SETUP = 0x00cf003,
65 LCFG_CLEANUP = 0x00cf004,
66 LCFG_ADD_UUID = 0x00cf005,
67 LCFG_DEL_UUID = 0x00cf006,
68 LCFG_MOUNTOPT = 0x00cf007,
69 LCFG_DEL_MOUNTOPT = 0x00cf008,
70 LCFG_SET_TIMEOUT = 0x00cf009,
71 LCFG_SET_UPCALL = 0x00cf00a,
72 LCFG_ADD_CONN = 0x00cf00b,
73 LCFG_DEL_CONN = 0x00cf00c,
74 LCFG_LOV_ADD_OBD = 0x00cf00d,
75 LCFG_LOV_DEL_OBD = 0x00cf00e,
76 LCFG_PARAM = 0x00cf00f,
77 LCFG_MARKER = 0x00cf010,
78 LCFG_LOG_START = 0x00ce011,
79 LCFG_LOG_END = 0x00ce012,
80 LCFG_LOV_ADD_INA = 0x00ce013,
81 LCFG_ADD_MDC = 0x00cf014,
82 LCFG_DEL_MDC = 0x00cf015,
83 LCFG_SPTLRPC_CONF = 0x00ce016,
84 LCFG_POOL_NEW = 0x00ce020,
85 LCFG_POOL_ADD = 0x00ce021,
86 LCFG_POOL_REM = 0x00ce022,
87 LCFG_POOL_DEL = 0x00ce023,
88 LCFG_SET_LDLM_TIMEOUT = 0x00ce030,
91 struct lustre_cfg_bufs {
92 void *lcfg_buf[LUSTRE_CFG_MAX_BUFCOUNT];
93 __u32 lcfg_buflen[LUSTRE_CFG_MAX_BUFCOUNT];
97 /* Mountconf transitional hack, should go away after 1.6 */
98 #define LCFG_FLG_MOUNTCONF 0x400
107 __u32 lcfg_nal; /* not used any more */
110 __u32 lcfg_buflens[0];
113 enum cfg_record_type {
114 PORTALS_CFG_TYPE = 1,
115 LUSTRE_CFG_TYPE = 123,
118 #define LUSTRE_CFG_BUFLEN(lcfg, idx) \
119 ((lcfg)->lcfg_bufcount <= (idx) \
121 : (lcfg)->lcfg_buflens[(idx)])
123 static inline void lustre_cfg_bufs_set(struct lustre_cfg_bufs *bufs,
128 if (index >= LUSTRE_CFG_MAX_BUFCOUNT)
133 if (bufs->lcfg_bufcount <= index)
134 bufs->lcfg_bufcount = index + 1;
136 bufs->lcfg_buf[index] = buf;
137 bufs->lcfg_buflen[index] = buflen;
140 static inline void lustre_cfg_bufs_set_string(struct lustre_cfg_bufs *bufs,
144 lustre_cfg_bufs_set(bufs, index, str, str ? strlen(str) + 1 : 0);
147 static inline void lustre_cfg_bufs_reset(struct lustre_cfg_bufs *bufs, char *name)
149 memset((bufs), 0, sizeof(*bufs));
151 lustre_cfg_bufs_set_string(bufs, 0, name);
154 static inline void *lustre_cfg_buf(struct lustre_cfg *lcfg, int index)
159 LASSERT (lcfg != NULL);
160 LASSERT (index >= 0);
162 bufcount = lcfg->lcfg_bufcount;
163 if (index >= bufcount)
166 offset = LCFG_HDR_SIZE(lcfg->lcfg_bufcount);
167 for (i = 0; i < index; i++)
168 offset += cfs_size_round(lcfg->lcfg_buflens[i]);
169 return (char *)lcfg + offset;
172 static inline void lustre_cfg_bufs_init(struct lustre_cfg_bufs *bufs,
173 struct lustre_cfg *lcfg)
176 bufs->lcfg_bufcount = lcfg->lcfg_bufcount;
177 for (i = 0; i < bufs->lcfg_bufcount; i++) {
178 bufs->lcfg_buflen[i] = lcfg->lcfg_buflens[i];
179 bufs->lcfg_buf[i] = lustre_cfg_buf(lcfg, i);
183 static inline char *lustre_cfg_string(struct lustre_cfg *lcfg, int index)
187 if (!lcfg->lcfg_buflens[index])
190 s = lustre_cfg_buf(lcfg, index);
194 /* make sure it's NULL terminated, even if this kills a char
195 * of data. Try to use the padding first though.
197 if (s[lcfg->lcfg_buflens[index] - 1] != '\0') {
198 int last = min((int)lcfg->lcfg_buflens[index],
199 cfs_size_round(lcfg->lcfg_buflens[index]) - 1);
203 CWARN("Truncated buf %d to '%s' (lost '%c'...)\n",
210 static inline int lustre_cfg_len(__u32 bufcount, __u32 *buflens)
216 len = LCFG_HDR_SIZE(bufcount);
217 for (i = 0; i < bufcount; i++)
218 len += cfs_size_round(buflens[i]);
220 RETURN(cfs_size_round(len));
224 #include <obd_support.h>
226 static inline struct lustre_cfg *lustre_cfg_new(int cmd,
227 struct lustre_cfg_bufs *bufs)
229 struct lustre_cfg *lcfg;
235 OBD_ALLOC(lcfg, lustre_cfg_len(bufs->lcfg_bufcount,
238 RETURN(ERR_PTR(-ENOMEM));
240 lcfg->lcfg_version = LUSTRE_CFG_VERSION;
241 lcfg->lcfg_command = cmd;
242 lcfg->lcfg_bufcount = bufs->lcfg_bufcount;
244 ptr = (char *)lcfg + LCFG_HDR_SIZE(lcfg->lcfg_bufcount);
245 for (i = 0; i < lcfg->lcfg_bufcount; i++) {
246 lcfg->lcfg_buflens[i] = bufs->lcfg_buflen[i];
247 LOGL((char *)bufs->lcfg_buf[i], bufs->lcfg_buflen[i], ptr);
252 static inline void lustre_cfg_free(struct lustre_cfg *lcfg)
256 len = lustre_cfg_len(lcfg->lcfg_bufcount, lcfg->lcfg_buflens);
263 static inline int lustre_cfg_sanity_check(void *buf, int len)
265 struct lustre_cfg *lcfg = (struct lustre_cfg *)buf;
270 /* check that the first bits of the struct are valid */
271 if (len < LCFG_HDR_SIZE(0))
274 if (lcfg->lcfg_version != LUSTRE_CFG_VERSION)
277 if (lcfg->lcfg_bufcount >= LUSTRE_CFG_MAX_BUFCOUNT)
280 /* check that the buflens are valid */
281 if (len < LCFG_HDR_SIZE(lcfg->lcfg_bufcount))
284 /* make sure all the pointers point inside the data */
285 if (len < lustre_cfg_len(lcfg->lcfg_bufcount, lcfg->lcfg_buflens))
291 #include <lustre/lustre_user.h>
293 #define INVALID_UID (-1)
297 #endif // _LUSTRE_CFG_H