1 //===-- LLParser.cpp - Parser Class ---------------------------------------===// 2 // 3 // The LLVM Compiler Infrastructure 4 // 5 // This file is distributed under the University of Illinois Open Source 6 // License. See LICENSE.TXT for details. 7 // 8 //===----------------------------------------------------------------------===// 9 // 10 // This file defines the parser class for .ll files. 11 // 12 //===----------------------------------------------------------------------===// 13 14 #include "LLParser.h" 15 #include "llvm/ADT/DenseMap.h" 16 #include "llvm/ADT/None.h" 17 #include "llvm/ADT/Optional.h" 18 #include "llvm/ADT/STLExtras.h" 19 #include "llvm/ADT/SmallPtrSet.h" 20 #include "llvm/AsmParser/SlotMapping.h" 21 #include "llvm/BinaryFormat/Dwarf.h" 22 #include "llvm/IR/Argument.h" 23 #include "llvm/IR/AutoUpgrade.h" 24 #include "llvm/IR/BasicBlock.h" 25 #include "llvm/IR/CallingConv.h" 26 #include "llvm/IR/Comdat.h" 27 #include "llvm/IR/Constants.h" 28 #include "llvm/IR/DebugInfoMetadata.h" 29 #include "llvm/IR/DerivedTypes.h" 30 #include "llvm/IR/Function.h" 31 #include "llvm/IR/GlobalIFunc.h" 32 #include "llvm/IR/GlobalObject.h" 33 #include "llvm/IR/InlineAsm.h" 34 #include "llvm/IR/Instruction.h" 35 #include "llvm/IR/Instructions.h" 36 #include "llvm/IR/Intrinsics.h" 37 #include "llvm/IR/LLVMContext.h" 38 #include "llvm/IR/Metadata.h" 39 #include "llvm/IR/Module.h" 40 #include "llvm/IR/Operator.h" 41 #include "llvm/IR/Type.h" 42 #include "llvm/IR/Value.h" 43 #include "llvm/IR/ValueSymbolTable.h" 44 #include "llvm/Support/Casting.h" 45 #include "llvm/Support/ErrorHandling.h" 46 #include "llvm/Support/MathExtras.h" 47 #include "llvm/Support/SaveAndRestore.h" 48 #include "llvm/Support/raw_ostream.h" 49 #include <algorithm> 50 #include <cassert> 51 #include <cstring> 52 #include <iterator> 53 #include <vector> 54 55 using namespace llvm; 56 57 static std::string getTypeString(Type *T) { 58 std::string Result; 59 raw_string_ostream Tmp(Result); 60 Tmp << *T; 61 return Tmp.str(); 62 } 63 64 /// Run: module ::= toplevelentity* 65 bool LLParser::Run() { 66 // Prime the lexer. 67 Lex.Lex(); 68 69 if (Context.shouldDiscardValueNames()) 70 return Error( 71 Lex.getLoc(), 72 "Can't read textual IR with a Context that discards named Values"); 73 74 return ParseTopLevelEntities() || ValidateEndOfModule() || 75 ValidateEndOfIndex(); 76 } 77 78 bool LLParser::parseStandaloneConstantValue(Constant *&C, 79 const SlotMapping *Slots) { 80 restoreParsingState(Slots); 81 Lex.Lex(); 82 83 Type *Ty = nullptr; 84 if (ParseType(Ty) || parseConstantValue(Ty, C)) 85 return true; 86 if (Lex.getKind() != lltok::Eof) 87 return Error(Lex.getLoc(), "expected end of string"); 88 return false; 89 } 90 91 bool LLParser::parseTypeAtBeginning(Type *&Ty, unsigned &Read, 92 const SlotMapping *Slots) { 93 restoreParsingState(Slots); 94 Lex.Lex(); 95 96 Read = 0; 97 SMLoc Start = Lex.getLoc(); 98 Ty = nullptr; 99 if (ParseType(Ty)) 100 return true; 101 SMLoc End = Lex.getLoc(); 102 Read = End.getPointer() - Start.getPointer(); 103 104 return false; 105 } 106 107 void LLParser::restoreParsingState(const SlotMapping *Slots) { 108 if (!Slots) 109 return; 110 NumberedVals = Slots->GlobalValues; 111 NumberedMetadata = Slots->MetadataNodes; 112 for (const auto &I : Slots->NamedTypes) 113 NamedTypes.insert( 114 std::make_pair(I.getKey(), std::make_pair(I.second, LocTy()))); 115 for (const auto &I : Slots->Types) 116 NumberedTypes.insert( 117 std::make_pair(I.first, std::make_pair(I.second, LocTy()))); 118 } 119 120 /// ValidateEndOfModule - Do final validity and sanity checks at the end of the 121 /// module. 122 bool LLParser::ValidateEndOfModule() { 123 if (!M) 124 return false; 125 // Handle any function attribute group forward references. 126 for (const auto &RAG : ForwardRefAttrGroups) { 127 Value *V = RAG.first; 128 const std::vector<unsigned> &Attrs = RAG.second; 129 AttrBuilder B; 130 131 for (const auto &Attr : Attrs) 132 B.merge(NumberedAttrBuilders[Attr]); 133 134 if (Function *Fn = dyn_cast<Function>(V)) { 135 AttributeList AS = Fn->getAttributes(); 136 AttrBuilder FnAttrs(AS.getFnAttributes()); 137 AS = AS.removeAttributes(Context, AttributeList::FunctionIndex); 138 139 FnAttrs.merge(B); 140 141 // If the alignment was parsed as an attribute, move to the alignment 142 // field. 143 if (FnAttrs.hasAlignmentAttr()) { 144 Fn->setAlignment(FnAttrs.getAlignment()); 145 FnAttrs.removeAttribute(Attribute::Alignment); 146 } 147 148 AS = AS.addAttributes(Context, AttributeList::FunctionIndex, 149 AttributeSet::get(Context, FnAttrs)); 150 Fn->setAttributes(AS); 151 } else if (CallInst *CI = dyn_cast<CallInst>(V)) { 152 AttributeList AS = CI->getAttributes(); 153 AttrBuilder FnAttrs(AS.getFnAttributes()); 154 AS = AS.removeAttributes(Context, AttributeList::FunctionIndex); 155 FnAttrs.merge(B); 156 AS = AS.addAttributes(Context, AttributeList::FunctionIndex, 157 AttributeSet::get(Context, FnAttrs)); 158 CI->setAttributes(AS); 159 } else if (InvokeInst *II = dyn_cast<InvokeInst>(V)) { 160 AttributeList AS = II->getAttributes(); 161 AttrBuilder FnAttrs(AS.getFnAttributes()); 162 AS = AS.removeAttributes(Context, AttributeList::FunctionIndex); 163 FnAttrs.merge(B); 164 AS = AS.addAttributes(Context, AttributeList::FunctionIndex, 165 AttributeSet::get(Context, FnAttrs)); 166 II->setAttributes(AS); 167 } else if (auto *GV = dyn_cast<GlobalVariable>(V)) { 168 AttrBuilder Attrs(GV->getAttributes()); 169 Attrs.merge(B); 170 GV->setAttributes(AttributeSet::get(Context,Attrs)); 171 } else { 172 llvm_unreachable("invalid object with forward attribute group reference"); 173 } 174 } 175 176 // If there are entries in ForwardRefBlockAddresses at this point, the 177 // function was never defined. 178 if (!ForwardRefBlockAddresses.empty()) 179 return Error(ForwardRefBlockAddresses.begin()->first.Loc, 180 "expected function name in blockaddress"); 181 182 for (const auto &NT : NumberedTypes) 183 if (NT.second.second.isValid()) 184 return Error(NT.second.second, 185 "use of undefined type '%" + Twine(NT.first) + "'"); 186 187 for (StringMap<std::pair<Type*, LocTy> >::iterator I = 188 NamedTypes.begin(), E = NamedTypes.end(); I != E; ++I) 189 if (I->second.second.isValid()) 190 return Error(I->second.second, 191 "use of undefined type named '" + I->getKey() + "'"); 192 193 if (!ForwardRefComdats.empty()) 194 return Error(ForwardRefComdats.begin()->second, 195 "use of undefined comdat '$" + 196 ForwardRefComdats.begin()->first + "'"); 197 198 if (!ForwardRefVals.empty()) 199 return Error(ForwardRefVals.begin()->second.second, 200 "use of undefined value '@" + ForwardRefVals.begin()->first + 201 "'"); 202 203 if (!ForwardRefValIDs.empty()) 204 return Error(ForwardRefValIDs.begin()->second.second, 205 "use of undefined value '@" + 206 Twine(ForwardRefValIDs.begin()->first) + "'"); 207 208 if (!ForwardRefMDNodes.empty()) 209 return Error(ForwardRefMDNodes.begin()->second.second, 210 "use of undefined metadata '!" + 211 Twine(ForwardRefMDNodes.begin()->first) + "'"); 212 213 // Resolve metadata cycles. 214 for (auto &N : NumberedMetadata) { 215 if (N.second && !N.second->isResolved()) 216 N.second->resolveCycles(); 217 } 218 219 for (auto *Inst : InstsWithTBAATag) { 220 MDNode *MD = Inst->getMetadata(LLVMContext::MD_tbaa); 221 assert(MD && "UpgradeInstWithTBAATag should have a TBAA tag"); 222 auto *UpgradedMD = UpgradeTBAANode(*MD); 223 if (MD != UpgradedMD) 224 Inst->setMetadata(LLVMContext::MD_tbaa, UpgradedMD); 225 } 226 227 // Look for intrinsic functions and CallInst that need to be upgraded 228 for (Module::iterator FI = M->begin(), FE = M->end(); FI != FE; ) 229 UpgradeCallsToIntrinsic(&*FI++); // must be post-increment, as we remove 230 231 // Some types could be renamed during loading if several modules are 232 // loaded in the same LLVMContext (LTO scenario). In this case we should 233 // remangle intrinsics names as well. 234 for (Module::iterator FI = M->begin(), FE = M->end(); FI != FE; ) { 235 Function *F = &*FI++; 236 if (auto Remangled = Intrinsic::remangleIntrinsicFunction(F)) { 237 F->replaceAllUsesWith(Remangled.getValue()); 238 F->eraseFromParent(); 239 } 240 } 241 242 if (UpgradeDebugInfo) 243 llvm::UpgradeDebugInfo(*M); 244 245 UpgradeModuleFlags(*M); 246 UpgradeSectionAttributes(*M); 247 248 if (!Slots) 249 return false; 250 // Initialize the slot mapping. 251 // Because by this point we've parsed and validated everything, we can "steal" 252 // the mapping from LLParser as it doesn't need it anymore. 253 Slots->GlobalValues = std::move(NumberedVals); 254 Slots->MetadataNodes = std::move(NumberedMetadata); 255 for (const auto &I : NamedTypes) 256 Slots->NamedTypes.insert(std::make_pair(I.getKey(), I.second.first)); 257 for (const auto &I : NumberedTypes) 258 Slots->Types.insert(std::make_pair(I.first, I.second.first)); 259 260 return false; 261 } 262 263 /// Do final validity and sanity checks at the end of the index. 264 bool LLParser::ValidateEndOfIndex() { 265 if (!Index) 266 return false; 267 268 if (!ForwardRefValueInfos.empty()) 269 return Error(ForwardRefValueInfos.begin()->second.front().second, 270 "use of undefined summary '^" + 271 Twine(ForwardRefValueInfos.begin()->first) + "'"); 272 273 if (!ForwardRefAliasees.empty()) 274 return Error(ForwardRefAliasees.begin()->second.front().second, 275 "use of undefined summary '^" + 276 Twine(ForwardRefAliasees.begin()->first) + "'"); 277 278 if (!ForwardRefTypeIds.empty()) 279 return Error(ForwardRefTypeIds.begin()->second.front().second, 280 "use of undefined type id summary '^" + 281 Twine(ForwardRefTypeIds.begin()->first) + "'"); 282 283 return false; 284 } 285 286 //===----------------------------------------------------------------------===// 287 // Top-Level Entities 288 //===----------------------------------------------------------------------===// 289 290 bool LLParser::ParseTopLevelEntities() { 291 // If there is no Module, then parse just the summary index entries. 292 if (!M) { 293 while (true) { 294 switch (Lex.getKind()) { 295 case lltok::Eof: 296 return false; 297 case lltok::SummaryID: 298 if (ParseSummaryEntry()) 299 return true; 300 break; 301 case lltok::kw_source_filename: 302 if (ParseSourceFileName()) 303 return true; 304 break; 305 default: 306 // Skip everything else 307 Lex.Lex(); 308 } 309 } 310 } 311 while (true) { 312 switch (Lex.getKind()) { 313 default: return TokError("expected top-level entity"); 314 case lltok::Eof: return false; 315 case lltok::kw_declare: if (ParseDeclare()) return true; break; 316 case lltok::kw_define: if (ParseDefine()) return true; break; 317 case lltok::kw_module: if (ParseModuleAsm()) return true; break; 318 case lltok::kw_target: if (ParseTargetDefinition()) return true; break; 319 case lltok::kw_source_filename: 320 if (ParseSourceFileName()) 321 return true; 322 break; 323 case lltok::kw_deplibs: if (ParseDepLibs()) return true; break; 324 case lltok::LocalVarID: if (ParseUnnamedType()) return true; break; 325 case lltok::LocalVar: if (ParseNamedType()) return true; break; 326 case lltok::GlobalID: if (ParseUnnamedGlobal()) return true; break; 327 case lltok::GlobalVar: if (ParseNamedGlobal()) return true; break; 328 case lltok::ComdatVar: if (parseComdat()) return true; break; 329 case lltok::exclaim: if (ParseStandaloneMetadata()) return true; break; 330 case lltok::SummaryID: 331 if (ParseSummaryEntry()) 332 return true; 333 break; 334 case lltok::MetadataVar:if (ParseNamedMetadata()) return true; break; 335 case lltok::kw_attributes: if (ParseUnnamedAttrGrp()) return true; break; 336 case lltok::kw_uselistorder: if (ParseUseListOrder()) return true; break; 337 case lltok::kw_uselistorder_bb: 338 if (ParseUseListOrderBB()) 339 return true; 340 break; 341 } 342 } 343 } 344 345 /// toplevelentity 346 /// ::= 'module' 'asm' STRINGCONSTANT 347 bool LLParser::ParseModuleAsm() { 348 assert(Lex.getKind() == lltok::kw_module); 349 Lex.Lex(); 350 351 std::string AsmStr; 352 if (ParseToken(lltok::kw_asm, "expected 'module asm'") || 353 ParseStringConstant(AsmStr)) return true; 354 355 M->appendModuleInlineAsm(AsmStr); 356 return false; 357 } 358 359 /// toplevelentity 360 /// ::= 'target' 'triple' '=' STRINGCONSTANT 361 /// ::= 'target' 'datalayout' '=' STRINGCONSTANT 362 bool LLParser::ParseTargetDefinition() { 363 assert(Lex.getKind() == lltok::kw_target); 364 std::string Str; 365 switch (Lex.Lex()) { 366 default: return TokError("unknown target property"); 367 case lltok::kw_triple: 368 Lex.Lex(); 369 if (ParseToken(lltok::equal, "expected '=' after target triple") || 370 ParseStringConstant(Str)) 371 return true; 372 M->setTargetTriple(Str); 373 return false; 374 case lltok::kw_datalayout: 375 Lex.Lex(); 376 if (ParseToken(lltok::equal, "expected '=' after target datalayout") || 377 ParseStringConstant(Str)) 378 return true; 379 if (DataLayoutStr.empty()) 380 M->setDataLayout(Str); 381 return false; 382 } 383 } 384 385 /// toplevelentity 386 /// ::= 'source_filename' '=' STRINGCONSTANT 387 bool LLParser::ParseSourceFileName() { 388 assert(Lex.getKind() == lltok::kw_source_filename); 389 Lex.Lex(); 390 if (ParseToken(lltok::equal, "expected '=' after source_filename") || 391 ParseStringConstant(SourceFileName)) 392 return true; 393 if (M) 394 M->setSourceFileName(SourceFileName); 395 return false; 396 } 397 398 /// toplevelentity 399 /// ::= 'deplibs' '=' '[' ']' 400 /// ::= 'deplibs' '=' '[' STRINGCONSTANT (',' STRINGCONSTANT)* ']' 401 /// FIXME: Remove in 4.0. Currently parse, but ignore. 402 bool LLParser::ParseDepLibs() { 403 assert(Lex.getKind() == lltok::kw_deplibs); 404 Lex.Lex(); 405 if (ParseToken(lltok::equal, "expected '=' after deplibs") || 406 ParseToken(lltok::lsquare, "expected '=' after deplibs")) 407 return true; 408 409 if (EatIfPresent(lltok::rsquare)) 410 return false; 411 412 do { 413 std::string Str; 414 if (ParseStringConstant(Str)) return true; 415 } while (EatIfPresent(lltok::comma)); 416 417 return ParseToken(lltok::rsquare, "expected ']' at end of list"); 418 } 419 420 /// ParseUnnamedType: 421 /// ::= LocalVarID '=' 'type' type 422 bool LLParser::ParseUnnamedType() { 423 LocTy TypeLoc = Lex.getLoc(); 424 unsigned TypeID = Lex.getUIntVal(); 425 Lex.Lex(); // eat LocalVarID; 426 427 if (ParseToken(lltok::equal, "expected '=' after name") || 428 ParseToken(lltok::kw_type, "expected 'type' after '='")) 429 return true; 430 431 Type *Result = nullptr; 432 if (ParseStructDefinition(TypeLoc, "", 433 NumberedTypes[TypeID], Result)) return true; 434 435 if (!isa<StructType>(Result)) { 436 std::pair<Type*, LocTy> &Entry = NumberedTypes[TypeID]; 437 if (Entry.first) 438 return Error(TypeLoc, "non-struct types may not be recursive"); 439 Entry.first = Result; 440 Entry.second = SMLoc(); 441 } 442 443 return false; 444 } 445 446 /// toplevelentity 447 /// ::= LocalVar '=' 'type' type 448 bool LLParser::ParseNamedType() { 449 std::string Name = Lex.getStrVal(); 450 LocTy NameLoc = Lex.getLoc(); 451 Lex.Lex(); // eat LocalVar. 452 453 if (ParseToken(lltok::equal, "expected '=' after name") || 454 ParseToken(lltok::kw_type, "expected 'type' after name")) 455 return true; 456 457 Type *Result = nullptr; 458 if (ParseStructDefinition(NameLoc, Name, 459 NamedTypes[Name], Result)) return true; 460 461 if (!isa<StructType>(Result)) { 462 std::pair<Type*, LocTy> &Entry = NamedTypes[Name]; 463 if (Entry.first) 464 return Error(NameLoc, "non-struct types may not be recursive"); 465 Entry.first = Result; 466 Entry.second = SMLoc(); 467 } 468 469 return false; 470 } 471 472 /// toplevelentity 473 /// ::= 'declare' FunctionHeader 474 bool LLParser::ParseDeclare() { 475 assert(Lex.getKind() == lltok::kw_declare); 476 Lex.Lex(); 477 478 std::vector<std::pair<unsigned, MDNode *>> MDs; 479 while (Lex.getKind() == lltok::MetadataVar) { 480 unsigned MDK; 481 MDNode *N; 482 if (ParseMetadataAttachment(MDK, N)) 483 return true; 484 MDs.push_back({MDK, N}); 485 } 486 487 Function *F; 488 if (ParseFunctionHeader(F, false)) 489 return true; 490 for (auto &MD : MDs) 491 F->addMetadata(MD.first, *MD.second); 492 return false; 493 } 494 495 /// toplevelentity 496 /// ::= 'define' FunctionHeader (!dbg !56)* '{' ... 497 bool LLParser::ParseDefine() { 498 assert(Lex.getKind() == lltok::kw_define); 499 Lex.Lex(); 500 501 Function *F; 502 return ParseFunctionHeader(F, true) || 503 ParseOptionalFunctionMetadata(*F) || 504 ParseFunctionBody(*F); 505 } 506 507 /// ParseGlobalType 508 /// ::= 'constant' 509 /// ::= 'global' 510 bool LLParser::ParseGlobalType(bool &IsConstant) { 511 if (Lex.getKind() == lltok::kw_constant) 512 IsConstant = true; 513 else if (Lex.getKind() == lltok::kw_global) 514 IsConstant = false; 515 else { 516 IsConstant = false; 517 return TokError("expected 'global' or 'constant'"); 518 } 519 Lex.Lex(); 520 return false; 521 } 522 523 bool LLParser::ParseOptionalUnnamedAddr( 524 GlobalVariable::UnnamedAddr &UnnamedAddr) { 525 if (EatIfPresent(lltok::kw_unnamed_addr)) 526 UnnamedAddr = GlobalValue::UnnamedAddr::Global; 527 else if (EatIfPresent(lltok::kw_local_unnamed_addr)) 528 UnnamedAddr = GlobalValue::UnnamedAddr::Local; 529 else 530 UnnamedAddr = GlobalValue::UnnamedAddr::None; 531 return false; 532 } 533 534 /// ParseUnnamedGlobal: 535 /// OptionalVisibility (ALIAS | IFUNC) ... 536 /// OptionalLinkage OptionalPreemptionSpecifier OptionalVisibility 537 /// OptionalDLLStorageClass 538 /// ... -> global variable 539 /// GlobalID '=' OptionalVisibility (ALIAS | IFUNC) ... 540 /// GlobalID '=' OptionalLinkage OptionalPreemptionSpecifier OptionalVisibility 541 /// OptionalDLLStorageClass 542 /// ... -> global variable 543 bool LLParser::ParseUnnamedGlobal() { 544 unsigned VarID = NumberedVals.size(); 545 std::string Name; 546 LocTy NameLoc = Lex.getLoc(); 547 548 // Handle the GlobalID form. 549 if (Lex.getKind() == lltok::GlobalID) { 550 if (Lex.getUIntVal() != VarID) 551 return Error(Lex.getLoc(), "variable expected to be numbered '%" + 552 Twine(VarID) + "'"); 553 Lex.Lex(); // eat GlobalID; 554 555 if (ParseToken(lltok::equal, "expected '=' after name")) 556 return true; 557 } 558 559 bool HasLinkage; 560 unsigned Linkage, Visibility, DLLStorageClass; 561 bool DSOLocal; 562 GlobalVariable::ThreadLocalMode TLM; 563 GlobalVariable::UnnamedAddr UnnamedAddr; 564 if (ParseOptionalLinkage(Linkage, HasLinkage, Visibility, DLLStorageClass, 565 DSOLocal) || 566 ParseOptionalThreadLocal(TLM) || ParseOptionalUnnamedAddr(UnnamedAddr)) 567 return true; 568 569 if (Lex.getKind() != lltok::kw_alias && Lex.getKind() != lltok::kw_ifunc) 570 return ParseGlobal(Name, NameLoc, Linkage, HasLinkage, Visibility, 571 DLLStorageClass, DSOLocal, TLM, UnnamedAddr); 572 573 return parseIndirectSymbol(Name, NameLoc, Linkage, Visibility, 574 DLLStorageClass, DSOLocal, TLM, UnnamedAddr); 575 } 576 577 /// ParseNamedGlobal: 578 /// GlobalVar '=' OptionalVisibility (ALIAS | IFUNC) ... 579 /// GlobalVar '=' OptionalLinkage OptionalPreemptionSpecifier 580 /// OptionalVisibility OptionalDLLStorageClass 581 /// ... -> global variable 582 bool LLParser::ParseNamedGlobal() { 583 assert(Lex.getKind() == lltok::GlobalVar); 584 LocTy NameLoc = Lex.getLoc(); 585 std::string Name = Lex.getStrVal(); 586 Lex.Lex(); 587 588 bool HasLinkage; 589 unsigned Linkage, Visibility, DLLStorageClass; 590 bool DSOLocal; 591 GlobalVariable::ThreadLocalMode TLM; 592 GlobalVariable::UnnamedAddr UnnamedAddr; 593 if (ParseToken(lltok::equal, "expected '=' in global variable") || 594 ParseOptionalLinkage(Linkage, HasLinkage, Visibility, DLLStorageClass, 595 DSOLocal) || 596 ParseOptionalThreadLocal(TLM) || ParseOptionalUnnamedAddr(UnnamedAddr)) 597 return true; 598 599 if (Lex.getKind() != lltok::kw_alias && Lex.getKind() != lltok::kw_ifunc) 600 return ParseGlobal(Name, NameLoc, Linkage, HasLinkage, Visibility, 601 DLLStorageClass, DSOLocal, TLM, UnnamedAddr); 602 603 return parseIndirectSymbol(Name, NameLoc, Linkage, Visibility, 604 DLLStorageClass, DSOLocal, TLM, UnnamedAddr); 605 } 606 607 bool LLParser::parseComdat() { 608 assert(Lex.getKind() == lltok::ComdatVar); 609 std::string Name = Lex.getStrVal(); 610 LocTy NameLoc = Lex.getLoc(); 611 Lex.Lex(); 612 613 if (ParseToken(lltok::equal, "expected '=' here")) 614 return true; 615 616 if (ParseToken(lltok::kw_comdat, "expected comdat keyword")) 617 return TokError("expected comdat type"); 618 619 Comdat::SelectionKind SK; 620 switch (Lex.getKind()) { 621 default: 622 return TokError("unknown selection kind"); 623 case lltok::kw_any: 624 SK = Comdat::Any; 625 break; 626 case lltok::kw_exactmatch: 627 SK = Comdat::ExactMatch; 628 break; 629 case lltok::kw_largest: 630 SK = Comdat::Largest; 631 break; 632 case lltok::kw_noduplicates: 633 SK = Comdat::NoDuplicates; 634 break; 635 case lltok::kw_samesize: 636 SK = Comdat::SameSize; 637 break; 638 } 639 Lex.Lex(); 640 641 // See if the comdat was forward referenced, if so, use the comdat. 642 Module::ComdatSymTabType &ComdatSymTab = M->getComdatSymbolTable(); 643 Module::ComdatSymTabType::iterator I = ComdatSymTab.find(Name); 644 if (I != ComdatSymTab.end() && !ForwardRefComdats.erase(Name)) 645 return Error(NameLoc, "redefinition of comdat '$" + Name + "'"); 646 647 Comdat *C; 648 if (I != ComdatSymTab.end()) 649 C = &I->second; 650 else 651 C = M->getOrInsertComdat(Name); 652 C->setSelectionKind(SK); 653 654 return false; 655 } 656 657 // MDString: 658 // ::= '!' STRINGCONSTANT 659 bool LLParser::ParseMDString(MDString *&Result) { 660 std::string Str; 661 if (ParseStringConstant(Str)) return true; 662 Result = MDString::get(Context, Str); 663 return false; 664 } 665 666 // MDNode: 667 // ::= '!' MDNodeNumber 668 bool LLParser::ParseMDNodeID(MDNode *&Result) { 669 // !{ ..., !42, ... } 670 LocTy IDLoc = Lex.getLoc(); 671 unsigned MID = 0; 672 if (ParseUInt32(MID)) 673 return true; 674 675 // If not a forward reference, just return it now. 676 if (NumberedMetadata.count(MID)) { 677 Result = NumberedMetadata[MID]; 678 return false; 679 } 680 681 // Otherwise, create MDNode forward reference. 682 auto &FwdRef = ForwardRefMDNodes[MID]; 683 FwdRef = std::make_pair(MDTuple::getTemporary(Context, None), IDLoc); 684 685 Result = FwdRef.first.get(); 686 NumberedMetadata[MID].reset(Result); 687 return false; 688 } 689 690 /// ParseNamedMetadata: 691 /// !foo = !{ !1, !2 } 692 bool LLParser::ParseNamedMetadata() { 693 assert(Lex.getKind() == lltok::MetadataVar); 694 std::string Name = Lex.getStrVal(); 695 Lex.Lex(); 696 697 if (ParseToken(lltok::equal, "expected '=' here") || 698 ParseToken(lltok::exclaim, "Expected '!' here") || 699 ParseToken(lltok::lbrace, "Expected '{' here")) 700 return true; 701 702 NamedMDNode *NMD = M->getOrInsertNamedMetadata(Name); 703 if (Lex.getKind() != lltok::rbrace) 704 do { 705 MDNode *N = nullptr; 706 // Parse DIExpressions inline as a special case. They are still MDNodes, 707 // so they can still appear in named metadata. Remove this logic if they 708 // become plain Metadata. 709 if (Lex.getKind() == lltok::MetadataVar && 710 Lex.getStrVal() == "DIExpression") { 711 if (ParseDIExpression(N, /*IsDistinct=*/false)) 712 return true; 713 } else if (ParseToken(lltok::exclaim, "Expected '!' here") || 714 ParseMDNodeID(N)) { 715 return true; 716 } 717 NMD->addOperand(N); 718 } while (EatIfPresent(lltok::comma)); 719 720 return ParseToken(lltok::rbrace, "expected end of metadata node"); 721 } 722 723 /// ParseStandaloneMetadata: 724 /// !42 = !{...} 725 bool LLParser::ParseStandaloneMetadata() { 726 assert(Lex.getKind() == lltok::exclaim); 727 Lex.Lex(); 728 unsigned MetadataID = 0; 729 730 MDNode *Init; 731 if (ParseUInt32(MetadataID) || 732 ParseToken(lltok::equal, "expected '=' here")) 733 return true; 734 735 // Detect common error, from old metadata syntax. 736 if (Lex.getKind() == lltok::Type) 737 return TokError("unexpected type in metadata definition"); 738 739 bool IsDistinct = EatIfPresent(lltok::kw_distinct); 740 if (Lex.getKind() == lltok::MetadataVar) { 741 if (ParseSpecializedMDNode(Init, IsDistinct)) 742 return true; 743 } else if (ParseToken(lltok::exclaim, "Expected '!' here") || 744 ParseMDTuple(Init, IsDistinct)) 745 return true; 746 747 // See if this was forward referenced, if so, handle it. 748 auto FI = ForwardRefMDNodes.find(MetadataID); 749 if (FI != ForwardRefMDNodes.end()) { 750 FI->second.first->replaceAllUsesWith(Init); 751 ForwardRefMDNodes.erase(FI); 752 753 assert(NumberedMetadata[MetadataID] == Init && "Tracking VH didn't work"); 754 } else { 755 if (NumberedMetadata.count(MetadataID)) 756 return TokError("Metadata id is already used"); 757 NumberedMetadata[MetadataID].reset(Init); 758 } 759 760 return false; 761 } 762 763 // Skips a single module summary entry. 764 bool LLParser::SkipModuleSummaryEntry() { 765 // Each module summary entry consists of a tag for the entry 766 // type, followed by a colon, then the fields surrounded by nested sets of 767 // parentheses. The "tag:" looks like a Label. Once parsing support is 768 // in place we will look for the tokens corresponding to the expected tags. 769 if (Lex.getKind() != lltok::kw_gv && Lex.getKind() != lltok::kw_module && 770 Lex.getKind() != lltok::kw_typeid) 771 return TokError( 772 "Expected 'gv', 'module', or 'typeid' at the start of summary entry"); 773 Lex.Lex(); 774 if (ParseToken(lltok::colon, "expected ':' at start of summary entry") || 775 ParseToken(lltok::lparen, "expected '(' at start of summary entry")) 776 return true; 777 // Now walk through the parenthesized entry, until the number of open 778 // parentheses goes back down to 0 (the first '(' was parsed above). 779 unsigned NumOpenParen = 1; 780 do { 781 switch (Lex.getKind()) { 782 case lltok::lparen: 783 NumOpenParen++; 784 break; 785 case lltok::rparen: 786 NumOpenParen--; 787 break; 788 case lltok::Eof: 789 return TokError("found end of file while parsing summary entry"); 790 default: 791 // Skip everything in between parentheses. 792 break; 793 } 794 Lex.Lex(); 795 } while (NumOpenParen > 0); 796 return false; 797 } 798 799 /// SummaryEntry 800 /// ::= SummaryID '=' GVEntry | ModuleEntry | TypeIdEntry 801 bool LLParser::ParseSummaryEntry() { 802 assert(Lex.getKind() == lltok::SummaryID); 803 unsigned SummaryID = Lex.getUIntVal(); 804 805 // For summary entries, colons should be treated as distinct tokens, 806 // not an indication of the end of a label token. 807 Lex.setIgnoreColonInIdentifiers(true); 808 809 Lex.Lex(); 810 if (ParseToken(lltok::equal, "expected '=' here")) 811 return true; 812 813 // If we don't have an index object, skip the summary entry. 814 if (!Index) 815 return SkipModuleSummaryEntry(); 816 817 switch (Lex.getKind()) { 818 case lltok::kw_gv: 819 return ParseGVEntry(SummaryID); 820 case lltok::kw_module: 821 return ParseModuleEntry(SummaryID); 822 case lltok::kw_typeid: 823 return ParseTypeIdEntry(SummaryID); 824 break; 825 default: 826 return Error(Lex.getLoc(), "unexpected summary kind"); 827 } 828 Lex.setIgnoreColonInIdentifiers(false); 829 return false; 830 } 831 832 static bool isValidVisibilityForLinkage(unsigned V, unsigned L) { 833 return !GlobalValue::isLocalLinkage((GlobalValue::LinkageTypes)L) || 834 (GlobalValue::VisibilityTypes)V == GlobalValue::DefaultVisibility; 835 } 836 837 // If there was an explicit dso_local, update GV. In the absence of an explicit 838 // dso_local we keep the default value. 839 static void maybeSetDSOLocal(bool DSOLocal, GlobalValue &GV) { 840 if (DSOLocal) 841 GV.setDSOLocal(true); 842 } 843 844 /// parseIndirectSymbol: 845 /// ::= GlobalVar '=' OptionalLinkage OptionalPreemptionSpecifier 846 /// OptionalVisibility OptionalDLLStorageClass 847 /// OptionalThreadLocal OptionalUnnamedAddr 848 // 'alias|ifunc' IndirectSymbol 849 /// 850 /// IndirectSymbol 851 /// ::= TypeAndValue 852 /// 853 /// Everything through OptionalUnnamedAddr has already been parsed. 854 /// 855 bool LLParser::parseIndirectSymbol(const std::string &Name, LocTy NameLoc, 856 unsigned L, unsigned Visibility, 857 unsigned DLLStorageClass, bool DSOLocal, 858 GlobalVariable::ThreadLocalMode TLM, 859 GlobalVariable::UnnamedAddr UnnamedAddr) { 860 bool IsAlias; 861 if (Lex.getKind() == lltok::kw_alias) 862 IsAlias = true; 863 else if (Lex.getKind() == lltok::kw_ifunc) 864 IsAlias = false; 865 else 866 llvm_unreachable("Not an alias or ifunc!"); 867 Lex.Lex(); 868 869 GlobalValue::LinkageTypes Linkage = (GlobalValue::LinkageTypes) L; 870 871 if(IsAlias && !GlobalAlias::isValidLinkage(Linkage)) 872 return Error(NameLoc, "invalid linkage type for alias"); 873 874 if (!isValidVisibilityForLinkage(Visibility, L)) 875 return Error(NameLoc, 876 "symbol with local linkage must have default visibility"); 877 878 Type *Ty; 879 LocTy ExplicitTypeLoc = Lex.getLoc(); 880 if (ParseType(Ty) || 881 ParseToken(lltok::comma, "expected comma after alias or ifunc's type")) 882 return true; 883 884 Constant *Aliasee; 885 LocTy AliaseeLoc = Lex.getLoc(); 886 if (Lex.getKind() != lltok::kw_bitcast && 887 Lex.getKind() != lltok::kw_getelementptr && 888 Lex.getKind() != lltok::kw_addrspacecast && 889 Lex.getKind() != lltok::kw_inttoptr) { 890 if (ParseGlobalTypeAndValue(Aliasee)) 891 return true; 892 } else { 893 // The bitcast dest type is not present, it is implied by the dest type. 894 ValID ID; 895 if (ParseValID(ID)) 896 return true; 897 if (ID.Kind != ValID::t_Constant) 898 return Error(AliaseeLoc, "invalid aliasee"); 899 Aliasee = ID.ConstantVal; 900 } 901 902 Type *AliaseeType = Aliasee->getType(); 903 auto *PTy = dyn_cast<PointerType>(AliaseeType); 904 if (!PTy) 905 return Error(AliaseeLoc, "An alias or ifunc must have pointer type"); 906 unsigned AddrSpace = PTy->getAddressSpace(); 907 908 if (IsAlias && Ty != PTy->getElementType()) 909 return Error( 910 ExplicitTypeLoc, 911 "explicit pointee type doesn't match operand's pointee type"); 912 913 if (!IsAlias && !PTy->getElementType()->isFunctionTy()) 914 return Error( 915 ExplicitTypeLoc, 916 "explicit pointee type should be a function type"); 917 918 GlobalValue *GVal = nullptr; 919 920 // See if the alias was forward referenced, if so, prepare to replace the 921 // forward reference. 922 if (!Name.empty()) { 923 GVal = M->getNamedValue(Name); 924 if (GVal) { 925 if (!ForwardRefVals.erase(Name)) 926 return Error(NameLoc, "redefinition of global '@" + Name + "'"); 927 } 928 } else { 929 auto I = ForwardRefValIDs.find(NumberedVals.size()); 930 if (I != ForwardRefValIDs.end()) { 931 GVal = I->second.first; 932 ForwardRefValIDs.erase(I); 933 } 934 } 935 936 // Okay, create the alias but do not insert it into the module yet. 937 std::unique_ptr<GlobalIndirectSymbol> GA; 938 if (IsAlias) 939 GA.reset(GlobalAlias::create(Ty, AddrSpace, 940 (GlobalValue::LinkageTypes)Linkage, Name, 941 Aliasee, /*Parent*/ nullptr)); 942 else 943 GA.reset(GlobalIFunc::create(Ty, AddrSpace, 944 (GlobalValue::LinkageTypes)Linkage, Name, 945 Aliasee, /*Parent*/ nullptr)); 946 GA->setThreadLocalMode(TLM); 947 GA->setVisibility((GlobalValue::VisibilityTypes)Visibility); 948 GA->setDLLStorageClass((GlobalValue::DLLStorageClassTypes)DLLStorageClass); 949 GA->setUnnamedAddr(UnnamedAddr); 950 maybeSetDSOLocal(DSOLocal, *GA); 951 952 if (Name.empty()) 953 NumberedVals.push_back(GA.get()); 954 955 if (GVal) { 956 // Verify that types agree. 957 if (GVal->getType() != GA->getType()) 958 return Error( 959 ExplicitTypeLoc, 960 "forward reference and definition of alias have different types"); 961 962 // If they agree, just RAUW the old value with the alias and remove the 963 // forward ref info. 964 GVal->replaceAllUsesWith(GA.get()); 965 GVal->eraseFromParent(); 966 } 967 968 // Insert into the module, we know its name won't collide now. 969 if (IsAlias) 970 M->getAliasList().push_back(cast<GlobalAlias>(GA.get())); 971 else 972 M->getIFuncList().push_back(cast<GlobalIFunc>(GA.get())); 973 assert(GA->getName() == Name && "Should not be a name conflict!"); 974 975 // The module owns this now 976 GA.release(); 977 978 return false; 979 } 980 981 /// ParseGlobal 982 /// ::= GlobalVar '=' OptionalLinkage OptionalPreemptionSpecifier 983 /// OptionalVisibility OptionalDLLStorageClass 984 /// OptionalThreadLocal OptionalUnnamedAddr OptionalAddrSpace 985 /// OptionalExternallyInitialized GlobalType Type Const OptionalAttrs 986 /// ::= OptionalLinkage OptionalPreemptionSpecifier OptionalVisibility 987 /// OptionalDLLStorageClass OptionalThreadLocal OptionalUnnamedAddr 988 /// OptionalAddrSpace OptionalExternallyInitialized GlobalType Type 989 /// Const OptionalAttrs 990 /// 991 /// Everything up to and including OptionalUnnamedAddr has been parsed 992 /// already. 993 /// 994 bool LLParser::ParseGlobal(const std::string &Name, LocTy NameLoc, 995 unsigned Linkage, bool HasLinkage, 996 unsigned Visibility, unsigned DLLStorageClass, 997 bool DSOLocal, GlobalVariable::ThreadLocalMode TLM, 998 GlobalVariable::UnnamedAddr UnnamedAddr) { 999 if (!isValidVisibilityForLinkage(Visibility, Linkage)) 1000 return Error(NameLoc, 1001 "symbol with local linkage must have default visibility"); 1002 1003 unsigned AddrSpace; 1004 bool IsConstant, IsExternallyInitialized; 1005 LocTy IsExternallyInitializedLoc; 1006 LocTy TyLoc; 1007 1008 Type *Ty = nullptr; 1009 if (ParseOptionalAddrSpace(AddrSpace) || 1010 ParseOptionalToken(lltok::kw_externally_initialized, 1011 IsExternallyInitialized, 1012 &IsExternallyInitializedLoc) || 1013 ParseGlobalType(IsConstant) || 1014 ParseType(Ty, TyLoc)) 1015 return true; 1016 1017 // If the linkage is specified and is external, then no initializer is 1018 // present. 1019 Constant *Init = nullptr; 1020 if (!HasLinkage || 1021 !GlobalValue::isValidDeclarationLinkage( 1022 (GlobalValue::LinkageTypes)Linkage)) { 1023 if (ParseGlobalValue(Ty, Init)) 1024 return true; 1025 } 1026 1027 if (Ty->isFunctionTy() || !PointerType::isValidElementType(Ty)) 1028 return Error(TyLoc, "invalid type for global variable"); 1029 1030 GlobalValue *GVal = nullptr; 1031 1032 // See if the global was forward referenced, if so, use the global. 1033 if (!Name.empty()) { 1034 GVal = M->getNamedValue(Name); 1035 if (GVal) { 1036 if (!ForwardRefVals.erase(Name)) 1037 return Error(NameLoc, "redefinition of global '@" + Name + "'"); 1038 } 1039 } else { 1040 auto I = ForwardRefValIDs.find(NumberedVals.size()); 1041 if (I != ForwardRefValIDs.end()) { 1042 GVal = I->second.first; 1043 ForwardRefValIDs.erase(I); 1044 } 1045 } 1046 1047 GlobalVariable *GV; 1048 if (!GVal) { 1049 GV = new GlobalVariable(*M, Ty, false, GlobalValue::ExternalLinkage, nullptr, 1050 Name, nullptr, GlobalVariable::NotThreadLocal, 1051 AddrSpace); 1052 } else { 1053 if (GVal->getValueType() != Ty) 1054 return Error(TyLoc, 1055 "forward reference and definition of global have different types"); 1056 1057 GV = cast<GlobalVariable>(GVal); 1058 1059 // Move the forward-reference to the correct spot in the module. 1060 M->getGlobalList().splice(M->global_end(), M->getGlobalList(), GV); 1061 } 1062 1063 if (Name.empty()) 1064 NumberedVals.push_back(GV); 1065 1066 // Set the parsed properties on the global. 1067 if (Init) 1068 GV->setInitializer(Init); 1069 GV->setConstant(IsConstant); 1070 GV->setLinkage((GlobalValue::LinkageTypes)Linkage); 1071 maybeSetDSOLocal(DSOLocal, *GV); 1072 GV->setVisibility((GlobalValue::VisibilityTypes)Visibility); 1073 GV->setDLLStorageClass((GlobalValue::DLLStorageClassTypes)DLLStorageClass); 1074 GV->setExternallyInitialized(IsExternallyInitialized); 1075 GV->setThreadLocalMode(TLM); 1076 GV->setUnnamedAddr(UnnamedAddr); 1077 1078 // Parse attributes on the global. 1079 while (Lex.getKind() == lltok::comma) { 1080 Lex.Lex(); 1081 1082 if (Lex.getKind() == lltok::kw_section) { 1083 Lex.Lex(); 1084 GV->setSection(Lex.getStrVal()); 1085 if (ParseToken(lltok::StringConstant, "expected global section string")) 1086 return true; 1087 } else if (Lex.getKind() == lltok::kw_align) { 1088 unsigned Alignment; 1089 if (ParseOptionalAlignment(Alignment)) return true; 1090 GV->setAlignment(Alignment); 1091 } else if (Lex.getKind() == lltok::MetadataVar) { 1092 if (ParseGlobalObjectMetadataAttachment(*GV)) 1093 return true; 1094 } else { 1095 Comdat *C; 1096 if (parseOptionalComdat(Name, C)) 1097 return true; 1098 if (C) 1099 GV->setComdat(C); 1100 else 1101 return TokError("unknown global variable property!"); 1102 } 1103 } 1104 1105 AttrBuilder Attrs; 1106 LocTy BuiltinLoc; 1107 std::vector<unsigned> FwdRefAttrGrps; 1108 if (ParseFnAttributeValuePairs(Attrs, FwdRefAttrGrps, false, BuiltinLoc)) 1109 return true; 1110 if (Attrs.hasAttributes() || !FwdRefAttrGrps.empty()) { 1111 GV->setAttributes(AttributeSet::get(Context, Attrs)); 1112 ForwardRefAttrGroups[GV] = FwdRefAttrGrps; 1113 } 1114 1115 return false; 1116 } 1117 1118 /// ParseUnnamedAttrGrp 1119 /// ::= 'attributes' AttrGrpID '=' '{' AttrValPair+ '}' 1120 bool LLParser::ParseUnnamedAttrGrp() { 1121 assert(Lex.getKind() == lltok::kw_attributes); 1122 LocTy AttrGrpLoc = Lex.getLoc(); 1123 Lex.Lex(); 1124 1125 if (Lex.getKind() != lltok::AttrGrpID) 1126 return TokError("expected attribute group id"); 1127 1128 unsigned VarID = Lex.getUIntVal(); 1129 std::vector<unsigned> unused; 1130 LocTy BuiltinLoc; 1131 Lex.Lex(); 1132 1133 if (ParseToken(lltok::equal, "expected '=' here") || 1134 ParseToken(lltok::lbrace, "expected '{' here") || 1135 ParseFnAttributeValuePairs(NumberedAttrBuilders[VarID], unused, true, 1136 BuiltinLoc) || 1137 ParseToken(lltok::rbrace, "expected end of attribute group")) 1138 return true; 1139 1140 if (!NumberedAttrBuilders[VarID].hasAttributes()) 1141 return Error(AttrGrpLoc, "attribute group has no attributes"); 1142 1143 return false; 1144 } 1145 1146 /// ParseFnAttributeValuePairs 1147 /// ::= <attr> | <attr> '=' <value> 1148 bool LLParser::ParseFnAttributeValuePairs(AttrBuilder &B, 1149 std::vector<unsigned> &FwdRefAttrGrps, 1150 bool inAttrGrp, LocTy &BuiltinLoc) { 1151 bool HaveError = false; 1152 1153 B.clear(); 1154 1155 while (true) { 1156 lltok::Kind Token = Lex.getKind(); 1157 if (Token == lltok::kw_builtin) 1158 BuiltinLoc = Lex.getLoc(); 1159 switch (Token) { 1160 default: 1161 if (!inAttrGrp) return HaveError; 1162 return Error(Lex.getLoc(), "unterminated attribute group"); 1163 case lltok::rbrace: 1164 // Finished. 1165 return false; 1166 1167 case lltok::AttrGrpID: { 1168 // Allow a function to reference an attribute group: 1169 // 1170 // define void @foo() #1 { ... } 1171 if (inAttrGrp) 1172 HaveError |= 1173 Error(Lex.getLoc(), 1174 "cannot have an attribute group reference in an attribute group"); 1175 1176 unsigned AttrGrpNum = Lex.getUIntVal(); 1177 if (inAttrGrp) break; 1178 1179 // Save the reference to the attribute group. We'll fill it in later. 1180 FwdRefAttrGrps.push_back(AttrGrpNum); 1181 break; 1182 } 1183 // Target-dependent attributes: 1184 case lltok::StringConstant: { 1185 if (ParseStringAttribute(B)) 1186 return true; 1187 continue; 1188 } 1189 1190 // Target-independent attributes: 1191 case lltok::kw_align: { 1192 // As a hack, we allow function alignment to be initially parsed as an 1193 // attribute on a function declaration/definition or added to an attribute 1194 // group and later moved to the alignment field. 1195 unsigned Alignment; 1196 if (inAttrGrp) { 1197 Lex.Lex(); 1198 if (ParseToken(lltok::equal, "expected '=' here") || 1199 ParseUInt32(Alignment)) 1200 return true; 1201 } else { 1202 if (ParseOptionalAlignment(Alignment)) 1203 return true; 1204 } 1205 B.addAlignmentAttr(Alignment); 1206 continue; 1207 } 1208 case lltok::kw_alignstack: { 1209 unsigned Alignment; 1210 if (inAttrGrp) { 1211 Lex.Lex(); 1212 if (ParseToken(lltok::equal, "expected '=' here") || 1213 ParseUInt32(Alignment)) 1214 return true; 1215 } else { 1216 if (ParseOptionalStackAlignment(Alignment)) 1217 return true; 1218 } 1219 B.addStackAlignmentAttr(Alignment); 1220 continue; 1221 } 1222 case lltok::kw_allocsize: { 1223 unsigned ElemSizeArg; 1224 Optional<unsigned> NumElemsArg; 1225 // inAttrGrp doesn't matter; we only support allocsize(a[, b]) 1226 if (parseAllocSizeArguments(ElemSizeArg, NumElemsArg)) 1227 return true; 1228 B.addAllocSizeAttr(ElemSizeArg, NumElemsArg); 1229 continue; 1230 } 1231 case lltok::kw_alwaysinline: B.addAttribute(Attribute::AlwaysInline); break; 1232 case lltok::kw_argmemonly: B.addAttribute(Attribute::ArgMemOnly); break; 1233 case lltok::kw_builtin: B.addAttribute(Attribute::Builtin); break; 1234 case lltok::kw_cold: B.addAttribute(Attribute::Cold); break; 1235 case lltok::kw_convergent: B.addAttribute(Attribute::Convergent); break; 1236 case lltok::kw_inaccessiblememonly: 1237 B.addAttribute(Attribute::InaccessibleMemOnly); break; 1238 case lltok::kw_inaccessiblemem_or_argmemonly: 1239 B.addAttribute(Attribute::InaccessibleMemOrArgMemOnly); break; 1240 case lltok::kw_inlinehint: B.addAttribute(Attribute::InlineHint); break; 1241 case lltok::kw_jumptable: B.addAttribute(Attribute::JumpTable); break; 1242 case lltok::kw_minsize: B.addAttribute(Attribute::MinSize); break; 1243 case lltok::kw_naked: B.addAttribute(Attribute::Naked); break; 1244 case lltok::kw_nobuiltin: B.addAttribute(Attribute::NoBuiltin); break; 1245 case lltok::kw_noduplicate: B.addAttribute(Attribute::NoDuplicate); break; 1246 case lltok::kw_noimplicitfloat: 1247 B.addAttribute(Attribute::NoImplicitFloat); break; 1248 case lltok::kw_noinline: B.addAttribute(Attribute::NoInline); break; 1249 case lltok::kw_nonlazybind: B.addAttribute(Attribute::NonLazyBind); break; 1250 case lltok::kw_noredzone: B.addAttribute(Attribute::NoRedZone); break; 1251 case lltok::kw_noreturn: B.addAttribute(Attribute::NoReturn); break; 1252 case lltok::kw_nocf_check: B.addAttribute(Attribute::NoCfCheck); break; 1253 case lltok::kw_norecurse: B.addAttribute(Attribute::NoRecurse); break; 1254 case lltok::kw_nounwind: B.addAttribute(Attribute::NoUnwind); break; 1255 case lltok::kw_optforfuzzing: 1256 B.addAttribute(Attribute::OptForFuzzing); break; 1257 case lltok::kw_optnone: B.addAttribute(Attribute::OptimizeNone); break; 1258 case lltok::kw_optsize: B.addAttribute(Attribute::OptimizeForSize); break; 1259 case lltok::kw_readnone: B.addAttribute(Attribute::ReadNone); break; 1260 case lltok::kw_readonly: B.addAttribute(Attribute::ReadOnly); break; 1261 case lltok::kw_returns_twice: 1262 B.addAttribute(Attribute::ReturnsTwice); break; 1263 case lltok::kw_speculatable: B.addAttribute(Attribute::Speculatable); break; 1264 case lltok::kw_ssp: B.addAttribute(Attribute::StackProtect); break; 1265 case lltok::kw_sspreq: B.addAttribute(Attribute::StackProtectReq); break; 1266 case lltok::kw_sspstrong: 1267 B.addAttribute(Attribute::StackProtectStrong); break; 1268 case lltok::kw_safestack: B.addAttribute(Attribute::SafeStack); break; 1269 case lltok::kw_shadowcallstack: 1270 B.addAttribute(Attribute::ShadowCallStack); break; 1271 case lltok::kw_sanitize_address: 1272 B.addAttribute(Attribute::SanitizeAddress); break; 1273 case lltok::kw_sanitize_hwaddress: 1274 B.addAttribute(Attribute::SanitizeHWAddress); break; 1275 case lltok::kw_sanitize_thread: 1276 B.addAttribute(Attribute::SanitizeThread); break; 1277 case lltok::kw_sanitize_memory: 1278 B.addAttribute(Attribute::SanitizeMemory); break; 1279 case lltok::kw_speculative_load_hardening: 1280 B.addAttribute(Attribute::SpeculativeLoadHardening); 1281 break; 1282 case lltok::kw_strictfp: B.addAttribute(Attribute::StrictFP); break; 1283 case lltok::kw_uwtable: B.addAttribute(Attribute::UWTable); break; 1284 case lltok::kw_writeonly: B.addAttribute(Attribute::WriteOnly); break; 1285 1286 // Error handling. 1287 case lltok::kw_inreg: 1288 case lltok::kw_signext: 1289 case lltok::kw_zeroext: 1290 HaveError |= 1291 Error(Lex.getLoc(), 1292 "invalid use of attribute on a function"); 1293 break; 1294 case lltok::kw_byval: 1295 case lltok::kw_dereferenceable: 1296 case lltok::kw_dereferenceable_or_null: 1297 case lltok::kw_inalloca: 1298 case lltok::kw_nest: 1299 case lltok::kw_noalias: 1300 case lltok::kw_nocapture: 1301 case lltok::kw_nonnull: 1302 case lltok::kw_returned: 1303 case lltok::kw_sret: 1304 case lltok::kw_swifterror: 1305 case lltok::kw_swiftself: 1306 HaveError |= 1307 Error(Lex.getLoc(), 1308 "invalid use of parameter-only attribute on a function"); 1309 break; 1310 } 1311 1312 Lex.Lex(); 1313 } 1314 } 1315 1316 //===----------------------------------------------------------------------===// 1317 // GlobalValue Reference/Resolution Routines. 1318 //===----------------------------------------------------------------------===// 1319 1320 static inline GlobalValue *createGlobalFwdRef(Module *M, PointerType *PTy, 1321 const std::string &Name) { 1322 if (auto *FT = dyn_cast<FunctionType>(PTy->getElementType())) 1323 return Function::Create(FT, GlobalValue::ExternalWeakLinkage, 1324 PTy->getAddressSpace(), Name, M); 1325 else 1326 return new GlobalVariable(*M, PTy->getElementType(), false, 1327 GlobalValue::ExternalWeakLinkage, nullptr, Name, 1328 nullptr, GlobalVariable::NotThreadLocal, 1329 PTy->getAddressSpace()); 1330 } 1331 1332 Value *LLParser::checkValidVariableType(LocTy Loc, const Twine &Name, Type *Ty, 1333 Value *Val, bool IsCall) { 1334 if (Val->getType() == Ty) 1335 return Val; 1336 // For calls we also accept variables in the program address space. 1337 Type *SuggestedTy = Ty; 1338 if (IsCall && isa<PointerType>(Ty)) { 1339 Type *TyInProgAS = cast<PointerType>(Ty)->getElementType()->getPointerTo( 1340 M->getDataLayout().getProgramAddressSpace()); 1341 SuggestedTy = TyInProgAS; 1342 if (Val->getType() == TyInProgAS) 1343 return Val; 1344 } 1345 if (Ty->isLabelTy()) 1346 Error(Loc, "'" + Name + "' is not a basic block"); 1347 else 1348 Error(Loc, "'" + Name + "' defined with type '" + 1349 getTypeString(Val->getType()) + "' but expected '" + 1350 getTypeString(SuggestedTy) + "'"); 1351 return nullptr; 1352 } 1353 1354 /// GetGlobalVal - Get a value with the specified name or ID, creating a 1355 /// forward reference record if needed. This can return null if the value 1356 /// exists but does not have the right type. 1357 GlobalValue *LLParser::GetGlobalVal(const std::string &Name, Type *Ty, 1358 LocTy Loc, bool IsCall) { 1359 PointerType *PTy = dyn_cast<PointerType>(Ty); 1360 if (!PTy) { 1361 Error(Loc, "global variable reference must have pointer type"); 1362 return nullptr; 1363 } 1364 1365 // Look this name up in the normal function symbol table. 1366 GlobalValue *Val = 1367 cast_or_null<GlobalValue>(M->getValueSymbolTable().lookup(Name)); 1368 1369 // If this is a forward reference for the value, see if we already created a 1370 // forward ref record. 1371 if (!Val) { 1372 auto I = ForwardRefVals.find(Name); 1373 if (I != ForwardRefVals.end()) 1374 Val = I->second.first; 1375 } 1376 1377 // If we have the value in the symbol table or fwd-ref table, return it. 1378 if (Val) 1379 return cast_or_null<GlobalValue>( 1380 checkValidVariableType(Loc, "@" + Name, Ty, Val, IsCall)); 1381 1382 // Otherwise, create a new forward reference for this value and remember it. 1383 GlobalValue *FwdVal = createGlobalFwdRef(M, PTy, Name); 1384 ForwardRefVals[Name] = std::make_pair(FwdVal, Loc); 1385 return FwdVal; 1386 } 1387 1388 GlobalValue *LLParser::GetGlobalVal(unsigned ID, Type *Ty, LocTy Loc, 1389 bool IsCall) { 1390 PointerType *PTy = dyn_cast<PointerType>(Ty); 1391 if (!PTy) { 1392 Error(Loc, "global variable reference must have pointer type"); 1393 return nullptr; 1394 } 1395 1396 GlobalValue *Val = ID < NumberedVals.size() ? NumberedVals[ID] : nullptr; 1397 1398 // If this is a forward reference for the value, see if we already created a 1399 // forward ref record. 1400 if (!Val) { 1401 auto I = ForwardRefValIDs.find(ID); 1402 if (I != ForwardRefValIDs.end()) 1403 Val = I->second.first; 1404 } 1405 1406 // If we have the value in the symbol table or fwd-ref table, return it. 1407 if (Val) 1408 return cast_or_null<GlobalValue>( 1409 checkValidVariableType(Loc, "@" + Twine(ID), Ty, Val, IsCall)); 1410 1411 // Otherwise, create a new forward reference for this value and remember it. 1412 GlobalValue *FwdVal = createGlobalFwdRef(M, PTy, ""); 1413 ForwardRefValIDs[ID] = std::make_pair(FwdVal, Loc); 1414 return FwdVal; 1415 } 1416 1417 //===----------------------------------------------------------------------===// 1418 // Comdat Reference/Resolution Routines. 1419 //===----------------------------------------------------------------------===// 1420 1421 Comdat *LLParser::getComdat(const std::string &Name, LocTy Loc) { 1422 // Look this name up in the comdat symbol table. 1423 Module::ComdatSymTabType &ComdatSymTab = M->getComdatSymbolTable(); 1424 Module::ComdatSymTabType::iterator I = ComdatSymTab.find(Name); 1425 if (I != ComdatSymTab.end()) 1426 return &I->second; 1427 1428 // Otherwise, create a new forward reference for this value and remember it. 1429 Comdat *C = M->getOrInsertComdat(Name); 1430 ForwardRefComdats[Name] = Loc; 1431 return C; 1432 } 1433 1434 //===----------------------------------------------------------------------===// 1435 // Helper Routines. 1436 //===----------------------------------------------------------------------===// 1437 1438 /// ParseToken - If the current token has the specified kind, eat it and return 1439 /// success. Otherwise, emit the specified error and return failure. 1440 bool LLParser::ParseToken(lltok::Kind T, const char *ErrMsg) { 1441 if (Lex.getKind() != T) 1442 return TokError(ErrMsg); 1443 Lex.Lex(); 1444 return false; 1445 } 1446 1447 /// ParseStringConstant 1448 /// ::= StringConstant 1449 bool LLParser::ParseStringConstant(std::string &Result) { 1450 if (Lex.getKind() != lltok::StringConstant) 1451 return TokError("expected string constant"); 1452 Result = Lex.getStrVal(); 1453 Lex.Lex(); 1454 return false; 1455 } 1456 1457 /// ParseUInt32 1458 /// ::= uint32 1459 bool LLParser::ParseUInt32(uint32_t &Val) { 1460 if (Lex.getKind() != lltok::APSInt || Lex.getAPSIntVal().isSigned()) 1461 return TokError("expected integer"); 1462 uint64_t Val64 = Lex.getAPSIntVal().getLimitedValue(0xFFFFFFFFULL+1); 1463 if (Val64 != unsigned(Val64)) 1464 return TokError("expected 32-bit integer (too large)"); 1465 Val = Val64; 1466 Lex.Lex(); 1467 return false; 1468 } 1469 1470 /// ParseUInt64 1471 /// ::= uint64 1472 bool LLParser::ParseUInt64(uint64_t &Val) { 1473 if (Lex.getKind() != lltok::APSInt || Lex.getAPSIntVal().isSigned()) 1474 return TokError("expected integer"); 1475 Val = Lex.getAPSIntVal().getLimitedValue(); 1476 Lex.Lex(); 1477 return false; 1478 } 1479 1480 /// ParseTLSModel 1481 /// := 'localdynamic' 1482 /// := 'initialexec' 1483 /// := 'localexec' 1484 bool LLParser::ParseTLSModel(GlobalVariable::ThreadLocalMode &TLM) { 1485 switch (Lex.getKind()) { 1486 default: 1487 return TokError("expected localdynamic, initialexec or localexec"); 1488 case lltok::kw_localdynamic: 1489 TLM = GlobalVariable::LocalDynamicTLSModel; 1490 break; 1491 case lltok::kw_initialexec: 1492 TLM = GlobalVariable::InitialExecTLSModel; 1493 break; 1494 case lltok::kw_localexec: 1495 TLM = GlobalVariable::LocalExecTLSModel; 1496 break; 1497 } 1498 1499 Lex.Lex(); 1500 return false; 1501 } 1502 1503 /// ParseOptionalThreadLocal 1504 /// := /*empty*/ 1505 /// := 'thread_local' 1506 /// := 'thread_local' '(' tlsmodel ')' 1507 bool LLParser::ParseOptionalThreadLocal(GlobalVariable::ThreadLocalMode &TLM) { 1508 TLM = GlobalVariable::NotThreadLocal; 1509 if (!EatIfPresent(lltok::kw_thread_local)) 1510 return false; 1511 1512 TLM = GlobalVariable::GeneralDynamicTLSModel; 1513 if (Lex.getKind() == lltok::lparen) { 1514 Lex.Lex(); 1515 return ParseTLSModel(TLM) || 1516 ParseToken(lltok::rparen, "expected ')' after thread local model"); 1517 } 1518 return false; 1519 } 1520 1521 /// ParseOptionalAddrSpace 1522 /// := /*empty*/ 1523 /// := 'addrspace' '(' uint32 ')' 1524 bool LLParser::ParseOptionalAddrSpace(unsigned &AddrSpace, unsigned DefaultAS) { 1525 AddrSpace = DefaultAS; 1526 if (!EatIfPresent(lltok::kw_addrspace)) 1527 return false; 1528 return ParseToken(lltok::lparen, "expected '(' in address space") || 1529 ParseUInt32(AddrSpace) || 1530 ParseToken(lltok::rparen, "expected ')' in address space"); 1531 } 1532 1533 /// ParseStringAttribute 1534 /// := StringConstant 1535 /// := StringConstant '=' StringConstant 1536 bool LLParser::ParseStringAttribute(AttrBuilder &B) { 1537 std::string Attr = Lex.getStrVal(); 1538 Lex.Lex(); 1539 std::string Val; 1540 if (EatIfPresent(lltok::equal) && ParseStringConstant(Val)) 1541 return true; 1542 B.addAttribute(Attr, Val); 1543 return false; 1544 } 1545 1546 /// ParseOptionalParamAttrs - Parse a potentially empty list of parameter attributes. 1547 bool LLParser::ParseOptionalParamAttrs(AttrBuilder &B) { 1548 bool HaveError = false; 1549 1550 B.clear(); 1551 1552 while (true) { 1553 lltok::Kind Token = Lex.getKind(); 1554 switch (Token) { 1555 default: // End of attributes. 1556 return HaveError; 1557 case lltok::StringConstant: { 1558 if (ParseStringAttribute(B)) 1559 return true; 1560 continue; 1561 } 1562 case lltok::kw_align: { 1563 unsigned Alignment; 1564 if (ParseOptionalAlignment(Alignment)) 1565 return true; 1566 B.addAlignmentAttr(Alignment); 1567 continue; 1568 } 1569 case lltok::kw_byval: B.addAttribute(Attribute::ByVal); break; 1570 case lltok::kw_dereferenceable: { 1571 uint64_t Bytes; 1572 if (ParseOptionalDerefAttrBytes(lltok::kw_dereferenceable, Bytes)) 1573 return true; 1574 B.addDereferenceableAttr(Bytes); 1575 continue; 1576 } 1577 case lltok::kw_dereferenceable_or_null: { 1578 uint64_t Bytes; 1579 if (ParseOptionalDerefAttrBytes(lltok::kw_dereferenceable_or_null, Bytes)) 1580 return true; 1581 B.addDereferenceableOrNullAttr(Bytes); 1582 continue; 1583 } 1584 case lltok::kw_inalloca: B.addAttribute(Attribute::InAlloca); break; 1585 case lltok::kw_inreg: B.addAttribute(Attribute::InReg); break; 1586 case lltok::kw_nest: B.addAttribute(Attribute::Nest); break; 1587 case lltok::kw_noalias: B.addAttribute(Attribute::NoAlias); break; 1588 case lltok::kw_nocapture: B.addAttribute(Attribute::NoCapture); break; 1589 case lltok::kw_nonnull: B.addAttribute(Attribute::NonNull); break; 1590 case lltok::kw_readnone: B.addAttribute(Attribute::ReadNone); break; 1591 case lltok::kw_readonly: B.addAttribute(Attribute::ReadOnly); break; 1592 case lltok::kw_returned: B.addAttribute(Attribute::Returned); break; 1593 case lltok::kw_signext: B.addAttribute(Attribute::SExt); break; 1594 case lltok::kw_sret: B.addAttribute(Attribute::StructRet); break; 1595 case lltok::kw_swifterror: B.addAttribute(Attribute::SwiftError); break; 1596 case lltok::kw_swiftself: B.addAttribute(Attribute::SwiftSelf); break; 1597 case lltok::kw_writeonly: B.addAttribute(Attribute::WriteOnly); break; 1598 case lltok::kw_zeroext: B.addAttribute(Attribute::ZExt); break; 1599 1600 case lltok::kw_alignstack: 1601 case lltok::kw_alwaysinline: 1602 case lltok::kw_argmemonly: 1603 case lltok::kw_builtin: 1604 case lltok::kw_inlinehint: 1605 case lltok::kw_jumptable: 1606 case lltok::kw_minsize: 1607 case lltok::kw_naked: 1608 case lltok::kw_nobuiltin: 1609 case lltok::kw_noduplicate: 1610 case lltok::kw_noimplicitfloat: 1611 case lltok::kw_noinline: 1612 case lltok::kw_nonlazybind: 1613 case lltok::kw_noredzone: 1614 case lltok::kw_noreturn: 1615 case lltok::kw_nocf_check: 1616 case lltok::kw_nounwind: 1617 case lltok::kw_optforfuzzing: 1618 case lltok::kw_optnone: 1619 case lltok::kw_optsize: 1620 case lltok::kw_returns_twice: 1621 case lltok::kw_sanitize_address: 1622 case lltok::kw_sanitize_hwaddress: 1623 case lltok::kw_sanitize_memory: 1624 case lltok::kw_sanitize_thread: 1625 case lltok::kw_speculative_load_hardening: 1626 case lltok::kw_ssp: 1627 case lltok::kw_sspreq: 1628 case lltok::kw_sspstrong: 1629 case lltok::kw_safestack: 1630 case lltok::kw_shadowcallstack: 1631 case lltok::kw_strictfp: 1632 case lltok::kw_uwtable: 1633 HaveError |= Error(Lex.getLoc(), "invalid use of function-only attribute"); 1634 break; 1635 } 1636 1637 Lex.Lex(); 1638 } 1639 } 1640 1641 /// ParseOptionalReturnAttrs - Parse a potentially empty list of return attributes. 1642 bool LLParser::ParseOptionalReturnAttrs(AttrBuilder &B) { 1643 bool HaveError = false; 1644 1645 B.clear(); 1646 1647 while (true) { 1648 lltok::Kind Token = Lex.getKind(); 1649 switch (Token) { 1650 default: // End of attributes. 1651 return HaveError; 1652 case lltok::StringConstant: { 1653 if (ParseStringAttribute(B)) 1654 return true; 1655 continue; 1656 } 1657 case lltok::kw_dereferenceable: { 1658 uint64_t Bytes; 1659 if (ParseOptionalDerefAttrBytes(lltok::kw_dereferenceable, Bytes)) 1660 return true; 1661 B.addDereferenceableAttr(Bytes); 1662 continue; 1663 } 1664 case lltok::kw_dereferenceable_or_null: { 1665 uint64_t Bytes; 1666 if (ParseOptionalDerefAttrBytes(lltok::kw_dereferenceable_or_null, Bytes)) 1667 return true; 1668 B.addDereferenceableOrNullAttr(Bytes); 1669 continue; 1670 } 1671 case lltok::kw_align: { 1672 unsigned Alignment; 1673 if (ParseOptionalAlignment(Alignment)) 1674 return true; 1675 B.addAlignmentAttr(Alignment); 1676 continue; 1677 } 1678 case lltok::kw_inreg: B.addAttribute(Attribute::InReg); break; 1679 case lltok::kw_noalias: B.addAttribute(Attribute::NoAlias); break; 1680 case lltok::kw_nonnull: B.addAttribute(Attribute::NonNull); break; 1681 case lltok::kw_signext: B.addAttribute(Attribute::SExt); break; 1682 case lltok::kw_zeroext: B.addAttribute(Attribute::ZExt); break; 1683 1684 // Error handling. 1685 case lltok::kw_byval: 1686 case lltok::kw_inalloca: 1687 case lltok::kw_nest: 1688 case lltok::kw_nocapture: 1689 case lltok::kw_returned: 1690 case lltok::kw_sret: 1691 case lltok::kw_swifterror: 1692 case lltok::kw_swiftself: 1693 HaveError |= Error(Lex.getLoc(), "invalid use of parameter-only attribute"); 1694 break; 1695 1696 case lltok::kw_alignstack: 1697 case lltok::kw_alwaysinline: 1698 case lltok::kw_argmemonly: 1699 case lltok::kw_builtin: 1700 case lltok::kw_cold: 1701 case lltok::kw_inlinehint: 1702 case lltok::kw_jumptable: 1703 case lltok::kw_minsize: 1704 case lltok::kw_naked: 1705 case lltok::kw_nobuiltin: 1706 case lltok::kw_noduplicate: 1707 case lltok::kw_noimplicitfloat: 1708 case lltok::kw_noinline: 1709 case lltok::kw_nonlazybind: 1710 case lltok::kw_noredzone: 1711 case lltok::kw_noreturn: 1712 case lltok::kw_nocf_check: 1713 case lltok::kw_nounwind: 1714 case lltok::kw_optforfuzzing: 1715 case lltok::kw_optnone: 1716 case lltok::kw_optsize: 1717 case lltok::kw_returns_twice: 1718 case lltok::kw_sanitize_address: 1719 case lltok::kw_sanitize_hwaddress: 1720 case lltok::kw_sanitize_memory: 1721 case lltok::kw_sanitize_thread: 1722 case lltok::kw_speculative_load_hardening: 1723 case lltok::kw_ssp: 1724 case lltok::kw_sspreq: 1725 case lltok::kw_sspstrong: 1726 case lltok::kw_safestack: 1727 case lltok::kw_shadowcallstack: 1728 case lltok::kw_strictfp: 1729 case lltok::kw_uwtable: 1730 HaveError |= Error(Lex.getLoc(), "invalid use of function-only attribute"); 1731 break; 1732 1733 case lltok::kw_readnone: 1734 case lltok::kw_readonly: 1735 HaveError |= Error(Lex.getLoc(), "invalid use of attribute on return type"); 1736 } 1737 1738 Lex.Lex(); 1739 } 1740 } 1741 1742 static unsigned parseOptionalLinkageAux(lltok::Kind Kind, bool &HasLinkage) { 1743 HasLinkage = true; 1744 switch (Kind) { 1745 default: 1746 HasLinkage = false; 1747 return GlobalValue::ExternalLinkage; 1748 case lltok::kw_private: 1749 return GlobalValue::PrivateLinkage; 1750 case lltok::kw_internal: 1751 return GlobalValue::InternalLinkage; 1752 case lltok::kw_weak: 1753 return GlobalValue::WeakAnyLinkage; 1754 case lltok::kw_weak_odr: 1755 return GlobalValue::WeakODRLinkage; 1756 case lltok::kw_linkonce: 1757 return GlobalValue::LinkOnceAnyLinkage; 1758 case lltok::kw_linkonce_odr: 1759 return GlobalValue::LinkOnceODRLinkage; 1760 case lltok::kw_available_externally: 1761 return GlobalValue::AvailableExternallyLinkage; 1762 case lltok::kw_appending: 1763 return GlobalValue::AppendingLinkage; 1764 case lltok::kw_common: 1765 return GlobalValue::CommonLinkage; 1766 case lltok::kw_extern_weak: 1767 return GlobalValue::ExternalWeakLinkage; 1768 case lltok::kw_external: 1769 return GlobalValue::ExternalLinkage; 1770 } 1771 } 1772 1773 /// ParseOptionalLinkage 1774 /// ::= /*empty*/ 1775 /// ::= 'private' 1776 /// ::= 'internal' 1777 /// ::= 'weak' 1778 /// ::= 'weak_odr' 1779 /// ::= 'linkonce' 1780 /// ::= 'linkonce_odr' 1781 /// ::= 'available_externally' 1782 /// ::= 'appending' 1783 /// ::= 'common' 1784 /// ::= 'extern_weak' 1785 /// ::= 'external' 1786 bool LLParser::ParseOptionalLinkage(unsigned &Res, bool &HasLinkage, 1787 unsigned &Visibility, 1788 unsigned &DLLStorageClass, 1789 bool &DSOLocal) { 1790 Res = parseOptionalLinkageAux(Lex.getKind(), HasLinkage); 1791 if (HasLinkage) 1792 Lex.Lex(); 1793 ParseOptionalDSOLocal(DSOLocal); 1794 ParseOptionalVisibility(Visibility); 1795 ParseOptionalDLLStorageClass(DLLStorageClass); 1796 1797 if (DSOLocal && DLLStorageClass == GlobalValue::DLLImportStorageClass) { 1798 return Error(Lex.getLoc(), "dso_location and DLL-StorageClass mismatch"); 1799 } 1800 1801 return false; 1802 } 1803 1804 void LLParser::ParseOptionalDSOLocal(bool &DSOLocal) { 1805 switch (Lex.getKind()) { 1806 default: 1807 DSOLocal = false; 1808 break; 1809 case lltok::kw_dso_local: 1810 DSOLocal = true; 1811 Lex.Lex(); 1812 break; 1813 case lltok::kw_dso_preemptable: 1814 DSOLocal = false; 1815 Lex.Lex(); 1816 break; 1817 } 1818 } 1819 1820 /// ParseOptionalVisibility 1821 /// ::= /*empty*/ 1822 /// ::= 'default' 1823 /// ::= 'hidden' 1824 /// ::= 'protected' 1825 /// 1826 void LLParser::ParseOptionalVisibility(unsigned &Res) { 1827 switch (Lex.getKind()) { 1828 default: 1829 Res = GlobalValue::DefaultVisibility; 1830 return; 1831 case lltok::kw_default: 1832 Res = GlobalValue::DefaultVisibility; 1833 break; 1834 case lltok::kw_hidden: 1835 Res = GlobalValue::HiddenVisibility; 1836 break; 1837 case lltok::kw_protected: 1838 Res = GlobalValue::ProtectedVisibility; 1839 break; 1840 } 1841 Lex.Lex(); 1842 } 1843 1844 /// ParseOptionalDLLStorageClass 1845 /// ::= /*empty*/ 1846 /// ::= 'dllimport' 1847 /// ::= 'dllexport' 1848 /// 1849 void LLParser::ParseOptionalDLLStorageClass(unsigned &Res) { 1850 switch (Lex.getKind()) { 1851 default: 1852 Res = GlobalValue::DefaultStorageClass; 1853 return; 1854 case lltok::kw_dllimport: 1855 Res = GlobalValue::DLLImportStorageClass; 1856 break; 1857 case lltok::kw_dllexport: 1858 Res = GlobalValue::DLLExportStorageClass; 1859 break; 1860 } 1861 Lex.Lex(); 1862 } 1863 1864 /// ParseOptionalCallingConv 1865 /// ::= /*empty*/ 1866 /// ::= 'ccc' 1867 /// ::= 'fastcc' 1868 /// ::= 'intel_ocl_bicc' 1869 /// ::= 'coldcc' 1870 /// ::= 'x86_stdcallcc' 1871 /// ::= 'x86_fastcallcc' 1872 /// ::= 'x86_thiscallcc' 1873 /// ::= 'x86_vectorcallcc' 1874 /// ::= 'arm_apcscc' 1875 /// ::= 'arm_aapcscc' 1876 /// ::= 'arm_aapcs_vfpcc' 1877 /// ::= 'aarch64_vector_pcs' 1878 /// ::= 'msp430_intrcc' 1879 /// ::= 'avr_intrcc' 1880 /// ::= 'avr_signalcc' 1881 /// ::= 'ptx_kernel' 1882 /// ::= 'ptx_device' 1883 /// ::= 'spir_func' 1884 /// ::= 'spir_kernel' 1885 /// ::= 'x86_64_sysvcc' 1886 /// ::= 'win64cc' 1887 /// ::= 'webkit_jscc' 1888 /// ::= 'anyregcc' 1889 /// ::= 'preserve_mostcc' 1890 /// ::= 'preserve_allcc' 1891 /// ::= 'ghccc' 1892 /// ::= 'swiftcc' 1893 /// ::= 'x86_intrcc' 1894 /// ::= 'hhvmcc' 1895 /// ::= 'hhvm_ccc' 1896 /// ::= 'cxx_fast_tlscc' 1897 /// ::= 'amdgpu_vs' 1898 /// ::= 'amdgpu_ls' 1899 /// ::= 'amdgpu_hs' 1900 /// ::= 'amdgpu_es' 1901 /// ::= 'amdgpu_gs' 1902 /// ::= 'amdgpu_ps' 1903 /// ::= 'amdgpu_cs' 1904 /// ::= 'amdgpu_kernel' 1905 /// ::= 'cc' UINT 1906 /// 1907 bool LLParser::ParseOptionalCallingConv(unsigned &CC) { 1908 switch (Lex.getKind()) { 1909 default: CC = CallingConv::C; return false; 1910 case lltok::kw_ccc: CC = CallingConv::C; break; 1911 case lltok::kw_fastcc: CC = CallingConv::Fast; break; 1912 case lltok::kw_coldcc: CC = CallingConv::Cold; break; 1913 case lltok::kw_x86_stdcallcc: CC = CallingConv::X86_StdCall; break; 1914 case lltok::kw_x86_fastcallcc: CC = CallingConv::X86_FastCall; break; 1915 case lltok::kw_x86_regcallcc: CC = CallingConv::X86_RegCall; break; 1916 case lltok::kw_x86_thiscallcc: CC = CallingConv::X86_ThisCall; break; 1917 case lltok::kw_x86_vectorcallcc:CC = CallingConv::X86_VectorCall; break; 1918 case lltok::kw_arm_apcscc: CC = CallingConv::ARM_APCS; break; 1919 case lltok::kw_arm_aapcscc: CC = CallingConv::ARM_AAPCS; break; 1920 case lltok::kw_arm_aapcs_vfpcc:CC = CallingConv::ARM_AAPCS_VFP; break; 1921 case lltok::kw_aarch64_vector_pcs:CC = CallingConv::AArch64_VectorCall; break; 1922 case lltok::kw_msp430_intrcc: CC = CallingConv::MSP430_INTR; break; 1923 case lltok::kw_avr_intrcc: CC = CallingConv::AVR_INTR; break; 1924 case lltok::kw_avr_signalcc: CC = CallingConv::AVR_SIGNAL; break; 1925 case lltok::kw_ptx_kernel: CC = CallingConv::PTX_Kernel; break; 1926 case lltok::kw_ptx_device: CC = CallingConv::PTX_Device; break; 1927 case lltok::kw_spir_kernel: CC = CallingConv::SPIR_KERNEL; break; 1928 case lltok::kw_spir_func: CC = CallingConv::SPIR_FUNC; break; 1929 case lltok::kw_intel_ocl_bicc: CC = CallingConv::Intel_OCL_BI; break; 1930 case lltok::kw_x86_64_sysvcc: CC = CallingConv::X86_64_SysV; break; 1931 case lltok::kw_win64cc: CC = CallingConv::Win64; break; 1932 case lltok::kw_webkit_jscc: CC = CallingConv::WebKit_JS; break; 1933 case lltok::kw_anyregcc: CC = CallingConv::AnyReg; break; 1934 case lltok::kw_preserve_mostcc:CC = CallingConv::PreserveMost; break; 1935 case lltok::kw_preserve_allcc: CC = CallingConv::PreserveAll; break; 1936 case lltok::kw_ghccc: CC = CallingConv::GHC; break; 1937 case lltok::kw_swiftcc: CC = CallingConv::Swift; break; 1938 case lltok::kw_x86_intrcc: CC = CallingConv::X86_INTR; break; 1939 case lltok::kw_hhvmcc: CC = CallingConv::HHVM; break; 1940 case lltok::kw_hhvm_ccc: CC = CallingConv::HHVM_C; break; 1941 case lltok::kw_cxx_fast_tlscc: CC = CallingConv::CXX_FAST_TLS; break; 1942 case lltok::kw_amdgpu_vs: CC = CallingConv::AMDGPU_VS; break; 1943 case lltok::kw_amdgpu_ls: CC = CallingConv::AMDGPU_LS; break; 1944 case lltok::kw_amdgpu_hs: CC = CallingConv::AMDGPU_HS; break; 1945 case lltok::kw_amdgpu_es: CC = CallingConv::AMDGPU_ES; break; 1946 case lltok::kw_amdgpu_gs: CC = CallingConv::AMDGPU_GS; break; 1947 case lltok::kw_amdgpu_ps: CC = CallingConv::AMDGPU_PS; break; 1948 case lltok::kw_amdgpu_cs: CC = CallingConv::AMDGPU_CS; break; 1949 case lltok::kw_amdgpu_kernel: CC = CallingConv::AMDGPU_KERNEL; break; 1950 case lltok::kw_cc: { 1951 Lex.Lex(); 1952 return ParseUInt32(CC); 1953 } 1954 } 1955 1956 Lex.Lex(); 1957 return false; 1958 } 1959 1960 /// ParseMetadataAttachment 1961 /// ::= !dbg !42 1962 bool LLParser::ParseMetadataAttachment(unsigned &Kind, MDNode *&MD) { 1963 assert(Lex.getKind() == lltok::MetadataVar && "Expected metadata attachment"); 1964 1965 std::string Name = Lex.getStrVal(); 1966 Kind = M->getMDKindID(Name); 1967 Lex.Lex(); 1968 1969 return ParseMDNode(MD); 1970 } 1971 1972 /// ParseInstructionMetadata 1973 /// ::= !dbg !42 (',' !dbg !57)* 1974 bool LLParser::ParseInstructionMetadata(Instruction &Inst) { 1975 do { 1976 if (Lex.getKind() != lltok::MetadataVar) 1977 return TokError("expected metadata after comma"); 1978 1979 unsigned MDK; 1980 MDNode *N; 1981 if (ParseMetadataAttachment(MDK, N)) 1982 return true; 1983 1984 Inst.setMetadata(MDK, N); 1985 if (MDK == LLVMContext::MD_tbaa) 1986 InstsWithTBAATag.push_back(&Inst); 1987 1988 // If this is the end of the list, we're done. 1989 } while (EatIfPresent(lltok::comma)); 1990 return false; 1991 } 1992 1993 /// ParseGlobalObjectMetadataAttachment 1994 /// ::= !dbg !57 1995 bool LLParser::ParseGlobalObjectMetadataAttachment(GlobalObject &GO) { 1996 unsigned MDK; 1997 MDNode *N; 1998 if (ParseMetadataAttachment(MDK, N)) 1999 return true; 2000 2001 GO.addMetadata(MDK, *N); 2002 return false; 2003 } 2004 2005 /// ParseOptionalFunctionMetadata 2006 /// ::= (!dbg !57)* 2007 bool LLParser::ParseOptionalFunctionMetadata(Function &F) { 2008 while (Lex.getKind() == lltok::MetadataVar) 2009 if (ParseGlobalObjectMetadataAttachment(F)) 2010 return true; 2011 return false; 2012 } 2013 2014 /// ParseOptionalAlignment 2015 /// ::= /* empty */ 2016 /// ::= 'align' 4 2017 bool LLParser::ParseOptionalAlignment(unsigned &Alignment) { 2018 Alignment = 0; 2019 if (!EatIfPresent(lltok::kw_align)) 2020 return false; 2021 LocTy AlignLoc = Lex.getLoc(); 2022 if (ParseUInt32(Alignment)) return true; 2023 if (!isPowerOf2_32(Alignment)) 2024 return Error(AlignLoc, "alignment is not a power of two"); 2025 if (Alignment > Value::MaximumAlignment) 2026 return Error(AlignLoc, "huge alignments are not supported yet"); 2027 return false; 2028 } 2029 2030 /// ParseOptionalDerefAttrBytes 2031 /// ::= /* empty */ 2032 /// ::= AttrKind '(' 4 ')' 2033 /// 2034 /// where AttrKind is either 'dereferenceable' or 'dereferenceable_or_null'. 2035 bool LLParser::ParseOptionalDerefAttrBytes(lltok::Kind AttrKind, 2036 uint64_t &Bytes) { 2037 assert((AttrKind == lltok::kw_dereferenceable || 2038 AttrKind == lltok::kw_dereferenceable_or_null) && 2039 "contract!"); 2040 2041 Bytes = 0; 2042 if (!EatIfPresent(AttrKind)) 2043 return false; 2044 LocTy ParenLoc = Lex.getLoc(); 2045 if (!EatIfPresent(lltok::lparen)) 2046 return Error(ParenLoc, "expected '('"); 2047 LocTy DerefLoc = Lex.getLoc(); 2048 if (ParseUInt64(Bytes)) return true; 2049 ParenLoc = Lex.getLoc(); 2050 if (!EatIfPresent(lltok::rparen)) 2051 return Error(ParenLoc, "expected ')'"); 2052 if (!Bytes) 2053 return Error(DerefLoc, "dereferenceable bytes must be non-zero"); 2054 return false; 2055 } 2056 2057 /// ParseOptionalCommaAlign 2058 /// ::= 2059 /// ::= ',' align 4 2060 /// 2061 /// This returns with AteExtraComma set to true if it ate an excess comma at the 2062 /// end. 2063 bool LLParser::ParseOptionalCommaAlign(unsigned &Alignment, 2064 bool &AteExtraComma) { 2065 AteExtraComma = false; 2066 while (EatIfPresent(lltok::comma)) { 2067 // Metadata at the end is an early exit. 2068 if (Lex.getKind() == lltok::MetadataVar) { 2069 AteExtraComma = true; 2070 return false; 2071 } 2072 2073 if (Lex.getKind() != lltok::kw_align) 2074 return Error(Lex.getLoc(), "expected metadata or 'align'"); 2075 2076 if (ParseOptionalAlignment(Alignment)) return true; 2077 } 2078 2079 return false; 2080 } 2081 2082 /// ParseOptionalCommaAddrSpace 2083 /// ::= 2084 /// ::= ',' addrspace(1) 2085 /// 2086 /// This returns with AteExtraComma set to true if it ate an excess comma at the 2087 /// end. 2088 bool LLParser::ParseOptionalCommaAddrSpace(unsigned &AddrSpace, 2089 LocTy &Loc, 2090 bool &AteExtraComma) { 2091 AteExtraComma = false; 2092 while (EatIfPresent(lltok::comma)) { 2093 // Metadata at the end is an early exit. 2094 if (Lex.getKind() == lltok::MetadataVar) { 2095 AteExtraComma = true; 2096 return false; 2097 } 2098 2099 Loc = Lex.getLoc(); 2100 if (Lex.getKind() != lltok::kw_addrspace) 2101 return Error(Lex.getLoc(), "expected metadata or 'addrspace'"); 2102 2103 if (ParseOptionalAddrSpace(AddrSpace)) 2104 return true; 2105 } 2106 2107 return false; 2108 } 2109 2110 bool LLParser::parseAllocSizeArguments(unsigned &BaseSizeArg, 2111 Optional<unsigned> &HowManyArg) { 2112 Lex.Lex(); 2113 2114 auto StartParen = Lex.getLoc(); 2115 if (!EatIfPresent(lltok::lparen)) 2116 return Error(StartParen, "expected '('"); 2117 2118 if (ParseUInt32(BaseSizeArg)) 2119 return true; 2120 2121 if (EatIfPresent(lltok::comma)) { 2122 auto HowManyAt = Lex.getLoc(); 2123 unsigned HowMany; 2124 if (ParseUInt32(HowMany)) 2125 return true; 2126 if (HowMany == BaseSizeArg) 2127 return Error(HowManyAt, 2128 "'allocsize' indices can't refer to the same parameter"); 2129 HowManyArg = HowMany; 2130 } else 2131 HowManyArg = None; 2132 2133 auto EndParen = Lex.getLoc(); 2134 if (!EatIfPresent(lltok::rparen)) 2135 return Error(EndParen, "expected ')'"); 2136 return false; 2137 } 2138 2139 /// ParseScopeAndOrdering 2140 /// if isAtomic: ::= SyncScope? AtomicOrdering 2141 /// else: ::= 2142 /// 2143 /// This sets Scope and Ordering to the parsed values. 2144 bool LLParser::ParseScopeAndOrdering(bool isAtomic, SyncScope::ID &SSID, 2145 AtomicOrdering &Ordering) { 2146 if (!isAtomic) 2147 return false; 2148 2149 return ParseScope(SSID) || ParseOrdering(Ordering); 2150 } 2151 2152 /// ParseScope 2153 /// ::= syncscope("singlethread" | "<target scope>")? 2154 /// 2155 /// This sets synchronization scope ID to the ID of the parsed value. 2156 bool LLParser::ParseScope(SyncScope::ID &SSID) { 2157 SSID = SyncScope::System; 2158 if (EatIfPresent(lltok::kw_syncscope)) { 2159 auto StartParenAt = Lex.getLoc(); 2160 if (!EatIfPresent(lltok::lparen)) 2161 return Error(StartParenAt, "Expected '(' in syncscope"); 2162 2163 std::string SSN; 2164 auto SSNAt = Lex.getLoc(); 2165 if (ParseStringConstant(SSN)) 2166 return Error(SSNAt, "Expected synchronization scope name"); 2167 2168 auto EndParenAt = Lex.getLoc(); 2169 if (!EatIfPresent(lltok::rparen)) 2170 return Error(EndParenAt, "Expected ')' in syncscope"); 2171 2172 SSID = Context.getOrInsertSyncScopeID(SSN); 2173 } 2174 2175 return false; 2176 } 2177 2178 /// ParseOrdering 2179 /// ::= AtomicOrdering 2180 /// 2181 /// This sets Ordering to the parsed value. 2182 bool LLParser::ParseOrdering(AtomicOrdering &Ordering) { 2183 switch (Lex.getKind()) { 2184 default: return TokError("Expected ordering on atomic instruction"); 2185 case lltok::kw_unordered: Ordering = AtomicOrdering::Unordered; break; 2186 case lltok::kw_monotonic: Ordering = AtomicOrdering::Monotonic; break; 2187 // Not specified yet: 2188 // case lltok::kw_consume: Ordering = AtomicOrdering::Consume; break; 2189 case lltok::kw_acquire: Ordering = AtomicOrdering::Acquire; break; 2190 case lltok::kw_release: Ordering = AtomicOrdering::Release; break; 2191 case lltok::kw_acq_rel: Ordering = AtomicOrdering::AcquireRelease; break; 2192 case lltok::kw_seq_cst: 2193 Ordering = AtomicOrdering::SequentiallyConsistent; 2194 break; 2195 } 2196 Lex.Lex(); 2197 return false; 2198 } 2199 2200 /// ParseOptionalStackAlignment 2201 /// ::= /* empty */ 2202 /// ::= 'alignstack' '(' 4 ')' 2203 bool LLParser::ParseOptionalStackAlignment(unsigned &Alignment) { 2204 Alignment = 0; 2205 if (!EatIfPresent(lltok::kw_alignstack)) 2206 return false; 2207 LocTy ParenLoc = Lex.getLoc(); 2208 if (!EatIfPresent(lltok::lparen)) 2209 return Error(ParenLoc, "expected '('"); 2210 LocTy AlignLoc = Lex.getLoc(); 2211 if (ParseUInt32(Alignment)) return true; 2212 ParenLoc = Lex.getLoc(); 2213 if (!EatIfPresent(lltok::rparen)) 2214 return Error(ParenLoc, "expected ')'"); 2215 if (!isPowerOf2_32(Alignment)) 2216 return Error(AlignLoc, "stack alignment is not a power of two"); 2217 return false; 2218 } 2219 2220 /// ParseIndexList - This parses the index list for an insert/extractvalue 2221 /// instruction. This sets AteExtraComma in the case where we eat an extra 2222 /// comma at the end of the line and find that it is followed by metadata. 2223 /// Clients that don't allow metadata can call the version of this function that 2224 /// only takes one argument. 2225 /// 2226 /// ParseIndexList 2227 /// ::= (',' uint32)+ 2228 /// 2229 bool LLParser::ParseIndexList(SmallVectorImpl<unsigned> &Indices, 2230 bool &AteExtraComma) { 2231 AteExtraComma = false; 2232 2233 if (Lex.getKind() != lltok::comma) 2234 return TokError("expected ',' as start of index list"); 2235 2236 while (EatIfPresent(lltok::comma)) { 2237 if (Lex.getKind() == lltok::MetadataVar) { 2238 if (Indices.empty()) return TokError("expected index"); 2239 AteExtraComma = true; 2240 return false; 2241 } 2242 unsigned Idx = 0; 2243 if (ParseUInt32(Idx)) return true; 2244 Indices.push_back(Idx); 2245 } 2246 2247 return false; 2248 } 2249 2250 //===----------------------------------------------------------------------===// 2251 // Type Parsing. 2252 //===----------------------------------------------------------------------===// 2253 2254 /// ParseType - Parse a type. 2255 bool LLParser::ParseType(Type *&Result, const Twine &Msg, bool AllowVoid) { 2256 SMLoc TypeLoc = Lex.getLoc(); 2257 switch (Lex.getKind()) { 2258 default: 2259 return TokError(Msg); 2260 case lltok::Type: 2261 // Type ::= 'float' | 'void' (etc) 2262 Result = Lex.getTyVal(); 2263 Lex.Lex(); 2264 break; 2265 case lltok::lbrace: 2266 // Type ::= StructType 2267 if (ParseAnonStructType(Result, false)) 2268 return true; 2269 break; 2270 case lltok::lsquare: 2271 // Type ::= '[' ... ']' 2272 Lex.Lex(); // eat the lsquare. 2273 if (ParseArrayVectorType(Result, false)) 2274 return true; 2275 break; 2276 case lltok::less: // Either vector or packed struct. 2277 // Type ::= '<' ... '>' 2278 Lex.Lex(); 2279 if (Lex.getKind() == lltok::lbrace) { 2280 if (ParseAnonStructType(Result, true) || 2281 ParseToken(lltok::greater, "expected '>' at end of packed struct")) 2282 return true; 2283 } else if (ParseArrayVectorType(Result, true)) 2284 return true; 2285 break; 2286 case lltok::LocalVar: { 2287 // Type ::= %foo 2288 std::pair<Type*, LocTy> &Entry = NamedTypes[Lex.getStrVal()]; 2289 2290 // If the type hasn't been defined yet, create a forward definition and 2291 // remember where that forward def'n was seen (in case it never is defined). 2292 if (!Entry.first) { 2293 Entry.first = StructType::create(Context, Lex.getStrVal()); 2294 Entry.second = Lex.getLoc(); 2295 } 2296 Result = Entry.first; 2297 Lex.Lex(); 2298 break; 2299 } 2300 2301 case lltok::LocalVarID: { 2302 // Type ::= %4 2303 std::pair<Type*, LocTy> &Entry = NumberedTypes[Lex.getUIntVal()]; 2304 2305 // If the type hasn't been defined yet, create a forward definition and 2306 // remember where that forward def'n was seen (in case it never is defined). 2307 if (!Entry.first) { 2308 Entry.first = StructType::create(Context); 2309 Entry.second = Lex.getLoc(); 2310 } 2311 Result = Entry.first; 2312 Lex.Lex(); 2313 break; 2314 } 2315 } 2316 2317 // Parse the type suffixes. 2318 while (true) { 2319 switch (Lex.getKind()) { 2320 // End of type. 2321 default: 2322 if (!AllowVoid && Result->isVoidTy()) 2323 return Error(TypeLoc, "void type only allowed for function results"); 2324 return false; 2325 2326 // Type ::= Type '*' 2327 case lltok::star: 2328 if (Result->isLabelTy()) 2329 return TokError("basic block pointers are invalid"); 2330 if (Result->isVoidTy()) 2331 return TokError("pointers to void are invalid - use i8* instead"); 2332 if (!PointerType::isValidElementType(Result)) 2333 return TokError("pointer to this type is invalid"); 2334 Result = PointerType::getUnqual(Result); 2335 Lex.Lex(); 2336 break; 2337 2338 // Type ::= Type 'addrspace' '(' uint32 ')' '*' 2339 case lltok::kw_addrspace: { 2340 if (Result->isLabelTy()) 2341 return TokError("basic block pointers are invalid"); 2342 if (Result->isVoidTy()) 2343 return TokError("pointers to void are invalid; use i8* instead"); 2344 if (!PointerType::isValidElementType(Result)) 2345 return TokError("pointer to this type is invalid"); 2346 unsigned AddrSpace; 2347 if (ParseOptionalAddrSpace(AddrSpace) || 2348 ParseToken(lltok::star, "expected '*' in address space")) 2349 return true; 2350 2351 Result = PointerType::get(Result, AddrSpace); 2352 break; 2353 } 2354 2355 /// Types '(' ArgTypeListI ')' OptFuncAttrs 2356 case lltok::lparen: 2357 if (ParseFunctionType(Result)) 2358 return true; 2359 break; 2360 } 2361 } 2362 } 2363 2364 /// ParseParameterList 2365 /// ::= '(' ')' 2366 /// ::= '(' Arg (',' Arg)* ')' 2367 /// Arg 2368 /// ::= Type OptionalAttributes Value OptionalAttributes 2369 bool LLParser::ParseParameterList(SmallVectorImpl<ParamInfo> &ArgList, 2370 PerFunctionState &PFS, bool IsMustTailCall, 2371 bool InVarArgsFunc) { 2372 if (ParseToken(lltok::lparen, "expected '(' in call")) 2373 return true; 2374 2375 while (Lex.getKind() != lltok::rparen) { 2376 // If this isn't the first argument, we need a comma. 2377 if (!ArgList.empty() && 2378 ParseToken(lltok::comma, "expected ',' in argument list")) 2379 return true; 2380 2381 // Parse an ellipsis if this is a musttail call in a variadic function. 2382 if (Lex.getKind() == lltok::dotdotdot) { 2383 const char *Msg = "unexpected ellipsis in argument list for "; 2384 if (!IsMustTailCall) 2385 return TokError(Twine(Msg) + "non-musttail call"); 2386 if (!InVarArgsFunc) 2387 return TokError(Twine(Msg) + "musttail call in non-varargs function"); 2388 Lex.Lex(); // Lex the '...', it is purely for readability. 2389 return ParseToken(lltok::rparen, "expected ')' at end of argument list"); 2390 } 2391 2392 // Parse the argument. 2393 LocTy ArgLoc; 2394 Type *ArgTy = nullptr; 2395 AttrBuilder ArgAttrs; 2396 Value *V; 2397 if (ParseType(ArgTy, ArgLoc)) 2398 return true; 2399 2400 if (ArgTy->isMetadataTy()) { 2401 if (ParseMetadataAsValue(V, PFS)) 2402 return true; 2403 } else { 2404 // Otherwise, handle normal operands. 2405 if (ParseOptionalParamAttrs(ArgAttrs) || ParseValue(ArgTy, V, PFS)) 2406 return true; 2407 } 2408 ArgList.push_back(ParamInfo( 2409 ArgLoc, V, AttributeSet::get(V->getContext(), ArgAttrs))); 2410 } 2411 2412 if (IsMustTailCall && InVarArgsFunc) 2413 return TokError("expected '...' at end of argument list for musttail call " 2414 "in varargs function"); 2415 2416 Lex.Lex(); // Lex the ')'. 2417 return false; 2418 } 2419 2420 /// ParseOptionalOperandBundles 2421 /// ::= /*empty*/ 2422 /// ::= '[' OperandBundle [, OperandBundle ]* ']' 2423 /// 2424 /// OperandBundle 2425 /// ::= bundle-tag '(' ')' 2426 /// ::= bundle-tag '(' Type Value [, Type Value ]* ')' 2427 /// 2428 /// bundle-tag ::= String Constant 2429 bool LLParser::ParseOptionalOperandBundles( 2430 SmallVectorImpl<OperandBundleDef> &BundleList, PerFunctionState &PFS) { 2431 LocTy BeginLoc = Lex.getLoc(); 2432 if (!EatIfPresent(lltok::lsquare)) 2433 return false; 2434 2435 while (Lex.getKind() != lltok::rsquare) { 2436 // If this isn't the first operand bundle, we need a comma. 2437 if (!BundleList.empty() && 2438 ParseToken(lltok::comma, "expected ',' in input list")) 2439 return true; 2440 2441 std::string Tag; 2442 if (ParseStringConstant(Tag)) 2443 return true; 2444 2445 if (ParseToken(lltok::lparen, "expected '(' in operand bundle")) 2446 return true; 2447 2448 std::vector<Value *> Inputs; 2449 while (Lex.getKind() != lltok::rparen) { 2450 // If this isn't the first input, we need a comma. 2451 if (!Inputs.empty() && 2452 ParseToken(lltok::comma, "expected ',' in input list")) 2453 return true; 2454 2455 Type *Ty = nullptr; 2456 Value *Input = nullptr; 2457 if (ParseType(Ty) || ParseValue(Ty, Input, PFS)) 2458 return true; 2459 Inputs.push_back(Input); 2460 } 2461 2462 BundleList.emplace_back(std::move(Tag), std::move(Inputs)); 2463 2464 Lex.Lex(); // Lex the ')'. 2465 } 2466 2467 if (BundleList.empty()) 2468 return Error(BeginLoc, "operand bundle set must not be empty"); 2469 2470 Lex.Lex(); // Lex the ']'. 2471 return false; 2472 } 2473 2474 /// ParseArgumentList - Parse the argument list for a function type or function 2475 /// prototype. 2476 /// ::= '(' ArgTypeListI ')' 2477 /// ArgTypeListI 2478 /// ::= /*empty*/ 2479 /// ::= '...' 2480 /// ::= ArgTypeList ',' '...' 2481 /// ::= ArgType (',' ArgType)* 2482 /// 2483 bool LLParser::ParseArgumentList(SmallVectorImpl<ArgInfo> &ArgList, 2484 bool &isVarArg){ 2485 isVarArg = false; 2486 assert(Lex.getKind() == lltok::lparen); 2487 Lex.Lex(); // eat the (. 2488 2489 if (Lex.getKind() == lltok::rparen) { 2490 // empty 2491 } else if (Lex.getKind() == lltok::dotdotdot) { 2492 isVarArg = true; 2493 Lex.Lex(); 2494 } else { 2495 LocTy TypeLoc = Lex.getLoc(); 2496 Type *ArgTy = nullptr; 2497 AttrBuilder Attrs; 2498 std::string Name; 2499 2500 if (ParseType(ArgTy) || 2501 ParseOptionalParamAttrs(Attrs)) return true; 2502 2503 if (ArgTy->isVoidTy()) 2504 return Error(TypeLoc, "argument can not have void type"); 2505 2506 if (Lex.getKind() == lltok::LocalVar) { 2507 Name = Lex.getStrVal(); 2508 Lex.Lex(); 2509 } 2510 2511 if (!FunctionType::isValidArgumentType(ArgTy)) 2512 return Error(TypeLoc, "invalid type for function argument"); 2513 2514 ArgList.emplace_back(TypeLoc, ArgTy, 2515 AttributeSet::get(ArgTy->getContext(), Attrs), 2516 std::move(Name)); 2517 2518 while (EatIfPresent(lltok::comma)) { 2519 // Handle ... at end of arg list. 2520 if (EatIfPresent(lltok::dotdotdot)) { 2521 isVarArg = true; 2522 break; 2523 } 2524 2525 // Otherwise must be an argument type. 2526 TypeLoc = Lex.getLoc(); 2527 if (ParseType(ArgTy) || ParseOptionalParamAttrs(Attrs)) return true; 2528 2529 if (ArgTy->isVoidTy()) 2530 return Error(TypeLoc, "argument can not have void type"); 2531 2532 if (Lex.getKind() == lltok::LocalVar) { 2533 Name = Lex.getStrVal(); 2534 Lex.Lex(); 2535 } else { 2536 Name = ""; 2537 } 2538 2539 if (!ArgTy->isFirstClassType()) 2540 return Error(TypeLoc, "invalid type for function argument"); 2541 2542 ArgList.emplace_back(TypeLoc, ArgTy, 2543 AttributeSet::get(ArgTy->getContext(), Attrs), 2544 std::move(Name)); 2545 } 2546 } 2547 2548 return ParseToken(lltok::rparen, "expected ')' at end of argument list"); 2549 } 2550 2551 /// ParseFunctionType 2552 /// ::= Type ArgumentList OptionalAttrs 2553 bool LLParser::ParseFunctionType(Type *&Result) { 2554 assert(Lex.getKind() == lltok::lparen); 2555 2556 if (!FunctionType::isValidReturnType(Result)) 2557 return TokError("invalid function return type"); 2558 2559 SmallVector<ArgInfo, 8> ArgList; 2560 bool isVarArg; 2561 if (ParseArgumentList(ArgList, isVarArg)) 2562 return true; 2563 2564 // Reject names on the arguments lists. 2565 for (unsigned i = 0, e = ArgList.size(); i != e; ++i) { 2566 if (!ArgList[i].Name.empty()) 2567 return Error(ArgList[i].Loc, "argument name invalid in function type"); 2568 if (ArgList[i].Attrs.hasAttributes()) 2569 return Error(ArgList[i].Loc, 2570 "argument attributes invalid in function type"); 2571 } 2572 2573 SmallVector<Type*, 16> ArgListTy; 2574 for (unsigned i = 0, e = ArgList.size(); i != e; ++i) 2575 ArgListTy.push_back(ArgList[i].Ty); 2576 2577 Result = FunctionType::get(Result, ArgListTy, isVarArg); 2578 return false; 2579 } 2580 2581 /// ParseAnonStructType - Parse an anonymous struct type, which is inlined into 2582 /// other structs. 2583 bool LLParser::ParseAnonStructType(Type *&Result, bool Packed) { 2584 SmallVector<Type*, 8> Elts; 2585 if (ParseStructBody(Elts)) return true; 2586 2587 Result = StructType::get(Context, Elts, Packed); 2588 return false; 2589 } 2590 2591 /// ParseStructDefinition - Parse a struct in a 'type' definition. 2592 bool LLParser::ParseStructDefinition(SMLoc TypeLoc, StringRef Name, 2593 std::pair<Type*, LocTy> &Entry, 2594 Type *&ResultTy) { 2595 // If the type was already defined, diagnose the redefinition. 2596 if (Entry.first && !Entry.second.isValid()) 2597 return Error(TypeLoc, "redefinition of type"); 2598 2599 // If we have opaque, just return without filling in the definition for the 2600 // struct. This counts as a definition as far as the .ll file goes. 2601 if (EatIfPresent(lltok::kw_opaque)) { 2602 // This type is being defined, so clear the location to indicate this. 2603 Entry.second = SMLoc(); 2604 2605 // If this type number has never been uttered, create it. 2606 if (!Entry.first) 2607 Entry.first = StructType::create(Context, Name); 2608 ResultTy = Entry.first; 2609 return false; 2610 } 2611 2612 // If the type starts with '<', then it is either a packed struct or a vector. 2613 bool isPacked = EatIfPresent(lltok::less); 2614 2615 // If we don't have a struct, then we have a random type alias, which we 2616 // accept for compatibility with old files. These types are not allowed to be 2617 // forward referenced and not allowed to be recursive. 2618 if (Lex.getKind() != lltok::lbrace) { 2619 if (Entry.first) 2620 return Error(TypeLoc, "forward references to non-struct type"); 2621 2622 ResultTy = nullptr; 2623 if (isPacked) 2624 return ParseArrayVectorType(ResultTy, true); 2625 return ParseType(ResultTy); 2626 } 2627 2628 // This type is being defined, so clear the location to indicate this. 2629 Entry.second = SMLoc(); 2630 2631 // If this type number has never been uttered, create it. 2632 if (!Entry.first) 2633 Entry.first = StructType::create(Context, Name); 2634 2635 StructType *STy = cast<StructType>(Entry.first); 2636 2637 SmallVector<Type*, 8> Body; 2638 if (ParseStructBody(Body) || 2639 (isPacked && ParseToken(lltok::greater, "expected '>' in packed struct"))) 2640 return true; 2641 2642 STy->setBody(Body, isPacked); 2643 ResultTy = STy; 2644 return false; 2645 } 2646 2647 /// ParseStructType: Handles packed and unpacked types. </> parsed elsewhere. 2648 /// StructType 2649 /// ::= '{' '}' 2650 /// ::= '{' Type (',' Type)* '}' 2651 /// ::= '<' '{' '}' '>' 2652 /// ::= '<' '{' Type (',' Type)* '}' '>' 2653 bool LLParser::ParseStructBody(SmallVectorImpl<Type*> &Body) { 2654 assert(Lex.getKind() == lltok::lbrace); 2655 Lex.Lex(); // Consume the '{' 2656 2657 // Handle the empty struct. 2658 if (EatIfPresent(lltok::rbrace)) 2659 return false; 2660 2661 LocTy EltTyLoc = Lex.getLoc(); 2662 Type *Ty = nullptr; 2663 if (ParseType(Ty)) return true; 2664 Body.push_back(Ty); 2665 2666 if (!StructType::isValidElementType(Ty)) 2667 return Error(EltTyLoc, "invalid element type for struct"); 2668 2669 while (EatIfPresent(lltok::comma)) { 2670 EltTyLoc = Lex.getLoc(); 2671 if (ParseType(Ty)) return true; 2672 2673 if (!StructType::isValidElementType(Ty)) 2674 return Error(EltTyLoc, "invalid element type for struct"); 2675 2676 Body.push_back(Ty); 2677 } 2678 2679 return ParseToken(lltok::rbrace, "expected '}' at end of struct"); 2680 } 2681 2682 /// ParseArrayVectorType - Parse an array or vector type, assuming the first 2683 /// token has already been consumed. 2684 /// Type 2685 /// ::= '[' APSINTVAL 'x' Types ']' 2686 /// ::= '<' APSINTVAL 'x' Types '>' 2687 bool LLParser::ParseArrayVectorType(Type *&Result, bool isVector) { 2688 if (Lex.getKind() != lltok::APSInt || Lex.getAPSIntVal().isSigned() || 2689 Lex.getAPSIntVal().getBitWidth() > 64) 2690 return TokError("expected number in address space"); 2691 2692 LocTy SizeLoc = Lex.getLoc(); 2693 uint64_t Size = Lex.getAPSIntVal().getZExtValue(); 2694 Lex.Lex(); 2695 2696 if (ParseToken(lltok::kw_x, "expected 'x' after element count")) 2697 return true; 2698 2699 LocTy TypeLoc = Lex.getLoc(); 2700 Type *EltTy = nullptr; 2701 if (ParseType(EltTy)) return true; 2702 2703 if (ParseToken(isVector ? lltok::greater : lltok::rsquare, 2704 "expected end of sequential type")) 2705 return true; 2706 2707 if (isVector) { 2708 if (Size == 0) 2709 return Error(SizeLoc, "zero element vector is illegal"); 2710 if ((unsigned)Size != Size) 2711 return Error(SizeLoc, "size too large for vector"); 2712 if (!VectorType::isValidElementType(EltTy)) 2713 return Error(TypeLoc, "invalid vector element type"); 2714 Result = VectorType::get(EltTy, unsigned(Size)); 2715 } else { 2716 if (!ArrayType::isValidElementType(EltTy)) 2717 return Error(TypeLoc, "invalid array element type"); 2718 Result = ArrayType::get(EltTy, Size); 2719 } 2720 return false; 2721 } 2722 2723 //===----------------------------------------------------------------------===// 2724 // Function Semantic Analysis. 2725 //===----------------------------------------------------------------------===// 2726 2727 LLParser::PerFunctionState::PerFunctionState(LLParser &p, Function &f, 2728 int functionNumber) 2729 : P(p), F(f), FunctionNumber(functionNumber) { 2730 2731 // Insert unnamed arguments into the NumberedVals list. 2732 for (Argument &A : F.args()) 2733 if (!A.hasName()) 2734 NumberedVals.push_back(&A); 2735 } 2736 2737 LLParser::PerFunctionState::~PerFunctionState() { 2738 // If there were any forward referenced non-basicblock values, delete them. 2739 2740 for (const auto &P : ForwardRefVals) { 2741 if (isa<BasicBlock>(P.second.first)) 2742 continue; 2743 P.second.first->replaceAllUsesWith( 2744 UndefValue::get(P.second.first->getType())); 2745 P.second.first->deleteValue(); 2746 } 2747 2748 for (const auto &P : ForwardRefValIDs) { 2749 if (isa<BasicBlock>(P.second.first)) 2750 continue; 2751 P.second.first->replaceAllUsesWith( 2752 UndefValue::get(P.second.first->getType())); 2753 P.second.first->deleteValue(); 2754 } 2755 } 2756 2757 bool LLParser::PerFunctionState::FinishFunction() { 2758 if (!ForwardRefVals.empty()) 2759 return P.Error(ForwardRefVals.begin()->second.second, 2760 "use of undefined value '%" + ForwardRefVals.begin()->first + 2761 "'"); 2762 if (!ForwardRefValIDs.empty()) 2763 return P.Error(ForwardRefValIDs.begin()->second.second, 2764 "use of undefined value '%" + 2765 Twine(ForwardRefValIDs.begin()->first) + "'"); 2766 return false; 2767 } 2768 2769 /// GetVal - Get a value with the specified name or ID, creating a 2770 /// forward reference record if needed. This can return null if the value 2771 /// exists but does not have the right type. 2772 Value *LLParser::PerFunctionState::GetVal(const std::string &Name, Type *Ty, 2773 LocTy Loc, bool IsCall) { 2774 // Look this name up in the normal function symbol table. 2775 Value *Val = F.getValueSymbolTable()->lookup(Name); 2776 2777 // If this is a forward reference for the value, see if we already created a 2778 // forward ref record. 2779 if (!Val) { 2780 auto I = ForwardRefVals.find(Name); 2781 if (I != ForwardRefVals.end()) 2782 Val = I->second.first; 2783 } 2784 2785 // If we have the value in the symbol table or fwd-ref table, return it. 2786 if (Val) 2787 return P.checkValidVariableType(Loc, "%" + Name, Ty, Val, IsCall); 2788 2789 // Don't make placeholders with invalid type. 2790 if (!Ty->isFirstClassType()) { 2791 P.Error(Loc, "invalid use of a non-first-class type"); 2792 return nullptr; 2793 } 2794 2795 // Otherwise, create a new forward reference for this value and remember it. 2796 Value *FwdVal; 2797 if (Ty->isLabelTy()) { 2798 FwdVal = BasicBlock::Create(F.getContext(), Name, &F); 2799 } else { 2800 FwdVal = new Argument(Ty, Name); 2801 } 2802 2803 ForwardRefVals[Name] = std::make_pair(FwdVal, Loc); 2804 return FwdVal; 2805 } 2806 2807 Value *LLParser::PerFunctionState::GetVal(unsigned ID, Type *Ty, LocTy Loc, 2808 bool IsCall) { 2809 // Look this name up in the normal function symbol table. 2810 Value *Val = ID < NumberedVals.size() ? NumberedVals[ID] : nullptr; 2811 2812 // If this is a forward reference for the value, see if we already created a 2813 // forward ref record. 2814 if (!Val) { 2815 auto I = ForwardRefValIDs.find(ID); 2816 if (I != ForwardRefValIDs.end()) 2817 Val = I->second.first; 2818 } 2819 2820 // If we have the value in the symbol table or fwd-ref table, return it. 2821 if (Val) 2822 return P.checkValidVariableType(Loc, "%" + Twine(ID), Ty, Val, IsCall); 2823 2824 if (!Ty->isFirstClassType()) { 2825 P.Error(Loc, "invalid use of a non-first-class type"); 2826 return nullptr; 2827 } 2828 2829 // Otherwise, create a new forward reference for this value and remember it. 2830 Value *FwdVal; 2831 if (Ty->isLabelTy()) { 2832 FwdVal = BasicBlock::Create(F.getContext(), "", &F); 2833 } else { 2834 FwdVal = new Argument(Ty); 2835 } 2836 2837 ForwardRefValIDs[ID] = std::make_pair(FwdVal, Loc); 2838 return FwdVal; 2839 } 2840 2841 /// SetInstName - After an instruction is parsed and inserted into its 2842 /// basic block, this installs its name. 2843 bool LLParser::PerFunctionState::SetInstName(int NameID, 2844 const std::string &NameStr, 2845 LocTy NameLoc, Instruction *Inst) { 2846 // If this instruction has void type, it cannot have a name or ID specified. 2847 if (Inst->getType()->isVoidTy()) { 2848 if (NameID != -1 || !NameStr.empty()) 2849 return P.Error(NameLoc, "instructions returning void cannot have a name"); 2850 return false; 2851 } 2852 2853 // If this was a numbered instruction, verify that the instruction is the 2854 // expected value and resolve any forward references. 2855 if (NameStr.empty()) { 2856 // If neither a name nor an ID was specified, just use the next ID. 2857 if (NameID == -1) 2858 NameID = NumberedVals.size(); 2859 2860 if (unsigned(NameID) != NumberedVals.size()) 2861 return P.Error(NameLoc, "instruction expected to be numbered '%" + 2862 Twine(NumberedVals.size()) + "'"); 2863 2864 auto FI = ForwardRefValIDs.find(NameID); 2865 if (FI != ForwardRefValIDs.end()) { 2866 Value *Sentinel = FI->second.first; 2867 if (Sentinel->getType() != Inst->getType()) 2868 return P.Error(NameLoc, "instruction forward referenced with type '" + 2869 getTypeString(FI->second.first->getType()) + "'"); 2870 2871 Sentinel->replaceAllUsesWith(Inst); 2872 Sentinel->deleteValue(); 2873 ForwardRefValIDs.erase(FI); 2874 } 2875 2876 NumberedVals.push_back(Inst); 2877 return false; 2878 } 2879 2880 // Otherwise, the instruction had a name. Resolve forward refs and set it. 2881 auto FI = ForwardRefVals.find(NameStr); 2882 if (FI != ForwardRefVals.end()) { 2883 Value *Sentinel = FI->second.first; 2884 if (Sentinel->getType() != Inst->getType()) 2885 return P.Error(NameLoc, "instruction forward referenced with type '" + 2886 getTypeString(FI->second.first->getType()) + "'"); 2887 2888 Sentinel->replaceAllUsesWith(Inst); 2889 Sentinel->deleteValue(); 2890 ForwardRefVals.erase(FI); 2891 } 2892 2893 // Set the name on the instruction. 2894 Inst->setName(NameStr); 2895 2896 if (Inst->getName() != NameStr) 2897 return P.Error(NameLoc, "multiple definition of local value named '" + 2898 NameStr + "'"); 2899 return false; 2900 } 2901 2902 /// GetBB - Get a basic block with the specified name or ID, creating a 2903 /// forward reference record if needed. 2904 BasicBlock *LLParser::PerFunctionState::GetBB(const std::string &Name, 2905 LocTy Loc) { 2906 return dyn_cast_or_null<BasicBlock>( 2907 GetVal(Name, Type::getLabelTy(F.getContext()), Loc, /*IsCall=*/false)); 2908 } 2909 2910 BasicBlock *LLParser::PerFunctionState::GetBB(unsigned ID, LocTy Loc) { 2911 return dyn_cast_or_null<BasicBlock>( 2912 GetVal(ID, Type::getLabelTy(F.getContext()), Loc, /*IsCall=*/false)); 2913 } 2914 2915 /// DefineBB - Define the specified basic block, which is either named or 2916 /// unnamed. If there is an error, this returns null otherwise it returns 2917 /// the block being defined. 2918 BasicBlock *LLParser::PerFunctionState::DefineBB(const std::string &Name, 2919 LocTy Loc) { 2920 BasicBlock *BB; 2921 if (Name.empty()) 2922 BB = GetBB(NumberedVals.size(), Loc); 2923 else 2924 BB = GetBB(Name, Loc); 2925 if (!BB) return nullptr; // Already diagnosed error. 2926 2927 // Move the block to the end of the function. Forward ref'd blocks are 2928 // inserted wherever they happen to be referenced. 2929 F.getBasicBlockList().splice(F.end(), F.getBasicBlockList(), BB); 2930 2931 // Remove the block from forward ref sets. 2932 if (Name.empty()) { 2933 ForwardRefValIDs.erase(NumberedVals.size()); 2934 NumberedVals.push_back(BB); 2935 } else { 2936 // BB forward references are already in the function symbol table. 2937 ForwardRefVals.erase(Name); 2938 } 2939 2940 return BB; 2941 } 2942 2943 //===----------------------------------------------------------------------===// 2944 // Constants. 2945 //===----------------------------------------------------------------------===// 2946 2947 /// ParseValID - Parse an abstract value that doesn't necessarily have a 2948 /// type implied. For example, if we parse "4" we don't know what integer type 2949 /// it has. The value will later be combined with its type and checked for 2950 /// sanity. PFS is used to convert function-local operands of metadata (since 2951 /// metadata operands are not just parsed here but also converted to values). 2952 /// PFS can be null when we are not parsing metadata values inside a function. 2953 bool LLParser::ParseValID(ValID &ID, PerFunctionState *PFS) { 2954 ID.Loc = Lex.getLoc(); 2955 switch (Lex.getKind()) { 2956 default: return TokError("expected value token"); 2957 case lltok::GlobalID: // @42 2958 ID.UIntVal = Lex.getUIntVal(); 2959 ID.Kind = ValID::t_GlobalID; 2960 break; 2961 case lltok::GlobalVar: // @foo 2962 ID.StrVal = Lex.getStrVal(); 2963 ID.Kind = ValID::t_GlobalName; 2964 break; 2965 case lltok::LocalVarID: // %42 2966 ID.UIntVal = Lex.getUIntVal(); 2967 ID.Kind = ValID::t_LocalID; 2968 break; 2969 case lltok::LocalVar: // %foo 2970 ID.StrVal = Lex.getStrVal(); 2971 ID.Kind = ValID::t_LocalName; 2972 break; 2973 case lltok::APSInt: 2974 ID.APSIntVal = Lex.getAPSIntVal(); 2975 ID.Kind = ValID::t_APSInt; 2976 break; 2977 case lltok::APFloat: 2978 ID.APFloatVal = Lex.getAPFloatVal(); 2979 ID.Kind = ValID::t_APFloat; 2980 break; 2981 case lltok::kw_true: 2982 ID.ConstantVal = ConstantInt::getTrue(Context); 2983 ID.Kind = ValID::t_Constant; 2984 break; 2985 case lltok::kw_false: 2986 ID.ConstantVal = ConstantInt::getFalse(Context); 2987 ID.Kind = ValID::t_Constant; 2988 break; 2989 case lltok::kw_null: ID.Kind = ValID::t_Null; break; 2990 case lltok::kw_undef: ID.Kind = ValID::t_Undef; break; 2991 case lltok::kw_zeroinitializer: ID.Kind = ValID::t_Zero; break; 2992 case lltok::kw_none: ID.Kind = ValID::t_None; break; 2993 2994 case lltok::lbrace: { 2995 // ValID ::= '{' ConstVector '}' 2996 Lex.Lex(); 2997 SmallVector<Constant*, 16> Elts; 2998 if (ParseGlobalValueVector(Elts) || 2999 ParseToken(lltok::rbrace, "expected end of struct constant")) 3000 return true; 3001 3002 ID.ConstantStructElts = make_unique<Constant *[]>(Elts.size()); 3003 ID.UIntVal = Elts.size(); 3004 memcpy(ID.ConstantStructElts.get(), Elts.data(), 3005 Elts.size() * sizeof(Elts[0])); 3006 ID.Kind = ValID::t_ConstantStruct; 3007 return false; 3008 } 3009 case lltok::less: { 3010 // ValID ::= '<' ConstVector '>' --> Vector. 3011 // ValID ::= '<' '{' ConstVector '}' '>' --> Packed Struct. 3012 Lex.Lex(); 3013 bool isPackedStruct = EatIfPresent(lltok::lbrace); 3014 3015 SmallVector<Constant*, 16> Elts; 3016 LocTy FirstEltLoc = Lex.getLoc(); 3017 if (ParseGlobalValueVector(Elts) || 3018 (isPackedStruct && 3019 ParseToken(lltok::rbrace, "expected end of packed struct")) || 3020 ParseToken(lltok::greater, "expected end of constant")) 3021 return true; 3022 3023 if (isPackedStruct) { 3024 ID.ConstantStructElts = make_unique<Constant *[]>(Elts.size()); 3025 memcpy(ID.ConstantStructElts.get(), Elts.data(), 3026 Elts.size() * sizeof(Elts[0])); 3027 ID.UIntVal = Elts.size(); 3028 ID.Kind = ValID::t_PackedConstantStruct; 3029 return false; 3030 } 3031 3032 if (Elts.empty()) 3033 return Error(ID.Loc, "constant vector must not be empty"); 3034 3035 if (!Elts[0]->getType()->isIntegerTy() && 3036 !Elts[0]->getType()->isFloatingPointTy() && 3037 !Elts[0]->getType()->isPointerTy()) 3038 return Error(FirstEltLoc, 3039 "vector elements must have integer, pointer or floating point type"); 3040 3041 // Verify that all the vector elements have the same type. 3042 for (unsigned i = 1, e = Elts.size(); i != e; ++i) 3043 if (Elts[i]->getType() != Elts[0]->getType()) 3044 return Error(FirstEltLoc, 3045 "vector element #" + Twine(i) + 3046 " is not of type '" + getTypeString(Elts[0]->getType())); 3047 3048 ID.ConstantVal = ConstantVector::get(Elts); 3049 ID.Kind = ValID::t_Constant; 3050 return false; 3051 } 3052 case lltok::lsquare: { // Array Constant 3053 Lex.Lex(); 3054 SmallVector<Constant*, 16> Elts; 3055 LocTy FirstEltLoc = Lex.getLoc(); 3056 if (ParseGlobalValueVector(Elts) || 3057 ParseToken(lltok::rsquare, "expected end of array constant")) 3058 return true; 3059 3060 // Handle empty element. 3061 if (Elts.empty()) { 3062 // Use undef instead of an array because it's inconvenient to determine 3063 // the element type at this point, there being no elements to examine. 3064 ID.Kind = ValID::t_EmptyArray; 3065 return false; 3066 } 3067 3068 if (!Elts[0]->getType()->isFirstClassType()) 3069 return Error(FirstEltLoc, "invalid array element type: " + 3070 getTypeString(Elts[0]->getType())); 3071 3072 ArrayType *ATy = ArrayType::get(Elts[0]->getType(), Elts.size()); 3073 3074 // Verify all elements are correct type! 3075 for (unsigned i = 0, e = Elts.size(); i != e; ++i) { 3076 if (Elts[i]->getType() != Elts[0]->getType()) 3077 return Error(FirstEltLoc, 3078 "array element #" + Twine(i) + 3079 " is not of type '" + getTypeString(Elts[0]->getType())); 3080 } 3081 3082 ID.ConstantVal = ConstantArray::get(ATy, Elts); 3083 ID.Kind = ValID::t_Constant; 3084 return false; 3085 } 3086 case lltok::kw_c: // c "foo" 3087 Lex.Lex(); 3088 ID.ConstantVal = ConstantDataArray::getString(Context, Lex.getStrVal(), 3089 false); 3090 if (ParseToken(lltok::StringConstant, "expected string")) return true; 3091 ID.Kind = ValID::t_Constant; 3092 return false; 3093 3094 case lltok::kw_asm: { 3095 // ValID ::= 'asm' SideEffect? AlignStack? IntelDialect? STRINGCONSTANT ',' 3096 // STRINGCONSTANT 3097 bool HasSideEffect, AlignStack, AsmDialect; 3098 Lex.Lex(); 3099 if (ParseOptionalToken(lltok::kw_sideeffect, HasSideEffect) || 3100 ParseOptionalToken(lltok::kw_alignstack, AlignStack) || 3101 ParseOptionalToken(lltok::kw_inteldialect, AsmDialect) || 3102 ParseStringConstant(ID.StrVal) || 3103 ParseToken(lltok::comma, "expected comma in inline asm expression") || 3104 ParseToken(lltok::StringConstant, "expected constraint string")) 3105 return true; 3106 ID.StrVal2 = Lex.getStrVal(); 3107 ID.UIntVal = unsigned(HasSideEffect) | (unsigned(AlignStack)<<1) | 3108 (unsigned(AsmDialect)<<2); 3109 ID.Kind = ValID::t_InlineAsm; 3110 return false; 3111 } 3112 3113 case lltok::kw_blockaddress: { 3114 // ValID ::= 'blockaddress' '(' @foo ',' %bar ')' 3115 Lex.Lex(); 3116 3117 ValID Fn, Label; 3118 3119 if (ParseToken(lltok::lparen, "expected '(' in block address expression") || 3120 ParseValID(Fn) || 3121 ParseToken(lltok::comma, "expected comma in block address expression")|| 3122 ParseValID(Label) || 3123 ParseToken(lltok::rparen, "expected ')' in block address expression")) 3124 return true; 3125 3126 if (Fn.Kind != ValID::t_GlobalID && Fn.Kind != ValID::t_GlobalName) 3127 return Error(Fn.Loc, "expected function name in blockaddress"); 3128 if (Label.Kind != ValID::t_LocalID && Label.Kind != ValID::t_LocalName) 3129 return Error(Label.Loc, "expected basic block name in blockaddress"); 3130 3131 // Try to find the function (but skip it if it's forward-referenced). 3132 GlobalValue *GV = nullptr; 3133 if (Fn.Kind == ValID::t_GlobalID) { 3134 if (Fn.UIntVal < NumberedVals.size()) 3135 GV = NumberedVals[Fn.UIntVal]; 3136 } else if (!ForwardRefVals.count(Fn.StrVal)) { 3137 GV = M->getNamedValue(Fn.StrVal); 3138 } 3139 Function *F = nullptr; 3140 if (GV) { 3141 // Confirm that it's actually a function with a definition. 3142 if (!isa<Function>(GV)) 3143 return Error(Fn.Loc, "expected function name in blockaddress"); 3144 F = cast<Function>(GV); 3145 if (F->isDeclaration()) 3146 return Error(Fn.Loc, "cannot take blockaddress inside a declaration"); 3147 } 3148 3149 if (!F) { 3150 // Make a global variable as a placeholder for this reference. 3151 GlobalValue *&FwdRef = 3152 ForwardRefBlockAddresses.insert(std::make_pair( 3153 std::move(Fn), 3154 std::map<ValID, GlobalValue *>())) 3155 .first->second.insert(std::make_pair(std::move(Label), nullptr)) 3156 .first->second; 3157 if (!FwdRef) 3158 FwdRef = new GlobalVariable(*M, Type::getInt8Ty(Context), false, 3159 GlobalValue::InternalLinkage, nullptr, ""); 3160 ID.ConstantVal = FwdRef; 3161 ID.Kind = ValID::t_Constant; 3162 return false; 3163 } 3164 3165 // We found the function; now find the basic block. Don't use PFS, since we 3166 // might be inside a constant expression. 3167 BasicBlock *BB; 3168 if (BlockAddressPFS && F == &BlockAddressPFS->getFunction()) { 3169 if (Label.Kind == ValID::t_LocalID) 3170 BB = BlockAddressPFS->GetBB(Label.UIntVal, Label.Loc); 3171 else 3172 BB = BlockAddressPFS->GetBB(Label.StrVal, Label.Loc); 3173 if (!BB) 3174 return Error(Label.Loc, "referenced value is not a basic block"); 3175 } else { 3176 if (Label.Kind == ValID::t_LocalID) 3177 return Error(Label.Loc, "cannot take address of numeric label after " 3178 "the function is defined"); 3179 BB = dyn_cast_or_null<BasicBlock>( 3180 F->getValueSymbolTable()->lookup(Label.StrVal)); 3181 if (!BB) 3182 return Error(Label.Loc, "referenced value is not a basic block"); 3183 } 3184 3185 ID.ConstantVal = BlockAddress::get(F, BB); 3186 ID.Kind = ValID::t_Constant; 3187 return false; 3188 } 3189 3190 case lltok::kw_trunc: 3191 case lltok::kw_zext: 3192 case lltok::kw_sext: 3193 case lltok::kw_fptrunc: 3194 case lltok::kw_fpext: 3195 case lltok::kw_bitcast: 3196 case lltok::kw_addrspacecast: 3197 case lltok::kw_uitofp: 3198 case lltok::kw_sitofp: 3199 case lltok::kw_fptoui: 3200 case lltok::kw_fptosi: 3201 case lltok::kw_inttoptr: 3202 case lltok::kw_ptrtoint: { 3203 unsigned Opc = Lex.getUIntVal(); 3204 Type *DestTy = nullptr; 3205 Constant *SrcVal; 3206 Lex.Lex(); 3207 if (ParseToken(lltok::lparen, "expected '(' after constantexpr cast") || 3208 ParseGlobalTypeAndValue(SrcVal) || 3209 ParseToken(lltok::kw_to, "expected 'to' in constantexpr cast") || 3210 ParseType(DestTy) || 3211 ParseToken(lltok::rparen, "expected ')' at end of constantexpr cast")) 3212 return true; 3213 if (!CastInst::castIsValid((Instruction::CastOps)Opc, SrcVal, DestTy)) 3214 return Error(ID.Loc, "invalid cast opcode for cast from '" + 3215 getTypeString(SrcVal->getType()) + "' to '" + 3216 getTypeString(DestTy) + "'"); 3217 ID.ConstantVal = ConstantExpr::getCast((Instruction::CastOps)Opc, 3218 SrcVal, DestTy); 3219 ID.Kind = ValID::t_Constant; 3220 return false; 3221 } 3222 case lltok::kw_extractvalue: { 3223 Lex.Lex(); 3224 Constant *Val; 3225 SmallVector<unsigned, 4> Indices; 3226 if (ParseToken(lltok::lparen, "expected '(' in extractvalue constantexpr")|| 3227 ParseGlobalTypeAndValue(Val) || 3228 ParseIndexList(Indices) || 3229 ParseToken(lltok::rparen, "expected ')' in extractvalue constantexpr")) 3230 return true; 3231 3232 if (!Val->getType()->isAggregateType()) 3233 return Error(ID.Loc, "extractvalue operand must be aggregate type"); 3234 if (!ExtractValueInst::getIndexedType(Val->getType(), Indices)) 3235 return Error(ID.Loc, "invalid indices for extractvalue"); 3236 ID.ConstantVal = ConstantExpr::getExtractValue(Val, Indices); 3237 ID.Kind = ValID::t_Constant; 3238 return false; 3239 } 3240 case lltok::kw_insertvalue: { 3241 Lex.Lex(); 3242 Constant *Val0, *Val1; 3243 SmallVector<unsigned, 4> Indices; 3244 if (ParseToken(lltok::lparen, "expected '(' in insertvalue constantexpr")|| 3245 ParseGlobalTypeAndValue(Val0) || 3246 ParseToken(lltok::comma, "expected comma in insertvalue constantexpr")|| 3247 ParseGlobalTypeAndValue(Val1) || 3248 ParseIndexList(Indices) || 3249 ParseToken(lltok::rparen, "expected ')' in insertvalue constantexpr")) 3250 return true; 3251 if (!Val0->getType()->isAggregateType()) 3252 return Error(ID.Loc, "insertvalue operand must be aggregate type"); 3253 Type *IndexedType = 3254 ExtractValueInst::getIndexedType(Val0->getType(), Indices); 3255 if (!IndexedType) 3256 return Error(ID.Loc, "invalid indices for insertvalue"); 3257 if (IndexedType != Val1->getType()) 3258 return Error(ID.Loc, "insertvalue operand and field disagree in type: '" + 3259 getTypeString(Val1->getType()) + 3260 "' instead of '" + getTypeString(IndexedType) + 3261 "'"); 3262 ID.ConstantVal = ConstantExpr::getInsertValue(Val0, Val1, Indices); 3263 ID.Kind = ValID::t_Constant; 3264 return false; 3265 } 3266 case lltok::kw_icmp: 3267 case lltok::kw_fcmp: { 3268 unsigned PredVal, Opc = Lex.getUIntVal(); 3269 Constant *Val0, *Val1; 3270 Lex.Lex(); 3271 if (ParseCmpPredicate(PredVal, Opc) || 3272 ParseToken(lltok::lparen, "expected '(' in compare constantexpr") || 3273 ParseGlobalTypeAndValue(Val0) || 3274 ParseToken(lltok::comma, "expected comma in compare constantexpr") || 3275 ParseGlobalTypeAndValue(Val1) || 3276 ParseToken(lltok::rparen, "expected ')' in compare constantexpr")) 3277 return true; 3278 3279 if (Val0->getType() != Val1->getType()) 3280 return Error(ID.Loc, "compare operands must have the same type"); 3281 3282 CmpInst::Predicate Pred = (CmpInst::Predicate)PredVal; 3283 3284 if (Opc == Instruction::FCmp) { 3285 if (!Val0->getType()->isFPOrFPVectorTy()) 3286 return Error(ID.Loc, "fcmp requires floating point operands"); 3287 ID.ConstantVal = ConstantExpr::getFCmp(Pred, Val0, Val1); 3288 } else { 3289 assert(Opc == Instruction::ICmp && "Unexpected opcode for CmpInst!"); 3290 if (!Val0->getType()->isIntOrIntVectorTy() && 3291 !Val0->getType()->isPtrOrPtrVectorTy()) 3292 return Error(ID.Loc, "icmp requires pointer or integer operands"); 3293 ID.ConstantVal = ConstantExpr::getICmp(Pred, Val0, Val1); 3294 } 3295 ID.Kind = ValID::t_Constant; 3296 return false; 3297 } 3298 3299 // Binary Operators. 3300 case lltok::kw_add: 3301 case lltok::kw_fadd: 3302 case lltok::kw_sub: 3303 case lltok::kw_fsub: 3304 case lltok::kw_mul: 3305 case lltok::kw_fmul: 3306 case lltok::kw_udiv: 3307 case lltok::kw_sdiv: 3308 case lltok::kw_fdiv: 3309 case lltok::kw_urem: 3310 case lltok::kw_srem: 3311 case lltok::kw_frem: 3312 case lltok::kw_shl: 3313 case lltok::kw_lshr: 3314 case lltok::kw_ashr: { 3315 bool NUW = false; 3316 bool NSW = false; 3317 bool Exact = false; 3318 unsigned Opc = Lex.getUIntVal(); 3319 Constant *Val0, *Val1; 3320 Lex.Lex(); 3321 LocTy ModifierLoc = Lex.getLoc(); 3322 if (Opc == Instruction::Add || Opc == Instruction::Sub || 3323 Opc == Instruction::Mul || Opc == Instruction::Shl) { 3324 if (EatIfPresent(lltok::kw_nuw)) 3325 NUW = true; 3326 if (EatIfPresent(lltok::kw_nsw)) { 3327 NSW = true; 3328 if (EatIfPresent(lltok::kw_nuw)) 3329 NUW = true; 3330 } 3331 } else if (Opc == Instruction::SDiv || Opc == Instruction::UDiv || 3332 Opc == Instruction::LShr || Opc == Instruction::AShr) { 3333 if (EatIfPresent(lltok::kw_exact)) 3334 Exact = true; 3335 } 3336 if (ParseToken(lltok::lparen, "expected '(' in binary constantexpr") || 3337 ParseGlobalTypeAndValue(Val0) || 3338 ParseToken(lltok::comma, "expected comma in binary constantexpr") || 3339 ParseGlobalTypeAndValue(Val1) || 3340 ParseToken(lltok::rparen, "expected ')' in binary constantexpr")) 3341 return true; 3342 if (Val0->getType() != Val1->getType()) 3343 return Error(ID.Loc, "operands of constexpr must have same type"); 3344 if (!Val0->getType()->isIntOrIntVectorTy()) { 3345 if (NUW) 3346 return Error(ModifierLoc, "nuw only applies to integer operations"); 3347 if (NSW) 3348 return Error(ModifierLoc, "nsw only applies to integer operations"); 3349 } 3350 // Check that the type is valid for the operator. 3351 switch (Opc) { 3352 case Instruction::Add: 3353 case Instruction::Sub: 3354 case Instruction::Mul: 3355 case Instruction::UDiv: 3356 case Instruction::SDiv: 3357 case Instruction::URem: 3358 case Instruction::SRem: 3359 case Instruction::Shl: 3360 case Instruction::AShr: 3361 case Instruction::LShr: 3362 if (!Val0->getType()->isIntOrIntVectorTy()) 3363 return Error(ID.Loc, "constexpr requires integer operands"); 3364 break; 3365 case Instruction::FAdd: 3366 case Instruction::FSub: 3367 case Instruction::FMul: 3368 case Instruction::FDiv: 3369 case Instruction::FRem: 3370 if (!Val0->getType()->isFPOrFPVectorTy()) 3371 return Error(ID.Loc, "constexpr requires fp operands"); 3372 break; 3373 default: llvm_unreachable("Unknown binary operator!"); 3374 } 3375 unsigned Flags = 0; 3376 if (NUW) Flags |= OverflowingBinaryOperator::NoUnsignedWrap; 3377 if (NSW) Flags |= OverflowingBinaryOperator::NoSignedWrap; 3378 if (Exact) Flags |= PossiblyExactOperator::IsExact; 3379 Constant *C = ConstantExpr::get(Opc, Val0, Val1, Flags); 3380 ID.ConstantVal = C; 3381 ID.Kind = ValID::t_Constant; 3382 return false; 3383 } 3384 3385 // Logical Operations 3386 case lltok::kw_and: 3387 case lltok::kw_or: 3388 case lltok::kw_xor: { 3389 unsigned Opc = Lex.getUIntVal(); 3390 Constant *Val0, *Val1; 3391 Lex.Lex(); 3392 if (ParseToken(lltok::lparen, "expected '(' in logical constantexpr") || 3393 ParseGlobalTypeAndValue(Val0) || 3394 ParseToken(lltok::comma, "expected comma in logical constantexpr") || 3395 ParseGlobalTypeAndValue(Val1) || 3396 ParseToken(lltok::rparen, "expected ')' in logical constantexpr")) 3397 return true; 3398 if (Val0->getType() != Val1->getType()) 3399 return Error(ID.Loc, "operands of constexpr must have same type"); 3400 if (!Val0->getType()->isIntOrIntVectorTy()) 3401 return Error(ID.Loc, 3402 "constexpr requires integer or integer vector operands"); 3403 ID.ConstantVal = ConstantExpr::get(Opc, Val0, Val1); 3404 ID.Kind = ValID::t_Constant; 3405 return false; 3406 } 3407 3408 case lltok::kw_getelementptr: 3409 case lltok::kw_shufflevector: 3410 case lltok::kw_insertelement: 3411 case lltok::kw_extractelement: 3412 case lltok::kw_select: { 3413 unsigned Opc = Lex.getUIntVal(); 3414 SmallVector<Constant*, 16> Elts; 3415 bool InBounds = false; 3416 Type *Ty; 3417 Lex.Lex(); 3418 3419 if (Opc == Instruction::GetElementPtr) 3420 InBounds = EatIfPresent(lltok::kw_inbounds); 3421 3422 if (ParseToken(lltok::lparen, "expected '(' in constantexpr")) 3423 return true; 3424 3425 LocTy ExplicitTypeLoc = Lex.getLoc(); 3426 if (Opc == Instruction::GetElementPtr) { 3427 if (ParseType(Ty) || 3428 ParseToken(lltok::comma, "expected comma after getelementptr's type")) 3429 return true; 3430 } 3431 3432 Optional<unsigned> InRangeOp; 3433 if (ParseGlobalValueVector( 3434 Elts, Opc == Instruction::GetElementPtr ? &InRangeOp : nullptr) || 3435 ParseToken(lltok::rparen, "expected ')' in constantexpr")) 3436 return true; 3437 3438 if (Opc == Instruction::GetElementPtr) { 3439 if (Elts.size() == 0 || 3440 !Elts[0]->getType()->isPtrOrPtrVectorTy()) 3441 return Error(ID.Loc, "base of getelementptr must be a pointer"); 3442 3443 Type *BaseType = Elts[0]->getType(); 3444 auto *BasePointerType = cast<PointerType>(BaseType->getScalarType()); 3445 if (Ty != BasePointerType->getElementType()) 3446 return Error( 3447 ExplicitTypeLoc, 3448 "explicit pointee type doesn't match operand's pointee type"); 3449 3450 unsigned GEPWidth = 3451 BaseType->isVectorTy() ? BaseType->getVectorNumElements() : 0; 3452 3453 ArrayRef<Constant *> Indices(Elts.begin() + 1, Elts.end()); 3454 for (Constant *Val : Indices) { 3455 Type *ValTy = Val->getType(); 3456 if (!ValTy->isIntOrIntVectorTy()) 3457 return Error(ID.Loc, "getelementptr index must be an integer"); 3458 if (ValTy->isVectorTy()) { 3459 unsigned ValNumEl = ValTy->getVectorNumElements(); 3460 if (GEPWidth && (ValNumEl != GEPWidth)) 3461 return Error( 3462 ID.Loc, 3463 "getelementptr vector index has a wrong number of elements"); 3464 // GEPWidth may have been unknown because the base is a scalar, 3465 // but it is known now. 3466 GEPWidth = ValNumEl; 3467 } 3468 } 3469 3470 SmallPtrSet<Type*, 4> Visited; 3471 if (!Indices.empty() && !Ty->isSized(&Visited)) 3472 return Error(ID.Loc, "base element of getelementptr must be sized"); 3473 3474 if (!GetElementPtrInst::getIndexedType(Ty, Indices)) 3475 return Error(ID.Loc, "invalid getelementptr indices"); 3476 3477 if (InRangeOp) { 3478 if (*InRangeOp == 0) 3479 return Error(ID.Loc, 3480 "inrange keyword may not appear on pointer operand"); 3481 --*InRangeOp; 3482 } 3483 3484 ID.ConstantVal = ConstantExpr::getGetElementPtr(Ty, Elts[0], Indices, 3485 InBounds, InRangeOp); 3486 } else if (Opc == Instruction::Select) { 3487 if (Elts.size() != 3) 3488 return Error(ID.Loc, "expected three operands to select"); 3489 if (const char *Reason = SelectInst::areInvalidOperands(Elts[0], Elts[1], 3490 Elts[2])) 3491 return Error(ID.Loc, Reason); 3492 ID.ConstantVal = ConstantExpr::getSelect(Elts[0], Elts[1], Elts[2]); 3493 } else if (Opc == Instruction::ShuffleVector) { 3494 if (Elts.size() != 3) 3495 return Error(ID.Loc, "expected three operands to shufflevector"); 3496 if (!ShuffleVectorInst::isValidOperands(Elts[0], Elts[1], Elts[2])) 3497 return Error(ID.Loc, "invalid operands to shufflevector"); 3498 ID.ConstantVal = 3499 ConstantExpr::getShuffleVector(Elts[0], Elts[1],Elts[2]); 3500 } else if (Opc == Instruction::ExtractElement) { 3501 if (Elts.size() != 2) 3502 return Error(ID.Loc, "expected two operands to extractelement"); 3503 if (!ExtractElementInst::isValidOperands(Elts[0], Elts[1])) 3504 return Error(ID.Loc, "invalid extractelement operands"); 3505 ID.ConstantVal = ConstantExpr::getExtractElement(Elts[0], Elts[1]); 3506 } else { 3507 assert(Opc == Instruction::InsertElement && "Unknown opcode"); 3508 if (Elts.size() != 3) 3509 return Error(ID.Loc, "expected three operands to insertelement"); 3510 if (!InsertElementInst::isValidOperands(Elts[0], Elts[1], Elts[2])) 3511 return Error(ID.Loc, "invalid insertelement operands"); 3512 ID.ConstantVal = 3513 ConstantExpr::getInsertElement(Elts[0], Elts[1],Elts[2]); 3514 } 3515 3516 ID.Kind = ValID::t_Constant; 3517 return false; 3518 } 3519 } 3520 3521 Lex.Lex(); 3522 return false; 3523 } 3524 3525 /// ParseGlobalValue - Parse a global value with the specified type. 3526 bool LLParser::ParseGlobalValue(Type *Ty, Constant *&C) { 3527 C = nullptr; 3528 ValID ID; 3529 Value *V = nullptr; 3530 bool Parsed = ParseValID(ID) || 3531 ConvertValIDToValue(Ty, ID, V, nullptr, /*IsCall=*/false); 3532 if (V && !(C = dyn_cast<Constant>(V))) 3533 return Error(ID.Loc, "global values must be constants"); 3534 return Parsed; 3535 } 3536 3537 bool LLParser::ParseGlobalTypeAndValue(Constant *&V) { 3538 Type *Ty = nullptr; 3539 return ParseType(Ty) || 3540 ParseGlobalValue(Ty, V); 3541 } 3542 3543 bool LLParser::parseOptionalComdat(StringRef GlobalName, Comdat *&C) { 3544 C = nullptr; 3545 3546 LocTy KwLoc = Lex.getLoc(); 3547 if (!EatIfPresent(lltok::kw_comdat)) 3548 return false; 3549 3550 if (EatIfPresent(lltok::lparen)) { 3551 if (Lex.getKind() != lltok::ComdatVar) 3552 return TokError("expected comdat variable"); 3553 C = getComdat(Lex.getStrVal(), Lex.getLoc()); 3554 Lex.Lex(); 3555 if (ParseToken(lltok::rparen, "expected ')' after comdat var")) 3556 return true; 3557 } else { 3558 if (GlobalName.empty()) 3559 return TokError("comdat cannot be unnamed"); 3560 C = getComdat(GlobalName, KwLoc); 3561 } 3562 3563 return false; 3564 } 3565 3566 /// ParseGlobalValueVector 3567 /// ::= /*empty*/ 3568 /// ::= [inrange] TypeAndValue (',' [inrange] TypeAndValue)* 3569 bool LLParser::ParseGlobalValueVector(SmallVectorImpl<Constant *> &Elts, 3570 Optional<unsigned> *InRangeOp) { 3571 // Empty list. 3572 if (Lex.getKind() == lltok::rbrace || 3573 Lex.getKind() == lltok::rsquare || 3574 Lex.getKind() == lltok::greater || 3575 Lex.getKind() == lltok::rparen) 3576 return false; 3577 3578 do { 3579 if (InRangeOp && !*InRangeOp && EatIfPresent(lltok::kw_inrange)) 3580 *InRangeOp = Elts.size(); 3581 3582 Constant *C; 3583 if (ParseGlobalTypeAndValue(C)) return true; 3584 Elts.push_back(C); 3585 } while (EatIfPresent(lltok::comma)); 3586 3587 return false; 3588 } 3589 3590 bool LLParser::ParseMDTuple(MDNode *&MD, bool IsDistinct) { 3591 SmallVector<Metadata *, 16> Elts; 3592 if (ParseMDNodeVector(Elts)) 3593 return true; 3594 3595 MD = (IsDistinct ? MDTuple::getDistinct : MDTuple::get)(Context, Elts); 3596 return false; 3597 } 3598 3599 /// MDNode: 3600 /// ::= !{ ... } 3601 /// ::= !7 3602 /// ::= !DILocation(...) 3603 bool LLParser::ParseMDNode(MDNode *&N) { 3604 if (Lex.getKind() == lltok::MetadataVar) 3605 return ParseSpecializedMDNode(N); 3606 3607 return ParseToken(lltok::exclaim, "expected '!' here") || 3608 ParseMDNodeTail(N); 3609 } 3610 3611 bool LLParser::ParseMDNodeTail(MDNode *&N) { 3612 // !{ ... } 3613 if (Lex.getKind() == lltok::lbrace) 3614 return ParseMDTuple(N); 3615 3616 // !42 3617 return ParseMDNodeID(N); 3618 } 3619 3620 namespace { 3621 3622 /// Structure to represent an optional metadata field. 3623 template <class FieldTy> struct MDFieldImpl { 3624 typedef MDFieldImpl ImplTy; 3625 FieldTy Val; 3626 bool Seen; 3627 3628 void assign(FieldTy Val) { 3629 Seen = true; 3630 this->Val = std::move(Val); 3631 } 3632 3633 explicit MDFieldImpl(FieldTy Default) 3634 : Val(std::move(Default)), Seen(false) {} 3635 }; 3636 3637 /// Structure to represent an optional metadata field that 3638 /// can be of either type (A or B) and encapsulates the 3639 /// MD<typeofA>Field and MD<typeofB>Field structs, so not 3640 /// to reimplement the specifics for representing each Field. 3641 template <class FieldTypeA, class FieldTypeB> struct MDEitherFieldImpl { 3642 typedef MDEitherFieldImpl<FieldTypeA, FieldTypeB> ImplTy; 3643 FieldTypeA A; 3644 FieldTypeB B; 3645 bool Seen; 3646 3647 enum { 3648 IsInvalid = 0, 3649 IsTypeA = 1, 3650 IsTypeB = 2 3651 } WhatIs; 3652 3653 void assign(FieldTypeA A) { 3654 Seen = true; 3655 this->A = std::move(A); 3656 WhatIs = IsTypeA; 3657 } 3658 3659 void assign(FieldTypeB B) { 3660 Seen = true; 3661 this->B = std::move(B); 3662 WhatIs = IsTypeB; 3663 } 3664 3665 explicit MDEitherFieldImpl(FieldTypeA DefaultA, FieldTypeB DefaultB) 3666 : A(std::move(DefaultA)), B(std::move(DefaultB)), Seen(false), 3667 WhatIs(IsInvalid) {} 3668 }; 3669 3670 struct MDUnsignedField : public MDFieldImpl<uint64_t> { 3671 uint64_t Max; 3672 3673 MDUnsignedField(uint64_t Default = 0, uint64_t Max = UINT64_MAX) 3674 : ImplTy(Default), Max(Max) {} 3675 }; 3676 3677 struct LineField : public MDUnsignedField { 3678 LineField() : MDUnsignedField(0, UINT32_MAX) {} 3679 }; 3680 3681 struct ColumnField : public MDUnsignedField { 3682 ColumnField() : MDUnsignedField(0, UINT16_MAX) {} 3683 }; 3684 3685 struct DwarfTagField : public MDUnsignedField { 3686 DwarfTagField() : MDUnsignedField(0, dwarf::DW_TAG_hi_user) {} 3687 DwarfTagField(dwarf::Tag DefaultTag) 3688 : MDUnsignedField(DefaultTag, dwarf::DW_TAG_hi_user) {} 3689 }; 3690 3691 struct DwarfMacinfoTypeField : public MDUnsignedField { 3692 DwarfMacinfoTypeField() : MDUnsignedField(0, dwarf::DW_MACINFO_vendor_ext) {} 3693 DwarfMacinfoTypeField(dwarf::MacinfoRecordType DefaultType) 3694 : MDUnsignedField(DefaultType, dwarf::DW_MACINFO_vendor_ext) {} 3695 }; 3696 3697 struct DwarfAttEncodingField : public MDUnsignedField { 3698 DwarfAttEncodingField() : MDUnsignedField(0, dwarf::DW_ATE_hi_user) {} 3699 }; 3700 3701 struct DwarfVirtualityField : public MDUnsignedField { 3702 DwarfVirtualityField() : MDUnsignedField(0, dwarf::DW_VIRTUALITY_max) {} 3703 }; 3704 3705 struct DwarfLangField : public MDUnsignedField { 3706 DwarfLangField() : MDUnsignedField(0, dwarf::DW_LANG_hi_user) {} 3707 }; 3708 3709 struct DwarfCCField : public MDUnsignedField { 3710 DwarfCCField() : MDUnsignedField(0, dwarf::DW_CC_hi_user) {} 3711 }; 3712 3713 struct EmissionKindField : public MDUnsignedField { 3714 EmissionKindField() : MDUnsignedField(0, DICompileUnit::LastEmissionKind) {} 3715 }; 3716 3717 struct NameTableKindField : public MDUnsignedField { 3718 NameTableKindField() 3719 : MDUnsignedField( 3720 0, (unsigned) 3721 DICompileUnit::DebugNameTableKind::LastDebugNameTableKind) {} 3722 }; 3723 3724 struct DIFlagField : public MDFieldImpl<DINode::DIFlags> { 3725 DIFlagField() : MDFieldImpl(DINode::FlagZero) {} 3726 }; 3727 3728 struct MDSignedField : public MDFieldImpl<int64_t> { 3729 int64_t Min; 3730 int64_t Max; 3731 3732 MDSignedField(int64_t Default = 0) 3733 : ImplTy(Default), Min(INT64_MIN), Max(INT64_MAX) {} 3734 MDSignedField(int64_t Default, int64_t Min, int64_t Max) 3735 : ImplTy(Default), Min(Min), Max(Max) {} 3736 }; 3737 3738 struct MDBoolField : public MDFieldImpl<bool> { 3739 MDBoolField(bool Default = false) : ImplTy(Default) {} 3740 }; 3741 3742 struct MDField : public MDFieldImpl<Metadata *> { 3743 bool AllowNull; 3744 3745 MDField(bool AllowNull = true) : ImplTy(nullptr), AllowNull(AllowNull) {} 3746 }; 3747 3748 struct MDConstant : public MDFieldImpl<ConstantAsMetadata *> { 3749 MDConstant() : ImplTy(nullptr) {} 3750 }; 3751 3752 struct MDStringField : public MDFieldImpl<MDString *> { 3753 bool AllowEmpty; 3754 MDStringField(bool AllowEmpty = true) 3755 : ImplTy(nullptr), AllowEmpty(AllowEmpty) {} 3756 }; 3757 3758 struct MDFieldList : public MDFieldImpl<SmallVector<Metadata *, 4>> { 3759 MDFieldList() : ImplTy(SmallVector<Metadata *, 4>()) {} 3760 }; 3761 3762 struct ChecksumKindField : public MDFieldImpl<DIFile::ChecksumKind> { 3763 ChecksumKindField(DIFile::ChecksumKind CSKind) : ImplTy(CSKind) {} 3764 }; 3765 3766 struct MDSignedOrMDField : MDEitherFieldImpl<MDSignedField, MDField> { 3767 MDSignedOrMDField(int64_t Default = 0, bool AllowNull = true) 3768 : ImplTy(MDSignedField(Default), MDField(AllowNull)) {} 3769 3770 MDSignedOrMDField(int64_t Default, int64_t Min, int64_t Max, 3771 bool AllowNull = true) 3772 : ImplTy(MDSignedField(Default, Min, Max), MDField(AllowNull)) {} 3773 3774 bool isMDSignedField() const { return WhatIs == IsTypeA; } 3775 bool isMDField() const { return WhatIs == IsTypeB; } 3776 int64_t getMDSignedValue() const { 3777 assert(isMDSignedField() && "Wrong field type"); 3778 return A.Val; 3779 } 3780 Metadata *getMDFieldValue() const { 3781 assert(isMDField() && "Wrong field type"); 3782 return B.Val; 3783 } 3784 }; 3785 3786 struct MDSignedOrUnsignedField 3787 : MDEitherFieldImpl<MDSignedField, MDUnsignedField> { 3788 MDSignedOrUnsignedField() : ImplTy(MDSignedField(0), MDUnsignedField(0)) {} 3789 3790 bool isMDSignedField() const { return WhatIs == IsTypeA; } 3791 bool isMDUnsignedField() const { return WhatIs == IsTypeB; } 3792 int64_t getMDSignedValue() const { 3793 assert(isMDSignedField() && "Wrong field type"); 3794 return A.Val; 3795 } 3796 uint64_t getMDUnsignedValue() const { 3797 assert(isMDUnsignedField() && "Wrong field type"); 3798 return B.Val; 3799 } 3800 }; 3801 3802 } // end anonymous namespace 3803 3804 namespace llvm { 3805 3806 template <> 3807 bool LLParser::ParseMDField(LocTy Loc, StringRef Name, 3808 MDUnsignedField &Result) { 3809 if (Lex.getKind() != lltok::APSInt || Lex.getAPSIntVal().isSigned()) 3810 return TokError("expected unsigned integer"); 3811 3812 auto &U = Lex.getAPSIntVal(); 3813 if (U.ugt(Result.Max)) 3814 return TokError("value for '" + Name + "' too large, limit is " + 3815 Twine(Result.Max)); 3816 Result.assign(U.getZExtValue()); 3817 assert(Result.Val <= Result.Max && "Expected value in range"); 3818 Lex.Lex(); 3819 return false; 3820 } 3821 3822 template <> 3823 bool LLParser::ParseMDField(LocTy Loc, StringRef Name, LineField &Result) { 3824 return ParseMDField(Loc, Name, static_cast<MDUnsignedField &>(Result)); 3825 } 3826 template <> 3827 bool LLParser::ParseMDField(LocTy Loc, StringRef Name, ColumnField &Result) { 3828 return ParseMDField(Loc, Name, static_cast<MDUnsignedField &>(Result)); 3829 } 3830 3831 template <> 3832 bool LLParser::ParseMDField(LocTy Loc, StringRef Name, DwarfTagField &Result) { 3833 if (Lex.getKind() == lltok::APSInt) 3834 return ParseMDField(Loc, Name, static_cast<MDUnsignedField &>(Result)); 3835 3836 if (Lex.getKind() != lltok::DwarfTag) 3837 return TokError("expected DWARF tag"); 3838 3839 unsigned Tag = dwarf::getTag(Lex.getStrVal()); 3840 if (Tag == dwarf::DW_TAG_invalid) 3841 return TokError("invalid DWARF tag" + Twine(" '") + Lex.getStrVal() + "'"); 3842 assert(Tag <= Result.Max && "Expected valid DWARF tag"); 3843 3844 Result.assign(Tag); 3845 Lex.Lex(); 3846 return false; 3847 } 3848 3849 template <> 3850 bool LLParser::ParseMDField(LocTy Loc, StringRef Name, 3851 DwarfMacinfoTypeField &Result) { 3852 if (Lex.getKind() == lltok::APSInt) 3853 return ParseMDField(Loc, Name, static_cast<MDUnsignedField &>(Result)); 3854 3855 if (Lex.getKind() != lltok::DwarfMacinfo) 3856 return TokError("expected DWARF macinfo type"); 3857 3858 unsigned Macinfo = dwarf::getMacinfo(Lex.getStrVal()); 3859 if (Macinfo == dwarf::DW_MACINFO_invalid) 3860 return TokError( 3861 "invalid DWARF macinfo type" + Twine(" '") + Lex.getStrVal() + "'"); 3862 assert(Macinfo <= Result.Max && "Expected valid DWARF macinfo type"); 3863 3864 Result.assign(Macinfo); 3865 Lex.Lex(); 3866 return false; 3867 } 3868 3869 template <> 3870 bool LLParser::ParseMDField(LocTy Loc, StringRef Name, 3871 DwarfVirtualityField &Result) { 3872 if (Lex.getKind() == lltok::APSInt) 3873 return ParseMDField(Loc, Name, static_cast<MDUnsignedField &>(Result)); 3874 3875 if (Lex.getKind() != lltok::DwarfVirtuality) 3876 return TokError("expected DWARF virtuality code"); 3877 3878 unsigned Virtuality = dwarf::getVirtuality(Lex.getStrVal()); 3879 if (Virtuality == dwarf::DW_VIRTUALITY_invalid) 3880 return TokError("invalid DWARF virtuality code" + Twine(" '") + 3881 Lex.getStrVal() + "'"); 3882 assert(Virtuality <= Result.Max && "Expected valid DWARF virtuality code"); 3883 Result.assign(Virtuality); 3884 Lex.Lex(); 3885 return false; 3886 } 3887 3888 template <> 3889 bool LLParser::ParseMDField(LocTy Loc, StringRef Name, DwarfLangField &Result) { 3890 if (Lex.getKind() == lltok::APSInt) 3891 return ParseMDField(Loc, Name, static_cast<MDUnsignedField &>(Result)); 3892 3893 if (Lex.getKind() != lltok::DwarfLang) 3894 return TokError("expected DWARF language"); 3895 3896 unsigned Lang = dwarf::getLanguage(Lex.getStrVal()); 3897 if (!Lang) 3898 return TokError("invalid DWARF language" + Twine(" '") + Lex.getStrVal() + 3899 "'"); 3900 assert(Lang <= Result.Max && "Expected valid DWARF language"); 3901 Result.assign(Lang); 3902 Lex.Lex(); 3903 return false; 3904 } 3905 3906 template <> 3907 bool LLParser::ParseMDField(LocTy Loc, StringRef Name, DwarfCCField &Result) { 3908 if (Lex.getKind() == lltok::APSInt) 3909 return ParseMDField(Loc, Name, static_cast<MDUnsignedField &>(Result)); 3910 3911 if (Lex.getKind() != lltok::DwarfCC) 3912 return TokError("expected DWARF calling convention"); 3913 3914 unsigned CC = dwarf::getCallingConvention(Lex.getStrVal()); 3915 if (!CC) 3916 return TokError("invalid DWARF calling convention" + Twine(" '") + Lex.getStrVal() + 3917 "'"); 3918 assert(CC <= Result.Max && "Expected valid DWARF calling convention"); 3919 Result.assign(CC); 3920 Lex.Lex(); 3921 return false; 3922 } 3923 3924 template <> 3925 bool LLParser::ParseMDField(LocTy Loc, StringRef Name, EmissionKindField &Result) { 3926 if (Lex.getKind() == lltok::APSInt) 3927 return ParseMDField(Loc, Name, static_cast<MDUnsignedField &>(Result)); 3928 3929 if (Lex.getKind() != lltok::EmissionKind) 3930 return TokError("expected emission kind"); 3931 3932 auto Kind = DICompileUnit::getEmissionKind(Lex.getStrVal()); 3933 if (!Kind) 3934 return TokError("invalid emission kind" + Twine(" '") + Lex.getStrVal() + 3935 "'"); 3936 assert(*Kind <= Result.Max && "Expected valid emission kind"); 3937 Result.assign(*Kind); 3938 Lex.Lex(); 3939 return false; 3940 } 3941 3942 template <> 3943 bool LLParser::ParseMDField(LocTy Loc, StringRef Name, 3944 NameTableKindField &Result) { 3945 if (Lex.getKind() == lltok::APSInt) 3946 return ParseMDField(Loc, Name, static_cast<MDUnsignedField &>(Result)); 3947 3948 if (Lex.getKind() != lltok::NameTableKind) 3949 return TokError("expected nameTable kind"); 3950 3951 auto Kind = DICompileUnit::getNameTableKind(Lex.getStrVal()); 3952 if (!Kind) 3953 return TokError("invalid nameTable kind" + Twine(" '") + Lex.getStrVal() + 3954 "'"); 3955 assert(((unsigned)*Kind) <= Result.Max && "Expected valid nameTable kind"); 3956 Result.assign((unsigned)*Kind); 3957 Lex.Lex(); 3958 return false; 3959 } 3960 3961 template <> 3962 bool LLParser::ParseMDField(LocTy Loc, StringRef Name, 3963 DwarfAttEncodingField &Result) { 3964 if (Lex.getKind() == lltok::APSInt) 3965 return ParseMDField(Loc, Name, static_cast<MDUnsignedField &>(Result)); 3966 3967 if (Lex.getKind() != lltok::DwarfAttEncoding) 3968 return TokError("expected DWARF type attribute encoding"); 3969 3970 unsigned Encoding = dwarf::getAttributeEncoding(Lex.getStrVal()); 3971 if (!Encoding) 3972 return TokError("invalid DWARF type attribute encoding" + Twine(" '") + 3973 Lex.getStrVal() + "'"); 3974 assert(Encoding <= Result.Max && "Expected valid DWARF language"); 3975 Result.assign(Encoding); 3976 Lex.Lex(); 3977 return false; 3978 } 3979 3980 /// DIFlagField 3981 /// ::= uint32 3982 /// ::= DIFlagVector 3983 /// ::= DIFlagVector '|' DIFlagFwdDecl '|' uint32 '|' DIFlagPublic 3984 template <> 3985 bool LLParser::ParseMDField(LocTy Loc, StringRef Name, DIFlagField &Result) { 3986 3987 // Parser for a single flag. 3988 auto parseFlag = [&](DINode::DIFlags &Val) { 3989 if (Lex.getKind() == lltok::APSInt && !Lex.getAPSIntVal().isSigned()) { 3990 uint32_t TempVal = static_cast<uint32_t>(Val); 3991 bool Res = ParseUInt32(TempVal); 3992 Val = static_cast<DINode::DIFlags>(TempVal); 3993 return Res; 3994 } 3995 3996 if (Lex.getKind() != lltok::DIFlag) 3997 return TokError("expected debug info flag"); 3998 3999 Val = DINode::getFlag(Lex.getStrVal()); 4000 if (!Val) 4001 return TokError(Twine("invalid debug info flag flag '") + 4002 Lex.getStrVal() + "'"); 4003 Lex.Lex(); 4004 return false; 4005 }; 4006 4007 // Parse the flags and combine them together. 4008 DINode::DIFlags Combined = DINode::FlagZero; 4009 do { 4010 DINode::DIFlags Val; 4011 if (parseFlag(Val)) 4012 return true; 4013 Combined |= Val; 4014 } while (EatIfPresent(lltok::bar)); 4015 4016 Result.assign(Combined); 4017 return false; 4018 } 4019 4020 template <> 4021 bool LLParser::ParseMDField(LocTy Loc, StringRef Name, 4022 MDSignedField &Result) { 4023 if (Lex.getKind() != lltok::APSInt) 4024 return TokError("expected signed integer"); 4025 4026 auto &S = Lex.getAPSIntVal(); 4027 if (S < Result.Min) 4028 return TokError("value for '" + Name + "' too small, limit is " + 4029 Twine(Result.Min)); 4030 if (S > Result.Max) 4031 return TokError("value for '" + Name + "' too large, limit is " + 4032 Twine(Result.Max)); 4033 Result.assign(S.getExtValue()); 4034 assert(Result.Val >= Result.Min && "Expected value in range"); 4035 assert(Result.Val <= Result.Max && "Expected value in range"); 4036 Lex.Lex(); 4037 return false; 4038 } 4039 4040 template <> 4041 bool LLParser::ParseMDField(LocTy Loc, StringRef Name, MDBoolField &Result) { 4042 switch (Lex.getKind()) { 4043 default: 4044 return TokError("expected 'true' or 'false'"); 4045 case lltok::kw_true: 4046 Result.assign(true); 4047 break; 4048 case lltok::kw_false: 4049 Result.assign(false); 4050 break; 4051 } 4052 Lex.Lex(); 4053 return false; 4054 } 4055 4056 template <> 4057 bool LLParser::ParseMDField(LocTy Loc, StringRef Name, MDField &Result) { 4058 if (Lex.getKind() == lltok::kw_null) { 4059 if (!Result.AllowNull) 4060 return TokError("'" + Name + "' cannot be null"); 4061 Lex.Lex(); 4062 Result.assign(nullptr); 4063 return false; 4064 } 4065 4066 Metadata *MD; 4067 if (ParseMetadata(MD, nullptr)) 4068 return true; 4069 4070 Result.assign(MD); 4071 return false; 4072 } 4073 4074 template <> 4075 bool LLParser::ParseMDField(LocTy Loc, StringRef Name, 4076 MDSignedOrMDField &Result) { 4077 // Try to parse a signed int. 4078 if (Lex.getKind() == lltok::APSInt) { 4079 MDSignedField Res = Result.A; 4080 if (!ParseMDField(Loc, Name, Res)) { 4081 Result.assign(Res); 4082 return false; 4083 } 4084 return true; 4085 } 4086 4087 // Otherwise, try to parse as an MDField. 4088 MDField Res = Result.B; 4089 if (!ParseMDField(Loc, Name, Res)) { 4090 Result.assign(Res); 4091 return false; 4092 } 4093 4094 return true; 4095 } 4096 4097 template <> 4098 bool LLParser::ParseMDField(LocTy Loc, StringRef Name, 4099 MDSignedOrUnsignedField &Result) { 4100 if (Lex.getKind() != lltok::APSInt) 4101 return false; 4102 4103 if (Lex.getAPSIntVal().isSigned()) { 4104 MDSignedField Res = Result.A; 4105 if (ParseMDField(Loc, Name, Res)) 4106 return true; 4107 Result.assign(Res); 4108 return false; 4109 } 4110 4111 MDUnsignedField Res = Result.B; 4112 if (ParseMDField(Loc, Name, Res)) 4113 return true; 4114 Result.assign(Res); 4115 return false; 4116 } 4117 4118 template <> 4119 bool LLParser::ParseMDField(LocTy Loc, StringRef Name, MDStringField &Result) { 4120 LocTy ValueLoc = Lex.getLoc(); 4121 std::string S; 4122 if (ParseStringConstant(S)) 4123 return true; 4124 4125 if (!Result.AllowEmpty && S.empty()) 4126 return Error(ValueLoc, "'" + Name + "' cannot be empty"); 4127 4128 Result.assign(S.empty() ? nullptr : MDString::get(Context, S)); 4129 return false; 4130 } 4131 4132 template <> 4133 bool LLParser::ParseMDField(LocTy Loc, StringRef Name, MDFieldList &Result) { 4134 SmallVector<Metadata *, 4> MDs; 4135 if (ParseMDNodeVector(MDs)) 4136 return true; 4137 4138 Result.assign(std::move(MDs)); 4139 return false; 4140 } 4141 4142 template <> 4143 bool LLParser::ParseMDField(LocTy Loc, StringRef Name, 4144 ChecksumKindField &Result) { 4145 Optional<DIFile::ChecksumKind> CSKind = 4146 DIFile::getChecksumKind(Lex.getStrVal()); 4147 4148 if (Lex.getKind() != lltok::ChecksumKind || !CSKind) 4149 return TokError( 4150 "invalid checksum kind" + Twine(" '") + Lex.getStrVal() + "'"); 4151 4152 Result.assign(*CSKind); 4153 Lex.Lex(); 4154 return false; 4155 } 4156 4157 } // end namespace llvm 4158 4159 template <class ParserTy> 4160 bool LLParser::ParseMDFieldsImplBody(ParserTy parseField) { 4161 do { 4162 if (Lex.getKind() != lltok::LabelStr) 4163 return TokError("expected field label here"); 4164 4165 if (parseField()) 4166 return true; 4167 } while (EatIfPresent(lltok::comma)); 4168 4169 return false; 4170 } 4171 4172 template <class ParserTy> 4173 bool LLParser::ParseMDFieldsImpl(ParserTy parseField, LocTy &ClosingLoc) { 4174 assert(Lex.getKind() == lltok::MetadataVar && "Expected metadata type name"); 4175 Lex.Lex(); 4176 4177 if (ParseToken(lltok::lparen, "expected '(' here")) 4178 return true; 4179 if (Lex.getKind() != lltok::rparen) 4180 if (ParseMDFieldsImplBody(parseField)) 4181 return true; 4182 4183 ClosingLoc = Lex.getLoc(); 4184 return ParseToken(lltok::rparen, "expected ')' here"); 4185 } 4186 4187 template <class FieldTy> 4188 bool LLParser::ParseMDField(StringRef Name, FieldTy &Result) { 4189 if (Result.Seen) 4190 return TokError("field '" + Name + "' cannot be specified more than once"); 4191 4192 LocTy Loc = Lex.getLoc(); 4193 Lex.Lex(); 4194 return ParseMDField(Loc, Name, Result); 4195 } 4196 4197 bool LLParser::ParseSpecializedMDNode(MDNode *&N, bool IsDistinct) { 4198 assert(Lex.getKind() == lltok::MetadataVar && "Expected metadata type name"); 4199 4200 #define HANDLE_SPECIALIZED_MDNODE_LEAF(CLASS) \ 4201 if (Lex.getStrVal() == #CLASS) \ 4202 return Parse##CLASS(N, IsDistinct); 4203 #include "llvm/IR/Metadata.def" 4204 4205 return TokError("expected metadata type"); 4206 } 4207 4208 #define DECLARE_FIELD(NAME, TYPE, INIT) TYPE NAME INIT 4209 #define NOP_FIELD(NAME, TYPE, INIT) 4210 #define REQUIRE_FIELD(NAME, TYPE, INIT) \ 4211 if (!NAME.Seen) \ 4212 return Error(ClosingLoc, "missing required field '" #NAME "'"); 4213 #define PARSE_MD_FIELD(NAME, TYPE, DEFAULT) \ 4214 if (Lex.getStrVal() == #NAME) \ 4215 return ParseMDField(#NAME, NAME); 4216 #define PARSE_MD_FIELDS() \ 4217 VISIT_MD_FIELDS(DECLARE_FIELD, DECLARE_FIELD) \ 4218 do { \ 4219 LocTy ClosingLoc; \ 4220 if (ParseMDFieldsImpl([&]() -> bool { \ 4221 VISIT_MD_FIELDS(PARSE_MD_FIELD, PARSE_MD_FIELD) \ 4222 return TokError(Twine("invalid field '") + Lex.getStrVal() + "'"); \ 4223 }, ClosingLoc)) \ 4224 return true; \ 4225 VISIT_MD_FIELDS(NOP_FIELD, REQUIRE_FIELD) \ 4226 } while (false) 4227 #define GET_OR_DISTINCT(CLASS, ARGS) \ 4228 (IsDistinct ? CLASS::getDistinct ARGS : CLASS::get ARGS) 4229 4230 /// ParseDILocationFields: 4231 /// ::= !DILocation(line: 43, column: 8, scope: !5, inlinedAt: !6, 4232 /// isImplicitCode: true) 4233 bool LLParser::ParseDILocation(MDNode *&Result, bool IsDistinct) { 4234 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED) \ 4235 OPTIONAL(line, LineField, ); \ 4236 OPTIONAL(column, ColumnField, ); \ 4237 REQUIRED(scope, MDField, (/* AllowNull */ false)); \ 4238 OPTIONAL(inlinedAt, MDField, ); \ 4239 OPTIONAL(isImplicitCode, MDBoolField, (false)); 4240 PARSE_MD_FIELDS(); 4241 #undef VISIT_MD_FIELDS 4242 4243 Result = 4244 GET_OR_DISTINCT(DILocation, (Context, line.Val, column.Val, scope.Val, 4245 inlinedAt.Val, isImplicitCode.Val)); 4246 return false; 4247 } 4248 4249 /// ParseGenericDINode: 4250 /// ::= !GenericDINode(tag: 15, header: "...", operands: {...}) 4251 bool LLParser::ParseGenericDINode(MDNode *&Result, bool IsDistinct) { 4252 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED) \ 4253 REQUIRED(tag, DwarfTagField, ); \ 4254 OPTIONAL(header, MDStringField, ); \ 4255 OPTIONAL(operands, MDFieldList, ); 4256 PARSE_MD_FIELDS(); 4257 #undef VISIT_MD_FIELDS 4258 4259 Result = GET_OR_DISTINCT(GenericDINode, 4260 (Context, tag.Val, header.Val, operands.Val)); 4261 return false; 4262 } 4263 4264 /// ParseDISubrange: 4265 /// ::= !DISubrange(count: 30, lowerBound: 2) 4266 /// ::= !DISubrange(count: !node, lowerBound: 2) 4267 bool LLParser::ParseDISubrange(MDNode *&Result, bool IsDistinct) { 4268 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED) \ 4269 REQUIRED(count, MDSignedOrMDField, (-1, -1, INT64_MAX, false)); \ 4270 OPTIONAL(lowerBound, MDSignedField, ); 4271 PARSE_MD_FIELDS(); 4272 #undef VISIT_MD_FIELDS 4273 4274 if (count.isMDSignedField()) 4275 Result = GET_OR_DISTINCT( 4276 DISubrange, (Context, count.getMDSignedValue(), lowerBound.Val)); 4277 else if (count.isMDField()) 4278 Result = GET_OR_DISTINCT( 4279 DISubrange, (Context, count.getMDFieldValue(), lowerBound.Val)); 4280 else 4281 return true; 4282 4283 return false; 4284 } 4285 4286 /// ParseDIEnumerator: 4287 /// ::= !DIEnumerator(value: 30, isUnsigned: true, name: "SomeKind") 4288 bool LLParser::ParseDIEnumerator(MDNode *&Result, bool IsDistinct) { 4289 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED) \ 4290 REQUIRED(name, MDStringField, ); \ 4291 REQUIRED(value, MDSignedOrUnsignedField, ); \ 4292 OPTIONAL(isUnsigned, MDBoolField, (false)); 4293 PARSE_MD_FIELDS(); 4294 #undef VISIT_MD_FIELDS 4295 4296 if (isUnsigned.Val && value.isMDSignedField()) 4297 return TokError("unsigned enumerator with negative value"); 4298 4299 int64_t Value = value.isMDSignedField() 4300 ? value.getMDSignedValue() 4301 : static_cast<int64_t>(value.getMDUnsignedValue()); 4302 Result = 4303 GET_OR_DISTINCT(DIEnumerator, (Context, Value, isUnsigned.Val, name.Val)); 4304 4305 return false; 4306 } 4307 4308 /// ParseDIBasicType: 4309 /// ::= !DIBasicType(tag: DW_TAG_base_type, name: "int", size: 32, align: 32, 4310 /// encoding: DW_ATE_encoding, flags: 0) 4311 bool LLParser::ParseDIBasicType(MDNode *&Result, bool IsDistinct) { 4312 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED) \ 4313 OPTIONAL(tag, DwarfTagField, (dwarf::DW_TAG_base_type)); \ 4314 OPTIONAL(name, MDStringField, ); \ 4315 OPTIONAL(size, MDUnsignedField, (0, UINT64_MAX)); \ 4316 OPTIONAL(align, MDUnsignedField, (0, UINT32_MAX)); \ 4317 OPTIONAL(encoding, DwarfAttEncodingField, ); \ 4318 OPTIONAL(flags, DIFlagField, ); 4319 PARSE_MD_FIELDS(); 4320 #undef VISIT_MD_FIELDS 4321 4322 Result = GET_OR_DISTINCT(DIBasicType, (Context, tag.Val, name.Val, size.Val, 4323 align.Val, encoding.Val, flags.Val)); 4324 return false; 4325 } 4326 4327 /// ParseDIDerivedType: 4328 /// ::= !DIDerivedType(tag: DW_TAG_pointer_type, name: "int", file: !0, 4329 /// line: 7, scope: !1, baseType: !2, size: 32, 4330 /// align: 32, offset: 0, flags: 0, extraData: !3, 4331 /// dwarfAddressSpace: 3) 4332 bool LLParser::ParseDIDerivedType(MDNode *&Result, bool IsDistinct) { 4333 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED) \ 4334 REQUIRED(tag, DwarfTagField, ); \ 4335 OPTIONAL(name, MDStringField, ); \ 4336 OPTIONAL(file, MDField, ); \ 4337 OPTIONAL(line, LineField, ); \ 4338 OPTIONAL(scope, MDField, ); \ 4339 REQUIRED(baseType, MDField, ); \ 4340 OPTIONAL(size, MDUnsignedField, (0, UINT64_MAX)); \ 4341 OPTIONAL(align, MDUnsignedField, (0, UINT32_MAX)); \ 4342 OPTIONAL(offset, MDUnsignedField, (0, UINT64_MAX)); \ 4343 OPTIONAL(flags, DIFlagField, ); \ 4344 OPTIONAL(extraData, MDField, ); \ 4345 OPTIONAL(dwarfAddressSpace, MDUnsignedField, (UINT32_MAX, UINT32_MAX)); 4346 PARSE_MD_FIELDS(); 4347 #undef VISIT_MD_FIELDS 4348 4349 Optional<unsigned> DWARFAddressSpace; 4350 if (dwarfAddressSpace.Val != UINT32_MAX) 4351 DWARFAddressSpace = dwarfAddressSpace.Val; 4352 4353 Result = GET_OR_DISTINCT(DIDerivedType, 4354 (Context, tag.Val, name.Val, file.Val, line.Val, 4355 scope.Val, baseType.Val, size.Val, align.Val, 4356 offset.Val, DWARFAddressSpace, flags.Val, 4357 extraData.Val)); 4358 return false; 4359 } 4360 4361 bool LLParser::ParseDICompositeType(MDNode *&Result, bool IsDistinct) { 4362 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED) \ 4363 REQUIRED(tag, DwarfTagField, ); \ 4364 OPTIONAL(name, MDStringField, ); \ 4365 OPTIONAL(file, MDField, ); \ 4366 OPTIONAL(line, LineField, ); \ 4367 OPTIONAL(scope, MDField, ); \ 4368 OPTIONAL(baseType, MDField, ); \ 4369 OPTIONAL(size, MDUnsignedField, (0, UINT64_MAX)); \ 4370 OPTIONAL(align, MDUnsignedField, (0, UINT32_MAX)); \ 4371 OPTIONAL(offset, MDUnsignedField, (0, UINT64_MAX)); \ 4372 OPTIONAL(flags, DIFlagField, ); \ 4373 OPTIONAL(elements, MDField, ); \ 4374 OPTIONAL(runtimeLang, DwarfLangField, ); \ 4375 OPTIONAL(vtableHolder, MDField, ); \ 4376 OPTIONAL(templateParams, MDField, ); \ 4377 OPTIONAL(identifier, MDStringField, ); \ 4378 OPTIONAL(discriminator, MDField, ); 4379 PARSE_MD_FIELDS(); 4380 #undef VISIT_MD_FIELDS 4381 4382 // If this has an identifier try to build an ODR type. 4383 if (identifier.Val) 4384 if (auto *CT = DICompositeType::buildODRType( 4385 Context, *identifier.Val, tag.Val, name.Val, file.Val, line.Val, 4386 scope.Val, baseType.Val, size.Val, align.Val, offset.Val, flags.Val, 4387 elements.Val, runtimeLang.Val, vtableHolder.Val, 4388 templateParams.Val, discriminator.Val)) { 4389 Result = CT; 4390 return false; 4391 } 4392 4393 // Create a new node, and save it in the context if it belongs in the type 4394 // map. 4395 Result = GET_OR_DISTINCT( 4396 DICompositeType, 4397 (Context, tag.Val, name.Val, file.Val, line.Val, scope.Val, baseType.Val, 4398 size.Val, align.Val, offset.Val, flags.Val, elements.Val, 4399 runtimeLang.Val, vtableHolder.Val, templateParams.Val, identifier.Val, 4400 discriminator.Val)); 4401 return false; 4402 } 4403 4404 bool LLParser::ParseDISubroutineType(MDNode *&Result, bool IsDistinct) { 4405 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED) \ 4406 OPTIONAL(flags, DIFlagField, ); \ 4407 OPTIONAL(cc, DwarfCCField, ); \ 4408 REQUIRED(types, MDField, ); 4409 PARSE_MD_FIELDS(); 4410 #undef VISIT_MD_FIELDS 4411 4412 Result = GET_OR_DISTINCT(DISubroutineType, 4413 (Context, flags.Val, cc.Val, types.Val)); 4414 return false; 4415 } 4416 4417 /// ParseDIFileType: 4418 /// ::= !DIFileType(filename: "path/to/file", directory: "/path/to/dir", 4419 /// checksumkind: CSK_MD5, 4420 /// checksum: "000102030405060708090a0b0c0d0e0f", 4421 /// source: "source file contents") 4422 bool LLParser::ParseDIFile(MDNode *&Result, bool IsDistinct) { 4423 // The default constructed value for checksumkind is required, but will never 4424 // be used, as the parser checks if the field was actually Seen before using 4425 // the Val. 4426 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED) \ 4427 REQUIRED(filename, MDStringField, ); \ 4428 REQUIRED(directory, MDStringField, ); \ 4429 OPTIONAL(checksumkind, ChecksumKindField, (DIFile::CSK_MD5)); \ 4430 OPTIONAL(checksum, MDStringField, ); \ 4431 OPTIONAL(source, MDStringField, ); 4432 PARSE_MD_FIELDS(); 4433 #undef VISIT_MD_FIELDS 4434 4435 Optional<DIFile::ChecksumInfo<MDString *>> OptChecksum; 4436 if (checksumkind.Seen && checksum.Seen) 4437 OptChecksum.emplace(checksumkind.Val, checksum.Val); 4438 else if (checksumkind.Seen || checksum.Seen) 4439 return Lex.Error("'checksumkind' and 'checksum' must be provided together"); 4440 4441 Optional<MDString *> OptSource; 4442 if (source.Seen) 4443 OptSource = source.Val; 4444 Result = GET_OR_DISTINCT(DIFile, (Context, filename.Val, directory.Val, 4445 OptChecksum, OptSource)); 4446 return false; 4447 } 4448 4449 /// ParseDICompileUnit: 4450 /// ::= !DICompileUnit(language: DW_LANG_C99, file: !0, producer: "clang", 4451 /// isOptimized: true, flags: "-O2", runtimeVersion: 1, 4452 /// splitDebugFilename: "abc.debug", 4453 /// emissionKind: FullDebug, enums: !1, retainedTypes: !2, 4454 /// globals: !4, imports: !5, macros: !6, dwoId: 0x0abcd) 4455 bool LLParser::ParseDICompileUnit(MDNode *&Result, bool IsDistinct) { 4456 if (!IsDistinct) 4457 return Lex.Error("missing 'distinct', required for !DICompileUnit"); 4458 4459 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED) \ 4460 REQUIRED(language, DwarfLangField, ); \ 4461 REQUIRED(file, MDField, (/* AllowNull */ false)); \ 4462 OPTIONAL(producer, MDStringField, ); \ 4463 OPTIONAL(isOptimized, MDBoolField, ); \ 4464 OPTIONAL(flags, MDStringField, ); \ 4465 OPTIONAL(runtimeVersion, MDUnsignedField, (0, UINT32_MAX)); \ 4466 OPTIONAL(splitDebugFilename, MDStringField, ); \ 4467 OPTIONAL(emissionKind, EmissionKindField, ); \ 4468 OPTIONAL(enums, MDField, ); \ 4469 OPTIONAL(retainedTypes, MDField, ); \ 4470 OPTIONAL(globals, MDField, ); \ 4471 OPTIONAL(imports, MDField, ); \ 4472 OPTIONAL(macros, MDField, ); \ 4473 OPTIONAL(dwoId, MDUnsignedField, ); \ 4474 OPTIONAL(splitDebugInlining, MDBoolField, = true); \ 4475 OPTIONAL(debugInfoForProfiling, MDBoolField, = false); \ 4476 OPTIONAL(nameTableKind, NameTableKindField, ); 4477 PARSE_MD_FIELDS(); 4478 #undef VISIT_MD_FIELDS 4479 4480 Result = DICompileUnit::getDistinct( 4481 Context, language.Val, file.Val, producer.Val, isOptimized.Val, flags.Val, 4482 runtimeVersion.Val, splitDebugFilename.Val, emissionKind.Val, enums.Val, 4483 retainedTypes.Val, globals.Val, imports.Val, macros.Val, dwoId.Val, 4484 splitDebugInlining.Val, debugInfoForProfiling.Val, nameTableKind.Val); 4485 return false; 4486 } 4487 4488 /// ParseDISubprogram: 4489 /// ::= !DISubprogram(scope: !0, name: "foo", linkageName: "_Zfoo", 4490 /// file: !1, line: 7, type: !2, isLocal: false, 4491 /// isDefinition: true, scopeLine: 8, containingType: !3, 4492 /// virtuality: DW_VIRTUALTIY_pure_virtual, 4493 /// virtualIndex: 10, thisAdjustment: 4, flags: 11, 4494 /// isOptimized: false, templateParams: !4, declaration: !5, 4495 /// retainedNodes: !6, thrownTypes: !7) 4496 bool LLParser::ParseDISubprogram(MDNode *&Result, bool IsDistinct) { 4497 auto Loc = Lex.getLoc(); 4498 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED) \ 4499 OPTIONAL(scope, MDField, ); \ 4500 OPTIONAL(name, MDStringField, ); \ 4501 OPTIONAL(linkageName, MDStringField, ); \ 4502 OPTIONAL(file, MDField, ); \ 4503 OPTIONAL(line, LineField, ); \ 4504 OPTIONAL(type, MDField, ); \ 4505 OPTIONAL(isLocal, MDBoolField, ); \ 4506 OPTIONAL(isDefinition, MDBoolField, (true)); \ 4507 OPTIONAL(scopeLine, LineField, ); \ 4508 OPTIONAL(containingType, MDField, ); \ 4509 OPTIONAL(virtuality, DwarfVirtualityField, ); \ 4510 OPTIONAL(virtualIndex, MDUnsignedField, (0, UINT32_MAX)); \ 4511 OPTIONAL(thisAdjustment, MDSignedField, (0, INT32_MIN, INT32_MAX)); \ 4512 OPTIONAL(flags, DIFlagField, ); \ 4513 OPTIONAL(isOptimized, MDBoolField, ); \ 4514 OPTIONAL(unit, MDField, ); \ 4515 OPTIONAL(templateParams, MDField, ); \ 4516 OPTIONAL(declaration, MDField, ); \ 4517 OPTIONAL(retainedNodes, MDField, ); \ 4518 OPTIONAL(thrownTypes, MDField, ); 4519 PARSE_MD_FIELDS(); 4520 #undef VISIT_MD_FIELDS 4521 4522 if (isDefinition.Val && !IsDistinct) 4523 return Lex.Error( 4524 Loc, 4525 "missing 'distinct', required for !DISubprogram when 'isDefinition'"); 4526 4527 Result = GET_OR_DISTINCT( 4528 DISubprogram, 4529 (Context, scope.Val, name.Val, linkageName.Val, file.Val, line.Val, 4530 type.Val, isLocal.Val, isDefinition.Val, scopeLine.Val, 4531 containingType.Val, virtuality.Val, virtualIndex.Val, thisAdjustment.Val, 4532 flags.Val, isOptimized.Val, unit.Val, templateParams.Val, 4533 declaration.Val, retainedNodes.Val, thrownTypes.Val)); 4534 return false; 4535 } 4536 4537 /// ParseDILexicalBlock: 4538 /// ::= !DILexicalBlock(scope: !0, file: !2, line: 7, column: 9) 4539 bool LLParser::ParseDILexicalBlock(MDNode *&Result, bool IsDistinct) { 4540 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED) \ 4541 REQUIRED(scope, MDField, (/* AllowNull */ false)); \ 4542 OPTIONAL(file, MDField, ); \ 4543 OPTIONAL(line, LineField, ); \ 4544 OPTIONAL(column, ColumnField, ); 4545 PARSE_MD_FIELDS(); 4546 #undef VISIT_MD_FIELDS 4547 4548 Result = GET_OR_DISTINCT( 4549 DILexicalBlock, (Context, scope.Val, file.Val, line.Val, column.Val)); 4550 return false; 4551 } 4552 4553 /// ParseDILexicalBlockFile: 4554 /// ::= !DILexicalBlockFile(scope: !0, file: !2, discriminator: 9) 4555 bool LLParser::ParseDILexicalBlockFile(MDNode *&Result, bool IsDistinct) { 4556 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED) \ 4557 REQUIRED(scope, MDField, (/* AllowNull */ false)); \ 4558 OPTIONAL(file, MDField, ); \ 4559 REQUIRED(discriminator, MDUnsignedField, (0, UINT32_MAX)); 4560 PARSE_MD_FIELDS(); 4561 #undef VISIT_MD_FIELDS 4562 4563 Result = GET_OR_DISTINCT(DILexicalBlockFile, 4564 (Context, scope.Val, file.Val, discriminator.Val)); 4565 return false; 4566 } 4567 4568 /// ParseDINamespace: 4569 /// ::= !DINamespace(scope: !0, file: !2, name: "SomeNamespace", line: 9) 4570 bool LLParser::ParseDINamespace(MDNode *&Result, bool IsDistinct) { 4571 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED) \ 4572 REQUIRED(scope, MDField, ); \ 4573 OPTIONAL(name, MDStringField, ); \ 4574 OPTIONAL(exportSymbols, MDBoolField, ); 4575 PARSE_MD_FIELDS(); 4576 #undef VISIT_MD_FIELDS 4577 4578 Result = GET_OR_DISTINCT(DINamespace, 4579 (Context, scope.Val, name.Val, exportSymbols.Val)); 4580 return false; 4581 } 4582 4583 /// ParseDIMacro: 4584 /// ::= !DIMacro(macinfo: type, line: 9, name: "SomeMacro", value: "SomeValue") 4585 bool LLParser::ParseDIMacro(MDNode *&Result, bool IsDistinct) { 4586 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED) \ 4587 REQUIRED(type, DwarfMacinfoTypeField, ); \ 4588 OPTIONAL(line, LineField, ); \ 4589 REQUIRED(name, MDStringField, ); \ 4590 OPTIONAL(value, MDStringField, ); 4591 PARSE_MD_FIELDS(); 4592 #undef VISIT_MD_FIELDS 4593 4594 Result = GET_OR_DISTINCT(DIMacro, 4595 (Context, type.Val, line.Val, name.Val, value.Val)); 4596 return false; 4597 } 4598 4599 /// ParseDIMacroFile: 4600 /// ::= !DIMacroFile(line: 9, file: !2, nodes: !3) 4601 bool LLParser::ParseDIMacroFile(MDNode *&Result, bool IsDistinct) { 4602 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED) \ 4603 OPTIONAL(type, DwarfMacinfoTypeField, (dwarf::DW_MACINFO_start_file)); \ 4604 OPTIONAL(line, LineField, ); \ 4605 REQUIRED(file, MDField, ); \ 4606 OPTIONAL(nodes, MDField, ); 4607 PARSE_MD_FIELDS(); 4608 #undef VISIT_MD_FIELDS 4609 4610 Result = GET_OR_DISTINCT(DIMacroFile, 4611 (Context, type.Val, line.Val, file.Val, nodes.Val)); 4612 return false; 4613 } 4614 4615 /// ParseDIModule: 4616 /// ::= !DIModule(scope: !0, name: "SomeModule", configMacros: "-DNDEBUG", 4617 /// includePath: "/usr/include", isysroot: "/") 4618 bool LLParser::ParseDIModule(MDNode *&Result, bool IsDistinct) { 4619 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED) \ 4620 REQUIRED(scope, MDField, ); \ 4621 REQUIRED(name, MDStringField, ); \ 4622 OPTIONAL(configMacros, MDStringField, ); \ 4623 OPTIONAL(includePath, MDStringField, ); \ 4624 OPTIONAL(isysroot, MDStringField, ); 4625 PARSE_MD_FIELDS(); 4626 #undef VISIT_MD_FIELDS 4627 4628 Result = GET_OR_DISTINCT(DIModule, (Context, scope.Val, name.Val, 4629 configMacros.Val, includePath.Val, isysroot.Val)); 4630 return false; 4631 } 4632 4633 /// ParseDITemplateTypeParameter: 4634 /// ::= !DITemplateTypeParameter(name: "Ty", type: !1) 4635 bool LLParser::ParseDITemplateTypeParameter(MDNode *&Result, bool IsDistinct) { 4636 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED) \ 4637 OPTIONAL(name, MDStringField, ); \ 4638 REQUIRED(type, MDField, ); 4639 PARSE_MD_FIELDS(); 4640 #undef VISIT_MD_FIELDS 4641 4642 Result = 4643 GET_OR_DISTINCT(DITemplateTypeParameter, (Context, name.Val, type.Val)); 4644 return false; 4645 } 4646 4647 /// ParseDITemplateValueParameter: 4648 /// ::= !DITemplateValueParameter(tag: DW_TAG_template_value_parameter, 4649 /// name: "V", type: !1, value: i32 7) 4650 bool LLParser::ParseDITemplateValueParameter(MDNode *&Result, bool IsDistinct) { 4651 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED) \ 4652 OPTIONAL(tag, DwarfTagField, (dwarf::DW_TAG_template_value_parameter)); \ 4653 OPTIONAL(name, MDStringField, ); \ 4654 OPTIONAL(type, MDField, ); \ 4655 REQUIRED(value, MDField, ); 4656 PARSE_MD_FIELDS(); 4657 #undef VISIT_MD_FIELDS 4658 4659 Result = GET_OR_DISTINCT(DITemplateValueParameter, 4660 (Context, tag.Val, name.Val, type.Val, value.Val)); 4661 return false; 4662 } 4663 4664 /// ParseDIGlobalVariable: 4665 /// ::= !DIGlobalVariable(scope: !0, name: "foo", linkageName: "foo", 4666 /// file: !1, line: 7, type: !2, isLocal: false, 4667 /// isDefinition: true, declaration: !3, align: 8) 4668 bool LLParser::ParseDIGlobalVariable(MDNode *&Result, bool IsDistinct) { 4669 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED) \ 4670 REQUIRED(name, MDStringField, (/* AllowEmpty */ false)); \ 4671 OPTIONAL(scope, MDField, ); \ 4672 OPTIONAL(linkageName, MDStringField, ); \ 4673 OPTIONAL(file, MDField, ); \ 4674 OPTIONAL(line, LineField, ); \ 4675 OPTIONAL(type, MDField, ); \ 4676 OPTIONAL(isLocal, MDBoolField, ); \ 4677 OPTIONAL(isDefinition, MDBoolField, (true)); \ 4678 OPTIONAL(declaration, MDField, ); \ 4679 OPTIONAL(align, MDUnsignedField, (0, UINT32_MAX)); 4680 PARSE_MD_FIELDS(); 4681 #undef VISIT_MD_FIELDS 4682 4683 Result = GET_OR_DISTINCT(DIGlobalVariable, 4684 (Context, scope.Val, name.Val, linkageName.Val, 4685 file.Val, line.Val, type.Val, isLocal.Val, 4686 isDefinition.Val, declaration.Val, align.Val)); 4687 return false; 4688 } 4689 4690 /// ParseDILocalVariable: 4691 /// ::= !DILocalVariable(arg: 7, scope: !0, name: "foo", 4692 /// file: !1, line: 7, type: !2, arg: 2, flags: 7, 4693 /// align: 8) 4694 /// ::= !DILocalVariable(scope: !0, name: "foo", 4695 /// file: !1, line: 7, type: !2, arg: 2, flags: 7, 4696 /// align: 8) 4697 bool LLParser::ParseDILocalVariable(MDNode *&Result, bool IsDistinct) { 4698 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED) \ 4699 REQUIRED(scope, MDField, (/* AllowNull */ false)); \ 4700 OPTIONAL(name, MDStringField, ); \ 4701 OPTIONAL(arg, MDUnsignedField, (0, UINT16_MAX)); \ 4702 OPTIONAL(file, MDField, ); \ 4703 OPTIONAL(line, LineField, ); \ 4704 OPTIONAL(type, MDField, ); \ 4705 OPTIONAL(flags, DIFlagField, ); \ 4706 OPTIONAL(align, MDUnsignedField, (0, UINT32_MAX)); 4707 PARSE_MD_FIELDS(); 4708 #undef VISIT_MD_FIELDS 4709 4710 Result = GET_OR_DISTINCT(DILocalVariable, 4711 (Context, scope.Val, name.Val, file.Val, line.Val, 4712 type.Val, arg.Val, flags.Val, align.Val)); 4713 return false; 4714 } 4715 4716 /// ParseDILabel: 4717 /// ::= !DILabel(scope: !0, name: "foo", file: !1, line: 7) 4718 bool LLParser::ParseDILabel(MDNode *&Result, bool IsDistinct) { 4719 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED) \ 4720 REQUIRED(scope, MDField, (/* AllowNull */ false)); \ 4721 REQUIRED(name, MDStringField, ); \ 4722 REQUIRED(file, MDField, ); \ 4723 REQUIRED(line, LineField, ); 4724 PARSE_MD_FIELDS(); 4725 #undef VISIT_MD_FIELDS 4726 4727 Result = GET_OR_DISTINCT(DILabel, 4728 (Context, scope.Val, name.Val, file.Val, line.Val)); 4729 return false; 4730 } 4731 4732 /// ParseDIExpression: 4733 /// ::= !DIExpression(0, 7, -1) 4734 bool LLParser::ParseDIExpression(MDNode *&Result, bool IsDistinct) { 4735 assert(Lex.getKind() == lltok::MetadataVar && "Expected metadata type name"); 4736 Lex.Lex(); 4737 4738 if (ParseToken(lltok::lparen, "expected '(' here")) 4739 return true; 4740 4741 SmallVector<uint64_t, 8> Elements; 4742 if (Lex.getKind() != lltok::rparen) 4743 do { 4744 if (Lex.getKind() == lltok::DwarfOp) { 4745 if (unsigned Op = dwarf::getOperationEncoding(Lex.getStrVal())) { 4746 Lex.Lex(); 4747 Elements.push_back(Op); 4748 continue; 4749 } 4750 return TokError(Twine("invalid DWARF op '") + Lex.getStrVal() + "'"); 4751 } 4752 4753 if (Lex.getKind() != lltok::APSInt || Lex.getAPSIntVal().isSigned()) 4754 return TokError("expected unsigned integer"); 4755 4756 auto &U = Lex.getAPSIntVal(); 4757 if (U.ugt(UINT64_MAX)) 4758 return TokError("element too large, limit is " + Twine(UINT64_MAX)); 4759 Elements.push_back(U.getZExtValue()); 4760 Lex.Lex(); 4761 } while (EatIfPresent(lltok::comma)); 4762 4763 if (ParseToken(lltok::rparen, "expected ')' here")) 4764 return true; 4765 4766 Result = GET_OR_DISTINCT(DIExpression, (Context, Elements)); 4767 return false; 4768 } 4769 4770 /// ParseDIGlobalVariableExpression: 4771 /// ::= !DIGlobalVariableExpression(var: !0, expr: !1) 4772 bool LLParser::ParseDIGlobalVariableExpression(MDNode *&Result, 4773 bool IsDistinct) { 4774 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED) \ 4775 REQUIRED(var, MDField, ); \ 4776 REQUIRED(expr, MDField, ); 4777 PARSE_MD_FIELDS(); 4778 #undef VISIT_MD_FIELDS 4779 4780 Result = 4781 GET_OR_DISTINCT(DIGlobalVariableExpression, (Context, var.Val, expr.Val)); 4782 return false; 4783 } 4784 4785 /// ParseDIObjCProperty: 4786 /// ::= !DIObjCProperty(name: "foo", file: !1, line: 7, setter: "setFoo", 4787 /// getter: "getFoo", attributes: 7, type: !2) 4788 bool LLParser::ParseDIObjCProperty(MDNode *&Result, bool IsDistinct) { 4789 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED) \ 4790 OPTIONAL(name, MDStringField, ); \ 4791 OPTIONAL(file, MDField, ); \ 4792 OPTIONAL(line, LineField, ); \ 4793 OPTIONAL(setter, MDStringField, ); \ 4794 OPTIONAL(getter, MDStringField, ); \ 4795 OPTIONAL(attributes, MDUnsignedField, (0, UINT32_MAX)); \ 4796 OPTIONAL(type, MDField, ); 4797 PARSE_MD_FIELDS(); 4798 #undef VISIT_MD_FIELDS 4799 4800 Result = GET_OR_DISTINCT(DIObjCProperty, 4801 (Context, name.Val, file.Val, line.Val, setter.Val, 4802 getter.Val, attributes.Val, type.Val)); 4803 return false; 4804 } 4805 4806 /// ParseDIImportedEntity: 4807 /// ::= !DIImportedEntity(tag: DW_TAG_imported_module, scope: !0, entity: !1, 4808 /// line: 7, name: "foo") 4809 bool LLParser::ParseDIImportedEntity(MDNode *&Result, bool IsDistinct) { 4810 #define VISIT_MD_FIELDS(OPTIONAL, REQUIRED) \ 4811 REQUIRED(tag, DwarfTagField, ); \ 4812 REQUIRED(scope, MDField, ); \ 4813 OPTIONAL(entity, MDField, ); \ 4814 OPTIONAL(file, MDField, ); \ 4815 OPTIONAL(line, LineField, ); \ 4816 OPTIONAL(name, MDStringField, ); 4817 PARSE_MD_FIELDS(); 4818 #undef VISIT_MD_FIELDS 4819 4820 Result = GET_OR_DISTINCT( 4821 DIImportedEntity, 4822 (Context, tag.Val, scope.Val, entity.Val, file.Val, line.Val, name.Val)); 4823 return false; 4824 } 4825 4826 #undef PARSE_MD_FIELD 4827 #undef NOP_FIELD 4828 #undef REQUIRE_FIELD 4829 #undef DECLARE_FIELD 4830 4831 /// ParseMetadataAsValue 4832 /// ::= metadata i32 %local 4833 /// ::= metadata i32 @global 4834 /// ::= metadata i32 7 4835 /// ::= metadata !0 4836 /// ::= metadata !{...} 4837 /// ::= metadata !"string" 4838 bool LLParser::ParseMetadataAsValue(Value *&V, PerFunctionState &PFS) { 4839 // Note: the type 'metadata' has already been parsed. 4840 Metadata *MD; 4841 if (ParseMetadata(MD, &PFS)) 4842 return true; 4843 4844 V = MetadataAsValue::get(Context, MD); 4845 return false; 4846 } 4847 4848 /// ParseValueAsMetadata 4849 /// ::= i32 %local 4850 /// ::= i32 @global 4851 /// ::= i32 7 4852 bool LLParser::ParseValueAsMetadata(Metadata *&MD, const Twine &TypeMsg, 4853 PerFunctionState *PFS) { 4854 Type *Ty; 4855 LocTy Loc; 4856 if (ParseType(Ty, TypeMsg, Loc)) 4857 return true; 4858 if (Ty->isMetadataTy()) 4859 return Error(Loc, "invalid metadata-value-metadata roundtrip"); 4860 4861 Value *V; 4862 if (ParseValue(Ty, V, PFS)) 4863 return true; 4864 4865 MD = ValueAsMetadata::get(V); 4866 return false; 4867 } 4868 4869 /// ParseMetadata 4870 /// ::= i32 %local 4871 /// ::= i32 @global 4872 /// ::= i32 7 4873 /// ::= !42 4874 /// ::= !{...} 4875 /// ::= !"string" 4876 /// ::= !DILocation(...) 4877 bool LLParser::ParseMetadata(Metadata *&MD, PerFunctionState *PFS) { 4878 if (Lex.getKind() == lltok::MetadataVar) { 4879 MDNode *N; 4880 if (ParseSpecializedMDNode(N)) 4881 return true; 4882 MD = N; 4883 return false; 4884 } 4885 4886 // ValueAsMetadata: 4887 // <type> <value> 4888 if (Lex.getKind() != lltok::exclaim) 4889 return ParseValueAsMetadata(MD, "expected metadata operand", PFS); 4890 4891 // '!'. 4892 assert(Lex.getKind() == lltok::exclaim && "Expected '!' here"); 4893 Lex.Lex(); 4894 4895 // MDString: 4896 // ::= '!' STRINGCONSTANT 4897 if (Lex.getKind() == lltok::StringConstant) { 4898 MDString *S; 4899 if (ParseMDString(S)) 4900 return true; 4901 MD = S; 4902 return false; 4903 } 4904 4905 // MDNode: 4906 // !{ ... } 4907 // !7 4908 MDNode *N; 4909 if (ParseMDNodeTail(N)) 4910 return true; 4911 MD = N; 4912 return false; 4913 } 4914 4915 //===----------------------------------------------------------------------===// 4916 // Function Parsing. 4917 //===----------------------------------------------------------------------===// 4918 4919 bool LLParser::ConvertValIDToValue(Type *Ty, ValID &ID, Value *&V, 4920 PerFunctionState *PFS, bool IsCall) { 4921 if (Ty->isFunctionTy()) 4922 return Error(ID.Loc, "functions are not values, refer to them as pointers"); 4923 4924 switch (ID.Kind) { 4925 case ValID::t_LocalID: 4926 if (!PFS) return Error(ID.Loc, "invalid use of function-local name"); 4927 V = PFS->GetVal(ID.UIntVal, Ty, ID.Loc, IsCall); 4928 return V == nullptr; 4929 case ValID::t_LocalName: 4930 if (!PFS) return Error(ID.Loc, "invalid use of function-local name"); 4931 V = PFS->GetVal(ID.StrVal, Ty, ID.Loc, IsCall); 4932 return V == nullptr; 4933 case ValID::t_InlineAsm: { 4934 if (!ID.FTy || !InlineAsm::Verify(ID.FTy, ID.StrVal2)) 4935 return Error(ID.Loc, "invalid type for inline asm constraint string"); 4936 V = InlineAsm::get(ID.FTy, ID.StrVal, ID.StrVal2, ID.UIntVal & 1, 4937 (ID.UIntVal >> 1) & 1, 4938 (InlineAsm::AsmDialect(ID.UIntVal >> 2))); 4939 return false; 4940 } 4941 case ValID::t_GlobalName: 4942 V = GetGlobalVal(ID.StrVal, Ty, ID.Loc, IsCall); 4943 return V == nullptr; 4944 case ValID::t_GlobalID: 4945 V = GetGlobalVal(ID.UIntVal, Ty, ID.Loc, IsCall); 4946 return V == nullptr; 4947 case ValID::t_APSInt: 4948 if (!Ty->isIntegerTy()) 4949 return Error(ID.Loc, "integer constant must have integer type"); 4950 ID.APSIntVal = ID.APSIntVal.extOrTrunc(Ty->getPrimitiveSizeInBits()); 4951 V = ConstantInt::get(Context, ID.APSIntVal); 4952 return false; 4953 case ValID::t_APFloat: 4954 if (!Ty->isFloatingPointTy() || 4955 !ConstantFP::isValueValidForType(Ty, ID.APFloatVal)) 4956 return Error(ID.Loc, "floating point constant invalid for type"); 4957 4958 // The lexer has no type info, so builds all half, float, and double FP 4959 // constants as double. Fix this here. Long double does not need this. 4960 if (&ID.APFloatVal.getSemantics() == &APFloat::IEEEdouble()) { 4961 bool Ignored; 4962 if (Ty->isHalfTy()) 4963 ID.APFloatVal.convert(APFloat::IEEEhalf(), APFloat::rmNearestTiesToEven, 4964 &Ignored); 4965 else if (Ty->isFloatTy()) 4966 ID.APFloatVal.convert(APFloat::IEEEsingle(), APFloat::rmNearestTiesToEven, 4967 &Ignored); 4968 } 4969 V = ConstantFP::get(Context, ID.APFloatVal); 4970 4971 if (V->getType() != Ty) 4972 return Error(ID.Loc, "floating point constant does not have type '" + 4973 getTypeString(Ty) + "'"); 4974 4975 return false; 4976 case ValID::t_Null: 4977 if (!Ty->isPointerTy()) 4978 return Error(ID.Loc, "null must be a pointer type"); 4979 V = ConstantPointerNull::get(cast<PointerType>(Ty)); 4980 return false; 4981 case ValID::t_Undef: 4982 // FIXME: LabelTy should not be a first-class type. 4983 if (!Ty->isFirstClassType() || Ty->isLabelTy()) 4984 return Error(ID.Loc, "invalid type for undef constant"); 4985 V = UndefValue::get(Ty); 4986 return false; 4987 case ValID::t_EmptyArray: 4988 if (!Ty->isArrayTy() || cast<ArrayType>(Ty)->getNumElements() != 0) 4989 return Error(ID.Loc, "invalid empty array initializer"); 4990 V = UndefValue::get(Ty); 4991 return false; 4992 case ValID::t_Zero: 4993 // FIXME: LabelTy should not be a first-class type. 4994 if (!Ty->isFirstClassType() || Ty->isLabelTy()) 4995 return Error(ID.Loc, "invalid type for null constant"); 4996 V = Constant::getNullValue(Ty); 4997 return false; 4998 case ValID::t_None: 4999 if (!Ty->isTokenTy()) 5000 return Error(ID.Loc, "invalid type for none constant"); 5001 V = Constant::getNullValue(Ty); 5002 return false; 5003 case ValID::t_Constant: 5004 if (ID.ConstantVal->getType() != Ty) 5005 return Error(ID.Loc, "constant expression type mismatch"); 5006 5007 V = ID.ConstantVal; 5008 return false; 5009 case ValID::t_ConstantStruct: 5010 case ValID::t_PackedConstantStruct: 5011 if (StructType *ST = dyn_cast<StructType>(Ty)) { 5012 if (ST->getNumElements() != ID.UIntVal) 5013 return Error(ID.Loc, 5014 "initializer with struct type has wrong # elements"); 5015 if (ST->isPacked() != (ID.Kind == ValID::t_PackedConstantStruct)) 5016 return Error(ID.Loc, "packed'ness of initializer and type don't match"); 5017 5018 // Verify that the elements are compatible with the structtype. 5019 for (unsigned i = 0, e = ID.UIntVal; i != e; ++i) 5020 if (ID.ConstantStructElts[i]->getType() != ST->getElementType(i)) 5021 return Error(ID.Loc, "element " + Twine(i) + 5022 " of struct initializer doesn't match struct element type"); 5023 5024 V = ConstantStruct::get( 5025 ST, makeArrayRef(ID.ConstantStructElts.get(), ID.UIntVal)); 5026 } else 5027 return Error(ID.Loc, "constant expression type mismatch"); 5028 return false; 5029 } 5030 llvm_unreachable("Invalid ValID"); 5031 } 5032 5033 bool LLParser::parseConstantValue(Type *Ty, Constant *&C) { 5034 C = nullptr; 5035 ValID ID; 5036 auto Loc = Lex.getLoc(); 5037 if (ParseValID(ID, /*PFS=*/nullptr)) 5038 return true; 5039 switch (ID.Kind) { 5040 case ValID::t_APSInt: 5041 case ValID::t_APFloat: 5042 case ValID::t_Undef: 5043 case ValID::t_Constant: 5044 case ValID::t_ConstantStruct: 5045 case ValID::t_PackedConstantStruct: { 5046 Value *V; 5047 if (ConvertValIDToValue(Ty, ID, V, /*PFS=*/nullptr, /*IsCall=*/false)) 5048 return true; 5049 assert(isa<Constant>(V) && "Expected a constant value"); 5050 C = cast<Constant>(V); 5051 return false; 5052 } 5053 case ValID::t_Null: 5054 C = Constant::getNullValue(Ty); 5055 return false; 5056 default: 5057 return Error(Loc, "expected a constant value"); 5058 } 5059 } 5060 5061 bool LLParser::ParseValue(Type *Ty, Value *&V, PerFunctionState *PFS) { 5062 V = nullptr; 5063 ValID ID; 5064 return ParseValID(ID, PFS) || 5065 ConvertValIDToValue(Ty, ID, V, PFS, /*IsCall=*/false); 5066 } 5067 5068 bool LLParser::ParseTypeAndValue(Value *&V, PerFunctionState *PFS) { 5069 Type *Ty = nullptr; 5070 return ParseType(Ty) || 5071 ParseValue(Ty, V, PFS); 5072 } 5073 5074 bool LLParser::ParseTypeAndBasicBlock(BasicBlock *&BB, LocTy &Loc, 5075 PerFunctionState &PFS) { 5076 Value *V; 5077 Loc = Lex.getLoc(); 5078 if (ParseTypeAndValue(V, PFS)) return true; 5079 if (!isa<BasicBlock>(V)) 5080 return Error(Loc, "expected a basic block"); 5081 BB = cast<BasicBlock>(V); 5082 return false; 5083 } 5084 5085 /// FunctionHeader 5086 /// ::= OptionalLinkage OptionalPreemptionSpecifier OptionalVisibility 5087 /// OptionalCallingConv OptRetAttrs OptUnnamedAddr Type GlobalName 5088 /// '(' ArgList ')' OptAddrSpace OptFuncAttrs OptSection OptionalAlign 5089 /// OptGC OptionalPrefix OptionalPrologue OptPersonalityFn 5090 bool LLParser::ParseFunctionHeader(Function *&Fn, bool isDefine) { 5091 // Parse the linkage. 5092 LocTy LinkageLoc = Lex.getLoc(); 5093 unsigned Linkage; 5094 unsigned Visibility; 5095 unsigned DLLStorageClass; 5096 bool DSOLocal; 5097 AttrBuilder RetAttrs; 5098 unsigned CC; 5099 bool HasLinkage; 5100 Type *RetType = nullptr; 5101 LocTy RetTypeLoc = Lex.getLoc(); 5102 if (ParseOptionalLinkage(Linkage, HasLinkage, Visibility, DLLStorageClass, 5103 DSOLocal) || 5104 ParseOptionalCallingConv(CC) || ParseOptionalReturnAttrs(RetAttrs) || 5105 ParseType(RetType, RetTypeLoc, true /*void allowed*/)) 5106 return true; 5107 5108 // Verify that the linkage is ok. 5109 switch ((GlobalValue::LinkageTypes)Linkage) { 5110 case GlobalValue::ExternalLinkage: 5111 break; // always ok. 5112 case GlobalValue::ExternalWeakLinkage: 5113 if (isDefine) 5114 return Error(LinkageLoc, "invalid linkage for function definition"); 5115 break; 5116 case GlobalValue::PrivateLinkage: 5117 case GlobalValue::InternalLinkage: 5118 case GlobalValue::AvailableExternallyLinkage: 5119 case GlobalValue::LinkOnceAnyLinkage: 5120 case GlobalValue::LinkOnceODRLinkage: 5121 case GlobalValue::WeakAnyLinkage: 5122 case GlobalValue::WeakODRLinkage: 5123 if (!isDefine) 5124 return Error(LinkageLoc, "invalid linkage for function declaration"); 5125 break; 5126 case GlobalValue::AppendingLinkage: 5127 case GlobalValue::CommonLinkage: 5128 return Error(LinkageLoc, "invalid function linkage type"); 5129 } 5130 5131 if (!isValidVisibilityForLinkage(Visibility, Linkage)) 5132 return Error(LinkageLoc, 5133 "symbol with local linkage must have default visibility"); 5134 5135 if (!FunctionType::isValidReturnType(RetType)) 5136 return Error(RetTypeLoc, "invalid function return type"); 5137 5138 LocTy NameLoc = Lex.getLoc(); 5139 5140 std::string FunctionName; 5141 if (Lex.getKind() == lltok::GlobalVar) { 5142 FunctionName = Lex.getStrVal(); 5143 } else if (Lex.getKind() == lltok::GlobalID) { // @42 is ok. 5144 unsigned NameID = Lex.getUIntVal(); 5145 5146 if (NameID != NumberedVals.size()) 5147 return TokError("function expected to be numbered '%" + 5148 Twine(NumberedVals.size()) + "'"); 5149 } else { 5150 return TokError("expected function name"); 5151 } 5152 5153 Lex.Lex(); 5154 5155 if (Lex.getKind() != lltok::lparen) 5156 return TokError("expected '(' in function argument list"); 5157 5158 SmallVector<ArgInfo, 8> ArgList; 5159 bool isVarArg; 5160 AttrBuilder FuncAttrs; 5161 std::vector<unsigned> FwdRefAttrGrps; 5162 LocTy BuiltinLoc; 5163 std::string Section; 5164 unsigned Alignment; 5165 std::string GC; 5166 GlobalValue::UnnamedAddr UnnamedAddr = GlobalValue::UnnamedAddr::None; 5167 unsigned AddrSpace = 0; 5168 Constant *Prefix = nullptr; 5169 Constant *Prologue = nullptr; 5170 Constant *PersonalityFn = nullptr; 5171 Comdat *C; 5172 5173 if (ParseArgumentList(ArgList, isVarArg) || 5174 ParseOptionalUnnamedAddr(UnnamedAddr) || 5175 ParseOptionalProgramAddrSpace(AddrSpace) || 5176 ParseFnAttributeValuePairs(FuncAttrs, FwdRefAttrGrps, false, 5177 BuiltinLoc) || 5178 (EatIfPresent(lltok::kw_section) && 5179 ParseStringConstant(Section)) || 5180 parseOptionalComdat(FunctionName, C) || 5181 ParseOptionalAlignment(Alignment) || 5182 (EatIfPresent(lltok::kw_gc) && 5183 ParseStringConstant(GC)) || 5184 (EatIfPresent(lltok::kw_prefix) && 5185 ParseGlobalTypeAndValue(Prefix)) || 5186 (EatIfPresent(lltok::kw_prologue) && 5187 ParseGlobalTypeAndValue(Prologue)) || 5188 (EatIfPresent(lltok::kw_personality) && 5189 ParseGlobalTypeAndValue(PersonalityFn))) 5190 return true; 5191 5192 if (FuncAttrs.contains(Attribute::Builtin)) 5193 return Error(BuiltinLoc, "'builtin' attribute not valid on function"); 5194 5195 // If the alignment was parsed as an attribute, move to the alignment field. 5196 if (FuncAttrs.hasAlignmentAttr()) { 5197 Alignment = FuncAttrs.getAlignment(); 5198 FuncAttrs.removeAttribute(Attribute::Alignment); 5199 } 5200 5201 // Okay, if we got here, the function is syntactically valid. Convert types 5202 // and do semantic checks. 5203 std::vector<Type*> ParamTypeList; 5204 SmallVector<AttributeSet, 8> Attrs; 5205 5206 for (unsigned i = 0, e = ArgList.size(); i != e; ++i) { 5207 ParamTypeList.push_back(ArgList[i].Ty); 5208 Attrs.push_back(ArgList[i].Attrs); 5209 } 5210 5211 AttributeList PAL = 5212 AttributeList::get(Context, AttributeSet::get(Context, FuncAttrs), 5213 AttributeSet::get(Context, RetAttrs), Attrs); 5214 5215 if (PAL.hasAttribute(1, Attribute::StructRet) && !RetType->isVoidTy()) 5216 return Error(RetTypeLoc, "functions with 'sret' argument must return void"); 5217 5218 FunctionType *FT = 5219 FunctionType::get(RetType, ParamTypeList, isVarArg); 5220 PointerType *PFT = PointerType::get(FT, AddrSpace); 5221 5222 Fn = nullptr; 5223 if (!FunctionName.empty()) { 5224 // If this was a definition of a forward reference, remove the definition 5225 // from the forward reference table and fill in the forward ref. 5226 auto FRVI = ForwardRefVals.find(FunctionName); 5227 if (FRVI != ForwardRefVals.end()) { 5228 Fn = M->getFunction(FunctionName); 5229 if (!Fn) 5230 return Error(FRVI->second.second, "invalid forward reference to " 5231 "function as global value!"); 5232 if (Fn->getType() != PFT) 5233 return Error(FRVI->second.second, "invalid forward reference to " 5234 "function '" + FunctionName + "' with wrong type: " 5235 "expected '" + getTypeString(PFT) + "' but was '" + 5236 getTypeString(Fn->getType()) + "'"); 5237 ForwardRefVals.erase(FRVI); 5238 } else if ((Fn = M->getFunction(FunctionName))) { 5239 // Reject redefinitions. 5240 return Error(NameLoc, "invalid redefinition of function '" + 5241 FunctionName + "'"); 5242 } else if (M->getNamedValue(FunctionName)) { 5243 return Error(NameLoc, "redefinition of function '@" + FunctionName + "'"); 5244 } 5245 5246 } else { 5247 // If this is a definition of a forward referenced function, make sure the 5248 // types agree. 5249 auto I = ForwardRefValIDs.find(NumberedVals.size()); 5250 if (I != ForwardRefValIDs.end()) { 5251 Fn = cast<Function>(I->second.first); 5252 if (Fn->getType() != PFT) 5253 return Error(NameLoc, "type of definition and forward reference of '@" + 5254 Twine(NumberedVals.size()) + "' disagree: " 5255 "expected '" + getTypeString(PFT) + "' but was '" + 5256 getTypeString(Fn->getType()) + "'"); 5257 ForwardRefValIDs.erase(I); 5258 } 5259 } 5260 5261 if (!Fn) 5262 Fn = Function::Create(FT, GlobalValue::ExternalLinkage, AddrSpace, 5263 FunctionName, M); 5264 else // Move the forward-reference to the correct spot in the module. 5265 M->getFunctionList().splice(M->end(), M->getFunctionList(), Fn); 5266 5267 assert(Fn->getAddressSpace() == AddrSpace && "Created function in wrong AS"); 5268 5269 if (FunctionName.empty()) 5270 NumberedVals.push_back(Fn); 5271 5272 Fn->setLinkage((GlobalValue::LinkageTypes)Linkage); 5273 maybeSetDSOLocal(DSOLocal, *Fn); 5274 Fn->setVisibility((GlobalValue::VisibilityTypes)Visibility); 5275 Fn->setDLLStorageClass((GlobalValue::DLLStorageClassTypes)DLLStorageClass); 5276 Fn->setCallingConv(CC); 5277 Fn->setAttributes(PAL); 5278 Fn->setUnnamedAddr(UnnamedAddr); 5279 Fn->setAlignment(Alignment); 5280 Fn->setSection(Section); 5281 Fn->setComdat(C); 5282 Fn->setPersonalityFn(PersonalityFn); 5283 if (!GC.empty()) Fn->setGC(GC); 5284 Fn->setPrefixData(Prefix); 5285 Fn->setPrologueData(Prologue); 5286 ForwardRefAttrGroups[Fn] = FwdRefAttrGrps; 5287 5288 // Add all of the arguments we parsed to the function. 5289 Function::arg_iterator ArgIt = Fn->arg_begin(); 5290 for (unsigned i = 0, e = ArgList.size(); i != e; ++i, ++ArgIt) { 5291 // If the argument has a name, insert it into the argument symbol table. 5292 if (ArgList[i].Name.empty()) continue; 5293 5294 // Set the name, if it conflicted, it will be auto-renamed. 5295 ArgIt->setName(ArgList[i].Name); 5296 5297 if (ArgIt->getName() != ArgList[i].Name) 5298 return Error(ArgList[i].Loc, "redefinition of argument '%" + 5299 ArgList[i].Name + "'"); 5300 } 5301 5302 if (isDefine) 5303 return false; 5304 5305 // Check the declaration has no block address forward references. 5306 ValID ID; 5307 if (FunctionName.empty()) { 5308 ID.Kind = ValID::t_GlobalID; 5309 ID.UIntVal = NumberedVals.size() - 1; 5310 } else { 5311 ID.Kind = ValID::t_GlobalName; 5312 ID.StrVal = FunctionName; 5313 } 5314 auto Blocks = ForwardRefBlockAddresses.find(ID); 5315 if (Blocks != ForwardRefBlockAddresses.end()) 5316 return Error(Blocks->first.Loc, 5317 "cannot take blockaddress inside a declaration"); 5318 return false; 5319 } 5320 5321 bool LLParser::PerFunctionState::resolveForwardRefBlockAddresses() { 5322 ValID ID; 5323 if (FunctionNumber == -1) { 5324 ID.Kind = ValID::t_GlobalName; 5325 ID.StrVal = F.getName(); 5326 } else { 5327 ID.Kind = ValID::t_GlobalID; 5328 ID.UIntVal = FunctionNumber; 5329 } 5330 5331 auto Blocks = P.ForwardRefBlockAddresses.find(ID); 5332 if (Blocks == P.ForwardRefBlockAddresses.end()) 5333 return false; 5334 5335 for (const auto &I : Blocks->second) { 5336 const ValID &BBID = I.first; 5337 GlobalValue *GV = I.second; 5338 5339 assert((BBID.Kind == ValID::t_LocalID || BBID.Kind == ValID::t_LocalName) && 5340 "Expected local id or name"); 5341 BasicBlock *BB; 5342 if (BBID.Kind == ValID::t_LocalName) 5343 BB = GetBB(BBID.StrVal, BBID.Loc); 5344 else 5345 BB = GetBB(BBID.UIntVal, BBID.Loc); 5346 if (!BB) 5347 return P.Error(BBID.Loc, "referenced value is not a basic block"); 5348 5349 GV->replaceAllUsesWith(BlockAddress::get(&F, BB)); 5350 GV->eraseFromParent(); 5351 } 5352 5353 P.ForwardRefBlockAddresses.erase(Blocks); 5354 return false; 5355 } 5356 5357 /// ParseFunctionBody 5358 /// ::= '{' BasicBlock+ UseListOrderDirective* '}' 5359 bool LLParser::ParseFunctionBody(Function &Fn) { 5360 if (Lex.getKind() != lltok::lbrace) 5361 return TokError("expected '{' in function body"); 5362 Lex.Lex(); // eat the {. 5363 5364 int FunctionNumber = -1; 5365 if (!Fn.hasName()) FunctionNumber = NumberedVals.size()-1; 5366 5367 PerFunctionState PFS(*this, Fn, FunctionNumber); 5368 5369 // Resolve block addresses and allow basic blocks to be forward-declared 5370 // within this function. 5371 if (PFS.resolveForwardRefBlockAddresses()) 5372 return true; 5373 SaveAndRestore<PerFunctionState *> ScopeExit(BlockAddressPFS, &PFS); 5374 5375 // We need at least one basic block. 5376 if (Lex.getKind() == lltok::rbrace || Lex.getKind() == lltok::kw_uselistorder) 5377 return TokError("function body requires at least one basic block"); 5378 5379 while (Lex.getKind() != lltok::rbrace && 5380 Lex.getKind() != lltok::kw_uselistorder) 5381 if (ParseBasicBlock(PFS)) return true; 5382 5383 while (Lex.getKind() != lltok::rbrace) 5384 if (ParseUseListOrder(&PFS)) 5385 return true; 5386 5387 // Eat the }. 5388 Lex.Lex(); 5389 5390 // Verify function is ok. 5391 return PFS.FinishFunction(); 5392 } 5393 5394 /// ParseBasicBlock 5395 /// ::= LabelStr? Instruction* 5396 bool LLParser::ParseBasicBlock(PerFunctionState &PFS) { 5397 // If this basic block starts out with a name, remember it. 5398 std::string Name; 5399 LocTy NameLoc = Lex.getLoc(); 5400 if (Lex.getKind() == lltok::LabelStr) { 5401 Name = Lex.getStrVal(); 5402 Lex.Lex(); 5403 } 5404 5405 BasicBlock *BB = PFS.DefineBB(Name, NameLoc); 5406 if (!BB) 5407 return Error(NameLoc, 5408 "unable to create block named '" + Name + "'"); 5409 5410 std::string NameStr; 5411 5412 // Parse the instructions in this block until we get a terminator. 5413 Instruction *Inst; 5414 do { 5415 // This instruction may have three possibilities for a name: a) none 5416 // specified, b) name specified "%foo =", c) number specified: "%4 =". 5417 LocTy NameLoc = Lex.getLoc(); 5418 int NameID = -1; 5419 NameStr = ""; 5420 5421 if (Lex.getKind() == lltok::LocalVarID) { 5422 NameID = Lex.getUIntVal(); 5423 Lex.Lex(); 5424 if (ParseToken(lltok::equal, "expected '=' after instruction id")) 5425 return true; 5426 } else if (Lex.getKind() == lltok::LocalVar) { 5427 NameStr = Lex.getStrVal(); 5428 Lex.Lex(); 5429 if (ParseToken(lltok::equal, "expected '=' after instruction name")) 5430 return true; 5431 } 5432 5433 switch (ParseInstruction(Inst, BB, PFS)) { 5434 default: llvm_unreachable("Unknown ParseInstruction result!"); 5435 case InstError: return true; 5436 case InstNormal: 5437 BB->getInstList().push_back(Inst); 5438 5439 // With a normal result, we check to see if the instruction is followed by 5440 // a comma and metadata. 5441 if (EatIfPresent(lltok::comma)) 5442 if (ParseInstructionMetadata(*Inst)) 5443 return true; 5444 break; 5445 case InstExtraComma: 5446 BB->getInstList().push_back(Inst); 5447 5448 // If the instruction parser ate an extra comma at the end of it, it 5449 // *must* be followed by metadata. 5450 if (ParseInstructionMetadata(*Inst)) 5451 return true; 5452 break; 5453 } 5454 5455 // Set the name on the instruction. 5456 if (PFS.SetInstName(NameID, NameStr, NameLoc, Inst)) return true; 5457 } while (!Inst->isTerminator()); 5458 5459 return false; 5460 } 5461 5462 //===----------------------------------------------------------------------===// 5463 // Instruction Parsing. 5464 //===----------------------------------------------------------------------===// 5465 5466 /// ParseInstruction - Parse one of the many different instructions. 5467 /// 5468 int LLParser::ParseInstruction(Instruction *&Inst, BasicBlock *BB, 5469 PerFunctionState &PFS) { 5470 lltok::Kind Token = Lex.getKind(); 5471 if (Token == lltok::Eof) 5472 return TokError("found end of file when expecting more instructions"); 5473 LocTy Loc = Lex.getLoc(); 5474 unsigned KeywordVal = Lex.getUIntVal(); 5475 Lex.Lex(); // Eat the keyword. 5476 5477 switch (Token) { 5478 default: return Error(Loc, "expected instruction opcode"); 5479 // Terminator Instructions. 5480 case lltok::kw_unreachable: Inst = new UnreachableInst(Context); return false; 5481 case lltok::kw_ret: return ParseRet(Inst, BB, PFS); 5482 case lltok::kw_br: return ParseBr(Inst, PFS); 5483 case lltok::kw_switch: return ParseSwitch(Inst, PFS); 5484 case lltok::kw_indirectbr: return ParseIndirectBr(Inst, PFS); 5485 case lltok::kw_invoke: return ParseInvoke(Inst, PFS); 5486 case lltok::kw_resume: return ParseResume(Inst, PFS); 5487 case lltok::kw_cleanupret: return ParseCleanupRet(Inst, PFS); 5488 case lltok::kw_catchret: return ParseCatchRet(Inst, PFS); 5489 case lltok::kw_catchswitch: return ParseCatchSwitch(Inst, PFS); 5490 case lltok::kw_catchpad: return ParseCatchPad(Inst, PFS); 5491 case lltok::kw_cleanuppad: return ParseCleanupPad(Inst, PFS); 5492 // Binary Operators. 5493 case lltok::kw_add: 5494 case lltok::kw_sub: 5495 case lltok::kw_mul: 5496 case lltok::kw_shl: { 5497 bool NUW = EatIfPresent(lltok::kw_nuw); 5498 bool NSW = EatIfPresent(lltok::kw_nsw); 5499 if (!NUW) NUW = EatIfPresent(lltok::kw_nuw); 5500 5501 if (ParseArithmetic(Inst, PFS, KeywordVal, 1)) return true; 5502 5503 if (NUW) cast<BinaryOperator>(Inst)->setHasNoUnsignedWrap(true); 5504 if (NSW) cast<BinaryOperator>(Inst)->setHasNoSignedWrap(true); 5505 return false; 5506 } 5507 case lltok::kw_fadd: 5508 case lltok::kw_fsub: 5509 case lltok::kw_fmul: 5510 case lltok::kw_fdiv: 5511 case lltok::kw_frem: { 5512 FastMathFlags FMF = EatFastMathFlagsIfPresent(); 5513 int Res = ParseArithmetic(Inst, PFS, KeywordVal, 2); 5514 if (Res != 0) 5515 return Res; 5516 if (FMF.any()) 5517 Inst->setFastMathFlags(FMF); 5518 return 0; 5519 } 5520 5521 case lltok::kw_sdiv: 5522 case lltok::kw_udiv: 5523 case lltok::kw_lshr: 5524 case lltok::kw_ashr: { 5525 bool Exact = EatIfPresent(lltok::kw_exact); 5526 5527 if (ParseArithmetic(Inst, PFS, KeywordVal, 1)) return true; 5528 if (Exact) cast<BinaryOperator>(Inst)->setIsExact(true); 5529 return false; 5530 } 5531 5532 case lltok::kw_urem: 5533 case lltok::kw_srem: return ParseArithmetic(Inst, PFS, KeywordVal, 1); 5534 case lltok::kw_and: 5535 case lltok::kw_or: 5536 case lltok::kw_xor: return ParseLogical(Inst, PFS, KeywordVal); 5537 case lltok::kw_icmp: return ParseCompare(Inst, PFS, KeywordVal); 5538 case lltok::kw_fcmp: { 5539 FastMathFlags FMF = EatFastMathFlagsIfPresent(); 5540 int Res = ParseCompare(Inst, PFS, KeywordVal); 5541 if (Res != 0) 5542 return Res; 5543 if (FMF.any()) 5544 Inst->setFastMathFlags(FMF); 5545 return 0; 5546 } 5547 5548 // Casts. 5549 case lltok::kw_trunc: 5550 case lltok::kw_zext: 5551 case lltok::kw_sext: 5552 case lltok::kw_fptrunc: 5553 case lltok::kw_fpext: 5554 case lltok::kw_bitcast: 5555 case lltok::kw_addrspacecast: 5556 case lltok::kw_uitofp: 5557 case lltok::kw_sitofp: 5558 case lltok::kw_fptoui: 5559 case lltok::kw_fptosi: 5560 case lltok::kw_inttoptr: 5561 case lltok::kw_ptrtoint: return ParseCast(Inst, PFS, KeywordVal); 5562 // Other. 5563 case lltok::kw_select: return ParseSelect(Inst, PFS); 5564 case lltok::kw_va_arg: return ParseVA_Arg(Inst, PFS); 5565 case lltok::kw_extractelement: return ParseExtractElement(Inst, PFS); 5566 case lltok::kw_insertelement: return ParseInsertElement(Inst, PFS); 5567 case lltok::kw_shufflevector: return ParseShuffleVector(Inst, PFS); 5568 case lltok::kw_phi: return ParsePHI(Inst, PFS); 5569 case lltok::kw_landingpad: return ParseLandingPad(Inst, PFS); 5570 // Call. 5571 case lltok::kw_call: return ParseCall(Inst, PFS, CallInst::TCK_None); 5572 case lltok::kw_tail: return ParseCall(Inst, PFS, CallInst::TCK_Tail); 5573 case lltok::kw_musttail: return ParseCall(Inst, PFS, CallInst::TCK_MustTail); 5574 case lltok::kw_notail: return ParseCall(Inst, PFS, CallInst::TCK_NoTail); 5575 // Memory. 5576 case lltok::kw_alloca: return ParseAlloc(Inst, PFS); 5577 case lltok::kw_load: return ParseLoad(Inst, PFS); 5578 case lltok::kw_store: return ParseStore(Inst, PFS); 5579 case lltok::kw_cmpxchg: return ParseCmpXchg(Inst, PFS); 5580 case lltok::kw_atomicrmw: return ParseAtomicRMW(Inst, PFS); 5581 case lltok::kw_fence: return ParseFence(Inst, PFS); 5582 case lltok::kw_getelementptr: return ParseGetElementPtr(Inst, PFS); 5583 case lltok::kw_extractvalue: return ParseExtractValue(Inst, PFS); 5584 case lltok::kw_insertvalue: return ParseInsertValue(Inst, PFS); 5585 } 5586 } 5587 5588 /// ParseCmpPredicate - Parse an integer or fp predicate, based on Kind. 5589 bool LLParser::ParseCmpPredicate(unsigned &P, unsigned Opc) { 5590 if (Opc == Instruction::FCmp) { 5591 switch (Lex.getKind()) { 5592 default: return TokError("expected fcmp predicate (e.g. 'oeq')"); 5593 case lltok::kw_oeq: P = CmpInst::FCMP_OEQ; break; 5594 case lltok::kw_one: P = CmpInst::FCMP_ONE; break; 5595 case lltok::kw_olt: P = CmpInst::FCMP_OLT; break; 5596 case lltok::kw_ogt: P = CmpInst::FCMP_OGT; break; 5597 case lltok::kw_ole: P = CmpInst::FCMP_OLE; break; 5598 case lltok::kw_oge: P = CmpInst::FCMP_OGE; break; 5599 case lltok::kw_ord: P = CmpInst::FCMP_ORD; break; 5600 case lltok::kw_uno: P = CmpInst::FCMP_UNO; break; 5601 case lltok::kw_ueq: P = CmpInst::FCMP_UEQ; break; 5602 case lltok::kw_une: P = CmpInst::FCMP_UNE; break; 5603 case lltok::kw_ult: P = CmpInst::FCMP_ULT; break; 5604 case lltok::kw_ugt: P = CmpInst::FCMP_UGT; break; 5605 case lltok::kw_ule: P = CmpInst::FCMP_ULE; break; 5606 case lltok::kw_uge: P = CmpInst::FCMP_UGE; break; 5607 case lltok::kw_true: P = CmpInst::FCMP_TRUE; break; 5608 case lltok::kw_false: P = CmpInst::FCMP_FALSE; break; 5609 } 5610 } else { 5611 switch (Lex.getKind()) { 5612 default: return TokError("expected icmp predicate (e.g. 'eq')"); 5613 case lltok::kw_eq: P = CmpInst::ICMP_EQ; break; 5614 case lltok::kw_ne: P = CmpInst::ICMP_NE; break; 5615 case lltok::kw_slt: P = CmpInst::ICMP_SLT; break; 5616 case lltok::kw_sgt: P = CmpInst::ICMP_SGT; break; 5617 case lltok::kw_sle: P = CmpInst::ICMP_SLE; break; 5618 case lltok::kw_sge: P = CmpInst::ICMP_SGE; break; 5619 case lltok::kw_ult: P = CmpInst::ICMP_ULT; break; 5620 case lltok::kw_ugt: P = CmpInst::ICMP_UGT; break; 5621 case lltok::kw_ule: P = CmpInst::ICMP_ULE; break; 5622 case lltok::kw_uge: P = CmpInst::ICMP_UGE; break; 5623 } 5624 } 5625 Lex.Lex(); 5626 return false; 5627 } 5628 5629 //===----------------------------------------------------------------------===// 5630 // Terminator Instructions. 5631 //===----------------------------------------------------------------------===// 5632 5633 /// ParseRet - Parse a return instruction. 5634 /// ::= 'ret' void (',' !dbg, !1)* 5635 /// ::= 'ret' TypeAndValue (',' !dbg, !1)* 5636 bool LLParser::ParseRet(Instruction *&Inst, BasicBlock *BB, 5637 PerFunctionState &PFS) { 5638 SMLoc TypeLoc = Lex.getLoc(); 5639 Type *Ty = nullptr; 5640 if (ParseType(Ty, true /*void allowed*/)) return true; 5641 5642 Type *ResType = PFS.getFunction().getReturnType(); 5643 5644 if (Ty->isVoidTy()) { 5645 if (!ResType->isVoidTy()) 5646 return Error(TypeLoc, "value doesn't match function result type '" + 5647 getTypeString(ResType) + "'"); 5648 5649 Inst = ReturnInst::Create(Context); 5650 return false; 5651 } 5652 5653 Value *RV; 5654 if (ParseValue(Ty, RV, PFS)) return true; 5655 5656 if (ResType != RV->getType()) 5657 return Error(TypeLoc, "value doesn't match function result type '" + 5658 getTypeString(ResType) + "'"); 5659 5660 Inst = ReturnInst::Create(Context, RV); 5661 return false; 5662 } 5663 5664 /// ParseBr 5665 /// ::= 'br' TypeAndValue 5666 /// ::= 'br' TypeAndValue ',' TypeAndValue ',' TypeAndValue 5667 bool LLParser::ParseBr(Instruction *&Inst, PerFunctionState &PFS) { 5668 LocTy Loc, Loc2; 5669 Value *Op0; 5670 BasicBlock *Op1, *Op2; 5671 if (ParseTypeAndValue(Op0, Loc, PFS)) return true; 5672 5673 if (BasicBlock *BB = dyn_cast<BasicBlock>(Op0)) { 5674 Inst = BranchInst::Create(BB); 5675 return false; 5676 } 5677 5678 if (Op0->getType() != Type::getInt1Ty(Context)) 5679 return Error(Loc, "branch condition must have 'i1' type"); 5680 5681 if (ParseToken(lltok::comma, "expected ',' after branch condition") || 5682 ParseTypeAndBasicBlock(Op1, Loc, PFS) || 5683 ParseToken(lltok::comma, "expected ',' after true destination") || 5684 ParseTypeAndBasicBlock(Op2, Loc2, PFS)) 5685 return true; 5686 5687 Inst = BranchInst::Create(Op1, Op2, Op0); 5688 return false; 5689 } 5690 5691 /// ParseSwitch 5692 /// Instruction 5693 /// ::= 'switch' TypeAndValue ',' TypeAndValue '[' JumpTable ']' 5694 /// JumpTable 5695 /// ::= (TypeAndValue ',' TypeAndValue)* 5696 bool LLParser::ParseSwitch(Instruction *&Inst, PerFunctionState &PFS) { 5697 LocTy CondLoc, BBLoc; 5698 Value *Cond; 5699 BasicBlock *DefaultBB; 5700 if (ParseTypeAndValue(Cond, CondLoc, PFS) || 5701 ParseToken(lltok::comma, "expected ',' after switch condition") || 5702 ParseTypeAndBasicBlock(DefaultBB, BBLoc, PFS) || 5703 ParseToken(lltok::lsquare, "expected '[' with switch table")) 5704 return true; 5705 5706 if (!Cond->getType()->isIntegerTy()) 5707 return Error(CondLoc, "switch condition must have integer type"); 5708 5709 // Parse the jump table pairs. 5710 SmallPtrSet<Value*, 32> SeenCases; 5711 SmallVector<std::pair<ConstantInt*, BasicBlock*>, 32> Table; 5712 while (Lex.getKind() != lltok::rsquare) { 5713 Value *Constant; 5714 BasicBlock *DestBB; 5715 5716 if (ParseTypeAndValue(Constant, CondLoc, PFS) || 5717 ParseToken(lltok::comma, "expected ',' after case value") || 5718 ParseTypeAndBasicBlock(DestBB, PFS)) 5719 return true; 5720 5721 if (!SeenCases.insert(Constant).second) 5722 return Error(CondLoc, "duplicate case value in switch"); 5723 if (!isa<ConstantInt>(Constant)) 5724 return Error(CondLoc, "case value is not a constant integer"); 5725 5726 Table.push_back(std::make_pair(cast<ConstantInt>(Constant), DestBB)); 5727 } 5728 5729 Lex.Lex(); // Eat the ']'. 5730 5731 SwitchInst *SI = SwitchInst::Create(Cond, DefaultBB, Table.size()); 5732 for (unsigned i = 0, e = Table.size(); i != e; ++i) 5733 SI->addCase(Table[i].first, Table[i].second); 5734 Inst = SI; 5735 return false; 5736 } 5737 5738 /// ParseIndirectBr 5739 /// Instruction 5740 /// ::= 'indirectbr' TypeAndValue ',' '[' LabelList ']' 5741 bool LLParser::ParseIndirectBr(Instruction *&Inst, PerFunctionState &PFS) { 5742 LocTy AddrLoc; 5743 Value *Address; 5744 if (ParseTypeAndValue(Address, AddrLoc, PFS) || 5745 ParseToken(lltok::comma, "expected ',' after indirectbr address") || 5746 ParseToken(lltok::lsquare, "expected '[' with indirectbr")) 5747 return true; 5748 5749 if (!Address->getType()->isPointerTy()) 5750 return Error(AddrLoc, "indirectbr address must have pointer type"); 5751 5752 // Parse the destination list. 5753 SmallVector<BasicBlock*, 16> DestList; 5754 5755 if (Lex.getKind() != lltok::rsquare) { 5756 BasicBlock *DestBB; 5757 if (ParseTypeAndBasicBlock(DestBB, PFS)) 5758 return true; 5759 DestList.push_back(DestBB); 5760 5761 while (EatIfPresent(lltok::comma)) { 5762 if (ParseTypeAndBasicBlock(DestBB, PFS)) 5763 return true; 5764 DestList.push_back(DestBB); 5765 } 5766 } 5767 5768 if (ParseToken(lltok::rsquare, "expected ']' at end of block list")) 5769 return true; 5770 5771 IndirectBrInst *IBI = IndirectBrInst::Create(Address, DestList.size()); 5772 for (unsigned i = 0, e = DestList.size(); i != e; ++i) 5773 IBI->addDestination(DestList[i]); 5774 Inst = IBI; 5775 return false; 5776 } 5777 5778 /// ParseInvoke 5779 /// ::= 'invoke' OptionalCallingConv OptionalAttrs Type Value ParamList 5780 /// OptionalAttrs 'to' TypeAndValue 'unwind' TypeAndValue 5781 bool LLParser::ParseInvoke(Instruction *&Inst, PerFunctionState &PFS) { 5782 LocTy CallLoc = Lex.getLoc(); 5783 AttrBuilder RetAttrs, FnAttrs; 5784 std::vector<unsigned> FwdRefAttrGrps; 5785 LocTy NoBuiltinLoc; 5786 unsigned CC; 5787 unsigned InvokeAddrSpace; 5788 Type *RetType = nullptr; 5789 LocTy RetTypeLoc; 5790 ValID CalleeID; 5791 SmallVector<ParamInfo, 16> ArgList; 5792 SmallVector<OperandBundleDef, 2> BundleList; 5793 5794 BasicBlock *NormalBB, *UnwindBB; 5795 if (ParseOptionalCallingConv(CC) || ParseOptionalReturnAttrs(RetAttrs) || 5796 ParseOptionalProgramAddrSpace(InvokeAddrSpace) || 5797 ParseType(RetType, RetTypeLoc, true /*void allowed*/) || 5798 ParseValID(CalleeID) || ParseParameterList(ArgList, PFS) || 5799 ParseFnAttributeValuePairs(FnAttrs, FwdRefAttrGrps, false, 5800 NoBuiltinLoc) || 5801 ParseOptionalOperandBundles(BundleList, PFS) || 5802 ParseToken(lltok::kw_to, "expected 'to' in invoke") || 5803 ParseTypeAndBasicBlock(NormalBB, PFS) || 5804 ParseToken(lltok::kw_unwind, "expected 'unwind' in invoke") || 5805 ParseTypeAndBasicBlock(UnwindBB, PFS)) 5806 return true; 5807 5808 // If RetType is a non-function pointer type, then this is the short syntax 5809 // for the call, which means that RetType is just the return type. Infer the 5810 // rest of the function argument types from the arguments that are present. 5811 FunctionType *Ty = dyn_cast<FunctionType>(RetType); 5812 if (!Ty) { 5813 // Pull out the types of all of the arguments... 5814 std::vector<Type*> ParamTypes; 5815 for (unsigned i = 0, e = ArgList.size(); i != e; ++i) 5816 ParamTypes.push_back(ArgList[i].V->getType()); 5817 5818 if (!FunctionType::isValidReturnType(RetType)) 5819 return Error(RetTypeLoc, "Invalid result type for LLVM function"); 5820 5821 Ty = FunctionType::get(RetType, ParamTypes, false); 5822 } 5823 5824 CalleeID.FTy = Ty; 5825 5826 // Look up the callee. 5827 Value *Callee; 5828 if (ConvertValIDToValue(PointerType::get(Ty, InvokeAddrSpace), CalleeID, 5829 Callee, &PFS, /*IsCall=*/true)) 5830 return true; 5831 5832 // Set up the Attribute for the function. 5833 SmallVector<Value *, 8> Args; 5834 SmallVector<AttributeSet, 8> ArgAttrs; 5835 5836 // Loop through FunctionType's arguments and ensure they are specified 5837 // correctly. Also, gather any parameter attributes. 5838 FunctionType::param_iterator I = Ty->param_begin(); 5839 FunctionType::param_iterator E = Ty->param_end(); 5840 for (unsigned i = 0, e = ArgList.size(); i != e; ++i) { 5841 Type *ExpectedTy = nullptr; 5842 if (I != E) { 5843 ExpectedTy = *I++; 5844 } else if (!Ty->isVarArg()) { 5845 return Error(ArgList[i].Loc, "too many arguments specified"); 5846 } 5847 5848 if (ExpectedTy && ExpectedTy != ArgList[i].V->getType()) 5849 return Error(ArgList[i].Loc, "argument is not of expected type '" + 5850 getTypeString(ExpectedTy) + "'"); 5851 Args.push_back(ArgList[i].V); 5852 ArgAttrs.push_back(ArgList[i].Attrs); 5853 } 5854 5855 if (I != E) 5856 return Error(CallLoc, "not enough parameters specified for call"); 5857 5858 if (FnAttrs.hasAlignmentAttr()) 5859 return Error(CallLoc, "invoke instructions may not have an alignment"); 5860 5861 // Finish off the Attribute and check them 5862 AttributeList PAL = 5863 AttributeList::get(Context, AttributeSet::get(Context, FnAttrs), 5864 AttributeSet::get(Context, RetAttrs), ArgAttrs); 5865 5866 InvokeInst *II = 5867 InvokeInst::Create(Ty, Callee, NormalBB, UnwindBB, Args, BundleList); 5868 II->setCallingConv(CC); 5869 II->setAttributes(PAL); 5870 ForwardRefAttrGroups[II] = FwdRefAttrGrps; 5871 Inst = II; 5872 return false; 5873 } 5874 5875 /// ParseResume 5876 /// ::= 'resume' TypeAndValue 5877 bool LLParser::ParseResume(Instruction *&Inst, PerFunctionState &PFS) { 5878 Value *Exn; LocTy ExnLoc; 5879 if (ParseTypeAndValue(Exn, ExnLoc, PFS)) 5880 return true; 5881 5882 ResumeInst *RI = ResumeInst::Create(Exn); 5883 Inst = RI; 5884 return false; 5885 } 5886 5887 bool LLParser::ParseExceptionArgs(SmallVectorImpl<Value *> &Args, 5888 PerFunctionState &PFS) { 5889 if (ParseToken(lltok::lsquare, "expected '[' in catchpad/cleanuppad")) 5890 return true; 5891 5892 while (Lex.getKind() != lltok::rsquare) { 5893 // If this isn't the first argument, we need a comma. 5894 if (!Args.empty() && 5895 ParseToken(lltok::comma, "expected ',' in argument list")) 5896 return true; 5897 5898 // Parse the argument. 5899 LocTy ArgLoc; 5900 Type *ArgTy = nullptr; 5901 if (ParseType(ArgTy, ArgLoc)) 5902 return true; 5903 5904 Value *V; 5905 if (ArgTy->isMetadataTy()) { 5906 if (ParseMetadataAsValue(V, PFS)) 5907 return true; 5908 } else { 5909 if (ParseValue(ArgTy, V, PFS)) 5910 return true; 5911 } 5912 Args.push_back(V); 5913 } 5914 5915 Lex.Lex(); // Lex the ']'. 5916 return false; 5917 } 5918 5919 /// ParseCleanupRet 5920 /// ::= 'cleanupret' from Value unwind ('to' 'caller' | TypeAndValue) 5921 bool LLParser::ParseCleanupRet(Instruction *&Inst, PerFunctionState &PFS) { 5922 Value *CleanupPad = nullptr; 5923 5924 if (ParseToken(lltok::kw_from, "expected 'from' after cleanupret")) 5925 return true; 5926 5927 if (ParseValue(Type::getTokenTy(Context), CleanupPad, PFS)) 5928 return true; 5929 5930 if (ParseToken(lltok::kw_unwind, "expected 'unwind' in cleanupret")) 5931 return true; 5932 5933 BasicBlock *UnwindBB = nullptr; 5934 if (Lex.getKind() == lltok::kw_to) { 5935 Lex.Lex(); 5936 if (ParseToken(lltok::kw_caller, "expected 'caller' in cleanupret")) 5937 return true; 5938 } else { 5939 if (ParseTypeAndBasicBlock(UnwindBB, PFS)) { 5940 return true; 5941 } 5942 } 5943 5944 Inst = CleanupReturnInst::Create(CleanupPad, UnwindBB); 5945 return false; 5946 } 5947 5948 /// ParseCatchRet 5949 /// ::= 'catchret' from Parent Value 'to' TypeAndValue 5950 bool LLParser::ParseCatchRet(Instruction *&Inst, PerFunctionState &PFS) { 5951 Value *CatchPad = nullptr; 5952 5953 if (ParseToken(lltok::kw_from, "expected 'from' after catchret")) 5954 return true; 5955 5956 if (ParseValue(Type::getTokenTy(Context), CatchPad, PFS)) 5957 return true; 5958 5959 BasicBlock *BB; 5960 if (ParseToken(lltok::kw_to, "expected 'to' in catchret") || 5961 ParseTypeAndBasicBlock(BB, PFS)) 5962 return true; 5963 5964 Inst = CatchReturnInst::Create(CatchPad, BB); 5965 return false; 5966 } 5967 5968 /// ParseCatchSwitch 5969 /// ::= 'catchswitch' within Parent 5970 bool LLParser::ParseCatchSwitch(Instruction *&Inst, PerFunctionState &PFS) { 5971 Value *ParentPad; 5972 5973 if (ParseToken(lltok::kw_within, "expected 'within' after catchswitch")) 5974 return true; 5975 5976 if (Lex.getKind() != lltok::kw_none && Lex.getKind() != lltok::LocalVar && 5977 Lex.getKind() != lltok::LocalVarID) 5978 return TokError("expected scope value for catchswitch"); 5979 5980 if (ParseValue(Type::getTokenTy(Context), ParentPad, PFS)) 5981 return true; 5982 5983 if (ParseToken(lltok::lsquare, "expected '[' with catchswitch labels")) 5984 return true; 5985 5986 SmallVector<BasicBlock *, 32> Table; 5987 do { 5988 BasicBlock *DestBB; 5989 if (ParseTypeAndBasicBlock(DestBB, PFS)) 5990 return true; 5991 Table.push_back(DestBB); 5992 } while (EatIfPresent(lltok::comma)); 5993 5994 if (ParseToken(lltok::rsquare, "expected ']' after catchswitch labels")) 5995 return true; 5996 5997 if (ParseToken(lltok::kw_unwind, 5998 "expected 'unwind' after catchswitch scope")) 5999 return true; 6000 6001 BasicBlock *UnwindBB = nullptr; 6002 if (EatIfPresent(lltok::kw_to)) { 6003 if (ParseToken(lltok::kw_caller, "expected 'caller' in catchswitch")) 6004 return true; 6005 } else { 6006 if (ParseTypeAndBasicBlock(UnwindBB, PFS)) 6007 return true; 6008 } 6009 6010 auto *CatchSwitch = 6011 CatchSwitchInst::Create(ParentPad, UnwindBB, Table.size()); 6012 for (BasicBlock *DestBB : Table) 6013 CatchSwitch->addHandler(DestBB); 6014 Inst = CatchSwitch; 6015 return false; 6016 } 6017 6018 /// ParseCatchPad 6019 /// ::= 'catchpad' ParamList 'to' TypeAndValue 'unwind' TypeAndValue 6020 bool LLParser::ParseCatchPad(Instruction *&Inst, PerFunctionState &PFS) { 6021 Value *CatchSwitch = nullptr; 6022 6023 if (ParseToken(lltok::kw_within, "expected 'within' after catchpad")) 6024 return true; 6025 6026 if (Lex.getKind() != lltok::LocalVar && Lex.getKind() != lltok::LocalVarID) 6027 return TokError("expected scope value for catchpad"); 6028 6029 if (ParseValue(Type::getTokenTy(Context), CatchSwitch, PFS)) 6030 return true; 6031 6032 SmallVector<Value *, 8> Args; 6033 if (ParseExceptionArgs(Args, PFS)) 6034 return true; 6035 6036 Inst = CatchPadInst::Create(CatchSwitch, Args); 6037 return false; 6038 } 6039 6040 /// ParseCleanupPad 6041 /// ::= 'cleanuppad' within Parent ParamList 6042 bool LLParser::ParseCleanupPad(Instruction *&Inst, PerFunctionState &PFS) { 6043 Value *ParentPad = nullptr; 6044 6045 if (ParseToken(lltok::kw_within, "expected 'within' after cleanuppad")) 6046 return true; 6047 6048 if (Lex.getKind() != lltok::kw_none && Lex.getKind() != lltok::LocalVar && 6049 Lex.getKind() != lltok::LocalVarID) 6050 return TokError("expected scope value for cleanuppad"); 6051 6052 if (ParseValue(Type::getTokenTy(Context), ParentPad, PFS)) 6053 return true; 6054 6055 SmallVector<Value *, 8> Args; 6056 if (ParseExceptionArgs(Args, PFS)) 6057 return true; 6058 6059 Inst = CleanupPadInst::Create(ParentPad, Args); 6060 return false; 6061 } 6062 6063 //===----------------------------------------------------------------------===// 6064 // Binary Operators. 6065 //===----------------------------------------------------------------------===// 6066 6067 /// ParseArithmetic 6068 /// ::= ArithmeticOps TypeAndValue ',' Value 6069 /// 6070 /// If OperandType is 0, then any FP or integer operand is allowed. If it is 1, 6071 /// then any integer operand is allowed, if it is 2, any fp operand is allowed. 6072 bool LLParser::ParseArithmetic(Instruction *&Inst, PerFunctionState &PFS, 6073 unsigned Opc, unsigned OperandType) { 6074 LocTy Loc; Value *LHS, *RHS; 6075 if (ParseTypeAndValue(LHS, Loc, PFS) || 6076 ParseToken(lltok::comma, "expected ',' in arithmetic operation") || 6077 ParseValue(LHS->getType(), RHS, PFS)) 6078 return true; 6079 6080 bool Valid; 6081 switch (OperandType) { 6082 default: llvm_unreachable("Unknown operand type!"); 6083 case 0: // int or FP. 6084 Valid = LHS->getType()->isIntOrIntVectorTy() || 6085 LHS->getType()->isFPOrFPVectorTy(); 6086 break; 6087 case 1: Valid = LHS->getType()->isIntOrIntVectorTy(); break; 6088 case 2: Valid = LHS->getType()->isFPOrFPVectorTy(); break; 6089 } 6090 6091 if (!Valid) 6092 return Error(Loc, "invalid operand type for instruction"); 6093 6094 Inst = BinaryOperator::Create((Instruction::BinaryOps)Opc, LHS, RHS); 6095 return false; 6096 } 6097 6098 /// ParseLogical 6099 /// ::= ArithmeticOps TypeAndValue ',' Value { 6100 bool LLParser::ParseLogical(Instruction *&Inst, PerFunctionState &PFS, 6101 unsigned Opc) { 6102 LocTy Loc; Value *LHS, *RHS; 6103 if (ParseTypeAndValue(LHS, Loc, PFS) || 6104 ParseToken(lltok::comma, "expected ',' in logical operation") || 6105 ParseValue(LHS->getType(), RHS, PFS)) 6106 return true; 6107 6108 if (!LHS->getType()->isIntOrIntVectorTy()) 6109 return Error(Loc,"instruction requires integer or integer vector operands"); 6110 6111 Inst = BinaryOperator::Create((Instruction::BinaryOps)Opc, LHS, RHS); 6112 return false; 6113 } 6114 6115 /// ParseCompare 6116 /// ::= 'icmp' IPredicates TypeAndValue ',' Value 6117 /// ::= 'fcmp' FPredicates TypeAndValue ',' Value 6118 bool LLParser::ParseCompare(Instruction *&Inst, PerFunctionState &PFS, 6119 unsigned Opc) { 6120 // Parse the integer/fp comparison predicate. 6121 LocTy Loc; 6122 unsigned Pred; 6123 Value *LHS, *RHS; 6124 if (ParseCmpPredicate(Pred, Opc) || 6125 ParseTypeAndValue(LHS, Loc, PFS) || 6126 ParseToken(lltok::comma, "expected ',' after compare value") || 6127 ParseValue(LHS->getType(), RHS, PFS)) 6128 return true; 6129 6130 if (Opc == Instruction::FCmp) { 6131 if (!LHS->getType()->isFPOrFPVectorTy()) 6132 return Error(Loc, "fcmp requires floating point operands"); 6133 Inst = new FCmpInst(CmpInst::Predicate(Pred), LHS, RHS); 6134 } else { 6135 assert(Opc == Instruction::ICmp && "Unknown opcode for CmpInst!"); 6136 if (!LHS->getType()->isIntOrIntVectorTy() && 6137 !LHS->getType()->isPtrOrPtrVectorTy()) 6138 return Error(Loc, "icmp requires integer operands"); 6139 Inst = new ICmpInst(CmpInst::Predicate(Pred), LHS, RHS); 6140 } 6141 return false; 6142 } 6143 6144 //===----------------------------------------------------------------------===// 6145 // Other Instructions. 6146 //===----------------------------------------------------------------------===// 6147 6148 6149 /// ParseCast 6150 /// ::= CastOpc TypeAndValue 'to' Type 6151 bool LLParser::ParseCast(Instruction *&Inst, PerFunctionState &PFS, 6152 unsigned Opc) { 6153 LocTy Loc; 6154 Value *Op; 6155 Type *DestTy = nullptr; 6156 if (ParseTypeAndValue(Op, Loc, PFS) || 6157 ParseToken(lltok::kw_to, "expected 'to' after cast value") || 6158 ParseType(DestTy)) 6159 return true; 6160 6161 if (!CastInst::castIsValid((Instruction::CastOps)Opc, Op, DestTy)) { 6162 CastInst::castIsValid((Instruction::CastOps)Opc, Op, DestTy); 6163 return Error(Loc, "invalid cast opcode for cast from '" + 6164 getTypeString(Op->getType()) + "' to '" + 6165 getTypeString(DestTy) + "'"); 6166 } 6167 Inst = CastInst::Create((Instruction::CastOps)Opc, Op, DestTy); 6168 return false; 6169 } 6170 6171 /// ParseSelect 6172 /// ::= 'select' TypeAndValue ',' TypeAndValue ',' TypeAndValue 6173 bool LLParser::ParseSelect(Instruction *&Inst, PerFunctionState &PFS) { 6174 LocTy Loc; 6175 Value *Op0, *Op1, *Op2; 6176 if (ParseTypeAndValue(Op0, Loc, PFS) || 6177 ParseToken(lltok::comma, "expected ',' after select condition") || 6178 ParseTypeAndValue(Op1, PFS) || 6179 ParseToken(lltok::comma, "expected ',' after select value") || 6180 ParseTypeAndValue(Op2, PFS)) 6181 return true; 6182 6183 if (const char *Reason = SelectInst::areInvalidOperands(Op0, Op1, Op2)) 6184 return Error(Loc, Reason); 6185 6186 Inst = SelectInst::Create(Op0, Op1, Op2); 6187 return false; 6188 } 6189 6190 /// ParseVA_Arg 6191 /// ::= 'va_arg' TypeAndValue ',' Type 6192 bool LLParser::ParseVA_Arg(Instruction *&Inst, PerFunctionState &PFS) { 6193 Value *Op; 6194 Type *EltTy = nullptr; 6195 LocTy TypeLoc; 6196 if (ParseTypeAndValue(Op, PFS) || 6197 ParseToken(lltok::comma, "expected ',' after vaarg operand") || 6198 ParseType(EltTy, TypeLoc)) 6199 return true; 6200 6201 if (!EltTy->isFirstClassType()) 6202 return Error(TypeLoc, "va_arg requires operand with first class type"); 6203 6204 Inst = new VAArgInst(Op, EltTy); 6205 return false; 6206 } 6207 6208 /// ParseExtractElement 6209 /// ::= 'extractelement' TypeAndValue ',' TypeAndValue 6210 bool LLParser::ParseExtractElement(Instruction *&Inst, PerFunctionState &PFS) { 6211 LocTy Loc; 6212 Value *Op0, *Op1; 6213 if (ParseTypeAndValue(Op0, Loc, PFS) || 6214 ParseToken(lltok::comma, "expected ',' after extract value") || 6215 ParseTypeAndValue(Op1, PFS)) 6216 return true; 6217 6218 if (!ExtractElementInst::isValidOperands(Op0, Op1)) 6219 return Error(Loc, "invalid extractelement operands"); 6220 6221 Inst = ExtractElementInst::Create(Op0, Op1); 6222 return false; 6223 } 6224 6225 /// ParseInsertElement 6226 /// ::= 'insertelement' TypeAndValue ',' TypeAndValue ',' TypeAndValue 6227 bool LLParser::ParseInsertElement(Instruction *&Inst, PerFunctionState &PFS) { 6228 LocTy Loc; 6229 Value *Op0, *Op1, *Op2; 6230 if (ParseTypeAndValue(Op0, Loc, PFS) || 6231 ParseToken(lltok::comma, "expected ',' after insertelement value") || 6232 ParseTypeAndValue(Op1, PFS) || 6233 ParseToken(lltok::comma, "expected ',' after insertelement value") || 6234 ParseTypeAndValue(Op2, PFS)) 6235 return true; 6236 6237 if (!InsertElementInst::isValidOperands(Op0, Op1, Op2)) 6238 return Error(Loc, "invalid insertelement operands"); 6239 6240 Inst = InsertElementInst::Create(Op0, Op1, Op2); 6241 return false; 6242 } 6243 6244 /// ParseShuffleVector 6245 /// ::= 'shufflevector' TypeAndValue ',' TypeAndValue ',' TypeAndValue 6246 bool LLParser::ParseShuffleVector(Instruction *&Inst, PerFunctionState &PFS) { 6247 LocTy Loc; 6248 Value *Op0, *Op1, *Op2; 6249 if (ParseTypeAndValue(Op0, Loc, PFS) || 6250 ParseToken(lltok::comma, "expected ',' after shuffle mask") || 6251 ParseTypeAndValue(Op1, PFS) || 6252 ParseToken(lltok::comma, "expected ',' after shuffle value") || 6253 ParseTypeAndValue(Op2, PFS)) 6254 return true; 6255 6256 if (!ShuffleVectorInst::isValidOperands(Op0, Op1, Op2)) 6257 return Error(Loc, "invalid shufflevector operands"); 6258 6259 Inst = new ShuffleVectorInst(Op0, Op1, Op2); 6260 return false; 6261 } 6262 6263 /// ParsePHI 6264 /// ::= 'phi' Type '[' Value ',' Value ']' (',' '[' Value ',' Value ']')* 6265 int LLParser::ParsePHI(Instruction *&Inst, PerFunctionState &PFS) { 6266 Type *Ty = nullptr; LocTy TypeLoc; 6267 Value *Op0, *Op1; 6268 6269 if (ParseType(Ty, TypeLoc) || 6270 ParseToken(lltok::lsquare, "expected '[' in phi value list") || 6271 ParseValue(Ty, Op0, PFS) || 6272 ParseToken(lltok::comma, "expected ',' after insertelement value") || 6273 ParseValue(Type::getLabelTy(Context), Op1, PFS) || 6274 ParseToken(lltok::rsquare, "expected ']' in phi value list")) 6275 return true; 6276 6277 bool AteExtraComma = false; 6278 SmallVector<std::pair<Value*, BasicBlock*>, 16> PHIVals; 6279 6280 while (true) { 6281 PHIVals.push_back(std::make_pair(Op0, cast<BasicBlock>(Op1))); 6282 6283 if (!EatIfPresent(lltok::comma)) 6284 break; 6285 6286 if (Lex.getKind() == lltok::MetadataVar) { 6287 AteExtraComma = true; 6288 break; 6289 } 6290 6291 if (ParseToken(lltok::lsquare, "expected '[' in phi value list") || 6292 ParseValue(Ty, Op0, PFS) || 6293 ParseToken(lltok::comma, "expected ',' after insertelement value") || 6294 ParseValue(Type::getLabelTy(Context), Op1, PFS) || 6295 ParseToken(lltok::rsquare, "expected ']' in phi value list")) 6296 return true; 6297 } 6298 6299 if (!Ty->isFirstClassType()) 6300 return Error(TypeLoc, "phi node must have first class type"); 6301 6302 PHINode *PN = PHINode::Create(Ty, PHIVals.size()); 6303 for (unsigned i = 0, e = PHIVals.size(); i != e; ++i) 6304 PN->addIncoming(PHIVals[i].first, PHIVals[i].second); 6305 Inst = PN; 6306 return AteExtraComma ? InstExtraComma : InstNormal; 6307 } 6308 6309 /// ParseLandingPad 6310 /// ::= 'landingpad' Type 'personality' TypeAndValue 'cleanup'? Clause+ 6311 /// Clause 6312 /// ::= 'catch' TypeAndValue 6313 /// ::= 'filter' 6314 /// ::= 'filter' TypeAndValue ( ',' TypeAndValue )* 6315 bool LLParser::ParseLandingPad(Instruction *&Inst, PerFunctionState &PFS) { 6316 Type *Ty = nullptr; LocTy TyLoc; 6317 6318 if (ParseType(Ty, TyLoc)) 6319 return true; 6320 6321 std::unique_ptr<LandingPadInst> LP(LandingPadInst::Create(Ty, 0)); 6322 LP->setCleanup(EatIfPresent(lltok::kw_cleanup)); 6323 6324 while (Lex.getKind() == lltok::kw_catch || Lex.getKind() == lltok::kw_filter){ 6325 LandingPadInst::ClauseType CT; 6326 if (EatIfPresent(lltok::kw_catch)) 6327 CT = LandingPadInst::Catch; 6328 else if (EatIfPresent(lltok::kw_filter)) 6329 CT = LandingPadInst::Filter; 6330 else 6331 return TokError("expected 'catch' or 'filter' clause type"); 6332 6333 Value *V; 6334 LocTy VLoc; 6335 if (ParseTypeAndValue(V, VLoc, PFS)) 6336 return true; 6337 6338 // A 'catch' type expects a non-array constant. A filter clause expects an 6339 // array constant. 6340 if (CT == LandingPadInst::Catch) { 6341 if (isa<ArrayType>(V->getType())) 6342 Error(VLoc, "'catch' clause has an invalid type"); 6343 } else { 6344 if (!isa<ArrayType>(V->getType())) 6345 Error(VLoc, "'filter' clause has an invalid type"); 6346 } 6347 6348 Constant *CV = dyn_cast<Constant>(V); 6349 if (!CV) 6350 return Error(VLoc, "clause argument must be a constant"); 6351 LP->addClause(CV); 6352 } 6353 6354 Inst = LP.release(); 6355 return false; 6356 } 6357 6358 /// ParseCall 6359 /// ::= 'call' OptionalFastMathFlags OptionalCallingConv 6360 /// OptionalAttrs Type Value ParameterList OptionalAttrs 6361 /// ::= 'tail' 'call' OptionalFastMathFlags OptionalCallingConv 6362 /// OptionalAttrs Type Value ParameterList OptionalAttrs 6363 /// ::= 'musttail' 'call' OptionalFastMathFlags OptionalCallingConv 6364 /// OptionalAttrs Type Value ParameterList OptionalAttrs 6365 /// ::= 'notail' 'call' OptionalFastMathFlags OptionalCallingConv 6366 /// OptionalAttrs Type Value ParameterList OptionalAttrs 6367 bool LLParser::ParseCall(Instruction *&Inst, PerFunctionState &PFS, 6368 CallInst::TailCallKind TCK) { 6369 AttrBuilder RetAttrs, FnAttrs; 6370 std::vector<unsigned> FwdRefAttrGrps; 6371 LocTy BuiltinLoc; 6372 unsigned CallAddrSpace; 6373 unsigned CC; 6374 Type *RetType = nullptr; 6375 LocTy RetTypeLoc; 6376 ValID CalleeID; 6377 SmallVector<ParamInfo, 16> ArgList; 6378 SmallVector<OperandBundleDef, 2> BundleList; 6379 LocTy CallLoc = Lex.getLoc(); 6380 6381 if (TCK != CallInst::TCK_None && 6382 ParseToken(lltok::kw_call, 6383 "expected 'tail call', 'musttail call', or 'notail call'")) 6384 return true; 6385 6386 FastMathFlags FMF = EatFastMathFlagsIfPresent(); 6387 6388 if (ParseOptionalCallingConv(CC) || ParseOptionalReturnAttrs(RetAttrs) || 6389 ParseOptionalProgramAddrSpace(CallAddrSpace) || 6390 ParseType(RetType, RetTypeLoc, true /*void allowed*/) || 6391 ParseValID(CalleeID) || 6392 ParseParameterList(ArgList, PFS, TCK == CallInst::TCK_MustTail, 6393 PFS.getFunction().isVarArg()) || 6394 ParseFnAttributeValuePairs(FnAttrs, FwdRefAttrGrps, false, BuiltinLoc) || 6395 ParseOptionalOperandBundles(BundleList, PFS)) 6396 return true; 6397 6398 if (FMF.any() && !RetType->isFPOrFPVectorTy()) 6399 return Error(CallLoc, "fast-math-flags specified for call without " 6400 "floating-point scalar or vector return type"); 6401 6402 // If RetType is a non-function pointer type, then this is the short syntax 6403 // for the call, which means that RetType is just the return type. Infer the 6404 // rest of the function argument types from the arguments that are present. 6405 FunctionType *Ty = dyn_cast<FunctionType>(RetType); 6406 if (!Ty) { 6407 // Pull out the types of all of the arguments... 6408 std::vector<Type*> ParamTypes; 6409 for (unsigned i = 0, e = ArgList.size(); i != e; ++i) 6410 ParamTypes.push_back(ArgList[i].V->getType()); 6411 6412 if (!FunctionType::isValidReturnType(RetType)) 6413 return Error(RetTypeLoc, "Invalid result type for LLVM function"); 6414 6415 Ty = FunctionType::get(RetType, ParamTypes, false); 6416 } 6417 6418 CalleeID.FTy = Ty; 6419 6420 // Look up the callee. 6421 Value *Callee; 6422 if (ConvertValIDToValue(PointerType::get(Ty, CallAddrSpace), CalleeID, Callee, 6423 &PFS, /*IsCall=*/true)) 6424 return true; 6425 6426 // Set up the Attribute for the function. 6427 SmallVector<AttributeSet, 8> Attrs; 6428 6429 SmallVector<Value*, 8> Args; 6430 6431 // Loop through FunctionType's arguments and ensure they are specified 6432 // correctly. Also, gather any parameter attributes. 6433 FunctionType::param_iterator I = Ty->param_begin(); 6434 FunctionType::param_iterator E = Ty->param_end(); 6435 for (unsigned i = 0, e = ArgList.size(); i != e; ++i) { 6436 Type *ExpectedTy = nullptr; 6437 if (I != E) { 6438 ExpectedTy = *I++; 6439 } else if (!Ty->isVarArg()) { 6440 return Error(ArgList[i].Loc, "too many arguments specified"); 6441 } 6442 6443 if (ExpectedTy && ExpectedTy != ArgList[i].V->getType()) 6444 return Error(ArgList[i].Loc, "argument is not of expected type '" + 6445 getTypeString(ExpectedTy) + "'"); 6446 Args.push_back(ArgList[i].V); 6447 Attrs.push_back(ArgList[i].Attrs); 6448 } 6449 6450 if (I != E) 6451 return Error(CallLoc, "not enough parameters specified for call"); 6452 6453 if (FnAttrs.hasAlignmentAttr()) 6454 return Error(CallLoc, "call instructions may not have an alignment"); 6455 6456 // Finish off the Attribute and check them 6457 AttributeList PAL = 6458 AttributeList::get(Context, AttributeSet::get(Context, FnAttrs), 6459 AttributeSet::get(Context, RetAttrs), Attrs); 6460 6461 CallInst *CI = CallInst::Create(Ty, Callee, Args, BundleList); 6462 CI->setTailCallKind(TCK); 6463 CI->setCallingConv(CC); 6464 if (FMF.any()) 6465 CI->setFastMathFlags(FMF); 6466 CI->setAttributes(PAL); 6467 ForwardRefAttrGroups[CI] = FwdRefAttrGrps; 6468 Inst = CI; 6469 return false; 6470 } 6471 6472 //===----------------------------------------------------------------------===// 6473 // Memory Instructions. 6474 //===----------------------------------------------------------------------===// 6475 6476 /// ParseAlloc 6477 /// ::= 'alloca' 'inalloca'? 'swifterror'? Type (',' TypeAndValue)? 6478 /// (',' 'align' i32)? (',', 'addrspace(n))? 6479 int LLParser::ParseAlloc(Instruction *&Inst, PerFunctionState &PFS) { 6480 Value *Size = nullptr; 6481 LocTy SizeLoc, TyLoc, ASLoc; 6482 unsigned Alignment = 0; 6483 unsigned AddrSpace = 0; 6484 Type *Ty = nullptr; 6485 6486 bool IsInAlloca = EatIfPresent(lltok::kw_inalloca); 6487 bool IsSwiftError = EatIfPresent(lltok::kw_swifterror); 6488 6489 if (ParseType(Ty, TyLoc)) return true; 6490 6491 if (Ty->isFunctionTy() || !PointerType::isValidElementType(Ty)) 6492 return Error(TyLoc, "invalid type for alloca"); 6493 6494 bool AteExtraComma = false; 6495 if (EatIfPresent(lltok::comma)) { 6496 if (Lex.getKind() == lltok::kw_align) { 6497 if (ParseOptionalAlignment(Alignment)) 6498 return true; 6499 if (ParseOptionalCommaAddrSpace(AddrSpace, ASLoc, AteExtraComma)) 6500 return true; 6501 } else if (Lex.getKind() == lltok::kw_addrspace) { 6502 ASLoc = Lex.getLoc(); 6503 if (ParseOptionalAddrSpace(AddrSpace)) 6504 return true; 6505 } else if (Lex.getKind() == lltok::MetadataVar) { 6506 AteExtraComma = true; 6507 } else { 6508 if (ParseTypeAndValue(Size, SizeLoc, PFS)) 6509 return true; 6510 if (EatIfPresent(lltok::comma)) { 6511 if (Lex.getKind() == lltok::kw_align) { 6512 if (ParseOptionalAlignment(Alignment)) 6513 return true; 6514 if (ParseOptionalCommaAddrSpace(AddrSpace, ASLoc, AteExtraComma)) 6515 return true; 6516 } else if (Lex.getKind() == lltok::kw_addrspace) { 6517 ASLoc = Lex.getLoc(); 6518 if (ParseOptionalAddrSpace(AddrSpace)) 6519 return true; 6520 } else if (Lex.getKind() == lltok::MetadataVar) { 6521 AteExtraComma = true; 6522 } 6523 } 6524 } 6525 } 6526 6527 if (Size && !Size->getType()->isIntegerTy()) 6528 return Error(SizeLoc, "element count must have integer type"); 6529 6530 AllocaInst *AI = new AllocaInst(Ty, AddrSpace, Size, Alignment); 6531 AI->setUsedWithInAlloca(IsInAlloca); 6532 AI->setSwiftError(IsSwiftError); 6533 Inst = AI; 6534 return AteExtraComma ? InstExtraComma : InstNormal; 6535 } 6536 6537 /// ParseLoad 6538 /// ::= 'load' 'volatile'? TypeAndValue (',' 'align' i32)? 6539 /// ::= 'load' 'atomic' 'volatile'? TypeAndValue 6540 /// 'singlethread'? AtomicOrdering (',' 'align' i32)? 6541 int LLParser::ParseLoad(Instruction *&Inst, PerFunctionState &PFS) { 6542 Value *Val; LocTy Loc; 6543 unsigned Alignment = 0; 6544 bool AteExtraComma = false; 6545 bool isAtomic = false; 6546 AtomicOrdering Ordering = AtomicOrdering::NotAtomic; 6547 SyncScope::ID SSID = SyncScope::System; 6548 6549 if (Lex.getKind() == lltok::kw_atomic) { 6550 isAtomic = true; 6551 Lex.Lex(); 6552 } 6553 6554 bool isVolatile = false; 6555 if (Lex.getKind() == lltok::kw_volatile) { 6556 isVolatile = true; 6557 Lex.Lex(); 6558 } 6559 6560 Type *Ty; 6561 LocTy ExplicitTypeLoc = Lex.getLoc(); 6562 if (ParseType(Ty) || 6563 ParseToken(lltok::comma, "expected comma after load's type") || 6564 ParseTypeAndValue(Val, Loc, PFS) || 6565 ParseScopeAndOrdering(isAtomic, SSID, Ordering) || 6566 ParseOptionalCommaAlign(Alignment, AteExtraComma)) 6567 return true; 6568 6569 if (!Val->getType()->isPointerTy() || !Ty->isFirstClassType()) 6570 return Error(Loc, "load operand must be a pointer to a first class type"); 6571 if (isAtomic && !Alignment) 6572 return Error(Loc, "atomic load must have explicit non-zero alignment"); 6573 if (Ordering == AtomicOrdering::Release || 6574 Ordering == AtomicOrdering::AcquireRelease) 6575 return Error(Loc, "atomic load cannot use Release ordering"); 6576 6577 if (Ty != cast<PointerType>(Val->getType())->getElementType()) 6578 return Error(ExplicitTypeLoc, 6579 "explicit pointee type doesn't match operand's pointee type"); 6580 6581 Inst = new LoadInst(Ty, Val, "", isVolatile, Alignment, Ordering, SSID); 6582 return AteExtraComma ? InstExtraComma : InstNormal; 6583 } 6584 6585 /// ParseStore 6586 6587 /// ::= 'store' 'volatile'? TypeAndValue ',' TypeAndValue (',' 'align' i32)? 6588 /// ::= 'store' 'atomic' 'volatile'? TypeAndValue ',' TypeAndValue 6589 /// 'singlethread'? AtomicOrdering (',' 'align' i32)? 6590 int LLParser::ParseStore(Instruction *&Inst, PerFunctionState &PFS) { 6591 Value *Val, *Ptr; LocTy Loc, PtrLoc; 6592 unsigned Alignment = 0; 6593 bool AteExtraComma = false; 6594 bool isAtomic = false; 6595 AtomicOrdering Ordering = AtomicOrdering::NotAtomic; 6596 SyncScope::ID SSID = SyncScope::System; 6597 6598 if (Lex.getKind() == lltok::kw_atomic) { 6599 isAtomic = true; 6600 Lex.Lex(); 6601 } 6602 6603 bool isVolatile = false; 6604 if (Lex.getKind() == lltok::kw_volatile) { 6605 isVolatile = true; 6606 Lex.Lex(); 6607 } 6608 6609 if (ParseTypeAndValue(Val, Loc, PFS) || 6610 ParseToken(lltok::comma, "expected ',' after store operand") || 6611 ParseTypeAndValue(Ptr, PtrLoc, PFS) || 6612 ParseScopeAndOrdering(isAtomic, SSID, Ordering) || 6613 ParseOptionalCommaAlign(Alignment, AteExtraComma)) 6614 return true; 6615 6616 if (!Ptr->getType()->isPointerTy()) 6617 return Error(PtrLoc, "store operand must be a pointer"); 6618 if (!Val->getType()->isFirstClassType()) 6619 return Error(Loc, "store operand must be a first class value"); 6620 if (cast<PointerType>(Ptr->getType())->getElementType() != Val->getType()) 6621 return Error(Loc, "stored value and pointer type do not match"); 6622 if (isAtomic && !Alignment) 6623 return Error(Loc, "atomic store must have explicit non-zero alignment"); 6624 if (Ordering == AtomicOrdering::Acquire || 6625 Ordering == AtomicOrdering::AcquireRelease) 6626 return Error(Loc, "atomic store cannot use Acquire ordering"); 6627 6628 Inst = new StoreInst(Val, Ptr, isVolatile, Alignment, Ordering, SSID); 6629 return AteExtraComma ? InstExtraComma : InstNormal; 6630 } 6631 6632 /// ParseCmpXchg 6633 /// ::= 'cmpxchg' 'weak'? 'volatile'? TypeAndValue ',' TypeAndValue ',' 6634 /// TypeAndValue 'singlethread'? AtomicOrdering AtomicOrdering 6635 int LLParser::ParseCmpXchg(Instruction *&Inst, PerFunctionState &PFS) { 6636 Value *Ptr, *Cmp, *New; LocTy PtrLoc, CmpLoc, NewLoc; 6637 bool AteExtraComma = false; 6638 AtomicOrdering SuccessOrdering = AtomicOrdering::NotAtomic; 6639 AtomicOrdering FailureOrdering = AtomicOrdering::NotAtomic; 6640 SyncScope::ID SSID = SyncScope::System; 6641 bool isVolatile = false; 6642 bool isWeak = false; 6643 6644 if (EatIfPresent(lltok::kw_weak)) 6645 isWeak = true; 6646 6647 if (EatIfPresent(lltok::kw_volatile)) 6648 isVolatile = true; 6649 6650 if (ParseTypeAndValue(Ptr, PtrLoc, PFS) || 6651 ParseToken(lltok::comma, "expected ',' after cmpxchg address") || 6652 ParseTypeAndValue(Cmp, CmpLoc, PFS) || 6653 ParseToken(lltok::comma, "expected ',' after cmpxchg cmp operand") || 6654 ParseTypeAndValue(New, NewLoc, PFS) || 6655 ParseScopeAndOrdering(true /*Always atomic*/, SSID, SuccessOrdering) || 6656 ParseOrdering(FailureOrdering)) 6657 return true; 6658 6659 if (SuccessOrdering == AtomicOrdering::Unordered || 6660 FailureOrdering == AtomicOrdering::Unordered) 6661 return TokError("cmpxchg cannot be unordered"); 6662 if (isStrongerThan(FailureOrdering, SuccessOrdering)) 6663 return TokError("cmpxchg failure argument shall be no stronger than the " 6664 "success argument"); 6665 if (FailureOrdering == AtomicOrdering::Release || 6666 FailureOrdering == AtomicOrdering::AcquireRelease) 6667 return TokError( 6668 "cmpxchg failure ordering cannot include release semantics"); 6669 if (!Ptr->getType()->isPointerTy()) 6670 return Error(PtrLoc, "cmpxchg operand must be a pointer"); 6671 if (cast<PointerType>(Ptr->getType())->getElementType() != Cmp->getType()) 6672 return Error(CmpLoc, "compare value and pointer type do not match"); 6673 if (cast<PointerType>(Ptr->getType())->getElementType() != New->getType()) 6674 return Error(NewLoc, "new value and pointer type do not match"); 6675 if (!New->getType()->isFirstClassType()) 6676 return Error(NewLoc, "cmpxchg operand must be a first class value"); 6677 AtomicCmpXchgInst *CXI = new AtomicCmpXchgInst( 6678 Ptr, Cmp, New, SuccessOrdering, FailureOrdering, SSID); 6679 CXI->setVolatile(isVolatile); 6680 CXI->setWeak(isWeak); 6681 Inst = CXI; 6682 return AteExtraComma ? InstExtraComma : InstNormal; 6683 } 6684 6685 /// ParseAtomicRMW 6686 /// ::= 'atomicrmw' 'volatile'? BinOp TypeAndValue ',' TypeAndValue 6687 /// 'singlethread'? AtomicOrdering 6688 int LLParser::ParseAtomicRMW(Instruction *&Inst, PerFunctionState &PFS) { 6689 Value *Ptr, *Val; LocTy PtrLoc, ValLoc; 6690 bool AteExtraComma = false; 6691 AtomicOrdering Ordering = AtomicOrdering::NotAtomic; 6692 SyncScope::ID SSID = SyncScope::System; 6693 bool isVolatile = false; 6694 AtomicRMWInst::BinOp Operation; 6695 6696 if (EatIfPresent(lltok::kw_volatile)) 6697 isVolatile = true; 6698 6699 switch (Lex.getKind()) { 6700 default: return TokError("expected binary operation in atomicrmw"); 6701 case lltok::kw_xchg: Operation = AtomicRMWInst::Xchg; break; 6702 case lltok::kw_add: Operation = AtomicRMWInst::Add; break; 6703 case lltok::kw_sub: Operation = AtomicRMWInst::Sub; break; 6704 case lltok::kw_and: Operation = AtomicRMWInst::And; break; 6705 case lltok::kw_nand: Operation = AtomicRMWInst::Nand; break; 6706 case lltok::kw_or: Operation = AtomicRMWInst::Or; break; 6707 case lltok::kw_xor: Operation = AtomicRMWInst::Xor; break; 6708 case lltok::kw_max: Operation = AtomicRMWInst::Max; break; 6709 case lltok::kw_min: Operation = AtomicRMWInst::Min; break; 6710 case lltok::kw_umax: Operation = AtomicRMWInst::UMax; break; 6711 case lltok::kw_umin: Operation = AtomicRMWInst::UMin; break; 6712 } 6713 Lex.Lex(); // Eat the operation. 6714 6715 if (ParseTypeAndValue(Ptr, PtrLoc, PFS) || 6716 ParseToken(lltok::comma, "expected ',' after atomicrmw address") || 6717 ParseTypeAndValue(Val, ValLoc, PFS) || 6718 ParseScopeAndOrdering(true /*Always atomic*/, SSID, Ordering)) 6719 return true; 6720 6721 if (Ordering == AtomicOrdering::Unordered) 6722 return TokError("atomicrmw cannot be unordered"); 6723 if (!Ptr->getType()->isPointerTy()) 6724 return Error(PtrLoc, "atomicrmw operand must be a pointer"); 6725 if (cast<PointerType>(Ptr->getType())->getElementType() != Val->getType()) 6726 return Error(ValLoc, "atomicrmw value and pointer type do not match"); 6727 if (!Val->getType()->isIntegerTy()) 6728 return Error(ValLoc, "atomicrmw operand must be an integer"); 6729 unsigned Size = Val->getType()->getPrimitiveSizeInBits(); 6730 if (Size < 8 || (Size & (Size - 1))) 6731 return Error(ValLoc, "atomicrmw operand must be power-of-two byte-sized" 6732 " integer"); 6733 6734 AtomicRMWInst *RMWI = 6735 new AtomicRMWInst(Operation, Ptr, Val, Ordering, SSID); 6736 RMWI->setVolatile(isVolatile); 6737 Inst = RMWI; 6738 return AteExtraComma ? InstExtraComma : InstNormal; 6739 } 6740 6741 /// ParseFence 6742 /// ::= 'fence' 'singlethread'? AtomicOrdering 6743 int LLParser::ParseFence(Instruction *&Inst, PerFunctionState &PFS) { 6744 AtomicOrdering Ordering = AtomicOrdering::NotAtomic; 6745 SyncScope::ID SSID = SyncScope::System; 6746 if (ParseScopeAndOrdering(true /*Always atomic*/, SSID, Ordering)) 6747 return true; 6748 6749 if (Ordering == AtomicOrdering::Unordered) 6750 return TokError("fence cannot be unordered"); 6751 if (Ordering == AtomicOrdering::Monotonic) 6752 return TokError("fence cannot be monotonic"); 6753 6754 Inst = new FenceInst(Context, Ordering, SSID); 6755 return InstNormal; 6756 } 6757 6758 /// ParseGetElementPtr 6759 /// ::= 'getelementptr' 'inbounds'? TypeAndValue (',' TypeAndValue)* 6760 int LLParser::ParseGetElementPtr(Instruction *&Inst, PerFunctionState &PFS) { 6761 Value *Ptr = nullptr; 6762 Value *Val = nullptr; 6763 LocTy Loc, EltLoc; 6764 6765 bool InBounds = EatIfPresent(lltok::kw_inbounds); 6766 6767 Type *Ty = nullptr; 6768 LocTy ExplicitTypeLoc = Lex.getLoc(); 6769 if (ParseType(Ty) || 6770 ParseToken(lltok::comma, "expected comma after getelementptr's type") || 6771 ParseTypeAndValue(Ptr, Loc, PFS)) 6772 return true; 6773 6774 Type *BaseType = Ptr->getType(); 6775 PointerType *BasePointerType = dyn_cast<PointerType>(BaseType->getScalarType()); 6776 if (!BasePointerType) 6777 return Error(Loc, "base of getelementptr must be a pointer"); 6778 6779 if (Ty != BasePointerType->getElementType()) 6780 return Error(ExplicitTypeLoc, 6781 "explicit pointee type doesn't match operand's pointee type"); 6782 6783 SmallVector<Value*, 16> Indices; 6784 bool AteExtraComma = false; 6785 // GEP returns a vector of pointers if at least one of parameters is a vector. 6786 // All vector parameters should have the same vector width. 6787 unsigned GEPWidth = BaseType->isVectorTy() ? 6788 BaseType->getVectorNumElements() : 0; 6789 6790 while (EatIfPresent(lltok::comma)) { 6791 if (Lex.getKind() == lltok::MetadataVar) { 6792 AteExtraComma = true; 6793 break; 6794 } 6795 if (ParseTypeAndValue(Val, EltLoc, PFS)) return true; 6796 if (!Val->getType()->isIntOrIntVectorTy()) 6797 return Error(EltLoc, "getelementptr index must be an integer"); 6798 6799 if (Val->getType()->isVectorTy()) { 6800 unsigned ValNumEl = Val->getType()->getVectorNumElements(); 6801 if (GEPWidth && GEPWidth != ValNumEl) 6802 return Error(EltLoc, 6803 "getelementptr vector index has a wrong number of elements"); 6804 GEPWidth = ValNumEl; 6805 } 6806 Indices.push_back(Val); 6807 } 6808 6809 SmallPtrSet<Type*, 4> Visited; 6810 if (!Indices.empty() && !Ty->isSized(&Visited)) 6811 return Error(Loc, "base element of getelementptr must be sized"); 6812 6813 if (!GetElementPtrInst::getIndexedType(Ty, Indices)) 6814 return Error(Loc, "invalid getelementptr indices"); 6815 Inst = GetElementPtrInst::Create(Ty, Ptr, Indices); 6816 if (InBounds) 6817 cast<GetElementPtrInst>(Inst)->setIsInBounds(true); 6818 return AteExtraComma ? InstExtraComma : InstNormal; 6819 } 6820 6821 /// ParseExtractValue 6822 /// ::= 'extractvalue' TypeAndValue (',' uint32)+ 6823 int LLParser::ParseExtractValue(Instruction *&Inst, PerFunctionState &PFS) { 6824 Value *Val; LocTy Loc; 6825 SmallVector<unsigned, 4> Indices; 6826 bool AteExtraComma; 6827 if (ParseTypeAndValue(Val, Loc, PFS) || 6828 ParseIndexList(Indices, AteExtraComma)) 6829 return true; 6830 6831 if (!Val->getType()->isAggregateType()) 6832 return Error(Loc, "extractvalue operand must be aggregate type"); 6833 6834 if (!ExtractValueInst::getIndexedType(Val->getType(), Indices)) 6835 return Error(Loc, "invalid indices for extractvalue"); 6836 Inst = ExtractValueInst::Create(Val, Indices); 6837 return AteExtraComma ? InstExtraComma : InstNormal; 6838 } 6839 6840 /// ParseInsertValue 6841 /// ::= 'insertvalue' TypeAndValue ',' TypeAndValue (',' uint32)+ 6842 int LLParser::ParseInsertValue(Instruction *&Inst, PerFunctionState &PFS) { 6843 Value *Val0, *Val1; LocTy Loc0, Loc1; 6844 SmallVector<unsigned, 4> Indices; 6845 bool AteExtraComma; 6846 if (ParseTypeAndValue(Val0, Loc0, PFS) || 6847 ParseToken(lltok::comma, "expected comma after insertvalue operand") || 6848 ParseTypeAndValue(Val1, Loc1, PFS) || 6849 ParseIndexList(Indices, AteExtraComma)) 6850 return true; 6851 6852 if (!Val0->getType()->isAggregateType()) 6853 return Error(Loc0, "insertvalue operand must be aggregate type"); 6854 6855 Type *IndexedType = ExtractValueInst::getIndexedType(Val0->getType(), Indices); 6856 if (!IndexedType) 6857 return Error(Loc0, "invalid indices for insertvalue"); 6858 if (IndexedType != Val1->getType()) 6859 return Error(Loc1, "insertvalue operand and field disagree in type: '" + 6860 getTypeString(Val1->getType()) + "' instead of '" + 6861 getTypeString(IndexedType) + "'"); 6862 Inst = InsertValueInst::Create(Val0, Val1, Indices); 6863 return AteExtraComma ? InstExtraComma : InstNormal; 6864 } 6865 6866 //===----------------------------------------------------------------------===// 6867 // Embedded metadata. 6868 //===----------------------------------------------------------------------===// 6869 6870 /// ParseMDNodeVector 6871 /// ::= { Element (',' Element)* } 6872 /// Element 6873 /// ::= 'null' | TypeAndValue 6874 bool LLParser::ParseMDNodeVector(SmallVectorImpl<Metadata *> &Elts) { 6875 if (ParseToken(lltok::lbrace, "expected '{' here")) 6876 return true; 6877 6878 // Check for an empty list. 6879 if (EatIfPresent(lltok::rbrace)) 6880 return false; 6881 6882 do { 6883 // Null is a special case since it is typeless. 6884 if (EatIfPresent(lltok::kw_null)) { 6885 Elts.push_back(nullptr); 6886 continue; 6887 } 6888 6889 Metadata *MD; 6890 if (ParseMetadata(MD, nullptr)) 6891 return true; 6892 Elts.push_back(MD); 6893 } while (EatIfPresent(lltok::comma)); 6894 6895 return ParseToken(lltok::rbrace, "expected end of metadata node"); 6896 } 6897 6898 //===----------------------------------------------------------------------===// 6899 // Use-list order directives. 6900 //===----------------------------------------------------------------------===// 6901 bool LLParser::sortUseListOrder(Value *V, ArrayRef<unsigned> Indexes, 6902 SMLoc Loc) { 6903 if (V->use_empty()) 6904 return Error(Loc, "value has no uses"); 6905 6906 unsigned NumUses = 0; 6907 SmallDenseMap<const Use *, unsigned, 16> Order; 6908 for (const Use &U : V->uses()) { 6909 if (++NumUses > Indexes.size()) 6910 break; 6911 Order[&U] = Indexes[NumUses - 1]; 6912 } 6913 if (NumUses < 2) 6914 return Error(Loc, "value only has one use"); 6915 if (Order.size() != Indexes.size() || NumUses > Indexes.size()) 6916 return Error(Loc, 6917 "wrong number of indexes, expected " + Twine(V->getNumUses())); 6918 6919 V->sortUseList([&](const Use &L, const Use &R) { 6920 return Order.lookup(&L) < Order.lookup(&R); 6921 }); 6922 return false; 6923 } 6924 6925 /// ParseUseListOrderIndexes 6926 /// ::= '{' uint32 (',' uint32)+ '}' 6927 bool LLParser::ParseUseListOrderIndexes(SmallVectorImpl<unsigned> &Indexes) { 6928 SMLoc Loc = Lex.getLoc(); 6929 if (ParseToken(lltok::lbrace, "expected '{' here")) 6930 return true; 6931 if (Lex.getKind() == lltok::rbrace) 6932 return Lex.Error("expected non-empty list of uselistorder indexes"); 6933 6934 // Use Offset, Max, and IsOrdered to check consistency of indexes. The 6935 // indexes should be distinct numbers in the range [0, size-1], and should 6936 // not be in order. 6937 unsigned Offset = 0; 6938 unsigned Max = 0; 6939 bool IsOrdered = true; 6940 assert(Indexes.empty() && "Expected empty order vector"); 6941 do { 6942 unsigned Index; 6943 if (ParseUInt32(Index)) 6944 return true; 6945 6946 // Update consistency checks. 6947 Offset += Index - Indexes.size(); 6948 Max = std::max(Max, Index); 6949 IsOrdered &= Index == Indexes.size(); 6950 6951 Indexes.push_back(Index); 6952 } while (EatIfPresent(lltok::comma)); 6953 6954 if (ParseToken(lltok::rbrace, "expected '}' here")) 6955 return true; 6956 6957 if (Indexes.size() < 2) 6958 return Error(Loc, "expected >= 2 uselistorder indexes"); 6959 if (Offset != 0 || Max >= Indexes.size()) 6960 return Error(Loc, "expected distinct uselistorder indexes in range [0, size)"); 6961 if (IsOrdered) 6962 return Error(Loc, "expected uselistorder indexes to change the order"); 6963 6964 return false; 6965 } 6966 6967 /// ParseUseListOrder 6968 /// ::= 'uselistorder' Type Value ',' UseListOrderIndexes 6969 bool LLParser::ParseUseListOrder(PerFunctionState *PFS) { 6970 SMLoc Loc = Lex.getLoc(); 6971 if (ParseToken(lltok::kw_uselistorder, "expected uselistorder directive")) 6972 return true; 6973 6974 Value *V; 6975 SmallVector<unsigned, 16> Indexes; 6976 if (ParseTypeAndValue(V, PFS) || 6977 ParseToken(lltok::comma, "expected comma in uselistorder directive") || 6978 ParseUseListOrderIndexes(Indexes)) 6979 return true; 6980 6981 return sortUseListOrder(V, Indexes, Loc); 6982 } 6983 6984 /// ParseUseListOrderBB 6985 /// ::= 'uselistorder_bb' @foo ',' %bar ',' UseListOrderIndexes 6986 bool LLParser::ParseUseListOrderBB() { 6987 assert(Lex.getKind() == lltok::kw_uselistorder_bb); 6988 SMLoc Loc = Lex.getLoc(); 6989 Lex.Lex(); 6990 6991 ValID Fn, Label; 6992 SmallVector<unsigned, 16> Indexes; 6993 if (ParseValID(Fn) || 6994 ParseToken(lltok::comma, "expected comma in uselistorder_bb directive") || 6995 ParseValID(Label) || 6996 ParseToken(lltok::comma, "expected comma in uselistorder_bb directive") || 6997 ParseUseListOrderIndexes(Indexes)) 6998 return true; 6999 7000 // Check the function. 7001 GlobalValue *GV; 7002 if (Fn.Kind == ValID::t_GlobalName) 7003 GV = M->getNamedValue(Fn.StrVal); 7004 else if (Fn.Kind == ValID::t_GlobalID) 7005 GV = Fn.UIntVal < NumberedVals.size() ? NumberedVals[Fn.UIntVal] : nullptr; 7006 else 7007 return Error(Fn.Loc, "expected function name in uselistorder_bb"); 7008 if (!GV) 7009 return Error(Fn.Loc, "invalid function forward reference in uselistorder_bb"); 7010 auto *F = dyn_cast<Function>(GV); 7011 if (!F) 7012 return Error(Fn.Loc, "expected function name in uselistorder_bb"); 7013 if (F->isDeclaration()) 7014 return Error(Fn.Loc, "invalid declaration in uselistorder_bb"); 7015 7016 // Check the basic block. 7017 if (Label.Kind == ValID::t_LocalID) 7018 return Error(Label.Loc, "invalid numeric label in uselistorder_bb"); 7019 if (Label.Kind != ValID::t_LocalName) 7020 return Error(Label.Loc, "expected basic block name in uselistorder_bb"); 7021 Value *V = F->getValueSymbolTable()->lookup(Label.StrVal); 7022 if (!V) 7023 return Error(Label.Loc, "invalid basic block in uselistorder_bb"); 7024 if (!isa<BasicBlock>(V)) 7025 return Error(Label.Loc, "expected basic block in uselistorder_bb"); 7026 7027 return sortUseListOrder(V, Indexes, Loc); 7028 } 7029 7030 /// ModuleEntry 7031 /// ::= 'module' ':' '(' 'path' ':' STRINGCONSTANT ',' 'hash' ':' Hash ')' 7032 /// Hash ::= '(' UInt32 ',' UInt32 ',' UInt32 ',' UInt32 ',' UInt32 ')' 7033 bool LLParser::ParseModuleEntry(unsigned ID) { 7034 assert(Lex.getKind() == lltok::kw_module); 7035 Lex.Lex(); 7036 7037 std::string Path; 7038 if (ParseToken(lltok::colon, "expected ':' here") || 7039 ParseToken(lltok::lparen, "expected '(' here") || 7040 ParseToken(lltok::kw_path, "expected 'path' here") || 7041 ParseToken(lltok::colon, "expected ':' here") || 7042 ParseStringConstant(Path) || 7043 ParseToken(lltok::comma, "expected ',' here") || 7044 ParseToken(lltok::kw_hash, "expected 'hash' here") || 7045 ParseToken(lltok::colon, "expected ':' here") || 7046 ParseToken(lltok::lparen, "expected '(' here")) 7047 return true; 7048 7049 ModuleHash Hash; 7050 if (ParseUInt32(Hash[0]) || ParseToken(lltok::comma, "expected ',' here") || 7051 ParseUInt32(Hash[1]) || ParseToken(lltok::comma, "expected ',' here") || 7052 ParseUInt32(Hash[2]) || ParseToken(lltok::comma, "expected ',' here") || 7053 ParseUInt32(Hash[3]) || ParseToken(lltok::comma, "expected ',' here") || 7054 ParseUInt32(Hash[4])) 7055 return true; 7056 7057 if (ParseToken(lltok::rparen, "expected ')' here") || 7058 ParseToken(lltok::rparen, "expected ')' here")) 7059 return true; 7060 7061 auto ModuleEntry = Index->addModule(Path, ID, Hash); 7062 ModuleIdMap[ID] = ModuleEntry->first(); 7063 7064 return false; 7065 } 7066 7067 /// TypeIdEntry 7068 /// ::= 'typeid' ':' '(' 'name' ':' STRINGCONSTANT ',' TypeIdSummary ')' 7069 bool LLParser::ParseTypeIdEntry(unsigned ID) { 7070 assert(Lex.getKind() == lltok::kw_typeid); 7071 Lex.Lex(); 7072 7073 std::string Name; 7074 if (ParseToken(lltok::colon, "expected ':' here") || 7075 ParseToken(lltok::lparen, "expected '(' here") || 7076 ParseToken(lltok::kw_name, "expected 'name' here") || 7077 ParseToken(lltok::colon, "expected ':' here") || 7078 ParseStringConstant(Name)) 7079 return true; 7080 7081 TypeIdSummary &TIS = Index->getOrInsertTypeIdSummary(Name); 7082 if (ParseToken(lltok::comma, "expected ',' here") || 7083 ParseTypeIdSummary(TIS) || ParseToken(lltok::rparen, "expected ')' here")) 7084 return true; 7085 7086 // Check if this ID was forward referenced, and if so, update the 7087 // corresponding GUIDs. 7088 auto FwdRefTIDs = ForwardRefTypeIds.find(ID); 7089 if (FwdRefTIDs != ForwardRefTypeIds.end()) { 7090 for (auto TIDRef : FwdRefTIDs->second) { 7091 assert(!*TIDRef.first && 7092 "Forward referenced type id GUID expected to be 0"); 7093 *TIDRef.first = GlobalValue::getGUID(Name); 7094 } 7095 ForwardRefTypeIds.erase(FwdRefTIDs); 7096 } 7097 7098 return false; 7099 } 7100 7101 /// TypeIdSummary 7102 /// ::= 'summary' ':' '(' TypeTestResolution [',' OptionalWpdResolutions]? ')' 7103 bool LLParser::ParseTypeIdSummary(TypeIdSummary &TIS) { 7104 if (ParseToken(lltok::kw_summary, "expected 'summary' here") || 7105 ParseToken(lltok::colon, "expected ':' here") || 7106 ParseToken(lltok::lparen, "expected '(' here") || 7107 ParseTypeTestResolution(TIS.TTRes)) 7108 return true; 7109 7110 if (EatIfPresent(lltok::comma)) { 7111 // Expect optional wpdResolutions field 7112 if (ParseOptionalWpdResolutions(TIS.WPDRes)) 7113 return true; 7114 } 7115 7116 if (ParseToken(lltok::rparen, "expected ')' here")) 7117 return true; 7118 7119 return false; 7120 } 7121 7122 /// TypeTestResolution 7123 /// ::= 'typeTestRes' ':' '(' 'kind' ':' 7124 /// ( 'unsat' | 'byteArray' | 'inline' | 'single' | 'allOnes' ) ',' 7125 /// 'sizeM1BitWidth' ':' SizeM1BitWidth [',' 'alignLog2' ':' UInt64]? 7126 /// [',' 'sizeM1' ':' UInt64]? [',' 'bitMask' ':' UInt8]? 7127 /// [',' 'inlinesBits' ':' UInt64]? ')' 7128 bool LLParser::ParseTypeTestResolution(TypeTestResolution &TTRes) { 7129 if (ParseToken(lltok::kw_typeTestRes, "expected 'typeTestRes' here") || 7130 ParseToken(lltok::colon, "expected ':' here") || 7131 ParseToken(lltok::lparen, "expected '(' here") || 7132 ParseToken(lltok::kw_kind, "expected 'kind' here") || 7133 ParseToken(lltok::colon, "expected ':' here")) 7134 return true; 7135 7136 switch (Lex.getKind()) { 7137 case lltok::kw_unsat: 7138 TTRes.TheKind = TypeTestResolution::Unsat; 7139 break; 7140 case lltok::kw_byteArray: 7141 TTRes.TheKind = TypeTestResolution::ByteArray; 7142 break; 7143 case lltok::kw_inline: 7144 TTRes.TheKind = TypeTestResolution::Inline; 7145 break; 7146 case lltok::kw_single: 7147 TTRes.TheKind = TypeTestResolution::Single; 7148 break; 7149 case lltok::kw_allOnes: 7150 TTRes.TheKind = TypeTestResolution::AllOnes; 7151 break; 7152 default: 7153 return Error(Lex.getLoc(), "unexpected TypeTestResolution kind"); 7154 } 7155 Lex.Lex(); 7156 7157 if (ParseToken(lltok::comma, "expected ',' here") || 7158 ParseToken(lltok::kw_sizeM1BitWidth, "expected 'sizeM1BitWidth' here") || 7159 ParseToken(lltok::colon, "expected ':' here") || 7160 ParseUInt32(TTRes.SizeM1BitWidth)) 7161 return true; 7162 7163 // Parse optional fields 7164 while (EatIfPresent(lltok::comma)) { 7165 switch (Lex.getKind()) { 7166 case lltok::kw_alignLog2: 7167 Lex.Lex(); 7168 if (ParseToken(lltok::colon, "expected ':'") || 7169 ParseUInt64(TTRes.AlignLog2)) 7170 return true; 7171 break; 7172 case lltok::kw_sizeM1: 7173 Lex.Lex(); 7174 if (ParseToken(lltok::colon, "expected ':'") || ParseUInt64(TTRes.SizeM1)) 7175 return true; 7176 break; 7177 case lltok::kw_bitMask: { 7178 unsigned Val; 7179 Lex.Lex(); 7180 if (ParseToken(lltok::colon, "expected ':'") || ParseUInt32(Val)) 7181 return true; 7182 assert(Val <= 0xff); 7183 TTRes.BitMask = (uint8_t)Val; 7184 break; 7185 } 7186 case lltok::kw_inlineBits: 7187 Lex.Lex(); 7188 if (ParseToken(lltok::colon, "expected ':'") || 7189 ParseUInt64(TTRes.InlineBits)) 7190 return true; 7191 break; 7192 default: 7193 return Error(Lex.getLoc(), "expected optional TypeTestResolution field"); 7194 } 7195 } 7196 7197 if (ParseToken(lltok::rparen, "expected ')' here")) 7198 return true; 7199 7200 return false; 7201 } 7202 7203 /// OptionalWpdResolutions 7204 /// ::= 'wpsResolutions' ':' '(' WpdResolution [',' WpdResolution]* ')' 7205 /// WpdResolution ::= '(' 'offset' ':' UInt64 ',' WpdRes ')' 7206 bool LLParser::ParseOptionalWpdResolutions( 7207 std::map<uint64_t, WholeProgramDevirtResolution> &WPDResMap) { 7208 if (ParseToken(lltok::kw_wpdResolutions, "expected 'wpdResolutions' here") || 7209 ParseToken(lltok::colon, "expected ':' here") || 7210 ParseToken(lltok::lparen, "expected '(' here")) 7211 return true; 7212 7213 do { 7214 uint64_t Offset; 7215 WholeProgramDevirtResolution WPDRes; 7216 if (ParseToken(lltok::lparen, "expected '(' here") || 7217 ParseToken(lltok::kw_offset, "expected 'offset' here") || 7218 ParseToken(lltok::colon, "expected ':' here") || ParseUInt64(Offset) || 7219 ParseToken(lltok::comma, "expected ',' here") || ParseWpdRes(WPDRes) || 7220 ParseToken(lltok::rparen, "expected ')' here")) 7221 return true; 7222 WPDResMap[Offset] = WPDRes; 7223 } while (EatIfPresent(lltok::comma)); 7224 7225 if (ParseToken(lltok::rparen, "expected ')' here")) 7226 return true; 7227 7228 return false; 7229 } 7230 7231 /// WpdRes 7232 /// ::= 'wpdRes' ':' '(' 'kind' ':' 'indir' 7233 /// [',' OptionalResByArg]? ')' 7234 /// ::= 'wpdRes' ':' '(' 'kind' ':' 'singleImpl' 7235 /// ',' 'singleImplName' ':' STRINGCONSTANT ',' 7236 /// [',' OptionalResByArg]? ')' 7237 /// ::= 'wpdRes' ':' '(' 'kind' ':' 'branchFunnel' 7238 /// [',' OptionalResByArg]? ')' 7239 bool LLParser::ParseWpdRes(WholeProgramDevirtResolution &WPDRes) { 7240 if (ParseToken(lltok::kw_wpdRes, "expected 'wpdRes' here") || 7241 ParseToken(lltok::colon, "expected ':' here") || 7242 ParseToken(lltok::lparen, "expected '(' here") || 7243 ParseToken(lltok::kw_kind, "expected 'kind' here") || 7244 ParseToken(lltok::colon, "expected ':' here")) 7245 return true; 7246 7247 switch (Lex.getKind()) { 7248 case lltok::kw_indir: 7249 WPDRes.TheKind = WholeProgramDevirtResolution::Indir; 7250 break; 7251 case lltok::kw_singleImpl: 7252 WPDRes.TheKind = WholeProgramDevirtResolution::SingleImpl; 7253 break; 7254 case lltok::kw_branchFunnel: 7255 WPDRes.TheKind = WholeProgramDevirtResolution::BranchFunnel; 7256 break; 7257 default: 7258 return Error(Lex.getLoc(), "unexpected WholeProgramDevirtResolution kind"); 7259 } 7260 Lex.Lex(); 7261 7262 // Parse optional fields 7263 while (EatIfPresent(lltok::comma)) { 7264 switch (Lex.getKind()) { 7265 case lltok::kw_singleImplName: 7266 Lex.Lex(); 7267 if (ParseToken(lltok::colon, "expected ':' here") || 7268 ParseStringConstant(WPDRes.SingleImplName)) 7269 return true; 7270 break; 7271 case lltok::kw_resByArg: 7272 if (ParseOptionalResByArg(WPDRes.ResByArg)) 7273 return true; 7274 break; 7275 default: 7276 return Error(Lex.getLoc(), 7277 "expected optional WholeProgramDevirtResolution field"); 7278 } 7279 } 7280 7281 if (ParseToken(lltok::rparen, "expected ')' here")) 7282 return true; 7283 7284 return false; 7285 } 7286 7287 /// OptionalResByArg 7288 /// ::= 'wpdRes' ':' '(' ResByArg[, ResByArg]* ')' 7289 /// ResByArg ::= Args ',' 'byArg' ':' '(' 'kind' ':' 7290 /// ( 'indir' | 'uniformRetVal' | 'UniqueRetVal' | 7291 /// 'virtualConstProp' ) 7292 /// [',' 'info' ':' UInt64]? [',' 'byte' ':' UInt32]? 7293 /// [',' 'bit' ':' UInt32]? ')' 7294 bool LLParser::ParseOptionalResByArg( 7295 std::map<std::vector<uint64_t>, WholeProgramDevirtResolution::ByArg> 7296 &ResByArg) { 7297 if (ParseToken(lltok::kw_resByArg, "expected 'resByArg' here") || 7298 ParseToken(lltok::colon, "expected ':' here") || 7299 ParseToken(lltok::lparen, "expected '(' here")) 7300 return true; 7301 7302 do { 7303 std::vector<uint64_t> Args; 7304 if (ParseArgs(Args) || ParseToken(lltok::comma, "expected ',' here") || 7305 ParseToken(lltok::kw_byArg, "expected 'byArg here") || 7306 ParseToken(lltok::colon, "expected ':' here") || 7307 ParseToken(lltok::lparen, "expected '(' here") || 7308 ParseToken(lltok::kw_kind, "expected 'kind' here") || 7309 ParseToken(lltok::colon, "expected ':' here")) 7310 return true; 7311 7312 WholeProgramDevirtResolution::ByArg ByArg; 7313 switch (Lex.getKind()) { 7314 case lltok::kw_indir: 7315 ByArg.TheKind = WholeProgramDevirtResolution::ByArg::Indir; 7316 break; 7317 case lltok::kw_uniformRetVal: 7318 ByArg.TheKind = WholeProgramDevirtResolution::ByArg::UniformRetVal; 7319 break; 7320 case lltok::kw_uniqueRetVal: 7321 ByArg.TheKind = WholeProgramDevirtResolution::ByArg::UniqueRetVal; 7322 break; 7323 case lltok::kw_virtualConstProp: 7324 ByArg.TheKind = WholeProgramDevirtResolution::ByArg::VirtualConstProp; 7325 break; 7326 default: 7327 return Error(Lex.getLoc(), 7328 "unexpected WholeProgramDevirtResolution::ByArg kind"); 7329 } 7330 Lex.Lex(); 7331 7332 // Parse optional fields 7333 while (EatIfPresent(lltok::comma)) { 7334 switch (Lex.getKind()) { 7335 case lltok::kw_info: 7336 Lex.Lex(); 7337 if (ParseToken(lltok::colon, "expected ':' here") || 7338 ParseUInt64(ByArg.Info)) 7339 return true; 7340 break; 7341 case lltok::kw_byte: 7342 Lex.Lex(); 7343 if (ParseToken(lltok::colon, "expected ':' here") || 7344 ParseUInt32(ByArg.Byte)) 7345 return true; 7346 break; 7347 case lltok::kw_bit: 7348 Lex.Lex(); 7349 if (ParseToken(lltok::colon, "expected ':' here") || 7350 ParseUInt32(ByArg.Bit)) 7351 return true; 7352 break; 7353 default: 7354 return Error(Lex.getLoc(), 7355 "expected optional whole program devirt field"); 7356 } 7357 } 7358 7359 if (ParseToken(lltok::rparen, "expected ')' here")) 7360 return true; 7361 7362 ResByArg[Args] = ByArg; 7363 } while (EatIfPresent(lltok::comma)); 7364 7365 if (ParseToken(lltok::rparen, "expected ')' here")) 7366 return true; 7367 7368 return false; 7369 } 7370 7371 /// OptionalResByArg 7372 /// ::= 'args' ':' '(' UInt64[, UInt64]* ')' 7373 bool LLParser::ParseArgs(std::vector<uint64_t> &Args) { 7374 if (ParseToken(lltok::kw_args, "expected 'args' here") || 7375 ParseToken(lltok::colon, "expected ':' here") || 7376 ParseToken(lltok::lparen, "expected '(' here")) 7377 return true; 7378 7379 do { 7380 uint64_t Val; 7381 if (ParseUInt64(Val)) 7382 return true; 7383 Args.push_back(Val); 7384 } while (EatIfPresent(lltok::comma)); 7385 7386 if (ParseToken(lltok::rparen, "expected ')' here")) 7387 return true; 7388 7389 return false; 7390 } 7391 7392 static ValueInfo EmptyVI = 7393 ValueInfo(false, (GlobalValueSummaryMapTy::value_type *)-8); 7394 7395 /// Stores the given Name/GUID and associated summary into the Index. 7396 /// Also updates any forward references to the associated entry ID. 7397 void LLParser::AddGlobalValueToIndex( 7398 std::string Name, GlobalValue::GUID GUID, GlobalValue::LinkageTypes Linkage, 7399 unsigned ID, std::unique_ptr<GlobalValueSummary> Summary) { 7400 // First create the ValueInfo utilizing the Name or GUID. 7401 ValueInfo VI; 7402 if (GUID != 0) { 7403 assert(Name.empty()); 7404 VI = Index->getOrInsertValueInfo(GUID); 7405 } else { 7406 assert(!Name.empty()); 7407 if (M) { 7408 auto *GV = M->getNamedValue(Name); 7409 assert(GV); 7410 VI = Index->getOrInsertValueInfo(GV); 7411 } else { 7412 assert( 7413 (!GlobalValue::isLocalLinkage(Linkage) || !SourceFileName.empty()) && 7414 "Need a source_filename to compute GUID for local"); 7415 GUID = GlobalValue::getGUID( 7416 GlobalValue::getGlobalIdentifier(Name, Linkage, SourceFileName)); 7417 VI = Index->getOrInsertValueInfo(GUID, Index->saveString(Name)); 7418 } 7419 } 7420 7421 // Add the summary if one was provided. 7422 if (Summary) 7423 Index->addGlobalValueSummary(VI, std::move(Summary)); 7424 7425 // Resolve forward references from calls/refs 7426 auto FwdRefVIs = ForwardRefValueInfos.find(ID); 7427 if (FwdRefVIs != ForwardRefValueInfos.end()) { 7428 for (auto VIRef : FwdRefVIs->second) { 7429 assert(*VIRef.first == EmptyVI && 7430 "Forward referenced ValueInfo expected to be empty"); 7431 *VIRef.first = VI; 7432 } 7433 ForwardRefValueInfos.erase(FwdRefVIs); 7434 } 7435 7436 // Resolve forward references from aliases 7437 auto FwdRefAliasees = ForwardRefAliasees.find(ID); 7438 if (FwdRefAliasees != ForwardRefAliasees.end()) { 7439 for (auto AliaseeRef : FwdRefAliasees->second) { 7440 assert(!AliaseeRef.first->hasAliasee() && 7441 "Forward referencing alias already has aliasee"); 7442 AliaseeRef.first->setAliasee(VI.getSummaryList().front().get()); 7443 } 7444 ForwardRefAliasees.erase(FwdRefAliasees); 7445 } 7446 7447 // Save the associated ValueInfo for use in later references by ID. 7448 if (ID == NumberedValueInfos.size()) 7449 NumberedValueInfos.push_back(VI); 7450 else { 7451 // Handle non-continuous numbers (to make test simplification easier). 7452 if (ID > NumberedValueInfos.size()) 7453 NumberedValueInfos.resize(ID + 1); 7454 NumberedValueInfos[ID] = VI; 7455 } 7456 } 7457 7458 /// ParseGVEntry 7459 /// ::= 'gv' ':' '(' ('name' ':' STRINGCONSTANT | 'guid' ':' UInt64) 7460 /// [',' 'summaries' ':' Summary[',' Summary]* ]? ')' 7461 /// Summary ::= '(' (FunctionSummary | VariableSummary | AliasSummary) ')' 7462 bool LLParser::ParseGVEntry(unsigned ID) { 7463 assert(Lex.getKind() == lltok::kw_gv); 7464 Lex.Lex(); 7465 7466 if (ParseToken(lltok::colon, "expected ':' here") || 7467 ParseToken(lltok::lparen, "expected '(' here")) 7468 return true; 7469 7470 std::string Name; 7471 GlobalValue::GUID GUID = 0; 7472 switch (Lex.getKind()) { 7473 case lltok::kw_name: 7474 Lex.Lex(); 7475 if (ParseToken(lltok::colon, "expected ':' here") || 7476 ParseStringConstant(Name)) 7477 return true; 7478 // Can't create GUID/ValueInfo until we have the linkage. 7479 break; 7480 case lltok::kw_guid: 7481 Lex.Lex(); 7482 if (ParseToken(lltok::colon, "expected ':' here") || ParseUInt64(GUID)) 7483 return true; 7484 break; 7485 default: 7486 return Error(Lex.getLoc(), "expected name or guid tag"); 7487 } 7488 7489 if (!EatIfPresent(lltok::comma)) { 7490 // No summaries. Wrap up. 7491 if (ParseToken(lltok::rparen, "expected ')' here")) 7492 return true; 7493 // This was created for a call to an external or indirect target. 7494 // A GUID with no summary came from a VALUE_GUID record, dummy GUID 7495 // created for indirect calls with VP. A Name with no GUID came from 7496 // an external definition. We pass ExternalLinkage since that is only 7497 // used when the GUID must be computed from Name, and in that case 7498 // the symbol must have external linkage. 7499 AddGlobalValueToIndex(Name, GUID, GlobalValue::ExternalLinkage, ID, 7500 nullptr); 7501 return false; 7502 } 7503 7504 // Have a list of summaries 7505 if (ParseToken(lltok::kw_summaries, "expected 'summaries' here") || 7506 ParseToken(lltok::colon, "expected ':' here")) 7507 return true; 7508 7509 do { 7510 if (ParseToken(lltok::lparen, "expected '(' here")) 7511 return true; 7512 switch (Lex.getKind()) { 7513 case lltok::kw_function: 7514 if (ParseFunctionSummary(Name, GUID, ID)) 7515 return true; 7516 break; 7517 case lltok::kw_variable: 7518 if (ParseVariableSummary(Name, GUID, ID)) 7519 return true; 7520 break; 7521 case lltok::kw_alias: 7522 if (ParseAliasSummary(Name, GUID, ID)) 7523 return true; 7524 break; 7525 default: 7526 return Error(Lex.getLoc(), "expected summary type"); 7527 } 7528 if (ParseToken(lltok::rparen, "expected ')' here")) 7529 return true; 7530 } while (EatIfPresent(lltok::comma)); 7531 7532 if (ParseToken(lltok::rparen, "expected ')' here")) 7533 return true; 7534 7535 return false; 7536 } 7537 7538 /// FunctionSummary 7539 /// ::= 'function' ':' '(' 'module' ':' ModuleReference ',' GVFlags 7540 /// ',' 'insts' ':' UInt32 [',' OptionalFFlags]? [',' OptionalCalls]? 7541 /// [',' OptionalTypeIdInfo]? [',' OptionalRefs]? ')' 7542 bool LLParser::ParseFunctionSummary(std::string Name, GlobalValue::GUID GUID, 7543 unsigned ID) { 7544 assert(Lex.getKind() == lltok::kw_function); 7545 Lex.Lex(); 7546 7547 StringRef ModulePath; 7548 GlobalValueSummary::GVFlags GVFlags = GlobalValueSummary::GVFlags( 7549 /*Linkage=*/GlobalValue::ExternalLinkage, /*NotEligibleToImport=*/false, 7550 /*Live=*/false, /*IsLocal=*/false); 7551 unsigned InstCount; 7552 std::vector<FunctionSummary::EdgeTy> Calls; 7553 FunctionSummary::TypeIdInfo TypeIdInfo; 7554 std::vector<ValueInfo> Refs; 7555 // Default is all-zeros (conservative values). 7556 FunctionSummary::FFlags FFlags = {}; 7557 if (ParseToken(lltok::colon, "expected ':' here") || 7558 ParseToken(lltok::lparen, "expected '(' here") || 7559 ParseModuleReference(ModulePath) || 7560 ParseToken(lltok::comma, "expected ',' here") || ParseGVFlags(GVFlags) || 7561 ParseToken(lltok::comma, "expected ',' here") || 7562 ParseToken(lltok::kw_insts, "expected 'insts' here") || 7563 ParseToken(lltok::colon, "expected ':' here") || ParseUInt32(InstCount)) 7564 return true; 7565 7566 // Parse optional fields 7567 while (EatIfPresent(lltok::comma)) { 7568 switch (Lex.getKind()) { 7569 case lltok::kw_funcFlags: 7570 if (ParseOptionalFFlags(FFlags)) 7571 return true; 7572 break; 7573 case lltok::kw_calls: 7574 if (ParseOptionalCalls(Calls)) 7575 return true; 7576 break; 7577 case lltok::kw_typeIdInfo: 7578 if (ParseOptionalTypeIdInfo(TypeIdInfo)) 7579 return true; 7580 break; 7581 case lltok::kw_refs: 7582 if (ParseOptionalRefs(Refs)) 7583 return true; 7584 break; 7585 default: 7586 return Error(Lex.getLoc(), "expected optional function summary field"); 7587 } 7588 } 7589 7590 if (ParseToken(lltok::rparen, "expected ')' here")) 7591 return true; 7592 7593 auto FS = llvm::make_unique<FunctionSummary>( 7594 GVFlags, InstCount, FFlags, std::move(Refs), std::move(Calls), 7595 std::move(TypeIdInfo.TypeTests), 7596 std::move(TypeIdInfo.TypeTestAssumeVCalls), 7597 std::move(TypeIdInfo.TypeCheckedLoadVCalls), 7598 std::move(TypeIdInfo.TypeTestAssumeConstVCalls), 7599 std::move(TypeIdInfo.TypeCheckedLoadConstVCalls)); 7600 7601 FS->setModulePath(ModulePath); 7602 7603 AddGlobalValueToIndex(Name, GUID, (GlobalValue::LinkageTypes)GVFlags.Linkage, 7604 ID, std::move(FS)); 7605 7606 return false; 7607 } 7608 7609 /// VariableSummary 7610 /// ::= 'variable' ':' '(' 'module' ':' ModuleReference ',' GVFlags 7611 /// [',' OptionalRefs]? ')' 7612 bool LLParser::ParseVariableSummary(std::string Name, GlobalValue::GUID GUID, 7613 unsigned ID) { 7614 assert(Lex.getKind() == lltok::kw_variable); 7615 Lex.Lex(); 7616 7617 StringRef ModulePath; 7618 GlobalValueSummary::GVFlags GVFlags = GlobalValueSummary::GVFlags( 7619 /*Linkage=*/GlobalValue::ExternalLinkage, /*NotEligibleToImport=*/false, 7620 /*Live=*/false, /*IsLocal=*/false); 7621 std::vector<ValueInfo> Refs; 7622 if (ParseToken(lltok::colon, "expected ':' here") || 7623 ParseToken(lltok::lparen, "expected '(' here") || 7624 ParseModuleReference(ModulePath) || 7625 ParseToken(lltok::comma, "expected ',' here") || ParseGVFlags(GVFlags)) 7626 return true; 7627 7628 // Parse optional refs field 7629 if (EatIfPresent(lltok::comma)) { 7630 if (ParseOptionalRefs(Refs)) 7631 return true; 7632 } 7633 7634 if (ParseToken(lltok::rparen, "expected ')' here")) 7635 return true; 7636 7637 auto GS = llvm::make_unique<GlobalVarSummary>(GVFlags, std::move(Refs)); 7638 7639 GS->setModulePath(ModulePath); 7640 7641 AddGlobalValueToIndex(Name, GUID, (GlobalValue::LinkageTypes)GVFlags.Linkage, 7642 ID, std::move(GS)); 7643 7644 return false; 7645 } 7646 7647 /// AliasSummary 7648 /// ::= 'alias' ':' '(' 'module' ':' ModuleReference ',' GVFlags ',' 7649 /// 'aliasee' ':' GVReference ')' 7650 bool LLParser::ParseAliasSummary(std::string Name, GlobalValue::GUID GUID, 7651 unsigned ID) { 7652 assert(Lex.getKind() == lltok::kw_alias); 7653 LocTy Loc = Lex.getLoc(); 7654 Lex.Lex(); 7655 7656 StringRef ModulePath; 7657 GlobalValueSummary::GVFlags GVFlags = GlobalValueSummary::GVFlags( 7658 /*Linkage=*/GlobalValue::ExternalLinkage, /*NotEligibleToImport=*/false, 7659 /*Live=*/false, /*IsLocal=*/false); 7660 if (ParseToken(lltok::colon, "expected ':' here") || 7661 ParseToken(lltok::lparen, "expected '(' here") || 7662 ParseModuleReference(ModulePath) || 7663 ParseToken(lltok::comma, "expected ',' here") || ParseGVFlags(GVFlags) || 7664 ParseToken(lltok::comma, "expected ',' here") || 7665 ParseToken(lltok::kw_aliasee, "expected 'aliasee' here") || 7666 ParseToken(lltok::colon, "expected ':' here")) 7667 return true; 7668 7669 ValueInfo AliaseeVI; 7670 unsigned GVId; 7671 if (ParseGVReference(AliaseeVI, GVId)) 7672 return true; 7673 7674 if (ParseToken(lltok::rparen, "expected ')' here")) 7675 return true; 7676 7677 auto AS = llvm::make_unique<AliasSummary>(GVFlags); 7678 7679 AS->setModulePath(ModulePath); 7680 7681 // Record forward reference if the aliasee is not parsed yet. 7682 if (AliaseeVI == EmptyVI) { 7683 auto FwdRef = ForwardRefAliasees.insert( 7684 std::make_pair(GVId, std::vector<std::pair<AliasSummary *, LocTy>>())); 7685 FwdRef.first->second.push_back(std::make_pair(AS.get(), Loc)); 7686 } else 7687 AS->setAliasee(AliaseeVI.getSummaryList().front().get()); 7688 7689 AddGlobalValueToIndex(Name, GUID, (GlobalValue::LinkageTypes)GVFlags.Linkage, 7690 ID, std::move(AS)); 7691 7692 return false; 7693 } 7694 7695 /// Flag 7696 /// ::= [0|1] 7697 bool LLParser::ParseFlag(unsigned &Val) { 7698 if (Lex.getKind() != lltok::APSInt || Lex.getAPSIntVal().isSigned()) 7699 return TokError("expected integer"); 7700 Val = (unsigned)Lex.getAPSIntVal().getBoolValue(); 7701 Lex.Lex(); 7702 return false; 7703 } 7704 7705 /// OptionalFFlags 7706 /// := 'funcFlags' ':' '(' ['readNone' ':' Flag]? 7707 /// [',' 'readOnly' ':' Flag]? [',' 'noRecurse' ':' Flag]? 7708 /// [',' 'returnDoesNotAlias' ':' Flag]? ')' 7709 bool LLParser::ParseOptionalFFlags(FunctionSummary::FFlags &FFlags) { 7710 assert(Lex.getKind() == lltok::kw_funcFlags); 7711 Lex.Lex(); 7712 7713 if (ParseToken(lltok::colon, "expected ':' in funcFlags") | 7714 ParseToken(lltok::lparen, "expected '(' in funcFlags")) 7715 return true; 7716 7717 do { 7718 unsigned Val; 7719 switch (Lex.getKind()) { 7720 case lltok::kw_readNone: 7721 Lex.Lex(); 7722 if (ParseToken(lltok::colon, "expected ':'") || ParseFlag(Val)) 7723 return true; 7724 FFlags.ReadNone = Val; 7725 break; 7726 case lltok::kw_readOnly: 7727 Lex.Lex(); 7728 if (ParseToken(lltok::colon, "expected ':'") || ParseFlag(Val)) 7729 return true; 7730 FFlags.ReadOnly = Val; 7731 break; 7732 case lltok::kw_noRecurse: 7733 Lex.Lex(); 7734 if (ParseToken(lltok::colon, "expected ':'") || ParseFlag(Val)) 7735 return true; 7736 FFlags.NoRecurse = Val; 7737 break; 7738 case lltok::kw_returnDoesNotAlias: 7739 Lex.Lex(); 7740 if (ParseToken(lltok::colon, "expected ':'") || ParseFlag(Val)) 7741 return true; 7742 FFlags.ReturnDoesNotAlias = Val; 7743 break; 7744 default: 7745 return Error(Lex.getLoc(), "expected function flag type"); 7746 } 7747 } while (EatIfPresent(lltok::comma)); 7748 7749 if (ParseToken(lltok::rparen, "expected ')' in funcFlags")) 7750 return true; 7751 7752 return false; 7753 } 7754 7755 /// OptionalCalls 7756 /// := 'calls' ':' '(' Call [',' Call]* ')' 7757 /// Call ::= '(' 'callee' ':' GVReference 7758 /// [( ',' 'hotness' ':' Hotness | ',' 'relbf' ':' UInt32 )]? ')' 7759 bool LLParser::ParseOptionalCalls(std::vector<FunctionSummary::EdgeTy> &Calls) { 7760 assert(Lex.getKind() == lltok::kw_calls); 7761 Lex.Lex(); 7762 7763 if (ParseToken(lltok::colon, "expected ':' in calls") | 7764 ParseToken(lltok::lparen, "expected '(' in calls")) 7765 return true; 7766 7767 IdToIndexMapType IdToIndexMap; 7768 // Parse each call edge 7769 do { 7770 ValueInfo VI; 7771 if (ParseToken(lltok::lparen, "expected '(' in call") || 7772 ParseToken(lltok::kw_callee, "expected 'callee' in call") || 7773 ParseToken(lltok::colon, "expected ':'")) 7774 return true; 7775 7776 LocTy Loc = Lex.getLoc(); 7777 unsigned GVId; 7778 if (ParseGVReference(VI, GVId)) 7779 return true; 7780 7781 CalleeInfo::HotnessType Hotness = CalleeInfo::HotnessType::Unknown; 7782 unsigned RelBF = 0; 7783 if (EatIfPresent(lltok::comma)) { 7784 // Expect either hotness or relbf 7785 if (EatIfPresent(lltok::kw_hotness)) { 7786 if (ParseToken(lltok::colon, "expected ':'") || ParseHotness(Hotness)) 7787 return true; 7788 } else { 7789 if (ParseToken(lltok::kw_relbf, "expected relbf") || 7790 ParseToken(lltok::colon, "expected ':'") || ParseUInt32(RelBF)) 7791 return true; 7792 } 7793 } 7794 // Keep track of the Call array index needing a forward reference. 7795 // We will save the location of the ValueInfo needing an update, but 7796 // can only do so once the std::vector is finalized. 7797 if (VI == EmptyVI) 7798 IdToIndexMap[GVId].push_back(std::make_pair(Calls.size(), Loc)); 7799 Calls.push_back(FunctionSummary::EdgeTy{VI, CalleeInfo(Hotness, RelBF)}); 7800 7801 if (ParseToken(lltok::rparen, "expected ')' in call")) 7802 return true; 7803 } while (EatIfPresent(lltok::comma)); 7804 7805 // Now that the Calls vector is finalized, it is safe to save the locations 7806 // of any forward GV references that need updating later. 7807 for (auto I : IdToIndexMap) { 7808 for (auto P : I.second) { 7809 assert(Calls[P.first].first == EmptyVI && 7810 "Forward referenced ValueInfo expected to be empty"); 7811 auto FwdRef = ForwardRefValueInfos.insert(std::make_pair( 7812 I.first, std::vector<std::pair<ValueInfo *, LocTy>>())); 7813 FwdRef.first->second.push_back( 7814 std::make_pair(&Calls[P.first].first, P.second)); 7815 } 7816 } 7817 7818 if (ParseToken(lltok::rparen, "expected ')' in calls")) 7819 return true; 7820 7821 return false; 7822 } 7823 7824 /// Hotness 7825 /// := ('unknown'|'cold'|'none'|'hot'|'critical') 7826 bool LLParser::ParseHotness(CalleeInfo::HotnessType &Hotness) { 7827 switch (Lex.getKind()) { 7828 case lltok::kw_unknown: 7829 Hotness = CalleeInfo::HotnessType::Unknown; 7830 break; 7831 case lltok::kw_cold: 7832 Hotness = CalleeInfo::HotnessType::Cold; 7833 break; 7834 case lltok::kw_none: 7835 Hotness = CalleeInfo::HotnessType::None; 7836 break; 7837 case lltok::kw_hot: 7838 Hotness = CalleeInfo::HotnessType::Hot; 7839 break; 7840 case lltok::kw_critical: 7841 Hotness = CalleeInfo::HotnessType::Critical; 7842 break; 7843 default: 7844 return Error(Lex.getLoc(), "invalid call edge hotness"); 7845 } 7846 Lex.Lex(); 7847 return false; 7848 } 7849 7850 /// OptionalRefs 7851 /// := 'refs' ':' '(' GVReference [',' GVReference]* ')' 7852 bool LLParser::ParseOptionalRefs(std::vector<ValueInfo> &Refs) { 7853 assert(Lex.getKind() == lltok::kw_refs); 7854 Lex.Lex(); 7855 7856 if (ParseToken(lltok::colon, "expected ':' in refs") | 7857 ParseToken(lltok::lparen, "expected '(' in refs")) 7858 return true; 7859 7860 IdToIndexMapType IdToIndexMap; 7861 // Parse each ref edge 7862 do { 7863 ValueInfo VI; 7864 LocTy Loc = Lex.getLoc(); 7865 unsigned GVId; 7866 if (ParseGVReference(VI, GVId)) 7867 return true; 7868 7869 // Keep track of the Refs array index needing a forward reference. 7870 // We will save the location of the ValueInfo needing an update, but 7871 // can only do so once the std::vector is finalized. 7872 if (VI == EmptyVI) 7873 IdToIndexMap[GVId].push_back(std::make_pair(Refs.size(), Loc)); 7874 Refs.push_back(VI); 7875 } while (EatIfPresent(lltok::comma)); 7876 7877 // Now that the Refs vector is finalized, it is safe to save the locations 7878 // of any forward GV references that need updating later. 7879 for (auto I : IdToIndexMap) { 7880 for (auto P : I.second) { 7881 assert(Refs[P.first] == EmptyVI && 7882 "Forward referenced ValueInfo expected to be empty"); 7883 auto FwdRef = ForwardRefValueInfos.insert(std::make_pair( 7884 I.first, std::vector<std::pair<ValueInfo *, LocTy>>())); 7885 FwdRef.first->second.push_back(std::make_pair(&Refs[P.first], P.second)); 7886 } 7887 } 7888 7889 if (ParseToken(lltok::rparen, "expected ')' in refs")) 7890 return true; 7891 7892 return false; 7893 } 7894 7895 /// OptionalTypeIdInfo 7896 /// := 'typeidinfo' ':' '(' [',' TypeTests]? [',' TypeTestAssumeVCalls]? 7897 /// [',' TypeCheckedLoadVCalls]? [',' TypeTestAssumeConstVCalls]? 7898 /// [',' TypeCheckedLoadConstVCalls]? ')' 7899 bool LLParser::ParseOptionalTypeIdInfo( 7900 FunctionSummary::TypeIdInfo &TypeIdInfo) { 7901 assert(Lex.getKind() == lltok::kw_typeIdInfo); 7902 Lex.Lex(); 7903 7904 if (ParseToken(lltok::colon, "expected ':' here") || 7905 ParseToken(lltok::lparen, "expected '(' in typeIdInfo")) 7906 return true; 7907 7908 do { 7909 switch (Lex.getKind()) { 7910 case lltok::kw_typeTests: 7911 if (ParseTypeTests(TypeIdInfo.TypeTests)) 7912 return true; 7913 break; 7914 case lltok::kw_typeTestAssumeVCalls: 7915 if (ParseVFuncIdList(lltok::kw_typeTestAssumeVCalls, 7916 TypeIdInfo.TypeTestAssumeVCalls)) 7917 return true; 7918 break; 7919 case lltok::kw_typeCheckedLoadVCalls: 7920 if (ParseVFuncIdList(lltok::kw_typeCheckedLoadVCalls, 7921 TypeIdInfo.TypeCheckedLoadVCalls)) 7922 return true; 7923 break; 7924 case lltok::kw_typeTestAssumeConstVCalls: 7925 if (ParseConstVCallList(lltok::kw_typeTestAssumeConstVCalls, 7926 TypeIdInfo.TypeTestAssumeConstVCalls)) 7927 return true; 7928 break; 7929 case lltok::kw_typeCheckedLoadConstVCalls: 7930 if (ParseConstVCallList(lltok::kw_typeCheckedLoadConstVCalls, 7931 TypeIdInfo.TypeCheckedLoadConstVCalls)) 7932 return true; 7933 break; 7934 default: 7935 return Error(Lex.getLoc(), "invalid typeIdInfo list type"); 7936 } 7937 } while (EatIfPresent(lltok::comma)); 7938 7939 if (ParseToken(lltok::rparen, "expected ')' in typeIdInfo")) 7940 return true; 7941 7942 return false; 7943 } 7944 7945 /// TypeTests 7946 /// ::= 'typeTests' ':' '(' (SummaryID | UInt64) 7947 /// [',' (SummaryID | UInt64)]* ')' 7948 bool LLParser::ParseTypeTests(std::vector<GlobalValue::GUID> &TypeTests) { 7949 assert(Lex.getKind() == lltok::kw_typeTests); 7950 Lex.Lex(); 7951 7952 if (ParseToken(lltok::colon, "expected ':' here") || 7953 ParseToken(lltok::lparen, "expected '(' in typeIdInfo")) 7954 return true; 7955 7956 IdToIndexMapType IdToIndexMap; 7957 do { 7958 GlobalValue::GUID GUID = 0; 7959 if (Lex.getKind() == lltok::SummaryID) { 7960 unsigned ID = Lex.getUIntVal(); 7961 LocTy Loc = Lex.getLoc(); 7962 // Keep track of the TypeTests array index needing a forward reference. 7963 // We will save the location of the GUID needing an update, but 7964 // can only do so once the std::vector is finalized. 7965 IdToIndexMap[ID].push_back(std::make_pair(TypeTests.size(), Loc)); 7966 Lex.Lex(); 7967 } else if (ParseUInt64(GUID)) 7968 return true; 7969 TypeTests.push_back(GUID); 7970 } while (EatIfPresent(lltok::comma)); 7971 7972 // Now that the TypeTests vector is finalized, it is safe to save the 7973 // locations of any forward GV references that need updating later. 7974 for (auto I : IdToIndexMap) { 7975 for (auto P : I.second) { 7976 assert(TypeTests[P.first] == 0 && 7977 "Forward referenced type id GUID expected to be 0"); 7978 auto FwdRef = ForwardRefTypeIds.insert(std::make_pair( 7979 I.first, std::vector<std::pair<GlobalValue::GUID *, LocTy>>())); 7980 FwdRef.first->second.push_back( 7981 std::make_pair(&TypeTests[P.first], P.second)); 7982 } 7983 } 7984 7985 if (ParseToken(lltok::rparen, "expected ')' in typeIdInfo")) 7986 return true; 7987 7988 return false; 7989 } 7990 7991 /// VFuncIdList 7992 /// ::= Kind ':' '(' VFuncId [',' VFuncId]* ')' 7993 bool LLParser::ParseVFuncIdList( 7994 lltok::Kind Kind, std::vector<FunctionSummary::VFuncId> &VFuncIdList) { 7995 assert(Lex.getKind() == Kind); 7996 Lex.Lex(); 7997 7998 if (ParseToken(lltok::colon, "expected ':' here") || 7999 ParseToken(lltok::lparen, "expected '(' here")) 8000 return true; 8001 8002 IdToIndexMapType IdToIndexMap; 8003 do { 8004 FunctionSummary::VFuncId VFuncId; 8005 if (ParseVFuncId(VFuncId, IdToIndexMap, VFuncIdList.size())) 8006 return true; 8007 VFuncIdList.push_back(VFuncId); 8008 } while (EatIfPresent(lltok::comma)); 8009 8010 if (ParseToken(lltok::rparen, "expected ')' here")) 8011 return true; 8012 8013 // Now that the VFuncIdList vector is finalized, it is safe to save the 8014 // locations of any forward GV references that need updating later. 8015 for (auto I : IdToIndexMap) { 8016 for (auto P : I.second) { 8017 assert(VFuncIdList[P.first].GUID == 0 && 8018 "Forward referenced type id GUID expected to be 0"); 8019 auto FwdRef = ForwardRefTypeIds.insert(std::make_pair( 8020 I.first, std::vector<std::pair<GlobalValue::GUID *, LocTy>>())); 8021 FwdRef.first->second.push_back( 8022 std::make_pair(&VFuncIdList[P.first].GUID, P.second)); 8023 } 8024 } 8025 8026 return false; 8027 } 8028 8029 /// ConstVCallList 8030 /// ::= Kind ':' '(' ConstVCall [',' ConstVCall]* ')' 8031 bool LLParser::ParseConstVCallList( 8032 lltok::Kind Kind, 8033 std::vector<FunctionSummary::ConstVCall> &ConstVCallList) { 8034 assert(Lex.getKind() == Kind); 8035 Lex.Lex(); 8036 8037 if (ParseToken(lltok::colon, "expected ':' here") || 8038 ParseToken(lltok::lparen, "expected '(' here")) 8039 return true; 8040 8041 IdToIndexMapType IdToIndexMap; 8042 do { 8043 FunctionSummary::ConstVCall ConstVCall; 8044 if (ParseConstVCall(ConstVCall, IdToIndexMap, ConstVCallList.size())) 8045 return true; 8046 ConstVCallList.push_back(ConstVCall); 8047 } while (EatIfPresent(lltok::comma)); 8048 8049 if (ParseToken(lltok::rparen, "expected ')' here")) 8050 return true; 8051 8052 // Now that the ConstVCallList vector is finalized, it is safe to save the 8053 // locations of any forward GV references that need updating later. 8054 for (auto I : IdToIndexMap) { 8055 for (auto P : I.second) { 8056 assert(ConstVCallList[P.first].VFunc.GUID == 0 && 8057 "Forward referenced type id GUID expected to be 0"); 8058 auto FwdRef = ForwardRefTypeIds.insert(std::make_pair( 8059 I.first, std::vector<std::pair<GlobalValue::GUID *, LocTy>>())); 8060 FwdRef.first->second.push_back( 8061 std::make_pair(&ConstVCallList[P.first].VFunc.GUID, P.second)); 8062 } 8063 } 8064 8065 return false; 8066 } 8067 8068 /// ConstVCall 8069 /// ::= '(' VFuncId ',' Args ')' 8070 bool LLParser::ParseConstVCall(FunctionSummary::ConstVCall &ConstVCall, 8071 IdToIndexMapType &IdToIndexMap, unsigned Index) { 8072 if (ParseToken(lltok::lparen, "expected '(' here") || 8073 ParseVFuncId(ConstVCall.VFunc, IdToIndexMap, Index)) 8074 return true; 8075 8076 if (EatIfPresent(lltok::comma)) 8077 if (ParseArgs(ConstVCall.Args)) 8078 return true; 8079 8080 if (ParseToken(lltok::rparen, "expected ')' here")) 8081 return true; 8082 8083 return false; 8084 } 8085 8086 /// VFuncId 8087 /// ::= 'vFuncId' ':' '(' (SummaryID | 'guid' ':' UInt64) ',' 8088 /// 'offset' ':' UInt64 ')' 8089 bool LLParser::ParseVFuncId(FunctionSummary::VFuncId &VFuncId, 8090 IdToIndexMapType &IdToIndexMap, unsigned Index) { 8091 assert(Lex.getKind() == lltok::kw_vFuncId); 8092 Lex.Lex(); 8093 8094 if (ParseToken(lltok::colon, "expected ':' here") || 8095 ParseToken(lltok::lparen, "expected '(' here")) 8096 return true; 8097 8098 if (Lex.getKind() == lltok::SummaryID) { 8099 VFuncId.GUID = 0; 8100 unsigned ID = Lex.getUIntVal(); 8101 LocTy Loc = Lex.getLoc(); 8102 // Keep track of the array index needing a forward reference. 8103 // We will save the location of the GUID needing an update, but 8104 // can only do so once the caller's std::vector is finalized. 8105 IdToIndexMap[ID].push_back(std::make_pair(Index, Loc)); 8106 Lex.Lex(); 8107 } else if (ParseToken(lltok::kw_guid, "expected 'guid' here") || 8108 ParseToken(lltok::colon, "expected ':' here") || 8109 ParseUInt64(VFuncId.GUID)) 8110 return true; 8111 8112 if (ParseToken(lltok::comma, "expected ',' here") || 8113 ParseToken(lltok::kw_offset, "expected 'offset' here") || 8114 ParseToken(lltok::colon, "expected ':' here") || 8115 ParseUInt64(VFuncId.Offset) || 8116 ParseToken(lltok::rparen, "expected ')' here")) 8117 return true; 8118 8119 return false; 8120 } 8121 8122 /// GVFlags 8123 /// ::= 'flags' ':' '(' 'linkage' ':' OptionalLinkageAux ',' 8124 /// 'notEligibleToImport' ':' Flag ',' 'live' ':' Flag ',' 8125 /// 'dsoLocal' ':' Flag ')' 8126 bool LLParser::ParseGVFlags(GlobalValueSummary::GVFlags &GVFlags) { 8127 assert(Lex.getKind() == lltok::kw_flags); 8128 Lex.Lex(); 8129 8130 bool HasLinkage; 8131 if (ParseToken(lltok::colon, "expected ':' here") || 8132 ParseToken(lltok::lparen, "expected '(' here") || 8133 ParseToken(lltok::kw_linkage, "expected 'linkage' here") || 8134 ParseToken(lltok::colon, "expected ':' here")) 8135 return true; 8136 8137 GVFlags.Linkage = parseOptionalLinkageAux(Lex.getKind(), HasLinkage); 8138 assert(HasLinkage && "Linkage not optional in summary entry"); 8139 Lex.Lex(); 8140 8141 unsigned Flag; 8142 if (ParseToken(lltok::comma, "expected ',' here") || 8143 ParseToken(lltok::kw_notEligibleToImport, 8144 "expected 'notEligibleToImport' here") || 8145 ParseToken(lltok::colon, "expected ':' here") || ParseFlag(Flag)) 8146 return true; 8147 GVFlags.NotEligibleToImport = Flag; 8148 8149 if (ParseToken(lltok::comma, "expected ',' here") || 8150 ParseToken(lltok::kw_live, "expected 'live' here") || 8151 ParseToken(lltok::colon, "expected ':' here") || ParseFlag(Flag)) 8152 return true; 8153 GVFlags.Live = Flag; 8154 8155 if (ParseToken(lltok::comma, "expected ',' here") || 8156 ParseToken(lltok::kw_dsoLocal, "expected 'dsoLocal' here") || 8157 ParseToken(lltok::colon, "expected ':' here") || ParseFlag(Flag)) 8158 return true; 8159 GVFlags.DSOLocal = Flag; 8160 8161 if (ParseToken(lltok::rparen, "expected ')' here")) 8162 return true; 8163 8164 return false; 8165 } 8166 8167 /// ModuleReference 8168 /// ::= 'module' ':' UInt 8169 bool LLParser::ParseModuleReference(StringRef &ModulePath) { 8170 // Parse module id. 8171 if (ParseToken(lltok::kw_module, "expected 'module' here") || 8172 ParseToken(lltok::colon, "expected ':' here") || 8173 ParseToken(lltok::SummaryID, "expected module ID")) 8174 return true; 8175 8176 unsigned ModuleID = Lex.getUIntVal(); 8177 auto I = ModuleIdMap.find(ModuleID); 8178 // We should have already parsed all module IDs 8179 assert(I != ModuleIdMap.end()); 8180 ModulePath = I->second; 8181 return false; 8182 } 8183 8184 /// GVReference 8185 /// ::= SummaryID 8186 bool LLParser::ParseGVReference(ValueInfo &VI, unsigned &GVId) { 8187 if (ParseToken(lltok::SummaryID, "expected GV ID")) 8188 return true; 8189 8190 GVId = Lex.getUIntVal(); 8191 8192 // Check if we already have a VI for this GV 8193 if (GVId < NumberedValueInfos.size()) { 8194 assert(NumberedValueInfos[GVId] != EmptyVI); 8195 VI = NumberedValueInfos[GVId]; 8196 } else 8197 // We will create a forward reference to the stored location. 8198 VI = EmptyVI; 8199 8200 return false; 8201 } 8202