124fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin/* 224fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin * Private includes and definitions 324fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin * 424fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin * Author: Lasse Collin <lasse.collin@tukaani.org> 524fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin * 624fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin * This file has been put into the public domain. 724fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin * You can do whatever you want with this file. 824fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin */ 924fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin 1024fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin#ifndef XZ_PRIVATE_H 1124fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin#define XZ_PRIVATE_H 1224fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin 1324fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin#ifdef __KERNEL__ 1424fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin# include <linux/xz.h> 1581d67439855a7f928d90965d832aa4f2fb677342Lasse Collin# include <linux/kernel.h> 1624fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin# include <asm/unaligned.h> 1724fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin /* XZ_PREBOOT may be defined only via decompress_unxz.c. */ 1824fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin# ifndef XZ_PREBOOT 1924fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin# include <linux/slab.h> 2024fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin# include <linux/vmalloc.h> 2124fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin# include <linux/string.h> 2224fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin# ifdef CONFIG_XZ_DEC_X86 2324fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin# define XZ_DEC_X86 2424fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin# endif 2524fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin# ifdef CONFIG_XZ_DEC_POWERPC 2624fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin# define XZ_DEC_POWERPC 2724fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin# endif 2824fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin# ifdef CONFIG_XZ_DEC_IA64 2924fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin# define XZ_DEC_IA64 3024fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin# endif 3124fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin# ifdef CONFIG_XZ_DEC_ARM 3224fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin# define XZ_DEC_ARM 3324fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin# endif 3424fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin# ifdef CONFIG_XZ_DEC_ARMTHUMB 3524fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin# define XZ_DEC_ARMTHUMB 3624fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin# endif 3724fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin# ifdef CONFIG_XZ_DEC_SPARC 3824fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin# define XZ_DEC_SPARC 3924fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin# endif 4024fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin# define memeq(a, b, size) (memcmp(a, b, size) == 0) 4124fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin# define memzero(buf, size) memset(buf, 0, size) 4224fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin# endif 4324fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin# define get_le32(p) le32_to_cpup((const uint32_t *)(p)) 4424fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin#else 4524fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin /* 4624fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin * For userspace builds, use a separate header to define the required 4724fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin * macros and functions. This makes it easier to adapt the code into 4824fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin * different environments and avoids clutter in the Linux kernel tree. 4924fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin */ 5024fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin# include "xz_config.h" 5124fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin#endif 5224fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin 5324fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin/* If no specific decoding mode is requested, enable support for all modes. */ 5424fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin#if !defined(XZ_DEC_SINGLE) && !defined(XZ_DEC_PREALLOC) \ 5524fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin && !defined(XZ_DEC_DYNALLOC) 5624fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin# define XZ_DEC_SINGLE 5724fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin# define XZ_DEC_PREALLOC 5824fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin# define XZ_DEC_DYNALLOC 5924fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin#endif 6024fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin 6124fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin/* 6224fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin * The DEC_IS_foo(mode) macros are used in "if" statements. If only some 6324fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin * of the supported modes are enabled, these macros will evaluate to true or 6424fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin * false at compile time and thus allow the compiler to omit unneeded code. 6524fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin */ 6624fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin#ifdef XZ_DEC_SINGLE 6724fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin# define DEC_IS_SINGLE(mode) ((mode) == XZ_SINGLE) 6824fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin#else 6924fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin# define DEC_IS_SINGLE(mode) (false) 7024fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin#endif 7124fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin 7224fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin#ifdef XZ_DEC_PREALLOC 7324fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin# define DEC_IS_PREALLOC(mode) ((mode) == XZ_PREALLOC) 7424fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin#else 7524fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin# define DEC_IS_PREALLOC(mode) (false) 7624fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin#endif 7724fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin 7824fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin#ifdef XZ_DEC_DYNALLOC 7924fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin# define DEC_IS_DYNALLOC(mode) ((mode) == XZ_DYNALLOC) 8024fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin#else 8124fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin# define DEC_IS_DYNALLOC(mode) (false) 8224fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin#endif 8324fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin 8424fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin#if !defined(XZ_DEC_SINGLE) 8524fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin# define DEC_IS_MULTI(mode) (true) 8624fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin#elif defined(XZ_DEC_PREALLOC) || defined(XZ_DEC_DYNALLOC) 8724fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin# define DEC_IS_MULTI(mode) ((mode) != XZ_SINGLE) 8824fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin#else 8924fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin# define DEC_IS_MULTI(mode) (false) 9024fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin#endif 9124fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin 9224fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin/* 9324fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin * If any of the BCJ filter decoders are wanted, define XZ_DEC_BCJ. 9424fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin * XZ_DEC_BCJ is used to enable generic support for BCJ decoders. 9524fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin */ 9624fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin#ifndef XZ_DEC_BCJ 9724fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin# if defined(XZ_DEC_X86) || defined(XZ_DEC_POWERPC) \ 9824fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin || defined(XZ_DEC_IA64) || defined(XZ_DEC_ARM) \ 9924fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin || defined(XZ_DEC_ARM) || defined(XZ_DEC_ARMTHUMB) \ 10024fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin || defined(XZ_DEC_SPARC) 10124fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin# define XZ_DEC_BCJ 10224fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin# endif 10324fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin#endif 10424fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin 10524fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin/* 10624fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin * Allocate memory for LZMA2 decoder. xz_dec_lzma2_reset() must be used 10724fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin * before calling xz_dec_lzma2_run(). 10824fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin */ 10924fa0402a9b6a537e87e38341e78b7da86486846Lasse CollinXZ_EXTERN struct xz_dec_lzma2 *xz_dec_lzma2_create(enum xz_mode mode, 11024fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin uint32_t dict_max); 11124fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin 11224fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin/* 11324fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin * Decode the LZMA2 properties (one byte) and reset the decoder. Return 11424fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin * XZ_OK on success, XZ_MEMLIMIT_ERROR if the preallocated dictionary is not 11524fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin * big enough, and XZ_OPTIONS_ERROR if props indicates something that this 11624fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin * decoder doesn't support. 11724fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin */ 11824fa0402a9b6a537e87e38341e78b7da86486846Lasse CollinXZ_EXTERN enum xz_ret xz_dec_lzma2_reset(struct xz_dec_lzma2 *s, 11924fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin uint8_t props); 12024fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin 12124fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin/* Decode raw LZMA2 stream from b->in to b->out. */ 12224fa0402a9b6a537e87e38341e78b7da86486846Lasse CollinXZ_EXTERN enum xz_ret xz_dec_lzma2_run(struct xz_dec_lzma2 *s, 12324fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin struct xz_buf *b); 12424fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin 12524fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin/* Free the memory allocated for the LZMA2 decoder. */ 12624fa0402a9b6a537e87e38341e78b7da86486846Lasse CollinXZ_EXTERN void xz_dec_lzma2_end(struct xz_dec_lzma2 *s); 12724fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin 12824fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin#ifdef XZ_DEC_BCJ 12924fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin/* 13024fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin * Allocate memory for BCJ decoders. xz_dec_bcj_reset() must be used before 13124fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin * calling xz_dec_bcj_run(). 13224fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin */ 13324fa0402a9b6a537e87e38341e78b7da86486846Lasse CollinXZ_EXTERN struct xz_dec_bcj *xz_dec_bcj_create(bool single_call); 13424fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin 13524fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin/* 13624fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin * Decode the Filter ID of a BCJ filter. This implementation doesn't 13724fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin * support custom start offsets, so no decoding of Filter Properties 13824fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin * is needed. Returns XZ_OK if the given Filter ID is supported. 13924fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin * Otherwise XZ_OPTIONS_ERROR is returned. 14024fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin */ 14124fa0402a9b6a537e87e38341e78b7da86486846Lasse CollinXZ_EXTERN enum xz_ret xz_dec_bcj_reset(struct xz_dec_bcj *s, uint8_t id); 14224fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin 14324fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin/* 14424fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin * Decode raw BCJ + LZMA2 stream. This must be used only if there actually is 14524fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin * a BCJ filter in the chain. If the chain has only LZMA2, xz_dec_lzma2_run() 14624fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin * must be called directly. 14724fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin */ 14824fa0402a9b6a537e87e38341e78b7da86486846Lasse CollinXZ_EXTERN enum xz_ret xz_dec_bcj_run(struct xz_dec_bcj *s, 14924fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin struct xz_dec_lzma2 *lzma2, 15024fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin struct xz_buf *b); 15124fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin 15224fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin/* Free the memory allocated for the BCJ filters. */ 15324fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin#define xz_dec_bcj_end(s) kfree(s) 15424fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin#endif 15524fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin 15624fa0402a9b6a537e87e38341e78b7da86486846Lasse Collin#endif 157