[mirror_ubuntu-jammy-kernel.git] / fs / jffs2 / xattr.h

/*
 * JFFS2 -- Journalling Flash File System, Version 2.
 *
 * Copyright (C) 2006  NEC Corporation
 *
 * Created by KaiGai Kohei <kaigai@ak.jp.nec.com>
 *
 * For licensing information, see the file 'LICENCE' in this directory.
 *
 */
#ifndef _JFFS2_FS_XATTR_H_
#define _JFFS2_FS_XATTR_H_

#include <linux/xattr.h>
#include <linux/list.h>

#define JFFS2_XFLAGS_HOT	(0x01)	/* This datum is HOT */
#define JFFS2_XFLAGS_BIND	(0x02)	/* This datum is not reclaimed */
#define JFFS2_XFLAGS_INVALID	(0x80)	/* This datum contains crc error */

struct jffs2_xattr_datum
{
	void *always_null;
	struct jffs2_raw_node_ref *node;
	uint8_t class;
	uint8_t flags;
	uint16_t xprefix;		/* see JFFS2_XATTR_PREFIX_* */

	struct list_head xindex;	/* chained from c->xattrindex[n] */
	uint32_t refcnt;		/* # of xattr_ref refers this */
	uint32_t xid;
	uint32_t version;

	uint32_t data_crc;
	uint32_t hashkey;
	char *xname;		/* XATTR name without prefix */
	uint32_t name_len;	/* length of xname */
	char *xvalue;		/* XATTR value */
	uint32_t value_len;	/* length of xvalue */
};

struct jffs2_inode_cache;
struct jffs2_xattr_ref
{
	void *always_null;
	struct jffs2_raw_node_ref *node;
	uint8_t class;
	uint8_t flags;		/* Currently unused */
	u16 unused;

	uint32_t xseqno;
	union {
		struct jffs2_inode_cache *ic;	/* reference to jffs2_inode_cache */
		uint32_t ino;			/* only used in scanning/building  */
	};
	union {
		struct jffs2_xattr_datum *xd;	/* reference to jffs2_xattr_datum */
		uint32_t xid;			/* only used in sccanning/building */
	};
	struct jffs2_xattr_ref *next;		/* chained from ic->xref_list */
};

#define XDATUM_DELETE_MARKER	(0xffffffff)
#define XREF_DELETE_MARKER	(0x00000001)
static inline int is_xattr_datum_dead(struct jffs2_xattr_datum *xd)
{
	return (xd->version == XDATUM_DELETE_MARKER);
}

static inline void set_xattr_datum_dead(struct jffs2_xattr_datum *xd)
{
	xd->version = XDATUM_DELETE_MARKER;
}

static inline int is_xattr_ref_dead(struct jffs2_xattr_ref *ref)
{
	return ((ref->xseqno & XREF_DELETE_MARKER) != 0);
}

static inline void set_xattr_ref_dead(struct jffs2_xattr_ref *ref)
{
	ref->xseqno |= XREF_DELETE_MARKER;
}

static inline void clr_xattr_ref_dead(struct jffs2_xattr_ref *ref)
{
	ref->xseqno &= ~XREF_DELETE_MARKER;
}


#ifdef CONFIG_JFFS2_FS_XATTR

extern void jffs2_init_xattr_subsystem(struct jffs2_sb_info *c);
extern void jffs2_build_xattr_subsystem(struct jffs2_sb_info *c);
extern void jffs2_clear_xattr_subsystem(struct jffs2_sb_info *c);

extern struct jffs2_xattr_datum *jffs2_setup_xattr_datum(struct jffs2_sb_info *c,
                                                  uint32_t xid, uint32_t version);

extern void jffs2_xattr_delete_inode(struct jffs2_sb_info *c, struct jffs2_inode_cache *ic);
extern void jffs2_xattr_free_inode(struct jffs2_sb_info *c, struct jffs2_inode_cache *ic);

extern int jffs2_garbage_collect_xattr_datum(struct jffs2_sb_info *c, struct jffs2_xattr_datum *xd,
					     struct jffs2_raw_node_ref *raw);
extern int jffs2_garbage_collect_xattr_ref(struct jffs2_sb_info *c, struct jffs2_xattr_ref *ref,
					   struct jffs2_raw_node_ref *raw);
extern int jffs2_verify_xattr(struct jffs2_sb_info *c);
extern void jffs2_release_xattr_datum(struct jffs2_sb_info *c, struct jffs2_xattr_datum *xd);
extern void jffs2_release_xattr_ref(struct jffs2_sb_info *c, struct jffs2_xattr_ref *ref);

extern int do_jffs2_getxattr(struct inode *inode, int xprefix, const char *xname,
			     char *buffer, size_t size);
