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