New release s390-tools-2.17.0

Signed-off-by: Jan Höppner <hoeppner@linux.ibm.com>

.gitignore

@@ -5,6 +5,10 @@
 *.a
 *.o.d
 
+# ctags files
+tags
+TAGS
+
 #
 # Ignore generated executables and other generated files
 #
@@ -13,6 +17,7 @@ cpacfstats/cpacfstats
 cpacfstats/cpacfstatsd
 cpumf/chcpumf
 cpumf/lscpumf
+cpumf/lshwc
 cpuplugd/cpuplugd
 dasdfmt/dasdfmt
 dasdinfo/dasdinfo
@@ -20,6 +25,7 @@ dasdview/dasdview
 dump2tar/src/dump2tar
 fdasd/fdasd
 hmcdrvfs/hmcdrvfs
+hsavmcore/hsavmcore
 hyptop/hyptop
 ip_watcher/xcec-bridge
 ipl_tools/chreipl
@@ -37,16 +43,16 @@ iucvterm/test/test_afiucv
 libekmfweb/check-dep-libekmfweb
 libekmfweb/detect-openssl-version.dep
 libekmfweb/libekmfweb.so
-libutil/util_base_example
-libutil/util_file_example
-libutil/util_libc_example
-libutil/util_opt_command_example
-libutil/util_opt_example
-libutil/util_panic_example
-libutil/util_path_example
-libutil/util_prg_example
-libutil/util_rec_example
-libutil/util_scandir_example
+libekmfweb/libekmfweb.so.1
+libekmfweb/libekmfweb.so.1.0
+libkmipclient/check-dep-libkmipclient
+libkmipclient/detect-openssl-version.dep
+libkmipclient/libkmipclient.so
+libkmipclient/libkmipclient.so.1
+libkmipclient/libkmipclient.so.1.0
+libseckey/check-dep-libseckey
+libseckey/detect-openssl-version.dep
+libutil/*_example
 libvmcp/vmcp_example
 libzds/libzds.a
 lsstp/lsstp
@@ -97,7 +103,10 @@ zipl/src/zipl_helper.device-mapper
 zkey/check-dep-zkey
 zkey/check-dep-zkey-cryptsetup
 zkey/detect-libcryptsetup.dep
+zkey/ekmfweb/libekmfweb.dep
 zkey/ekmfweb/zkey-ekmfweb.so
+zkey/kmip/libkmipclient.dep
+zkey/kmip/zkey-kmip.so
 zkey/zkey
 zkey/zkey-cryptsetup
 zpcictl/zpcictl

AUTHORS.md

@@ -9,12 +9,14 @@ List of all individuals having contributed content to s390-tools
 - Arnd Bergmann
 - Axel Wirbser
 - Benjamin Block
+- Brian C. Lane
 - Carsten Otte
 - Christian Borntraeger
 - Christian Ehrhardt
 - Christof Schmitt
 - Claudio Imbrenda
 - Clemens von Mann
+- Colin Walters
 - Dan Horak
 - Despina Papadopoulou
 - Dimitri John Ledkov
@@ -25,6 +27,7 @@ List of all individuals having contributed content to s390-tools
 - Erwin Vicari
 - Eugene Crosser
 - Eugene Dvurechenski
+- Fabrice Fontaine
 - Farhan Ali
 - Fedor Loshakov
 - Felix Beck
@@ -55,6 +58,7 @@ List of all individuals having contributed content to s390-tools
 - Jean-Baptiste Joret
 - Jens Remus
 - Jochen Roehrig
+- Joern Siglen
 - Juergen Christ
 - Julian Wiedmann
 - Karsten Graul
@@ -62,6 +66,7 @@ List of all individuals having contributed content to s390-tools
 - Klaus-Dieter Wacker
 - Lakhvich Dmitriy
 - Marc Hartmayer
+- Mario Held
 - Mark Dettinger
 - Mark Post
 - Martin Kammerer
@@ -75,11 +80,13 @@ List of all individuals having contributed content to s390-tools
 - Michael Mueller
 - Mijo Safradin
 - Mikhail Zaslonko
+- Nikita Dubrovskii
 - Niklas Schnelle
 - Peter Oberparleiter
 - Peter Tiedemann
 - Philipp Kern
 - Philipp Rudo
+- Prashanth Sundararaman
 - Rafael Fonseca
 - Raimund Schroeder
 - Ralph Wuerthner
@@ -109,7 +116,10 @@ List of all individuals having contributed content to s390-tools
 - Tuan Hoang
 - Ursula Braun
 - Utz Bacher
+- Vance Morris
 - Vasily Gorbik
 - Viktor Mihajlovski
+- Vineeth Vijayan
 - Volker Sameske
+- Wenjia Zhang
 - Wolfgang Taphorn

CHANGELOG.md

@@ -1,5 +1,82 @@
 Release history for s390-tools (MIT version)
 --------------------------------------------
+* __v2.17.0 (2021-07-07)__
+
+  For Linux kernel version: 5.12 / 5.13
+
+  Add new tools / libraries:
+  - hsavmcore: New utility to make the dump process with kdump more efficient
+  - libkmipclient: Add KMIP client shared library
+  - libseckey: Add a secure key library
+  - lshwc: New tool to extract and list complete counter sets
+
+  Changes of existing tools:
+  - genprotimg: Add '--(enable|disable)-pckmo' options
+  - genprotimg: Add OpenSSL 3.0 support
+  - genprotimg: Change plaintext control flags defaults so PCKMO functions are allowed
+  - libutil: Introduce multi-level message logging (util_log)
+  - libutil: Introduce util_arch module
+  - udev/dasd: Change DASD udev-rule to set none scheduler
+  - zdsfs: Add transparent codepage conversion
+  - zkey: Add support for KMIP-based key management systems
+
+  Bug Fixes:
+  - ttyrun-getty: Avoid conflicts with serial-getty@
+  - dbginfo: add /proc/kallsyms - refresh zVM, lscpu - fix WORKARCHIVE handling
+  - dbginfo: add KVM data collection for server and guest - fix lszdev
+  - genprotimg: Add missing return values in error paths
+  - zkey: Fix conversion of CCA DATA keys to CCA CIPHER keys
+  - znetconf: avoid conflict with "chzdev -e"
+
+* __v2.16.0 (2021-02-19)__
+
+  For Linux kernel version: 5.10 / 5.11
+
+  Add new tool:
+  - hsci: New tool to manage HSCI (HiperSockets Converged Interfaces)
+
+  Changes of existing tools:
+  - genprotimg: Add host-key document verification support
+  - genprotimg: boot: Make boot loader -march=z900 compatible
+  - libekmfweb: Make install directory for shared libraries configurable
+  - lsdasd: Add FC Endpoint Security information
+  - make: Add address sanitizer support
+  - netboot: Add version information to scripts
+  - netboot: Bump busybox version in pxelinux.0 build
+  - zdev: Add FC Endpoint Security information for DASD devices
+  - zdev: Add build option to update initial RAM-disk by default
+  - zkey-ekmfweb: Avoid sequence number clash when generating keys
+  - zkey/zkey-ekmfweb: Install KMS plugins into configurable location
+  - zkey: Add support to store LUKS2 dummy passphrase in key repository
+
+  Bug Fixes:
+  - dasdfmt: Fix segfault when an incorrect option is specified
+  - genprotimg: Fix several build issues
+  - genprotimg: Require argument for 'ramdisk' and 'parmfile' options
+  - zcryptstats: Fix handling of partial results with many domains
+  - zfcpdbf: Deal with crash 7.2.9 change in caller name formatting
+  - zipl/boot: Fix memory use after free in stage2
+  - zipl/boot: Fix potential heap overflow in stage2
+  - zipl: Fix reading 4k disk's geometry
+
+* __v2.15.1 (2020-10-28)__
+
+  For Linux kernel version: 5.9
+
+  Changes of existing tools:
+  - lsstp: Improve wording and fix typos in man page
+  - zkey: Ensure zkey and friends are skipped with HAVE_OPENSSL=0
+  - zkey: Add library versioning for libekmfweb and zkey-ekmfweb
+  - libutil: Add function to determine base device of a partition block device
+
+  Bug Fixes:
+  - dasdfmt: Fix bad file descriptor error when running on symlinks
+  - libdasd: Fix dasd_get_host_access_count()
+  - zipl: Fix multivolume dump
+  - zgetdump: Fix device node determination via sysfs to work with multivolume again
+  - genprotimg/boot: Fix build by disabling SSP
+  - zipl/boot: Fix build by disabling SSP
+
 * __v2.15.0 (2020-10-15)__
 
   For Linux kernel version: 5.9

CONTRIBUTING.md

@@ -72,7 +72,7 @@ In the examples below we use this fictive identity:
 ### Setup GitHub and local git
 
 1. Create a fork of this repository by clicking the `Fork` button on the top
-   right of the [s390-tools](https://github.com/ibm-s390-tools/s390-tools)
+   right of the [s390-tools](https://github.com/ibm-s390-linux/s390-tools)
    main page
 
 2. Clone your forked repository to your local development system
@@ -84,7 +84,7 @@ In the examples below we use this fictive identity:
    s390-tools repository on GitHub
    ```
    $ cd s390-tools
-   ~/s390-tools $ git remote add upstream https://github.com/ibm-s390-tools/s390-tools.git
+   ~/s390-tools $ git remote add upstream https://github.com/ibm-s390-linux/s390-tools.git
    ```
 
 4. Verify your remotes
@@ -92,8 +92,8 @@ In the examples below we use this fictive identity:
    ~/s390-tools $ git remote -v
    origin  https://github.com/random-developer/s390-tools.git (fetch)
    origin  https://github.com/random-developer/s390-tools.git (push)
-   upstream        https://github.com/ibm-s390-tools/s390-tools.git (fetch)
-   upstream        https://github.com/ibm-s390-tools/s390-tools.git (push)
+   upstream        https://github.com/ibm-s390-linux/s390-tools.git (fetch)
+   upstream        https://github.com/ibm-s390-linux/s390-tools.git (push)
    ```
    You now have two remotes: The "origin" remote points to your fork
    and the "upstream" remote to the official s390-tools repository.

Makefile

@@ -3,13 +3,14 @@ ARCH := $(shell uname -m | sed -e s/i.86/i386/ -e s/sun4u/sparc64/ -e s/arm.*/ar
 # Include common definitions
 include common.mak
 
-LIB_DIRS = libvtoc libutil libzds libdasd libvmdump libccw libvmcp libekmfweb
+LIB_DIRS = libvtoc libutil libzds libdasd libvmdump libccw libvmcp libekmfweb \
+	   libseckey libkmipclient
 TOOL_DIRS = zipl zdump fdasd dasdfmt dasdview tunedasd \
 	   tape390 osasnmpd qetharp ip_watcher qethconf scripts zconf \
 	   vmconvert vmcp man mon_tools dasdinfo vmur cpuplugd ipl_tools \
 	   ziomon iucvterm hyptop cmsfs-fuse qethqoat zfcpdump zdsfs cpumf \
 	   systemd hmcdrvfs cpacfstats zdev dump2tar zkey netboot etc zpcictl \
-	   genprotimg lsstp
+	   genprotimg lsstp hsci hsavmcore
 
 SUB_DIRS = $(LIB_DIRS) $(TOOL_DIRS)
 

README.md

@@ -223,7 +223,8 @@ Package contents
  * CPU-measurement facilities (CPU-MF) tools:
    Use the lscpumf tool to display information about the CPU-measurement
    counter and sampling facilities.  Use the chcpumf tool to control the
-   sampling facility support.
+   sampling facility support. Use lshwc to extract complete counter sets from
+   the CPU Measurement Facilities.
 
  * cpacfstats:
    The cpacfstats tools provide a client/server application set to monitor
@@ -249,6 +250,23 @@ Package contents
    Management Foundation - Web Edition, and is used to manage keys in an
    enterprise.
 
+ * libkmipclient:
+   A shared library that provides an KMIP client to communicate with an KMIP
+   server. KMIP stands for Key Management Interoperability Protocol, and is an
+   extensible communication protocol that defines message formats for the
+   manipulation of cryptographic keys on a key management server.
+
+ * hsci:
+   Manage HiperSockets Converged Interfaces (HSCI).
+
+ * hsavmcore:
+   hsavmcore is designed to make the dump process with kdump more efficient.
+   With hsavmcore, the HSA memory that contains a part of the production
+   kernel's memory can be released early in the process. Depending on the size
+   of the production kernel's memory, writing the dump to persistent storage
+   can be time consuming and prevent the HSA memory from being reused
+   by other LPARs.
+
 For more information refer to the following publications:
 
   * "Device Drivers, Features, and Commands" chapter "Useful Linux commands"
@@ -267,24 +285,30 @@ build options:
 
 | __LIBRARY__    | __BUILD OPTION__   | __TOOLS__                             |
 |----------------|:------------------:|:-------------------------------------:|
-| fuse           | `HAVE_FUSE`        | cmsfs-fuse, zdsfs, hmcdrvfs, zgetdump |
+| fuse           | `HAVE_FUSE`        | cmsfs-fuse, zdsfs, hmcdrvfs, zgetdump,|
+|                |                    | hsavmcore                             |
 | zlib           | `HAVE_ZLIB`        | zgetdump, dump2tar                    |
 | ncurses        | `HAVE_NCURSES`     | hyptop                                |
 | pfm            | `HAVE_PFM`         | cpacfstats                            |
 | net-snmp       | `HAVE_SNMP`        | osasnmpd                              |
 | glibc-static   | `HAVE_LIBC_STATIC` | zfcpdump                              |
-| openssl        | `HAVE_OPENSSL`     | genprotimg, zkey, libekmfweb          |
+| openssl        | `HAVE_OPENSSL`     | genprotimg, zkey, libekmfweb,         |
+|                |                    | libkmipclient                         |
 | cryptsetup     | `HAVE_CRYPTSETUP2` | zkey-cryptsetup                       |
-| json-c         | `HAVE_JSONC`       | zkey-cryptsetup, libekmfweb           |
+| json-c         | `HAVE_JSONC`       | zkey-cryptsetup, libekmfweb,          |
+|                |                    | libkmipclient                         |
 | glib2          | `HAVE_GLIB2`       | genprotimg                            |
-| libcurl        | `HAVE_LIBCURL`     | libekmfweb                            |
+| libcurl        | `HAVE_LIBCURL`     | genprotimg, libekmfweb, libkmipclient |
+| libxml2        | `HAVE_LIBXML2`     | libkmipclient                         |
+| systemd        | `HAVE_SYSTEMD`     | hsavmcore                             |
 
 This table lists additional build or install options:
 
-| __COMPONENT__  | __OPTION__       | __TOOLS__                       |
-|----------------|:----------------:|:-------------------------------:|
-| dracut         | `HAVE_DRACUT`    | zdev                            |
-| initramfs-tools| `HAVE_INITRAMFS` | zdev                            |
+| __COMPONENT__    | __OPTION__                   | __TOOLS__      |
+|------------------|:----------------------------:|:--------------:|
+| dracut           | `HAVE_DRACUT`                | zdev           |
+| initramfs-tools  | `HAVE_INITRAMFS`             | zdev           |
+|                  | `ZDEV_ALWAYS_UPDATE_INITRD`  | zdev           |
 
 The s390-tools build process uses "pkg-config" if available and hard-coded
 compiler and linker options otherwise.
@@ -375,6 +399,17 @@ the different tools are provided:
   Distributors with different boot or RAM-disk mechanisms should provide
   a custom zdev-root-update helper script.
 
+  - `ZDEV_ALWAYS_UPDATE_INITRD=1` upon modification of any persistent device
+    configuration, chzdev updates the initial RAM-disk by default, without any
+    additional user interaction.
+
+  For some distributions, all the configuration attributes must be copied to
+  the initial RAM-disk. Because the device configuration directives applied
+  in the initial RAM-disk takes precedence over those stored in the root file-
+  system. This copying is done usually by explicitly invoking a command. This
+  build option makes it user-friendly and does this copying without any manual
+  intervention.
+
   Some functions of zdev require that the following programs are available:
 
   - modprobe (kmod)
@@ -412,3 +447,18 @@ the different tools are provided:
   (libcurl-devel.rpm).
   Tip: you may skip the libekmfweb build by adding `HAVE_OPENSSL=0`,
   `HAVE_JSONC=0`, or `HAVE_LIBCURL=0` to the make invocation.
+
+* hsavmcore:
+  For building the hsavmcore tool you need fuse version 2.6 and optionally
+  systemd which is enabled by default, to disable systemd support,
+  add `HAVE_SYSTEMD=0` to the make invocation.
+  Tip: you may skip the hsavmcore build by adding `HAVE_FUSE=0`
+  to the make invocation.
+
+* libkmipclient:
+  For building the libkmipclient shared library you need openssl version 1.1.1
+  or newer installed (openssl-devel.rpm). Also required are json-c version 0.13
+  or newer (json-c-devel.rpm), libxml2 version 2.9.10 or newer
+  (libxml2-devel.rpm), and libcurl version 7.59 or newer (libcurl-devel.rpm).
+  Tip: you may skip the libkmipclient build by adding `HAVE_OPENSSL=0`,
+  `HAVE_JSONC=0`, `HAVE_LIBXML2=0`, or `HAVE_LIBCURL=0` to the make invocation.

cmsfs-fuse/cmsfs-fuse.c

@@ -299,7 +299,7 @@ static unsigned long dec_to_hex(unsigned long long num)
 {
 	unsigned long res;
 
-	asm volatile("cvb %0,%1" : "=d" (res) : "m" (num));
+	asm volatile("cvb %0,%1" : "=d" (res) : "Q" (num));
 	return res & 0xffffffff;
 }
 
@@ -307,7 +307,7 @@ static unsigned int hex_to_dec(unsigned int num)
 {
 	unsigned long long res;
 
-	asm volatile("cvd %1,%0" : "=m" (res) : "d" (num));
+	asm volatile("cvd %1,%0" : "=Q" (res) : "d" (num));
 	return res & 0xffffffff;
 }
 
@@ -2050,7 +2050,7 @@ static int update_dir_levels(int blocks)
 	if (blocks < 2)
 		return 0;
 
-	while (blocks / (PTRS_PER_BLOCK + 1)) {
+	while (blocks / PTRS_PER_BLOCK) {
 		levels++;
 		blocks /= PTRS_PER_BLOCK;
 	}
@@ -3103,7 +3103,7 @@ static void update_levels(struct file *f)
 		return;
 	}
 
-	while (blocks / (per_block + 1)) {
+	while (blocks / per_block) {
 		levels++;
 		blocks /= per_block;
 	}

common.mak

@@ -5,7 +5,7 @@ COMMON_INCLUDED = true
 # The variable "DISTRELEASE" should be overwritten in rpm spec files with:
 # "make DISTRELEASE=%{release}" and "make install DISTRELEASE=%{release}"
 VERSION            = 2
-RELEASE            = 15
+RELEASE            = 17
 PATCHLEVEL         = 0
 DISTRELEASE        = build-$(shell date +%Y%m%d)
 S390_TOOLS_RELEASE = $(VERSION).$(RELEASE).$(PATCHLEVEL)-$(DISTRELEASE)
@@ -106,6 +106,25 @@ endif
 DEFAULT_CPPFLAGS = -D_GNU_SOURCE
 DEFAULT_LDFLAGS = -rdynamic
 
+ifeq ("${ASAN}","1")
+	DEFAULT_CFLAGS  += -fsanitize=address -fno-omit-frame-pointer
+	DEFAULT_LDFLAGS += -fsanitize=address
+endif
+
+#
+# Check for header prerequisite
+#
+# $1: Name of include file to check
+# $2: Additional compiler & linker options (optional)
+#
+# Returns "yes" on success and nothing otherwise
+#
+define check_header_prereq
+$(shell printf "#include <%s>\n int main(void) {return 0;}" $1 | \
+        ( $(CC) $(filter-out --coverage, $(ALL_CFLAGS)) $(ALL_CPPFLAGS) \
+                $2 -o /dev/null -xc - ) >/dev/null 2>&1 && echo -n yes)
+endef
+
 #
 # Check for build dependency
 #
@@ -163,7 +182,7 @@ USRSBINDIR      = $(INSTALLDIR)/usr/sbin
 USRBINDIR       = $(INSTALLDIR)/usr/bin
 BINDIR          = $(INSTALLDIR)/sbin
 LIBDIR          = $(INSTALLDIR)/lib
-LIB64DIR        = $(INSTALLDIR)/lib64
+USRLIB64DIR     = $(INSTALLDIR)/usr/lib64
 SYSCONFDIR      = $(INSTALLDIR)/etc
 MANDIR          = $(INSTALLDIR)/usr/share/man
 VARDIR          = $(INSTALLDIR)/var
@@ -174,15 +193,23 @@ ZFCPDUMP_DIR    = $(TOOLS_LIBDIR)/zfcpdump
 # for SYSTEMDSYSTEMUNITDIR (e.g. /lib/systemd/system)
 SYSTEMDSYSTEMUNITDIR =
 USRINCLUDEDIR   = $(INSTALLDIR)/usr/include
+ZKEYKMSPLUGINDIR = $(USRLIB64DIR)/zkey
+
+ifeq ($(LIBDIR),$(INSTALLDIR)/lib)
+SOINSTALLDIR = $(USRLIB64DIR)
+else
+SOINSTALLDIR = $(LIBDIR)
+endif
 
 INSTDIRS        = $(USRSBINDIR) $(USRBINDIR) $(BINDIR) $(LIBDIR) $(MANDIR) \
 			$(SYSCONFDIR) $(SYSCONFDIR)/sysconfig \
 			$(TOOLS_LIBDIR) $(TOOLS_DATADIR) \
 			$(ZFCPDUMP_DIR) $(SYSTEMDSYSTEMUNITDIR) \
-			$(LIB64DIR) $(USRINCLUDEDIR)
+			$(USRLIB64DIR) $(USRINCLUDEDIR) $(ZKEYKMSPLUGINDIR) \
+			$(SOINSTALLDIR)
 OWNER           = $(shell id -un)
 GROUP		= $(shell id -gn)
-export INSTALLDIR BINDIR LIBDIR LIB64DIR MANDIR OWNER GROUP
+export INSTALLDIR BINDIR LIBDIR USRLIB64DIR MANDIR OWNER GROUP
 
 # Special defines for zfcpdump
 ZFCPDUMP_IMAGE	= zfcpdump-image
@@ -264,6 +291,7 @@ help:
 	@echo '  G=1      Build with gcov to collect code coverage data'
 	@echo '  V=1      Generate verbose build output'
 	@echo '  W=1      Build with higher warning level'
+	@echo '  ASAN=1   Build with address sanitizer'
 	@echo ''
 	@echo 'EXAMPLES'
 	@echo '  # make clean all D=1 W=1 -j'
@@ -346,6 +374,14 @@ $(rootdir)/libekmfweb/libekmfweb.so: $(rootdir)/libekmfweb
 	$(MAKE) -C $(rootdir)/libekmfweb/ libekmfweb.so
 .PHONY: $(rootdir)/libekmfweb
 
+$(rootdir)/libseckey/libseckey.a: $(rootdir)/libseckey
+	$(MAKE) -C $(rootdir)/libseckey/ libseckey.a
+.PHONY: $(rootdir)/libseckey
+
+$(rootdir)/libkmipclient/libkmipclient.so: $(rootdir)/libkmipclient
+	$(MAKE) -C $(rootdir)/libkmipclient/ libkmipclient.so
+.PHONY: $(rootdir)/libkmipclient
+
 $(rootdir)/zipl/boot/data.o:
 	$(MAKE) -C $(rootdir)/zipl/boot/ data.o
 
@@ -366,9 +402,9 @@ install: install_echo install_dirs
 clean_echo:
 	$(call echocmd,"  CLEAN   ")
 clean_gcov:
-	rm -f *.gcda *.gcno *.gcov
+	rm -f -- *.gcda *.gcno *.gcov
 clean_dep:
-	rm -f .*.o.d
+	rm -f -- .*.o.d
 
 clean: clean_echo clean_gcov clean_dep
 endif

cpumf/Makefile

@@ -1,7 +1,7 @@
 include ../common.mak
 
-BIN_FILES = lscpumf chcpumf
-MAN_FILES = lscpumf.1 chcpumf.8
+BIN_FILES = lscpumf chcpumf lshwc
+MAN_FILES = lscpumf.1 chcpumf.8 lshwc.1
 
 all: $(BIN_FILES)
 
@@ -9,6 +9,7 @@ libs =	$(rootdir)/libutil/libutil.a
 
 lscpumf: lscpumf.o $(libs)
 chcpumf: chcpumf.o $(libs)
+lshwc: lshwc.o $(libs)
 
 install: all install-man
 	$(INSTALL) -d -m 755 $(DESTDIR)$(BINDIR) $(DESTDIR)$(MANDIR)/man8

cpumf/chcpumf.c

@@ -85,20 +85,19 @@ static long parse_buffersize(char *string)
 	return bytes;
 }
 
-static int read_sfb(unsigned long *min, unsigned long *max)
+static void read_sfb(unsigned long *min, unsigned long *max)
 {
 	unsigned long cur_min_sdb, cur_max_sdb;
-	int rc = EXIT_SUCCESS;
 	FILE *fp;
 
+	if (geteuid())
+		errx(EXIT_FAILURE, "Must run as root");
 	fp = fopen(PERF_SFB_SIZE, "r");
-	if (fp == NULL) {
-		linux_error(PERF_SFB_SIZE);
-		return EXIT_FAILURE;
-	}
+	if (!fp)
+		err(EXIT_FAILURE, PERF_SFB_SIZE);
 	if (fscanf(fp, "%ld,%ld", &cur_min_sdb, &cur_max_sdb) != 2) {
-		fprintf(stderr, "Error: Can not parse file " PERF_SFB_SIZE);
-		rc = EXIT_FAILURE;
+		fclose(fp);
+		errx(EXIT_FAILURE, "Can not parse file " PERF_SFB_SIZE);
 	} else {
 		if (*min == 0)
 			*min = cur_min_sdb;
@@ -106,7 +105,9 @@ static int read_sfb(unsigned long *min, unsigned long *max)
 			*max = cur_max_sdb;
 	}
 	fclose(fp);
-	return rc;
+	if (*min >= *max)
+		errx(EXIT_FAILURE,
+		     "The specified maximum must be greater than the minimum");
 }
 
 static int write_sfb(unsigned long min, unsigned long max)
@@ -117,25 +118,23 @@ static int write_sfb(unsigned long min, unsigned long max)
 	FILE *fp;
 
 	fp = fopen(PERF_SFB_SIZE, "w");
-	if (fp == NULL) {
-		linux_error(PERF_SFB_SIZE);
-		return EXIT_FAILURE;
-	}
+	if (!fp)
+		err(EXIT_FAILURE, PERF_SFB_SIZE);
 	snprintf(text, sizeof text, "%ld,%ld", min, max);
 	len = strlen(text) + 1;
 	if (fwrite(text, 1, len, fp) != len) {
-		linux_error(PERF_SFB_SIZE);
+		warn(PERF_SFB_SIZE);
 		rc = EXIT_FAILURE;
 	}
 	if (fclose(fp)) {
-		linux_error(PERF_SFB_SIZE);
+		warn(PERF_SFB_SIZE);
 		rc = EXIT_FAILURE;
 	}
 	if (verbose && rc != EXIT_FAILURE)
-		fprintf(stderr, "Sampling buffer sizes:\n"
-				"    Minimum:%7ld sample-data-blocks\n"
-				"    Maximum:%7ld sample-data-blocks\n",
-				min, max);
+		warnx("Sampling buffer sizes:\n"
+		      "    Minimum:%7ld sample-data-blocks\n"
+		      "    Maximum:%7ld sample-data-blocks\n",
+		      min, max);
 	return rc;
 }
 
@@ -155,61 +154,44 @@ static int parse_args(int argc, char **argv)
 			exit(EXIT_SUCCESS);
 		case 'x':
 			new = parse_buffersize(optarg);
-			if (new < 1) {
-				fprintf(stderr, "The specified number(s)"
-						" are not valid\n");
-				exit(EXIT_FAILURE);
-			}
+			if (new < 1)
+				errx(EXIT_FAILURE,
+				     "The specified number(s) are not valid");
 			max_sdb = new;
 			action = 1;
 			break;
 		case 'm':
 			new = parse_buffersize(optarg);
-			if (new < 1) {
-				fprintf(stderr, "The specified number(s)"
-						" are not valid\n");
-				exit(EXIT_FAILURE);
-			}
+			if (new < 1)
+				errx(EXIT_FAILURE,
+				     "The specified number(s) are not valid");
 			min_sdb = new;
 			action = 1;
 			break;
 		case 'V':
 			verbose = 1;
 			break;
-		case '?':
-			fprintf(stderr, "One or more options are not valid\n");
-			fprintf(stderr, "Try 'chcpumf --help' for more"
-					" information\n");
+		default:
+			util_opt_print_parse_error(opt, argv);
 			exit(EXIT_FAILURE);
 		}
 	}
-	if (!action) {
-		fprintf(stderr, "You must specify a valid option\n");
-		exit(EXIT_FAILURE);
-	}
+	if (!action)
+		errx(EXIT_FAILURE, "You must specify a valid option");
 	return action;
 }
 
 int main(int argc, char **argv)
 {
-	int ret = EXIT_FAILURE;
 	struct stat sbuf;
 
 	util_prg_init(&prg);
 	util_opt_init(opt_vec, NULL);
 
 	parse_args(argc, argv);
-	if (stat(PERF_PATH PERF_SF, &sbuf) != 0) {
-		fprintf(stderr,
-			"No CPU-measurement sampling facility detected\n");
-		return ret;
-	}
-	if (read_sfb(&min_sdb, &max_sdb))
-		return ret;
-	if (min_sdb >= max_sdb) {
-		fprintf(stderr, "The specified maximum must be greater "
-				"than the minimum\n");
-		return ret;
-	}
+	if (stat(PERF_PATH PERF_SF, &sbuf))
+		errx(EXIT_FAILURE,
+		     "No CPU-measurement sampling facility detected");
+	read_sfb(&min_sdb, &max_sdb);
 	return write_sfb(min_sdb, max_sdb);
 }

cpumf/defines.h

@@ -15,9 +15,4 @@
 #define	PERF_SF		"cpum_sf"
 #define	PERF_CF		"cpum_cf"
 
-static inline void linux_error(const char *message)
-{
-	fprintf(stderr, "Error: %s: %s\n", message, strerror(errno));
-}
-
 #endif

cpumf/lscpumf.c

@@ -23,9 +23,10 @@
 
 #include <linux/perf_event.h>
 
+#include "lib/util_arch.h"
+#include "lib/util_base.h"
 #include "lib/util_opt.h"
 #include "lib/util_prg.h"
-#include "lib/util_base.h"
 
 #include "defines.h"
 
@@ -2558,24 +2559,6 @@ static struct counters cpumcf_z15_counters[] = {
 	},
 };
 
-static const char *machine_name(void)
-{
-	switch (cpumf.machine_type) {
-	case 2097:	return "IBM System z10 EC";
-	case 2098:	return "IBM System z10 BC";
-	case 2817:	return "IBM zEnterprise 196";
-	case 2818:	return "IBM zEnterprise 114";
-	case 2827:	return "IBM zEnterprise EC12";
-	case 2828:	return "IBM zEnterprise BC12";
-	case 2964:	return "IBM z13";
-	case 2965:	return "IBM z13s";
-	case 3906:	return "IBM z14";
-	case 3907:	return "IBM z14 ZR1";
-	case 8561:	return "IBM z15";
-	}
-	return "Unknown hardware model";
-}
-
 /* Return the type number of the CPU Measurement facility from the sysfs file.
  * If the type number is equal to PERF_TYPE_RAW, then the prefix is 'r' to
  * specify the raw counter number by the perf tool.
@@ -2588,13 +2571,12 @@ static int read_cpumf_type(const char *filename, const char *type)
 	FILE *fp = fopen(filename, "r");
 
 	if (fp == NULL) {
-		fprintf(stderr, "No CPU-measurement %s facility detected\n",
-			type);
+		warnx("No CPU-measurement %s facility detected", type);
 		return rc;
 	}
-	if (fscanf(fp, "%d", &nr) != 1)
-		fprintf(stderr, "Can not parse file %s\n", filename);
-	else {
+	if (fscanf(fp, "%d", &nr) != 1) {
+		warnx("Can not parse file %s", filename);
+	} else {
 		rc = EXIT_SUCCESS;
 		if (nr == PERF_TYPE_RAW)
 			strcat(prefix, "r");
@@ -2638,10 +2620,8 @@ static int parse_args(int argc, char **argv)
 		case 'C':
 			actions[ACTION_CNTALL] = true;
 			break;
-		case '?':
-			fprintf(stderr, "One or more options are not valid\n");
-			fprintf(stderr, "Try 'lscpumf --help' for more"
-				" information.\n");
+		default:
+			util_opt_print_parse_error(opt, argv);
 			exit(EXIT_FAILURE);
 		}
 	}
@@ -2684,7 +2664,7 @@ static void show_info(struct cpumf_info *p, int details)
 	struct stat sbuf;
 
 	if (!p->have_counter && !p->have_samples) {
-		fprintf(stderr, "No CPU-measurement facilities detected\n");
+		warnx("No CPU-measurement facilities detected");
 		return;
 	}
 	if (p->have_counter) {
@@ -2709,13 +2689,12 @@ static void show_info(struct cpumf_info *p, int details)
 			if (0x8000 & p->authorization)
 				printf("    Coprocessor Group counter Set\n");
 			printf("\nLinux perf event support: %s\n\n",
-				(stat(PERF_PATH PERF_CF, &sbuf) != 0) ? "No" :
+				(stat(PERF_PATH PERF_CF, &sbuf)) ? "No" :
 				"Yes (PMU: " PERF_CF ")");
 
 		}
 	} else
-		fprintf(stderr,
-			"No CPU-measurement counter facility detected\n");
+		warnx("No CPU-measurement counter facility detected");
 	if (p->have_samples) {
 		unsigned long total, fdiag;
 		char text[32];
@@ -2739,7 +2718,7 @@ static void show_info(struct cpumf_info *p, int details)
 			       p->diag_sample_sz);
 
 			printf("\nLinux perf event support: %s\n\n",
-				(stat(PERF_PATH PERF_SF, &sbuf) != 0) ? "No" :
+				(stat(PERF_PATH PERF_SF, &sbuf)) ? "No" :
 				"Yes (PMU: " PERF_SF ")");
 
 			printf("Current sampling buffer settings for %s:\n",
@@ -2773,40 +2752,7 @@ static void show_info(struct cpumf_info *p, int details)
 			printf("        Size factor: %2ld\n", fdiag);
 		}
 	} else
-		fprintf(stderr,
-			"No CPU-measurement sampling facility detected\n");
-}
-
-/* Funktion to read machine type */
-#define	SYSINFO		"/proc/sysinfo"
-#define	MACH_TYPE	"Type:"
-
-static int read_machine(unsigned short *mt)
-{
-	int rc = EXIT_FAILURE;
-	char *linep = NULL;
-	size_t line_sz;
-	ssize_t nbytes;
-	FILE *fp;
-
-	fp = fopen(SYSINFO, "r");
-	if (fp == NULL) {
-		linux_error(SYSINFO);
-		return rc;
-	}
-	while ((nbytes = getline(&linep, &line_sz, fp)) != EOF) {
-		if (!strncmp(linep, MACH_TYPE, sizeof MACH_TYPE - 1)) {
-			int rc_scan = sscanf(linep, MACH_TYPE "%hd", mt);
-			if (rc_scan != 1)
-				fprintf(stderr, "Can not parse line %s", linep);
-			else
-				rc = EXIT_SUCCESS;
-			break;
-		}
-	}
-	fclose(fp);
-	free(linep);
-	return rc;
+		warnx("No CPU-measurement sampling facility detected");
 }
 
 /* Read CPU Measurement sampling facility device driver minimum and maximum
@@ -2814,16 +2760,16 @@ static int read_machine(unsigned short *mt)
  */
 static int read_sfb(struct cpumf_info *p)
 {
-	FILE *fp;
 	int rc = EXIT_SUCCESS;
+	FILE *fp;
 
 	fp = fopen(PERF_SFB_SIZE, "r");
-	if (fp == NULL) {
-		linux_error(PERF_SFB_SIZE);
+	if (!fp) {
+		warn(PERF_SFB_SIZE);
 		return EXIT_FAILURE;
 	}
 	if (fscanf(fp, "%d,%d", &p->min_sfb, &p->max_sfb) != 2) {
-		fprintf(stderr, "Can not parse %s\n", PERF_SFB_SIZE);
+		warnx("Can not parse %s", PERF_SFB_SIZE);
 		rc = EXIT_FAILURE;
 	}
 	fclose(fp);
@@ -2842,7 +2788,7 @@ static void read_ccerror(struct counters *cp, size_t cp_cnt)
 	char *ctrname;
 	size_t i = 0;
 
-	if (stat(CCERROR, &sbuf) == 0)
+	if (!stat(CCERROR, &sbuf))
 		ctrname = "DFLT_CCERROR";
 	else
 		ctrname = "DFLT_CCFINISH";
@@ -2865,8 +2811,8 @@ static int read_info(void)
 
 	memset(&cpumf, 0, sizeof cpumf);
 	slp = fopen(SERVICELEVEL, "r");
-	if (slp == NULL) {
-		linux_error(SERVICELEVEL);
+	if (!slp) {
+		warn(SERVICELEVEL);
 		return EXIT_FAILURE;
 	}
 
@@ -2876,7 +2822,7 @@ static int read_info(void)
 				    " version=%f authorization=%x",
 				    &cpumf.version, &cpumf.authorization);
 			if (rc != 2) {
-				fprintf(stderr, "Can not parse line %s", linep);
+				warnx("Can not parse line %s", linep);
 				rc = EXIT_FAILURE;
 				goto out;
 			}
@@ -2890,7 +2836,7 @@ static int read_info(void)
 				    &cpumf.min_rate, &cpumf.max_rate,
 				    &cpumf.cpu_speed);
 			if (rc != 3) {
-				fprintf(stderr, "Can not parse line %s", linep);
+				warnx("Can not parse line %s", linep);
 				rc = EXIT_FAILURE;
 				goto out;
 			}
@@ -2901,7 +2847,7 @@ static int read_info(void)
 				    " mode=basic sample_size=%u",
 				    &cpumf.basic_sample_sz);
 			if (rc != 1) {
-				fprintf(stderr, "Can not parse line %s", linep);
+				warnx("Can not parse line %s", linep);
 				rc = EXIT_FAILURE;
 				goto out;
 			}
@@ -2911,7 +2857,7 @@ static int read_info(void)
 				    " mode=diagnostic sample_size=%u",
 				    &cpumf.diag_sample_sz);
 			if (rc != 1) {
-				fprintf(stderr, "Can not parse line %s", linep);
+				warnx("Can not parse line %s", linep);
 				rc = EXIT_FAILURE;
 				goto out;
 			}
@@ -2922,9 +2868,11 @@ static int read_info(void)
 		if (rc == EXIT_FAILURE)
 			goto out;
 	}
-	rc = read_machine(&cpumf.machine_type);
-	if (rc == EXIT_FAILURE)
+	cpumf.machine_type = util_arch_machine_type();
+	if (cpumf.machine_type == UTIL_ARCH_MACHINE_TYPE_UNKNOWN) {
+		rc = EXIT_FAILURE;
 		goto out;
+	}
 	rc = EXIT_SUCCESS;
 out:
 	fclose(slp);
@@ -3012,33 +2960,33 @@ static struct counters *get_counter(int ctrset, size_t *len)
 		break;
 	case CPUMF_CTRSET_EXTENDED:
 		switch (cpumf.machine_type) {
-		case 2097:
-		case 2098:
+		case UTIL_ARCH_MACHINE_TYPE_Z10_EC:
+		case UTIL_ARCH_MACHINE_TYPE_Z10_BC:
 			cp = cpumcf_z10_counters;
 			*len = ARRAY_SIZE(cpumcf_z10_counters);
 			break;
-		case 2817:
-		case 2818:
+		case UTIL_ARCH_MACHINE_TYPE_ZE_196:
+		case UTIL_ARCH_MACHINE_TYPE_ZE_114:
 			cp = cpumcf_z196_counters;
 			*len = ARRAY_SIZE(cpumcf_z196_counters);
 			break;
-		case 2827:
-		case 2828:
+		case UTIL_ARCH_MACHINE_TYPE_ZE_EC12:
+		case UTIL_ARCH_MACHINE_TYPE_ZE_BC12:
 			cp = cpumcf_zec12_counters;
 			*len = ARRAY_SIZE(cpumcf_zec12_counters);
 			break;
-		case 2964:
-		case 2965:
+		case UTIL_ARCH_MACHINE_TYPE_Z13:
+		case UTIL_ARCH_MACHINE_TYPE_Z13_S:
 			cp = cpumcf_z13_counters;
 			*len = ARRAY_SIZE(cpumcf_z13_counters);
 			break;
-		case 3906:
-		case 3907:
+		case UTIL_ARCH_MACHINE_TYPE_Z14:
+		case UTIL_ARCH_MACHINE_TYPE_Z14_ZR1:
 			cp = cpumcf_z14_counters;
 			*len = ARRAY_SIZE(cpumcf_z14_counters);
 			break;
-		case 8561:
-		case 8562:
+		case UTIL_ARCH_MACHINE_TYPE_Z15:
+		case UTIL_ARCH_MACHINE_TYPE_Z15_T02:
 			cp = cpumcf_z15_counters;
 			*len = ARRAY_SIZE(cpumcf_z15_counters);
 			read_ccerror(cp, *len);
@@ -3073,7 +3021,8 @@ static void show_counter(bool all)
 	struct counters *cp;
 	size_t cp_cnt;
 
-	printf("perf event counter list for %s\n", machine_name());
+	printf("perf event counter list for %s\n",
+	       util_arch_machine_type_str());
 	show_hdr();
 	/* Basic counter set */
 	cp = get_counter(CPUMF_CTRSET_BASIC, &cp_cnt);
@@ -3094,11 +3043,11 @@ int main(int argc, char **argv)
 	util_prg_init(&prg);
 	util_opt_init(opt_vec, NULL);
 
-	ret = read_info();
-	if (ret == EXIT_FAILURE)
-		return ret;
+	ret = parse_args(argc, argv);
+	if (read_info() == EXIT_FAILURE)
+		return EXIT_FAILURE;
 
-	switch ((ret = parse_args(argc, argv))) {
+	switch (ret) {
 	case ACTION_CNT:
 	case ACTION_CNTALL:
 		all = ret == ACTION_CNTALL;
@@ -3114,6 +3063,7 @@ int main(int argc, char **argv)
 	case ACTION_NONE:
 	case ACTION_INFO:
 		show_info(&cpumf, ret == ACTION_INFO);
+		ret = EXIT_SUCCESS;
 		break;
 	}
 	return ret;

cpumf/lshwc.c

@@ -0,0 +1,775 @@
+/* Copyright IBM Corp. 2021
+ *
+ * s390-tools is free software; you can redistribute it and/or modify
+ * it under the terms of the MIT license. See LICENSE for details.
+ */
+
+/* CPU Measurements counter facility counter sets can be extracted by a
+ * device driver accessible by opening device /dev/hwctr.
+ * This program extracts complete counter set using this device.
+ * Counter sets are per CPU, the interface allows to specify counter sets
+ * for individual CPUs.  The supported flags are executed from left to
+ * right, the first error encountered stops the execution of the program.
+ */
+
+#include <ctype.h>
+#include <dirent.h>
+#include <err.h>
+#include <errno.h>
+#include <fcntl.h>
+#include <linux/limits.h>
+#include <stdarg.h>
+#include <stdbool.h>
+#include <stdint.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <sys/ioctl.h>
+#include <sys/stat.h>
+#include <sys/time.h>
+#include <sys/user.h>
+#include <time.h>
+#include <unistd.h>
+
+#include "lib/util_opt.h"
+#include "lib/util_prg.h"
+#include "lib/util_base.h"
+#include "lib/util_path.h"
+#include "lib/util_scandir.h"
+#include "lib/util_libc.h"
+
+#include "lshwc.h"
+
+#define SERVICELEVEL	"/proc/service_levels"
+#define CPUS_ONLINE	"/sys/devices/system/cpu/online"
+#define CPUS_POSSIBLE	"/sys/devices/system/cpu/possible"
+#define CPUS_KERNELMAX	"/sys/devices/system/cpu/kernel_max"
+#define MAXCTRS		512
+
+static const unsigned int ioctlsleep = 60;
+static unsigned int read_interval = ioctlsleep, cfvn, csvn, authorization;
+static unsigned long loop_count = 1;
+static unsigned char *ioctlbuffer;
+static bool allcpu;
+
+static unsigned int max_possible_cpus;	/* No of possible CPUs */
+struct ctrname {		/* List of defined counters */
+	char *name;		/* Counter name */
+	bool hitcnt;		/* Counter number read from ioctl() */
+	unsigned long total;	/* Total counter value */
+	unsigned long *ccv;	/* Per CPU counter value */
+} ctrname[MAXCTRS];
+
+/* Open file and extract counter number */
+static int read_counter(const char *p)
+{
+	FILE *fp = fopen(p, "r");
+	int rc = 0, ctr;
+
+	if (fp) {
+		rc = fscanf(fp, "event=%x", &ctr);
+		fclose(fp);
+	}
+	return rc == 1 ? ctr : -EINVAL;
+}
+
+static int add_countername(char *name, int nr)
+{
+	ctrname[nr].name = strdup(name);
+	return ctrname[nr].name ? 0 : -ENOMEM;
+}
+
+static bool read_counternames(void)
+{
+	struct dirent **namelist = NULL;
+	int i, ctr = 0, count = 0;
+	char *path, *ctrpath;
+
+	path = util_path_sysfs("/bus/event_source/devices/cpum_cf/events/");
+	count = util_scandir(&namelist, alphasort, path, "[^.]");
+	if (count <= 0) {
+		warnx("Cannot open %s", path);
+		free(path);
+		return false;
+	}
+	for (i = 0; i < count && ctr >= 0; i++) {
+		util_asprintf(&ctrpath, "%s/%s", path, namelist[i]->d_name);
+		ctr = read_counter(ctrpath);
+		free(ctrpath);
+		if (ctr >= 0)
+			ctr = add_countername(namelist[i]->d_name, ctr);
+	}
+	if (ctr < 0)
+		warnx("Cannot parse %s", path);
+	util_scandir_free(namelist, count);
+	free(path);
+	return ctr < 0 ? false : true;
+}
+
+static void free_counternames(void)
+{
+	for (size_t i = 0; i < ARRAY_SIZE(ctrname); ++i) {
+		free(ctrname[i].name);
+		free(ctrname[i].ccv);
+	}
+}
+
+static struct check_result {
+	bool cpu_pos;			/* CPU Number possible */
+	bool cpu_req;			/* CPU Number requested */
+	bool cpu_hit;			/* CPU Number received */
+	unsigned char sets_req;		/* Counters sets requested */
+	unsigned char sets_hit;		/* Counters sets received */
+} *check;
+
+static bool check_set(unsigned long a, unsigned long b, unsigned long sets)
+{
+	if (a > b)
+		return false;
+	for (; a <= b; ++a) {
+		if (a >= max_possible_cpus || !check[a].cpu_pos)
+			return false;
+		check[a].cpu_req = true;
+		check[a].sets_req = sets;
+	}
+	return true;
+}
+
+/*
+ * Functions to parse command line parameters
+ * Convert a number from ascii to int.
+ */
+static unsigned long getnumber(char *word, char stopchar)
+{
+	unsigned long no;
+	char *endp;
+
+	no = strtoul(word, &endp, 0);
+	if (*endp != stopchar)
+		errx(EXIT_FAILURE, "Invalid parameter %s", word);
+	return no;
+}
+
+/* Remove all whitespace from string.  */
+static void kill_whitespace(char *s)
+{
+	char *cp = s;
+
+	for (; *s != '\0'; ++s) {
+		if (isspace(*s))
+			continue;
+		if (isprint(*s))
+			*cp++ = *s;
+	}
+	*cp = '\0';
+}
+
+/* Read file to get all online CPUs */
+static bool get_cpus(char *file, char *buf, size_t bufsz)
+{
+	char fmt[16];
+	FILE *slp;
+	int rc;
+
+	slp = fopen(file, "r");
+	if (!slp) {
+		warnx("Cannot open %s", file);
+		return false;
+	}
+	snprintf(fmt, sizeof(fmt), "%%%zus", bufsz - 1);
+	rc = fscanf(slp, fmt, buf);
+	fclose(slp);
+	if (rc != 1)
+		warnx("Cannot parse %s", file);
+	return rc == 1 ? true : false;
+}
+
+/* Parse counter set specification */
+static unsigned long parse_ctrset(char *cp)
+{
+	unsigned long x = 0;
+
+	for (; *cp; ++cp) {
+		switch (tolower(*cp)) {
+		case 'b':
+			x |= S390_HWCTR_BASIC;
+			break;
+		case 'c':
+			x |= S390_HWCTR_CRYPTO;
+			break;
+		case 'e':
+			x |= S390_HWCTR_EXT;
+			break;
+		case 'm':
+			x |= S390_HWCTR_MT_DIAG;
+			break;
+		case 'p':
+		case 'u':
+			x |= S390_HWCTR_USER;
+			break;
+		case 'a':
+			x |= S390_HWCTR_ALL;
+			break;
+		default:
+			errx(EXIT_FAILURE,
+			     "Invalid counter set specification '%c'", *cp);
+		}
+	}
+	return x;
+}
+
+static char *show_ctrset(unsigned long set)
+{
+	static char text[16];
+	int i = 0;
+
+	if (set & S390_HWCTR_BASIC)
+		text[i++] = 'B';
+	if (set & S390_HWCTR_CRYPTO)
+		text[i++] = 'C';
+	if (set & S390_HWCTR_EXT)
+		text[i++] = 'E';
+	if (set & S390_HWCTR_MT_DIAG)
+		text[i++] = 'M';
+	if (set & S390_HWCTR_USER)
+		text[i++] = 'U';
+	text[i] = '\0';
+	return text;
+}
+
+/* Parse CPU list and counter sets */
+static void parse_cpulist(char *parm, struct s390_hwctr_start *start)
+{
+	__u64 *words = start->cpumask;
+	unsigned long i, no_a, no_b;
+	char *cp, *tokens[16];		/* Used to parse command line params */
+	char cpubuf[256];
+
+	start->data_bytes = 0;
+	if (parm)
+		kill_whitespace(parm);
+	if (!parm || *parm == ':') {
+		/* No CPU list or just counter sets */
+		if (!get_cpus(CPUS_ONLINE, cpubuf, sizeof(cpubuf)))
+			exit(EXIT_FAILURE);
+		if (parm)
+			strcat(cpubuf, parm);
+		parm = cpubuf;
+	}
+
+	cp = strchr(parm, ':');
+	if (cp) {		/* Handle counter set */
+		*cp = '\0';
+		start->counter_sets = parse_ctrset(++cp);
+	} else {
+		start->counter_sets = S390_HWCTR_ALL;
+	}
+	/* Check with authorized counter sets */
+	if ((start->counter_sets & authorization) != start->counter_sets) {
+		unsigned int noton = ~(start->counter_sets & authorization);
+
+		start->counter_sets &= authorization;
+		if (!start->counter_sets)
+			errx(EXIT_FAILURE, "No counter sets are authorized");
+		warnx("One or more counter sets are not authorized: %s",
+		      show_ctrset(noton));
+	}
+
+	for (i = 0; i < ARRAY_SIZE(tokens) && (tokens[i] = strtok(parm, ",")) != 0;
+	    ++i, parm = 0) {
+		cp = strchr(tokens[i], '-');	/* Range character? */
+		if (cp) {
+			no_a = getnumber(tokens[i], *cp);
+			no_b = getnumber(++cp, '\0');
+		} else {
+			no_b = getnumber(tokens[i], '\0');
+			no_a = no_b;
+		}
+		if (!check_set(no_a, no_b, start->counter_sets))
+			errx(EXIT_FAILURE, "Invalid CPU list %s", tokens[i]);
+	}
+
+	/* Convert the CPU list to a bitmask for kernel cpumask_t */
+	for (i = 0, no_b = 0; i < max_possible_cpus; ++i) {
+		if (check[i].cpu_req) {
+			no_a = i % __BITS_PER_LONG;
+			no_b = i / __BITS_PER_LONG;
+			words[no_b] |= 1ULL << no_a;
+		}
+	}
+	/* no_b is highest used index, swap array */
+	start->cpumask_len = (no_b + 1) * 8;
+	for (no_a = 0; no_a < no_b; ++no_a, --no_b) {
+		__u64 tmp =  words[no_a];
+
+		words[no_a] = words[no_b];
+		words[no_b] = tmp;
+	}
+	start->version = S390_HWCTR_START_VERSION;
+}
+
+static bool check_setpossible(void)
+{
+	char *cp, *parm, *tokens[16];	/* Used to parse command line params */
+	unsigned long i, no_a, no_b;
+	char cpubuf[1024];
+
+	if (!get_cpus(CPUS_KERNELMAX, cpubuf, sizeof(cpubuf)))
+		return false;
+	max_possible_cpus = getnumber(cpubuf, '\0') + 1;
+	check = calloc(max_possible_cpus, sizeof(*check));
+	if (!check)
+		err(EXIT_FAILURE, "Maximum CPUs %u", max_possible_cpus);
+	if (!get_cpus(CPUS_POSSIBLE, cpubuf, sizeof(cpubuf))) {
+		free(check);
+		return false;
+	}
+	parm = cpubuf;
+	for (i = 0; i < ARRAY_SIZE(tokens) && (tokens[i] = strtok(parm, ","));
+							++i, parm = 0) {
+		cp = strchr(tokens[i], '-');
+		if (cp) {		/* Range */
+			no_a = getnumber(tokens[i], *cp);
+			no_b = getnumber(++cp, '\0');
+		} else {
+			no_b = getnumber(tokens[i], '\0');
+			no_a = no_b;
+		}
+		for (; no_a <= no_b; ++no_a)
+			check[no_a].cpu_pos = true;
+	}
+	return true;
+}
+
+static void show_header(void)
+{
+	static bool header;
+	bool comma = false;
+
+	if (header)
+		return;			/* Printed already */
+	printf("Date,Time,CPU,");	/* Print counter name and number */
+	for (size_t i = 0; i < ARRAY_SIZE(ctrname); ++i) {
+		if (!ctrname[i].hitcnt)
+			continue;
+		if (comma)
+			putchar(',');
+		printf("%s(%ld)", ctrname[i].name ?: "Counter", i);
+		comma = true;
+	}
+	putchar('\n');
+	header = true;
+}
+
+static void line(char *header)
+{
+	bool comma;
+
+	show_header();
+	if (allcpu) {
+		for (unsigned int h = 0; h < max_possible_cpus; ++h) {
+			char txt[16];
+
+			if (!check[h].cpu_hit)
+				continue;
+			comma = false;
+			snprintf(txt, sizeof(txt), "CPU%d,", h);
+			printf("%s%s", header, txt);
+			for (size_t i = 0; i < ARRAY_SIZE(ctrname); ++i) {
+				if (!ctrname[i].hitcnt)
+					continue;
+				if (comma)
+					putchar(',');
+				printf("%ld", ctrname[i].ccv[h]);
+				comma = true;
+			}
+			putchar('\n');
+		}
+	}
+
+	/* Print total count of all CPUs */
+	printf("%sTotal,", header);
+	comma = false;
+	for (size_t i = 0; i < ARRAY_SIZE(ctrname); ++i) {
+		if (!ctrname[i].hitcnt)
+			continue;
+		if (comma)
+			putchar(',');
+		printf("%ld", ctrname[i].total);
+		comma = true;
+	}
+	putchar('\n');
+}
+
+static void show(void)
+{
+	time_t now = time(NULL);
+	struct tm *now_tm;
+	char now_text[32];
+
+	now_tm = localtime(&now);
+	strftime(now_text, sizeof(now_text), "%F,%T,", now_tm);
+	line(now_text);
+}
+
+/* Return Counter set size numbers (in counters) */
+static unsigned int ctrset_size(int set)
+{
+	switch (set) {
+	case S390_HWCTR_BASIC:
+		return 6;
+	case S390_HWCTR_USER:
+		return (cfvn == 1) ? 6 : 2;
+	case S390_HWCTR_CRYPTO:
+		return (csvn <= 5) ? 16 : 20;
+	case S390_HWCTR_EXT:
+		switch (csvn) {
+		case 1:	return 32;
+		case 2:	return 48;
+		case 3:
+		case 4:
+		case 5: return 128;
+		}
+		return 160;
+	case S390_HWCTR_MT_DIAG:
+		switch (csvn) {
+		case 1:
+		case 2:
+		case 3:	return 0;
+		}
+		return 48;
+	}
+	return 0;
+}
+
+/* Return counter set offset numbers */
+static int ctrset_offset(int set)
+{
+	switch (set) {
+	case S390_HWCTR_BASIC:
+		return 0;
+	case S390_HWCTR_USER:
+		return 32;
+	case S390_HWCTR_CRYPTO:
+		return 64;
+	case S390_HWCTR_EXT:
+		return 128;
+	case S390_HWCTR_MT_DIAG:
+		return 448;
+	}
+	return 0;
+}
+
+static bool set_and_size_ok(struct s390_hwctr_setdata *p)
+{
+	switch (p->set) {
+	case S390_HWCTR_BASIC:
+	case S390_HWCTR_USER:
+	case S390_HWCTR_CRYPTO:
+	case S390_HWCTR_EXT:
+	case S390_HWCTR_MT_DIAG:
+		return p->no_cnts == ctrset_size(p->set);
+	}
+	return false;
+}
+
+static bool add_countervalue(size_t idx, unsigned int cpu, unsigned long value)
+{
+	if (idx >= ARRAY_SIZE(ctrname)) {
+		warnx("Invalid counter number %zu", idx);
+		return false;
+	}
+	if (cpu >= max_possible_cpus) {
+		warnx("Invalid CPU number %d", cpu);
+		return false;
+	}
+	if (!ctrname[idx].ccv)		/* Unknown counter */
+		ctrname[idx].ccv = calloc(max_possible_cpus,
+					  sizeof(unsigned long));
+	if (ctrname[idx].ccv)
+		ctrname[idx].ccv[cpu] += value;
+	ctrname[idx].total += value;
+	ctrname[idx].hitcnt = true;
+	return true;
+}
+
+static int test_read(struct s390_hwctr_read *read)
+{
+	void *base = &read->data;
+	size_t offset = 0;
+
+	/* Clear previous hit counters */
+	for (unsigned int i = 0; i < max_possible_cpus; ++i) {
+		check[i].sets_hit = 0;
+		check[i].cpu_hit = false;
+	}
+
+	/* Iterate over all CPUs */
+	for (unsigned int i = 0; i < read->no_cpus; ++i) {
+		struct s390_hwctr_cpudata *cp = base + offset;
+
+		check[cp->cpu_nr].cpu_hit = true;
+		check[cp->cpu_nr].sets_hit = 0;
+
+		offset += sizeof(cp->cpu_nr) + sizeof(cp->no_sets);
+		/* Iterate over all counter sets */
+		for (unsigned int j = 0; j < cp->no_sets; ++j) {
+			struct s390_hwctr_setdata *sp = base + offset;
+
+			check[cp->cpu_nr].sets_hit |= sp->set;
+			offset += sizeof(sp->set) + sizeof(sp->no_cnts);
+			if (!set_and_size_ok(sp)) {
+				warnx("CPU %d inconsistent set %d size %d",
+				      cp->cpu_nr, sp->set, sp->no_cnts);
+				return -1;
+			}
+			/* Iterate over all counters in each set */
+			for (unsigned int k = 0; k < sp->no_cnts; ++k) {
+				__u64 value;
+				void *addr = base + offset;
+				size_t idx = ctrset_offset(sp->set) + k;
+
+				memcpy(&value, addr, sizeof(value));
+				offset += sizeof(value);
+				if (!add_countervalue(idx, cp->cpu_nr, value))
+					return -1;
+			}
+		}
+	}
+	show();
+	return 0;
+}
+
+static int do_open(void)
+{
+	int fd = open(S390_HWCTR_DEVICE, O_RDWR);
+
+	if (fd < 0)
+		warn(S390_HWCTR_DEVICE);
+	return fd;
+}
+
+static int do_stop(int ioctlfd)
+{
+	int rc = ioctl(ioctlfd, S390_HWCTR_STOP, 0);
+
+	if (rc < 0)
+		warn("ioctl S390_HWCTR_STOP");
+	return rc;
+}
+
+static int do_start(int ioctlfd, struct s390_hwctr_start *start)
+{
+	int rc = ioctl(ioctlfd, S390_HWCTR_START, start);
+
+	if (rc < 0)
+		warn("ioctl S390_HWCTR_START");
+	return rc;
+}
+
+static int do_read(int ioctlfd)
+{
+	size_t ioctlbuffer_len = PAGE_SIZE * max_possible_cpus +
+				 sizeof(struct s390_hwctr_read);
+	struct s390_hwctr_read *read;
+	int rc;
+
+	if (!ioctlbuffer) {
+		ioctlbuffer = malloc(ioctlbuffer_len);
+		if (!ioctlbuffer) {
+			warn("ioctl S390_HWCTR_START");
+			return -ENOMEM;
+		}
+	}
+	read = (struct s390_hwctr_read *)ioctlbuffer;
+	rc = ioctl(ioctlfd, S390_HWCTR_READ, read);
+	if (!rc)
+		rc = test_read(read);
+	else
+		warn("ioctl S390_HWCTR_READ");
+	return rc;
+}
+
+static void do_sleep(void)
+{
+	struct timespec req = {
+		.tv_sec = read_interval,
+		.tv_nsec = 0
+	};
+
+	nanosleep(&req, NULL);
+}
+
+/* Execute commands and report first error */
+static int do_it(char *s)
+{
+	struct s390_hwctr_start start;
+	int ioctlfd;
+	int rc;
+
+	memset(&start, 0, sizeof(start));
+	rc = max_possible_cpus / sizeof(__u64);
+	start.cpumask = alloca(max_possible_cpus / sizeof(__u64));
+	memset(start.cpumask, 0, rc);
+	parse_cpulist(s, &start);
+	errno = 0;
+	ioctlfd = do_open();
+	if (ioctlfd  < 0)
+		return EXIT_FAILURE;
+
+	rc = do_start(ioctlfd, &start);
+	if (rc < 0) {
+		close(ioctlfd);
+		return EXIT_FAILURE;
+	}
+
+	for (unsigned long i = 0; !rc && i < loop_count; ++i) {
+		rc = do_read(ioctlfd);
+		if (rc) {
+			close(ioctlfd);
+			return EXIT_FAILURE;
+		}
+		if (read_interval && i + 1 < loop_count)
+			do_sleep();
+	}
+	rc = do_stop(ioctlfd);
+	close(ioctlfd);
+	return rc ? EXIT_FAILURE : EXIT_SUCCESS;
+}
+
+/* Read counter first and second version number */
+static bool get_cvn(void)
+{
+	char *linep = NULL;
+	bool good = false;
+	size_t line_sz;
+	ssize_t nbytes;
+	FILE *slp;
+
+	slp = fopen(SERVICELEVEL, "r");
+	if (!slp) {
+		warn(SERVICELEVEL);
+		return false;
+	}
+	while ((nbytes = getline(&linep, &line_sz, slp)) != EOF) {
+		if (!strncmp(linep, "CPU-MF: Counter facility:", 25)) {
+			int rc;
+
+			rc = sscanf(linep, "CPU-MF: Counter facility: version=%d.%d authorization=%x",
+				    &cfvn, &csvn, &authorization);
+			good = rc == 3;
+			if (!good)
+				warnx("Cannot parse line %s", linep);
+			break;
+		}
+	}
+	fclose(slp);
+	free(linep);
+	return good;
+}
+
+static struct util_opt opt_vec[] = {
+	UTIL_OPT_SECTION("OPTIONS"),
+	{
+		.option = { "all", no_argument, NULL, 'a' },
+		.desc = "Displays all CPUs in output"
+	},
+	{
+		.option = { "loop", required_argument, NULL, 'l' },
+		.argument = "NUMBER",
+		.desc = "Specifies loop count for next read"
+	},
+	{
+		.option = { "interval", required_argument, NULL, 'i' },
+		.argument = "NUMBER",
+		.desc = "Specifies interval between read operations (seconds)"
+	},
+	UTIL_OPT_HELP,
+	UTIL_OPT_VERSION,
+	UTIL_OPT_END
+};
+
+static const struct util_prg prg = {
+	.desc = "Read CPU Measurement facility counter sets",
+	.copyright_vec = {
+		{
+			.owner = "IBM Corp.",
+			.pub_first = 2021,
+			.pub_last = 2021,
+		},
+		UTIL_PRG_COPYRIGHT_END
+	}
+};
+
+/* Check for hardware support and exit if not available */
+static void have_support(void)
+{
+	struct stat statbuf;
+
+	if (stat(S390_HWCTR_DEVICE, &statbuf) == -1)
+		errx(EXIT_FAILURE,
+		     "No support for CPU Measurement Counter set facility");
+}
+
+int main(int argc, char **argv)
+{
+	char *slash;
+	int ch;
+
+	util_prg_init(&prg);
+	util_opt_init(opt_vec, NULL);
+
+	while ((ch = util_opt_getopt_long(argc, argv)) != -1) {
+		switch (ch) {
+		default:
+			util_opt_print_parse_error(ch, argv);
+			return EXIT_FAILURE;
+		case 'h':
+			util_prg_print_help();
+			util_opt_print_help();
+			return EXIT_SUCCESS;
+		case 'v':
+			util_prg_print_version();
+			return EXIT_SUCCESS;
+		case 'l':
+			errno = 0;
+			loop_count = strtoul(optarg, &slash, 0);
+			if (errno || *slash)
+				errx(EXIT_FAILURE, "Invalid argument for -%c",
+				     ch);
+			break;
+		case 'i':
+			errno = 0;
+			read_interval = (unsigned int)strtoul(optarg, &slash, 0);
+			if (errno || *slash)
+				errx(EXIT_FAILURE, "Invalid argument for -%c", ch);
+			break;
+		case 'a':
+			allcpu = true;
+			break;
+		}
+	}
+
+	have_support();
+	if (!get_cvn())
+		return EXIT_FAILURE;
+	if (!check_setpossible())
+		return EXIT_FAILURE;
+	if (!read_counternames()) {
+		free(check);
+		return EXIT_FAILURE;
+	}
+
+	if (optind >= argc) {
+		ch = do_it(NULL);
+	} else {
+		while (optind < argc) {
+			ch = do_it(argv[optind++]);
+			if (ch)
+				break;
+		}
+	}
+	free_counternames();
+	free(check);
+	return ch;
+}

cpumf/lshwc.h

@@ -0,0 +1,92 @@
+/* Copyright IBM Corp. 2021
+ *
+ * s390-tools is free software; you can redistribute it and/or modify
+ * it under the terms of the MIT license. See LICENSE for details.
+ */
+
+/*
+ * CPU Measurement counter facility application for device driver.
+ *
+ * Ioctl system call definitions.
+ */
+
+#ifndef LSHWC_H
+#define LSHWC_H
+
+#include <sys/ioctl.h>
+
+enum {
+	S390_HWCTR_BASIC = 0x2,		/* BASIC counter set */
+	S390_HWCTR_USER = 0x4,		/* Problem-State Counter Set */
+	S390_HWCTR_CRYPTO = 0x8,	/* Crypto-Activity Counter Set */
+	S390_HWCTR_EXT = 0x1,		/* Extended Counter Set */
+	S390_HWCTR_MT_DIAG = 0x20,	/* MT-diagnostic Counter Set */
+	S390_HWCTR_ALL = S390_HWCTR_BASIC | S390_HWCTR_USER |
+				S390_HWCTR_CRYPTO | S390_HWCTR_EXT |
+				S390_HWCTR_MT_DIAG
+};
+
+/* The ioctl(..., S390_HWCTR_READ, ...) is the only subcommand which returns
+ * data. It requires member data_bytes to be positive and indicates the
+ * maximum amount of data available to store counter set data. The other
+ * ioctl() subcommands do not use this member and it should be set to zero.
+ *
+ * The cpuset data is flattened using the following scheme, stored in member
+ * data:
+ *
+ * 0x0       0x8   0xc       0x10   0x14      0x18  0x20  0x28         0xU-1
+ * +---------+-----+---------+-----+---------+-----+-----+------+------+
+ * | no_cpus | cpu | no_sets | set | no_cnts | cv1 | cv2 | .... | cv_n |
+ * +---------+-----+---------+-----+---------+-----+-----+------+------+
+ *
+ *                           0xU   0xU+4     0xU+8 0xU+10             0xV-1
+ *                           +-----+---------+-----+-----+------+------+
+ *                           | set | no_cnts | cv1 | cv2 | .... | cv_n |
+ *                           +-----+---------+-----+-----+------+------+
+ *
+ *           0xV   0xV+4     0xV+8 0xV+c
+ *           +-----+---------+-----+---------+-----+-----+------+------+
+ *           | cpu | no_sets | set | no_cnts | cv1 | cv2 | .... | cv_n |
+ *           +-----+---------+-----+---------+-----+-----+------+------+
+ *
+ * U and V denote arbitrary hexadezimal addresses.
+ * In fact the first int represents the number of CPUs data was extracted
+ * from. This is followed by CPU number and number of counter sets extracted.
+ * Both are two integer values. This is followed by the set number and number
+ * of counters extracted. Both are two integer values. This is followed by
+ * the counter values, each element is eight bytes in size.
+ */
+
+struct s390_hwctr_start {		/* Set CPUs to operate on */
+	__u64 version;			/* Version of interface */
+	__u64 data_bytes;		/* # of bytes required */
+	__u64 cpumask_len;		/* Length of CPU mask in bytes */
+	__u64 *cpumask;			/* Pointer to CPU mask */
+	__u64 counter_sets;		/* Bit mask of counter set to get */
+};
+
+struct s390_hwctr_setdata {		/* Counter set data */
+	__u32 set;			/* Counter set number */
+	__u32 no_cnts;			/* # of counters stored in cv[] */
+	__u64 cv[0];			/* Counter values (variable length) */
+};
+
+struct s390_hwctr_cpudata {		/* Counter set data per CPU */
+	__u32 cpu_nr;			/* Counter set number */
+	__u32 no_sets;			/* # of counters sets in data[] */
+	struct s390_hwctr_setdata data[0];
+};
+
+struct s390_hwctr_read {		/* Structure to get all ctr sets */
+	__u64 no_cpus;			/* Total # of CPUs data taken from */
+	struct s390_hwctr_cpudata data[0];
+};
+
+#define S390_HWCTR_MAGIC	'C'	/* Random magic # for ioctls */
+#define	S390_HWCTR_START	_IOWR(S390_HWCTR_MAGIC, 1, struct s390_hwctr_start)
+#define	S390_HWCTR_STOP		_IO(S390_HWCTR_MAGIC, 2)
+#define	S390_HWCTR_READ		_IOWR(S390_HWCTR_MAGIC, 3, struct s390_hwctr_read)
+
+#define	S390_HWCTR_START_VERSION	1	/* Version # s390_hwctr_start */
+#define	S390_HWCTR_DEVICE	"/dev/hwctr"	/* Device name */
+#endif

cpumf/man/lshwc.1

@@ -0,0 +1,134 @@
+.\" lshwc.1
+.\"
+.\"
+.\" Copyright IBM Corp. 2021
+.\" s390-tools is free software; you can redistribute it and/or modify
+.\" it under the terms of the MIT license. See LICENSE for details.
+.\" ----------------------------------------------------------------------
+.ds c \fBlshwc\fP
+.
+.TH \*c "1" "February 2021" "s390-tools" "CPU-MF management programs"
+.
+.SH NAME
+\*c \- extract CPU Measurement Facilities counter sets
+.
+.SH SYNOPSIS
+\*c
+.RB [ \-a ]
+.RB [ \-l
+.IR count ]
+.RB [ \-i
+.IR interval ]
+\fR[\fIcpulist\fR][:\fIsets\fR]\fP
+.br
+\*c
+.BR \-h | \-\-help
+.br
+\*c
+.BR \-v | \-\-version
+.
+.
+.SH DESCRIPTION
+The \*c command extracts complete counter sets from the CPU
+Measurement Facilities for Linux on Z.
+Counter sets can be specified and extracted for individual CPUs.
+The output is a comma-separated values file.
+Each line starts with a timestamp and the CPU number,
+followed by the extracted counter values.
+.
+.SH OPTIONS
+.TP
+.BR \-h ", " \-\-help
+Displays help information, then exits.
+.
+.TP
+.BR \-v ", " \-\-version
+Displays version information, then exits.
+.
+.TP
+.BR \-a ", " \-\-allcpu
+Displays counter values from each CPU.
+The default is a total summary line of all counters from all CPUs.
+.
+.TP
+.BR \-i ", " \-\-interval \fI\ seconds\fP
+Specifies a time interval, in seconds,
+that the command waits between read operations.
+The default is 60 seconds.
+.
+.TP
+.BR \-l ", " \-\-loop \fI\ count\fP
+Performs the specified number of read operations.
+.
+.TP
+\fR[\fIcpulist\fR][:\fIsets\fR]\fP
+A comma-separated list of CPUs.
+Each CPU can optionally be followed by characters that specify the counter set.
+See below for details.
+.
+.SS "CPU List and counter-set specification"
+In the comma-separated list of CPUs,
+each element is a CPU or a range of CPUs.
+By default, \*c lists all CPUs.
+.P
+The CPU list can be followed by an optional list
+of characters that specify the counter sets to be extracted,
+preceded by a colon.
+The characters can be upper or lower case.
+By default, all counter sets are used.
+.IP b
+Include the basic counter set.
+.IP c
+Include the crypto counter set.
+.IP e
+Include the extended counter set.
+.IP m
+Include the MT_Diagnostic counter set.
+.IP p|u
+Include the problem counter set.
+.IP a
+Include all known counter sets (default).
+.SH "Concurrency with perf tool"
+The \*c tool and the linux
+.B perf
+tool use the same hardware and cannot be used concurrently.
+Both tools print an error message and abort when they
+detect this situation.
+.SH "EXAMPLES"
+The first example enables the basic and problem counter sets on CPU 0 and 1.
+Two read operations are performed and a summary line is printed for each
+read operation.
+.sp 1
+.nf
+.ft CW
+# lshwc -l2 0-1:BP
+Date,Time,CPU,CPU_CYCLES(0),INSTRUCTIONS(1),L1I_DIR_WRITES(2),L1I_PENALTY_CYCLES(3),L1D_DIR_WRITES(4),
+	L1D_PENALTY_CYCLES(5),PROBLEM_STATE_CPU_CYCLES(32),PROBLEM_STATE_INSTRUCTIONS(33)
+2021-04-01,11:50:32,Total,125422,39421,304,13953,454,
+	97489,0,0
+2021-04-01,11:51:32,Total,68074231,16386850,194028,21382384,317227,
+	104503489,777383,14198
+.ft
+.fi
+.sp 1
+This example shows the counter values of the problem state counter set
+per CPU. CPU 0 and CPU 1 is selected.
+.nf
+.ft CW
+.sp 1
+# lshwc -l3 -a 0-1:P
+Date,Time,CPU,PROBLEM_STATE_CPU_CYCLES(32),PROBLEM_STATE_INSTRUCTIONS(33)
+2021-04-01,11:54:47,CPU0,0,0
+2021-04-01,11:54:47,CPU1,0,0
+2021-04-01,11:54:47,Total,0,0
+2021-04-01,11:55:47,CPU0,818775,14198
+2021-04-01,11:55:47,CPU1,125689,1306
+2021-04-01,11:55:47,Total,944464,15504
+2021-04-01,11:56:47,CPU0,3207071426,1489122591
+2021-04-01,11:56:47,CPU1,3225092021,1489278312
+2021-04-01,11:56:47,Total,6432163447,2978400903
+.ft
+.fi
+.SH "SEE ALSO"
+.BR lscpumf (1)
+.BR chcpumf (8)

dasdfmt/dasdfmt.h

@@ -41,6 +41,10 @@ static const char mode_str[3][10] = {
 	"Full", "Quick", "Expand"
 };
 
+/* Report error, free memory, and exit */
+static void error(const char *format, ...)
+	__attribute__((__noreturn__, __format__(__printf__, 1, 2)));
+
 #define DASD_PARTN_BITS 2
 #define PARTN_MASK ((1 << DASD_PARTN_BITS) - 1)
 
@@ -65,47 +69,24 @@ static const char mode_str[3][10] = {
 	"is in invalid format\n",prog_name);}
 
 typedef struct bootstrap1 {
-        u_int32_t key;
-        u_int32_t data[6];
+	u_int32_t key;
+	u_int32_t data[6];
 } __attribute__ ((packed)) bootstrap1_t;
 
 typedef struct bootstrap2 {
-        u_int32_t key;
-        u_int32_t data[36];
+	u_int32_t key;
+	u_int32_t data[36];
 } __attribute__ ((packed)) bootstrap2_t;
 
-typedef struct dasdfmt_info {
-	dasd_information2_t dasd_info;
-        int   verbosity;
-        int   testmode;
-        int   withoutprompt;
-        int   print_progressbar;
-        int   print_hashmarks, hashstep;
-	int   print_percentage;
-        int   force;
-        int   writenolabel;
-        int   labelspec;
-        int   cdl_format;
-        int   blksize_specified;
-	int   reqsize_specified;
-        int   keep_volser;
-	int   force_host;
-	int   layout_specified;
-	int   check;
-	int   mode_specified;
-	int   ese;
-	int   no_discard;
-} dasdfmt_info_t;
-
 
 /*
 C9D7D3F1 000A0000 0000000F 03000000  00000001 00000000 00000000
 */
 static bootstrap1_t ipl1 = {
-        0xC9D7D3F1, {
-                0x000A0000, 0x0000000F, 0x03000000,
-                0x00000001, 0x00000000, 0x00000000
-        }
+	0xC9D7D3F1, {
+		0x000A0000, 0x0000000F, 0x03000000,
+		0x00000001, 0x00000000, 0x00000000
+	}
 };
 
 /*
@@ -116,21 +97,20 @@ C9D7D3F2 07003AB8 40000006 31003ABE  40000005 08003AA0 00000000 06000000
 00000000 00000000 00000000 00000000  00000000
 */
 static bootstrap2_t ipl2 = {
-        0xC9D7D3F2, {
-                0x07003AB8, 0x40000006, 0x31003ABE,
-                0x40000005, 0x08003AA0, 0x00000000,
-                0x06000000, 0x20000000, 0x00000000,
-                0x00000000, 0x00000400, 0x00000000,
-                0x00000000, 0x00000000, 0x00000000,
-                0x00000000, 0x00000000, 0x00000000,
-                0x00000000, 0x00000000, 0x00000000,
-                0x00000000, 0x00000000, 0x00000000,
-                0x00000000, 0x00000000, 0x00000000,
-                0x00000000, 0x00000000, 0x00000000,
-                0x00000000, 0x00000000, 0x00000000,
-                0x00000000, 0x00000000, 0x00000000
-        }
+	0xC9D7D3F2, {
+		0x07003AB8, 0x40000006, 0x31003ABE,
+		0x40000005, 0x08003AA0, 0x00000000,
+		0x06000000, 0x20000000, 0x00000000,
+		0x00000000, 0x00000400, 0x00000000,
+		0x00000000, 0x00000000, 0x00000000,
+		0x00000000, 0x00000000, 0x00000000,
+		0x00000000, 0x00000000, 0x00000000,
+		0x00000000, 0x00000000, 0x00000000,
+		0x00000000, 0x00000000, 0x00000000,
+		0x00000000, 0x00000000, 0x00000000,
+		0x00000000, 0x00000000, 0x00000000,
+		0x00000000, 0x00000000, 0x00000000
+	}
 };
 
 #endif /* DASDFMT_H */
-

etc/hsavmcore.conf

@@ -0,0 +1,25 @@
+# Example configuration for hsavmcore
+# See hsavmcore.conf(8) for documentation
+
+# 0 - ERROR
+# 1 - WARN
+# 2 - INFO
+# 3 - DEBUG
+# 4 - TRACE
+#verbose = 0
+
+#workdir = /var/crash
+
+#mount_debugfs = 0
+
+#use_hsa_mem = 0
+
+#hsa_size = -1
+#release_hsa = 1
+
+#bind_mount_vmcore = 1
+
+#swap = /dev/disk/by-uuid/3cf6630b-4c4d-49ac-a0ae-0f5484cb5721
+#swap = /swap.img
+
+#fuse_debug = 0

etc/udev/rules.d/59-dasd.rules

@@ -26,10 +26,10 @@ KERNEL=="dasd*[0-9]", ENV{ID_XUID}=="?*", SYMLINK+="disk/by-id/$env{ID_BUS}-$env
 
 LABEL="dasd_symlinks_end"
 
-# on device add set request queue scheduler to deadline
+# on device add set request queue scheduler to none
 SUBSYSTEM!="block", GOTO="sched_end"
 
 ACTION!="change", GOTO="sched_end"
-KERNEL=="dasd*[!0-9]", TEST=="queue/scheduler", ATTR{queue/scheduler}="deadline"
+KERNEL=="dasd*[!0-9]", TEST=="queue/scheduler", ATTR{queue/scheduler}="none"
 
 LABEL="sched_end"

fdasd/fdasd.c

@@ -1232,7 +1232,7 @@ static void fdasd_reread_partition_table(fdasd_anchor_t *anc)
 	if (!anc->silent)
 		printf("rereading partition table...\n");
 
-	if (dasd_reread_partition_table(options.device, 1) != 0) {
+	if (dasd_reread_partition_table(options.device, 5) != 0) {
 		fdasd_error(anc, unable_to_ioctl, "Error while rereading "
 			    "partition table.\nPlease reboot!");
 	}

genprotimg/Makefile

@@ -21,7 +21,7 @@ clean: clean-recursive
 $(RECURSIVE_TARGETS):
 	@target=`echo $@ |sed s/-recursive//`; \
 		for d in $(SUBDIRS); do \
-			$(MAKE) -C $$d $$target; \
+			$(MAKE) -C $$d $$target || exit 1; \
 		done
 
 .PHONY: all install clean $(RECURSIVE_TARGETS)

genprotimg/boot/Makefile

@@ -12,7 +12,7 @@ ALL_CFLAGS := $(NO_PIE_CFLAGS) -Os -g \
 	-DENABLE_SCLP_ASCII=1 \
 	-DS390_TOOLS_RELEASE=$(S390_TOOLS_RELEASE) \
 	-fno-builtin -ffreestanding -fno-asynchronous-unwind-tables \
-	-fno-delete-null-pointer-checks \
+	-fno-delete-null-pointer-checks -fno-stack-protector \
 	-fexec-charset=IBM1047 -m64 -mpacked-stack \
 	-mstack-size=4096 -mstack-guard=128 -msoft-float \
 	-Wall -Wformat-security -Wextra -Werror

genprotimg/boot/head.S

@@ -1,5 +1,5 @@
 /*
- * Entry code for stage 3a boot loader
+ * Entry code for stage 3a and stage 3b boot loader
  *
  * Copyright IBM Corp. 2020
  *
@@ -24,6 +24,8 @@ _start:
 	sam64
 
 	/* Initialize stack */
-	lgfi	%r15, STACK_ADDRESS + STACK_SIZE - STACK_FRAME_OVERHEAD
+	basr	%r13, 0
+.Lbase:	llgf	%r15, .Lstack - .Lbase(%r13)
 	brasl	%r14, initialize
+.Lstack: .long STACK_ADDRESS + STACK_SIZE - STACK_FRAME_OVERHEAD
 .previous

genprotimg/boot/stage3a_init.S

@@ -21,6 +21,8 @@ _init:
 	 * kernel command line and the address and size of the
 	 * ramdisk. Simply ignore this by starting at 0x11000.
 	 */
-	lgfi	%r1, STAGE3A_ENTRY
+	basr	%r13, 0
+.Lbase:	llgf	%r1, .Lstage3a_entry - .Lbase(%r13)
 	br	%r1
+.Lstage3a_entry: .long STAGE3A_ENTRY
 .previous

genprotimg/boot/stage3b_reloc.S

@@ -31,12 +31,12 @@ stage3b_reloc_start:
 	sigp	%r1, %r0, SIGP_SET_ARCHITECTURE
 	sam64
 
-.copy_stage3b:
 	/* Location of stage3b in memory */
 	larl	%r8, stage3b_start
 
 	/* Destination for stage3b */
-	lgfi	%r9, STAGE3B_LOAD_ADDRESS
+	basr	%r13, 0
+.Lbase:	llgf	%r9, .Lstage3b_load_address - .Lbase(%r13)
 
 	/* Size of stage3b */
 	lghi	%r11, stage3b_end - stage3b_start
@@ -45,8 +45,10 @@ stage3b_reloc_start:
 	MEMCPY	%r9, %r8, %r11
 
 	/* Branch to STAGE3B_ENTRY */
-	lgfi	%r9, STAGE3B_ENTRY
+	llgf	%r9, .Lstage3b_entry - .Lbase(%r13)
 	br	%r9
+.Lstage3b_load_address:	.long STAGE3B_LOAD_ADDRESS
+.Lstage3b_entry:	.long STAGE3B_ENTRY
 stage3b_start:
 	.incbin	"stage3b.bin"
 stage3b_end:

genprotimg/man/genprotimg.8

@@ -2,7 +2,7 @@
 .\" s390-tools is free software; you can redistribute it and/or modify
 .\" it under the terms of the MIT license. See LICENSE for details.
 .\"
-.TH GENPROTIMG 8 "March 2020" "s390-tools"
+.TH GENPROTIMG 8 "November 2020" "s390-tools"
 .SH NAME
 genprotimg \- Create a protected virtualization image
 
@@ -10,6 +10,7 @@ genprotimg \- Create a protected virtualization image
 .SY
 .B genprotimg
 \fB\-k\fR \fIHOST_KEY_DOCUMENT\fR...
+\fB\-C\fR \fICERTIFICATE\fR...
 \fB\-i\fR \fIVMLINUZ\fR
 [\fB\-r\fR \fIRAMDISK\fR]
 [\fB\-p\fR \fIPARMFILE\fR]
@@ -21,15 +22,19 @@ genprotimg \- Create a protected virtualization image
 .PP
 Use \fBgenprotimg\fR to generate a single bootable image file with
 encrypted and integrity-protected parts. The command requires a kernel
-image, a host-key document, and an output file name. Optionally,
-specify an initial RAM filesystem, and a file containing the kernel
-parameters. Should special circumstances require it, you can
+image, a host-key document, certificates for the host-key document
+verification, and an output file name. Optionally, specify an initial
+RAM filesystem, and a file containing the kernel parameters. If the
+command should be run offline, use the \fB\-\-offline\fR option and
+specify the certificate revocation lists (CRLs) by using the
+\fB\-\-crl\fR option. Should special circumstances require it, you can
 optionally specify your own keys for the encryption by using the
-experimental options. In the resulting image file, a plain text boot
-loader, the encrypted components for kernel, initial RAM disk, kernel
-parameters, and the encrypted and integrity-protected header are
-concatenated. The header contains metadata necessary for running the
-guest in protected mode.
+experimental options. For all certificates, CRLs, and host-key
+documents, both the PEM and DER input formats are supported. In the
+resulting image file, a plain text boot loader, the encrypted
+components for kernel, initial RAM disk, kernel parameters, and the
+encrypted and integrity-protected header are concatenated. The header
+contains metadata necessary for running the guest in protected mode.
 .PP
 Use this image file as a kernel image for zipl or for a direct kernel
 boot using QEMU.
@@ -53,6 +58,12 @@ Specifies a host-key document. At least one is required. Specify this
 option multiple times to enable the image to run on more than one
 host.
 .TP
+\fB\-C\fR, \fB\-\-cert\fR=\fI\,FILE\/\fR
+Specifies the certificate that is used to establish a chain of trust
+for the verification of the host-key documents. Specify this option
+twice to specify the IBM Z signing key and the intermediate CA
+certificate (signed by the root CA). Required.
+.TP
 \fB\-o\fR, \fB\-\-output\fR=\fI\,OUTPUT_FILE\/\fR
 Specifies the output file. Required.
 .TP
@@ -65,10 +76,32 @@ Specifies the RAM disk image. Optional.
 \fB\-p\fR, \fB\-\-parmfile\fR=\fI\,PARMFILE\/\fR
 Specifies the kernel command line stored in \fI\,PARMFILE\/\fR. Optional.
 .TP
+\fB\-\-crl\fR=\fI\,FILE\/\fR
+Specifies the revocation list that is used to check whether a
+certificate of the chain of trust is revoked. Specify this option
+multiple times to use multiple CRLs. Optional.
+.TP
+\fB\-\-offline\fR
+Specifies offline mode, in which no attempt is made to download
+CRLs. Optional.
+.TP
+\fB\-\-root\-ca\fR=\fI\,FILE\/\fR
+Specifies the root CA certificate for the verification. If omitted,
+the DigiCert root CA certificate installed on the system is used. Use
+this only if you trust the specified certificate. Optional.
+.TP
 \fB\-\-no-verify\fR
 Do not require the host-key documents to be valid. For testing
 purposes, do not use for a production image. Optional.
 .TP
+\fB\-\-enable\-pckmo\fR
+Enable the support for the DEA, TDEA, AES, and ECC PCKMO key encryption
+functions. This is the default. Optional.
+.TP
+\fB\-\-disable\-pckmo\fR
+Disable the support for the DEA, TDEA, AES, and ECC PCKMO key encryption
+functions. Optional.
+.TP
 \fB\-v\fR, \fB\-\-version\fR
 Prints version information, then exits.
 
@@ -77,11 +110,13 @@ Prints version information, then exits.
 Generate a protected virtualization image in
 \fI\,/boot/vmlinuz.pv\/\fR, using the kernel file \fI\,vmlinuz\/\fR,
 the initrd in \fI\,initramfs\/\fR, the kernel parameters contained in
-\fI\,parmfile\/\fR, and the host-key document in \fI\,host_key.crt\/\fR:
+\fI\,parmfile\/\fR, the intermediate CA in \fI\,DigiCertCA.crt\/\fR,
+the IBM Z signing key in \fI\,ibm-z-host-key-signing.crt\/\fR, and the
+host-key document in \fI\,host_key.crt\/\fR:
 .PP
 .Vb 1
 .EX
-\&        genprotimg \-i \fI\,vmlinuz\/\fR \-r \fI\,initramfs\/\fR \-p \fI\,parmfile\/\fR \-k \fI\,host_key.crt\/\fR \-o \fI\,/boot/vmlinuz.pv\/\fR
+\&        genprotimg \-i \fI\,vmlinuz\/\fR \-r \fI\,initramfs\/\fR \-p \fI\,parmfile\/\fR \-k \fI\,host_key.crt\/\fR \-C \fI\,ibm-z-host-key-signing.crt\/\fR \-C \fI\,DigiCertCA.crt \-o \fI\,/boot/vmlinuz.pv\/\fR
 .EE
 .Ve
 .PP

genprotimg/src/Makefile

@@ -15,24 +15,25 @@ INCLUDE_PARMS = $(addprefix -I,$(INCLUDE_PATHS))
 
 WARNINGS := -Wall -Wextra -Wshadow \
 	-Wcast-align -Wwrite-strings -Wmissing-prototypes \
-	-Wmissing-declarations -Wredundant-decls -Wnested-externs -Winline \
+	-Wmissing-declarations -Wredundant-decls -Wnested-externs \
 	-Wno-long-long -Wuninitialized -Wconversion -Wstrict-prototypes \
-	-Wpointer-arith -Werror \
+	-Wpointer-arith -Werror -Wno-error=inline \
 	$(NULL)
 
 $(bin_PROGRAM)_SRCS := $(bin_PROGRAM).c pv/pv_stage3.c pv/pv_image.c \
 	pv/pv_comp.c pv/pv_hdr.c pv/pv_ipib.c utils/crypto.c utils/file_utils.c \
 	pv/pv_args.c utils/buffer.c pv/pv_comps.c pv/pv_error.c \
-	pv/pv_opt_item.c \
+	pv/pv_opt_item.c utils/curl.c \
 	$(NULL)
 $(bin_PROGRAM)_OBJS := $($(bin_PROGRAM)_SRCS:.c=.o)
 
 ALL_CFLAGS += -std=gnu11 -DPKGDATADIR=$(PKGDATADIR) \
-	$(GLIB2_CFLAGS) $(LIBCRYPTO_CFLAGS) \
+	$(GLIB2_CFLAGS) $(LIBCRYPTO_CFLAGS) $(LIBCURL_CFLAGS) \
+	-DOPENSSL_API_COMPAT=0x10100000L \
 	$(WARNINGS) \
 	$(NULL)
 ALL_CPPFLAGS += $(INCLUDE_PARMS)
-LDLIBS += $(GLIB2_LIBS) $(LIBCRYPTO_LIBS)
+LDLIBS += $(GLIB2_LIBS) $(LIBCRYPTO_LIBS) $(LIBCURL_LIBS)
 
 
 ifneq ($(shell sh -c 'command -v pkg-config'),)
@@ -40,21 +41,27 @@ GLIB2_CFLAGS := $(shell pkg-config --silence-errors --cflags glib-2.0)
 GLIB2_LIBS := $(shell pkg-config --silence-errors --libs glib-2.0)
 LIBCRYPTO_CFLAGS := $(shell pkg-config --silence-errors --cflags libcrypto)
 LIBCRYPTO_LIBS := $(shell pkg-config --silence-errors --libs libcrypto)
+LIBCURL_CFLAGS := $(shell pkg-config --silence-errors --cflags libcurl)
+LIBCURL_LIBS := $(shell pkg-config --silence-errors --libs libcurl)
 else
 GLIB2_CFLAGS := -I/usr/include/glib-2.0 -I/usr/lib64/glib-2.0/include
 GLIB2_LIBS := -lglib-2.0
 LIBCRYPTO_CFLAGS :=
 LIBCRYPTO_LIBS := -lcrypto
+LIBCURL_CFLAGS :=
+LIBCURL_LIBS := -lcurl
 endif
 
 BUILD_TARGETS := skip-$(bin_PROGRAM)
 INSTALL_TARGETS := skip-$(bin_PROGRAM)
 ifneq (${HAVE_OPENSSL},0)
 ifneq (${HAVE_GLIB2},0)
+ifneq (${HAVE_LIBCURL},0)
 BUILD_TARGETS := $(bin_PROGRAM)
 INSTALL_TARGETS := install-$(bin_PROGRAM)
 endif
 endif
+endif
 
 all: $(BUILD_TARGETS)
 
@@ -98,4 +105,9 @@ $($(bin_PROGRAM)_OBJS): .check-dep-$(bin_PROGRAM)
 		"openssl-devel / libssl-dev version >= 1.1.0", \
 		"HAVE_OPENSSL=0", \
 		"-I.")
+	$(call check_dep, \
+		"$(bin_PROGRAM)", \
+		"curl/curl.h", \
+		"libcurl-devel", \
+		"HAVE_LIBCURL=0")
 	touch $@

genprotimg/src/genprotimg.c

@@ -18,6 +18,8 @@
 #include "common.h"
 #include "pv/pv_args.h"
 #include "pv/pv_image.h"
+#include "utils/crypto.h"
+#include "utils/curl.h"
 
 enum {
 	LOG_LEVEL_CRITICAL = 0,
@@ -117,6 +119,8 @@ static void remove_signal_handler(const gint *signals, const gsize signals_n)
 		signal(signals[i], SIG_DFL);
 }
 
+static void __attribute__((constructor)) __init(void);
+static void __attribute__((destructor)) __cleanup(void);
 gint main(gint argc, gchar *argv[])
 {
 	g_autoptr(PvArgs) args = pv_args_new();
@@ -177,5 +181,20 @@ error:
 	rmdir_recursive(tmp_dir, NULL);
 	remove_signal_handler(signals, G_N_ELEMENTS(signals));
 	g_free(tmp_dir);
+	g_clear_pointer(&img, pv_img_free);
+	g_clear_pointer(&args, pv_args_free);
 	exit(ret);
 }
+
+static void __init(void)
+{
+	pv_crypto_init();
+	if (curl_init() != 0)
+		g_abort();
+}
+
+static void __cleanup(void)
+{
+	curl_cleanup();
+	pv_crypto_cleanup();
+}

genprotimg/src/include/pv_crypto_def.h

@@ -14,6 +14,24 @@
 
 #include "lib/zt_common.h"
 
+/* IBM signing key subject */
+#define PV_IBM_Z_SUBJECT_COMMON_NAME "International Business Machines Corporation"
+#define PV_IBM_Z_SUBJECT_COUNTRY_NAME "US"
+#define PV_IBM_Z_SUBJECT_LOCALITY_NAME "Poughkeepsie"
+#define PV_IBM_Z_SUBJECT_ORGANIZATIONONAL_UNIT_NAME_SUFFIX "Key Signing Service"
+#define PV_IBM_Z_SUBJECT_ORGANIZATION_NAME "International Business Machines Corporation"
+#define PV_IBM_Z_SUBJECT_STATE "New York"
+#define PV_IMB_Z_SUBJECT_ENTRY_COUNT 6
+
+/* Minimum security level for the keys/certificates used to establish a chain of
+ * trust (see https://www.openssl.org/docs/man1.1.1/man3/X509_VERIFY_PARAM_set_auth_level.html
+ * for details).
+ */
+#define PV_CERTS_SECURITY_LEVEL 2
+
+/* SKID for DigiCert Assured ID Root CA */
+#define DIGICERT_ASSURED_ID_ROOT_CA_SKID "45EBA2AFF492CB82312D518BA7A7219DF36DC80F"
+
 union ecdh_pub_key {
 	struct {
 		uint8_t x[80];

genprotimg/src/include/pv_hdr_def.h

@@ -24,8 +24,11 @@
 #define PV_MAGIC_NUMBER 0x49424d5365634578ULL
 #define PV_VERSION_1	0x00000100U
 
-/* prevent Ultravisor decryption during unpack operation */
-#define PV_CFLAG_NO_DECRYPTION 0x10000000ULL
+/* Plaintext control flags */
+#define PV_PCF_PCKM_ECC		(1ULL << 5)  /* PCKMO encrypt-ECC-key functions allowed */
+#define PV_PCF_PCKMO_AES	(1ULL << 6)  /* PCKMO encrypt-AES-key functions allowed */
+#define PV_PCF_PCKMO_DEA_TDEA	(1ULL << 7)  /* PCKMO encrypt-DEA/TDEA-key functions allowed */
+#define PV_PCF_NO_DECRYPTION	(1ULL << 28) /* prevent Ultravisor decryption during unpack operation */
 
 /* maxima for the PV version 1 */
 #define PV_V1_IPIB_MAX_SIZE	PAGE_SIZE

genprotimg/src/pv/pv_args.c

@@ -18,7 +18,9 @@
 
 static gchar summary[] =
 	"Use genprotimg to create a protected virtualization kernel image file,\n"
-	"which can be loaded using zipl or QEMU.";
+	"which can be loaded using zipl or QEMU. For all certificates, revocation\n"
+	"lists, and host-key documents, both the PEM and DER input formats are\n"
+	"supported.";
 
 static gint pv_arg_compare(gconstpointer arg_1, gconstpointer arg_2)
 {
@@ -62,6 +64,13 @@ static gint pv_args_validate_options(PvArgs *args, GError **err)
 {
 	PvComponentType KERNEL = PV_COMP_TYPE_KERNEL;
 
+	if (args->pcf && args->allow_pckmo != PV_NOT_SET) {
+		g_set_error(err, PV_PARSE_ERROR, PV_PARSE_ERROR_SYNTAX,
+			    _("The '--x-pcf' and '--(enable|disable)-pckmo' options are mutually"
+			      " exclusive.\nUse 'genprotimg --help' for more information"));
+		return -1;
+	}
+
 	if (args->unused_values->len > 0) {
 		g_autofree gchar *unused = NULL;
 
@@ -97,9 +106,14 @@ static gint pv_args_validate_options(PvArgs *args, GError **err)
 		return -1;
 	}
 
-	if (!args->no_verify) {
-		g_set_error(err, PV_PARSE_ERROR, PR_PARSE_ERROR_MISSING_ARGUMENT,
-			    _("Use the option '--no-verify' as the verification support is not available yet."));
+	if (!args->no_verify &&
+	    (!args->untrusted_cert_paths ||
+	     g_strv_length(args->untrusted_cert_paths) == 0)) {
+		g_set_error(
+			err, PV_PARSE_ERROR, PR_PARSE_ERROR_MISSING_ARGUMENT,
+			_("Either specify the IBM Z signing key and (DigiCert) intermediate CA certificate\n"
+			  "by using the '--cert' option, or use the '--no-verify' flag to disable the\n"
+			  "host-key document verification completely (at your own risk)."));
 		return -1;
 	}
 
@@ -141,6 +155,8 @@ static gboolean cb_set_string_option(const gchar *option, const gchar *value,
 {
 	gchar **args_option = NULL;
 
+	if (g_str_equal(option, "--root-ca"))
+		args_option = &args->root_ca_path;
 	if (g_str_equal(option, "-o") || g_str_equal(option, "--output"))
 		args_option = &args->output_path;
 	if (g_str_equal(option, "--x-comp-key"))
@@ -172,6 +188,19 @@ static gboolean cb_set_string_option(const gchar *option, const gchar *value,
 	return TRUE;
 }
 
+static gboolean cb_enable_disable_flag(const gchar *option, const gchar *value G_GNUC_UNUSED,
+				       PvArgs *args, GError **err G_GNUC_UNUSED)
+{
+	if (g_str_equal(option, "--enable-pckmo"))
+		args->allow_pckmo = PV_TRUE;
+	else if (g_str_equal(option, "--disable-pckmo"))
+		args->allow_pckmo = PV_FALSE;
+	else
+		g_assert_not_reached();
+
+	return TRUE;
+}
+
 static gboolean cb_set_log_level(const gchar *option G_GNUC_UNUSED,
 				 const gchar *value G_GNUC_UNUSED, PvArgs *args,
 				 GError **err G_GNUC_UNUSED)
@@ -211,6 +240,18 @@ gint pv_args_parse_options(PvArgs *args, gint *argc, gchar **argv[],
 			_("FILE specifies a host-key document. At least\n" INDENT
 			  "one is required."),
 		  .arg_description = _("FILE") },
+		{ .long_name = "cert",
+		  .short_name = 'C',
+		  .flags = G_OPTION_FLAG_NONE,
+		  .arg = G_OPTION_ARG_FILENAME_ARRAY,
+		  .arg_data = &args->untrusted_cert_paths,
+		  .description = _(
+			  "FILE contains a certificate that is used to\n" INDENT
+			  "establish a chain of trust for the verification\n" INDENT
+			  "of the host-key documents. The IBM Z signing\n" INDENT
+			  "key and intermediate CA certificate (signed\n" INDENT
+			  "by the root CA) are required."),
+		  .arg_description = _("FILE") },
 		{ .long_name = "output",
 		  .short_name = 'o',
 		  .flags = G_OPTION_FLAG_FILENAME,
@@ -227,7 +268,7 @@ gint pv_args_parse_options(PvArgs *args, gint *argc, gchar **argv[],
 		  .arg_description = _("IMAGE") },
 		{ .long_name = "ramdisk",
 		  .short_name = 'r',
-		  .flags = G_OPTION_FLAG_OPTIONAL_ARG | G_OPTION_FLAG_FILENAME,
+		  .flags = G_OPTION_FLAG_FILENAME,
 		  .arg = G_OPTION_ARG_CALLBACK,
 		  .arg_data = cb_add_component,
 		  .description = _("Use RAMDISK as the initial RAM disk\n" INDENT
@@ -235,12 +276,52 @@ gint pv_args_parse_options(PvArgs *args, gint *argc, gchar **argv[],
 		  .arg_description = _("RAMDISK") },
 		{ .long_name = "parmfile",
 		  .short_name = 'p',
-		  .flags = G_OPTION_FLAG_OPTIONAL_ARG | G_OPTION_FLAG_FILENAME,
+		  .flags = G_OPTION_FLAG_FILENAME,
 		  .arg = G_OPTION_ARG_CALLBACK,
 		  .arg_data = cb_add_component,
 		  .description = _("Use the kernel parameters stored in PARMFILE\n" INDENT
 				   "(optional)."),
 		  .arg_description = _("PARMFILE") },
+		{.long_name = "enable-pckmo",
+		 .short_name = 0,
+		 .flags = G_OPTION_FLAG_NO_ARG,
+		 .arg = G_OPTION_ARG_CALLBACK,
+		 .arg_data = cb_enable_disable_flag,
+		 .description = _("Enable the support for the DEA, TDEA, AES, and\n" INDENT
+				  "ECC PCKMO key encryption functions (default)\n" INDENT
+				  "(optional).")},
+		{.long_name = "disable-pckmo",
+		 .short_name = 0,
+		 .flags = G_OPTION_FLAG_NO_ARG,
+		 .arg = G_OPTION_ARG_CALLBACK,
+		 .arg_data = cb_enable_disable_flag,
+		 .description = _("Disable the support for the DEA, TDEA, AES, and\n" INDENT
+				  "ECC PCKMO key encryption functions (optional).")},
+		{ .long_name = "crl",
+		  .short_name = 0,
+		  .flags = G_OPTION_FLAG_NONE,
+		  .arg = G_OPTION_ARG_FILENAME_ARRAY,
+		  .arg_data = &args->crl_paths,
+		  .description = _(
+			  "FILE contains a certificate revocation list\n" INDENT
+			  "(optional)."),
+		  .arg_description = _("FILE") },
+		{ .long_name = "offline",
+		  .short_name = 0,
+		  .flags = G_OPTION_FLAG_NONE,
+		  .arg = G_OPTION_ARG_NONE,
+		  .arg_data = &args->offline,
+		  .description = _("Don't download CRLs (optional)."),
+		  .arg_description = NULL },
+		{ .long_name = "root-ca",
+		  .short_name = 0,
+		  .flags = G_OPTION_FLAG_FILENAME,
+		  .arg = G_OPTION_ARG_CALLBACK,
+		  .arg_data = cb_set_string_option,
+		  .description = _(
+			  "Set FILE as the trusted root CA and don't use the\n" INDENT
+			  "root CAs that are installed on the system (optional)."),
+		  .arg_description = _("FILE") },
 		{ .long_name = "no-verify",
 		  .short_name = 0,
 		  .flags = G_OPTION_FLAG_NONE,
@@ -311,7 +392,8 @@ gint pv_args_parse_options(PvArgs *args, gint *argc, gchar **argv[],
 		  .description =
 			  _("Specify the plaintext control flags\n" INDENT
 			    "as a hexadecimal value.\n" INDENT
-			    "Optional; default: '0x0'."),
+			    "Optional; mutually exclusive with\n" INDENT
+			    "'--(enable|disable)-pckmo'; default: '0xe0'."),
 		  .arg_description = _("VALUE") },
 		{ .long_name = "x-psw",
 		  .short_name = 0,
@@ -364,6 +446,7 @@ PvArgs *pv_args_new(void)
 	g_autoptr(PvArgs) args = g_new0(PvArgs, 1);
 
 	args->unused_values = g_ptr_array_new_with_free_func(g_free);
+	args->allow_pckmo = PV_NOT_SET;
 	return g_steal_pointer(&args);
 }
 
@@ -378,6 +461,9 @@ void pv_args_free(PvArgs *args)
 	g_free(args->cust_root_key_path);
 	g_free(args->cust_comm_key_path);
 	g_free(args->gcm_iv_path);
+	g_free(args->root_ca_path);
+	g_strfreev(args->crl_paths);
+	g_strfreev(args->untrusted_cert_paths);
 	g_strfreev(args->host_keys);
 	g_free(args->xts_key_path);
 	g_slist_free_full(args->comps, (GDestroyNotify)pv_arg_free);

genprotimg/src/pv/pv_args.h

@@ -22,11 +22,19 @@ typedef struct pv_arg {
 PvArg *pv_arg_new(PvComponentType type, const gchar *path);
 void pv_arg_free(PvArg *arg);
 
+typedef enum pv_tristate {
+		  PV_NOT_SET = 0,
+		  PV_TRUE,
+		  PV_FALSE,
+} PvTristate;
+
 typedef struct {
 	gint log_level;
 	gint no_verify;
+	gboolean offline;
 	gchar *pcf;
 	gchar *scf;
+	PvTristate allow_pckmo;
 	gchar *psw_addr; /* PSW address which will be used for the start of
 			  * the actual component (e.g. Linux kernel)
 			  */
@@ -34,6 +42,11 @@ typedef struct {
 	gchar *cust_comm_key_path;
 	gchar *gcm_iv_path;
 	gchar **host_keys;
+	gchar *root_ca_path; /* Trusted root CA used for the verification of the
+			      * chain of trust (if specified).
+			      */
+	gchar **untrusted_cert_paths;
+	gchar **crl_paths;
 	gchar *xts_key_path;
 	GSList *comps;
 	gchar *output_path;

genprotimg/src/pv/pv_comp.c

@@ -73,12 +73,12 @@ PvComponent *pv_component_new_file(PvComponentType type, const gchar *path,
 	return pv_component_new(type, size, DATA_FILE, (void **)&file, err);
 }
 
-PvComponent *pv_component_new_buf(PvComponentType type, const Buffer *buf,
+PvComponent *pv_component_new_buf(PvComponentType type, const PvBuffer *buf,
 				  GError **err)
 {
 	g_assert(buf);
 
-	g_autoptr(Buffer) dup_buf = buffer_dup(buf, FALSE);
+	g_autoptr(PvBuffer) dup_buf = pv_buffer_dup(buf, FALSE);
 	return pv_component_new(type, buf->size, DATA_BUFFER, (void **)&dup_buf,
 				err);
 }
@@ -90,7 +90,7 @@ void pv_component_free(PvComponent *component)
 
 	switch ((PvComponentDataType)component->d_type) {
 	case DATA_BUFFER:
-		buffer_clear(&component->buf);
+		pv_buffer_clear(&component->buf);
 		break;
 	case DATA_FILE:
 		comp_file_free(component->file);
@@ -162,21 +162,21 @@ gint pv_component_align_and_encrypt(PvComponent *component, const gchar *tmp_pat
 
 	switch ((PvComponentDataType)component->d_type) {
 	case DATA_BUFFER: {
-		g_autoptr(Buffer) enc_buf = NULL;
+		g_autoptr(PvBuffer) enc_buf = NULL;
 
 		if (!(IS_PAGE_ALIGNED(pv_component_size(component)))) {
-			g_autoptr(Buffer) new = NULL;
+			g_autoptr(PvBuffer) new = NULL;
 
 			/* create a page aligned copy */
-			new = buffer_dup(component->buf, TRUE);
-			buffer_clear(&component->buf);
+			new = pv_buffer_dup(component->buf, TRUE);
+			pv_buffer_clear(&component->buf);
 			component->buf = g_steal_pointer(&new);
 		}
 		enc_buf = encrypt_buf(parms, component->buf, err);
 		if (!enc_buf)
 			return -1;
 
-		buffer_clear(&component->buf);
+		pv_buffer_clear(&component->buf);
 		component->buf = g_steal_pointer(&enc_buf);
 		return 0;
 	}
@@ -220,10 +220,10 @@ gint pv_component_align(PvComponent *component, const gchar *tmp_path,
 
 	switch (component->d_type) {
 	case DATA_BUFFER: {
-		g_autoptr(Buffer) buf = NULL;
+		g_autoptr(PvBuffer) buf = NULL;
 
-		buf = buffer_dup(component->buf, TRUE);
-		buffer_clear(&component->buf);
+		buf = pv_buffer_dup(component->buf, TRUE);
+		pv_buffer_clear(&component->buf);
 		component->buf = g_steal_pointer(&buf);
 		return 0;
 	} break;
@@ -301,7 +301,7 @@ int64_t pv_component_update_pld(const PvComponent *comp, EVP_MD_CTX *ctx,
 
 	switch (comp->d_type) {
 	case DATA_BUFFER: {
-		const Buffer *buf = comp->buf;
+		const PvBuffer *buf = comp->buf;
 
 		g_assert(buf->size <= INT64_MAX);
 		g_assert(buf->size == size);
@@ -383,6 +383,7 @@ int64_t pv_component_update_tld(const PvComponent *comp, EVP_MD_CTX *ctx,
 		g_set_error(err, PV_CRYPTO_ERROR,
 			    PV_CRYPTO_ERROR_INTERNAL,
 			    _("BN_bin2bn failed"));
+		return -1;
 	}
 
 	for (uint64_t cur = 0; cur < size; cur += PAGE_SIZE) {
@@ -395,6 +396,7 @@ int64_t pv_component_update_tld(const PvComponent *comp, EVP_MD_CTX *ctx,
 			g_set_error(err, PV_CRYPTO_ERROR,
 				    PV_CRYPTO_ERROR_INTERNAL,
 				    _("BN_bn2binpad failed"));
+			return -1;
 		}
 
 		if (EVP_DigestUpdate(ctx, tmp, sizeof(tmp)) != 1) {
@@ -409,6 +411,7 @@ int64_t pv_component_update_tld(const PvComponent *comp, EVP_MD_CTX *ctx,
 			g_set_error(err, PV_CRYPTO_ERROR,
 				    PV_CRYPTO_ERROR_INTERNAL,
 				    _("BN_add_word failed"));
+			return -1;
 		}
 
 		nep++;
@@ -425,7 +428,7 @@ gint pv_component_write(const PvComponent *component, FILE *f, GError **err)
 
 	switch (component->d_type) {
 	case DATA_BUFFER: {
-		const Buffer *buf = component->buf;
+		const PvBuffer *buf = component->buf;
 
 		if (seek_and_write_buffer(f, buf, offset, err) < 0)
 			return -1;

genprotimg/src/pv/pv_comp.h

@@ -41,7 +41,7 @@ typedef struct {
 	gint d_type; /* PvComponentDataType */
 	union {
 		struct comp_file *file;
-		Buffer *buf;
+		PvBuffer *buf;
 		void *data;
 	};
 	uint64_t src_addr;
@@ -51,7 +51,7 @@ typedef struct {
 
 PvComponent *pv_component_new_file(PvComponentType type, const gchar *path,
 				   GError **err);
-PvComponent *pv_component_new_buf(PvComponentType type, const Buffer *buf,
+PvComponent *pv_component_new_buf(PvComponentType type, const PvBuffer *buf,
 				  GError **err);
 void pv_component_free(PvComponent *component);
 gint pv_component_type(const PvComponent *component);

genprotimg/src/pv/pv_comps.c

@@ -210,13 +210,13 @@ GSList *pv_img_comps_get_comps(const PvImgComps *comps)
 	return comps->comps;
 }
 
-gint pv_img_comps_finalize(PvImgComps *comps, Buffer **pld_digest,
-			   Buffer **ald_digest, Buffer **tld_digest,
+gint pv_img_comps_finalize(PvImgComps *comps, PvBuffer **pld_digest,
+			   PvBuffer **ald_digest, PvBuffer **tld_digest,
 			   uint64_t *nep, GError **err)
 {
-	g_autoptr(Buffer) tmp_pld_digest = NULL;
-	g_autoptr(Buffer) tmp_ald_digest = NULL;
-	g_autoptr(Buffer) tmp_tld_digest = NULL;
+	g_autoptr(PvBuffer) tmp_pld_digest = NULL;
+	g_autoptr(PvBuffer) tmp_ald_digest = NULL;
+	g_autoptr(PvBuffer) tmp_tld_digest = NULL;
 
 	comps->finalized = TRUE;
 	for (GSList *iterator = comps->comps; iterator; iterator = iterator->next) {

genprotimg/src/pv/pv_comps.h

@@ -32,8 +32,8 @@ gint pv_img_comps_add_component(PvImgComps *comps, PvComponent **comp,
 				GError **err);
 PvComponent *pv_img_comps_get_nth_comp(PvImgComps *comps, guint n);
 gint pv_img_comps_set_offset(PvImgComps *comps, gsize offset, GError **err);
-gint pv_img_comps_finalize(PvImgComps *comps, Buffer **pld_digest,
-			   Buffer **ald_digest, Buffer **tld_digest,
+gint pv_img_comps_finalize(PvImgComps *comps, PvBuffer **pld_digest,
+			   PvBuffer **ald_digest, PvBuffer **tld_digest,
 			   uint64_t *nep, GError **err);
 void pv_img_comps_free(PvImgComps *comps);
 

genprotimg/src/pv/pv_error.h

@@ -28,6 +28,8 @@ typedef enum {
 	PV_ERROR_IPIB_SIZE,
 	PV_ERROR_PV_HDR_SIZE,
 	PV_ERROR_INTERNAL,
+	PV_ERROR_CURL_INIT_FAILED,
+	PV_ERROR_DOWNLOAD_FAILED,
 } PvErrors;
 
 typedef enum {
@@ -57,6 +59,31 @@ typedef enum {
 	PV_CRYPTO_ERROR_RANDOMIZATION,
 	PV_CRYPTO_ERROR_INVALID_PARM,
 	PV_CRYPTO_ERROR_INVALID_KEY_SIZE,
+	PV_CRYPTO_ERROR_INVALID_VALIDITY_PERIOD,
+	PV_CRYPTO_ERROR_EXPIRED,
+	PV_CRYPTO_ERROR_NOT_VALID_YET,
+	PV_CRYPTO_ERROR_LOAD_CRL,
+	PV_CRYPTO_ERROR_NO_PUBLIC_KEY,
+	PV_CRYPTO_ERROR_INVALID_SIGNATURE_ALGORITHM,
+	PV_CRYPTO_ERROR_SIGNATURE_ALGORITHM_MISMATCH,
+	PV_CRYPTO_ERROR_INVALID_URI,
+	PV_CRYPTO_ERROR_CRL_DOWNLOAD_FAILED,
+	PV_CRYPTO_ERROR_CERT_SIGNATURE_INVALID,
+	PV_CRYPTO_ERROR_CRL_SIGNATURE_INVALID,
+	PV_CRYPTO_ERROR_CERT_SUBJECT_ISSUER_MISMATCH,
+	PV_CRYPTO_ERROR_CRL_SUBJECT_ISSUER_MISMATCH,
+	PV_CRYPTO_ERROR_NO_IBM_Z_SIGNING_KEY,
+	PV_CRYPTO_ERROR_MALFORMED_CERTIFICATE,
+	PV_CRYPTO_ERROR_NO_CRL,
+	PV_CRYPTO_ERROR_LOAD_ROOT_CA,
+	PV_CRYPTO_ERROR_LOAD_DEFAULT_CA,
+	PV_CRYPTO_ERROR_MALFORMED_ROOT_CA,
+	PV_CRYPTO_ERROR_WRONG_CA_USED,
+	PV_CRYPTO_ERROR_SKID_AKID_MISMATCH,
+	PV_CRYPTO_ERROR_NO_ISSUER_IBM_Z_FOUND,
+	PV_CRYPTO_ERROR_FAILED_DOWNLOAD_CRL,
+	PV_CRYPTO_ERROR_NO_CRLDP,
+	PV_CRYPTO_ERROR_CERT_REVOKED,
 } PvCryptoErrors;
 
 #endif

genprotimg/src/pv/pv_hdr.c

@@ -41,7 +41,7 @@ uint32_t pv_hdr_size(const PvHdr *hdr)
 
 gboolean pv_hdr_uses_encryption(const PvHdr *hdr)
 {
-	return !(GUINT64_FROM_BE(hdr->head.pcf) & PV_CFLAG_NO_DECRYPTION);
+	return !(GUINT64_FROM_BE(hdr->head.pcf) & PV_PCF_NO_DECRYPTION);
 }
 
 uint64_t pv_hdr_enc_size(const PvHdr *hdr)
@@ -76,17 +76,17 @@ uint64_t pv_hdr_get_nks(const PvHdr *hdr)
 }
 
 /* In-place modification of ``buf`` */
-static gint pv_hdr_encrypt(const PvHdr *hdr, const PvImage *img, Buffer *buf,
+static gint pv_hdr_encrypt(const PvHdr *hdr, const PvImage *img, PvBuffer *buf,
 			   GError **err)
 {
 	uint32_t hdr_len = pv_hdr_size(hdr);
 	uint32_t aad_len = pv_hdr_aad_size(hdr);
 	guint tag_len = pv_hdr_tag_size(hdr);
 	uint32_t enc_len = pv_hdr_enc_size_casted(hdr);
-	const Buffer aad_part = { .data = buf->data, .size = aad_len };
-	Buffer enc_part = { .data = (uint8_t *)buf->data + aad_len,
+	const PvBuffer aad_part = { .data = buf->data, .size = aad_len };
+	PvBuffer enc_part = { .data = (uint8_t *)buf->data + aad_len,
 			    .size = enc_len };
-	Buffer tag_part = { .data = (uint8_t *)buf->data + hdr_len - tag_len,
+	PvBuffer tag_part = { .data = (uint8_t *)buf->data + hdr_len - tag_len,
 			    .size = tag_len };
 	struct cipher_parms parms;
 	int64_t c_len;
@@ -119,9 +119,9 @@ static gint pv_hdr_aad_init(PvHdr *hdr, const PvImage *img, GError **err)
 	g_autofree union ecdh_pub_key *cust_pub_key = NULL;
 	struct pv_hdr_key_slot *hdr_slot = hdr->slots;
 	struct pv_hdr_head *head = &hdr->head;
-	g_autoptr(Buffer) pld = NULL;
-	g_autoptr(Buffer) ald = NULL;
-	g_autoptr(Buffer) tld = NULL;
+	g_autoptr(PvBuffer) pld = NULL;
+	g_autoptr(PvBuffer) ald = NULL;
+	g_autoptr(PvBuffer) tld = NULL;
 	uint64_t nep = 0;
 
 	g_assert(sizeof(head->iv) == img->gcm_iv->size);
@@ -250,7 +250,7 @@ PvHdr *pv_hdr_new(const PvImage *img, GError **err)
 	return g_steal_pointer(&ret);
 }
 
-static void pv_hdr_memcpy(const PvHdr *hdr, const Buffer *dst)
+static void pv_hdr_memcpy(const PvHdr *hdr, const PvBuffer *dst)
 {
 	uint64_t nks = pv_hdr_get_nks(hdr);
 	uint8_t *data;
@@ -270,13 +270,13 @@ static void pv_hdr_memcpy(const PvHdr *hdr, const Buffer *dst)
 	}
 }
 
-Buffer *pv_hdr_serialize(const PvHdr *hdr, const PvImage *img,
-			 enum PvCryptoMode mode, GError **err)
+PvBuffer *pv_hdr_serialize(const PvHdr *hdr, const PvImage *img,
+			   enum PvCryptoMode mode, GError **err)
 {
 	uint32_t hdr_size = pv_hdr_size(hdr);
-	g_autoptr(Buffer) ret = NULL;
+	g_autoptr(PvBuffer) ret = NULL;
 
-	ret = buffer_alloc(hdr_size);
+	ret = pv_buffer_alloc(hdr_size);
 	pv_hdr_memcpy(hdr, ret);
 
 	if (mode == PV_ENCRYPT) {

genprotimg/src/pv/pv_hdr.h

@@ -23,8 +23,8 @@
 PvHdr *pv_hdr_new(const PvImage *img, GError **err);
 void pv_hdr_free(PvHdr *hdr);
 G_GNUC_UNUSED gboolean pv_hdr_uses_encryption(const PvHdr *hdr);
-Buffer *pv_hdr_serialize(const PvHdr *hdr, const PvImage *img,
-			 enum PvCryptoMode mode, GError **err);
+PvBuffer *pv_hdr_serialize(const PvHdr *hdr, const PvImage *img,
+			   enum PvCryptoMode mode, GError **err);
 uint32_t pv_hdr_size(const PvHdr *hdr);
 uint32_t pv_hdr_aad_size(const PvHdr *hdr);
 uint64_t pv_hdr_enc_size(const PvHdr *hdr);

genprotimg/src/pv/pv_image.c

@@ -10,6 +10,7 @@
 #include <errno.h>
 #include <glib.h>
 #include <openssl/evp.h>
+#include <openssl/x509.h>
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
@@ -55,12 +56,12 @@ static gint pv_img_prepare_component(const PvImage *img, PvComponent *comp,
 				     GError **err)
 {
 	struct cipher_parms parms = { 0 };
-	g_autoptr(Buffer) tweak = NULL;
+	g_autoptr(PvBuffer) tweak = NULL;
 	prepare_func func = NULL;
 	void *opaque = NULL;
 	gint rc;
 
-	if (img->pcf & PV_CFLAG_NO_DECRYPTION) {
+	if (img->pcf & PV_PCF_NO_DECRYPTION) {
 		/* we only need to align the components */
 		func = pv_component_align;
 		opaque = NULL;
@@ -75,7 +76,7 @@ static gint pv_img_prepare_component(const PvImage *img, PvComponent *comp,
 				EVP_CIPHER_iv_length(cipher));
 		g_assert(img->xts_key->size <= UINT_MAX);
 
-		tweak = buffer_alloc(sizeof(comp->tweak.data));
+		tweak = pv_buffer_alloc(sizeof(comp->tweak.data));
 		memcpy(tweak->data, comp->tweak.data, tweak->size);
 		func = pv_component_align_and_encrypt;
 		parms.cipher = cipher;
@@ -92,11 +93,11 @@ static gint pv_img_prepare_component(const PvImage *img, PvComponent *comp,
 	return 0;
 }
 
-static Buffer *pv_img_read_key(const gchar *path, guint key_size,
-			       GError **err)
+static PvBuffer *pv_img_read_key(const gchar *path, guint key_size,
+				 GError **err)
 {
-	g_autoptr(Buffer) tmp_ret = NULL;
-	Buffer *ret = NULL;
+	g_autoptr(PvBuffer) tmp_ret = NULL;
+	PvBuffer *ret = NULL;
 	gsize bytes_read;
 	FILE *f = NULL;
 	gsize size;
@@ -115,7 +116,7 @@ static Buffer *pv_img_read_key(const gchar *path, guint key_size,
 	if (!f)
 		return NULL;
 
-	tmp_ret = buffer_alloc(size);
+	tmp_ret = pv_buffer_alloc(size);
 	if (file_read(f, tmp_ret->data, 1, tmp_ret->size, &bytes_read, err) < 0)
 		goto err;
 
@@ -138,22 +139,18 @@ static EVP_PKEY *pv_img_get_cust_pub_priv_key(gint nid, GError **err)
 	return generate_ec_key(nid, err);
 }
 
-static HostKeyList *pv_img_get_host_keys(gchar **host_cert_paths,
-					 X509_STORE *store, gint nid,
+static HostKeyList *pv_img_get_host_keys(GSList *host_keys_with_path, gint nid,
 					 GError **err)
 {
 	g_autoslist(EVP_PKEY) ret = NULL;
 
-	g_assert(host_cert_paths);
-
-	for (gchar **iterator = host_cert_paths; iterator != NULL && *iterator != NULL;
-	     iterator++) {
+	for (GSList *iterator = host_keys_with_path; iterator;
+	     iterator = iterator->next) {
+		x509_with_path *cert_with_path = iterator->data;
 		g_autoptr(EVP_PKEY) host_key = NULL;
-		const gchar *path = *iterator;
+		X509 *cert = cert_with_path->cert;
 
-		g_assert(path);
-
-		host_key = read_ec_pubkey_cert(store, nid, path, err);
+		host_key = read_ec_pubkey_cert(cert, nid, err);
 		if (!host_key)
 			return NULL;
 
@@ -163,8 +160,8 @@ static HostKeyList *pv_img_get_host_keys(gchar **host_cert_paths,
 	return g_steal_pointer(&ret);
 }
 
-static Buffer *pv_img_get_key(const EVP_CIPHER *cipher, const gchar *path,
-			      GError **err)
+static PvBuffer *pv_img_get_key(const EVP_CIPHER *cipher, const gchar *path,
+				GError **err)
 {
 	gint key_len = EVP_CIPHER_key_length(cipher);
 
@@ -176,8 +173,8 @@ static Buffer *pv_img_get_key(const EVP_CIPHER *cipher, const gchar *path,
 	return generate_aes_key((guint)key_len, err);
 }
 
-static Buffer *pv_img_get_iv(const EVP_CIPHER *cipher, const gchar *path,
-			     GError **err)
+static PvBuffer *pv_img_get_iv(const EVP_CIPHER *cipher, const gchar *path,
+			       GError **err)
 {
 	gint iv_len = EVP_CIPHER_iv_length(cipher);
 
@@ -232,7 +229,7 @@ static gint pv_img_set_psw_addr(PvImage *img, const gchar *psw_addr_s,
 }
 
 static gint pv_img_set_control_flags(PvImage *img, const gchar *pcf_s,
-				     const gchar *scf_s, GError **err)
+				     const gchar *scf_s, PvTristate allow_pckmo, GError **err)
 {
 	uint64_t flags;
 
@@ -250,13 +247,180 @@ static gint pv_img_set_control_flags(PvImage *img, const gchar *pcf_s,
 		img->scf = flags;
 	}
 
+	if (allow_pckmo == PV_TRUE)
+		img->pcf |= PV_PCF_PCKM_ECC | PV_PCF_PCKMO_AES | PV_PCF_PCKMO_DEA_TDEA;
+	else if (allow_pckmo == PV_FALSE)
+		img->pcf &= ~(PV_PCF_PCKM_ECC | PV_PCF_PCKMO_AES | PV_PCF_PCKMO_DEA_TDEA);
+
 	return 0;
 }
 
+static gint pv_img_hostkey_verify(GSList *host_key_certs,
+				  const gchar *root_ca_path,
+				  const gchar *const *crl_paths,
+				  const gchar *const *untrusted_cert_paths,
+				  gboolean offline, GError **err)
+{
+	g_autoslist(x509_with_path) untrusted_certs_with_path = NULL;
+	g_autoptr(STACK_OF_X509) ibm_signing_certs = NULL;
+	g_autoptr(STACK_OF_X509) untrusted_certs = NULL;
+	g_autoslist(x509_pair) ibm_z_pairs = NULL;
+	g_autoptr(X509_STORE) trusted = NULL;
+	gint ibm_signing_certs_count;
+
+	/* Load trusted root CAs of the system if and only if @root_ca_path is
+	 * NULL, otherwise use the root CA specified by @root_ca_path.
+	 */
+	trusted = store_setup(root_ca_path, crl_paths, err);
+	if (!trusted)
+		goto error;
+
+	if (!offline) {
+		g_autoptr(STACK_OF_X509_CRL) downloaded_ibm_signing_crls = NULL;
+
+		/* Set up the download routine for the lookup of CRLs. */
+		store_setup_crl_download(trusted);
+
+		/* Try to download the CRLs of the IBM Z signing certificates
+		 * specified in the host-key documents. Ignore download errors
+		 * as it's still possible that a CRL is specified via command
+		 * line.
+		 */
+		downloaded_ibm_signing_crls = try_load_crls_by_certs(host_key_certs);
+
+		/* Add the downloaded CRLs to the store so they can be used for
+		 * the verification later.
+		 */
+		for (int i = 0; i < sk_X509_CRL_num(downloaded_ibm_signing_crls); i++) {
+			X509_CRL *crl = sk_X509_CRL_value(downloaded_ibm_signing_crls, i);
+
+			if (X509_STORE_add_crl(trusted, crl) != 1) {
+				g_set_error(err, PV_CRYPTO_ERROR,
+					    PV_CRYPTO_ERROR_INTERNAL,
+					    _("failed to load CRL"));
+				goto error;
+			}
+		}
+	}
+
+	/* Load all untrusted certificates (e.g. IBM Z signing key and
+	 * DigiCert intermediate CA) that are required to establish a chain of
+	 * trust starting from the host-key document up to the root CA (if not
+	 * otherwise specified that's the DigiCert Assured ID Root CA).
+	 */
+	untrusted_certs_with_path = load_certificates(untrusted_cert_paths, err);
+	if (!untrusted_certs_with_path)
+		goto error;
+
+	/* Convert to STACK_OF(X509) */
+	untrusted_certs = get_x509_stack(untrusted_certs_with_path);
+
+	/* Find all IBM Z signing keys and remove them from the chain as we
+	 * have to verify that they're valid. The last step of the chain of
+	 * trust verification must be done manually, as the IBM Z signing keys
+	 * are not marked as (intermediate) CA and therefore the standard
+	 * `X509_verify_cert` function of OpenSSL cannot be used to verify the
+	 * actual host-key documents.
+	 */
+	ibm_signing_certs = delete_ibm_signing_certs(untrusted_certs);
+	ibm_signing_certs_count = sk_X509_num(ibm_signing_certs);
+	if (ibm_signing_certs_count < 1) {
+		g_set_error(err, PV_CRYPTO_ERROR, PV_CRYPTO_ERROR_NO_IBM_Z_SIGNING_KEY,
+			    _("please specify at least one IBM Z signing key"));
+		goto error;
+	} else if (ibm_signing_certs_count > 1) {
+		g_set_error(err, PV_CRYPTO_ERROR, PV_CRYPTO_ERROR_NO_IBM_Z_SIGNING_KEY,
+			    _("please specify only one IBM Z signing key"));
+		goto error;
+	}
+
+	if (store_set_verify_param(trusted, err) < 0)
+		goto error;
+
+	/* Verify that the IBM Z signing keys are trustable.
+	 * For this we must check:
+	 *
+	 * 1. Can a chain of trust be established ending in a root CA
+	 * 2. Is the correct root CA ued? It has either to be the
+	 *    'DigiCert Assured ID Root CA' or the root CA specified via
+	 *    command line.
+	 */
+	for (gint i = 0; i < sk_X509_num(ibm_signing_certs); ++i) {
+		X509 *ibm_signing_cert = sk_X509_value(ibm_signing_certs, i);
+		g_autoptr(STACK_OF_X509_CRL) ibm_signing_crls = NULL;
+		g_autoptr(X509_STORE_CTX) ctx = NULL;
+		x509_pair *pair = NULL;
+
+		g_assert(ibm_signing_cert);
+
+		/* Create the verification context and set the trusted
+		 * and chain parameters.
+		 */
+		ctx = create_store_ctx(trusted, untrusted_certs, err);
+		if (!ctx)
+			goto error;
+
+		/* Verify the IBM Z signing key */
+		if (verify_cert(ibm_signing_cert, ctx, err) < 0)
+			goto error;
+
+		/* Verify the build chain of trust chain. If the user passes a
+		 * trusted root CA on the command line then the check for the
+		 * Subject Key Identifier (SKID) is skipped, otherwise let's
+		 * check if the SKID meets our expectation.
+		 */
+		if (!root_ca_path &&
+		    check_chain_parameters(X509_STORE_CTX_get0_chain(ctx),
+					   get_digicert_assured_id_root_ca_skid(),
+					   err) < 0) {
+			goto error;
+		}
+
+		ibm_signing_crls = store_ctx_find_valid_crls(ctx, ibm_signing_cert, err);
+		if (!ibm_signing_crls) {
+			g_prefix_error(err, _("IBM Z signing key: "));
+			goto error;
+		}
+
+		/* Increment reference counter of @ibm_signing_cert as the
+		 * certificate will now also be owned by @ibm_z_pairs.
+		 */
+		if (X509_up_ref(ibm_signing_cert) != 1)
+			g_abort();
+
+		pair = x509_pair_new(&ibm_signing_cert, &ibm_signing_crls);
+		ibm_z_pairs = g_slist_append(ibm_z_pairs, pair);
+		g_assert(!ibm_signing_cert);
+		g_assert(!ibm_signing_crls);
+	}
+
+	/* Verify host-key documents by using the IBM Z signing
+	 * certificates and the corresponding certificate revocation
+	 * lists.
+	 */
+	for (GSList *iterator = host_key_certs; iterator; iterator = iterator->next) {
+		x509_with_path *host_key_with_path = iterator->data;
+		const gchar *host_key_path = host_key_with_path->path;
+		X509 *host_key = host_key_with_path->cert;
+		gint flags = X509_V_FLAG_CRL_CHECK;
+
+		if (verify_host_key(host_key, ibm_z_pairs, flags,
+				    PV_CERTS_SECURITY_LEVEL, err) < 0) {
+			g_prefix_error(err, "'%s': ", host_key_path);
+			goto error;
+		}
+	}
+
+	return 0;
+error:
+	g_prefix_error(err, _("Failed to verify host-key document: "));
+	return -1;
+}
+
 /* read in the keys or auto-generate them */
 static gint pv_img_set_keys(PvImage *img, const PvArgs *args, GError **err)
 {
-	g_autoptr(X509_STORE) store = NULL;
+	g_autoslist(x509_with_path) host_key_certs = NULL;
 
 	g_assert(img->xts_cipher);
 	g_assert(img->cust_comm_cipher);
@@ -285,8 +449,25 @@ static gint pv_img_set_keys(PvImage *img, const PvArgs *args, GError **err)
 	if (!img->cust_pub_priv_key)
 		return -1;
 
+	/* Load all host-key documents specified on the command line */
+	host_key_certs = load_certificates((const gchar **)args->host_keys,
+					   err);
+	if (!host_key_certs)
+		return -1;
+
+	if (!args->no_verify &&
+	    pv_img_hostkey_verify(host_key_certs, args->root_ca_path,
+				  (const gchar * const *)args->crl_paths,
+				  (const gchar * const *)args->untrusted_cert_paths,
+				  args->offline, err) < 0) {
+		return -1;
+	}
+
+	/* Loads the public keys stored in the host-key documents and verify
+	 * that the correct elliptic curve is used.
+	 */
 	img->host_pub_keys =
-		pv_img_get_host_keys(args->host_keys, store, img->nid, err);
+		pv_img_get_host_keys(host_key_certs, img->nid, err);
 	if (!img->host_pub_keys)
 		return -1;
 
@@ -309,23 +490,23 @@ static void pv_hdr_key_slot_free(PvHdrKeySlot *slot)
 WRAPPED_G_DEFINE_AUTOPTR_CLEANUP_FUNC(PvHdrKeySlot, pv_hdr_key_slot_free)
 
 static PvHdrKeySlot *pv_hdr_key_slot_new(const EVP_CIPHER *gcm_cipher,
-					 const Buffer *cust_root_key,
+					 const PvBuffer *cust_root_key,
 					 EVP_PKEY *cust_key, EVP_PKEY *host_key,
 					 GError **err)
 {
 	g_autoptr(PvHdrKeySlot) ret = g_new0(PvHdrKeySlot, 1);
 	g_autofree union ecdh_pub_key *pub = NULL;
-	g_autoptr(Buffer) exchange_key = NULL;
-	g_autoptr(Buffer) digest_key = NULL;
-	g_autoptr(Buffer) iv = NULL;
-	Buffer pub_buf;
+	g_autoptr(PvBuffer) exchange_key = NULL;
+	g_autoptr(PvBuffer) digest_key = NULL;
+	g_autoptr(PvBuffer) iv = NULL;
+	PvBuffer pub_buf;
 	/* No AAD data is used */
-	Buffer aad = { .data = NULL, .size = 0 };
+	PvBuffer aad = { .data = NULL, .size = 0 };
 	/* Set the output buffers for the encrypted data and the
 	 * generated GCM tag
 	 */
-	Buffer enc = { .data = ret->wrapped_key, .size = sizeof(ret->wrapped_key) };
-	Buffer tag = { .data = ret->tag, .size = sizeof(ret->tag) };
+	PvBuffer enc = { .data = ret->wrapped_key, .size = sizeof(ret->wrapped_key) };
+	PvBuffer tag = { .data = ret->tag, .size = sizeof(ret->tag) };
 	struct cipher_parms parms;
 	int64_t c_len = 0;
 
@@ -354,7 +535,7 @@ static PvHdrKeySlot *pv_hdr_key_slot_new(const EVP_CIPHER *gcm_cipher,
 	g_assert(exchange_key->size == (guint)EVP_CIPHER_key_length(gcm_cipher));
 
 	/* create zero IV */
-	iv = buffer_alloc((guint)EVP_CIPHER_iv_length(gcm_cipher));
+	iv = pv_buffer_alloc((guint)EVP_CIPHER_iv_length(gcm_cipher));
 	parms.iv_or_tweak = iv;
 	parms.key = exchange_key;
 	parms.cipher = gcm_cipher;
@@ -406,10 +587,14 @@ PvImage *pv_img_new(PvArgs *args, const gchar *stage3a_path, GError **err)
 	if (args->no_verify)
 		g_warning(_("host-key document verification is disabled. Your workload is not secured."));
 
+	if (args->root_ca_path)
+		g_warning(_("A different root CA than the default DigiCert root CA is selected. Ensure that this root CA is trusted."));
+
 	ret->comps = pv_img_comps_new(EVP_sha512(), EVP_sha512(), EVP_sha512(), err);
 	if (!ret->comps)
 		return NULL;
 
+	ret->pcf = PV_PCF_PCKMO_AES | PV_PCF_PCKMO_DEA_TDEA | PV_PCF_PCKM_ECC;
 	ret->cust_comm_cipher = EVP_aes_256_gcm();
 	ret->gcm_cipher = EVP_aes_256_gcm();
 	ret->initial_psw.addr = DEFAULT_INITIAL_PSW_ADDR;
@@ -423,7 +608,7 @@ PvImage *pv_img_new(PvArgs *args, const gchar *stage3a_path, GError **err)
 		return NULL;
 
 	/* set the control flags: PCF and SCF */
-	if (pv_img_set_control_flags(ret, args->pcf, args->scf, err) < 0)
+	if (pv_img_set_control_flags(ret, args->pcf, args->scf, args->allow_pckmo, err) < 0)
 		return NULL;
 
 	/* read in the keys */
@@ -458,13 +643,13 @@ void pv_img_free(PvImage *img)
 	g_slist_free_full(img->key_slots, (GDestroyNotify)pv_hdr_key_slot_free);
 	g_slist_free_full(img->host_pub_keys, (GDestroyNotify)EVP_PKEY_free);
 	EVP_PKEY_free(img->cust_pub_priv_key);
-	buffer_clear(&img->stage3a);
+	pv_buffer_clear(&img->stage3a);
 	pv_img_comps_free(img->comps);
 	g_free(img->tmp_dir);
-	buffer_free(img->xts_key);
-	buffer_free(img->cust_root_key);
-	buffer_free(img->gcm_iv);
-	buffer_free(img->cust_comm_key);
+	pv_buffer_free(img->xts_key);
+	pv_buffer_free(img->cust_root_key);
+	pv_buffer_free(img->gcm_iv);
+	pv_buffer_free(img->cust_comm_key);
 	g_free(img);
 }
 
@@ -505,13 +690,13 @@ gint pv_img_add_component(PvImage *img, const PvArg *arg, GError **err)
 	return 0;
 }
 
-gint pv_img_calc_pld_ald_tld_nep(const PvImage *img, Buffer **pld, Buffer **ald,
-				 Buffer **tld, uint64_t *nep, GError **err)
+gint pv_img_calc_pld_ald_tld_nep(const PvImage *img, PvBuffer **pld, PvBuffer **ald,
+				 PvBuffer **tld, uint64_t *nep, GError **err)
 {
 	return pv_img_comps_finalize(img->comps, pld, ald, tld, nep, err);
 }
 
-static gint pv_img_build_stage3b(PvImage *img, Buffer *stage3b, GError **err)
+static gint pv_img_build_stage3b(PvImage *img, PvBuffer *stage3b, GError **err)
 {
 	g_autofree struct stage3b_args *args = NULL;
 
@@ -529,7 +714,7 @@ static gint pv_img_build_stage3b(PvImage *img, Buffer *stage3b, GError **err)
 gint pv_img_add_stage3b_comp(PvImage *img, const gchar *path, GError **err)
 {
 	g_autoptr(PvComponent) comp = NULL;
-	g_autoptr(Buffer) stage3b = NULL;
+	g_autoptr(PvBuffer) stage3b = NULL;
 
 	stage3b = stage3b_getblob(path, err);
 	if (!stage3b)
@@ -646,7 +831,7 @@ static gint get_stage3a_data_size(const PvImage *img, gsize *data_size,
 
 gint pv_img_load_and_set_stage3a(PvImage *img, const gchar *path, GError **err)
 {
-	g_autoptr(Buffer) stage3a = NULL;
+	g_autoptr(PvBuffer) stage3a = NULL;
 	gsize bin_size, data_size = 0;
 
 	if (get_stage3a_data_size(img, &data_size, err) < 0)
@@ -666,8 +851,8 @@ gint pv_img_load_and_set_stage3a(PvImage *img, const gchar *path, GError **err)
 }
 
 /* Creates the PV IPIB and sets the stage3a arguments */
-static gint pv_img_build_stage3a(Buffer *stage3a, gsize stage3a_bin_size,
-				 GSList *comps, const Buffer *hdr, GError **err)
+static gint pv_img_build_stage3a(PvBuffer *stage3a, gsize stage3a_bin_size,
+				 GSList *comps, const PvBuffer *hdr, GError **err)
 {
 	g_autofree struct ipl_parameter_block *ipib = NULL;
 
@@ -687,9 +872,9 @@ static gint pv_img_build_stage3a(Buffer *stage3a, gsize stage3a_bin_size,
 }
 
 /* Creates the actual PV header (serialized and AES-GCM encrypted) */
-static Buffer *pv_img_create_pv_hdr(PvImage *img, GError **err)
+static PvBuffer *pv_img_create_pv_hdr(PvImage *img, GError **err)
 {
-	g_autoptr(Buffer) hdr_buf = NULL;
+	g_autoptr(PvBuffer) hdr_buf = NULL;
 	g_autoptr(PvHdr) hdr = NULL;
 
 	hdr = pv_hdr_new(img, err);
@@ -708,7 +893,7 @@ static Buffer *pv_img_create_pv_hdr(PvImage *img, GError **err)
  */
 gint pv_img_finalize(PvImage *pv, const gchar *stage3b_path, GError **err)
 {
-	g_autoptr(Buffer) hdr = NULL;
+	g_autoptr(PvBuffer) hdr = NULL;
 
 	/* load stage3b template into memory and add it to the list of
 	 * components. This must be done before calling

genprotimg/src/pv/pv_image.h

@@ -25,7 +25,7 @@
 
 typedef struct {
 	gchar *tmp_dir; /* directory used for temporary files */
-	Buffer *stage3a; /* stage3a containing IPIB and PV header */
+	PvBuffer *stage3a; /* stage3a containing IPIB and PV header */
 	gsize stage3a_bin_size; /* size of stage3a.bin */
 	struct psw_t stage3a_psw; /* (short) PSW that is written to
 				   * location 0 of the created image
@@ -35,15 +35,15 @@ typedef struct {
 	GSList *host_pub_keys; /* public host keys */
 	gint nid; /* Elliptic Curve used for the key derivation */
 	/* keys and cipher used for the AES-GCM encryption */
-	Buffer *cust_root_key;
-	Buffer *gcm_iv;
+	PvBuffer *cust_root_key;
+	PvBuffer *gcm_iv;
 	const EVP_CIPHER *gcm_cipher;
 	/* Information for the IPIB and PV header */
 	uint64_t pcf;
 	uint64_t scf;
-	Buffer *cust_comm_key;
+	PvBuffer *cust_comm_key;
 	const EVP_CIPHER *cust_comm_cipher;
-	Buffer *xts_key;
+	PvBuffer *xts_key;
 	const EVP_CIPHER *xts_cipher;
 	GSList *key_slots;
 	GSList *optional_items;
@@ -54,8 +54,8 @@ PvImage *pv_img_new(PvArgs *args, const gchar *stage3a_path, GError **err);
 void pv_img_free(PvImage *img);
 gint pv_img_add_component(PvImage *img, const PvArg *arg, GError **err);
 gint pv_img_finalize(PvImage *img, const gchar *stage3b_path, GError **err);
-gint pv_img_calc_pld_ald_tld_nep(const PvImage *img, Buffer **pld, Buffer **ald,
-				 Buffer **tld, uint64_t *nep, GError **err);
+gint pv_img_calc_pld_ald_tld_nep(const PvImage *img, PvBuffer **pld, PvBuffer **ald,
+				 PvBuffer **tld, uint64_t *nep, GError **err);
 gint pv_img_load_and_set_stage3a(PvImage *img, const gchar *path, GError **err);
 const PvComponent *pv_img_get_stage3b_comp(const PvImage *img, GError **err);
 gint pv_img_add_stage3b_comp(PvImage *img, const gchar *path, GError **err);

genprotimg/src/pv/pv_ipib.c

@@ -35,7 +35,7 @@ uint64_t pv_ipib_get_size(uint32_t num_comp)
 }
 
 static gint pv_ipib_init(IplParameterBlock *ipib, GSList *comps,
-			 const Buffer *hdr)
+			 const PvBuffer *hdr)
 {
 	g_assert(sizeof(struct ipl_pl_hdr) <= UINT32_MAX);
 	g_assert(sizeof(struct ipl_pb0_pv_comp) <= UINT32_MAX);
@@ -100,7 +100,7 @@ static gint pv_ipib_init(IplParameterBlock *ipib, GSList *comps,
 	return 0;
 }
 
-IplParameterBlock *pv_ipib_new(GSList *comps, const Buffer *hdr, GError **err)
+IplParameterBlock *pv_ipib_new(GSList *comps, const PvBuffer *hdr, GError **err)
 {
 	uint64_t ipib_size = pv_ipib_get_size(g_slist_length(comps));
 	g_autoptr(IplParameterBlock) ret = NULL;

genprotimg/src/pv/pv_ipib.h

@@ -19,7 +19,7 @@
 typedef struct ipl_parameter_block IplParameterBlock;
 
 uint64_t pv_ipib_get_size(uint32_t num_comp);
-IplParameterBlock *pv_ipib_new(GSList *comps, const Buffer *hdr, GError **err);
+IplParameterBlock *pv_ipib_new(GSList *comps, const PvBuffer *hdr, GError **err);
 void pv_ipib_free(IplParameterBlock *ipib);
 
 WRAPPED_G_DEFINE_AUTOPTR_CLEANUP_FUNC(IplParameterBlock, pv_ipib_free)

genprotimg/src/pv/pv_stage3.c

@@ -24,12 +24,12 @@
 	((struct stage3a_args *)((uint64_t)data_ptr + loader_size - \
 				 sizeof(struct stage3a_args)))
 
-static Buffer *loader_getblob(const gchar *filename, gsize *loader_size,
-			      gsize args_size, gsize data_size,
-			      gboolean data_aligned, GError **err)
+static PvBuffer *loader_getblob(const gchar *filename, gsize *loader_size,
+				gsize args_size, gsize data_size,
+				gboolean data_aligned, GError **err)
 {
 	g_autoptr(GMappedFile) mapped_file = NULL;
-	g_autoptr(Buffer) ret = NULL;
+	g_autoptr(PvBuffer) ret = NULL;
 	gsize size, tmp_loader_size;
 	gchar *loader_data;
 
@@ -60,7 +60,7 @@ static Buffer *loader_getblob(const gchar *filename, gsize *loader_size,
 	size = (data_aligned ? PAGE_ALIGN(tmp_loader_size) : tmp_loader_size) +
 	       data_size;
 
-	ret = buffer_alloc(size);
+	ret = pv_buffer_alloc(size);
 
 	/* copy the loader "template" */
 	memcpy(ret->data, loader_data, tmp_loader_size);
@@ -71,8 +71,8 @@ static Buffer *loader_getblob(const gchar *filename, gsize *loader_size,
 	return g_steal_pointer(&ret);
 }
 
-Buffer *stage3a_getblob(const gchar *filename, gsize *loader_size,
-			gsize data_size, GError **err)
+PvBuffer *stage3a_getblob(const gchar *filename, gsize *loader_size,
+			  gsize data_size, GError **err)
 {
 	return loader_getblob(filename, loader_size,
 			      sizeof(struct stage3a_args), data_size, TRUE,
@@ -83,8 +83,8 @@ Buffer *stage3a_getblob(const gchar *filename, gsize *loader_size,
 /* Set the right offsets and sizes in the stage3a template + add
  * the IPIB block with the PV header
  */
-static gint stage3a_set_data(Buffer *loader, gsize loader_size,
-			     const Buffer *hdr, struct ipl_parameter_block *ipib,
+static gint stage3a_set_data(PvBuffer *loader, gsize loader_size,
+			     const PvBuffer *hdr, struct ipl_parameter_block *ipib,
 			     GError **err)
 {
 	uint32_t ipib_size = GUINT32_FROM_BE(ipib->hdr.len);
@@ -126,15 +126,15 @@ static gint stage3a_set_data(Buffer *loader, gsize loader_size,
 	return 0;
 }
 
-gint build_stage3a(Buffer *loader, gsize loader_size, const Buffer *hdr,
+gint build_stage3a(PvBuffer *loader, gsize loader_size, const PvBuffer *hdr,
 		   struct ipl_parameter_block *ipib, GError **err)
 {
 	return stage3a_set_data(loader, loader_size, hdr, ipib, err);
 }
 
-Buffer *stage3b_getblob(const gchar *filename, GError **err)
+PvBuffer *stage3b_getblob(const gchar *filename, GError **err)
 {
-	g_autoptr(Buffer) ret = NULL;
+	g_autoptr(PvBuffer) ret = NULL;
 	gsize rb_size;
 
 	ret = loader_getblob(filename, &rb_size, sizeof(struct stage3b_args), 0,
@@ -146,7 +146,7 @@ Buffer *stage3b_getblob(const gchar *filename, GError **err)
 	return g_steal_pointer(&ret);
 }
 
-void build_stage3b(Buffer *stage3b, const struct stage3b_args *args)
+void build_stage3b(PvBuffer *stage3b, const struct stage3b_args *args)
 {
 	g_assert(stage3b->size > sizeof(*args));
 

genprotimg/src/pv/pv_stage3.h

@@ -19,12 +19,12 @@
 #include "boot/stage3b.h"
 #include "utils/buffer.h"
 
-Buffer *stage3a_getblob(const gchar *filename, gsize *loader_size,
-			gsize data_size, GError **err);
-gint build_stage3a(Buffer *dc, gsize dc_size, const Buffer *hdr,
+PvBuffer *stage3a_getblob(const gchar *filename, gsize *loader_size,
+			  gsize data_size, GError **err);
+gint build_stage3a(PvBuffer *dc, gsize dc_size, const PvBuffer *hdr,
 		   struct ipl_parameter_block *ipib, GError **err);
-Buffer *stage3b_getblob(const gchar *filename, GError **err);
-void build_stage3b(Buffer *stage3b, const struct stage3b_args *args);
+PvBuffer *stage3b_getblob(const gchar *filename, GError **err);
+void build_stage3b(PvBuffer *stage3b, const struct stage3b_args *args);
 void memblob_init(struct memblob *arg, uint64_t src, uint64_t size);
 
 #endif

genprotimg/src/utils/buffer.c

@@ -17,18 +17,18 @@
 #include "common.h"
 #include "file_utils.h"
 
-Buffer *buffer_alloc(gsize size)
+PvBuffer *pv_buffer_alloc(gsize size)
 {
-	Buffer *ret = g_new0(Buffer, 1);
+	PvBuffer *ret = g_new0(PvBuffer, 1);
 
 	ret->data = g_malloc0(size);
 	ret->size = size;
 	return ret;
 }
 
-Buffer *buffer_dup(const Buffer *buf, gboolean page_aligned)
+PvBuffer *pv_buffer_dup(const PvBuffer *buf, gboolean page_aligned)
 {
-	Buffer *ret;
+	PvBuffer *ret;
 	gsize size;
 
 	if (!buf)
@@ -38,19 +38,19 @@ Buffer *buffer_dup(const Buffer *buf, gboolean page_aligned)
 	if (page_aligned)
 		size = PAGE_ALIGN(size);
 
-	ret = buffer_alloc(size);
+	ret = pv_buffer_alloc(size);
 
 	/* content will be 0-right-padded */
 	memcpy(ret->data, buf->data, buf->size);
 	return ret;
 }
 
-gint buffer_write(const Buffer *buf, FILE *file, GError **err)
+gint pv_buffer_write(const PvBuffer *buf, FILE *file, GError **err)
 {
 	return file_write(file, buf->data, buf->size, 1, NULL, err);
 }
 
-void buffer_free(Buffer *buf)
+void pv_buffer_free(PvBuffer *buf)
 {
 	if (!buf)
 		return;
@@ -59,11 +59,11 @@ void buffer_free(Buffer *buf)
 	g_free(buf);
 }
 
-void buffer_clear(Buffer **buf)
+void pv_buffer_clear(PvBuffer **buf)
 {
 	if (!buf || !*buf)
 		return;
 
-	buffer_free(*buf);
+	pv_buffer_free(*buf);
 	*buf = NULL;
 }

genprotimg/src/utils/buffer.h

@@ -15,17 +15,17 @@
 
 #include "common.h"
 
-typedef struct Buffer {
+typedef struct PvBuffer {
 	void *data;
 	gsize size; /* in bytes */
-} Buffer;
+} PvBuffer;
 
-Buffer *buffer_alloc(gsize size);
-void buffer_free(Buffer *buf);
-void buffer_clear(Buffer **buf);
-gint buffer_write(const Buffer *buf, FILE *file, GError **err);
-Buffer *buffer_dup(const Buffer *buf, gboolean page_aligned);
+PvBuffer *pv_buffer_alloc(gsize size);
+void pv_buffer_free(PvBuffer *buf);
+void pv_buffer_clear(PvBuffer **buf);
+gint pv_buffer_write(const PvBuffer *buf, FILE *file, GError **err);
+PvBuffer *pv_buffer_dup(const PvBuffer *buf, gboolean page_aligned);
 
-WRAPPED_G_DEFINE_AUTOPTR_CLEANUP_FUNC(Buffer, buffer_free)
+WRAPPED_G_DEFINE_AUTOPTR_CLEANUP_FUNC(PvBuffer, pv_buffer_free)
 
 #endif

genprotimg/src/utils/crypto.h

@@ -11,14 +11,18 @@
 #define PV_UTILS_CRYPTO_H
 
 #include <glib.h>
+#include <openssl/asn1.h>
 #include <openssl/bio.h>
 #include <openssl/bn.h>
 #include <openssl/ec.h>
 #include <openssl/ecdh.h>
 #include <openssl/evp.h>
+#include <openssl/ossl_typ.h>
 #include <openssl/rand.h>
+#include <openssl/safestack.h>
 #include <openssl/sha.h>
 #include <openssl/x509.h>
+#include <openssl/x509v3.h>
 #include <stdint.h>
 
 #include "common.h"
@@ -33,6 +37,9 @@
 #define AES_256_XTS_TWEAK_SIZE 16
 #define AES_256_XTS_KEY_SIZE   64
 
+#define CRL_DOWNLOAD_TIMEOUT_MS 3000
+#define CRL_DOWNLOAD_MAX_SIZE	(1024 * 1024) /* in bytes */
+
 enum PvCryptoMode {
 	PV_ENCRYPT,
 	PV_DECRYPT,
@@ -40,7 +47,34 @@ enum PvCryptoMode {
 
 typedef GSList HostKeyList;
 
+/* play nice with g_autoptr */
+typedef STACK_OF(DIST_POINT) STACK_OF_DIST_POINT;
+typedef STACK_OF(X509) STACK_OF_X509;
+typedef STACK_OF(X509_CRL) STACK_OF_X509_CRL;
+
+void STACK_OF_DIST_POINT_free(STACK_OF_DIST_POINT *stack);
+void STACK_OF_X509_free(STACK_OF_X509 *stack);
+void STACK_OF_X509_CRL_free(STACK_OF_X509_CRL *stack);
+
+typedef struct {
+	X509 *cert;
+	const gchar *path;
+} x509_with_path;
+
+x509_with_path *x509_with_path_new(X509 *cert, const gchar *path);
+void x509_with_path_free(x509_with_path *cert);
+
+typedef struct {
+	X509 *cert;
+	STACK_OF_X509_CRL *crls;
+} x509_pair;
+
+x509_pair *x509_pair_new(X509 **cert, STACK_OF_X509_CRL **crls);
+void x509_pair_free(x509_pair *pair);
+
 /* Register auto cleanup functions */
+WRAPPED_G_DEFINE_AUTOPTR_CLEANUP_FUNC(ASN1_INTEGER, ASN1_INTEGER_free)
+WRAPPED_G_DEFINE_AUTOPTR_CLEANUP_FUNC(ASN1_OCTET_STRING, ASN1_OCTET_STRING_free)
 WRAPPED_G_DEFINE_AUTOPTR_CLEANUP_FUNC(BIGNUM, BN_free)
 WRAPPED_G_DEFINE_AUTOPTR_CLEANUP_FUNC(BIO, BIO_free_all)
 WRAPPED_G_DEFINE_AUTOPTR_CLEANUP_FUNC(BN_CTX, BN_CTX_free)
@@ -51,10 +85,18 @@ WRAPPED_G_DEFINE_AUTOPTR_CLEANUP_FUNC(EVP_CIPHER_CTX, EVP_CIPHER_CTX_free)
 WRAPPED_G_DEFINE_AUTOPTR_CLEANUP_FUNC(EVP_MD_CTX, EVP_MD_CTX_free)
 WRAPPED_G_DEFINE_AUTOPTR_CLEANUP_FUNC(EVP_PKEY, EVP_PKEY_free)
 WRAPPED_G_DEFINE_AUTOPTR_CLEANUP_FUNC(EVP_PKEY_CTX, EVP_PKEY_CTX_free)
+WRAPPED_G_DEFINE_AUTOPTR_CLEANUP_FUNC(STACK_OF_DIST_POINT, STACK_OF_DIST_POINT_free);
+WRAPPED_G_DEFINE_AUTOPTR_CLEANUP_FUNC(STACK_OF_X509, STACK_OF_X509_free);
+WRAPPED_G_DEFINE_AUTOPTR_CLEANUP_FUNC(STACK_OF_X509_CRL, STACK_OF_X509_CRL_free);
 WRAPPED_G_DEFINE_AUTOPTR_CLEANUP_FUNC(X509, X509_free)
+WRAPPED_G_DEFINE_AUTOPTR_CLEANUP_FUNC(X509_CRL, X509_CRL_free)
 WRAPPED_G_DEFINE_AUTOPTR_CLEANUP_FUNC(X509_LOOKUP, X509_LOOKUP_free)
+WRAPPED_G_DEFINE_AUTOPTR_CLEANUP_FUNC(X509_NAME, X509_NAME_free)
+WRAPPED_G_DEFINE_AUTOPTR_CLEANUP_FUNC(x509_pair, x509_pair_free)
 WRAPPED_G_DEFINE_AUTOPTR_CLEANUP_FUNC(X509_STORE, X509_STORE_free)
 WRAPPED_G_DEFINE_AUTOPTR_CLEANUP_FUNC(X509_STORE_CTX, X509_STORE_CTX_free)
+WRAPPED_G_DEFINE_AUTOPTR_CLEANUP_FUNC(X509_VERIFY_PARAM, X509_VERIFY_PARAM_free)
+WRAPPED_G_DEFINE_AUTOPTR_CLEANUP_FUNC(x509_with_path, x509_with_path_free)
 
 union cmp_index {
 	struct {
@@ -75,30 +117,59 @@ union tweak {
 
 struct cipher_parms {
 	const EVP_CIPHER *cipher;
-	const Buffer *key;
-	const Buffer *iv_or_tweak;
+	const PvBuffer *key;
+	const PvBuffer *iv_or_tweak;
 };
 
-EVP_PKEY *read_ec_pubkey_cert(X509_STORE *store, gint nid, const gchar *path,
-			      GError **err);
-Buffer *compute_exchange_key(EVP_PKEY *cust, EVP_PKEY *host, GError **err);
-Buffer *generate_aes_key(guint size, GError **err);
-Buffer *generate_aes_iv(guint size, GError **err);
+int check_crl_valid_for_cert(X509_CRL *crl, X509 *cert,
+			     gint verify_flags, GError **err);
+void pv_crypto_init(void);
+void pv_crypto_cleanup(void);
+const ASN1_OCTET_STRING *get_digicert_assured_id_root_ca_skid(void);
+gint verify_host_key(X509 *host_key, GSList *issuer_pairs,
+		     gint verify_flags, int level, GError **err);
+X509 *load_cert_from_file(const char *path, GError **err);
+X509_CRL *load_crl_from_file(const gchar *path, GError **err);
+GSList *load_certificates(const gchar *const *cert_paths, GError **err);
+STACK_OF_X509 *get_x509_stack(const GSList *x509_with_path_list);
+X509_STORE *store_setup(const gchar *root_ca_path,
+			const gchar * const *crl_paths,
+			GError **err);
+int store_set_verify_param(X509_STORE *store, GError **err);
+X509_CRL *load_crl_by_cert(X509 *cert, GError **err);
+STACK_OF_X509_CRL *try_load_crls_by_certs(GSList *certs_with_path);
+gint check_chain_parameters(const STACK_OF_X509 *chain,
+			    const ASN1_OCTET_STRING *skid, GError **err);
+X509_NAME *c2b_name(const X509_NAME *name);
+
+STACK_OF_X509 *delete_ibm_signing_certs(STACK_OF_X509 *certs);
+STACK_OF_X509_CRL *store_ctx_find_valid_crls(X509_STORE_CTX *ctx, X509 *cert,
+					     GError **err);
+X509_STORE_CTX *create_store_ctx(X509_STORE *trusted, STACK_OF_X509 *chain,
+				 GError **err);
+gint verify_cert(X509 *cert, X509_STORE_CTX *ctx, GError **err);
+X509_CRL *get_first_valid_crl(X509_STORE_CTX *ctx, X509 *cert, GError **err);
+void store_setup_crl_download(X509_STORE *st);
+EVP_PKEY *read_ec_pubkey_cert(X509 *cert, gint nid, GError **err);
+
+PvBuffer *compute_exchange_key(EVP_PKEY *cust, EVP_PKEY *host, GError **err);
+PvBuffer *generate_aes_key(guint size, GError **err);
+PvBuffer *generate_aes_iv(guint size, GError **err);
 EVP_PKEY *generate_ec_key(gint nid, GError **err);
 gint generate_tweak(union tweak *tweak, uint16_t i, GError **err);
 union ecdh_pub_key *evp_pkey_to_ecdh_pub_key(EVP_PKEY *key, GError **err);
 EVP_MD_CTX *digest_ctx_new(const EVP_MD *md, GError **err);
-Buffer *digest_ctx_finalize(EVP_MD_CTX *ctx, GError **err);
-Buffer *sha256_buffer(const Buffer *buf, GError **err);
-int64_t gcm_encrypt(const Buffer *in, const Buffer *aad,
-		    const struct cipher_parms *parms, Buffer *out,
-		    Buffer *tag, GError **err);
+PvBuffer *digest_ctx_finalize(EVP_MD_CTX *ctx, GError **err);
+PvBuffer *sha256_buffer(const PvBuffer *buf, GError **err);
+int64_t gcm_encrypt(const PvBuffer *in, const PvBuffer *aad,
+		    const struct cipher_parms *parms, PvBuffer *out,
+		    PvBuffer *tag, GError **err);
 gint encrypt_file(const struct cipher_parms *parms, const gchar *in_path,
 		  const gchar *path_out, gsize *in_size, gsize *out_size,
 		  GError **err);
-Buffer *encrypt_buf(const struct cipher_parms *parms, const Buffer *in,
-		    GError **err);
-G_GNUC_UNUSED Buffer *decrypt_buf(const struct cipher_parms *parms,
-				  const Buffer *in, GError **err);
+PvBuffer *encrypt_buf(const struct cipher_parms *parms, const PvBuffer *in,
+		      GError **err);
+G_GNUC_UNUSED PvBuffer *decrypt_buf(const struct cipher_parms *parms,
+				    const PvBuffer *in, GError **err);
 
 #endif

genprotimg/src/utils/curl.c

@@ -0,0 +1,121 @@
+/*
+ * Libcurl utils
+ *
+ * Copyright IBM Corp. 2020
+ *
+ * s390-tools is free software; you can redistribute it and/or modify
+ * it under the terms of the MIT license. See LICENSE for details.
+ */
+
+#include <stdio.h>
+#include <glib.h>
+#include <glib/gtypes.h>
+#include <curl/curl.h>
+
+#include "lib/zt_common.h"
+#include "pv/pv_error.h"
+
+#include "curl.h"
+
+struct UserData {
+	GByteArray *buffer;
+	guint max_size;
+};
+
+static size_t write_callback(char *ptr, size_t size, size_t nmemb, void *userdata)
+{
+	g_assert(userdata);
+	struct UserData *data = (struct UserData *)userdata;
+	GByteArray *buffer = data->buffer;
+	guint64 actual_size;
+	size_t err;
+
+	g_assert(buffer);
+
+	if (!g_uint64_checked_mul(&actual_size, size, nmemb))
+		g_abort();
+
+	/* Signal an error condition by returning a amount that differs
+	 * from the amount passed to the callback. This results in a
+	 * CURLE_WRITE_ERROR.
+	 */
+	err = actual_size + 1;
+
+	if (actual_size > G_MAXUINT)
+		return err;
+
+	data->buffer = g_byte_array_append(buffer, (guchar *)ptr, (guint)actual_size);
+	if (data->buffer->len > data->max_size)
+		return err;
+
+	return actual_size;
+}
+
+gint curl_init(void)
+{
+	if (curl_global_init(CURL_GLOBAL_ALL) != 0)
+		return -1;
+	return 0;
+}
+
+void curl_cleanup(void)
+{
+	curl_global_cleanup();
+}
+
+GByteArray *curl_download(const gchar *url, long timeout_ms, guint max_size,
+			  GError **err)
+{
+	g_autoptr(GByteArray) ret = NULL;
+	g_autoptr(CURL) handle = NULL;
+	g_autofree gchar *agent = NULL;
+	struct UserData userdata;
+	CURLcode rc;
+
+	/* set up curl session */
+	handle = curl_easy_init();
+	if (!handle)
+		g_abort();
+
+	/* follow redirection */
+	rc = curl_easy_setopt(handle, CURLOPT_FOLLOWLOCATION, 1l);
+	if (rc != CURLE_OK)
+		goto curl_err;
+	rc = curl_easy_setopt(handle, CURLOPT_TIMEOUT_MS, timeout_ms);
+	if (rc != CURLE_OK)
+		goto curl_err;
+	rc = curl_easy_setopt(handle, CURLOPT_NOSIGNAL, 1l);
+	if (rc != CURLE_OK)
+		goto curl_err;
+	agent = g_strdup_printf("%s/%s", tool_name, RELEASE_STRING);
+	rc = curl_easy_setopt(handle, CURLOPT_USERAGENT, agent);
+	if (rc != CURLE_OK)
+		goto curl_err;
+	rc = curl_easy_setopt(handle, CURLOPT_WRITEFUNCTION, write_callback);
+	if (rc != CURLE_OK)
+		goto curl_err;
+	ret = g_byte_array_new();
+	userdata.buffer = ret;
+	userdata.max_size = max_size;
+	rc =  curl_easy_setopt(handle, CURLOPT_WRITEDATA, (void *)&userdata);
+	if (rc != CURLE_OK)
+		goto curl_err;
+	rc =  curl_easy_setopt(handle, CURLOPT_URL, url);
+	if (rc != CURLE_OK)
+		goto curl_err;
+
+	rc = curl_easy_perform(handle);
+	if (rc != CURLE_OK) {
+		g_set_error(err, PV_ERROR, PV_ERROR_DOWNLOAD_FAILED,
+			    _("download failed: %s"), curl_easy_strerror(rc));
+		return NULL;
+	}
+
+	return g_steal_pointer(&ret);
+curl_err:
+	g_set_error(err, PV_ERROR,
+		    PV_ERROR_CURL_INIT_FAILED,
+		    _("cURL initialization failed: %s"),
+		    curl_easy_strerror(rc));
+	return NULL;
+}

genprotimg/src/utils/curl.h

@@ -0,0 +1,25 @@
+/*
+ * Libcurl utils
+ *
+ * Copyright IBM Corp. 2020
+ *
+ * s390-tools is free software; you can redistribute it and/or modify
+ * it under the terms of the MIT license. See LICENSE for details.
+ */
+
+#ifndef PV_UTILS_LIBCURL_H
+#define PV_UTILS_LIBCURL_H
+
+#include <glib.h>
+#include <curl/curl.h>
+
+#include "common.h"
+
+WRAPPED_G_DEFINE_AUTOPTR_CLEANUP_FUNC(CURL, curl_easy_cleanup)
+
+GByteArray *curl_download(const gchar *url, long timeout_ms, guint max_size,
+			  GError **err);
+gint curl_init(void);
+void curl_cleanup(void);
+
+#endif /* PV_UTILS_LIBCURL_H */

genprotimg/src/utils/file_utils.c

@@ -171,13 +171,13 @@ err:
 	return ret;
 }
 
-gint seek_and_write_buffer(FILE *o, const Buffer *buf, uint64_t offset,
+gint seek_and_write_buffer(FILE *o, const PvBuffer *buf, uint64_t offset,
 			   GError **err)
 {
 	if (file_seek(o, offset, err) < 0)
 		return -1;
 
-	if (buffer_write(buf, o, err) < 0)
+	if (pv_buffer_write(buf, o, err) < 0)
 		return -1;
 
 	return 0;

genprotimg/src/utils/file_utils.h

@@ -26,7 +26,7 @@ gint file_write(FILE *out, const void *ptr, gsize size, gsize count,
 		gsize *count_written, GError **err);
 gint pad_file_right(const gchar *path_out, const gchar *path_in,
 		    gsize *size_out, guint padding, GError **err);
-gint seek_and_write_buffer(FILE *out, const Buffer *buf, uint64_t offset,
+gint seek_and_write_buffer(FILE *out, const PvBuffer *buf, uint64_t offset,
 			   GError **err);
 gint seek_and_write_file(FILE *o, const CompFile *ifile, uint64_t offset,
 			 GError **err);

genprotimg/src/utils/openssl_compat.h

@@ -0,0 +1,33 @@
+/*
+ * OpenSSL compatibility utils
+ *
+ * Copyright IBM Corp. 2021
+ *
+ * s390-tools is free software; you can redistribute it and/or modify
+ * it under the terms of the MIT license. See LICENSE for details.
+ */
+
+#ifndef PV_UTILS_OPENSSL_COMPAT_H
+#define PV_UTILS_OPENSSL_COMPAT_H
+
+#include <openssl/opensslv.h>
+#include <openssl/x509.h>
+#include <openssl/x509_vfy.h>
+
+#if OPENSSL_VERSION_NUMBER < 0x30000000L
+#define Pv_X509_STORE_CTX_get_current_cert(ctx)                                \
+	X509_STORE_CTX_get_current_cert((X509_STORE_CTX *)(ctx))
+#define Pv_X509_STORE_CTX_get1_crls(ctx, nm)                                   \
+	X509_STORE_CTX_get1_crls((X509_STORE_CTX *)(ctx), (X509_NAME *)(nm))
+#define Pv_X509_STORE_set_lookup_crls(st, cb)                                  \
+	X509_STORE_set_lookup_crls(st, (X509_STORE_CTX_lookup_crls_fn)(cb))
+#else
+#define Pv_X509_STORE_CTX_get_current_cert(ctx)                                \
+	X509_STORE_CTX_get_current_cert(ctx)
+#define Pv_X509_STORE_CTX_get1_crls(ctx, nm)                                   \
+	X509_STORE_CTX_get1_crls(ctx, nm)
+#define Pv_X509_STORE_set_lookup_crls(st, cb)                                  \
+	X509_STORE_set_lookup_crls(st, cb)
+#endif
+
+#endif

hsavmcore/Makefile

@@ -0,0 +1,86 @@
+#
+# Copyright IBM Corp. 2021
+#
+# s390-tools is free software; you can redistribute it and/or modify
+# it under the terms of the MIT license. See LICENSE for details.
+#
+
+include ../common.mak
+
+ALL_CPPFLAGS += -D_FILE_OFFSET_BITS=64
+
+ifeq (${HAVE_FUSE},0)
+
+all:
+	$(SKIP) HAVE_FUSE=0
+
+install:
+	$(SKIP) HAVE_FUSE=0
+
+else # HAVE_FUSE
+
+#
+# FUSE
+#
+ifneq ($(shell sh -c 'command -v pkg-config'),)
+  FUSE_CFLAGS = $(shell pkg-config --silence-errors --cflags fuse)
+  FUSE_LDLIBS = $(shell pkg-config --silence-errors --libs fuse)
+else
+  FUSE_CFLAGS = -I/usr/include/fuse
+  FUSE_LDLIBS = -lfuse
+endif
+
+#
+# systemd
+#
+ifneq (${HAVE_SYSTEMD},0)
+  ifeq ($(call check_header_prereq,"systemd/sd-daemon.h"),yes)
+    ifneq ($(shell sh -c 'command -v pkg-config'),)
+      SYSTEMD_CFLAGS = $(shell pkg-config --silence-errors --cflags libsystemd)
+      SYSTEMD_LDLIBS = $(shell pkg-config --silence-errors --libs libsystemd)
+    else
+      SYSTEMD_CFLAGS =
+      SYSTEMD_LDLIBS = -lsystemd
+    endif
+    ALL_CPPFLAGS += -DHAVE_SYSTEMD
+  else
+    $(warning "systemd support disabled")
+  endif
+endif
+
+ALL_CFLAGS += $(FUSE_CFLAGS) $(SYSTEMD_CFLAGS)
+LDLIBS += $(FUSE_LDLIBS) $(SYSTEMD_LDLIBS) -lpthread
+
+sources := $(wildcard *.c)
+objects := $(patsubst %.c,%.o,$(sources))
+
+libs = $(rootdir)/libutil/libutil.a
+
+all: hsavmcore
+
+hsavmcore: $(objects) $(libs)
+	$(LINK) $(ALL_LDFLAGS) $^ $(LDLIBS) -o $@
+
+overlay.o: check-dep-fuse overlay.c overlay.h
+
+check-dep-fuse:
+	$(call check_dep, \
+		"hsavmcore", \
+		"fuse.h", \
+		"fuse-devel or libfuse-dev", \
+		"HAVE_FUSE=0")
+
+install: all
+	$(INSTALL) -g $(GROUP) -o $(OWNER) -m 755 hsavmcore \
+		$(DESTDIR)$(USRSBINDIR)
+	$(INSTALL) -g $(GROUP) -o $(OWNER) -m 644 man/hsavmcore.8 \
+		$(DESTDIR)$(MANDIR)/man8
+	$(INSTALL) -g $(GROUP) -o $(OWNER) -m 644 man/hsavmcore.conf.5 \
+		$(DESTDIR)$(MANDIR)/man5
+
+endif # HAVE_FUSE
+
+clean:
+	rm -f hsavmcore $(objects)
+
+.PHONY: all install clean

hsavmcore/cmdline_options.c

@@ -0,0 +1,219 @@
+/*
+ * Copyright IBM Corp. 2021
+ *
+ * s390-tools is free software; you can redistribute it and/or modify
+ * it under the terms of the MIT license. See LICENSE for details.
+ */
+
+#include <limits.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+
+#include "lib/zt_common.h"
+#include "lib/util_opt.h"
+#include "lib/util_prg.h"
+#include "lib/util_log.h"
+
+#include "cmdline_options.h"
+
+static const struct util_prg prg = {
+	.desc = "hsavmcore is designed to make the dump process with kdump more "
+		"efficient. The HSA memory contains a part of the production "
+		"kernel's memory. Use hsavmcore to cache this information and "
+		"release HSA memory early in the process.",
+	.copyright_vec = {
+		{
+			.owner = "IBM Corp.",
+			.pub_first = 2021,
+			.pub_last = 2021,
+		},
+		UTIL_PRG_COPYRIGHT_END
+	}
+};
+
+static struct util_opt opt_vec[] = {
+	UTIL_OPT_SECTION("CONFIGURATION"),
+	{
+		.option = { "config", required_argument, NULL, 'c' },
+		.argument = "CONFIGFILE",
+		.desc = "Path to the configuration file.\n"
+			"Default: no configuration file is used",
+	},
+	{
+		.option = { "vmcore", required_argument, NULL, 'C' },
+		.argument = "VMCOREFILE",
+		.desc = "Path to the vmcore file.\n"
+			"Default: " PROC_VMCORE,
+	},
+	{
+		.option = { "hsa", required_argument, NULL, 'H' },
+		.argument = "ZCOREHSAFILE",
+		.desc = "Path to the zcore HSA file.\n"
+			"Default: " ZCORE_HSA,
+	},
+	{
+		.option = { "workdir", required_argument, NULL, 'W' },
+		.argument = "WORKDIR",
+		.desc = "Path to the work directory where temporary files can be "
+			"stored.\nDefault: " WORKDIR,
+	},
+	{
+		.option = { "bmvmcore", required_argument, NULL, 'B' },
+		.argument = "VMCOREFILE",
+		.desc = "Path to the target of the bind mount for the vmcore "
+			"replacement.\nDefault: " PROC_VMCORE,
+	},
+	{
+		.option = { "swap", required_argument, NULL, 'S' },
+		.argument = "PATH",
+		.desc = "Path to a swap device or file. The specified swap "
+			"device or file must exist and have the proper swap "
+			"format.\nDefault: no swap device or file is activated",
+	},
+	{
+		.option = { "hsasize", required_argument, NULL, 'T' },
+		.argument = "HSASIZE",
+		.desc = "HSA size in bytes.\n"
+			"Default: -1 (read from the zcore HSA file)",
+	},
+	{
+		.option = { "dbgfsmnt", no_argument, NULL, 'D' },
+		.desc = "Mount the debug file system.\n"
+			"Default: the debug file system is not mounted",
+	},
+	{
+		.option = { "hsamem", no_argument, NULL, 'F' },
+		.desc = "Cache the HSA memory in regular memory.\n"
+			"Default: the HSA memory is cached as a file within "
+			"WORKDIR",
+	},
+	{
+		.option = { "norelhsa", no_argument, NULL, 'R' },
+		.desc = "Do NOT release the HSA memory after caching.\n"
+			"Default: the HSA memory is released",
+	},
+	{
+		.option = { "nobindmnt", no_argument, NULL, 'N' },
+		.desc = "Do NOT replace the system's vmcore.\n"
+			"Default: the system's vmcore is replaced",
+	},
+	UTIL_OPT_SECTION("LOGGING"),
+	{
+		.option = { "verbose", no_argument, NULL, 'V' },
+		.desc = "Print verbose messages to stdout. Repeat this option "
+			"for increased verbosity from just error messages to "
+			"also include warning,  information, debug, and trace "
+			"messages. This option is intended for debugging",
+	},
+	{
+		.option = { "fusedbg", no_argument, NULL, 'G' },
+		.desc = "Enable FUSE debugging.\n"
+			"Default: FUSE debugging is disabled",
+	},
+	UTIL_OPT_SECTION("GENERAL OPTIONS"),
+	UTIL_OPT_HELP,
+	UTIL_OPT_VERSION,
+	UTIL_OPT_END
+};
+
+void parse_cmdline_options(int argc, char *argv[], struct config *config)
+{
+	int opt, ret;
+
+	util_prg_init(&prg);
+	util_opt_init(opt_vec, NULL);
+
+	/* Parse given command-line config */
+	while (1) {
+		opt = util_opt_getopt_long(argc, argv);
+		if (opt == -1)
+			break;
+
+		switch (opt) {
+		case 'h':
+			util_prg_print_help();
+			util_opt_print_help();
+			exit(EXIT_SUCCESS);
+		case 'v':
+			util_prg_print_version();
+			exit(EXIT_SUCCESS);
+		case 'V':
+			config->verbose++;
+			util_log_set_level(config->verbose);
+			break;
+		case 'c':
+			ret = update_config_from_file(optarg, config);
+			if (ret < 0)
+				exit(EXIT_FAILURE);
+			util_log_set_level(config->verbose);
+			break;
+		case 'C':
+			strncpy(config->vmcore_path, optarg,
+				sizeof(config->vmcore_path) - 1);
+			/* Ensure null termination */
+			config->vmcore_path[sizeof(config->vmcore_path) - 1] =
+				'\0';
+			break;
+		case 'H':
+			strncpy(config->zcore_hsa_path, optarg,
+				sizeof(config->zcore_hsa_path) - 1);
+			/* Ensure null termination */
+			config->zcore_hsa_path[sizeof(config->zcore_hsa_path) -
+					       1] = '\0';
+			break;
+		case 'W':
+			strncpy(config->workdir_path, optarg,
+				sizeof(config->workdir_path) - 1);
+			/* Ensure null termination */
+			config->workdir_path[sizeof(config->workdir_path) - 1] =
+				'\0';
+			break;
+		case 'B':
+			strncpy(config->bind_mount_vmcore_path, optarg,
+				sizeof(config->bind_mount_vmcore_path) - 1);
+			/* Ensure null termination */
+			config->bind_mount_vmcore_path
+				[sizeof(config->bind_mount_vmcore_path) - 1] =
+				'\0';
+			break;
+		case 'S':
+			strncpy(config->swap, optarg, sizeof(config->swap) - 1);
+			/* Ensure null termination */
+			config->swap[sizeof(config->swap) - 1] = '\0';
+			break;
+		case 'T': {
+			char *endptr;
+			long hsa_size = strtol(optarg, &endptr, 0);
+
+			if (*endptr != '\0' || hsa_size < -1 ||
+			    hsa_size > INT_MAX) {
+				fprintf(stderr,
+					"The given HSA size is invalid.\n");
+				exit(EXIT_FAILURE);
+			}
+			config->hsa_size = hsa_size;
+			break;
+		}
+		case 'D':
+			config->mount_debugfs = true;
+			break;
+		case 'F':
+			config->use_hsa_mem = true;
+			break;
+		case 'R':
+			config->release_hsa = false;
+			break;
+		case 'N':
+			config->bind_mount_vmcore = false;
+			break;
+		case 'G':
+			config->fuse_debug = true;
+			break;
+		case '?':
+		default:
+			util_opt_print_parse_error(opt, argv);
+			exit(EXIT_FAILURE);
+		}
+	}
+}

hsavmcore/cmdline_options.h

@@ -0,0 +1,19 @@
+/*
+ * Copyright IBM Corp. 2021
+ *
+ * s390-tools is free software; you can redistribute it and/or modify
+ * it under the terms of the MIT license. See LICENSE for details.
+ */
+
+#ifndef _HSAVMCORE_CMDLINE_OPTIONS_H
+#define _HSAVMCORE_CMDLINE_OPTIONS_H
+
+#include "config.h"
+
+/*
+ * Parses the given command-line options and adjusts the application's
+ * configuration accordingly.
+ */
+void parse_cmdline_options(int argc, char *argv[], struct config *config);
+
+#endif

hsavmcore/common.h

@@ -0,0 +1,27 @@
+/*
+ * Copyright IBM Corp. 2021
+ *
+ * s390-tools is free software; you can redistribute it and/or modify
+ * it under the terms of the MIT license. See LICENSE for details.
+ */
+
+#ifndef _HSAVMCORE_COMMON_H
+#define _HSAVMCORE_COMMON_H
+
+#define NAME "hsavmcore"
+
+#define DEBUGFS_MOUNT_POINT "/sys/kernel/debug"
+
+#define ZCORE_HSA DEBUGFS_MOUNT_POINT "/zcore/hsa"
+
+#define VMCORE_FILE "vmcore"
+
+#define PROC_VMCORE "/proc/" VMCORE_FILE
+
+#define WORKDIR "/var/crash"
+
+#define HSA_CACHE_FILE NAME "-hsa-cache.bin"
+
+#define OVERLAY_MOUNT_POINT "/tmp/" NAME "-overlay/"
+
+#endif

hsavmcore/config.c

@@ -0,0 +1,242 @@
+/*
+ * Copyright IBM Corp. 2021
+ *
+ * s390-tools is free software; you can redistribute it and/or modify
+ * it under the terms of the MIT license. See LICENSE for details.
+ */
+
+#include <limits.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <ctype.h>
+
+#include "lib/util_libc.h"
+#include "lib/util_log.h"
+
+#include "config.h"
+
+#define CONFIG_LINE_MAX_SIZE 1024
+
+/*
+ * Supported configuration parameters
+ */
+#define CONFIG_VERBOSE "verbose"
+#define CONFIG_WORKDIR "workdir"
+#define CONFIG_HSA_SIZE "hsa_size"
+#define CONFIG_MOUNT_DEBUGFS "mount_debugfs"
+#define CONFIG_USE_HSA_MEM "use_hsa_mem"
+#define CONFIG_RELEASE_HSA "release_hsa"
+#define CONFIG_BIND_MOUNT_VMCORE "bind_mount_vmcore"
+#define CONFIG_FUSE_DEBUG "fuse_debug"
+#define CONFIG_SWAP "swap"
+
+static char *get_value_str(char *line)
+{
+	char *ptr = strchr(line, '=');
+
+	if (!ptr)
+		return NULL;
+
+	return util_strstrip(ptr + 1);
+}
+
+static int parse_bool(char *line, int linenum, const char *name, bool *value)
+{
+	const char *value_str;
+	unsigned long value_num;
+	char *endptr;
+
+	value_str = get_value_str(line);
+	if (!value_str) {
+		util_log_print(UTIL_LOG_ERROR,
+			       "config line %d: value expected for %s\n",
+			       linenum, name);
+		return -1;
+	}
+
+	util_log_print(UTIL_LOG_DEBUG, "config parse bool: %s\n", value_str);
+
+	value_num = strtoul(value_str, &endptr, 0);
+	if (*endptr != '\0' || (value_num != 0 && value_num != 1)) {
+		util_log_print(UTIL_LOG_ERROR,
+			       "config line %d: invalid value for %s\n",
+			       linenum, name);
+		return -1;
+	}
+
+	*value = value_num;
+
+	return 0;
+}
+
+static int parse_int(char *line, int linenum, const char *name, int min_value,
+		     int max_value, int *value)
+{
+	const char *value_str;
+	long value_num;
+	char *endptr;
+
+	value_str = get_value_str(line);
+	if (!value_str) {
+		util_log_print(UTIL_LOG_ERROR,
+			       "config line %d: value expected for %s\n",
+			       linenum, name);
+		return -1;
+	}
+
+	util_log_print(UTIL_LOG_DEBUG, "config parse int: %s\n", value_str);
+
+	value_num = strtol(value_str, &endptr, 0);
+	if (*endptr != '\0' || value_num < min_value || value_num > max_value) {
+		util_log_print(UTIL_LOG_ERROR,
+			       "config line %d: invalid value for %s\n",
+			       linenum, name);
+		return -1;
+	}
+
+	*value = value_num;
+
+	return 0;
+}
+
+static int parse_str(char *line, int linenum, const char *name, int min_size,
+		     int max_size, char *value)
+{
+	const char *value_str;
+	int size;
+
+	value_str = get_value_str(line);
+	if (!value_str) {
+		util_log_print(UTIL_LOG_ERROR,
+			       "config line %d: value expected for %s\n",
+			       linenum, name);
+		return -1;
+	}
+
+	util_log_print(UTIL_LOG_DEBUG, "config parse string: %s\n", value_str);
+
+	size = strlen(value_str);
+	if ((min_size >= 0 && size < min_size) || size > max_size) {
+		util_log_print(UTIL_LOG_ERROR,
+			       "config line %d: invalid value for %s\n",
+			       linenum, name);
+		return -1;
+	}
+
+	strncpy(value, value_str, max_size);
+	/* Ensure null termination */
+	value[max_size] = '\0';
+
+	return 0;
+}
+
+static int parse_line(char *line, int linenum, struct config *config)
+{
+	if (strncmp(line, CONFIG_VERBOSE, strlen(CONFIG_VERBOSE)) == 0) {
+		if (parse_int(line, linenum, CONFIG_VERBOSE, UTIL_LOG_ERROR,
+			      UTIL_LOG_TRACE, &config->verbose))
+			return -1;
+	} else if (strncmp(line, CONFIG_WORKDIR, strlen(CONFIG_WORKDIR)) == 0) {
+		if (parse_str(line, linenum, CONFIG_WORKDIR, 0,
+			      sizeof(config->workdir_path) - 1,
+			      config->workdir_path))
+			return -1;
+	} else if (strncmp(line, CONFIG_HSA_SIZE, strlen(CONFIG_HSA_SIZE)) ==
+		   0) {
+		if (parse_int(line, linenum, CONFIG_HSA_SIZE, -1, INT_MAX,
+			      &config->hsa_size))
+			return -1;
+	} else if (strncmp(line, CONFIG_MOUNT_DEBUGFS,
+			   strlen(CONFIG_MOUNT_DEBUGFS)) == 0) {
+		if (parse_bool(line, linenum, CONFIG_MOUNT_DEBUGFS,
+			       &config->mount_debugfs))
+			return -1;
+	} else if (strncmp(line, CONFIG_USE_HSA_MEM,
+			   strlen(CONFIG_USE_HSA_MEM)) == 0) {
+		if (parse_bool(line, linenum, CONFIG_USE_HSA_MEM,
+			       &config->use_hsa_mem))
+			return -1;
+	} else if (strncmp(line, CONFIG_RELEASE_HSA,
+			   strlen(CONFIG_RELEASE_HSA)) == 0) {
+		if (parse_bool(line, linenum, CONFIG_RELEASE_HSA,
+			       &config->release_hsa))
+			return -1;
+	} else if (strncmp(line, CONFIG_BIND_MOUNT_VMCORE,
+			   strlen(CONFIG_BIND_MOUNT_VMCORE)) == 0) {
+		if (parse_bool(line, linenum, CONFIG_BIND_MOUNT_VMCORE,
+			       &config->bind_mount_vmcore))
+			return -1;
+	} else if (strncmp(line, CONFIG_FUSE_DEBUG,
+			   strlen(CONFIG_FUSE_DEBUG)) == 0) {
+		if (parse_bool(line, linenum, CONFIG_FUSE_DEBUG,
+			       &config->fuse_debug))
+			return -1;
+	} else if (strncmp(line, CONFIG_SWAP, strlen(CONFIG_SWAP)) == 0) {
+		if (parse_str(line, linenum, CONFIG_SWAP, 0,
+			      sizeof(config->swap) - 1, config->swap))
+			return -1;
+	} else {
+		util_log_print(UTIL_LOG_ERROR,
+			       "config line %d: unknown configuration '%s'\n",
+			       linenum, line);
+		return -1;
+	}
+
+	return 0;
+}
+
+void init_config(struct config *config)
+{
+	memset(config, 0, sizeof(struct config));
+	strncpy(config->vmcore_path, PROC_VMCORE,
+		sizeof(config->vmcore_path) - 1);
+	strncpy(config->zcore_hsa_path, ZCORE_HSA,
+		sizeof(config->zcore_hsa_path) - 1);
+	strncpy(config->workdir_path, WORKDIR,
+		sizeof(config->workdir_path) - 1);
+	strncpy(config->bind_mount_vmcore_path, PROC_VMCORE,
+		sizeof(config->bind_mount_vmcore_path) - 1);
+	config->hsa_size = -1;
+	config->mount_debugfs = false;
+	config->use_hsa_mem = false;
+	config->release_hsa = true;
+	config->bind_mount_vmcore = true;
+	config->fuse_debug = false;
+}
+
+int update_config_from_file(const char *config_path, struct config *config)
+{
+	char line[CONFIG_LINE_MAX_SIZE], *ptr;
+	int ret = 0, linenum;
+	FILE *fp;
+
+	fp = fopen(config_path, "r");
+	if (!fp) {
+		util_log_print(UTIL_LOG_ERROR, "Couldn't open config file %s\n",
+			       config_path);
+		return -1;
+	}
+
+	/* Read the given configuration file linewise and parse parameters */
+	linenum = 0;
+	while (fgets(line, sizeof(line), fp)) {
+		linenum++;
+
+		ptr = util_strstrip(line);
+		/* Skip empty or comment lines */
+		if (ptr[0] == '\0' || ptr[0] == '#')
+			continue;
+
+		util_log_print(UTIL_LOG_DEBUG, "config line %d: %s\n", linenum,
+			       ptr);
+
+		ret = parse_line(ptr, linenum, config);
+		if (ret < 0)
+			break;
+	}
+
+	fclose(fp);
+
+	return ret;
+}

hsavmcore/config.h

@@ -0,0 +1,59 @@
+/*
+ * Copyright IBM Corp. 2021
+ *
+ * s390-tools is free software; you can redistribute it and/or modify
+ * it under the terms of the MIT license. See LICENSE for details.
+ */
+
+#ifndef _HSAVMCORE_CONFIG_H
+#define _HSAVMCORE_CONFIG_H
+
+#include <limits.h>
+#include <stdbool.h>
+
+#include "common.h"
+
+/*
+ * This represents the application's configuration.
+ */
+struct config {
+	/* Log message level */
+	int verbose;
+	/* Path to the system's vmcore file */
+	char vmcore_path[PATH_MAX];
+	/* Path to the system's zcore hsa file */
+	char zcore_hsa_path[PATH_MAX];
+	/*
+	 * Path to a directory where the application could create temporary
+	 * files.
+	 */
+	char workdir_path[PATH_MAX];
+	/* Path to a bind-mount target for vmcore Overlay */
+	char bind_mount_vmcore_path[PATH_MAX];
+	/* Path to a swap device/file */
+	char swap[PATH_MAX];
+	/* HSA memory size */
+	int hsa_size;
+	/* Indicates whether the debugfs shall be mounted */
+	bool mount_debugfs;
+	/* Indicates whether the HSA memory file reader shall be used */
+	bool use_hsa_mem;
+	/* Indicates whether the HSA memory shall be released after caching */
+	bool release_hsa;
+	/* Indicates whether a bind-mount of vmcore Proxy shall be enabled */
+	bool bind_mount_vmcore;
+	/* Indicates whether the FUSE debug messages shall be enabled */
+	bool fuse_debug;
+};
+
+/*
+ * Initializes the application's configuration to its default values.
+ */
+void init_config(struct config *config);
+
+/*
+ * Updates the application's configuration from the given configuration file.
+ */
+int update_config_from_file(const char *config_path, struct config *config);
+
+#endif

hsavmcore/hsa.c

@@ -0,0 +1,172 @@
+/*
+ * Copyright IBM Corp. 2021
+ *
+ * s390-tools is free software; you can redistribute it and/or modify
+ * it under the terms of the MIT license. See LICENSE for details.
+ */
+
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <errno.h>
+#include <elf.h>
+#include <sys/types.h>
+#include <sys/stat.h>
+#include <fcntl.h>
+#include <unistd.h>
+
+#include "lib/util_file.h"
+#include "lib/util_log.h"
+
+#include "hsa.h"
+
+long get_hsa_size(const char *zcore_hsa_path)
+{
+	long size;
+	int ret;
+
+	util_log_print(UTIL_LOG_DEBUG, "Reading HSA memory size from %s\n",
+		       zcore_hsa_path);
+
+	/* Read HSA size */
+	ret = util_file_read_l(&size, 16, zcore_hsa_path);
+	if (ret < 0) {
+		util_log_print(UTIL_LOG_ERROR, "File read failed (%s)\n",
+			       strerror(errno));
+		return -1;
+	}
+
+	return size;
+}
+
+long get_hsa_vmcore_offset(const char *vmcore_path)
+{
+	Elf64_Ehdr elf_hdr;
+	int fd = -1, n, i;
+	long offset = -1;
+
+	util_log_print(UTIL_LOG_DEBUG,
+		       "Reading HSA memory offset from vmcore %s\n",
+		       vmcore_path);
+
+	/* Open vmcore file */
+	fd = open(vmcore_path, O_RDONLY);
+	if (fd < 0) {
+		util_log_print(UTIL_LOG_ERROR, "open syscall failed (%s)\n",
+			       strerror(errno));
+		goto fail;
+	}
+
+	util_log_print(UTIL_LOG_DEBUG, "Reading vmcore ELF header\n");
+
+	/* Read ELF header */
+	n = read(fd, &elf_hdr, sizeof(Elf64_Ehdr));
+	if (n < 0) {
+		util_log_print(UTIL_LOG_ERROR, "read syscall failed (%s)\n",
+			       strerror(errno));
+		goto fail;
+	} else if (n != sizeof(Elf64_Ehdr)) {
+		util_log_print(UTIL_LOG_ERROR,
+			       "read syscall read less data than expected (%s)\n",
+			       strerror(errno));
+		goto fail;
+	}
+
+	/* Verify ELF header */
+	if ((memcmp(elf_hdr.e_ident, ELFMAG, SELFMAG) != 0) ||
+	    elf_hdr.e_type != ET_CORE || elf_hdr.e_machine != EM_S390 ||
+	    elf_hdr.e_ident[EI_CLASS] != ELFCLASS64) {
+		util_log_print(UTIL_LOG_ERROR, "Invalid vmcore ELF header\n");
+		goto fail;
+	}
+
+	util_log_print(UTIL_LOG_DEBUG,
+		       "Reading vmcore ELF program header(s)\n");
+
+	/* Read ELF program header(s) */
+	n = lseek(fd, elf_hdr.e_phoff, SEEK_SET);
+	if (n < 0) {
+		util_log_print(UTIL_LOG_ERROR, "lseek syscall failed (%s)\n",
+			       strerror(errno));
+		goto fail;
+	}
+	/*
+	 * Go through all ELF program headers and find one
+	 * that starts at physical/virtual address 0x0.
+	 */
+	for (i = 0; i < elf_hdr.e_phnum; i++) {
+		Elf64_Phdr elf_phdr;
+
+		util_log_print(UTIL_LOG_DEBUG,
+			       "Reading vmcore ELF program header #%d\n", i);
+
+		n = read(fd, &elf_phdr, sizeof(Elf64_Phdr));
+		if (n < 0) {
+			util_log_print(UTIL_LOG_ERROR,
+				       "read syscall failed (%s)\n",
+				       strerror(errno));
+			goto fail;
+		} else if (n != sizeof(Elf64_Phdr)) {
+			util_log_print(UTIL_LOG_ERROR,
+				       "read syscall read less data than expected (%s)\n",
+				       strerror(errno));
+			goto fail;
+		}
+
+		util_log_print(UTIL_LOG_DEBUG,
+			       "vmcore ELF program segment #%d: type=%lx vaddr=%lx paddr=%lx offset=%lx\n",
+			       i, elf_phdr.p_type, elf_phdr.p_vaddr,
+			       elf_phdr.p_paddr, elf_phdr.p_offset);
+
+		/* HSA memory starts at physical/virtual address 0x0 */
+		if (elf_phdr.p_type == PT_LOAD && elf_phdr.p_vaddr == 0 &&
+		    elf_phdr.p_paddr == 0) {
+			offset = elf_phdr.p_offset;
+			break;
+		}
+	}
+
+	if (offset < 0) {
+		util_log_print(UTIL_LOG_ERROR,
+			       "Couldn't find HSA memory offset in vmcore\n");
+		goto fail;
+	}
+
+	util_log_print(UTIL_LOG_DEBUG, "HSA memory vmcore offset %lx\n",
+		       offset);
+
+	close(fd);
+
+	return offset;
+
+fail:
+	if (fd >= 0)
+		close(fd);
+	return -1;
+}
+
+int release_hsa(const char *zcore_hsa_path)
+{
+	int ret;
+
+	util_log_print(UTIL_LOG_INFO, "Release HSA memory via %s\n",
+		       zcore_hsa_path);
+
+	/* Release HSA memory */
+	ret = util_file_write_s("0", zcore_hsa_path);
+	if (ret < 0) {
+		util_log_print(UTIL_LOG_ERROR, "File write failed (%s)\n",
+			       strerror(errno));
+		return -1;
+	}
+
+	/* Verify that HSA memory has been released */
+	if (get_hsa_size(zcore_hsa_path) > 0) {
+		util_log_print(UTIL_LOG_ERROR, "HSA memory release failed\n");
+		return -1;
+	}
+
+	util_log_print(UTIL_LOG_INFO, "HSA memory successfully released\n");
+
+	return 0;
+}

hsavmcore/hsa.h

@@ -0,0 +1,75 @@
+/*
+ * Copyright IBM Corp. 2021
+ *
+ * s390-tools is free software; you can redistribute it and/or modify
+ * it under the terms of the MIT license. See LICENSE for details.
+ */
+
+#ifndef _HSAVMCORE_HSA_H
+#define _HSAVMCORE_HSA_H
+
+#include <stddef.h>
+
+/*
+ * The interface to a HSA memory reader.
+ * This interface must be implemented by a concrete HSA memory reader.
+ */
+struct hsa_reader {
+	/* Total HSA memory size */
+	long hsa_size;
+	/* Offset of HSA memory in /proc/vmcore */
+	long hsa_vmcore_offset;
+	/* Destroys a concrete HSA memory reader */
+	void (*destroy)(struct hsa_reader *self);
+	/* Reads a HSA memory block given by offset and size */
+	int (*read_at)(struct hsa_reader *self, long offset, void *buf,
+		       int size);
+};
+
+static inline long hsa_get_size(struct hsa_reader *self)
+{
+	return self->hsa_size;
+}
+
+static inline long hsa_get_vmcore_offset(struct hsa_reader *self)
+{
+	return self->hsa_vmcore_offset;
+}
+
+static inline void destroy_hsa_reader(struct hsa_reader *self)
+{
+	self->destroy(self);
+}
+
+static inline int read_hsa_at(struct hsa_reader *self, long offset, void *buf,
+			      int size)
+{
+	return self->read_at(self, offset, buf, size);
+}
+
+/*
+ * Reads total HSA memory size from /sys/kernel/debug/zcore/hsa.
+ */
+long get_hsa_size(const char *zcore_hsa_path);
+
+/*
+ * Returns the offset of HSA memory in /proc/vmcore.
+ */
+long get_hsa_vmcore_offset(const char *vmcore_path);
+
+/*
+ * Releases HSA memory.
+ */
+int release_hsa(const char *zcore_hsa_path);
+
+/*
+ * Returns a pointer to the enclosing struct which contains
+ * the variable pointed to by the given pointer as a member.
+ */
+#define container_of(ptr, type, member)					\
+	({								\
+		const typeof(((type *)NULL)->member) *mptr = (ptr);	\
+		(type *)((char *)mptr - offsetof(type, member));	\
+	})
+
+#endif

hsavmcore/hsa_file.c

@@ -0,0 +1,236 @@
+/*
+ * Copyright IBM Corp. 2021
+ *
+ * s390-tools is free software; you can redistribute it and/or modify
+ * it under the terms of the MIT license. See LICENSE for details.
+ */
+
+#include <limits.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <errno.h>
+#include <sys/types.h>
+#include <sys/stat.h>
+#include <fcntl.h>
+#include <unistd.h>
+
+#include "lib/zt_common.h"
+#include "lib/util_log.h"
+
+#include "common.h"
+#include "hsa.h"
+#include "hsa_file.h"
+
+struct hsa_file_reader {
+	struct hsa_reader super;
+	/* Temporary file containing a copy of the HSA memory */
+	int fd;
+};
+
+static void destroy(struct hsa_reader *super)
+{
+	struct hsa_file_reader *self =
+		container_of(super, struct hsa_file_reader, super);
+
+	close(self->fd);
+	free(self);
+}
+
+static int read_at(struct hsa_reader *super, long offset, void *buf, int size)
+{
+	struct hsa_file_reader *self =
+		container_of(super, struct hsa_file_reader, super);
+	long n, nread = 0;
+
+	util_log_print(UTIL_LOG_DEBUG, "HSA file read: offset=%lx size=%x\n",
+		       offset, size);
+
+	/* Validate given offset */
+	if (offset >= super->hsa_size)
+		return 0;
+
+	/* Validate given size */
+	size = MIN(super->hsa_size - offset, size);
+
+	n = lseek(self->fd, offset, SEEK_SET);
+	if (n < 0) {
+		util_log_print(UTIL_LOG_ERROR, "lseek syscall failed (%s)\n",
+			       strerror(errno));
+		return -1;
+	}
+
+	while (size) {
+		n = read(self->fd, buf + nread, size);
+		if (n < 0) {
+			util_log_print(UTIL_LOG_ERROR,
+				       "read syscall failed (%s)\n",
+				       strerror(errno));
+			return -1;
+		} else if (n == 0) {
+			break;
+		}
+
+		nread += n;
+		size -= n;
+	}
+
+	return nread;
+}
+
+static int copy_hsa_to_file(const char *vmcore_path, const char *workdir_path,
+			    long size, long offset)
+{
+	int fd_in = -1, fd_out = -1;
+	char cache_file_path[PATH_MAX];
+	long n;
+
+	snprintf(cache_file_path, sizeof(cache_file_path), "%s/%s",
+		 workdir_path, HSA_CACHE_FILE);
+
+	util_log_print(UTIL_LOG_DEBUG,
+		       "Copy HSA memory from vmcore %s to cache file %s\n",
+		       vmcore_path, cache_file_path);
+
+	/* Open vmcore file */
+	fd_in = open(vmcore_path, O_RDONLY);
+	if (fd_in < 0) {
+		util_log_print(UTIL_LOG_ERROR, "open syscall failed (%s)\n",
+			       strerror(errno));
+		goto fail;
+	}
+
+	/* Open cache file */
+	fd_out = open(cache_file_path, O_RDWR | O_CREAT | O_TRUNC, 0644);
+	if (fd_out < 0) {
+		util_log_print(UTIL_LOG_ERROR, "open syscall failed (%s)\n",
+			       strerror(errno));
+		goto fail;
+	}
+
+	/* Unlink cache file to auto-delete it on close */
+	n = unlink(cache_file_path);
+	if (n < 0) {
+		util_log_print(UTIL_LOG_ERROR, "unlink syscall failed (%s)\n",
+			       strerror(errno));
+		goto fail;
+	}
+
+	/* Copy HSA memory to cache file */
+	n = lseek(fd_in, offset, SEEK_SET);
+	if (n < 0) {
+		util_log_print(UTIL_LOG_ERROR, "lseek syscall failed (%s)\n",
+			       strerror(errno));
+		goto fail;
+	}
+
+	/* Copy HSA memory chunkwise to the temporary file */
+	while (size) {
+		char buf[1024];
+		long nread, nwrite;
+
+		/* Read a chunk from vmcore */
+		nread = MIN((long)sizeof(buf), size);
+
+		n = read(fd_in, buf, nread);
+		if (n < 0) {
+			util_log_print(UTIL_LOG_ERROR,
+				       "read syscall failed (%s)\n",
+				       strerror(errno));
+			goto fail;
+		} else if (n == 0) {
+			util_log_print(UTIL_LOG_ERROR,
+				       "read syscall read less data than expected\n");
+			goto fail;
+		}
+
+		/* Write a chunk to cache file */
+		nwrite = n;
+		n = write(fd_out, buf, nwrite);
+		if (n < 0) {
+			util_log_print(UTIL_LOG_ERROR,
+				       "write syscall failed (%s)\n",
+				       strerror(errno));
+			goto fail;
+		} else if (n != nwrite) {
+			util_log_print(UTIL_LOG_ERROR,
+				       "write syscall wrote less data than expected\n");
+			goto fail;
+		}
+
+		size -= n;
+	}
+
+	/* Reset cache file position */
+	n = lseek(fd_out, 0, SEEK_SET);
+	if (n < 0) {
+		util_log_print(UTIL_LOG_ERROR, "lseek syscall failed (%s)\n",
+			       strerror(errno));
+		goto fail;
+	}
+
+	close(fd_in);
+
+	return fd_out;
+
+fail:
+	if (fd_in >= 0)
+		close(fd_in);
+	if (fd_out >= 0)
+		close(fd_out);
+	return -1;
+}
+
+struct hsa_reader *make_hsa_file_reader(const char *zcore_hsa_path,
+					const char *vmcore_path,
+					const char *workdir_path, long hsa_size,
+					bool release_hsa_flag)
+{
+	struct hsa_file_reader *self;
+	long hsa_vmcore_offset;
+	int fd;
+
+	/* Calculate HSA size if not given by user */
+	if (hsa_size < 0) {
+		hsa_size = get_hsa_size(zcore_hsa_path);
+		if (hsa_size <= 0)
+			return NULL;
+	}
+	hsa_vmcore_offset = get_hsa_vmcore_offset(vmcore_path);
+	if (hsa_vmcore_offset < 0)
+		return NULL;
+
+	util_log_print(UTIL_LOG_INFO, "HSA: size=%lx vmcore offset=%lx\n",
+		       hsa_size, hsa_vmcore_offset);
+
+	/*
+	 * Store the whole HSA memory from /proc/vmcore to a temporary file
+	 * before releasing HSA.
+	 */
+	fd = copy_hsa_to_file(vmcore_path, workdir_path, hsa_size,
+			      hsa_vmcore_offset);
+	if (fd < 0)
+		return NULL;
+
+	if (release_hsa_flag) {
+		if (release_hsa(zcore_hsa_path)) {
+			close(fd);
+			return NULL;
+		}
+	}
+
+	self = malloc(sizeof(struct hsa_file_reader));
+	if (!self) {
+		util_log_print(UTIL_LOG_ERROR, "malloc failed\n");
+		close(fd);
+		return NULL;
+	}
+
+	self->super.hsa_size = hsa_size;
+	self->super.hsa_vmcore_offset = hsa_vmcore_offset;
+	self->super.destroy = destroy;
+	self->super.read_at = read_at;
+	self->fd = fd;
+
+	return &self->super;
+}

hsavmcore/hsa_file.h

@@ -0,0 +1,27 @@
+/*
+ * Copyright IBM Corp. 2021
+ *
+ * s390-tools is free software; you can redistribute it and/or modify
+ * it under the terms of the MIT license. See LICENSE for details.
+ */
+
+#ifndef _HSAVMCORE_HSA_FILE_H
+#define _HSAVMCORE_HSA_FILE_H
+
+#include <stdbool.h>
+
+#include "hsa.h"
+
+/*
+ * This concrete HSA memory reader copies the whole HSA memory from /proc/vmcore
+ * to a temporary file.
+ * In order for it to work, the system must provide enough file storage.
+ * The advantage of this reader is that it doesn't require extra memory for
+ * caching.
+ */
+struct hsa_reader *make_hsa_file_reader(const char *zcore_hsa_path,
+					const char *vmcore_path,
+					const char *workdir_path, long hsa_size,
+					bool release_hsa_flag);
+
+#endif

hsavmcore/hsa_mem.c

@@ -0,0 +1,151 @@
+/*
+ * Copyright IBM Corp. 2021
+ *
+ * s390-tools is free software; you can redistribute it and/or modify
+ * it under the terms of the MIT license. See LICENSE for details.
+ */
+
+#include <stdlib.h>
+#include <string.h>
+#include <errno.h>
+#include <sys/types.h>
+#include <sys/stat.h>
+#include <fcntl.h>
+#include <unistd.h>
+
+#include "lib/zt_common.h"
+#include "lib/util_log.h"
+
+#include "hsa.h"
+#include "hsa_mem.h"
+
+struct hsa_mem_reader {
+	struct hsa_reader super;
+	unsigned char cache[];
+};
+
+static void destroy(struct hsa_reader *super)
+{
+	struct hsa_mem_reader *self =
+		container_of(super, struct hsa_mem_reader, super);
+
+	free(self);
+}
+
+static int read_at(struct hsa_reader *super, long offset, void *buf, int size)
+{
+	struct hsa_mem_reader *self =
+		container_of(super, struct hsa_mem_reader, super);
+
+	util_log_print(UTIL_LOG_DEBUG, "HSA file read: offset=%lx size=%x\n",
+		       offset, size);
+
+	/* Validate given offset */
+	if (offset >= super->hsa_size)
+		return 0;
+
+	/* Validate given size */
+	size = MIN(super->hsa_size - offset, size);
+
+	memcpy(buf, self->cache + offset, size);
+
+	return size;
+}
+
+static int read_hsa(const char *vmcore_path, long offset, void *buf, int size)
+{
+	long n, nread = 0;
+	int fd = -1;
+
+	util_log_print(UTIL_LOG_DEBUG, "Read HSA memory from vmcore %s\n",
+		       vmcore_path);
+
+	/* Open vmcore file */
+	fd = open(vmcore_path, O_RDONLY);
+	if (fd < 0) {
+		util_log_print(UTIL_LOG_ERROR, "open syscall failed (%s)\n",
+			       strerror(errno));
+		goto fail;
+	}
+
+	n = lseek(fd, offset, SEEK_SET);
+	if (n < 0) {
+		util_log_print(UTIL_LOG_ERROR, "lseek syscall failed (%s)\n",
+			       strerror(errno));
+		goto fail;
+	}
+
+	/* Read HSA memory */
+	while (size) {
+		n = read(fd, buf + nread, size);
+		if (n < 0) {
+			util_log_print(UTIL_LOG_ERROR,
+				       "read syscall failed (%s)\n",
+				       strerror(errno));
+			goto fail;
+		} else if (n == 0) {
+			util_log_print(UTIL_LOG_ERROR,
+				       "read syscall read less data than expected\n");
+			goto fail;
+		}
+
+		nread += n;
+		size -= n;
+	}
+
+	close(fd);
+
+	return 0;
+
+fail:
+	if (fd >= 0)
+		close(fd);
+	return -1;
+}
+
+struct hsa_reader *make_hsa_mem_reader(const char *zcore_hsa_path,
+				       const char *vmcore_path, long hsa_size,
+				       bool release_hsa_flag)
+{
+	struct hsa_mem_reader *self;
+	long hsa_vmcore_offset;
+
+	/* Calculate HSA size if not given by user */
+	if (hsa_size < 0) {
+		hsa_size = get_hsa_size(zcore_hsa_path);
+		if (hsa_size <= 0)
+			return NULL;
+	}
+	hsa_vmcore_offset = get_hsa_vmcore_offset(vmcore_path);
+	if (hsa_vmcore_offset < 0)
+		return NULL;
+
+	util_log_print(UTIL_LOG_INFO, "HSA: size=%lx vmcore offset=%lx\n",
+		       hsa_size, hsa_vmcore_offset);
+
+	self = malloc(sizeof(struct hsa_mem_reader) + hsa_size);
+	if (!self) {
+		util_log_print(UTIL_LOG_ERROR, "malloc failed\n");
+		return NULL;
+	}
+
+	/* Cache the whole HSA memory from /proc/vmcore before releasing HSA */
+	if (read_hsa(vmcore_path, hsa_vmcore_offset, self->cache, hsa_size)) {
+		free(self);
+		return NULL;
+	}
+
+	if (release_hsa_flag) {
+		if (release_hsa(zcore_hsa_path)) {
+			free(self);
+			return NULL;
+		}
+	}
+
+	self->super.hsa_size = hsa_size;
+	self->super.hsa_vmcore_offset = hsa_vmcore_offset;
+	self->super.destroy = destroy;
+	self->super.read_at = read_at;
+
+	return &self->super;
+}

hsavmcore/hsa_mem.h

@@ -0,0 +1,24 @@
+/*
+ * Copyright IBM Corp. 2021
+ *
+ * s390-tools is free software; you can redistribute it and/or modify
+ * it under the terms of the MIT license. See LICENSE for details.
+ */
+
+#ifndef _HSAVMCORE_HSA_MEM_H
+#define _HSAVMCORE_HSA_MEM_H
+
+#include <stdbool.h>
+
+#include "hsa.h"
+
+/*
+ * This concrete HSA memory reader reads the whole HSA memory from /proc/vmcore
+ * and caches it all in an internal memory buffer.
+ * In order for it to work, the system must provide enough memory or swap space.
+ */
+struct hsa_reader *make_hsa_mem_reader(const char *zcore_hsa_path,
+				       const char *vmcore_path, long hsa_size,
+				       bool release_hsa_flag);
+
+#endif

hsavmcore/initramfs/fedora-rhel/README.md

@@ -0,0 +1,147 @@
+
+# Setup
+
+## Configure crashkernel
+
+```shell
+sudo grubby --args "crashkernel=512M" --update-kernel=ALL
+sudo reboot
+```
+
+## Production kernel's root file system
+
+- kdump mounts the production kernel's root file system under **/sysroot**.
+
+## Dependencies
+
+```shell
+sudo dnf install -y fuse fuse-devel systemd-devel
+```
+
+## Build hsavmcore
+
+```shell
+make -C s390-tools/hsavmcore
+```
+
+## Install hsavmcore
+
+```shell
+sudo cp s390-tools/hsavmcore/hsavmcore /usr/sbin/
+```
+
+## Create swap file
+
+```shell
+sudo dd if=/dev/zero of=/var/crash/swap.img bs=1M count=1024
+sudo mkswap /var/crash/swap.img
+```
+
+## Install hsavmcore.conf
+
+### Test configuration
+
+- Doesn't require HSA support
+
+#### HSA cache in file
+
+```shell
+cat <<EOF | sudo tee /etc/hsavmcore.conf
+verbose = 2
+workdir = /sysroot/var/crash
+use_hsa_mem = 0
+mount_debugfs = 1
+hsa_size = 0x1ffff000
+release_hsa = 0
+bind_mount_vmcore = 1
+EOF
+```
+
+#### HSA cache in memory
+
+```shell
+cat <<EOF | sudo tee /etc/hsavmcore.conf
+verbose = 2
+workdir = /sysroot/var/crash
+use_hsa_mem = 1
+mount_debugfs = 1
+hsa_size = 0x1ffff000
+release_hsa = 0
+bind_mount_vmcore = 1
+swap = /sysroot/var/crash/swap.img
+EOF
+```
+
+### Production configuration
+
+- Works only on s390x
+
+#### HSA cache in file
+
+```shell
+cat <<EOF | sudo tee /etc/hsavmcore.conf
+verbose = 2
+workdir = /sysroot/var/crash
+use_hsa_mem = 0
+mount_debugfs = 1
+hsa_size = -1
+release_hsa = 1
+bind_mount_vmcore = 1
+EOF
+```
+
+#### HSA cache in memory
+
+```shell
+cat <<EOF | sudo tee /etc/hsavmcore.conf
+verbose = 2
+workdir = /sysroot/var/crash
+use_hsa_mem = 1
+mount_debugfs = 1
+hsa_size = -1
+release_hsa = 1
+bind_mount_vmcore = 1
+swap = /sysroot/var/crash/swap.img
+EOF
+```
+
+## Install new dracut module
+
+```shell
+sudo cp -r s390-tools/hsavmcore/initramfs/fedora-rhel/dracut/modules.d/99hsavmcore /lib/dracut/modules.d/
+```
+
+## Add the new dracut module as a dependency to the dracut module *kdumpbase*
+
+```shell
+sudo sed -e 's#local _dep="base shutdown"#local _dep="base shutdown hsavmcore"#' \
+         -i /lib/dracut/modules.d/99kdumpbase/module-setup.sh
+```
+
+## Rebuild kdump initramfs
+
+```shell
+sudo kdumpctl rebuild
+```
+
+## Enable swap LVM in kdump
+
+- Required if you want to use a swap device in kdump
+
+```shell
+sudo sed -e 's#^KDUMP_COMMANDLINE_APPEND="\(.*\)"$#KDUMP_COMMANDLINE_APPEND="\1 rd.lvm.lv=rhel/swap"#' \
+         -i /etc/sysconfig/kdump
+```
+
+## Reload kdump
+
+```shell
+sudo kdumpctl reload
+```
+
+# Test
+
+```shell
+echo N | sudo tee /sys/module/kernel/parameters/crash_kexec_post_notifiers
+echo c | sudo tee /proc/sysrq-trigger
+```

hsavmcore/initramfs/fedora-rhel/dracut/modules.d/99hsavmcore/hsavmcore.service

@@ -0,0 +1,20 @@
+#  This file is part of systemd.
+#
+#  systemd is free software; you can redistribute it and/or modify it
+#  under the terms of the GNU Lesser General Public License as published by
+#  the Free Software Foundation; either version 2.1 of the License, or
+#  (at your option) any later version.
+
+[Unit]
+Description=hsavmcore Service
+After=initrd.target initrd-parse-etc.service sysroot.mount
+After=dracut-initqueue.service dracut-pre-mount.service dracut-mount.service dracut-pre-pivot.service
+Before=kdump-capture.service
+Before=initrd-cleanup.service
+
+[Service]
+Type=notify
+ExecStart=/usr/sbin/hsavmcore -c /etc/hsavmcore.conf
+StandardInput=null
+StandardOutput=syslog
+StandardError=syslog+console

hsavmcore/initramfs/fedora-rhel/dracut/modules.d/99hsavmcore/module-setup.sh

@@ -0,0 +1,37 @@
+#!/usr/bin/bash
+
+. $dracutfunctions
+
+if ! [[ -d "${initdir}/tmp" ]]; then
+    mkdir -p "${initdir}/tmp"
+fi
+
+check() {
+    [[ $debug ]] && set -x
+    #kdumpctl sets this explicitly
+    if [ -z "$IN_KDUMP" ]
+    then
+        return 1
+    fi
+    return 0
+}
+
+depends() {
+    local _dep="base shutdown"
+    echo $_dep
+    return 0
+}
+
+installkernel() {
+    hostonly='' instmods fuse
+}
+
+install() {
+    inst "/usr/sbin/hsavmcore" "/usr/sbin/hsavmcore"
+    inst "/etc/hsavmcore.conf" "/etc/hsavmcore.conf"
+    inst "$moddir/hsavmcore.service" "$systemdsystemunitdir/hsavmcore.service"
+    mkdir -p "$initdir/$systemdsystemunitdir/initrd.target.wants"
+    ln_r "$systemdsystemunitdir/hsavmcore.service" "$systemdsystemunitdir/initrd.target.wants/hsavmcore.service"
+
+    inst_hook pre-mount 30 "$moddir/setup-fuse.sh"
+}

hsavmcore/initramfs/fedora-rhel/dracut/modules.d/99hsavmcore/setup-fuse.sh

@@ -0,0 +1,3 @@
+#!/bin/sh
+
+modprobe fuse

hsavmcore/initramfs/sles/README.md

@@ -0,0 +1,141 @@
+
+# Setup
+
+## Configure crashkernel
+
+```shell
+sudo vim /etc/default/grub
+sudo sed -e 's/GRUB_CMDLINE_LINUX_DEFAULT="\(.*\)"/GRUB_CMDLINE_LINUX_DEFAULT="\1 crashkernel=512M"/' \
+         -i /etc/default/grub
+sudo grub2-mkconfig -o /boot/grub2/grub.cfg
+sudo reboot
+```
+
+## Production kernel's root file system
+
+- kdump mounts the production kernel's root file system under **/kdump/mnt1**.
+
+## Dependencies
+
+```shell
+sudo zypper install -y fuse fuse-devel systemd-devel
+```
+
+## Build hsavmcore
+
+```shell
+make -C s390-tools/hsavmcore
+```
+
+## Install hsavmcore
+
+```shell
+sudo cp s390-tools/hsavmcore/hsavmcore /usr/sbin/
+```
+
+## Create swap file
+
+```shell
+sudo dd if=/dev/zero of=/var/crash/swap.img bs=1M count=1024
+sudo mkswap /var/crash/swap.img
+```
+
+## Install hsavmcore.conf
+
+### Test configuration
+
+- Doesn't require HSA support
+
+#### HSA cache in file
+
+```shell
+cat <<EOF | sudo tee /etc/hsavmcore.conf
+verbose = 2
+workdir = /kdump/mnt1/var/crash
+use_hsa_mem = 0
+mount_debugfs = 1
+hsa_size = 0x1ffff000
+release_hsa = 0
+bind_mount_vmcore = 1
+EOF
+```
+
+#### HSA cache in memory
+
+```shell
+cat <<EOF | sudo tee /etc/hsavmcore.conf
+verbose = 2
+workdir = /kdump/mnt1/var/crash
+use_hsa_mem = 1
+mount_debugfs = 1
+hsa_size = 0x1ffff000
+release_hsa = 0
+bind_mount_vmcore = 1
+swap = /kdump/mnt1/var/crash/swap.img
+EOF
+```
+
+### Production configuration
+
+- Works only on s390x
+
+#### HSA cache in file
+
+```shell
+cat <<EOF | sudo tee /etc/hsavmcore.conf
+verbose = 2
+workdir = /kdump/mnt1/var/crash
+use_hsa_mem = 0
+mount_debugfs = 1
+hsa_size = -1
+release_hsa = 1
+bind_mount_vmcore = 1
+EOF
+```
+
+#### HSA cache in memory
+
+```shell
+cat <<EOF | sudo tee /etc/hsavmcore.conf
+verbose = 2
+workdir = /kdump/mnt1/var/crash
+use_hsa_mem = 1
+mount_debugfs = 1
+hsa_size = -1
+release_hsa = 1
+bind_mount_vmcore = 1
+swap = /kdump/mnt1/var/crash/swap.img
+EOF
+```
+
+## Install new dracut module
+
+```shell
+sudo cp -r s390-tools/hsavmcore/initramfs/sles/dracut/modules.d/99hsavmcore /usr/lib/dracut/modules.d/
+```
+
+## Add the new dracut module as a dependency to the dracut module *kdump*
+
+```shell
+sudo sed -e 's/_modules\[drm\]=/_modules[drm]=\n    _modules[hsavmcore]=/' \
+         -i /usr/lib/dracut/modules.d/99kdump/module-setup.sh
+```
+
+## Rebuild kdump initramfs
+
+```shell
+sudo mkdumprd -f
+```
+
+## Reload kdump
+
+```shell
+systemctl enable kdump
+systemctl restart kdump
+```
+
+# Test
+
+```shell
+echo c | sudo tee /proc/sysrq-trigger
+```

hsavmcore/initramfs/sles/dracut/modules.d/99hsavmcore/hsavmcore.service

@@ -0,0 +1,21 @@
+#  This file is part of systemd.
+#
+#  systemd is free software; you can redistribute it and/or modify it
+#  under the terms of the GNU Lesser General Public License as published by
+#  the Free Software Foundation; either version 2.1 of the License, or
+#  (at your option) any later version.
+
+# See systemd.special(7) for details
+
+[Unit]
+Description=hsavmcore Service
+Before=kdump-save.service
+ConditionPathExists=/etc/initrd-release
+ConditionPathExists=/proc/vmcore
+
+[Service]
+Type=notify
+ExecStart=/usr/sbin/hsavmcore -c /etc/hsavmcore.conf
+StandardInput=null
+StandardOutput=syslog
+StandardError=syslog+console

hsavmcore/initramfs/sles/dracut/modules.d/99hsavmcore/module-setup.sh

@@ -0,0 +1,47 @@
+#!/bin/bash
+
+. /lib/kdump/setup-kdump.functions
+
+kdump_needed() {
+    # Building a kdump initrd?
+    if [[ " $dracutmodules $add_dracutmodules $force_add_dracutmodules" == *\ $_mod\ * ]]; then
+        return 0
+    fi
+
+    # Is FADUMP active?
+    if [ "$KDUMP_FADUMP" = "yes" ]; then
+        return 0
+    fi
+
+    # Do not include kdump by default
+    return 1
+}
+
+check() {
+    # Get configuration
+    kdump_get_config || return 1
+
+    kdump_needed || return 1
+
+    return 0
+}
+
+depends() {
+    echo "systemd"
+    return 0
+}
+
+installkernel() {
+    hostonly='' instmods fuse
+}
+
+install() {
+    inst_simple /usr/sbin/hsavmcore
+    inst_simple /etc/hsavmcore.conf
+
+    inst "$moddir/hsavmcore.service" "$systemdsystemunitdir/hsavmcore.service"
+    mkdir -p "$initdir/$systemdsystemunitdir/initrd.target.wants"
+    ln_r "$systemdsystemunitdir/hsavmcore.service" "$systemdsystemunitdir/initrd.target.wants/hsavmcore.service"
+
+    inst_hook pre-mount 30 "$moddir/setup-fuse.sh"
+}

hsavmcore/initramfs/sles/dracut/modules.d/99hsavmcore/setup-fuse.sh

@@ -0,0 +1,3 @@
+#!/bin/sh
+
+modprobe fuse

hsavmcore/initramfs/ubuntu/README.md

@@ -0,0 +1,142 @@
+# Setup
+
+## Production kernel's root file system
+
+- kdump mounts the production kernel's root file system under **/**.
+
+## debugfs
+
+- kdump mounts debugfs automatically.
+
+## Dependencies
+
+```shell
+sudo apt-get install -y make gcc kdump-tools fuse libfuse-dev libsystemd-dev
+```
+
+## Build hsavmcore
+
+```shell
+make -C s390-tools/hsavmcore
+```
+
+## Install hsavmcore
+
+```shell
+sudo cp s390-tools/hsavmcore/hsavmcore /usr/sbin/
+```
+
+## Create swap file
+
+```shell
+sudo dd if=/dev/zero of=/var/crash/swap.img bs=1M count=1024
+sudo mkswap /var/crash/swap.img
+```
+
+## Install hsavmcore.conf
+
+### Test configuration
+
+- Doesn't require HSA support
+
+#### HSA cache in file
+
+```shell
+cat <<EOF | sudo tee /etc/hsavmcore.conf
+verbose = 2
+workdir = /sysroot/var/crash
+use_hsa_mem = 0
+mount_debugfs = 0
+hsa_size = 0x1ffff000
+release_hsa = 0
+bind_mount_vmcore = 1
+EOF
+```
+
+#### HSA cache in memory
+
+```shell
+cat <<EOF | sudo tee /etc/hsavmcore.conf
+verbose = 2
+workdir = /var/crash
+use_hsa_mem = 1
+mount_debugfs = 0
+hsa_size = 0x1ffff000
+release_hsa = 0
+bind_mount_vmcore = 1
+swap = /var/crash/swap.img
+EOF
+```
+
+### Production configuration
+
+- Works only on s390x
+
+#### HSA cache in file
+
+```shell
+cat <<EOF | sudo tee /etc/hsavmcore.conf
+verbose = 2
+workdir = /var/crash
+use_hsa_mem = 0
+mount_debugfs = 0
+hsa_size = -1
+release_hsa = 1
+bind_mount_vmcore = 1
+EOF
+```
+
+#### HSA cache in memory
+
+```shell
+cat <<EOF | sudo tee /etc/hsavmcore.conf
+verbose = 2
+workdir = /sysroot/var/crash
+use_hsa_mem = 1
+mount_debugfs = 0
+hsa_size = -1
+release_hsa = 1
+bind_mount_vmcore = 1
+swap = /var/crash/swap.img
+EOF
+```
+
+## Install new dracut module
+
+```shell
+sudo cp s390-tools/hsavmcore/initramfs/ubuntu/hsavmcore.service /usr/lib/systemd/system/
+```
+
+## Add the new systemd service as a dependency to the service *kdump-tools-dump*
+
+```shell
+Wants=network-online.target dbus.socket systemd-resolved.service hsavmcore.service
+After=network-online.target dbus.socket systemd-resolved.service hsavmcore.service
+
+sudo sed -e 's/Wants=\(.*\)$/Wants=\1 hsavmcore.service/' \
+         -e 's/After=\(.*\)$/After=\1 hsavmcore.service/' \
+         -i /usr/lib/systemd/system/kdump-tools-dump.service
+```
+
+## Rebuild kdump initramfs
+
+```shell
+sudo rm -rf /var/lib/kdump/initrd*
+sudo kdump-config unload
+sudo kdump-config load
+sudo systemctl restart kdump-tools
+```
+
+## Reload kdump
+
+```shell
+sudo kdump-config unload
+sudo kdump-config load
+```
+
+# Test
+
+```shell
+echo N | sudo tee /sys/module/kernel/parameters/crash_kexec_post_notifiers
+echo c | sudo tee /proc/sysrq-trigger
+```

hsavmcore/initramfs/ubuntu/hsavmcore.service

@@ -0,0 +1,22 @@
+#  This file is part of systemd.
+#
+#  systemd is free software; you can redistribute it and/or modify it
+#  under the terms of the GNU Lesser General Public License as published by
+#  the Free Software Foundation; either version 2.1 of the License, or
+#  (at your option) any later version.
+
+[Unit]
+Description=hsavmcore Service
+Wants=network-online.target dbus.socket systemd-resolved.service
+After=network-online.target dbus.socket systemd-resolved.service
+Before=kdump-tools-dump.service
+
+[Install]
+WantedBy=kdump-tools-dump.service
+
+[Service]
+Type=notify
+ExecStart=/usr/sbin/hsavmcore -c /etc/hsavmcore.conf
+StandardInput=null
+StandardOutput=syslog+console
+StandardError=syslog+console

hsavmcore/main.c

@@ -0,0 +1,238 @@
+/*
+ * Copyright IBM Corp. 2021
+ *
+ * s390-tools is free software; you can redistribute it and/or modify
+ * it under the terms of the MIT license. See LICENSE for details.
+ */
+
+#include <stdlib.h>
+#include <string.h>
+#include <pthread.h>
+#include <signal.h>
+#include <sys/types.h>
+#include <sys/stat.h>
+#include <unistd.h>
+
+#ifdef HAVE_SYSTEMD
+#include <systemd/sd-daemon.h>
+#endif
+
+#include "lib/util_log.h"
+
+#include "common.h"
+#include "config.h"
+#include "cmdline_options.h"
+#include "mount.h"
+#include "swap.h"
+#include "hsa.h"
+#include "hsa_mem.h"
+#include "hsa_file.h"
+#include "proxy.h"
+#include "overlay.h"
+
+#define MAX_WAIT_VMCORE_OVERLAY_SECS 5
+
+static int bind_mount_vmcore(const char *src, const char *target,
+			     int max_wait_secs)
+{
+	struct stat st;
+	int ret;
+
+	util_log_print(UTIL_LOG_INFO, "Wait %d secs for %s to appear\n",
+		       max_wait_secs, src);
+
+	while (max_wait_secs--) {
+		if (!stat(src, &st))
+			break;
+		sleep(1);
+	}
+
+	if (stat(src, &st)) {
+		util_log_print(UTIL_LOG_ERROR, "Timeout for appearance of %s\n",
+			       src);
+		return -1;
+	}
+
+	ret = bind_mount(src, target);
+	if (ret < 0)
+		return -1;
+
+	return 0;
+}
+
+static void block_all_signals(void)
+{
+	sigset_t signal_set;
+
+	sigfillset(&signal_set);
+	pthread_sigmask(SIG_BLOCK, &signal_set, NULL);
+}
+
+static void unblock_all_signals(void)
+{
+	sigset_t signal_set;
+
+	sigfillset(&signal_set);
+	pthread_sigmask(SIG_UNBLOCK, &signal_set, NULL);
+}
+
+static void *vmcore_overlay_server(void *arg)
+{
+	struct vmcore_overlay *vmcore_overlay = (struct vmcore_overlay *)arg;
+	int ret;
+
+	util_log_print(UTIL_LOG_DEBUG, "vmcore overlay thread: start\n");
+
+	/* Unblock all signals because vmcore overlay handles them */
+	unblock_all_signals();
+
+	/* Blocks until a signal has been received or an error occurred */
+	ret = serve_vmcore_overlay(vmcore_overlay);
+
+	util_log_print(UTIL_LOG_DEBUG, "vmcore overlay thread: end (%d)\n",
+		       ret);
+
+	return (void *)(long)ret;
+}
+
+static void terminate_vmcore_overlay(pthread_t tid)
+{
+	pthread_kill(tid, SIGINT);
+	pthread_join(tid, NULL);
+}
+
+static int wait_for_vmcore_overlay(pthread_t tid)
+{
+	int ret;
+
+	pthread_join(tid, (void **)&ret);
+
+	return ret;
+}
+
+int main(int argc, char *argv[])
+{
+	struct vmcore_overlay *vmcore_overlay;
+	struct vmcore_proxy *vmcore_proxy;
+	int exit_code = EXIT_SUCCESS, ret;
+	struct hsa_reader *hsa_reader;
+	pthread_t vmcore_overlay_tid;
+	struct config config;
+
+	init_config(&config);
+
+	parse_cmdline_options(argc, argv, &config);
+
+	if (strlen(config.swap)) {
+		ret = swap_on(config.swap);
+		if (ret < 0) {
+			exit_code = EXIT_FAILURE;
+			goto done;
+		}
+	}
+
+	if (config.mount_debugfs) {
+		ret = mount_debugfs(DEBUGFS_MOUNT_POINT);
+		if (ret < 0) {
+			exit_code = EXIT_FAILURE;
+			goto swap_off;
+		}
+	}
+
+	if (config.use_hsa_mem)
+		hsa_reader =
+			make_hsa_mem_reader(config.zcore_hsa_path,
+					    config.vmcore_path, config.hsa_size,
+					    config.release_hsa);
+	else
+		hsa_reader = make_hsa_file_reader(config.zcore_hsa_path,
+						  config.vmcore_path,
+						  config.workdir_path,
+						  config.hsa_size,
+						  config.release_hsa);
+	if (!hsa_reader) {
+		exit_code = EXIT_FAILURE;
+		goto unmount_debugfs;
+	}
+
+	vmcore_proxy = make_vmcore_proxy(config.vmcore_path, hsa_reader);
+	if (!vmcore_proxy) {
+		exit_code = EXIT_FAILURE;
+		goto destroy_hsa_reader;
+	}
+
+	vmcore_overlay = make_vmcore_overlay(vmcore_proxy, OVERLAY_MOUNT_POINT,
+					     config.fuse_debug);
+	if (!vmcore_overlay) {
+		exit_code = EXIT_FAILURE;
+		goto destroy_vmcore_proxy;
+	}
+
+	/* vmcore overlay thread handles all signals */
+	block_all_signals();
+
+	/* Start vmcore overlay thread which handles file system calls */
+	ret = pthread_create(&vmcore_overlay_tid, NULL, vmcore_overlay_server,
+			     vmcore_overlay);
+	if (ret < 0) {
+		exit_code = EXIT_FAILURE;
+		goto destroy_vmcore_overlay;
+	}
+
+	/* Bind mount /proc/vmcore */
+	if (config.bind_mount_vmcore) {
+		ret = bind_mount_vmcore(OVERLAY_MOUNT_POINT "/" VMCORE_FILE,
+					config.bind_mount_vmcore_path,
+					MAX_WAIT_VMCORE_OVERLAY_SECS);
+		if (ret < 0) {
+			terminate_vmcore_overlay(vmcore_overlay_tid);
+			exit_code = EXIT_FAILURE;
+			goto destroy_vmcore_overlay;
+		}
+	}
+
+#ifdef HAVE_SYSTEMD
+	/* Tell systemd that service is ready now */
+	ret = sd_notify(0, "READY=1");
+	if (ret <= 0)
+		util_log_print(UTIL_LOG_WARN, "Failed to notify systemd (%d)\n",
+			       ret);
+#endif
+
+	ret = wait_for_vmcore_overlay(vmcore_overlay_tid);
+	if (ret < 0)
+		exit_code = EXIT_FAILURE;
+
+#ifdef HAVE_SYSTEMD
+	/* Tell systemd that service is stopping now */
+	ret = sd_notify(0, "STOPPING=1");
+	if (ret <= 0)
+		util_log_print(UTIL_LOG_WARN, "Failed to notify systemd (%d)\n",
+			       ret);
+#endif
+
+	unblock_all_signals();
+
+	if (config.bind_mount_vmcore)
+		unmount_detach(config.bind_mount_vmcore_path);
+
+destroy_vmcore_overlay:
+	destroy_vmcore_overlay(vmcore_overlay);
+
+destroy_vmcore_proxy:
+	destroy_vmcore_proxy(vmcore_proxy);
+
+destroy_hsa_reader:
+	destroy_hsa_reader(hsa_reader);
+
+unmount_debugfs:
+	if (config.mount_debugfs)
+		unmount_detach(DEBUGFS_MOUNT_POINT);
+
+swap_off:
+	if (strlen(config.swap))
+		swap_off(config.swap);
+
+done:
+	return exit_code;
+}

hsavmcore/man/hsavmcore.8

@@ -0,0 +1,139 @@
+.\" Copyright 2021 IBM Corp.
+.\" s390-tools is free software; you can redistribute it and/or modify
+.\" it under the terms of the MIT license. See LICENSE for details.
+.\"
+.TH HSAVMCORE 8 "May 2021" "s390-tools"
+.
+.SH NAME
+hsavmcore - Enable kdump to release the HSA memory early in the dump process
+.
+.SH SYNOPSIS
+.B hsavmcore
+.RI [ OPTIONS ]
+.
+.SH DESCRIPTION
+.B hsavmcore
+is designed to make the dump process with kdump more efficient.
+The HSA memory contains a part of the production kernel's memory.
+Use hsavmcore to cache this information and release HSA memory early in the process.
+.PP
+Depending on the size of the production kernel's memory, writing the dump to persistent
+storage can be time consuming and prevent the HSA memory from being reused by other LPARs.
+.
+The
+.B hsavmcore
+tool performs these steps:
+.IP "  1)"
+Read the size of the HSA memory from
+.B /sys/kernel/debug/zcore/hsa.
+.IP "  2)"
+Cache the HSA memory content contained in
+.B /proc/vmcore
+either in regular memory or within the file system.
+.IP "  3)"
+Releases the HSA memory by writing to
+.B /sys/kernel/debug/zcore/hsa.
+.PP
+At this stage, the HSA memory region is unavailable to
+.B /proc/vmcore
+and cannot be used by kdump.
+.
+The
+.B hsavmcore
+tool now combines the cached HSA memory and the non-HSA memory from the original
+.B /proc/vmcore
+to create a replacement for
+.B /proc/vmcore.
+.
+The replacement
+.B /proc/vmcore
+can be processed as usual.
+.
+.SH OPTIONS
+.TP
+\fB\-h\fP or \fB\-\-help\fP
+Print usage information and exit.
+.
+.TP
+\fB\-v\fP or \fB\-\-version\fP
+Print version information and exit.
+.
+.TP
+\fB\-V\fP or \fB\-\-verbose\fP
+Print verbose messages to stdout. Repeat this option for increased verbosity
+from just error messages to also include warning, information, debug, and trace messages.
+This option is intended for debugging.
+.
+.TP
+\fB\-c\fP or \fB\-\-config\fP \fICONFIGFILE\fP
+Path to the configuration file. By default, no configuration file is used.
+.
+.TP
+\fB\-C\fP or \fB\-\-vmcore\fP \fIVMCOREFILE\fP
+Path to the vmcore file. Default:
+.B /proc/vmcore.
+.
+.TP
+\fB\-H\fP or \fB\-\-hsa\fP \fIZCOREHSAFILE\fP
+Path to the zcore HSA file. Default:
+.B /sys/kernel/debug/zcore/hsa.
+.
+.TP
+\fB\-W\fP or \fB\-\-workdir\fP \fIWORKDIR\fP
+Path to the work directory where temporary files can be stored. Default:
+.B /var/crash.
+.
+.TP
+\fB\-B\fP or \fB\-\-bmvmcore\fP \fIVMCOREFILE\fP
+Path to the target of the bind mount for the replacement vmcore file. Default:
+.B /proc/vmcore.
+.
+.TP
+\fB\-S\fP or \fB\-\-swap\fP \fIPATH\fP
+Path to a swap device or file. The specified swap device or file must exist and have the proper
+swap format. Default: no swap device or file is activated.
+.
+.TP
+\fB\-T\fP or \fB\-\-hsasize\fP \fIHSASIZE\fP
+HSA size in bytes. Used for testing purposes. Default: -1 (read from the zcore HSA file).
+.
+.TP
+\fB\-D\fP or \fB\-\-dbgfsmnt\fP
+Mount the debug file system. Default: the debug file system is not mounted.
+.
+.TP
+\fB\-F\fP or \fB\-\-hsamem\fP
+Cache the HSA memory in regular memory. Default: the HSA memory is cached as a file
+within WORKDIR.
+.
+.TP
+\fB\-R\fP or \fB\-\-norelhsa\fP
+Do NOT release the HSA memory after caching. Default: the HSA memory is released.
+.
+.TP
+\fB\-N\fP or \fB\-\-nobindmnt\fP
+Do NOT replace the system's vmcore file. Default: the system's vmcore file is replaced.
+.
+.TP
+\fB\-G\fP or \fB\-\-fusedbg\fP
+Enable FUSE debugging. Default: FUSE debugging is disabled.
+.RE
+.
+.SH EXAMPLES
+.TP
+.B To run hsavmcore on a kdump system during a stand-alone dump with default parameters:
+.RS 4
+hsavmcore
+.br
+makedumpfile \-d 31 /proc/vmcore test-dump.elf
+.RE
+.TP
+.B To test hsavmcore with a vmcore copy and without being in a kdump system (for debugging):
+.RS 4
+hsavmcore \-VVV \-T 0x1ffff000 \-C vmcore-dump.elf \-N \-R
+.br
+makedumpfile \-d 31 /tmp/hsavmcore-overlay/vmcore test-dump.elf
+.RE
+
+.SH SEE ALSO
+.BR hsavmcore.conf (5)

hsavmcore/man/hsavmcore.conf.5

@@ -0,0 +1,118 @@
+.\" Copyright 2021 IBM Corp.
+.\" s390-tools is free software; you can redistribute it and/or modify
+.\" it under the terms of the MIT license. See LICENSE for details.
+.\"
+.TH HSAVMCORE.CONF 5 "May 2021" "s390-tools"
+.SH NAME
+hsavmcore.conf \- Configuration file for the hsavmcore tool
+.
+.SH DESCRIPTION
+The
+.B hsavmcore.conf
+configuration file contains the configuration information for
+the
+.B hsavmcore
+tool.
+
+All specifications in the configuration file are optional.
+The command defaults apply for omitted parameters.
+.
+.SS "verbose"
+This parameter sets the verbosity level of the output messages.
+The following pre-defined numeric values can be used:
+.
+.RS 2
+.IP "-" 2
+\fB0\fP - show only error messages (default)
+.IP "-" 2
+\fB1\fP - show error and warning messages
+.IP "-" 2
+\fB2\fP - show error, warning and information messages
+.IP "-" 2
+\fB3\fP - show error, warning, information and debug messages
+.IP "-" 2
+\fB4\fP - show error, warning, information, debug and trace messages
+.RE
+.PP
+.
+.SS "mount_debugfs"
+Mount (1) or do not mount (0) debugfs. Use this configuration if the kdump kernel
+does not mount the debugfs during the boot process.
+.
+.SS "workdir"
+Specifies a work directory on the kdump system where the hsavmcore tool can create
+temporary files. This specification is required if
+.B use_hsa_mem
+is set to 0.
+.
+.SS "use_hsa_mem"
+Cache the HSA memory in regular memory (1) or in a file on a file system (0).
+.
+.SS "hsa_size"
+Specify a value, in bytes, for the HSA memory size instead of reading the size
+from
+.B /sys/kernel/debug/zcore/hsa.
+This parameter is intended only to test
+the
+.B hsavmcore
+tool without being in a kdump kernel. Specifying -1 falls back
+to reading the size from
+.B /sys/kernel/debug/zcore/hsa.
+.
+.SS "release_hsa"
+Release (1) or do not release (0) the HSA memory after it is cached by
+the
+.B hsavmcore
+tool.
+.
+.SS "bind_mount_vmcore"
+Replace (1) the original vmcore file with the new file created by the
+.B hsavmcore
+tool or keep the original file (0), which no longer contains the information
+from the HSA memory. Set this parameter to 1 if you intend to use kdump tools to
+create a core dump.
+.
+.SS "swap"
+Specify a swap device or file through its path in a kdump system.
+The specified swap device or file must exist and have the proper swap format.
+You might need a swap device because the amount of memory available in the kdump
+kernel during a stand-alone dump is limited to the size of the HSA memory.
+.
+.SS "fuse_debug"
+Enable (1) or disable (0) fuse debugging.
+.
+.SH EXAMPLES
+A complete configuration file could look like this:
+
+.nf
+------------------------------ config file start ------------------------------
+# Example configuration for hsavmcore
+
+# 0 - ERROR
+# 1 - WARN
+# 2 - INFO
+# 3 - DEBUG
+# 4 - TRACE
+verbose = 3
+
+workdir = /var/crash
+
+mount_debugfs = 1
+
+use_hsa_mem = 1
+
+hsa_size = -1
+release_hsa = 1
+
+bind_mount_vmcore = 1
+
+swap = /dev/disk/by-uuid/3cf6630b-4c4d-49ac-a0ae-0f5484cb5721
+#swap = /swap.img
+
+fuse_debug = 0
+------------------------------ config file end ------------------------------
+.fi
+
+.
+.SH SEE ALSO
+.BR hsavmcore (8)

hsavmcore/mount.c

@@ -0,0 +1,63 @@
+/*
+ * Copyright IBM Corp. 2021
+ *
+ * s390-tools is free software; you can redistribute it and/or modify
+ * it under the terms of the MIT license. See LICENSE for details.
+ */
+
+#include <stddef.h>
+#include <string.h>
+#include <errno.h>
+#include <sys/mount.h>
+
+#include "lib/util_log.h"
+
+#include "mount.h"
+
+int mount_debugfs(const char *target)
+{
+	int ret;
+
+	util_log_print(UTIL_LOG_INFO, "Mount debugfs on %s\n", target);
+
+	ret = mount("none", target, "debugfs", 0, NULL);
+	if (ret) {
+		util_log_print(UTIL_LOG_ERROR, "mount syscall failed (%s)\n",
+			       strerror(errno));
+		return -1;
+	}
+
+	return 0;
+}
+
+int bind_mount(const char *src, const char *target)
+{
+	int ret;
+
+	util_log_print(UTIL_LOG_INFO, "Bind mount %s on %s\n", src, target);
+
+	ret = mount(src, target, "", MS_BIND, NULL);
+	if (ret) {
+		util_log_print(UTIL_LOG_ERROR, "mount syscall failed (%s)\n",
+			       strerror(errno));
+		return -1;
+	}
+
+	return 0;
+}
+
+int unmount_detach(const char *target)
+{
+	int ret;
+
+	util_log_print(UTIL_LOG_INFO, "Unmount detach %s\n", target);
+
+	ret = umount2(target, MNT_DETACH);
+	if (ret) {
+		util_log_print(UTIL_LOG_ERROR, "umount2 syscall failed (%s)\n",
+			       strerror(errno));
+		return -1;
+	}
+
+	return 0;
+}

hsavmcore/mount.h

@@ -0,0 +1,17 @@
+/*
+ * Copyright IBM Corp. 2021
+ *
+ * s390-tools is free software; you can redistribute it and/or modify
+ * it under the terms of the MIT license. See LICENSE for details.
+ */
+
+#ifndef _HSAVMCORE_MOUNT_H
+#define _HSAVMCORE_MOUNT_H
+
+int mount_debugfs(const char *target);
+
+int bind_mount(const char *src, const char *target);
+
+int unmount_detach(const char *target);
+
+#endif

hsavmcore/overlay.c

@@ -0,0 +1,209 @@
+/*
+ * Copyright IBM Corp. 2021
+ *
+ * s390-tools is free software; you can redistribute it and/or modify
+ * it under the terms of the MIT license. See LICENSE for details.
+ */
+
+#include <limits.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <errno.h>
+#include <sys/types.h>
+#include <sys/stat.h>
+#include <fcntl.h>
+#include <unistd.h>
+
+#define FUSE_USE_VERSION 26
+#include <fuse.h>
+
+#include "lib/util_log.h"
+
+#include "common.h"
+#include "overlay.h"
+
+#define ROOT_DIR "/"
+
+struct vmcore_overlay {
+	struct vmcore_proxy *vmcore_proxy;
+	char mount_point[PATH_MAX];
+	bool fuse_debug;
+};
+
+static int vmcore_fuse_getattr(const char *path, struct stat *stbuf)
+{
+	struct vmcore_overlay *overlay = fuse_get_context()->private_data;
+	int ret = 0;
+
+	memset(stbuf, 0, sizeof(struct stat));
+
+	if (strcmp(path, ROOT_DIR) == 0) {
+		stbuf->st_mode = S_IFDIR | 0755;
+		stbuf->st_nlink = 2;
+	} else if (strcmp(path + 1, VMCORE_FILE) == 0) {
+		stbuf->st_mode = S_IFREG | 0444;
+		stbuf->st_nlink = 1;
+		stbuf->st_size = vmcore_proxy_size(overlay->vmcore_proxy);
+	} else {
+		ret = -ENOENT;
+	}
+
+	return ret;
+}
+
+static int vmcore_fuse_readdir(const char *path, void *buf,
+			       fuse_fill_dir_t filler, off_t offset,
+			       struct fuse_file_info *fi)
+{
+	(void)offset;
+	(void)fi;
+
+	if (strcmp(path, ROOT_DIR) != 0)
+		return -ENOENT;
+
+	/* We have only one file */
+	filler(buf, ".", NULL, 0);
+	filler(buf, "..", NULL, 0);
+	filler(buf, VMCORE_FILE, NULL, 0);
+
+	return 0;
+}
+
+static int vmcore_fuse_open(const char *path, struct fuse_file_info *fi)
+{
+	if (strcmp(path + 1, VMCORE_FILE) != 0)
+		return -ENOENT;
+
+	if ((fi->flags & O_ACCMODE) != O_RDONLY)
+		return -EACCES;
+
+	return 0;
+}
+
+static int vmcore_fuse_read(const char *path, char *buf, size_t size,
+			    off_t offset, struct fuse_file_info *fi)
+{
+	(void)fi;
+
+	if (strcmp(path + 1, VMCORE_FILE) != 0)
+		return -ENOENT;
+
+	struct vmcore_overlay *overlay = fuse_get_context()->private_data;
+
+	return read_vmcore_proxy_at(overlay->vmcore_proxy, offset, buf, size);
+}
+
+static int setup_fuse_args(struct fuse_args *args, const char *mount_point,
+			   bool debug)
+{
+	int ret;
+
+	ret = fuse_opt_add_arg(args, NAME);
+	if (ret)
+		goto done;
+
+	/* Single-threaded */
+	ret = fuse_opt_add_arg(args, "-s");
+	if (ret)
+		goto done;
+
+	/* Foreground */
+	ret = fuse_opt_add_arg(args, "-f");
+	if (ret)
+		goto done;
+
+	/* Debugging */
+	if (debug) {
+		ret = fuse_opt_add_arg(args, "-d");
+		if (ret)
+			goto done;
+	}
+
+	ret = fuse_opt_add_arg(args, mount_point);
+	if (ret)
+		goto done;
+
+done:
+	if (ret)
+		return -1;
+	else
+		return 0;
+}
+
+struct vmcore_overlay *make_vmcore_overlay(struct vmcore_proxy *vmcore_proxy,
+					   const char *mount_point,
+					   bool fuse_debug)
+{
+	struct vmcore_overlay *overlay;
+
+	util_log_print(UTIL_LOG_INFO, "vmcore overlay: mountpoint=%s\n",
+		       mount_point);
+
+	overlay = malloc(sizeof(struct vmcore_overlay));
+	if (!overlay) {
+		util_log_print(UTIL_LOG_ERROR, "malloc failed\n");
+		return NULL;
+	}
+
+	overlay->vmcore_proxy = vmcore_proxy;
+	strncpy(overlay->mount_point, mount_point,
+		sizeof(overlay->mount_point) - 1);
+	/* Ensure null termination */
+	overlay->mount_point[sizeof(overlay->mount_point) - 1] = '\0';
+	overlay->fuse_debug = fuse_debug;
+
+	return overlay;
+}
+
+void destroy_vmcore_overlay(struct vmcore_overlay *overlay)
+{
+	free(overlay);
+}
+
+/*
+ * FUSE file system operations
+ */
+static struct fuse_operations vmcore_fuse_ops = {
+	.getattr = vmcore_fuse_getattr,
+	.readdir = vmcore_fuse_readdir,
+	.open = vmcore_fuse_open,
+	.read = vmcore_fuse_read,
+};
+
+int serve_vmcore_overlay(struct vmcore_overlay *overlay)
+{
+	struct fuse_args args = FUSE_ARGS_INIT(0, NULL);
+	int ret;
+
+	util_log_print(UTIL_LOG_DEBUG, "vmcore overlay: FUSE main\n");
+
+	ret = setup_fuse_args(&args, overlay->mount_point, overlay->fuse_debug);
+	if (ret < 0)
+		goto free_args;
+
+	/* Create mount point */
+	ret = mkdir(overlay->mount_point, 0755);
+	if (ret < 0) {
+		util_log_print(UTIL_LOG_ERROR, "mkdir syscall failed (%s)\n",
+			       strerror(errno));
+		goto free_args;
+	}
+
+	/*
+	 * Run file system, blocks until a signal has been received or an error
+	 * occurred.
+	 */
+	fuse_main(args.argc, args.argv, &vmcore_fuse_ops, overlay);
+
+	/* Remove mount point */
+	rmdir(overlay->mount_point);
+
+	ret = 0;
+
+free_args:
+
+	fuse_opt_free_args(&args);
+
+	return ret;
+}

hsavmcore/overlay.h

@@ -0,0 +1,33 @@
+/*
+ * Copyright IBM Corp. 2021
+ *
+ * s390-tools is free software; you can redistribute it and/or modify
+ * it under the terms of the MIT license. See LICENSE for details.
+ */
+
+#ifndef _HSAVMCORE_OVERLAY_H
+#define _HSAVMCORE_OVERLAY_H
+
+#include <stdbool.h>
+
+#include "proxy.h"
+
+/*
+ * A vmcore Overlay exports a vmcore Proxy as a normal read-only file
+ * that could be used, for instance, by *makedumpfile*.
+ */
+
+struct vmcore_overlay;
+
+struct vmcore_overlay *make_vmcore_overlay(struct vmcore_proxy *vmcore_proxy,
+					   const char *mount_point,
+					   bool fuse_debug);
+
+void destroy_vmcore_overlay(struct vmcore_overlay *overlay);
+
+/*
+ * This method handles all file system calls and blocks until a signal arrives.
+ */
+int serve_vmcore_overlay(struct vmcore_overlay *overlay);
+
+#endif

hsavmcore/proxy.c

@@ -0,0 +1,198 @@
+/*
+ * Copyright IBM Corp. 2021
+ *
+ * s390-tools is free software; you can redistribute it and/or modify
+ * it under the terms of the MIT license. See LICENSE for details.
+ */
+
+#include <limits.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <errno.h>
+#include <sys/types.h>
+#include <sys/stat.h>
+#include <fcntl.h>
+#include <unistd.h>
+
+#include "lib/zt_common.h"
+#include "lib/util_log.h"
+
+#include "proxy.h"
+
+struct vmcore_proxy {
+	int vmcore_fd;
+	long vmcore_size;
+	struct hsa_reader *hsa_reader;
+};
+
+static int read_file_at(int fd, long offset, void *buf, int size)
+{
+	long n, nread = 0;
+
+	util_log_print(UTIL_LOG_DEBUG,
+		       "vmcore proxy vmcore read: offset=%lx size=%x\n", offset,
+		       size);
+
+	n = lseek(fd, offset, SEEK_SET);
+	if (n < 0) {
+		util_log_print(UTIL_LOG_ERROR, "lseek syscall failed (%s)\n",
+			       strerror(errno));
+		return -1;
+	}
+
+	while (size) {
+		n = read(fd, buf + nread, size);
+		if (n < 0) {
+			util_log_print(UTIL_LOG_ERROR,
+				       "read syscall failed (%s)\n",
+				       strerror(errno));
+			return -1;
+		} else if (n == 0) {
+			break;
+		}
+
+		nread += n;
+		size -= n;
+	}
+
+	return nread;
+}
+
+static long get_vmcore_size(int fd)
+{
+	long n, size;
+
+	/* Get vmcore file size */
+	n = lseek(fd, 0, SEEK_END);
+	if (n < 0) {
+		util_log_print(UTIL_LOG_ERROR, "lseek syscall failed (%s)\n",
+			       strerror(errno));
+		return 0;
+	}
+
+	size = n;
+
+	/* Reset vmcore file position */
+	n = lseek(fd, 0, SEEK_SET);
+	if (n < 0) {
+		util_log_print(UTIL_LOG_ERROR, "lseek syscall failed (%s)\n",
+			       strerror(errno));
+		return 0;
+	}
+
+	return size;
+}
+
+struct vmcore_proxy *make_vmcore_proxy(const char *vmcore_path,
+				       struct hsa_reader *hsa_reader)
+{
+	struct vmcore_proxy *proxy;
+	int vmcore_fd;
+	long vmcore_size;
+
+	util_log_print(UTIL_LOG_INFO, "vmcore proxy: vmcore path=%s\n",
+		       vmcore_path);
+
+	/* Open vmcore file */
+	vmcore_fd = open(vmcore_path, O_RDONLY);
+	if (vmcore_fd < 0) {
+		util_log_print(UTIL_LOG_ERROR, "open syscall failed (%s)\n",
+			       strerror(errno));
+		return NULL;
+	}
+
+	vmcore_size = get_vmcore_size(vmcore_fd);
+	if (!vmcore_size) {
+		close(vmcore_fd);
+		return NULL;
+	}
+
+	util_log_print(UTIL_LOG_INFO, "vmcore proxy: vmcore size=%lx\n",
+		       vmcore_size);
+
+	proxy = malloc(sizeof(struct vmcore_proxy));
+	if (!proxy) {
+		util_log_print(UTIL_LOG_ERROR, "malloc failed\n");
+		close(vmcore_fd);
+		return NULL;
+	}
+
+	proxy->vmcore_fd = vmcore_fd;
+	proxy->vmcore_size = vmcore_size;
+	proxy->hsa_reader = hsa_reader;
+
+	return proxy;
+}
+
+void destroy_vmcore_proxy(struct vmcore_proxy *proxy)
+{
+	close(proxy->vmcore_fd);
+	free(proxy);
+}
+
+long vmcore_proxy_size(struct vmcore_proxy *proxy)
+{
+	return proxy->vmcore_size;
+}
+
+int read_vmcore_proxy_at(struct vmcore_proxy *proxy, long offset, void *buf,
+			 int size)
+{
+	const long hsa_size = hsa_get_size(proxy->hsa_reader);
+	const long hsa_vmcore_offset = hsa_get_vmcore_offset(proxy->hsa_reader);
+	long nread = 0;
+
+	util_log_print(UTIL_LOG_DEBUG,
+		       "vmcore proxy read: offset=%lx size=%x\n", offset, size);
+
+	/*
+	 * The caller might try to read beyond the maximum length of vmcore.
+	 * This guarantees the termination of the loop below in that case.
+	 */
+	size = MIN(proxy->vmcore_size - offset, size);
+
+	/*
+	 * 0                 HSA offset          HSA offset +        vmcore size
+	 *                                       HSA size
+	 *
+	 * +---------------------+---------------------+-----------------------+
+	 * |                     |                     |                       |
+	 * |  vmcore 1st part    |  HSA memory region  |    vmcore 2nd part    |
+	 * |                     |                     |                       |
+	 * +---------------------+---------------------+-----------------------+
+	 */
+
+	while (size) {
+		long n, nbyte;
+
+		if (offset < hsa_vmcore_offset) {
+			/* vmcore 1st part */
+			nbyte = MIN(hsa_vmcore_offset - offset, size);
+			n = read_file_at(proxy->vmcore_fd, offset, buf + nread,
+					 nbyte);
+		} else if (offset >= hsa_vmcore_offset &&
+			   offset < (hsa_vmcore_offset + hsa_size)) {
+			/* HSA memory region */
+			nbyte = MIN(hsa_vmcore_offset + hsa_size - offset,
+				    size);
+			n = read_hsa_at(proxy->hsa_reader,
+					offset - hsa_vmcore_offset,
+					buf + nread, nbyte);
+		} else {
+			/* vmcore 2nd part */
+			nbyte = MIN(proxy->vmcore_size - offset, size);
+			n = read_file_at(proxy->vmcore_fd, offset, buf + nread,
+					 nbyte);
+		}
+
+		if (n != nbyte)
+			return -1;
+
+		nread += n;
+		size -= n;
+		offset += n;
+	}
+
+	return nread;
+}

hsavmcore/proxy.h

@@ -0,0 +1,35 @@
+/*
+ * Copyright IBM Corp. 2021
+ *
+ * s390-tools is free software; you can redistribute it and/or modify
+ * it under the terms of the MIT license. See LICENSE for details.
+ */
+
+#ifndef _HSAVMCORE_PROXY_H
+#define _HSAVMCORE_PROXY_H
+
+#include "hsa.h"
+
+/*
+ * A vmcore Proxy combines the original /proc/vmcore file with a HSA memory
+ * reader into a new interface which can be used to read vmcore data w/o being
+ * aware that the HSA memory region is NOT contained in the file /proc/vmcore.
+ *
+ * After releasing the HSA memory, the original /proc/vmcore will contain
+ * a *hole* where the HSA memory was located. The vmcore proxy hides this
+ * inconvenience from the user of this interface.
+ */
+
+struct vmcore_proxy;
+
+struct vmcore_proxy *make_vmcore_proxy(const char *vmcore_path,
+				       struct hsa_reader *hsa_reader);
+
+void destroy_vmcore_proxy(struct vmcore_proxy *proxy);
+
+long vmcore_proxy_size(struct vmcore_proxy *proxy);
+
+int read_vmcore_proxy_at(struct vmcore_proxy *proxy, long offset, void *buf,
+			 int size);
+
+#endif

hsavmcore/swap.c

@@ -0,0 +1,51 @@
+/*
+ * Copyright IBM Corp. 2021
+ *
+ * s390-tools is free software; you can redistribute it and/or modify
+ * it under the terms of the MIT license. See LICENSE for details.
+ */
+
+#include <limits.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <errno.h>
+#include <unistd.h>
+#include <sys/swap.h>
+
+#include "lib/util_log.h"
+
+#include "common.h"
+#include "swap.h"
+
+int swap_on(const char *path)
+{
+	int ret;
+
+	util_log_print(UTIL_LOG_INFO, "Swap on %s\n", path);
+
+	ret = swapon(path, 0);
+	if (ret) {
+		util_log_print(UTIL_LOG_ERROR, "swapon syscall failed (%s)\n",
+			       strerror(errno));
+		return ret;
+	}
+
+	return 0;
+}
+
+int swap_off(const char *path)
+{
+	int ret;
+
+	util_log_print(UTIL_LOG_INFO, "Swap off %s\n", path);
+
+	ret = swapoff(path);
+	if (ret) {
+		util_log_print(UTIL_LOG_ERROR, "swapoff syscall failed (%s)\n",
+			       strerror(errno));
+		return ret;
+	}
+
+	return 0;
+}

hsavmcore/swap.h

@@ -0,0 +1,15 @@
+/*
+ * Copyright IBM Corp. 2021
+ *
+ * s390-tools is free software; you can redistribute it and/or modify
+ * it under the terms of the MIT license. See LICENSE for details.
+ */
+
+#ifndef _HSAVMCORE_SWAP_H
+#define _HSAVMCORE_SWAP_H
+
+int swap_on(const char *path);
+
+int swap_off(const char *path);
+
+#endif

hsci/Makefile

@@ -0,0 +1,16 @@
+include ../common.mak
+
+all:
+
+install: hsci
+	$(SED) -e 's/%S390_TOOLS_VERSION%/$(S390_TOOLS_RELEASE)/' \
+	< hsci >$(DESTDIR)$(BINDIR)/hsci; \
+	chown $(OWNER).$(GROUP) $(DESTDIR)$(BINDIR)/hsci; \
+	chmod 755 $(DESTDIR)$(BINDIR)/hsci; \
+	$(INSTALL) -d -m 755 $(DESTDIR)$(BINDIR) $(DESTDIR)$(MANDIR)/man8
+	$(INSTALL) -g $(GROUP) -o $(OWNER) -m 644 hsci.8 \
+		$(DESTDIR)$(MANDIR)/man8
+
+clean:
+
+.PHONY: all install clean

hsci/hsci

@@ -0,0 +1,436 @@
+#!/bin/bash
+#
+# hsci - Tool to manage HiperSockets Converged Interfaces (HSCI)
+#
+# Copyright IBM Corp. 2020
+#
+# s390-tools is free software; you can redistribute it and/or modify
+# it under the terms of the MIT license. See LICENSE for details.
+#
+
+hsdev=""
+ndev=""
+hsci=""
+hsdev_mac=""
+hsif_pnetid=""
+netif_pnetid=""
+hsci_pnetid=""
+
+function usage {
+cat <<-EOD
+Usage: hsci COMMAND [OPTION]
+
+This tool is designed to control and show HSCI (HiperSockets Converged
+Interfaces) settings. A HiperSockets interface and an external network
+interface are converged into an HSCI interface.
+
+COMMANDS
+        add HIPERSOCKETS_DEV NET_DEV    Adds an HSCI interface
+        del HSCI_NAME                   Deletes an HSCI interface
+        show                            Lists the configured HSCI interfaces
+
+OPTIONS:
+        -v, --version                   Prints the version number of the hsci tool and exits
+        -h, --help                      Displays the help information for the command
+EOD
+}
+
+function prereqs_check {
+	if ! [ -x "$(command -v ip)" ]; then
+		echo "Error: No iproute2 installed on this system" >&2
+		return 1
+	fi
+}
+
+function check_pnetids {
+	# get PNETID of the HS
+	local hsif_pnetids=""
+	local netif_pnetids=""
+
+	if [ -e /sys/class/net/$hsdev/device/util_string ]; then
+		hsif_pnetids="$(cat /sys/class/net/$hsdev/device/util_string | tr -d '\000' | iconv -f IBM-1047 -t ASCII)"
+	else
+		if [ -e /sys/class/net/$hsdev/device/chpid ]; then
+			chpid="$(cat /sys/class/net/$hsdev/device/chpid | tr [:upper:] [:lower:])"
+			hsif_pnetids="$(cat /sys/devices/css0/chp0.$chpid/util_string | tr -d '\000' | iconv -f IBM-1047 -t ASCII)"
+		fi
+	fi
+	if [ "$hsif_pnetids" != "" ]; then
+		port_hsif="$(cat /sys/class/net/$hsdev/dev_port)"
+		(( idx=16*$port_hsif+1 ))
+		(( end=$idx+15 ))
+		hsif_pnetid="$(echo "$hsif_pnetids" | cut -c $idx-$end | tr -d ' ')"
+	fi
+
+	# get PNETID of the NET_DEV
+	if [ -e /sys/class/net/$ndev/device/util_string ]; then
+		netif_pnetids="$(cat /sys/class/net/$ndev/device/util_string | tr -d '\000' | iconv -f IBM-1047 -t ASCII)"
+	else
+		if [ -e /sys/class/net/$ndev/device/chpid ]; then
+			chpid="$(cat /sys/class/net/$ndev/device/chpid | tr [:upper:] [:lower:])"
+			netif_pnetids="$(cat /sys/devices/css0/chp0.$chpid/util_string | tr -d '\000' | iconv -f IBM-1047 -t ASCII)"
+		fi
+	fi
+	if [ "$netif_pnetids" != "" ]; then
+		port_netif="$(cat /sys/class/net/$ndev/dev_port)"
+		(( idx=16*$port_netif+1 ))
+		(( end=$idx+15 ))
+		netif_pnetid="$(echo "$netif_pnetids" | cut -c $idx-$end | tr -d ' ')"
+	fi
+
+	#Check PNETIDs
+	if [ "$hsif_pnetid" != "" ] && [ "$netif_pnetid" != "" ] && [ "$netif_pnetid" != "$hsif_pnetid" ]; then
+		echo "Error: $hsdev and $ndev have different PNETIDs! They are $hsif_pnetid and $netif_pnetid respectively" >&2
+		return 1
+	fi
+
+	if [ "$hsif_pnetid" != "" ] && [ "$netif_pnetid" != "" ] && [ "$netif_pnetid" == "$hsif_pnetid" ]; then
+		hsci_pnetid=$hsif_pnetid
+	fi
+}
+
+function verify_precon {
+	echo "Verifying net dev $ndev and HiperSockets dev $hsdev"
+
+	if [ ! -e /sys/class/net/$hsdev ]; then
+		echo "Error: $hsdev does not exist" >&2
+		return 1
+	fi
+	if [ "$(cat /sys/class/net/$hsdev/device/card_type)" != "HiperSockets" ]; then
+		echo "Error: $hsdev is not a HiperSockets device" >&2
+		return 1
+	fi
+	if [ "$(cat /sys/class/net/$hsdev/device/layer2)" != "1" ]; then
+		echo "Error: $hsdev is not in layer 2 mode" >&2
+		return 1
+	fi
+	if [ ! -e /sys/class/net/$hsdev/device/vnicc/bridge_invisible ]; then
+		echo "Error: Missing vnic-characteristics support" >&2
+		return 1
+	fi
+	if [ "$(cat /sys/class/net/$hsdev/device/vnicc/bridge_invisible)" == "n/a" ]; then
+		echo "Error: $hsdev does not support vnicc" >&2
+		return 1
+	fi
+	if [ $(ip link show $hsdev | grep UP | wc -l) -eq 0 ]; then
+		echo "Error: $hsdev is not in state UP" >&2
+		return 1
+	fi
+	if [ $(bridge -d link show dev $hsdev self | grep learning_sync | wc -l) -eq 0 ]; then
+		echo "Error: $hsdev does not support attribute learning_sync" >&2
+		return 1
+	fi
+	if [ $(ip link show $hsdev | grep master | wc -l) -ne 0 ]; then
+		echo "Error: $hsdev is already a bridge port" >&2
+		return 1
+	fi
+
+	#Pre-verify net_dev
+	if [ ! -e /sys/class/net/$ndev ]; then
+		echo "Error: $ndev does not exist" >&2
+		return 1
+	fi
+	if [ "$(cat /sys/class/net/$ndev/device/card_type)" == "HiperSockets" ]; then
+		echo "Error: $ndev is also a HiperSockets device" >&2
+		return 1
+	fi
+	if [ $(ip link show $ndev | grep UP | wc -l) -eq 0 ]; then
+		echo "Error: $ndev is not in state UP" >&2
+		return 1
+	fi
+	if [ $(ip link show $ndev | grep master | wc -l) -ne 0 ]; then
+		echo "Error: $ndev is already a bridge port" >&2
+		return 1
+	fi
+
+	#Check PNETIDs
+	check_pnetids
+	if [ $? -ne 0 ]; then
+		return 1
+	fi
+
+	return 0
+}
+
+function clean_up {
+	bridge link set dev $hsdev learning_sync off self >/dev/null 2>&1
+	echo 0 > /sys/class/net/$hsdev/device/vnicc/bridge_invisible >/dev/null 2>&1
+	bridge fdb del $hsdev_mac dev $ndev >/dev/null 2>&1
+	ip link del $hsci >/dev/null 2>&1
+}
+
+##############################################################################
+##	add a new HSCI interface
+##############################################################################
+function add_hsci {
+
+	if [ $# != 2 ]; then
+		echo "hsci: Invalid parameters" >&2
+		echo "Use 'hsci --help' for more information" >&2
+		return 1
+	fi
+	hsdev=$1
+	ndev=$2
+
+	#### Verify preconditions
+	verify_precon
+	if [ $? -ne 0 ]; then
+		return 1
+	fi
+
+	hsci_postfix="$(readlink /sys/class/net/$hsdev/device/cdev0 | tail -c5)"
+	hsci=hsci$hsci_postfix
+
+	echo "Adding $hsci with a HiperSockets dev $hsdev and an external dev $ndev"
+
+	#### Create bridge
+	ip link add name $hsci type bridge stp_state 0 >/dev/null 2>&1
+	if [ $? -ne 0 ]; then
+		echo "Error: Could not create a bridge" >&2
+		return 1
+	fi
+
+	#### Prepare hsdev
+	# Set VNICC of hsdev to invisible
+	#(mandatory for co-existence with HS-OSA bridges!)
+	echo 1 > /sys/class/net/$hsdev/device/vnicc/bridge_invisible
+
+	#### Create bridge ports
+	ip link set dev $ndev master $hsci >/dev/null 2>&1
+	if [ $? -ne 0 ]; then
+		echo "Error: Could not set master for $ndev" >&2
+		clean_up
+		return 1
+	fi
+	ip link set dev $hsdev master $hsci >/dev/null 2>&1
+	if [ $? -ne 0 ]; then
+		echo "Error: Could not set master for $hsdev" >&2
+		clean_up
+		return 1
+	fi
+
+	# no forwarding between ndev and hsdev -> isolated on
+	# ndev is default for outgoing unknown targets -> flood on
+	# no need to learn external LAN targets into fdb -> learning off
+	bridge link set dev $ndev isolated on learning off flood on mcast_flood on >/dev/null 2>&1
+	if [ $? -ne 0 ]; then
+		echo "Error: Failed to set bridge attributes on $ndev" >&2
+		clean_up
+		return 1
+	fi
+
+	# no forwarding between ndev and hsdev -> isolated on
+	# fdb will be populated by dev-to-bridge-notification, no need to learn
+	#	-> learning off
+	# only send to hsdev, if listed in fdb -> flood off
+	# don't send MC/BC on hsdev -> mcast_flood off
+	bridge link set dev $hsdev isolated on learning off flood off mcast_flood off >/dev/null 2>&1
+	if [ $? -ne 0 ]; then
+		echo "Error: Failed to set bridge attributes on $hsdev" >&2
+		clean_up
+		return 1
+	fi
+
+	# NOTE: Although not required, BCs will be sent out on hsdev.
+	# NOTE: We need to receive BCs on hsdev, as z/OS HSCI does ARP requests on HS.
+
+	hsdev_mac="$(cat /sys/class/net/$hsdev/address)"
+	echo "Set $hsdev MAC $hsdev_mac on $ndev and $hsci"
+
+	# set HS MAC on OSA as secondary MAC
+	bridge fdb add $hsdev_mac dev $ndev >/dev/null 2>&1
+	if [ $? -ne 0 ]; then
+		echo "Error: Failed to set HS MAC on OSA as secondary MAC" >&2
+		clean_up
+		return 1
+	fi
+
+	# set HS MAC (common MAC) on HSCI as primary MAC
+	ip link set address $hsdev_mac dev $hsci >/dev/null 2>&1
+	if [ $? -ne 0 ]; then
+		echo "Error: Failed to set HiperSockets MAC (common MAC) on HSCI as primary MAC" >&2
+		clean_up
+		return 1
+	fi
+
+	ip link set dev $hsci up >/dev/null 2>&1
+	if [ $? -ne 0 ]; then
+		echo "Error: Failed to set $hsci up" >&2
+		clean_up
+		return 1
+	fi
+
+	# Turn on device for bridge notification
+	bridge link set dev $hsdev learning_sync on self >/dev/null 2>&1
+	if [ $? -ne 0 ]; then
+		echo "Error: Failed to turn on device for bridge notification" >&2
+		clean_up
+		return 1
+	fi
+	echo "Successfully added HSCI interface $hsci"
+	return 0
+}
+
+##############################################################################
+##	Delete HSCI
+##############################################################################
+
+function del_hsci {
+	if [ $# != 1 ]; then
+		echo "hsci: invalid parameters" >&2
+		echo "Use 'hsci --help' for more information" >&2
+		return 1
+	fi
+	hsci=$1
+	if [ $(ip link show dev $hsci | wc -l) -eq 0 ]; then
+		echo "Error: $hsci does not exit" >&2
+		return 1
+	fi
+	if [ $(ip link show | grep "master $hsci" | wc -l) -eq 0 ]; then
+		echo "Error: $hsci is not an active HSCI interface" >&2
+		return 1
+	fi
+
+	bports="$(ip link show | grep "master $hsci" | awk '{print $2}')"
+	for bport in $bports; do
+		bport=${bport%:}
+			if [[ $bport == *@* ]]; then
+				bport=${bport%@*}
+			fi
+		if [ $(bridge -d link show dev $bport | grep "learning_sync on" | wc -l) -ne 0 ]; then
+			hsdev=$bport
+		else
+			ndev=$bport
+		fi
+	done
+	if [ "$hsdev" == "" ]; then
+		echo "Error: $hsci has no active HiperSockets port" >&2
+		return 1
+	fi
+	echo "Deleting HSCI interface $hsci with the HiperSockets $hsdev and the external $ndev"
+
+	bridge link set dev $hsdev learning_sync off self >/dev/null 2>&1
+	if [ $? -ne 0 ]; then
+		echo "Error: Failed to turn off learning_sync on $hsdev" >&2
+		return 1
+	fi
+	echo 0 > /sys/class/net/$hsdev/device/vnicc/bridge_invisible
+
+	hsdev_mac="$(cat /sys/class/net/$hsdev/address)"
+	echo "Deleting $hsev MAC $hsdev_mac on $ndev"
+	bridge fdb del $hsdev_mac dev $ndev >/dev/null 2>&1
+	if [ $? -ne 0 ]; then
+		echo "Error: Failed to delete $hsev MAC $hsdev_mac on $ndev" >&2
+		return 1
+	fi
+
+	ip link del $hsci >/dev/null 2>&1
+	if [ $? -ne 0 ]; then
+		echo "Error: Failed to delete $hsci" >&2
+		return 1
+	fi
+	echo "Successfully deleted device $hsci"
+
+	return 0
+}
+
+##############################################################################
+##	Show HSCI
+##############################################################################
+
+function list_active {
+	hsdev=$1
+	local ext=""
+
+	hsci="$(ip link show dev $hsdev | awk '{for(x=1;x<NF;x++) if($x~/master/) print $(x+1)}')"
+	ext="$(ip link show | grep "master $hsci" | grep --invert-match $hsdev | awk '{print $2}')"
+	# remove trailing ':'
+	ndev="${ext%:}"
+
+	check_pnetids
+
+	printf '%-8s  %-16s  %-15s  %-15s\n' "$hsci" "$hsci_pnetid" "$hsdev" "$ndev"
+
+	return 0
+}
+
+function print_header {
+	if [ $header -eq 0 ]; then
+		echo "HSCI      PNET_ID           HiperSockets     External       "
+		echo "------------------------------------------------------------"
+	fi
+}
+
+function list_one {
+	local hsnetdev=$1
+
+	if [ $(bridge -d link show dev $hsnetdev | grep	 "learning_sync on" | wc -l) -ne 0 ]; then
+		print_header
+		list_active $hsnetdev
+	fi
+
+	return 0
+}
+
+function show_hsci {
+	if [ $# != 0 ]; then
+		echo "hsci: invalid parameters" >&2
+		echo "Use 'hsci --help' for more information" >&2
+		return 1
+	fi
+	header=0
+
+	for hs_net_dev in $(ls -1 /sys/class/net/); do
+		list_one $hs_net_dev
+	done
+
+	return 0
+}
+
+#==============================================================================
+
+function print_version()
+{
+	echo "hsci utility: version %S390_TOOLS_VERSION%"
+	echo "Copyright IBM Corp. 2020"
+}
+
+##############################################################################
+##### Main
+##############################################################################
+prereqs_check
+
+args="$(getopt -u -o hv -l help,version -- $*)"
+[ $? -ne 0 ] && exit 2
+set -- $args
+while true; do
+	case $1 in
+		-v | --version)
+			print_version
+			exit 0
+			;;
+		-h | --help)
+			usage
+			exit 0
+			;;
+		--)
+			;;
+		add)	shift
+			add_hsci "$@"
+			exit $?
+			;;
+		del)	shift
+			del_hsci "$@"
+			exit $?
+			;;
+		show)	shift
+			show_hsci "$@"
+			exit $?
+			;;
+		*)	echo "hsci: Please specify a valid command or option" >&2
+			echo "Use 'hsci --help' for more information" >&2
+			exit 1
+	esac
+	shift
+done
+

hsci/hsci.8

@@ -0,0 +1,100 @@
+.\" Copyright IBM Corp. 2020
+
+.TH HSCI 8 "November 2020" "s390-tools" "Linux Programmer's Manual"
+
+
+.SH NAME
+.B hsci
+\- control and show HSCI settings.
+
+
+.SH SYNOPSIS
+.B hsci add
+.I HSDEV
+.I NETDEV
+.br
+.B hsci del
+.I HSCINAME
+.br
+.B hsci show
+.br
+.B hsci [\-hv]
+
+.SH DESCRIPTION
+.BI hsci
+is used to control and show HSCI (HiperSockets Converged Interfaces) settings. A HiperSockets interface and an external network interface are converged into an HSCI interface.
+
+.SH COMMANDS
+.TP
+.B add \fIHSDEV\fR \fINETDEV\fR
+.RS .4i
+.PP
+Adds an HSCI interface
+.PP
+.I HSDEV
+is the interface name of the HiperSockets device to be converged into the HSCI interface.
+.PP
+.I NETDEV
+is the interface name of the external network device to be converged into the HSCI interface.
+.RE
+
+.TP
+.B del \fIHSCINAME\fR
+.RS .4i
+.PP
+Deletes an HSCI interface
+.PP
+.I HSCINAME
+is the name of the HSCI interface for the HiperSockets device and the external network device.
+.RE
+
+.TP
+.B show
+.RS .4i
+.PP
+Lists the configured HSCI interfaces.
+.RE
+
+.SH OPTIONS
+.TP
+.BR \-v ", " \-\-version
+Prints the version number of hsci and exits.
+.TP
+.BR \-h ", " \-\-help
+Displays the help information for the command.
+
+.SH EXIT CODES
+.TP
+.BR "0"
+The hsci command ran successfully.
+
+.TP
+.BR "1"
+An error occurred.
+
+.SH EXAMPLE
+.BR "hsci show"
+.TP
+.RB
+Lists the configured HSCI interfaces:
+.RS 1.2i
+
+HSCI      PNET_ID  HiperSockets  External
+.br
+-----------------------------------------
+.br
+hsci8410  NET1     enc8410       encb040
+
+.RE
+
+.SH SEE ALSO
+.nf
+ip(8), bridge(8)
+.fi
+
+.SH AUTHOR
+.nf
+Written by Alexandra Winter <wintera@linux.ibm.com>
+           Wenjia Zhang <wenjia@linux.ibm.com>
+.fi
+

include/lib/libzds.h

@@ -115,7 +115,7 @@
 #include "lib/util_base.h"
 #include "lib/util_list.h"
 #include "vtoc.h"
-
+#include <iconv.h>
 
 
 /**
@@ -834,6 +834,11 @@ void lzds_dshandle_get_errorlog(struct dshandle *dsh, struct errorlog **log);
 int lzds_dshandle_set_seekbuffer(struct dshandle *dsh,
 				 unsigned long long seek_buffer_size);
 
+/**
+ * @brief Set iconv handle for codepage conversion.
+ */
+int lzds_dshandle_set_iconv(struct dshandle *dsh, iconv_t *iconv);
+
 /**
  * @brief Get the size of the data set in number of tracks (sum of all extents).
  */

include/lib/util_arch.h

@@ -0,0 +1,39 @@
+/**
+ * @defgroup util_arch_h util_arch: General architecture helpers
+ * @{
+ * @brief General architecture helpers
+ *
+ * Copyright IBM Corp. 2021
+ *
+ * s390-tools is free software; you can redistribute it and/or modify
+ * it under the terms of the MIT license. See LICENSE for details.
+ */
+
+#ifndef LIB_UTIL_ARCH_H
+#define LIB_UTIL_ARCH_H
+
+enum util_arch_machine_type {
+	UTIL_ARCH_MACHINE_TYPE_UNKNOWN	= 0,
+	UTIL_ARCH_MACHINE_TYPE_Z10_EC	= 2097,
+	UTIL_ARCH_MACHINE_TYPE_Z10_BC	= 2098,
+	UTIL_ARCH_MACHINE_TYPE_ZE_196	= 2817,
+	UTIL_ARCH_MACHINE_TYPE_ZE_114	= 2818,
+	UTIL_ARCH_MACHINE_TYPE_ZE_EC12	= 2827,
+	UTIL_ARCH_MACHINE_TYPE_ZE_BC12	= 2828,
+	UTIL_ARCH_MACHINE_TYPE_Z13	= 2964,
+	UTIL_ARCH_MACHINE_TYPE_Z13_S	= 2965,
+	UTIL_ARCH_MACHINE_TYPE_Z14	= 3906,
+	UTIL_ARCH_MACHINE_TYPE_Z14_ZR1	= 3907,
+	UTIL_ARCH_MACHINE_TYPE_Z15	= 8561,
+	UTIL_ARCH_MACHINE_TYPE_Z15_T02	= 8562,
+};
+
+int util_arch_machine_type(void);
+
+const char *util_arch_machine_type_str(void);
+
+const char *util_arch_machine_type_to_str(int type);
+
+unsigned long util_arch_hsa_maxsize(void);
+
+#endif /** LIB_UTIL_ARCH_H @} */

include/lib/util_log.h

@@ -0,0 +1,28 @@
+/**
+ * @defgroup util_log_h util_log: Multi-level message logging interface
+ * @{
+ * @brief Multi-level message logging
+ *
+ * Copyright IBM Corp. 2021
+ *
+ * s390-tools is free software; you can redistribute it and/or modify
+ * it under the terms of the MIT license. See LICENSE for details.
+ */
+
+#ifndef LIB_UTIL_LOG_H
+#define LIB_UTIL_LOG_H
+
+enum util_log_level {
+	UTIL_LOG_ERROR,
+	UTIL_LOG_WARN,
+	UTIL_LOG_INFO,
+	UTIL_LOG_DEBUG,
+	UTIL_LOG_TRACE,
+	UTIL_LOG_NUM_LEVELS	/* Must be the last one. */
+};
+
+void util_log_set_level(int log_level);
+
+void util_log_print(int log_level, const char *fmt, ...);
+
+#endif /** LIB_UTIL_LOG_H @} */

include/lib/util_proc.h

@@ -27,25 +27,10 @@ struct util_proc_dev_entry {
 	char *name;
 };
 
-/**
- * Container for the fields of the output of /proc/mounts (man fstab)
- */
-struct util_proc_mnt_entry {
-	char *spec;
-	char *file;
-	char *vfstype;
-	char *mntOpts;
-	char *dump;
-	char *passno;
-};
-
 int util_proc_part_get_entry(dev_t device, struct util_proc_part_entry *entry);
 void util_proc_part_free_entry(struct util_proc_part_entry *entry);
 int util_proc_dev_get_entry(dev_t dev, int blockdev,
 			    struct util_proc_dev_entry *entry);
 void util_proc_dev_free_entry(struct util_proc_dev_entry *entry);
-int util_proc_mnt_get_entry(const char *file_name, const char *spec,
-			    struct util_proc_mnt_entry *entry);
-void util_proc_mnt_free_entry(struct util_proc_mnt_entry *entry);
 
 #endif /* LIB_UTIL_PROC_H */

include/lib/util_sys.h

@@ -12,6 +12,11 @@
 #ifndef LIB_UTIL_SYS_H
 #define LIB_UTIL_SYS_H
 
+#include <stdbool.h>
+
 int util_sys_get_dev_addr(const char *dev, char *addr);
+bool util_sys_dev_is_partition(dev_t dev);
+int util_sys_get_partnum(dev_t dev);
+int util_sys_get_base_dev(dev_t dev, dev_t *base_dev);
 
 #endif /** LIB_UTIL_SYS_H @} */

include/libseckey/sk_cca.h

@@ -0,0 +1,48 @@
+/*
+ * libseckey - Secure key library
+ *
+ * Copyright IBM Corp. 2021
+ *
+ * s390-tools is free software; you can redistribute it and/or modify
+ * it under the terms of the MIT license. See LICENSE for details.
+ */
+#ifndef SK_CCA_H
+#define SK_CCA_H
+
+#include <stddef.h>
+#include <stdbool.h>
+
+#include <openssl/evp.h>
+
+#include "libseckey/sk_openssl.h"
+
+#define CCA_MAX_PKA_KEY_TOKEN_SIZE	3500
+
+int SK_CCA_generate_ec_key_pair(const struct sk_ext_cca_lib *cca_lib,
+				int curve_nid, unsigned char *key_token,
+				size_t *key_token_length, bool debug);
+
+int SK_CCA_generate_rsa_key_pair(const struct sk_ext_cca_lib *cca_lib,
+				 size_t modulus_bits, unsigned int pub_exp,
+				 unsigned char *key_token,
+				 size_t *key_token_length, bool debug);
+
+int SK_CCA_get_key_type(const unsigned char *key_token, size_t key_token_length,
+			int *pkey_type);
+
+int SK_CCA_get_secure_key_as_pkey(const struct sk_ext_cca_lib *cca_lib,
+				  const unsigned char *key_token,
+				  size_t key_token_length,
+				  bool rsa_pss, EVP_PKEY **pkey, bool debug);
+
+int SK_CCA_get_public_from_secure_key(const unsigned char *key_token,
+				      size_t key_token_length,
+				      sk_pub_key_func_t pub_key_cb,
+				      void *private,
+				      bool debug);
+
+int SK_CCA_reencipher_key(const struct sk_ext_cca_lib *cca_lib,
+			  unsigned char *key_token, size_t key_token_length,
+			  bool to_new, bool debug);
+
+#endif

include/libseckey/sk_ep11.h

@@ -0,0 +1,177 @@
+/*
+ * libseckey - Secure key library
+ *
+ * Copyright IBM Corp. 2021
+ *
+ * s390-tools is free software; you can redistribute it and/or modify
+ * it under the terms of the MIT license. See LICENSE for details.
+ */
+#ifndef SK_EP11_H
+#define SK_EP11_H
+
+#include <stddef.h>
+#include <stdbool.h>
+
+#include <openssl/evp.h>
+
+#include "libseckey/sk_openssl.h"
+
+#define EP11_MAX_KEY_TOKEN_SIZE		8192
+
+int SK_EP11_generate_ec_key_pair(const struct sk_ext_ep11_lib *ep11_lib,
+				 int curve_nid, unsigned char *key_token,
+				 size_t *key_token_length, bool debug);
+
+int SK_EP11_generate_rsa_key_pair(const struct sk_ext_ep11_lib *ep11_lib,
+				  size_t modulus_bits, unsigned int pub_exp,
+				  bool x9_31, unsigned char *key_token,
+				  size_t *key_token_length, bool debug);
+
+int SK_EP11_get_key_type(const unsigned char *key_token,
+			 size_t key_token_length,
+			 int *pkey_type);
+
+const unsigned char *SK_EP11_get_key_blob(const unsigned char *key_token,
+					  size_t key_token_length);
+
+size_t SK_EP11_get_key_blob_size(const unsigned char *key_token,
+				 size_t key_token_length);
+
+int SK_EP11_get_secure_key_as_pkey(const struct sk_ext_ep11_lib *ep11_lib,
+				   const unsigned char *key_token,
+				   size_t key_token_length,
+				   bool rsa_pss, EVP_PKEY **pkey, bool debug);
+
+int SK_EP11_get_public_from_secure_key(const unsigned char *key_token,
+				       size_t key_token_length,
+				       sk_pub_key_func_t pub_key_cb,
+				       void *private,
+				       bool debug);
+
+int SK_EP11_reencipher_key(const struct sk_ext_ep11_lib *ep11_lib,
+			   unsigned char *key_token, size_t key_token_length,
+			   bool debug);
+
+/* PKCS#11 definitions */
+
+#define CK_PTR *
+
+typedef unsigned char CK_BYTE;
+typedef CK_BYTE CK_CHAR;
+typedef CK_BYTE CK_UTF8CHAR;
+typedef CK_BYTE CK_BBOOL;
+typedef unsigned long CK_ULONG;
+typedef long CK_LONG;
+typedef CK_ULONG CK_FLAGS;
+typedef CK_ULONG CK_RV;
+typedef CK_ULONG CK_SLOT_ID;
+typedef CK_ULONG CK_MECHANISM_TYPE;
+typedef CK_ULONG CK_ATTRIBUTE_TYPE;
+typedef CK_ULONG CK_OBJECT_CLASS;
+typedef CK_ULONG CK_KEY_TYPE;
+typedef CK_ULONG CK_RSA_PKCS_OAEP_SOURCE_TYPE;
+typedef CK_ULONG CK_RSA_PKCS_MGF_TYPE;
+
+typedef CK_BYTE CK_PTR CK_BYTE_PTR;
+typedef CK_CHAR CK_PTR CK_CHAR_PTR;
+typedef CK_UTF8CHAR CK_PTR CK_UTF8CHAR_PTR;
+typedef CK_ULONG CK_PTR CK_ULONG_PTR;
+typedef void CK_PTR CK_VOID_PTR;
+typedef CK_SLOT_ID CK_PTR CK_SLOT_ID_PTR;
+typedef CK_MECHANISM_TYPE CK_PTR CK_MECHANISM_TYPE_PTR;
+typedef CK_RSA_PKCS_MGF_TYPE CK_PTR CK_RSA_PKCS_MGF_TYPE_PTR;
+
+typedef struct CK_MECHANISM {
+	CK_MECHANISM_TYPE mechanism;
+	CK_VOID_PTR pParameter;
+	CK_ULONG ulParameterLen;
+} CK_MECHANISM;
+
+typedef CK_MECHANISM CK_PTR CK_MECHANISM_PTR;
+
+typedef struct CK_ATTRIBUTE {
+	CK_ATTRIBUTE_TYPE type;
+	CK_VOID_PTR pValue;
+	CK_ULONG ulValueLen;
+} CK_ATTRIBUTE;
+
+typedef CK_ATTRIBUTE CK_PTR CK_ATTRIBUTE_PTR;
+
+typedef struct CK_RSA_PKCS_PSS_PARAMS {
+	CK_MECHANISM_TYPE hashAlg;
+	CK_RSA_PKCS_MGF_TYPE mgf;
+	CK_ULONG sLen;
+} CK_RSA_PKCS_PSS_PARAMS;
+
+typedef CK_RSA_PKCS_PSS_PARAMS CK_PTR CK_RSA_PKCS_PSS_PARAMS_PTR;
+
+typedef struct CK_RSA_PKCS_OAEP_PARAMS {
+	CK_MECHANISM_TYPE hashAlg;
+	CK_RSA_PKCS_MGF_TYPE mgf;
+	CK_RSA_PKCS_OAEP_SOURCE_TYPE source;
+	CK_VOID_PTR pSourceData;
+	CK_ULONG ulSourceDataLen;
+} CK_RSA_PKCS_OAEP_PARAMS;
+
+typedef CK_RSA_PKCS_OAEP_PARAMS CK_PTR CK_RSA_PKCS_OAEP_PARAMS_PTR;
+
+#define CKZ_DATA_SPECIFIED		0x00000001
+
+#define CKG_MGF1_SHA1			0x00000001
+#define CKG_MGF1_SHA224			0x00000005
+#define CKG_MGF1_SHA256			0x00000002
+#define CKG_MGF1_SHA384			0x00000003
+#define CKG_MGF1_SHA512			0x00000004
+
+#define CKG_VENDOR_DEFINED		0x80000000UL
+#define CKG_IBM_MGF1_SHA3_224		(CKG_VENDOR_DEFINED + 1)
+#define CKG_IBM_MGF1_SHA3_256		(CKG_VENDOR_DEFINED + 2)
+#define CKG_IBM_MGF1_SHA3_384		(CKG_VENDOR_DEFINED + 3)
+#define CKG_IBM_MGF1_SHA3_512		(CKG_VENDOR_DEFINED + 4)
+
+#define CKR_OK				0x00000000
+#define CKR_VENDOR_DEFINED		0x80000000
+
+#define CKO_PUBLIC_KEY			0x00000002
+#define CKO_PRIVATE_KEY			0x00000003
+
+#define CKK_EC				0x00000003
+
+#define CKM_RSA_PKCS_KEY_PAIR_GEN	0x00000000
+#define CKM_RSA_PKCS			0x00000001
+#define CKM_RSA_PKCS_OAEP		0x00000009
+#define CKM_RSA_X9_31_KEY_PAIR_GEN	0x0000000A
+#define CKM_RSA_X9_31			0x0000000B
+#define CKM_RSA_PKCS_PSS		0x0000000D
+#define CKM_SHA_1			0x00000220
+#define CKM_SHA256			0x00000250
+#define CKM_SHA224			0x00000255
+#define CKM_SHA384			0x00000260
+#define CKM_SHA512			0x00000270
+#define CKM_SHA512_224			0x00000048
+#define CKM_SHA512_256			0x0000004C
+#define CKM_EC_KEY_PAIR_GEN		0x00001040
+#define CKM_ECDSA			0x00001041
+
+#define CKM_VENDOR_DEFINED		0x80000000
+#define CKM_IBM_SHA3_224		(CKM_VENDOR_DEFINED + 0x00010001)
+#define CKM_IBM_SHA3_256		(CKM_VENDOR_DEFINED + 0x00010002)
+#define CKM_IBM_SHA3_384		(CKM_VENDOR_DEFINED + 0x00010003)
+#define CKM_IBM_SHA3_512		(CKM_VENDOR_DEFINED + 0x00010004)
+
+#define CKA_CLASS			0x00000000
+#define CKA_KEY_TYPE			0x00000100
+#define CKA_SENSITIVE			0x00000103
+#define CKA_ENCRYPT			0x00000104
+#define CKA_DECRYPT			0x00000105
+#define CKA_SIGN			0x00000108
+#define CKA_VERIFY			0x0000010A
+#define CKA_DERIVE			0x0000010C
+#define CKA_DECRYPT			0x00000105
+#define CKA_WRAP			0x00000106
+#define CKA_UNWRAP			0x00000107
+#define CKA_MODULUS_BITS		0x00000121
+#define CKA_PUBLIC_EXPONENT		0x00000122
+#define CKA_EC_PARAMS			0x00000180
+
+#endif

include/libseckey/sk_openssl.h

@@ -0,0 +1,234 @@
+/*
+ * libseckey - Secure key library
+ *
+ * Copyright IBM Corp. 2021
+ *
+ * s390-tools is free software; you can redistribute it and/or modify
+ * it under the terms of the MIT license. See LICENSE for details.
+ */
+#ifndef SK_OPENSSL_H
+#define SK_OPENSSL_H
+
+#include <stddef.h>
+#include <stdbool.h>
+
+#include <openssl/evp.h>
+#include <openssl/opensslv.h>
+#include <openssl/x509.h>
+#include <openssl/x509v3.h>
+
+#ifndef OPENSSL_VERSION_PREREQ
+	#if defined(OPENSSL_VERSION_MAJOR) && defined(OPENSSL_VERSION_MINOR)
+		#define OPENSSL_VERSION_PREREQ(maj, min)		\
+			((OPENSSL_VERSION_MAJOR << 16) +		\
+			OPENSSL_VERSION_MINOR >= ((maj) << 16) + (min))
+	#else
+		#define OPENSSL_VERSION_PREREQ(maj, min)		\
+			(OPENSSL_VERSION_NUMBER >= (((maj) << 28) |	\
+			((min) << 20)))
+	#endif
+#endif
+
+/**
+ * External crypto library definitions
+ */
+
+struct sk_ext_cca_lib {
+	void *cca_lib; /* Handle of CCA host library loaded via dlopen */
+};
+
+typedef uint64_t target_t;
+
+struct sk_ext_ep11_lib {
+	void *ep11_lib; /* Handle of EP11 host library loaded via dlopen */
+	target_t target; /* single or group target handle */
+};
+
+enum sk_ext_lib_type {
+	SK_EXT_LIB_CCA = 1,
+	SK_EXT_LIB_EP11 = 2,
+};
+
+struct sk_ext_lib {
+	enum sk_ext_lib_type type;
+	union {
+		struct sk_ext_cca_lib *cca; /* Used if type = EXT_LIB_CCA */
+		struct sk_ext_ep11_lib *ep11; /* Used if type = EXT_LIB_EP11 */
+	};
+};
+
+/*
+ * Secure key library initialization and termination functions
+ */
+
+int SK_OPENSSL_init(bool debug);
+void SK_OPENSSL_term(void);
+
+/*
+ * Secure key generation and reenciphering definitions and functions
+ */
+
+enum sk_key_type {
+	SK_KEY_TYPE_EC = 1,
+	SK_KEY_TYPE_RSA = 2,
+};
+
+struct sk_key_gen_info {
+	enum sk_key_type type;
+	union {
+		struct {
+			int curve_nid;
+		} ec;
+		struct {
+			size_t modulus_bits;
+			unsigned int pub_exp;
+			bool x9_31;
+		} rsa;
+	};
+};
+
+int SK_OPENSSL_generate_secure_key(unsigned char *secure_key,
+				   size_t *secure_key_size,
+				   const struct sk_key_gen_info *info,
+				   const struct sk_ext_lib *ext_lib,
+				   bool debug);
+
+int SK_OPENSSL_reencipher_secure_key(unsigned char *secure_key,
+				     size_t secure_key_size, bool to_new,
+				     const struct sk_ext_lib *ext_lib,
+				     bool debug);
+
+/*
+ * Get an OpenSSL PKEY from a secure key to be used with OpenSSL.
+ */
+int SK_OPENSSL_get_secure_key_as_pkey(const unsigned char *secure_key,
+				      size_t secure_key_size, bool rsa_pss,
+				      EVP_PKEY **pkey,
+				      const struct sk_ext_lib *ext_lib,
+				      bool debug);
+
+/*
+ * Get the public key parts from a secure key.
+ */
+struct sk_pub_key_info {
+	enum sk_key_type type;
+	union {
+		struct {
+			int curve_nid;
+			size_t prime_len;
+			const unsigned char *x;
+			const unsigned char *y;
+		} ec;
+		struct {
+			size_t modulus_len;
+			const unsigned char *modulus;
+			size_t pub_exp_len;
+			const unsigned char *pub_exp;
+		} rsa;
+	};
+};
+
+typedef int (*sk_pub_key_func_t)(const struct sk_pub_key_info *pub_key,
+				 void *private);
+
+int SK_OPENSSL_get_public_from_secure_key(const unsigned char *secure_key,
+					  size_t secure_key_size,
+					  sk_pub_key_func_t pub_key_cb,
+					  void *private,
+					  const struct sk_ext_lib *ext_lib,
+					  bool debug);
+
+/*
+ * Helper functions to setup a secure key sign context and to generate
+ * certificate signing requests or self signed certificates with the secure key
+ */
+
+struct sk_rsa_pss_params {
+	/*
+	 * salt length in bytes, or OpenSSL constants
+	 * RSA_PSS_SALTLEN_DIGEST (-1),	RSA_PSS_SALTLEN_AUTO (-2), or
+	 * RSA_PSS_SALTLEN_MAX(-3)
+	 */
+	int salt_len;
+	/*
+	 * OpenSSl digest nid, or NID_undef to use the same digest algorithm
+	 * as the signature algorithm
+	 */
+	int mgf_digest_nid;
+};
+
+int SK_OPENSSL_setup_sign_context(EVP_PKEY *pkey, bool verify, int digest_nid,
+				  struct sk_rsa_pss_params *rsa_pss_params,
+				  EVP_MD_CTX **md_ctx, EVP_PKEY_CTX **pkey_ctx,
+				  bool debug);
+
+int SK_OPENSSL_generate_csr(const unsigned char *secure_key,
+			    size_t secure_key_size,
+			    const char *subject_rdns[], size_t num_subject_rdns,
+			    bool subject_utf8, const X509 *renew_cert,
+			    const char *extensions[], size_t num_extensions,
+			    int digest_nid,
+			    struct sk_rsa_pss_params *rsa_pss_params,
+			    X509_REQ **csr,
+			    const struct sk_ext_lib *ext_lib, bool debug);
+
+int SK_OPENSSL_generate_ss_cert(const unsigned char *secure_key,
+				size_t secure_key_size,
+				const char *subject_rdns[],
+				size_t num_subject_rdns, bool subject_utf8,
+				const X509 *renew_cert,
+				const char *extensions[], size_t num_extensions,
+				int validity_days, int digest_nid,
+				struct sk_rsa_pss_params *rsa_pss_params,
+				X509 **ss_cert,
+				const struct sk_ext_lib *ext_lib, bool debug);
+
+/*
+ * Import secure keys as PKEY, or import clear public keys as PKEY
+ */
+
+typedef int (*sk_rsa_sign_t)(const unsigned char *key_blob,
+			     size_t key_blob_length,
+			     unsigned char *sig, size_t *siglen,
+			     const unsigned char *tbs, size_t tbslen,
+			     int padding_type, int md_nid,
+			     void *private, bool debug);
+typedef int (*sk_rsa_pss_sign_t)(const unsigned char *key_blob,
+				 size_t key_blob_length, unsigned char *sig,
+				 size_t *siglen, const unsigned char *tbs,
+				 size_t tbslen, int md_nid, int mfgmd_nid,
+				 int saltlen, void *private, bool debug);
+typedef int (*sk_ecdsa_sign_t)(const unsigned char *key_blob,
+			       size_t key_blob_length, unsigned char *sig,
+			       size_t *siglen, const unsigned char *tbs,
+			       size_t tbslen, int md_nid, void *private,
+			       bool debug);
+typedef int (*sk_rsa_decrypt_t)(const unsigned char *key_blob,
+				size_t key_blob_length,
+				unsigned char *to, size_t *tolen,
+				const unsigned char *from, size_t fromlen,
+				int padding_type, void *private, bool debug);
+typedef int (*sk_rsa_decrypt_oaep_t)(const unsigned char *key_blob,
+				     size_t key_blob_length,
+				     unsigned char *to, size_t *tolen,
+				     const unsigned char *from, size_t fromlen,
+				     int oaep_md_nid, int mgfmd_nid,
+				     unsigned char *label, int label_len,
+				     void *private, bool debug);
+
+struct sk_funcs {
+	sk_rsa_sign_t		rsa_sign;
+	sk_rsa_pss_sign_t	rsa_pss_sign;
+	sk_ecdsa_sign_t		ecdsa_sign;
+	sk_rsa_decrypt_t	rsa_decrypt;
+	sk_rsa_decrypt_oaep_t	rsa_decrypt_oaep;
+};
+
+int SK_OPENSSL_get_pkey(const unsigned char *secure_key, size_t secure_key_size,
+			const struct sk_pub_key_info *pub_key, bool rsa_pss,
+			const struct sk_funcs *sk_funcs, const void *private,
+			EVP_PKEY **pkey, bool debug);
+
+int SK_OPENSSL_get_curve_from_ec_pkey(EVP_PKEY *pkey);
+
+#endif

include/libseckey/sk_utilities.h

@@ -0,0 +1,89 @@
+/*
+ * libseckey - Secure key library
+ *
+ * Copyright IBM Corp. 2021
+ *
+ * s390-tools is free software; you can redistribute it and/or modify
+ * it under the terms of the MIT license. See LICENSE for details.
+ */
+#ifndef SK_UTILITIES_H
+#define SK_UTILITIES_H
+
+#include <stddef.h>
+#include <stdbool.h>
+
+#include <openssl/x509.h>
+#include <openssl/obj_mac.h>
+#include <openssl/evp.h>
+
+#include "libseckey/sk_openssl.h"
+
+void SK_UTIL_warnx(const char *func, const char *fmt, ...);
+
+#define sk_debug(debug, fmt...)						\
+		do {							\
+			if (debug)					\
+				SK_UTIL_warnx(__func__, fmt);		\
+		} while (0)
+
+/* EC curve information definitions and functions */
+struct sk_ec_curve_info {
+	int curve_nid;
+	enum {
+		SK_EC_TYPE_PRIME = 0,
+		SK_EC_TYPE_BRAINPOOL = 1,
+	} type;
+	size_t prime_bits;
+	size_t prime_len;
+	const unsigned char *der; /* DER encoded OID */
+	size_t der_size;
+};
+
+const struct sk_ec_curve_info *SK_UTIL_ec_get_curve_info(int curve_nid);
+int SK_UTIL_ec_get_prime_curve_by_prime_bits(size_t prime_bits);
+int SK_UTIL_ec_get_brainpool_curve_by_prime_bits(size_t prime_bits);
+
+int SK_UTIL_ec_calculate_y_coordinate(int nid, size_t prime_len,
+				      const unsigned char *x, int y_bit,
+				      unsigned char *y);
+
+/* Digest information definitions and functions */
+struct sk_digest_info {
+	int digest_nid;
+	size_t digest_size;
+	const char *cca_keyword;
+	const unsigned char *der; /* DER encoded SEQ of OID and OCT-STRING */
+	size_t der_size;
+	unsigned long pkcs11_mech;
+	unsigned long pkcs11_mgf;
+	unsigned char x9_31_md; /* X9.31 digest identifier */
+};
+
+const struct sk_digest_info *SK_UTIL_get_digest_info(int digest_nid);
+
+/* Helper functions for certificate and CSR handling */
+int SK_UTIL_build_subject_name(X509_NAME **name, const char *rdns[],
+				size_t num_rdns, bool utf8);
+int SK_UTIL_build_certificate_extensions(X509 *cert, X509_REQ *req,
+					 const char *exts[], size_t num_exts,
+					 const STACK_OF(X509_EXTENSION)
+								*addl_exts);
+int SK_UTIL_generate_x509_serial_number(X509 *cert, size_t sn_bit_size);
+
+int SK_UTIL_build_ecdsa_signature(const unsigned char *raw_sig,
+				  size_t raw_sig_len,
+				  unsigned char *sig, size_t *sig_len);
+
+/* Functions to read and write keys, certificates, requests, etc. */
+int SK_UTIL_read_x509_certificate(const char *pem_filename, X509 **cert);
+int SK_UTIL_write_x509_certificate(const char *pem_filename, X509 *cert);
+int SK_UTIL_write_x509_request(const char *pem_filename, X509_REQ *req,
+			       bool new_hdr);
+int SK_UTIL_read_key_blob(const char *filename, unsigned char *key_blob,
+			  size_t *key_blob_len);
+int SK_UTIL_write_key_blob(const char *filename, unsigned char *key_blob,
+			   size_t key_blob_len);
+int SK_UTIL_read_public_key(const char *pem_filename, EVP_PKEY **pkey);
+int SK_UTIL_write_public_key(const char *pem_filename, EVP_PKEY *pkey);
+
+#endif