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 not LCFG_REQUIRED, we can ignore this cmd and go on. */
51 #define LCFG_REQUIRED 0x0001000
53 enum lcfg_command_type {
54 LCFG_ATTACH = 0x00cf001,
55 LCFG_DETACH = 0x00cf002,
56 LCFG_SETUP = 0x00cf003,
57 LCFG_CLEANUP = 0x00cf004,
58 LCFG_ADD_UUID = 0x00cf005,
59 LCFG_DEL_UUID = 0x00cf006,
60 LCFG_MOUNTOPT = 0x00cf007,
61 LCFG_DEL_MOUNTOPT = 0x00cf008,
62 LCFG_SET_TIMEOUT = 0x00cf009,
63 LCFG_SET_UPCALL = 0x00cf00a,
64 LCFG_ADD_CONN = 0x00cf00b,
65 LCFG_DEL_CONN = 0x00cf00c,
66 LCFG_LOV_ADD_OBD = 0x00cf00d,
67 LCFG_LOV_DEL_OBD = 0x00cf00e,
68 LCFG_PARAM = 0x00cf00f,
69 LCFG_MARKER = 0x00cf010,
70 LCFG_LOG_START = 0x00ce011,
71 LCFG_LOG_END = 0x00ce012,
72 LCFG_LOV_ADD_INA = 0x00ce013,
73 LCFG_ADD_MDC = 0x00cf014,
74 LCFG_DEL_MDC = 0x00cf015,
75 LCFG_SPTLRPC_CONF = 0x00ce016,
78 struct lustre_cfg_bufs {
79 void *lcfg_buf[LUSTRE_CFG_MAX_BUFCOUNT];
80 __u32 lcfg_buflen[LUSTRE_CFG_MAX_BUFCOUNT];
84 /* Mountconf transitional hack, should go away after 1.6 */
85 #define LCFG_FLG_MOUNTCONF 0x400
94 __u32 lcfg_nal; /* not used any more */
97 __u32 lcfg_buflens[0];
100 enum cfg_record_type {
101 PORTALS_CFG_TYPE = 1,
102 LUSTRE_CFG_TYPE = 123,
105 #define LUSTRE_CFG_BUFLEN(lcfg, idx) \
106 ((lcfg)->lcfg_bufcount <= (idx) \
108 : (lcfg)->lcfg_buflens[(idx)])
110 static inline void lustre_cfg_bufs_set(struct lustre_cfg_bufs *bufs,
115 if (index >= LUSTRE_CFG_MAX_BUFCOUNT)
120 if (bufs->lcfg_bufcount <= index)
121 bufs->lcfg_bufcount = index + 1;
123 bufs->lcfg_buf[index] = buf;
124 bufs->lcfg_buflen[index] = buflen;
127 static inline void lustre_cfg_bufs_set_string(struct lustre_cfg_bufs *bufs,
131 lustre_cfg_bufs_set(bufs, index, str, str ? strlen(str) + 1 : 0);
134 static inline void lustre_cfg_bufs_reset(struct lustre_cfg_bufs *bufs, char *name)
136 memset((bufs), 0, sizeof(*bufs));
138 lustre_cfg_bufs_set_string(bufs, 0, name);
141 static inline void *lustre_cfg_buf(struct lustre_cfg *lcfg, int index)
146 LASSERT (lcfg != NULL);
147 LASSERT (index >= 0);
149 bufcount = lcfg->lcfg_bufcount;
150 if (index >= bufcount)
153 offset = LCFG_HDR_SIZE(lcfg->lcfg_bufcount);
154 for (i = 0; i < index; i++)
155 offset += size_round(lcfg->lcfg_buflens[i]);
156 return (char *)lcfg + offset;
159 static inline void lustre_cfg_bufs_init(struct lustre_cfg_bufs *bufs,
160 struct lustre_cfg *lcfg)
163 bufs->lcfg_bufcount = lcfg->lcfg_bufcount;
164 for (i = 0; i < bufs->lcfg_bufcount; i++) {
165 bufs->lcfg_buflen[i] = lcfg->lcfg_buflens[i];
166 bufs->lcfg_buf[i] = lustre_cfg_buf(lcfg, i);
170 static inline char *lustre_cfg_string(struct lustre_cfg *lcfg, int index)
174 if (!lcfg->lcfg_buflens[index])
177 s = lustre_cfg_buf(lcfg, index);
181 /* make sure it's NULL terminated, even if this kills a char
182 * of data. Try to use the padding first though.
184 if (s[lcfg->lcfg_buflens[index] - 1] != '\0') {
185 int last = min((int)lcfg->lcfg_buflens[index],
186 size_round(lcfg->lcfg_buflens[index]) - 1);
190 CWARN("Truncated buf %d to '%s' (lost '%c'...)\n",
197 static inline int lustre_cfg_len(__u32 bufcount, __u32 *buflens)
203 len = LCFG_HDR_SIZE(bufcount);
204 for (i = 0; i < bufcount; i++)
205 len += size_round(buflens[i]);
207 RETURN(size_round(len));
211 #include <obd_support.h>
213 static inline struct lustre_cfg *lustre_cfg_new(int cmd,
214 struct lustre_cfg_bufs *bufs)
216 struct lustre_cfg *lcfg;
222 OBD_ALLOC(lcfg, lustre_cfg_len(bufs->lcfg_bufcount,
227 lcfg->lcfg_version = LUSTRE_CFG_VERSION;
228 lcfg->lcfg_command = cmd;
229 lcfg->lcfg_bufcount = bufs->lcfg_bufcount;
231 ptr = (char *)lcfg + LCFG_HDR_SIZE(lcfg->lcfg_bufcount);
232 for (i = 0; i < lcfg->lcfg_bufcount; i++) {
233 lcfg->lcfg_buflens[i] = bufs->lcfg_buflen[i];
234 LOGL((char *)bufs->lcfg_buf[i], bufs->lcfg_buflen[i], ptr);
239 static inline void lustre_cfg_free(struct lustre_cfg *lcfg)
243 len = lustre_cfg_len(lcfg->lcfg_bufcount, lcfg->lcfg_buflens);
250 static inline int lustre_cfg_sanity_check(void *buf, int len)
252 struct lustre_cfg *lcfg = (struct lustre_cfg *)buf;
257 /* check that the first bits of the struct are valid */
258 if (len < LCFG_HDR_SIZE(0))
261 if (lcfg->lcfg_version != LUSTRE_CFG_VERSION)
264 if (lcfg->lcfg_bufcount >= LUSTRE_CFG_MAX_BUFCOUNT)
267 /* check that the buflens are valid */
268 if (len < LCFG_HDR_SIZE(lcfg->lcfg_bufcount))
271 /* make sure all the pointers point inside the data */
272 if (len < lustre_cfg_len(lcfg->lcfg_bufcount, lcfg->lcfg_buflens))
278 #include <lustre/lustre_user.h>
280 #define INVALID_UID (-1)
282 #endif // _LUSTRE_CFG_H