[linux-2.6-block.git] / fs / xfs / xfs_attr_sf.h

/*
 * Copyright (c) 2000,2002,2005 Silicon Graphics, Inc.
 * All Rights Reserved.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it would be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write the Free Software Foundation,
 * Inc.,  51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */
#ifndef __XFS_ATTR_SF_H__
#define	__XFS_ATTR_SF_H__

/*
 * Attribute storage when stored inside the inode.
 *
 * Small attribute lists are packed as tightly as possible so as
 * to fit into the literal area of the inode.
 */

struct xfs_inode;

/*
 * Entries are packed toward the top as tight as possible.
 */
typedef struct xfs_attr_shortform {
	struct xfs_attr_sf_hdr {	/* constant-structure header block */
		__be16	totsize;	/* total bytes in shortform list */
		__u8	count;	/* count of active entries */
	} hdr;
	struct xfs_attr_sf_entry {
		__uint8_t namelen;	/* actual length of name (no NULL) */
		__uint8_t valuelen;	/* actual length of value (no NULL) */
		__uint8_t flags;	/* flags bits (see xfs_attr_leaf.h) */
		__uint8_t nameval[1];	/* name & value bytes concatenated */
	} list[1];			/* variable sized array */
} xfs_attr_shortform_t;
typedef struct xfs_attr_sf_hdr xfs_attr_sf_hdr_t;
typedef struct xfs_attr_sf_entry xfs_attr_sf_entry_t;

/*
 * We generate this then sort it, attr_list() must return things in hash-order.
 */
typedef struct xfs_attr_sf_sort {
	__uint8_t	entno;		/* entry number in original list */
	__uint8_t	namelen;	/* length of name value (no null) */
	__uint8_t	valuelen;	/* length of value */
	__uint8_t	flags;		/* flags bits (see xfs_attr_leaf.h) */
	xfs_dahash_t	hash;		/* this entry's hash value */
	char		*name;		/* name value, pointer into buffer */
} xfs_attr_sf_sort_t;

#define XFS_ATTR_SF_ENTSIZE_BYNAME(nlen,vlen)	/* space name/value uses */ \
	(((int)sizeof(xfs_attr_sf_entry_t)-1 + (nlen)+(vlen)))
#define XFS_ATTR_SF_ENTSIZE_MAX			/* max space for name&value */ \
	((1 << (NBBY*(int)sizeof(__uint8_t))) - 1)
#define XFS_ATTR_SF_ENTSIZE(sfep)		/* space an entry uses */ \
	((int)sizeof(xfs_attr_sf_entry_t)-1 + (sfep)->namelen+(sfep)->valuelen)
#define XFS_ATTR_SF_NEXTENTRY(sfep)		/* next entry in struct */ \
	((xfs_attr_sf_entry_t *)((char *)(sfep) + XFS_ATTR_SF_ENTSIZE(sfep)))
#define XFS_ATTR_SF_TOTSIZE(dp)			/* total space in use */ \
	(be16_to_cpu(((xfs_attr_shortform_t *)	\
		((dp)->i_afp->if_u1.if_data))->hdr.totsize))

#if defined(XFS_ATTR_TRACE)
/*
 * Kernel tracing support for attribute lists
 */
struct xfs_attr_list_context;
struct xfs_da_intnode;
struct xfs_da_node_entry;
struct xfs_attr_leafblock;

#define	XFS_ATTR_TRACE_SIZE	4096	/* size of global trace buffer */
extern ktrace_t	*xfs_attr_trace_buf;

/*
 * Trace record types.
 */
#define	XFS_ATTR_KTRACE_L_C	1	/* context */
#define	XFS_ATTR_KTRACE_L_CN	2	/* context, node */
#define	XFS_ATTR_KTRACE_L_CB	3	/* context, btree */
#define	XFS_ATTR_KTRACE_L_CL	4	/* context, leaf */

void xfs_attr_trace_l_c(char *where, struct xfs_attr_list_context *context);
void xfs_attr_trace_l_cn(char *where, struct xfs_attr_list_context *context,
			      struct xfs_da_intnode *node);
void xfs_attr_trace_l_cb(char *where, struct xfs_attr_list_context *context,
			      struct xfs_da_node_entry *btree);
void xfs_attr_trace_l_cl(char *where, struct xfs_attr_list_context *context,
			      struct xfs_attr_leafblock *leaf);
void xfs_attr_trace_enter(int type, char *where,
			     struct xfs_attr_list_context *context,
			     __psunsigned_t a13, __psunsigned_t a14,
			     __psunsigned_t a15);
#else
#define	xfs_attr_trace_l_c(w,c)
#define	xfs_attr_trace_l_cn(w,c,n)
#define	xfs_attr_trace_l_cb(w,c,b)
#define	xfs_attr_trace_l_cl(w,c,l)
#endif /* XFS_ATTR_TRACE */

