LLVM  10.0.0svn
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 
17 #include "llvm/MC/MCExpr.h"
19 
20 namespace llvm {
21 
22 class AArch64MCExpr : public MCTargetExpr {
23 public:
24  enum VariantKind {
25  // Symbol locations specifying (roughly speaking) what calculation should be
26  // performed to construct the final address for the relocated
27  // symbol. E.g. direct, via the GOT, ...
28  VK_ABS = 0x001,
29  VK_SABS = 0x002,
30  VK_PREL = 0x003,
31  VK_GOT = 0x004,
32  VK_DTPREL = 0x005,
33  VK_GOTTPREL = 0x006,
34  VK_TPREL = 0x007,
35  VK_TLSDESC = 0x008,
36  VK_SECREL = 0x009,
37  VK_SymLocBits = 0x00f,
38 
39  // Variants specifying which part of the final address calculation is
40  // used. E.g. the low 12 bits for an ADD/LDR, the middle 16 bits for a
41  // MOVZ/MOVK.
42  VK_PAGE = 0x010,
43  VK_PAGEOFF = 0x020,
44  VK_HI12 = 0x030,
45  VK_G0 = 0x040,
46  VK_G1 = 0x050,
47  VK_G2 = 0x060,
48  VK_G3 = 0x070,
50 
51  // Whether the final relocation is a checked one (where a linker should
52  // perform a range-check on the final address) or not. Note that this field
53  // is unfortunately sometimes omitted from the assembly syntax. E.g. :lo12:
54  // on its own is a non-checked relocation. We side with ELF on being
55  // explicit about this!
56  VK_NC = 0x100,
57 
58  // Convenience definitions for referring to specific textual representations
59  // of relocation specifiers. Note that this means the "_NC" is sometimes
60  // omitted in line with assembly syntax here (VK_LO12 rather than VK_LO12_NC
61  // since a user would write ":lo12:").
109 
110  VK_INVALID = 0xfff
111  };
112 
113 private:
114  const MCExpr *Expr;
115  const VariantKind Kind;
116 
117  explicit AArch64MCExpr(const MCExpr *Expr, VariantKind Kind)
118  : Expr(Expr), Kind(Kind) {}
119 
120 public:
121  /// @name Construction
122  /// @{
123 
124  static const AArch64MCExpr *create(const MCExpr *Expr, VariantKind Kind,
125  MCContext &Ctx);
126 
127  /// @}
128  /// @name Accessors
129  /// @{
130 
131  /// Get the kind of this expression.
132  VariantKind getKind() const { return Kind; }
133 
134  /// Get the expression this modifier applies to.
135  const MCExpr *getSubExpr() const { return Expr; }
136 
137  /// @}
138  /// @name VariantKind information extractors.
139  /// @{
140 
142  return static_cast<VariantKind>(Kind & VK_SymLocBits);
143  }
144 
146  return static_cast<VariantKind>(Kind & VK_AddressFragBits);
147  }
148 
149  static bool isNotChecked(VariantKind Kind) { return Kind & VK_NC; }
150 
151  /// @}
152 
153  /// Convert the variant kind into an ELF-appropriate modifier
154  /// (e.g. ":got:", ":lo12:").
156 
157  void printImpl(raw_ostream &OS, const MCAsmInfo *MAI) const override;
158 
159  void visitUsedExpr(MCStreamer &Streamer) const override;
160 
161  MCFragment *findAssociatedFragment() const override;
162 
163  bool evaluateAsRelocatableImpl(MCValue &Res, const MCAsmLayout *Layout,
164  const MCFixup *Fixup) const override;
165 
166  void fixELFSymbolsInTLSFixups(MCAssembler &Asm) const override;
167 
168  static bool classof(const MCExpr *E) {
169  return E->getKind() == MCExpr::Target;
170  }
171 
172  static bool classof(const AArch64MCExpr *) { return true; }
173 };
174 } // end namespace llvm
175 
176 #endif
VariantKind getKind() const
Get the kind of this expression.
This class represents lattice values for constants.
Definition: AllocatorList.h:23
This represents an "assembler immediate".
Definition: MCValue.h:39
static const AArch64MCExpr * create(const MCExpr *Expr, VariantKind Kind, MCContext &Ctx)
static bool classof(const AArch64MCExpr *)
StringRef getVariantKindName() const
Convert the variant kind into an ELF-appropriate modifier (e.g.
Encode information on a single operation to perform on a byte sequence (e.g., an encoded instruction)...
Definition: MCFixup.h:77
Encapsulates the layout of an assembly file at a particular point in time.
Definition: MCAsmLayout.h:28
Base class for the full range of assembler expressions which are needed for parsing.
Definition: MCExpr.h:35
This is an extension point for target-specific MCExpr subclasses to implement.
Definition: MCExpr.h:585
bool evaluateAsRelocatableImpl(MCValue &Res, const MCAsmLayout *Layout, const MCFixup *Fixup) const override
Context object for machine code objects.
Definition: MCContext.h:65
static VariantKind getAddressFrag(VariantKind Kind)
This class is intended to be used as a base class for asm properties and features specific to the tar...
Definition: MCAsmInfo.h:56
Streaming machine code generation interface.
Definition: MCStreamer.h:189
const MCExpr * getSubExpr() const
Get the expression this modifier applies to.
static GCRegistry::Add< CoreCLRGC > E("coreclr", "CoreCLR-compatible GC")
void visitUsedExpr(MCStreamer &Streamer) const override
PowerPC TLS Dynamic Call Fixup
ExprKind getKind() const
Definition: MCExpr.h:68
static bool isNotChecked(VariantKind Kind)
static bool classof(const MCExpr *E)
static VariantKind getSymbolLoc(VariantKind Kind)
void printImpl(raw_ostream &OS, const MCAsmInfo *MAI) const override
This class implements an extremely fast bulk output stream that can only output to a stream...
Definition: raw_ostream.h:45
void fixELFSymbolsInTLSFixups(MCAssembler &Asm) const override
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:48
Target specific expression.
Definition: MCExpr.h:42
MCFragment * findAssociatedFragment() const override