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.
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.
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]
22 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
25 #ifndef _SYS_FS_ZFS_VFSOPS_H
26 #define _SYS_FS_ZFS_VFSOPS_H
28 #include <sys/isa_defs.h>
29 #include <sys/types32.h>
34 #include <sys/rrwlock.h>
35 #include <sys/zfs_ioctl.h>
41 typedef struct zfsvfs zfsvfs_t;
45 vfs_t *z_vfs; /* generic fs struct */
46 zfsvfs_t *z_parent; /* parent fs */
47 objset_t *z_os; /* objset reference */
48 uint64_t z_root; /* id of root znode */
49 uint64_t z_unlinkedobj; /* id of unlinked zapobj */
50 uint64_t z_max_blksz; /* maximum block size for files */
51 uint64_t z_fuid_obj; /* fuid table object number */
52 uint64_t z_fuid_size; /* fuid table size */
53 avl_tree_t z_fuid_idx; /* fuid tree keyed by index */
54 avl_tree_t z_fuid_domain; /* fuid tree keyed by domain */
55 krwlock_t z_fuid_lock; /* fuid lock */
56 boolean_t z_fuid_loaded; /* fuid tables are loaded */
57 boolean_t z_fuid_dirty; /* need to sync fuid table ? */
58 struct zfs_fuid_info *z_fuid_replay; /* fuid info for replay */
59 zilog_t *z_log; /* intent log pointer */
60 uint_t z_acl_inherit; /* acl inheritance behavior */
61 zfs_case_t z_case; /* case-sense */
62 boolean_t z_utf8; /* utf8-only */
63 int z_norm; /* normalization flags */
64 boolean_t z_atime; /* enable atimes mount option */
65 boolean_t z_unmounted; /* unmounted */
66 rrwlock_t z_teardown_lock;
67 krwlock_t z_teardown_inactive_lock;
68 list_t z_all_znodes; /* all vnodes in the fs */
69 kmutex_t z_znodes_lock; /* lock for z_all_znodes */
70 struct inode *z_ctldir; /* .zfs directory inode */
71 boolean_t z_show_ctldir; /* expose .zfs in the root dir */
72 boolean_t z_issnap; /* true if this is a snapshot */
73 boolean_t z_vscan; /* virus scan on/off */
74 boolean_t z_use_fuids; /* version allows fuids */
75 boolean_t z_replay; /* set during ZIL replay */
76 boolean_t z_use_sa; /* version allow system attributes */
77 uint64_t z_version; /* ZPL version */
78 uint64_t z_shares_dir; /* hidden shares dir */
80 uint64_t z_userquota_obj;
81 uint64_t z_groupquota_obj;
82 uint64_t z_replay_eof; /* New end of file - replay only */
83 sa_attr_type_t *z_attr_table; /* SA attr mapping->id */
84 #define ZFS_OBJ_MTX_SZ 64
85 kmutex_t z_hold_mtx[ZFS_OBJ_MTX_SZ]; /* znode hold locks */
88 #define ZFS_SUPER_MAGIC 0x2fc12fc1
92 * Minimal snapshot helpers, the bulk of the Linux snapshot implementation
93 * lives in the zpl_snap.c file which is part of the zpl source.
95 #define ZFS_CTLDIR_NAME ".zfs"
97 #define zfs_has_ctldir(zdp) \
98 ((zdp)->z_id == ZTOZSB(zdp)->z_root && \
99 (ZTOZSB(zdp)->z_ctldir != NULL))
100 #define zfs_show_ctldir(zdp) \
101 (zfs_has_ctldir(zdp) && \
102 (ZTOZSB(zdp)->z_show_ctldir))
104 #define ZFSCTL_INO_ROOT 0x1
105 #define ZFSCTL_INO_SNAPDIR 0x2
106 #define ZFSCTL_INO_SHARES 0x3
109 * Allow a maximum number of links. While ZFS does not internally limit
110 * this most Linux filesystems do. It's probably a good idea to limit
111 * this to a large value until it is validated that this is safe.
113 #define ZFS_LINK_MAX 65536
116 * Normal filesystems (those not under .zfs/snapshot) have a total
117 * file ID size limited to 12 bytes (including the length field) due to
118 * NFSv2 protocol's limitation of 32 bytes for a filehandle. For historical
119 * reasons, this same limit is being imposed by the Solaris NFSv3 implementation
120 * (although the NFSv3 protocol actually permits a maximum of 64 bytes). It
121 * is not possible to expand beyond 12 bytes without abandoning support
124 * For normal filesystems, we partition up the available space as follows:
125 * 2 bytes fid length (required)
126 * 6 bytes object number (48 bits)
127 * 4 bytes generation number (32 bits)
129 * We reserve only 48 bits for the object number, as this is the limit
130 * currently defined and imposed by the DMU.
132 typedef struct zfid_short {
134 uint8_t zf_object[6]; /* obj[i] = obj >> (8 * i) */
135 uint8_t zf_gen[4]; /* gen[i] = gen >> (8 * i) */
139 * Filesystems under .zfs/snapshot have a total file ID size of 22 bytes
140 * (including the length field). This makes files under .zfs/snapshot
141 * accessible by NFSv3 and NFSv4, but not NFSv2.
143 * For files under .zfs/snapshot, we partition up the available space
145 * 2 bytes fid length (required)
146 * 6 bytes object number (48 bits)
147 * 4 bytes generation number (32 bits)
148 * 6 bytes objset id (48 bits)
149 * 4 bytes currently just zero (32 bits)
151 * We reserve only 48 bits for the object number and objset id, as these are
152 * the limits currently defined and imposed by the DMU.
154 typedef struct zfid_long {
156 uint8_t zf_setid[6]; /* obj[i] = obj >> (8 * i) */
157 uint8_t zf_setgen[4]; /* gen[i] = gen >> (8 * i) */
160 #define SHORT_FID_LEN (sizeof (zfid_short_t) - sizeof (uint16_t))
161 #define LONG_FID_LEN (sizeof (zfid_long_t) - sizeof (uint16_t))
163 extern uint_t zfs_fsyncer_key;
165 extern int zfs_suspend_fs(zfsvfs_t *zfsvfs);
166 extern int zfs_resume_fs(zfsvfs_t *zfsvfs, const char *osname);
167 extern int zfs_userspace_one(zfsvfs_t *zfsvfs, zfs_userquota_prop_t type,
168 const char *domain, uint64_t rid, uint64_t *valuep);
169 extern int zfs_userspace_many(zfsvfs_t *zfsvfs, zfs_userquota_prop_t type,
170 uint64_t *cookiep, void *vbuf, uint64_t *bufsizep);
171 extern int zfs_set_userquota(zfsvfs_t *zfsvfs, zfs_userquota_prop_t type,
172 const char *domain, uint64_t rid, uint64_t quota);
173 extern boolean_t zfs_owner_overquota(zfsvfs_t *zfsvfs, struct znode *,
175 extern boolean_t zfs_fuid_overquota(zfsvfs_t *zfsvfs, boolean_t isgroup,
177 extern int zfs_set_version(zfsvfs_t *zfsvfs, uint64_t newvers);
178 extern int zfsvfs_create(const char *name, zfsvfs_t **zfvp);
179 extern void zfsvfs_free(zfsvfs_t *zfsvfs);
180 extern int zfs_check_global_label(const char *dsname, const char *hexsl);
182 extern int zfs_register_callbacks(vfs_t *vfsp);
183 extern void zfs_unregister_callbacks(zfsvfs_t *zfsvfs);
184 extern int zfs_domount(vfs_t *vfsp, char *osname);
185 extern int zfs_umount(vfs_t *vfsp, int fflag, cred_t *cr);
186 extern int zfs_root(vfs_t *vfsp, vnode_t **vpp);
187 extern int zfs_statvfs(vfs_t *vfsp, struct statvfs64 *statp);
188 extern int zfs_vget(vfs_t *vfsp, vnode_t **vpp, fid_t *fidp);
194 #endif /* _SYS_FS_ZFS_VFSOPS_H */