[deliverable/linux.git] / fs / xfs / xfs_attr_sf.h

/*
 * Copyright (c) 2000, 2002 Silicon Graphics, Inc.  All Rights Reserved.
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of version 2 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.
 *
 * Further, this software is distributed without any warranty that it is
 * free of the rightful claim of any third person regarding infringement
 * or the like.  Any license provided herein, whether implied or
 * otherwise, applies only to this software file.  Patent licenses, if
 * any, provided herein do not apply to combinations of this program with
 * other software, or any other product whatsoever.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write the Free Software Foundation, Inc., 59
 * Temple Place - Suite 330, Boston MA 02111-1307, USA.
 *
 * Contact information: Silicon Graphics, Inc., 1600 Amphitheatre Pkwy,
 * Mountain View, CA  94043, or:
 *
 * http://www.sgi.com
 *
 * For further information regarding this notice, see:
 *
 * http://oss.sgi.com/projects/GenInfo/SGIGPLNoticeExplan/
 */
#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 */
		__uint16_t totsize;	/* total bytes in shortform list */
		__uint8_t 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 */ \
	(INT_GET(((xfs_attr_shortform_t *)	\
		((dp)->i_afp->if_u1.if_data))->hdr.totsize, ARCH_CONVERT))

#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,
			     __psunsigned_t a2, __psunsigned_t a3,
			     __psunsigned_t a4, __psunsigned_t a5,
			     __psunsigned_t a6, __psunsigned_t a7,
			     __psunsigned_t a8, __psunsigned_t a9,
			     __psunsigned_t a10, __psunsigned_t a11,
			     __psunsigned_t a12, __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 LT	1	/*
	2	* Copyright (c) 2000, 2002 Silicon Graphics, Inc. All Rights Reserved.
	3	*
	4	* This program is free software; you can redistribute it and/or modify it
	5	* under the terms of version 2 of the GNU General Public License as
	6	* published by the Free Software Foundation.
	7	*
	8	* This program is distributed in the hope that it would be useful, but
	9	* WITHOUT ANY WARRANTY; without even the implied warranty of
	10	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
	11	*
	12	* Further, this software is distributed without any warranty that it is
	13	* free of the rightful claim of any third person regarding infringement
	14	* or the like. Any license provided herein, whether implied or
	15	* otherwise, applies only to this software file. Patent licenses, if
	16	* any, provided herein do not apply to combinations of this program with
	17	* other software, or any other product whatsoever.
	18	*
	19	* You should have received a copy of the GNU General Public License along
	20	* with this program; if not, write the Free Software Foundation, Inc., 59
	21	* Temple Place - Suite 330, Boston MA 02111-1307, USA.
	22	*
	23	* Contact information: Silicon Graphics, Inc., 1600 Amphitheatre Pkwy,
	24	* Mountain View, CA 94043, or:
	25	*
	26	* http://www.sgi.com
	27	*
	28	* For further information regarding this notice, see:
	29	*
	30	* http://oss.sgi.com/projects/GenInfo/SGIGPLNoticeExplan/
	31	*/
	32	#ifndef __XFS_ATTR_SF_H__
	33	#define __XFS_ATTR_SF_H__
	34
	35	/*
	36	* Attribute storage when stored inside the inode.
	37	*
	38	* Small attribute lists are packed as tightly as possible so as
	39	* to fit into the literal area of the inode.
	40	*/
	41
	42	struct xfs_inode;
	43
	44	/*
	45	* Entries are packed toward the top as tight as possible.
	46	*/
	47	typedef struct xfs_attr_shortform {
	48	struct xfs_attr_sf_hdr { /* constant-structure header block */
	49	__uint16_t totsize; /* total bytes in shortform list */
	50	__uint8_t count; /* count of active entries */
	51	} hdr;
	52	struct xfs_attr_sf_entry {
	53	__uint8_t namelen; /* actual length of name (no NULL) */
	54	__uint8_t valuelen; /* actual length of value (no NULL) */
	55	__uint8_t flags; /* flags bits (see xfs_attr_leaf.h) */
	56	__uint8_t nameval[1]; /* name & value bytes concatenated */
	57	} list[1]; /* variable sized array */
	58	} xfs_attr_shortform_t;
	59	typedef struct xfs_attr_sf_hdr xfs_attr_sf_hdr_t;
	60	typedef struct xfs_attr_sf_entry xfs_attr_sf_entry_t;
	61
	62	/*
	63	* We generate this then sort it, attr_list() must return things in hash-order.
	64	*/