extern int do_jffs2_setxattr(struct inode *inode, int xprefix, const char *xname,
			     const char *buffer, size_t size, int flags);

extern struct xattr_handler *jffs2_xattr_handlers[];
extern struct xattr_handler jffs2_user_xattr_handler;
extern struct xattr_handler jffs2_trusted_xattr_handler;

extern ssize_t jffs2_listxattr(struct dentry *, char *, size_t);
#define jffs2_getxattr		generic_getxattr
#define jffs2_setxattr		generic_setxattr
#define jffs2_removexattr	generic_removexattr

#else

#define jffs2_init_xattr_subsystem(c)
#define jffs2_build_xattr_subsystem(c)
#define jffs2_clear_xattr_subsystem(c)

#define jffs2_xattr_delete_inode(c, ic)
#define jffs2_xattr_free_inode(c, ic)
#define jffs2_verify_xattr(c)			(1)

#define jffs2_xattr_handlers	NULL
#define jffs2_listxattr		NULL
#define jffs2_getxattr		NULL
#define jffs2_setxattr		NULL
#define jffs2_removexattr	NULL

#endif /* CONFIG_JFFS2_FS_XATTR */

#ifdef CONFIG_JFFS2_FS_SECURITY
extern int jffs2_init_security(struct inode *inode, struct inode *dir);
extern struct xattr_handler jffs2_security_xattr_handler;
#else
#define jffs2_init_security(inode,dir)	(0)
#endif /* CONFIG_JFFS2_FS_SECURITY */

#endif /* _JFFS2_FS_XATTR_H_ */
Commit	Line	Data
652ecc20 KK	1	/*
652ecc20 KK	2	* JFFS2 -- Journalling Flash File System, Version 2.
aa98d7cf	3	*
652ecc20	4	* Copyright (C) 2006 NEC Corporation
aa98d7cf	5	*
652ecc20 KK	6	* Created by KaiGai Kohei <kaigai@ak.jp.nec.com>
	7	*
	8	* For licensing information, see the file 'LICENCE' in this directory.
	9	*
	10	*/
aa98d7cf KK	11	#ifndef _JFFS2_FS_XATTR_H_
	12	#define _JFFS2_FS_XATTR_H_
	13
	14	#include <linux/xattr.h>
4470d040	15	#include <linux/list.h>
aa98d7cf KK	16
	17	#define JFFS2_XFLAGS_HOT (0x01) /* This datum is HOT */
	18	#define JFFS2_XFLAGS_BIND (0x02) /* This datum is not reclaimed */
c9f700f8	19	#define JFFS2_XFLAGS_INVALID (0x80) /* This datum contains crc error */
aa98d7cf KK	20
	21	struct jffs2_xattr_datum
	22	{
	23	void *always_null;
aa98d7cf	24	struct jffs2_raw_node_ref *node;
987d47b7 DW	25	uint8_t class;
987d47b7 DW	26	uint8_t flags;
c9f700f8	27	uint16_t xprefix; /* see JFFS2_XATTR_PREFIX_* */
987d47b7	28
aa98d7cf KK	29	struct list_head xindex; /* chained from c->xattrindex[n] */
	30	uint32_t refcnt; /* # of xattr_ref refers this */
	31	uint32_t xid;
	32	uint32_t version;
	33
	34	uint32_t data_crc;
	35	uint32_t hashkey;
	36	char xname; / XATTR name without prefix */
	37	uint32_t name_len; /* length of xname */
	38	char xvalue; / XATTR value */
	39	uint32_t value_len; /* length of xvalue */
	40	};
	41
ee886b5d	42	struct jffs2_inode_cache;
aa98d7cf KK	43	struct jffs2_xattr_ref
	44	{
	45	void *always_null;
987d47b7 DW	46	struct jffs2_raw_node_ref *node;
	47	uint8_t class;
	48	uint8_t flags; /* Currently unused */
aa98d7cf KK	49	u16 unused;
aa98d7cf KK	50
c9f700f8	51	uint32_t xseqno;
aa98d7cf KK	52	union {
	53	struct jffs2_inode_cache ic; / reference to jffs2_inode_cache */
	54	uint32_t ino; /* only used in scanning/building */
	55	};
	56	union {
	57	struct jffs2_xattr_datum xd; / reference to jffs2_xattr_datum */
	58	uint32_t xid; /* only used in sccanning/building */
	59	};
8f2b6f49	60	struct jffs2_xattr_ref next; / chained from ic->xref_list */
aa98d7cf KK	61	};
aa98d7cf KK	62
c9f700f8 KK	63	#define XDATUM_DELETE_MARKER (0xffffffff)
	64	#define XREF_DELETE_MARKER (0x00000001)
	65	static inline int is_xattr_datum_dead(struct jffs2_xattr_datum *xd)
	66	{
	67	return (xd->version == XDATUM_DELETE_MARKER);
	68	}
	69
	70	static inline void set_xattr_datum_dead(struct jffs2_xattr_datum *xd)
	71	{
	72	xd->version = XDATUM_DELETE_MARKER;
	73	}
	74
	75	static inline int is_xattr_ref_dead(struct jffs2_xattr_ref *ref)
	76	{
	77	return ((ref->xseqno & XREF_DELETE_MARKER) != 0);
	78	}
	79
	80	static inline void set_xattr_ref_dead(struct jffs2_xattr_ref *ref)
	81	{
	82	ref->xseqno \|= XREF_DELETE_MARKER;
	83	}
	84
	85	static inline void clr_xattr_ref_dead(struct jffs2_xattr_ref *ref)
	86	{
	87	ref->xseqno &= ~XREF_DELETE_MARKER;
	88	}
	89
	90
