git.cworth.org Git - vogl/blob - src/voglcore/lzma_Bra.h

   1 /**************************************************************************
   2  *
   3  * Copyright 2013-2014 RAD Game Tools and Valve Software
   4  * Copyright 2010-2014 Rich Geldreich and Tenacious Software LLC
   5  * All Rights Reserved.
   6  *
   7  * Permission is hereby granted, free of charge, to any person obtaining a copy
   8  * of this software and associated documentation files (the "Software"), to deal
   9  * in the Software without restriction, including without limitation the rights
  10  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  11  * copies of the Software, and to permit persons to whom the Software is
  12  * furnished to do so, subject to the following conditions:
  13  *
  14  * The above copyright notice and this permission notice shall be included in
  15  * all copies or substantial portions of the Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  20  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  21  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  22  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  23  * THE SOFTWARE.
  24  *
  25  **************************************************************************/
  26
  27 /* Bra.h -- Branch converters for executables
  28 2008-10-04 : Igor Pavlov : Public domain */
  29
  30 #ifndef __BRA_H
  31 #define __BRA_H
  32
  33 #include "lzma_Types.h"
  34
  35 namespace vogl
  36 {
  37
  38 /*
  39 These functions convert relative addresses to absolute addresses
  40 in CALL instructions to increase the compression ratio.
  41
  42   In:
  43     data     - data buffer
  44     size     - size of data
  45     ip       - current virtual Instruction Pinter (IP) value
  46     state    - state variable for x86 converter
  47     encoding - 0 (for decoding), 1 (for encoding)
  48
  49   Out:
  50     state    - state variable for x86 converter
  51
  52   Returns:
  53     The number of processed bytes. If you call these functions with multiple calls,
  54     you must start next call with first byte after block of processed bytes.
  55
  56   Type   Endian  Alignment  LookAhead
  57
  58   x86    little      1          4
  59   ARMT   little      2          2
  60   ARM    little      4          0
  61   PPC     big        4          0
  62   SPARC   big        4          0
  63   IA64   little     16          0
  64
  65   size must be >= Alignment + LookAhead, if it's not last block.
  66   If (size < Alignment + LookAhead), converter returns 0.
  67
  68   Example:
  69
  70     UInt32 ip = 0;
  71     for ()
  72     {
  73       ; size must be >= Alignment + LookAhead, if it's not last block
  74       SizeT processed = Convert(data, size, ip, 1);
  75       data += processed;
  76       size -= processed;
  77       ip += processed;
  78     }
  79 */
  80
  81 #define x86_Convert_Init(state) \
  82     {                           \
  83         state = 0;              \
  84     }
  85     SizeT x86_Convert(Byte *data, SizeT size, UInt32 ip, UInt32 *state, int encoding);
  86     SizeT ARM_Convert(Byte *data, SizeT size, UInt32 ip, int encoding);
  87     SizeT ARMT_Convert(Byte *data, SizeT size, UInt32 ip, int encoding);
  88     SizeT PPC_Convert(Byte *data, SizeT size, UInt32 ip, int encoding);
  89     SizeT SPARC_Convert(Byte *data, SizeT size, UInt32 ip, int encoding);
  90     SizeT IA64_Convert(Byte *data, SizeT size, UInt32 ip, int encoding);
  91 }
  92
  93 #endif