xref: /illumos-gate/usr/src/uts/common/fs/zfs/sys/zfs_fuid.h (revision 2f172c55ef76964744bc62b4500ece87f3089b4d)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9  * or http://www.opensolaris.org/os/licensing.
10  * See the License for the specific language governing permissions
11  * and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL HEADER in each
14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15  * If applicable, add the following below this CDDL HEADER, with the
16  * fields enclosed by brackets "[]" replaced with your own identifying
17  * information: Portions Copyright [yyyy] [name of copyright owner]
18  *
19  * CDDL HEADER END
20  */
21 /*
22  * Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
23  * Use is subject to license terms.
24  */
25 
26 #ifndef	_SYS_FS_ZFS_FUID_H
27 #define	_SYS_FS_ZFS_FUID_H
28 
29 #ifdef _KERNEL
30 #include <sys/kidmap.h>
31 #include <sys/sid.h>
32 #include <sys/dmu.h>
33 #include <sys/zfs_vfsops.h>
34 #endif
35 #include <sys/avl.h>
36 
37 #ifdef	__cplusplus
38 extern "C" {
39 #endif
40 
41 typedef enum {
42 	ZFS_OWNER,
43 	ZFS_GROUP,
44 	ZFS_ACE_USER,
45 	ZFS_ACE_GROUP
46 } zfs_fuid_type_t;
47 
48 /*
49  * Estimate space needed for one more fuid table entry.
50  * for now assume its current size + 1K
51  */
52 #define	FUID_SIZE_ESTIMATE(z) ((z)->z_fuid_size + (SPA_MINBLOCKSIZE << 1))
53 
54 #define	FUID_INDEX(x)	((x) >> 32)
55 #define	FUID_RID(x)	((x) & 0xffffffff)
56 #define	FUID_ENCODE(idx, rid) (((uint64_t)(idx) << 32) | (rid))
57 /*
58  * FUIDs cause problems for the intent log
59  * we need to replay the creation of the FUID,
60  * but we can't count on the idmapper to be around
61  * and during replay the FUID index may be different than
62  * before.  Also, if an ACL has 100 ACEs and 12 different
63  * domains we don't want to log 100 domain strings, but rather
64  * just the unique 12.
65  */
66 
67 /*
68  * The FUIDs in the log will index into
69  * domain string table and the bottom half will be the rid.
70  * Used for mapping ephemeral uid/gid during ACL setting to FUIDs
71  */
72 typedef struct zfs_fuid {
73 	list_node_t 	z_next;
74 	uint64_t 	z_id;		/* uid/gid being converted to fuid */
75 	uint64_t	z_domidx;	/* index in AVL domain table */
76 	uint64_t	z_logfuid;	/* index for domain in log */
77 } zfs_fuid_t;
78 
79 /* list of unique domains */
80 typedef struct zfs_fuid_domain {
81 	list_node_t	z_next;
82 	uint64_t	z_domidx;	/* AVL tree idx */
83 	const char	*z_domain;	/* domain string */
84 } zfs_fuid_domain_t;
85 
86 /*
87  * FUID information necessary for logging create, setattr, and setacl.
88  */
89 typedef struct zfs_fuid_info {
90 	list_t	z_fuids;
91 	list_t	z_domains;
92 	uint64_t z_fuid_owner;
93 	uint64_t z_fuid_group;
94 	char **z_domain_table;  /* Used during replay */
95 	uint32_t z_fuid_cnt;	/* How many fuids in z_fuids */
96 	uint32_t z_domain_cnt;	/* How many domains */
97 	size_t	z_domain_str_sz; /* len of domain strings z_domain list */
98 } zfs_fuid_info_t;
99 
100 #ifdef _KERNEL
101 struct znode;
102 extern uid_t zfs_fuid_map_id(zfsvfs_t *, uint64_t, cred_t *, zfs_fuid_type_t);
103 extern void zfs_fuid_destroy(zfsvfs_t *);
104 extern uint64_t zfs_fuid_create_cred(zfsvfs_t *, zfs_fuid_type_t,
105     cred_t *, zfs_fuid_info_t **);
106 extern uint64_t zfs_fuid_create(zfsvfs_t *, uint64_t, cred_t *, zfs_fuid_type_t,
107     zfs_fuid_info_t **);
108 extern void zfs_fuid_map_ids(struct znode *zp, cred_t *cr,
109     uid_t *uid, uid_t *gid);
110 extern zfs_fuid_info_t *zfs_fuid_info_alloc(void);
111 extern void zfs_fuid_info_free(zfs_fuid_info_t *);
112 extern boolean_t zfs_groupmember(zfsvfs_t *, uint64_t, cred_t *);
113 void zfs_fuid_sync(zfsvfs_t *, dmu_tx_t *);
114 extern int zfs_fuid_find_by_domain(zfsvfs_t *, const char *domain,
115     char **retdomain, boolean_t addok);
116 extern const char *zfs_fuid_find_by_idx(zfsvfs_t *zfsvfs, uint32_t idx);
117 extern void zfs_fuid_txhold(zfsvfs_t *zfsvfs, dmu_tx_t *tx);
118 #endif
119 
120 char *zfs_fuid_idx_domain(avl_tree_t *, uint32_t);
121 void zfs_fuid_avl_tree_create(avl_tree_t *, avl_tree_t *);
122 uint64_t zfs_fuid_table_load(objset_t *, uint64_t, avl_tree_t *, avl_tree_t *);
123 void zfs_fuid_table_destroy(avl_tree_t *, avl_tree_t *);
124 
125 #ifdef	__cplusplus
126 }
127 #endif
128 
129 #endif	/* _SYS_FS_ZFS_FUID_H */
130