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