[mirror_ubuntu-bionic-kernel.git] / fs / xfs / xfs_attr.h

/*
 * Copyright (c) 2000,2002-2003,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_H__
#define	__XFS_ATTR_H__

struct xfs_inode;
struct xfs_da_args;
struct xfs_attr_list_context;

/*
 * Large attribute lists are structured around Btrees where all the data
 * elements are in the leaf nodes.  Attribute names are hashed into an int,
 * then that int is used as the index into the Btree.  Since the hashval
 * of an attribute name may not be unique, we may have duplicate keys.
 * The internal links in the Btree are logical block offsets into the file.
 *
 * Small attribute lists use a different format and are packed as tightly
 * as possible so as to fit into the literal area of the inode.
 */

/*========================================================================
 * External interfaces
 *========================================================================*/


#define ATTR_DONTFOLLOW	0x0001	/* -- unused, from IRIX -- */
#define ATTR_ROOT	0x0002	/* use attrs in root (trusted) namespace */
#define ATTR_TRUST	0x0004	/* -- unused, from IRIX -- */
#define ATTR_SECURE	0x0008	/* use attrs in security namespace */
#define ATTR_CREATE	0x0010	/* pure create: fail if attr already exists */
#define ATTR_REPLACE	0x0020	/* pure set: fail if attr does not exist */

#define ATTR_KERNOTIME	0x1000	/* [kernel] don't update inode timestamps */
#define ATTR_KERNOVAL	0x2000	/* [kernel] get attr size only, not value */

#define ATTR_INCOMPLETE	0x4000	/* [kernel] return INCOMPLETE attr keys */

#define XFS_ATTR_FLAGS \
	{ ATTR_DONTFOLLOW, 	"DONTFOLLOW" }, \
	{ ATTR_ROOT,		"ROOT" }, \
	{ ATTR_TRUST,		"TRUST" }, \
	{ ATTR_SECURE,		"SECURE" }, \
	{ ATTR_CREATE,		"CREATE" }, \
	{ ATTR_REPLACE,		"REPLACE" }, \
	{ ATTR_KERNOTIME,	"KERNOTIME" }, \
	{ ATTR_KERNOVAL,	"KERNOVAL" }, \
	{ ATTR_INCOMPLETE,	"INCOMPLETE" }

/*
 * The maximum size (into the kernel or returned from the kernel) of an
 * attribute value or the buffer used for an attr_list() call.  Larger
 * sizes will result in an ERANGE return code.
 */
#define	ATTR_MAX_VALUELEN	(64*1024)	/* max length of a value */

/*
 * Define how lists of attribute names are returned to the user from
 * the attr_list() call.  A large, 32bit aligned, buffer is passed in
 * along with its size.  We put an array of offsets at the top that each
 * reference an attrlist_ent_t and pack the attrlist_ent_t's at the bottom.
 */
typedef struct attrlist {
	__s32	al_count;	/* number of entries in attrlist */
	__s32	al_more;	/* T/F: more attrs (do call again) */
	__s32	al_offset[1];	/* byte offsets of attrs [var-sized] */
} attrlist_t;

/*
 * Show the interesting info about one attribute.  This is what the
 * al_offset[i] entry points to.
 */
typedef struct attrlist_ent {	/* data from attr_list() */
	__u32	a_valuelen;	/* number bytes in value of attr */
	char	a_name[1];	/* attr name (NULL terminated) */
} attrlist_ent_t;

/*
 * Given a pointer to the (char*) buffer containing the attr_list() result,
 * and an index, return a pointer to the indicated attribute in the buffer.
 */
#define	ATTR_ENTRY(buffer, index)		\
	((attrlist_ent_t *)			\
	 &((char *)buffer)[ ((attrlist_t *)(buffer))->al_offset[index] ])

/*
 * Kernel-internal version of the attrlist cursor.
 */
typedef struct attrlist_cursor_kern {
	__u32	hashval;	/* hash value of next entry to add */
	__u32	blkno;		/* block containing entry (suggestion) */
	__u32	offset;		/* offset in list of equal-hashvals */
	__u16	pad1;		/* padding to match user-level */
	__u8	pad2;		/* padding to match user-level */
	__u8	initted;	/* T/F: cursor has been initialized */
} attrlist_cursor_kern_t;


/*========================================================================
 * Structure used to pass context around among the routines.
 *========================================================================*/


/* void; state communicated via *context */
typedef void (*put_listent_func_t)(struct xfs_attr_list_context *, int,
			      unsigned char *, int, int);

