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
2953 struct MDSignedField : public MDFieldImpl<int64_t> {
2954   int64_t Min;
2955   int64_t Max;
2956
2957   MDSignedField(int64_t Default = 0)
2958       : ImplTy(Default), Min(INT64_MIN), Max(INT64_MAX) {}
2959   MDSignedField(int64_t Default, int64_t Min, int64_t Max)
2960       : ImplTy(Default), Min(Min), Max(Max) {}
2961 };
2962
2963 struct MDField : public MDFieldImpl<Metadata *> {
2964   MDField() : ImplTy(nullptr) {}
2965 };
2966 struct MDStringField : public MDFieldImpl<std::string> {
2967   MDStringField() : ImplTy(std::string()) {}
2968 };
2969 struct MDFieldList : public MDFieldImpl<SmallVector<Metadata *, 4>> {
2970   MDFieldList() : ImplTy(SmallVector<Metadata *, 4>()) {}
2971 };
2972
2973 } // end namespace
2974
2975 namespace llvm {
2976
2977 template <>
2978 bool LLParser::ParseMDField(LocTy Loc, StringRef Name,
2979                             MDUnsignedField &Result) {
2980   if (Lex.getKind() != lltok::APSInt || Lex.getAPSIntVal().isSigned())
2981     return TokError("expected unsigned integer");
2982
2983   auto &U = Lex.getAPSIntVal();
2984   if (U.ugt(Result.Max))
2985     return TokError("value for '" + Name + "' too large, limit is " +
2986                     Twine(Result.Max));
2987   Result.assign(U.getZExtValue());
2988   assert(Result.Val <= Result.Max && "Expected value in range");
2989   Lex.Lex();
2990   return false;
2991 }
2992
2993 template <>
2994 bool LLParser::ParseMDField(LocTy Loc, StringRef Name, LineField &Result) {
2995   return ParseMDField(Loc, Name, static_cast<MDUnsignedField &>(Result));
2996 }
2997 template <>
2998 bool LLParser::ParseMDField(LocTy Loc, StringRef Name, ColumnField &Result) {
2999   return ParseMDField(Loc, Name, static_cast<MDUnsignedField &>(Result));
3000 }
3001
3002 template <>
3003 bool LLParser::ParseMDField(LocTy Loc, StringRef Name, DwarfTagField &Result) {
3004   if (Lex.getKind() == lltok::APSInt)
3005     return ParseMDField(Loc, Name, static_cast<MDUnsignedField &>(Result));
3006
3007   if (Lex.getKind() != lltok::DwarfTag)
3008     return TokError("expected DWARF tag");
3009
3010   unsigned Tag = dwarf::getTag(Lex.getStrVal());
3011   if (Tag == dwarf::DW_TAG_invalid)
3012     return TokError("invalid DWARF tag" + Twine(" '") + Lex.getStrVal() + "'");
3013   assert(Tag <= Result.Max && "Expected valid DWARF tag");
3014
3015   Result.assign(Tag);
3016   Lex.Lex();
3017   return false;
3018 }
3019
3020 template <>
3021 bool LLParser::ParseMDField(LocTy Loc, StringRef Name,
3022                             DwarfAttEncodingField &Result) {
3023   if (Lex.getKind() == lltok::APSInt)
3024     return ParseMDField(Loc, Name, static_cast<MDUnsignedField &>(Result));
3025
3026   if (Lex.getKind() != lltok::DwarfAttEncoding)
3027     return TokError("expected DWARF type attribute encoding");
3028
3029   unsigned Encoding = dwarf::getAttributeEncoding(Lex.getStrVal());
3030   if (!Encoding)
3031     return TokError("invalid DWARF type attribute encoding" + Twine(" '") +
3032                     Lex.getStrVal() + "'");
3033   assert(Encoding <= Result.Max && "Expected valid DWARF language");
3034   Result.assign(Encoding);
3035   Lex.Lex();
3036   return false;
3037 }
3038
3039 template <>
3040 bool LLParser::ParseMDField(LocTy Loc, StringRef Name,
3041                             MDSignedField &Result) {
3042   if (Lex.getKind() != lltok::APSInt)
3043     return TokError("expected signed integer");
3044
3045   auto &S = Lex.getAPSIntVal();
3046   if (S < Result.Min)
3047     return TokError("value for '" + Name + "' too small, limit is " +
3048                     Twine(Result.Min));
3049   if (S > Result.Max)
3050     return TokError("value for '" + Name + "' too large, limit is " +
3051                     Twine(Result.Max));
3052   Result.assign(S.getExtValue());
3053   assert(Result.Val >= Result.Min && "Expected value in range");
3054   assert(Result.Val <= Result.Max && "Expected value in range");
3055   Lex.Lex();
3056   return false;
3057 }
3058
3059 template <>
3060 bool LLParser::ParseMDField(LocTy Loc, StringRef Name, MDField &Result) {
3061   Metadata *MD;
3062   if (ParseMetadata(MD, nullptr))
3063     return true;
3064
3065   Result.assign(MD);
3066   return false;
3067 }
3068
3069 template <>
3070 bool LLParser::ParseMDField(LocTy Loc, StringRef Name, MDStringField &Result) {
3071   std::string S;
3072   if (ParseStringConstant(S))
3073     return true;
3074
3075   Result.assign(std::move(S));
3076   return false;
3077 }
3078
3079 template <>
3080 bool LLParser::ParseMDField(LocTy Loc, StringRef Name, MDFieldList &Result) {
3081   SmallVector<Metadata *, 4> MDs;
3082   if (ParseMDNodeVector(MDs))
3083     return true;
3084
3085   Result.assign(std::move(MDs));
3086   return false;
3087 }
3088
3089 } // end namespace llvm
3090
3091 template <class ParserTy>
3092 bool LLParser::ParseMDFieldsImplBody(ParserTy parseField) {
3093   do {
3094     if (Lex.getKind() != lltok::LabelStr)
3095       return TokError("expected field label here");
3096
3097     if (parseField())
3098       return true;
3099   } while (EatIfPresent(lltok::comma));
3100
3101   return false;
3102 }
3103
3104 template <class ParserTy>
3105 bool LLParser::ParseMDFieldsImpl(ParserTy parseField, LocTy &ClosingLoc) {
3106   assert(Lex.getKind() == lltok::MetadataVar && "Expected metadata type name");
3107   Lex.Lex();
3108
3109   if (ParseToken(lltok::lparen, "expected '(' here"))
3110     return true;
3111   if (Lex.getKind() != lltok::rparen)
3112     if (ParseMDFieldsImplBody(parseField))
3113       return true;
3114
3115   ClosingLoc = Lex.getLoc();
3116   return ParseToken(lltok::rparen, "expected ')' here");
3117 }
3118
3119 template <class FieldTy>
3120 bool LLParser::ParseMDField(StringRef Name, FieldTy &Result) {
3121   if (Result.Seen)
3122     return TokError("field '" + Name + "' cannot be specified more than once");
3123
3124   LocTy Loc = Lex.getLoc();
3125   Lex.Lex();
3126   return ParseMDField(Loc, Name, Result);
3127 }
3128
3129 bool LLParser::ParseSpecializedMDNode(MDNode *&N, bool IsDistinct) {
3130   assert(Lex.getKind() == lltok::MetadataVar && "Expected metadata type name");
3131
3132 #define HANDLE_SPECIALIZED_MDNODE_LEAF(CLASS)                                  \
3133   if (Lex.getStrVal() == #CLASS)                                               \
3134     return Parse##CLASS(N, IsDistinct);
3135 #include "llvm/IR/Metadata.def"
3136
3137   return TokError("expected metadata type");
3138 }
3139
3140 #define DECLARE_FIELD(NAME, TYPE, INIT) TYPE NAME INIT
3141 #define NOP_FIELD(NAME, TYPE, INIT)
3142 #define REQUIRE_FIELD(NAME, TYPE, INIT)                                        \
3143   if (!NAME.Seen)                                                              \
3144     return Error(ClosingLoc, "missing required field '" #NAME "'");
3145 #define PARSE_MD_FIELD(NAME, TYPE, DEFAULT)                                    \
3146   if (Lex.getStrVal() == #NAME)                                                \
3147     return ParseMDField(#NAME, NAME);
3148 #define PARSE_MD_FIELDS()                                                      \
3149   VISIT_MD_FIELDS(DECLARE_FIELD, DECLARE_FIELD)                                \
3150   do {                                                                         \
3151     LocTy ClosingLoc;                                                          \
3152     if (ParseMDFieldsImpl([&]() -> bool {                                      \
3153       VISIT_MD_FIELDS(PARSE_MD_FIELD, PARSE_MD_FIELD)                          \
3154       return TokError(Twine("invalid field '") + Lex.getStrVal() + "'");       \
3155     }, ClosingLoc))                                                            \
3156       return true;                                                             \
3157     VISIT_MD_FIELDS(NOP_FIELD, REQUIRE_FIELD)                                  \
3158   } while (false)
3159 #define GET_OR_DISTINCT(CLASS, ARGS)                                           \
3160   (IsDistinct ? CLASS::getDistinct ARGS : CLASS::get ARGS)
3161
3162 /// ParseMDLocationFields:
3163 ///   ::= !MDLocation(line: 43, column: 8, scope: !5, inlinedAt: !6)
3164 bool LLParser::ParseMDLocation(MDNode *&Result, bool IsDistinct) {
3165 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED)                                    \
3166   OPTIONAL(line, LineField, );                                                 \
3167   OPTIONAL(column, ColumnField, );                                             \
3168   REQUIRED(scope, MDField, );                                                  \
3169   OPTIONAL(inlinedAt, MDField, );
3170   PARSE_MD_FIELDS();
3171 #undef VISIT_MD_FIELDS
3172
3173   auto get = (IsDistinct ? MDLocation::getDistinct : MDLocation::get);
3174   Result = get(Context, line.Val, column.Val, scope.Val, inlinedAt.Val);
3175   return false;
3176 }
3177
3178 /// ParseGenericDebugNode:
3179 ///   ::= !GenericDebugNode(tag: 15, header: "...", operands: {...})
3180 bool LLParser::ParseGenericDebugNode(MDNode *&Result, bool IsDistinct) {
3181 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED)                                    \
3182   REQUIRED(tag, DwarfTagField, );                                              \
3183   OPTIONAL(header, MDStringField, );                                           \
3184   OPTIONAL(operands, MDFieldList, );
3185   PARSE_MD_FIELDS();
3186 #undef VISIT_MD_FIELDS
3187
3188   Result = GET_OR_DISTINCT(GenericDebugNode,
3189                            (Context, tag.Val, header.Val, operands.Val));
3190   return false;
3191 }
3192
3193 /// ParseMDSubrange:
3194 ///   ::= !MDSubrange(count: 30, lowerBound: 2)
3195 bool LLParser::ParseMDSubrange(MDNode *&Result, bool IsDistinct) {
3196 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED)                                    \
3197   REQUIRED(count, MDUnsignedField, (0, UINT64_MAX >> 1));                      \
3198   OPTIONAL(lowerBound, MDSignedField, );
3199   PARSE_MD_FIELDS();
3200 #undef VISIT_MD_FIELDS
3201
3202   Result = GET_OR_DISTINCT(MDSubrange, (Context, count.Val, lowerBound.Val));
3203   return false;
3204 }
3205
3206 /// ParseMDEnumerator:
3207 ///   ::= !MDEnumerator(value: 30, name: "SomeKind")
3208 bool LLParser::ParseMDEnumerator(MDNode *&Result, bool IsDistinct) {
3209 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED)                                    \
3210   REQUIRED(value, MDSignedField, );                                            \
3211   REQUIRED(name, MDStringField, );
3212   PARSE_MD_FIELDS();
3213 #undef VISIT_MD_FIELDS
3214
3215   Result = GET_OR_DISTINCT(MDEnumerator, (Context, value.Val, name.Val));
3216   return false;
3217 }
3218
3219 /// ParseMDBasicType:
3220 ///   ::= !MDBasicType(tag: DW_TAG_base_type, name: "int", size: 32, align: 32)
3221 bool LLParser::ParseMDBasicType(MDNode *&Result, bool IsDistinct) {
3222 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED)                                    \
3223   REQUIRED(tag, DwarfTagField, );                                              \
3224   OPTIONAL(name, MDStringField, );                                             \
3225   OPTIONAL(size, MDUnsignedField, (0, UINT32_MAX));                            \
3226   OPTIONAL(align, MDUnsignedField, (0, UINT32_MAX));                           \
3227   OPTIONAL(encoding, DwarfAttEncodingField, );
3228   PARSE_MD_FIELDS();
3229 #undef VISIT_MD_FIELDS
3230
3231   Result = GET_OR_DISTINCT(MDBasicType, (Context, tag.Val, name.Val, size.Val,
3232                                          align.Val, encoding.Val));
3233   return false;
3234 }
3235
3236 /// ParseMDDerivedType:
3237 ///   ::= !MDDerivedType(tag: DW_TAG_pointer_type, name: "int", file: !0,
3238 ///                      line: 7, scope: !1, baseType: !2, size: 32,
3239 ///                      align: 32, offset: 0, flags: 0, extraData: !3)
3240 bool LLParser::ParseMDDerivedType(MDNode *&Result, bool IsDistinct) {
3241 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED)                                    \
3242   REQUIRED(tag, DwarfTagField, );                                              \
3243   OPTIONAL(name, MDStringField, );                                             \
3244   OPTIONAL(file, MDField, );                                                   \
3245   OPTIONAL(line, LineField, );                                                 \
3246   OPTIONAL(scope, MDField, );                                                  \
3247   REQUIRED(baseType, MDField, );                                               \
3248   OPTIONAL(size, MDUnsignedField, (0, UINT32_MAX));                            \
3249   OPTIONAL(align, MDUnsignedField, (0, UINT32_MAX));                           \
3250   OPTIONAL(offset, MDUnsignedField, (0, UINT32_MAX));                          \
3251   OPTIONAL(flags, MDUnsignedField, (0, UINT32_MAX));                           \
3252   OPTIONAL(extraData, MDField, );
3253   PARSE_MD_FIELDS();
3254 #undef VISIT_MD_FIELDS
3255
3256   Result = GET_OR_DISTINCT(MDDerivedType,
3257                            (Context, tag.Val, name.Val, file.Val, line.Val,
3258                             scope.Val, baseType.Val, size.Val, align.Val,
3259                             offset.Val, flags.Val, extraData.Val));
3260   return false;
3261 }
3262
3263 bool LLParser::ParseMDCompositeType(MDNode *&Result, bool IsDistinct) {
3264 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED)                                    \
3265   REQUIRED(tag, DwarfTagField, );                                              \
3266   OPTIONAL(name, MDStringField, );                                             \
3267   OPTIONAL(file, MDField, );                                                   \
3268   OPTIONAL(line, LineField, );                                                 \
3269   OPTIONAL(scope, MDField, );                                                  \
3270   OPTIONAL(baseType, MDField, );                                               \
3271   OPTIONAL(size, MDUnsignedField, (0, UINT32_MAX));                            \
3272   OPTIONAL(align, MDUnsignedField, (0, UINT32_MAX));                           \
3273   OPTIONAL(offset, MDUnsignedField, (0, UINT32_MAX));                          \
3274   OPTIONAL(flags, MDUnsignedField, (0, UINT32_MAX));                           \
3275   OPTIONAL(elements, MDField, );                                               \
3276   OPTIONAL(runtimeLang, MDUnsignedField, (0, UINT32_MAX));                     \
3277   OPTIONAL(vtableHolder, MDField, );                                           \
3278   OPTIONAL(templateParams, MDField, );                                         \
3279   OPTIONAL(identifier, MDStringField, );
3280   PARSE_MD_FIELDS();
3281 #undef VISIT_MD_FIELDS
3282
3283   Result = GET_OR_DISTINCT(
3284       MDCompositeType,
3285       (Context, tag.Val, name.Val, file.Val, line.Val, scope.Val, baseType.Val,
3286        size.Val, align.Val, offset.Val, flags.Val, elements.Val,
3287        runtimeLang.Val, vtableHolder.Val, templateParams.Val, identifier.Val));
3288   return false;
3289 }
3290
3291 bool LLParser::ParseMDSubroutineType(MDNode *&Result, bool IsDistinct) {
3292   return TokError("unimplemented parser");
3293 }
3294
3295 /// ParseMDFileType:
3296 ///   ::= !MDFileType(filename: "path/to/file", directory: "/path/to/dir")
3297 bool LLParser::ParseMDFile(MDNode *&Result, bool IsDistinct) {
3298 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED)                                    \
3299   REQUIRED(filename, MDStringField, );                                         \
3300   REQUIRED(directory, MDStringField, );
3301   PARSE_MD_FIELDS();
3302 #undef VISIT_MD_FIELDS
3303
3304   Result = GET_OR_DISTINCT(MDFile, (Context, filename.Val, directory.Val));
3305   return false;
3306 }
3307
3308 bool LLParser::ParseMDCompileUnit(MDNode *&Result, bool IsDistinct) {
3309   return TokError("unimplemented parser");
3310 }
3311 bool LLParser::ParseMDSubprogram(MDNode *&Result, bool IsDistinct) {
3312   return TokError("unimplemented parser");
3313 }
3314 bool LLParser::ParseMDLexicalBlock(MDNode *&Result, bool IsDistinct) {
3315   return TokError("unimplemented parser");
3316 }
3317 bool LLParser::ParseMDLexicalBlockFile(MDNode *&Result, bool IsDistinct) {
3318   return TokError("unimplemented parser");
3319 }
3320 bool LLParser::ParseMDNamespace(MDNode *&Result, bool IsDistinct) {
3321   return TokError("unimplemented parser");
3322 }
3323 bool LLParser::ParseMDTemplateTypeParameter(MDNode *&Result, bool IsDistinct) {
3324   return TokError("unimplemented parser");
3325 }
3326 bool LLParser::ParseMDTemplateValueParameter(MDNode *&Result, bool IsDistinct) {
3327   return TokError("unimplemented parser");
3328 }
3329 bool LLParser::ParseMDGlobalVariable(MDNode *&Result, bool IsDistinct) {
3330   return TokError("unimplemented parser");
3331 }
3332 bool LLParser::ParseMDLocalVariable(MDNode *&Result, bool IsDistinct) {
3333   return TokError("unimplemented parser");
3334 }
3335 bool LLParser::ParseMDExpression(MDNode *&Result, bool IsDistinct) {
3336   return TokError("unimplemented parser");
3337 }
3338 bool LLParser::ParseMDObjCProperty(MDNode *&Result, bool IsDistinct) {
3339   return TokError("unimplemented parser");
3340 }
3341 bool LLParser::ParseMDImportedEntity(MDNode *&Result, bool IsDistinct) {
3342   return TokError("unimplemented parser");
3343 }
3344 #undef PARSE_MD_FIELD
3345 #undef NOP_FIELD
3346 #undef REQUIRE_FIELD
3347 #undef DECLARE_FIELD
3348
3349 /// ParseMetadataAsValue
3350 ///  ::= metadata i32 %local
3351 ///  ::= metadata i32 @global
3352 ///  ::= metadata i32 7
3353 ///  ::= metadata !0
3354 ///  ::= metadata !{...}
3355 ///  ::= metadata !"string"
3356 bool LLParser::ParseMetadataAsValue(Value *&V, PerFunctionState &PFS) {
3357   // Note: the type 'metadata' has already been parsed.
3358   Metadata *MD;
3359   if (ParseMetadata(MD, &PFS))
3360     return true;
3361
3362   V = MetadataAsValue::get(Context, MD);
3363   return false;
3364 }
3365
3366 /// ParseValueAsMetadata
3367 ///  ::= i32 %local
3368 ///  ::= i32 @global
3369 ///  ::= i32 7
3370 bool LLParser::ParseValueAsMetadata(Metadata *&MD, PerFunctionState *PFS) {
3371   Type *Ty;
3372   LocTy Loc;
3373   if (ParseType(Ty, "expected metadata operand", Loc))
3374     return true;
3375   if (Ty->isMetadataTy())
3376     return Error(Loc, "invalid metadata-value-metadata roundtrip");
3377
3378   Value *V;
3379   if (ParseValue(Ty, V, PFS))
3380     return true;
3381
3382   MD = ValueAsMetadata::get(V);
3383   return false;
3384 }
3385
3386 /// ParseMetadata
3387 ///  ::= i32 %local
3388 ///  ::= i32 @global
3389 ///  ::= i32 7
3390 ///  ::= !42
3391 ///  ::= !{...}
3392 ///  ::= !"string"
3393 ///  ::= !MDLocation(...)
3394 bool LLParser::ParseMetadata(Metadata *&MD, PerFunctionState *PFS) {
3395   if (Lex.getKind() == lltok::MetadataVar) {
3396     MDNode *N;
3397     if (ParseSpecializedMDNode(N))
3398       return true;
3399     MD = N;
3400     return false;
3401   }
3402
3403   // ValueAsMetadata:
3404   // <type> <value>
3405   if (Lex.getKind() != lltok::exclaim)
3406     return ParseValueAsMetadata(MD, PFS);
3407
3408   // '!'.
3409   assert(Lex.getKind() == lltok::exclaim && "Expected '!' here");
3410   Lex.Lex();
3411
3412   // MDString:
3413   //   ::= '!' STRINGCONSTANT
3414   if (Lex.getKind() == lltok::StringConstant) {
3415     MDString *S;
3416     if (ParseMDString(S))
3417       return true;
3418     MD = S;
3419     return false;
3420   }
3421
3422   // MDNode:
3423   // !{ ... }
3424   // !7
3425   MDNode *N;
3426   if (ParseMDNodeTail(N))
3427     return true;
3428   MD = N;
3429   return false;
3430 }
3431
3432
3433 //===----------------------------------------------------------------------===//
3434 // Function Parsing.
3435 //===----------------------------------------------------------------------===//
3436
3437 bool LLParser::ConvertValIDToValue(Type *Ty, ValID &ID, Value *&V,
3438                                    PerFunctionState *PFS) {
3439   if (Ty->isFunctionTy())
3440     return Error(ID.Loc, "functions are not values, refer to them as pointers");
3441
3442   switch (ID.Kind) {
3443   case ValID::t_LocalID:
3444     if (!PFS) return Error(ID.Loc, "invalid use of function-local name");
3445     V = PFS->GetVal(ID.UIntVal, Ty, ID.Loc);
3446     return V == nullptr;
3447   case ValID::t_LocalName:
3448     if (!PFS) return Error(ID.Loc, "invalid use of function-local name");
3449     V = PFS->GetVal(ID.StrVal, Ty, ID.Loc);
3450     return V == nullptr;
3451   case ValID::t_InlineAsm: {
3452     PointerType *PTy = dyn_cast<PointerType>(Ty);
3453     FunctionType *FTy =
3454       PTy ? dyn_cast<FunctionType>(PTy->getElementType()) : nullptr;
3455     if (!FTy || !InlineAsm::Verify(FTy, ID.StrVal2))
3456       return Error(ID.Loc, "invalid type for inline asm constraint string");
3457     V = InlineAsm::get(FTy, ID.StrVal, ID.StrVal2, ID.UIntVal&1,
3458                        (ID.UIntVal>>1)&1, (InlineAsm::AsmDialect(ID.UIntVal>>2)));
3459     return false;
3460   }
3461   case ValID::t_GlobalName:
3462     V = GetGlobalVal(ID.StrVal, Ty, ID.Loc);
3463     return V == nullptr;
3464   case ValID::t_GlobalID:
3465     V = GetGlobalVal(ID.UIntVal, Ty, ID.Loc);
3466     return V == nullptr;
3467   case ValID::t_APSInt:
3468     if (!Ty->isIntegerTy())
3469       return Error(ID.Loc, "integer constant must have integer type");
3470     ID.APSIntVal = ID.APSIntVal.extOrTrunc(Ty->getPrimitiveSizeInBits());
3471     V = ConstantInt::get(Context, ID.APSIntVal);
3472     return false;
3473   case ValID::t_APFloat:
3474     if (!Ty->isFloatingPointTy() ||
3475         !ConstantFP::isValueValidForType(Ty, ID.APFloatVal))
3476       return Error(ID.Loc, "floating point constant invalid for type");
3477
3478     // The lexer has no type info, so builds all half, float, and double FP
3479     // constants as double.  Fix this here.  Long double does not need this.
3480     if (&ID.APFloatVal.getSemantics() == &APFloat::IEEEdouble) {
3481       bool Ignored;
3482       if (Ty->isHalfTy())
3483         ID.APFloatVal.convert(APFloat::IEEEhalf, APFloat::rmNearestTiesToEven,
3484                               &Ignored);
3485       else if (Ty->isFloatTy())
3486         ID.APFloatVal.convert(APFloat::IEEEsingle, APFloat::rmNearestTiesToEven,
3487                               &Ignored);
3488     }
3489     V = ConstantFP::get(Context, ID.APFloatVal);
3490
3491     if (V->getType() != Ty)
3492       return Error(ID.Loc, "floating point constant does not have type '" +
3493                    getTypeString(Ty) + "'");
3494
3495     return false;
3496   case ValID::t_Null:
3497     if (!Ty->isPointerTy())
3498       return Error(ID.Loc, "null must be a pointer type");
3499     V = ConstantPointerNull::get(cast<PointerType>(Ty));
3500     return false;
3501   case ValID::t_Undef:
3502     // FIXME: LabelTy should not be a first-class type.
3503     if (!Ty->isFirstClassType() || Ty->isLabelTy())
3504       return Error(ID.Loc, "invalid type for undef constant");
3505     V = UndefValue::get(Ty);
3506     return false;
3507   case ValID::t_EmptyArray:
3508     if (!Ty->isArrayTy() || cast<ArrayType>(Ty)->getNumElements() != 0)
3509       return Error(ID.Loc, "invalid empty array initializer");
3510     V = UndefValue::get(Ty);
3511     return false;
3512   case ValID::t_Zero:
3513     // FIXME: LabelTy should not be a first-class type.
3514     if (!Ty->isFirstClassType() || Ty->isLabelTy())
3515       return Error(ID.Loc, "invalid type for null constant");
3516     V = Constant::getNullValue(Ty);
3517     return false;
3518   case ValID::t_Constant:
3519     if (ID.ConstantVal->getType() != Ty)
3520       return Error(ID.Loc, "constant expression type mismatch");
3521
3522     V = ID.ConstantVal;
3523     return false;
3524   case ValID::t_ConstantStruct:
3525   case ValID::t_PackedConstantStruct:
3526     if (StructType *ST = dyn_cast<StructType>(Ty)) {
3527       if (ST->getNumElements() != ID.UIntVal)
3528         return Error(ID.Loc,
3529                      "initializer with struct type has wrong # elements");
3530       if (ST->isPacked() != (ID.Kind == ValID::t_PackedConstantStruct))
3531         return Error(ID.Loc, "packed'ness of initializer and type don't match");
3532
3533       // Verify that the elements are compatible with the structtype.
3534       for (unsigned i = 0, e = ID.UIntVal; i != e; ++i)
3535         if (ID.ConstantStructElts[i]->getType() != ST->getElementType(i))
3536           return Error(ID.Loc, "element " + Twine(i) +
3537                     " of struct initializer doesn't match struct element type");
3538
3539       V = ConstantStruct::get(ST, makeArrayRef(ID.ConstantStructElts,
3540                                                ID.UIntVal));
3541     } else
3542       return Error(ID.Loc, "constant expression type mismatch");
3543     return false;
3544   }
3545   llvm_unreachable("Invalid ValID");
3546 }
3547
3548 bool LLParser::ParseValue(Type *Ty, Value *&V, PerFunctionState *PFS) {
3549   V = nullptr;
3550   ValID ID;
3551   return ParseValID(ID, PFS) ||
3552          ConvertValIDToValue(Ty, ID, V, PFS);
3553 }
3554
3555 bool LLParser::ParseTypeAndValue(Value *&V, PerFunctionState *PFS) {
3556   Type *Ty = nullptr;
3557   return ParseType(Ty) ||
3558          ParseValue(Ty, V, PFS);
3559 }
3560
3561 bool LLParser::ParseTypeAndBasicBlock(BasicBlock *&BB, LocTy &Loc,
3562                                       PerFunctionState &PFS) {
3563   Value *V;
3564   Loc = Lex.getLoc();
3565   if (ParseTypeAndValue(V, PFS)) return true;
3566   if (!isa<BasicBlock>(V))
3567     return Error(Loc, "expected a basic block");
3568   BB = cast<BasicBlock>(V);
3569   return false;
3570 }
3571
3572
3573 /// FunctionHeader
3574 ///   ::= OptionalLinkage OptionalVisibility OptionalCallingConv OptRetAttrs
3575 ///       OptUnnamedAddr Type GlobalName '(' ArgList ')' OptFuncAttrs OptSection
3576 ///       OptionalAlign OptGC OptionalPrefix OptionalPrologue
3577 bool LLParser::ParseFunctionHeader(Function *&Fn, bool isDefine) {
3578   // Parse the linkage.
3579   LocTy LinkageLoc = Lex.getLoc();
3580   unsigned Linkage;
3581
3582   unsigned Visibility;
3583   unsigned DLLStorageClass;
3584   AttrBuilder RetAttrs;
3585   unsigned CC;
3586   Type *RetType = nullptr;
3587   LocTy RetTypeLoc = Lex.getLoc();
3588   if (ParseOptionalLinkage(Linkage) ||
3589       ParseOptionalVisibility(Visibility) ||
3590       ParseOptionalDLLStorageClass(DLLStorageClass) ||
3591       ParseOptionalCallingConv(CC) ||
3592       ParseOptionalReturnAttrs(RetAttrs) ||
3593       ParseType(RetType, RetTypeLoc, true /*void allowed*/))
3594     return true;
3595
3596   // Verify that the linkage is ok.
3597   switch ((GlobalValue::LinkageTypes)Linkage) {
3598   case GlobalValue::ExternalLinkage:
3599     break; // always ok.
3600   case GlobalValue::ExternalWeakLinkage:
3601     if (isDefine)
3602       return Error(LinkageLoc, "invalid linkage for function definition");
3603     break;
3604   case GlobalValue::PrivateLinkage:
3605   case GlobalValue::InternalLinkage:
3606   case GlobalValue::AvailableExternallyLinkage:
3607   case GlobalValue::LinkOnceAnyLinkage:
3608   case GlobalValue::LinkOnceODRLinkage:
3609   case GlobalValue::WeakAnyLinkage:
3610   case GlobalValue::WeakODRLinkage:
3611     if (!isDefine)
3612       return Error(LinkageLoc, "invalid linkage for function declaration");
3613     break;
3614   case GlobalValue::AppendingLinkage:
3615   case GlobalValue::CommonLinkage:
3616     return Error(LinkageLoc, "invalid function linkage type");
3617   }
3618
3619   if (!isValidVisibilityForLinkage(Visibility, Linkage))
3620     return Error(LinkageLoc,
3621                  "symbol with local linkage must have default visibility");
3622
3623   if (!FunctionType::isValidReturnType(RetType))
3624     return Error(RetTypeLoc, "invalid function return type");
3625
3626   LocTy NameLoc = Lex.getLoc();
3627
3628   std::string FunctionName;
3629   if (Lex.getKind() == lltok::GlobalVar) {
3630     FunctionName = Lex.getStrVal();
3631   } else if (Lex.getKind() == lltok::GlobalID) {     // @42 is ok.
3632     unsigned NameID = Lex.getUIntVal();
3633
3634     if (NameID != NumberedVals.size())
3635       return TokError("function expected to be numbered '%" +
3636                       Twine(NumberedVals.size()) + "'");
3637   } else {
3638     return TokError("expected function name");
3639   }
3640
3641   Lex.Lex();
3642
3643   if (Lex.getKind() != lltok::lparen)
3644     return TokError("expected '(' in function argument list");
3645
3646   SmallVector<ArgInfo, 8> ArgList;
3647   bool isVarArg;
3648   AttrBuilder FuncAttrs;
3649   std::vector<unsigned> FwdRefAttrGrps;
3650   LocTy BuiltinLoc;
3651   std::string Section;
3652   unsigned Alignment;
3653   std::string GC;
3654   bool UnnamedAddr;
3655   LocTy UnnamedAddrLoc;
3656   Constant *Prefix = nullptr;
3657   Constant *Prologue = nullptr;
3658   Comdat *C;
3659
3660   if (ParseArgumentList(ArgList, isVarArg) ||
3661       ParseOptionalToken(lltok::kw_unnamed_addr, UnnamedAddr,
3662                          &UnnamedAddrLoc) ||
3663       ParseFnAttributeValuePairs(FuncAttrs, FwdRefAttrGrps, false,
3664                                  BuiltinLoc) ||
3665       (EatIfPresent(lltok::kw_section) &&
3666        ParseStringConstant(Section)) ||
3667       parseOptionalComdat(FunctionName, C) ||
3668       ParseOptionalAlignment(Alignment) ||
3669       (EatIfPresent(lltok::kw_gc) &&
3670        ParseStringConstant(GC)) ||
3671       (EatIfPresent(lltok::kw_prefix) &&
3672        ParseGlobalTypeAndValue(Prefix)) ||
3673       (EatIfPresent(lltok::kw_prologue) &&
3674        ParseGlobalTypeAndValue(Prologue)))
3675     return true;
3676
3677   if (FuncAttrs.contains(Attribute::Builtin))
3678     return Error(BuiltinLoc, "'builtin' attribute not valid on function");
3679
3680   // If the alignment was parsed as an attribute, move to the alignment field.
3681   if (FuncAttrs.hasAlignmentAttr()) {
3682     Alignment = FuncAttrs.getAlignment();
3683     FuncAttrs.removeAttribute(Attribute::Alignment);
3684   }
3685
3686   // Okay, if we got here, the function is syntactically valid.  Convert types
3687   // and do semantic checks.
3688   std::vector<Type*> ParamTypeList;
3689   SmallVector<AttributeSet, 8> Attrs;
3690
3691   if (RetAttrs.hasAttributes())
3692     Attrs.push_back(AttributeSet::get(RetType->getContext(),
3693                                       AttributeSet::ReturnIndex,
3694                                       RetAttrs));
3695
3696   for (unsigned i = 0, e = ArgList.size(); i != e; ++i) {
3697     ParamTypeList.push_back(ArgList[i].Ty);
3698     if (ArgList[i].Attrs.hasAttributes(i + 1)) {
3699       AttrBuilder B(ArgList[i].Attrs, i + 1);
3700       Attrs.push_back(AttributeSet::get(RetType->getContext(), i + 1, B));
3701     }
3702   }
3703
3704   if (FuncAttrs.hasAttributes())
3705     Attrs.push_back(AttributeSet::get(RetType->getContext(),
3706                                       AttributeSet::FunctionIndex,
3707                                       FuncAttrs));
3708
3709   AttributeSet PAL = AttributeSet::get(Context, Attrs);
3710
3711   if (PAL.hasAttribute(1, Attribute::StructRet) && !RetType->isVoidTy())
3712     return Error(RetTypeLoc, "functions with 'sret' argument must return void");
3713
3714   FunctionType *FT =
3715     FunctionType::get(RetType, ParamTypeList, isVarArg);
3716   PointerType *PFT = PointerType::getUnqual(FT);
3717
3718   Fn = nullptr;
3719   if (!FunctionName.empty()) {
3720     // If this was a definition of a forward reference, remove the definition
3721     // from the forward reference table and fill in the forward ref.
3722     std::map<std::string, std::pair<GlobalValue*, LocTy> >::iterator FRVI =
3723       ForwardRefVals.find(FunctionName);
3724     if (FRVI != ForwardRefVals.end()) {
3725       Fn = M->getFunction(FunctionName);
3726       if (!Fn)
3727         return Error(FRVI->second.second, "invalid forward reference to "
3728                      "function as global value!");
3729       if (Fn->getType() != PFT)
3730         return Error(FRVI->second.second, "invalid forward reference to "
3731                      "function '" + FunctionName + "' with wrong type!");
3732
3733       ForwardRefVals.erase(FRVI);
3734     } else if ((Fn = M->getFunction(FunctionName))) {
3735       // Reject redefinitions.
3736       return Error(NameLoc, "invalid redefinition of function '" +
3737                    FunctionName + "'");
3738     } else if (M->getNamedValue(FunctionName)) {
3739       return Error(NameLoc, "redefinition of function '@" + FunctionName + "'");
3740     }
3741
3742   } else {
3743     // If this is a definition of a forward referenced function, make sure the
3744     // types agree.
3745     std::map<unsigned, std::pair<GlobalValue*, LocTy> >::iterator I
3746       = ForwardRefValIDs.find(NumberedVals.size());
3747     if (I != ForwardRefValIDs.end()) {
3748       Fn = cast<Function>(I->second.first);
3749       if (Fn->getType() != PFT)
3750         return Error(NameLoc, "type of definition and forward reference of '@" +
3751                      Twine(NumberedVals.size()) + "' disagree");
3752       ForwardRefValIDs.erase(I);
3753     }
3754   }
3755
3756   if (!Fn)
3757     Fn = Function::Create(FT, GlobalValue::ExternalLinkage, FunctionName, M);
3758   else // Move the forward-reference to the correct spot in the module.
3759     M->getFunctionList().splice(M->end(), M->getFunctionList(), Fn);
3760
3761   if (FunctionName.empty())
3762     NumberedVals.push_back(Fn);
3763
3764   Fn->setLinkage((GlobalValue::LinkageTypes)Linkage);
3765   Fn->setVisibility((GlobalValue::VisibilityTypes)Visibility);
3766   Fn->setDLLStorageClass((GlobalValue::DLLStorageClassTypes)DLLStorageClass);
3767   Fn->setCallingConv(CC);
3768   Fn->setAttributes(PAL);
3769   Fn->setUnnamedAddr(UnnamedAddr);
3770   Fn->setAlignment(Alignment);
3771   Fn->setSection(Section);
3772   Fn->setComdat(C);
3773   if (!GC.empty()) Fn->setGC(GC.c_str());
3774   Fn->setPrefixData(Prefix);
3775   Fn->setPrologueData(Prologue);
3776   ForwardRefAttrGroups[Fn] = FwdRefAttrGrps;
3777
3778   // Add all of the arguments we parsed to the function.
3779   Function::arg_iterator ArgIt = Fn->arg_begin();
3780   for (unsigned i = 0, e = ArgList.size(); i != e; ++i, ++ArgIt) {
3781     // If the argument has a name, insert it into the argument symbol table.
3782     if (ArgList[i].Name.empty()) continue;
3783
3784     // Set the name, if it conflicted, it will be auto-renamed.
3785     ArgIt->setName(ArgList[i].Name);
3786
3787     if (ArgIt->getName() != ArgList[i].Name)
3788       return Error(ArgList[i].Loc, "redefinition of argument '%" +
3789                    ArgList[i].Name + "'");
3790   }
3791
3792   if (isDefine)
3793     return false;
3794
3795   // Check the declaration has no block address forward references.
3796   ValID ID;
3797   if (FunctionName.empty()) {
3798     ID.Kind = ValID::t_GlobalID;
3799     ID.UIntVal = NumberedVals.size() - 1;
3800   } else {
3801     ID.Kind = ValID::t_GlobalName;
3802     ID.StrVal = FunctionName;
3803   }
3804   auto Blocks = ForwardRefBlockAddresses.find(ID);
3805   if (Blocks != ForwardRefBlockAddresses.end())
3806     return Error(Blocks->first.Loc,
3807                  "cannot take blockaddress inside a declaration");
3808   return false;
3809 }
3810
3811 bool LLParser::PerFunctionState::resolveForwardRefBlockAddresses() {
3812   ValID ID;
3813   if (FunctionNumber == -1) {
3814     ID.Kind = ValID::t_GlobalName;
3815     ID.StrVal = F.getName();
3816   } else {
3817     ID.Kind = ValID::t_GlobalID;
3818     ID.UIntVal = FunctionNumber;
3819   }
3820
3821   auto Blocks = P.ForwardRefBlockAddresses.find(ID);
3822   if (Blocks == P.ForwardRefBlockAddresses.end())
3823     return false;
3824
3825   for (const auto &I : Blocks->second) {
3826     const ValID &BBID = I.first;
3827     GlobalValue *GV = I.second;
3828
3829     assert((BBID.Kind == ValID::t_LocalID || BBID.Kind == ValID::t_LocalName) &&
3830            "Expected local id or name");
3831     BasicBlock *BB;
3832     if (BBID.Kind == ValID::t_LocalName)
3833       BB = GetBB(BBID.StrVal, BBID.Loc);
3834     else
3835       BB = GetBB(BBID.UIntVal, BBID.Loc);
3836     if (!BB)
3837       return P.Error(BBID.Loc, "referenced value is not a basic block");
3838
3839     GV->replaceAllUsesWith(BlockAddress::get(&F, BB));
3840     GV->eraseFromParent();
3841   }
3842
3843   P.ForwardRefBlockAddresses.erase(Blocks);
3844   return false;
3845 }
3846
3847 /// ParseFunctionBody
3848 ///   ::= '{' BasicBlock+ UseListOrderDirective* '}'
3849 bool LLParser::ParseFunctionBody(Function &Fn) {
3850   if (Lex.getKind() != lltok::lbrace)
3851     return TokError("expected '{' in function body");
3852   Lex.Lex();  // eat the {.
3853
3854   int FunctionNumber = -1;
3855   if (!Fn.hasName()) FunctionNumber = NumberedVals.size()-1;
3856
3857   PerFunctionState PFS(*this, Fn, FunctionNumber);
3858
3859   // Resolve block addresses and allow basic blocks to be forward-declared
3860   // within this function.
3861   if (PFS.resolveForwardRefBlockAddresses())
3862     return true;
3863   SaveAndRestore<PerFunctionState *> ScopeExit(BlockAddressPFS, &PFS);
3864
3865   // We need at least one basic block.
3866   if (Lex.getKind() == lltok::rbrace || Lex.getKind() == lltok::kw_uselistorder)
3867     return TokError("function body requires at least one basic block");
3868
3869   while (Lex.getKind() != lltok::rbrace &&
3870          Lex.getKind() != lltok::kw_uselistorder)
3871     if (ParseBasicBlock(PFS)) return true;
3872
3873   while (Lex.getKind() != lltok::rbrace)
3874     if (ParseUseListOrder(&PFS))
3875       return true;
3876
3877   // Eat the }.
3878   Lex.Lex();
3879
3880   // Verify function is ok.
3881   return PFS.FinishFunction();
3882 }
3883
3884 /// ParseBasicBlock
3885 ///   ::= LabelStr? Instruction*
3886 bool LLParser::ParseBasicBlock(PerFunctionState &PFS) {
3887   // If this basic block starts out with a name, remember it.
3888   std::string Name;
3889   LocTy NameLoc = Lex.getLoc();
3890   if (Lex.getKind() == lltok::LabelStr) {
3891     Name = Lex.getStrVal();
3892     Lex.Lex();
3893   }
3894
3895   BasicBlock *BB = PFS.DefineBB(Name, NameLoc);
3896   if (!BB) return true;
3897
3898   std::string NameStr;
3899
3900   // Parse the instructions in this block until we get a terminator.
3901   Instruction *Inst;
3902   do {
3903     // This instruction may have three possibilities for a name: a) none
3904     // specified, b) name specified "%foo =", c) number specified: "%4 =".
3905     LocTy NameLoc = Lex.getLoc();
3906     int NameID = -1;
3907     NameStr = "";
3908
3909     if (Lex.getKind() == lltok::LocalVarID) {
3910       NameID = Lex.getUIntVal();
3911       Lex.Lex();
3912       if (ParseToken(lltok::equal, "expected '=' after instruction id"))
3913         return true;
3914     } else if (Lex.getKind() == lltok::LocalVar) {
3915       NameStr = Lex.getStrVal();
3916       Lex.Lex();
3917       if (ParseToken(lltok::equal, "expected '=' after instruction name"))
3918         return true;
3919     }
3920
3921     switch (ParseInstruction(Inst, BB, PFS)) {
3922     default: llvm_unreachable("Unknown ParseInstruction result!");
3923     case InstError: return true;
3924     case InstNormal:
3925       BB->getInstList().push_back(Inst);
3926
3927       // With a normal result, we check to see if the instruction is followed by
3928       // a comma and metadata.
3929       if (EatIfPresent(lltok::comma))
3930         if (ParseInstructionMetadata(Inst, &PFS))
3931           return true;
3932       break;
3933     case InstExtraComma:
3934       BB->getInstList().push_back(Inst);
3935
3936       // If the instruction parser ate an extra comma at the end of it, it
3937       // *must* be followed by metadata.
3938       if (ParseInstructionMetadata(Inst, &PFS))
3939         return true;
3940       break;
3941     }
3942
3943     // Set the name on the instruction.
3944     if (PFS.SetInstName(NameID, NameStr, NameLoc, Inst)) return true;
3945   } while (!isa<TerminatorInst>(Inst));
3946
3947   return false;
3948 }
3949
3950 //===----------------------------------------------------------------------===//
3951 // Instruction Parsing.
3952 //===----------------------------------------------------------------------===//
3953
3954 /// ParseInstruction - Parse one of the many different instructions.
3955 ///
3956 int LLParser::ParseInstruction(Instruction *&Inst, BasicBlock *BB,
3957                                PerFunctionState &PFS) {
3958   lltok::Kind Token = Lex.getKind();
3959   if (Token == lltok::Eof)
3960     return TokError("found end of file when expecting more instructions");
3961   LocTy Loc = Lex.getLoc();
3962   unsigned KeywordVal = Lex.getUIntVal();
3963   Lex.Lex();  // Eat the keyword.
3964
3965   switch (Token) {
3966   default:                    return Error(Loc, "expected instruction opcode");
3967   // Terminator Instructions.
3968   case lltok::kw_unreachable: Inst = new UnreachableInst(Context); return false;
3969   case lltok::kw_ret:         return ParseRet(Inst, BB, PFS);
3970   case lltok::kw_br:          return ParseBr(Inst, PFS);
3971   case lltok::kw_switch:      return ParseSwitch(Inst, PFS);
3972   case lltok::kw_indirectbr:  return ParseIndirectBr(Inst, PFS);
3973   case lltok::kw_invoke:      return ParseInvoke(Inst, PFS);
3974   case lltok::kw_resume:      return ParseResume(Inst, PFS);
3975   // Binary Operators.
3976   case lltok::kw_add:
3977   case lltok::kw_sub:
3978   case lltok::kw_mul:
3979   case lltok::kw_shl: {
3980     bool NUW = EatIfPresent(lltok::kw_nuw);
3981     bool NSW = EatIfPresent(lltok::kw_nsw);
3982     if (!NUW) NUW = EatIfPresent(lltok::kw_nuw);
3983
3984     if (ParseArithmetic(Inst, PFS, KeywordVal, 1)) return true;
3985
3986     if (NUW) cast<BinaryOperator>(Inst)->setHasNoUnsignedWrap(true);
3987     if (NSW) cast<BinaryOperator>(Inst)->setHasNoSignedWrap(true);
3988     return false;
3989   }
3990   case lltok::kw_fadd:
3991   case lltok::kw_fsub:
3992   case lltok::kw_fmul:
3993   case lltok::kw_fdiv:
3994   case lltok::kw_frem: {
3995     FastMathFlags FMF = EatFastMathFlagsIfPresent();
3996     int Res = ParseArithmetic(Inst, PFS, KeywordVal, 2);
3997     if (Res != 0)
3998       return Res;
3999     if (FMF.any())
4000       Inst->setFastMathFlags(FMF);
4001     return 0;
4002   }
4003
4004   case lltok::kw_sdiv:
4005   case lltok::kw_udiv:
4006   case lltok::kw_lshr:
4007   case lltok::kw_ashr: {
4008     bool Exact = EatIfPresent(lltok::kw_exact);
4009
4010     if (ParseArithmetic(Inst, PFS, KeywordVal, 1)) return true;
4011     if (Exact) cast<BinaryOperator>(Inst)->setIsExact(true);
4012     return false;
4013   }
4014
4015   case lltok::kw_urem:
4016   case lltok::kw_srem:   return ParseArithmetic(Inst, PFS, KeywordVal, 1);
4017   case lltok::kw_and:
4018   case lltok::kw_or:
4019   case lltok::kw_xor:    return ParseLogical(Inst, PFS, KeywordVal);
4020   case lltok::kw_icmp:
4021   case lltok::kw_fcmp:   return ParseCompare(Inst, PFS, KeywordVal);
4022   // Casts.
4023   case lltok::kw_trunc:
4024   case lltok::kw_zext:
4025   case lltok::kw_sext:
4026   case lltok::kw_fptrunc:
4027   case lltok::kw_fpext:
4028   case lltok::kw_bitcast:
4029   case lltok::kw_addrspacecast:
4030   case lltok::kw_uitofp:
4031   case lltok::kw_sitofp:
4032   case lltok::kw_fptoui:
4033   case lltok::kw_fptosi:
4034   case lltok::kw_inttoptr:
4035   case lltok::kw_ptrtoint:       return ParseCast(Inst, PFS, KeywordVal);
4036   // Other.
4037   case lltok::kw_select:         return ParseSelect(Inst, PFS);
4038   case lltok::kw_va_arg:         return ParseVA_Arg(Inst, PFS);
4039   case lltok::kw_extractelement: return ParseExtractElement(Inst, PFS);
4040   case lltok::kw_insertelement:  return ParseInsertElement(Inst, PFS);
4041   case lltok::kw_shufflevector:  return ParseShuffleVector(Inst, PFS);
4042   case lltok::kw_phi:            return ParsePHI(Inst, PFS);
4043   case lltok::kw_landingpad:     return ParseLandingPad(Inst, PFS);
4044   // Call.
4045   case lltok::kw_call:     return ParseCall(Inst, PFS, CallInst::TCK_None);
4046   case lltok::kw_tail:     return ParseCall(Inst, PFS, CallInst::TCK_Tail);
4047   case lltok::kw_musttail: return ParseCall(Inst, PFS, CallInst::TCK_MustTail);
4048   // Memory.
4049   case lltok::kw_alloca:         return ParseAlloc(Inst, PFS);
4050   case lltok::kw_load:           return ParseLoad(Inst, PFS);
4051   case lltok::kw_store:          return ParseStore(Inst, PFS);
4052   case lltok::kw_cmpxchg:        return ParseCmpXchg(Inst, PFS);
4053   case lltok::kw_atomicrmw:      return ParseAtomicRMW(Inst, PFS);
4054   case lltok::kw_fence:          return ParseFence(Inst, PFS);
4055   case lltok::kw_getelementptr: return ParseGetElementPtr(Inst, PFS);
4056   case lltok::kw_extractvalue:  return ParseExtractValue(Inst, PFS);
4057   case lltok::kw_insertvalue:   return ParseInsertValue(Inst, PFS);
4058   }
4059 }
4060
4061 /// ParseCmpPredicate - Parse an integer or fp predicate, based on Kind.
4062 bool LLParser::ParseCmpPredicate(unsigned &P, unsigned Opc) {
4063   if (Opc == Instruction::FCmp) {
4064     switch (Lex.getKind()) {
4065     default: return TokError("expected fcmp predicate (e.g. 'oeq')");
4066     case lltok::kw_oeq: P = CmpInst::FCMP_OEQ; break;
4067     case lltok::kw_one: P = CmpInst::FCMP_ONE; break;
4068     case lltok::kw_olt: P = CmpInst::FCMP_OLT; break;
4069     case lltok::kw_ogt: P = CmpInst::FCMP_OGT; break;
4070     case lltok::kw_ole: P = CmpInst::FCMP_OLE; break;
4071     case lltok::kw_oge: P = CmpInst::FCMP_OGE; break;
4072     case lltok::kw_ord: P = CmpInst::FCMP_ORD; break;
4073     case lltok::kw_uno: P = CmpInst::FCMP_UNO; break;
4074     case lltok::kw_ueq: P = CmpInst::FCMP_UEQ; break;
4075     case lltok::kw_une: P = CmpInst::FCMP_UNE; break;
4076     case lltok::kw_ult: P = CmpInst::FCMP_ULT; break;
4077     case lltok::kw_ugt: P = CmpInst::FCMP_UGT; break;
4078     case lltok::kw_ule: P = CmpInst::FCMP_ULE; break;
4079     case lltok::kw_uge: P = CmpInst::FCMP_UGE; break;
4080     case lltok::kw_true: P = CmpInst::FCMP_TRUE; break;
4081     case lltok::kw_false: P = CmpInst::FCMP_FALSE; break;
4082     }
4083   } else {
4084     switch (Lex.getKind()) {
4085     default: return TokError("expected icmp predicate (e.g. 'eq')");
4086     case lltok::kw_eq:  P = CmpInst::ICMP_EQ; break;
4087     case lltok::kw_ne:  P = CmpInst::ICMP_NE; break;
4088     case lltok::kw_slt: P = CmpInst::ICMP_SLT; break;
4089     case lltok::kw_sgt: P = CmpInst::ICMP_SGT; break;
4090     case lltok::kw_sle: P = CmpInst::ICMP_SLE; break;
4091     case lltok::kw_sge: P = CmpInst::ICMP_SGE; break;
4092     case lltok::kw_ult: P = CmpInst::ICMP_ULT; break;
4093     case lltok::kw_ugt: P = CmpInst::ICMP_UGT; break;
4094     case lltok::kw_ule: P = CmpInst::ICMP_ULE; break;
4095     case lltok::kw_uge: P = CmpInst::ICMP_UGE; break;
4096     }
4097   }
4098   Lex.Lex();
4099   return false;
4100 }
4101
4102 //===----------------------------------------------------------------------===//
4103 // Terminator Instructions.
4104 //===----------------------------------------------------------------------===//
4105
4106 /// ParseRet - Parse a return instruction.
4107 ///   ::= 'ret' void (',' !dbg, !1)*
4108 ///   ::= 'ret' TypeAndValue (',' !dbg, !1)*
4109 bool LLParser::ParseRet(Instruction *&Inst, BasicBlock *BB,
4110                         PerFunctionState &PFS) {
4111   SMLoc TypeLoc = Lex.getLoc();
4112   Type *Ty = nullptr;
4113   if (ParseType(Ty, true /*void allowed*/)) return true;
4114
4115   Type *ResType = PFS.getFunction().getReturnType();
4116
4117   if (Ty->isVoidTy()) {
4118     if (!ResType->isVoidTy())
4119       return Error(TypeLoc, "value doesn't match function result type '" +
4120                    getTypeString(ResType) + "'");
4121
4122     Inst = ReturnInst::Create(Context);
4123     return false;
4124   }
4125
4126   Value *RV;
4127   if (ParseValue(Ty, RV, PFS)) return true;
4128
4129   if (ResType != RV->getType())
4130     return Error(TypeLoc, "value doesn't match function result type '" +
4131                  getTypeString(ResType) + "'");
4132
4133   Inst = ReturnInst::Create(Context, RV);
4134   return false;
4135 }
4136
4137
4138 /// ParseBr
4139 ///   ::= 'br' TypeAndValue
4140 ///   ::= 'br' TypeAndValue ',' TypeAndValue ',' TypeAndValue
4141 bool LLParser::ParseBr(Instruction *&Inst, PerFunctionState &PFS) {
4142   LocTy Loc, Loc2;
4143   Value *Op0;
4144   BasicBlock *Op1, *Op2;
4145   if (ParseTypeAndValue(Op0, Loc, PFS)) return true;
4146
4147   if (BasicBlock *BB = dyn_cast<BasicBlock>(Op0)) {
4148     Inst = BranchInst::Create(BB);
4149     return false;
4150   }
4151
4152   if (Op0->getType() != Type::getInt1Ty(Context))
4153     return Error(Loc, "branch condition must have 'i1' type");
4154
4155   if (ParseToken(lltok::comma, "expected ',' after branch condition") ||
4156       ParseTypeAndBasicBlock(Op1, Loc, PFS) ||
4157       ParseToken(lltok::comma, "expected ',' after true destination") ||
4158       ParseTypeAndBasicBlock(Op2, Loc2, PFS))
4159     return true;
4160
4161   Inst = BranchInst::Create(Op1, Op2, Op0);
4162   return false;
4163 }
4164
4165 /// ParseSwitch
4166 ///  Instruction
4167 ///    ::= 'switch' TypeAndValue ',' TypeAndValue '[' JumpTable ']'
4168 ///  JumpTable
4169 ///    ::= (TypeAndValue ',' TypeAndValue)*
4170 bool LLParser::ParseSwitch(Instruction *&Inst, PerFunctionState &PFS) {
4171   LocTy CondLoc, BBLoc;
4172   Value *Cond;
4173   BasicBlock *DefaultBB;
4174   if (ParseTypeAndValue(Cond, CondLoc, PFS) ||
4175       ParseToken(lltok::comma, "expected ',' after switch condition") ||
4176       ParseTypeAndBasicBlock(DefaultBB, BBLoc, PFS) ||
4177       ParseToken(lltok::lsquare, "expected '[' with switch table"))
4178     return true;
4179
4180   if (!Cond->getType()->isIntegerTy())
4181     return Error(CondLoc, "switch condition must have integer type");
4182
4183   // Parse the jump table pairs.
4184   SmallPtrSet<Value*, 32> SeenCases;
4185   SmallVector<std::pair<ConstantInt*, BasicBlock*>, 32> Table;
4186   while (Lex.getKind() != lltok::rsquare) {
4187     Value *Constant;
4188     BasicBlock *DestBB;
4189
4190     if (ParseTypeAndValue(Constant, CondLoc, PFS) ||
4191         ParseToken(lltok::comma, "expected ',' after case value") ||
4192         ParseTypeAndBasicBlock(DestBB, PFS))
4193       return true;
4194
4195     if (!SeenCases.insert(Constant).second)
4196       return Error(CondLoc, "duplicate case value in switch");
4197     if (!isa<ConstantInt>(Constant))
4198       return Error(CondLoc, "case value is not a constant integer");
4199
4200     Table.push_back(std::make_pair(cast<ConstantInt>(Constant), DestBB));
4201   }
4202
4203   Lex.Lex();  // Eat the ']'.
4204
4205   SwitchInst *SI = SwitchInst::Create(Cond, DefaultBB, Table.size());
4206   for (unsigned i = 0, e = Table.size(); i != e; ++i)
4207     SI->addCase(Table[i].first, Table[i].second);
4208   Inst = SI;
4209   return false;
4210 }
4211
4212 /// ParseIndirectBr
4213 ///  Instruction
4214 ///    ::= 'indirectbr' TypeAndValue ',' '[' LabelList ']'
4215 bool LLParser::ParseIndirectBr(Instruction *&Inst, PerFunctionState &PFS) {
4216   LocTy AddrLoc;
4217   Value *Address;
4218   if (ParseTypeAndValue(Address, AddrLoc, PFS) ||
4219       ParseToken(lltok::comma, "expected ',' after indirectbr address") ||
4220       ParseToken(lltok::lsquare, "expected '[' with indirectbr"))
4221     return true;
4222
4223   if (!Address->getType()->isPointerTy())
4224     return Error(AddrLoc, "indirectbr address must have pointer type");
4225
4226   // Parse the destination list.
4227   SmallVector<BasicBlock*, 16> DestList;
4228
4229   if (Lex.getKind() != lltok::rsquare) {
4230     BasicBlock *DestBB;
4231     if (ParseTypeAndBasicBlock(DestBB, PFS))
4232       return true;
4233     DestList.push_back(DestBB);
4234
4235     while (EatIfPresent(lltok::comma)) {
4236       if (ParseTypeAndBasicBlock(DestBB, PFS))
4237         return true;
4238       DestList.push_back(DestBB);
4239     }
4240   }
4241
4242   if (ParseToken(lltok::rsquare, "expected ']' at end of block list"))
4243     return true;
4244
4245   IndirectBrInst *IBI = IndirectBrInst::Create(Address, DestList.size());
4246   for (unsigned i = 0, e = DestList.size(); i != e; ++i)
4247     IBI->addDestination(DestList[i]);
4248   Inst = IBI;
4249   return false;
4250 }
4251
4252
4253 /// ParseInvoke
4254 ///   ::= 'invoke' OptionalCallingConv OptionalAttrs Type Value ParamList
4255 ///       OptionalAttrs 'to' TypeAndValue 'unwind' TypeAndValue
4256 bool LLParser::ParseInvoke(Instruction *&Inst, PerFunctionState &PFS) {
4257   LocTy CallLoc = Lex.getLoc();
4258   AttrBuilder RetAttrs, FnAttrs;
4259   std::vector<unsigned> FwdRefAttrGrps;
4260   LocTy NoBuiltinLoc;
4261   unsigned CC;
4262   Type *RetType = nullptr;
4263   LocTy RetTypeLoc;
4264   ValID CalleeID;
4265   SmallVector<ParamInfo, 16> ArgList;
4266
4267   BasicBlock *NormalBB, *UnwindBB;
4268   if (ParseOptionalCallingConv(CC) ||
4269       ParseOptionalReturnAttrs(RetAttrs) ||
4270       ParseType(RetType, RetTypeLoc, true /*void allowed*/) ||
4271       ParseValID(CalleeID) ||
4272       ParseParameterList(ArgList, PFS) ||
4273       ParseFnAttributeValuePairs(FnAttrs, FwdRefAttrGrps, false,
4274                                  NoBuiltinLoc) ||
4275       ParseToken(lltok::kw_to, "expected 'to' in invoke") ||
4276       ParseTypeAndBasicBlock(NormalBB, PFS) ||
4277       ParseToken(lltok::kw_unwind, "expected 'unwind' in invoke") ||
4278       ParseTypeAndBasicBlock(UnwindBB, PFS))
4279     return true;
4280
4281   // If RetType is a non-function pointer type, then this is the short syntax
4282   // for the call, which means that RetType is just the return type.  Infer the
4283   // rest of the function argument types from the arguments that are present.
4284   PointerType *PFTy = nullptr;
4285   FunctionType *Ty = nullptr;
4286   if (!(PFTy = dyn_cast<PointerType>(RetType)) ||
4287       !(Ty = dyn_cast<FunctionType>(PFTy->getElementType()))) {
4288     // Pull out the types of all of the arguments...
4289     std::vector<Type*> ParamTypes;
4290     for (unsigned i = 0, e = ArgList.size(); i != e; ++i)
4291       ParamTypes.push_back(ArgList[i].V->getType());
4292
4293     if (!FunctionType::isValidReturnType(RetType))
4294       return Error(RetTypeLoc, "Invalid result type for LLVM function");
4295
4296     Ty = FunctionType::get(RetType, ParamTypes, false);
4297     PFTy = PointerType::getUnqual(Ty);
4298   }
4299
4300   // Look up the callee.
4301   Value *Callee;
4302   if (ConvertValIDToValue(PFTy, CalleeID, Callee, &PFS)) return true;
4303
4304   // Set up the Attribute for the function.
4305   SmallVector<AttributeSet, 8> Attrs;
4306   if (RetAttrs.hasAttributes())
4307     Attrs.push_back(AttributeSet::get(RetType->getContext(),
4308                                       AttributeSet::ReturnIndex,
4309                                       RetAttrs));
4310
4311   SmallVector<Value*, 8> Args;
4312
4313   // Loop through FunctionType's arguments and ensure they are specified
4314   // correctly.  Also, gather any parameter attributes.
4315   FunctionType::param_iterator I = Ty->param_begin();
4316   FunctionType::param_iterator E = Ty->param_end();
4317   for (unsigned i = 0, e = ArgList.size(); i != e; ++i) {
4318     Type *ExpectedTy = nullptr;
4319     if (I != E) {
4320       ExpectedTy = *I++;
4321     } else if (!Ty->isVarArg()) {
4322       return Error(ArgList[i].Loc, "too many arguments specified");
4323     }
4324
4325     if (ExpectedTy && ExpectedTy != ArgList[i].V->getType())
4326       return Error(ArgList[i].Loc, "argument is not of expected type '" +
4327                    getTypeString(ExpectedTy) + "'");
4328     Args.push_back(ArgList[i].V);
4329     if (ArgList[i].Attrs.hasAttributes(i + 1)) {
4330       AttrBuilder B(ArgList[i].Attrs, i + 1);
4331       Attrs.push_back(AttributeSet::get(RetType->getContext(), i + 1, B));
4332     }
4333   }
4334
4335   if (I != E)
4336     return Error(CallLoc, "not enough parameters specified for call");
4337
4338   if (FnAttrs.hasAttributes())
4339     Attrs.push_back(AttributeSet::get(RetType->getContext(),
4340                                       AttributeSet::FunctionIndex,
4341                                       FnAttrs));
4342
4343   // Finish off the Attribute and check them
4344   AttributeSet PAL = AttributeSet::get(Context, Attrs);
4345
4346   InvokeInst *II = InvokeInst::Create(Callee, NormalBB, UnwindBB, Args);
4347   II->setCallingConv(CC);
4348   II->setAttributes(PAL);
4349   ForwardRefAttrGroups[II] = FwdRefAttrGrps;
4350   Inst = II;
4351   return false;
4352 }
4353
4354 /// ParseResume
4355 ///   ::= 'resume' TypeAndValue
4356 bool LLParser::ParseResume(Instruction *&Inst, PerFunctionState &PFS) {
4357   Value *Exn; LocTy ExnLoc;
4358   if (ParseTypeAndValue(Exn, ExnLoc, PFS))
4359     return true;
4360
4361   ResumeInst *RI = ResumeInst::Create(Exn);
4362   Inst = RI;
4363   return false;
4364 }
4365
4366 //===----------------------------------------------------------------------===//
4367 // Binary Operators.
4368 //===----------------------------------------------------------------------===//
4369
4370 /// ParseArithmetic
4371 ///  ::= ArithmeticOps TypeAndValue ',' Value
4372 ///
4373 /// If OperandType is 0, then any FP or integer operand is allowed.  If it is 1,
4374 /// then any integer operand is allowed, if it is 2, any fp operand is allowed.
4375 bool LLParser::ParseArithmetic(Instruction *&Inst, PerFunctionState &PFS,
4376                                unsigned Opc, unsigned OperandType) {
4377   LocTy Loc; Value *LHS, *RHS;
4378   if (ParseTypeAndValue(LHS, Loc, PFS) ||
4379       ParseToken(lltok::comma, "expected ',' in arithmetic operation") ||
4380       ParseValue(LHS->getType(), RHS, PFS))
4381     return true;
4382
4383   bool Valid;
4384   switch (OperandType) {
4385   default: llvm_unreachable("Unknown operand type!");
4386   case 0: // int or FP.
4387     Valid = LHS->getType()->isIntOrIntVectorTy() ||
4388             LHS->getType()->isFPOrFPVectorTy();
4389     break;
4390   case 1: Valid = LHS->getType()->isIntOrIntVectorTy(); break;
4391   case 2: Valid = LHS->getType()->isFPOrFPVectorTy(); break;
4392   }
4393
4394   if (!Valid)
4395     return Error(Loc, "invalid operand type for instruction");
4396
4397   Inst = BinaryOperator::Create((Instruction::BinaryOps)Opc, LHS, RHS);
4398   return false;
4399 }
4400
4401 /// ParseLogical
4402 ///  ::= ArithmeticOps TypeAndValue ',' Value {
4403 bool LLParser::ParseLogical(Instruction *&Inst, PerFunctionState &PFS,
4404                             unsigned Opc) {
4405   LocTy Loc; Value *LHS, *RHS;
4406   if (ParseTypeAndValue(LHS, Loc, PFS) ||
4407       ParseToken(lltok::comma, "expected ',' in logical operation") ||
4408       ParseValue(LHS->getType(), RHS, PFS))
4409     return true;
4410
4411   if (!LHS->getType()->isIntOrIntVectorTy())
4412     return Error(Loc,"instruction requires integer or integer vector operands");
4413
4414   Inst = BinaryOperator::Create((Instruction::BinaryOps)Opc, LHS, RHS);
4415   return false;
4416 }
4417
4418
4419 /// ParseCompare
4420 ///  ::= 'icmp' IPredicates TypeAndValue ',' Value
4421 ///  ::= 'fcmp' FPredicates TypeAndValue ',' Value
4422 bool LLParser::ParseCompare(Instruction *&Inst, PerFunctionState &PFS,
4423                             unsigned Opc) {
4424   // Parse the integer/fp comparison predicate.
4425   LocTy Loc;
4426   unsigned Pred;
4427   Value *LHS, *RHS;
4428   if (ParseCmpPredicate(Pred, Opc) ||
4429       ParseTypeAndValue(LHS, Loc, PFS) ||
4430       ParseToken(lltok::comma, "expected ',' after compare value") ||
4431       ParseValue(LHS->getType(), RHS, PFS))
4432     return true;
4433
4434   if (Opc == Instruction::FCmp) {
4435     if (!LHS->getType()->isFPOrFPVectorTy())
4436       return Error(Loc, "fcmp requires floating point operands");
4437     Inst = new FCmpInst(CmpInst::Predicate(Pred), LHS, RHS);
4438   } else {
4439     assert(Opc == Instruction::ICmp && "Unknown opcode for CmpInst!");
4440     if (!LHS->getType()->isIntOrIntVectorTy() &&
4441         !LHS->getType()->getScalarType()->isPointerTy())
4442       return Error(Loc, "icmp requires integer operands");
4443     Inst = new ICmpInst(CmpInst::Predicate(Pred), LHS, RHS);
4444   }
4445   return false;
4446 }
4447
4448 //===----------------------------------------------------------------------===//
4449 // Other Instructions.
4450 //===----------------------------------------------------------------------===//
4451
4452
4453 /// ParseCast
4454 ///   ::= CastOpc TypeAndValue 'to' Type
4455 bool LLParser::ParseCast(Instruction *&Inst, PerFunctionState &PFS,
4456                          unsigned Opc) {
4457   LocTy Loc;
4458   Value *Op;
4459   Type *DestTy = nullptr;
4460   if (ParseTypeAndValue(Op, Loc, PFS) ||
4461       ParseToken(lltok::kw_to, "expected 'to' after cast value") ||
4462       ParseType(DestTy))
4463     return true;
4464
4465   if (!CastInst::castIsValid((Instruction::CastOps)Opc, Op, DestTy)) {
4466     CastInst::castIsValid((Instruction::CastOps)Opc, Op, DestTy);
4467     return Error(Loc, "invalid cast opcode for cast from '" +
4468                  getTypeString(Op->getType()) + "' to '" +
4469                  getTypeString(DestTy) + "'");
4470   }
4471   Inst = CastInst::Create((Instruction::CastOps)Opc, Op, DestTy);
4472   return false;
4473 }
4474
4475 /// ParseSelect
4476 ///   ::= 'select' TypeAndValue ',' TypeAndValue ',' TypeAndValue
4477 bool LLParser::ParseSelect(Instruction *&Inst, PerFunctionState &PFS) {
4478   LocTy Loc;
4479   Value *Op0, *Op1, *Op2;
4480   if (ParseTypeAndValue(Op0, Loc, PFS) ||
4481       ParseToken(lltok::comma, "expected ',' after select condition") ||
4482       ParseTypeAndValue(Op1, PFS) ||
4483       ParseToken(lltok::comma, "expected ',' after select value") ||
4484       ParseTypeAndValue(Op2, PFS))
4485     return true;
4486
4487   if (const char *Reason = SelectInst::areInvalidOperands(Op0, Op1, Op2))
4488     return Error(Loc, Reason);
4489
4490   Inst = SelectInst::Create(Op0, Op1, Op2);
4491   return false;
4492 }
4493
4494 /// ParseVA_Arg
4495 ///   ::= 'va_arg' TypeAndValue ',' Type
4496 bool LLParser::ParseVA_Arg(Instruction *&Inst, PerFunctionState &PFS) {
4497   Value *Op;
4498   Type *EltTy = nullptr;
4499   LocTy TypeLoc;
4500   if (ParseTypeAndValue(Op, PFS) ||
4501       ParseToken(lltok::comma, "expected ',' after vaarg operand") ||
4502       ParseType(EltTy, TypeLoc))
4503     return true;
4504
4505   if (!EltTy->isFirstClassType())
4506     return Error(TypeLoc, "va_arg requires operand with first class type");
4507
4508   Inst = new VAArgInst(Op, EltTy);
4509   return false;
4510 }
4511
4512 /// ParseExtractElement
4513 ///   ::= 'extractelement' TypeAndValue ',' TypeAndValue
4514 bool LLParser::ParseExtractElement(Instruction *&Inst, PerFunctionState &PFS) {
4515   LocTy Loc;
4516   Value *Op0, *Op1;
4517   if (ParseTypeAndValue(Op0, Loc, PFS) ||
4518       ParseToken(lltok::comma, "expected ',' after extract value") ||
4519       ParseTypeAndValue(Op1, PFS))
4520     return true;
4521
4522   if (!ExtractElementInst::isValidOperands(Op0, Op1))
4523     return Error(Loc, "invalid extractelement operands");
4524
4525   Inst = ExtractElementInst::Create(Op0, Op1);
4526   return false;
4527 }
4528
4529 /// ParseInsertElement
4530 ///   ::= 'insertelement' TypeAndValue ',' TypeAndValue ',' TypeAndValue
4531 bool LLParser::ParseInsertElement(Instruction *&Inst, PerFunctionState &PFS) {
4532   LocTy Loc;
4533   Value *Op0, *Op1, *Op2;
4534   if (ParseTypeAndValue(Op0, Loc, PFS) ||
4535       ParseToken(lltok::comma, "expected ',' after insertelement value") ||
4536       ParseTypeAndValue(Op1, PFS) ||
4537       ParseToken(lltok::comma, "expected ',' after insertelement value") ||
4538       ParseTypeAndValue(Op2, PFS))
4539     return true;
4540
4541   if (!InsertElementInst::isValidOperands(Op0, Op1, Op2))
4542     return Error(Loc, "invalid insertelement operands");
4543
4544   Inst = InsertElementInst::Create(Op0, Op1, Op2);
4545   return false;
4546 }
4547
4548 /// ParseShuffleVector
4549 ///   ::= 'shufflevector' TypeAndValue ',' TypeAndValue ',' TypeAndValue
4550 bool LLParser::ParseShuffleVector(Instruction *&Inst, PerFunctionState &PFS) {
4551   LocTy Loc;
4552   Value *Op0, *Op1, *Op2;
4553   if (ParseTypeAndValue(Op0, Loc, PFS) ||
4554       ParseToken(lltok::comma, "expected ',' after shuffle mask") ||
4555       ParseTypeAndValue(Op1, PFS) ||
4556       ParseToken(lltok::comma, "expected ',' after shuffle value") ||
4557       ParseTypeAndValue(Op2, PFS))
4558     return true;
4559
4560   if (!ShuffleVectorInst::isValidOperands(Op0, Op1, Op2))
4561     return Error(Loc, "invalid shufflevector operands");
4562
4563   Inst = new ShuffleVectorInst(Op0, Op1, Op2);
4564   return false;
4565 }
4566
4567 /// ParsePHI
4568 ///   ::= 'phi' Type '[' Value ',' Value ']' (',' '[' Value ',' Value ']')*
4569 int LLParser::ParsePHI(Instruction *&Inst, PerFunctionState &PFS) {
4570   Type *Ty = nullptr;  LocTy TypeLoc;
4571   Value *Op0, *Op1;
4572
4573   if (ParseType(Ty, TypeLoc) ||
4574       ParseToken(lltok::lsquare, "expected '[' in phi value list") ||
4575       ParseValue(Ty, Op0, PFS) ||
4576       ParseToken(lltok::comma, "expected ',' after insertelement value") ||
4577       ParseValue(Type::getLabelTy(Context), Op1, PFS) ||
4578       ParseToken(lltok::rsquare, "expected ']' in phi value list"))
4579     return true;
4580
4581   bool AteExtraComma = false;
4582   SmallVector<std::pair<Value*, BasicBlock*>, 16> PHIVals;
4583   while (1) {
4584     PHIVals.push_back(std::make_pair(Op0, cast<BasicBlock>(Op1)));
4585
4586     if (!EatIfPresent(lltok::comma))
4587       break;
4588
4589     if (Lex.getKind() == lltok::MetadataVar) {
4590       AteExtraComma = true;
4591       break;
4592     }
4593
4594     if (ParseToken(lltok::lsquare, "expected '[' in phi value list") ||
4595         ParseValue(Ty, Op0, PFS) ||
4596         ParseToken(lltok::comma, "expected ',' after insertelement value") ||
4597         ParseValue(Type::getLabelTy(Context), Op1, PFS) ||
4598         ParseToken(lltok::rsquare, "expected ']' in phi value list"))
4599       return true;
4600   }
4601
4602   if (!Ty->isFirstClassType())
4603     return Error(TypeLoc, "phi node must have first class type");
4604
4605   PHINode *PN = PHINode::Create(Ty, PHIVals.size());
4606   for (unsigned i = 0, e = PHIVals.size(); i != e; ++i)
4607     PN->addIncoming(PHIVals[i].first, PHIVals[i].second);
4608   Inst = PN;
4609   return AteExtraComma ? InstExtraComma : InstNormal;
4610 }
4611
4612 /// ParseLandingPad
4613 ///   ::= 'landingpad' Type 'personality' TypeAndValue 'cleanup'? Clause+
4614 /// Clause
4615 ///   ::= 'catch' TypeAndValue
4616 ///   ::= 'filter'
4617 ///   ::= 'filter' TypeAndValue ( ',' TypeAndValue )*
4618 bool LLParser::ParseLandingPad(Instruction *&Inst, PerFunctionState &PFS) {
4619   Type *Ty = nullptr; LocTy TyLoc;
4620   Value *PersFn; LocTy PersFnLoc;
4621
4622   if (ParseType(Ty, TyLoc) ||
4623       ParseToken(lltok::kw_personality, "expected 'personality'") ||
4624       ParseTypeAndValue(PersFn, PersFnLoc, PFS))
4625     return true;
4626
4627   LandingPadInst *LP = LandingPadInst::Create(Ty, PersFn, 0);
4628   LP->setCleanup(EatIfPresent(lltok::kw_cleanup));
4629
4630   while (Lex.getKind() == lltok::kw_catch || Lex.getKind() == lltok::kw_filter){
4631     LandingPadInst::ClauseType CT;
4632     if (EatIfPresent(lltok::kw_catch))
4633       CT = LandingPadInst::Catch;
4634     else if (EatIfPresent(lltok::kw_filter))
4635       CT = LandingPadInst::Filter;
4636     else
4637       return TokError("expected 'catch' or 'filter' clause type");
4638
4639     Value *V;
4640     LocTy VLoc;
4641     if (ParseTypeAndValue(V, VLoc, PFS)) {
4642       delete LP;
4643       return true;
4644     }
4645
4646     // A 'catch' type expects a non-array constant. A filter clause expects an
4647     // array constant.
4648     if (CT == LandingPadInst::Catch) {
4649       if (isa<ArrayType>(V->getType()))
4650         Error(VLoc, "'catch' clause has an invalid type");
4651     } else {
4652       if (!isa<ArrayType>(V->getType()))
4653         Error(VLoc, "'filter' clause has an invalid type");
4654     }
4655
4656     LP->addClause(cast<Constant>(V));
4657   }
4658
4659   Inst = LP;
4660   return false;
4661 }
4662
4663 /// ParseCall
4664 ///   ::= 'call' OptionalCallingConv OptionalAttrs Type Value
4665 ///       ParameterList OptionalAttrs
4666 ///   ::= 'tail' 'call' OptionalCallingConv OptionalAttrs Type Value
4667 ///       ParameterList OptionalAttrs
4668 ///   ::= 'musttail' 'call' OptionalCallingConv OptionalAttrs Type Value
4669 ///       ParameterList OptionalAttrs
4670 bool LLParser::ParseCall(Instruction *&Inst, PerFunctionState &PFS,
4671                          CallInst::TailCallKind TCK) {
4672   AttrBuilder RetAttrs, FnAttrs;
4673   std::vector<unsigned> FwdRefAttrGrps;
4674   LocTy BuiltinLoc;
4675   unsigned CC;
4676   Type *RetType = nullptr;
4677   LocTy RetTypeLoc;
4678   ValID CalleeID;
4679   SmallVector<ParamInfo, 16> ArgList;
4680   LocTy CallLoc = Lex.getLoc();
4681
4682   if ((TCK != CallInst::TCK_None &&
4683        ParseToken(lltok::kw_call, "expected 'tail call'")) ||
4684       ParseOptionalCallingConv(CC) ||
4685       ParseOptionalReturnAttrs(RetAttrs) ||
4686       ParseType(RetType, RetTypeLoc, true /*void allowed*/) ||
4687       ParseValID(CalleeID) ||
4688       ParseParameterList(ArgList, PFS, TCK == CallInst::TCK_MustTail,
4689                          PFS.getFunction().isVarArg()) ||
4690       ParseFnAttributeValuePairs(FnAttrs, FwdRefAttrGrps, false,
4691                                  BuiltinLoc))
4692     return true;
4693
4694   // If RetType is a non-function pointer type, then this is the short syntax
4695   // for the call, which means that RetType is just the return type.  Infer the
4696   // rest of the function argument types from the arguments that are present.
4697   PointerType *PFTy = nullptr;
4698   FunctionType *Ty = nullptr;
4699   if (!(PFTy = dyn_cast<PointerType>(RetType)) ||
4700       !(Ty = dyn_cast<FunctionType>(PFTy->getElementType()))) {
4701     // Pull out the types of all of the arguments...
4702     std::vector<Type*> ParamTypes;
4703     for (unsigned i = 0, e = ArgList.size(); i != e; ++i)
4704       ParamTypes.push_back(ArgList[i].V->getType());
4705
4706     if (!FunctionType::isValidReturnType(RetType))
4707       return Error(RetTypeLoc, "Invalid result type for LLVM function");
4708
4709     Ty = FunctionType::get(RetType, ParamTypes, false);
4710     PFTy = PointerType::getUnqual(Ty);
4711   }
4712
4713   // Look up the callee.
4714   Value *Callee;
4715   if (ConvertValIDToValue(PFTy, CalleeID, Callee, &PFS)) return true;
4716
4717   // Set up the Attribute for the function.
4718   SmallVector<AttributeSet, 8> Attrs;
4719   if (RetAttrs.hasAttributes())
4720     Attrs.push_back(AttributeSet::get(RetType->getContext(),
4721                                       AttributeSet::ReturnIndex,
4722                                       RetAttrs));
4723
4724   SmallVector<Value*, 8> Args;
4725
4726   // Loop through FunctionType's arguments and ensure they are specified
4727   // correctly.  Also, gather any parameter attributes.
4728   FunctionType::param_iterator I = Ty->param_begin();
4729   FunctionType::param_iterator E = Ty->param_end();
4730   for (unsigned i = 0, e = ArgList.size(); i != e; ++i) {
4731     Type *ExpectedTy = nullptr;
4732     if (I != E) {
4733       ExpectedTy = *I++;
4734     } else if (!Ty->isVarArg()) {
4735       return Error(ArgList[i].Loc, "too many arguments specified");
4736     }
4737
4738     if (ExpectedTy && ExpectedTy != ArgList[i].V->getType())
4739       return Error(ArgList[i].Loc, "argument is not of expected type '" +
4740                    getTypeString(ExpectedTy) + "'");
4741     Args.push_back(ArgList[i].V);
4742     if (ArgList[i].Attrs.hasAttributes(i + 1)) {
4743       AttrBuilder B(ArgList[i].Attrs, i + 1);
4744       Attrs.push_back(AttributeSet::get(RetType->getContext(), i + 1, B));
4745     }
4746   }
4747
4748   if (I != E)
4749     return Error(CallLoc, "not enough parameters specified for call");
4750
4751   if (FnAttrs.hasAttributes())
4752     Attrs.push_back(AttributeSet::get(RetType->getContext(),
4753                                       AttributeSet::FunctionIndex,
4754                                       FnAttrs));
4755
4756   // Finish off the Attribute and check them
4757   AttributeSet PAL = AttributeSet::get(Context, Attrs);
4758
4759   CallInst *CI = CallInst::Create(Callee, Args);
4760   CI->setTailCallKind(TCK);
4761   CI->setCallingConv(CC);
4762   CI->setAttributes(PAL);
4763   ForwardRefAttrGroups[CI] = FwdRefAttrGrps;
4764   Inst = CI;
4765   return false;
4766 }
4767
4768 //===----------------------------------------------------------------------===//
4769 // Memory Instructions.
4770 //===----------------------------------------------------------------------===//
4771
4772 /// ParseAlloc
4773 ///   ::= 'alloca' 'inalloca'? Type (',' TypeAndValue)? (',' 'align' i32)?
4774 int LLParser::ParseAlloc(Instruction *&Inst, PerFunctionState &PFS) {
4775   Value *Size = nullptr;
4776   LocTy SizeLoc;
4777   unsigned Alignment = 0;
4778   Type *Ty = nullptr;
4779
4780   bool IsInAlloca = EatIfPresent(lltok::kw_inalloca);
4781
4782   if (ParseType(Ty)) return true;
4783
4784   if (!PointerType::isValidElementType(Ty))
4785     return TokError("pointer to this type is invalid");
4786
4787   bool AteExtraComma = false;
4788   if (EatIfPresent(lltok::comma)) {
4789     if (Lex.getKind() == lltok::kw_align) {
4790       if (ParseOptionalAlignment(Alignment)) return true;
4791     } else if (Lex.getKind() == lltok::MetadataVar) {
4792       AteExtraComma = true;
4793     } else {
4794       if (ParseTypeAndValue(Size, SizeLoc, PFS) ||
4795           ParseOptionalCommaAlign(Alignment, AteExtraComma))
4796         return true;
4797     }
4798   }
4799
4800   if (Size && !Size->getType()->isIntegerTy())
4801     return Error(SizeLoc, "element count must have integer type");
4802
4803   AllocaInst *AI = new AllocaInst(Ty, Size, Alignment);
4804   AI->setUsedWithInAlloca(IsInAlloca);
4805   Inst = AI;
4806   return AteExtraComma ? InstExtraComma : InstNormal;
4807 }
4808
4809 /// ParseLoad
4810 ///   ::= 'load' 'volatile'? TypeAndValue (',' 'align' i32)?
4811 ///   ::= 'load' 'atomic' 'volatile'? TypeAndValue
4812 ///       'singlethread'? AtomicOrdering (',' 'align' i32)?
4813 int LLParser::ParseLoad(Instruction *&Inst, PerFunctionState &PFS) {
4814   Value *Val; LocTy Loc;
4815   unsigned Alignment = 0;
4816   bool AteExtraComma = false;
4817   bool isAtomic = false;
4818   AtomicOrdering Ordering = NotAtomic;
4819   SynchronizationScope Scope = CrossThread;
4820
4821   if (Lex.getKind() == lltok::kw_atomic) {
4822     isAtomic = true;
4823     Lex.Lex();
4824   }
4825
4826   bool isVolatile = false;
4827   if (Lex.getKind() == lltok::kw_volatile) {
4828     isVolatile = true;
4829     Lex.Lex();
4830   }
4831
4832   if (ParseTypeAndValue(Val, Loc, PFS) ||
4833       ParseScopeAndOrdering(isAtomic, Scope, Ordering) ||
4834       ParseOptionalCommaAlign(Alignment, AteExtraComma))
4835     return true;
4836
4837   if (!Val->getType()->isPointerTy() ||
4838       !cast<PointerType>(Val->getType())->getElementType()->isFirstClassType())
4839     return Error(Loc, "load operand must be a pointer to a first class type");
4840   if (isAtomic && !Alignment)
4841     return Error(Loc, "atomic load must have explicit non-zero alignment");
4842   if (Ordering == Release || Ordering == AcquireRelease)
4843     return Error(Loc, "atomic load cannot use Release ordering");
4844
4845   Inst = new LoadInst(Val, "", isVolatile, Alignment, Ordering, Scope);
4846   return AteExtraComma ? InstExtraComma : InstNormal;
4847 }
4848
4849 /// ParseStore
4850
4851 ///   ::= 'store' 'volatile'? TypeAndValue ',' TypeAndValue (',' 'align' i32)?
4852 ///   ::= 'store' 'atomic' 'volatile'? TypeAndValue ',' TypeAndValue
4853 ///       'singlethread'? AtomicOrdering (',' 'align' i32)?
4854 int LLParser::ParseStore(Instruction *&Inst, PerFunctionState &PFS) {
4855   Value *Val, *Ptr; LocTy Loc, PtrLoc;
4856   unsigned Alignment = 0;
4857   bool AteExtraComma = false;
4858   bool isAtomic = false;
4859   AtomicOrdering Ordering = NotAtomic;
4860   SynchronizationScope Scope = CrossThread;
4861
4862   if (Lex.getKind() == lltok::kw_atomic) {
4863     isAtomic = true;
4864     Lex.Lex();
4865   }
4866
4867   bool isVolatile = false;
4868   if (Lex.getKind() == lltok::kw_volatile) {
4869     isVolatile = true;
4870     Lex.Lex();
4871   }
4872
4873   if (ParseTypeAndValue(Val, Loc, PFS) ||
4874       ParseToken(lltok::comma, "expected ',' after store operand") ||
4875       ParseTypeAndValue(Ptr, PtrLoc, PFS) ||
4876       ParseScopeAndOrdering(isAtomic, Scope, Ordering) ||
4877       ParseOptionalCommaAlign(Alignment, AteExtraComma))
4878     return true;
4879
4880   if (!Ptr->getType()->isPointerTy())
4881     return Error(PtrLoc, "store operand must be a pointer");
4882   if (!Val->getType()->isFirstClassType())
4883     return Error(Loc, "store operand must be a first class value");
4884   if (cast<PointerType>(Ptr->getType())->getElementType() != Val->getType())
4885     return Error(Loc, "stored value and pointer type do not match");
4886   if (isAtomic && !Alignment)
4887     return Error(Loc, "atomic store must have explicit non-zero alignment");
4888   if (Ordering == Acquire || Ordering == AcquireRelease)
4889     return Error(Loc, "atomic store cannot use Acquire ordering");
4890
4891   Inst = new StoreInst(Val, Ptr, isVolatile, Alignment, Ordering, Scope);
4892   return AteExtraComma ? InstExtraComma : InstNormal;
4893 }
4894
4895 /// ParseCmpXchg
4896 ///   ::= 'cmpxchg' 'weak'? 'volatile'? TypeAndValue ',' TypeAndValue ','
4897 ///       TypeAndValue 'singlethread'? AtomicOrdering AtomicOrdering
4898 int LLParser::ParseCmpXchg(Instruction *&Inst, PerFunctionState &PFS) {
4899   Value *Ptr, *Cmp, *New; LocTy PtrLoc, CmpLoc, NewLoc;
4900   bool AteExtraComma = false;
4901   AtomicOrdering SuccessOrdering = NotAtomic;
4902   AtomicOrdering FailureOrdering = NotAtomic;
4903   SynchronizationScope Scope = CrossThread;
4904   bool isVolatile = false;
4905   bool isWeak = false;
4906
4907   if (EatIfPresent(lltok::kw_weak))
4908     isWeak = true;
4909
4910   if (EatIfPresent(lltok::kw_volatile))
4911     isVolatile = true;
4912
4913   if (ParseTypeAndValue(Ptr, PtrLoc, PFS) ||
4914       ParseToken(lltok::comma, "expected ',' after cmpxchg address") ||
4915       ParseTypeAndValue(Cmp, CmpLoc, PFS) ||
4916       ParseToken(lltok::comma, "expected ',' after cmpxchg cmp operand") ||
4917       ParseTypeAndValue(New, NewLoc, PFS) ||
4918       ParseScopeAndOrdering(true /*Always atomic*/, Scope, SuccessOrdering) ||
4919       ParseOrdering(FailureOrdering))
4920     return true;
4921
4922   if (SuccessOrdering == Unordered || FailureOrdering == Unordered)
4923     return TokError("cmpxchg cannot be unordered");
4924   if (SuccessOrdering < FailureOrdering)
4925     return TokError("cmpxchg must be at least as ordered on success as failure");
4926   if (FailureOrdering == Release || FailureOrdering == AcquireRelease)
4927     return TokError("cmpxchg failure ordering cannot include release semantics");
4928   if (!Ptr->getType()->isPointerTy())
4929     return Error(PtrLoc, "cmpxchg operand must be a pointer");
4930   if (cast<PointerType>(Ptr->getType())->getElementType() != Cmp->getType())
4931     return Error(CmpLoc, "compare value and pointer type do not match");
4932   if (cast<PointerType>(Ptr->getType())->getElementType() != New->getType())
4933     return Error(NewLoc, "new value and pointer type do not match");
4934   if (!New->getType()->isIntegerTy())
4935     return Error(NewLoc, "cmpxchg operand must be an integer");
4936   unsigned Size = New->getType()->getPrimitiveSizeInBits();
4937   if (Size < 8 || (Size & (Size - 1)))
4938     return Error(NewLoc, "cmpxchg operand must be power-of-two byte-sized"
4939                          " integer");
4940
4941   AtomicCmpXchgInst *CXI = new AtomicCmpXchgInst(
4942       Ptr, Cmp, New, SuccessOrdering, FailureOrdering, Scope);
4943   CXI->setVolatile(isVolatile);
4944   CXI->setWeak(isWeak);
4945   Inst = CXI;
4946   return AteExtraComma ? InstExtraComma : InstNormal;
4947 }
4948
4949 /// ParseAtomicRMW
4950 ///   ::= 'atomicrmw' 'volatile'? BinOp TypeAndValue ',' TypeAndValue
4951 ///       'singlethread'? AtomicOrdering
4952 int LLParser::ParseAtomicRMW(Instruction *&Inst, PerFunctionState &PFS) {
4953   Value *Ptr, *Val; LocTy PtrLoc, ValLoc;
4954   bool AteExtraComma = false;
4955   AtomicOrdering Ordering = NotAtomic;
4956   SynchronizationScope Scope = CrossThread;
4957   bool isVolatile = false;
4958   AtomicRMWInst::BinOp Operation;
4959
4960   if (EatIfPresent(lltok::kw_volatile))
4961     isVolatile = true;
4962
4963   switch (Lex.getKind()) {
4964   default: return TokError("expected binary operation in atomicrmw");
4965   case lltok::kw_xchg: Operation = AtomicRMWInst::Xchg; break;
4966   case lltok::kw_add: Operation = AtomicRMWInst::Add; break;
4967   case lltok::kw_sub: Operation = AtomicRMWInst::Sub; break;
4968   case lltok::kw_and: Operation = AtomicRMWInst::And; break;
4969   case lltok::kw_nand: Operation = AtomicRMWInst::Nand; break;
4970   case lltok::kw_or: Operation = AtomicRMWInst::Or; break;
4971   case lltok::kw_xor: Operation = AtomicRMWInst::Xor; break;
4972   case lltok::kw_max: Operation = AtomicRMWInst::Max; break;
4973   case lltok::kw_min: Operation = AtomicRMWInst::Min; break;
4974   case lltok::kw_umax: Operation = AtomicRMWInst::UMax; break;
4975   case lltok::kw_umin: Operation = AtomicRMWInst::UMin; break;
4976   }
4977   Lex.Lex();  // Eat the operation.
4978
4979   if (ParseTypeAndValue(Ptr, PtrLoc, PFS) ||
4980       ParseToken(lltok::comma, "expected ',' after atomicrmw address") ||
4981       ParseTypeAndValue(Val, ValLoc, PFS) ||
4982       ParseScopeAndOrdering(true /*Always atomic*/, Scope, Ordering))
4983     return true;
4984
4985   if (Ordering == Unordered)
4986     return TokError("atomicrmw cannot be unordered");
4987   if (!Ptr->getType()->isPointerTy())
4988     return Error(PtrLoc, "atomicrmw operand must be a pointer");
4989   if (cast<PointerType>(Ptr->getType())->getElementType() != Val->getType())
4990     return Error(ValLoc, "atomicrmw value and pointer type do not match");
4991   if (!Val->getType()->isIntegerTy())
4992     return Error(ValLoc, "atomicrmw operand must be an integer");
4993   unsigned Size = Val->getType()->getPrimitiveSizeInBits();
4994   if (Size < 8 || (Size & (Size - 1)))
4995     return Error(ValLoc, "atomicrmw operand must be power-of-two byte-sized"
4996                          " integer");
4997
4998   AtomicRMWInst *RMWI =
4999     new AtomicRMWInst(Operation, Ptr, Val, Ordering, Scope);
5000   RMWI->setVolatile(isVolatile);
5001   Inst = RMWI;
5002   return AteExtraComma ? InstExtraComma : InstNormal;
5003 }
5004
5005 /// ParseFence
5006 ///   ::= 'fence' 'singlethread'? AtomicOrdering
5007 int LLParser::ParseFence(Instruction *&Inst, PerFunctionState &PFS) {
5008   AtomicOrdering Ordering = NotAtomic;
5009   SynchronizationScope Scope = CrossThread;
5010   if (ParseScopeAndOrdering(true /*Always atomic*/, Scope, Ordering))
5011     return true;
5012
5013   if (Ordering == Unordered)
5014     return TokError("fence cannot be unordered");
5015   if (Ordering == Monotonic)
5016     return TokError("fence cannot be monotonic");
5017
5018   Inst = new FenceInst(Context, Ordering, Scope);
5019   return InstNormal;
5020 }
5021
5022 /// ParseGetElementPtr
5023 ///   ::= 'getelementptr' 'inbounds'? TypeAndValue (',' TypeAndValue)*
5024 int LLParser::ParseGetElementPtr(Instruction *&Inst, PerFunctionState &PFS) {
5025   Value *Ptr = nullptr;
5026   Value *Val = nullptr;
5027   LocTy Loc, EltLoc;
5028
5029   bool InBounds = EatIfPresent(lltok::kw_inbounds);
5030
5031   if (ParseTypeAndValue(Ptr, Loc, PFS)) return true;
5032
5033   Type *BaseType = Ptr->getType();
5034   PointerType *BasePointerType = dyn_cast<PointerType>(BaseType->getScalarType());
5035   if (!BasePointerType)
5036     return Error(Loc, "base of getelementptr must be a pointer");
5037
5038   SmallVector<Value*, 16> Indices;
5039   bool AteExtraComma = false;
5040   while (EatIfPresent(lltok::comma)) {
5041     if (Lex.getKind() == lltok::MetadataVar) {
5042       AteExtraComma = true;
5043       break;
5044     }
5045     if (ParseTypeAndValue(Val, EltLoc, PFS)) return true;
5046     if (!Val->getType()->getScalarType()->isIntegerTy())
5047       return Error(EltLoc, "getelementptr index must be an integer");
5048     if (Val->getType()->isVectorTy() != Ptr->getType()->isVectorTy())
5049       return Error(EltLoc, "getelementptr index type missmatch");
5050     if (Val->getType()->isVectorTy()) {
5051       unsigned ValNumEl = cast<VectorType>(Val->getType())->getNumElements();
5052       unsigned PtrNumEl = cast<VectorType>(Ptr->getType())->getNumElements();
5053       if (ValNumEl != PtrNumEl)
5054         return Error(EltLoc,
5055           "getelementptr vector index has a wrong number of elements");
5056     }
5057     Indices.push_back(Val);
5058   }
5059
5060   if (!Indices.empty() && !BasePointerType->getElementType()->isSized())
5061     return Error(Loc, "base element of getelementptr must be sized");
5062
5063   if (!GetElementPtrInst::getIndexedType(BaseType, Indices))
5064     return Error(Loc, "invalid getelementptr indices");
5065   Inst = GetElementPtrInst::Create(Ptr, Indices);
5066   if (InBounds)
5067     cast<GetElementPtrInst>(Inst)->setIsInBounds(true);
5068   return AteExtraComma ? InstExtraComma : InstNormal;
5069 }
5070
5071 /// ParseExtractValue
5072 ///   ::= 'extractvalue' TypeAndValue (',' uint32)+
5073 int LLParser::ParseExtractValue(Instruction *&Inst, PerFunctionState &PFS) {
5074   Value *Val; LocTy Loc;
5075   SmallVector<unsigned, 4> Indices;
5076   bool AteExtraComma;
5077   if (ParseTypeAndValue(Val, Loc, PFS) ||
5078       ParseIndexList(Indices, AteExtraComma))
5079     return true;
5080
5081   if (!Val->getType()->isAggregateType())
5082     return Error(Loc, "extractvalue operand must be aggregate type");
5083
5084   if (!ExtractValueInst::getIndexedType(Val->getType(), Indices))
5085     return Error(Loc, "invalid indices for extractvalue");
5086   Inst = ExtractValueInst::Create(Val, Indices);
5087   return AteExtraComma ? InstExtraComma : InstNormal;
5088 }
5089
5090 /// ParseInsertValue
5091 ///   ::= 'insertvalue' TypeAndValue ',' TypeAndValue (',' uint32)+
5092 int LLParser::ParseInsertValue(Instruction *&Inst, PerFunctionState &PFS) {
5093   Value *Val0, *Val1; LocTy Loc0, Loc1;
5094   SmallVector<unsigned, 4> Indices;
5095   bool AteExtraComma;
5096   if (ParseTypeAndValue(Val0, Loc0, PFS) ||
5097       ParseToken(lltok::comma, "expected comma after insertvalue operand") ||
5098       ParseTypeAndValue(Val1, Loc1, PFS) ||
5099       ParseIndexList(Indices, AteExtraComma))
5100     return true;
5101
5102   if (!Val0->getType()->isAggregateType())
5103     return Error(Loc0, "insertvalue operand must be aggregate type");
5104
5105   Type *IndexedType = ExtractValueInst::getIndexedType(Val0->getType(), Indices);
5106   if (!IndexedType)
5107     return Error(Loc0, "invalid indices for insertvalue");
5108   if (IndexedType != Val1->getType())
5109     return Error(Loc1, "insertvalue operand and field disagree in type: '" +
5110                            getTypeString(Val1->getType()) + "' instead of '" +
5111                            getTypeString(IndexedType) + "'");
5112   Inst = InsertValueInst::Create(Val0, Val1, Indices);
5113   return AteExtraComma ? InstExtraComma : InstNormal;
5114 }
5115
5116 //===----------------------------------------------------------------------===//
5117 // Embedded metadata.
5118 //===----------------------------------------------------------------------===//
5119
5120 /// ParseMDNodeVector
5121 ///   ::= { Element (',' Element)* }
5122 /// Element
5123 ///   ::= 'null' | TypeAndValue
5124 bool LLParser::ParseMDNodeVector(SmallVectorImpl<Metadata *> &Elts) {
5125   if (ParseToken(lltok::lbrace, "expected '{' here"))
5126     return true;
5127
5128   // Check for an empty list.
5129   if (EatIfPresent(lltok::rbrace))
5130     return false;
5131
5132   do {
5133     // Null is a special case since it is typeless.
5134     if (EatIfPresent(lltok::kw_null)) {
5135       Elts.push_back(nullptr);
5136       continue;
5137     }
5138
5139     Metadata *MD;
5140     if (ParseMetadata(MD, nullptr))
5141       return true;
5142     Elts.push_back(MD);
5143   } while (EatIfPresent(lltok::comma));
5144
5145   return ParseToken(lltok::rbrace, "expected end of metadata node");
5146 }
5147
5148 //===----------------------------------------------------------------------===//
5149 // Use-list order directives.
5150 //===----------------------------------------------------------------------===//
5151 bool LLParser::sortUseListOrder(Value *V, ArrayRef<unsigned> Indexes,
5152                                 SMLoc Loc) {
5153   if (V->use_empty())
5154     return Error(Loc, "value has no uses");
5155
5156   unsigned NumUses = 0;
5157   SmallDenseMap<const Use *, unsigned, 16> Order;
5158   for (const Use &U : V->uses()) {
5159     if (++NumUses > Indexes.size())
5160       break;
5161     Order[&U] = Indexes[NumUses - 1];
5162   }
5163   if (NumUses < 2)
5164     return Error(Loc, "value only has one use");
5165   if (Order.size() != Indexes.size() || NumUses > Indexes.size())
5166     return Error(Loc, "wrong number of indexes, expected " +
5167                           Twine(std::distance(V->use_begin(), V->use_end())));
5168
5169   V->sortUseList([&](const Use &L, const Use &R) {
5170     return Order.lookup(&L) < Order.lookup(&R);
5171   });
5172   return false;
5173 }
5174
5175 /// ParseUseListOrderIndexes
5176 ///   ::= '{' uint32 (',' uint32)+ '}'
5177 bool LLParser::ParseUseListOrderIndexes(SmallVectorImpl<unsigned> &Indexes) {
5178   SMLoc Loc = Lex.getLoc();
5179   if (ParseToken(lltok::lbrace, "expected '{' here"))
5180     return true;
5181   if (Lex.getKind() == lltok::rbrace)
5182     return Lex.Error("expected non-empty list of uselistorder indexes");
5183
5184   // Use Offset, Max, and IsOrdered to check consistency of indexes.  The
5185   // indexes should be distinct numbers in the range [0, size-1], and should
5186   // not be in order.
5187   unsigned Offset = 0;
5188   unsigned Max = 0;
5189   bool IsOrdered = true;
5190   assert(Indexes.empty() && "Expected empty order vector");
5191   do {
5192     unsigned Index;
5193     if (ParseUInt32(Index))
5194       return true;
5195
5196     // Update consistency checks.
5197     Offset += Index - Indexes.size();
5198     Max = std::max(Max, Index);
5199     IsOrdered &= Index == Indexes.size();
5200
5201     Indexes.push_back(Index);
5202   } while (EatIfPresent(lltok::comma));
5203
5204   if (ParseToken(lltok::rbrace, "expected '}' here"))
5205     return true;
5206
5207   if (Indexes.size() < 2)
5208     return Error(Loc, "expected >= 2 uselistorder indexes");
5209   if (Offset != 0 || Max >= Indexes.size())
5210     return Error(Loc, "expected distinct uselistorder indexes in range [0, size)");
5211   if (IsOrdered)
5212     return Error(Loc, "expected uselistorder indexes to change the order");
5213
5214   return false;
5215 }
5216
5217 /// ParseUseListOrder
5218 ///   ::= 'uselistorder' Type Value ',' UseListOrderIndexes
5219 bool LLParser::ParseUseListOrder(PerFunctionState *PFS) {
5220   SMLoc Loc = Lex.getLoc();
5221   if (ParseToken(lltok::kw_uselistorder, "expected uselistorder directive"))
5222     return true;
5223
5224   Value *V;
5225   SmallVector<unsigned, 16> Indexes;
5226   if (ParseTypeAndValue(V, PFS) ||
5227       ParseToken(lltok::comma, "expected comma in uselistorder directive") ||
5228       ParseUseListOrderIndexes(Indexes))
5229     return true;
5230
5231   return sortUseListOrder(V, Indexes, Loc);
5232 }
5233
5234 /// ParseUseListOrderBB
5235 ///   ::= 'uselistorder_bb' @foo ',' %bar ',' UseListOrderIndexes
5236 bool LLParser::ParseUseListOrderBB() {
5237   assert(Lex.getKind() == lltok::kw_uselistorder_bb);
5238   SMLoc Loc = Lex.getLoc();
5239   Lex.Lex();
5240
5241   ValID Fn, Label;
5242   SmallVector<unsigned, 16> Indexes;
5243   if (ParseValID(Fn) ||
5244       ParseToken(lltok::comma, "expected comma in uselistorder_bb directive") ||
5245       ParseValID(Label) ||
5246       ParseToken(lltok::comma, "expected comma in uselistorder_bb directive") ||
5247       ParseUseListOrderIndexes(Indexes))
5248     return true;
5249
5250   // Check the function.
5251   GlobalValue *GV;
5252   if (Fn.Kind == ValID::t_GlobalName)
5253     GV = M->getNamedValue(Fn.StrVal);
5254   else if (Fn.Kind == ValID::t_GlobalID)
5255     GV = Fn.UIntVal < NumberedVals.size() ? NumberedVals[Fn.UIntVal] : nullptr;
5256   else
5257     return Error(Fn.Loc, "expected function name in uselistorder_bb");
5258   if (!GV)
5259     return Error(Fn.Loc, "invalid function forward reference in uselistorder_bb");
5260   auto *F = dyn_cast<Function>(GV);
5261   if (!F)
5262     return Error(Fn.Loc, "expected function name in uselistorder_bb");
5263   if (F->isDeclaration())
5264     return Error(Fn.Loc, "invalid declaration in uselistorder_bb");
5265
5266   // Check the basic block.
5267   if (Label.Kind == ValID::t_LocalID)
5268     return Error(Label.Loc, "invalid numeric label in uselistorder_bb");
5269   if (Label.Kind != ValID::t_LocalName)
5270     return Error(Label.Loc, "expected basic block name in uselistorder_bb");
5271   Value *V = F->getValueSymbolTable().lookup(Label.StrVal);
5272   if (!V)
5273     return Error(Label.Loc, "invalid basic block in uselistorder_bb");
5274   if (!isa<BasicBlock>(V))
5275     return Error(Label.Loc, "expected basic block in uselistorder_bb");
5276
5277   return sortUseListOrder(V, Indexes, Loc);
5278 }