Refine and export backing file loop check
v7 cover Refine and export backing file loop check
If there is loop exists in the backing file chain, many problems could be caused by it, such as no response and segment fault during system boot. Hence stopping backing file loop appear is very necessary. These patches refine and export loop checking function from collect_image_ info_list() to block.c and build a independent function named bdrv_ backing_file_loop_check(). Backing file loop checking is added before image created, before change backing file and before system boot.
Updates from V6:
1. Combine bdrv_backing_chain_okay() and bdrv_new_chain_okay() into one.
2. Delete bdrv_find_format() in the backing_chain_has_loop().
3. Comments syntax and function naming updates.
Updates from V5:
1. Simplify the function of loop checking (Just filename comparation. Thanks Eric's suggestion).
2. Delete WIN32 platform support (There is no need to this patch now).
3. Adjust position of backing file loop checking (calling checking function before change happen).
4. Function name updates and comments description fix.
Updates from V4:
1. Add backing file loop check in bdrv_new_open().
2. Adjust open file logic of collect_image_info_list() (bdrv_new_open() is called only once when opening the whole chain).
3. Remove redundant brackets in lnk file check logic.
4. Add error output in bdrv_img_create().
5. Remove MAX_PATH_LEN to use PATH_MAX instead.
Updates from V3:
1. Comments fix for function bdrv_backing_file_loop_check().
2. Add ret check for fseek()/fread() in get_lnk_target_file().
3. Add limit of shortcuts filename length reading during comparing.
4. Add error_report() in driv_init().
5. Remove redundant loop check in qcow2/qed_change_backing_file().
Updates from V2:
1. Removed parameter @chain from bdrv_backing_file_loop_check()
2. Comments and format fix, all patches were checked by checkpatch.pl
3. Fixed *bs leak.
4. Improved logic of .lnk file recognization.
5. Add filename lenth limit check in while()
6. Changed get_win_inode() to get_inode() and move all inode get method into it to make logic more simpler.
7. Added value of @fmt as suggested.
8. Added backing file loop check in qcow2.c/qed.c
Xu Wang (4):
block/qemu-img: Refine and export infinite loop checking in
collect_image_info_list()
block: Add check infinite loop in bdrv_img_create()
block: Add backing file loop check in change_backing_file()
blockdev: Add infinite loop check in drive_init()
block.c | 90 ++++++++++++++++++++++++++++++++++++++++++++++++--- blockdev.c | 6 ++++ include/block/block.h | 3 ++ qemu-img.c | 52 ++++++++++++++--------------- 4 files changed, 121 insertions(+), 30 deletions(-)
Signature · 1 line
1.8.1.4
PATCH v7 1/4 block/qemu-img: Refine and export infinite loop checking in collect_image_info_list()
If there is a loop in the backing file chain, it could cause problems such as no response or a segfault during system boot. Hence detecting a backing file loop is necessary. This patch extracts the loop check from collect_image_info_list() in block.c into independent functions bdrv_backing_chain_okay() and bdrv_image_create_okay().
--- block.c | 76 +++++++++++++++++++++++++++++++++++++++++++++++++++ include/block/block.h | 3 ++ qemu-img.c | 52 +++++++++++++++++------------------ 3 files changed, 105 insertions(+), 26 deletions(-)
block.c +76 -0
@@ -4490,6 +4490,82 @@ bdrv_acct_done(BlockDriverState *bs, BlockAcctCookie *cookie) bs->total_time_ns[cookie->type] +=get_clock () - cookie->start_time_ns; } +static bool file_chain_has_loop (GHashTable *filenames,const char *filename, +const char *fmt) +{ +BlockDriverState *bs; +char fbuf[PATH_MAX ]; +int ret; +Error *local_err =NULL ; + +while (filename && (filename[0 ] !='\0' )) { +if (g_hash_table_lookup_extended (filenames, filename,NULL ,NULL )) { +error_report ("Backing file '%s' creates an infinite loop." , + filename); +return true; + } +g_hash_table_insert (filenames, (gpointer )filename,NULL ); + + bs =bdrv_new ("image" ); + + ret =bdrv_open (bs, filename,NULL , +BDRV_O_CACHE_WB |BDRV_O_NO_BACKING ,NULL , &local_err); +if (ret <0 ) { +error_report ("Could not open '%s': %s" , filename, +error_get_pretty (local_err)); +error_free (local_err); + local_err =NULL ; +return true; + } + +bdrv_get_backing_filename (bs, fbuf,sizeof (fbuf)); + filename = fbuf; + fmt =NULL ; + +bdrv_unref (bs); + } + +return false; +} + +/** +* Check backing file chain if there is a loop in it. +* +* @filename: topmost image filename of backing file chain. +* @fmt: topmost image format of backing file chain(may be NULL to autodetect). +* @new_filename: if a new image to be created and takes @filename as backing +* file, the new chain should be checked before creating. +* +* Returns: true for backing chain okay, false for loop happened. +*/ +bool bdrv_backing_chain_okay (const char *filename,const char *fmt, +const char *new_filename) +{ +GHashTable *filenames; + + filenames =g_hash_table_new_full (g_str_hash, g_str_equal,NULL ,NULL ); + +if (filename ==NULL || filename[0 ] =='\0' ) { + goto exit; + } + +if (new_filename && new_filename[0 ] !='\0' ) { +g_hash_table_insert (filenames, (gpointer )new_filename,NULL ); + } + +if (file_chain_has_loop (filenames, filename, fmt)) { + goto err; + } + +exit: +g_hash_table_destroy (filenames); +return true; + +err: +g_hash_table_destroy (filenames); +return false; +} + void bdrv_img_create(const char *filename, const char *fmt, const char *base_filename, const char *base_fmt, char *options, uint64_t img_size, int flags,
include/block/block.h +3 -0
@@ -378,6 +378,9 @@ int bdrv_save_vmstate(BlockDriverState *bs, const uint8_t *buf,int bdrv_load_vmstate (BlockDriverState *bs,uint8_t *buf,int64_t pos,int size); +bool bdrv_backing_chain_okay (const char *filename,const char *fmt, +const char *new_filename); + void bdrv_img_create(const char *filename, const char *fmt, const char *base_filename, const char *base_fmt, char *options, uint64_t img_size, int flags,
qemu-img.c +26 -26
87 lines not on this page · raw message
Signature · 1 line
1.8.1.4
Re: [Qemu-devel] [PATCH V7 1/4] block/qemu-img: Refine and export infinite loop checking in collect_image_info_list()
Quoted 25 lines · Xu Wang
If there is a loop in the backing file chain, it could cause problems such as no response or a segfault during system boot. Hence detecting a backing file loop is necessary. This patch extracts the loop check from
collect_image_info_list()inblock.cinto independent functionsbdrv_backing_chain_okay()andbdrv_image_create_okay().Signed-off-by Xu Wang <[email protected]>--- block.c | 76 +++++++++++++++++++++++++++++++++++++++++++++++++++ include/block/block.h | 3 ++ qemu-img.c | 52 +++++++++++++++++------------------ 3 files changed, 105 insertions(+), 26 deletions(-)block.c +4
-0@@ -4490,6 +4490,82 @@ bdrv_acct_done(BlockDriverState *bs, BlockAcctCookie *cookie) bs->total_time_ns[cookie->type] +=get_clock () - cookie->start_time_ns; } +static bool file_chain_has_loop (GHashTable *filenames,const char *filename, +const char *fmt) +{ +BlockDriverState *bs;
block.c bdrv_acct_done(BlockDriverState *bs, BlockAcctCookie *cookie) · line 4506
Quoted 10 lines
block.c +10
-0+char fbuf[PATH_MAX ]; +int ret; +Error *local_err =NULL ; + +while (filename && (filename[0 ] !='\0' )) { +if (g_hash_table_lookup_extended (filenames, filename,NULL ,NULL )) { +error_report ("Backing file '%s' creates an infinite loop." , + filename); +return true; + }
I would expect the caller to format error message and report to user. But this is acceptable. Let's see if other reviewers have more opinions.
Fam
Quoted 175 lines
block.c +62
-0+g_hash_table_insert (filenames, (gpointer )filename,NULL ); + + bs =bdrv_new ("image" ); + + ret =bdrv_open (bs, filename,NULL , +BDRV_O_CACHE_WB |BDRV_O_NO_BACKING ,NULL , &local_err); +if (ret <0 ) { +error_report ("Could not open '%s': %s" , filename, +error_get_pretty (local_err)); +error_free (local_err); + local_err =NULL ; +return true; + } + +bdrv_get_backing_filename (bs, fbuf,sizeof (fbuf)); + filename = fbuf; + fmt =NULL ; + +bdrv_unref (bs); + } + +return false; +} + +/** +* Check backing file chain if there is a loop in it. +* +* @filename: topmost image filename of backing file chain. +* @fmt: topmost image format of backing file chain(may be NULL to autodetect). +* @new_filename: if a new image to be created and takes @filename as backing +* file, the new chain should be checked before creating. +* +* Returns: true for backing chain okay, false for loop happened. +*/ +bool bdrv_backing_chain_okay (const char *filename,const char *fmt, +const char *new_filename) +{ +GHashTable *filenames; + + filenames =g_hash_table_new_full (g_str_hash, g_str_equal,NULL ,NULL ); + +if (filename ==NULL || filename[0 ] =='\0' ) { + goto exit; + } + +if (new_filename && new_filename[0 ] !='\0' ) { +g_hash_table_insert (filenames, (gpointer )new_filename,NULL ); + } + +if (file_chain_has_loop (filenames, filename, fmt)) { + goto err; + } + +exit: +g_hash_table_destroy (filenames); +return true; + +err: +g_hash_table_destroy (filenames); +return false; +} + void bdrv_img_create(const char *filename, const char *fmt, const char *base_filename, const char *base_fmt, char *options, uint64_t img_size, int flags,include/block/block.h +3
-0@@ -378,6 +378,9 @@ int bdrv_save_vmstate(BlockDriverState *bs, const uint8_t *buf,int bdrv_load_vmstate (BlockDriverState *bs,uint8_t *buf,int64_t pos,int size); +bool bdrv_backing_chain_okay (const char *filename,const char *fmt, +const char *new_filename); + void bdrv_img_create(const char *filename, const char *fmt, const char *base_filename, const char *base_fmt, char *options, uint64_t img_size, int flags,qemu-img.c +26
-26@@ -281,6 +281,14 @@ static BlockDriverState *bdrv_new_open(const char *filename, drv =NULL ; } +/* check backing file loop if the whole chain need to be opened */ +if (!(flags &BDRV_O_NO_BACKING ) && + !bdrv_backing_chain_okay (filename, fmt,NULL )) { +error_report ("bdrv_new_open: Open %s failed. An infinite loop exists " +"in the backing chain" , filename); + goto fail; + } + ret =bdrv_open (bs, filename,NULL , flags, drv, &local_err);if (ret <0 ) { error_report("Could not open '%s': %s", filename,@@ -1641,11 +1649,6 @@ static void dump_human_image_info_list(ImageInfoList *list) } } -static gboolean str_equal_func (gconstpointer a,gconstpointer b) -{ -return strcmp (a, b) ==0 ; -} -/** * Open an image file chain and return an ImageInfoList * @@ -1663,30 +1666,24 @@ static ImageInfoList *collect_image_info_list(const char *filename, bool chain) {ImageInfoList *head =NULL ; +BlockDriverState *bs; +ImageInfoList *elem;ImageInfoList **last = &head; -GHashTable *filenames; +ImageInfo *info;Error *err =NULL ; +int flags =BDRV_O_FLAGS ; - filenames =g_hash_table_new_full (g_str_hash, str_equal_func,NULL ,NULL ); - -while (filename) { -BlockDriverState *bs; -ImageInfo *info; -ImageInfoList *elem; - -if (g_hash_table_lookup_extended (filenames, filename,NULL ,NULL )) { -error_report ("Backing file '%s' creates an infinite loop." , - filename); - goto err; - } -g_hash_table_insert (filenames, (gpointer )filename,NULL ); +if (!chain) { + flags |=BDRV_O_NO_BACKING ; + } - bs =bdrv_new_open (filename, fmt,BDRV_O_FLAGS |BDRV_O_NO_BACKING , - false, false); -if (!bs) { - goto err; - } + bs =bdrv_new_open (filename, fmt, flags, + false, false); +if (!bs) { + goto err; + } +while (filename) {bdrv_query_image_info (bs, &info, &err);if (error_is_set (&err)) {error_report ("%s" ,error_get_pretty (err));@@ -1711,14 +1708,17 @@ static ImageInfoList *collect_image_info_list(const char *filename,if (info->has_backing_filename_format) { fmt = info->backing_filename_format; } + +if (filename) { + bs =bdrv_find_backing_image (bs, filename); + } } } -g_hash_table_destroy (filenames); +return head; err:qapi_free_ImageInfoList (head); -g_hash_table_destroy (filenames);return NULL ; }
PATCH v7 2/4 block: Add check infinite loop in bdrv_img_create()
In reply to Xu WangBacking file loop should be checked before qemu-img create command execution. If loop is found, qemu-img create should be stopped and an error printed.
--- block.c | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-)
block.c +5 -4
@@ -4629,15 +4629,16 @@ void bdrv_img_create(const char *filename, const char *fmt, } backing_file =get_option_parameter (param,BLOCK_OPT_BACKING_FILE ); + backing_fmt =get_option_parameter (param,BLOCK_OPT_BACKING_FMT );if (backing_file && backing_file->value.s) { -if (!strcmp (filename, backing_file->value.s)) { -error_setg (errp,"Error: Trying to create an image with the " -"same filename as the backing file" ); +if (!bdrv_backing_chain_okay (backing_file->value.s, + backing_fmt->value.s, filename)) { +error_setg (errp,"bdrv_img_create: loop exists, " +"image create failed" ); goto out; } } - backing_fmt =get_option_parameter (param,BLOCK_OPT_BACKING_FMT );if (backing_fmt && backing_fmt->value.s) { backing_drv =bdrv_find_format (backing_fmt->value.s);if (!backing_drv) {
Signature · 1 line
1.8.1.4
Re: [Qemu-devel] [PATCH V7 2/4] block: Add check infinite loop in bdrv_img_create()
Quoted 16 lines · Xu Wang
Backing file loop should be checked before qemu-img create command execution. If loop is found, qemu-img create should be stopped and an error printed.
Signed-off-by Xu Wang <[email protected]>--- block.c | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-)block.c +0
-0@@ -4629,15 +4629,16 @@ void bdrv_img_create(const char *filename, const char *fmt, }
block.c void bdrv_img_create(const char *filename, const char *fmt, · line 4637
Quoted 10 lines
block.c +5
-3backing_file =get_option_parameter (param,BLOCK_OPT_BACKING_FILE ); + backing_fmt =get_option_parameter (param,BLOCK_OPT_BACKING_FMT );if (backing_file && backing_file->value.s) { -if (!strcmp (filename, backing_file->value.s)) { -error_setg (errp,"Error: Trying to create an image with the " -"same filename as the backing file" ); +if (!bdrv_backing_chain_okay (backing_file->value.s, + backing_fmt->value.s, filename)) { +error_setg (errp,"bdrv_img_create: loop exists, " +"image create failed" );
Another failure path in file_chain_has_loop() is when bdrv_open fails, which is not a backing chain loop. What if the backing file doesn't exist? Would the error message still mention "look exits", which is very confusing?
Fam
Quoted 9 lines
block.c +0
-1goto out; } } - backing_fmt =get_option_parameter (param,BLOCK_OPT_BACKING_FMT );if (backing_fmt && backing_fmt->value.s) { backing_drv =bdrv_find_format (backing_fmt->value.s);if (!backing_drv) {
Re: [Qemu-devel] [PATCH V7 2/4] block: Add check infinite loop in bdrv_img_create()
Quoted 18 lines · Fam Zheng
Quoted 17 lines · Xu Wang
Backing file loop should be checked before qemu-img create command execution. If loop is found, qemu-img create should be stopped and an error printed.
Signed-off-by Xu Wang <[email protected]>--- block.c | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-)block.c +0
-0@@ -4629,15 +4629,16 @@ void bdrv_img_create(const char *filename, const char *fmt, }
Quoted 16 lines
block.c void bdrv_img_create(const char *filename, const char *fmt, · line 4637
Quoted 11 lines
block.c +1
-2backing_file =get_option_parameter (param,BLOCK_OPT_BACKING_FILE ); + backing_fmt =get_option_parameter (param,BLOCK_OPT_BACKING_FMT );if (backing_file && backing_file->value.s) { -if (!strcmp (filename, backing_file->value.s)) { - error_setg(errp, "Error: Trying to create an image withthe "
block.c +4
-1- "same filename as the backing file"); +if (!bdrv_backing_chain_okay (backing_file->value.s, + backing_fmt->value.s, filename)) { +error_setg (errp,"bdrv_img_create: loop exists, " +"image create failed" );Another failure path in
file_chain_has_loop()is whenbdrv_openfails, which is not a backing chain loop. What if the backing file doesn't exist? Would the error message still mention "look exits", which is very confusing?
s/look/loop/
Fam
Quoted 14 lines
Fam
Quoted 9 lines
goto out; } }- backing_fmt = get_option_parameter(param, BLOCK_OPT_BACKING_FMT); if (backing_fmt && backing_fmt->value.s) { backing_drv = bdrv_find_format(backing_fmt->value.s); if (!backing_drv) {
PATCH v7 3/4 block: Add backing file loop check in change_backing_file()
In reply to Xu WangBacking file loop should be checked before calling change_backing_ file(). If loop appeared, this calling should be stopped and an error printed.
--- block.c | 5 +++++ 1 file changed, 5 insertions(+)
block.c +5 -0
@@ -2083,6 +2083,11 @@ int bdrv_change_backing_file(BlockDriverState *bs,return -EINVAL ; } +/* Check if loop exists in backing files chain after change */ +if (!bdrv_backing_chain_okay (backing_file, backing_fmt, bs->filename)) { +return -EIO ; + } +if (drv->bdrv_change_backing_file !=NULL ) { ret = drv->bdrv_change_backing_file (bs, backing_file, backing_fmt); }else {
Signature · 1 line
1.8.1.4
Quoted 54 lines · Xu Wang
If there is loop exists in the backing file chain, many problems could be caused by it, such as no response and segment fault during system boot. Hence stopping backing file loop appear is very necessary. These patches refine and export loop checking function from
collect_image_info_list()toblock.cand build a independent function namedbdrv_backing_file_loop_check(). Backing file loop checking is added before image created, before change backing file and before system boot.Updates from V6:
1. Combinebdrv_backing_chain_okay()andbdrv_new_chain_okay()into one.
2. Deletebdrv_find_format()in thebacking_chain_has_loop().
3. Comments syntax and function naming updates.Updates from V5:
1. Simplify the function of loop checking (Just filename comparation. Thanks Eric's suggestion).
2. Delete WIN32 platform support (There is no need to this patch now).
3. Adjust position of backing file loop checking (calling checking function before change happen).
4. Function name updates and comments description fix.Updates from V4:
1. Add backing file loop check inbdrv_new_open().
2. Adjust open file logic ofcollect_image_info_list()(bdrv_new_open()is called only once when opening the whole chain).
3. Remove redundant brackets in lnk file check logic.
4. Add error output inbdrv_img_create().
5. RemoveMAX_PATH_LENto usePATH_MAXinstead.Updates from V3:
1. Comments fix for functionbdrv_backing_file_loop_check().
2. Add ret check for fseek()/fread() inget_lnk_target_file().
3. Add limit of shortcuts filename length reading during comparing.
4. Adderror_report()indriv_init().
5. Remove redundant loop check in qcow2/qed_change_backing_file().Updates from V2:
1. Removed parameter @chain frombdrv_backing_file_loop_check()
2. Comments and format fix, all patches were checked by checkpatch.pl
3. Fixed *bs leak.
4. Improved logic of .lnk file recognization.
5. Add filename lenth limit check inwhile()
6. Changedget_win_inode()toget_inode()and move all inode get method into it to make logic more simpler.
7. Added value of @fmt as suggested.
8. Added backing file loop check inqcow2.c/qed.cXu Wang (4):
block/qemu-img: Refine and export infinite loop checking in
collect_image_info_list()
block: Add check infinite loop inbdrv_img_create()
block: Add backing file loop check inchange_backing_file()
blockdev: Add infinite loop check indrive_init()
Quoted 6 lines
block.c | 90 ++++++++++++++++++++++++++++++++++++++++++++++++--- blockdev.c | 6 ++++ include/block/block.h | 3 ++ qemu-img.c | 52 ++++++++++++++--------------- 4 files changed, 121 insertions(+), 30 deletions(-)
Thanks, this looks pretty good to me. I've left a few questions, mainly regarding to the error messages.
Thank you for your effort continuously improving your series!
Fam