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