Skip to content

staging: erofs: decompression inplace approach

Gao Xiang linux-erofs linux-fsdevel lkml 1 version In review

Get series with b4
b4 am [email protected]

Versions newest first

  1. v3 Latest8 patches 2 repliesIn review

Changes in v3 from the cover letter

- wrap up some offsets as marcos;
- add some error handling for erofs_get_pcpubuf();
- move some decompression inplace stuffes from PATCH 5 -> 6.

Patches in v3 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/8staging: erofs: add compacted ondisk compression indexesdrivers/staging/erofs/data.c drivers/staging/erofs/erofs_fs.h drivers/staging/erofs/inode.c +2 more+62 -310 replies
2/8staging: erofs: add compacted compression indexes supportdrivers/staging/erofs/Makefile drivers/staging/erofs/inode.c drivers/staging/erofs/internal.h +2 more+480 -2950 replies
3/8staging: erofs: move per-CPU buffers implementation to utils.cdrivers/staging/erofs/internal.h drivers/staging/erofs/unzip_vle.c drivers/staging/erofs/unzip_vle.h +2 more+56 -281 reply
4/8staging: erofs: move stagingpage operations to compress.hdrivers/staging/erofs/compress.h drivers/staging/erofs/unzip_vle.c drivers/staging/erofs/unzip_vle.h+46 -250 replies
5/8staging: erofs: introduce generic decompression backenddrivers/staging/erofs/Makefile drivers/staging/erofs/compress.h drivers/staging/erofs/decompressor.c+323 -10 replies
6/8staging: erofs: introduce LZ4 decompression inplacedrivers/staging/erofs/compress.h drivers/staging/erofs/decompressor.c drivers/staging/erofs/erofs_fs.h+35 -50 replies
7/8staging: erofs: switch to new decompression backenddrivers/staging/erofs/Makefile drivers/staging/erofs/internal.h drivers/staging/erofs/unzip_vle.c +2 more+24 -2800 replies
8/8staging: erofs: integrate decompression inplacedrivers/staging/erofs/internal.h drivers/staging/erofs/unzip_vle.c drivers/staging/erofs/unzip_vle.h +1 more+16 -40 replies

Reviews trailers per patch

All 8 patches have a Reviewed-by or Acked-by.

PatchChao Yu
1/8R-b
2/8R-b
3/8R-b
4/8R-b
5/8R-b
6/8R-b
7/8R-b
8/8R-b

Trailers given in replies are filled; those carried in the patches from earlier versions are outlined with dashes.

Read the v3 thread

Cover letter [PATCH v3 0/8] staging: erofs: decompression inplace approach

This is patch v3 of erofs decompression inplace approach, which is sent out by my personal email since I'm out of office to attend Open Source Summit China 2019 these days. No major change from PATCH v2 since no noticeable issue raised from landing to our products till now, mainly as a response to Chao's suggestions.

See the bottom lines which are taken from RFC PATCH v1 and describe the principle of these technologies.

The series is based on the latest staging-next since all dependencies have already been merged.

changelog from v2:
- wrap up some offsets as marcos;
- add some error handling for erofs_get_pcpubuf();
- move some decompression inplace stuffes from PATCH 5 -> 6.

changelog from v1:
- keep Z_EROFS_NR_INLINE_PAGEVECS in unzip_vle.h after switching to new decompression backend;
- add some DBG_BUGONs in new decompression backend to observe potential issues;
- minor code cleanup.

8<--------

Hi,

After working on for more than half a year, the detail of erofs decompression inplace is almost determined and ready for linux-next.

Currently, inplace IO is used if the whole compressed data is used in order to reduce compressed pages extra memory overhead and an extra memcpy (the only one memcpy) will be used for each inplace IO since temporary buffer is needed to keep decompressing safe for inplace IO.

However, most of lz-based decompression algorithms support decompression inplace by their algorithm designs, such as LZ4, LZO, etc.

If iend - oend margin is large enough, decompression inplace can be done in the same buffer safely, as illustrated below:

start of compressed logical extent
| end of this logical extent
| |
______v___________________________v________

... |  page 6  |  page 7  |  page 8  |  page 9  | ...
    |__________|__________|__________|__________|
           .                         ^ .        ^
           .                         |compressed|
           .                         |   data   |
           .                           .        .
           |<          dstsize        >|<margin>|
                                       oend     iend

op ip

