aboutsummaryrefslogtreecommitdiffstats
path: root/drivers/staging/lustre/include/uapi/linux/lustre/lustre_cfg.h
blob: 11b51d93f64c1d09eb506bda42b167c700d9059d (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
/*
 * GPL HEADER START
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 only,
 * as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License version 2 for more details (a copy is included
 * in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU General Public License
 * version 2 along with this program; If not, see
 * http://www.gnu.org/licenses/gpl-2.0.html
 *
 * GPL HEADER END
 */
/*
 * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
 * Use is subject to license terms.
 *
 * Copyright (c) 2012, Intel Corporation.
 */
/*
 * This file is part of Lustre, http://www.lustre.org/
 * Lustre is a trademark of Sun Microsystems, Inc.
 */

#ifndef _UAPI_LUSTRE_CFG_H_
#define _UAPI_LUSTRE_CFG_H_

#include <linux/errno.h>
#include <linux/kernel.h>
#include <uapi/linux/lustre/lustre_user.h>

/** \defgroup cfg cfg
 *
 * @{
 */

/*
 * 1cf6
 * lcfG
 */
#define LUSTRE_CFG_VERSION 0x1cf60001
#define LUSTRE_CFG_MAX_BUFCOUNT 8

#define LCFG_HDR_SIZE(count) \
	__ALIGN_KERNEL(offsetof(struct lustre_cfg, lcfg_buflens[(count)]), 8)

/** If the LCFG_REQUIRED bit is set in a configuration command,
 * then the client is required to understand this parameter
 * in order to mount the filesystem. If it does not understand
 * a REQUIRED command the client mount will fail.
 */
#define LCFG_REQUIRED	0x0001000

enum lcfg_command_type {
	LCFG_ATTACH		  = 0x00cf001, /**< create a new obd instance */
	LCFG_DETACH		  = 0x00cf002, /**< destroy obd instance */
	LCFG_SETUP		  = 0x00cf003, /**< call type-specific setup */
	LCFG_CLEANUP		  = 0x00cf004, /**< call type-specific cleanup
						 */
	LCFG_ADD_UUID		  = 0x00cf005, /**< add a nid to a niduuid */
	LCFG_DEL_UUID		  = 0x00cf006, /**< remove a nid from
						 *  a niduuid
						 */
	LCFG_MOUNTOPT		  = 0x00cf007, /**< create a profile
						 * (mdc, osc)
						 */
	LCFG_DEL_MOUNTOPT	  = 0x00cf008, /**< destroy a profile */
	LCFG_SET_TIMEOUT	  = 0x00cf009, /**< set obd_timeout */
	LCFG_SET_UPCALL		  = 0x00cf00a, /**< deprecated */
	LCFG_ADD_CONN		  = 0x00cf00b, /**< add a failover niduuid to
						 *  an obd
						 */
	LCFG_DEL_CONN		  = 0x00cf00c, /**< remove a failover niduuid */
	LCFG_LOV_ADD_OBD	  = 0x00cf00d, /**< add an osc to a lov */
	LCFG_LOV_DEL_OBD	  = 0x00cf00e, /**< remove an osc from a lov */
	LCFG_PARAM		  = 0x00cf00f, /**< set a proc parameter */
	LCFG_MARKER		  = 0x00cf010, /**< metadata about next
						 *  cfg rec
						 */
	LCFG_LOG_START		  = 0x00ce011, /**< mgc only, process a
						 *  cfg log
						 */
	LCFG_LOG_END		  = 0x00ce012, /**< stop processing updates */
	LCFG_LOV_ADD_INA	  = 0x00ce013, /**< like LOV_ADD_OBD,
						 *  inactive
						 */
	LCFG_ADD_MDC		  = 0x00cf014, /**< add an mdc to a lmv */
	LCFG_DEL_MDC		  = 0x00cf015, /**< remove an mdc from a lmv */
	LCFG_SPTLRPC_CONF	  = 0x00ce016, /**< security */
	LCFG_POOL_NEW		  = 0x00ce020, /**< create an ost pool name */
	LCFG_POOL_ADD		  = 0x00ce021, /**< add an ost to a pool */
	LCFG_POOL_REM		  = 0x00ce022, /**< remove an ost from a pool */
	LCFG_POOL_DEL		  = 0x00ce023, /**< destroy an ost pool name */
	LCFG_SET_LDLM_TIMEOUT	  = 0x00ce030, /**< set ldlm_timeout */
	LCFG_PRE_CLEANUP	  = 0x00cf031, /**< call type-specific pre
						 * cleanup cleanup
						 */
	LCFG_SET_PARAM		  = 0x00ce032, /**< use set_param syntax to set
						 * a proc parameters
						 */
};

struct lustre_cfg_bufs {
	void  *lcfg_buf[LUSTRE_CFG_MAX_BUFCOUNT];
	__u32 lcfg_buflen[LUSTRE_CFG_MAX_BUFCOUNT];
	__u32 lcfg_bufcount;
};

struct lustre_cfg {
	__u32 lcfg_version;
	__u32 lcfg_command;

	__u32 lcfg_num;
	__u32 lcfg_flags;
	__u64 lcfg_nid;
	__u32 lcfg_nal;		/* not used any more */

	__u32 lcfg_bufcount;
	__u32 lcfg_buflens[0];
};

enum cfg_record_type {
	PORTALS_CFG_TYPE	= 1,
	LUSTRE_CFG_TYPE		= 123,
};

#define LUSTRE_CFG_BUFLEN(lcfg, idx)					\
	((lcfg)->lcfg_bufcount <= (idx) ? 0 : (lcfg)->lcfg_buflens[(idx)])

static inline void lustre_cfg_bufs_set(struct lustre_cfg_bufs *bufs,
				       __u32 index, void *buf, __u32 buflen)
{
	if (index >= LUSTRE_CFG_MAX_BUFCOUNT)
		return;

	if (!bufs)
		return;

	if (bufs->lcfg_bufcount <= index)
		bufs->lcfg_bufcount = index + 1;

	bufs->lcfg_buf[index] = buf;
	bufs->lcfg_buflen[index] = buflen;
}

static inline void lustre_cfg_bufs_set_string(struct lustre_cfg_bufs *bufs,
					      __u32 index, char *str)
{
	lustre_cfg_bufs_set(bufs, index, str, str ? strlen(str) + 1 : 0);
}

static inline void lustre_cfg_bufs_reset(struct lustre_cfg_bufs *bufs,
					 char *name)
{
	memset((bufs), 0, sizeof(*bufs));
	if (name)
		lustre_cfg_bufs_set_string(bufs, 0, name);
}

static inline void *lustre_cfg_buf(struct lustre_cfg *lcfg, __u32 index)
{
	__u32 i;
	size_t offset;
	__u32 bufcount;

	if (!lcfg)
		return NULL;

	bufcount = lcfg->lcfg_bufcount;
	if (index >= bufcount)
		return NULL;

	offset = LCFG_HDR_SIZE(lcfg->lcfg_bufcount);
	for (i = 0; i < index; i++)
		offset += __ALIGN_KERNEL(lcfg->lcfg_buflens[i], 8);
	return (char *)lcfg + offset;
}

static inline void lustre_cfg_bufs_init(struct lustre_cfg_bufs *bufs,
					struct lustre_cfg *lcfg)
{
	__u32 i;

	bufs->lcfg_bufcount = lcfg->lcfg_bufcount;
	for (i = 0; i < bufs->lcfg_bufcount; i++) {
		bufs->lcfg_buflen[i] = lcfg->lcfg_buflens[i];
		bufs->lcfg_buf[i] = lustre_cfg_buf(lcfg, i);
	}
}

static inline __u32 lustre_cfg_len(__u32 bufcount, __u32 *buflens)
{
	__u32 i;
	__u32 len;

	len = LCFG_HDR_SIZE(bufcount);
	for (i = 0; i < bufcount; i++)
		len += __ALIGN_KERNEL(buflens[i], 8);

	return __ALIGN_KERNEL(len, 8);
}

static inline void lustre_cfg_init(struct lustre_cfg *lcfg, int cmd,
				   struct lustre_cfg_bufs *bufs)
{
	char *ptr;
	__u32 i;

	lcfg->lcfg_version = LUSTRE_CFG_VERSION;
	lcfg->lcfg_command = cmd;
	lcfg->lcfg_bufcount = bufs->lcfg_bufcount;

	ptr = (char *)lcfg + LCFG_HDR_SIZE(lcfg->lcfg_bufcount);
	for (i = 0; i < lcfg->lcfg_bufcount; i++) {
		lcfg->lcfg_buflens[i] = bufs->lcfg_buflen[i];
		if (bufs->lcfg_buf[i]) {
			memcpy(ptr, bufs->lcfg_buf[i], bufs->lcfg_buflen[i]);
			ptr += __ALIGN_KERNEL(bufs->lcfg_buflen[i], 8);
		}
	}
}

static inline int lustre_cfg_sanity_check(void *buf, size_t len)
{
	struct lustre_cfg *lcfg = (struct lustre_cfg *)buf;

	if (!lcfg)
		return -EINVAL;

	/* check that the first bits of the struct are valid */
	if (len < LCFG_HDR_SIZE(0))
		return -EINVAL;

	if (lcfg->lcfg_version != LUSTRE_CFG_VERSION)
		return -EINVAL;

	if (lcfg->lcfg_bufcount >= LUSTRE_CFG_MAX_BUFCOUNT)
		return -EINVAL;

	/* check that the buflens are valid */
	if (len < LCFG_HDR_SIZE(lcfg->lcfg_bufcount))
		return -EINVAL;

	/* make sure all the pointers point inside the data */
	if (len < lustre_cfg_len(lcfg->lcfg_bufcount, lcfg->lcfg_buflens))
		return -EINVAL;

	return 0;
}

/** @} cfg */

#endif /* _UAPI_LUSTRE_CFG_H_ */