1 // Copyright (c) 2011 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
5 #ifndef COURGETTE_ENCODED_PROGRAM_H_
6 #define COURGETTE_ENCODED_PROGRAM_H_
10 #include "base/basictypes.h"
11 #include "courgette/disassembler.h"
12 #include "courgette/memory_allocator.h"
13 #include "courgette/types_elf.h"
19 class SourceStreamSet
;
21 // An EncodedProgram is a set of tables that contain a simple 'binary assembly
22 // language' that can be assembled to produce a sequence of bytes, for example,
23 // a Windows 32-bit executable.
25 class EncodedProgram
{
30 // Generating an EncodedProgram:
32 // (1) The image base can be specified at any time.
33 void set_image_base(uint64 base
) { image_base_
= base
; }
35 // (2) Address tables and indexes defined first.
36 CheckBool
DefineRel32Label(int index
, RVA address
) WARN_UNUSED_RESULT
;
37 CheckBool
DefineAbs32Label(int index
, RVA address
) WARN_UNUSED_RESULT
;
40 // (3) Add instructions in the order needed to generate bytes of file.
41 // NOTE: If any of these methods ever fail, the EncodedProgram instance
42 // has failed and should be discarded.
43 CheckBool
AddOrigin(RVA rva
) WARN_UNUSED_RESULT
;
44 CheckBool
AddCopy(size_t count
, const void* bytes
) WARN_UNUSED_RESULT
;
45 CheckBool
AddRel32(int label_index
) WARN_UNUSED_RESULT
;
46 CheckBool
AddRel32ARM(uint16 op
, int label_index
) WARN_UNUSED_RESULT
;
47 CheckBool
AddAbs32(int label_index
) WARN_UNUSED_RESULT
;
48 CheckBool
AddPeMakeRelocs(ExecutableType kind
) WARN_UNUSED_RESULT
;
49 CheckBool
AddElfMakeRelocs() WARN_UNUSED_RESULT
;
50 CheckBool
AddElfARMMakeRelocs() WARN_UNUSED_RESULT
;
52 // (3) Serialize binary assembly language tables to a set of streams.
53 CheckBool
WriteTo(SinkStreamSet
* streams
) WARN_UNUSED_RESULT
;
55 // Using an EncodedProgram to generate a byte stream:
57 // (4) Deserializes a fresh EncodedProgram from a set of streams.
58 bool ReadFrom(SourceStreamSet
* streams
);
60 // (5) Assembles the 'binary assembly language' into final file.
61 CheckBool
AssembleTo(SinkStream
* buffer
) WARN_UNUSED_RESULT
;
64 // Binary assembly language operations.
65 // These are part of the patch format. Reusing an existing value will
66 // break backwards compatibility.
68 ORIGIN
= 0, // ORIGIN <rva> - set address for subsequent assembly.
69 COPY
= 1, // COPY <count> <bytes> - copy bytes to output.
70 COPY1
= 2, // COPY1 <byte> - same as COPY 1 <byte>.
71 REL32
= 3, // REL32 <index> - emit rel32 encoded reference to address at
72 // address table offset <index>
73 ABS32
= 4, // ABS32 <index> - emit abs32 encoded reference to address at
74 // address table offset <index>
75 MAKE_PE_RELOCATION_TABLE
= 5, // Emit PE base relocation table blocks.
76 MAKE_ELF_RELOCATION_TABLE
= 6, // Emit Elf relocation table for X86
77 MAKE_ELF_ARM_RELOCATION_TABLE
= 7, // Emit Elf relocation table for ARM
78 MAKE_PE64_RELOCATION_TABLE
= 8, // Emit PE64 base relocation table blocks.
79 // ARM reserves 0x1000-LAST_ARM, bits 13-16 define the opcode
80 // subset, and 1-12 are the compressed ARM op.
89 typedef NoThrowBuffer
<RVA
> RvaVector
;
90 typedef NoThrowBuffer
<size_t> SizeTVector
;
91 typedef NoThrowBuffer
<uint32
> UInt32Vector
;
92 typedef NoThrowBuffer
<uint8
> UInt8Vector
;
93 typedef NoThrowBuffer
<OP
> OPVector
;
95 void DebuggingSummary();
96 CheckBool
GeneratePeRelocations(SinkStream
*buffer
,
97 uint8 type
) WARN_UNUSED_RESULT
;
98 CheckBool
GenerateElfRelocations(Elf32_Word pending_elf_relocation_table
,
99 SinkStream
*buffer
) WARN_UNUSED_RESULT
;
100 CheckBool
DefineLabelCommon(RvaVector
*, int, RVA
) WARN_UNUSED_RESULT
;
101 void FinishLabelsCommon(RvaVector
* addresses
);
103 // Decodes and evaluates courgette ops for ARM rel32 addresses.
104 CheckBool
EvaluateRel32ARM(OP op
, size_t& ix_rel32_ix
, RVA
& current_rva
,
107 // Binary assembly language tables.
109 RvaVector rel32_rva_
;
110 RvaVector abs32_rva_
;
113 SizeTVector copy_counts_
;
114 UInt8Vector copy_bytes_
;
115 UInt32Vector rel32_ix_
;
116 UInt32Vector abs32_ix_
;
118 // Table of the addresses containing abs32 relocations; computed during
119 // assembly, used to generate base relocation table.
120 UInt32Vector abs32_relocs_
;
122 DISALLOW_COPY_AND_ASSIGN(EncodedProgram
);
125 } // namespace courgette
126 #endif // COURGETTE_ENCODED_PROGRAM_H_