[mirror_zfs.git] / include / sys / zfs_sa.h

/*
 * 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 2010 Sun Microsystems, Inc.  All rights reserved.
 * Use is subject to license terms.
 */

#ifndef	_SYS_ZFS_SA_H
#define	_SYS_ZFS_SA_H

#ifdef _KERNEL
#include <sys/types32.h>
#include <sys/list.h>
#include <sys/dmu.h>
#include <sys/zfs_acl.h>
#include <sys/zfs_znode.h>
#include <sys/sa.h>
#include <sys/zil.h>


#endif

#ifdef	__cplusplus
extern "C" {
#endif

/*
 * This is the list of known attributes
 * to the ZPL.  The values of the actual
 * attributes are not defined by the order
 * the enums.  It is controlled by the attribute
 * registration mechanism.  Two different file system
 * could have different numeric values for the same
 * attributes.  this list is only used for dereferencing
 * into the table that will hold the actual numeric value.
 */
typedef enum zpl_attr {
	ZPL_ATIME,
	ZPL_MTIME,
	ZPL_CTIME,
	ZPL_CRTIME,
	ZPL_GEN,
	ZPL_MODE,
	ZPL_SIZE,
	ZPL_PARENT,
	ZPL_LINKS,
	ZPL_XATTR,
	ZPL_RDEV,
	ZPL_FLAGS,
	ZPL_UID,
	ZPL_GID,
	ZPL_PAD,
	ZPL_ZNODE_ACL,
	ZPL_DACL_COUNT,
	ZPL_SYMLINK,
	ZPL_SCANSTAMP,
	ZPL_DACL_ACES,
	ZPL_DXATTR,
	ZPL_PROJID,
	ZPL_END
} zpl_attr_t;

#define	ZFS_OLD_ZNODE_PHYS_SIZE	0x108
#define	ZFS_SA_BASE_ATTR_SIZE	(ZFS_OLD_ZNODE_PHYS_SIZE - \
    sizeof (zfs_acl_phys_t))

#define	SA_MODE_OFFSET		0
#define	SA_SIZE_OFFSET		8
#define	SA_GEN_OFFSET		16
#define	SA_UID_OFFSET		24
#define	SA_GID_OFFSET		32
#define	SA_PARENT_OFFSET	40
#define	SA_FLAGS_OFFSET		48
#define	SA_PROJID_OFFSET	128

extern const sa_attr_reg_t zfs_attr_table[ZPL_END + 1];

/*
 * This is a deprecated data structure that only exists for
 * dealing with file systems create prior to ZPL version 5.
 */
typedef struct znode_phys {
	uint64_t zp_atime[2];		/*  0 - last file access time */
	uint64_t zp_mtime[2];		/* 16 - last file modification time */
	uint64_t zp_ctime[2];		/* 32 - last file change time */
	uint64_t zp_crtime[2];		/* 48 - creation time */
	uint64_t zp_gen;		/* 64 - generation (txg of creation) */
	uint64_t zp_mode;		/* 72 - file mode bits */
	uint64_t zp_size;		/* 80 - size of file */
	uint64_t zp_parent;		/* 88 - directory parent (`..') */
	uint64_t zp_links;		/* 96 - number of links to file */
	uint64_t zp_xattr;		/* 104 - DMU object for xattrs */
	uint64_t zp_rdev;		/* 112 - dev_t for VBLK & VCHR files */
	uint64_t zp_flags;		/* 120 - persistent flags */
	uint64_t zp_uid;		/* 128 - file owner */
	uint64_t zp_gid;		/* 136 - owning group */
	uint64_t zp_zap;		/* 144 - extra attributes */
	uint64_t zp_pad[3];		/* 152 - future */
	zfs_acl_phys_t zp_acl;		/* 176 - 263 ACL */
	/*
	 * Data may pad out any remaining bytes in the znode buffer, eg:
	 *
	 * |<---------------------- dnode_phys (512) ------------------------>|
	 * |<-- dnode (192) --->|<----------- "bonus" buffer (320) ---------->|
	 *			|<---- znode (264) ---->|<---- data (56) ---->|
	 *
	 * At present, we use this space for the following:
	 *  - symbolic links
	 *  - 32-byte anti-virus scanstamp (regular files only)
	 */
} znode_phys_t;

#ifdef _KERNEL

#define	DXATTR_MAX_ENTRY_SIZE	(32768)
#define	DXATTR_MAX_SA_SIZE	(SPA_OLD_MAXBLOCKSIZE >> 1)

int zfs_sa_readlink(struct znode *, zfs_uio_t *);
void zfs_sa_symlink(struct znode *, char *link, int len, dmu_tx_t *);
void zfs_sa_get_scanstamp(struct znode *, xvattr_t *);
void zfs_sa_set_scanstamp(struct znode *, xvattr_t *, dmu_tx_t *);
int zfs_sa_get_xattr(struct znode *);
int zfs_sa_set_xattr(struct znode *);
void zfs_sa_upgrade(struct sa_handle  *, dmu_tx_t *);
void zfs_sa_upgrade_txholds(dmu_tx_t *, struct znode *);
void zfs_sa_init(void);
void zfs_sa_fini(void);
#endif

#ifdef	__cplusplus
}
#endif

