BaseTools: Fix build on FreeBSD and allow use of non-gcc system compiler

[mirror_edk2.git] / BaseTools / Source / C / LzmaCompress / Sdk / lzma.txt

LZMA SDK 4.65\r
-------------\r
\r
LZMA SDK provides the documentation, samples, header files, libraries, \r
and tools you need to develop applications that use LZMA compression.\r
\r
LZMA is default and general compression method of 7z format\r
in 7-Zip compression program (www.7-zip.org). LZMA provides high \r
compression ratio and very fast decompression.\r
\r
LZMA is an improved version of famous LZ77 compression algorithm. \r
It was improved in way of maximum increasing of compression ratio,\r
keeping high decompression speed and low memory requirements for \r
decompressing.\r
\r
\r
\r
LICENSE\r
-------\r
\r
LZMA SDK is written and placed in the public domain by Igor Pavlov.\r
\r
\r
LZMA SDK Contents\r
-----------------\r
\r
LZMA SDK includes:\r
\r
  - ANSI-C/C++/C#/Java source code for LZMA compressing and decompressing\r
  - Compiled file->file LZMA compressing/decompressing program for Windows system\r
\r
\r
UNIX/Linux version \r
------------------\r
To compile C++ version of file->file LZMA encoding, go to directory\r
C++/7zip/Compress/LZMA_Alone \r
and call make to recompile it:\r
  make -f makefile.gcc clean all\r
\r
In some UNIX/Linux versions you must compile LZMA with static libraries.\r
To compile with static libraries, you can use \r
LIB = -lm -static\r
\r
\r
Files\r
---------------------\r
lzma.txt     - LZMA SDK description (this file)\r
7zFormat.txt - 7z Format description\r
7zC.txt      - 7z ANSI-C Decoder description\r
methods.txt  - Compression method IDs for .7z\r
lzma.exe     - Compiled file->file LZMA encoder/decoder for Windows\r
history.txt  - history of the LZMA SDK\r
\r
\r
Source code structure\r
---------------------\r
\r
C/  - C files\r
        7zCrc*.*   - CRC code\r
        Alloc.*    - Memory allocation functions\r
        Bra*.*     - Filters for x86, IA-64, ARM, ARM-Thumb, PowerPC and SPARC code\r
        LzFind.*   - Match finder for LZ (LZMA) encoders \r
        LzFindMt.* - Match finder for LZ (LZMA) encoders for multithreading encoding\r
        LzHash.h   - Additional file for LZ match finder\r
        LzmaDec.*  - LZMA decoding\r
        LzmaEnc.*  - LZMA encoding\r
        LzmaLib.*  - LZMA Library for DLL calling\r
        Types.h    - Basic types for another .c files\r
	Threads.*  - The code for multithreading.\r
\r
    LzmaLib  - LZMA Library (.DLL for Windows)\r
    \r
    LzmaUtil - LZMA Utility (file->file LZMA encoder/decoder).\r
\r
    Archive - files related to archiving\r
      7z     - 7z ANSI-C Decoder\r
\r
CPP/ -- CPP files\r
\r
  Common  - common files for C++ projects\r
  Windows - common files for Windows related code\r
\r
  7zip    - files related to 7-Zip Project\r
\r
    Common   - common files for 7-Zip\r
\r
    Compress - files related to compression/decompression\r
\r
      Copy         - Copy coder\r
      RangeCoder   - Range Coder (special code of compression/decompression)\r
      LZMA         - LZMA compression/decompression on C++\r
      LZMA_Alone   - file->file LZMA compression/decompression\r
      Branch       - Filters for x86, IA-64, ARM, ARM-Thumb, PowerPC and SPARC code\r
\r
    Archive - files related to archiving\r
\r
      Common   - common files for archive handling\r
      7z       - 7z C++ Encoder/Decoder\r
