2 * Copyright (c) 2013 Grzegorz Kostka (kostka.grzegorz@gmail.com)
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
9 * - Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * - Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * - The name of the author may not be used to endorse or promote products
15 * derived from this software without specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 /** @addtogroup lwext4
34 * @brief Ext4 high level operations (file, directory, mountpoints...)
37 #include "ext4_config.h"
38 #include "ext4_blockdev.h"
39 #include "ext4_types.h"
40 #include "ext4_debug.h"
41 #include "ext4_errno.h"
44 #include "ext4_inode.h"
45 #include "ext4_super.h"
46 #include "ext4_dir_idx.h"
47 #include "ext4_xattr.h"
53 /**@brief Mount point OS dependent lock*/
54 #define EXT4_MP_LOCK(_m) \
57 (_m)->os_locks->lock(); \
60 /**@brief Mount point OS dependent unlock*/
61 #define EXT4_MP_UNLOCK(_m) \
64 (_m)->os_locks->unlock(); \
67 /**@brief Mount point descriptor.*/
68 struct ext4_mountpoint {
70 /**@brief Mount done flag.*/
73 /**@brief Mount point name (@ref ext4_mount)*/
76 /**@brief OS dependent lock/unlock functions.*/
77 const struct ext4_lock *os_locks;
79 /**@brief Ext4 filesystem internals.*/
82 /**@brief Dynamic allocation cache flag.*/
86 /**@brief Block devices descriptor.*/
87 struct _ext4_devices {
89 /**@brief Block device name (@ref ext4_device_register)*/
92 /**@brief Block device handle.*/
93 struct ext4_blockdev *bd;
95 /**@brief Block cache handle.*/
96 struct ext4_bcache *bc;
99 /**@brief Block devices.*/
100 struct _ext4_devices _bdevices[CONFIG_EXT4_BLOCKDEVS_COUNT];
102 /**@brief Mountpoints.*/
103 struct ext4_mountpoint _mp[CONFIG_EXT4_MOUNTPOINTS_COUNT];
105 int ext4_device_register(struct ext4_blockdev *bd, struct ext4_bcache *bc,
106 const char *dev_name)
109 ext4_assert(bd && dev_name);
111 for (i = 0; i < CONFIG_EXT4_BLOCKDEVS_COUNT; ++i) {
112 if (!_bdevices[i].bd) {
113 strcpy(_bdevices[i].name, dev_name);
114 _bdevices[i].bd = bd;
115 _bdevices[i].bc = bc;
119 if (!strcmp(_bdevices[i].name, dev_name))
125 /****************************************************************************/
127 static bool ext4_is_dots(const uint8_t *name, size_t name_size)
129 if ((name_size == 1) && (name[0] == '.'))
132 if ((name_size == 2) && (name[0] == '.') && (name[1] == '.'))
138 static int ext4_has_children(bool *has_children, struct ext4_inode_ref *enode)
140 struct ext4_fs *fs = enode->fs;
142 /* Check if node is directory */
143 if (!ext4_inode_is_type(&fs->sb, enode->inode,
144 EXT4_INODE_MODE_DIRECTORY)) {
145 *has_children = false;
149 struct ext4_directory_iterator it;
150 int rc = ext4_dir_iterator_init(&it, enode, 0);
154 /* Find a non-empty directory entry */
156 while (it.current != NULL) {
157 if (ext4_dir_entry_ll_get_inode(it.current) != 0) {
158 uint16_t name_size = ext4_dir_entry_ll_get_name_length(
159 &fs->sb, it.current);
160 if (!ext4_is_dots(it.current->name, name_size)) {
166 rc = ext4_dir_iterator_next(&it);
168 ext4_dir_iterator_fini(&it);
173 rc = ext4_dir_iterator_fini(&it);
177 *has_children = found;
182 static int ext4_link(struct ext4_mountpoint *mp, struct ext4_inode_ref *parent,
183 struct ext4_inode_ref *child, const char *name,
184 uint32_t name_len, bool rename)
186 /* Check maximum name length */
187 if (name_len > EXT4_DIRECTORY_FILENAME_LEN)
190 /* Add entry to parent directory */
191 int rc = ext4_dir_add_entry(parent, name, name_len, child);
195 /* Fill new dir -> add '.' and '..' entries.
196 * Also newly allocated inode should have 0 link count.
198 if (ext4_inode_is_type(&mp->fs.sb, child->inode,
199 EXT4_INODE_MODE_DIRECTORY) &&
201 rc = ext4_dir_add_entry(child, ".", strlen("."), child);
203 ext4_dir_remove_entry(parent, name, strlen(name));
207 rc = ext4_dir_add_entry(child, "..", strlen(".."), parent);
209 ext4_dir_remove_entry(parent, name, strlen(name));
210 ext4_dir_remove_entry(child, ".", strlen("."));
214 /*New empty directory. Two links (. and ..) */
215 ext4_inode_set_links_count(child->inode, 2);
217 #if CONFIG_DIR_INDEX_ENABLE
218 /* Initialize directory index if supported */
219 if (ext4_sb_has_feature_compatible(
220 &mp->fs.sb, EXT4_FEATURE_COMPAT_DIR_INDEX)) {
221 rc = ext4_dir_dx_init(child);
225 ext4_inode_set_flag(child->inode,
226 EXT4_INODE_FLAG_INDEX);
231 ext4_fs_inode_links_count_inc(parent);
233 parent->dirty = true;
236 * In case we want to rename a directory,
237 * we reset the original '..' pointer.
239 if (ext4_inode_is_type(&mp->fs.sb, child->inode,
240 EXT4_INODE_MODE_DIRECTORY)) {
242 ext4_inode_has_flag(child->inode,
243 EXT4_INODE_FLAG_INDEX);
244 struct ext4_directory_search_result result;
245 if (!has_flag_index) {
246 rc = ext4_dir_find_entry(&result,
252 ext4_dir_entry_ll_set_inode(result.dentry,
254 result.block.dirty = true;
255 rc = ext4_dir_destroy_result(child, &result);
260 #if CONFIG_DIR_INDEX_ENABLE
261 rc = ext4_dir_dx_reset_parent_inode(child,
269 ext4_fs_inode_links_count_inc(parent);
270 parent->dirty = true;
273 ext4_fs_inode_links_count_inc(child);
281 static int ext4_unlink(struct ext4_mountpoint *mp,
282 struct ext4_inode_ref *parent,
283 struct ext4_inode_ref *child_inode_ref, const char *name,
287 int rc = ext4_has_children(&has_children, child_inode_ref);
291 /* Cannot unlink non-empty node */
295 /* Remove entry from parent directory */
296 rc = ext4_dir_remove_entry(parent, name, name_len);
300 bool is_dir = ext4_inode_is_type(&mp->fs.sb, child_inode_ref->inode,
301 EXT4_INODE_MODE_DIRECTORY);
303 /* If directory - handle links from parent */
305 // ext4_assert(ext4_inode_get_links_count(child_inode_ref->inode)
307 ext4_fs_inode_links_count_dec(parent);
308 parent->dirty = true;
312 * TODO: Update timestamps of the parent
313 * (when we have wall-clock time).
315 * ext4_inode_set_change_inode_time(parent->inode, (uint32_t) now);
316 * ext4_inode_set_modification_time(parent->inode, (uint32_t) now);
317 * parent->dirty = true;
321 * TODO: Update timestamp for inode.
323 * ext4_inode_set_change_inode_time(child_inode_ref->inode,
326 if (ext4_inode_get_links_count(child_inode_ref->inode)) {
327 ext4_fs_inode_links_count_dec(child_inode_ref);
328 child_inode_ref->dirty = true;
334 /****************************************************************************/
336 int ext4_mount(const char *dev_name, const char *mount_point)
338 ext4_assert(mount_point && dev_name);
343 struct ext4_blockdev *bd = 0;
344 struct ext4_bcache *bc = 0;
345 struct ext4_mountpoint *mp = 0;
347 if (mount_point[strlen(mount_point) - 1] != '/')
350 for (i = 0; i < CONFIG_EXT4_BLOCKDEVS_COUNT; ++i) {
351 if (_bdevices[i].name) {
352 if (!strcmp(dev_name, _bdevices[i].name)) {
353 bd = _bdevices[i].bd;
354 bc = _bdevices[i].bc;
363 for (i = 0; i < CONFIG_EXT4_MOUNTPOINTS_COUNT; ++i) {
364 if (!_mp[i].mounted) {
365 strcpy(_mp[i].name, mount_point);
371 if (!strcmp(_mp[i].name, mount_point))
378 r = ext4_block_init(bd);
382 r = ext4_fs_init(&mp->fs, bd);
388 bsize = ext4_sb_get_block_size(&mp->fs.sb);
389 ext4_block_set_lb_size(bd, bsize);
391 mp->cache_dynamic = 0;
394 /*Automatic block cache alloc.*/
395 mp->cache_dynamic = 1;
396 bc = malloc(sizeof(struct ext4_bcache));
398 r = ext4_bcache_init_dynamic(bc, CONFIG_BLOCK_DEV_CACHE_SIZE,
407 if (bsize != bc->itemsize)
410 /*Bind block cache to block device*/
411 r = ext4_block_bind_bcache(bd, bc);
414 if (mp->cache_dynamic) {
415 ext4_bcache_fini_dynamic(bc);
424 int ext4_umount(const char *mount_point)
428 struct ext4_mountpoint *mp = 0;
430 for (i = 0; i < CONFIG_EXT4_MOUNTPOINTS_COUNT; ++i) {
431 if (!strcmp(_mp[i].name, mount_point)) {
440 r = ext4_fs_fini(&mp->fs);
446 if (mp->cache_dynamic) {
447 ext4_bcache_fini_dynamic(mp->fs.bdev->bc);
448 free(mp->fs.bdev->bc);
451 return ext4_block_fini(mp->fs.bdev);
454 static struct ext4_mountpoint *ext4_get_mount(const char *path)
457 for (i = 0; i < CONFIG_EXT4_MOUNTPOINTS_COUNT; ++i) {
462 if (!strncmp(_mp[i].name, path, strlen(_mp[i].name)))
468 int ext4_mount_point_stats(const char *mount_point,
469 struct ext4_mount_stats *stats)
471 struct ext4_mountpoint *mp = ext4_get_mount(mount_point);
477 stats->inodes_count = ext4_get32(&mp->fs.sb, inodes_count);
478 stats->free_inodes_count = ext4_get32(&mp->fs.sb, free_inodes_count);
479 stats->blocks_count = ext4_sb_get_blocks_cnt(&mp->fs.sb);
480 stats->free_blocks_count = ext4_sb_get_free_blocks_cnt(&mp->fs.sb);
481 stats->block_size = ext4_sb_get_block_size(&mp->fs.sb);
483 stats->block_group_count = ext4_block_group_cnt(&mp->fs.sb);
484 stats->blocks_per_group = ext4_get32(&mp->fs.sb, blocks_per_group);
485 stats->inodes_per_group = ext4_get32(&mp->fs.sb, inodes_per_group);
487 memcpy(stats->volume_name, mp->fs.sb.volume_name, 16);
493 int ext4_mount_setup_locks(const char *mount_point,
494 const struct ext4_lock *locks)
497 struct ext4_mountpoint *mp = 0;
499 for (i = 0; i < CONFIG_EXT4_MOUNTPOINTS_COUNT; ++i) {
500 if (!strcmp(_mp[i].name, mount_point)) {
508 mp->os_locks = locks;
512 /********************************FILE OPERATIONS*****************************/
514 static int ext4_path_check(const char *path, bool *is_goal)
518 for (i = 0; i < EXT4_DIRECTORY_FILENAME_LEN; ++i) {
520 if (path[i] == '/') {
534 static bool ext4_parse_flags(const char *flags, uint32_t *file_flags)
539 if (!strcmp(flags, "r") || !strcmp(flags, "rb")) {
540 *file_flags = O_RDONLY;
544 if (!strcmp(flags, "w") || !strcmp(flags, "wb")) {
545 *file_flags = O_WRONLY | O_CREAT | O_TRUNC;
549 if (!strcmp(flags, "a") || !strcmp(flags, "ab")) {
550 *file_flags = O_WRONLY | O_CREAT | O_APPEND;
554 if (!strcmp(flags, "r+") || !strcmp(flags, "rb+") ||
555 !strcmp(flags, "r+b")) {
556 *file_flags = O_RDWR;
560 if (!strcmp(flags, "w+") || !strcmp(flags, "wb+") ||
561 !strcmp(flags, "w+b")) {
562 *file_flags = O_RDWR | O_CREAT | O_TRUNC;
566 if (!strcmp(flags, "a+") || !strcmp(flags, "ab+") ||
567 !strcmp(flags, "a+b")) {
568 *file_flags = O_RDWR | O_CREAT | O_APPEND;
576 * NOTICE: if filetype is equal to EXT4_DIRENTRY_UNKNOWN,
577 * any filetype of the target dir entry will be accepted.
579 static int ext4_generic_open2(ext4_file *f, const char *path, int flags,
580 int filetype, uint32_t *parent_inode,
583 bool is_goal = false;
584 uint8_t inode_type = EXT4_DIRENTRY_UNKNOWN;
588 struct ext4_mountpoint *mp = ext4_get_mount(path);
589 struct ext4_directory_search_result result;
590 struct ext4_inode_ref ref;
600 path += strlen(mp->name);
603 *name_off = strlen(mp->name);
606 r = ext4_fs_get_inode_ref(&mp->fs, EXT4_INODE_ROOT_INDEX, &ref);
612 *parent_inode = ref.index;
614 int len = ext4_path_check(path, &is_goal);
618 len = ext4_path_check(path, &is_goal);
621 /*If root open was request.*/
623 ((filetype == EXT4_DIRENTRY_DIR) ||
624 (filetype == EXT4_DIRENTRY_UNKNOWN)))
631 r = ext4_dir_find_entry(&result, &ref, path, len);
634 /*Destroy last result*/
635 ext4_dir_destroy_result(&ref, &result);
640 if (!(f->flags & O_CREAT))
643 /*O_CREAT allows create new entry*/
644 struct ext4_inode_ref child_ref;
645 r = ext4_fs_alloc_inode(
648 : EXT4_DIRENTRY_DIR);
653 /*Link with root dir.*/
654 r = ext4_link(mp, &ref, &child_ref, path, len, false);
656 /*Fail. Free new inode.*/
657 ext4_fs_free_inode(&child_ref);
658 /*We do not want to write new inode.
659 But block has to be released.*/
660 child_ref.dirty = false;
661 ext4_fs_put_inode_ref(&child_ref);
665 ext4_fs_put_inode_ref(&child_ref);
671 *parent_inode = ref.index;
673 next_inode = ext4_dir_entry_ll_get_inode(result.dentry);
675 ext4_dir_entry_ll_get_inode_type(&mp->fs.sb, result.dentry);
677 r = ext4_dir_destroy_result(&ref, &result);
681 /*If expected file error*/
682 if (inode_type != EXT4_DIRENTRY_DIR && !is_goal) {
686 if (filetype != EXT4_DIRENTRY_UNKNOWN) {
687 if ((inode_type != filetype) && is_goal) {
693 r = ext4_fs_put_inode_ref(&ref);
697 r = ext4_fs_get_inode_ref(&mp->fs, next_inode, &ref);
707 *name_off += len + 1;
711 ext4_fs_put_inode_ref(&ref);
717 if ((f->flags & O_TRUNC) &&
718 (inode_type == EXT4_DIRENTRY_REG_FILE)) {
720 r = ext4_fs_truncate_inode(&ref, 0);
722 ext4_fs_put_inode_ref(&ref);
728 f->fsize = ext4_inode_get_size(&f->mp->fs.sb, ref.inode);
729 f->inode = ref.index;
732 if (f->flags & O_APPEND)
735 /* FIXME: Debugging code on EA. */
738 struct ext4_xattr_ref xattr_ref;
739 struct ext4_xattr_entry *found_entry = NULL;
740 void *out_data = NULL;
742 private_ret = ext4_fs_get_xattr_ref(&f->mp->fs, &ref,
744 if (private_ret == EOK) {
745 ext4_dmask_set(EXT4_DEBUG_ALL);
746 private_ret = ext4_xattr_lookup(&xattr_ref,
747 EXT4_XATTR_INDEX_POSIX_ACL_ACCESS,
753 if (private_ret == EOK) {
756 ext4_fs_put_xattr_ref(&xattr_ref);
761 r = ext4_fs_put_inode_ref(&ref);
765 /****************************************************************************/
767 static int ext4_generic_open(ext4_file *f, const char *path, const char *flags,
768 bool file_expect, uint32_t *parent_inode,
773 if (ext4_parse_flags(flags, &iflags) == false)
776 if (file_expect == true)
777 filetype = EXT4_DIRENTRY_REG_FILE;
779 filetype = EXT4_DIRENTRY_DIR;
781 return ext4_generic_open2(f, path, iflags, filetype, parent_inode,
785 static int __ext4_create_hardlink(const char *path,
786 struct ext4_inode_ref *child_ref,
789 bool is_goal = false;
790 uint8_t inode_type = EXT4_DIRENTRY_DIR;
794 struct ext4_mountpoint *mp = ext4_get_mount(path);
795 struct ext4_directory_search_result result;
796 struct ext4_inode_ref ref;
802 path += strlen(mp->name);
805 r = ext4_fs_get_inode_ref(&mp->fs, EXT4_INODE_ROOT_INDEX, &ref);
810 int len = ext4_path_check(path, &is_goal);
814 len = ext4_path_check(path, &is_goal);
817 /*If root open was request.*/
825 r = ext4_dir_find_entry(&result, &ref, path, len);
828 /*Destroy last result*/
829 ext4_dir_destroy_result(&ref, &result);
831 if (r != ENOENT || !is_goal)
834 /*Link with root dir.*/
835 r = ext4_link(mp, &ref, child_ref, path, len, rename);
837 } else if (r == EOK && is_goal) {
838 /*Destroy last result*/
839 ext4_dir_destroy_result(&ref, &result);
844 next_inode = result.dentry->inode;
846 ext4_dir_entry_ll_get_inode_type(&mp->fs.sb, result.dentry);
848 r = ext4_dir_destroy_result(&ref, &result);
852 if (inode_type == EXT4_DIRENTRY_REG_FILE) {
861 r = ext4_fs_put_inode_ref(&ref);
865 r = ext4_fs_get_inode_ref(&mp->fs, next_inode, &ref);
876 ext4_fs_put_inode_ref(&ref);
880 r = ext4_fs_put_inode_ref(&ref);
884 static int ext4_remove_orig_reference(const char *path,
886 struct ext4_inode_ref *parent_ref,
887 struct ext4_inode_ref *child_ref)
892 struct ext4_mountpoint *mp = ext4_get_mount(path);
900 len = ext4_path_check(path, &is_goal);
902 /* Remove entry from parent directory */
903 r = ext4_dir_remove_entry(parent_ref, path, len);
907 if (ext4_inode_is_type(&mp->fs.sb, child_ref->inode,
908 EXT4_INODE_MODE_DIRECTORY)) {
909 ext4_fs_inode_links_count_dec(parent_ref);
910 parent_ref->dirty = true;
916 int ext4_flink(const char *path, const char *hardlink_path)
921 bool child_loaded = false;
922 uint32_t parent_inode, child_inode;
923 struct ext4_mountpoint *mp = ext4_get_mount(path);
924 struct ext4_mountpoint *target_mp = ext4_get_mount(hardlink_path);
925 struct ext4_inode_ref child_ref;
930 /* Will that happen? Anyway return EINVAL for such case. */
936 r = ext4_generic_open2(&f, path, O_RDONLY,
937 EXT4_DIRENTRY_UNKNOWN,
938 &parent_inode, &name_off);
942 child_inode = f.inode;
945 /*We have file to unlink. Load it.*/
946 r = ext4_fs_get_inode_ref(&mp->fs, child_inode, &child_ref);
952 /* Creating hardlink for directory is not allowed. */
953 if (ext4_inode_is_type(&mp->fs.sb, child_ref.inode,
954 EXT4_INODE_MODE_DIRECTORY)) {
959 r = __ext4_create_hardlink(hardlink_path, &child_ref, false);
963 ext4_fs_put_inode_ref(&child_ref);
970 int ext4_frename(const char *path, const char *new_path)
975 bool parent_loaded = false, child_loaded = false;
976 uint32_t parent_inode, child_inode;
977 struct ext4_mountpoint *mp = ext4_get_mount(path);
978 struct ext4_inode_ref child_ref, parent_ref;
985 r = ext4_generic_open2(&f, path, O_RDONLY,
986 EXT4_DIRENTRY_UNKNOWN,
987 &parent_inode, &name_off);
991 child_inode = f.inode;
995 r = ext4_fs_get_inode_ref(&mp->fs, parent_inode, &parent_ref);
999 parent_loaded = true;
1001 /*We have file to unlink. Load it.*/
1002 r = ext4_fs_get_inode_ref(&mp->fs, child_inode, &child_ref);
1006 child_loaded = true;
1008 r = __ext4_create_hardlink(new_path, &child_ref, true);
1012 r = ext4_remove_orig_reference(path, name_off,
1013 &parent_ref, &child_ref);
1019 ext4_fs_put_inode_ref(&parent_ref);
1022 ext4_fs_put_inode_ref(&child_ref);
1029 /****************************************************************************/
1031 int ext4_get_sblock(const char *mount_point, struct ext4_sblock **sb)
1033 struct ext4_mountpoint *mp = ext4_get_mount(mount_point);
1042 int ext4_cache_write_back(const char *path, bool on)
1044 struct ext4_mountpoint *mp = ext4_get_mount(path);
1050 ext4_block_cache_write_back(mp->fs.bdev, on);
1055 int ext4_fremove(const char *path)
1058 uint32_t parent_inode;
1063 struct ext4_inode_ref child;
1064 struct ext4_inode_ref parent;
1065 struct ext4_mountpoint *mp = ext4_get_mount(path);
1071 r = ext4_generic_open2(&f, path, O_RDWR,
1072 EXT4_DIRENTRY_UNKNOWN,
1073 &parent_inode, &name_off);
1080 r = ext4_fs_get_inode_ref(&mp->fs, parent_inode, &parent);
1086 /*We have file to delete. Load it.*/
1087 r = ext4_fs_get_inode_ref(&mp->fs, f.inode, &child);
1089 ext4_fs_put_inode_ref(&parent);
1097 len = ext4_path_check(path, &is_goal);
1099 /*Unlink from parent*/
1100 r = ext4_unlink(mp, &parent, &child, path, len);
1104 /*Link count is zero, the inode should be freed. */
1105 if (!ext4_inode_get_links_count(child.inode)) {
1106 ext4_inode_set_deletion_time(child.inode, 0xFFFFFFFF);
1108 ext4_block_cache_write_back(mp->fs.bdev, 1);
1109 /*Truncate may be IO heavy. Do it writeback cache mode.*/
1110 r = ext4_fs_truncate_inode(&child, 0);
1111 ext4_block_cache_write_back(mp->fs.bdev, 0);
1116 r = ext4_fs_free_inode(&child);
1122 ext4_fs_put_inode_ref(&child);
1123 ext4_fs_put_inode_ref(&parent);
1128 int ext4_fill_raw_inode(const char *path,
1130 struct ext4_inode *inode)
1134 struct ext4_inode_ref inode_ref;
1135 struct ext4_mountpoint *mp = ext4_get_mount(path);
1143 r = ext4_generic_open2(&f, path, O_RDONLY,
1144 EXT4_DIRENTRY_UNKNOWN,
1155 r = ext4_fs_get_inode_ref(&mp->fs, ino, &inode_ref);
1161 memcpy(inode, inode_ref.inode, sizeof(struct ext4_inode));
1163 ext4_fs_put_inode_ref(&inode_ref);
1172 int ext4_fopen(ext4_file *f, const char *path, const char *flags)
1174 struct ext4_mountpoint *mp = ext4_get_mount(path);
1181 ext4_block_cache_write_back(mp->fs.bdev, 1);
1182 r = ext4_generic_open(f, path, flags, true, 0, 0);
1183 ext4_block_cache_write_back(mp->fs.bdev, 0);
1188 int ext4_fopen2(ext4_file *f, const char *path, int flags)
1190 struct ext4_mountpoint *mp = ext4_get_mount(path);
1197 filetype = EXT4_DIRENTRY_REG_FILE;
1200 ext4_block_cache_write_back(mp->fs.bdev, 1);
1201 r = ext4_generic_open2(f, path, flags, filetype, 0, 0);
1202 ext4_block_cache_write_back(mp->fs.bdev, 0);
1207 int ext4_fclose(ext4_file *f)
1209 ext4_assert(f && f->mp);
1214 f->fpos = f->fsize = 0;
1219 static int ext4_ftruncate_no_lock(ext4_file *f, uint64_t size)
1221 struct ext4_inode_ref ref;
1225 r = ext4_fs_get_inode_ref(&f->mp->fs, f->inode, &ref);
1227 EXT4_MP_UNLOCK(f->mp);
1232 f->fsize = ext4_inode_get_size(&f->mp->fs.sb, ref.inode);
1233 if (f->fsize <= size) {
1238 /*Start write back cache mode.*/
1239 r = ext4_block_cache_write_back(f->mp->fs.bdev, 1);
1243 r = ext4_fs_truncate_inode(&ref, size);
1251 /*Stop write back cache mode*/
1252 ext4_block_cache_write_back(f->mp->fs.bdev, 0);
1258 ext4_fs_put_inode_ref(&ref);
1263 int ext4_ftruncate(ext4_file *f, uint64_t size)
1266 ext4_assert(f && f->mp);
1268 if (f->flags & O_RDONLY)
1271 EXT4_MP_LOCK(f->mp);
1273 r = ext4_ftruncate_no_lock(f, size);
1275 EXT4_MP_UNLOCK(f->mp);
1279 int ext4_fread(ext4_file *f, void *buf, size_t size, size_t *rcnt)
1283 uint32_t fblock_start;
1284 uint32_t fblock_cnt;
1286 uint32_t sblock_end;
1287 uint32_t block_size;
1288 uint8_t *u8_buf = buf;
1290 struct ext4_block b;
1291 struct ext4_inode_ref ref;
1293 ext4_assert(f && f->mp);
1295 if (f->flags & O_WRONLY)
1301 EXT4_MP_LOCK(f->mp);
1306 r = ext4_fs_get_inode_ref(&f->mp->fs, f->inode, &ref);
1308 EXT4_MP_UNLOCK(f->mp);
1313 f->fsize = ext4_inode_get_size(&f->mp->fs.sb, ref.inode);
1315 block_size = ext4_sb_get_block_size(&f->mp->fs.sb);
1316 size = size > (f->fsize - f->fpos) ? (f->fsize - f->fpos) : size;
1317 sblock = (f->fpos) / block_size;
1318 sblock_end = (f->fpos + size) / block_size;
1319 u = (f->fpos) % block_size;
1321 /*If the size of symlink is smaller than 60 bytes*/
1322 if (ext4_inode_is_type(&f->mp->fs.sb, ref.inode, EXT4_INODE_MODE_SOFTLINK)
1323 && f->fsize < sizeof(ref.inode->blocks)
1324 && !ext4_inode_get_blocks_count(&f->mp->fs.sb, ref.inode)) {
1325 char *content = (char *)ref.inode->blocks;
1326 if (f->fpos < f->fsize) {
1327 r = (u + size > f->fsize)
1330 memcpy(buf, content + u, r);
1347 uint32_t ll = size > (block_size - u) ? (block_size - u) : size;
1349 r = ext4_fs_get_inode_data_block_index(&ref, sblock, &fblock);
1353 r = ext4_block_get(f->mp->fs.bdev, &b, fblock);
1357 memcpy(u8_buf, b.data + u, ll);
1359 r = ext4_block_set(f->mp->fs.bdev, &b);
1375 while (size >= block_size) {
1376 while (sblock < sblock_end) {
1377 r = ext4_fs_get_inode_data_block_index(&ref, sblock,
1384 if (!fblock_start) {
1385 fblock_start = fblock;
1388 if ((fblock_start + fblock_cnt) != fblock)
1394 r = ext4_blocks_get_direct(f->mp->fs.bdev, u8_buf, fblock_start,
1399 size -= block_size * fblock_cnt;
1400 u8_buf += block_size * fblock_cnt;
1401 f->fpos += block_size * fblock_cnt;
1404 *rcnt += block_size * fblock_cnt;
1406 fblock_start = fblock;
1411 r = ext4_fs_get_inode_data_block_index(&ref, sblock, &fblock);
1415 r = ext4_block_get(f->mp->fs.bdev, &b, fblock);
1419 memcpy(u8_buf, b.data, size);
1421 r = ext4_block_set(f->mp->fs.bdev, &b);
1432 ext4_fs_put_inode_ref(&ref);
1433 EXT4_MP_UNLOCK(f->mp);
1437 int ext4_fwrite(ext4_file *f, const void *buf, size_t size, size_t *wcnt)
1443 uint32_t sblock_end;
1444 uint32_t file_blocks;
1445 uint32_t block_size;
1446 uint32_t fblock_start;
1447 uint32_t fblock_cnt;
1449 struct ext4_block b;
1450 struct ext4_inode_ref ref;
1451 const uint8_t *u8_buf = buf;
1454 ext4_assert(f && f->mp);
1456 if (f->flags & O_RDONLY)
1462 EXT4_MP_LOCK(f->mp);
1467 r = ext4_fs_get_inode_ref(&f->mp->fs, f->inode, &ref);
1469 EXT4_MP_UNLOCK(f->mp);
1474 f->fsize = ext4_inode_get_size(&f->mp->fs.sb, ref.inode);
1476 block_size = ext4_sb_get_block_size(&f->mp->fs.sb);
1478 sblock_end = (f->fpos + size) > f->fsize ? (f->fpos + size) : f->fsize;
1479 sblock_end /= block_size;
1480 file_blocks = (f->fsize / block_size);
1482 if (f->fsize % block_size)
1485 sblock = (f->fpos) / block_size;
1487 u = (f->fpos) % block_size;
1490 uint32_t ll = size > (block_size - u) ? (block_size - u) : size;
1492 r = ext4_fs_get_inode_data_block_index(&ref, sblock, &fblock);
1496 r = ext4_block_get(f->mp->fs.bdev, &b, fblock);
1500 memcpy(b.data + u, u8_buf, ll);
1503 r = ext4_block_set(f->mp->fs.bdev, &b);
1517 /*Start write back cache mode.*/
1518 r = ext4_block_cache_write_back(f->mp->fs.bdev, 1);
1524 while (size >= block_size) {
1526 while (sblock < sblock_end) {
1527 if (sblock < file_blocks) {
1528 r = ext4_fs_get_inode_data_block_index(
1529 &ref, sblock, &fblock);
1533 r = ext4_fs_append_inode_block(&ref, &fblock,
1541 if (!fblock_start) {
1542 fblock_start = fblock;
1545 if ((fblock_start + fblock_cnt) != fblock)
1551 r = ext4_blocks_set_direct(f->mp->fs.bdev, u8_buf, fblock_start,
1556 size -= block_size * fblock_cnt;
1557 u8_buf += block_size * fblock_cnt;
1558 f->fpos += block_size * fblock_cnt;
1561 *wcnt += block_size * fblock_cnt;
1563 fblock_start = fblock;
1567 /*Stop write back cache mode*/
1568 ext4_block_cache_write_back(f->mp->fs.bdev, 0);
1574 if (sblock < file_blocks) {
1575 r = ext4_fs_get_inode_data_block_index(&ref, sblock,
1580 r = ext4_fs_append_inode_block(&ref, &fblock, &sblock);
1585 r = ext4_block_get(f->mp->fs.bdev, &b, fblock);
1589 memcpy(b.data, u8_buf, size);
1592 r = ext4_block_set(f->mp->fs.bdev, &b);
1602 if (f->fpos > f->fsize) {
1604 ext4_inode_set_size(ref.inode, f->fsize);
1609 ext4_fs_put_inode_ref(&ref);
1610 EXT4_MP_UNLOCK(f->mp);
1614 int ext4_fseek(ext4_file *f, uint64_t offset, uint32_t origin)
1618 if (offset > f->fsize)
1624 if ((offset + f->fpos) > f->fsize)
1630 if (offset > f->fsize)
1633 f->fpos = f->fsize - offset;
1639 uint64_t ext4_ftell(ext4_file *f) { return f->fpos; }
1641 uint64_t ext4_fsize(ext4_file *f) { return f->fsize; }
1643 int ext4_chmod(const char *path, uint32_t mode)
1648 struct ext4_sblock *sb;
1649 struct ext4_inode_ref inode_ref;
1650 struct ext4_mountpoint *mp = ext4_get_mount(path);
1657 r = ext4_generic_open2(&f, path, O_RDWR, EXT4_DIRENTRY_UNKNOWN, 0, 0);
1665 r = ext4_fs_get_inode_ref(&mp->fs, ino, &inode_ref);
1671 ext4_inode_set_mode(sb, inode_ref.inode, mode);
1672 inode_ref.dirty = true;
1674 ext4_fs_put_inode_ref(&inode_ref);
1679 int ext4_chown(const char *path, uint32_t uid, uint32_t gid)
1684 struct ext4_inode_ref inode_ref;
1685 struct ext4_mountpoint *mp = ext4_get_mount(path);
1692 r = ext4_generic_open2(&f, path, O_RDWR, EXT4_DIRENTRY_UNKNOWN, 0, 0);
1699 r = ext4_fs_get_inode_ref(&mp->fs, ino, &inode_ref);
1705 ext4_inode_set_uid(inode_ref.inode, uid);
1706 ext4_inode_set_gid(inode_ref.inode, gid);
1707 inode_ref.dirty = true;
1709 ext4_fs_put_inode_ref(&inode_ref);
1714 int ext4_file_set_atime(const char *path, uint32_t atime)
1719 struct ext4_inode_ref inode_ref;
1720 struct ext4_mountpoint *mp = ext4_get_mount(path);
1727 r = ext4_generic_open2(&f, path, O_RDWR, EXT4_DIRENTRY_UNKNOWN, 0, 0);
1734 r = ext4_fs_get_inode_ref(&mp->fs, ino, &inode_ref);
1740 ext4_inode_set_access_time(inode_ref.inode, atime);
1741 inode_ref.dirty = true;
1743 ext4_fs_put_inode_ref(&inode_ref);
1748 int ext4_file_set_mtime(const char *path, uint32_t mtime)
1753 struct ext4_inode_ref inode_ref;
1754 struct ext4_mountpoint *mp = ext4_get_mount(path);
1761 r = ext4_generic_open2(&f, path, O_RDWR, EXT4_DIRENTRY_UNKNOWN, 0, 0);
1768 r = ext4_fs_get_inode_ref(&mp->fs, ino, &inode_ref);
1774 ext4_inode_set_modification_time(inode_ref.inode, mtime);
1775 inode_ref.dirty = true;
1777 ext4_fs_put_inode_ref(&inode_ref);
1782 int ext4_file_set_ctime(const char *path, uint32_t ctime)
1787 struct ext4_inode_ref inode_ref;
1788 struct ext4_mountpoint *mp = ext4_get_mount(path);
1795 r = ext4_generic_open2(&f, path, O_RDWR, EXT4_DIRENTRY_UNKNOWN, 0, 0);
1802 r = ext4_fs_get_inode_ref(&mp->fs, ino, &inode_ref);
1808 ext4_inode_set_change_inode_time(inode_ref.inode, ctime);
1809 inode_ref.dirty = true;
1811 ext4_fs_put_inode_ref(&inode_ref);
1816 static int ext4_fsymlink_set(ext4_file *f, const void *buf, uint32_t size)
1818 struct ext4_block b;
1819 struct ext4_inode_ref ref;
1820 uint32_t sblock, fblock;
1821 uint32_t block_size;
1824 ext4_assert(f && f->mp);
1829 r = ext4_fs_get_inode_ref(&f->mp->fs, f->inode, &ref);
1831 EXT4_MP_UNLOCK(f->mp);
1836 block_size = ext4_sb_get_block_size(&f->mp->fs.sb);
1837 if (size > block_size) {
1841 r = ext4_ftruncate_no_lock(f, 0);
1845 /*Start write back cache mode.*/
1846 r = ext4_block_cache_write_back(f->mp->fs.bdev, 1);
1850 /*If the size of symlink is smaller than 60 bytes*/
1851 if (size < sizeof(ref.inode->blocks)) {
1852 char *content = (char *)ref.inode->blocks;
1853 memset(content, 0, sizeof(ref.inode->blocks));
1854 memcpy(content, buf, size);
1855 ext4_inode_clear_flag(ref.inode, EXT4_INODE_FLAG_EXTENTS);
1857 ext4_fs_inode_blocks_init(&f->mp->fs, &ref);
1858 r = ext4_fs_append_inode_block(&ref, &fblock, &sblock);
1862 r = ext4_block_get(f->mp->fs.bdev, &b, fblock);
1866 memcpy(b.data, buf, size);
1868 r = ext4_block_set(f->mp->fs.bdev, &b);
1873 /*Stop write back cache mode*/
1874 ext4_block_cache_write_back(f->mp->fs.bdev, 0);
1879 ext4_inode_set_size(ref.inode, size);
1887 ext4_fs_put_inode_ref(&ref);
1891 int ext4_fsymlink(const char *target, const char *path)
1893 struct ext4_mountpoint *mp = ext4_get_mount(path);
1901 filetype = EXT4_DIRENTRY_SYMLINK;
1904 ext4_block_cache_write_back(mp->fs.bdev, 1);
1905 r = ext4_generic_open2(&f, path, O_RDWR|O_CREAT, filetype, 0, 0);
1907 r = ext4_fsymlink_set(&f, target, strlen(target));
1914 ext4_block_cache_write_back(mp->fs.bdev, 0);
1919 int ext4_readlink(const char *path, char *buf, size_t bufsize, size_t *rcnt)
1921 struct ext4_mountpoint *mp = ext4_get_mount(path);
1932 memset(buf, 0, sizeof(bufsize));
1934 filetype = EXT4_DIRENTRY_SYMLINK;
1937 ext4_block_cache_write_back(mp->fs.bdev, 1);
1938 r = ext4_generic_open2(&f, path, O_RDONLY, filetype, 0, 0);
1940 r = ext4_fread(&f, buf, bufsize, rcnt);
1947 ext4_block_cache_write_back(mp->fs.bdev, 0);
1952 /*********************************DIRECTORY OPERATION************************/
1954 int ext4_dir_rm(const char *path)
1960 struct ext4_mountpoint *mp = ext4_get_mount(path);
1961 struct ext4_inode_ref current;
1962 struct ext4_inode_ref child;
1963 struct ext4_directory_iterator it;
1967 uint32_t inode_current;
1980 r = ext4_generic_open(&f, path, "r", false, &inode_up, &name_off);
1987 len = ext4_path_check(path, &is_goal);
1989 inode_current = f.inode;
1992 ext4_block_cache_write_back(mp->fs.bdev, 1);
1995 /*Load directory node.*/
1996 r = ext4_fs_get_inode_ref(&f.mp->fs, inode_current, ¤t);
2001 /*Initialize iterator.*/
2002 r = ext4_dir_iterator_init(&it, ¤t, 0);
2004 ext4_fs_put_inode_ref(¤t);
2015 /*Get up directory inode when ".." entry*/
2016 if ((it.current->name_length == 2) &&
2017 ext4_is_dots(it.current->name,
2018 it.current->name_length)) {
2019 inode_up = ext4_dir_entry_ll_get_inode(it.current);
2022 /*If directory or file entry, but not "." ".." entry*/
2023 if (!ext4_is_dots(it.current->name,
2024 it.current->name_length)) {
2026 /*Get child inode reference do unlink
2028 r = ext4_fs_get_inode_ref(&f.mp->fs,
2029 ext4_dir_entry_ll_get_inode(it.current),
2034 /*If directory with no leaf children*/
2035 r = ext4_has_children(&has_children, &child);
2037 ext4_fs_put_inode_ref(&child);
2042 /*Has directory children. Go into this
2044 inode_up = inode_current;
2045 inode_current = ext4_dir_entry_ll_get_inode(it.current);
2047 ext4_fs_put_inode_ref(&child);
2051 /*No children in child directory or file. Just
2053 r = ext4_unlink(f.mp, ¤t, &child,
2054 (char *)it.current->name,
2055 it.current->name_length);
2057 ext4_fs_put_inode_ref(&child);
2061 ext4_inode_set_deletion_time(child.inode,
2063 ext4_inode_set_links_count(child.inode, 0);
2066 r = ext4_fs_truncate_inode(&child, 0);
2068 ext4_fs_put_inode_ref(&child);
2072 r = ext4_fs_free_inode(&child);
2074 ext4_fs_put_inode_ref(&child);
2078 r = ext4_fs_put_inode_ref(&child);
2083 r = ext4_dir_iterator_next(&it);
2087 /*Directory iterator reached last entry*/
2088 ext4_has_children(&has_children, ¤t);
2089 if (!has_children) {
2090 inode_current = inode_up;
2097 struct ext4_inode_ref parent;
2098 r = ext4_fs_get_inode_ref(&f.mp->fs, inode_up,
2103 /* In this place all directories should be
2105 * Last unlink from root of current directory*/
2106 r = ext4_unlink(f.mp, &parent, ¤t,
2109 ext4_fs_put_inode_ref(&parent);
2113 if (ext4_inode_get_links_count(current.inode) ==
2115 ext4_inode_set_deletion_time(
2116 current.inode, 0xFFFFFFFF);
2117 ext4_inode_set_links_count(
2119 current.dirty = true;
2121 r = ext4_fs_truncate_inode(¤t, 0);
2123 ext4_fs_put_inode_ref(&parent);
2127 r = ext4_fs_free_inode(¤t);
2129 ext4_fs_put_inode_ref(&parent);
2134 r = ext4_fs_put_inode_ref(&parent);
2141 ext4_dir_iterator_fini(&it);
2142 ext4_fs_put_inode_ref(¤t);
2145 /*When something goes wrong. End loop.*/
2151 ext4_block_cache_write_back(mp->fs.bdev, 0);
2156 int ext4_dir_mk(const char *path)
2161 struct ext4_mountpoint *mp = ext4_get_mount(path);
2169 r = ext4_generic_open(&f, path, "r", false, 0, 0);
2171 /*Directory already created*/
2177 r = ext4_generic_open(&f, path, "w", false, 0, 0);
2187 int ext4_dir_open(ext4_dir *d, const char *path)
2189 struct ext4_mountpoint *mp = ext4_get_mount(path);
2196 r = ext4_generic_open(&d->f, path, "r", false, 0, 0);
2202 int ext4_dir_close(ext4_dir *d)
2204 return ext4_fclose(&d->f);
2207 const ext4_direntry *ext4_dir_entry_next(ext4_dir *d)
2209 #define EXT4_DIR_ENTRY_OFFSET_TERM (uint64_t)(-1)
2212 ext4_direntry *de = 0;
2213 struct ext4_inode_ref dir;
2214 struct ext4_directory_iterator it;
2216 EXT4_MP_LOCK(d->f.mp);
2218 if (d->next_off == EXT4_DIR_ENTRY_OFFSET_TERM) {
2219 EXT4_MP_UNLOCK(d->f.mp);
2223 r = ext4_fs_get_inode_ref(&d->f.mp->fs, d->f.inode, &dir);
2228 r = ext4_dir_iterator_init(&it, &dir, d->next_off);
2230 ext4_fs_put_inode_ref(&dir);
2234 memcpy(&d->de, it.current, sizeof(ext4_direntry));
2237 ext4_dir_iterator_next(&it);
2240 it.current ? it.current_offset : EXT4_DIR_ENTRY_OFFSET_TERM;
2242 ext4_dir_iterator_fini(&it);
2243 ext4_fs_put_inode_ref(&dir);
2246 EXT4_MP_UNLOCK(d->f.mp);
2250 void ext4_dir_entry_rewind(ext4_dir *d)