Bump version and soname for 5.6.1.

The original files were generated with random local to my machine.
To better reproduce these files in the future, a constant seed was used
to recreate these files.

.gitignore

@@ -67,6 +67,7 @@ coverage
 /tests/test_index
 /tests/test_index_hash
 /tests/test_lzip_decoder
+/tests/test_microlzma
 /tests/test_memlimit
 /tests/test_stream_flags
 /tests/test_vli

CMakeLists.txt

@@ -273,14 +273,48 @@ endif()
 # Translation support requires CMake 3.20 because it added the Intl::Intl
 # target so we don't need to play with the individual variables.
 #
-# The defintion ENABLE_NLS is added only to those targets that use it, thus
+# The definition ENABLE_NLS is added only to those targets that use it, thus
 # it's not done here. (xz has translations, xzdec doesn't.)
 if(CMAKE_VERSION VERSION_GREATER_EQUAL "3.20")
     find_package(Intl)
     find_package(Gettext)
+
     if(Intl_FOUND)
         option(ENABLE_NLS "Native Language Support (translated messages)" ON)
 
+        # If translation support is enabled but neither gettext tools or
+        # pre-generated .gmo files exist, translation support cannot be
+        # enabled.
+        #
+        # The detection of pre-generated .gmo files is done by only
+        # checking for the existence of a single .gmo file; Ukrainian
+        # is one of many translations that gets regular updates.
+        if(ENABLE_NLS AND NOT GETTEXT_FOUND AND
+                NOT EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/po/uk.gmo")
+            # This only sets the variable, not the cache variable!
+            set(ENABLE_NLS OFF)
+
+            # This message is shown only when new enough CMake is used and
+            # library support for translations was found. The assumptions is
+            # that in this situation the user might have interest in the
+            # translations. This also keeps this code simpler.
+            message(WARNING "Native language support (NLS) has been disabled. "
+                            "NLS support requires either gettext tools or "
+                            "pre-generated .gmo files. The latter are only "
+                            "available in distribution tarballs. "
+                            "To avoid this warning, NLS can be explicitly "
+                            "disabled by passing -DENABLE_NLS=OFF to cmake.")
+        endif()
+
+        # Warn if NLS is enabled but translated man pages are missing.
+        if(UNIX AND ENABLE_NLS AND
+                NOT EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/po4a/man")
+            message(WARNING "Native language support (NLS) has been enabled "
+                            "but pre-generated translated man pages "
+                            "were not found and thus they won't be installed. "
+                            "Run 'po4a/update-po' to generate them.")
+        endif()
+
         # The *installed* name of the translation files is "xz.mo".
         set(TRANSLATION_DOMAIN "xz")
     endif()
@@ -819,10 +853,6 @@ if(MICROLZMA_DECODER)
     target_sources(liblzma PRIVATE src/liblzma/common/microlzma_decoder.c)
 endif()
 
-if (MICROLZMA_ENCODER OR MICROLZMA_DECODER)
-    add_compile_definitions(HAVE_MICROLZMA)
-endif()
-
 
 #############################
 # lzip (.lz) format support #
@@ -901,10 +931,29 @@ endif()
 
 # Sandboxing: Landlock
 if(NOT SANDBOX_FOUND AND ENABLE_SANDBOX MATCHES "^ON$|^landlock$")
-    check_include_file(linux/landlock.h HAVE_LINUX_LANDLOCK_H)
+    # A compile check is done here because some systems have
+    # linux/landlock.h, but do not have the syscalls defined
+    # in order to actually use Linux Landlock.
+    check_c_source_compiles("
+        #include <linux/landlock.h>
+        #include <sys/syscall.h>
+        #include <sys/prctl.h>
+.
+        void my_sandbox(void)
+        {
+            (void)prctl(PR_SET_NO_NEW_PRIVS, 1, 0, 0, 0);
+            (void)SYS_landlock_create_ruleset;
+            (void)SYS_landlock_restrict_self;
+            (void)LANDLOCK_CREATE_RULESET_VERSION;
+            return;
+        }
 
-    if(HAVE_LINUX_LANDLOCK_H)
+        int main(void) { return 0; }
-        set(SANDBOX_COMPILE_DEFINITION "HAVE_LINUX_LANDLOCK_H")
+        "
+    HAVE_LINUX_LANDLOCK)
+
+    if(HAVE_LINUX_LANDLOCK)
+        set(SANDBOX_COMPILE_DEFINITION "HAVE_LINUX_LANDLOCK")
         set(SANDBOX_FOUND ON)
 
         # Of our three sandbox methods, only Landlock is incompatible
@@ -1029,6 +1078,13 @@ if(USE_ATTR_IFUNC STREQUAL "auto")
             #endif
 
             static void func(void) { return; }
+
+            /*
+            * The attribute __no_profile_instrument_function__ is
+            * needed with GCC to prevent improper instrumentation in
+            * the ifunc resolver.
+            */
+            __attribute__((__no_profile_instrument_function__))
             static void (*resolve_func(void)) (void) { return func; }
             void func_ifunc(void)
                     __attribute__((__ifunc__(\"resolve_func\")));
@@ -1988,6 +2044,16 @@ if(BUILD_TESTING)
         test_vli
     )
 
+    # MicroLZMA encoder is needed for both encoder and decoder tests.
+    # If MicroLZMA decoder is not configured but LZMA1 decoder is, then
+    # test_microlzma will fail to compile because this configuration is
+    # not possible in the Autotools build, so the test was not made to
+    # support it since it would have required additional changes.
+    if (MICROLZMA_ENCODER AND (MICROLZMA_DECODER
+            OR NOT "lzma1" IN_LIST DECODERS))
+        list(APPEND LIBLZMA_TESTS test_microlzma)
+    endif()
+
     foreach(TEST IN LISTS LIBLZMA_TESTS)
         add_executable("${TEST}" "tests/${TEST}.c")
 

NEWS

@@ -2,6 +2,32 @@
 XZ Utils Release Notes
 ======================
 
+5.6.1 (2024-03-09)
+
+    * liblzma: Fixed two bugs relating to GNU indirect function (IFUNC)
+      with GCC. The more serious bug caused a program linked with
+      liblzma to crash on start up if the flag -fprofile-generate was
+      used to build liblzma. The second bug caused liblzma to falsely
+      report an invalid write to Valgrind when loading liblzma.
+
+    * xz: Changed the messages for thread reduction due to memory
+      constraints to only appear under the highest verbosity level.
+
+    * Build:
+
+        - Fixed a build issue when the header file <linux/landlock.h>
+          was present on the system but the Landlock system calls were
+          not defined in <sys/syscall.h>.
+
+        - The CMake build now warns and disables NLS if both gettext
+          tools and pre-created .gmo files are missing. Previously,
+          this caused the CMake build to fail.
+
+    * Minor improvements to man pages.
+
+    * Minor improvements to tests.
+
+
 5.6.0 (2024-02-24)
 
     This bumps the minor version of liblzma because new features were
@@ -23,7 +49,7 @@ XZ Utils Release Notes
     * Sandboxing support in xz:
 
         - Landlock is now used even when xz needs to create files.
-          In this case the sandbox is has to be more permissive than
+          In this case the sandbox has to be more permissive than
           when no files need to be created. A similar thing was
           already in use with pledge(2) since 5.3.4alpha.
 

THANKS

@@ -152,9 +152,9 @@ has been important. :-) In alphabetical order:
   - Dan Stromberg
   - Jia Tan
   - Vincent Torri
+  - Alexey Tourbin
   - Paul Townsend
   - Mohammed Adnène Trojette
-  - Alexey Tourbin
   - Taiki Tsunekawa
   - Maksym Vatsyk
   - Loganaden Velvindron
@@ -171,6 +171,7 @@ has been important. :-) In alphabetical order:
   - Charles Wilson
   - Lars Wirzenius
   - Pilorz Wojciech
+  - Chien Wong
   - Ryan Young
   - Andreas Zieringer
 

configure.ac

@@ -304,13 +304,8 @@ AC_ARG_ENABLE([microlzma], AS_HELP_STRING([--disable-microlzma],
 		for example, erofs-utils.]),
 	[], [enable_microlzma=yes])
 case $enable_microlzma in
-	yes)
+	yes | no)
-		AC_DEFINE([HAVE_MICROLZMA], [1],
+		AC_MSG_RESULT([$enable_microlzma])
-			[Define to 1 if MicroLZMA support is enabled.])
-		AC_MSG_RESULT([yes])
-		;;
-	no)
-		AC_MSG_RESULT([no])
 		;;
 	*)
 		AC_MSG_RESULT([])
