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