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