lib/AsmParser/LLParser.cpp

   1 //===-- LLParser.cpp - Parser 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 defines the parser class for .ll files.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "LLParser.h"
  15 #include "llvm/ADT/SmallPtrSet.h"
  16 #include "llvm/ADT/STLExtras.h"
  17 #include "llvm/AsmParser/SlotMapping.h"
  18 #include "llvm/IR/AutoUpgrade.h"
  19 #include "llvm/IR/CallingConv.h"
  20 #include "llvm/IR/Constants.h"
  21 #include "llvm/IR/DebugInfo.h"
  22 #include "llvm/IR/DebugInfoMetadata.h"
  23 #include "llvm/IR/DerivedTypes.h"
  24 #include "llvm/IR/InlineAsm.h"
  25 #include "llvm/IR/Instructions.h"
  26 #include "llvm/IR/LLVMContext.h"
  27 #include "llvm/IR/Module.h"
  28 #include "llvm/IR/Operator.h"
  29 #include "llvm/IR/ValueSymbolTable.h"
  30 #include "llvm/Support/Dwarf.h"
  31 #include "llvm/Support/ErrorHandling.h"
  32 #include "llvm/Support/SaveAndRestore.h"
  33 #include "llvm/Support/raw_ostream.h"
  34 using namespace llvm;
  35
  36 static std::string getTypeString(Type *T) {
  37   std::string Result;
  38   raw_string_ostream Tmp(Result);
  39   Tmp << *T;
  40   return Tmp.str();
  41 }
  42
  43 /// Run: module ::= toplevelentity*
  44 bool LLParser::Run() {
  45   // Prime the lexer.
  46   Lex.Lex();
  47
  48   return ParseTopLevelEntities() ||
  49          ValidateEndOfModule();
  50 }
  51
  52 bool LLParser::parseStandaloneConstantValue(Constant *&C,
  53                                             const SlotMapping *Slots) {
  54   restoreParsingState(Slots);
  55   Lex.Lex();
  56
  57   Type *Ty = nullptr;
  58   if (ParseType(Ty) || parseConstantValue(Ty, C))
  59     return true;
  60   if (Lex.getKind() != lltok::Eof)
  61     return Error(Lex.getLoc(), "expected end of string");
  62   return false;
  63 }
  64
  65 void LLParser::restoreParsingState(const SlotMapping *Slots) {
  66   if (!Slots)
  67     return;
  68   NumberedVals = Slots->GlobalValues;
  69   NumberedMetadata = Slots->MetadataNodes;
  70   for (const auto &I : Slots->NamedTypes)
  71     NamedTypes.insert(
  72         std::make_pair(I.getKey(), std::make_pair(I.second, LocTy())));
  73   for (const auto &I : Slots->Types)
  74     NumberedTypes.insert(
  75         std::make_pair(I.first, std::make_pair(I.second, LocTy())));
  76 }
  77
  78 /// ValidateEndOfModule - Do final validity and sanity checks at the end of the
  79 /// module.
  80 bool LLParser::ValidateEndOfModule() {
  81   for (unsigned I = 0, E = InstsWithTBAATag.size(); I < E; I++)
  82     UpgradeInstWithTBAATag(InstsWithTBAATag[I]);
  83
  84   // Handle any function attribute group forward references.
  85   for (std::map<Value*, std::vector<unsigned> >::iterator
  86          I = ForwardRefAttrGroups.begin(), E = ForwardRefAttrGroups.end();
  87          I != E; ++I) {
  88     Value *V = I->first;
  89     std::vector<unsigned> &Vec = I->second;
  90     AttrBuilder B;
  91
  92     for (std::vector<unsigned>::iterator VI = Vec.begin(), VE = Vec.end();
  93          VI != VE; ++VI)
  94       B.merge(NumberedAttrBuilders[*VI]);
  95
  96     if (Function *Fn = dyn_cast<Function>(V)) {
  97       AttributeSet AS = Fn->getAttributes();
  98       AttrBuilder FnAttrs(AS.getFnAttributes(), AttributeSet::FunctionIndex);
  99       AS = AS.removeAttributes(Context, AttributeSet::FunctionIndex,
 100                                AS.getFnAttributes());
 101
 102       FnAttrs.merge(B);
 103
 104       // If the alignment was parsed as an attribute, move to the alignment
 105       // field.
 106       if (FnAttrs.hasAlignmentAttr()) {
 107         Fn->setAlignment(FnAttrs.getAlignment());
 108         FnAttrs.removeAttribute(Attribute::Alignment);
 109       }
 110
 111       AS = AS.addAttributes(Context, AttributeSet::FunctionIndex,
 112                             AttributeSet::get(Context,
 113                                               AttributeSet::FunctionIndex,
 114                                               FnAttrs));
 115       Fn->setAttributes(AS);
 116     } else if (CallInst *CI = dyn_cast<CallInst>(V)) {
 117       AttributeSet AS = CI->getAttributes();
 118       AttrBuilder FnAttrs(AS.getFnAttributes(), AttributeSet::FunctionIndex);
 119       AS = AS.removeAttributes(Context, AttributeSet::FunctionIndex,
 120                                AS.getFnAttributes());
 121       FnAttrs.merge(B);
 122       AS = AS.addAttributes(Context, AttributeSet::FunctionIndex,
 123                             AttributeSet::get(Context,
 124                                               AttributeSet::FunctionIndex,
 125                                               FnAttrs));
 126       CI->setAttributes(AS);
 127     } else if (InvokeInst *II = dyn_cast<InvokeInst>(V)) {
 128       AttributeSet AS = II->getAttributes();
 129       AttrBuilder FnAttrs(AS.getFnAttributes(), AttributeSet::FunctionIndex);
 130       AS = AS.removeAttributes(Context, AttributeSet::FunctionIndex,
 131                                AS.getFnAttributes());
 132       FnAttrs.merge(B);
 133       AS = AS.addAttributes(Context, AttributeSet::FunctionIndex,
 134                             AttributeSet::get(Context,
 135                                               AttributeSet::FunctionIndex,
 136                                               FnAttrs));
 137       II->setAttributes(AS);
 138     } else {
 139       llvm_unreachable("invalid object with forward attribute group reference");
 140     }
 141   }
 142
 143   // If there are entries in ForwardRefBlockAddresses at this point, the
 144   // function was never defined.
 145   if (!ForwardRefBlockAddresses.empty())
 146     return Error(ForwardRefBlockAddresses.begin()->first.Loc,
 147                  "expected function name in blockaddress");
 148
 149   for (const auto &NT : NumberedTypes)
 150     if (NT.second.second.isValid())
 151       return Error(NT.second.second,
 152                    "use of undefined type '%" + Twine(NT.first) + "'");
 153
 154   for (StringMap<std::pair<Type*, LocTy> >::iterator I =
 155        NamedTypes.begin(), E = NamedTypes.end(); I != E; ++I)
 156     if (I->second.second.isValid())
 157       return Error(I->second.second,
 158                    "use of undefined type named '" + I->getKey() + "'");
 159
 160   if (!ForwardRefComdats.empty())
 161     return Error(ForwardRefComdats.begin()->second,
 162                  "use of undefined comdat '$" +
 163                      ForwardRefComdats.begin()->first + "'");
 164
 165   if (!ForwardRefVals.empty())
 166     return Error(ForwardRefVals.begin()->second.second,
 167                  "use of undefined value '@" + ForwardRefVals.begin()->first +
 168                  "'");
 169
 170   if (!ForwardRefValIDs.empty())
 171     return Error(ForwardRefValIDs.begin()->second.second,
 172                  "use of undefined value '@" +
 173                  Twine(ForwardRefValIDs.begin()->first) + "'");
 174
 175   if (!ForwardRefMDNodes.empty())
 176     return Error(ForwardRefMDNodes.begin()->second.second,
 177                  "use of undefined metadata '!" +
 178                  Twine(ForwardRefMDNodes.begin()->first) + "'");
 179
 180   // Resolve metadata cycles.
 181   for (auto &N : NumberedMetadata) {
 182     if (N.second && !N.second->isResolved())
 183       N.second->resolveCycles();
 184   }
 185
 186   // Look for intrinsic functions and CallInst that need to be upgraded
 187   for (Module::iterator FI = M->begin(), FE = M->end(); FI != FE; )
 188     UpgradeCallsToIntrinsic(&*FI++); // must be post-increment, as we remove
 189
 190   UpgradeDebugInfo(*M);
 191
 192   if (!Slots)
 193     return false;
 194   // Initialize the slot mapping.
 195   // Because by this point we've parsed and validated everything, we can "steal"
 196   // the mapping from LLParser as it doesn't need it anymore.
 197   Slots->GlobalValues = std::move(NumberedVals);
 198   Slots->MetadataNodes = std::move(NumberedMetadata);
 199   for (const auto &I : NamedTypes)
 200     Slots->NamedTypes.insert(std::make_pair(I.getKey(), I.second.first));
 201   for (const auto &I : NumberedTypes)
 202     Slots->Types.insert(std::make_pair(I.first, I.second.first));
 203
 204   return false;
 205 }
 206
 207 //===----------------------------------------------------------------------===//
 208 // Top-Level Entities
 209 //===----------------------------------------------------------------------===//
 210
 211 bool LLParser::ParseTopLevelEntities() {
 212   while (1) {
 213     switch (Lex.getKind()) {
 214     default:         return TokError("expected top-level entity");
 215     case lltok::Eof: return false;
 216     case lltok::kw_declare: if (ParseDeclare()) return true; break;
 217     case lltok::kw_define:  if (ParseDefine()) return true; break;
 218     case lltok::kw_module:  if (ParseModuleAsm()) return true; break;
 219     case lltok::kw_target:  if (ParseTargetDefinition()) return true; break;
 220     case lltok::kw_deplibs: if (ParseDepLibs()) return true; break;
 221     case lltok::LocalVarID: if (ParseUnnamedType()) return true; break;
 222     case lltok::LocalVar:   if (ParseNamedType()) return true; break;
 223     case lltok::GlobalID:   if (ParseUnnamedGlobal()) return true; break;
 224     case lltok::GlobalVar:  if (ParseNamedGlobal()) return true; break;
 225     case lltok::ComdatVar:  if (parseComdat()) return true; break;
 226     case lltok::exclaim:    if (ParseStandaloneMetadata()) return true; break;
 227     case lltok::MetadataVar:if (ParseNamedMetadata()) return true; break;
 228
 229     // The Global variable production with no name can have many different
 230     // optional leading prefixes, the production is:
 231     // GlobalVar ::= OptionalLinkage OptionalVisibility OptionalDLLStorageClass
 232     //               OptionalThreadLocal OptionalAddrSpace OptionalUnnamedAddr
 233     //               ('constant'|'global') ...
 234     case lltok::kw_private:             // OptionalLinkage
 235     case lltok::kw_internal:            // OptionalLinkage
 236     case lltok::kw_weak:                // OptionalLinkage
 237     case lltok::kw_weak_odr:            // OptionalLinkage
 238     case lltok::kw_linkonce:            // OptionalLinkage
 239     case lltok::kw_linkonce_odr:        // OptionalLinkage
 240     case lltok::kw_appending:           // OptionalLinkage
 241     case lltok::kw_common:              // OptionalLinkage
 242     case lltok::kw_extern_weak:         // OptionalLinkage
 243     case lltok::kw_external:            // OptionalLinkage
 244     case lltok::kw_default:             // OptionalVisibility
 245     case lltok::kw_hidden:              // OptionalVisibility
 246     case lltok::kw_protected:           // OptionalVisibility
 247     case lltok::kw_dllimport:           // OptionalDLLStorageClass
 248     case lltok::kw_dllexport:           // OptionalDLLStorageClass
 249     case lltok::kw_thread_local:        // OptionalThreadLocal
 250     case lltok::kw_addrspace:           // OptionalAddrSpace
 251     case lltok::kw_constant:            // GlobalType
 252     case lltok::kw_global: {            // GlobalType
 253       unsigned Linkage, Visibility, DLLStorageClass;
 254       bool UnnamedAddr;
 255       GlobalVariable::ThreadLocalMode TLM;
 256       bool HasLinkage;
 257       if (ParseOptionalLinkage(Linkage, HasLinkage) ||
 258           ParseOptionalVisibility(Visibility) ||
 259           ParseOptionalDLLStorageClass(DLLStorageClass) ||
 260           ParseOptionalThreadLocal(TLM) ||
 261           parseOptionalUnnamedAddr(UnnamedAddr) ||
 262           ParseGlobal("", SMLoc(), Linkage, HasLinkage, Visibility,
 263                       DLLStorageClass, TLM, UnnamedAddr))
 264         return true;
 265       break;
 266     }
 267
 268     case lltok::kw_attributes: if (ParseUnnamedAttrGrp()) return true; break;
 269     case lltok::kw_uselistorder: if (ParseUseListOrder()) return true; break;
 270     case lltok::kw_uselistorder_bb:
 271                                  if (ParseUseListOrderBB()) return true; break;
 272     }
 273   }
 274 }
 275
 276
 277 /// toplevelentity
 278 ///   ::= 'module' 'asm' STRINGCONSTANT
 279 bool LLParser::ParseModuleAsm() {
 280   assert(Lex.getKind() == lltok::kw_module);
 281   Lex.Lex();
 282
 283   std::string AsmStr;
 284   if (ParseToken(lltok::kw_asm, "expected 'module asm'") ||
 285       ParseStringConstant(AsmStr)) return true;
 286
 287   M->appendModuleInlineAsm(AsmStr);
 288   return false;
 289 }
 290
 291 /// toplevelentity
 292 ///   ::= 'target' 'triple' '=' STRINGCONSTANT
 293 ///   ::= 'target' 'datalayout' '=' STRINGCONSTANT
 294 bool LLParser::ParseTargetDefinition() {
 295   assert(Lex.getKind() == lltok::kw_target);
 296   std::string Str;
 297   switch (Lex.Lex()) {
 298   default: return TokError("unknown target property");
 299   case lltok::kw_triple:
 300     Lex.Lex();
 301     if (ParseToken(lltok::equal, "expected '=' after target triple") ||
 302         ParseStringConstant(Str))
 303       return true;
 304     M->setTargetTriple(Str);
 305     return false;
 306   case lltok::kw_datalayout:
 307     Lex.Lex();
 308     if (ParseToken(lltok::equal, "expected '=' after target datalayout") ||
 309         ParseStringConstant(Str))
 310       return true;
 311     M->setDataLayout(Str);
 312     return false;
 313   }
 314 }
 315
 316 /// toplevelentity
 317 ///   ::= 'deplibs' '=' '[' ']'
 318 ///   ::= 'deplibs' '=' '[' STRINGCONSTANT (',' STRINGCONSTANT)* ']'
 319 /// FIXME: Remove in 4.0. Currently parse, but ignore.
 320 bool LLParser::ParseDepLibs() {
 321   assert(Lex.getKind() == lltok::kw_deplibs);
 322   Lex.Lex();
 323   if (ParseToken(lltok::equal, "expected '=' after deplibs") ||
 324       ParseToken(lltok::lsquare, "expected '=' after deplibs"))
 325     return true;
 326
 327   if (EatIfPresent(lltok::rsquare))
 328     return false;
 329
 330   do {
 331     std::string Str;
 332     if (ParseStringConstant(Str)) return true;
 333   } while (EatIfPresent(lltok::comma));
 334
 335   return ParseToken(lltok::rsquare, "expected ']' at end of list");
 336 }
 337
 338 /// ParseUnnamedType:
 339 ///   ::= LocalVarID '=' 'type' type
 340 bool LLParser::ParseUnnamedType() {
 341   LocTy TypeLoc = Lex.getLoc();
 342   unsigned TypeID = Lex.getUIntVal();
 343   Lex.Lex(); // eat LocalVarID;
 344
 345   if (ParseToken(lltok::equal, "expected '=' after name") ||
 346       ParseToken(lltok::kw_type, "expected 'type' after '='"))
 347     return true;
 348
 349   Type *Result = nullptr;
 350   if (ParseStructDefinition(TypeLoc, "",
 351                             NumberedTypes[TypeID], Result)) return true;
 352
 353   if (!isa<StructType>(Result)) {
 354     std::pair<Type*, LocTy> &Entry = NumberedTypes[TypeID];
 355     if (Entry.first)
 356       return Error(TypeLoc, "non-struct types may not be recursive");
 357     Entry.first = Result;
 358     Entry.second = SMLoc();
 359   }
 360
 361   return false;
 362 }
 363
 364
 365 /// toplevelentity
 366 ///   ::= LocalVar '=' 'type' type
 367 bool LLParser::ParseNamedType() {
 368   std::string Name = Lex.getStrVal();
 369   LocTy NameLoc = Lex.getLoc();
 370   Lex.Lex();  // eat LocalVar.
 371
 372   if (ParseToken(lltok::equal, "expected '=' after name") ||
 373       ParseToken(lltok::kw_type, "expected 'type' after name"))
 374     return true;
 375
 376   Type *Result = nullptr;
 377   if (ParseStructDefinition(NameLoc, Name,
 378                             NamedTypes[Name], Result)) return true;
 379
 380   if (!isa<StructType>(Result)) {
 381     std::pair<Type*, LocTy> &Entry = NamedTypes[Name];
 382     if (Entry.first)
 383       return Error(NameLoc, "non-struct types may not be recursive");
 384     Entry.first = Result;
 385     Entry.second = SMLoc();
 386   }
 387
 388   return false;
 389 }
 390
 391
 392 /// toplevelentity
 393 ///   ::= 'declare' FunctionHeader
 394 bool LLParser::ParseDeclare() {
 395   assert(Lex.getKind() == lltok::kw_declare);
 396   Lex.Lex();
 397
 398   Function *F;
 399   return ParseFunctionHeader(F, false);
 400 }
 401
 402 /// toplevelentity
 403 ///   ::= 'define' FunctionHeader (!dbg !56)* '{' ...
 404 bool LLParser::ParseDefine() {
 405   assert(Lex.getKind() == lltok::kw_define);
 406   Lex.Lex();
 407
 408   Function *F;
 409   return ParseFunctionHeader(F, true) ||
 410          ParseOptionalFunctionMetadata(*F) ||
 411          ParseFunctionBody(*F);
 412 }
 413
 414 /// ParseGlobalType
 415 ///   ::= 'constant'
 416 ///   ::= 'global'
 417 bool LLParser::ParseGlobalType(bool &IsConstant) {
 418   if (Lex.getKind() == lltok::kw_constant)
 419     IsConstant = true;
 420   else if (Lex.getKind() == lltok::kw_global)
 421     IsConstant = false;
 422   else {
 423     IsConstant = false;
 424     return TokError("expected 'global' or 'constant'");
 425   }
 426   Lex.Lex();
 427   return false;
 428 }
 429
 430 /// ParseUnnamedGlobal:
 431 ///   OptionalVisibility ALIAS ...
 432 ///   OptionalLinkage OptionalVisibility OptionalDLLStorageClass
 433 ///                                                     ...   -> global variable
 434 ///   GlobalID '=' OptionalVisibility ALIAS ...
 435 ///   GlobalID '=' OptionalLinkage OptionalVisibility OptionalDLLStorageClass
 436 ///                                                     ...   -> global variable
 437 bool LLParser::ParseUnnamedGlobal() {
 438   unsigned VarID = NumberedVals.size();
 439   std::string Name;
 440   LocTy NameLoc = Lex.getLoc();
 441
 442   // Handle the GlobalID form.
 443   if (Lex.getKind() == lltok::GlobalID) {
 444     if (Lex.getUIntVal() != VarID)
 445       return Error(Lex.getLoc(), "variable expected to be numbered '%" +
 446                    Twine(VarID) + "'");
 447     Lex.Lex(); // eat GlobalID;
 448
 449     if (ParseToken(lltok::equal, "expected '=' after name"))
 450       return true;
 451   }
 452
 453   bool HasLinkage;
 454   unsigned Linkage, Visibility, DLLStorageClass;
 455   GlobalVariable::ThreadLocalMode TLM;
 456   bool UnnamedAddr;
 457   if (ParseOptionalLinkage(Linkage, HasLinkage) ||
 458       ParseOptionalVisibility(Visibility) ||
 459       ParseOptionalDLLStorageClass(DLLStorageClass) ||
 460       ParseOptionalThreadLocal(TLM) ||
 461       parseOptionalUnnamedAddr(UnnamedAddr))
 462     return true;
 463
 464   if (Lex.getKind() != lltok::kw_alias)
 465     return ParseGlobal(Name, NameLoc, Linkage, HasLinkage, Visibility,
 466                        DLLStorageClass, TLM, UnnamedAddr);
 467   return ParseAlias(Name, NameLoc, Linkage, Visibility, DLLStorageClass, TLM,
 468                     UnnamedAddr);
 469 }
 470
 471 /// ParseNamedGlobal:
 472 ///   GlobalVar '=' OptionalVisibility ALIAS ...
 473 ///   GlobalVar '=' OptionalLinkage OptionalVisibility OptionalDLLStorageClass
 474 ///                                                     ...   -> global variable
 475 bool LLParser::ParseNamedGlobal() {
 476   assert(Lex.getKind() == lltok::GlobalVar);
 477   LocTy NameLoc = Lex.getLoc();
 478   std::string Name = Lex.getStrVal();
 479   Lex.Lex();
 480
 481   bool HasLinkage;
 482   unsigned Linkage, Visibility, DLLStorageClass;
 483   GlobalVariable::ThreadLocalMode TLM;
 484   bool UnnamedAddr;
 485   if (ParseToken(lltok::equal, "expected '=' in global variable") ||
 486       ParseOptionalLinkage(Linkage, HasLinkage) ||
 487       ParseOptionalVisibility(Visibility) ||
 488       ParseOptionalDLLStorageClass(DLLStorageClass) ||
 489       ParseOptionalThreadLocal(TLM) ||
 490       parseOptionalUnnamedAddr(UnnamedAddr))
 491     return true;
 492
 493   if (Lex.getKind() != lltok::kw_alias)
 494     return ParseGlobal(Name, NameLoc, Linkage, HasLinkage, Visibility,
 495                        DLLStorageClass, TLM, UnnamedAddr);
 496
 497   return ParseAlias(Name, NameLoc, Linkage, Visibility, DLLStorageClass, TLM,
 498                     UnnamedAddr);
 499 }
 500
 501 bool LLParser::parseComdat() {
 502   assert(Lex.getKind() == lltok::ComdatVar);
 503   std::string Name = Lex.getStrVal();
 504   LocTy NameLoc = Lex.getLoc();
 505   Lex.Lex();
 506
 507   if (ParseToken(lltok::equal, "expected '=' here"))
 508     return true;
 509
 510   if (ParseToken(lltok::kw_comdat, "expected comdat keyword"))
 511     return TokError("expected comdat type");
 512
 513   Comdat::SelectionKind SK;
 514   switch (Lex.getKind()) {
 515   default:
 516     return TokError("unknown selection kind");
 517   case lltok::kw_any:
 518     SK = Comdat::Any;
 519     break;
 520   case lltok::kw_exactmatch:
 521     SK = Comdat::ExactMatch;
 522     break;
 523   case lltok::kw_largest:
 524     SK = Comdat::Largest;
 525     break;
 526   case lltok::kw_noduplicates:
 527     SK = Comdat::NoDuplicates;
 528     break;
 529   case lltok::kw_samesize:
 530     SK = Comdat::SameSize;
 531     break;
 532   }
 533   Lex.Lex();
 534
 535   // See if the comdat was forward referenced, if so, use the comdat.
 536   Module::ComdatSymTabType &ComdatSymTab = M->getComdatSymbolTable();
 537   Module::ComdatSymTabType::iterator I = ComdatSymTab.find(Name);
 538   if (I != ComdatSymTab.end() && !ForwardRefComdats.erase(Name))
 539     return Error(NameLoc, "redefinition of comdat '$" + Name + "'");
 540
 541   Comdat *C;
 542   if (I != ComdatSymTab.end())
 543     C = &I->second;
 544   else
 545     C = M->getOrInsertComdat(Name);
 546   C->setSelectionKind(SK);
 547
 548   return false;
 549 }
 550
 551 // MDString:
 552 //   ::= '!' STRINGCONSTANT
 553 bool LLParser::ParseMDString(MDString *&Result) {
 554   std::string Str;
 555   if (ParseStringConstant(Str)) return true;
 556   llvm::UpgradeMDStringConstant(Str);
 557   Result = MDString::get(Context, Str);
 558   return false;
 559 }
 560
 561 // MDNode:
 562 //   ::= '!' MDNodeNumber
 563 bool LLParser::ParseMDNodeID(MDNode *&Result) {
 564   // !{ ..., !42, ... }
 565   unsigned MID = 0;
 566   if (ParseUInt32(MID))
 567     return true;
 568
 569   // If not a forward reference, just return it now.
 570   if (NumberedMetadata.count(MID)) {
 571     Result = NumberedMetadata[MID];
 572     return false;
 573   }
 574
 575   // Otherwise, create MDNode forward reference.
 576   auto &FwdRef = ForwardRefMDNodes[MID];
 577   FwdRef = std::make_pair(MDTuple::getTemporary(Context, None), Lex.getLoc());
 578
 579   Result = FwdRef.first.get();
 580   NumberedMetadata[MID].reset(Result);
 581   return false;
 582 }
 583
 584 /// ParseNamedMetadata:
 585 ///   !foo = !{ !1, !2 }
 586 bool LLParser::ParseNamedMetadata() {
 587   assert(Lex.getKind() == lltok::MetadataVar);
 588   std::string Name = Lex.getStrVal();
 589   Lex.Lex();
 590
 591   if (ParseToken(lltok::equal, "expected '=' here") ||
 592       ParseToken(lltok::exclaim, "Expected '!' here") ||
 593       ParseToken(lltok::lbrace, "Expected '{' here"))
 594     return true;
 595
 596   NamedMDNode *NMD = M->getOrInsertNamedMetadata(Name);
 597   if (Lex.getKind() != lltok::rbrace)
 598     do {
 599       if (ParseToken(lltok::exclaim, "Expected '!' here"))
 600         return true;
 601
 602       MDNode *N = nullptr;
 603       if (ParseMDNodeID(N)) return true;
 604       NMD->addOperand(N);
 605     } while (EatIfPresent(lltok::comma));
 606
 607   return ParseToken(lltok::rbrace, "expected end of metadata node");
 608 }
 609
 610 /// ParseStandaloneMetadata:
 611 ///   !42 = !{...}
 612 bool LLParser::ParseStandaloneMetadata() {
 613   assert(Lex.getKind() == lltok::exclaim);
 614   Lex.Lex();
 615   unsigned MetadataID = 0;
 616
 617   MDNode *Init;
 618   if (ParseUInt32(MetadataID) ||
 619       ParseToken(lltok::equal, "expected '=' here"))
 620     return true;
 621
 622   // Detect common error, from old metadata syntax.
 623   if (Lex.getKind() == lltok::Type)
 624     return TokError("unexpected type in metadata definition");
 625
 626   bool IsDistinct = EatIfPresent(lltok::kw_distinct);
 627   if (Lex.getKind() == lltok::MetadataVar) {
 628     if (ParseSpecializedMDNode(Init, IsDistinct))
 629       return true;
 630   } else if (ParseToken(lltok::exclaim, "Expected '!' here") ||
 631              ParseMDTuple(Init, IsDistinct))
 632     return true;
 633
 634   // See if this was forward referenced, if so, handle it.
 635   auto FI = ForwardRefMDNodes.find(MetadataID);
 636   if (FI != ForwardRefMDNodes.end()) {
 637     FI->second.first->replaceAllUsesWith(Init);
 638     ForwardRefMDNodes.erase(FI);
 639
 640     assert(NumberedMetadata[MetadataID] == Init && "Tracking VH didn't work");
 641   } else {
 642     if (NumberedMetadata.count(MetadataID))
 643       return TokError("Metadata id is already used");
 644     NumberedMetadata[MetadataID].reset(Init);
 645   }
 646
 647   return false;
 648 }
 649
 650 static bool isValidVisibilityForLinkage(unsigned V, unsigned L) {
 651   return !GlobalValue::isLocalLinkage((GlobalValue::LinkageTypes)L) ||
 652          (GlobalValue::VisibilityTypes)V == GlobalValue::DefaultVisibility;
 653 }
 654
 655 /// ParseAlias:
 656 ///   ::= GlobalVar '=' OptionalLinkage OptionalVisibility
 657 ///                     OptionalDLLStorageClass OptionalThreadLocal
 658 ///                     OptionalUnnamedAddr 'alias' Aliasee
 659 ///
 660 /// Aliasee
 661 ///   ::= TypeAndValue
 662 ///
 663 /// Everything through OptionalUnnamedAddr has already been parsed.
 664 ///
 665 bool LLParser::ParseAlias(const std::string &Name, LocTy NameLoc, unsigned L,
 666                           unsigned Visibility, unsigned DLLStorageClass,
 667                           GlobalVariable::ThreadLocalMode TLM,
 668                           bool UnnamedAddr) {
 669   assert(Lex.getKind() == lltok::kw_alias);
 670   Lex.Lex();
 671
 672   GlobalValue::LinkageTypes Linkage = (GlobalValue::LinkageTypes) L;
 673
 674   if(!GlobalAlias::isValidLinkage(Linkage))
 675     return Error(NameLoc, "invalid linkage type for alias");
 676
 677   if (!isValidVisibilityForLinkage(Visibility, L))
 678     return Error(NameLoc,
 679                  "symbol with local linkage must have default visibility");
 680
 681   Type *Ty;
 682   LocTy ExplicitTypeLoc = Lex.getLoc();
 683   if (ParseType(Ty) ||
 684       ParseToken(lltok::comma, "expected comma after alias's type"))
 685     return true;
 686
 687   Constant *Aliasee;
 688   LocTy AliaseeLoc = Lex.getLoc();
 689   if (Lex.getKind() != lltok::kw_bitcast &&
 690       Lex.getKind() != lltok::kw_getelementptr &&
 691       Lex.getKind() != lltok::kw_addrspacecast &&
 692       Lex.getKind() != lltok::kw_inttoptr) {
 693     if (ParseGlobalTypeAndValue(Aliasee))
 694       return true;
 695   } else {
 696     // The bitcast dest type is not present, it is implied by the dest type.
 697     ValID ID;
 698     if (ParseValID(ID))
 699       return true;
 700     if (ID.Kind != ValID::t_Constant)
 701       return Error(AliaseeLoc, "invalid aliasee");
 702     Aliasee = ID.ConstantVal;
 703   }
 704
 705   Type *AliaseeType = Aliasee->getType();
 706   auto *PTy = dyn_cast<PointerType>(AliaseeType);
 707   if (!PTy)
 708     return Error(AliaseeLoc, "An alias must have pointer type");
 709   unsigned AddrSpace = PTy->getAddressSpace();
 710
 711   if (Ty != PTy->getElementType())
 712     return Error(
 713         ExplicitTypeLoc,
 714         "explicit pointee type doesn't match operand's pointee type");
 715
 716   // Okay, create the alias but do not insert it into the module yet.
 717   std::unique_ptr<GlobalAlias> GA(
 718       GlobalAlias::create(Ty, AddrSpace, (GlobalValue::LinkageTypes)Linkage,
 719                           Name, Aliasee, /*Parent*/ nullptr));
 720   GA->setThreadLocalMode(TLM);
 721   GA->setVisibility((GlobalValue::VisibilityTypes)Visibility);
 722   GA->setDLLStorageClass((GlobalValue::DLLStorageClassTypes)DLLStorageClass);
 723   GA->setUnnamedAddr(UnnamedAddr);
 724
 725   if (Name.empty())
 726     NumberedVals.push_back(GA.get());
 727
 728   // See if this value already exists in the symbol table.  If so, it is either
 729   // a redefinition or a definition of a forward reference.
 730   if (GlobalValue *Val = M->getNamedValue(Name)) {
 731     // See if this was a redefinition.  If so, there is no entry in
 732     // ForwardRefVals.
 733     auto I = ForwardRefVals.find(Name);
 734     if (I == ForwardRefVals.end())
 735       return Error(NameLoc, "redefinition of global named '@" + Name + "'");
 736
 737     // Otherwise, this was a definition of forward ref.  Verify that types
 738     // agree.
 739     if (Val->getType() != GA->getType())
 740       return Error(NameLoc,
 741               "forward reference and definition of alias have different types");
 742
 743     // If they agree, just RAUW the old value with the alias and remove the
 744     // forward ref info.
 745     Val->replaceAllUsesWith(GA.get());
 746     Val->eraseFromParent();
 747     ForwardRefVals.erase(I);
 748   }
 749
 750   // Insert into the module, we know its name won't collide now.
 751   M->getAliasList().push_back(GA.get());
 752   assert(GA->getName() == Name && "Should not be a name conflict!");
 753
 754   // The module owns this now
 755   GA.release();
 756
 757   return false;
 758 }
 759
 760 /// ParseGlobal
 761 ///   ::= GlobalVar '=' OptionalLinkage OptionalVisibility OptionalDLLStorageClass
 762 ///       OptionalThreadLocal OptionalUnnamedAddr OptionalAddrSpace
 763 ///       OptionalExternallyInitialized GlobalType Type Const
 764 ///   ::= OptionalLinkage OptionalVisibility OptionalDLLStorageClass
 765 ///       OptionalThreadLocal OptionalUnnamedAddr OptionalAddrSpace
 766 ///       OptionalExternallyInitialized GlobalType Type Const
 767 ///
 768 /// Everything up to and including OptionalUnnamedAddr has been parsed
 769 /// already.
 770 ///
 771 bool LLParser::ParseGlobal(const std::string &Name, LocTy NameLoc,
 772                            unsigned Linkage, bool HasLinkage,
 773                            unsigned Visibility, unsigned DLLStorageClass,
 774                            GlobalVariable::ThreadLocalMode TLM,
 775                            bool UnnamedAddr) {
 776   if (!isValidVisibilityForLinkage(Visibility, Linkage))
 777     return Error(NameLoc,
 778                  "symbol with local linkage must have default visibility");
 779
 780   unsigned AddrSpace;
 781   bool IsConstant, IsExternallyInitialized;
 782   LocTy IsExternallyInitializedLoc;
 783   LocTy TyLoc;
 784
 785   Type *Ty = nullptr;
 786   if (ParseOptionalAddrSpace(AddrSpace) ||
 787       ParseOptionalToken(lltok::kw_externally_initialized,
 788                          IsExternallyInitialized,
 789                          &IsExternallyInitializedLoc) ||
 790       ParseGlobalType(IsConstant) ||
 791       ParseType(Ty, TyLoc))
 792     return true;
 793
 794   // If the linkage is specified and is external, then no initializer is
 795   // present.
 796   Constant *Init = nullptr;
 797   if (!HasLinkage || (Linkage != GlobalValue::ExternalWeakLinkage &&
 798                       Linkage != GlobalValue::ExternalLinkage)) {
 799     if (ParseGlobalValue(Ty, Init))
 800       return true;
 801   }
 802
 803   if (Ty->isFunctionTy() || !PointerType::isValidElementType(Ty))
 804     return Error(TyLoc, "invalid type for global variable");
 805
 806   GlobalValue *GVal = nullptr;
 807
 808   // See if the global was forward referenced, if so, use the global.
 809   if (!Name.empty()) {
 810     GVal = M->getNamedValue(Name);
 811     if (GVal) {
 812       if (!ForwardRefVals.erase(Name) || !isa<GlobalValue>(GVal))
 813         return Error(NameLoc, "redefinition of global '@" + Name + "'");
 814     }
 815   } else {
 816     auto I = ForwardRefValIDs.find(NumberedVals.size());
 817     if (I != ForwardRefValIDs.end()) {
 818       GVal = I->second.first;
 819       ForwardRefValIDs.erase(I);
 820     }
 821   }
 822
 823   GlobalVariable *GV;
 824   if (!GVal) {
 825     GV = new GlobalVariable(*M, Ty, false, GlobalValue::ExternalLinkage, nullptr,
 826                             Name, nullptr, GlobalVariable::NotThreadLocal,
 827                             AddrSpace);
 828   } else {
 829     if (GVal->getValueType() != Ty)
 830       return Error(TyLoc,
 831             "forward reference and definition of global have different types");
 832
 833     GV = cast<GlobalVariable>(GVal);
 834
 835     // Move the forward-reference to the correct spot in the module.
 836     M->getGlobalList().splice(M->global_end(), M->getGlobalList(), GV);
 837   }
 838
 839   if (Name.empty())
 840     NumberedVals.push_back(GV);
 841
 842   // Set the parsed properties on the global.
 843   if (Init)
 844     GV->setInitializer(Init);
 845   GV->setConstant(IsConstant);
 846   GV->setLinkage((GlobalValue::LinkageTypes)Linkage);
 847   GV->setVisibility((GlobalValue::VisibilityTypes)Visibility);
 848   GV->setDLLStorageClass((GlobalValue::DLLStorageClassTypes)DLLStorageClass);
 849   GV->setExternallyInitialized(IsExternallyInitialized);
 850   GV->setThreadLocalMode(TLM);
 851   GV->setUnnamedAddr(UnnamedAddr);
 852
 853   // Parse attributes on the global.
 854   while (Lex.getKind() == lltok::comma) {
 855     Lex.Lex();
 856
 857     if (Lex.getKind() == lltok::kw_section) {
 858       Lex.Lex();
 859       GV->setSection(Lex.getStrVal());
 860       if (ParseToken(lltok::StringConstant, "expected global section string"))
 861         return true;
 862     } else if (Lex.getKind() == lltok::kw_align) {
 863       unsigned Alignment;
 864       if (ParseOptionalAlignment(Alignment)) return true;
 865       GV->setAlignment(Alignment);
 866     } else {
 867       Comdat *C;
 868       if (parseOptionalComdat(Name, C))
 869         return true;
 870       if (C)
 871         GV->setComdat(C);
 872       else
 873         return TokError("unknown global variable property!");
 874     }
 875   }
 876
 877   return false;
 878 }
 879
 880 /// ParseUnnamedAttrGrp
 881 ///   ::= 'attributes' AttrGrpID '=' '{' AttrValPair+ '}'
 882 bool LLParser::ParseUnnamedAttrGrp() {
 883   assert(Lex.getKind() == lltok::kw_attributes);
 884   LocTy AttrGrpLoc = Lex.getLoc();
 885   Lex.Lex();
 886
 887   if (Lex.getKind() != lltok::AttrGrpID)
 888     return TokError("expected attribute group id");
 889
 890   unsigned VarID = Lex.getUIntVal();
 891   std::vector<unsigned> unused;
 892   LocTy BuiltinLoc;
 893   Lex.Lex();
 894
 895   if (ParseToken(lltok::equal, "expected '=' here") ||
 896       ParseToken(lltok::lbrace, "expected '{' here") ||
 897       ParseFnAttributeValuePairs(NumberedAttrBuilders[VarID], unused, true,
 898                                  BuiltinLoc) ||
 899       ParseToken(lltok::rbrace, "expected end of attribute group"))
 900     return true;
 901
 902   if (!NumberedAttrBuilders[VarID].hasAttributes())
 903     return Error(AttrGrpLoc, "attribute group has no attributes");
 904
 905   return false;
 906 }
 907
 908 /// ParseFnAttributeValuePairs
 909 ///   ::= <attr> | <attr> '=' <value>
 910 bool LLParser::ParseFnAttributeValuePairs(AttrBuilder &B,
 911                                           std::vector<unsigned> &FwdRefAttrGrps,
 912                                           bool inAttrGrp, LocTy &BuiltinLoc) {
 913   bool HaveError = false;
 914
 915   B.clear();
 916
 917   while (true) {
 918     lltok::Kind Token = Lex.getKind();
 919     if (Token == lltok::kw_builtin)
 920       BuiltinLoc = Lex.getLoc();
 921     switch (Token) {
 922     default:
 923       if (!inAttrGrp) return HaveError;
 924       return Error(Lex.getLoc(), "unterminated attribute group");
 925     case lltok::rbrace:
 926       // Finished.
 927       return false;
 928
 929     case lltok::AttrGrpID: {
 930       // Allow a function to reference an attribute group:
 931       //
 932       //   define void @foo() #1 { ... }
 933       if (inAttrGrp)
 934         HaveError |=
 935           Error(Lex.getLoc(),
 936               "cannot have an attribute group reference in an attribute group");
 937
 938       unsigned AttrGrpNum = Lex.getUIntVal();
 939       if (inAttrGrp) break;
 940
 941       // Save the reference to the attribute group. We'll fill it in later.
 942       FwdRefAttrGrps.push_back(AttrGrpNum);
 943       break;
 944     }
 945     // Target-dependent attributes:
 946     case lltok::StringConstant: {
 947       if (ParseStringAttribute(B))
 948         return true;
 949       continue;
 950     }
 951
 952     // Target-independent attributes:
 953     case lltok::kw_align: {
 954       // As a hack, we allow function alignment to be initially parsed as an
 955       // attribute on a function declaration/definition or added to an attribute
 956       // group and later moved to the alignment field.
 957       unsigned Alignment;
 958       if (inAttrGrp) {
 959         Lex.Lex();
 960         if (ParseToken(lltok::equal, "expected '=' here") ||
 961             ParseUInt32(Alignment))
 962           return true;
 963       } else {
 964         if (ParseOptionalAlignment(Alignment))
 965           return true;
 966       }
 967       B.addAlignmentAttr(Alignment);
 968       continue;
 969     }
 970     case lltok::kw_alignstack: {
 971       unsigned Alignment;
 972       if (inAttrGrp) {
 973         Lex.Lex();
 974         if (ParseToken(lltok::equal, "expected '=' here") ||
 975             ParseUInt32(Alignment))
 976           return true;
 977       } else {
 978         if (ParseOptionalStackAlignment(Alignment))
 979           return true;
 980       }
 981       B.addStackAlignmentAttr(Alignment);
 982       continue;
 983     }
 984     case lltok::kw_alwaysinline: B.addAttribute(Attribute::AlwaysInline); break;
 985     case lltok::kw_argmemonly: B.addAttribute(Attribute::ArgMemOnly); break;
 986     case lltok::kw_builtin: B.addAttribute(Attribute::Builtin); break;
 987     case lltok::kw_cold: B.addAttribute(Attribute::Cold); break;
 988     case lltok::kw_convergent: B.addAttribute(Attribute::Convergent); break;
 989     case lltok::kw_inlinehint: B.addAttribute(Attribute::InlineHint); break;
 990     case lltok::kw_jumptable: B.addAttribute(Attribute::JumpTable); break;
 991     case lltok::kw_minsize: B.addAttribute(Attribute::MinSize); break;
 992     case lltok::kw_naked: B.addAttribute(Attribute::Naked); break;
 993     case lltok::kw_nobuiltin: B.addAttribute(Attribute::NoBuiltin); break;
 994     case lltok::kw_noduplicate: B.addAttribute(Attribute::NoDuplicate); break;
 995     case lltok::kw_noimplicitfloat:
 996       B.addAttribute(Attribute::NoImplicitFloat); break;
 997     case lltok::kw_noinline: B.addAttribute(Attribute::NoInline); break;
 998     case lltok::kw_nonlazybind: B.addAttribute(Attribute::NonLazyBind); break;
 999     case lltok::kw_noredzone: B.addAttribute(Attribute::NoRedZone); break;
1000     case lltok::kw_noreturn: B.addAttribute(Attribute::NoReturn); break;
1001     case lltok::kw_nounwind: B.addAttribute(Attribute::NoUnwind); break;
1002     case lltok::kw_optnone: B.addAttribute(Attribute::OptimizeNone); break;
1003     case lltok::kw_optsize: B.addAttribute(Attribute::OptimizeForSize); break;
1004     case lltok::kw_readnone: B.addAttribute(Attribute::ReadNone); break;
1005     case lltok::kw_readonly: B.addAttribute(Attribute::ReadOnly); break;
1006     case lltok::kw_returns_twice:
1007       B.addAttribute(Attribute::ReturnsTwice); break;
1008     case lltok::kw_ssp: B.addAttribute(Attribute::StackProtect); break;
1009     case lltok::kw_sspreq: B.addAttribute(Attribute::StackProtectReq); break;
1010     case lltok::kw_sspstrong:
1011       B.addAttribute(Attribute::StackProtectStrong); break;
1012     case lltok::kw_safestack: B.addAttribute(Attribute::SafeStack); break;
1013     case lltok::kw_sanitize_address:
1014       B.addAttribute(Attribute::SanitizeAddress); break;
1015     case lltok::kw_sanitize_thread:
1016       B.addAttribute(Attribute::SanitizeThread); break;
1017     case lltok::kw_sanitize_memory:
1018       B.addAttribute(Attribute::SanitizeMemory); break;
1019     case lltok::kw_uwtable: B.addAttribute(Attribute::UWTable); break;
1020
1021     // Error handling.
1022     case lltok::kw_inreg:
1023     case lltok::kw_signext:
1024     case lltok::kw_zeroext:
1025       HaveError |=
1026         Error(Lex.getLoc(),
1027               "invalid use of attribute on a function");
1028       break;
1029     case lltok::kw_byval:
1030     case lltok::kw_dereferenceable:
1031     case lltok::kw_dereferenceable_or_null:
1032     case lltok::kw_inalloca:
1033     case lltok::kw_nest:
1034     case lltok::kw_noalias:
1035     case lltok::kw_nocapture:
1036     case lltok::kw_nonnull:
1037     case lltok::kw_returned:
1038     case lltok::kw_sret:
1039       HaveError |=
1040         Error(Lex.getLoc(),
1041               "invalid use of parameter-only attribute on a function");
1042       break;
1043     }
1044
1045     Lex.Lex();
1046   }
1047 }
1048
1049 //===----------------------------------------------------------------------===//
1050 // GlobalValue Reference/Resolution Routines.
1051 //===----------------------------------------------------------------------===//
1052
1053 static inline GlobalValue *createGlobalFwdRef(Module *M, PointerType *PTy,
1054                                               const std::string &Name) {
1055   if (auto *FT = dyn_cast<FunctionType>(PTy->getElementType()))
1056     return Function::Create(FT, GlobalValue::ExternalWeakLinkage, Name, M);
1057   else
1058     return new GlobalVariable(*M, PTy->getElementType(), false,
1059                               GlobalValue::ExternalWeakLinkage, nullptr, Name,
1060                               nullptr, GlobalVariable::NotThreadLocal,
1061                               PTy->getAddressSpace());
1062 }
1063
1064 /// GetGlobalVal - Get a value with the specified name or ID, creating a
1065 /// forward reference record if needed.  This can return null if the value
1066 /// exists but does not have the right type.
1067 GlobalValue *LLParser::GetGlobalVal(const std::string &Name, Type *Ty,
1068                                     LocTy Loc) {
1069   PointerType *PTy = dyn_cast<PointerType>(Ty);
1070   if (!PTy) {
1071     Error(Loc, "global variable reference must have pointer type");
1072     return nullptr;
1073   }
1074
1075   // Look this name up in the normal function symbol table.
1076   GlobalValue *Val =
1077     cast_or_null<GlobalValue>(M->getValueSymbolTable().lookup(Name));
1078
1079   // If this is a forward reference for the value, see if we already created a
1080   // forward ref record.
1081   if (!Val) {
1082     auto I = ForwardRefVals.find(Name);
1083     if (I != ForwardRefVals.end())
1084       Val = I->second.first;
1085   }
1086
1087   // If we have the value in the symbol table or fwd-ref table, return it.
1088   if (Val) {
1089     if (Val->getType() == Ty) return Val;
1090     Error(Loc, "'@" + Name + "' defined with type '" +
1091           getTypeString(Val->getType()) + "'");
1092     return nullptr;
1093   }
1094
1095   // Otherwise, create a new forward reference for this value and remember it.
1096   GlobalValue *FwdVal = createGlobalFwdRef(M, PTy, Name);
1097   ForwardRefVals[Name] = std::make_pair(FwdVal, Loc);
1098   return FwdVal;
1099 }
1100
1101 GlobalValue *LLParser::GetGlobalVal(unsigned ID, Type *Ty, LocTy Loc) {
1102   PointerType *PTy = dyn_cast<PointerType>(Ty);
1103   if (!PTy) {
1104     Error(Loc, "global variable reference must have pointer type");
1105     return nullptr;
1106   }
1107
1108   GlobalValue *Val = ID < NumberedVals.size() ? NumberedVals[ID] : nullptr;
1109
1110   // If this is a forward reference for the value, see if we already created a
1111   // forward ref record.
1112   if (!Val) {
1113     auto I = ForwardRefValIDs.find(ID);
1114     if (I != ForwardRefValIDs.end())
1115       Val = I->second.first;
1116   }
1117
1118   // If we have the value in the symbol table or fwd-ref table, return it.
1119   if (Val) {
1120     if (Val->getType() == Ty) return Val;
1121     Error(Loc, "'@" + Twine(ID) + "' defined with type '" +
1122           getTypeString(Val->getType()) + "'");
1123     return nullptr;
1124   }
1125
1126   // Otherwise, create a new forward reference for this value and remember it.
1127   GlobalValue *FwdVal = createGlobalFwdRef(M, PTy, "");
1128   ForwardRefValIDs[ID] = std::make_pair(FwdVal, Loc);
1129   return FwdVal;
1130 }
1131
1132
1133 //===----------------------------------------------------------------------===//
1134 // Comdat Reference/Resolution Routines.
1135 //===----------------------------------------------------------------------===//
1136
1137 Comdat *LLParser::getComdat(const std::string &Name, LocTy Loc) {
1138   // Look this name up in the comdat symbol table.
1139   Module::ComdatSymTabType &ComdatSymTab = M->getComdatSymbolTable();
1140   Module::ComdatSymTabType::iterator I = ComdatSymTab.find(Name);
1141   if (I != ComdatSymTab.end())
1142     return &I->second;
1143
1144   // Otherwise, create a new forward reference for this value and remember it.
1145   Comdat *C = M->getOrInsertComdat(Name);
1146   ForwardRefComdats[Name] = Loc;
1147   return C;
1148 }
1149
1150
1151 //===----------------------------------------------------------------------===//
1152 // Helper Routines.
1153 //===----------------------------------------------------------------------===//
1154
1155 /// ParseToken - If the current token has the specified kind, eat it and return
1156 /// success.  Otherwise, emit the specified error and return failure.
1157 bool LLParser::ParseToken(lltok::Kind T, const char *ErrMsg) {
1158   if (Lex.getKind() != T)
1159     return TokError(ErrMsg);
1160   Lex.Lex();
1161   return false;
1162 }
1163
1164 /// ParseStringConstant
1165 ///   ::= StringConstant
1166 bool LLParser::ParseStringConstant(std::string &Result) {
1167   if (Lex.getKind() != lltok::StringConstant)
1168     return TokError("expected string constant");
1169   Result = Lex.getStrVal();
1170   Lex.Lex();
1171   return false;
1172 }
1173
1174 /// ParseUInt32
1175 ///   ::= uint32
1176 bool LLParser::ParseUInt32(unsigned &Val) {
1177   if (Lex.getKind() != lltok::APSInt || Lex.getAPSIntVal().isSigned())
1178     return TokError("expected integer");
1179   uint64_t Val64 = Lex.getAPSIntVal().getLimitedValue(0xFFFFFFFFULL+1);
1180   if (Val64 != unsigned(Val64))
1181     return TokError("expected 32-bit integer (too large)");
1182   Val = Val64;
1183   Lex.Lex();
1184   return false;
1185 }
1186
1187 /// ParseUInt64
1188 ///   ::= uint64
1189 bool LLParser::ParseUInt64(uint64_t &Val) {
1190   if (Lex.getKind() != lltok::APSInt || Lex.getAPSIntVal().isSigned())
1191     return TokError("expected integer");
1192   Val = Lex.getAPSIntVal().getLimitedValue();
1193   Lex.Lex();
1194   return false;
1195 }
1196
1197 /// ParseTLSModel
1198 ///   := 'localdynamic'
1199 ///   := 'initialexec'
1200 ///   := 'localexec'
1201 bool LLParser::ParseTLSModel(GlobalVariable::ThreadLocalMode &TLM) {
1202   switch (Lex.getKind()) {
1203     default:
1204       return TokError("expected localdynamic, initialexec or localexec");
1205     case lltok::kw_localdynamic:
1206       TLM = GlobalVariable::LocalDynamicTLSModel;
1207       break;
1208     case lltok::kw_initialexec:
1209       TLM = GlobalVariable::InitialExecTLSModel;
1210       break;
1211     case lltok::kw_localexec:
1212       TLM = GlobalVariable::LocalExecTLSModel;
1213       break;
1214   }
1215
1216   Lex.Lex();
1217   return false;
1218 }
1219
1220 /// ParseOptionalThreadLocal
1221 ///   := /*empty*/
1222 ///   := 'thread_local'
1223 ///   := 'thread_local' '(' tlsmodel ')'
1224 bool LLParser::ParseOptionalThreadLocal(GlobalVariable::ThreadLocalMode &TLM) {
1225   TLM = GlobalVariable::NotThreadLocal;
1226   if (!EatIfPresent(lltok::kw_thread_local))
1227     return false;
1228
1229   TLM = GlobalVariable::GeneralDynamicTLSModel;
1230   if (Lex.getKind() == lltok::lparen) {
1231     Lex.Lex();
1232     return ParseTLSModel(TLM) ||
1233       ParseToken(lltok::rparen, "expected ')' after thread local model");
1234   }
1235   return false;
1236 }
1237
1238 /// ParseOptionalAddrSpace
1239 ///   := /*empty*/
1240 ///   := 'addrspace' '(' uint32 ')'
1241 bool LLParser::ParseOptionalAddrSpace(unsigned &AddrSpace) {
1242   AddrSpace = 0;
1243   if (!EatIfPresent(lltok::kw_addrspace))
1244     return false;
1245   return ParseToken(lltok::lparen, "expected '(' in address space") ||
1246          ParseUInt32(AddrSpace) ||
1247          ParseToken(lltok::rparen, "expected ')' in address space");
1248 }
1249
1250 /// ParseStringAttribute
1251 ///   := StringConstant
1252 ///   := StringConstant '=' StringConstant
1253 bool LLParser::ParseStringAttribute(AttrBuilder &B) {
1254   std::string Attr = Lex.getStrVal();
1255   Lex.Lex();
1256   std::string Val;
1257   if (EatIfPresent(lltok::equal) && ParseStringConstant(Val))
1258     return true;
1259   B.addAttribute(Attr, Val);
1260   return false;
1261 }
1262
1263 /// ParseOptionalParamAttrs - Parse a potentially empty list of parameter attributes.
1264 bool LLParser::ParseOptionalParamAttrs(AttrBuilder &B) {
1265   bool HaveError = false;
1266
1267   B.clear();
1268
1269   while (1) {
1270     lltok::Kind Token = Lex.getKind();
1271     switch (Token) {
1272     default:  // End of attributes.
1273       return HaveError;
1274     case lltok::StringConstant: {
1275       if (ParseStringAttribute(B))
1276         return true;
1277       continue;
1278     }
1279     case lltok::kw_align: {
1280       unsigned Alignment;
1281       if (ParseOptionalAlignment(Alignment))
1282         return true;
1283       B.addAlignmentAttr(Alignment);
1284       continue;
1285     }
1286     case lltok::kw_byval:           B.addAttribute(Attribute::ByVal); break;
1287     case lltok::kw_dereferenceable: {
1288       uint64_t Bytes;
1289       if (ParseOptionalDerefAttrBytes(lltok::kw_dereferenceable, Bytes))
1290         return true;
1291       B.addDereferenceableAttr(Bytes);
1292       continue;
1293     }
1294     case lltok::kw_dereferenceable_or_null: {
1295       uint64_t Bytes;
1296       if (ParseOptionalDerefAttrBytes(lltok::kw_dereferenceable_or_null, Bytes))
1297         return true;
1298       B.addDereferenceableOrNullAttr(Bytes);
1299       continue;
1300     }
1301     case lltok::kw_inalloca:        B.addAttribute(Attribute::InAlloca); break;
1302     case lltok::kw_inreg:           B.addAttribute(Attribute::InReg); break;
1303     case lltok::kw_nest:            B.addAttribute(Attribute::Nest); break;
1304     case lltok::kw_noalias:         B.addAttribute(Attribute::NoAlias); break;
1305     case lltok::kw_nocapture:       B.addAttribute(Attribute::NoCapture); break;
1306     case lltok::kw_nonnull:         B.addAttribute(Attribute::NonNull); break;
1307     case lltok::kw_readnone:        B.addAttribute(Attribute::ReadNone); break;
1308     case lltok::kw_readonly:        B.addAttribute(Attribute::ReadOnly); break;
1309     case lltok::kw_returned:        B.addAttribute(Attribute::Returned); break;
1310     case lltok::kw_signext:         B.addAttribute(Attribute::SExt); break;
1311     case lltok::kw_sret:            B.addAttribute(Attribute::StructRet); break;
1312     case lltok::kw_zeroext:         B.addAttribute(Attribute::ZExt); break;
1313
1314     case lltok::kw_alignstack:
1315     case lltok::kw_alwaysinline:
1316     case lltok::kw_argmemonly:
1317     case lltok::kw_builtin:
1318     case lltok::kw_inlinehint:
1319     case lltok::kw_jumptable:
1320     case lltok::kw_minsize:
1321     case lltok::kw_naked:
1322     case lltok::kw_nobuiltin:
1323     case lltok::kw_noduplicate:
1324     case lltok::kw_noimplicitfloat:
1325     case lltok::kw_noinline:
1326     case lltok::kw_nonlazybind:
1327     case lltok::kw_noredzone:
1328     case lltok::kw_noreturn:
1329     case lltok::kw_nounwind:
1330     case lltok::kw_optnone:
1331     case lltok::kw_optsize:
1332     case lltok::kw_returns_twice:
1333     case lltok::kw_sanitize_address:
1334     case lltok::kw_sanitize_memory:
1335     case lltok::kw_sanitize_thread:
1336     case lltok::kw_ssp:
1337     case lltok::kw_sspreq:
1338     case lltok::kw_sspstrong:
1339     case lltok::kw_safestack:
1340     case lltok::kw_uwtable:
1341       HaveError |= Error(Lex.getLoc(), "invalid use of function-only attribute");
1342       break;
1343     }
1344
1345     Lex.Lex();
1346   }
1347 }
1348
1349 /// ParseOptionalReturnAttrs - Parse a potentially empty list of return attributes.
1350 bool LLParser::ParseOptionalReturnAttrs(AttrBuilder &B) {
1351   bool HaveError = false;
1352
1353   B.clear();
1354
1355   while (1) {
1356     lltok::Kind Token = Lex.getKind();
1357     switch (Token) {
1358     default:  // End of attributes.
1359       return HaveError;
1360     case lltok::StringConstant: {
1361       if (ParseStringAttribute(B))
1362         return true;
1363       continue;
1364     }
1365     case lltok::kw_dereferenceable: {
1366       uint64_t Bytes;
1367       if (ParseOptionalDerefAttrBytes(lltok::kw_dereferenceable, Bytes))
1368         return true;
1369       B.addDereferenceableAttr(Bytes);
1370       continue;
1371     }
1372     case lltok::kw_dereferenceable_or_null: {
1373       uint64_t Bytes;
1374       if (ParseOptionalDerefAttrBytes(lltok::kw_dereferenceable_or_null, Bytes))
1375         return true;
1376       B.addDereferenceableOrNullAttr(Bytes);
1377       continue;
1378     }
1379     case lltok::kw_align: {
1380       unsigned Alignment;
1381       if (ParseOptionalAlignment(Alignment))
1382         return true;
1383       B.addAlignmentAttr(Alignment);
1384       continue;
1385     }
1386     case lltok::kw_inreg:           B.addAttribute(Attribute::InReg); break;
1387     case lltok::kw_noalias:         B.addAttribute(Attribute::NoAlias); break;
1388     case lltok::kw_nonnull:         B.addAttribute(Attribute::NonNull); break;
1389     case lltok::kw_signext:         B.addAttribute(Attribute::SExt); break;
1390     case lltok::kw_zeroext:         B.addAttribute(Attribute::ZExt); break;
1391
1392     // Error handling.
1393     case lltok::kw_byval:
1394     case lltok::kw_inalloca:
1395     case lltok::kw_nest:
1396     case lltok::kw_nocapture:
1397     case lltok::kw_returned:
1398     case lltok::kw_sret:
1399       HaveError |= Error(Lex.getLoc(), "invalid use of parameter-only attribute");
1400       break;
1401
1402     case lltok::kw_alignstack:
1403     case lltok::kw_alwaysinline:
1404     case lltok::kw_argmemonly:
1405     case lltok::kw_builtin:
1406     case lltok::kw_cold:
1407     case lltok::kw_inlinehint:
1408     case lltok::kw_jumptable:
1409     case lltok::kw_minsize:
1410     case lltok::kw_naked:
1411     case lltok::kw_nobuiltin:
1412     case lltok::kw_noduplicate:
1413     case lltok::kw_noimplicitfloat:
1414     case lltok::kw_noinline:
1415     case lltok::kw_nonlazybind:
1416     case lltok::kw_noredzone:
1417     case lltok::kw_noreturn:
1418     case lltok::kw_nounwind:
1419     case lltok::kw_optnone:
1420     case lltok::kw_optsize:
1421     case lltok::kw_returns_twice:
1422     case lltok::kw_sanitize_address:
1423     case lltok::kw_sanitize_memory:
1424     case lltok::kw_sanitize_thread:
1425     case lltok::kw_ssp:
1426     case lltok::kw_sspreq:
1427     case lltok::kw_sspstrong:
1428     case lltok::kw_safestack:
1429     case lltok::kw_uwtable:
1430       HaveError |= Error(Lex.getLoc(), "invalid use of function-only attribute");
1431       break;
1432
1433     case lltok::kw_readnone:
1434     case lltok::kw_readonly:
1435       HaveError |= Error(Lex.getLoc(), "invalid use of attribute on return type");
1436     }
1437
1438     Lex.Lex();
1439   }
1440 }
1441
1442 /// ParseOptionalLinkage
1443 ///   ::= /*empty*/
1444 ///   ::= 'private'
1445 ///   ::= 'internal'
1446 ///   ::= 'weak'
1447 ///   ::= 'weak_odr'
1448 ///   ::= 'linkonce'
1449 ///   ::= 'linkonce_odr'
1450 ///   ::= 'available_externally'
1451 ///   ::= 'appending'
1452 ///   ::= 'common'
1453 ///   ::= 'extern_weak'
1454 ///   ::= 'external'
1455 bool LLParser::ParseOptionalLinkage(unsigned &Res, bool &HasLinkage) {
1456   HasLinkage = false;
1457   switch (Lex.getKind()) {
1458   default:                       Res=GlobalValue::ExternalLinkage; return false;
1459   case lltok::kw_private:        Res = GlobalValue::PrivateLinkage;       break;
1460   case lltok::kw_internal:       Res = GlobalValue::InternalLinkage;      break;
1461   case lltok::kw_weak:           Res = GlobalValue::WeakAnyLinkage;       break;
1462   case lltok::kw_weak_odr:       Res = GlobalValue::WeakODRLinkage;       break;
1463   case lltok::kw_linkonce:       Res = GlobalValue::LinkOnceAnyLinkage;   break;
1464   case lltok::kw_linkonce_odr:   Res = GlobalValue::LinkOnceODRLinkage;   break;
1465   case lltok::kw_available_externally:
1466     Res = GlobalValue::AvailableExternallyLinkage;
1467     break;
1468   case lltok::kw_appending:      Res = GlobalValue::AppendingLinkage;     break;
1469   case lltok::kw_common:         Res = GlobalValue::CommonLinkage;        break;
1470   case lltok::kw_extern_weak:    Res = GlobalValue::ExternalWeakLinkage;  break;
1471   case lltok::kw_external:       Res = GlobalValue::ExternalLinkage;      break;
1472   }
1473   Lex.Lex();
1474   HasLinkage = true;
1475   return false;
1476 }
1477
1478 /// ParseOptionalVisibility
1479 ///   ::= /*empty*/
1480 ///   ::= 'default'
1481 ///   ::= 'hidden'
1482 ///   ::= 'protected'
1483 ///
1484 bool LLParser::ParseOptionalVisibility(unsigned &Res) {
1485   switch (Lex.getKind()) {
1486   default:                  Res = GlobalValue::DefaultVisibility; return false;
1487   case lltok::kw_default:   Res = GlobalValue::DefaultVisibility; break;
1488   case lltok::kw_hidden:    Res = GlobalValue::HiddenVisibility; break;
1489   case lltok::kw_protected: Res = GlobalValue::ProtectedVisibility; break;
1490   }
1491   Lex.Lex();
1492   return false;
1493 }
1494
1495 /// ParseOptionalDLLStorageClass
1496 ///   ::= /*empty*/
1497 ///   ::= 'dllimport'
1498 ///   ::= 'dllexport'
1499 ///
1500 bool LLParser::ParseOptionalDLLStorageClass(unsigned &Res) {
1501   switch (Lex.getKind()) {
1502   default:                  Res = GlobalValue::DefaultStorageClass; return false;
1503   case lltok::kw_dllimport: Res = GlobalValue::DLLImportStorageClass; break;
1504   case lltok::kw_dllexport: Res = GlobalValue::DLLExportStorageClass; break;
1505   }
1506   Lex.Lex();
1507   return false;
1508 }
1509
1510 /// ParseOptionalCallingConv
1511 ///   ::= /*empty*/
1512 ///   ::= 'ccc'
1513 ///   ::= 'fastcc'
1514 ///   ::= 'intel_ocl_bicc'
1515 ///   ::= 'coldcc'
1516 ///   ::= 'x86_stdcallcc'
1517 ///   ::= 'x86_fastcallcc'
1518 ///   ::= 'x86_thiscallcc'
1519 ///   ::= 'x86_vectorcallcc'
1520 ///   ::= 'arm_apcscc'
1521 ///   ::= 'arm_aapcscc'
1522 ///   ::= 'arm_aapcs_vfpcc'
1523 ///   ::= 'msp430_intrcc'
1524 ///   ::= 'ptx_kernel'
1525 ///   ::= 'ptx_device'
1526 ///   ::= 'spir_func'
1527 ///   ::= 'spir_kernel'
1528 ///   ::= 'x86_64_sysvcc'
1529 ///   ::= 'x86_64_win64cc'
1530 ///   ::= 'webkit_jscc'
1531 ///   ::= 'anyregcc'
1532 ///   ::= 'preserve_mostcc'
1533 ///   ::= 'preserve_allcc'
1534 ///   ::= 'ghccc'
1535 ///   ::= 'hhvmcc'
1536 ///   ::= 'hhvm_ccc'
1537 ///   ::= 'cc' UINT
1538 ///
1539 bool LLParser::ParseOptionalCallingConv(unsigned &CC) {
1540   switch (Lex.getKind()) {
1541   default:                       CC = CallingConv::C; return false;
1542   case lltok::kw_ccc:            CC = CallingConv::C; break;
1543   case lltok::kw_fastcc:         CC = CallingConv::Fast; break;
1544   case lltok::kw_coldcc:         CC = CallingConv::Cold; break;
1545   case lltok::kw_x86_stdcallcc:  CC = CallingConv::X86_StdCall; break;
1546   case lltok::kw_x86_fastcallcc: CC = CallingConv::X86_FastCall; break;
1547   case lltok::kw_x86_thiscallcc: CC = CallingConv::X86_ThisCall; break;
1548   case lltok::kw_x86_vectorcallcc:CC = CallingConv::X86_VectorCall; break;
1549   case lltok::kw_arm_apcscc:     CC = CallingConv::ARM_APCS; break;
1550   case lltok::kw_arm_aapcscc:    CC = CallingConv::ARM_AAPCS; break;
1551   case lltok::kw_arm_aapcs_vfpcc:CC = CallingConv::ARM_AAPCS_VFP; break;
1552   case lltok::kw_msp430_intrcc:  CC = CallingConv::MSP430_INTR; break;
1553   case lltok::kw_ptx_kernel:     CC = CallingConv::PTX_Kernel; break;
1554   case lltok::kw_ptx_device:     CC = CallingConv::PTX_Device; break;
1555   case lltok::kw_spir_kernel:    CC = CallingConv::SPIR_KERNEL; break;
1556   case lltok::kw_spir_func:      CC = CallingConv::SPIR_FUNC; break;
1557   case lltok::kw_intel_ocl_bicc: CC = CallingConv::Intel_OCL_BI; break;
1558   case lltok::kw_x86_64_sysvcc:  CC = CallingConv::X86_64_SysV; break;
1559   case lltok::kw_x86_64_win64cc: CC = CallingConv::X86_64_Win64; break;
1560   case lltok::kw_webkit_jscc:    CC = CallingConv::WebKit_JS; break;
1561   case lltok::kw_anyregcc:       CC = CallingConv::AnyReg; break;
1562   case lltok::kw_preserve_mostcc:CC = CallingConv::PreserveMost; break;
1563   case lltok::kw_preserve_allcc: CC = CallingConv::PreserveAll; break;
1564   case lltok::kw_ghccc:          CC = CallingConv::GHC; break;
1565   case lltok::kw_hhvmcc:         CC = CallingConv::HHVM; break;
1566   case lltok::kw_hhvm_ccc:       CC = CallingConv::HHVM_C; break;
1567   case lltok::kw_cc: {
1568       Lex.Lex();
1569       return ParseUInt32(CC);
1570     }
1571   }
1572
1573   Lex.Lex();
1574   return false;
1575 }
1576
1577 /// ParseMetadataAttachment
1578 ///   ::= !dbg !42
1579 bool LLParser::ParseMetadataAttachment(unsigned &Kind, MDNode *&MD) {
1580   assert(Lex.getKind() == lltok::MetadataVar && "Expected metadata attachment");
1581
1582   std::string Name = Lex.getStrVal();
1583   Kind = M->getMDKindID(Name);
1584   Lex.Lex();
1585
1586   return ParseMDNode(MD);
1587 }
1588
1589 /// ParseInstructionMetadata
1590 ///   ::= !dbg !42 (',' !dbg !57)*
1591 bool LLParser::ParseInstructionMetadata(Instruction &Inst) {
1592   do {
1593     if (Lex.getKind() != lltok::MetadataVar)
1594       return TokError("expected metadata after comma");
1595
1596     unsigned MDK;
1597     MDNode *N;
1598     if (ParseMetadataAttachment(MDK, N))
1599       return true;
1600
1601     Inst.setMetadata(MDK, N);
1602     if (MDK == LLVMContext::MD_tbaa)
1603       InstsWithTBAATag.push_back(&Inst);
1604
1605     // If this is the end of the list, we're done.
1606   } while (EatIfPresent(lltok::comma));
1607   return false;
1608 }
1609
1610 /// ParseOptionalFunctionMetadata
1611 ///   ::= (!dbg !57)*
1612 bool LLParser::ParseOptionalFunctionMetadata(Function &F) {
1613   while (Lex.getKind() == lltok::MetadataVar) {
1614     unsigned MDK;
1615     MDNode *N;
1616     if (ParseMetadataAttachment(MDK, N))
1617       return true;
1618
1619     F.setMetadata(MDK, N);
1620   }
1621   return false;
1622 }
1623
1624 /// ParseOptionalAlignment
1625 ///   ::= /* empty */
1626 ///   ::= 'align' 4
1627 bool LLParser::ParseOptionalAlignment(unsigned &Alignment) {
1628   Alignment = 0;
1629   if (!EatIfPresent(lltok::kw_align))
1630     return false;
1631   LocTy AlignLoc = Lex.getLoc();
1632   if (ParseUInt32(Alignment)) return true;
1633   if (!isPowerOf2_32(Alignment))
1634     return Error(AlignLoc, "alignment is not a power of two");
1635   if (Alignment > Value::MaximumAlignment)
1636     return Error(AlignLoc, "huge alignments are not supported yet");
1637   return false;
1638 }
1639
1640 /// ParseOptionalDerefAttrBytes
1641 ///   ::= /* empty */
1642 ///   ::= AttrKind '(' 4 ')'
1643 ///
1644 /// where AttrKind is either 'dereferenceable' or 'dereferenceable_or_null'.
1645 bool LLParser::ParseOptionalDerefAttrBytes(lltok::Kind AttrKind,
1646                                            uint64_t &Bytes) {
1647   assert((AttrKind == lltok::kw_dereferenceable ||
1648           AttrKind == lltok::kw_dereferenceable_or_null) &&
1649          "contract!");
1650
1651   Bytes = 0;
1652   if (!EatIfPresent(AttrKind))
1653     return false;
1654   LocTy ParenLoc = Lex.getLoc();
1655   if (!EatIfPresent(lltok::lparen))
1656     return Error(ParenLoc, "expected '('");
1657   LocTy DerefLoc = Lex.getLoc();
1658   if (ParseUInt64(Bytes)) return true;
1659   ParenLoc = Lex.getLoc();
1660   if (!EatIfPresent(lltok::rparen))
1661     return Error(ParenLoc, "expected ')'");
1662   if (!Bytes)
1663     return Error(DerefLoc, "dereferenceable bytes must be non-zero");
1664   return false;
1665 }
1666
1667 /// ParseOptionalCommaAlign
1668 ///   ::=
1669 ///   ::= ',' align 4
1670 ///
1671 /// This returns with AteExtraComma set to true if it ate an excess comma at the
1672 /// end.
1673 bool LLParser::ParseOptionalCommaAlign(unsigned &Alignment,
1674                                        bool &AteExtraComma) {
1675   AteExtraComma = false;
1676   while (EatIfPresent(lltok::comma)) {
1677     // Metadata at the end is an early exit.
1678     if (Lex.getKind() == lltok::MetadataVar) {
1679       AteExtraComma = true;
1680       return false;
1681     }
1682
1683     if (Lex.getKind() != lltok::kw_align)
1684       return Error(Lex.getLoc(), "expected metadata or 'align'");
1685
1686     if (ParseOptionalAlignment(Alignment)) return true;
1687   }
1688
1689   return false;
1690 }
1691
1692 /// ParseScopeAndOrdering
1693 ///   if isAtomic: ::= 'singlethread'? AtomicOrdering
1694 ///   else: ::=
1695 ///
1696 /// This sets Scope and Ordering to the parsed values.
1697 bool LLParser::ParseScopeAndOrdering(bool isAtomic, SynchronizationScope &Scope,
1698                                      AtomicOrdering &Ordering) {
1699   if (!isAtomic)
1700     return false;
1701
1702   Scope = CrossThread;
1703   if (EatIfPresent(lltok::kw_singlethread))
1704     Scope = SingleThread;
1705
1706   return ParseOrdering(Ordering);
1707 }
1708
1709 /// ParseOrdering
1710 ///   ::= AtomicOrdering
1711 ///
1712 /// This sets Ordering to the parsed value.
1713 bool LLParser::ParseOrdering(AtomicOrdering &Ordering) {
1714   switch (Lex.getKind()) {
1715   default: return TokError("Expected ordering on atomic instruction");
1716   case lltok::kw_unordered: Ordering = Unordered; break;
1717   case lltok::kw_monotonic: Ordering = Monotonic; break;
1718   case lltok::kw_acquire: Ordering = Acquire; break;
1719   case lltok::kw_release: Ordering = Release; break;
1720   case lltok::kw_acq_rel: Ordering = AcquireRelease; break;
1721   case lltok::kw_seq_cst: Ordering = SequentiallyConsistent; break;
1722   }
1723   Lex.Lex();
1724   return false;
1725 }
1726
1727 /// ParseOptionalStackAlignment
1728 ///   ::= /* empty */
1729 ///   ::= 'alignstack' '(' 4 ')'
1730 bool LLParser::ParseOptionalStackAlignment(unsigned &Alignment) {
1731   Alignment = 0;
1732   if (!EatIfPresent(lltok::kw_alignstack))
1733     return false;
1734   LocTy ParenLoc = Lex.getLoc();
1735   if (!EatIfPresent(lltok::lparen))
1736     return Error(ParenLoc, "expected '('");
1737   LocTy AlignLoc = Lex.getLoc();
1738   if (ParseUInt32(Alignment)) return true;
1739   ParenLoc = Lex.getLoc();
1740   if (!EatIfPresent(lltok::rparen))
1741     return Error(ParenLoc, "expected ')'");
1742   if (!isPowerOf2_32(Alignment))
1743     return Error(AlignLoc, "stack alignment is not a power of two");
1744   return false;
1745 }
1746
1747 /// ParseIndexList - This parses the index list for an insert/extractvalue
1748 /// instruction.  This sets AteExtraComma in the case where we eat an extra
1749 /// comma at the end of the line and find that it is followed by metadata.
1750 /// Clients that don't allow metadata can call the version of this function that
1751 /// only takes one argument.
1752 ///
1753 /// ParseIndexList
1754 ///    ::=  (',' uint32)+
1755 ///
1756 bool LLParser::ParseIndexList(SmallVectorImpl<unsigned> &Indices,
1757                               bool &AteExtraComma) {
1758   AteExtraComma = false;
1759
1760   if (Lex.getKind() != lltok::comma)
1761     return TokError("expected ',' as start of index list");
1762
1763   while (EatIfPresent(lltok::comma)) {
1764     if (Lex.getKind() == lltok::MetadataVar) {
1765       if (Indices.empty()) return TokError("expected index");
1766       AteExtraComma = true;
1767       return false;
1768     }
1769     unsigned Idx = 0;
1770     if (ParseUInt32(Idx)) return true;
1771     Indices.push_back(Idx);
1772   }
1773
1774   return false;
1775 }
1776
1777 //===----------------------------------------------------------------------===//
1778 // Type Parsing.
1779 //===----------------------------------------------------------------------===//
1780
1781 /// ParseType - Parse a type.
1782 bool LLParser::ParseType(Type *&Result, const Twine &Msg, bool AllowVoid) {
1783   SMLoc TypeLoc = Lex.getLoc();
1784   switch (Lex.getKind()) {
1785   default:
1786     return TokError(Msg);
1787   case lltok::Type:
1788     // Type ::= 'float' | 'void' (etc)
1789     Result = Lex.getTyVal();
1790     Lex.Lex();
1791     break;
1792   case lltok::lbrace:
1793     // Type ::= StructType
1794     if (ParseAnonStructType(Result, false))
1795       return true;
1796     break;
1797   case lltok::lsquare:
1798     // Type ::= '[' ... ']'
1799     Lex.Lex(); // eat the lsquare.
1800     if (ParseArrayVectorType(Result, false))
1801       return true;
1802     break;
1803   case lltok::less: // Either vector or packed struct.
1804     // Type ::= '<' ... '>'
1805     Lex.Lex();
1806     if (Lex.getKind() == lltok::lbrace) {
1807       if (ParseAnonStructType(Result, true) ||
1808           ParseToken(lltok::greater, "expected '>' at end of packed struct"))
1809         return true;
1810     } else if (ParseArrayVectorType(Result, true))
1811       return true;
1812     break;
1813   case lltok::LocalVar: {
1814     // Type ::= %foo
1815     std::pair<Type*, LocTy> &Entry = NamedTypes[Lex.getStrVal()];
1816
1817     // If the type hasn't been defined yet, create a forward definition and
1818     // remember where that forward def'n was seen (in case it never is defined).
1819     if (!Entry.first) {
1820       Entry.first = StructType::create(Context, Lex.getStrVal());
1821       Entry.second = Lex.getLoc();
1822     }
1823     Result = Entry.first;
1824     Lex.Lex();
1825     break;
1826   }
1827
1828   case lltok::LocalVarID: {
1829     // Type ::= %4
1830     std::pair<Type*, LocTy> &Entry = NumberedTypes[Lex.getUIntVal()];
1831
1832     // If the type hasn't been defined yet, create a forward definition and
1833     // remember where that forward def'n was seen (in case it never is defined).
1834     if (!Entry.first) {
1835       Entry.first = StructType::create(Context);
1836       Entry.second = Lex.getLoc();
1837     }
1838     Result = Entry.first;
1839     Lex.Lex();
1840     break;
1841   }
1842   }
1843
1844   // Parse the type suffixes.
1845   while (1) {
1846     switch (Lex.getKind()) {
1847     // End of type.
1848     default:
1849       if (!AllowVoid && Result->isVoidTy())
1850         return Error(TypeLoc, "void type only allowed for function results");
1851       return false;
1852
1853     // Type ::= Type '*'
1854     case lltok::star:
1855       if (Result->isLabelTy())
1856         return TokError("basic block pointers are invalid");
1857       if (Result->isVoidTy())
1858         return TokError("pointers to void are invalid - use i8* instead");
1859       if (!PointerType::isValidElementType(Result))
1860         return TokError("pointer to this type is invalid");
1861       Result = PointerType::getUnqual(Result);
1862       Lex.Lex();
1863       break;
1864
1865     // Type ::= Type 'addrspace' '(' uint32 ')' '*'
1866     case lltok::kw_addrspace: {
1867       if (Result->isLabelTy())
1868         return TokError("basic block pointers are invalid");
1869       if (Result->isVoidTy())
1870         return TokError("pointers to void are invalid; use i8* instead");
1871       if (!PointerType::isValidElementType(Result))
1872         return TokError("pointer to this type is invalid");
1873       unsigned AddrSpace;
1874       if (ParseOptionalAddrSpace(AddrSpace) ||
1875           ParseToken(lltok::star, "expected '*' in address space"))
1876         return true;
1877
1878       Result = PointerType::get(Result, AddrSpace);
1879       break;
1880     }
1881
1882     /// Types '(' ArgTypeListI ')' OptFuncAttrs
1883     case lltok::lparen:
1884       if (ParseFunctionType(Result))
1885         return true;
1886       break;
1887     }
1888   }
1889 }
1890
1891 /// ParseParameterList
1892 ///    ::= '(' ')'
1893 ///    ::= '(' Arg (',' Arg)* ')'
1894 ///  Arg
1895 ///    ::= Type OptionalAttributes Value OptionalAttributes
1896 bool LLParser::ParseParameterList(SmallVectorImpl<ParamInfo> &ArgList,
1897                                   PerFunctionState &PFS, bool IsMustTailCall,
1898                                   bool InVarArgsFunc) {
1899   if (ParseToken(lltok::lparen, "expected '(' in call"))
1900     return true;
1901
1902   unsigned AttrIndex = 1;
1903   while (Lex.getKind() != lltok::rparen) {
1904     // If this isn't the first argument, we need a comma.
1905     if (!ArgList.empty() &&
1906         ParseToken(lltok::comma, "expected ',' in argument list"))
1907       return true;
1908
1909     // Parse an ellipsis if this is a musttail call in a variadic function.
1910     if (Lex.getKind() == lltok::dotdotdot) {
1911       const char *Msg = "unexpected ellipsis in argument list for ";
1912       if (!IsMustTailCall)
1913         return TokError(Twine(Msg) + "non-musttail call");
1914       if (!InVarArgsFunc)
1915         return TokError(Twine(Msg) + "musttail call in non-varargs function");
1916       Lex.Lex();  // Lex the '...', it is purely for readability.
1917       return ParseToken(lltok::rparen, "expected ')' at end of argument list");
1918     }
1919
1920     // Parse the argument.
1921     LocTy ArgLoc;
1922     Type *ArgTy = nullptr;
1923     AttrBuilder ArgAttrs;
1924     Value *V;
1925     if (ParseType(ArgTy, ArgLoc))
1926       return true;
1927
1928     if (ArgTy->isMetadataTy()) {
1929       if (ParseMetadataAsValue(V, PFS))
1930         return true;
1931     } else {
1932       // Otherwise, handle normal operands.
1933       if (ParseOptionalParamAttrs(ArgAttrs) || ParseValue(ArgTy, V, PFS))
1934         return true;
1935     }
1936     ArgList.push_back(ParamInfo(ArgLoc, V, AttributeSet::get(V->getContext(),
1937                                                              AttrIndex++,
1938                                                              ArgAttrs)));
1939   }
1940
1941   if (IsMustTailCall && InVarArgsFunc)
1942     return TokError("expected '...' at end of argument list for musttail call "
1943                     "in varargs function");
1944
1945   Lex.Lex();  // Lex the ')'.
1946   return false;
1947 }
1948
1949 /// ParseOptionalOperandBundles
1950 ///    ::= /*empty*/
1951 ///    ::= '[' OperandBundle [, OperandBundle ]* ']'
1952 ///
1953 /// OperandBundle
1954 ///    ::= bundle-tag '(' ')'
1955 ///    ::= bundle-tag '(' Type Value [, Type Value ]* ')'
1956 ///
1957 /// bundle-tag ::= String Constant
1958 bool LLParser::ParseOptionalOperandBundles(
1959     SmallVectorImpl<OperandBundleDef> &BundleList, PerFunctionState &PFS) {
1960   LocTy BeginLoc = Lex.getLoc();
1961   if (!EatIfPresent(lltok::lsquare))
1962     return false;
1963
1964   while (Lex.getKind() != lltok::rsquare) {
1965     // If this isn't the first operand bundle, we need a comma.
1966     if (!BundleList.empty() &&
1967         ParseToken(lltok::comma, "expected ',' in input list"))
1968       return true;
1969
1970     std::string Tag;
1971     if (ParseStringConstant(Tag))
1972       return true;
1973
1974     BundleList.emplace_back();
1975     auto &OBI = BundleList.back();
1976
1977     OBI.Tag = std::move(Tag);
1978
1979     if (ParseToken(lltok::lparen, "expected '(' in operand bundle"))
1980       return true;
1981
1982     while (Lex.getKind() != lltok::rparen) {
1983       // If this isn't the first input, we need a comma.
1984       if (!OBI.Inputs.empty() &&
1985           ParseToken(lltok::comma, "expected ',' in input list"))
1986         return true;
1987
1988       Type *Ty = nullptr;
1989       Value *Input = nullptr;
1990       if (ParseType(Ty) || ParseValue(Ty, Input, PFS))
1991         return true;
1992       OBI.Inputs.push_back(Input);
1993     }
1994
1995     Lex.Lex(); // Lex the ')'.
1996   }
1997
1998   if (BundleList.empty())
1999     return Error(BeginLoc, "operand bundle set must not be empty");
2000
2001   Lex.Lex(); // Lex the ']'.
2002   return false;
2003 }
2004
2005 /// ParseArgumentList - Parse the argument list for a function type or function
2006 /// prototype.
2007 ///   ::= '(' ArgTypeListI ')'
2008 /// ArgTypeListI
2009 ///   ::= /*empty*/
2010 ///   ::= '...'
2011 ///   ::= ArgTypeList ',' '...'
2012 ///   ::= ArgType (',' ArgType)*
2013 ///
2014 bool LLParser::ParseArgumentList(SmallVectorImpl<ArgInfo> &ArgList,
2015                                  bool &isVarArg){
2016   isVarArg = false;
2017   assert(Lex.getKind() == lltok::lparen);
2018   Lex.Lex(); // eat the (.
2019
2020   if (Lex.getKind() == lltok::rparen) {
2021     // empty
2022   } else if (Lex.getKind() == lltok::dotdotdot) {
2023     isVarArg = true;
2024     Lex.Lex();
2025   } else {
2026     LocTy TypeLoc = Lex.getLoc();
2027     Type *ArgTy = nullptr;
2028     AttrBuilder Attrs;
2029     std::string Name;
2030
2031     if (ParseType(ArgTy) ||
2032         ParseOptionalParamAttrs(Attrs)) return true;
2033
2034     if (ArgTy->isVoidTy())
2035       return Error(TypeLoc, "argument can not have void type");
2036
2037     if (Lex.getKind() == lltok::LocalVar) {
2038       Name = Lex.getStrVal();
2039       Lex.Lex();
2040     }
2041
2042     if (!FunctionType::isValidArgumentType(ArgTy))
2043       return Error(TypeLoc, "invalid type for function argument");
2044
2045     unsigned AttrIndex = 1;
2046     ArgList.emplace_back(TypeLoc, ArgTy, AttributeSet::get(ArgTy->getContext(),
2047                                                            AttrIndex++, Attrs),
2048                          std::move(Name));
2049
2050     while (EatIfPresent(lltok::comma)) {
2051       // Handle ... at end of arg list.
2052       if (EatIfPresent(lltok::dotdotdot)) {
2053         isVarArg = true;
2054         break;
2055       }
2056
2057       // Otherwise must be an argument type.
2058       TypeLoc = Lex.getLoc();
2059       if (ParseType(ArgTy) || ParseOptionalParamAttrs(Attrs)) return true;
2060
2061       if (ArgTy->isVoidTy())
2062         return Error(TypeLoc, "argument can not have void type");
2063
2064       if (Lex.getKind() == lltok::LocalVar) {
2065         Name = Lex.getStrVal();
2066         Lex.Lex();
2067       } else {
2068         Name = "";
2069       }
2070
2071       if (!ArgTy->isFirstClassType())
2072         return Error(TypeLoc, "invalid type for function argument");
2073
2074       ArgList.emplace_back(
2075           TypeLoc, ArgTy,
2076           AttributeSet::get(ArgTy->getContext(), AttrIndex++, Attrs),
2077           std::move(Name));
2078     }
2079   }
2080
2081   return ParseToken(lltok::rparen, "expected ')' at end of argument list");
2082 }
2083
2084 /// ParseFunctionType
2085 ///  ::= Type ArgumentList OptionalAttrs
2086 bool LLParser::ParseFunctionType(Type *&Result) {
2087   assert(Lex.getKind() == lltok::lparen);
2088
2089   if (!FunctionType::isValidReturnType(Result))
2090     return TokError("invalid function return type");
2091
2092   SmallVector<ArgInfo, 8> ArgList;
2093   bool isVarArg;
2094   if (ParseArgumentList(ArgList, isVarArg))
2095     return true;
2096
2097   // Reject names on the arguments lists.
2098   for (unsigned i = 0, e = ArgList.size(); i != e; ++i) {
2099     if (!ArgList[i].Name.empty())
2100       return Error(ArgList[i].Loc, "argument name invalid in function type");
2101     if (ArgList[i].Attrs.hasAttributes(i + 1))
2102       return Error(ArgList[i].Loc,
2103                    "argument attributes invalid in function type");
2104   }
2105
2106   SmallVector<Type*, 16> ArgListTy;
2107   for (unsigned i = 0, e = ArgList.size(); i != e; ++i)
2108     ArgListTy.push_back(ArgList[i].Ty);
2109
2110   Result = FunctionType::get(Result, ArgListTy, isVarArg);
2111   return false;
2112 }
2113
2114 /// ParseAnonStructType - Parse an anonymous struct type, which is inlined into
2115 /// other structs.
2116 bool LLParser::ParseAnonStructType(Type *&Result, bool Packed) {
2117   SmallVector<Type*, 8> Elts;
2118   if (ParseStructBody(Elts)) return true;
2119
2120   Result = StructType::get(Context, Elts, Packed);
2121   return false;
2122 }
2123
2124 /// ParseStructDefinition - Parse a struct in a 'type' definition.
2125 bool LLParser::ParseStructDefinition(SMLoc TypeLoc, StringRef Name,
2126                                      std::pair<Type*, LocTy> &Entry,
2127                                      Type *&ResultTy) {
2128   // If the type was already defined, diagnose the redefinition.
2129   if (Entry.first && !Entry.second.isValid())
2130     return Error(TypeLoc, "redefinition of type");
2131
2132   // If we have opaque, just return without filling in the definition for the
2133   // struct.  This counts as a definition as far as the .ll file goes.
2134   if (EatIfPresent(lltok::kw_opaque)) {
2135     // This type is being defined, so clear the location to indicate this.
2136     Entry.second = SMLoc();
2137
2138     // If this type number has never been uttered, create it.
2139     if (!Entry.first)
2140       Entry.first = StructType::create(Context, Name);
2141     ResultTy = Entry.first;
2142     return false;
2143   }
2144
2145   // If the type starts with '<', then it is either a packed struct or a vector.
2146   bool isPacked = EatIfPresent(lltok::less);
2147
2148   // If we don't have a struct, then we have a random type alias, which we
2149   // accept for compatibility with old files.  These types are not allowed to be
2150   // forward referenced and not allowed to be recursive.
2151   if (Lex.getKind() != lltok::lbrace) {
2152     if (Entry.first)
2153       return Error(TypeLoc, "forward references to non-struct type");
2154
2155     ResultTy = nullptr;
2156     if (isPacked)
2157       return ParseArrayVectorType(ResultTy, true);
2158     return ParseType(ResultTy);
2159   }
2160
2161   // This type is being defined, so clear the location to indicate this.
2162   Entry.second = SMLoc();
2163
2164   // If this type number has never been uttered, create it.
2165   if (!Entry.first)
2166     Entry.first = StructType::create(Context, Name);
2167
2168   StructType *STy = cast<StructType>(Entry.first);
2169
2170   SmallVector<Type*, 8> Body;
2171   if (ParseStructBody(Body) ||
2172       (isPacked && ParseToken(lltok::greater, "expected '>' in packed struct")))
2173     return true;
2174
2175   STy->setBody(Body, isPacked);
2176   ResultTy = STy;
2177   return false;
2178 }
2179
2180
2181 /// ParseStructType: Handles packed and unpacked types.  </> parsed elsewhere.
2182 ///   StructType
2183 ///     ::= '{' '}'
2184 ///     ::= '{' Type (',' Type)* '}'
2185 ///     ::= '<' '{' '}' '>'
2186 ///     ::= '<' '{' Type (',' Type)* '}' '>'
2187 bool LLParser::ParseStructBody(SmallVectorImpl<Type*> &Body) {
2188   assert(Lex.getKind() == lltok::lbrace);
2189   Lex.Lex(); // Consume the '{'
2190
2191   // Handle the empty struct.
2192   if (EatIfPresent(lltok::rbrace))
2193     return false;
2194
2195   LocTy EltTyLoc = Lex.getLoc();
2196   Type *Ty = nullptr;
2197   if (ParseType(Ty)) return true;
2198   Body.push_back(Ty);
2199
2200   if (!StructType::isValidElementType(Ty))
2201     return Error(EltTyLoc, "invalid element type for struct");
2202
2203   while (EatIfPresent(lltok::comma)) {
2204     EltTyLoc = Lex.getLoc();
2205     if (ParseType(Ty)) return true;
2206
2207     if (!StructType::isValidElementType(Ty))
2208       return Error(EltTyLoc, "invalid element type for struct");
2209
2210     Body.push_back(Ty);
2211   }
2212
2213   return ParseToken(lltok::rbrace, "expected '}' at end of struct");
2214 }
2215
2216 /// ParseArrayVectorType - Parse an array or vector type, assuming the first
2217 /// token has already been consumed.
2218 ///   Type
2219 ///     ::= '[' APSINTVAL 'x' Types ']'
2220 ///     ::= '<' APSINTVAL 'x' Types '>'
2221 bool LLParser::ParseArrayVectorType(Type *&Result, bool isVector) {
2222   if (Lex.getKind() != lltok::APSInt || Lex.getAPSIntVal().isSigned() ||
2223       Lex.getAPSIntVal().getBitWidth() > 64)
2224     return TokError("expected number in address space");
2225
2226   LocTy SizeLoc = Lex.getLoc();
2227   uint64_t Size = Lex.getAPSIntVal().getZExtValue();
2228   Lex.Lex();
2229
2230   if (ParseToken(lltok::kw_x, "expected 'x' after element count"))
2231       return true;
2232
2233   LocTy TypeLoc = Lex.getLoc();
2234   Type *EltTy = nullptr;
2235   if (ParseType(EltTy)) return true;
2236
2237   if (ParseToken(isVector ? lltok::greater : lltok::rsquare,
2238                  "expected end of sequential type"))
2239     return true;
2240
2241   if (isVector) {
2242     if (Size == 0)
2243       return Error(SizeLoc, "zero element vector is illegal");
2244     if ((unsigned)Size != Size)
2245       return Error(SizeLoc, "size too large for vector");
2246     if (!VectorType::isValidElementType(EltTy))
2247       return Error(TypeLoc, "invalid vector element type");
2248     Result = VectorType::get(EltTy, unsigned(Size));
2249   } else {
2250     if (!ArrayType::isValidElementType(EltTy))
2251       return Error(TypeLoc, "invalid array element type");
2252     Result = ArrayType::get(EltTy, Size);
2253   }
2254   return false;
2255 }
2256
2257 //===----------------------------------------------------------------------===//
2258 // Function Semantic Analysis.
2259 //===----------------------------------------------------------------------===//
2260
2261 LLParser::PerFunctionState::PerFunctionState(LLParser &p, Function &f,
2262                                              int functionNumber)
2263   : P(p), F(f), FunctionNumber(functionNumber) {
2264
2265   // Insert unnamed arguments into the NumberedVals list.
2266   for (Argument &A : F.args())
2267     if (!A.hasName())
2268       NumberedVals.push_back(&A);
2269 }
2270
2271 LLParser::PerFunctionState::~PerFunctionState() {
2272   // If there were any forward referenced non-basicblock values, delete them.
2273
2274   for (const auto &P : ForwardRefVals) {
2275     if (isa<BasicBlock>(P.second.first))
2276       continue;
2277     P.second.first->replaceAllUsesWith(
2278         UndefValue::get(P.second.first->getType()));
2279     delete P.second.first;
2280   }
2281
2282   for (const auto &P : ForwardRefValIDs) {
2283     if (isa<BasicBlock>(P.second.first))
2284       continue;
2285     P.second.first->replaceAllUsesWith(
2286         UndefValue::get(P.second.first->getType()));
2287     delete P.second.first;
2288   }
2289 }
2290
2291 bool LLParser::PerFunctionState::FinishFunction() {
2292   if (!ForwardRefVals.empty())
2293     return P.Error(ForwardRefVals.begin()->second.second,
2294                    "use of undefined value '%" + ForwardRefVals.begin()->first +
2295                    "'");
2296   if (!ForwardRefValIDs.empty())
2297     return P.Error(ForwardRefValIDs.begin()->second.second,
2298                    "use of undefined value '%" +
2299                    Twine(ForwardRefValIDs.begin()->first) + "'");
2300   return false;
2301 }
2302
2303
2304 /// GetVal - Get a value with the specified name or ID, creating a
2305 /// forward reference record if needed.  This can return null if the value
2306 /// exists but does not have the right type.
2307 Value *LLParser::PerFunctionState::GetVal(const std::string &Name, Type *Ty,
2308                                           LocTy Loc, OperatorConstraint OC) {
2309   // Look this name up in the normal function symbol table.
2310   Value *Val = F.getValueSymbolTable().lookup(Name);
2311
2312   // If this is a forward reference for the value, see if we already created a
2313   // forward ref record.
2314   if (!Val) {
2315     auto I = ForwardRefVals.find(Name);
2316     if (I != ForwardRefVals.end())
2317       Val = I->second.first;
2318   }
2319
2320   // If we have the value in the symbol table or fwd-ref table, return it.
2321   if (Val) {
2322     // Check operator constraints.
2323     switch (OC) {
2324     case OC_None:
2325       // no constraint
2326       break;
2327     case OC_CatchPad:
2328       if (!isa<CatchPadInst>(Val)) {
2329         P.Error(Loc, "'%" + Name + "' is not a catchpad");
2330         return nullptr;
2331       }
2332       break;
2333     case OC_CleanupPad:
2334       if (!isa<CleanupPadInst>(Val)) {
2335         P.Error(Loc, "'%" + Name + "' is not a cleanuppad");
2336         return nullptr;
2337       }
2338       break;
2339     }
2340     if (Val->getType() == Ty) return Val;
2341     if (Ty->isLabelTy())
2342       P.Error(Loc, "'%" + Name + "' is not a basic block");
2343     else
2344       P.Error(Loc, "'%" + Name + "' defined with type '" +
2345               getTypeString(Val->getType()) + "'");
2346     return nullptr;
2347   }
2348
2349   // Don't make placeholders with invalid type.
2350   if (!Ty->isFirstClassType()) {
2351     P.Error(Loc, "invalid use of a non-first-class type");
2352     return nullptr;
2353   }
2354
2355   // Otherwise, create a new forward reference for this value and remember it.
2356   Value *FwdVal;
2357   if (Ty->isLabelTy()) {
2358     assert(!OC);
2359     FwdVal = BasicBlock::Create(F.getContext(), Name, &F);
2360   } else if (!OC) {
2361     FwdVal = new Argument(Ty, Name);
2362   } else {
2363     switch (OC) {
2364     case OC_CatchPad:
2365       FwdVal = CatchPadInst::Create(&F.getEntryBlock(), &F.getEntryBlock(), {},
2366                                     Name);
2367       break;
2368     case OC_CleanupPad:
2369       FwdVal = CleanupPadInst::Create(F.getContext(), {}, Name);
2370       break;
2371     default:
2372       llvm_unreachable("unexpected constraint");
2373     }
2374   }
2375
2376   ForwardRefVals[Name] = std::make_pair(FwdVal, Loc);
2377   return FwdVal;
2378 }
2379
2380 Value *LLParser::PerFunctionState::GetVal(unsigned ID, Type *Ty, LocTy Loc,
2381                                           OperatorConstraint OC) {
2382   // Look this name up in the normal function symbol table.
2383   Value *Val = ID < NumberedVals.size() ? NumberedVals[ID] : nullptr;
2384
2385   // If this is a forward reference for the value, see if we already created a
2386   // forward ref record.
2387   if (!Val) {
2388     auto I = ForwardRefValIDs.find(ID);
2389     if (I != ForwardRefValIDs.end())
2390       Val = I->second.first;
2391   }
2392
2393   // If we have the value in the symbol table or fwd-ref table, return it.
2394   if (Val) {
2395     // Check operator constraint.
2396     switch (OC) {
2397     case OC_None:
2398       // no constraint
2399       break;
2400     case OC_CatchPad:
2401       if (!isa<CatchPadInst>(Val)) {
2402         P.Error(Loc, "'%" + Twine(ID) + "' is not a catchpad");
2403         return nullptr;
2404       }
2405       break;
2406     case OC_CleanupPad:
2407       if (!isa<CleanupPadInst>(Val)) {
2408         P.Error(Loc, "'%" + Twine(ID) + "' is not a cleanuppad");
2409         return nullptr;
2410       }
2411       break;
2412     }
2413     if (Val->getType() == Ty) return Val;
2414     if (Ty->isLabelTy())
2415       P.Error(Loc, "'%" + Twine(ID) + "' is not a basic block");
2416     else
2417       P.Error(Loc, "'%" + Twine(ID) + "' defined with type '" +
2418               getTypeString(Val->getType()) + "'");
2419     return nullptr;
2420   }
2421
2422   if (!Ty->isFirstClassType()) {
2423     P.Error(Loc, "invalid use of a non-first-class type");
2424     return nullptr;
2425   }
2426
2427   // Otherwise, create a new forward reference for this value and remember it.
2428   Value *FwdVal;
2429   if (Ty->isLabelTy()) {
2430     assert(!OC);
2431     FwdVal = BasicBlock::Create(F.getContext(), "", &F);
2432   } else if (!OC) {
2433     FwdVal = new Argument(Ty);
2434   } else {
2435     switch (OC) {
2436     case OC_CatchPad:
2437       FwdVal = CatchPadInst::Create(&F.getEntryBlock(), &F.getEntryBlock(), {});
2438       break;
2439     case OC_CleanupPad:
2440       FwdVal = CleanupPadInst::Create(F.getContext(), {});
2441       break;
2442     default:
2443       llvm_unreachable("unexpected constraint");
2444     }
2445   }
2446
2447   ForwardRefValIDs[ID] = std::make_pair(FwdVal, Loc);
2448   return FwdVal;
2449 }
2450
2451 /// SetInstName - After an instruction is parsed and inserted into its
2452 /// basic block, this installs its name.
2453 bool LLParser::PerFunctionState::SetInstName(int NameID,
2454                                              const std::string &NameStr,
2455                                              LocTy NameLoc, Instruction *Inst) {
2456   // If this instruction has void type, it cannot have a name or ID specified.
2457   if (Inst->getType()->isVoidTy()) {
2458     if (NameID != -1 || !NameStr.empty())
2459       return P.Error(NameLoc, "instructions returning void cannot have a name");
2460     return false;
2461   }
2462
2463   // If this was a numbered instruction, verify that the instruction is the
2464   // expected value and resolve any forward references.
2465   if (NameStr.empty()) {
2466     // If neither a name nor an ID was specified, just use the next ID.
2467     if (NameID == -1)
2468       NameID = NumberedVals.size();
2469
2470     if (unsigned(NameID) != NumberedVals.size())
2471       return P.Error(NameLoc, "instruction expected to be numbered '%" +
2472                      Twine(NumberedVals.size()) + "'");
2473
2474     auto FI = ForwardRefValIDs.find(NameID);
2475     if (FI != ForwardRefValIDs.end()) {
2476       Value *Sentinel = FI->second.first;
2477       if (Sentinel->getType() != Inst->getType())
2478         return P.Error(NameLoc, "instruction forward referenced with type '" +
2479                        getTypeString(FI->second.first->getType()) + "'");
2480       // Check operator constraints.  We only put cleanuppads or catchpads in
2481       // the forward value map if the value is constrained to match.
2482       if (isa<CatchPadInst>(Sentinel)) {
2483         if (!isa<CatchPadInst>(Inst))
2484           return P.Error(FI->second.second,
2485                          "'%" + Twine(NameID) + "' is not a catchpad");
2486       } else if (isa<CleanupPadInst>(Sentinel)) {
2487         if (!isa<CleanupPadInst>(Inst))
2488           return P.Error(FI->second.second,
2489                          "'%" + Twine(NameID) + "' is not a cleanuppad");
2490       }
2491
2492       Sentinel->replaceAllUsesWith(Inst);
2493       delete Sentinel;
2494       ForwardRefValIDs.erase(FI);
2495     }
2496
2497     NumberedVals.push_back(Inst);
2498     return false;
2499   }
2500
2501   // Otherwise, the instruction had a name.  Resolve forward refs and set it.
2502   auto FI = ForwardRefVals.find(NameStr);
2503   if (FI != ForwardRefVals.end()) {
2504     Value *Sentinel = FI->second.first;
2505     if (Sentinel->getType() != Inst->getType())
2506       return P.Error(NameLoc, "instruction forward referenced with type '" +
2507                      getTypeString(FI->second.first->getType()) + "'");
2508     // Check operator constraints.  We only put cleanuppads or catchpads in
2509     // the forward value map if the value is constrained to match.
2510     if (isa<CatchPadInst>(Sentinel)) {
2511       if (!isa<CatchPadInst>(Inst))
2512         return P.Error(FI->second.second,
2513                        "'%" + NameStr + "' is not a catchpad");
2514     } else if (isa<CleanupPadInst>(Sentinel)) {
2515       if (!isa<CleanupPadInst>(Inst))
2516         return P.Error(FI->second.second,
2517                        "'%" + NameStr + "' is not a cleanuppad");
2518     }
2519
2520     Sentinel->replaceAllUsesWith(Inst);
2521     delete Sentinel;
2522     ForwardRefVals.erase(FI);
2523   }
2524
2525   // Set the name on the instruction.
2526   Inst->setName(NameStr);
2527
2528   if (Inst->getName() != NameStr)
2529     return P.Error(NameLoc, "multiple definition of local value named '" +
2530                    NameStr + "'");
2531   return false;
2532 }
2533
2534 /// GetBB - Get a basic block with the specified name or ID, creating a
2535 /// forward reference record if needed.
2536 BasicBlock *LLParser::PerFunctionState::GetBB(const std::string &Name,
2537                                               LocTy Loc) {
2538   return dyn_cast_or_null<BasicBlock>(GetVal(Name,
2539                                       Type::getLabelTy(F.getContext()), Loc));
2540 }
2541
2542 BasicBlock *LLParser::PerFunctionState::GetBB(unsigned ID, LocTy Loc) {
2543   return dyn_cast_or_null<BasicBlock>(GetVal(ID,
2544                                       Type::getLabelTy(F.getContext()), Loc));
2545 }
2546
2547 /// DefineBB - Define the specified basic block, which is either named or
2548 /// unnamed.  If there is an error, this returns null otherwise it returns
2549 /// the block being defined.
2550 BasicBlock *LLParser::PerFunctionState::DefineBB(const std::string &Name,
2551                                                  LocTy Loc) {
2552   BasicBlock *BB;
2553   if (Name.empty())
2554     BB = GetBB(NumberedVals.size(), Loc);
2555   else
2556     BB = GetBB(Name, Loc);
2557   if (!BB) return nullptr; // Already diagnosed error.
2558
2559   // Move the block to the end of the function.  Forward ref'd blocks are
2560   // inserted wherever they happen to be referenced.
2561   F.getBasicBlockList().splice(F.end(), F.getBasicBlockList(), BB);
2562
2563   // Remove the block from forward ref sets.
2564   if (Name.empty()) {
2565     ForwardRefValIDs.erase(NumberedVals.size());
2566     NumberedVals.push_back(BB);
2567   } else {
2568     // BB forward references are already in the function symbol table.
2569     ForwardRefVals.erase(Name);
2570   }
2571
2572   return BB;
2573 }
2574
2575 //===----------------------------------------------------------------------===//
2576 // Constants.
2577 //===----------------------------------------------------------------------===//
2578
2579 /// ParseValID - Parse an abstract value that doesn't necessarily have a
2580 /// type implied.  For example, if we parse "4" we don't know what integer type
2581 /// it has.  The value will later be combined with its type and checked for
2582 /// sanity.  PFS is used to convert function-local operands of metadata (since
2583 /// metadata operands are not just parsed here but also converted to values).
2584 /// PFS can be null when we are not parsing metadata values inside a function.
2585 bool LLParser::ParseValID(ValID &ID, PerFunctionState *PFS) {
2586   ID.Loc = Lex.getLoc();
2587   switch (Lex.getKind()) {
2588   default: return TokError("expected value token");
2589   case lltok::GlobalID:  // @42
2590     ID.UIntVal = Lex.getUIntVal();
2591     ID.Kind = ValID::t_GlobalID;
2592     break;
2593   case lltok::GlobalVar:  // @foo
2594     ID.StrVal = Lex.getStrVal();
2595     ID.Kind = ValID::t_GlobalName;
2596     break;
2597   case lltok::LocalVarID:  // %42
2598     ID.UIntVal = Lex.getUIntVal();
2599     ID.Kind = ValID::t_LocalID;
2600     break;
2601   case lltok::LocalVar:  // %foo
2602     ID.StrVal = Lex.getStrVal();
2603     ID.Kind = ValID::t_LocalName;
2604     break;
2605   case lltok::APSInt:
2606     ID.APSIntVal = Lex.getAPSIntVal();
2607     ID.Kind = ValID::t_APSInt;
2608     break;
2609   case lltok::APFloat:
2610     ID.APFloatVal = Lex.getAPFloatVal();
2611     ID.Kind = ValID::t_APFloat;
2612     break;
2613   case lltok::kw_true:
2614     ID.ConstantVal = ConstantInt::getTrue(Context);
2615     ID.Kind = ValID::t_Constant;
2616     break;
2617   case lltok::kw_false:
2618     ID.ConstantVal = ConstantInt::getFalse(Context);
2619     ID.Kind = ValID::t_Constant;
2620     break;
2621   case lltok::kw_null: ID.Kind = ValID::t_Null; break;
2622   case lltok::kw_undef: ID.Kind = ValID::t_Undef; break;
2623   case lltok::kw_zeroinitializer: ID.Kind = ValID::t_Zero; break;
2624
2625   case lltok::lbrace: {
2626     // ValID ::= '{' ConstVector '}'
2627     Lex.Lex();
2628     SmallVector<Constant*, 16> Elts;
2629     if (ParseGlobalValueVector(Elts) ||
2630         ParseToken(lltok::rbrace, "expected end of struct constant"))
2631       return true;
2632
2633     ID.ConstantStructElts = make_unique<Constant *[]>(Elts.size());
2634     ID.UIntVal = Elts.size();
2635     memcpy(ID.ConstantStructElts.get(), Elts.data(),
2636            Elts.size() * sizeof(Elts[0]));
2637     ID.Kind = ValID::t_ConstantStruct;
2638     return false;
2639   }
2640   case lltok::less: {
2641     // ValID ::= '<' ConstVector '>'         --> Vector.
2642     // ValID ::= '<' '{' ConstVector '}' '>' --> Packed Struct.
2643     Lex.Lex();
2644     bool isPackedStruct = EatIfPresent(lltok::lbrace);
2645
2646     SmallVector<Constant*, 16> Elts;
2647     LocTy FirstEltLoc = Lex.getLoc();
2648     if (ParseGlobalValueVector(Elts) ||
2649         (isPackedStruct &&
2650          ParseToken(lltok::rbrace, "expected end of packed struct")) ||
2651         ParseToken(lltok::greater, "expected end of constant"))
2652       return true;
2653
2654     if (isPackedStruct) {
2655       ID.ConstantStructElts = make_unique<Constant *[]>(Elts.size());
2656       memcpy(ID.ConstantStructElts.get(), Elts.data(),
2657              Elts.size() * sizeof(Elts[0]));
2658       ID.UIntVal = Elts.size();
2659       ID.Kind = ValID::t_PackedConstantStruct;
2660       return false;
2661     }
2662
2663     if (Elts.empty())
2664       return Error(ID.Loc, "constant vector must not be empty");
2665
2666     if (!Elts[0]->getType()->isIntegerTy() &&
2667         !Elts[0]->getType()->isFloatingPointTy() &&
2668         !Elts[0]->getType()->isPointerTy())
2669       return Error(FirstEltLoc,
2670             "vector elements must have integer, pointer or floating point type");
2671
2672     // Verify that all the vector elements have the same type.
2673     for (unsigned i = 1, e = Elts.size(); i != e; ++i)
2674       if (Elts[i]->getType() != Elts[0]->getType())
2675         return Error(FirstEltLoc,
2676                      "vector element #" + Twine(i) +
2677                     " is not of type '" + getTypeString(Elts[0]->getType()));
2678
2679     ID.ConstantVal = ConstantVector::get(Elts);
2680     ID.Kind = ValID::t_Constant;
2681     return false;
2682   }
2683   case lltok::lsquare: {   // Array Constant
2684     Lex.Lex();
2685     SmallVector<Constant*, 16> Elts;
2686     LocTy FirstEltLoc = Lex.getLoc();
2687     if (ParseGlobalValueVector(Elts) ||
2688         ParseToken(lltok::rsquare, "expected end of array constant"))
2689       return true;
2690
2691     // Handle empty element.
2692     if (Elts.empty()) {
2693       // Use undef instead of an array because it's inconvenient to determine
2694       // the element type at this point, there being no elements to examine.
2695       ID.Kind = ValID::t_EmptyArray;
2696       return false;
2697     }
2698
2699     if (!Elts[0]->getType()->isFirstClassType())
2700       return Error(FirstEltLoc, "invalid array element type: " +
2701                    getTypeString(Elts[0]->getType()));
2702
2703     ArrayType *ATy = ArrayType::get(Elts[0]->getType(), Elts.size());
2704
2705     // Verify all elements are correct type!
2706     for (unsigned i = 0, e = Elts.size(); i != e; ++i) {
2707       if (Elts[i]->getType() != Elts[0]->getType())
2708         return Error(FirstEltLoc,
2709                      "array element #" + Twine(i) +
2710                      " is not of type '" + getTypeString(Elts[0]->getType()));
2711     }
2712
2713     ID.ConstantVal = ConstantArray::get(ATy, Elts);
2714     ID.Kind = ValID::t_Constant;
2715     return false;
2716   }
2717   case lltok::kw_c:  // c "foo"
2718     Lex.Lex();
2719     ID.ConstantVal = ConstantDataArray::getString(Context, Lex.getStrVal(),
2720                                                   false);
2721     if (ParseToken(lltok::StringConstant, "expected string")) return true;
2722     ID.Kind = ValID::t_Constant;
2723     return false;
2724
2725   case lltok::kw_asm: {
2726     // ValID ::= 'asm' SideEffect? AlignStack? IntelDialect? STRINGCONSTANT ','
2727     //             STRINGCONSTANT
2728     bool HasSideEffect, AlignStack, AsmDialect;
2729     Lex.Lex();
2730     if (ParseOptionalToken(lltok::kw_sideeffect, HasSideEffect) ||
2731         ParseOptionalToken(lltok::kw_alignstack, AlignStack) ||
2732         ParseOptionalToken(lltok::kw_inteldialect, AsmDialect) ||
2733         ParseStringConstant(ID.StrVal) ||
2734         ParseToken(lltok::comma, "expected comma in inline asm expression") ||
2735         ParseToken(lltok::StringConstant, "expected constraint string"))
2736       return true;
2737     ID.StrVal2 = Lex.getStrVal();
2738     ID.UIntVal = unsigned(HasSideEffect) | (unsigned(AlignStack)<<1) |
2739       (unsigned(AsmDialect)<<2);
2740     ID.Kind = ValID::t_InlineAsm;
2741     return false;
2742   }
2743
2744   case lltok::kw_blockaddress: {
2745     // ValID ::= 'blockaddress' '(' @foo ',' %bar ')'
2746     Lex.Lex();
2747
2748     ValID Fn, Label;
2749
2750     if (ParseToken(lltok::lparen, "expected '(' in block address expression") ||
2751         ParseValID(Fn) ||
2752         ParseToken(lltok::comma, "expected comma in block address expression")||
2753         ParseValID(Label) ||
2754         ParseToken(lltok::rparen, "expected ')' in block address expression"))
2755       return true;
2756
2757     if (Fn.Kind != ValID::t_GlobalID && Fn.Kind != ValID::t_GlobalName)
2758       return Error(Fn.Loc, "expected function name in blockaddress");
2759     if (Label.Kind != ValID::t_LocalID && Label.Kind != ValID::t_LocalName)
2760       return Error(Label.Loc, "expected basic block name in blockaddress");
2761
2762     // Try to find the function (but skip it if it's forward-referenced).
2763     GlobalValue *GV = nullptr;
2764     if (Fn.Kind == ValID::t_GlobalID) {
2765       if (Fn.UIntVal < NumberedVals.size())
2766         GV = NumberedVals[Fn.UIntVal];
2767     } else if (!ForwardRefVals.count(Fn.StrVal)) {
2768       GV = M->getNamedValue(Fn.StrVal);
2769     }
2770     Function *F = nullptr;
2771     if (GV) {
2772       // Confirm that it's actually a function with a definition.
2773       if (!isa<Function>(GV))
2774         return Error(Fn.Loc, "expected function name in blockaddress");
2775       F = cast<Function>(GV);
2776       if (F->isDeclaration())
2777         return Error(Fn.Loc, "cannot take blockaddress inside a declaration");
2778     }
2779
2780     if (!F) {
2781       // Make a global variable as a placeholder for this reference.
2782       GlobalValue *&FwdRef =
2783           ForwardRefBlockAddresses.insert(std::make_pair(
2784                                               std::move(Fn),
2785                                               std::map<ValID, GlobalValue *>()))
2786               .first->second.insert(std::make_pair(std::move(Label), nullptr))
2787               .first->second;
2788       if (!FwdRef)
2789         FwdRef = new GlobalVariable(*M, Type::getInt8Ty(Context), false,
2790                                     GlobalValue::InternalLinkage, nullptr, "");
2791       ID.ConstantVal = FwdRef;
2792       ID.Kind = ValID::t_Constant;
2793       return false;
2794     }
2795
2796     // We found the function; now find the basic block.  Don't use PFS, since we
2797     // might be inside a constant expression.
2798     BasicBlock *BB;
2799     if (BlockAddressPFS && F == &BlockAddressPFS->getFunction()) {
2800       if (Label.Kind == ValID::t_LocalID)
2801         BB = BlockAddressPFS->GetBB(Label.UIntVal, Label.Loc);
2802       else
2803         BB = BlockAddressPFS->GetBB(Label.StrVal, Label.Loc);
2804       if (!BB)
2805         return Error(Label.Loc, "referenced value is not a basic block");
2806     } else {
2807       if (Label.Kind == ValID::t_LocalID)
2808         return Error(Label.Loc, "cannot take address of numeric label after "
2809                                 "the function is defined");
2810       BB = dyn_cast_or_null<BasicBlock>(
2811           F->getValueSymbolTable().lookup(Label.StrVal));
2812       if (!BB)
2813         return Error(Label.Loc, "referenced value is not a basic block");
2814     }
2815
2816     ID.ConstantVal = BlockAddress::get(F, BB);
2817     ID.Kind = ValID::t_Constant;
2818     return false;
2819   }
2820
2821   case lltok::kw_trunc:
2822   case lltok::kw_zext:
2823   case lltok::kw_sext:
2824   case lltok::kw_fptrunc:
2825   case lltok::kw_fpext:
2826   case lltok::kw_bitcast:
2827   case lltok::kw_addrspacecast:
2828   case lltok::kw_uitofp:
2829   case lltok::kw_sitofp:
2830   case lltok::kw_fptoui:
2831   case lltok::kw_fptosi:
2832   case lltok::kw_inttoptr:
2833   case lltok::kw_ptrtoint: {
2834     unsigned Opc = Lex.getUIntVal();
2835     Type *DestTy = nullptr;
2836     Constant *SrcVal;
2837     Lex.Lex();
2838     if (ParseToken(lltok::lparen, "expected '(' after constantexpr cast") ||
2839         ParseGlobalTypeAndValue(SrcVal) ||
2840         ParseToken(lltok::kw_to, "expected 'to' in constantexpr cast") ||
2841         ParseType(DestTy) ||
2842         ParseToken(lltok::rparen, "expected ')' at end of constantexpr cast"))
2843       return true;
2844     if (!CastInst::castIsValid((Instruction::CastOps)Opc, SrcVal, DestTy))
2845       return Error(ID.Loc, "invalid cast opcode for cast from '" +
2846                    getTypeString(SrcVal->getType()) + "' to '" +
2847                    getTypeString(DestTy) + "'");
2848     ID.ConstantVal = ConstantExpr::getCast((Instruction::CastOps)Opc,
2849                                                  SrcVal, DestTy);
2850     ID.Kind = ValID::t_Constant;
2851     return false;
2852   }
2853   case lltok::kw_extractvalue: {
2854     Lex.Lex();
2855     Constant *Val;
2856     SmallVector<unsigned, 4> Indices;
2857     if (ParseToken(lltok::lparen, "expected '(' in extractvalue constantexpr")||
2858         ParseGlobalTypeAndValue(Val) ||
2859         ParseIndexList(Indices) ||
2860         ParseToken(lltok::rparen, "expected ')' in extractvalue constantexpr"))
2861       return true;
2862
2863     if (!Val->getType()->isAggregateType())
2864       return Error(ID.Loc, "extractvalue operand must be aggregate type");
2865     if (!ExtractValueInst::getIndexedType(Val->getType(), Indices))
2866       return Error(ID.Loc, "invalid indices for extractvalue");
2867     ID.ConstantVal = ConstantExpr::getExtractValue(Val, Indices);
2868     ID.Kind = ValID::t_Constant;
2869     return false;
2870   }
2871   case lltok::kw_insertvalue: {
2872     Lex.Lex();
2873     Constant *Val0, *Val1;
2874     SmallVector<unsigned, 4> Indices;
2875     if (ParseToken(lltok::lparen, "expected '(' in insertvalue constantexpr")||
2876         ParseGlobalTypeAndValue(Val0) ||
2877         ParseToken(lltok::comma, "expected comma in insertvalue constantexpr")||
2878         ParseGlobalTypeAndValue(Val1) ||
2879         ParseIndexList(Indices) ||
2880         ParseToken(lltok::rparen, "expected ')' in insertvalue constantexpr"))
2881       return true;
2882     if (!Val0->getType()->isAggregateType())
2883       return Error(ID.Loc, "insertvalue operand must be aggregate type");
2884     Type *IndexedType =
2885         ExtractValueInst::getIndexedType(Val0->getType(), Indices);
2886     if (!IndexedType)
2887       return Error(ID.Loc, "invalid indices for insertvalue");
2888     if (IndexedType != Val1->getType())
2889       return Error(ID.Loc, "insertvalue operand and field disagree in type: '" +
2890                                getTypeString(Val1->getType()) +
2891                                "' instead of '" + getTypeString(IndexedType) +
2892                                "'");
2893     ID.ConstantVal = ConstantExpr::getInsertValue(Val0, Val1, Indices);
2894     ID.Kind = ValID::t_Constant;
2895     return false;
2896   }
2897   case lltok::kw_icmp:
2898   case lltok::kw_fcmp: {
2899     unsigned PredVal, Opc = Lex.getUIntVal();
2900     Constant *Val0, *Val1;
2901     Lex.Lex();
2902     if (ParseCmpPredicate(PredVal, Opc) ||
2903         ParseToken(lltok::lparen, "expected '(' in compare constantexpr") ||
2904         ParseGlobalTypeAndValue(Val0) ||
2905         ParseToken(lltok::comma, "expected comma in compare constantexpr") ||
2906         ParseGlobalTypeAndValue(Val1) ||
2907         ParseToken(lltok::rparen, "expected ')' in compare constantexpr"))
2908       return true;
2909
2910     if (Val0->getType() != Val1->getType())
2911       return Error(ID.Loc, "compare operands must have the same type");
2912
2913     CmpInst::Predicate Pred = (CmpInst::Predicate)PredVal;
2914
2915     if (Opc == Instruction::FCmp) {
2916       if (!Val0->getType()->isFPOrFPVectorTy())
2917         return Error(ID.Loc, "fcmp requires floating point operands");
2918       ID.ConstantVal = ConstantExpr::getFCmp(Pred, Val0, Val1);
2919     } else {
2920       assert(Opc == Instruction::ICmp && "Unexpected opcode for CmpInst!");
2921       if (!Val0->getType()->isIntOrIntVectorTy() &&
2922           !Val0->getType()->getScalarType()->isPointerTy())
2923         return Error(ID.Loc, "icmp requires pointer or integer operands");
2924       ID.ConstantVal = ConstantExpr::getICmp(Pred, Val0, Val1);
2925     }
2926     ID.Kind = ValID::t_Constant;
2927     return false;
2928   }
2929
2930   // Binary Operators.
2931   case lltok::kw_add:
2932   case lltok::kw_fadd:
2933   case lltok::kw_sub:
2934   case lltok::kw_fsub:
2935   case lltok::kw_mul:
2936   case lltok::kw_fmul:
2937   case lltok::kw_udiv:
2938   case lltok::kw_sdiv:
2939   case lltok::kw_fdiv:
2940   case lltok::kw_urem:
2941   case lltok::kw_srem:
2942   case lltok::kw_frem:
2943   case lltok::kw_shl:
2944   case lltok::kw_lshr:
2945   case lltok::kw_ashr: {
2946     bool NUW = false;
2947     bool NSW = false;
2948     bool Exact = false;
2949     unsigned Opc = Lex.getUIntVal();
2950     Constant *Val0, *Val1;
2951     Lex.Lex();
2952     LocTy ModifierLoc = Lex.getLoc();
2953     if (Opc == Instruction::Add || Opc == Instruction::Sub ||
2954         Opc == Instruction::Mul || Opc == Instruction::Shl) {
2955       if (EatIfPresent(lltok::kw_nuw))
2956         NUW = true;
2957       if (EatIfPresent(lltok::kw_nsw)) {
2958         NSW = true;
2959         if (EatIfPresent(lltok::kw_nuw))
2960           NUW = true;
2961       }
2962     } else if (Opc == Instruction::SDiv || Opc == Instruction::UDiv ||
2963                Opc == Instruction::LShr || Opc == Instruction::AShr) {
2964       if (EatIfPresent(lltok::kw_exact))
2965         Exact = true;
2966     }
2967     if (ParseToken(lltok::lparen, "expected '(' in binary constantexpr") ||
2968         ParseGlobalTypeAndValue(Val0) ||
2969         ParseToken(lltok::comma, "expected comma in binary constantexpr") ||
2970         ParseGlobalTypeAndValue(Val1) ||
2971         ParseToken(lltok::rparen, "expected ')' in binary constantexpr"))
2972       return true;
2973     if (Val0->getType() != Val1->getType())
2974       return Error(ID.Loc, "operands of constexpr must have same type");
2975     if (!Val0->getType()->isIntOrIntVectorTy()) {
2976       if (NUW)
2977         return Error(ModifierLoc, "nuw only applies to integer operations");
2978       if (NSW)
2979         return Error(ModifierLoc, "nsw only applies to integer operations");
2980     }
2981     // Check that the type is valid for the operator.
2982     switch (Opc) {
2983     case Instruction::Add:
2984     case Instruction::Sub:
2985     case Instruction::Mul:
2986     case Instruction::UDiv:
2987     case Instruction::SDiv:
2988     case Instruction::URem:
2989     case Instruction::SRem:
2990     case Instruction::Shl:
2991     case Instruction::AShr:
2992     case Instruction::LShr:
2993       if (!Val0->getType()->isIntOrIntVectorTy())
2994         return Error(ID.Loc, "constexpr requires integer operands");
2995       break;
2996     case Instruction::FAdd:
2997     case Instruction::FSub:
2998     case Instruction::FMul:
2999     case Instruction::FDiv:
3000     case Instruction::FRem:
3001       if (!Val0->getType()->isFPOrFPVectorTy())
3002         return Error(ID.Loc, "constexpr requires fp operands");
3003       break;
3004     default: llvm_unreachable("Unknown binary operator!");
3005     }
3006     unsigned Flags = 0;
3007     if (NUW)   Flags |= OverflowingBinaryOperator::NoUnsignedWrap;
3008     if (NSW)   Flags |= OverflowingBinaryOperator::NoSignedWrap;
3009     if (Exact) Flags |= PossiblyExactOperator::IsExact;
3010     Constant *C = ConstantExpr::get(Opc, Val0, Val1, Flags);
3011     ID.ConstantVal = C;
3012     ID.Kind = ValID::t_Constant;
3013     return false;
3014   }
3015
3016   // Logical Operations
3017   case lltok::kw_and:
3018   case lltok::kw_or:
3019   case lltok::kw_xor: {
3020     unsigned Opc = Lex.getUIntVal();
3021     Constant *Val0, *Val1;
3022     Lex.Lex();
3023     if (ParseToken(lltok::lparen, "expected '(' in logical constantexpr") ||
3024         ParseGlobalTypeAndValue(Val0) ||
3025         ParseToken(lltok::comma, "expected comma in logical constantexpr") ||
3026         ParseGlobalTypeAndValue(Val1) ||
3027         ParseToken(lltok::rparen, "expected ')' in logical constantexpr"))
3028       return true;
3029     if (Val0->getType() != Val1->getType())
3030       return Error(ID.Loc, "operands of constexpr must have same type");
3031     if (!Val0->getType()->isIntOrIntVectorTy())
3032       return Error(ID.Loc,
3033                    "constexpr requires integer or integer vector operands");
3034     ID.ConstantVal = ConstantExpr::get(Opc, Val0, Val1);
3035     ID.Kind = ValID::t_Constant;
3036     return false;
3037   }
3038
3039   case lltok::kw_getelementptr:
3040   case lltok::kw_shufflevector:
3041   case lltok::kw_insertelement:
3042   case lltok::kw_extractelement:
3043   case lltok::kw_select: {
3044     unsigned Opc = Lex.getUIntVal();
3045     SmallVector<Constant*, 16> Elts;
3046     bool InBounds = false;
3047     Type *Ty;
3048     Lex.Lex();
3049
3050     if (Opc == Instruction::GetElementPtr)
3051       InBounds = EatIfPresent(lltok::kw_inbounds);
3052
3053     if (ParseToken(lltok::lparen, "expected '(' in constantexpr"))
3054       return true;
3055
3056     LocTy ExplicitTypeLoc = Lex.getLoc();
3057     if (Opc == Instruction::GetElementPtr) {
3058       if (ParseType(Ty) ||
3059           ParseToken(lltok::comma, "expected comma after getelementptr's type"))
3060         return true;
3061     }
3062
3063     if (ParseGlobalValueVector(Elts) ||
3064         ParseToken(lltok::rparen, "expected ')' in constantexpr"))
3065       return true;
3066
3067     if (Opc == Instruction::GetElementPtr) {
3068       if (Elts.size() == 0 ||
3069           !Elts[0]->getType()->getScalarType()->isPointerTy())
3070         return Error(ID.Loc, "base of getelementptr must be a pointer");
3071
3072       Type *BaseType = Elts[0]->getType();
3073       auto *BasePointerType = cast<PointerType>(BaseType->getScalarType());
3074       if (Ty != BasePointerType->getElementType())
3075         return Error(
3076             ExplicitTypeLoc,
3077             "explicit pointee type doesn't match operand's pointee type");
3078
3079       ArrayRef<Constant *> Indices(Elts.begin() + 1, Elts.end());
3080       for (Constant *Val : Indices) {
3081         Type *ValTy = Val->getType();
3082         if (!ValTy->getScalarType()->isIntegerTy())
3083           return Error(ID.Loc, "getelementptr index must be an integer");
3084         if (ValTy->isVectorTy() != BaseType->isVectorTy())
3085           return Error(ID.Loc, "getelementptr index type missmatch");
3086         if (ValTy->isVectorTy()) {
3087           unsigned ValNumEl = ValTy->getVectorNumElements();
3088           unsigned PtrNumEl = BaseType->getVectorNumElements();
3089           if (ValNumEl != PtrNumEl)
3090             return Error(
3091                 ID.Loc,
3092                 "getelementptr vector index has a wrong number of elements");
3093         }
3094       }
3095
3096       SmallPtrSet<Type*, 4> Visited;
3097       if (!Indices.empty() && !Ty->isSized(&Visited))
3098         return Error(ID.Loc, "base element of getelementptr must be sized");
3099
3100       if (!GetElementPtrInst::getIndexedType(Ty, Indices))
3101         return Error(ID.Loc, "invalid getelementptr indices");
3102       ID.ConstantVal =
3103           ConstantExpr::getGetElementPtr(Ty, Elts[0], Indices, InBounds);
3104     } else if (Opc == Instruction::Select) {
3105       if (Elts.size() != 3)
3106         return Error(ID.Loc, "expected three operands to select");
3107       if (const char *Reason = SelectInst::areInvalidOperands(Elts[0], Elts[1],
3108                                                               Elts[2]))
3109         return Error(ID.Loc, Reason);
3110       ID.ConstantVal = ConstantExpr::getSelect(Elts[0], Elts[1], Elts[2]);
3111     } else if (Opc == Instruction::ShuffleVector) {
3112       if (Elts.size() != 3)
3113         return Error(ID.Loc, "expected three operands to shufflevector");
3114       if (!ShuffleVectorInst::isValidOperands(Elts[0], Elts[1], Elts[2]))
3115         return Error(ID.Loc, "invalid operands to shufflevector");
3116       ID.ConstantVal =
3117                  ConstantExpr::getShuffleVector(Elts[0], Elts[1],Elts[2]);
3118     } else if (Opc == Instruction::ExtractElement) {
3119       if (Elts.size() != 2)
3120         return Error(ID.Loc, "expected two operands to extractelement");
3121       if (!ExtractElementInst::isValidOperands(Elts[0], Elts[1]))
3122         return Error(ID.Loc, "invalid extractelement operands");
3123       ID.ConstantVal = ConstantExpr::getExtractElement(Elts[0], Elts[1]);
3124     } else {
3125       assert(Opc == Instruction::InsertElement && "Unknown opcode");
3126       if (Elts.size() != 3)
3127       return Error(ID.Loc, "expected three operands to insertelement");
3128       if (!InsertElementInst::isValidOperands(Elts[0], Elts[1], Elts[2]))
3129         return Error(ID.Loc, "invalid insertelement operands");
3130       ID.ConstantVal =
3131                  ConstantExpr::getInsertElement(Elts[0], Elts[1],Elts[2]);
3132     }
3133
3134     ID.Kind = ValID::t_Constant;
3135     return false;
3136   }
3137   }
3138
3139   Lex.Lex();
3140   return false;
3141 }
3142
3143 /// ParseGlobalValue - Parse a global value with the specified type.
3144 bool LLParser::ParseGlobalValue(Type *Ty, Constant *&C) {
3145   C = nullptr;
3146   ValID ID;
3147   Value *V = nullptr;
3148   bool Parsed = ParseValID(ID) ||
3149                 ConvertValIDToValue(Ty, ID, V, nullptr);
3150   if (V && !(C = dyn_cast<Constant>(V)))
3151     return Error(ID.Loc, "global values must be constants");
3152   return Parsed;
3153 }
3154
3155 bool LLParser::ParseGlobalTypeAndValue(Constant *&V) {
3156   Type *Ty = nullptr;
3157   return ParseType(Ty) ||
3158          ParseGlobalValue(Ty, V);
3159 }
3160
3161 bool LLParser::parseOptionalComdat(StringRef GlobalName, Comdat *&C) {
3162   C = nullptr;
3163
3164   LocTy KwLoc = Lex.getLoc();
3165   if (!EatIfPresent(lltok::kw_comdat))
3166     return false;
3167
3168   if (EatIfPresent(lltok::lparen)) {
3169     if (Lex.getKind() != lltok::ComdatVar)
3170       return TokError("expected comdat variable");
3171     C = getComdat(Lex.getStrVal(), Lex.getLoc());
3172     Lex.Lex();
3173     if (ParseToken(lltok::rparen, "expected ')' after comdat var"))
3174       return true;
3175   } else {
3176     if (GlobalName.empty())
3177       return TokError("comdat cannot be unnamed");
3178     C = getComdat(GlobalName, KwLoc);
3179   }
3180
3181   return false;
3182 }
3183
3184 /// ParseGlobalValueVector
3185 ///   ::= /*empty*/
3186 ///   ::= TypeAndValue (',' TypeAndValue)*
3187 bool LLParser::ParseGlobalValueVector(SmallVectorImpl<Constant *> &Elts) {
3188   // Empty list.
3189   if (Lex.getKind() == lltok::rbrace ||
3190       Lex.getKind() == lltok::rsquare ||
3191       Lex.getKind() == lltok::greater ||
3192       Lex.getKind() == lltok::rparen)
3193     return false;
3194
3195   Constant *C;
3196   if (ParseGlobalTypeAndValue(C)) return true;
3197   Elts.push_back(C);
3198
3199   while (EatIfPresent(lltok::comma)) {
3200     if (ParseGlobalTypeAndValue(C)) return true;
3201     Elts.push_back(C);
3202   }
3203
3204   return false;
3205 }
3206
3207 bool LLParser::ParseMDTuple(MDNode *&MD, bool IsDistinct) {
3208   SmallVector<Metadata *, 16> Elts;
3209   if (ParseMDNodeVector(Elts))
3210     return true;
3211
3212   MD = (IsDistinct ? MDTuple::getDistinct : MDTuple::get)(Context, Elts);
3213   return false;
3214 }
3215
3216 /// MDNode:
3217 ///  ::= !{ ... }
3218 ///  ::= !7
3219 ///  ::= !DILocation(...)
3220 bool LLParser::ParseMDNode(MDNode *&N) {
3221   if (Lex.getKind() == lltok::MetadataVar)
3222     return ParseSpecializedMDNode(N);
3223
3224   return ParseToken(lltok::exclaim, "expected '!' here") ||
3225          ParseMDNodeTail(N);
3226 }
3227
3228 bool LLParser::ParseMDNodeTail(MDNode *&N) {
3229   // !{ ... }
3230   if (Lex.getKind() == lltok::lbrace)
3231     return ParseMDTuple(N);
3232
3233   // !42
3234   return ParseMDNodeID(N);
3235 }
3236
3237 namespace {
3238
3239 /// Structure to represent an optional metadata field.
3240 template <class FieldTy> struct MDFieldImpl {
3241   typedef MDFieldImpl ImplTy;
3242   FieldTy Val;
3243   bool Seen;
3244
3245   void assign(FieldTy Val) {
3246     Seen = true;
3247     this->Val = std::move(Val);
3248   }
3249
3250   explicit MDFieldImpl(FieldTy Default)
3251       : Val(std::move(Default)), Seen(false) {}
3252 };
3253
3254 struct MDUnsignedField : public MDFieldImpl<uint64_t> {
3255   uint64_t Max;
3256
3257   MDUnsignedField(uint64_t Default = 0, uint64_t Max = UINT64_MAX)
3258       : ImplTy(Default), Max(Max) {}
3259 };
3260 struct LineField : public MDUnsignedField {
3261   LineField() : MDUnsignedField(0, UINT32_MAX) {}
3262 };
3263 struct ColumnField : public MDUnsignedField {
3264   ColumnField() : MDUnsignedField(0, UINT16_MAX) {}
3265 };
3266 struct DwarfTagField : public MDUnsignedField {
3267   DwarfTagField() : MDUnsignedField(0, dwarf::DW_TAG_hi_user) {}
3268   DwarfTagField(dwarf::Tag DefaultTag)
3269       : MDUnsignedField(DefaultTag, dwarf::DW_TAG_hi_user) {}
3270 };
3271 struct DwarfAttEncodingField : public MDUnsignedField {
3272   DwarfAttEncodingField() : MDUnsignedField(0, dwarf::DW_ATE_hi_user) {}
3273 };
3274 struct DwarfVirtualityField : public MDUnsignedField {
3275   DwarfVirtualityField() : MDUnsignedField(0, dwarf::DW_VIRTUALITY_max) {}
3276 };
3277 struct DwarfLangField : public MDUnsignedField {
3278   DwarfLangField() : MDUnsignedField(0, dwarf::DW_LANG_hi_user) {}
3279 };
3280
3281 struct DIFlagField : public MDUnsignedField {
3282   DIFlagField() : MDUnsignedField(0, UINT32_MAX) {}
3283 };
3284
3285 struct MDSignedField : public MDFieldImpl<int64_t> {
3286   int64_t Min;
3287   int64_t Max;
3288
3289   MDSignedField(int64_t Default = 0)
3290       : ImplTy(Default), Min(INT64_MIN), Max(INT64_MAX) {}
3291   MDSignedField(int64_t Default, int64_t Min, int64_t Max)
3292       : ImplTy(Default), Min(Min), Max(Max) {}
3293 };
3294
3295 struct MDBoolField : public MDFieldImpl<bool> {
3296   MDBoolField(bool Default = false) : ImplTy(Default) {}
3297 };
3298 struct MDField : public MDFieldImpl<Metadata *> {
3299   bool AllowNull;
3300
3301   MDField(bool AllowNull = true) : ImplTy(nullptr), AllowNull(AllowNull) {}
3302 };
3303 struct MDConstant : public MDFieldImpl<ConstantAsMetadata *> {
3304   MDConstant() : ImplTy(nullptr) {}
3305 };
3306 struct MDStringField : public MDFieldImpl<MDString *> {
3307   bool AllowEmpty;
3308   MDStringField(bool AllowEmpty = true)
3309       : ImplTy(nullptr), AllowEmpty(AllowEmpty) {}
3310 };
3311 struct MDFieldList : public MDFieldImpl<SmallVector<Metadata *, 4>> {
3312   MDFieldList() : ImplTy(SmallVector<Metadata *, 4>()) {}
3313 };
3314
3315 } // end namespace
3316
3317 namespace llvm {
3318
3319 template <>
3320 bool LLParser::ParseMDField(LocTy Loc, StringRef Name,
3321                             MDUnsignedField &Result) {
3322   if (Lex.getKind() != lltok::APSInt || Lex.getAPSIntVal().isSigned())
3323     return TokError("expected unsigned integer");
3324
3325   auto &U = Lex.getAPSIntVal();
3326   if (U.ugt(Result.Max))
3327     return TokError("value for '" + Name + "' too large, limit is " +
3328                     Twine(Result.Max));
3329   Result.assign(U.getZExtValue());
3330   assert(Result.Val <= Result.Max && "Expected value in range");
3331   Lex.Lex();
3332   return false;
3333 }
3334
3335 template <>
3336 bool LLParser::ParseMDField(LocTy Loc, StringRef Name, LineField &Result) {
3337   return ParseMDField(Loc, Name, static_cast<MDUnsignedField &>(Result));
3338 }
3339 template <>
3340 bool LLParser::ParseMDField(LocTy Loc, StringRef Name, ColumnField &Result) {
3341   return ParseMDField(Loc, Name, static_cast<MDUnsignedField &>(Result));
3342 }
3343
3344 template <>
3345 bool LLParser::ParseMDField(LocTy Loc, StringRef Name, DwarfTagField &Result) {
3346   if (Lex.getKind() == lltok::APSInt)
3347     return ParseMDField(Loc, Name, static_cast<MDUnsignedField &>(Result));
3348
3349   if (Lex.getKind() != lltok::DwarfTag)
3350     return TokError("expected DWARF tag");
3351
3352   unsigned Tag = dwarf::getTag(Lex.getStrVal());
3353   if (Tag == dwarf::DW_TAG_invalid)
3354     return TokError("invalid DWARF tag" + Twine(" '") + Lex.getStrVal() + "'");
3355   assert(Tag <= Result.Max && "Expected valid DWARF tag");
3356
3357   Result.assign(Tag);
3358   Lex.Lex();
3359   return false;
3360 }
3361
3362 template <>
3363 bool LLParser::ParseMDField(LocTy Loc, StringRef Name,
3364                             DwarfVirtualityField &Result) {
3365   if (Lex.getKind() == lltok::APSInt)
3366     return ParseMDField(Loc, Name, static_cast<MDUnsignedField &>(Result));
3367
3368   if (Lex.getKind() != lltok::DwarfVirtuality)
3369     return TokError("expected DWARF virtuality code");
3370
3371   unsigned Virtuality = dwarf::getVirtuality(Lex.getStrVal());
3372   if (!Virtuality)
3373     return TokError("invalid DWARF virtuality code" + Twine(" '") +
3374                     Lex.getStrVal() + "'");
3375   assert(Virtuality <= Result.Max && "Expected valid DWARF virtuality code");
3376   Result.assign(Virtuality);
3377   Lex.Lex();
3378   return false;
3379 }
3380
3381 template <>
3382 bool LLParser::ParseMDField(LocTy Loc, StringRef Name, DwarfLangField &Result) {
3383   if (Lex.getKind() == lltok::APSInt)
3384     return ParseMDField(Loc, Name, static_cast<MDUnsignedField &>(Result));
3385
3386   if (Lex.getKind() != lltok::DwarfLang)
3387     return TokError("expected DWARF language");
3388
3389   unsigned Lang = dwarf::getLanguage(Lex.getStrVal());
3390   if (!Lang)
3391     return TokError("invalid DWARF language" + Twine(" '") + Lex.getStrVal() +
3392                     "'");
3393   assert(Lang <= Result.Max && "Expected valid DWARF language");
3394   Result.assign(Lang);
3395   Lex.Lex();
3396   return false;
3397 }
3398
3399 template <>
3400 bool LLParser::ParseMDField(LocTy Loc, StringRef Name,
3401                             DwarfAttEncodingField &Result) {
3402   if (Lex.getKind() == lltok::APSInt)
3403     return ParseMDField(Loc, Name, static_cast<MDUnsignedField &>(Result));
3404
3405   if (Lex.getKind() != lltok::DwarfAttEncoding)
3406     return TokError("expected DWARF type attribute encoding");
3407
3408   unsigned Encoding = dwarf::getAttributeEncoding(Lex.getStrVal());
3409   if (!Encoding)
3410     return TokError("invalid DWARF type attribute encoding" + Twine(" '") +
3411                     Lex.getStrVal() + "'");
3412   assert(Encoding <= Result.Max && "Expected valid DWARF language");
3413   Result.assign(Encoding);
3414   Lex.Lex();
3415   return false;
3416 }
3417
3418 /// DIFlagField
3419 ///  ::= uint32
3420 ///  ::= DIFlagVector
3421 ///  ::= DIFlagVector '|' DIFlagFwdDecl '|' uint32 '|' DIFlagPublic
3422 template <>
3423 bool LLParser::ParseMDField(LocTy Loc, StringRef Name, DIFlagField &Result) {
3424   assert(Result.Max == UINT32_MAX && "Expected only 32-bits");
3425
3426   // Parser for a single flag.
3427   auto parseFlag = [&](unsigned &Val) {
3428     if (Lex.getKind() == lltok::APSInt && !Lex.getAPSIntVal().isSigned())
3429       return ParseUInt32(Val);
3430
3431     if (Lex.getKind() != lltok::DIFlag)
3432       return TokError("expected debug info flag");
3433
3434     Val = DINode::getFlag(Lex.getStrVal());
3435     if (!Val)
3436       return TokError(Twine("invalid debug info flag flag '") +
3437                       Lex.getStrVal() + "'");
3438     Lex.Lex();
3439     return false;
3440   };
3441
3442   // Parse the flags and combine them together.
3443   unsigned Combined = 0;
3444   do {
3445     unsigned Val;
3446     if (parseFlag(Val))
3447       return true;
3448     Combined |= Val;
3449   } while (EatIfPresent(lltok::bar));
3450
3451   Result.assign(Combined);
3452   return false;
3453 }
3454
3455 template <>
3456 bool LLParser::ParseMDField(LocTy Loc, StringRef Name,
3457                             MDSignedField &Result) {
3458   if (Lex.getKind() != lltok::APSInt)
3459     return TokError("expected signed integer");
3460
3461   auto &S = Lex.getAPSIntVal();
3462   if (S < Result.Min)
3463     return TokError("value for '" + Name + "' too small, limit is " +
3464                     Twine(Result.Min));
3465   if (S > Result.Max)
3466     return TokError("value for '" + Name + "' too large, limit is " +
3467                     Twine(Result.Max));
3468   Result.assign(S.getExtValue());
3469   assert(Result.Val >= Result.Min && "Expected value in range");
3470   assert(Result.Val <= Result.Max && "Expected value in range");
3471   Lex.Lex();
3472   return false;
3473 }
3474
3475 template <>
3476 bool LLParser::ParseMDField(LocTy Loc, StringRef Name, MDBoolField &Result) {
3477   switch (Lex.getKind()) {
3478   default:
3479     return TokError("expected 'true' or 'false'");
3480   case lltok::kw_true:
3481     Result.assign(true);
3482     break;
3483   case lltok::kw_false:
3484     Result.assign(false);
3485     break;
3486   }
3487   Lex.Lex();
3488   return false;
3489 }
3490
3491 template <>
3492 bool LLParser::ParseMDField(LocTy Loc, StringRef Name, MDField &Result) {
3493   if (Lex.getKind() == lltok::kw_null) {
3494     if (!Result.AllowNull)
3495       return TokError("'" + Name + "' cannot be null");
3496     Lex.Lex();
3497     Result.assign(nullptr);
3498     return false;
3499   }
3500
3501   Metadata *MD;
3502   if (ParseMetadata(MD, nullptr))
3503     return true;
3504
3505   Result.assign(MD);
3506   return false;
3507 }
3508
3509 template <>
3510 bool LLParser::ParseMDField(LocTy Loc, StringRef Name, MDConstant &Result) {
3511   Metadata *MD;
3512   if (ParseValueAsMetadata(MD, "expected constant", nullptr))
3513     return true;
3514
3515   Result.assign(cast<ConstantAsMetadata>(MD));
3516   return false;
3517 }
3518
3519 template <>
3520 bool LLParser::ParseMDField(LocTy Loc, StringRef Name, MDStringField &Result) {
3521   LocTy ValueLoc = Lex.getLoc();
3522   std::string S;
3523   if (ParseStringConstant(S))
3524     return true;
3525
3526   if (!Result.AllowEmpty && S.empty())
3527     return Error(ValueLoc, "'" + Name + "' cannot be empty");
3528
3529   Result.assign(S.empty() ? nullptr : MDString::get(Context, S));
3530   return false;
3531 }
3532
3533 template <>
3534 bool LLParser::ParseMDField(LocTy Loc, StringRef Name, MDFieldList &Result) {
3535   SmallVector<Metadata *, 4> MDs;
3536   if (ParseMDNodeVector(MDs))
3537     return true;
3538
3539   Result.assign(std::move(MDs));
3540   return false;
3541 }
3542
3543 } // end namespace llvm
3544
3545 template <class ParserTy>
3546 bool LLParser::ParseMDFieldsImplBody(ParserTy parseField) {
3547   do {
3548     if (Lex.getKind() != lltok::LabelStr)
3549       return TokError("expected field label here");
3550
3551     if (parseField())
3552       return true;
3553   } while (EatIfPresent(lltok::comma));
3554
3555   return false;
3556 }
3557
3558 template <class ParserTy>
3559 bool LLParser::ParseMDFieldsImpl(ParserTy parseField, LocTy &ClosingLoc) {
3560   assert(Lex.getKind() == lltok::MetadataVar && "Expected metadata type name");
3561   Lex.Lex();
3562
3563   if (ParseToken(lltok::lparen, "expected '(' here"))
3564     return true;
3565   if (Lex.getKind() != lltok::rparen)
3566     if (ParseMDFieldsImplBody(parseField))
3567       return true;
3568
3569   ClosingLoc = Lex.getLoc();
3570   return ParseToken(lltok::rparen, "expected ')' here");
3571 }
3572
3573 template <class FieldTy>
3574 bool LLParser::ParseMDField(StringRef Name, FieldTy &Result) {
3575   if (Result.Seen)
3576     return TokError("field '" + Name + "' cannot be specified more than once");
3577
3578   LocTy Loc = Lex.getLoc();
3579   Lex.Lex();
3580   return ParseMDField(Loc, Name, Result);
3581 }
3582
3583 bool LLParser::ParseSpecializedMDNode(MDNode *&N, bool IsDistinct) {
3584   assert(Lex.getKind() == lltok::MetadataVar && "Expected metadata type name");
3585
3586 #define HANDLE_SPECIALIZED_MDNODE_LEAF(CLASS)                                  \
3587   if (Lex.getStrVal() == #CLASS)                                               \
3588     return Parse##CLASS(N, IsDistinct);
3589 #include "llvm/IR/Metadata.def"
3590
3591   return TokError("expected metadata type");
3592 }
3593
3594 #define DECLARE_FIELD(NAME, TYPE, INIT) TYPE NAME INIT
3595 #define NOP_FIELD(NAME, TYPE, INIT)
3596 #define REQUIRE_FIELD(NAME, TYPE, INIT)                                        \
3597   if (!NAME.Seen)                                                              \
3598     return Error(ClosingLoc, "missing required field '" #NAME "'");
3599 #define PARSE_MD_FIELD(NAME, TYPE, DEFAULT)                                    \
3600   if (Lex.getStrVal() == #NAME)                                                \
3601     return ParseMDField(#NAME, NAME);
3602 #define PARSE_MD_FIELDS()                                                      \
3603   VISIT_MD_FIELDS(DECLARE_FIELD, DECLARE_FIELD)                                \
3604   do {                                                                         \
3605     LocTy ClosingLoc;                                                          \
3606     if (ParseMDFieldsImpl([&]() -> bool {                                      \
3607       VISIT_MD_FIELDS(PARSE_MD_FIELD, PARSE_MD_FIELD)                          \
3608       return TokError(Twine("invalid field '") + Lex.getStrVal() + "'");       \
3609     }, ClosingLoc))                                                            \
3610       return true;                                                             \
3611     VISIT_MD_FIELDS(NOP_FIELD, REQUIRE_FIELD)                                  \
3612   } while (false)
3613 #define GET_OR_DISTINCT(CLASS, ARGS)                                           \
3614   (IsDistinct ? CLASS::getDistinct ARGS : CLASS::get ARGS)
3615
3616 /// ParseDILocationFields:
3617 ///   ::= !DILocation(line: 43, column: 8, scope: !5, inlinedAt: !6)
3618 bool LLParser::ParseDILocation(MDNode *&Result, bool IsDistinct) {
3619 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED)                                    \
3620   OPTIONAL(line, LineField, );                                                 \
3621   OPTIONAL(column, ColumnField, );                                             \
3622   REQUIRED(scope, MDField, (/* AllowNull */ false));                           \
3623   OPTIONAL(inlinedAt, MDField, );
3624   PARSE_MD_FIELDS();
3625 #undef VISIT_MD_FIELDS
3626
3627   Result = GET_OR_DISTINCT(
3628       DILocation, (Context, line.Val, column.Val, scope.Val, inlinedAt.Val));
3629   return false;
3630 }
3631
3632 /// ParseGenericDINode:
3633 ///   ::= !GenericDINode(tag: 15, header: "...", operands: {...})
3634 bool LLParser::ParseGenericDINode(MDNode *&Result, bool IsDistinct) {
3635 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED)                                    \
3636   REQUIRED(tag, DwarfTagField, );                                              \
3637   OPTIONAL(header, MDStringField, );                                           \
3638   OPTIONAL(operands, MDFieldList, );
3639   PARSE_MD_FIELDS();
3640 #undef VISIT_MD_FIELDS
3641
3642   Result = GET_OR_DISTINCT(GenericDINode,
3643                            (Context, tag.Val, header.Val, operands.Val));
3644   return false;
3645 }
3646
3647 /// ParseDISubrange:
3648 ///   ::= !DISubrange(count: 30, lowerBound: 2)
3649 bool LLParser::ParseDISubrange(MDNode *&Result, bool IsDistinct) {
3650 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED)                                    \
3651   REQUIRED(count, MDSignedField, (-1, -1, INT64_MAX));                         \
3652   OPTIONAL(lowerBound, MDSignedField, );
3653   PARSE_MD_FIELDS();
3654 #undef VISIT_MD_FIELDS
3655
3656   Result = GET_OR_DISTINCT(DISubrange, (Context, count.Val, lowerBound.Val));
3657   return false;
3658 }
3659
3660 /// ParseDIEnumerator:
3661 ///   ::= !DIEnumerator(value: 30, name: "SomeKind")
3662 bool LLParser::ParseDIEnumerator(MDNode *&Result, bool IsDistinct) {
3663 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED)                                    \
3664   REQUIRED(name, MDStringField, );                                             \
3665   REQUIRED(value, MDSignedField, );
3666   PARSE_MD_FIELDS();
3667 #undef VISIT_MD_FIELDS
3668
3669   Result = GET_OR_DISTINCT(DIEnumerator, (Context, value.Val, name.Val));
3670   return false;
3671 }
3672
3673 /// ParseDIBasicType:
3674 ///   ::= !DIBasicType(tag: DW_TAG_base_type, name: "int", size: 32, align: 32)
3675 bool LLParser::ParseDIBasicType(MDNode *&Result, bool IsDistinct) {
3676 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED)                                    \
3677   OPTIONAL(tag, DwarfTagField, (dwarf::DW_TAG_base_type));                     \
3678   OPTIONAL(name, MDStringField, );                                             \
3679   OPTIONAL(size, MDUnsignedField, (0, UINT64_MAX));                            \
3680   OPTIONAL(align, MDUnsignedField, (0, UINT64_MAX));                           \
3681   OPTIONAL(encoding, DwarfAttEncodingField, );
3682   PARSE_MD_FIELDS();
3683 #undef VISIT_MD_FIELDS
3684
3685   Result = GET_OR_DISTINCT(DIBasicType, (Context, tag.Val, name.Val, size.Val,
3686                                          align.Val, encoding.Val));
3687   return false;
3688 }
3689
3690 /// ParseDIDerivedType:
3691 ///   ::= !DIDerivedType(tag: DW_TAG_pointer_type, name: "int", file: !0,
3692 ///                      line: 7, scope: !1, baseType: !2, size: 32,
3693 ///                      align: 32, offset: 0, flags: 0, extraData: !3)
3694 bool LLParser::ParseDIDerivedType(MDNode *&Result, bool IsDistinct) {
3695 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED)                                    \
3696   REQUIRED(tag, DwarfTagField, );                                              \
3697   OPTIONAL(name, MDStringField, );                                             \
3698   OPTIONAL(file, MDField, );                                                   \
3699   OPTIONAL(line, LineField, );                                                 \
3700   OPTIONAL(scope, MDField, );                                                  \
3701   REQUIRED(baseType, MDField, );                                               \
3702   OPTIONAL(size, MDUnsignedField, (0, UINT64_MAX));                            \
3703   OPTIONAL(align, MDUnsignedField, (0, UINT64_MAX));                           \
3704   OPTIONAL(offset, MDUnsignedField, (0, UINT64_MAX));                          \
3705   OPTIONAL(flags, DIFlagField, );                                              \
3706   OPTIONAL(extraData, MDField, );
3707   PARSE_MD_FIELDS();
3708 #undef VISIT_MD_FIELDS
3709
3710   Result = GET_OR_DISTINCT(DIDerivedType,
3711                            (Context, tag.Val, name.Val, file.Val, line.Val,
3712                             scope.Val, baseType.Val, size.Val, align.Val,
3713                             offset.Val, flags.Val, extraData.Val));
3714   return false;
3715 }
3716
3717 bool LLParser::ParseDICompositeType(MDNode *&Result, bool IsDistinct) {
3718 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED)                                    \
3719   REQUIRED(tag, DwarfTagField, );                                              \
3720   OPTIONAL(name, MDStringField, );                                             \
3721   OPTIONAL(file, MDField, );                                                   \
3722   OPTIONAL(line, LineField, );                                                 \
3723   OPTIONAL(scope, MDField, );                                                  \
3724   OPTIONAL(baseType, MDField, );                                               \
3725   OPTIONAL(size, MDUnsignedField, (0, UINT64_MAX));                            \
3726   OPTIONAL(align, MDUnsignedField, (0, UINT64_MAX));                           \
3727   OPTIONAL(offset, MDUnsignedField, (0, UINT64_MAX));                          \
3728   OPTIONAL(flags, DIFlagField, );                                              \
3729   OPTIONAL(elements, MDField, );                                               \
3730   OPTIONAL(runtimeLang, DwarfLangField, );                                     \
3731   OPTIONAL(vtableHolder, MDField, );                                           \
3732   OPTIONAL(templateParams, MDField, );                                         \
3733   OPTIONAL(identifier, MDStringField, );
3734   PARSE_MD_FIELDS();
3735 #undef VISIT_MD_FIELDS
3736
3737   Result = GET_OR_DISTINCT(
3738       DICompositeType,
3739       (Context, tag.Val, name.Val, file.Val, line.Val, scope.Val, baseType.Val,
3740        size.Val, align.Val, offset.Val, flags.Val, elements.Val,
3741        runtimeLang.Val, vtableHolder.Val, templateParams.Val, identifier.Val));
3742   return false;
3743 }
3744
3745 bool LLParser::ParseDISubroutineType(MDNode *&Result, bool IsDistinct) {
3746 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED)                                    \
3747   OPTIONAL(flags, DIFlagField, );                                              \
3748   REQUIRED(types, MDField, );
3749   PARSE_MD_FIELDS();
3750 #undef VISIT_MD_FIELDS
3751
3752   Result = GET_OR_DISTINCT(DISubroutineType, (Context, flags.Val, types.Val));
3753   return false;
3754 }
3755
3756 /// ParseDIFileType:
3757 ///   ::= !DIFileType(filename: "path/to/file", directory: "/path/to/dir")
3758 bool LLParser::ParseDIFile(MDNode *&Result, bool IsDistinct) {
3759 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED)                                    \
3760   REQUIRED(filename, MDStringField, );                                         \
3761   REQUIRED(directory, MDStringField, );
3762   PARSE_MD_FIELDS();
3763 #undef VISIT_MD_FIELDS
3764
3765   Result = GET_OR_DISTINCT(DIFile, (Context, filename.Val, directory.Val));
3766   return false;
3767 }
3768
3769 /// ParseDICompileUnit:
3770 ///   ::= !DICompileUnit(language: DW_LANG_C99, file: !0, producer: "clang",
3771 ///                      isOptimized: true, flags: "-O2", runtimeVersion: 1,
3772 ///                      splitDebugFilename: "abc.debug", emissionKind: 1,
3773 ///                      enums: !1, retainedTypes: !2, subprograms: !3,
3774 ///                      globals: !4, imports: !5, dwoId: 0x0abcd)
3775 bool LLParser::ParseDICompileUnit(MDNode *&Result, bool IsDistinct) {
3776   if (!IsDistinct)
3777     return Lex.Error("missing 'distinct', required for !DICompileUnit");
3778
3779 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED)                                    \
3780   REQUIRED(language, DwarfLangField, );                                        \
3781   REQUIRED(file, MDField, (/* AllowNull */ false));                            \
3782   OPTIONAL(producer, MDStringField, );                                         \
3783   OPTIONAL(isOptimized, MDBoolField, );                                        \
3784   OPTIONAL(flags, MDStringField, );                                            \
3785   OPTIONAL(runtimeVersion, MDUnsignedField, (0, UINT32_MAX));                  \
3786   OPTIONAL(splitDebugFilename, MDStringField, );                               \
3787   OPTIONAL(emissionKind, MDUnsignedField, (0, UINT32_MAX));                    \
3788   OPTIONAL(enums, MDField, );                                                  \
3789   OPTIONAL(retainedTypes, MDField, );                                          \
3790   OPTIONAL(subprograms, MDField, );                                            \
3791   OPTIONAL(globals, MDField, );                                                \
3792   OPTIONAL(imports, MDField, );                                                \
3793   OPTIONAL(dwoId, MDUnsignedField, );
3794   PARSE_MD_FIELDS();
3795 #undef VISIT_MD_FIELDS
3796
3797   Result = DICompileUnit::getDistinct(
3798       Context, language.Val, file.Val, producer.Val, isOptimized.Val, flags.Val,
3799       runtimeVersion.Val, splitDebugFilename.Val, emissionKind.Val, enums.Val,
3800       retainedTypes.Val, subprograms.Val, globals.Val, imports.Val, dwoId.Val);
3801   return false;
3802 }
3803
3804 /// ParseDISubprogram:
3805 ///   ::= !DISubprogram(scope: !0, name: "foo", linkageName: "_Zfoo",
3806 ///                     file: !1, line: 7, type: !2, isLocal: false,
3807 ///                     isDefinition: true, scopeLine: 8, containingType: !3,
3808 ///                     virtuality: DW_VIRTUALTIY_pure_virtual,
3809 ///                     virtualIndex: 10, flags: 11,
3810 ///                     isOptimized: false, templateParams: !4, declaration: !5,
3811 ///                     variables: !6)
3812 bool LLParser::ParseDISubprogram(MDNode *&Result, bool IsDistinct) {
3813   auto Loc = Lex.getLoc();
3814 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED)                                    \
3815   OPTIONAL(scope, MDField, );                                                  \
3816   OPTIONAL(name, MDStringField, );                                             \
3817   OPTIONAL(linkageName, MDStringField, );                                      \
3818   OPTIONAL(file, MDField, );                                                   \
3819   OPTIONAL(line, LineField, );                                                 \
3820   OPTIONAL(type, MDField, );                                                   \
3821   OPTIONAL(isLocal, MDBoolField, );                                            \
3822   OPTIONAL(isDefinition, MDBoolField, (true));                                 \
3823   OPTIONAL(scopeLine, LineField, );                                            \
3824   OPTIONAL(containingType, MDField, );                                         \
3825   OPTIONAL(virtuality, DwarfVirtualityField, );                                \
3826   OPTIONAL(virtualIndex, MDUnsignedField, (0, UINT32_MAX));                    \
3827   OPTIONAL(flags, DIFlagField, );                                              \
3828   OPTIONAL(isOptimized, MDBoolField, );                                        \
3829   OPTIONAL(templateParams, MDField, );                                         \
3830   OPTIONAL(declaration, MDField, );                                            \
3831   OPTIONAL(variables, MDField, );
3832   PARSE_MD_FIELDS();
3833 #undef VISIT_MD_FIELDS
3834
3835   if (isDefinition.Val && !IsDistinct)
3836     return Lex.Error(
3837         Loc,
3838         "missing 'distinct', required for !DISubprogram when 'isDefinition'");
3839
3840   Result = GET_OR_DISTINCT(
3841       DISubprogram,
3842       (Context, scope.Val, name.Val, linkageName.Val, file.Val, line.Val,
3843        type.Val, isLocal.Val, isDefinition.Val, scopeLine.Val,
3844        containingType.Val, virtuality.Val, virtualIndex.Val, flags.Val,
3845        isOptimized.Val, templateParams.Val, declaration.Val, variables.Val));
3846   return false;
3847 }
3848
3849 /// ParseDILexicalBlock:
3850 ///   ::= !DILexicalBlock(scope: !0, file: !2, line: 7, column: 9)
3851 bool LLParser::ParseDILexicalBlock(MDNode *&Result, bool IsDistinct) {
3852 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED)                                    \
3853   REQUIRED(scope, MDField, (/* AllowNull */ false));                           \
3854   OPTIONAL(file, MDField, );                                                   \
3855   OPTIONAL(line, LineField, );                                                 \
3856   OPTIONAL(column, ColumnField, );
3857   PARSE_MD_FIELDS();
3858 #undef VISIT_MD_FIELDS
3859
3860   Result = GET_OR_DISTINCT(
3861       DILexicalBlock, (Context, scope.Val, file.Val, line.Val, column.Val));
3862   return false;
3863 }
3864
3865 /// ParseDILexicalBlockFile:
3866 ///   ::= !DILexicalBlockFile(scope: !0, file: !2, discriminator: 9)
3867 bool LLParser::ParseDILexicalBlockFile(MDNode *&Result, bool IsDistinct) {
3868 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED)                                    \
3869   REQUIRED(scope, MDField, (/* AllowNull */ false));                           \
3870   OPTIONAL(file, MDField, );                                                   \
3871   REQUIRED(discriminator, MDUnsignedField, (0, UINT32_MAX));
3872   PARSE_MD_FIELDS();
3873 #undef VISIT_MD_FIELDS
3874
3875   Result = GET_OR_DISTINCT(DILexicalBlockFile,
3876                            (Context, scope.Val, file.Val, discriminator.Val));
3877   return false;
3878 }
3879
3880 /// ParseDINamespace:
3881 ///   ::= !DINamespace(scope: !0, file: !2, name: "SomeNamespace", line: 9)
3882 bool LLParser::ParseDINamespace(MDNode *&Result, bool IsDistinct) {
3883 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED)                                    \
3884   REQUIRED(scope, MDField, );                                                  \
3885   OPTIONAL(file, MDField, );                                                   \
3886   OPTIONAL(name, MDStringField, );                                             \
3887   OPTIONAL(line, LineField, );
3888   PARSE_MD_FIELDS();
3889 #undef VISIT_MD_FIELDS
3890
3891   Result = GET_OR_DISTINCT(DINamespace,
3892                            (Context, scope.Val, file.Val, name.Val, line.Val));
3893   return false;
3894 }
3895
3896 /// ParseDIModule:
3897 ///   ::= !DIModule(scope: !0, name: "SomeModule", configMacros: "-DNDEBUG",
3898 ///                 includePath: "/usr/include", isysroot: "/")
3899 bool LLParser::ParseDIModule(MDNode *&Result, bool IsDistinct) {
3900 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED)                                    \
3901   REQUIRED(scope, MDField, );                                                  \
3902   REQUIRED(name, MDStringField, );                                             \
3903   OPTIONAL(configMacros, MDStringField, );                                     \
3904   OPTIONAL(includePath, MDStringField, );                                      \
3905   OPTIONAL(isysroot, MDStringField, );
3906   PARSE_MD_FIELDS();
3907 #undef VISIT_MD_FIELDS
3908
3909   Result = GET_OR_DISTINCT(DIModule, (Context, scope.Val, name.Val,
3910                            configMacros.Val, includePath.Val, isysroot.Val));
3911   return false;
3912 }
3913
3914 /// ParseDITemplateTypeParameter:
3915 ///   ::= !DITemplateTypeParameter(name: "Ty", type: !1)
3916 bool LLParser::ParseDITemplateTypeParameter(MDNode *&Result, bool IsDistinct) {
3917 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED)                                    \
3918   OPTIONAL(name, MDStringField, );                                             \
3919   REQUIRED(type, MDField, );
3920   PARSE_MD_FIELDS();
3921 #undef VISIT_MD_FIELDS
3922
3923   Result =
3924       GET_OR_DISTINCT(DITemplateTypeParameter, (Context, name.Val, type.Val));
3925   return false;
3926 }
3927
3928 /// ParseDITemplateValueParameter:
3929 ///   ::= !DITemplateValueParameter(tag: DW_TAG_template_value_parameter,
3930 ///                                 name: "V", type: !1, value: i32 7)
3931 bool LLParser::ParseDITemplateValueParameter(MDNode *&Result, bool IsDistinct) {
3932 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED)                                    \
3933   OPTIONAL(tag, DwarfTagField, (dwarf::DW_TAG_template_value_parameter));      \
3934   OPTIONAL(name, MDStringField, );                                             \
3935   OPTIONAL(type, MDField, );                                                   \
3936   REQUIRED(value, MDField, );
3937   PARSE_MD_FIELDS();
3938 #undef VISIT_MD_FIELDS
3939
3940   Result = GET_OR_DISTINCT(DITemplateValueParameter,
3941                            (Context, tag.Val, name.Val, type.Val, value.Val));
3942   return false;
3943 }
3944
3945 /// ParseDIGlobalVariable:
3946 ///   ::= !DIGlobalVariable(scope: !0, name: "foo", linkageName: "foo",
3947 ///                         file: !1, line: 7, type: !2, isLocal: false,
3948 ///                         isDefinition: true, variable: i32* @foo,
3949 ///                         declaration: !3)
3950 bool LLParser::ParseDIGlobalVariable(MDNode *&Result, bool IsDistinct) {
3951 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED)                                    \
3952   REQUIRED(name, MDStringField, (/* AllowEmpty */ false));                     \
3953   OPTIONAL(scope, MDField, );                                                  \
3954   OPTIONAL(linkageName, MDStringField, );                                      \
3955   OPTIONAL(file, MDField, );                                                   \
3956   OPTIONAL(line, LineField, );                                                 \
3957   OPTIONAL(type, MDField, );                                                   \
3958   OPTIONAL(isLocal, MDBoolField, );                                            \
3959   OPTIONAL(isDefinition, MDBoolField, (true));                                 \
3960   OPTIONAL(variable, MDConstant, );                                            \
3961   OPTIONAL(declaration, MDField, );
3962   PARSE_MD_FIELDS();
3963 #undef VISIT_MD_FIELDS
3964
3965   Result = GET_OR_DISTINCT(DIGlobalVariable,
3966                            (Context, scope.Val, name.Val, linkageName.Val,
3967                             file.Val, line.Val, type.Val, isLocal.Val,
3968                             isDefinition.Val, variable.Val, declaration.Val));
3969   return false;
3970 }
3971
3972 /// ParseDILocalVariable:
3973 ///   ::= !DILocalVariable(arg: 7, scope: !0, name: "foo",
3974 ///                        file: !1, line: 7, type: !2, arg: 2, flags: 7)
3975 ///   ::= !DILocalVariable(scope: !0, name: "foo",
3976 ///                        file: !1, line: 7, type: !2, arg: 2, flags: 7)
3977 bool LLParser::ParseDILocalVariable(MDNode *&Result, bool IsDistinct) {
3978 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED)                                    \
3979   REQUIRED(scope, MDField, (/* AllowNull */ false));                           \
3980   OPTIONAL(name, MDStringField, );                                             \
3981   OPTIONAL(arg, MDUnsignedField, (0, UINT16_MAX));                             \
3982   OPTIONAL(file, MDField, );                                                   \
3983   OPTIONAL(line, LineField, );                                                 \
3984   OPTIONAL(type, MDField, );                                                   \
3985   OPTIONAL(flags, DIFlagField, );
3986   PARSE_MD_FIELDS();
3987 #undef VISIT_MD_FIELDS
3988
3989   Result = GET_OR_DISTINCT(DILocalVariable,
3990                            (Context, scope.Val, name.Val, file.Val, line.Val,
3991                             type.Val, arg.Val, flags.Val));
3992   return false;
3993 }
3994
3995 /// ParseDIExpression:
3996 ///   ::= !DIExpression(0, 7, -1)
3997 bool LLParser::ParseDIExpression(MDNode *&Result, bool IsDistinct) {
3998   assert(Lex.getKind() == lltok::MetadataVar && "Expected metadata type name");
3999   Lex.Lex();
4000
4001   if (ParseToken(lltok::lparen, "expected '(' here"))
4002     return true;
4003
4004   SmallVector<uint64_t, 8> Elements;
4005   if (Lex.getKind() != lltok::rparen)
4006     do {
4007       if (Lex.getKind() == lltok::DwarfOp) {
4008         if (unsigned Op = dwarf::getOperationEncoding(Lex.getStrVal())) {
4009           Lex.Lex();
4010           Elements.push_back(Op);
4011           continue;
4012         }
4013         return TokError(Twine("invalid DWARF op '") + Lex.getStrVal() + "'");
4014       }
4015
4016       if (Lex.getKind() != lltok::APSInt || Lex.getAPSIntVal().isSigned())
4017         return TokError("expected unsigned integer");
4018
4019       auto &U = Lex.getAPSIntVal();
4020       if (U.ugt(UINT64_MAX))
4021         return TokError("element too large, limit is " + Twine(UINT64_MAX));
4022       Elements.push_back(U.getZExtValue());
4023       Lex.Lex();
4024     } while (EatIfPresent(lltok::comma));
4025
4026   if (ParseToken(lltok::rparen, "expected ')' here"))
4027     return true;
4028
4029   Result = GET_OR_DISTINCT(DIExpression, (Context, Elements));
4030   return false;
4031 }
4032
4033 /// ParseDIObjCProperty:
4034 ///   ::= !DIObjCProperty(name: "foo", file: !1, line: 7, setter: "setFoo",
4035 ///                       getter: "getFoo", attributes: 7, type: !2)
4036 bool LLParser::ParseDIObjCProperty(MDNode *&Result, bool IsDistinct) {
4037 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED)                                    \
4038   OPTIONAL(name, MDStringField, );                                             \
4039   OPTIONAL(file, MDField, );                                                   \
4040   OPTIONAL(line, LineField, );                                                 \
4041   OPTIONAL(setter, MDStringField, );                                           \
4042   OPTIONAL(getter, MDStringField, );                                           \
4043   OPTIONAL(attributes, MDUnsignedField, (0, UINT32_MAX));                      \
4044   OPTIONAL(type, MDField, );
4045   PARSE_MD_FIELDS();
4046 #undef VISIT_MD_FIELDS
4047
4048   Result = GET_OR_DISTINCT(DIObjCProperty,
4049                            (Context, name.Val, file.Val, line.Val, setter.Val,
4050                             getter.Val, attributes.Val, type.Val));
4051   return false;
4052 }
4053
4054 /// ParseDIImportedEntity:
4055 ///   ::= !DIImportedEntity(tag: DW_TAG_imported_module, scope: !0, entity: !1,
4056 ///                         line: 7, name: "foo")
4057 bool LLParser::ParseDIImportedEntity(MDNode *&Result, bool IsDistinct) {
4058 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED)                                    \
4059   REQUIRED(tag, DwarfTagField, );                                              \
4060   REQUIRED(scope, MDField, );                                                  \
4061   OPTIONAL(entity, MDField, );                                                 \
4062   OPTIONAL(line, LineField, );                                                 \
4063   OPTIONAL(name, MDStringField, );
4064   PARSE_MD_FIELDS();
4065 #undef VISIT_MD_FIELDS
4066
4067   Result = GET_OR_DISTINCT(DIImportedEntity, (Context, tag.Val, scope.Val,
4068                                               entity.Val, line.Val, name.Val));
4069   return false;
4070 }
4071
4072 #undef PARSE_MD_FIELD
4073 #undef NOP_FIELD
4074 #undef REQUIRE_FIELD
4075 #undef DECLARE_FIELD
4076
4077 /// ParseMetadataAsValue
4078 ///  ::= metadata i32 %local
4079 ///  ::= metadata i32 @global
4080 ///  ::= metadata i32 7
4081 ///  ::= metadata !0
4082 ///  ::= metadata !{...}
4083 ///  ::= metadata !"string"
4084 bool LLParser::ParseMetadataAsValue(Value *&V, PerFunctionState &PFS) {
4085   // Note: the type 'metadata' has already been parsed.
4086   Metadata *MD;
4087   if (ParseMetadata(MD, &PFS))
4088     return true;
4089
4090   V = MetadataAsValue::get(Context, MD);
4091   return false;
4092 }
4093
4094 /// ParseValueAsMetadata
4095 ///  ::= i32 %local
4096 ///  ::= i32 @global
4097 ///  ::= i32 7
4098 bool LLParser::ParseValueAsMetadata(Metadata *&MD, const Twine &TypeMsg,
4099                                     PerFunctionState *PFS) {
4100   Type *Ty;
4101   LocTy Loc;
4102   if (ParseType(Ty, TypeMsg, Loc))
4103     return true;
4104   if (Ty->isMetadataTy())
4105     return Error(Loc, "invalid metadata-value-metadata roundtrip");
4106
4107   Value *V;
4108   if (ParseValue(Ty, V, PFS))
4109     return true;
4110
4111   MD = ValueAsMetadata::get(V);
4112   return false;
4113 }
4114
4115 /// ParseMetadata
4116 ///  ::= i32 %local
4117 ///  ::= i32 @global
4118 ///  ::= i32 7
4119 ///  ::= !42
4120 ///  ::= !{...}
4121 ///  ::= !"string"
4122 ///  ::= !DILocation(...)
4123 bool LLParser::ParseMetadata(Metadata *&MD, PerFunctionState *PFS) {
4124   if (Lex.getKind() == lltok::MetadataVar) {
4125     MDNode *N;
4126     if (ParseSpecializedMDNode(N))
4127       return true;
4128     MD = N;
4129     return false;
4130   }
4131
4132   // ValueAsMetadata:
4133   // <type> <value>
4134   if (Lex.getKind() != lltok::exclaim)
4135     return ParseValueAsMetadata(MD, "expected metadata operand", PFS);
4136
4137   // '!'.
4138   assert(Lex.getKind() == lltok::exclaim && "Expected '!' here");
4139   Lex.Lex();
4140
4141   // MDString:
4142   //   ::= '!' STRINGCONSTANT
4143   if (Lex.getKind() == lltok::StringConstant) {
4144     MDString *S;
4145     if (ParseMDString(S))
4146       return true;
4147     MD = S;
4148     return false;
4149   }
4150
4151   // MDNode:
4152   // !{ ... }
4153   // !7
4154   MDNode *N;
4155   if (ParseMDNodeTail(N))
4156     return true;
4157   MD = N;
4158   return false;
4159 }
4160
4161
4162 //===----------------------------------------------------------------------===//
4163 // Function Parsing.
4164 //===----------------------------------------------------------------------===//
4165
4166 bool LLParser::ConvertValIDToValue(Type *Ty, ValID &ID, Value *&V,
4167                                    PerFunctionState *PFS,
4168                                    OperatorConstraint OC) {
4169   if (Ty->isFunctionTy())
4170     return Error(ID.Loc, "functions are not values, refer to them as pointers");
4171
4172   if (OC && ID.Kind != ValID::t_LocalID && ID.Kind != ValID::t_LocalName) {
4173     switch (OC) {
4174     case OC_CatchPad:
4175       return Error(ID.Loc, "Catchpad value required in this position");
4176     case OC_CleanupPad:
4177       return Error(ID.Loc, "Cleanuppad value required in this position");
4178     default:
4179       llvm_unreachable("Unexpected constraint kind");
4180     }
4181   }
4182
4183   switch (ID.Kind) {
4184   case ValID::t_LocalID:
4185     if (!PFS) return Error(ID.Loc, "invalid use of function-local name");
4186     V = PFS->GetVal(ID.UIntVal, Ty, ID.Loc, OC);
4187     return V == nullptr;
4188   case ValID::t_LocalName:
4189     if (!PFS) return Error(ID.Loc, "invalid use of function-local name");
4190     V = PFS->GetVal(ID.StrVal, Ty, ID.Loc, OC);
4191     return V == nullptr;
4192   case ValID::t_InlineAsm: {
4193     if (!ID.FTy || !InlineAsm::Verify(ID.FTy, ID.StrVal2))
4194       return Error(ID.Loc, "invalid type for inline asm constraint string");
4195     V = InlineAsm::get(ID.FTy, ID.StrVal, ID.StrVal2, ID.UIntVal & 1,
4196                        (ID.UIntVal >> 1) & 1,
4197                        (InlineAsm::AsmDialect(ID.UIntVal >> 2)));
4198     return false;
4199   }
4200   case ValID::t_GlobalName:
4201     V = GetGlobalVal(ID.StrVal, Ty, ID.Loc);
4202     return V == nullptr;
4203   case ValID::t_GlobalID:
4204     V = GetGlobalVal(ID.UIntVal, Ty, ID.Loc);
4205     return V == nullptr;
4206   case ValID::t_APSInt:
4207     if (!Ty->isIntegerTy())
4208       return Error(ID.Loc, "integer constant must have integer type");
4209     ID.APSIntVal = ID.APSIntVal.extOrTrunc(Ty->getPrimitiveSizeInBits());
4210     V = ConstantInt::get(Context, ID.APSIntVal);
4211     return false;
4212   case ValID::t_APFloat:
4213     if (!Ty->isFloatingPointTy() ||
4214         !ConstantFP::isValueValidForType(Ty, ID.APFloatVal))
4215       return Error(ID.Loc, "floating point constant invalid for type");
4216
4217     // The lexer has no type info, so builds all half, float, and double FP
4218     // constants as double.  Fix this here.  Long double does not need this.
4219     if (&ID.APFloatVal.getSemantics() == &APFloat::IEEEdouble) {
4220       bool Ignored;
4221       if (Ty->isHalfTy())
4222         ID.APFloatVal.convert(APFloat::IEEEhalf, APFloat::rmNearestTiesToEven,
4223                               &Ignored);
4224       else if (Ty->isFloatTy())
4225         ID.APFloatVal.convert(APFloat::IEEEsingle, APFloat::rmNearestTiesToEven,
4226                               &Ignored);
4227     }
4228     V = ConstantFP::get(Context, ID.APFloatVal);
4229
4230     if (V->getType() != Ty)
4231       return Error(ID.Loc, "floating point constant does not have type '" +
4232                    getTypeString(Ty) + "'");
4233
4234     return false;
4235   case ValID::t_Null:
4236     if (!Ty->isPointerTy())
4237       return Error(ID.Loc, "null must be a pointer type");
4238     V = ConstantPointerNull::get(cast<PointerType>(Ty));
4239     return false;
4240   case ValID::t_Undef:
4241     // FIXME: LabelTy should not be a first-class type.
4242     if (!Ty->isFirstClassType() || Ty->isLabelTy())
4243       return Error(ID.Loc, "invalid type for undef constant");
4244     V = UndefValue::get(Ty);
4245     return false;
4246   case ValID::t_EmptyArray:
4247     if (!Ty->isArrayTy() || cast<ArrayType>(Ty)->getNumElements() != 0)
4248       return Error(ID.Loc, "invalid empty array initializer");
4249     V = UndefValue::get(Ty);
4250     return false;
4251   case ValID::t_Zero:
4252     // FIXME: LabelTy should not be a first-class type.
4253     if (!Ty->isFirstClassType() || Ty->isLabelTy())
4254       return Error(ID.Loc, "invalid type for null constant");
4255     V = Constant::getNullValue(Ty);
4256     return false;
4257   case ValID::t_Constant:
4258     if (ID.ConstantVal->getType() != Ty)
4259       return Error(ID.Loc, "constant expression type mismatch");
4260
4261     V = ID.ConstantVal;
4262     return false;
4263   case ValID::t_ConstantStruct:
4264   case ValID::t_PackedConstantStruct:
4265     if (StructType *ST = dyn_cast<StructType>(Ty)) {
4266       if (ST->getNumElements() != ID.UIntVal)
4267         return Error(ID.Loc,
4268                      "initializer with struct type has wrong # elements");
4269       if (ST->isPacked() != (ID.Kind == ValID::t_PackedConstantStruct))
4270         return Error(ID.Loc, "packed'ness of initializer and type don't match");
4271
4272       // Verify that the elements are compatible with the structtype.
4273       for (unsigned i = 0, e = ID.UIntVal; i != e; ++i)
4274         if (ID.ConstantStructElts[i]->getType() != ST->getElementType(i))
4275           return Error(ID.Loc, "element " + Twine(i) +
4276                     " of struct initializer doesn't match struct element type");
4277
4278       V = ConstantStruct::get(
4279           ST, makeArrayRef(ID.ConstantStructElts.get(), ID.UIntVal));
4280     } else
4281       return Error(ID.Loc, "constant expression type mismatch");
4282     return false;
4283   }
4284   llvm_unreachable("Invalid ValID");
4285 }
4286
4287 bool LLParser::parseConstantValue(Type *Ty, Constant *&C) {
4288   C = nullptr;
4289   ValID ID;
4290   auto Loc = Lex.getLoc();
4291   if (ParseValID(ID, /*PFS=*/nullptr))
4292     return true;
4293   switch (ID.Kind) {
4294   case ValID::t_APSInt:
4295   case ValID::t_APFloat:
4296   case ValID::t_Undef:
4297   case ValID::t_Constant:
4298   case ValID::t_ConstantStruct:
4299   case ValID::t_PackedConstantStruct: {
4300     Value *V;
4301     if (ConvertValIDToValue(Ty, ID, V, /*PFS=*/nullptr))
4302       return true;
4303     assert(isa<Constant>(V) && "Expected a constant value");
4304     C = cast<Constant>(V);
4305     return false;
4306   }
4307   default:
4308     return Error(Loc, "expected a constant value");
4309   }
4310 }
4311
4312 bool LLParser::ParseValue(Type *Ty, Value *&V, PerFunctionState *PFS,
4313                           OperatorConstraint OC) {
4314   V = nullptr;
4315   ValID ID;
4316   return ParseValID(ID, PFS) || ConvertValIDToValue(Ty, ID, V, PFS, OC);
4317 }
4318
4319 bool LLParser::ParseTypeAndValue(Value *&V, PerFunctionState *PFS) {
4320   Type *Ty = nullptr;
4321   return ParseType(Ty) ||
4322          ParseValue(Ty, V, PFS);
4323 }
4324
4325 bool LLParser::ParseTypeAndBasicBlock(BasicBlock *&BB, LocTy &Loc,
4326                                       PerFunctionState &PFS) {
4327   Value *V;
4328   Loc = Lex.getLoc();
4329   if (ParseTypeAndValue(V, PFS)) return true;
4330   if (!isa<BasicBlock>(V))
4331     return Error(Loc, "expected a basic block");
4332   BB = cast<BasicBlock>(V);
4333   return false;
4334 }
4335
4336
4337 /// FunctionHeader
4338 ///   ::= OptionalLinkage OptionalVisibility OptionalCallingConv OptRetAttrs
4339 ///       OptUnnamedAddr Type GlobalName '(' ArgList ')' OptFuncAttrs OptSection
4340 ///       OptionalAlign OptGC OptionalPrefix OptionalPrologue OptPersonalityFn
4341 bool LLParser::ParseFunctionHeader(Function *&Fn, bool isDefine) {
4342   // Parse the linkage.
4343   LocTy LinkageLoc = Lex.getLoc();
4344   unsigned Linkage;
4345
4346   unsigned Visibility;
4347   unsigned DLLStorageClass;
4348   AttrBuilder RetAttrs;
4349   unsigned CC;
4350   Type *RetType = nullptr;
4351   LocTy RetTypeLoc = Lex.getLoc();
4352   if (ParseOptionalLinkage(Linkage) ||
4353       ParseOptionalVisibility(Visibility) ||
4354       ParseOptionalDLLStorageClass(DLLStorageClass) ||
4355       ParseOptionalCallingConv(CC) ||
4356       ParseOptionalReturnAttrs(RetAttrs) ||
4357       ParseType(RetType, RetTypeLoc, true /*void allowed*/))
4358     return true;
4359
4360   // Verify that the linkage is ok.
4361   switch ((GlobalValue::LinkageTypes)Linkage) {
4362   case GlobalValue::ExternalLinkage:
4363     break; // always ok.
4364   case GlobalValue::ExternalWeakLinkage:
4365     if (isDefine)
4366       return Error(LinkageLoc, "invalid linkage for function definition");
4367     break;
4368   case GlobalValue::PrivateLinkage:
4369   case GlobalValue::InternalLinkage:
4370   case GlobalValue::AvailableExternallyLinkage:
4371   case GlobalValue::LinkOnceAnyLinkage:
4372   case GlobalValue::LinkOnceODRLinkage:
4373   case GlobalValue::WeakAnyLinkage:
4374   case GlobalValue::WeakODRLinkage:
4375     if (!isDefine)
4376       return Error(LinkageLoc, "invalid linkage for function declaration");
4377     break;
4378   case GlobalValue::AppendingLinkage:
4379   case GlobalValue::CommonLinkage:
4380     return Error(LinkageLoc, "invalid function linkage type");
4381   }
4382
4383   if (!isValidVisibilityForLinkage(Visibility, Linkage))
4384     return Error(LinkageLoc,
4385                  "symbol with local linkage must have default visibility");
4386
4387   if (!FunctionType::isValidReturnType(RetType))
4388     return Error(RetTypeLoc, "invalid function return type");
4389
4390   LocTy NameLoc = Lex.getLoc();
4391
4392   std::string FunctionName;
4393   if (Lex.getKind() == lltok::GlobalVar) {
4394     FunctionName = Lex.getStrVal();
4395   } else if (Lex.getKind() == lltok::GlobalID) {     // @42 is ok.
4396     unsigned NameID = Lex.getUIntVal();
4397
4398     if (NameID != NumberedVals.size())
4399       return TokError("function expected to be numbered '%" +
4400                       Twine(NumberedVals.size()) + "'");
4401   } else {
4402     return TokError("expected function name");
4403   }
4404
4405   Lex.Lex();
4406
4407   if (Lex.getKind() != lltok::lparen)
4408     return TokError("expected '(' in function argument list");
4409
4410   SmallVector<ArgInfo, 8> ArgList;
4411   bool isVarArg;
4412   AttrBuilder FuncAttrs;
4413   std::vector<unsigned> FwdRefAttrGrps;
4414   LocTy BuiltinLoc;
4415   std::string Section;
4416   unsigned Alignment;
4417   std::string GC;
4418   bool UnnamedAddr;
4419   LocTy UnnamedAddrLoc;
4420   Constant *Prefix = nullptr;
4421   Constant *Prologue = nullptr;
4422   Constant *PersonalityFn = nullptr;
4423   Comdat *C;
4424
4425   if (ParseArgumentList(ArgList, isVarArg) ||
4426       ParseOptionalToken(lltok::kw_unnamed_addr, UnnamedAddr,
4427                          &UnnamedAddrLoc) ||
4428       ParseFnAttributeValuePairs(FuncAttrs, FwdRefAttrGrps, false,
4429                                  BuiltinLoc) ||
4430       (EatIfPresent(lltok::kw_section) &&
4431        ParseStringConstant(Section)) ||
4432       parseOptionalComdat(FunctionName, C) ||
4433       ParseOptionalAlignment(Alignment) ||
4434       (EatIfPresent(lltok::kw_gc) &&
4435        ParseStringConstant(GC)) ||
4436       (EatIfPresent(lltok::kw_prefix) &&
4437        ParseGlobalTypeAndValue(Prefix)) ||
4438       (EatIfPresent(lltok::kw_prologue) &&
4439        ParseGlobalTypeAndValue(Prologue)) ||
4440       (EatIfPresent(lltok::kw_personality) &&
4441        ParseGlobalTypeAndValue(PersonalityFn)))
4442     return true;
4443
4444   if (FuncAttrs.contains(Attribute::Builtin))
4445     return Error(BuiltinLoc, "'builtin' attribute not valid on function");
4446
4447   // If the alignment was parsed as an attribute, move to the alignment field.
4448   if (FuncAttrs.hasAlignmentAttr()) {
4449     Alignment = FuncAttrs.getAlignment();
4450     FuncAttrs.removeAttribute(Attribute::Alignment);
4451   }
4452
4453   // Okay, if we got here, the function is syntactically valid.  Convert types
4454   // and do semantic checks.
4455   std::vector<Type*> ParamTypeList;
4456   SmallVector<AttributeSet, 8> Attrs;
4457
4458   if (RetAttrs.hasAttributes())
4459     Attrs.push_back(AttributeSet::get(RetType->getContext(),
4460                                       AttributeSet::ReturnIndex,
4461                                       RetAttrs));
4462
4463   for (unsigned i = 0, e = ArgList.size(); i != e; ++i) {
4464     ParamTypeList.push_back(ArgList[i].Ty);
4465     if (ArgList[i].Attrs.hasAttributes(i + 1)) {
4466       AttrBuilder B(ArgList[i].Attrs, i + 1);
4467       Attrs.push_back(AttributeSet::get(RetType->getContext(), i + 1, B));
4468     }
4469   }
4470
4471   if (FuncAttrs.hasAttributes())
4472     Attrs.push_back(AttributeSet::get(RetType->getContext(),
4473                                       AttributeSet::FunctionIndex,
4474                                       FuncAttrs));
4475
4476   AttributeSet PAL = AttributeSet::get(Context, Attrs);
4477
4478   if (PAL.hasAttribute(1, Attribute::StructRet) && !RetType->isVoidTy())
4479     return Error(RetTypeLoc, "functions with 'sret' argument must return void");
4480
4481   FunctionType *FT =
4482     FunctionType::get(RetType, ParamTypeList, isVarArg);
4483   PointerType *PFT = PointerType::getUnqual(FT);
4484
4485   Fn = nullptr;
4486   if (!FunctionName.empty()) {
4487     // If this was a definition of a forward reference, remove the definition
4488     // from the forward reference table and fill in the forward ref.
4489     auto FRVI = ForwardRefVals.find(FunctionName);
4490     if (FRVI != ForwardRefVals.end()) {
4491       Fn = M->getFunction(FunctionName);
4492       if (!Fn)
4493         return Error(FRVI->second.second, "invalid forward reference to "
4494                      "function as global value!");
4495       if (Fn->getType() != PFT)
4496         return Error(FRVI->second.second, "invalid forward reference to "
4497                      "function '" + FunctionName + "' with wrong type!");
4498
4499       ForwardRefVals.erase(FRVI);
4500     } else if ((Fn = M->getFunction(FunctionName))) {
4501       // Reject redefinitions.
4502       return Error(NameLoc, "invalid redefinition of function '" +
4503                    FunctionName + "'");
4504     } else if (M->getNamedValue(FunctionName)) {
4505       return Error(NameLoc, "redefinition of function '@" + FunctionName + "'");
4506     }
4507
4508   } else {
4509     // If this is a definition of a forward referenced function, make sure the
4510     // types agree.
4511     auto I = ForwardRefValIDs.find(NumberedVals.size());
4512     if (I != ForwardRefValIDs.end()) {
4513       Fn = cast<Function>(I->second.first);
4514       if (Fn->getType() != PFT)
4515         return Error(NameLoc, "type of definition and forward reference of '@" +
4516                      Twine(NumberedVals.size()) + "' disagree");
4517       ForwardRefValIDs.erase(I);
4518     }
4519   }
4520
4521   if (!Fn)
4522     Fn = Function::Create(FT, GlobalValue::ExternalLinkage, FunctionName, M);
4523   else // Move the forward-reference to the correct spot in the module.
4524     M->getFunctionList().splice(M->end(), M->getFunctionList(), Fn);
4525
4526   if (FunctionName.empty())
4527     NumberedVals.push_back(Fn);
4528
4529   Fn->setLinkage((GlobalValue::LinkageTypes)Linkage);
4530   Fn->setVisibility((GlobalValue::VisibilityTypes)Visibility);
4531   Fn->setDLLStorageClass((GlobalValue::DLLStorageClassTypes)DLLStorageClass);
4532   Fn->setCallingConv(CC);
4533   Fn->setAttributes(PAL);
4534   Fn->setUnnamedAddr(UnnamedAddr);
4535   Fn->setAlignment(Alignment);
4536   Fn->setSection(Section);
4537   Fn->setComdat(C);
4538   Fn->setPersonalityFn(PersonalityFn);
4539   if (!GC.empty()) Fn->setGC(GC.c_str());
4540   Fn->setPrefixData(Prefix);
4541   Fn->setPrologueData(Prologue);
4542   ForwardRefAttrGroups[Fn] = FwdRefAttrGrps;
4543
4544   // Add all of the arguments we parsed to the function.
4545   Function::arg_iterator ArgIt = Fn->arg_begin();
4546   for (unsigned i = 0, e = ArgList.size(); i != e; ++i, ++ArgIt) {
4547     // If the argument has a name, insert it into the argument symbol table.
4548     if (ArgList[i].Name.empty()) continue;
4549
4550     // Set the name, if it conflicted, it will be auto-renamed.
4551     ArgIt->setName(ArgList[i].Name);
4552
4553     if (ArgIt->getName() != ArgList[i].Name)
4554       return Error(ArgList[i].Loc, "redefinition of argument '%" +
4555                    ArgList[i].Name + "'");
4556   }
4557
4558   if (isDefine)
4559     return false;
4560
4561   // Check the declaration has no block address forward references.
4562   ValID ID;
4563   if (FunctionName.empty()) {
4564     ID.Kind = ValID::t_GlobalID;
4565     ID.UIntVal = NumberedVals.size() - 1;
4566   } else {
4567     ID.Kind = ValID::t_GlobalName;
4568     ID.StrVal = FunctionName;
4569   }
4570   auto Blocks = ForwardRefBlockAddresses.find(ID);
4571   if (Blocks != ForwardRefBlockAddresses.end())
4572     return Error(Blocks->first.Loc,
4573                  "cannot take blockaddress inside a declaration");
4574   return false;
4575 }
4576
4577 bool LLParser::PerFunctionState::resolveForwardRefBlockAddresses() {
4578   ValID ID;
4579   if (FunctionNumber == -1) {
4580     ID.Kind = ValID::t_GlobalName;
4581     ID.StrVal = F.getName();
4582   } else {
4583     ID.Kind = ValID::t_GlobalID;
4584     ID.UIntVal = FunctionNumber;
4585   }
4586
4587   auto Blocks = P.ForwardRefBlockAddresses.find(ID);
4588   if (Blocks == P.ForwardRefBlockAddresses.end())
4589     return false;
4590
4591   for (const auto &I : Blocks->second) {
4592     const ValID &BBID = I.first;
4593     GlobalValue *GV = I.second;
4594
4595     assert((BBID.Kind == ValID::t_LocalID || BBID.Kind == ValID::t_LocalName) &&
4596            "Expected local id or name");
4597     BasicBlock *BB;
4598     if (BBID.Kind == ValID::t_LocalName)
4599       BB = GetBB(BBID.StrVal, BBID.Loc);
4600     else
4601       BB = GetBB(BBID.UIntVal, BBID.Loc);
4602     if (!BB)
4603       return P.Error(BBID.Loc, "referenced value is not a basic block");
4604
4605     GV->replaceAllUsesWith(BlockAddress::get(&F, BB));
4606     GV->eraseFromParent();
4607   }
4608
4609   P.ForwardRefBlockAddresses.erase(Blocks);
4610   return false;
4611 }
4612
4613 /// ParseFunctionBody
4614 ///   ::= '{' BasicBlock+ UseListOrderDirective* '}'
4615 bool LLParser::ParseFunctionBody(Function &Fn) {
4616   if (Lex.getKind() != lltok::lbrace)
4617     return TokError("expected '{' in function body");
4618   Lex.Lex();  // eat the {.
4619
4620   int FunctionNumber = -1;
4621   if (!Fn.hasName()) FunctionNumber = NumberedVals.size()-1;
4622
4623   PerFunctionState PFS(*this, Fn, FunctionNumber);
4624
4625   // Resolve block addresses and allow basic blocks to be forward-declared
4626   // within this function.
4627   if (PFS.resolveForwardRefBlockAddresses())
4628     return true;
4629   SaveAndRestore<PerFunctionState *> ScopeExit(BlockAddressPFS, &PFS);
4630
4631   // We need at least one basic block.
4632   if (Lex.getKind() == lltok::rbrace || Lex.getKind() == lltok::kw_uselistorder)
4633     return TokError("function body requires at least one basic block");
4634
4635   while (Lex.getKind() != lltok::rbrace &&
4636          Lex.getKind() != lltok::kw_uselistorder)
4637     if (ParseBasicBlock(PFS)) return true;
4638
4639   while (Lex.getKind() != lltok::rbrace)
4640     if (ParseUseListOrder(&PFS))
4641       return true;
4642
4643   // Eat the }.
4644   Lex.Lex();
4645
4646   // Verify function is ok.
4647   return PFS.FinishFunction();
4648 }
4649
4650 /// ParseBasicBlock
4651 ///   ::= LabelStr? Instruction*
4652 bool LLParser::ParseBasicBlock(PerFunctionState &PFS) {
4653   // If this basic block starts out with a name, remember it.
4654   std::string Name;
4655   LocTy NameLoc = Lex.getLoc();
4656   if (Lex.getKind() == lltok::LabelStr) {
4657     Name = Lex.getStrVal();
4658     Lex.Lex();
4659   }
4660
4661   BasicBlock *BB = PFS.DefineBB(Name, NameLoc);
4662   if (!BB)
4663     return Error(NameLoc,
4664                  "unable to create block named '" + Name + "'");
4665
4666   std::string NameStr;
4667
4668   // Parse the instructions in this block until we get a terminator.
4669   Instruction *Inst;
4670   do {
4671     // This instruction may have three possibilities for a name: a) none
4672     // specified, b) name specified "%foo =", c) number specified: "%4 =".
4673     LocTy NameLoc = Lex.getLoc();
4674     int NameID = -1;
4675     NameStr = "";
4676
4677     if (Lex.getKind() == lltok::LocalVarID) {
4678       NameID = Lex.getUIntVal();
4679       Lex.Lex();
4680       if (ParseToken(lltok::equal, "expected '=' after instruction id"))
4681         return true;
4682     } else if (Lex.getKind() == lltok::LocalVar) {
4683       NameStr = Lex.getStrVal();
4684       Lex.Lex();
4685       if (ParseToken(lltok::equal, "expected '=' after instruction name"))
4686         return true;
4687     }
4688
4689     switch (ParseInstruction(Inst, BB, PFS)) {
4690     default: llvm_unreachable("Unknown ParseInstruction result!");
4691     case InstError: return true;
4692     case InstNormal:
4693       BB->getInstList().push_back(Inst);
4694
4695       // With a normal result, we check to see if the instruction is followed by
4696       // a comma and metadata.
4697       if (EatIfPresent(lltok::comma))
4698         if (ParseInstructionMetadata(*Inst))
4699           return true;
4700       break;
4701     case InstExtraComma:
4702       BB->getInstList().push_back(Inst);
4703
4704       // If the instruction parser ate an extra comma at the end of it, it
4705       // *must* be followed by metadata.
4706       if (ParseInstructionMetadata(*Inst))
4707         return true;
4708       break;
4709     }
4710
4711     // Set the name on the instruction.
4712     if (PFS.SetInstName(NameID, NameStr, NameLoc, Inst)) return true;
4713   } while (!isa<TerminatorInst>(Inst));
4714
4715   return false;
4716 }
4717
4718 //===----------------------------------------------------------------------===//
4719 // Instruction Parsing.
4720 //===----------------------------------------------------------------------===//
4721
4722 /// ParseInstruction - Parse one of the many different instructions.
4723 ///
4724 int LLParser::ParseInstruction(Instruction *&Inst, BasicBlock *BB,
4725                                PerFunctionState &PFS) {
4726   lltok::Kind Token = Lex.getKind();
4727   if (Token == lltok::Eof)
4728     return TokError("found end of file when expecting more instructions");
4729   LocTy Loc = Lex.getLoc();
4730   unsigned KeywordVal = Lex.getUIntVal();
4731   Lex.Lex();  // Eat the keyword.
4732
4733   switch (Token) {
4734   default:                    return Error(Loc, "expected instruction opcode");
4735   // Terminator Instructions.
4736   case lltok::kw_unreachable: Inst = new UnreachableInst(Context); return false;
4737   case lltok::kw_ret:         return ParseRet(Inst, BB, PFS);
4738   case lltok::kw_br:          return ParseBr(Inst, PFS);
4739   case lltok::kw_switch:      return ParseSwitch(Inst, PFS);
4740   case lltok::kw_indirectbr:  return ParseIndirectBr(Inst, PFS);
4741   case lltok::kw_invoke:      return ParseInvoke(Inst, PFS);
4742   case lltok::kw_resume:      return ParseResume(Inst, PFS);
4743   case lltok::kw_cleanupret:  return ParseCleanupRet(Inst, PFS);
4744   case lltok::kw_catchret:    return ParseCatchRet(Inst, PFS);
4745   case lltok::kw_catchpad:  return ParseCatchPad(Inst, PFS);
4746   case lltok::kw_terminatepad: return ParseTerminatePad(Inst, PFS);
4747   case lltok::kw_cleanuppad: return ParseCleanupPad(Inst, PFS);
4748   case lltok::kw_catchendpad: return ParseCatchEndPad(Inst, PFS);
4749   case lltok::kw_cleanupendpad: return ParseCleanupEndPad(Inst, PFS);
4750   // Binary Operators.
4751   case lltok::kw_add:
4752   case lltok::kw_sub:
4753   case lltok::kw_mul:
4754   case lltok::kw_shl: {
4755     bool NUW = EatIfPresent(lltok::kw_nuw);
4756     bool NSW = EatIfPresent(lltok::kw_nsw);
4757     if (!NUW) NUW = EatIfPresent(lltok::kw_nuw);
4758
4759     if (ParseArithmetic(Inst, PFS, KeywordVal, 1)) return true;
4760
4761     if (NUW) cast<BinaryOperator>(Inst)->setHasNoUnsignedWrap(true);
4762     if (NSW) cast<BinaryOperator>(Inst)->setHasNoSignedWrap(true);
4763     return false;
4764   }
4765   case lltok::kw_fadd:
4766   case lltok::kw_fsub:
4767   case lltok::kw_fmul:
4768   case lltok::kw_fdiv:
4769   case lltok::kw_frem: {
4770     FastMathFlags FMF = EatFastMathFlagsIfPresent();
4771     int Res = ParseArithmetic(Inst, PFS, KeywordVal, 2);
4772     if (Res != 0)
4773       return Res;
4774     if (FMF.any())
4775       Inst->setFastMathFlags(FMF);
4776     return 0;
4777   }
4778
4779   case lltok::kw_sdiv:
4780   case lltok::kw_udiv:
4781   case lltok::kw_lshr:
4782   case lltok::kw_ashr: {
4783     bool Exact = EatIfPresent(lltok::kw_exact);
4784
4785     if (ParseArithmetic(Inst, PFS, KeywordVal, 1)) return true;
4786     if (Exact) cast<BinaryOperator>(Inst)->setIsExact(true);
4787     return false;
4788   }
4789
4790   case lltok::kw_urem:
4791   case lltok::kw_srem:   return ParseArithmetic(Inst, PFS, KeywordVal, 1);
4792   case lltok::kw_and:
4793   case lltok::kw_or:
4794   case lltok::kw_xor:    return ParseLogical(Inst, PFS, KeywordVal);
4795   case lltok::kw_icmp:   return ParseCompare(Inst, PFS, KeywordVal);
4796   case lltok::kw_fcmp: {
4797     FastMathFlags FMF = EatFastMathFlagsIfPresent();
4798     int Res = ParseCompare(Inst, PFS, KeywordVal);
4799     if (Res != 0)
4800       return Res;
4801     if (FMF.any())
4802       Inst->setFastMathFlags(FMF);
4803     return 0;
4804   }
4805
4806   // Casts.
4807   case lltok::kw_trunc:
4808   case lltok::kw_zext:
4809   case lltok::kw_sext:
4810   case lltok::kw_fptrunc:
4811   case lltok::kw_fpext:
4812   case lltok::kw_bitcast:
4813   case lltok::kw_addrspacecast:
4814   case lltok::kw_uitofp:
4815   case lltok::kw_sitofp:
4816   case lltok::kw_fptoui:
4817   case lltok::kw_fptosi:
4818   case lltok::kw_inttoptr:
4819   case lltok::kw_ptrtoint:       return ParseCast(Inst, PFS, KeywordVal);
4820   // Other.
4821   case lltok::kw_select:         return ParseSelect(Inst, PFS);
4822   case lltok::kw_va_arg:         return ParseVA_Arg(Inst, PFS);
4823   case lltok::kw_extractelement: return ParseExtractElement(Inst, PFS);
4824   case lltok::kw_insertelement:  return ParseInsertElement(Inst, PFS);
4825   case lltok::kw_shufflevector:  return ParseShuffleVector(Inst, PFS);
4826   case lltok::kw_phi:            return ParsePHI(Inst, PFS);
4827   case lltok::kw_landingpad:     return ParseLandingPad(Inst, PFS);
4828   // Call.
4829   case lltok::kw_call:     return ParseCall(Inst, PFS, CallInst::TCK_None);
4830   case lltok::kw_tail:     return ParseCall(Inst, PFS, CallInst::TCK_Tail);
4831   case lltok::kw_musttail: return ParseCall(Inst, PFS, CallInst::TCK_MustTail);
4832   // Memory.
4833   case lltok::kw_alloca:         return ParseAlloc(Inst, PFS);
4834   case lltok::kw_load:           return ParseLoad(Inst, PFS);
4835   case lltok::kw_store:          return ParseStore(Inst, PFS);
4836   case lltok::kw_cmpxchg:        return ParseCmpXchg(Inst, PFS);
4837   case lltok::kw_atomicrmw:      return ParseAtomicRMW(Inst, PFS);
4838   case lltok::kw_fence:          return ParseFence(Inst, PFS);
4839   case lltok::kw_getelementptr: return ParseGetElementPtr(Inst, PFS);
4840   case lltok::kw_extractvalue:  return ParseExtractValue(Inst, PFS);
4841   case lltok::kw_insertvalue:   return ParseInsertValue(Inst, PFS);
4842   }
4843 }
4844
4845 /// ParseCmpPredicate - Parse an integer or fp predicate, based on Kind.
4846 bool LLParser::ParseCmpPredicate(unsigned &P, unsigned Opc) {
4847   if (Opc == Instruction::FCmp) {
4848     switch (Lex.getKind()) {
4849     default: return TokError("expected fcmp predicate (e.g. 'oeq')");
4850     case lltok::kw_oeq: P = CmpInst::FCMP_OEQ; break;
4851     case lltok::kw_one: P = CmpInst::FCMP_ONE; break;
4852     case lltok::kw_olt: P = CmpInst::FCMP_OLT; break;
4853     case lltok::kw_ogt: P = CmpInst::FCMP_OGT; break;
4854     case lltok::kw_ole: P = CmpInst::FCMP_OLE; break;
4855     case lltok::kw_oge: P = CmpInst::FCMP_OGE; break;
4856     case lltok::kw_ord: P = CmpInst::FCMP_ORD; break;
4857     case lltok::kw_uno: P = CmpInst::FCMP_UNO; break;
4858     case lltok::kw_ueq: P = CmpInst::FCMP_UEQ; break;
4859     case lltok::kw_une: P = CmpInst::FCMP_UNE; break;
4860     case lltok::kw_ult: P = CmpInst::FCMP_ULT; break;
4861     case lltok::kw_ugt: P = CmpInst::FCMP_UGT; break;
4862     case lltok::kw_ule: P = CmpInst::FCMP_ULE; break;
4863     case lltok::kw_uge: P = CmpInst::FCMP_UGE; break;
4864     case lltok::kw_true: P = CmpInst::FCMP_TRUE; break;
4865     case lltok::kw_false: P = CmpInst::FCMP_FALSE; break;
4866     }
4867   } else {
4868     switch (Lex.getKind()) {
4869     default: return TokError("expected icmp predicate (e.g. 'eq')");
4870     case lltok::kw_eq:  P = CmpInst::ICMP_EQ; break;
4871     case lltok::kw_ne:  P = CmpInst::ICMP_NE; break;
4872     case lltok::kw_slt: P = CmpInst::ICMP_SLT; break;
4873     case lltok::kw_sgt: P = CmpInst::ICMP_SGT; break;
4874     case lltok::kw_sle: P = CmpInst::ICMP_SLE; break;
4875     case lltok::kw_sge: P = CmpInst::ICMP_SGE; break;
4876     case lltok::kw_ult: P = CmpInst::ICMP_ULT; break;
4877     case lltok::kw_ugt: P = CmpInst::ICMP_UGT; break;
4878     case lltok::kw_ule: P = CmpInst::ICMP_ULE; break;
4879     case lltok::kw_uge: P = CmpInst::ICMP_UGE; break;
4880     }
4881   }
4882   Lex.Lex();
4883   return false;
4884 }
4885
4886 //===----------------------------------------------------------------------===//
4887 // Terminator Instructions.
4888 //===----------------------------------------------------------------------===//
4889
4890 /// ParseRet - Parse a return instruction.
4891 ///   ::= 'ret' void (',' !dbg, !1)*
4892 ///   ::= 'ret' TypeAndValue (',' !dbg, !1)*
4893 bool LLParser::ParseRet(Instruction *&Inst, BasicBlock *BB,
4894                         PerFunctionState &PFS) {
4895   SMLoc TypeLoc = Lex.getLoc();
4896   Type *Ty = nullptr;
4897   if (ParseType(Ty, true /*void allowed*/)) return true;
4898
4899   Type *ResType = PFS.getFunction().getReturnType();
4900
4901   if (Ty->isVoidTy()) {
4902     if (!ResType->isVoidTy())
4903       return Error(TypeLoc, "value doesn't match function result type '" +
4904                    getTypeString(ResType) + "'");
4905
4906     Inst = ReturnInst::Create(Context);
4907     return false;
4908   }
4909
4910   Value *RV;
4911   if (ParseValue(Ty, RV, PFS)) return true;
4912
4913   if (ResType != RV->getType())
4914     return Error(TypeLoc, "value doesn't match function result type '" +
4915                  getTypeString(ResType) + "'");
4916
4917   Inst = ReturnInst::Create(Context, RV);
4918   return false;
4919 }
4920
4921
4922 /// ParseBr
4923 ///   ::= 'br' TypeAndValue
4924 ///   ::= 'br' TypeAndValue ',' TypeAndValue ',' TypeAndValue
4925 bool LLParser::ParseBr(Instruction *&Inst, PerFunctionState &PFS) {
4926   LocTy Loc, Loc2;
4927   Value *Op0;
4928   BasicBlock *Op1, *Op2;
4929   if (ParseTypeAndValue(Op0, Loc, PFS)) return true;
4930
4931   if (BasicBlock *BB = dyn_cast<BasicBlock>(Op0)) {
4932     Inst = BranchInst::Create(BB);
4933     return false;
4934   }
4935
4936   if (Op0->getType() != Type::getInt1Ty(Context))
4937     return Error(Loc, "branch condition must have 'i1' type");
4938
4939   if (ParseToken(lltok::comma, "expected ',' after branch condition") ||
4940       ParseTypeAndBasicBlock(Op1, Loc, PFS) ||
4941       ParseToken(lltok::comma, "expected ',' after true destination") ||
4942       ParseTypeAndBasicBlock(Op2, Loc2, PFS))
4943     return true;
4944
4945   Inst = BranchInst::Create(Op1, Op2, Op0);
4946   return false;
4947 }
4948
4949 /// ParseSwitch
4950 ///  Instruction
4951 ///    ::= 'switch' TypeAndValue ',' TypeAndValue '[' JumpTable ']'
4952 ///  JumpTable
4953 ///    ::= (TypeAndValue ',' TypeAndValue)*
4954 bool LLParser::ParseSwitch(Instruction *&Inst, PerFunctionState &PFS) {
4955   LocTy CondLoc, BBLoc;
4956   Value *Cond;
4957   BasicBlock *DefaultBB;
4958   if (ParseTypeAndValue(Cond, CondLoc, PFS) ||
4959       ParseToken(lltok::comma, "expected ',' after switch condition") ||
4960       ParseTypeAndBasicBlock(DefaultBB, BBLoc, PFS) ||
4961       ParseToken(lltok::lsquare, "expected '[' with switch table"))
4962     return true;
4963
4964   if (!Cond->getType()->isIntegerTy())
4965     return Error(CondLoc, "switch condition must have integer type");
4966
4967   // Parse the jump table pairs.
4968   SmallPtrSet<Value*, 32> SeenCases;
4969   SmallVector<std::pair<ConstantInt*, BasicBlock*>, 32> Table;
4970   while (Lex.getKind() != lltok::rsquare) {
4971     Value *Constant;
4972     BasicBlock *DestBB;
4973
4974     if (ParseTypeAndValue(Constant, CondLoc, PFS) ||
4975         ParseToken(lltok::comma, "expected ',' after case value") ||
4976         ParseTypeAndBasicBlock(DestBB, PFS))
4977       return true;
4978
4979     if (!SeenCases.insert(Constant).second)
4980       return Error(CondLoc, "duplicate case value in switch");
4981     if (!isa<ConstantInt>(Constant))
4982       return Error(CondLoc, "case value is not a constant integer");
4983
4984     Table.push_back(std::make_pair(cast<ConstantInt>(Constant), DestBB));
4985   }
4986
4987   Lex.Lex();  // Eat the ']'.
4988
4989   SwitchInst *SI = SwitchInst::Create(Cond, DefaultBB, Table.size());
4990   for (unsigned i = 0, e = Table.size(); i != e; ++i)
4991     SI->addCase(Table[i].first, Table[i].second);
4992   Inst = SI;
4993   return false;
4994 }
4995
4996 /// ParseIndirectBr
4997 ///  Instruction
4998 ///    ::= 'indirectbr' TypeAndValue ',' '[' LabelList ']'
4999 bool LLParser::ParseIndirectBr(Instruction *&Inst, PerFunctionState &PFS) {
5000   LocTy AddrLoc;
5001   Value *Address;
5002   if (ParseTypeAndValue(Address, AddrLoc, PFS) ||
5003       ParseToken(lltok::comma, "expected ',' after indirectbr address") ||
5004       ParseToken(lltok::lsquare, "expected '[' with indirectbr"))
5005     return true;
5006
5007   if (!Address->getType()->isPointerTy())
5008     return Error(AddrLoc, "indirectbr address must have pointer type");
5009
5010   // Parse the destination list.
5011   SmallVector<BasicBlock*, 16> DestList;
5012
5013   if (Lex.getKind() != lltok::rsquare) {
5014     BasicBlock *DestBB;
5015     if (ParseTypeAndBasicBlock(DestBB, PFS))
5016       return true;
5017     DestList.push_back(DestBB);
5018
5019     while (EatIfPresent(lltok::comma)) {
5020       if (ParseTypeAndBasicBlock(DestBB, PFS))
5021         return true;
5022       DestList.push_back(DestBB);
5023     }
5024   }
5025
5026   if (ParseToken(lltok::rsquare, "expected ']' at end of block list"))
5027     return true;
5028
5029   IndirectBrInst *IBI = IndirectBrInst::Create(Address, DestList.size());
5030   for (unsigned i = 0, e = DestList.size(); i != e; ++i)
5031     IBI->addDestination(DestList[i]);
5032   Inst = IBI;
5033   return false;
5034 }
5035
5036
5037 /// ParseInvoke
5038 ///   ::= 'invoke' OptionalCallingConv OptionalAttrs Type Value ParamList
5039 ///       OptionalAttrs 'to' TypeAndValue 'unwind' TypeAndValue
5040 bool LLParser::ParseInvoke(Instruction *&Inst, PerFunctionState &PFS) {
5041   LocTy CallLoc = Lex.getLoc();
5042   AttrBuilder RetAttrs, FnAttrs;
5043   std::vector<unsigned> FwdRefAttrGrps;
5044   LocTy NoBuiltinLoc;
5045   unsigned CC;
5046   Type *RetType = nullptr;
5047   LocTy RetTypeLoc;
5048   ValID CalleeID;
5049   SmallVector<ParamInfo, 16> ArgList;
5050   SmallVector<OperandBundleDef, 2> BundleList;
5051
5052   BasicBlock *NormalBB, *UnwindBB;
5053   if (ParseOptionalCallingConv(CC) || ParseOptionalReturnAttrs(RetAttrs) ||
5054       ParseType(RetType, RetTypeLoc, true /*void allowed*/) ||
5055       ParseValID(CalleeID) || ParseParameterList(ArgList, PFS) ||
5056       ParseFnAttributeValuePairs(FnAttrs, FwdRefAttrGrps, false,
5057                                  NoBuiltinLoc) ||
5058       ParseOptionalOperandBundles(BundleList, PFS) ||
5059       ParseToken(lltok::kw_to, "expected 'to' in invoke") ||
5060       ParseTypeAndBasicBlock(NormalBB, PFS) ||
5061       ParseToken(lltok::kw_unwind, "expected 'unwind' in invoke") ||
5062       ParseTypeAndBasicBlock(UnwindBB, PFS))
5063     return true;
5064
5065   // If RetType is a non-function pointer type, then this is the short syntax
5066   // for the call, which means that RetType is just the return type.  Infer the
5067   // rest of the function argument types from the arguments that are present.
5068   FunctionType *Ty = dyn_cast<FunctionType>(RetType);
5069   if (!Ty) {
5070     // Pull out the types of all of the arguments...
5071     std::vector<Type*> ParamTypes;
5072     for (unsigned i = 0, e = ArgList.size(); i != e; ++i)
5073       ParamTypes.push_back(ArgList[i].V->getType());
5074
5075     if (!FunctionType::isValidReturnType(RetType))
5076       return Error(RetTypeLoc, "Invalid result type for LLVM function");
5077
5078     Ty = FunctionType::get(RetType, ParamTypes, false);
5079   }
5080
5081   CalleeID.FTy = Ty;
5082
5083   // Look up the callee.
5084   Value *Callee;
5085   if (ConvertValIDToValue(PointerType::getUnqual(Ty), CalleeID, Callee, &PFS))
5086     return true;
5087
5088   // Set up the Attribute for the function.
5089   SmallVector<AttributeSet, 8> Attrs;
5090   if (RetAttrs.hasAttributes())
5091     Attrs.push_back(AttributeSet::get(RetType->getContext(),
5092                                       AttributeSet::ReturnIndex,
5093                                       RetAttrs));
5094
5095   SmallVector<Value*, 8> Args;
5096
5097   // Loop through FunctionType's arguments and ensure they are specified
5098   // correctly.  Also, gather any parameter attributes.
5099   FunctionType::param_iterator I = Ty->param_begin();
5100   FunctionType::param_iterator E = Ty->param_end();
5101   for (unsigned i = 0, e = ArgList.size(); i != e; ++i) {
5102     Type *ExpectedTy = nullptr;
5103     if (I != E) {
5104       ExpectedTy = *I++;
5105     } else if (!Ty->isVarArg()) {
5106       return Error(ArgList[i].Loc, "too many arguments specified");
5107     }
5108
5109     if (ExpectedTy && ExpectedTy != ArgList[i].V->getType())
5110       return Error(ArgList[i].Loc, "argument is not of expected type '" +
5111                    getTypeString(ExpectedTy) + "'");
5112     Args.push_back(ArgList[i].V);
5113     if (ArgList[i].Attrs.hasAttributes(i + 1)) {
5114       AttrBuilder B(ArgList[i].Attrs, i + 1);
5115       Attrs.push_back(AttributeSet::get(RetType->getContext(), i + 1, B));
5116     }
5117   }
5118
5119   if (I != E)
5120     return Error(CallLoc, "not enough parameters specified for call");
5121
5122   if (FnAttrs.hasAttributes()) {
5123     if (FnAttrs.hasAlignmentAttr())
5124       return Error(CallLoc, "invoke instructions may not have an alignment");
5125
5126     Attrs.push_back(AttributeSet::get(RetType->getContext(),
5127                                       AttributeSet::FunctionIndex,
5128                                       FnAttrs));
5129   }
5130
5131   // Finish off the Attribute and check them
5132   AttributeSet PAL = AttributeSet::get(Context, Attrs);
5133
5134   InvokeInst *II =
5135       InvokeInst::Create(Ty, Callee, NormalBB, UnwindBB, Args, BundleList);
5136   II->setCallingConv(CC);
5137   II->setAttributes(PAL);
5138   ForwardRefAttrGroups[II] = FwdRefAttrGrps;
5139   Inst = II;
5140   return false;
5141 }
5142
5143 /// ParseResume
5144 ///   ::= 'resume' TypeAndValue
5145 bool LLParser::ParseResume(Instruction *&Inst, PerFunctionState &PFS) {
5146   Value *Exn; LocTy ExnLoc;
5147   if (ParseTypeAndValue(Exn, ExnLoc, PFS))
5148     return true;
5149
5150   ResumeInst *RI = ResumeInst::Create(Exn);
5151   Inst = RI;
5152   return false;
5153 }
5154
5155 bool LLParser::ParseExceptionArgs(SmallVectorImpl<Value *> &Args,
5156                                   PerFunctionState &PFS) {
5157   if (ParseToken(lltok::lsquare, "expected '[' in catchpad/cleanuppad"))
5158     return true;
5159
5160   while (Lex.getKind() != lltok::rsquare) {
5161     // If this isn't the first argument, we need a comma.
5162     if (!Args.empty() &&
5163         ParseToken(lltok::comma, "expected ',' in argument list"))
5164       return true;
5165
5166     // Parse the argument.
5167     LocTy ArgLoc;
5168     Type *ArgTy = nullptr;
5169     if (ParseType(ArgTy, ArgLoc))
5170       return true;
5171
5172     Value *V;
5173     if (ArgTy->isMetadataTy()) {
5174       if (ParseMetadataAsValue(V, PFS))
5175         return true;
5176     } else {
5177       if (ParseValue(ArgTy, V, PFS))
5178         return true;
5179     }
5180     Args.push_back(V);
5181   }
5182
5183   Lex.Lex();  // Lex the ']'.
5184   return false;
5185 }
5186
5187 /// ParseCleanupRet
5188 ///   ::= 'cleanupret' Value unwind ('to' 'caller' | TypeAndValue)
5189 bool LLParser::ParseCleanupRet(Instruction *&Inst, PerFunctionState &PFS) {
5190   Value *CleanupPad = nullptr;
5191
5192   if (ParseValue(Type::getTokenTy(Context), CleanupPad, PFS, OC_CleanupPad))
5193     return true;
5194
5195   if (ParseToken(lltok::kw_unwind, "expected 'unwind' in cleanupret"))
5196     return true;
5197
5198   BasicBlock *UnwindBB = nullptr;
5199   if (Lex.getKind() == lltok::kw_to) {
5200     Lex.Lex();
5201     if (ParseToken(lltok::kw_caller, "expected 'caller' in cleanupret"))
5202       return true;
5203   } else {
5204     if (ParseTypeAndBasicBlock(UnwindBB, PFS)) {
5205       return true;
5206     }
5207   }
5208
5209   Inst = CleanupReturnInst::Create(cast<CleanupPadInst>(CleanupPad), UnwindBB);
5210   return false;
5211 }
5212
5213 /// ParseCatchRet
5214 ///   ::= 'catchret' Value 'to' TypeAndValue
5215 bool LLParser::ParseCatchRet(Instruction *&Inst, PerFunctionState &PFS) {
5216   Value *CatchPad = nullptr;
5217
5218   if (ParseValue(Type::getTokenTy(Context), CatchPad, PFS, OC_CatchPad))
5219     return true;
5220
5221   BasicBlock *BB;
5222   if (ParseToken(lltok::kw_to, "expected 'to' in catchret") ||
5223       ParseTypeAndBasicBlock(BB, PFS))
5224       return true;
5225
5226   Inst = CatchReturnInst::Create(cast<CatchPadInst>(CatchPad), BB);
5227   return false;
5228 }
5229
5230 /// ParseCatchPad
5231 ///   ::= 'catchpad' ParamList 'to' TypeAndValue 'unwind' TypeAndValue
5232 bool LLParser::ParseCatchPad(Instruction *&Inst, PerFunctionState &PFS) {
5233   SmallVector<Value *, 8> Args;
5234   if (ParseExceptionArgs(Args, PFS))
5235     return true;
5236
5237   BasicBlock *NormalBB, *UnwindBB;
5238   if (ParseToken(lltok::kw_to, "expected 'to' in catchpad") ||
5239       ParseTypeAndBasicBlock(NormalBB, PFS) ||
5240       ParseToken(lltok::kw_unwind, "expected 'unwind' in catchpad") ||
5241       ParseTypeAndBasicBlock(UnwindBB, PFS))
5242     return true;
5243
5244   Inst = CatchPadInst::Create(NormalBB, UnwindBB, Args);
5245   return false;
5246 }
5247
5248 /// ParseTerminatePad
5249 ///   ::= 'terminatepad' ParamList 'to' TypeAndValue
5250 bool LLParser::ParseTerminatePad(Instruction *&Inst, PerFunctionState &PFS) {
5251   SmallVector<Value *, 8> Args;
5252   if (ParseExceptionArgs(Args, PFS))
5253     return true;
5254
5255   if (ParseToken(lltok::kw_unwind, "expected 'unwind' in terminatepad"))
5256     return true;
5257
5258   BasicBlock *UnwindBB = nullptr;
5259   if (Lex.getKind() == lltok::kw_to) {
5260     Lex.Lex();
5261     if (ParseToken(lltok::kw_caller, "expected 'caller' in terminatepad"))
5262       return true;
5263   } else {
5264     if (ParseTypeAndBasicBlock(UnwindBB, PFS)) {
5265       return true;
5266     }
5267   }
5268
5269   Inst = TerminatePadInst::Create(Context, UnwindBB, Args);
5270   return false;
5271 }
5272
5273 /// ParseCleanupPad
5274 ///   ::= 'cleanuppad' ParamList
5275 bool LLParser::ParseCleanupPad(Instruction *&Inst, PerFunctionState &PFS) {
5276   SmallVector<Value *, 8> Args;
5277   if (ParseExceptionArgs(Args, PFS))
5278     return true;
5279
5280   Inst = CleanupPadInst::Create(Context, Args);
5281   return false;
5282 }
5283
5284 /// ParseCatchEndPad
5285 ///   ::= 'catchendpad' unwind ('to' 'caller' | TypeAndValue)
5286 bool LLParser::ParseCatchEndPad(Instruction *&Inst, PerFunctionState &PFS) {
5287   if (ParseToken(lltok::kw_unwind, "expected 'unwind' in catchendpad"))
5288     return true;
5289
5290   BasicBlock *UnwindBB = nullptr;
5291   if (Lex.getKind() == lltok::kw_to) {
5292     Lex.Lex();
5293     if (Lex.getKind() == lltok::kw_caller) {
5294       Lex.Lex();
5295     } else {
5296       return true;
5297     }
5298   } else {
5299     if (ParseTypeAndBasicBlock(UnwindBB, PFS)) {
5300       return true;
5301     }
5302   }
5303
5304   Inst = CatchEndPadInst::Create(Context, UnwindBB);
5305   return false;
5306 }
5307
5308 /// ParseCatchEndPad
5309 ///   ::= 'cleanupendpad' Value unwind ('to' 'caller' | TypeAndValue)
5310 bool LLParser::ParseCleanupEndPad(Instruction *&Inst, PerFunctionState &PFS) {
5311   Value *CleanupPad = nullptr;
5312
5313   if (ParseValue(Type::getTokenTy(Context), CleanupPad, PFS, OC_CleanupPad))
5314     return true;
5315
5316   if (ParseToken(lltok::kw_unwind, "expected 'unwind' in catchendpad"))
5317     return true;
5318
5319   BasicBlock *UnwindBB = nullptr;
5320   if (Lex.getKind() == lltok::kw_to) {
5321     Lex.Lex();
5322     if (Lex.getKind() == lltok::kw_caller) {
5323       Lex.Lex();
5324     } else {
5325       return true;
5326     }
5327   } else {
5328     if (ParseTypeAndBasicBlock(UnwindBB, PFS)) {
5329       return true;
5330     }
5331   }
5332
5333   Inst = CleanupEndPadInst::Create(cast<CleanupPadInst>(CleanupPad), UnwindBB);
5334   return false;
5335 }
5336
5337 //===----------------------------------------------------------------------===//
5338 // Binary Operators.
5339 //===----------------------------------------------------------------------===//
5340
5341 /// ParseArithmetic
5342 ///  ::= ArithmeticOps TypeAndValue ',' Value
5343 ///
5344 /// If OperandType is 0, then any FP or integer operand is allowed.  If it is 1,
5345 /// then any integer operand is allowed, if it is 2, any fp operand is allowed.
5346 bool LLParser::ParseArithmetic(Instruction *&Inst, PerFunctionState &PFS,
5347                                unsigned Opc, unsigned OperandType) {
5348   LocTy Loc; Value *LHS, *RHS;
5349   if (ParseTypeAndValue(LHS, Loc, PFS) ||
5350       ParseToken(lltok::comma, "expected ',' in arithmetic operation") ||
5351       ParseValue(LHS->getType(), RHS, PFS))
5352     return true;
5353
5354   bool Valid;
5355   switch (OperandType) {
5356   default: llvm_unreachable("Unknown operand type!");
5357   case 0: // int or FP.
5358     Valid = LHS->getType()->isIntOrIntVectorTy() ||
5359             LHS->getType()->isFPOrFPVectorTy();
5360     break;
5361   case 1: Valid = LHS->getType()->isIntOrIntVectorTy(); break;
5362   case 2: Valid = LHS->getType()->isFPOrFPVectorTy(); break;
5363   }
5364
5365   if (!Valid)
5366     return Error(Loc, "invalid operand type for instruction");
5367
5368   Inst = BinaryOperator::Create((Instruction::BinaryOps)Opc, LHS, RHS);
5369   return false;
5370 }
5371
5372 /// ParseLogical
5373 ///  ::= ArithmeticOps TypeAndValue ',' Value {
5374 bool LLParser::ParseLogical(Instruction *&Inst, PerFunctionState &PFS,
5375                             unsigned Opc) {
5376   LocTy Loc; Value *LHS, *RHS;
5377   if (ParseTypeAndValue(LHS, Loc, PFS) ||
5378       ParseToken(lltok::comma, "expected ',' in logical operation") ||
5379       ParseValue(LHS->getType(), RHS, PFS))
5380     return true;
5381
5382   if (!LHS->getType()->isIntOrIntVectorTy())
5383     return Error(Loc,"instruction requires integer or integer vector operands");
5384
5385   Inst = BinaryOperator::Create((Instruction::BinaryOps)Opc, LHS, RHS);
5386   return false;
5387 }
5388
5389
5390 /// ParseCompare
5391 ///  ::= 'icmp' IPredicates TypeAndValue ',' Value
5392 ///  ::= 'fcmp' FPredicates TypeAndValue ',' Value
5393 bool LLParser::ParseCompare(Instruction *&Inst, PerFunctionState &PFS,
5394                             unsigned Opc) {
5395   // Parse the integer/fp comparison predicate.
5396   LocTy Loc;
5397   unsigned Pred;
5398   Value *LHS, *RHS;
5399   if (ParseCmpPredicate(Pred, Opc) ||
5400       ParseTypeAndValue(LHS, Loc, PFS) ||
5401       ParseToken(lltok::comma, "expected ',' after compare value") ||
5402       ParseValue(LHS->getType(), RHS, PFS))
5403     return true;
5404
5405   if (Opc == Instruction::FCmp) {
5406     if (!LHS->getType()->isFPOrFPVectorTy())
5407       return Error(Loc, "fcmp requires floating point operands");
5408     Inst = new FCmpInst(CmpInst::Predicate(Pred), LHS, RHS);
5409   } else {
5410     assert(Opc == Instruction::ICmp && "Unknown opcode for CmpInst!");
5411     if (!LHS->getType()->isIntOrIntVectorTy() &&
5412         !LHS->getType()->getScalarType()->isPointerTy())
5413       return Error(Loc, "icmp requires integer operands");
5414     Inst = new ICmpInst(CmpInst::Predicate(Pred), LHS, RHS);
5415   }
5416   return false;
5417 }
5418
5419 //===----------------------------------------------------------------------===//
5420 // Other Instructions.
5421 //===----------------------------------------------------------------------===//
5422
5423
5424 /// ParseCast
5425 ///   ::= CastOpc TypeAndValue 'to' Type
5426 bool LLParser::ParseCast(Instruction *&Inst, PerFunctionState &PFS,
5427                          unsigned Opc) {
5428   LocTy Loc;
5429   Value *Op;
5430   Type *DestTy = nullptr;
5431   if (ParseTypeAndValue(Op, Loc, PFS) ||
5432       ParseToken(lltok::kw_to, "expected 'to' after cast value") ||
5433       ParseType(DestTy))
5434     return true;
5435
5436   if (!CastInst::castIsValid((Instruction::CastOps)Opc, Op, DestTy)) {
5437     CastInst::castIsValid((Instruction::CastOps)Opc, Op, DestTy);
5438     return Error(Loc, "invalid cast opcode for cast from '" +
5439                  getTypeString(Op->getType()) + "' to '" +
5440                  getTypeString(DestTy) + "'");
5441   }
5442   Inst = CastInst::Create((Instruction::CastOps)Opc, Op, DestTy);
5443   return false;
5444 }
5445
5446 /// ParseSelect
5447 ///   ::= 'select' TypeAndValue ',' TypeAndValue ',' TypeAndValue
5448 bool LLParser::ParseSelect(Instruction *&Inst, PerFunctionState &PFS) {
5449   LocTy Loc;
5450   Value *Op0, *Op1, *Op2;
5451   if (ParseTypeAndValue(Op0, Loc, PFS) ||
5452       ParseToken(lltok::comma, "expected ',' after select condition") ||
5453       ParseTypeAndValue(Op1, PFS) ||
5454       ParseToken(lltok::comma, "expected ',' after select value") ||
5455       ParseTypeAndValue(Op2, PFS))
5456     return true;
5457
5458   if (const char *Reason = SelectInst::areInvalidOperands(Op0, Op1, Op2))
5459     return Error(Loc, Reason);
5460
5461   Inst = SelectInst::Create(Op0, Op1, Op2);
5462   return false;
5463 }
5464
5465 /// ParseVA_Arg
5466 ///   ::= 'va_arg' TypeAndValue ',' Type
5467 bool LLParser::ParseVA_Arg(Instruction *&Inst, PerFunctionState &PFS) {
5468   Value *Op;
5469   Type *EltTy = nullptr;
5470   LocTy TypeLoc;
5471   if (ParseTypeAndValue(Op, PFS) ||
5472       ParseToken(lltok::comma, "expected ',' after vaarg operand") ||
5473       ParseType(EltTy, TypeLoc))
5474     return true;
5475
5476   if (!EltTy->isFirstClassType())
5477     return Error(TypeLoc, "va_arg requires operand with first class type");
5478
5479   Inst = new VAArgInst(Op, EltTy);
5480   return false;
5481 }
5482
5483 /// ParseExtractElement
5484 ///   ::= 'extractelement' TypeAndValue ',' TypeAndValue
5485 bool LLParser::ParseExtractElement(Instruction *&Inst, PerFunctionState &PFS) {
5486   LocTy Loc;
5487   Value *Op0, *Op1;
5488   if (ParseTypeAndValue(Op0, Loc, PFS) ||
5489       ParseToken(lltok::comma, "expected ',' after extract value") ||
5490       ParseTypeAndValue(Op1, PFS))
5491     return true;
5492
5493   if (!ExtractElementInst::isValidOperands(Op0, Op1))
5494     return Error(Loc, "invalid extractelement operands");
5495
5496   Inst = ExtractElementInst::Create(Op0, Op1);
5497   return false;
5498 }
5499
5500 /// ParseInsertElement
5501 ///   ::= 'insertelement' TypeAndValue ',' TypeAndValue ',' TypeAndValue
5502 bool LLParser::ParseInsertElement(Instruction *&Inst, PerFunctionState &PFS) {
5503   LocTy Loc;
5504   Value *Op0, *Op1, *Op2;
5505   if (ParseTypeAndValue(Op0, Loc, PFS) ||
5506       ParseToken(lltok::comma, "expected ',' after insertelement value") ||
5507       ParseTypeAndValue(Op1, PFS) ||
5508       ParseToken(lltok::comma, "expected ',' after insertelement value") ||
5509       ParseTypeAndValue(Op2, PFS))
5510     return true;
5511
5512   if (!InsertElementInst::isValidOperands(Op0, Op1, Op2))
5513     return Error(Loc, "invalid insertelement operands");
5514
5515   Inst = InsertElementInst::Create(Op0, Op1, Op2);
5516   return false;
5517 }
5518
5519 /// ParseShuffleVector
5520 ///   ::= 'shufflevector' TypeAndValue ',' TypeAndValue ',' TypeAndValue
5521 bool LLParser::ParseShuffleVector(Instruction *&Inst, PerFunctionState &PFS) {
5522   LocTy Loc;
5523   Value *Op0, *Op1, *Op2;
5524   if (ParseTypeAndValue(Op0, Loc, PFS) ||
5525       ParseToken(lltok::comma, "expected ',' after shuffle mask") ||
5526       ParseTypeAndValue(Op1, PFS) ||
5527       ParseToken(lltok::comma, "expected ',' after shuffle value") ||
5528       ParseTypeAndValue(Op2, PFS))
5529     return true;
5530
5531   if (!ShuffleVectorInst::isValidOperands(Op0, Op1, Op2))
5532     return Error(Loc, "invalid shufflevector operands");
5533
5534   Inst = new ShuffleVectorInst(Op0, Op1, Op2);
5535   return false;
5536 }
5537
5538 /// ParsePHI
5539 ///   ::= 'phi' Type '[' Value ',' Value ']' (',' '[' Value ',' Value ']')*
5540 int LLParser::ParsePHI(Instruction *&Inst, PerFunctionState &PFS) {
5541   Type *Ty = nullptr;  LocTy TypeLoc;
5542   Value *Op0, *Op1;
5543
5544   if (ParseType(Ty, TypeLoc) ||
5545       ParseToken(lltok::lsquare, "expected '[' in phi value list") ||
5546       ParseValue(Ty, Op0, PFS) ||
5547       ParseToken(lltok::comma, "expected ',' after insertelement value") ||
5548       ParseValue(Type::getLabelTy(Context), Op1, PFS) ||
5549       ParseToken(lltok::rsquare, "expected ']' in phi value list"))
5550     return true;
5551
5552   bool AteExtraComma = false;
5553   SmallVector<std::pair<Value*, BasicBlock*>, 16> PHIVals;
5554   while (1) {
5555     PHIVals.push_back(std::make_pair(Op0, cast<BasicBlock>(Op1)));
5556
5557     if (!EatIfPresent(lltok::comma))
5558       break;
5559
5560     if (Lex.getKind() == lltok::MetadataVar) {
5561       AteExtraComma = true;
5562       break;
5563     }
5564
5565     if (ParseToken(lltok::lsquare, "expected '[' in phi value list") ||
5566         ParseValue(Ty, Op0, PFS) ||
5567         ParseToken(lltok::comma, "expected ',' after insertelement value") ||
5568         ParseValue(Type::getLabelTy(Context), Op1, PFS) ||
5569         ParseToken(lltok::rsquare, "expected ']' in phi value list"))
5570       return true;
5571   }
5572
5573   if (!Ty->isFirstClassType())
5574     return Error(TypeLoc, "phi node must have first class type");
5575
5576   PHINode *PN = PHINode::Create(Ty, PHIVals.size());
5577   for (unsigned i = 0, e = PHIVals.size(); i != e; ++i)
5578     PN->addIncoming(PHIVals[i].first, PHIVals[i].second);
5579   Inst = PN;
5580   return AteExtraComma ? InstExtraComma : InstNormal;
5581 }
5582
5583 /// ParseLandingPad
5584 ///   ::= 'landingpad' Type 'personality' TypeAndValue 'cleanup'? Clause+
5585 /// Clause
5586 ///   ::= 'catch' TypeAndValue
5587 ///   ::= 'filter'
5588 ///   ::= 'filter' TypeAndValue ( ',' TypeAndValue )*
5589 bool LLParser::ParseLandingPad(Instruction *&Inst, PerFunctionState &PFS) {
5590   Type *Ty = nullptr; LocTy TyLoc;
5591
5592   if (ParseType(Ty, TyLoc))
5593     return true;
5594
5595   std::unique_ptr<LandingPadInst> LP(LandingPadInst::Create(Ty, 0));
5596   LP->setCleanup(EatIfPresent(lltok::kw_cleanup));
5597
5598   while (Lex.getKind() == lltok::kw_catch || Lex.getKind() == lltok::kw_filter){
5599     LandingPadInst::ClauseType CT;
5600     if (EatIfPresent(lltok::kw_catch))
5601       CT = LandingPadInst::Catch;
5602     else if (EatIfPresent(lltok::kw_filter))
5603       CT = LandingPadInst::Filter;
5604     else
5605       return TokError("expected 'catch' or 'filter' clause type");
5606
5607     Value *V;
5608     LocTy VLoc;
5609     if (ParseTypeAndValue(V, VLoc, PFS))
5610       return true;
5611
5612     // A 'catch' type expects a non-array constant. A filter clause expects an
5613     // array constant.
5614     if (CT == LandingPadInst::Catch) {
5615       if (isa<ArrayType>(V->getType()))
5616         Error(VLoc, "'catch' clause has an invalid type");
5617     } else {
5618       if (!isa<ArrayType>(V->getType()))
5619         Error(VLoc, "'filter' clause has an invalid type");
5620     }
5621
5622     Constant *CV = dyn_cast<Constant>(V);
5623     if (!CV)
5624       return Error(VLoc, "clause argument must be a constant");
5625     LP->addClause(CV);
5626   }
5627
5628   Inst = LP.release();
5629   return false;
5630 }
5631
5632 /// ParseCall
5633 ///   ::= 'call' OptionalCallingConv OptionalAttrs Type Value
5634 ///       ParameterList OptionalAttrs
5635 ///   ::= 'tail' 'call' OptionalCallingConv OptionalAttrs Type Value
5636 ///       ParameterList OptionalAttrs
5637 ///   ::= 'musttail' 'call' OptionalCallingConv OptionalAttrs Type Value
5638 ///       ParameterList OptionalAttrs
5639 bool LLParser::ParseCall(Instruction *&Inst, PerFunctionState &PFS,
5640                          CallInst::TailCallKind TCK) {
5641   AttrBuilder RetAttrs, FnAttrs;
5642   std::vector<unsigned> FwdRefAttrGrps;
5643   LocTy BuiltinLoc;
5644   unsigned CC;
5645   Type *RetType = nullptr;
5646   LocTy RetTypeLoc;
5647   ValID CalleeID;
5648   SmallVector<ParamInfo, 16> ArgList;
5649   SmallVector<OperandBundleDef, 2> BundleList;
5650   LocTy CallLoc = Lex.getLoc();
5651
5652   if ((TCK != CallInst::TCK_None &&
5653        ParseToken(lltok::kw_call, "expected 'tail call'")) ||
5654       ParseOptionalCallingConv(CC) || ParseOptionalReturnAttrs(RetAttrs) ||
5655       ParseType(RetType, RetTypeLoc, true /*void allowed*/) ||
5656       ParseValID(CalleeID) ||
5657       ParseParameterList(ArgList, PFS, TCK == CallInst::TCK_MustTail,
5658                          PFS.getFunction().isVarArg()) ||
5659       ParseFnAttributeValuePairs(FnAttrs, FwdRefAttrGrps, false, BuiltinLoc) ||
5660       ParseOptionalOperandBundles(BundleList, PFS))
5661     return true;
5662
5663   // If RetType is a non-function pointer type, then this is the short syntax
5664   // for the call, which means that RetType is just the return type.  Infer the
5665   // rest of the function argument types from the arguments that are present.
5666   FunctionType *Ty = dyn_cast<FunctionType>(RetType);
5667   if (!Ty) {
5668     // Pull out the types of all of the arguments...
5669     std::vector<Type*> ParamTypes;
5670     for (unsigned i = 0, e = ArgList.size(); i != e; ++i)
5671       ParamTypes.push_back(ArgList[i].V->getType());
5672
5673     if (!FunctionType::isValidReturnType(RetType))
5674       return Error(RetTypeLoc, "Invalid result type for LLVM function");
5675
5676     Ty = FunctionType::get(RetType, ParamTypes, false);
5677   }
5678
5679   CalleeID.FTy = Ty;
5680
5681   // Look up the callee.
5682   Value *Callee;
5683   if (ConvertValIDToValue(PointerType::getUnqual(Ty), CalleeID, Callee, &PFS))
5684     return true;
5685
5686   // Set up the Attribute for the function.
5687   SmallVector<AttributeSet, 8> Attrs;
5688   if (RetAttrs.hasAttributes())
5689     Attrs.push_back(AttributeSet::get(RetType->getContext(),
5690                                       AttributeSet::ReturnIndex,
5691                                       RetAttrs));
5692
5693   SmallVector<Value*, 8> Args;
5694
5695   // Loop through FunctionType's arguments and ensure they are specified
5696   // correctly.  Also, gather any parameter attributes.
5697   FunctionType::param_iterator I = Ty->param_begin();
5698   FunctionType::param_iterator E = Ty->param_end();
5699   for (unsigned i = 0, e = ArgList.size(); i != e; ++i) {
5700     Type *ExpectedTy = nullptr;
5701     if (I != E) {
5702       ExpectedTy = *I++;
5703     } else if (!Ty->isVarArg()) {
5704       return Error(ArgList[i].Loc, "too many arguments specified");
5705     }
5706
5707     if (ExpectedTy && ExpectedTy != ArgList[i].V->getType())
5708       return Error(ArgList[i].Loc, "argument is not of expected type '" +
5709                    getTypeString(ExpectedTy) + "'");
5710     Args.push_back(ArgList[i].V);
5711     if (ArgList[i].Attrs.hasAttributes(i + 1)) {
5712       AttrBuilder B(ArgList[i].Attrs, i + 1);
5713       Attrs.push_back(AttributeSet::get(RetType->getContext(), i + 1, B));
5714     }
5715   }
5716
5717   if (I != E)
5718     return Error(CallLoc, "not enough parameters specified for call");
5719
5720   if (FnAttrs.hasAttributes()) {
5721     if (FnAttrs.hasAlignmentAttr())
5722       return Error(CallLoc, "call instructions may not have an alignment");
5723
5724     Attrs.push_back(AttributeSet::get(RetType->getContext(),
5725                                       AttributeSet::FunctionIndex,
5726                                       FnAttrs));
5727   }
5728
5729   // Finish off the Attribute and check them
5730   AttributeSet PAL = AttributeSet::get(Context, Attrs);
5731
5732   CallInst *CI = CallInst::Create(Ty, Callee, Args, BundleList);
5733   CI->setTailCallKind(TCK);
5734   CI->setCallingConv(CC);
5735   CI->setAttributes(PAL);
5736   ForwardRefAttrGroups[CI] = FwdRefAttrGrps;
5737   Inst = CI;
5738   return false;
5739 }
5740
5741 //===----------------------------------------------------------------------===//
5742 // Memory Instructions.
5743 //===----------------------------------------------------------------------===//
5744
5745 /// ParseAlloc
5746 ///   ::= 'alloca' 'inalloca'? Type (',' TypeAndValue)? (',' 'align' i32)?
5747 int LLParser::ParseAlloc(Instruction *&Inst, PerFunctionState &PFS) {
5748   Value *Size = nullptr;
5749   LocTy SizeLoc, TyLoc;
5750   unsigned Alignment = 0;
5751   Type *Ty = nullptr;
5752
5753   bool IsInAlloca = EatIfPresent(lltok::kw_inalloca);
5754
5755   if (ParseType(Ty, TyLoc)) return true;
5756
5757   if (Ty->isFunctionTy() || !PointerType::isValidElementType(Ty))
5758     return Error(TyLoc, "invalid type for alloca");
5759
5760   bool AteExtraComma = false;
5761   if (EatIfPresent(lltok::comma)) {
5762     if (Lex.getKind() == lltok::kw_align) {
5763       if (ParseOptionalAlignment(Alignment)) return true;
5764     } else if (Lex.getKind() == lltok::MetadataVar) {
5765       AteExtraComma = true;
5766     } else {
5767       if (ParseTypeAndValue(Size, SizeLoc, PFS) ||
5768           ParseOptionalCommaAlign(Alignment, AteExtraComma))
5769         return true;
5770     }
5771   }
5772
5773   if (Size && !Size->getType()->isIntegerTy())
5774     return Error(SizeLoc, "element count must have integer type");
5775
5776   AllocaInst *AI = new AllocaInst(Ty, Size, Alignment);
5777   AI->setUsedWithInAlloca(IsInAlloca);
5778   Inst = AI;
5779   return AteExtraComma ? InstExtraComma : InstNormal;
5780 }
5781
5782 /// ParseLoad
5783 ///   ::= 'load' 'volatile'? TypeAndValue (',' 'align' i32)?
5784 ///   ::= 'load' 'atomic' 'volatile'? TypeAndValue
5785 ///       'singlethread'? AtomicOrdering (',' 'align' i32)?
5786 int LLParser::ParseLoad(Instruction *&Inst, PerFunctionState &PFS) {
5787   Value *Val; LocTy Loc;
5788   unsigned Alignment = 0;
5789   bool AteExtraComma = false;
5790   bool isAtomic = false;
5791   AtomicOrdering Ordering = NotAtomic;
5792   SynchronizationScope Scope = CrossThread;
5793
5794   if (Lex.getKind() == lltok::kw_atomic) {
5795     isAtomic = true;
5796     Lex.Lex();
5797   }
5798
5799   bool isVolatile = false;
5800   if (Lex.getKind() == lltok::kw_volatile) {
5801     isVolatile = true;
5802     Lex.Lex();
5803   }
5804
5805   Type *Ty;
5806   LocTy ExplicitTypeLoc = Lex.getLoc();
5807   if (ParseType(Ty) ||
5808       ParseToken(lltok::comma, "expected comma after load's type") ||
5809       ParseTypeAndValue(Val, Loc, PFS) ||
5810       ParseScopeAndOrdering(isAtomic, Scope, Ordering) ||
5811       ParseOptionalCommaAlign(Alignment, AteExtraComma))
5812     return true;
5813
5814   if (!Val->getType()->isPointerTy() || !Ty->isFirstClassType())
5815     return Error(Loc, "load operand must be a pointer to a first class type");
5816   if (isAtomic && !Alignment)
5817     return Error(Loc, "atomic load must have explicit non-zero alignment");
5818   if (Ordering == Release || Ordering == AcquireRelease)
5819     return Error(Loc, "atomic load cannot use Release ordering");
5820
5821   if (Ty != cast<PointerType>(Val->getType())->getElementType())
5822     return Error(ExplicitTypeLoc,
5823                  "explicit pointee type doesn't match operand's pointee type");
5824
5825   Inst = new LoadInst(Ty, Val, "", isVolatile, Alignment, Ordering, Scope);
5826   return AteExtraComma ? InstExtraComma : InstNormal;
5827 }
5828
5829 /// ParseStore
5830
5831 ///   ::= 'store' 'volatile'? TypeAndValue ',' TypeAndValue (',' 'align' i32)?
5832 ///   ::= 'store' 'atomic' 'volatile'? TypeAndValue ',' TypeAndValue
5833 ///       'singlethread'? AtomicOrdering (',' 'align' i32)?
5834 int LLParser::ParseStore(Instruction *&Inst, PerFunctionState &PFS) {
5835   Value *Val, *Ptr; LocTy Loc, PtrLoc;
5836   unsigned Alignment = 0;
5837   bool AteExtraComma = false;
5838   bool isAtomic = false;
5839   AtomicOrdering Ordering = NotAtomic;
5840   SynchronizationScope Scope = CrossThread;
5841
5842   if (Lex.getKind() == lltok::kw_atomic) {
5843     isAtomic = true;
5844     Lex.Lex();
5845   }
5846
5847   bool isVolatile = false;
5848   if (Lex.getKind() == lltok::kw_volatile) {
5849     isVolatile = true;
5850     Lex.Lex();
5851   }
5852
5853   if (ParseTypeAndValue(Val, Loc, PFS) ||
5854       ParseToken(lltok::comma, "expected ',' after store operand") ||
5855       ParseTypeAndValue(Ptr, PtrLoc, PFS) ||
5856       ParseScopeAndOrdering(isAtomic, Scope, Ordering) ||
5857       ParseOptionalCommaAlign(Alignment, AteExtraComma))
5858     return true;
5859
5860   if (!Ptr->getType()->isPointerTy())
5861     return Error(PtrLoc, "store operand must be a pointer");
5862   if (!Val->getType()->isFirstClassType())
5863     return Error(Loc, "store operand must be a first class value");
5864   if (cast<PointerType>(Ptr->getType())->getElementType() != Val->getType())
5865     return Error(Loc, "stored value and pointer type do not match");
5866   if (isAtomic && !Alignment)
5867     return Error(Loc, "atomic store must have explicit non-zero alignment");
5868   if (Ordering == Acquire || Ordering == AcquireRelease)
5869     return Error(Loc, "atomic store cannot use Acquire ordering");
5870
5871   Inst = new StoreInst(Val, Ptr, isVolatile, Alignment, Ordering, Scope);
5872   return AteExtraComma ? InstExtraComma : InstNormal;
5873 }
5874
5875 /// ParseCmpXchg
5876 ///   ::= 'cmpxchg' 'weak'? 'volatile'? TypeAndValue ',' TypeAndValue ','
5877 ///       TypeAndValue 'singlethread'? AtomicOrdering AtomicOrdering
5878 int LLParser::ParseCmpXchg(Instruction *&Inst, PerFunctionState &PFS) {
5879   Value *Ptr, *Cmp, *New; LocTy PtrLoc, CmpLoc, NewLoc;
5880   bool AteExtraComma = false;
5881   AtomicOrdering SuccessOrdering = NotAtomic;
5882   AtomicOrdering FailureOrdering = NotAtomic;
5883   SynchronizationScope Scope = CrossThread;
5884   bool isVolatile = false;
5885   bool isWeak = false;
5886
5887   if (EatIfPresent(lltok::kw_weak))
5888     isWeak = true;
5889
5890   if (EatIfPresent(lltok::kw_volatile))
5891     isVolatile = true;
5892
5893   if (ParseTypeAndValue(Ptr, PtrLoc, PFS) ||
5894       ParseToken(lltok::comma, "expected ',' after cmpxchg address") ||
5895       ParseTypeAndValue(Cmp, CmpLoc, PFS) ||
5896       ParseToken(lltok::comma, "expected ',' after cmpxchg cmp operand") ||
5897       ParseTypeAndValue(New, NewLoc, PFS) ||
5898       ParseScopeAndOrdering(true /*Always atomic*/, Scope, SuccessOrdering) ||
5899       ParseOrdering(FailureOrdering))
5900     return true;
5901
5902   if (SuccessOrdering == Unordered || FailureOrdering == Unordered)
5903     return TokError("cmpxchg cannot be unordered");
5904   if (SuccessOrdering < FailureOrdering)
5905     return TokError("cmpxchg must be at least as ordered on success as failure");
5906   if (FailureOrdering == Release || FailureOrdering == AcquireRelease)
5907     return TokError("cmpxchg failure ordering cannot include release semantics");
5908   if (!Ptr->getType()->isPointerTy())
5909     return Error(PtrLoc, "cmpxchg operand must be a pointer");
5910   if (cast<PointerType>(Ptr->getType())->getElementType() != Cmp->getType())
5911     return Error(CmpLoc, "compare value and pointer type do not match");
5912   if (cast<PointerType>(Ptr->getType())->getElementType() != New->getType())
5913     return Error(NewLoc, "new value and pointer type do not match");
5914   if (!New->getType()->isIntegerTy())
5915     return Error(NewLoc, "cmpxchg operand must be an integer");
5916   unsigned Size = New->getType()->getPrimitiveSizeInBits();
5917   if (Size < 8 || (Size & (Size - 1)))
5918     return Error(NewLoc, "cmpxchg operand must be power-of-two byte-sized"
5919                          " integer");
5920
5921   AtomicCmpXchgInst *CXI = new AtomicCmpXchgInst(
5922       Ptr, Cmp, New, SuccessOrdering, FailureOrdering, Scope);
5923   CXI->setVolatile(isVolatile);
5924   CXI->setWeak(isWeak);
5925   Inst = CXI;
5926   return AteExtraComma ? InstExtraComma : InstNormal;
5927 }
5928
5929 /// ParseAtomicRMW
5930 ///   ::= 'atomicrmw' 'volatile'? BinOp TypeAndValue ',' TypeAndValue
5931 ///       'singlethread'? AtomicOrdering
5932 int LLParser::ParseAtomicRMW(Instruction *&Inst, PerFunctionState &PFS) {
5933   Value *Ptr, *Val; LocTy PtrLoc, ValLoc;
5934   bool AteExtraComma = false;
5935   AtomicOrdering Ordering = NotAtomic;
5936   SynchronizationScope Scope = CrossThread;
5937   bool isVolatile = false;
5938   AtomicRMWInst::BinOp Operation;
5939
5940   if (EatIfPresent(lltok::kw_volatile))
5941     isVolatile = true;
5942
5943   switch (Lex.getKind()) {
5944   default: return TokError("expected binary operation in atomicrmw");
5945   case lltok::kw_xchg: Operation = AtomicRMWInst::Xchg; break;
5946   case lltok::kw_add: Operation = AtomicRMWInst::Add; break;
5947   case lltok::kw_sub: Operation = AtomicRMWInst::Sub; break;
5948   case lltok::kw_and: Operation = AtomicRMWInst::And; break;
5949   case lltok::kw_nand: Operation = AtomicRMWInst::Nand; break;
5950   case lltok::kw_or: Operation = AtomicRMWInst::Or; break;
5951   case lltok::kw_xor: Operation = AtomicRMWInst::Xor; break;
5952   case lltok::kw_max: Operation = AtomicRMWInst::Max; break;
5953   case lltok::kw_min: Operation = AtomicRMWInst::Min; break;
5954   case lltok::kw_umax: Operation = AtomicRMWInst::UMax; break;
5955   case lltok::kw_umin: Operation = AtomicRMWInst::UMin; break;
5956   }
5957   Lex.Lex();  // Eat the operation.
5958
5959   if (ParseTypeAndValue(Ptr, PtrLoc, PFS) ||
5960       ParseToken(lltok::comma, "expected ',' after atomicrmw address") ||
5961       ParseTypeAndValue(Val, ValLoc, PFS) ||
5962       ParseScopeAndOrdering(true /*Always atomic*/, Scope, Ordering))
5963     return true;
5964
5965   if (Ordering == Unordered)
5966     return TokError("atomicrmw cannot be unordered");
5967   if (!Ptr->getType()->isPointerTy())
5968     return Error(PtrLoc, "atomicrmw operand must be a pointer");
5969   if (cast<PointerType>(Ptr->getType())->getElementType() != Val->getType())
5970     return Error(ValLoc, "atomicrmw value and pointer type do not match");
5971   if (!Val->getType()->isIntegerTy())
5972     return Error(ValLoc, "atomicrmw operand must be an integer");
5973   unsigned Size = Val->getType()->getPrimitiveSizeInBits();
5974   if (Size < 8 || (Size & (Size - 1)))
5975     return Error(ValLoc, "atomicrmw operand must be power-of-two byte-sized"
5976                          " integer");
5977
5978   AtomicRMWInst *RMWI =
5979     new AtomicRMWInst(Operation, Ptr, Val, Ordering, Scope);
5980   RMWI->setVolatile(isVolatile);
5981   Inst = RMWI;
5982   return AteExtraComma ? InstExtraComma : InstNormal;
5983 }
5984
5985 /// ParseFence
5986 ///   ::= 'fence' 'singlethread'? AtomicOrdering
5987 int LLParser::ParseFence(Instruction *&Inst, PerFunctionState &PFS) {
5988   AtomicOrdering Ordering = NotAtomic;
5989   SynchronizationScope Scope = CrossThread;
5990   if (ParseScopeAndOrdering(true /*Always atomic*/, Scope, Ordering))
5991     return true;
5992
5993   if (Ordering == Unordered)
5994     return TokError("fence cannot be unordered");
5995   if (Ordering == Monotonic)
5996     return TokError("fence cannot be monotonic");
5997
5998   Inst = new FenceInst(Context, Ordering, Scope);
5999   return InstNormal;
6000 }
6001
6002 /// ParseGetElementPtr
6003 ///   ::= 'getelementptr' 'inbounds'? TypeAndValue (',' TypeAndValue)*
6004 int LLParser::ParseGetElementPtr(Instruction *&Inst, PerFunctionState &PFS) {
6005   Value *Ptr = nullptr;
6006   Value *Val = nullptr;
6007   LocTy Loc, EltLoc;
6008
6009   bool InBounds = EatIfPresent(lltok::kw_inbounds);
6010
6011   Type *Ty = nullptr;
6012   LocTy ExplicitTypeLoc = Lex.getLoc();
6013   if (ParseType(Ty) ||
6014       ParseToken(lltok::comma, "expected comma after getelementptr's type") ||
6015       ParseTypeAndValue(Ptr, Loc, PFS))
6016     return true;
6017
6018   Type *BaseType = Ptr->getType();
6019   PointerType *BasePointerType = dyn_cast<PointerType>(BaseType->getScalarType());
6020   if (!BasePointerType)
6021     return Error(Loc, "base of getelementptr must be a pointer");
6022
6023   if (Ty != BasePointerType->getElementType())
6024     return Error(ExplicitTypeLoc,
6025                  "explicit pointee type doesn't match operand's pointee type");
6026
6027   SmallVector<Value*, 16> Indices;
6028   bool AteExtraComma = false;
6029   // GEP returns a vector of pointers if at least one of parameters is a vector.
6030   // All vector parameters should have the same vector width.
6031   unsigned GEPWidth = BaseType->isVectorTy() ?
6032     BaseType->getVectorNumElements() : 0;
6033
6034   while (EatIfPresent(lltok::comma)) {
6035     if (Lex.getKind() == lltok::MetadataVar) {
6036       AteExtraComma = true;
6037       break;
6038     }
6039     if (ParseTypeAndValue(Val, EltLoc, PFS)) return true;
6040     if (!Val->getType()->getScalarType()->isIntegerTy())
6041       return Error(EltLoc, "getelementptr index must be an integer");
6042
6043     if (Val->getType()->isVectorTy()) {
6044       unsigned ValNumEl = Val->getType()->getVectorNumElements();
6045       if (GEPWidth && GEPWidth != ValNumEl)
6046         return Error(EltLoc,
6047           "getelementptr vector index has a wrong number of elements");
6048       GEPWidth = ValNumEl;
6049     }
6050     Indices.push_back(Val);
6051   }
6052
6053   SmallPtrSet<Type*, 4> Visited;
6054   if (!Indices.empty() && !Ty->isSized(&Visited))
6055     return Error(Loc, "base element of getelementptr must be sized");
6056
6057   if (!GetElementPtrInst::getIndexedType(Ty, Indices))
6058     return Error(Loc, "invalid getelementptr indices");
6059   Inst = GetElementPtrInst::Create(Ty, Ptr, Indices);
6060   if (InBounds)
6061     cast<GetElementPtrInst>(Inst)->setIsInBounds(true);
6062   return AteExtraComma ? InstExtraComma : InstNormal;
6063 }
6064
6065 /// ParseExtractValue
6066 ///   ::= 'extractvalue' TypeAndValue (',' uint32)+
6067 int LLParser::ParseExtractValue(Instruction *&Inst, PerFunctionState &PFS) {
6068   Value *Val; LocTy Loc;
6069   SmallVector<unsigned, 4> Indices;
6070   bool AteExtraComma;
6071   if (ParseTypeAndValue(Val, Loc, PFS) ||
6072       ParseIndexList(Indices, AteExtraComma))
6073     return true;
6074
6075   if (!Val->getType()->isAggregateType())
6076     return Error(Loc, "extractvalue operand must be aggregate type");
6077
6078   if (!ExtractValueInst::getIndexedType(Val->getType(), Indices))
6079     return Error(Loc, "invalid indices for extractvalue");
6080   Inst = ExtractValueInst::Create(Val, Indices);
6081   return AteExtraComma ? InstExtraComma : InstNormal;
6082 }
6083
6084 /// ParseInsertValue
6085 ///   ::= 'insertvalue' TypeAndValue ',' TypeAndValue (',' uint32)+
6086 int LLParser::ParseInsertValue(Instruction *&Inst, PerFunctionState &PFS) {
6087   Value *Val0, *Val1; LocTy Loc0, Loc1;
6088   SmallVector<unsigned, 4> Indices;
6089   bool AteExtraComma;
6090   if (ParseTypeAndValue(Val0, Loc0, PFS) ||
6091       ParseToken(lltok::comma, "expected comma after insertvalue operand") ||
6092       ParseTypeAndValue(Val1, Loc1, PFS) ||
6093       ParseIndexList(Indices, AteExtraComma))
6094     return true;
6095
6096   if (!Val0->getType()->isAggregateType())
6097     return Error(Loc0, "insertvalue operand must be aggregate type");
6098
6099   Type *IndexedType = ExtractValueInst::getIndexedType(Val0->getType(), Indices);
6100   if (!IndexedType)
6101     return Error(Loc0, "invalid indices for insertvalue");
6102   if (IndexedType != Val1->getType())
6103     return Error(Loc1, "insertvalue operand and field disagree in type: '" +
6104                            getTypeString(Val1->getType()) + "' instead of '" +
6105                            getTypeString(IndexedType) + "'");
6106   Inst = InsertValueInst::Create(Val0, Val1, Indices);
6107   return AteExtraComma ? InstExtraComma : InstNormal;
6108 }
6109
6110 //===----------------------------------------------------------------------===//
6111 // Embedded metadata.
6112 //===----------------------------------------------------------------------===//
6113
6114 /// ParseMDNodeVector
6115 ///   ::= { Element (',' Element)* }
6116 /// Element
6117 ///   ::= 'null' | TypeAndValue
6118 bool LLParser::ParseMDNodeVector(SmallVectorImpl<Metadata *> &Elts) {
6119   if (ParseToken(lltok::lbrace, "expected '{' here"))
6120     return true;
6121
6122   // Check for an empty list.
6123   if (EatIfPresent(lltok::rbrace))
6124     return false;
6125
6126   do {
6127     // Null is a special case since it is typeless.
6128     if (EatIfPresent(lltok::kw_null)) {
6129       Elts.push_back(nullptr);
6130       continue;
6131     }
6132
6133     Metadata *MD;
6134     if (ParseMetadata(MD, nullptr))
6135       return true;
6136     Elts.push_back(MD);
6137   } while (EatIfPresent(lltok::comma));
6138
6139   return ParseToken(lltok::rbrace, "expected end of metadata node");
6140 }
6141
6142 //===----------------------------------------------------------------------===//
6143 // Use-list order directives.
6144 //===----------------------------------------------------------------------===//
6145 bool LLParser::sortUseListOrder(Value *V, ArrayRef<unsigned> Indexes,
6146                                 SMLoc Loc) {
6147   if (V->use_empty())
6148     return Error(Loc, "value has no uses");
6149
6150   unsigned NumUses = 0;
6151   SmallDenseMap<const Use *, unsigned, 16> Order;
6152   for (const Use &U : V->uses()) {
6153     if (++NumUses > Indexes.size())
6154       break;
6155     Order[&U] = Indexes[NumUses - 1];
6156   }
6157   if (NumUses < 2)
6158     return Error(Loc, "value only has one use");
6159   if (Order.size() != Indexes.size() || NumUses > Indexes.size())
6160     return Error(Loc, "wrong number of indexes, expected " +
6161                           Twine(std::distance(V->use_begin(), V->use_end())));
6162
6163   V->sortUseList([&](const Use &L, const Use &R) {
6164     return Order.lookup(&L) < Order.lookup(&R);
6165   });
6166   return false;
6167 }
6168
6169 /// ParseUseListOrderIndexes
6170 ///   ::= '{' uint32 (',' uint32)+ '}'
6171 bool LLParser::ParseUseListOrderIndexes(SmallVectorImpl<unsigned> &Indexes) {
6172   SMLoc Loc = Lex.getLoc();
6173   if (ParseToken(lltok::lbrace, "expected '{' here"))
6174     return true;
6175   if (Lex.getKind() == lltok::rbrace)
6176     return Lex.Error("expected non-empty list of uselistorder indexes");
6177
6178   // Use Offset, Max, and IsOrdered to check consistency of indexes.  The
6179   // indexes should be distinct numbers in the range [0, size-1], and should
6180   // not be in order.
6181   unsigned Offset = 0;
6182   unsigned Max = 0;
6183   bool IsOrdered = true;
6184   assert(Indexes.empty() && "Expected empty order vector");
6185   do {
6186     unsigned Index;
6187     if (ParseUInt32(Index))
6188       return true;
6189
6190     // Update consistency checks.
6191     Offset += Index - Indexes.size();
6192     Max = std::max(Max, Index);
6193     IsOrdered &= Index == Indexes.size();
6194
6195     Indexes.push_back(Index);
6196   } while (EatIfPresent(lltok::comma));
6197
6198   if (ParseToken(lltok::rbrace, "expected '}' here"))
6199     return true;
6200
6201   if (Indexes.size() < 2)
6202     return Error(Loc, "expected >= 2 uselistorder indexes");
6203   if (Offset != 0 || Max >= Indexes.size())
6204     return Error(Loc, "expected distinct uselistorder indexes in range [0, size)");
6205   if (IsOrdered)
6206     return Error(Loc, "expected uselistorder indexes to change the order");
6207
6208   return false;
6209 }
6210
6211 /// ParseUseListOrder
6212 ///   ::= 'uselistorder' Type Value ',' UseListOrderIndexes
6213 bool LLParser::ParseUseListOrder(PerFunctionState *PFS) {
6214   SMLoc Loc = Lex.getLoc();
6215   if (ParseToken(lltok::kw_uselistorder, "expected uselistorder directive"))
6216     return true;
6217
6218   Value *V;
6219   SmallVector<unsigned, 16> Indexes;
6220   if (ParseTypeAndValue(V, PFS) ||
6221       ParseToken(lltok::comma, "expected comma in uselistorder directive") ||
6222       ParseUseListOrderIndexes(Indexes))
6223     return true;
6224
6225   return sortUseListOrder(V, Indexes, Loc);
6226 }
6227
6228 /// ParseUseListOrderBB
6229 ///   ::= 'uselistorder_bb' @foo ',' %bar ',' UseListOrderIndexes
6230 bool LLParser::ParseUseListOrderBB() {
6231   assert(Lex.getKind() == lltok::kw_uselistorder_bb);
6232   SMLoc Loc = Lex.getLoc();
6233   Lex.Lex();
6234
6235   ValID Fn, Label;
6236   SmallVector<unsigned, 16> Indexes;
6237   if (ParseValID(Fn) ||
6238       ParseToken(lltok::comma, "expected comma in uselistorder_bb directive") ||
6239       ParseValID(Label) ||
6240       ParseToken(lltok::comma, "expected comma in uselistorder_bb directive") ||
6241       ParseUseListOrderIndexes(Indexes))
6242     return true;
6243
6244   // Check the function.
6245   GlobalValue *GV;
6246   if (Fn.Kind == ValID::t_GlobalName)
6247     GV = M->getNamedValue(Fn.StrVal);
6248   else if (Fn.Kind == ValID::t_GlobalID)
6249     GV = Fn.UIntVal < NumberedVals.size() ? NumberedVals[Fn.UIntVal] : nullptr;
6250   else
6251     return Error(Fn.Loc, "expected function name in uselistorder_bb");
6252   if (!GV)
6253     return Error(Fn.Loc, "invalid function forward reference in uselistorder_bb");
6254   auto *F = dyn_cast<Function>(GV);
6255   if (!F)
6256     return Error(Fn.Loc, "expected function name in uselistorder_bb");
6257   if (F->isDeclaration())
6258     return Error(Fn.Loc, "invalid declaration in uselistorder_bb");
6259
6260   // Check the basic block.
6261   if (Label.Kind == ValID::t_LocalID)
6262     return Error(Label.Loc, "invalid numeric label in uselistorder_bb");
6263   if (Label.Kind != ValID::t_LocalName)
6264     return Error(Label.Loc, "expected basic block name in uselistorder_bb");
6265   Value *V = F->getValueSymbolTable().lookup(Label.StrVal);
6266   if (!V)
6267     return Error(Label.Loc, "invalid basic block in uselistorder_bb");
6268   if (!isa<BasicBlock>(V))
6269     return Error(Label.Loc, "expected basic block in uselistorder_bb");
6270
6271   return sortUseListOrder(V, Indexes, Loc);
6272 }