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 2010 Sun Microsystems, Inc. All rights reserved.
23 * Use is subject to license terms.
24 *
25 * Copyright 2017 Nexenta Systems, Inc. All rights reserved.
26 */
27
28 #ifndef _SYS_FS_ZFS_FUID_H
29 #define _SYS_FS_ZFS_FUID_H
30
31 #ifdef _KERNEL
32 #include <sys/kidmap.h>
33 #include <sys/sid.h>
34 #include <sys/dmu.h>
35 #include <sys/zfs_vfsops.h>
36 #endif
37 #include <sys/avl.h>
38
39 #ifdef __cplusplus
40 extern "C" {
41 #endif
42
43 typedef enum {
44 ZFS_OWNER,
45 ZFS_GROUP,
46 ZFS_ACE_USER,
47 ZFS_ACE_GROUP
48 } zfs_fuid_type_t;
49
50 /*
51 * Estimate space needed for one more fuid table entry.
52 * for now assume its current size + 1K
53 */
54 #define FUID_SIZE_ESTIMATE(z) ((z)->z_fuid_size + (SPA_MINBLOCKSIZE << 1))
55
56 #define FUID_INDEX(x) ((x) >> 32)
57 #define FUID_RID(x) ((x) & 0xffffffff)
58 #define FUID_ENCODE(idx, rid) (((uint64_t)(idx) << 32) | (rid))
59 /*
60 * FUIDs cause problems for the intent log
61 * we need to replay the creation of the FUID,
62 * but we can't count on the idmapper to be around
63 * and during replay the FUID index may be different than
64 * before. Also, if an ACL has 100 ACEs and 12 different
65 * domains we don't want to log 100 domain strings, but rather
66 * just the unique 12.
67 */
68
69 /*
70 * The FUIDs in the log will index into
71 * domain string table and the bottom half will be the rid.
72 * Used for mapping ephemeral uid/gid during ACL setting to FUIDs
73 */
74 typedef struct zfs_fuid {
75 list_node_t z_next;
76 uint64_t z_id; /* uid/gid being converted to fuid */
77 uint64_t z_domidx; /* index in AVL domain table */
78 uint64_t z_logfuid; /* index for domain in log */
79 } zfs_fuid_t;
80
81 /* list of unique domains */
82 typedef struct zfs_fuid_domain {
83 list_node_t z_next;
84 uint64_t z_domidx; /* AVL tree idx */
85 const char *z_domain; /* domain string */
86 } zfs_fuid_domain_t;
87
88 /*
89 * FUID information necessary for logging create, setattr, and setacl.
90 */
91 typedef struct zfs_fuid_info {
92 list_t z_fuids;
93 list_t z_domains;
94 uint64_t z_fuid_owner;
95 uint64_t z_fuid_group;
96 char **z_domain_table; /* Used during replay */
97 uint32_t z_fuid_cnt; /* How many fuids in z_fuids */
98 uint32_t z_domain_cnt; /* How many domains */
99 size_t z_domain_str_sz; /* len of domain strings z_domain list */
100 } zfs_fuid_info_t;
101
102 #ifdef _KERNEL
103 struct znode;
104 extern uid_t zfs_fuid_map_id(zfsvfs_t *, uint64_t, cred_t *, zfs_fuid_type_t);
105 extern void zfs_fuid_node_add(zfs_fuid_info_t **, const char *, uint32_t,
106 uint64_t, uint64_t, zfs_fuid_type_t);
107 extern void zfs_fuid_destroy(zfsvfs_t *);
108 extern uint64_t zfs_fuid_create_cred(zfsvfs_t *, zfs_fuid_type_t,
109 cred_t *, zfs_fuid_info_t **);
110 extern uint64_t zfs_fuid_create(zfsvfs_t *, uint64_t, cred_t *, zfs_fuid_type_t,
111 zfs_fuid_info_t **);
112 extern void zfs_fuid_map_ids(struct znode *zp, cred_t *cr,
113 uid_t *uid, uid_t *gid);
114 extern zfs_fuid_info_t *zfs_fuid_info_alloc(void);
115 extern void zfs_fuid_info_free(zfs_fuid_info_t *);
116 extern boolean_t zfs_user_in_cred(zfsvfs_t *, uint64_t, cred_t *);
117 extern boolean_t zfs_groupmember(zfsvfs_t *, uint64_t, cred_t *);
118 void zfs_fuid_sync(zfsvfs_t *, dmu_tx_t *);
119 extern int zfs_fuid_find_by_domain(zfsvfs_t *, const char *domain,
120 char **retdomain, boolean_t addok);
121 extern const char *zfs_fuid_find_by_idx(zfsvfs_t *zfsvfs, uint32_t idx);
122 extern void zfs_fuid_txhold(zfsvfs_t *zfsvfs, dmu_tx_t *tx);
123 #endif
124
125 char *zfs_fuid_idx_domain(avl_tree_t *, uint32_t);
126 void zfs_fuid_avl_tree_create(avl_tree_t *, avl_tree_t *);
127 uint64_t zfs_fuid_table_load(objset_t *, uint64_t, avl_tree_t *, avl_tree_t *);
128 void zfs_fuid_table_destroy(avl_tree_t *, avl_tree_t *);
129
130 #ifdef __cplusplus
131 }
132 #endif
133
134 #endif /* _SYS_FS_ZFS_FUID_H */