2 * Copyright (c) 2013 Grzegorz Kostka (kostka.grzegorz@gmail.com)
6 * Copyright (c) 2012 Martin Sucha
7 * Copyright (c) 2012 Frantisek Princ
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
14 * - Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * - Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
19 * - The name of the author may not be used to endorse or promote products
20 * derived from this software without specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
23 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
24 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
25 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
26 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
27 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
31 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 /** @addtogroup lwext4
39 * @brief Directory handle procedures.
42 #include "ext4_config.h"
44 #include "ext4_dir_idx.h"
45 #include "ext4_crc32c.h"
46 #include "ext4_inode.h"
51 /****************************************************************************/
53 /* Walk through a dirent block to find a checksum "dirent" at the tail */
54 static struct ext4_dir_entry_tail *
55 ext4_dir_get_tail(struct ext4_inode_ref *inode_ref,
56 struct ext4_dir_entry_ll *de)
58 struct ext4_dir_entry_tail *t;
59 struct ext4_sblock *sb = &inode_ref->fs->sb;
61 t = EXT4_DIRENT_TAIL(de, ext4_sb_get_block_size(sb));
63 if (t->reserved_zero1 ||
64 to_le16(t->rec_len) != sizeof(struct ext4_dir_entry_tail) ||
66 t->reserved_ft != EXT4_DIRENTRY_DIR_CSUM)
72 #if CONFIG_META_CSUM_ENABLE
73 static uint32_t ext4_dir_checksum(struct ext4_inode_ref *inode_ref,
74 struct ext4_dir_entry_ll *dirent, int size)
77 struct ext4_sblock *sb = &inode_ref->fs->sb;
78 uint32_t ino_index = to_le32(inode_ref->index);
80 to_le32(ext4_inode_get_generation(inode_ref->inode));
82 /* First calculate crc32 checksum against fs uuid */
83 checksum = ext4_crc32c(EXT4_CRC32_INIT, sb->uuid, sizeof(sb->uuid));
84 /* Then calculate crc32 checksum against inode number
85 * and inode generation */
86 checksum = ext4_crc32c(checksum, &ino_index,
88 checksum = ext4_crc32c(checksum, &ino_gen,
90 /* Finally calculate crc32 checksum against directory entries */
91 checksum = ext4_crc32c(checksum, dirent, size);
95 #define ext4_dir_checksum(...) 0
99 ext4_dir_checksum_verify(struct ext4_inode_ref *inode_ref,
100 struct ext4_dir_entry_ll *dirent)
102 #ifdef CONFIG_META_CSUM_ENABLE
103 struct ext4_dir_entry_tail *t;
104 struct ext4_sblock *sb = &inode_ref->fs->sb;
106 /* Compute the checksum only if the filesystem supports it */
107 if (ext4_sb_feature_ro_com(sb, EXT4_FRO_COM_METADATA_CSUM)) {
108 t = ext4_dir_get_tail(inode_ref, dirent);
110 /* There is no space to hold the checksum */
114 if (t->checksum != to_le32(ext4_dir_checksum(inode_ref, dirent,
115 (char *)t - (char *)dirent)))
123 /* checksumming functions */
124 void initialize_dir_tail(struct ext4_dir_entry_tail *t)
126 memset(t, 0, sizeof(struct ext4_dir_entry_tail));
127 t->rec_len = to_le16(sizeof(struct ext4_dir_entry_tail));
128 t->reserved_ft = EXT4_DIRENTRY_DIR_CSUM;
131 void ext4_dir_set_checksum(struct ext4_inode_ref *inode_ref,
132 struct ext4_dir_entry_ll *dirent)
134 struct ext4_dir_entry_tail *t;
135 struct ext4_sblock *sb = &inode_ref->fs->sb;
137 /* Compute the checksum only if the filesystem supports it */
138 if (ext4_sb_feature_ro_com(sb, EXT4_FRO_COM_METADATA_CSUM)) {
139 t = ext4_dir_get_tail(inode_ref, dirent);
141 /* There is no space to hold the checksum */
145 t->checksum = to_le32(ext4_dir_checksum(inode_ref, dirent,
146 (char *)t - (char *)dirent));
150 /**@brief Do some checks before returning iterator.
151 * @param it Iterator to be checked
152 * @param block_size Size of data block
155 static int ext4_dir_iterator_set(struct ext4_dir_iterator *it,
160 uint32_t offset_in_block = it->current_offset % block_size;
162 /* Ensure proper alignment */
163 if ((offset_in_block % 4) != 0)
166 /* Ensure that the core of the entry does not overflow the block */
167 if (offset_in_block > block_size - 8)
170 struct ext4_dir_entry_ll *entry =
171 (void *)(it->current_block.data + offset_in_block);
173 /* Ensure that the whole entry does not overflow the block */
174 uint16_t length = ext4_dir_entry_ll_get_entry_length(entry);
175 if (offset_in_block + length > block_size)
178 /* Ensure the name length is not too large */
179 if (ext4_dir_entry_ll_get_name_length(&it->inode_ref->fs->sb, entry) >
183 /* Everything OK - "publish" the entry */
188 /**@brief Seek to next valid directory entry.
189 * Here can be jumped to the next data block.
190 * @param it Initialized iterator
191 * @param pos Position of the next entry
194 static int ext4_dir_iterator_seek(struct ext4_dir_iterator *it,
198 ext4_inode_get_size(&it->inode_ref->fs->sb, it->inode_ref->inode);
200 /* The iterator is not valid until we seek to the desired position */
203 /* Are we at the end? */
205 if (it->current_block.lb_id) {
207 int rc = ext4_block_set(it->inode_ref->fs->bdev,
209 it->current_block.lb_id = 0;
215 it->current_offset = pos;
219 /* Compute next block address */
220 uint32_t block_size = ext4_sb_get_block_size(&it->inode_ref->fs->sb);
221 uint64_t current_block_idx = it->current_offset / block_size;
222 uint32_t next_block_idx = pos / block_size;
225 * If we don't have a block or are moving across block boundary,
226 * we need to get another block
228 if ((it->current_block.lb_id == 0) ||
229 (current_block_idx != next_block_idx)) {
230 if (it->current_block.lb_id) {
231 int rc = ext4_block_set(it->inode_ref->fs->bdev,
233 it->current_block.lb_id = 0;
239 ext4_fsblk_t next_block_phys_idx;
240 int rc = ext4_fs_get_inode_data_block_index(
241 it->inode_ref, next_block_idx,
242 &next_block_phys_idx,
247 rc = ext4_block_get(it->inode_ref->fs->bdev, &it->current_block,
248 next_block_phys_idx);
250 it->current_block.lb_id = 0;
255 it->current_offset = pos;
257 return ext4_dir_iterator_set(it, block_size);
260 int ext4_dir_iterator_init(struct ext4_dir_iterator *it,
261 struct ext4_inode_ref *inode_ref, uint64_t pos)
263 it->inode_ref = inode_ref;
265 it->current_offset = 0;
266 it->current_block.lb_id = 0;
268 return ext4_dir_iterator_seek(it, pos);
271 int ext4_dir_iterator_next(struct ext4_dir_iterator *it)
277 skip = ext4_dir_entry_ll_get_entry_length(it->current);
278 r = ext4_dir_iterator_seek(it, it->current_offset + skip);
282 /*Skip NULL referenced entry*/
283 if (ext4_dir_entry_ll_get_inode(it->current) != 0)
290 int ext4_dir_iterator_fini(struct ext4_dir_iterator *it)
294 if (it->current_block.lb_id)
295 return ext4_block_set(it->inode_ref->fs->bdev,
301 void ext4_dir_write_entry(struct ext4_sblock *sb,
302 struct ext4_dir_entry_ll *entry,
303 uint16_t entry_len, struct ext4_inode_ref *child,
304 const char *name, size_t name_len)
306 /* Check maximum entry length */
307 ext4_assert(entry_len <= ext4_sb_get_block_size(sb));
309 /* Set type of entry */
310 switch (ext4_inode_type(sb, child->inode)) {
311 case EXT4_INODE_MODE_DIRECTORY:
312 ext4_dir_entry_ll_set_inode_type(sb, entry,
315 case EXT4_INODE_MODE_FILE:
316 ext4_dir_entry_ll_set_inode_type(
317 sb, entry, EXT4_DIRENTRY_REG_FILE);
319 case EXT4_INODE_MODE_SOFTLINK:
320 ext4_dir_entry_ll_set_inode_type(
321 sb, entry, EXT4_DIRENTRY_SYMLINK);
324 /* FIXME: right now we only support 3 inode type. */
328 /* Set basic attributes */
329 ext4_dir_entry_ll_set_inode(entry, child->index);
330 ext4_dir_entry_ll_set_entry_length(entry, entry_len);
331 ext4_dir_entry_ll_set_name_length(sb, entry, name_len);
334 memcpy(entry->name, name, name_len);
337 int ext4_dir_add_entry(struct ext4_inode_ref *parent, const char *name,
338 uint32_t name_len, struct ext4_inode_ref *child)
340 struct ext4_fs *fs = parent->fs;
342 #if CONFIG_DIR_INDEX_ENABLE
343 /* Index adding (if allowed) */
344 if ((ext4_sb_feature_com(&fs->sb, EXT4_FCOM_DIR_INDEX)) &&
345 (ext4_inode_has_flag(parent->inode, EXT4_INODE_FLAG_INDEX))) {
346 int rc = ext4_dir_dx_add_entry(parent, child, name);
348 /* Check if index is not corrupted */
349 if (rc != EXT4_ERR_BAD_DX_DIR) {
356 /* Needed to clear dir index flag if corrupted */
357 ext4_inode_clear_flag(parent->inode, EXT4_INODE_FLAG_INDEX);
358 parent->dirty = true;
362 /* Linear algorithm */
364 ext4_fsblk_t fblock = 0;
365 uint32_t block_size = ext4_sb_get_block_size(&fs->sb);
366 uint32_t inode_size = ext4_inode_get_size(&fs->sb, parent->inode);
367 uint32_t total_blocks = inode_size / block_size;
369 /* Find block, where is space for new entry and try to add */
370 bool success = false;
371 for (iblock = 0; iblock < total_blocks; ++iblock) {
373 ext4_fs_get_inode_data_block_index(parent,
379 struct ext4_block block;
380 rc = ext4_block_get(fs->bdev, &block, fblock);
384 if (!ext4_dir_checksum_verify(
386 (struct ext4_dir_entry_ll *)
389 DBG_WARN "Leaf block checksum failed."
390 "Inode: %" PRIu32", "
391 "Block: %" PRIu32"\n",
396 /* If adding is successful, function can finish */
397 rc = ext4_dir_try_insert_entry(&fs->sb, parent, &block, child, name,
402 rc = ext4_block_set(fs->bdev, &block);
410 /* No free block found - needed to allocate next data block */
414 int rc = ext4_fs_append_inode_block(parent, &fblock, &iblock);
419 struct ext4_block new_block;
421 rc = ext4_block_get_noread(fs->bdev, &new_block, fblock);
425 /* Fill block with zeroes */
426 memset(new_block.data, 0, block_size);
427 struct ext4_dir_entry_ll *block_entry = (void *)new_block.data;
430 if (ext4_sb_feature_ro_com(&fs->sb, EXT4_FRO_COM_METADATA_CSUM)) {
431 ext4_dir_write_entry(&fs->sb, block_entry,
432 block_size - sizeof(struct ext4_dir_entry_tail),
435 initialize_dir_tail(EXT4_DIRENT_TAIL(new_block.data,
436 ext4_sb_get_block_size(&fs->sb)));
438 ext4_dir_write_entry(&fs->sb, block_entry, block_size, child, name,
441 ext4_dir_set_checksum(parent,
442 (struct ext4_dir_entry_ll *)new_block.data);
443 new_block.dirty = true;
444 rc = ext4_block_set(fs->bdev, &new_block);
449 int ext4_dir_find_entry(struct ext4_dir_search_result *result,
450 struct ext4_inode_ref *parent, const char *name,
453 struct ext4_sblock *sb = &parent->fs->sb;
456 result->block.lb_id = 0;
457 result->dentry = NULL;
459 #if CONFIG_DIR_INDEX_ENABLE
461 if ((ext4_sb_feature_com(sb, EXT4_FCOM_DIR_INDEX)) &&
462 (ext4_inode_has_flag(parent->inode, EXT4_INODE_FLAG_INDEX))) {
463 int rc = ext4_dir_dx_find_entry(result, parent, name_len, name);
465 /* Check if index is not corrupted */
466 if (rc != EXT4_ERR_BAD_DX_DIR) {
473 /* Needed to clear dir index flag if corrupted */
474 ext4_inode_clear_flag(parent->inode, EXT4_INODE_FLAG_INDEX);
475 parent->dirty = true;
479 /* Linear algorithm */
483 uint32_t block_size = ext4_sb_get_block_size(sb);
484 uint32_t inode_size = ext4_inode_get_size(sb, parent->inode);
485 uint32_t total_blocks = inode_size / block_size;
487 /* Walk through all data blocks */
488 for (iblock = 0; iblock < total_blocks; ++iblock) {
489 /* Load block address */
491 ext4_fs_get_inode_data_block_index(parent,
497 /* Load data block */
498 struct ext4_block block;
499 rc = ext4_block_get(parent->fs->bdev, &block, fblock);
503 if (!ext4_dir_checksum_verify(
505 (struct ext4_dir_entry_ll *)
508 DBG_WARN "Leaf block checksum failed."
509 "Inode: %" PRIu32", "
510 "Block: %" PRIu32"\n",
515 /* Try to find entry in block */
516 struct ext4_dir_entry_ll *res_entry;
517 rc = ext4_dir_find_in_block(&block, sb, name_len, name,
520 result->block = block;
521 result->dentry = res_entry;
525 /* Entry not found - put block and continue to the next block */
527 rc = ext4_block_set(parent->fs->bdev, &block);
535 int ext4_dir_remove_entry(struct ext4_inode_ref *parent, const char *name,
538 /* Check if removing from directory */
539 if (!ext4_inode_is_type(&parent->fs->sb, parent->inode,
540 EXT4_INODE_MODE_DIRECTORY))
543 /* Try to find entry */
544 struct ext4_dir_search_result result;
545 int rc = ext4_dir_find_entry(&result, parent, name, name_len);
549 /* Invalidate entry */
550 ext4_dir_entry_ll_set_inode(result.dentry, 0);
552 /* Store entry position in block */
553 uint32_t pos = (uint8_t *)result.dentry - result.block.data;
556 * If entry is not the first in block, it must be merged
557 * with previous entry
562 /* Start from the first entry in block */
563 struct ext4_dir_entry_ll *tmp_dentry =
564 (void *)result.block.data;
565 uint16_t tmp_dentry_length =
566 ext4_dir_entry_ll_get_entry_length(tmp_dentry);
568 /* Find direct predecessor of removed entry */
569 while ((offset + tmp_dentry_length) < pos) {
571 ext4_dir_entry_ll_get_entry_length(tmp_dentry);
572 tmp_dentry = (void *)(result.block.data + offset);
574 ext4_dir_entry_ll_get_entry_length(tmp_dentry);
577 ext4_assert(tmp_dentry_length + offset == pos);
579 /* Add to removed entry length to predecessor's length */
580 uint16_t del_entry_length =
581 ext4_dir_entry_ll_get_entry_length(result.dentry);
582 ext4_dir_entry_ll_set_entry_length(
583 tmp_dentry, tmp_dentry_length + del_entry_length);
586 ext4_dir_set_checksum(parent,
587 (struct ext4_dir_entry_ll *)result.block.data);
588 result.block.dirty = true;
590 return ext4_dir_destroy_result(parent, &result);
593 int ext4_dir_try_insert_entry(struct ext4_sblock *sb,
594 struct ext4_inode_ref *inode_ref,
595 struct ext4_block *target_block,
596 struct ext4_inode_ref *child, const char *name,
599 /* Compute required length entry and align it to 4 bytes */
600 uint32_t block_size = ext4_sb_get_block_size(sb);
601 uint16_t required_len =
602 sizeof(struct ext4_fake_dir_entry) + name_len;
604 if ((required_len % 4) != 0)
605 required_len += 4 - (required_len % 4);
607 /* Initialize pointers, stop means to upper bound */
608 struct ext4_dir_entry_ll *dentry = (void *)target_block->data;
609 struct ext4_dir_entry_ll *stop =
610 (void *)(target_block->data + block_size);
613 * Walk through the block and check for invalid entries
614 * or entries with free space for new entry
616 while (dentry < stop) {
617 uint32_t inode = ext4_dir_entry_ll_get_inode(dentry);
618 uint16_t rec_len = ext4_dir_entry_ll_get_entry_length(dentry);
619 uint8_t inode_type = ext4_dir_entry_ll_get_inode_type(sb, dentry);
621 /* If invalid and large enough entry, use it */
623 (inode_type != EXT4_DIRENTRY_DIR_CSUM) &&
624 (rec_len >= required_len)) {
625 ext4_dir_write_entry(sb, dentry, rec_len, child, name,
627 ext4_dir_set_checksum(inode_ref,
628 (struct ext4_dir_entry_ll *)
630 target_block->dirty = true;
635 /* Valid entry, try to split it */
637 uint16_t used_name_len =
638 ext4_dir_entry_ll_get_name_length(sb, dentry);
640 uint16_t used_space =
641 sizeof(struct ext4_fake_dir_entry) +
644 if ((used_name_len % 4) != 0)
645 used_space += 4 - (used_name_len % 4);
647 uint16_t free_space = rec_len - used_space;
649 /* There is free space for new entry */
650 if (free_space >= required_len) {
651 /* Cut tail of current entry */
652 ext4_dir_entry_ll_set_entry_length(dentry,
654 struct ext4_dir_entry_ll *new_entry =
655 (void *)((uint8_t *)dentry + used_space);
656 ext4_dir_write_entry(sb, new_entry, free_space,
657 child, name, name_len);
659 ext4_dir_set_checksum(inode_ref,
660 (struct ext4_dir_entry_ll *)
662 target_block->dirty = true;
667 /* Jump to the next entry */
668 dentry = (void *)((uint8_t *)dentry + rec_len);
671 /* No free space found for new entry */
675 int ext4_dir_find_in_block(struct ext4_block *block, struct ext4_sblock *sb,
676 size_t name_len, const char *name,
677 struct ext4_dir_entry_ll **res_entry)
679 /* Start from the first entry in block */
680 struct ext4_dir_entry_ll *dentry =
681 (struct ext4_dir_entry_ll *)block->data;
683 /* Set upper bound for cycling */
684 uint8_t *addr_limit = block->data + ext4_sb_get_block_size(sb);
686 /* Walk through the block and check entries */
687 while ((uint8_t *)dentry < addr_limit) {
688 /* Termination condition */
689 if ((uint8_t *)dentry + name_len > addr_limit)
692 /* Valid entry - check it */
693 if (ext4_dir_entry_ll_get_inode(dentry) != 0) {
694 /* For more efficient compare only lengths firstly*/
695 if (ext4_dir_entry_ll_get_name_length(sb, dentry) ==
698 if (memcmp((uint8_t *)name, dentry->name,
706 uint16_t dentry_len =
707 ext4_dir_entry_ll_get_entry_length(dentry);
709 /* Corrupted entry */
713 /* Jump to next entry */
714 dentry = (struct ext4_dir_entry_ll *)((uint8_t *)dentry +
718 /* Entry not found */
722 int ext4_dir_destroy_result(struct ext4_inode_ref *parent,
723 struct ext4_dir_search_result *result)
725 if (result->block.lb_id)
726 return ext4_block_set(parent->fs->bdev, &result->block);