1 //===-- LLParser.cpp - Parser Class ---------------------------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file defines the parser class for .ll files.
12 //===----------------------------------------------------------------------===//
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/DebugInfo.h"
20 #include "llvm/IR/DebugInfoMetadata.h"
21 #include "llvm/IR/DerivedTypes.h"
22 #include "llvm/IR/InlineAsm.h"
23 #include "llvm/IR/Instructions.h"
24 #include "llvm/IR/LLVMContext.h"
25 #include "llvm/IR/Module.h"
26 #include "llvm/IR/Operator.h"
27 #include "llvm/IR/ValueSymbolTable.h"
28 #include "llvm/Support/Dwarf.h"
29 #include "llvm/Support/ErrorHandling.h"
30 #include "llvm/Support/SaveAndRestore.h"
31 #include "llvm/Support/raw_ostream.h"
34 static std::string getTypeString(Type *T) {
36 raw_string_ostream Tmp(Result);
41 /// Run: module ::= toplevelentity*
42 bool LLParser::Run() {
46 return ParseTopLevelEntities() ||
47 ValidateEndOfModule();
50 /// ValidateEndOfModule - Do final validity and sanity checks at the end of the
52 bool LLParser::ValidateEndOfModule() {
53 for (unsigned I = 0, E = InstsWithTBAATag.size(); I < E; I++)
54 UpgradeInstWithTBAATag(InstsWithTBAATag[I]);
56 // Handle any function attribute group forward references.
57 for (std::map<Value*, std::vector<unsigned> >::iterator
58 I = ForwardRefAttrGroups.begin(), E = ForwardRefAttrGroups.end();
61 std::vector<unsigned> &Vec = I->second;
64 for (std::vector<unsigned>::iterator VI = Vec.begin(), VE = Vec.end();
66 B.merge(NumberedAttrBuilders[*VI]);
68 if (Function *Fn = dyn_cast<Function>(V)) {
69 AttributeSet AS = Fn->getAttributes();
70 AttrBuilder FnAttrs(AS.getFnAttributes(), AttributeSet::FunctionIndex);
71 AS = AS.removeAttributes(Context, AttributeSet::FunctionIndex,
72 AS.getFnAttributes());
76 // If the alignment was parsed as an attribute, move to the alignment
78 if (FnAttrs.hasAlignmentAttr()) {
79 Fn->setAlignment(FnAttrs.getAlignment());
80 FnAttrs.removeAttribute(Attribute::Alignment);
83 AS = AS.addAttributes(Context, AttributeSet::FunctionIndex,
84 AttributeSet::get(Context,
85 AttributeSet::FunctionIndex,
87 Fn->setAttributes(AS);
88 } else if (CallInst *CI = dyn_cast<CallInst>(V)) {
89 AttributeSet AS = CI->getAttributes();
90 AttrBuilder FnAttrs(AS.getFnAttributes(), AttributeSet::FunctionIndex);
91 AS = AS.removeAttributes(Context, AttributeSet::FunctionIndex,
92 AS.getFnAttributes());
94 AS = AS.addAttributes(Context, AttributeSet::FunctionIndex,
95 AttributeSet::get(Context,
96 AttributeSet::FunctionIndex,
98 CI->setAttributes(AS);
99 } else if (InvokeInst *II = dyn_cast<InvokeInst>(V)) {
100 AttributeSet AS = II->getAttributes();
101 AttrBuilder FnAttrs(AS.getFnAttributes(), AttributeSet::FunctionIndex);
102 AS = AS.removeAttributes(Context, AttributeSet::FunctionIndex,
103 AS.getFnAttributes());
105 AS = AS.addAttributes(Context, AttributeSet::FunctionIndex,
106 AttributeSet::get(Context,
107 AttributeSet::FunctionIndex,
109 II->setAttributes(AS);
111 llvm_unreachable("invalid object with forward attribute group reference");
115 // If there are entries in ForwardRefBlockAddresses at this point, the
116 // function was never defined.
117 if (!ForwardRefBlockAddresses.empty())
118 return Error(ForwardRefBlockAddresses.begin()->first.Loc,
119 "expected function name in blockaddress");
121 for (const auto &NT : NumberedTypes)
122 if (NT.second.second.isValid())
123 return Error(NT.second.second,
124 "use of undefined type '%" + Twine(NT.first) + "'");
126 for (StringMap<std::pair<Type*, LocTy> >::iterator I =
127 NamedTypes.begin(), E = NamedTypes.end(); I != E; ++I)
128 if (I->second.second.isValid())
129 return Error(I->second.second,
130 "use of undefined type named '" + I->getKey() + "'");
132 if (!ForwardRefComdats.empty())
133 return Error(ForwardRefComdats.begin()->second,
134 "use of undefined comdat '$" +
135 ForwardRefComdats.begin()->first + "'");
137 if (!ForwardRefVals.empty())
138 return Error(ForwardRefVals.begin()->second.second,
139 "use of undefined value '@" + ForwardRefVals.begin()->first +
142 if (!ForwardRefValIDs.empty())
143 return Error(ForwardRefValIDs.begin()->second.second,
144 "use of undefined value '@" +
145 Twine(ForwardRefValIDs.begin()->first) + "'");
147 if (!ForwardRefMDNodes.empty())
148 return Error(ForwardRefMDNodes.begin()->second.second,
149 "use of undefined metadata '!" +
150 Twine(ForwardRefMDNodes.begin()->first) + "'");
152 // Resolve metadata cycles.
153 for (auto &N : NumberedMetadata) {
154 if (N.second && !N.second->isResolved())
155 N.second->resolveCycles();
158 // Look for intrinsic functions and CallInst that need to be upgraded
159 for (Module::iterator FI = M->begin(), FE = M->end(); FI != FE; )
160 UpgradeCallsToIntrinsic(FI++); // must be post-increment, as we remove
162 UpgradeDebugInfo(*M);
167 //===----------------------------------------------------------------------===//
168 // Top-Level Entities
169 //===----------------------------------------------------------------------===//
171 bool LLParser::ParseTopLevelEntities() {
173 switch (Lex.getKind()) {
174 default: return TokError("expected top-level entity");
175 case lltok::Eof: return false;
176 case lltok::kw_declare: if (ParseDeclare()) return true; break;
177 case lltok::kw_define: if (ParseDefine()) return true; break;
178 case lltok::kw_module: if (ParseModuleAsm()) return true; break;
179 case lltok::kw_target: if (ParseTargetDefinition()) return true; break;
180 case lltok::kw_deplibs: if (ParseDepLibs()) return true; break;
181 case lltok::LocalVarID: if (ParseUnnamedType()) return true; break;
182 case lltok::LocalVar: if (ParseNamedType()) return true; break;
183 case lltok::GlobalID: if (ParseUnnamedGlobal()) return true; break;
184 case lltok::GlobalVar: if (ParseNamedGlobal()) return true; break;
185 case lltok::ComdatVar: if (parseComdat()) return true; break;
186 case lltok::exclaim: if (ParseStandaloneMetadata()) return true; break;
187 case lltok::MetadataVar:if (ParseNamedMetadata()) return true; break;
189 // The Global variable production with no name can have many different
190 // optional leading prefixes, the production is:
191 // GlobalVar ::= OptionalLinkage OptionalVisibility OptionalDLLStorageClass
192 // OptionalThreadLocal OptionalAddrSpace OptionalUnNammedAddr
193 // ('constant'|'global') ...
194 case lltok::kw_private: // OptionalLinkage
195 case lltok::kw_internal: // OptionalLinkage
196 case lltok::kw_weak: // OptionalLinkage
197 case lltok::kw_weak_odr: // OptionalLinkage
198 case lltok::kw_linkonce: // OptionalLinkage
199 case lltok::kw_linkonce_odr: // OptionalLinkage
200 case lltok::kw_appending: // OptionalLinkage
201 case lltok::kw_common: // OptionalLinkage
202 case lltok::kw_extern_weak: // OptionalLinkage
203 case lltok::kw_external: // OptionalLinkage
204 case lltok::kw_default: // OptionalVisibility
205 case lltok::kw_hidden: // OptionalVisibility
206 case lltok::kw_protected: // OptionalVisibility
207 case lltok::kw_dllimport: // OptionalDLLStorageClass
208 case lltok::kw_dllexport: // OptionalDLLStorageClass
209 case lltok::kw_thread_local: // OptionalThreadLocal
210 case lltok::kw_addrspace: // OptionalAddrSpace
211 case lltok::kw_constant: // GlobalType
212 case lltok::kw_global: { // GlobalType
213 unsigned Linkage, Visibility, DLLStorageClass;
215 GlobalVariable::ThreadLocalMode TLM;
217 if (ParseOptionalLinkage(Linkage, HasLinkage) ||
218 ParseOptionalVisibility(Visibility) ||
219 ParseOptionalDLLStorageClass(DLLStorageClass) ||
220 ParseOptionalThreadLocal(TLM) ||
221 parseOptionalUnnamedAddr(UnnamedAddr) ||
222 ParseGlobal("", SMLoc(), Linkage, HasLinkage, Visibility,
223 DLLStorageClass, TLM, UnnamedAddr))
228 case lltok::kw_attributes: if (ParseUnnamedAttrGrp()) return true; break;
229 case lltok::kw_uselistorder: if (ParseUseListOrder()) return true; break;
230 case lltok::kw_uselistorder_bb:
231 if (ParseUseListOrderBB()) return true; break;
238 /// ::= 'module' 'asm' STRINGCONSTANT
239 bool LLParser::ParseModuleAsm() {
240 assert(Lex.getKind() == lltok::kw_module);
244 if (ParseToken(lltok::kw_asm, "expected 'module asm'") ||
245 ParseStringConstant(AsmStr)) return true;
247 M->appendModuleInlineAsm(AsmStr);
252 /// ::= 'target' 'triple' '=' STRINGCONSTANT
253 /// ::= 'target' 'datalayout' '=' STRINGCONSTANT
254 bool LLParser::ParseTargetDefinition() {
255 assert(Lex.getKind() == lltok::kw_target);
258 default: return TokError("unknown target property");
259 case lltok::kw_triple:
261 if (ParseToken(lltok::equal, "expected '=' after target triple") ||
262 ParseStringConstant(Str))
264 M->setTargetTriple(Str);
266 case lltok::kw_datalayout:
268 if (ParseToken(lltok::equal, "expected '=' after target datalayout") ||
269 ParseStringConstant(Str))
271 M->setDataLayout(Str);
277 /// ::= 'deplibs' '=' '[' ']'
278 /// ::= 'deplibs' '=' '[' STRINGCONSTANT (',' STRINGCONSTANT)* ']'
279 /// FIXME: Remove in 4.0. Currently parse, but ignore.
280 bool LLParser::ParseDepLibs() {
281 assert(Lex.getKind() == lltok::kw_deplibs);
283 if (ParseToken(lltok::equal, "expected '=' after deplibs") ||
284 ParseToken(lltok::lsquare, "expected '=' after deplibs"))
287 if (EatIfPresent(lltok::rsquare))
292 if (ParseStringConstant(Str)) return true;
293 } while (EatIfPresent(lltok::comma));
295 return ParseToken(lltok::rsquare, "expected ']' at end of list");
298 /// ParseUnnamedType:
299 /// ::= LocalVarID '=' 'type' type
300 bool LLParser::ParseUnnamedType() {
301 LocTy TypeLoc = Lex.getLoc();
302 unsigned TypeID = Lex.getUIntVal();
303 Lex.Lex(); // eat LocalVarID;
305 if (ParseToken(lltok::equal, "expected '=' after name") ||
306 ParseToken(lltok::kw_type, "expected 'type' after '='"))
309 Type *Result = nullptr;
310 if (ParseStructDefinition(TypeLoc, "",
311 NumberedTypes[TypeID], Result)) return true;
313 if (!isa<StructType>(Result)) {
314 std::pair<Type*, LocTy> &Entry = NumberedTypes[TypeID];
316 return Error(TypeLoc, "non-struct types may not be recursive");
317 Entry.first = Result;
318 Entry.second = SMLoc();
326 /// ::= LocalVar '=' 'type' type
327 bool LLParser::ParseNamedType() {
328 std::string Name = Lex.getStrVal();
329 LocTy NameLoc = Lex.getLoc();
330 Lex.Lex(); // eat LocalVar.
332 if (ParseToken(lltok::equal, "expected '=' after name") ||
333 ParseToken(lltok::kw_type, "expected 'type' after name"))
336 Type *Result = nullptr;
337 if (ParseStructDefinition(NameLoc, Name,
338 NamedTypes[Name], Result)) return true;
340 if (!isa<StructType>(Result)) {
341 std::pair<Type*, LocTy> &Entry = NamedTypes[Name];
343 return Error(NameLoc, "non-struct types may not be recursive");
344 Entry.first = Result;
345 Entry.second = SMLoc();
353 /// ::= 'declare' FunctionHeader
354 bool LLParser::ParseDeclare() {
355 assert(Lex.getKind() == lltok::kw_declare);
359 return ParseFunctionHeader(F, false);
363 /// ::= 'define' FunctionHeader '{' ...
364 bool LLParser::ParseDefine() {
365 assert(Lex.getKind() == lltok::kw_define);
369 return ParseFunctionHeader(F, true) ||
370 ParseFunctionBody(*F);
376 bool LLParser::ParseGlobalType(bool &IsConstant) {
377 if (Lex.getKind() == lltok::kw_constant)
379 else if (Lex.getKind() == lltok::kw_global)
383 return TokError("expected 'global' or 'constant'");
389 /// ParseUnnamedGlobal:
390 /// OptionalVisibility ALIAS ...
391 /// OptionalLinkage OptionalVisibility OptionalDLLStorageClass
392 /// ... -> global variable
393 /// GlobalID '=' OptionalVisibility ALIAS ...
394 /// GlobalID '=' OptionalLinkage OptionalVisibility OptionalDLLStorageClass
395 /// ... -> global variable
396 bool LLParser::ParseUnnamedGlobal() {
397 unsigned VarID = NumberedVals.size();
399 LocTy NameLoc = Lex.getLoc();
401 // Handle the GlobalID form.
402 if (Lex.getKind() == lltok::GlobalID) {
403 if (Lex.getUIntVal() != VarID)
404 return Error(Lex.getLoc(), "variable expected to be numbered '%" +
406 Lex.Lex(); // eat GlobalID;
408 if (ParseToken(lltok::equal, "expected '=' after name"))
413 unsigned Linkage, Visibility, DLLStorageClass;
414 GlobalVariable::ThreadLocalMode TLM;
416 if (ParseOptionalLinkage(Linkage, HasLinkage) ||
417 ParseOptionalVisibility(Visibility) ||
418 ParseOptionalDLLStorageClass(DLLStorageClass) ||
419 ParseOptionalThreadLocal(TLM) ||
420 parseOptionalUnnamedAddr(UnnamedAddr))
423 if (Lex.getKind() != lltok::kw_alias)
424 return ParseGlobal(Name, NameLoc, Linkage, HasLinkage, Visibility,
425 DLLStorageClass, TLM, UnnamedAddr);
426 return ParseAlias(Name, NameLoc, Linkage, Visibility, DLLStorageClass, TLM,
430 /// ParseNamedGlobal:
431 /// GlobalVar '=' OptionalVisibility ALIAS ...
432 /// GlobalVar '=' OptionalLinkage OptionalVisibility OptionalDLLStorageClass
433 /// ... -> global variable
434 bool LLParser::ParseNamedGlobal() {
435 assert(Lex.getKind() == lltok::GlobalVar);
436 LocTy NameLoc = Lex.getLoc();
437 std::string Name = Lex.getStrVal();
441 unsigned Linkage, Visibility, DLLStorageClass;
442 GlobalVariable::ThreadLocalMode TLM;
444 if (ParseToken(lltok::equal, "expected '=' in global variable") ||
445 ParseOptionalLinkage(Linkage, HasLinkage) ||
446 ParseOptionalVisibility(Visibility) ||
447 ParseOptionalDLLStorageClass(DLLStorageClass) ||
448 ParseOptionalThreadLocal(TLM) ||
449 parseOptionalUnnamedAddr(UnnamedAddr))
452 if (Lex.getKind() != lltok::kw_alias)
453 return ParseGlobal(Name, NameLoc, Linkage, HasLinkage, Visibility,
454 DLLStorageClass, TLM, UnnamedAddr);
456 return ParseAlias(Name, NameLoc, Linkage, Visibility, DLLStorageClass, TLM,
460 bool LLParser::parseComdat() {
461 assert(Lex.getKind() == lltok::ComdatVar);
462 std::string Name = Lex.getStrVal();
463 LocTy NameLoc = Lex.getLoc();
466 if (ParseToken(lltok::equal, "expected '=' here"))
469 if (ParseToken(lltok::kw_comdat, "expected comdat keyword"))
470 return TokError("expected comdat type");
472 Comdat::SelectionKind SK;
473 switch (Lex.getKind()) {
475 return TokError("unknown selection kind");
479 case lltok::kw_exactmatch:
480 SK = Comdat::ExactMatch;
482 case lltok::kw_largest:
483 SK = Comdat::Largest;
485 case lltok::kw_noduplicates:
486 SK = Comdat::NoDuplicates;
488 case lltok::kw_samesize:
489 SK = Comdat::SameSize;
494 // See if the comdat was forward referenced, if so, use the comdat.
495 Module::ComdatSymTabType &ComdatSymTab = M->getComdatSymbolTable();
496 Module::ComdatSymTabType::iterator I = ComdatSymTab.find(Name);
497 if (I != ComdatSymTab.end() && !ForwardRefComdats.erase(Name))
498 return Error(NameLoc, "redefinition of comdat '$" + Name + "'");
501 if (I != ComdatSymTab.end())
504 C = M->getOrInsertComdat(Name);
505 C->setSelectionKind(SK);
511 // ::= '!' STRINGCONSTANT
512 bool LLParser::ParseMDString(MDString *&Result) {
514 if (ParseStringConstant(Str)) return true;
515 llvm::UpgradeMDStringConstant(Str);
516 Result = MDString::get(Context, Str);
521 // ::= '!' MDNodeNumber
522 bool LLParser::ParseMDNodeID(MDNode *&Result) {
523 // !{ ..., !42, ... }
525 if (ParseUInt32(MID))
528 // If not a forward reference, just return it now.
529 if (NumberedMetadata.count(MID)) {
530 Result = NumberedMetadata[MID];
534 // Otherwise, create MDNode forward reference.
535 auto &FwdRef = ForwardRefMDNodes[MID];
536 FwdRef = std::make_pair(MDTuple::getTemporary(Context, None), Lex.getLoc());
538 Result = FwdRef.first.get();
539 NumberedMetadata[MID].reset(Result);
543 /// ParseNamedMetadata:
544 /// !foo = !{ !1, !2 }
545 bool LLParser::ParseNamedMetadata() {
546 assert(Lex.getKind() == lltok::MetadataVar);
547 std::string Name = Lex.getStrVal();
550 if (ParseToken(lltok::equal, "expected '=' here") ||
551 ParseToken(lltok::exclaim, "Expected '!' here") ||
552 ParseToken(lltok::lbrace, "Expected '{' here"))
555 NamedMDNode *NMD = M->getOrInsertNamedMetadata(Name);
556 if (Lex.getKind() != lltok::rbrace)
558 if (ParseToken(lltok::exclaim, "Expected '!' here"))
562 if (ParseMDNodeID(N)) return true;
564 } while (EatIfPresent(lltok::comma));
566 if (ParseToken(lltok::rbrace, "expected end of metadata node"))
572 /// ParseStandaloneMetadata:
574 bool LLParser::ParseStandaloneMetadata() {
575 assert(Lex.getKind() == lltok::exclaim);
577 unsigned MetadataID = 0;
580 if (ParseUInt32(MetadataID) ||
581 ParseToken(lltok::equal, "expected '=' here"))
584 // Detect common error, from old metadata syntax.
585 if (Lex.getKind() == lltok::Type)
586 return TokError("unexpected type in metadata definition");
588 bool IsDistinct = EatIfPresent(lltok::kw_distinct);
589 if (Lex.getKind() == lltok::MetadataVar) {
590 if (ParseSpecializedMDNode(Init, IsDistinct))
592 } else if (ParseToken(lltok::exclaim, "Expected '!' here") ||
593 ParseMDTuple(Init, IsDistinct))
596 // See if this was forward referenced, if so, handle it.
597 auto FI = ForwardRefMDNodes.find(MetadataID);
598 if (FI != ForwardRefMDNodes.end()) {
599 FI->second.first->replaceAllUsesWith(Init);
600 ForwardRefMDNodes.erase(FI);
602 assert(NumberedMetadata[MetadataID] == Init && "Tracking VH didn't work");
604 if (NumberedMetadata.count(MetadataID))
605 return TokError("Metadata id is already used");
606 NumberedMetadata[MetadataID].reset(Init);
612 static bool isValidVisibilityForLinkage(unsigned V, unsigned L) {
613 return !GlobalValue::isLocalLinkage((GlobalValue::LinkageTypes)L) ||
614 (GlobalValue::VisibilityTypes)V == GlobalValue::DefaultVisibility;
618 /// ::= GlobalVar '=' OptionalLinkage OptionalVisibility
619 /// OptionalDLLStorageClass OptionalThreadLocal
620 /// OptionalUnNammedAddr 'alias' Aliasee
625 /// Everything through OptionalUnNammedAddr has already been parsed.
627 bool LLParser::ParseAlias(const std::string &Name, LocTy NameLoc, unsigned L,
628 unsigned Visibility, unsigned DLLStorageClass,
629 GlobalVariable::ThreadLocalMode TLM,
631 assert(Lex.getKind() == lltok::kw_alias);
634 GlobalValue::LinkageTypes Linkage = (GlobalValue::LinkageTypes) L;
636 if(!GlobalAlias::isValidLinkage(Linkage))
637 return Error(NameLoc, "invalid linkage type for alias");
639 if (!isValidVisibilityForLinkage(Visibility, L))
640 return Error(NameLoc,
641 "symbol with local linkage must have default visibility");
644 LocTy AliaseeLoc = Lex.getLoc();
645 if (Lex.getKind() != lltok::kw_bitcast &&
646 Lex.getKind() != lltok::kw_getelementptr &&
647 Lex.getKind() != lltok::kw_addrspacecast &&
648 Lex.getKind() != lltok::kw_inttoptr) {
649 if (ParseGlobalTypeAndValue(Aliasee))
652 // The bitcast dest type is not present, it is implied by the dest type.
656 if (ID.Kind != ValID::t_Constant)
657 return Error(AliaseeLoc, "invalid aliasee");
658 Aliasee = ID.ConstantVal;
661 Type *AliaseeType = Aliasee->getType();
662 auto *PTy = dyn_cast<PointerType>(AliaseeType);
664 return Error(AliaseeLoc, "An alias must have pointer type");
665 Type *Ty = PTy->getElementType();
666 unsigned AddrSpace = PTy->getAddressSpace();
668 // Okay, create the alias but do not insert it into the module yet.
669 std::unique_ptr<GlobalAlias> GA(
670 GlobalAlias::create(Ty, AddrSpace, (GlobalValue::LinkageTypes)Linkage,
671 Name, Aliasee, /*Parent*/ nullptr));
672 GA->setThreadLocalMode(TLM);
673 GA->setVisibility((GlobalValue::VisibilityTypes)Visibility);
674 GA->setDLLStorageClass((GlobalValue::DLLStorageClassTypes)DLLStorageClass);
675 GA->setUnnamedAddr(UnnamedAddr);
677 // See if this value already exists in the symbol table. If so, it is either
678 // a redefinition or a definition of a forward reference.
679 if (GlobalValue *Val = M->getNamedValue(Name)) {
680 // See if this was a redefinition. If so, there is no entry in
682 std::map<std::string, std::pair<GlobalValue*, LocTy> >::iterator
683 I = ForwardRefVals.find(Name);
684 if (I == ForwardRefVals.end())
685 return Error(NameLoc, "redefinition of global named '@" + Name + "'");
687 // Otherwise, this was a definition of forward ref. Verify that types
689 if (Val->getType() != GA->getType())
690 return Error(NameLoc,
691 "forward reference and definition of alias have different types");
693 // If they agree, just RAUW the old value with the alias and remove the
695 Val->replaceAllUsesWith(GA.get());
696 Val->eraseFromParent();
697 ForwardRefVals.erase(I);
700 // Insert into the module, we know its name won't collide now.
701 M->getAliasList().push_back(GA.get());
702 assert(GA->getName() == Name && "Should not be a name conflict!");
704 // The module owns this now
711 /// ::= GlobalVar '=' OptionalLinkage OptionalVisibility OptionalDLLStorageClass
712 /// OptionalThreadLocal OptionalUnNammedAddr OptionalAddrSpace
713 /// OptionalExternallyInitialized GlobalType Type Const
714 /// ::= OptionalLinkage OptionalVisibility OptionalDLLStorageClass
715 /// OptionalThreadLocal OptionalUnNammedAddr OptionalAddrSpace
716 /// OptionalExternallyInitialized GlobalType Type Const
718 /// Everything up to and including OptionalUnNammedAddr has been parsed
721 bool LLParser::ParseGlobal(const std::string &Name, LocTy NameLoc,
722 unsigned Linkage, bool HasLinkage,
723 unsigned Visibility, unsigned DLLStorageClass,
724 GlobalVariable::ThreadLocalMode TLM,
726 if (!isValidVisibilityForLinkage(Visibility, Linkage))
727 return Error(NameLoc,
728 "symbol with local linkage must have default visibility");
731 bool IsConstant, IsExternallyInitialized;
732 LocTy IsExternallyInitializedLoc;
736 if (ParseOptionalAddrSpace(AddrSpace) ||
737 ParseOptionalToken(lltok::kw_externally_initialized,
738 IsExternallyInitialized,
739 &IsExternallyInitializedLoc) ||
740 ParseGlobalType(IsConstant) ||
741 ParseType(Ty, TyLoc))
744 // If the linkage is specified and is external, then no initializer is
746 Constant *Init = nullptr;
747 if (!HasLinkage || (Linkage != GlobalValue::ExternalWeakLinkage &&
748 Linkage != GlobalValue::ExternalLinkage)) {
749 if (ParseGlobalValue(Ty, Init))
753 if (Ty->isFunctionTy() || !PointerType::isValidElementType(Ty))
754 return Error(TyLoc, "invalid type for global variable");
756 GlobalValue *GVal = nullptr;
758 // See if the global was forward referenced, if so, use the global.
760 GVal = M->getNamedValue(Name);
762 if (!ForwardRefVals.erase(Name) || !isa<GlobalValue>(GVal))
763 return Error(NameLoc, "redefinition of global '@" + Name + "'");
766 std::map<unsigned, std::pair<GlobalValue*, LocTy> >::iterator
767 I = ForwardRefValIDs.find(NumberedVals.size());
768 if (I != ForwardRefValIDs.end()) {
769 GVal = I->second.first;
770 ForwardRefValIDs.erase(I);
776 GV = new GlobalVariable(*M, Ty, false, GlobalValue::ExternalLinkage, nullptr,
777 Name, nullptr, GlobalVariable::NotThreadLocal,
780 if (GVal->getType()->getElementType() != Ty)
782 "forward reference and definition of global have different types");
784 GV = cast<GlobalVariable>(GVal);
786 // Move the forward-reference to the correct spot in the module.
787 M->getGlobalList().splice(M->global_end(), M->getGlobalList(), GV);
791 NumberedVals.push_back(GV);
793 // Set the parsed properties on the global.
795 GV->setInitializer(Init);
796 GV->setConstant(IsConstant);
797 GV->setLinkage((GlobalValue::LinkageTypes)Linkage);
798 GV->setVisibility((GlobalValue::VisibilityTypes)Visibility);
799 GV->setDLLStorageClass((GlobalValue::DLLStorageClassTypes)DLLStorageClass);
800 GV->setExternallyInitialized(IsExternallyInitialized);
801 GV->setThreadLocalMode(TLM);
802 GV->setUnnamedAddr(UnnamedAddr);
804 // Parse attributes on the global.
805 while (Lex.getKind() == lltok::comma) {
808 if (Lex.getKind() == lltok::kw_section) {
810 GV->setSection(Lex.getStrVal());
811 if (ParseToken(lltok::StringConstant, "expected global section string"))
813 } else if (Lex.getKind() == lltok::kw_align) {
815 if (ParseOptionalAlignment(Alignment)) return true;
816 GV->setAlignment(Alignment);
819 if (parseOptionalComdat(Name, C))
824 return TokError("unknown global variable property!");
831 /// ParseUnnamedAttrGrp
832 /// ::= 'attributes' AttrGrpID '=' '{' AttrValPair+ '}'
833 bool LLParser::ParseUnnamedAttrGrp() {
834 assert(Lex.getKind() == lltok::kw_attributes);
835 LocTy AttrGrpLoc = Lex.getLoc();
838 if (Lex.getKind() != lltok::AttrGrpID)
839 return TokError("expected attribute group id");
841 unsigned VarID = Lex.getUIntVal();
842 std::vector<unsigned> unused;
846 if (ParseToken(lltok::equal, "expected '=' here") ||
847 ParseToken(lltok::lbrace, "expected '{' here") ||
848 ParseFnAttributeValuePairs(NumberedAttrBuilders[VarID], unused, true,
850 ParseToken(lltok::rbrace, "expected end of attribute group"))
853 if (!NumberedAttrBuilders[VarID].hasAttributes())
854 return Error(AttrGrpLoc, "attribute group has no attributes");
859 /// ParseFnAttributeValuePairs
860 /// ::= <attr> | <attr> '=' <value>
861 bool LLParser::ParseFnAttributeValuePairs(AttrBuilder &B,
862 std::vector<unsigned> &FwdRefAttrGrps,
863 bool inAttrGrp, LocTy &BuiltinLoc) {
864 bool HaveError = false;
869 lltok::Kind Token = Lex.getKind();
870 if (Token == lltok::kw_builtin)
871 BuiltinLoc = Lex.getLoc();
874 if (!inAttrGrp) return HaveError;
875 return Error(Lex.getLoc(), "unterminated attribute group");
880 case lltok::AttrGrpID: {
881 // Allow a function to reference an attribute group:
883 // define void @foo() #1 { ... }
887 "cannot have an attribute group reference in an attribute group");
889 unsigned AttrGrpNum = Lex.getUIntVal();
890 if (inAttrGrp) break;
892 // Save the reference to the attribute group. We'll fill it in later.
893 FwdRefAttrGrps.push_back(AttrGrpNum);
896 // Target-dependent attributes:
897 case lltok::StringConstant: {
898 std::string Attr = Lex.getStrVal();
901 if (EatIfPresent(lltok::equal) &&
902 ParseStringConstant(Val))
905 B.addAttribute(Attr, Val);
909 // Target-independent attributes:
910 case lltok::kw_align: {
911 // As a hack, we allow function alignment to be initially parsed as an
912 // attribute on a function declaration/definition or added to an attribute
913 // group and later moved to the alignment field.
917 if (ParseToken(lltok::equal, "expected '=' here") ||
918 ParseUInt32(Alignment))
921 if (ParseOptionalAlignment(Alignment))
924 B.addAlignmentAttr(Alignment);
927 case lltok::kw_alignstack: {
931 if (ParseToken(lltok::equal, "expected '=' here") ||
932 ParseUInt32(Alignment))
935 if (ParseOptionalStackAlignment(Alignment))
938 B.addStackAlignmentAttr(Alignment);
941 case lltok::kw_alwaysinline: B.addAttribute(Attribute::AlwaysInline); break;
942 case lltok::kw_builtin: B.addAttribute(Attribute::Builtin); break;
943 case lltok::kw_cold: B.addAttribute(Attribute::Cold); break;
944 case lltok::kw_inlinehint: B.addAttribute(Attribute::InlineHint); break;
945 case lltok::kw_jumptable: B.addAttribute(Attribute::JumpTable); break;
946 case lltok::kw_minsize: B.addAttribute(Attribute::MinSize); break;
947 case lltok::kw_naked: B.addAttribute(Attribute::Naked); break;
948 case lltok::kw_nobuiltin: B.addAttribute(Attribute::NoBuiltin); break;
949 case lltok::kw_noduplicate: B.addAttribute(Attribute::NoDuplicate); break;
950 case lltok::kw_noimplicitfloat: B.addAttribute(Attribute::NoImplicitFloat); break;
951 case lltok::kw_noinline: B.addAttribute(Attribute::NoInline); break;
952 case lltok::kw_nonlazybind: B.addAttribute(Attribute::NonLazyBind); break;
953 case lltok::kw_noredzone: B.addAttribute(Attribute::NoRedZone); break;
954 case lltok::kw_noreturn: B.addAttribute(Attribute::NoReturn); break;
955 case lltok::kw_nounwind: B.addAttribute(Attribute::NoUnwind); break;
956 case lltok::kw_optnone: B.addAttribute(Attribute::OptimizeNone); break;
957 case lltok::kw_optsize: B.addAttribute(Attribute::OptimizeForSize); break;
958 case lltok::kw_readnone: B.addAttribute(Attribute::ReadNone); break;
959 case lltok::kw_readonly: B.addAttribute(Attribute::ReadOnly); break;
960 case lltok::kw_returns_twice: B.addAttribute(Attribute::ReturnsTwice); break;
961 case lltok::kw_ssp: B.addAttribute(Attribute::StackProtect); break;
962 case lltok::kw_sspreq: B.addAttribute(Attribute::StackProtectReq); break;
963 case lltok::kw_sspstrong: B.addAttribute(Attribute::StackProtectStrong); break;
964 case lltok::kw_sanitize_address: B.addAttribute(Attribute::SanitizeAddress); break;
965 case lltok::kw_sanitize_thread: B.addAttribute(Attribute::SanitizeThread); break;
966 case lltok::kw_sanitize_memory: B.addAttribute(Attribute::SanitizeMemory); break;
967 case lltok::kw_uwtable: B.addAttribute(Attribute::UWTable); break;
970 case lltok::kw_inreg:
971 case lltok::kw_signext:
972 case lltok::kw_zeroext:
975 "invalid use of attribute on a function");
977 case lltok::kw_byval:
978 case lltok::kw_dereferenceable:
979 case lltok::kw_dereferenceable_or_null:
980 case lltok::kw_inalloca:
982 case lltok::kw_noalias:
983 case lltok::kw_nocapture:
984 case lltok::kw_nonnull:
985 case lltok::kw_returned:
989 "invalid use of parameter-only attribute on a function");
997 //===----------------------------------------------------------------------===//
998 // GlobalValue Reference/Resolution Routines.
999 //===----------------------------------------------------------------------===//
1001 /// GetGlobalVal - Get a value with the specified name or ID, creating a
1002 /// forward reference record if needed. This can return null if the value
1003 /// exists but does not have the right type.
1004 GlobalValue *LLParser::GetGlobalVal(const std::string &Name, Type *Ty,
1006 PointerType *PTy = dyn_cast<PointerType>(Ty);
1008 Error(Loc, "global variable reference must have pointer type");
1012 // Look this name up in the normal function symbol table.
1014 cast_or_null<GlobalValue>(M->getValueSymbolTable().lookup(Name));
1016 // If this is a forward reference for the value, see if we already created a
1017 // forward ref record.
1019 std::map<std::string, std::pair<GlobalValue*, LocTy> >::iterator
1020 I = ForwardRefVals.find(Name);
1021 if (I != ForwardRefVals.end())
1022 Val = I->second.first;
1025 // If we have the value in the symbol table or fwd-ref table, return it.
1027 if (Val->getType() == Ty) return Val;
1028 Error(Loc, "'@" + Name + "' defined with type '" +
1029 getTypeString(Val->getType()) + "'");
1033 // Otherwise, create a new forward reference for this value and remember it.
1034 GlobalValue *FwdVal;
1035 if (FunctionType *FT = dyn_cast<FunctionType>(PTy->getElementType()))
1036 FwdVal = Function::Create(FT, GlobalValue::ExternalWeakLinkage, Name, M);
1038 FwdVal = new GlobalVariable(*M, PTy->getElementType(), false,
1039 GlobalValue::ExternalWeakLinkage, nullptr, Name,
1040 nullptr, GlobalVariable::NotThreadLocal,
1041 PTy->getAddressSpace());
1043 ForwardRefVals[Name] = std::make_pair(FwdVal, Loc);
1047 GlobalValue *LLParser::GetGlobalVal(unsigned ID, Type *Ty, LocTy Loc) {
1048 PointerType *PTy = dyn_cast<PointerType>(Ty);
1050 Error(Loc, "global variable reference must have pointer type");
1054 GlobalValue *Val = ID < NumberedVals.size() ? NumberedVals[ID] : nullptr;
1056 // If this is a forward reference for the value, see if we already created a
1057 // forward ref record.
1059 std::map<unsigned, std::pair<GlobalValue*, LocTy> >::iterator
1060 I = ForwardRefValIDs.find(ID);
1061 if (I != ForwardRefValIDs.end())
1062 Val = I->second.first;
1065 // If we have the value in the symbol table or fwd-ref table, return it.
1067 if (Val->getType() == Ty) return Val;
1068 Error(Loc, "'@" + Twine(ID) + "' defined with type '" +
1069 getTypeString(Val->getType()) + "'");
1073 // Otherwise, create a new forward reference for this value and remember it.
1074 GlobalValue *FwdVal;
1075 if (FunctionType *FT = dyn_cast<FunctionType>(PTy->getElementType()))
1076 FwdVal = Function::Create(FT, GlobalValue::ExternalWeakLinkage, "", M);
1078 FwdVal = new GlobalVariable(*M, PTy->getElementType(), false,
1079 GlobalValue::ExternalWeakLinkage, nullptr, "");
1081 ForwardRefValIDs[ID] = std::make_pair(FwdVal, Loc);
1086 //===----------------------------------------------------------------------===//
1087 // Comdat Reference/Resolution Routines.
1088 //===----------------------------------------------------------------------===//
1090 Comdat *LLParser::getComdat(const std::string &Name, LocTy Loc) {
1091 // Look this name up in the comdat symbol table.
1092 Module::ComdatSymTabType &ComdatSymTab = M->getComdatSymbolTable();
1093 Module::ComdatSymTabType::iterator I = ComdatSymTab.find(Name);
1094 if (I != ComdatSymTab.end())
1097 // Otherwise, create a new forward reference for this value and remember it.
1098 Comdat *C = M->getOrInsertComdat(Name);
1099 ForwardRefComdats[Name] = Loc;
1104 //===----------------------------------------------------------------------===//
1106 //===----------------------------------------------------------------------===//
1108 /// ParseToken - If the current token has the specified kind, eat it and return
1109 /// success. Otherwise, emit the specified error and return failure.
1110 bool LLParser::ParseToken(lltok::Kind T, const char *ErrMsg) {
1111 if (Lex.getKind() != T)
1112 return TokError(ErrMsg);
1117 /// ParseStringConstant
1118 /// ::= StringConstant
1119 bool LLParser::ParseStringConstant(std::string &Result) {
1120 if (Lex.getKind() != lltok::StringConstant)
1121 return TokError("expected string constant");
1122 Result = Lex.getStrVal();
1129 bool LLParser::ParseUInt32(unsigned &Val) {
1130 if (Lex.getKind() != lltok::APSInt || Lex.getAPSIntVal().isSigned())
1131 return TokError("expected integer");
1132 uint64_t Val64 = Lex.getAPSIntVal().getLimitedValue(0xFFFFFFFFULL+1);
1133 if (Val64 != unsigned(Val64))
1134 return TokError("expected 32-bit integer (too large)");
1142 bool LLParser::ParseUInt64(uint64_t &Val) {
1143 if (Lex.getKind() != lltok::APSInt || Lex.getAPSIntVal().isSigned())
1144 return TokError("expected integer");
1145 Val = Lex.getAPSIntVal().getLimitedValue();
1151 /// := 'localdynamic'
1152 /// := 'initialexec'
1154 bool LLParser::ParseTLSModel(GlobalVariable::ThreadLocalMode &TLM) {
1155 switch (Lex.getKind()) {
1157 return TokError("expected localdynamic, initialexec or localexec");
1158 case lltok::kw_localdynamic:
1159 TLM = GlobalVariable::LocalDynamicTLSModel;
1161 case lltok::kw_initialexec:
1162 TLM = GlobalVariable::InitialExecTLSModel;
1164 case lltok::kw_localexec:
1165 TLM = GlobalVariable::LocalExecTLSModel;
1173 /// ParseOptionalThreadLocal
1175 /// := 'thread_local'
1176 /// := 'thread_local' '(' tlsmodel ')'
1177 bool LLParser::ParseOptionalThreadLocal(GlobalVariable::ThreadLocalMode &TLM) {
1178 TLM = GlobalVariable::NotThreadLocal;
1179 if (!EatIfPresent(lltok::kw_thread_local))
1182 TLM = GlobalVariable::GeneralDynamicTLSModel;
1183 if (Lex.getKind() == lltok::lparen) {
1185 return ParseTLSModel(TLM) ||
1186 ParseToken(lltok::rparen, "expected ')' after thread local model");
1191 /// ParseOptionalAddrSpace
1193 /// := 'addrspace' '(' uint32 ')'
1194 bool LLParser::ParseOptionalAddrSpace(unsigned &AddrSpace) {
1196 if (!EatIfPresent(lltok::kw_addrspace))
1198 return ParseToken(lltok::lparen, "expected '(' in address space") ||
1199 ParseUInt32(AddrSpace) ||
1200 ParseToken(lltok::rparen, "expected ')' in address space");
1203 /// ParseOptionalParamAttrs - Parse a potentially empty list of parameter attributes.
1204 bool LLParser::ParseOptionalParamAttrs(AttrBuilder &B) {
1205 bool HaveError = false;
1210 lltok::Kind Token = Lex.getKind();
1212 default: // End of attributes.
1214 case lltok::kw_align: {
1216 if (ParseOptionalAlignment(Alignment))
1218 B.addAlignmentAttr(Alignment);
1221 case lltok::kw_byval: B.addAttribute(Attribute::ByVal); break;
1222 case lltok::kw_dereferenceable: {
1224 if (ParseOptionalDerefAttrBytes(lltok::kw_dereferenceable, Bytes))
1226 B.addDereferenceableAttr(Bytes);
1229 case lltok::kw_dereferenceable_or_null: {
1231 if (ParseOptionalDerefAttrBytes(lltok::kw_dereferenceable_or_null, Bytes))
1233 B.addDereferenceableOrNullAttr(Bytes);
1236 case lltok::kw_inalloca: B.addAttribute(Attribute::InAlloca); break;
1237 case lltok::kw_inreg: B.addAttribute(Attribute::InReg); break;
1238 case lltok::kw_nest: B.addAttribute(Attribute::Nest); break;
1239 case lltok::kw_noalias: B.addAttribute(Attribute::NoAlias); break;
1240 case lltok::kw_nocapture: B.addAttribute(Attribute::NoCapture); break;
1241 case lltok::kw_nonnull: B.addAttribute(Attribute::NonNull); break;
1242 case lltok::kw_readnone: B.addAttribute(Attribute::ReadNone); break;
1243 case lltok::kw_readonly: B.addAttribute(Attribute::ReadOnly); break;
1244 case lltok::kw_returned: B.addAttribute(Attribute::Returned); break;
1245 case lltok::kw_signext: B.addAttribute(Attribute::SExt); break;
1246 case lltok::kw_sret: B.addAttribute(Attribute::StructRet); break;
1247 case lltok::kw_zeroext: B.addAttribute(Attribute::ZExt); break;
1249 case lltok::kw_alignstack:
1250 case lltok::kw_alwaysinline:
1251 case lltok::kw_builtin:
1252 case lltok::kw_inlinehint:
1253 case lltok::kw_jumptable:
1254 case lltok::kw_minsize:
1255 case lltok::kw_naked:
1256 case lltok::kw_nobuiltin:
1257 case lltok::kw_noduplicate:
1258 case lltok::kw_noimplicitfloat:
1259 case lltok::kw_noinline:
1260 case lltok::kw_nonlazybind:
1261 case lltok::kw_noredzone:
1262 case lltok::kw_noreturn:
1263 case lltok::kw_nounwind:
1264 case lltok::kw_optnone:
1265 case lltok::kw_optsize:
1266 case lltok::kw_returns_twice:
1267 case lltok::kw_sanitize_address:
1268 case lltok::kw_sanitize_memory:
1269 case lltok::kw_sanitize_thread:
1271 case lltok::kw_sspreq:
1272 case lltok::kw_sspstrong:
1273 case lltok::kw_uwtable:
1274 HaveError |= Error(Lex.getLoc(), "invalid use of function-only attribute");
1282 /// ParseOptionalReturnAttrs - Parse a potentially empty list of return attributes.
1283 bool LLParser::ParseOptionalReturnAttrs(AttrBuilder &B) {
1284 bool HaveError = false;
1289 lltok::Kind Token = Lex.getKind();
1291 default: // End of attributes.
1293 case lltok::kw_dereferenceable: {
1295 if (ParseOptionalDerefAttrBytes(lltok::kw_dereferenceable, Bytes))
1297 B.addDereferenceableAttr(Bytes);
1300 case lltok::kw_dereferenceable_or_null: {
1302 if (ParseOptionalDerefAttrBytes(lltok::kw_dereferenceable_or_null, Bytes))
1304 B.addDereferenceableOrNullAttr(Bytes);
1307 case lltok::kw_inreg: B.addAttribute(Attribute::InReg); break;
1308 case lltok::kw_noalias: B.addAttribute(Attribute::NoAlias); break;
1309 case lltok::kw_nonnull: B.addAttribute(Attribute::NonNull); break;
1310 case lltok::kw_signext: B.addAttribute(Attribute::SExt); break;
1311 case lltok::kw_zeroext: B.addAttribute(Attribute::ZExt); break;
1314 case lltok::kw_align:
1315 case lltok::kw_byval:
1316 case lltok::kw_inalloca:
1317 case lltok::kw_nest:
1318 case lltok::kw_nocapture:
1319 case lltok::kw_returned:
1320 case lltok::kw_sret:
1321 HaveError |= Error(Lex.getLoc(), "invalid use of parameter-only attribute");
1324 case lltok::kw_alignstack:
1325 case lltok::kw_alwaysinline:
1326 case lltok::kw_builtin:
1327 case lltok::kw_cold:
1328 case lltok::kw_inlinehint:
1329 case lltok::kw_jumptable:
1330 case lltok::kw_minsize:
1331 case lltok::kw_naked:
1332 case lltok::kw_nobuiltin:
1333 case lltok::kw_noduplicate:
1334 case lltok::kw_noimplicitfloat:
1335 case lltok::kw_noinline:
1336 case lltok::kw_nonlazybind:
1337 case lltok::kw_noredzone:
1338 case lltok::kw_noreturn:
1339 case lltok::kw_nounwind:
1340 case lltok::kw_optnone:
1341 case lltok::kw_optsize:
1342 case lltok::kw_returns_twice:
1343 case lltok::kw_sanitize_address:
1344 case lltok::kw_sanitize_memory:
1345 case lltok::kw_sanitize_thread:
1347 case lltok::kw_sspreq:
1348 case lltok::kw_sspstrong:
1349 case lltok::kw_uwtable:
1350 HaveError |= Error(Lex.getLoc(), "invalid use of function-only attribute");
1353 case lltok::kw_readnone:
1354 case lltok::kw_readonly:
1355 HaveError |= Error(Lex.getLoc(), "invalid use of attribute on return type");
1362 /// ParseOptionalLinkage
1369 /// ::= 'linkonce_odr'
1370 /// ::= 'available_externally'
1373 /// ::= 'extern_weak'
1375 bool LLParser::ParseOptionalLinkage(unsigned &Res, bool &HasLinkage) {
1377 switch (Lex.getKind()) {
1378 default: Res=GlobalValue::ExternalLinkage; return false;
1379 case lltok::kw_private: Res = GlobalValue::PrivateLinkage; break;
1380 case lltok::kw_internal: Res = GlobalValue::InternalLinkage; break;
1381 case lltok::kw_weak: Res = GlobalValue::WeakAnyLinkage; break;
1382 case lltok::kw_weak_odr: Res = GlobalValue::WeakODRLinkage; break;
1383 case lltok::kw_linkonce: Res = GlobalValue::LinkOnceAnyLinkage; break;
1384 case lltok::kw_linkonce_odr: Res = GlobalValue::LinkOnceODRLinkage; break;
1385 case lltok::kw_available_externally:
1386 Res = GlobalValue::AvailableExternallyLinkage;
1388 case lltok::kw_appending: Res = GlobalValue::AppendingLinkage; break;
1389 case lltok::kw_common: Res = GlobalValue::CommonLinkage; break;
1390 case lltok::kw_extern_weak: Res = GlobalValue::ExternalWeakLinkage; break;
1391 case lltok::kw_external: Res = GlobalValue::ExternalLinkage; break;
1398 /// ParseOptionalVisibility
1404 bool LLParser::ParseOptionalVisibility(unsigned &Res) {
1405 switch (Lex.getKind()) {
1406 default: Res = GlobalValue::DefaultVisibility; return false;
1407 case lltok::kw_default: Res = GlobalValue::DefaultVisibility; break;
1408 case lltok::kw_hidden: Res = GlobalValue::HiddenVisibility; break;
1409 case lltok::kw_protected: Res = GlobalValue::ProtectedVisibility; break;
1415 /// ParseOptionalDLLStorageClass
1420 bool LLParser::ParseOptionalDLLStorageClass(unsigned &Res) {
1421 switch (Lex.getKind()) {
1422 default: Res = GlobalValue::DefaultStorageClass; return false;
1423 case lltok::kw_dllimport: Res = GlobalValue::DLLImportStorageClass; break;
1424 case lltok::kw_dllexport: Res = GlobalValue::DLLExportStorageClass; break;
1430 /// ParseOptionalCallingConv
1434 /// ::= 'intel_ocl_bicc'
1436 /// ::= 'x86_stdcallcc'
1437 /// ::= 'x86_fastcallcc'
1438 /// ::= 'x86_thiscallcc'
1439 /// ::= 'x86_vectorcallcc'
1440 /// ::= 'arm_apcscc'
1441 /// ::= 'arm_aapcscc'
1442 /// ::= 'arm_aapcs_vfpcc'
1443 /// ::= 'msp430_intrcc'
1444 /// ::= 'ptx_kernel'
1445 /// ::= 'ptx_device'
1447 /// ::= 'spir_kernel'
1448 /// ::= 'x86_64_sysvcc'
1449 /// ::= 'x86_64_win64cc'
1450 /// ::= 'webkit_jscc'
1452 /// ::= 'preserve_mostcc'
1453 /// ::= 'preserve_allcc'
1457 bool LLParser::ParseOptionalCallingConv(unsigned &CC) {
1458 switch (Lex.getKind()) {
1459 default: CC = CallingConv::C; return false;
1460 case lltok::kw_ccc: CC = CallingConv::C; break;
1461 case lltok::kw_fastcc: CC = CallingConv::Fast; break;
1462 case lltok::kw_coldcc: CC = CallingConv::Cold; break;
1463 case lltok::kw_x86_stdcallcc: CC = CallingConv::X86_StdCall; break;
1464 case lltok::kw_x86_fastcallcc: CC = CallingConv::X86_FastCall; break;
1465 case lltok::kw_x86_thiscallcc: CC = CallingConv::X86_ThisCall; break;
1466 case lltok::kw_x86_vectorcallcc:CC = CallingConv::X86_VectorCall; break;
1467 case lltok::kw_arm_apcscc: CC = CallingConv::ARM_APCS; break;
1468 case lltok::kw_arm_aapcscc: CC = CallingConv::ARM_AAPCS; break;
1469 case lltok::kw_arm_aapcs_vfpcc:CC = CallingConv::ARM_AAPCS_VFP; break;
1470 case lltok::kw_msp430_intrcc: CC = CallingConv::MSP430_INTR; break;
1471 case lltok::kw_ptx_kernel: CC = CallingConv::PTX_Kernel; break;
1472 case lltok::kw_ptx_device: CC = CallingConv::PTX_Device; break;
1473 case lltok::kw_spir_kernel: CC = CallingConv::SPIR_KERNEL; break;
1474 case lltok::kw_spir_func: CC = CallingConv::SPIR_FUNC; break;
1475 case lltok::kw_intel_ocl_bicc: CC = CallingConv::Intel_OCL_BI; break;
1476 case lltok::kw_x86_64_sysvcc: CC = CallingConv::X86_64_SysV; break;
1477 case lltok::kw_x86_64_win64cc: CC = CallingConv::X86_64_Win64; break;
1478 case lltok::kw_webkit_jscc: CC = CallingConv::WebKit_JS; break;
1479 case lltok::kw_anyregcc: CC = CallingConv::AnyReg; break;
1480 case lltok::kw_preserve_mostcc:CC = CallingConv::PreserveMost; break;
1481 case lltok::kw_preserve_allcc: CC = CallingConv::PreserveAll; break;
1482 case lltok::kw_ghccc: CC = CallingConv::GHC; break;
1483 case lltok::kw_cc: {
1485 return ParseUInt32(CC);
1493 /// ParseInstructionMetadata
1494 /// ::= !dbg !42 (',' !dbg !57)*
1495 bool LLParser::ParseInstructionMetadata(Instruction *Inst,
1496 PerFunctionState *PFS) {
1498 if (Lex.getKind() != lltok::MetadataVar)
1499 return TokError("expected metadata after comma");
1501 std::string Name = Lex.getStrVal();
1502 unsigned MDK = M->getMDKindID(Name);
1509 Inst->setMetadata(MDK, N);
1510 if (MDK == LLVMContext::MD_tbaa)
1511 InstsWithTBAATag.push_back(Inst);
1513 // If this is the end of the list, we're done.
1514 } while (EatIfPresent(lltok::comma));
1518 /// ParseOptionalAlignment
1521 bool LLParser::ParseOptionalAlignment(unsigned &Alignment) {
1523 if (!EatIfPresent(lltok::kw_align))
1525 LocTy AlignLoc = Lex.getLoc();
1526 if (ParseUInt32(Alignment)) return true;
1527 if (!isPowerOf2_32(Alignment))
1528 return Error(AlignLoc, "alignment is not a power of two");
1529 if (Alignment > Value::MaximumAlignment)
1530 return Error(AlignLoc, "huge alignments are not supported yet");
1534 /// ParseOptionalDerefAttrBytes
1536 /// ::= AttrKind '(' 4 ')'
1538 /// where AttrKind is either 'dereferenceable' or 'dereferenceable_or_null'.
1539 bool LLParser::ParseOptionalDerefAttrBytes(lltok::Kind AttrKind,
1541 assert((AttrKind == lltok::kw_dereferenceable ||
1542 AttrKind == lltok::kw_dereferenceable_or_null) &&
1546 if (!EatIfPresent(AttrKind))
1548 LocTy ParenLoc = Lex.getLoc();
1549 if (!EatIfPresent(lltok::lparen))
1550 return Error(ParenLoc, "expected '('");
1551 LocTy DerefLoc = Lex.getLoc();
1552 if (ParseUInt64(Bytes)) return true;
1553 ParenLoc = Lex.getLoc();
1554 if (!EatIfPresent(lltok::rparen))
1555 return Error(ParenLoc, "expected ')'");
1557 return Error(DerefLoc, "dereferenceable bytes must be non-zero");
1561 /// ParseOptionalCommaAlign
1565 /// This returns with AteExtraComma set to true if it ate an excess comma at the
1567 bool LLParser::ParseOptionalCommaAlign(unsigned &Alignment,
1568 bool &AteExtraComma) {
1569 AteExtraComma = false;
1570 while (EatIfPresent(lltok::comma)) {
1571 // Metadata at the end is an early exit.
1572 if (Lex.getKind() == lltok::MetadataVar) {
1573 AteExtraComma = true;
1577 if (Lex.getKind() != lltok::kw_align)
1578 return Error(Lex.getLoc(), "expected metadata or 'align'");
1580 if (ParseOptionalAlignment(Alignment)) return true;
1586 /// ParseScopeAndOrdering
1587 /// if isAtomic: ::= 'singlethread'? AtomicOrdering
1590 /// This sets Scope and Ordering to the parsed values.
1591 bool LLParser::ParseScopeAndOrdering(bool isAtomic, SynchronizationScope &Scope,
1592 AtomicOrdering &Ordering) {
1596 Scope = CrossThread;
1597 if (EatIfPresent(lltok::kw_singlethread))
1598 Scope = SingleThread;
1600 return ParseOrdering(Ordering);
1604 /// ::= AtomicOrdering
1606 /// This sets Ordering to the parsed value.
1607 bool LLParser::ParseOrdering(AtomicOrdering &Ordering) {
1608 switch (Lex.getKind()) {
1609 default: return TokError("Expected ordering on atomic instruction");
1610 case lltok::kw_unordered: Ordering = Unordered; break;
1611 case lltok::kw_monotonic: Ordering = Monotonic; break;
1612 case lltok::kw_acquire: Ordering = Acquire; break;
1613 case lltok::kw_release: Ordering = Release; break;
1614 case lltok::kw_acq_rel: Ordering = AcquireRelease; break;
1615 case lltok::kw_seq_cst: Ordering = SequentiallyConsistent; break;
1621 /// ParseOptionalStackAlignment
1623 /// ::= 'alignstack' '(' 4 ')'
1624 bool LLParser::ParseOptionalStackAlignment(unsigned &Alignment) {
1626 if (!EatIfPresent(lltok::kw_alignstack))
1628 LocTy ParenLoc = Lex.getLoc();
1629 if (!EatIfPresent(lltok::lparen))
1630 return Error(ParenLoc, "expected '('");
1631 LocTy AlignLoc = Lex.getLoc();
1632 if (ParseUInt32(Alignment)) return true;
1633 ParenLoc = Lex.getLoc();
1634 if (!EatIfPresent(lltok::rparen))
1635 return Error(ParenLoc, "expected ')'");
1636 if (!isPowerOf2_32(Alignment))
1637 return Error(AlignLoc, "stack alignment is not a power of two");
1641 /// ParseIndexList - This parses the index list for an insert/extractvalue
1642 /// instruction. This sets AteExtraComma in the case where we eat an extra
1643 /// comma at the end of the line and find that it is followed by metadata.
1644 /// Clients that don't allow metadata can call the version of this function that
1645 /// only takes one argument.
1648 /// ::= (',' uint32)+
1650 bool LLParser::ParseIndexList(SmallVectorImpl<unsigned> &Indices,
1651 bool &AteExtraComma) {
1652 AteExtraComma = false;
1654 if (Lex.getKind() != lltok::comma)
1655 return TokError("expected ',' as start of index list");
1657 while (EatIfPresent(lltok::comma)) {
1658 if (Lex.getKind() == lltok::MetadataVar) {
1659 if (Indices.empty()) return TokError("expected index");
1660 AteExtraComma = true;
1664 if (ParseUInt32(Idx)) return true;
1665 Indices.push_back(Idx);
1671 //===----------------------------------------------------------------------===//
1673 //===----------------------------------------------------------------------===//
1675 /// ParseType - Parse a type.
1676 bool LLParser::ParseType(Type *&Result, const Twine &Msg, bool AllowVoid) {
1677 SMLoc TypeLoc = Lex.getLoc();
1678 switch (Lex.getKind()) {
1680 return TokError(Msg);
1682 // Type ::= 'float' | 'void' (etc)
1683 Result = Lex.getTyVal();
1687 // Type ::= StructType
1688 if (ParseAnonStructType(Result, false))
1691 case lltok::lsquare:
1692 // Type ::= '[' ... ']'
1693 Lex.Lex(); // eat the lsquare.
1694 if (ParseArrayVectorType(Result, false))
1697 case lltok::less: // Either vector or packed struct.
1698 // Type ::= '<' ... '>'
1700 if (Lex.getKind() == lltok::lbrace) {
1701 if (ParseAnonStructType(Result, true) ||
1702 ParseToken(lltok::greater, "expected '>' at end of packed struct"))
1704 } else if (ParseArrayVectorType(Result, true))
1707 case lltok::LocalVar: {
1709 std::pair<Type*, LocTy> &Entry = NamedTypes[Lex.getStrVal()];
1711 // If the type hasn't been defined yet, create a forward definition and
1712 // remember where that forward def'n was seen (in case it never is defined).
1714 Entry.first = StructType::create(Context, Lex.getStrVal());
1715 Entry.second = Lex.getLoc();
1717 Result = Entry.first;
1722 case lltok::LocalVarID: {
1724 std::pair<Type*, LocTy> &Entry = NumberedTypes[Lex.getUIntVal()];
1726 // If the type hasn't been defined yet, create a forward definition and
1727 // remember where that forward def'n was seen (in case it never is defined).
1729 Entry.first = StructType::create(Context);
1730 Entry.second = Lex.getLoc();
1732 Result = Entry.first;
1738 // Parse the type suffixes.
1740 switch (Lex.getKind()) {
1743 if (!AllowVoid && Result->isVoidTy())
1744 return Error(TypeLoc, "void type only allowed for function results");
1747 // Type ::= Type '*'
1749 if (Result->isLabelTy())
1750 return TokError("basic block pointers are invalid");
1751 if (Result->isVoidTy())
1752 return TokError("pointers to void are invalid - use i8* instead");
1753 if (!PointerType::isValidElementType(Result))
1754 return TokError("pointer to this type is invalid");
1755 Result = PointerType::getUnqual(Result);
1759 // Type ::= Type 'addrspace' '(' uint32 ')' '*'
1760 case lltok::kw_addrspace: {
1761 if (Result->isLabelTy())
1762 return TokError("basic block pointers are invalid");
1763 if (Result->isVoidTy())
1764 return TokError("pointers to void are invalid; use i8* instead");
1765 if (!PointerType::isValidElementType(Result))
1766 return TokError("pointer to this type is invalid");
1768 if (ParseOptionalAddrSpace(AddrSpace) ||
1769 ParseToken(lltok::star, "expected '*' in address space"))
1772 Result = PointerType::get(Result, AddrSpace);
1776 /// Types '(' ArgTypeListI ')' OptFuncAttrs
1778 if (ParseFunctionType(Result))
1785 /// ParseParameterList
1787 /// ::= '(' Arg (',' Arg)* ')'
1789 /// ::= Type OptionalAttributes Value OptionalAttributes
1790 bool LLParser::ParseParameterList(SmallVectorImpl<ParamInfo> &ArgList,
1791 PerFunctionState &PFS, bool IsMustTailCall,
1792 bool InVarArgsFunc) {
1793 if (ParseToken(lltok::lparen, "expected '(' in call"))
1796 unsigned AttrIndex = 1;
1797 while (Lex.getKind() != lltok::rparen) {
1798 // If this isn't the first argument, we need a comma.
1799 if (!ArgList.empty() &&
1800 ParseToken(lltok::comma, "expected ',' in argument list"))
1803 // Parse an ellipsis if this is a musttail call in a variadic function.
1804 if (Lex.getKind() == lltok::dotdotdot) {
1805 const char *Msg = "unexpected ellipsis in argument list for ";
1806 if (!IsMustTailCall)
1807 return TokError(Twine(Msg) + "non-musttail call");
1809 return TokError(Twine(Msg) + "musttail call in non-varargs function");
1810 Lex.Lex(); // Lex the '...', it is purely for readability.
1811 return ParseToken(lltok::rparen, "expected ')' at end of argument list");
1814 // Parse the argument.
1816 Type *ArgTy = nullptr;
1817 AttrBuilder ArgAttrs;
1819 if (ParseType(ArgTy, ArgLoc))
1822 if (ArgTy->isMetadataTy()) {
1823 if (ParseMetadataAsValue(V, PFS))
1826 // Otherwise, handle normal operands.
1827 if (ParseOptionalParamAttrs(ArgAttrs) || ParseValue(ArgTy, V, PFS))
1830 ArgList.push_back(ParamInfo(ArgLoc, V, AttributeSet::get(V->getContext(),
1835 if (IsMustTailCall && InVarArgsFunc)
1836 return TokError("expected '...' at end of argument list for musttail call "
1837 "in varargs function");
1839 Lex.Lex(); // Lex the ')'.
1845 /// ParseArgumentList - Parse the argument list for a function type or function
1847 /// ::= '(' ArgTypeListI ')'
1851 /// ::= ArgTypeList ',' '...'
1852 /// ::= ArgType (',' ArgType)*
1854 bool LLParser::ParseArgumentList(SmallVectorImpl<ArgInfo> &ArgList,
1857 assert(Lex.getKind() == lltok::lparen);
1858 Lex.Lex(); // eat the (.
1860 if (Lex.getKind() == lltok::rparen) {
1862 } else if (Lex.getKind() == lltok::dotdotdot) {
1866 LocTy TypeLoc = Lex.getLoc();
1867 Type *ArgTy = nullptr;
1871 if (ParseType(ArgTy) ||
1872 ParseOptionalParamAttrs(Attrs)) return true;
1874 if (ArgTy->isVoidTy())
1875 return Error(TypeLoc, "argument can not have void type");
1877 if (Lex.getKind() == lltok::LocalVar) {
1878 Name = Lex.getStrVal();
1882 if (!FunctionType::isValidArgumentType(ArgTy))
1883 return Error(TypeLoc, "invalid type for function argument");
1885 unsigned AttrIndex = 1;
1886 ArgList.push_back(ArgInfo(TypeLoc, ArgTy,
1887 AttributeSet::get(ArgTy->getContext(),
1888 AttrIndex++, Attrs), Name));
1890 while (EatIfPresent(lltok::comma)) {
1891 // Handle ... at end of arg list.
1892 if (EatIfPresent(lltok::dotdotdot)) {
1897 // Otherwise must be an argument type.
1898 TypeLoc = Lex.getLoc();
1899 if (ParseType(ArgTy) || ParseOptionalParamAttrs(Attrs)) return true;
1901 if (ArgTy->isVoidTy())
1902 return Error(TypeLoc, "argument can not have void type");
1904 if (Lex.getKind() == lltok::LocalVar) {
1905 Name = Lex.getStrVal();
1911 if (!ArgTy->isFirstClassType())
1912 return Error(TypeLoc, "invalid type for function argument");
1914 ArgList.push_back(ArgInfo(TypeLoc, ArgTy,
1915 AttributeSet::get(ArgTy->getContext(),
1916 AttrIndex++, Attrs),
1921 return ParseToken(lltok::rparen, "expected ')' at end of argument list");
1924 /// ParseFunctionType
1925 /// ::= Type ArgumentList OptionalAttrs
1926 bool LLParser::ParseFunctionType(Type *&Result) {
1927 assert(Lex.getKind() == lltok::lparen);
1929 if (!FunctionType::isValidReturnType(Result))
1930 return TokError("invalid function return type");
1932 SmallVector<ArgInfo, 8> ArgList;
1934 if (ParseArgumentList(ArgList, isVarArg))
1937 // Reject names on the arguments lists.
1938 for (unsigned i = 0, e = ArgList.size(); i != e; ++i) {
1939 if (!ArgList[i].Name.empty())
1940 return Error(ArgList[i].Loc, "argument name invalid in function type");
1941 if (ArgList[i].Attrs.hasAttributes(i + 1))
1942 return Error(ArgList[i].Loc,
1943 "argument attributes invalid in function type");
1946 SmallVector<Type*, 16> ArgListTy;
1947 for (unsigned i = 0, e = ArgList.size(); i != e; ++i)
1948 ArgListTy.push_back(ArgList[i].Ty);
1950 Result = FunctionType::get(Result, ArgListTy, isVarArg);
1954 /// ParseAnonStructType - Parse an anonymous struct type, which is inlined into
1956 bool LLParser::ParseAnonStructType(Type *&Result, bool Packed) {
1957 SmallVector<Type*, 8> Elts;
1958 if (ParseStructBody(Elts)) return true;
1960 Result = StructType::get(Context, Elts, Packed);
1964 /// ParseStructDefinition - Parse a struct in a 'type' definition.
1965 bool LLParser::ParseStructDefinition(SMLoc TypeLoc, StringRef Name,
1966 std::pair<Type*, LocTy> &Entry,
1968 // If the type was already defined, diagnose the redefinition.
1969 if (Entry.first && !Entry.second.isValid())
1970 return Error(TypeLoc, "redefinition of type");
1972 // If we have opaque, just return without filling in the definition for the
1973 // struct. This counts as a definition as far as the .ll file goes.
1974 if (EatIfPresent(lltok::kw_opaque)) {
1975 // This type is being defined, so clear the location to indicate this.
1976 Entry.second = SMLoc();
1978 // If this type number has never been uttered, create it.
1980 Entry.first = StructType::create(Context, Name);
1981 ResultTy = Entry.first;
1985 // If the type starts with '<', then it is either a packed struct or a vector.
1986 bool isPacked = EatIfPresent(lltok::less);
1988 // If we don't have a struct, then we have a random type alias, which we
1989 // accept for compatibility with old files. These types are not allowed to be
1990 // forward referenced and not allowed to be recursive.
1991 if (Lex.getKind() != lltok::lbrace) {
1993 return Error(TypeLoc, "forward references to non-struct type");
1997 return ParseArrayVectorType(ResultTy, true);
1998 return ParseType(ResultTy);
2001 // This type is being defined, so clear the location to indicate this.
2002 Entry.second = SMLoc();
2004 // If this type number has never been uttered, create it.
2006 Entry.first = StructType::create(Context, Name);
2008 StructType *STy = cast<StructType>(Entry.first);
2010 SmallVector<Type*, 8> Body;
2011 if (ParseStructBody(Body) ||
2012 (isPacked && ParseToken(lltok::greater, "expected '>' in packed struct")))
2015 STy->setBody(Body, isPacked);
2021 /// ParseStructType: Handles packed and unpacked types. </> parsed elsewhere.
2024 /// ::= '{' Type (',' Type)* '}'
2025 /// ::= '<' '{' '}' '>'
2026 /// ::= '<' '{' Type (',' Type)* '}' '>'
2027 bool LLParser::ParseStructBody(SmallVectorImpl<Type*> &Body) {
2028 assert(Lex.getKind() == lltok::lbrace);
2029 Lex.Lex(); // Consume the '{'
2031 // Handle the empty struct.
2032 if (EatIfPresent(lltok::rbrace))
2035 LocTy EltTyLoc = Lex.getLoc();
2037 if (ParseType(Ty)) return true;
2040 if (!StructType::isValidElementType(Ty))
2041 return Error(EltTyLoc, "invalid element type for struct");
2043 while (EatIfPresent(lltok::comma)) {
2044 EltTyLoc = Lex.getLoc();
2045 if (ParseType(Ty)) return true;
2047 if (!StructType::isValidElementType(Ty))
2048 return Error(EltTyLoc, "invalid element type for struct");
2053 return ParseToken(lltok::rbrace, "expected '}' at end of struct");
2056 /// ParseArrayVectorType - Parse an array or vector type, assuming the first
2057 /// token has already been consumed.
2059 /// ::= '[' APSINTVAL 'x' Types ']'
2060 /// ::= '<' APSINTVAL 'x' Types '>'
2061 bool LLParser::ParseArrayVectorType(Type *&Result, bool isVector) {
2062 if (Lex.getKind() != lltok::APSInt || Lex.getAPSIntVal().isSigned() ||
2063 Lex.getAPSIntVal().getBitWidth() > 64)
2064 return TokError("expected number in address space");
2066 LocTy SizeLoc = Lex.getLoc();
2067 uint64_t Size = Lex.getAPSIntVal().getZExtValue();
2070 if (ParseToken(lltok::kw_x, "expected 'x' after element count"))
2073 LocTy TypeLoc = Lex.getLoc();
2074 Type *EltTy = nullptr;
2075 if (ParseType(EltTy)) return true;
2077 if (ParseToken(isVector ? lltok::greater : lltok::rsquare,
2078 "expected end of sequential type"))
2083 return Error(SizeLoc, "zero element vector is illegal");
2084 if ((unsigned)Size != Size)
2085 return Error(SizeLoc, "size too large for vector");
2086 if (!VectorType::isValidElementType(EltTy))
2087 return Error(TypeLoc, "invalid vector element type");
2088 Result = VectorType::get(EltTy, unsigned(Size));
2090 if (!ArrayType::isValidElementType(EltTy))
2091 return Error(TypeLoc, "invalid array element type");
2092 Result = ArrayType::get(EltTy, Size);
2097 //===----------------------------------------------------------------------===//
2098 // Function Semantic Analysis.
2099 //===----------------------------------------------------------------------===//
2101 LLParser::PerFunctionState::PerFunctionState(LLParser &p, Function &f,
2103 : P(p), F(f), FunctionNumber(functionNumber) {
2105 // Insert unnamed arguments into the NumberedVals list.
2106 for (Function::arg_iterator AI = F.arg_begin(), E = F.arg_end();
2109 NumberedVals.push_back(AI);
2112 LLParser::PerFunctionState::~PerFunctionState() {
2113 // If there were any forward referenced non-basicblock values, delete them.
2114 for (std::map<std::string, std::pair<Value*, LocTy> >::iterator
2115 I = ForwardRefVals.begin(), E = ForwardRefVals.end(); I != E; ++I)
2116 if (!isa<BasicBlock>(I->second.first)) {
2117 I->second.first->replaceAllUsesWith(
2118 UndefValue::get(I->second.first->getType()));
2119 delete I->second.first;
2120 I->second.first = nullptr;
2123 for (std::map<unsigned, std::pair<Value*, LocTy> >::iterator
2124 I = ForwardRefValIDs.begin(), E = ForwardRefValIDs.end(); I != E; ++I)
2125 if (!isa<BasicBlock>(I->second.first)) {
2126 I->second.first->replaceAllUsesWith(
2127 UndefValue::get(I->second.first->getType()));
2128 delete I->second.first;
2129 I->second.first = nullptr;
2133 bool LLParser::PerFunctionState::FinishFunction() {
2134 if (!ForwardRefVals.empty())
2135 return P.Error(ForwardRefVals.begin()->second.second,
2136 "use of undefined value '%" + ForwardRefVals.begin()->first +
2138 if (!ForwardRefValIDs.empty())
2139 return P.Error(ForwardRefValIDs.begin()->second.second,
2140 "use of undefined value '%" +
2141 Twine(ForwardRefValIDs.begin()->first) + "'");
2146 /// GetVal - Get a value with the specified name or ID, creating a
2147 /// forward reference record if needed. This can return null if the value
2148 /// exists but does not have the right type.
2149 Value *LLParser::PerFunctionState::GetVal(const std::string &Name,
2150 Type *Ty, LocTy Loc) {
2151 // Look this name up in the normal function symbol table.
2152 Value *Val = F.getValueSymbolTable().lookup(Name);
2154 // If this is a forward reference for the value, see if we already created a
2155 // forward ref record.
2157 std::map<std::string, std::pair<Value*, LocTy> >::iterator
2158 I = ForwardRefVals.find(Name);
2159 if (I != ForwardRefVals.end())
2160 Val = I->second.first;
2163 // If we have the value in the symbol table or fwd-ref table, return it.
2165 if (Val->getType() == Ty) return Val;
2166 if (Ty->isLabelTy())
2167 P.Error(Loc, "'%" + Name + "' is not a basic block");
2169 P.Error(Loc, "'%" + Name + "' defined with type '" +
2170 getTypeString(Val->getType()) + "'");
2174 // Don't make placeholders with invalid type.
2175 if (!Ty->isFirstClassType()) {
2176 P.Error(Loc, "invalid use of a non-first-class type");
2180 // Otherwise, create a new forward reference for this value and remember it.
2182 if (Ty->isLabelTy())
2183 FwdVal = BasicBlock::Create(F.getContext(), Name, &F);
2185 FwdVal = new Argument(Ty, Name);
2187 ForwardRefVals[Name] = std::make_pair(FwdVal, Loc);
2191 Value *LLParser::PerFunctionState::GetVal(unsigned ID, Type *Ty,
2193 // Look this name up in the normal function symbol table.
2194 Value *Val = ID < NumberedVals.size() ? NumberedVals[ID] : nullptr;
2196 // If this is a forward reference for the value, see if we already created a
2197 // forward ref record.
2199 std::map<unsigned, std::pair<Value*, LocTy> >::iterator
2200 I = ForwardRefValIDs.find(ID);
2201 if (I != ForwardRefValIDs.end())
2202 Val = I->second.first;
2205 // If we have the value in the symbol table or fwd-ref table, return it.
2207 if (Val->getType() == Ty) return Val;
2208 if (Ty->isLabelTy())
2209 P.Error(Loc, "'%" + Twine(ID) + "' is not a basic block");
2211 P.Error(Loc, "'%" + Twine(ID) + "' defined with type '" +
2212 getTypeString(Val->getType()) + "'");
2216 if (!Ty->isFirstClassType()) {
2217 P.Error(Loc, "invalid use of a non-first-class type");
2221 // Otherwise, create a new forward reference for this value and remember it.
2223 if (Ty->isLabelTy())
2224 FwdVal = BasicBlock::Create(F.getContext(), "", &F);
2226 FwdVal = new Argument(Ty);
2228 ForwardRefValIDs[ID] = std::make_pair(FwdVal, Loc);
2232 /// SetInstName - After an instruction is parsed and inserted into its
2233 /// basic block, this installs its name.
2234 bool LLParser::PerFunctionState::SetInstName(int NameID,
2235 const std::string &NameStr,
2236 LocTy NameLoc, Instruction *Inst) {
2237 // If this instruction has void type, it cannot have a name or ID specified.
2238 if (Inst->getType()->isVoidTy()) {
2239 if (NameID != -1 || !NameStr.empty())
2240 return P.Error(NameLoc, "instructions returning void cannot have a name");
2244 // If this was a numbered instruction, verify that the instruction is the
2245 // expected value and resolve any forward references.
2246 if (NameStr.empty()) {
2247 // If neither a name nor an ID was specified, just use the next ID.
2249 NameID = NumberedVals.size();
2251 if (unsigned(NameID) != NumberedVals.size())
2252 return P.Error(NameLoc, "instruction expected to be numbered '%" +
2253 Twine(NumberedVals.size()) + "'");
2255 std::map<unsigned, std::pair<Value*, LocTy> >::iterator FI =
2256 ForwardRefValIDs.find(NameID);
2257 if (FI != ForwardRefValIDs.end()) {
2258 if (FI->second.first->getType() != Inst->getType())
2259 return P.Error(NameLoc, "instruction forward referenced with type '" +
2260 getTypeString(FI->second.first->getType()) + "'");
2261 FI->second.first->replaceAllUsesWith(Inst);
2262 delete FI->second.first;
2263 ForwardRefValIDs.erase(FI);
2266 NumberedVals.push_back(Inst);
2270 // Otherwise, the instruction had a name. Resolve forward refs and set it.
2271 std::map<std::string, std::pair<Value*, LocTy> >::iterator
2272 FI = ForwardRefVals.find(NameStr);
2273 if (FI != ForwardRefVals.end()) {
2274 if (FI->second.first->getType() != Inst->getType())
2275 return P.Error(NameLoc, "instruction forward referenced with type '" +
2276 getTypeString(FI->second.first->getType()) + "'");
2277 FI->second.first->replaceAllUsesWith(Inst);
2278 delete FI->second.first;
2279 ForwardRefVals.erase(FI);
2282 // Set the name on the instruction.
2283 Inst->setName(NameStr);
2285 if (Inst->getName() != NameStr)
2286 return P.Error(NameLoc, "multiple definition of local value named '" +
2291 /// GetBB - Get a basic block with the specified name or ID, creating a
2292 /// forward reference record if needed.
2293 BasicBlock *LLParser::PerFunctionState::GetBB(const std::string &Name,
2295 return dyn_cast_or_null<BasicBlock>(GetVal(Name,
2296 Type::getLabelTy(F.getContext()), Loc));
2299 BasicBlock *LLParser::PerFunctionState::GetBB(unsigned ID, LocTy Loc) {
2300 return dyn_cast_or_null<BasicBlock>(GetVal(ID,
2301 Type::getLabelTy(F.getContext()), Loc));
2304 /// DefineBB - Define the specified basic block, which is either named or
2305 /// unnamed. If there is an error, this returns null otherwise it returns
2306 /// the block being defined.
2307 BasicBlock *LLParser::PerFunctionState::DefineBB(const std::string &Name,
2311 BB = GetBB(NumberedVals.size(), Loc);
2313 BB = GetBB(Name, Loc);
2314 if (!BB) return nullptr; // Already diagnosed error.
2316 // Move the block to the end of the function. Forward ref'd blocks are
2317 // inserted wherever they happen to be referenced.
2318 F.getBasicBlockList().splice(F.end(), F.getBasicBlockList(), BB);
2320 // Remove the block from forward ref sets.
2322 ForwardRefValIDs.erase(NumberedVals.size());
2323 NumberedVals.push_back(BB);
2325 // BB forward references are already in the function symbol table.
2326 ForwardRefVals.erase(Name);
2332 //===----------------------------------------------------------------------===//
2334 //===----------------------------------------------------------------------===//
2336 /// ParseValID - Parse an abstract value that doesn't necessarily have a
2337 /// type implied. For example, if we parse "4" we don't know what integer type
2338 /// it has. The value will later be combined with its type and checked for
2339 /// sanity. PFS is used to convert function-local operands of metadata (since
2340 /// metadata operands are not just parsed here but also converted to values).
2341 /// PFS can be null when we are not parsing metadata values inside a function.
2342 bool LLParser::ParseValID(ValID &ID, PerFunctionState *PFS) {
2343 ID.Loc = Lex.getLoc();
2344 switch (Lex.getKind()) {
2345 default: return TokError("expected value token");
2346 case lltok::GlobalID: // @42
2347 ID.UIntVal = Lex.getUIntVal();
2348 ID.Kind = ValID::t_GlobalID;
2350 case lltok::GlobalVar: // @foo
2351 ID.StrVal = Lex.getStrVal();
2352 ID.Kind = ValID::t_GlobalName;
2354 case lltok::LocalVarID: // %42
2355 ID.UIntVal = Lex.getUIntVal();
2356 ID.Kind = ValID::t_LocalID;
2358 case lltok::LocalVar: // %foo
2359 ID.StrVal = Lex.getStrVal();
2360 ID.Kind = ValID::t_LocalName;
2363 ID.APSIntVal = Lex.getAPSIntVal();
2364 ID.Kind = ValID::t_APSInt;
2366 case lltok::APFloat:
2367 ID.APFloatVal = Lex.getAPFloatVal();
2368 ID.Kind = ValID::t_APFloat;
2370 case lltok::kw_true:
2371 ID.ConstantVal = ConstantInt::getTrue(Context);
2372 ID.Kind = ValID::t_Constant;
2374 case lltok::kw_false:
2375 ID.ConstantVal = ConstantInt::getFalse(Context);
2376 ID.Kind = ValID::t_Constant;
2378 case lltok::kw_null: ID.Kind = ValID::t_Null; break;
2379 case lltok::kw_undef: ID.Kind = ValID::t_Undef; break;
2380 case lltok::kw_zeroinitializer: ID.Kind = ValID::t_Zero; break;
2382 case lltok::lbrace: {
2383 // ValID ::= '{' ConstVector '}'
2385 SmallVector<Constant*, 16> Elts;
2386 if (ParseGlobalValueVector(Elts) ||
2387 ParseToken(lltok::rbrace, "expected end of struct constant"))
2390 ID.ConstantStructElts = new Constant*[Elts.size()];
2391 ID.UIntVal = Elts.size();
2392 memcpy(ID.ConstantStructElts, Elts.data(), Elts.size()*sizeof(Elts[0]));
2393 ID.Kind = ValID::t_ConstantStruct;
2397 // ValID ::= '<' ConstVector '>' --> Vector.
2398 // ValID ::= '<' '{' ConstVector '}' '>' --> Packed Struct.
2400 bool isPackedStruct = EatIfPresent(lltok::lbrace);
2402 SmallVector<Constant*, 16> Elts;
2403 LocTy FirstEltLoc = Lex.getLoc();
2404 if (ParseGlobalValueVector(Elts) ||
2406 ParseToken(lltok::rbrace, "expected end of packed struct")) ||
2407 ParseToken(lltok::greater, "expected end of constant"))
2410 if (isPackedStruct) {
2411 ID.ConstantStructElts = new Constant*[Elts.size()];
2412 memcpy(ID.ConstantStructElts, Elts.data(), Elts.size()*sizeof(Elts[0]));
2413 ID.UIntVal = Elts.size();
2414 ID.Kind = ValID::t_PackedConstantStruct;
2419 return Error(ID.Loc, "constant vector must not be empty");
2421 if (!Elts[0]->getType()->isIntegerTy() &&
2422 !Elts[0]->getType()->isFloatingPointTy() &&
2423 !Elts[0]->getType()->isPointerTy())
2424 return Error(FirstEltLoc,
2425 "vector elements must have integer, pointer or floating point type");
2427 // Verify that all the vector elements have the same type.
2428 for (unsigned i = 1, e = Elts.size(); i != e; ++i)
2429 if (Elts[i]->getType() != Elts[0]->getType())
2430 return Error(FirstEltLoc,
2431 "vector element #" + Twine(i) +
2432 " is not of type '" + getTypeString(Elts[0]->getType()));
2434 ID.ConstantVal = ConstantVector::get(Elts);
2435 ID.Kind = ValID::t_Constant;
2438 case lltok::lsquare: { // Array Constant
2440 SmallVector<Constant*, 16> Elts;
2441 LocTy FirstEltLoc = Lex.getLoc();
2442 if (ParseGlobalValueVector(Elts) ||
2443 ParseToken(lltok::rsquare, "expected end of array constant"))
2446 // Handle empty element.
2448 // Use undef instead of an array because it's inconvenient to determine
2449 // the element type at this point, there being no elements to examine.
2450 ID.Kind = ValID::t_EmptyArray;
2454 if (!Elts[0]->getType()->isFirstClassType())
2455 return Error(FirstEltLoc, "invalid array element type: " +
2456 getTypeString(Elts[0]->getType()));
2458 ArrayType *ATy = ArrayType::get(Elts[0]->getType(), Elts.size());
2460 // Verify all elements are correct type!
2461 for (unsigned i = 0, e = Elts.size(); i != e; ++i) {
2462 if (Elts[i]->getType() != Elts[0]->getType())
2463 return Error(FirstEltLoc,
2464 "array element #" + Twine(i) +
2465 " is not of type '" + getTypeString(Elts[0]->getType()));
2468 ID.ConstantVal = ConstantArray::get(ATy, Elts);
2469 ID.Kind = ValID::t_Constant;
2472 case lltok::kw_c: // c "foo"
2474 ID.ConstantVal = ConstantDataArray::getString(Context, Lex.getStrVal(),
2476 if (ParseToken(lltok::StringConstant, "expected string")) return true;
2477 ID.Kind = ValID::t_Constant;
2480 case lltok::kw_asm: {
2481 // ValID ::= 'asm' SideEffect? AlignStack? IntelDialect? STRINGCONSTANT ','
2483 bool HasSideEffect, AlignStack, AsmDialect;
2485 if (ParseOptionalToken(lltok::kw_sideeffect, HasSideEffect) ||
2486 ParseOptionalToken(lltok::kw_alignstack, AlignStack) ||
2487 ParseOptionalToken(lltok::kw_inteldialect, AsmDialect) ||
2488 ParseStringConstant(ID.StrVal) ||
2489 ParseToken(lltok::comma, "expected comma in inline asm expression") ||
2490 ParseToken(lltok::StringConstant, "expected constraint string"))
2492 ID.StrVal2 = Lex.getStrVal();
2493 ID.UIntVal = unsigned(HasSideEffect) | (unsigned(AlignStack)<<1) |
2494 (unsigned(AsmDialect)<<2);
2495 ID.Kind = ValID::t_InlineAsm;
2499 case lltok::kw_blockaddress: {
2500 // ValID ::= 'blockaddress' '(' @foo ',' %bar ')'
2505 if (ParseToken(lltok::lparen, "expected '(' in block address expression") ||
2507 ParseToken(lltok::comma, "expected comma in block address expression")||
2508 ParseValID(Label) ||
2509 ParseToken(lltok::rparen, "expected ')' in block address expression"))
2512 if (Fn.Kind != ValID::t_GlobalID && Fn.Kind != ValID::t_GlobalName)
2513 return Error(Fn.Loc, "expected function name in blockaddress");
2514 if (Label.Kind != ValID::t_LocalID && Label.Kind != ValID::t_LocalName)
2515 return Error(Label.Loc, "expected basic block name in blockaddress");
2517 // Try to find the function (but skip it if it's forward-referenced).
2518 GlobalValue *GV = nullptr;
2519 if (Fn.Kind == ValID::t_GlobalID) {
2520 if (Fn.UIntVal < NumberedVals.size())
2521 GV = NumberedVals[Fn.UIntVal];
2522 } else if (!ForwardRefVals.count(Fn.StrVal)) {
2523 GV = M->getNamedValue(Fn.StrVal);
2525 Function *F = nullptr;
2527 // Confirm that it's actually a function with a definition.
2528 if (!isa<Function>(GV))
2529 return Error(Fn.Loc, "expected function name in blockaddress");
2530 F = cast<Function>(GV);
2531 if (F->isDeclaration())
2532 return Error(Fn.Loc, "cannot take blockaddress inside a declaration");
2536 // Make a global variable as a placeholder for this reference.
2537 GlobalValue *&FwdRef =
2538 ForwardRefBlockAddresses.insert(std::make_pair(
2540 std::map<ValID, GlobalValue *>()))
2541 .first->second.insert(std::make_pair(std::move(Label), nullptr))
2544 FwdRef = new GlobalVariable(*M, Type::getInt8Ty(Context), false,
2545 GlobalValue::InternalLinkage, nullptr, "");
2546 ID.ConstantVal = FwdRef;
2547 ID.Kind = ValID::t_Constant;
2551 // We found the function; now find the basic block. Don't use PFS, since we
2552 // might be inside a constant expression.
2554 if (BlockAddressPFS && F == &BlockAddressPFS->getFunction()) {
2555 if (Label.Kind == ValID::t_LocalID)
2556 BB = BlockAddressPFS->GetBB(Label.UIntVal, Label.Loc);
2558 BB = BlockAddressPFS->GetBB(Label.StrVal, Label.Loc);
2560 return Error(Label.Loc, "referenced value is not a basic block");
2562 if (Label.Kind == ValID::t_LocalID)
2563 return Error(Label.Loc, "cannot take address of numeric label after "
2564 "the function is defined");
2565 BB = dyn_cast_or_null<BasicBlock>(
2566 F->getValueSymbolTable().lookup(Label.StrVal));
2568 return Error(Label.Loc, "referenced value is not a basic block");
2571 ID.ConstantVal = BlockAddress::get(F, BB);
2572 ID.Kind = ValID::t_Constant;
2576 case lltok::kw_trunc:
2577 case lltok::kw_zext:
2578 case lltok::kw_sext:
2579 case lltok::kw_fptrunc:
2580 case lltok::kw_fpext:
2581 case lltok::kw_bitcast:
2582 case lltok::kw_addrspacecast:
2583 case lltok::kw_uitofp:
2584 case lltok::kw_sitofp:
2585 case lltok::kw_fptoui:
2586 case lltok::kw_fptosi:
2587 case lltok::kw_inttoptr:
2588 case lltok::kw_ptrtoint: {
2589 unsigned Opc = Lex.getUIntVal();
2590 Type *DestTy = nullptr;
2593 if (ParseToken(lltok::lparen, "expected '(' after constantexpr cast") ||
2594 ParseGlobalTypeAndValue(SrcVal) ||
2595 ParseToken(lltok::kw_to, "expected 'to' in constantexpr cast") ||
2596 ParseType(DestTy) ||
2597 ParseToken(lltok::rparen, "expected ')' at end of constantexpr cast"))
2599 if (!CastInst::castIsValid((Instruction::CastOps)Opc, SrcVal, DestTy))
2600 return Error(ID.Loc, "invalid cast opcode for cast from '" +
2601 getTypeString(SrcVal->getType()) + "' to '" +
2602 getTypeString(DestTy) + "'");
2603 ID.ConstantVal = ConstantExpr::getCast((Instruction::CastOps)Opc,
2605 ID.Kind = ValID::t_Constant;
2608 case lltok::kw_extractvalue: {
2611 SmallVector<unsigned, 4> Indices;
2612 if (ParseToken(lltok::lparen, "expected '(' in extractvalue constantexpr")||
2613 ParseGlobalTypeAndValue(Val) ||
2614 ParseIndexList(Indices) ||
2615 ParseToken(lltok::rparen, "expected ')' in extractvalue constantexpr"))
2618 if (!Val->getType()->isAggregateType())
2619 return Error(ID.Loc, "extractvalue operand must be aggregate type");
2620 if (!ExtractValueInst::getIndexedType(Val->getType(), Indices))
2621 return Error(ID.Loc, "invalid indices for extractvalue");
2622 ID.ConstantVal = ConstantExpr::getExtractValue(Val, Indices);
2623 ID.Kind = ValID::t_Constant;
2626 case lltok::kw_insertvalue: {
2628 Constant *Val0, *Val1;
2629 SmallVector<unsigned, 4> Indices;
2630 if (ParseToken(lltok::lparen, "expected '(' in insertvalue constantexpr")||
2631 ParseGlobalTypeAndValue(Val0) ||
2632 ParseToken(lltok::comma, "expected comma in insertvalue constantexpr")||
2633 ParseGlobalTypeAndValue(Val1) ||
2634 ParseIndexList(Indices) ||
2635 ParseToken(lltok::rparen, "expected ')' in insertvalue constantexpr"))
2637 if (!Val0->getType()->isAggregateType())
2638 return Error(ID.Loc, "insertvalue operand must be aggregate type");
2640 ExtractValueInst::getIndexedType(Val0->getType(), Indices);
2642 return Error(ID.Loc, "invalid indices for insertvalue");
2643 if (IndexedType != Val1->getType())
2644 return Error(ID.Loc, "insertvalue operand and field disagree in type: '" +
2645 getTypeString(Val1->getType()) +
2646 "' instead of '" + getTypeString(IndexedType) +
2648 ID.ConstantVal = ConstantExpr::getInsertValue(Val0, Val1, Indices);
2649 ID.Kind = ValID::t_Constant;
2652 case lltok::kw_icmp:
2653 case lltok::kw_fcmp: {
2654 unsigned PredVal, Opc = Lex.getUIntVal();
2655 Constant *Val0, *Val1;
2657 if (ParseCmpPredicate(PredVal, Opc) ||
2658 ParseToken(lltok::lparen, "expected '(' in compare constantexpr") ||
2659 ParseGlobalTypeAndValue(Val0) ||
2660 ParseToken(lltok::comma, "expected comma in compare constantexpr") ||
2661 ParseGlobalTypeAndValue(Val1) ||
2662 ParseToken(lltok::rparen, "expected ')' in compare constantexpr"))
2665 if (Val0->getType() != Val1->getType())
2666 return Error(ID.Loc, "compare operands must have the same type");
2668 CmpInst::Predicate Pred = (CmpInst::Predicate)PredVal;
2670 if (Opc == Instruction::FCmp) {
2671 if (!Val0->getType()->isFPOrFPVectorTy())
2672 return Error(ID.Loc, "fcmp requires floating point operands");
2673 ID.ConstantVal = ConstantExpr::getFCmp(Pred, Val0, Val1);
2675 assert(Opc == Instruction::ICmp && "Unexpected opcode for CmpInst!");
2676 if (!Val0->getType()->isIntOrIntVectorTy() &&
2677 !Val0->getType()->getScalarType()->isPointerTy())
2678 return Error(ID.Loc, "icmp requires pointer or integer operands");
2679 ID.ConstantVal = ConstantExpr::getICmp(Pred, Val0, Val1);
2681 ID.Kind = ValID::t_Constant;
2685 // Binary Operators.
2687 case lltok::kw_fadd:
2689 case lltok::kw_fsub:
2691 case lltok::kw_fmul:
2692 case lltok::kw_udiv:
2693 case lltok::kw_sdiv:
2694 case lltok::kw_fdiv:
2695 case lltok::kw_urem:
2696 case lltok::kw_srem:
2697 case lltok::kw_frem:
2699 case lltok::kw_lshr:
2700 case lltok::kw_ashr: {
2704 unsigned Opc = Lex.getUIntVal();
2705 Constant *Val0, *Val1;
2707 LocTy ModifierLoc = Lex.getLoc();
2708 if (Opc == Instruction::Add || Opc == Instruction::Sub ||
2709 Opc == Instruction::Mul || Opc == Instruction::Shl) {
2710 if (EatIfPresent(lltok::kw_nuw))
2712 if (EatIfPresent(lltok::kw_nsw)) {
2714 if (EatIfPresent(lltok::kw_nuw))
2717 } else if (Opc == Instruction::SDiv || Opc == Instruction::UDiv ||
2718 Opc == Instruction::LShr || Opc == Instruction::AShr) {
2719 if (EatIfPresent(lltok::kw_exact))
2722 if (ParseToken(lltok::lparen, "expected '(' in binary constantexpr") ||
2723 ParseGlobalTypeAndValue(Val0) ||
2724 ParseToken(lltok::comma, "expected comma in binary constantexpr") ||
2725 ParseGlobalTypeAndValue(Val1) ||
2726 ParseToken(lltok::rparen, "expected ')' in binary constantexpr"))
2728 if (Val0->getType() != Val1->getType())
2729 return Error(ID.Loc, "operands of constexpr must have same type");
2730 if (!Val0->getType()->isIntOrIntVectorTy()) {
2732 return Error(ModifierLoc, "nuw only applies to integer operations");
2734 return Error(ModifierLoc, "nsw only applies to integer operations");
2736 // Check that the type is valid for the operator.
2738 case Instruction::Add:
2739 case Instruction::Sub:
2740 case Instruction::Mul:
2741 case Instruction::UDiv:
2742 case Instruction::SDiv:
2743 case Instruction::URem:
2744 case Instruction::SRem:
2745 case Instruction::Shl:
2746 case Instruction::AShr:
2747 case Instruction::LShr:
2748 if (!Val0->getType()->isIntOrIntVectorTy())
2749 return Error(ID.Loc, "constexpr requires integer operands");
2751 case Instruction::FAdd:
2752 case Instruction::FSub:
2753 case Instruction::FMul:
2754 case Instruction::FDiv:
2755 case Instruction::FRem:
2756 if (!Val0->getType()->isFPOrFPVectorTy())
2757 return Error(ID.Loc, "constexpr requires fp operands");
2759 default: llvm_unreachable("Unknown binary operator!");
2762 if (NUW) Flags |= OverflowingBinaryOperator::NoUnsignedWrap;
2763 if (NSW) Flags |= OverflowingBinaryOperator::NoSignedWrap;
2764 if (Exact) Flags |= PossiblyExactOperator::IsExact;
2765 Constant *C = ConstantExpr::get(Opc, Val0, Val1, Flags);
2767 ID.Kind = ValID::t_Constant;
2771 // Logical Operations
2774 case lltok::kw_xor: {
2775 unsigned Opc = Lex.getUIntVal();
2776 Constant *Val0, *Val1;
2778 if (ParseToken(lltok::lparen, "expected '(' in logical constantexpr") ||
2779 ParseGlobalTypeAndValue(Val0) ||
2780 ParseToken(lltok::comma, "expected comma in logical constantexpr") ||
2781 ParseGlobalTypeAndValue(Val1) ||
2782 ParseToken(lltok::rparen, "expected ')' in logical constantexpr"))
2784 if (Val0->getType() != Val1->getType())
2785 return Error(ID.Loc, "operands of constexpr must have same type");
2786 if (!Val0->getType()->isIntOrIntVectorTy())
2787 return Error(ID.Loc,
2788 "constexpr requires integer or integer vector operands");
2789 ID.ConstantVal = ConstantExpr::get(Opc, Val0, Val1);
2790 ID.Kind = ValID::t_Constant;
2794 case lltok::kw_getelementptr:
2795 case lltok::kw_shufflevector:
2796 case lltok::kw_insertelement:
2797 case lltok::kw_extractelement:
2798 case lltok::kw_select: {
2799 unsigned Opc = Lex.getUIntVal();
2800 SmallVector<Constant*, 16> Elts;
2801 bool InBounds = false;
2805 if (Opc == Instruction::GetElementPtr)
2806 InBounds = EatIfPresent(lltok::kw_inbounds);
2808 if (ParseToken(lltok::lparen, "expected '(' in constantexpr"))
2811 LocTy ExplicitTypeLoc = Lex.getLoc();
2812 if (Opc == Instruction::GetElementPtr) {
2813 if (ParseType(Ty) ||
2814 ParseToken(lltok::comma, "expected comma after getelementptr's type"))
2818 if (ParseGlobalValueVector(Elts) ||
2819 ParseToken(lltok::rparen, "expected ')' in constantexpr"))
2822 if (Opc == Instruction::GetElementPtr) {
2823 if (Elts.size() == 0 ||
2824 !Elts[0]->getType()->getScalarType()->isPointerTy())
2825 return Error(ID.Loc, "base of getelementptr must be a pointer");
2827 Type *BaseType = Elts[0]->getType();
2828 auto *BasePointerType = cast<PointerType>(BaseType->getScalarType());
2829 if (Ty != BasePointerType->getElementType())
2832 "explicit pointee type doesn't match operand's pointee type");
2834 ArrayRef<Constant *> Indices(Elts.begin() + 1, Elts.end());
2835 for (Constant *Val : Indices) {
2836 Type *ValTy = Val->getType();
2837 if (!ValTy->getScalarType()->isIntegerTy())
2838 return Error(ID.Loc, "getelementptr index must be an integer");
2839 if (ValTy->isVectorTy() != BaseType->isVectorTy())
2840 return Error(ID.Loc, "getelementptr index type missmatch");
2841 if (ValTy->isVectorTy()) {
2842 unsigned ValNumEl = cast<VectorType>(ValTy)->getNumElements();
2843 unsigned PtrNumEl = cast<VectorType>(BaseType)->getNumElements();
2844 if (ValNumEl != PtrNumEl)
2847 "getelementptr vector index has a wrong number of elements");
2851 SmallPtrSet<const Type*, 4> Visited;
2852 if (!Indices.empty() && !Ty->isSized(&Visited))
2853 return Error(ID.Loc, "base element of getelementptr must be sized");
2855 if (!GetElementPtrInst::getIndexedType(Ty, Indices))
2856 return Error(ID.Loc, "invalid getelementptr indices");
2858 ConstantExpr::getGetElementPtr(Ty, Elts[0], Indices, InBounds);
2859 } else if (Opc == Instruction::Select) {
2860 if (Elts.size() != 3)
2861 return Error(ID.Loc, "expected three operands to select");
2862 if (const char *Reason = SelectInst::areInvalidOperands(Elts[0], Elts[1],
2864 return Error(ID.Loc, Reason);
2865 ID.ConstantVal = ConstantExpr::getSelect(Elts[0], Elts[1], Elts[2]);
2866 } else if (Opc == Instruction::ShuffleVector) {
2867 if (Elts.size() != 3)
2868 return Error(ID.Loc, "expected three operands to shufflevector");
2869 if (!ShuffleVectorInst::isValidOperands(Elts[0], Elts[1], Elts[2]))
2870 return Error(ID.Loc, "invalid operands to shufflevector");
2872 ConstantExpr::getShuffleVector(Elts[0], Elts[1],Elts[2]);
2873 } else if (Opc == Instruction::ExtractElement) {
2874 if (Elts.size() != 2)
2875 return Error(ID.Loc, "expected two operands to extractelement");
2876 if (!ExtractElementInst::isValidOperands(Elts[0], Elts[1]))
2877 return Error(ID.Loc, "invalid extractelement operands");
2878 ID.ConstantVal = ConstantExpr::getExtractElement(Elts[0], Elts[1]);
2880 assert(Opc == Instruction::InsertElement && "Unknown opcode");
2881 if (Elts.size() != 3)
2882 return Error(ID.Loc, "expected three operands to insertelement");
2883 if (!InsertElementInst::isValidOperands(Elts[0], Elts[1], Elts[2]))
2884 return Error(ID.Loc, "invalid insertelement operands");
2886 ConstantExpr::getInsertElement(Elts[0], Elts[1],Elts[2]);
2889 ID.Kind = ValID::t_Constant;
2898 /// ParseGlobalValue - Parse a global value with the specified type.
2899 bool LLParser::ParseGlobalValue(Type *Ty, Constant *&C) {
2903 bool Parsed = ParseValID(ID) ||
2904 ConvertValIDToValue(Ty, ID, V, nullptr);
2905 if (V && !(C = dyn_cast<Constant>(V)))
2906 return Error(ID.Loc, "global values must be constants");
2910 bool LLParser::ParseGlobalTypeAndValue(Constant *&V) {
2912 return ParseType(Ty) ||
2913 ParseGlobalValue(Ty, V);
2916 bool LLParser::parseOptionalComdat(StringRef GlobalName, Comdat *&C) {
2919 LocTy KwLoc = Lex.getLoc();
2920 if (!EatIfPresent(lltok::kw_comdat))
2923 if (EatIfPresent(lltok::lparen)) {
2924 if (Lex.getKind() != lltok::ComdatVar)
2925 return TokError("expected comdat variable");
2926 C = getComdat(Lex.getStrVal(), Lex.getLoc());
2928 if (ParseToken(lltok::rparen, "expected ')' after comdat var"))
2931 if (GlobalName.empty())
2932 return TokError("comdat cannot be unnamed");
2933 C = getComdat(GlobalName, KwLoc);
2939 /// ParseGlobalValueVector
2941 /// ::= TypeAndValue (',' TypeAndValue)*
2942 bool LLParser::ParseGlobalValueVector(SmallVectorImpl<Constant *> &Elts) {
2944 if (Lex.getKind() == lltok::rbrace ||
2945 Lex.getKind() == lltok::rsquare ||
2946 Lex.getKind() == lltok::greater ||
2947 Lex.getKind() == lltok::rparen)
2951 if (ParseGlobalTypeAndValue(C)) return true;
2954 while (EatIfPresent(lltok::comma)) {
2955 if (ParseGlobalTypeAndValue(C)) return true;
2962 bool LLParser::ParseMDTuple(MDNode *&MD, bool IsDistinct) {
2963 SmallVector<Metadata *, 16> Elts;
2964 if (ParseMDNodeVector(Elts))
2967 MD = (IsDistinct ? MDTuple::getDistinct : MDTuple::get)(Context, Elts);
2974 /// ::= !MDLocation(...)
2975 bool LLParser::ParseMDNode(MDNode *&N) {
2976 if (Lex.getKind() == lltok::MetadataVar)
2977 return ParseSpecializedMDNode(N);
2979 return ParseToken(lltok::exclaim, "expected '!' here") ||
2983 bool LLParser::ParseMDNodeTail(MDNode *&N) {
2985 if (Lex.getKind() == lltok::lbrace)
2986 return ParseMDTuple(N);
2989 return ParseMDNodeID(N);
2994 /// Structure to represent an optional metadata field.
2995 template <class FieldTy> struct MDFieldImpl {
2996 typedef MDFieldImpl ImplTy;
3000 void assign(FieldTy Val) {
3002 this->Val = std::move(Val);
3005 explicit MDFieldImpl(FieldTy Default)
3006 : Val(std::move(Default)), Seen(false) {}
3009 struct MDUnsignedField : public MDFieldImpl<uint64_t> {
3012 MDUnsignedField(uint64_t Default = 0, uint64_t Max = UINT64_MAX)
3013 : ImplTy(Default), Max(Max) {}
3015 struct LineField : public MDUnsignedField {
3016 LineField() : MDUnsignedField(0, UINT32_MAX) {}
3018 struct ColumnField : public MDUnsignedField {
3019 ColumnField() : MDUnsignedField(0, UINT16_MAX) {}
3021 struct DwarfTagField : public MDUnsignedField {
3022 DwarfTagField() : MDUnsignedField(0, dwarf::DW_TAG_hi_user) {}
3023 DwarfTagField(dwarf::Tag DefaultTag)
3024 : MDUnsignedField(DefaultTag, dwarf::DW_TAG_hi_user) {}
3026 struct DwarfAttEncodingField : public MDUnsignedField {
3027 DwarfAttEncodingField() : MDUnsignedField(0, dwarf::DW_ATE_hi_user) {}
3029 struct DwarfVirtualityField : public MDUnsignedField {
3030 DwarfVirtualityField() : MDUnsignedField(0, dwarf::DW_VIRTUALITY_max) {}
3032 struct DwarfLangField : public MDUnsignedField {
3033 DwarfLangField() : MDUnsignedField(0, dwarf::DW_LANG_hi_user) {}
3036 struct DIFlagField : public MDUnsignedField {
3037 DIFlagField() : MDUnsignedField(0, UINT32_MAX) {}
3040 struct MDSignedField : public MDFieldImpl<int64_t> {
3044 MDSignedField(int64_t Default = 0)
3045 : ImplTy(Default), Min(INT64_MIN), Max(INT64_MAX) {}
3046 MDSignedField(int64_t Default, int64_t Min, int64_t Max)
3047 : ImplTy(Default), Min(Min), Max(Max) {}
3050 struct MDBoolField : public MDFieldImpl<bool> {
3051 MDBoolField(bool Default = false) : ImplTy(Default) {}
3053 struct MDField : public MDFieldImpl<Metadata *> {
3056 MDField(bool AllowNull = true) : ImplTy(nullptr), AllowNull(AllowNull) {}
3058 struct MDConstant : public MDFieldImpl<ConstantAsMetadata *> {
3059 MDConstant() : ImplTy(nullptr) {}
3061 struct MDStringField : public MDFieldImpl<MDString *> {
3063 MDStringField(bool AllowEmpty = true)
3064 : ImplTy(nullptr), AllowEmpty(AllowEmpty) {}
3066 struct MDFieldList : public MDFieldImpl<SmallVector<Metadata *, 4>> {
3067 MDFieldList() : ImplTy(SmallVector<Metadata *, 4>()) {}
3075 bool LLParser::ParseMDField(LocTy Loc, StringRef Name,
3076 MDUnsignedField &Result) {
3077 if (Lex.getKind() != lltok::APSInt || Lex.getAPSIntVal().isSigned())
3078 return TokError("expected unsigned integer");
3080 auto &U = Lex.getAPSIntVal();
3081 if (U.ugt(Result.Max))
3082 return TokError("value for '" + Name + "' too large, limit is " +
3084 Result.assign(U.getZExtValue());
3085 assert(Result.Val <= Result.Max && "Expected value in range");
3091 bool LLParser::ParseMDField(LocTy Loc, StringRef Name, LineField &Result) {
3092 return ParseMDField(Loc, Name, static_cast<MDUnsignedField &>(Result));
3095 bool LLParser::ParseMDField(LocTy Loc, StringRef Name, ColumnField &Result) {
3096 return ParseMDField(Loc, Name, static_cast<MDUnsignedField &>(Result));
3100 bool LLParser::ParseMDField(LocTy Loc, StringRef Name, DwarfTagField &Result) {
3101 if (Lex.getKind() == lltok::APSInt)
3102 return ParseMDField(Loc, Name, static_cast<MDUnsignedField &>(Result));
3104 if (Lex.getKind() != lltok::DwarfTag)
3105 return TokError("expected DWARF tag");
3107 unsigned Tag = dwarf::getTag(Lex.getStrVal());
3108 if (Tag == dwarf::DW_TAG_invalid)
3109 return TokError("invalid DWARF tag" + Twine(" '") + Lex.getStrVal() + "'");
3110 assert(Tag <= Result.Max && "Expected valid DWARF tag");
3118 bool LLParser::ParseMDField(LocTy Loc, StringRef Name,
3119 DwarfVirtualityField &Result) {
3120 if (Lex.getKind() == lltok::APSInt)
3121 return ParseMDField(Loc, Name, static_cast<MDUnsignedField &>(Result));
3123 if (Lex.getKind() != lltok::DwarfVirtuality)
3124 return TokError("expected DWARF virtuality code");
3126 unsigned Virtuality = dwarf::getVirtuality(Lex.getStrVal());
3128 return TokError("invalid DWARF virtuality code" + Twine(" '") +
3129 Lex.getStrVal() + "'");
3130 assert(Virtuality <= Result.Max && "Expected valid DWARF virtuality code");
3131 Result.assign(Virtuality);
3137 bool LLParser::ParseMDField(LocTy Loc, StringRef Name, DwarfLangField &Result) {
3138 if (Lex.getKind() == lltok::APSInt)
3139 return ParseMDField(Loc, Name, static_cast<MDUnsignedField &>(Result));
3141 if (Lex.getKind() != lltok::DwarfLang)
3142 return TokError("expected DWARF language");
3144 unsigned Lang = dwarf::getLanguage(Lex.getStrVal());
3146 return TokError("invalid DWARF language" + Twine(" '") + Lex.getStrVal() +
3148 assert(Lang <= Result.Max && "Expected valid DWARF language");
3149 Result.assign(Lang);
3155 bool LLParser::ParseMDField(LocTy Loc, StringRef Name,
3156 DwarfAttEncodingField &Result) {
3157 if (Lex.getKind() == lltok::APSInt)
3158 return ParseMDField(Loc, Name, static_cast<MDUnsignedField &>(Result));
3160 if (Lex.getKind() != lltok::DwarfAttEncoding)
3161 return TokError("expected DWARF type attribute encoding");
3163 unsigned Encoding = dwarf::getAttributeEncoding(Lex.getStrVal());
3165 return TokError("invalid DWARF type attribute encoding" + Twine(" '") +
3166 Lex.getStrVal() + "'");
3167 assert(Encoding <= Result.Max && "Expected valid DWARF language");
3168 Result.assign(Encoding);
3175 /// ::= DIFlagVector
3176 /// ::= DIFlagVector '|' DIFlagFwdDecl '|' uint32 '|' DIFlagPublic
3178 bool LLParser::ParseMDField(LocTy Loc, StringRef Name, DIFlagField &Result) {
3179 assert(Result.Max == UINT32_MAX && "Expected only 32-bits");
3181 // Parser for a single flag.
3182 auto parseFlag = [&](unsigned &Val) {
3183 if (Lex.getKind() == lltok::APSInt && !Lex.getAPSIntVal().isSigned())
3184 return ParseUInt32(Val);
3186 if (Lex.getKind() != lltok::DIFlag)
3187 return TokError("expected debug info flag");
3189 Val = DebugNode::getFlag(Lex.getStrVal());
3191 return TokError(Twine("invalid debug info flag flag '") +
3192 Lex.getStrVal() + "'");
3197 // Parse the flags and combine them together.
3198 unsigned Combined = 0;
3204 } while (EatIfPresent(lltok::bar));
3206 Result.assign(Combined);
3211 bool LLParser::ParseMDField(LocTy Loc, StringRef Name,
3212 MDSignedField &Result) {
3213 if (Lex.getKind() != lltok::APSInt)
3214 return TokError("expected signed integer");
3216 auto &S = Lex.getAPSIntVal();
3218 return TokError("value for '" + Name + "' too small, limit is " +
3221 return TokError("value for '" + Name + "' too large, limit is " +
3223 Result.assign(S.getExtValue());
3224 assert(Result.Val >= Result.Min && "Expected value in range");
3225 assert(Result.Val <= Result.Max && "Expected value in range");
3231 bool LLParser::ParseMDField(LocTy Loc, StringRef Name, MDBoolField &Result) {
3232 switch (Lex.getKind()) {
3234 return TokError("expected 'true' or 'false'");
3235 case lltok::kw_true:
3236 Result.assign(true);
3238 case lltok::kw_false:
3239 Result.assign(false);
3247 bool LLParser::ParseMDField(LocTy Loc, StringRef Name, MDField &Result) {
3248 if (Lex.getKind() == lltok::kw_null) {
3249 if (!Result.AllowNull)
3250 return TokError("'" + Name + "' cannot be null");
3252 Result.assign(nullptr);
3257 if (ParseMetadata(MD, nullptr))
3265 bool LLParser::ParseMDField(LocTy Loc, StringRef Name, MDConstant &Result) {
3267 if (ParseValueAsMetadata(MD, "expected constant", nullptr))
3270 Result.assign(cast<ConstantAsMetadata>(MD));
3275 bool LLParser::ParseMDField(LocTy Loc, StringRef Name, MDStringField &Result) {
3276 LocTy ValueLoc = Lex.getLoc();
3278 if (ParseStringConstant(S))
3281 if (!Result.AllowEmpty && S.empty())
3282 return Error(ValueLoc, "'" + Name + "' cannot be empty");
3284 Result.assign(S.empty() ? nullptr : MDString::get(Context, S));
3289 bool LLParser::ParseMDField(LocTy Loc, StringRef Name, MDFieldList &Result) {
3290 SmallVector<Metadata *, 4> MDs;
3291 if (ParseMDNodeVector(MDs))
3294 Result.assign(std::move(MDs));
3298 } // end namespace llvm
3300 template <class ParserTy>
3301 bool LLParser::ParseMDFieldsImplBody(ParserTy parseField) {
3303 if (Lex.getKind() != lltok::LabelStr)
3304 return TokError("expected field label here");
3308 } while (EatIfPresent(lltok::comma));
3313 template <class ParserTy>
3314 bool LLParser::ParseMDFieldsImpl(ParserTy parseField, LocTy &ClosingLoc) {
3315 assert(Lex.getKind() == lltok::MetadataVar && "Expected metadata type name");
3318 if (ParseToken(lltok::lparen, "expected '(' here"))
3320 if (Lex.getKind() != lltok::rparen)
3321 if (ParseMDFieldsImplBody(parseField))
3324 ClosingLoc = Lex.getLoc();
3325 return ParseToken(lltok::rparen, "expected ')' here");
3328 template <class FieldTy>
3329 bool LLParser::ParseMDField(StringRef Name, FieldTy &Result) {
3331 return TokError("field '" + Name + "' cannot be specified more than once");
3333 LocTy Loc = Lex.getLoc();
3335 return ParseMDField(Loc, Name, Result);
3338 bool LLParser::ParseSpecializedMDNode(MDNode *&N, bool IsDistinct) {
3339 assert(Lex.getKind() == lltok::MetadataVar && "Expected metadata type name");
3341 #define HANDLE_SPECIALIZED_MDNODE_LEAF(CLASS) \
3342 if (Lex.getStrVal() == #CLASS) \
3343 return Parse##CLASS(N, IsDistinct);
3344 #include "llvm/IR/Metadata.def"
3346 return TokError("expected metadata type");
3349 #define DECLARE_FIELD(NAME, TYPE, INIT) TYPE NAME INIT
3350 #define NOP_FIELD(NAME, TYPE, INIT)
3351 #define REQUIRE_FIELD(NAME, TYPE, INIT) \
3353 return Error(ClosingLoc, "missing required field '" #NAME "'");
3354 #define PARSE_MD_FIELD(NAME, TYPE, DEFAULT) \
3355 if (Lex.getStrVal() == #NAME) \
3356 return ParseMDField(#NAME, NAME);
3357 #define PARSE_MD_FIELDS() \
3358 VISIT_MD_FIELDS(DECLARE_FIELD, DECLARE_FIELD) \
3361 if (ParseMDFieldsImpl([&]() -> bool { \
3362 VISIT_MD_FIELDS(PARSE_MD_FIELD, PARSE_MD_FIELD) \
3363 return TokError(Twine("invalid field '") + Lex.getStrVal() + "'"); \
3366 VISIT_MD_FIELDS(NOP_FIELD, REQUIRE_FIELD) \
3368 #define GET_OR_DISTINCT(CLASS, ARGS) \
3369 (IsDistinct ? CLASS::getDistinct ARGS : CLASS::get ARGS)
3371 /// ParseMDLocationFields:
3372 /// ::= !MDLocation(line: 43, column: 8, scope: !5, inlinedAt: !6)
3373 bool LLParser::ParseMDLocation(MDNode *&Result, bool IsDistinct) {
3374 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED) \
3375 OPTIONAL(line, LineField, ); \
3376 OPTIONAL(column, ColumnField, ); \
3377 REQUIRED(scope, MDField, (/* AllowNull */ false)); \
3378 OPTIONAL(inlinedAt, MDField, );
3380 #undef VISIT_MD_FIELDS
3382 Result = GET_OR_DISTINCT(
3383 MDLocation, (Context, line.Val, column.Val, scope.Val, inlinedAt.Val));
3387 /// ParseGenericDebugNode:
3388 /// ::= !GenericDebugNode(tag: 15, header: "...", operands: {...})
3389 bool LLParser::ParseGenericDebugNode(MDNode *&Result, bool IsDistinct) {
3390 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED) \
3391 REQUIRED(tag, DwarfTagField, ); \
3392 OPTIONAL(header, MDStringField, ); \
3393 OPTIONAL(operands, MDFieldList, );
3395 #undef VISIT_MD_FIELDS
3397 Result = GET_OR_DISTINCT(GenericDebugNode,
3398 (Context, tag.Val, header.Val, operands.Val));
3402 /// ParseMDSubrange:
3403 /// ::= !MDSubrange(count: 30, lowerBound: 2)
3404 bool LLParser::ParseMDSubrange(MDNode *&Result, bool IsDistinct) {
3405 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED) \
3406 REQUIRED(count, MDSignedField, (-1, -1, INT64_MAX)); \
3407 OPTIONAL(lowerBound, MDSignedField, );
3409 #undef VISIT_MD_FIELDS
3411 Result = GET_OR_DISTINCT(MDSubrange, (Context, count.Val, lowerBound.Val));
3415 /// ParseMDEnumerator:
3416 /// ::= !MDEnumerator(value: 30, name: "SomeKind")
3417 bool LLParser::ParseMDEnumerator(MDNode *&Result, bool IsDistinct) {
3418 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED) \
3419 REQUIRED(name, MDStringField, ); \
3420 REQUIRED(value, MDSignedField, );
3422 #undef VISIT_MD_FIELDS
3424 Result = GET_OR_DISTINCT(MDEnumerator, (Context, value.Val, name.Val));
3428 /// ParseMDBasicType:
3429 /// ::= !MDBasicType(tag: DW_TAG_base_type, name: "int", size: 32, align: 32)
3430 bool LLParser::ParseMDBasicType(MDNode *&Result, bool IsDistinct) {
3431 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED) \
3432 OPTIONAL(tag, DwarfTagField, (dwarf::DW_TAG_base_type)); \
3433 OPTIONAL(name, MDStringField, ); \
3434 OPTIONAL(size, MDUnsignedField, (0, UINT64_MAX)); \
3435 OPTIONAL(align, MDUnsignedField, (0, UINT64_MAX)); \
3436 OPTIONAL(encoding, DwarfAttEncodingField, );
3438 #undef VISIT_MD_FIELDS
3440 Result = GET_OR_DISTINCT(MDBasicType, (Context, tag.Val, name.Val, size.Val,
3441 align.Val, encoding.Val));
3445 /// ParseMDDerivedType:
3446 /// ::= !MDDerivedType(tag: DW_TAG_pointer_type, name: "int", file: !0,
3447 /// line: 7, scope: !1, baseType: !2, size: 32,
3448 /// align: 32, offset: 0, flags: 0, extraData: !3)
3449 bool LLParser::ParseMDDerivedType(MDNode *&Result, bool IsDistinct) {
3450 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED) \
3451 REQUIRED(tag, DwarfTagField, ); \
3452 OPTIONAL(name, MDStringField, ); \
3453 OPTIONAL(file, MDField, ); \
3454 OPTIONAL(line, LineField, ); \
3455 OPTIONAL(scope, MDField, ); \
3456 REQUIRED(baseType, MDField, ); \
3457 OPTIONAL(size, MDUnsignedField, (0, UINT64_MAX)); \
3458 OPTIONAL(align, MDUnsignedField, (0, UINT64_MAX)); \
3459 OPTIONAL(offset, MDUnsignedField, (0, UINT64_MAX)); \
3460 OPTIONAL(flags, DIFlagField, ); \
3461 OPTIONAL(extraData, MDField, );
3463 #undef VISIT_MD_FIELDS
3465 Result = GET_OR_DISTINCT(MDDerivedType,
3466 (Context, tag.Val, name.Val, file.Val, line.Val,
3467 scope.Val, baseType.Val, size.Val, align.Val,
3468 offset.Val, flags.Val, extraData.Val));
3472 bool LLParser::ParseMDCompositeType(MDNode *&Result, bool IsDistinct) {
3473 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED) \
3474 REQUIRED(tag, DwarfTagField, ); \
3475 OPTIONAL(name, MDStringField, ); \
3476 OPTIONAL(file, MDField, ); \
3477 OPTIONAL(line, LineField, ); \
3478 OPTIONAL(scope, MDField, ); \
3479 OPTIONAL(baseType, MDField, ); \
3480 OPTIONAL(size, MDUnsignedField, (0, UINT64_MAX)); \
3481 OPTIONAL(align, MDUnsignedField, (0, UINT64_MAX)); \
3482 OPTIONAL(offset, MDUnsignedField, (0, UINT64_MAX)); \
3483 OPTIONAL(flags, DIFlagField, ); \
3484 OPTIONAL(elements, MDField, ); \
3485 OPTIONAL(runtimeLang, DwarfLangField, ); \
3486 OPTIONAL(vtableHolder, MDField, ); \
3487 OPTIONAL(templateParams, MDField, ); \
3488 OPTIONAL(identifier, MDStringField, );
3490 #undef VISIT_MD_FIELDS
3492 Result = GET_OR_DISTINCT(
3494 (Context, tag.Val, name.Val, file.Val, line.Val, scope.Val, baseType.Val,
3495 size.Val, align.Val, offset.Val, flags.Val, elements.Val,
3496 runtimeLang.Val, vtableHolder.Val, templateParams.Val, identifier.Val));
3500 bool LLParser::ParseMDSubroutineType(MDNode *&Result, bool IsDistinct) {
3501 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED) \
3502 OPTIONAL(flags, DIFlagField, ); \
3503 REQUIRED(types, MDField, );
3505 #undef VISIT_MD_FIELDS
3507 Result = GET_OR_DISTINCT(MDSubroutineType, (Context, flags.Val, types.Val));
3511 /// ParseMDFileType:
3512 /// ::= !MDFileType(filename: "path/to/file", directory: "/path/to/dir")
3513 bool LLParser::ParseMDFile(MDNode *&Result, bool IsDistinct) {
3514 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED) \
3515 REQUIRED(filename, MDStringField, ); \
3516 REQUIRED(directory, MDStringField, );
3518 #undef VISIT_MD_FIELDS
3520 Result = GET_OR_DISTINCT(MDFile, (Context, filename.Val, directory.Val));
3524 /// ParseMDCompileUnit:
3525 /// ::= !MDCompileUnit(language: DW_LANG_C99, file: !0, producer: "clang",
3526 /// isOptimized: true, flags: "-O2", runtimeVersion: 1,
3527 /// splitDebugFilename: "abc.debug", emissionKind: 1,
3528 /// enums: !1, retainedTypes: !2, subprograms: !3,
3529 /// globals: !4, imports: !5)
3530 bool LLParser::ParseMDCompileUnit(MDNode *&Result, bool IsDistinct) {
3531 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED) \
3532 REQUIRED(language, DwarfLangField, ); \
3533 REQUIRED(file, MDField, (/* AllowNull */ false)); \
3534 OPTIONAL(producer, MDStringField, ); \
3535 OPTIONAL(isOptimized, MDBoolField, ); \
3536 OPTIONAL(flags, MDStringField, ); \
3537 OPTIONAL(runtimeVersion, MDUnsignedField, (0, UINT32_MAX)); \
3538 OPTIONAL(splitDebugFilename, MDStringField, ); \
3539 OPTIONAL(emissionKind, MDUnsignedField, (0, UINT32_MAX)); \
3540 OPTIONAL(enums, MDField, ); \
3541 OPTIONAL(retainedTypes, MDField, ); \
3542 OPTIONAL(subprograms, MDField, ); \
3543 OPTIONAL(globals, MDField, ); \
3544 OPTIONAL(imports, MDField, );
3546 #undef VISIT_MD_FIELDS
3548 Result = GET_OR_DISTINCT(MDCompileUnit,
3549 (Context, language.Val, file.Val, producer.Val,
3550 isOptimized.Val, flags.Val, runtimeVersion.Val,
3551 splitDebugFilename.Val, emissionKind.Val, enums.Val,
3552 retainedTypes.Val, subprograms.Val, globals.Val,
3557 /// ParseMDSubprogram:
3558 /// ::= !MDSubprogram(scope: !0, name: "foo", linkageName: "_Zfoo",
3559 /// file: !1, line: 7, type: !2, isLocal: false,
3560 /// isDefinition: true, scopeLine: 8, containingType: !3,
3561 /// virtuality: DW_VIRTUALTIY_pure_virtual,
3562 /// virtualIndex: 10, flags: 11,
3563 /// isOptimized: false, function: void ()* @_Z3foov,
3564 /// templateParams: !4, declaration: !5, variables: !6)
3565 bool LLParser::ParseMDSubprogram(MDNode *&Result, bool IsDistinct) {
3566 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED) \
3567 OPTIONAL(scope, MDField, ); \
3568 OPTIONAL(name, MDStringField, ); \
3569 OPTIONAL(linkageName, MDStringField, ); \
3570 OPTIONAL(file, MDField, ); \
3571 OPTIONAL(line, LineField, ); \
3572 OPTIONAL(type, MDField, ); \
3573 OPTIONAL(isLocal, MDBoolField, ); \
3574 OPTIONAL(isDefinition, MDBoolField, (true)); \
3575 OPTIONAL(scopeLine, LineField, ); \
3576 OPTIONAL(containingType, MDField, ); \
3577 OPTIONAL(virtuality, DwarfVirtualityField, ); \
3578 OPTIONAL(virtualIndex, MDUnsignedField, (0, UINT32_MAX)); \
3579 OPTIONAL(flags, DIFlagField, ); \
3580 OPTIONAL(isOptimized, MDBoolField, ); \
3581 OPTIONAL(function, MDConstant, ); \
3582 OPTIONAL(templateParams, MDField, ); \
3583 OPTIONAL(declaration, MDField, ); \
3584 OPTIONAL(variables, MDField, );
3586 #undef VISIT_MD_FIELDS
3588 Result = GET_OR_DISTINCT(
3589 MDSubprogram, (Context, scope.Val, name.Val, linkageName.Val, file.Val,
3590 line.Val, type.Val, isLocal.Val, isDefinition.Val,
3591 scopeLine.Val, containingType.Val, virtuality.Val,
3592 virtualIndex.Val, flags.Val, isOptimized.Val, function.Val,
3593 templateParams.Val, declaration.Val, variables.Val));
3597 /// ParseMDLexicalBlock:
3598 /// ::= !MDLexicalBlock(scope: !0, file: !2, line: 7, column: 9)
3599 bool LLParser::ParseMDLexicalBlock(MDNode *&Result, bool IsDistinct) {
3600 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED) \
3601 REQUIRED(scope, MDField, (/* AllowNull */ false)); \
3602 OPTIONAL(file, MDField, ); \
3603 OPTIONAL(line, LineField, ); \
3604 OPTIONAL(column, ColumnField, );
3606 #undef VISIT_MD_FIELDS
3608 Result = GET_OR_DISTINCT(
3609 MDLexicalBlock, (Context, scope.Val, file.Val, line.Val, column.Val));
3613 /// ParseMDLexicalBlockFile:
3614 /// ::= !MDLexicalBlockFile(scope: !0, file: !2, discriminator: 9)
3615 bool LLParser::ParseMDLexicalBlockFile(MDNode *&Result, bool IsDistinct) {
3616 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED) \
3617 REQUIRED(scope, MDField, (/* AllowNull */ false)); \
3618 OPTIONAL(file, MDField, ); \
3619 REQUIRED(discriminator, MDUnsignedField, (0, UINT32_MAX));
3621 #undef VISIT_MD_FIELDS
3623 Result = GET_OR_DISTINCT(MDLexicalBlockFile,
3624 (Context, scope.Val, file.Val, discriminator.Val));
3628 /// ParseMDNamespace:
3629 /// ::= !MDNamespace(scope: !0, file: !2, name: "SomeNamespace", line: 9)
3630 bool LLParser::ParseMDNamespace(MDNode *&Result, bool IsDistinct) {
3631 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED) \
3632 REQUIRED(scope, MDField, ); \
3633 OPTIONAL(file, MDField, ); \
3634 OPTIONAL(name, MDStringField, ); \
3635 OPTIONAL(line, LineField, );
3637 #undef VISIT_MD_FIELDS
3639 Result = GET_OR_DISTINCT(MDNamespace,
3640 (Context, scope.Val, file.Val, name.Val, line.Val));
3644 /// ParseMDTemplateTypeParameter:
3645 /// ::= !MDTemplateTypeParameter(name: "Ty", type: !1)
3646 bool LLParser::ParseMDTemplateTypeParameter(MDNode *&Result, bool IsDistinct) {
3647 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED) \
3648 OPTIONAL(name, MDStringField, ); \
3649 REQUIRED(type, MDField, );
3651 #undef VISIT_MD_FIELDS
3654 GET_OR_DISTINCT(MDTemplateTypeParameter, (Context, name.Val, type.Val));
3658 /// ParseMDTemplateValueParameter:
3659 /// ::= !MDTemplateValueParameter(tag: DW_TAG_template_value_parameter,
3660 /// name: "V", type: !1, value: i32 7)
3661 bool LLParser::ParseMDTemplateValueParameter(MDNode *&Result, bool IsDistinct) {
3662 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED) \
3663 OPTIONAL(tag, DwarfTagField, (dwarf::DW_TAG_template_value_parameter)); \
3664 OPTIONAL(name, MDStringField, ); \
3665 OPTIONAL(type, MDField, ); \
3666 REQUIRED(value, MDField, );
3668 #undef VISIT_MD_FIELDS
3670 Result = GET_OR_DISTINCT(MDTemplateValueParameter,
3671 (Context, tag.Val, name.Val, type.Val, value.Val));
3675 /// ParseMDGlobalVariable:
3676 /// ::= !MDGlobalVariable(scope: !0, name: "foo", linkageName: "foo",
3677 /// file: !1, line: 7, type: !2, isLocal: false,
3678 /// isDefinition: true, variable: i32* @foo,
3679 /// declaration: !3)
3680 bool LLParser::ParseMDGlobalVariable(MDNode *&Result, bool IsDistinct) {
3681 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED) \
3682 REQUIRED(name, MDStringField, (/* AllowEmpty */ false)); \
3683 OPTIONAL(scope, MDField, ); \
3684 OPTIONAL(linkageName, MDStringField, ); \
3685 OPTIONAL(file, MDField, ); \
3686 OPTIONAL(line, LineField, ); \
3687 OPTIONAL(type, MDField, ); \
3688 OPTIONAL(isLocal, MDBoolField, ); \
3689 OPTIONAL(isDefinition, MDBoolField, (true)); \
3690 OPTIONAL(variable, MDConstant, ); \
3691 OPTIONAL(declaration, MDField, );
3693 #undef VISIT_MD_FIELDS
3695 Result = GET_OR_DISTINCT(MDGlobalVariable,
3696 (Context, scope.Val, name.Val, linkageName.Val,
3697 file.Val, line.Val, type.Val, isLocal.Val,
3698 isDefinition.Val, variable.Val, declaration.Val));
3702 /// ParseMDLocalVariable:
3703 /// ::= !MDLocalVariable(tag: DW_TAG_arg_variable, scope: !0, name: "foo",
3704 /// file: !1, line: 7, type: !2, arg: 2, flags: 7)
3705 bool LLParser::ParseMDLocalVariable(MDNode *&Result, bool IsDistinct) {
3706 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED) \
3707 REQUIRED(tag, DwarfTagField, ); \
3708 REQUIRED(scope, MDField, (/* AllowNull */ false)); \
3709 OPTIONAL(name, MDStringField, ); \
3710 OPTIONAL(file, MDField, ); \
3711 OPTIONAL(line, LineField, ); \
3712 OPTIONAL(type, MDField, ); \
3713 OPTIONAL(arg, MDUnsignedField, (0, UINT8_MAX)); \
3714 OPTIONAL(flags, DIFlagField, );
3716 #undef VISIT_MD_FIELDS
3718 Result = GET_OR_DISTINCT(MDLocalVariable,
3719 (Context, tag.Val, scope.Val, name.Val, file.Val,
3720 line.Val, type.Val, arg.Val, flags.Val));
3724 /// ParseMDExpression:
3725 /// ::= !MDExpression(0, 7, -1)
3726 bool LLParser::ParseMDExpression(MDNode *&Result, bool IsDistinct) {
3727 assert(Lex.getKind() == lltok::MetadataVar && "Expected metadata type name");
3730 if (ParseToken(lltok::lparen, "expected '(' here"))
3733 SmallVector<uint64_t, 8> Elements;
3734 if (Lex.getKind() != lltok::rparen)
3736 if (Lex.getKind() == lltok::DwarfOp) {
3737 if (unsigned Op = dwarf::getOperationEncoding(Lex.getStrVal())) {
3739 Elements.push_back(Op);
3742 return TokError(Twine("invalid DWARF op '") + Lex.getStrVal() + "'");
3745 if (Lex.getKind() != lltok::APSInt || Lex.getAPSIntVal().isSigned())
3746 return TokError("expected unsigned integer");
3748 auto &U = Lex.getAPSIntVal();
3749 if (U.ugt(UINT64_MAX))
3750 return TokError("element too large, limit is " + Twine(UINT64_MAX));
3751 Elements.push_back(U.getZExtValue());
3753 } while (EatIfPresent(lltok::comma));
3755 if (ParseToken(lltok::rparen, "expected ')' here"))
3758 Result = GET_OR_DISTINCT(MDExpression, (Context, Elements));
3762 /// ParseMDObjCProperty:
3763 /// ::= !MDObjCProperty(name: "foo", file: !1, line: 7, setter: "setFoo",
3764 /// getter: "getFoo", attributes: 7, type: !2)
3765 bool LLParser::ParseMDObjCProperty(MDNode *&Result, bool IsDistinct) {
3766 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED) \
3767 OPTIONAL(name, MDStringField, ); \
3768 OPTIONAL(file, MDField, ); \
3769 OPTIONAL(line, LineField, ); \
3770 OPTIONAL(setter, MDStringField, ); \
3771 OPTIONAL(getter, MDStringField, ); \
3772 OPTIONAL(attributes, MDUnsignedField, (0, UINT32_MAX)); \
3773 OPTIONAL(type, MDField, );
3775 #undef VISIT_MD_FIELDS
3777 Result = GET_OR_DISTINCT(MDObjCProperty,
3778 (Context, name.Val, file.Val, line.Val, setter.Val,
3779 getter.Val, attributes.Val, type.Val));
3783 /// ParseMDImportedEntity:
3784 /// ::= !MDImportedEntity(tag: DW_TAG_imported_module, scope: !0, entity: !1,
3785 /// line: 7, name: "foo")
3786 bool LLParser::ParseMDImportedEntity(MDNode *&Result, bool IsDistinct) {
3787 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED) \
3788 REQUIRED(tag, DwarfTagField, ); \
3789 REQUIRED(scope, MDField, ); \
3790 OPTIONAL(entity, MDField, ); \
3791 OPTIONAL(line, LineField, ); \
3792 OPTIONAL(name, MDStringField, );
3794 #undef VISIT_MD_FIELDS
3796 Result = GET_OR_DISTINCT(MDImportedEntity, (Context, tag.Val, scope.Val,
3797 entity.Val, line.Val, name.Val));
3801 #undef PARSE_MD_FIELD
3803 #undef REQUIRE_FIELD
3804 #undef DECLARE_FIELD
3806 /// ParseMetadataAsValue
3807 /// ::= metadata i32 %local
3808 /// ::= metadata i32 @global
3809 /// ::= metadata i32 7
3811 /// ::= metadata !{...}
3812 /// ::= metadata !"string"
3813 bool LLParser::ParseMetadataAsValue(Value *&V, PerFunctionState &PFS) {
3814 // Note: the type 'metadata' has already been parsed.
3816 if (ParseMetadata(MD, &PFS))
3819 V = MetadataAsValue::get(Context, MD);
3823 /// ParseValueAsMetadata
3827 bool LLParser::ParseValueAsMetadata(Metadata *&MD, const Twine &TypeMsg,
3828 PerFunctionState *PFS) {
3831 if (ParseType(Ty, TypeMsg, Loc))
3833 if (Ty->isMetadataTy())
3834 return Error(Loc, "invalid metadata-value-metadata roundtrip");
3837 if (ParseValue(Ty, V, PFS))
3840 MD = ValueAsMetadata::get(V);
3851 /// ::= !MDLocation(...)
3852 bool LLParser::ParseMetadata(Metadata *&MD, PerFunctionState *PFS) {
3853 if (Lex.getKind() == lltok::MetadataVar) {
3855 if (ParseSpecializedMDNode(N))
3863 if (Lex.getKind() != lltok::exclaim)
3864 return ParseValueAsMetadata(MD, "expected metadata operand", PFS);
3867 assert(Lex.getKind() == lltok::exclaim && "Expected '!' here");
3871 // ::= '!' STRINGCONSTANT
3872 if (Lex.getKind() == lltok::StringConstant) {
3874 if (ParseMDString(S))
3884 if (ParseMDNodeTail(N))
3891 //===----------------------------------------------------------------------===//
3892 // Function Parsing.
3893 //===----------------------------------------------------------------------===//
3895 bool LLParser::ConvertValIDToValue(Type *Ty, ValID &ID, Value *&V,
3896 PerFunctionState *PFS) {
3897 if (Ty->isFunctionTy())
3898 return Error(ID.Loc, "functions are not values, refer to them as pointers");
3901 case ValID::t_LocalID:
3902 if (!PFS) return Error(ID.Loc, "invalid use of function-local name");
3903 V = PFS->GetVal(ID.UIntVal, Ty, ID.Loc);
3904 return V == nullptr;
3905 case ValID::t_LocalName:
3906 if (!PFS) return Error(ID.Loc, "invalid use of function-local name");
3907 V = PFS->GetVal(ID.StrVal, Ty, ID.Loc);
3908 return V == nullptr;
3909 case ValID::t_InlineAsm: {
3910 PointerType *PTy = dyn_cast<PointerType>(Ty);
3912 PTy ? dyn_cast<FunctionType>(PTy->getElementType()) : nullptr;
3913 if (!FTy || !InlineAsm::Verify(FTy, ID.StrVal2))
3914 return Error(ID.Loc, "invalid type for inline asm constraint string");
3915 V = InlineAsm::get(FTy, ID.StrVal, ID.StrVal2, ID.UIntVal&1,
3916 (ID.UIntVal>>1)&1, (InlineAsm::AsmDialect(ID.UIntVal>>2)));
3919 case ValID::t_GlobalName:
3920 V = GetGlobalVal(ID.StrVal, Ty, ID.Loc);
3921 return V == nullptr;
3922 case ValID::t_GlobalID:
3923 V = GetGlobalVal(ID.UIntVal, Ty, ID.Loc);
3924 return V == nullptr;
3925 case ValID::t_APSInt:
3926 if (!Ty->isIntegerTy())
3927 return Error(ID.Loc, "integer constant must have integer type");
3928 ID.APSIntVal = ID.APSIntVal.extOrTrunc(Ty->getPrimitiveSizeInBits());
3929 V = ConstantInt::get(Context, ID.APSIntVal);
3931 case ValID::t_APFloat:
3932 if (!Ty->isFloatingPointTy() ||
3933 !ConstantFP::isValueValidForType(Ty, ID.APFloatVal))
3934 return Error(ID.Loc, "floating point constant invalid for type");
3936 // The lexer has no type info, so builds all half, float, and double FP
3937 // constants as double. Fix this here. Long double does not need this.
3938 if (&ID.APFloatVal.getSemantics() == &APFloat::IEEEdouble) {
3941 ID.APFloatVal.convert(APFloat::IEEEhalf, APFloat::rmNearestTiesToEven,
3943 else if (Ty->isFloatTy())
3944 ID.APFloatVal.convert(APFloat::IEEEsingle, APFloat::rmNearestTiesToEven,
3947 V = ConstantFP::get(Context, ID.APFloatVal);
3949 if (V->getType() != Ty)
3950 return Error(ID.Loc, "floating point constant does not have type '" +
3951 getTypeString(Ty) + "'");
3955 if (!Ty->isPointerTy())
3956 return Error(ID.Loc, "null must be a pointer type");
3957 V = ConstantPointerNull::get(cast<PointerType>(Ty));
3959 case ValID::t_Undef:
3960 // FIXME: LabelTy should not be a first-class type.
3961 if (!Ty->isFirstClassType() || Ty->isLabelTy())
3962 return Error(ID.Loc, "invalid type for undef constant");
3963 V = UndefValue::get(Ty);
3965 case ValID::t_EmptyArray:
3966 if (!Ty->isArrayTy() || cast<ArrayType>(Ty)->getNumElements() != 0)
3967 return Error(ID.Loc, "invalid empty array initializer");
3968 V = UndefValue::get(Ty);
3971 // FIXME: LabelTy should not be a first-class type.
3972 if (!Ty->isFirstClassType() || Ty->isLabelTy())
3973 return Error(ID.Loc, "invalid type for null constant");
3974 V = Constant::getNullValue(Ty);
3976 case ValID::t_Constant:
3977 if (ID.ConstantVal->getType() != Ty)
3978 return Error(ID.Loc, "constant expression type mismatch");
3982 case ValID::t_ConstantStruct:
3983 case ValID::t_PackedConstantStruct:
3984 if (StructType *ST = dyn_cast<StructType>(Ty)) {
3985 if (ST->getNumElements() != ID.UIntVal)
3986 return Error(ID.Loc,
3987 "initializer with struct type has wrong # elements");
3988 if (ST->isPacked() != (ID.Kind == ValID::t_PackedConstantStruct))
3989 return Error(ID.Loc, "packed'ness of initializer and type don't match");
3991 // Verify that the elements are compatible with the structtype.
3992 for (unsigned i = 0, e = ID.UIntVal; i != e; ++i)
3993 if (ID.ConstantStructElts[i]->getType() != ST->getElementType(i))
3994 return Error(ID.Loc, "element " + Twine(i) +
3995 " of struct initializer doesn't match struct element type");
3997 V = ConstantStruct::get(ST, makeArrayRef(ID.ConstantStructElts,
4000 return Error(ID.Loc, "constant expression type mismatch");
4003 llvm_unreachable("Invalid ValID");
4006 bool LLParser::ParseValue(Type *Ty, Value *&V, PerFunctionState *PFS) {
4009 return ParseValID(ID, PFS) ||
4010 ConvertValIDToValue(Ty, ID, V, PFS);
4013 bool LLParser::ParseTypeAndValue(Value *&V, PerFunctionState *PFS) {
4015 return ParseType(Ty) ||
4016 ParseValue(Ty, V, PFS);
4019 bool LLParser::ParseTypeAndBasicBlock(BasicBlock *&BB, LocTy &Loc,
4020 PerFunctionState &PFS) {
4023 if (ParseTypeAndValue(V, PFS)) return true;
4024 if (!isa<BasicBlock>(V))
4025 return Error(Loc, "expected a basic block");
4026 BB = cast<BasicBlock>(V);
4032 /// ::= OptionalLinkage OptionalVisibility OptionalCallingConv OptRetAttrs
4033 /// OptUnnamedAddr Type GlobalName '(' ArgList ')' OptFuncAttrs OptSection
4034 /// OptionalAlign OptGC OptionalPrefix OptionalPrologue
4035 bool LLParser::ParseFunctionHeader(Function *&Fn, bool isDefine) {
4036 // Parse the linkage.
4037 LocTy LinkageLoc = Lex.getLoc();
4040 unsigned Visibility;
4041 unsigned DLLStorageClass;
4042 AttrBuilder RetAttrs;
4044 Type *RetType = nullptr;
4045 LocTy RetTypeLoc = Lex.getLoc();
4046 if (ParseOptionalLinkage(Linkage) ||
4047 ParseOptionalVisibility(Visibility) ||
4048 ParseOptionalDLLStorageClass(DLLStorageClass) ||
4049 ParseOptionalCallingConv(CC) ||
4050 ParseOptionalReturnAttrs(RetAttrs) ||
4051 ParseType(RetType, RetTypeLoc, true /*void allowed*/))
4054 // Verify that the linkage is ok.
4055 switch ((GlobalValue::LinkageTypes)Linkage) {
4056 case GlobalValue::ExternalLinkage:
4057 break; // always ok.
4058 case GlobalValue::ExternalWeakLinkage:
4060 return Error(LinkageLoc, "invalid linkage for function definition");
4062 case GlobalValue::PrivateLinkage:
4063 case GlobalValue::InternalLinkage:
4064 case GlobalValue::AvailableExternallyLinkage:
4065 case GlobalValue::LinkOnceAnyLinkage:
4066 case GlobalValue::LinkOnceODRLinkage:
4067 case GlobalValue::WeakAnyLinkage:
4068 case GlobalValue::WeakODRLinkage:
4070 return Error(LinkageLoc, "invalid linkage for function declaration");
4072 case GlobalValue::AppendingLinkage:
4073 case GlobalValue::CommonLinkage:
4074 return Error(LinkageLoc, "invalid function linkage type");
4077 if (!isValidVisibilityForLinkage(Visibility, Linkage))
4078 return Error(LinkageLoc,
4079 "symbol with local linkage must have default visibility");
4081 if (!FunctionType::isValidReturnType(RetType))
4082 return Error(RetTypeLoc, "invalid function return type");
4084 LocTy NameLoc = Lex.getLoc();
4086 std::string FunctionName;
4087 if (Lex.getKind() == lltok::GlobalVar) {
4088 FunctionName = Lex.getStrVal();
4089 } else if (Lex.getKind() == lltok::GlobalID) { // @42 is ok.
4090 unsigned NameID = Lex.getUIntVal();
4092 if (NameID != NumberedVals.size())
4093 return TokError("function expected to be numbered '%" +
4094 Twine(NumberedVals.size()) + "'");
4096 return TokError("expected function name");
4101 if (Lex.getKind() != lltok::lparen)
4102 return TokError("expected '(' in function argument list");
4104 SmallVector<ArgInfo, 8> ArgList;
4106 AttrBuilder FuncAttrs;
4107 std::vector<unsigned> FwdRefAttrGrps;
4109 std::string Section;
4113 LocTy UnnamedAddrLoc;
4114 Constant *Prefix = nullptr;
4115 Constant *Prologue = nullptr;
4118 if (ParseArgumentList(ArgList, isVarArg) ||
4119 ParseOptionalToken(lltok::kw_unnamed_addr, UnnamedAddr,
4121 ParseFnAttributeValuePairs(FuncAttrs, FwdRefAttrGrps, false,
4123 (EatIfPresent(lltok::kw_section) &&
4124 ParseStringConstant(Section)) ||
4125 parseOptionalComdat(FunctionName, C) ||
4126 ParseOptionalAlignment(Alignment) ||
4127 (EatIfPresent(lltok::kw_gc) &&
4128 ParseStringConstant(GC)) ||
4129 (EatIfPresent(lltok::kw_prefix) &&
4130 ParseGlobalTypeAndValue(Prefix)) ||
4131 (EatIfPresent(lltok::kw_prologue) &&
4132 ParseGlobalTypeAndValue(Prologue)))
4135 if (FuncAttrs.contains(Attribute::Builtin))
4136 return Error(BuiltinLoc, "'builtin' attribute not valid on function");
4138 // If the alignment was parsed as an attribute, move to the alignment field.
4139 if (FuncAttrs.hasAlignmentAttr()) {
4140 Alignment = FuncAttrs.getAlignment();
4141 FuncAttrs.removeAttribute(Attribute::Alignment);
4144 // Okay, if we got here, the function is syntactically valid. Convert types
4145 // and do semantic checks.
4146 std::vector<Type*> ParamTypeList;
4147 SmallVector<AttributeSet, 8> Attrs;
4149 if (RetAttrs.hasAttributes())
4150 Attrs.push_back(AttributeSet::get(RetType->getContext(),
4151 AttributeSet::ReturnIndex,
4154 for (unsigned i = 0, e = ArgList.size(); i != e; ++i) {
4155 ParamTypeList.push_back(ArgList[i].Ty);
4156 if (ArgList[i].Attrs.hasAttributes(i + 1)) {
4157 AttrBuilder B(ArgList[i].Attrs, i + 1);
4158 Attrs.push_back(AttributeSet::get(RetType->getContext(), i + 1, B));
4162 if (FuncAttrs.hasAttributes())
4163 Attrs.push_back(AttributeSet::get(RetType->getContext(),
4164 AttributeSet::FunctionIndex,
4167 AttributeSet PAL = AttributeSet::get(Context, Attrs);
4169 if (PAL.hasAttribute(1, Attribute::StructRet) && !RetType->isVoidTy())
4170 return Error(RetTypeLoc, "functions with 'sret' argument must return void");
4173 FunctionType::get(RetType, ParamTypeList, isVarArg);
4174 PointerType *PFT = PointerType::getUnqual(FT);
4177 if (!FunctionName.empty()) {
4178 // If this was a definition of a forward reference, remove the definition
4179 // from the forward reference table and fill in the forward ref.
4180 std::map<std::string, std::pair<GlobalValue*, LocTy> >::iterator FRVI =
4181 ForwardRefVals.find(FunctionName);
4182 if (FRVI != ForwardRefVals.end()) {
4183 Fn = M->getFunction(FunctionName);
4185 return Error(FRVI->second.second, "invalid forward reference to "
4186 "function as global value!");
4187 if (Fn->getType() != PFT)
4188 return Error(FRVI->second.second, "invalid forward reference to "
4189 "function '" + FunctionName + "' with wrong type!");
4191 ForwardRefVals.erase(FRVI);
4192 } else if ((Fn = M->getFunction(FunctionName))) {
4193 // Reject redefinitions.
4194 return Error(NameLoc, "invalid redefinition of function '" +
4195 FunctionName + "'");
4196 } else if (M->getNamedValue(FunctionName)) {
4197 return Error(NameLoc, "redefinition of function '@" + FunctionName + "'");
4201 // If this is a definition of a forward referenced function, make sure the
4203 std::map<unsigned, std::pair<GlobalValue*, LocTy> >::iterator I
4204 = ForwardRefValIDs.find(NumberedVals.size());
4205 if (I != ForwardRefValIDs.end()) {
4206 Fn = cast<Function>(I->second.first);
4207 if (Fn->getType() != PFT)
4208 return Error(NameLoc, "type of definition and forward reference of '@" +
4209 Twine(NumberedVals.size()) + "' disagree");
4210 ForwardRefValIDs.erase(I);
4215 Fn = Function::Create(FT, GlobalValue::ExternalLinkage, FunctionName, M);
4216 else // Move the forward-reference to the correct spot in the module.
4217 M->getFunctionList().splice(M->end(), M->getFunctionList(), Fn);
4219 if (FunctionName.empty())
4220 NumberedVals.push_back(Fn);
4222 Fn->setLinkage((GlobalValue::LinkageTypes)Linkage);
4223 Fn->setVisibility((GlobalValue::VisibilityTypes)Visibility);
4224 Fn->setDLLStorageClass((GlobalValue::DLLStorageClassTypes)DLLStorageClass);
4225 Fn->setCallingConv(CC);
4226 Fn->setAttributes(PAL);
4227 Fn->setUnnamedAddr(UnnamedAddr);
4228 Fn->setAlignment(Alignment);
4229 Fn->setSection(Section);
4231 if (!GC.empty()) Fn->setGC(GC.c_str());
4232 Fn->setPrefixData(Prefix);
4233 Fn->setPrologueData(Prologue);
4234 ForwardRefAttrGroups[Fn] = FwdRefAttrGrps;
4236 // Add all of the arguments we parsed to the function.
4237 Function::arg_iterator ArgIt = Fn->arg_begin();
4238 for (unsigned i = 0, e = ArgList.size(); i != e; ++i, ++ArgIt) {
4239 // If the argument has a name, insert it into the argument symbol table.
4240 if (ArgList[i].Name.empty()) continue;
4242 // Set the name, if it conflicted, it will be auto-renamed.
4243 ArgIt->setName(ArgList[i].Name);
4245 if (ArgIt->getName() != ArgList[i].Name)
4246 return Error(ArgList[i].Loc, "redefinition of argument '%" +
4247 ArgList[i].Name + "'");
4253 // Check the declaration has no block address forward references.
4255 if (FunctionName.empty()) {
4256 ID.Kind = ValID::t_GlobalID;
4257 ID.UIntVal = NumberedVals.size() - 1;
4259 ID.Kind = ValID::t_GlobalName;
4260 ID.StrVal = FunctionName;
4262 auto Blocks = ForwardRefBlockAddresses.find(ID);
4263 if (Blocks != ForwardRefBlockAddresses.end())
4264 return Error(Blocks->first.Loc,
4265 "cannot take blockaddress inside a declaration");
4269 bool LLParser::PerFunctionState::resolveForwardRefBlockAddresses() {
4271 if (FunctionNumber == -1) {
4272 ID.Kind = ValID::t_GlobalName;
4273 ID.StrVal = F.getName();
4275 ID.Kind = ValID::t_GlobalID;
4276 ID.UIntVal = FunctionNumber;
4279 auto Blocks = P.ForwardRefBlockAddresses.find(ID);
4280 if (Blocks == P.ForwardRefBlockAddresses.end())
4283 for (const auto &I : Blocks->second) {
4284 const ValID &BBID = I.first;
4285 GlobalValue *GV = I.second;
4287 assert((BBID.Kind == ValID::t_LocalID || BBID.Kind == ValID::t_LocalName) &&
4288 "Expected local id or name");
4290 if (BBID.Kind == ValID::t_LocalName)
4291 BB = GetBB(BBID.StrVal, BBID.Loc);
4293 BB = GetBB(BBID.UIntVal, BBID.Loc);
4295 return P.Error(BBID.Loc, "referenced value is not a basic block");
4297 GV->replaceAllUsesWith(BlockAddress::get(&F, BB));
4298 GV->eraseFromParent();
4301 P.ForwardRefBlockAddresses.erase(Blocks);
4305 /// ParseFunctionBody
4306 /// ::= '{' BasicBlock+ UseListOrderDirective* '}'
4307 bool LLParser::ParseFunctionBody(Function &Fn) {
4308 if (Lex.getKind() != lltok::lbrace)
4309 return TokError("expected '{' in function body");
4310 Lex.Lex(); // eat the {.
4312 int FunctionNumber = -1;
4313 if (!Fn.hasName()) FunctionNumber = NumberedVals.size()-1;
4315 PerFunctionState PFS(*this, Fn, FunctionNumber);
4317 // Resolve block addresses and allow basic blocks to be forward-declared
4318 // within this function.
4319 if (PFS.resolveForwardRefBlockAddresses())
4321 SaveAndRestore<PerFunctionState *> ScopeExit(BlockAddressPFS, &PFS);
4323 // We need at least one basic block.
4324 if (Lex.getKind() == lltok::rbrace || Lex.getKind() == lltok::kw_uselistorder)
4325 return TokError("function body requires at least one basic block");
4327 while (Lex.getKind() != lltok::rbrace &&
4328 Lex.getKind() != lltok::kw_uselistorder)
4329 if (ParseBasicBlock(PFS)) return true;
4331 while (Lex.getKind() != lltok::rbrace)
4332 if (ParseUseListOrder(&PFS))
4338 // Verify function is ok.
4339 return PFS.FinishFunction();
4343 /// ::= LabelStr? Instruction*
4344 bool LLParser::ParseBasicBlock(PerFunctionState &PFS) {
4345 // If this basic block starts out with a name, remember it.
4347 LocTy NameLoc = Lex.getLoc();
4348 if (Lex.getKind() == lltok::LabelStr) {
4349 Name = Lex.getStrVal();
4353 BasicBlock *BB = PFS.DefineBB(Name, NameLoc);
4355 return Error(NameLoc,
4356 "unable to create block named '" + Name + "'");
4358 std::string NameStr;
4360 // Parse the instructions in this block until we get a terminator.
4363 // This instruction may have three possibilities for a name: a) none
4364 // specified, b) name specified "%foo =", c) number specified: "%4 =".
4365 LocTy NameLoc = Lex.getLoc();
4369 if (Lex.getKind() == lltok::LocalVarID) {
4370 NameID = Lex.getUIntVal();
4372 if (ParseToken(lltok::equal, "expected '=' after instruction id"))
4374 } else if (Lex.getKind() == lltok::LocalVar) {
4375 NameStr = Lex.getStrVal();
4377 if (ParseToken(lltok::equal, "expected '=' after instruction name"))
4381 switch (ParseInstruction(Inst, BB, PFS)) {
4382 default: llvm_unreachable("Unknown ParseInstruction result!");
4383 case InstError: return true;
4385 BB->getInstList().push_back(Inst);
4387 // With a normal result, we check to see if the instruction is followed by
4388 // a comma and metadata.
4389 if (EatIfPresent(lltok::comma))
4390 if (ParseInstructionMetadata(Inst, &PFS))
4393 case InstExtraComma:
4394 BB->getInstList().push_back(Inst);
4396 // If the instruction parser ate an extra comma at the end of it, it
4397 // *must* be followed by metadata.
4398 if (ParseInstructionMetadata(Inst, &PFS))
4403 // Set the name on the instruction.
4404 if (PFS.SetInstName(NameID, NameStr, NameLoc, Inst)) return true;
4405 } while (!isa<TerminatorInst>(Inst));
4410 //===----------------------------------------------------------------------===//
4411 // Instruction Parsing.
4412 //===----------------------------------------------------------------------===//
4414 /// ParseInstruction - Parse one of the many different instructions.
4416 int LLParser::ParseInstruction(Instruction *&Inst, BasicBlock *BB,
4417 PerFunctionState &PFS) {
4418 lltok::Kind Token = Lex.getKind();
4419 if (Token == lltok::Eof)
4420 return TokError("found end of file when expecting more instructions");
4421 LocTy Loc = Lex.getLoc();
4422 unsigned KeywordVal = Lex.getUIntVal();
4423 Lex.Lex(); // Eat the keyword.
4426 default: return Error(Loc, "expected instruction opcode");
4427 // Terminator Instructions.
4428 case lltok::kw_unreachable: Inst = new UnreachableInst(Context); return false;
4429 case lltok::kw_ret: return ParseRet(Inst, BB, PFS);
4430 case lltok::kw_br: return ParseBr(Inst, PFS);
4431 case lltok::kw_switch: return ParseSwitch(Inst, PFS);
4432 case lltok::kw_indirectbr: return ParseIndirectBr(Inst, PFS);
4433 case lltok::kw_invoke: return ParseInvoke(Inst, PFS);
4434 case lltok::kw_resume: return ParseResume(Inst, PFS);
4435 // Binary Operators.
4439 case lltok::kw_shl: {
4440 bool NUW = EatIfPresent(lltok::kw_nuw);
4441 bool NSW = EatIfPresent(lltok::kw_nsw);
4442 if (!NUW) NUW = EatIfPresent(lltok::kw_nuw);
4444 if (ParseArithmetic(Inst, PFS, KeywordVal, 1)) return true;
4446 if (NUW) cast<BinaryOperator>(Inst)->setHasNoUnsignedWrap(true);
4447 if (NSW) cast<BinaryOperator>(Inst)->setHasNoSignedWrap(true);
4450 case lltok::kw_fadd:
4451 case lltok::kw_fsub:
4452 case lltok::kw_fmul:
4453 case lltok::kw_fdiv:
4454 case lltok::kw_frem: {
4455 FastMathFlags FMF = EatFastMathFlagsIfPresent();
4456 int Res = ParseArithmetic(Inst, PFS, KeywordVal, 2);
4460 Inst->setFastMathFlags(FMF);
4464 case lltok::kw_sdiv:
4465 case lltok::kw_udiv:
4466 case lltok::kw_lshr:
4467 case lltok::kw_ashr: {
4468 bool Exact = EatIfPresent(lltok::kw_exact);
4470 if (ParseArithmetic(Inst, PFS, KeywordVal, 1)) return true;
4471 if (Exact) cast<BinaryOperator>(Inst)->setIsExact(true);
4475 case lltok::kw_urem:
4476 case lltok::kw_srem: return ParseArithmetic(Inst, PFS, KeywordVal, 1);
4479 case lltok::kw_xor: return ParseLogical(Inst, PFS, KeywordVal);
4480 case lltok::kw_icmp:
4481 case lltok::kw_fcmp: return ParseCompare(Inst, PFS, KeywordVal);
4483 case lltok::kw_trunc:
4484 case lltok::kw_zext:
4485 case lltok::kw_sext:
4486 case lltok::kw_fptrunc:
4487 case lltok::kw_fpext:
4488 case lltok::kw_bitcast:
4489 case lltok::kw_addrspacecast:
4490 case lltok::kw_uitofp:
4491 case lltok::kw_sitofp:
4492 case lltok::kw_fptoui:
4493 case lltok::kw_fptosi:
4494 case lltok::kw_inttoptr:
4495 case lltok::kw_ptrtoint: return ParseCast(Inst, PFS, KeywordVal);
4497 case lltok::kw_select: return ParseSelect(Inst, PFS);
4498 case lltok::kw_va_arg: return ParseVA_Arg(Inst, PFS);
4499 case lltok::kw_extractelement: return ParseExtractElement(Inst, PFS);
4500 case lltok::kw_insertelement: return ParseInsertElement(Inst, PFS);
4501 case lltok::kw_shufflevector: return ParseShuffleVector(Inst, PFS);
4502 case lltok::kw_phi: return ParsePHI(Inst, PFS);
4503 case lltok::kw_landingpad: return ParseLandingPad(Inst, PFS);
4505 case lltok::kw_call: return ParseCall(Inst, PFS, CallInst::TCK_None);
4506 case lltok::kw_tail: return ParseCall(Inst, PFS, CallInst::TCK_Tail);
4507 case lltok::kw_musttail: return ParseCall(Inst, PFS, CallInst::TCK_MustTail);
4509 case lltok::kw_alloca: return ParseAlloc(Inst, PFS);
4510 case lltok::kw_load: return ParseLoad(Inst, PFS);
4511 case lltok::kw_store: return ParseStore(Inst, PFS);
4512 case lltok::kw_cmpxchg: return ParseCmpXchg(Inst, PFS);
4513 case lltok::kw_atomicrmw: return ParseAtomicRMW(Inst, PFS);
4514 case lltok::kw_fence: return ParseFence(Inst, PFS);
4515 case lltok::kw_getelementptr: return ParseGetElementPtr(Inst, PFS);
4516 case lltok::kw_extractvalue: return ParseExtractValue(Inst, PFS);
4517 case lltok::kw_insertvalue: return ParseInsertValue(Inst, PFS);
4521 /// ParseCmpPredicate - Parse an integer or fp predicate, based on Kind.
4522 bool LLParser::ParseCmpPredicate(unsigned &P, unsigned Opc) {
4523 if (Opc == Instruction::FCmp) {
4524 switch (Lex.getKind()) {
4525 default: return TokError("expected fcmp predicate (e.g. 'oeq')");
4526 case lltok::kw_oeq: P = CmpInst::FCMP_OEQ; break;
4527 case lltok::kw_one: P = CmpInst::FCMP_ONE; break;
4528 case lltok::kw_olt: P = CmpInst::FCMP_OLT; break;
4529 case lltok::kw_ogt: P = CmpInst::FCMP_OGT; break;
4530 case lltok::kw_ole: P = CmpInst::FCMP_OLE; break;
4531 case lltok::kw_oge: P = CmpInst::FCMP_OGE; break;
4532 case lltok::kw_ord: P = CmpInst::FCMP_ORD; break;
4533 case lltok::kw_uno: P = CmpInst::FCMP_UNO; break;
4534 case lltok::kw_ueq: P = CmpInst::FCMP_UEQ; break;
4535 case lltok::kw_une: P = CmpInst::FCMP_UNE; break;
4536 case lltok::kw_ult: P = CmpInst::FCMP_ULT; break;
4537 case lltok::kw_ugt: P = CmpInst::FCMP_UGT; break;
4538 case lltok::kw_ule: P = CmpInst::FCMP_ULE; break;
4539 case lltok::kw_uge: P = CmpInst::FCMP_UGE; break;
4540 case lltok::kw_true: P = CmpInst::FCMP_TRUE; break;
4541 case lltok::kw_false: P = CmpInst::FCMP_FALSE; break;
4544 switch (Lex.getKind()) {
4545 default: return TokError("expected icmp predicate (e.g. 'eq')");
4546 case lltok::kw_eq: P = CmpInst::ICMP_EQ; break;
4547 case lltok::kw_ne: P = CmpInst::ICMP_NE; break;
4548 case lltok::kw_slt: P = CmpInst::ICMP_SLT; break;
4549 case lltok::kw_sgt: P = CmpInst::ICMP_SGT; break;
4550 case lltok::kw_sle: P = CmpInst::ICMP_SLE; break;
4551 case lltok::kw_sge: P = CmpInst::ICMP_SGE; break;
4552 case lltok::kw_ult: P = CmpInst::ICMP_ULT; break;
4553 case lltok::kw_ugt: P = CmpInst::ICMP_UGT; break;
4554 case lltok::kw_ule: P = CmpInst::ICMP_ULE; break;
4555 case lltok::kw_uge: P = CmpInst::ICMP_UGE; break;
4562 //===----------------------------------------------------------------------===//
4563 // Terminator Instructions.
4564 //===----------------------------------------------------------------------===//
4566 /// ParseRet - Parse a return instruction.
4567 /// ::= 'ret' void (',' !dbg, !1)*
4568 /// ::= 'ret' TypeAndValue (',' !dbg, !1)*
4569 bool LLParser::ParseRet(Instruction *&Inst, BasicBlock *BB,
4570 PerFunctionState &PFS) {
4571 SMLoc TypeLoc = Lex.getLoc();
4573 if (ParseType(Ty, true /*void allowed*/)) return true;
4575 Type *ResType = PFS.getFunction().getReturnType();
4577 if (Ty->isVoidTy()) {
4578 if (!ResType->isVoidTy())
4579 return Error(TypeLoc, "value doesn't match function result type '" +
4580 getTypeString(ResType) + "'");
4582 Inst = ReturnInst::Create(Context);
4587 if (ParseValue(Ty, RV, PFS)) return true;
4589 if (ResType != RV->getType())
4590 return Error(TypeLoc, "value doesn't match function result type '" +
4591 getTypeString(ResType) + "'");
4593 Inst = ReturnInst::Create(Context, RV);
4599 /// ::= 'br' TypeAndValue
4600 /// ::= 'br' TypeAndValue ',' TypeAndValue ',' TypeAndValue
4601 bool LLParser::ParseBr(Instruction *&Inst, PerFunctionState &PFS) {
4604 BasicBlock *Op1, *Op2;
4605 if (ParseTypeAndValue(Op0, Loc, PFS)) return true;
4607 if (BasicBlock *BB = dyn_cast<BasicBlock>(Op0)) {
4608 Inst = BranchInst::Create(BB);
4612 if (Op0->getType() != Type::getInt1Ty(Context))
4613 return Error(Loc, "branch condition must have 'i1' type");
4615 if (ParseToken(lltok::comma, "expected ',' after branch condition") ||
4616 ParseTypeAndBasicBlock(Op1, Loc, PFS) ||
4617 ParseToken(lltok::comma, "expected ',' after true destination") ||
4618 ParseTypeAndBasicBlock(Op2, Loc2, PFS))
4621 Inst = BranchInst::Create(Op1, Op2, Op0);
4627 /// ::= 'switch' TypeAndValue ',' TypeAndValue '[' JumpTable ']'
4629 /// ::= (TypeAndValue ',' TypeAndValue)*
4630 bool LLParser::ParseSwitch(Instruction *&Inst, PerFunctionState &PFS) {
4631 LocTy CondLoc, BBLoc;
4633 BasicBlock *DefaultBB;
4634 if (ParseTypeAndValue(Cond, CondLoc, PFS) ||
4635 ParseToken(lltok::comma, "expected ',' after switch condition") ||
4636 ParseTypeAndBasicBlock(DefaultBB, BBLoc, PFS) ||
4637 ParseToken(lltok::lsquare, "expected '[' with switch table"))
4640 if (!Cond->getType()->isIntegerTy())
4641 return Error(CondLoc, "switch condition must have integer type");
4643 // Parse the jump table pairs.
4644 SmallPtrSet<Value*, 32> SeenCases;
4645 SmallVector<std::pair<ConstantInt*, BasicBlock*>, 32> Table;
4646 while (Lex.getKind() != lltok::rsquare) {
4650 if (ParseTypeAndValue(Constant, CondLoc, PFS) ||
4651 ParseToken(lltok::comma, "expected ',' after case value") ||
4652 ParseTypeAndBasicBlock(DestBB, PFS))
4655 if (!SeenCases.insert(Constant).second)
4656 return Error(CondLoc, "duplicate case value in switch");
4657 if (!isa<ConstantInt>(Constant))
4658 return Error(CondLoc, "case value is not a constant integer");
4660 Table.push_back(std::make_pair(cast<ConstantInt>(Constant), DestBB));
4663 Lex.Lex(); // Eat the ']'.
4665 SwitchInst *SI = SwitchInst::Create(Cond, DefaultBB, Table.size());
4666 for (unsigned i = 0, e = Table.size(); i != e; ++i)
4667 SI->addCase(Table[i].first, Table[i].second);
4674 /// ::= 'indirectbr' TypeAndValue ',' '[' LabelList ']'
4675 bool LLParser::ParseIndirectBr(Instruction *&Inst, PerFunctionState &PFS) {
4678 if (ParseTypeAndValue(Address, AddrLoc, PFS) ||
4679 ParseToken(lltok::comma, "expected ',' after indirectbr address") ||
4680 ParseToken(lltok::lsquare, "expected '[' with indirectbr"))
4683 if (!Address->getType()->isPointerTy())
4684 return Error(AddrLoc, "indirectbr address must have pointer type");
4686 // Parse the destination list.
4687 SmallVector<BasicBlock*, 16> DestList;
4689 if (Lex.getKind() != lltok::rsquare) {
4691 if (ParseTypeAndBasicBlock(DestBB, PFS))
4693 DestList.push_back(DestBB);
4695 while (EatIfPresent(lltok::comma)) {
4696 if (ParseTypeAndBasicBlock(DestBB, PFS))
4698 DestList.push_back(DestBB);
4702 if (ParseToken(lltok::rsquare, "expected ']' at end of block list"))
4705 IndirectBrInst *IBI = IndirectBrInst::Create(Address, DestList.size());
4706 for (unsigned i = 0, e = DestList.size(); i != e; ++i)
4707 IBI->addDestination(DestList[i]);
4714 /// ::= 'invoke' OptionalCallingConv OptionalAttrs Type Value ParamList
4715 /// OptionalAttrs 'to' TypeAndValue 'unwind' TypeAndValue
4716 bool LLParser::ParseInvoke(Instruction *&Inst, PerFunctionState &PFS) {
4717 LocTy CallLoc = Lex.getLoc();
4718 AttrBuilder RetAttrs, FnAttrs;
4719 std::vector<unsigned> FwdRefAttrGrps;
4722 Type *RetType = nullptr;
4725 SmallVector<ParamInfo, 16> ArgList;
4727 BasicBlock *NormalBB, *UnwindBB;
4728 if (ParseOptionalCallingConv(CC) ||
4729 ParseOptionalReturnAttrs(RetAttrs) ||
4730 ParseType(RetType, RetTypeLoc, true /*void allowed*/) ||
4731 ParseValID(CalleeID) ||
4732 ParseParameterList(ArgList, PFS) ||
4733 ParseFnAttributeValuePairs(FnAttrs, FwdRefAttrGrps, false,
4735 ParseToken(lltok::kw_to, "expected 'to' in invoke") ||
4736 ParseTypeAndBasicBlock(NormalBB, PFS) ||
4737 ParseToken(lltok::kw_unwind, "expected 'unwind' in invoke") ||
4738 ParseTypeAndBasicBlock(UnwindBB, PFS))
4741 // If RetType is a non-function pointer type, then this is the short syntax
4742 // for the call, which means that RetType is just the return type. Infer the
4743 // rest of the function argument types from the arguments that are present.
4744 FunctionType *Ty = dyn_cast<FunctionType>(RetType);
4746 // Pull out the types of all of the arguments...
4747 std::vector<Type*> ParamTypes;
4748 for (unsigned i = 0, e = ArgList.size(); i != e; ++i)
4749 ParamTypes.push_back(ArgList[i].V->getType());
4751 if (!FunctionType::isValidReturnType(RetType))
4752 return Error(RetTypeLoc, "Invalid result type for LLVM function");
4754 Ty = FunctionType::get(RetType, ParamTypes, false);
4757 // Look up the callee.
4759 if (ConvertValIDToValue(PointerType::getUnqual(Ty), CalleeID, Callee, &PFS))
4762 // Set up the Attribute for the function.
4763 SmallVector<AttributeSet, 8> Attrs;
4764 if (RetAttrs.hasAttributes())
4765 Attrs.push_back(AttributeSet::get(RetType->getContext(),
4766 AttributeSet::ReturnIndex,
4769 SmallVector<Value*, 8> Args;
4771 // Loop through FunctionType's arguments and ensure they are specified
4772 // correctly. Also, gather any parameter attributes.
4773 FunctionType::param_iterator I = Ty->param_begin();
4774 FunctionType::param_iterator E = Ty->param_end();
4775 for (unsigned i = 0, e = ArgList.size(); i != e; ++i) {
4776 Type *ExpectedTy = nullptr;
4779 } else if (!Ty->isVarArg()) {
4780 return Error(ArgList[i].Loc, "too many arguments specified");
4783 if (ExpectedTy && ExpectedTy != ArgList[i].V->getType())
4784 return Error(ArgList[i].Loc, "argument is not of expected type '" +
4785 getTypeString(ExpectedTy) + "'");
4786 Args.push_back(ArgList[i].V);
4787 if (ArgList[i].Attrs.hasAttributes(i + 1)) {
4788 AttrBuilder B(ArgList[i].Attrs, i + 1);
4789 Attrs.push_back(AttributeSet::get(RetType->getContext(), i + 1, B));
4794 return Error(CallLoc, "not enough parameters specified for call");
4796 if (FnAttrs.hasAttributes()) {
4797 if (FnAttrs.hasAlignmentAttr())
4798 return Error(CallLoc, "invoke instructions may not have an alignment");
4800 Attrs.push_back(AttributeSet::get(RetType->getContext(),
4801 AttributeSet::FunctionIndex,
4805 // Finish off the Attribute and check them
4806 AttributeSet PAL = AttributeSet::get(Context, Attrs);
4808 InvokeInst *II = InvokeInst::Create(Callee, NormalBB, UnwindBB, Args);
4809 II->setCallingConv(CC);
4810 II->setAttributes(PAL);
4811 ForwardRefAttrGroups[II] = FwdRefAttrGrps;
4817 /// ::= 'resume' TypeAndValue
4818 bool LLParser::ParseResume(Instruction *&Inst, PerFunctionState &PFS) {
4819 Value *Exn; LocTy ExnLoc;
4820 if (ParseTypeAndValue(Exn, ExnLoc, PFS))
4823 ResumeInst *RI = ResumeInst::Create(Exn);
4828 //===----------------------------------------------------------------------===//
4829 // Binary Operators.
4830 //===----------------------------------------------------------------------===//
4833 /// ::= ArithmeticOps TypeAndValue ',' Value
4835 /// If OperandType is 0, then any FP or integer operand is allowed. If it is 1,
4836 /// then any integer operand is allowed, if it is 2, any fp operand is allowed.
4837 bool LLParser::ParseArithmetic(Instruction *&Inst, PerFunctionState &PFS,
4838 unsigned Opc, unsigned OperandType) {
4839 LocTy Loc; Value *LHS, *RHS;
4840 if (ParseTypeAndValue(LHS, Loc, PFS) ||
4841 ParseToken(lltok::comma, "expected ',' in arithmetic operation") ||
4842 ParseValue(LHS->getType(), RHS, PFS))
4846 switch (OperandType) {
4847 default: llvm_unreachable("Unknown operand type!");
4848 case 0: // int or FP.
4849 Valid = LHS->getType()->isIntOrIntVectorTy() ||
4850 LHS->getType()->isFPOrFPVectorTy();
4852 case 1: Valid = LHS->getType()->isIntOrIntVectorTy(); break;
4853 case 2: Valid = LHS->getType()->isFPOrFPVectorTy(); break;
4857 return Error(Loc, "invalid operand type for instruction");
4859 Inst = BinaryOperator::Create((Instruction::BinaryOps)Opc, LHS, RHS);
4864 /// ::= ArithmeticOps TypeAndValue ',' Value {
4865 bool LLParser::ParseLogical(Instruction *&Inst, PerFunctionState &PFS,
4867 LocTy Loc; Value *LHS, *RHS;
4868 if (ParseTypeAndValue(LHS, Loc, PFS) ||
4869 ParseToken(lltok::comma, "expected ',' in logical operation") ||
4870 ParseValue(LHS->getType(), RHS, PFS))
4873 if (!LHS->getType()->isIntOrIntVectorTy())
4874 return Error(Loc,"instruction requires integer or integer vector operands");
4876 Inst = BinaryOperator::Create((Instruction::BinaryOps)Opc, LHS, RHS);
4882 /// ::= 'icmp' IPredicates TypeAndValue ',' Value
4883 /// ::= 'fcmp' FPredicates TypeAndValue ',' Value
4884 bool LLParser::ParseCompare(Instruction *&Inst, PerFunctionState &PFS,
4886 // Parse the integer/fp comparison predicate.
4890 if (ParseCmpPredicate(Pred, Opc) ||
4891 ParseTypeAndValue(LHS, Loc, PFS) ||
4892 ParseToken(lltok::comma, "expected ',' after compare value") ||
4893 ParseValue(LHS->getType(), RHS, PFS))
4896 if (Opc == Instruction::FCmp) {
4897 if (!LHS->getType()->isFPOrFPVectorTy())
4898 return Error(Loc, "fcmp requires floating point operands");
4899 Inst = new FCmpInst(CmpInst::Predicate(Pred), LHS, RHS);
4901 assert(Opc == Instruction::ICmp && "Unknown opcode for CmpInst!");
4902 if (!LHS->getType()->isIntOrIntVectorTy() &&
4903 !LHS->getType()->getScalarType()->isPointerTy())
4904 return Error(Loc, "icmp requires integer operands");
4905 Inst = new ICmpInst(CmpInst::Predicate(Pred), LHS, RHS);
4910 //===----------------------------------------------------------------------===//
4911 // Other Instructions.
4912 //===----------------------------------------------------------------------===//
4916 /// ::= CastOpc TypeAndValue 'to' Type
4917 bool LLParser::ParseCast(Instruction *&Inst, PerFunctionState &PFS,
4921 Type *DestTy = nullptr;
4922 if (ParseTypeAndValue(Op, Loc, PFS) ||
4923 ParseToken(lltok::kw_to, "expected 'to' after cast value") ||
4927 if (!CastInst::castIsValid((Instruction::CastOps)Opc, Op, DestTy)) {
4928 CastInst::castIsValid((Instruction::CastOps)Opc, Op, DestTy);
4929 return Error(Loc, "invalid cast opcode for cast from '" +
4930 getTypeString(Op->getType()) + "' to '" +
4931 getTypeString(DestTy) + "'");
4933 Inst = CastInst::Create((Instruction::CastOps)Opc, Op, DestTy);
4938 /// ::= 'select' TypeAndValue ',' TypeAndValue ',' TypeAndValue
4939 bool LLParser::ParseSelect(Instruction *&Inst, PerFunctionState &PFS) {
4941 Value *Op0, *Op1, *Op2;
4942 if (ParseTypeAndValue(Op0, Loc, PFS) ||
4943 ParseToken(lltok::comma, "expected ',' after select condition") ||
4944 ParseTypeAndValue(Op1, PFS) ||
4945 ParseToken(lltok::comma, "expected ',' after select value") ||
4946 ParseTypeAndValue(Op2, PFS))
4949 if (const char *Reason = SelectInst::areInvalidOperands(Op0, Op1, Op2))
4950 return Error(Loc, Reason);
4952 Inst = SelectInst::Create(Op0, Op1, Op2);
4957 /// ::= 'va_arg' TypeAndValue ',' Type
4958 bool LLParser::ParseVA_Arg(Instruction *&Inst, PerFunctionState &PFS) {
4960 Type *EltTy = nullptr;
4962 if (ParseTypeAndValue(Op, PFS) ||
4963 ParseToken(lltok::comma, "expected ',' after vaarg operand") ||
4964 ParseType(EltTy, TypeLoc))
4967 if (!EltTy->isFirstClassType())
4968 return Error(TypeLoc, "va_arg requires operand with first class type");
4970 Inst = new VAArgInst(Op, EltTy);
4974 /// ParseExtractElement
4975 /// ::= 'extractelement' TypeAndValue ',' TypeAndValue
4976 bool LLParser::ParseExtractElement(Instruction *&Inst, PerFunctionState &PFS) {
4979 if (ParseTypeAndValue(Op0, Loc, PFS) ||
4980 ParseToken(lltok::comma, "expected ',' after extract value") ||
4981 ParseTypeAndValue(Op1, PFS))
4984 if (!ExtractElementInst::isValidOperands(Op0, Op1))
4985 return Error(Loc, "invalid extractelement operands");
4987 Inst = ExtractElementInst::Create(Op0, Op1);
4991 /// ParseInsertElement
4992 /// ::= 'insertelement' TypeAndValue ',' TypeAndValue ',' TypeAndValue
4993 bool LLParser::ParseInsertElement(Instruction *&Inst, PerFunctionState &PFS) {
4995 Value *Op0, *Op1, *Op2;
4996 if (ParseTypeAndValue(Op0, Loc, PFS) ||
4997 ParseToken(lltok::comma, "expected ',' after insertelement value") ||
4998 ParseTypeAndValue(Op1, PFS) ||
4999 ParseToken(lltok::comma, "expected ',' after insertelement value") ||
5000 ParseTypeAndValue(Op2, PFS))
5003 if (!InsertElementInst::isValidOperands(Op0, Op1, Op2))
5004 return Error(Loc, "invalid insertelement operands");
5006 Inst = InsertElementInst::Create(Op0, Op1, Op2);
5010 /// ParseShuffleVector
5011 /// ::= 'shufflevector' TypeAndValue ',' TypeAndValue ',' TypeAndValue
5012 bool LLParser::ParseShuffleVector(Instruction *&Inst, PerFunctionState &PFS) {
5014 Value *Op0, *Op1, *Op2;
5015 if (ParseTypeAndValue(Op0, Loc, PFS) ||
5016 ParseToken(lltok::comma, "expected ',' after shuffle mask") ||
5017 ParseTypeAndValue(Op1, PFS) ||
5018 ParseToken(lltok::comma, "expected ',' after shuffle value") ||
5019 ParseTypeAndValue(Op2, PFS))
5022 if (!ShuffleVectorInst::isValidOperands(Op0, Op1, Op2))
5023 return Error(Loc, "invalid shufflevector operands");
5025 Inst = new ShuffleVectorInst(Op0, Op1, Op2);
5030 /// ::= 'phi' Type '[' Value ',' Value ']' (',' '[' Value ',' Value ']')*
5031 int LLParser::ParsePHI(Instruction *&Inst, PerFunctionState &PFS) {
5032 Type *Ty = nullptr; LocTy TypeLoc;
5035 if (ParseType(Ty, TypeLoc) ||
5036 ParseToken(lltok::lsquare, "expected '[' in phi value list") ||
5037 ParseValue(Ty, Op0, PFS) ||
5038 ParseToken(lltok::comma, "expected ',' after insertelement value") ||
5039 ParseValue(Type::getLabelTy(Context), Op1, PFS) ||
5040 ParseToken(lltok::rsquare, "expected ']' in phi value list"))
5043 bool AteExtraComma = false;
5044 SmallVector<std::pair<Value*, BasicBlock*>, 16> PHIVals;
5046 PHIVals.push_back(std::make_pair(Op0, cast<BasicBlock>(Op1)));
5048 if (!EatIfPresent(lltok::comma))
5051 if (Lex.getKind() == lltok::MetadataVar) {
5052 AteExtraComma = true;
5056 if (ParseToken(lltok::lsquare, "expected '[' in phi value list") ||
5057 ParseValue(Ty, Op0, PFS) ||
5058 ParseToken(lltok::comma, "expected ',' after insertelement value") ||
5059 ParseValue(Type::getLabelTy(Context), Op1, PFS) ||
5060 ParseToken(lltok::rsquare, "expected ']' in phi value list"))
5064 if (!Ty->isFirstClassType())
5065 return Error(TypeLoc, "phi node must have first class type");
5067 PHINode *PN = PHINode::Create(Ty, PHIVals.size());
5068 for (unsigned i = 0, e = PHIVals.size(); i != e; ++i)
5069 PN->addIncoming(PHIVals[i].first, PHIVals[i].second);
5071 return AteExtraComma ? InstExtraComma : InstNormal;
5075 /// ::= 'landingpad' Type 'personality' TypeAndValue 'cleanup'? Clause+
5077 /// ::= 'catch' TypeAndValue
5079 /// ::= 'filter' TypeAndValue ( ',' TypeAndValue )*
5080 bool LLParser::ParseLandingPad(Instruction *&Inst, PerFunctionState &PFS) {
5081 Type *Ty = nullptr; LocTy TyLoc;
5082 Value *PersFn; LocTy PersFnLoc;
5084 if (ParseType(Ty, TyLoc) ||
5085 ParseToken(lltok::kw_personality, "expected 'personality'") ||
5086 ParseTypeAndValue(PersFn, PersFnLoc, PFS))
5089 std::unique_ptr<LandingPadInst> LP(LandingPadInst::Create(Ty, PersFn, 0));
5090 LP->setCleanup(EatIfPresent(lltok::kw_cleanup));
5092 while (Lex.getKind() == lltok::kw_catch || Lex.getKind() == lltok::kw_filter){
5093 LandingPadInst::ClauseType CT;
5094 if (EatIfPresent(lltok::kw_catch))
5095 CT = LandingPadInst::Catch;
5096 else if (EatIfPresent(lltok::kw_filter))
5097 CT = LandingPadInst::Filter;
5099 return TokError("expected 'catch' or 'filter' clause type");
5103 if (ParseTypeAndValue(V, VLoc, PFS))
5106 // A 'catch' type expects a non-array constant. A filter clause expects an
5108 if (CT == LandingPadInst::Catch) {
5109 if (isa<ArrayType>(V->getType()))
5110 Error(VLoc, "'catch' clause has an invalid type");
5112 if (!isa<ArrayType>(V->getType()))
5113 Error(VLoc, "'filter' clause has an invalid type");
5116 Constant *CV = dyn_cast<Constant>(V);
5118 return Error(VLoc, "clause argument must be a constant");
5122 Inst = LP.release();
5127 /// ::= 'call' OptionalCallingConv OptionalAttrs Type Value
5128 /// ParameterList OptionalAttrs
5129 /// ::= 'tail' 'call' OptionalCallingConv OptionalAttrs Type Value
5130 /// ParameterList OptionalAttrs
5131 /// ::= 'musttail' 'call' OptionalCallingConv OptionalAttrs Type Value
5132 /// ParameterList OptionalAttrs
5133 bool LLParser::ParseCall(Instruction *&Inst, PerFunctionState &PFS,
5134 CallInst::TailCallKind TCK) {
5135 AttrBuilder RetAttrs, FnAttrs;
5136 std::vector<unsigned> FwdRefAttrGrps;
5139 Type *RetType = nullptr;
5142 SmallVector<ParamInfo, 16> ArgList;
5143 LocTy CallLoc = Lex.getLoc();
5145 if ((TCK != CallInst::TCK_None &&
5146 ParseToken(lltok::kw_call, "expected 'tail call'")) ||
5147 ParseOptionalCallingConv(CC) ||
5148 ParseOptionalReturnAttrs(RetAttrs) ||
5149 ParseType(RetType, RetTypeLoc, true /*void allowed*/) ||
5150 ParseValID(CalleeID) ||
5151 ParseParameterList(ArgList, PFS, TCK == CallInst::TCK_MustTail,
5152 PFS.getFunction().isVarArg()) ||
5153 ParseFnAttributeValuePairs(FnAttrs, FwdRefAttrGrps, false,
5157 // If RetType is a non-function pointer type, then this is the short syntax
5158 // for the call, which means that RetType is just the return type. Infer the
5159 // rest of the function argument types from the arguments that are present.
5160 FunctionType *Ty = dyn_cast<FunctionType>(RetType);
5162 // Pull out the types of all of the arguments...
5163 std::vector<Type*> ParamTypes;
5164 for (unsigned i = 0, e = ArgList.size(); i != e; ++i)
5165 ParamTypes.push_back(ArgList[i].V->getType());
5167 if (!FunctionType::isValidReturnType(RetType))
5168 return Error(RetTypeLoc, "Invalid result type for LLVM function");
5170 Ty = FunctionType::get(RetType, ParamTypes, false);
5173 // Look up the callee.
5175 if (ConvertValIDToValue(PointerType::getUnqual(Ty), CalleeID, Callee, &PFS))
5178 // Set up the Attribute for the function.
5179 SmallVector<AttributeSet, 8> Attrs;
5180 if (RetAttrs.hasAttributes())
5181 Attrs.push_back(AttributeSet::get(RetType->getContext(),
5182 AttributeSet::ReturnIndex,
5185 SmallVector<Value*, 8> Args;
5187 // Loop through FunctionType's arguments and ensure they are specified
5188 // correctly. Also, gather any parameter attributes.
5189 FunctionType::param_iterator I = Ty->param_begin();
5190 FunctionType::param_iterator E = Ty->param_end();
5191 for (unsigned i = 0, e = ArgList.size(); i != e; ++i) {
5192 Type *ExpectedTy = nullptr;
5195 } else if (!Ty->isVarArg()) {
5196 return Error(ArgList[i].Loc, "too many arguments specified");
5199 if (ExpectedTy && ExpectedTy != ArgList[i].V->getType())
5200 return Error(ArgList[i].Loc, "argument is not of expected type '" +
5201 getTypeString(ExpectedTy) + "'");
5202 Args.push_back(ArgList[i].V);
5203 if (ArgList[i].Attrs.hasAttributes(i + 1)) {
5204 AttrBuilder B(ArgList[i].Attrs, i + 1);
5205 Attrs.push_back(AttributeSet::get(RetType->getContext(), i + 1, B));
5210 return Error(CallLoc, "not enough parameters specified for call");
5212 if (FnAttrs.hasAttributes()) {
5213 if (FnAttrs.hasAlignmentAttr())
5214 return Error(CallLoc, "call instructions may not have an alignment");
5216 Attrs.push_back(AttributeSet::get(RetType->getContext(),
5217 AttributeSet::FunctionIndex,
5221 // Finish off the Attribute and check them
5222 AttributeSet PAL = AttributeSet::get(Context, Attrs);
5224 CallInst *CI = CallInst::Create(Ty, Callee, Args);
5225 CI->setTailCallKind(TCK);
5226 CI->setCallingConv(CC);
5227 CI->setAttributes(PAL);
5228 ForwardRefAttrGroups[CI] = FwdRefAttrGrps;
5233 //===----------------------------------------------------------------------===//
5234 // Memory Instructions.
5235 //===----------------------------------------------------------------------===//
5238 /// ::= 'alloca' 'inalloca'? Type (',' TypeAndValue)? (',' 'align' i32)?
5239 int LLParser::ParseAlloc(Instruction *&Inst, PerFunctionState &PFS) {
5240 Value *Size = nullptr;
5241 LocTy SizeLoc, TyLoc;
5242 unsigned Alignment = 0;
5245 bool IsInAlloca = EatIfPresent(lltok::kw_inalloca);
5247 if (ParseType(Ty, TyLoc)) return true;
5249 if (Ty->isFunctionTy() || !PointerType::isValidElementType(Ty))
5250 return Error(TyLoc, "invalid type for alloca");
5252 bool AteExtraComma = false;
5253 if (EatIfPresent(lltok::comma)) {
5254 if (Lex.getKind() == lltok::kw_align) {
5255 if (ParseOptionalAlignment(Alignment)) return true;
5256 } else if (Lex.getKind() == lltok::MetadataVar) {
5257 AteExtraComma = true;
5259 if (ParseTypeAndValue(Size, SizeLoc, PFS) ||
5260 ParseOptionalCommaAlign(Alignment, AteExtraComma))
5265 if (Size && !Size->getType()->isIntegerTy())
5266 return Error(SizeLoc, "element count must have integer type");
5268 AllocaInst *AI = new AllocaInst(Ty, Size, Alignment);
5269 AI->setUsedWithInAlloca(IsInAlloca);
5271 return AteExtraComma ? InstExtraComma : InstNormal;
5275 /// ::= 'load' 'volatile'? TypeAndValue (',' 'align' i32)?
5276 /// ::= 'load' 'atomic' 'volatile'? TypeAndValue
5277 /// 'singlethread'? AtomicOrdering (',' 'align' i32)?
5278 int LLParser::ParseLoad(Instruction *&Inst, PerFunctionState &PFS) {
5279 Value *Val; LocTy Loc;
5280 unsigned Alignment = 0;
5281 bool AteExtraComma = false;
5282 bool isAtomic = false;
5283 AtomicOrdering Ordering = NotAtomic;
5284 SynchronizationScope Scope = CrossThread;
5286 if (Lex.getKind() == lltok::kw_atomic) {
5291 bool isVolatile = false;
5292 if (Lex.getKind() == lltok::kw_volatile) {
5298 LocTy ExplicitTypeLoc = Lex.getLoc();
5299 if (ParseType(Ty) ||
5300 ParseToken(lltok::comma, "expected comma after load's type") ||
5301 ParseTypeAndValue(Val, Loc, PFS) ||
5302 ParseScopeAndOrdering(isAtomic, Scope, Ordering) ||
5303 ParseOptionalCommaAlign(Alignment, AteExtraComma))
5306 if (!Val->getType()->isPointerTy() || !Ty->isFirstClassType())
5307 return Error(Loc, "load operand must be a pointer to a first class type");
5308 if (isAtomic && !Alignment)
5309 return Error(Loc, "atomic load must have explicit non-zero alignment");
5310 if (Ordering == Release || Ordering == AcquireRelease)
5311 return Error(Loc, "atomic load cannot use Release ordering");
5313 if (Ty != cast<PointerType>(Val->getType())->getElementType())
5314 return Error(ExplicitTypeLoc,
5315 "explicit pointee type doesn't match operand's pointee type");
5317 Inst = new LoadInst(Ty, Val, "", isVolatile, Alignment, Ordering, Scope);
5318 return AteExtraComma ? InstExtraComma : InstNormal;
5323 /// ::= 'store' 'volatile'? TypeAndValue ',' TypeAndValue (',' 'align' i32)?
5324 /// ::= 'store' 'atomic' 'volatile'? TypeAndValue ',' TypeAndValue
5325 /// 'singlethread'? AtomicOrdering (',' 'align' i32)?
5326 int LLParser::ParseStore(Instruction *&Inst, PerFunctionState &PFS) {
5327 Value *Val, *Ptr; LocTy Loc, PtrLoc;
5328 unsigned Alignment = 0;
5329 bool AteExtraComma = false;
5330 bool isAtomic = false;
5331 AtomicOrdering Ordering = NotAtomic;
5332 SynchronizationScope Scope = CrossThread;
5334 if (Lex.getKind() == lltok::kw_atomic) {
5339 bool isVolatile = false;
5340 if (Lex.getKind() == lltok::kw_volatile) {
5345 if (ParseTypeAndValue(Val, Loc, PFS) ||
5346 ParseToken(lltok::comma, "expected ',' after store operand") ||
5347 ParseTypeAndValue(Ptr, PtrLoc, PFS) ||
5348 ParseScopeAndOrdering(isAtomic, Scope, Ordering) ||
5349 ParseOptionalCommaAlign(Alignment, AteExtraComma))
5352 if (!Ptr->getType()->isPointerTy())
5353 return Error(PtrLoc, "store operand must be a pointer");
5354 if (!Val->getType()->isFirstClassType())
5355 return Error(Loc, "store operand must be a first class value");
5356 if (cast<PointerType>(Ptr->getType())->getElementType() != Val->getType())
5357 return Error(Loc, "stored value and pointer type do not match");
5358 if (isAtomic && !Alignment)
5359 return Error(Loc, "atomic store must have explicit non-zero alignment");
5360 if (Ordering == Acquire || Ordering == AcquireRelease)
5361 return Error(Loc, "atomic store cannot use Acquire ordering");
5363 Inst = new StoreInst(Val, Ptr, isVolatile, Alignment, Ordering, Scope);
5364 return AteExtraComma ? InstExtraComma : InstNormal;
5368 /// ::= 'cmpxchg' 'weak'? 'volatile'? TypeAndValue ',' TypeAndValue ','
5369 /// TypeAndValue 'singlethread'? AtomicOrdering AtomicOrdering
5370 int LLParser::ParseCmpXchg(Instruction *&Inst, PerFunctionState &PFS) {
5371 Value *Ptr, *Cmp, *New; LocTy PtrLoc, CmpLoc, NewLoc;
5372 bool AteExtraComma = false;
5373 AtomicOrdering SuccessOrdering = NotAtomic;
5374 AtomicOrdering FailureOrdering = NotAtomic;
5375 SynchronizationScope Scope = CrossThread;
5376 bool isVolatile = false;
5377 bool isWeak = false;
5379 if (EatIfPresent(lltok::kw_weak))
5382 if (EatIfPresent(lltok::kw_volatile))
5385 if (ParseTypeAndValue(Ptr, PtrLoc, PFS) ||
5386 ParseToken(lltok::comma, "expected ',' after cmpxchg address") ||
5387 ParseTypeAndValue(Cmp, CmpLoc, PFS) ||
5388 ParseToken(lltok::comma, "expected ',' after cmpxchg cmp operand") ||
5389 ParseTypeAndValue(New, NewLoc, PFS) ||
5390 ParseScopeAndOrdering(true /*Always atomic*/, Scope, SuccessOrdering) ||
5391 ParseOrdering(FailureOrdering))
5394 if (SuccessOrdering == Unordered || FailureOrdering == Unordered)
5395 return TokError("cmpxchg cannot be unordered");
5396 if (SuccessOrdering < FailureOrdering)
5397 return TokError("cmpxchg must be at least as ordered on success as failure");
5398 if (FailureOrdering == Release || FailureOrdering == AcquireRelease)
5399 return TokError("cmpxchg failure ordering cannot include release semantics");
5400 if (!Ptr->getType()->isPointerTy())
5401 return Error(PtrLoc, "cmpxchg operand must be a pointer");
5402 if (cast<PointerType>(Ptr->getType())->getElementType() != Cmp->getType())
5403 return Error(CmpLoc, "compare value and pointer type do not match");
5404 if (cast<PointerType>(Ptr->getType())->getElementType() != New->getType())
5405 return Error(NewLoc, "new value and pointer type do not match");
5406 if (!New->getType()->isIntegerTy())
5407 return Error(NewLoc, "cmpxchg operand must be an integer");
5408 unsigned Size = New->getType()->getPrimitiveSizeInBits();
5409 if (Size < 8 || (Size & (Size - 1)))
5410 return Error(NewLoc, "cmpxchg operand must be power-of-two byte-sized"
5413 AtomicCmpXchgInst *CXI = new AtomicCmpXchgInst(
5414 Ptr, Cmp, New, SuccessOrdering, FailureOrdering, Scope);
5415 CXI->setVolatile(isVolatile);
5416 CXI->setWeak(isWeak);
5418 return AteExtraComma ? InstExtraComma : InstNormal;
5422 /// ::= 'atomicrmw' 'volatile'? BinOp TypeAndValue ',' TypeAndValue
5423 /// 'singlethread'? AtomicOrdering
5424 int LLParser::ParseAtomicRMW(Instruction *&Inst, PerFunctionState &PFS) {
5425 Value *Ptr, *Val; LocTy PtrLoc, ValLoc;
5426 bool AteExtraComma = false;
5427 AtomicOrdering Ordering = NotAtomic;
5428 SynchronizationScope Scope = CrossThread;
5429 bool isVolatile = false;
5430 AtomicRMWInst::BinOp Operation;
5432 if (EatIfPresent(lltok::kw_volatile))
5435 switch (Lex.getKind()) {
5436 default: return TokError("expected binary operation in atomicrmw");
5437 case lltok::kw_xchg: Operation = AtomicRMWInst::Xchg; break;
5438 case lltok::kw_add: Operation = AtomicRMWInst::Add; break;
5439 case lltok::kw_sub: Operation = AtomicRMWInst::Sub; break;
5440 case lltok::kw_and: Operation = AtomicRMWInst::And; break;
5441 case lltok::kw_nand: Operation = AtomicRMWInst::Nand; break;
5442 case lltok::kw_or: Operation = AtomicRMWInst::Or; break;
5443 case lltok::kw_xor: Operation = AtomicRMWInst::Xor; break;
5444 case lltok::kw_max: Operation = AtomicRMWInst::Max; break;
5445 case lltok::kw_min: Operation = AtomicRMWInst::Min; break;
5446 case lltok::kw_umax: Operation = AtomicRMWInst::UMax; break;
5447 case lltok::kw_umin: Operation = AtomicRMWInst::UMin; break;
5449 Lex.Lex(); // Eat the operation.
5451 if (ParseTypeAndValue(Ptr, PtrLoc, PFS) ||
5452 ParseToken(lltok::comma, "expected ',' after atomicrmw address") ||
5453 ParseTypeAndValue(Val, ValLoc, PFS) ||
5454 ParseScopeAndOrdering(true /*Always atomic*/, Scope, Ordering))
5457 if (Ordering == Unordered)
5458 return TokError("atomicrmw cannot be unordered");
5459 if (!Ptr->getType()->isPointerTy())
5460 return Error(PtrLoc, "atomicrmw operand must be a pointer");
5461 if (cast<PointerType>(Ptr->getType())->getElementType() != Val->getType())
5462 return Error(ValLoc, "atomicrmw value and pointer type do not match");
5463 if (!Val->getType()->isIntegerTy())
5464 return Error(ValLoc, "atomicrmw operand must be an integer");
5465 unsigned Size = Val->getType()->getPrimitiveSizeInBits();
5466 if (Size < 8 || (Size & (Size - 1)))
5467 return Error(ValLoc, "atomicrmw operand must be power-of-two byte-sized"
5470 AtomicRMWInst *RMWI =
5471 new AtomicRMWInst(Operation, Ptr, Val, Ordering, Scope);
5472 RMWI->setVolatile(isVolatile);
5474 return AteExtraComma ? InstExtraComma : InstNormal;
5478 /// ::= 'fence' 'singlethread'? AtomicOrdering
5479 int LLParser::ParseFence(Instruction *&Inst, PerFunctionState &PFS) {
5480 AtomicOrdering Ordering = NotAtomic;
5481 SynchronizationScope Scope = CrossThread;
5482 if (ParseScopeAndOrdering(true /*Always atomic*/, Scope, Ordering))
5485 if (Ordering == Unordered)
5486 return TokError("fence cannot be unordered");
5487 if (Ordering == Monotonic)
5488 return TokError("fence cannot be monotonic");
5490 Inst = new FenceInst(Context, Ordering, Scope);
5494 /// ParseGetElementPtr
5495 /// ::= 'getelementptr' 'inbounds'? TypeAndValue (',' TypeAndValue)*
5496 int LLParser::ParseGetElementPtr(Instruction *&Inst, PerFunctionState &PFS) {
5497 Value *Ptr = nullptr;
5498 Value *Val = nullptr;
5501 bool InBounds = EatIfPresent(lltok::kw_inbounds);
5504 LocTy ExplicitTypeLoc = Lex.getLoc();
5505 if (ParseType(Ty) ||
5506 ParseToken(lltok::comma, "expected comma after getelementptr's type") ||
5507 ParseTypeAndValue(Ptr, Loc, PFS))
5510 Type *BaseType = Ptr->getType();
5511 PointerType *BasePointerType = dyn_cast<PointerType>(BaseType->getScalarType());
5512 if (!BasePointerType)
5513 return Error(Loc, "base of getelementptr must be a pointer");
5515 if (Ty != BasePointerType->getElementType())
5516 return Error(ExplicitTypeLoc,
5517 "explicit pointee type doesn't match operand's pointee type");
5519 SmallVector<Value*, 16> Indices;
5520 bool AteExtraComma = false;
5521 while (EatIfPresent(lltok::comma)) {
5522 if (Lex.getKind() == lltok::MetadataVar) {
5523 AteExtraComma = true;
5526 if (ParseTypeAndValue(Val, EltLoc, PFS)) return true;
5527 if (!Val->getType()->getScalarType()->isIntegerTy())
5528 return Error(EltLoc, "getelementptr index must be an integer");
5529 if (Val->getType()->isVectorTy() != Ptr->getType()->isVectorTy())
5530 return Error(EltLoc, "getelementptr index type missmatch");
5531 if (Val->getType()->isVectorTy()) {
5532 unsigned ValNumEl = cast<VectorType>(Val->getType())->getNumElements();
5533 unsigned PtrNumEl = cast<VectorType>(Ptr->getType())->getNumElements();
5534 if (ValNumEl != PtrNumEl)
5535 return Error(EltLoc,
5536 "getelementptr vector index has a wrong number of elements");
5538 Indices.push_back(Val);
5541 SmallPtrSet<const Type*, 4> Visited;
5542 if (!Indices.empty() && !Ty->isSized(&Visited))
5543 return Error(Loc, "base element of getelementptr must be sized");
5545 if (!GetElementPtrInst::getIndexedType(Ty, Indices))
5546 return Error(Loc, "invalid getelementptr indices");
5547 Inst = GetElementPtrInst::Create(Ty, Ptr, Indices);
5549 cast<GetElementPtrInst>(Inst)->setIsInBounds(true);
5550 return AteExtraComma ? InstExtraComma : InstNormal;
5553 /// ParseExtractValue
5554 /// ::= 'extractvalue' TypeAndValue (',' uint32)+
5555 int LLParser::ParseExtractValue(Instruction *&Inst, PerFunctionState &PFS) {
5556 Value *Val; LocTy Loc;
5557 SmallVector<unsigned, 4> Indices;
5559 if (ParseTypeAndValue(Val, Loc, PFS) ||
5560 ParseIndexList(Indices, AteExtraComma))
5563 if (!Val->getType()->isAggregateType())
5564 return Error(Loc, "extractvalue operand must be aggregate type");
5566 if (!ExtractValueInst::getIndexedType(Val->getType(), Indices))
5567 return Error(Loc, "invalid indices for extractvalue");
5568 Inst = ExtractValueInst::Create(Val, Indices);
5569 return AteExtraComma ? InstExtraComma : InstNormal;
5572 /// ParseInsertValue
5573 /// ::= 'insertvalue' TypeAndValue ',' TypeAndValue (',' uint32)+
5574 int LLParser::ParseInsertValue(Instruction *&Inst, PerFunctionState &PFS) {
5575 Value *Val0, *Val1; LocTy Loc0, Loc1;
5576 SmallVector<unsigned, 4> Indices;
5578 if (ParseTypeAndValue(Val0, Loc0, PFS) ||
5579 ParseToken(lltok::comma, "expected comma after insertvalue operand") ||
5580 ParseTypeAndValue(Val1, Loc1, PFS) ||
5581 ParseIndexList(Indices, AteExtraComma))
5584 if (!Val0->getType()->isAggregateType())
5585 return Error(Loc0, "insertvalue operand must be aggregate type");
5587 Type *IndexedType = ExtractValueInst::getIndexedType(Val0->getType(), Indices);
5589 return Error(Loc0, "invalid indices for insertvalue");
5590 if (IndexedType != Val1->getType())
5591 return Error(Loc1, "insertvalue operand and field disagree in type: '" +
5592 getTypeString(Val1->getType()) + "' instead of '" +
5593 getTypeString(IndexedType) + "'");
5594 Inst = InsertValueInst::Create(Val0, Val1, Indices);
5595 return AteExtraComma ? InstExtraComma : InstNormal;
5598 //===----------------------------------------------------------------------===//
5599 // Embedded metadata.
5600 //===----------------------------------------------------------------------===//
5602 /// ParseMDNodeVector
5603 /// ::= { Element (',' Element)* }
5605 /// ::= 'null' | TypeAndValue
5606 bool LLParser::ParseMDNodeVector(SmallVectorImpl<Metadata *> &Elts) {
5607 if (ParseToken(lltok::lbrace, "expected '{' here"))
5610 // Check for an empty list.
5611 if (EatIfPresent(lltok::rbrace))
5615 // Null is a special case since it is typeless.
5616 if (EatIfPresent(lltok::kw_null)) {
5617 Elts.push_back(nullptr);
5622 if (ParseMetadata(MD, nullptr))
5625 } while (EatIfPresent(lltok::comma));
5627 return ParseToken(lltok::rbrace, "expected end of metadata node");
5630 //===----------------------------------------------------------------------===//
5631 // Use-list order directives.
5632 //===----------------------------------------------------------------------===//
5633 bool LLParser::sortUseListOrder(Value *V, ArrayRef<unsigned> Indexes,
5636 return Error(Loc, "value has no uses");
5638 unsigned NumUses = 0;
5639 SmallDenseMap<const Use *, unsigned, 16> Order;
5640 for (const Use &U : V->uses()) {
5641 if (++NumUses > Indexes.size())
5643 Order[&U] = Indexes[NumUses - 1];
5646 return Error(Loc, "value only has one use");
5647 if (Order.size() != Indexes.size() || NumUses > Indexes.size())
5648 return Error(Loc, "wrong number of indexes, expected " +
5649 Twine(std::distance(V->use_begin(), V->use_end())));
5651 V->sortUseList([&](const Use &L, const Use &R) {
5652 return Order.lookup(&L) < Order.lookup(&R);
5657 /// ParseUseListOrderIndexes
5658 /// ::= '{' uint32 (',' uint32)+ '}'
5659 bool LLParser::ParseUseListOrderIndexes(SmallVectorImpl<unsigned> &Indexes) {
5660 SMLoc Loc = Lex.getLoc();
5661 if (ParseToken(lltok::lbrace, "expected '{' here"))
5663 if (Lex.getKind() == lltok::rbrace)
5664 return Lex.Error("expected non-empty list of uselistorder indexes");
5666 // Use Offset, Max, and IsOrdered to check consistency of indexes. The
5667 // indexes should be distinct numbers in the range [0, size-1], and should
5669 unsigned Offset = 0;
5671 bool IsOrdered = true;
5672 assert(Indexes.empty() && "Expected empty order vector");
5675 if (ParseUInt32(Index))
5678 // Update consistency checks.
5679 Offset += Index - Indexes.size();
5680 Max = std::max(Max, Index);
5681 IsOrdered &= Index == Indexes.size();
5683 Indexes.push_back(Index);
5684 } while (EatIfPresent(lltok::comma));
5686 if (ParseToken(lltok::rbrace, "expected '}' here"))
5689 if (Indexes.size() < 2)
5690 return Error(Loc, "expected >= 2 uselistorder indexes");
5691 if (Offset != 0 || Max >= Indexes.size())
5692 return Error(Loc, "expected distinct uselistorder indexes in range [0, size)");
5694 return Error(Loc, "expected uselistorder indexes to change the order");
5699 /// ParseUseListOrder
5700 /// ::= 'uselistorder' Type Value ',' UseListOrderIndexes
5701 bool LLParser::ParseUseListOrder(PerFunctionState *PFS) {
5702 SMLoc Loc = Lex.getLoc();
5703 if (ParseToken(lltok::kw_uselistorder, "expected uselistorder directive"))
5707 SmallVector<unsigned, 16> Indexes;
5708 if (ParseTypeAndValue(V, PFS) ||
5709 ParseToken(lltok::comma, "expected comma in uselistorder directive") ||
5710 ParseUseListOrderIndexes(Indexes))
5713 return sortUseListOrder(V, Indexes, Loc);
5716 /// ParseUseListOrderBB
5717 /// ::= 'uselistorder_bb' @foo ',' %bar ',' UseListOrderIndexes
5718 bool LLParser::ParseUseListOrderBB() {
5719 assert(Lex.getKind() == lltok::kw_uselistorder_bb);
5720 SMLoc Loc = Lex.getLoc();
5724 SmallVector<unsigned, 16> Indexes;
5725 if (ParseValID(Fn) ||
5726 ParseToken(lltok::comma, "expected comma in uselistorder_bb directive") ||
5727 ParseValID(Label) ||
5728 ParseToken(lltok::comma, "expected comma in uselistorder_bb directive") ||
5729 ParseUseListOrderIndexes(Indexes))
5732 // Check the function.
5734 if (Fn.Kind == ValID::t_GlobalName)
5735 GV = M->getNamedValue(Fn.StrVal);
5736 else if (Fn.Kind == ValID::t_GlobalID)
5737 GV = Fn.UIntVal < NumberedVals.size() ? NumberedVals[Fn.UIntVal] : nullptr;
5739 return Error(Fn.Loc, "expected function name in uselistorder_bb");
5741 return Error(Fn.Loc, "invalid function forward reference in uselistorder_bb");
5742 auto *F = dyn_cast<Function>(GV);
5744 return Error(Fn.Loc, "expected function name in uselistorder_bb");
5745 if (F->isDeclaration())
5746 return Error(Fn.Loc, "invalid declaration in uselistorder_bb");
5748 // Check the basic block.
5749 if (Label.Kind == ValID::t_LocalID)
5750 return Error(Label.Loc, "invalid numeric label in uselistorder_bb");
5751 if (Label.Kind != ValID::t_LocalName)
5752 return Error(Label.Loc, "expected basic block name in uselistorder_bb");
5753 Value *V = F->getValueSymbolTable().lookup(Label.StrVal);
5755 return Error(Label.Loc, "invalid basic block in uselistorder_bb");
5756 if (!isa<BasicBlock>(V))
5757 return Error(Label.Loc, "expected basic block in uselistorder_bb");
5759 return sortUseListOrder(V, Indexes, Loc);