\r
    Bundles    - Modules that are bundles of other modules\r
  \r
      Alone7z           - 7zr.exe: Standalone version of 7z.exe that supports only 7z/LZMA/BCJ/BCJ2\r
      Format7zR         - 7zr.dll: Reduced version of 7za.dll: extracting/compressing to 7z/LZMA/BCJ/BCJ2\r
      Format7zExtractR  - 7zxr.dll: Reduced version of 7zxa.dll: extracting from 7z/LZMA/BCJ/BCJ2.\r
\r
    UI        - User Interface files\r
         \r
      Client7z - Test application for 7za.dll,  7zr.dll, 7zxr.dll\r
      Common   - Common UI files\r
      Console  - Code for console archiver\r
\r
\r
\r
CS/ - C# files\r
  7zip\r
    Common   - some common files for 7-Zip\r
    Compress - files related to compression/decompression\r
      LZ     - files related to LZ (Lempel-Ziv) compression algorithm\r
      LZMA         - LZMA compression/decompression\r
      LzmaAlone    - file->file LZMA compression/decompression\r
      RangeCoder   - Range Coder (special code of compression/decompression)\r
\r
Java/  - Java files\r
  SevenZip\r
    Compression    - files related to compression/decompression\r
      LZ           - files related to LZ (Lempel-Ziv) compression algorithm\r
      LZMA         - LZMA compression/decompression\r
      RangeCoder   - Range Coder (special code of compression/decompression)\r
\r
\r
C/C++ source code of LZMA SDK is part of 7-Zip project.\r
7-Zip source code can be downloaded from 7-Zip's SourceForge page:\r
\r
  http://sourceforge.net/projects/sevenzip/\r
\r
\r
\r
LZMA features\r
-------------\r
  - Variable dictionary size (up to 1 GB)\r
  - Estimated compressing speed: about 2 MB/s on 2 GHz CPU\r
  - Estimated decompressing speed: \r
      - 20-30 MB/s on 2 GHz Core 2 or AMD Athlon 64\r
      - 1-2 MB/s on 200 MHz ARM, MIPS, PowerPC or other simple RISC\r
  - Small memory requirements for decompressing (16 KB + DictionarySize)\r
  - Small code size for decompressing: 5-8 KB\r
\r
LZMA decoder uses only integer operations and can be \r
implemented in any modern 32-bit CPU (or on 16-bit CPU with some conditions).\r
\r
Some critical operations that affect the speed of LZMA decompression:\r
  1) 32*16 bit integer multiply\r
  2) Misspredicted branches (penalty mostly depends from pipeline length)\r
  3) 32-bit shift and arithmetic operations\r
\r
The speed of LZMA decompressing mostly depends from CPU speed.\r
Memory speed has no big meaning. But if your CPU has small data cache, \r
overall weight of memory speed will slightly increase.\r
\r
\r
How To Use\r
----------\r
\r
Using LZMA encoder/decoder executable\r
--------------------------------------\r
\r
Usage:  LZMA <e|d> inputFile outputFile [<switches>...]\r
\r
  e: encode file\r
\r
  d: decode file\r
\r
  b: Benchmark. There are two tests: compressing and decompressing \r
     with LZMA method. Benchmark shows rating in MIPS (million \r
     instructions per second). Rating value is calculated from \r
     measured speed and it is normalized with Intel's Core 2 results.\r
     Also Benchmark checks possible hardware errors (RAM \r
     errors in most cases). Benchmark uses these settings:\r
     (-a1, -d21, -fb32, -mfbt4). You can change only -d parameter. \r
     Also you can change the number of iterations. Example for 30 iterations:\r
       LZMA b 30\r
     Default number of iterations is 10.\r
\r
<Switches>\r
  \r
\r
  -a{N}:  set compression mode 0 = fast, 1 = normal\r
          default: 1 (normal)\r
\r
  d{N}:   Sets Dictionary size - [0, 30], default: 23 (8MB)\r
          The maximum value for dictionary size is 1 GB = 2^30 bytes.\r
          Dictionary size is calculated as DictionarySize = 2^N bytes. \r
          For decompressing file compressed by LZMA method with dictionary \r
          size D = 2^N you need about D bytes of memory (RAM).\r
