courgette/courgette.h

   1 // Copyright 2011 The Chromium Authors
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef COURGETTE_COURGETTE_H_
   6 #define COURGETTE_COURGETTE_H_
   7
   8 #include <stddef.h>   // Required to define size_t on GCC
   9
  10 #include "base/files/file.h"
  11 #include "base/files/file_path.h"
  12
  13 namespace courgette {
  14
  15 // Status codes for Courgette APIs.
  16 //
  17 // Client code should only rely on the distintion between C_OK and the other
  18 // status codes.
  19 //
  20 enum Status {
  21   C_OK = 1,                       // Successful operation.
  22
  23   C_GENERAL_ERROR = 2,            // Error other than listed below.
  24
  25   C_READ_OPEN_ERROR = 3,          // Could not open input file for reading.
  26   C_READ_ERROR = 4,               // Could not read from opened input file.
  27
  28   C_WRITE_OPEN_ERROR = 3,         // Could not open output file for writing.
  29   C_WRITE_ERROR = 4,              // Could not write to opened output file.
  30
  31   C_BAD_ENSEMBLE_MAGIC = 5,       // Ensemble patch has bad magic.
  32   C_BAD_ENSEMBLE_VERSION = 6,     // Ensemble patch has wrong version.
  33   C_BAD_ENSEMBLE_HEADER = 7,      // Ensemble patch has corrupt header.
  34   C_BAD_ENSEMBLE_CRC = 8,         // Ensemble patch has corrupt data.
  35
  36   C_BAD_TRANSFORM = 12,           // Transform mis-specified.
  37   C_BAD_BASE = 13,                // Base for transform malformed.
  38
  39   C_BINARY_DIFF_CRC_ERROR = 14,   // Internal diff input doesn't have expected
  40                                   // CRC.
  41
  42   // Internal errors.
  43   C_STREAM_ERROR = 20,            // Unexpected error from streams.h.
  44   C_STREAM_NOT_CONSUMED = 21,     // Stream has extra data, is expected to be
  45                                   // used up.
  46   C_SERIALIZATION_FAILED = 22,    //
  47   C_DESERIALIZATION_FAILED = 23,  //
  48   C_INPUT_NOT_RECOGNIZED = 24,    // Unrecognized input (not an executable).
  49   C_DISASSEMBLY_FAILED = 25,      //
  50   C_ASSEMBLY_FAILED = 26,         //
  51   C_ADJUSTMENT_FAILED = 27,       //
  52 };
  53
  54 // What type of executable is something
  55 // This is part of the patch format. Never reuse an id number.
  56 enum ExecutableType {
  57   EXE_UNKNOWN = 0,
  58   EXE_WIN_32_X86 = 1,
  59   EXE_ELF_32_X86 = 2,
  60   // EXE_ELF_32_ARM_DEPRECATED = 3,  // DEPRECATED.
  61   EXE_WIN_32_X64 = 4,
  62 };
  63
  64 class SinkStream;
  65 class SinkStreamSet;
  66 class SourceStream;
  67
  68 class AssemblyProgram;
  69 class EncodedProgram;
  70
  71 // Applies the patch to the bytes in |old| and writes the transformed ensemble
  72 // to |output|.
  73 // Returns C_OK unless something went wrong.
  74 Status ApplyEnsemblePatch(SourceStream* old, SourceStream* patch,
  75                           SinkStream* output);
  76
  77 // Applies the patch in |patch_file| to the bytes in |old_file| and writes the
  78 // transformed ensemble to |new_file|.
  79 // Returns C_OK unless something went wrong.
  80 // This function first validates that the patch file has a proper header, so the
  81 // function can be used to 'try' a patch.
  82 Status ApplyEnsemblePatch(base::File old_file,
  83                           base::File patch_file,
  84                           base::File new_file);
  85
  86 // Applies the patch in |patch_file_name| to the bytes in |old_file_name| and
  87 // writes the transformed ensemble to |new_file_name|.
  88 // Returns C_OK unless something went wrong.
  89 // This function first validates that the patch file has a proper header, so the
  90 // function can be used to 'try' a patch.
  91 Status ApplyEnsemblePatch(const base::FilePath::CharType* old_file_name,
  92                           const base::FilePath::CharType* patch_file_name,
  93                           const base::FilePath::CharType* new_file_name);
  94
  95 // Generates a patch that will transform the bytes in |old| into the bytes in
  96 // |target|.
  97 // Returns C_OK unless something when wrong (unexpected).
  98 Status GenerateEnsemblePatch(SourceStream* old, SourceStream* target,
  99                              SinkStream* patch);
 100
 101 // Serializes |encoded| into the stream set.
 102 // Returns C_OK if succeeded, otherwise returns an error status.
 103 Status WriteEncodedProgram(EncodedProgram* encoded, SinkStreamSet* sink);
 104
 105 // Assembles |encoded|, emitting the bytes into |buffer|.
 106 // Returns C_OK if succeeded, otherwise returns an error status and leaves
 107 // |buffer| in an undefined state.
 108 Status Assemble(EncodedProgram* encoded, SinkStream* buffer);
 109
 110 // Adjusts |program| to look more like |model|.
 111 //
 112 Status Adjust(const AssemblyProgram& model, AssemblyProgram *program);
 113
 114 }  // namespace courgette
 115
 116 #endif  // COURGETTE_COURGETTE_H_