initial commit
[freebsd-arm:freebsd-arm.git] / cddl / contrib / opensolaris / uts / common / fs / zfs / sys / zfs_vfsops.h
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 2008 Sun Microsystems, Inc.  All rights reserved.
23  * Use is subject to license terms.
24  */
25
26 #ifndef _SYS_FS_ZFS_VFSOPS_H
27 #define _SYS_FS_ZFS_VFSOPS_H
28
29 #pragma ident   "%Z%%M% %I%     %E% SMI"
30
31 #include <sys/list.h>
32 #include <sys/vfs.h>
33 #include <sys/zil.h>
34 #include <sys/rrwlock.h>
35 #include <sys/zfs_ioctl.h>
36
37 #ifdef  __cplusplus
38 extern "C" {
39 #endif
40
41 typedef struct zfsvfs zfsvfs_t;
42
43 struct zfsvfs {
44         vfs_t           *z_vfs;         /* generic fs struct */
45         zfsvfs_t        *z_parent;      /* parent fs */
46         objset_t        *z_os;          /* objset reference */
47         uint64_t        z_root;         /* id of root znode */
48         uint64_t        z_unlinkedobj;  /* id of unlinked zapobj */
49         uint64_t        z_max_blksz;    /* maximum block size for files */
50         uint64_t        z_assign;       /* TXG_NOWAIT or set by zil_replay() */
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         struct zfs_fuid_info    *z_fuid_replay; /* fuid info for replay */
58         zilog_t         *z_log;         /* intent log pointer */
59         uint_t          z_acl_mode;     /* acl chmod/mode behavior */
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         vnode_t         *z_ctldir;      /* .zfs directory pointer */
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         kmutex_t        z_online_recv_lock; /* recv in prog grabs as WRITER */
76         uint64_t        z_version;      /* ZPL version */
77 #define ZFS_OBJ_MTX_SZ  64
78         kmutex_t        z_hold_mtx[ZFS_OBJ_MTX_SZ];     /* znode hold locks */
79 };
80
81 /*
82  * Normal filesystems (those not under .zfs/snapshot) have a total
83  * file ID size limited to 12 bytes (including the length field) due to
84  * NFSv2 protocol's limitation of 32 bytes for a filehandle.  For historical
85  * reasons, this same limit is being imposed by the Solaris NFSv3 implementation
86  * (although the NFSv3 protocol actually permits a maximum of 64 bytes).  It
87  * is not possible to expand beyond 12 bytes without abandoning support
88  * of NFSv2.
89  *
90  * For normal filesystems, we partition up the available space as follows:
91  *      2 bytes         fid length (required)
92  *      6 bytes         object number (48 bits)
93  *      4 bytes         generation number (32 bits)
94  *
95  * We reserve only 48 bits for the object number, as this is the limit
96  * currently defined and imposed by the DMU.
97  */
98 typedef struct zfid_short {
99         uint16_t        zf_len;
100         uint8_t         zf_object[6];           /* obj[i] = obj >> (8 * i) */
101         uint8_t         zf_gen[4];              /* gen[i] = gen >> (8 * i) */
102 } zfid_short_t;
103
104 /*
105  * Filesystems under .zfs/snapshot have a total file ID size of 22 bytes
106  * (including the length field).  This makes files under .zfs/snapshot
107  * accessible by NFSv3 and NFSv4, but not NFSv2.
108  *
109  * For files under .zfs/snapshot, we partition up the available space
110  * as follows:
111  *      2 bytes         fid length (required)
112  *      6 bytes         object number (48 bits)
113  *      4 bytes         generation number (32 bits)
114  *      6 bytes         objset id (48 bits)
115  *      4 bytes         currently just zero (32 bits)
116  *
117  * We reserve only 48 bits for the object number and objset id, as these are
118  * the limits currently defined and imposed by the DMU.
119  */
120 typedef struct zfid_long {
121         zfid_short_t    z_fid;
122         uint8_t         zf_setid[6];            /* obj[i] = obj >> (8 * i) */
123         uint8_t         zf_setgen[2];           /* gen[i] = gen >> (8 * i) */
124 } zfid_long_t;
125
126 #define SHORT_FID_LEN   (sizeof (zfid_short_t) - sizeof (uint16_t))
127 #define LONG_FID_LEN    (sizeof (zfid_long_t) - sizeof (uint16_t))
128
129 extern uint_t zfs_fsyncer_key;
130 extern int zfs_super_owner;
131
132 extern int zfs_suspend_fs(zfsvfs_t *zfsvfs, char *osname, int *mode);
133 extern int zfs_resume_fs(zfsvfs_t *zfsvfs, const char *osname, int mode);
134
135 #ifdef  __cplusplus
136 }
137 #endif
138
139 #endif  /* _SYS_FS_ZFS_VFSOPS_H */