2 * ext_attr.c --- extended attribute blocks
4 * Copyright (C) 2001 Andreas Gruenbacher, <a.gruenbacher@computer.org>
6 * Copyright (C) 2002 Theodore Ts'o.
9 * This file may be redistributed under the terms of the GNU Library
10 * General Public License, version 2.
23 #include "ext2_ext_attr.h"
28 static errcode_t read_ea_inode_hash(ext2_filsys fs, ext2_ino_t ino, __u32 *hash)
30 struct ext2_inode inode;
33 retval = ext2fs_read_inode(fs, ino, &inode);
36 *hash = ext2fs_get_ea_inode_hash(&inode);
40 #define NAME_HASH_SHIFT 5
41 #define VALUE_HASH_SHIFT 16
44 * ext2_xattr_hash_entry()
46 * Compute the hash of an extended attribute.
48 __u32 ext2fs_ext_attr_hash_entry(struct ext2_ext_attr_entry *entry, void *data)
51 char *name = ((char *) entry) + sizeof(struct ext2_ext_attr_entry);
54 for (n = 0; n < entry->e_name_len; n++) {
55 hash = (hash << NAME_HASH_SHIFT) ^
56 (hash >> (8*sizeof(hash) - NAME_HASH_SHIFT)) ^
60 /* The hash needs to be calculated on the data in little-endian. */
61 if (entry->e_value_inum == 0 && entry->e_value_size != 0) {
62 __u32 *value = (__u32 *)data;
63 for (n = (entry->e_value_size + EXT2_EXT_ATTR_ROUND) >>
64 EXT2_EXT_ATTR_PAD_BITS; n; n--) {
65 hash = (hash << VALUE_HASH_SHIFT) ^
66 (hash >> (8*sizeof(hash) - VALUE_HASH_SHIFT)) ^
67 ext2fs_le32_to_cpu(*value++);
75 * ext2fs_ext_attr_hash_entry2()
77 * Compute the hash of an extended attribute.
78 * This version of the function supports hashing entries that reference
79 * external inodes (ea_inode feature).
81 errcode_t ext2fs_ext_attr_hash_entry2(ext2_filsys fs,
82 struct ext2_ext_attr_entry *entry,
83 void *data, __u32 *hash)
85 *hash = ext2fs_ext_attr_hash_entry(entry, data);
87 if (entry->e_value_inum) {
91 retval = read_ea_inode_hash(fs, entry->e_value_inum,
96 *hash = (*hash << VALUE_HASH_SHIFT) ^
97 (*hash >> (8*sizeof(*hash) - VALUE_HASH_SHIFT)) ^
103 #undef NAME_HASH_SHIFT
104 #undef VALUE_HASH_SHIFT
106 #define BLOCK_HASH_SHIFT 16
108 /* Mirrors ext4_xattr_rehash() implementation in kernel. */
109 void ext2fs_ext_attr_block_rehash(struct ext2_ext_attr_header *header,
110 struct ext2_ext_attr_entry *end)
112 struct ext2_ext_attr_entry *here;
115 here = (struct ext2_ext_attr_entry *)(header+1);
116 while (here < end && !EXT2_EXT_IS_LAST_ENTRY(here)) {
118 /* Block is not shared if an entry's hash value == 0 */
122 hash = (hash << BLOCK_HASH_SHIFT) ^
123 (hash >> (8*sizeof(hash) - BLOCK_HASH_SHIFT)) ^
125 here = EXT2_EXT_ATTR_NEXT(here);
127 header->h_hash = hash;
130 #undef BLOCK_HASH_SHIFT
132 __u32 ext2fs_get_ea_inode_hash(struct ext2_inode *inode)
134 return inode->i_atime;
137 void ext2fs_set_ea_inode_hash(struct ext2_inode *inode, __u32 hash)
139 inode->i_atime = hash;
142 __u64 ext2fs_get_ea_inode_ref(struct ext2_inode *inode)
144 return ((__u64)inode->i_ctime << 32) | inode->osd1.linux1.l_i_version;
147 void ext2fs_set_ea_inode_ref(struct ext2_inode *inode, __u64 ref_count)
149 inode->i_ctime = (__u32)(ref_count >> 32);
150 inode->osd1.linux1.l_i_version = (__u32)ref_count;
153 static errcode_t check_ext_attr_header(struct ext2_ext_attr_header *header)
155 if ((header->h_magic != EXT2_EXT_ATTR_MAGIC_v1 &&
156 header->h_magic != EXT2_EXT_ATTR_MAGIC) ||
157 header->h_blocks != 1)
158 return EXT2_ET_BAD_EA_HEADER;
163 errcode_t ext2fs_read_ext_attr3(ext2_filsys fs, blk64_t block, void *buf,
169 retval = io_channel_read_blk64(fs->io, block, 1, buf);
173 if (!(fs->flags & EXT2_FLAG_IGNORE_CSUM_ERRORS) &&
174 !ext2fs_ext_attr_block_csum_verify(fs, inum, block, buf))
177 #ifdef WORDS_BIGENDIAN
178 ext2fs_swap_ext_attr(buf, buf, fs->blocksize, 1);
181 retval = check_ext_attr_header(buf);
182 if (retval == 0 && csum_failed)
183 retval = EXT2_ET_EXT_ATTR_CSUM_INVALID;
188 errcode_t ext2fs_read_ext_attr2(ext2_filsys fs, blk64_t block, void *buf)
190 return ext2fs_read_ext_attr3(fs, block, buf, 0);
193 errcode_t ext2fs_read_ext_attr(ext2_filsys fs, blk_t block, void *buf)
195 return ext2fs_read_ext_attr2(fs, block, buf);
198 errcode_t ext2fs_write_ext_attr3(ext2_filsys fs, blk64_t block, void *inbuf,
204 #ifdef WORDS_BIGENDIAN
205 retval = ext2fs_get_mem(fs->blocksize, &write_buf);
208 ext2fs_swap_ext_attr(write_buf, inbuf, fs->blocksize, 1);
210 write_buf = (char *) inbuf;
213 retval = ext2fs_ext_attr_block_csum_set(fs, inum, block,
214 (struct ext2_ext_attr_header *)write_buf);
218 retval = io_channel_write_blk64(fs->io, block, 1, write_buf);
219 #ifdef WORDS_BIGENDIAN
220 ext2fs_free_mem(&write_buf);
223 ext2fs_mark_changed(fs);
227 errcode_t ext2fs_write_ext_attr2(ext2_filsys fs, blk64_t block, void *inbuf)
229 return ext2fs_write_ext_attr3(fs, block, inbuf, 0);
232 errcode_t ext2fs_write_ext_attr(ext2_filsys fs, blk_t block, void *inbuf)
234 return ext2fs_write_ext_attr2(fs, block, inbuf);
238 * This function adjusts the reference count of the EA block.
240 errcode_t ext2fs_adjust_ea_refcount3(ext2_filsys fs, blk64_t blk,
241 char *block_buf, int adjust,
242 __u32 *newcount, ext2_ino_t inum)
245 struct ext2_ext_attr_header *header;
248 if ((blk >= ext2fs_blocks_count(fs->super)) ||
249 (blk < fs->super->s_first_data_block))
250 return EXT2_ET_BAD_EA_BLOCK_NUM;
253 retval = ext2fs_get_mem(fs->blocksize, &buf);
259 retval = ext2fs_read_ext_attr3(fs, blk, block_buf, inum);
263 header = (struct ext2_ext_attr_header *) block_buf;
264 header->h_refcount += adjust;
266 *newcount = header->h_refcount;
268 retval = ext2fs_write_ext_attr3(fs, blk, block_buf, inum);
274 ext2fs_free_mem(&buf);
278 errcode_t ext2fs_adjust_ea_refcount2(ext2_filsys fs, blk64_t blk,
279 char *block_buf, int adjust,
282 return ext2fs_adjust_ea_refcount3(fs, blk, block_buf, adjust,
286 errcode_t ext2fs_adjust_ea_refcount(ext2_filsys fs, blk_t blk,
287 char *block_buf, int adjust,
290 return ext2fs_adjust_ea_refcount2(fs, blk, block_buf, adjust,
294 /* Manipulate the contents of extended attribute regions */
300 unsigned int value_len;
304 struct ext2_xattr_handle {
307 struct ext2_xattr *attrs;
315 static errcode_t ext2fs_xattrs_expand(struct ext2_xattr_handle *h,
316 unsigned int expandby)
318 struct ext2_xattr *new_attrs;
321 err = ext2fs_get_arrayzero(h->capacity + expandby,
322 sizeof(struct ext2_xattr), &new_attrs);
326 memcpy(new_attrs, h->attrs, h->capacity * sizeof(struct ext2_xattr));
327 ext2fs_free_mem(&h->attrs);
328 h->capacity += expandby;
329 h->attrs = new_attrs;
334 struct ea_name_index {
339 /* Keep these names sorted in order of decreasing specificity. */
340 static struct ea_name_index ea_names[] = {
342 {3, "system.posix_acl_default"},
343 {2, "system.posix_acl_access"},
344 {8, "system.richacl"},
352 static const char *find_ea_prefix(int index)
354 struct ea_name_index *e;
356 for (e = ea_names; e->name; e++)
357 if (e->index == index)
363 static int find_ea_index(const char *fullname, const char **name, int *index)
365 struct ea_name_index *e;
367 for (e = ea_names; e->name; e++) {
368 if (strncmp(fullname, e->name, strlen(e->name)) == 0) {
369 *name = fullname + strlen(e->name);
377 errcode_t ext2fs_free_ext_attr(ext2_filsys fs, ext2_ino_t ino,
378 struct ext2_inode_large *inode)
380 struct ext2_ext_attr_header *header;
381 void *block_buf = NULL;
384 struct ext2_inode_large i;
388 err = ext2fs_read_inode_full(fs, ino, (struct ext2_inode *)&i,
389 sizeof(struct ext2_inode_large));
395 /* Do we already have an EA block? */
396 blk = ext2fs_file_acl_block(fs, (struct ext2_inode *)inode);
400 /* Find block, zero it, write back */
401 if ((blk < fs->super->s_first_data_block) ||
402 (blk >= ext2fs_blocks_count(fs->super))) {
403 err = EXT2_ET_BAD_EA_BLOCK_NUM;
407 err = ext2fs_get_mem(fs->blocksize, &block_buf);
411 err = ext2fs_read_ext_attr3(fs, blk, block_buf, ino);
415 /* We only know how to deal with v2 EA blocks */
416 header = (struct ext2_ext_attr_header *) block_buf;
417 if (header->h_magic != EXT2_EXT_ATTR_MAGIC) {
418 err = EXT2_ET_BAD_EA_HEADER;
422 header->h_refcount--;
423 err = ext2fs_write_ext_attr3(fs, blk, block_buf, ino);
427 /* Erase link to block */
428 ext2fs_file_acl_block_set(fs, (struct ext2_inode *)inode, 0);
429 if (header->h_refcount == 0)
430 ext2fs_block_alloc_stats2(fs, blk, -1);
431 err = ext2fs_iblk_sub_blocks(fs, (struct ext2_inode *)inode, 1);
437 err = ext2fs_write_inode_full(fs, ino, (struct ext2_inode *)&i,
438 sizeof(struct ext2_inode_large));
444 ext2fs_free_mem(&block_buf);
449 static errcode_t prep_ea_block_for_write(ext2_filsys fs, ext2_ino_t ino,
450 struct ext2_inode_large *inode)
452 struct ext2_ext_attr_header *header;
453 void *block_buf = NULL;
457 /* Do we already have an EA block? */
458 blk = ext2fs_file_acl_block(fs, (struct ext2_inode *)inode);
460 if ((blk < fs->super->s_first_data_block) ||
461 (blk >= ext2fs_blocks_count(fs->super))) {
462 err = EXT2_ET_BAD_EA_BLOCK_NUM;
466 err = ext2fs_get_mem(fs->blocksize, &block_buf);
470 err = ext2fs_read_ext_attr3(fs, blk, block_buf, ino);
474 /* We only know how to deal with v2 EA blocks */
475 header = (struct ext2_ext_attr_header *) block_buf;
476 if (header->h_magic != EXT2_EXT_ATTR_MAGIC) {
477 err = EXT2_ET_BAD_EA_HEADER;
481 /* Single-user block. We're done here. */
482 if (header->h_refcount == 1)
485 /* We need to CoW the block. */
486 header->h_refcount--;
487 err = ext2fs_write_ext_attr3(fs, blk, block_buf, ino);
491 /* No block, we must increment i_blocks */
492 err = ext2fs_iblk_add_blocks(fs, (struct ext2_inode *)inode,
498 /* Allocate a block */
499 goal = ext2fs_find_inode_goal(fs, ino, (struct ext2_inode *)inode, 0);
500 err = ext2fs_alloc_block2(fs, goal, NULL, &blk);
503 ext2fs_file_acl_block_set(fs, (struct ext2_inode *)inode, blk);
506 ext2fs_free_mem(&block_buf);
513 posix_acl_xattr_count(size_t size)
515 if (size < sizeof(posix_acl_xattr_header))
517 size -= sizeof(posix_acl_xattr_header);
518 if (size % sizeof(posix_acl_xattr_entry))
520 return size / sizeof(posix_acl_xattr_entry);
524 * The lgetxattr function returns data formatted in the POSIX extended
525 * attribute format. The on-disk format uses a more compact encoding.
526 * See the ext4_acl_to_disk in fs/ext4/acl.c.
528 static errcode_t convert_posix_acl_to_disk_buffer(const void *value, size_t size,
529 void *out_buf, size_t *size_out)
531 const posix_acl_xattr_header *header =
532 (const posix_acl_xattr_header*) value;
533 const posix_acl_xattr_entry *end, *entry =
534 (const posix_acl_xattr_entry *)(header+1);
535 ext4_acl_header *ext_acl;
543 if (size < sizeof(posix_acl_xattr_header))
545 if (header->a_version != ext2fs_cpu_to_le32(POSIX_ACL_XATTR_VERSION))
548 count = posix_acl_xattr_count(size);
550 ext_acl->a_version = ext2fs_cpu_to_le32(EXT4_ACL_VERSION);
555 e = (char *) out_buf + sizeof(ext4_acl_header);
556 s = sizeof(ext4_acl_header);
557 for (end = entry + count; entry != end;entry++) {
558 ext4_acl_entry *disk_entry = (ext4_acl_entry*) e;
559 disk_entry->e_tag = ext2fs_cpu_to_le16(entry->e_tag);
560 disk_entry->e_perm = ext2fs_cpu_to_le16(entry->e_perm);
562 switch(entry->e_tag) {
567 e += sizeof(ext4_acl_entry_short);
568 s += sizeof(ext4_acl_entry_short);
572 disk_entry->e_id = ext2fs_cpu_to_le32(entry->e_id);
573 e += sizeof(ext4_acl_entry);
574 s += sizeof(ext4_acl_entry);
582 static errcode_t convert_disk_buffer_to_posix_acl(const void *value, size_t size,
583 void **out_buf, size_t *size_out)
585 posix_acl_xattr_header *header;
586 posix_acl_xattr_entry *entry;
587 const ext4_acl_header *ext_acl = (const ext4_acl_header *) value;
593 (size < sizeof(ext4_acl_header)) ||
594 (ext_acl->a_version != ext2fs_cpu_to_le32(EXT4_ACL_VERSION)))
597 err = ext2fs_get_mem(size * 2, &out);
601 header = (posix_acl_xattr_header *) out;
602 header->a_version = ext2fs_cpu_to_le32(POSIX_ACL_XATTR_VERSION);
603 entry = (posix_acl_xattr_entry *) (out + sizeof(posix_acl_xattr_header));
605 cp = (const char *) value + sizeof(ext4_acl_header);
606 size -= sizeof(ext4_acl_header);
609 const ext4_acl_entry *disk_entry = (const ext4_acl_entry *) cp;
611 entry->e_tag = ext2fs_le16_to_cpu(disk_entry->e_tag);
612 entry->e_perm = ext2fs_le16_to_cpu(disk_entry->e_perm);
614 switch(entry->e_tag) {
620 cp += sizeof(ext4_acl_entry_short);
621 size -= sizeof(ext4_acl_entry_short);
625 entry->e_id = ext2fs_le32_to_cpu(disk_entry->e_id);
626 cp += sizeof(ext4_acl_entry);
627 size -= sizeof(ext4_acl_entry);
630 ext2fs_free_mem(&out);
637 *size_out = ((char *) entry - out);
642 write_xattrs_to_buffer(ext2_filsys fs, struct ext2_xattr *attrs, int count,
643 void *entries_start, unsigned int storage_size,
644 unsigned int value_offset_correction, int write_hash)
646 struct ext2_xattr *x;
647 struct ext2_ext_attr_entry *e = entries_start;
648 char *end = (char *) entries_start + storage_size;
649 unsigned int value_size;
652 memset(entries_start, 0, storage_size);
653 for (x = attrs; x < attrs + count; x++) {
654 value_size = ((x->value_len + EXT2_EXT_ATTR_PAD - 1) /
655 EXT2_EXT_ATTR_PAD) * EXT2_EXT_ATTR_PAD;
657 /* Fill out e appropriately */
658 e->e_name_len = strlen(x->short_name);
659 e->e_name_index = x->name_index;
661 e->e_value_size = x->value_len;
662 e->e_value_inum = x->ea_ino;
665 memcpy((char *)e + sizeof(*e), x->short_name, e->e_name_len);
670 e->e_value_offs = end - (char *) entries_start +
671 value_offset_correction;
672 memcpy(end, x->value, e->e_value_size);
675 if (write_hash || x->ea_ino) {
676 err = ext2fs_ext_attr_hash_entry2(fs, e,
684 e = EXT2_EXT_ATTR_NEXT(e);
690 errcode_t ext2fs_xattrs_write(struct ext2_xattr_handle *handle)
692 ext2_filsys fs = handle->fs;
693 const unsigned int inode_size = EXT2_INODE_SIZE(fs->super);
694 struct ext2_inode_large *inode;
695 char *start, *block_buf = NULL;
696 struct ext2_ext_attr_header *header;
697 __u32 ea_inode_magic;
699 unsigned int storage_size;
703 EXT2_CHECK_MAGIC(handle, EXT2_ET_MAGIC_EA_HANDLE);
705 if (i < sizeof(*inode))
707 err = ext2fs_get_memzero(i, &inode);
711 err = ext2fs_read_inode_full(fs, handle->ino, EXT2_INODE(inode),
716 /* If extra_isize isn't set, we need to set it now */
717 if (inode->i_extra_isize == 0 &&
718 inode_size > EXT2_GOOD_OLD_INODE_SIZE) {
719 char *p = (char *)inode;
720 size_t extra = fs->super->s_want_extra_isize;
723 extra = sizeof(__u32);
724 memset(p + EXT2_GOOD_OLD_INODE_SIZE, 0, extra);
725 inode->i_extra_isize = extra;
727 if (inode->i_extra_isize & 3) {
728 err = EXT2_ET_INODE_CORRUPTED;
732 /* Does the inode have space for EA? */
733 if (inode->i_extra_isize < sizeof(inode->i_extra_isize) ||
734 inode_size <= EXT2_GOOD_OLD_INODE_SIZE + inode->i_extra_isize +
738 /* Write the inode EA */
739 ea_inode_magic = EXT2_EXT_ATTR_MAGIC;
740 memcpy(((char *) inode) + EXT2_GOOD_OLD_INODE_SIZE +
741 inode->i_extra_isize, &ea_inode_magic, sizeof(__u32));
742 storage_size = inode_size - EXT2_GOOD_OLD_INODE_SIZE -
743 inode->i_extra_isize - sizeof(__u32);
744 start = ((char *) inode) + EXT2_GOOD_OLD_INODE_SIZE +
745 inode->i_extra_isize + sizeof(__u32);
747 err = write_xattrs_to_buffer(fs, handle->attrs, handle->ibody_count,
748 start, storage_size, 0, 0);
753 if (handle->ibody_count == handle->count &&
754 !ext2fs_file_acl_block(fs, EXT2_INODE(inode)))
757 /* Write the EA block */
758 err = ext2fs_get_memzero(fs->blocksize, &block_buf);
762 storage_size = fs->blocksize - sizeof(struct ext2_ext_attr_header);
763 start = block_buf + sizeof(struct ext2_ext_attr_header);
765 err = write_xattrs_to_buffer(fs, handle->attrs + handle->ibody_count,
766 handle->count - handle->ibody_count, start,
767 storage_size, start - block_buf, 1);
771 /* Write a header on the EA block */
772 header = (struct ext2_ext_attr_header *) block_buf;
773 header->h_magic = EXT2_EXT_ATTR_MAGIC;
774 header->h_refcount = 1;
775 header->h_blocks = 1;
777 /* Get a new block for writing */
778 err = prep_ea_block_for_write(fs, handle->ino, inode);
782 /* Finally, write the new EA block */
783 blk = ext2fs_file_acl_block(fs, EXT2_INODE(inode));
784 err = ext2fs_write_ext_attr3(fs, blk, block_buf, handle->ino);
789 blk = ext2fs_file_acl_block(fs, (struct ext2_inode *)inode);
790 if (!block_buf && blk) {
791 /* xattrs shrunk, free the block */
792 err = ext2fs_free_ext_attr(fs, handle->ino, inode);
797 /* Write the inode */
798 err = ext2fs_write_inode_full(fs, handle->ino, EXT2_INODE(inode),
804 ext2fs_free_mem(&block_buf);
806 ext2fs_free_mem(&inode);
810 static errcode_t read_xattrs_from_buffer(struct ext2_xattr_handle *handle,
811 struct ext2_inode_large *inode,
812 struct ext2_ext_attr_entry *entries,
813 unsigned int storage_size,
816 struct ext2_xattr *x;
817 struct ext2_ext_attr_entry *entry, *end;
819 unsigned int remain, prefix_len;
821 unsigned int values_size = storage_size +
822 ((char *)entries - value_start);
826 remain = storage_size;
827 while (remain >= sizeof(struct ext2_ext_attr_entry) &&
828 !EXT2_EXT_IS_LAST_ENTRY(end)) {
830 /* header eats this space */
831 remain -= sizeof(struct ext2_ext_attr_entry);
833 /* is attribute name valid? */
834 if (EXT2_EXT_ATTR_SIZE(end->e_name_len) > remain)
835 return EXT2_ET_EA_BAD_NAME_LEN;
837 /* attribute len eats this space */
838 remain -= EXT2_EXT_ATTR_SIZE(end->e_name_len);
839 end = EXT2_EXT_ATTR_NEXT(end);
843 remain = storage_size;
844 while (remain >= sizeof(struct ext2_ext_attr_entry) &&
845 !EXT2_EXT_IS_LAST_ENTRY(entry)) {
847 /* Allocate space for more attrs? */
848 if (handle->count == handle->capacity) {
849 err = ext2fs_xattrs_expand(handle, 4);
854 x = handle->attrs + handle->count;
856 /* header eats this space */
857 remain -= sizeof(struct ext2_ext_attr_entry);
859 /* attribute len eats this space */
860 remain -= EXT2_EXT_ATTR_SIZE(entry->e_name_len);
863 prefix = find_ea_prefix(entry->e_name_index);
864 prefix_len = (prefix ? strlen(prefix) : 0);
865 err = ext2fs_get_memzero(entry->e_name_len + prefix_len + 1,
870 memcpy(x->name, prefix, prefix_len);
871 if (entry->e_name_len)
872 memcpy(x->name + prefix_len,
873 (char *)entry + sizeof(*entry),
875 x->short_name = x->name + prefix_len;
876 x->name_index = entry->e_name_index;
878 /* Check & copy value */
879 if (!ext2fs_has_feature_ea_inode(handle->fs->super) &&
880 entry->e_value_inum != 0)
881 return EXT2_ET_BAD_EA_BLOCK_NUM;
883 if (entry->e_value_inum == 0) {
884 if (entry->e_value_size > remain)
885 return EXT2_ET_EA_BAD_VALUE_SIZE;
887 if (entry->e_value_offs + entry->e_value_size > values_size)
888 return EXT2_ET_EA_BAD_VALUE_OFFSET;
890 if (entry->e_value_size > 0 &&
891 value_start + entry->e_value_offs <
892 (char *)end + sizeof(__u32))
893 return EXT2_ET_EA_BAD_VALUE_OFFSET;
895 remain -= entry->e_value_size;
897 err = ext2fs_get_mem(entry->e_value_size, &x->value);
900 memcpy(x->value, value_start + entry->e_value_offs,
901 entry->e_value_size);
903 struct ext2_inode *ea_inode;
906 if (entry->e_value_offs != 0)
907 return EXT2_ET_EA_BAD_VALUE_OFFSET;
909 if (entry->e_value_size > (64 * 1024))
910 return EXT2_ET_EA_BAD_VALUE_SIZE;
912 err = ext2fs_get_mem(entry->e_value_size, &x->value);
916 err = ext2fs_file_open(handle->fs, entry->e_value_inum,
921 ea_inode = ext2fs_file_get_inode(ea_file);
922 if ((ea_inode->i_flags & EXT4_INLINE_DATA_FL) ||
923 !(ea_inode->i_flags & EXT4_EA_INODE_FL) ||
924 ea_inode->i_links_count == 0)
925 err = EXT2_ET_EA_INODE_CORRUPTED;
926 else if ((__u64) ext2fs_file_get_size(ea_file) !=
928 err = EXT2_ET_EA_BAD_VALUE_SIZE;
930 err = ext2fs_file_read(ea_file, x->value,
931 entry->e_value_size, 0);
932 ext2fs_file_close(ea_file);
937 x->ea_ino = entry->e_value_inum;
938 x->value_len = entry->e_value_size;
940 /* e_hash may be 0 in older inode's ea */
941 if (entry->e_hash != 0) {
943 void *data = (entry->e_value_inum != 0) ?
944 0 : value_start + entry->e_value_offs;
946 err = ext2fs_ext_attr_hash_entry2(handle->fs, entry,
950 if (entry->e_hash != hash) {
951 struct ext2_inode child;
953 /* Check whether this is an old Lustre-style
954 * ea_inode reference.
956 err = ext2fs_read_inode(handle->fs,
961 if (child.i_mtime != handle->ino ||
962 child.i_generation != inode->i_generation)
963 return EXT2_ET_BAD_EA_HASH;
968 entry = EXT2_EXT_ATTR_NEXT(entry);
974 static void xattrs_free_keys(struct ext2_xattr_handle *h)
976 struct ext2_xattr *a = h->attrs;
979 for (i = 0; i < h->capacity; i++) {
981 ext2fs_free_mem(&a[i].name);
983 ext2fs_free_mem(&a[i].value);
989 errcode_t ext2fs_xattrs_read(struct ext2_xattr_handle *handle)
991 struct ext2_inode_large *inode;
992 struct ext2_ext_attr_header *header;
993 __u32 ea_inode_magic;
994 unsigned int storage_size;
995 char *start, *block_buf = NULL;
1000 EXT2_CHECK_MAGIC(handle, EXT2_ET_MAGIC_EA_HANDLE);
1001 i = EXT2_INODE_SIZE(handle->fs->super);
1002 if (i < sizeof(*inode))
1004 err = ext2fs_get_memzero(i, &inode);
1008 err = ext2fs_read_inode_full(handle->fs, handle->ino,
1009 (struct ext2_inode *)inode,
1010 EXT2_INODE_SIZE(handle->fs->super));
1014 xattrs_free_keys(handle);
1016 /* Does the inode have space for EA? */
1017 if (inode->i_extra_isize < sizeof(inode->i_extra_isize) ||
1018 EXT2_INODE_SIZE(handle->fs->super) <= EXT2_GOOD_OLD_INODE_SIZE +
1019 inode->i_extra_isize +
1022 if (inode->i_extra_isize & 3) {
1023 err = EXT2_ET_INODE_CORRUPTED;
1027 /* Look for EA in the inode */
1028 memcpy(&ea_inode_magic, ((char *) inode) + EXT2_GOOD_OLD_INODE_SIZE +
1029 inode->i_extra_isize, sizeof(__u32));
1030 if (ea_inode_magic == EXT2_EXT_ATTR_MAGIC) {
1031 storage_size = EXT2_INODE_SIZE(handle->fs->super) -
1032 EXT2_GOOD_OLD_INODE_SIZE - inode->i_extra_isize -
1034 start = ((char *) inode) + EXT2_GOOD_OLD_INODE_SIZE +
1035 inode->i_extra_isize + sizeof(__u32);
1037 err = read_xattrs_from_buffer(handle, inode,
1038 (struct ext2_ext_attr_entry *) start,
1039 storage_size, start);
1043 handle->ibody_count = handle->count;
1047 /* Look for EA in a separate EA block */
1048 blk = ext2fs_file_acl_block(handle->fs, (struct ext2_inode *)inode);
1050 if ((blk < handle->fs->super->s_first_data_block) ||
1051 (blk >= ext2fs_blocks_count(handle->fs->super))) {
1052 err = EXT2_ET_BAD_EA_BLOCK_NUM;
1056 err = ext2fs_get_mem(handle->fs->blocksize, &block_buf);
1060 err = ext2fs_read_ext_attr3(handle->fs, blk, block_buf,
1065 /* We only know how to deal with v2 EA blocks */
1066 header = (struct ext2_ext_attr_header *) block_buf;
1067 if (header->h_magic != EXT2_EXT_ATTR_MAGIC) {
1068 err = EXT2_ET_BAD_EA_HEADER;
1073 storage_size = handle->fs->blocksize -
1074 sizeof(struct ext2_ext_attr_header);
1075 start = block_buf + sizeof(struct ext2_ext_attr_header);
1076 err = read_xattrs_from_buffer(handle, inode,
1077 (struct ext2_ext_attr_entry *) start,
1078 storage_size, block_buf);
1082 ext2fs_free_mem(&block_buf);
1085 ext2fs_free_mem(&block_buf);
1086 ext2fs_free_mem(&inode);
1090 ext2fs_free_mem(&block_buf);
1092 ext2fs_free_mem(&inode);
1096 errcode_t ext2fs_xattrs_iterate(struct ext2_xattr_handle *h,
1097 int (*func)(char *name, char *value,
1098 size_t value_len, void *data),
1101 struct ext2_xattr *x;
1105 EXT2_CHECK_MAGIC(h, EXT2_ET_MAGIC_EA_HANDLE);
1106 for (x = h->attrs; x < h->attrs + h->count; x++) {
1107 ret = func(x->name, x->value, x->value_len, data);
1108 if (ret & XATTR_CHANGED)
1110 if (ret & XATTR_ABORT)
1115 return ext2fs_xattrs_write(h);
1119 errcode_t ext2fs_xattr_get(struct ext2_xattr_handle *h, const char *key,
1120 void **value, size_t *value_len)
1122 struct ext2_xattr *x;
1126 EXT2_CHECK_MAGIC(h, EXT2_ET_MAGIC_EA_HANDLE);
1127 for (x = h->attrs; x < h->attrs + h->count; x++) {
1128 if (strcmp(x->name, key))
1131 if (!(h->flags & XATTR_HANDLE_FLAG_RAW) &&
1132 ((strcmp(key, "system.posix_acl_default") == 0) ||
1133 (strcmp(key, "system.posix_acl_access") == 0))) {
1134 err = convert_disk_buffer_to_posix_acl(x->value, x->value_len,
1138 err = ext2fs_get_mem(x->value_len, &val);
1141 memcpy(val, x->value, x->value_len);
1143 *value_len = x->value_len;
1148 return EXT2_ET_EA_KEY_NOT_FOUND;
1151 errcode_t ext2fs_xattr_inode_max_size(ext2_filsys fs, ext2_ino_t ino,
1154 struct ext2_ext_attr_entry *entry;
1155 struct ext2_inode_large *inode;
1156 __u32 ea_inode_magic;
1157 unsigned int minoff;
1162 i = EXT2_INODE_SIZE(fs->super);
1163 if (i < sizeof(*inode))
1165 err = ext2fs_get_memzero(i, &inode);
1169 err = ext2fs_read_inode_full(fs, ino, (struct ext2_inode *)inode,
1170 EXT2_INODE_SIZE(fs->super));
1174 /* Does the inode have size for EA? */
1175 if (EXT2_INODE_SIZE(fs->super) <= EXT2_GOOD_OLD_INODE_SIZE +
1176 inode->i_extra_isize +
1178 err = EXT2_ET_INLINE_DATA_NO_SPACE;
1182 minoff = EXT2_INODE_SIZE(fs->super) - sizeof(*inode) - sizeof(__u32);
1183 memcpy(&ea_inode_magic, ((char *) inode) + EXT2_GOOD_OLD_INODE_SIZE +
1184 inode->i_extra_isize, sizeof(__u32));
1185 if (ea_inode_magic == EXT2_EXT_ATTR_MAGIC) {
1186 /* has xattrs. calculate the size */
1187 start= ((char *) inode) + EXT2_GOOD_OLD_INODE_SIZE +
1188 inode->i_extra_isize + sizeof(__u32);
1189 entry = (struct ext2_ext_attr_entry *) start;
1190 while (!EXT2_EXT_IS_LAST_ENTRY(entry)) {
1191 if (!entry->e_value_inum && entry->e_value_size) {
1192 unsigned int offs = entry->e_value_offs;
1196 entry = EXT2_EXT_ATTR_NEXT(entry);
1198 *size = minoff - ((char *)entry - (char *)start) - sizeof(__u32);
1200 /* no xattr. return a maximum size */
1201 *size = EXT2_EXT_ATTR_SIZE(minoff -
1202 EXT2_EXT_ATTR_LEN(strlen("data")) -
1203 EXT2_EXT_ATTR_ROUND - sizeof(__u32));
1207 ext2fs_free_mem(&inode);
1211 static errcode_t xattr_create_ea_inode(ext2_filsys fs, const void *value,
1212 size_t value_len, ext2_ino_t *ea_ino)
1214 struct ext2_inode inode;
1220 ret = ext2fs_new_inode(fs, 0, 0, 0, &ino);
1224 memset(&inode, 0, sizeof(inode));
1225 inode.i_flags |= EXT4_EA_INODE_FL;
1226 if (ext2fs_has_feature_extents(fs->super))
1227 inode.i_flags |= EXT4_EXTENTS_FL;
1229 inode.i_mode = LINUX_S_IFREG | 0600;
1230 inode.i_links_count = 1;
1231 ret = ext2fs_write_new_inode(fs, ino, &inode);
1235 * ref_count and hash utilize inode's i_*time fields.
1236 * ext2fs_write_new_inode() call above initializes these fields with
1237 * current time. That's why ref count and hash updates are done
1240 ext2fs_set_ea_inode_ref(&inode, 1);
1241 hash = ext2fs_crc32c_le(fs->csum_seed, value, value_len);
1242 ext2fs_set_ea_inode_hash(&inode, hash);
1244 ret = ext2fs_write_inode(fs, ino, &inode);
1248 ret = ext2fs_file_open(fs, ino, EXT2_FILE_WRITE, &file);
1251 ret = ext2fs_file_write(file, value, value_len, NULL);
1252 ext2fs_file_close(file);
1256 ext2fs_inode_alloc_stats2(fs, ino, 1 /* inuse */, 0 /* isdir */);
1262 static errcode_t xattr_inode_dec_ref(ext2_filsys fs, ext2_ino_t ino)
1264 struct ext2_inode_large inode;
1268 ret = ext2fs_read_inode_full(fs, ino, (struct ext2_inode *)&inode,
1273 ref_count = ext2fs_get_ea_inode_ref(EXT2_INODE(&inode));
1275 ext2fs_set_ea_inode_ref(EXT2_INODE(&inode), ref_count);
1280 inode.i_links_count = 0;
1281 inode.i_dtime = fs->now ? fs->now : time(0);
1283 ret = ext2fs_free_ext_attr(fs, ino, &inode);
1287 if (ext2fs_inode_has_valid_blocks2(fs, (struct ext2_inode *)&inode)) {
1288 ret = ext2fs_punch(fs, ino, (struct ext2_inode *)&inode, NULL,
1294 ext2fs_inode_alloc_stats2(fs, ino, -1 /* inuse */, 0 /* is_dir */);
1297 ret = ext2fs_write_inode_full(fs, ino, (struct ext2_inode *)&inode,
1303 static errcode_t xattr_update_entry(ext2_filsys fs, struct ext2_xattr *x,
1304 const char *name, const char *short_name,
1305 int index, const void *value,
1306 size_t value_len, int in_inode)
1308 ext2_ino_t ea_ino = 0;
1309 void *new_value = NULL;
1310 char *new_name = NULL;
1315 name_len = strlen(name);
1316 ret = ext2fs_get_mem(name_len + 1, &new_name);
1319 memcpy(new_name, name, name_len + 1);
1322 ret = ext2fs_get_mem(value_len, &new_value);
1325 memcpy(new_value, value, value_len);
1328 ret = xattr_create_ea_inode(fs, value, value_len, &ea_ino);
1334 ret = xattr_inode_dec_ref(fs, x->ea_ino);
1341 x->short_name = new_name + (short_name - name);
1343 x->name_index = index;
1346 ext2fs_free_mem(&x->value);
1347 x->value = new_value;
1348 x->value_len = value_len;
1353 ext2fs_free_mem(&new_name);
1355 ext2fs_free_mem(&new_value);
1357 xattr_inode_dec_ref(fs, ea_ino);
1361 static int xattr_find_position(struct ext2_xattr *attrs, int count,
1362 const char *shortname, int name_idx)
1364 struct ext2_xattr *x;
1366 int shortname_len, x_shortname_len;
1368 shortname_len = strlen(shortname);
1370 for (i = 0, x = attrs; i < count; i++, x++) {
1371 if (name_idx < x->name_index)
1373 if (name_idx > x->name_index)
1376 x_shortname_len = strlen(x->short_name);
1377 if (shortname_len < x_shortname_len)
1379 if (shortname_len > x_shortname_len)
1382 if (memcmp(shortname, x->short_name, shortname_len) <= 0)
1388 static errcode_t xattr_array_update(struct ext2_xattr_handle *h,
1390 const void *value, size_t value_len,
1391 int ibody_free, int block_free,
1392 int old_idx, int in_inode)
1394 struct ext2_xattr tmp;
1397 int name_len, name_idx = 0;
1398 const char *shortname = name;
1402 find_ea_index(name, &shortname, &name_idx);
1403 name_len = strlen(shortname);
1405 needed = EXT2_EXT_ATTR_LEN(name_len);
1407 needed += EXT2_EXT_ATTR_SIZE(value_len);
1409 if (old_idx >= 0 && old_idx < h->ibody_count) {
1410 ibody_free += EXT2_EXT_ATTR_LEN(name_len);
1411 if (!h->attrs[old_idx].ea_ino)
1412 ibody_free += EXT2_EXT_ATTR_SIZE(
1413 h->attrs[old_idx].value_len);
1416 if (needed <= ibody_free) {
1418 new_idx = h->ibody_count;
1423 /* Update the existing entry. */
1424 ret = xattr_update_entry(h->fs, &h->attrs[old_idx], name,
1425 shortname, name_idx, value,
1426 value_len, in_inode);
1429 if (h->ibody_count <= old_idx) {
1430 /* Move entry from block to the end of ibody. */
1431 tmp = h->attrs[old_idx];
1432 memmove(h->attrs + h->ibody_count + 1,
1433 h->attrs + h->ibody_count,
1434 (old_idx - h->ibody_count) * sizeof(*h->attrs));
1435 h->attrs[h->ibody_count] = tmp;
1441 if (h->ibody_count <= old_idx) {
1442 block_free += EXT2_EXT_ATTR_LEN(name_len);
1443 if (!h->attrs[old_idx].ea_ino)
1445 EXT2_EXT_ATTR_SIZE(h->attrs[old_idx].value_len);
1448 if (needed > block_free)
1449 return EXT2_ET_EA_NO_SPACE;
1452 /* Update the existing entry. */
1453 ret = xattr_update_entry(h->fs, &h->attrs[old_idx], name,
1454 shortname, name_idx, value,
1455 value_len, in_inode);
1458 if (old_idx < h->ibody_count) {
1460 * Move entry from ibody to the block. Note that
1461 * entries in the block are sorted.
1463 new_idx = xattr_find_position(h->attrs + h->ibody_count,
1464 h->count - h->ibody_count,
1465 shortname, name_idx);
1466 new_idx += h->ibody_count - 1;
1467 tmp = h->attrs[old_idx];
1468 memmove(h->attrs + old_idx, h->attrs + old_idx + 1,
1469 (new_idx - old_idx) * sizeof(*h->attrs));
1470 h->attrs[new_idx] = tmp;
1476 new_idx = xattr_find_position(h->attrs + h->ibody_count,
1477 h->count - h->ibody_count,
1478 shortname, name_idx);
1479 new_idx += h->ibody_count;
1483 if (h->count == h->capacity) {
1484 ret = ext2fs_xattrs_expand(h, 4);
1489 ret = xattr_update_entry(h->fs, &h->attrs[h->count], name, shortname,
1490 name_idx, value, value_len, in_inode);
1494 tmp = h->attrs[h->count];
1495 memmove(h->attrs + new_idx + 1, h->attrs + new_idx,
1496 (h->count - new_idx)*sizeof(*h->attrs));
1497 h->attrs[new_idx] = tmp;
1504 static int space_used(struct ext2_xattr *attrs, int count)
1507 struct ext2_xattr *x;
1510 for (i = 0, x = attrs; i < count; i++, x++) {
1511 len = strlen(x->short_name);
1512 total += EXT2_EXT_ATTR_LEN(len);
1514 total += EXT2_EXT_ATTR_SIZE(x->value_len);
1520 * The minimum size of EA value when you start storing it in an external inode
1521 * size of block - size of header - size of 1 entry - 4 null bytes
1523 #define EXT4_XATTR_MIN_LARGE_EA_SIZE(b) \
1524 ((b) - EXT2_EXT_ATTR_LEN(3) - sizeof(struct ext2_ext_attr_header) - 4)
1526 errcode_t ext2fs_xattr_set(struct ext2_xattr_handle *h,
1531 ext2_filsys fs = h->fs;
1532 const int inode_size = EXT2_INODE_SIZE(fs->super);
1533 struct ext2_inode_large *inode = NULL;
1534 struct ext2_xattr *x;
1536 int ibody_free, block_free;
1542 EXT2_CHECK_MAGIC(h, EXT2_ET_MAGIC_EA_HANDLE);
1544 ret = ext2fs_get_mem(value_len, &new_value);
1547 if (!(h->flags & XATTR_HANDLE_FLAG_RAW) &&
1548 ((strcmp(name, "system.posix_acl_default") == 0) ||
1549 (strcmp(name, "system.posix_acl_access") == 0))) {
1550 ret = convert_posix_acl_to_disk_buffer(value, value_len,
1551 new_value, &value_len);
1554 } else if (value_len)
1555 memcpy(new_value, value, value_len);
1557 /* Imitate kernel behavior by skipping update if value is the same. */
1558 for (x = h->attrs; x < h->attrs + h->count; x++) {
1559 if (!strcmp(x->name, name)) {
1560 if (!x->ea_ino && x->value_len == value_len &&
1562 !memcmp(x->value, new_value, value_len))) {
1566 old_idx = x - h->attrs;
1571 ret = ext2fs_get_memzero(inode_size, &inode);
1574 ret = ext2fs_read_inode_full(fs, h->ino,
1575 (struct ext2_inode *)inode,
1579 if (inode_size > EXT2_GOOD_OLD_INODE_SIZE) {
1580 extra_isize = inode->i_extra_isize;
1581 if (extra_isize == 0) {
1582 extra_isize = fs->super->s_want_extra_isize;
1583 if (extra_isize == 0)
1584 extra_isize = sizeof(__u32);
1586 ibody_free = inode_size - EXT2_GOOD_OLD_INODE_SIZE;
1587 ibody_free -= extra_isize;
1588 /* Extended attribute magic and final null entry. */
1589 ibody_free -= sizeof(__u32) * 2;
1590 ibody_free -= space_used(h->attrs, h->ibody_count);
1594 /* Inline data can only go to ibody. */
1595 if (strcmp(name, "system.data") == 0) {
1596 if (h->ibody_count <= old_idx) {
1597 ret = EXT2_ET_FILESYSTEM_CORRUPTED;
1600 ret = xattr_array_update(h, name, new_value, value_len,
1602 0 /* block_free */, old_idx,
1609 block_free = fs->blocksize;
1610 block_free -= sizeof(struct ext2_ext_attr_header);
1611 /* Final null entry. */
1612 block_free -= sizeof(__u32);
1613 block_free -= space_used(h->attrs + h->ibody_count,
1614 h->count - h->ibody_count);
1616 if (ext2fs_has_feature_ea_inode(fs->super) &&
1617 value_len > EXT4_XATTR_MIN_LARGE_EA_SIZE(fs->blocksize))
1620 ret = xattr_array_update(h, name, new_value, value_len, ibody_free,
1621 block_free, old_idx, in_inode);
1622 if (ret == EXT2_ET_EA_NO_SPACE && !in_inode &&
1623 ext2fs_has_feature_ea_inode(fs->super))
1624 ret = xattr_array_update(h, name, new_value, value_len,
1625 ibody_free, block_free, old_idx, 1 /* in_inode */);
1630 ret = ext2fs_xattrs_write(h);
1633 ext2fs_free_mem(&inode);
1634 ext2fs_free_mem(&new_value);
1638 errcode_t ext2fs_xattr_remove(struct ext2_xattr_handle *handle,
1641 struct ext2_xattr *x;
1642 struct ext2_xattr *end = handle->attrs + handle->count;
1644 EXT2_CHECK_MAGIC(handle, EXT2_ET_MAGIC_EA_HANDLE);
1645 for (x = handle->attrs; x < end; x++) {
1646 if (strcmp(x->name, key) == 0) {
1647 ext2fs_free_mem(&x->name);
1648 ext2fs_free_mem(&x->value);
1650 xattr_inode_dec_ref(handle->fs, x->ea_ino);
1651 memmove(x, x + 1, (end - x - 1)*sizeof(*x));
1652 memset(end - 1, 0, sizeof(*end));
1653 if (x < handle->attrs + handle->ibody_count)
1654 handle->ibody_count--;
1656 return ext2fs_xattrs_write(handle);
1660 /* no key found, success! */
1664 errcode_t ext2fs_xattrs_open(ext2_filsys fs, ext2_ino_t ino,
1665 struct ext2_xattr_handle **handle)
1667 struct ext2_xattr_handle *h;
1670 if (!ext2fs_has_feature_xattr(fs->super) &&
1671 !ext2fs_has_feature_inline_data(fs->super))
1672 return EXT2_ET_MISSING_EA_FEATURE;
1674 err = ext2fs_get_memzero(sizeof(*h), &h);
1678 h->magic = EXT2_ET_MAGIC_EA_HANDLE;
1680 err = ext2fs_get_arrayzero(h->capacity, sizeof(struct ext2_xattr),
1683 ext2fs_free_mem(&h);
1693 errcode_t ext2fs_xattrs_close(struct ext2_xattr_handle **handle)
1695 struct ext2_xattr_handle *h = *handle;
1697 EXT2_CHECK_MAGIC(h, EXT2_ET_MAGIC_EA_HANDLE);
1698 xattrs_free_keys(h);
1699 ext2fs_free_mem(&h->attrs);
1700 ext2fs_free_mem(handle);
1704 errcode_t ext2fs_xattrs_count(struct ext2_xattr_handle *handle, size_t *count)
1706 EXT2_CHECK_MAGIC(handle, EXT2_ET_MAGIC_EA_HANDLE);
1707 *count = handle->count;
1711 errcode_t ext2fs_xattrs_flags(struct ext2_xattr_handle *handle,
1712 unsigned int *new_flags, unsigned int *old_flags)
1714 EXT2_CHECK_MAGIC(handle, EXT2_ET_MAGIC_EA_HANDLE);
1716 *old_flags = handle->flags;
1718 handle->flags = *new_flags;