3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 1) /*
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 2) * Wrapper for decompressing XZ-compressed kernel, initramfs, and initrd
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 3) *
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 4) * Author: Lasse Collin <lasse.collin@tukaani.org>
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 5) *
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 6) * This file has been put into the public domain.
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 7) * You can do whatever you want with this file.
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 8) */
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 9)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 10) /*
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 11) * Important notes about in-place decompression
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 12) *
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 13) * At least on x86, the kernel is decompressed in place: the compressed data
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 14) * is placed to the end of the output buffer, and the decompressor overwrites
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 15) * most of the compressed data. There must be enough safety margin to
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 16) * guarantee that the write position is always behind the read position.
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 17) *
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 18) * The safety margin for XZ with LZMA2 or BCJ+LZMA2 is calculated below.
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 19) * Note that the margin with XZ is bigger than with Deflate (gzip)!
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 20) *
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 21) * The worst case for in-place decompression is that the beginning of
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 22) * the file is compressed extremely well, and the rest of the file is
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 23) * uncompressible. Thus, we must look for worst-case expansion when the
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 24) * compressor is encoding uncompressible data.
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 25) *
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 26) * The structure of the .xz file in case of a compresed kernel is as follows.
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 27) * Sizes (as bytes) of the fields are in parenthesis.
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 28) *
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 29) * Stream Header (12)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 30) * Block Header:
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 31) * Block Header (8-12)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 32) * Compressed Data (N)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 33) * Block Padding (0-3)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 34) * CRC32 (4)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 35) * Index (8-20)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 36) * Stream Footer (12)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 37) *
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 38) * Normally there is exactly one Block, but let's assume that there are
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 39) * 2-4 Blocks just in case. Because Stream Header and also Block Header
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 40) * of the first Block don't make the decompressor produce any uncompressed
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 41) * data, we can ignore them from our calculations. Block Headers of possible
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 42) * additional Blocks have to be taken into account still. With these
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 43) * assumptions, it is safe to assume that the total header overhead is
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 44) * less than 128 bytes.
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 45) *
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 46) * Compressed Data contains LZMA2 or BCJ+LZMA2 encoded data. Since BCJ
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 47) * doesn't change the size of the data, it is enough to calculate the
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 48) * safety margin for LZMA2.
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 49) *
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 50) * LZMA2 stores the data in chunks. Each chunk has a header whose size is
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 51) * a maximum of 6 bytes, but to get round 2^n numbers, let's assume that
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 52) * the maximum chunk header size is 8 bytes. After the chunk header, there
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 53) * may be up to 64 KiB of actual payload in the chunk. Often the payload is
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 54) * quite a bit smaller though; to be safe, let's assume that an average
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 55) * chunk has only 32 KiB of payload.
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 56) *
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 57) * The maximum uncompressed size of the payload is 2 MiB. The minimum
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 58) * uncompressed size of the payload is in practice never less than the
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 59) * payload size itself. The LZMA2 format would allow uncompressed size
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 60) * to be less than the payload size, but no sane compressor creates such
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 61) * files. LZMA2 supports storing uncompressible data in uncompressed form,
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 62) * so there's never a need to create payloads whose uncompressed size is
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 63) * smaller than the compressed size.
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 64) *
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 65) * The assumption, that the uncompressed size of the payload is never
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 66) * smaller than the payload itself, is valid only when talking about
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 67) * the payload as a whole. It is possible that the payload has parts where
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 68) * the decompressor consumes more input than it produces output. Calculating
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 69) * the worst case for this would be tricky. Instead of trying to do that,
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 70) * let's simply make sure that the decompressor never overwrites any bytes
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 71) * of the payload which it is currently reading.
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 72) *
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 73) * Now we have enough information to calculate the safety margin. We need
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 74) * - 128 bytes for the .xz file format headers;
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 75) * - 8 bytes per every 32 KiB of uncompressed size (one LZMA2 chunk header
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 76) * per chunk, each chunk having average payload size of 32 KiB); and
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 77) * - 64 KiB (biggest possible LZMA2 chunk payload size) to make sure that
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 78) * the decompressor never overwrites anything from the LZMA2 chunk
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 79) * payload it is currently reading.
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 80) *
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 81) * We get the following formula:
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 82) *
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 83) * safety_margin = 128 + uncompressed_size * 8 / 32768 + 65536
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 84) * = 128 + (uncompressed_size >> 12) + 65536
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 85) *
25985edcedea6 (Lucas De Marchi 2011-03-30 22:57:33 -0300 86) * For comparison, according to arch/x86/boot/compressed/misc.c, the
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 87) * equivalent formula for Deflate is this:
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 88) *
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 89) * safety_margin = 18 + (uncompressed_size >> 12) + 32768
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 90) *
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 91) * Thus, when updating Deflate-only in-place kernel decompressor to
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 92) * support XZ, the fixed overhead has to be increased from 18+32768 bytes
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 93) * to 128+65536 bytes.
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 94) */
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 95)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 96) /*
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 97) * STATIC is defined to "static" if we are being built for kernel
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 98) * decompression (pre-boot code). <linux/decompress/mm.h> will define
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 99) * STATIC to empty if it wasn't already defined. Since we will need to
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 100) * know later if we are being used for kernel decompression, we define
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 101) * XZ_PREBOOT here.
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 102) */
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 103) #ifdef STATIC
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 104) # define XZ_PREBOOT
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 105) #endif
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 106) #ifdef __KERNEL__
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 107) # include <linux/decompress/mm.h>
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 108) #endif
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 109) #define XZ_EXTERN STATIC
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 110)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 111) #ifndef XZ_PREBOOT
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 112) # include <linux/slab.h>
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 113) # include <linux/xz.h>
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 114) #else
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 115) /*
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 116) * Use the internal CRC32 code instead of kernel's CRC32 module, which
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 117) * is not available in early phase of booting.
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 118) */
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 119) #define XZ_INTERNAL_CRC32 1
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 120)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 121) /*
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 122) * For boot time use, we enable only the BCJ filter of the current
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 123) * architecture or none if no BCJ filter is available for the architecture.
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 124) */
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 125) #ifdef CONFIG_X86
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 126) # define XZ_DEC_X86
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 127) #endif
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 128) #ifdef CONFIG_PPC
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 129) # define XZ_DEC_POWERPC
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 130) #endif
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 131) #ifdef CONFIG_ARM
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 132) # define XZ_DEC_ARM
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 133) #endif
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 134) #ifdef CONFIG_IA64
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 135) # define XZ_DEC_IA64
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 136) #endif
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 137) #ifdef CONFIG_SPARC
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 138) # define XZ_DEC_SPARC
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 139) #endif
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 140)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 141) /*
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 142) * This will get the basic headers so that memeq() and others
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 143) * can be defined.
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 144) */
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 145) #include "xz/xz_private.h"
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 146)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 147) /*
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 148) * Replace the normal allocation functions with the versions from
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 149) * <linux/decompress/mm.h>. vfree() needs to support vfree(NULL)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 150) * when XZ_DYNALLOC is used, but the pre-boot free() doesn't support it.
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 151) * Workaround it here because the other decompressors don't need it.
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 152) */
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 153) #undef kmalloc
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 154) #undef kfree
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 155) #undef vmalloc
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 156) #undef vfree
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 157) #define kmalloc(size, flags) malloc(size)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 158) #define kfree(ptr) free(ptr)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 159) #define vmalloc(size) malloc(size)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 160) #define vfree(ptr) do { if (ptr != NULL) free(ptr); } while (0)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 161)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 162) /*
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 163) * FIXME: Not all basic memory functions are provided in architecture-specific
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 164) * files (yet). We define our own versions here for now, but this should be
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 165) * only a temporary solution.
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 166) *
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 167) * memeq and memzero are not used much and any remotely sane implementation
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 168) * is fast enough. memcpy/memmove speed matters in multi-call mode, but
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 169) * the kernel image is decompressed in single-call mode, in which only
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 170) * memcpy speed can matter and only if there is a lot of uncompressible data
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 171) * (LZMA2 stores uncompressible chunks in uncompressed form). Thus, the
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 172) * functions below should just be kept small; it's probably not worth
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 173) * optimizing for speed.
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 174) */
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 175)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 176) #ifndef memeq
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 177) static bool memeq(const void *a, const void *b, size_t size)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 178) {
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 179) const uint8_t *x = a;
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 180) const uint8_t *y = b;
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 181) size_t i;
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 182)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 183) for (i = 0; i < size; ++i)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 184) if (x[i] != y[i])
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 185) return false;
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 186)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 187) return true;
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 188) }
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 189) #endif
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 190)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 191) #ifndef memzero
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 192) static void memzero(void *buf, size_t size)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 193) {
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 194) uint8_t *b = buf;
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 195) uint8_t *e = b + size;
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 196)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 197) while (b != e)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 198) *b++ = '\0';
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 199) }
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 200) #endif
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 201)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 202) #ifndef memmove
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 203) /* Not static to avoid a conflict with the prototype in the Linux headers. */
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 204) void *memmove(void *dest, const void *src, size_t size)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 205) {
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 206) uint8_t *d = dest;
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 207) const uint8_t *s = src;
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 208) size_t i;
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 209)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 210) if (d < s) {
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 211) for (i = 0; i < size; ++i)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 212) d[i] = s[i];
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 213) } else if (d > s) {
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 214) i = size;
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 215) while (i-- > 0)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 216) d[i] = s[i];
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 217) }
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 218)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 219) return dest;
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 220) }
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 221) #endif
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 222)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 223) /*
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 224) * Since we need memmove anyway, would use it as memcpy too.
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 225) * Commented out for now to avoid breaking things.
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 226) */
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 227) /*
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 228) #ifndef memcpy
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 229) # define memcpy memmove
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 230) #endif
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 231) */
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 232)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 233) #include "xz/xz_crc32.c"
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 234) #include "xz/xz_dec_stream.c"
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 235) #include "xz/xz_dec_lzma2.c"
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 236) #include "xz/xz_dec_bcj.c"
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 237)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 238) #endif /* XZ_PREBOOT */
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 239)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 240) /* Size of the input and output buffers in multi-call mode */
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 241) #define XZ_IOBUF_SIZE 4096
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 242)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 243) /*
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 244) * This function implements the API defined in <linux/decompress/generic.h>.
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 245) *
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 246) * This wrapper will automatically choose single-call or multi-call mode
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 247) * of the native XZ decoder API. The single-call mode can be used only when
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 248) * both input and output buffers are available as a single chunk, i.e. when
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 249) * fill() and flush() won't be used.
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 250) */
d97b07c54f34e (Yinghai Lu 2014-08-08 14:23:14 -0700 251) STATIC int INIT unxz(unsigned char *in, long in_size,
d97b07c54f34e (Yinghai Lu 2014-08-08 14:23:14 -0700 252) long (*fill)(void *dest, unsigned long size),
d97b07c54f34e (Yinghai Lu 2014-08-08 14:23:14 -0700 253) long (*flush)(void *src, unsigned long size),
d97b07c54f34e (Yinghai Lu 2014-08-08 14:23:14 -0700 254) unsigned char *out, long *in_used,
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 255) void (*error)(char *x))
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 256) {
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 257) struct xz_buf b;
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 258) struct xz_dec *s;
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 259) enum xz_ret ret;
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 260) bool must_free_in = false;
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 261)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 262) #if XZ_INTERNAL_CRC32
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 263) xz_crc32_init();
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 264) #endif
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 265)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 266) if (in_used != NULL)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 267) *in_used = 0;
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 268)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 269) if (fill == NULL && flush == NULL)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 270) s = xz_dec_init(XZ_SINGLE, 0);
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 271) else
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 272) s = xz_dec_init(XZ_DYNALLOC, (uint32_t)-1);
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 273)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 274) if (s == NULL)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 275) goto error_alloc_state;
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 276)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 277) if (flush == NULL) {
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 278) b.out = out;
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 279) b.out_size = (size_t)-1;
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 280) } else {
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 281) b.out_size = XZ_IOBUF_SIZE;
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 282) b.out = malloc(XZ_IOBUF_SIZE);
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 283) if (b.out == NULL)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 284) goto error_alloc_out;
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 285) }
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 286)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 287) if (in == NULL) {
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 288) must_free_in = true;
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 289) in = malloc(XZ_IOBUF_SIZE);
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 290) if (in == NULL)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 291) goto error_alloc_in;
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 292) }
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 293)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 294) b.in = in;
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 295) b.in_pos = 0;
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 296) b.in_size = in_size;
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 297) b.out_pos = 0;
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 298)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 299) if (fill == NULL && flush == NULL) {
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 300) ret = xz_dec_run(s, &b);
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 301) } else {
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 302) do {
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 303) if (b.in_pos == b.in_size && fill != NULL) {
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 304) if (in_used != NULL)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 305) *in_used += b.in_pos;
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 306)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 307) b.in_pos = 0;
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 308)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 309) in_size = fill(in, XZ_IOBUF_SIZE);
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 310) if (in_size < 0) {
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 311) /*
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 312) * This isn't an optimal error code
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 313) * but it probably isn't worth making
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 314) * a new one either.
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 315) */
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 316) ret = XZ_BUF_ERROR;
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 317) break;
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 318) }
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 319)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 320) b.in_size = in_size;
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 321) }
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 322)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 323) ret = xz_dec_run(s, &b);
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 324)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 325) if (flush != NULL && (b.out_pos == b.out_size
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 326) || (ret != XZ_OK && b.out_pos > 0))) {
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 327) /*
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 328) * Setting ret here may hide an error
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 329) * returned by xz_dec_run(), but probably
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 330) * it's not too bad.
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 331) */
d97b07c54f34e (Yinghai Lu 2014-08-08 14:23:14 -0700 332) if (flush(b.out, b.out_pos) != (long)b.out_pos)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 333) ret = XZ_BUF_ERROR;
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 334)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 335) b.out_pos = 0;
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 336) }
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 337) } while (ret == XZ_OK);
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 338)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 339) if (must_free_in)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 340) free(in);
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 341)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 342) if (flush != NULL)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 343) free(b.out);
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 344) }
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 345)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 346) if (in_used != NULL)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 347) *in_used += b.in_pos;
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 348)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 349) xz_dec_end(s);
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 350)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 351) switch (ret) {
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 352) case XZ_STREAM_END:
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 353) return 0;
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 354)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 355) case XZ_MEM_ERROR:
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 356) /* This can occur only in multi-call mode. */
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 357) error("XZ decompressor ran out of memory");
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 358) break;
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 359)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 360) case XZ_FORMAT_ERROR:
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 361) error("Input is not in the XZ format (wrong magic bytes)");
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 362) break;
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 363)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 364) case XZ_OPTIONS_ERROR:
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 365) error("Input was encoded with settings that are not "
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 366) "supported by this XZ decoder");
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 367) break;
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 368)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 369) case XZ_DATA_ERROR:
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 370) case XZ_BUF_ERROR:
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 371) error("XZ-compressed data is corrupt");
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 372) break;
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 373)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 374) default:
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 375) error("Bug in the XZ decompressor");
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 376) break;
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 377) }
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 378)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 379) return -1;
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 380)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 381) error_alloc_in:
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 382) if (flush != NULL)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 383) free(b.out);
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 384)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 385) error_alloc_out:
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 386) xz_dec_end(s);
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 387)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 388) error_alloc_state:
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 389) error("XZ decompressor ran out of memory");
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 390) return -1;
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 391) }
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 392)
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 393) /*
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 394) * This macro is used by architecture-specific files to decompress
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 395) * the kernel image.
3ebe12439ba7f (Lasse Collin 2011-01-12 17:01:23 -0800 396) */
2d3862d26e67a (Yinghai Lu 2015-09-09 15:39:12 -0700 397) #ifdef XZ_PREBOOT
2d3862d26e67a (Yinghai Lu 2015-09-09 15:39:12 -0700 398) STATIC int INIT __decompress(unsigned char *buf, long len,
2d3862d26e67a (Yinghai Lu 2015-09-09 15:39:12 -0700 399) long (*fill)(void*, unsigned long),
2d3862d26e67a (Yinghai Lu 2015-09-09 15:39:12 -0700 400) long (*flush)(void*, unsigned long),
2d3862d26e67a (Yinghai Lu 2015-09-09 15:39:12 -0700 401) unsigned char *out_buf, long olen,
2d3862d26e67a (Yinghai Lu 2015-09-09 15:39:12 -0700 402) long *pos,
2d3862d26e67a (Yinghai Lu 2015-09-09 15:39:12 -0700 403) void (*error)(char *x))
2d3862d26e67a (Yinghai Lu 2015-09-09 15:39:12 -0700 404) {
2d3862d26e67a (Yinghai Lu 2015-09-09 15:39:12 -0700 405) return unxz(buf, len, fill, flush, out_buf, pos, error);
2d3862d26e67a (Yinghai Lu 2015-09-09 15:39:12 -0700 406) }
2d3862d26e67a (Yinghai Lu 2015-09-09 15:39:12 -0700 407) #endif
VisionFive2 Linux kernel
StarFive Tech Linux Kernel for VisionFive (JH7110) boards (mirror)
More than 9999 Commits
32 Branches
54 Tags