Re: [PATCH v2] AOSP: erofs-utils: add block list support

[Gao Xiang <hsiangkao@linux.alibaba.com>]

Hi Yue,

On Thu, Jun 24, 2021 at 12:33:12PM +0800, Yue Hu wrote:
> On Thu, 24 Jun 2021 01:31:29 +0800
> Gao Xiang <hsiangkao@linux.alibaba.com> wrote:
> 
> > From: Yue Hu <huyue2@yulong.com>
> > 
> > Android update engine will treat EROFS filesystem image as one single
> > file. Let's add block list support to optimize OTA size.
> > 
> > Signed-off-by: Yue Hu <huyue2@yulong.com>
> > Signed-off-by: Gao Xiang <xiang@kernel.org>
> > ---
> > some cleanups.
> > 
> > Hi all,
> > please kindly check it again if it works since I dont have such
> > environment. If it doesn't work, please help fix it..
> > 
> > Thanks,
> > Gao Xiang
> > 
> >  include/erofs/block_list.h | 27 +++++++++++++++
> >  include/erofs/config.h     |  1 +
> >  lib/block_list.c           | 86 ++++++++++++++++++++++++++++++++++++++++++++++
> >  lib/compress.c             |  2 ++
> >  lib/inode.c                |  6 ++++
> >  mkfs/main.c                | 14 ++++++++
> >  6 files changed, 136 insertions(+)
> >  create mode 100644 include/erofs/block_list.h
> >  create mode 100644 lib/block_list.c
> > 
> > diff --git a/include/erofs/block_list.h b/include/erofs/block_list.h
> > new file mode 100644
> > index 000000000000..7756d8a5784c
> > --- /dev/null
> > +++ b/include/erofs/block_list.h
> > @@ -0,0 +1,27 @@
> > +// SPDX-License-Identifier: GPL-2.0+
> > +/*
> > + * erofs-utils/include/erofs/block_list.h
> > + *
> > + * Copyright (C), 2021, Coolpad Group Limited.
> > + * Created by Yue Hu <huyue2@yulong.com>
> > + */
> > +#ifndef __EROFS_BLOCK_LIST_H
> > +#define __EROFS_BLOCK_LIST_H
> > +
> > +#include "internal.h"
> > +
> > +#ifdef WITH_ANDROID
> > +int erofs_droid_blocklist_fopen(void);
> > +void erofs_droid_blocklist_fclose(void);
> > +void erofs_droid_blocklist_write(struct erofs_inode *inode,
> > +				 erofs_blk_t blk_start, erofs_blk_t nblocks);
> > +void erofs_droid_blocklist_write_tail_end(struct erofs_inode *inode,
> > +					  erofs_blk_t blkaddr);
> > +#else
> > +static inline void erofs_droid_blocklist_write(struct erofs_inode *inode,
> > +				 erofs_blk_t blk_start, erofs_blk_t nblocks) {}
> > +static inline
> > +void erofs_droid_blocklist_write_tail_end(struct erofs_inode *inode,
> > +					  erofs_blk_t blkaddr) {}
> > +#endif
> > +#endif
> > diff --git a/include/erofs/config.h b/include/erofs/config.h
> > index d140a735bd49..67e7a0fed24c 100644
> > --- a/include/erofs/config.h
> > +++ b/include/erofs/config.h
> > @@ -65,6 +65,7 @@ struct erofs_configure {
> >  	char *mount_point;
> >  	char *target_out_path;
> >  	char *fs_config_file;
> > +	char *block_list_file;
> >  #endif
> >  };
> >  
> > diff --git a/lib/block_list.c b/lib/block_list.c
> > new file mode 100644
> > index 000000000000..ffe780e91900
> > --- /dev/null
> > +++ b/lib/block_list.c
> > @@ -0,0 +1,86 @@
> > +// SPDX-License-Identifier: GPL-2.0+
> > +/*
> > + * erofs-utils/lib/block_list.c
> > + *
> > + * Copyright (C), 2021, Coolpad Group Limited.
> > + * Created by Yue Hu <huyue2@yulong.com>
> > + */
> > +#ifdef WITH_ANDROID
> > +#include <stdio.h>
> > +#include <sys/stat.h>
> > +#include "erofs/block_list.h"
> > +
> > +#define pr_fmt(fmt) "EROFS block_list: " FUNC_LINE_FMT fmt "\n"
> > +#include "erofs/print.h"
> > +
> > +static FILE *block_list_fp = NULL;
> > +
> > +int erofs_droid_blocklist_fopen(void)
> > +{
> > +	if (block_list_fp)
> > +		return 0;
> > +
> > +	block_list_fp = fopen(cfg.block_list_file, "w");
> > +
> > +	if (!block_list_fp)
> > +		return -1;
> > +	return 0;
> > +}
> > +
> > +void erofs_droid_blocklist_fclose(void)
> > +{
> > +	if (!block_list_fp)
> > +		return;
> > +
> > +	fclose(block_list_fp);
> > +	block_list_fp = NULL;
> > +}
> > +
> > +static void blocklist_write(const char *path, erofs_blk_t blk_start,
> > +			    erofs_blk_t nblocks, bool has_tail)
> > +{
> > +	const char *fspath = erofs_fspath(path);
> > +
> > +	fprintf(block_list_fp, "/%s", cfg.mount_point);
> > +
> > +	if (fspath[0] != '/')
> > +		fprintf(block_list_fp, "/");
> > +
> > +	if (nblocks == 1)
> > +		fprintf(block_list_fp, "%s %u", fspath, blk_start);
> > +	else if (nblocks > 1)
> > +		fprintf(block_list_fp, "%s %u-%u", fspath, blk_start,
> > +			blk_start + nblocks - 1);
> > +	else
> > +		fprintf(block_list_fp, "%s", fspath);
> 
> Seems the last else branch is not correct, it will only record the fspath without
> block map due to only inline tail-end data. It's not intention in my v1 patch.

Thanks for pointing out... yeah, that is a bit awkward, my intention was
to simplify it as much as possible, some better idea for this?

Thanks,
Gao Xiang

> 
> > + 
> > +	if (!has_tail)
> > +		fprintf(block_list_fp, "\n");
> > +}
> > +
> > +void erofs_droid_blocklist_write(struct erofs_inode *inode,
> > +				 erofs_blk_t blk_start, erofs_blk_t nblocks)
> > +{
> > +	if (!block_list_fp || !cfg.mount_point)
> > +		return;
> > +
> > +	blocklist_write(inode->i_srcpath, blk_start, nblocks,
> > +			!!inode->idata_size);
> > +}
> > +
> > +void erofs_droid_blocklist_write_tail_end(struct erofs_inode *inode,
> > +					  erofs_blk_t blkaddr)
> > +{
> > +	if (!block_list_fp || !cfg.mount_point)
> > +		return;
> > +
> > +	/* XXX: a bit hacky.. may need a better approach */
> > +	if (S_ISDIR(inode->i_mode) || S_ISLNK(inode->i_mode))
> > +		return;
> > +
> > +	if (blkaddr != NULL_ADDR)
> > +		fprintf(block_list_fp, " %u\n", blkaddr);
> > +	else
> > +		fprintf(block_list_fp, "\n");
> > +}
> > +#endif
> > diff --git a/lib/compress.c b/lib/compress.c
> > index 2093bfd68b71..af0c72037281 100644
> > --- a/lib/compress.c
> > +++ b/lib/compress.c
> > @@ -18,6 +18,7 @@
> >  #include "erofs/cache.h"
> >  #include "erofs/compress.h"
> >  #include "compressor.h"
> > +#include "erofs/block_list.h"
> >  
> >  static struct erofs_compress compresshandle;
> >  static int compressionlevel;
> > @@ -571,6 +572,7 @@ int erofs_write_compressed_file(struct erofs_inode *inode)
> >  		DBG_BUGON(ret);
> >  	}
> >  	inode->compressmeta = compressmeta;
> > +	erofs_droid_blocklist_write(inode, blkaddr, compressed_blocks);
> >  	return 0;
> >  
> >  err_bdrop:
> > diff --git a/lib/inode.c b/lib/inode.c
> > index 787e5b4485a2..4134f8a0e91b 100644
> > --- a/lib/inode.c
> > +++ b/lib/inode.c
> > @@ -21,6 +21,7 @@
> >  #include "erofs/compress.h"
> >  #include "erofs/xattr.h"
> >  #include "erofs/exclude.h"
> > +#include "erofs/block_list.h"
> >  
> >  #define S_SHIFT                 12
> >  static unsigned char erofs_ftype_by_mode[S_IFMT >> S_SHIFT] = {
> > @@ -369,6 +370,7 @@ static int write_uncompressed_file_from_fd(struct erofs_inode *inode, int fd)
> >  			return -EIO;
> >  		}
> >  	}
> > +	erofs_droid_blocklist_write(inode, inode->u.i_blkaddr, nblocks);
> >  	return 0;
> >  }
> >  
> > @@ -638,6 +640,8 @@ int erofs_write_tail_end(struct erofs_inode *inode)
> >  
> >  		ibh->fsprivate = erofs_igrab(inode);
> >  		ibh->op = &erofs_write_inline_bhops;
> > +
> > +		erofs_droid_blocklist_write_tail_end(inode, NULL_ADDR);
> >  	} else {
> >  		int ret;
> >  		erofs_off_t pos;
> > @@ -657,6 +661,8 @@ int erofs_write_tail_end(struct erofs_inode *inode)
> >  		inode->idata_size = 0;
> >  		free(inode->idata);
> >  		inode->idata = NULL;
> > +
> > +		erofs_droid_blocklist_write_tail_end(inode, erofs_blknr(pos));
> >  	}
> >  out:
> >  	/* now bh_data can drop directly */
> > diff --git a/mkfs/main.c b/mkfs/main.c
> > index e476189f0731..28539da5ea5f 100644
> > --- a/mkfs/main.c
> > +++ b/mkfs/main.c
> > @@ -22,6 +22,7 @@
> >  #include "erofs/compress.h"
> >  #include "erofs/xattr.h"
> >  #include "erofs/exclude.h"
> > +#include "erofs/block_list.h"
> >  
> >  #ifdef HAVE_LIBUUID
> >  #include <uuid.h>
> > @@ -47,6 +48,7 @@ static struct option long_options[] = {
> >  	{"mount-point", required_argument, NULL, 10},
> >  	{"product-out", required_argument, NULL, 11},
> >  	{"fs-config-file", required_argument, NULL, 12},
> > +	{"block-list-file", required_argument, NULL, 13},
> >  #endif
> >  	{0, 0, 0, 0},
> >  };
> > @@ -95,6 +97,7 @@ static void usage(void)
> >  	      " --mount-point=X       X=prefix of target fs path (default: /)\n"
> >  	      " --product-out=X       X=product_out directory\n"
> >  	      " --fs-config-file=X    X=fs_config file\n"
> > +	      " --block-list-file=X    X=block_list file\n"
> >  #endif
> >  	      "\nAvailable compressors are: ", stderr);
> >  	print_available_compressors(stderr, ", ");
> > @@ -293,6 +296,9 @@ static int mkfs_parse_options_cfg(int argc, char *argv[])
> >  		case 12:
> >  			cfg.fs_config_file = optarg;
> >  			break;
> > +		case 13:
> > +			cfg.block_list_file = optarg;
> > +			break;
> >  #endif
> >  		case 'C':
> >  			i = strtoull(optarg, &endptr, 0);
> > @@ -541,6 +547,11 @@ int main(int argc, char **argv)
> >  		erofs_err("failed to load fs config %s", cfg.fs_config_file);
> >  		return 1;
> >  	}
> > +
> > +	if (cfg.block_list_file && erofs_droid_blocklist_fopen() < 0) {
> > +		erofs_err("failed to open %s", cfg.block_list_file);
> > +		return 1;
> > +	}
> >  #endif
> >  
> >  	erofs_show_config();
> > @@ -607,6 +618,9 @@ int main(int argc, char **argv)
> >  		err = erofs_mkfs_superblock_csum_set();
> >  exit:
> >  	z_erofs_compress_exit();
> > +#ifdef WITH_ANDROID
> > +	erofs_droid_blocklist_fclose();
> > +#endif
> >  	dev_close();
> >  	erofs_cleanup_exclude_rules();
> >  	erofs_exit_configure();