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_inalloca:
981 case lltok::kw_noalias:
982 case lltok::kw_nocapture:
983 case lltok::kw_nonnull:
984 case lltok::kw_returned:
988 "invalid use of parameter-only attribute on a function");
996 //===----------------------------------------------------------------------===//
997 // GlobalValue Reference/Resolution Routines.
998 //===----------------------------------------------------------------------===//
1000 /// GetGlobalVal - Get a value with the specified name or ID, creating a
1001 /// forward reference record if needed. This can return null if the value
1002 /// exists but does not have the right type.
1003 GlobalValue *LLParser::GetGlobalVal(const std::string &Name, Type *Ty,
1005 PointerType *PTy = dyn_cast<PointerType>(Ty);
1007 Error(Loc, "global variable reference must have pointer type");
1011 // Look this name up in the normal function symbol table.
1013 cast_or_null<GlobalValue>(M->getValueSymbolTable().lookup(Name));
1015 // If this is a forward reference for the value, see if we already created a
1016 // forward ref record.
1018 std::map<std::string, std::pair<GlobalValue*, LocTy> >::iterator
1019 I = ForwardRefVals.find(Name);
1020 if (I != ForwardRefVals.end())
1021 Val = I->second.first;
1024 // If we have the value in the symbol table or fwd-ref table, return it.
1026 if (Val->getType() == Ty) return Val;
1027 Error(Loc, "'@" + Name + "' defined with type '" +
1028 getTypeString(Val->getType()) + "'");
1032 // Otherwise, create a new forward reference for this value and remember it.
1033 GlobalValue *FwdVal;
1034 if (FunctionType *FT = dyn_cast<FunctionType>(PTy->getElementType()))
1035 FwdVal = Function::Create(FT, GlobalValue::ExternalWeakLinkage, Name, M);
1037 FwdVal = new GlobalVariable(*M, PTy->getElementType(), false,
1038 GlobalValue::ExternalWeakLinkage, nullptr, Name,
1039 nullptr, GlobalVariable::NotThreadLocal,
1040 PTy->getAddressSpace());
1042 ForwardRefVals[Name] = std::make_pair(FwdVal, Loc);
1046 GlobalValue *LLParser::GetGlobalVal(unsigned ID, Type *Ty, LocTy Loc) {
1047 PointerType *PTy = dyn_cast<PointerType>(Ty);
1049 Error(Loc, "global variable reference must have pointer type");
1053 GlobalValue *Val = ID < NumberedVals.size() ? NumberedVals[ID] : nullptr;
1055 // If this is a forward reference for the value, see if we already created a
1056 // forward ref record.
1058 std::map<unsigned, std::pair<GlobalValue*, LocTy> >::iterator
1059 I = ForwardRefValIDs.find(ID);
1060 if (I != ForwardRefValIDs.end())
1061 Val = I->second.first;
1064 // If we have the value in the symbol table or fwd-ref table, return it.
1066 if (Val->getType() == Ty) return Val;
1067 Error(Loc, "'@" + Twine(ID) + "' defined with type '" +
1068 getTypeString(Val->getType()) + "'");
1072 // Otherwise, create a new forward reference for this value and remember it.
1073 GlobalValue *FwdVal;
1074 if (FunctionType *FT = dyn_cast<FunctionType>(PTy->getElementType()))
1075 FwdVal = Function::Create(FT, GlobalValue::ExternalWeakLinkage, "", M);
1077 FwdVal = new GlobalVariable(*M, PTy->getElementType(), false,
1078 GlobalValue::ExternalWeakLinkage, nullptr, "");
1080 ForwardRefValIDs[ID] = std::make_pair(FwdVal, Loc);
1085 //===----------------------------------------------------------------------===//
1086 // Comdat Reference/Resolution Routines.
1087 //===----------------------------------------------------------------------===//
1089 Comdat *LLParser::getComdat(const std::string &Name, LocTy Loc) {
1090 // Look this name up in the comdat symbol table.
1091 Module::ComdatSymTabType &ComdatSymTab = M->getComdatSymbolTable();
1092 Module::ComdatSymTabType::iterator I = ComdatSymTab.find(Name);
1093 if (I != ComdatSymTab.end())
1096 // Otherwise, create a new forward reference for this value and remember it.
1097 Comdat *C = M->getOrInsertComdat(Name);
1098 ForwardRefComdats[Name] = Loc;
1103 //===----------------------------------------------------------------------===//
1105 //===----------------------------------------------------------------------===//
1107 /// ParseToken - If the current token has the specified kind, eat it and return
1108 /// success. Otherwise, emit the specified error and return failure.
1109 bool LLParser::ParseToken(lltok::Kind T, const char *ErrMsg) {
1110 if (Lex.getKind() != T)
1111 return TokError(ErrMsg);
1116 /// ParseStringConstant
1117 /// ::= StringConstant
1118 bool LLParser::ParseStringConstant(std::string &Result) {
1119 if (Lex.getKind() != lltok::StringConstant)
1120 return TokError("expected string constant");
1121 Result = Lex.getStrVal();
1128 bool LLParser::ParseUInt32(unsigned &Val) {
1129 if (Lex.getKind() != lltok::APSInt || Lex.getAPSIntVal().isSigned())
1130 return TokError("expected integer");
1131 uint64_t Val64 = Lex.getAPSIntVal().getLimitedValue(0xFFFFFFFFULL+1);
1132 if (Val64 != unsigned(Val64))
1133 return TokError("expected 32-bit integer (too large)");
1141 bool LLParser::ParseUInt64(uint64_t &Val) {
1142 if (Lex.getKind() != lltok::APSInt || Lex.getAPSIntVal().isSigned())
1143 return TokError("expected integer");
1144 Val = Lex.getAPSIntVal().getLimitedValue();
1150 /// := 'localdynamic'
1151 /// := 'initialexec'
1153 bool LLParser::ParseTLSModel(GlobalVariable::ThreadLocalMode &TLM) {
1154 switch (Lex.getKind()) {
1156 return TokError("expected localdynamic, initialexec or localexec");
1157 case lltok::kw_localdynamic:
1158 TLM = GlobalVariable::LocalDynamicTLSModel;
1160 case lltok::kw_initialexec:
1161 TLM = GlobalVariable::InitialExecTLSModel;
1163 case lltok::kw_localexec:
1164 TLM = GlobalVariable::LocalExecTLSModel;
1172 /// ParseOptionalThreadLocal
1174 /// := 'thread_local'
1175 /// := 'thread_local' '(' tlsmodel ')'
1176 bool LLParser::ParseOptionalThreadLocal(GlobalVariable::ThreadLocalMode &TLM) {
1177 TLM = GlobalVariable::NotThreadLocal;
1178 if (!EatIfPresent(lltok::kw_thread_local))
1181 TLM = GlobalVariable::GeneralDynamicTLSModel;
1182 if (Lex.getKind() == lltok::lparen) {
1184 return ParseTLSModel(TLM) ||
1185 ParseToken(lltok::rparen, "expected ')' after thread local model");
1190 /// ParseOptionalAddrSpace
1192 /// := 'addrspace' '(' uint32 ')'
1193 bool LLParser::ParseOptionalAddrSpace(unsigned &AddrSpace) {
1195 if (!EatIfPresent(lltok::kw_addrspace))
1197 return ParseToken(lltok::lparen, "expected '(' in address space") ||
1198 ParseUInt32(AddrSpace) ||
1199 ParseToken(lltok::rparen, "expected ')' in address space");
1202 /// ParseOptionalParamAttrs - Parse a potentially empty list of parameter attributes.
1203 bool LLParser::ParseOptionalParamAttrs(AttrBuilder &B) {
1204 bool HaveError = false;
1209 lltok::Kind Token = Lex.getKind();
1211 default: // End of attributes.
1213 case lltok::kw_align: {
1215 if (ParseOptionalAlignment(Alignment))
1217 B.addAlignmentAttr(Alignment);
1220 case lltok::kw_byval: B.addAttribute(Attribute::ByVal); break;
1221 case lltok::kw_dereferenceable: {
1223 if (ParseOptionalDereferenceableBytes(Bytes))
1225 B.addDereferenceableAttr(Bytes);
1228 case lltok::kw_inalloca: B.addAttribute(Attribute::InAlloca); break;
1229 case lltok::kw_inreg: B.addAttribute(Attribute::InReg); break;
1230 case lltok::kw_nest: B.addAttribute(Attribute::Nest); break;
1231 case lltok::kw_noalias: B.addAttribute(Attribute::NoAlias); break;
1232 case lltok::kw_nocapture: B.addAttribute(Attribute::NoCapture); break;
1233 case lltok::kw_nonnull: B.addAttribute(Attribute::NonNull); break;
1234 case lltok::kw_readnone: B.addAttribute(Attribute::ReadNone); break;
1235 case lltok::kw_readonly: B.addAttribute(Attribute::ReadOnly); break;
1236 case lltok::kw_returned: B.addAttribute(Attribute::Returned); break;
1237 case lltok::kw_signext: B.addAttribute(Attribute::SExt); break;
1238 case lltok::kw_sret: B.addAttribute(Attribute::StructRet); break;
1239 case lltok::kw_zeroext: B.addAttribute(Attribute::ZExt); break;
1241 case lltok::kw_alignstack:
1242 case lltok::kw_alwaysinline:
1243 case lltok::kw_builtin:
1244 case lltok::kw_inlinehint:
1245 case lltok::kw_jumptable:
1246 case lltok::kw_minsize:
1247 case lltok::kw_naked:
1248 case lltok::kw_nobuiltin:
1249 case lltok::kw_noduplicate:
1250 case lltok::kw_noimplicitfloat:
1251 case lltok::kw_noinline:
1252 case lltok::kw_nonlazybind:
1253 case lltok::kw_noredzone:
1254 case lltok::kw_noreturn:
1255 case lltok::kw_nounwind:
1256 case lltok::kw_optnone:
1257 case lltok::kw_optsize:
1258 case lltok::kw_returns_twice:
1259 case lltok::kw_sanitize_address:
1260 case lltok::kw_sanitize_memory:
1261 case lltok::kw_sanitize_thread:
1263 case lltok::kw_sspreq:
1264 case lltok::kw_sspstrong:
1265 case lltok::kw_uwtable:
1266 HaveError |= Error(Lex.getLoc(), "invalid use of function-only attribute");
1274 /// ParseOptionalReturnAttrs - Parse a potentially empty list of return attributes.
1275 bool LLParser::ParseOptionalReturnAttrs(AttrBuilder &B) {
1276 bool HaveError = false;
1281 lltok::Kind Token = Lex.getKind();
1283 default: // End of attributes.
1285 case lltok::kw_dereferenceable: {
1287 if (ParseOptionalDereferenceableBytes(Bytes))
1289 B.addDereferenceableAttr(Bytes);
1292 case lltok::kw_inreg: B.addAttribute(Attribute::InReg); break;
1293 case lltok::kw_noalias: B.addAttribute(Attribute::NoAlias); break;
1294 case lltok::kw_nonnull: B.addAttribute(Attribute::NonNull); break;
1295 case lltok::kw_signext: B.addAttribute(Attribute::SExt); break;
1296 case lltok::kw_zeroext: B.addAttribute(Attribute::ZExt); break;
1299 case lltok::kw_align:
1300 case lltok::kw_byval:
1301 case lltok::kw_inalloca:
1302 case lltok::kw_nest:
1303 case lltok::kw_nocapture:
1304 case lltok::kw_returned:
1305 case lltok::kw_sret:
1306 HaveError |= Error(Lex.getLoc(), "invalid use of parameter-only attribute");
1309 case lltok::kw_alignstack:
1310 case lltok::kw_alwaysinline:
1311 case lltok::kw_builtin:
1312 case lltok::kw_cold:
1313 case lltok::kw_inlinehint:
1314 case lltok::kw_jumptable:
1315 case lltok::kw_minsize:
1316 case lltok::kw_naked:
1317 case lltok::kw_nobuiltin:
1318 case lltok::kw_noduplicate:
1319 case lltok::kw_noimplicitfloat:
1320 case lltok::kw_noinline:
1321 case lltok::kw_nonlazybind:
1322 case lltok::kw_noredzone:
1323 case lltok::kw_noreturn:
1324 case lltok::kw_nounwind:
1325 case lltok::kw_optnone:
1326 case lltok::kw_optsize:
1327 case lltok::kw_returns_twice:
1328 case lltok::kw_sanitize_address:
1329 case lltok::kw_sanitize_memory:
1330 case lltok::kw_sanitize_thread:
1332 case lltok::kw_sspreq:
1333 case lltok::kw_sspstrong:
1334 case lltok::kw_uwtable:
1335 HaveError |= Error(Lex.getLoc(), "invalid use of function-only attribute");
1338 case lltok::kw_readnone:
1339 case lltok::kw_readonly:
1340 HaveError |= Error(Lex.getLoc(), "invalid use of attribute on return type");
1347 /// ParseOptionalLinkage
1354 /// ::= 'linkonce_odr'
1355 /// ::= 'available_externally'
1358 /// ::= 'extern_weak'
1360 bool LLParser::ParseOptionalLinkage(unsigned &Res, bool &HasLinkage) {
1362 switch (Lex.getKind()) {
1363 default: Res=GlobalValue::ExternalLinkage; return false;
1364 case lltok::kw_private: Res = GlobalValue::PrivateLinkage; break;
1365 case lltok::kw_internal: Res = GlobalValue::InternalLinkage; break;
1366 case lltok::kw_weak: Res = GlobalValue::WeakAnyLinkage; break;
1367 case lltok::kw_weak_odr: Res = GlobalValue::WeakODRLinkage; break;
1368 case lltok::kw_linkonce: Res = GlobalValue::LinkOnceAnyLinkage; break;
1369 case lltok::kw_linkonce_odr: Res = GlobalValue::LinkOnceODRLinkage; break;
1370 case lltok::kw_available_externally:
1371 Res = GlobalValue::AvailableExternallyLinkage;
1373 case lltok::kw_appending: Res = GlobalValue::AppendingLinkage; break;
1374 case lltok::kw_common: Res = GlobalValue::CommonLinkage; break;
1375 case lltok::kw_extern_weak: Res = GlobalValue::ExternalWeakLinkage; break;
1376 case lltok::kw_external: Res = GlobalValue::ExternalLinkage; break;
1383 /// ParseOptionalVisibility
1389 bool LLParser::ParseOptionalVisibility(unsigned &Res) {
1390 switch (Lex.getKind()) {
1391 default: Res = GlobalValue::DefaultVisibility; return false;
1392 case lltok::kw_default: Res = GlobalValue::DefaultVisibility; break;
1393 case lltok::kw_hidden: Res = GlobalValue::HiddenVisibility; break;
1394 case lltok::kw_protected: Res = GlobalValue::ProtectedVisibility; break;
1400 /// ParseOptionalDLLStorageClass
1405 bool LLParser::ParseOptionalDLLStorageClass(unsigned &Res) {
1406 switch (Lex.getKind()) {
1407 default: Res = GlobalValue::DefaultStorageClass; return false;
1408 case lltok::kw_dllimport: Res = GlobalValue::DLLImportStorageClass; break;
1409 case lltok::kw_dllexport: Res = GlobalValue::DLLExportStorageClass; break;
1415 /// ParseOptionalCallingConv
1419 /// ::= 'intel_ocl_bicc'
1421 /// ::= 'x86_stdcallcc'
1422 /// ::= 'x86_fastcallcc'
1423 /// ::= 'x86_thiscallcc'
1424 /// ::= 'x86_vectorcallcc'
1425 /// ::= 'arm_apcscc'
1426 /// ::= 'arm_aapcscc'
1427 /// ::= 'arm_aapcs_vfpcc'
1428 /// ::= 'msp430_intrcc'
1429 /// ::= 'ptx_kernel'
1430 /// ::= 'ptx_device'
1432 /// ::= 'spir_kernel'
1433 /// ::= 'x86_64_sysvcc'
1434 /// ::= 'x86_64_win64cc'
1435 /// ::= 'webkit_jscc'
1437 /// ::= 'preserve_mostcc'
1438 /// ::= 'preserve_allcc'
1442 bool LLParser::ParseOptionalCallingConv(unsigned &CC) {
1443 switch (Lex.getKind()) {
1444 default: CC = CallingConv::C; return false;
1445 case lltok::kw_ccc: CC = CallingConv::C; break;
1446 case lltok::kw_fastcc: CC = CallingConv::Fast; break;
1447 case lltok::kw_coldcc: CC = CallingConv::Cold; break;
1448 case lltok::kw_x86_stdcallcc: CC = CallingConv::X86_StdCall; break;
1449 case lltok::kw_x86_fastcallcc: CC = CallingConv::X86_FastCall; break;
1450 case lltok::kw_x86_thiscallcc: CC = CallingConv::X86_ThisCall; break;
1451 case lltok::kw_x86_vectorcallcc:CC = CallingConv::X86_VectorCall; break;
1452 case lltok::kw_arm_apcscc: CC = CallingConv::ARM_APCS; break;
1453 case lltok::kw_arm_aapcscc: CC = CallingConv::ARM_AAPCS; break;
1454 case lltok::kw_arm_aapcs_vfpcc:CC = CallingConv::ARM_AAPCS_VFP; break;
1455 case lltok::kw_msp430_intrcc: CC = CallingConv::MSP430_INTR; break;
1456 case lltok::kw_ptx_kernel: CC = CallingConv::PTX_Kernel; break;
1457 case lltok::kw_ptx_device: CC = CallingConv::PTX_Device; break;
1458 case lltok::kw_spir_kernel: CC = CallingConv::SPIR_KERNEL; break;
1459 case lltok::kw_spir_func: CC = CallingConv::SPIR_FUNC; break;
1460 case lltok::kw_intel_ocl_bicc: CC = CallingConv::Intel_OCL_BI; break;
1461 case lltok::kw_x86_64_sysvcc: CC = CallingConv::X86_64_SysV; break;
1462 case lltok::kw_x86_64_win64cc: CC = CallingConv::X86_64_Win64; break;
1463 case lltok::kw_webkit_jscc: CC = CallingConv::WebKit_JS; break;
1464 case lltok::kw_anyregcc: CC = CallingConv::AnyReg; break;
1465 case lltok::kw_preserve_mostcc:CC = CallingConv::PreserveMost; break;
1466 case lltok::kw_preserve_allcc: CC = CallingConv::PreserveAll; break;
1467 case lltok::kw_ghccc: CC = CallingConv::GHC; break;
1468 case lltok::kw_cc: {
1470 return ParseUInt32(CC);
1478 /// ParseInstructionMetadata
1479 /// ::= !dbg !42 (',' !dbg !57)*
1480 bool LLParser::ParseInstructionMetadata(Instruction *Inst,
1481 PerFunctionState *PFS) {
1483 if (Lex.getKind() != lltok::MetadataVar)
1484 return TokError("expected metadata after comma");
1486 std::string Name = Lex.getStrVal();
1487 unsigned MDK = M->getMDKindID(Name);
1494 Inst->setMetadata(MDK, N);
1495 if (MDK == LLVMContext::MD_tbaa)
1496 InstsWithTBAATag.push_back(Inst);
1498 // If this is the end of the list, we're done.
1499 } while (EatIfPresent(lltok::comma));
1503 /// ParseOptionalAlignment
1506 bool LLParser::ParseOptionalAlignment(unsigned &Alignment) {
1508 if (!EatIfPresent(lltok::kw_align))
1510 LocTy AlignLoc = Lex.getLoc();
1511 if (ParseUInt32(Alignment)) return true;
1512 if (!isPowerOf2_32(Alignment))
1513 return Error(AlignLoc, "alignment is not a power of two");
1514 if (Alignment > Value::MaximumAlignment)
1515 return Error(AlignLoc, "huge alignments are not supported yet");
1519 /// ParseOptionalDereferenceableBytes
1521 /// ::= 'dereferenceable' '(' 4 ')'
1522 bool LLParser::ParseOptionalDereferenceableBytes(uint64_t &Bytes) {
1524 if (!EatIfPresent(lltok::kw_dereferenceable))
1526 LocTy ParenLoc = Lex.getLoc();
1527 if (!EatIfPresent(lltok::lparen))
1528 return Error(ParenLoc, "expected '('");
1529 LocTy DerefLoc = Lex.getLoc();
1530 if (ParseUInt64(Bytes)) return true;
1531 ParenLoc = Lex.getLoc();
1532 if (!EatIfPresent(lltok::rparen))
1533 return Error(ParenLoc, "expected ')'");
1535 return Error(DerefLoc, "dereferenceable bytes must be non-zero");
1539 /// ParseOptionalCommaAlign
1543 /// This returns with AteExtraComma set to true if it ate an excess comma at the
1545 bool LLParser::ParseOptionalCommaAlign(unsigned &Alignment,
1546 bool &AteExtraComma) {
1547 AteExtraComma = false;
1548 while (EatIfPresent(lltok::comma)) {
1549 // Metadata at the end is an early exit.
1550 if (Lex.getKind() == lltok::MetadataVar) {
1551 AteExtraComma = true;
1555 if (Lex.getKind() != lltok::kw_align)
1556 return Error(Lex.getLoc(), "expected metadata or 'align'");
1558 if (ParseOptionalAlignment(Alignment)) return true;
1564 /// ParseScopeAndOrdering
1565 /// if isAtomic: ::= 'singlethread'? AtomicOrdering
1568 /// This sets Scope and Ordering to the parsed values.
1569 bool LLParser::ParseScopeAndOrdering(bool isAtomic, SynchronizationScope &Scope,
1570 AtomicOrdering &Ordering) {
1574 Scope = CrossThread;
1575 if (EatIfPresent(lltok::kw_singlethread))
1576 Scope = SingleThread;
1578 return ParseOrdering(Ordering);
1582 /// ::= AtomicOrdering
1584 /// This sets Ordering to the parsed value.
1585 bool LLParser::ParseOrdering(AtomicOrdering &Ordering) {
1586 switch (Lex.getKind()) {
1587 default: return TokError("Expected ordering on atomic instruction");
1588 case lltok::kw_unordered: Ordering = Unordered; break;
1589 case lltok::kw_monotonic: Ordering = Monotonic; break;
1590 case lltok::kw_acquire: Ordering = Acquire; break;
1591 case lltok::kw_release: Ordering = Release; break;
1592 case lltok::kw_acq_rel: Ordering = AcquireRelease; break;
1593 case lltok::kw_seq_cst: Ordering = SequentiallyConsistent; break;
1599 /// ParseOptionalStackAlignment
1601 /// ::= 'alignstack' '(' 4 ')'
1602 bool LLParser::ParseOptionalStackAlignment(unsigned &Alignment) {
1604 if (!EatIfPresent(lltok::kw_alignstack))
1606 LocTy ParenLoc = Lex.getLoc();
1607 if (!EatIfPresent(lltok::lparen))
1608 return Error(ParenLoc, "expected '('");
1609 LocTy AlignLoc = Lex.getLoc();
1610 if (ParseUInt32(Alignment)) return true;
1611 ParenLoc = Lex.getLoc();
1612 if (!EatIfPresent(lltok::rparen))
1613 return Error(ParenLoc, "expected ')'");
1614 if (!isPowerOf2_32(Alignment))
1615 return Error(AlignLoc, "stack alignment is not a power of two");
1619 /// ParseIndexList - This parses the index list for an insert/extractvalue
1620 /// instruction. This sets AteExtraComma in the case where we eat an extra
1621 /// comma at the end of the line and find that it is followed by metadata.
1622 /// Clients that don't allow metadata can call the version of this function that
1623 /// only takes one argument.
1626 /// ::= (',' uint32)+
1628 bool LLParser::ParseIndexList(SmallVectorImpl<unsigned> &Indices,
1629 bool &AteExtraComma) {
1630 AteExtraComma = false;
1632 if (Lex.getKind() != lltok::comma)
1633 return TokError("expected ',' as start of index list");
1635 while (EatIfPresent(lltok::comma)) {
1636 if (Lex.getKind() == lltok::MetadataVar) {
1637 if (Indices.empty()) return TokError("expected index");
1638 AteExtraComma = true;
1642 if (ParseUInt32(Idx)) return true;
1643 Indices.push_back(Idx);
1649 //===----------------------------------------------------------------------===//
1651 //===----------------------------------------------------------------------===//
1653 /// ParseType - Parse a type.
1654 bool LLParser::ParseType(Type *&Result, const Twine &Msg, bool AllowVoid) {
1655 SMLoc TypeLoc = Lex.getLoc();
1656 switch (Lex.getKind()) {
1658 return TokError(Msg);
1660 // Type ::= 'float' | 'void' (etc)
1661 Result = Lex.getTyVal();
1665 // Type ::= StructType
1666 if (ParseAnonStructType(Result, false))
1669 case lltok::lsquare:
1670 // Type ::= '[' ... ']'
1671 Lex.Lex(); // eat the lsquare.
1672 if (ParseArrayVectorType(Result, false))
1675 case lltok::less: // Either vector or packed struct.
1676 // Type ::= '<' ... '>'
1678 if (Lex.getKind() == lltok::lbrace) {
1679 if (ParseAnonStructType(Result, true) ||
1680 ParseToken(lltok::greater, "expected '>' at end of packed struct"))
1682 } else if (ParseArrayVectorType(Result, true))
1685 case lltok::LocalVar: {
1687 std::pair<Type*, LocTy> &Entry = NamedTypes[Lex.getStrVal()];
1689 // If the type hasn't been defined yet, create a forward definition and
1690 // remember where that forward def'n was seen (in case it never is defined).
1692 Entry.first = StructType::create(Context, Lex.getStrVal());
1693 Entry.second = Lex.getLoc();
1695 Result = Entry.first;
1700 case lltok::LocalVarID: {
1702 std::pair<Type*, LocTy> &Entry = NumberedTypes[Lex.getUIntVal()];
1704 // If the type hasn't been defined yet, create a forward definition and
1705 // remember where that forward def'n was seen (in case it never is defined).
1707 Entry.first = StructType::create(Context);
1708 Entry.second = Lex.getLoc();
1710 Result = Entry.first;
1716 // Parse the type suffixes.
1718 switch (Lex.getKind()) {
1721 if (!AllowVoid && Result->isVoidTy())
1722 return Error(TypeLoc, "void type only allowed for function results");
1725 // Type ::= Type '*'
1727 if (Result->isLabelTy())
1728 return TokError("basic block pointers are invalid");
1729 if (Result->isVoidTy())
1730 return TokError("pointers to void are invalid - use i8* instead");
1731 if (!PointerType::isValidElementType(Result))
1732 return TokError("pointer to this type is invalid");
1733 Result = PointerType::getUnqual(Result);
1737 // Type ::= Type 'addrspace' '(' uint32 ')' '*'
1738 case lltok::kw_addrspace: {
1739 if (Result->isLabelTy())
1740 return TokError("basic block pointers are invalid");
1741 if (Result->isVoidTy())
1742 return TokError("pointers to void are invalid; use i8* instead");
1743 if (!PointerType::isValidElementType(Result))
1744 return TokError("pointer to this type is invalid");
1746 if (ParseOptionalAddrSpace(AddrSpace) ||
1747 ParseToken(lltok::star, "expected '*' in address space"))
1750 Result = PointerType::get(Result, AddrSpace);
1754 /// Types '(' ArgTypeListI ')' OptFuncAttrs
1756 if (ParseFunctionType(Result))
1763 /// ParseParameterList
1765 /// ::= '(' Arg (',' Arg)* ')'
1767 /// ::= Type OptionalAttributes Value OptionalAttributes
1768 bool LLParser::ParseParameterList(SmallVectorImpl<ParamInfo> &ArgList,
1769 PerFunctionState &PFS, bool IsMustTailCall,
1770 bool InVarArgsFunc) {
1771 if (ParseToken(lltok::lparen, "expected '(' in call"))
1774 unsigned AttrIndex = 1;
1775 while (Lex.getKind() != lltok::rparen) {
1776 // If this isn't the first argument, we need a comma.
1777 if (!ArgList.empty() &&
1778 ParseToken(lltok::comma, "expected ',' in argument list"))
1781 // Parse an ellipsis if this is a musttail call in a variadic function.
1782 if (Lex.getKind() == lltok::dotdotdot) {
1783 const char *Msg = "unexpected ellipsis in argument list for ";
1784 if (!IsMustTailCall)
1785 return TokError(Twine(Msg) + "non-musttail call");
1787 return TokError(Twine(Msg) + "musttail call in non-varargs function");
1788 Lex.Lex(); // Lex the '...', it is purely for readability.
1789 return ParseToken(lltok::rparen, "expected ')' at end of argument list");
1792 // Parse the argument.
1794 Type *ArgTy = nullptr;
1795 AttrBuilder ArgAttrs;
1797 if (ParseType(ArgTy, ArgLoc))
1800 if (ArgTy->isMetadataTy()) {
1801 if (ParseMetadataAsValue(V, PFS))
1804 // Otherwise, handle normal operands.
1805 if (ParseOptionalParamAttrs(ArgAttrs) || ParseValue(ArgTy, V, PFS))
1808 ArgList.push_back(ParamInfo(ArgLoc, V, AttributeSet::get(V->getContext(),
1813 if (IsMustTailCall && InVarArgsFunc)
1814 return TokError("expected '...' at end of argument list for musttail call "
1815 "in varargs function");
1817 Lex.Lex(); // Lex the ')'.
1823 /// ParseArgumentList - Parse the argument list for a function type or function
1825 /// ::= '(' ArgTypeListI ')'
1829 /// ::= ArgTypeList ',' '...'
1830 /// ::= ArgType (',' ArgType)*
1832 bool LLParser::ParseArgumentList(SmallVectorImpl<ArgInfo> &ArgList,
1835 assert(Lex.getKind() == lltok::lparen);
1836 Lex.Lex(); // eat the (.
1838 if (Lex.getKind() == lltok::rparen) {
1840 } else if (Lex.getKind() == lltok::dotdotdot) {
1844 LocTy TypeLoc = Lex.getLoc();
1845 Type *ArgTy = nullptr;
1849 if (ParseType(ArgTy) ||
1850 ParseOptionalParamAttrs(Attrs)) return true;
1852 if (ArgTy->isVoidTy())
1853 return Error(TypeLoc, "argument can not have void type");
1855 if (Lex.getKind() == lltok::LocalVar) {
1856 Name = Lex.getStrVal();
1860 if (!FunctionType::isValidArgumentType(ArgTy))
1861 return Error(TypeLoc, "invalid type for function argument");
1863 unsigned AttrIndex = 1;
1864 ArgList.push_back(ArgInfo(TypeLoc, ArgTy,
1865 AttributeSet::get(ArgTy->getContext(),
1866 AttrIndex++, Attrs), Name));
1868 while (EatIfPresent(lltok::comma)) {
1869 // Handle ... at end of arg list.
1870 if (EatIfPresent(lltok::dotdotdot)) {
1875 // Otherwise must be an argument type.
1876 TypeLoc = Lex.getLoc();
1877 if (ParseType(ArgTy) || ParseOptionalParamAttrs(Attrs)) return true;
1879 if (ArgTy->isVoidTy())
1880 return Error(TypeLoc, "argument can not have void type");
1882 if (Lex.getKind() == lltok::LocalVar) {
1883 Name = Lex.getStrVal();
1889 if (!ArgTy->isFirstClassType())
1890 return Error(TypeLoc, "invalid type for function argument");
1892 ArgList.push_back(ArgInfo(TypeLoc, ArgTy,
1893 AttributeSet::get(ArgTy->getContext(),
1894 AttrIndex++, Attrs),
1899 return ParseToken(lltok::rparen, "expected ')' at end of argument list");
1902 /// ParseFunctionType
1903 /// ::= Type ArgumentList OptionalAttrs
1904 bool LLParser::ParseFunctionType(Type *&Result) {
1905 assert(Lex.getKind() == lltok::lparen);
1907 if (!FunctionType::isValidReturnType(Result))
1908 return TokError("invalid function return type");
1910 SmallVector<ArgInfo, 8> ArgList;
1912 if (ParseArgumentList(ArgList, isVarArg))
1915 // Reject names on the arguments lists.
1916 for (unsigned i = 0, e = ArgList.size(); i != e; ++i) {
1917 if (!ArgList[i].Name.empty())
1918 return Error(ArgList[i].Loc, "argument name invalid in function type");
1919 if (ArgList[i].Attrs.hasAttributes(i + 1))
1920 return Error(ArgList[i].Loc,
1921 "argument attributes invalid in function type");
1924 SmallVector<Type*, 16> ArgListTy;
1925 for (unsigned i = 0, e = ArgList.size(); i != e; ++i)
1926 ArgListTy.push_back(ArgList[i].Ty);
1928 Result = FunctionType::get(Result, ArgListTy, isVarArg);
1932 /// ParseAnonStructType - Parse an anonymous struct type, which is inlined into
1934 bool LLParser::ParseAnonStructType(Type *&Result, bool Packed) {
1935 SmallVector<Type*, 8> Elts;
1936 if (ParseStructBody(Elts)) return true;
1938 Result = StructType::get(Context, Elts, Packed);
1942 /// ParseStructDefinition - Parse a struct in a 'type' definition.
1943 bool LLParser::ParseStructDefinition(SMLoc TypeLoc, StringRef Name,
1944 std::pair<Type*, LocTy> &Entry,
1946 // If the type was already defined, diagnose the redefinition.
1947 if (Entry.first && !Entry.second.isValid())
1948 return Error(TypeLoc, "redefinition of type");
1950 // If we have opaque, just return without filling in the definition for the
1951 // struct. This counts as a definition as far as the .ll file goes.
1952 if (EatIfPresent(lltok::kw_opaque)) {
1953 // This type is being defined, so clear the location to indicate this.
1954 Entry.second = SMLoc();
1956 // If this type number has never been uttered, create it.
1958 Entry.first = StructType::create(Context, Name);
1959 ResultTy = Entry.first;
1963 // If the type starts with '<', then it is either a packed struct or a vector.
1964 bool isPacked = EatIfPresent(lltok::less);
1966 // If we don't have a struct, then we have a random type alias, which we
1967 // accept for compatibility with old files. These types are not allowed to be
1968 // forward referenced and not allowed to be recursive.
1969 if (Lex.getKind() != lltok::lbrace) {
1971 return Error(TypeLoc, "forward references to non-struct type");
1975 return ParseArrayVectorType(ResultTy, true);
1976 return ParseType(ResultTy);
1979 // This type is being defined, so clear the location to indicate this.
1980 Entry.second = SMLoc();
1982 // If this type number has never been uttered, create it.
1984 Entry.first = StructType::create(Context, Name);
1986 StructType *STy = cast<StructType>(Entry.first);
1988 SmallVector<Type*, 8> Body;
1989 if (ParseStructBody(Body) ||
1990 (isPacked && ParseToken(lltok::greater, "expected '>' in packed struct")))
1993 STy->setBody(Body, isPacked);
1999 /// ParseStructType: Handles packed and unpacked types. </> parsed elsewhere.
2002 /// ::= '{' Type (',' Type)* '}'
2003 /// ::= '<' '{' '}' '>'
2004 /// ::= '<' '{' Type (',' Type)* '}' '>'
2005 bool LLParser::ParseStructBody(SmallVectorImpl<Type*> &Body) {
2006 assert(Lex.getKind() == lltok::lbrace);
2007 Lex.Lex(); // Consume the '{'
2009 // Handle the empty struct.
2010 if (EatIfPresent(lltok::rbrace))
2013 LocTy EltTyLoc = Lex.getLoc();
2015 if (ParseType(Ty)) return true;
2018 if (!StructType::isValidElementType(Ty))
2019 return Error(EltTyLoc, "invalid element type for struct");
2021 while (EatIfPresent(lltok::comma)) {
2022 EltTyLoc = Lex.getLoc();
2023 if (ParseType(Ty)) return true;
2025 if (!StructType::isValidElementType(Ty))
2026 return Error(EltTyLoc, "invalid element type for struct");
2031 return ParseToken(lltok::rbrace, "expected '}' at end of struct");
2034 /// ParseArrayVectorType - Parse an array or vector type, assuming the first
2035 /// token has already been consumed.
2037 /// ::= '[' APSINTVAL 'x' Types ']'
2038 /// ::= '<' APSINTVAL 'x' Types '>'
2039 bool LLParser::ParseArrayVectorType(Type *&Result, bool isVector) {
2040 if (Lex.getKind() != lltok::APSInt || Lex.getAPSIntVal().isSigned() ||
2041 Lex.getAPSIntVal().getBitWidth() > 64)
2042 return TokError("expected number in address space");
2044 LocTy SizeLoc = Lex.getLoc();
2045 uint64_t Size = Lex.getAPSIntVal().getZExtValue();
2048 if (ParseToken(lltok::kw_x, "expected 'x' after element count"))
2051 LocTy TypeLoc = Lex.getLoc();
2052 Type *EltTy = nullptr;
2053 if (ParseType(EltTy)) return true;
2055 if (ParseToken(isVector ? lltok::greater : lltok::rsquare,
2056 "expected end of sequential type"))
2061 return Error(SizeLoc, "zero element vector is illegal");
2062 if ((unsigned)Size != Size)
2063 return Error(SizeLoc, "size too large for vector");
2064 if (!VectorType::isValidElementType(EltTy))
2065 return Error(TypeLoc, "invalid vector element type");
2066 Result = VectorType::get(EltTy, unsigned(Size));
2068 if (!ArrayType::isValidElementType(EltTy))
2069 return Error(TypeLoc, "invalid array element type");
2070 Result = ArrayType::get(EltTy, Size);
2075 //===----------------------------------------------------------------------===//
2076 // Function Semantic Analysis.
2077 //===----------------------------------------------------------------------===//
2079 LLParser::PerFunctionState::PerFunctionState(LLParser &p, Function &f,
2081 : P(p), F(f), FunctionNumber(functionNumber) {
2083 // Insert unnamed arguments into the NumberedVals list.
2084 for (Function::arg_iterator AI = F.arg_begin(), E = F.arg_end();
2087 NumberedVals.push_back(AI);
2090 LLParser::PerFunctionState::~PerFunctionState() {
2091 // If there were any forward referenced non-basicblock values, delete them.
2092 for (std::map<std::string, std::pair<Value*, LocTy> >::iterator
2093 I = ForwardRefVals.begin(), E = ForwardRefVals.end(); I != E; ++I)
2094 if (!isa<BasicBlock>(I->second.first)) {
2095 I->second.first->replaceAllUsesWith(
2096 UndefValue::get(I->second.first->getType()));
2097 delete I->second.first;
2098 I->second.first = nullptr;
2101 for (std::map<unsigned, std::pair<Value*, LocTy> >::iterator
2102 I = ForwardRefValIDs.begin(), E = ForwardRefValIDs.end(); I != E; ++I)
2103 if (!isa<BasicBlock>(I->second.first)) {
2104 I->second.first->replaceAllUsesWith(
2105 UndefValue::get(I->second.first->getType()));
2106 delete I->second.first;
2107 I->second.first = nullptr;
2111 bool LLParser::PerFunctionState::FinishFunction() {
2112 if (!ForwardRefVals.empty())
2113 return P.Error(ForwardRefVals.begin()->second.second,
2114 "use of undefined value '%" + ForwardRefVals.begin()->first +
2116 if (!ForwardRefValIDs.empty())
2117 return P.Error(ForwardRefValIDs.begin()->second.second,
2118 "use of undefined value '%" +
2119 Twine(ForwardRefValIDs.begin()->first) + "'");
2124 /// GetVal - Get a value with the specified name or ID, creating a
2125 /// forward reference record if needed. This can return null if the value
2126 /// exists but does not have the right type.
2127 Value *LLParser::PerFunctionState::GetVal(const std::string &Name,
2128 Type *Ty, LocTy Loc) {
2129 // Look this name up in the normal function symbol table.
2130 Value *Val = F.getValueSymbolTable().lookup(Name);
2132 // If this is a forward reference for the value, see if we already created a
2133 // forward ref record.
2135 std::map<std::string, std::pair<Value*, LocTy> >::iterator
2136 I = ForwardRefVals.find(Name);
2137 if (I != ForwardRefVals.end())
2138 Val = I->second.first;
2141 // If we have the value in the symbol table or fwd-ref table, return it.
2143 if (Val->getType() == Ty) return Val;
2144 if (Ty->isLabelTy())
2145 P.Error(Loc, "'%" + Name + "' is not a basic block");
2147 P.Error(Loc, "'%" + Name + "' defined with type '" +
2148 getTypeString(Val->getType()) + "'");
2152 // Don't make placeholders with invalid type.
2153 if (!Ty->isFirstClassType()) {
2154 P.Error(Loc, "invalid use of a non-first-class type");
2158 // Otherwise, create a new forward reference for this value and remember it.
2160 if (Ty->isLabelTy())
2161 FwdVal = BasicBlock::Create(F.getContext(), Name, &F);
2163 FwdVal = new Argument(Ty, Name);
2165 ForwardRefVals[Name] = std::make_pair(FwdVal, Loc);
2169 Value *LLParser::PerFunctionState::GetVal(unsigned ID, Type *Ty,
2171 // Look this name up in the normal function symbol table.
2172 Value *Val = ID < NumberedVals.size() ? NumberedVals[ID] : nullptr;
2174 // If this is a forward reference for the value, see if we already created a
2175 // forward ref record.
2177 std::map<unsigned, std::pair<Value*, LocTy> >::iterator
2178 I = ForwardRefValIDs.find(ID);
2179 if (I != ForwardRefValIDs.end())
2180 Val = I->second.first;
2183 // If we have the value in the symbol table or fwd-ref table, return it.
2185 if (Val->getType() == Ty) return Val;
2186 if (Ty->isLabelTy())
2187 P.Error(Loc, "'%" + Twine(ID) + "' is not a basic block");
2189 P.Error(Loc, "'%" + Twine(ID) + "' defined with type '" +
2190 getTypeString(Val->getType()) + "'");
2194 if (!Ty->isFirstClassType()) {
2195 P.Error(Loc, "invalid use of a non-first-class type");
2199 // Otherwise, create a new forward reference for this value and remember it.
2201 if (Ty->isLabelTy())
2202 FwdVal = BasicBlock::Create(F.getContext(), "", &F);
2204 FwdVal = new Argument(Ty);
2206 ForwardRefValIDs[ID] = std::make_pair(FwdVal, Loc);
2210 /// SetInstName - After an instruction is parsed and inserted into its
2211 /// basic block, this installs its name.
2212 bool LLParser::PerFunctionState::SetInstName(int NameID,
2213 const std::string &NameStr,
2214 LocTy NameLoc, Instruction *Inst) {
2215 // If this instruction has void type, it cannot have a name or ID specified.
2216 if (Inst->getType()->isVoidTy()) {
2217 if (NameID != -1 || !NameStr.empty())
2218 return P.Error(NameLoc, "instructions returning void cannot have a name");
2222 // If this was a numbered instruction, verify that the instruction is the
2223 // expected value and resolve any forward references.
2224 if (NameStr.empty()) {
2225 // If neither a name nor an ID was specified, just use the next ID.
2227 NameID = NumberedVals.size();
2229 if (unsigned(NameID) != NumberedVals.size())
2230 return P.Error(NameLoc, "instruction expected to be numbered '%" +
2231 Twine(NumberedVals.size()) + "'");
2233 std::map<unsigned, std::pair<Value*, LocTy> >::iterator FI =
2234 ForwardRefValIDs.find(NameID);
2235 if (FI != ForwardRefValIDs.end()) {
2236 if (FI->second.first->getType() != Inst->getType())
2237 return P.Error(NameLoc, "instruction forward referenced with type '" +
2238 getTypeString(FI->second.first->getType()) + "'");
2239 FI->second.first->replaceAllUsesWith(Inst);
2240 delete FI->second.first;
2241 ForwardRefValIDs.erase(FI);
2244 NumberedVals.push_back(Inst);
2248 // Otherwise, the instruction had a name. Resolve forward refs and set it.
2249 std::map<std::string, std::pair<Value*, LocTy> >::iterator
2250 FI = ForwardRefVals.find(NameStr);
2251 if (FI != ForwardRefVals.end()) {
2252 if (FI->second.first->getType() != Inst->getType())
2253 return P.Error(NameLoc, "instruction forward referenced with type '" +
2254 getTypeString(FI->second.first->getType()) + "'");
2255 FI->second.first->replaceAllUsesWith(Inst);
2256 delete FI->second.first;
2257 ForwardRefVals.erase(FI);
2260 // Set the name on the instruction.
2261 Inst->setName(NameStr);
2263 if (Inst->getName() != NameStr)
2264 return P.Error(NameLoc, "multiple definition of local value named '" +
2269 /// GetBB - Get a basic block with the specified name or ID, creating a
2270 /// forward reference record if needed.
2271 BasicBlock *LLParser::PerFunctionState::GetBB(const std::string &Name,
2273 return dyn_cast_or_null<BasicBlock>(GetVal(Name,
2274 Type::getLabelTy(F.getContext()), Loc));
2277 BasicBlock *LLParser::PerFunctionState::GetBB(unsigned ID, LocTy Loc) {
2278 return dyn_cast_or_null<BasicBlock>(GetVal(ID,
2279 Type::getLabelTy(F.getContext()), Loc));
2282 /// DefineBB - Define the specified basic block, which is either named or
2283 /// unnamed. If there is an error, this returns null otherwise it returns
2284 /// the block being defined.
2285 BasicBlock *LLParser::PerFunctionState::DefineBB(const std::string &Name,
2289 BB = GetBB(NumberedVals.size(), Loc);
2291 BB = GetBB(Name, Loc);
2292 if (!BB) return nullptr; // Already diagnosed error.
2294 // Move the block to the end of the function. Forward ref'd blocks are
2295 // inserted wherever they happen to be referenced.
2296 F.getBasicBlockList().splice(F.end(), F.getBasicBlockList(), BB);
2298 // Remove the block from forward ref sets.
2300 ForwardRefValIDs.erase(NumberedVals.size());
2301 NumberedVals.push_back(BB);
2303 // BB forward references are already in the function symbol table.
2304 ForwardRefVals.erase(Name);
2310 //===----------------------------------------------------------------------===//
2312 //===----------------------------------------------------------------------===//
2314 /// ParseValID - Parse an abstract value that doesn't necessarily have a
2315 /// type implied. For example, if we parse "4" we don't know what integer type
2316 /// it has. The value will later be combined with its type and checked for
2317 /// sanity. PFS is used to convert function-local operands of metadata (since
2318 /// metadata operands are not just parsed here but also converted to values).
2319 /// PFS can be null when we are not parsing metadata values inside a function.
2320 bool LLParser::ParseValID(ValID &ID, PerFunctionState *PFS) {
2321 ID.Loc = Lex.getLoc();
2322 switch (Lex.getKind()) {
2323 default: return TokError("expected value token");
2324 case lltok::GlobalID: // @42
2325 ID.UIntVal = Lex.getUIntVal();
2326 ID.Kind = ValID::t_GlobalID;
2328 case lltok::GlobalVar: // @foo
2329 ID.StrVal = Lex.getStrVal();
2330 ID.Kind = ValID::t_GlobalName;
2332 case lltok::LocalVarID: // %42
2333 ID.UIntVal = Lex.getUIntVal();
2334 ID.Kind = ValID::t_LocalID;
2336 case lltok::LocalVar: // %foo
2337 ID.StrVal = Lex.getStrVal();
2338 ID.Kind = ValID::t_LocalName;
2341 ID.APSIntVal = Lex.getAPSIntVal();
2342 ID.Kind = ValID::t_APSInt;
2344 case lltok::APFloat:
2345 ID.APFloatVal = Lex.getAPFloatVal();
2346 ID.Kind = ValID::t_APFloat;
2348 case lltok::kw_true:
2349 ID.ConstantVal = ConstantInt::getTrue(Context);
2350 ID.Kind = ValID::t_Constant;
2352 case lltok::kw_false:
2353 ID.ConstantVal = ConstantInt::getFalse(Context);
2354 ID.Kind = ValID::t_Constant;
2356 case lltok::kw_null: ID.Kind = ValID::t_Null; break;
2357 case lltok::kw_undef: ID.Kind = ValID::t_Undef; break;
2358 case lltok::kw_zeroinitializer: ID.Kind = ValID::t_Zero; break;
2360 case lltok::lbrace: {
2361 // ValID ::= '{' ConstVector '}'
2363 SmallVector<Constant*, 16> Elts;
2364 if (ParseGlobalValueVector(Elts) ||
2365 ParseToken(lltok::rbrace, "expected end of struct constant"))
2368 ID.ConstantStructElts = new Constant*[Elts.size()];
2369 ID.UIntVal = Elts.size();
2370 memcpy(ID.ConstantStructElts, Elts.data(), Elts.size()*sizeof(Elts[0]));
2371 ID.Kind = ValID::t_ConstantStruct;
2375 // ValID ::= '<' ConstVector '>' --> Vector.
2376 // ValID ::= '<' '{' ConstVector '}' '>' --> Packed Struct.
2378 bool isPackedStruct = EatIfPresent(lltok::lbrace);
2380 SmallVector<Constant*, 16> Elts;
2381 LocTy FirstEltLoc = Lex.getLoc();
2382 if (ParseGlobalValueVector(Elts) ||
2384 ParseToken(lltok::rbrace, "expected end of packed struct")) ||
2385 ParseToken(lltok::greater, "expected end of constant"))
2388 if (isPackedStruct) {
2389 ID.ConstantStructElts = new Constant*[Elts.size()];
2390 memcpy(ID.ConstantStructElts, Elts.data(), Elts.size()*sizeof(Elts[0]));
2391 ID.UIntVal = Elts.size();
2392 ID.Kind = ValID::t_PackedConstantStruct;
2397 return Error(ID.Loc, "constant vector must not be empty");
2399 if (!Elts[0]->getType()->isIntegerTy() &&
2400 !Elts[0]->getType()->isFloatingPointTy() &&
2401 !Elts[0]->getType()->isPointerTy())
2402 return Error(FirstEltLoc,
2403 "vector elements must have integer, pointer or floating point type");
2405 // Verify that all the vector elements have the same type.
2406 for (unsigned i = 1, e = Elts.size(); i != e; ++i)
2407 if (Elts[i]->getType() != Elts[0]->getType())
2408 return Error(FirstEltLoc,
2409 "vector element #" + Twine(i) +
2410 " is not of type '" + getTypeString(Elts[0]->getType()));
2412 ID.ConstantVal = ConstantVector::get(Elts);
2413 ID.Kind = ValID::t_Constant;
2416 case lltok::lsquare: { // Array Constant
2418 SmallVector<Constant*, 16> Elts;
2419 LocTy FirstEltLoc = Lex.getLoc();
2420 if (ParseGlobalValueVector(Elts) ||
2421 ParseToken(lltok::rsquare, "expected end of array constant"))
2424 // Handle empty element.
2426 // Use undef instead of an array because it's inconvenient to determine
2427 // the element type at this point, there being no elements to examine.
2428 ID.Kind = ValID::t_EmptyArray;
2432 if (!Elts[0]->getType()->isFirstClassType())
2433 return Error(FirstEltLoc, "invalid array element type: " +
2434 getTypeString(Elts[0]->getType()));
2436 ArrayType *ATy = ArrayType::get(Elts[0]->getType(), Elts.size());
2438 // Verify all elements are correct type!
2439 for (unsigned i = 0, e = Elts.size(); i != e; ++i) {
2440 if (Elts[i]->getType() != Elts[0]->getType())
2441 return Error(FirstEltLoc,
2442 "array element #" + Twine(i) +
2443 " is not of type '" + getTypeString(Elts[0]->getType()));
2446 ID.ConstantVal = ConstantArray::get(ATy, Elts);
2447 ID.Kind = ValID::t_Constant;
2450 case lltok::kw_c: // c "foo"
2452 ID.ConstantVal = ConstantDataArray::getString(Context, Lex.getStrVal(),
2454 if (ParseToken(lltok::StringConstant, "expected string")) return true;
2455 ID.Kind = ValID::t_Constant;
2458 case lltok::kw_asm: {
2459 // ValID ::= 'asm' SideEffect? AlignStack? IntelDialect? STRINGCONSTANT ','
2461 bool HasSideEffect, AlignStack, AsmDialect;
2463 if (ParseOptionalToken(lltok::kw_sideeffect, HasSideEffect) ||
2464 ParseOptionalToken(lltok::kw_alignstack, AlignStack) ||
2465 ParseOptionalToken(lltok::kw_inteldialect, AsmDialect) ||
2466 ParseStringConstant(ID.StrVal) ||
2467 ParseToken(lltok::comma, "expected comma in inline asm expression") ||
2468 ParseToken(lltok::StringConstant, "expected constraint string"))
2470 ID.StrVal2 = Lex.getStrVal();
2471 ID.UIntVal = unsigned(HasSideEffect) | (unsigned(AlignStack)<<1) |
2472 (unsigned(AsmDialect)<<2);
2473 ID.Kind = ValID::t_InlineAsm;
2477 case lltok::kw_blockaddress: {
2478 // ValID ::= 'blockaddress' '(' @foo ',' %bar ')'
2483 if (ParseToken(lltok::lparen, "expected '(' in block address expression") ||
2485 ParseToken(lltok::comma, "expected comma in block address expression")||
2486 ParseValID(Label) ||
2487 ParseToken(lltok::rparen, "expected ')' in block address expression"))
2490 if (Fn.Kind != ValID::t_GlobalID && Fn.Kind != ValID::t_GlobalName)
2491 return Error(Fn.Loc, "expected function name in blockaddress");
2492 if (Label.Kind != ValID::t_LocalID && Label.Kind != ValID::t_LocalName)
2493 return Error(Label.Loc, "expected basic block name in blockaddress");
2495 // Try to find the function (but skip it if it's forward-referenced).
2496 GlobalValue *GV = nullptr;
2497 if (Fn.Kind == ValID::t_GlobalID) {
2498 if (Fn.UIntVal < NumberedVals.size())
2499 GV = NumberedVals[Fn.UIntVal];
2500 } else if (!ForwardRefVals.count(Fn.StrVal)) {
2501 GV = M->getNamedValue(Fn.StrVal);
2503 Function *F = nullptr;
2505 // Confirm that it's actually a function with a definition.
2506 if (!isa<Function>(GV))
2507 return Error(Fn.Loc, "expected function name in blockaddress");
2508 F = cast<Function>(GV);
2509 if (F->isDeclaration())
2510 return Error(Fn.Loc, "cannot take blockaddress inside a declaration");
2514 // Make a global variable as a placeholder for this reference.
2515 GlobalValue *&FwdRef =
2516 ForwardRefBlockAddresses.insert(std::make_pair(
2518 std::map<ValID, GlobalValue *>()))
2519 .first->second.insert(std::make_pair(std::move(Label), nullptr))
2522 FwdRef = new GlobalVariable(*M, Type::getInt8Ty(Context), false,
2523 GlobalValue::InternalLinkage, nullptr, "");
2524 ID.ConstantVal = FwdRef;
2525 ID.Kind = ValID::t_Constant;
2529 // We found the function; now find the basic block. Don't use PFS, since we
2530 // might be inside a constant expression.
2532 if (BlockAddressPFS && F == &BlockAddressPFS->getFunction()) {
2533 if (Label.Kind == ValID::t_LocalID)
2534 BB = BlockAddressPFS->GetBB(Label.UIntVal, Label.Loc);
2536 BB = BlockAddressPFS->GetBB(Label.StrVal, Label.Loc);
2538 return Error(Label.Loc, "referenced value is not a basic block");
2540 if (Label.Kind == ValID::t_LocalID)
2541 return Error(Label.Loc, "cannot take address of numeric label after "
2542 "the function is defined");
2543 BB = dyn_cast_or_null<BasicBlock>(
2544 F->getValueSymbolTable().lookup(Label.StrVal));
2546 return Error(Label.Loc, "referenced value is not a basic block");
2549 ID.ConstantVal = BlockAddress::get(F, BB);
2550 ID.Kind = ValID::t_Constant;
2554 case lltok::kw_trunc:
2555 case lltok::kw_zext:
2556 case lltok::kw_sext:
2557 case lltok::kw_fptrunc:
2558 case lltok::kw_fpext:
2559 case lltok::kw_bitcast:
2560 case lltok::kw_addrspacecast:
2561 case lltok::kw_uitofp:
2562 case lltok::kw_sitofp:
2563 case lltok::kw_fptoui:
2564 case lltok::kw_fptosi:
2565 case lltok::kw_inttoptr:
2566 case lltok::kw_ptrtoint: {
2567 unsigned Opc = Lex.getUIntVal();
2568 Type *DestTy = nullptr;
2571 if (ParseToken(lltok::lparen, "expected '(' after constantexpr cast") ||
2572 ParseGlobalTypeAndValue(SrcVal) ||
2573 ParseToken(lltok::kw_to, "expected 'to' in constantexpr cast") ||
2574 ParseType(DestTy) ||
2575 ParseToken(lltok::rparen, "expected ')' at end of constantexpr cast"))
2577 if (!CastInst::castIsValid((Instruction::CastOps)Opc, SrcVal, DestTy))
2578 return Error(ID.Loc, "invalid cast opcode for cast from '" +
2579 getTypeString(SrcVal->getType()) + "' to '" +
2580 getTypeString(DestTy) + "'");
2581 ID.ConstantVal = ConstantExpr::getCast((Instruction::CastOps)Opc,
2583 ID.Kind = ValID::t_Constant;
2586 case lltok::kw_extractvalue: {
2589 SmallVector<unsigned, 4> Indices;
2590 if (ParseToken(lltok::lparen, "expected '(' in extractvalue constantexpr")||
2591 ParseGlobalTypeAndValue(Val) ||
2592 ParseIndexList(Indices) ||
2593 ParseToken(lltok::rparen, "expected ')' in extractvalue constantexpr"))
2596 if (!Val->getType()->isAggregateType())
2597 return Error(ID.Loc, "extractvalue operand must be aggregate type");
2598 if (!ExtractValueInst::getIndexedType(Val->getType(), Indices))
2599 return Error(ID.Loc, "invalid indices for extractvalue");
2600 ID.ConstantVal = ConstantExpr::getExtractValue(Val, Indices);
2601 ID.Kind = ValID::t_Constant;
2604 case lltok::kw_insertvalue: {
2606 Constant *Val0, *Val1;
2607 SmallVector<unsigned, 4> Indices;
2608 if (ParseToken(lltok::lparen, "expected '(' in insertvalue constantexpr")||
2609 ParseGlobalTypeAndValue(Val0) ||
2610 ParseToken(lltok::comma, "expected comma in insertvalue constantexpr")||
2611 ParseGlobalTypeAndValue(Val1) ||
2612 ParseIndexList(Indices) ||
2613 ParseToken(lltok::rparen, "expected ')' in insertvalue constantexpr"))
2615 if (!Val0->getType()->isAggregateType())
2616 return Error(ID.Loc, "insertvalue operand must be aggregate type");
2618 ExtractValueInst::getIndexedType(Val0->getType(), Indices);
2620 return Error(ID.Loc, "invalid indices for insertvalue");
2621 if (IndexedType != Val1->getType())
2622 return Error(ID.Loc, "insertvalue operand and field disagree in type: '" +
2623 getTypeString(Val1->getType()) +
2624 "' instead of '" + getTypeString(IndexedType) +
2626 ID.ConstantVal = ConstantExpr::getInsertValue(Val0, Val1, Indices);
2627 ID.Kind = ValID::t_Constant;
2630 case lltok::kw_icmp:
2631 case lltok::kw_fcmp: {
2632 unsigned PredVal, Opc = Lex.getUIntVal();
2633 Constant *Val0, *Val1;
2635 if (ParseCmpPredicate(PredVal, Opc) ||
2636 ParseToken(lltok::lparen, "expected '(' in compare constantexpr") ||
2637 ParseGlobalTypeAndValue(Val0) ||
2638 ParseToken(lltok::comma, "expected comma in compare constantexpr") ||
2639 ParseGlobalTypeAndValue(Val1) ||
2640 ParseToken(lltok::rparen, "expected ')' in compare constantexpr"))
2643 if (Val0->getType() != Val1->getType())
2644 return Error(ID.Loc, "compare operands must have the same type");
2646 CmpInst::Predicate Pred = (CmpInst::Predicate)PredVal;
2648 if (Opc == Instruction::FCmp) {
2649 if (!Val0->getType()->isFPOrFPVectorTy())
2650 return Error(ID.Loc, "fcmp requires floating point operands");
2651 ID.ConstantVal = ConstantExpr::getFCmp(Pred, Val0, Val1);
2653 assert(Opc == Instruction::ICmp && "Unexpected opcode for CmpInst!");
2654 if (!Val0->getType()->isIntOrIntVectorTy() &&
2655 !Val0->getType()->getScalarType()->isPointerTy())
2656 return Error(ID.Loc, "icmp requires pointer or integer operands");
2657 ID.ConstantVal = ConstantExpr::getICmp(Pred, Val0, Val1);
2659 ID.Kind = ValID::t_Constant;
2663 // Binary Operators.
2665 case lltok::kw_fadd:
2667 case lltok::kw_fsub:
2669 case lltok::kw_fmul:
2670 case lltok::kw_udiv:
2671 case lltok::kw_sdiv:
2672 case lltok::kw_fdiv:
2673 case lltok::kw_urem:
2674 case lltok::kw_srem:
2675 case lltok::kw_frem:
2677 case lltok::kw_lshr:
2678 case lltok::kw_ashr: {
2682 unsigned Opc = Lex.getUIntVal();
2683 Constant *Val0, *Val1;
2685 LocTy ModifierLoc = Lex.getLoc();
2686 if (Opc == Instruction::Add || Opc == Instruction::Sub ||
2687 Opc == Instruction::Mul || Opc == Instruction::Shl) {
2688 if (EatIfPresent(lltok::kw_nuw))
2690 if (EatIfPresent(lltok::kw_nsw)) {
2692 if (EatIfPresent(lltok::kw_nuw))
2695 } else if (Opc == Instruction::SDiv || Opc == Instruction::UDiv ||
2696 Opc == Instruction::LShr || Opc == Instruction::AShr) {
2697 if (EatIfPresent(lltok::kw_exact))
2700 if (ParseToken(lltok::lparen, "expected '(' in binary constantexpr") ||
2701 ParseGlobalTypeAndValue(Val0) ||
2702 ParseToken(lltok::comma, "expected comma in binary constantexpr") ||
2703 ParseGlobalTypeAndValue(Val1) ||
2704 ParseToken(lltok::rparen, "expected ')' in binary constantexpr"))
2706 if (Val0->getType() != Val1->getType())
2707 return Error(ID.Loc, "operands of constexpr must have same type");
2708 if (!Val0->getType()->isIntOrIntVectorTy()) {
2710 return Error(ModifierLoc, "nuw only applies to integer operations");
2712 return Error(ModifierLoc, "nsw only applies to integer operations");
2714 // Check that the type is valid for the operator.
2716 case Instruction::Add:
2717 case Instruction::Sub:
2718 case Instruction::Mul:
2719 case Instruction::UDiv:
2720 case Instruction::SDiv:
2721 case Instruction::URem:
2722 case Instruction::SRem:
2723 case Instruction::Shl:
2724 case Instruction::AShr:
2725 case Instruction::LShr:
2726 if (!Val0->getType()->isIntOrIntVectorTy())
2727 return Error(ID.Loc, "constexpr requires integer operands");
2729 case Instruction::FAdd:
2730 case Instruction::FSub:
2731 case Instruction::FMul:
2732 case Instruction::FDiv:
2733 case Instruction::FRem:
2734 if (!Val0->getType()->isFPOrFPVectorTy())
2735 return Error(ID.Loc, "constexpr requires fp operands");
2737 default: llvm_unreachable("Unknown binary operator!");
2740 if (NUW) Flags |= OverflowingBinaryOperator::NoUnsignedWrap;
2741 if (NSW) Flags |= OverflowingBinaryOperator::NoSignedWrap;
2742 if (Exact) Flags |= PossiblyExactOperator::IsExact;
2743 Constant *C = ConstantExpr::get(Opc, Val0, Val1, Flags);
2745 ID.Kind = ValID::t_Constant;
2749 // Logical Operations
2752 case lltok::kw_xor: {
2753 unsigned Opc = Lex.getUIntVal();
2754 Constant *Val0, *Val1;
2756 if (ParseToken(lltok::lparen, "expected '(' in logical constantexpr") ||
2757 ParseGlobalTypeAndValue(Val0) ||
2758 ParseToken(lltok::comma, "expected comma in logical constantexpr") ||
2759 ParseGlobalTypeAndValue(Val1) ||
2760 ParseToken(lltok::rparen, "expected ')' in logical constantexpr"))
2762 if (Val0->getType() != Val1->getType())
2763 return Error(ID.Loc, "operands of constexpr must have same type");
2764 if (!Val0->getType()->isIntOrIntVectorTy())
2765 return Error(ID.Loc,
2766 "constexpr requires integer or integer vector operands");
2767 ID.ConstantVal = ConstantExpr::get(Opc, Val0, Val1);
2768 ID.Kind = ValID::t_Constant;
2772 case lltok::kw_getelementptr:
2773 case lltok::kw_shufflevector:
2774 case lltok::kw_insertelement:
2775 case lltok::kw_extractelement:
2776 case lltok::kw_select: {
2777 unsigned Opc = Lex.getUIntVal();
2778 SmallVector<Constant*, 16> Elts;
2779 bool InBounds = false;
2783 if (Opc == Instruction::GetElementPtr)
2784 InBounds = EatIfPresent(lltok::kw_inbounds);
2786 if (ParseToken(lltok::lparen, "expected '(' in constantexpr"))
2789 LocTy ExplicitTypeLoc = Lex.getLoc();
2790 if (Opc == Instruction::GetElementPtr) {
2791 if (ParseType(Ty) ||
2792 ParseToken(lltok::comma, "expected comma after getelementptr's type"))
2796 if (ParseGlobalValueVector(Elts) ||
2797 ParseToken(lltok::rparen, "expected ')' in constantexpr"))
2800 if (Opc == Instruction::GetElementPtr) {
2801 if (Elts.size() == 0 ||
2802 !Elts[0]->getType()->getScalarType()->isPointerTy())
2803 return Error(ID.Loc, "base of getelementptr must be a pointer");
2805 Type *BaseType = Elts[0]->getType();
2806 auto *BasePointerType = cast<PointerType>(BaseType->getScalarType());
2807 if (Ty != BasePointerType->getElementType())
2810 "explicit pointee type doesn't match operand's pointee type");
2812 ArrayRef<Constant *> Indices(Elts.begin() + 1, Elts.end());
2813 for (Constant *Val : Indices) {
2814 Type *ValTy = Val->getType();
2815 if (!ValTy->getScalarType()->isIntegerTy())
2816 return Error(ID.Loc, "getelementptr index must be an integer");
2817 if (ValTy->isVectorTy() != BaseType->isVectorTy())
2818 return Error(ID.Loc, "getelementptr index type missmatch");
2819 if (ValTy->isVectorTy()) {
2820 unsigned ValNumEl = cast<VectorType>(ValTy)->getNumElements();
2821 unsigned PtrNumEl = cast<VectorType>(BaseType)->getNumElements();
2822 if (ValNumEl != PtrNumEl)
2825 "getelementptr vector index has a wrong number of elements");
2829 SmallPtrSet<const Type*, 4> Visited;
2830 if (!Indices.empty() &&
2831 !BasePointerType->getElementType()->isSized(&Visited))
2832 return Error(ID.Loc, "base element of getelementptr must be sized");
2834 if (!GetElementPtrInst::getIndexedType(
2835 cast<PointerType>(Elts[0]->getType()->getScalarType())
2838 return Error(ID.Loc, "invalid getelementptr indices");
2839 ID.ConstantVal = ConstantExpr::getGetElementPtr(Elts[0], Indices,
2841 } else if (Opc == Instruction::Select) {
2842 if (Elts.size() != 3)
2843 return Error(ID.Loc, "expected three operands to select");
2844 if (const char *Reason = SelectInst::areInvalidOperands(Elts[0], Elts[1],
2846 return Error(ID.Loc, Reason);
2847 ID.ConstantVal = ConstantExpr::getSelect(Elts[0], Elts[1], Elts[2]);
2848 } else if (Opc == Instruction::ShuffleVector) {
2849 if (Elts.size() != 3)
2850 return Error(ID.Loc, "expected three operands to shufflevector");
2851 if (!ShuffleVectorInst::isValidOperands(Elts[0], Elts[1], Elts[2]))
2852 return Error(ID.Loc, "invalid operands to shufflevector");
2854 ConstantExpr::getShuffleVector(Elts[0], Elts[1],Elts[2]);
2855 } else if (Opc == Instruction::ExtractElement) {
2856 if (Elts.size() != 2)
2857 return Error(ID.Loc, "expected two operands to extractelement");
2858 if (!ExtractElementInst::isValidOperands(Elts[0], Elts[1]))
2859 return Error(ID.Loc, "invalid extractelement operands");
2860 ID.ConstantVal = ConstantExpr::getExtractElement(Elts[0], Elts[1]);
2862 assert(Opc == Instruction::InsertElement && "Unknown opcode");
2863 if (Elts.size() != 3)
2864 return Error(ID.Loc, "expected three operands to insertelement");
2865 if (!InsertElementInst::isValidOperands(Elts[0], Elts[1], Elts[2]))
2866 return Error(ID.Loc, "invalid insertelement operands");
2868 ConstantExpr::getInsertElement(Elts[0], Elts[1],Elts[2]);
2871 ID.Kind = ValID::t_Constant;
2880 /// ParseGlobalValue - Parse a global value with the specified type.
2881 bool LLParser::ParseGlobalValue(Type *Ty, Constant *&C) {
2885 bool Parsed = ParseValID(ID) ||
2886 ConvertValIDToValue(Ty, ID, V, nullptr);
2887 if (V && !(C = dyn_cast<Constant>(V)))
2888 return Error(ID.Loc, "global values must be constants");
2892 bool LLParser::ParseGlobalTypeAndValue(Constant *&V) {
2894 return ParseType(Ty) ||
2895 ParseGlobalValue(Ty, V);
2898 bool LLParser::parseOptionalComdat(StringRef GlobalName, Comdat *&C) {
2901 LocTy KwLoc = Lex.getLoc();
2902 if (!EatIfPresent(lltok::kw_comdat))
2905 if (EatIfPresent(lltok::lparen)) {
2906 if (Lex.getKind() != lltok::ComdatVar)
2907 return TokError("expected comdat variable");
2908 C = getComdat(Lex.getStrVal(), Lex.getLoc());
2910 if (ParseToken(lltok::rparen, "expected ')' after comdat var"))
2913 if (GlobalName.empty())
2914 return TokError("comdat cannot be unnamed");
2915 C = getComdat(GlobalName, KwLoc);
2921 /// ParseGlobalValueVector
2923 /// ::= TypeAndValue (',' TypeAndValue)*
2924 bool LLParser::ParseGlobalValueVector(SmallVectorImpl<Constant *> &Elts) {
2926 if (Lex.getKind() == lltok::rbrace ||
2927 Lex.getKind() == lltok::rsquare ||
2928 Lex.getKind() == lltok::greater ||
2929 Lex.getKind() == lltok::rparen)
2933 if (ParseGlobalTypeAndValue(C)) return true;
2936 while (EatIfPresent(lltok::comma)) {
2937 if (ParseGlobalTypeAndValue(C)) return true;
2944 bool LLParser::ParseMDTuple(MDNode *&MD, bool IsDistinct) {
2945 SmallVector<Metadata *, 16> Elts;
2946 if (ParseMDNodeVector(Elts))
2949 MD = (IsDistinct ? MDTuple::getDistinct : MDTuple::get)(Context, Elts);
2956 /// ::= !MDLocation(...)
2957 bool LLParser::ParseMDNode(MDNode *&N) {
2958 if (Lex.getKind() == lltok::MetadataVar)
2959 return ParseSpecializedMDNode(N);
2961 return ParseToken(lltok::exclaim, "expected '!' here") ||
2965 bool LLParser::ParseMDNodeTail(MDNode *&N) {
2967 if (Lex.getKind() == lltok::lbrace)
2968 return ParseMDTuple(N);
2971 return ParseMDNodeID(N);
2976 /// Structure to represent an optional metadata field.
2977 template <class FieldTy> struct MDFieldImpl {
2978 typedef MDFieldImpl ImplTy;
2982 void assign(FieldTy Val) {
2984 this->Val = std::move(Val);
2987 explicit MDFieldImpl(FieldTy Default)
2988 : Val(std::move(Default)), Seen(false) {}
2991 struct MDUnsignedField : public MDFieldImpl<uint64_t> {
2994 MDUnsignedField(uint64_t Default = 0, uint64_t Max = UINT64_MAX)
2995 : ImplTy(Default), Max(Max) {}
2997 struct LineField : public MDUnsignedField {
2998 LineField() : MDUnsignedField(0, UINT32_MAX) {}
3000 struct ColumnField : public MDUnsignedField {
3001 ColumnField() : MDUnsignedField(0, UINT16_MAX) {}
3003 struct DwarfTagField : public MDUnsignedField {
3004 DwarfTagField() : MDUnsignedField(0, dwarf::DW_TAG_hi_user) {}
3005 DwarfTagField(dwarf::Tag DefaultTag)
3006 : MDUnsignedField(DefaultTag, dwarf::DW_TAG_hi_user) {}
3008 struct DwarfAttEncodingField : public MDUnsignedField {
3009 DwarfAttEncodingField() : MDUnsignedField(0, dwarf::DW_ATE_hi_user) {}
3011 struct DwarfVirtualityField : public MDUnsignedField {
3012 DwarfVirtualityField() : MDUnsignedField(0, dwarf::DW_VIRTUALITY_max) {}
3014 struct DwarfLangField : public MDUnsignedField {
3015 DwarfLangField() : MDUnsignedField(0, dwarf::DW_LANG_hi_user) {}
3018 struct DIFlagField : public MDUnsignedField {
3019 DIFlagField() : MDUnsignedField(0, UINT32_MAX) {}
3022 struct MDSignedField : public MDFieldImpl<int64_t> {
3026 MDSignedField(int64_t Default = 0)
3027 : ImplTy(Default), Min(INT64_MIN), Max(INT64_MAX) {}
3028 MDSignedField(int64_t Default, int64_t Min, int64_t Max)
3029 : ImplTy(Default), Min(Min), Max(Max) {}
3032 struct MDBoolField : public MDFieldImpl<bool> {
3033 MDBoolField(bool Default = false) : ImplTy(Default) {}
3035 struct MDField : public MDFieldImpl<Metadata *> {
3038 MDField(bool AllowNull = true) : ImplTy(nullptr), AllowNull(AllowNull) {}
3040 struct MDConstant : public MDFieldImpl<ConstantAsMetadata *> {
3041 MDConstant() : ImplTy(nullptr) {}
3043 struct MDStringField : public MDFieldImpl<MDString *> {
3045 MDStringField(bool AllowEmpty = true)
3046 : ImplTy(nullptr), AllowEmpty(AllowEmpty) {}
3048 struct MDFieldList : public MDFieldImpl<SmallVector<Metadata *, 4>> {
3049 MDFieldList() : ImplTy(SmallVector<Metadata *, 4>()) {}
3057 bool LLParser::ParseMDField(LocTy Loc, StringRef Name,
3058 MDUnsignedField &Result) {
3059 if (Lex.getKind() != lltok::APSInt || Lex.getAPSIntVal().isSigned())
3060 return TokError("expected unsigned integer");
3062 auto &U = Lex.getAPSIntVal();
3063 if (U.ugt(Result.Max))
3064 return TokError("value for '" + Name + "' too large, limit is " +
3066 Result.assign(U.getZExtValue());
3067 assert(Result.Val <= Result.Max && "Expected value in range");
3073 bool LLParser::ParseMDField(LocTy Loc, StringRef Name, LineField &Result) {
3074 return ParseMDField(Loc, Name, static_cast<MDUnsignedField &>(Result));
3077 bool LLParser::ParseMDField(LocTy Loc, StringRef Name, ColumnField &Result) {
3078 return ParseMDField(Loc, Name, static_cast<MDUnsignedField &>(Result));
3082 bool LLParser::ParseMDField(LocTy Loc, StringRef Name, DwarfTagField &Result) {
3083 if (Lex.getKind() == lltok::APSInt)
3084 return ParseMDField(Loc, Name, static_cast<MDUnsignedField &>(Result));
3086 if (Lex.getKind() != lltok::DwarfTag)
3087 return TokError("expected DWARF tag");
3089 unsigned Tag = dwarf::getTag(Lex.getStrVal());
3090 if (Tag == dwarf::DW_TAG_invalid)
3091 return TokError("invalid DWARF tag" + Twine(" '") + Lex.getStrVal() + "'");
3092 assert(Tag <= Result.Max && "Expected valid DWARF tag");
3100 bool LLParser::ParseMDField(LocTy Loc, StringRef Name,
3101 DwarfVirtualityField &Result) {
3102 if (Lex.getKind() == lltok::APSInt)
3103 return ParseMDField(Loc, Name, static_cast<MDUnsignedField &>(Result));
3105 if (Lex.getKind() != lltok::DwarfVirtuality)
3106 return TokError("expected DWARF virtuality code");
3108 unsigned Virtuality = dwarf::getVirtuality(Lex.getStrVal());
3110 return TokError("invalid DWARF virtuality code" + Twine(" '") +
3111 Lex.getStrVal() + "'");
3112 assert(Virtuality <= Result.Max && "Expected valid DWARF virtuality code");
3113 Result.assign(Virtuality);
3119 bool LLParser::ParseMDField(LocTy Loc, StringRef Name, DwarfLangField &Result) {
3120 if (Lex.getKind() == lltok::APSInt)
3121 return ParseMDField(Loc, Name, static_cast<MDUnsignedField &>(Result));
3123 if (Lex.getKind() != lltok::DwarfLang)
3124 return TokError("expected DWARF language");
3126 unsigned Lang = dwarf::getLanguage(Lex.getStrVal());
3128 return TokError("invalid DWARF language" + Twine(" '") + Lex.getStrVal() +
3130 assert(Lang <= Result.Max && "Expected valid DWARF language");
3131 Result.assign(Lang);
3137 bool LLParser::ParseMDField(LocTy Loc, StringRef Name,
3138 DwarfAttEncodingField &Result) {
3139 if (Lex.getKind() == lltok::APSInt)
3140 return ParseMDField(Loc, Name, static_cast<MDUnsignedField &>(Result));
3142 if (Lex.getKind() != lltok::DwarfAttEncoding)
3143 return TokError("expected DWARF type attribute encoding");
3145 unsigned Encoding = dwarf::getAttributeEncoding(Lex.getStrVal());
3147 return TokError("invalid DWARF type attribute encoding" + Twine(" '") +
3148 Lex.getStrVal() + "'");
3149 assert(Encoding <= Result.Max && "Expected valid DWARF language");
3150 Result.assign(Encoding);
3157 /// ::= DIFlagVector
3158 /// ::= DIFlagVector '|' DIFlagFwdDecl '|' uint32 '|' DIFlagPublic
3160 bool LLParser::ParseMDField(LocTy Loc, StringRef Name, DIFlagField &Result) {
3161 assert(Result.Max == UINT32_MAX && "Expected only 32-bits");
3163 // Parser for a single flag.
3164 auto parseFlag = [&](unsigned &Val) {
3165 if (Lex.getKind() == lltok::APSInt && !Lex.getAPSIntVal().isSigned())
3166 return ParseUInt32(Val);
3168 if (Lex.getKind() != lltok::DIFlag)
3169 return TokError("expected debug info flag");
3171 Val = DIDescriptor::getFlag(Lex.getStrVal());
3173 return TokError(Twine("invalid debug info flag flag '") +
3174 Lex.getStrVal() + "'");
3179 // Parse the flags and combine them together.
3180 unsigned Combined = 0;
3186 } while (EatIfPresent(lltok::bar));
3188 Result.assign(Combined);
3193 bool LLParser::ParseMDField(LocTy Loc, StringRef Name,
3194 MDSignedField &Result) {
3195 if (Lex.getKind() != lltok::APSInt)
3196 return TokError("expected signed integer");
3198 auto &S = Lex.getAPSIntVal();
3200 return TokError("value for '" + Name + "' too small, limit is " +
3203 return TokError("value for '" + Name + "' too large, limit is " +
3205 Result.assign(S.getExtValue());
3206 assert(Result.Val >= Result.Min && "Expected value in range");
3207 assert(Result.Val <= Result.Max && "Expected value in range");
3213 bool LLParser::ParseMDField(LocTy Loc, StringRef Name, MDBoolField &Result) {
3214 switch (Lex.getKind()) {
3216 return TokError("expected 'true' or 'false'");
3217 case lltok::kw_true:
3218 Result.assign(true);
3220 case lltok::kw_false:
3221 Result.assign(false);
3229 bool LLParser::ParseMDField(LocTy Loc, StringRef Name, MDField &Result) {
3230 if (Lex.getKind() == lltok::kw_null) {
3231 if (!Result.AllowNull)
3232 return TokError("'" + Name + "' cannot be null");
3234 Result.assign(nullptr);
3239 if (ParseMetadata(MD, nullptr))
3247 bool LLParser::ParseMDField(LocTy Loc, StringRef Name, MDConstant &Result) {
3249 if (ParseValueAsMetadata(MD, "expected constant", nullptr))
3252 Result.assign(cast<ConstantAsMetadata>(MD));
3257 bool LLParser::ParseMDField(LocTy Loc, StringRef Name, MDStringField &Result) {
3258 LocTy ValueLoc = Lex.getLoc();
3260 if (ParseStringConstant(S))
3263 if (!Result.AllowEmpty && S.empty())
3264 return Error(ValueLoc, "'" + Name + "' cannot be empty");
3266 Result.assign(S.empty() ? nullptr : MDString::get(Context, S));
3271 bool LLParser::ParseMDField(LocTy Loc, StringRef Name, MDFieldList &Result) {
3272 SmallVector<Metadata *, 4> MDs;
3273 if (ParseMDNodeVector(MDs))
3276 Result.assign(std::move(MDs));
3280 } // end namespace llvm
3282 template <class ParserTy>
3283 bool LLParser::ParseMDFieldsImplBody(ParserTy parseField) {
3285 if (Lex.getKind() != lltok::LabelStr)
3286 return TokError("expected field label here");
3290 } while (EatIfPresent(lltok::comma));
3295 template <class ParserTy>
3296 bool LLParser::ParseMDFieldsImpl(ParserTy parseField, LocTy &ClosingLoc) {
3297 assert(Lex.getKind() == lltok::MetadataVar && "Expected metadata type name");
3300 if (ParseToken(lltok::lparen, "expected '(' here"))
3302 if (Lex.getKind() != lltok::rparen)
3303 if (ParseMDFieldsImplBody(parseField))
3306 ClosingLoc = Lex.getLoc();
3307 return ParseToken(lltok::rparen, "expected ')' here");
3310 template <class FieldTy>
3311 bool LLParser::ParseMDField(StringRef Name, FieldTy &Result) {
3313 return TokError("field '" + Name + "' cannot be specified more than once");
3315 LocTy Loc = Lex.getLoc();
3317 return ParseMDField(Loc, Name, Result);
3320 bool LLParser::ParseSpecializedMDNode(MDNode *&N, bool IsDistinct) {
3321 assert(Lex.getKind() == lltok::MetadataVar && "Expected metadata type name");
3323 #define HANDLE_SPECIALIZED_MDNODE_LEAF(CLASS) \
3324 if (Lex.getStrVal() == #CLASS) \
3325 return Parse##CLASS(N, IsDistinct);
3326 #include "llvm/IR/Metadata.def"
3328 return TokError("expected metadata type");
3331 #define DECLARE_FIELD(NAME, TYPE, INIT) TYPE NAME INIT
3332 #define NOP_FIELD(NAME, TYPE, INIT)
3333 #define REQUIRE_FIELD(NAME, TYPE, INIT) \
3335 return Error(ClosingLoc, "missing required field '" #NAME "'");
3336 #define PARSE_MD_FIELD(NAME, TYPE, DEFAULT) \
3337 if (Lex.getStrVal() == #NAME) \
3338 return ParseMDField(#NAME, NAME);
3339 #define PARSE_MD_FIELDS() \
3340 VISIT_MD_FIELDS(DECLARE_FIELD, DECLARE_FIELD) \
3343 if (ParseMDFieldsImpl([&]() -> bool { \
3344 VISIT_MD_FIELDS(PARSE_MD_FIELD, PARSE_MD_FIELD) \
3345 return TokError(Twine("invalid field '") + Lex.getStrVal() + "'"); \
3348 VISIT_MD_FIELDS(NOP_FIELD, REQUIRE_FIELD) \
3350 #define GET_OR_DISTINCT(CLASS, ARGS) \
3351 (IsDistinct ? CLASS::getDistinct ARGS : CLASS::get ARGS)
3353 /// ParseMDLocationFields:
3354 /// ::= !MDLocation(line: 43, column: 8, scope: !5, inlinedAt: !6)
3355 bool LLParser::ParseMDLocation(MDNode *&Result, bool IsDistinct) {
3356 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED) \
3357 OPTIONAL(line, LineField, ); \
3358 OPTIONAL(column, ColumnField, ); \
3359 REQUIRED(scope, MDField, (/* AllowNull */ false)); \
3360 OPTIONAL(inlinedAt, MDField, );
3362 #undef VISIT_MD_FIELDS
3364 Result = GET_OR_DISTINCT(
3365 MDLocation, (Context, line.Val, column.Val, scope.Val, inlinedAt.Val));
3369 /// ParseGenericDebugNode:
3370 /// ::= !GenericDebugNode(tag: 15, header: "...", operands: {...})
3371 bool LLParser::ParseGenericDebugNode(MDNode *&Result, bool IsDistinct) {
3372 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED) \
3373 REQUIRED(tag, DwarfTagField, ); \
3374 OPTIONAL(header, MDStringField, ); \
3375 OPTIONAL(operands, MDFieldList, );
3377 #undef VISIT_MD_FIELDS
3379 Result = GET_OR_DISTINCT(GenericDebugNode,
3380 (Context, tag.Val, header.Val, operands.Val));
3384 /// ParseMDSubrange:
3385 /// ::= !MDSubrange(count: 30, lowerBound: 2)
3386 bool LLParser::ParseMDSubrange(MDNode *&Result, bool IsDistinct) {
3387 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED) \
3388 REQUIRED(count, MDSignedField, (-1, -1, INT64_MAX)); \
3389 OPTIONAL(lowerBound, MDSignedField, );
3391 #undef VISIT_MD_FIELDS
3393 Result = GET_OR_DISTINCT(MDSubrange, (Context, count.Val, lowerBound.Val));
3397 /// ParseMDEnumerator:
3398 /// ::= !MDEnumerator(value: 30, name: "SomeKind")
3399 bool LLParser::ParseMDEnumerator(MDNode *&Result, bool IsDistinct) {
3400 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED) \
3401 REQUIRED(name, MDStringField, ); \
3402 REQUIRED(value, MDSignedField, );
3404 #undef VISIT_MD_FIELDS
3406 Result = GET_OR_DISTINCT(MDEnumerator, (Context, value.Val, name.Val));
3410 /// ParseMDBasicType:
3411 /// ::= !MDBasicType(tag: DW_TAG_base_type, name: "int", size: 32, align: 32)
3412 bool LLParser::ParseMDBasicType(MDNode *&Result, bool IsDistinct) {
3413 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED) \
3414 OPTIONAL(tag, DwarfTagField, (dwarf::DW_TAG_base_type)); \
3415 OPTIONAL(name, MDStringField, ); \
3416 OPTIONAL(size, MDUnsignedField, (0, UINT64_MAX)); \
3417 OPTIONAL(align, MDUnsignedField, (0, UINT64_MAX)); \
3418 OPTIONAL(encoding, DwarfAttEncodingField, );
3420 #undef VISIT_MD_FIELDS
3422 Result = GET_OR_DISTINCT(MDBasicType, (Context, tag.Val, name.Val, size.Val,
3423 align.Val, encoding.Val));
3427 /// ParseMDDerivedType:
3428 /// ::= !MDDerivedType(tag: DW_TAG_pointer_type, name: "int", file: !0,
3429 /// line: 7, scope: !1, baseType: !2, size: 32,
3430 /// align: 32, offset: 0, flags: 0, extraData: !3)
3431 bool LLParser::ParseMDDerivedType(MDNode *&Result, bool IsDistinct) {
3432 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED) \
3433 REQUIRED(tag, DwarfTagField, ); \
3434 OPTIONAL(name, MDStringField, ); \
3435 OPTIONAL(file, MDField, ); \
3436 OPTIONAL(line, LineField, ); \
3437 OPTIONAL(scope, MDField, ); \
3438 REQUIRED(baseType, MDField, ); \
3439 OPTIONAL(size, MDUnsignedField, (0, UINT64_MAX)); \
3440 OPTIONAL(align, MDUnsignedField, (0, UINT64_MAX)); \
3441 OPTIONAL(offset, MDUnsignedField, (0, UINT64_MAX)); \
3442 OPTIONAL(flags, DIFlagField, ); \
3443 OPTIONAL(extraData, MDField, );
3445 #undef VISIT_MD_FIELDS
3447 Result = GET_OR_DISTINCT(MDDerivedType,
3448 (Context, tag.Val, name.Val, file.Val, line.Val,
3449 scope.Val, baseType.Val, size.Val, align.Val,
3450 offset.Val, flags.Val, extraData.Val));
3454 bool LLParser::ParseMDCompositeType(MDNode *&Result, bool IsDistinct) {
3455 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED) \
3456 REQUIRED(tag, DwarfTagField, ); \
3457 OPTIONAL(name, MDStringField, ); \
3458 OPTIONAL(file, MDField, ); \
3459 OPTIONAL(line, LineField, ); \
3460 OPTIONAL(scope, MDField, ); \
3461 OPTIONAL(baseType, MDField, ); \
3462 OPTIONAL(size, MDUnsignedField, (0, UINT64_MAX)); \
3463 OPTIONAL(align, MDUnsignedField, (0, UINT64_MAX)); \
3464 OPTIONAL(offset, MDUnsignedField, (0, UINT64_MAX)); \
3465 OPTIONAL(flags, DIFlagField, ); \
3466 OPTIONAL(elements, MDField, ); \
3467 OPTIONAL(runtimeLang, DwarfLangField, ); \
3468 OPTIONAL(vtableHolder, MDField, ); \
3469 OPTIONAL(templateParams, MDField, ); \
3470 OPTIONAL(identifier, MDStringField, );
3472 #undef VISIT_MD_FIELDS
3474 Result = GET_OR_DISTINCT(
3476 (Context, tag.Val, name.Val, file.Val, line.Val, scope.Val, baseType.Val,
3477 size.Val, align.Val, offset.Val, flags.Val, elements.Val,
3478 runtimeLang.Val, vtableHolder.Val, templateParams.Val, identifier.Val));
3482 bool LLParser::ParseMDSubroutineType(MDNode *&Result, bool IsDistinct) {
3483 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED) \
3484 OPTIONAL(flags, DIFlagField, ); \
3485 REQUIRED(types, MDField, );
3487 #undef VISIT_MD_FIELDS
3489 Result = GET_OR_DISTINCT(MDSubroutineType, (Context, flags.Val, types.Val));
3493 /// ParseMDFileType:
3494 /// ::= !MDFileType(filename: "path/to/file", directory: "/path/to/dir")
3495 bool LLParser::ParseMDFile(MDNode *&Result, bool IsDistinct) {
3496 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED) \
3497 REQUIRED(filename, MDStringField, ); \
3498 REQUIRED(directory, MDStringField, );
3500 #undef VISIT_MD_FIELDS
3502 Result = GET_OR_DISTINCT(MDFile, (Context, filename.Val, directory.Val));
3506 /// ParseMDCompileUnit:
3507 /// ::= !MDCompileUnit(language: DW_LANG_C99, file: !0, producer: "clang",
3508 /// isOptimized: true, flags: "-O2", runtimeVersion: 1,
3509 /// splitDebugFilename: "abc.debug", emissionKind: 1,
3510 /// enums: !1, retainedTypes: !2, subprograms: !3,
3511 /// globals: !4, imports: !5)
3512 bool LLParser::ParseMDCompileUnit(MDNode *&Result, bool IsDistinct) {
3513 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED) \
3514 REQUIRED(language, DwarfLangField, ); \
3515 REQUIRED(file, MDField, (/* AllowNull */ false)); \
3516 OPTIONAL(producer, MDStringField, ); \
3517 OPTIONAL(isOptimized, MDBoolField, ); \
3518 OPTIONAL(flags, MDStringField, ); \
3519 OPTIONAL(runtimeVersion, MDUnsignedField, (0, UINT32_MAX)); \
3520 OPTIONAL(splitDebugFilename, MDStringField, ); \
3521 OPTIONAL(emissionKind, MDUnsignedField, (0, UINT32_MAX)); \
3522 OPTIONAL(enums, MDField, ); \
3523 OPTIONAL(retainedTypes, MDField, ); \
3524 OPTIONAL(subprograms, MDField, ); \
3525 OPTIONAL(globals, MDField, ); \
3526 OPTIONAL(imports, MDField, );
3528 #undef VISIT_MD_FIELDS
3530 Result = GET_OR_DISTINCT(MDCompileUnit,
3531 (Context, language.Val, file.Val, producer.Val,
3532 isOptimized.Val, flags.Val, runtimeVersion.Val,
3533 splitDebugFilename.Val, emissionKind.Val, enums.Val,
3534 retainedTypes.Val, subprograms.Val, globals.Val,
3539 /// ParseMDSubprogram:
3540 /// ::= !MDSubprogram(scope: !0, name: "foo", linkageName: "_Zfoo",
3541 /// file: !1, line: 7, type: !2, isLocal: false,
3542 /// isDefinition: true, scopeLine: 8, containingType: !3,
3543 /// virtuality: DW_VIRTUALTIY_pure_virtual,
3544 /// virtualIndex: 10, flags: 11,
3545 /// isOptimized: false, function: void ()* @_Z3foov,
3546 /// templateParams: !4, declaration: !5, variables: !6)
3547 bool LLParser::ParseMDSubprogram(MDNode *&Result, bool IsDistinct) {
3548 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED) \
3549 OPTIONAL(scope, MDField, ); \
3550 OPTIONAL(name, MDStringField, ); \
3551 OPTIONAL(linkageName, MDStringField, ); \
3552 OPTIONAL(file, MDField, ); \
3553 OPTIONAL(line, LineField, ); \
3554 OPTIONAL(type, MDField, ); \
3555 OPTIONAL(isLocal, MDBoolField, ); \
3556 OPTIONAL(isDefinition, MDBoolField, (true)); \
3557 OPTIONAL(scopeLine, LineField, ); \
3558 OPTIONAL(containingType, MDField, ); \
3559 OPTIONAL(virtuality, DwarfVirtualityField, ); \
3560 OPTIONAL(virtualIndex, MDUnsignedField, (0, UINT32_MAX)); \
3561 OPTIONAL(flags, DIFlagField, ); \
3562 OPTIONAL(isOptimized, MDBoolField, ); \
3563 OPTIONAL(function, MDConstant, ); \
3564 OPTIONAL(templateParams, MDField, ); \
3565 OPTIONAL(declaration, MDField, ); \
3566 OPTIONAL(variables, MDField, );
3568 #undef VISIT_MD_FIELDS
3570 Result = GET_OR_DISTINCT(
3571 MDSubprogram, (Context, scope.Val, name.Val, linkageName.Val, file.Val,
3572 line.Val, type.Val, isLocal.Val, isDefinition.Val,
3573 scopeLine.Val, containingType.Val, virtuality.Val,
3574 virtualIndex.Val, flags.Val, isOptimized.Val, function.Val,
3575 templateParams.Val, declaration.Val, variables.Val));
3579 /// ParseMDLexicalBlock:
3580 /// ::= !MDLexicalBlock(scope: !0, file: !2, line: 7, column: 9)
3581 bool LLParser::ParseMDLexicalBlock(MDNode *&Result, bool IsDistinct) {
3582 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED) \
3583 REQUIRED(scope, MDField, (/* AllowNull */ false)); \
3584 OPTIONAL(file, MDField, ); \
3585 OPTIONAL(line, LineField, ); \
3586 OPTIONAL(column, ColumnField, );
3588 #undef VISIT_MD_FIELDS
3590 Result = GET_OR_DISTINCT(
3591 MDLexicalBlock, (Context, scope.Val, file.Val, line.Val, column.Val));
3595 /// ParseMDLexicalBlockFile:
3596 /// ::= !MDLexicalBlockFile(scope: !0, file: !2, discriminator: 9)
3597 bool LLParser::ParseMDLexicalBlockFile(MDNode *&Result, bool IsDistinct) {
3598 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED) \
3599 REQUIRED(scope, MDField, (/* AllowNull */ false)); \
3600 OPTIONAL(file, MDField, ); \
3601 REQUIRED(discriminator, MDUnsignedField, (0, UINT32_MAX));
3603 #undef VISIT_MD_FIELDS
3605 Result = GET_OR_DISTINCT(MDLexicalBlockFile,
3606 (Context, scope.Val, file.Val, discriminator.Val));
3610 /// ParseMDNamespace:
3611 /// ::= !MDNamespace(scope: !0, file: !2, name: "SomeNamespace", line: 9)
3612 bool LLParser::ParseMDNamespace(MDNode *&Result, bool IsDistinct) {
3613 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED) \
3614 REQUIRED(scope, MDField, ); \
3615 OPTIONAL(file, MDField, ); \
3616 OPTIONAL(name, MDStringField, ); \
3617 OPTIONAL(line, LineField, );
3619 #undef VISIT_MD_FIELDS
3621 Result = GET_OR_DISTINCT(MDNamespace,
3622 (Context, scope.Val, file.Val, name.Val, line.Val));
3626 /// ParseMDTemplateTypeParameter:
3627 /// ::= !MDTemplateTypeParameter(name: "Ty", type: !1)
3628 bool LLParser::ParseMDTemplateTypeParameter(MDNode *&Result, bool IsDistinct) {
3629 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED) \
3630 OPTIONAL(name, MDStringField, ); \
3631 REQUIRED(type, MDField, );
3633 #undef VISIT_MD_FIELDS
3636 GET_OR_DISTINCT(MDTemplateTypeParameter, (Context, name.Val, type.Val));
3640 /// ParseMDTemplateValueParameter:
3641 /// ::= !MDTemplateValueParameter(tag: DW_TAG_template_value_parameter,
3642 /// name: "V", type: !1, value: i32 7)
3643 bool LLParser::ParseMDTemplateValueParameter(MDNode *&Result, bool IsDistinct) {
3644 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED) \
3645 OPTIONAL(tag, DwarfTagField, (dwarf::DW_TAG_template_value_parameter)); \
3646 OPTIONAL(name, MDStringField, ); \
3647 OPTIONAL(type, MDField, ); \
3648 REQUIRED(value, MDField, );
3650 #undef VISIT_MD_FIELDS
3652 Result = GET_OR_DISTINCT(MDTemplateValueParameter,
3653 (Context, tag.Val, name.Val, type.Val, value.Val));
3657 /// ParseMDGlobalVariable:
3658 /// ::= !MDGlobalVariable(scope: !0, name: "foo", linkageName: "foo",
3659 /// file: !1, line: 7, type: !2, isLocal: false,
3660 /// isDefinition: true, variable: i32* @foo,
3661 /// declaration: !3)
3662 bool LLParser::ParseMDGlobalVariable(MDNode *&Result, bool IsDistinct) {
3663 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED) \
3664 REQUIRED(name, MDStringField, (/* AllowEmpty */ false)); \
3665 OPTIONAL(scope, MDField, ); \
3666 OPTIONAL(linkageName, MDStringField, ); \
3667 OPTIONAL(file, MDField, ); \
3668 OPTIONAL(line, LineField, ); \
3669 OPTIONAL(type, MDField, ); \
3670 OPTIONAL(isLocal, MDBoolField, ); \
3671 OPTIONAL(isDefinition, MDBoolField, (true)); \
3672 OPTIONAL(variable, MDConstant, ); \
3673 OPTIONAL(declaration, MDField, );
3675 #undef VISIT_MD_FIELDS
3677 Result = GET_OR_DISTINCT(MDGlobalVariable,
3678 (Context, scope.Val, name.Val, linkageName.Val,
3679 file.Val, line.Val, type.Val, isLocal.Val,
3680 isDefinition.Val, variable.Val, declaration.Val));
3684 /// ParseMDLocalVariable:
3685 /// ::= !MDLocalVariable(tag: DW_TAG_arg_variable, scope: !0, name: "foo",
3686 /// file: !1, line: 7, type: !2, arg: 2, flags: 7,
3688 bool LLParser::ParseMDLocalVariable(MDNode *&Result, bool IsDistinct) {
3689 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED) \
3690 REQUIRED(tag, DwarfTagField, ); \
3691 REQUIRED(scope, MDField, (/* AllowNull */ false)); \
3692 OPTIONAL(name, MDStringField, ); \
3693 OPTIONAL(file, MDField, ); \
3694 OPTIONAL(line, LineField, ); \
3695 OPTIONAL(type, MDField, ); \
3696 OPTIONAL(arg, MDUnsignedField, (0, UINT8_MAX)); \
3697 OPTIONAL(flags, DIFlagField, ); \
3698 OPTIONAL(inlinedAt, MDField, );
3700 #undef VISIT_MD_FIELDS
3702 Result = GET_OR_DISTINCT(
3703 MDLocalVariable, (Context, tag.Val, scope.Val, name.Val, file.Val,
3704 line.Val, type.Val, arg.Val, flags.Val, inlinedAt.Val));
3708 /// ParseMDExpression:
3709 /// ::= !MDExpression(0, 7, -1)
3710 bool LLParser::ParseMDExpression(MDNode *&Result, bool IsDistinct) {
3711 assert(Lex.getKind() == lltok::MetadataVar && "Expected metadata type name");
3714 if (ParseToken(lltok::lparen, "expected '(' here"))
3717 SmallVector<uint64_t, 8> Elements;
3718 if (Lex.getKind() != lltok::rparen)
3720 if (Lex.getKind() == lltok::DwarfOp) {
3721 if (unsigned Op = dwarf::getOperationEncoding(Lex.getStrVal())) {
3723 Elements.push_back(Op);
3726 return TokError(Twine("invalid DWARF op '") + Lex.getStrVal() + "'");
3729 if (Lex.getKind() != lltok::APSInt || Lex.getAPSIntVal().isSigned())
3730 return TokError("expected unsigned integer");
3732 auto &U = Lex.getAPSIntVal();
3733 if (U.ugt(UINT64_MAX))
3734 return TokError("element too large, limit is " + Twine(UINT64_MAX));
3735 Elements.push_back(U.getZExtValue());
3737 } while (EatIfPresent(lltok::comma));
3739 if (ParseToken(lltok::rparen, "expected ')' here"))
3742 Result = GET_OR_DISTINCT(MDExpression, (Context, Elements));
3746 /// ParseMDObjCProperty:
3747 /// ::= !MDObjCProperty(name: "foo", file: !1, line: 7, setter: "setFoo",
3748 /// getter: "getFoo", attributes: 7, type: !2)
3749 bool LLParser::ParseMDObjCProperty(MDNode *&Result, bool IsDistinct) {
3750 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED) \
3751 OPTIONAL(name, MDStringField, ); \
3752 OPTIONAL(file, MDField, ); \
3753 OPTIONAL(line, LineField, ); \
3754 OPTIONAL(setter, MDStringField, ); \
3755 OPTIONAL(getter, MDStringField, ); \
3756 OPTIONAL(attributes, MDUnsignedField, (0, UINT32_MAX)); \
3757 OPTIONAL(type, MDField, );
3759 #undef VISIT_MD_FIELDS
3761 Result = GET_OR_DISTINCT(MDObjCProperty,
3762 (Context, name.Val, file.Val, line.Val, setter.Val,
3763 getter.Val, attributes.Val, type.Val));
3767 /// ParseMDImportedEntity:
3768 /// ::= !MDImportedEntity(tag: DW_TAG_imported_module, scope: !0, entity: !1,
3769 /// line: 7, name: "foo")
3770 bool LLParser::ParseMDImportedEntity(MDNode *&Result, bool IsDistinct) {
3771 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED) \
3772 REQUIRED(tag, DwarfTagField, ); \
3773 REQUIRED(scope, MDField, ); \
3774 OPTIONAL(entity, MDField, ); \
3775 OPTIONAL(line, LineField, ); \
3776 OPTIONAL(name, MDStringField, );
3778 #undef VISIT_MD_FIELDS
3780 Result = GET_OR_DISTINCT(MDImportedEntity, (Context, tag.Val, scope.Val,
3781 entity.Val, line.Val, name.Val));
3785 #undef PARSE_MD_FIELD
3787 #undef REQUIRE_FIELD
3788 #undef DECLARE_FIELD
3790 /// ParseMetadataAsValue
3791 /// ::= metadata i32 %local
3792 /// ::= metadata i32 @global
3793 /// ::= metadata i32 7
3795 /// ::= metadata !{...}
3796 /// ::= metadata !"string"
3797 bool LLParser::ParseMetadataAsValue(Value *&V, PerFunctionState &PFS) {
3798 // Note: the type 'metadata' has already been parsed.
3800 if (ParseMetadata(MD, &PFS))
3803 V = MetadataAsValue::get(Context, MD);
3807 /// ParseValueAsMetadata
3811 bool LLParser::ParseValueAsMetadata(Metadata *&MD, const Twine &TypeMsg,
3812 PerFunctionState *PFS) {
3815 if (ParseType(Ty, TypeMsg, Loc))
3817 if (Ty->isMetadataTy())
3818 return Error(Loc, "invalid metadata-value-metadata roundtrip");
3821 if (ParseValue(Ty, V, PFS))
3824 MD = ValueAsMetadata::get(V);
3835 /// ::= !MDLocation(...)
3836 bool LLParser::ParseMetadata(Metadata *&MD, PerFunctionState *PFS) {
3837 if (Lex.getKind() == lltok::MetadataVar) {
3839 if (ParseSpecializedMDNode(N))
3847 if (Lex.getKind() != lltok::exclaim)
3848 return ParseValueAsMetadata(MD, "expected metadata operand", PFS);
3851 assert(Lex.getKind() == lltok::exclaim && "Expected '!' here");
3855 // ::= '!' STRINGCONSTANT
3856 if (Lex.getKind() == lltok::StringConstant) {
3858 if (ParseMDString(S))
3868 if (ParseMDNodeTail(N))
3875 //===----------------------------------------------------------------------===//
3876 // Function Parsing.
3877 //===----------------------------------------------------------------------===//
3879 bool LLParser::ConvertValIDToValue(Type *Ty, ValID &ID, Value *&V,
3880 PerFunctionState *PFS) {
3881 if (Ty->isFunctionTy())
3882 return Error(ID.Loc, "functions are not values, refer to them as pointers");
3885 case ValID::t_LocalID:
3886 if (!PFS) return Error(ID.Loc, "invalid use of function-local name");
3887 V = PFS->GetVal(ID.UIntVal, Ty, ID.Loc);
3888 return V == nullptr;
3889 case ValID::t_LocalName:
3890 if (!PFS) return Error(ID.Loc, "invalid use of function-local name");
3891 V = PFS->GetVal(ID.StrVal, Ty, ID.Loc);
3892 return V == nullptr;
3893 case ValID::t_InlineAsm: {
3894 PointerType *PTy = dyn_cast<PointerType>(Ty);
3896 PTy ? dyn_cast<FunctionType>(PTy->getElementType()) : nullptr;
3897 if (!FTy || !InlineAsm::Verify(FTy, ID.StrVal2))
3898 return Error(ID.Loc, "invalid type for inline asm constraint string");
3899 V = InlineAsm::get(FTy, ID.StrVal, ID.StrVal2, ID.UIntVal&1,
3900 (ID.UIntVal>>1)&1, (InlineAsm::AsmDialect(ID.UIntVal>>2)));
3903 case ValID::t_GlobalName:
3904 V = GetGlobalVal(ID.StrVal, Ty, ID.Loc);
3905 return V == nullptr;
3906 case ValID::t_GlobalID:
3907 V = GetGlobalVal(ID.UIntVal, Ty, ID.Loc);
3908 return V == nullptr;
3909 case ValID::t_APSInt:
3910 if (!Ty->isIntegerTy())
3911 return Error(ID.Loc, "integer constant must have integer type");
3912 ID.APSIntVal = ID.APSIntVal.extOrTrunc(Ty->getPrimitiveSizeInBits());
3913 V = ConstantInt::get(Context, ID.APSIntVal);
3915 case ValID::t_APFloat:
3916 if (!Ty->isFloatingPointTy() ||
3917 !ConstantFP::isValueValidForType(Ty, ID.APFloatVal))
3918 return Error(ID.Loc, "floating point constant invalid for type");
3920 // The lexer has no type info, so builds all half, float, and double FP
3921 // constants as double. Fix this here. Long double does not need this.
3922 if (&ID.APFloatVal.getSemantics() == &APFloat::IEEEdouble) {
3925 ID.APFloatVal.convert(APFloat::IEEEhalf, APFloat::rmNearestTiesToEven,
3927 else if (Ty->isFloatTy())
3928 ID.APFloatVal.convert(APFloat::IEEEsingle, APFloat::rmNearestTiesToEven,
3931 V = ConstantFP::get(Context, ID.APFloatVal);
3933 if (V->getType() != Ty)
3934 return Error(ID.Loc, "floating point constant does not have type '" +
3935 getTypeString(Ty) + "'");
3939 if (!Ty->isPointerTy())
3940 return Error(ID.Loc, "null must be a pointer type");
3941 V = ConstantPointerNull::get(cast<PointerType>(Ty));
3943 case ValID::t_Undef:
3944 // FIXME: LabelTy should not be a first-class type.
3945 if (!Ty->isFirstClassType() || Ty->isLabelTy())
3946 return Error(ID.Loc, "invalid type for undef constant");
3947 V = UndefValue::get(Ty);
3949 case ValID::t_EmptyArray:
3950 if (!Ty->isArrayTy() || cast<ArrayType>(Ty)->getNumElements() != 0)
3951 return Error(ID.Loc, "invalid empty array initializer");
3952 V = UndefValue::get(Ty);
3955 // FIXME: LabelTy should not be a first-class type.
3956 if (!Ty->isFirstClassType() || Ty->isLabelTy())
3957 return Error(ID.Loc, "invalid type for null constant");
3958 V = Constant::getNullValue(Ty);
3960 case ValID::t_Constant:
3961 if (ID.ConstantVal->getType() != Ty)
3962 return Error(ID.Loc, "constant expression type mismatch");
3966 case ValID::t_ConstantStruct:
3967 case ValID::t_PackedConstantStruct:
3968 if (StructType *ST = dyn_cast<StructType>(Ty)) {
3969 if (ST->getNumElements() != ID.UIntVal)
3970 return Error(ID.Loc,
3971 "initializer with struct type has wrong # elements");
3972 if (ST->isPacked() != (ID.Kind == ValID::t_PackedConstantStruct))
3973 return Error(ID.Loc, "packed'ness of initializer and type don't match");
3975 // Verify that the elements are compatible with the structtype.
3976 for (unsigned i = 0, e = ID.UIntVal; i != e; ++i)
3977 if (ID.ConstantStructElts[i]->getType() != ST->getElementType(i))
3978 return Error(ID.Loc, "element " + Twine(i) +
3979 " of struct initializer doesn't match struct element type");
3981 V = ConstantStruct::get(ST, makeArrayRef(ID.ConstantStructElts,
3984 return Error(ID.Loc, "constant expression type mismatch");
3987 llvm_unreachable("Invalid ValID");
3990 bool LLParser::ParseValue(Type *Ty, Value *&V, PerFunctionState *PFS) {
3993 return ParseValID(ID, PFS) ||
3994 ConvertValIDToValue(Ty, ID, V, PFS);
3997 bool LLParser::ParseTypeAndValue(Value *&V, PerFunctionState *PFS) {
3999 return ParseType(Ty) ||
4000 ParseValue(Ty, V, PFS);
4003 bool LLParser::ParseTypeAndBasicBlock(BasicBlock *&BB, LocTy &Loc,
4004 PerFunctionState &PFS) {
4007 if (ParseTypeAndValue(V, PFS)) return true;
4008 if (!isa<BasicBlock>(V))
4009 return Error(Loc, "expected a basic block");
4010 BB = cast<BasicBlock>(V);
4016 /// ::= OptionalLinkage OptionalVisibility OptionalCallingConv OptRetAttrs
4017 /// OptUnnamedAddr Type GlobalName '(' ArgList ')' OptFuncAttrs OptSection
4018 /// OptionalAlign OptGC OptionalPrefix OptionalPrologue
4019 bool LLParser::ParseFunctionHeader(Function *&Fn, bool isDefine) {
4020 // Parse the linkage.
4021 LocTy LinkageLoc = Lex.getLoc();
4024 unsigned Visibility;
4025 unsigned DLLStorageClass;
4026 AttrBuilder RetAttrs;
4028 Type *RetType = nullptr;
4029 LocTy RetTypeLoc = Lex.getLoc();
4030 if (ParseOptionalLinkage(Linkage) ||
4031 ParseOptionalVisibility(Visibility) ||
4032 ParseOptionalDLLStorageClass(DLLStorageClass) ||
4033 ParseOptionalCallingConv(CC) ||
4034 ParseOptionalReturnAttrs(RetAttrs) ||
4035 ParseType(RetType, RetTypeLoc, true /*void allowed*/))
4038 // Verify that the linkage is ok.
4039 switch ((GlobalValue::LinkageTypes)Linkage) {
4040 case GlobalValue::ExternalLinkage:
4041 break; // always ok.
4042 case GlobalValue::ExternalWeakLinkage:
4044 return Error(LinkageLoc, "invalid linkage for function definition");
4046 case GlobalValue::PrivateLinkage:
4047 case GlobalValue::InternalLinkage:
4048 case GlobalValue::AvailableExternallyLinkage:
4049 case GlobalValue::LinkOnceAnyLinkage:
4050 case GlobalValue::LinkOnceODRLinkage:
4051 case GlobalValue::WeakAnyLinkage:
4052 case GlobalValue::WeakODRLinkage:
4054 return Error(LinkageLoc, "invalid linkage for function declaration");
4056 case GlobalValue::AppendingLinkage:
4057 case GlobalValue::CommonLinkage:
4058 return Error(LinkageLoc, "invalid function linkage type");
4061 if (!isValidVisibilityForLinkage(Visibility, Linkage))
4062 return Error(LinkageLoc,
4063 "symbol with local linkage must have default visibility");
4065 if (!FunctionType::isValidReturnType(RetType))
4066 return Error(RetTypeLoc, "invalid function return type");
4068 LocTy NameLoc = Lex.getLoc();
4070 std::string FunctionName;
4071 if (Lex.getKind() == lltok::GlobalVar) {
4072 FunctionName = Lex.getStrVal();
4073 } else if (Lex.getKind() == lltok::GlobalID) { // @42 is ok.
4074 unsigned NameID = Lex.getUIntVal();
4076 if (NameID != NumberedVals.size())
4077 return TokError("function expected to be numbered '%" +
4078 Twine(NumberedVals.size()) + "'");
4080 return TokError("expected function name");
4085 if (Lex.getKind() != lltok::lparen)
4086 return TokError("expected '(' in function argument list");
4088 SmallVector<ArgInfo, 8> ArgList;
4090 AttrBuilder FuncAttrs;
4091 std::vector<unsigned> FwdRefAttrGrps;
4093 std::string Section;
4097 LocTy UnnamedAddrLoc;
4098 Constant *Prefix = nullptr;
4099 Constant *Prologue = nullptr;
4102 if (ParseArgumentList(ArgList, isVarArg) ||
4103 ParseOptionalToken(lltok::kw_unnamed_addr, UnnamedAddr,
4105 ParseFnAttributeValuePairs(FuncAttrs, FwdRefAttrGrps, false,
4107 (EatIfPresent(lltok::kw_section) &&
4108 ParseStringConstant(Section)) ||
4109 parseOptionalComdat(FunctionName, C) ||
4110 ParseOptionalAlignment(Alignment) ||
4111 (EatIfPresent(lltok::kw_gc) &&
4112 ParseStringConstant(GC)) ||
4113 (EatIfPresent(lltok::kw_prefix) &&
4114 ParseGlobalTypeAndValue(Prefix)) ||
4115 (EatIfPresent(lltok::kw_prologue) &&
4116 ParseGlobalTypeAndValue(Prologue)))
4119 if (FuncAttrs.contains(Attribute::Builtin))
4120 return Error(BuiltinLoc, "'builtin' attribute not valid on function");
4122 // If the alignment was parsed as an attribute, move to the alignment field.
4123 if (FuncAttrs.hasAlignmentAttr()) {
4124 Alignment = FuncAttrs.getAlignment();
4125 FuncAttrs.removeAttribute(Attribute::Alignment);
4128 // Okay, if we got here, the function is syntactically valid. Convert types
4129 // and do semantic checks.
4130 std::vector<Type*> ParamTypeList;
4131 SmallVector<AttributeSet, 8> Attrs;
4133 if (RetAttrs.hasAttributes())
4134 Attrs.push_back(AttributeSet::get(RetType->getContext(),
4135 AttributeSet::ReturnIndex,
4138 for (unsigned i = 0, e = ArgList.size(); i != e; ++i) {
4139 ParamTypeList.push_back(ArgList[i].Ty);
4140 if (ArgList[i].Attrs.hasAttributes(i + 1)) {
4141 AttrBuilder B(ArgList[i].Attrs, i + 1);
4142 Attrs.push_back(AttributeSet::get(RetType->getContext(), i + 1, B));
4146 if (FuncAttrs.hasAttributes())
4147 Attrs.push_back(AttributeSet::get(RetType->getContext(),
4148 AttributeSet::FunctionIndex,
4151 AttributeSet PAL = AttributeSet::get(Context, Attrs);
4153 if (PAL.hasAttribute(1, Attribute::StructRet) && !RetType->isVoidTy())
4154 return Error(RetTypeLoc, "functions with 'sret' argument must return void");
4157 FunctionType::get(RetType, ParamTypeList, isVarArg);
4158 PointerType *PFT = PointerType::getUnqual(FT);
4161 if (!FunctionName.empty()) {
4162 // If this was a definition of a forward reference, remove the definition
4163 // from the forward reference table and fill in the forward ref.
4164 std::map<std::string, std::pair<GlobalValue*, LocTy> >::iterator FRVI =
4165 ForwardRefVals.find(FunctionName);
4166 if (FRVI != ForwardRefVals.end()) {
4167 Fn = M->getFunction(FunctionName);
4169 return Error(FRVI->second.second, "invalid forward reference to "
4170 "function as global value!");
4171 if (Fn->getType() != PFT)
4172 return Error(FRVI->second.second, "invalid forward reference to "
4173 "function '" + FunctionName + "' with wrong type!");
4175 ForwardRefVals.erase(FRVI);
4176 } else if ((Fn = M->getFunction(FunctionName))) {
4177 // Reject redefinitions.
4178 return Error(NameLoc, "invalid redefinition of function '" +
4179 FunctionName + "'");
4180 } else if (M->getNamedValue(FunctionName)) {
4181 return Error(NameLoc, "redefinition of function '@" + FunctionName + "'");
4185 // If this is a definition of a forward referenced function, make sure the
4187 std::map<unsigned, std::pair<GlobalValue*, LocTy> >::iterator I
4188 = ForwardRefValIDs.find(NumberedVals.size());
4189 if (I != ForwardRefValIDs.end()) {
4190 Fn = cast<Function>(I->second.first);
4191 if (Fn->getType() != PFT)
4192 return Error(NameLoc, "type of definition and forward reference of '@" +
4193 Twine(NumberedVals.size()) + "' disagree");
4194 ForwardRefValIDs.erase(I);
4199 Fn = Function::Create(FT, GlobalValue::ExternalLinkage, FunctionName, M);
4200 else // Move the forward-reference to the correct spot in the module.
4201 M->getFunctionList().splice(M->end(), M->getFunctionList(), Fn);
4203 if (FunctionName.empty())
4204 NumberedVals.push_back(Fn);
4206 Fn->setLinkage((GlobalValue::LinkageTypes)Linkage);
4207 Fn->setVisibility((GlobalValue::VisibilityTypes)Visibility);
4208 Fn->setDLLStorageClass((GlobalValue::DLLStorageClassTypes)DLLStorageClass);
4209 Fn->setCallingConv(CC);
4210 Fn->setAttributes(PAL);
4211 Fn->setUnnamedAddr(UnnamedAddr);
4212 Fn->setAlignment(Alignment);
4213 Fn->setSection(Section);
4215 if (!GC.empty()) Fn->setGC(GC.c_str());
4216 Fn->setPrefixData(Prefix);
4217 Fn->setPrologueData(Prologue);
4218 ForwardRefAttrGroups[Fn] = FwdRefAttrGrps;
4220 // Add all of the arguments we parsed to the function.
4221 Function::arg_iterator ArgIt = Fn->arg_begin();
4222 for (unsigned i = 0, e = ArgList.size(); i != e; ++i, ++ArgIt) {
4223 // If the argument has a name, insert it into the argument symbol table.
4224 if (ArgList[i].Name.empty()) continue;
4226 // Set the name, if it conflicted, it will be auto-renamed.
4227 ArgIt->setName(ArgList[i].Name);
4229 if (ArgIt->getName() != ArgList[i].Name)
4230 return Error(ArgList[i].Loc, "redefinition of argument '%" +
4231 ArgList[i].Name + "'");
4237 // Check the declaration has no block address forward references.
4239 if (FunctionName.empty()) {
4240 ID.Kind = ValID::t_GlobalID;
4241 ID.UIntVal = NumberedVals.size() - 1;
4243 ID.Kind = ValID::t_GlobalName;
4244 ID.StrVal = FunctionName;
4246 auto Blocks = ForwardRefBlockAddresses.find(ID);
4247 if (Blocks != ForwardRefBlockAddresses.end())
4248 return Error(Blocks->first.Loc,
4249 "cannot take blockaddress inside a declaration");
4253 bool LLParser::PerFunctionState::resolveForwardRefBlockAddresses() {
4255 if (FunctionNumber == -1) {
4256 ID.Kind = ValID::t_GlobalName;
4257 ID.StrVal = F.getName();
4259 ID.Kind = ValID::t_GlobalID;
4260 ID.UIntVal = FunctionNumber;
4263 auto Blocks = P.ForwardRefBlockAddresses.find(ID);
4264 if (Blocks == P.ForwardRefBlockAddresses.end())
4267 for (const auto &I : Blocks->second) {
4268 const ValID &BBID = I.first;
4269 GlobalValue *GV = I.second;
4271 assert((BBID.Kind == ValID::t_LocalID || BBID.Kind == ValID::t_LocalName) &&
4272 "Expected local id or name");
4274 if (BBID.Kind == ValID::t_LocalName)
4275 BB = GetBB(BBID.StrVal, BBID.Loc);
4277 BB = GetBB(BBID.UIntVal, BBID.Loc);
4279 return P.Error(BBID.Loc, "referenced value is not a basic block");
4281 GV->replaceAllUsesWith(BlockAddress::get(&F, BB));
4282 GV->eraseFromParent();
4285 P.ForwardRefBlockAddresses.erase(Blocks);
4289 /// ParseFunctionBody
4290 /// ::= '{' BasicBlock+ UseListOrderDirective* '}'
4291 bool LLParser::ParseFunctionBody(Function &Fn) {
4292 if (Lex.getKind() != lltok::lbrace)
4293 return TokError("expected '{' in function body");
4294 Lex.Lex(); // eat the {.
4296 int FunctionNumber = -1;
4297 if (!Fn.hasName()) FunctionNumber = NumberedVals.size()-1;
4299 PerFunctionState PFS(*this, Fn, FunctionNumber);
4301 // Resolve block addresses and allow basic blocks to be forward-declared
4302 // within this function.
4303 if (PFS.resolveForwardRefBlockAddresses())
4305 SaveAndRestore<PerFunctionState *> ScopeExit(BlockAddressPFS, &PFS);
4307 // We need at least one basic block.
4308 if (Lex.getKind() == lltok::rbrace || Lex.getKind() == lltok::kw_uselistorder)
4309 return TokError("function body requires at least one basic block");
4311 while (Lex.getKind() != lltok::rbrace &&
4312 Lex.getKind() != lltok::kw_uselistorder)
4313 if (ParseBasicBlock(PFS)) return true;
4315 while (Lex.getKind() != lltok::rbrace)
4316 if (ParseUseListOrder(&PFS))
4322 // Verify function is ok.
4323 return PFS.FinishFunction();
4327 /// ::= LabelStr? Instruction*
4328 bool LLParser::ParseBasicBlock(PerFunctionState &PFS) {
4329 // If this basic block starts out with a name, remember it.
4331 LocTy NameLoc = Lex.getLoc();
4332 if (Lex.getKind() == lltok::LabelStr) {
4333 Name = Lex.getStrVal();
4337 BasicBlock *BB = PFS.DefineBB(Name, NameLoc);
4339 return Error(NameLoc,
4340 "unable to create block named '" + Name + "'");
4342 std::string NameStr;
4344 // Parse the instructions in this block until we get a terminator.
4347 // This instruction may have three possibilities for a name: a) none
4348 // specified, b) name specified "%foo =", c) number specified: "%4 =".
4349 LocTy NameLoc = Lex.getLoc();
4353 if (Lex.getKind() == lltok::LocalVarID) {
4354 NameID = Lex.getUIntVal();
4356 if (ParseToken(lltok::equal, "expected '=' after instruction id"))
4358 } else if (Lex.getKind() == lltok::LocalVar) {
4359 NameStr = Lex.getStrVal();
4361 if (ParseToken(lltok::equal, "expected '=' after instruction name"))
4365 switch (ParseInstruction(Inst, BB, PFS)) {
4366 default: llvm_unreachable("Unknown ParseInstruction result!");
4367 case InstError: return true;
4369 BB->getInstList().push_back(Inst);
4371 // With a normal result, we check to see if the instruction is followed by
4372 // a comma and metadata.
4373 if (EatIfPresent(lltok::comma))
4374 if (ParseInstructionMetadata(Inst, &PFS))
4377 case InstExtraComma:
4378 BB->getInstList().push_back(Inst);
4380 // If the instruction parser ate an extra comma at the end of it, it
4381 // *must* be followed by metadata.
4382 if (ParseInstructionMetadata(Inst, &PFS))
4387 // Set the name on the instruction.
4388 if (PFS.SetInstName(NameID, NameStr, NameLoc, Inst)) return true;
4389 } while (!isa<TerminatorInst>(Inst));
4394 //===----------------------------------------------------------------------===//
4395 // Instruction Parsing.
4396 //===----------------------------------------------------------------------===//
4398 /// ParseInstruction - Parse one of the many different instructions.
4400 int LLParser::ParseInstruction(Instruction *&Inst, BasicBlock *BB,
4401 PerFunctionState &PFS) {
4402 lltok::Kind Token = Lex.getKind();
4403 if (Token == lltok::Eof)
4404 return TokError("found end of file when expecting more instructions");
4405 LocTy Loc = Lex.getLoc();
4406 unsigned KeywordVal = Lex.getUIntVal();
4407 Lex.Lex(); // Eat the keyword.
4410 default: return Error(Loc, "expected instruction opcode");
4411 // Terminator Instructions.
4412 case lltok::kw_unreachable: Inst = new UnreachableInst(Context); return false;
4413 case lltok::kw_ret: return ParseRet(Inst, BB, PFS);
4414 case lltok::kw_br: return ParseBr(Inst, PFS);
4415 case lltok::kw_switch: return ParseSwitch(Inst, PFS);
4416 case lltok::kw_indirectbr: return ParseIndirectBr(Inst, PFS);
4417 case lltok::kw_invoke: return ParseInvoke(Inst, PFS);
4418 case lltok::kw_resume: return ParseResume(Inst, PFS);
4419 // Binary Operators.
4423 case lltok::kw_shl: {
4424 bool NUW = EatIfPresent(lltok::kw_nuw);
4425 bool NSW = EatIfPresent(lltok::kw_nsw);
4426 if (!NUW) NUW = EatIfPresent(lltok::kw_nuw);
4428 if (ParseArithmetic(Inst, PFS, KeywordVal, 1)) return true;
4430 if (NUW) cast<BinaryOperator>(Inst)->setHasNoUnsignedWrap(true);
4431 if (NSW) cast<BinaryOperator>(Inst)->setHasNoSignedWrap(true);
4434 case lltok::kw_fadd:
4435 case lltok::kw_fsub:
4436 case lltok::kw_fmul:
4437 case lltok::kw_fdiv:
4438 case lltok::kw_frem: {
4439 FastMathFlags FMF = EatFastMathFlagsIfPresent();
4440 int Res = ParseArithmetic(Inst, PFS, KeywordVal, 2);
4444 Inst->setFastMathFlags(FMF);
4448 case lltok::kw_sdiv:
4449 case lltok::kw_udiv:
4450 case lltok::kw_lshr:
4451 case lltok::kw_ashr: {
4452 bool Exact = EatIfPresent(lltok::kw_exact);
4454 if (ParseArithmetic(Inst, PFS, KeywordVal, 1)) return true;
4455 if (Exact) cast<BinaryOperator>(Inst)->setIsExact(true);
4459 case lltok::kw_urem:
4460 case lltok::kw_srem: return ParseArithmetic(Inst, PFS, KeywordVal, 1);
4463 case lltok::kw_xor: return ParseLogical(Inst, PFS, KeywordVal);
4464 case lltok::kw_icmp:
4465 case lltok::kw_fcmp: return ParseCompare(Inst, PFS, KeywordVal);
4467 case lltok::kw_trunc:
4468 case lltok::kw_zext:
4469 case lltok::kw_sext:
4470 case lltok::kw_fptrunc:
4471 case lltok::kw_fpext:
4472 case lltok::kw_bitcast:
4473 case lltok::kw_addrspacecast:
4474 case lltok::kw_uitofp:
4475 case lltok::kw_sitofp:
4476 case lltok::kw_fptoui:
4477 case lltok::kw_fptosi:
4478 case lltok::kw_inttoptr:
4479 case lltok::kw_ptrtoint: return ParseCast(Inst, PFS, KeywordVal);
4481 case lltok::kw_select: return ParseSelect(Inst, PFS);
4482 case lltok::kw_va_arg: return ParseVA_Arg(Inst, PFS);
4483 case lltok::kw_extractelement: return ParseExtractElement(Inst, PFS);
4484 case lltok::kw_insertelement: return ParseInsertElement(Inst, PFS);
4485 case lltok::kw_shufflevector: return ParseShuffleVector(Inst, PFS);
4486 case lltok::kw_phi: return ParsePHI(Inst, PFS);
4487 case lltok::kw_landingpad: return ParseLandingPad(Inst, PFS);
4489 case lltok::kw_call: return ParseCall(Inst, PFS, CallInst::TCK_None);
4490 case lltok::kw_tail: return ParseCall(Inst, PFS, CallInst::TCK_Tail);
4491 case lltok::kw_musttail: return ParseCall(Inst, PFS, CallInst::TCK_MustTail);
4493 case lltok::kw_alloca: return ParseAlloc(Inst, PFS);
4494 case lltok::kw_load: return ParseLoad(Inst, PFS);
4495 case lltok::kw_store: return ParseStore(Inst, PFS);
4496 case lltok::kw_cmpxchg: return ParseCmpXchg(Inst, PFS);
4497 case lltok::kw_atomicrmw: return ParseAtomicRMW(Inst, PFS);
4498 case lltok::kw_fence: return ParseFence(Inst, PFS);
4499 case lltok::kw_getelementptr: return ParseGetElementPtr(Inst, PFS);
4500 case lltok::kw_extractvalue: return ParseExtractValue(Inst, PFS);
4501 case lltok::kw_insertvalue: return ParseInsertValue(Inst, PFS);
4505 /// ParseCmpPredicate - Parse an integer or fp predicate, based on Kind.
4506 bool LLParser::ParseCmpPredicate(unsigned &P, unsigned Opc) {
4507 if (Opc == Instruction::FCmp) {
4508 switch (Lex.getKind()) {
4509 default: return TokError("expected fcmp predicate (e.g. 'oeq')");
4510 case lltok::kw_oeq: P = CmpInst::FCMP_OEQ; break;
4511 case lltok::kw_one: P = CmpInst::FCMP_ONE; break;
4512 case lltok::kw_olt: P = CmpInst::FCMP_OLT; break;
4513 case lltok::kw_ogt: P = CmpInst::FCMP_OGT; break;
4514 case lltok::kw_ole: P = CmpInst::FCMP_OLE; break;
4515 case lltok::kw_oge: P = CmpInst::FCMP_OGE; break;
4516 case lltok::kw_ord: P = CmpInst::FCMP_ORD; break;
4517 case lltok::kw_uno: P = CmpInst::FCMP_UNO; break;
4518 case lltok::kw_ueq: P = CmpInst::FCMP_UEQ; break;
4519 case lltok::kw_une: P = CmpInst::FCMP_UNE; break;
4520 case lltok::kw_ult: P = CmpInst::FCMP_ULT; break;
4521 case lltok::kw_ugt: P = CmpInst::FCMP_UGT; break;
4522 case lltok::kw_ule: P = CmpInst::FCMP_ULE; break;
4523 case lltok::kw_uge: P = CmpInst::FCMP_UGE; break;
4524 case lltok::kw_true: P = CmpInst::FCMP_TRUE; break;
4525 case lltok::kw_false: P = CmpInst::FCMP_FALSE; break;
4528 switch (Lex.getKind()) {
4529 default: return TokError("expected icmp predicate (e.g. 'eq')");
4530 case lltok::kw_eq: P = CmpInst::ICMP_EQ; break;
4531 case lltok::kw_ne: P = CmpInst::ICMP_NE; break;
4532 case lltok::kw_slt: P = CmpInst::ICMP_SLT; break;
4533 case lltok::kw_sgt: P = CmpInst::ICMP_SGT; break;
4534 case lltok::kw_sle: P = CmpInst::ICMP_SLE; break;
4535 case lltok::kw_sge: P = CmpInst::ICMP_SGE; break;
4536 case lltok::kw_ult: P = CmpInst::ICMP_ULT; break;
4537 case lltok::kw_ugt: P = CmpInst::ICMP_UGT; break;
4538 case lltok::kw_ule: P = CmpInst::ICMP_ULE; break;
4539 case lltok::kw_uge: P = CmpInst::ICMP_UGE; break;
4546 //===----------------------------------------------------------------------===//
4547 // Terminator Instructions.
4548 //===----------------------------------------------------------------------===//
4550 /// ParseRet - Parse a return instruction.
4551 /// ::= 'ret' void (',' !dbg, !1)*
4552 /// ::= 'ret' TypeAndValue (',' !dbg, !1)*
4553 bool LLParser::ParseRet(Instruction *&Inst, BasicBlock *BB,
4554 PerFunctionState &PFS) {
4555 SMLoc TypeLoc = Lex.getLoc();
4557 if (ParseType(Ty, true /*void allowed*/)) return true;
4559 Type *ResType = PFS.getFunction().getReturnType();
4561 if (Ty->isVoidTy()) {
4562 if (!ResType->isVoidTy())
4563 return Error(TypeLoc, "value doesn't match function result type '" +
4564 getTypeString(ResType) + "'");
4566 Inst = ReturnInst::Create(Context);
4571 if (ParseValue(Ty, RV, PFS)) return true;
4573 if (ResType != RV->getType())
4574 return Error(TypeLoc, "value doesn't match function result type '" +
4575 getTypeString(ResType) + "'");
4577 Inst = ReturnInst::Create(Context, RV);
4583 /// ::= 'br' TypeAndValue
4584 /// ::= 'br' TypeAndValue ',' TypeAndValue ',' TypeAndValue
4585 bool LLParser::ParseBr(Instruction *&Inst, PerFunctionState &PFS) {
4588 BasicBlock *Op1, *Op2;
4589 if (ParseTypeAndValue(Op0, Loc, PFS)) return true;
4591 if (BasicBlock *BB = dyn_cast<BasicBlock>(Op0)) {
4592 Inst = BranchInst::Create(BB);
4596 if (Op0->getType() != Type::getInt1Ty(Context))
4597 return Error(Loc, "branch condition must have 'i1' type");
4599 if (ParseToken(lltok::comma, "expected ',' after branch condition") ||
4600 ParseTypeAndBasicBlock(Op1, Loc, PFS) ||
4601 ParseToken(lltok::comma, "expected ',' after true destination") ||
4602 ParseTypeAndBasicBlock(Op2, Loc2, PFS))
4605 Inst = BranchInst::Create(Op1, Op2, Op0);
4611 /// ::= 'switch' TypeAndValue ',' TypeAndValue '[' JumpTable ']'
4613 /// ::= (TypeAndValue ',' TypeAndValue)*
4614 bool LLParser::ParseSwitch(Instruction *&Inst, PerFunctionState &PFS) {
4615 LocTy CondLoc, BBLoc;
4617 BasicBlock *DefaultBB;
4618 if (ParseTypeAndValue(Cond, CondLoc, PFS) ||
4619 ParseToken(lltok::comma, "expected ',' after switch condition") ||
4620 ParseTypeAndBasicBlock(DefaultBB, BBLoc, PFS) ||
4621 ParseToken(lltok::lsquare, "expected '[' with switch table"))
4624 if (!Cond->getType()->isIntegerTy())
4625 return Error(CondLoc, "switch condition must have integer type");
4627 // Parse the jump table pairs.
4628 SmallPtrSet<Value*, 32> SeenCases;
4629 SmallVector<std::pair<ConstantInt*, BasicBlock*>, 32> Table;
4630 while (Lex.getKind() != lltok::rsquare) {
4634 if (ParseTypeAndValue(Constant, CondLoc, PFS) ||
4635 ParseToken(lltok::comma, "expected ',' after case value") ||
4636 ParseTypeAndBasicBlock(DestBB, PFS))
4639 if (!SeenCases.insert(Constant).second)
4640 return Error(CondLoc, "duplicate case value in switch");
4641 if (!isa<ConstantInt>(Constant))
4642 return Error(CondLoc, "case value is not a constant integer");
4644 Table.push_back(std::make_pair(cast<ConstantInt>(Constant), DestBB));
4647 Lex.Lex(); // Eat the ']'.
4649 SwitchInst *SI = SwitchInst::Create(Cond, DefaultBB, Table.size());
4650 for (unsigned i = 0, e = Table.size(); i != e; ++i)
4651 SI->addCase(Table[i].first, Table[i].second);
4658 /// ::= 'indirectbr' TypeAndValue ',' '[' LabelList ']'
4659 bool LLParser::ParseIndirectBr(Instruction *&Inst, PerFunctionState &PFS) {
4662 if (ParseTypeAndValue(Address, AddrLoc, PFS) ||
4663 ParseToken(lltok::comma, "expected ',' after indirectbr address") ||
4664 ParseToken(lltok::lsquare, "expected '[' with indirectbr"))
4667 if (!Address->getType()->isPointerTy())
4668 return Error(AddrLoc, "indirectbr address must have pointer type");
4670 // Parse the destination list.
4671 SmallVector<BasicBlock*, 16> DestList;
4673 if (Lex.getKind() != lltok::rsquare) {
4675 if (ParseTypeAndBasicBlock(DestBB, PFS))
4677 DestList.push_back(DestBB);
4679 while (EatIfPresent(lltok::comma)) {
4680 if (ParseTypeAndBasicBlock(DestBB, PFS))
4682 DestList.push_back(DestBB);
4686 if (ParseToken(lltok::rsquare, "expected ']' at end of block list"))
4689 IndirectBrInst *IBI = IndirectBrInst::Create(Address, DestList.size());
4690 for (unsigned i = 0, e = DestList.size(); i != e; ++i)
4691 IBI->addDestination(DestList[i]);
4698 /// ::= 'invoke' OptionalCallingConv OptionalAttrs Type Value ParamList
4699 /// OptionalAttrs 'to' TypeAndValue 'unwind' TypeAndValue
4700 bool LLParser::ParseInvoke(Instruction *&Inst, PerFunctionState &PFS) {
4701 LocTy CallLoc = Lex.getLoc();
4702 AttrBuilder RetAttrs, FnAttrs;
4703 std::vector<unsigned> FwdRefAttrGrps;
4706 Type *RetType = nullptr;
4709 SmallVector<ParamInfo, 16> ArgList;
4711 BasicBlock *NormalBB, *UnwindBB;
4712 if (ParseOptionalCallingConv(CC) ||
4713 ParseOptionalReturnAttrs(RetAttrs) ||
4714 ParseType(RetType, RetTypeLoc, true /*void allowed*/) ||
4715 ParseValID(CalleeID) ||
4716 ParseParameterList(ArgList, PFS) ||
4717 ParseFnAttributeValuePairs(FnAttrs, FwdRefAttrGrps, false,
4719 ParseToken(lltok::kw_to, "expected 'to' in invoke") ||
4720 ParseTypeAndBasicBlock(NormalBB, PFS) ||
4721 ParseToken(lltok::kw_unwind, "expected 'unwind' in invoke") ||
4722 ParseTypeAndBasicBlock(UnwindBB, PFS))
4725 // If RetType is a non-function pointer type, then this is the short syntax
4726 // for the call, which means that RetType is just the return type. Infer the
4727 // rest of the function argument types from the arguments that are present.
4728 PointerType *PFTy = nullptr;
4729 FunctionType *Ty = nullptr;
4730 if (!(PFTy = dyn_cast<PointerType>(RetType)) ||
4731 !(Ty = dyn_cast<FunctionType>(PFTy->getElementType()))) {
4732 // Pull out the types of all of the arguments...
4733 std::vector<Type*> ParamTypes;
4734 for (unsigned i = 0, e = ArgList.size(); i != e; ++i)
4735 ParamTypes.push_back(ArgList[i].V->getType());
4737 if (!FunctionType::isValidReturnType(RetType))
4738 return Error(RetTypeLoc, "Invalid result type for LLVM function");
4740 Ty = FunctionType::get(RetType, ParamTypes, false);
4741 PFTy = PointerType::getUnqual(Ty);
4744 // Look up the callee.
4746 if (ConvertValIDToValue(PFTy, CalleeID, Callee, &PFS)) return true;
4748 // Set up the Attribute for the function.
4749 SmallVector<AttributeSet, 8> Attrs;
4750 if (RetAttrs.hasAttributes())
4751 Attrs.push_back(AttributeSet::get(RetType->getContext(),
4752 AttributeSet::ReturnIndex,
4755 SmallVector<Value*, 8> Args;
4757 // Loop through FunctionType's arguments and ensure they are specified
4758 // correctly. Also, gather any parameter attributes.
4759 FunctionType::param_iterator I = Ty->param_begin();
4760 FunctionType::param_iterator E = Ty->param_end();
4761 for (unsigned i = 0, e = ArgList.size(); i != e; ++i) {
4762 Type *ExpectedTy = nullptr;
4765 } else if (!Ty->isVarArg()) {
4766 return Error(ArgList[i].Loc, "too many arguments specified");
4769 if (ExpectedTy && ExpectedTy != ArgList[i].V->getType())
4770 return Error(ArgList[i].Loc, "argument is not of expected type '" +
4771 getTypeString(ExpectedTy) + "'");
4772 Args.push_back(ArgList[i].V);
4773 if (ArgList[i].Attrs.hasAttributes(i + 1)) {
4774 AttrBuilder B(ArgList[i].Attrs, i + 1);
4775 Attrs.push_back(AttributeSet::get(RetType->getContext(), i + 1, B));
4780 return Error(CallLoc, "not enough parameters specified for call");
4782 if (FnAttrs.hasAttributes()) {
4783 if (FnAttrs.hasAlignmentAttr())
4784 return Error(CallLoc, "invoke instructions may not have an alignment");
4786 Attrs.push_back(AttributeSet::get(RetType->getContext(),
4787 AttributeSet::FunctionIndex,
4791 // Finish off the Attribute and check them
4792 AttributeSet PAL = AttributeSet::get(Context, Attrs);
4794 InvokeInst *II = InvokeInst::Create(Callee, NormalBB, UnwindBB, Args);
4795 II->setCallingConv(CC);
4796 II->setAttributes(PAL);
4797 ForwardRefAttrGroups[II] = FwdRefAttrGrps;
4803 /// ::= 'resume' TypeAndValue
4804 bool LLParser::ParseResume(Instruction *&Inst, PerFunctionState &PFS) {
4805 Value *Exn; LocTy ExnLoc;
4806 if (ParseTypeAndValue(Exn, ExnLoc, PFS))
4809 ResumeInst *RI = ResumeInst::Create(Exn);
4814 //===----------------------------------------------------------------------===//
4815 // Binary Operators.
4816 //===----------------------------------------------------------------------===//
4819 /// ::= ArithmeticOps TypeAndValue ',' Value
4821 /// If OperandType is 0, then any FP or integer operand is allowed. If it is 1,
4822 /// then any integer operand is allowed, if it is 2, any fp operand is allowed.
4823 bool LLParser::ParseArithmetic(Instruction *&Inst, PerFunctionState &PFS,
4824 unsigned Opc, unsigned OperandType) {
4825 LocTy Loc; Value *LHS, *RHS;
4826 if (ParseTypeAndValue(LHS, Loc, PFS) ||
4827 ParseToken(lltok::comma, "expected ',' in arithmetic operation") ||
4828 ParseValue(LHS->getType(), RHS, PFS))
4832 switch (OperandType) {
4833 default: llvm_unreachable("Unknown operand type!");
4834 case 0: // int or FP.
4835 Valid = LHS->getType()->isIntOrIntVectorTy() ||
4836 LHS->getType()->isFPOrFPVectorTy();
4838 case 1: Valid = LHS->getType()->isIntOrIntVectorTy(); break;
4839 case 2: Valid = LHS->getType()->isFPOrFPVectorTy(); break;
4843 return Error(Loc, "invalid operand type for instruction");
4845 Inst = BinaryOperator::Create((Instruction::BinaryOps)Opc, LHS, RHS);
4850 /// ::= ArithmeticOps TypeAndValue ',' Value {
4851 bool LLParser::ParseLogical(Instruction *&Inst, PerFunctionState &PFS,
4853 LocTy Loc; Value *LHS, *RHS;
4854 if (ParseTypeAndValue(LHS, Loc, PFS) ||
4855 ParseToken(lltok::comma, "expected ',' in logical operation") ||
4856 ParseValue(LHS->getType(), RHS, PFS))
4859 if (!LHS->getType()->isIntOrIntVectorTy())
4860 return Error(Loc,"instruction requires integer or integer vector operands");
4862 Inst = BinaryOperator::Create((Instruction::BinaryOps)Opc, LHS, RHS);
4868 /// ::= 'icmp' IPredicates TypeAndValue ',' Value
4869 /// ::= 'fcmp' FPredicates TypeAndValue ',' Value
4870 bool LLParser::ParseCompare(Instruction *&Inst, PerFunctionState &PFS,
4872 // Parse the integer/fp comparison predicate.
4876 if (ParseCmpPredicate(Pred, Opc) ||
4877 ParseTypeAndValue(LHS, Loc, PFS) ||
4878 ParseToken(lltok::comma, "expected ',' after compare value") ||
4879 ParseValue(LHS->getType(), RHS, PFS))
4882 if (Opc == Instruction::FCmp) {
4883 if (!LHS->getType()->isFPOrFPVectorTy())
4884 return Error(Loc, "fcmp requires floating point operands");
4885 Inst = new FCmpInst(CmpInst::Predicate(Pred), LHS, RHS);
4887 assert(Opc == Instruction::ICmp && "Unknown opcode for CmpInst!");
4888 if (!LHS->getType()->isIntOrIntVectorTy() &&
4889 !LHS->getType()->getScalarType()->isPointerTy())
4890 return Error(Loc, "icmp requires integer operands");
4891 Inst = new ICmpInst(CmpInst::Predicate(Pred), LHS, RHS);
4896 //===----------------------------------------------------------------------===//
4897 // Other Instructions.
4898 //===----------------------------------------------------------------------===//
4902 /// ::= CastOpc TypeAndValue 'to' Type
4903 bool LLParser::ParseCast(Instruction *&Inst, PerFunctionState &PFS,
4907 Type *DestTy = nullptr;
4908 if (ParseTypeAndValue(Op, Loc, PFS) ||
4909 ParseToken(lltok::kw_to, "expected 'to' after cast value") ||
4913 if (!CastInst::castIsValid((Instruction::CastOps)Opc, Op, DestTy)) {
4914 CastInst::castIsValid((Instruction::CastOps)Opc, Op, DestTy);
4915 return Error(Loc, "invalid cast opcode for cast from '" +
4916 getTypeString(Op->getType()) + "' to '" +
4917 getTypeString(DestTy) + "'");
4919 Inst = CastInst::Create((Instruction::CastOps)Opc, Op, DestTy);
4924 /// ::= 'select' TypeAndValue ',' TypeAndValue ',' TypeAndValue
4925 bool LLParser::ParseSelect(Instruction *&Inst, PerFunctionState &PFS) {
4927 Value *Op0, *Op1, *Op2;
4928 if (ParseTypeAndValue(Op0, Loc, PFS) ||
4929 ParseToken(lltok::comma, "expected ',' after select condition") ||
4930 ParseTypeAndValue(Op1, PFS) ||
4931 ParseToken(lltok::comma, "expected ',' after select value") ||
4932 ParseTypeAndValue(Op2, PFS))
4935 if (const char *Reason = SelectInst::areInvalidOperands(Op0, Op1, Op2))
4936 return Error(Loc, Reason);
4938 Inst = SelectInst::Create(Op0, Op1, Op2);
4943 /// ::= 'va_arg' TypeAndValue ',' Type
4944 bool LLParser::ParseVA_Arg(Instruction *&Inst, PerFunctionState &PFS) {
4946 Type *EltTy = nullptr;
4948 if (ParseTypeAndValue(Op, PFS) ||
4949 ParseToken(lltok::comma, "expected ',' after vaarg operand") ||
4950 ParseType(EltTy, TypeLoc))
4953 if (!EltTy->isFirstClassType())
4954 return Error(TypeLoc, "va_arg requires operand with first class type");
4956 Inst = new VAArgInst(Op, EltTy);
4960 /// ParseExtractElement
4961 /// ::= 'extractelement' TypeAndValue ',' TypeAndValue
4962 bool LLParser::ParseExtractElement(Instruction *&Inst, PerFunctionState &PFS) {
4965 if (ParseTypeAndValue(Op0, Loc, PFS) ||
4966 ParseToken(lltok::comma, "expected ',' after extract value") ||
4967 ParseTypeAndValue(Op1, PFS))
4970 if (!ExtractElementInst::isValidOperands(Op0, Op1))
4971 return Error(Loc, "invalid extractelement operands");
4973 Inst = ExtractElementInst::Create(Op0, Op1);
4977 /// ParseInsertElement
4978 /// ::= 'insertelement' TypeAndValue ',' TypeAndValue ',' TypeAndValue
4979 bool LLParser::ParseInsertElement(Instruction *&Inst, PerFunctionState &PFS) {
4981 Value *Op0, *Op1, *Op2;
4982 if (ParseTypeAndValue(Op0, Loc, PFS) ||
4983 ParseToken(lltok::comma, "expected ',' after insertelement value") ||
4984 ParseTypeAndValue(Op1, PFS) ||
4985 ParseToken(lltok::comma, "expected ',' after insertelement value") ||
4986 ParseTypeAndValue(Op2, PFS))
4989 if (!InsertElementInst::isValidOperands(Op0, Op1, Op2))
4990 return Error(Loc, "invalid insertelement operands");
4992 Inst = InsertElementInst::Create(Op0, Op1, Op2);
4996 /// ParseShuffleVector
4997 /// ::= 'shufflevector' TypeAndValue ',' TypeAndValue ',' TypeAndValue
4998 bool LLParser::ParseShuffleVector(Instruction *&Inst, PerFunctionState &PFS) {
5000 Value *Op0, *Op1, *Op2;
5001 if (ParseTypeAndValue(Op0, Loc, PFS) ||
5002 ParseToken(lltok::comma, "expected ',' after shuffle mask") ||
5003 ParseTypeAndValue(Op1, PFS) ||
5004 ParseToken(lltok::comma, "expected ',' after shuffle value") ||
5005 ParseTypeAndValue(Op2, PFS))
5008 if (!ShuffleVectorInst::isValidOperands(Op0, Op1, Op2))
5009 return Error(Loc, "invalid shufflevector operands");
5011 Inst = new ShuffleVectorInst(Op0, Op1, Op2);
5016 /// ::= 'phi' Type '[' Value ',' Value ']' (',' '[' Value ',' Value ']')*
5017 int LLParser::ParsePHI(Instruction *&Inst, PerFunctionState &PFS) {
5018 Type *Ty = nullptr; LocTy TypeLoc;
5021 if (ParseType(Ty, TypeLoc) ||
5022 ParseToken(lltok::lsquare, "expected '[' in phi value list") ||
5023 ParseValue(Ty, Op0, PFS) ||
5024 ParseToken(lltok::comma, "expected ',' after insertelement value") ||
5025 ParseValue(Type::getLabelTy(Context), Op1, PFS) ||
5026 ParseToken(lltok::rsquare, "expected ']' in phi value list"))
5029 bool AteExtraComma = false;
5030 SmallVector<std::pair<Value*, BasicBlock*>, 16> PHIVals;
5032 PHIVals.push_back(std::make_pair(Op0, cast<BasicBlock>(Op1)));
5034 if (!EatIfPresent(lltok::comma))
5037 if (Lex.getKind() == lltok::MetadataVar) {
5038 AteExtraComma = true;
5042 if (ParseToken(lltok::lsquare, "expected '[' in phi value list") ||
5043 ParseValue(Ty, Op0, PFS) ||
5044 ParseToken(lltok::comma, "expected ',' after insertelement value") ||
5045 ParseValue(Type::getLabelTy(Context), Op1, PFS) ||
5046 ParseToken(lltok::rsquare, "expected ']' in phi value list"))
5050 if (!Ty->isFirstClassType())
5051 return Error(TypeLoc, "phi node must have first class type");
5053 PHINode *PN = PHINode::Create(Ty, PHIVals.size());
5054 for (unsigned i = 0, e = PHIVals.size(); i != e; ++i)
5055 PN->addIncoming(PHIVals[i].first, PHIVals[i].second);
5057 return AteExtraComma ? InstExtraComma : InstNormal;
5061 /// ::= 'landingpad' Type 'personality' TypeAndValue 'cleanup'? Clause+
5063 /// ::= 'catch' TypeAndValue
5065 /// ::= 'filter' TypeAndValue ( ',' TypeAndValue )*
5066 bool LLParser::ParseLandingPad(Instruction *&Inst, PerFunctionState &PFS) {
5067 Type *Ty = nullptr; LocTy TyLoc;
5068 Value *PersFn; LocTy PersFnLoc;
5070 if (ParseType(Ty, TyLoc) ||
5071 ParseToken(lltok::kw_personality, "expected 'personality'") ||
5072 ParseTypeAndValue(PersFn, PersFnLoc, PFS))
5075 std::unique_ptr<LandingPadInst> LP(LandingPadInst::Create(Ty, PersFn, 0));
5076 LP->setCleanup(EatIfPresent(lltok::kw_cleanup));
5078 while (Lex.getKind() == lltok::kw_catch || Lex.getKind() == lltok::kw_filter){
5079 LandingPadInst::ClauseType CT;
5080 if (EatIfPresent(lltok::kw_catch))
5081 CT = LandingPadInst::Catch;
5082 else if (EatIfPresent(lltok::kw_filter))
5083 CT = LandingPadInst::Filter;
5085 return TokError("expected 'catch' or 'filter' clause type");
5089 if (ParseTypeAndValue(V, VLoc, PFS))
5092 // A 'catch' type expects a non-array constant. A filter clause expects an
5094 if (CT == LandingPadInst::Catch) {
5095 if (isa<ArrayType>(V->getType()))
5096 Error(VLoc, "'catch' clause has an invalid type");
5098 if (!isa<ArrayType>(V->getType()))
5099 Error(VLoc, "'filter' clause has an invalid type");
5102 Constant *CV = dyn_cast<Constant>(V);
5104 return Error(VLoc, "clause argument must be a constant");
5108 Inst = LP.release();
5113 /// ::= 'call' OptionalCallingConv OptionalAttrs Type Value
5114 /// ParameterList OptionalAttrs
5115 /// ::= 'tail' 'call' OptionalCallingConv OptionalAttrs Type Value
5116 /// ParameterList OptionalAttrs
5117 /// ::= 'musttail' 'call' OptionalCallingConv OptionalAttrs Type Value
5118 /// ParameterList OptionalAttrs
5119 bool LLParser::ParseCall(Instruction *&Inst, PerFunctionState &PFS,
5120 CallInst::TailCallKind TCK) {
5121 AttrBuilder RetAttrs, FnAttrs;
5122 std::vector<unsigned> FwdRefAttrGrps;
5125 Type *RetType = nullptr;
5128 SmallVector<ParamInfo, 16> ArgList;
5129 LocTy CallLoc = Lex.getLoc();
5131 if ((TCK != CallInst::TCK_None &&
5132 ParseToken(lltok::kw_call, "expected 'tail call'")) ||
5133 ParseOptionalCallingConv(CC) ||
5134 ParseOptionalReturnAttrs(RetAttrs) ||
5135 ParseType(RetType, RetTypeLoc, true /*void allowed*/) ||
5136 ParseValID(CalleeID) ||
5137 ParseParameterList(ArgList, PFS, TCK == CallInst::TCK_MustTail,
5138 PFS.getFunction().isVarArg()) ||
5139 ParseFnAttributeValuePairs(FnAttrs, FwdRefAttrGrps, false,
5143 // If RetType is a non-function pointer type, then this is the short syntax
5144 // for the call, which means that RetType is just the return type. Infer the
5145 // rest of the function argument types from the arguments that are present.
5146 PointerType *PFTy = nullptr;
5147 FunctionType *Ty = nullptr;
5148 if (!(PFTy = dyn_cast<PointerType>(RetType)) ||
5149 !(Ty = dyn_cast<FunctionType>(PFTy->getElementType()))) {
5150 // Pull out the types of all of the arguments...
5151 std::vector<Type*> ParamTypes;
5152 for (unsigned i = 0, e = ArgList.size(); i != e; ++i)
5153 ParamTypes.push_back(ArgList[i].V->getType());
5155 if (!FunctionType::isValidReturnType(RetType))
5156 return Error(RetTypeLoc, "Invalid result type for LLVM function");
5158 Ty = FunctionType::get(RetType, ParamTypes, false);
5159 PFTy = PointerType::getUnqual(Ty);
5162 // Look up the callee.
5164 if (ConvertValIDToValue(PFTy, CalleeID, Callee, &PFS)) return true;
5166 // Set up the Attribute for the function.
5167 SmallVector<AttributeSet, 8> Attrs;
5168 if (RetAttrs.hasAttributes())
5169 Attrs.push_back(AttributeSet::get(RetType->getContext(),
5170 AttributeSet::ReturnIndex,
5173 SmallVector<Value*, 8> Args;
5175 // Loop through FunctionType's arguments and ensure they are specified
5176 // correctly. Also, gather any parameter attributes.
5177 FunctionType::param_iterator I = Ty->param_begin();
5178 FunctionType::param_iterator E = Ty->param_end();
5179 for (unsigned i = 0, e = ArgList.size(); i != e; ++i) {
5180 Type *ExpectedTy = nullptr;
5183 } else if (!Ty->isVarArg()) {
5184 return Error(ArgList[i].Loc, "too many arguments specified");
5187 if (ExpectedTy && ExpectedTy != ArgList[i].V->getType())
5188 return Error(ArgList[i].Loc, "argument is not of expected type '" +
5189 getTypeString(ExpectedTy) + "'");
5190 Args.push_back(ArgList[i].V);
5191 if (ArgList[i].Attrs.hasAttributes(i + 1)) {
5192 AttrBuilder B(ArgList[i].Attrs, i + 1);
5193 Attrs.push_back(AttributeSet::get(RetType->getContext(), i + 1, B));
5198 return Error(CallLoc, "not enough parameters specified for call");
5200 if (FnAttrs.hasAttributes()) {
5201 if (FnAttrs.hasAlignmentAttr())
5202 return Error(CallLoc, "call instructions may not have an alignment");
5204 Attrs.push_back(AttributeSet::get(RetType->getContext(),
5205 AttributeSet::FunctionIndex,
5209 // Finish off the Attribute and check them
5210 AttributeSet PAL = AttributeSet::get(Context, Attrs);
5212 CallInst *CI = CallInst::Create(Callee, Args);
5213 CI->setTailCallKind(TCK);
5214 CI->setCallingConv(CC);
5215 CI->setAttributes(PAL);
5216 ForwardRefAttrGroups[CI] = FwdRefAttrGrps;
5221 //===----------------------------------------------------------------------===//
5222 // Memory Instructions.
5223 //===----------------------------------------------------------------------===//
5226 /// ::= 'alloca' 'inalloca'? Type (',' TypeAndValue)? (',' 'align' i32)?
5227 int LLParser::ParseAlloc(Instruction *&Inst, PerFunctionState &PFS) {
5228 Value *Size = nullptr;
5229 LocTy SizeLoc, TyLoc;
5230 unsigned Alignment = 0;
5233 bool IsInAlloca = EatIfPresent(lltok::kw_inalloca);
5235 if (ParseType(Ty, TyLoc)) return true;
5237 if (Ty->isFunctionTy() || !PointerType::isValidElementType(Ty))
5238 return Error(TyLoc, "invalid type for alloca");
5240 bool AteExtraComma = false;
5241 if (EatIfPresent(lltok::comma)) {
5242 if (Lex.getKind() == lltok::kw_align) {
5243 if (ParseOptionalAlignment(Alignment)) return true;
5244 } else if (Lex.getKind() == lltok::MetadataVar) {
5245 AteExtraComma = true;
5247 if (ParseTypeAndValue(Size, SizeLoc, PFS) ||
5248 ParseOptionalCommaAlign(Alignment, AteExtraComma))
5253 if (Size && !Size->getType()->isIntegerTy())
5254 return Error(SizeLoc, "element count must have integer type");
5256 AllocaInst *AI = new AllocaInst(Ty, Size, Alignment);
5257 AI->setUsedWithInAlloca(IsInAlloca);
5259 return AteExtraComma ? InstExtraComma : InstNormal;
5263 /// ::= 'load' 'volatile'? TypeAndValue (',' 'align' i32)?
5264 /// ::= 'load' 'atomic' 'volatile'? TypeAndValue
5265 /// 'singlethread'? AtomicOrdering (',' 'align' i32)?
5266 int LLParser::ParseLoad(Instruction *&Inst, PerFunctionState &PFS) {
5267 Value *Val; LocTy Loc;
5268 unsigned Alignment = 0;
5269 bool AteExtraComma = false;
5270 bool isAtomic = false;
5271 AtomicOrdering Ordering = NotAtomic;
5272 SynchronizationScope Scope = CrossThread;
5274 if (Lex.getKind() == lltok::kw_atomic) {
5279 bool isVolatile = false;
5280 if (Lex.getKind() == lltok::kw_volatile) {
5286 LocTy ExplicitTypeLoc = Lex.getLoc();
5287 if (ParseType(Ty) ||
5288 ParseToken(lltok::comma, "expected comma after load's type") ||
5289 ParseTypeAndValue(Val, Loc, PFS) ||
5290 ParseScopeAndOrdering(isAtomic, Scope, Ordering) ||
5291 ParseOptionalCommaAlign(Alignment, AteExtraComma))
5294 if (!Val->getType()->isPointerTy() ||
5295 !cast<PointerType>(Val->getType())->getElementType()->isFirstClassType())
5296 return Error(Loc, "load operand must be a pointer to a first class type");
5297 if (isAtomic && !Alignment)
5298 return Error(Loc, "atomic load must have explicit non-zero alignment");
5299 if (Ordering == Release || Ordering == AcquireRelease)
5300 return Error(Loc, "atomic load cannot use Release ordering");
5302 if (Ty != cast<PointerType>(Val->getType())->getElementType())
5303 return Error(ExplicitTypeLoc,
5304 "explicit pointee type doesn't match operand's pointee type");
5306 Inst = new LoadInst(Val, "", isVolatile, Alignment, Ordering, Scope);
5307 return AteExtraComma ? InstExtraComma : InstNormal;
5312 /// ::= 'store' 'volatile'? TypeAndValue ',' TypeAndValue (',' 'align' i32)?
5313 /// ::= 'store' 'atomic' 'volatile'? TypeAndValue ',' TypeAndValue
5314 /// 'singlethread'? AtomicOrdering (',' 'align' i32)?
5315 int LLParser::ParseStore(Instruction *&Inst, PerFunctionState &PFS) {
5316 Value *Val, *Ptr; LocTy Loc, PtrLoc;
5317 unsigned Alignment = 0;
5318 bool AteExtraComma = false;
5319 bool isAtomic = false;
5320 AtomicOrdering Ordering = NotAtomic;
5321 SynchronizationScope Scope = CrossThread;
5323 if (Lex.getKind() == lltok::kw_atomic) {
5328 bool isVolatile = false;
5329 if (Lex.getKind() == lltok::kw_volatile) {
5334 if (ParseTypeAndValue(Val, Loc, PFS) ||
5335 ParseToken(lltok::comma, "expected ',' after store operand") ||
5336 ParseTypeAndValue(Ptr, PtrLoc, PFS) ||
5337 ParseScopeAndOrdering(isAtomic, Scope, Ordering) ||
5338 ParseOptionalCommaAlign(Alignment, AteExtraComma))
5341 if (!Ptr->getType()->isPointerTy())
5342 return Error(PtrLoc, "store operand must be a pointer");
5343 if (!Val->getType()->isFirstClassType())
5344 return Error(Loc, "store operand must be a first class value");
5345 if (cast<PointerType>(Ptr->getType())->getElementType() != Val->getType())
5346 return Error(Loc, "stored value and pointer type do not match");
5347 if (isAtomic && !Alignment)
5348 return Error(Loc, "atomic store must have explicit non-zero alignment");
5349 if (Ordering == Acquire || Ordering == AcquireRelease)
5350 return Error(Loc, "atomic store cannot use Acquire ordering");
5352 Inst = new StoreInst(Val, Ptr, isVolatile, Alignment, Ordering, Scope);
5353 return AteExtraComma ? InstExtraComma : InstNormal;
5357 /// ::= 'cmpxchg' 'weak'? 'volatile'? TypeAndValue ',' TypeAndValue ','
5358 /// TypeAndValue 'singlethread'? AtomicOrdering AtomicOrdering
5359 int LLParser::ParseCmpXchg(Instruction *&Inst, PerFunctionState &PFS) {
5360 Value *Ptr, *Cmp, *New; LocTy PtrLoc, CmpLoc, NewLoc;
5361 bool AteExtraComma = false;
5362 AtomicOrdering SuccessOrdering = NotAtomic;
5363 AtomicOrdering FailureOrdering = NotAtomic;
5364 SynchronizationScope Scope = CrossThread;
5365 bool isVolatile = false;
5366 bool isWeak = false;
5368 if (EatIfPresent(lltok::kw_weak))
5371 if (EatIfPresent(lltok::kw_volatile))
5374 if (ParseTypeAndValue(Ptr, PtrLoc, PFS) ||
5375 ParseToken(lltok::comma, "expected ',' after cmpxchg address") ||
5376 ParseTypeAndValue(Cmp, CmpLoc, PFS) ||
5377 ParseToken(lltok::comma, "expected ',' after cmpxchg cmp operand") ||
5378 ParseTypeAndValue(New, NewLoc, PFS) ||
5379 ParseScopeAndOrdering(true /*Always atomic*/, Scope, SuccessOrdering) ||
5380 ParseOrdering(FailureOrdering))
5383 if (SuccessOrdering == Unordered || FailureOrdering == Unordered)
5384 return TokError("cmpxchg cannot be unordered");
5385 if (SuccessOrdering < FailureOrdering)
5386 return TokError("cmpxchg must be at least as ordered on success as failure");
5387 if (FailureOrdering == Release || FailureOrdering == AcquireRelease)
5388 return TokError("cmpxchg failure ordering cannot include release semantics");
5389 if (!Ptr->getType()->isPointerTy())
5390 return Error(PtrLoc, "cmpxchg operand must be a pointer");
5391 if (cast<PointerType>(Ptr->getType())->getElementType() != Cmp->getType())
5392 return Error(CmpLoc, "compare value and pointer type do not match");
5393 if (cast<PointerType>(Ptr->getType())->getElementType() != New->getType())
5394 return Error(NewLoc, "new value and pointer type do not match");
5395 if (!New->getType()->isIntegerTy())
5396 return Error(NewLoc, "cmpxchg operand must be an integer");
5397 unsigned Size = New->getType()->getPrimitiveSizeInBits();
5398 if (Size < 8 || (Size & (Size - 1)))
5399 return Error(NewLoc, "cmpxchg operand must be power-of-two byte-sized"
5402 AtomicCmpXchgInst *CXI = new AtomicCmpXchgInst(
5403 Ptr, Cmp, New, SuccessOrdering, FailureOrdering, Scope);
5404 CXI->setVolatile(isVolatile);
5405 CXI->setWeak(isWeak);
5407 return AteExtraComma ? InstExtraComma : InstNormal;
5411 /// ::= 'atomicrmw' 'volatile'? BinOp TypeAndValue ',' TypeAndValue
5412 /// 'singlethread'? AtomicOrdering
5413 int LLParser::ParseAtomicRMW(Instruction *&Inst, PerFunctionState &PFS) {
5414 Value *Ptr, *Val; LocTy PtrLoc, ValLoc;
5415 bool AteExtraComma = false;
5416 AtomicOrdering Ordering = NotAtomic;
5417 SynchronizationScope Scope = CrossThread;
5418 bool isVolatile = false;
5419 AtomicRMWInst::BinOp Operation;
5421 if (EatIfPresent(lltok::kw_volatile))
5424 switch (Lex.getKind()) {
5425 default: return TokError("expected binary operation in atomicrmw");
5426 case lltok::kw_xchg: Operation = AtomicRMWInst::Xchg; break;
5427 case lltok::kw_add: Operation = AtomicRMWInst::Add; break;
5428 case lltok::kw_sub: Operation = AtomicRMWInst::Sub; break;
5429 case lltok::kw_and: Operation = AtomicRMWInst::And; break;
5430 case lltok::kw_nand: Operation = AtomicRMWInst::Nand; break;
5431 case lltok::kw_or: Operation = AtomicRMWInst::Or; break;
5432 case lltok::kw_xor: Operation = AtomicRMWInst::Xor; break;
5433 case lltok::kw_max: Operation = AtomicRMWInst::Max; break;
5434 case lltok::kw_min: Operation = AtomicRMWInst::Min; break;
5435 case lltok::kw_umax: Operation = AtomicRMWInst::UMax; break;
5436 case lltok::kw_umin: Operation = AtomicRMWInst::UMin; break;
5438 Lex.Lex(); // Eat the operation.
5440 if (ParseTypeAndValue(Ptr, PtrLoc, PFS) ||
5441 ParseToken(lltok::comma, "expected ',' after atomicrmw address") ||
5442 ParseTypeAndValue(Val, ValLoc, PFS) ||
5443 ParseScopeAndOrdering(true /*Always atomic*/, Scope, Ordering))
5446 if (Ordering == Unordered)
5447 return TokError("atomicrmw cannot be unordered");
5448 if (!Ptr->getType()->isPointerTy())
5449 return Error(PtrLoc, "atomicrmw operand must be a pointer");
5450 if (cast<PointerType>(Ptr->getType())->getElementType() != Val->getType())
5451 return Error(ValLoc, "atomicrmw value and pointer type do not match");
5452 if (!Val->getType()->isIntegerTy())
5453 return Error(ValLoc, "atomicrmw operand must be an integer");
5454 unsigned Size = Val->getType()->getPrimitiveSizeInBits();
5455 if (Size < 8 || (Size & (Size - 1)))
5456 return Error(ValLoc, "atomicrmw operand must be power-of-two byte-sized"
5459 AtomicRMWInst *RMWI =
5460 new AtomicRMWInst(Operation, Ptr, Val, Ordering, Scope);
5461 RMWI->setVolatile(isVolatile);
5463 return AteExtraComma ? InstExtraComma : InstNormal;
5467 /// ::= 'fence' 'singlethread'? AtomicOrdering
5468 int LLParser::ParseFence(Instruction *&Inst, PerFunctionState &PFS) {
5469 AtomicOrdering Ordering = NotAtomic;
5470 SynchronizationScope Scope = CrossThread;
5471 if (ParseScopeAndOrdering(true /*Always atomic*/, Scope, Ordering))
5474 if (Ordering == Unordered)
5475 return TokError("fence cannot be unordered");
5476 if (Ordering == Monotonic)
5477 return TokError("fence cannot be monotonic");
5479 Inst = new FenceInst(Context, Ordering, Scope);
5483 /// ParseGetElementPtr
5484 /// ::= 'getelementptr' 'inbounds'? TypeAndValue (',' TypeAndValue)*
5485 int LLParser::ParseGetElementPtr(Instruction *&Inst, PerFunctionState &PFS) {
5486 Value *Ptr = nullptr;
5487 Value *Val = nullptr;
5490 bool InBounds = EatIfPresent(lltok::kw_inbounds);
5493 LocTy ExplicitTypeLoc = Lex.getLoc();
5494 if (ParseType(Ty) ||
5495 ParseToken(lltok::comma, "expected comma after getelementptr's type") ||
5496 ParseTypeAndValue(Ptr, Loc, PFS))
5499 Type *BaseType = Ptr->getType();
5500 PointerType *BasePointerType = dyn_cast<PointerType>(BaseType->getScalarType());
5501 if (!BasePointerType)
5502 return Error(Loc, "base of getelementptr must be a pointer");
5504 if (Ty != BasePointerType->getElementType())
5505 return Error(ExplicitTypeLoc,
5506 "explicit pointee type doesn't match operand's pointee type");
5508 SmallVector<Value*, 16> Indices;
5509 bool AteExtraComma = false;
5510 while (EatIfPresent(lltok::comma)) {
5511 if (Lex.getKind() == lltok::MetadataVar) {
5512 AteExtraComma = true;
5515 if (ParseTypeAndValue(Val, EltLoc, PFS)) return true;
5516 if (!Val->getType()->getScalarType()->isIntegerTy())
5517 return Error(EltLoc, "getelementptr index must be an integer");
5518 if (Val->getType()->isVectorTy() != Ptr->getType()->isVectorTy())
5519 return Error(EltLoc, "getelementptr index type missmatch");
5520 if (Val->getType()->isVectorTy()) {
5521 unsigned ValNumEl = cast<VectorType>(Val->getType())->getNumElements();
5522 unsigned PtrNumEl = cast<VectorType>(Ptr->getType())->getNumElements();
5523 if (ValNumEl != PtrNumEl)
5524 return Error(EltLoc,
5525 "getelementptr vector index has a wrong number of elements");
5527 Indices.push_back(Val);
5530 SmallPtrSet<const Type*, 4> Visited;
5531 if (!Indices.empty() &&
5532 !BasePointerType->getElementType()->isSized(&Visited))
5533 return Error(Loc, "base element of getelementptr must be sized");
5535 if (!GetElementPtrInst::getIndexedType(
5536 cast<PointerType>(BaseType->getScalarType())->getElementType(),
5538 return Error(Loc, "invalid getelementptr indices");
5539 Inst = GetElementPtrInst::Create(Ty, Ptr, Indices);
5541 cast<GetElementPtrInst>(Inst)->setIsInBounds(true);
5542 return AteExtraComma ? InstExtraComma : InstNormal;
5545 /// ParseExtractValue
5546 /// ::= 'extractvalue' TypeAndValue (',' uint32)+
5547 int LLParser::ParseExtractValue(Instruction *&Inst, PerFunctionState &PFS) {
5548 Value *Val; LocTy Loc;
5549 SmallVector<unsigned, 4> Indices;
5551 if (ParseTypeAndValue(Val, Loc, PFS) ||
5552 ParseIndexList(Indices, AteExtraComma))
5555 if (!Val->getType()->isAggregateType())
5556 return Error(Loc, "extractvalue operand must be aggregate type");
5558 if (!ExtractValueInst::getIndexedType(Val->getType(), Indices))
5559 return Error(Loc, "invalid indices for extractvalue");
5560 Inst = ExtractValueInst::Create(Val, Indices);
5561 return AteExtraComma ? InstExtraComma : InstNormal;
5564 /// ParseInsertValue
5565 /// ::= 'insertvalue' TypeAndValue ',' TypeAndValue (',' uint32)+
5566 int LLParser::ParseInsertValue(Instruction *&Inst, PerFunctionState &PFS) {
5567 Value *Val0, *Val1; LocTy Loc0, Loc1;
5568 SmallVector<unsigned, 4> Indices;
5570 if (ParseTypeAndValue(Val0, Loc0, PFS) ||
5571 ParseToken(lltok::comma, "expected comma after insertvalue operand") ||
5572 ParseTypeAndValue(Val1, Loc1, PFS) ||
5573 ParseIndexList(Indices, AteExtraComma))
5576 if (!Val0->getType()->isAggregateType())
5577 return Error(Loc0, "insertvalue operand must be aggregate type");
5579 Type *IndexedType = ExtractValueInst::getIndexedType(Val0->getType(), Indices);
5581 return Error(Loc0, "invalid indices for insertvalue");
5582 if (IndexedType != Val1->getType())
5583 return Error(Loc1, "insertvalue operand and field disagree in type: '" +
5584 getTypeString(Val1->getType()) + "' instead of '" +
5585 getTypeString(IndexedType) + "'");
5586 Inst = InsertValueInst::Create(Val0, Val1, Indices);
5587 return AteExtraComma ? InstExtraComma : InstNormal;
5590 //===----------------------------------------------------------------------===//
5591 // Embedded metadata.
5592 //===----------------------------------------------------------------------===//
5594 /// ParseMDNodeVector
5595 /// ::= { Element (',' Element)* }
5597 /// ::= 'null' | TypeAndValue
5598 bool LLParser::ParseMDNodeVector(SmallVectorImpl<Metadata *> &Elts) {
5599 if (ParseToken(lltok::lbrace, "expected '{' here"))
5602 // Check for an empty list.
5603 if (EatIfPresent(lltok::rbrace))
5607 // Null is a special case since it is typeless.
5608 if (EatIfPresent(lltok::kw_null)) {
5609 Elts.push_back(nullptr);
5614 if (ParseMetadata(MD, nullptr))
5617 } while (EatIfPresent(lltok::comma));
5619 return ParseToken(lltok::rbrace, "expected end of metadata node");
5622 //===----------------------------------------------------------------------===//
5623 // Use-list order directives.
5624 //===----------------------------------------------------------------------===//
5625 bool LLParser::sortUseListOrder(Value *V, ArrayRef<unsigned> Indexes,
5628 return Error(Loc, "value has no uses");
5630 unsigned NumUses = 0;
5631 SmallDenseMap<const Use *, unsigned, 16> Order;
5632 for (const Use &U : V->uses()) {
5633 if (++NumUses > Indexes.size())
5635 Order[&U] = Indexes[NumUses - 1];
5638 return Error(Loc, "value only has one use");
5639 if (Order.size() != Indexes.size() || NumUses > Indexes.size())
5640 return Error(Loc, "wrong number of indexes, expected " +
5641 Twine(std::distance(V->use_begin(), V->use_end())));
5643 V->sortUseList([&](const Use &L, const Use &R) {
5644 return Order.lookup(&L) < Order.lookup(&R);
5649 /// ParseUseListOrderIndexes
5650 /// ::= '{' uint32 (',' uint32)+ '}'
5651 bool LLParser::ParseUseListOrderIndexes(SmallVectorImpl<unsigned> &Indexes) {
5652 SMLoc Loc = Lex.getLoc();
5653 if (ParseToken(lltok::lbrace, "expected '{' here"))
5655 if (Lex.getKind() == lltok::rbrace)
5656 return Lex.Error("expected non-empty list of uselistorder indexes");
5658 // Use Offset, Max, and IsOrdered to check consistency of indexes. The
5659 // indexes should be distinct numbers in the range [0, size-1], and should
5661 unsigned Offset = 0;
5663 bool IsOrdered = true;
5664 assert(Indexes.empty() && "Expected empty order vector");
5667 if (ParseUInt32(Index))
5670 // Update consistency checks.
5671 Offset += Index - Indexes.size();
5672 Max = std::max(Max, Index);
5673 IsOrdered &= Index == Indexes.size();
5675 Indexes.push_back(Index);
5676 } while (EatIfPresent(lltok::comma));
5678 if (ParseToken(lltok::rbrace, "expected '}' here"))
5681 if (Indexes.size() < 2)
5682 return Error(Loc, "expected >= 2 uselistorder indexes");
5683 if (Offset != 0 || Max >= Indexes.size())
5684 return Error(Loc, "expected distinct uselistorder indexes in range [0, size)");
5686 return Error(Loc, "expected uselistorder indexes to change the order");
5691 /// ParseUseListOrder
5692 /// ::= 'uselistorder' Type Value ',' UseListOrderIndexes
5693 bool LLParser::ParseUseListOrder(PerFunctionState *PFS) {
5694 SMLoc Loc = Lex.getLoc();
5695 if (ParseToken(lltok::kw_uselistorder, "expected uselistorder directive"))
5699 SmallVector<unsigned, 16> Indexes;
5700 if (ParseTypeAndValue(V, PFS) ||
5701 ParseToken(lltok::comma, "expected comma in uselistorder directive") ||
5702 ParseUseListOrderIndexes(Indexes))
5705 return sortUseListOrder(V, Indexes, Loc);
5708 /// ParseUseListOrderBB
5709 /// ::= 'uselistorder_bb' @foo ',' %bar ',' UseListOrderIndexes
5710 bool LLParser::ParseUseListOrderBB() {
5711 assert(Lex.getKind() == lltok::kw_uselistorder_bb);
5712 SMLoc Loc = Lex.getLoc();
5716 SmallVector<unsigned, 16> Indexes;
5717 if (ParseValID(Fn) ||
5718 ParseToken(lltok::comma, "expected comma in uselistorder_bb directive") ||
5719 ParseValID(Label) ||
5720 ParseToken(lltok::comma, "expected comma in uselistorder_bb directive") ||
5721 ParseUseListOrderIndexes(Indexes))
5724 // Check the function.
5726 if (Fn.Kind == ValID::t_GlobalName)
5727 GV = M->getNamedValue(Fn.StrVal);
5728 else if (Fn.Kind == ValID::t_GlobalID)
5729 GV = Fn.UIntVal < NumberedVals.size() ? NumberedVals[Fn.UIntVal] : nullptr;
5731 return Error(Fn.Loc, "expected function name in uselistorder_bb");
5733 return Error(Fn.Loc, "invalid function forward reference in uselistorder_bb");
5734 auto *F = dyn_cast<Function>(GV);
5736 return Error(Fn.Loc, "expected function name in uselistorder_bb");
5737 if (F->isDeclaration())
5738 return Error(Fn.Loc, "invalid declaration in uselistorder_bb");
5740 // Check the basic block.
5741 if (Label.Kind == ValID::t_LocalID)
5742 return Error(Label.Loc, "invalid numeric label in uselistorder_bb");
5743 if (Label.Kind != ValID::t_LocalName)
5744 return Error(Label.Loc, "expected basic block name in uselistorder_bb");
5745 Value *V = F->getValueSymbolTable().lookup(Label.StrVal);
5747 return Error(Label.Loc, "invalid basic block in uselistorder_bb");
5748 if (!isa<BasicBlock>(V))
5749 return Error(Label.Loc, "expected basic block in uselistorder_bb");
5751 return sortUseListOrder(V, Indexes, Loc);