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.
44 #define LUSTRE_CFG_VERSION 0x1cf60001
45 #define LUSTRE_CFG_MAX_BUFCOUNT 8
47 #define LCFG_HDR_SIZE(count) \
48 size_round(offsetof (struct lustre_cfg, lcfg_buflens[(count)]))
50 /* If the LCFG_REQUIRED bit is set in a configuration command,
51 * then the client is required to understand this parameter
52 * in order to mount the filesystem. If it does not understand
53 * a REQUIRED command the client mount will fail. */
54 #define LCFG_REQUIRED 0x0001000
56 enum lcfg_command_type {
57 LCFG_ATTACH = 0x00cf001,
58 LCFG_DETACH = 0x00cf002,
59 LCFG_SETUP = 0x00cf003,
60 LCFG_CLEANUP = 0x00cf004,
61 LCFG_ADD_UUID = 0x00cf005,
62 LCFG_DEL_UUID = 0x00cf006,
63 LCFG_MOUNTOPT = 0x00cf007,
64 LCFG_DEL_MOUNTOPT = 0x00cf008,
65 LCFG_SET_TIMEOUT = 0x00cf009,
66 LCFG_SET_UPCALL = 0x00cf00a,
67 LCFG_ADD_CONN = 0x00cf00b,
68 LCFG_DEL_CONN = 0x00cf00c,
69 LCFG_LOV_ADD_OBD = 0x00cf00d,
70 LCFG_LOV_DEL_OBD = 0x00cf00e,
71 LCFG_PARAM = 0x00cf00f,
72 LCFG_MARKER = 0x00cf010,
73 LCFG_LOG_START = 0x00ce011,
74 LCFG_LOG_END = 0x00ce012,
75 LCFG_LOV_ADD_INA = 0x00ce013,
76 LCFG_ADD_MDC = 0x00cf014,
77 LCFG_DEL_MDC = 0x00cf015,
78 LCFG_SPTLRPC_CONF = 0x00ce016,
79 LCFG_POOL_NEW = 0x00ce020,
80 LCFG_POOL_ADD = 0x00ce021,
81 LCFG_POOL_REM = 0x00ce022,
82 LCFG_POOL_DEL = 0x00ce023,
83 LCFG_SET_LDLM_TIMEOUT = 0x00ce030,
86 struct lustre_cfg_bufs {
87 void *lcfg_buf[LUSTRE_CFG_MAX_BUFCOUNT];
88 __u32 lcfg_buflen[LUSTRE_CFG_MAX_BUFCOUNT];
92 /* Mountconf transitional hack, should go away after 1.6 */
93 #define LCFG_FLG_MOUNTCONF 0x400
102 __u32 lcfg_nal; /* not used any more */
105 __u32 lcfg_buflens[0];
108 enum cfg_record_type {
109 PORTALS_CFG_TYPE = 1,
110 LUSTRE_CFG_TYPE = 123,
113 #define LUSTRE_CFG_BUFLEN(lcfg, idx) \
114 ((lcfg)->lcfg_bufcount <= (idx) \
116 : (lcfg)->lcfg_buflens[(idx)])
118 static inline void lustre_cfg_bufs_set(struct lustre_cfg_bufs *bufs,
123 if (index >= LUSTRE_CFG_MAX_BUFCOUNT)
128 if (bufs->lcfg_bufcount <= index)
129 bufs->lcfg_bufcount = index + 1;
131 bufs->lcfg_buf[index] = buf;
132 bufs->lcfg_buflen[index] = buflen;
135 static inline void lustre_cfg_bufs_set_string(struct lustre_cfg_bufs *bufs,
139 lustre_cfg_bufs_set(bufs, index, str, str ? strlen(str) + 1 : 0);
142 static inline void lustre_cfg_bufs_reset(struct lustre_cfg_bufs *bufs, char *name)
144 memset((bufs), 0, sizeof(*bufs));
146 lustre_cfg_bufs_set_string(bufs, 0, name);
149 static inline void *lustre_cfg_buf(struct lustre_cfg *lcfg, int index)
154 LASSERT (lcfg != NULL);
155 LASSERT (index >= 0);
157 bufcount = lcfg->lcfg_bufcount;
158 if (index >= bufcount)
161 offset = LCFG_HDR_SIZE(lcfg->lcfg_bufcount);
162 for (i = 0; i < index; i++)
163 offset += size_round(lcfg->lcfg_buflens[i]);
164 return (char *)lcfg + offset;
167 static inline void lustre_cfg_bufs_init(struct lustre_cfg_bufs *bufs,
168 struct lustre_cfg *lcfg)
171 bufs->lcfg_bufcount = lcfg->lcfg_bufcount;
172 for (i = 0; i < bufs->lcfg_bufcount; i++) {
173 bufs->lcfg_buflen[i] = lcfg->lcfg_buflens[i];
174 bufs->lcfg_buf[i] = lustre_cfg_buf(lcfg, i);
178 static inline char *lustre_cfg_string(struct lustre_cfg *lcfg, int index)
182 if (!lcfg->lcfg_buflens[index])
185 s = lustre_cfg_buf(lcfg, index);
189 /* make sure it's NULL terminated, even if this kills a char
190 * of data. Try to use the padding first though.
192 if (s[lcfg->lcfg_buflens[index] - 1] != '\0') {
193 int last = min((int)lcfg->lcfg_buflens[index],
194 size_round(lcfg->lcfg_buflens[index]) - 1);
198 CWARN("Truncated buf %d to '%s' (lost '%c'...)\n",
205 static inline int lustre_cfg_len(__u32 bufcount, __u32 *buflens)
211 len = LCFG_HDR_SIZE(bufcount);
212 for (i = 0; i < bufcount; i++)
213 len += size_round(buflens[i]);
215 RETURN(size_round(len));
219 #include <obd_support.h>
221 static inline struct lustre_cfg *lustre_cfg_new(int cmd,
222 struct lustre_cfg_bufs *bufs)
224 struct lustre_cfg *lcfg;
230 OBD_ALLOC(lcfg, lustre_cfg_len(bufs->lcfg_bufcount,
233 RETURN(ERR_PTR(-ENOMEM));
235 lcfg->lcfg_version = LUSTRE_CFG_VERSION;
236 lcfg->lcfg_command = cmd;
237 lcfg->lcfg_bufcount = bufs->lcfg_bufcount;
239 ptr = (char *)lcfg + LCFG_HDR_SIZE(lcfg->lcfg_bufcount);
240 for (i = 0; i < lcfg->lcfg_bufcount; i++) {
241 lcfg->lcfg_buflens[i] = bufs->lcfg_buflen[i];
242 LOGL((char *)bufs->lcfg_buf[i], bufs->lcfg_buflen[i], ptr);
247 static inline void lustre_cfg_free(struct lustre_cfg *lcfg)
251 len = lustre_cfg_len(lcfg->lcfg_bufcount, lcfg->lcfg_buflens);
258 static inline int lustre_cfg_sanity_check(void *buf, int len)
260 struct lustre_cfg *lcfg = (struct lustre_cfg *)buf;
265 /* check that the first bits of the struct are valid */
266 if (len < LCFG_HDR_SIZE(0))
269 if (lcfg->lcfg_version != LUSTRE_CFG_VERSION)
272 if (lcfg->lcfg_bufcount >= LUSTRE_CFG_MAX_BUFCOUNT)
275 /* check that the buflens are valid */
276 if (len < LCFG_HDR_SIZE(lcfg->lcfg_bufcount))
279 /* make sure all the pointers point inside the data */
280 if (len < lustre_cfg_len(lcfg->lcfg_bufcount, lcfg->lcfg_buflens))
286 #include <lustre/lustre_user.h>
288 #define INVALID_UID (-1)
290 #endif // _LUSTRE_CFG_H