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