#endif	/* _SYS_ZFS_SA_H */
Commit	Line	Data
428870ff BB	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 2010 Sun Microsystems, Inc. All rights reserved.
	23	* Use is subject to license terms.
	24	*/
	25
	26	#ifndef _SYS_ZFS_SA_H
	27	#define _SYS_ZFS_SA_H
	28
	29	#ifdef _KERNEL
	30	#include <sys/types32.h>
	31	#include <sys/list.h>
	32	#include <sys/dmu.h>
	33	#include <sys/zfs_acl.h>
	34	#include <sys/zfs_znode.h>
	35	#include <sys/sa.h>
	36	#include <sys/zil.h>
	37
	38
	39	#endif
	40
	41	#ifdef __cplusplus
	42	extern "C" {
	43	#endif
	44
	45	/*
	46	* This is the list of known attributes
	47	* to the ZPL. The values of the actual
	48	* attributes are not defined by the order
	49	* the enums. It is controlled by the attribute
	50	* registration mechanism. Two different file system
	51	* could have different numeric values for the same
	52	* attributes. this list is only used for dereferencing
	53	* into the table that will hold the actual numeric value.
	54	*/
	55	typedef enum zpl_attr {
	56	ZPL_ATIME,
	57	ZPL_MTIME,
	58	ZPL_CTIME,
	59	ZPL_CRTIME,
	60	ZPL_GEN,
	61	ZPL_MODE,
	62	ZPL_SIZE,
	63	ZPL_PARENT,
	64	ZPL_LINKS,
65	ZPL_XATTR,
66	ZPL_RDEV,
67	ZPL_FLAGS,
68	ZPL_UID,
69	ZPL_GID,
70	ZPL_PAD,
71	ZPL_ZNODE_ACL,
72	ZPL_DACL_COUNT,
73	ZPL_SYMLINK,
74	ZPL_SCANSTAMP,
75	ZPL_DACL_ACES,
82a37189	76	ZPL_DXATTR,
9c5167d1	77	ZPL_PROJID,
428870ff BB	78	ZPL_END
	79	} zpl_attr_t;
	80
	81	#define ZFS_OLD_ZNODE_PHYS_SIZE 0x108
	82	#define ZFS_SA_BASE_ATTR_SIZE (ZFS_OLD_ZNODE_PHYS_SIZE - \
	83	sizeof (zfs_acl_phys_t))
	84
	85	#define SA_MODE_OFFSET 0
	86	#define SA_SIZE_OFFSET 8
	87	#define SA_GEN_OFFSET 16
	88	#define SA_UID_OFFSET 24
	89	#define SA_GID_OFFSET 32
	90	#define SA_PARENT_OFFSET 40
9c5167d1 NF	91	#define SA_FLAGS_OFFSET 48
9c5167d1 NF	92	#define SA_PROJID_OFFSET 128
428870ff	93
18168da7	94	extern const sa_attr_reg_t zfs_attr_table[ZPL_END + 1];
428870ff BB	95
	96	/*
	97	* This is a deprecated data structure that only exists for
	98	* dealing with file systems create prior to ZPL version 5.
	99	*/
	100	typedef struct znode_phys {
	101	uint64_t zp_atime[2]; /* 0 - last file access time */
	102	uint64_t zp_mtime[2]; /* 16 - last file modification time */
	103	uint64_t zp_ctime[2]; /* 32 - last file change time */
	104	uint64_t zp_crtime[2]; /* 48 - creation time */
	105	uint64_t zp_gen; /* 64 - generation (txg of creation) */
	106	uint64_t zp_mode; /* 72 - file mode bits */
	107	uint64_t zp_size; /* 80 - size of file */
	108	uint64_t zp_parent; /* 88 - directory parent (`..') */
	109	uint64_t zp_links; /* 96 - number of links to file */
	110	uint64_t zp_xattr; /* 104 - DMU object for xattrs */
	111	uint64_t zp_rdev; /* 112 - dev_t for VBLK & VCHR files */
	112	uint64_t zp_flags; /* 120 - persistent flags */
	113	uint64_t zp_uid; /* 128 - file owner */
	114	uint64_t zp_gid; /* 136 - owning group */
	115	uint64_t zp_zap; /* 144 - extra attributes */
	116	uint64_t zp_pad[3]; /* 152 - future */
	117	zfs_acl_phys_t zp_acl; /* 176 - 263 ACL */
	118	/*
	119	* Data may pad out any remaining bytes in the znode buffer, eg:
	120	*
	121	* \|<---------------------- dnode_phys (512) ------------------------>\|
	122	* \|<-- dnode (192) --->\|<----------- "bonus" buffer (320) ---------->\|
	123	* \|<---- znode (264) ---->\|<---- data (56) ---->\|
	124	*
	125	* At present, we use this space for the following:
	126	* - symbolic links
	127	* - 32-byte anti-virus scanstamp (regular files only)
	128	*/
	129	} znode_phys_t;
	130
	131	#ifdef _KERNEL
82a37189	132
d1d7e268	133	#define DXATTR_MAX_ENTRY_SIZE (32768)
f1512ee6	134	#define DXATTR_MAX_SA_SIZE (SPA_OLD_MAXBLOCKSIZE >> 1)
82a37189	135
d0cd9a5c	136	int zfs_sa_readlink(struct znode , zfs_uio_t );
428870ff	137	void zfs_sa_symlink(struct znode , char link, int len, dmu_tx_t *);
428870ff BB	138	void zfs_sa_get_scanstamp(struct znode , xvattr_t );
428870ff BB	139	void zfs_sa_set_scanstamp(struct znode , xvattr_t , dmu_tx_t *);
82a37189 BB	140	int zfs_sa_get_xattr(struct znode *);
82a37189 BB	141	int zfs_sa_set_xattr(struct znode *);
e45aa452	142	void zfs_sa_upgrade(struct sa_handle , dmu_tx_t );
428870ff	143	void zfs_sa_upgrade_txholds(dmu_tx_t , struct znode );
82a37189 BB	144	void zfs_sa_init(void);
82a37189 BB	145	void zfs_sa_fini(void);
428870ff BB	146	#endif
	147
	148	#ifdef __cplusplus
	149	}
	150	#endif
	151
	152	#endif /* _SYS_ZFS_SA_H */