zfs/sys/zfs_znode.h

	zfs_znode.h revision 3b2aab18808792cbd248a12f1edf139b89833c13
/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License (the "License").
 * You may not use this file except in compliance with the License.
 *
 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
 * or http://www.opensolaris.org/os/licensing.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
 * If applicable, add the following below this CDDL HEADER, with the
 * fields enclosed by brackets "[]" replaced with your own identifying
 * information: Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 */
/*
 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
 * Copyright (c) 2012 by Delphix. All rights reserved.
 */

#ifndef _SYS_FS_ZFS_ZNODE_H
#define _SYS_FS_ZFS_ZNODE_H

#ifdef _KERNEL
#include <sys/isa_defs.h>
#include <sys/types32.h>
#include <sys/attr.h>
#include <sys/list.h>
#include <sys/dmu.h>
#include <sys/sa.h>
#include <sys/zfs_vfsops.h>
#include <sys/rrwlock.h>
#include <sys/zfs_sa.h>
#include <sys/zfs_stat.h>
#endif
#include <sys/zfs_acl.h>
#include <sys/zil.h>

#ifdef  __cplusplus
extern "C" {
#endif

/*
 * Additional file level attributes, that are stored
 * in the upper half of zp_flags
 */
#define ZFS_READONLY        0x0000000100000000
#define ZFS_HIDDEN      0x0000000200000000
#define ZFS_SYSTEM      0x0000000400000000
#define ZFS_ARCHIVE     0x0000000800000000
#define ZFS_IMMUTABLE       0x0000001000000000
#define ZFS_NOUNLINK        0x0000002000000000
#define ZFS_APPENDONLY      0x0000004000000000
#define ZFS_NODUMP      0x0000008000000000
#define ZFS_OPAQUE      0x0000010000000000
#define ZFS_AV_QUARANTINED  0x0000020000000000
#define ZFS_AV_MODIFIED     0x0000040000000000
#define ZFS_REPARSE     0x0000080000000000
#define ZFS_OFFLINE     0x0000100000000000
#define ZFS_SPARSE      0x0000200000000000

#define ZFS_ATTR_SET(zp, attr, value, pflags, tx) \
{ \
    if (value) \
        pflags |= attr; \
    else \
        pflags &= ~attr; \
    VERIFY(0 == sa_update(zp->z_sa_hdl, SA_ZPL_FLAGS(zp->z_zfsvfs), \
        &pflags, sizeof (pflags), tx)); \
}

/*
 * Define special zfs pflags
 */
#define ZFS_XATTR       0x1     /* is an extended attribute */
#define ZFS_INHERIT_ACE     0x2     /* ace has inheritable ACEs */
#define ZFS_ACL_TRIVIAL     0x4     /* files ACL is trivial */
#define ZFS_ACL_OBJ_ACE     0x8     /* ACL has CMPLX Object ACE */
#define ZFS_ACL_PROTECTED   0x10        /* ACL protected */
#define ZFS_ACL_DEFAULTED   0x20        /* ACL should be defaulted */
#define ZFS_ACL_AUTO_INHERIT    0x40        /* ACL should be inherited */
#define ZFS_BONUS_SCANSTAMP 0x80        /* Scanstamp in bonus area */
#define ZFS_NO_EXECS_DENIED 0x100       /* exec was given to everyone */

#define SA_ZPL_ATIME(z)     z->z_attr_table[ZPL_ATIME]
#define SA_ZPL_MTIME(z)     z->z_attr_table[ZPL_MTIME]
#define SA_ZPL_CTIME(z)     z->z_attr_table[ZPL_CTIME]
#define SA_ZPL_CRTIME(z)    z->z_attr_table[ZPL_CRTIME]
#define SA_ZPL_GEN(z)       z->z_attr_table[ZPL_GEN]
#define SA_ZPL_DACL_ACES(z) z->z_attr_table[ZPL_DACL_ACES]
#define SA_ZPL_XATTR(z)     z->z_attr_table[ZPL_XATTR]
#define SA_ZPL_SYMLINK(z)   z->z_attr_table[ZPL_SYMLINK]
#define SA_ZPL_RDEV(z)      z->z_attr_table[ZPL_RDEV]
#define SA_ZPL_SCANSTAMP(z) z->z_attr_table[ZPL_SCANSTAMP]
#define SA_ZPL_UID(z)       z->z_attr_table[ZPL_UID]
#define SA_ZPL_GID(z)       z->z_attr_table[ZPL_GID]
#define SA_ZPL_PARENT(z)    z->z_attr_table[ZPL_PARENT]
#define SA_ZPL_LINKS(z)     z->z_attr_table[ZPL_LINKS]
#define SA_ZPL_MODE(z)      z->z_attr_table[ZPL_MODE]
#define SA_ZPL_DACL_COUNT(z)    z->z_attr_table[ZPL_DACL_COUNT]
#define SA_ZPL_FLAGS(z)     z->z_attr_table[ZPL_FLAGS]
#define SA_ZPL_SIZE(z)      z->z_attr_table[ZPL_SIZE]
#define SA_ZPL_ZNODE_ACL(z) z->z_attr_table[ZPL_ZNODE_ACL]
#define SA_ZPL_PAD(z)       z->z_attr_table[ZPL_PAD]

/*
 * Is ID ephemeral?
 */
#define IS_EPHEMERAL(x)     (x > MAXUID)

/*
 * Should we use FUIDs?
 */
#define USE_FUIDS(version, os)  (version >= ZPL_VERSION_FUID && \
    spa_version(dmu_objset_spa(os)) >= SPA_VERSION_FUID)
