1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894
|
/*========================== begin_copyright_notice ============================
Copyright (C) 2020-2022 Intel Corporation
SPDX-License-Identifier: MIT
============================= end_copyright_notice ===========================*/
#include "vc/GenXCodeGen/GenXOCLRuntimeInfo.h"
#include "ConstantEncoder.h"
#include "GenX.h"
#include "GenXModule.h"
#include "GenXSubtarget.h"
#include "GenXTargetMachine.h"
#include "GenXUtil.h"
#include "OCLRuntimeInfoPrinter.h"
#include "vc/Utils/GenX/GlobalVariable.h"
#include "vc/Utils/GenX/InternalMetadata.h"
#include "vc/Utils/GenX/Printf.h"
#include "vc/Utils/GenX/RegCategory.h"
#include "llvm/GenXIntrinsics/GenXIntrinsics.h"
#include <visaBuilder_interface.h>
#include <llvm/CodeGen/TargetPassConfig.h>
#include <llvm/IR/Argument.h>
#include <llvm/IR/Constants.h>
#include <llvm/IR/DataLayout.h>
#include <llvm/IR/Type.h>
#include <llvm/IR/Value.h>
#include <llvm/InitializePasses.h>
#include <algorithm>
#include <cctype>
#include <functional>
#include <iterator>
#include <numeric>
#include <stack>
#include "Probe/Assertion.h"
#define CISA_CALL(c) \
do { \
auto Result = (c); \
(void)Result; \
IGC_ASSERT_MESSAGE(Result == 0, "Call to VISA API failed: " #c); \
} while (0);
using namespace llvm;
char GenXOCLRuntimeInfo::ID = 0;
//===----------------------------------------------------------------------===//
//
// Kernel argument info implementation.
//
//===----------------------------------------------------------------------===//
// Supported kernel argument attributes.
struct OCLAttributes {
// Type qualifiers for resources.
static constexpr auto ReadOnly = "read_only";
static constexpr auto WriteOnly = "write_only";
static constexpr auto ReadWrite = "read_write";
// Buffer surface.
static constexpr auto Buffer = "buffer_t";
// SVM pointer to buffer.
static constexpr auto SVM = "svmptr_t";
// OpenCL-like types.
static constexpr auto Sampler = "sampler_t";
static constexpr auto Image1d = "image1d_t";
static constexpr auto Image1dArray = "image1d_array_t";
// Same as 1D image. Seems that there is no difference in runtime.
static constexpr auto Image1dBuffer = "image1d_buffer_t";
static constexpr auto Image2d = "image2d_t";
static constexpr auto Image2dArray = "image2d_array_t";
static constexpr auto Image2dMediaBlock = "image2d_media_block_t";
static constexpr auto Image3d = "image3d_t";
};
namespace llvm {
class KernelArgBuilder final {
using ArgKindType = GenXOCLRuntimeInfo::KernelArgInfo::KindType;
using ArgAccessKindType = GenXOCLRuntimeInfo::KernelArgInfo::AccessKindType;
const vc::KernelMetadata &KM;
const DataLayout &DL;
const GenXSubtarget &ST;
const GenXBackendConfig &BC;
public:
KernelArgBuilder(const vc::KernelMetadata &KMIn, const DataLayout &DLIn,
const GenXSubtarget &STIn, const GenXBackendConfig &BCIn)
: KM(KMIn), DL(DLIn), ST(STIn), BC(BCIn) {}
GenXOCLRuntimeInfo::KernelArgInfo
translateArgument(const Argument &Arg) const;
private:
static auto getStrPred(const char *Attr) {
return [Attr](StringRef Token) { return Token == Attr; };
}
ArgKindType getOCLArgKind(ArrayRef<StringRef> Tokens, unsigned ArgNo) const;
ArgAccessKindType getOCLArgAccessKind(ArrayRef<StringRef> Tokens,
ArgKindType Kind) const;
std::pair<ArgKindType, ArgAccessKindType>
translateArgDesc(unsigned ArgNo) const;
unsigned getArgSizeInBytes(const Argument &Arg) const;
};
} // namespace llvm
KernelArgBuilder::ArgAccessKindType
KernelArgBuilder::getOCLArgAccessKind(ArrayRef<StringRef> Tokens,
ArgKindType Kind) const {
switch (Kind) {
case ArgKindType::Buffer:
case ArgKindType::Image1D:
case ArgKindType::Image1DArray:
case ArgKindType::Image2D:
case ArgKindType::Image2DArray:
case ArgKindType::Image2DMediaBlock:
case ArgKindType::Image3D:
case ArgKindType::SVM:
case ArgKindType::BindlessBuffer:
if (any_of(Tokens, getStrPred(OCLAttributes::ReadOnly)))
return ArgAccessKindType::ReadOnly;
if (any_of(Tokens, getStrPred(OCLAttributes::WriteOnly)))
return ArgAccessKindType::WriteOnly;
return ArgAccessKindType::ReadWrite;
default:
return ArgAccessKindType::None;
}
}
KernelArgBuilder::ArgKindType
KernelArgBuilder::getOCLArgKind(ArrayRef<StringRef> Tokens,
unsigned ArgNo) const {
unsigned RawKind = KM.getArgKind(ArgNo);
// Implicit arguments.
if (vc::isLocalSizeKind(RawKind))
return ArgKindType::LocalSize;
if (vc::isGroupCountKind(RawKind))
return ArgKindType::GroupCount;
if (vc::isPrintBufferKind(RawKind))
return ArgKindType::PrintBuffer;
if (vc::isPrivateBaseKind(RawKind))
return ArgKindType::PrivateBase;
if (vc::isByValSVMKind(RawKind))
return ArgKindType::ByValSVM;
if (vc::isImplicitArgsBufferKind(RawKind))
return ArgKindType::ImplicitArgsBuffer;
// Explicit arguments.
switch (KM.getArgCategory(ArgNo)) {
default:
return ArgKindType::General;
case vc::RegCategory::General:
if (any_of(Tokens, getStrPred(OCLAttributes::SVM)))
return ArgKindType::SVM;
// Bindless buffers have general category but buffer annotation.
if (any_of(Tokens, getStrPred(OCLAttributes::Buffer)))
return ArgKindType::BindlessBuffer;
return ArgKindType::General;
case vc::RegCategory::Surface:
if (any_of(Tokens, getStrPred(OCLAttributes::Image1d)))
return ArgKindType::Image1D;
if (any_of(Tokens, getStrPred(OCLAttributes::Image1dArray)))
return ArgKindType::Image1DArray;
if (any_of(Tokens, getStrPred(OCLAttributes::Image1dBuffer)))
return ArgKindType::Image1D;
if (any_of(Tokens, getStrPred(OCLAttributes::Image2d))) {
if (BC.usePlain2DImages())
return ArgKindType::Image2D;
// Legacy behavior to treat all 2d images as media block.
return ArgKindType::Image2DMediaBlock;
}
if (any_of(Tokens, getStrPred(OCLAttributes::Image2dArray)))
return ArgKindType::Image2DArray;
if (any_of(Tokens, getStrPred(OCLAttributes::Image2dMediaBlock))) {
if (ST.translateLegacyMessages())
return ArgKindType::Image2D;
return ArgKindType::Image2DMediaBlock;
}
if (any_of(Tokens, getStrPred(OCLAttributes::Image3d)))
return ArgKindType::Image3D;
return ArgKindType::Buffer;
case vc::RegCategory::Sampler:
return ArgKindType::Sampler;
}
}
// Retrieve Kind and AccessKind from given ArgTypeDesc in metadata.
std::pair<KernelArgBuilder::ArgKindType, KernelArgBuilder::ArgAccessKindType>
KernelArgBuilder::translateArgDesc(unsigned ArgNo) const {
std::string Translated{KM.getArgTypeDesc(ArgNo)};
// Transform each separator to space.
std::transform(Translated.begin(), Translated.end(), Translated.begin(),
[](char C) {
if (C != '-' && C != '_' && C != '=' && !std::isalnum(C))
return ' ';
return C;
});
// Split and delete duplicates.
SmallVector<StringRef, 4> Tokens;
StringRef(Translated)
.split(Tokens, ' ', -1 /* MaxSplit */, false /* AllowEmpty */);
std::sort(Tokens.begin(), Tokens.end());
Tokens.erase(std::unique(Tokens.begin(), Tokens.end()), Tokens.end());
const ArgKindType Kind = getOCLArgKind(Tokens, ArgNo);
const ArgAccessKindType AccessKind = getOCLArgAccessKind(Tokens, Kind);
return {Kind, AccessKind};
}
unsigned KernelArgBuilder::getArgSizeInBytes(const Argument &Arg) const {
Type *ArgTy = Arg.getType();
if (ArgTy->isPointerTy())
return DL.getPointerTypeSize(ArgTy);
if (KM.isBufferType(Arg.getArgNo()))
return DL.getPointerSize();
return ArgTy->getPrimitiveSizeInBits() / genx::ByteBits;
}
GenXOCLRuntimeInfo::KernelArgInfo
KernelArgBuilder::translateArgument(const Argument &Arg) const {
GenXOCLRuntimeInfo::KernelArgInfo Info;
const unsigned ArgNo = Arg.getArgNo();
std::tie(Info.Kind, Info.AccessKind) = translateArgDesc(ArgNo);
Info.Offset = KM.getArgOffset(ArgNo);
Info.SizeInBytes = getArgSizeInBytes(Arg);
Info.BTI = KM.getBTI(ArgNo);
// For implicit arguments that are byval argument linearization, index !=
// ArgNo in the IR function.
Info.Index = KM.getArgIndex(ArgNo);
// Linearization arguments have a non-zero offset in the original explicit
// byval arg.
Info.OffsetInArg = KM.getOffsetInArg(ArgNo);
return Info;
}
//===----------------------------------------------------------------------===//
//
// Kernel info implementation.
//
//===----------------------------------------------------------------------===//
// Just perform linear instructions scan to find usage stats.
void GenXOCLRuntimeInfo::KernelInfo::setInstructionUsageProperties(
const FunctionGroup &FG, const GenXBackendConfig &BC) {
for (Function *F : FG) {
for (BasicBlock &BB : *F) {
for (Instruction &I : BB) {
switch (GenXIntrinsic::getGenXIntrinsicID(&I)) {
default:
break;
case GenXIntrinsic::genx_group_id_x:
case GenXIntrinsic::genx_group_id_y:
case GenXIntrinsic::genx_group_id_z:
UsesGroupId = true;
break;
case GenXIntrinsic::genx_barrier:
case GenXIntrinsic::genx_sbarrier:
NumBarriers = 1;
break;
case GenXIntrinsic::genx_ssdp4a:
case GenXIntrinsic::genx_sudp4a:
case GenXIntrinsic::genx_usdp4a:
case GenXIntrinsic::genx_uudp4a:
case GenXIntrinsic::genx_ssdp4a_sat:
case GenXIntrinsic::genx_sudp4a_sat:
case GenXIntrinsic::genx_usdp4a_sat:
case GenXIntrinsic::genx_uudp4a_sat:
case GenXIntrinsic::genx_dpas:
case GenXIntrinsic::genx_dpas2:
case GenXIntrinsic::genx_dpasw:
case GenXIntrinsic::genx_dpas_nosrc0:
case GenXIntrinsic::genx_dpasw_nosrc0:
UsesDPAS = true;
break;
#if 0
// ThreadPrivateMemSize was not copied to igcmc structures
// always defaulting to zero and everything worked. After
// removal of igcmc structures TPMSize started to be
// initialized to values other than zero and some ispc tests
// started to fail.
// Restore old behavior as temporary fix until proper
// investigation will be performed. This is really strange.
case GenXIntrinsic::genx_alloca:
ThreadPrivateMemSize = BC.getStackSurfaceMaxSize();
break;
#endif
}
}
}
}
}
void GenXOCLRuntimeInfo::KernelInfo::setMetadataProperties(
vc::KernelMetadata &KM, const GenXSubtarget &ST) {
Name = KM.getName().str();
SLMSize = KM.getSLMSize();
if (ST.hasNBarrier())
NumBarriers = KM.getAlignedBarrierCnt(NumBarriers);
}
void GenXOCLRuntimeInfo::KernelInfo::setArgumentProperties(
const Function &Kernel, const vc::KernelMetadata &KM,
const GenXSubtarget &ST, const GenXBackendConfig &BC) {
IGC_ASSERT_MESSAGE(Kernel.arg_size() == KM.getNumArgs(),
"Expected same number of arguments");
// Some arguments are part of thread payload and do not require
// entries in arguments info for OCL runtime.
auto NonPayloadArgs =
make_filter_range(Kernel.args(), [&KM](const Argument &Arg) {
uint32_t ArgKind = KM.getArgKind(Arg.getArgNo());
return !vc::isLocalIDKind(ArgKind);
});
KernelArgBuilder ArgBuilder{KM, Kernel.getParent()->getDataLayout(), ST, BC};
transform(NonPayloadArgs, std::back_inserter(ArgInfos),
[&ArgBuilder](const Argument &Arg) {
return ArgBuilder.translateArgument(Arg);
});
UsesReadWriteImages = std::any_of(
ArgInfos.begin(), ArgInfos.end(), [](const KernelArgInfo &AI) {
return AI.isImage() &&
AI.getAccessKind() == KernelArgInfo::AccessKindType::ReadWrite;
});
}
void GenXOCLRuntimeInfo::KernelInfo::setPrintStrings(
const Module &KernelModule) {
const auto *StringsMeta = KernelModule.getNamedMetadata("cm_print_strings");
if (!StringsMeta)
return;
std::transform(StringsMeta->op_begin(), StringsMeta->op_end(),
std::back_inserter(PrintStrings), [](const auto *StringMeta) {
StringRef Str =
cast<MDString>(StringMeta->getOperand(0))->getString();
return std::string{Str.begin(), Str.end()};
});
}
GenXOCLRuntimeInfo::KernelInfo::KernelInfo(const GenXSubtarget &ST)
: Name{"Intel_Symbol_Table_Void_Program"}, GRFSizeInBytes{
ST.getGRFByteSize()} {}
GenXOCLRuntimeInfo::KernelInfo::KernelInfo(const FunctionGroup &FG,
const GenXSubtarget &ST,
const GenXBackendConfig &BC) {
setInstructionUsageProperties(FG, BC);
GRFSizeInBytes = ST.getGRFByteSize();
StatelessPrivateMemSize =
vc::getStackAmount(FG.getHead(), BC.getStatelessPrivateMemSize());
SupportsDebugging = BC.emitDebuggableKernels();
DisableEUFusion = BC.isDisableEUFusion();
vc::KernelMetadata KM{FG.getHead()};
IGC_ASSERT_MESSAGE(KM.isKernel(), "Expected kernel as head of function group");
setMetadataProperties(KM, ST);
setArgumentProperties(*FG.getHead(), KM, ST, BC);
setPrintStrings(*FG.getHead()->getParent());
}
//===----------------------------------------------------------------------===//
//
// Compiled kernel implementation.
//
//===----------------------------------------------------------------------===//
GenXOCLRuntimeInfo::CompiledKernel::CompiledKernel(KernelInfo &&KI,
const FINALIZER_INFO &JI,
const GTPinInfo &GI,
std::vector<char> DbgInfoIn)
: CompilerInfo(std::move(KI)), JitterInfo(JI),
GtpinInfo(GI),
DebugInfo{std::move(DbgInfoIn)} {
}
//===----------------------------------------------------------------------===//
//
// Runtime info pass implementation.
//
//===----------------------------------------------------------------------===//
namespace {
// Relates to GenXOCLRuntimeInfo::SectionInfo. GenXOCLRuntimeInfo::SectionInfo
// can be created from this struct.
struct RawSectionInfo {
genx::BinaryDataAccumulator<const GlobalValue *> Data;
GenXOCLRuntimeInfo::RelocationSeq Relocations;
};
struct GVEncodingInfo {
const GlobalVariable *GV;
// Alignment requirments of a global variable that will be encoded after
// the considered GV variable.
unsigned NextGVAlignment;
};
struct ModuleDataT {
RawSectionInfo Constant;
RawSectionInfo Global;
RawSectionInfo ConstString;
ModuleDataT() = default;
ModuleDataT(const Module &M);
};
template <vISA::GenSymType SymbolClass, typename InputIter, typename OutputIter>
void constructSymbols(InputIter First, InputIter Last, OutputIter Out) {
std::transform(First, Last, Out, [](const auto &Section) -> vISA::ZESymEntry {
return {SymbolClass, static_cast<uint32_t>(Section.Info.Offset),
static_cast<uint32_t>(Section.Info.getSize()),
Section.Key->getName().str()};
});
}
static GenXOCLRuntimeInfo::SymbolSeq constructFunctionSymbols(
genx::BinaryDataAccumulator<const GlobalValue *> &GenBinary,
bool HasKernel) {
GenXOCLRuntimeInfo::SymbolSeq Symbols;
if (GenBinary.begin() == GenBinary.end())
return Symbols;
Symbols.reserve(GenBinary.getNumSections());
if (HasKernel) {
auto &KernelSection = GenBinary.front();
Symbols.emplace_back(vISA::GenSymType::S_KERNEL, KernelSection.Info.Offset,
KernelSection.Info.getSize(),
KernelSection.Key->getName().str());
}
// Skipping first section if binary has a kernel.
constructSymbols<vISA::GenSymType::S_FUNC>(
HasKernel ? std::next(GenBinary.begin()) : GenBinary.begin(),
GenBinary.end(), std::back_inserter(Symbols));
return Symbols;
}
} // namespace
// Appends the binary of function/kernel represented by \p Func and \p BuiltFunc
// to \p GenBinary.
static void
appendFuncBinary(genx::BinaryDataAccumulator<const GlobalValue *> &GenBinary,
const Function &Func, const VISAKernel &BuiltFunc) {
void *GenBin = nullptr;
int GenBinSize = 0;
CISA_CALL(BuiltFunc.GetGenxBinary(GenBin, GenBinSize));
IGC_ASSERT_MESSAGE(GenBin,
"Unexpected null buffer or zero-sized kernel (compilation failed?)");
IGC_ASSERT_MESSAGE(GenBinSize,
"Unexpected null buffer or zero-sized kernel (compilation failed?)");
GenBinary.append(&Func, ArrayRef<uint8_t>{static_cast<uint8_t *>(GenBin),
static_cast<size_t>(GenBinSize)});
freeBlock(GenBin);
}
// Loads if it is possible external files.
// Returns the success status of the loading.
static bool loadGenBinaryFromFile(
genx::BinaryDataAccumulator<const GlobalValue *> &GenBinary,
const Function &F, vc::ShaderOverrider const &Loader,
vc::ShaderOverrider::Extensions Ext) {
void *GenBin = nullptr;
int GenBinSize = 0;
if (!Loader.override(GenBin, GenBinSize, F.getName(), Ext))
return false;
if (!GenBin || !GenBinSize) {
llvm::errs()
<< "Unexpected null buffer or zero-sized kernel (loading failed?)\n";
return false;
}
GenBinary.append(&F, ArrayRef<uint8_t>{static_cast<uint8_t *>(GenBin),
static_cast<size_t>(GenBinSize)});
freeBlock(GenBin);
return true;
}
// Constructs gen binary for Function but loading is from injected file.
// Returns the success status of the overriding.
static bool
tryOverrideBinary(genx::BinaryDataAccumulator<const GlobalValue *> &GenBinary,
const Function &F, vc::ShaderOverrider const &Loader) {
using Extensions = vc::ShaderOverrider::Extensions;
// Attempts to override .asm
if (loadGenBinaryFromFile(GenBinary, F, Loader, Extensions::ASM))
return true;
// If it has failed then attempts to override .dat file
return loadGenBinaryFromFile(GenBinary, F, Loader, Extensions::DAT);
}
template <typename UnaryPred>
std::vector<const Function *> collectCalledFunctions(const FunctionGroup &FG,
UnaryPred &&Pred) {
std::vector<const Function *> Collected;
std::set<const FunctionGroup *> Visited;
std::stack<const FunctionGroup *> Worklist;
Worklist.push(&FG);
while (!Worklist.empty()) {
const FunctionGroup *CurFG = Worklist.top();
Worklist.pop();
if (Visited.count(CurFG))
continue;
for (const FunctionGroup *SubFG : CurFG->subgroups())
Worklist.push(SubFG);
Visited.insert(CurFG);
const Function *SubgroupHead = CurFG->getHead();
if (Pred(SubgroupHead))
Collected.push_back(SubgroupHead);
}
return Collected;
}
// Appends relocations of \p Func to \p SectionRelocations. Added relocations
// are shifted by \p Offset.
static void
appendTextRelocations(GenXOCLRuntimeInfo::RelocationSeq &SectionRelocations,
VISAKernel &Func, std::size_t Offset) {
if (!Offset) {
CISA_CALL(Func.GetRelocations(SectionRelocations));
return;
}
GenXOCLRuntimeInfo::RelocationSeq FuncRelocations;
CISA_CALL(Func.GetRelocations(FuncRelocations));
vc::shiftRelocations(FuncRelocations.begin(), FuncRelocations.end(),
std::back_inserter(SectionRelocations), Offset);
}
// Either loads binary from VISABuilder or overrides from file.
static void loadBinary(RawSectionInfo &TextSection, VISABuilder &VB,
const FunctionGroup &FG, const GenXBackendConfig &BC) {
const Function &F = *FG.getHead();
// Attempt to override
if (BC.hasShaderOverrider() &&
tryOverrideBinary(TextSection.Data, F, BC.getShaderOverrider()))
return;
// If there is no overriding or attemp fails, then gets binary from
// compilation
VISAKernel *BuiltKernel = VB.GetVISAKernel(F.getName().str());
IGC_ASSERT_MESSAGE(BuiltKernel, "Kernel is null");
appendTextRelocations(TextSection.Relocations, *BuiltKernel,
TextSection.Data.getFullSize());
appendFuncBinary(TextSection.Data, F, *BuiltKernel);
}
static unsigned getAlignment(const GlobalVariable &GV) {
unsigned Align = GV.getAlignment();
if (Align)
return Align;
return GV.getParent()->getDataLayout().getABITypeAlignment(GV.getValueType());
}
static void appendGlobalVariableData(RawSectionInfo &Sect,
const GlobalVariable &GV,
const DataLayout &DL) {
std::vector<char> Data;
GenXOCLRuntimeInfo::RelocationSeq Relocations;
vc::encodeConstant(*GV.getInitializer(), DL, std::back_inserter(Data),
std::back_inserter(Relocations));
Sect.Data.append(&GV, Data.begin(), Data.end(), getAlignment(GV));
// vc::encodeConstant calculates offsets relative to GV. Need to make it
// relative to section start.
vc::shiftRelocations(std::make_move_iterator(Relocations.begin()),
std::make_move_iterator(Relocations.end()),
std::back_inserter(Sect.Relocations),
Sect.Data.back().Info.Offset);
}
// Fetches DWARF data associated with the specified function.
// Empty vector is returned if none is found.
static GenXDebugInfo::ElfBin getDebugInformation(const GenXDebugInfo &Dbg,
const Function *F) {
const auto &DbgInfoStorage = Dbg.getModuleDebug();
auto DbgInfoIt = DbgInfoStorage.find(F);
if (DbgInfoIt == DbgInfoStorage.end())
return {};
const auto &ElfImage = DbgInfoIt->second;
return {ElfImage.begin(), ElfImage.end()};
}
static GenXDebugInfo::ElfBin getDebugInfoForIndirectFunctions(
const GenXDebugInfo &Dbg, const std::vector<FunctionGroup *> &Subgroups) {
if (Subgroups.empty())
return {};
// FIXME: current implementation does not properly handle debug information
// in the presence of indirect calls. Several indirect functions are
// embedded into one "section" - which means that the associated DWARF file
// should contain information about all of them. Currently, we provide DWARF
// info only about the first function.
return getDebugInformation(Dbg, Subgroups.front()->getHead());
}
ModuleDataT::ModuleDataT(const Module &M) {
auto RealGlobals =
make_filter_range(M.globals(), [](const GlobalVariable &GV) {
return vc::isRealGlobalVariable(GV);
});
for (auto &GV : RealGlobals) {
if (GV.isConstant()) {
if (GV.hasAttribute(vc::PrintfStringVariable))
// This section is always empty for oclbin flow. This happens because
// of printf legalization that separates globals that will be indexed
// and real globals. Only indexed globals are left marked as printf
// strings but indexed strings aren't real global variables so they're
// skipped here. Indexed strings are handled separately.
appendGlobalVariableData(ConstString, GV, M.getDataLayout());
else
appendGlobalVariableData(Constant, GV, M.getDataLayout());
} else {
IGC_ASSERT_MESSAGE(!GV.hasAttribute(vc::PrintfStringVariable),
"non-const global variable cannot be a printf string");
appendGlobalVariableData(Global, GV, M.getDataLayout());
}
}
}
static GenXOCLRuntimeInfo::ModuleInfoT getModuleInfo(const Module &M) {
ModuleDataT ModuleData{M};
GenXOCLRuntimeInfo::ModuleInfoT ModuleInfo;
constructSymbols<vISA::GenSymType::S_GLOBAL_VAR_CONST>(
ModuleData.Constant.Data.begin(), ModuleData.Constant.Data.end(),
std::back_inserter(ModuleInfo.Constant.Symbols));
constructSymbols<vISA::GenSymType::S_GLOBAL_VAR>(
ModuleData.Global.Data.begin(), ModuleData.Global.Data.end(),
std::back_inserter(ModuleInfo.Global.Symbols));
constructSymbols<vISA::GenSymType::S_GLOBAL_VAR_CONST>(
ModuleData.ConstString.Data.begin(), ModuleData.ConstString.Data.end(),
std::back_inserter(ModuleInfo.ConstString.Symbols));
ModuleInfo.Constant.Relocations = std::move(ModuleData.Constant.Relocations);
ModuleInfo.Global.Relocations = std::move(ModuleData.Global.Relocations);
ModuleInfo.ConstString.Relocations =
std::move(ModuleData.ConstString.Relocations);
ModuleInfo.Constant.Data.Buffer =
std::move(ModuleData.Constant.Data).emitConsolidatedData();
// IGC always sets 0
ModuleInfo.Constant.Data.Alignment = 0;
ModuleInfo.Constant.Data.AdditionalZeroedSpace = 0;
ModuleInfo.Global.Data.Buffer =
std::move(ModuleData.Global.Data).emitConsolidatedData();
ModuleInfo.Global.Data.Alignment = 0;
ModuleInfo.Global.Data.AdditionalZeroedSpace = 0;
ModuleInfo.ConstString.Data.Buffer =
std::move(ModuleData.ConstString.Data).emitConsolidatedData();
ModuleInfo.ConstString.Data.Alignment = 0;
ModuleInfo.ConstString.Data.AdditionalZeroedSpace = 0;
return std::move(ModuleInfo);
}
namespace {
class RuntimeInfoCollector final {
const FunctionGroupAnalysis &FGA;
const GenXBackendConfig &BC;
VISABuilder &VB;
const GenXSubtarget &ST;
const Module &M;
const GenXDebugInfo &DBG;
public:
using KernelStorageTy = GenXOCLRuntimeInfo::KernelStorageTy;
using CompiledKernel = GenXOCLRuntimeInfo::CompiledKernel;
using CompiledModuleT = GenXOCLRuntimeInfo::CompiledModuleT;
public:
RuntimeInfoCollector(const FunctionGroupAnalysis &InFGA,
const GenXBackendConfig &InBC, VISABuilder &InVB,
const GenXSubtarget &InST, const Module &InM,
const GenXDebugInfo &InDbg)
: FGA{InFGA}, BC{InBC}, VB{InVB}, ST{InST}, M{InM}, DBG{InDbg} {}
CompiledModuleT run();
private:
CompiledKernel collectFunctionGroupInfo(const FunctionGroup &FG) const;
// Collects all subgroups info in a dummy kernel. Also stores visaasm for the
// whole module in this dummy kernel.
template <typename Range>
CompiledKernel
collectFunctionSubgroupsInfo(const std::vector<FunctionGroup *> &Subgroups,
const Range &DeclsRange) const;
};
} // namespace
RuntimeInfoCollector::CompiledModuleT RuntimeInfoCollector::run() {
KernelStorageTy Kernels;
std::transform(FGA.begin(), FGA.end(), std::back_inserter(Kernels),
[this](const FunctionGroup *FG) {
return collectFunctionGroupInfo(*FG);
});
std::vector<FunctionGroup *> IndirectlyReferencedFuncs;
std::copy_if(FGA.subgroup_begin(), FGA.subgroup_end(),
std::back_inserter(IndirectlyReferencedFuncs),
[&BECfg = BC](const FunctionGroup *FG) {
return vc::isIndirect(FG->getHead()) &&
!BECfg.directCallsOnly(FG->getHead()->getName());
});
auto &&DeclsRange =
llvm::make_filter_range(M.functions(), [](const Function &F) {
if (!F.isDeclaration())
return false;
return vc::isIndirect(F);
});
if (!IndirectlyReferencedFuncs.empty() ||
DeclsRange.begin() != DeclsRange.end() || BC.emitZebinVisaSections())
Kernels.push_back(
collectFunctionSubgroupsInfo(IndirectlyReferencedFuncs, DeclsRange));
return {getModuleInfo(M), std::move(Kernels),
M.getDataLayout().getPointerSize()};
}
RuntimeInfoCollector::CompiledKernel
RuntimeInfoCollector::collectFunctionGroupInfo(const FunctionGroup &FG) const {
using KernelInfo = GenXOCLRuntimeInfo::KernelInfo;
using GTPinInfo = GenXOCLRuntimeInfo::GTPinInfo;
using CompiledKernel = GenXOCLRuntimeInfo::CompiledKernel;
// Compiler info.
KernelInfo Info{FG, ST, BC};
const Function *KernelFunction = FG.getHead();
const std::string KernelName = KernelFunction->getName().str();
VISAKernel *VK = VB.GetVISAKernel(KernelName);
IGC_ASSERT_MESSAGE(VK, "Kernel is null");
FINALIZER_INFO *JitInfo = nullptr;
CISA_CALL(VK->GetJitInfo(JitInfo));
IGC_ASSERT_MESSAGE(JitInfo, "Jit info is not set by finalizer");
// TODO: this a temporary solution for spill mem size
// calculation. This has to be redesign properly, maybe w/ multiple
// KernelInfos or by introducing FunctionInfos
const auto StackCalls = collectCalledFunctions(
FG, [](const Function *F) { return vc::requiresStackCall(F); });
for (const Function *F : StackCalls) {
const std::string FuncName = F->getName().str();
VISAKernel *VF = VB.GetVISAKernel(FuncName);
IGC_ASSERT_MESSAGE(VF, "Function is null");
FINALIZER_INFO *FuncJitInfo = nullptr;
CISA_CALL(VF->GetJitInfo(FuncJitInfo));
IGC_ASSERT_MESSAGE(FuncJitInfo, "Func jit info is not set by finalizer");
JitInfo->isSpill |= FuncJitInfo->isSpill;
JitInfo->hasStackcalls |= FuncJitInfo->hasStackcalls;
JitInfo->spillMemUsed += FuncJitInfo->spillMemUsed;
}
RawSectionInfo TextSection;
loadBinary(TextSection, VB, FG, BC);
auto DebugData = getDebugInformation(DBG, KernelFunction);
Info.Func.Relocations = TextSection.Relocations;
// Still have to duplicate function relocations because they are constructed
// inside Finalizer.
CISA_CALL(VK->GetGenRelocEntryBuffer(Info.LegacyFuncRelocations.Buffer,
Info.LegacyFuncRelocations.Size,
Info.LegacyFuncRelocations.Entries));
Info.Func.Symbols =
constructFunctionSymbols(TextSection.Data, /*HasKernel=*/true);
void *GTPinBuffer = nullptr;
unsigned GTPinBufferSize = 0;
CISA_CALL(VK->GetGTPinBuffer(GTPinBuffer, GTPinBufferSize));
auto *GTPinBytes = static_cast<char *>(GTPinBuffer);
GTPinInfo gtpin{GTPinBytes, GTPinBytes + GTPinBufferSize};
Info.Func.Data.Buffer = std::move(TextSection.Data).emitConsolidatedData();
return CompiledKernel{std::move(Info), *JitInfo, std::move(gtpin),
std::move(DebugData)};
}
// Goes through function groups in FGRange and collects their vISA asms into a
// string.
template <typename Range>
static std::vector<GenXOCLRuntimeInfo::KernelInfo::NamedVISAAsm>
collectVISAAsm(const VISABuilder &VB, Range &&FGRange) {
std::vector<GenXOCLRuntimeInfo::KernelInfo::NamedVISAAsm> VISAAsm;
std::transform(FGRange.begin(), FGRange.end(), std::back_inserter(VISAAsm),
[&VB](const FunctionGroup *FG) {
auto Name = FG->getName();
return std::make_pair(
Name.str(), VB.GetVISAKernel(Name.str())->getVISAAsm());
});
return VISAAsm;
}
template <typename Range>
RuntimeInfoCollector::CompiledKernel
RuntimeInfoCollector::collectFunctionSubgroupsInfo(
const std::vector<FunctionGroup *> &Subgroups,
const Range &DeclsRange) const {
using KernelInfo = GenXOCLRuntimeInfo::KernelInfo;
using CompiledKernel = GenXOCLRuntimeInfo::CompiledKernel;
IGC_ASSERT(!Subgroups.empty() || DeclsRange.begin() != DeclsRange.end() ||
BC.emitZebinVisaSections());
RawSectionInfo TextSection;
for (auto *FG : Subgroups) {
auto *Func = FG->getHead();
IGC_ASSERT(genx::fg::isSubGroupHead(*Func));
loadBinary(TextSection, VB, *FG, BC);
}
auto DebugInfo = getDebugInfoForIndirectFunctions(DBG, Subgroups);
KernelInfo Info{ST};
if (BC.emitZebinVisaSections())
Info.VISAAsm = collectVISAAsm(VB, FGA.AllGroups());
// FIXME: cannot initialize legacy relocations as the relocation structure is
// opaque and cannot be modified. But having multiple functions inside a
// section requires shifting (modifying) the relocations.
Info.Func.Relocations = TextSection.Relocations;
Info.Func.Symbols =
constructFunctionSymbols(TextSection.Data, /*HasKernel*/ false);
for (auto &&Decl : DeclsRange)
Info.Func.Symbols.emplace_back(vISA::GenSymType::S_UNDEF, 0, 0,
Decl.getName().str());
Info.Func.Data.Buffer = TextSection.Data.emitConsolidatedData();
return CompiledKernel{std::move(Info), FINALIZER_INFO{}, /*GtpinInfo*/ {},
DebugInfo};
}
void GenXOCLRuntimeInfo::getAnalysisUsage(AnalysisUsage &AU) const {
AU.addRequired<FunctionGroupAnalysis>();
AU.addRequired<GenXBackendConfig>();
AU.addRequired<GenXModule>();
AU.addRequired<GenXDebugInfo>();
AU.addRequired<TargetPassConfig>();
AU.setPreservesAll();
}
bool GenXOCLRuntimeInfo::runOnModule(Module &M) {
const auto &FGA = getAnalysis<FunctionGroupAnalysis>();
const auto &BC = getAnalysis<GenXBackendConfig>();
// Getters for builders are not constant.
auto &GM = getAnalysis<GenXModule>();
const auto &ST = getAnalysis<TargetPassConfig>()
.getTM<GenXTargetMachine>()
.getGenXSubtarget();
const auto &DBG = getAnalysis<GenXDebugInfo>();
VISABuilder &VB =
*((GM.HasInlineAsm() || !BC.getVISALTOStrings().empty()) ? GM.GetVISAAsmReader() : GM.GetCisaBuilder());
CompiledModule = RuntimeInfoCollector{FGA, BC, VB, ST, M, DBG}.run();
return false;
}
void GenXOCLRuntimeInfo::print(raw_ostream &OS, const Module *M) const {
vc::printOCLRuntimeInfo(OS, CompiledModule);
}
INITIALIZE_PASS_BEGIN(GenXOCLRuntimeInfo, "GenXOCLRuntimeInfo",
"GenXOCLRuntimeInfo", false, true)
INITIALIZE_PASS_DEPENDENCY(FunctionGroupAnalysis);
INITIALIZE_PASS_DEPENDENCY(GenXBackendConfig);
INITIALIZE_PASS_DEPENDENCY(GenXModule);
INITIALIZE_PASS_DEPENDENCY(GenXDebugInfo);
INITIALIZE_PASS_DEPENDENCY(TargetPassConfig);
INITIALIZE_PASS_END(GenXOCLRuntimeInfo, "GenXOCLRuntimeInfo",
"GenXOCLRuntimeInfo", false, true)
|