MCFixup.h revision ce618af3e880ae0ec0ddd81aca8ed5bbd4096ae4 
1//===-- llvm/MC/MCFixup.h - Instruction Relocation and Patching -*- C++ -*-===//
2//
3//                     The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9
10#ifndef LLVM_MC_MCFIXUP_H
11#define LLVM_MC_MCFIXUP_H
12
13#include "llvm/Support/DataTypes.h"
14#include <cassert>
15
16namespace llvm {
17class MCExpr;
18
19/// MCFixupKind - Extensible enumeration to represent the type of a fixup.
20enum MCFixupKind {
21  FK_Data_1 = 0, ///< A one-byte fixup.
22  FK_Data_2,     ///< A two-byte fixup.
23  FK_Data_4,     ///< A four-byte fixup.
24  FK_Data_8,     ///< A eight-byte fixup.
25  FK_PCRel_1,    ///< A one-byte pc relative fixup.
26  FK_PCRel_2,    ///< A two-byte pc relative fixup.
27  FK_PCRel_4,    ///< A four-byte pc relative fixup.
28  FK_PCRel_8,    ///< A eight-byte pc relative fixup.
29  FK_GPRel_1,    ///< A one-byte gp relative fixup.
30  FK_GPRel_2,    ///< A two-byte gp relative fixup.
31  FK_GPRel_4,    ///< A four-byte gp relative fixup.
32  FK_GPRel_8,    ///< A eight-byte gp relative fixup.
33  FK_SecRel_1,   ///< A one-byte section relative fixup.
34  FK_SecRel_2,   ///< A two-byte section relative fixup.
35  FK_SecRel_4,   ///< A four-byte section relative fixup.
36  FK_SecRel_8,   ///< A eight-byte section relative fixup.
37
38  FirstTargetFixupKind = 128,
39
40  // Limit range of target fixups, in case we want to pack more efficiently
41  // later.
42  MaxTargetFixupKind = (1 << 8)
43};
44
45/// MCFixup - Encode information on a single operation to perform on a byte
46/// sequence (e.g., an encoded instruction) which requires assemble- or run-
47/// time patching.
48///
49/// Fixups are used any time the target instruction encoder needs to represent
50/// some value in an instruction which is not yet concrete. The encoder will
51/// encode the instruction assuming the value is 0, and emit a fixup which
52/// communicates to the assembler backend how it should rewrite the encoded
53/// value.
54///
55/// During the process of relaxation, the assembler will apply fixups as
56/// symbolic values become concrete. When relaxation is complete, any remaining
57/// fixups become relocations in the object file (or errors, if the fixup cannot
58/// be encoded on the target).
59class MCFixup {
60  /// The value to put into the fixup location. The exact interpretation of the
61  /// expression is target dependent, usually it will be one of the operands to
62  /// an instruction or an assembler directive.
63  const MCExpr *Value;
64
65  /// The byte index of start of the relocation inside the encoded instruction.
66  uint32_t Offset;
67
68  /// The target dependent kind of fixup item this is. The kind is used to
69  /// determine how the operand value should be encoded into the instruction.
70  unsigned Kind;
71
72public:
73  static MCFixup Create(uint32_t Offset, const MCExpr *Value,
74                        MCFixupKind Kind) {
75    assert(unsigned(Kind) < MaxTargetFixupKind && "Kind out of range!");
76    MCFixup FI;
77    FI.Value = Value;
78    FI.Offset = Offset;
79    FI.Kind = unsigned(Kind);
80    return FI;
81  }
82
83  MCFixupKind getKind() const { return MCFixupKind(Kind); }
84
85  uint32_t getOffset() const { return Offset; }
86  void setOffset(uint32_t Value) { Offset = Value; }
87
88  const MCExpr *getValue() const { return Value; }
89
90  /// getKindForSize - Return the generic fixup kind for a value with the given
91  /// size. It is an error to pass an unsupported size.
92  static MCFixupKind getKindForSize(unsigned Size, bool isPCRel) {
93    switch (Size) {
94    default: assert(0 && "Invalid generic fixup size!");
95    case 1: return isPCRel ? FK_PCRel_1 : FK_Data_1;
96    case 2: return isPCRel ? FK_PCRel_2 : FK_Data_2;
97    case 4: return isPCRel ? FK_PCRel_4 : FK_Data_4;
98    case 8: return isPCRel ? FK_PCRel_8 : FK_Data_8;
99    }
100  }
101};
102
103} // End llvm namespace
104
105#endif
106