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>
44 typedef struct zfs_mntopts
{
45 char *z_osname
; /* Objset name */
46 char *z_mntpoint
; /* Primary mount point */
49 boolean_t z_do_readonly
;
51 boolean_t z_do_setuid
;
55 boolean_t z_do_devices
;
60 boolean_t z_do_relatime
;
62 boolean_t z_do_nbmand
;
65 typedef struct zfs_sb
{
66 struct super_block
*z_sb
; /* generic super_block */
67 struct backing_dev_info z_bdi
; /* generic backing dev info */
68 struct zfs_sb
*z_parent
; /* parent fs */
69 objset_t
*z_os
; /* objset reference */
70 zfs_mntopts_t
*z_mntopts
; /* passed mount options */
71 uint64_t z_flags
; /* super_block flags */
72 uint64_t z_root
; /* id of root znode */
73 uint64_t z_unlinkedobj
; /* id of unlinked zapobj */
74 uint64_t z_max_blksz
; /* maximum block size for files */
75 uint64_t z_fuid_obj
; /* fuid table object number */
76 uint64_t z_fuid_size
; /* fuid table size */
77 avl_tree_t z_fuid_idx
; /* fuid tree keyed by index */
78 avl_tree_t z_fuid_domain
; /* fuid tree keyed by domain */
79 krwlock_t z_fuid_lock
; /* fuid lock */
80 boolean_t z_fuid_loaded
; /* fuid tables are loaded */
81 boolean_t z_fuid_dirty
; /* need to sync fuid table ? */
82 struct zfs_fuid_info
*z_fuid_replay
; /* fuid info for replay */
83 zilog_t
*z_log
; /* intent log pointer */
84 uint_t z_acl_inherit
; /* acl inheritance behavior */
85 uint_t z_acl_type
; /* type of ACL usable on this FS */
86 zfs_case_t z_case
; /* case-sense */
87 boolean_t z_utf8
; /* utf8-only */
88 int z_norm
; /* normalization flags */
89 boolean_t z_atime
; /* enable atimes mount option */
90 boolean_t z_relatime
; /* enable relatime mount option */
91 boolean_t z_unmounted
; /* unmounted */
92 rrmlock_t z_teardown_lock
;
93 krwlock_t z_teardown_inactive_lock
;
94 list_t z_all_znodes
; /* all znodes in the fs */
95 uint64_t z_nr_znodes
; /* number of znodes in the fs */
96 unsigned long z_rollback_time
; /* last online rollback time */
97 unsigned long z_snap_defer_time
; /* last snapshot unmount deferal */
98 kmutex_t z_znodes_lock
; /* lock for z_all_znodes */
99 arc_prune_t
*z_arc_prune
; /* called by ARC to prune caches */
100 struct inode
*z_ctldir
; /* .zfs directory inode */
101 boolean_t z_show_ctldir
; /* expose .zfs in the root dir */
102 boolean_t z_issnap
; /* true if this is a snapshot */
103 boolean_t z_vscan
; /* virus scan on/off */
104 boolean_t z_use_fuids
; /* version allows fuids */
105 boolean_t z_replay
; /* set during ZIL replay */
106 boolean_t z_use_sa
; /* version allow system attributes */
107 boolean_t z_xattr_sa
; /* allow xattrs to be stores as SA */
108 uint64_t z_version
; /* ZPL version */
109 uint64_t z_shares_dir
; /* hidden shares dir */
111 uint64_t z_userquota_obj
;
112 uint64_t z_groupquota_obj
;
113 uint64_t z_replay_eof
; /* New end of file - replay only */
114 sa_attr_type_t
*z_attr_table
; /* SA attr mapping->id */
115 #define ZFS_OBJ_MTX_SZ 256
116 kmutex_t
*z_hold_mtx
; /* znode hold locks */
119 #define ZFS_SUPER_MAGIC 0x2fc12fc1
121 #define ZSB_XATTR 0x0001 /* Enable user xattrs */
124 * Allow a maximum number of links. While ZFS does not internally limit
125 * this the inode->i_nlink member is defined as an unsigned int. To be
126 * safe we use 2^31-1 as the limit.
128 #define ZFS_LINK_MAX ((1U << 31) - 1U)
131 * Normal filesystems (those not under .zfs/snapshot) have a total
132 * file ID size limited to 12 bytes (including the length field) due to
133 * NFSv2 protocol's limitation of 32 bytes for a filehandle. For historical
134 * reasons, this same limit is being imposed by the Solaris NFSv3 implementation
135 * (although the NFSv3 protocol actually permits a maximum of 64 bytes). It
136 * is not possible to expand beyond 12 bytes without abandoning support
139 * For normal filesystems, we partition up the available space as follows:
140 * 2 bytes fid length (required)
141 * 6 bytes object number (48 bits)
142 * 4 bytes generation number (32 bits)
144 * We reserve only 48 bits for the object number, as this is the limit
145 * currently defined and imposed by the DMU.
147 typedef struct zfid_short
{
149 uint8_t zf_object
[6]; /* obj[i] = obj >> (8 * i) */
150 uint8_t zf_gen
[4]; /* gen[i] = gen >> (8 * i) */
154 * Filesystems under .zfs/snapshot have a total file ID size of 22 bytes
155 * (including the length field). This makes files under .zfs/snapshot
156 * accessible by NFSv3 and NFSv4, but not NFSv2.
158 * For files under .zfs/snapshot, we partition up the available space
160 * 2 bytes fid length (required)
161 * 6 bytes object number (48 bits)
162 * 4 bytes generation number (32 bits)
163 * 6 bytes objset id (48 bits)
164 * 4 bytes currently just zero (32 bits)
166 * We reserve only 48 bits for the object number and objset id, as these are
167 * the limits currently defined and imposed by the DMU.
169 typedef struct zfid_long
{
171 uint8_t zf_setid
[6]; /* obj[i] = obj >> (8 * i) */
172 uint8_t zf_setgen
[4]; /* gen[i] = gen >> (8 * i) */
175 #define SHORT_FID_LEN (sizeof (zfid_short_t) - sizeof (uint16_t))
176 #define LONG_FID_LEN (sizeof (zfid_long_t) - sizeof (uint16_t))
178 extern uint_t zfs_fsyncer_key
;
180 extern int zfs_suspend_fs(zfs_sb_t
*zsb
);
181 extern int zfs_resume_fs(zfs_sb_t
*zsb
, const char *osname
);
182 extern int zfs_userspace_one(zfs_sb_t
*zsb
, zfs_userquota_prop_t type
,
183 const char *domain
, uint64_t rid
, uint64_t *valuep
);
184 extern int zfs_userspace_many(zfs_sb_t
*zsb
, zfs_userquota_prop_t type
,
185 uint64_t *cookiep
, void *vbuf
, uint64_t *bufsizep
);
186 extern int zfs_set_userquota(zfs_sb_t
*zsb
, zfs_userquota_prop_t type
,
187 const char *domain
, uint64_t rid
, uint64_t quota
);
188 extern boolean_t
zfs_owner_overquota(zfs_sb_t
*zsb
, struct znode
*,
190 extern boolean_t
zfs_fuid_overquota(zfs_sb_t
*zsb
, boolean_t isgroup
,
192 extern int zfs_set_version(zfs_sb_t
*zsb
, uint64_t newvers
);
193 extern int zfs_get_zplprop(objset_t
*os
, zfs_prop_t prop
,
195 extern zfs_mntopts_t
*zfs_mntopts_alloc(void);
196 extern void zfs_mntopts_free(zfs_mntopts_t
*zmo
);
197 extern int zfs_sb_create(const char *name
, zfs_mntopts_t
*zmo
,
199 extern int zfs_sb_setup(zfs_sb_t
*zsb
, boolean_t mounting
);
200 extern void zfs_sb_free(zfs_sb_t
*zsb
);
201 extern int zfs_sb_prune(struct super_block
*sb
, unsigned long nr_to_scan
,
203 extern int zfs_sb_teardown(zfs_sb_t
*zsb
, boolean_t unmounting
);
204 extern int zfs_check_global_label(const char *dsname
, const char *hexsl
);
205 extern boolean_t
zfs_is_readonly(zfs_sb_t
*zsb
);
207 extern int zfs_register_callbacks(zfs_sb_t
*zsb
);
208 extern void zfs_unregister_callbacks(zfs_sb_t
*zsb
);
209 extern int zfs_domount(struct super_block
*sb
, zfs_mntopts_t
*zmo
, int silent
);
210 extern void zfs_preumount(struct super_block
*sb
);
211 extern int zfs_umount(struct super_block
*sb
);
212 extern int zfs_remount(struct super_block
*sb
, int *flags
, zfs_mntopts_t
*zmo
);
213 extern int zfs_root(zfs_sb_t
*zsb
, struct inode
**ipp
);
214 extern int zfs_statvfs(struct dentry
*dentry
, struct kstatfs
*statp
);
215 extern int zfs_vget(struct super_block
*sb
, struct inode
**ipp
, fid_t
*fidp
);
221 #endif /* _SYS_FS_ZFS_VFSOPS_H */