#define USE_SA(version, os) (version >= ZPL_VERSION_SA && \
    spa_version(dmu_objset_spa(os)) >= SPA_VERSION_SA)

#define MASTER_NODE_OBJ 1

/*
 * Special attributes for master node.
 * "userquota@" and "groupquota@" are also valid (from
 * zfs_userquota_prop_prefixes[]).
 */
#define ZFS_FSID        "FSID"
#define ZFS_UNLINKED_SET    "DELETE_QUEUE"
#define ZFS_ROOT_OBJ        "ROOT"
#define ZPL_VERSION_STR     "VERSION"
#define ZFS_FUID_TABLES     "FUID"
#define ZFS_SHARES_DIR      "SHARES"
#define ZFS_SA_ATTRS        "SA_ATTRS"

#define ZFS_MAX_BLOCKSIZE   (SPA_MAXBLOCKSIZE)

/* Path component length */
/*
 * The generic fs code uses MAXNAMELEN to represent
 * what the largest component length is.  Unfortunately,
 * this length includes the terminating NULL.  ZFS needs
 * to tell the users via pathconf() and statvfs() what the
 * true maximum length of a component is, excluding the NULL.
 */
#define ZFS_MAXNAMELEN  (MAXNAMELEN - 1)

/*
 * Convert mode bits (zp_mode) to BSD-style DT_* values for storing in
 * the directory entries.
 */
#define IFTODT(mode) (((mode) & S_IFMT) >> 12)

/*
 * The directory entry has the type (currently unused on Solaris) in the
 * top 4 bits, and the object number in the low 48 bits.  The "middle"
 * 12 bits are unused.
 */
#define ZFS_DIRENT_TYPE(de) BF64_GET(de, 60, 4)
#define ZFS_DIRENT_OBJ(de) BF64_GET(de, 0, 48)

/*
 * Directory entry locks control access to directory entries.
 * They are used to protect creates, deletes, and renames.
 * Each directory znode has a mutex and a list of locked names.
 */
#ifdef _KERNEL
typedef struct zfs_dirlock {
    char        *dl_name;   /* directory entry being locked */
    uint32_t    dl_sharecnt;    /* 0 if exclusive, > 0 if shared */
    uint8_t     dl_namelock;    /* 1 if z_name_lock is NOT held */
    uint16_t    dl_namesize;    /* set if dl_name was allocated */
    kcondvar_t  dl_cv;      /* wait for entry to be unlocked */
    struct znode    *dl_dzp;    /* directory znode */
    struct zfs_dirlock *dl_next;    /* next in z_dirlocks list */
} zfs_dirlock_t;

