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 void ext4_dir_init_entry_tail(struct ext4_dir_entry_tail *t)
125 memset(t, 0, sizeof(struct ext4_dir_entry_tail));
126 t->rec_len = to_le16(sizeof(struct ext4_dir_entry_tail));
127 t->reserved_ft = EXT4_DIRENTRY_DIR_CSUM;
130 void ext4_dir_set_checksum(struct ext4_inode_ref *inode_ref,
131 struct ext4_dir_entry_ll *dirent)
133 struct ext4_dir_entry_tail *t;
134 struct ext4_sblock *sb = &inode_ref->fs->sb;
136 /* Compute the checksum only if the filesystem supports it */
137 if (ext4_sb_feature_ro_com(sb, EXT4_FRO_COM_METADATA_CSUM)) {
138 t = ext4_dir_get_tail(inode_ref, dirent);
140 /* There is no space to hold the checksum */
144 t->checksum = to_le32(ext4_dir_checksum(inode_ref, dirent,
145 (char *)t - (char *)dirent));
149 /**@brief Do some checks before returning iterator.
150 * @param it Iterator to be checked
151 * @param block_size Size of data block
154 static int ext4_dir_iterator_set(struct ext4_dir_iterator *it,
159 uint32_t offset_in_block = it->current_offset % block_size;
161 /* Ensure proper alignment */
162 if ((offset_in_block % 4) != 0)
165 /* Ensure that the core of the entry does not overflow the block */
166 if (offset_in_block > block_size - 8)
169 struct ext4_dir_entry_ll *entry =
170 (void *)(it->current_block.data + offset_in_block);
172 /* Ensure that the whole entry does not overflow the block */
173 uint16_t length = ext4_dir_entry_ll_get_entry_length(entry);
174 if (offset_in_block + length > block_size)
177 /* Ensure the name length is not too large */
178 if (ext4_dir_entry_ll_get_name_length(&it->inode_ref->fs->sb, entry) >
182 /* Everything OK - "publish" the entry */
187 /**@brief Seek to next valid directory entry.
188 * Here can be jumped to the next data block.
189 * @param it Initialized iterator
190 * @param pos Position of the next entry
193 static int ext4_dir_iterator_seek(struct ext4_dir_iterator *it,
197 ext4_inode_get_size(&it->inode_ref->fs->sb, it->inode_ref->inode);
199 /* The iterator is not valid until we seek to the desired position */
202 /* Are we at the end? */
204 if (it->current_block.lb_id) {
206 int rc = ext4_block_set(it->inode_ref->fs->bdev,
208 it->current_block.lb_id = 0;
214 it->current_offset = pos;
218 /* Compute next block address */
219 uint32_t block_size = ext4_sb_get_block_size(&it->inode_ref->fs->sb);
220 uint64_t current_block_idx = it->current_offset / block_size;
221 uint32_t next_block_idx = pos / block_size;
224 * If we don't have a block or are moving across block boundary,
225 * we need to get another block
227 if ((it->current_block.lb_id == 0) ||
228 (current_block_idx != next_block_idx)) {
229 if (it->current_block.lb_id) {
230 int rc = ext4_block_set(it->inode_ref->fs->bdev,
232 it->current_block.lb_id = 0;
238 ext4_fsblk_t next_block_phys_idx;
239 int rc = ext4_fs_get_inode_data_block_index(
240 it->inode_ref, next_block_idx,
241 &next_block_phys_idx,
246 rc = ext4_block_get(it->inode_ref->fs->bdev, &it->current_block,
247 next_block_phys_idx);
249 it->current_block.lb_id = 0;
254 it->current_offset = pos;
256 return ext4_dir_iterator_set(it, block_size);
259 int ext4_dir_iterator_init(struct ext4_dir_iterator *it,
260 struct ext4_inode_ref *inode_ref, uint64_t pos)
262 it->inode_ref = inode_ref;
264 it->current_offset = 0;
265 it->current_block.lb_id = 0;
267 return ext4_dir_iterator_seek(it, pos);
270 int ext4_dir_iterator_next(struct ext4_dir_iterator *it)
276 skip = ext4_dir_entry_ll_get_entry_length(it->current);
277 r = ext4_dir_iterator_seek(it, it->current_offset + skip);
281 /*Skip NULL referenced entry*/
282 if (ext4_dir_entry_ll_get_inode(it->current) != 0)
289 int ext4_dir_iterator_fini(struct ext4_dir_iterator *it)
293 if (it->current_block.lb_id)
294 return ext4_block_set(it->inode_ref->fs->bdev,
300 void ext4_dir_write_entry(struct ext4_sblock *sb,
301 struct ext4_dir_entry_ll *entry,
302 uint16_t entry_len, struct ext4_inode_ref *child,
303 const char *name, size_t name_len)
305 /* Check maximum entry length */
306 ext4_assert(entry_len <= ext4_sb_get_block_size(sb));
308 /* Set type of entry */
309 switch (ext4_inode_type(sb, child->inode)) {
310 case EXT4_INODE_MODE_DIRECTORY:
311 ext4_dir_entry_ll_set_inode_type(sb, entry, EXT4_DIRENTRY_DIR);
313 case EXT4_INODE_MODE_FILE:
314 ext4_dir_entry_ll_set_inode_type(sb, entry,
315 EXT4_DIRENTRY_REG_FILE);
317 case EXT4_INODE_MODE_SOFTLINK:
318 ext4_dir_entry_ll_set_inode_type(sb, entry,
319 EXT4_DIRENTRY_SYMLINK);
322 /* FIXME: right now we only support 3 inode type. */
326 /* Set basic attributes */
327 ext4_dir_entry_ll_set_inode(entry, child->index);
328 ext4_dir_entry_ll_set_entry_length(entry, entry_len);
329 ext4_dir_entry_ll_set_name_length(sb, entry, name_len);
332 memcpy(entry->name, name, name_len);
335 int ext4_dir_add_entry(struct ext4_inode_ref *parent, const char *name,
336 uint32_t name_len, struct ext4_inode_ref *child)
338 struct ext4_fs *fs = parent->fs;
340 #if CONFIG_DIR_INDEX_ENABLE
341 /* Index adding (if allowed) */
342 if ((ext4_sb_feature_com(&fs->sb, EXT4_FCOM_DIR_INDEX)) &&
343 (ext4_inode_has_flag(parent->inode, EXT4_INODE_FLAG_INDEX))) {
344 int rc = ext4_dir_dx_add_entry(parent, child, name);
346 /* Check if index is not corrupted */
347 if (rc != EXT4_ERR_BAD_DX_DIR) {
354 /* Needed to clear dir index flag if corrupted */
355 ext4_inode_clear_flag(parent->inode, EXT4_INODE_FLAG_INDEX);
356 parent->dirty = true;
360 /* Linear algorithm */
362 ext4_fsblk_t fblock = 0;
363 uint32_t block_size = ext4_sb_get_block_size(&fs->sb);
364 uint32_t inode_size = ext4_inode_get_size(&fs->sb, parent->inode);
365 uint32_t total_blocks = inode_size / block_size;
367 /* Find block, where is space for new entry and try to add */
368 bool success = false;
369 for (iblock = 0; iblock < total_blocks; ++iblock) {
371 ext4_fs_get_inode_data_block_index(parent,
377 struct ext4_block block;
378 rc = ext4_block_get(fs->bdev, &block, fblock);
382 if (!ext4_dir_checksum_verify(
384 (struct ext4_dir_entry_ll *)
387 DBG_WARN "Leaf block checksum failed."
388 "Inode: %" PRIu32", "
389 "Block: %" PRIu32"\n",
394 /* If adding is successful, function can finish */
395 rc = ext4_dir_try_insert_entry(&fs->sb, parent, &block, child, name,
400 rc = ext4_block_set(fs->bdev, &block);
408 /* No free block found - needed to allocate next data block */
412 int rc = ext4_fs_append_inode_block(parent, &fblock, &iblock);
417 struct ext4_block new_block;
419 rc = ext4_block_get_noread(fs->bdev, &new_block, fblock);
423 /* Fill block with zeroes */
424 memset(new_block.data, 0, block_size);
425 struct ext4_dir_entry_ll *block_entry = (void *)new_block.data;
428 if (ext4_sb_feature_ro_com(&fs->sb, EXT4_FRO_COM_METADATA_CSUM)) {
429 ext4_dir_write_entry(&fs->sb, block_entry,
430 block_size - sizeof(struct ext4_dir_entry_tail),
433 ext4_dir_init_entry_tail(EXT4_DIRENT_TAIL(new_block.data,
434 ext4_sb_get_block_size(&fs->sb)));
436 ext4_dir_write_entry(&fs->sb, block_entry, block_size, child, name,
439 ext4_dir_set_checksum(parent,
440 (struct ext4_dir_entry_ll *)new_block.data);
441 new_block.dirty = true;
442 rc = ext4_block_set(fs->bdev, &new_block);
447 int ext4_dir_find_entry(struct ext4_dir_search_result *result,
448 struct ext4_inode_ref *parent, const char *name,
451 struct ext4_sblock *sb = &parent->fs->sb;
454 result->block.lb_id = 0;
455 result->dentry = NULL;
457 #if CONFIG_DIR_INDEX_ENABLE
459 if ((ext4_sb_feature_com(sb, EXT4_FCOM_DIR_INDEX)) &&
460 (ext4_inode_has_flag(parent->inode, EXT4_INODE_FLAG_INDEX))) {
461 int rc = ext4_dir_dx_find_entry(result, parent, name_len, name);
463 /* Check if index is not corrupted */
464 if (rc != EXT4_ERR_BAD_DX_DIR) {
471 /* Needed to clear dir index flag if corrupted */
472 ext4_inode_clear_flag(parent->inode, EXT4_INODE_FLAG_INDEX);
473 parent->dirty = true;
477 /* Linear algorithm */
481 uint32_t block_size = ext4_sb_get_block_size(sb);
482 uint32_t inode_size = ext4_inode_get_size(sb, parent->inode);
483 uint32_t total_blocks = inode_size / block_size;
485 /* Walk through all data blocks */
486 for (iblock = 0; iblock < total_blocks; ++iblock) {
487 /* Load block address */
489 ext4_fs_get_inode_data_block_index(parent,
495 /* Load data block */
496 struct ext4_block block;
497 rc = ext4_block_get(parent->fs->bdev, &block, fblock);
501 if (!ext4_dir_checksum_verify(
503 (struct ext4_dir_entry_ll *)
506 DBG_WARN "Leaf block checksum failed."
507 "Inode: %" PRIu32", "
508 "Block: %" PRIu32"\n",
513 /* Try to find entry in block */
514 struct ext4_dir_entry_ll *res_entry;
515 rc = ext4_dir_find_in_block(&block, sb, name_len, name,
518 result->block = block;
519 result->dentry = res_entry;
523 /* Entry not found - put block and continue to the next block */
525 rc = ext4_block_set(parent->fs->bdev, &block);
533 int ext4_dir_remove_entry(struct ext4_inode_ref *parent, const char *name,
536 /* Check if removing from directory */
537 if (!ext4_inode_is_type(&parent->fs->sb, parent->inode,
538 EXT4_INODE_MODE_DIRECTORY))
541 /* Try to find entry */
542 struct ext4_dir_search_result result;
543 int rc = ext4_dir_find_entry(&result, parent, name, name_len);
547 /* Invalidate entry */
548 ext4_dir_entry_ll_set_inode(result.dentry, 0);
550 /* Store entry position in block */
551 uint32_t pos = (uint8_t *)result.dentry - result.block.data;
554 * If entry is not the first in block, it must be merged
555 * with previous entry
560 /* Start from the first entry in block */
561 struct ext4_dir_entry_ll *tmp_dentry =
562 (void *)result.block.data;
563 uint16_t tmp_dentry_length =
564 ext4_dir_entry_ll_get_entry_length(tmp_dentry);
566 /* Find direct predecessor of removed entry */
567 while ((offset + tmp_dentry_length) < pos) {
569 ext4_dir_entry_ll_get_entry_length(tmp_dentry);
570 tmp_dentry = (void *)(result.block.data + offset);
572 ext4_dir_entry_ll_get_entry_length(tmp_dentry);
575 ext4_assert(tmp_dentry_length + offset == pos);
577 /* Add to removed entry length to predecessor's length */
578 uint16_t del_entry_length =
579 ext4_dir_entry_ll_get_entry_length(result.dentry);
580 ext4_dir_entry_ll_set_entry_length(
581 tmp_dentry, tmp_dentry_length + del_entry_length);
584 ext4_dir_set_checksum(parent,
585 (struct ext4_dir_entry_ll *)result.block.data);
586 result.block.dirty = true;
588 return ext4_dir_destroy_result(parent, &result);
591 int ext4_dir_try_insert_entry(struct ext4_sblock *sb,
592 struct ext4_inode_ref *inode_ref,
593 struct ext4_block *target_block,
594 struct ext4_inode_ref *child, const char *name,
597 /* Compute required length entry and align it to 4 bytes */
598 uint32_t block_size = ext4_sb_get_block_size(sb);
599 uint16_t required_len =
600 sizeof(struct ext4_fake_dir_entry) + name_len;
602 if ((required_len % 4) != 0)
603 required_len += 4 - (required_len % 4);
605 /* Initialize pointers, stop means to upper bound */
606 struct ext4_dir_entry_ll *dentry = (void *)target_block->data;
607 struct ext4_dir_entry_ll *stop =
608 (void *)(target_block->data + block_size);
611 * Walk through the block and check for invalid entries
612 * or entries with free space for new entry
614 while (dentry < stop) {
615 uint32_t inode = ext4_dir_entry_ll_get_inode(dentry);
616 uint16_t rec_len = ext4_dir_entry_ll_get_entry_length(dentry);
617 uint8_t inode_type = ext4_dir_entry_ll_get_inode_type(sb, dentry);
619 /* If invalid and large enough entry, use it */
621 (inode_type != EXT4_DIRENTRY_DIR_CSUM) &&
622 (rec_len >= required_len)) {
623 ext4_dir_write_entry(sb, dentry, rec_len, child, name,
625 ext4_dir_set_checksum(inode_ref,
626 (struct ext4_dir_entry_ll *)
628 target_block->dirty = true;
633 /* Valid entry, try to split it */
635 uint16_t used_name_len =
636 ext4_dir_entry_ll_get_name_length(sb, dentry);
638 uint16_t used_space =
639 sizeof(struct ext4_fake_dir_entry) +
642 if ((used_name_len % 4) != 0)
643 used_space += 4 - (used_name_len % 4);
645 uint16_t free_space = rec_len - used_space;
647 /* There is free space for new entry */
648 if (free_space >= required_len) {
649 /* Cut tail of current entry */
650 ext4_dir_entry_ll_set_entry_length(dentry,
652 struct ext4_dir_entry_ll *new_entry =
653 (void *)((uint8_t *)dentry + used_space);
654 ext4_dir_write_entry(sb, new_entry, free_space,
655 child, name, name_len);
657 ext4_dir_set_checksum(inode_ref,
658 (struct ext4_dir_entry_ll *)
660 target_block->dirty = true;
665 /* Jump to the next entry */
666 dentry = (void *)((uint8_t *)dentry + rec_len);
669 /* No free space found for new entry */
673 int ext4_dir_find_in_block(struct ext4_block *block, struct ext4_sblock *sb,
674 size_t name_len, const char *name,
675 struct ext4_dir_entry_ll **res_entry)
677 /* Start from the first entry in block */
678 struct ext4_dir_entry_ll *dentry =
679 (struct ext4_dir_entry_ll *)block->data;
681 /* Set upper bound for cycling */
682 uint8_t *addr_limit = block->data + ext4_sb_get_block_size(sb);
684 /* Walk through the block and check entries */
685 while ((uint8_t *)dentry < addr_limit) {
686 /* Termination condition */
687 if ((uint8_t *)dentry + name_len > addr_limit)
690 /* Valid entry - check it */
691 if (ext4_dir_entry_ll_get_inode(dentry) != 0) {
692 /* For more efficient compare only lengths firstly*/
693 if (ext4_dir_entry_ll_get_name_length(sb, dentry) ==
696 if (memcmp((uint8_t *)name, dentry->name,
704 uint16_t dentry_len =
705 ext4_dir_entry_ll_get_entry_length(dentry);
707 /* Corrupted entry */
711 /* Jump to next entry */
712 dentry = (struct ext4_dir_entry_ll *)((uint8_t *)dentry +
716 /* Entry not found */
720 int ext4_dir_destroy_result(struct ext4_inode_ref *parent,
721 struct ext4_dir_search_result *result)
723 if (result->block.lb_id)
724 return ext4_block_set(parent->fs->bdev, &result->block);