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

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

Bug fix for pipeline: it was terminating too early when there was insufficient output space to process all of the input for a kernel.

File size: 74.5 KB
Line 
1/*
2 *  Copyright (c) 2016-7 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_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    if (mStreamMap.empty()) {
217        prepareStreamSetNameMap();
218    }
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 signature;
293        raw_string_ostream OS(signature);
294        WriteBitcodeToFile(getModule(), OS);
295        return signature;
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 ("KernelBuilder does not have a valid IDISA Builder" && idb.get());
307    // If the module id cannot uniquely identify this kernel, "generateKernelSignature()" will have already
308    // generated the unoptimized IR.
309    if (!mIsGenerated) {
310        const auto m = idb->getModule();
311        const auto ip = idb->saveIP();
312        // const auto saveInstance = getInstance();
313        idb->setModule(mModule);
314        addKernelDeclarations(idb);
315        callGenerateInitializeMethod(idb);
316        callGenerateDoSegmentMethod(idb);
317        callGenerateFinalizeMethod(idb);
318        // setInstance(saveInstance);
319        idb->setModule(m);
320        idb->restoreIP(ip);
321        mIsGenerated = true;
322    }
323}
324
325
326/** ------------------------------------------------------------------------------------------------------------- *
327 * @brief callGenerateInitializeMethod
328 ** ------------------------------------------------------------------------------------------------------------- */
329inline void Kernel::callGenerateInitializeMethod(const std::unique_ptr<kernel::KernelBuilder> & idb) {
330    mCurrentMethod = getInitFunction(idb->getModule());
331    idb->SetInsertPoint(BasicBlock::Create(idb->getContext(), "entry", mCurrentMethod));
332    Function::arg_iterator args = mCurrentMethod->arg_begin();
333    setInstance(&*(args++));
334    idb->CreateStore(ConstantAggregateZero::get(mKernelStateType), getInstance());
335    for (const auto & binding : mScalarInputs) {
336        idb->setScalarField(binding.getName(), &*(args++));
337    }
338    for (const auto & binding : mStreamSetOutputs) {
339        idb->setConsumerLock(binding.getName(), &*(args++));
340    }
341    generateInitializeMethod(idb);
342    idb->CreateRetVoid();
343}
344
345/** ------------------------------------------------------------------------------------------------------------- *
346 * @brief callGenerateDoSegmentMethod
347 ** ------------------------------------------------------------------------------------------------------------- */
348inline void Kernel::callGenerateDoSegmentMethod(const std::unique_ptr<kernel::KernelBuilder> & idb) {
349    mCurrentMethod = getDoSegmentFunction(idb->getModule());
350    idb->SetInsertPoint(BasicBlock::Create(idb->getContext(), "entry", mCurrentMethod));
351    auto args = mCurrentMethod->arg_begin();
352    setInstance(&*(args++));
353    mIsFinal = &*(args++);
354    mAvailablePrincipalItemCount = nullptr;
355    const auto n = mStreamSetInputs.size();
356    mAvailableItemCount.resize(n, nullptr);
357    for (unsigned i = 0; i < n; i++) {
358        assert (args != mCurrentMethod->arg_end());
359        mAvailableItemCount[i] = &*(args++);
360    }
361    assert (args == mCurrentMethod->arg_end());
362    generateKernelMethod(idb); // must be overridden by the Kernel subtype
363    mIsFinal = nullptr;
364    mAvailableItemCount.clear();
365    idb->CreateRetVoid();
366}
367
368
369/** ------------------------------------------------------------------------------------------------------------- *
370 * @brief callGenerateFinalizeMethod
371 ** ------------------------------------------------------------------------------------------------------------- */
372inline void Kernel::callGenerateFinalizeMethod(const std::unique_ptr<KernelBuilder> & idb) {
373    mCurrentMethod = getTerminateFunction(idb->getModule());
374    idb->SetInsertPoint(BasicBlock::Create(idb->getContext(), "entry", mCurrentMethod));
375    auto args = mCurrentMethod->arg_begin();
376    setInstance(&*(args++));
377    generateFinalizeMethod(idb); // may be overridden by the Kernel subtype
378    const auto n = mScalarOutputs.size();
379    if (n == 0) {
380        idb->CreateRetVoid();
381    } else {
382        Value * outputs[n];
383        for (unsigned i = 0; i < n; ++i) {
384            outputs[i] = idb->getScalarField(mScalarOutputs[i].getName());
385        }
386        if (n == 1) {
387            idb->CreateRet(outputs[0]);
388        } else {
389            idb->CreateAggregateRet(outputs, n);
390        }
391    }
392}
393
394
395/** ------------------------------------------------------------------------------------------------------------- *
396 * @brief getScalarIndex
397 ** ------------------------------------------------------------------------------------------------------------- */
398unsigned Kernel::getScalarIndex(const std::string & name) const {
399    const auto f = mKernelFieldMap.find(name);
400    if (LLVM_UNLIKELY(f == mKernelFieldMap.end())) {
401        assert (false);
402        report_fatal_error(getName() + " does not contain scalar: " + name);
403    }
404    return f->second;
405}
406
407
408/** ------------------------------------------------------------------------------------------------------------- *
409 * @brief createInstance
410 ** ------------------------------------------------------------------------------------------------------------- */
411Value * Kernel::createInstance(const std::unique_ptr<KernelBuilder> & idb) {
412    assert ("KernelBuilder does not have a valid IDISA Builder" && idb);
413    if (LLVM_UNLIKELY(mKernelStateType == nullptr)) {
414        report_fatal_error("Cannot instantiate " + getName() + " before calling prepareKernel()");
415    }
416    setInstance(idb->CreateCacheAlignedAlloca(mKernelStateType));
417    return getInstance();
418}
419
420
421/** ------------------------------------------------------------------------------------------------------------- *
422 * @brief initializeInstance
423 ** ------------------------------------------------------------------------------------------------------------- */
424void Kernel::initializeInstance(const std::unique_ptr<KernelBuilder> & idb) {
425    assert ("KernelBuilder does not have a valid IDISA Builder" && idb);
426    if (LLVM_UNLIKELY(getInstance() == nullptr)) {
427        report_fatal_error("Cannot initialize " + getName() + " before calling createInstance()");
428    }
429    std::vector<Value *> args;
430    args.reserve(1 + mInitialArguments.size() + mStreamSetInputBuffers.size() + (mStreamSetOutputBuffers.size() * 2));
431    args.push_back(getInstance());
432    for (unsigned i = 0; i < mInitialArguments.size(); ++i) {
433        Value * arg = mInitialArguments[i];
434        if (LLVM_UNLIKELY(arg == nullptr)) {
435            report_fatal_error(getName() + ": initial argument " + std::to_string(i)
436                               + " cannot be null when calling createInstance()");
437        }
438        args.push_back(arg);
439    }
440    for (unsigned i = 0; i < mStreamSetInputBuffers.size(); ++i) {
441        assert (mStreamSetInputBuffers[i]);
442        Value * arg = mStreamSetInputBuffers[i]->getStreamSetHandle();
443        if (LLVM_UNLIKELY(arg == nullptr)) {
444            report_fatal_error(getName() + ": input stream set " + std::to_string(i)
445                               + " was not allocated prior to calling createInstance()");
446        }
447        args.push_back(arg);
448    }
449    assert (mStreamSetInputs.size() == mStreamSetInputBuffers.size());
450    for (unsigned i = 0; i < mStreamSetOutputBuffers.size(); ++i) {
451        assert (mStreamSetOutputBuffers[i]);
452        Value * arg = mStreamSetOutputBuffers[i]->getStreamSetHandle();
453        if (LLVM_UNLIKELY(arg == nullptr)) {
454            report_fatal_error(getName() + ": output stream set " + std::to_string(i)
455                               + " was not allocated prior to calling createInstance()");
456        }
457        args.push_back(arg);
458    }
459    assert (mStreamSetOutputs.size() == mStreamSetOutputBuffers.size());
460    IntegerType * const sizeTy = idb->getSizeTy();
461    PointerType * const sizePtrTy = sizeTy->getPointerTo();
462    PointerType * const sizePtrPtrTy = sizePtrTy->getPointerTo();
463    StructType * const consumerTy = StructType::get(idb->getContext(), {sizeTy, sizePtrPtrTy});
464    for (unsigned i = 0; i < mStreamSetOutputBuffers.size(); ++i) {
465        const auto output = mStreamSetOutputBuffers[i];
466        const auto & consumers = output->getConsumers();
467        const auto n = consumers.size();
468        AllocaInst * const outputConsumers = idb->CreateAlloca(consumerTy);
469        Value * const consumerSegNoArray = idb->CreateAlloca(ArrayType::get(sizePtrTy, n));
470        for (unsigned i = 0; i < n; ++i) {
471            Kernel * const consumer = consumers[i];
472            assert ("all instances must be created prior to initialization of any instance" && consumer->getInstance());
473            idb->setKernel(consumer);
474            Value * const segmentNoPtr = idb->getScalarFieldPtr(LOGICAL_SEGMENT_NO_SCALAR);
475            idb->CreateStore(segmentNoPtr, idb->CreateGEP(consumerSegNoArray, { idb->getInt32(0), idb->getInt32(i) }));
476        }
477        idb->setKernel(this);
478        Value * const consumerCountPtr = idb->CreateGEP(outputConsumers, {idb->getInt32(0), idb->getInt32(0)});
479        idb->CreateStore(idb->getSize(n), consumerCountPtr);
480        Value * const consumerSegNoArrayPtr = idb->CreateGEP(outputConsumers, {idb->getInt32(0), idb->getInt32(1)});
481        idb->CreateStore(idb->CreatePointerCast(consumerSegNoArray, sizePtrPtrTy), consumerSegNoArrayPtr);
482        args.push_back(outputConsumers);
483    }
484    idb->CreateCall(getInitFunction(idb->getModule()), args);
485}
486
487/** ------------------------------------------------------------------------------------------------------------- *
488 * @brief finalizeInstance
489 ** ------------------------------------------------------------------------------------------------------------- */
490void Kernel::finalizeInstance(const std::unique_ptr<KernelBuilder> & idb) {
491    assert ("KernelBuilder does not have a valid IDISA Builder" && idb);
492    mOutputScalarResult = idb->CreateCall(getTerminateFunction(idb->getModule()), { getInstance() });
493}
494
495/** ------------------------------------------------------------------------------------------------------------- *
496 * @brief getStreamPort
497 ** ------------------------------------------------------------------------------------------------------------- */
498Kernel::StreamPort Kernel::getStreamPort(const std::string & name) const {
499    const auto f = mStreamMap.find(name);
500    if (LLVM_UNLIKELY(f == mStreamMap.end())) {
501        report_fatal_error(getName() + " does not contain stream set " + name);
502    }
503    return f->second;
504}
505
506/** ------------------------------------------------------------------------------------------------------------- *
507 * @brief getStreamPort
508 ** ------------------------------------------------------------------------------------------------------------- */
509const Binding & Kernel::getBinding(const std::string & name) const {
510    Port port; unsigned index;
511    std::tie(port, index) = getStreamPort(name);
512    return (port == Port::Input) ? getStreamInput(index) : getStreamOutput(index);
513}
514
515/** ------------------------------------------------------------------------------------------------------------- *
516 * @brief getLowerBound
517 ** ------------------------------------------------------------------------------------------------------------- */
518ProcessingRate::RateValue Kernel::getLowerBound(const ProcessingRate & rate) const {
519    if (rate.isFixed() || rate.isBounded()) {
520        return rate.getLowerBound();
521    } else if (rate.isRelative()) {
522        return rate.getRate() * getLowerBound(getBinding(rate.getReference()).getRate());
523    } else { // if (rate.isUnknown())
524        return 0;
525    }
526}
527
528/** ------------------------------------------------------------------------------------------------------------- *
529 * @brief getUpperBound
530 ** ------------------------------------------------------------------------------------------------------------- */
531ProcessingRate::RateValue Kernel::getUpperBound(const ProcessingRate &rate) const {
532    if (rate.isFixed() || rate.isBounded()) {
533        return rate.getUpperBound();
534    } else if (rate.isRelative()) {
535        return rate.getRate() * getUpperBound(getBinding(rate.getReference()).getRate());
536    } else { // if (rate.isUnknown())
537        return 0;
538    }
539}
540
541/** ------------------------------------------------------------------------------------------------------------- *
542 * @brief normalizeRelativeToFixedProcessingRate
543 ** ------------------------------------------------------------------------------------------------------------- */
544bool Kernel::normalizeRelativeToFixedProcessingRate(const ProcessingRate & base, ProcessingRate & toUpdate) {
545    if (base.isFixed()) {
546        return true;
547    } else if (LLVM_UNLIKELY(base.isRelative())) {
548        const auto & ref = getBinding(base.getReference()).getRate();
549        if (normalizeRelativeToFixedProcessingRate(ref, toUpdate)) {
550            toUpdate.getRate() *= ref.getRate();
551            return true;
552        }
553    }
554    return false;
555}
556
557/** ------------------------------------------------------------------------------------------------------------- *
558 * @brief normalizeStreamProcessingRates
559 *
560 * If we allow a stream to be transitively relative to a fixed rate stream, it complicates detection of fixed
561 * rate streams later. Find any such occurance and transform them. This implies, however, that a fixed rate
562 * stream could have a rational processing rate (which should not occur normally.)
563 ** ------------------------------------------------------------------------------------------------------------- */
564inline void Kernel::normalizeStreamProcessingRates() {
565    for (Binding & input : mStreamSetInputs) {
566        normalizeRelativeToFixedProcessingRate(input.getRate(), input.getRate());
567    }
568    for (Binding & output : mStreamSetOutputs) {
569        normalizeRelativeToFixedProcessingRate(output.getRate(), output.getRate());
570    }
571    // TODO: we want to consume whole units. Once the pipeline is able to schedule kernels based on their stride
572    // and input/output rates, modify them here.
573}
574
575/** ------------------------------------------------------------------------------------------------------------- *
576 * @brief generateKernelMethod
577 ** ------------------------------------------------------------------------------------------------------------- */
578void SegmentOrientedKernel::generateKernelMethod(const std::unique_ptr<KernelBuilder> & b) {
579    const auto inputSetCount = mStreamSetInputs.size();
580    mStreamSetInputBaseAddress.resize(inputSetCount);
581    for (unsigned i = 0; i < inputSetCount; ++i) {
582        mStreamSetInputBaseAddress[i] = nullptr;
583    }
584    const auto outputSetCount = mStreamSetOutputs.size();
585    mStreamSetOutputBaseAddress.resize(outputSetCount);
586    for (unsigned i = 0; i < outputSetCount; ++i) {
587        mStreamSetOutputBaseAddress[i] = nullptr;
588    }
589    generateDoSegmentMethod(b);
590}
591
592/** ------------------------------------------------------------------------------------------------------------- *
593 * @brief requiresBufferedFinalStride
594 ** ------------------------------------------------------------------------------------------------------------- */
595inline bool requiresBufferedFinalStride(const Binding & binding) {
596    if (LLVM_LIKELY(isa<ArrayType>(binding.getType()))) {
597        return binding.getType()->getArrayNumElements() == 1;
598    }
599    return true;
600}
601
602/** ------------------------------------------------------------------------------------------------------------- *
603 * @brief getItemWidth
604 ** ------------------------------------------------------------------------------------------------------------- */
605inline unsigned getItemWidth(const Binding & b) {
606    Type * ty = b.getType();
607    if (LLVM_LIKELY(isa<ArrayType>(ty))) {
608        ty = ty->getArrayElementType();
609    }
610    return cast<IntegerType>(ty->getVectorElementType())->getBitWidth();
611}
612
613/** ------------------------------------------------------------------------------------------------------------- *
614 * @brief getUpperBound
615 ** ------------------------------------------------------------------------------------------------------------- */
616bool MultiBlockKernel::isTransitivelyUnknownRate(const ProcessingRate & rate) const {
617    if (rate.isUnknown()) {
618        return true;
619    } else if (rate.isDerived()) {
620        return isTransitivelyUnknownRate(getBinding(rate.getReference()).getRate());
621    }
622    return false;
623}
624
625/** ------------------------------------------------------------------------------------------------------------- *
626 * @brief getItemAlignment
627 ** ------------------------------------------------------------------------------------------------------------- */
628inline unsigned MultiBlockKernel::getItemAlignment(const Binding & binding) const {
629    const auto & rate = binding.getRate();
630    if (rate.isFixed() && binding.nonDeferred() && !binding.isMisaligned()) {
631        const auto r = rate.getRate();
632        auto n = (r.numerator() * mStride);
633        if (LLVM_LIKELY(r.denominator() == 1)) {
634            return n;
635        } else if (LLVM_LIKELY((n % r.denominator()) == 0)) {
636            return n / r.denominator();
637        }
638    }
639    return 1; // ∀x GCD(x, x + 1) = 1
640}
641
642/** ------------------------------------------------------------------------------------------------------------- *
643 * @brief getStrideSize
644 ** ------------------------------------------------------------------------------------------------------------- */
645llvm::Value * MultiBlockKernel::getStrideSize(const std::unique_ptr<KernelBuilder> & b, const ProcessingRate & rate) {
646    // NOTE: if we ever support feedback loops, using upper bound could lead to a deadlock due to data starvation
647    const auto r = getUpperBound(rate);
648    if (r.numerator() == 0) {
649        return nullptr;
650    } else {
651        assert ((r.numerator() * mStride) % r.denominator() == 0);
652        return b->getSize((r.numerator() * mStride) / r.denominator());
653    }
654}
655
656/** ------------------------------------------------------------------------------------------------------------- *
657 * @brief generateKernelMethod
658 ** ------------------------------------------------------------------------------------------------------------- */
659void MultiBlockKernel::generateKernelMethod(const std::unique_ptr<KernelBuilder> & b) {
660
661    if (LLVM_UNLIKELY((mStride % b->getBitBlockWidth()) != 0)) {
662        report_fatal_error(getName() + ": the Stride (" + std::to_string(mStride) + ") of MultiBlockKernel "
663                           "must be a multiple of the BitBlockWidth (" + std::to_string(b->getBitBlockWidth()) + ")");
664    }
665
666    using RateValue = ProcessingRate::RateValue;
667
668    const auto inputSetCount = mStreamSetInputs.size();
669    const auto outputSetCount = mStreamSetOutputs.size();
670
671    // Define and allocate the temporary buffer area in the prolog.
672    const auto blockAlignment = b->getBitBlockWidth() / 8;
673    AllocaInst * temporaryInputBuffer[inputSetCount];
674    for (unsigned i = 0; i < inputSetCount; ++i) {
675        const Binding & input = mStreamSetInputs[i];
676        const ProcessingRate & rate = input.getRate();
677        if (isTransitivelyUnknownRate(rate)) {
678            report_fatal_error("MultiBlock kernels do not support unknown rate input streams or streams relative to an unknown rate input.");
679        } else if (rate.isFixed() && !requiresBufferedFinalStride(input)) {
680            temporaryInputBuffer[i] = nullptr;
681        } else {
682            Type * const ty = mStreamSetInputBuffers[i]->getStreamSetBlockType();
683            auto ub = getUpperBound(rate);
684            if (LLVM_UNLIKELY(input.hasLookahead())) {
685                ub += RateValue(input.getLookahead(), mStride);
686            }
687            Constant * const arraySize = b->getInt64(ceiling(ub));
688            AllocaInst * const ptr = b->CreateAlignedAlloca(ty, blockAlignment, arraySize);
689            assert (ptr->isStaticAlloca());
690            temporaryInputBuffer[i] = ptr;
691        }
692    }
693
694    AllocaInst * temporaryOutputBuffer[outputSetCount];
695    for (unsigned i = 0; i < outputSetCount; i++) {
696        const Binding & output = mStreamSetOutputs[i];
697        const ProcessingRate & rate = output.getRate();
698        if (LLVM_UNLIKELY(isTransitivelyUnknownRate(rate) || (rate.isFixed() && !requiresBufferedFinalStride(output)))) {
699            temporaryOutputBuffer[i] = nullptr;
700        } else {           
701            auto ub = getUpperBound(rate);
702            if (LLVM_UNLIKELY(mStreamSetOutputBuffers[i]->supportsCopyBack() && requiresCopyBack(rate))) {
703                ub += mStreamSetOutputBuffers[i]->overflowSize();
704            }
705            Type * const ty = mStreamSetOutputBuffers[i]->getStreamSetBlockType();
706            Constant * const arraySize = b->getInt64(ceiling(ub));
707            AllocaInst * const ptr = b->CreateAlignedAlloca(ty, blockAlignment, arraySize);
708            assert (ptr->isStaticAlloca());
709            temporaryOutputBuffer[i] = ptr;
710        }
711    }
712
713    // Now we iteratively process these blocks using the doMultiBlock method.
714    // In each iteration, we check how many linearly accessible / writable
715    // items can be processed with our current input / output buffers. If we
716    // cannot support an full stride, we check whether (a) there is enough
717    // input data to process but it is not linearly accessible, in which case
718    // we move the data into temporary buffers or (b) there is not enough data
719    // to process, in which case we abort unless IsFinal was set.
720
721    Constant * const ZERO = b->getSize(0);
722    Constant * const ONE = b->getSize(1);
723    Constant * const LOG_2_BLOCK_WIDTH = b->getSize(std::log2(b->getBitBlockWidth()));
724    Constant * const BLOCK_WIDTH_MASK = b->getSize(b->getBitBlockWidth() - 1);
725
726    if (LLVM_UNLIKELY(codegen::DebugOptionIsSet(codegen::EnableAsserts))) {
727        Value * terminatedTwice = b->CreateAnd(mIsFinal, b->getTerminationSignal());
728        Value * unprocessedData = nullptr;
729        for (unsigned i = 0; i < inputSetCount; i++) {
730            Value * processed = b->getProcessedItemCount(mStreamSetInputs[i].getName());
731            Value * const check = b->CreateICmpNE(processed, mAvailableItemCount[i]);
732            unprocessedData = unprocessedData ? b->CreateOr(unprocessedData, check) : check;
733        }
734        b->CreateAssertZero(b->CreateAnd(terminatedTwice, unprocessedData),
735                            getName() + " was called after its termination with additional input data");
736        b->CreateAssertZero(terminatedTwice,
737                            getName() + " was called after its termination");
738    }
739
740    // Now proceed with creation of the doSegment method.
741    BasicBlock * const segmentLoop = b->CreateBasicBlock("SegmentLoop");
742
743    b->CreateBr(segmentLoop);
744
745    /// DO SEGMENT LOOP
746
747    b->SetInsertPoint(segmentLoop);
748
749    // For each input buffer, get the initial processed item count, base input pointer, and the number of
750    // linearly available strides.
751    Value * numOfStrides = nullptr;
752    mInitialAvailableItemCount.assign(mAvailableItemCount.begin(), mAvailableItemCount.end());
753    mInitialProcessedItemCount.resize(inputSetCount);
754    mStreamSetInputBaseAddress.resize(inputSetCount);
755    Value * inputStrideSize[inputSetCount];
756    for (unsigned i = 0; i < inputSetCount; i++) {
757        const Binding & input = mStreamSetInputs[i];
758        const auto & name = input.getName();
759        const ProcessingRate & rate = input.getRate();
760        Value * const processed = b->getProcessedItemCount(name);
761
762        mInitialProcessedItemCount[i] = processed;
763        Value * baseBuffer  = b->getBlockAddress(name, b->CreateLShr(processed, LOG_2_BLOCK_WIDTH));
764
765        if (LLVM_UNLIKELY(codegen::DebugOptionIsSet(codegen::EnableAsserts))) {           
766            b->CreateAssert(b->CreateICmpULE(processed, mAvailableItemCount[i]),
767                            getName() + ": " + name + " processed item count exceeds its available item count");
768        }
769
770        // Ensure that everything between S⌈P/S⌉, and S⌈n*(P + L)/S⌉ is linearly available, where S is the stride size,
771        // P is the current processed position, L is the lookahead amount and n ∈ â„€+.
772
773        Value * const unprocessed = b->CreateSub(mAvailableItemCount[i], processed);
774        Value * avail = b->getLinearlyAccessibleItems(name, processed, unprocessed);
775        Value * remaining = avail;
776        if (LLVM_UNLIKELY(input.hasLookahead())) {
777            Constant * const lookahead = b->getSize(input.getLookahead());
778            remaining = b->CreateSelect(b->CreateICmpULT(lookahead, remaining), b->CreateSub(remaining, lookahead), ZERO);
779        }
780
781        inputStrideSize[i] = getStrideSize(b, rate);
782        Value * accessibleStrides = b->CreateUDiv(remaining, inputStrideSize[i]);
783        AllocaInst * const tempBuffer = temporaryInputBuffer[i];
784        if (tempBuffer) {
785
786            // Since we trust that the pipeline won't call this kernel unless there is enough data to process a stride, whenever
787            // we discover that there isn't enough linearly available data, optimistically copy the data to the temporary buffer.
788
789            BasicBlock * const entry = b->GetInsertBlock();
790            BasicBlock * const copyFromBack = b->CreateBasicBlock(name + "CopyFromBack");
791            BasicBlock * const copyFromFront = b->CreateBasicBlock(name + "CopyFromFront");
792            BasicBlock * const resume = b->CreateBasicBlock(name + "Resume");
793
794            b->CreateUnlikelyCondBr(b->CreateICmpEQ(accessibleStrides, ZERO), copyFromBack, resume);
795
796            b->SetInsertPoint(copyFromBack);
797            Value * const arraySize = b->CreateZExt(tempBuffer->getArraySize(), b->getInt64Ty());
798            Value * const temporarySize = b->CreateTrunc(b->CreateMul(arraySize, b->getInt64(mStride)), unprocessed->getType());
799            Value * const temporaryAvailable = b->CreateUMin(unprocessed, temporarySize);
800            Value * const offset = b->CreateAnd(processed, BLOCK_WIDTH_MASK);
801            Value * const bufferSize = b->CreateMul(ConstantExpr::getSizeOf(tempBuffer->getAllocatedType()), arraySize);
802            b->CreateMemZero(tempBuffer, bufferSize, blockAlignment);
803            const auto copyAlignment = getItemAlignment(mStreamSetInputs[i]);
804            b->CreateStreamCpy(name, tempBuffer, ZERO, baseBuffer, offset, avail, copyAlignment);
805            Value * const temporaryStrides = b->CreateSelect(b->CreateICmpULT(unprocessed, inputStrideSize[i]), ZERO, ONE);
806            BasicBlock * const copyToBackEnd = b->GetInsertBlock();
807            b->CreateCondBr(b->CreateICmpNE(temporaryAvailable, unprocessed), copyFromFront, resume);
808
809            b->SetInsertPoint(copyFromFront);
810            Value * const remaining = b->CreateSub(temporaryAvailable, avail);
811            Value * const baseAddress = b->getBaseAddress(name);
812            b->CreateStreamCpy(name, tempBuffer, avail, baseAddress, ZERO, remaining, copyAlignment);
813            BasicBlock * const copyToFrontEnd = b->GetInsertBlock();
814            b->CreateBr(resume);
815
816            b->SetInsertPoint(resume);
817            PHINode * const bufferPtr = b->CreatePHI(baseBuffer->getType(), 4);
818            bufferPtr->addIncoming(baseBuffer, entry);
819            bufferPtr->addIncoming(tempBuffer, copyToBackEnd);
820            bufferPtr->addIncoming(tempBuffer, copyToFrontEnd);
821            baseBuffer = bufferPtr;
822
823            PHINode * const phiAvailItemCount = b->CreatePHI(b->getSizeTy(), 4);
824            phiAvailItemCount->addIncoming(avail, entry);
825            phiAvailItemCount->addIncoming(temporaryAvailable, copyToBackEnd);
826            phiAvailItemCount->addIncoming(temporaryAvailable, copyToFrontEnd);
827            avail = phiAvailItemCount;
828
829            PHINode * const phiStrides = b->CreatePHI(b->getSizeTy(), 4);
830            phiStrides->addIncoming(accessibleStrides, entry);
831            phiStrides->addIncoming(temporaryStrides, copyToBackEnd);
832            phiStrides->addIncoming(temporaryStrides, copyToFrontEnd);
833            accessibleStrides = phiStrides;
834        }
835        mAvailableItemCount[i] = avail;
836        mStreamSetInputBaseAddress[i] = baseBuffer;
837        numOfStrides = b->CreateUMin(numOfStrides, accessibleStrides);
838    }
839
840    // Now determine the linearly writeable strides
841    Value * linearlyWritable[outputSetCount];
842    Value * outputStrideSize[outputSetCount];
843    mInitialProducedItemCount.resize(outputSetCount);
844    mStreamSetOutputBaseAddress.resize(outputSetCount);
845    for (unsigned i = 0; i < outputSetCount; i++) {
846        const auto & output = mStreamSetOutputs[i];
847        const auto & name = output.getName();
848        const ProcessingRate & rate = output.getRate();
849        Value * const produced = b->getProducedItemCount(name);
850        Value * baseBuffer = b->getBlockAddress(name, b->CreateLShr(produced, LOG_2_BLOCK_WIDTH));
851        assert (baseBuffer->getType()->isPointerTy());
852        linearlyWritable[i] = b->getLinearlyWritableItems(name, produced);
853        outputStrideSize[i] = getStrideSize(b, rate);
854        // Is the number of linearly writable items sufficient for a stride?
855        if (outputStrideSize[i]) {
856            AllocaInst * const tempBuffer = temporaryOutputBuffer[i];
857            Value * writableStrides = b->CreateUDiv(linearlyWritable[i], outputStrideSize[i]);
858            // Do we require a temporary buffer to write to?
859            if (tempBuffer) {
860                assert (tempBuffer->getType() == baseBuffer->getType());
861                BasicBlock * const entry = b->GetInsertBlock();
862                BasicBlock * const prepareTempBuffer = b->CreateBasicBlock(name + "PrepareTempBuffer");
863                BasicBlock * const resume = b->CreateBasicBlock(name + "Resume");
864                Value * const requiresCopy = b->CreateICmpEQ(writableStrides, ZERO);
865                b->CreateUnlikelyCondBr(requiresCopy, prepareTempBuffer, resume);
866                // Clear the output buffer prior to using it
867                b->SetInsertPoint(prepareTempBuffer);
868                Value * const bufferSize = b->CreateMul(ConstantExpr::getSizeOf(tempBuffer->getAllocatedType()), tempBuffer->getArraySize());
869                b->CreateMemZero(tempBuffer, bufferSize, blockAlignment);
870                b->CreateBr(resume);
871                // Select the appropriate buffer / stride #
872                b->SetInsertPoint(resume);
873                PHINode * const phiBuffer = b->CreatePHI(baseBuffer->getType(), 3);
874                phiBuffer->addIncoming(baseBuffer, entry);
875                phiBuffer->addIncoming(tempBuffer, prepareTempBuffer);
876                baseBuffer = phiBuffer;
877                PHINode * const phiStrides = b->CreatePHI(b->getSizeTy(), 2);
878                phiStrides->addIncoming(writableStrides, entry);
879                phiStrides->addIncoming(ONE, prepareTempBuffer);
880                writableStrides = phiStrides;
881            }
882            numOfStrides = b->CreateUMin(numOfStrides, writableStrides);
883        }
884        mInitialProducedItemCount[i] = produced;
885        mStreamSetOutputBaseAddress[i] = baseBuffer;
886    }
887
888    BasicBlock * const segmentDone = b->CreateBasicBlock("SegmentDone");
889
890    Value * const initiallyFinal = mIsFinal;
891    if (LLVM_LIKELY(numOfStrides != nullptr)) {
892        mIsFinal = b->CreateAnd(mIsFinal, b->CreateICmpEQ(numOfStrides, ZERO));
893        if (LLVM_UNLIKELY(codegen::DebugOptionIsSet(codegen::EnableAsserts))) {
894            Value * const hasStride = b->CreateOr(b->CreateICmpNE(numOfStrides, ZERO), mIsFinal);
895            b->CreateAssert(hasStride, getName() + " has insufficient input data or output space for one stride");
896        }
897        for (unsigned i = 0; i < inputSetCount; ++i) {
898            const auto & input = mStreamSetInputs[i];
899            const ProcessingRate & rate = input.getRate();
900            if (rate.isFixed() && input.nonDeferred()) {
901                mAvailableItemCount[i] = b->CreateSelect(mIsFinal, mAvailableItemCount[i], b->CreateMul(numOfStrides, inputStrideSize[i]));
902            }
903        }
904    }
905
906    //  We have one or more blocks of input data and output buffer space for all stream sets.
907    generateMultiBlockLogic(b, numOfStrides);
908
909    for (unsigned i = 0; i < inputSetCount; ++i) {
910        const auto & input = mStreamSetInputs[i];
911        const ProcessingRate & rate = input.getRate();
912        if (rate.isFixed() && input.nonDeferred()) {
913            Value * const ic = b->CreateAdd(mInitialProcessedItemCount[i], mAvailableItemCount[i]);
914            b->setProcessedItemCount(input.getName(), ic);
915        }
916    }
917
918    for (unsigned i = 0; i < outputSetCount; ++i) {
919        const auto & output = mStreamSetOutputs[i];
920        const ProcessingRate & rate = output.getRate();
921        if (rate.isFixed()) {
922            assert (output.nonDeferred());
923            Value * const produced = b->CreateMul(numOfStrides, outputStrideSize[i]);
924            Value * const ic = b->CreateAdd(mInitialProducedItemCount[i], produced);
925            b->setProducedItemCount(output.getName(), ic);
926        }
927    }
928
929    BasicBlock * const handleFinalBlock = b->CreateBasicBlock("HandleFinalBlock");
930    BasicBlock * const temporaryBufferCopyBack = b->CreateBasicBlock("TemporaryBufferCopyBack");
931    BasicBlock * const strideDone = b->CreateBasicBlock("MultiBlockDone");
932
933    b->CreateUnlikelyCondBr(mIsFinal, handleFinalBlock, temporaryBufferCopyBack);
934
935
936    /// FINAL STRIDE ADJUSTMENT
937    b->SetInsertPoint(handleFinalBlock);
938
939    // If this is our final stride, adjust the Fixed output item counts. The main loop assumes that
940    // the ITEM COUNT % FIXED RATE = 0 for all Fixed Input and Output streams. We correct that here
941    // to calculate them based on the actual input item counts.
942
943    reviseFinalProducedItemCounts(b);
944
945    b->CreateBr(temporaryBufferCopyBack);
946
947    /// TEMPORARY BUFFER COPY BACK
948    b->SetInsertPoint(temporaryBufferCopyBack);
949
950    // Copy back data to the actual output buffers.
951    for (unsigned i = 0; i < outputSetCount; i++) {
952        AllocaInst * const tempBuffer = temporaryOutputBuffer[i];
953        if (LLVM_UNLIKELY(tempBuffer == nullptr)) {
954            continue;
955        }
956
957        Value * const baseBuffer = mStreamSetOutputBaseAddress[i];
958        assert ("stack corruption likely" && (tempBuffer->getType() == baseBuffer->getType()));
959        const auto & name = mStreamSetOutputs[i].getName();
960        BasicBlock * const copyToBack = b->CreateBasicBlock(name + "CopyToBack");
961        BasicBlock * const copyToFront = b->CreateBasicBlock(name + "CopyToFront");
962        BasicBlock * const resume = b->CreateBasicBlock(name + "ResumeCopyBack");
963        // If we used a temporary buffer, copy it back to the original output buffer
964        b->CreateCondBr(b->CreateICmpEQ(tempBuffer, baseBuffer), copyToBack, resume);
965
966        b->SetInsertPoint(copyToBack);       
967        Value * const offset = b->CreateAnd(mInitialProducedItemCount[i], BLOCK_WIDTH_MASK);
968        Value * const newProducedItemCount = b->getProducedItemCount(name);
969        Value * const newlyProduced = b->CreateSub(newProducedItemCount, mInitialProducedItemCount[i]);
970        Value * const toWrite = b->CreateUMin(newlyProduced, linearlyWritable[i]);
971        const auto alignment = getItemAlignment(mStreamSetOutputs[i]);
972        b->CreateStreamCpy(name, baseBuffer, offset, tempBuffer, ZERO, toWrite, alignment);
973        // If we required a temporary output buffer, we will probably need to write to the beginning of the buffer as well.
974        b->CreateLikelyCondBr(b->CreateICmpULT(toWrite, newlyProduced), copyToFront, resume);
975
976        b->SetInsertPoint(copyToFront);
977        Value * const remaining = b->CreateSub(newlyProduced, toWrite);
978        Value * const baseAddress = b->getBaseAddress(name);
979        b->CreateStreamCpy(name, baseAddress, ZERO, tempBuffer, toWrite, remaining, alignment);
980        b->CreateBr(resume);
981
982        b->SetInsertPoint(resume);
983    }
984
985    //  We've dealt with the partial block processing and copied information back into the
986    //  actual buffers.  If this isn't the final block, loop back for more multiblock processing.
987    BasicBlock * const setTermination = b->CreateBasicBlock("setTermination");
988    b->CreateCondBr(mIsFinal, setTermination, strideDone);
989
990    b->SetInsertPoint(setTermination);
991    b->setTerminationSignal();
992    b->CreateBr(segmentDone);
993
994    /// STRIDE DONE
995    strideDone->moveAfter(b->GetInsertBlock());
996    b->SetInsertPoint(strideDone);
997
998    // do we have enough data for another stride?
999    Value * hasMoreStrides = b->getTrue();
1000    for (unsigned i = 0; i < inputSetCount; ++i) {
1001        const Binding & input = mStreamSetInputs[i];
1002        const auto & name = input.getName();
1003        Value * const avail = mInitialAvailableItemCount[i];
1004        Value * const processed = b->getProcessedItemCount(name);
1005        if (LLVM_UNLIKELY(codegen::DebugOptionIsSet(codegen::EnableAsserts))) {
1006            b->CreateAssert(b->CreateICmpULE(processed, avail), getName() + ": " + name + " processed data exceeds available data");
1007        }
1008        Value * remaining = b->CreateSub(avail, processed);
1009        if (LLVM_UNLIKELY(input.hasLookahead())) {
1010            Constant * const lookahead = b->getSize(input.getLookahead());
1011            remaining = b->CreateSelect(b->CreateICmpULT(lookahead, remaining), b->CreateSub(remaining, lookahead), ZERO);
1012        }
1013        Value * const remainingStrides = b->CreateUDiv(remaining, inputStrideSize[i]);
1014        Value * const hasRemainingStrides = b->CreateICmpNE(remainingStrides, ZERO);
1015        hasMoreStrides = b->CreateAnd(hasMoreStrides, hasRemainingStrides);
1016    }
1017    // even if we do not have enough input data for a full stride, if this is our final stride, allow it ...
1018    hasMoreStrides = b->CreateOr(hasMoreStrides, initiallyFinal);
1019
1020    // do we have enough room for another stride?
1021    for (unsigned i = 0; i < outputSetCount; ++i) {
1022        const ProcessingRate & rate = mStreamSetOutputs[i].getRate();
1023        const auto & name = mStreamSetOutputs[i].getName();
1024        Value * const produced = b->getProducedItemCount(name);
1025        // If this output has a Fixed/Bounded rate, determine whether we have room for another stride.
1026        if (LLVM_LIKELY(outputStrideSize[i] != nullptr)) {
1027            Value * const consumed = b->getConsumedItemCount(name);
1028            if (LLVM_UNLIKELY(codegen::DebugOptionIsSet(codegen::EnableAsserts))) {
1029                b->CreateAssert(b->CreateICmpULE(consumed, produced),
1030                                getName() + ": " + name + " consumed data exceeds produced data");
1031            }
1032            Value * const unconsumed = b->CreateSub(produced, consumed);
1033            Value * const capacity = b->getCapacity(name);
1034            if (LLVM_UNLIKELY(codegen::DebugOptionIsSet(codegen::EnableAsserts))) {
1035                b->CreateAssert(b->CreateICmpULE(unconsumed, capacity),
1036                                getName() + ": " + name + " unconsumed data exceeds capacity");
1037            }
1038            Value * const remaining = b->CreateSub(capacity, unconsumed);
1039            Value * const remainingStrides = b->CreateUDiv(remaining, outputStrideSize[i]);
1040            Value * const hasRemainingStrides = b->CreateICmpNE(remainingStrides, ZERO);
1041
1042            hasMoreStrides = b->CreateAnd(hasMoreStrides, hasRemainingStrides);
1043        }
1044        // Do copybacks if necessary.
1045        if (mStreamSetOutputBuffers[i]->supportsCopyBack() && requiresCopyBack(rate)) {
1046            BasicBlock * const copyBack = b->CreateBasicBlock(name + "CopyBack");
1047            BasicBlock * const done = b->CreateBasicBlock(name + "CopyBackDone");
1048
1049            Value * const bufferSize = b->getBufferedSize(name);
1050            Value * const prior = b->CreateURem(mInitialProducedItemCount[i], bufferSize);
1051            Value * const current = b->CreateURem(produced, bufferSize);
1052            b->CreateUnlikelyCondBr(b->CreateICmpUGT(prior, current), copyBack, done);
1053
1054            b->SetInsertPoint(copyBack);
1055            Value * const baseAddress = b->getBaseAddress(name);
1056            const auto copyAlignment = getItemAlignment(mStreamSetOutputs[i]);
1057            b->CreateStreamCpy(name, baseAddress, ZERO, baseAddress, bufferSize, current, copyAlignment);
1058            b->CreateBr(done);
1059
1060            b->SetInsertPoint(done);
1061        }
1062    }
1063
1064    b->CreateCondBr(hasMoreStrides, segmentLoop, segmentDone);
1065
1066    /// SEGMENT DONE
1067    segmentDone->moveAfter(b->GetInsertBlock());
1068    b->SetInsertPoint(segmentDone);
1069
1070}
1071
1072/** ------------------------------------------------------------------------------------------------------------- *
1073 * @brief requiresCopyBack
1074 ** ------------------------------------------------------------------------------------------------------------- */
1075bool MultiBlockKernel::requiresCopyBack(const ProcessingRate & rate) const {
1076    if (rate.isBounded() || rate.isUnknown()) {
1077        return true;
1078    } else if (rate.isRelative()) {
1079        return requiresCopyBack(getBinding(rate.getReference()).getRate());
1080    }
1081    return false;
1082}
1083
1084/** ------------------------------------------------------------------------------------------------------------- *
1085 * @brief CreateUDivCeil
1086 ** ------------------------------------------------------------------------------------------------------------- */
1087inline Value * CreateUDivCeil(const std::unique_ptr<KernelBuilder> & b, Value * const number, const ProcessingRate::RateValue divisor, const Twine & Name = "") {
1088    Constant * const n = ConstantInt::get(number->getType(), divisor.numerator());
1089    if (LLVM_LIKELY(divisor.denominator() == 1)) {
1090        return b->CreateUDivCeil(number, n, Name);
1091    } else {
1092        //   âŒŠ(num + ratio - 1) / ratio⌋
1093        // = ⌊(num - 1) / (n/d)⌋ + (ratio/ratio)
1094        // = ⌊(d * (num - 1)) / n⌋ + 1
1095        Constant * const ONE = ConstantInt::get(number->getType(), 1);
1096        Constant * const d = ConstantInt::get(number->getType(), divisor.denominator());
1097        return b->CreateAdd(b->CreateUDiv(b->CreateMul(b->CreateSub(number, ONE), d), n), ONE, Name);
1098    }
1099}
1100
1101
1102/** ------------------------------------------------------------------------------------------------------------- *
1103 * @brief reviseFinalProducedItemCounts
1104 ** ------------------------------------------------------------------------------------------------------------- */
1105void MultiBlockKernel::reviseFinalProducedItemCounts(const std::unique_ptr<KernelBuilder> & b) {
1106
1107    if (LLVM_UNLIKELY(mStreamSetInputs.empty())) {
1108        return;
1109    }
1110
1111    const auto inputSetCount = mStreamSetInputs.size();
1112
1113    ProcessingRate::RateValue rateLCM(1);
1114    unsigned first = 0;
1115    unsigned last = inputSetCount;
1116
1117    for (unsigned i = 0; i < inputSetCount; ++i) {
1118        const ProcessingRate & pr = mStreamSetInputs[i].getRate();
1119        if (pr.isFixed()) {
1120            rateLCM = lcm(rateLCM, pr.getRate());
1121            if (mStreamSetInputs[i].isPrincipal()) {
1122                assert ("A kernel cannot have multiple principle input streams" && (first == 0 && last == inputSetCount));
1123                first = i;
1124                last = i + 1;
1125            }
1126        }       
1127    }
1128
1129    bool noFixedRateOutput = true;
1130
1131    for (const Binding & output : mStreamSetOutputs) {
1132        const ProcessingRate & pr = output.getRate();
1133        if (pr.isFixed()) {
1134            rateLCM = lcm(rateLCM, pr.getRate());
1135            noFixedRateOutput = false;
1136        }
1137    }
1138
1139    if (noFixedRateOutput) {
1140        return;
1141    }
1142
1143    Value * baseInitialProcessedItemCount = nullptr;
1144    Value * scaledInverseOfAvailItemCount = nullptr;
1145
1146    // For each Fixed output stream, this calculates:
1147
1148    //    CEILING(MIN(Available Item Count / Fixed Input Rate) * Fixed Output Rate)
1149
1150    // But avoids the possibility of overflow errors (assuming that each processed item count does not overflow)
1151
1152    for (unsigned i = first; i < last; ++i) {
1153        const ProcessingRate & pr = mStreamSetInputs[i].getRate();
1154        if (pr.isFixed()) {
1155            Value * p = mInitialProcessedItemCount[i];
1156            Value * a = b->CreateSub(mInitialAvailableItemCount[i], p);
1157            const auto & rate = pr.getRate();
1158            if (LLVM_UNLIKELY(rateLCM != rate)) {
1159                const auto factor = rateLCM / rate;
1160                if (LLVM_UNLIKELY(factor.numerator() > 1)) {
1161                    a = b->CreateMul(a, b->getSize(factor.numerator()));
1162                }
1163                if (LLVM_UNLIKELY(factor.denominator() > 1)) {
1164                    a = b->CreateUDiv(a, b->getSize(factor.denominator()));
1165                }
1166            }
1167            if (LLVM_UNLIKELY(rate.denominator() > 1)) {
1168                p = b->CreateMul(p, b->getSize(rate.denominator()));
1169            }
1170            if (LLVM_UNLIKELY(rate.numerator() > 1)) {
1171                p = b->CreateUDiv(p, b->getSize(rate.numerator()));
1172            }
1173            if (scaledInverseOfAvailItemCount) {
1174                scaledInverseOfAvailItemCount = b->CreateUMin(scaledInverseOfAvailItemCount, a);
1175                baseInitialProcessedItemCount = b->CreateUMin(baseInitialProcessedItemCount, p);
1176            } else {
1177                scaledInverseOfAvailItemCount = a;
1178                baseInitialProcessedItemCount = p;
1179            }
1180        }
1181    }
1182
1183    for (const Binding & output : mStreamSetOutputs) {
1184        const auto name = output.getName();
1185        const ProcessingRate & pr = output.getRate();
1186        Value * produced = nullptr;
1187        if (pr.isFixed() && output.nonDeferred()) {
1188            assert (baseInitialProcessedItemCount && scaledInverseOfAvailItemCount);
1189            const auto rate = pr.getRate();
1190            Value * p = baseInitialProcessedItemCount;
1191            if (LLVM_UNLIKELY(rate.numerator() != 1)) {
1192                p = b->CreateMul(p, b->getSize(rate.numerator()));
1193            }
1194            if (LLVM_UNLIKELY(rate.denominator() != 1)) {
1195                p = b->CreateUDiv(p, b->getSize(rate.denominator()));
1196            }
1197            Value * const ic = CreateUDivCeil(b, scaledInverseOfAvailItemCount, rateLCM / pr.getRate());
1198            produced = b->CreateAdd(p, ic);
1199        } else { // check if we have an attribute; if so, get the current produced count and adjust it
1200            bool noAttributes = true;
1201            for (const Attribute & attr : output.getAttributes()) {
1202                if (attr.isAdd() || attr.isRoundUpTo()) {
1203                    noAttributes = false;
1204                    break;
1205                }
1206            }
1207            if (noAttributes) {
1208                continue;
1209            }
1210            produced = b->getProducedItemCount(name);
1211        }
1212        for (const Attribute & attr : output.getAttributes()) {
1213            if (attr.isAdd()) {
1214                produced = b->CreateAdd(produced, b->getSize(attr.amount()));
1215            } else if (attr.isRoundUpTo()) {
1216                produced = b->CreateRoundUp(produced, b->getSize(attr.amount()));
1217            }
1218        }
1219        b->setProducedItemCount(name, produced);
1220    }
1221
1222}
1223
1224/** ------------------------------------------------------------------------------------------------------------- *
1225 * @brief generateMultiBlockLogic
1226 ** ------------------------------------------------------------------------------------------------------------- */
1227Value * BlockOrientedKernel::generateMultiBlockLogic(const std::unique_ptr<KernelBuilder> & b, Value * const numOfBlocks) {
1228
1229    if (LLVM_UNLIKELY(mStride != b->getBitBlockWidth())) {
1230        report_fatal_error(getName() + ": the Stride (" + std::to_string(mStride) + ") of BlockOrientedKernel "
1231                           "equal to the BitBlockWidth (" + std::to_string(b->getBitBlockWidth()) + ")");
1232    }
1233
1234    Constant * const LOG_2_BLOCK_WIDTH = b->getSize(std::log2(b->getBitBlockWidth()));
1235
1236    BasicBlock * const entryBlock = b->GetInsertBlock();
1237    mStrideLoopBody = b->CreateBasicBlock(getName() + "_strideLoopBody");
1238    BasicBlock * const stridesDone = b->CreateBasicBlock(getName() + "_stridesDone");
1239    BasicBlock * const doFinalBlock = b->CreateBasicBlock(getName() + "_doFinalBlock");
1240    BasicBlock * const segmentDone = b->CreateBasicBlock(getName() + "_segmentDone");
1241    if (LLVM_UNLIKELY(codegen::DebugOptionIsSet(codegen::EnableAsserts))) {
1242        b->CreateAssert(b->CreateXor(b->CreateIsNotNull(numOfBlocks), mIsFinal),
1243                        "numOfStrides cannot be 0 unless this is the final stride and must be 0 if it is");
1244    }
1245    const auto inputSetCount = mStreamSetInputs.size();
1246    Value * baseProcessedIndex[inputSetCount];
1247    Value * baseInputAddress[inputSetCount];
1248    for (unsigned i = 0; i < inputSetCount; i++) {
1249        const ProcessingRate & rate = mStreamSetInputs[i].getRate();
1250        if (LLVM_UNLIKELY(!rate.isFixed())) {
1251            Value * const ic = mInitialProcessedItemCount[i];
1252            baseProcessedIndex[i] = b->CreateLShr(ic, LOG_2_BLOCK_WIDTH);
1253        }
1254        baseInputAddress[i] = mStreamSetInputBaseAddress[i];
1255    }
1256
1257    const auto outputSetCount = mStreamSetOutputs.size();
1258    Value * baseProducedIndex[outputSetCount];
1259    Value * baseOutputAddress[inputSetCount];
1260    for (unsigned i = 0; i < outputSetCount; i++) {
1261        const ProcessingRate & rate = mStreamSetOutputs[i].getRate();
1262        if (LLVM_UNLIKELY(!rate.isFixed())) {
1263            Value * const ic = b->getProducedItemCount(mStreamSetOutputs[i].getName());
1264            baseProducedIndex[i] = b->CreateLShr(ic, LOG_2_BLOCK_WIDTH);
1265        }
1266        baseOutputAddress[i] = mStreamSetOutputBaseAddress[i];
1267    }
1268
1269    b->CreateUnlikelyCondBr(mIsFinal, doFinalBlock, mStrideLoopBody);
1270
1271    /// BLOCK BODY
1272
1273    b->SetInsertPoint(mStrideLoopBody);
1274
1275    if (b->supportsIndirectBr()) {
1276        Value * const baseTarget = BlockAddress::get(segmentDone);
1277        mStrideLoopTarget = b->CreatePHI(baseTarget->getType(), 2, "strideTarget");
1278        mStrideLoopTarget->addIncoming(baseTarget, entryBlock);
1279    }
1280
1281    mStrideBlockIndex = b->CreatePHI(b->getSizeTy(), 2);
1282    mStrideBlockIndex->addIncoming(b->getSize(0), entryBlock);
1283
1284    /// GENERATE DO BLOCK METHOD
1285
1286    for (unsigned i = 0; i < inputSetCount; ++i) {
1287        Value * index = mStrideBlockIndex;
1288        const ProcessingRate & rate = mStreamSetInputs[i].getRate();
1289        if (LLVM_UNLIKELY(!rate.isFixed())) {
1290            Value * ic = b->getProcessedItemCount(mStreamSetInputs[i].getName());
1291            index = b->CreateSub(b->CreateLShr(ic, LOG_2_BLOCK_WIDTH), baseProcessedIndex[i]);
1292        }
1293        mStreamSetInputBaseAddress[i] = b->CreateGEP(mStreamSetInputBaseAddress[i], index);
1294    }
1295
1296    for (unsigned i = 0; i < outputSetCount; ++i) {
1297        Value * index = mStrideBlockIndex;
1298        const ProcessingRate & rate = mStreamSetOutputs[i].getRate();
1299        if (LLVM_UNLIKELY(!rate.isFixed())) {
1300            Value * ic = b->getProducedItemCount(mStreamSetOutputs[i].getName());
1301            index = b->CreateSub(b->CreateLShr(ic, LOG_2_BLOCK_WIDTH), baseProducedIndex[i]);
1302        }
1303        mStreamSetOutputBaseAddress[i] = b->CreateGEP(mStreamSetOutputBaseAddress[i], index);
1304    }
1305
1306    writeDoBlockMethod(b);
1307
1308    BasicBlock * const bodyEnd = b->GetInsertBlock();
1309    if (mStrideLoopTarget) {
1310        mStrideLoopTarget->addIncoming(mStrideLoopTarget, bodyEnd);
1311    }
1312
1313    Value * const nextIndex = b->CreateAdd(mStrideBlockIndex, b->getSize(1));
1314    mStrideBlockIndex->addIncoming(nextIndex, bodyEnd);
1315    Value * const notDone = b->CreateICmpULT(nextIndex, numOfBlocks);
1316    b->CreateCondBr(notDone, mStrideLoopBody, stridesDone);
1317
1318    stridesDone->moveAfter(bodyEnd);
1319
1320    /// STRIDE DONE
1321
1322    b->SetInsertPoint(stridesDone);
1323
1324    // Now conditionally perform the final block processing depending on the doFinal parameter.
1325    if (mStrideLoopTarget) {
1326        mStrideLoopBranch = b->CreateIndirectBr(mStrideLoopTarget, 3);
1327        mStrideLoopBranch->addDestination(doFinalBlock);
1328        mStrideLoopBranch->addDestination(segmentDone);
1329    } else {
1330        b->CreateUnlikelyCondBr(mIsFinal, doFinalBlock, segmentDone);
1331    }
1332
1333    doFinalBlock->moveAfter(stridesDone);
1334
1335    /// DO FINAL BLOCK
1336
1337    b->SetInsertPoint(doFinalBlock);
1338    for (unsigned i = 0; i < inputSetCount; ++i) {
1339        mStreamSetInputBaseAddress[i] = baseInputAddress[i];
1340    }
1341
1342    for (unsigned i = 0; i < outputSetCount; ++i) {
1343        mStreamSetOutputBaseAddress[i] = baseOutputAddress[i];
1344    }
1345
1346    Value * const remainingItems = getRemainingItems(b);
1347
1348//    b->CallPrintInt(getName() + "_remainingItems", remainingItems);
1349
1350    writeFinalBlockMethod(b, remainingItems);
1351
1352    b->CreateBr(segmentDone);
1353
1354    segmentDone->moveAfter(b->GetInsertBlock());
1355
1356    b->SetInsertPoint(segmentDone);
1357
1358    // Update the branch prediction metadata to indicate that the likely target will be segmentDone
1359    if (mStrideLoopTarget) {
1360        MDBuilder mdb(b->getContext());
1361        const auto destinations = mStrideLoopBranch->getNumDestinations();
1362        uint32_t weights[destinations];
1363        for (unsigned i = 0; i < destinations; ++i) {
1364            weights[i] = (mStrideLoopBranch->getDestination(i) == segmentDone) ? 100 : 1;
1365        }
1366        ArrayRef<uint32_t> bw(weights, destinations);
1367        mStrideLoopBranch->setMetadata(LLVMContext::MD_prof, mdb.createBranchWeights(bw));
1368    }
1369
1370    return numOfBlocks;
1371}
1372
1373/** ------------------------------------------------------------------------------------------------------------- *
1374 * @brief getRemainingItems
1375 ** ------------------------------------------------------------------------------------------------------------- */
1376Value * BlockOrientedKernel::getRemainingItems(const std::unique_ptr<KernelBuilder> & b) {
1377    Value * remainingItems = nullptr;
1378    const auto count = mStreamSetInputs.size();
1379    if (count == 1) {
1380        return mAvailableItemCount[0];
1381    } else {
1382        for (unsigned i = 0; i < count; i++) {
1383            if (mStreamSetInputs[i].isPrincipal()) {
1384                return mAvailableItemCount[i];
1385            }
1386        }
1387        for (unsigned i = 0; i < count; ++i) {
1388            const ProcessingRate & r = mStreamSetInputs[i].getRate();
1389            if (r.isFixed()) {
1390                Value * ic = CreateUDivCeil(b, mAvailableItemCount[i], r.getRate());
1391                if (remainingItems) {
1392                    remainingItems = b->CreateUMin(remainingItems, ic);
1393                } else {
1394                    remainingItems = ic;
1395                }
1396            }
1397        }
1398    }
1399    return remainingItems;
1400}
1401
1402/** ------------------------------------------------------------------------------------------------------------- *
1403 * @brief writeDoBlockMethod
1404 ** ------------------------------------------------------------------------------------------------------------- */
1405inline void BlockOrientedKernel::writeDoBlockMethod(const std::unique_ptr<KernelBuilder> & b) {
1406
1407    Value * const self = getInstance();
1408    Function * const cp = mCurrentMethod;
1409    auto ip = b->saveIP();
1410    std::vector<Value *> availableItemCount(0);
1411
1412    /// Check if the do block method is called and create the function if necessary
1413    if (!b->supportsIndirectBr()) {
1414
1415        std::vector<Type *> params;
1416        params.reserve(1 + mAvailableItemCount.size());
1417        params.push_back(self->getType());
1418        for (Value * avail : mAvailableItemCount) {
1419            params.push_back(avail->getType());
1420        }
1421
1422        FunctionType * const type = FunctionType::get(b->getVoidTy(), params, false);
1423        mCurrentMethod = Function::Create(type, GlobalValue::InternalLinkage, getName() + DO_BLOCK_SUFFIX, b->getModule());
1424        mCurrentMethod->setCallingConv(CallingConv::C);
1425        mCurrentMethod->setDoesNotThrow();
1426        auto args = mCurrentMethod->arg_begin();
1427        args->setName("self");
1428        setInstance(&*args);
1429        availableItemCount.reserve(mAvailableItemCount.size());
1430        while (++args != mCurrentMethod->arg_end()) {
1431            availableItemCount.push_back(&*args);
1432        }
1433        assert (availableItemCount.size() == mAvailableItemCount.size());
1434        mAvailableItemCount.swap(availableItemCount);
1435        b->SetInsertPoint(BasicBlock::Create(b->getContext(), "entry", mCurrentMethod));
1436    }
1437
1438    generateDoBlockMethod(b); // must be implemented by the BlockOrientedKernelBuilder subtype
1439
1440    if (!b->supportsIndirectBr()) {
1441        // Restore the DoSegment function state then call the DoBlock method
1442        b->CreateRetVoid();
1443        mDoBlockMethod = mCurrentMethod;
1444        b->restoreIP(ip);
1445        setInstance(self);
1446        mCurrentMethod = cp;
1447        mAvailableItemCount.swap(availableItemCount);
1448        CreateDoBlockMethodCall(b);
1449    }
1450
1451}
1452
1453/** ------------------------------------------------------------------------------------------------------------- *
1454 * @brief writeFinalBlockMethod
1455 ** ------------------------------------------------------------------------------------------------------------- */
1456inline void BlockOrientedKernel::writeFinalBlockMethod(const std::unique_ptr<KernelBuilder> & b, Value * remainingItems) {
1457
1458    Value * const self = getInstance();
1459    Function * const cp = mCurrentMethod;
1460    Value * const remainingItemCount = remainingItems;
1461    auto ip = b->saveIP();
1462    std::vector<Value *> availableItemCount(0);
1463
1464    if (!b->supportsIndirectBr()) {
1465        std::vector<Type *> params;
1466        params.reserve(2 + mAvailableItemCount.size());
1467        params.push_back(self->getType());
1468        params.push_back(b->getSizeTy());
1469        for (Value * avail : mAvailableItemCount) {
1470            params.push_back(avail->getType());
1471        }
1472        FunctionType * const type = FunctionType::get(b->getVoidTy(), params, false);
1473        mCurrentMethod = Function::Create(type, GlobalValue::InternalLinkage, getName() + FINAL_BLOCK_SUFFIX, b->getModule());
1474        mCurrentMethod->setCallingConv(CallingConv::C);
1475        mCurrentMethod->setDoesNotThrow();
1476        auto args = mCurrentMethod->arg_begin();
1477        args->setName("self");
1478        setInstance(&*args);
1479        remainingItems = &*(++args);
1480        remainingItems->setName("remainingItems");
1481        availableItemCount.reserve(mAvailableItemCount.size());
1482        while (++args != mCurrentMethod->arg_end()) {
1483            availableItemCount.push_back(&*args);
1484        }
1485        assert (availableItemCount.size() == mAvailableItemCount.size());
1486        mAvailableItemCount.swap(availableItemCount);
1487        b->SetInsertPoint(BasicBlock::Create(b->getContext(), "entry", mCurrentMethod));
1488    }
1489
1490    generateFinalBlockMethod(b, remainingItems); // may be implemented by the BlockOrientedKernel subtype
1491
1492    if (!b->supportsIndirectBr()) {
1493        b->CreateRetVoid();
1494        b->restoreIP(ip);
1495        setInstance(self);
1496        mAvailableItemCount.swap(availableItemCount);
1497        // Restore the DoSegment function state then call the DoFinal method
1498        std::vector<Value *> args;
1499        args.reserve(2 + mAvailableItemCount.size());
1500        args.push_back(self);
1501        args.push_back(remainingItemCount);
1502        args.insert(args.end(), mAvailableItemCount.begin(), mAvailableItemCount.end());
1503        b->CreateCall(mCurrentMethod, args);
1504        mCurrentMethod = cp;
1505    }
1506
1507}
1508
1509/** ------------------------------------------------------------------------------------------------------------- *
1510 * @brief generateFinalBlockMethod
1511 ** ------------------------------------------------------------------------------------------------------------- */
1512void BlockOrientedKernel::generateFinalBlockMethod(const std::unique_ptr<KernelBuilder> & b, Value * /* remainingItems */) {
1513    //  The default finalBlock method simply dispatches to the doBlock routine.
1514    CreateDoBlockMethodCall(b);
1515}
1516
1517void BlockOrientedKernel::CreateDoBlockMethodCall(const std::unique_ptr<KernelBuilder> & b) {
1518    if (b->supportsIndirectBr()) {
1519        BasicBlock * const bb = b->CreateBasicBlock("resume");
1520        mStrideLoopBranch->addDestination(bb);
1521        BasicBlock * const current = b->GetInsertBlock();
1522        mStrideLoopTarget->addIncoming(BlockAddress::get(bb), current);
1523        mStrideBlockIndex->addIncoming(b->getSize(0), current);
1524        b->CreateBr(mStrideLoopBody);
1525        bb->moveAfter(current);
1526        b->SetInsertPoint(bb);
1527    } else {
1528        std::vector<Value *> args;
1529        args.reserve(1 + mAvailableItemCount.size());
1530        args.push_back(getInstance());
1531        args.insert(args.end(), mAvailableItemCount.begin(), mAvailableItemCount.end());
1532        b->CreateCall(mDoBlockMethod, args);
1533    }
1534}
1535
1536static inline std::string annotateKernelNameWithDebugFlags(std::string && name) {
1537    if (LLVM_UNLIKELY(codegen::DebugOptionIsSet(codegen::EnableAsserts))) {
1538        name += "_EA";
1539    }
1540    name += "_O" + std::to_string((int)codegen::OptLevel);
1541    return name;
1542}
1543
1544// CONSTRUCTOR
1545Kernel::Kernel(std::string && kernelName,
1546               Bindings && stream_inputs,
1547               Bindings && stream_outputs,
1548               Bindings && scalar_parameters,
1549               Bindings && scalar_outputs,
1550               Bindings && internal_scalars)
1551: KernelInterface(annotateKernelNameWithDebugFlags(std::move(kernelName))
1552                  , std::move(stream_inputs), std::move(stream_outputs)
1553                  , std::move(scalar_parameters), std::move(scalar_outputs)
1554                  , std::move(internal_scalars))
1555, mCurrentMethod(nullptr)
1556, mAvailablePrincipalItemCount(nullptr)
1557, mIsGenerated(false)
1558, mStride(0)
1559, mIsFinal(nullptr)
1560, mOutputScalarResult(nullptr) {
1561
1562}
1563
1564Kernel::~Kernel() {
1565
1566}
1567
1568// MULTI-BLOCK KERNEL CONSTRUCTOR
1569MultiBlockKernel::MultiBlockKernel(std::string && kernelName,
1570                                   Bindings && stream_inputs,
1571                                   Bindings && stream_outputs,
1572                                   Bindings && scalar_parameters,
1573                                   Bindings && scalar_outputs,
1574                                   Bindings && internal_scalars)
1575: Kernel(std::move(kernelName), std::move(stream_inputs), std::move(stream_outputs), std::move(scalar_parameters), std::move(scalar_outputs), std::move(internal_scalars)) {
1576
1577}
1578
1579// CONSTRUCTOR
1580BlockOrientedKernel::BlockOrientedKernel(std::string && kernelName,
1581                                         Bindings && stream_inputs,
1582                                         Bindings && stream_outputs,
1583                                         Bindings && scalar_parameters,
1584                                         Bindings && scalar_outputs,
1585                                         Bindings && internal_scalars)
1586: MultiBlockKernel(std::move(kernelName), std::move(stream_inputs), std::move(stream_outputs), std::move(scalar_parameters), std::move(scalar_outputs), std::move(internal_scalars))
1587, mDoBlockMethod(nullptr)
1588, mStrideLoopBody(nullptr)
1589, mStrideLoopBranch(nullptr)
1590, mStrideLoopTarget(nullptr)
1591, mStrideBlockIndex(nullptr) {
1592
1593}
1594
1595// CONSTRUCTOR
1596SegmentOrientedKernel::SegmentOrientedKernel(std::string && kernelName,
1597                                             Bindings && stream_inputs,
1598                                             Bindings && stream_outputs,
1599                                             Bindings && scalar_parameters,
1600                                             Bindings && scalar_outputs,
1601                                             Bindings && internal_scalars)
1602: Kernel(std::move(kernelName), std::move(stream_inputs), std::move(stream_outputs), std::move(scalar_parameters), std::move(scalar_outputs), std::move(internal_scalars)) {
1603
1604}
1605
1606
1607}
Note: See TracBrowser for help on using the repository browser.