decompress.c

/*
 * Copyright (c) 2012 Dave Vasilevsky <dave@vasilevsky.ca>
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
#include "decompress.h"

#include "squashfs_fs.h"
#include "swap.h"

#include <string.h>

#if _WIN32
	#include "win_decompress.c.inc"
#endif


#ifdef HAVE_ZLIB_H
#include <zlib.h>

static sqfs_err sqfs_decompressor_zlib(void *in, size_t insz,
		void *out, size_t *outsz) {
	uLongf zout = *outsz;
	int zerr = uncompress((Bytef*)out, &zout, in, insz);
	if (zerr != Z_OK)
		return SQFS_ERR;
	*outsz = zout;
	return SQFS_OK;
}
#define CAN_DECOMPRESS_ZLIB 1
#endif


#ifdef HAVE_LZMA_H
#include <lzma.h>

static sqfs_err sqfs_decompressor_xz(void *in, size_t insz,
		void *out, size_t *outsz) {
	/* FIXME: Save stream state, to minimize setup time? */
	uint64_t memlimit = UINT64_MAX;
	size_t inpos = 0, outpos = 0;
	lzma_ret err = lzma_stream_buffer_decode(&memlimit, 0, NULL, in, &inpos, insz,
		out, &outpos, *outsz);
	if (err != LZMA_OK)
		return SQFS_ERR;
	*outsz = outpos;
	return SQFS_OK;
}
#define CAN_DECOMPRESS_XZ 1

// The following implementation was adapted from  squashfs-tools
// https://github.com/plougher/squashfs-tools.git

#define LZMA_PROPS_SIZE 5
#define LZMA_UNCOMP_SIZE 8
#define LZMA_HEADER_SIZE (LZMA_PROPS_SIZE + LZMA_UNCOMP_SIZE)
#define MEMLIMIT (32 * 1024 * 1024)

static sqfs_err sqfs_decompressor_lzma(void *in, size_t insz,
		void *out, size_t *outsz) {

	lzma_stream strm = LZMA_STREAM_INIT;
	uint32_t uncompressed_size = 0, res;
	unsigned char lzma_header[LZMA_HEADER_SIZE];

	res = lzma_alone_decoder(&strm, MEMLIMIT);
	if (res != LZMA_OK) {
		lzma_end(&strm);
		return SQFS_ERR;
	}

	memcpy(lzma_header, in, LZMA_HEADER_SIZE);
	uncompressed_size = *((uint32_t*)(lzma_header + LZMA_PROPS_SIZE));
	sqfs_swapin32(&uncompressed_size);

	if (uncompressed_size > *outsz) {
		lzma_end(&strm);
		return SQFS_ERR;
	}

	memset(lzma_header + LZMA_PROPS_SIZE, 255, LZMA_UNCOMP_SIZE);

	strm.next_out = out;
	strm.avail_out = *outsz;
	strm.next_in = lzma_header;
	strm.avail_in = LZMA_HEADER_SIZE;

	res = lzma_code(&strm, LZMA_RUN);

	if (res != LZMA_OK || strm.avail_in != 0) {
		lzma_end(&strm);
		return SQFS_ERR;
	}

	strm.next_in = (uint8_t *)in + LZMA_HEADER_SIZE;
	strm.avail_in = insz - LZMA_HEADER_SIZE;

	res = lzma_code(&strm, LZMA_FINISH);
	lzma_end(&strm);

	if (res == LZMA_STREAM_END || (res == LZMA_OK &&
		strm.total_out >= uncompressed_size && strm.avail_in == 0)) {
		*outsz = uncompressed_size;
		return SQFS_OK;
	}

	return SQFS_ERR;
}
#define CAN_DECOMPRESS_LZMA 1
#endif


#ifdef HAVE_LZO_LZO1X_H
#include <lzo/lzo1x.h>

static sqfs_err sqfs_decompressor_lzo(void *in, size_t insz,
		void *out, size_t *outsz) {
	lzo_uint lzout = *outsz;
	int err = lzo1x_decompress_safe(in, insz, out, &lzout, NULL);
	if (err != LZO_E_OK)
		return SQFS_ERR;
	*outsz = lzout;
	return SQFS_OK;
}
#define CAN_DECOMPRESS_LZO 1
#endif


#ifdef HAVE_LZ4_H
#include <lz4.h>
static sqfs_err sqfs_decompressor_lz4(void *in, size_t insz,
		void *out, size_t *outsz) {
	int lz4out = LZ4_decompress_safe (in, out, insz, *outsz);
	if (lz4out < 0)
		return SQFS_ERR;
	*outsz = lz4out;
	return SQFS_OK;
}
#define CAN_DECOMPRESS_LZ4 1
#endif


#ifdef HAVE_ZSTD_H
#include <zstd.h>
static sqfs_err sqfs_decompressor_zstd(void *in, size_t insz,
        void *out, size_t *outsz) {
	const size_t zstdout = ZSTD_decompress(out, *outsz, in, insz);
	if (ZSTD_isError(zstdout))
		return SQFS_ERR;
	*outsz = zstdout;
	return SQFS_OK;
}
#define CAN_DECOMPRESS_ZSTD 1
#endif

sqfs_decompressor sqfs_decompressor_get(sqfs_compression_type type) {
	switch (type) {
#ifdef CAN_DECOMPRESS_ZLIB
		case ZLIB_COMPRESSION: return &sqfs_decompressor_zlib;
#endif
#ifdef CAN_DECOMPRESS_LZMA
		case LZMA_COMPRESSION: return &sqfs_decompressor_lzma;
#endif
#ifdef CAN_DECOMPRESS_LZO
		case LZO_COMPRESSION: return &sqfs_decompressor_lzo;
#endif
#ifdef CAN_DECOMPRESS_XZ
		case XZ_COMPRESSION: return &sqfs_decompressor_xz;
#endif
#ifdef CAN_DECOMPRESS_LZ4
		case LZ4_COMPRESSION: return &sqfs_decompressor_lz4;
#endif
#ifdef CAN_DECOMPRESS_ZSTD
		case ZSTD_COMPRESSION: return &sqfs_decompressor_zstd;
#endif
		default: return NULL;
	}
}

static char *const sqfs_compression_names[SQFS_COMP_MAX] = {
	NULL, "zlib", "lzma", "lzo", "xz", "lz4", "zstd",
};

char *sqfs_compression_name(sqfs_compression_type type) {
	if (type < 0 || type >= SQFS_COMP_MAX)
		return NULL;
	return sqfs_compression_names[type];
}

void sqfs_compression_supported(sqfs_compression_type *types) {
	size_t i = 0;
	memset(types, SQFS_COMP_UNKNOWN, SQFS_COMP_MAX * sizeof(*types));
#ifdef CAN_DECOMPRESS_ZLIB
	types[i++] = ZLIB_COMPRESSION;
#endif
#ifdef CAN_DECOMPRESS_LZMA
	types[i++] = LZMA_COMPRESSION;
#endif
#ifdef CAN_DECOMPRESS_LZO
	types[i++] = LZO_COMPRESSION;
#endif
#ifdef CAN_DECOMPRESS_XZ
	types[i++] = XZ_COMPRESSION;
#endif
#ifdef CAN_DECOMPRESS_LZ4
	types[i++] = LZ4_COMPRESSION;
#endif
#ifdef CAN_DECOMPRESS_ZSTD
	types[i++] = ZSTD_COMPRESSION;
#endif
}