LLVM 19.0.0git
AArch64MCExpr.h
Go to the documentation of this file.
1//=--- AArch64MCExpr.h - AArch64 specific MC expression classes ---*- 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// This file describes AArch64-specific MCExprs, used for modifiers like
10// ":lo12:" or ":gottprel_g1:".
11//
12//===----------------------------------------------------------------------===//
13
14#ifndef LLVM_LIB_TARGET_AARCH64_MCTARGETDESC_AARCH64MCEXPR_H
15#define LLVM_LIB_TARGET_AARCH64_MCTARGETDESC_AARCH64MCEXPR_H
16
18#include "llvm/MC/MCExpr.h"
21
22namespace llvm {
23
25public:
27 // Symbol locations specifying (roughly speaking) what calculation should be
28 // performed to construct the final address for the relocated
29 // symbol. E.g. direct, via the GOT, ...
30 VK_ABS = 0x001,
31 VK_SABS = 0x002,
32 VK_PREL = 0x003,
33 VK_GOT = 0x004,
34 VK_DTPREL = 0x005,
35 VK_GOTTPREL = 0x006,
36 VK_TPREL = 0x007,
37 VK_TLSDESC = 0x008,
38 VK_SECREL = 0x009,
39 VK_AUTH = 0x00a,
40 VK_AUTHADDR = 0x00b,
42
43 // Variants specifying which part of the final address calculation is
44 // used. E.g. the low 12 bits for an ADD/LDR, the middle 16 bits for a
45 // MOVZ/MOVK.
46 VK_PAGE = 0x010,
47 VK_PAGEOFF = 0x020,
48 VK_HI12 = 0x030,
49 VK_G0 = 0x040,
50 VK_G1 = 0x050,
51 VK_G2 = 0x060,
52 VK_G3 = 0x070,
53 VK_LO15 = 0x080,
55
56 // Whether the final relocation is a checked one (where a linker should
57 // perform a range-check on the final address) or not. Note that this field
58 // is unfortunately sometimes omitted from the assembly syntax. E.g. :lo12:
59 // on its own is a non-checked relocation. We side with ELF on being
60 // explicit about this!
61 VK_NC = 0x100,
62
63 // Convenience definitions for referring to specific textual representations
64 // of relocation specifiers. Note that this means the "_NC" is sometimes
65 // omitted in line with assembly syntax here (VK_LO12 rather than VK_LO12_NC
66 // since a user would write ":lo12:").
115
116 VK_INVALID = 0xfff
117 };
118
119private:
120 const MCExpr *Expr;
121 const VariantKind Kind;
122
123protected:
124 explicit AArch64MCExpr(const MCExpr *Expr, VariantKind Kind)
125 : Expr(Expr), Kind(Kind) {}
126
127public:
128 /// @name Construction
129 /// @{
130
131 static const AArch64MCExpr *create(const MCExpr *Expr, VariantKind Kind,
132 MCContext &Ctx);
133
134 /// @}
135 /// @name Accessors
136 /// @{
137
138 /// Get the kind of this expression.
139 VariantKind getKind() const { return Kind; }
140
141 /// Get the expression this modifier applies to.
142 const MCExpr *getSubExpr() const { return Expr; }
143
144 /// @}
145 /// @name VariantKind information extractors.
146 /// @{
147
149 return static_cast<VariantKind>(Kind & VK_SymLocBits);
150 }
151
153 return static_cast<VariantKind>(Kind & VK_AddressFragBits);
154 }
155
156 static bool isNotChecked(VariantKind Kind) { return Kind & VK_NC; }
157
158 /// @}
159
160 /// Convert the variant kind into an ELF-appropriate modifier
161 /// (e.g. ":got:", ":lo12:").
163
164 void printImpl(raw_ostream &OS, const MCAsmInfo *MAI) const override;
165
166 void visitUsedExpr(MCStreamer &Streamer) const override;
167
168 MCFragment *findAssociatedFragment() const override;
169
170 bool evaluateAsRelocatableImpl(MCValue &Res, const MCAsmLayout *Layout,
171 const MCFixup *Fixup) const override;
172
173 void fixELFSymbolsInTLSFixups(MCAssembler &Asm) const override;
174
175 static bool classof(const MCExpr *E) {
176 return E->getKind() == MCExpr::Target;
177 }
178};
179
180class AArch64AuthMCExpr final : public AArch64MCExpr {
181 uint16_t Discriminator;
183
184 explicit AArch64AuthMCExpr(const MCExpr *Expr, uint16_t Discriminator,
185 AArch64PACKey::ID Key, bool HasAddressDiversity)
186 : AArch64MCExpr(Expr, HasAddressDiversity ? VK_AUTHADDR : VK_AUTH),
187 Discriminator(Discriminator), Key(Key) {}
188
189public:
190 static const AArch64AuthMCExpr *
191 create(const MCExpr *Expr, uint16_t Discriminator, AArch64PACKey::ID Key,
192 bool HasAddressDiversity, MCContext &Ctx);
193
194 AArch64PACKey::ID getKey() const { return Key; }
195 uint16_t getDiscriminator() const { return Discriminator; }
196 bool hasAddressDiversity() const { return getKind() == VK_AUTHADDR; }
197
198 void printImpl(raw_ostream &OS, const MCAsmInfo *MAI) const override;
199
200 void visitUsedExpr(MCStreamer &Streamer) const override;
201
202 MCFragment *findAssociatedFragment() const override;
203
204 bool evaluateAsRelocatableImpl(MCValue &Res, const MCAsmLayout *Layout,
205 const MCFixup *Fixup) const override;
206
207 static bool classof(const MCExpr *E) {
208 return isa<AArch64MCExpr>(E) && classof(cast<AArch64MCExpr>(E));
209 }
210
211 static bool classof(const AArch64MCExpr *E) {
212 return E->getKind() == VK_AUTH || E->getKind() == VK_AUTHADDR;
213 }
214};
215} // end namespace llvm
216
217#endif
static GCRegistry::Add< CoreCLRGC > E("coreclr", "CoreCLR-compatible GC")
PowerPC TLS Dynamic Call Fixup
raw_pwrite_stream & OS
bool evaluateAsRelocatableImpl(MCValue &Res, const MCAsmLayout *Layout, const MCFixup *Fixup) const override
bool hasAddressDiversity() const
static const AArch64AuthMCExpr * create(const MCExpr *Expr, uint16_t Discriminator, AArch64PACKey::ID Key, bool HasAddressDiversity, MCContext &Ctx)
static bool classof(const AArch64MCExpr *E)
void visitUsedExpr(MCStreamer &Streamer) const override
uint16_t getDiscriminator() const
void printImpl(raw_ostream &OS, const MCAsmInfo *MAI) const override
AArch64PACKey::ID getKey() const
static bool classof(const MCExpr *E)
MCFragment * findAssociatedFragment() const override
static VariantKind getSymbolLoc(VariantKind Kind)
void fixELFSymbolsInTLSFixups(MCAssembler &Asm) const override
AArch64MCExpr(const MCExpr *Expr, VariantKind Kind)
MCFragment * findAssociatedFragment() const override
StringRef getVariantKindName() const
Convert the variant kind into an ELF-appropriate modifier (e.g.
void visitUsedExpr(MCStreamer &Streamer) const override
static bool isNotChecked(VariantKind Kind)
static VariantKind getAddressFrag(VariantKind Kind)
static const AArch64MCExpr * create(const MCExpr *Expr, VariantKind Kind, MCContext &Ctx)
static bool classof(const MCExpr *E)
const MCExpr * getSubExpr() const
Get the expression this modifier applies to.
VariantKind getKind() const
Get the kind of this expression.
void printImpl(raw_ostream &OS, const MCAsmInfo *MAI) const override
bool evaluateAsRelocatableImpl(MCValue &Res, const MCAsmLayout *Layout, const MCFixup *Fixup) const override
This class is intended to be used as a base class for asm properties and features specific to the tar...
Definition: MCAsmInfo.h:56
Encapsulates the layout of an assembly file at a particular point in time.
Definition: MCAsmLayout.h:28
Context object for machine code objects.
Definition: MCContext.h:76
Base class for the full range of assembler expressions which are needed for parsing.
Definition: MCExpr.h:35
@ Target
Target specific expression.
Definition: MCExpr.h:42
Encode information on a single operation to perform on a byte sequence (e.g., an encoded instruction)...
Definition: MCFixup.h:71
Streaming machine code generation interface.
Definition: MCStreamer.h:212
This is an extension point for target-specific MCExpr subclasses to implement.
Definition: MCExpr.h:654
This represents an "assembler immediate".
Definition: MCValue.h:36
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:50
This class implements an extremely fast bulk output stream that can only output to a stream.
Definition: raw_ostream.h:52
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:18