Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
68979bc
Add missing ARM64 and RISCV filter in lzma module
ivq Feb 27, 2024
3fa0c17
Suppress doc warning "py:const reference target not found"
ivq Feb 28, 2024
c1e166a
Add lzma version
ivq Mar 17, 2024
ea51476
Add ARM64, RISC-V filter test case
ivq Mar 17, 2024
6189ceb
Update lzma doc
ivq Mar 17, 2024
0f6fd63
Add NEWS entry
ivq Mar 17, 2024
9731225
Optimise NEWS
ivq Mar 18, 2024
40e9d34
Move version doc section
ivq Mar 19, 2024
8c922f7
Add WHATSNEW entry
ivq Mar 19, 2024
9cd4cb8
Fix filter chain specs position
ivq Mar 19, 2024
8a85c48
Suppress doc warning
ivq Mar 22, 2024
32725a7
Elide upstream binary data from the test.
gpshead Mar 30, 2024
6d94a08
Clarify the documentation a bit.
gpshead Mar 30, 2024
c62ca63
Clarifying comment, docs accuracy.
gpshead Mar 30, 2024
045aa40
Expose the version as a number.
gpshead Mar 30, 2024
8f49f69
Merge branch 'main' into xz_bcj_filters
gpshead Mar 30, 2024
832335d
minor version explanation tweak.
gpshead Mar 30, 2024
728f286
Adjust the whats new text.
gpshead Mar 30, 2024
61c4adf
NEWS wording and formatting tweak.
gpshead Mar 30, 2024
98adeee
line length
gpshead Mar 30, 2024
449b722
Merge remote-tracking branch 'origin/main' into xz_bcj_filters
ivq Jul 13, 2025
f381ca5
We've missed the 3.13 window
ivq Jul 13, 2025
9f0d4d4
Fix accidentally removed newline when merging remote main
ivq Jul 13, 2025
1a17fd5
Remove unused import
ivq Jul 13, 2025
78e7d9a
Merge remote-tracking branch 'origin/main' into xz_bcj_filters
ivq May 27, 2026
9cc998f
Remove lzma version constants
ivq May 27, 2026
5ed9891
versionadded "next" in rst
gpshead May 27, 2026
b52d942
Put whatsnew entry alphabetically
ivq May 28, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 20 additions & 6 deletions Doc/library/lzma.rst
Original file line number Diff line number Diff line change
Expand Up @@ -356,12 +356,26 @@ options. Valid filter IDs are as follows:

* Branch-Call-Jump (BCJ) filters:

* :const:`FILTER_X86`
* :const:`FILTER_IA64`
* :const:`FILTER_ARM`
* :const:`FILTER_ARMTHUMB`
* :const:`FILTER_POWERPC`
* :const:`FILTER_SPARC`
* :const:`!FILTER_X86`
* :const:`!FILTER_IA64`
* :const:`!FILTER_ARM`
* :const:`!FILTER_ARMTHUMB`
* :const:`!FILTER_POWERPC`
* :const:`!FILTER_SPARC`

The above work on all lzma runtime library versions.

* :const:`!FILTER_ARM64`

Only works if the lzma version is 5.4.0 or later.

.. versionadded:: next

* :const:`!FILTER_RISCV`

Only works if the lzma version is 5.6.0 or later.

.. versionadded:: next

A filter chain can consist of up to 4 filters, and cannot be empty. The last
filter in the chain must be a compression filter, and any other filters must be
Expand Down
9 changes: 9 additions & 0 deletions Doc/whatsnew/3.16.rst
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,15 @@ gzip
which is passed on to the constructor of the :class:`~gzip.GzipFile` class.
(Contributed by Marin Misur in :gh:`91372`.)

lzma
----

* Add support of new BCJ filters ARM64 and RISC-V via
:const:`!lzma.FILTER_ARM64` and :const:`!lzma.FILTER_RISCV`. Note that the
new filters will work only if runtime library supports them. ARM64 filter
requires ``lzma`` 5.4.0 or newer while RISC-V requires 5.6.0 or newer.
(Contributed by Chien Wong in :gh:`115988`.)

os
--

