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/MC/MCContext.h"
  12 #include "llvm/MC/MCSymbol.h"
  13 #include "llvm/MC/MCValue.h"
  14 #include "llvm/Support/Debug.h"
  15 #include "llvm/Support/raw_ostream.h"
  16 using namespace llvm;
  17
  18 void MCExpr::print(raw_ostream &OS, const MCAsmInfo *MAI) const {
  19   switch (getKind()) {
  20   case MCExpr::Constant:
  21     OS << cast<MCConstantExpr>(*this).getValue();
  22     return;
  23
  24   case MCExpr::SymbolRef: {
  25     const MCSymbol &Sym = cast<MCSymbolRefExpr>(*this).getSymbol();
  26
  27     // Parenthesize names that start with $ so that they don't look like
  28     // absolute names.
  29     if (Sym.getName()[0] == '$')
  30       OS << '(' << Sym << ')';
  31     else
  32       OS << Sym;
  33     return;
  34   }
  35
  36   case MCExpr::Unary: {
  37     const MCUnaryExpr &UE = cast<MCUnaryExpr>(*this);
  38     switch (UE.getOpcode()) {
  39     default: assert(0 && "Invalid opcode!");
  40     case MCUnaryExpr::LNot:  OS << '!'; break;
  41     case MCUnaryExpr::Minus: OS << '-'; break;
  42     case MCUnaryExpr::Not:   OS << '~'; break;
  43     case MCUnaryExpr::Plus:  OS << '+'; break;
  44     }
  45     UE.getSubExpr()->print(OS, MAI);
  46     return;
  47   }
  48
  49   case MCExpr::Binary: {
  50     const MCBinaryExpr &BE = cast<MCBinaryExpr>(*this);
  51
  52     // Only print parens around the LHS if it is non-trivial.
  53     if (isa<MCConstantExpr>(BE.getLHS()) || isa<MCSymbolRefExpr>(BE.getLHS())) {
  54       BE.getLHS()->print(OS, MAI);
  55     } else {
  56       OS << '(';
  57       BE.getLHS()->print(OS, MAI);
  58       OS << ')';
  59     }
  60
  61     switch (BE.getOpcode()) {
  62     default: assert(0 && "Invalid opcode!");
  63     case MCBinaryExpr::Add:
  64       // Print "X-42" instead of "X+-42".
  65       if (const MCConstantExpr *RHSC = dyn_cast<MCConstantExpr>(BE.getRHS())) {
  66         if (RHSC->getValue() < 0) {
  67           OS << RHSC->getValue();
  68           return;
  69         }
  70       }
  71
  72       OS <<  '+';
  73       break;
  74     case MCBinaryExpr::And:  OS <<  '&'; break;
  75     case MCBinaryExpr::Div:  OS <<  '/'; break;
  76     case MCBinaryExpr::EQ:   OS << "=="; break;
  77     case MCBinaryExpr::GT:   OS <<  '>'; break;
  78     case MCBinaryExpr::GTE:  OS << ">="; break;
  79     case MCBinaryExpr::LAnd: OS << "&&"; break;
  80     case MCBinaryExpr::LOr:  OS << "||"; break;
  81     case MCBinaryExpr::LT:   OS <<  '<'; break;
  82     case MCBinaryExpr::LTE:  OS << "<="; break;
  83     case MCBinaryExpr::Mod:  OS <<  '%'; break;
  84     case MCBinaryExpr::Mul:  OS <<  '*'; break;
  85     case MCBinaryExpr::NE:   OS << "!="; break;
  86     case MCBinaryExpr::Or:   OS <<  '|'; break;
  87     case MCBinaryExpr::Shl:  OS << "<<"; break;
  88     case MCBinaryExpr::Shr:  OS << ">>"; break;
  89     case MCBinaryExpr::Sub:  OS <<  '-'; break;
  90     case MCBinaryExpr::Xor:  OS <<  '^'; break;
  91     }
  92
  93     // Only print parens around the LHS if it is non-trivial.
  94     if (isa<MCConstantExpr>(BE.getRHS()) || isa<MCSymbolRefExpr>(BE.getRHS())) {
  95       BE.getRHS()->print(OS, MAI);
  96     } else {
  97       OS << '(';
  98       BE.getRHS()->print(OS, MAI);
  99       OS << ')';
 100     }
 101     return;
 102   }
 103   }
 104
 105   assert(0 && "Invalid expression kind!");
 106 }
 107
 108 void MCExpr::dump() const {
 109   print(dbgs(), 0);
 110   dbgs() << '\n';
 111 }
 112
 113 /* *** */
 114
 115 const MCBinaryExpr *MCBinaryExpr::Create(Opcode Opc, const MCExpr *LHS,
 116                                          const MCExpr *RHS, MCContext &Ctx) {
 117   return new (Ctx) MCBinaryExpr(Opc, LHS, RHS);
 118 }
 119
 120 const MCUnaryExpr *MCUnaryExpr::Create(Opcode Opc, const MCExpr *Expr,
 121                                        MCContext &Ctx) {
 122   return new (Ctx) MCUnaryExpr(Opc, Expr);
 123 }
 124
 125 const MCConstantExpr *MCConstantExpr::Create(int64_t Value, MCContext &Ctx) {
 126   return new (Ctx) MCConstantExpr(Value);
 127 }
 128
 129 const MCSymbolRefExpr *MCSymbolRefExpr::Create(const MCSymbol *Sym,
 130                                                MCContext &Ctx) {
 131   return new (Ctx) MCSymbolRefExpr(Sym);
 132 }
 133
 134 const MCSymbolRefExpr *MCSymbolRefExpr::Create(StringRef Name, MCContext &Ctx) {
 135   return Create(Ctx.GetOrCreateSymbol(Name), Ctx);
 136 }
 137
 138
 139 /* *** */
 140
 141 bool MCExpr::EvaluateAsAbsolute(int64_t &Res) const {
 142   MCValue Value;
 143
 144   if (!EvaluateAsRelocatable(Value) || !Value.isAbsolute())
 145     return false;
 146
 147   Res = Value.getConstant();
 148   return true;
 149 }
 150
 151 static bool EvaluateSymbolicAdd(const MCValue &LHS, const MCSymbol *RHS_A,
 152                                 const MCSymbol *RHS_B, int64_t RHS_Cst,
 153                                 MCValue &Res) {
 154   // We can't add or subtract two symbols.
 155   if ((LHS.getSymA() && RHS_A) ||
 156       (LHS.getSymB() && RHS_B))
 157     return false;
 158
 159   const MCSymbol *A = LHS.getSymA() ? LHS.getSymA() : RHS_A;
 160   const MCSymbol *B = LHS.getSymB() ? LHS.getSymB() : RHS_B;
 161   if (B) {
 162     // If we have a negated symbol, then we must have also have a non-negated
 163     // symbol in order to encode the expression. We can do this check later to
 164     // permit expressions which eventually fold to a representable form -- such
 165     // as (a + (0 - b)) -- if necessary.
 166     if (!A)
 167       return false;
 168   }
 169   Res = MCValue::get(A, B, LHS.getConstant() + RHS_Cst);
 170   return true;
 171 }
 172
 173 bool MCExpr::EvaluateAsRelocatable(MCValue &Res) const {
 174   switch (getKind()) {
 175   case Constant:
 176     Res = MCValue::get(cast<MCConstantExpr>(this)->getValue());
 177     return true;
 178
 179   case SymbolRef: {
 180     const MCSymbol &Sym = cast<MCSymbolRefExpr>(this)->getSymbol();
 181
 182     // Evaluate recursively if this is a variable.
 183     if (Sym.isVariable())
 184       return Sym.getValue()->EvaluateAsRelocatable(Res);
 185
 186     Res = MCValue::get(&Sym, 0, 0);
 187     return true;
 188   }
 189
 190   case Unary: {
 191     const MCUnaryExpr *AUE = cast<MCUnaryExpr>(this);
 192     MCValue Value;
 193
 194     if (!AUE->getSubExpr()->EvaluateAsRelocatable(Value))
 195       return false;
 196
 197     switch (AUE->getOpcode()) {
 198     case MCUnaryExpr::LNot:
 199       if (!Value.isAbsolute())
 200         return false;
 201       Res = MCValue::get(!Value.getConstant());
 202       break;
 203     case MCUnaryExpr::Minus:
 204       /// -(a - b + const) ==> (b - a - const)
 205       if (Value.getSymA() && !Value.getSymB())
 206         return false;
 207       Res = MCValue::get(Value.getSymB(), Value.getSymA(),
 208                          -Value.getConstant());
 209       break;
 210     case MCUnaryExpr::Not:
 211       if (!Value.isAbsolute())
 212         return false;
 213       Res = MCValue::get(~Value.getConstant());
 214       break;
 215     case MCUnaryExpr::Plus:
 216       Res = Value;
 217       break;
 218     }
 219
 220     return true;
 221   }
 222
 223   case Binary: {
 224     const MCBinaryExpr *ABE = cast<MCBinaryExpr>(this);
 225     MCValue LHSValue, RHSValue;
 226
 227     if (!ABE->getLHS()->EvaluateAsRelocatable(LHSValue) ||
 228         !ABE->getRHS()->EvaluateAsRelocatable(RHSValue))
 229       return false;
 230
 231     // We only support a few operations on non-constant expressions, handle
 232     // those first.
 233     if (!LHSValue.isAbsolute() || !RHSValue.isAbsolute()) {
 234       switch (ABE->getOpcode()) {
 235       default:
 236         return false;
 237       case MCBinaryExpr::Sub:
 238         // Negate RHS and add.
 239         return EvaluateSymbolicAdd(LHSValue,
 240                                    RHSValue.getSymB(), RHSValue.getSymA(),
 241                                    -RHSValue.getConstant(),
 242                                    Res);
 243
 244       case MCBinaryExpr::Add:
 245         return EvaluateSymbolicAdd(LHSValue,
 246                                    RHSValue.getSymA(), RHSValue.getSymB(),
 247                                    RHSValue.getConstant(),
 248                                    Res);
 249       }
 250     }
 251
 252     // FIXME: We need target hooks for the evaluation. It may be limited in
 253     // width, and gas defines the result of comparisons differently from Apple
 254     // as (the result is sign extended).
 255     int64_t LHS = LHSValue.getConstant(), RHS = RHSValue.getConstant();
 256     int64_t Result = 0;
 257     switch (ABE->getOpcode()) {
 258     case MCBinaryExpr::Add:  Result = LHS + RHS; break;
 259     case MCBinaryExpr::And:  Result = LHS & RHS; break;
 260     case MCBinaryExpr::Div:  Result = LHS / RHS; break;
 261     case MCBinaryExpr::EQ:   Result = LHS == RHS; break;
 262     case MCBinaryExpr::GT:   Result = LHS > RHS; break;
 263     case MCBinaryExpr::GTE:  Result = LHS >= RHS; break;
 264     case MCBinaryExpr::LAnd: Result = LHS && RHS; break;
 265     case MCBinaryExpr::LOr:  Result = LHS || RHS; break;
 266     case MCBinaryExpr::LT:   Result = LHS < RHS; break;
 267     case MCBinaryExpr::LTE:  Result = LHS <= RHS; break;
 268     case MCBinaryExpr::Mod:  Result = LHS % RHS; break;
 269     case MCBinaryExpr::Mul:  Result = LHS * RHS; break;
 270     case MCBinaryExpr::NE:   Result = LHS != RHS; break;
 271     case MCBinaryExpr::Or:   Result = LHS | RHS; break;
 272     case MCBinaryExpr::Shl:  Result = LHS << RHS; break;
 273     case MCBinaryExpr::Shr:  Result = LHS >> RHS; break;
 274     case MCBinaryExpr::Sub:  Result = LHS - RHS; break;
 275     case MCBinaryExpr::Xor:  Result = LHS ^ RHS; break;
 276     }
 277
 278     Res = MCValue::get(Result);
 279     return true;
 280   }
 281   }
 282
 283   assert(0 && "Invalid assembly expression kind!");
 284   return false;
 285 }