typedef struct znode {
    struct zfsvfs   *z_zfsvfs;
    vnode_t     *z_vnode;
    uint64_t    z_id;       /* object ID for this znode */
    kmutex_t    z_lock;     /* znode modification lock */
    krwlock_t   z_parent_lock;  /* parent lock for directories */
    krwlock_t   z_name_lock;    /* "master" lock for dirent locks */
    zfs_dirlock_t   *z_dirlocks;    /* directory entry lock list */
    kmutex_t    z_range_lock;   /* protects changes to z_range_avl */
    avl_tree_t  z_range_avl;    /* avl tree of file range locks */
    uint8_t     z_unlinked; /* file has been unlinked */
    uint8_t     z_atime_dirty;  /* atime needs to be synced */
    uint8_t     z_zn_prefetch;  /* Prefetch znodes? */
    uint8_t     z_moved;    /* Has this znode been moved? */
    uint_t      z_blksz;    /* block size in bytes */
    uint_t      z_seq;      /* modification sequence number */
    uint64_t    z_mapcnt;   /* number of pages mapped to file */
    uint64_t    z_gen;      /* generation (cached) */
    uint64_t    z_size;     /* file size (cached) */
    uint64_t    z_atime[2]; /* atime (cached) */
    uint64_t    z_links;    /* file links (cached) */
    uint64_t    z_pflags;   /* pflags (cached) */
    uint64_t    z_uid;      /* uid fuid (cached) */
    uint64_t    z_gid;      /* gid fuid (cached) */
    mode_t      z_mode;     /* mode (cached) */
    uint32_t    z_sync_cnt; /* synchronous open count */
    kmutex_t    z_acl_lock; /* acl data lock */
    zfs_acl_t   *z_acl_cached;  /* cached acl */
    list_node_t z_link_node;    /* all znodes in fs link */
    sa_handle_t *z_sa_hdl;  /* handle to sa data */
    boolean_t   z_is_sa;    /* are we native sa? */
} znode_t;


/*
 * Range locking rules
 * --------------------
 * 1. When truncating a file (zfs_create, zfs_setattr, zfs_space) the whole
 *    file range needs to be locked as RL_WRITER. Only then can the pages be
 *    freed etc and zp_size reset. zp_size must be set within range lock.
 * 2. For writes and punching holes (zfs_write & zfs_space) just the range
 *    being written or freed needs to be locked as RL_WRITER.
 *    Multiple writes at the end of the file must coordinate zp_size updates
 *    to ensure data isn't lost. A compare and swap loop is currently used
 *    to ensure the file size is at least the offset last written.
 * 3. For reads (zfs_read, zfs_get_data & zfs_putapage) just the range being
 *    read needs to be locked as RL_READER. A check against zp_size can then
 *    be made for reading beyond end of file.
 */

/*
 * Convert between znode pointers and vnode pointers
 */
#define ZTOV(ZP)    ((ZP)->z_vnode)
#define VTOZ(VP)    ((znode_t *)(VP)->v_data)

/*
 * ZFS_ENTER() is called on entry to each ZFS vnode and vfs operation.
 * ZFS_EXIT() must be called before exitting the vop.
 * ZFS_VERIFY_ZP() verifies the znode is valid.
 */
#define ZFS_ENTER(zfsvfs) \
    { \
        rrw_enter_read(&(zfsvfs)->z_teardown_lock, FTAG); \
        if ((zfsvfs)->z_unmounted) { \
            ZFS_EXIT(zfsvfs); \
            return (EIO); \
        } \
    }

#define ZFS_EXIT(zfsvfs) rrw_exit(&(zfsvfs)->z_teardown_lock, FTAG)

#define ZFS_VERIFY_ZP(zp) \
    if ((zp)->z_sa_hdl == NULL) { \
        ZFS_EXIT((zp)->z_zfsvfs); \
        return (EIO); \
    } \

/*
 * Macros for dealing with dmu_buf_hold
 */
#define ZFS_OBJ_HASH(obj_num)   ((obj_num) & (ZFS_OBJ_MTX_SZ - 1))
#define ZFS_OBJ_MUTEX(zfsvfs, obj_num)  \
    (&(zfsvfs)->z_hold_mtx[ZFS_OBJ_HASH(obj_num)])
#define ZFS_OBJ_HOLD_ENTER(zfsvfs, obj_num) \
    mutex_enter(ZFS_OBJ_MUTEX((zfsvfs), (obj_num)))
#define ZFS_OBJ_HOLD_TRYENTER(zfsvfs, obj_num) \
    mutex_tryenter(ZFS_OBJ_MUTEX((zfsvfs), (obj_num)))
#define ZFS_OBJ_HOLD_EXIT(zfsvfs, obj_num) \
    mutex_exit(ZFS_OBJ_MUTEX((zfsvfs), (obj_num)))

/*
 * Macros to encode/decode ZFS stored time values from/to struct timespec
 */
#define ZFS_TIME_ENCODE(tp, stmp)       \
{                       \
    (stmp)[0] = (uint64_t)(tp)->tv_sec; \
    (stmp)[1] = (uint64_t)(tp)->tv_nsec;    \
}

#define ZFS_TIME_DECODE(tp, stmp)       \
{                       \
    (tp)->tv_sec = (time_t)(stmp)[0];       \
    (tp)->tv_nsec = (long)(stmp)[1];        \
}

/*
 * Timestamp defines
 */
#define ACCESSED        (AT_ATIME)
#define STATE_CHANGED       (AT_CTIME)
#define CONTENT_MODIFIED    (AT_MTIME | AT_CTIME)

