lib/MC/MCExpr.cpp

   1 //===- MCExpr.cpp - Assembly Level Expression Implementation --------------===//
   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 "llvm/MC/MCExpr.h"
  11 #include "llvm/ADT/Statistic.h"
  12 #include "llvm/ADT/StringSwitch.h"
  13 #include "llvm/MC/MCAsmInfo.h"
  14 #include "llvm/MC/MCAsmLayout.h"
  15 #include "llvm/MC/MCAssembler.h"
  16 #include "llvm/MC/MCContext.h"
  17 #include "llvm/MC/MCObjectWriter.h"
  18 #include "llvm/MC/MCSymbol.h"
  19 #include "llvm/MC/MCValue.h"
  20 #include "llvm/Support/Debug.h"
  21 #include "llvm/Support/ErrorHandling.h"
  22 #include "llvm/Support/raw_ostream.h"
  23 using namespace llvm;
  24
  25 #define DEBUG_TYPE "mcexpr"
  26
  27 namespace {
  28 namespace stats {
  29 STATISTIC(MCExprEvaluate, "Number of MCExpr evaluations");
  30 }
  31 }
  32
  33 void MCExpr::print(raw_ostream &OS, const MCAsmInfo *MAI) const {
  34   switch (getKind()) {
  35   case MCExpr::Target:
  36     return cast<MCTargetExpr>(this)->printImpl(OS, MAI);
  37   case MCExpr::Constant:
  38     OS << cast<MCConstantExpr>(*this).getValue();
  39     return;
  40
  41   case MCExpr::SymbolRef: {
  42     const MCSymbolRefExpr &SRE = cast<MCSymbolRefExpr>(*this);
  43     const MCSymbol &Sym = SRE.getSymbol();
  44     // Parenthesize names that start with $ so that they don't look like
  45     // absolute names.
  46     bool UseParens = Sym.getName().size() && Sym.getName()[0] == '$';
  47     if (UseParens) {
  48       OS << '(';
  49       Sym.print(OS, MAI);
  50       OS << ')';
  51     } else
  52       Sym.print(OS, MAI);
  53
  54     if (SRE.getKind() != MCSymbolRefExpr::VK_None)
  55       SRE.printVariantKind(OS);
  56
  57     return;
  58   }
  59
  60   case MCExpr::Unary: {
  61     const MCUnaryExpr &UE = cast<MCUnaryExpr>(*this);
  62     switch (UE.getOpcode()) {
  63     case MCUnaryExpr::LNot:  OS << '!'; break;
  64     case MCUnaryExpr::Minus: OS << '-'; break;
  65     case MCUnaryExpr::Not:   OS << '~'; break;
  66     case MCUnaryExpr::Plus:  OS << '+'; break;
  67     }
  68     UE.getSubExpr()->print(OS, MAI);
  69     return;
  70   }
  71
  72   case MCExpr::Binary: {
  73     const MCBinaryExpr &BE = cast<MCBinaryExpr>(*this);
  74
  75     // Only print parens around the LHS if it is non-trivial.
  76     if (isa<MCConstantExpr>(BE.getLHS()) || isa<MCSymbolRefExpr>(BE.getLHS())) {
  77       BE.getLHS()->print(OS, MAI);
  78     } else {
  79       OS << '(';
  80       BE.getLHS()->print(OS, MAI);
  81       OS << ')';
  82     }
  83
  84     switch (BE.getOpcode()) {
  85     case MCBinaryExpr::Add:
  86       // Print "X-42" instead of "X+-42".
  87       if (const MCConstantExpr *RHSC = dyn_cast<MCConstantExpr>(BE.getRHS())) {
  88         if (RHSC->getValue() < 0) {
  89           OS << RHSC->getValue();
  90           return;
  91         }
  92       }
  93
  94       OS <<  '+';
  95       break;
  96     case MCBinaryExpr::AShr: OS << ">>"; break;
  97     case MCBinaryExpr::And:  OS <<  '&'; break;
  98     case MCBinaryExpr::Div:  OS <<  '/'; break;
  99     case MCBinaryExpr::EQ:   OS << "=="; break;
 100     case MCBinaryExpr::GT:   OS <<  '>'; break;
 101     case MCBinaryExpr::GTE:  OS << ">="; break;
 102     case MCBinaryExpr::LAnd: OS << "&&"; break;
 103     case MCBinaryExpr::LOr:  OS << "||"; break;
 104     case MCBinaryExpr::LShr: OS << ">>"; break;
 105     case MCBinaryExpr::LT:   OS <<  '<'; break;
 106     case MCBinaryExpr::LTE:  OS << "<="; break;
 107     case MCBinaryExpr::Mod:  OS <<  '%'; break;
 108     case MCBinaryExpr::Mul:  OS <<  '*'; break;
 109     case MCBinaryExpr::NE:   OS << "!="; break;
 110     case MCBinaryExpr::Or:   OS <<  '|'; break;
 111     case MCBinaryExpr::Shl:  OS << "<<"; break;
 112     case MCBinaryExpr::Sub:  OS <<  '-'; break;
 113     case MCBinaryExpr::Xor:  OS <<  '^'; break;
 114     }
 115
 116     // Only print parens around the LHS if it is non-trivial.
 117     if (isa<MCConstantExpr>(BE.getRHS()) || isa<MCSymbolRefExpr>(BE.getRHS())) {
 118       BE.getRHS()->print(OS, MAI);
 119     } else {
 120       OS << '(';
 121       BE.getRHS()->print(OS, MAI);
 122       OS << ')';
 123     }
 124     return;
 125   }
 126   }
 127
 128   llvm_unreachable("Invalid expression kind!");
 129 }
 130
 131 #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
 132 void MCExpr::dump() const {
 133   dbgs() << *this;
 134   dbgs() << '\n';
 135 }
 136 #endif
 137
 138 /* *** */
 139
 140 const MCBinaryExpr *MCBinaryExpr::create(Opcode Opc, const MCExpr *LHS,
 141                                          const MCExpr *RHS, MCContext &Ctx) {
 142   return new (Ctx) MCBinaryExpr(Opc, LHS, RHS);
 143 }
 144
 145 const MCUnaryExpr *MCUnaryExpr::create(Opcode Opc, const MCExpr *Expr,
 146                                        MCContext &Ctx) {
 147   return new (Ctx) MCUnaryExpr(Opc, Expr);
 148 }
 149
 150 const MCConstantExpr *MCConstantExpr::create(int64_t Value, MCContext &Ctx) {
 151   return new (Ctx) MCConstantExpr(Value);
 152 }
 153
 154 /* *** */
 155
 156 MCSymbolRefExpr::MCSymbolRefExpr(const MCSymbol *Symbol, VariantKind Kind,
 157                                  const MCAsmInfo *MAI)
 158     : MCExpr(MCExpr::SymbolRef), Kind(Kind),
 159       UseParensForSymbolVariant(MAI->useParensForSymbolVariant()),
 160       HasSubsectionsViaSymbols(MAI->hasSubsectionsViaSymbols()),
 161       Symbol(Symbol) {
 162   assert(Symbol);
 163 }
 164
 165 const MCSymbolRefExpr *MCSymbolRefExpr::create(const MCSymbol *Sym,
 166                                                VariantKind Kind,
 167                                                MCContext &Ctx) {
 168   return new (Ctx) MCSymbolRefExpr(Sym, Kind, Ctx.getAsmInfo());
 169 }
 170
 171 const MCSymbolRefExpr *MCSymbolRefExpr::create(StringRef Name, VariantKind Kind,
 172                                                MCContext &Ctx) {
 173   return create(Ctx.getOrCreateSymbol(Name), Kind, Ctx);
 174 }
 175
 176 StringRef MCSymbolRefExpr::getVariantKindName(VariantKind Kind) {
 177   switch (Kind) {
 178   case VK_Invalid: return "<<invalid>>";
 179   case VK_None: return "<<none>>";
 180
 181   case VK_GOT: return "GOT";
 182   case VK_GOTOFF: return "GOTOFF";
 183   case VK_GOTPCREL: return "GOTPCREL";
 184   case VK_GOTTPOFF: return "GOTTPOFF";
 185   case VK_INDNTPOFF: return "INDNTPOFF";
 186   case VK_NTPOFF: return "NTPOFF";
 187   case VK_GOTNTPOFF: return "GOTNTPOFF";
 188   case VK_PLT: return "PLT";
 189   case VK_TLSGD: return "TLSGD";
 190   case VK_TLSLD: return "TLSLD";
 191   case VK_TLSLDM: return "TLSLDM";
 192   case VK_TPOFF: return "TPOFF";
 193   case VK_DTPOFF: return "DTPOFF";
 194   case VK_TLVP: return "TLVP";
 195   case VK_TLVPPAGE: return "TLVPPAGE";
 196   case VK_TLVPPAGEOFF: return "TLVPPAGEOFF";
 197   case VK_PAGE: return "PAGE";
 198   case VK_PAGEOFF: return "PAGEOFF";
 199   case VK_GOTPAGE: return "GOTPAGE";
 200   case VK_GOTPAGEOFF: return "GOTPAGEOFF";
 201   case VK_SECREL: return "SECREL32";
 202   case VK_SIZE: return "SIZE";
 203   case VK_WEAKREF: return "WEAKREF";
 204   case VK_ARM_NONE: return "none";
 205   case VK_ARM_GOT_PREL: return "GOT_PREL";
 206   case VK_ARM_TARGET1: return "target1";
 207   case VK_ARM_TARGET2: return "target2";
 208   case VK_ARM_PREL31: return "prel31";
 209   case VK_ARM_SBREL: return "sbrel";
 210   case VK_ARM_TLSLDO: return "tlsldo";
 211   case VK_ARM_TLSCALL: return "tlscall";
 212   case VK_ARM_TLSDESC: return "tlsdesc";
 213   case VK_ARM_TLSDESCSEQ: return "tlsdescseq";
 214   case VK_PPC_LO: return "l";
 215   case VK_PPC_HI: return "h";
 216   case VK_PPC_HA: return "ha";
 217   case VK_PPC_HIGHER: return "higher";
 218   case VK_PPC_HIGHERA: return "highera";
 219   case VK_PPC_HIGHEST: return "highest";
 220   case VK_PPC_HIGHESTA: return "highesta";
 221   case VK_PPC_GOT_LO: return "got@l";
 222   case VK_PPC_GOT_HI: return "got@h";
 223   case VK_PPC_GOT_HA: return "got@ha";
 224   case VK_PPC_TOCBASE: return "tocbase";
 225   case VK_PPC_TOC: return "toc";
 226   case VK_PPC_TOC_LO: return "toc@l";
 227   case VK_PPC_TOC_HI: return "toc@h";
 228   case VK_PPC_TOC_HA: return "toc@ha";
 229   case VK_PPC_DTPMOD: return "dtpmod";
 230   case VK_PPC_TPREL: return "tprel";
 231   case VK_PPC_TPREL_LO: return "tprel@l";
 232   case VK_PPC_TPREL_HI: return "tprel@h";
 233   case VK_PPC_TPREL_HA: return "tprel@ha";
 234   case VK_PPC_TPREL_HIGHER: return "tprel@higher";
 235   case VK_PPC_TPREL_HIGHERA: return "tprel@highera";
 236   case VK_PPC_TPREL_HIGHEST: return "tprel@highest";
 237   case VK_PPC_TPREL_HIGHESTA: return "tprel@highesta";
 238   case VK_PPC_DTPREL: return "dtprel";
 239   case VK_PPC_DTPREL_LO: return "dtprel@l";
 240   case VK_PPC_DTPREL_HI: return "dtprel@h";
 241   case VK_PPC_DTPREL_HA: return "dtprel@ha";
 242   case VK_PPC_DTPREL_HIGHER: return "dtprel@higher";
 243   case VK_PPC_DTPREL_HIGHERA: return "dtprel@highera";
 244   case VK_PPC_DTPREL_HIGHEST: return "dtprel@highest";
 245   case VK_PPC_DTPREL_HIGHESTA: return "dtprel@highesta";
 246   case VK_PPC_GOT_TPREL: return "got@tprel";
 247   case VK_PPC_GOT_TPREL_LO: return "got@tprel@l";
 248   case VK_PPC_GOT_TPREL_HI: return "got@tprel@h";
 249   case VK_PPC_GOT_TPREL_HA: return "got@tprel@ha";
 250   case VK_PPC_GOT_DTPREL: return "got@dtprel";
 251   case VK_PPC_GOT_DTPREL_LO: return "got@dtprel@l";
 252   case VK_PPC_GOT_DTPREL_HI: return "got@dtprel@h";
 253   case VK_PPC_GOT_DTPREL_HA: return "got@dtprel@ha";
 254   case VK_PPC_TLS: return "tls";
 255   case VK_PPC_GOT_TLSGD: return "got@tlsgd";
 256   case VK_PPC_GOT_TLSGD_LO: return "got@tlsgd@l";
 257   case VK_PPC_GOT_TLSGD_HI: return "got@tlsgd@h";
 258   case VK_PPC_GOT_TLSGD_HA: return "got@tlsgd@ha";
 259   case VK_PPC_TLSGD: return "tlsgd";
 260   case VK_PPC_GOT_TLSLD: return "got@tlsld";
 261   case VK_PPC_GOT_TLSLD_LO: return "got@tlsld@l";
 262   case VK_PPC_GOT_TLSLD_HI: return "got@tlsld@h";
 263   case VK_PPC_GOT_TLSLD_HA: return "got@tlsld@ha";
 264   case VK_PPC_TLSLD: return "tlsld";
 265   case VK_PPC_LOCAL: return "local";
 266   case VK_Mips_GPREL: return "GPREL";
 267   case VK_Mips_GOT_CALL: return "GOT_CALL";
 268   case VK_Mips_GOT16: return "GOT16";
 269   case VK_Mips_GOT: return "GOT";
 270   case VK_Mips_ABS_HI: return "ABS_HI";
 271   case VK_Mips_ABS_LO: return "ABS_LO";
 272   case VK_Mips_TLSGD: return "TLSGD";
 273   case VK_Mips_TLSLDM: return "TLSLDM";
 274   case VK_Mips_DTPREL_HI: return "DTPREL_HI";
 275   case VK_Mips_DTPREL_LO: return "DTPREL_LO";
 276   case VK_Mips_GOTTPREL: return "GOTTPREL";
 277   case VK_Mips_TPREL_HI: return "TPREL_HI";
 278   case VK_Mips_TPREL_LO: return "TPREL_LO";
 279   case VK_Mips_GPOFF_HI: return "GPOFF_HI";
 280   case VK_Mips_GPOFF_LO: return "GPOFF_LO";
 281   case VK_Mips_GOT_DISP: return "GOT_DISP";
 282   case VK_Mips_GOT_PAGE: return "GOT_PAGE";
 283   case VK_Mips_GOT_OFST: return "GOT_OFST";
 284   case VK_Mips_HIGHER:   return "HIGHER";
 285   case VK_Mips_HIGHEST:  return "HIGHEST";
 286   case VK_Mips_GOT_HI16: return "GOT_HI16";
 287   case VK_Mips_GOT_LO16: return "GOT_LO16";
 288   case VK_Mips_CALL_HI16: return "CALL_HI16";
 289   case VK_Mips_CALL_LO16: return "CALL_LO16";
 290   case VK_Mips_PCREL_HI16: return "PCREL_HI16";
 291   case VK_Mips_PCREL_LO16: return "PCREL_LO16";
 292   case VK_COFF_IMGREL32: return "IMGREL";
 293   case VK_Hexagon_PCREL: return "PCREL";
 294   case VK_Hexagon_LO16: return "LO16";
 295   case VK_Hexagon_HI16: return "HI16";
 296   case VK_Hexagon_GPREL: return "GPREL";
 297   case VK_Hexagon_GD_GOT: return "GDGOT";
 298   case VK_Hexagon_LD_GOT: return "LDGOT";
 299   case VK_Hexagon_GD_PLT: return "GDPLT";
 300   case VK_Hexagon_LD_PLT: return "LDPLT";
 301   case VK_Hexagon_IE: return "IE";
 302   case VK_Hexagon_IE_GOT: return "IEGOT";
 303   case VK_WebAssembly_FUNCTION: return "FUNCTION";
 304   case VK_TPREL: return "tprel";
 305   case VK_DTPREL: return "dtprel";
 306   }
 307   llvm_unreachable("Invalid variant kind");
 308 }
 309
 310 MCSymbolRefExpr::VariantKind
 311 MCSymbolRefExpr::getVariantKindForName(StringRef Name) {
 312   return StringSwitch<VariantKind>(Name.lower())
 313     .Case("got", VK_GOT)
 314     .Case("gotoff", VK_GOTOFF)
 315     .Case("gotpcrel", VK_GOTPCREL)
 316     .Case("gottpoff", VK_GOTTPOFF)
 317     .Case("indntpoff", VK_INDNTPOFF)
 318     .Case("ntpoff", VK_NTPOFF)
 319     .Case("gotntpoff", VK_GOTNTPOFF)
 320     .Case("plt", VK_PLT)
 321     .Case("tlsgd", VK_TLSGD)
 322     .Case("tlsld", VK_TLSLD)
 323     .Case("tlsldm", VK_TLSLDM)
 324     .Case("tpoff", VK_TPOFF)
 325     .Case("dtpoff", VK_DTPOFF)
 326     .Case("tlvp", VK_TLVP)
 327     .Case("tlvppage", VK_TLVPPAGE)
 328     .Case("tlvppageoff", VK_TLVPPAGEOFF)
 329     .Case("page", VK_PAGE)
 330     .Case("pageoff", VK_PAGEOFF)
 331     .Case("gotpage", VK_GOTPAGE)
 332     .Case("gotpageoff", VK_GOTPAGEOFF)
 333     .Case("imgrel", VK_COFF_IMGREL32)
 334     .Case("secrel32", VK_SECREL)
 335     .Case("size", VK_SIZE)
 336     .Case("l", VK_PPC_LO)
 337     .Case("h", VK_PPC_HI)
 338     .Case("ha", VK_PPC_HA)
 339     .Case("higher", VK_PPC_HIGHER)
 340     .Case("highera", VK_PPC_HIGHERA)
 341     .Case("highest", VK_PPC_HIGHEST)
 342     .Case("highesta", VK_PPC_HIGHESTA)
 343     .Case("got@l", VK_PPC_GOT_LO)
 344     .Case("got@h", VK_PPC_GOT_HI)
 345     .Case("got@ha", VK_PPC_GOT_HA)
 346     .Case("local", VK_PPC_LOCAL)
 347     .Case("tocbase", VK_PPC_TOCBASE)
 348     .Case("toc", VK_PPC_TOC)
 349     .Case("toc@l", VK_PPC_TOC_LO)
 350     .Case("toc@h", VK_PPC_TOC_HI)
 351     .Case("toc@ha", VK_PPC_TOC_HA)
 352     .Case("tls", VK_PPC_TLS)
 353     .Case("dtpmod", VK_PPC_DTPMOD)
 354     .Case("tprel", VK_PPC_TPREL)
 355     .Case("tprel@l", VK_PPC_TPREL_LO)
 356     .Case("tprel@h", VK_PPC_TPREL_HI)
 357     .Case("tprel@ha", VK_PPC_TPREL_HA)
 358     .Case("tprel@higher", VK_PPC_TPREL_HIGHER)
 359     .Case("tprel@highera", VK_PPC_TPREL_HIGHERA)
 360     .Case("tprel@highest", VK_PPC_TPREL_HIGHEST)
 361     .Case("tprel@highesta", VK_PPC_TPREL_HIGHESTA)
 362     .Case("dtprel", VK_PPC_DTPREL)
 363     .Case("dtprel@l", VK_PPC_DTPREL_LO)
 364     .Case("dtprel@h", VK_PPC_DTPREL_HI)
 365     .Case("dtprel@ha", VK_PPC_DTPREL_HA)
 366     .Case("dtprel@higher", VK_PPC_DTPREL_HIGHER)
 367     .Case("dtprel@highera", VK_PPC_DTPREL_HIGHERA)
 368     .Case("dtprel@highest", VK_PPC_DTPREL_HIGHEST)
 369     .Case("dtprel@highesta", VK_PPC_DTPREL_HIGHESTA)
 370     .Case("got@tprel", VK_PPC_GOT_TPREL)
 371     .Case("got@tprel@l", VK_PPC_GOT_TPREL_LO)
 372     .Case("got@tprel@h", VK_PPC_GOT_TPREL_HI)
 373     .Case("got@tprel@ha", VK_PPC_GOT_TPREL_HA)
 374     .Case("got@dtprel", VK_PPC_GOT_DTPREL)
 375     .Case("got@dtprel@l", VK_PPC_GOT_DTPREL_LO)
 376     .Case("got@dtprel@h", VK_PPC_GOT_DTPREL_HI)
 377     .Case("got@dtprel@ha", VK_PPC_GOT_DTPREL_HA)
 378     .Case("got@tlsgd", VK_PPC_GOT_TLSGD)
 379     .Case("got@tlsgd@l", VK_PPC_GOT_TLSGD_LO)
 380     .Case("got@tlsgd@h", VK_PPC_GOT_TLSGD_HI)
 381     .Case("got@tlsgd@ha", VK_PPC_GOT_TLSGD_HA)
 382     .Case("got@tlsld", VK_PPC_GOT_TLSLD)
 383     .Case("got@tlsld@l", VK_PPC_GOT_TLSLD_LO)
 384     .Case("got@tlsld@h", VK_PPC_GOT_TLSLD_HI)
 385     .Case("got@tlsld@ha", VK_PPC_GOT_TLSLD_HA)
 386     .Case("gdgot", VK_Hexagon_GD_GOT)
 387     .Case("gdplt", VK_Hexagon_GD_PLT)
 388     .Case("iegot", VK_Hexagon_IE_GOT)
 389     .Case("ie", VK_Hexagon_IE)
 390     .Case("ldgot", VK_Hexagon_LD_GOT)
 391     .Case("ldplt", VK_Hexagon_LD_PLT)
 392     .Case("pcrel", VK_Hexagon_PCREL)
 393     .Case("none", VK_ARM_NONE)
 394     .Case("got_prel", VK_ARM_GOT_PREL)
 395     .Case("target1", VK_ARM_TARGET1)
 396     .Case("target2", VK_ARM_TARGET2)
 397     .Case("prel31", VK_ARM_PREL31)
 398     .Case("sbrel", VK_ARM_SBREL)
 399     .Case("tlsldo", VK_ARM_TLSLDO)
 400     .Case("tlscall", VK_ARM_TLSCALL)
 401     .Case("tlsdesc", VK_ARM_TLSDESC)
 402     .Default(VK_Invalid);
 403 }
 404
 405 void MCSymbolRefExpr::printVariantKind(raw_ostream &OS) const {
 406   if (UseParensForSymbolVariant)
 407     OS << '(' << MCSymbolRefExpr::getVariantKindName(getKind()) << ')';
 408   else
 409     OS << '@' << MCSymbolRefExpr::getVariantKindName(getKind());
 410 }
 411
 412 /* *** */
 413
 414 void MCTargetExpr::anchor() {}
 415
 416 /* *** */
 417
 418 bool MCExpr::evaluateAsAbsolute(int64_t &Res) const {
 419   return evaluateAsAbsolute(Res, nullptr, nullptr, nullptr);
 420 }
 421
 422 bool MCExpr::evaluateAsAbsolute(int64_t &Res,
 423                                 const MCAsmLayout &Layout) const {
 424   return evaluateAsAbsolute(Res, &Layout.getAssembler(), &Layout, nullptr);
 425 }
 426
 427 bool MCExpr::evaluateAsAbsolute(int64_t &Res,
 428                                 const MCAsmLayout &Layout,
 429                                 const SectionAddrMap &Addrs) const {
 430   return evaluateAsAbsolute(Res, &Layout.getAssembler(), &Layout, &Addrs);
 431 }
 432
 433 bool MCExpr::evaluateAsAbsolute(int64_t &Res, const MCAssembler &Asm) const {
 434   return evaluateAsAbsolute(Res, &Asm, nullptr, nullptr);
 435 }
 436
 437 bool MCExpr::evaluateKnownAbsolute(int64_t &Res,
 438                                    const MCAsmLayout &Layout) const {
 439   return evaluateAsAbsolute(Res, &Layout.getAssembler(), &Layout, nullptr,
 440                             true);
 441 }
 442
 443 bool MCExpr::evaluateAsAbsolute(int64_t &Res, const MCAssembler *Asm,
 444                                 const MCAsmLayout *Layout,
 445                                 const SectionAddrMap *Addrs) const {
 446   // FIXME: The use if InSet = Addrs is a hack. Setting InSet causes us
 447   // absolutize differences across sections and that is what the MachO writer
 448   // uses Addrs for.
 449   return evaluateAsAbsolute(Res, Asm, Layout, Addrs, Addrs);
 450 }
 451
 452 bool MCExpr::evaluateAsAbsolute(int64_t &Res, const MCAssembler *Asm,
 453                                 const MCAsmLayout *Layout,
 454                                 const SectionAddrMap *Addrs, bool InSet) const {
 455   MCValue Value;
 456
 457   // Fast path constants.
 458   if (const MCConstantExpr *CE = dyn_cast<MCConstantExpr>(this)) {
 459     Res = CE->getValue();
 460     return true;
 461   }
 462
 463   bool IsRelocatable =
 464       evaluateAsRelocatableImpl(Value, Asm, Layout, nullptr, Addrs, InSet);
 465
 466   // Record the current value.
 467   Res = Value.getConstant();
 468
 469   return IsRelocatable && Value.isAbsolute();
 470 }
 471
 472 /// \brief Helper method for \see EvaluateSymbolAdd().
 473 static void AttemptToFoldSymbolOffsetDifference(
 474     const MCAssembler *Asm, const MCAsmLayout *Layout,
 475     const SectionAddrMap *Addrs, bool InSet, const MCSymbolRefExpr *&A,
 476     const MCSymbolRefExpr *&B, int64_t &Addend) {
 477   if (!A || !B)
 478     return;
 479
 480   const MCSymbol &SA = A->getSymbol();
 481   const MCSymbol &SB = B->getSymbol();
 482
 483   if (SA.isUndefined() || SB.isUndefined())
 484     return;
 485
 486   if (!Asm->getWriter().isSymbolRefDifferenceFullyResolved(*Asm, A, B, InSet))
 487     return;
 488
 489   if (SA.getFragment() == SB.getFragment() && !SA.isVariable() &&
 490       !SB.isVariable()) {
 491     Addend += (SA.getOffset() - SB.getOffset());
 492
 493     // Pointers to Thumb symbols need to have their low-bit set to allow
 494     // for interworking.
 495     if (Asm->isThumbFunc(&SA))
 496       Addend |= 1;
 497
 498     // Clear the symbol expr pointers to indicate we have folded these
 499     // operands.
 500     A = B = nullptr;
 501     return;
 502   }
 503
 504   if (!Layout)
 505     return;
 506
 507   const MCSection &SecA = *SA.getFragment()->getParent();
 508   const MCSection &SecB = *SB.getFragment()->getParent();
 509
 510   if ((&SecA != &SecB) && !Addrs)
 511     return;
 512
 513   // Eagerly evaluate.
 514   Addend += Layout->getSymbolOffset(A->getSymbol()) -
 515             Layout->getSymbolOffset(B->getSymbol());
 516   if (Addrs && (&SecA != &SecB))
 517     Addend += (Addrs->lookup(&SecA) - Addrs->lookup(&SecB));
 518
 519   // Pointers to Thumb symbols need to have their low-bit set to allow
 520   // for interworking.
 521   if (Asm->isThumbFunc(&SA))
 522     Addend |= 1;
 523
 524   // Clear the symbol expr pointers to indicate we have folded these
 525   // operands.
 526   A = B = nullptr;
 527 }
 528
 529 /// \brief Evaluate the result of an add between (conceptually) two MCValues.
 530 ///
 531 /// This routine conceptually attempts to construct an MCValue:
 532 ///   Result = (Result_A - Result_B + Result_Cst)
 533 /// from two MCValue's LHS and RHS where
 534 ///   Result = LHS + RHS
 535 /// and
 536 ///   Result = (LHS_A - LHS_B + LHS_Cst) + (RHS_A - RHS_B + RHS_Cst).
 537 ///
 538 /// This routine attempts to aggresively fold the operands such that the result
 539 /// is representable in an MCValue, but may not always succeed.
 540 ///
 541 /// \returns True on success, false if the result is not representable in an
 542 /// MCValue.
 543
 544 /// NOTE: It is really important to have both the Asm and Layout arguments.
 545 /// They might look redundant, but this function can be used before layout
 546 /// is done (see the object streamer for example) and having the Asm argument
 547 /// lets us avoid relaxations early.
 548 static bool
 549 EvaluateSymbolicAdd(const MCAssembler *Asm, const MCAsmLayout *Layout,
 550                     const SectionAddrMap *Addrs, bool InSet, const MCValue &LHS,
 551                     const MCSymbolRefExpr *RHS_A, const MCSymbolRefExpr *RHS_B,
 552                     int64_t RHS_Cst, MCValue &Res) {
 553   // FIXME: This routine (and other evaluation parts) are *incredibly* sloppy
 554   // about dealing with modifiers. This will ultimately bite us, one day.
 555   const MCSymbolRefExpr *LHS_A = LHS.getSymA();
 556   const MCSymbolRefExpr *LHS_B = LHS.getSymB();
 557   int64_t LHS_Cst = LHS.getConstant();
 558
 559   // Fold the result constant immediately.
 560   int64_t Result_Cst = LHS_Cst + RHS_Cst;
 561
 562   assert((!Layout || Asm) &&
 563          "Must have an assembler object if layout is given!");
 564
 565   // If we have a layout, we can fold resolved differences.
 566   if (Asm) {
 567     // First, fold out any differences which are fully resolved. By
 568     // reassociating terms in
 569     //   Result = (LHS_A - LHS_B + LHS_Cst) + (RHS_A - RHS_B + RHS_Cst).
 570     // we have the four possible differences:
 571     //   (LHS_A - LHS_B),
 572     //   (LHS_A - RHS_B),
 573     //   (RHS_A - LHS_B),
 574     //   (RHS_A - RHS_B).
 575     // Since we are attempting to be as aggressive as possible about folding, we
 576     // attempt to evaluate each possible alternative.
 577     AttemptToFoldSymbolOffsetDifference(Asm, Layout, Addrs, InSet, LHS_A, LHS_B,
 578                                         Result_Cst);
 579     AttemptToFoldSymbolOffsetDifference(Asm, Layout, Addrs, InSet, LHS_A, RHS_B,
 580                                         Result_Cst);
 581     AttemptToFoldSymbolOffsetDifference(Asm, Layout, Addrs, InSet, RHS_A, LHS_B,
 582                                         Result_Cst);
 583     AttemptToFoldSymbolOffsetDifference(Asm, Layout, Addrs, InSet, RHS_A, RHS_B,
 584                                         Result_Cst);
 585   }
 586
 587   // We can't represent the addition or subtraction of two symbols.
 588   if ((LHS_A && RHS_A) || (LHS_B && RHS_B))
 589     return false;
 590
 591   // At this point, we have at most one additive symbol and one subtractive
 592   // symbol -- find them.
 593   const MCSymbolRefExpr *A = LHS_A ? LHS_A : RHS_A;
 594   const MCSymbolRefExpr *B = LHS_B ? LHS_B : RHS_B;
 595
 596   Res = MCValue::get(A, B, Result_Cst);
 597   return true;
 598 }
 599
 600 bool MCExpr::evaluateAsRelocatable(MCValue &Res,
 601                                    const MCAsmLayout *Layout,
 602                                    const MCFixup *Fixup) const {
 603   MCAssembler *Assembler = Layout ? &Layout->getAssembler() : nullptr;
 604   return evaluateAsRelocatableImpl(Res, Assembler, Layout, Fixup, nullptr,
 605                                    false);
 606 }
 607
 608 bool MCExpr::evaluateAsValue(MCValue &Res, const MCAsmLayout &Layout) const {
 609   MCAssembler *Assembler = &Layout.getAssembler();
 610   return evaluateAsRelocatableImpl(Res, Assembler, &Layout, nullptr, nullptr,
 611                                    true);
 612 }
 613
 614 static bool canExpand(const MCSymbol &Sym, bool InSet) {
 615   const MCExpr *Expr = Sym.getVariableValue();
 616   const auto *Inner = dyn_cast<MCSymbolRefExpr>(Expr);
 617   if (Inner) {
 618     if (Inner->getKind() == MCSymbolRefExpr::VK_WEAKREF)
 619       return false;
 620   }
 621
 622   if (InSet)
 623     return true;
 624   return !Sym.isInSection();
 625 }
 626
 627 bool MCExpr::evaluateAsRelocatableImpl(MCValue &Res, const MCAssembler *Asm,
 628                                        const MCAsmLayout *Layout,
 629                                        const MCFixup *Fixup,
 630                                        const SectionAddrMap *Addrs,
 631                                        bool InSet) const {
 632   ++stats::MCExprEvaluate;
 633
 634   switch (getKind()) {
 635   case Target:
 636     return cast<MCTargetExpr>(this)->evaluateAsRelocatableImpl(Res, Layout,
 637                                                                Fixup);
 638
 639   case Constant:
 640     Res = MCValue::get(cast<MCConstantExpr>(this)->getValue());
 641     return true;
 642
 643   case SymbolRef: {
 644     const MCSymbolRefExpr *SRE = cast<MCSymbolRefExpr>(this);
 645     const MCSymbol &Sym = SRE->getSymbol();
 646
 647     // Evaluate recursively if this is a variable.
 648     if (Sym.isVariable() && SRE->getKind() == MCSymbolRefExpr::VK_None &&
 649         canExpand(Sym, InSet)) {
 650       bool IsMachO = SRE->hasSubsectionsViaSymbols();
 651       if (Sym.getVariableValue()->evaluateAsRelocatableImpl(
 652               Res, Asm, Layout, Fixup, Addrs, InSet || IsMachO)) {
 653         if (!IsMachO)
 654           return true;
 655
 656         const MCSymbolRefExpr *A = Res.getSymA();
 657         const MCSymbolRefExpr *B = Res.getSymB();
 658         // FIXME: This is small hack. Given
 659         // a = b + 4
 660         // .long a
 661         // the OS X assembler will completely drop the 4. We should probably
 662         // include it in the relocation or produce an error if that is not
 663         // possible.
 664         if (!A && !B)
 665           return true;
 666       }
 667     }
 668
 669     Res = MCValue::get(SRE, nullptr, 0);
 670     return true;
 671   }
 672
 673   case Unary: {
 674     const MCUnaryExpr *AUE = cast<MCUnaryExpr>(this);
 675     MCValue Value;
 676
 677     if (!AUE->getSubExpr()->evaluateAsRelocatableImpl(Value, Asm, Layout, Fixup,
 678                                                       Addrs, InSet))
 679       return false;
 680
 681     switch (AUE->getOpcode()) {
 682     case MCUnaryExpr::LNot:
 683       if (!Value.isAbsolute())
 684         return false;
 685       Res = MCValue::get(!Value.getConstant());
 686       break;
 687     case MCUnaryExpr::Minus:
 688       /// -(a - b + const) ==> (b - a - const)
 689       if (Value.getSymA() && !Value.getSymB())
 690         return false;
 691       Res = MCValue::get(Value.getSymB(), Value.getSymA(),
 692                          -Value.getConstant());
 693       break;
 694     case MCUnaryExpr::Not:
 695       if (!Value.isAbsolute())
 696         return false;
 697       Res = MCValue::get(~Value.getConstant());
 698       break;
 699     case MCUnaryExpr::Plus:
 700       Res = Value;
 701       break;
 702     }
 703
 704     return true;
 705   }
 706
 707   case Binary: {
 708     const MCBinaryExpr *ABE = cast<MCBinaryExpr>(this);
 709     MCValue LHSValue, RHSValue;
 710
 711     if (!ABE->getLHS()->evaluateAsRelocatableImpl(LHSValue, Asm, Layout, Fixup,
 712                                                   Addrs, InSet) ||
 713         !ABE->getRHS()->evaluateAsRelocatableImpl(RHSValue, Asm, Layout, Fixup,
 714                                                   Addrs, InSet))
 715       return false;
 716
 717     // We only support a few operations on non-constant expressions, handle
 718     // those first.
 719     if (!LHSValue.isAbsolute() || !RHSValue.isAbsolute()) {
 720       switch (ABE->getOpcode()) {
 721       default:
 722         return false;
 723       case MCBinaryExpr::Sub:
 724         // Negate RHS and add.
 725         return EvaluateSymbolicAdd(Asm, Layout, Addrs, InSet, LHSValue,
 726                                    RHSValue.getSymB(), RHSValue.getSymA(),
 727                                    -RHSValue.getConstant(), Res);
 728
 729       case MCBinaryExpr::Add:
 730         return EvaluateSymbolicAdd(Asm, Layout, Addrs, InSet, LHSValue,
 731                                    RHSValue.getSymA(), RHSValue.getSymB(),
 732                                    RHSValue.getConstant(), Res);
 733       }
 734     }
 735
 736     // FIXME: We need target hooks for the evaluation. It may be limited in
 737     // width, and gas defines the result of comparisons differently from
 738     // Apple as.
 739     int64_t LHS = LHSValue.getConstant(), RHS = RHSValue.getConstant();
 740     int64_t Result = 0;
 741     switch (ABE->getOpcode()) {
 742     case MCBinaryExpr::AShr: Result = LHS >> RHS; break;
 743     case MCBinaryExpr::Add:  Result = LHS + RHS; break;
 744     case MCBinaryExpr::And:  Result = LHS & RHS; break;
 745     case MCBinaryExpr::Div:
 746       // Handle division by zero. gas just emits a warning and keeps going,
 747       // we try to be stricter.
 748       // FIXME: Currently the caller of this function has no way to understand
 749       // we're bailing out because of 'division by zero'. Therefore, it will
 750       // emit a 'expected relocatable expression' error. It would be nice to
 751       // change this code to emit a better diagnostic.
 752       if (RHS == 0)
 753         return false;
 754       Result = LHS / RHS;
 755       break;
 756     case MCBinaryExpr::EQ:   Result = LHS == RHS; break;
 757     case MCBinaryExpr::GT:   Result = LHS > RHS; break;
 758     case MCBinaryExpr::GTE:  Result = LHS >= RHS; break;
 759     case MCBinaryExpr::LAnd: Result = LHS && RHS; break;
 760     case MCBinaryExpr::LOr:  Result = LHS || RHS; break;
 761     case MCBinaryExpr::LShr: Result = uint64_t(LHS) >> uint64_t(RHS); break;
 762     case MCBinaryExpr::LT:   Result = LHS < RHS; break;
 763     case MCBinaryExpr::LTE:  Result = LHS <= RHS; break;
 764     case MCBinaryExpr::Mod:  Result = LHS % RHS; break;
 765     case MCBinaryExpr::Mul:  Result = LHS * RHS; break;
 766     case MCBinaryExpr::NE:   Result = LHS != RHS; break;
 767     case MCBinaryExpr::Or:   Result = LHS | RHS; break;
 768     case MCBinaryExpr::Shl:  Result = uint64_t(LHS) << uint64_t(RHS); break;
 769     case MCBinaryExpr::Sub:  Result = LHS - RHS; break;
 770     case MCBinaryExpr::Xor:  Result = LHS ^ RHS; break;
 771     }
 772
 773     Res = MCValue::get(Result);
 774     return true;
 775   }
 776   }
 777
 778   llvm_unreachable("Invalid assembly expression kind!");
 779 }
 780
 781 MCFragment *MCExpr::findAssociatedFragment() const {
 782   switch (getKind()) {
 783   case Target:
 784     // We never look through target specific expressions.
 785     return cast<MCTargetExpr>(this)->findAssociatedFragment();
 786
 787   case Constant:
 788     return MCSymbol::AbsolutePseudoFragment;
 789
 790   case SymbolRef: {
 791     const MCSymbolRefExpr *SRE = cast<MCSymbolRefExpr>(this);
 792     const MCSymbol &Sym = SRE->getSymbol();
 793     return Sym.getFragment();
 794   }
 795
 796   case Unary:
 797     return cast<MCUnaryExpr>(this)->getSubExpr()->findAssociatedFragment();
 798
 799   case Binary: {
 800     const MCBinaryExpr *BE = cast<MCBinaryExpr>(this);
 801     MCFragment *LHS_F = BE->getLHS()->findAssociatedFragment();
 802     MCFragment *RHS_F = BE->getRHS()->findAssociatedFragment();
 803
 804     // If either is absolute, return the other.
 805     if (LHS_F == MCSymbol::AbsolutePseudoFragment)
 806       return RHS_F;
 807     if (RHS_F == MCSymbol::AbsolutePseudoFragment)
 808       return LHS_F;
 809
 810     // Not always correct, but probably the best we can do without more context.
 811     if (BE->getOpcode() == MCBinaryExpr::Sub)
 812       return MCSymbol::AbsolutePseudoFragment;
 813
 814     // Otherwise, return the first non-null fragment.
 815     return LHS_F ? LHS_F : RHS_F;
 816   }
 817   }
 818
 819   llvm_unreachable("Invalid assembly expression kind!");
 820 }