include/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 (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
  23  */
  24
  25 #ifndef _SYS_FS_ZFS_VFSOPS_H
  26 #define _SYS_FS_ZFS_VFSOPS_H
  27
  28 #include <sys/isa_defs.h>
  29 #include <sys/types32.h>
  30 #include <sys/list.h>
  31 #include <sys/vfs.h>
  32 #include <sys/zil.h>
  33 #include <sys/sa.h>
  34 #include <sys/rrwlock.h>
  35 #include <sys/zfs_ioctl.h>
  36
  37 #ifdef  __cplusplus
  38 extern "C" {
  39 #endif
  40
  41 struct zfs_sb;
  42 struct znode;
  43
  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         uint_t          z_acl_type;     /* type of ACL usable on this FS */
  64         zfs_case_t      z_case;         /* case-sense */
  65         boolean_t       z_utf8;         /* utf8-only */
  66         int             z_norm;         /* normalization flags */
  67         boolean_t       z_atime;        /* enable atimes mount option */
  68         boolean_t       z_relatime;     /* enable relatime mount option */
  69         boolean_t       z_unmounted;    /* unmounted */
  70         rrwlock_t       z_teardown_lock;
  71         krwlock_t       z_teardown_inactive_lock;
  72         list_t          z_all_znodes;   /* all znodes in the fs */
  73         uint64_t        z_nr_znodes;    /* number of znodes in the fs */
  74         unsigned long   z_rollback_time; /* last online rollback time */
  75         kmutex_t        z_znodes_lock;  /* lock for z_all_znodes */
  76         struct inode    *z_ctldir;      /* .zfs directory inode */
  77         avl_tree_t      z_ctldir_snaps; /* .zfs/snapshot entries */
  78         kmutex_t        z_ctldir_lock;  /* .zfs ctldir lock */
  79         boolean_t       z_show_ctldir;  /* expose .zfs in the root dir */
  80         boolean_t       z_issnap;       /* true if this is a snapshot */
  81         boolean_t       z_vscan;        /* virus scan on/off */
  82         boolean_t       z_use_fuids;    /* version allows fuids */
  83         boolean_t       z_replay;       /* set during ZIL replay */
  84         boolean_t       z_use_sa;       /* version allow system attributes */
  85         boolean_t       z_xattr_sa;     /* allow xattrs to be stores as SA */
  86         uint64_t        z_version;      /* ZPL version */
  87         uint64_t        z_shares_dir;   /* hidden shares dir */
  88         kmutex_t        z_lock;
  89         uint64_t        z_userquota_obj;
  90         uint64_t        z_groupquota_obj;
  91         uint64_t        z_replay_eof;   /* New end of file - replay only */
  92         sa_attr_type_t  *z_attr_table;  /* SA attr mapping->id */
  93 #define ZFS_OBJ_MTX_SZ  256
  94         kmutex_t        z_hold_mtx[ZFS_OBJ_MTX_SZ];     /* znode hold locks */
  95 } zfs_sb_t;
  96
  97 #define ZFS_SUPER_MAGIC 0x2fc12fc1
  98
  99 #define ZSB_XATTR       0x0001          /* Enable user xattrs */
 100
 101 /*
 102  * Allow a maximum number of links.  While ZFS does not internally limit
 103  * this the inode->i_nlink member is defined as an unsigned int.  To be
 104  * safe we use 2^31-1 as the limit.
 105  */
 106 #define ZFS_LINK_MAX            ((1U << 31) - 1U)
 107
 108 /*
 109  * Normal filesystems (those not under .zfs/snapshot) have a total
 110  * file ID size limited to 12 bytes (including the length field) due to
 111  * NFSv2 protocol's limitation of 32 bytes for a filehandle.  For historical
 112  * reasons, this same limit is being imposed by the Solaris NFSv3 implementation
 113  * (although the NFSv3 protocol actually permits a maximum of 64 bytes).  It
 114  * is not possible to expand beyond 12 bytes without abandoning support
 115  * of NFSv2.
 116  *
 117  * For normal filesystems, we partition up the available space as follows:
 118  *      2 bytes         fid length (required)
 119  *      6 bytes         object number (48 bits)
 120  *      4 bytes         generation number (32 bits)
 121  *
 122  * We reserve only 48 bits for the object number, as this is the limit
 123  * currently defined and imposed by the DMU.
 124  */
 125 typedef struct zfid_short {
 126         uint16_t        zf_len;
 127         uint8_t         zf_object[6];           /* obj[i] = obj >> (8 * i) */
 128         uint8_t         zf_gen[4];              /* gen[i] = gen >> (8 * i) */
 129 } zfid_short_t;
 130
 131 /*
 132  * Filesystems under .zfs/snapshot have a total file ID size of 22 bytes
 133  * (including the length field).  This makes files under .zfs/snapshot
 134  * accessible by NFSv3 and NFSv4, but not NFSv2.
 135  *
 136  * For files under .zfs/snapshot, we partition up the available space
 137  * as follows:
 138  *      2 bytes         fid length (required)
 139  *      6 bytes         object number (48 bits)
 140  *      4 bytes         generation number (32 bits)
 141  *      6 bytes         objset id (48 bits)
 142  *      4 bytes         currently just zero (32 bits)
 143  *
 144  * We reserve only 48 bits for the object number and objset id, as these are
 145  * the limits currently defined and imposed by the DMU.
 146  */
 147 typedef struct zfid_long {
 148         zfid_short_t    z_fid;
 149         uint8_t         zf_setid[6];            /* obj[i] = obj >> (8 * i) */
 150         uint8_t         zf_setgen[4];           /* gen[i] = gen >> (8 * i) */
 151 } zfid_long_t;
 152
 153 #define SHORT_FID_LEN   (sizeof (zfid_short_t) - sizeof (uint16_t))
 154 #define LONG_FID_LEN    (sizeof (zfid_long_t) - sizeof (uint16_t))
 155
 156 extern uint_t zfs_fsyncer_key;
 157
 158 extern int zfs_suspend_fs(zfs_sb_t *zsb);
 159 extern int zfs_resume_fs(zfs_sb_t *zsb, const char *osname);
 160 extern int zfs_userspace_one(zfs_sb_t *zsb, zfs_userquota_prop_t type,
 161     const char *domain, uint64_t rid, uint64_t *valuep);
 162 extern int zfs_userspace_many(zfs_sb_t *zsb, zfs_userquota_prop_t type,
 163     uint64_t *cookiep, void *vbuf, uint64_t *bufsizep);
 164 extern int zfs_set_userquota(zfs_sb_t *zsb, zfs_userquota_prop_t type,
 165     const char *domain, uint64_t rid, uint64_t quota);
 166 extern boolean_t zfs_owner_overquota(zfs_sb_t *zsb, struct znode *,
 167     boolean_t isgroup);
 168 extern boolean_t zfs_fuid_overquota(zfs_sb_t *zsb, boolean_t isgroup,
 169     uint64_t fuid);
 170 extern int zfs_set_version(zfs_sb_t *zsb, uint64_t newvers);
 171 extern int zfs_get_zplprop(objset_t *os, zfs_prop_t prop,
 172     uint64_t *value);
 173 extern int zfs_sb_create(const char *name, zfs_sb_t **zsbp);
 174 extern int zfs_sb_setup(zfs_sb_t *zsb, boolean_t mounting);
 175 extern void zfs_sb_free(zfs_sb_t *zsb);
 176 extern int zfs_sb_prune(struct super_block *sb, unsigned long nr_to_scan,
 177     int *objects);
 178 extern int zfs_sb_teardown(zfs_sb_t *zsb, boolean_t unmounting);
 179 extern int zfs_check_global_label(const char *dsname, const char *hexsl);
 180 extern boolean_t zfs_is_readonly(zfs_sb_t *zsb);
 181
 182 extern int zfs_register_callbacks(zfs_sb_t *zsb);
 183 extern void zfs_unregister_callbacks(zfs_sb_t *zsb);
 184 extern int zfs_domount(struct super_block *sb, void *data, int silent);
 185 extern void zfs_preumount(struct super_block *sb);
 186 extern int zfs_umount(struct super_block *sb);
 187 extern int zfs_remount(struct super_block *sb, int *flags, char *data);
 188 extern int zfs_root(zfs_sb_t *zsb, struct inode **ipp);
 189 extern int zfs_statvfs(struct dentry *dentry, struct kstatfs *statp);
 190 extern int zfs_vget(struct super_block *sb, struct inode **ipp, fid_t *fidp);
 191
 192 #ifdef  __cplusplus
 193 }
 194 #endif
 195
 196 #endif  /* _SYS_FS_ZFS_VFSOPS_H */