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