xref: /llvm-project/llvm/lib/Target/Mips/MCTargetDesc/MipsELFObjectWriter.cpp (revision dcb312bdb9616c19f1e58afc9d06b49f81f648e8)
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/MipsFixupKinds.h"
11 #include "MCTargetDesc/MipsMCTargetDesc.h"
12 #include "llvm/ADT/STLExtras.h"
13 #include "llvm/BinaryFormat/ELF.h"
14 #include "llvm/MC/MCELFObjectWriter.h"
15 #include "llvm/MC/MCFixup.h"
16 #include "llvm/MC/MCSymbolELF.h"
17 #include "llvm/Support/Casting.h"
18 #include "llvm/Support/Compiler.h"
19 #include "llvm/Support/Debug.h"
20 #include "llvm/Support/ErrorHandling.h"
21 #include "llvm/Support/MathExtras.h"
22 #include "llvm/Support/raw_ostream.h"
23 #include <algorithm>
24 #include <cassert>
25 #include <cstdint>
26 #include <iterator>
27 #include <list>
28 #include <utility>
29 
30 #define DEBUG_TYPE "mips-elf-object-writer"
31 
32 using namespace llvm;
33 
34 namespace {
35 
36 /// Holds additional information needed by the relocation ordering algorithm.
37 struct MipsRelocationEntry {
38   const ELFRelocationEntry R; ///< The relocation.
39   bool Matched = false;       ///< Is this relocation part of a match.
40 
41   MipsRelocationEntry(const ELFRelocationEntry &R) : R(R) {}
42 
43   void print(raw_ostream &Out) const {
44     R.print(Out);
45     Out << ", Matched=" << Matched;
46   }
47 };
48 
49 #ifndef NDEBUG
50 raw_ostream &operator<<(raw_ostream &OS, const MipsRelocationEntry &RHS) {
51   RHS.print(OS);
52   return OS;
53 }
54 #endif
55 
56 class MipsELFObjectWriter : public MCELFObjectTargetWriter {
57 public:
58   MipsELFObjectWriter(uint8_t OSABI, bool HasRelocationAddend, bool Is64,
59                       bool IsLittleEndian);
60 
61   ~MipsELFObjectWriter() override = default;
62 
63   unsigned getRelocType(MCContext &Ctx, const MCValue &Target,
64                         const MCFixup &Fixup, bool IsPCRel) const override;
65   bool needsRelocateWithSymbol(const MCSymbol &Sym,
66                                unsigned Type) const override;
67   void sortRelocs(const MCAssembler &Asm,
68                   std::vector<ELFRelocationEntry> &Relocs) override;
69 };
70 
71 /// The possible results of the Predicate function used by find_best.
72 enum FindBestPredicateResult {
73   FindBest_NoMatch = 0,  ///< The current element is not a match.
74   FindBest_Match,        ///< The current element is a match but better ones are
75                          ///  possible.
76   FindBest_PerfectMatch, ///< The current element is an unbeatable match.
77 };
78 
79 } // end anonymous namespace
80 
81 /// Copy elements in the range [First, Last) to d1 when the predicate is true or
82 /// d2 when the predicate is false. This is essentially both std::copy_if and
83 /// std::remove_copy_if combined into a single pass.
84 template <class InputIt, class OutputIt1, class OutputIt2, class UnaryPredicate>
85 static std::pair<OutputIt1, OutputIt2> copy_if_else(InputIt First, InputIt Last,
86                                                     OutputIt1 d1, OutputIt2 d2,
87                                                     UnaryPredicate Predicate) {
88   for (InputIt I = First; I != Last; ++I) {
89     if (Predicate(*I)) {
90       *d1 = *I;
91       d1++;
92     } else {
93       *d2 = *I;
94       d2++;
95     }
96   }
97 
98   return std::make_pair(d1, d2);
99 }
100 
101 /// Find the best match in the range [First, Last).
102 ///
103 /// An element matches when Predicate(X) returns FindBest_Match or
104 /// FindBest_PerfectMatch. A value of FindBest_PerfectMatch also terminates
105 /// the search. BetterThan(A, B) is a comparator that returns true when A is a
106 /// better match than B. The return value is the position of the best match.
107 ///
108 /// This is similar to std::find_if but finds the best of multiple possible
109 /// matches.
110 template <class InputIt, class UnaryPredicate, class Comparator>
111 static InputIt find_best(InputIt First, InputIt Last, UnaryPredicate Predicate,
112                          Comparator BetterThan) {
113   InputIt Best = Last;
114 
115   for (InputIt I = First; I != Last; ++I) {
116     unsigned Matched = Predicate(*I);
117     if (Matched != FindBest_NoMatch) {
118       DEBUG(dbgs() << std::distance(First, I) << " is a match (";
119             I->print(dbgs()); dbgs() << ")\n");
120       if (Best == Last || BetterThan(*I, *Best)) {
121         DEBUG(dbgs() << ".. and it beats the last one\n");
122         Best = I;
123       }
124     }
125     if (Matched == FindBest_PerfectMatch) {
126       DEBUG(dbgs() << ".. and it is unbeatable\n");
127       break;
128     }
129   }
130 
131   return Best;
132 }
133 
134 /// Determine the low relocation that matches the given relocation.
135 /// If the relocation does not need a low relocation then the return value
136 /// is ELF::R_MIPS_NONE.
137 ///
138 /// The relocations that need a matching low part are
139 /// R_(MIPS|MICROMIPS|MIPS16)_HI16 for all symbols and
140 /// R_(MIPS|MICROMIPS|MIPS16)_GOT16 for local symbols only.
141 static unsigned getMatchingLoType(const ELFRelocationEntry &Reloc) {
142   unsigned Type = Reloc.Type;
143   if (Type == ELF::R_MIPS_HI16)
144     return ELF::R_MIPS_LO16;
145   if (Type == ELF::R_MICROMIPS_HI16)
146     return ELF::R_MICROMIPS_LO16;
147   if (Type == ELF::R_MIPS16_HI16)
148     return ELF::R_MIPS16_LO16;
149 
150   if (Reloc.OriginalSymbol->getBinding() != ELF::STB_LOCAL)
151     return ELF::R_MIPS_NONE;
152 
153   if (Type == ELF::R_MIPS_GOT16)
154     return ELF::R_MIPS_LO16;
155   if (Type == ELF::R_MICROMIPS_GOT16)
156     return ELF::R_MICROMIPS_LO16;
157   if (Type == ELF::R_MIPS16_GOT16)
158     return ELF::R_MIPS16_LO16;
159 
160   return ELF::R_MIPS_NONE;
161 }
162 
163 /// Determine whether a relocation (X) matches the one given in R.
164 ///
165 /// A relocation matches if:
166 /// - It's type matches that of a corresponding low part. This is provided in
167 ///   MatchingType for efficiency.
168 /// - It's based on the same symbol.
169 /// - It's offset of greater or equal to that of the one given in R.
170 ///   It should be noted that this rule assumes the programmer does not use
171 ///   offsets that exceed the alignment of the symbol. The carry-bit will be
172 ///   incorrect if this is not true.
173 ///
174 /// A matching relocation is unbeatable if:
175 /// - It is not already involved in a match.
176 /// - It's offset is exactly that of the one given in R.
177 static FindBestPredicateResult isMatchingReloc(const MipsRelocationEntry &X,
178                                                const ELFRelocationEntry &R,
179                                                unsigned MatchingType) {
180   if (X.R.Type == MatchingType && X.R.OriginalSymbol == R.OriginalSymbol) {
181     if (!X.Matched &&
182         X.R.OriginalAddend == R.OriginalAddend)
183       return FindBest_PerfectMatch;
184     else if (X.R.OriginalAddend >= R.OriginalAddend)
185       return FindBest_Match;
186   }
187   return FindBest_NoMatch;
188 }
189 
190 /// Determine whether Candidate or PreviousBest is the better match.
191 /// The return value is true if Candidate is the better match.
192 ///
193 /// A matching relocation is a better match if:
194 /// - It has a smaller addend.
195 /// - It is not already involved in a match.
196 static bool compareMatchingRelocs(const MipsRelocationEntry &Candidate,
197                                   const MipsRelocationEntry &PreviousBest) {
198   if (Candidate.R.OriginalAddend != PreviousBest.R.OriginalAddend)
199     return Candidate.R.OriginalAddend < PreviousBest.R.OriginalAddend;
200   return PreviousBest.Matched && !Candidate.Matched;
201 }
202 
203 #ifndef NDEBUG
204 /// Print all the relocations.
205 template <class Container>
206 static void dumpRelocs(const char *Prefix, const Container &Relocs) {
207   for (const auto &R : Relocs)
208     dbgs() << Prefix << R << "\n";
209 }
210 #endif
211 
212 MipsELFObjectWriter::MipsELFObjectWriter(uint8_t OSABI,
213                                          bool HasRelocationAddend, bool Is64,
214                                          bool IsLittleEndian)
215     : MCELFObjectTargetWriter(Is64, OSABI, ELF::EM_MIPS, HasRelocationAddend) {}
216 
217 unsigned MipsELFObjectWriter::getRelocType(MCContext &Ctx,
218                                            const MCValue &Target,
219                                            const MCFixup &Fixup,
220                                            bool IsPCRel) const {
221   // Determine the type of the relocation.
222   unsigned Kind = (unsigned)Fixup.getKind();
223 
224   switch (Kind) {
225   case Mips::fixup_Mips_NONE:
226     return ELF::R_MIPS_NONE;
227   case Mips::fixup_Mips_16:
228   case FK_Data_2:
229     return IsPCRel ? ELF::R_MIPS_PC16 : ELF::R_MIPS_16;
230   case Mips::fixup_Mips_32:
231   case FK_Data_4:
232     return IsPCRel ? ELF::R_MIPS_PC32 : ELF::R_MIPS_32;
233   }
234 
235   if (IsPCRel) {
236     switch (Kind) {
237     case Mips::fixup_Mips_Branch_PCRel:
238     case Mips::fixup_Mips_PC16:
239       return ELF::R_MIPS_PC16;
240     case Mips::fixup_MICROMIPS_PC7_S1:
241       return ELF::R_MICROMIPS_PC7_S1;
242     case Mips::fixup_MICROMIPS_PC10_S1:
243       return ELF::R_MICROMIPS_PC10_S1;
244     case Mips::fixup_MICROMIPS_PC16_S1:
245       return ELF::R_MICROMIPS_PC16_S1;
246     case Mips::fixup_MICROMIPS_PC26_S1:
247       return ELF::R_MICROMIPS_PC26_S1;
248     case Mips::fixup_MICROMIPS_PC19_S2:
249       return ELF::R_MICROMIPS_PC19_S2;
250     case Mips::fixup_MICROMIPS_PC18_S3:
251       return ELF::R_MICROMIPS_PC18_S3;
252     case Mips::fixup_MICROMIPS_PC21_S1:
253       return ELF::R_MICROMIPS_PC21_S1;
254     case Mips::fixup_MIPS_PC19_S2:
255       return ELF::R_MIPS_PC19_S2;
256     case Mips::fixup_MIPS_PC18_S3:
257       return ELF::R_MIPS_PC18_S3;
258     case Mips::fixup_MIPS_PC21_S2:
259       return ELF::R_MIPS_PC21_S2;
260     case Mips::fixup_MIPS_PC26_S2:
261       return ELF::R_MIPS_PC26_S2;
262     case Mips::fixup_MIPS_PCHI16:
263       return ELF::R_MIPS_PCHI16;
264     case Mips::fixup_MIPS_PCLO16:
265       return ELF::R_MIPS_PCLO16;
266     }
267 
268     llvm_unreachable("invalid PC-relative fixup kind!");
269   }
270 
271   switch (Kind) {
272   case Mips::fixup_Mips_64:
273   case FK_Data_8:
274     return ELF::R_MIPS_64;
275   case FK_DTPRel_4:
276     return ELF::R_MIPS_TLS_DTPREL32;
277   case FK_DTPRel_8:
278     return ELF::R_MIPS_TLS_DTPREL64;
279   case FK_TPRel_4:
280     return ELF::R_MIPS_TLS_TPREL32;
281   case FK_TPRel_8:
282     return ELF::R_MIPS_TLS_TPREL64;
283   case FK_GPRel_4:
284     if (is64Bit()) {
285       unsigned Type = (unsigned)ELF::R_MIPS_NONE;
286       Type = setRType((unsigned)ELF::R_MIPS_GPREL32, Type);
287       Type = setRType2((unsigned)ELF::R_MIPS_64, Type);
288       Type = setRType3((unsigned)ELF::R_MIPS_NONE, Type);
289       return Type;
290     }
291     return ELF::R_MIPS_GPREL32;
292   case Mips::fixup_Mips_GPREL16:
293     return ELF::R_MIPS_GPREL16;
294   case Mips::fixup_Mips_26:
295     return ELF::R_MIPS_26;
296   case Mips::fixup_Mips_CALL16:
297     return ELF::R_MIPS_CALL16;
298   case Mips::fixup_Mips_GOT:
299     return ELF::R_MIPS_GOT16;
300   case Mips::fixup_Mips_HI16:
301     return ELF::R_MIPS_HI16;
302   case Mips::fixup_Mips_LO16:
303     return ELF::R_MIPS_LO16;
304   case Mips::fixup_Mips_TLSGD:
305     return ELF::R_MIPS_TLS_GD;
306   case Mips::fixup_Mips_GOTTPREL:
307     return ELF::R_MIPS_TLS_GOTTPREL;
308   case Mips::fixup_Mips_TPREL_HI:
309     return ELF::R_MIPS_TLS_TPREL_HI16;
310   case Mips::fixup_Mips_TPREL_LO:
311     return ELF::R_MIPS_TLS_TPREL_LO16;
312   case Mips::fixup_Mips_TLSLDM:
313     return ELF::R_MIPS_TLS_LDM;
314   case Mips::fixup_Mips_DTPREL_HI:
315     return ELF::R_MIPS_TLS_DTPREL_HI16;
316   case Mips::fixup_Mips_DTPREL_LO:
317     return ELF::R_MIPS_TLS_DTPREL_LO16;
318   case Mips::fixup_Mips_GOT_PAGE:
319     return ELF::R_MIPS_GOT_PAGE;
320   case Mips::fixup_Mips_GOT_OFST:
321     return ELF::R_MIPS_GOT_OFST;
322   case Mips::fixup_Mips_GOT_DISP:
323     return ELF::R_MIPS_GOT_DISP;
324   case Mips::fixup_Mips_GPOFF_HI: {
325     unsigned Type = (unsigned)ELF::R_MIPS_NONE;
326     Type = setRType((unsigned)ELF::R_MIPS_GPREL16, Type);
327     Type = setRType2((unsigned)ELF::R_MIPS_SUB, Type);
328     Type = setRType3((unsigned)ELF::R_MIPS_HI16, Type);
329     return Type;
330   }
331   case Mips::fixup_Mips_GPOFF_LO: {
332     unsigned Type = (unsigned)ELF::R_MIPS_NONE;
333     Type = setRType((unsigned)ELF::R_MIPS_GPREL16, Type);
334     Type = setRType2((unsigned)ELF::R_MIPS_SUB, Type);
335     Type = setRType3((unsigned)ELF::R_MIPS_LO16, Type);
336     return Type;
337   }
338   case Mips::fixup_Mips_HIGHER:
339     return ELF::R_MIPS_HIGHER;
340   case Mips::fixup_Mips_HIGHEST:
341     return ELF::R_MIPS_HIGHEST;
342   case Mips::fixup_Mips_SUB:
343     return ELF::R_MIPS_SUB;
344   case Mips::fixup_Mips_GOT_HI16:
345     return ELF::R_MIPS_GOT_HI16;
346   case Mips::fixup_Mips_GOT_LO16:
347     return ELF::R_MIPS_GOT_LO16;
348   case Mips::fixup_Mips_CALL_HI16:
349     return ELF::R_MIPS_CALL_HI16;
350   case Mips::fixup_Mips_CALL_LO16:
351     return ELF::R_MIPS_CALL_LO16;
352   case Mips::fixup_MICROMIPS_26_S1:
353     return ELF::R_MICROMIPS_26_S1;
354   case Mips::fixup_MICROMIPS_HI16:
355     return ELF::R_MICROMIPS_HI16;
356   case Mips::fixup_MICROMIPS_LO16:
357     return ELF::R_MICROMIPS_LO16;
358   case Mips::fixup_MICROMIPS_GOT16:
359     return ELF::R_MICROMIPS_GOT16;
360   case Mips::fixup_MICROMIPS_CALL16:
361     return ELF::R_MICROMIPS_CALL16;
362   case Mips::fixup_MICROMIPS_GOT_DISP:
363     return ELF::R_MICROMIPS_GOT_DISP;
364   case Mips::fixup_MICROMIPS_GOT_PAGE:
365     return ELF::R_MICROMIPS_GOT_PAGE;
366   case Mips::fixup_MICROMIPS_GOT_OFST:
367     return ELF::R_MICROMIPS_GOT_OFST;
368   case Mips::fixup_MICROMIPS_TLS_GD:
369     return ELF::R_MICROMIPS_TLS_GD;
370   case Mips::fixup_MICROMIPS_TLS_LDM:
371     return ELF::R_MICROMIPS_TLS_LDM;
372   case Mips::fixup_MICROMIPS_TLS_DTPREL_HI16:
373     return ELF::R_MICROMIPS_TLS_DTPREL_HI16;
374   case Mips::fixup_MICROMIPS_TLS_DTPREL_LO16:
375     return ELF::R_MICROMIPS_TLS_DTPREL_LO16;
376   case Mips::fixup_MICROMIPS_GOTTPREL:
377     return ELF::R_MICROMIPS_TLS_GOTTPREL;
378   case Mips::fixup_MICROMIPS_TLS_TPREL_HI16:
379     return ELF::R_MICROMIPS_TLS_TPREL_HI16;
380   case Mips::fixup_MICROMIPS_TLS_TPREL_LO16:
381     return ELF::R_MICROMIPS_TLS_TPREL_LO16;
382   case Mips::fixup_MICROMIPS_SUB:
383     return ELF::R_MICROMIPS_SUB;
384   }
385 
386   llvm_unreachable("invalid fixup kind!");
387 }
388 
389 /// Sort relocation table entries by offset except where another order is
390 /// required by the MIPS ABI.
391 ///
392 /// MIPS has a few relocations that have an AHL component in the expression used
393 /// to evaluate them. This AHL component is an addend with the same number of
394 /// bits as a symbol value but not all of our ABI's are able to supply a
395 /// sufficiently sized addend in a single relocation.
396 ///
397 /// The O32 ABI for example, uses REL relocations which store the addend in the
398 /// section data. All the relocations with AHL components affect 16-bit fields
399 /// so the addend for a single relocation is limited to 16-bit. This ABI
400 /// resolves the limitation by linking relocations (e.g. R_MIPS_HI16 and
401 /// R_MIPS_LO16) and distributing the addend between the linked relocations. The
402 /// ABI mandates that such relocations must be next to each other in a
403 /// particular order (e.g. R_MIPS_HI16 must be immediately followed by a
404 /// matching R_MIPS_LO16) but the rule is less strict in practice.
405 ///
406 /// The de facto standard is lenient in the following ways:
407 /// - 'Immediately following' does not refer to the next relocation entry but
408 ///   the next matching relocation.
409 /// - There may be multiple high parts relocations for one low part relocation.
410 /// - There may be multiple low part relocations for one high part relocation.
411 /// - The AHL addend in each part does not have to be exactly equal as long as
412 ///   the difference does not affect the carry bit from bit 15 into 16. This is
413 ///   to allow, for example, the use of %lo(foo) and %lo(foo+4) when loading
414 ///   both halves of a long long.
415 ///
416 /// See getMatchingLoType() for a description of which high part relocations
417 /// match which low part relocations. One particular thing to note is that
418 /// R_MIPS_GOT16 and similar only have AHL addends if they refer to local
419 /// symbols.
420 ///
421 /// It should also be noted that this function is not affected by whether
422 /// the symbol was kept or rewritten into a section-relative equivalent. We
423 /// always match using the expressions from the source.
424 void MipsELFObjectWriter::sortRelocs(const MCAssembler &Asm,
425                                      std::vector<ELFRelocationEntry> &Relocs) {
426   // We do not need to sort the relocation table for RELA relocations which
427   // N32/N64 uses as the relocation addend contains the value we require,
428   // rather than it being split across a pair of relocations.
429   if (hasRelocationAddend())
430     return;
431 
432   if (Relocs.size() < 2)
433     return;
434 
435   // Sort relocations by the address they are applied to.
436   std::sort(Relocs.begin(), Relocs.end(),
437             [](const ELFRelocationEntry &A, const ELFRelocationEntry &B) {
438               return A.Offset < B.Offset;
439             });
440 
441   std::list<MipsRelocationEntry> Sorted;
442   std::list<ELFRelocationEntry> Remainder;
443 
444   DEBUG(dumpRelocs("R: ", Relocs));
445 
446   // Separate the movable relocations (AHL relocations using the high bits) from
447   // the immobile relocations (everything else). This does not preserve high/low
448   // matches that already existed in the input.
449   copy_if_else(Relocs.begin(), Relocs.end(), std::back_inserter(Remainder),
450                std::back_inserter(Sorted), [](const ELFRelocationEntry &Reloc) {
451                  return getMatchingLoType(Reloc) != ELF::R_MIPS_NONE;
452                });
453 
454   for (auto &R : Remainder) {
455     DEBUG(dbgs() << "Matching: " << R << "\n");
456 
457     unsigned MatchingType = getMatchingLoType(R);
458     assert(MatchingType != ELF::R_MIPS_NONE &&
459            "Wrong list for reloc that doesn't need a match");
460 
461     // Find the best matching relocation for the current high part.
462     // See isMatchingReloc for a description of a matching relocation and
463     // compareMatchingRelocs for a description of what 'best' means.
464     auto InsertionPoint =
465         find_best(Sorted.begin(), Sorted.end(),
466                   [&R, &MatchingType](const MipsRelocationEntry &X) {
467                     return isMatchingReloc(X, R, MatchingType);
468                   },
469                   compareMatchingRelocs);
470 
471     // If we matched then insert the high part in front of the match and mark
472     // both relocations as being involved in a match. We only mark the high
473     // part for cosmetic reasons in the debug output.
474     //
475     // If we failed to find a match then the high part is orphaned. This is not
476     // permitted since the relocation cannot be evaluated without knowing the
477     // carry-in. We can sometimes handle this using a matching low part that is
478     // already used in a match but we already cover that case in
479     // isMatchingReloc and compareMatchingRelocs. For the remaining cases we
480     // should insert the high part at the end of the list. This will cause the
481     // linker to fail but the alternative is to cause the linker to bind the
482     // high part to a semi-matching low part and silently calculate the wrong
483     // value. Unfortunately we have no means to warn the user that we did this
484     // so leave it up to the linker to complain about it.
485     if (InsertionPoint != Sorted.end())
486       InsertionPoint->Matched = true;
487     Sorted.insert(InsertionPoint, R)->Matched = true;
488   }
489 
490   DEBUG(dumpRelocs("S: ", Sorted));
491 
492   assert(Relocs.size() == Sorted.size() && "Some relocs were not consumed");
493 
494   // Overwrite the original vector with the sorted elements. The caller expects
495   // them in reverse order.
496   unsigned CopyTo = 0;
497   for (const auto &R : reverse(Sorted))
498     Relocs[CopyTo++] = R.R;
499 }
500 
501 bool MipsELFObjectWriter::needsRelocateWithSymbol(const MCSymbol &Sym,
502                                                   unsigned Type) const {
503   // If it's a compound relocation for N64 then we need the relocation if any
504   // sub-relocation needs it.
505   if (!isUInt<8>(Type))
506     return needsRelocateWithSymbol(Sym, Type & 0xff) ||
507            needsRelocateWithSymbol(Sym, (Type >> 8) & 0xff) ||
508            needsRelocateWithSymbol(Sym, (Type >> 16) & 0xff);
509 
510   switch (Type) {
511   default:
512     errs() << Type << "\n";
513     llvm_unreachable("Unexpected relocation");
514     return true;
515 
516   // This relocation doesn't affect the section data.
517   case ELF::R_MIPS_NONE:
518     return false;
519 
520   // On REL ABI's (e.g. O32), these relocations form pairs. The pairing is done
521   // by the static linker by matching the symbol and offset.
522   // We only see one relocation at a time but it's still safe to relocate with
523   // the section so long as both relocations make the same decision.
524   //
525   // Some older linkers may require the symbol for particular cases. Such cases
526   // are not supported yet but can be added as required.
527   case ELF::R_MIPS_GOT16:
528   case ELF::R_MIPS16_GOT16:
529   case ELF::R_MICROMIPS_GOT16:
530   case ELF::R_MIPS_HIGHER:
531   case ELF::R_MIPS_HIGHEST:
532   case ELF::R_MIPS_HI16:
533   case ELF::R_MIPS16_HI16:
534   case ELF::R_MICROMIPS_HI16:
535   case ELF::R_MIPS_LO16:
536   case ELF::R_MIPS16_LO16:
537   case ELF::R_MICROMIPS_LO16:
538     // FIXME: It should be safe to return false for the STO_MIPS_MICROMIPS but
539     //        we neglect to handle the adjustment to the LSB of the addend that
540     //        it causes in applyFixup() and similar.
541     if (cast<MCSymbolELF>(Sym).getOther() & ELF::STO_MIPS_MICROMIPS)
542       return true;
543     return false;
544 
545   case ELF::R_MIPS_GOT_PAGE:
546   case ELF::R_MICROMIPS_GOT_PAGE:
547   case ELF::R_MIPS_GOT_OFST:
548   case ELF::R_MICROMIPS_GOT_OFST:
549   case ELF::R_MIPS_16:
550   case ELF::R_MIPS_32:
551   case ELF::R_MIPS_GPREL32:
552     if (cast<MCSymbolELF>(Sym).getOther() & ELF::STO_MIPS_MICROMIPS)
553       return true;
554     LLVM_FALLTHROUGH;
555   case ELF::R_MIPS_26:
556   case ELF::R_MIPS_64:
557   case ELF::R_MIPS_GPREL16:
558   case ELF::R_MIPS_PC16:
559   case ELF::R_MIPS_SUB:
560     return false;
561 
562   // FIXME: Many of these relocations should probably return false but this
563   //        hasn't been confirmed to be safe yet.
564   case ELF::R_MIPS_REL32:
565   case ELF::R_MIPS_LITERAL:
566   case ELF::R_MIPS_CALL16:
567   case ELF::R_MIPS_SHIFT5:
568   case ELF::R_MIPS_SHIFT6:
569   case ELF::R_MIPS_GOT_DISP:
570   case ELF::R_MIPS_GOT_HI16:
571   case ELF::R_MIPS_GOT_LO16:
572   case ELF::R_MIPS_INSERT_A:
573   case ELF::R_MIPS_INSERT_B:
574   case ELF::R_MIPS_DELETE:
575   case ELF::R_MIPS_CALL_HI16:
576   case ELF::R_MIPS_CALL_LO16:
577   case ELF::R_MIPS_SCN_DISP:
578   case ELF::R_MIPS_REL16:
579   case ELF::R_MIPS_ADD_IMMEDIATE:
580   case ELF::R_MIPS_PJUMP:
581   case ELF::R_MIPS_RELGOT:
582   case ELF::R_MIPS_JALR:
583   case ELF::R_MIPS_TLS_DTPMOD32:
584   case ELF::R_MIPS_TLS_DTPREL32:
585   case ELF::R_MIPS_TLS_DTPMOD64:
586   case ELF::R_MIPS_TLS_DTPREL64:
587   case ELF::R_MIPS_TLS_GD:
588   case ELF::R_MIPS_TLS_LDM:
589   case ELF::R_MIPS_TLS_DTPREL_HI16:
590   case ELF::R_MIPS_TLS_DTPREL_LO16:
591   case ELF::R_MIPS_TLS_GOTTPREL:
592   case ELF::R_MIPS_TLS_TPREL32:
593   case ELF::R_MIPS_TLS_TPREL64:
594   case ELF::R_MIPS_TLS_TPREL_HI16:
595   case ELF::R_MIPS_TLS_TPREL_LO16:
596   case ELF::R_MIPS_GLOB_DAT:
597   case ELF::R_MIPS_PC21_S2:
598   case ELF::R_MIPS_PC26_S2:
599   case ELF::R_MIPS_PC18_S3:
600   case ELF::R_MIPS_PC19_S2:
601   case ELF::R_MIPS_PCHI16:
602   case ELF::R_MIPS_PCLO16:
603   case ELF::R_MIPS_COPY:
604   case ELF::R_MIPS_JUMP_SLOT:
605   case ELF::R_MIPS_NUM:
606   case ELF::R_MIPS_PC32:
607   case ELF::R_MIPS_EH:
608   case ELF::R_MICROMIPS_26_S1:
609   case ELF::R_MICROMIPS_GPREL16:
610   case ELF::R_MICROMIPS_LITERAL:
611   case ELF::R_MICROMIPS_PC7_S1:
612   case ELF::R_MICROMIPS_PC10_S1:
613   case ELF::R_MICROMIPS_PC16_S1:
614   case ELF::R_MICROMIPS_CALL16:
615   case ELF::R_MICROMIPS_GOT_DISP:
616   case ELF::R_MICROMIPS_GOT_HI16:
617   case ELF::R_MICROMIPS_GOT_LO16:
618   case ELF::R_MICROMIPS_SUB:
619   case ELF::R_MICROMIPS_HIGHER:
620   case ELF::R_MICROMIPS_HIGHEST:
621   case ELF::R_MICROMIPS_CALL_HI16:
622   case ELF::R_MICROMIPS_CALL_LO16:
623   case ELF::R_MICROMIPS_SCN_DISP:
624   case ELF::R_MICROMIPS_JALR:
625   case ELF::R_MICROMIPS_HI0_LO16:
626   case ELF::R_MICROMIPS_TLS_GD:
627   case ELF::R_MICROMIPS_TLS_LDM:
628   case ELF::R_MICROMIPS_TLS_DTPREL_HI16:
629   case ELF::R_MICROMIPS_TLS_DTPREL_LO16:
630   case ELF::R_MICROMIPS_TLS_GOTTPREL:
631   case ELF::R_MICROMIPS_TLS_TPREL_HI16:
632   case ELF::R_MICROMIPS_TLS_TPREL_LO16:
633   case ELF::R_MICROMIPS_GPREL7_S2:
634   case ELF::R_MICROMIPS_PC23_S2:
635   case ELF::R_MICROMIPS_PC21_S1:
636   case ELF::R_MICROMIPS_PC26_S1:
637   case ELF::R_MICROMIPS_PC18_S3:
638   case ELF::R_MICROMIPS_PC19_S2:
639     return true;
640 
641   // FIXME: Many of these should probably return false but MIPS16 isn't
642   //        supported by the integrated assembler.
643   case ELF::R_MIPS16_26:
644   case ELF::R_MIPS16_GPREL:
645   case ELF::R_MIPS16_CALL16:
646   case ELF::R_MIPS16_TLS_GD:
647   case ELF::R_MIPS16_TLS_LDM:
648   case ELF::R_MIPS16_TLS_DTPREL_HI16:
649   case ELF::R_MIPS16_TLS_DTPREL_LO16:
650   case ELF::R_MIPS16_TLS_GOTTPREL:
651   case ELF::R_MIPS16_TLS_TPREL_HI16:
652   case ELF::R_MIPS16_TLS_TPREL_LO16:
653     llvm_unreachable("Unsupported MIPS16 relocation");
654     return true;
655   }
656 }
657 
658 MCObjectWriter *llvm::createMipsELFObjectWriter(raw_pwrite_stream &OS,
659                                                 const Triple &TT, bool IsN32) {
660   uint8_t OSABI = MCELFObjectTargetWriter::getOSABI(TT.getOS());
661   bool IsN64 = TT.isArch64Bit() && !IsN32;
662   bool HasRelocationAddend = TT.isArch64Bit();
663   auto MOTW = llvm::make_unique<MipsELFObjectWriter>(
664       OSABI, HasRelocationAddend, IsN64, TT.isLittleEndian());
665   return createELFObjectWriter(std::move(MOTW), OS, TT.isLittleEndian());
666 }
667