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 #define DEBUG_TYPE "mcexpr"
  11 #include "llvm/MC/MCExpr.h"
  12 #include "llvm/ADT/Statistic.h"
  13 #include "llvm/ADT/StringSwitch.h"
  14 #include "llvm/MC/MCAsmLayout.h"
  15 #include "llvm/MC/MCAssembler.h"
  16 #include "llvm/MC/MCContext.h"
  17 #include "llvm/MC/MCSymbol.h"
  18 #include "llvm/MC/MCValue.h"
  19 #include "llvm/Support/Debug.h"
  20 #include "llvm/Support/raw_ostream.h"
  21 #include "llvm/Target/TargetAsmBackend.h"
  22 using namespace llvm;
  23
  24 namespace {
  25 namespace stats {
  26 STATISTIC(MCExprEvaluate, "Number of MCExpr evaluations");
  27 }
  28 }
  29
  30 void MCExpr::print(raw_ostream &OS) const {
  31   switch (getKind()) {
  32   case MCExpr::Target:
  33     return cast<MCTargetExpr>(this)->PrintImpl(OS);
  34   case MCExpr::Constant:
  35     OS << cast<MCConstantExpr>(*this).getValue();
  36     return;
  37
  38   case MCExpr::SymbolRef: {
  39     const MCSymbolRefExpr &SRE = cast<MCSymbolRefExpr>(*this);
  40     const MCSymbol &Sym = SRE.getSymbol();
  41
  42     if (SRE.getKind() == MCSymbolRefExpr::VK_ARM_HI16 ||
  43         SRE.getKind() == MCSymbolRefExpr::VK_ARM_LO16)
  44       OS << MCSymbolRefExpr::getVariantKindName(SRE.getKind());
  45
  46     // Parenthesize names that start with $ so that they don't look like
  47     // absolute names.
  48     if (Sym.getName()[0] == '$')
  49       OS << '(' << Sym << ')';
  50     else
  51       OS << Sym;
  52
  53     if (SRE.getKind() == MCSymbolRefExpr::VK_ARM_PLT)
  54       OS << MCSymbolRefExpr::getVariantKindName(SRE.getKind());
  55     else if (SRE.getKind() != MCSymbolRefExpr::VK_None &&
  56              SRE.getKind() != MCSymbolRefExpr::VK_ARM_HI16 &&
  57              SRE.getKind() != MCSymbolRefExpr::VK_ARM_LO16)
  58       OS << '@' << MCSymbolRefExpr::getVariantKindName(SRE.getKind());
  59
  60     return;
  61   }
  62
  63   case MCExpr::Unary: {
  64     const MCUnaryExpr &UE = cast<MCUnaryExpr>(*this);
  65     switch (UE.getOpcode()) {
  66     default: assert(0 && "Invalid opcode!");
  67     case MCUnaryExpr::LNot:  OS << '!'; break;
  68     case MCUnaryExpr::Minus: OS << '-'; break;
  69     case MCUnaryExpr::Not:   OS << '~'; break;
  70     case MCUnaryExpr::Plus:  OS << '+'; break;
  71     }
  72     OS << *UE.getSubExpr();
  73     return;
  74   }
  75
  76   case MCExpr::Binary: {
  77     const MCBinaryExpr &BE = cast<MCBinaryExpr>(*this);
  78
  79     // Only print parens around the LHS if it is non-trivial.
  80     if (isa<MCConstantExpr>(BE.getLHS()) || isa<MCSymbolRefExpr>(BE.getLHS())) {
  81       OS << *BE.getLHS();
  82     } else {
  83       OS << '(' << *BE.getLHS() << ')';
  84     }
  85
  86     switch (BE.getOpcode()) {
  87     default: assert(0 && "Invalid opcode!");
  88     case MCBinaryExpr::Add:
  89       // Print "X-42" instead of "X+-42".
  90       if (const MCConstantExpr *RHSC = dyn_cast<MCConstantExpr>(BE.getRHS())) {
  91         if (RHSC->getValue() < 0) {
  92           OS << RHSC->getValue();
  93           return;
  94         }
  95       }
  96
  97       OS <<  '+';
  98       break;
  99     case MCBinaryExpr::And:  OS <<  '&'; break;
 100     case MCBinaryExpr::Div:  OS <<  '/'; break;
 101     case MCBinaryExpr::EQ:   OS << "=="; break;
 102     case MCBinaryExpr::GT:   OS <<  '>'; break;
 103     case MCBinaryExpr::GTE:  OS << ">="; break;
 104     case MCBinaryExpr::LAnd: OS << "&&"; break;
 105     case MCBinaryExpr::LOr:  OS << "||"; break;
 106     case MCBinaryExpr::LT:   OS <<  '<'; break;
 107     case MCBinaryExpr::LTE:  OS << "<="; break;
 108     case MCBinaryExpr::Mod:  OS <<  '%'; break;
 109     case MCBinaryExpr::Mul:  OS <<  '*'; break;
 110     case MCBinaryExpr::NE:   OS << "!="; break;
 111     case MCBinaryExpr::Or:   OS <<  '|'; break;
 112     case MCBinaryExpr::Shl:  OS << "<<"; break;
 113     case MCBinaryExpr::Shr:  OS << ">>"; break;
 114     case MCBinaryExpr::Sub:  OS <<  '-'; break;
 115     case MCBinaryExpr::Xor:  OS <<  '^'; break;
 116     }
 117
 118     // Only print parens around the LHS if it is non-trivial.
 119     if (isa<MCConstantExpr>(BE.getRHS()) || isa<MCSymbolRefExpr>(BE.getRHS())) {
 120       OS << *BE.getRHS();
 121     } else {
 122       OS << '(' << *BE.getRHS() << ')';
 123     }
 124     return;
 125   }
 126   }
 127
 128   assert(0 && "Invalid expression kind!");
 129 }
 130
 131 void MCExpr::dump() const {
 132   print(dbgs());
 133   dbgs() << '\n';
 134 }
 135
 136 /* *** */
 137
 138 const MCBinaryExpr *MCBinaryExpr::Create(Opcode Opc, const MCExpr *LHS,
 139                                          const MCExpr *RHS, MCContext &Ctx) {
 140   return new (Ctx) MCBinaryExpr(Opc, LHS, RHS);
 141 }
 142
 143 const MCUnaryExpr *MCUnaryExpr::Create(Opcode Opc, const MCExpr *Expr,
 144                                        MCContext &Ctx) {
 145   return new (Ctx) MCUnaryExpr(Opc, Expr);
 146 }
 147
 148 const MCConstantExpr *MCConstantExpr::Create(int64_t Value, MCContext &Ctx) {
 149   return new (Ctx) MCConstantExpr(Value);
 150 }
 151
 152 /* *** */
 153
 154 const MCSymbolRefExpr *MCSymbolRefExpr::Create(const MCSymbol *Sym,
 155                                                VariantKind Kind,
 156                                                MCContext &Ctx) {
 157   return new (Ctx) MCSymbolRefExpr(Sym, Kind);
 158 }
 159
 160 const MCSymbolRefExpr *MCSymbolRefExpr::Create(StringRef Name, VariantKind Kind,
 161                                                MCContext &Ctx) {
 162   return Create(Ctx.GetOrCreateSymbol(Name), Kind, Ctx);
 163 }
 164
 165 StringRef MCSymbolRefExpr::getVariantKindName(VariantKind Kind) {
 166   switch (Kind) {
 167   default:
 168   case VK_Invalid: return "<<invalid>>";
 169   case VK_None: return "<<none>>";
 170
 171   case VK_GOT: return "GOT";
 172   case VK_GOTOFF: return "GOTOFF";
 173   case VK_GOTPCREL: return "GOTPCREL";
 174   case VK_GOTTPOFF: return "GOTTPOFF";
 175   case VK_INDNTPOFF: return "INDNTPOFF";
 176   case VK_NTPOFF: return "NTPOFF";
 177   case VK_PLT: return "PLT";
 178   case VK_TLSGD: return "TLSGD";
 179   case VK_TPOFF: return "TPOFF";
 180   case VK_ARM_HI16: return ":upper16:";
 181   case VK_ARM_LO16: return ":lower16:";
 182   case VK_ARM_PLT: return "(PLT)";
 183   case VK_TLVP: return "TLVP";
 184   }
 185 }
 186
 187 MCSymbolRefExpr::VariantKind
 188 MCSymbolRefExpr::getVariantKindForName(StringRef Name) {
 189   return StringSwitch<VariantKind>(Name)
 190     .Case("GOT", VK_GOT)
 191     .Case("GOTOFF", VK_GOTOFF)
 192     .Case("GOTPCREL", VK_GOTPCREL)
 193     .Case("GOTTPOFF", VK_GOTTPOFF)
 194     .Case("INDNTPOFF", VK_INDNTPOFF)
 195     .Case("NTPOFF", VK_NTPOFF)
 196     .Case("PLT", VK_PLT)
 197     .Case("TLSGD", VK_TLSGD)
 198     .Case("TPOFF", VK_TPOFF)
 199     .Case("TLVP", VK_TLVP)
 200     .Default(VK_Invalid);
 201 }
 202
 203 /* *** */
 204
 205 void MCTargetExpr::Anchor() {}
 206
 207 /* *** */
 208
 209 bool MCExpr::EvaluateAsAbsolute(int64_t &Res, const MCAsmLayout *Layout) const {
 210   MCValue Value;
 211
 212   // Fast path constants.
 213   if (const MCConstantExpr *CE = dyn_cast<MCConstantExpr>(this)) {
 214     Res = CE->getValue();
 215     return true;
 216   }
 217
 218   if (!EvaluateAsRelocatable(Value, Layout) || !Value.isAbsolute()) {
 219     // EvaluateAsAbsolute is defined to return the "current value" of
 220     // the expression if we are given a Layout object, even in cases
 221     // when the value is not fixed.
 222     if (Layout) {
 223       Res = Value.getConstant();
 224       if (Value.getSymA()) {
 225         Res += Layout->getSymbolAddress(
 226           &Layout->getAssembler().getSymbolData(Value.getSymA()->getSymbol()));
 227       }
 228       if (Value.getSymB()) {
 229         Res -= Layout->getSymbolAddress(
 230           &Layout->getAssembler().getSymbolData(Value.getSymB()->getSymbol()));
 231       }
 232     }
 233     return false;
 234   }
 235
 236   Res = Value.getConstant();
 237   return true;
 238 }
 239
 240 static bool EvaluateSymbolicAdd(const MCValue &LHS,const MCSymbolRefExpr *RHS_A,
 241                                 const MCSymbolRefExpr *RHS_B, int64_t RHS_Cst,
 242                                 MCValue &Res) {
 243   // We can't add or subtract two symbols.
 244   if ((LHS.getSymA() && RHS_A) ||
 245       (LHS.getSymB() && RHS_B))
 246     return false;
 247
 248   const MCSymbolRefExpr *A = LHS.getSymA() ? LHS.getSymA() : RHS_A;
 249   const MCSymbolRefExpr *B = LHS.getSymB() ? LHS.getSymB() : RHS_B;
 250   if (B) {
 251     // If we have a negated symbol, then we must have also have a non-negated
 252     // symbol in order to encode the expression. We can do this check later to
 253     // permit expressions which eventually fold to a representable form -- such
 254     // as (a + (0 - b)) -- if necessary.
 255     if (!A)
 256       return false;
 257   }
 258   Res = MCValue::get(A, B, LHS.getConstant() + RHS_Cst);
 259   return true;
 260 }
 261
 262 bool MCExpr::EvaluateAsRelocatable(MCValue &Res,
 263                                    const MCAsmLayout *Layout) const {
 264   ++stats::MCExprEvaluate;
 265
 266   switch (getKind()) {
 267   case Target:
 268     return cast<MCTargetExpr>(this)->EvaluateAsRelocatableImpl(Res, Layout);
 269
 270   case Constant:
 271     Res = MCValue::get(cast<MCConstantExpr>(this)->getValue());
 272     return true;
 273
 274   case SymbolRef: {
 275     const MCSymbolRefExpr *SRE = cast<MCSymbolRefExpr>(this);
 276     const MCSymbol &Sym = SRE->getSymbol();
 277
 278     // Evaluate recursively if this is a variable.
 279     if (Sym.isVariable()) {
 280       if (!Sym.getVariableValue()->EvaluateAsRelocatable(Res, Layout))
 281         return false;
 282
 283       // Absolutize symbol differences between defined symbols when we have a
 284       // layout object and the target requests it.
 285       if (Layout && Res.getSymB() &&
 286           Layout->getAssembler().getBackend().hasAbsolutizedSet() &&
 287           Res.getSymA()->getSymbol().isDefined() &&
 288           Res.getSymB()->getSymbol().isDefined()) {
 289         MCSymbolData &A =
 290           Layout->getAssembler().getSymbolData(Res.getSymA()->getSymbol());
 291         MCSymbolData &B =
 292           Layout->getAssembler().getSymbolData(Res.getSymB()->getSymbol());
 293         Res = MCValue::get(+ Layout->getSymbolAddress(&A)
 294                            - Layout->getSymbolAddress(&B)
 295                            + Res.getConstant());
 296       }
 297
 298       return true;
 299     }
 300
 301     Res = MCValue::get(SRE, 0, 0);
 302     return true;
 303   }
 304
 305   case Unary: {
 306     const MCUnaryExpr *AUE = cast<MCUnaryExpr>(this);
 307     MCValue Value;
 308
 309     if (!AUE->getSubExpr()->EvaluateAsRelocatable(Value, Layout))
 310       return false;
 311
 312     switch (AUE->getOpcode()) {
 313     case MCUnaryExpr::LNot:
 314       if (!Value.isAbsolute())
 315         return false;
 316       Res = MCValue::get(!Value.getConstant());
 317       break;
 318     case MCUnaryExpr::Minus:
 319       /// -(a - b + const) ==> (b - a - const)
 320       if (Value.getSymA() && !Value.getSymB())
 321         return false;
 322       Res = MCValue::get(Value.getSymB(), Value.getSymA(),
 323                          -Value.getConstant());
 324       break;
 325     case MCUnaryExpr::Not:
 326       if (!Value.isAbsolute())
 327         return false;
 328       Res = MCValue::get(~Value.getConstant());
 329       break;
 330     case MCUnaryExpr::Plus:
 331       Res = Value;
 332       break;
 333     }
 334
 335     return true;
 336   }
 337
 338   case Binary: {
 339     const MCBinaryExpr *ABE = cast<MCBinaryExpr>(this);
 340     MCValue LHSValue, RHSValue;
 341
 342     if (!ABE->getLHS()->EvaluateAsRelocatable(LHSValue, Layout) ||
 343         !ABE->getRHS()->EvaluateAsRelocatable(RHSValue, Layout))
 344       return false;
 345
 346     // We only support a few operations on non-constant expressions, handle
 347     // those first.
 348     if (!LHSValue.isAbsolute() || !RHSValue.isAbsolute()) {
 349       switch (ABE->getOpcode()) {
 350       default:
 351         return false;
 352       case MCBinaryExpr::Sub:
 353         // Negate RHS and add.
 354         return EvaluateSymbolicAdd(LHSValue,
 355                                    RHSValue.getSymB(), RHSValue.getSymA(),
 356                                    -RHSValue.getConstant(),
 357                                    Res);
 358
 359       case MCBinaryExpr::Add:
 360         return EvaluateSymbolicAdd(LHSValue,
 361                                    RHSValue.getSymA(), RHSValue.getSymB(),
 362                                    RHSValue.getConstant(),
 363                                    Res);
 364       }
 365     }
 366
 367     // FIXME: We need target hooks for the evaluation. It may be limited in
 368     // width, and gas defines the result of comparisons and right shifts
 369     // differently from Apple as.
 370     int64_t LHS = LHSValue.getConstant(), RHS = RHSValue.getConstant();
 371     int64_t Result = 0;
 372     switch (ABE->getOpcode()) {
 373     case MCBinaryExpr::Add:  Result = LHS + RHS; break;
 374     case MCBinaryExpr::And:  Result = LHS & RHS; break;
 375     case MCBinaryExpr::Div:  Result = LHS / RHS; break;
 376     case MCBinaryExpr::EQ:   Result = LHS == RHS; break;
 377     case MCBinaryExpr::GT:   Result = LHS > RHS; break;
 378     case MCBinaryExpr::GTE:  Result = LHS >= RHS; break;
 379     case MCBinaryExpr::LAnd: Result = LHS && RHS; break;
 380     case MCBinaryExpr::LOr:  Result = LHS || RHS; break;
 381     case MCBinaryExpr::LT:   Result = LHS < RHS; break;
 382     case MCBinaryExpr::LTE:  Result = LHS <= RHS; break;
 383     case MCBinaryExpr::Mod:  Result = LHS % RHS; break;
 384     case MCBinaryExpr::Mul:  Result = LHS * RHS; break;
 385     case MCBinaryExpr::NE:   Result = LHS != RHS; break;
 386     case MCBinaryExpr::Or:   Result = LHS | RHS; break;
 387     case MCBinaryExpr::Shl:  Result = LHS << RHS; break;
 388     case MCBinaryExpr::Shr:  Result = LHS >> RHS; break;
 389     case MCBinaryExpr::Sub:  Result = LHS - RHS; break;
 390     case MCBinaryExpr::Xor:  Result = LHS ^ RHS; break;
 391     }
 392
 393     Res = MCValue::get(Result);
 394     return true;
 395   }
 396   }
 397
 398   assert(0 && "Invalid assembly expression kind!");
 399   return false;
 400 }