Skip to content

S390 hardware support for kernel zlib

Mikhail Zaslonko linux-s390 lkml 3 versions – In review

Get series with b4
b4 am [email protected]

Versions newest first · linked by author and title

  1. v3 Latest6 patches 6 repliesIn review 5 of 6 applied
  2. v26 patches 3 repliesSuperseded
  3. v15 patches 7 repliesSuperseded

Changes in v3 from the cover letter

- In btrfs zlib_compress_pages() do not copy input pages to the workspace buffer if no s390 hardware compression is enabled or the remaining input data fits in one page.
- Leave just a single Kconfig option for s390 zlib hardware support (CONFIG_ZLIB_DFLTCC)
- Fix the issues reported by kbuild test robot.

Patches in v3 5 of 6 applied

#Subject and filesSizeRepliesApplied
1/6lib/zlib: Add s390 hardware support for kernel zlib_deflatelib/Kconfig lib/Makefile lib/zlib_deflate/deflate.c +8 more+752 -1020 repliesApplied
2/6s390/boot: Rename HEAP_SIZE due to name collisionarch/s390/boot/compressed/decompressor.c+4 -41 replyApplied
3/6lib/zlib: Add s390 hardware support for kernel zlib_inflatelib/decompress_inflate.c lib/zlib_dfltcc/Makefile lib/zlib_dfltcc/dfltcc.h +4 more+233 -110 repliesApplied
4/6s390/boot: Add dfltcc= kernel command line parameterDocumentation/admin-guide/kernel-parameters.txt arch/s390/boot/ipl_parm.c arch/s390/include/asm/setup.h +6 more+55 -20 repliesApplied
5/6lib/zlib: Add zlib_deflate_dfltcc_enabled() functioninclude/linux/zlib.h lib/zlib_deflate/deflate.c lib/zlib_deflate/deflate_syms.c +2 more+24 -90 repliesApplied
6/6btrfs: Use larger zlib buffer for s390 hardware compressionfs/btrfs/compression.c fs/btrfs/zlib.c+94 -3613 replies

Reviews trailers per patch

2 of 6 patches have a Reviewed-by or Acked-by.

PatchChristian BorntraegerDavid Sterba
1/6
2/6R-b
3/6
4/6
5/6
6/6R-b R-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/6] S390 hardware support for kernel zlib

With IBM z15 mainframe the new DFLTCC instruction is available. It implements deflate algorithm in hardware (Nest Acceleration Unit - NXU) with estimated compression and decompression performance orders of magnitude faster than the current zlib.

This patch-set adds s390 hardware compression support to kernel zlib. The code is based on the userspace zlib implementation:
https://github.com/madler/zlib/pull/410
The coding style is also preserved for future maintainability. There is only limited set of userspace zlib functions represented in kernel. Apart from that, all the memory allocation should be performed in advance. Thus, the workarea structures are extended with the parameter lists required for the DEFLATE CONVENTION CALL instruction. Since kernel zlib itself does not support gzip headers, only Adler-32 checksum is processed (also can be produced by DFLTCC facility). Like it was implemented for userspace, kernel zlib will compress in hardware on level 1, and in software on all other levels. Decompression will always happen in hardware (when enabled).
Two DFLTCC compression calls produce the same results only when they both are made on machines of the same generation, and when the respective buffers have the same offset relative to the start of the page. Therefore care should be taken when using hardware compression when reproducible results are desired. However it does always produce the standard conform output which can be inflated anyway.
The new kernel command line parameter 'dfltcc' is introduced to configure s390 zlib hardware support:
Format: { on | off | def_only | inf_only | always }
on: s390 zlib hardware support for compression on
level 1 and decompression (default)
off: No s390 zlib hardware support
def_only: s390 zlib hardware support for deflate
only (compression on level 1)
inf_only: s390 zlib hardware support for inflate
only (decompression)
always: Same as 'on' but ignores the selected compression
level always using hardware support (used for debugging)

The main purpose of the integration of the NXU support into the kernel zlib is the use of hardware deflate in btrfs filesystem with on-the-fly compression enabled. Apart from that, hardware support can also be used during boot for decompressing the kernel or the ramdisk image