typedef struct xfs_attr_list_context {
	struct xfs_trans		*tp;
	struct xfs_inode		*dp;		/* inode */
	struct attrlist_cursor_kern	*cursor;	/* position in list */
	char				*alist;		/* output buffer */
	int				seen_enough;	/* T/F: seen enough of list? */
	ssize_t				count;		/* num used entries */
	int				dupcnt;		/* count dup hashvals seen */
	int				bufsize;	/* total buffer size */
	int				firstu;		/* first used byte in buffer */
	int				flags;		/* from VOP call */
	int				resynch;	/* T/F: resynch with cursor */
	put_listent_func_t		put_listent;	/* list output fmt function */
	int				index;		/* index into output buffer */
} xfs_attr_list_context_t;


/*========================================================================
 * Function prototypes for the kernel.
 *========================================================================*/

/*
 * Overall external interface routines.
 */
int xfs_attr_inactive(struct xfs_inode *dp);
int xfs_attr_list_int_ilocked(struct xfs_attr_list_context *);
int xfs_attr_list_int(struct xfs_attr_list_context *);
int xfs_inode_hasattr(struct xfs_inode *ip);
int xfs_attr_get_ilocked(struct xfs_inode *ip, struct xfs_da_args *args);
int xfs_attr_get(struct xfs_inode *ip, const unsigned char *name,
		 unsigned char *value, int *valuelenp, int flags);
int xfs_attr_set(struct xfs_inode *dp, const unsigned char *name,
		 unsigned char *value, int valuelen, int flags);
int xfs_attr_remove(struct xfs_inode *dp, const unsigned char *name, int flags);
int xfs_attr_list(struct xfs_inode *dp, char *buffer, int bufsize,
		  int flags, struct attrlist_cursor_kern *cursor);


#endif	/* __XFS_ATTR_H__ */
Commit	Line	Data
1da177e4	1	/*
7b718769 NS	2	* Copyright (c) 2000,2002-2003,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_H__
	19	#define __XFS_ATTR_H__
	20
ad9b463a CH	21	struct xfs_inode;
	22	struct xfs_da_args;
	23	struct xfs_attr_list_context;
	24
1da177e4	25	/*
1da177e4 LT	26	* Large attribute lists are structured around Btrees where all the data
	27	* elements are in the leaf nodes. Attribute names are hashed into an int,
	28	* then that int is used as the index into the Btree. Since the hashval
	29	* of an attribute name may not be unique, we may have duplicate keys.
	30	* The internal links in the Btree are logical block offsets into the file.
	31	*
	32	* Small attribute lists use a different format and are packed as tightly
	33	* as possible so as to fit into the literal area of the inode.
	34	*/
	35
	36	/*========================================================================
	37	* External interfaces
	38	========================================================================/
	39
1da177e4 LT	40
	41	#define ATTR_DONTFOLLOW 0x0001 /* -- unused, from IRIX -- */
	42	#define ATTR_ROOT 0x0002 /* use attrs in root (trusted) namespace */
	43	#define ATTR_TRUST 0x0004 /* -- unused, from IRIX -- */
	44	#define ATTR_SECURE 0x0008 /* use attrs in security namespace */
	45	#define ATTR_CREATE 0x0010 /* pure create: fail if attr already exists */
	46	#define ATTR_REPLACE 0x0020 /* pure set: fail if attr does not exist */
1da177e4	47
1da177e4 LT	48	#define ATTR_KERNOTIME 0x1000 /* [kernel] don't update inode timestamps */
1da177e4 LT	49	#define ATTR_KERNOVAL 0x2000 /* [kernel] get attr size only, not value */
1da177e4	50
eec0482e DW	51	#define ATTR_INCOMPLETE 0x4000 /* [kernel] return INCOMPLETE attr keys */
eec0482e DW	52
0b1b213f CH	53	#define XFS_ATTR_FLAGS \
	54	{ ATTR_DONTFOLLOW, "DONTFOLLOW" }, \
	55	{ ATTR_ROOT, "ROOT" }, \
	56	{ ATTR_TRUST, "TRUST" }, \
	57	{ ATTR_SECURE, "SECURE" }, \
	58	{ ATTR_CREATE, "CREATE" }, \
	59	{ ATTR_REPLACE, "REPLACE" }, \
	60	{ ATTR_KERNOTIME, "KERNOTIME" }, \
