1 //===- MCExpr.h - Assembly Level Expressions --------------------*- 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_MCEXPR_H 10 #define LLVM_MC_MCEXPR_H 11 12 #include "llvm/ADT/DenseMap.h" 13 #include "llvm/Support/SMLoc.h" 14 #include <cstdint> 15 16 namespace llvm { 17 18 class MCAsmInfo; 19 class MCAsmLayout; 20 class MCAssembler; 21 class MCContext; 22 class MCFixup; 23 class MCFragment; 24 class MCSection; 25 class MCStreamer; 26 class MCSymbol; 27 class MCValue; 28 class raw_ostream; 29 class StringRef; 30 31 using SectionAddrMap = DenseMap<const MCSection *, uint64_t>; 32 33 /// Base class for the full range of assembler expressions which are 34 /// needed for parsing. 35 class MCExpr { 36 public: 37 enum ExprKind : uint8_t { 38 Binary, ///< Binary expressions. 39 Constant, ///< Constant expressions. 40 SymbolRef, ///< References to labels and assigned expressions. 41 Unary, ///< Unary expressions. 42 Target ///< Target specific expression. 43 }; 44 45 private: 46 static const unsigned NumSubclassDataBits = 24; 47 static_assert( 48 NumSubclassDataBits == CHAR_BIT * (sizeof(unsigned) - sizeof(ExprKind)), 49 "ExprKind and SubclassData together should take up one word"); 50 51 ExprKind Kind; 52 /// Field reserved for use by MCExpr subclasses. 53 unsigned SubclassData : NumSubclassDataBits; 54 SMLoc Loc; 55 56 bool evaluateAsAbsolute(int64_t &Res, const MCAssembler *Asm, 57 const MCAsmLayout *Layout, 58 const SectionAddrMap *Addrs, bool InSet) const; 59 60 protected: 61 explicit MCExpr(ExprKind Kind, SMLoc Loc, unsigned SubclassData = 0) Kind(Kind)62 : Kind(Kind), SubclassData(SubclassData), Loc(Loc) { 63 assert(SubclassData < (1 << NumSubclassDataBits) && 64 "Subclass data too large"); 65 } 66 67 bool evaluateAsRelocatableImpl(MCValue &Res, const MCAssembler *Asm, 68 const MCAsmLayout *Layout, 69 const MCFixup *Fixup, 70 const SectionAddrMap *Addrs, bool InSet) const; 71 getSubclassData()72 unsigned getSubclassData() const { return SubclassData; } 73 74 public: 75 MCExpr(const MCExpr &) = delete; 76 MCExpr &operator=(const MCExpr &) = delete; 77 78 /// \name Accessors 79 /// @{ 80 getKind()81 ExprKind getKind() const { return Kind; } getLoc()82 SMLoc getLoc() const { return Loc; } 83 84 /// @} 85 /// \name Utility Methods 86 /// @{ 87 88 void print(raw_ostream &OS, const MCAsmInfo *MAI, 89 bool InParens = false) const; 90 void dump() const; 91 92 /// @} 93 /// \name Expression Evaluation 94 /// @{ 95 96 /// Try to evaluate the expression to an absolute value. 97 /// 98 /// \param Res - The absolute value, if evaluation succeeds. 99 /// \param Layout - The assembler layout object to use for evaluating symbol 100 /// values. If not given, then only non-symbolic expressions will be 101 /// evaluated. 102 /// \return - True on success. 103 bool evaluateAsAbsolute(int64_t &Res, const MCAsmLayout &Layout, 104 const SectionAddrMap &Addrs) const; 105 bool evaluateAsAbsolute(int64_t &Res) const; 106 bool evaluateAsAbsolute(int64_t &Res, const MCAssembler &Asm) const; 107 bool evaluateAsAbsolute(int64_t &Res, const MCAssembler *Asm) const; 108 bool evaluateAsAbsolute(int64_t &Res, const MCAsmLayout &Layout) const; 109 110 bool evaluateKnownAbsolute(int64_t &Res, const MCAsmLayout &Layout) const; 111 112 /// Try to evaluate the expression to a relocatable value, i.e. an 113 /// expression of the fixed form (a - b + constant). 114 /// 115 /// \param Res - The relocatable value, if evaluation succeeds. 116 /// \param Layout - The assembler layout object to use for evaluating values. 117 /// \param Fixup - The Fixup object if available. 118 /// \return - True on success. 119 bool evaluateAsRelocatable(MCValue &Res, const MCAsmLayout *Layout, 120 const MCFixup *Fixup) const; 121 122 /// Try to evaluate the expression to the form (a - b + constant) where 123 /// neither a nor b are variables. 124 /// 125 /// This is a more aggressive variant of evaluateAsRelocatable. The intended 126 /// use is for when relocations are not available, like the .size directive. 127 bool evaluateAsValue(MCValue &Res, const MCAsmLayout &Layout) const; 128 129 /// Find the "associated section" for this expression, which is 130 /// currently defined as the absolute section for constants, or 131 /// otherwise the section associated with the first defined symbol in the 132 /// expression. 133 MCFragment *findAssociatedFragment() const; 134 135 /// @} 136 }; 137 138 inline raw_ostream &operator<<(raw_ostream &OS, const MCExpr &E) { 139 E.print(OS, nullptr); 140 return OS; 141 } 142 143 //// Represent a constant integer expression. 144 class MCConstantExpr : public MCExpr { 145 int64_t Value; 146 147 // Subclass data stores SizeInBytes in bits 0..7 and PrintInHex in bit 8. 148 static const unsigned SizeInBytesBits = 8; 149 static const unsigned SizeInBytesMask = (1 << SizeInBytesBits) - 1; 150 static const unsigned PrintInHexBit = 1 << SizeInBytesBits; 151 encodeSubclassData(bool PrintInHex,unsigned SizeInBytes)152 static unsigned encodeSubclassData(bool PrintInHex, unsigned SizeInBytes) { 153 assert(SizeInBytes <= sizeof(int64_t) && "Excessive size"); 154 return SizeInBytes | (PrintInHex ? PrintInHexBit : 0); 155 } 156 MCConstantExpr(int64_t Value,bool PrintInHex,unsigned SizeInBytes)157 MCConstantExpr(int64_t Value, bool PrintInHex, unsigned SizeInBytes) 158 : MCExpr(MCExpr::Constant, SMLoc(), 159 encodeSubclassData(PrintInHex, SizeInBytes)), Value(Value) {} 160 161 public: 162 /// \name Construction 163 /// @{ 164 165 static const MCConstantExpr *create(int64_t Value, MCContext &Ctx, 166 bool PrintInHex = false, 167 unsigned SizeInBytes = 0); 168 169 /// @} 170 /// \name Accessors 171 /// @{ 172 getValue()173 int64_t getValue() const { return Value; } getSizeInBytes()174 unsigned getSizeInBytes() const { 175 return getSubclassData() & SizeInBytesMask; 176 } 177 useHexFormat()178 bool useHexFormat() const { return (getSubclassData() & PrintInHexBit) != 0; } 179 180 /// @} 181 classof(const MCExpr * E)182 static bool classof(const MCExpr *E) { 183 return E->getKind() == MCExpr::Constant; 184 } 185 }; 186 187 /// Represent a reference to a symbol from inside an expression. 188 /// 189 /// A symbol reference in an expression may be a use of a label, a use of an 190 /// assembler variable (defined constant), or constitute an implicit definition 191 /// of the symbol as external. 192 class MCSymbolRefExpr : public MCExpr { 193 public: 194 enum VariantKind : uint16_t { 195 VK_None, 196 VK_Invalid, 197 198 VK_GOT, 199 VK_GOTOFF, 200 VK_GOTREL, 201 VK_PCREL, 202 VK_GOTPCREL, 203 VK_GOTTPOFF, 204 VK_INDNTPOFF, 205 VK_NTPOFF, 206 VK_GOTNTPOFF, 207 VK_PLT, 208 VK_TLSGD, 209 VK_TLSLD, 210 VK_TLSLDM, 211 VK_TPOFF, 212 VK_DTPOFF, 213 VK_TLSCALL, // symbol(tlscall) 214 VK_TLSDESC, // symbol(tlsdesc) 215 VK_TLVP, // Mach-O thread local variable relocations 216 VK_TLVPPAGE, 217 VK_TLVPPAGEOFF, 218 VK_PAGE, 219 VK_PAGEOFF, 220 VK_GOTPAGE, 221 VK_GOTPAGEOFF, 222 VK_SECREL, 223 VK_SIZE, // symbol@SIZE 224 VK_WEAKREF, // The link between the symbols in .weakref foo, bar 225 226 VK_X86_ABS8, 227 VK_X86_PLTOFF, 228 229 VK_ARM_NONE, 230 VK_ARM_GOT_PREL, 231 VK_ARM_TARGET1, 232 VK_ARM_TARGET2, 233 VK_ARM_PREL31, 234 VK_ARM_SBREL, // symbol(sbrel) 235 VK_ARM_TLSLDO, // symbol(tlsldo) 236 VK_ARM_TLSDESCSEQ, 237 238 VK_AVR_NONE, 239 VK_AVR_LO8, 240 VK_AVR_HI8, 241 VK_AVR_HLO8, 242 VK_AVR_DIFF8, 243 VK_AVR_DIFF16, 244 VK_AVR_DIFF32, 245 246 VK_PPC_LO, // symbol@l 247 VK_PPC_HI, // symbol@h 248 VK_PPC_HA, // symbol@ha 249 VK_PPC_HIGH, // symbol@high 250 VK_PPC_HIGHA, // symbol@higha 251 VK_PPC_HIGHER, // symbol@higher 252 VK_PPC_HIGHERA, // symbol@highera 253 VK_PPC_HIGHEST, // symbol@highest 254 VK_PPC_HIGHESTA, // symbol@highesta 255 VK_PPC_GOT_LO, // symbol@got@l 256 VK_PPC_GOT_HI, // symbol@got@h 257 VK_PPC_GOT_HA, // symbol@got@ha 258 VK_PPC_TOCBASE, // symbol@tocbase 259 VK_PPC_TOC, // symbol@toc 260 VK_PPC_TOC_LO, // symbol@toc@l 261 VK_PPC_TOC_HI, // symbol@toc@h 262 VK_PPC_TOC_HA, // symbol@toc@ha 263 VK_PPC_U, // symbol@u 264 VK_PPC_L, // symbol@l 265 VK_PPC_DTPMOD, // symbol@dtpmod 266 VK_PPC_TPREL_LO, // symbol@tprel@l 267 VK_PPC_TPREL_HI, // symbol@tprel@h 268 VK_PPC_TPREL_HA, // symbol@tprel@ha 269 VK_PPC_TPREL_HIGH, // symbol@tprel@high 270 VK_PPC_TPREL_HIGHA, // symbol@tprel@higha 271 VK_PPC_TPREL_HIGHER, // symbol@tprel@higher 272 VK_PPC_TPREL_HIGHERA, // symbol@tprel@highera 273 VK_PPC_TPREL_HIGHEST, // symbol@tprel@highest 274 VK_PPC_TPREL_HIGHESTA, // symbol@tprel@highesta 275 VK_PPC_DTPREL_LO, // symbol@dtprel@l 276 VK_PPC_DTPREL_HI, // symbol@dtprel@h 277 VK_PPC_DTPREL_HA, // symbol@dtprel@ha 278 VK_PPC_DTPREL_HIGH, // symbol@dtprel@high 279 VK_PPC_DTPREL_HIGHA, // symbol@dtprel@higha 280 VK_PPC_DTPREL_HIGHER, // symbol@dtprel@higher 281 VK_PPC_DTPREL_HIGHERA, // symbol@dtprel@highera 282 VK_PPC_DTPREL_HIGHEST, // symbol@dtprel@highest 283 VK_PPC_DTPREL_HIGHESTA, // symbol@dtprel@highesta 284 VK_PPC_GOT_TPREL, // symbol@got@tprel 285 VK_PPC_GOT_TPREL_LO, // symbol@got@tprel@l 286 VK_PPC_GOT_TPREL_HI, // symbol@got@tprel@h 287 VK_PPC_GOT_TPREL_HA, // symbol@got@tprel@ha 288 VK_PPC_GOT_DTPREL, // symbol@got@dtprel 289 VK_PPC_GOT_DTPREL_LO, // symbol@got@dtprel@l 290 VK_PPC_GOT_DTPREL_HI, // symbol@got@dtprel@h 291 VK_PPC_GOT_DTPREL_HA, // symbol@got@dtprel@ha 292 VK_PPC_TLS, // symbol@tls 293 VK_PPC_GOT_TLSGD, // symbol@got@tlsgd 294 VK_PPC_GOT_TLSGD_LO, // symbol@got@tlsgd@l 295 VK_PPC_GOT_TLSGD_HI, // symbol@got@tlsgd@h 296 VK_PPC_GOT_TLSGD_HA, // symbol@got@tlsgd@ha 297 VK_PPC_TLSGD, // symbol@tlsgd 298 VK_PPC_GOT_TLSLD, // symbol@got@tlsld 299 VK_PPC_GOT_TLSLD_LO, // symbol@got@tlsld@l 300 VK_PPC_GOT_TLSLD_HI, // symbol@got@tlsld@h 301 VK_PPC_GOT_TLSLD_HA, // symbol@got@tlsld@ha 302 VK_PPC_GOT_PCREL, // symbol@got@pcrel 303 VK_PPC_GOT_TLSGD_PCREL, // symbol@got@tlsgd@pcrel 304 VK_PPC_GOT_TLSLD_PCREL, // symbol@got@tlsld@pcrel 305 VK_PPC_GOT_TPREL_PCREL, // symbol@got@tprel@pcrel 306 VK_PPC_TLS_PCREL, // symbol@tls@pcrel 307 VK_PPC_TLSLD, // symbol@tlsld 308 VK_PPC_LOCAL, // symbol@local 309 VK_PPC_NOTOC, // symbol@notoc 310 VK_PPC_PCREL_OPT, // .reloc expr, R_PPC64_PCREL_OPT, expr 311 312 VK_COFF_IMGREL32, // symbol@imgrel (image-relative) 313 314 VK_Hexagon_LO16, 315 VK_Hexagon_HI16, 316 VK_Hexagon_GPREL, 317 VK_Hexagon_GD_GOT, 318 VK_Hexagon_LD_GOT, 319 VK_Hexagon_GD_PLT, 320 VK_Hexagon_LD_PLT, 321 VK_Hexagon_IE, 322 VK_Hexagon_IE_GOT, 323 324 VK_WASM_TYPEINDEX, // Reference to a symbol's type (signature) 325 VK_WASM_TLSREL, // Memory address relative to __tls_base 326 VK_WASM_MBREL, // Memory address relative to __memory_base 327 VK_WASM_TBREL, // Table index relative to __table_base 328 329 VK_AMDGPU_GOTPCREL32_LO, // symbol@gotpcrel32@lo 330 VK_AMDGPU_GOTPCREL32_HI, // symbol@gotpcrel32@hi 331 VK_AMDGPU_REL32_LO, // symbol@rel32@lo 332 VK_AMDGPU_REL32_HI, // symbol@rel32@hi 333 VK_AMDGPU_REL64, // symbol@rel64 334 VK_AMDGPU_ABS32_LO, // symbol@abs32@lo 335 VK_AMDGPU_ABS32_HI, // symbol@abs32@hi 336 337 VK_VE_HI32, // symbol@hi 338 VK_VE_LO32, // symbol@lo 339 VK_VE_PC_HI32, // symbol@pc_hi 340 VK_VE_PC_LO32, // symbol@pc_lo 341 VK_VE_GOT_HI32, // symbol@got_hi 342 VK_VE_GOT_LO32, // symbol@got_lo 343 VK_VE_GOTOFF_HI32, // symbol@gotoff_hi 344 VK_VE_GOTOFF_LO32, // symbol@gotoff_lo 345 VK_VE_PLT_HI32, // symbol@plt_hi 346 VK_VE_PLT_LO32, // symbol@plt_lo 347 VK_VE_TLS_GD_HI32, // symbol@tls_gd_hi 348 VK_VE_TLS_GD_LO32, // symbol@tls_gd_lo 349 VK_VE_TPOFF_HI32, // symbol@tpoff_hi 350 VK_VE_TPOFF_LO32, // symbol@tpoff_lo 351 352 VK_TPREL, 353 VK_DTPREL 354 }; 355 356 private: 357 /// The symbol being referenced. 358 const MCSymbol *Symbol; 359 360 // Subclass data stores VariantKind in bits 0..15 and HasSubsectionsViaSymbols 361 // in bit 16. 362 static const unsigned VariantKindBits = 16; 363 static const unsigned VariantKindMask = (1 << VariantKindBits) - 1; 364 365 // FIXME: Remove this bit. 366 static const unsigned HasSubsectionsViaSymbolsBit = 1 << VariantKindBits; 367 encodeSubclassData(VariantKind Kind,bool HasSubsectionsViaSymbols)368 static unsigned encodeSubclassData(VariantKind Kind, 369 bool HasSubsectionsViaSymbols) { 370 return (unsigned)Kind | 371 (HasSubsectionsViaSymbols ? HasSubsectionsViaSymbolsBit : 0); 372 } 373 374 explicit MCSymbolRefExpr(const MCSymbol *Symbol, VariantKind Kind, 375 const MCAsmInfo *MAI, SMLoc Loc = SMLoc()); 376 377 public: 378 /// \name Construction 379 /// @{ 380 create(const MCSymbol * Symbol,MCContext & Ctx)381 static const MCSymbolRefExpr *create(const MCSymbol *Symbol, MCContext &Ctx) { 382 return MCSymbolRefExpr::create(Symbol, VK_None, Ctx); 383 } 384 385 static const MCSymbolRefExpr *create(const MCSymbol *Symbol, VariantKind Kind, 386 MCContext &Ctx, SMLoc Loc = SMLoc()); 387 static const MCSymbolRefExpr *create(StringRef Name, VariantKind Kind, 388 MCContext &Ctx); 389 390 /// @} 391 /// \name Accessors 392 /// @{ 393 getSymbol()394 const MCSymbol &getSymbol() const { return *Symbol; } 395 getKind()396 VariantKind getKind() const { 397 return (VariantKind)(getSubclassData() & VariantKindMask); 398 } 399 hasSubsectionsViaSymbols()400 bool hasSubsectionsViaSymbols() const { 401 return (getSubclassData() & HasSubsectionsViaSymbolsBit) != 0; 402 } 403 404 /// @} 405 /// \name Static Utility Functions 406 /// @{ 407 408 static StringRef getVariantKindName(VariantKind Kind); 409 410 static VariantKind getVariantKindForName(StringRef Name); 411 412 /// @} 413 classof(const MCExpr * E)414 static bool classof(const MCExpr *E) { 415 return E->getKind() == MCExpr::SymbolRef; 416 } 417 }; 418 419 /// Unary assembler expressions. 420 class MCUnaryExpr : public MCExpr { 421 public: 422 enum Opcode { 423 LNot, ///< Logical negation. 424 Minus, ///< Unary minus. 425 Not, ///< Bitwise negation. 426 Plus ///< Unary plus. 427 }; 428 429 private: 430 const MCExpr *Expr; 431 MCUnaryExpr(Opcode Op,const MCExpr * Expr,SMLoc Loc)432 MCUnaryExpr(Opcode Op, const MCExpr *Expr, SMLoc Loc) 433 : MCExpr(MCExpr::Unary, Loc, Op), Expr(Expr) {} 434 435 public: 436 /// \name Construction 437 /// @{ 438 439 static const MCUnaryExpr *create(Opcode Op, const MCExpr *Expr, 440 MCContext &Ctx, SMLoc Loc = SMLoc()); 441 442 static const MCUnaryExpr *createLNot(const MCExpr *Expr, MCContext &Ctx, SMLoc Loc = SMLoc()) { 443 return create(LNot, Expr, Ctx, Loc); 444 } 445 446 static const MCUnaryExpr *createMinus(const MCExpr *Expr, MCContext &Ctx, SMLoc Loc = SMLoc()) { 447 return create(Minus, Expr, Ctx, Loc); 448 } 449 450 static const MCUnaryExpr *createNot(const MCExpr *Expr, MCContext &Ctx, SMLoc Loc = SMLoc()) { 451 return create(Not, Expr, Ctx, Loc); 452 } 453 454 static const MCUnaryExpr *createPlus(const MCExpr *Expr, MCContext &Ctx, SMLoc Loc = SMLoc()) { 455 return create(Plus, Expr, Ctx, Loc); 456 } 457 458 /// @} 459 /// \name Accessors 460 /// @{ 461 462 /// Get the kind of this unary expression. getOpcode()463 Opcode getOpcode() const { return (Opcode)getSubclassData(); } 464 465 /// Get the child of this unary expression. getSubExpr()466 const MCExpr *getSubExpr() const { return Expr; } 467 468 /// @} 469 classof(const MCExpr * E)470 static bool classof(const MCExpr *E) { 471 return E->getKind() == MCExpr::Unary; 472 } 473 }; 474 475 /// Binary assembler expressions. 476 class MCBinaryExpr : public MCExpr { 477 public: 478 enum Opcode { 479 Add, ///< Addition. 480 And, ///< Bitwise and. 481 Div, ///< Signed division. 482 EQ, ///< Equality comparison. 483 GT, ///< Signed greater than comparison (result is either 0 or some 484 ///< target-specific non-zero value) 485 GTE, ///< Signed greater than or equal comparison (result is either 0 or 486 ///< some target-specific non-zero value). 487 LAnd, ///< Logical and. 488 LOr, ///< Logical or. 489 LT, ///< Signed less than comparison (result is either 0 or 490 ///< some target-specific non-zero value). 491 LTE, ///< Signed less than or equal comparison (result is either 0 or 492 ///< some target-specific non-zero value). 493 Mod, ///< Signed remainder. 494 Mul, ///< Multiplication. 495 NE, ///< Inequality comparison. 496 Or, ///< Bitwise or. 497 OrNot, ///< Bitwise or not. 498 Shl, ///< Shift left. 499 AShr, ///< Arithmetic shift right. 500 LShr, ///< Logical shift right. 501 Sub, ///< Subtraction. 502 Xor ///< Bitwise exclusive or. 503 }; 504 505 private: 506 const MCExpr *LHS, *RHS; 507 508 MCBinaryExpr(Opcode Op, const MCExpr *LHS, const MCExpr *RHS, 509 SMLoc Loc = SMLoc()) MCExpr(MCExpr::Binary,Loc,Op)510 : MCExpr(MCExpr::Binary, Loc, Op), LHS(LHS), RHS(RHS) {} 511 512 public: 513 /// \name Construction 514 /// @{ 515 516 static const MCBinaryExpr *create(Opcode Op, const MCExpr *LHS, 517 const MCExpr *RHS, MCContext &Ctx, 518 SMLoc Loc = SMLoc()); 519 createAdd(const MCExpr * LHS,const MCExpr * RHS,MCContext & Ctx)520 static const MCBinaryExpr *createAdd(const MCExpr *LHS, const MCExpr *RHS, 521 MCContext &Ctx) { 522 return create(Add, LHS, RHS, Ctx); 523 } 524 createAnd(const MCExpr * LHS,const MCExpr * RHS,MCContext & Ctx)525 static const MCBinaryExpr *createAnd(const MCExpr *LHS, const MCExpr *RHS, 526 MCContext &Ctx) { 527 return create(And, LHS, RHS, Ctx); 528 } 529 createDiv(const MCExpr * LHS,const MCExpr * RHS,MCContext & Ctx)530 static const MCBinaryExpr *createDiv(const MCExpr *LHS, const MCExpr *RHS, 531 MCContext &Ctx) { 532 return create(Div, LHS, RHS, Ctx); 533 } 534 createEQ(const MCExpr * LHS,const MCExpr * RHS,MCContext & Ctx)535 static const MCBinaryExpr *createEQ(const MCExpr *LHS, const MCExpr *RHS, 536 MCContext &Ctx) { 537 return create(EQ, LHS, RHS, Ctx); 538 } 539 createGT(const MCExpr * LHS,const MCExpr * RHS,MCContext & Ctx)540 static const MCBinaryExpr *createGT(const MCExpr *LHS, const MCExpr *RHS, 541 MCContext &Ctx) { 542 return create(GT, LHS, RHS, Ctx); 543 } 544 createGTE(const MCExpr * LHS,const MCExpr * RHS,MCContext & Ctx)545 static const MCBinaryExpr *createGTE(const MCExpr *LHS, const MCExpr *RHS, 546 MCContext &Ctx) { 547 return create(GTE, LHS, RHS, Ctx); 548 } 549 createLAnd(const MCExpr * LHS,const MCExpr * RHS,MCContext & Ctx)550 static const MCBinaryExpr *createLAnd(const MCExpr *LHS, const MCExpr *RHS, 551 MCContext &Ctx) { 552 return create(LAnd, LHS, RHS, Ctx); 553 } 554 createLOr(const MCExpr * LHS,const MCExpr * RHS,MCContext & Ctx)555 static const MCBinaryExpr *createLOr(const MCExpr *LHS, const MCExpr *RHS, 556 MCContext &Ctx) { 557 return create(LOr, LHS, RHS, Ctx); 558 } 559 createLT(const MCExpr * LHS,const MCExpr * RHS,MCContext & Ctx)560 static const MCBinaryExpr *createLT(const MCExpr *LHS, const MCExpr *RHS, 561 MCContext &Ctx) { 562 return create(LT, LHS, RHS, Ctx); 563 } 564 createLTE(const MCExpr * LHS,const MCExpr * RHS,MCContext & Ctx)565 static const MCBinaryExpr *createLTE(const MCExpr *LHS, const MCExpr *RHS, 566 MCContext &Ctx) { 567 return create(LTE, LHS, RHS, Ctx); 568 } 569 createMod(const MCExpr * LHS,const MCExpr * RHS,MCContext & Ctx)570 static const MCBinaryExpr *createMod(const MCExpr *LHS, const MCExpr *RHS, 571 MCContext &Ctx) { 572 return create(Mod, LHS, RHS, Ctx); 573 } 574 createMul(const MCExpr * LHS,const MCExpr * RHS,MCContext & Ctx)575 static const MCBinaryExpr *createMul(const MCExpr *LHS, const MCExpr *RHS, 576 MCContext &Ctx) { 577 return create(Mul, LHS, RHS, Ctx); 578 } 579 createNE(const MCExpr * LHS,const MCExpr * RHS,MCContext & Ctx)580 static const MCBinaryExpr *createNE(const MCExpr *LHS, const MCExpr *RHS, 581 MCContext &Ctx) { 582 return create(NE, LHS, RHS, Ctx); 583 } 584 createOr(const MCExpr * LHS,const MCExpr * RHS,MCContext & Ctx)585 static const MCBinaryExpr *createOr(const MCExpr *LHS, const MCExpr *RHS, 586 MCContext &Ctx) { 587 return create(Or, LHS, RHS, Ctx); 588 } 589 createShl(const MCExpr * LHS,const MCExpr * RHS,MCContext & Ctx)590 static const MCBinaryExpr *createShl(const MCExpr *LHS, const MCExpr *RHS, 591 MCContext &Ctx) { 592 return create(Shl, LHS, RHS, Ctx); 593 } 594 createAShr(const MCExpr * LHS,const MCExpr * RHS,MCContext & Ctx)595 static const MCBinaryExpr *createAShr(const MCExpr *LHS, const MCExpr *RHS, 596 MCContext &Ctx) { 597 return create(AShr, LHS, RHS, Ctx); 598 } 599 createLShr(const MCExpr * LHS,const MCExpr * RHS,MCContext & Ctx)600 static const MCBinaryExpr *createLShr(const MCExpr *LHS, const MCExpr *RHS, 601 MCContext &Ctx) { 602 return create(LShr, LHS, RHS, Ctx); 603 } 604 createSub(const MCExpr * LHS,const MCExpr * RHS,MCContext & Ctx)605 static const MCBinaryExpr *createSub(const MCExpr *LHS, const MCExpr *RHS, 606 MCContext &Ctx) { 607 return create(Sub, LHS, RHS, Ctx); 608 } 609 createXor(const MCExpr * LHS,const MCExpr * RHS,MCContext & Ctx)610 static const MCBinaryExpr *createXor(const MCExpr *LHS, const MCExpr *RHS, 611 MCContext &Ctx) { 612 return create(Xor, LHS, RHS, Ctx); 613 } 614 615 /// @} 616 /// \name Accessors 617 /// @{ 618 619 /// Get the kind of this binary expression. getOpcode()620 Opcode getOpcode() const { return (Opcode)getSubclassData(); } 621 622 /// Get the left-hand side expression of the binary operator. getLHS()623 const MCExpr *getLHS() const { return LHS; } 624 625 /// Get the right-hand side expression of the binary operator. getRHS()626 const MCExpr *getRHS() const { return RHS; } 627 628 /// @} 629 classof(const MCExpr * E)630 static bool classof(const MCExpr *E) { 631 return E->getKind() == MCExpr::Binary; 632 } 633 }; 634 635 /// This is an extension point for target-specific MCExpr subclasses to 636 /// implement. 637 /// 638 /// NOTE: All subclasses are required to have trivial destructors because 639 /// MCExprs are bump pointer allocated and not destructed. 640 class MCTargetExpr : public MCExpr { 641 virtual void anchor(); 642 643 protected: MCTargetExpr()644 MCTargetExpr() : MCExpr(Target, SMLoc()) {} 645 virtual ~MCTargetExpr() = default; 646 647 public: 648 virtual void printImpl(raw_ostream &OS, const MCAsmInfo *MAI) const = 0; 649 virtual bool evaluateAsRelocatableImpl(MCValue &Res, 650 const MCAsmLayout *Layout, 651 const MCFixup *Fixup) const = 0; 652 // allow Target Expressions to be checked for equality isEqualTo(const MCExpr * x)653 virtual bool isEqualTo(const MCExpr *x) const { return false; } 654 // This should be set when assigned expressions are not valid ".set" 655 // expressions, e.g. registers, and must be inlined. inlineAssignedExpr()656 virtual bool inlineAssignedExpr() const { return false; } 657 virtual void visitUsedExpr(MCStreamer& Streamer) const = 0; 658 virtual MCFragment *findAssociatedFragment() const = 0; 659 660 virtual void fixELFSymbolsInTLSFixups(MCAssembler &) const = 0; 661 classof(const MCExpr * E)662 static bool classof(const MCExpr *E) { 663 return E->getKind() == MCExpr::Target; 664 } 665 }; 666 667 } // end namespace llvm 668 669 #endif // LLVM_MC_MCEXPR_H 670