LLVM 17.0.0git
MCELFObjectWriter.h
Go to the documentation of this file.
1//===- llvm/MC/MCELFObjectWriter.h - ELF Object Writer ----------*- C++ -*-===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8
9#ifndef LLVM_MC_MCELFOBJECTWRITER_H
10#define LLVM_MC_MCELFOBJECTWRITER_H
11
12#include "llvm/ADT/Triple.h"
18#include <cstdint>
19#include <vector>
20
21namespace llvm {
22
23class MCAssembler;
24class MCContext;
25class MCFixup;
26class MCSymbol;
27class MCSymbolELF;
28class MCValue;
29
31 uint64_t Offset; // Where is the relocation.
32 const MCSymbolELF *Symbol; // The symbol to relocate with.
33 unsigned Type; // The type of the relocation.
34 uint64_t Addend; // The addend to use.
35 const MCSymbolELF *OriginalSymbol; // The original value of Symbol if we changed it.
36 uint64_t OriginalAddend; // The original value of addend.
37
43
44 void print(raw_ostream &Out) const {
45 Out << "Off=" << Offset << ", Sym=" << Symbol << ", Type=" << Type
46 << ", Addend=" << Addend << ", OriginalSymbol=" << OriginalSymbol
47 << ", OriginalAddend=" << OriginalAddend;
48 }
49
50 LLVM_DUMP_METHOD void dump() const { print(errs()); }
51};
52
54 const uint8_t OSABI;
55 const uint8_t ABIVersion;
56 const uint16_t EMachine;
57 const unsigned HasRelocationAddend : 1;
58 const unsigned Is64Bit : 1;
59
60protected:
61 MCELFObjectTargetWriter(bool Is64Bit_, uint8_t OSABI_, uint16_t EMachine_,
62 bool HasRelocationAddend_, uint8_t ABIVersion_ = 0);
63
64public:
65 virtual ~MCELFObjectTargetWriter() = default;
66
67 Triple::ObjectFormatType getFormat() const override { return Triple::ELF; }
68 static bool classof(const MCObjectTargetWriter *W) {
69 return W->getFormat() == Triple::ELF;
70 }
71
72 static uint8_t getOSABI(Triple::OSType OSType) {
73 switch (OSType) {
78 case Triple::PS4:
79 case Triple::FreeBSD:
81 case Triple::Solaris:
83 default:
84 return ELF::ELFOSABI_NONE;
85 }
86 }
87
88 virtual unsigned getRelocType(MCContext &Ctx, const MCValue &Target,
89 const MCFixup &Fixup, bool IsPCRel) const = 0;
90
91 virtual bool needsRelocateWithSymbol(const MCSymbol &Sym,
92 unsigned Type) const;
93
94 virtual void sortRelocs(const MCAssembler &Asm,
95 std::vector<ELFRelocationEntry> &Relocs);
96
97 virtual void addTargetSectionFlags(MCContext &Ctx, MCSectionELF &Sec);
98
99 /// \name Accessors
100 /// @{
101 uint8_t getOSABI() const { return OSABI; }
102 uint8_t getABIVersion() const { return ABIVersion; }
103 uint16_t getEMachine() const { return EMachine; }
104 bool hasRelocationAddend() const { return HasRelocationAddend; }
105 bool is64Bit() const { return Is64Bit; }
106 /// @}
107
108 // Instead of changing everyone's API we pack the N64 Type fields
109 // into the existing 32 bit data unsigned.
110#define R_TYPE_SHIFT 0
111#define R_TYPE_MASK 0xffffff00
112#define R_TYPE2_SHIFT 8
113#define R_TYPE2_MASK 0xffff00ff
114#define R_TYPE3_SHIFT 16
115#define R_TYPE3_MASK 0xff00ffff
116#define R_SSYM_SHIFT 24
117#define R_SSYM_MASK 0x00ffffff
118
119 // N64 relocation type accessors
120 uint8_t getRType(uint32_t Type) const {
121 return (unsigned)((Type >> R_TYPE_SHIFT) & 0xff);
122 }
123 uint8_t getRType2(uint32_t Type) const {
124 return (unsigned)((Type >> R_TYPE2_SHIFT) & 0xff);
125 }
126 uint8_t getRType3(uint32_t Type) const {
127 return (unsigned)((Type >> R_TYPE3_SHIFT) & 0xff);
128 }
129 uint8_t getRSsym(uint32_t Type) const {
130 return (unsigned)((Type >> R_SSYM_SHIFT) & 0xff);
131 }
132
133 // N64 relocation type setting
134 static unsigned setRTypes(unsigned Value1, unsigned Value2, unsigned Value3) {
135 return ((Value1 & 0xff) << R_TYPE_SHIFT) |
136 ((Value2 & 0xff) << R_TYPE2_SHIFT) |
137 ((Value3 & 0xff) << R_TYPE3_SHIFT);
138 }
139 unsigned setRSsym(unsigned Value, unsigned Type) const {
140 return (Type & R_SSYM_MASK) | ((Value & 0xff) << R_SSYM_SHIFT);
141 }
142
143 // On AArch64, return a new section to be added to the ELF object that
144 // contains relocations used to describe every symbol that should have memory
145 // tags applied. Returns nullptr if no such section is necessary (i.e. there's
146 // no tagged globals).
148 return nullptr;
149 }
150};
151
152/// Construct a new ELF writer instance.
153///
154/// \param MOTW - The target specific ELF writer subclass.
155/// \param OS - The stream to write to.
156/// \returns The constructed object writer.
157std::unique_ptr<MCObjectWriter>
158createELFObjectWriter(std::unique_ptr<MCELFObjectTargetWriter> MOTW,
159 raw_pwrite_stream &OS, bool IsLittleEndian);
160
161std::unique_ptr<MCObjectWriter>
162createELFDwoObjectWriter(std::unique_ptr<MCELFObjectTargetWriter> MOTW,
163 raw_pwrite_stream &OS, raw_pwrite_stream &DwoOS,
164 bool IsLittleEndian);
165
166} // end namespace llvm
167
168#endif // LLVM_MC_MCELFOBJECTWRITER_H
This header is deprecated in favour of llvm/TargetParser/Triple.h.
#define LLVM_DUMP_METHOD
Mark debug helper function definitions like dump() that should not be stripped from debug builds.
Definition: Compiler.h:492
#define R_TYPE2_SHIFT
#define R_SSYM_MASK
#define R_TYPE_SHIFT
#define R_TYPE3_SHIFT
#define R_SSYM_SHIFT
PowerPC TLS Dynamic Call Fixup
Context object for machine code objects.
Definition: MCContext.h:76
static bool classof(const MCObjectTargetWriter *W)
virtual void sortRelocs(const MCAssembler &Asm, std::vector< ELFRelocationEntry > &Relocs)
virtual bool needsRelocateWithSymbol(const MCSymbol &Sym, unsigned Type) const
Triple::ObjectFormatType getFormat() const override
virtual MCSectionELF * getMemtagRelocsSection(MCContext &Ctx) const
static unsigned setRTypes(unsigned Value1, unsigned Value2, unsigned Value3)
uint8_t getRType(uint32_t Type) const
virtual unsigned getRelocType(MCContext &Ctx, const MCValue &Target, const MCFixup &Fixup, bool IsPCRel) const =0
uint8_t getRSsym(uint32_t Type) const
virtual ~MCELFObjectTargetWriter()=default
virtual void addTargetSectionFlags(MCContext &Ctx, MCSectionELF &Sec)
static uint8_t getOSABI(Triple::OSType OSType)
unsigned setRSsym(unsigned Value, unsigned Type) const
uint8_t getRType2(uint32_t Type) const
uint8_t getRType3(uint32_t Type) const
Encode information on a single operation to perform on a byte sequence (e.g., an encoded instruction)...
Definition: MCFixup.h:71
Base class for classes that define behaviour that is specific to both the target and the object forma...
This represents a section on linux, lots of unix variants and some bare metal systems.
Definition: MCSectionELF.h:26
MCSymbol - Instances of this class represent a symbol name in the MC file, and MCSymbols are created ...
Definition: MCSymbol.h:41
This represents an "assembler immediate".
Definition: MCValue.h:36
Target - Wrapper for Target specific information.
@ HermitCore
Definition: Triple.h:221
ObjectFormatType
Definition: Triple.h:279
The instances of the Type class are immutable: once they are created, they are never changed.
Definition: Type.h:45
LLVM Value Representation.
Definition: Value.h:74
This class implements an extremely fast bulk output stream that can only output to a stream.
Definition: raw_ostream.h:52
@ ELFOSABI_SOLARIS
Definition: ELF.h:347
@ ELFOSABI_FREEBSD
Definition: ELF.h:350
@ ELFOSABI_STANDALONE
Definition: ELF.h:366
@ ELFOSABI_CLOUDABI
Definition: ELF.h:358
@ ELFOSABI_NONE
Definition: ELF.h:341
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:18
std::unique_ptr< MCObjectWriter > createELFObjectWriter(std::unique_ptr< MCELFObjectTargetWriter > MOTW, raw_pwrite_stream &OS, bool IsLittleEndian)
Construct a new ELF writer instance.
std::unique_ptr< MCObjectWriter > createELFDwoObjectWriter(std::unique_ptr< MCELFObjectTargetWriter > MOTW, raw_pwrite_stream &OS, raw_pwrite_stream &DwoOS, bool IsLittleEndian)
raw_fd_ostream & errs()
This returns a reference to a raw_ostream for standard error.
ELFRelocationEntry(uint64_t Offset, const MCSymbolELF *Symbol, unsigned Type, uint64_t Addend, const MCSymbolELF *OriginalSymbol, uint64_t OriginalAddend)
const MCSymbolELF * OriginalSymbol
const MCSymbolELF * Symbol
void print(raw_ostream &Out) const
LLVM_DUMP_METHOD void dump() const