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

Last change on this file since 5865 was 5865, checked in by nmedfort, 15 months ago

More work on the pipeline I/O rate handling

File size: 78.2 KB
Line 
1/*
2 *  Copyright (c) 2018 International Characters.
3 *  This software is licensed to the public under the Open Software License 3.0.
4 */
5
6#include "kernel.h"
7#include <toolchain/toolchain.h>
8#include <kernels/streamset.h>
9#include <llvm/IR/Constants.h>
10#include <llvm/IR/Function.h>
11#include <llvm/IR/Instructions.h>
12#include <llvm/IR/MDBuilder.h>
13#include <llvm/IR/Module.h>
14#include <llvm/Support/raw_ostream.h>
15#if LLVM_VERSION_INTEGER < LLVM_VERSION_CODE(4, 0, 0)
16#include <llvm/Bitcode/ReaderWriter.h>
17#else
18#include <llvm/Bitcode/BitcodeWriter.h>
19#endif
20#include <llvm/Transforms/Utils/Local.h>
21#include <kernels/streamset.h>
22#include <sstream>
23#include <kernels/kernel_builder.h>
24#include <boost/math/common_factor.hpp>
25#include <llvm/Support/Debug.h>
26
27using namespace llvm;
28using namespace parabix;
29using namespace boost::math;
30
31namespace kernel {
32
33const std::string Kernel::DO_BLOCK_SUFFIX = "_DoBlock";
34const std::string Kernel::FINAL_BLOCK_SUFFIX = "_FinalBlock";
35const std::string Kernel::MULTI_BLOCK_SUFFIX = "_MultiBlock";
36const std::string Kernel::LOGICAL_SEGMENT_NO_SCALAR = "logicalSegNo";
37const std::string Kernel::PROCESSED_ITEM_COUNT_SUFFIX = "_processedItemCount";
38const std::string Kernel::CONSUMED_ITEM_COUNT_SUFFIX = "_consumedItemCount";
39const std::string Kernel::PRODUCED_ITEM_COUNT_SUFFIX = "_producedItemCount";
40const std::string Kernel::TERMINATION_SIGNAL = "terminationSignal";
41const std::string Kernel::BUFFER_PTR_SUFFIX = "_bufferPtr";
42const std::string Kernel::CONSUMER_SUFFIX = "_consumerLocks";
43const std::string Kernel::CYCLECOUNT_SCALAR = "CPUcycles";
44
45/** ------------------------------------------------------------------------------------------------------------- *
46 * @brief addScalar
47 ** ------------------------------------------------------------------------------------------------------------- */
48unsigned Kernel::addScalar(Type * const type, const std::string & name) {
49    if (LLVM_UNLIKELY(mKernelStateType != nullptr)) {
50        report_fatal_error("Cannot add field " + name + " to " + getName() + " after kernel state finalized");
51    }
52    if (LLVM_UNLIKELY(mKernelFieldMap.count(name))) {
53        report_fatal_error(getName() + " already contains scalar field " + name);
54    }
55    const auto index = mKernelFields.size();
56    mKernelFieldMap.emplace(name, index);
57    mKernelFields.push_back(type);
58    return index;
59}
60
61
62/** ------------------------------------------------------------------------------------------------------------- *
63 * @brief addUnnamedScalar
64 ** ------------------------------------------------------------------------------------------------------------- */
65unsigned Kernel::addUnnamedScalar(Type * const type) {
66    if (LLVM_UNLIKELY(mKernelStateType != nullptr)) {
67        report_fatal_error("Cannot add unnamed field  to " + getName() + " after kernel state finalized");
68    }
69    const auto index = mKernelFields.size();
70    mKernelFields.push_back(type);
71    return index;
72}
73
74
75/** ------------------------------------------------------------------------------------------------------------- *
76 * @brief prepareStreamSetNameMap
77 ** ------------------------------------------------------------------------------------------------------------- */
78void Kernel::prepareStreamSetNameMap() {
79    for (unsigned i = 0; i < mStreamSetInputs.size(); i++) {
80        mStreamMap.emplace(mStreamSetInputs[i].getName(), std::make_pair(Port::Input, i));
81    }
82    for (unsigned i = 0; i < mStreamSetOutputs.size(); i++) {
83        mStreamMap.emplace(mStreamSetOutputs[i].getName(), std::make_pair(Port::Output, i));
84    }
85}
86
87
88/** ------------------------------------------------------------------------------------------------------------- *
89 * @brief bindPorts
90 ** ------------------------------------------------------------------------------------------------------------- */
91void Kernel::bindPorts(const StreamSetBuffers & inputs, const StreamSetBuffers & outputs) {
92    assert (mModule == nullptr);
93    assert (mStreamSetInputBuffers.empty());
94    assert (mStreamSetOutputBuffers.empty());
95
96    if (LLVM_UNLIKELY(mStreamSetInputs.size() != inputs.size())) {
97        report_fatal_error(getName() + ": expected " + std::to_string(mStreamSetInputs.size()) +
98                           " input stream sets but was given "
99                           + std::to_string(inputs.size()));
100    }
101
102    for (unsigned i = 0; i < inputs.size(); ++i) {
103        StreamSetBuffer * const buf = inputs[i];
104        if (LLVM_UNLIKELY(buf == nullptr)) {
105            report_fatal_error(getName() + ": input stream set " + std::to_string(i)
106                               + " cannot be null");
107        }
108        buf->addConsumer(this);
109    }
110
111    if (LLVM_UNLIKELY(mStreamSetOutputs.size() != outputs.size())) {
112        report_fatal_error(getName() + ": expected " + std::to_string(mStreamSetOutputs.size())
113                           + " output stream sets but was given "
114                           + std::to_string(outputs.size()));
115    }
116
117    for (unsigned i = 0; i < outputs.size(); ++i) {
118        StreamSetBuffer * const buf = outputs[i];
119        if (LLVM_UNLIKELY(buf == nullptr)) {
120            report_fatal_error(getName() + ": output stream set " + std::to_string(i) + " cannot be null");
121        }
122        if (LLVM_LIKELY(buf->getProducer() == nullptr)) {
123            buf->setProducer(this);
124        } else {
125            report_fatal_error(getName() + ": output stream set " + std::to_string(i)
126                               + " is already produced by kernel " + buf->getProducer()->getName());
127        }
128    }
129
130    mStreamSetInputBuffers.assign(inputs.begin(), inputs.end());
131    mStreamSetOutputBuffers.assign(outputs.begin(), outputs.end());
132}
133
134
135/** ------------------------------------------------------------------------------------------------------------- *
136 * @brief getCacheName
137 ** ------------------------------------------------------------------------------------------------------------- */
138std::string Kernel::getCacheName(const std::unique_ptr<KernelBuilder> & idb) const {
139    std::stringstream cacheName;
140    cacheName << getName() << '_' << idb->getBuilderUniqueName();
141    for (const StreamSetBuffer * b: mStreamSetInputBuffers) {
142        cacheName <<  ':' <<  b->getUniqueID();
143    }
144    for (const StreamSetBuffer * b: mStreamSetOutputBuffers) {
145        cacheName <<  ':' <<  b->getUniqueID();
146    }
147    return cacheName.str();
148}
149
150
151/** ------------------------------------------------------------------------------------------------------------- *
152 * @brief setModule
153 ** ------------------------------------------------------------------------------------------------------------- */
154Module * Kernel::setModule(Module * const module) {
155    assert (mModule == nullptr || mModule == module);
156    assert (module != nullptr);
157    mModule = module;
158    return mModule;
159}
160
161
162/** ------------------------------------------------------------------------------------------------------------- *
163 * @brief makeModule
164 ** ------------------------------------------------------------------------------------------------------------- */
165Module * Kernel::makeModule(const std::unique_ptr<kernel::KernelBuilder> & idb) {
166    Module * m = new Module(getCacheName(idb), idb->getContext());
167    m->setTargetTriple(idb->getModule()->getTargetTriple());
168    m->setDataLayout(idb->getModule()->getDataLayout());
169    return setModule(m);
170}
171
172
173/** ------------------------------------------------------------------------------------------------------------- *
174 * @brief prepareKernel
175 ** ------------------------------------------------------------------------------------------------------------- */
176void Kernel::prepareKernel(const std::unique_ptr<KernelBuilder> & idb) {
177    assert ("KernelBuilder does not have a valid IDISA Builder" && idb);
178    if (LLVM_UNLIKELY(mKernelStateType != nullptr)) {
179        report_fatal_error(getName() + ": cannot prepare kernel after kernel state finalized");
180    }
181    addBaseKernelProperties(idb);
182    addInternalKernelProperties(idb);
183    // NOTE: StructType::create always creates a new type even if an identical one exists.
184    if (LLVM_UNLIKELY(mModule == nullptr)) {
185        makeModule(idb);
186    }
187    mKernelStateType = mModule->getTypeByName(getName());
188    if (LLVM_LIKELY(mKernelStateType == nullptr)) {
189        mKernelStateType = StructType::create(idb->getContext(), mKernelFields, getName());
190        assert (mKernelStateType);
191    }
192}
193
194
195/** ------------------------------------------------------------------------------------------------------------- *
196 * @brief prepareCachedKernel
197 ** ------------------------------------------------------------------------------------------------------------- */
198void Kernel::prepareCachedKernel(const std::unique_ptr<KernelBuilder> & idb) {
199    assert ("KernelBuilder does not have a valid IDISA Builder" && idb);
200    if (LLVM_UNLIKELY(mKernelStateType != nullptr)) {
201        report_fatal_error(getName() + ": cannot prepare kernel after kernel state finalized");
202    }
203    assert (getModule());
204    addBaseKernelProperties(idb);
205    mKernelStateType = getModule()->getTypeByName(getName());
206    if (LLVM_UNLIKELY(mKernelStateType == nullptr)) {
207        report_fatal_error("Kernel definition for " + getName() + " could not be found in the cache object");
208    }
209}
210
211/** ------------------------------------------------------------------------------------------------------------- *
212 * @brief addBaseKernelProperties
213 ** ------------------------------------------------------------------------------------------------------------- */
214void Kernel::addBaseKernelProperties(const std::unique_ptr<KernelBuilder> & idb) {
215
216    assert (mStreamMap.empty());
217
218    prepareStreamSetNameMap();
219
220    normalizeStreamProcessingRates();
221
222    const unsigned inputSetCount = mStreamSetInputs.size();
223    const unsigned outputSetCount = mStreamSetOutputs.size();
224
225    assert (inputSetCount == mStreamSetInputBuffers.size());
226    assert (outputSetCount == mStreamSetOutputBuffers.size());
227
228    if (mStride == 0) {
229        // Set the default kernel stride.
230        mStride = idb->getBitBlockWidth();
231    }
232
233    IntegerType * const sizeTy = idb->getSizeTy();
234
235    for (unsigned i = 0; i < inputSetCount; i++) {
236        const Binding & b = mStreamSetInputs[i];
237        //const ProcessingRate & rate = b.getRate();
238        //if (rate.isBounded() || rate.isUnknown()) {
239            addScalar(sizeTy, b.getName() + PROCESSED_ITEM_COUNT_SUFFIX);
240        //}
241    }
242
243    for (unsigned i = 0; i < outputSetCount; i++) {
244        const Binding & b = mStreamSetOutputs[i];
245        //const ProcessingRate & rate = b.getRate();
246        //if (rate.isBounded() || rate.isUnknown()) {
247            addScalar(sizeTy, b.getName() + PRODUCED_ITEM_COUNT_SUFFIX);
248        //}
249    }
250
251    for (unsigned i = 0; i < inputSetCount; i++) {
252        mScalarInputs.emplace_back(mStreamSetInputBuffers[i]->getStreamSetHandle()->getType(), mStreamSetInputs[i].getName() + BUFFER_PTR_SUFFIX);
253    }
254    for (unsigned i = 0; i < outputSetCount; i++) {
255        mScalarInputs.emplace_back(mStreamSetOutputBuffers[i]->getStreamSetHandle()->getType(), mStreamSetOutputs[i].getName() + BUFFER_PTR_SUFFIX);
256    }
257    for (const auto & binding : mScalarInputs) {
258        addScalar(binding.getType(), binding.getName());
259    }
260    for (const auto & binding : mScalarOutputs) {
261        addScalar(binding.getType(), binding.getName());
262    }
263    for (const auto & binding : mInternalScalars) {
264        addScalar(binding.getType(), binding.getName());
265    }
266    Type * const consumerSetTy = StructType::get(idb->getContext(), {sizeTy, sizeTy->getPointerTo()->getPointerTo()})->getPointerTo();
267    for (unsigned i = 0; i < mStreamSetOutputs.size(); i++) {
268        addScalar(consumerSetTy, mStreamSetOutputs[i].getName() + CONSUMER_SUFFIX);
269    }
270    addScalar(sizeTy, LOGICAL_SEGMENT_NO_SCALAR);
271    addScalar(sizeTy, TERMINATION_SIGNAL);
272    for (unsigned i = 0; i < mStreamSetOutputs.size(); i++) {
273        addScalar(sizeTy, mStreamSetOutputs[i].getName() + CONSUMED_ITEM_COUNT_SUFFIX);
274    }
275    // We compile in a 64-bit CPU cycle counter into every kernel.   It will remain unused
276    // in normal execution, but when codegen::EnableCycleCounter is specified, pipelines
277    // will be able to add instrumentation to cached modules without recompilation.
278    addScalar(idb->getInt64Ty(), CYCLECOUNT_SCALAR);
279
280}
281
282
283/** ------------------------------------------------------------------------------------------------------------- *
284 * @brief makeSignature
285 *
286 * Default kernel signature: generate the IR and emit as byte code.
287 ** ------------------------------------------------------------------------------------------------------------- */
288std::string Kernel::makeSignature(const std::unique_ptr<kernel::KernelBuilder> & idb) {
289    assert ("KernelBuilder does not have a valid IDISA Builder" && idb.get());
290    if (LLVM_UNLIKELY(hasSignature())) {
291        generateKernel(idb);
292        std::string tmp;
293        raw_string_ostream signature(tmp);
294        WriteBitcodeToFile(getModule(), signature);
295        return signature.str();
296    } else {
297        return getModule()->getModuleIdentifier();
298    }
299}
300
301
302/** ------------------------------------------------------------------------------------------------------------- *
303 * @brief generateKernel
304 ** ------------------------------------------------------------------------------------------------------------- */
305void Kernel::generateKernel(const std::unique_ptr<kernel::KernelBuilder> & idb) {
306    assert ("Kernel does not have a valid IDISA Builder" && idb.get());
307    if (LLVM_UNLIKELY(mIsGenerated)) return;
308    idb->setModule(mModule);
309    addKernelDeclarations(idb);
310    callGenerateInitializeMethod(idb);
311    callGenerateDoSegmentMethod(idb);
312    callGenerateFinalizeMethod(idb);
313    mIsGenerated = true;
314}
315
316
317/** ------------------------------------------------------------------------------------------------------------- *
318 * @brief callGenerateInitializeMethod
319 ** ------------------------------------------------------------------------------------------------------------- */
320inline void Kernel::callGenerateInitializeMethod(const std::unique_ptr<kernel::KernelBuilder> & idb) {
321    mCurrentMethod = getInitFunction(idb->getModule());
322    idb->SetInsertPoint(BasicBlock::Create(idb->getContext(), "entry", mCurrentMethod));
323    Function::arg_iterator args = mCurrentMethod->arg_begin();
324    setInstance(&*(args++));
325    idb->CreateStore(ConstantAggregateZero::get(mKernelStateType), getInstance());
326    for (const auto & binding : mScalarInputs) {
327        idb->setScalarField(binding.getName(), &*(args++));
328    }
329    for (const auto & binding : mStreamSetOutputs) {
330        idb->setConsumerLock(binding.getName(), &*(args++));
331    }
332    generateInitializeMethod(idb);
333    idb->CreateRetVoid();
334}
335
336/** ------------------------------------------------------------------------------------------------------------- *
337 * @brief callGenerateDoSegmentMethod
338 ** ------------------------------------------------------------------------------------------------------------- */
339inline void Kernel::callGenerateDoSegmentMethod(const std::unique_ptr<kernel::KernelBuilder> & idb) {
340    mCurrentMethod = getDoSegmentFunction(idb->getModule());
341    idb->SetInsertPoint(BasicBlock::Create(idb->getContext(), "entry", mCurrentMethod));
342    auto args = mCurrentMethod->arg_begin();
343    setInstance(&*(args++));
344    mIsFinal = &*(args++);
345    mAvailablePrincipalItemCount = nullptr;
346    const auto n = mStreamSetInputs.size();
347    mAvailableItemCount.resize(n, nullptr);
348    for (unsigned i = 0; i < n; i++) {
349        assert (args != mCurrentMethod->arg_end());
350        mAvailableItemCount[i] = &*(args++);
351    }
352    assert (args == mCurrentMethod->arg_end());
353    generateKernelMethod(idb); // must be overridden by the Kernel subtype
354    mIsFinal = nullptr;
355    mAvailableItemCount.clear();
356    idb->CreateRetVoid();
357}
358
359
360/** ------------------------------------------------------------------------------------------------------------- *
361 * @brief callGenerateFinalizeMethod
362 ** ------------------------------------------------------------------------------------------------------------- */
363inline void Kernel::callGenerateFinalizeMethod(const std::unique_ptr<KernelBuilder> & idb) {
364    mCurrentMethod = getTerminateFunction(idb->getModule());
365    idb->SetInsertPoint(BasicBlock::Create(idb->getContext(), "entry", mCurrentMethod));
366    auto args = mCurrentMethod->arg_begin();
367    setInstance(&*(args++));
368    generateFinalizeMethod(idb); // may be overridden by the Kernel subtype
369    const auto n = mScalarOutputs.size();
370    if (n == 0) {
371        idb->CreateRetVoid();
372    } else {
373        Value * outputs[n];
374        for (unsigned i = 0; i < n; ++i) {
375            outputs[i] = idb->getScalarField(mScalarOutputs[i].getName());
376        }
377        if (n == 1) {
378            idb->CreateRet(outputs[0]);
379        } else {
380            idb->CreateAggregateRet(outputs, n);
381        }
382    }
383}
384
385
386/** ------------------------------------------------------------------------------------------------------------- *
387 * @brief getScalarIndex
388 ** ------------------------------------------------------------------------------------------------------------- */
389unsigned Kernel::getScalarIndex(const std::string & name) const {
390    const auto f = mKernelFieldMap.find(name);
391    if (LLVM_UNLIKELY(f == mKernelFieldMap.end())) {
392        assert (false);
393        report_fatal_error(getName() + " does not contain scalar: " + name);
394    }
395    return f->second;
396}
397
398
399/** ------------------------------------------------------------------------------------------------------------- *
400 * @brief createInstance
401 ** ------------------------------------------------------------------------------------------------------------- */
402Value * Kernel::createInstance(const std::unique_ptr<KernelBuilder> & idb) {
403    assert ("KernelBuilder does not have a valid IDISA Builder" && idb);
404    if (LLVM_UNLIKELY(mKernelStateType == nullptr)) {
405        report_fatal_error("Cannot instantiate " + getName() + " before calling prepareKernel()");
406    }
407    setInstance(idb->CreateCacheAlignedAlloca(mKernelStateType));
408    return getInstance();
409}
410
411
412/** ------------------------------------------------------------------------------------------------------------- *
413 * @brief initializeInstance
414 ** ------------------------------------------------------------------------------------------------------------- */
415void Kernel::initializeInstance(const std::unique_ptr<KernelBuilder> & idb) {
416    assert ("KernelBuilder does not have a valid IDISA Builder" && idb);
417    if (LLVM_UNLIKELY(getInstance() == nullptr)) {
418        report_fatal_error("Cannot initialize " + getName() + " before calling createInstance()");
419    }
420    std::vector<Value *> args;
421    args.reserve(1 + mInitialArguments.size() + mStreamSetInputBuffers.size() + (mStreamSetOutputBuffers.size() * 2));
422    args.push_back(getInstance());
423    for (unsigned i = 0; i < mInitialArguments.size(); ++i) {
424        Value * arg = mInitialArguments[i];
425        if (LLVM_UNLIKELY(arg == nullptr)) {
426            report_fatal_error(getName() + ": initial argument " + std::to_string(i)
427                               + " cannot be null when calling createInstance()");
428        }
429        args.push_back(arg);
430    }
431    for (unsigned i = 0; i < mStreamSetInputBuffers.size(); ++i) {
432        assert (mStreamSetInputBuffers[i]);
433        Value * arg = mStreamSetInputBuffers[i]->getStreamSetHandle();
434        if (LLVM_UNLIKELY(arg == nullptr)) {
435            report_fatal_error(getName() + ": input stream set " + std::to_string(i)
436                               + " was not allocated prior to calling createInstance()");
437        }
438        args.push_back(arg);
439    }
440    assert (mStreamSetInputs.size() == mStreamSetInputBuffers.size());
441    for (unsigned i = 0; i < mStreamSetOutputBuffers.size(); ++i) {
442        assert (mStreamSetOutputBuffers[i]);
443        Value * arg = mStreamSetOutputBuffers[i]->getStreamSetHandle();
444        if (LLVM_UNLIKELY(arg == nullptr)) {
445            report_fatal_error(getName() + ": output stream set " + std::to_string(i)
446                               + " was not allocated prior to calling createInstance()");
447        }
448        args.push_back(arg);
449    }
450    assert (mStreamSetOutputs.size() == mStreamSetOutputBuffers.size());
451    IntegerType * const sizeTy = idb->getSizeTy();
452    PointerType * const sizePtrTy = sizeTy->getPointerTo();
453    PointerType * const sizePtrPtrTy = sizePtrTy->getPointerTo();
454    StructType * const consumerTy = StructType::get(idb->getContext(), {sizeTy, sizePtrPtrTy});
455    for (unsigned i = 0; i < mStreamSetOutputBuffers.size(); ++i) {
456        const auto output = mStreamSetOutputBuffers[i];
457        const auto & consumers = output->getConsumers();
458        const auto n = consumers.size();
459        AllocaInst * const outputConsumers = idb->CreateAlloca(consumerTy);
460        Value * const consumerSegNoArray = idb->CreateAlloca(ArrayType::get(sizePtrTy, n));
461        for (unsigned i = 0; i < n; ++i) {
462            Kernel * const consumer = consumers[i];
463            assert ("all instances must be created prior to initialization of any instance" && consumer->getInstance());
464            idb->setKernel(consumer);
465            Value * const segmentNoPtr = idb->getScalarFieldPtr(LOGICAL_SEGMENT_NO_SCALAR);
466            idb->CreateStore(segmentNoPtr, idb->CreateGEP(consumerSegNoArray, { idb->getInt32(0), idb->getInt32(i) }));
467        }
468        idb->setKernel(this);
469        Value * const consumerCountPtr = idb->CreateGEP(outputConsumers, {idb->getInt32(0), idb->getInt32(0)});
470        idb->CreateStore(idb->getSize(n), consumerCountPtr);
471        Value * const consumerSegNoArrayPtr = idb->CreateGEP(outputConsumers, {idb->getInt32(0), idb->getInt32(1)});
472        idb->CreateStore(idb->CreatePointerCast(consumerSegNoArray, sizePtrPtrTy), consumerSegNoArrayPtr);
473        args.push_back(outputConsumers);
474    }
475    idb->CreateCall(getInitFunction(idb->getModule()), args);
476}
477
478/** ------------------------------------------------------------------------------------------------------------- *
479 * @brief finalizeInstance
480 ** ------------------------------------------------------------------------------------------------------------- */
481void Kernel::finalizeInstance(const std::unique_ptr<KernelBuilder> & idb) {
482    assert ("KernelBuilder does not have a valid IDISA Builder" && idb);
483    mOutputScalarResult = idb->CreateCall(getTerminateFunction(idb->getModule()), { getInstance() });
484}
485
486/** ------------------------------------------------------------------------------------------------------------- *
487 * @brief getStreamPort
488 ** ------------------------------------------------------------------------------------------------------------- */
489Kernel::StreamPort Kernel::getStreamPort(const std::string & name) const {
490    const auto f = mStreamMap.find(name);
491    if (LLVM_UNLIKELY(f == mStreamMap.end())) {
492        report_fatal_error(getName() + " does not contain stream set " + name);
493    }
494    return f->second;
495}
496
497/** ------------------------------------------------------------------------------------------------------------- *
498 * @brief getStreamPort
499 ** ------------------------------------------------------------------------------------------------------------- */
500const Binding & Kernel::getBinding(const std::string & name) const {
501    Port port; unsigned index;
502    std::tie(port, index) = getStreamPort(name);
503    return (port == Port::Input) ? getStreamInput(index) : getStreamOutput(index);
504}
505
506/** ------------------------------------------------------------------------------------------------------------- *
507 * @brief getLowerBound
508 ** ------------------------------------------------------------------------------------------------------------- */
509ProcessingRate::RateValue Kernel::getLowerBound(const ProcessingRate & rate) const {
510    if (rate.isFixed() || rate.isBounded()) {
511        return rate.getLowerBound();
512    } else if (rate.isRelative()) {
513        return rate.getRate() * getLowerBound(getBinding(rate.getReference()).getRate());
514    } else { // if (rate.isUnknown())
515        return 0;
516    }
517}
518
519/** ------------------------------------------------------------------------------------------------------------- *
520 * @brief getUpperBound
521 ** ------------------------------------------------------------------------------------------------------------- */
522ProcessingRate::RateValue Kernel::getUpperBound(const ProcessingRate &rate) const {
523    if (rate.isFixed() || rate.isBounded()) {
524        return rate.getUpperBound();
525    } else if (rate.isRelative()) {
526        return rate.getRate() * getUpperBound(getBinding(rate.getReference()).getRate());
527    } else { // if (rate.isUnknown())
528        return 0;
529    }
530}
531
532/** ------------------------------------------------------------------------------------------------------------- *
533 * @brief normalizeRelativeToFixedProcessingRate
534 ** ------------------------------------------------------------------------------------------------------------- */
535bool Kernel::normalizeRelativeToFixedProcessingRate(const ProcessingRate & base, ProcessingRate & toUpdate) {
536    if (base.isFixed()) {
537        return true;
538    } else if (LLVM_UNLIKELY(base.isRelative())) {
539        const auto & ref = getBinding(base.getReference()).getRate();
540        if (normalizeRelativeToFixedProcessingRate(ref, toUpdate)) {
541            toUpdate.getRate() *= ref.getRate();
542            return true;
543        }
544    }
545    return false;
546}
547
548/** ------------------------------------------------------------------------------------------------------------- *
549 * @brief normalizeStreamProcessingRates
550 *
551 * If we allow a stream to be transitively relative to a fixed rate stream, it complicates detection of fixed
552 * rate streams later. Find any such occurance and transform them. This implies, however, that a fixed rate
553 * stream could have a rational processing rate (which should not occur normally.)
554 ** ------------------------------------------------------------------------------------------------------------- */
555inline void Kernel::normalizeStreamProcessingRates() {
556    for (Binding & input : mStreamSetInputs) {
557        normalizeRelativeToFixedProcessingRate(input.getRate(), input.getRate());
558    }
559    for (Binding & output : mStreamSetOutputs) {
560        normalizeRelativeToFixedProcessingRate(output.getRate(), output.getRate());
561    }
562    // TODO: we want to consume whole units. Once the pipeline is able to schedule kernels based on their stride
563    // and input/output rates, modify them here.
564}
565
566/** ------------------------------------------------------------------------------------------------------------- *
567 * @brief generateKernelMethod
568 ** ------------------------------------------------------------------------------------------------------------- */
569void SegmentOrientedKernel::generateKernelMethod(const std::unique_ptr<KernelBuilder> & b) {
570    const auto inputSetCount = mStreamSetInputs.size();
571    mStreamSetInputBaseAddress.resize(inputSetCount);
572    for (unsigned i = 0; i < inputSetCount; ++i) {
573        mStreamSetInputBaseAddress[i] = nullptr;
574    }
575    const auto outputSetCount = mStreamSetOutputs.size();
576    mStreamSetOutputBaseAddress.resize(outputSetCount);
577    for (unsigned i = 0; i < outputSetCount; ++i) {
578        mStreamSetOutputBaseAddress[i] = nullptr;
579    }
580    generateDoSegmentMethod(b);
581}
582
583/** ------------------------------------------------------------------------------------------------------------- *
584 * @brief requiresBufferedFinalStride
585 ** ------------------------------------------------------------------------------------------------------------- */
586inline bool LLVM_READNONE requiresBufferedFinalStride(const Binding & binding) {
587    if (LLVM_LIKELY(isa<ArrayType>(binding.getType()))) {
588        return binding.getType()->getArrayNumElements() == 1;
589    }
590    return true;
591}
592
593/** ------------------------------------------------------------------------------------------------------------- *
594 * @brief getItemWidth
595 ** ------------------------------------------------------------------------------------------------------------- */
596inline unsigned LLVM_READNONE getItemWidth(const Binding & b) {
597    Type * ty = b.getType();
598    if (LLVM_LIKELY(isa<ArrayType>(ty))) {
599        ty = ty->getArrayElementType();
600    }
601    return cast<IntegerType>(ty->getVectorElementType())->getBitWidth();
602}
603
604/** ------------------------------------------------------------------------------------------------------------- *
605 * @brief isTransitivelyUnknownRate
606 ** ------------------------------------------------------------------------------------------------------------- */
607bool LLVM_READNONE MultiBlockKernel::isTransitivelyUnknownRate(const ProcessingRate & rate) const {
608    if (rate.isUnknown()) {
609        return true;
610    } else if (rate.isDerived()) {
611        return isTransitivelyUnknownRate(getBinding(rate.getReference()).getRate());
612    }
613    return false;
614}
615
616/** ------------------------------------------------------------------------------------------------------------- *
617 * @brief requiresTemporaryInputBuffer
618 ** ------------------------------------------------------------------------------------------------------------- */
619inline bool LLVM_READNONE MultiBlockKernel::requiresTemporaryInputBuffer(const Binding & binding, const ProcessingRate & rate) const {
620    if (requiresBufferedFinalStride(binding)) {
621        return true;
622    } else if (LLVM_UNLIKELY(isTransitivelyUnknownRate(rate))) {
623        report_fatal_error("MultiBlock kernels do not support unknown rate input streams or streams relative to an unknown rate input.");
624    } else {
625        return !rate.isFixed();
626    }
627}
628
629/** ------------------------------------------------------------------------------------------------------------- *
630 * @brief requiresTemporaryOutputBuffer
631 ** ------------------------------------------------------------------------------------------------------------- */
632inline bool LLVM_READNONE MultiBlockKernel::requiresTemporaryOutputBuffer(const Binding & binding, const ProcessingRate & rate) const {
633    if (requiresBufferedFinalStride(binding)) {
634        return true;
635    } else {
636        return !(rate.isFixed() || isTransitivelyUnknownRate(rate));
637    }
638}
639
640/** ------------------------------------------------------------------------------------------------------------- *
641 * @brief getItemAlignment
642 ** ------------------------------------------------------------------------------------------------------------- */
643inline unsigned LLVM_READNONE MultiBlockKernel::getItemAlignment(const Binding & binding) const {
644    const auto & rate = binding.getRate();
645    if (rate.isFixed() && binding.nonDeferred() && !binding.isMisaligned()) {
646        const auto r = rate.getRate();
647        auto n = (r.numerator() * mStride);
648        if (LLVM_LIKELY(r.denominator() == 1)) {
649            return n;
650        } else if (LLVM_LIKELY((n % r.denominator()) == 0)) {
651            return n / r.denominator();
652        }
653    }
654    return 1; // ∀x GCD(x, x + 1) = 1
655}
656
657/** ------------------------------------------------------------------------------------------------------------- *
658 * @brief getCopyAlignment
659 ** ------------------------------------------------------------------------------------------------------------- */
660inline unsigned LLVM_READNONE MultiBlockKernel::getCopyAlignment(const Binding & binding) const {
661    return ((getItemAlignment(binding) * getItemWidth(binding)) + 7) / 8;
662}
663
664/** ------------------------------------------------------------------------------------------------------------- *
665 * @brief getStrideSize
666 ** ------------------------------------------------------------------------------------------------------------- */
667llvm::Value * LLVM_READNONE MultiBlockKernel::getStrideSize(const std::unique_ptr<KernelBuilder> & b, const ProcessingRate & rate) {
668    // NOTE: if we ever support feedback loops, using upper bound could lead to a deadlock due to data starvation
669    const auto r = getUpperBound(rate);
670    if (r.numerator() == 0) {
671        return nullptr;
672    } else {
673        assert ((r.numerator() * mStride) % r.denominator() == 0);
674        return b->getSize((r.numerator() * mStride) / r.denominator());
675    }
676}
677
678// #define DEBUG_LOG
679
680/** ------------------------------------------------------------------------------------------------------------- *
681 * @brief generateKernelMethod
682 ** ------------------------------------------------------------------------------------------------------------- */
683void MultiBlockKernel::generateKernelMethod(const std::unique_ptr<KernelBuilder> & b) {
684
685    if (LLVM_UNLIKELY((mStride % b->getBitBlockWidth()) != 0)) {
686        report_fatal_error(getName() + ": the Stride (" + std::to_string(mStride) + ") of MultiBlockKernel "
687                           "must be a multiple of the BitBlockWidth (" + std::to_string(b->getBitBlockWidth()) + ")");
688    }
689
690    using RateValue = ProcessingRate::RateValue;
691
692    const auto inputSetCount = mStreamSetInputs.size();
693    const auto outputSetCount = mStreamSetOutputs.size();
694
695    // Define and allocate the temporary buffer area in the prolog.   
696    const auto blockAlignment = b->getBitBlockWidth() / 8;
697    AllocaInst * temporaryInputBuffer[inputSetCount];
698    for (unsigned i = 0; i < inputSetCount; ++i) {       
699        const Binding & input = mStreamSetInputs[i];
700        const ProcessingRate & rate = input.getRate();
701        temporaryInputBuffer[i] = nullptr;
702        if (requiresTemporaryInputBuffer(input, rate)) {
703            Type * const ty = mStreamSetInputBuffers[i]->getStreamSetBlockType();
704            auto ub = getUpperBound(rate);
705            assert (ub != 0);
706            if (LLVM_UNLIKELY(input.hasLookahead())) {
707                ub += RateValue(input.getLookahead(), mStride);
708            }
709            Constant * const arraySize = b->getInt64(ceiling(ub));
710            AllocaInst * const ptr = b->CreateAlignedAlloca(ty, blockAlignment, arraySize);
711            assert (ptr->isStaticAlloca());
712            temporaryInputBuffer[i] = ptr;
713        }
714    }
715
716    AllocaInst * temporaryOutputBuffer[outputSetCount];
717    for (unsigned i = 0; i < outputSetCount; i++) {
718        const Binding & output = mStreamSetOutputs[i];
719        const ProcessingRate & rate = output.getRate();
720        temporaryOutputBuffer[i] = nullptr;
721        if (requiresTemporaryOutputBuffer(output, rate)) {
722            auto ub = getUpperBound(rate);
723            if (ub > 0) {
724                if (LLVM_UNLIKELY(mStreamSetOutputBuffers[i]->supportsCopyBack() && requiresCopyBack(rate))) {
725                    ub += mStreamSetOutputBuffers[i]->overflowSize();
726                }
727                Type * const ty = mStreamSetOutputBuffers[i]->getStreamSetBlockType();
728                Constant * const arraySize = b->getInt64(ceiling(ub));
729                AllocaInst * const ptr = b->CreateAlignedAlloca(ty, blockAlignment, arraySize);
730                assert (ptr->isStaticAlloca());
731                temporaryOutputBuffer[i] = ptr;
732            }
733        }
734    }
735
736    Constant * const ZERO = b->getSize(0);
737    Constant * const ONE = b->getSize(1);
738    Constant * const LOG_2_BLOCK_WIDTH = b->getSize(std::log2(b->getBitBlockWidth()));
739    Constant * const BLOCK_WIDTH_MASK = b->getSize(b->getBitBlockWidth() - 1);
740
741    if (LLVM_UNLIKELY(codegen::DebugOptionIsSet(codegen::EnableAsserts))) {
742        Value * terminatedTwice = b->CreateAnd(mIsFinal, b->getTerminationSignal());
743        Value * unprocessedData = nullptr;
744        for (unsigned i = 0; i < inputSetCount; i++) {
745            Value * processed = b->getProcessedItemCount(mStreamSetInputs[i].getName());
746            Value * const check = b->CreateICmpNE(processed, mAvailableItemCount[i]);
747            unprocessedData = unprocessedData ? b->CreateOr(unprocessedData, check) : check;
748        }
749        b->CreateAssertZero(b->CreateAnd(terminatedTwice, unprocessedData),
750                            getName() + " was called after its termination with additional input data");
751        b->CreateAssertZero(terminatedTwice,
752                            getName() + " was called after its termination");
753    }
754
755    mInitialAvailableItemCount.assign(mAvailableItemCount.begin(), mAvailableItemCount.end());
756    mInitialProcessedItemCount.resize(inputSetCount);
757    mStreamSetInputBaseAddress.resize(inputSetCount);
758
759    Value * const initiallyFinal = mIsFinal;
760    #ifdef DEBUG_LOG
761    b->CallPrintInt(getName() + "_initiallyFinal", initiallyFinal);
762    #endif
763    // Now proceed with creation of the doSegment method.
764    BasicBlock * const segmentLoop = b->CreateBasicBlock("SegmentLoop");
765
766    b->CreateBr(segmentLoop);
767
768    /// DO SEGMENT LOOP
769
770    b->SetInsertPoint(segmentLoop);
771
772    Value * numOfStrides = nullptr;
773
774    // TODO: we don't want the our available output space to limit how many conditional blocks we
775    // can check. When we have a conditional region, split computation of input/output strides and
776    // check as many input strides as possible but leave the kernel in a state that respects our
777    // available output space. NOTE: we know coming into this block that the pipeline or kernel has
778    // ensured there is at least one stride worth of space.
779
780
781    // For each input buffer, get the initial processed item count, base input pointer, and the number of
782    // linearly available strides.
783    Value * inputStrideSize[inputSetCount];
784    Value * linearlyAccessible[inputSetCount];
785    for (unsigned i = 0; i < inputSetCount; i++) {
786        const Binding & input = mStreamSetInputs[i];
787        const auto & name = input.getName();
788        Value * const processed = b->getProcessedItemCount(name);
789        #ifdef DEBUG_LOG
790        b->CallPrintInt(getName() + "_" + name + "_avail", mAvailableItemCount[i]);
791        b->CallPrintInt(getName() + "_" + name + "_processed", processed);
792        #endif
793        mInitialProcessedItemCount[i] = processed;
794        mStreamSetInputBaseAddress[i] = b->getBlockAddress(name, b->CreateLShr(processed, LOG_2_BLOCK_WIDTH));
795        if (LLVM_UNLIKELY(codegen::DebugOptionIsSet(codegen::EnableAsserts))) {
796            b->CreateAssert(b->CreateICmpULE(processed, mAvailableItemCount[i]),
797                            getName() + ": " + name + " processed item count exceeds its available item count");
798        }
799
800        Value * const unprocessed = b->CreateSub(mAvailableItemCount[i], processed);
801        #ifdef DEBUG_LOG
802        b->CallPrintInt(getName() + "_" + name + "_unprocessed", unprocessed);
803        #endif
804        Value * const accessible = b->getLinearlyAccessibleItems(name, processed, unprocessed);
805        #ifdef DEBUG_LOG
806        b->CallPrintInt(getName() + "_" + name + "_accessible", accessible);
807        #endif
808        mAvailableItemCount[i] = unprocessed;
809        linearlyAccessible[i] = accessible;
810        inputStrideSize[i] = getStrideSize(b, input.getRate());
811        Value * const accessibleStrides = b->CreateUDiv(accessible, inputStrideSize[i]);
812        numOfStrides = b->CreateUMin(numOfStrides, accessibleStrides);
813    }
814
815    BasicBlock * const checkInputAvailability = b->CreateBasicBlock("CheckInputAvailability");
816    BasicBlock * const selectOutputBuffers = b->CreateBasicBlock("SelectOutputBuffers");
817    b->CreateLikelyCondBr(b->CreateICmpNE(numOfStrides, ZERO), selectOutputBuffers, checkInputAvailability);
818
819    // Ensure that everything between S⌈P/S⌉ and S⌈n*(P + L)/S⌉ is linearly available, where S is the stride size,
820    // P is the current processed position, L is the lookahead amount and n is our number of accessible strides ∈ â„€+.
821    b->SetInsertPoint(checkInputAvailability);
822    Value * linearlyCopyable[inputSetCount];
823    PHINode * selectedInputBuffer[inputSetCount];
824    for (unsigned i = 0; i < inputSetCount; i++) {
825        AllocaInst * const tempBuffer = temporaryInputBuffer[i];
826        selectedInputBuffer[i] = nullptr;
827        if (tempBuffer) {
828
829            const Binding & input = mStreamSetInputs[i];
830            const auto & name = input.getName();
831            Value * const processed = mInitialProcessedItemCount[i];
832            Value * const unprocessed = mAvailableItemCount[i];
833            Value * const accessible = linearlyAccessible[i];
834
835            BasicBlock * const entry = b->GetInsertBlock();
836            BasicBlock * const copyFromBack = b->CreateBasicBlock(name + "CopyFromBack");
837            BasicBlock * const copyFromFront = b->CreateBasicBlock(name + "CopyFromFront");
838            BasicBlock * const resume = b->CreateBasicBlock(name + "Resume");
839
840            Value * strideSize = inputStrideSize[i];
841            if (LLVM_UNLIKELY(input.hasLookahead())) {
842                Constant * const lookahead = b->getSize(input.getLookahead());
843                strideSize = b->CreateAdd(strideSize, lookahead);
844            }
845            Value * const requiresCopy = b->CreateICmpULT(accessible, strideSize);
846            b->CreateUnlikelyCondBr(requiresCopy, copyFromBack, resume);
847
848            b->SetInsertPoint(copyFromBack);
849            Value * const arraySize = b->CreateZExt(tempBuffer->getArraySize(), b->getInt64Ty());
850            Value * const temporarySize = b->CreateTrunc(b->CreateMul(arraySize, b->getInt64(mStride)), accessible->getType());
851            Value * const copyable = b->CreateUMin(unprocessed, temporarySize); // <- we only really need strideSize items
852            Value * const offset = b->CreateAnd(processed, BLOCK_WIDTH_MASK);
853            Value * const bufferSize = b->CreateMul(ConstantExpr::getSizeOf(tempBuffer->getAllocatedType()), arraySize);
854            b->CreateMemZero(tempBuffer, bufferSize, blockAlignment);
855            b->CreateStreamCpy(name, tempBuffer, ZERO, mStreamSetInputBaseAddress[i], offset, accessible, getItemAlignment(input));
856            BasicBlock * const copyToBackEnd = b->GetInsertBlock();
857            b->CreateCondBr(b->CreateICmpNE(copyable, accessible), copyFromFront, resume);
858
859            b->SetInsertPoint(copyFromFront);
860            Value * const remaining = b->CreateSub(copyable, accessible);
861            Value * const baseAddress = b->getBaseAddress(name);
862            b->CreateStreamCpy(name, tempBuffer, accessible, baseAddress, ZERO, remaining, getItemAlignment(input));
863            Value * const isPartialStride = b->CreateICmpUGE(copyable, strideSize);
864            BasicBlock * const copyToFrontEnd = b->GetInsertBlock();
865            b->CreateBr(resume);
866
867            b->SetInsertPoint(resume);
868            PHINode * const address = b->CreatePHI(tempBuffer->getType(), 3);
869            address->addIncoming(mStreamSetInputBaseAddress[i], entry);
870            address->addIncoming(tempBuffer, copyToBackEnd);
871            address->addIncoming(tempBuffer, copyToFrontEnd);
872            selectedInputBuffer[i] = address;
873            PHINode * const available = b->CreatePHI(accessible->getType(), 3);
874            available->addIncoming(accessible, entry);
875            available->addIncoming(copyable, copyToBackEnd);
876            available->addIncoming(copyable, copyToFrontEnd);
877            linearlyCopyable[i] = available;
878            PHINode * const finalStride = b->CreatePHI(b->getInt1Ty(), 3);
879            finalStride->addIncoming(mIsFinal, entry);
880            finalStride->addIncoming(b->getTrue(), copyToBackEnd);
881            finalStride->addIncoming(isPartialStride, copyToFrontEnd);
882            mIsFinal = finalStride;
883            if (LLVM_UNLIKELY(codegen::DebugOptionIsSet(codegen::EnableAsserts))) {
884                Value * const hasStride = b->CreateOr(initiallyFinal, b->CreateNot(finalStride));
885                b->CreateAssert(hasStride, getName() + ": " + name + " has insufficient input data for one stride");
886            }
887        }
888    }
889
890    BasicBlock * const endCheckInputAvailability = b->GetInsertBlock();
891    selectOutputBuffers->moveAfter(endCheckInputAvailability);
892    b->CreateBr(selectOutputBuffers);
893
894    b->SetInsertPoint(selectOutputBuffers);
895    PHINode * const final = b->CreatePHI(mIsFinal->getType(), 2);
896    final->addIncoming(b->getFalse(), segmentLoop);
897    final->addIncoming(mIsFinal, endCheckInputAvailability);
898    mIsFinal = final;
899    for (unsigned i = 0; i < inputSetCount; i++) {
900        if (selectedInputBuffer[i]) {
901            PHINode * const address = b->CreatePHI(selectedInputBuffer[i]->getType(), 2);
902            address->addIncoming(mStreamSetInputBaseAddress[i], segmentLoop);
903            address->addIncoming(selectedInputBuffer[i], endCheckInputAvailability);
904            mStreamSetInputBaseAddress[i] = address;
905            PHINode * const accessible = b->CreatePHI(linearlyAccessible[i]->getType(), 2);
906            accessible->addIncoming(linearlyAccessible[i], segmentLoop);
907            accessible->addIncoming(linearlyCopyable[i], endCheckInputAvailability);
908            linearlyAccessible[i] = accessible;
909        }
910    }
911    PHINode * const strides = b->CreatePHI(numOfStrides->getType(), 2);
912    strides->addIncoming(numOfStrides, segmentLoop);
913    strides->addIncoming(ONE, endCheckInputAvailability);
914    numOfStrides = strides;
915
916    // Now determine the linearly writeable strides
917    Value * outputStrideSize[outputSetCount];
918    Value * linearlyWritable[outputSetCount];
919    mInitialProducedItemCount.resize(outputSetCount);
920    mStreamSetOutputBaseAddress.resize(outputSetCount);
921    for (unsigned i = 0; i < outputSetCount; i++) {
922        const auto & output = mStreamSetOutputs[i];
923        const auto & name = output.getName();
924        Value * const produced = b->getProducedItemCount(name);
925        #ifdef DEBUG_LOG
926        b->CallPrintInt(getName() + "_" + name + "_produced", produced);
927        #endif
928        Value * baseBuffer = b->getBlockAddress(name, b->CreateLShr(produced, LOG_2_BLOCK_WIDTH));
929        mInitialProducedItemCount[i] = produced;
930        mStreamSetOutputBaseAddress[i] = baseBuffer;
931        linearlyWritable[i] = nullptr;
932        // Is the number of linearly writable items sufficient for a stride?
933        outputStrideSize[i] = getStrideSize(b, output.getRate());
934        if (outputStrideSize[i]) {
935            linearlyWritable[i] = b->getLinearlyWritableItems(name, produced);
936            Value * writableStrides = b->CreateUDiv(linearlyWritable[i], outputStrideSize[i]);
937            numOfStrides = b->CreateUMin(numOfStrides, writableStrides);
938            // Do we require a temporary buffer to write to?
939            AllocaInst * const tempBuffer = temporaryOutputBuffer[i];
940            if (tempBuffer) {
941                assert (tempBuffer->getType() == baseBuffer->getType());
942                BasicBlock * const entry = b->GetInsertBlock();
943                BasicBlock * const prepareTempBuffer = b->CreateBasicBlock(name + "PrepareTempBuffer");
944                BasicBlock * const resume = b->CreateBasicBlock(name + "Resume");
945                Value * const requiresCopy = b->CreateICmpEQ(writableStrides, ZERO);
946                b->CreateUnlikelyCondBr(requiresCopy, prepareTempBuffer, resume);
947                // Clear the output buffer prior to using it
948                b->SetInsertPoint(prepareTempBuffer);
949                Value * const bufferSize = b->CreateMul(ConstantExpr::getSizeOf(tempBuffer->getAllocatedType()), tempBuffer->getArraySize());
950                b->CreateMemZero(tempBuffer, bufferSize, blockAlignment);               
951                b->CreateBr(resume);
952                // Select the appropriate buffer / stride #
953                b->SetInsertPoint(resume);
954                PHINode * const phiBuffer = b->CreatePHI(baseBuffer->getType(), 3);
955                phiBuffer->addIncoming(baseBuffer, entry);
956                phiBuffer->addIncoming(tempBuffer, prepareTempBuffer);
957                baseBuffer = phiBuffer;
958                PHINode * const phiStrides = b->CreatePHI(b->getSizeTy(), 2);
959                phiStrides->addIncoming(numOfStrides, entry);
960                phiStrides->addIncoming(ONE, prepareTempBuffer);
961                numOfStrides = phiStrides;
962            }
963            if (LLVM_UNLIKELY(codegen::DebugOptionIsSet(codegen::EnableAsserts))) {
964                b->CreateAssert(numOfStrides, getName() + ": " + name + " has insufficient output space for one stride");
965            }
966        }
967    }
968
969    // Update the locally available item count to reflect the current state
970    for (unsigned i = 0; i < inputSetCount; i++) {
971        const Binding & input = mStreamSetInputs[i];
972        if (input.getRate().isFixed() && input.nonDeferred()) {
973            Value * const processable = b->CreateMul(numOfStrides, inputStrideSize[i]);
974            linearlyAccessible[i] = b->CreateSelect(mIsFinal, linearlyAccessible[i], processable);
975        }
976        mAvailableItemCount[i] = linearlyAccessible[i];
977    }
978
979    //  We have one or more strides of input data and output buffer space for all stream sets.
980    generateMultiBlockLogic(b, numOfStrides);
981
982    for (unsigned i = 0; i < inputSetCount; ++i) {
983        const auto & input = mStreamSetInputs[i];
984        const ProcessingRate & rate = input.getRate();
985        if (rate.isFixed() && input.nonDeferred()) {
986            Value * const ic = b->CreateAdd(mInitialProcessedItemCount[i], mAvailableItemCount[i]);
987            b->setProcessedItemCount(input.getName(), ic);
988        }
989    }
990
991    for (unsigned i = 0; i < outputSetCount; ++i) {
992        const auto & output = mStreamSetOutputs[i];
993        const ProcessingRate & rate = output.getRate();
994        if (rate.isFixed()) {
995            Value * const produced = b->CreateMul(numOfStrides, outputStrideSize[i]);
996            Value * const ic = b->CreateAdd(mInitialProducedItemCount[i], produced);
997            b->setProducedItemCount(output.getName(), ic);
998        }
999    }
1000
1001    BasicBlock * const handleFinalBlock = b->CreateBasicBlock("HandleFinalBlock");
1002    BasicBlock * const temporaryBufferCopyBack = b->CreateBasicBlock("TemporaryBufferCopyBack");
1003    BasicBlock * const strideDone = b->CreateBasicBlock("MultiBlockDone");
1004
1005    b->CreateUnlikelyCondBr(mIsFinal, handleFinalBlock, temporaryBufferCopyBack);
1006
1007
1008    /// FINAL STRIDE ADJUSTMENT
1009    b->SetInsertPoint(handleFinalBlock);
1010
1011    // If this is our final stride, adjust the Fixed output item counts. The main loop assumes that
1012    // the ITEM COUNT % FIXED RATE = 0 for all Fixed Input and Output streams. We correct that here
1013    // to calculate them based on the actual input item counts.
1014
1015    reviseFinalProducedItemCounts(b);
1016
1017    b->CreateBr(temporaryBufferCopyBack);
1018
1019    /// TEMPORARY BUFFER COPY BACK
1020    b->SetInsertPoint(temporaryBufferCopyBack);
1021
1022    // Copy back data to the actual output buffers.
1023    for (unsigned i = 0; i < outputSetCount; i++) {
1024        AllocaInst * const tempBuffer = temporaryOutputBuffer[i];
1025        if (LLVM_UNLIKELY(tempBuffer == nullptr)) {
1026            continue;
1027        }
1028        const auto & name = mStreamSetOutputs[i].getName();
1029        Value * const produced = b->getProducedItemCount(name);
1030        Value * const baseBuffer = mStreamSetOutputBaseAddress[i];
1031        assert ("stack corruption likely" && (tempBuffer->getType() == baseBuffer->getType()));
1032        //const auto & name = mStreamSetOutputs[i].getName();
1033        BasicBlock * const copyToBack = b->CreateBasicBlock(name + "CopyToBack");
1034        BasicBlock * const copyToFront = b->CreateBasicBlock(name + "CopyToFront");
1035        BasicBlock * const resume = b->CreateBasicBlock(name + "ResumeCopyBack");
1036        // If we used a temporary buffer, copy it back to the original output buffer
1037        Value * const requiresCopy = b->CreateICmpEQ(tempBuffer, baseBuffer);
1038        b->CreateCondBr(requiresCopy, copyToBack, resume);
1039
1040        b->SetInsertPoint(copyToBack);       
1041        Value * const offset = b->CreateAnd(mInitialProducedItemCount[i], BLOCK_WIDTH_MASK);
1042        //Value * const newProducedItemCount = b->getProducedItemCount(name);
1043        Value * const newlyProduced = b->CreateSub(produced, mInitialProducedItemCount[i]);
1044
1045
1046        Value * const toWrite = b->CreateUMin(newlyProduced, linearlyWritable[i]);
1047        const auto alignment = getItemAlignment(mStreamSetOutputs[i]);
1048        b->CreateStreamCpy(name, baseBuffer, offset, tempBuffer, ZERO, toWrite, alignment);
1049        // If we required a temporary output buffer, we will probably need to write to the beginning of the buffer as well.
1050        b->CreateLikelyCondBr(b->CreateICmpULT(toWrite, newlyProduced), copyToFront, resume);
1051
1052        b->SetInsertPoint(copyToFront);
1053        Value * const remaining = b->CreateSub(newlyProduced, toWrite);
1054        Value * const baseAddress = b->getBaseAddress(name);
1055        b->CreateStreamCpy(name, baseAddress, ZERO, tempBuffer, toWrite, remaining, alignment);
1056        b->CreateBr(resume);
1057
1058        b->SetInsertPoint(resume);
1059    }
1060
1061    //  We've dealt with the partial block processing and copied information back into the
1062    //  actual buffers.  If this isn't the final block, loop back for more multiblock processing.
1063    BasicBlock * const segmentDone = b->CreateBasicBlock("SegmentDone");
1064    if (canTerminateEarly()) {
1065        mIsFinal = b->CreateOr(mIsFinal, b->getTerminationSignal());
1066    }
1067    b->CreateCondBr(mIsFinal, segmentDone, strideDone);
1068
1069    /// STRIDE DONE
1070    strideDone->moveAfter(b->GetInsertBlock());
1071    b->SetInsertPoint(strideDone);
1072
1073    // do we have enough data for another stride?
1074    Value * hasMoreStrides = b->getTrue();
1075    for (unsigned i = 0; i < inputSetCount; ++i) {
1076        const Binding & input = mStreamSetInputs[i];
1077        const auto & name = input.getName();
1078        Value * const avail = mInitialAvailableItemCount[i];
1079        Value * const processed = b->getProcessedItemCount(name);
1080//        b->CallPrintInt(getName() + "_" + name + "_processed'", processed);
1081
1082        if (LLVM_UNLIKELY(codegen::DebugOptionIsSet(codegen::EnableAsserts))) {
1083            b->CreateAssert(b->CreateICmpULE(processed, avail), getName() + ": " + name + " processed data exceeds available data");
1084        }
1085        Value * const remaining = b->CreateSub(avail, processed);
1086        Value * strideSize = inputStrideSize[i];
1087        if (LLVM_UNLIKELY(input.hasLookahead())) {
1088            strideSize = b->CreateAdd(strideSize, b->getSize(input.getLookahead()));
1089        }
1090        Value * const hasRemainingStrides = b->CreateICmpUGE(remaining, strideSize);
1091        hasMoreStrides = b->CreateAnd(hasMoreStrides, hasRemainingStrides);
1092    }
1093
1094    // even if we do not have enough input data for a full stride, if this is our final stride, allow it ...
1095    hasMoreStrides = b->CreateOr(hasMoreStrides, initiallyFinal);
1096
1097    // do we have enough room for another stride?
1098    for (unsigned i = 0; i < outputSetCount; ++i) {
1099        const ProcessingRate & rate = mStreamSetOutputs[i].getRate();
1100        const auto & name = mStreamSetOutputs[i].getName();
1101        Value * const produced = b->getProducedItemCount(name);
1102
1103        // If this output has a Fixed/Bounded rate, determine whether we have room for another stride.
1104        if (LLVM_LIKELY(outputStrideSize[i] != nullptr)) {
1105            Value * const consumed = b->getConsumedItemCount(name);
1106            if (LLVM_UNLIKELY(codegen::DebugOptionIsSet(codegen::EnableAsserts))) {
1107                b->CreateAssert(b->CreateICmpULE(consumed, produced),
1108                                getName() + ": " + name + " consumed data exceeds produced data");
1109            }
1110            Value * const unconsumed = b->CreateSub(produced, consumed);
1111
1112//            b->CallPrintInt(getName() + "_" + name + "_unconsumed", unconsumed);
1113
1114            Value * const capacity = b->getBufferedSize(name);
1115
1116//            b->CallPrintInt(getName() + "_" + name + "_capacity", capacity);
1117
1118            if (LLVM_UNLIKELY(codegen::DebugOptionIsSet(codegen::EnableAsserts))) {
1119                b->CreateAssert(b->CreateICmpULE(unconsumed, capacity),
1120                                getName() + ": " + name + " more data was written than its capacity allows");
1121            }
1122
1123
1124
1125            Value * const remaining = b->CreateSub(capacity, unconsumed);
1126            Value * const hasRemainingStrides = b->CreateICmpUGE(remaining, outputStrideSize[i]);
1127            hasMoreStrides = b->CreateAnd(hasMoreStrides, hasRemainingStrides);
1128        }
1129        // Do copybacks if necessary.
1130        if (mStreamSetOutputBuffers[i]->supportsCopyBack() && requiresCopyBack(rate)) {
1131            BasicBlock * const copyBack = b->CreateBasicBlock(name + "CopyBack");
1132            BasicBlock * const done = b->CreateBasicBlock(name + "CopyBackDone");
1133
1134            Value * const bufferSize = b->getBufferedSize(name);
1135            Value * const prior = b->CreateURem(mInitialProducedItemCount[i], bufferSize);
1136            Value * const current = b->CreateURem(produced, bufferSize);
1137            b->CreateUnlikelyCondBr(b->CreateICmpUGT(prior, current), copyBack, done);
1138
1139            b->SetInsertPoint(copyBack);
1140            const auto copyAlignment = getItemAlignment(mStreamSetOutputs[i]);
1141            Value * const startOfBuffer = b->getBaseAddress(name);
1142            Value * const offset = b->CreateUDiv(bufferSize, b->getSize(b->getBitBlockWidth()));
1143            Value * const endOfBuffer = b->CreateGEP(startOfBuffer, offset);
1144            b->CreateStreamCpy(name, startOfBuffer, ZERO, endOfBuffer, ZERO, current, copyAlignment);
1145            b->CreateBr(done);
1146
1147            b->SetInsertPoint(done);
1148        }
1149    }
1150
1151    b->CreateCondBr(hasMoreStrides, segmentLoop, segmentDone);
1152
1153    /// SEGMENT DONE
1154    segmentDone->moveAfter(b->GetInsertBlock());
1155    b->SetInsertPoint(segmentDone);
1156
1157}
1158
1159/** ------------------------------------------------------------------------------------------------------------- *
1160 * @brief requiresCopyBack
1161 ** ------------------------------------------------------------------------------------------------------------- */
1162bool MultiBlockKernel::requiresCopyBack(const ProcessingRate & rate) const {
1163    if (rate.isBounded() || rate.isUnknown()) {
1164        return true;
1165    } else if (rate.isRelative()) {
1166        return requiresCopyBack(getBinding(rate.getReference()).getRate());
1167    }
1168    return false;
1169}
1170
1171/** ------------------------------------------------------------------------------------------------------------- *
1172 * @brief CreateUDivCeil
1173 ** ------------------------------------------------------------------------------------------------------------- */
1174inline Value * CreateUDivCeil(const std::unique_ptr<KernelBuilder> & b, Value * const number, const ProcessingRate::RateValue divisor, const Twine & Name = "") {
1175    Constant * const n = ConstantInt::get(number->getType(), divisor.numerator());
1176    if (LLVM_LIKELY(divisor.denominator() == 1)) {
1177        return b->CreateUDivCeil(number, n, Name);
1178    } else {
1179        //   âŒŠ(num + ratio - 1) / ratio⌋
1180        // = ⌊(num - 1) / (n/d)⌋ + (ratio/ratio)
1181        // = ⌊(d * (num - 1)) / n⌋ + 1
1182        Constant * const ONE = ConstantInt::get(number->getType(), 1);
1183        Constant * const d = ConstantInt::get(number->getType(), divisor.denominator());
1184        return b->CreateAdd(b->CreateUDiv(b->CreateMul(b->CreateSub(number, ONE), d), n), ONE, Name);
1185    }
1186}
1187
1188
1189/** ------------------------------------------------------------------------------------------------------------- *
1190 * @brief reviseFinalProducedItemCounts
1191 ** ------------------------------------------------------------------------------------------------------------- */
1192void MultiBlockKernel::reviseFinalProducedItemCounts(const std::unique_ptr<KernelBuilder> & b) {
1193
1194    if (LLVM_UNLIKELY(mStreamSetInputs.empty())) {
1195        return;
1196    }
1197
1198    const auto inputSetCount = mStreamSetInputs.size();
1199
1200    ProcessingRate::RateValue rateLCM(1);
1201    unsigned first = 0;
1202    unsigned last = inputSetCount;
1203
1204    for (unsigned i = 0; i < inputSetCount; ++i) {
1205        const ProcessingRate & pr = mStreamSetInputs[i].getRate();
1206        if (pr.isFixed()) {
1207            rateLCM = lcm(rateLCM, pr.getRate());
1208            if (mStreamSetInputs[i].isPrincipal()) {
1209                assert ("A kernel cannot have multiple principle input streams" && (first == 0 && last == inputSetCount));
1210                first = i;
1211                last = i + 1;
1212            }
1213        }       
1214    }
1215
1216    bool noFixedRateOutput = true;
1217
1218    for (const Binding & output : mStreamSetOutputs) {
1219        const ProcessingRate & pr = output.getRate();
1220        if (pr.isFixed()) {
1221            rateLCM = lcm(rateLCM, pr.getRate());
1222            noFixedRateOutput = false;
1223        }
1224    }
1225
1226    if (noFixedRateOutput) {
1227        return;
1228    }
1229
1230    Value * baseInitialProcessedItemCount = nullptr;
1231    Value * scaledInverseOfAvailItemCount = nullptr;
1232
1233    // For each Fixed output stream, this calculates:
1234
1235    //    CEILING(MIN(Available Item Count / Fixed Input Rate) * Fixed Output Rate)
1236
1237    // But avoids the possibility of overflow errors (assuming that each processed item count does not overflow)
1238
1239    for (unsigned i = first; i < last; ++i) {
1240        const ProcessingRate & pr = mStreamSetInputs[i].getRate();
1241        if (pr.isFixed()) {
1242            Value * p = mInitialProcessedItemCount[i];
1243            Value * a = b->CreateSub(mInitialAvailableItemCount[i], p);
1244            const auto & rate = pr.getRate();
1245            if (LLVM_UNLIKELY(rateLCM != rate)) {
1246                const auto factor = rateLCM / rate;
1247                if (LLVM_UNLIKELY(factor.numerator() > 1)) {
1248                    a = b->CreateMul(a, b->getSize(factor.numerator()));
1249                }
1250                if (LLVM_UNLIKELY(factor.denominator() > 1)) {
1251                    a = b->CreateUDiv(a, b->getSize(factor.denominator()));
1252                }
1253            }
1254            if (LLVM_UNLIKELY(rate.denominator() > 1)) {
1255                p = b->CreateMul(p, b->getSize(rate.denominator()));
1256            }
1257            if (LLVM_UNLIKELY(rate.numerator() > 1)) {
1258                p = b->CreateUDiv(p, b->getSize(rate.numerator()));
1259            }
1260            if (scaledInverseOfAvailItemCount) {
1261                scaledInverseOfAvailItemCount = b->CreateUMin(scaledInverseOfAvailItemCount, a);
1262                baseInitialProcessedItemCount = b->CreateUMin(baseInitialProcessedItemCount, p);
1263            } else {
1264                scaledInverseOfAvailItemCount = a;
1265                baseInitialProcessedItemCount = p;
1266            }
1267        }
1268    }
1269
1270    for (const Binding & output : mStreamSetOutputs) {
1271        const auto name = output.getName();
1272        const ProcessingRate & pr = output.getRate();
1273        Value * produced = nullptr;
1274        if (pr.isFixed() && output.nonDeferred()) {
1275            assert (baseInitialProcessedItemCount && scaledInverseOfAvailItemCount);
1276            const auto rate = pr.getRate();
1277            Value * p = baseInitialProcessedItemCount;
1278            if (LLVM_UNLIKELY(rate.numerator() != 1)) {
1279                p = b->CreateMul(p, b->getSize(rate.numerator()));
1280            }
1281            if (LLVM_UNLIKELY(rate.denominator() != 1)) {
1282                p = b->CreateUDiv(p, b->getSize(rate.denominator()));
1283            }
1284            Value * const ic = CreateUDivCeil(b, scaledInverseOfAvailItemCount, rateLCM / pr.getRate());
1285            produced = b->CreateAdd(p, ic);
1286        } else { // check if we have an attribute; if so, get the current produced count and adjust it
1287            bool noAttributes = true;
1288            for (const Attribute & attr : output.getAttributes()) {
1289                if (attr.isAdd() || attr.isRoundUpTo()) {
1290                    noAttributes = false;
1291                    break;
1292                }
1293            }
1294            if (noAttributes) {
1295                continue;
1296            }
1297            produced = b->getProducedItemCount(name);
1298        }
1299        for (const Attribute & attr : output.getAttributes()) {
1300            if (attr.isAdd()) {
1301                produced = b->CreateAdd(produced, b->getSize(attr.amount()));
1302            } else if (attr.isRoundUpTo()) {
1303                produced = b->CreateRoundUp(produced, b->getSize(attr.amount()));
1304            }
1305        }
1306        b->setProducedItemCount(name, produced);
1307    }
1308
1309}
1310
1311/** ------------------------------------------------------------------------------------------------------------- *
1312 * @brief generateMultiBlockLogic
1313 ** ------------------------------------------------------------------------------------------------------------- */
1314void BlockOrientedKernel::generateMultiBlockLogic(const std::unique_ptr<KernelBuilder> & b, Value * const numOfBlocks) {
1315
1316    if (LLVM_UNLIKELY(mStride != b->getBitBlockWidth())) {
1317        report_fatal_error(getName() + ": the Stride (" + std::to_string(mStride) + ") of BlockOrientedKernel "
1318                           "equal to the BitBlockWidth (" + std::to_string(b->getBitBlockWidth()) + ")");
1319    }
1320
1321    Constant * const LOG_2_BLOCK_WIDTH = b->getSize(std::log2(b->getBitBlockWidth()));
1322
1323    BasicBlock * const entryBlock = b->GetInsertBlock();
1324    mStrideLoopBody = b->CreateBasicBlock(getName() + "_strideLoopBody");
1325    BasicBlock * const stridesDone = b->CreateBasicBlock(getName() + "_stridesDone");
1326    BasicBlock * const doFinalBlock = b->CreateBasicBlock(getName() + "_doFinalBlock");
1327    BasicBlock * const segmentDone = b->CreateBasicBlock(getName() + "_segmentDone");
1328
1329    const auto inputSetCount = mStreamSetInputs.size();
1330    Value * baseProcessedIndex[inputSetCount];
1331    Value * baseInputAddress[inputSetCount];
1332    for (unsigned i = 0; i < inputSetCount; i++) {
1333        const ProcessingRate & rate = mStreamSetInputs[i].getRate();
1334        if (LLVM_UNLIKELY(!rate.isFixed())) {
1335            Value * const ic = mInitialProcessedItemCount[i];
1336            baseProcessedIndex[i] = b->CreateLShr(ic, LOG_2_BLOCK_WIDTH);
1337        }
1338        baseInputAddress[i] = mStreamSetInputBaseAddress[i];
1339    }
1340
1341    const auto outputSetCount = mStreamSetOutputs.size();
1342    Value * baseProducedIndex[outputSetCount];
1343    Value * baseOutputAddress[inputSetCount];
1344    for (unsigned i = 0; i < outputSetCount; i++) {
1345        const ProcessingRate & rate = mStreamSetOutputs[i].getRate();
1346        if (LLVM_UNLIKELY(!rate.isFixed())) {
1347            Value * const ic = b->getProducedItemCount(mStreamSetOutputs[i].getName());
1348            baseProducedIndex[i] = b->CreateLShr(ic, LOG_2_BLOCK_WIDTH);
1349        }
1350        baseOutputAddress[i] = mStreamSetOutputBaseAddress[i];
1351    }
1352
1353    b->CreateUnlikelyCondBr(mIsFinal, doFinalBlock, mStrideLoopBody);
1354
1355    /// BLOCK BODY
1356
1357    b->SetInsertPoint(mStrideLoopBody);
1358
1359    if (b->supportsIndirectBr()) {
1360        Value * const baseTarget = BlockAddress::get(segmentDone);
1361        mStrideLoopTarget = b->CreatePHI(baseTarget->getType(), 2, "strideTarget");
1362        mStrideLoopTarget->addIncoming(baseTarget, entryBlock);
1363    }
1364
1365    mStrideBlockIndex = b->CreatePHI(b->getSizeTy(), 2);
1366    mStrideBlockIndex->addIncoming(b->getSize(0), entryBlock);
1367
1368    /// GENERATE DO BLOCK METHOD
1369
1370    for (unsigned i = 0; i < inputSetCount; ++i) {
1371        Value * index = mStrideBlockIndex;
1372        const ProcessingRate & rate = mStreamSetInputs[i].getRate();
1373        if (LLVM_UNLIKELY(!rate.isFixed())) {
1374            Value * ic = b->getProcessedItemCount(mStreamSetInputs[i].getName());
1375            index = b->CreateSub(b->CreateLShr(ic, LOG_2_BLOCK_WIDTH), baseProcessedIndex[i]);
1376        }
1377        mStreamSetInputBaseAddress[i] = b->CreateGEP(mStreamSetInputBaseAddress[i], index);
1378    }
1379
1380    for (unsigned i = 0; i < outputSetCount; ++i) {
1381        Value * index = mStrideBlockIndex;
1382        const ProcessingRate & rate = mStreamSetOutputs[i].getRate();
1383        if (LLVM_UNLIKELY(!rate.isFixed())) {
1384            Value * ic = b->getProducedItemCount(mStreamSetOutputs[i].getName());
1385            index = b->CreateSub(b->CreateLShr(ic, LOG_2_BLOCK_WIDTH), baseProducedIndex[i]);
1386        }
1387        mStreamSetOutputBaseAddress[i] = b->CreateGEP(mStreamSetOutputBaseAddress[i], index);
1388    }
1389
1390    writeDoBlockMethod(b);
1391
1392    BasicBlock * const bodyEnd = b->GetInsertBlock();
1393    if (mStrideLoopTarget) {
1394        mStrideLoopTarget->addIncoming(mStrideLoopTarget, bodyEnd);
1395    }
1396
1397    Value * const nextIndex = b->CreateAdd(mStrideBlockIndex, b->getSize(1));
1398    mStrideBlockIndex->addIncoming(nextIndex, bodyEnd);
1399    Value * const notDone = b->CreateICmpULT(nextIndex, numOfBlocks);
1400    b->CreateCondBr(notDone, mStrideLoopBody, stridesDone);
1401
1402    stridesDone->moveAfter(bodyEnd);
1403
1404    /// STRIDE DONE
1405
1406    b->SetInsertPoint(stridesDone);
1407
1408    // Now conditionally perform the final block processing depending on the doFinal parameter.
1409    if (mStrideLoopTarget) {
1410        mStrideLoopBranch = b->CreateIndirectBr(mStrideLoopTarget, 3);
1411        mStrideLoopBranch->addDestination(doFinalBlock);
1412        mStrideLoopBranch->addDestination(segmentDone);
1413    } else {
1414        b->CreateUnlikelyCondBr(mIsFinal, doFinalBlock, segmentDone);
1415    }
1416
1417    doFinalBlock->moveAfter(stridesDone);
1418
1419    /// DO FINAL BLOCK
1420
1421    b->SetInsertPoint(doFinalBlock);
1422    for (unsigned i = 0; i < inputSetCount; ++i) {
1423        mStreamSetInputBaseAddress[i] = baseInputAddress[i];
1424    }
1425
1426    for (unsigned i = 0; i < outputSetCount; ++i) {
1427        mStreamSetOutputBaseAddress[i] = baseOutputAddress[i];
1428    }
1429
1430    writeFinalBlockMethod(b, getRemainingItems(b));
1431
1432    b->CreateBr(segmentDone);
1433
1434    segmentDone->moveAfter(b->GetInsertBlock());
1435
1436    b->SetInsertPoint(segmentDone);
1437
1438    // Update the branch prediction metadata to indicate that the likely target will be segmentDone
1439    if (mStrideLoopTarget) {
1440        MDBuilder mdb(b->getContext());
1441        const auto destinations = mStrideLoopBranch->getNumDestinations();
1442        uint32_t weights[destinations];
1443        for (unsigned i = 0; i < destinations; ++i) {
1444            weights[i] = (mStrideLoopBranch->getDestination(i) == segmentDone) ? 100 : 1;
1445        }
1446        ArrayRef<uint32_t> bw(weights, destinations);
1447        mStrideLoopBranch->setMetadata(LLVMContext::MD_prof, mdb.createBranchWeights(bw));
1448    }
1449
1450}
1451
1452/** ------------------------------------------------------------------------------------------------------------- *
1453 * @brief getRemainingItems
1454 ** ------------------------------------------------------------------------------------------------------------- */
1455Value * BlockOrientedKernel::getRemainingItems(const std::unique_ptr<KernelBuilder> & b) {
1456    Value * remainingItems = nullptr;
1457    const auto count = mStreamSetInputs.size();
1458    if (count == 1) {
1459        return mAvailableItemCount[0];
1460    } else {
1461        for (unsigned i = 0; i < count; i++) {
1462            if (mStreamSetInputs[i].isPrincipal()) {
1463                return mAvailableItemCount[i];
1464            }
1465        }
1466        for (unsigned i = 0; i < count; ++i) {
1467            const ProcessingRate & r = mStreamSetInputs[i].getRate();
1468            if (r.isFixed()) {
1469                Value * ic = CreateUDivCeil(b, mAvailableItemCount[i], r.getRate());
1470                if (remainingItems) {
1471                    remainingItems = b->CreateUMin(remainingItems, ic);
1472                } else {
1473                    remainingItems = ic;
1474                }
1475            }
1476        }
1477    }
1478    return remainingItems;
1479}
1480
1481/** ------------------------------------------------------------------------------------------------------------- *
1482 * @brief writeDoBlockMethod
1483 ** ------------------------------------------------------------------------------------------------------------- */
1484inline void BlockOrientedKernel::writeDoBlockMethod(const std::unique_ptr<KernelBuilder> & b) {
1485
1486    Value * const self = getInstance();
1487    Function * const cp = mCurrentMethod;
1488    auto ip = b->saveIP();
1489    std::vector<Value *> availableItemCount(0);
1490
1491    /// Check if the do block method is called and create the function if necessary
1492    if (!b->supportsIndirectBr()) {
1493
1494        std::vector<Type *> params;
1495        params.reserve(1 + mAvailableItemCount.size());
1496        params.push_back(self->getType());
1497        for (Value * avail : mAvailableItemCount) {
1498            params.push_back(avail->getType());
1499        }
1500
1501        FunctionType * const type = FunctionType::get(b->getVoidTy(), params, false);
1502        mCurrentMethod = Function::Create(type, GlobalValue::InternalLinkage, getName() + DO_BLOCK_SUFFIX, b->getModule());
1503        mCurrentMethod->setCallingConv(CallingConv::C);
1504        mCurrentMethod->setDoesNotThrow();
1505        auto args = mCurrentMethod->arg_begin();
1506        args->setName("self");
1507        setInstance(&*args);
1508        availableItemCount.reserve(mAvailableItemCount.size());
1509        while (++args != mCurrentMethod->arg_end()) {
1510            availableItemCount.push_back(&*args);
1511        }
1512        assert (availableItemCount.size() == mAvailableItemCount.size());
1513        mAvailableItemCount.swap(availableItemCount);
1514        b->SetInsertPoint(BasicBlock::Create(b->getContext(), "entry", mCurrentMethod));
1515    }
1516
1517    generateDoBlockMethod(b); // must be implemented by the BlockOrientedKernelBuilder subtype
1518
1519    if (!b->supportsIndirectBr()) {
1520        // Restore the DoSegment function state then call the DoBlock method
1521        b->CreateRetVoid();
1522        mDoBlockMethod = mCurrentMethod;
1523        b->restoreIP(ip);
1524        setInstance(self);
1525        mCurrentMethod = cp;
1526        mAvailableItemCount.swap(availableItemCount);
1527        CreateDoBlockMethodCall(b);
1528    }
1529
1530}
1531
1532/** ------------------------------------------------------------------------------------------------------------- *
1533 * @brief writeFinalBlockMethod
1534 ** ------------------------------------------------------------------------------------------------------------- */
1535inline void BlockOrientedKernel::writeFinalBlockMethod(const std::unique_ptr<KernelBuilder> & b, Value * remainingItems) {
1536
1537    Value * const self = getInstance();
1538    Function * const cp = mCurrentMethod;
1539    Value * const remainingItemCount = remainingItems;
1540    auto ip = b->saveIP();
1541    std::vector<Value *> availableItemCount(0);
1542
1543    if (!b->supportsIndirectBr()) {
1544        std::vector<Type *> params;
1545        params.reserve(2 + mAvailableItemCount.size());
1546        params.push_back(self->getType());
1547        params.push_back(b->getSizeTy());
1548        for (Value * avail : mAvailableItemCount) {
1549            params.push_back(avail->getType());
1550        }
1551        FunctionType * const type = FunctionType::get(b->getVoidTy(), params, false);
1552        mCurrentMethod = Function::Create(type, GlobalValue::InternalLinkage, getName() + FINAL_BLOCK_SUFFIX, b->getModule());
1553        mCurrentMethod->setCallingConv(CallingConv::C);
1554        mCurrentMethod->setDoesNotThrow();
1555        auto args = mCurrentMethod->arg_begin();
1556        args->setName("self");
1557        setInstance(&*args);
1558        remainingItems = &*(++args);
1559        remainingItems->setName("remainingItems");
1560        availableItemCount.reserve(mAvailableItemCount.size());
1561        while (++args != mCurrentMethod->arg_end()) {
1562            availableItemCount.push_back(&*args);
1563        }
1564        assert (availableItemCount.size() == mAvailableItemCount.size());
1565        mAvailableItemCount.swap(availableItemCount);
1566        b->SetInsertPoint(BasicBlock::Create(b->getContext(), "entry", mCurrentMethod));
1567    }
1568
1569    generateFinalBlockMethod(b, remainingItems); // may be implemented by the BlockOrientedKernel subtype
1570
1571    if (!b->supportsIndirectBr()) {
1572        b->CreateRetVoid();
1573        b->restoreIP(ip);
1574        setInstance(self);
1575        mAvailableItemCount.swap(availableItemCount);
1576        // Restore the DoSegment function state then call the DoFinal method
1577        std::vector<Value *> args;
1578        args.reserve(2 + mAvailableItemCount.size());
1579        args.push_back(self);
1580        args.push_back(remainingItemCount);
1581        args.insert(args.end(), mAvailableItemCount.begin(), mAvailableItemCount.end());
1582        b->CreateCall(mCurrentMethod, args);
1583        mCurrentMethod = cp;
1584    }
1585
1586}
1587
1588/** ------------------------------------------------------------------------------------------------------------- *
1589 * @brief generateFinalBlockMethod
1590 ** ------------------------------------------------------------------------------------------------------------- */
1591void BlockOrientedKernel::generateFinalBlockMethod(const std::unique_ptr<KernelBuilder> & b, Value * /* remainingItems */) {
1592    //  The default finalBlock method simply dispatches to the doBlock routine.
1593    CreateDoBlockMethodCall(b);
1594}
1595
1596void BlockOrientedKernel::CreateDoBlockMethodCall(const std::unique_ptr<KernelBuilder> & b) {
1597    if (b->supportsIndirectBr()) {
1598        BasicBlock * const bb = b->CreateBasicBlock("resume");
1599        mStrideLoopBranch->addDestination(bb);
1600        BasicBlock * const current = b->GetInsertBlock();
1601        mStrideLoopTarget->addIncoming(BlockAddress::get(bb), current);
1602        mStrideBlockIndex->addIncoming(b->getSize(0), current);
1603        b->CreateBr(mStrideLoopBody);
1604        bb->moveAfter(current);
1605        b->SetInsertPoint(bb);
1606    } else {
1607        std::vector<Value *> args;
1608        args.reserve(1 + mAvailableItemCount.size());
1609        args.push_back(getInstance());
1610        args.insert(args.end(), mAvailableItemCount.begin(), mAvailableItemCount.end());
1611        b->CreateCall(mDoBlockMethod, args);
1612    }
1613}
1614
1615static inline std::string annotateKernelNameWithDebugFlags(std::string && name) {
1616    if (LLVM_UNLIKELY(codegen::DebugOptionIsSet(codegen::EnableAsserts))) {
1617        name += "_EA";
1618    }
1619    name += "_O" + std::to_string((int)codegen::OptLevel);
1620    return name;
1621}
1622
1623// CONSTRUCTOR
1624Kernel::Kernel(std::string && kernelName,
1625               Bindings && stream_inputs,
1626               Bindings && stream_outputs,
1627               Bindings && scalar_parameters,
1628               Bindings && scalar_outputs,
1629               Bindings && internal_scalars)
1630: KernelInterface(annotateKernelNameWithDebugFlags(std::move(kernelName))
1631                  , std::move(stream_inputs), std::move(stream_outputs)
1632                  , std::move(scalar_parameters), std::move(scalar_outputs)
1633                  , std::move(internal_scalars))
1634, mCurrentMethod(nullptr)
1635, mAvailablePrincipalItemCount(nullptr)
1636, mStride(0)
1637, mIsFinal(nullptr)
1638, mOutputScalarResult(nullptr)
1639, mIsGenerated(false) {
1640
1641}
1642
1643Kernel::~Kernel() {
1644
1645}
1646
1647// MULTI-BLOCK KERNEL CONSTRUCTOR
1648MultiBlockKernel::MultiBlockKernel(std::string && kernelName,
1649                                   Bindings && stream_inputs,
1650                                   Bindings && stream_outputs,
1651                                   Bindings && scalar_parameters,
1652                                   Bindings && scalar_outputs,
1653                                   Bindings && internal_scalars)
1654: Kernel(std::move(kernelName), std::move(stream_inputs), std::move(stream_outputs), std::move(scalar_parameters), std::move(scalar_outputs), std::move(internal_scalars)) {
1655
1656}
1657
1658// CONSTRUCTOR
1659BlockOrientedKernel::BlockOrientedKernel(std::string && kernelName,
1660                                         Bindings && stream_inputs,
1661                                         Bindings && stream_outputs,
1662                                         Bindings && scalar_parameters,
1663                                         Bindings && scalar_outputs,
1664                                         Bindings && internal_scalars)
1665: MultiBlockKernel(std::move(kernelName), std::move(stream_inputs), std::move(stream_outputs), std::move(scalar_parameters), std::move(scalar_outputs), std::move(internal_scalars))
1666, mDoBlockMethod(nullptr)
1667, mStrideLoopBody(nullptr)
1668, mStrideLoopBranch(nullptr)
1669, mStrideLoopTarget(nullptr)
1670, mStrideBlockIndex(nullptr) {
1671
1672}
1673
1674// CONSTRUCTOR
1675SegmentOrientedKernel::SegmentOrientedKernel(std::string && kernelName,
1676                                             Bindings && stream_inputs,
1677                                             Bindings && stream_outputs,
1678                                             Bindings && scalar_parameters,
1679                                             Bindings && scalar_outputs,
1680                                             Bindings && internal_scalars)
1681: Kernel(std::move(kernelName), std::move(stream_inputs), std::move(stream_outputs), std::move(scalar_parameters), std::move(scalar_outputs), std::move(internal_scalars)) {
1682
1683}
1684
1685
1686}
Note: See TracBrowser for help on using the repository browser.