With the patch for btrfs expanding zlib buffer from 1 to 4 pages (patch 6) the following performance results have been achieved using the ramdisk with btrfs. These are relative numbers based on throughput rate and compression ratio for zlib level 1:

  Input data              Deflate rate   Inflate rate   Compression ratio
                          NXU/Software   NXU/Software   NXU/Software
  stream of zeroes        1.46           1.02           1.00
  random ASCII data       10.44          3.00           0.96
  ASCII text (dickens)    6,21           3.33           0.94
  binary data (vmlinux)   8,37           3.90           1.02

This means that s390 hardware deflate can provide up to 10 times faster compression (on level 1) and up to 4 times faster decompression (refers to all compression levels) for btrfs zlib.

Disclaimer: Performance results are based on IBM internal tests using DD command-line utility on btrfs on a Fedora 30 based internal driver in native LPAR on a z15 system. Results may vary based on individual workload, configuration and software levels.

Changelog:
v2 -> v3:
- In btrfs zlib_compress_pages() do not copy input pages to the workspace buffer if no s390 hardware compression is enabled or the remaining input data fits in one page.
- Leave just a single Kconfig option for s390 zlib hardware support (CONFIG_ZLIB_DFLTCC)
- Fix the issues reported by kbuild test robot.
v1 -> v2:
- Added new external zlib function to check if s390 Deflate-Conversion facility is installed and enabled (see patch 5).
- The larger buffer for btrfs zlib workspace is allocated only if s390 hardware compression is enabled. In case of failure to allocate 4-page buffer, we fall back to a PAGE_SIZE buffer, as proposed by Josef Bacik (see patch 6).

Mikhail Zaslonko (6):
lib/zlib: Add s390 hardware support for kernel zlib_deflate s390/boot: Rename HEAP_SIZE due to name collision lib/zlib: Add s390 hardware support for kernel zlib_inflate s390/boot: Add dfltcc= kernel command line parameter lib/zlib: Add zlib_deflate_dfltcc_enabled() function
btrfs: Use larger zlib buffer for s390 hardware compression

 .../admin-guide/kernel-parameters.txt         |  12 +
 arch/s390/boot/compressed/decompressor.c      |   8 +-
 arch/s390/boot/ipl_parm.c                     |  14 +
 arch/s390/include/asm/setup.h                 |   7 +
 arch/s390/kernel/setup.c                      |   2 +
 fs/btrfs/compression.c                        |   2 +-
 fs/btrfs/zlib.c                               | 128 +++++---
 include/linux/zlib.h                          |   6 +
 lib/Kconfig                                   |   7 +
 lib/Makefile                                  |   1 +
 lib/decompress_inflate.c                      |  13 +
 lib/zlib_deflate/deflate.c                    |  85 +++---
 lib/zlib_deflate/deflate_syms.c               |   1 +
 lib/zlib_deflate/deftree.c                    |  54 ----
 lib/zlib_deflate/defutil.h                    | 134 ++++++++-
 lib/zlib_dfltcc/Makefile                      |  11 +
 lib/zlib_dfltcc/dfltcc.c                      |  55 ++++
 lib/zlib_dfltcc/dfltcc.h                      | 155 ++++++++++
 lib/zlib_dfltcc/dfltcc_deflate.c              | 280 ++++++++++++++++++
 lib/zlib_dfltcc/dfltcc_inflate.c              | 149 ++++++++++
 lib/zlib_dfltcc/dfltcc_syms.c                 |  17 ++
 lib/zlib_dfltcc/dfltcc_util.h                 | 103 +++++++
 lib/zlib_inflate/inflate.c                    |  32 +-
 lib/zlib_inflate/inflate.h                    |   8 +
 lib/zlib_inflate/infutil.h                    |  18 +-
 25 files changed, 1150 insertions(+), 152 deletions(-)
 create mode 100644 lib/zlib_dfltcc/Makefile
 create mode 100644 lib/zlib_dfltcc/dfltcc.c
 create mode 100644 lib/zlib_dfltcc/dfltcc.h
 create mode 100644 lib/zlib_dfltcc/dfltcc_deflate.c
 create mode 100644 lib/zlib_dfltcc/dfltcc_inflate.c
 create mode 100644 lib/zlib_dfltcc/dfltcc_syms.c
 create mode 100644 lib/zlib_dfltcc/dfltcc_util.h
Signature · 1 line
2.17.1