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