\r
  -fb{N}: set number of fast bytes - [5, 273], default: 128\r
          Usually big number gives a little bit better compression ratio \r
          and slower compression process.\r
\r
  -lc{N}: set number of literal context bits - [0, 8], default: 3\r
          Sometimes lc=4 gives gain for big files.\r
\r
  -lp{N}: set number of literal pos bits - [0, 4], default: 0\r
          lp switch is intended for periodical data when period is \r
          equal 2^N. For example, for 32-bit (4 bytes) \r
          periodical data you can use lp=2. Often it's better to set lc0, \r
          if you change lp switch.\r
\r
  -pb{N}: set number of pos bits - [0, 4], default: 2\r
          pb switch is intended for periodical data \r
          when period is equal 2^N.\r
\r
  -mf{MF_ID}: set Match Finder. Default: bt4. \r
              Algorithms from hc* group doesn't provide good compression \r
              ratio, but they often works pretty fast in combination with \r
              fast mode (-a0).\r
\r
              Memory requirements depend from dictionary size \r
              (parameter "d" in table below). \r
\r
               MF_ID     Memory                   Description\r
\r
                bt2    d *  9.5 + 4MB  Binary Tree with 2 bytes hashing.\r
                bt3    d * 11.5 + 4MB  Binary Tree with 3 bytes hashing.\r
                bt4    d * 11.5 + 4MB  Binary Tree with 4 bytes hashing.\r
                hc4    d *  7.5 + 4MB  Hash Chain with 4 bytes hashing.\r
\r
  -eos:   write End Of Stream marker. By default LZMA doesn't write \r
          eos marker, since LZMA decoder knows uncompressed size \r
          stored in .lzma file header.\r
\r
  -si:    Read data from stdin (it will write End Of Stream marker).\r
  -so:    Write data to stdout\r
\r
\r
Examples:\r
\r
1) LZMA e file.bin file.lzma -d16 -lc0 \r
\r
compresses file.bin to file.lzma with 64 KB dictionary (2^16=64K)  \r
and 0 literal context bits. -lc0 allows to reduce memory requirements \r
for decompression.\r
\r
\r
2) LZMA e file.bin file.lzma -lc0 -lp2\r
\r
compresses file.bin to file.lzma with settings suitable \r
for 32-bit periodical data (for example, ARM or MIPS code).\r
\r
3) LZMA d file.lzma file.bin\r
\r
decompresses file.lzma to file.bin.\r
\r
\r
Compression ratio hints\r
-----------------------\r
\r
Recommendations\r
---------------\r
\r
To increase the compression ratio for LZMA compressing it's desirable \r
to have aligned data (if it's possible) and also it's desirable to locate\r
data in such order, where code is grouped in one place and data is \r
grouped in other place (it's better than such mixing: code, data, code,\r
data, ...).\r
\r
\r
Filters\r
-------\r
You can increase the compression ratio for some data types, using\r
special filters before compressing. For example, it's possible to \r
increase the compression ratio on 5-10% for code for those CPU ISAs: \r
x86, IA-64, ARM, ARM-Thumb, PowerPC, SPARC.\r
\r
You can find C source code of such filters in C/Bra*.* files\r
\r
You can check the compression ratio gain of these filters with such \r
7-Zip commands (example for ARM code):\r
No filter:\r
  7z a a1.7z a.bin -m0=lzma\r
\r
With filter for little-endian ARM code:\r
  7z a a2.7z a.bin -m0=arm -m1=lzma        \r
\r
It works in such manner:\r
Compressing    = Filter_encoding + LZMA_encoding\r
Decompressing  = LZMA_decoding + Filter_decoding\r
\r
Compressing and decompressing speed of such filters is very high,\r
so it will not increase decompressing time too much.\r
Moreover, it reduces decompression time for LZMA_decoding, \r
since compression ratio with filtering is higher.\r
\r
These filters convert CALL (calling procedure) instructions \r
from relative offsets to absolute addresses, so such data becomes more \r
compressible.\r
\r
For some ISAs (for example, for MIPS) it's impossible to get gain from such filter.\r
\r
\r
LZMA compressed file format\r
---------------------------\r
Offset Size Description\r
  0     1   Special LZMA properties (lc,lp, pb in encoded form)\r
  1     4   Dictionary size (little endian)\r
  5     8   Uncompressed size (little endian). -1 means unknown size\r
 13         Compressed data\r
\r
\r
ANSI-C LZMA Decoder\r
~~~~~~~~~~~~~~~~~~~\r
\r
Please note that interfaces for ANSI-C code were changed in LZMA SDK 4.58.\r
If you want to use old interfaces you can download previous version of LZMA SDK\r
from sourceforge.net site.\r
\r
To use ANSI-C LZMA Decoder you need the following files:\r
1) LzmaDec.h + LzmaDec.c + Types.h\r
LzmaUtil/LzmaUtil.c is example application that uses these files.\r
\r
\r
Memory requirements for LZMA decoding\r
-------------------------------------\r
\r
Stack usage of LZMA decoding function for local variables is not \r
larger than 200-400 bytes.\r
\r
LZMA Decoder uses dictionary buffer and internal state structure.\r
Internal state structure consumes\r
  state_size = (4 + (1.5 << (lc + lp))) KB\r