#endif	/* __XFS_ATTR_SF_H__ */
Commit	Line	Data
1da177e4	1	/*
7b718769 NS	2	* Copyright (c) 2000,2002,2005 Silicon Graphics, Inc.
7b718769 NS	3	* All Rights Reserved.
1da177e4	4	*
7b718769 NS	5	* This program is free software; you can redistribute it and/or
7b718769 NS	6	* modify it under the terms of the GNU General Public License as
1da177e4 LT	7	* published by the Free Software Foundation.
1da177e4 LT	8	*
7b718769 NS	9	* This program is distributed in the hope that it would be useful,
	10	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	11	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	12	* GNU General Public License for more details.
1da177e4	13	*
7b718769 NS	14	* You should have received a copy of the GNU General Public License
	15	* along with this program; if not, write the Free Software Foundation,
	16	* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
1da177e4 LT	17	*/
	18	#ifndef __XFS_ATTR_SF_H__
	19	#define __XFS_ATTR_SF_H__
	20
	21	/*
	22	* Attribute storage when stored inside the inode.
	23	*
	24	* Small attribute lists are packed as tightly as possible so as
	25	* to fit into the literal area of the inode.
	26	*/
	27
	28	struct xfs_inode;
	29
	30	/*
	31	* Entries are packed toward the top as tight as possible.
	32	*/
	33	typedef struct xfs_attr_shortform {
	34	struct xfs_attr_sf_hdr { /* constant-structure header block */
3b244aa8 NS	35	__be16 totsize; /* total bytes in shortform list */
3b244aa8 NS	36	__u8 count; /* count of active entries */
1da177e4 LT	37	} hdr;
	38	struct xfs_attr_sf_entry {
	39	__uint8_t namelen; /* actual length of name (no NULL) */
	40	__uint8_t valuelen; /* actual length of value (no NULL) */
	41	__uint8_t flags; /* flags bits (see xfs_attr_leaf.h) */
	42	__uint8_t nameval[1]; /* name & value bytes concatenated */
	43	} list[1]; /* variable sized array */
	44	} xfs_attr_shortform_t;
	45	typedef struct xfs_attr_sf_hdr xfs_attr_sf_hdr_t;
	46	typedef struct xfs_attr_sf_entry xfs_attr_sf_entry_t;
	47
	48	/*
	49	* We generate this then sort it, attr_list() must return things in hash-order.
	50	*/
	51	typedef struct xfs_attr_sf_sort {
	52	__uint8_t entno; /* entry number in original list */
	53	__uint8_t namelen; /* length of name value (no null) */
	54	__uint8_t valuelen; /* length of value */
	55	__uint8_t flags; /* flags bits (see xfs_attr_leaf.h) */
	56	xfs_dahash_t hash; /* this entry's hash value */
	57	char name; / name value, pointer into buffer */
	58	} xfs_attr_sf_sort_t;
	59
1da177e4	60	#define XFS_ATTR_SF_ENTSIZE_BYNAME(nlen,vlen) /* space name/value uses */ \
a844f451	61	(((int)sizeof(xfs_attr_sf_entry_t)-1 + (nlen)+(vlen)))
1da177e4 LT	62	#define XFS_ATTR_SF_ENTSIZE_MAX /* max space for name&value */ \
1da177e4 LT	63	((1 << (NBBY*(int)sizeof(__uint8_t))) - 1)
1da177e4 LT	64	#define XFS_ATTR_SF_ENTSIZE(sfep) /* space an entry uses */ \
1da177e4 LT	65	((int)sizeof(xfs_attr_sf_entry_t)-1 + (sfep)->namelen+(sfep)->valuelen)
1da177e4	66	#define XFS_ATTR_SF_NEXTENTRY(sfep) /* next entry in struct */ \
a844f451	67	((xfs_attr_sf_entry_t )((char )(sfep) + XFS_ATTR_SF_ENTSIZE(sfep)))
1da177e4	68	#define XFS_ATTR_SF_TOTSIZE(dp) /* total space in use */ \
3b244aa8 NS	69	(be16_to_cpu(((xfs_attr_shortform_t *) \
3b244aa8 NS	70	((dp)->i_afp->if_u1.if_data))->hdr.totsize))
1da177e4 LT	71
	72	#if defined(XFS_ATTR_TRACE)
	73	/*
	74	* Kernel tracing support for attribute lists
	75	*/
	76	struct xfs_attr_list_context;
	77	struct xfs_da_intnode;
	78	struct xfs_da_node_entry;
	79	struct xfs_attr_leafblock;
	80
	81	#define XFS_ATTR_TRACE_SIZE 4096 /* size of global trace buffer */
	82	extern ktrace_t *xfs_attr_trace_buf;
	83
	84	/*
	85	* Trace record types.
	86	*/
	87	#define XFS_ATTR_KTRACE_L_C 1 /* context */
	88	#define XFS_ATTR_KTRACE_L_CN 2 /* context, node */
	89	#define XFS_ATTR_KTRACE_L_CB 3 /* context, btree */
	90	#define XFS_ATTR_KTRACE_L_CL 4 /* context, leaf */
	91
	92	void xfs_attr_trace_l_c(char where, struct xfs_attr_list_context context);
	93	void xfs_attr_trace_l_cn(char where, struct xfs_attr_list_context context,
	94	struct xfs_da_intnode *node);
	95	void xfs_attr_trace_l_cb(char where, struct xfs_attr_list_context context,
	96	struct xfs_da_node_entry *btree);
	97	void xfs_attr_trace_l_cl(char where, struct xfs_attr_list_context context,
	98	struct xfs_attr_leafblock *leaf);
	99	void xfs_attr_trace_enter(int type, char *where,
68f34d51 ES	100	struct xfs_attr_list_context *context,
	101	__psunsigned_t a13, __psunsigned_t a14,
	102	__psunsigned_t a15);
1da177e4 LT	103	#else
	104	#define xfs_attr_trace_l_c(w,c)
	105	#define xfs_attr_trace_l_cn(w,c,n)
	106	#define xfs_attr_trace_l_cb(w,c,b)
	107	#define xfs_attr_trace_l_cl(w,c,l)
	108	#endif /* XFS_ATTR_TRACE */
	109
	110	#endif /* __XFS_ATTR_SF_H__ */