Improve setup_items_for_insert
cover Improve setup_items_for_insert
here is a series to improve setup_items_for_insert. First patch is a simple re-arranegement of statements to eliminate a duplication of calculation. Patches 2 and 3 improve leaky interface of setup_items_for_insert as they convey information about the function's implementation. Patch 4 adds a proper kernel doc. Finally, patch 5 improves the error message in an exceptional condition. As an added bonus after applying the whole series bloat-o-meter output looks like:
add/remove: 0/0 grow/shrink: 1/7 up/down: 33/-99 (-66)
Function old new deltasetup_items_for_insert 1200 1233 +33
insert_extent 448 445 -3 btrfs_duplicate_item 260 254 -6 test_btrfs_split_item 1784 1776 -8 insert_inode_item_key 156 148 -8 __btrfs_drop_extents 3637 3621 -16 btrfs_insert_delayed_items 1153 1125 -28 btrfs_insert_empty_items 177 147 -30
Total: Before=1113157, After=1113091, chg -0.01%
This has survived -g quick of xfstests
Nikolay Borisov (5):
btrfs: Re-arrange statements in setup_items_for_insert
btrfs: Eliminate total_size parameter from setup_items_for_insert
btrfs: Sink total_data parameter in setup_items_for_insert
btrfs: Add kerneldoc for setup_items_for_insert
btrfs: improve error message in setup_items_for_insert
fs/btrfs/ctree.c | 35 +++++++++++++++++----------- fs/btrfs/ctree.h | 2 +- fs/btrfs/delayed-inode.c | 3 +-- fs/btrfs/file.c | 6 +---- fs/btrfs/tests/extent-buffer-tests.c | 3 +-- fs/btrfs/tests/inode-tests.c | 6 ++--- 6 files changed, 28 insertions(+), 27 deletions(-)
--
2.17.1
PATCH 1/5 btrfs: Re-arrange statements in setup_items_for_insert
Rearrange statements calculating the offset of the newly added items so that the calculation has to be done only once. No functional change.
--- fs/btrfs/ctree.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
fs/btrfs/ctree.c +1 -1
@@ -4823,8 +4823,8 @@ void setup_items_for_insert(struct btrfs_root *root, struct btrfs_path *path,btrfs_cpu_key_to_disk (&disk_key, cpu_key + i);btrfs_set_item_key (leaf, &disk_key, slot + i); item =btrfs_item_nr (slot + i); -btrfs_set_token_item_offset (&token, item, data_end - data_size[i]); data_end -= data_size[i]; +btrfs_set_token_item_offset (&token, item, data_end);btrfs_set_token_item_size (&token, item, data_size[i]); }
Signature · 1 line
2.17.1
Re: [PATCH 1/5] btrfs: Re-arrange statements in setup_items_for_insert
Quoted 4 lines · Nikolay Borisov
Rearrange statements calculating the offset of the newly added items so that the calculation has to be done only once. No functional change.
Signed-off-by Nikolay Borisov <[email protected]>
Thanks,
Josef
PATCH 2/5 btrfs: Eliminate total_size parameter from setup_items_for_insert
In reply to Nikolay BorisovThe value of this argument can be derived from the total_data as it's simply the value of the data size + size of btrfs_items being touched. Move the parameter calculation inside the function. This results in a simpler interface and also a minor size reduction:
./scripts/bloat-o-meter ctree.original fs/btrfs/ctree.o add/remove: 0/0 grow/shrink: 0/3 up/down: 0/-34 (-34)
Function old new delta btrfs_duplicate_item 260 259 -1
setup_items_for_insert 1200 1190 -10btrfs_insert_empty_items 177 154 -23
--- fs/btrfs/ctree.c | 11 +++++------ fs/btrfs/ctree.h | 2 +- fs/btrfs/delayed-inode.c | 4 ++-- fs/btrfs/file.c | 5 +---- fs/btrfs/tests/extent-buffer-tests.c | 3 +-- fs/btrfs/tests/inode-tests.c | 6 ++---- 6 files changed, 12 insertions(+), 19 deletions(-)
fs/btrfs/ctree.c +5 -6
@@ -4571,9 +4571,7 @@ int btrfs_duplicate_item(struct btrfs_trans_handle *trans,return ret; path->slots[0 ]++; -setup_items_for_insert (root, path, new_key, &item_size, - item_size, item_size + -sizeof (struct btrfs_item ),1 ); +setup_items_for_insert (root, path, new_key, &item_size, item_size,1 ); leaf = path->nodes[0 ]; memcpy_extent_buffer(leaf, btrfs_item_ptr_offset(leaf, path->slots[0]),
@@ -4753,7 +4751,7 @@ void btrfs_extend_item(struct btrfs_path *path, u32 data_size)*/ void setup_items_for_insert (struct btrfs_root *root,struct btrfs_path *path,const struct btrfs_key *cpu_key,u32 *data_size, -u32 total_data,u32 total_size,int nr) +u32 total_data,int nr) {struct btrfs_fs_info *fs_info = root->fs_info;struct btrfs_item *item;
@@ -4764,6 +4762,8 @@ void setup_items_for_insert(struct btrfs_root *root, struct btrfs_path *path,struct extent_buffer *leaf;int slot;struct btrfs_map_token token; +const u32 total_size = total_data + (nr *sizeof (struct btrfs_item )); +if (path->slots[0 ] ==0 ) {btrfs_cpu_key_to_disk (&disk_key, cpu_key);
@@ -4866,8 +4866,7 @@ int btrfs_insert_empty_items(struct btrfs_trans_handle *trans, slot = path->slots[0 ];BUG_ON (slot <0 ); -setup_items_for_insert (root, path, cpu_key, data_size, - total_data, total_size, nr); +setup_items_for_insert (root, path, cpu_key, data_size, total_data, nr);return 0 ; }
fs/btrfs/ctree.h +1 -1
@@ -2713,7 +2713,7 @@ static inline int btrfs_del_item(struct btrfs_trans_handle *trans,void setup_items_for_insert (struct btrfs_root *root,struct btrfs_path *path,const struct btrfs_key *cpu_key,u32 *data_size, -u32 total_data,u32 total_size,int nr); +u32 total_data,int nr);int btrfs_insert_item (struct btrfs_trans_handle *trans,struct btrfs_root *root,const struct btrfs_key *key,void *data,u32 data_size); int btrfs_insert_empty_items(struct btrfs_trans_handle *trans,
fs/btrfs/delayed-inode.c +2 -2
@@ -768,8 +768,8 @@ static int btrfs_batch_insert_items(struct btrfs_root *root, }/* insert the keys of the items */ -setup_items_for_insert (root, path, keys, data_size, - total_data_size, total_size, nitems); +setup_items_for_insert (root, path, keys, data_size, total_data_size, + nitems);/* insert the dir index items */ slot = path->slots[0 ];
fs/btrfs/file.c +1 -4
@@ -1057,10 +1057,7 @@ int __btrfs_drop_extents(struct btrfs_trans_handle *trans,if (btrfs_comp_cpu_keys (&key, &slot_key) >0 ) path->slots[0 ]++; } -setup_items_for_insert (root, path, &key, - &extent_item_size, - extent_item_size, -sizeof (struct btrfs_item ) + +setup_items_for_insert (root, path, &key, &extent_item_size, extent_item_size,1 ); *key_inserted =1 ; }
fs/btrfs/tests/extent-buffer-tests.c +1 -2
@@ -60,8 +60,7 @@ static int test_btrfs_split_item(u32 sectorsize, u32 nodesize) key.type =BTRFS_EXTENT_CSUM_KEY ; key.offset =0 ; -setup_items_for_insert (root, path, &key, &value_len, value_len, - value_len +sizeof (struct btrfs_item ),1 ); +setup_items_for_insert (root, path, &key, &value_len, value_len,1 ); item =btrfs_item_nr (0 );write_extent_buffer (eb, value,btrfs_item_ptr_offset (eb,0 ), value_len);
fs/btrfs/tests/inode-tests.c +2 -4
@@ -33,8 +33,7 @@ static void insert_extent(struct btrfs_root *root, u64 start, u64 len, key.type =BTRFS_EXTENT_DATA_KEY ; key.offset = start; -setup_items_for_insert (root, &path, &key, &value_len, value_len, - value_len +sizeof (struct btrfs_item ),1 ); +setup_items_for_insert (root, &path, &key, &value_len, value_len,1 ); fi = btrfs_item_ptr(leaf, slot, struct btrfs_file_extent_item);btrfs_set_file_extent_generation (leaf, fi,1 );btrfs_set_file_extent_type (leaf, fi, type);
@@ -64,8 +63,7 @@ static void insert_inode_item_key(struct btrfs_root *root) key.type =BTRFS_INODE_ITEM_KEY ; key.offset =0 ; -setup_items_for_insert (root, &path, &key, &value_len, value_len, - value_len +sizeof (struct btrfs_item ),1 ); +setup_items_for_insert (root, &path, &key, &value_len, value_len,1 ); }/*
Signature · 1 line
2.17.1
Re: [PATCH 2/5] btrfs: Eliminate total_size parameter from setup_items_for_insert
Quoted 5 lines · Nikolay Borisov
The value of this argument can be derived from the
total_dataas it's simply the value of the data size + size ofbtrfs_itemsbeing touched. Move the parameter calculation inside the function. This results in a simpler interface and also a minor size reduction:
Quoted 8 lines
./scripts/bloat-o-meterctree.originalfs/btrfs/ctree.oadd/remove: 0/0 grow/shrink: 0/3 up/down: 0/-34 (-34)Function old new delta btrfs_duplicate_item 260 259 -1
setup_items_for_insert1200 1190 -10btrfs_insert_empty_items177 154 -23Signed-off-by Nikolay Borisov <[email protected]>
Some of these things, like btrfs_batch_insert_items, we could probably clean up and remove total_size later.
Thanks,
Josef
PATCH 3/5 btrfs: Sink total_data parameter in setup_items_for_insert
In reply to Nikolay BorisovThat parameter can easily be derived based on the "data_size" and "nr" parameters exploit this fact to simply the function's signature. No functional changes.
--- fs/btrfs/ctree.c | 12 ++++++++---- fs/btrfs/ctree.h | 2 +- fs/btrfs/delayed-inode.c | 3 +-- fs/btrfs/file.c | 3 +-- fs/btrfs/tests/extent-buffer-tests.c | 2 +- fs/btrfs/tests/inode-tests.c | 4 ++-- 6 files changed, 14 insertions(+), 12 deletions(-)
fs/btrfs/ctree.c +8 -4
@@ -4571,7 +4571,7 @@ int btrfs_duplicate_item(struct btrfs_trans_handle *trans,return ret; path->slots[0 ]++; -setup_items_for_insert (root, path, new_key, &item_size, item_size,1 ); +setup_items_for_insert (root, path, new_key, &item_size,1 ); leaf = path->nodes[0 ]; memcpy_extent_buffer(leaf, btrfs_item_ptr_offset(leaf, path->slots[0]),
@@ -4751,7 +4751,7 @@ void btrfs_extend_item(struct btrfs_path *path, u32 data_size)*/ void setup_items_for_insert (struct btrfs_root *root,struct btrfs_path *path,const struct btrfs_key *cpu_key,u32 *data_size, -u32 total_data,int nr) +int nr) {struct btrfs_fs_info *fs_info = root->fs_info;struct btrfs_item *item;
@@ -4762,8 +4762,12 @@ void setup_items_for_insert(struct btrfs_root *root, struct btrfs_path *path,struct extent_buffer *leaf;int slot;struct btrfs_map_token token; -const u32 total_size = total_data + (nr *sizeof (struct btrfs_item )); +u32 total_size; +u32 total_data =0 ; +for (i =0 ; i < nr; i++) + total_data += data_size[i]; + total_size = total_data + (nr *sizeof (struct btrfs_item ));if (path->slots[0 ] ==0 ) {btrfs_cpu_key_to_disk (&disk_key, cpu_key);
@@ -4866,7 +4870,7 @@ int btrfs_insert_empty_items(struct btrfs_trans_handle *trans, slot = path->slots[0 ];BUG_ON (slot <0 ); -setup_items_for_insert (root, path, cpu_key, data_size, total_data, nr); +setup_items_for_insert (root, path, cpu_key, data_size, nr);return 0 ; }
fs/btrfs/ctree.h +1 -1
@@ -2713,7 +2713,7 @@ static inline int btrfs_del_item(struct btrfs_trans_handle *trans,void setup_items_for_insert (struct btrfs_root *root,struct btrfs_path *path,const struct btrfs_key *cpu_key,u32 *data_size, -u32 total_data,int nr); +int nr);int btrfs_insert_item (struct btrfs_trans_handle *trans,struct btrfs_root *root,const struct btrfs_key *key,void *data,u32 data_size); int btrfs_insert_empty_items(struct btrfs_trans_handle *trans,
fs/btrfs/delayed-inode.c +1 -2
@@ -768,8 +768,7 @@ static int btrfs_batch_insert_items(struct btrfs_root *root, }/* insert the keys of the items */ -setup_items_for_insert (root, path, keys, data_size, total_data_size, - nitems); +setup_items_for_insert (root, path, keys, data_size, nitems);/* insert the dir index items */ slot = path->slots[0 ];
fs/btrfs/file.c +1 -2
@@ -1057,8 +1057,7 @@ int __btrfs_drop_extents(struct btrfs_trans_handle *trans,if (btrfs_comp_cpu_keys (&key, &slot_key) >0 ) path->slots[0 ]++; } -setup_items_for_insert (root, path, &key, &extent_item_size, - extent_item_size,1 ); +setup_items_for_insert (root, path, &key, &extent_item_size,1 ); *key_inserted =1 ; }
fs/btrfs/tests/extent-buffer-tests.c +1 -1
@@ -60,7 +60,7 @@ static int test_btrfs_split_item(u32 sectorsize, u32 nodesize) key.type =BTRFS_EXTENT_CSUM_KEY ; key.offset =0 ; -setup_items_for_insert (root, path, &key, &value_len, value_len,1 ); +setup_items_for_insert (root, path, &key, &value_len,1 ); item =btrfs_item_nr (0 );write_extent_buffer (eb, value,btrfs_item_ptr_offset (eb,0 ), value_len);
fs/btrfs/tests/inode-tests.c +2 -2
@@ -33,7 +33,7 @@ static void insert_extent(struct btrfs_root *root, u64 start, u64 len, key.type =BTRFS_EXTENT_DATA_KEY ; key.offset = start; -setup_items_for_insert (root, &path, &key, &value_len, value_len,1 ); +setup_items_for_insert (root, &path, &key, &value_len,1 ); fi = btrfs_item_ptr(leaf, slot, struct btrfs_file_extent_item);btrfs_set_file_extent_generation (leaf, fi,1 );btrfs_set_file_extent_type (leaf, fi, type);
@@ -63,7 +63,7 @@ static void insert_inode_item_key(struct btrfs_root *root) key.type =BTRFS_INODE_ITEM_KEY ; key.offset =0 ; -setup_items_for_insert (root, &path, &key, &value_len, value_len,1 ); +setup_items_for_insert (root, &path, &key, &value_len,1 ); }/*
Signature · 1 line
2.17.1
Re: [PATCH 3/5] btrfs: Sink total_data parameter in setup_items_for_insert
Quoted 5 lines · Nikolay Borisov
That parameter can easily be derived based on the "
data_size" and "nr" parameters exploit this fact to simply the function's signature. No functional changes.Signed-off-by Nikolay Borisov <[email protected]>
Thanks,
Josef
PATCH 4/5 btrfs: Add kerneldoc for setup_items_for_insert
In reply to Nikolay Borisov--- fs/btrfs/ctree.c | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-)
fs/btrfs/ctree.c +10 -4
@@ -4744,10 +4744,16 @@ void btrfs_extend_item(struct btrfs_path *path, u32 data_size) } } -/* -* this is a helper for btrfs_insert_empty_items, the main goal here is -* to save stack depth by doing the bulk of the work in a function -* that doesn't call btrfs_search_slot +/** +* setup_items_for_insert - Helper called before inserting one or more items +* in a leaf. Main purpose is to save stack depth by doing the bulk of the work +* in a function that doesn't call btrfs_search_slot +* +* @root: root we are inserting items in +* @path: points to the leaf/slot where we are going to insert new items +* @cpu_key: array of keys for items to be inserted +* @data_size: size of the body of each item we are going to insert +* @nr: size of @cpu_key/@data_size arrays */ void setup_items_for_insert(struct btrfs_root *root, struct btrfs_path *path, const struct btrfs_key *cpu_key, u32 *data_size,
Signature · 1 line
2.17.1
Re: [PATCH 4/5] btrfs: Add kerneldoc for setup_items_for_insert
Quoted 1 line · Nikolay Borisov
Signed-off-by Nikolay Borisov <[email protected]>
Thanks,
Josef
PATCH 5/5 btrfs: improve error message in setup_items_for_insert
In reply to Nikolay BorisovWhile at it also print the leaf content after the error.
--- fs/btrfs/ctree.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
fs/btrfs/ctree.c +2 -2
@@ -4799,9 +4799,9 @@ void setup_items_for_insert(struct btrfs_root *root, struct btrfs_path *path,unsigned int old_data =btrfs_item_end_nr (leaf, slot);if (old_data < data_end) { -btrfs_print_leaf (leaf); -btrfs_crit (fs_info,"slot %d old_data %d data_end %d" , +btrfs_crit (fs_info,"item's (slot %d) data offset (%d) beyond data end of leaf (%d)" , slot, old_data, data_end); +btrfs_print_leaf (leaf);BUG (); }/*
Signature · 1 line
2.17.1
Re: [PATCH 5/5] btrfs: improve error message in setup_items_for_insert
Quoted 3 lines · Nikolay Borisov
While at it also print the leaf content after the error.
Signed-off-by Nikolay Borisov <[email protected]>
Thanks,
Josef
Re: [PATCH 5/5] btrfs: improve error message in setup_items_for_insert
In reply to Nikolay BorisovQuoted 12 lines · Nikolay Borisov
While at it also print the leaf content after the error.
Signed-off-by Nikolay Borisov <[email protected]>--- fs/btrfs/ctree.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)fs/btrfs/ctree.c +0
-0
fs/btrfs/ctree.c void setup_items_for_insert(struct btrfs_root *root, struct btrfs_path *path, · line 4804
Quoted 8 lines
fs/btrfs/ctree.c +2
-2@@ -4799,9 +4799,9 @@ void setup_items_for_insert(struct btrfs_root *root, struct btrfs_path *path,unsigned int old_data =btrfs_item_end_nr (leaf, slot);if (old_data < data_end) { -btrfs_print_leaf (leaf); -btrfs_crit (fs_info,"slot %d old_data %d data_end %d" , +btrfs_crit (fs_info,"item's (slot %d) data offset (%d) beyond data end of leaf (%d)" , slot, old_data, data_end); +btrfs_print_leaf (leaf);
This is a question if the order is right or vice versa. When something goes wrong, the leaf dump fills a few pages or screens and it's not always possible to scroll back.
The idea of 1) dump leaf 2) print the error message, is to keep the specific error last hoping that it's still visible when somebody takes a screenshot for a bugreport.
I've checked instances where we call print_leaf and this is the most common ordering, so I'd rather keep it like that as it has some practial impacts.
Re: [PATCH 5/5] btrfs: improve error message in setup_items_for_insert
In reply to Nikolay BorisovQuoted 12 lines · Nikolay Borisov
While at it also print the leaf content after the error.
Signed-off-by Nikolay Borisov <[email protected]>--- fs/btrfs/ctree.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)fs/btrfs/ctree.c +0
-0
fs/btrfs/ctree.c void setup_items_for_insert(struct btrfs_root *root, struct btrfs_path *path, · line 4803
Quoted 7 lines
fs/btrfs/ctree.c +1
-2@@ -4799,9 +4799,9 @@ void setup_items_for_insert(struct btrfs_root *root, struct btrfs_path *path,unsigned int old_data =btrfs_item_end_nr (leaf, slot);if (old_data < data_end) { -btrfs_print_leaf (leaf); -btrfs_crit (fs_info,"slot %d old_data %d data_end %d" , +btrfs_crit (fs_info,"item's (slot %d) data offset (%d) beyond data end of leaf (%d)" , slot, old_data, data_end);
I've changed it to
"item at slot %d with data offset %u beyond data end of leaf %u"
as we don't use the ( ) elsewhere. The formats were mismatching old_data and data_end, so they're now %u.
fs/btrfs/ctree.c void setup_items_for_insert(struct btrfs_root *root, struct btrfs_path *path, · line 4804
Quoted 1 line
fs/btrfs/ctree.c +1
-0+btrfs_print_leaf (leaf);
The leaf is dumped as before, so the changelog got updated too.
Looks good,
Quoted 20 lines · Nikolay Borisov
here is a series to improve
setup_items_for_insert. First patch is a simple re-arranegement of statements to eliminate a duplication of calculation. Patches 2 and 3 improve leaky interface ofsetup_items_for_insertas they convey information about the function's implementation. Patch 4 adds a proper kernel doc. Finally, patch 5 improves the error message in an exceptional condition. As an added bonus after applying the whole series bloat-o-meter output looks like:add/remove: 0/0 grow/shrink: 1/7 up/down: 33/-99 (-66)
Function old new deltasetup_items_for_insert1200 1233 +33insert_extent 448 445 -3 btrfs_duplicate_item 260 254 -6 test_btrfs_split_item 1784 1776 -8 insert_inode_item_key 156 148 -8 __btrfs_drop_extents 3637 3621 -16 btrfs_insert_delayed_items 1153 1125 -28 btrfs_insert_empty_items 177 147 -30Total: Before=1113157, After=1113091, chg -0.01%
Quoted 8 lines
This has survived -g quick of xfstests
Nikolay Borisov (5):
btrfs: Re-arrange statements insetup_items_for_insert
btrfs: Eliminatetotal_sizeparameter fromsetup_items_for_insert
btrfs: Sinktotal_dataparameter insetup_items_for_insert
btrfs: Add kerneldoc forsetup_items_for_insert
btrfs: improve error message insetup_items_for_insert
Thanks, all seem straightforward, I'll add it to for-next and move to misc-next once the tests finish.