@@ -915,6 +910,13 @@ if test "x$enable_ifunc" = xauto ; then
 		#endif
 
 		static void func(void) { return; }
+
+		/*
+		 * The attribute __no_profile_instrument_function__ is
+		 * needed with GCC to prevent improper instrumentation in
+		 * the ifunc resolver.
+		 */
+		__attribute__((__no_profile_instrument_function__))
 		static void (*resolve_func (void)) (void) { return func; }
 		void func_ifunc (void)
 				__attribute__((__ifunc__("resolve_func")));
@@ -1177,12 +1179,37 @@ AS_CASE([$enable_sandbox],
 )
 AS_CASE([$enable_sandbox],
 	[auto | landlock], [
-		AC_CHECK_HEADERS([linux/landlock.h], [
+		AC_MSG_CHECKING([if Linux Landlock is usable])
+
+		# A compile check is done here because some systems have
+		# linux/landlock.h, but do not have the syscalls defined
+		# in order to actually use Linux Landlock.
+		AC_COMPILE_IFELSE([AC_LANG_SOURCE([[
+			#include <linux/landlock.h>
+			#include <sys/syscall.h>
+			#include <sys/prctl.h>
+
+			void my_sandbox(void)
+			{
+				(void)prctl(PR_SET_NO_NEW_PRIVS, 1, 0, 0, 0);
+				(void)SYS_landlock_create_ruleset;
+				(void)SYS_landlock_restrict_self;
+				(void)LANDLOCK_CREATE_RULESET_VERSION;
+				return;
+			}
+		]])], [
 			enable_sandbox=found
 
 			AS_CASE([$CFLAGS], [*-fsanitize=*], [AC_MSG_ERROR([
     CFLAGS contains '-fsanitize=' which is incompatible with the Landlock
     sandboxing. Use --disable-sandbox when using '-fsanitize'.])])
+
+			AC_DEFINE([HAVE_LINUX_LANDLOCK], [1],
+				[Define to 1 if Linux Landlock is supported.
+				See configure.ac for details.])
+			AC_MSG_RESULT([yes])
+		], [
+			AC_MSG_RESULT([no])
 		])
 	]
 )

src/liblzma/Makefile.am

@@ -20,7 +20,7 @@ liblzma_la_CPPFLAGS = \
 	-I$(top_srcdir)/src/liblzma/simple \
 	-I$(top_srcdir)/src/common \
 	-DTUKLIB_SYMBOL_PREFIX=lzma_
-liblzma_la_LDFLAGS = -no-undefined -version-info 10:99:5
+liblzma_la_LDFLAGS = -no-undefined -version-info 11:1:6
 
 EXTRA_DIST += liblzma_generic.map liblzma_linux.map validate_map.sh
 if COND_SYMVERS_GENERIC

src/liblzma/api/lzma/version.h

@@ -19,10 +19,10 @@
 #define LZMA_VERSION_MAJOR 5
 
 /** \brief Minor version number of the liblzma release. */
-#define LZMA_VERSION_MINOR 5
+#define LZMA_VERSION_MINOR 6
 
 /** \brief Patch version number of the liblzma release. */
-#define LZMA_VERSION_PATCH 2
+#define LZMA_VERSION_PATCH 1
 
 /**
  * \brief Version stability marker
@@ -32,7 +32,7 @@
  *   - LZMA_VERSION_STABILITY_BETA
  *   - LZMA_VERSION_STABILITY_STABLE
  */
-#define LZMA_VERSION_STABILITY LZMA_VERSION_STABILITY_BETA
+#define LZMA_VERSION_STABILITY LZMA_VERSION_STABILITY_STABLE
 
 /** \brief Commit version number of the liblzma release */
 #ifndef LZMA_VERSION_COMMIT

src/liblzma/check/crc32_fast.c

@@ -135,6 +135,8 @@ typedef uint32_t (*crc32_func_type)(
 // This resolver is shared between all three dispatch methods. It serves as
 // the ifunc resolver if ifunc is supported, otherwise it is called as a
 // regular function by the constructor or first call resolution methods.
+// The function attributes are needed for safe IFUNC resolver usage with GCC.
+lzma_resolver_attributes
 static crc32_func_type
 crc32_resolve(void)
 {

src/liblzma/check/crc64_fast.c

@@ -98,6 +98,7 @@ typedef uint64_t (*crc64_func_type)(
 #	pragma GCC diagnostic ignored "-Wunused-function"
 #endif
 
+lzma_resolver_attributes
 static crc64_func_type
 crc64_resolve(void)
 {

src/liblzma/check/crc_common.h

@@ -128,6 +128,31 @@
 #	endif
 #endif
 
+#ifdef CRC_USE_IFUNC
+// Two function attributes are needed to make IFUNC safe with GCC.
+//
+// no-omit-frame-pointer prevents false Valgrind issues when combined with
+// a few other compiler flags. The optimize attribute is supported on
+// GCC >= 4.4 and is not supported with Clang.
+#	if TUKLIB_GNUC_REQ(4,4) && !defined(__clang__)
+#		define no_omit_frame_pointer \
+			__attribute__((optimize("no-omit-frame-pointer")))
+#	else
+#		define no_omit_frame_pointer
+#	endif
+
+// The __no_profile_instrument_function__ attribute support is checked when
+// determining if ifunc can be used, so it is safe to use unconditionally.
+// This attribute is needed because GCC can add profiling to the IFUNC
+// resolver, which calls functions that have not yet been relocated leading
+// to a crash on liblzma start up.
+#	define lzma_resolver_attributes \
+		__attribute__((__no_profile_instrument_function__)) \
+		no_omit_frame_pointer
+#else
+#	define lzma_resolver_attributes
+#endif
+
 // For CRC32 use the generic slice-by-eight implementation if no optimized
 // version is available.
 #if !defined(CRC32_ARCH_OPTIMIZED) && !defined(CRC32_GENERIC)

src/liblzma/liblzma_generic.map

@@ -122,7 +122,7 @@ global:
 	lzma_str_to_filters;
 } XZ_5.2;
 
-XZ_5.5.2beta {
+XZ_5.6.0 {
 global:
 	lzma_mt_block_size;
 } XZ_5.4;

src/liblzma/liblzma_linux.map

@@ -137,7 +137,7 @@ global:
 	lzma_str_to_filters;
 } XZ_5.2;
 
-XZ_5.5.2beta {
+XZ_5.6.0 {
 global:
 	lzma_mt_block_size;
 } XZ_5.4;

src/liblzma/simple/riscv.c

@@ -116,7 +116,7 @@ AUIPC with rd != x0
         Zfh, F, D, and Q:
           * RV32I: LB, LH, LW, LBU, LHU, SB, SH, SW
           * RV64I has also: LD, LWU, SD
-          * Zhf: FLH, FSH
+          * Zfh: FLH, FSH
           * F: FLW, FSW
           * D: FLD, FSD
           * Q: FLQ, FSQ
@@ -320,11 +320,11 @@ AUIPC with rd == x0
 // The left-hand side takes care of (1) and (2).
 //   (a) The lowest 7 bits are already known to be AUIPC so subtracting 0x17
 //       makes those bits zeros.
-//   (b) If AUIPC rd equals x2, subtracting 0x10 makes bits [11:7] zeros.
+//   (b) If AUIPC rd equals x2, subtracting 0x100 makes bits [11:7] zeros.
 //       If rd doesn't equal x2, then there will be at least one non-zero bit
 //       and the next step (c) is irrelevant.
 //   (c) If the lowest two opcode bits of the packed inst2 are set in [13:12],
-//       then subtracting 0x300 will make those bits zeros. Otherwise there
+//       then subtracting 0x3000 will make those bits zeros. Otherwise there
 //       will be at least one non-zero bit.
 //
 // The shift by 18 removes the high bits from the final '>=' comparison and

src/xz/coder.c

@@ -581,7 +581,14 @@ coder_set_compression_settings(void)
 
 			if (memory_usage <= memory_limit) {
 				// The memory usage is now low enough.
-				message(V_WARNING, _("Reduced the number of "
+				//
+				// Since 5.6.1: This is only shown at
+				// V_DEBUG instead of V_WARNING because
+				// changing the number of threads doesn't
+				// affect the output. On some systems this
+				// message would be too common now that
+				// multithreaded compression is the default.
+				message(V_DEBUG, _("Reduced the number of "
 					"threads from %s to %s to not exceed "
 					"the memory usage limit of %s MiB"),
 					uint64_to_str(
@@ -600,8 +607,11 @@ coder_set_compression_settings(void)
 		// way -T0 won't use insane amount of memory but at the same
 		// time the soft limit will never make xz fail and never make
 		// xz change settings that would affect the compressed output.
+		//
+		// Since 5.6.1: Like above, this is now shown at V_DEBUG
+		// instead of V_WARNING.
 		if (hardware_memlimit_mtenc_is_default()) {
-			message(V_WARNING, _("Reduced the number of threads "
+			message(V_DEBUG, _("Reduced the number of threads "
 				"from %s to one. The automatic memory usage "
 				"limit of %s MiB is still being exceeded. "
 				"%s MiB of memory is required. "

src/xz/sandbox.c

@@ -109,7 +109,7 @@ sandbox_enable_strict_if_allowed(int src_fd lzma_attribute((__unused__)),
 }
 
 
-#elif defined(HAVE_LINUX_LANDLOCK_H)
+#elif defined(HAVE_LINUX_LANDLOCK)
 
 //////////////
 // Landlock //

src/xz/sandbox.h

@@ -9,7 +9,7 @@
 //
 ///////////////////////////////////////////////////////////////////////////////
 
-#if defined(HAVE_PLEDGE) || defined(HAVE_LINUX_LANDLOCK_H) \
+#if defined(HAVE_PLEDGE) || defined(HAVE_LINUX_LANDLOCK) \
 		|| defined(HAVE_CAP_RIGHTS_LIMIT)
 #	define ENABLE_SANDBOX 1
 #endif

src/xz/xz.1

@@ -4,7 +4,7 @@
 .\" Authors: Lasse Collin
 .\"          Jia Tan
 .\"
-.TH XZ 1 "2024-02-13" "Tukaani" "XZ Utils"
+.TH XZ 1 "2024-02-25" "Tukaani" "XZ Utils"
 .
 .SH NAME
 xz, unxz, xzcat, lzma, unlzma, lzcat \- Compress or decompress .xz and .lzma files
@@ -1812,6 +1812,8 @@ and
 \fB\-\-ia64\fR[\fB=\fIoptions\fR]
 .TP
 \fB\-\-sparc\fR[\fB=\fIoptions\fR]
+.TP
+\fB\-\-riscv\fR[\fB=\fIoptions\fR]
 .PD
 Add a branch/call/jump (BCJ) filter to the filter chain.
 These filters can be used only as a non-last filter

src/xzdec/xzdec.c

@@ -24,14 +24,14 @@
 #	include <sys/capsicum.h>
 #endif
 
-#ifdef HAVE_LINUX_LANDLOCK_H
+#ifdef HAVE_LINUX_LANDLOCK
 #	include <linux/landlock.h>
 #	include <sys/prctl.h>
 #	include <sys/syscall.h>
 #endif
 
 #if defined(HAVE_CAP_RIGHTS_LIMIT) || defined(HAVE_PLEDGE) \
-		|| defined(HAVE_LINUX_LANDLOCK_H)
+		|| defined(HAVE_LINUX_LANDLOCK)
 #	define ENABLE_SANDBOX 1
 #endif
 
@@ -325,7 +325,7 @@ sandbox_enter(int src_fd)
 		goto error;
 
 	(void)src_fd;
-#elif defined(HAVE_LINUX_LANDLOCK_H)
+#elif defined(HAVE_LINUX_LANDLOCK)
 	int landlock_abi = syscall(SYS_landlock_create_ruleset,
 			(void *)NULL, 0, LANDLOCK_CREATE_RULESET_VERSION);
 
@@ -389,7 +389,7 @@ main(int argc, char **argv)
 	}
 #endif
 
-#ifdef HAVE_LINUX_LANDLOCK_H
+#ifdef HAVE_LINUX_LANDLOCK
 	// Prevent the process from gaining new privileges. The return
 	// is ignored to keep compatibility with old kernels.
 	(void)prctl(PR_SET_NO_NEW_PRIVS, 1, 0, 0, 0);

tests/Makefile.am

@@ -42,8 +42,7 @@ check_PROGRAMS = \
 	test_bcj_exact_size \
 	test_memlimit \
 	test_lzip_decoder \
-	test_vli \
+	test_vli
-	test_microlzma
 
 TESTS = \
 	test_check \
@@ -58,7 +57,6 @@ TESTS = \
 	test_memlimit \
 	test_lzip_decoder \
 	test_vli \
-	test_microlzma \
 	test_files.sh \
 	test_suffix.sh \
 	test_compress_prepared_bcj_sparc \
@@ -67,6 +65,11 @@ TESTS = \
 	test_compress_generated_random \
 	test_compress_generated_text
 
+if COND_MICROLZMA
+check_PROGRAMS += test_microlzma
+TESTS += test_microlzma
+endif
+
 if COND_SCRIPTS
 TESTS += test_scripts.sh
 endif

tests/test_files.sh

@@ -149,6 +149,17 @@ else
 	exit 1
 fi
 
+# Test that --single-stream can decompress bad-3-corrupt_lzma2.xz.
+# The first Stream in this file should decompress without errors.
+# This file cannot be decompressed with xzdec.
+I="$srcdir/files/bad-3-corrupt_lzma2.xz"
+if test -z "$XZ" || "$XZ" -dc --single-stream $NO_WARN "$I" > /dev/null; then
+	:
+else
+	echo "Good first Stream failed xz with --single-stream: $I"
+	exit 1
+fi
+
 
 #########
 # .lzma #

tests/test_microlzma.c

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: 0BSD
+
 ///////////////////////////////////////////////////////////////////////////////
 //
 /// \file       test_microlzma.c
@@ -5,15 +7,10 @@
 //
 //  Author:     Jia Tan
 //
-//  This file has been put into the public domain.
-//  You can do whatever you want with this file.
-//
 ///////////////////////////////////////////////////////////////////////////////
 
 #include "tests.h"
 
-#ifdef HAVE_MICROLZMA
-
 #define BUFFER_SIZE 1024
 
 #ifdef HAVE_ENCODER_LZMA1
@@ -514,7 +511,6 @@ test_decode_bad_lzma_properties(void)
 	lzma_end(&strm);
 }
 #endif
-#endif
 
 
 extern int
@@ -522,17 +518,16 @@ main(int argc, char **argv)
 {
 	tuktest_start(argc, argv);
 
-#ifndef HAVE_MICROLZMA
+#ifndef HAVE_ENCODER_LZMA1
-	tuktest_early_skip("MicroLZMA disabled");
+	tuktest_early_skip("LZMA1 encoder disabled");
 #else
-#	ifdef HAVE_ENCODER_LZMA1
 	tuktest_run(test_encode_options);
 	tuktest_run(test_encode_basic);
 	tuktest_run(test_encode_small_out);
 	tuktest_run(test_encode_actions);
-#	endif
 
-#	if defined(HAVE_DECODER_LZMA1) && defined(HAVE_ENCODER_LZMA1)
+	// MicroLZMA decoder tests require the basic encoder functionality.
+#	ifdef HAVE_DECODER_LZMA1
 	goodbye_world_encoded_size = basic_microlzma_encode(goodbye_world,
 			ARRAY_SIZE(goodbye_world), &goodbye_world_encoded);