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   case VK_Hexagon_PCREL: return "PCREL";
 287   case VK_Hexagon_LO16: return "LO16";
 288   case VK_Hexagon_HI16: return "HI16";
 289   case VK_Hexagon_GPREL: return "GPREL";
 290   case VK_Hexagon_GD_GOT: return "GDGOT";
 291   case VK_Hexagon_LD_GOT: return "LDGOT";
 292   case VK_Hexagon_GD_PLT: return "GDPLT";
 293   case VK_Hexagon_LD_PLT: return "LDPLT";
 294   case VK_Hexagon_IE: return "IE";
 295   case VK_Hexagon_IE_GOT: return "IEGOT";
 296   case VK_TPREL: return "tprel";
 297   case VK_DTPREL: return "dtprel";
 298   }
 299   llvm_unreachable("Invalid variant kind");
 300 }
 301
 302 MCSymbolRefExpr::VariantKind
 303 MCSymbolRefExpr::getVariantKindForName(StringRef Name) {
 304   return StringSwitch<VariantKind>(Name.lower())
 305     .Case("got", VK_GOT)
 306     .Case("gotoff", VK_GOTOFF)
 307     .Case("gotpcrel", VK_GOTPCREL)
 308     .Case("got_prel", VK_GOTPCREL)
 309     .Case("gottpoff", VK_GOTTPOFF)
 310     .Case("indntpoff", VK_INDNTPOFF)
 311     .Case("ntpoff", VK_NTPOFF)
 312     .Case("gotntpoff", VK_GOTNTPOFF)
 313     .Case("plt", VK_PLT)
 314     .Case("tlsgd", VK_TLSGD)
 315     .Case("tlsld", VK_TLSLD)
 316     .Case("tlsldm", VK_TLSLDM)
 317     .Case("tpoff", VK_TPOFF)
 318     .Case("dtpoff", VK_DTPOFF)
 319     .Case("tlvp", VK_TLVP)
 320     .Case("tlvppage", VK_TLVPPAGE)
 321     .Case("tlvppageoff", VK_TLVPPAGEOFF)
 322     .Case("page", VK_PAGE)
 323     .Case("pageoff", VK_PAGEOFF)
 324     .Case("gotpage", VK_GOTPAGE)
 325     .Case("gotpageoff", VK_GOTPAGEOFF)
 326     .Case("imgrel", VK_COFF_IMGREL32)
 327     .Case("secrel32", VK_SECREL)
 328     .Case("size", VK_SIZE)
 329     .Case("l", VK_PPC_LO)
 330     .Case("h", VK_PPC_HI)
 331     .Case("ha", VK_PPC_HA)
 332     .Case("higher", VK_PPC_HIGHER)
 333     .Case("highera", VK_PPC_HIGHERA)
 334     .Case("highest", VK_PPC_HIGHEST)
 335     .Case("highesta", VK_PPC_HIGHESTA)
 336     .Case("got@l", VK_PPC_GOT_LO)
 337     .Case("got@h", VK_PPC_GOT_HI)
 338     .Case("got@ha", VK_PPC_GOT_HA)
 339     .Case("local", VK_PPC_LOCAL)
 340     .Case("tocbase", VK_PPC_TOCBASE)
 341     .Case("toc", VK_PPC_TOC)
 342     .Case("toc@l", VK_PPC_TOC_LO)
 343     .Case("toc@h", VK_PPC_TOC_HI)
 344     .Case("toc@ha", VK_PPC_TOC_HA)
 345     .Case("tls", VK_PPC_TLS)
 346     .Case("dtpmod", VK_PPC_DTPMOD)
 347     .Case("tprel", VK_PPC_TPREL)
 348     .Case("tprel@l", VK_PPC_TPREL_LO)
 349     .Case("tprel@h", VK_PPC_TPREL_HI)
 350     .Case("tprel@ha", VK_PPC_TPREL_HA)
 351     .Case("tprel@higher", VK_PPC_TPREL_HIGHER)
 352     .Case("tprel@highera", VK_PPC_TPREL_HIGHERA)
 353     .Case("tprel@highest", VK_PPC_TPREL_HIGHEST)
 354     .Case("tprel@highesta", VK_PPC_TPREL_HIGHESTA)
 355     .Case("dtprel", VK_PPC_DTPREL)
 356     .Case("dtprel@l", VK_PPC_DTPREL_LO)
 357     .Case("dtprel@h", VK_PPC_DTPREL_HI)
 358     .Case("dtprel@ha", VK_PPC_DTPREL_HA)
 359     .Case("dtprel@higher", VK_PPC_DTPREL_HIGHER)
 360     .Case("dtprel@highera", VK_PPC_DTPREL_HIGHERA)
 361     .Case("dtprel@highest", VK_PPC_DTPREL_HIGHEST)
 362     .Case("dtprel@highesta", VK_PPC_DTPREL_HIGHESTA)
 363     .Case("got@tprel", VK_PPC_GOT_TPREL)
 364     .Case("got@tprel@l", VK_PPC_GOT_TPREL_LO)
 365     .Case("got@tprel@h", VK_PPC_GOT_TPREL_HI)
 366     .Case("got@tprel@ha", VK_PPC_GOT_TPREL_HA)
 367     .Case("got@dtprel", VK_PPC_GOT_DTPREL)
 368     .Case("got@dtprel@l", VK_PPC_GOT_DTPREL_LO)
 369     .Case("got@dtprel@h", VK_PPC_GOT_DTPREL_HI)
 370     .Case("got@dtprel@ha", VK_PPC_GOT_DTPREL_HA)
 371     .Case("got@tlsgd", VK_PPC_GOT_TLSGD)
 372     .Case("got@tlsgd@l", VK_PPC_GOT_TLSGD_LO)
 373     .Case("got@tlsgd@h", VK_PPC_GOT_TLSGD_HI)
 374     .Case("got@tlsgd@ha", VK_PPC_GOT_TLSGD_HA)
 375     .Case("got@tlsld", VK_PPC_GOT_TLSLD)
 376     .Case("got@tlsld@l", VK_PPC_GOT_TLSLD_LO)
 377     .Case("got@tlsld@h", VK_PPC_GOT_TLSLD_HI)
 378     .Case("got@tlsld@ha", VK_PPC_GOT_TLSLD_HA)
 379     .Case("none", VK_ARM_NONE)
 380     .Case("target1", VK_ARM_TARGET1)
 381     .Case("target2", VK_ARM_TARGET2)
 382     .Case("prel31", VK_ARM_PREL31)
 383     .Case("sbrel", VK_ARM_SBREL)
 384     .Case("tlsldo", VK_ARM_TLSLDO)
 385     .Case("tlscall", VK_ARM_TLSCALL)
 386     .Case("tlsdesc", VK_ARM_TLSDESC)
 387     .Default(VK_Invalid);
 388 }
 389
 390 void MCSymbolRefExpr::printVariantKind(raw_ostream &OS) const {
 391   if (UseParensForSymbolVariant)
 392     OS << '(' << MCSymbolRefExpr::getVariantKindName(getKind()) << ')';
 393   else
 394     OS << '@' << MCSymbolRefExpr::getVariantKindName(getKind());
 395 }
 396
 397 /* *** */
 398
 399 void MCTargetExpr::anchor() {}
 400
 401 /* *** */
 402
 403 bool MCExpr::EvaluateAsAbsolute(int64_t &Res) const {
 404   return EvaluateAsAbsolute(Res, nullptr, nullptr, nullptr);
 405 }
 406
 407 bool MCExpr::EvaluateAsAbsolute(int64_t &Res,
 408                                 const MCAsmLayout &Layout) const {
 409   return EvaluateAsAbsolute(Res, &Layout.getAssembler(), &Layout, nullptr);
 410 }
 411
 412 bool MCExpr::EvaluateAsAbsolute(int64_t &Res,
 413                                 const MCAsmLayout &Layout,
 414                                 const SectionAddrMap &Addrs) const {
 415   return EvaluateAsAbsolute(Res, &Layout.getAssembler(), &Layout, &Addrs);
 416 }
 417
 418 bool MCExpr::EvaluateAsAbsolute(int64_t &Res, const MCAssembler &Asm) const {
 419   return EvaluateAsAbsolute(Res, &Asm, nullptr, nullptr);
 420 }
 421
 422 bool MCExpr::evaluateKnownAbsolute(int64_t &Res,
 423                                    const MCAsmLayout &Layout) const {
 424   return evaluateAsAbsolute(Res, &Layout.getAssembler(), &Layout, nullptr,
 425                             true);
 426 }
 427
 428 bool MCExpr::EvaluateAsAbsolute(int64_t &Res, const MCAssembler *Asm,
 429                                 const MCAsmLayout *Layout,
 430                                 const SectionAddrMap *Addrs) const {
 431   // FIXME: The use if InSet = Addrs is a hack. Setting InSet causes us
 432   // absolutize differences across sections and that is what the MachO writer
 433   // uses Addrs for.
 434   return evaluateAsAbsolute(Res, Asm, Layout, Addrs, Addrs);
 435 }
 436
 437 bool MCExpr::evaluateAsAbsolute(int64_t &Res, const MCAssembler *Asm,
 438                                 const MCAsmLayout *Layout,
 439                                 const SectionAddrMap *Addrs, bool InSet) const {
 440   MCValue Value;
 441
 442   // Fast path constants.
 443   if (const MCConstantExpr *CE = dyn_cast<MCConstantExpr>(this)) {
 444     Res = CE->getValue();
 445     return true;
 446   }
 447
 448   bool IsRelocatable =
 449       EvaluateAsRelocatableImpl(Value, Asm, Layout, nullptr, Addrs, InSet);
 450
 451   // Record the current value.
 452   Res = Value.getConstant();
 453
 454   return IsRelocatable && Value.isAbsolute();
 455 }
 456
 457 /// \brief Helper method for \see EvaluateSymbolAdd().
 458 static void AttemptToFoldSymbolOffsetDifference(
 459     const MCAssembler *Asm, const MCAsmLayout *Layout,
 460     const SectionAddrMap *Addrs, bool InSet, const MCSymbolRefExpr *&A,
 461     const MCSymbolRefExpr *&B, int64_t &Addend) {
 462   if (!A || !B)
 463     return;
 464
 465   const MCSymbol &SA = A->getSymbol();
 466   const MCSymbol &SB = B->getSymbol();
 467
 468   if (SA.isUndefined() || SB.isUndefined())
 469     return;
 470
 471   if (!Asm->getWriter().IsSymbolRefDifferenceFullyResolved(*Asm, A, B, InSet))
 472     return;
 473
 474   const MCSymbolData &AD = Asm->getSymbolData(SA);
 475   const MCSymbolData &BD = Asm->getSymbolData(SB);
 476
 477   if (AD.getFragment() == BD.getFragment()) {
 478     Addend += (AD.getOffset() - BD.getOffset());
 479
 480     // Pointers to Thumb symbols need to have their low-bit set to allow
 481     // for interworking.
 482     if (Asm->isThumbFunc(&SA))
 483       Addend |= 1;
 484
 485     // Clear the symbol expr pointers to indicate we have folded these
 486     // operands.
 487     A = B = nullptr;
 488     return;
 489   }
 490
 491   if (!Layout)
 492     return;
 493
 494   const MCSectionData &SecA = *AD.getFragment()->getParent();
 495   const MCSectionData &SecB = *BD.getFragment()->getParent();
 496
 497   if ((&SecA != &SecB) && !Addrs)
 498     return;
 499
 500   // Eagerly evaluate.
 501   Addend += (Layout->getSymbolOffset(&Asm->getSymbolData(A->getSymbol())) -
 502              Layout->getSymbolOffset(&Asm->getSymbolData(B->getSymbol())));
 503   if (Addrs && (&SecA != &SecB))
 504     Addend += (Addrs->lookup(&SecA) - Addrs->lookup(&SecB));
 505
 506   // Pointers to Thumb symbols need to have their low-bit set to allow
 507   // for interworking.
 508   if (Asm->isThumbFunc(&SA))
 509     Addend |= 1;
 510
 511   // Clear the symbol expr pointers to indicate we have folded these
 512   // operands.
 513   A = B = nullptr;
 514 }
 515
 516 /// \brief Evaluate the result of an add between (conceptually) two MCValues.
 517 ///
 518 /// This routine conceptually attempts to construct an MCValue:
 519 ///   Result = (Result_A - Result_B + Result_Cst)
 520 /// from two MCValue's LHS and RHS where
 521 ///   Result = LHS + RHS
 522 /// and
 523 ///   Result = (LHS_A - LHS_B + LHS_Cst) + (RHS_A - RHS_B + RHS_Cst).
 524 ///
 525 /// This routine attempts to aggresively fold the operands such that the result
 526 /// is representable in an MCValue, but may not always succeed.
 527 ///
 528 /// \returns True on success, false if the result is not representable in an
 529 /// MCValue.
 530
 531 /// NOTE: It is really important to have both the Asm and Layout arguments.
 532 /// They might look redundant, but this function can be used before layout
 533 /// is done (see the object streamer for example) and having the Asm argument
 534 /// lets us avoid relaxations early.
 535 static bool
 536 EvaluateSymbolicAdd(const MCAssembler *Asm, const MCAsmLayout *Layout,
 537                     const SectionAddrMap *Addrs, bool InSet, const MCValue &LHS,
 538                     const MCSymbolRefExpr *RHS_A, const MCSymbolRefExpr *RHS_B,
 539                     int64_t RHS_Cst, MCValue &Res) {
 540   // FIXME: This routine (and other evaluation parts) are *incredibly* sloppy
 541   // about dealing with modifiers. This will ultimately bite us, one day.
 542   const MCSymbolRefExpr *LHS_A = LHS.getSymA();
 543   const MCSymbolRefExpr *LHS_B = LHS.getSymB();
 544   int64_t LHS_Cst = LHS.getConstant();
 545
 546   // Fold the result constant immediately.
 547   int64_t Result_Cst = LHS_Cst + RHS_Cst;
 548
 549   assert((!Layout || Asm) &&
 550          "Must have an assembler object if layout is given!");
 551
 552   // If we have a layout, we can fold resolved differences.
 553   if (Asm) {
 554     // First, fold out any differences which are fully resolved. By
 555     // reassociating terms in
 556     //   Result = (LHS_A - LHS_B + LHS_Cst) + (RHS_A - RHS_B + RHS_Cst).
 557     // we have the four possible differences:
 558     //   (LHS_A - LHS_B),
 559     //   (LHS_A - RHS_B),
 560     //   (RHS_A - LHS_B),
 561     //   (RHS_A - RHS_B).
 562     // Since we are attempting to be as aggressive as possible about folding, we
 563     // attempt to evaluate each possible alternative.
 564     AttemptToFoldSymbolOffsetDifference(Asm, Layout, Addrs, InSet, LHS_A, LHS_B,
 565                                         Result_Cst);
 566     AttemptToFoldSymbolOffsetDifference(Asm, Layout, Addrs, InSet, LHS_A, RHS_B,
 567                                         Result_Cst);
 568     AttemptToFoldSymbolOffsetDifference(Asm, Layout, Addrs, InSet, RHS_A, LHS_B,
 569                                         Result_Cst);
 570     AttemptToFoldSymbolOffsetDifference(Asm, Layout, Addrs, InSet, RHS_A, RHS_B,
 571                                         Result_Cst);
 572   }
 573
 574   // We can't represent the addition or subtraction of two symbols.
 575   if ((LHS_A && RHS_A) || (LHS_B && RHS_B))
 576     return false;
 577
 578   // At this point, we have at most one additive symbol and one subtractive
 579   // symbol -- find them.
 580   const MCSymbolRefExpr *A = LHS_A ? LHS_A : RHS_A;
 581   const MCSymbolRefExpr *B = LHS_B ? LHS_B : RHS_B;
 582
 583   // If we have a negated symbol, then we must have also have a non-negated
 584   // symbol in order to encode the expression.
 585   if (B && !A)
 586     return false;
 587
 588   Res = MCValue::get(A, B, Result_Cst);
 589   return true;
 590 }
 591
 592 bool MCExpr::EvaluateAsRelocatable(MCValue &Res,
 593                                    const MCAsmLayout *Layout,
 594                                    const MCFixup *Fixup) const {
 595   MCAssembler *Assembler = Layout ? &Layout->getAssembler() : nullptr;
 596   return EvaluateAsRelocatableImpl(Res, Assembler, Layout, Fixup, nullptr,
 597                                    false);
 598 }
 599
 600 bool MCExpr::evaluateAsValue(MCValue &Res, const MCAsmLayout &Layout) const {
 601   MCAssembler *Assembler = &Layout.getAssembler();
 602   return EvaluateAsRelocatableImpl(Res, Assembler, &Layout, nullptr, nullptr,
 603                                    true);
 604 }
 605
 606 static bool canExpand(const MCSymbol &Sym, const MCAssembler *Asm, bool InSet) {
 607   if (InSet)
 608     return true;
 609   if (!Asm)
 610     return false;
 611   const MCSymbolData &SD = Asm->getSymbolData(Sym);
 612   return !Asm->getWriter().isWeak(SD);
 613 }
 614
 615 bool MCExpr::EvaluateAsRelocatableImpl(MCValue &Res, const MCAssembler *Asm,
 616                                        const MCAsmLayout *Layout,
 617                                        const MCFixup *Fixup,
 618                                        const SectionAddrMap *Addrs,
 619                                        bool InSet) const {
 620   ++stats::MCExprEvaluate;
 621
 622   switch (getKind()) {
 623   case Target:
 624     return cast<MCTargetExpr>(this)->EvaluateAsRelocatableImpl(Res, Layout,
 625                                                                Fixup);
 626
 627   case Constant:
 628     Res = MCValue::get(cast<MCConstantExpr>(this)->getValue());
 629     return true;
 630
 631   case SymbolRef: {
 632     const MCSymbolRefExpr *SRE = cast<MCSymbolRefExpr>(this);
 633     const MCSymbol &Sym = SRE->getSymbol();
 634
 635     // Evaluate recursively if this is a variable.
 636     if (Sym.isVariable() && SRE->getKind() == MCSymbolRefExpr::VK_None &&
 637         canExpand(Sym, Asm, InSet)) {
 638       bool IsMachO = SRE->hasSubsectionsViaSymbols();
 639       if (Sym.getVariableValue()->EvaluateAsRelocatableImpl(
 640               Res, Asm, Layout, Fixup, Addrs, InSet || IsMachO)) {
 641         if (!IsMachO)
 642           return true;
 643
 644         const MCSymbolRefExpr *A = Res.getSymA();
 645         const MCSymbolRefExpr *B = Res.getSymB();
 646         // FIXME: This is small hack. Given
 647         // a = b + 4
 648         // .long a
 649         // the OS X assembler will completely drop the 4. We should probably
 650         // include it in the relocation or produce an error if that is not
 651         // possible.
 652         if (!A && !B)
 653           return true;
 654       }
 655     }
 656
 657     Res = MCValue::get(SRE, nullptr, 0);
 658     return true;
 659   }
 660
 661   case Unary: {
 662     const MCUnaryExpr *AUE = cast<MCUnaryExpr>(this);
 663     MCValue Value;
 664
 665     if (!AUE->getSubExpr()->EvaluateAsRelocatableImpl(Value, Asm, Layout, Fixup,
 666                                                       Addrs, InSet))
 667       return false;
 668
 669     switch (AUE->getOpcode()) {
 670     case MCUnaryExpr::LNot:
 671       if (!Value.isAbsolute())
 672         return false;
 673       Res = MCValue::get(!Value.getConstant());
 674       break;
 675     case MCUnaryExpr::Minus:
 676       /// -(a - b + const) ==> (b - a - const)
 677       if (Value.getSymA() && !Value.getSymB())
 678         return false;
 679       Res = MCValue::get(Value.getSymB(), Value.getSymA(),
 680                          -Value.getConstant());
 681       break;
 682     case MCUnaryExpr::Not:
 683       if (!Value.isAbsolute())
 684         return false;
 685       Res = MCValue::get(~Value.getConstant());
 686       break;
 687     case MCUnaryExpr::Plus:
 688       Res = Value;
 689       break;
 690     }
 691
 692     return true;
 693   }
 694
 695   case Binary: {
 696     const MCBinaryExpr *ABE = cast<MCBinaryExpr>(this);
 697     MCValue LHSValue, RHSValue;
 698
 699     if (!ABE->getLHS()->EvaluateAsRelocatableImpl(LHSValue, Asm, Layout, Fixup,
 700                                                   Addrs, InSet) ||
 701         !ABE->getRHS()->EvaluateAsRelocatableImpl(RHSValue, Asm, Layout, Fixup,
 702                                                   Addrs, InSet))
 703       return false;
 704
 705     // We only support a few operations on non-constant expressions, handle
 706     // those first.
 707     if (!LHSValue.isAbsolute() || !RHSValue.isAbsolute()) {
 708       switch (ABE->getOpcode()) {
 709       default:
 710         return false;
 711       case MCBinaryExpr::Sub:
 712         // Negate RHS and add.
 713         return EvaluateSymbolicAdd(Asm, Layout, Addrs, InSet, LHSValue,
 714                                    RHSValue.getSymB(), RHSValue.getSymA(),
 715                                    -RHSValue.getConstant(), Res);
 716
 717       case MCBinaryExpr::Add:
 718         return EvaluateSymbolicAdd(Asm, Layout, Addrs, InSet, LHSValue,
 719                                    RHSValue.getSymA(), RHSValue.getSymB(),
 720                                    RHSValue.getConstant(), Res);
 721       }
 722     }
 723
 724     // FIXME: We need target hooks for the evaluation. It may be limited in
 725     // width, and gas defines the result of comparisons differently from
 726     // Apple as.
 727     int64_t LHS = LHSValue.getConstant(), RHS = RHSValue.getConstant();
 728     int64_t Result = 0;
 729     switch (ABE->getOpcode()) {
 730     case MCBinaryExpr::AShr: Result = LHS >> RHS; break;
 731     case MCBinaryExpr::Add:  Result = LHS + RHS; break;
 732     case MCBinaryExpr::And:  Result = LHS & RHS; break;
 733     case MCBinaryExpr::Div:  Result = LHS / RHS; break;
 734     case MCBinaryExpr::EQ:   Result = LHS == RHS; break;
 735     case MCBinaryExpr::GT:   Result = LHS > RHS; break;
 736     case MCBinaryExpr::GTE:  Result = LHS >= RHS; break;
 737     case MCBinaryExpr::LAnd: Result = LHS && RHS; break;
 738     case MCBinaryExpr::LOr:  Result = LHS || RHS; break;
 739     case MCBinaryExpr::LShr: Result = uint64_t(LHS) >> uint64_t(RHS); break;
 740     case MCBinaryExpr::LT:   Result = LHS < RHS; break;
 741     case MCBinaryExpr::LTE:  Result = LHS <= RHS; break;
 742     case MCBinaryExpr::Mod:  Result = LHS % RHS; break;
 743     case MCBinaryExpr::Mul:  Result = LHS * RHS; break;
 744     case MCBinaryExpr::NE:   Result = LHS != RHS; break;
 745     case MCBinaryExpr::Or:   Result = LHS | RHS; break;
 746     case MCBinaryExpr::Shl:  Result = LHS << RHS; break;
 747     case MCBinaryExpr::Sub:  Result = LHS - RHS; break;
 748     case MCBinaryExpr::Xor:  Result = LHS ^ RHS; break;
 749     }
 750
 751     Res = MCValue::get(Result);
 752     return true;
 753   }
 754   }
 755
 756   llvm_unreachable("Invalid assembly expression kind!");
 757 }
 758
 759 const MCSection *MCExpr::FindAssociatedSection() const {
 760   switch (getKind()) {
 761   case Target:
 762     // We never look through target specific expressions.
 763     return cast<MCTargetExpr>(this)->FindAssociatedSection();
 764
 765   case Constant:
 766     return MCSymbol::AbsolutePseudoSection;
 767
 768   case SymbolRef: {
 769     const MCSymbolRefExpr *SRE = cast<MCSymbolRefExpr>(this);
 770     const MCSymbol &Sym = SRE->getSymbol();
 771
 772     if (Sym.isDefined())
 773       return &Sym.getSection();
 774
 775     return nullptr;
 776   }
 777
 778   case Unary:
 779     return cast<MCUnaryExpr>(this)->getSubExpr()->FindAssociatedSection();
 780
 781   case Binary: {
 782     const MCBinaryExpr *BE = cast<MCBinaryExpr>(this);
 783     const MCSection *LHS_S = BE->getLHS()->FindAssociatedSection();
 784     const MCSection *RHS_S = BE->getRHS()->FindAssociatedSection();
 785
 786     // If either section is absolute, return the other.
 787     if (LHS_S == MCSymbol::AbsolutePseudoSection)
 788       return RHS_S;
 789     if (RHS_S == MCSymbol::AbsolutePseudoSection)
 790       return LHS_S;
 791
 792     // Not always correct, but probably the best we can do without more context.
 793     if (BE->getOpcode() == MCBinaryExpr::Sub)
 794       return MCSymbol::AbsolutePseudoSection;
 795
 796     // Otherwise, return the first non-null section.
 797     return LHS_S ? LHS_S : RHS_S;
 798   }
 799   }
 800
 801   llvm_unreachable("Invalid assembly expression kind!");
 802 }