blob: c767dbdd7fc495e5a4fd4a5c581455db73c5c1c3 [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
Tao Ma67cf5b02012-12-10 14:04:46 -050024#define EXT4_XATTR_INDEX_SYSTEM 7
Theodore Ts'ofd03d8d2013-04-18 14:53:15 -040025#define EXT4_XATTR_INDEX_RICHACL 8
Dave Kleikampac27a0e2006-10-11 01:20:50 -070026
Mingming Cao617ba132006-10-11 01:20:53 -070027struct ext4_xattr_header {
Dave Kleikampac27a0e2006-10-11 01:20:50 -070028 __le32 h_magic; /* magic number for identification */
29 __le32 h_refcount; /* reference count */
30 __le32 h_blocks; /* number of disk blocks used */
31 __le32 h_hash; /* hash value of all attributes */
Darrick J. Wonge6153912012-04-29 18:23:10 -040032 __le32 h_checksum; /* crc32c(uuid+id+xattrblock) */
33 /* id = inum if refcount=1, blknum otherwise */
34 __u32 h_reserved[3]; /* zero right now */
Dave Kleikampac27a0e2006-10-11 01:20:50 -070035};
36
Mingming Cao617ba132006-10-11 01:20:53 -070037struct ext4_xattr_ibody_header {
Dave Kleikampac27a0e2006-10-11 01:20:50 -070038 __le32 h_magic; /* magic number for identification */
39};
40
Mingming Cao617ba132006-10-11 01:20:53 -070041struct ext4_xattr_entry {
Dave Kleikampac27a0e2006-10-11 01:20:50 -070042 __u8 e_name_len; /* length of name */
43 __u8 e_name_index; /* attribute name index */
44 __le16 e_value_offs; /* offset in disk block of value */
45 __le32 e_value_block; /* disk block attribute is stored on (n/i) */
46 __le32 e_value_size; /* size of attribute value */
47 __le32 e_hash; /* hash value of name and value */
48 char e_name[0]; /* attribute name */
49};
50
Mingming Cao617ba132006-10-11 01:20:53 -070051#define EXT4_XATTR_PAD_BITS 2
52#define EXT4_XATTR_PAD (1<<EXT4_XATTR_PAD_BITS)
53#define EXT4_XATTR_ROUND (EXT4_XATTR_PAD-1)
54#define EXT4_XATTR_LEN(name_len) \
55 (((name_len) + EXT4_XATTR_ROUND + \
56 sizeof(struct ext4_xattr_entry)) & ~EXT4_XATTR_ROUND)
57#define EXT4_XATTR_NEXT(entry) \
Theodore Ts'oaf5bc922008-09-08 22:25:24 -040058 ((struct ext4_xattr_entry *)( \
59 (char *)(entry) + EXT4_XATTR_LEN((entry)->e_name_len)))
Mingming Cao617ba132006-10-11 01:20:53 -070060#define EXT4_XATTR_SIZE(size) \
61 (((size) + EXT4_XATTR_ROUND) & ~EXT4_XATTR_ROUND)
Dave Kleikampac27a0e2006-10-11 01:20:50 -070062
Kalpak Shah6dd4ee72007-07-18 09:19:57 -040063#define IHDR(inode, raw_inode) \
64 ((struct ext4_xattr_ibody_header *) \
65 ((void *)raw_inode + \
66 EXT4_GOOD_OLD_INODE_SIZE + \
67 EXT4_I(inode)->i_extra_isize))
68#define IFIRST(hdr) ((struct ext4_xattr_entry *)((hdr)+1))
69
Tao Ma879b3822012-12-05 10:28:46 -050070#define BHDR(bh) ((struct ext4_xattr_header *)((bh)->b_data))
71#define ENTRY(ptr) ((struct ext4_xattr_entry *)(ptr))
72#define BFIRST(bh) ENTRY(BHDR(bh)+1)
73#define IS_LAST_ENTRY(entry) (*(__u32 *)(entry) == 0)
74
Theodore Ts'obd9926e2012-12-11 03:31:49 -050075#define EXT4_ZERO_XATTR_VALUE ((void *)-1)
Tao Ma879b3822012-12-05 10:28:46 -050076
77struct ext4_xattr_info {
78 int name_index;
79 const char *name;
80 const void *value;
81 size_t value_len;
82};
83
84struct ext4_xattr_search {
85 struct ext4_xattr_entry *first;
86 void *base;
87 void *end;
88 struct ext4_xattr_entry *here;
89 int not_found;
90};
91
92struct ext4_xattr_ibody_find {
93 struct ext4_xattr_search s;
94 struct ext4_iloc iloc;
95};
96
Stephen Hemminger11e27522010-05-13 17:53:18 -070097extern const struct xattr_handler ext4_xattr_user_handler;
98extern const struct xattr_handler ext4_xattr_trusted_handler;
99extern const struct xattr_handler ext4_xattr_acl_access_handler;
100extern const struct xattr_handler ext4_xattr_acl_default_handler;
101extern const struct xattr_handler ext4_xattr_security_handler;
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700102
Mingming Cao617ba132006-10-11 01:20:53 -0700103extern ssize_t ext4_listxattr(struct dentry *, char *, size_t);
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700104
Mingming Cao617ba132006-10-11 01:20:53 -0700105extern int ext4_xattr_get(struct inode *, int, const char *, void *, size_t);
Mingming Cao617ba132006-10-11 01:20:53 -0700106extern int ext4_xattr_set(struct inode *, int, const char *, const void *, size_t, int);
107extern int ext4_xattr_set_handle(handle_t *, struct inode *, int, const char *, const void *, size_t, int);
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700108
Mingming Cao617ba132006-10-11 01:20:53 -0700109extern void ext4_xattr_delete_inode(handle_t *, struct inode *);
110extern void ext4_xattr_put_super(struct super_block *);
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700111
Kalpak Shah6dd4ee72007-07-18 09:19:57 -0400112extern int ext4_expand_extra_isize_ea(struct inode *inode, int new_extra_isize,
113 struct ext4_inode *raw_inode, handle_t *handle);
114
Theodore Ts'o5dabfc72010-10-27 21:30:14 -0400115extern int __init ext4_init_xattr(void);
116extern void ext4_exit_xattr(void);
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700117
Stephen Hemminger11e27522010-05-13 17:53:18 -0700118extern const struct xattr_handler *ext4_xattr_handlers[];
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700119
Tao Ma879b3822012-12-05 10:28:46 -0500120extern int ext4_xattr_ibody_find(struct inode *inode, struct ext4_xattr_info *i,
121 struct ext4_xattr_ibody_find *is);
122extern int ext4_xattr_ibody_get(struct inode *inode, int name_index,
123 const char *name,
124 void *buffer, size_t buffer_size);
Tao Ma0d812f72012-12-10 14:06:02 -0500125extern int ext4_xattr_ibody_inline_set(handle_t *handle, struct inode *inode,
126 struct ext4_xattr_info *i,
127 struct ext4_xattr_ibody_find *is);
Tao Ma879b3822012-12-05 10:28:46 -0500128
Theodore Ts'o03010a32008-10-10 20:02:48 -0400129#ifdef CONFIG_EXT4_FS_SECURITY
Mingming Cao617ba132006-10-11 01:20:53 -0700130extern int ext4_init_security(handle_t *handle, struct inode *inode,
Eric Paris2a7dba32011-02-01 11:05:39 -0500131 struct inode *dir, const struct qstr *qstr);
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700132#else
Mingming Cao617ba132006-10-11 01:20:53 -0700133static inline int ext4_init_security(handle_t *handle, struct inode *inode,
Eric Paris2a7dba32011-02-01 11:05:39 -0500134 struct inode *dir, const struct qstr *qstr)
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700135{
136 return 0;
137}
138#endif