65	typedef struct xfs_attr_sf_sort {
66	__uint8_t entno; /* entry number in original list */
67	__uint8_t namelen; /* length of name value (no null) */
68	__uint8_t valuelen; /* length of value */
69	__uint8_t flags; /* flags bits (see xfs_attr_leaf.h) */
70	xfs_dahash_t hash; /* this entry's hash value */
71	char name; / name value, pointer into buffer */
72	} xfs_attr_sf_sort_t;
73
1da177e4	74	#define XFS_ATTR_SF_ENTSIZE_BYNAME(nlen,vlen) /* space name/value uses */ \
a844f451	75	(((int)sizeof(xfs_attr_sf_entry_t)-1 + (nlen)+(vlen)))
1da177e4 LT	76	#define XFS_ATTR_SF_ENTSIZE_MAX /* max space for name&value */ \
1da177e4 LT	77	((1 << (NBBY*(int)sizeof(__uint8_t))) - 1)
1da177e4 LT	78	#define XFS_ATTR_SF_ENTSIZE(sfep) /* space an entry uses */ \
1da177e4 LT	79	((int)sizeof(xfs_attr_sf_entry_t)-1 + (sfep)->namelen+(sfep)->valuelen)
1da177e4	80	#define XFS_ATTR_SF_NEXTENTRY(sfep) /* next entry in struct */ \
a844f451	81	((xfs_attr_sf_entry_t )((char )(sfep) + XFS_ATTR_SF_ENTSIZE(sfep)))
1da177e4	82	#define XFS_ATTR_SF_TOTSIZE(dp) /* total space in use */ \
a844f451 NS	83	(INT_GET(((xfs_attr_shortform_t *) \
a844f451 NS	84	((dp)->i_afp->if_u1.if_data))->hdr.totsize, ARCH_CONVERT))
1da177e4 LT	85
	86	#if defined(XFS_ATTR_TRACE)
	87	/*
	88	* Kernel tracing support for attribute lists
	89	*/
	90	struct xfs_attr_list_context;
	91	struct xfs_da_intnode;
	92	struct xfs_da_node_entry;
	93	struct xfs_attr_leafblock;
	94
	95	#define XFS_ATTR_TRACE_SIZE 4096 /* size of global trace buffer */
	96	extern ktrace_t *xfs_attr_trace_buf;
	97
	98	/*
	99	* Trace record types.
	100	*/
	101	#define XFS_ATTR_KTRACE_L_C 1 /* context */
	102	#define XFS_ATTR_KTRACE_L_CN 2 /* context, node */
	103	#define XFS_ATTR_KTRACE_L_CB 3 /* context, btree */
	104	#define XFS_ATTR_KTRACE_L_CL 4 /* context, leaf */
	105
	106	void xfs_attr_trace_l_c(char where, struct xfs_attr_list_context context);
	107	void xfs_attr_trace_l_cn(char where, struct xfs_attr_list_context context,
	108	struct xfs_da_intnode *node);
	109	void xfs_attr_trace_l_cb(char where, struct xfs_attr_list_context context,
	110	struct xfs_da_node_entry *btree);
	111	void xfs_attr_trace_l_cl(char where, struct xfs_attr_list_context context,
	112	struct xfs_attr_leafblock *leaf);
	113	void xfs_attr_trace_enter(int type, char *where,
	114	__psunsigned_t a2, __psunsigned_t a3,
	115	__psunsigned_t a4, __psunsigned_t a5,
	116	__psunsigned_t a6, __psunsigned_t a7,
	117	__psunsigned_t a8, __psunsigned_t a9,
	118	__psunsigned_t a10, __psunsigned_t a11,
	119	__psunsigned_t a12, __psunsigned_t a13,
	120	__psunsigned_t a14, __psunsigned_t a15);
	121	#else
	122	#define xfs_attr_trace_l_c(w,c)
	123	#define xfs_attr_trace_l_cn(w,c,n)
	124	#define xfs_attr_trace_l_cb(w,c,b)
	125	#define xfs_attr_trace_l_cl(w,c,l)
	126	#endif /* XFS_ATTR_TRACE */
	127
	128	#endif /* __XFS_ATTR_SF_H__ */