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