btrfs-progs: rework how we traverse rootdir
cover btrfs-progs: rework how we traverse rootdir
Thanks to Mark's recent work, I finally get some time to rework rootdir traversal.
All the problems are described inside the second patch. While the last patch is a small enhancement to --rootdir to reject hard links.
With this change, it's much easier to support subvolume creations at mkfs time:
- Create a hashmap (or other similar structure) to record all the directories that should be subvolume
- Call btrfs_make_subvoume() other than btrfs_insert_inode() if a path should be a subvolume
- Call btrfs_link_subvolume() other than btrfs_add_link() for a subvolume
Everything like parent directory inode size is properly handled by btrfs_link_subvolume() and btrfs_add_link() already.
Qu Wenruo (3):
btrfs-progs: constify the name parameter of btrfs_add_link()
btrfs-progs: mkfs: rework how we traverse rootdir
btrfs-progs: rootdir: reject hard links
kernel-shared/ctree.h | 2 +- kernel-shared/inode.c | 2 +- mkfs/rootdir.c | 676 +++++++++++++++++------------------------- mkfs/rootdir.h | 8 - 4 files changed, 271 insertions(+), 417 deletions(-)
--
2.45.2
PATCH 1/3 btrfs-progs: constify the name parameter of btrfs_add_link()
The name is never touched, thus it should be const.
--- kernel-shared/ctree.h | 2 +- kernel-shared/inode.c | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-)
kernel-shared/ctree.h +1 -1
@@ -1210,7 +1210,7 @@ int btrfs_new_inode(struct btrfs_trans_handle *trans, struct btrfs_root *root,int btrfs_change_inode_flags (struct btrfs_trans_handle *trans,struct btrfs_root *root,u64 ino,u64 flags);int btrfs_add_link (struct btrfs_trans_handle *trans,struct btrfs_root *root, -u64 ino,u64 parent_ino,char *name,int namelen, +u64 ino,u64 parent_ino,const char *name,int namelen,u8 type,u64 *index,int add_backref,int ignore_existed); int btrfs_unlink(struct btrfs_trans_handle *trans, struct btrfs_root *root, u64 ino, u64 parent_ino, u64 index, const char *name,
kernel-shared/inode.c +1 -1
@@ -167,7 +167,7 @@ out:* Currently only supports adding link from an inode to another inode. */ int btrfs_add_link (struct btrfs_trans_handle *trans,struct btrfs_root *root, -u64 ino,u64 parent_ino,char *name,int namelen, +u64 ino,u64 parent_ino,const char *name,int namelen,u8 type,u64 *index,int add_backref,int ignore_existed) {struct btrfs_path *path;
Signature · 1 line
2.45.2
PATCH 2/3 btrfs-progs: mkfs: rework how we traverse rootdir
In reply to Qu WenruoThere are several hidden pitfalls of the existing traverse_directory():
- Hand written preorder traversal
Meanwhile there is already a better written standard library function, nftw() doing exactly what we need.
- Over-designed path list
To properly handle the directory change, we have structure directory_name_entry, to record every inode until rootdir.
But it has two string members, dir_name and path, which is a little overkilled.
As for preorder traversal, we will never need to read the parent's filename, just its inode number.
And it's exported while no one utilizes it out of mkfs/rootdir.c.
- Weird inode numbers
We use the inode number from st->st_ino, with an extra offset. This by itself is not safe, if the rootdir has child directory in another filesystem.
And this results very weird inode numbers, e.g:
item 0 key (256 INODE_ITEM 0) itemoff 16123 itemsize 160 item 6 key (88347519 INODE_ITEM 0) itemoff 15815 itemsize 160 item 16 key (88347520 INODE_ITEM 0) itemoff 15363 itemsize 160 item 20 key (88347521 INODE_ITEM 0) itemoff 15119 itemsize 160 item 24 key (88347522 INODE_ITEM 0) itemoff 14875 itemsize 160 item 26 key (88347523 INODE_ITEM 0) itemoff 14700 itemsize 160 item 28 key (88347524 INODE_ITEM 0) itemoff 14525 itemsize 160 item 30 key (88347557 INODE_ITEM 0) itemoff 14350 itemsize 160 item 32 key (88347566 INODE_ITEM 0) itemoff 14175 itemsize 160
Which is far from a regular fs created by copying the data.
- Weird directory inode size calculation
Unlike kernel, which updated the directory inode size every time new child inodes are added, we calculate the directory inode size by searching all its children first, then later new inodes linked to this directory won't touch the inode size.
Enhance all these points by:
- Use nftw() to do the preorder traversal
It also provides the extra level detection, which is pretty handy.
- Use a simple local inode_entry to record each parent The only value is a u64 to record the inode number. And one simple rootdir_path structure to record the list of inode_entry, alone with the current level.
This rootdir_path structure along with two helpers, rootdir_path_push() and rootdir_path_pop(), along with the preorder traversal provided by nftw(), are enough for us to record all the parent directories until the rootdir.
- Grab new inode number properly
Just call btrfs_get_free_objectid() to grab a proper inode number, other than using some weird calculated value.
- Use btrfs_insert_inode() and btrfs_add_link() to update directory inode automatically
With all the refactor, the code is shorter and easier to read.
--- mkfs/rootdir.c | 664 +++++++++++++++++++------------------------------ mkfs/rootdir.h | 8 - 2 files changed, 257 insertions(+), 415 deletions(-)
mkfs/rootdir.c +257 -407
@@ -38,15 +38,12 @@#include "kernel-shared/file-item.h" #include "common/internal.h" #include "common/messages.h" -#include "common/path-utils.h" #include "common/utils.h" #include "common/extent-tree-utils.h" #include "mkfs/rootdir.h" static u32 fs_block_size; -static u64 index_cnt =2 ; -/* * Size estimate will be done using the following data: * 1) Number of inodes
@@ -63,169 +60,91 @@ static u64 index_cnt = 2;static u64 ftw_meta_nr_inode;static u64 ftw_data_size; -static int add_directory_items (struct btrfs_trans_handle *trans, -struct btrfs_root *root,u64 objectid, -ino_t parent_inum,const char *name, -struct stat *st,int *dir_index_cnt) +/* +* Represent one inode inside the path. +* +* For now, all those inodes are inside fs tree. +*/ +struct inode_entry { +/* The inode number inside btrfs. */ +u64 ino; +struct list_head list; +}; + +/* +* The path towards the rootdir. +* +* Only directory inodes are stored inside the path. +*/ +struct rootdir_path { +/* +* Level 0 means it's the rootdir itself. +* Level -1 means it's uninitlized. +*/ +int level; + +struct list_head inode_list; +} current_path = { + .level =-1 , +}; + +struct btrfs_trans_handle *g_trans =NULL ; + +static inline struct inode_entry *rootdir_path_last (struct rootdir_path *path) { -int ret; -int name_len; -struct btrfs_key location; -u8 filetype =0 ; +UASSERT (!list_empty (&path->inode_list)); - name_len =strlen (name); - - location.objectid = objectid; - location.type =BTRFS_INODE_ITEM_KEY ; - location.offset =0 ; - -if (S_ISDIR (st->st_mode)) - filetype =BTRFS_FT_DIR ; -if (S_ISREG (st->st_mode)) - filetype =BTRFS_FT_REG_FILE ; -if (S_ISLNK (st->st_mode)) - filetype =BTRFS_FT_SYMLINK ; -if (S_ISSOCK (st->st_mode)) - filetype =BTRFS_FT_SOCK ; -if (S_ISCHR (st->st_mode)) - filetype =BTRFS_FT_CHRDEV ; -if (S_ISBLK (st->st_mode)) - filetype =BTRFS_FT_BLKDEV ; -if (S_ISFIFO (st->st_mode)) - filetype =BTRFS_FT_FIFO ; - - ret =btrfs_insert_dir_item (trans, root, name, name_len, - parent_inum, &location, - filetype, index_cnt); -if (ret) -return ret; - ret =btrfs_insert_inode_ref (trans, root, name, name_len, - objectid, parent_inum, index_cnt); - *dir_index_cnt = index_cnt; - index_cnt++; - -return ret; + return list_entry(path->inode_list.prev, struct inode_entry, list); } -static int fill_inode_item (struct btrfs_trans_handle *trans, -struct btrfs_root *root, -struct btrfs_inode_item *dst,struct stat *src) +static void rootdir_path_pop (struct rootdir_path *path) { -u64 blocks =0 ; -u64 sectorsize = root->fs_info->sectorsize; +struct inode_entry *last; +UASSERT (path->level >=0 ); -/* -* btrfs_inode_item has some reserved fields -* and represents on-disk inode entry, so -* zero everything to prevent information leak -*/ -memset (dst,0 ,sizeof (*dst)); + last =rootdir_path_last (path); +list_del_init (&last->list); + path->level--; +free (last); +} -btrfs_set_stack_inode_generation (dst, trans->transid); -btrfs_set_stack_inode_size (dst, src->st_size); -btrfs_set_stack_inode_nbytes (dst,0 ); -btrfs_set_stack_inode_block_group (dst,0 ); -btrfs_set_stack_inode_nlink (dst, src->st_nlink); -btrfs_set_stack_inode_uid (dst, src->st_uid); -btrfs_set_stack_inode_gid (dst, src->st_gid); -btrfs_set_stack_inode_mode (dst, src->st_mode); -btrfs_set_stack_inode_rdev (dst,0 ); -btrfs_set_stack_inode_flags (dst,0 ); -btrfs_set_stack_timespec_sec (&dst->atime, src->st_atime); -btrfs_set_stack_timespec_nsec (&dst->atime,0 ); -btrfs_set_stack_timespec_sec (&dst->ctime, src->st_ctime); -btrfs_set_stack_timespec_nsec (&dst->ctime,0 ); -btrfs_set_stack_timespec_sec (&dst->mtime, src->st_mtime); -btrfs_set_stack_timespec_nsec (&dst->mtime,0 ); -btrfs_set_stack_timespec_sec (&dst->otime,0 ); -btrfs_set_stack_timespec_nsec (&dst->otime,0 ); - -if (S_ISDIR (src->st_mode)) { -btrfs_set_stack_inode_size (dst,0 ); -btrfs_set_stack_inode_nlink (dst,1 ); - } -if (S_ISREG (src->st_mode)) { -btrfs_set_stack_inode_size (dst, (u64 )src->st_size); -if (src->st_size <=BTRFS_MAX_INLINE_DATA_SIZE (root->fs_info) && - src->st_size < sectorsize) -btrfs_set_stack_inode_nbytes (dst, src->st_size); -else { - blocks = src->st_size / sectorsize; -if (src->st_size % sectorsize) - blocks +=1 ; - blocks *= sectorsize; -btrfs_set_stack_inode_nbytes (dst, blocks); - } - } -if (S_ISLNK (src->st_mode)) -btrfs_set_stack_inode_nbytes (dst, src->st_size +1 ); +static int rootdir_path_push (struct rootdir_path *path,u64 ino) +{ +struct inode_entry *new; + new =malloc (sizeof (*new)); +if (!new) +return -ENOMEM ; + new->ino = ino; +list_add_tail (&new->list, &path->inode_list); + path->level++;return 0 ; } -static int directory_select (const struct dirent *entry) + +static void stat_to_inode_item (struct btrfs_inode_item *dst,const struct stat *st) { -if (entry->d_name[0 ] =='.' && - (entry->d_name[1 ] ==0 || - (entry->d_name[1 ] =='.' && entry->d_name[2 ] ==0 ))) -return 0 ; -return 1 ; -} - -static void free_namelist (struct dirent **files,int count) -{ -int i; - -if (count <0 ) -return ; - -for (i =0 ; i < count; ++i) -free (files[i]); -free (files); -} - -static u64 calculate_dir_inode_size (const char *dirname) -{ -int count, i; -struct dirent **files, *cur_file; -u64 dir_inode_size =0 ; - - count =scandir (dirname, &files, directory_select,NULL ); - -for (i =0 ; i < count; i++) { - cur_file = files[i]; - dir_inode_size +=strlen (cur_file->d_name); - } - -free_namelist (files, count); - - dir_inode_size *=2 ; -return dir_inode_size; -} - -static int add_inode_items (struct btrfs_trans_handle *trans, -struct btrfs_root *root, -struct stat *st,const char *name, -u64 self_objectid, -struct btrfs_inode_item *inode_ret) -{ -int ret; -struct btrfs_inode_item btrfs_inode; -u64 objectid; -u64 inode_size =0 ; - -fill_inode_item (trans, root, &btrfs_inode, st); - objectid = self_objectid; - -if (S_ISDIR (st->st_mode)) { - inode_size =calculate_dir_inode_size (name); -btrfs_set_stack_inode_size (&btrfs_inode, inode_size); - } - - ret =btrfs_insert_inode (trans, root, objectid, &btrfs_inode); - - *inode_ret = btrfs_inode; -return ret; +/* +* Do not touch size for directory inode, the size would be +* automatically updated during btrfs_link_inode(). +*/ +if (!S_ISDIR (st->st_mode)) +btrfs_set_stack_inode_size (dst, st->st_size); +btrfs_set_stack_inode_nbytes (dst,0 ); +btrfs_set_stack_inode_block_group (dst,0 ); +btrfs_set_stack_inode_uid (dst, st->st_uid); +btrfs_set_stack_inode_gid (dst, st->st_gid); +btrfs_set_stack_inode_mode (dst, st->st_mode); +btrfs_set_stack_inode_rdev (dst,0 ); +btrfs_set_stack_inode_flags (dst,0 ); +btrfs_set_stack_timespec_sec (&dst->atime, st->st_atime); +btrfs_set_stack_timespec_nsec (&dst->atime,0 ); +btrfs_set_stack_timespec_sec (&dst->ctime, st->st_ctime); +btrfs_set_stack_timespec_nsec (&dst->ctime,0 ); +btrfs_set_stack_timespec_sec (&dst->mtime, st->st_mtime); +btrfs_set_stack_timespec_nsec (&dst->mtime,0 ); +btrfs_set_stack_timespec_sec (&dst->otime,0 ); +btrfs_set_stack_timespec_nsec (&dst->otime,0 ); } static int add_xattr_item(struct btrfs_trans_handle *trans,
@@ -280,8 +199,10 @@ static int add_xattr_item(struct btrfs_trans_handle *trans,static int add_symbolic_link (struct btrfs_trans_handle *trans,struct btrfs_root *root, +struct btrfs_inode_item *inode_item,u64 objectid,const char *path_name) { +u64 nbytes;int ret;char buf[PATH_MAX ];
@@ -297,8 +218,16 @@ static int add_symbolic_link(struct btrfs_trans_handle *trans, } buf[ret] ='\0' ;/* readlink does not do it for us */ + nbytes = ret +1 ; ret =btrfs_insert_inline_extent (trans, root, objectid,0 , - buf, ret +1 ); + buf, nbytes); +if (ret <0 ) { + errno = -ret; +error ("failed to insert inline extent for %s: %m" , + path_name); + goto fail; + } +btrfs_set_stack_inode_nbytes (inode_item, nbytes); fail:return ret; }
@@ -306,7 +235,7 @@ fail:static int add_file_items (struct btrfs_trans_handle *trans,struct btrfs_root *root,struct btrfs_inode_item *btrfs_inode,u64 objectid, -struct stat *st,const char *path_name) +const struct stat *st,const char *path_name) {struct btrfs_fs_info *fs_info = trans->fs_info;int ret =-1 ;
@@ -355,6 +284,8 @@ static int add_file_items(struct btrfs_trans_handle *trans, ret =btrfs_insert_inline_extent (trans, root, objectid,0 , buffer, st->st_size);free (buffer); +/* Update the inode nbytes for inline extents. */ +btrfs_set_stack_inode_nbytes (btrfs_inode, st->st_size); goto end; }
@@ -429,264 +360,199 @@ end:return ret; } -static int copy_rootdir_inode (struct btrfs_trans_handle *trans, -struct btrfs_root *root,const char *dir_name) +static int update_inode_item (struct btrfs_trans_handle *trans, +struct btrfs_root *root, +const struct btrfs_inode_item *inode_item, +u64 ino) { -u64 root_dir_inode_size; -struct btrfs_inode_item *inode_item;struct btrfs_path path = {0 }; -struct btrfs_key key; -struct extent_buffer *leaf; -struct stat st; +struct btrfs_key key = { + .objectid = ino, + .type =BTRFS_INODE_ITEM_KEY , + .offset =0 , + }; +u32 item_ptr_off;int ret; - ret =stat (dir_name, &st); -if (ret <0 ) { - ret = -errno; -error ("stat failed for directory %s: %m" , dir_name); -return ret; - } - - ret =add_xattr_item (trans, root,btrfs_root_dirid (&root->root_item), dir_name); -if (ret <0 ) { - errno = -ret; -error ("failed to add xattr item for the top level inode: %m" ); -return ret; - } - - key.objectid =btrfs_root_dirid (&root->root_item); - key.type =BTRFS_INODE_ITEM_KEY ; - key.offset =0 ; ret =btrfs_lookup_inode (trans, root, &path, &key,1 );if (ret >0 ) ret = -ENOENT ; -if (ret) { -error ("failed to lookup root dir: %d" , ret); - goto error; +if (ret <0 ) { +btrfs_release_path (&path); +return ret; } - - leaf = path.nodes[0 ]; - inode_item = btrfs_item_ptr(leaf, path.slots[0], struct btrfs_inode_item); - - root_dir_inode_size =calculate_dir_inode_size (dir_name); -btrfs_set_inode_size (leaf, inode_item, root_dir_inode_size); - -/* Unlike fill_inode_item, we only need to copy part of the attributes. */ -btrfs_set_inode_uid (leaf, inode_item, st.st_uid); -btrfs_set_inode_gid (leaf, inode_item, st.st_gid); -btrfs_set_inode_mode (leaf, inode_item, st.st_mode); -btrfs_set_timespec_sec (leaf, &inode_item->atime, st.st_atime); -btrfs_set_timespec_nsec (leaf, &inode_item->atime,0 ); -btrfs_set_timespec_sec (leaf, &inode_item->ctime, st.st_ctime); -btrfs_set_timespec_nsec (leaf, &inode_item->ctime,0 ); -btrfs_set_timespec_sec (leaf, &inode_item->mtime, st.st_mtime); -btrfs_set_timespec_nsec (leaf, &inode_item->mtime,0 ); -/* FIXME */ -btrfs_set_timespec_sec (leaf, &inode_item->otime,0 ); -btrfs_set_timespec_nsec (leaf, &inode_item->otime,0 ); -btrfs_mark_buffer_dirty (leaf); - -error: + item_ptr_off =btrfs_item_ptr_offset (path.nodes[0 ], path.slots[0 ]); +write_extent_buffer (path.nodes[0 ], inode_item, item_ptr_off,sizeof (*inode_item)); +btrfs_mark_buffer_dirty (path.nodes[0 ]);btrfs_release_path (&path); -return ret; +return 0 ; } -static int traverse_directory (struct btrfs_trans_handle *trans, -struct btrfs_root *root,const char *dir_name, -struct directory_name_entry *dir_head) +static u8 ftype_to_btrfs_type (mode_t ftype) { -int ret =0 ; +if (S_ISREG (ftype)) +return BTRFS_FT_REG_FILE ; +if (S_ISDIR (ftype)) +return BTRFS_FT_DIR ; +if (S_ISLNK (ftype)) +return BTRFS_FT_SYMLINK ; +if (S_ISCHR (ftype)) +return BTRFS_FT_CHRDEV ; +if (S_ISBLK (ftype)) +return BTRFS_FT_BLKDEV ; +if (S_ISFIFO (ftype)) +return BTRFS_FT_FIFO ; +if (S_ISSOCK (ftype)) +return BTRFS_FT_SOCK ; +return BTRFS_FT_UNKNOWN ; -struct btrfs_inode_item cur_inode; -int count, i, dir_index_cnt; -struct dirent **files; -struct stat st; -struct directory_name_entry *dir_entry, *parent_dir_entry; -struct dirent *cur_file; -ino_t parent_inum, cur_inum; -ino_t highest_inum =0 ; -const char *parent_dir_name; +} -/* Add list for source directory */ - dir_entry =malloc (sizeof (struct directory_name_entry )); -if (!dir_entry) -return -ENOMEM ; - dir_entry->dir_name = dir_name; - dir_entry->path =realpath (dir_name,NULL ); -if (!dir_entry->path) { -error ("realpath failed for %s: %m" , dir_name); - ret =-1 ; - goto fail_no_dir; +static int ftw_add_inode (const char *full_path,const struct stat *st, +int typeflag,struct FTW *ftwbuf) +{ +struct btrfs_fs_info *fs_info = g_trans->fs_info; +struct btrfs_root *root = fs_info->fs_root; +struct btrfs_inode_item inode_item = {0 }; +struct inode_entry *parent; +u64 ino; +int ret; + +/* The rootdir itself. */ +if (unlikely (ftwbuf->level ==0 )) { +u64 root_ino =btrfs_root_dirid (&root->root_item); + +UASSERT (S_ISDIR (st->st_mode)); + + ret =add_xattr_item (g_trans, root, root_ino, full_path); +if (ret <0 ) { + errno = -ret; +error ("failed to add xattr item for the top level inode: %m" ); +return ret; + } +stat_to_inode_item (&inode_item, st); +/* +* Rootdir inode exists without any parent. +* Thus needs to set its nlink to 1 manually. +*/ +btrfs_set_stack_inode_nlink (&inode_item,1 ); + ret =update_inode_item (g_trans, root, &inode_item, root_ino); +if (ret <0 ) { + errno = -ret; +error ("failed to update root dir for root %llu: %m" , + root->root_key.objectid); +return ret; + } + + ret =rootdir_path_push (¤t_path, +btrfs_root_dirid (&root->root_item)); +if (ret <0 ) { + errno = -ret; +error_msg (ERROR_MSG_MEMORY ,"push path for rootdir: %m" ); +return ret; + } +return ret; } - parent_inum = highest_inum +BTRFS_FIRST_FREE_OBJECTID ; - dir_entry->inum = parent_inum; -list_add_tail (&dir_entry->list, &dir_head->list); +/* +* If our path level is higher than this level - 1, this means +* we have changed directory. +* Poping out the unrelated inodes. +*/ +while (current_path.level > ftwbuf->level -1 ) +rootdir_path_pop (¤t_path); - ret =copy_rootdir_inode (trans, root, dir_name); + ret =btrfs_find_free_objectid (g_trans, root, +BTRFS_FIRST_FREE_OBJECTID , &ino);if (ret <0 ) { errno = -ret; -error ("failed to copy rootdir inode: %m" ); - goto fail_no_dir; +error ("failed to find free objectid for file %s: %m" , + full_path); +return ret; + } +stat_to_inode_item (&inode_item, st); + + ret =btrfs_insert_inode (g_trans, root, ino, &inode_item); +if (ret <0 ) { + errno = -ret; +error ("failed to insert inode item %llu for '%s': %m" , + ino, full_path); +return ret; } -do { - parent_dir_entry =list_entry (dir_head->list.next, - struct directory_name_entry, - list); -list_del (&parent_dir_entry->list); + parent =rootdir_path_last (¤t_path); + ret =btrfs_add_link (g_trans, root, ino, parent->ino, + full_path + ftwbuf->base, +strlen (full_path) - ftwbuf->base, +ftype_to_btrfs_type (st->st_mode), +NULL ,1 ,0 ); +if (ret <0 ) { + errno = -ret; +error ("failed to add link for inode %llu ('%s'): %m" , + ino, full_path); +return ret; + } +/* +* btrfs_add_link() has increased the nlink to 1 in the metadata. +* Also update the value in case we need to update the inode item +* later. +*/ +btrfs_set_stack_inode_nlink (&inode_item,1 ); - parent_inum = parent_dir_entry->inum; - parent_dir_name = parent_dir_entry->dir_name; -if (chdir (parent_dir_entry->path)) { -error ("chdir failed for %s: %m" , - parent_dir_name); - ret =-1 ; - goto fail_no_files; + ret =add_xattr_item (g_trans, root, ino, full_path); +if (ret <0 ) { + errno = -ret; +error ("failed to add xattrs for inode %llu ('%s'): %m" , + ino, full_path); +return ret; + } +if (S_ISDIR (st->st_mode)) { + ret =rootdir_path_push (¤t_path, ino); +if (ret <0 ) { + errno = -ret; +error ("failed to allocate new entry for inode %llu ('%s'): %m" , + ino, full_path); +return ret; } - - count =scandir (parent_dir_entry->path, &files, - directory_select,NULL ); -if (count ==-1 ) { -error ("scandir failed for %s: %m" , - parent_dir_name); - ret =-1 ; - goto fail; + }else if (S_ISREG (st->st_mode)) { + ret =add_file_items (g_trans, root, &inode_item, ino, st, full_path); +if (ret <0 ) { + errno = -ret; +error ("failed to add file extents for inode %llu ('%s'): %m" , + ino, full_path); +return ret; } - -for (i =0 ; i < count; i++) { -char tmp[PATH_MAX ]; - - cur_file = files[i]; - -if (lstat (cur_file->d_name, &st) ==-1 ) { -error ("lstat failed for %s: %m" , - cur_file->d_name); - ret =-1 ; - goto fail; - } -if (bconf.verbose >=LOG_INFO ) { -path_cat_out (tmp, parent_dir_entry->path, cur_file->d_name); -pr_verbose (LOG_INFO ,"ADD: %s\n" , tmp); - } - -/* -* We can not directly use the source ino number, -* as there is a chance that the ino is smaller than -* BTRFS_FIRST_FREE_OBJECTID, which will screw up -* backref code. -*/ - cur_inum = st.st_ino +BTRFS_FIRST_FREE_OBJECTID ; - ret =add_directory_items (trans, root, - cur_inum, parent_inum, - cur_file->d_name, - &st, &dir_index_cnt); -if (ret) { -error ("unable to add directory items for %s: %d" , - cur_file->d_name, ret); - goto fail; - } - - ret =add_inode_items (trans, root, &st, - cur_file->d_name, cur_inum, - &cur_inode); -if (ret == -EEXIST ) { -if (st.st_nlink <=1 ) { -error ( -"item %s already exists but has wrong st_nlink %lu <= 1" , - cur_file->d_name, - (unsigned long )st.st_nlink); - goto fail; - } - ret =0 ; -continue ; - } -if (ret) { -error ("unable to add inode items for %s: %d" , - cur_file->d_name, ret); - goto fail; - } - - ret =add_xattr_item (trans, root, - cur_inum, cur_file->d_name); -if (ret) { -error ("unable to add xattr items for %s: %d" , - cur_file->d_name, ret); -if (ret != -ENOTSUP ) - goto fail; - } - -if (S_ISDIR (st.st_mode)) { - dir_entry =malloc (sizeof (*dir_entry)); -if (!dir_entry) { - ret = -ENOMEM ; - goto fail; - } - dir_entry->dir_name = cur_file->d_name; -if (path_cat_out (tmp, parent_dir_entry->path, - cur_file->d_name)) { -error ("invalid path: %s/%s" , - parent_dir_entry->path, - cur_file->d_name); - ret = -EINVAL ; - goto fail; - } - dir_entry->path =strdup (tmp); -if (!dir_entry->path) { -error_msg (ERROR_MSG_MEMORY ,NULL ); - ret = -ENOMEM ; - goto fail; - } - dir_entry->inum = cur_inum; -list_add_tail (&dir_entry->list, - &dir_head->list); - }else if (S_ISREG (st.st_mode)) { - ret =add_file_items (trans, root, &cur_inode, - cur_inum, &st, - cur_file->d_name); -if (ret) { -error ("unable to add file items for %s: %d" , - cur_file->d_name, ret); - goto fail; - } - }else if (S_ISLNK (st.st_mode)) { - ret =add_symbolic_link (trans, root, - cur_inum, cur_file->d_name); -if (ret) { -error ("unable to add symlink for %s: %d" , - cur_file->d_name, ret); - goto fail; - } - } + ret =update_inode_item (g_trans, root, &inode_item, ino); +if (ret <0 ) { + errno = -ret; +error ("failed to update inode item for inode %llu ('%s'): %m" , + ino, full_path); +return ret; } - -free_namelist (files, count); -free (parent_dir_entry->path); -free (parent_dir_entry); - - index_cnt =2 ; - - }while (!list_empty (&dir_head->list)); - -out: -return !!ret; -fail: -free_namelist (files, count); -fail_no_files: -free (parent_dir_entry); - goto out; -fail_no_dir: -free (dir_entry); - goto out; -} + }else if (S_ISLNK (st->st_mode)) { + ret =add_symbolic_link (g_trans, root, &inode_item, ino, full_path); +if (ret <0 ) { + errno = -ret; +error ("failed to insert link for inode %llu ('%s'): %m" , + ino, full_path); +return ret; + } + ret =update_inode_item (g_trans, root, &inode_item, ino); +if (ret <0 ) { + errno = -ret; +error ("failed to update inode item for inode %llu ('%s'): %m" , + ino, full_path); +return ret; + } + } +return 0 ; +};int btrfs_mkfs_fill_dir (const char *source_dir,struct btrfs_root *root) {int ret;struct btrfs_trans_handle *trans;struct stat root_st; -struct directory_name_entry dir_head; -struct directory_name_entry *dir_entry =NULL ; ret =lstat (source_dir, &root_st);if (ret) {
@@ -695,17 +561,18 @@ int btrfs_mkfs_fill_dir(const char *source_dir, struct btrfs_root *root) goto out; } -INIT_LIST_HEAD (&dir_head.list); - trans =btrfs_start_transaction (root,1 );if (IS_ERR (trans)) { ret =PTR_ERR (trans); errno = -ret;error_msg (ERROR_MSG_START_TRANS ,"%m" ); goto fail; -} + } - ret =traverse_directory (trans, root, source_dir, &dir_head); + g_trans = trans; +INIT_LIST_HEAD (¤t_path.inode_list); + + ret =nftw (source_dir, ftw_add_inode,32 ,FTW_PHYS );if (ret) {error ("unable to traverse directory %s: %d" , source_dir, ret); goto fail;
@@ -716,29 +583,12 @@ int btrfs_mkfs_fill_dir(const char *source_dir, struct btrfs_root *root)error_msg (ERROR_MSG_COMMIT_TRANS ,"%m" ); goto out; } +while (current_path.level >=0 ) +rootdir_path_pop (¤t_path);return 0 ; fail: -/* -* Since we don't have btrfs_abort_transaction() yet, uncommitted trans -* will trigger a BUG_ON(). -* -* However before mkfs is fully finished, the magic number is invalid, -* so even we commit transaction here, the fs still can't be mounted. -* -* To do a graceful error out, here we commit transaction as a -* workaround. -* Since we have already hit some problem, the return value doesn't -* matter now. -*/ -btrfs_commit_transaction (trans, root); -while (!list_empty (&dir_head.list)) { - dir_entry =list_entry (dir_head.list.next, - struct directory_name_entry, list); -list_del (&dir_entry->list); -free (dir_entry->path); -free (dir_entry); - } +btrfs_abort_transaction (trans, ret); out:return ret; }
mkfs/rootdir.h +0 -8
@@ -24,18 +24,10 @@#include "kerncompat.h" #include <sys/types.h> #include <stdbool.h> -#include "kernel-lib/list.h" struct btrfs_fs_info ;struct btrfs_root ; -struct directory_name_entry { -const char *dir_name; -char *path; -ino_t inum; -struct list_head list; -}; -int btrfs_mkfs_fill_dir (const char *source_dir,struct btrfs_root *root);u64 btrfs_mkfs_size_dir (const char *dir_name,u32 sectorsize,u64 min_dev_size,u64 meta_profile,u64 data_profile);
Signature · 1 line
2.45.2
PATCH 3/3 btrfs-progs: rootdir: reject hard links
In reply to Qu WenruoHard link detection needs extra memory to save all the inodes hits with extra nlinks.
There is no such support from the very beginning, and our code will just create two different inodes, ignoring the extra links completely.
Considering the most common use case (populating a rootfs), there is not much distro doing hard links intentionally, it should be pretty safe.
Just error out if we hit such hard links.
--- mkfs/rootdir.c | 12 ++++++++++++ 1 file changed, 12 insertions(+)
mkfs/rootdir.c +12 -0
@@ -418,6 +418,18 @@ static int ftw_add_inode(const char *full_path, const struct stat *st,u64 ino;int ret; +/* +* Hard link need extra detection code, not support for now. +* +* st_nlink on directories is fs specific, so only check it on +* non-directory inodes. +*/ +if (unlikely (!S_ISDIR (st->st_mode) && st->st_nlink >1 )) { +error ("'%s' has extra hard links, not supported for now" , + full_path); +return -EOPNOTSUPP ; + } +/* The rootdir itself. */ if (unlikely (ftwbuf->level ==0 )) {u64 root_ino =btrfs_root_dirid (&root->root_item);
Signature · 1 line
2.45.2
Re: [PATCH 3/3] btrfs-progs: rootdir: reject hard links
Quoted 5 lines · Qu Wenruo
Hard link detection needs extra memory to save all the inodes hits with extra nlinks.
There is no such support from the very beginning, and our code will just create two different inodes, ignoring the extra links completely.
I don't understand exactly what this means.
How does the code you are replacing handle hardlinks? As far as I can tell (far from an expert...) it looks like it does handle them, so explicitly rejecting them now is a regression?
Quoted 18 lines
Considering the most common use case (populating a rootfs), there is not much distro doing hard links intentionally, it should be pretty safe.
Just error out if we hit such hard links.
Signed-off-by Qu Wenruo <[email protected]>--- mkfs/rootdir.c | 12 ++++++++++++ 1 file changed, 12 insertions(+)mkfs/rootdir.c +0
-0@@ -418,6 +418,18 @@ static int ftw_add_inode(const char *full_path, const struct stat *st,u64 ino;int ret;
mkfs/rootdir.c static int ftw_add_inode(const char *full_path, const struct stat *st, · line 429
Quoted 10 lines
mkfs/rootdir.c +9
-0+/* +* Hard link need extra detection code, not support for now. +* +* st_nlink on directories is fs specific, so only check it on +* non-directory inodes. +*/ +if (unlikely (!S_ISDIR (st->st_mode) && st->st_nlink >1 )) { +error ("'%s' has extra hard links, not supported for now" , + full_path);
I would change the message to something like:
"inodes with hard links are not supported"
Thanks,
Boris
Quoted 9 lines
mkfs/rootdir.c +3
-0+return -EOPNOTSUPP ; + } +/* The rootdir itself. */ if (unlikely (ftwbuf->level ==0 )) {u64 root_ino =btrfs_root_dirid (&root->root_item);Signature · 1 line
2.45.2
Re: [PATCH 3/3] btrfs-progs: rootdir: reject hard links
Quoted 8 lines · Boris Burkov
Quoted 5 lines · Qu Wenruo
Hard link detection needs extra memory to save all the inodes hits with extra nlinks.
There is no such support from the very beginning, and our code will just create two different inodes, ignoring the extra links completely.
I don't understand exactly what this means.
I mean, if we have the following layout as source root dir
rootdir
|- dir1 | |- file1 (ino 1024) |- dir2
|- file2 (ino 1024)
Then the resulted btrfs would looks like this:
.
|- dir1 | |- file 1 (ino 257) |- dir2
|- file 2 (ino 259)
Making them different inodes.
Quoted 4 lines
How does the code you are replacing handle hardlinks? As far as I can tell (far from an expert...) it looks like it does handle them, so explicitly rejecting them now is a regression?
Sorry, the new code doesn't handle hardlinks, they are treated as different inodes.
As the new code always grab a new ino number for each file.
Although things like btrfs_add_link() can handle extra hard links, we always treat every inode we hit as a new one.
And yes, it is a regression. The old code skips the ino number detection by reusing the old ino from the host fs, which introduced two bugs (that we didn't notice until now):
- If rootdir crosses mount points, we can have conflicting ino And screw up things easily
- If rootdir has an inode with hardlinks out of rootdir Then the resulted fs will have the same nlink number, mismatching the correct number.
Just like this:
# mkfs rootfs # touch rootfs/file1 # ln rootfs/file1 file1 # mkfs.btrfs -f --rootdir rootfs $dev # btrfs check #dev ... [4/7] checking fs roots root 5 inode 88347536 errors 2000, link count wrong unresolved ref dir 256 index 2 namelen 5 name file1 filetype 1 errors 0 ERROR: errors found in fs roots found 147456 bytes used, error(s) found
So for now, I'll go with the more robust and correct code, with the cost of buggy hard links support.
Quoted 20 lines
Quoted 20 lines
Considering the most common use case (populating a rootfs), there is not much distro doing hard links intentionally, it should be pretty safe.
Just error out if we hit such hard links.
Signed-off-by Qu Wenruo <[email protected]>--- mkfs/rootdir.c | 12 ++++++++++++ 1 file changed, 12 insertions(+)mkfs/rootdir.c +0
-0@@ -418,6 +418,18 @@ static int ftw_add_inode(const char *full_path, const struct stat *st,u64 ino;int ret;
Quoted 12 lines
mkfs/rootdir.c static int ftw_add_inode(const char *full_path, const struct stat *st, · line 429
Quoted 9 lines
mkfs/rootdir.c +9
-0+/* +* Hard link need extra detection code, not support for now. +* +* st_nlink on directories is fs specific, so only check it on +* non-directory inodes. +*/ +if (unlikely (!S_ISDIR (st->st_mode) && st->st_nlink >1 )) { +error ("'%s' has extra hard links, not supported for now" , + full_path);I would change the message to something like:
"inodes with hard links are not supported"
Thanks for the advice, I'll go with this new message, along with some new test cases for the existing hardlink and mount point bugs.
Thanks,
Qu
Quoted 14 lines
Thanks,
BorisQuoted 9 lines
mkfs/rootdir.c +3
-1+return -EOPNOTSUPP ; + } +/* The rootdir itself. */ if (unlikely (ftwbuf->level ==0 )) {u64 root_ino =btrfs_root_dirid (&root->root_item); --2.45.2
Re: [PATCH 2/3] btrfs-progs: mkfs: rework how we traverse rootdir
In reply to Qu WenruoQuoted 5 lines · Qu Wenruo
There are several hidden pitfalls of the existing
traverse_directory():- Hand written preorder traversal
Meanwhile there is already a better written standard library function,nftw()doing exactly what we need.
This is great!
Quoted 10 lines
- Over-designed path list
To properly handle the directory change, we have structuredirectory_name_entry, to record every inode until rootdir.But it has two string members,
dir_nameand path, which is a little overkilled.
As for preorder traversal, we will never need to read the parent's filename, just its inode number.
Quoted 6 lines
And it's exported while no one utilizes it out of
mkfs/rootdir.c.- Weird inode numbers
We use the inode number fromst->st_ino, with an extra offset. This by itself is not safe, if the rootdir has child directory in another filesystem.
Can you explain what you mean by not safe? As far as I can tell, the +256 is to handle that particular invariant of btrfs. Are you worried about duplicate inode numbers in the vein of the usual st_dev/st_ino debates?
In that case, if this is a bugfix, I think it makes sense to write a regression test that highlights it. It would be nice to pull the fix out of the refactor, too, but I suppose that with such a deep refactor, that might not be possible/worth it.
Quoted 13 lines
And this results very weird inode numbers, e.g:
item 0 key (256 INODE_ITEM 0) itemoff 16123 itemsize 160 item 6 key (88347519 INODE_ITEM 0) itemoff 15815 itemsize 160 item 16 key (88347520 INODE_ITEM 0) itemoff 15363 itemsize 160 item 20 key (88347521 INODE_ITEM 0) itemoff 15119 itemsize 160 item 24 key (88347522 INODE_ITEM 0) itemoff 14875 itemsize 160 item 26 key (88347523 INODE_ITEM 0) itemoff 14700 itemsize 160 item 28 key (88347524 INODE_ITEM 0) itemoff 14525 itemsize 160 item 30 key (88347557 INODE_ITEM 0) itemoff 14350 itemsize 160 item 32 key (88347566 INODE_ITEM 0) itemoff 14175 itemsize 160
Quoted 1 line
Which is far from a regular fs created by copying the data.
+1, especially since it doesn't even *preserve* the inode numbers, which would be a comprehensible (if not working) behavior. Creating the oids in "btrfs order" seems like a nice improvement!
Quoted 22 lines
- Weird directory inode size calculation
Unlike kernel, which updated the directory inode size every time new child inodes are added, we calculate the directory inode size by searching all its children first, then later new inodes linked to this directory won't touch the inode size.Enhance all these points by:
- Use
nftw()to do the preorder traversal
It also provides the extra level detection, which is pretty handy.- Use a simple local
inode_entryto record each parent The only value is a u64 to record the inode number. And one simplerootdir_pathstructure to record the list ofinode_entry, alone with the current level.This
rootdir_pathstructure along with two helpers,rootdir_path_push()androotdir_path_pop(), along with the preorder traversal provided bynftw(), are enough for us to record all the parent directories until the rootdir.
Quoted 8 lines
- Grab new inode number properly
Just callbtrfs_get_free_objectid()to grab a proper inode number, other than using some weird calculated value.- Use
btrfs_insert_inode()andbtrfs_add_link()to update directory inode automaticallyWith all the refactor, the code is shorter and easier to read.
Agreed on all counts, I think this is a lovely refactor.
For a change of this magnitude, I think it is helpful to justify the correctness of the change by documenting the testing plan. Are there existing unit tests of mkfs that cover all the cases we are modifying here? Is there some --rootdir master case that covers everything? Is it in fstests? Knowing that all of the new code has at least run correctly would go a long way to feeling confident in the details of the transformation.
I left a few more notes inline.
Thanks,
Boris
Quoted 12 lines
Signed-off-by Qu Wenruo <[email protected]>--- mkfs/rootdir.c | 664 +++++++++++++++++++------------------------------ mkfs/rootdir.h | 8 - 2 files changed, 257 insertions(+), 415 deletions(-)mkfs/rootdir.c +0
-0
mkfs/rootdir.c line 43
Quoted 7 lines
mkfs/rootdir.c +0
-1@@ -38,15 +38,12 @@#include "kernel-shared/file-item.h" #include "common/internal.h" #include "common/messages.h" -#include "common/path-utils.h" #include "common/utils.h" #include "common/extent-tree-utils.h" #include "mkfs/rootdir.h"
#include <ftw.h> to be explicit?
Quoted 467 lines
mkfs/rootdir.c +164
-229static u32 fs_block_size; -static u64 index_cnt =2 ; -/* * Size estimate will be done using the following data: * 1) Number of inodes @@ -63,169 +60,91 @@ static u64 index_cnt = 2;static u64 ftw_meta_nr_inode;static u64 ftw_data_size; -static int add_directory_items (struct btrfs_trans_handle *trans, -struct btrfs_root *root,u64 objectid, -ino_t parent_inum,const char *name, -struct stat *st,int *dir_index_cnt) +/* +* Represent one inode inside the path. +* +* For now, all those inodes are inside fs tree. +*/ +struct inode_entry { +/* The inode number inside btrfs. */ +u64 ino; +struct list_head list; +}; + +/* +* The path towards the rootdir. +* +* Only directory inodes are stored inside the path. +*/ +struct rootdir_path { +/* +* Level 0 means it's the rootdir itself. +* Level -1 means it's uninitlized. +*/ +int level; + +struct list_head inode_list; +} current_path = { + .level =-1 , +}; + +struct btrfs_trans_handle *g_trans =NULL ; + +static inline struct inode_entry *rootdir_path_last (struct rootdir_path *path) { -int ret; -int name_len; -struct btrfs_key location; -u8 filetype =0 ; +UASSERT (!list_empty (&path->inode_list)); - name_len =strlen (name); - - location.objectid = objectid; - location.type =BTRFS_INODE_ITEM_KEY ; - location.offset =0 ; - -if (S_ISDIR (st->st_mode)) - filetype =BTRFS_FT_DIR ; -if (S_ISREG (st->st_mode)) - filetype =BTRFS_FT_REG_FILE ; -if (S_ISLNK (st->st_mode)) - filetype =BTRFS_FT_SYMLINK ; -if (S_ISSOCK (st->st_mode)) - filetype =BTRFS_FT_SOCK ; -if (S_ISCHR (st->st_mode)) - filetype =BTRFS_FT_CHRDEV ; -if (S_ISBLK (st->st_mode)) - filetype =BTRFS_FT_BLKDEV ; -if (S_ISFIFO (st->st_mode)) - filetype =BTRFS_FT_FIFO ; - - ret =btrfs_insert_dir_item (trans, root, name, name_len, - parent_inum, &location, - filetype, index_cnt); -if (ret) -return ret; - ret =btrfs_insert_inode_ref (trans, root, name, name_len, - objectid, parent_inum, index_cnt); - *dir_index_cnt = index_cnt; - index_cnt++; - -return ret; + return list_entry(path->inode_list.prev, struct inode_entry, list); } -static int fill_inode_item (struct btrfs_trans_handle *trans, -struct btrfs_root *root, -struct btrfs_inode_item *dst,struct stat *src) +static void rootdir_path_pop (struct rootdir_path *path) { -u64 blocks =0 ; -u64 sectorsize = root->fs_info->sectorsize; +struct inode_entry *last; +UASSERT (path->level >=0 ); -/* -* btrfs_inode_item has some reserved fields -* and represents on-disk inode entry, so -* zero everything to prevent information leak -*/ -memset (dst,0 ,sizeof (*dst)); + last =rootdir_path_last (path); +list_del_init (&last->list); + path->level--; +free (last); +} -btrfs_set_stack_inode_generation (dst, trans->transid); -btrfs_set_stack_inode_size (dst, src->st_size); -btrfs_set_stack_inode_nbytes (dst,0 ); -btrfs_set_stack_inode_block_group (dst,0 ); -btrfs_set_stack_inode_nlink (dst, src->st_nlink); -btrfs_set_stack_inode_uid (dst, src->st_uid); -btrfs_set_stack_inode_gid (dst, src->st_gid); -btrfs_set_stack_inode_mode (dst, src->st_mode); -btrfs_set_stack_inode_rdev (dst,0 ); -btrfs_set_stack_inode_flags (dst,0 ); -btrfs_set_stack_timespec_sec (&dst->atime, src->st_atime); -btrfs_set_stack_timespec_nsec (&dst->atime,0 ); -btrfs_set_stack_timespec_sec (&dst->ctime, src->st_ctime); -btrfs_set_stack_timespec_nsec (&dst->ctime,0 ); -btrfs_set_stack_timespec_sec (&dst->mtime, src->st_mtime); -btrfs_set_stack_timespec_nsec (&dst->mtime,0 ); -btrfs_set_stack_timespec_sec (&dst->otime,0 ); -btrfs_set_stack_timespec_nsec (&dst->otime,0 ); - -if (S_ISDIR (src->st_mode)) { -btrfs_set_stack_inode_size (dst,0 ); -btrfs_set_stack_inode_nlink (dst,1 ); - } -if (S_ISREG (src->st_mode)) { -btrfs_set_stack_inode_size (dst, (u64 )src->st_size); -if (src->st_size <=BTRFS_MAX_INLINE_DATA_SIZE (root->fs_info) && - src->st_size < sectorsize) -btrfs_set_stack_inode_nbytes (dst, src->st_size); -else { - blocks = src->st_size / sectorsize; -if (src->st_size % sectorsize) - blocks +=1 ; - blocks *= sectorsize; -btrfs_set_stack_inode_nbytes (dst, blocks); - } - } -if (S_ISLNK (src->st_mode)) -btrfs_set_stack_inode_nbytes (dst, src->st_size +1 ); +static int rootdir_path_push (struct rootdir_path *path,u64 ino) +{ +struct inode_entry *new; + new =malloc (sizeof (*new)); +if (!new) +return -ENOMEM ; + new->ino = ino; +list_add_tail (&new->list, &path->inode_list); + path->level++;return 0 ; } -static int directory_select (const struct dirent *entry) + +static void stat_to_inode_item (struct btrfs_inode_item *dst,const struct stat *st) { -if (entry->d_name[0 ] =='.' && - (entry->d_name[1 ] ==0 || - (entry->d_name[1 ] =='.' && entry->d_name[2 ] ==0 ))) -return 0 ; -return 1 ; -} - -static void free_namelist (struct dirent **files,int count) -{ -int i; - -if (count <0 ) -return ; - -for (i =0 ; i < count; ++i) -free (files[i]); -free (files); -} - -static u64 calculate_dir_inode_size (const char *dirname) -{ -int count, i; -struct dirent **files, *cur_file; -u64 dir_inode_size =0 ; - - count =scandir (dirname, &files, directory_select,NULL ); - -for (i =0 ; i < count; i++) { - cur_file = files[i]; - dir_inode_size +=strlen (cur_file->d_name); - } - -free_namelist (files, count); - - dir_inode_size *=2 ; -return dir_inode_size; -} - -static int add_inode_items (struct btrfs_trans_handle *trans, -struct btrfs_root *root, -struct stat *st,const char *name, -u64 self_objectid, -struct btrfs_inode_item *inode_ret) -{ -int ret; -struct btrfs_inode_item btrfs_inode; -u64 objectid; -u64 inode_size =0 ; - -fill_inode_item (trans, root, &btrfs_inode, st); - objectid = self_objectid; - -if (S_ISDIR (st->st_mode)) { - inode_size =calculate_dir_inode_size (name); -btrfs_set_stack_inode_size (&btrfs_inode, inode_size); - } - - ret =btrfs_insert_inode (trans, root, objectid, &btrfs_inode); - - *inode_ret = btrfs_inode; -return ret; +/* +* Do not touch size for directory inode, the size would be +* automatically updated during btrfs_link_inode(). +*/ +if (!S_ISDIR (st->st_mode)) +btrfs_set_stack_inode_size (dst, st->st_size); +btrfs_set_stack_inode_nbytes (dst,0 ); +btrfs_set_stack_inode_block_group (dst,0 ); +btrfs_set_stack_inode_uid (dst, st->st_uid); +btrfs_set_stack_inode_gid (dst, st->st_gid); +btrfs_set_stack_inode_mode (dst, st->st_mode); +btrfs_set_stack_inode_rdev (dst,0 ); +btrfs_set_stack_inode_flags (dst,0 ); +btrfs_set_stack_timespec_sec (&dst->atime, st->st_atime); +btrfs_set_stack_timespec_nsec (&dst->atime,0 ); +btrfs_set_stack_timespec_sec (&dst->ctime, st->st_ctime); +btrfs_set_stack_timespec_nsec (&dst->ctime,0 ); +btrfs_set_stack_timespec_sec (&dst->mtime, st->st_mtime); +btrfs_set_stack_timespec_nsec (&dst->mtime,0 ); +btrfs_set_stack_timespec_sec (&dst->otime,0 ); +btrfs_set_stack_timespec_nsec (&dst->otime,0 ); } static int add_xattr_item(struct btrfs_trans_handle *trans,@@ -280,8 +199,10 @@ static int add_xattr_item(struct btrfs_trans_handle *trans,static int add_symbolic_link (struct btrfs_trans_handle *trans,struct btrfs_root *root, +struct btrfs_inode_item *inode_item,u64 objectid,const char *path_name) { +u64 nbytes;int ret;char buf[PATH_MAX ];@@ -297,8 +218,16 @@ static int add_symbolic_link(struct btrfs_trans_handle *trans, } buf[ret] ='\0' ;/* readlink does not do it for us */ + nbytes = ret +1 ; ret =btrfs_insert_inline_extent (trans, root, objectid,0 , - buf, ret +1 ); + buf, nbytes); +if (ret <0 ) { + errno = -ret; +error ("failed to insert inline extent for %s: %m" , + path_name); + goto fail; + } +btrfs_set_stack_inode_nbytes (inode_item, nbytes); fail:return ret; }@@ -306,7 +235,7 @@ fail:static int add_file_items (struct btrfs_trans_handle *trans,struct btrfs_root *root,struct btrfs_inode_item *btrfs_inode,u64 objectid, -struct stat *st,const char *path_name) +const struct stat *st,const char *path_name) {struct btrfs_fs_info *fs_info = trans->fs_info;int ret =-1 ;@@ -355,6 +284,8 @@ static int add_file_items(struct btrfs_trans_handle *trans, ret =btrfs_insert_inline_extent (trans, root, objectid,0 , buffer, st->st_size);free (buffer); +/* Update the inode nbytes for inline extents. */ +btrfs_set_stack_inode_nbytes (btrfs_inode, st->st_size); goto end; }@@ -429,264 +360,199 @@ end:return ret; } -static int copy_rootdir_inode (struct btrfs_trans_handle *trans, -struct btrfs_root *root,const char *dir_name) +static int update_inode_item (struct btrfs_trans_handle *trans, +struct btrfs_root *root, +const struct btrfs_inode_item *inode_item, +u64 ino) { -u64 root_dir_inode_size; -struct btrfs_inode_item *inode_item;struct btrfs_path path = {0 }; -struct btrfs_key key; -struct extent_buffer *leaf; -struct stat st; +struct btrfs_key key = { + .objectid = ino, + .type =BTRFS_INODE_ITEM_KEY , + .offset =0 , + }; +u32 item_ptr_off;int ret; - ret =stat (dir_name, &st); -if (ret <0 ) { - ret = -errno; -error ("stat failed for directory %s: %m" , dir_name); -return ret; - } - - ret =add_xattr_item (trans, root,btrfs_root_dirid (&root->root_item), dir_name); -if (ret <0 ) { - errno = -ret; -error ("failed to add xattr item for the top level inode: %m" ); -return ret; - } - - key.objectid =btrfs_root_dirid (&root->root_item); - key.type =BTRFS_INODE_ITEM_KEY ; - key.offset =0 ; ret =btrfs_lookup_inode (trans, root, &path, &key,1 );if (ret >0 ) ret = -ENOENT ; -if (ret) { -error ("failed to lookup root dir: %d" , ret); - goto error; +if (ret <0 ) { +btrfs_release_path (&path); +return ret; } - - leaf = path.nodes[0 ]; - inode_item = btrfs_item_ptr(leaf, path.slots[0], struct btrfs_inode_item); - - root_dir_inode_size =calculate_dir_inode_size (dir_name); -btrfs_set_inode_size (leaf, inode_item, root_dir_inode_size); - -/* Unlike fill_inode_item, we only need to copy part of the attributes. */ -btrfs_set_inode_uid (leaf, inode_item, st.st_uid); -btrfs_set_inode_gid (leaf, inode_item, st.st_gid); -btrfs_set_inode_mode (leaf, inode_item, st.st_mode); -btrfs_set_timespec_sec (leaf, &inode_item->atime, st.st_atime); -btrfs_set_timespec_nsec (leaf, &inode_item->atime,0 ); -btrfs_set_timespec_sec (leaf, &inode_item->ctime, st.st_ctime); -btrfs_set_timespec_nsec (leaf, &inode_item->ctime,0 ); -btrfs_set_timespec_sec (leaf, &inode_item->mtime, st.st_mtime); -btrfs_set_timespec_nsec (leaf, &inode_item->mtime,0 ); -/* FIXME */ -btrfs_set_timespec_sec (leaf, &inode_item->otime,0 ); -btrfs_set_timespec_nsec (leaf, &inode_item->otime,0 ); -btrfs_mark_buffer_dirty (leaf); - -error: + item_ptr_off =btrfs_item_ptr_offset (path.nodes[0 ], path.slots[0 ]); +write_extent_buffer (path.nodes[0 ], inode_item, item_ptr_off,sizeof (*inode_item)); +btrfs_mark_buffer_dirty (path.nodes[0 ]);btrfs_release_path (&path); -return ret; +return 0 ; } -static int traverse_directory (struct btrfs_trans_handle *trans, -struct btrfs_root *root,const char *dir_name, -struct directory_name_entry *dir_head) +static u8 ftype_to_btrfs_type (mode_t ftype) { -int ret =0 ; +if (S_ISREG (ftype)) +return BTRFS_FT_REG_FILE ; +if (S_ISDIR (ftype)) +return BTRFS_FT_DIR ; +if (S_ISLNK (ftype)) +return BTRFS_FT_SYMLINK ; +if (S_ISCHR (ftype)) +return BTRFS_FT_CHRDEV ; +if (S_ISBLK (ftype)) +return BTRFS_FT_BLKDEV ; +if (S_ISFIFO (ftype)) +return BTRFS_FT_FIFO ; +if (S_ISSOCK (ftype)) +return BTRFS_FT_SOCK ; +return BTRFS_FT_UNKNOWN ; -struct btrfs_inode_item cur_inode; -int count, i, dir_index_cnt; -struct dirent **files; -struct stat st; -struct directory_name_entry *dir_entry, *parent_dir_entry; -struct dirent *cur_file; -ino_t parent_inum, cur_inum; -ino_t highest_inum =0 ; -const char *parent_dir_name; +} -/* Add list for source directory */ - dir_entry =malloc (sizeof (struct directory_name_entry )); -if (!dir_entry) -return -ENOMEM ; - dir_entry->dir_name = dir_name; - dir_entry->path =realpath (dir_name,NULL ); -if (!dir_entry->path) { -error ("realpath failed for %s: %m" , dir_name); - ret =-1 ; - goto fail_no_dir; +static int ftw_add_inode (const char *full_path,const struct stat *st, +int typeflag,struct FTW *ftwbuf) +{ +struct btrfs_fs_info *fs_info = g_trans->fs_info; +struct btrfs_root *root = fs_info->fs_root; +struct btrfs_inode_item inode_item = {0 }; +struct inode_entry *parent; +u64 ino; +int ret; + +/* The rootdir itself. */ +if (unlikely (ftwbuf->level ==0 )) { +u64 root_ino =btrfs_root_dirid (&root->root_item); + +UASSERT (S_ISDIR (st->st_mode)); + + ret =add_xattr_item (g_trans, root, root_ino, full_path); +if (ret <0 ) { + errno = -ret; +error ("failed to add xattr item for the top level inode: %m" ); +return ret; + } +stat_to_inode_item (&inode_item, st); +/* +* Rootdir inode exists without any parent. +* Thus needs to set its nlink to 1 manually. +*/ +btrfs_set_stack_inode_nlink (&inode_item,1 ); + ret =update_inode_item (g_trans, root, &inode_item, root_ino); +if (ret <0 ) { + errno = -ret; +error ("failed to update root dir for root %llu: %m" , + root->root_key.objectid); +return ret; + } + + ret =rootdir_path_push (¤t_path, +btrfs_root_dirid (&root->root_item)); +if (ret <0 ) { + errno = -ret; +error_msg (ERROR_MSG_MEMORY ,"push path for rootdir: %m" ); +return ret; + }
mkfs/rootdir.c end: · line 460
Quoted 10 lines
mkfs/rootdir.c +5
-3+return ret; } - parent_inum = highest_inum +BTRFS_FIRST_FREE_OBJECTID ; - dir_entry->inum = parent_inum; -list_add_tail (&dir_entry->list, &dir_head->list); +/* +* If our path level is higher than this level - 1, this means +* we have changed directory. +* Poping out the unrelated inodes.
Popping
Also, this took me like 15 minutes of working examples to figure out why it worked. I think it could definitely do with some deeper explanation of the invariant, like:
ftwbuf->level - 1 is the level of the parent of the current traversed inode. ftw will traverse all inodes in a directory before leaving it, and will never traverse an inode without first traversing its dir, so if we see a level less than or equal to the last directory we saw, we are finished with that directory and can pop it.
Perhaps with an annotated drawing like:
0: /
1: /foo/
2: /foo/bar/
3: /foo/bar/f
2: /foo/baz/ POP! 2 > (2 - 1); done with /foo/bar/
3: /foo/baz/g
1: /h POP! 2 > (1 - 1); done with /foo/baz/
To help make it clearer. I honestly even think just changing to >= makes it clearer? Not sure about that.
Quoted 330 lines
mkfs/rootdir.c +88
-174+*/ +while (current_path.level > ftwbuf->level -1 ) +rootdir_path_pop (¤t_path); - ret =copy_rootdir_inode (trans, root, dir_name); + ret =btrfs_find_free_objectid (g_trans, root, +BTRFS_FIRST_FREE_OBJECTID , &ino);if (ret <0 ) { errno = -ret; -error ("failed to copy rootdir inode: %m" ); - goto fail_no_dir; +error ("failed to find free objectid for file %s: %m" , + full_path); +return ret; + } +stat_to_inode_item (&inode_item, st); + + ret =btrfs_insert_inode (g_trans, root, ino, &inode_item); +if (ret <0 ) { + errno = -ret; +error ("failed to insert inode item %llu for '%s': %m" , + ino, full_path); +return ret; } -do { - parent_dir_entry =list_entry (dir_head->list.next, - struct directory_name_entry, - list); -list_del (&parent_dir_entry->list); + parent =rootdir_path_last (¤t_path); + ret =btrfs_add_link (g_trans, root, ino, parent->ino, + full_path + ftwbuf->base, +strlen (full_path) - ftwbuf->base, +ftype_to_btrfs_type (st->st_mode), +NULL ,1 ,0 ); +if (ret <0 ) { + errno = -ret; +error ("failed to add link for inode %llu ('%s'): %m" , + ino, full_path); +return ret; + } +/* +* btrfs_add_link() has increased the nlink to 1 in the metadata. +* Also update the value in case we need to update the inode item +* later. +*/ +btrfs_set_stack_inode_nlink (&inode_item,1 ); - parent_inum = parent_dir_entry->inum; - parent_dir_name = parent_dir_entry->dir_name; -if (chdir (parent_dir_entry->path)) { -error ("chdir failed for %s: %m" , - parent_dir_name); - ret =-1 ; - goto fail_no_files; + ret =add_xattr_item (g_trans, root, ino, full_path); +if (ret <0 ) { + errno = -ret; +error ("failed to add xattrs for inode %llu ('%s'): %m" , + ino, full_path); +return ret; + } +if (S_ISDIR (st->st_mode)) { + ret =rootdir_path_push (¤t_path, ino); +if (ret <0 ) { + errno = -ret; +error ("failed to allocate new entry for inode %llu ('%s'): %m" , + ino, full_path); +return ret; } - - count =scandir (parent_dir_entry->path, &files, - directory_select,NULL ); -if (count ==-1 ) { -error ("scandir failed for %s: %m" , - parent_dir_name); - ret =-1 ; - goto fail; + }else if (S_ISREG (st->st_mode)) { + ret =add_file_items (g_trans, root, &inode_item, ino, st, full_path); +if (ret <0 ) { + errno = -ret; +error ("failed to add file extents for inode %llu ('%s'): %m" , + ino, full_path); +return ret; } - -for (i =0 ; i < count; i++) { -char tmp[PATH_MAX ]; - - cur_file = files[i]; - -if (lstat (cur_file->d_name, &st) ==-1 ) { -error ("lstat failed for %s: %m" , - cur_file->d_name); - ret =-1 ; - goto fail; - } -if (bconf.verbose >=LOG_INFO ) { -path_cat_out (tmp, parent_dir_entry->path, cur_file->d_name); -pr_verbose (LOG_INFO ,"ADD: %s\n" , tmp); - } - -/* -* We can not directly use the source ino number, -* as there is a chance that the ino is smaller than -* BTRFS_FIRST_FREE_OBJECTID, which will screw up -* backref code. -*/ - cur_inum = st.st_ino +BTRFS_FIRST_FREE_OBJECTID ; - ret =add_directory_items (trans, root, - cur_inum, parent_inum, - cur_file->d_name, - &st, &dir_index_cnt); -if (ret) { -error ("unable to add directory items for %s: %d" , - cur_file->d_name, ret); - goto fail; - } - - ret =add_inode_items (trans, root, &st, - cur_file->d_name, cur_inum, - &cur_inode); -if (ret == -EEXIST ) { -if (st.st_nlink <=1 ) { -error ( -"item %s already exists but has wrong st_nlink %lu <= 1" , - cur_file->d_name, - (unsigned long )st.st_nlink); - goto fail; - } - ret =0 ; -continue ; - } -if (ret) { -error ("unable to add inode items for %s: %d" , - cur_file->d_name, ret); - goto fail; - } - - ret =add_xattr_item (trans, root, - cur_inum, cur_file->d_name); -if (ret) { -error ("unable to add xattr items for %s: %d" , - cur_file->d_name, ret); -if (ret != -ENOTSUP ) - goto fail; - } - -if (S_ISDIR (st.st_mode)) { - dir_entry =malloc (sizeof (*dir_entry)); -if (!dir_entry) { - ret = -ENOMEM ; - goto fail; - } - dir_entry->dir_name = cur_file->d_name; -if (path_cat_out (tmp, parent_dir_entry->path, - cur_file->d_name)) { -error ("invalid path: %s/%s" , - parent_dir_entry->path, - cur_file->d_name); - ret = -EINVAL ; - goto fail; - } - dir_entry->path =strdup (tmp); -if (!dir_entry->path) { -error_msg (ERROR_MSG_MEMORY ,NULL ); - ret = -ENOMEM ; - goto fail; - } - dir_entry->inum = cur_inum; -list_add_tail (&dir_entry->list, - &dir_head->list); - }else if (S_ISREG (st.st_mode)) { - ret =add_file_items (trans, root, &cur_inode, - cur_inum, &st, - cur_file->d_name); -if (ret) { -error ("unable to add file items for %s: %d" , - cur_file->d_name, ret); - goto fail; - } - }else if (S_ISLNK (st.st_mode)) { - ret =add_symbolic_link (trans, root, - cur_inum, cur_file->d_name); -if (ret) { -error ("unable to add symlink for %s: %d" , - cur_file->d_name, ret); - goto fail; - } - } + ret =update_inode_item (g_trans, root, &inode_item, ino); +if (ret <0 ) { + errno = -ret; +error ("failed to update inode item for inode %llu ('%s'): %m" , + ino, full_path); +return ret; } - -free_namelist (files, count); -free (parent_dir_entry->path); -free (parent_dir_entry); - - index_cnt =2 ; - - }while (!list_empty (&dir_head->list)); - -out: -return !!ret; -fail: -free_namelist (files, count); -fail_no_files: -free (parent_dir_entry); - goto out; -fail_no_dir: -free (dir_entry); - goto out; -} + }else if (S_ISLNK (st->st_mode)) { + ret =add_symbolic_link (g_trans, root, &inode_item, ino, full_path); +if (ret <0 ) { + errno = -ret; +error ("failed to insert link for inode %llu ('%s'): %m" , + ino, full_path); +return ret; + } + ret =update_inode_item (g_trans, root, &inode_item, ino); +if (ret <0 ) { + errno = -ret; +error ("failed to update inode item for inode %llu ('%s'): %m" , + ino, full_path); +return ret; + } + } +return 0 ; +};int btrfs_mkfs_fill_dir (const char *source_dir,struct btrfs_root *root) {int ret;struct btrfs_trans_handle *trans;struct stat root_st; -struct directory_name_entry dir_head; -struct directory_name_entry *dir_entry =NULL ; ret =lstat (source_dir, &root_st);if (ret) {@@ -695,17 +561,18 @@ int btrfs_mkfs_fill_dir(const char *source_dir, struct btrfs_root *root) goto out; } -INIT_LIST_HEAD (&dir_head.list); - trans =btrfs_start_transaction (root,1 );if (IS_ERR (trans)) { ret =PTR_ERR (trans); errno = -ret;error_msg (ERROR_MSG_START_TRANS ,"%m" ); goto fail; -} + } - ret =traverse_directory (trans, root, source_dir, &dir_head); + g_trans = trans; +INIT_LIST_HEAD (¤t_path.inode_list); + + ret =nftw (source_dir, ftw_add_inode,32 ,FTW_PHYS );if (ret) {error ("unable to traverse directory %s: %d" , source_dir, ret); goto fail;@@ -716,29 +583,12 @@ int btrfs_mkfs_fill_dir(const char *source_dir, struct btrfs_root *root)error_msg (ERROR_MSG_COMMIT_TRANS ,"%m" ); goto out; } +while (current_path.level >=0 ) +rootdir_path_pop (¤t_path);return 0 ; fail: -/* -* Since we don't have btrfs_abort_transaction() yet, uncommitted trans -* will trigger a BUG_ON(). -* -* However before mkfs is fully finished, the magic number is invalid, -* so even we commit transaction here, the fs still can't be mounted. -* -* To do a graceful error out, here we commit transaction as a -* workaround. -* Since we have already hit some problem, the return value doesn't -* matter now. -*/ -btrfs_commit_transaction (trans, root); -while (!list_empty (&dir_head.list)) { - dir_entry =list_entry (dir_head.list.next, - struct directory_name_entry, list); -list_del (&dir_entry->list); -free (dir_entry->path); -free (dir_entry); - } +btrfs_abort_transaction (trans, ret); out:return ret; }mkfs/rootdir.h +0
-8@@ -24,18 +24,10 @@#include "kerncompat.h" #include <sys/types.h> #include <stdbool.h> -#include "kernel-lib/list.h" struct btrfs_fs_info ;struct btrfs_root ; -struct directory_name_entry { -const char *dir_name; -char *path; -ino_t inum; -struct list_head list; -}; -int btrfs_mkfs_fill_dir (const char *source_dir,struct btrfs_root *root);u64 btrfs_mkfs_size_dir (const char *dir_name,u32 sectorsize,u64 min_dev_size,u64 meta_profile,u64 data_profile);Signature · 1 line
2.45.2
Re: [PATCH 2/3] btrfs-progs: mkfs: rework how we traverse rootdir
Quoted 26 lines · Boris Burkov
Quoted 5 lines · Qu Wenruo
There are several hidden pitfalls of the existing
traverse_directory():- Hand written preorder traversal
Meanwhile there is already a better written standard library function,nftw()doing exactly what we need.This is great!
Quoted 10 lines
- Over-designed path list
To properly handle the directory change, we have structuredirectory_name_entry, to record every inode until rootdir.But it has two string members,
dir_nameand path, which is a little overkilled.
As for preorder traversal, we will never need to read the parent's filename, just its inode number.Quoted 6 lines
And it's exported while no one utilizes it out of
mkfs/rootdir.c.- Weird inode numbers
We use the inode number fromst->st_ino, with an extra offset. This by itself is not safe, if the rootdir has child directory in another filesystem.
Quoted 4 lines
Can you explain what you mean by not safe? As far as I can tell, the +256 is to handle that particular invariant of btrfs. Are you worried about duplicate inode numbers in the vein of the usual st_dev/st_ino debates?
I'm worried about this case:
rootdir (on fs1)
|- dir1 | |- file1 (fs1, ino 1024) |- dir2 (on fs2)
|- file2 (fs2, ino 1024)
We do not have any cross mount point checks.
I created a case like this:
# fallocate -l 1G 1.img # fallocate -l 1G 2.img # mkfs.ext4 1.img # mkfs.ext4 2.img # mount 1.img mnt # mkdir mnt/dir1 mnt/dir2 # touch mnt/dir1/file1 mnt/file1 # umount mnt # mount 2.img mnt # mkdir mnt/dir1 mnt/dir2 # touch mnt/dir1/file1 mnt/file1 # umount mnt # mkdir rootdir # mount 1.img rootdir # mount 2.img rootdir/dir2 # mkfs.btrfs -f --rootdir rootdir test.img ERROR: item file1 already exists but has wrong st_nlink 1 <= 1 ERROR: unable to traverse directory rootdir/: 1 ERROR: error while filling filesystem: 1
And it failed as expeceted.
Quoted 5 lines
In that case, if this is a bugfix, I think it makes sense to write a regression test that highlights it. It would be nice to pull the fix out of the refactor, too, but I suppose that with such a deep refactor, that might not be possible/worth it.
Unfortunately I didn't even notice how serious these problems are, until I tried...
Will add two new test cases. One is the above one, the other is the hardlink out of rootdir bug I mentioned in 3/3.
Quoted 49 lines
Quoted 15 lines
And this results very weird inode numbers, e.g: item 0 key (256 INODE_ITEM 0) itemoff 16123 itemsize 160 item 6 key (88347519 INODE_ITEM 0) itemoff 15815 itemsize 160 item 16 key (88347520 INODE_ITEM 0) itemoff 15363 itemsize 160 item 20 key (88347521 INODE_ITEM 0) itemoff 15119 itemsize 160 item 24 key (88347522 INODE_ITEM 0) itemoff 14875 itemsize 160 item 26 key (88347523 INODE_ITEM 0) itemoff 14700 itemsize 160 item 28 key (88347524 INODE_ITEM 0) itemoff 14525 itemsize 160 item 30 key (88347557 INODE_ITEM 0) itemoff 14350 itemsize 160 item 32 key (88347566 INODE_ITEM 0) itemoff 14175 itemsize 160 Which is far from a regular fs created by copying the data.+1, especially since it doesn't even *preserve* the inode numbers, which would be a comprehensible (if not working) behavior. Creating the oids in "btrfs order" seems like a nice improvement!
Quoted 29 lines
- Weird directory inode size calculation
Unlike kernel, which updated the directory inode size every time new child inodes are added, we calculate the directory inode size by searching all its children first, then later new inodes linked to this directory won't touch the inode size.Enhance all these points by:
- Use
nftw()to do the preorder traversal
It also provides the extra level detection, which is pretty handy.- Use a simple local
inode_entryto record each parent The only value is a u64 to record the inode number. And one simplerootdir_pathstructure to record the list ofinode_entry, alone with the current level.This
rootdir_pathstructure along with two helpers,rootdir_path_push()androotdir_path_pop(), along with the preorder traversal provided bynftw(), are enough for us to record all the parent directories until the rootdir.- Grab new inode number properly
Just callbtrfs_get_free_objectid()to grab a proper inode number, other than using some weird calculated value.- Use
btrfs_insert_inode()andbtrfs_add_link()to update directory inode automatically
Quoted 8 lines
Quoted 1 line
With all the refactor, the code is shorter and easier to read.
Agreed on all counts, I think this is a lovely refactor.
For a change of this magnitude, I think it is helpful to justify the correctness of the change by documenting the testing plan. Are there existing unit tests of mkfs that cover all the cases we are modifying here?
We have existing rootdir test cases, from the regular functional tests, to corner cases.
But we lack corner cases of corner cases, like duplicating inode number (cross mnt) and hard links.
Quoted 1 line
Is there some --rootdir master case that covers everything?
It's inside tests/mkfs-tests/
A quick grep shows:
004-rootdir-keeps-size
009-special-files-for-rootdir
011-rootdir-create-file
012-rootdir-no-shrink
014-rootdir-inline-extent
016-rootdir-bad-symbolic-link
021-rfeatures-quota-rootdir
022-rootdir-size
027-rootdir-inode
Quoted 4 lines
Is it
in fstests? Knowing that all of the new code has at least run correctly would go a long way to feeling confident in the details of the transformation.
We have btrfs-progs github CI, runs the all the selftests on each PR. And it's all green (except a typo caught by code spell).
[...]
Quoted 9 lines
mkfs/rootdir.c end: · line 460
Quoted 7 lines
mkfs/rootdir.c +4
-3- parent_inum = highest_inum +BTRFS_FIRST_FREE_OBJECTID ; - dir_entry->inum = parent_inum; -list_add_tail (&dir_entry->list, &dir_head->list); +/* +* If our path level is higher than this level - 1, this means +* we have changed directory. +* Poping out the unrelated inodes. Popping
Exposed by the CI, and fixed immediately in github.
Quoted 21 lines
Also, this took me like 15 minutes of working examples to figure out why it worked. I think it could definitely do with some deeper explanation of the invariant, like:
ftwbuf->level- 1 is the level of the parent of the current traversed inode. ftw will traverse all inodes in a directory before leaving it, and will never traverse an inode without first traversing its dir, so if we see a level less than or equal to the last directory we saw, we are finished with that directory and can pop it.Perhaps with an annotated drawing like:
0: /
1: /foo/
2: /foo/bar/
3: /foo/bar/f
2: /foo/baz/ POP! 2 > (2 - 1); done with /foo/bar/
3: /foo/baz/g
1: /h POP! 2 > (1 - 1); done with /foo/baz/
Quoted 2 lines
To help make it clearer. I honestly even think just changing to >= makes it clearer? Not sure about that.
I'll add comments with an example to explain the workflow.
BTW, David and I are working with Github review system a lot recently:
https://github.com/kdave/btrfs-progs/pull/855
We do not force anyone to use specific system to do anything, but you may find it a little easier to comment, and feel free to fall back to the mail based review workflow at any time.
Thanks a lot for the detailed review!
Qu
Boris Burkov
Reviewed-byRe: [PATCH 2/3] btrfs-progs: mkfs: rework how we traverse rootdir
Quoted 66 lines · Qu Wenruo
Quoted 26 lines · Boris Burkov
Quoted 5 lines · Qu Wenruo
There are several hidden pitfalls of the existing
traverse_directory():- Hand written preorder traversal
Meanwhile there is already a better written standard library function,nftw()doing exactly what we need.This is great!
Quoted 10 lines
- Over-designed path list
To properly handle the directory change, we have structuredirectory_name_entry, to record every inode until rootdir.But it has two string members,
dir_nameand path, which is a little overkilled.
As for preorder traversal, we will never need to read the parent's filename, just its inode number.Quoted 6 lines
And it's exported while no one utilizes it out of
mkfs/rootdir.c.- Weird inode numbers
We use the inode number fromst->st_ino, with an extra offset. This by itself is not safe, if the rootdir has child directory in another filesystem.Quoted 4 lines
Can you explain what you mean by not safe? As far as I can tell, the +256 is to handle that particular invariant of btrfs. Are you worried about duplicate inode numbers in the vein of the usual st_dev/st_ino debates?
I'm worried about this case:
rootdir (on fs1)
|- dir1 | |- file1 (fs1, ino 1024) |- dir2 (on fs2)|- file2 (fs2, ino 1024)
We do not have any cross mount point checks.
I created a case like this:
# fallocate -l 1G 1.img # fallocate -l 1G 2.img # mkfs.ext4 1.img # mkfs.ext4 2.img # mount 1.img mnt # mkdir mnt/dir1 mnt/dir2 # touch mnt/dir1/file1 mnt/file1 # umount mnt # mount 2.img mnt # mkdir mnt/dir1 mnt/dir2 # touch mnt/dir1/file1 mnt/file1 # umount mnt # mkdir rootdir # mount 1.img rootdir # mount 2.img rootdir/dir2 # mkfs.btrfs -f --rootdir rootdir test.img ERROR: item file1 already exists but has wrong st_nlink 1 <= 1 ERROR: unable to traverse directory rootdir/: 1 ERROR: error while filling filesystem: 1
Quoted 2 lines
And it failed as expeceted.
Perfect example, it did seem to be vulnerable to this with just "original st_ino + 256"... Thanks for the new test.
Quoted 8 lines
Quoted 5 lines
In that case, if this is a bugfix, I think it makes sense to write a regression test that highlights it. It would be nice to pull the fix out of the refactor, too, but I suppose that with such a deep refactor, that might not be possible/worth it.
Unfortunately I didn't even notice how serious these problems are, until I tried...
That's kind of my concern with the higher level testing question, that we don't have much coverage for such a big refactor. OTOH, if we already had such serious bugs, how bad could the refactor really be :)
Quoted 74 lines
Will add two new test cases. One is the above one, the other is the hardlink out of rootdir bug I mentioned in 3/3.
Quoted 49 lines
Quoted 15 lines
And this results very weird inode numbers, e.g: item 0 key (256 INODE_ITEM 0) itemoff 16123 itemsize 160 item 6 key (88347519 INODE_ITEM 0) itemoff 15815 itemsize 160 item 16 key (88347520 INODE_ITEM 0) itemoff 15363 itemsize 160 item 20 key (88347521 INODE_ITEM 0) itemoff 15119 itemsize 160 item 24 key (88347522 INODE_ITEM 0) itemoff 14875 itemsize 160 item 26 key (88347523 INODE_ITEM 0) itemoff 14700 itemsize 160 item 28 key (88347524 INODE_ITEM 0) itemoff 14525 itemsize 160 item 30 key (88347557 INODE_ITEM 0) itemoff 14350 itemsize 160 item 32 key (88347566 INODE_ITEM 0) itemoff 14175 itemsize 160 Which is far from a regular fs created by copying the data.+1, especially since it doesn't even *preserve* the inode numbers, which would be a comprehensible (if not working) behavior. Creating the oids in "btrfs order" seems like a nice improvement!
Quoted 29 lines
- Weird directory inode size calculation
Unlike kernel, which updated the directory inode size every time new child inodes are added, we calculate the directory inode size by searching all its children first, then later new inodes linked to this directory won't touch the inode size.Enhance all these points by:
- Use
nftw()to do the preorder traversal
It also provides the extra level detection, which is pretty handy.- Use a simple local
inode_entryto record each parent The only value is a u64 to record the inode number. And one simplerootdir_pathstructure to record the list ofinode_entry, alone with the current level.This
rootdir_pathstructure along with two helpers,rootdir_path_push()androotdir_path_pop(), along with the preorder traversal provided bynftw(), are enough for us to record all the parent directories until the rootdir.- Grab new inode number properly
Just callbtrfs_get_free_objectid()to grab a proper inode number, other than using some weird calculated value.- Use
btrfs_insert_inode()andbtrfs_add_link()to update directory inode automaticallyQuoted 8 lines
Quoted 1 line
With all the refactor, the code is shorter and easier to read.
Agreed on all counts, I think this is a lovely refactor.
For a change of this magnitude, I think it is helpful to justify the correctness of the change by documenting the testing plan. Are there existing unit tests of mkfs that cover all the cases we are modifying here?
We have existing rootdir test cases, from the regular functional tests, to corner cases.
But we lack corner cases of corner cases, like duplicating inode number (cross mnt) and hard links.
Quoted 1 line
Is there some --rootdir master case that covers everything?
It's inside tests/mkfs-tests/
A quick grep shows:
Quoted 9 lines
004-rootdir-keeps-size
009-special-files-for-rootdir
011-rootdir-create-file
012-rootdir-no-shrink
014-rootdir-inline-extent
016-rootdir-bad-symbolic-link
021-rfeatures-quota-rootdir
022-rootdir-size
027-rootdir-inode
Thanks for collecting those. By scanning those, it's hard to tell if there is, for example, a test of an "interesting" directory structure like the one I drew above, to test the traversal, for example.
Out of curiousity, I applied your patches, ran the tests (pass) then put a bug in the traversal code (only pop on cur_lvl > ftw_level, not ftw_level - 1) and 004-rootdir-keeps-size did fail, as it ran on the Documentation/ dir, which does seem like a sufficiently interesting directory.
I feel a bit better now :)
Maybe something that ran after fsstress (or however we test send/recv?) in the long run would be a good test, as we nail down some of the bugs you have hit here.
This comment is not directed at you, but is more general for btrfs
development: I think explicitly stating the testing conducted on a complex patch is really helpful for reviewers.
Quoted 21 lines
Quoted 6 lines
Is it
in fstests? Knowing that all of the new code has at least run correctly would go a long way to feeling confident in the details of the transformation.We have btrfs-progs github CI, runs the all the selftests on each PR. And it's all green (except a typo caught by code spell).
[...]
Quoted 9 lines
mkfs/rootdir.c end: · line 460
Quoted 7 lines
mkfs/rootdir.c +4
-3- parent_inum = highest_inum +BTRFS_FIRST_FREE_OBJECTID ; - dir_entry->inum = parent_inum; -list_add_tail (&dir_entry->list, &dir_head->list); +/* +* If our path level is higher than this level - 1, this means +* we have changed directory. +* Poping out the unrelated inodes. Popping
Quoted 2 lines
Exposed by the CI, and fixed immediately in github.
Cool!
Quoted 24 lines
Quoted 21 lines
Also, this took me like 15 minutes of working examples to figure out why it worked. I think it could definitely do with some deeper explanation of the invariant, like:
ftwbuf->level- 1 is the level of the parent of the current traversed inode. ftw will traverse all inodes in a directory before leaving it, and will never traverse an inode without first traversing its dir, so if we see a level less than or equal to the last directory we saw, we are finished with that directory and can pop it.Perhaps with an annotated drawing like:
0: /
1: /foo/
2: /foo/bar/
3: /foo/bar/f
2: /foo/baz/ POP! 2 > (2 - 1); done with /foo/bar/
3: /foo/baz/g
1: /h POP! 2 > (1 - 1); done with /foo/baz/Quoted 2 lines
To help make it clearer. I honestly even think just changing to >= makes it clearer? Not sure about that.
Quoted 8 lines
I'll add comments with an example to explain the workflow.
BTW, David and I are working with Github review system a lot recently:
https://github.com/kdave/btrfs-progs/pull/855We do not force anyone to use specific system to do anything, but you may find it a little easier to comment, and feel free to fall back to the mail based review workflow at any time.
Happy to do code review in PRs! It's a bit annoying that the history gets blown up when the author re-pushes the branch after incorporating feeback (never understood that design, Phabricator tracks the *branch* history too and it seems very helpful to me.)
BTW, if this review style is going well, we should discuss more and get the workflow more documented/supported in the workflow docs.
Also, while we are still here in email-land, you can add
Thanks,
Boris
Quoted 3 lines
Thanks a lot for the detailed review!
Qu
Re: [PATCH 2/3] btrfs-progs: mkfs: rework how we traverse rootdir
Quoted 1 line · Boris Burkov
On Thu, Aug 01, 2024 at 08:49:39AM +0930, Qu Wenruo wrote:
[...]
Quoted 17 lines
Quoted 7 lines
# mkfs.btrfs -f --rootdir rootdir test.img ERROR: item file1 already exists but has wrong st_nlink 1 <= 1 ERROR: unable to traverse directory rootdir/: 1 ERROR: error while filling filesystem: 1And it failed as expeceted.
Perfect example, it did seem to be vulnerable to this with just "original
st_ino+ 256"... Thanks for the new test.Quoted 6 lines
Quoted 5 lines
In that case, if this is a bugfix, I think it makes sense to write a regression test that highlights it. It would be nice to pull the fix out of the refactor, too, but I suppose that with such a deep refactor, that might not be possible/worth it.
Quoted 6 lines
Quoted 2 lines
Unfortunately I didn't even notice how serious these problems are, until I tried...
That's kind of my concern with the higher level testing question, that we don't have much coverage for such a big refactor. OTOH, if we already had such serious bugs, how bad could the refactor really be :)
David is also pushing for the coverage tests:
https://github.com/kdave/btrfs-progs/actions/runs/10167512547
And indeed the coverage for mkfs/rootdir.c is not that good (71.2 %)
Another thing is, even if we go fsstress (already included btrfs-progs/tests) there are still limits what we can test.
E.g. the cross-mount point bug, and the out of rootdir hard link, as even fsstress can not create new mount point (unless using btrfs snapshot/subvolume)
To be honest, all the exotic new bugs are only exposed if we find some behavior unreliable, then reserve engineering to create test cases.
So in short, we need both fsstress based functionality tests, but we also need all those weird and seemingly impossible hand-crafted corner cases.
I just hope the new cases can improve the coverage.
[...]
Quoted 24 lines
Quoted 11 lines
A quick grep shows:
004-rootdir-keeps-size
009-special-files-for-rootdir
011-rootdir-create-file
012-rootdir-no-shrink
014-rootdir-inline-extent
016-rootdir-bad-symbolic-link
021-rfeatures-quota-rootdir
022-rootdir-size
027-rootdir-inodeThanks for collecting those. By scanning those, it's hard to tell if there is, for example, a test of an "interesting" directory structure like the one I drew above, to test the traversal, for example.
Out of curiousity, I applied your patches, ran the tests (pass) then put a bug in the traversal code (only pop on
cur_lvl>ftw_level, notftw_level- 1) and 004-rootdir-keeps-size did fail, as it ran on theDocumentation/dir, which does seem like a sufficiently interesting directory.I feel a bit better now :)
Quoted 7 lines
Maybe something that ran after fsstress (or however we test send/recv?) in the long run would be a good test, as we nail down some of the bugs you have hit here.
This comment is not directed at you, but is more general for btrfs
development: I think explicitly stating the testing conducted on a complex patch is really helpful for reviewers.
In that case, the coverage rate would be something to improve next.
Quoted 56 lines
Quoted 22 lines
Quoted 7 lines
Is it
in fstests? Knowing that all of the new code has at least run correctly would go a long way to feeling confident in the details of the transformation.We have btrfs-progs github CI, runs the all the selftests on each PR. And it's all green (except a typo caught by code spell).
[...]
Quoted 9 lines
mkfs/rootdir.c end: · line 460
Quoted 7 lines
mkfs/rootdir.c +4
-3- parent_inum = highest_inum +BTRFS_FIRST_FREE_OBJECTID ; - dir_entry->inum = parent_inum; -list_add_tail (&dir_entry->list, &dir_head->list); +/* +* If our path level is higher than this level - 1, this means +* we have changed directory. +* Poping out the unrelated inodes. Popping
Quoted 2 lines
Exposed by the CI, and fixed immediately in github.
Cool!
Quoted 29 lines
Quoted 21 lines
Also, this took me like 15 minutes of working examples to figure out why it worked. I think it could definitely do with some deeper explanation of the invariant, like:
ftwbuf->level- 1 is the level of the parent of the current traversed inode. ftw will traverse all inodes in a directory before leaving it, and will never traverse an inode without first traversing its dir, so if we see a level less than or equal to the last directory we saw, we are finished with that directory and can pop it.Perhaps with an annotated drawing like:
0: /
1: /foo/
2: /foo/bar/
3: /foo/bar/f
2: /foo/baz/ POP! 2 > (2 - 1); done with /foo/bar/
3: /foo/baz/g
1: /h POP! 2 > (1 - 1); done with /foo/baz/Quoted 2 lines
To help make it clearer. I honestly even think just changing to >= makes it clearer? Not sure about that.
I'll add comments with an example to explain the workflow.
BTW, David and I are working with Github review system a lot recently:
https://github.com/kdave/btrfs-progs/pull/855
Quoted 8 lines
Quoted 3 lines
We do not force anyone to use specific system to do anything, but you may find it a little easier to comment, and feel free to fall back to the mail based review workflow at any time.
Happy to do code review in PRs! It's a bit annoying that the history gets blown up when the author re-pushes the branch after incorporating feeback (never understood that design, Phabricator tracks the *branch* history too and it seems very helpful to me.)
In fact that auto outdated marking is pretty useful for guys with a short memory, just like me.
Sometimes I forgot to address some comments, then the review part still shows the previous comment without outdated, reminding me something is missing.
Thanks,
Qu
Quoted 13 lines
BTW, if this review style is going well, we should discuss more and get the workflow more documented/supported in the workflow docs.
Also, while we are still here in email-land, you can add
Reviewed-by Boris Burkov <[email protected]>Thanks,
BorisQuoted 3 lines
Thanks a lot for the detailed review!
Qu