blob: 91f31ca7d9af9df24a965c64bb0271c43a4d4b09 [file] [log] [blame]
Dave Kleikampac27a0e2006-10-11 01:20:50 -07001/*
Mingming Cao617ba132006-10-11 01:20:53 -07002 File: fs/ext4/xattr.h
Dave Kleikampac27a0e2006-10-11 01:20:50 -07003
Mingming Cao617ba132006-10-11 01:20:53 -07004 On-disk format of extended attributes for the ext4 filesystem.
Dave Kleikampac27a0e2006-10-11 01:20:50 -07005
6 (C) 2001 Andreas Gruenbacher, <a.gruenbacher@computer.org>
7*/
8
9#include <linux/xattr.h>
10
11/* Magic value in attribute blocks */
Mingming Cao617ba132006-10-11 01:20:53 -070012#define EXT4_XATTR_MAGIC 0xEA020000
Dave Kleikampac27a0e2006-10-11 01:20:50 -070013
14/* Maximum number of references to one attribute block */
Mingming Cao617ba132006-10-11 01:20:53 -070015#define EXT4_XATTR_REFCOUNT_MAX 1024
Dave Kleikampac27a0e2006-10-11 01:20:50 -070016
17/* Name indexes */
Mingming Cao617ba132006-10-11 01:20:53 -070018#define EXT4_XATTR_INDEX_USER 1
19#define EXT4_XATTR_INDEX_POSIX_ACL_ACCESS 2
20#define EXT4_XATTR_INDEX_POSIX_ACL_DEFAULT 3
21#define EXT4_XATTR_INDEX_TRUSTED 4
22#define EXT4_XATTR_INDEX_LUSTRE 5
23#define EXT4_XATTR_INDEX_SECURITY 6
Dave Kleikampac27a0e2006-10-11 01:20:50 -070024
Mingming Cao617ba132006-10-11 01:20:53 -070025struct ext4_xattr_header {
Dave Kleikampac27a0e2006-10-11 01:20:50 -070026 __le32 h_magic; /* magic number for identification */
27 __le32 h_refcount; /* reference count */
28 __le32 h_blocks; /* number of disk blocks used */
29 __le32 h_hash; /* hash value of all attributes */
Darrick J. Wonge6153912012-04-29 18:23:10 -040030 __le32 h_checksum; /* crc32c(uuid+id+xattrblock) */
31 /* id = inum if refcount=1, blknum otherwise */
32 __u32 h_reserved[3]; /* zero right now */
Dave Kleikampac27a0e2006-10-11 01:20:50 -070033};
34
Mingming Cao617ba132006-10-11 01:20:53 -070035struct ext4_xattr_ibody_header {
Dave Kleikampac27a0e2006-10-11 01:20:50 -070036 __le32 h_magic; /* magic number for identification */
37};
38
Mingming Cao617ba132006-10-11 01:20:53 -070039struct ext4_xattr_entry {
Dave Kleikampac27a0e2006-10-11 01:20:50 -070040 __u8 e_name_len; /* length of name */
41 __u8 e_name_index; /* attribute name index */
42 __le16 e_value_offs; /* offset in disk block of value */
43 __le32 e_value_block; /* disk block attribute is stored on (n/i) */
44 __le32 e_value_size; /* size of attribute value */
45 __le32 e_hash; /* hash value of name and value */
46 char e_name[0]; /* attribute name */
47};
48
Mingming Cao617ba132006-10-11 01:20:53 -070049#define EXT4_XATTR_PAD_BITS 2
50#define EXT4_XATTR_PAD (1<<EXT4_XATTR_PAD_BITS)
51#define EXT4_XATTR_ROUND (EXT4_XATTR_PAD-1)
52#define EXT4_XATTR_LEN(name_len) \
53 (((name_len) + EXT4_XATTR_ROUND + \
54 sizeof(struct ext4_xattr_entry)) & ~EXT4_XATTR_ROUND)
55#define EXT4_XATTR_NEXT(entry) \
Theodore Ts'oaf5bc922008-09-08 22:25:24 -040056 ((struct ext4_xattr_entry *)( \
57 (char *)(entry) + EXT4_XATTR_LEN((entry)->e_name_len)))
Mingming Cao617ba132006-10-11 01:20:53 -070058#define EXT4_XATTR_SIZE(size) \
59 (((size) + EXT4_XATTR_ROUND) & ~EXT4_XATTR_ROUND)
Dave Kleikampac27a0e2006-10-11 01:20:50 -070060
Kalpak Shah6dd4ee72007-07-18 09:19:57 -040061#define IHDR(inode, raw_inode) \
62 ((struct ext4_xattr_ibody_header *) \
63 ((void *)raw_inode + \
64 EXT4_GOOD_OLD_INODE_SIZE + \
65 EXT4_I(inode)->i_extra_isize))
66#define IFIRST(hdr) ((struct ext4_xattr_entry *)((hdr)+1))
67
Theodore Ts'o03010a32008-10-10 20:02:48 -040068# ifdef CONFIG_EXT4_FS_XATTR
Dave Kleikampac27a0e2006-10-11 01:20:50 -070069
Stephen Hemminger11e27522010-05-13 17:53:18 -070070extern const struct xattr_handler ext4_xattr_user_handler;
71extern const struct xattr_handler ext4_xattr_trusted_handler;
72extern const struct xattr_handler ext4_xattr_acl_access_handler;
73extern const struct xattr_handler ext4_xattr_acl_default_handler;
74extern const struct xattr_handler ext4_xattr_security_handler;
Dave Kleikampac27a0e2006-10-11 01:20:50 -070075
Mingming Cao617ba132006-10-11 01:20:53 -070076extern ssize_t ext4_listxattr(struct dentry *, char *, size_t);
Dave Kleikampac27a0e2006-10-11 01:20:50 -070077
Mingming Cao617ba132006-10-11 01:20:53 -070078extern int ext4_xattr_get(struct inode *, int, const char *, void *, size_t);
Mingming Cao617ba132006-10-11 01:20:53 -070079extern int ext4_xattr_set(struct inode *, int, const char *, const void *, size_t, int);
80extern int ext4_xattr_set_handle(handle_t *, struct inode *, int, const char *, const void *, size_t, int);
Dave Kleikampac27a0e2006-10-11 01:20:50 -070081
Mingming Cao617ba132006-10-11 01:20:53 -070082extern void ext4_xattr_delete_inode(handle_t *, struct inode *);
83extern void ext4_xattr_put_super(struct super_block *);
Dave Kleikampac27a0e2006-10-11 01:20:50 -070084
Kalpak Shah6dd4ee72007-07-18 09:19:57 -040085extern int ext4_expand_extra_isize_ea(struct inode *inode, int new_extra_isize,
86 struct ext4_inode *raw_inode, handle_t *handle);
87
Theodore Ts'o5dabfc72010-10-27 21:30:14 -040088extern int __init ext4_init_xattr(void);
89extern void ext4_exit_xattr(void);
Dave Kleikampac27a0e2006-10-11 01:20:50 -070090
Stephen Hemminger11e27522010-05-13 17:53:18 -070091extern const struct xattr_handler *ext4_xattr_handlers[];
Dave Kleikampac27a0e2006-10-11 01:20:50 -070092
Theodore Ts'o03010a32008-10-10 20:02:48 -040093# else /* CONFIG_EXT4_FS_XATTR */
Dave Kleikampac27a0e2006-10-11 01:20:50 -070094
95static inline int
Mingming Cao617ba132006-10-11 01:20:53 -070096ext4_xattr_get(struct inode *inode, int name_index, const char *name,
Dave Kleikampac27a0e2006-10-11 01:20:50 -070097 void *buffer, size_t size, int flags)
98{
99 return -EOPNOTSUPP;
100}
101
102static inline int
Mingming Cao617ba132006-10-11 01:20:53 -0700103ext4_xattr_set(struct inode *inode, int name_index, const char *name,
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700104 const void *value, size_t size, int flags)
105{
106 return -EOPNOTSUPP;
107}
108
109static inline int
Mingming Cao617ba132006-10-11 01:20:53 -0700110ext4_xattr_set_handle(handle_t *handle, struct inode *inode, int name_index,
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700111 const char *name, const void *value, size_t size, int flags)
112{
113 return -EOPNOTSUPP;
114}
115
116static inline void
Mingming Cao617ba132006-10-11 01:20:53 -0700117ext4_xattr_delete_inode(handle_t *handle, struct inode *inode)
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700118{
119}
120
121static inline void
Mingming Cao617ba132006-10-11 01:20:53 -0700122ext4_xattr_put_super(struct super_block *sb)
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700123{
124}
125
Theodore Ts'o5dabfc72010-10-27 21:30:14 -0400126static __init inline int
Ingo Molnar19ef2012010-10-28 09:56:31 +0200127ext4_init_xattr(void)
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700128{
129 return 0;
130}
131
132static inline void
Theodore Ts'o5dabfc72010-10-27 21:30:14 -0400133ext4_exit_xattr(void)
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700134{
135}
136
Kalpak Shah6dd4ee72007-07-18 09:19:57 -0400137static inline int
138ext4_expand_extra_isize_ea(struct inode *inode, int new_extra_isize,
139 struct ext4_inode *raw_inode, handle_t *handle)
140{
141 return -EOPNOTSUPP;
142}
143
Mingming Cao617ba132006-10-11 01:20:53 -0700144#define ext4_xattr_handlers NULL
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700145
Theodore Ts'o03010a32008-10-10 20:02:48 -0400146# endif /* CONFIG_EXT4_FS_XATTR */
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700147
Theodore Ts'o03010a32008-10-10 20:02:48 -0400148#ifdef CONFIG_EXT4_FS_SECURITY
Mingming Cao617ba132006-10-11 01:20:53 -0700149extern int ext4_init_security(handle_t *handle, struct inode *inode,
Eric Paris2a7dba32011-02-01 11:05:39 -0500150 struct inode *dir, const struct qstr *qstr);
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700151#else
Mingming Cao617ba132006-10-11 01:20:53 -0700152static inline int ext4_init_security(handle_t *handle, struct inode *inode,
Eric Paris2a7dba32011-02-01 11:05:39 -0500153 struct inode *dir, const struct qstr *qstr)
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700154{
155 return 0;
156}
157#endif