source: icGREP/icgrep-devel/icgrep/kernels/kernel.cpp @ 5501

Last change on this file since 5501 was 5501, checked in by cameron, 23 months ago

setCapacity/getCapacity/getLinearlyAvailableItems for SourceBuffer?

File size: 56.2 KB
RevLine 
[4924]1/*
2 *  Copyright (c) 2016 International Characters.
3 *  This software is licensed to the public under the Open Software License 3.0.
4 */
5
6#include "kernel.h"
[5425]7#include <toolchain/toolchain.h>
[5297]8#include <kernels/streamset.h>
9#include <llvm/IR/Constants.h>
10#include <llvm/IR/Function.h>
11#include <llvm/IR/Instructions.h>
[5350]12#include <llvm/IR/MDBuilder.h>
[5267]13#include <llvm/IR/Module.h>
14#include <llvm/Support/raw_ostream.h>
[5392]15#include <llvm/Bitcode/ReaderWriter.h>
[5350]16#include <llvm/Transforms/Utils/Local.h>
[5408]17#include <kernels/streamset.h>
18#include <sstream>
[5436]19#include <kernels/kernel_builder.h>
[4924]20
[5435]21using namespace llvm;
22using namespace parabix;
[5287]23
[5435]24namespace kernel {
[5287]25
[5435]26const std::string Kernel::DO_BLOCK_SUFFIX = "_DoBlock";
27const std::string Kernel::FINAL_BLOCK_SUFFIX = "_FinalBlock";
[5439]28const std::string Kernel::MULTI_BLOCK_SUFFIX = "_MultiBlock";
[5435]29const std::string Kernel::LOGICAL_SEGMENT_NO_SCALAR = "logicalSegNo";
30const std::string Kernel::PROCESSED_ITEM_COUNT_SUFFIX = "_processedItemCount";
31const std::string Kernel::CONSUMED_ITEM_COUNT_SUFFIX = "_consumedItemCount";
32const std::string Kernel::PRODUCED_ITEM_COUNT_SUFFIX = "_producedItemCount";
33const std::string Kernel::TERMINATION_SIGNAL = "terminationSignal";
34const std::string Kernel::BUFFER_PTR_SUFFIX = "_bufferPtr";
35const std::string Kernel::CONSUMER_SUFFIX = "_consumerLocks";
[5456]36const std::string Kernel::CYCLECOUNT_SCALAR = "CPUcycles";
[5292]37
[5435]38unsigned Kernel::addScalar(Type * const type, const std::string & name) {
[5063]39    if (LLVM_UNLIKELY(mKernelStateType != nullptr)) {
[5320]40        report_fatal_error("Cannot add field " + name + " to " + getName() + " after kernel state finalized");
[4924]41    }
[5283]42    if (LLVM_UNLIKELY(mKernelMap.count(name))) {
[5320]43        report_fatal_error(getName() + " already contains scalar field " + name);
[5283]44    }
[5227]45    const auto index = mKernelFields.size();
46    mKernelMap.emplace(name, index);
47    mKernelFields.push_back(type);
48    return index;
[4924]49}
[4968]50
[5435]51unsigned Kernel::addUnnamedScalar(Type * const type) {
[5283]52    if (LLVM_UNLIKELY(mKernelStateType != nullptr)) {
[5418]53        report_fatal_error("Cannot add unnamed field  to " + getName() + " after kernel state finalized");
[5283]54    }
55    const auto index = mKernelFields.size();
56    mKernelFields.push_back(type);
57    return index;
58}
59
[5435]60void Kernel::prepareStreamSetNameMap() {
[5299]61    for (unsigned i = 0; i < mStreamSetInputs.size(); i++) {
[5398]62        mStreamMap.emplace(mStreamSetInputs[i].name, std::make_pair(Port::Input, i));
[5299]63    }
64    for (unsigned i = 0; i < mStreamSetOutputs.size(); i++) {
[5398]65        mStreamMap.emplace(mStreamSetOutputs[i].name, std::make_pair(Port::Output, i));
[5299]66    }
67}
[5440]68
[5446]69void Kernel::bindPorts(const StreamSetBuffers & inputs, const StreamSetBuffers & outputs) {
[5440]70    assert (mModule == nullptr);
71    assert (mStreamSetInputBuffers.empty());
72    assert (mStreamSetOutputBuffers.empty());
73
74    if (LLVM_UNLIKELY(mStreamSetInputs.size() != inputs.size())) {
75        report_fatal_error(getName() + ": expected " + std::to_string(mStreamSetInputs.size()) +
76                           " input stream sets but was given "
77                           + std::to_string(inputs.size()));
78    }
79
80    for (unsigned i = 0; i < inputs.size(); ++i) {
81        StreamSetBuffer * const buf = inputs[i];
82        if (LLVM_UNLIKELY(buf == nullptr)) {
83            report_fatal_error(getName() + ": input stream set " + std::to_string(i)
84                               + " cannot be null");
85        }
86        buf->addConsumer(this);
87    }
88
89    if (LLVM_UNLIKELY(mStreamSetOutputs.size() != outputs.size())) {
90        report_fatal_error(getName() + ": expected " + std::to_string(mStreamSetOutputs.size())
91                           + " output stream sets but was given "
92                           + std::to_string(outputs.size()));
93    }
94
95    for (unsigned i = 0; i < outputs.size(); ++i) {
96        StreamSetBuffer * const buf = outputs[i];
97        if (LLVM_UNLIKELY(buf == nullptr)) {
98            report_fatal_error(getName() + ": output stream set " + std::to_string(i) + " cannot be null");
99        }
100        if (LLVM_LIKELY(buf->getProducer() == nullptr)) {
101            buf->setProducer(this);
102        } else {
103            report_fatal_error(getName() + ": output stream set " + std::to_string(i)
104                               + " is already produced by kernel " + buf->getProducer()->getName());
105        }
106    }
107
108    mStreamSetInputBuffers.assign(inputs.begin(), inputs.end());
109    mStreamSetOutputBuffers.assign(outputs.begin(), outputs.end());
[5446]110}
111
112Module * Kernel::makeModule(const std::unique_ptr<KernelBuilder> & idb) {
113    assert (mModule == nullptr);
114    std::stringstream cacheName;   
115    cacheName << getName() << '_' << idb->getBuilderUniqueName();
116    for (const StreamSetBuffer * b: mStreamSetInputBuffers) {
117        cacheName <<  ':' <<  b->getUniqueID();
118    }
119    for (const StreamSetBuffer * b: mStreamSetOutputBuffers) {
120        cacheName <<  ':' <<  b->getUniqueID();
121    }
122    mModule = new Module(cacheName.str(), idb->getContext());
[5440]123    prepareKernel(idb);
[5446]124    return mModule;
[5440]125}
126
[5446]127Module * Kernel::setModule(const std::unique_ptr<KernelBuilder> & idb, llvm::Module * const module) {
128    assert (mModule == nullptr);
129    mModule = module;
130    prepareKernel(idb);
131    return mModule;
132}
133
[5440]134void Kernel::prepareKernel(const std::unique_ptr<KernelBuilder> & idb) {
135    assert ("KernelBuilder does not have a valid IDISA Builder" && idb);
[5246]136    if (LLVM_UNLIKELY(mKernelStateType != nullptr)) {
[5307]137        report_fatal_error("Cannot prepare kernel after kernel state finalized");
[5246]138    }
[5440]139    const auto blockSize = idb->getBitBlockWidth();
[5446]140    const auto requiredBlocks = codegen::SegmentSize + ((blockSize + mLookAheadPositions - 1) / blockSize);
141
[5133]142    for (unsigned i = 0; i < mStreamSetInputs.size(); i++) {
[5454]143        if ((mStreamSetInputBuffers[i]->getBufferBlocks() != 0) && (mStreamSetInputBuffers[i]->getBufferBlocks() < requiredBlocks)) {
[5446]144            report_fatal_error(getName() + ": " + mStreamSetInputs[i].name + " requires buffer size " + std::to_string(requiredBlocks));
[5142]145        }
[5307]146        mScalarInputs.emplace_back(mStreamSetInputBuffers[i]->getPointerType(), mStreamSetInputs[i].name + BUFFER_PTR_SUFFIX);
[5434]147        if ((i == 0) || !mStreamSetInputs[i].rate.isExact()) {
[5440]148            addScalar(idb->getSizeTy(), mStreamSetInputs[i].name + PROCESSED_ITEM_COUNT_SUFFIX);
149        }
[5086]150    }
[5408]151
[5440]152    IntegerType * const sizeTy = idb->getSizeTy();
[5133]153    for (unsigned i = 0; i < mStreamSetOutputs.size(); i++) {
[5307]154        mScalarInputs.emplace_back(mStreamSetOutputBuffers[i]->getPointerType(), mStreamSetOutputs[i].name + BUFFER_PTR_SUFFIX);
[5328]155        if ((mStreamSetInputs.empty() && (i == 0)) || !mStreamSetOutputs[i].rate.isExact()) {
[5408]156            addScalar(sizeTy, mStreamSetOutputs[i].name + PRODUCED_ITEM_COUNT_SUFFIX);
[5327]157        }
[5086]158    }
[5446]159    for (const auto & binding : mScalarInputs) {
[5202]160        addScalar(binding.type, binding.name);
[5076]161    }
[5446]162    for (const auto & binding : mScalarOutputs) {
[5202]163        addScalar(binding.type, binding.name);
[5076]164    }
[5398]165    if (mStreamMap.empty()) {
[5392]166        prepareStreamSetNameMap();
[5307]167    }
[5446]168    for (const auto & binding : mInternalScalars) {
[5202]169        addScalar(binding.type, binding.name);
[5076]170    }
[5408]171
172    Type * const consumerSetTy = StructType::get(sizeTy, sizeTy->getPointerTo()->getPointerTo(), nullptr)->getPointerTo();
173    for (unsigned i = 0; i < mStreamSetOutputs.size(); i++) {
[5418]174        addScalar(consumerSetTy, mStreamSetOutputs[i].name + CONSUMER_SUFFIX);
[5408]175    }
176
177    addScalar(sizeTy, LOGICAL_SEGMENT_NO_SCALAR);
[5440]178    addScalar(idb->getInt1Ty(), TERMINATION_SIGNAL);
[5408]179
[5418]180    for (unsigned i = 0; i < mStreamSetOutputs.size(); i++) {
181        addScalar(sizeTy, mStreamSetOutputs[i].name + CONSUMED_ITEM_COUNT_SUFFIX);
182    }
183
[5456]184    // We compile in a 64-bit CPU cycle counter into every kernel.   It will remain unused
185    // in normal execution, but when codegen::EnableCycleCounter is specified, pipelines
186    // will be able to add instrumentation to cached modules without recompilation.
187    addScalar(idb->getInt64Ty(), CYCLECOUNT_SCALAR);
188   
[5440]189    mKernelStateType = StructType::create(idb->getContext(), mKernelFields, getName());
[4970]190}
191
[5392]192// Default kernel signature: generate the IR and emit as byte code.
[5440]193std::string Kernel::makeSignature(const std::unique_ptr<kernel::KernelBuilder> & idb) {
194    assert ("KernelBuilder does not have a valid IDISA Builder" && idb.get());
[5464]195    if (LLVM_UNLIKELY(hasSignature())) {
[5440]196        generateKernel(idb);
[5401]197        std::string signature;
198        raw_string_ostream OS(signature);
[5431]199        WriteBitcodeToFile(getModule(), OS);
[5401]200        return signature;
[5464]201    } else {
202        return getModule()->getModuleIdentifier();
[5401]203    }
[5392]204}
205
[5440]206void Kernel::generateKernel(const std::unique_ptr<kernel::KernelBuilder> & idb) {
207    assert ("KernelBuilder does not have a valid IDISA Builder" && idb.get());
[5411]208    // If the module id cannot uniquely identify this kernel, "generateKernelSignature()" will have already
[5401]209    // generated the unoptimized IR.
210    if (!mIsGenerated) {
[5440]211        const auto m = idb->getModule();
212        const auto ip = idb->saveIP();
213        const auto saveInstance = getInstance();
214        idb->setModule(mModule);
215        addKernelDeclarations(idb);
216        callGenerateInitializeMethod(idb);
217        callGenerateDoSegmentMethod(idb);
218        callGenerateFinalizeMethod(idb);
[5411]219        setInstance(saveInstance);
[5440]220        idb->setModule(m);
221        idb->restoreIP(ip);
[5431]222        mIsGenerated = true;
[4995]223    }
[5250]224}
[5246]225
[5440]226inline void Kernel::callGenerateInitializeMethod(const std::unique_ptr<kernel::KernelBuilder> & idb) {
227    mCurrentMethod = getInitFunction(idb->getModule());
228    idb->SetInsertPoint(BasicBlock::Create(idb->getContext(), "entry", mCurrentMethod));
[5347]229    Function::arg_iterator args = mCurrentMethod->arg_begin();
[5408]230    setInstance(&*(args++));
[5440]231    idb->CreateStore(ConstantAggregateZero::get(mKernelStateType), getInstance());
[5436]232    for (const auto & binding : mScalarInputs) {
[5440]233        idb->setScalarField(binding.name, &*(args++));
[5051]234    }
[5436]235    for (const auto & binding : mStreamSetOutputs) {
[5440]236        idb->setConsumerLock(binding.name, &*(args++));
[5408]237    }
[5440]238    generateInitializeMethod(idb);
239    idb->CreateRetVoid();
[5051]240}
241
[5440]242inline void Kernel::callGenerateDoSegmentMethod(const std::unique_ptr<kernel::KernelBuilder> & idb) {
243    mCurrentMethod = getDoSegmentFunction(idb->getModule());
244    idb->SetInsertPoint(BasicBlock::Create(idb->getContext(), "entry", mCurrentMethod));
[5411]245    auto args = mCurrentMethod->arg_begin();
246    setInstance(&*(args++));
[5418]247    mIsFinal = &*(args++);
248    const auto n = mStreamSetInputs.size();
249    mAvailableItemCount.resize(n, nullptr);
250    for (unsigned i = 0; i < mStreamSetInputs.size(); i++) {
251        mAvailableItemCount[i] = &*(args++);
252    }
[5440]253    generateDoSegmentMethod(idb); // must be overridden by the KernelBuilder subtype
[5418]254    mIsFinal = nullptr;
255    mAvailableItemCount.clear();
[5440]256    idb->CreateRetVoid();
[5411]257}
258
[5440]259inline void Kernel::callGenerateFinalizeMethod(const std::unique_ptr<KernelBuilder> & idb) {
260    mCurrentMethod = getTerminateFunction(idb->getModule());
261    idb->SetInsertPoint(BasicBlock::Create(idb->getContext(), "entry", mCurrentMethod));
[5418]262    auto args = mCurrentMethod->arg_begin();
263    setInstance(&*(args++));
[5440]264    generateFinalizeMethod(idb); // may be overridden by the KernelBuilder subtype
[5418]265    const auto n = mScalarOutputs.size();
266    if (n == 0) {
[5440]267        idb->CreateRetVoid();
[5418]268    } else {
269        Value * outputs[n];
270        for (unsigned i = 0; i < n; ++i) {
[5440]271            outputs[i] = idb->getScalarField(mScalarOutputs[i].name);
[5418]272        }
273        if (n == 1) {
[5440]274            idb->CreateRet(outputs[0]);
[5418]275        } else {
[5440]276            idb->CreateAggregateRet(outputs, n);
[5418]277        }
278    }
279}
280
[5435]281unsigned Kernel::getScalarIndex(const std::string & name) const {
[5227]282    const auto f = mKernelMap.find(name);
283    if (LLVM_UNLIKELY(f == mKernelMap.end())) {
[5320]284        report_fatal_error(getName() + " does not contain scalar: " + name);
[5000]285    }
[5435]286    return f->second;
[4959]287}
[4924]288
[5440]289Value * Kernel::createInstance(const std::unique_ptr<KernelBuilder> & idb) {
290    assert ("KernelBuilder does not have a valid IDISA Builder" && idb);
[5246]291    if (LLVM_UNLIKELY(mKernelStateType == nullptr)) {
[5320]292        report_fatal_error("Cannot instantiate " + getName() + " before calling prepareKernel()");
[5246]293    }
[5440]294    setInstance(idb->CreateCacheAlignedAlloca(mKernelStateType));
[5408]295    return getInstance();
296}
[5320]297
[5440]298void Kernel::initializeInstance(const std::unique_ptr<KernelBuilder> & idb) {
299    assert ("KernelBuilder does not have a valid IDISA Builder" && idb);
[5408]300    if (LLVM_UNLIKELY(getInstance() == nullptr)) {
301        report_fatal_error("Cannot initialize " + getName() + " before calling createInstance()");
302    }
[5320]303    std::vector<Value *> args;
[5408]304    args.reserve(1 + mInitialArguments.size() + mStreamSetInputBuffers.size() + (mStreamSetOutputBuffers.size() * 2));
305    args.push_back(getInstance());
[5320]306    for (unsigned i = 0; i < mInitialArguments.size(); ++i) {
307        Value * arg = mInitialArguments[i];
308        if (LLVM_UNLIKELY(arg == nullptr)) {
309            report_fatal_error(getName() + ": initial argument " + std::to_string(i)
310                               + " cannot be null when calling createInstance()");
311        }
312        args.push_back(arg);
[5133]313    }
[5320]314    for (unsigned i = 0; i < mStreamSetInputBuffers.size(); ++i) {
315        assert (mStreamSetInputBuffers[i]);
316        Value * arg = mStreamSetInputBuffers[i]->getStreamSetBasePtr();
317        if (LLVM_UNLIKELY(arg == nullptr)) {
318            report_fatal_error(getName() + ": input stream set " + std::to_string(i)
319                               + " was not allocated prior to calling createInstance()");
320        }
321        args.push_back(arg);
[5133]322    }
[5320]323    assert (mStreamSetInputs.size() == mStreamSetInputBuffers.size());
324    for (unsigned i = 0; i < mStreamSetOutputBuffers.size(); ++i) {
325        assert (mStreamSetOutputBuffers[i]);
326        Value * arg = mStreamSetOutputBuffers[i]->getStreamSetBasePtr();
327        if (LLVM_UNLIKELY(arg == nullptr)) {
328            report_fatal_error(getName() + ": output stream set " + std::to_string(i)
329                               + " was not allocated prior to calling createInstance()");
330        }
331        args.push_back(arg);
[5133]332    }
[5320]333    assert (mStreamSetOutputs.size() == mStreamSetOutputBuffers.size());
[5440]334    IntegerType * const sizeTy = idb->getSizeTy();
[5408]335    PointerType * const sizePtrTy = sizeTy->getPointerTo();
336    PointerType * const sizePtrPtrTy = sizePtrTy->getPointerTo();
337    StructType * const consumerTy = StructType::get(sizeTy, sizePtrPtrTy, nullptr);
338    for (unsigned i = 0; i < mStreamSetOutputBuffers.size(); ++i) {
[5418]339        const auto output = mStreamSetOutputBuffers[i];
340        const auto & consumers = output->getConsumers();
[5411]341        const auto n = consumers.size();
[5440]342        AllocaInst * const outputConsumers = idb->CreateAlloca(consumerTy);
343        Value * const consumerSegNoArray = idb->CreateAlloca(ArrayType::get(sizePtrTy, n));
[5408]344        for (unsigned i = 0; i < n; ++i) {
[5435]345            Kernel * const consumer = consumers[i];
[5418]346            assert ("all instances must be created prior to initialization of any instance" && consumer->getInstance());
[5440]347            idb->setKernel(consumer);
348            Value * const segmentNoPtr = idb->getScalarFieldPtr(LOGICAL_SEGMENT_NO_SCALAR);
349            idb->CreateStore(segmentNoPtr, idb->CreateGEP(consumerSegNoArray, { idb->getInt32(0), idb->getInt32(i) }));
[5408]350        }
[5440]351        idb->setKernel(this);
352        Value * const consumerCountPtr = idb->CreateGEP(outputConsumers, {idb->getInt32(0), idb->getInt32(0)});
353        idb->CreateStore(idb->getSize(n), consumerCountPtr);
354        Value * const consumerSegNoArrayPtr = idb->CreateGEP(outputConsumers, {idb->getInt32(0), idb->getInt32(1)});
355        idb->CreateStore(idb->CreatePointerCast(consumerSegNoArray, sizePtrPtrTy), consumerSegNoArrayPtr);
[5408]356        args.push_back(outputConsumers);
357    }
[5440]358    idb->CreateCall(getInitFunction(idb->getModule()), args);
[5133]359}
[5104]360
[5285]361//  The default doSegment method dispatches to the doBlock routine for
362//  each block of the given number of blocksToDo, and then updates counts.
[5347]363
[5440]364void BlockOrientedKernel::generateDoSegmentMethod(const std::unique_ptr<KernelBuilder> & idb) {
365    BasicBlock * const entryBlock = idb->GetInsertBlock();
366    BasicBlock * const strideLoopCond = idb->CreateBasicBlock(getName() + "_strideLoopCond");
367    mStrideLoopBody = idb->CreateBasicBlock(getName() + "_strideLoopBody");
368    BasicBlock * const stridesDone = idb->CreateBasicBlock(getName() + "_stridesDone");
369    BasicBlock * const doFinalBlock = idb->CreateBasicBlock(getName() + "_doFinalBlock");
370    BasicBlock * const segmentDone = idb->CreateBasicBlock(getName() + "_segmentDone");
[5285]371
[5351]372    Value * baseTarget = nullptr;
[5440]373    if (idb->supportsIndirectBr()) {
374        baseTarget = idb->CreateSelect(mIsFinal, BlockAddress::get(doFinalBlock), BlockAddress::get(segmentDone));
[5351]375    }
376
[5440]377    ConstantInt * stride = idb->getSize(idb->getStride());
[5418]378    Value * availablePos = mAvailableItemCount[0];
[5440]379    Value * processed = idb->getProcessedItemCount(mStreamSetInputs[0].name);
380    Value * itemsAvail = idb->CreateSub(availablePos, processed);
381    Value * stridesToDo = idb->CreateUDiv(itemsAvail, stride);
[5350]382
[5440]383    idb->CreateBr(strideLoopCond);
[5285]384
[5440]385    idb->SetInsertPoint(strideLoopCond);
[5351]386
387    PHINode * branchTarget = nullptr;
[5440]388    if (idb->supportsIndirectBr()) {
389        branchTarget = idb->CreatePHI(baseTarget->getType(), 2, "branchTarget");
[5351]390        branchTarget->addIncoming(baseTarget, entryBlock);
391    }
392
[5440]393    PHINode * const stridesRemaining = idb->CreatePHI(idb->getSizeTy(), 2, "stridesRemaining");
[5285]394    stridesRemaining->addIncoming(stridesToDo, entryBlock);
[5353]395    // NOTE: stridesRemaining may go to a negative number in the final block if the generateFinalBlockMethod(...)
396    // calls CreateDoBlockMethodCall(). Do *not* replace the comparator with an unsigned one!
[5440]397    Value * notDone = idb->CreateICmpSGT(stridesRemaining, idb->getSize(0));
398    idb->CreateLikelyCondBr(notDone, mStrideLoopBody, stridesDone);
[5285]399
[5440]400    idb->SetInsertPoint(mStrideLoopBody);
[5285]401
[5440]402    if (idb->supportsIndirectBr()) {
403        mStrideLoopTarget = idb->CreatePHI(baseTarget->getType(), 2, "strideTarget");
[5351]404        mStrideLoopTarget->addIncoming(branchTarget, strideLoopCond);
[5350]405    }
406
[5347]407    /// GENERATE DO BLOCK METHOD
[5285]408
[5440]409    writeDoBlockMethod(idb);
[5347]410
411    /// UPDATE PROCESSED COUNTS
412
[5440]413    processed = idb->getProcessedItemCount(mStreamSetInputs[0].name);
414    Value * itemsDone = idb->CreateAdd(processed, stride);
415    idb->setProcessedItemCount(mStreamSetInputs[0].name, itemsDone);
[5347]416
[5440]417    stridesRemaining->addIncoming(idb->CreateSub(stridesRemaining, idb->getSize(1)), idb->GetInsertBlock());
[5297]418
[5440]419    BasicBlock * bodyEnd = idb->GetInsertBlock();
420    if (idb->supportsIndirectBr()) {
[5351]421        branchTarget->addIncoming(mStrideLoopTarget, bodyEnd);
[5350]422    }
[5440]423    idb->CreateBr(strideLoopCond);
[5350]424
[5351]425    stridesDone->moveAfter(bodyEnd);
426
[5440]427    idb->SetInsertPoint(stridesDone);
[5297]428
[5285]429    // Now conditionally perform the final block processing depending on the doFinal parameter.
[5440]430    if (idb->supportsIndirectBr()) {
431        mStrideLoopBranch = idb->CreateIndirectBr(branchTarget, 3);
[5351]432        mStrideLoopBranch->addDestination(doFinalBlock);
433        mStrideLoopBranch->addDestination(segmentDone);
434    } else {
[5440]435        idb->CreateUnlikelyCondBr(mIsFinal, doFinalBlock, segmentDone);
[5351]436    }
437
438    doFinalBlock->moveAfter(stridesDone);
439
[5440]440    idb->SetInsertPoint(doFinalBlock);
[5285]441
[5440]442    Value * remainingItems = idb->CreateSub(mAvailableItemCount[0], idb->getProcessedItemCount(mStreamSetInputs[0].name));
[5285]443
[5440]444    writeFinalBlockMethod(idb, remainingItems);
445
[5418]446    itemsDone = mAvailableItemCount[0];
[5440]447    idb->setProcessedItemCount(mStreamSetInputs[0].name, itemsDone);
448    idb->setTerminationSignal();
449    idb->CreateBr(segmentDone);
[5285]450
[5440]451    segmentDone->moveAfter(idb->GetInsertBlock());
[5351]452
[5440]453    idb->SetInsertPoint(segmentDone);
[5351]454
455    // Update the branch prediction metadata to indicate that the likely target will be segmentDone
[5440]456    if (idb->supportsIndirectBr()) {
457        MDBuilder mdb(idb->getContext());
[5350]458        const auto destinations = mStrideLoopBranch->getNumDestinations();
[5351]459        uint32_t weights[destinations];
460        for (unsigned i = 0; i < destinations; ++i) {
461            weights[i] = (mStrideLoopBranch->getDestination(i) == segmentDone) ? 100 : 1;
[5350]462        }
[5351]463        ArrayRef<uint32_t> bw(weights, destinations);
464        mStrideLoopBranch->setMetadata(LLVMContext::MD_prof, mdb.createBranchWeights(bw));
[5350]465    }
466
[5285]467}
468
[5440]469inline void BlockOrientedKernel::writeDoBlockMethod(const std::unique_ptr<KernelBuilder> & idb) {
[5292]470
[5408]471    Value * const self = getInstance();
[5347]472    Function * const cp = mCurrentMethod;
[5440]473    auto ip = idb->saveIP();
[5454]474    std::vector<Value *> availableItemCount(0);
[5292]475
[5347]476    /// Check if the do block method is called and create the function if necessary   
[5440]477    if (!idb->supportsIndirectBr()) {
[5454]478
479        std::vector<Type *> params;
480        params.reserve(1 + mAvailableItemCount.size());
481        params.push_back(self->getType());
482        for (Value * avail : mAvailableItemCount) {
483            params.push_back(avail->getType());
484        }
485
486        FunctionType * const type = FunctionType::get(idb->getVoidTy(), params, false);
[5440]487        mCurrentMethod = Function::Create(type, GlobalValue::InternalLinkage, getName() + DO_BLOCK_SUFFIX, idb->getModule());
[5347]488        mCurrentMethod->setCallingConv(CallingConv::C);
489        mCurrentMethod->setDoesNotThrow();
490        mCurrentMethod->setDoesNotCapture(1);
491        auto args = mCurrentMethod->arg_begin();
[5408]492        args->setName("self");
493        setInstance(&*args);
[5454]494        availableItemCount.reserve(mAvailableItemCount.size());
495        while (++args != mCurrentMethod->arg_end()) {
496            availableItemCount.push_back(&*args);
497        }
498        assert (availableItemCount.size() == mAvailableItemCount.size());
499        mAvailableItemCount.swap(availableItemCount);
500        idb->SetInsertPoint(BasicBlock::Create(idb->getContext(), "entry", mCurrentMethod));
[5347]501    }
502
[5330]503    std::vector<Value *> priorProduced;
504    for (unsigned i = 0; i < mStreamSetOutputs.size(); i++) {
[5355]505        if (isa<CircularCopybackBuffer>(mStreamSetOutputBuffers[i]) || isa<SwizzledCopybackBuffer>(mStreamSetOutputBuffers[i]))  {
[5440]506            priorProduced.push_back(idb->getProducedItemCount(mStreamSetOutputs[i].name));
[5330]507        }
508    }
[5347]509
[5440]510    generateDoBlockMethod(idb); // must be implemented by the BlockOrientedKernelBuilder subtype
[5347]511
[5361]512    unsigned priorIdx = 0;
[5330]513    for (unsigned i = 0; i < mStreamSetOutputs.size(); i++) {
[5440]514        Value * log2BlockSize = idb->getSize(std::log2(idb->getBitBlockWidth()));
[5431]515        if (SwizzledCopybackBuffer * const cb = dyn_cast<SwizzledCopybackBuffer>(mStreamSetOutputBuffers[i]))  {
[5440]516            BasicBlock * copyBack = idb->CreateBasicBlock(mStreamSetOutputs[i].name + "_copyBack");
517            BasicBlock * done = idb->CreateBasicBlock(mStreamSetOutputs[i].name + "_copyBackDone");
518            Value * newlyProduced = idb->CreateSub(idb->getProducedItemCount(mStreamSetOutputs[i].name), priorProduced[priorIdx]);
519            Value * priorBlock = idb->CreateLShr(priorProduced[priorIdx], log2BlockSize);
520            Value * priorOffset = idb->CreateAnd(priorProduced[priorIdx], idb->getSize(idb->getBitBlockWidth() - 1));
521            Value * instance = idb->getStreamSetBufferPtr(mStreamSetOutputs[i].name);
[5501]522            Value * accessibleBlocks = idb->getLinearlyAccessibleBlocks(mStreamSetOutputs[i].name, priorBlock);
[5440]523            Value * accessible = idb->CreateSub(idb->CreateShl(accessibleBlocks, log2BlockSize), priorOffset);
524            Value * wraparound = idb->CreateICmpULT(accessible, newlyProduced);
525            idb->CreateCondBr(wraparound, copyBack, done);
526            idb->SetInsertPoint(copyBack);
527            Value * copyItems = idb->CreateSub(newlyProduced, accessible);
528            cb->createCopyBack(idb.get(), instance, copyItems);
529            idb->CreateBr(done);
530            idb->SetInsertPoint(done);
[5355]531            priorIdx++;
532        }
[5431]533        if (CircularCopybackBuffer * const cb = dyn_cast<CircularCopybackBuffer>(mStreamSetOutputBuffers[i]))  {
[5440]534            BasicBlock * copyBack = idb->CreateBasicBlock(mStreamSetOutputs[i].name + "_copyBack");
535            BasicBlock * done = idb->CreateBasicBlock(mStreamSetOutputs[i].name + "_copyBackDone");
536            Value * instance = idb->getStreamSetBufferPtr(mStreamSetOutputs[i].name);
537            Value * newlyProduced = idb->CreateSub(idb->getProducedItemCount(mStreamSetOutputs[i].name), priorProduced[priorIdx]);
[5501]538            Value * accessible = idb->getLinearlyAccessibleItems(mStreamSetOutputs[i].name, priorProduced[priorIdx]);
[5440]539            Value * wraparound = idb->CreateICmpULT(accessible, newlyProduced);
540            idb->CreateCondBr(wraparound, copyBack, done);
541            idb->SetInsertPoint(copyBack);
542            Value * copyItems = idb->CreateSub(newlyProduced, accessible);
543            cb->createCopyBack(idb.get(), instance, copyItems);
544            idb->CreateBr(done);
545            idb->SetInsertPoint(done);
[5330]546            priorIdx++;
547        }
[5329]548    }
[5347]549
[5440]550    if (!idb->supportsIndirectBr()) {
[5454]551        // Restore the DoSegment function state then call the DoBlock method
[5440]552        idb->CreateRetVoid();
[5350]553        mDoBlockMethod = mCurrentMethod;
[5440]554        idb->restoreIP(ip);
[5408]555        setInstance(self);
[5350]556        mCurrentMethod = cp;
[5454]557        mAvailableItemCount.swap(availableItemCount);
558        CreateDoBlockMethodCall(idb);
[5350]559    }
560
[5285]561}
562
[5440]563inline void BlockOrientedKernel::writeFinalBlockMethod(const std::unique_ptr<KernelBuilder> & idb, Value * remainingItems) {
[5292]564
[5408]565    Value * const self = getInstance();
[5347]566    Function * const cp = mCurrentMethod;
567    Value * const remainingItemCount = remainingItems;
[5440]568    auto ip = idb->saveIP();
[5454]569    std::vector<Value *> availableItemCount(0);
[5285]570
[5440]571    if (!idb->supportsIndirectBr()) {
[5454]572        std::vector<Type *> params;
573        params.reserve(2 + mAvailableItemCount.size());
574        params.push_back(self->getType());
575        params.push_back(idb->getSizeTy());
576        for (Value * avail : mAvailableItemCount) {
577            params.push_back(avail->getType());
578        }
579        FunctionType * const type = FunctionType::get(idb->getVoidTy(), params, false);
[5440]580        mCurrentMethod = Function::Create(type, GlobalValue::InternalLinkage, getName() + FINAL_BLOCK_SUFFIX, idb->getModule());
[5347]581        mCurrentMethod->setCallingConv(CallingConv::C);
582        mCurrentMethod->setDoesNotThrow();
583        mCurrentMethod->setDoesNotCapture(1);
584        auto args = mCurrentMethod->arg_begin();
[5408]585        args->setName("self");
586        setInstance(&*args);
[5347]587        remainingItems = &*(++args);
588        remainingItems->setName("remainingItems");
[5454]589        availableItemCount.reserve(mAvailableItemCount.size());
590        while (++args != mCurrentMethod->arg_end()) {
591            availableItemCount.push_back(&*args);
592        }
593        assert (availableItemCount.size() == mAvailableItemCount.size());
594        mAvailableItemCount.swap(availableItemCount);
595        idb->SetInsertPoint(BasicBlock::Create(idb->getContext(), "entry", mCurrentMethod));
[5292]596    }
[5347]597
[5440]598    generateFinalBlockMethod(idb, remainingItems); // may be implemented by the BlockOrientedKernel subtype
[5347]599
[5351]600    RecursivelyDeleteTriviallyDeadInstructions(remainingItems); // if remainingItems was not used, this will eliminate it.
601
[5440]602    if (!idb->supportsIndirectBr()) {
603        idb->CreateRetVoid();
604        idb->restoreIP(ip);
[5454]605        setInstance(self);
606        mAvailableItemCount.swap(availableItemCount);
607        // Restore the DoSegment function state then call the DoFinal method
608        std::vector<Value *> args;
609        args.reserve(2 + mAvailableItemCount.size());
610        args.push_back(self);
611        args.push_back(remainingItemCount);
612        for (Value * avail : mAvailableItemCount) {
613            args.push_back(avail);
614        }
615        idb->CreateCall(mCurrentMethod, args);
[5347]616        mCurrentMethod = cp;
617    }
618
[5285]619}
620
[5347]621//  The default finalBlock method simply dispatches to the doBlock routine.
[5440]622void BlockOrientedKernel::generateFinalBlockMethod(const std::unique_ptr<KernelBuilder> & idb, Value * /* remainingItems */) {
623    CreateDoBlockMethodCall(idb);
[5292]624}
625
[5440]626void BlockOrientedKernel::CreateDoBlockMethodCall(const std::unique_ptr<KernelBuilder> & idb) {
627    if (idb->supportsIndirectBr()) {
628        BasicBlock * bb = idb->CreateBasicBlock("resume");
[5350]629        mStrideLoopBranch->addDestination(bb);
[5440]630        mStrideLoopTarget->addIncoming(BlockAddress::get(bb), idb->GetInsertBlock());
631        idb->CreateBr(mStrideLoopBody);
632        bb->moveAfter(idb->GetInsertBlock());
633        idb->SetInsertPoint(bb);
[5350]634    } else {
[5454]635        std::vector<Value *> args;
636        args.reserve(1 + mAvailableItemCount.size());
637        args.push_back(getInstance());
638        for (Value * avail : mAvailableItemCount) {
639            args.push_back(avail);
640        }
641        idb->CreateCall(mDoBlockMethod, args);
[5292]642    }
[5285]643}
644
[5440]645void MultiBlockKernel::generateDoSegmentMethod(const std::unique_ptr<KernelBuilder> & kb) {
[5292]646
[5479]647    // Stream set and buffer analysis.  When near the end of buffers
648    // or for final block processing, data for each streamset may need
649    // to be copied into temporary buffers to ensure linear access.
650    // Data is always copied as a number of whole blocks, dependent
651    // on the stream set processing rate.
652   
653    const unsigned bitBlockWidth = kb->getBitBlockWidth();
654    const unsigned inputSetCount = mStreamSetInputs.size();
655    const unsigned outputSetCount = mStreamSetOutputs.size();
656    const unsigned totalSetCount = inputSetCount + outputSetCount;
[5497]657   
658    unsigned itemsPerStride[totalSetCount];
[5479]659    bool isDerived[totalSetCount];
660   
[5497]661    if (mStride == 0) mStride = bitBlockWidth;
662
663    itemsPerStride[0] = mStride;
664    isDerived[0] = true;
665   
666    for (unsigned i = 1; i < inputSetCount; i++) {
[5479]667        auto & rate = mStreamSetInputs[i].rate;
668        std::string refSet = mStreamSetInputs[i].rate.referenceStreamSet();
669        if (rate.isExact()) {
670            if (refSet.empty()) {
[5497]671                itemsPerStride[i] = rate.calculateRatio(itemsPerStride[0]);
[5479]672                isDerived[i] = true;
673                continue;
674            }
675            else {
676                Port port; unsigned ssIdx;
677                std::tie(port, ssIdx) = getStreamPort(mStreamSetInputs[i].name);
678                assert (port == Port::Input && ssIdx < i);
679                if (isDerived[ssIdx]) {
[5497]680                    itemsPerStride[i] = rate.calculateRatio(itemsPerStride[ssIdx]);
[5479]681                    isDerived[i] = true;
682                    continue;
683                }
684            }
685        }
686        isDerived[i] = false;
687    }
688   
689    for (auto & ss : mStreamSetOutputs) {
690        unsigned i = inputSetCount;
691        auto & rate = ss.rate;
692        std::string refSet = rate.referenceStreamSet();
693        if (rate.isExact() || rate.isMaxRatio()) {
694            if (refSet.empty()) {
[5497]695                itemsPerStride[i] = rate.calculateRatio(bitBlockWidth);
[5479]696                isDerived[i] = rate.isExact();
697                continue;
698            }
699            else {
700                Port port; unsigned ssIdx;
701                std::tie(port, ssIdx) = getStreamPort(mStreamSetOutputs[i].name);
702                if (port == Port::Output) ssIdx += inputSetCount;
703                if (isDerived[ssIdx]) {
[5497]704                    itemsPerStride[i] = rate.calculateRatio(itemsPerStride[ssIdx]);
[5479]705                    isDerived[i] = rate.isExact();
706                    continue;
707                }
708            }
709        }
710        isDerived[i] = false;
711        i++;
712    }
713    int maxBlocksToCopy[totalSetCount];
714   
715    for (unsigned i = 0; i < totalSetCount; i++) {
716        if (isDerived[i]) {
[5497]717            if (itemsPerStride[i] % bitBlockWidth == 0) {
718                maxBlocksToCopy[i] = itemsPerStride[i] / bitBlockWidth;
[5479]719            }
720            else {
721                // May not be block aligned, can overlap partial blocks at both ends.
[5497]722                maxBlocksToCopy[i] = itemsPerStride[i]/bitBlockWidth + 2;
[5479]723            }
724        }
725        else {
[5497]726            // For variable input stream sets, we make a single stride of items
727            // available, if possible, but this stride could be nonaligned.
728            maxBlocksToCopy[i] = mStride / bitBlockWidth + 2;
[5479]729        }
730    }
[5446]731    auto ip = kb->saveIP();
[5479]732   
[5442]733    Function * const cp = mCurrentMethod;
[5443]734    const auto saveInstance = getInstance();
[5446]735
[5440]736    // First prepare the multi-block method that will be used.
[5418]737
[5446]738    DataLayout DL(kb->getModule());
[5454]739    IntegerType * const intAddrTy = DL.getIntPtrType(kb->getContext());
[5446]740
[5439]741    std::vector<Type *> multiBlockParmTypes;
742    multiBlockParmTypes.push_back(mKernelStateType->getPointerTo());
[5446]743    multiBlockParmTypes.push_back(kb->getSizeTy());
[5479]744    for (unsigned i = 1; i < mStreamSetInputs.size(); i++) {
745        if (!isDerived[i]) multiBlockParmTypes.push_back(kb->getSizeTy());
746    }
[5439]747    for (auto buffer : mStreamSetInputBuffers) {
748        multiBlockParmTypes.push_back(buffer->getPointerType());
749    }
750    for (auto buffer : mStreamSetOutputBuffers) {
751        multiBlockParmTypes.push_back(buffer->getPointerType());
752    }
[5446]753
754    FunctionType * const type = FunctionType::get(kb->getVoidTy(), multiBlockParmTypes, false);
755    Function * multiBlockFunction = Function::Create(type, GlobalValue::InternalLinkage, getName() + MULTI_BLOCK_SUFFIX, kb->getModule());
[5439]756    multiBlockFunction->setCallingConv(CallingConv::C);
757    multiBlockFunction->setDoesNotThrow();
758    auto args = multiBlockFunction->arg_begin();
759    args->setName("self");
[5443]760    setInstance(&*args);
[5441]761    (++args)->setName("itemsToDo");
[5479]762    for (unsigned i = 1; i < mStreamSetInputs.size(); i++) {
763        if (!isDerived[i]) (++args)->setName(mStreamSetInputs[i].name + "_availItems");
764    }
[5439]765    for (auto binding : mStreamSetInputs) {
766        (++args)->setName(binding.name + "BufPtr");
767    }
768    for (auto binding : mStreamSetOutputs) {
[5441]769        (++args)->setName(binding.name + "BufPtr");
[5439]770    }
[5440]771
772    // Now use the generateMultiBlockLogic method of the MultiBlockKernelBuilder subtype to
[5439]773    // provide the required multi-block kernel logic.
[5442]774    mCurrentMethod = multiBlockFunction;
[5446]775    kb->SetInsertPoint(BasicBlock::Create(kb->getContext(), "multiBlockEntry", multiBlockFunction, 0));
[5441]776    generateMultiBlockLogic(kb);
[5440]777
[5446]778    kb->CreateRetVoid();
779
780    kb->restoreIP(ip);
[5442]781    mCurrentMethod = cp;
[5443]782    setInstance(saveInstance);
[5446]783
[5439]784    // Now proceed with creation of the doSegment method.
[5440]785
[5446]786    BasicBlock * const entry = kb->GetInsertBlock();
787    BasicBlock * const doSegmentOuterLoop = kb->CreateBasicBlock(getName() + "_doSegmentOuterLoop");
788    BasicBlock * const doMultiBlockCall = kb->CreateBasicBlock(getName() + "_doMultiBlockCall");
789    BasicBlock * const tempBlockCheck = kb->CreateBasicBlock(getName() + "_tempBlockCheck");
790    BasicBlock * const doTempBufferBlock = kb->CreateBasicBlock(getName() + "_doTempBufferBlock");
791    BasicBlock * const segmentDone = kb->CreateBasicBlock(getName() + "_segmentDone");
[5440]792
[5446]793    Value * blockBaseMask = kb->CreateNot(kb->getSize(kb->getBitBlockWidth() - 1));
[5440]794
[5439]795    //
[5479]796    // Define and allocate the temporary buffer area.
[5439]797    //
[5479]798    Type * tempBuffers[totalSetCount];
799    for (unsigned i = 0; i < totalSetCount; i++) {
800        unsigned blocks = maxBlocksToCopy[i];
801        Type * bufType = i < inputSetCount ? mStreamSetInputBuffers[i]->getType() : mStreamSetOutputBuffers[i -inputSetCount]->getType();
[5439]802        if (blocks > 1) {
[5479]803            tempBuffers[i] = ArrayType::get(bufType, blocks);
[5439]804        }
805        else {
[5479]806            tempBuffers[i] = bufType;
[5439]807        }
808    }
[5479]809    Type * tempParameterStructType = StructType::create(kb->getContext(), ArrayRef<Type *>(tempBuffers, totalSetCount), "tempBuf");
[5446]810    Value * tempParameterArea = kb->CreateCacheAlignedAlloca(tempParameterStructType);
[5442]811
[5446]812    ConstantInt * blockSize = kb->getSize(kb->getBitBlockWidth());
[5497]813    ConstantInt * strideSize = kb->getSize(mStride);
814   
[5439]815    Value * availablePos = mAvailableItemCount[0];
816    Value * itemsAvail = availablePos;
[5446]817
[5439]818    //  Make sure that corresponding data is available depending on processing rate
819    //  for all input stream sets.
[5446]820
[5439]821    for (unsigned i = 1; i < mStreamSetInputs.size(); i++) {
822        Value * a = mAvailableItemCount[i];
823        auto & rate = mStreamSetInputs[i].rate;
[5440]824        assert (((rate.referenceStreamSet().empty()) || (rate.referenceStreamSet() == mStreamSetInputs[0].name)) && "Multiblock kernel input rate not with respect to principal stream.");
[5446]825        Value * maxItems = rate.CreateMaxReferenceItemsCalculation(kb.get(), a);
826        itemsAvail = kb->CreateSelect(kb->CreateICmpULT(itemsAvail, maxItems), itemsAvail, maxItems);
[5439]827    }
[5440]828
[5446]829    Value * processed = kb->getProcessedItemCount(mStreamSetInputs[0].name);
830    Value * itemsToDo = kb->CreateSub(itemsAvail, processed);
[5497]831    Value * fullStridesToDo = kb->CreateUDiv(itemsToDo, strideSize);
832    Value * excessItems = kb->CreateURem(itemsToDo, strideSize);
[5440]833
834    //  Now we iteratively process these blocks using the doMultiBlock method.
[5439]835    //  In each iteration, we process the maximum number of linearly accessible
836    //  blocks on the principal input, reduced to ensure that the corresponding
837    //  data is linearly available at the specified processing rates for the other inputs,
838    //  and that each of the output buffers has sufficient linearly available space
839    //  (using overflow areas, if necessary) for the maximum output that can be
840    //  produced.
[5440]841
[5446]842    kb->CreateBr(doSegmentOuterLoop);
843    kb->SetInsertPoint(doSegmentOuterLoop);
[5497]844    PHINode * const stridesRemaining = kb->CreatePHI(kb->getSizeTy(), 2, "stridesRemaining");
845    stridesRemaining->addIncoming(fullStridesToDo, entry);
[5446]846
[5439]847    // For each input buffer, determine the processedItemCount, the block pointer for the
848    // buffer block containing the next item, and the number of linearly available items.
[5446]849
[5439]850    std::vector<Value *> processedItemCount;
851    std::vector<Value *> inputBlockPtr;
852    std::vector<Value *> producedItemCount;
853    std::vector<Value *> outputBlockPtr;
[5440]854
[5442]855    //  Now determine the linearly available blocks, based on blocks remaining reduced
856    //  by limitations of linearly available input buffer space.
[5446]857
[5497]858    Value * linearlyAvailStrides = stridesRemaining;
[5479]859    for (unsigned i = 0; i < inputSetCount; i++) {
[5446]860        Value * p = kb->getProcessedItemCount(mStreamSetInputs[i].name);
861        Value * blkNo = kb->CreateUDiv(p, blockSize);
862        Value * b = kb->getInputStreamBlockPtr(mStreamSetInputs[i].name, kb->getInt32(0));
[5439]863        processedItemCount.push_back(p);
864        inputBlockPtr.push_back(b);
[5479]865        if (isDerived[i]) {
866            auto & rate = mStreamSetInputs[i].rate;
[5497]867            Value * maxReferenceItems = nullptr;
[5479]868            if ((rate.isFixedRatio()) && (rate.getRatioNumerator() == rate.getRatioDenominator()) && (rate.referenceStreamSet() == "")) {
[5501]869                maxReferenceItems = kb->CreateMul(kb->getLinearlyAccessibleBlocks(mStreamSetInputs[i].name, blkNo), blockSize);
[5479]870            } else {
[5501]871                Value * linearlyAvailItems = kb->getLinearlyAccessibleItems(mStreamSetInputs[i].name, p);
[5497]872                maxReferenceItems = rate.CreateMaxReferenceItemsCalculation(kb.get(), linearlyAvailItems);
[5479]873            }
[5497]874            Value * maxStrides = kb->CreateUDiv(maxReferenceItems, strideSize);
875            linearlyAvailStrides = kb->CreateSelect(kb->CreateICmpULT(maxStrides, linearlyAvailStrides), maxStrides, linearlyAvailStrides);
[5439]876        }
877    }
878    //  Now determine the linearly writeable blocks, based on available blocks reduced
879    //  by limitations of output buffer space.
[5497]880    Value * linearlyWritableStrides = linearlyAvailStrides;
[5440]881
[5479]882    for (unsigned i = 0; i < outputSetCount; i++) {
[5446]883        Value * p = kb->getProducedItemCount(mStreamSetOutputs[i].name);
884        Value * blkNo = kb->CreateUDiv(p, blockSize);
885        Value * b = kb->getOutputStreamBlockPtr(mStreamSetOutputs[i].name, kb->getInt32(0));
[5439]886        producedItemCount.push_back(p);
887        outputBlockPtr.push_back(b);
[5479]888        if (isDerived[inputSetCount + i]) {
889            auto & rate = mStreamSetOutputs[i].rate;
[5497]890            Value * maxReferenceItems = nullptr;
[5479]891            if ((rate.isFixedRatio()) && (rate.getRatioNumerator() == rate.getRatioDenominator())) {
[5501]892                maxReferenceItems = kb->CreateMul(kb->getLinearlyWritableBlocks(mStreamSetOutputs[i].name, blkNo), blockSize);
[5479]893            } else {
[5501]894                Value * writableItems = kb->getLinearlyWritableItems(mStreamSetOutputs[i].name, p);
[5497]895                maxReferenceItems = rate.CreateMaxReferenceItemsCalculation(kb.get(), writableItems);
[5479]896            }
[5497]897            Value * maxStrides = kb->CreateUDiv(maxReferenceItems, strideSize);
898            linearlyWritableStrides = kb->CreateSelect(kb->CreateICmpULT(maxStrides, linearlyWritableStrides), maxStrides, linearlyWritableStrides);
[5439]899        }
900    }
[5452]901
[5497]902    Value * haveStrides = kb->CreateICmpUGT(linearlyWritableStrides, kb->getSize(0));
903    kb->CreateCondBr(haveStrides, doMultiBlockCall, tempBlockCheck);
[5440]904
[5439]905    //  At this point we have verified the availability of one or more blocks of input data and output buffer space for all stream sets.
906    //  Now prepare the doMultiBlock call.
[5446]907    kb->SetInsertPoint(doMultiBlockCall);
[5440]908
[5497]909    Value * linearlyAvailItems = kb->CreateMul(linearlyWritableStrides, strideSize);
[5440]910
[5439]911    std::vector<Value *> doMultiBlockArgs;
[5441]912    doMultiBlockArgs.push_back(getInstance());
[5439]913    doMultiBlockArgs.push_back(linearlyAvailItems);
914    for (unsigned i = 0; i < mStreamSetInputs.size(); i++) {
[5479]915        if (!isDerived[i]) {
916            Value * avail = kb->CreateSub(mAvailableItemCount[i], processedItemCount[i]);
[5501]917            Value * linearlyAvail = kb->getLinearlyAccessibleItems(mStreamSetInputs[i].name, processedItemCount[i]);
[5479]918            doMultiBlockArgs.push_back(kb->CreateSelect(kb->CreateICmpULT(avail, linearlyAvail), avail, linearlyAvail));
919        }
920    }
921    for (unsigned i = 0; i < mStreamSetInputs.size(); i++) {
[5446]922        Value * bufPtr = kb->getRawInputPointer(mStreamSetInputs[i].name, kb->getInt32(0), processedItemCount[i]);
923        bufPtr = kb->CreatePointerCast(bufPtr, mStreamSetInputBuffers[i]->getPointerType());
[5442]924        doMultiBlockArgs.push_back(bufPtr);
[5439]925    }
926    for (unsigned i = 0; i < mStreamSetOutputs.size(); i++) {
[5446]927        Value * bufPtr = kb->getRawOutputPointer(mStreamSetOutputs[i].name, kb->getInt32(0), producedItemCount[i]);
928        bufPtr = kb->CreatePointerCast(bufPtr, mStreamSetOutputBuffers[i]->getPointerType());
[5442]929        doMultiBlockArgs.push_back(bufPtr);
[5439]930    }
[5440]931
[5446]932    kb->CreateCall(multiBlockFunction, doMultiBlockArgs);
[5439]933    // Do copybacks if necessary.
934    unsigned priorIdx = 0;
935    for (unsigned i = 0; i < mStreamSetOutputs.size(); i++) {
[5446]936        Value * log2BlockSize = kb->getSize(std::log2(kb->getBitBlockWidth()));
[5439]937        if (auto cb = dyn_cast<SwizzledCopybackBuffer>(mStreamSetOutputBuffers[i]))  {
[5446]938            BasicBlock * copyBack = kb->CreateBasicBlock(mStreamSetOutputs[i].name + "_copyBack");
939            BasicBlock * done = kb->CreateBasicBlock(mStreamSetOutputs[i].name + "_copyBackDone");
940            Value * newlyProduced = kb->CreateSub(kb->getProducedItemCount(mStreamSetOutputs[i].name), producedItemCount[i]);
941            Value * priorBlock = kb->CreateLShr(producedItemCount[i], log2BlockSize);
942            Value * priorOffset = kb->CreateAnd(producedItemCount[i], kb->getSize(kb->getBitBlockWidth() - 1));
943            Value * instance = kb->getStreamSetBufferPtr(mStreamSetOutputs[i].name);
[5501]944            Value * accessibleBlocks = kb->getLinearlyAccessibleBlocks(mStreamSetOutputs[i].name, priorBlock);
[5446]945            Value * accessible = kb->CreateSub(kb->CreateShl(accessibleBlocks, log2BlockSize), priorOffset);
946            Value * wraparound = kb->CreateICmpULT(accessible, newlyProduced);
947            kb->CreateCondBr(wraparound, copyBack, done);
948            kb->SetInsertPoint(copyBack);
949            Value * copyItems = kb->CreateSub(newlyProduced, accessible);
950            cb->createCopyBack(kb.get(), instance, copyItems);
951            kb->CreateBr(done);
952            kb->SetInsertPoint(done);
[5439]953            priorIdx++;
954        }
955        if (auto cb = dyn_cast<CircularCopybackBuffer>(mStreamSetOutputBuffers[i]))  {
[5446]956            BasicBlock * copyBack = kb->CreateBasicBlock(mStreamSetOutputs[i].name + "_copyBack");
957            BasicBlock * done = kb->CreateBasicBlock(mStreamSetOutputs[i].name + "_copyBackDone");
958            Value * instance = kb->getStreamSetBufferPtr(mStreamSetOutputs[i].name);
959            Value * newlyProduced = kb->CreateSub(kb->getProducedItemCount(mStreamSetOutputs[i].name), producedItemCount[i]);
[5501]960            Value * accessible = kb->getLinearlyAccessibleItems(mStreamSetOutputs[i].name, producedItemCount[i]);
[5446]961            Value * wraparound = kb->CreateICmpULT(accessible, newlyProduced);
962            kb->CreateCondBr(wraparound, copyBack, done);
963            kb->SetInsertPoint(copyBack);
964            Value * copyItems = kb->CreateSub(newlyProduced, accessible);
965            cb->createCopyBack(kb.get(), instance, copyItems);
966            kb->CreateBr(done);
967            kb->SetInsertPoint(done);
[5439]968            priorIdx++;
969        }
970    }
[5452]971
972    Value * nowProcessed = kb->CreateAdd(processedItemCount[0], linearlyAvailItems);
973    kb->setProcessedItemCount(mStreamSetInputs[0].name, nowProcessed);
[5497]974    Value * reducedStridesToDo = kb->CreateSub(stridesRemaining, linearlyWritableStrides);
[5446]975    BasicBlock * multiBlockFinal = kb->GetInsertBlock();
[5497]976    stridesRemaining->addIncoming(reducedStridesToDo, multiBlockFinal);
[5452]977    kb->CreateBr(doSegmentOuterLoop);
[5442]978    //
979    // We use temporary buffers in 3 different cases that preclude full block processing.
980    // (a) One or more input buffers does not have a sufficient number of input items linearly available.
981    // (b) One or more output buffers does not have sufficient linearly available buffer space.
982    // (c) We have processed all the full blocks of input and only the excessItems remain.
983    // In each case we set up temporary buffers for input and output and then
984    // call the Multiblock routine.
985    //
[5440]986
[5446]987    kb->SetInsertPoint(tempBlockCheck);
[5497]988    haveStrides = kb->CreateICmpUGT(stridesRemaining, kb->getSize(0));
989    kb->CreateCondBr(kb->CreateOr(mIsFinal, haveStrides), doTempBufferBlock, segmentDone);
[5446]990
991    kb->SetInsertPoint(doTempBufferBlock);
[5497]992    Value * tempBlockItems = kb->CreateSelect(haveStrides, strideSize, excessItems);
993    Value * doFinal = kb->CreateNot(haveStrides);
[5440]994
[5439]995    // Begin constructing the doMultiBlock args.
996    std::vector<Value *> tempArgs;
[5441]997    tempArgs.push_back(getInstance());
[5439]998    tempArgs.push_back(tempBlockItems);
[5479]999   
1000    // For non-derived inputs, add the available items.
1001    for (unsigned i = 0; i < mStreamSetInputs.size(); i++) {
1002        if (!isDerived[i]) {
1003            Value * avail = kb->CreateSub(mAvailableItemCount[i], processedItemCount[i]);
[5497]1004            doMultiBlockArgs.push_back(kb->CreateSelect(kb->CreateICmpULT(avail, strideSize), avail, strideSize));
[5479]1005        }
1006    }
[5440]1007
[5439]1008    // Prepare the temporary buffer area.
1009    //
1010    // First zero it out.
[5446]1011    Constant * const tempAreaSize = ConstantExpr::getIntegerCast(ConstantExpr::getSizeOf(tempParameterStructType), kb->getSizeTy(), false);
1012    kb->CreateMemZero(tempParameterArea, tempAreaSize);
1013
[5439]1014    // For each input and output buffer, copy over necessary data starting from the last
1015    // block boundary.
[5452]1016    std::vector<Value *> finalItemCountNeeded;
[5453]1017    finalItemCountNeeded.push_back(kb->CreateAdd(processedItemCount[0], tempBlockItems));
[5439]1018
1019    for (unsigned i = 0; i < mStreamSetInputBuffers.size(); i++) {
[5446]1020        Value * tempBufPtr = kb->CreateGEP(tempParameterArea, kb->getInt32(i));
[5460]1021        Type * bufPtrType = mStreamSetInputBuffers[i]->getPointerType();
1022        tempBufPtr = kb->CreatePointerCast(tempBufPtr, bufPtrType);
[5452]1023        Value * blockBasePos = kb->CreateAnd(processedItemCount[i], blockBaseMask);
[5439]1024        // The number of items to copy is determined by the processing rate requirements.
1025        if (i > 1) {
[5442]1026            auto & rate = mStreamSetInputs[i].rate;
[5439]1027            std::string refSet = mStreamSetInputs[i].rate.referenceStreamSet();
1028            if (refSet.empty()) {
[5452]1029                finalItemCountNeeded.push_back(rate.CreateRatioCalculation(kb.get(), finalItemCountNeeded[0], doFinal));
[5439]1030            }
[5479]1031            else if (isDerived[i]) {
[5439]1032                Port port; unsigned ssIdx;
1033                std::tie(port, ssIdx) = getStreamPort(mStreamSetInputs[i].name);
1034                assert (port == Port::Input && ssIdx < i);
[5452]1035                finalItemCountNeeded.push_back(rate.CreateRatioCalculation(kb.get(), finalItemCountNeeded[ssIdx], doFinal));
[5439]1036            }
[5479]1037            else {
1038                // Ensure that there is up to a full block of items, if available.
1039                Value * avail = kb->CreateSub(mAvailableItemCount[i], processedItemCount[i]);
1040                finalItemCountNeeded.push_back(kb->CreateSelect(kb->CreateICmpULT(avail, blockSize), avail, blockSize));
1041            }
[5439]1042        }
[5460]1043        Value * inputPtr = kb->CreatePointerCast(kb->getRawInputPointer(mStreamSetInputs[i].name, kb->getInt32(0), blockBasePos), bufPtrType);
[5479]1044        if (maxBlocksToCopy[i] == 1) {
1045            // copy one block
1046            mStreamSetInputBuffers[i]->createBlockCopy(kb.get(), tempBufPtr, inputPtr, kb->getSize(1));
1047        }
1048        else {
1049            Value * neededItems = kb->CreateSub(finalItemCountNeeded[i], blockBasePos);
1050            // Round up to exact multiple of block size.
1051            neededItems = kb->CreateAnd(kb->CreateAdd(neededItems, kb->getSize(bitBlockWidth - 1)), blockBaseMask);
[5501]1052            Value * availFromBase = kb->getLinearlyAccessibleItems(mStreamSetInputs[i].name, blockBasePos);
[5479]1053            Value * copyItems1 = kb->CreateSelect(kb->CreateICmpULT(neededItems, availFromBase), neededItems, availFromBase);
1054            Value * copyItems2 = kb->CreateSub(neededItems, copyItems1);
1055            mStreamSetInputBuffers[i]->createBlockAlignedCopy(kb.get(), tempBufPtr, inputPtr, copyItems1);
1056            Value * nextBufPtr = kb->CreateGEP(tempBufPtr, kb->CreateUDiv(copyItems1, blockSize));
1057            mStreamSetInputBuffers[i]->createBlockAlignedCopy(kb.get(), nextBufPtr, kb->getStreamSetBufferPtr(mStreamSetInputs[i].name), copyItems2);
1058        }
[5447]1059        Value * itemAddress = kb->getRawInputPointer(mStreamSetInputs[i].name, kb->getInt32(0), processedItemCount[i]);
[5454]1060        itemAddress = kb->CreatePtrToInt(itemAddress, intAddrTy);
[5447]1061        Value * baseAddress = inputBlockPtr[i];
[5454]1062        baseAddress = kb->CreatePtrToInt(baseAddress, intAddrTy);
1063        Value * tempAddress = kb->CreateAdd(kb->CreatePtrToInt(tempBufPtr, intAddrTy), kb->CreateSub(itemAddress, baseAddress));
[5460]1064        tempArgs.push_back(kb->CreateIntToPtr(tempAddress, bufPtrType));
[5439]1065    }
1066
[5452]1067    std::vector<Value *> blockBasePos;
[5439]1068    for (unsigned i = 0; i < mStreamSetOutputBuffers.size(); i++) {
[5446]1069        Value * tempBufPtr = kb->CreateGEP(tempParameterArea, kb->getInt32(mStreamSetInputs.size() + i));
[5460]1070        Type * bufPtrType = mStreamSetOutputBuffers[i]->getPointerType();
1071        tempBufPtr = kb->CreatePointerCast(tempBufPtr, bufPtrType);
[5452]1072        producedItemCount[i] = kb->getProducedItemCount(mStreamSetOutputs[i].name);
1073        blockBasePos.push_back(kb->CreateAnd(producedItemCount[i], blockBaseMask));
1074        mStreamSetOutputBuffers[i]->createBlockAlignedCopy(kb.get(), tempBufPtr, outputBlockPtr[i], kb->CreateSub(producedItemCount[i], blockBasePos[i]));
[5454]1075        Value * itemAddress = kb->CreatePtrToInt(kb->getRawOutputPointer(mStreamSetOutputs[i].name, kb->getInt32(0), producedItemCount[i]), intAddrTy);
[5446]1076        Value * outputPtr = kb->getOutputStreamBlockPtr(mStreamSetOutputs[i].name, kb->getInt32(0));
[5454]1077        Value * baseAddress = kb->CreatePtrToInt(outputPtr, intAddrTy);
1078        Value * tempAddress = kb->CreateAdd(kb->CreatePtrToInt(tempBufPtr, intAddrTy), kb->CreateSub(itemAddress, baseAddress));
[5460]1079        tempArgs.push_back(kb->CreateIntToPtr(tempAddress, bufPtrType));
[5439]1080    }
1081
[5446]1082    kb->CreateCall(multiBlockFunction, tempArgs);
1083
[5439]1084    // Copy back data to the actual output buffers.
[5440]1085
[5439]1086    for (unsigned i = 0; i < mStreamSetOutputBuffers.size(); i++) {
[5446]1087        Value * tempBufPtr = kb->CreateGEP(tempParameterArea, kb->getInt32(mStreamSetInputs.size() + i));
1088        tempBufPtr = kb->CreatePointerCast(tempBufPtr, mStreamSetOutputBuffers[i]->getPointerType());
[5452]1089        Value * finalItems = kb->getProducedItemCount(mStreamSetOutputs[i].name);
1090        Value * copyItems = kb->CreateSub(finalItems, blockBasePos[i]);
[5479]1091        // Round up to exact multiple of block size.
1092        copyItems = kb->CreateAnd(kb->CreateAdd(copyItems, kb->getSize(bitBlockWidth - 1)), blockBaseMask);
[5501]1093        Value * writableFromBase = kb->getLinearlyWritableItems(mStreamSetOutputs[i].name, blockBasePos[i]); // must be a whole number of blocks.
[5452]1094        Value * copyItems1 = kb->CreateSelect(kb->CreateICmpULT(copyItems, writableFromBase), copyItems, writableFromBase);
[5479]1095        Value * copyBlocks1 = kb->CreateUDiv(copyItems1, blockSize);
1096        mStreamSetOutputBuffers[i]->createBlockCopy(kb.get(), outputBlockPtr[i], tempBufPtr, copyBlocks1);
[5452]1097        Value * copyItems2 = kb->CreateSub(copyItems, copyItems1);
[5479]1098        tempBufPtr = kb->CreateGEP(tempBufPtr, copyBlocks1);
[5452]1099        Value * outputBaseBlockPtr = kb->CreateGEP(kb->getBaseAddress(mStreamSetOutputs[i].name), kb->getInt32(0));
[5479]1100        mStreamSetOutputBuffers[i]->createBlockAlignedCopy(kb.get(), outputBaseBlockPtr, tempBufPtr, kb->CreateUDiv(copyItems2, blockSize));
[5439]1101    }
1102
[5452]1103    kb->setProcessedItemCount(mStreamSetInputs[0].name, finalItemCountNeeded[0]);
[5439]1104
1105    //  We've dealt with the partial block processing and copied information back into the
1106    //  actual buffers.  If this isn't the final block, loop back for more multiblock processing.
1107    //
[5497]1108    stridesRemaining->addIncoming(kb->CreateSub(stridesRemaining, kb->CreateZExt(haveStrides, kb->getSizeTy())), kb->GetInsertBlock());
1109    kb->CreateCondBr(haveStrides, doSegmentOuterLoop, segmentDone);
[5446]1110    kb->SetInsertPoint(segmentDone);
[5439]1111}
[5440]1112
1113void Kernel::finalizeInstance(const std::unique_ptr<KernelBuilder> & idb) {
1114    assert ("KernelBuilder does not have a valid IDISA Builder" && idb);
1115    mOutputScalarResult = idb->CreateCall(getTerminateFunction(idb->getModule()), { getInstance() });
1116}
1117
1118Kernel::StreamPort Kernel::getStreamPort(const std::string & name) const {
1119    const auto f = mStreamMap.find(name);
1120    if (LLVM_UNLIKELY(f == mStreamMap.end())) {
1121        report_fatal_error(getName() + " does not contain stream set " + name);
1122    }
1123    return f->second;
1124}
1125
[5454]1126static inline std::string annotateKernelNameWithDebugFlags(std::string && name) {
1127    if (codegen::EnableAsserts) {
1128        name += "_EA";
1129    }
1130    return name;
1131}
1132
[5285]1133// CONSTRUCTOR
[5435]1134Kernel::Kernel(std::string && kernelName,
[5454]1135               std::vector<Binding> && stream_inputs,
1136               std::vector<Binding> && stream_outputs,
1137               std::vector<Binding> && scalar_parameters,
1138               std::vector<Binding> && scalar_outputs,
1139               std::vector<Binding> && internal_scalars)
[5493]1140: KernelInterface(annotateKernelNameWithDebugFlags(std::move(kernelName))
[5454]1141                  , std::move(stream_inputs), std::move(stream_outputs)
1142                  , std::move(scalar_parameters), std::move(scalar_outputs)
1143                  , std::move(internal_scalars))
[5350]1144, mCurrentMethod(nullptr)
[5408]1145, mNoTerminateAttribute(false)
[5418]1146, mIsGenerated(false)
1147, mIsFinal(nullptr)
1148, mOutputScalarResult(nullptr) {
[5283]1149
1150}
1151
[5435]1152Kernel::~Kernel() {
[5283]1153
[5408]1154}
1155
[5285]1156// CONSTRUCTOR
[5435]1157BlockOrientedKernel::BlockOrientedKernel(std::string && kernelName,
[5408]1158                                         std::vector<Binding> && stream_inputs,
1159                                         std::vector<Binding> && stream_outputs,
1160                                         std::vector<Binding> && scalar_parameters,
1161                                         std::vector<Binding> && scalar_outputs,
1162                                         std::vector<Binding> && internal_scalars)
[5435]1163: Kernel(std::move(kernelName), std::move(stream_inputs), std::move(stream_outputs), std::move(scalar_parameters), std::move(scalar_outputs), std::move(internal_scalars))
[5408]1164, mDoBlockMethod(nullptr)
1165, mStrideLoopBody(nullptr)
1166, mStrideLoopBranch(nullptr)
1167, mStrideLoopTarget(nullptr) {
1168
1169}
1170
1171// CONSTRUCTOR
[5441]1172MultiBlockKernel::MultiBlockKernel(std::string && kernelName,
[5454]1173                                   std::vector<Binding> && stream_inputs,
1174                                   std::vector<Binding> && stream_outputs,
1175                                   std::vector<Binding> && scalar_parameters,
1176                                   std::vector<Binding> && scalar_outputs,
1177                                   std::vector<Binding> && internal_scalars)
[5497]1178: Kernel(std::move(kernelName), std::move(stream_inputs), std::move(stream_outputs), std::move(scalar_parameters), std::move(scalar_outputs), std::move(internal_scalars))
1179, mStride(0) {
[5441]1180}
1181
1182// CONSTRUCTOR
[5435]1183SegmentOrientedKernel::SegmentOrientedKernel(std::string && kernelName,
[5283]1184                                             std::vector<Binding> && stream_inputs,
1185                                             std::vector<Binding> && stream_outputs,
1186                                             std::vector<Binding> && scalar_parameters,
1187                                             std::vector<Binding> && scalar_outputs,
1188                                             std::vector<Binding> && internal_scalars)
[5435]1189: Kernel(std::move(kernelName), std::move(stream_inputs), std::move(stream_outputs), std::move(scalar_parameters), std::move(scalar_outputs), std::move(internal_scalars)) {
[5441]1190   
[5283]1191}
[5441]1192   
[5435]1193}
Note: See TracBrowser for help on using the repository browser.