eec0482e DW	61	{ ATTR_KERNOVAL, "KERNOVAL" }, \
eec0482e DW	62	{ ATTR_INCOMPLETE, "INCOMPLETE" }
0b1b213f	63
1da177e4 LT	64	/*
	65	* The maximum size (into the kernel or returned from the kernel) of an
	66	* attribute value or the buffer used for an attr_list() call. Larger
	67	* sizes will result in an ERANGE return code.
	68	*/
	69	#define ATTR_MAX_VALUELEN (641024) / max length of a value */
	70
	71	/*
	72	* Define how lists of attribute names are returned to the user from
	73	* the attr_list() call. A large, 32bit aligned, buffer is passed in
	74	* along with its size. We put an array of offsets at the top that each
	75	* reference an attrlist_ent_t and pack the attrlist_ent_t's at the bottom.
	76	*/
	77	typedef struct attrlist {
	78	__s32 al_count; /* number of entries in attrlist */
	79	__s32 al_more; /* T/F: more attrs (do call again) */
	80	__s32 al_offset[1]; /* byte offsets of attrs [var-sized] */
	81	} attrlist_t;
	82
	83	/*
	84	* Show the interesting info about one attribute. This is what the
	85	* al_offset[i] entry points to.
	86	*/
	87	typedef struct attrlist_ent { /* data from attr_list() */
	88	__u32 a_valuelen; /* number bytes in value of attr */
	89	char a_name[1]; /* attr name (NULL terminated) */
	90	} attrlist_ent_t;
	91
	92	/*
	93	* Given a pointer to the (char*) buffer containing the attr_list() result,
	94	* and an index, return a pointer to the indicated attribute in the buffer.
	95	*/
	96	#define ATTR_ENTRY(buffer, index) \
	97	((attrlist_ent_t *) \
	98	&((char )buffer)[ ((attrlist_t )(buffer))->al_offset[index] ])
	99
1da177e4 LT	100	/*
	101	* Kernel-internal version of the attrlist cursor.
	102	*/
	103	typedef struct attrlist_cursor_kern {
	104	__u32 hashval; /* hash value of next entry to add */
	105	__u32 blkno; /* block containing entry (suggestion) */
	106	__u32 offset; /* offset in list of equal-hashvals */
	107	__u16 pad1; /* padding to match user-level */
	108	__u8 pad2; /* padding to match user-level */
	109	__u8 initted; /* T/F: cursor has been initialized */
	110	} attrlist_cursor_kern_t;
	111
	112
	113	/*========================================================================
ad9b463a	114	* Structure used to pass context around among the routines.
1da177e4 LT	115	========================================================================/
1da177e4 LT	116
ad9b463a	117
f7a136ae ES	118	/* void; state communicated via context /
f7a136ae ES	119	typedef void (put_listent_func_t)(struct xfs_attr_list_context , int,
e5bd12bf	120	unsigned char *, int, int);
ad9b463a CH	121
ad9b463a CH	122	typedef struct xfs_attr_list_context {
ad017f65	123	struct xfs_trans *tp;
ad9b463a CH	124	struct xfs_inode dp; / inode */
	125	struct attrlist_cursor_kern cursor; / position in list */
	126	char alist; / output buffer */
	127	int seen_enough; /* T/F: seen enough of list? */
61f10fad	128	ssize_t count; /* num used entries */
ad9b463a CH	129	int dupcnt; /* count dup hashvals seen */
	130	int bufsize; /* total buffer size */
	131	int firstu; /* first used byte in buffer */
	132	int flags; /* from VOP call */
	133	int resynch; /* T/F: resynch with cursor */
ad9b463a CH	134	put_listent_func_t put_listent; /* list output fmt function */
	135	int index; /* index into output buffer */
	136	} xfs_attr_list_context_t;
	137
	138
	139	/*========================================================================
	140	* Function prototypes for the kernel.
	141	========================================================================/
1da177e4 LT	142
	143	/*
	144	* Overall external interface routines.
	145	*/
1da177e4	146	int xfs_attr_inactive(struct xfs_inode *dp);
ad017f65	147	int xfs_attr_list_int_ilocked(struct xfs_attr_list_context *);
ad9b463a	148	int xfs_attr_list_int(struct xfs_attr_list_context *);
abec5f2b	149	int xfs_inode_hasattr(struct xfs_inode *ip);
ad017f65	150	int xfs_attr_get_ilocked(struct xfs_inode ip, struct xfs_da_args args);
c24b5dfa DC	151	int xfs_attr_get(struct xfs_inode ip, const unsigned char name,
	152	unsigned char value, int valuelenp, int flags);
	153	int xfs_attr_set(struct xfs_inode dp, const unsigned char name,
	154	unsigned char *value, int valuelen, int flags);
	155	int xfs_attr_remove(struct xfs_inode dp, const unsigned char name, int flags);
	156	int xfs_attr_list(struct xfs_inode dp, char buffer, int bufsize,
	157	int flags, struct attrlist_cursor_kern *cursor);
	158
1da177e4 LT	159
1da177e4 LT	160	#endif /* __XFS_ATTR_H__ */