Whamcloud - gitweb
LU-8851 nodemap: add uid/gid only flags to control mapping
[fs/lustre-release.git] / lustre / include / lustre_cfg.h
1 /*
2  * GPL HEADER START
3  *
4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5  *
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.
9  *
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).
15  *
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.gnu.org/licenses/gpl-2.0.html
19  *
20  * GPL HEADER END
21  */
22 /*
23  * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
24  * Use is subject to license terms.
25  *
26  * Copyright (c) 2012, 2014, Intel Corporation.
27  */
28 /*
29  * This file is part of Lustre, http://www.lustre.org/
30  * Lustre is a trademark of Sun Microsystems, Inc.
31  */
32
33 #ifndef _LUSTRE_CFG_H
34 #define _LUSTRE_CFG_H
35
36 #include <libcfs/libcfs.h>
37 #include <lustre/lustre_user.h>
38
39 #ifdef __KERNEL__
40 # include <obd_support.h>
41 #else /* !__KERNEL__ */
42 # include <malloc.h>
43 # include <stdlib.h>
44 #endif /* __KERNEL__ */
45
46 /** \defgroup cfg cfg
47  *
48  * @{
49  */
50
51 /*
52  * 1cf6
53  * lcfG
54  */
55 #define LUSTRE_CFG_VERSION 0x1cf60001
56 #define LUSTRE_CFG_MAX_BUFCOUNT 8
57
58 #define LCFG_HDR_SIZE(count) \
59     cfs_size_round(offsetof (struct lustre_cfg, lcfg_buflens[(count)]))
60
61 /** If the LCFG_REQUIRED bit is set in a configuration command,
62  * then the client is required to understand this parameter
63  * in order to mount the filesystem. If it does not understand
64  * a REQUIRED command the client mount will fail. */
65 #define LCFG_REQUIRED         0x0001000
66
67 enum lcfg_command_type {
68         LCFG_ATTACH             = 0x00cf001, /**< create a new obd instance */
69         LCFG_DETACH             = 0x00cf002, /**< destroy obd instance */
70         LCFG_SETUP              = 0x00cf003, /**< call type-specific setup */
71         LCFG_CLEANUP            = 0x00cf004, /**< call type-specific cleanup */
72         LCFG_ADD_UUID           = 0x00cf005, /**< add a nid to a niduuid */
73         LCFG_DEL_UUID           = 0x00cf006, /**< remove a nid from a niduuid */
74         LCFG_MOUNTOPT           = 0x00cf007, /**< create a profile (mdc, osc) */
75         LCFG_DEL_MOUNTOPT       = 0x00cf008, /**< destroy a profile */
76         LCFG_SET_TIMEOUT        = 0x00cf009, /**< set obd_timeout */
77         LCFG_SET_UPCALL         = 0x00cf00a, /**< deprecated */
78         LCFG_ADD_CONN           = 0x00cf00b, /**< add a failover niduuid to an obd */
79         LCFG_DEL_CONN           = 0x00cf00c, /**< remove a failover niduuid */
80         LCFG_LOV_ADD_OBD        = 0x00cf00d, /**< add an osc to a lov */
81         LCFG_LOV_DEL_OBD        = 0x00cf00e, /**< remove an osc from a lov */
82         LCFG_PARAM              = 0x00cf00f, /**< set a proc parameter */
83         LCFG_MARKER             = 0x00cf010, /**< metadata about next cfg rec */
84         LCFG_LOG_START          = 0x00ce011, /**< mgc only, process a cfg log */
85         LCFG_LOG_END            = 0x00ce012, /**< stop processing updates */
86         LCFG_LOV_ADD_INA        = 0x00ce013, /**< like LOV_ADD_OBD, inactive */
87         LCFG_ADD_MDC            = 0x00cf014, /**< add an mdc to a lmv */
88         LCFG_DEL_MDC            = 0x00cf015, /**< remove an mdc from a lmv */
89         LCFG_SPTLRPC_CONF       = 0x00ce016, /**< security */
90         LCFG_POOL_NEW           = 0x00ce020, /**< create an ost pool name */
91         LCFG_POOL_ADD           = 0x00ce021, /**< add an ost to a pool */
92         LCFG_POOL_REM           = 0x00ce022, /**< remove an ost from a pool */
93         LCFG_POOL_DEL           = 0x00ce023, /**< destroy an ost pool name */
94         LCFG_SET_LDLM_TIMEOUT   = 0x00ce030, /**< set ldlm_timeout */
95         LCFG_PRE_CLEANUP        = 0x00cf031, /**< call type-specific pre
96                                               * cleanup cleanup */
97         LCFG_SET_PARAM          = 0x00ce032, /**< use set_param syntax to set
98                                               *a proc parameters */
99         LCFG_NODEMAP_ADD        = 0x00ce040, /**< create a cluster */
100         LCFG_NODEMAP_DEL        = 0x00ce041, /**< destroy a cluster */
101         LCFG_NODEMAP_ADD_RANGE  = 0x00ce042, /**< add a nid range */
102         LCFG_NODEMAP_DEL_RANGE  = 0x00ce043, /**< delete an nid range */
103         LCFG_NODEMAP_ADD_UIDMAP = 0x00ce044, /**< add a uidmap */
104         LCFG_NODEMAP_DEL_UIDMAP = 0x00ce045, /**< delete a uidmap */
105         LCFG_NODEMAP_ADD_GIDMAP = 0x00ce046, /**< add a gidmap */
106         LCFG_NODEMAP_DEL_GIDMAP = 0x00ce047, /**< delete a gidmap */
107         LCFG_NODEMAP_ACTIVATE   = 0x00ce048, /**< activate cluster id mapping */
108         LCFG_NODEMAP_ADMIN      = 0x00ce049, /**< allow cluster to use id 0 */
109         LCFG_NODEMAP_TRUSTED    = 0x00ce050, /**< trust a clusters ids */
110         LCFG_NODEMAP_SQUASH_UID = 0x00ce051, /**< default map uid */
111         LCFG_NODEMAP_SQUASH_GID = 0x00ce052, /**< default map gid */
112         LCFG_NODEMAP_ADD_SHKEY  = 0x00ce053, /**< add shared key to cluster */
113         LCFG_NODEMAP_DEL_SHKEY  = 0x00ce054, /**< delete shared key from cluster */
114         LCFG_NODEMAP_TEST_NID   = 0x00ce055, /**< test for nodemap membership */
115         LCFG_NODEMAP_TEST_ID    = 0x00ce056, /**< test uid/gid mapping */
116         LCFG_NODEMAP_SET_FILESET   = 0x00ce057, /**< set fileset */
117         LCFG_NODEMAP_DENY_UNKNOWN  = 0x00ce058, /**< deny squashed nodemap users */
118         LCFG_NODEMAP_MAP_MODE  = 0x00ce059, /**< set the mapping mode */
119 };
120
121 struct lustre_cfg_bufs {
122         void    *lcfg_buf[LUSTRE_CFG_MAX_BUFCOUNT];
123         __u32    lcfg_buflen[LUSTRE_CFG_MAX_BUFCOUNT];
124         __u32    lcfg_bufcount;
125 };
126
127 struct lustre_cfg {
128         __u32 lcfg_version;
129         __u32 lcfg_command;
130
131         __u32 lcfg_num;
132         __u32 lcfg_flags;
133         __u64 lcfg_nid;
134         __u32 lcfg_nal;         /* not used any more */
135
136         __u32 lcfg_bufcount;
137         __u32 lcfg_buflens[0];
138 };
139
140 enum cfg_record_type {
141         PORTALS_CFG_TYPE = 1,
142         LUSTRE_CFG_TYPE = 123,
143 };
144
145 #define LUSTRE_CFG_BUFLEN(lcfg, idx)            \
146         ((lcfg)->lcfg_bufcount <= (idx)         \
147          ? 0                                    \
148          : (lcfg)->lcfg_buflens[(idx)])
149
150 static inline void lustre_cfg_bufs_set(struct lustre_cfg_bufs *bufs,
151                                        __u32                   index,
152                                        void                   *buf,
153                                        __u32                   buflen)
154 {
155         if (index >= LUSTRE_CFG_MAX_BUFCOUNT)
156                 return;
157         if (bufs == NULL)
158                 return;
159
160         if (bufs->lcfg_bufcount <= index)
161                 bufs->lcfg_bufcount = index + 1;
162
163         bufs->lcfg_buf[index]    = buf;
164         bufs->lcfg_buflen[index] = buflen;
165 }
166
167 static inline void lustre_cfg_bufs_set_string(struct lustre_cfg_bufs *bufs,
168                                               __u32 index,
169                                               char *str)
170 {
171         lustre_cfg_bufs_set(bufs, index, str, str ? strlen(str) + 1 : 0);
172 }
173
174 static inline void lustre_cfg_bufs_reset(struct lustre_cfg_bufs *bufs, char *name)
175 {
176         memset((bufs), 0, sizeof(*bufs));
177         if (name)
178                 lustre_cfg_bufs_set_string(bufs, 0, name);
179 }
180
181 static inline void *lustre_cfg_buf(struct lustre_cfg *lcfg, __u32 index)
182 {
183         __u32 i;
184         size_t offset;
185         __u32 bufcount;
186
187         if (!lcfg)
188                 return NULL;
189
190         bufcount = lcfg->lcfg_bufcount;
191         if (index >= bufcount)
192                 return NULL;
193
194         offset = LCFG_HDR_SIZE(lcfg->lcfg_bufcount);
195         for (i = 0; i < index; i++)
196                 offset += cfs_size_round(lcfg->lcfg_buflens[i]);
197         return (char *)lcfg + offset;
198 }
199
200 static inline void lustre_cfg_bufs_init(struct lustre_cfg_bufs *bufs,
201                                         struct lustre_cfg *lcfg)
202 {
203         __u32 i;
204         bufs->lcfg_bufcount = lcfg->lcfg_bufcount;
205         for (i = 0; i < bufs->lcfg_bufcount; i++) {
206                 bufs->lcfg_buflen[i] = lcfg->lcfg_buflens[i];
207                 bufs->lcfg_buf[i] = lustre_cfg_buf(lcfg, i);
208         }
209 }
210
211 static inline char *lustre_cfg_string(struct lustre_cfg *lcfg, __u32 index)
212 {
213         char *s;
214
215         if (lcfg->lcfg_buflens[index] == 0)
216                 return NULL;
217
218         s = lustre_cfg_buf(lcfg, index);
219         if (s == NULL)
220                 return NULL;
221
222         /*
223          * make sure it's NULL terminated, even if this kills a char
224          * of data.  Try to use the padding first though.
225          */
226         if (s[lcfg->lcfg_buflens[index] - 1] != '\0') {
227                 size_t last = cfs_size_round(lcfg->lcfg_buflens[index]) - 1;
228                 char lost;
229
230                 /* Use the smaller value */
231                 if (last > lcfg->lcfg_buflens[index])
232                         last = lcfg->lcfg_buflens[index];
233
234                 lost = s[last];
235                 s[last] = '\0';
236                 if (lost != '\0') {
237                         CWARN("Truncated buf %d to '%s' (lost '%c'...)\n",
238                               index, s, lost);
239                 }
240         }
241         return s;
242 }
243
244 static inline __u32 lustre_cfg_len(__u32 bufcount, __u32 *buflens)
245 {
246         __u32 i;
247         __u32 len;
248         ENTRY;
249
250         len = LCFG_HDR_SIZE(bufcount);
251         for (i = 0; i < bufcount; i++)
252                 len += cfs_size_round(buflens[i]);
253
254         RETURN(cfs_size_round(len));
255 }
256
257 static inline void lustre_cfg_init(struct lustre_cfg *lcfg, int cmd,
258                                    struct lustre_cfg_bufs *bufs)
259 {
260         char *ptr;
261         __u32 i;
262
263         lcfg->lcfg_version = LUSTRE_CFG_VERSION;
264         lcfg->lcfg_command = cmd;
265         lcfg->lcfg_bufcount = bufs->lcfg_bufcount;
266
267         ptr = (char *)lcfg + LCFG_HDR_SIZE(lcfg->lcfg_bufcount);
268         for (i = 0; i < lcfg->lcfg_bufcount; i++) {
269                 lcfg->lcfg_buflens[i] = bufs->lcfg_buflen[i];
270                 if (bufs->lcfg_buf[i]) {
271                         memcpy(ptr, bufs->lcfg_buf[i], bufs->lcfg_buflen[i]);
272                         ptr += cfs_size_round(bufs->lcfg_buflen[i]);
273                 }
274         }
275 }
276
277 static inline struct lustre_cfg *lustre_cfg_new(int cmd,
278                                                 struct lustre_cfg_bufs *bufs)
279 {
280         struct lustre_cfg       *lcfg;
281
282 #ifdef __KERNEL__
283         OBD_ALLOC(lcfg, lustre_cfg_len(bufs->lcfg_bufcount, bufs->lcfg_buflen));
284 #else /* !__KERNEL__ */
285         lcfg = malloc(lustre_cfg_len(bufs->lcfg_bufcount, bufs->lcfg_buflen));
286 #endif /* __KERNEL__ */
287
288         if (lcfg != NULL)
289                 lustre_cfg_init(lcfg, cmd, bufs);
290
291         return lcfg;
292 }
293
294 static inline void lustre_cfg_free(struct lustre_cfg *lcfg)
295 {
296 #ifdef __KERNEL__
297         OBD_FREE(lcfg, lustre_cfg_len(lcfg->lcfg_bufcount, lcfg->lcfg_buflens));
298 #else /* ! __KERNEL__ */
299         free(lcfg);
300 #endif /* __KERNEL__ */
301 }
302
303 static inline int lustre_cfg_sanity_check(void *buf, size_t len)
304 {
305         struct lustre_cfg *lcfg = (struct lustre_cfg *)buf;
306         ENTRY;
307         if (!lcfg)
308                 RETURN(-EINVAL);
309
310         /* check that the first bits of the struct are valid */
311         if (len < LCFG_HDR_SIZE(0))
312                 RETURN(-EINVAL);
313
314         if (lcfg->lcfg_version != LUSTRE_CFG_VERSION)
315                 RETURN(-EINVAL);
316
317         if (lcfg->lcfg_bufcount >= LUSTRE_CFG_MAX_BUFCOUNT)
318                 RETURN(-EINVAL);
319
320         /* check that the buflens are valid */
321         if (len < LCFG_HDR_SIZE(lcfg->lcfg_bufcount))
322                 RETURN(-EINVAL);
323
324         /* make sure all the pointers point inside the data */
325         if (len < lustre_cfg_len(lcfg->lcfg_bufcount, lcfg->lcfg_buflens))
326                 RETURN(-EINVAL);
327
328         RETURN(0);
329 }
330
331 /** @} cfg */
332
333 #endif /* _LUSTRE_CFG_H */