by default (lc=3, lp=0), state_size = 16 KB.\r
\r
\r
How To decompress data\r
----------------------\r
\r
LZMA Decoder (ANSI-C version) now supports 2 interfaces:\r
1) Single-call Decompressing\r
2) Multi-call State Decompressing (zlib-like interface)\r
\r
You must use external allocator:\r
Example:\r
void *SzAlloc(void *p, size_t size) { p = p; return malloc(size); }\r
void SzFree(void *p, void *address) { p = p; free(address); }\r
ISzAlloc alloc = { SzAlloc, SzFree };\r
\r
You can use p = p; operator to disable compiler warnings.\r
\r
\r
Single-call Decompressing\r
-------------------------\r
When to use: RAM->RAM decompressing\r
Compile files: LzmaDec.h + LzmaDec.c + Types.h\r
Compile defines: no defines\r
Memory Requirements:\r
  - Input buffer: compressed size\r
  - Output buffer: uncompressed size\r
  - LZMA Internal Structures: state_size (16 KB for default settings) \r
\r
Interface:\r
  int LzmaDecode(Byte *dest, SizeT *destLen, const Byte *src, SizeT *srcLen,\r
      const Byte *propData, unsigned propSize, ELzmaFinishMode finishMode, \r
      ELzmaStatus *status, ISzAlloc *alloc);\r
  In: \r
    dest     - output data\r
    destLen  - output data size\r
    src      - input data\r
    srcLen   - input data size\r
    propData - LZMA properties  (5 bytes)\r
    propSize - size of propData buffer (5 bytes)\r
    finishMode - It has meaning only if the decoding reaches output limit (*destLen).\r
	 LZMA_FINISH_ANY - Decode just destLen bytes.\r
	 LZMA_FINISH_END - Stream must be finished after (*destLen).\r
                           You can use LZMA_FINISH_END, when you know that \r
                           current output buffer covers last bytes of stream. \r
    alloc    - Memory allocator.\r
\r
  Out: \r
    destLen  - processed output size \r
    srcLen   - processed input size \r
\r
  Output:\r
    SZ_OK\r
      status:\r
        LZMA_STATUS_FINISHED_WITH_MARK\r
        LZMA_STATUS_NOT_FINISHED \r
        LZMA_STATUS_MAYBE_FINISHED_WITHOUT_MARK\r
    SZ_ERROR_DATA - Data error\r
    SZ_ERROR_MEM  - Memory allocation error\r
    SZ_ERROR_UNSUPPORTED - Unsupported properties\r
    SZ_ERROR_INPUT_EOF - It needs more bytes in input buffer (src).\r
\r
  If LZMA decoder sees end_marker before reaching output limit, it returns OK result,\r
  and output value of destLen will be less than output buffer size limit.\r
