LzmaDecompress.c File Reference

#include "LzmaDecompressLibInternal.h"
#include "Sdk/C/7zTypes.h"
#include "Sdk/C/7zVersion.h"
#include "Sdk/C/LzmaDec.h"

Go to the source code of this file.

Data Structures
struct	ISzAllocWithData

Macros
#define	SCRATCH_BUFFER_REQUEST_SIZE   SIZE_64KB
#define	LZMA_HEADER_SIZE   (LZMA_PROPS_SIZE + 8)

Functions
VOID *	SzAlloc (CONST ISzAlloc *P, size_t Size)
VOID	SzFree (CONST ISzAlloc *P, VOID *Address)
UINT64	GetDecodedSizeOfBuf (UINT8 *EncodedData)
RETURN_STATUS EFIAPI	LzmaUefiDecompressGetInfo (IN CONST VOID *Source, IN UINT32 SourceSize, OUT UINT32 *DestinationSize, OUT UINT32 *ScratchSize)
RETURN_STATUS EFIAPI	LzmaUefiDecompress (IN CONST VOID *Source, IN UINTN SourceSize, IN OUT VOID *Destination, IN OUT VOID *Scratch)

Detailed Description

LZMA Decompress interfaces

Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file LzmaDecompress.c.

Macro Definition Documentation

LZMA_HEADER_SIZE

#define LZMA_HEADER_SIZE   (LZMA_PROPS_SIZE + 8)

Definition at line 71 of file LzmaDecompress.c.

SCRATCH_BUFFER_REQUEST_SIZE

#define SCRATCH_BUFFER_REQUEST_SIZE   SIZE_64KB

Definition at line 14 of file LzmaDecompress.c.

Function Documentation

GetDecodedSizeOfBuf()

UINT64 GetDecodedSizeOfBuf

(

UINT8 *

EncodedData

)

Get the size of the uncompressed buffer by parsing EncodeData header.

Parameters

EncodedData

Pointer to the compressed data.

Returns

The size of the uncompressed buffer.

Definition at line 81 of file LzmaDecompress.c.

LzmaUefiDecompress()

RETURN_STATUS EFIAPI LzmaUefiDecompress	(	IN CONST VOID *	Source,
		IN UINTN	SourceSize,
		IN OUT VOID *	Destination,
		IN OUT VOID *	Scratch
	)

Decompresses a Lzma compressed source buffer.

Extracts decompressed data to its original form. If the compressed source data specified by Source is successfully decompressed into Destination, then RETURN_SUCCESS is returned. If the compressed source data specified by Source is not in a valid compressed data format, then RETURN_INVALID_PARAMETER is returned.

Parameters

Source	The source buffer containing the compressed data.
SourceSize	The size of source buffer.
Destination	The destination buffer to store the decompressed data
Scratch	A temporary scratch buffer that is used to perform the decompression. This is an optional parameter that may be NULL if the required scratch buffer size is 0.

Return values

RETURN_SUCCESS	Decompression completed successfully, and the uncompressed buffer is returned in Destination.
RETURN_INVALID_PARAMETER	The source buffer specified by Source is corrupted (not in a valid compressed format).

Definition at line 182 of file LzmaDecompress.c.

LzmaUefiDecompressGetInfo()

RETURN_STATUS EFIAPI LzmaUefiDecompressGetInfo	(	IN CONST VOID *	Source,
		IN UINT32	SourceSize,
		OUT UINT32 *	DestinationSize,
		OUT UINT32 *	ScratchSize
	)

Given a Lzma compressed source buffer, this function retrieves the size of the uncompressed buffer and the size of the scratch buffer required to decompress the compressed source buffer.

Retrieves the size of the uncompressed buffer and the temporary scratch buffer required to decompress the buffer specified by Source and SourceSize. The size of the uncompressed buffer is returned in DestinationSize, the size of the scratch buffer is returned in ScratchSize, and RETURN_SUCCESS is returned. This function does not have scratch buffer available to perform a thorough checking of the validity of the source data. It just retrieves the "Original Size" field from the LZMA_HEADER_SIZE beginning bytes of the source data and output it as DestinationSize. And ScratchSize is specific to the decompression implementation.

If SourceSize is less than LZMA_HEADER_SIZE, then ASSERT().

Parameters

Source	The source buffer containing the compressed data.
SourceSize	The size, in bytes, of the source buffer.
DestinationSize	A pointer to the size, in bytes, of the uncompressed buffer that will be generated when the compressed buffer specified by Source and SourceSize is decompressed.
ScratchSize	A pointer to the size, in bytes, of the scratch buffer that is required to decompress the compressed buffer specified by Source and SourceSize.

Return values

RETURN_SUCCESS	The size of the uncompressed data was returned in DestinationSize and the size of the scratch buffer was returned in ScratchSize.
RETURN_UNSUPPORTED	DestinationSize cannot be output because the uncompressed buffer size (in bytes) does not fit in a UINT32. Output parameters have not been modified.

Definition at line 137 of file LzmaDecompress.c.

SzAlloc()

VOID * SzAlloc	(	CONST ISzAlloc *	P,
		size_t	Size
	)

Allocation routine used by LZMA decompression.

Parameters

P	Pointer to the ISzAlloc instance
Size	The size in bytes to be allocated

Returns

The allocated pointer address, or NULL on failure

Definition at line 31 of file LzmaDecompress.c.

SzFree()

VOID SzFree	(	CONST ISzAlloc *	P,
		VOID *	Address
	)

Free routine used by LZMA decompression.

Parameters

P	Pointer to the ISzAlloc instance
Address	The address to be freed

Definition at line 59 of file LzmaDecompress.c.