^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 1) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 2) * Private includes and definitions
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 3) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 4) * Author: Lasse Collin <lasse.collin@tukaani.org>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 5) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 6) * This file has been put into the public domain.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 7) * You can do whatever you want with this file.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 8) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 9)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 10) #ifndef XZ_PRIVATE_H
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 11) #define XZ_PRIVATE_H
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 12)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 13) #ifdef __KERNEL__
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 14) # include <linux/xz.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 15) # include <linux/kernel.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 16) # include <asm/unaligned.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 17) /* XZ_PREBOOT may be defined only via decompress_unxz.c. */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 18) # ifndef XZ_PREBOOT
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 19) # include <linux/slab.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 20) # include <linux/vmalloc.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 21) # include <linux/string.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 22) # ifdef CONFIG_XZ_DEC_X86
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 23) # define XZ_DEC_X86
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 24) # endif
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 25) # ifdef CONFIG_XZ_DEC_POWERPC
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 26) # define XZ_DEC_POWERPC
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 27) # endif
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 28) # ifdef CONFIG_XZ_DEC_IA64
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 29) # define XZ_DEC_IA64
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 30) # endif
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 31) # ifdef CONFIG_XZ_DEC_ARM
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 32) # define XZ_DEC_ARM
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 33) # endif
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 34) # ifdef CONFIG_XZ_DEC_ARMTHUMB
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 35) # define XZ_DEC_ARMTHUMB
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 36) # endif
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 37) # ifdef CONFIG_XZ_DEC_SPARC
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 38) # define XZ_DEC_SPARC
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 39) # endif
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 40) # define memeq(a, b, size) (memcmp(a, b, size) == 0)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 41) # define memzero(buf, size) memset(buf, 0, size)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 42) # endif
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 43) # define get_le32(p) le32_to_cpup((const uint32_t *)(p))
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 44) #else
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 45) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 46) * For userspace builds, use a separate header to define the required
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 47) * macros and functions. This makes it easier to adapt the code into
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 48) * different environments and avoids clutter in the Linux kernel tree.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 49) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 50) # include "xz_config.h"
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 51) #endif
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 52)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 53) /* If no specific decoding mode is requested, enable support for all modes. */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 54) #if !defined(XZ_DEC_SINGLE) && !defined(XZ_DEC_PREALLOC) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 55) && !defined(XZ_DEC_DYNALLOC)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 56) # define XZ_DEC_SINGLE
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 57) # define XZ_DEC_PREALLOC
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 58) # define XZ_DEC_DYNALLOC
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 59) #endif
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 60)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 61) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 62) * The DEC_IS_foo(mode) macros are used in "if" statements. If only some
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 63) * of the supported modes are enabled, these macros will evaluate to true or
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 64) * false at compile time and thus allow the compiler to omit unneeded code.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 65) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 66) #ifdef XZ_DEC_SINGLE
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 67) # define DEC_IS_SINGLE(mode) ((mode) == XZ_SINGLE)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 68) #else
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 69) # define DEC_IS_SINGLE(mode) (false)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 70) #endif
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 71)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 72) #ifdef XZ_DEC_PREALLOC
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 73) # define DEC_IS_PREALLOC(mode) ((mode) == XZ_PREALLOC)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 74) #else
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 75) # define DEC_IS_PREALLOC(mode) (false)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 76) #endif
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 77)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 78) #ifdef XZ_DEC_DYNALLOC
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 79) # define DEC_IS_DYNALLOC(mode) ((mode) == XZ_DYNALLOC)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 80) #else
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 81) # define DEC_IS_DYNALLOC(mode) (false)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 82) #endif
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 83)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 84) #if !defined(XZ_DEC_SINGLE)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 85) # define DEC_IS_MULTI(mode) (true)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 86) #elif defined(XZ_DEC_PREALLOC) || defined(XZ_DEC_DYNALLOC)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 87) # define DEC_IS_MULTI(mode) ((mode) != XZ_SINGLE)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 88) #else
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 89) # define DEC_IS_MULTI(mode) (false)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 90) #endif
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 91)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 92) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 93) * If any of the BCJ filter decoders are wanted, define XZ_DEC_BCJ.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 94) * XZ_DEC_BCJ is used to enable generic support for BCJ decoders.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 95) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 96) #ifndef XZ_DEC_BCJ
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 97) # if defined(XZ_DEC_X86) || defined(XZ_DEC_POWERPC) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 98) || defined(XZ_DEC_IA64) || defined(XZ_DEC_ARM) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 99) || defined(XZ_DEC_ARM) || defined(XZ_DEC_ARMTHUMB) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 100) || defined(XZ_DEC_SPARC)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 101) # define XZ_DEC_BCJ
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 102) # endif
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 103) #endif
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 104)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 105) #ifndef CRC32_POLY_LE
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 106) #define CRC32_POLY_LE 0xedb88320
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 107) #endif
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 108)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 109) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 110) * Allocate memory for LZMA2 decoder. xz_dec_lzma2_reset() must be used
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 111) * before calling xz_dec_lzma2_run().
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 112) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 113) XZ_EXTERN struct xz_dec_lzma2 *xz_dec_lzma2_create(enum xz_mode mode,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 114) uint32_t dict_max);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 115)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 116) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 117) * Decode the LZMA2 properties (one byte) and reset the decoder. Return
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 118) * XZ_OK on success, XZ_MEMLIMIT_ERROR if the preallocated dictionary is not
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 119) * big enough, and XZ_OPTIONS_ERROR if props indicates something that this
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 120) * decoder doesn't support.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 121) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 122) XZ_EXTERN enum xz_ret xz_dec_lzma2_reset(struct xz_dec_lzma2 *s,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 123) uint8_t props);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 124)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 125) /* Decode raw LZMA2 stream from b->in to b->out. */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 126) XZ_EXTERN enum xz_ret xz_dec_lzma2_run(struct xz_dec_lzma2 *s,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 127) struct xz_buf *b);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 128)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 129) /* Free the memory allocated for the LZMA2 decoder. */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 130) XZ_EXTERN void xz_dec_lzma2_end(struct xz_dec_lzma2 *s);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 131)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 132) #ifdef XZ_DEC_BCJ
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 133) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 134) * Allocate memory for BCJ decoders. xz_dec_bcj_reset() must be used before
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 135) * calling xz_dec_bcj_run().
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 136) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 137) XZ_EXTERN struct xz_dec_bcj *xz_dec_bcj_create(bool single_call);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 138)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 139) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 140) * Decode the Filter ID of a BCJ filter. This implementation doesn't
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 141) * support custom start offsets, so no decoding of Filter Properties
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 142) * is needed. Returns XZ_OK if the given Filter ID is supported.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 143) * Otherwise XZ_OPTIONS_ERROR is returned.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 144) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 145) XZ_EXTERN enum xz_ret xz_dec_bcj_reset(struct xz_dec_bcj *s, uint8_t id);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 146)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 147) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 148) * Decode raw BCJ + LZMA2 stream. This must be used only if there actually is
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 149) * a BCJ filter in the chain. If the chain has only LZMA2, xz_dec_lzma2_run()
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 150) * must be called directly.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 151) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 152) XZ_EXTERN enum xz_ret xz_dec_bcj_run(struct xz_dec_bcj *s,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 153) struct xz_dec_lzma2 *lzma2,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 154) struct xz_buf *b);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 155)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 156) /* Free the memory allocated for the BCJ filters. */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 157) #define xz_dec_bcj_end(s) kfree(s)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 158) #endif
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 159)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 160) #endif
Orange Pi5 kernel
Deprecated Linux kernel 5.10.110 for OrangePi 5/5B/5+ boards
3 Commits
0 Branches
0 Tags