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 */
298 unsigned int value_len;
302 struct ext2_xattr_handle {
305 struct ext2_xattr *attrs;
313 static errcode_t ext2fs_xattrs_expand(struct ext2_xattr_handle *h,
314 unsigned int expandby)
316 struct ext2_xattr *new_attrs;
319 err = ext2fs_get_arrayzero(h->capacity + expandby,
320 sizeof(struct ext2_xattr), &new_attrs);
324 memcpy(new_attrs, h->attrs, h->capacity * sizeof(struct ext2_xattr));
325 ext2fs_free_mem(&h->attrs);
326 h->capacity += expandby;
327 h->attrs = new_attrs;
332 struct ea_name_index {
337 /* Keep these names sorted in order of decreasing specificity. */
338 static struct ea_name_index ea_names[] = {
339 {3, "system.posix_acl_default"},
340 {2, "system.posix_acl_access"},
341 {8, "system.richacl"},
349 static const char *find_ea_prefix(int index)
351 struct ea_name_index *e;
353 for (e = ea_names; e->name; e++)
354 if (e->index == index)
360 static int find_ea_index(const char *fullname, char **name, int *index)
362 struct ea_name_index *e;
364 for (e = ea_names; e->name; e++) {
365 if (strncmp(fullname, e->name, strlen(e->name)) == 0) {
366 *name = (char *)fullname + strlen(e->name);
374 errcode_t ext2fs_free_ext_attr(ext2_filsys fs, ext2_ino_t ino,
375 struct ext2_inode_large *inode)
377 struct ext2_ext_attr_header *header;
378 void *block_buf = NULL;
381 struct ext2_inode_large i;
385 err = ext2fs_read_inode_full(fs, ino, (struct ext2_inode *)&i,
386 sizeof(struct ext2_inode_large));
392 /* Do we already have an EA block? */
393 blk = ext2fs_file_acl_block(fs, (struct ext2_inode *)inode);
397 /* Find block, zero it, write back */
398 if ((blk < fs->super->s_first_data_block) ||
399 (blk >= ext2fs_blocks_count(fs->super))) {
400 err = EXT2_ET_BAD_EA_BLOCK_NUM;
404 err = ext2fs_get_mem(fs->blocksize, &block_buf);
408 err = ext2fs_read_ext_attr3(fs, blk, block_buf, ino);
412 /* We only know how to deal with v2 EA blocks */
413 header = (struct ext2_ext_attr_header *) block_buf;
414 if (header->h_magic != EXT2_EXT_ATTR_MAGIC) {
415 err = EXT2_ET_BAD_EA_HEADER;
419 header->h_refcount--;
420 err = ext2fs_write_ext_attr3(fs, blk, block_buf, ino);
424 /* Erase link to block */
425 ext2fs_file_acl_block_set(fs, (struct ext2_inode *)inode, 0);
426 if (header->h_refcount == 0)
427 ext2fs_block_alloc_stats2(fs, blk, -1);
428 err = ext2fs_iblk_sub_blocks(fs, (struct ext2_inode *)inode, 1);
434 err = ext2fs_write_inode_full(fs, ino, (struct ext2_inode *)&i,
435 sizeof(struct ext2_inode_large));
441 ext2fs_free_mem(&block_buf);
446 static errcode_t prep_ea_block_for_write(ext2_filsys fs, ext2_ino_t ino,
447 struct ext2_inode_large *inode)
449 struct ext2_ext_attr_header *header;
450 void *block_buf = NULL;
454 /* Do we already have an EA block? */
455 blk = ext2fs_file_acl_block(fs, (struct ext2_inode *)inode);
457 if ((blk < fs->super->s_first_data_block) ||
458 (blk >= ext2fs_blocks_count(fs->super))) {
459 err = EXT2_ET_BAD_EA_BLOCK_NUM;
463 err = ext2fs_get_mem(fs->blocksize, &block_buf);
467 err = ext2fs_read_ext_attr3(fs, blk, block_buf, ino);
471 /* We only know how to deal with v2 EA blocks */
472 header = (struct ext2_ext_attr_header *) block_buf;
473 if (header->h_magic != EXT2_EXT_ATTR_MAGIC) {
474 err = EXT2_ET_BAD_EA_HEADER;
478 /* Single-user block. We're done here. */
479 if (header->h_refcount == 1)
482 /* We need to CoW the block. */
483 header->h_refcount--;
484 err = ext2fs_write_ext_attr3(fs, blk, block_buf, ino);
488 /* No block, we must increment i_blocks */
489 err = ext2fs_iblk_add_blocks(fs, (struct ext2_inode *)inode,
495 /* Allocate a block */
496 goal = ext2fs_find_inode_goal(fs, ino, (struct ext2_inode *)inode, 0);
497 err = ext2fs_alloc_block2(fs, goal, NULL, &blk);
500 ext2fs_file_acl_block_set(fs, (struct ext2_inode *)inode, blk);
503 ext2fs_free_mem(&block_buf);
510 posix_acl_xattr_count(size_t size)
512 if (size < sizeof(posix_acl_xattr_header))
514 size -= sizeof(posix_acl_xattr_header);
515 if (size % sizeof(posix_acl_xattr_entry))
517 return size / sizeof(posix_acl_xattr_entry);
521 * The lgetxattr function returns data formatted in the POSIX extended
522 * attribute format. The on-disk format uses a more compact encoding.
523 * See the ext4_acl_to_disk in fs/ext4/acl.c.
525 static errcode_t convert_posix_acl_to_disk_buffer(const void *value, size_t size,
526 void *out_buf, size_t *size_out)
528 posix_acl_xattr_header *header = (posix_acl_xattr_header*) value;
529 posix_acl_xattr_entry *entry = (posix_acl_xattr_entry *)(header+1), *end;
530 ext4_acl_header *ext_acl;
538 if (size < sizeof(posix_acl_xattr_header))
540 if (header->a_version != ext2fs_cpu_to_le32(POSIX_ACL_XATTR_VERSION))
543 count = posix_acl_xattr_count(size);
545 ext_acl->a_version = ext2fs_cpu_to_le32(EXT4_ACL_VERSION);
550 e = (char *) out_buf + sizeof(ext4_acl_header);
551 s = sizeof(ext4_acl_header);
552 for (end = entry + count; entry != end;entry++) {
553 ext4_acl_entry *disk_entry = (ext4_acl_entry*) e;
554 disk_entry->e_tag = ext2fs_cpu_to_le16(entry->e_tag);
555 disk_entry->e_perm = ext2fs_cpu_to_le16(entry->e_perm);
557 switch(entry->e_tag) {
562 e += sizeof(ext4_acl_entry_short);
563 s += sizeof(ext4_acl_entry_short);
567 disk_entry->e_id = ext2fs_cpu_to_le32(entry->e_id);
568 e += sizeof(ext4_acl_entry);
569 s += sizeof(ext4_acl_entry);
577 static errcode_t convert_disk_buffer_to_posix_acl(const void *value, size_t size,
578 void **out_buf, size_t *size_out)
580 posix_acl_xattr_header *header;
581 posix_acl_xattr_entry *entry;
582 ext4_acl_header *ext_acl = (ext4_acl_header *) value;
588 (size < sizeof(ext4_acl_header)) ||
589 (ext_acl->a_version != ext2fs_cpu_to_le32(EXT4_ACL_VERSION)))
592 err = ext2fs_get_mem(size * 2, &out);
596 header = (posix_acl_xattr_header *) out;
597 header->a_version = ext2fs_cpu_to_le32(POSIX_ACL_XATTR_VERSION);
598 entry = (posix_acl_xattr_entry *) (out + sizeof(posix_acl_xattr_header));
600 cp = value + sizeof(ext4_acl_header);
601 size -= sizeof(ext4_acl_header);
604 const ext4_acl_entry *disk_entry = (const ext4_acl_entry *) cp;
606 entry->e_tag = ext2fs_le16_to_cpu(disk_entry->e_tag);
607 entry->e_perm = ext2fs_le16_to_cpu(disk_entry->e_perm);
609 switch(entry->e_tag) {
615 cp += sizeof(ext4_acl_entry_short);
616 size -= sizeof(ext4_acl_entry_short);
620 entry->e_id = ext2fs_le32_to_cpu(disk_entry->e_id);
621 cp += sizeof(ext4_acl_entry);
622 size -= sizeof(ext4_acl_entry);
625 ext2fs_free_mem(&out);
632 *size_out = ((char *) entry - out);
637 write_xattrs_to_buffer(ext2_filsys fs, struct ext2_xattr *attrs, int count,
638 void *entries_start, unsigned int storage_size,
639 unsigned int value_offset_correction, int write_hash)
641 struct ext2_xattr *x;
642 struct ext2_ext_attr_entry *e = entries_start;
643 void *end = entries_start + storage_size;
645 unsigned int entry_size, value_size;
649 memset(entries_start, 0, storage_size);
650 for (x = attrs; x < attrs + count; x++) {
651 /* Calculate index and shortname position */
653 ret = find_ea_index(x->name, &shortname, &idx);
655 /* Calculate entry and value size */
656 entry_size = (sizeof(*e) + strlen(shortname) +
657 EXT2_EXT_ATTR_PAD - 1) &
658 ~(EXT2_EXT_ATTR_PAD - 1);
659 value_size = ((x->value_len + EXT2_EXT_ATTR_PAD - 1) /
660 EXT2_EXT_ATTR_PAD) * EXT2_EXT_ATTR_PAD;
662 /* Fill out e appropriately */
663 e->e_name_len = strlen(shortname);
664 e->e_name_index = (ret ? idx : 0);
666 e->e_value_size = x->value_len;
667 e->e_value_inum = x->ea_ino;
670 memcpy((char *)e + sizeof(*e), shortname, e->e_name_len);
675 e->e_value_offs = end - entries_start +
676 value_offset_correction;
677 memcpy(end, x->value, e->e_value_size);
680 if (write_hash || x->ea_ino) {
681 err = ext2fs_ext_attr_hash_entry2(fs, e,
689 e = EXT2_EXT_ATTR_NEXT(e);
695 errcode_t ext2fs_xattrs_write(struct ext2_xattr_handle *handle)
697 ext2_filsys fs = handle->fs;
698 const int inode_size = EXT2_INODE_SIZE(fs->super);
699 struct ext2_inode_large *inode;
700 char *start, *block_buf = NULL;
701 struct ext2_ext_attr_header *header;
702 __u32 ea_inode_magic;
704 unsigned int storage_size;
708 EXT2_CHECK_MAGIC(handle, EXT2_ET_MAGIC_EA_HANDLE);
710 if (i < sizeof(*inode))
712 err = ext2fs_get_memzero(i, &inode);
716 err = ext2fs_read_inode_full(fs, handle->ino, EXT2_INODE(inode),
721 /* If extra_isize isn't set, we need to set it now */
722 if (inode->i_extra_isize == 0 &&
723 inode_size > EXT2_GOOD_OLD_INODE_SIZE) {
724 char *p = (char *)inode;
725 size_t extra = fs->super->s_want_extra_isize;
728 extra = sizeof(__u32);
729 memset(p + EXT2_GOOD_OLD_INODE_SIZE, 0, extra);
730 inode->i_extra_isize = extra;
732 if (inode->i_extra_isize & 3) {
733 err = EXT2_ET_INODE_CORRUPTED;
737 /* Does the inode have space for EA? */
738 if (inode->i_extra_isize < sizeof(inode->i_extra_isize) ||
739 inode_size <= EXT2_GOOD_OLD_INODE_SIZE + inode->i_extra_isize +
743 /* Write the inode EA */
744 ea_inode_magic = EXT2_EXT_ATTR_MAGIC;
745 memcpy(((char *) inode) + EXT2_GOOD_OLD_INODE_SIZE +
746 inode->i_extra_isize, &ea_inode_magic, sizeof(__u32));
747 storage_size = inode_size - EXT2_GOOD_OLD_INODE_SIZE -
748 inode->i_extra_isize - sizeof(__u32);
749 start = ((char *) inode) + EXT2_GOOD_OLD_INODE_SIZE +
750 inode->i_extra_isize + sizeof(__u32);
752 err = write_xattrs_to_buffer(fs, handle->attrs, handle->ibody_count,
753 start, storage_size, 0, 0);
758 if (handle->ibody_count == handle->count &&
759 !ext2fs_file_acl_block(fs, EXT2_INODE(inode)))
762 /* Write the EA block */
763 err = ext2fs_get_memzero(fs->blocksize, &block_buf);
767 storage_size = fs->blocksize - sizeof(struct ext2_ext_attr_header);
768 start = block_buf + sizeof(struct ext2_ext_attr_header);
770 err = write_xattrs_to_buffer(fs, handle->attrs + handle->ibody_count,
771 handle->count - handle->ibody_count, start,
772 storage_size, start - block_buf, 1);
776 /* Write a header on the EA block */
777 header = (struct ext2_ext_attr_header *) block_buf;
778 header->h_magic = EXT2_EXT_ATTR_MAGIC;
779 header->h_refcount = 1;
780 header->h_blocks = 1;
782 /* Get a new block for writing */
783 err = prep_ea_block_for_write(fs, handle->ino, inode);
787 /* Finally, write the new EA block */
788 blk = ext2fs_file_acl_block(fs, EXT2_INODE(inode));
789 err = ext2fs_write_ext_attr3(fs, blk, block_buf, handle->ino);
794 blk = ext2fs_file_acl_block(fs, (struct ext2_inode *)inode);
795 if (!block_buf && blk) {
796 /* xattrs shrunk, free the block */
797 err = ext2fs_free_ext_attr(fs, handle->ino, inode);
802 /* Write the inode */
803 err = ext2fs_write_inode_full(fs, handle->ino, EXT2_INODE(inode),
809 ext2fs_free_mem(&block_buf);
811 ext2fs_free_mem(&inode);
815 static errcode_t read_xattrs_from_buffer(struct ext2_xattr_handle *handle,
816 struct ext2_inode_large *inode,
817 struct ext2_ext_attr_entry *entries,
818 unsigned int storage_size,
821 struct ext2_xattr *x;
822 struct ext2_ext_attr_entry *entry, *end;
824 unsigned int remain, prefix_len;
826 unsigned int values_size = storage_size +
827 ((char *)entries - value_start);
831 remain = storage_size;
832 while (remain >= sizeof(struct ext2_ext_attr_entry) &&
833 !EXT2_EXT_IS_LAST_ENTRY(end)) {
835 /* header eats this space */
836 remain -= sizeof(struct ext2_ext_attr_entry);
838 /* is attribute name valid? */
839 if (EXT2_EXT_ATTR_SIZE(end->e_name_len) > remain)
840 return EXT2_ET_EA_BAD_NAME_LEN;
842 /* attribute len eats this space */
843 remain -= EXT2_EXT_ATTR_SIZE(end->e_name_len);
844 end = EXT2_EXT_ATTR_NEXT(end);
848 remain = storage_size;
849 while (remain >= sizeof(struct ext2_ext_attr_entry) &&
850 !EXT2_EXT_IS_LAST_ENTRY(entry)) {
852 /* Allocate space for more attrs? */
853 if (handle->count == handle->capacity) {
854 err = ext2fs_xattrs_expand(handle, 4);
859 x = handle->attrs + handle->count;
861 /* header eats this space */
862 remain -= sizeof(struct ext2_ext_attr_entry);
864 /* attribute len eats this space */
865 remain -= EXT2_EXT_ATTR_SIZE(entry->e_name_len);
868 prefix = find_ea_prefix(entry->e_name_index);
869 prefix_len = (prefix ? strlen(prefix) : 0);
870 err = ext2fs_get_memzero(entry->e_name_len + prefix_len + 1,
875 memcpy(x->name, prefix, prefix_len);
876 if (entry->e_name_len)
877 memcpy(x->name + prefix_len,
878 (char *)entry + sizeof(*entry),
881 /* Check & copy value */
882 if (!ext2fs_has_feature_ea_inode(handle->fs->super) &&
883 entry->e_value_inum != 0)
884 return EXT2_ET_BAD_EA_BLOCK_NUM;
886 if (entry->e_value_inum == 0) {
887 if (entry->e_value_size > remain)
888 return EXT2_ET_EA_BAD_VALUE_SIZE;
890 if (entry->e_value_offs + entry->e_value_size > values_size)
891 return EXT2_ET_EA_BAD_VALUE_OFFSET;
893 if (entry->e_value_size > 0 &&
894 value_start + entry->e_value_offs <
895 (char *)end + sizeof(__u32))
896 return EXT2_ET_EA_BAD_VALUE_OFFSET;
898 remain -= entry->e_value_size;
900 err = ext2fs_get_mem(entry->e_value_size, &x->value);
903 memcpy(x->value, value_start + entry->e_value_offs,
904 entry->e_value_size);
908 if (entry->e_value_offs != 0)
909 return EXT2_ET_EA_BAD_VALUE_OFFSET;
911 if (entry->e_value_size > (64 * 1024))
912 return EXT2_ET_EA_BAD_VALUE_SIZE;
914 err = ext2fs_get_mem(entry->e_value_size, &x->value);
918 err = ext2fs_file_open(handle->fs, entry->e_value_inum,
923 if (ext2fs_file_get_size(ea_file) !=
925 err = EXT2_ET_EA_BAD_VALUE_SIZE;
927 err = ext2fs_file_read(ea_file, x->value,
928 entry->e_value_size, 0);
929 ext2fs_file_close(ea_file);
934 x->ea_ino = entry->e_value_inum;
935 x->value_len = entry->e_value_size;
937 /* e_hash may be 0 in older inode's ea */
938 if (entry->e_hash != 0) {
940 void *data = (entry->e_value_inum != 0) ?
941 0 : value_start + entry->e_value_offs;
943 err = ext2fs_ext_attr_hash_entry2(handle->fs, entry,
947 if (entry->e_hash != hash) {
948 struct ext2_inode child;
950 /* Check whether this is an old Lustre-style
951 * ea_inode reference.
953 err = ext2fs_read_inode(handle->fs,
958 if (child.i_mtime != handle->ino ||
959 child.i_generation != inode->i_generation)
960 return EXT2_ET_BAD_EA_HASH;
965 entry = EXT2_EXT_ATTR_NEXT(entry);
971 static void xattrs_free_keys(struct ext2_xattr_handle *h)
973 struct ext2_xattr *a = h->attrs;
976 for (i = 0; i < h->capacity; i++) {
978 ext2fs_free_mem(&a[i].name);
980 ext2fs_free_mem(&a[i].value);
986 errcode_t ext2fs_xattrs_read(struct ext2_xattr_handle *handle)
988 struct ext2_inode_large *inode;
989 struct ext2_ext_attr_header *header;
990 __u32 ea_inode_magic;
991 unsigned int storage_size;
992 char *start, *block_buf = NULL;
997 EXT2_CHECK_MAGIC(handle, EXT2_ET_MAGIC_EA_HANDLE);
998 i = EXT2_INODE_SIZE(handle->fs->super);
999 if (i < sizeof(*inode))
1001 err = ext2fs_get_memzero(i, &inode);
1005 err = ext2fs_read_inode_full(handle->fs, handle->ino,
1006 (struct ext2_inode *)inode,
1007 EXT2_INODE_SIZE(handle->fs->super));
1011 xattrs_free_keys(handle);
1013 /* Does the inode have space for EA? */
1014 if (inode->i_extra_isize < sizeof(inode->i_extra_isize) ||
1015 EXT2_INODE_SIZE(handle->fs->super) <= EXT2_GOOD_OLD_INODE_SIZE +
1016 inode->i_extra_isize +
1019 if (inode->i_extra_isize & 3) {
1020 err = EXT2_ET_INODE_CORRUPTED;
1024 /* Look for EA in the inode */
1025 memcpy(&ea_inode_magic, ((char *) inode) + EXT2_GOOD_OLD_INODE_SIZE +
1026 inode->i_extra_isize, sizeof(__u32));
1027 if (ea_inode_magic == EXT2_EXT_ATTR_MAGIC) {
1028 storage_size = EXT2_INODE_SIZE(handle->fs->super) -
1029 EXT2_GOOD_OLD_INODE_SIZE - inode->i_extra_isize -
1031 start = ((char *) inode) + EXT2_GOOD_OLD_INODE_SIZE +
1032 inode->i_extra_isize + sizeof(__u32);
1034 err = read_xattrs_from_buffer(handle, inode,
1035 (struct ext2_ext_attr_entry *) start,
1036 storage_size, start);
1040 handle->ibody_count = handle->count;
1044 /* Look for EA in a separate EA block */
1045 blk = ext2fs_file_acl_block(handle->fs, (struct ext2_inode *)inode);
1047 if ((blk < handle->fs->super->s_first_data_block) ||
1048 (blk >= ext2fs_blocks_count(handle->fs->super))) {
1049 err = EXT2_ET_BAD_EA_BLOCK_NUM;
1053 err = ext2fs_get_mem(handle->fs->blocksize, &block_buf);
1057 err = ext2fs_read_ext_attr3(handle->fs, blk, block_buf,
1062 /* We only know how to deal with v2 EA blocks */
1063 header = (struct ext2_ext_attr_header *) block_buf;
1064 if (header->h_magic != EXT2_EXT_ATTR_MAGIC) {
1065 err = EXT2_ET_BAD_EA_HEADER;
1070 storage_size = handle->fs->blocksize -
1071 sizeof(struct ext2_ext_attr_header);
1072 start = block_buf + sizeof(struct ext2_ext_attr_header);
1073 err = read_xattrs_from_buffer(handle, inode,
1074 (struct ext2_ext_attr_entry *) start,
1075 storage_size, block_buf);
1079 ext2fs_free_mem(&block_buf);
1082 ext2fs_free_mem(&block_buf);
1083 ext2fs_free_mem(&inode);
1087 ext2fs_free_mem(&block_buf);
1089 ext2fs_free_mem(&inode);
1093 errcode_t ext2fs_xattrs_iterate(struct ext2_xattr_handle *h,
1094 int (*func)(char *name, char *value,
1095 size_t value_len, void *data),
1098 struct ext2_xattr *x;
1102 EXT2_CHECK_MAGIC(h, EXT2_ET_MAGIC_EA_HANDLE);
1103 for (x = h->attrs; x < h->attrs + h->count; x++) {
1104 ret = func(x->name, x->value, x->value_len, data);
1105 if (ret & XATTR_CHANGED)
1107 if (ret & XATTR_ABORT)
1112 return ext2fs_xattrs_write(h);
1116 errcode_t ext2fs_xattr_get(struct ext2_xattr_handle *h, const char *key,
1117 void **value, size_t *value_len)
1119 struct ext2_xattr *x;
1123 EXT2_CHECK_MAGIC(h, EXT2_ET_MAGIC_EA_HANDLE);
1124 for (x = h->attrs; x < h->attrs + h->count; x++) {
1125 if (strcmp(x->name, key))
1128 if (!(h->flags & XATTR_HANDLE_FLAG_RAW) &&
1129 ((strcmp(key, "system.posix_acl_default") == 0) ||
1130 (strcmp(key, "system.posix_acl_access") == 0))) {
1131 err = convert_disk_buffer_to_posix_acl(x->value, x->value_len,
1135 err = ext2fs_get_mem(x->value_len, &val);
1138 memcpy(val, x->value, x->value_len);
1140 *value_len = x->value_len;
1145 return EXT2_ET_EA_KEY_NOT_FOUND;
1148 errcode_t ext2fs_xattr_inode_max_size(ext2_filsys fs, ext2_ino_t ino,
1151 struct ext2_ext_attr_entry *entry;
1152 struct ext2_inode_large *inode;
1153 __u32 ea_inode_magic;
1154 unsigned int minoff;
1159 i = EXT2_INODE_SIZE(fs->super);
1160 if (i < sizeof(*inode))
1162 err = ext2fs_get_memzero(i, &inode);
1166 err = ext2fs_read_inode_full(fs, ino, (struct ext2_inode *)inode,
1167 EXT2_INODE_SIZE(fs->super));
1171 /* Does the inode have size for EA? */
1172 if (EXT2_INODE_SIZE(fs->super) <= EXT2_GOOD_OLD_INODE_SIZE +
1173 inode->i_extra_isize +
1175 err = EXT2_ET_INLINE_DATA_NO_SPACE;
1179 minoff = EXT2_INODE_SIZE(fs->super) - sizeof(*inode) - sizeof(__u32);
1180 memcpy(&ea_inode_magic, ((char *) inode) + EXT2_GOOD_OLD_INODE_SIZE +
1181 inode->i_extra_isize, sizeof(__u32));
1182 if (ea_inode_magic == EXT2_EXT_ATTR_MAGIC) {
1183 /* has xattrs. calculate the size */
1184 start= ((char *) inode) + EXT2_GOOD_OLD_INODE_SIZE +
1185 inode->i_extra_isize + sizeof(__u32);
1186 entry = (struct ext2_ext_attr_entry *) start;
1187 while (!EXT2_EXT_IS_LAST_ENTRY(entry)) {
1188 if (!entry->e_value_inum && entry->e_value_size) {
1189 unsigned int offs = entry->e_value_offs;
1193 entry = EXT2_EXT_ATTR_NEXT(entry);
1195 *size = minoff - ((char *)entry - (char *)start) - sizeof(__u32);
1197 /* no xattr. return a maximum size */
1198 *size = EXT2_EXT_ATTR_SIZE(minoff -
1199 EXT2_EXT_ATTR_LEN(strlen("data")) -
1200 EXT2_EXT_ATTR_ROUND - sizeof(__u32));
1204 ext2fs_free_mem(&inode);
1208 static errcode_t xattr_create_ea_inode(ext2_filsys fs, const void *value,
1209 size_t value_len, ext2_ino_t *ea_ino)
1211 struct ext2_inode inode;
1217 ret = ext2fs_new_inode(fs, 0, 0, 0, &ino);
1221 memset(&inode, 0, sizeof(inode));
1222 inode.i_flags |= EXT4_EA_INODE_FL;
1223 if (ext2fs_has_feature_extents(fs->super))
1224 inode.i_flags |= EXT4_EXTENTS_FL;
1226 inode.i_mode = LINUX_S_IFREG | 0600;
1227 inode.i_links_count = 1;
1228 ret = ext2fs_write_new_inode(fs, ino, &inode);
1232 * ref_count and hash utilize inode's i_*time fields.
1233 * ext2fs_write_new_inode() call above initializes these fields with
1234 * current time. That's why ref count and hash updates are done
1237 ext2fs_set_ea_inode_ref(&inode, 1);
1238 hash = ext2fs_crc32c_le(fs->csum_seed, value, value_len);
1239 ext2fs_set_ea_inode_hash(&inode, hash);
1241 ret = ext2fs_write_inode(fs, ino, &inode);
1245 ret = ext2fs_file_open(fs, ino, EXT2_FILE_WRITE, &file);
1248 ret = ext2fs_file_write(file, value, value_len, NULL);
1249 ext2fs_file_close(file);
1253 ext2fs_inode_alloc_stats2(fs, ino, 1 /* inuse */, 0 /* isdir */);
1259 static errcode_t xattr_inode_dec_ref(ext2_filsys fs, ext2_ino_t ino)
1261 struct ext2_inode_large inode;
1265 ret = ext2fs_read_inode_full(fs, ino, (struct ext2_inode *)&inode,
1270 ref_count = ext2fs_get_ea_inode_ref(EXT2_INODE(&inode));
1272 ext2fs_set_ea_inode_ref(EXT2_INODE(&inode), ref_count);
1277 inode.i_links_count = 0;
1278 inode.i_dtime = fs->now ? fs->now : time(0);
1280 ret = ext2fs_free_ext_attr(fs, ino, &inode);
1284 if (ext2fs_inode_has_valid_blocks2(fs, (struct ext2_inode *)&inode)) {
1285 ret = ext2fs_punch(fs, ino, (struct ext2_inode *)&inode, NULL,
1291 ext2fs_inode_alloc_stats2(fs, ino, -1 /* inuse */, 0 /* is_dir */);
1294 ret = ext2fs_write_inode_full(fs, ino, (struct ext2_inode *)&inode,
1300 static errcode_t xattr_update_entry(ext2_filsys fs, struct ext2_xattr *x,
1301 const char *name, const void *value,
1302 size_t value_len, int in_inode)
1304 ext2_ino_t ea_ino = 0;
1305 void *new_value = NULL;
1306 char *new_name = NULL;
1311 name_len = strlen(name);
1312 ret = ext2fs_get_mem(name_len + 1, &new_name);
1315 memcpy(new_name, name, name_len + 1);
1318 ret = ext2fs_get_mem(value_len, &new_value);
1321 memcpy(new_value, value, value_len);
1324 ret = xattr_create_ea_inode(fs, value, value_len, &ea_ino);
1330 ret = xattr_inode_dec_ref(fs, x->ea_ino);
1339 ext2fs_free_mem(&x->value);
1340 x->value = new_value;
1341 x->value_len = value_len;
1346 ext2fs_free_mem(&new_name);
1348 ext2fs_free_mem(&new_value);
1350 xattr_inode_dec_ref(fs, ea_ino);
1354 static int xattr_find_position(struct ext2_xattr *attrs, int count,
1357 struct ext2_xattr *x;
1359 char *shortname, *x_shortname;
1360 int name_idx, x_name_idx;
1361 int shortname_len, x_shortname_len;
1363 find_ea_index(name, &shortname, &name_idx);
1364 shortname_len = strlen(shortname);
1366 for (i = 0, x = attrs; i < count; i++, x++) {
1367 find_ea_index(x->name, &x_shortname, &x_name_idx);
1368 if (name_idx < x_name_idx)
1370 if (name_idx > x_name_idx)
1373 x_shortname_len = strlen(x_shortname);
1374 if (shortname_len < x_shortname_len)
1376 if (shortname_len > x_shortname_len)
1379 if (memcmp(shortname, x_shortname, shortname_len) <= 0)
1385 errcode_t xattr_array_update(struct ext2_xattr_handle *h, const char *name,
1386 const void *value, size_t value_len, int ibody_free,
1387 int block_free, int old_idx, int in_inode)
1389 struct ext2_xattr tmp;
1392 int name_len, name_idx;
1397 find_ea_index(name, &shortname, &name_idx);
1398 name_len = strlen(shortname);
1400 needed = EXT2_EXT_ATTR_LEN(name_len);
1402 needed += EXT2_EXT_ATTR_SIZE(value_len);
1404 if (old_idx >= 0 && old_idx < h->ibody_count) {
1405 ibody_free += EXT2_EXT_ATTR_LEN(name_len);
1406 if (!h->attrs[old_idx].ea_ino)
1407 ibody_free += EXT2_EXT_ATTR_SIZE(
1408 h->attrs[old_idx].value_len);
1411 if (needed <= ibody_free) {
1413 new_idx = h->ibody_count;
1418 /* Update the existing entry. */
1419 ret = xattr_update_entry(h->fs, &h->attrs[old_idx], name,
1420 value, value_len, in_inode);
1423 if (h->ibody_count <= old_idx) {
1424 /* Move entry from block to the end of ibody. */
1425 tmp = h->attrs[old_idx];
1426 memmove(h->attrs + h->ibody_count + 1,
1427 h->attrs + h->ibody_count,
1428 (old_idx - h->ibody_count) * sizeof(*h->attrs));
1429 h->attrs[h->ibody_count] = tmp;
1435 if (h->ibody_count <= old_idx) {
1436 block_free += EXT2_EXT_ATTR_LEN(name_len);
1437 if (!h->attrs[old_idx].ea_ino)
1439 EXT2_EXT_ATTR_SIZE(h->attrs[old_idx].value_len);
1442 if (needed > block_free)
1443 return EXT2_ET_EA_NO_SPACE;
1446 /* Update the existing entry. */
1447 ret = xattr_update_entry(h->fs, &h->attrs[old_idx], name,
1448 value, value_len, in_inode);
1451 if (old_idx < h->ibody_count) {
1453 * Move entry from ibody to the block. Note that
1454 * entries in the block are sorted.
1456 new_idx = xattr_find_position(h->attrs + h->ibody_count,
1457 h->count - h->ibody_count, name);
1458 new_idx += h->ibody_count - 1;
1459 tmp = h->attrs[old_idx];
1460 memmove(h->attrs + old_idx, h->attrs + old_idx + 1,
1461 (new_idx - old_idx) * sizeof(*h->attrs));
1462 h->attrs[new_idx] = tmp;
1468 new_idx = xattr_find_position(h->attrs + h->ibody_count,
1469 h->count - h->ibody_count, name);
1470 new_idx += h->ibody_count;
1474 if (h->count == h->capacity) {
1475 ret = ext2fs_xattrs_expand(h, 4);
1480 ret = xattr_update_entry(h->fs, &h->attrs[h->count], name, value,
1481 value_len, in_inode);
1485 tmp = h->attrs[h->count];
1486 memmove(h->attrs + new_idx + 1, h->attrs + new_idx,
1487 (h->count - new_idx)*sizeof(*h->attrs));
1488 h->attrs[new_idx] = tmp;
1495 int space_used(struct ext2_xattr *attrs, int count)
1498 struct ext2_xattr *x;
1500 int i, len, name_idx;
1502 for (i = 0, x = attrs; i < count; i++, x++) {
1503 find_ea_index(x->name, &shortname, &name_idx);
1504 len = strlen(shortname);
1505 total += EXT2_EXT_ATTR_LEN(len);
1507 total += EXT2_EXT_ATTR_SIZE(x->value_len);
1513 * The minimum size of EA value when you start storing it in an external inode
1514 * size of block - size of header - size of 1 entry - 4 null bytes
1516 #define EXT4_XATTR_MIN_LARGE_EA_SIZE(b) \
1517 ((b) - EXT2_EXT_ATTR_LEN(3) - sizeof(struct ext2_ext_attr_header) - 4)
1519 errcode_t ext2fs_xattr_set(struct ext2_xattr_handle *h,
1524 ext2_filsys fs = h->fs;
1525 const int inode_size = EXT2_INODE_SIZE(fs->super);
1526 struct ext2_inode_large *inode = NULL;
1527 struct ext2_xattr *x;
1529 int ibody_free, block_free;
1535 EXT2_CHECK_MAGIC(h, EXT2_ET_MAGIC_EA_HANDLE);
1537 ret = ext2fs_get_mem(value_len, &new_value);
1540 if (!(h->flags & XATTR_HANDLE_FLAG_RAW) &&
1541 ((strcmp(name, "system.posix_acl_default") == 0) ||
1542 (strcmp(name, "system.posix_acl_access") == 0))) {
1543 ret = convert_posix_acl_to_disk_buffer(value, value_len,
1544 new_value, &value_len);
1548 memcpy(new_value, value, value_len);
1550 /* Imitate kernel behavior by skipping update if value is the same. */
1551 for (x = h->attrs; x < h->attrs + h->count; x++) {
1552 if (!strcmp(x->name, name)) {
1553 if (!x->ea_ino && x->value_len == value_len &&
1554 !memcmp(x->value, new_value, value_len)) {
1558 old_idx = x - h->attrs;
1563 ret = ext2fs_get_memzero(inode_size, &inode);
1566 ret = ext2fs_read_inode_full(fs, h->ino,
1567 (struct ext2_inode *)inode,
1571 if (inode_size > EXT2_GOOD_OLD_INODE_SIZE) {
1572 extra_isize = inode->i_extra_isize;
1573 if (extra_isize == 0) {
1574 extra_isize = fs->super->s_want_extra_isize;
1575 if (extra_isize == 0)
1576 extra_isize = sizeof(__u32);
1578 ibody_free = inode_size - EXT2_GOOD_OLD_INODE_SIZE;
1579 ibody_free -= extra_isize;
1580 /* Extended attribute magic and final null entry. */
1581 ibody_free -= sizeof(__u32) * 2;
1582 ibody_free -= space_used(h->attrs, h->ibody_count);
1586 /* Inline data can only go to ibody. */
1587 if (strcmp(name, "system.data") == 0) {
1588 if (h->ibody_count <= old_idx) {
1589 ret = EXT2_ET_FILESYSTEM_CORRUPTED;
1592 ret = xattr_array_update(h, name, value, value_len, ibody_free,
1593 0 /* block_free */, old_idx,
1600 block_free = fs->blocksize;
1601 block_free -= sizeof(struct ext2_ext_attr_header);
1602 /* Final null entry. */
1603 block_free -= sizeof(__u32);
1604 block_free -= space_used(h->attrs + h->ibody_count,
1605 h->count - h->ibody_count);
1607 if (ext2fs_has_feature_ea_inode(fs->super) &&
1608 value_len > EXT4_XATTR_MIN_LARGE_EA_SIZE(fs->blocksize))
1611 ret = xattr_array_update(h, name, value, value_len, ibody_free,
1612 block_free, old_idx, in_inode);
1613 if (ret == EXT2_ET_EA_NO_SPACE && !in_inode &&
1614 ext2fs_has_feature_ea_inode(fs->super))
1615 ret = xattr_array_update(h, name, value, value_len, ibody_free,
1616 block_free, old_idx, 1 /* in_inode */);
1621 ret = ext2fs_xattrs_write(h);
1624 ext2fs_free_mem(&inode);
1625 ext2fs_free_mem(&new_value);
1629 errcode_t ext2fs_xattr_remove(struct ext2_xattr_handle *handle,
1632 struct ext2_xattr *x;
1633 struct ext2_xattr *end = handle->attrs + handle->count;
1635 EXT2_CHECK_MAGIC(handle, EXT2_ET_MAGIC_EA_HANDLE);
1636 for (x = handle->attrs; x < end; x++) {
1637 if (strcmp(x->name, key) == 0) {
1638 ext2fs_free_mem(&x->name);
1639 ext2fs_free_mem(&x->value);
1641 xattr_inode_dec_ref(handle->fs, x->ea_ino);
1642 memmove(x, x + 1, (end - x - 1)*sizeof(*x));
1643 memset(end - 1, 0, sizeof(*end));
1644 if (x < handle->attrs + handle->ibody_count)
1645 handle->ibody_count--;
1647 return ext2fs_xattrs_write(handle);
1651 /* no key found, success! */
1655 errcode_t ext2fs_xattrs_open(ext2_filsys fs, ext2_ino_t ino,
1656 struct ext2_xattr_handle **handle)
1658 struct ext2_xattr_handle *h;
1661 if (!ext2fs_has_feature_xattr(fs->super) &&
1662 !ext2fs_has_feature_inline_data(fs->super))
1663 return EXT2_ET_MISSING_EA_FEATURE;
1665 err = ext2fs_get_memzero(sizeof(*h), &h);
1669 h->magic = EXT2_ET_MAGIC_EA_HANDLE;
1671 err = ext2fs_get_arrayzero(h->capacity, sizeof(struct ext2_xattr),
1674 ext2fs_free_mem(&h);
1684 errcode_t ext2fs_xattrs_close(struct ext2_xattr_handle **handle)
1686 struct ext2_xattr_handle *h = *handle;
1688 EXT2_CHECK_MAGIC(h, EXT2_ET_MAGIC_EA_HANDLE);
1689 xattrs_free_keys(h);
1690 ext2fs_free_mem(&h->attrs);
1691 ext2fs_free_mem(handle);
1695 errcode_t ext2fs_xattrs_count(struct ext2_xattr_handle *handle, size_t *count)
1697 EXT2_CHECK_MAGIC(handle, EXT2_ET_MAGIC_EA_HANDLE);
1698 *count = handle->count;
1702 errcode_t ext2fs_xattrs_flags(struct ext2_xattr_handle *handle,
1703 unsigned int *new_flags, unsigned int *old_flags)
1705 EXT2_CHECK_MAGIC(handle, EXT2_ET_MAGIC_EA_HANDLE);
1707 *old_flags = handle->flags;
1709 handle->flags = *new_flags;