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_sb
{
45 struct super_block
*z_sb
; /* generic super_block */
46 struct backing_dev_info z_bdi
; /* generic backing dev info */
47 struct zfs_sb
*z_parent
; /* parent fs */
48 objset_t
*z_os
; /* objset reference */
49 uint64_t z_flags
; /* super_block flags */
50 uint64_t z_root
; /* id of root znode */
51 uint64_t z_unlinkedobj
; /* id of unlinked zapobj */
52 uint64_t z_max_blksz
; /* maximum block size for files */
53 uint64_t z_fuid_obj
; /* fuid table object number */
54 uint64_t z_fuid_size
; /* fuid table size */
55 avl_tree_t z_fuid_idx
; /* fuid tree keyed by index */
56 avl_tree_t z_fuid_domain
; /* fuid tree keyed by domain */
57 krwlock_t z_fuid_lock
; /* fuid lock */
58 boolean_t z_fuid_loaded
; /* fuid tables are loaded */
59 boolean_t z_fuid_dirty
; /* need to sync fuid table ? */
60 struct zfs_fuid_info
*z_fuid_replay
; /* fuid info for replay */
61 zilog_t
*z_log
; /* intent log pointer */
62 uint_t z_acl_inherit
; /* acl inheritance behavior */
63 zfs_case_t z_case
; /* case-sense */
64 boolean_t z_utf8
; /* utf8-only */
65 int z_norm
; /* normalization flags */
66 boolean_t z_atime
; /* enable atimes mount option */
67 boolean_t z_unmounted
; /* unmounted */
68 rrwlock_t z_teardown_lock
;
69 krwlock_t z_teardown_inactive_lock
;
70 list_t z_all_znodes
; /* all vnodes in the fs */
71 kmutex_t z_znodes_lock
; /* lock for z_all_znodes */
72 struct inode
*z_ctldir
; /* .zfs directory inode */
73 boolean_t z_show_ctldir
; /* expose .zfs in the root dir */
74 boolean_t z_issnap
; /* true if this is a snapshot */
75 boolean_t z_vscan
; /* virus scan on/off */
76 boolean_t z_use_fuids
; /* version allows fuids */
77 boolean_t z_replay
; /* set during ZIL replay */
78 boolean_t z_use_sa
; /* version allow system attributes */
79 boolean_t z_xattr_sa
; /* allow xattrs to be stores as SA */
80 uint64_t z_version
; /* ZPL version */
81 uint64_t z_shares_dir
; /* hidden shares dir */
83 uint64_t z_userquota_obj
;
84 uint64_t z_groupquota_obj
;
85 uint64_t z_replay_eof
; /* New end of file - replay only */
86 sa_attr_type_t
*z_attr_table
; /* SA attr mapping->id */
87 #define ZFS_OBJ_MTX_SZ 64
88 kmutex_t z_hold_mtx
[ZFS_OBJ_MTX_SZ
]; /* znode hold locks */
91 #define ZFS_SUPER_MAGIC 0x2fc12fc1
93 #define ZSB_XATTR 0x0001 /* Enable user xattrs */
97 * Minimal snapshot helpers, the bulk of the Linux snapshot implementation
98 * lives in the zpl_snap.c file which is part of the zpl source.
100 #define ZFS_CTLDIR_NAME ".zfs"
102 #define zfs_has_ctldir(zdp) \
103 ((zdp)->z_id == ZTOZSB(zdp)->z_root && \
104 (ZTOZSB(zdp)->z_ctldir != NULL))
105 #define zfs_show_ctldir(zdp) \
106 (zfs_has_ctldir(zdp) && \
107 (ZTOZSB(zdp)->z_show_ctldir))
109 #define ZFSCTL_INO_ROOT 0x1
110 #define ZFSCTL_INO_SNAPDIR 0x2
111 #define ZFSCTL_INO_SHARES 0x3
114 * Allow a maximum number of links. While ZFS does not internally limit
115 * this most Linux filesystems do. It's probably a good idea to limit
116 * this to a large value until it is validated that this is safe.
118 #define ZFS_LINK_MAX 65536
121 * Normal filesystems (those not under .zfs/snapshot) have a total
122 * file ID size limited to 12 bytes (including the length field) due to
123 * NFSv2 protocol's limitation of 32 bytes for a filehandle. For historical
124 * reasons, this same limit is being imposed by the Solaris NFSv3 implementation
125 * (although the NFSv3 protocol actually permits a maximum of 64 bytes). It
126 * is not possible to expand beyond 12 bytes without abandoning support
129 * For normal filesystems, we partition up the available space as follows:
130 * 2 bytes fid length (required)
131 * 6 bytes object number (48 bits)
132 * 4 bytes generation number (32 bits)
134 * We reserve only 48 bits for the object number, as this is the limit
135 * currently defined and imposed by the DMU.
137 typedef struct zfid_short
{
139 uint8_t zf_object
[6]; /* obj[i] = obj >> (8 * i) */
140 uint8_t zf_gen
[4]; /* gen[i] = gen >> (8 * i) */
144 * Filesystems under .zfs/snapshot have a total file ID size of 22 bytes
145 * (including the length field). This makes files under .zfs/snapshot
146 * accessible by NFSv3 and NFSv4, but not NFSv2.
148 * For files under .zfs/snapshot, we partition up the available space
150 * 2 bytes fid length (required)
151 * 6 bytes object number (48 bits)
152 * 4 bytes generation number (32 bits)
153 * 6 bytes objset id (48 bits)
154 * 4 bytes currently just zero (32 bits)
156 * We reserve only 48 bits for the object number and objset id, as these are
157 * the limits currently defined and imposed by the DMU.
159 typedef struct zfid_long
{
161 uint8_t zf_setid
[6]; /* obj[i] = obj >> (8 * i) */
162 uint8_t zf_setgen
[4]; /* gen[i] = gen >> (8 * i) */
165 #define SHORT_FID_LEN (sizeof (zfid_short_t) - sizeof (uint16_t))
166 #define LONG_FID_LEN (sizeof (zfid_long_t) - sizeof (uint16_t))
168 extern uint_t zfs_fsyncer_key
;
170 extern int zfs_suspend_fs(zfs_sb_t
*zsb
);
171 extern int zfs_resume_fs(zfs_sb_t
*zsb
, const char *osname
);
172 extern int zfs_userspace_one(zfs_sb_t
*zsb
, zfs_userquota_prop_t type
,
173 const char *domain
, uint64_t rid
, uint64_t *valuep
);
174 extern int zfs_userspace_many(zfs_sb_t
*zsb
, zfs_userquota_prop_t type
,
175 uint64_t *cookiep
, void *vbuf
, uint64_t *bufsizep
);
176 extern int zfs_set_userquota(zfs_sb_t
*zsb
, zfs_userquota_prop_t type
,
177 const char *domain
, uint64_t rid
, uint64_t quota
);
178 extern boolean_t
zfs_owner_overquota(zfs_sb_t
*zsb
, struct znode
*,
180 extern boolean_t
zfs_fuid_overquota(zfs_sb_t
*zsb
, boolean_t isgroup
,
182 extern int zfs_set_version(zfs_sb_t
*zsb
, uint64_t newvers
);
183 extern int zfs_get_zplprop(objset_t
*os
, zfs_prop_t prop
,
185 extern int zfs_sb_create(const char *name
, zfs_sb_t
**zsbp
);
186 extern int zfs_sb_setup(zfs_sb_t
*zsb
, boolean_t mounting
);
187 extern void zfs_sb_free(zfs_sb_t
*zsb
);
188 extern int zfs_sb_teardown(zfs_sb_t
*zsb
, boolean_t unmounting
);
189 extern int zfs_check_global_label(const char *dsname
, const char *hexsl
);
190 extern boolean_t
zfs_is_readonly(zfs_sb_t
*zsb
);
192 extern int zfs_register_callbacks(zfs_sb_t
*zsb
);
193 extern void zfs_unregister_callbacks(zfs_sb_t
*zsb
);
194 extern int zfs_domount(struct super_block
*sb
, void *data
, int silent
);
195 extern int zfs_umount(struct super_block
*sb
);
196 extern int zfs_remount(struct super_block
*sb
, int *flags
, char *data
);
197 extern int zfs_root(zfs_sb_t
*zsb
, struct inode
**ipp
);
198 extern int zfs_statvfs(struct dentry
*dentry
, struct kstatfs
*statp
);
199 extern int zfs_vget(struct super_block
*sb
, struct inode
**ipp
, fid_t
*fidp
);
205 #endif /* _SYS_FS_ZFS_VFSOPS_H */