\r
  You can use multiple checks to test data integrity after full decompression:\r
    1) Check Result and "status" variable.\r
    2) Check that output(destLen) = uncompressedSize, if you know real uncompressedSize.\r
    3) Check that output(srcLen) = compressedSize, if you know real compressedSize. \r
       You must use correct finish mode in that case. */ \r
\r
\r
Multi-call State Decompressing (zlib-like interface)\r
----------------------------------------------------\r
\r
When to use: file->file decompressing \r
Compile files: LzmaDec.h + LzmaDec.c + Types.h\r
\r
Memory Requirements:\r
 - Buffer for input stream: any size (for example, 16 KB)\r
 - Buffer for output stream: any size (for example, 16 KB)\r
 - LZMA Internal Structures: state_size (16 KB for default settings) \r
 - LZMA dictionary (dictionary size is encoded in LZMA properties header)\r
\r
1) read LZMA properties (5 bytes) and uncompressed size (8 bytes, little-endian) to header:\r
   unsigned char header[LZMA_PROPS_SIZE + 8];\r
   ReadFile(inFile, header, sizeof(header)\r
\r
2) Allocate CLzmaDec structures (state + dictionary) using LZMA properties\r
\r
  CLzmaDec state;\r
  LzmaDec_Constr(&state);\r
  res = LzmaDec_Allocate(&state, header, LZMA_PROPS_SIZE, &g_Alloc);\r
  if (res != SZ_OK)\r
    return res;\r
\r
3) Init LzmaDec structure before any new LZMA stream. And call LzmaDec_DecodeToBuf in loop\r
\r
  LzmaDec_Init(&state);\r
  for (;;)\r
  {\r
    ... \r
    int res = LzmaDec_DecodeToBuf(CLzmaDec *p, Byte *dest, SizeT *destLen, \r
    	const Byte *src, SizeT *srcLen, ELzmaFinishMode finishMode);\r
    ...\r
  }\r
\r
\r
4) Free all allocated structures\r
  LzmaDec_Free(&state, &g_Alloc);\r
\r
For full code example, look at C/LzmaUtil/LzmaUtil.c code.\r
\r
\r
How To compress data\r
--------------------\r
\r
Compile files: LzmaEnc.h + LzmaEnc.c + Types.h +\r
LzFind.c + LzFind.h + LzFindMt.c + LzFindMt.h + LzHash.h\r
\r
Memory Requirements:\r
  - (dictSize * 11.5 + 6 MB) + state_size\r
\r
Lzma Encoder can use two memory allocators:\r
1) alloc - for small arrays.\r
2) allocBig - for big arrays.\r
\r
For example, you can use Large RAM Pages (2 MB) in allocBig allocator for \r
better compression speed. Note that Windows has bad implementation for \r
Large RAM Pages. \r
It's OK to use same allocator for alloc and allocBig.\r
\r
\r
Single-call Compression with callbacks\r
--------------------------------------\r
\r
Check C/LzmaUtil/LzmaUtil.c as example, \r
\r
When to use: file->file decompressing \r
\r
1) you must implement callback structures for interfaces:\r
ISeqInStream\r
ISeqOutStream\r
ICompressProgress\r
ISzAlloc\r
\r
static void *SzAlloc(void *p, size_t size) { p = p; return MyAlloc(size); }\r
static void SzFree(void *p, void *address) {  p = p; MyFree(address); }\r
static ISzAlloc g_Alloc = { SzAlloc, SzFree };\r
\r
  CFileSeqInStream inStream;\r
  CFileSeqOutStream outStream;\r
\r
  inStream.funcTable.Read = MyRead;\r
  inStream.file = inFile;\r
  outStream.funcTable.Write = MyWrite;\r
  outStream.file = outFile;\r
\r
\r
2) Create CLzmaEncHandle object;\r
\r
  CLzmaEncHandle enc;\r
\r
  enc = LzmaEnc_Create(&g_Alloc);\r
  if (enc == 0)\r
    return SZ_ERROR_MEM;\r
\r
\r
3) initialize CLzmaEncProps properties;\r
\r
  LzmaEncProps_Init(&props);\r