#define ZFS_ACCESSTIME_STAMP(zfsvfs, zp) \
    if ((zfsvfs)->z_atime && !((zfsvfs)->z_vfs->vfs_flag & VFS_RDONLY)) \
        zfs_tstamp_update_setup(zp, ACCESSED, NULL, NULL, B_FALSE);

extern int  zfs_init_fs(zfsvfs_t *, znode_t **);
extern void zfs_set_dataprop(objset_t *);
extern void zfs_create_fs(objset_t *os, cred_t *cr, nvlist_t *,
    dmu_tx_t *tx);
extern void zfs_tstamp_update_setup(znode_t *, uint_t, uint64_t [2],
    uint64_t [2], boolean_t);
extern void zfs_grow_blocksize(znode_t *, uint64_t, dmu_tx_t *);
extern int  zfs_freesp(znode_t *, uint64_t, uint64_t, int, boolean_t);
extern void zfs_znode_init(void);
extern void zfs_znode_fini(void);
extern int  zfs_zget(zfsvfs_t *, uint64_t, znode_t **);
extern int  zfs_rezget(znode_t *);
extern void zfs_zinactive(znode_t *);
extern void zfs_znode_delete(znode_t *, dmu_tx_t *);
extern void zfs_znode_free(znode_t *);
extern void zfs_remove_op_tables();
extern int  zfs_create_op_tables();
extern int  zfs_sync(vfs_t *vfsp, short flag, cred_t *cr);
extern dev_t    zfs_cmpldev(uint64_t);
extern int  zfs_get_zplprop(objset_t *os, zfs_prop_t prop, uint64_t *value);
extern int  zfs_get_stats(objset_t *os, nvlist_t *nv);
extern void zfs_znode_dmu_fini(znode_t *);

extern void zfs_log_create(zilog_t *zilog, dmu_tx_t *tx, uint64_t txtype,
    znode_t *dzp, znode_t *zp, char *name, vsecattr_t *, zfs_fuid_info_t *,
    vattr_t *vap);
extern int zfs_log_create_txtype(zil_create_t, vsecattr_t *vsecp,
    vattr_t *vap);
extern void zfs_log_remove(zilog_t *zilog, dmu_tx_t *tx, uint64_t txtype,
    znode_t *dzp, char *name, uint64_t foid);
#define ZFS_NO_OBJECT   0   /* no object id */
extern void zfs_log_link(zilog_t *zilog, dmu_tx_t *tx, uint64_t txtype,
    znode_t *dzp, znode_t *zp, char *name);
extern void zfs_log_symlink(zilog_t *zilog, dmu_tx_t *tx, uint64_t txtype,
    znode_t *dzp, znode_t *zp, char *name, char *link);
extern void zfs_log_rename(zilog_t *zilog, dmu_tx_t *tx, uint64_t txtype,
    znode_t *sdzp, char *sname, znode_t *tdzp, char *dname, znode_t *szp);
extern void zfs_log_write(zilog_t *zilog, dmu_tx_t *tx, int txtype,
    znode_t *zp, offset_t off, ssize_t len, int ioflag);
extern void zfs_log_truncate(zilog_t *zilog, dmu_tx_t *tx, int txtype,
    znode_t *zp, uint64_t off, uint64_t len);
extern void zfs_log_setattr(zilog_t *zilog, dmu_tx_t *tx, int txtype,
    znode_t *zp, vattr_t *vap, uint_t mask_applied, zfs_fuid_info_t *fuidp);
extern void zfs_log_acl(zilog_t *zilog, dmu_tx_t *tx, znode_t *zp,
    vsecattr_t *vsecp, zfs_fuid_info_t *fuidp);
extern void zfs_xvattr_set(znode_t *zp, xvattr_t *xvap, dmu_tx_t *tx);
extern void zfs_upgrade(zfsvfs_t *zfsvfs, dmu_tx_t *tx);
extern int zfs_create_share_dir(zfsvfs_t *zfsvfs, dmu_tx_t *tx);

extern caddr_t zfs_map_page(page_t *, enum seg_rw);
extern void zfs_unmap_page(page_t *, caddr_t);

extern zil_get_data_t zfs_get_data;
extern zil_replay_func_t *zfs_replay_vector[TX_MAX_TYPE];
extern int zfsfstype;

#endif /* _KERNEL */

extern int zfs_obj_to_path(objset_t *osp, uint64_t obj, char *buf, int len);

#ifdef  __cplusplus
}
#endif

#endif  /* _SYS_FS_ZFS_ZNODE_H */