2 * Copyright (c) 2015 Grzegorz Kostka (kostka.grzegorz@gmail.com)
3 * Copyright (c) 2015 Kaho Ng (ngkaho1234@gmail.com)
7 * Copyright (c) 2012 Martin Sucha
8 * Copyright (c) 2012 Frantisek Princ
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
15 * - Redistributions of source code must retain the above copyright
16 * notice, this list of conditions and the following disclaimer.
17 * - Redistributions in binary form must reproduce the above copyright
18 * notice, this list of conditions and the following disclaimer in the
19 * documentation and/or other materials provided with the distribution.
20 * - The name of the author may not be used to endorse or promote products
21 * derived from this software without specific prior written permission.
23 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
24 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
25 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
26 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
27 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
28 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
29 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
30 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
32 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35 /** @addtogroup lwext4
40 * @brief Extended Attribute manipulation.
43 #include "ext4_config.h"
44 #include "ext4_types.h"
46 #include "ext4_errno.h"
47 #include "ext4_blockdev.h"
48 #include "ext4_super.h"
49 #include "ext4_debug.h"
50 #include "ext4_block_group.h"
51 #include "ext4_balloc.h"
52 #include "ext4_inode.h"
53 #include "ext4_extent.h"
60 * @brief Extended Attribute Manipulation
63 #define NAME_HASH_SHIFT 5
64 #define VALUE_HASH_SHIFT 16
67 ext4_xattr_compute_hash(struct ext4_xattr_header *header,
68 struct ext4_xattr_entry *entry)
71 char *name = EXT4_XATTR_NAME(entry);
74 for (n = 0; n < entry->e_name_len; n++) {
75 hash = (hash << NAME_HASH_SHIFT) ^
76 (hash >> (8*sizeof(hash) - NAME_HASH_SHIFT)) ^
80 if (entry->e_value_block == 0 && entry->e_value_size != 0) {
81 uint32_t *value = (uint32_t *)((char *)header +
82 to_le16(entry->e_value_offs));
83 for (n = (to_le32(entry->e_value_size) +
84 EXT4_XATTR_ROUND) >> EXT4_XATTR_PAD_BITS; n; n--) {
85 hash = (hash << VALUE_HASH_SHIFT) ^
86 (hash >> (8*sizeof(hash) - VALUE_HASH_SHIFT)) ^
90 entry->e_hash = to_le32(hash);
93 #define BLOCK_HASH_SHIFT 16
98 * Re-compute the extended attribute hash value after an entry has changed.
100 static void ext4_xattr_rehash(struct ext4_xattr_header *header,
101 struct ext4_xattr_entry *entry)
103 struct ext4_xattr_entry *here;
106 ext4_xattr_compute_hash(header, entry);
107 here = EXT4_XATTR_ENTRY(header+1);
108 while (!EXT4_XATTR_IS_LAST_ENTRY(here)) {
110 /* Block is not shared if an entry's hash value == 0 */
114 hash = (hash << BLOCK_HASH_SHIFT) ^
115 (hash >> (8*sizeof(hash) - BLOCK_HASH_SHIFT)) ^
116 to_le32(here->e_hash);
117 here = EXT4_XATTR_NEXT(here);
119 header->h_hash = to_le32(hash);
122 static int ext4_xattr_item_cmp(struct ext4_xattr_item *a,
123 struct ext4_xattr_item *b)
126 result = a->name_index - b->name_index;
130 result = a->name_len - b->name_len;
134 return memcmp(a->name, b->name, a->name_len);
137 RB_GENERATE_INTERNAL(ext4_xattr_tree,
143 static struct ext4_xattr_item *
144 ext4_xattr_item_alloc(uint8_t name_index,
148 struct ext4_xattr_item *item;
149 item = malloc(sizeof(struct ext4_xattr_item) +
154 item->name_index = name_index;
155 item->name = (char *)(item + 1);
156 item->name_len = name_len;
160 memset(&item->node, 0, sizeof(item->node));
161 memcpy(item->name, name, name_len);
167 ext4_xattr_item_alloc_data(struct ext4_xattr_item *item,
172 ext4_assert(!item->data);
173 data = malloc(data_size);
178 memcpy(data, orig_data, data_size);
181 item->data_size = data_size;
186 ext4_xattr_item_free_data(struct ext4_xattr_item *item)
188 ext4_assert(item->data);
195 ext4_xattr_item_resize_data(struct ext4_xattr_item *item,
196 size_t new_data_size)
198 if (new_data_size != item->data_size) {
200 new_data = realloc(item->data, new_data_size);
204 item->data = new_data;
205 item->data_size = new_data_size;
211 ext4_xattr_item_free(struct ext4_xattr_item *item)
214 ext4_xattr_item_free_data(item);
220 static void *ext4_xattr_entry_data(struct ext4_xattr_ref *xattr_ref,
221 struct ext4_xattr_entry *entry,
226 struct ext4_xattr_ibody_header *header;
227 struct ext4_xattr_entry *first_entry;
228 uint16_t inode_size = ext4_get16(&xattr_ref->fs->sb,
230 header = EXT4_XATTR_IHDR(xattr_ref->inode_ref->inode);
231 first_entry = EXT4_XATTR_IFIRST(header);
233 ret = (void *)((char *)first_entry + to_le16(entry->e_value_offs));
234 if ((char *)ret + EXT4_XATTR_SIZE(to_le32(entry->e_value_size))
235 - (char *)xattr_ref->inode_ref->inode >
241 ext4_sb_get_block_size(&xattr_ref->fs->sb);
242 ret = (void *)((char *)xattr_ref->block.data +
243 to_le16(entry->e_value_offs));
244 if ((char *)ret + EXT4_XATTR_SIZE(to_le32(entry->e_value_size))
245 - (char *)xattr_ref->block.data >
252 static int ext4_xattr_block_fetch(struct ext4_xattr_ref *xattr_ref)
257 struct ext4_xattr_entry *entry = NULL;
259 ext4_assert(xattr_ref->block.data);
260 entry = EXT4_XATTR_BFIRST(&xattr_ref->block);
262 size_rem = ext4_sb_get_block_size(&xattr_ref->fs->sb);
263 for(;size_rem > 0 && !EXT4_XATTR_IS_LAST_ENTRY(entry);
264 entry = EXT4_XATTR_NEXT(entry),
265 size_rem -= EXT4_XATTR_LEN(entry->e_name_len)) {
266 struct ext4_xattr_item *item;
267 char *e_name = EXT4_XATTR_NAME(entry);
269 data = ext4_xattr_entry_data(xattr_ref, entry,
276 item = ext4_xattr_item_alloc(entry->e_name_index,
278 (size_t)entry->e_name_len);
283 if (ext4_xattr_item_alloc_data(item,
285 to_le32(entry->e_value_size))
287 ext4_xattr_item_free(item);
291 RB_INSERT(ext4_xattr_tree, &xattr_ref->root, item);
292 xattr_ref->ea_size += EXT4_XATTR_SIZE(item->data_size) +
293 EXT4_XATTR_LEN(item->name_len);
300 static int ext4_xattr_inode_fetch(struct ext4_xattr_ref *xattr_ref)
305 struct ext4_xattr_ibody_header *header = NULL;
306 struct ext4_xattr_entry *entry = NULL;
307 uint16_t inode_size = ext4_get16(&xattr_ref->fs->sb,
310 header = EXT4_XATTR_IHDR(xattr_ref->inode_ref->inode);
311 entry = EXT4_XATTR_IFIRST(header);
313 size_rem = inode_size -
314 EXT4_GOOD_OLD_INODE_SIZE -
315 xattr_ref->inode_ref->inode->extra_isize;
316 for(;size_rem > 0 && !EXT4_XATTR_IS_LAST_ENTRY(entry);
317 entry = EXT4_XATTR_NEXT(entry),
318 size_rem -= EXT4_XATTR_LEN(entry->e_name_len)) {
319 struct ext4_xattr_item *item;
320 char *e_name = EXT4_XATTR_NAME(entry);
322 data = ext4_xattr_entry_data(xattr_ref, entry,
329 item = ext4_xattr_item_alloc(entry->e_name_index,
331 (size_t)entry->e_name_len);
336 if (ext4_xattr_item_alloc_data(item,
338 to_le32(entry->e_value_size))
340 ext4_xattr_item_free(item);
344 RB_INSERT(ext4_xattr_tree, &xattr_ref->root, item);
345 xattr_ref->ea_size += EXT4_XATTR_SIZE(item->data_size) +
346 EXT4_XATTR_LEN(item->name_len);
355 ext4_xattr_inode_space(struct ext4_xattr_ref *xattr_ref)
357 uint16_t inode_size = ext4_get16(&xattr_ref->fs->sb,
359 uint16_t size_rem = inode_size -
360 EXT4_GOOD_OLD_INODE_SIZE -
361 xattr_ref->inode_ref->inode->extra_isize;
366 ext4_xattr_block_space(struct ext4_xattr_ref *xattr_ref)
368 return ext4_sb_get_block_size(&xattr_ref->fs->sb);
371 static int ext4_xattr_fetch(struct ext4_xattr_ref *xattr_ref)
374 uint16_t inode_size = ext4_get16(&xattr_ref->fs->sb,
376 if (inode_size > EXT4_GOOD_OLD_INODE_SIZE) {
377 ret = ext4_xattr_inode_fetch(xattr_ref);
383 if (xattr_ref->block_loaded)
384 ret = ext4_xattr_block_fetch(xattr_ref);
386 xattr_ref->dirty = false;
390 static struct ext4_xattr_item *
391 ext4_xattr_lookup_item(struct ext4_xattr_ref *xattr_ref,
396 struct ext4_xattr_item tmp, *ret;
397 tmp.name_index = name_index;
399 tmp.name_len = name_len;
400 ret = RB_FIND(ext4_xattr_tree, &xattr_ref->root,
405 static struct ext4_xattr_item *
406 ext4_xattr_insert_item(struct ext4_xattr_ref *xattr_ref,
413 struct ext4_xattr_item *item;
414 item = ext4_xattr_item_alloc(name_index,
420 if (xattr_ref->ea_size + EXT4_XATTR_SIZE(item->data_size) +
421 EXT4_XATTR_LEN(item->name_len) >
422 ext4_xattr_inode_space(xattr_ref) +
423 ext4_xattr_block_space(xattr_ref)) {
424 ext4_xattr_item_free(item);
427 if (ext4_xattr_item_alloc_data(item,
430 ext4_xattr_item_free(item);
433 RB_INSERT(ext4_xattr_tree, &xattr_ref->root, item);
434 xattr_ref->ea_size += EXT4_XATTR_SIZE(item->data_size) +
435 EXT4_XATTR_LEN(item->name_len);
436 xattr_ref->dirty = true;
441 ext4_xattr_remove_item(struct ext4_xattr_ref *xattr_ref,
447 struct ext4_xattr_item *item =
448 ext4_xattr_lookup_item(xattr_ref,
453 if (item == xattr_ref->iter_from)
454 xattr_ref->iter_from = RB_NEXT(ext4_xattr_tree,
458 RB_REMOVE(ext4_xattr_tree, &xattr_ref->root, item);
459 ext4_xattr_item_free(item);
460 xattr_ref->ea_size -= EXT4_XATTR_SIZE(item->data_size) +
461 EXT4_XATTR_LEN(item->name_len);
462 xattr_ref->dirty = true;
469 ext4_xattr_resize_item(struct ext4_xattr_ref *xattr_ref,
470 struct ext4_xattr_item *item,
471 size_t new_data_size)
474 if (xattr_ref->ea_size - EXT4_XATTR_SIZE(item->data_size) +
475 EXT4_XATTR_SIZE(new_data_size) >
476 ext4_xattr_inode_space(xattr_ref) +
477 ext4_xattr_block_space(xattr_ref)) {
481 ret = ext4_xattr_item_resize_data(item,
486 xattr_ref->ea_size -= EXT4_XATTR_SIZE(item->data_size) +
487 EXT4_XATTR_SIZE(new_data_size);
488 xattr_ref->dirty = true;
493 ext4_xattr_purge_items(struct ext4_xattr_ref *xattr_ref)
495 struct ext4_xattr_item *item, *save_item;
496 uint64_t xattr_block = ext4_inode_get_file_acl(xattr_ref->inode_ref->inode,
498 RB_FOREACH_SAFE(item,
502 RB_REMOVE(ext4_xattr_tree, &xattr_ref->root, item);
503 ext4_xattr_item_free(item);
505 xattr_ref->ea_size = 0;
507 xattr_ref->ea_size += sizeof(struct ext4_xattr_header);
509 if (ext4_xattr_inode_space(xattr_ref) >
510 sizeof(struct ext4_xattr_ibody_header))
511 xattr_ref->ea_size += sizeof(struct ext4_xattr_ibody_header);
516 ext4_xattr_try_alloc_block(struct ext4_xattr_ref *xattr_ref)
520 uint64_t xattr_block = 0;
521 xattr_block = ext4_inode_get_file_acl(xattr_ref->inode_ref->inode,
524 ret = ext4_balloc_alloc_block(xattr_ref->inode_ref,
525 (uint32_t *)&xattr_block);
529 ret = ext4_block_get(xattr_ref->fs->bdev,
533 ext4_balloc_free_block(xattr_ref->inode_ref,
538 ext4_inode_set_file_acl(xattr_ref->inode_ref->inode,
541 xattr_ref->inode_ref->dirty = true;
542 xattr_ref->block_loaded = true;
543 xattr_ref->ea_size += sizeof(struct ext4_xattr_header);
551 ext4_xattr_try_free_block(struct ext4_xattr_ref *xattr_ref)
553 uint64_t xattr_block;
555 ext4_inode_get_file_acl(xattr_ref->inode_ref->inode,
557 ext4_inode_set_file_acl(xattr_ref->inode_ref->inode,
560 ext4_block_set(xattr_ref->fs->bdev,
562 ext4_balloc_free_block(xattr_ref->inode_ref,
564 xattr_ref->inode_ref->dirty = true;
565 xattr_ref->block_loaded = false;
566 xattr_ref->ea_size -= sizeof(struct ext4_xattr_header);
570 ext4_xattr_set_block_header(struct ext4_xattr_ref *xattr_ref)
572 struct ext4_xattr_header *block_header = NULL;
573 block_header = EXT4_XATTR_BHDR(&xattr_ref->block);
575 memset(block_header, 0, sizeof(struct ext4_xattr_header));
576 block_header->h_magic = EXT4_XATTR_MAGIC;
577 block_header->h_refcount = to_le32(1);
578 block_header->h_blocks = to_le32(1);
582 ext4_xattr_set_inode_entry(struct ext4_xattr_item *item,
583 struct ext4_xattr_ibody_header *ibody_header,
584 struct ext4_xattr_entry *entry,
585 void *ibody_data_ptr)
587 entry->e_name_len = to_le32(item->name_len);
588 entry->e_name_index = item->name_index;
589 entry->e_value_offs =
590 (char *)ibody_data_ptr -
591 (char *)EXT4_XATTR_IFIRST(ibody_header);
592 entry->e_value_block = 0;
593 entry->e_value_size = item->data_size;
597 ext4_xattr_set_block_entry(struct ext4_xattr_item *item,
598 struct ext4_xattr_header *block_header,
599 struct ext4_xattr_entry *block_entry,
600 void *block_data_ptr)
602 block_entry->e_name_len = to_le32(item->name_len);
603 block_entry->e_name_index = item->name_index;
604 block_entry->e_value_offs =
605 (char *)block_data_ptr - (char *)block_header;
606 block_entry->e_value_block = 0;
607 block_entry->e_value_size = item->data_size;
611 ext4_xattr_write_to_disk(struct ext4_xattr_ref *xattr_ref)
614 bool block_modified = false;
615 void *ibody_data, *block_data;
616 struct ext4_xattr_item *item, *save_item;
617 size_t inode_size_rem, block_size_rem;
618 struct ext4_xattr_ibody_header *ibody_header = NULL;
619 struct ext4_xattr_header *block_header = NULL;
620 struct ext4_xattr_entry *entry = NULL;
621 struct ext4_xattr_entry *block_entry = NULL;
623 inode_size_rem = ext4_xattr_inode_space(xattr_ref);
624 block_size_rem = ext4_xattr_block_space(xattr_ref);
625 if (inode_size_rem > sizeof(struct ext4_xattr_ibody_header)) {
626 ibody_header = EXT4_XATTR_IHDR(xattr_ref->inode_ref->inode);
627 entry = EXT4_XATTR_IFIRST(ibody_header);
630 if (xattr_ref->dirty) {
631 /* If there are enough spaces in the ibody EA table.*/
632 if (inode_size_rem > sizeof(struct ext4_xattr_ibody_header)) {
633 memset(ibody_header, 0, inode_size_rem);
634 ibody_header->h_magic = EXT4_XATTR_MAGIC;
635 ibody_data = (char *)ibody_header + inode_size_rem;
636 inode_size_rem -= sizeof(struct ext4_xattr_ibody_header);
638 xattr_ref->inode_ref->dirty = true;
640 /* If we need an extra block to hold the EA entries*/
641 if (xattr_ref->ea_size > inode_size_rem) {
642 if (!xattr_ref->block_loaded) {
643 ret = ext4_xattr_try_alloc_block(xattr_ref);
648 block_header = EXT4_XATTR_BHDR(&xattr_ref->block);
649 block_entry = EXT4_XATTR_BFIRST(&xattr_ref->block);
650 ext4_xattr_set_block_header(xattr_ref);
651 block_data = (char *)block_header + block_size_rem;
652 block_size_rem -= sizeof(struct ext4_xattr_header);
654 xattr_ref->block.dirty = true;
656 /* We don't need an extra block.*/
657 if (xattr_ref->block_loaded) {
658 block_header = EXT4_XATTR_BHDR(&xattr_ref->block);
659 block_header->h_refcount =
660 to_le32(to_le32(block_header->h_refcount) - 1);
661 if (!block_header->h_refcount) {
662 ext4_xattr_try_free_block(xattr_ref);
665 block_entry = EXT4_XATTR_BFIRST(&xattr_ref->block);
666 block_data = (char *)block_header + block_size_rem;
667 block_size_rem -= sizeof(struct ext4_xattr_header);
668 ext4_inode_set_file_acl(xattr_ref->inode_ref->inode,
672 xattr_ref->inode_ref->dirty = true;
673 xattr_ref->block.dirty = true;
677 RB_FOREACH_SAFE(item,
681 if (EXT4_XATTR_SIZE(item->data_size) +
682 EXT4_XATTR_LEN(item->name_len) <=
684 ibody_data = (char *)ibody_data -
685 EXT4_XATTR_SIZE(item->data_size);
686 ext4_xattr_set_inode_entry(item,
690 memcpy(EXT4_XATTR_NAME(entry),
691 item->name, item->name_len);
692 memcpy(ibody_data, item->data, item->data_size);
693 entry = EXT4_XATTR_NEXT(entry);
695 EXT4_XATTR_SIZE(item->data_size) +
696 EXT4_XATTR_LEN(item->name_len);
698 xattr_ref->inode_ref->dirty = true;
701 if (EXT4_XATTR_SIZE(item->data_size) +
702 EXT4_XATTR_LEN(item->name_len) > block_size_rem) {
706 block_data = (char *)block_data -
707 EXT4_XATTR_SIZE(item->data_size);
708 ext4_xattr_set_block_entry(item,
712 memcpy(EXT4_XATTR_NAME(block_entry),
713 item->name, item->name_len);
715 item->data, item->data_size);
716 block_entry = EXT4_XATTR_NEXT(block_entry);
718 EXT4_XATTR_SIZE(item->data_size) +
719 EXT4_XATTR_LEN(item->name_len);
721 block_modified = true;
723 xattr_ref->dirty = false;
724 if (block_modified) {
725 ext4_xattr_rehash(block_header,
726 EXT4_XATTR_BFIRST(&xattr_ref->block));
727 xattr_ref->block.dirty = true;
736 ext4_fs_xattr_iterate(struct ext4_xattr_ref *ref,
737 int (iter)(struct ext4_xattr_ref *ref,
738 struct ext4_xattr_item *item))
740 struct ext4_xattr_item *item;
742 ref->iter_from = RB_MIN(ext4_xattr_tree, &ref->root);
744 RB_FOREACH_FROM(item,
747 int ret = EXT4_XATTR_ITERATE_CONT;
751 if (ret != EXT4_XATTR_ITERATE_CONT) {
752 if (ret == EXT4_XATTR_ITERATE_STOP)
753 ref->iter_from = NULL;
761 ext4_fs_xattr_iterate_reset(struct ext4_xattr_ref *ref)
763 ref->iter_from = NULL;
766 int ext4_fs_set_xattr(struct ext4_xattr_ref *ref,
775 struct ext4_xattr_item *item =
776 ext4_xattr_lookup_item(ref,
785 if (item->data_size != data_size)
786 ret = ext4_xattr_resize_item(ref,
793 memcpy(item->data, data, data_size);
799 item = ext4_xattr_insert_item(ref,
813 int ext4_fs_remove_xattr(struct ext4_xattr_ref *ref,
818 return ext4_xattr_remove_item(ref,
824 int ext4_fs_get_xattr(struct ext4_xattr_ref *ref,
833 size_t item_size = 0;
834 struct ext4_xattr_item *item =
835 ext4_xattr_lookup_item(ref,
844 item_size = item->data_size;
845 if (buf_size > item_size)
846 buf_size = item_size;
849 memcpy(buf, item->data, buf_size);
853 *size_got = buf_size;
858 int ext4_fs_get_xattr_ref(struct ext4_fs *fs,
859 struct ext4_inode_ref *inode_ref,
860 struct ext4_xattr_ref *ref)
863 uint64_t xattr_block;
864 xattr_block = ext4_inode_get_file_acl(inode_ref->inode,
868 ref->iter_from = NULL;
870 rc = ext4_block_get(fs->bdev,
871 &ref->block, xattr_block);
875 ref->ea_size += sizeof(struct ext4_xattr_header);
876 ref->block_loaded = true;
878 ref->block_loaded = false;
880 ref->inode_ref = inode_ref;
883 if (ext4_xattr_inode_space(ref) >
884 sizeof(struct ext4_xattr_ibody_header))
885 ref->ea_size += sizeof(struct ext4_xattr_ibody_header);
887 rc = ext4_xattr_fetch(ref);
889 ext4_xattr_purge_items(ref);
891 ext4_block_set(fs->bdev, &inode_ref->block);
893 ref->block_loaded = false;
899 void ext4_fs_put_xattr_ref(struct ext4_xattr_ref *ref)
901 ext4_xattr_write_to_disk(ref);
902 if (ref->block_loaded) {
903 ext4_block_set(ref->fs->bdev, &ref->block);
904 ref->block_loaded = false;
906 ext4_xattr_purge_items(ref);
907 ref->inode_ref = NULL;