1 // SPDX-License-Identifier: GPL-2.0
3 * linux/fs/ext4/xattr.c
9 * Extended attributes for symlinks and special files added per
18 * Extended attributes are stored directly in inodes (on file systems with
19 * inodes bigger than 128 bytes) and on additional disk blocks. The i_file_acl
20 * field contains the block number if an inode uses an additional block. All
21 * attributes must fit in the inode and one additional block. Blocks that
22 * contain the identical set of attributes may be shared among several inodes.
23 * Identical blocks are detected by keeping a cache of blocks that have
24 * recently been accessed.
26 * The attributes in inodes and on blocks have a different header; the entries
27 * are stored in the same format:
29 * +------------------+
32 * | entry 2 | | growing downwards
37 * | value 3 | | growing upwards
39 * +------------------+
41 * The header is followed by multiple entry descriptors. In disk blocks, the
42 * entry descriptors are kept sorted. In inodes, they are unsorted. The
43 * attribute values are aligned to the end of the block in no specific order.
47 * EXT4_I(inode)->i_file_acl is protected by EXT4_I(inode)->xattr_sem.
48 * EA blocks are only changed if they are exclusive to an inode, so
49 * holding xattr_sem also means that nothing but the EA block's reference
50 * count can change. Multiple writers to the same block are synchronized
54 #include <linux/init.h>
56 #include <linux/slab.h>
57 #include <linux/mbcache.h>
58 #include <linux/quotaops.h>
59 #include <linux/iversion.h>
60 #include "ext4_jbd2.h"
65 #ifdef EXT4_XATTR_DEBUG
66 # define ea_idebug(inode, fmt, ...) \
67 printk(KERN_DEBUG "inode %s:%lu: " fmt "\n", \
68 inode->i_sb->s_id, inode->i_ino, ##__VA_ARGS__)
69 # define ea_bdebug(bh, fmt, ...) \
70 printk(KERN_DEBUG "block %pg:%lu: " fmt "\n", \
71 bh->b_bdev, (unsigned long)bh->b_blocknr, ##__VA_ARGS__)
73 # define ea_idebug(inode, fmt, ...) no_printk(fmt, ##__VA_ARGS__)
74 # define ea_bdebug(bh, fmt, ...) no_printk(fmt, ##__VA_ARGS__)
77 static void ext4_xattr_block_cache_insert(struct mb_cache *,
78 struct buffer_head *);
79 static struct buffer_head *
80 ext4_xattr_block_cache_find(struct inode *, struct ext4_xattr_header *,
81 struct mb_cache_entry **);
82 static __le32 ext4_xattr_hash_entry(char *name, size_t name_len, __le32 *value,
84 static void ext4_xattr_rehash(struct ext4_xattr_header *);
86 static const struct xattr_handler * const ext4_xattr_handler_map[] = {
87 [EXT4_XATTR_INDEX_USER] = &ext4_xattr_user_handler,
88 #ifdef CONFIG_EXT4_FS_POSIX_ACL
89 [EXT4_XATTR_INDEX_POSIX_ACL_ACCESS] = &posix_acl_access_xattr_handler,
90 [EXT4_XATTR_INDEX_POSIX_ACL_DEFAULT] = &posix_acl_default_xattr_handler,
92 [EXT4_XATTR_INDEX_TRUSTED] = &ext4_xattr_trusted_handler,
93 #ifdef CONFIG_EXT4_FS_SECURITY
94 [EXT4_XATTR_INDEX_SECURITY] = &ext4_xattr_security_handler,
96 [EXT4_XATTR_INDEX_HURD] = &ext4_xattr_hurd_handler,
99 const struct xattr_handler *ext4_xattr_handlers[] = {
100 &ext4_xattr_user_handler,
101 &ext4_xattr_trusted_handler,
102 #ifdef CONFIG_EXT4_FS_POSIX_ACL
103 &posix_acl_access_xattr_handler,
104 &posix_acl_default_xattr_handler,
106 #ifdef CONFIG_EXT4_FS_SECURITY
107 &ext4_xattr_security_handler,
109 &ext4_xattr_hurd_handler,
113 #define EA_BLOCK_CACHE(inode) (((struct ext4_sb_info *) \
114 inode->i_sb->s_fs_info)->s_ea_block_cache)
116 #define EA_INODE_CACHE(inode) (((struct ext4_sb_info *) \
117 inode->i_sb->s_fs_info)->s_ea_inode_cache)
120 ext4_expand_inode_array(struct ext4_xattr_inode_array **ea_inode_array,
121 struct inode *inode);
123 #ifdef CONFIG_LOCKDEP
124 void ext4_xattr_inode_set_class(struct inode *ea_inode)
126 lockdep_set_subclass(&ea_inode->i_rwsem, 1);
130 static __le32 ext4_xattr_block_csum(struct inode *inode,
132 struct ext4_xattr_header *hdr)
134 struct ext4_sb_info *sbi = EXT4_SB(inode->i_sb);
136 __le64 dsk_block_nr = cpu_to_le64(block_nr);
137 __u32 dummy_csum = 0;
138 int offset = offsetof(struct ext4_xattr_header, h_checksum);
140 csum = ext4_chksum(sbi, sbi->s_csum_seed, (__u8 *)&dsk_block_nr,
141 sizeof(dsk_block_nr));
142 csum = ext4_chksum(sbi, csum, (__u8 *)hdr, offset);
143 csum = ext4_chksum(sbi, csum, (__u8 *)&dummy_csum, sizeof(dummy_csum));
144 offset += sizeof(dummy_csum);
145 csum = ext4_chksum(sbi, csum, (__u8 *)hdr + offset,
146 EXT4_BLOCK_SIZE(inode->i_sb) - offset);
148 return cpu_to_le32(csum);
151 static int ext4_xattr_block_csum_verify(struct inode *inode,
152 struct buffer_head *bh)
154 struct ext4_xattr_header *hdr = BHDR(bh);
157 if (ext4_has_metadata_csum(inode->i_sb)) {
159 ret = (hdr->h_checksum == ext4_xattr_block_csum(inode,
160 bh->b_blocknr, hdr));
166 static void ext4_xattr_block_csum_set(struct inode *inode,
167 struct buffer_head *bh)
169 if (ext4_has_metadata_csum(inode->i_sb))
170 BHDR(bh)->h_checksum = ext4_xattr_block_csum(inode,
171 bh->b_blocknr, BHDR(bh));
174 static inline const struct xattr_handler *
175 ext4_xattr_handler(int name_index)
177 const struct xattr_handler *handler = NULL;
179 if (name_index > 0 && name_index < ARRAY_SIZE(ext4_xattr_handler_map))
180 handler = ext4_xattr_handler_map[name_index];
185 ext4_xattr_check_entries(struct ext4_xattr_entry *entry, void *end,
188 struct ext4_xattr_entry *e = entry;
190 /* Find the end of the names list */
191 while (!IS_LAST_ENTRY(e)) {
192 struct ext4_xattr_entry *next = EXT4_XATTR_NEXT(e);
193 if ((void *)next >= end)
194 return -EFSCORRUPTED;
195 if (strnlen(e->e_name, e->e_name_len) != e->e_name_len)
196 return -EFSCORRUPTED;
200 /* Check the values */
201 while (!IS_LAST_ENTRY(entry)) {
202 u32 size = le32_to_cpu(entry->e_value_size);
204 if (size > EXT4_XATTR_SIZE_MAX)
205 return -EFSCORRUPTED;
207 if (size != 0 && entry->e_value_inum == 0) {
208 u16 offs = le16_to_cpu(entry->e_value_offs);
212 * The value cannot overlap the names, and the value
213 * with padding cannot extend beyond 'end'. Check both
214 * the padded and unpadded sizes, since the size may
215 * overflow to 0 when adding padding.
217 if (offs > end - value_start)
218 return -EFSCORRUPTED;
219 value = value_start + offs;
220 if (value < (void *)e + sizeof(u32) ||
221 size > end - value ||
222 EXT4_XATTR_SIZE(size) > end - value)
223 return -EFSCORRUPTED;
225 entry = EXT4_XATTR_NEXT(entry);
232 __ext4_xattr_check_block(struct inode *inode, struct buffer_head *bh,
233 const char *function, unsigned int line)
235 int error = -EFSCORRUPTED;
237 if (BHDR(bh)->h_magic != cpu_to_le32(EXT4_XATTR_MAGIC) ||
238 BHDR(bh)->h_blocks != cpu_to_le32(1))
240 if (buffer_verified(bh))
244 if (!ext4_xattr_block_csum_verify(inode, bh))
246 error = ext4_xattr_check_entries(BFIRST(bh), bh->b_data + bh->b_size,
250 __ext4_error_inode(inode, function, line, 0, -error,
251 "corrupted xattr block %llu",
252 (unsigned long long) bh->b_blocknr);
254 set_buffer_verified(bh);
258 #define ext4_xattr_check_block(inode, bh) \
259 __ext4_xattr_check_block((inode), (bh), __func__, __LINE__)
263 __xattr_check_inode(struct inode *inode, struct ext4_xattr_ibody_header *header,
264 void *end, const char *function, unsigned int line)
266 int error = -EFSCORRUPTED;
268 if (end - (void *)header < sizeof(*header) + sizeof(u32) ||
269 (header->h_magic != cpu_to_le32(EXT4_XATTR_MAGIC)))
271 error = ext4_xattr_check_entries(IFIRST(header), end, IFIRST(header));
274 __ext4_error_inode(inode, function, line, 0, -error,
275 "corrupted in-inode xattr");
279 #define xattr_check_inode(inode, header, end) \
280 __xattr_check_inode((inode), (header), (end), __func__, __LINE__)
283 xattr_find_entry(struct inode *inode, struct ext4_xattr_entry **pentry,
284 void *end, int name_index, const char *name, int sorted)
286 struct ext4_xattr_entry *entry, *next;
292 name_len = strlen(name);
293 for (entry = *pentry; !IS_LAST_ENTRY(entry); entry = next) {
294 next = EXT4_XATTR_NEXT(entry);
295 if ((void *) next >= end) {
296 EXT4_ERROR_INODE(inode, "corrupted xattr entries");
297 return -EFSCORRUPTED;
299 cmp = name_index - entry->e_name_index;
301 cmp = name_len - entry->e_name_len;
303 cmp = memcmp(name, entry->e_name, name_len);
304 if (cmp <= 0 && (sorted || cmp == 0))
308 return cmp ? -ENODATA : 0;
312 ext4_xattr_inode_hash(struct ext4_sb_info *sbi, const void *buffer, size_t size)
314 return ext4_chksum(sbi, sbi->s_csum_seed, buffer, size);
317 static u64 ext4_xattr_inode_get_ref(struct inode *ea_inode)
319 return ((u64)ea_inode->i_ctime.tv_sec << 32) |
320 (u32) inode_peek_iversion_raw(ea_inode);
323 static void ext4_xattr_inode_set_ref(struct inode *ea_inode, u64 ref_count)
325 ea_inode->i_ctime.tv_sec = (u32)(ref_count >> 32);
326 inode_set_iversion_raw(ea_inode, ref_count & 0xffffffff);
329 static u32 ext4_xattr_inode_get_hash(struct inode *ea_inode)
331 return (u32)ea_inode->i_atime.tv_sec;
334 static void ext4_xattr_inode_set_hash(struct inode *ea_inode, u32 hash)
336 ea_inode->i_atime.tv_sec = hash;
340 * Read the EA value from an inode.
342 static int ext4_xattr_inode_read(struct inode *ea_inode, void *buf, size_t size)
344 int blocksize = 1 << ea_inode->i_blkbits;
345 int bh_count = (size + blocksize - 1) >> ea_inode->i_blkbits;
346 int tail_size = (size % blocksize) ?: blocksize;
347 struct buffer_head *bhs_inline[8];
348 struct buffer_head **bhs = bhs_inline;
351 if (bh_count > ARRAY_SIZE(bhs_inline)) {
352 bhs = kmalloc_array(bh_count, sizeof(*bhs), GFP_NOFS);
357 ret = ext4_bread_batch(ea_inode, 0 /* block */, bh_count,
358 true /* wait */, bhs);
362 for (i = 0; i < bh_count; i++) {
363 /* There shouldn't be any holes in ea_inode. */
368 memcpy((char *)buf + blocksize * i, bhs[i]->b_data,
369 i < bh_count - 1 ? blocksize : tail_size);
373 for (i = 0; i < bh_count; i++)
376 if (bhs != bhs_inline)
381 #define EXT4_XATTR_INODE_GET_PARENT(inode) ((__u32)(inode)->i_mtime.tv_sec)
383 static int ext4_xattr_inode_iget(struct inode *parent, unsigned long ea_ino,
384 u32 ea_inode_hash, struct inode **ea_inode)
389 inode = ext4_iget(parent->i_sb, ea_ino, EXT4_IGET_NORMAL);
391 err = PTR_ERR(inode);
392 ext4_error(parent->i_sb,
393 "error while reading EA inode %lu err=%d", ea_ino,
398 if (is_bad_inode(inode)) {
399 ext4_error(parent->i_sb,
400 "error while reading EA inode %lu is_bad_inode",
406 if (!(EXT4_I(inode)->i_flags & EXT4_EA_INODE_FL)) {
407 ext4_error(parent->i_sb,
408 "EA inode %lu does not have EXT4_EA_INODE_FL flag",
414 ext4_xattr_inode_set_class(inode);
417 * Check whether this is an old Lustre-style xattr inode. Lustre
418 * implementation does not have hash validation, rather it has a
419 * backpointer from ea_inode to the parent inode.
421 if (ea_inode_hash != ext4_xattr_inode_get_hash(inode) &&
422 EXT4_XATTR_INODE_GET_PARENT(inode) == parent->i_ino &&
423 inode->i_generation == parent->i_generation) {
424 ext4_set_inode_state(inode, EXT4_STATE_LUSTRE_EA_INODE);
425 ext4_xattr_inode_set_ref(inode, 1);
428 inode->i_flags |= S_NOQUOTA;
440 ext4_xattr_inode_verify_hashes(struct inode *ea_inode,
441 struct ext4_xattr_entry *entry, void *buffer,
446 /* Verify stored hash matches calculated hash. */
447 hash = ext4_xattr_inode_hash(EXT4_SB(ea_inode->i_sb), buffer, size);
448 if (hash != ext4_xattr_inode_get_hash(ea_inode))
449 return -EFSCORRUPTED;
452 __le32 e_hash, tmp_data;
454 /* Verify entry hash. */
455 tmp_data = cpu_to_le32(hash);
456 e_hash = ext4_xattr_hash_entry(entry->e_name, entry->e_name_len,
458 if (e_hash != entry->e_hash)
459 return -EFSCORRUPTED;
465 * Read xattr value from the EA inode.
468 ext4_xattr_inode_get(struct inode *inode, struct ext4_xattr_entry *entry,
469 void *buffer, size_t size)
471 struct mb_cache *ea_inode_cache = EA_INODE_CACHE(inode);
472 struct inode *ea_inode;
475 err = ext4_xattr_inode_iget(inode, le32_to_cpu(entry->e_value_inum),
476 le32_to_cpu(entry->e_hash), &ea_inode);
482 if (i_size_read(ea_inode) != size) {
483 ext4_warning_inode(ea_inode,
484 "ea_inode file size=%llu entry size=%zu",
485 i_size_read(ea_inode), size);
490 err = ext4_xattr_inode_read(ea_inode, buffer, size);
494 if (!ext4_test_inode_state(ea_inode, EXT4_STATE_LUSTRE_EA_INODE)) {
495 err = ext4_xattr_inode_verify_hashes(ea_inode, entry, buffer,
498 ext4_warning_inode(ea_inode,
499 "EA inode hash validation failed");
504 mb_cache_entry_create(ea_inode_cache, GFP_NOFS,
505 ext4_xattr_inode_get_hash(ea_inode),
506 ea_inode->i_ino, true /* reusable */);
514 ext4_xattr_block_get(struct inode *inode, int name_index, const char *name,
515 void *buffer, size_t buffer_size)
517 struct buffer_head *bh = NULL;
518 struct ext4_xattr_entry *entry;
522 struct mb_cache *ea_block_cache = EA_BLOCK_CACHE(inode);
524 ea_idebug(inode, "name=%d.%s, buffer=%p, buffer_size=%ld",
525 name_index, name, buffer, (long)buffer_size);
527 if (!EXT4_I(inode)->i_file_acl)
529 ea_idebug(inode, "reading block %llu",
530 (unsigned long long)EXT4_I(inode)->i_file_acl);
531 bh = ext4_sb_bread(inode->i_sb, EXT4_I(inode)->i_file_acl, REQ_PRIO);
534 ea_bdebug(bh, "b_count=%d, refcount=%d",
535 atomic_read(&(bh->b_count)), le32_to_cpu(BHDR(bh)->h_refcount));
536 error = ext4_xattr_check_block(inode, bh);
539 ext4_xattr_block_cache_insert(ea_block_cache, bh);
541 end = bh->b_data + bh->b_size;
542 error = xattr_find_entry(inode, &entry, end, name_index, name, 1);
545 size = le32_to_cpu(entry->e_value_size);
547 if (unlikely(size > EXT4_XATTR_SIZE_MAX))
550 if (size > buffer_size)
552 if (entry->e_value_inum) {
553 error = ext4_xattr_inode_get(inode, entry, buffer,
558 u16 offset = le16_to_cpu(entry->e_value_offs);
559 void *p = bh->b_data + offset;
561 if (unlikely(p + size > end))
563 memcpy(buffer, p, size);
574 ext4_xattr_ibody_get(struct inode *inode, int name_index, const char *name,
575 void *buffer, size_t buffer_size)
577 struct ext4_xattr_ibody_header *header;
578 struct ext4_xattr_entry *entry;
579 struct ext4_inode *raw_inode;
580 struct ext4_iloc iloc;
585 if (!ext4_test_inode_state(inode, EXT4_STATE_XATTR))
587 error = ext4_get_inode_loc(inode, &iloc);
590 raw_inode = ext4_raw_inode(&iloc);
591 header = IHDR(inode, raw_inode);
592 end = (void *)raw_inode + EXT4_SB(inode->i_sb)->s_inode_size;
593 error = xattr_check_inode(inode, header, end);
596 entry = IFIRST(header);
597 error = xattr_find_entry(inode, &entry, end, name_index, name, 0);
600 size = le32_to_cpu(entry->e_value_size);
602 if (unlikely(size > EXT4_XATTR_SIZE_MAX))
605 if (size > buffer_size)
607 if (entry->e_value_inum) {
608 error = ext4_xattr_inode_get(inode, entry, buffer,
613 u16 offset = le16_to_cpu(entry->e_value_offs);
614 void *p = (void *)IFIRST(header) + offset;
616 if (unlikely(p + size > end))
618 memcpy(buffer, p, size);
631 * Copy an extended attribute into the buffer
632 * provided, or compute the buffer size required.
633 * Buffer is NULL to compute the size of the buffer required.
635 * Returns a negative error number on failure, or the number of bytes
636 * used / required on success.
639 ext4_xattr_get(struct inode *inode, int name_index, const char *name,
640 void *buffer, size_t buffer_size)
644 if (unlikely(ext4_forced_shutdown(EXT4_SB(inode->i_sb))))
647 if (strlen(name) > 255)
650 down_read(&EXT4_I(inode)->xattr_sem);
651 error = ext4_xattr_ibody_get(inode, name_index, name, buffer,
653 if (error == -ENODATA)
654 error = ext4_xattr_block_get(inode, name_index, name, buffer,
656 up_read(&EXT4_I(inode)->xattr_sem);
661 ext4_xattr_list_entries(struct dentry *dentry, struct ext4_xattr_entry *entry,
662 char *buffer, size_t buffer_size)
664 size_t rest = buffer_size;
666 for (; !IS_LAST_ENTRY(entry); entry = EXT4_XATTR_NEXT(entry)) {
667 const struct xattr_handler *handler =
668 ext4_xattr_handler(entry->e_name_index);
670 if (handler && (!handler->list || handler->list(dentry))) {
671 const char *prefix = handler->prefix ?: handler->name;
672 size_t prefix_len = strlen(prefix);
673 size_t size = prefix_len + entry->e_name_len + 1;
678 memcpy(buffer, prefix, prefix_len);
679 buffer += prefix_len;
680 memcpy(buffer, entry->e_name, entry->e_name_len);
681 buffer += entry->e_name_len;
687 return buffer_size - rest; /* total size */
691 ext4_xattr_block_list(struct dentry *dentry, char *buffer, size_t buffer_size)
693 struct inode *inode = d_inode(dentry);
694 struct buffer_head *bh = NULL;
697 ea_idebug(inode, "buffer=%p, buffer_size=%ld",
698 buffer, (long)buffer_size);
700 if (!EXT4_I(inode)->i_file_acl)
702 ea_idebug(inode, "reading block %llu",
703 (unsigned long long)EXT4_I(inode)->i_file_acl);
704 bh = ext4_sb_bread(inode->i_sb, EXT4_I(inode)->i_file_acl, REQ_PRIO);
707 ea_bdebug(bh, "b_count=%d, refcount=%d",
708 atomic_read(&(bh->b_count)), le32_to_cpu(BHDR(bh)->h_refcount));
709 error = ext4_xattr_check_block(inode, bh);
712 ext4_xattr_block_cache_insert(EA_BLOCK_CACHE(inode), bh);
713 error = ext4_xattr_list_entries(dentry, BFIRST(bh), buffer,
721 ext4_xattr_ibody_list(struct dentry *dentry, char *buffer, size_t buffer_size)
723 struct inode *inode = d_inode(dentry);
724 struct ext4_xattr_ibody_header *header;
725 struct ext4_inode *raw_inode;
726 struct ext4_iloc iloc;
730 if (!ext4_test_inode_state(inode, EXT4_STATE_XATTR))
732 error = ext4_get_inode_loc(inode, &iloc);
735 raw_inode = ext4_raw_inode(&iloc);
736 header = IHDR(inode, raw_inode);
737 end = (void *)raw_inode + EXT4_SB(inode->i_sb)->s_inode_size;
738 error = xattr_check_inode(inode, header, end);
741 error = ext4_xattr_list_entries(dentry, IFIRST(header),
742 buffer, buffer_size);
750 * Inode operation listxattr()
752 * d_inode(dentry)->i_rwsem: don't care
754 * Copy a list of attribute names into the buffer
755 * provided, or compute the buffer size required.
756 * Buffer is NULL to compute the size of the buffer required.
758 * Returns a negative error number on failure, or the number of bytes
759 * used / required on success.
762 ext4_listxattr(struct dentry *dentry, char *buffer, size_t buffer_size)
766 down_read(&EXT4_I(d_inode(dentry))->xattr_sem);
767 ret = ret2 = ext4_xattr_ibody_list(dentry, buffer, buffer_size);
774 ret = ext4_xattr_block_list(dentry, buffer, buffer_size);
779 up_read(&EXT4_I(d_inode(dentry))->xattr_sem);
784 * If the EXT4_FEATURE_COMPAT_EXT_ATTR feature of this file system is
787 static void ext4_xattr_update_super_block(handle_t *handle,
788 struct super_block *sb)
790 if (ext4_has_feature_xattr(sb))
793 BUFFER_TRACE(EXT4_SB(sb)->s_sbh, "get_write_access");
794 if (ext4_journal_get_write_access(handle, EXT4_SB(sb)->s_sbh) == 0) {
795 lock_buffer(EXT4_SB(sb)->s_sbh);
796 ext4_set_feature_xattr(sb);
797 ext4_superblock_csum_set(sb);
798 unlock_buffer(EXT4_SB(sb)->s_sbh);
799 ext4_handle_dirty_metadata(handle, NULL, EXT4_SB(sb)->s_sbh);
803 int ext4_get_inode_usage(struct inode *inode, qsize_t *usage)
805 struct ext4_iloc iloc = { .bh = NULL };
806 struct buffer_head *bh = NULL;
807 struct ext4_inode *raw_inode;
808 struct ext4_xattr_ibody_header *header;
809 struct ext4_xattr_entry *entry;
810 qsize_t ea_inode_refs = 0;
814 lockdep_assert_held_read(&EXT4_I(inode)->xattr_sem);
816 if (ext4_test_inode_state(inode, EXT4_STATE_XATTR)) {
817 ret = ext4_get_inode_loc(inode, &iloc);
820 raw_inode = ext4_raw_inode(&iloc);
821 header = IHDR(inode, raw_inode);
822 end = (void *)raw_inode + EXT4_SB(inode->i_sb)->s_inode_size;
823 ret = xattr_check_inode(inode, header, end);
827 for (entry = IFIRST(header); !IS_LAST_ENTRY(entry);
828 entry = EXT4_XATTR_NEXT(entry))
829 if (entry->e_value_inum)
833 if (EXT4_I(inode)->i_file_acl) {
834 bh = ext4_sb_bread(inode->i_sb, EXT4_I(inode)->i_file_acl, REQ_PRIO);
841 ret = ext4_xattr_check_block(inode, bh);
845 for (entry = BFIRST(bh); !IS_LAST_ENTRY(entry);
846 entry = EXT4_XATTR_NEXT(entry))
847 if (entry->e_value_inum)
850 *usage = ea_inode_refs + 1;
858 static inline size_t round_up_cluster(struct inode *inode, size_t length)
860 struct super_block *sb = inode->i_sb;
861 size_t cluster_size = 1 << (EXT4_SB(sb)->s_cluster_bits +
863 size_t mask = ~(cluster_size - 1);
865 return (length + cluster_size - 1) & mask;
868 static int ext4_xattr_inode_alloc_quota(struct inode *inode, size_t len)
872 err = dquot_alloc_inode(inode);
875 err = dquot_alloc_space_nodirty(inode, round_up_cluster(inode, len));
877 dquot_free_inode(inode);
881 static void ext4_xattr_inode_free_quota(struct inode *parent,
882 struct inode *ea_inode,
886 ext4_test_inode_state(ea_inode, EXT4_STATE_LUSTRE_EA_INODE))
888 dquot_free_space_nodirty(parent, round_up_cluster(parent, len));
889 dquot_free_inode(parent);
892 int __ext4_xattr_set_credits(struct super_block *sb, struct inode *inode,
893 struct buffer_head *block_bh, size_t value_len,
900 * 1) Owner inode update
901 * 2) Ref count update on old xattr block
903 * 4) block bitmap update for new xattr block
904 * 5) group descriptor for new xattr block
905 * 6) block bitmap update for old xattr block
906 * 7) group descriptor for old block
908 * 6 & 7 can happen if we have two racing threads T_a and T_b
909 * which are each trying to set an xattr on inodes I_a and I_b
910 * which were both initially sharing an xattr block.
915 credits += EXT4_MAXQUOTAS_TRANS_BLOCKS(sb);
918 * In case of inline data, we may push out the data to a block,
919 * so we need to reserve credits for this eventuality
921 if (inode && ext4_has_inline_data(inode))
922 credits += ext4_writepage_trans_blocks(inode) + 1;
924 /* We are done if ea_inode feature is not enabled. */
925 if (!ext4_has_feature_ea_inode(sb))
928 /* New ea_inode, inode map, block bitmap, group descriptor. */
932 blocks = (value_len + sb->s_blocksize - 1) >> sb->s_blocksize_bits;
934 /* Indirection block or one level of extent tree. */
937 /* Block bitmap and group descriptor updates for each block. */
938 credits += blocks * 2;
940 /* Blocks themselves. */
944 /* Dereference ea_inode holding old xattr value.
945 * Old ea_inode, inode map, block bitmap, group descriptor.
949 /* Data blocks for old ea_inode. */
950 blocks = XATTR_SIZE_MAX >> sb->s_blocksize_bits;
952 /* Indirection block or one level of extent tree for old
957 /* Block bitmap and group descriptor updates for each block. */
958 credits += blocks * 2;
961 /* We may need to clone the existing xattr block in which case we need
962 * to increment ref counts for existing ea_inodes referenced by it.
965 struct ext4_xattr_entry *entry = BFIRST(block_bh);
967 for (; !IS_LAST_ENTRY(entry); entry = EXT4_XATTR_NEXT(entry))
968 if (entry->e_value_inum)
969 /* Ref count update on ea_inode. */
975 static int ext4_xattr_inode_update_ref(handle_t *handle, struct inode *ea_inode,
978 struct mb_cache *ea_inode_cache = EA_INODE_CACHE(ea_inode);
979 struct ext4_iloc iloc;
984 inode_lock(ea_inode);
986 ret = ext4_reserve_inode_write(handle, ea_inode, &iloc);
990 ref_count = ext4_xattr_inode_get_ref(ea_inode);
991 ref_count += ref_change;
992 ext4_xattr_inode_set_ref(ea_inode, ref_count);
994 if (ref_change > 0) {
995 WARN_ONCE(ref_count <= 0, "EA inode %lu ref_count=%lld",
996 ea_inode->i_ino, ref_count);
998 if (ref_count == 1) {
999 WARN_ONCE(ea_inode->i_nlink, "EA inode %lu i_nlink=%u",
1000 ea_inode->i_ino, ea_inode->i_nlink);
1002 set_nlink(ea_inode, 1);
1003 ext4_orphan_del(handle, ea_inode);
1005 if (ea_inode_cache) {
1006 hash = ext4_xattr_inode_get_hash(ea_inode);
1007 mb_cache_entry_create(ea_inode_cache,
1010 true /* reusable */);
1014 WARN_ONCE(ref_count < 0, "EA inode %lu ref_count=%lld",
1015 ea_inode->i_ino, ref_count);
1017 if (ref_count == 0) {
1018 WARN_ONCE(ea_inode->i_nlink != 1,
1019 "EA inode %lu i_nlink=%u",
1020 ea_inode->i_ino, ea_inode->i_nlink);
1022 clear_nlink(ea_inode);
1023 ext4_orphan_add(handle, ea_inode);
1025 if (ea_inode_cache) {
1026 hash = ext4_xattr_inode_get_hash(ea_inode);
1027 mb_cache_entry_delete(ea_inode_cache, hash,
1033 ret = ext4_mark_iloc_dirty(handle, ea_inode, &iloc);
1035 ext4_warning_inode(ea_inode,
1036 "ext4_mark_iloc_dirty() failed ret=%d", ret);
1038 inode_unlock(ea_inode);
1042 static int ext4_xattr_inode_inc_ref(handle_t *handle, struct inode *ea_inode)
1044 return ext4_xattr_inode_update_ref(handle, ea_inode, 1);
1047 static int ext4_xattr_inode_dec_ref(handle_t *handle, struct inode *ea_inode)
1049 return ext4_xattr_inode_update_ref(handle, ea_inode, -1);
1052 static int ext4_xattr_inode_inc_ref_all(handle_t *handle, struct inode *parent,
1053 struct ext4_xattr_entry *first)
1055 struct inode *ea_inode;
1056 struct ext4_xattr_entry *entry;
1057 struct ext4_xattr_entry *failed_entry;
1058 unsigned int ea_ino;
1061 for (entry = first; !IS_LAST_ENTRY(entry);
1062 entry = EXT4_XATTR_NEXT(entry)) {
1063 if (!entry->e_value_inum)
1065 ea_ino = le32_to_cpu(entry->e_value_inum);
1066 err = ext4_xattr_inode_iget(parent, ea_ino,
1067 le32_to_cpu(entry->e_hash),
1071 err = ext4_xattr_inode_inc_ref(handle, ea_inode);
1073 ext4_warning_inode(ea_inode, "inc ref error %d", err);
1083 failed_entry = entry;
1085 for (entry = first; entry != failed_entry;
1086 entry = EXT4_XATTR_NEXT(entry)) {
1087 if (!entry->e_value_inum)
1089 ea_ino = le32_to_cpu(entry->e_value_inum);
1090 err = ext4_xattr_inode_iget(parent, ea_ino,
1091 le32_to_cpu(entry->e_hash),
1094 ext4_warning(parent->i_sb,
1095 "cleanup ea_ino %u iget error %d", ea_ino,
1099 err = ext4_xattr_inode_dec_ref(handle, ea_inode);
1101 ext4_warning_inode(ea_inode, "cleanup dec ref error %d",
1108 static int ext4_xattr_restart_fn(handle_t *handle, struct inode *inode,
1109 struct buffer_head *bh, bool block_csum, bool dirty)
1115 ext4_xattr_block_csum_set(inode, bh);
1116 error = ext4_handle_dirty_metadata(handle, NULL, bh);
1118 ext4_warning(inode->i_sb, "Handle metadata (error %d)",
1127 ext4_xattr_inode_dec_ref_all(handle_t *handle, struct inode *parent,
1128 struct buffer_head *bh,
1129 struct ext4_xattr_entry *first, bool block_csum,
1130 struct ext4_xattr_inode_array **ea_inode_array,
1131 int extra_credits, bool skip_quota)
1133 struct inode *ea_inode;
1134 struct ext4_xattr_entry *entry;
1136 unsigned int ea_ino;
1140 /* One credit for dec ref on ea_inode, one for orphan list addition, */
1141 credits = 2 + extra_credits;
1143 for (entry = first; !IS_LAST_ENTRY(entry);
1144 entry = EXT4_XATTR_NEXT(entry)) {
1145 if (!entry->e_value_inum)
1147 ea_ino = le32_to_cpu(entry->e_value_inum);
1148 err = ext4_xattr_inode_iget(parent, ea_ino,
1149 le32_to_cpu(entry->e_hash),
1154 err = ext4_expand_inode_array(ea_inode_array, ea_inode);
1156 ext4_warning_inode(ea_inode,
1157 "Expand inode array err=%d", err);
1162 err = ext4_journal_ensure_credits_fn(handle, credits, credits,
1163 ext4_free_metadata_revoke_credits(parent->i_sb, 1),
1164 ext4_xattr_restart_fn(handle, parent, bh, block_csum,
1167 ext4_warning_inode(ea_inode, "Ensure credits err=%d",
1172 err = ext4_journal_get_write_access(handle, bh);
1174 ext4_warning_inode(ea_inode,
1175 "Re-get write access err=%d",
1181 err = ext4_xattr_inode_dec_ref(handle, ea_inode);
1183 ext4_warning_inode(ea_inode, "ea_inode dec ref err=%d",
1189 ext4_xattr_inode_free_quota(parent, ea_inode,
1190 le32_to_cpu(entry->e_value_size));
1193 * Forget about ea_inode within the same transaction that
1194 * decrements the ref count. This avoids duplicate decrements in
1195 * case the rest of the work spills over to subsequent
1198 entry->e_value_inum = 0;
1199 entry->e_value_size = 0;
1206 * Note that we are deliberately skipping csum calculation for
1207 * the final update because we do not expect any journal
1208 * restarts until xattr block is freed.
1211 err = ext4_handle_dirty_metadata(handle, NULL, bh);
1213 ext4_warning_inode(parent,
1214 "handle dirty metadata err=%d", err);
1219 * Release the xattr block BH: If the reference count is > 1, decrement it;
1220 * otherwise free the block.
1223 ext4_xattr_release_block(handle_t *handle, struct inode *inode,
1224 struct buffer_head *bh,
1225 struct ext4_xattr_inode_array **ea_inode_array,
1228 struct mb_cache *ea_block_cache = EA_BLOCK_CACHE(inode);
1232 BUFFER_TRACE(bh, "get_write_access");
1233 error = ext4_journal_get_write_access(handle, bh);
1238 hash = le32_to_cpu(BHDR(bh)->h_hash);
1239 ref = le32_to_cpu(BHDR(bh)->h_refcount);
1241 ea_bdebug(bh, "refcount now=0; freeing");
1243 * This must happen under buffer lock for
1244 * ext4_xattr_block_set() to reliably detect freed block
1247 mb_cache_entry_delete(ea_block_cache, hash,
1252 if (ext4_has_feature_ea_inode(inode->i_sb))
1253 ext4_xattr_inode_dec_ref_all(handle, inode, bh,
1255 true /* block_csum */,
1258 true /* skip_quota */);
1259 ext4_free_blocks(handle, inode, bh, 0, 1,
1260 EXT4_FREE_BLOCKS_METADATA |
1261 EXT4_FREE_BLOCKS_FORGET);
1264 BHDR(bh)->h_refcount = cpu_to_le32(ref);
1265 if (ref == EXT4_XATTR_REFCOUNT_MAX - 1) {
1266 struct mb_cache_entry *ce;
1268 if (ea_block_cache) {
1269 ce = mb_cache_entry_get(ea_block_cache, hash,
1273 mb_cache_entry_put(ea_block_cache, ce);
1278 ext4_xattr_block_csum_set(inode, bh);
1280 * Beware of this ugliness: Releasing of xattr block references
1281 * from different inodes can race and so we have to protect
1282 * from a race where someone else frees the block (and releases
1283 * its journal_head) before we are done dirtying the buffer. In
1284 * nojournal mode this race is harmless and we actually cannot
1285 * call ext4_handle_dirty_metadata() with locked buffer as
1286 * that function can call sync_dirty_buffer() so for that case
1287 * we handle the dirtying after unlocking the buffer.
1289 if (ext4_handle_valid(handle))
1290 error = ext4_handle_dirty_metadata(handle, inode, bh);
1292 if (!ext4_handle_valid(handle))
1293 error = ext4_handle_dirty_metadata(handle, inode, bh);
1295 ext4_handle_sync(handle);
1296 dquot_free_block(inode, EXT4_C2B(EXT4_SB(inode->i_sb), 1));
1297 ea_bdebug(bh, "refcount now=%d; releasing",
1298 le32_to_cpu(BHDR(bh)->h_refcount));
1301 ext4_std_error(inode->i_sb, error);
1306 * Find the available free space for EAs. This also returns the total number of
1307 * bytes used by EA entries.
1309 static size_t ext4_xattr_free_space(struct ext4_xattr_entry *last,
1310 size_t *min_offs, void *base, int *total)
1312 for (; !IS_LAST_ENTRY(last); last = EXT4_XATTR_NEXT(last)) {
1313 if (!last->e_value_inum && last->e_value_size) {
1314 size_t offs = le16_to_cpu(last->e_value_offs);
1315 if (offs < *min_offs)
1319 *total += EXT4_XATTR_LEN(last->e_name_len);
1321 return (*min_offs - ((void *)last - base) - sizeof(__u32));
1325 * Write the value of the EA in an inode.
1327 static int ext4_xattr_inode_write(handle_t *handle, struct inode *ea_inode,
1328 const void *buf, int bufsize)
1330 struct buffer_head *bh = NULL;
1331 unsigned long block = 0;
1332 int blocksize = ea_inode->i_sb->s_blocksize;
1333 int max_blocks = (bufsize + blocksize - 1) >> ea_inode->i_blkbits;
1334 int csize, wsize = 0;
1335 int ret = 0, ret2 = 0;
1339 while (ret >= 0 && ret < max_blocks) {
1340 struct ext4_map_blocks map;
1341 map.m_lblk = block += ret;
1342 map.m_len = max_blocks -= ret;
1344 ret = ext4_map_blocks(handle, ea_inode, &map,
1345 EXT4_GET_BLOCKS_CREATE);
1347 ext4_mark_inode_dirty(handle, ea_inode);
1348 if (ret == -ENOSPC &&
1349 ext4_should_retry_alloc(ea_inode->i_sb, &retries)) {
1361 while (wsize < bufsize) {
1363 csize = (bufsize - wsize) > blocksize ? blocksize :
1365 bh = ext4_getblk(handle, ea_inode, block, 0);
1370 EXT4_ERROR_INODE(ea_inode,
1371 "ext4_getblk() return bh = NULL");
1372 return -EFSCORRUPTED;
1374 ret = ext4_journal_get_write_access(handle, bh);
1378 memcpy(bh->b_data, buf, csize);
1379 set_buffer_uptodate(bh);
1380 ext4_handle_dirty_metadata(handle, ea_inode, bh);
1387 inode_lock(ea_inode);
1388 i_size_write(ea_inode, wsize);
1389 ext4_update_i_disksize(ea_inode, wsize);
1390 inode_unlock(ea_inode);
1392 ret2 = ext4_mark_inode_dirty(handle, ea_inode);
1393 if (unlikely(ret2 && !ret))
1403 * Create an inode to store the value of a large EA.
1405 static struct inode *ext4_xattr_inode_create(handle_t *handle,
1406 struct inode *inode, u32 hash)
1408 struct inode *ea_inode = NULL;
1409 uid_t owner[2] = { i_uid_read(inode), i_gid_read(inode) };
1413 * Let the next inode be the goal, so we try and allocate the EA inode
1414 * in the same group, or nearby one.
1416 ea_inode = ext4_new_inode(handle, inode->i_sb->s_root->d_inode,
1417 S_IFREG | 0600, NULL, inode->i_ino + 1, owner,
1419 if (!IS_ERR(ea_inode)) {
1420 ea_inode->i_op = &ext4_file_inode_operations;
1421 ea_inode->i_fop = &ext4_file_operations;
1422 ext4_set_aops(ea_inode);
1423 ext4_xattr_inode_set_class(ea_inode);
1424 unlock_new_inode(ea_inode);
1425 ext4_xattr_inode_set_ref(ea_inode, 1);
1426 ext4_xattr_inode_set_hash(ea_inode, hash);
1427 err = ext4_mark_inode_dirty(handle, ea_inode);
1429 err = ext4_inode_attach_jinode(ea_inode);
1432 return ERR_PTR(err);
1436 * Xattr inodes are shared therefore quota charging is performed
1437 * at a higher level.
1439 dquot_free_inode(ea_inode);
1440 dquot_drop(ea_inode);
1441 inode_lock(ea_inode);
1442 ea_inode->i_flags |= S_NOQUOTA;
1443 inode_unlock(ea_inode);
1449 static struct inode *
1450 ext4_xattr_inode_cache_find(struct inode *inode, const void *value,
1451 size_t value_len, u32 hash)
1453 struct inode *ea_inode;
1454 struct mb_cache_entry *ce;
1455 struct mb_cache *ea_inode_cache = EA_INODE_CACHE(inode);
1458 if (!ea_inode_cache)
1461 ce = mb_cache_entry_find_first(ea_inode_cache, hash);
1465 ea_data = kvmalloc(value_len, GFP_KERNEL);
1467 mb_cache_entry_put(ea_inode_cache, ce);
1472 ea_inode = ext4_iget(inode->i_sb, ce->e_value,
1474 if (!IS_ERR(ea_inode) &&
1475 !is_bad_inode(ea_inode) &&
1476 (EXT4_I(ea_inode)->i_flags & EXT4_EA_INODE_FL) &&
1477 i_size_read(ea_inode) == value_len &&
1478 !ext4_xattr_inode_read(ea_inode, ea_data, value_len) &&
1479 !ext4_xattr_inode_verify_hashes(ea_inode, NULL, ea_data,
1481 !memcmp(value, ea_data, value_len)) {
1482 mb_cache_entry_touch(ea_inode_cache, ce);
1483 mb_cache_entry_put(ea_inode_cache, ce);
1488 if (!IS_ERR(ea_inode))
1490 ce = mb_cache_entry_find_next(ea_inode_cache, ce);
1497 * Add value of the EA in an inode.
1499 static int ext4_xattr_inode_lookup_create(handle_t *handle, struct inode *inode,
1500 const void *value, size_t value_len,
1501 struct inode **ret_inode)
1503 struct inode *ea_inode;
1507 hash = ext4_xattr_inode_hash(EXT4_SB(inode->i_sb), value, value_len);
1508 ea_inode = ext4_xattr_inode_cache_find(inode, value, value_len, hash);
1510 err = ext4_xattr_inode_inc_ref(handle, ea_inode);
1516 *ret_inode = ea_inode;
1520 /* Create an inode for the EA value */
1521 ea_inode = ext4_xattr_inode_create(handle, inode, hash);
1522 if (IS_ERR(ea_inode))
1523 return PTR_ERR(ea_inode);
1525 err = ext4_xattr_inode_write(handle, ea_inode, value, value_len);
1527 ext4_xattr_inode_dec_ref(handle, ea_inode);
1532 if (EA_INODE_CACHE(inode))
1533 mb_cache_entry_create(EA_INODE_CACHE(inode), GFP_NOFS, hash,
1534 ea_inode->i_ino, true /* reusable */);
1536 *ret_inode = ea_inode;
1541 * Reserve min(block_size/8, 1024) bytes for xattr entries/names if ea_inode
1542 * feature is enabled.
1544 #define EXT4_XATTR_BLOCK_RESERVE(inode) min(i_blocksize(inode)/8, 1024U)
1546 static int ext4_xattr_set_entry(struct ext4_xattr_info *i,
1547 struct ext4_xattr_search *s,
1548 handle_t *handle, struct inode *inode,
1551 struct ext4_xattr_entry *last, *next;
1552 struct ext4_xattr_entry *here = s->here;
1553 size_t min_offs = s->end - s->base, name_len = strlen(i->name);
1554 int in_inode = i->in_inode;
1555 struct inode *old_ea_inode = NULL;
1556 struct inode *new_ea_inode = NULL;
1557 size_t old_size, new_size;
1560 /* Space used by old and new values. */
1561 old_size = (!s->not_found && !here->e_value_inum) ?
1562 EXT4_XATTR_SIZE(le32_to_cpu(here->e_value_size)) : 0;
1563 new_size = (i->value && !in_inode) ? EXT4_XATTR_SIZE(i->value_len) : 0;
1566 * Optimization for the simple case when old and new values have the
1567 * same padded sizes. Not applicable if external inodes are involved.
1569 if (new_size && new_size == old_size) {
1570 size_t offs = le16_to_cpu(here->e_value_offs);
1571 void *val = s->base + offs;
1573 here->e_value_size = cpu_to_le32(i->value_len);
1574 if (i->value == EXT4_ZERO_XATTR_VALUE) {
1575 memset(val, 0, new_size);
1577 memcpy(val, i->value, i->value_len);
1578 /* Clear padding bytes. */
1579 memset(val + i->value_len, 0, new_size - i->value_len);
1584 /* Compute min_offs and last. */
1586 for (; !IS_LAST_ENTRY(last); last = next) {
1587 next = EXT4_XATTR_NEXT(last);
1588 if ((void *)next >= s->end) {
1589 EXT4_ERROR_INODE(inode, "corrupted xattr entries");
1590 ret = -EFSCORRUPTED;
1593 if (!last->e_value_inum && last->e_value_size) {
1594 size_t offs = le16_to_cpu(last->e_value_offs);
1595 if (offs < min_offs)
1600 /* Check whether we have enough space. */
1604 free = min_offs - ((void *)last - s->base) - sizeof(__u32);
1606 free += EXT4_XATTR_LEN(name_len) + old_size;
1608 if (free < EXT4_XATTR_LEN(name_len) + new_size) {
1614 * If storing the value in an external inode is an option,
1615 * reserve space for xattr entries/names in the external
1616 * attribute block so that a long value does not occupy the
1617 * whole space and prevent futher entries being added.
1619 if (ext4_has_feature_ea_inode(inode->i_sb) &&
1620 new_size && is_block &&
1621 (min_offs + old_size - new_size) <
1622 EXT4_XATTR_BLOCK_RESERVE(inode)) {
1629 * Getting access to old and new ea inodes is subject to failures.
1630 * Finish that work before doing any modifications to the xattr data.
1632 if (!s->not_found && here->e_value_inum) {
1633 ret = ext4_xattr_inode_iget(inode,
1634 le32_to_cpu(here->e_value_inum),
1635 le32_to_cpu(here->e_hash),
1638 old_ea_inode = NULL;
1642 if (i->value && in_inode) {
1643 WARN_ON_ONCE(!i->value_len);
1645 ret = ext4_xattr_inode_alloc_quota(inode, i->value_len);
1649 ret = ext4_xattr_inode_lookup_create(handle, inode, i->value,
1653 new_ea_inode = NULL;
1654 ext4_xattr_inode_free_quota(inode, NULL, i->value_len);
1660 /* We are ready to release ref count on the old_ea_inode. */
1661 ret = ext4_xattr_inode_dec_ref(handle, old_ea_inode);
1663 /* Release newly required ref count on new_ea_inode. */
1667 err = ext4_xattr_inode_dec_ref(handle,
1670 ext4_warning_inode(new_ea_inode,
1671 "dec ref new_ea_inode err=%d",
1673 ext4_xattr_inode_free_quota(inode, new_ea_inode,
1679 ext4_xattr_inode_free_quota(inode, old_ea_inode,
1680 le32_to_cpu(here->e_value_size));
1683 /* No failures allowed past this point. */
1685 if (!s->not_found && here->e_value_size && !here->e_value_inum) {
1686 /* Remove the old value. */
1687 void *first_val = s->base + min_offs;
1688 size_t offs = le16_to_cpu(here->e_value_offs);
1689 void *val = s->base + offs;
1691 memmove(first_val + old_size, first_val, val - first_val);
1692 memset(first_val, 0, old_size);
1693 min_offs += old_size;
1695 /* Adjust all value offsets. */
1697 while (!IS_LAST_ENTRY(last)) {
1698 size_t o = le16_to_cpu(last->e_value_offs);
1700 if (!last->e_value_inum &&
1701 last->e_value_size && o < offs)
1702 last->e_value_offs = cpu_to_le16(o + old_size);
1703 last = EXT4_XATTR_NEXT(last);
1708 /* Remove old name. */
1709 size_t size = EXT4_XATTR_LEN(name_len);
1711 last = ENTRY((void *)last - size);
1712 memmove(here, (void *)here + size,
1713 (void *)last - (void *)here + sizeof(__u32));
1714 memset(last, 0, size);
1715 } else if (s->not_found) {
1716 /* Insert new name. */
1717 size_t size = EXT4_XATTR_LEN(name_len);
1718 size_t rest = (void *)last - (void *)here + sizeof(__u32);
1720 memmove((void *)here + size, here, rest);
1721 memset(here, 0, size);
1722 here->e_name_index = i->name_index;
1723 here->e_name_len = name_len;
1724 memcpy(here->e_name, i->name, name_len);
1726 /* This is an update, reset value info. */
1727 here->e_value_inum = 0;
1728 here->e_value_offs = 0;
1729 here->e_value_size = 0;
1733 /* Insert new value. */
1735 here->e_value_inum = cpu_to_le32(new_ea_inode->i_ino);
1736 } else if (i->value_len) {
1737 void *val = s->base + min_offs - new_size;
1739 here->e_value_offs = cpu_to_le16(min_offs - new_size);
1740 if (i->value == EXT4_ZERO_XATTR_VALUE) {
1741 memset(val, 0, new_size);
1743 memcpy(val, i->value, i->value_len);
1744 /* Clear padding bytes. */
1745 memset(val + i->value_len, 0,
1746 new_size - i->value_len);
1749 here->e_value_size = cpu_to_le32(i->value_len);
1756 /* Entry hash calculation. */
1761 * Feed crc32c hash instead of the raw value for entry
1762 * hash calculation. This is to avoid walking
1763 * potentially long value buffer again.
1765 crc32c_hash = cpu_to_le32(
1766 ext4_xattr_inode_get_hash(new_ea_inode));
1767 hash = ext4_xattr_hash_entry(here->e_name,
1770 } else if (is_block) {
1771 __le32 *value = s->base + le16_to_cpu(
1772 here->e_value_offs);
1774 hash = ext4_xattr_hash_entry(here->e_name,
1775 here->e_name_len, value,
1778 here->e_hash = hash;
1782 ext4_xattr_rehash((struct ext4_xattr_header *)s->base);
1791 struct ext4_xattr_block_find {
1792 struct ext4_xattr_search s;
1793 struct buffer_head *bh;
1797 ext4_xattr_block_find(struct inode *inode, struct ext4_xattr_info *i,
1798 struct ext4_xattr_block_find *bs)
1800 struct super_block *sb = inode->i_sb;
1803 ea_idebug(inode, "name=%d.%s, value=%p, value_len=%ld",
1804 i->name_index, i->name, i->value, (long)i->value_len);
1806 if (EXT4_I(inode)->i_file_acl) {
1807 /* The inode already has an extended attribute block. */
1808 bs->bh = ext4_sb_bread(sb, EXT4_I(inode)->i_file_acl, REQ_PRIO);
1809 if (IS_ERR(bs->bh)) {
1810 error = PTR_ERR(bs->bh);
1814 ea_bdebug(bs->bh, "b_count=%d, refcount=%d",
1815 atomic_read(&(bs->bh->b_count)),
1816 le32_to_cpu(BHDR(bs->bh)->h_refcount));
1817 error = ext4_xattr_check_block(inode, bs->bh);
1820 /* Find the named attribute. */
1821 bs->s.base = BHDR(bs->bh);
1822 bs->s.first = BFIRST(bs->bh);
1823 bs->s.end = bs->bh->b_data + bs->bh->b_size;
1824 bs->s.here = bs->s.first;
1825 error = xattr_find_entry(inode, &bs->s.here, bs->s.end,
1826 i->name_index, i->name, 1);
1827 if (error && error != -ENODATA)
1829 bs->s.not_found = error;
1835 ext4_xattr_block_set(handle_t *handle, struct inode *inode,
1836 struct ext4_xattr_info *i,
1837 struct ext4_xattr_block_find *bs)
1839 struct super_block *sb = inode->i_sb;
1840 struct buffer_head *new_bh = NULL;
1841 struct ext4_xattr_search s_copy = bs->s;
1842 struct ext4_xattr_search *s = &s_copy;
1843 struct mb_cache_entry *ce = NULL;
1845 struct mb_cache *ea_block_cache = EA_BLOCK_CACHE(inode);
1846 struct inode *ea_inode = NULL, *tmp_inode;
1847 size_t old_ea_inode_quota = 0;
1848 unsigned int ea_ino;
1851 #define header(x) ((struct ext4_xattr_header *)(x))
1854 BUFFER_TRACE(bs->bh, "get_write_access");
1855 error = ext4_journal_get_write_access(handle, bs->bh);
1858 lock_buffer(bs->bh);
1860 if (header(s->base)->h_refcount == cpu_to_le32(1)) {
1861 __u32 hash = le32_to_cpu(BHDR(bs->bh)->h_hash);
1864 * This must happen under buffer lock for
1865 * ext4_xattr_block_set() to reliably detect modified
1869 mb_cache_entry_delete(ea_block_cache, hash,
1871 ea_bdebug(bs->bh, "modifying in-place");
1872 error = ext4_xattr_set_entry(i, s, handle, inode,
1873 true /* is_block */);
1874 ext4_xattr_block_csum_set(inode, bs->bh);
1875 unlock_buffer(bs->bh);
1876 if (error == -EFSCORRUPTED)
1879 error = ext4_handle_dirty_metadata(handle,
1886 int offset = (char *)s->here - bs->bh->b_data;
1888 unlock_buffer(bs->bh);
1889 ea_bdebug(bs->bh, "cloning");
1890 s->base = kmalloc(bs->bh->b_size, GFP_NOFS);
1892 if (s->base == NULL)
1894 memcpy(s->base, BHDR(bs->bh), bs->bh->b_size);
1895 s->first = ENTRY(header(s->base)+1);
1896 header(s->base)->h_refcount = cpu_to_le32(1);
1897 s->here = ENTRY(s->base + offset);
1898 s->end = s->base + bs->bh->b_size;
1901 * If existing entry points to an xattr inode, we need
1902 * to prevent ext4_xattr_set_entry() from decrementing
1903 * ref count on it because the reference belongs to the
1904 * original block. In this case, make the entry look
1905 * like it has an empty value.
1907 if (!s->not_found && s->here->e_value_inum) {
1908 ea_ino = le32_to_cpu(s->here->e_value_inum);
1909 error = ext4_xattr_inode_iget(inode, ea_ino,
1910 le32_to_cpu(s->here->e_hash),
1915 if (!ext4_test_inode_state(tmp_inode,
1916 EXT4_STATE_LUSTRE_EA_INODE)) {
1918 * Defer quota free call for previous
1919 * inode until success is guaranteed.
1921 old_ea_inode_quota = le32_to_cpu(
1922 s->here->e_value_size);
1926 s->here->e_value_inum = 0;
1927 s->here->e_value_size = 0;
1931 /* Allocate a buffer where we construct the new block. */
1932 s->base = kzalloc(sb->s_blocksize, GFP_NOFS);
1934 if (s->base == NULL)
1936 header(s->base)->h_magic = cpu_to_le32(EXT4_XATTR_MAGIC);
1937 header(s->base)->h_blocks = cpu_to_le32(1);
1938 header(s->base)->h_refcount = cpu_to_le32(1);
1939 s->first = ENTRY(header(s->base)+1);
1940 s->here = ENTRY(header(s->base)+1);
1941 s->end = s->base + sb->s_blocksize;
1944 error = ext4_xattr_set_entry(i, s, handle, inode, true /* is_block */);
1945 if (error == -EFSCORRUPTED)
1950 if (i->value && s->here->e_value_inum) {
1952 * A ref count on ea_inode has been taken as part of the call to
1953 * ext4_xattr_set_entry() above. We would like to drop this
1954 * extra ref but we have to wait until the xattr block is
1955 * initialized and has its own ref count on the ea_inode.
1957 ea_ino = le32_to_cpu(s->here->e_value_inum);
1958 error = ext4_xattr_inode_iget(inode, ea_ino,
1959 le32_to_cpu(s->here->e_hash),
1968 if (!IS_LAST_ENTRY(s->first)) {
1969 new_bh = ext4_xattr_block_cache_find(inode, header(s->base),
1972 /* We found an identical block in the cache. */
1973 if (new_bh == bs->bh)
1974 ea_bdebug(new_bh, "keeping");
1978 WARN_ON_ONCE(dquot_initialize_needed(inode));
1980 /* The old block is released after updating
1982 error = dquot_alloc_block(inode,
1983 EXT4_C2B(EXT4_SB(sb), 1));
1986 BUFFER_TRACE(new_bh, "get_write_access");
1987 error = ext4_journal_get_write_access(handle,
1991 lock_buffer(new_bh);
1993 * We have to be careful about races with
1994 * freeing, rehashing or adding references to
1995 * xattr block. Once we hold buffer lock xattr
1996 * block's state is stable so we can check
1997 * whether the block got freed / rehashed or
1998 * not. Since we unhash mbcache entry under
1999 * buffer lock when freeing / rehashing xattr
2000 * block, checking whether entry is still
2001 * hashed is reliable. Same rules hold for
2002 * e_reusable handling.
2004 if (hlist_bl_unhashed(&ce->e_hash_list) ||
2007 * Undo everything and check mbcache
2010 unlock_buffer(new_bh);
2011 dquot_free_block(inode,
2012 EXT4_C2B(EXT4_SB(sb),
2015 mb_cache_entry_put(ea_block_cache, ce);
2020 ref = le32_to_cpu(BHDR(new_bh)->h_refcount) + 1;
2021 BHDR(new_bh)->h_refcount = cpu_to_le32(ref);
2022 if (ref >= EXT4_XATTR_REFCOUNT_MAX)
2024 ea_bdebug(new_bh, "reusing; refcount now=%d",
2026 ext4_xattr_block_csum_set(inode, new_bh);
2027 unlock_buffer(new_bh);
2028 error = ext4_handle_dirty_metadata(handle,
2034 mb_cache_entry_touch(ea_block_cache, ce);
2035 mb_cache_entry_put(ea_block_cache, ce);
2037 } else if (bs->bh && s->base == bs->bh->b_data) {
2038 /* We were modifying this block in-place. */
2039 ea_bdebug(bs->bh, "keeping this block");
2040 ext4_xattr_block_cache_insert(ea_block_cache, bs->bh);
2044 /* We need to allocate a new block */
2045 ext4_fsblk_t goal, block;
2047 WARN_ON_ONCE(dquot_initialize_needed(inode));
2049 goal = ext4_group_first_block_no(sb,
2050 EXT4_I(inode)->i_block_group);
2052 /* non-extent files can't have physical blocks past 2^32 */
2053 if (!(ext4_test_inode_flag(inode, EXT4_INODE_EXTENTS)))
2054 goal = goal & EXT4_MAX_BLOCK_FILE_PHYS;
2056 block = ext4_new_meta_blocks(handle, inode, goal, 0,
2061 if (!(ext4_test_inode_flag(inode, EXT4_INODE_EXTENTS)))
2062 BUG_ON(block > EXT4_MAX_BLOCK_FILE_PHYS);
2064 ea_idebug(inode, "creating block %llu",
2065 (unsigned long long)block);
2067 new_bh = sb_getblk(sb, block);
2068 if (unlikely(!new_bh)) {
2071 ext4_free_blocks(handle, inode, NULL, block, 1,
2072 EXT4_FREE_BLOCKS_METADATA);
2075 error = ext4_xattr_inode_inc_ref_all(handle, inode,
2076 ENTRY(header(s->base)+1));
2080 /* Drop the extra ref on ea_inode. */
2081 error = ext4_xattr_inode_dec_ref(handle,
2084 ext4_warning_inode(ea_inode,
2091 lock_buffer(new_bh);
2092 error = ext4_journal_get_create_access(handle, new_bh);
2094 unlock_buffer(new_bh);
2098 memcpy(new_bh->b_data, s->base, new_bh->b_size);
2099 ext4_xattr_block_csum_set(inode, new_bh);
2100 set_buffer_uptodate(new_bh);
2101 unlock_buffer(new_bh);
2102 ext4_xattr_block_cache_insert(ea_block_cache, new_bh);
2103 error = ext4_handle_dirty_metadata(handle, inode,
2110 if (old_ea_inode_quota)
2111 ext4_xattr_inode_free_quota(inode, NULL, old_ea_inode_quota);
2113 /* Update the inode. */
2114 EXT4_I(inode)->i_file_acl = new_bh ? new_bh->b_blocknr : 0;
2116 /* Drop the previous xattr block. */
2117 if (bs->bh && bs->bh != new_bh) {
2118 struct ext4_xattr_inode_array *ea_inode_array = NULL;
2120 ext4_xattr_release_block(handle, inode, bs->bh,
2122 0 /* extra_credits */);
2123 ext4_xattr_inode_array_free(ea_inode_array);
2131 error2 = ext4_xattr_inode_dec_ref(handle, ea_inode);
2133 ext4_warning_inode(ea_inode, "dec ref error=%d",
2136 /* If there was an error, revert the quota charge. */
2138 ext4_xattr_inode_free_quota(inode, ea_inode,
2139 i_size_read(ea_inode));
2143 mb_cache_entry_put(ea_block_cache, ce);
2145 if (!(bs->bh && s->base == bs->bh->b_data))
2151 dquot_free_block(inode, EXT4_C2B(EXT4_SB(sb), 1));
2155 EXT4_ERROR_INODE(inode, "bad block %llu",
2156 EXT4_I(inode)->i_file_acl);
2162 int ext4_xattr_ibody_find(struct inode *inode, struct ext4_xattr_info *i,
2163 struct ext4_xattr_ibody_find *is)
2165 struct ext4_xattr_ibody_header *header;
2166 struct ext4_inode *raw_inode;
2169 if (EXT4_I(inode)->i_extra_isize == 0)
2171 raw_inode = ext4_raw_inode(&is->iloc);
2172 header = IHDR(inode, raw_inode);
2173 is->s.base = is->s.first = IFIRST(header);
2174 is->s.here = is->s.first;
2175 is->s.end = (void *)raw_inode + EXT4_SB(inode->i_sb)->s_inode_size;
2176 if (ext4_test_inode_state(inode, EXT4_STATE_XATTR)) {
2177 error = xattr_check_inode(inode, header, is->s.end);
2180 /* Find the named attribute. */
2181 error = xattr_find_entry(inode, &is->s.here, is->s.end,
2182 i->name_index, i->name, 0);
2183 if (error && error != -ENODATA)
2185 is->s.not_found = error;
2190 int ext4_xattr_ibody_inline_set(handle_t *handle, struct inode *inode,
2191 struct ext4_xattr_info *i,
2192 struct ext4_xattr_ibody_find *is)
2194 struct ext4_xattr_ibody_header *header;
2195 struct ext4_xattr_search *s = &is->s;
2198 if (EXT4_I(inode)->i_extra_isize == 0)
2200 error = ext4_xattr_set_entry(i, s, handle, inode, false /* is_block */);
2203 header = IHDR(inode, ext4_raw_inode(&is->iloc));
2204 if (!IS_LAST_ENTRY(s->first)) {
2205 header->h_magic = cpu_to_le32(EXT4_XATTR_MAGIC);
2206 ext4_set_inode_state(inode, EXT4_STATE_XATTR);
2208 header->h_magic = cpu_to_le32(0);
2209 ext4_clear_inode_state(inode, EXT4_STATE_XATTR);
2214 static int ext4_xattr_ibody_set(handle_t *handle, struct inode *inode,
2215 struct ext4_xattr_info *i,
2216 struct ext4_xattr_ibody_find *is)
2218 struct ext4_xattr_ibody_header *header;
2219 struct ext4_xattr_search *s = &is->s;
2222 if (EXT4_I(inode)->i_extra_isize == 0)
2224 error = ext4_xattr_set_entry(i, s, handle, inode, false /* is_block */);
2227 header = IHDR(inode, ext4_raw_inode(&is->iloc));
2228 if (!IS_LAST_ENTRY(s->first)) {
2229 header->h_magic = cpu_to_le32(EXT4_XATTR_MAGIC);
2230 ext4_set_inode_state(inode, EXT4_STATE_XATTR);
2232 header->h_magic = cpu_to_le32(0);
2233 ext4_clear_inode_state(inode, EXT4_STATE_XATTR);
2238 static int ext4_xattr_value_same(struct ext4_xattr_search *s,
2239 struct ext4_xattr_info *i)
2243 /* When e_value_inum is set the value is stored externally. */
2244 if (s->here->e_value_inum)
2246 if (le32_to_cpu(s->here->e_value_size) != i->value_len)
2248 value = ((void *)s->base) + le16_to_cpu(s->here->e_value_offs);
2249 return !memcmp(value, i->value, i->value_len);
2252 static struct buffer_head *ext4_xattr_get_block(struct inode *inode)
2254 struct buffer_head *bh;
2257 if (!EXT4_I(inode)->i_file_acl)
2259 bh = ext4_sb_bread(inode->i_sb, EXT4_I(inode)->i_file_acl, REQ_PRIO);
2262 error = ext4_xattr_check_block(inode, bh);
2265 return ERR_PTR(error);
2271 * ext4_xattr_set_handle()
2273 * Create, replace or remove an extended attribute for this inode. Value
2274 * is NULL to remove an existing extended attribute, and non-NULL to
2275 * either replace an existing extended attribute, or create a new extended
2276 * attribute. The flags XATTR_REPLACE and XATTR_CREATE
2277 * specify that an extended attribute must exist and must not exist
2278 * previous to the call, respectively.
2280 * Returns 0, or a negative error number on failure.
2283 ext4_xattr_set_handle(handle_t *handle, struct inode *inode, int name_index,
2284 const char *name, const void *value, size_t value_len,
2287 struct ext4_xattr_info i = {
2288 .name_index = name_index,
2291 .value_len = value_len,
2294 struct ext4_xattr_ibody_find is = {
2295 .s = { .not_found = -ENODATA, },
2297 struct ext4_xattr_block_find bs = {
2298 .s = { .not_found = -ENODATA, },
2305 if (strlen(name) > 255)
2308 ext4_write_lock_xattr(inode, &no_expand);
2310 /* Check journal credits under write lock. */
2311 if (ext4_handle_valid(handle)) {
2312 struct buffer_head *bh;
2315 bh = ext4_xattr_get_block(inode);
2317 error = PTR_ERR(bh);
2321 credits = __ext4_xattr_set_credits(inode->i_sb, inode, bh,
2323 flags & XATTR_CREATE);
2326 if (jbd2_handle_buffer_credits(handle) < credits) {
2332 error = ext4_reserve_inode_write(handle, inode, &is.iloc);
2336 if (ext4_test_inode_state(inode, EXT4_STATE_NEW)) {
2337 struct ext4_inode *raw_inode = ext4_raw_inode(&is.iloc);
2338 memset(raw_inode, 0, EXT4_SB(inode->i_sb)->s_inode_size);
2339 ext4_clear_inode_state(inode, EXT4_STATE_NEW);
2342 error = ext4_xattr_ibody_find(inode, &i, &is);
2346 error = ext4_xattr_block_find(inode, &i, &bs);
2349 if (is.s.not_found && bs.s.not_found) {
2351 if (flags & XATTR_REPLACE)
2358 if (flags & XATTR_CREATE)
2363 if (!is.s.not_found)
2364 error = ext4_xattr_ibody_set(handle, inode, &i, &is);
2365 else if (!bs.s.not_found)
2366 error = ext4_xattr_block_set(handle, inode, &i, &bs);
2369 /* Xattr value did not change? Save us some work and bail out */
2370 if (!is.s.not_found && ext4_xattr_value_same(&is.s, &i))
2372 if (!bs.s.not_found && ext4_xattr_value_same(&bs.s, &i))
2375 if (ext4_has_feature_ea_inode(inode->i_sb) &&
2376 (EXT4_XATTR_SIZE(i.value_len) >
2377 EXT4_XATTR_MIN_LARGE_EA_SIZE(inode->i_sb->s_blocksize)))
2380 error = ext4_xattr_ibody_set(handle, inode, &i, &is);
2381 if (!error && !bs.s.not_found) {
2383 error = ext4_xattr_block_set(handle, inode, &i, &bs);
2384 } else if (error == -ENOSPC) {
2385 if (EXT4_I(inode)->i_file_acl && !bs.s.base) {
2388 error = ext4_xattr_block_find(inode, &i, &bs);
2392 error = ext4_xattr_block_set(handle, inode, &i, &bs);
2393 if (!error && !is.s.not_found) {
2395 error = ext4_xattr_ibody_set(handle, inode, &i,
2397 } else if (error == -ENOSPC) {
2399 * Xattr does not fit in the block, store at
2400 * external inode if possible.
2402 if (ext4_has_feature_ea_inode(inode->i_sb) &&
2411 ext4_xattr_update_super_block(handle, inode->i_sb);
2412 inode->i_ctime = current_time(inode);
2415 error = ext4_mark_iloc_dirty(handle, inode, &is.iloc);
2417 * The bh is consumed by ext4_mark_iloc_dirty, even with
2422 ext4_handle_sync(handle);
2424 ext4_fc_mark_ineligible(inode->i_sb, EXT4_FC_REASON_XATTR);
2429 ext4_write_unlock_xattr(inode, &no_expand);
2433 int ext4_xattr_set_credits(struct inode *inode, size_t value_len,
2434 bool is_create, int *credits)
2436 struct buffer_head *bh;
2441 if (!EXT4_SB(inode->i_sb)->s_journal)
2444 down_read(&EXT4_I(inode)->xattr_sem);
2446 bh = ext4_xattr_get_block(inode);
2450 *credits = __ext4_xattr_set_credits(inode->i_sb, inode, bh,
2451 value_len, is_create);
2456 up_read(&EXT4_I(inode)->xattr_sem);
2463 * Like ext4_xattr_set_handle, but start from an inode. This extended
2464 * attribute modification is a filesystem transaction by itself.
2466 * Returns 0, or a negative error number on failure.
2469 ext4_xattr_set(struct inode *inode, int name_index, const char *name,
2470 const void *value, size_t value_len, int flags)
2473 struct super_block *sb = inode->i_sb;
2474 int error, retries = 0;
2477 error = dquot_initialize(inode);
2482 error = ext4_xattr_set_credits(inode, value_len, flags & XATTR_CREATE,
2487 handle = ext4_journal_start(inode, EXT4_HT_XATTR, credits);
2488 if (IS_ERR(handle)) {
2489 error = PTR_ERR(handle);
2493 error = ext4_xattr_set_handle(handle, inode, name_index, name,
2494 value, value_len, flags);
2495 error2 = ext4_journal_stop(handle);
2496 if (error == -ENOSPC &&
2497 ext4_should_retry_alloc(sb, &retries))
2502 ext4_fc_mark_ineligible(inode->i_sb, EXT4_FC_REASON_XATTR);
2508 * Shift the EA entries in the inode to create space for the increased
2511 static void ext4_xattr_shift_entries(struct ext4_xattr_entry *entry,
2512 int value_offs_shift, void *to,
2513 void *from, size_t n)
2515 struct ext4_xattr_entry *last = entry;
2518 /* We always shift xattr headers further thus offsets get lower */
2519 BUG_ON(value_offs_shift > 0);
2521 /* Adjust the value offsets of the entries */
2522 for (; !IS_LAST_ENTRY(last); last = EXT4_XATTR_NEXT(last)) {
2523 if (!last->e_value_inum && last->e_value_size) {
2524 new_offs = le16_to_cpu(last->e_value_offs) +
2526 last->e_value_offs = cpu_to_le16(new_offs);
2529 /* Shift the entries by n bytes */
2530 memmove(to, from, n);
2534 * Move xattr pointed to by 'entry' from inode into external xattr block
2536 static int ext4_xattr_move_to_block(handle_t *handle, struct inode *inode,
2537 struct ext4_inode *raw_inode,
2538 struct ext4_xattr_entry *entry)
2540 struct ext4_xattr_ibody_find *is = NULL;
2541 struct ext4_xattr_block_find *bs = NULL;
2542 char *buffer = NULL, *b_entry_name = NULL;
2543 size_t value_size = le32_to_cpu(entry->e_value_size);
2544 struct ext4_xattr_info i = {
2547 .name_index = entry->e_name_index,
2548 .in_inode = !!entry->e_value_inum,
2550 struct ext4_xattr_ibody_header *header = IHDR(inode, raw_inode);
2553 is = kzalloc(sizeof(struct ext4_xattr_ibody_find), GFP_NOFS);
2554 bs = kzalloc(sizeof(struct ext4_xattr_block_find), GFP_NOFS);
2555 buffer = kmalloc(value_size, GFP_NOFS);
2556 b_entry_name = kmalloc(entry->e_name_len + 1, GFP_NOFS);
2557 if (!is || !bs || !buffer || !b_entry_name) {
2562 is->s.not_found = -ENODATA;
2563 bs->s.not_found = -ENODATA;
2567 /* Save the entry name and the entry value */
2568 if (entry->e_value_inum) {
2569 error = ext4_xattr_inode_get(inode, entry, buffer, value_size);
2573 size_t value_offs = le16_to_cpu(entry->e_value_offs);
2574 memcpy(buffer, (void *)IFIRST(header) + value_offs, value_size);
2577 memcpy(b_entry_name, entry->e_name, entry->e_name_len);
2578 b_entry_name[entry->e_name_len] = '\0';
2579 i.name = b_entry_name;
2581 error = ext4_get_inode_loc(inode, &is->iloc);
2585 error = ext4_xattr_ibody_find(inode, &i, is);
2589 /* Remove the chosen entry from the inode */
2590 error = ext4_xattr_ibody_set(handle, inode, &i, is);
2595 i.value_len = value_size;
2596 error = ext4_xattr_block_find(inode, &i, bs);
2600 /* Add entry which was removed from the inode into the block */
2601 error = ext4_xattr_block_set(handle, inode, &i, bs);
2606 kfree(b_entry_name);
2609 brelse(is->iloc.bh);
2618 static int ext4_xattr_make_inode_space(handle_t *handle, struct inode *inode,
2619 struct ext4_inode *raw_inode,
2620 int isize_diff, size_t ifree,
2621 size_t bfree, int *total_ino)
2623 struct ext4_xattr_ibody_header *header = IHDR(inode, raw_inode);
2624 struct ext4_xattr_entry *small_entry;
2625 struct ext4_xattr_entry *entry;
2626 struct ext4_xattr_entry *last;
2627 unsigned int entry_size; /* EA entry size */
2628 unsigned int total_size; /* EA entry size + value size */
2629 unsigned int min_total_size;
2632 while (isize_diff > ifree) {
2635 min_total_size = ~0U;
2636 last = IFIRST(header);
2637 /* Find the entry best suited to be pushed into EA block */
2638 for (; !IS_LAST_ENTRY(last); last = EXT4_XATTR_NEXT(last)) {
2639 /* never move system.data out of the inode */
2640 if ((last->e_name_len == 4) &&
2641 (last->e_name_index == EXT4_XATTR_INDEX_SYSTEM) &&
2642 !memcmp(last->e_name, "data", 4))
2644 total_size = EXT4_XATTR_LEN(last->e_name_len);
2645 if (!last->e_value_inum)
2646 total_size += EXT4_XATTR_SIZE(
2647 le32_to_cpu(last->e_value_size));
2648 if (total_size <= bfree &&
2649 total_size < min_total_size) {
2650 if (total_size + ifree < isize_diff) {
2654 min_total_size = total_size;
2659 if (entry == NULL) {
2660 if (small_entry == NULL)
2662 entry = small_entry;
2665 entry_size = EXT4_XATTR_LEN(entry->e_name_len);
2666 total_size = entry_size;
2667 if (!entry->e_value_inum)
2668 total_size += EXT4_XATTR_SIZE(
2669 le32_to_cpu(entry->e_value_size));
2670 error = ext4_xattr_move_to_block(handle, inode, raw_inode,
2675 *total_ino -= entry_size;
2676 ifree += total_size;
2677 bfree -= total_size;
2684 * Expand an inode by new_extra_isize bytes when EAs are present.
2685 * Returns 0 on success or negative error number on failure.
2687 int ext4_expand_extra_isize_ea(struct inode *inode, int new_extra_isize,
2688 struct ext4_inode *raw_inode, handle_t *handle)
2690 struct ext4_xattr_ibody_header *header;
2691 struct ext4_sb_info *sbi = EXT4_SB(inode->i_sb);
2692 static unsigned int mnt_count;
2694 size_t ifree, bfree;
2697 int error = 0, tried_min_extra_isize = 0;
2698 int s_min_extra_isize = le16_to_cpu(sbi->s_es->s_min_extra_isize);
2699 int isize_diff; /* How much do we need to grow i_extra_isize */
2702 isize_diff = new_extra_isize - EXT4_I(inode)->i_extra_isize;
2703 if (EXT4_I(inode)->i_extra_isize >= new_extra_isize)
2706 header = IHDR(inode, raw_inode);
2709 * Check if enough free space is available in the inode to shift the
2710 * entries ahead by new_extra_isize.
2713 base = IFIRST(header);
2714 end = (void *)raw_inode + EXT4_SB(inode->i_sb)->s_inode_size;
2715 min_offs = end - base;
2716 total_ino = sizeof(struct ext4_xattr_ibody_header) + sizeof(u32);
2718 error = xattr_check_inode(inode, header, end);
2722 ifree = ext4_xattr_free_space(base, &min_offs, base, &total_ino);
2723 if (ifree >= isize_diff)
2727 * Enough free space isn't available in the inode, check if
2728 * EA block can hold new_extra_isize bytes.
2730 if (EXT4_I(inode)->i_file_acl) {
2731 struct buffer_head *bh;
2733 bh = ext4_sb_bread(inode->i_sb, EXT4_I(inode)->i_file_acl, REQ_PRIO);
2735 error = PTR_ERR(bh);
2738 error = ext4_xattr_check_block(inode, bh);
2744 end = bh->b_data + bh->b_size;
2745 min_offs = end - base;
2746 bfree = ext4_xattr_free_space(BFIRST(bh), &min_offs, base,
2749 if (bfree + ifree < isize_diff) {
2750 if (!tried_min_extra_isize && s_min_extra_isize) {
2751 tried_min_extra_isize++;
2752 new_extra_isize = s_min_extra_isize;
2759 bfree = inode->i_sb->s_blocksize;
2762 error = ext4_xattr_make_inode_space(handle, inode, raw_inode,
2763 isize_diff, ifree, bfree,
2766 if (error == -ENOSPC && !tried_min_extra_isize &&
2767 s_min_extra_isize) {
2768 tried_min_extra_isize++;
2769 new_extra_isize = s_min_extra_isize;
2775 /* Adjust the offsets and shift the remaining entries ahead */
2776 ext4_xattr_shift_entries(IFIRST(header), EXT4_I(inode)->i_extra_isize
2777 - new_extra_isize, (void *)raw_inode +
2778 EXT4_GOOD_OLD_INODE_SIZE + new_extra_isize,
2779 (void *)header, total_ino);
2780 EXT4_I(inode)->i_extra_isize = new_extra_isize;
2783 if (error && (mnt_count != le16_to_cpu(sbi->s_es->s_mnt_count))) {
2784 ext4_warning(inode->i_sb, "Unable to expand inode %lu. Delete some EAs or run e2fsck.",
2786 mnt_count = le16_to_cpu(sbi->s_es->s_mnt_count);
2791 #define EIA_INCR 16 /* must be 2^n */
2792 #define EIA_MASK (EIA_INCR - 1)
2794 /* Add the large xattr @inode into @ea_inode_array for deferred iput().
2795 * If @ea_inode_array is new or full it will be grown and the old
2796 * contents copied over.
2799 ext4_expand_inode_array(struct ext4_xattr_inode_array **ea_inode_array,
2800 struct inode *inode)
2802 if (*ea_inode_array == NULL) {
2804 * Start with 15 inodes, so it fits into a power-of-two size.
2805 * If *ea_inode_array is NULL, this is essentially offsetof()
2808 kmalloc(offsetof(struct ext4_xattr_inode_array,
2811 if (*ea_inode_array == NULL)
2813 (*ea_inode_array)->count = 0;
2814 } else if (((*ea_inode_array)->count & EIA_MASK) == EIA_MASK) {
2815 /* expand the array once all 15 + n * 16 slots are full */
2816 struct ext4_xattr_inode_array *new_array = NULL;
2817 int count = (*ea_inode_array)->count;
2819 /* if new_array is NULL, this is essentially offsetof() */
2820 new_array = kmalloc(
2821 offsetof(struct ext4_xattr_inode_array,
2822 inodes[count + EIA_INCR]),
2824 if (new_array == NULL)
2826 memcpy(new_array, *ea_inode_array,
2827 offsetof(struct ext4_xattr_inode_array, inodes[count]));
2828 kfree(*ea_inode_array);
2829 *ea_inode_array = new_array;
2831 (*ea_inode_array)->inodes[(*ea_inode_array)->count++] = inode;
2836 * ext4_xattr_delete_inode()
2838 * Free extended attribute resources associated with this inode. Traverse
2839 * all entries and decrement reference on any xattr inodes associated with this
2840 * inode. This is called immediately before an inode is freed. We have exclusive
2841 * access to the inode. If an orphan inode is deleted it will also release its
2842 * references on xattr block and xattr inodes.
2844 int ext4_xattr_delete_inode(handle_t *handle, struct inode *inode,
2845 struct ext4_xattr_inode_array **ea_inode_array,
2848 struct buffer_head *bh = NULL;
2849 struct ext4_xattr_ibody_header *header;
2850 struct ext4_iloc iloc = { .bh = NULL };
2851 struct ext4_xattr_entry *entry;
2852 struct inode *ea_inode;
2855 error = ext4_journal_ensure_credits(handle, extra_credits,
2856 ext4_free_metadata_revoke_credits(inode->i_sb, 1));
2858 EXT4_ERROR_INODE(inode, "ensure credits (error %d)", error);
2862 if (ext4_has_feature_ea_inode(inode->i_sb) &&
2863 ext4_test_inode_state(inode, EXT4_STATE_XATTR)) {
2865 error = ext4_get_inode_loc(inode, &iloc);
2867 EXT4_ERROR_INODE(inode, "inode loc (error %d)", error);
2871 error = ext4_journal_get_write_access(handle, iloc.bh);
2873 EXT4_ERROR_INODE(inode, "write access (error %d)",
2878 header = IHDR(inode, ext4_raw_inode(&iloc));
2879 if (header->h_magic == cpu_to_le32(EXT4_XATTR_MAGIC))
2880 ext4_xattr_inode_dec_ref_all(handle, inode, iloc.bh,
2882 false /* block_csum */,
2885 false /* skip_quota */);
2888 if (EXT4_I(inode)->i_file_acl) {
2889 bh = ext4_sb_bread(inode->i_sb, EXT4_I(inode)->i_file_acl, REQ_PRIO);
2891 error = PTR_ERR(bh);
2892 if (error == -EIO) {
2893 EXT4_ERROR_INODE_ERR(inode, EIO,
2894 "block %llu read error",
2895 EXT4_I(inode)->i_file_acl);
2900 error = ext4_xattr_check_block(inode, bh);
2904 if (ext4_has_feature_ea_inode(inode->i_sb)) {
2905 for (entry = BFIRST(bh); !IS_LAST_ENTRY(entry);
2906 entry = EXT4_XATTR_NEXT(entry)) {
2907 if (!entry->e_value_inum)
2909 error = ext4_xattr_inode_iget(inode,
2910 le32_to_cpu(entry->e_value_inum),
2911 le32_to_cpu(entry->e_hash),
2915 ext4_xattr_inode_free_quota(inode, ea_inode,
2916 le32_to_cpu(entry->e_value_size));
2922 ext4_xattr_release_block(handle, inode, bh, ea_inode_array,
2925 * Update i_file_acl value in the same transaction that releases
2928 EXT4_I(inode)->i_file_acl = 0;
2929 error = ext4_mark_inode_dirty(handle, inode);
2931 EXT4_ERROR_INODE(inode, "mark inode dirty (error %d)",
2935 ext4_fc_mark_ineligible(inode->i_sb, EXT4_FC_REASON_XATTR);
2944 void ext4_xattr_inode_array_free(struct ext4_xattr_inode_array *ea_inode_array)
2948 if (ea_inode_array == NULL)
2951 for (idx = 0; idx < ea_inode_array->count; ++idx)
2952 iput(ea_inode_array->inodes[idx]);
2953 kfree(ea_inode_array);
2957 * ext4_xattr_block_cache_insert()
2959 * Create a new entry in the extended attribute block cache, and insert
2960 * it unless such an entry is already in the cache.
2962 * Returns 0, or a negative error number on failure.
2965 ext4_xattr_block_cache_insert(struct mb_cache *ea_block_cache,
2966 struct buffer_head *bh)
2968 struct ext4_xattr_header *header = BHDR(bh);
2969 __u32 hash = le32_to_cpu(header->h_hash);
2970 int reusable = le32_to_cpu(header->h_refcount) <
2971 EXT4_XATTR_REFCOUNT_MAX;
2974 if (!ea_block_cache)
2976 error = mb_cache_entry_create(ea_block_cache, GFP_NOFS, hash,
2977 bh->b_blocknr, reusable);
2979 if (error == -EBUSY)
2980 ea_bdebug(bh, "already in cache");
2982 ea_bdebug(bh, "inserting [%x]", (int)hash);
2988 * Compare two extended attribute blocks for equality.
2990 * Returns 0 if the blocks are equal, 1 if they differ, and
2991 * a negative error number on errors.
2994 ext4_xattr_cmp(struct ext4_xattr_header *header1,
2995 struct ext4_xattr_header *header2)
2997 struct ext4_xattr_entry *entry1, *entry2;
2999 entry1 = ENTRY(header1+1);
3000 entry2 = ENTRY(header2+1);
3001 while (!IS_LAST_ENTRY(entry1)) {
3002 if (IS_LAST_ENTRY(entry2))
3004 if (entry1->e_hash != entry2->e_hash ||
3005 entry1->e_name_index != entry2->e_name_index ||
3006 entry1->e_name_len != entry2->e_name_len ||
3007 entry1->e_value_size != entry2->e_value_size ||
3008 entry1->e_value_inum != entry2->e_value_inum ||
3009 memcmp(entry1->e_name, entry2->e_name, entry1->e_name_len))
3011 if (!entry1->e_value_inum &&
3012 memcmp((char *)header1 + le16_to_cpu(entry1->e_value_offs),
3013 (char *)header2 + le16_to_cpu(entry2->e_value_offs),
3014 le32_to_cpu(entry1->e_value_size)))
3017 entry1 = EXT4_XATTR_NEXT(entry1);
3018 entry2 = EXT4_XATTR_NEXT(entry2);
3020 if (!IS_LAST_ENTRY(entry2))
3026 * ext4_xattr_block_cache_find()
3028 * Find an identical extended attribute block.
3030 * Returns a pointer to the block found, or NULL if such a block was
3031 * not found or an error occurred.
3033 static struct buffer_head *
3034 ext4_xattr_block_cache_find(struct inode *inode,
3035 struct ext4_xattr_header *header,
3036 struct mb_cache_entry **pce)
3038 __u32 hash = le32_to_cpu(header->h_hash);
3039 struct mb_cache_entry *ce;
3040 struct mb_cache *ea_block_cache = EA_BLOCK_CACHE(inode);
3042 if (!ea_block_cache)
3044 if (!header->h_hash)
3045 return NULL; /* never share */
3046 ea_idebug(inode, "looking for cached blocks [%x]", (int)hash);
3047 ce = mb_cache_entry_find_first(ea_block_cache, hash);
3049 struct buffer_head *bh;
3051 bh = ext4_sb_bread(inode->i_sb, ce->e_value, REQ_PRIO);
3053 if (PTR_ERR(bh) == -ENOMEM)
3056 EXT4_ERROR_INODE(inode, "block %lu read error",
3057 (unsigned long)ce->e_value);
3058 } else if (ext4_xattr_cmp(header, BHDR(bh)) == 0) {
3063 ce = mb_cache_entry_find_next(ea_block_cache, ce);
3068 #define NAME_HASH_SHIFT 5
3069 #define VALUE_HASH_SHIFT 16
3072 * ext4_xattr_hash_entry()
3074 * Compute the hash of an extended attribute.
3076 static __le32 ext4_xattr_hash_entry(char *name, size_t name_len, __le32 *value,
3081 while (name_len--) {
3082 hash = (hash << NAME_HASH_SHIFT) ^
3083 (hash >> (8*sizeof(hash) - NAME_HASH_SHIFT)) ^
3086 while (value_count--) {
3087 hash = (hash << VALUE_HASH_SHIFT) ^
3088 (hash >> (8*sizeof(hash) - VALUE_HASH_SHIFT)) ^
3089 le32_to_cpu(*value++);
3091 return cpu_to_le32(hash);
3094 #undef NAME_HASH_SHIFT
3095 #undef VALUE_HASH_SHIFT
3097 #define BLOCK_HASH_SHIFT 16
3100 * ext4_xattr_rehash()
3102 * Re-compute the extended attribute hash value after an entry has changed.
3104 static void ext4_xattr_rehash(struct ext4_xattr_header *header)
3106 struct ext4_xattr_entry *here;
3109 here = ENTRY(header+1);
3110 while (!IS_LAST_ENTRY(here)) {
3111 if (!here->e_hash) {
3112 /* Block is not shared if an entry's hash value == 0 */
3116 hash = (hash << BLOCK_HASH_SHIFT) ^
3117 (hash >> (8*sizeof(hash) - BLOCK_HASH_SHIFT)) ^
3118 le32_to_cpu(here->e_hash);
3119 here = EXT4_XATTR_NEXT(here);
3121 header->h_hash = cpu_to_le32(hash);
3124 #undef BLOCK_HASH_SHIFT
3126 #define HASH_BUCKET_BITS 10
3129 ext4_xattr_create_cache(void)
3131 return mb_cache_create(HASH_BUCKET_BITS);
3134 void ext4_xattr_destroy_cache(struct mb_cache *cache)
3137 mb_cache_destroy(cache);