aa98d7cf KK	91	#ifdef CONFIG_JFFS2_FS_XATTR
	92
	93	extern void jffs2_init_xattr_subsystem(struct jffs2_sb_info *c);
	94	extern void jffs2_build_xattr_subsystem(struct jffs2_sb_info *c);
	95	extern void jffs2_clear_xattr_subsystem(struct jffs2_sb_info *c);
	96
	97	extern struct jffs2_xattr_datum jffs2_setup_xattr_datum(struct jffs2_sb_info c,
	98	uint32_t xid, uint32_t version);
	99
	100	extern void jffs2_xattr_delete_inode(struct jffs2_sb_info c, struct jffs2_inode_cache ic);
	101	extern void jffs2_xattr_free_inode(struct jffs2_sb_info c, struct jffs2_inode_cache ic);
	102
c9f700f8 KK	103	extern int jffs2_garbage_collect_xattr_datum(struct jffs2_sb_info c, struct jffs2_xattr_datum xd,
	104	struct jffs2_raw_node_ref *raw);
	105	extern int jffs2_garbage_collect_xattr_ref(struct jffs2_sb_info c, struct jffs2_xattr_ref ref,
	106	struct jffs2_raw_node_ref *raw);
aa98d7cf	107	extern int jffs2_verify_xattr(struct jffs2_sb_info *c);
c9f700f8 KK	108	extern void jffs2_release_xattr_datum(struct jffs2_sb_info c, struct jffs2_xattr_datum xd);
c9f700f8 KK	109	extern void jffs2_release_xattr_ref(struct jffs2_sb_info c, struct jffs2_xattr_ref ref);
aa98d7cf KK	110
	111	extern int do_jffs2_getxattr(struct inode inode, int xprefix, const char xname,
	112	char *buffer, size_t size);
	113	extern int do_jffs2_setxattr(struct inode inode, int xprefix, const char xname,
	114	const char *buffer, size_t size, int flags);
	115
	116	extern struct xattr_handler *jffs2_xattr_handlers[];
	117	extern struct xattr_handler jffs2_user_xattr_handler;
	118	extern struct xattr_handler jffs2_trusted_xattr_handler;
	119
	120	extern ssize_t jffs2_listxattr(struct dentry , char , size_t);
	121	#define jffs2_getxattr generic_getxattr
	122	#define jffs2_setxattr generic_setxattr
	123	#define jffs2_removexattr generic_removexattr
	124
aa98d7cf KK	125	#else
	126
	127	#define jffs2_init_xattr_subsystem(c)
	128	#define jffs2_build_xattr_subsystem(c)
	129	#define jffs2_clear_xattr_subsystem(c)
	130
	131	#define jffs2_xattr_delete_inode(c, ic)
	132	#define jffs2_xattr_free_inode(c, ic)
aa98d7cf KK	133	#define jffs2_verify_xattr(c) (1)
	134
	135	#define jffs2_xattr_handlers NULL
	136	#define jffs2_listxattr NULL
	137	#define jffs2_getxattr NULL
	138	#define jffs2_setxattr NULL
	139	#define jffs2_removexattr NULL
	140
aa98d7cf KK	141	#endif /* CONFIG_JFFS2_FS_XATTR */
	142
	143	#ifdef CONFIG_JFFS2_FS_SECURITY
	144	extern int jffs2_init_security(struct inode inode, struct inode dir);
	145	extern struct xattr_handler jffs2_security_xattr_handler;
	146	#else
	147	#define jffs2_init_security(inode,dir) (0)
	148	#endif /* CONFIG_JFFS2_FS_SECURITY */
	149
	150	#endif /* _JFFS2_FS_XATTR_H_ */