2 * Private includes and definitions
4 * Author: Lasse Collin <lasse.collin@tukaani.org>
6 * This file has been put into the public domain.
7 * You can do whatever you want with this file.
14 # include <linux/xz.h>
15 # include <linux/kernel.h>
16 # include <asm/unaligned.h>
17 /* XZ_PREBOOT may be defined only via decompress_unxz.c. */
19 # include <linux/slab.h>
20 # include <linux/vmalloc.h>
21 # include <linux/string.h>
22 # ifdef CONFIG_XZ_DEC_X86
25 # ifdef CONFIG_XZ_DEC_POWERPC
26 # define XZ_DEC_POWERPC
28 # ifdef CONFIG_XZ_DEC_IA64
31 # ifdef CONFIG_XZ_DEC_ARM
34 # ifdef CONFIG_XZ_DEC_ARMTHUMB
35 # define XZ_DEC_ARMTHUMB
37 # ifdef CONFIG_XZ_DEC_SPARC
40 # define memeq(a, b, size) (memcmp(a, b, size) == 0)
41 # define memzero(buf, size) memset(buf, 0, size)
43 # define get_le32(p) le32_to_cpup((const uint32_t *)(p))
46 * For userspace builds, use a separate header to define the required
47 * macros and functions. This makes it easier to adapt the code into
48 * different environments and avoids clutter in the Linux kernel tree.
50 # include "xz_config.h"
53 /* If no specific decoding mode is requested, enable support for all modes. */
54 #if !defined(XZ_DEC_SINGLE) && !defined(XZ_DEC_PREALLOC) \
55 && !defined(XZ_DEC_DYNALLOC)
56 # define XZ_DEC_SINGLE
57 # define XZ_DEC_PREALLOC
58 # define XZ_DEC_DYNALLOC
62 * The DEC_IS_foo(mode) macros are used in "if" statements. If only some
63 * of the supported modes are enabled, these macros will evaluate to true or
64 * false at compile time and thus allow the compiler to omit unneeded code.
67 # define DEC_IS_SINGLE(mode) ((mode) == XZ_SINGLE)
69 # define DEC_IS_SINGLE(mode) (false)
72 #ifdef XZ_DEC_PREALLOC
73 # define DEC_IS_PREALLOC(mode) ((mode) == XZ_PREALLOC)
75 # define DEC_IS_PREALLOC(mode) (false)
78 #ifdef XZ_DEC_DYNALLOC
79 # define DEC_IS_DYNALLOC(mode) ((mode) == XZ_DYNALLOC)
81 # define DEC_IS_DYNALLOC(mode) (false)
84 #if !defined(XZ_DEC_SINGLE)
85 # define DEC_IS_MULTI(mode) (true)
86 #elif defined(XZ_DEC_PREALLOC) || defined(XZ_DEC_DYNALLOC)
87 # define DEC_IS_MULTI(mode) ((mode) != XZ_SINGLE)
89 # define DEC_IS_MULTI(mode) (false)
93 * If any of the BCJ filter decoders are wanted, define XZ_DEC_BCJ.
94 * XZ_DEC_BCJ is used to enable generic support for BCJ decoders.
97 # if defined(XZ_DEC_X86) || defined(XZ_DEC_POWERPC) \
98 || defined(XZ_DEC_IA64) || defined(XZ_DEC_ARM) \
99 || defined(XZ_DEC_ARM) || defined(XZ_DEC_ARMTHUMB) \
100 || defined(XZ_DEC_SPARC)
105 #ifndef CRC32_POLY_LE
106 #define CRC32_POLY_LE 0xedb88320
110 * Allocate memory for LZMA2 decoder. xz_dec_lzma2_reset() must be used
111 * before calling xz_dec_lzma2_run().
113 XZ_EXTERN struct xz_dec_lzma2 *xz_dec_lzma2_create(enum xz_mode mode,
117 * Decode the LZMA2 properties (one byte) and reset the decoder. Return
118 * XZ_OK on success, XZ_MEMLIMIT_ERROR if the preallocated dictionary is not
119 * big enough, and XZ_OPTIONS_ERROR if props indicates something that this
120 * decoder doesn't support.
122 XZ_EXTERN enum xz_ret xz_dec_lzma2_reset(struct xz_dec_lzma2 *s,
125 /* Decode raw LZMA2 stream from b->in to b->out. */
126 XZ_EXTERN enum xz_ret xz_dec_lzma2_run(struct xz_dec_lzma2 *s,
129 /* Free the memory allocated for the LZMA2 decoder. */
130 XZ_EXTERN void xz_dec_lzma2_end(struct xz_dec_lzma2 *s);
134 * Allocate memory for BCJ decoders. xz_dec_bcj_reset() must be used before
135 * calling xz_dec_bcj_run().
137 XZ_EXTERN struct xz_dec_bcj *xz_dec_bcj_create(bool single_call);
140 * Decode the Filter ID of a BCJ filter. This implementation doesn't
141 * support custom start offsets, so no decoding of Filter Properties
142 * is needed. Returns XZ_OK if the given Filter ID is supported.
143 * Otherwise XZ_OPTIONS_ERROR is returned.
145 XZ_EXTERN enum xz_ret xz_dec_bcj_reset(struct xz_dec_bcj *s, uint8_t id);
148 * Decode raw BCJ + LZMA2 stream. This must be used only if there actually is
149 * a BCJ filter in the chain. If the chain has only LZMA2, xz_dec_lzma2_run()
150 * must be called directly.
152 XZ_EXTERN enum xz_ret xz_dec_bcj_run(struct xz_dec_bcj *s,
153 struct xz_dec_lzma2 *lzma2,
156 /* Free the memory allocated for the BCJ filters. */
157 #define xz_dec_bcj_end(s) kfree(s)