1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160
|
// Copyright (c) 2011 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef COURGETTE_ENCODED_PROGRAM_H_
#define COURGETTE_ENCODED_PROGRAM_H_
#include <stddef.h>
#include <stdint.h>
#include <memory>
#include <vector>
#include "base/macros.h"
#include "courgette/disassembler.h"
#include "courgette/label_manager.h"
#include "courgette/memory_allocator.h"
#include "courgette/types_elf.h"
namespace courgette {
// Stream indexes.
const int kStreamMisc = 0;
const int kStreamOps = 1;
const int kStreamBytes = 2;
const int kStreamAbs32Indexes = 3;
const int kStreamRel32Indexes = 4;
const int kStreamAbs32Addresses = 5;
const int kStreamRel32Addresses = 6;
const int kStreamCopyCounts = 7;
const int kStreamOriginAddresses = kStreamMisc;
const int kStreamLimit = 9;
class SinkStream;
class SinkStreamSet;
class SourceStreamSet;
// An EncodedProgram is a set of tables that contain a simple 'binary assembly
// language' that can be assembled to produce a sequence of bytes, for example,
// a Windows 32-bit executable.
//
class EncodedProgram {
public:
EncodedProgram();
~EncodedProgram();
// Generating an EncodedProgram:
//
// (1) The image base can be specified at any time.
void set_image_base(uint64_t base) { image_base_ = base; }
// (2) Address tables and indexes imported first.
CheckBool ImportLabels(const LabelManager& abs32_label_manager,
const LabelManager& rel32_label_manager)
WARN_UNUSED_RESULT;
// (3) Add instructions in the order needed to generate bytes of file.
// NOTE: If any of these methods ever fail, the EncodedProgram instance
// has failed and should be discarded.
CheckBool AddOrigin(RVA rva) WARN_UNUSED_RESULT;
CheckBool AddCopy(size_t count, const void* bytes) WARN_UNUSED_RESULT;
CheckBool AddRel32(int label_index) WARN_UNUSED_RESULT;
CheckBool AddRel32ARM(uint16_t op, int label_index) WARN_UNUSED_RESULT;
CheckBool AddAbs32(int label_index) WARN_UNUSED_RESULT;
CheckBool AddAbs64(int label_index) WARN_UNUSED_RESULT;
CheckBool AddPeMakeRelocs(ExecutableType kind) WARN_UNUSED_RESULT;
CheckBool AddElfMakeRelocs() WARN_UNUSED_RESULT;
CheckBool AddElfARMMakeRelocs() WARN_UNUSED_RESULT;
// (3) Serialize binary assembly language tables to a set of streams.
CheckBool WriteTo(SinkStreamSet* streams) WARN_UNUSED_RESULT;
// Using an EncodedProgram to generate a byte stream:
//
// (4) Deserializes a fresh EncodedProgram from a set of streams.
bool ReadFrom(SourceStreamSet* streams);
// (5) Assembles the 'binary assembly language' into final file.
CheckBool AssembleTo(SinkStream* buffer) WARN_UNUSED_RESULT;
private:
// Binary assembly language operations.
// These are part of the patch format. Reusing an existing value will
// break backwards compatibility.
enum OP {
ORIGIN = 0, // ORIGIN <rva> - set address for subsequent assembly.
COPY = 1, // COPY <count> <bytes> - copy bytes to output.
COPY1 = 2, // COPY1 <byte> - same as COPY 1 <byte>.
REL32 = 3, // REL32 <index> - emit rel32 encoded reference to address at
// address table offset <index>
ABS32 = 4, // ABS32 <index> - emit abs32 encoded reference to address at
// address table offset <index>
MAKE_PE_RELOCATION_TABLE = 5, // Emit PE base relocation table blocks.
MAKE_ELF_RELOCATION_TABLE = 6, // Emit Elf relocation table for X86
MAKE_ELF_ARM_RELOCATION_TABLE = 7, // Emit Elf relocation table for ARM
MAKE_PE64_RELOCATION_TABLE = 8, // Emit PE64 base relocation table blocks.
ABS64 = 9, // ABS64 <index> - emit abs64 encoded reference to address at
// address table offset <index>
// ARM reserves 0x1000-LAST_ARM, bits 13-16 define the opcode
// subset, and 1-12 are the compressed ARM op.
REL32ARM8 = 0x1000,
REL32ARM11 = 0x2000,
REL32ARM24 = 0x3000,
REL32ARM25 = 0x4000,
REL32ARM21 = 0x5000,
LAST_ARM = 0x5FFF,
};
typedef NoThrowBuffer<RVA> RvaVector;
typedef NoThrowBuffer<size_t> SizeTVector;
typedef NoThrowBuffer<uint32_t> UInt32Vector;
typedef NoThrowBuffer<uint8_t> UInt8Vector;
typedef NoThrowBuffer<OP> OPVector;
void DebuggingSummary();
// Helper for ImportLabels().
static CheckBool WriteRvasToList(const LabelManager& label_manager,
RvaVector* rvas);
// Helper for ImportLabels().
static void FillUnassignedRvaSlots(RvaVector* rvas);
CheckBool GeneratePeRelocations(SinkStream* buffer,
uint8_t type) WARN_UNUSED_RESULT;
CheckBool GenerateElfRelocations(Elf32_Word pending_elf_relocation_table,
SinkStream *buffer) WARN_UNUSED_RESULT;
// Decodes and evaluates courgette ops for ARM rel32 addresses.
CheckBool EvaluateRel32ARM(OP op, size_t& ix_rel32_ix, RVA& current_rva,
SinkStream* output);
// Binary assembly language tables.
uint64_t image_base_ = 0;
RvaVector rel32_rva_;
RvaVector abs32_rva_;
OPVector ops_;
RvaVector origins_;
SizeTVector copy_counts_;
UInt8Vector copy_bytes_;
UInt32Vector rel32_ix_;
UInt32Vector abs32_ix_;
// Table of the addresses containing abs32 relocations; computed during
// assembly, used to generate base relocation table.
UInt32Vector abs32_relocs_;
DISALLOW_COPY_AND_ASSIGN(EncodedProgram);
};
// Deserializes program from a stream set to |*output|. Returns C_OK if
// successful, otherwise assigns |*output| to null and returns an error status.
Status ReadEncodedProgram(SourceStreamSet* source,
std::unique_ptr<EncodedProgram>* output);
} // namespace courgette
#endif // COURGETTE_ENCODED_PROGRAM_H_
|