Whamcloud - gitweb
LU-1330 obdclass: splits server-side object stack from client
[fs/lustre-release.git] / lustre / include / lustre_idmap.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.sun.com/software/products/lustre/docs/GPLv2.pdf
19  *
20  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21  * CA 95054 USA or visit www.sun.com if you need additional information or
22  * have any questions.
23  *
24  * GPL HEADER END
25  */
26 /*
27  * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
28  * Use is subject to license terms.
29  *
30  * Copyright (c) 2012, Intel Corporation.
31  */
32 /*
33  * This file is part of Lustre, http://www.lustre.org/
34  * Lustre is a trademark of Sun Microsystems, Inc.
35  *
36  * lustre/lustre/include/lustre_idmap.h
37  *
38  * MDS data structures.
39  * See also lustre_idl.h for wire formats of requests.
40  */
41
42 #ifndef _LUSTRE_IDMAP_H
43 #define _LUSTRE_IDMAP_H
44
45 /** \defgroup idmap idmap
46  *
47  * @{
48  */
49
50 #include <libcfs/libcfs.h>
51
52 #define CFS_NGROUPS_PER_BLOCK   ((int)(CFS_PAGE_SIZE / sizeof(gid_t)))
53
54 #define CFS_GROUP_AT(gi, i) \
55         ((gi)->blocks[(i) / CFS_NGROUPS_PER_BLOCK][(i) % CFS_NGROUPS_PER_BLOCK])
56
57 enum {
58         CFS_IC_NOTHING     = 0,    /* convert nothing */
59         CFS_IC_ALL         = 1,    /* convert all items */
60         CFS_IC_MAPPED      = 2,    /* convert mapped uid/gid */
61         CFS_IC_UNMAPPED    = 3     /* convert unmapped uid/gid */
62 };
63
64 #define  CFS_IDMAP_NOTFOUND     (-1)
65
66 #define CFS_IDMAP_HASHSIZE      32
67
68 enum lustre_idmap_idx {
69         RMT_UIDMAP_IDX,
70         LCL_UIDMAP_IDX,
71         RMT_GIDMAP_IDX,
72         LCL_GIDMAP_IDX,
73         CFS_IDMAP_N_HASHES
74 };
75
76 struct lustre_idmap_table {
77         spinlock_t      lit_lock;
78         cfs_list_t      lit_idmaps[CFS_IDMAP_N_HASHES][CFS_IDMAP_HASHSIZE];
79 };
80
81 struct lu_ucred;
82
83 extern void lustre_groups_from_list(cfs_group_info_t *ginfo, gid_t *glist);
84 extern void lustre_groups_sort(cfs_group_info_t *group_info);
85 extern int lustre_in_group_p(struct lu_ucred *mu, gid_t grp);
86
87 extern int lustre_idmap_add(struct lustre_idmap_table *t,
88                             uid_t ruid, uid_t luid,
89                             gid_t rgid, gid_t lgid);
90 extern int lustre_idmap_del(struct lustre_idmap_table *t,
91                             uid_t ruid, uid_t luid,
92                             gid_t rgid, gid_t lgid);
93 extern int lustre_idmap_lookup_uid(struct lu_ucred *mu,
94                                    struct lustre_idmap_table *t,
95                                    int reverse, uid_t uid);
96 extern int lustre_idmap_lookup_gid(struct lu_ucred *mu,
97                                    struct lustre_idmap_table *t,
98                                    int reverse, gid_t gid);
99 extern struct lustre_idmap_table *lustre_idmap_init(void);
100 extern void lustre_idmap_fini(struct lustre_idmap_table *t);
101
102 /** @} idmap */
103
104 #endif