lib/IR/InlineAsm.cpp

   1 //===-- InlineAsm.cpp - Implement the InlineAsm class ---------------------===//
   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 // This file implements the InlineAsm class.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "llvm/IR/InlineAsm.h"
  15 #include "ConstantsContext.h"
  16 #include "LLVMContextImpl.h"
  17 #include "llvm/IR/DerivedTypes.h"
  18 #include <algorithm>
  19 #include <cctype>
  20 using namespace llvm;
  21
  22 // Implement the first virtual method in this class in this file so the
  23 // InlineAsm vtable is emitted here.
  24 InlineAsm::~InlineAsm() {
  25 }
  26
  27 InlineAsm *InlineAsm::get(FunctionType *FTy, StringRef AsmString,
  28                           StringRef Constraints, bool hasSideEffects,
  29                           bool isAlignStack, AsmDialect asmDialect) {
  30   InlineAsmKeyType Key(AsmString, Constraints, FTy, hasSideEffects,
  31                        isAlignStack, asmDialect);
  32   LLVMContextImpl *pImpl = FTy->getContext().pImpl;
  33   return pImpl->InlineAsms.getOrCreate(PointerType::getUnqual(FTy), Key);
  34 }
  35
  36 InlineAsm::InlineAsm(FunctionType *FTy, const std::string &asmString,
  37                      const std::string &constraints, bool hasSideEffects,
  38                      bool isAlignStack, AsmDialect asmDialect)
  39     : Value(PointerType::getUnqual(FTy), Value::InlineAsmVal),
  40       AsmString(asmString), Constraints(constraints), FTy(FTy),
  41       HasSideEffects(hasSideEffects), IsAlignStack(isAlignStack),
  42       Dialect(asmDialect) {
  43
  44   // Do various checks on the constraint string and type.
  45   assert(Verify(getFunctionType(), constraints) &&
  46          "Function type not legal for constraints!");
  47 }
  48
  49 void InlineAsm::destroyConstant() {
  50   getType()->getContext().pImpl->InlineAsms.remove(this);
  51   delete this;
  52 }
  53
  54 FunctionType *InlineAsm::getFunctionType() const {
  55   return FTy;
  56 }
  57
  58 ///Default constructor.
  59 InlineAsm::ConstraintInfo::ConstraintInfo() :
  60   Type(isInput), isEarlyClobber(false),
  61   MatchingInput(-1), isCommutative(false),
  62   isIndirect(false), isMultipleAlternative(false),
  63   currentAlternativeIndex(0) {
  64 }
  65
  66 /// Parse - Analyze the specified string (e.g. "==&{eax}") and fill in the
  67 /// fields in this structure.  If the constraint string is not understood,
  68 /// return true, otherwise return false.
  69 bool InlineAsm::ConstraintInfo::Parse(StringRef Str,
  70                      InlineAsm::ConstraintInfoVector &ConstraintsSoFar) {
  71   StringRef::iterator I = Str.begin(), E = Str.end();
  72   unsigned multipleAlternativeCount = Str.count('|') + 1;
  73   unsigned multipleAlternativeIndex = 0;
  74   ConstraintCodeVector *pCodes = &Codes;
  75
  76   // Initialize
  77   isMultipleAlternative = multipleAlternativeCount > 1;
  78   if (isMultipleAlternative) {
  79     multipleAlternatives.resize(multipleAlternativeCount);
  80     pCodes = &multipleAlternatives[0].Codes;
  81   }
  82   Type = isInput;
  83   isEarlyClobber = false;
  84   MatchingInput = -1;
  85   isCommutative = false;
  86   isIndirect = false;
  87   currentAlternativeIndex = 0;
  88
  89   // Parse prefixes.
  90   if (*I == '~') {
  91     Type = isClobber;
  92     ++I;
  93
  94     // '{' must immediately follow '~'.
  95     if (I != E && *I != '{')
  96       return true;
  97   } else if (*I == '=') {
  98     ++I;
  99     Type = isOutput;
 100   }
 101
 102   if (*I == '*') {
 103     isIndirect = true;
 104     ++I;
 105   }
 106
 107   if (I == E) return true;  // Just a prefix, like "==" or "~".
 108
 109   // Parse the modifiers.
 110   bool DoneWithModifiers = false;
 111   while (!DoneWithModifiers) {
 112     switch (*I) {
 113     default:
 114       DoneWithModifiers = true;
 115       break;
 116     case '&':     // Early clobber.
 117       if (Type != isOutput ||      // Cannot early clobber anything but output.
 118           isEarlyClobber)          // Reject &&&&&&
 119         return true;
 120       isEarlyClobber = true;
 121       break;
 122     case '%':     // Commutative.
 123       if (Type == isClobber ||     // Cannot commute clobbers.
 124           isCommutative)           // Reject %%%%%
 125         return true;
 126       isCommutative = true;
 127       break;
 128     case '#':     // Comment.
 129     case '*':     // Register preferencing.
 130       return true;     // Not supported.
 131     }
 132
 133     if (!DoneWithModifiers) {
 134       ++I;
 135       if (I == E) return true;   // Just prefixes and modifiers!
 136     }
 137   }
 138
 139   // Parse the various constraints.
 140   while (I != E) {
 141     if (*I == '{') {   // Physical register reference.
 142       // Find the end of the register name.
 143       StringRef::iterator ConstraintEnd = std::find(I+1, E, '}');
 144       if (ConstraintEnd == E) return true;  // "{foo"
 145       pCodes->push_back(std::string(I, ConstraintEnd+1));
 146       I = ConstraintEnd+1;
 147     } else if (isdigit(static_cast<unsigned char>(*I))) { // Matching Constraint
 148       // Maximal munch numbers.
 149       StringRef::iterator NumStart = I;
 150       while (I != E && isdigit(static_cast<unsigned char>(*I)))
 151         ++I;
 152       pCodes->push_back(std::string(NumStart, I));
 153       unsigned N = atoi(pCodes->back().c_str());
 154       // Check that this is a valid matching constraint!
 155       if (N >= ConstraintsSoFar.size() || ConstraintsSoFar[N].Type != isOutput||
 156           Type != isInput)
 157         return true;  // Invalid constraint number.
 158
 159       // If Operand N already has a matching input, reject this.  An output
 160       // can't be constrained to the same value as multiple inputs.
 161       if (isMultipleAlternative) {
 162         if (multipleAlternativeIndex >= ConstraintsSoFar[N].multipleAlternatives.size())
 163           return true;
 164         InlineAsm::SubConstraintInfo &scInfo =
 165           ConstraintsSoFar[N].multipleAlternatives[multipleAlternativeIndex];
 166         if (scInfo.MatchingInput != -1)
 167           return true;
 168         // Note that operand #n has a matching input.
 169         scInfo.MatchingInput = ConstraintsSoFar.size();
 170       } else {
 171         if (ConstraintsSoFar[N].hasMatchingInput() &&
 172             (size_t)ConstraintsSoFar[N].MatchingInput !=
 173                 ConstraintsSoFar.size())
 174           return true;
 175         // Note that operand #n has a matching input.
 176         ConstraintsSoFar[N].MatchingInput = ConstraintsSoFar.size();
 177         }
 178     } else if (*I == '|') {
 179       multipleAlternativeIndex++;
 180       pCodes = &multipleAlternatives[multipleAlternativeIndex].Codes;
 181       ++I;
 182     } else if (*I == '^') {
 183       // Multi-letter constraint
 184       // FIXME: For now assuming these are 2-character constraints.
 185       pCodes->push_back(std::string(I+1, I+3));
 186       I += 3;
 187     } else {
 188       // Single letter constraint.
 189       pCodes->push_back(std::string(I, I+1));
 190       ++I;
 191     }
 192   }
 193
 194   return false;
 195 }
 196
 197 /// selectAlternative - Point this constraint to the alternative constraint
 198 /// indicated by the index.
 199 void InlineAsm::ConstraintInfo::selectAlternative(unsigned index) {
 200   if (index < multipleAlternatives.size()) {
 201     currentAlternativeIndex = index;
 202     InlineAsm::SubConstraintInfo &scInfo =
 203       multipleAlternatives[currentAlternativeIndex];
 204     MatchingInput = scInfo.MatchingInput;
 205     Codes = scInfo.Codes;
 206   }
 207 }
 208
 209 InlineAsm::ConstraintInfoVector
 210 InlineAsm::ParseConstraints(StringRef Constraints) {
 211   ConstraintInfoVector Result;
 212
 213   // Scan the constraints string.
 214   for (StringRef::iterator I = Constraints.begin(),
 215          E = Constraints.end(); I != E; ) {
 216     ConstraintInfo Info;
 217
 218     // Find the end of this constraint.
 219     StringRef::iterator ConstraintEnd = std::find(I, E, ',');
 220
 221     if (ConstraintEnd == I ||  // Empty constraint like ",,"
 222         Info.Parse(StringRef(I, ConstraintEnd-I), Result)) {
 223       Result.clear();          // Erroneous constraint?
 224       break;
 225     }
 226
 227     Result.push_back(Info);
 228
 229     // ConstraintEnd may be either the next comma or the end of the string.  In
 230     // the former case, we skip the comma.
 231     I = ConstraintEnd;
 232     if (I != E) {
 233       ++I;
 234       if (I == E) {
 235         Result.clear();
 236         break;
 237       } // don't allow "xyz,"
 238     }
 239   }
 240
 241   return Result;
 242 }
 243
 244 /// Verify - Verify that the specified constraint string is reasonable for the
 245 /// specified function type, and otherwise validate the constraint string.
 246 bool InlineAsm::Verify(FunctionType *Ty, StringRef ConstStr) {
 247   if (Ty->isVarArg()) return false;
 248
 249   ConstraintInfoVector Constraints = ParseConstraints(ConstStr);
 250
 251   // Error parsing constraints.
 252   if (Constraints.empty() && !ConstStr.empty()) return false;
 253
 254   unsigned NumOutputs = 0, NumInputs = 0, NumClobbers = 0;
 255   unsigned NumIndirect = 0;
 256
 257   for (unsigned i = 0, e = Constraints.size(); i != e; ++i) {
 258     switch (Constraints[i].Type) {
 259     case InlineAsm::isOutput:
 260       if ((NumInputs-NumIndirect) != 0 || NumClobbers != 0)
 261         return false;  // outputs before inputs and clobbers.
 262       if (!Constraints[i].isIndirect) {
 263         ++NumOutputs;
 264         break;
 265       }
 266       ++NumIndirect;
 267       // FALLTHROUGH for Indirect Outputs.
 268     case InlineAsm::isInput:
 269       if (NumClobbers) return false;               // inputs before clobbers.
 270       ++NumInputs;
 271       break;
 272     case InlineAsm::isClobber:
 273       ++NumClobbers;
 274       break;
 275     }
 276   }
 277
 278   switch (NumOutputs) {
 279   case 0:
 280     if (!Ty->getReturnType()->isVoidTy()) return false;
 281     break;
 282   case 1:
 283     if (Ty->getReturnType()->isStructTy()) return false;
 284     break;
 285   default:
 286     StructType *STy = dyn_cast<StructType>(Ty->getReturnType());
 287     if (!STy || STy->getNumElements() != NumOutputs)
 288       return false;
 289     break;
 290   }
 291
 292   if (Ty->getNumParams() != NumInputs) return false;
 293   return true;
 294 }