MipsELFObjectWriter.cpp revision fc54d9e47a1276650f14f38e7d037c9b58c8dc2d 
1//===-- MipsELFObjectWriter.cpp - Mips ELF Writer -------------------------===//
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#include "MCTargetDesc/MipsBaseInfo.h"
11#include "MCTargetDesc/MipsFixupKinds.h"
12#include "MCTargetDesc/MipsMCTargetDesc.h"
13#include "llvm/MC/MCAssembler.h"
14#include "llvm/MC/MCELFObjectWriter.h"
15#include "llvm/MC/MCExpr.h"
16#include "llvm/MC/MCSection.h"
17#include "llvm/MC/MCValue.h"
18#include "llvm/Support/ErrorHandling.h"
19#include <list>
20
21using namespace llvm;
22
23namespace {
24  struct RelEntry {
25    RelEntry(const ELFRelocationEntry &R, const MCSymbol *S, int64_t O) :
26      Reloc(R), Sym(S), Offset(O) {}
27    ELFRelocationEntry Reloc;
28    const MCSymbol *Sym;
29    int64_t Offset;
30  };
31
32  typedef std::list<RelEntry> RelLs;
33  typedef RelLs::iterator RelLsIter;
34
35  class MipsELFObjectWriter : public MCELFObjectTargetWriter {
36  public:
37    MipsELFObjectWriter(bool _is64Bit, uint8_t OSABI, bool _isN64);
38
39    virtual ~MipsELFObjectWriter();
40
41    virtual unsigned GetRelocType(const MCValue &Target, const MCFixup &Fixup,
42                                  bool IsPCRel, bool IsRelocWithSymbol,
43                                  int64_t Addend) const;
44    virtual unsigned getEFlags() const;
45    virtual const MCSymbol *ExplicitRelSym(const MCAssembler &Asm,
46                                           const MCValue &Target,
47                                           const MCFragment &F,
48                                           const MCFixup &Fixup,
49                                           bool IsPCRel) const;
50    virtual void sortRelocs(const MCAssembler &Asm,
51                            std::vector<ELFRelocationEntry> &Relocs);
52  };
53}
54
55MipsELFObjectWriter::MipsELFObjectWriter(bool _is64Bit, uint8_t OSABI,
56                                         bool _isN64)
57  : MCELFObjectTargetWriter(_is64Bit, OSABI, ELF::EM_MIPS,
58                            /*HasRelocationAddend*/ false,
59                            /*IsN64*/ _isN64) {}
60
61MipsELFObjectWriter::~MipsELFObjectWriter() {}
62
63// FIXME: get the real EABI Version from the Subtarget class.
64unsigned MipsELFObjectWriter::getEFlags() const {
65
66  // FIXME: We can't tell if we are PIC (dynamic) or CPIC (static)
67  unsigned Flag = ELF::EF_MIPS_NOREORDER;
68
69  if (is64Bit())
70    Flag |= ELF::EF_MIPS_ARCH_64R2;
71  else
72    Flag |= ELF::EF_MIPS_ARCH_32R2;
73  return Flag;
74}
75
76const MCSymbol *MipsELFObjectWriter::ExplicitRelSym(const MCAssembler &Asm,
77                                                    const MCValue &Target,
78                                                    const MCFragment &F,
79                                                    const MCFixup &Fixup,
80                                                    bool IsPCRel) const {
81  assert(Target.getSymA() && "SymA cannot be 0.");
82  const MCSymbol &Sym = Target.getSymA()->getSymbol().AliasedSymbol();
83
84  if (Sym.getSection().getKind().isMergeableCString() ||
85      Sym.getSection().getKind().isMergeableConst())
86    return &Sym;
87
88  return NULL;
89}
90
91unsigned MipsELFObjectWriter::GetRelocType(const MCValue &Target,
92                                           const MCFixup &Fixup,
93                                           bool IsPCRel,
94                                           bool IsRelocWithSymbol,
95                                           int64_t Addend) const {
96  // determine the type of the relocation
97  unsigned Type = (unsigned)ELF::R_MIPS_NONE;
98  unsigned Kind = (unsigned)Fixup.getKind();
99
100  switch (Kind) {
101  default:
102    llvm_unreachable("invalid fixup kind!");
103  case FK_Data_4:
104    Type = ELF::R_MIPS_32;
105    break;
106  case FK_GPRel_4:
107    Type = ELF::R_MIPS_GPREL32;
108    break;
109  case Mips::fixup_Mips_GPREL16:
110    Type = ELF::R_MIPS_GPREL16;
111    break;
112  case Mips::fixup_Mips_26:
113    Type = ELF::R_MIPS_26;
114    break;
115  case Mips::fixup_Mips_CALL16:
116    Type = ELF::R_MIPS_CALL16;
117    break;
118  case Mips::fixup_Mips_GOT_Global:
119  case Mips::fixup_Mips_GOT_Local:
120    Type = ELF::R_MIPS_GOT16;
121    break;
122  case Mips::fixup_Mips_HI16:
123    Type = ELF::R_MIPS_HI16;
124    break;
125  case Mips::fixup_Mips_LO16:
126    Type = ELF::R_MIPS_LO16;
127    break;
128  case Mips::fixup_Mips_TLSGD:
129    Type = ELF::R_MIPS_TLS_GD;
130    break;
131  case Mips::fixup_Mips_GOTTPREL:
132    Type = ELF::R_MIPS_TLS_GOTTPREL;
133    break;
134  case Mips::fixup_Mips_TPREL_HI:
135    Type = ELF::R_MIPS_TLS_TPREL_HI16;
136    break;
137  case Mips::fixup_Mips_TPREL_LO:
138    Type = ELF::R_MIPS_TLS_TPREL_LO16;
139    break;
140  case Mips::fixup_Mips_TLSLDM:
141    Type = ELF::R_MIPS_TLS_LDM;
142    break;
143  case Mips::fixup_Mips_DTPREL_HI:
144    Type = ELF::R_MIPS_TLS_DTPREL_HI16;
145    break;
146  case Mips::fixup_Mips_DTPREL_LO:
147    Type = ELF::R_MIPS_TLS_DTPREL_LO16;
148    break;
149  case Mips::fixup_Mips_Branch_PCRel:
150  case Mips::fixup_Mips_PC16:
151    Type = ELF::R_MIPS_PC16;
152    break;
153  case Mips::fixup_Mips_GOT_PAGE:
154    Type = ELF::R_MIPS_GOT_PAGE;
155    break;
156  case Mips::fixup_Mips_GOT_OFST:
157    Type = ELF::R_MIPS_GOT_OFST;
158    break;
159  case Mips::fixup_Mips_GOT_DISP:
160    Type = ELF::R_MIPS_GOT_DISP;
161    break;
162  case Mips::fixup_Mips_GPOFF_HI:
163    Type = setRType((unsigned)ELF::R_MIPS_GPREL16, Type);
164    Type = setRType2((unsigned)ELF::R_MIPS_SUB, Type);
165    Type = setRType3((unsigned)ELF::R_MIPS_HI16, Type);
166    break;
167  case Mips::fixup_Mips_GPOFF_LO:
168    Type = setRType((unsigned)ELF::R_MIPS_GPREL16, Type);
169    Type = setRType2((unsigned)ELF::R_MIPS_SUB, Type);
170    Type = setRType3((unsigned)ELF::R_MIPS_LO16, Type);
171    break;
172  case Mips::fixup_Mips_HIGHER:
173    Type = ELF::R_MIPS_HIGHER;
174    break;
175  case Mips::fixup_Mips_HIGHEST:
176    Type = ELF::R_MIPS_HIGHEST;
177    break;
178  }
179  return Type;
180}
181
182// Return true if R is either a GOT16 against a local symbol or HI16.
183static bool NeedsMatchingLo(const MCAssembler &Asm, const RelEntry &R) {
184  if (!R.Sym)
185    return false;
186
187  MCSymbolData &SD = Asm.getSymbolData(R.Sym->AliasedSymbol());
188
189  return ((R.Reloc.Type == ELF::R_MIPS_GOT16) && !SD.isExternal()) ||
190    (R.Reloc.Type == ELF::R_MIPS_HI16);
191}
192
193static bool HasMatchingLo(const MCAssembler &Asm, RelLsIter I, RelLsIter Last) {
194  if (I == Last)
195    return false;
196
197  RelLsIter Hi = I++;
198
199  return (I->Reloc.Type == ELF::R_MIPS_LO16) && (Hi->Sym == I->Sym) &&
200    (Hi->Offset == I->Offset);
201}
202
203static bool HasSameSymbol(const RelEntry &R0, const RelEntry &R1) {
204  return R0.Sym == R1.Sym;
205}
206
207static int CompareOffset(const RelEntry &R0, const RelEntry &R1) {
208  return (R0.Offset > R1.Offset) ? 1 : ((R0.Offset == R1.Offset) ? 0 : -1);
209}
210
211void MipsELFObjectWriter::sortRelocs(const MCAssembler &Asm,
212                                     std::vector<ELFRelocationEntry> &Relocs) {
213  // Call the default function first. Relocations are sorted in descending
214  // order of r_offset.
215  MCELFObjectTargetWriter::sortRelocs(Asm, Relocs);
216
217  RelLs RelocLs;
218  std::vector<RelLsIter> Unmatched;
219
220  // Fill RelocLs. Traverse Relocs backwards so that relocations in RelocLs
221  // are in ascending order of r_offset.
222  for (std::vector<ELFRelocationEntry>::reverse_iterator R = Relocs.rbegin();
223       R != Relocs.rend(); ++R) {
224     std::pair<const MCSymbolRefExpr*, int64_t> P =
225       MipsGetSymAndOffset(*R->Fixup);
226     RelocLs.push_back(RelEntry(*R, P.first ? &P.first->getSymbol() : 0,
227                                P.second));
228  }
229
230  // Get list of unmatched HI16 and GOT16.
231  for (RelLsIter R = RelocLs.begin(); R != RelocLs.end(); ++R)
232    if (NeedsMatchingLo(Asm, *R) && !HasMatchingLo(Asm, R, --RelocLs.end()))
233      Unmatched.push_back(R);
234
235  // Insert unmatched HI16 and GOT16 immediately before their matching LO16.
236  for (std::vector<RelLsIter>::iterator U = Unmatched.begin();
237       U != Unmatched.end(); ++U) {
238    RelLsIter LoPos = RelocLs.end(), HiPos = *U;
239    bool MatchedLo = false;
240
241    for (RelLsIter R = RelocLs.begin(); R != RelocLs.end(); ++R) {
242      if ((R->Reloc.Type == ELF::R_MIPS_LO16) && HasSameSymbol(*HiPos, *R) &&
243          (CompareOffset(*R, *HiPos) >= 0) &&
244          ((LoPos == RelocLs.end()) || ((CompareOffset(*R, *LoPos) < 0)) ||
245           (!MatchedLo && !CompareOffset(*R, *LoPos))))
246        LoPos = R;
247
248      MatchedLo = NeedsMatchingLo(Asm, *R) &&
249        HasMatchingLo(Asm, R, --RelocLs.end());
250    }
251
252    // If a matching LoPos was found, move HiPos and insert it before LoPos.
253    // Make the offsets of HiPos and LoPos match.
254    if (LoPos != RelocLs.end()) {
255      HiPos->Offset = LoPos->Offset;
256      RelocLs.insert(LoPos, *HiPos);
257      RelocLs.erase(HiPos);
258    }
259  }
260
261  // Put the sorted list back in reverse order.
262  assert(Relocs.size() == RelocLs.size());
263  unsigned I = RelocLs.size();
264
265  for (RelLsIter R = RelocLs.begin(); R != RelocLs.end(); ++R)
266    Relocs[--I] = R->Reloc;
267}
268
269MCObjectWriter *llvm::createMipsELFObjectWriter(raw_ostream &OS,
270                                                uint8_t OSABI,
271                                                bool IsLittleEndian,
272                                                bool Is64Bit) {
273  MCELFObjectTargetWriter *MOTW = new MipsELFObjectWriter(Is64Bit, OSABI,
274                                                (Is64Bit) ? true : false);
275  return createELFObjectWriter(MOTW, OS, IsLittleEndian);
276}
277