Fixed-size output compression can make the full use of this feature to reduce memory overhead and avoid extra memcpy compared with fixed-size input compression since iend is strictly not less than oend for fixed-size output compression with inplace IO to last pages.

In addition, erofs compression indexes have been improved as well by introducing compacted compression indexes.

These two techniques all benefit sequential read (on x86_64, 710.8MiB/s -> 755.4MiB/s; on Kirin980, 725MiB/s -> 812MiB/s) therefore erofs could have similar sequential read performance against ext4 in a larger CR range on high-spend SSD / NVMe devices as well.

However, note that it is _cpu vs storage device_ tradeoff, there is no absolute performance conclusion for all on-market combinations.

Test images:

 name                       size                 CR
 enwik9                     1000000000           1.00
 enwik9_4k.squashfs.img      621211648           1.61
 enwik9_4k.erofs.img         558133248           1.79
 enwik9_8k.squashfs.img      556191744           1.80
 enwik9_16k.squashfs.img     502661120           1.99
 enwik9_128k.squashfs.img    398204928           2.51

Test Environment:
CPU: Intel(R) Core(TM) i5-8250U CPU @ 1.60GHz (4 cores, 8 threads)
DDR: 8G
SSD: INTEL SSDPEKKF360G7H
Kernel: Linux 5.2-rc3+ (with lz4-1.8.3 algorithm)

Test configuration:
squashfs:
CONFIG_SQUASHFS=y
CONFIG_SQUASHFS_FILE_DIRECT=y
CONFIG_SQUASHFS_DECOMP_MULTI_PERCPU=y
CONFIG_SQUASHFS_LZ4=y
CONFIG_SQUASHFS_4K_DEVBLK_SIZE=y
erofs:
CONFIG_EROFS_FS_USE_VM_MAP_RAM=y
CONFIG_EROFS_FS_ZIP=y
CONFIG_EROFS_FS_CLUSTER_PAGE_LIMIT=1
CONFIG_EROFS_FS_ZIP_CACHE_BIPOLAR=y

with intel_pstate=disable,

     8 cpus on at 1801000 scaling_{min,max}_freq,
     userspace scaling_governor

Sequential read results (MiB/s):

                           1      2      3      4      5      avg
 enwik9_4k.ext4.img        767    770    738    726    724    745
 enwik9_4k.erofs.img       756    745    770    746    760    755.4
 enwik9_4k.squashfs.img    90.3   83.0   94.3   90.7   92.6   90.18
 enwik9_8k.squashfs.img    111    108    110    108    110    109.4
 enwik9_16k.squashfs.img   158    163    146    165    174    161.2
 enwik9_128k.squashfs.img  324    314    262    262    296    291.6

Thanks,
Gao Xiang

Gao Xiang (8):
staging: erofs: add compacted ondisk compression indexes
staging: erofs: add compacted compression indexes support
staging: erofs: move per-CPU buffers implementation to utils.c
staging: erofs: move stagingpage operations to compress.h
staging: erofs: introduce generic decompression backend
staging: erofs: introduce LZ4 decompression inplace
staging: erofs: switch to new decompression backend
staging: erofs: integrate decompression inplace

 drivers/staging/erofs/Makefile        |   2 +-
 drivers/staging/erofs/compress.h      |  62 ++++
 drivers/staging/erofs/data.c          |   4 +-
 drivers/staging/erofs/decompressor.c  | 329 ++++++++++++++++++
 drivers/staging/erofs/erofs_fs.h      |  68 +++-
 drivers/staging/erofs/inode.c         |  12 +-
 drivers/staging/erofs/internal.h      |  52 ++-
 drivers/staging/erofs/unzip_vle.c     | 368 ++------------------
 drivers/staging/erofs/unzip_vle.h     |  38 +--
 drivers/staging/erofs/unzip_vle_lz4.c | 229 -------------
 drivers/staging/erofs/utils.c         |  12 +
 drivers/staging/erofs/zmap.c          | 463 ++++++++++++++++++++++++++
 12 files changed, 1006 insertions(+), 633 deletions(-)
 create mode 100644 drivers/staging/erofs/compress.h
 create mode 100644 drivers/staging/erofs/decompressor.c
 delete mode 100644 drivers/staging/erofs/unzip_vle_lz4.c
 create mode 100644 drivers/staging/erofs/zmap.c
Signature · 1 line
2.17.1