\r
  Then you can change some properties in that structure.\r
\r
4) Send LZMA properties to LZMA Encoder\r
\r
  res = LzmaEnc_SetProps(enc, &props);\r
\r
5) Write encoded properties to header\r
\r
    Byte header[LZMA_PROPS_SIZE + 8];\r
    size_t headerSize = LZMA_PROPS_SIZE;\r
    UInt64 fileSize;\r
    int i;\r
\r
    res = LzmaEnc_WriteProperties(enc, header, &headerSize);\r
    fileSize = MyGetFileLength(inFile);\r
    for (i = 0; i < 8; i++)\r
      header[headerSize++] = (Byte)(fileSize >> (8 * i));\r
    MyWriteFileAndCheck(outFile, header, headerSize)\r
\r
6) Call encoding function:\r
      res = LzmaEnc_Encode(enc, &outStream.funcTable, &inStream.funcTable, \r
        NULL, &g_Alloc, &g_Alloc);\r
\r
7) Destroy LZMA Encoder Object\r
  LzmaEnc_Destroy(enc, &g_Alloc, &g_Alloc);\r
\r
\r
If callback function return some error code, LzmaEnc_Encode also returns that code.\r
\r
\r
Single-call RAM->RAM Compression\r
--------------------------------\r
\r
Single-call RAM->RAM Compression is similar to Compression with callbacks,\r
but you provide pointers to buffers instead of pointers to stream callbacks:\r
\r
HRes LzmaEncode(Byte *dest, SizeT *destLen, const Byte *src, SizeT srcLen,\r
    CLzmaEncProps *props, Byte *propsEncoded, SizeT *propsSize, int writeEndMark, \r
    ICompressProgress *progress, ISzAlloc *alloc, ISzAlloc *allocBig);\r
\r
Return code:\r
  SZ_OK               - OK\r
  SZ_ERROR_MEM        - Memory allocation error \r
  SZ_ERROR_PARAM      - Incorrect paramater\r
  SZ_ERROR_OUTPUT_EOF - output buffer overflow\r
  SZ_ERROR_THREAD     - errors in multithreading functions (only for Mt version)\r
\r
\r
\r
LZMA Defines\r
------------\r
\r
_LZMA_SIZE_OPT - Enable some optimizations in LZMA Decoder to get smaller executable code.\r
\r
_LZMA_PROB32   - It can increase the speed on some 32-bit CPUs, but memory usage for \r
                 some structures will be doubled in that case.\r
\r
_LZMA_UINT32_IS_ULONG  - Define it if int is 16-bit on your compiler and long is 32-bit.\r
\r
_LZMA_NO_SYSTEM_SIZE_T  - Define it if you don't want to use size_t type.\r
\r
\r
C++ LZMA Encoder/Decoder \r
~~~~~~~~~~~~~~~~~~~~~~~~\r
C++ LZMA code use COM-like interfaces. So if you want to use it, \r
you can study basics of COM/OLE.\r
C++ LZMA code is just wrapper over ANSI-C code.\r
\r
\r
C++ Notes\r
~~~~~~~~~~~~~~~~~~~~~~~~\r
If you use some C++ code folders in 7-Zip (for example, C++ code for .7z handling),\r
you must check that you correctly work with "new" operator.\r
7-Zip can be compiled with MSVC 6.0 that doesn't throw "exception" from "new" operator.\r
So 7-Zip uses "CPP\Common\NewHandler.cpp" that redefines "new" operator:\r
operator new(size_t size)\r
{\r
  void *p = ::malloc(size);\r
  if (p == 0)\r
    throw CNewException();\r
  return p;\r
}\r
If you use MSCV that throws exception for "new" operator, you can compile without \r
"NewHandler.cpp". So standard exception will be used. Actually some code of \r
7-Zip catches any exception in internal code and converts it to HRESULT code.\r
So you don't need to catch CNewException, if you call COM interfaces of 7-Zip.\r
\r
---\r
\r
http://www.7-zip.org\r
http://www.7-zip.org/sdk.html\r
http://www.7-zip.org/support.html\r