third_party/bspatch/mbspatch.h

   1 /*-
   2  * Copyright 2003,2004 Colin Percival
   3  * All rights reserved
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted providing that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  15  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  16  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
  18  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  22  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
  23  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  24  * POSSIBILITY OF SUCH DAMAGE.
  25  *
  26  * Changelog:
  27  * 2005-04-26 - Define the header as a C structure, add a CRC32 checksum to
  28  *              the header, and make all the types 32-bit.
  29  *                --Benjamin Smedberg <benjamin@smedbergs.us>
  30  */
  31
  32 #ifndef bspatch_h__
  33 #define bspatch_h__
  34
  35 #define OK 0
  36 #define MEM_ERROR 1
  37 // #define IO_ERROR 2  // Use READ_ERROR or WRITE_ERROR instead
  38 #define USAGE_ERROR 3
  39 #define CRC_ERROR 4
  40 #define PARSE_ERROR 5
  41 #define READ_ERROR 6
  42 #define WRITE_ERROR 7
  43 #define UNEXPECTED_ERROR 8
  44
  45 typedef struct MBSPatchHeader_ {
  46   /* "MBDIFF10" */
  47   char tag[8];
  48
  49   /* Length of the file to be patched */
  50   unsigned int slen;
  51
  52   /* CRC32 of the file to be patched */
  53   unsigned int scrc32;
  54
  55   /* Length of the result file */
  56   unsigned int dlen;
  57
  58   /* Length of the control block in bytes */
  59   unsigned int cblen;
  60
  61   /* Length of the diff block in bytes */
  62   unsigned int difflen;
  63
  64   /* Length of the extra block in bytes */
  65   unsigned int extralen;
  66
  67   /* Control block (MBSPatchTriple[]) */
  68   /* Diff block (binary data) */
  69   /* Extra block (binary data) */
  70 } MBSPatchHeader;
  71
  72 /**
  73  * Read the header of a patch file into the MBSPatchHeader structure.
  74  *
  75  * @param fd Must have been opened for reading, and be at the beginning
  76  *           of the file.
  77  */
  78 int MBS_ReadHeader(int fd, MBSPatchHeader *header);
  79
  80 /**
  81  * Apply a patch. This method does not validate the checksum of the original
  82  * file: client code should validate the checksum before calling this method.
  83  *
  84  * @param patchfd Must have been processed by MBS_ReadHeader
  85  * @param fbuffer The original file read into a memory buffer of length
  86  *                header->slen.
  87  * @param filefd  Must have been opened for writing. Should be truncated
  88  *                to header->dlen if it is an existing file. The offset
  89  *                should be at the beginning of the file.
  90  */
  91 int MBS_ApplyPatch(const MBSPatchHeader *header, int patchfd,
  92                    unsigned char *fbuffer, int filefd);
  93
  94 typedef struct MBSPatchTriple_ {
  95   unsigned int x; /* add x bytes from oldfile to x bytes from the diff block */
  96   unsigned int y; /* copy y bytes from the extra block */
  97   int z; /* seek forwards in oldfile by z bytes */
  98 } MBSPatchTriple;
  99
 100 /**
 101  * Apply the given patch file to a given source file. This method validates
 102  * the CRC of the original file stored in the patch file, before applying the
 103  * patch to it.
 104  */
 105 int ApplyBinaryPatch(const wchar_t *old_file, const wchar_t *patch_file,
 106                      const wchar_t *new_file);
 107
 108 /**
 109   * Calculates Crc of the given buffer by calling CRC method in LZMA SDK
 110   */
 111 int CalculateCrc(const unsigned char *buf, int size);
 112 #endif  // bspatch_h__