Expand Down
1 change: 1 addition & 0 deletions Lib/lzma.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
"CHECK_ID_MAX", "CHECK_UNKNOWN",
"FILTER_LZMA1", "FILTER_LZMA2", "FILTER_DELTA", "FILTER_X86", "FILTER_IA64",
"FILTER_ARM", "FILTER_ARMTHUMB", "FILTER_POWERPC", "FILTER_SPARC",
"FILTER_ARM64", "FILTER_RISCV",
"FORMAT_AUTO", "FORMAT_XZ", "FORMAT_ALONE", "FORMAT_RAW",
"MF_HC3", "MF_HC4", "MF_BT2", "MF_BT3", "MF_BT4",
"MODE_FAST", "MODE_NORMAL", "PRESET_DEFAULT", "PRESET_EXTREME",
Expand Down
6 changes: 6 additions & 0 deletions Lib/test/test_lzma.py
Original file line number Diff line number Diff line change
Expand Up @@ -383,6 +383,12 @@ def test_uninitialized_LZMADecompressor_crash(self):
self.assertEqual(LZMADecompressor.__new__(LZMADecompressor).
decompress(bytes()), b'')

def test_riscv_filter_constant_exists(self):
self.assertTrue(lzma.FILTER_RISCV)

def test_arm64_filter_constant_exists(self):
self.assertTrue(lzma.FILTER_ARM64)


class CompressDecompressFunctionTestCase(unittest.TestCase):

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
:mod:`lzma` adds constants to support the newer BCJ filters for ARM64 and RISC-V.
21 changes: 20 additions & 1 deletion Modules/_lzmamodule.c
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,19 @@
#error "The maximum block size accepted by liblzma is SIZE_MAX."
#endif


/*
* If the lzma.h we're building against is so old as not to define these, this
* provides their equivalent values so that the names remain defined in Python
* regardless of the header versions used at build time.
*/
#ifndef LZMA_FILTER_ARM64
Comment thread
gpshead marked this conversation as resolved.
#define LZMA_FILTER_ARM64 LZMA_VLI_C(0x0A)
#endif
#ifndef LZMA_FILTER_RISCV
#define LZMA_FILTER_RISCV LZMA_VLI_C(0x0B)
#endif

/* On success, return value >= 0
On failure, return -1 */
static inline Py_ssize_t
Expand Down Expand Up @@ -373,6 +386,8 @@ lzma_filter_converter(_lzma_state *state, PyObject *spec, void *ptr)
case LZMA_FILTER_ARM:
case LZMA_FILTER_ARMTHUMB:
case LZMA_FILTER_SPARC:
case LZMA_FILTER_ARM64:
case LZMA_FILTER_RISCV:
Comment thread
gpshead marked this conversation as resolved.
f->options = parse_filter_spec_bcj(state, spec);
return f->options != NULL;
default:
Expand Down Expand Up @@ -491,7 +506,9 @@ build_filter_spec(const lzma_filter *f)
case LZMA_FILTER_IA64:
case LZMA_FILTER_ARM:
case LZMA_FILTER_ARMTHUMB:
case LZMA_FILTER_SPARC: {
case LZMA_FILTER_SPARC:
case LZMA_FILTER_ARM64:
case LZMA_FILTER_RISCV: {
lzma_options_bcj *options = f->options;
if (options) {
ADD_FIELD(options, start_offset);
Expand Down Expand Up @@ -1544,6 +1561,8 @@ lzma_exec(PyObject *module)
ADD_INT_PREFIX_MACRO(module, FILTER_ARMTHUMB);
ADD_INT_PREFIX_MACRO(module, FILTER_SPARC);
ADD_INT_PREFIX_MACRO(module, FILTER_POWERPC);
ADD_INT_PREFIX_MACRO(module, FILTER_ARM64);
ADD_INT_PREFIX_MACRO(module, FILTER_RISCV);
ADD_INT_PREFIX_MACRO(module, MF_HC3);
ADD_INT_PREFIX_MACRO(module, MF_HC4);
ADD_INT_PREFIX_MACRO(module, MF_BT2);
Expand Down
Loading