Skip to content

Commit

Permalink
module: Split modules_install compression and in-kernel decompression
Browse files Browse the repository at this point in the history
The kernel configuration allows specifying a module compression mode. If
one is selected then each module gets compressed during
'make modules_install' and additionally one can also enable support for
a respective direct in-kernel decompression support. This means that the
decompression support cannot be enabled without the automatic compression.

Some distributions, such as the (open)SUSE family, use a signer service for
modules. A build runs on a worker machine but signing is done by a separate
locked-down server that is in possession of the signing key. The build
invokes 'make modules_install' to create a modules tree, collects
information about the modules, asks the signer service for their signature,
appends each signature to the respective module and compresses all modules.

When using this arrangment, the 'make modules_install' step produces
unsigned+uncompressed modules and the distribution's own build recipe takes
care of signing and compression later.

The signing support can be currently enabled without automatically signing
modules during 'make modules_install'. However, the in-kernel decompression
support can be selected only after first enabling automatic compression
during this step.

To allow only enabling the in-kernel decompression support without the
automatic compression during 'make modules_install', separate the
compression options similarly to the signing options, as follows:

> Enable loadable module support
[*] Module compression
      Module compression type (GZIP)  --->
[*]   Automatically compress all modules
[ ]   Support in-kernel module decompression

* "Module compression" (MODULE_COMPRESS) is a new main switch for the
  compression/decompression support. It replaces MODULE_COMPRESS_NONE.
* "Module compression type" (MODULE_COMPRESS_<type>) chooses the
  compression type, one of GZ, XZ, ZSTD.
* "Automatically compress all modules" (MODULE_COMPRESS_ALL) is a new
  option to enable module compression during 'make modules_install'. It
  defaults to Y.
* "Support in-kernel module decompression" (MODULE_DECOMPRESS) enables
  in-kernel decompression.

Signed-off-by: Petr Pavlu <petr.pavlu@suse.com>
Acked-by: Masahiro Yamada <masahiroy@kernel.org>
Signed-off-by: Luis Chamberlain <mcgrof@kernel.org>
  • Loading branch information
petrpavlu authored and mcgrof committed Aug 19, 2024
1 parent 47ac09b commit c7ff693
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 30 deletions.
61 changes: 31 additions & 30 deletions kernel/module/Kconfig
Original file line number Diff line number Diff line change
Expand Up @@ -278,64 +278,65 @@ config MODULE_SIG_HASH
default "sha3-384" if MODULE_SIG_SHA3_384
default "sha3-512" if MODULE_SIG_SHA3_512

choice
prompt "Module compression mode"
config MODULE_COMPRESS
bool "Module compression"
help
This option allows you to choose the algorithm which will be used to
compress modules when 'make modules_install' is run. (or, you can
choose to not compress modules at all.)

External modules will also be compressed in the same way during the
installation.

For modules inside an initrd or initramfs, it's more efficient to
compress the whole initrd or initramfs instead.

Enable module compression to reduce on-disk size of module binaries.
This is fully compatible with signed modules.

Please note that the tool used to load modules needs to support the
corresponding algorithm. module-init-tools MAY support gzip, and kmod
MAY support gzip, xz and zstd.
The tool used to work with modules needs to support the selected
compression type. kmod MAY support gzip, xz and zstd. Other tools
might have a limited selection of the supported types.

Your build system needs to provide the appropriate compression tool
to compress the modules.
Note that for modules inside an initrd or initramfs, it's more
efficient to compress the whole ramdisk instead.

If in doubt, select 'None'.
If unsure, say N.

config MODULE_COMPRESS_NONE
bool "None"
choice
prompt "Module compression type"
depends on MODULE_COMPRESS
help
Do not compress modules. The installed modules are suffixed
with .ko.
Choose the supported algorithm for module compression.

config MODULE_COMPRESS_GZIP
bool "GZIP"
help
Compress modules with GZIP. The installed modules are suffixed
with .ko.gz.
Support modules compressed with GZIP. The installed modules are
suffixed with .ko.gz.

config MODULE_COMPRESS_XZ
bool "XZ"
help
Compress modules with XZ. The installed modules are suffixed
with .ko.xz.
Support modules compressed with XZ. The installed modules are
suffixed with .ko.xz.

config MODULE_COMPRESS_ZSTD
bool "ZSTD"
help
Compress modules with ZSTD. The installed modules are suffixed
with .ko.zst.
Support modules compressed with ZSTD. The installed modules are
suffixed with .ko.zst.

endchoice

config MODULE_COMPRESS_ALL
bool "Automatically compress all modules"
default y
depends on MODULE_COMPRESS
help
Compress all modules during 'make modules_install'.

Your build system needs to provide the appropriate compression tool
for the selected compression type. External modules will also be
compressed in the same way during the installation.

config MODULE_DECOMPRESS
bool "Support in-kernel module decompression"
depends on MODULE_COMPRESS_GZIP || MODULE_COMPRESS_XZ || MODULE_COMPRESS_ZSTD
depends on MODULE_COMPRESS
select ZLIB_INFLATE if MODULE_COMPRESS_GZIP
select XZ_DEC if MODULE_COMPRESS_XZ
select ZSTD_DECOMPRESS if MODULE_COMPRESS_ZSTD
help

Support for decompressing kernel modules by the kernel itself
instead of relying on userspace to perform this task. Useful when
load pinning security policy is enabled.
Expand Down
2 changes: 2 additions & 0 deletions scripts/Makefile.modinst
Original file line number Diff line number Diff line change
Expand Up @@ -51,9 +51,11 @@ $(foreach x, % :, $(if $(findstring $x, $(dst)), \
$(error module installation path cannot contain '$x')))

suffix-y :=
ifdef CONFIG_MODULE_COMPRESS_ALL
suffix-$(CONFIG_MODULE_COMPRESS_GZIP) := .gz
suffix-$(CONFIG_MODULE_COMPRESS_XZ) := .xz
suffix-$(CONFIG_MODULE_COMPRESS_ZSTD) := .zst
endif

modules := $(patsubst $(extmod_prefix)%.o, $(dst)/%.ko$(suffix-y), $(modules))
install-$(CONFIG_MODULES) += $(modules)
Expand Down

0 comments on commit c7ff693

Please sign in to comment.