Whamcloud - gitweb
LU-1095 debug: Common client/server message standardization
[fs/lustre-release.git] / lustre / include / lustre_idmap.h
1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2  * vim:expandtab:shiftwidth=8:tabstop=8:
3  *
4  * GPL HEADER START
5  *
6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
7  *
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.
11  *
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).
17  *
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
21  *
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
24  * have any questions.
25  *
26  * GPL HEADER END
27  */
28 /*
29  * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
30  * Use is subject to license terms.
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 <md_object.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         cfs_spinlock_t   lit_lock;
78         cfs_list_t       lit_idmaps[CFS_IDMAP_N_HASHES][CFS_IDMAP_HASHSIZE];
79 };
80
81 extern void lustre_groups_from_list(cfs_group_info_t *ginfo, gid_t *glist);
82 extern void lustre_groups_sort(cfs_group_info_t *group_info);
83 extern int lustre_in_group_p(struct md_ucred *mu, gid_t grp);
84
85 extern int lustre_idmap_add(struct lustre_idmap_table *t,
86                             uid_t ruid, uid_t luid,
87                             gid_t rgid, gid_t lgid);
88 extern int lustre_idmap_del(struct lustre_idmap_table *t,
89                             uid_t ruid, uid_t luid,
90                             gid_t rgid, gid_t lgid);
91 extern int lustre_idmap_lookup_uid(struct md_ucred *mu,
92                                    struct lustre_idmap_table *t,
93                                    int reverse, uid_t uid);
94 extern int lustre_idmap_lookup_gid(struct md_ucred *mu,
95                                    struct lustre_idmap_table *t,
96                                    int reverse, gid_t gid);
97 extern struct lustre_idmap_table *lustre_idmap_init(void);
98 extern void lustre_idmap_fini(struct lustre_idmap_table *t);
99
100 /** @} idmap */
101
102 #endif