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

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

Minor changes and hopefully a fix for bug exposed by base64 test

File size: 72.8 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(idb->getInt1Ty(), 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 roundUp
627 ** ------------------------------------------------------------------------------------------------------------- */
628unsigned roundUp(const ProcessingRate::RateValue & r) {
629    if (LLVM_LIKELY(r.denominator() == 1)) {
630        return r.numerator();
631    } else {
632        return (r.numerator() + r.denominator() - 1) / r.denominator();
633    }
634}
635
636/** ------------------------------------------------------------------------------------------------------------- *
637 * @brief getItemAlignment
638 ** ------------------------------------------------------------------------------------------------------------- */
639inline unsigned MultiBlockKernel::getItemAlignment(const Binding & binding) const {
640    const auto & rate = binding.getRate();
641    if (rate.isFixed()) {
642        const auto & r = rate.getRate();
643        const auto n = (r.numerator() * mStride);
644        if (LLVM_LIKELY(r.denominator() == 1)) {
645            return n;
646        } else if (LLVM_LIKELY((n % r.denominator()) == 0)) {
647            return n / r.denominator();
648        }
649    }
650    return 1; // ∀x GCD(x, x + 1) = 1
651}
652
653/** ------------------------------------------------------------------------------------------------------------- *
654 * @brief getStrideSize
655 ** ------------------------------------------------------------------------------------------------------------- */
656llvm::Value * MultiBlockKernel::getStrideSize(const std::unique_ptr<KernelBuilder> & b, const ProcessingRate & rate) {
657    // NOTE: if we ever support feedback loops, using upper bound could lead to a deadlock due to data starvation
658    const auto r = getUpperBound(rate);
659    if (r.numerator() == 0) {
660        return nullptr;
661    } else {
662        assert ((r.numerator() * mStride) % r.denominator() == 0);
663        return b->getSize((r.numerator() * mStride) / r.denominator());
664    }
665}
666
667/** ------------------------------------------------------------------------------------------------------------- *
668 * @brief generateKernelMethod
669 ** ------------------------------------------------------------------------------------------------------------- */
670void MultiBlockKernel::generateKernelMethod(const std::unique_ptr<KernelBuilder> & b) {
671
672    if (LLVM_UNLIKELY((mStride % b->getBitBlockWidth()) != 0)) {
673        report_fatal_error(getName() + ": the Stride (" + std::to_string(mStride) + ") of MultiBlockKernel "
674                           "must be a multiple of the BitBlockWidth (" + std::to_string(b->getBitBlockWidth()) + ")");
675    }
676
677    const auto inputSetCount = mStreamSetInputs.size();
678    const auto outputSetCount = mStreamSetOutputs.size();
679
680    // Define and allocate the temporary buffer area in the prolog.
681    const auto blockAlignment = b->getBitBlockWidth() / 8;
682    AllocaInst * temporaryInputBuffer[inputSetCount];
683    for (unsigned i = 0; i < inputSetCount; ++i) {
684        const auto & input = mStreamSetInputs[i];
685        const ProcessingRate & rate = input.getRate();
686        if (isTransitivelyUnknownRate(rate)) {
687            report_fatal_error("MultiBlock kernels do not support unknown rate input streams or streams relative to an unknown rate input.");
688        } else if (rate.isFixed() && input.nonDeferred() && !requiresBufferedFinalStride(input)) {
689            temporaryInputBuffer[i] = nullptr;
690        } else {
691            Type * const ty = mStreamSetInputBuffers[i]->getStreamSetBlockType();
692            const auto ub = getUpperBound(rate);
693            Constant * arraySize = b->getInt64(roundUp(ub));
694            AllocaInst * const ptr = b->CreateAlignedAlloca(ty, blockAlignment, arraySize);
695            assert (ptr->isStaticAlloca());
696            temporaryInputBuffer[i] = ptr;
697        }
698    }
699
700    AllocaInst * temporaryOutputBuffer[outputSetCount];
701    for (unsigned i = 0; i < outputSetCount; i++) {
702        const auto & output = mStreamSetOutputs[i];
703        const ProcessingRate & rate = output.getRate();
704        if (LLVM_UNLIKELY(isTransitivelyUnknownRate(rate) || (rate.isFixed() && output.nonDeferred() && !requiresBufferedFinalStride(output)))) {
705            temporaryOutputBuffer[i] = nullptr;
706        } else {           
707            auto ub = getUpperBound(rate);
708            if (LLVM_UNLIKELY(mStreamSetOutputBuffers[i]->supportsCopyBack() && requiresCopyBack(rate))) {
709                ub += mStreamSetOutputBuffers[i]->overflowSize();
710            }
711            Type * const ty = mStreamSetOutputBuffers[i]->getStreamSetBlockType();
712            Constant * arraySize = b->getInt64(roundUp(ub));
713            AllocaInst * const ptr = b->CreateAlignedAlloca(ty, blockAlignment, arraySize);
714            assert (ptr->isStaticAlloca());
715            temporaryOutputBuffer[i] = ptr;
716        }
717    }
718
719    // Now we iteratively process these blocks using the doMultiBlock method.
720    // In each iteration, we check how many linearly accessible / writable
721    // items can be processed with our current input / output buffers. If we
722    // cannot support an full stride, we check whether (a) there is enough
723    // input data to process but it is not linearly accessible, in which case
724    // we move the data into temporary buffers or (b) there is not enough data
725    // to process, in which case we abort unless IsFinal was set.
726
727    Constant * const ZERO = b->getSize(0);
728    Constant * const ONE = b->getSize(1);
729    Constant * const LOG_2_BLOCK_WIDTH = b->getSize(std::log2(b->getBitBlockWidth()));
730    Constant * const BLOCK_WIDTH_MASK = b->getSize(b->getBitBlockWidth() - 1);
731
732    // Now proceed with creation of the doSegment method.
733    BasicBlock * const segmentLoop = b->CreateBasicBlock("SegmentLoop");
734
735    b->CreateBr(segmentLoop);
736
737    /// DO SEGMENT LOOP
738
739    b->SetInsertPoint(segmentLoop);
740
741    // For each input buffer, get the initial processed item count, base input pointer, and the number of
742    // linearly available strides.
743    Value * numOfStrides = nullptr;
744    mInitialAvailableItemCount.resize(inputSetCount);
745    mInitialProcessedItemCount.resize(inputSetCount);
746    mStreamSetInputBaseAddress.resize(inputSetCount);
747    Value * inputStrideSize[inputSetCount];
748    for (unsigned i = 0; i < inputSetCount; i++) {
749        const auto & input = mStreamSetInputs[i];
750        const auto & name = input.getName();
751        const ProcessingRate & rate = input.getRate();
752        Value * const ic = b->getProcessedItemCount(name);
753        mInitialProcessedItemCount[i] = ic;
754        if (LLVM_UNLIKELY(codegen::DebugOptionIsSet(codegen::EnableAsserts))) {
755            b->CreateAssert(b->CreateICmpUGE(mAvailableItemCount[i], ic),
756                            "processed item count cannot exceed the available item count");
757        }
758        assert (ic->getType() == mAvailableItemCount[i]->getType());
759        Value * const unprocessed = b->CreateSub(mAvailableItemCount[i], ic);
760        Value * baseBuffer  = b->getBlockAddress(name, b->CreateLShr(ic, LOG_2_BLOCK_WIDTH));
761        mInitialAvailableItemCount[i] = mAvailableItemCount[i];
762        mAvailableItemCount[i] = b->getLinearlyAccessibleItems(name, ic, unprocessed);
763
764        // Are our linearly accessible items sufficient for a stride?
765        inputStrideSize[i] = getStrideSize(b, rate);
766        Value * accessibleStrides = b->CreateUDiv(mAvailableItemCount[i], inputStrideSize[i]);
767        AllocaInst * const tempBuffer = temporaryInputBuffer[i];
768        if (tempBuffer) {
769
770            // Since we trust that the pipeline won't call this kernel unless there is enough data to process a stride, whenever
771            // we discover that there isn't enough linearly available data, optimistically copy the data to the temporary buffer.
772
773            BasicBlock * const entry = b->GetInsertBlock();
774            BasicBlock * const copyFromBack = b->CreateBasicBlock(name + "CopyFromBack");
775            BasicBlock * const copyFromFront = b->CreateBasicBlock(name + "CopyFromFront");
776            BasicBlock * const resume = b->CreateBasicBlock(name + "Resume");
777
778            b->CreateUnlikelyCondBr(b->CreateICmpEQ(accessibleStrides, ZERO), copyFromBack, resume);
779
780            b->SetInsertPoint(copyFromBack);
781            Value * const temporaryAvailable = b->CreateUMin(unprocessed, inputStrideSize[i]);
782            if (LLVM_UNLIKELY(codegen::DebugOptionIsSet(codegen::EnableAsserts))) {
783                b->CreateAssert(b->CreateICmpULE(mAvailableItemCount[i], temporaryAvailable),
784                                "linearly available cannot be greater than temporarily available");
785            }
786            Value * const offset = b->CreateAnd(ic, BLOCK_WIDTH_MASK);
787            Value * const bufferSize = b->CreateMul(ConstantExpr::getSizeOf(tempBuffer->getAllocatedType()), tempBuffer->getArraySize());
788            b->CreateMemZero(tempBuffer, bufferSize, blockAlignment);
789            const auto copyAlignment = getItemAlignment(mStreamSetInputs[i]);
790            b->CreateStreamCpy(name, tempBuffer, ZERO, baseBuffer, offset, mAvailableItemCount[i], copyAlignment);
791            Value * const temporaryStrides = b->CreateSelect(b->CreateICmpULT(unprocessed, inputStrideSize[i]), ZERO, ONE);
792            BasicBlock * const copyToBackEnd = b->GetInsertBlock();
793            b->CreateCondBr(b->CreateICmpNE(mAvailableItemCount[i], temporaryAvailable), copyFromFront, resume);
794
795            b->SetInsertPoint(copyFromFront);
796            Value * const remaining = b->CreateSub(temporaryAvailable, mAvailableItemCount[i]);
797            Value * const baseAddress = b->getBaseAddress(name);
798            b->CreateStreamCpy(name, tempBuffer, mAvailableItemCount[i], baseAddress, ZERO, remaining, copyAlignment);
799            BasicBlock * const copyToFrontEnd = b->GetInsertBlock();
800            b->CreateBr(resume);
801
802            b->SetInsertPoint(resume);
803            PHINode * const bufferPtr = b->CreatePHI(baseBuffer->getType(), 3);
804            bufferPtr->addIncoming(baseBuffer , entry);
805            bufferPtr->addIncoming(tempBuffer, copyToBackEnd);
806            bufferPtr->addIncoming(tempBuffer, copyToFrontEnd);
807            baseBuffer = bufferPtr;
808
809            PHINode * const phiAvailItemCount = b->CreatePHI(b->getSizeTy(), 3);
810            phiAvailItemCount->addIncoming(mAvailableItemCount[i], entry);
811            phiAvailItemCount->addIncoming(temporaryAvailable, copyToBackEnd);
812            phiAvailItemCount->addIncoming(temporaryAvailable, copyToFrontEnd);
813            mAvailableItemCount[i] = phiAvailItemCount;
814
815            PHINode * const phiStrides = b->CreatePHI(b->getSizeTy(), 2);
816            phiStrides->addIncoming(accessibleStrides, entry);
817            phiStrides->addIncoming(temporaryStrides, copyToBackEnd);
818            phiStrides->addIncoming(temporaryStrides, copyToFrontEnd);
819            accessibleStrides = phiStrides;
820        }
821
822        mStreamSetInputBaseAddress[i] = baseBuffer;
823        numOfStrides = b->CreateUMin(numOfStrides, accessibleStrides);
824    }
825
826    // Now determine the linearly writeable strides
827    Value * linearlyWritable[outputSetCount];
828    Value * outputStrideSize[outputSetCount];
829    mInitialProducedItemCount.resize(outputSetCount);
830    mStreamSetOutputBaseAddress.resize(outputSetCount);
831    for (unsigned i = 0; i < outputSetCount; i++) {
832        const auto & output = mStreamSetOutputs[i];
833        const auto & name = output.getName();
834        const ProcessingRate & rate = output.getRate();
835        Value * const ic = b->getProducedItemCount(name);
836        Value * baseBuffer = b->getBlockAddress(name, b->CreateLShr(ic, LOG_2_BLOCK_WIDTH));
837        assert (baseBuffer->getType()->isPointerTy());
838        linearlyWritable[i] = b->getLinearlyWritableItems(name, ic);       
839        outputStrideSize[i] = getStrideSize(b, rate);
840        // Is the number of linearly writable items sufficient for a stride?
841        if (outputStrideSize[i]) {
842            AllocaInst * const tempBuffer = temporaryOutputBuffer[i];
843            Value * writableStrides = b->CreateUDiv(linearlyWritable[i], outputStrideSize[i]);
844            // Do we require a temporary buffer to write to?
845            if (tempBuffer) {
846                assert (tempBuffer->getType() == baseBuffer->getType());
847                BasicBlock * const entry = b->GetInsertBlock();
848                BasicBlock * const useTemporary = b->CreateBasicBlock(name + "UseTemporary");
849                BasicBlock * const resume = b->CreateBasicBlock(name + "Resume");
850                Value * const requiresCopy = b->CreateICmpEQ(writableStrides, ZERO);
851
852                b->CreateUnlikelyCondBr(requiresCopy, useTemporary, resume);
853
854                // Clear the buffer after use since we may end up reusing it within the same stride
855                b->SetInsertPoint(useTemporary);
856                Value * const bufferSize = b->CreateMul(ConstantExpr::getSizeOf(tempBuffer->getAllocatedType()), tempBuffer->getArraySize());
857                b->CreateMemZero(tempBuffer, bufferSize, blockAlignment);
858                b->CreateBr(resume);
859
860                b->SetInsertPoint(resume);
861                PHINode * const phiBuffer = b->CreatePHI(baseBuffer->getType(), 3);
862                phiBuffer->addIncoming(baseBuffer, entry);
863                phiBuffer->addIncoming(tempBuffer, useTemporary);
864                baseBuffer = phiBuffer;
865                PHINode * const phiStrides = b->CreatePHI(b->getSizeTy(), 2);
866                phiStrides->addIncoming(writableStrides, entry);
867                phiStrides->addIncoming(ONE, useTemporary);
868                writableStrides = phiStrides;
869
870            }
871            numOfStrides = b->CreateUMin(numOfStrides, writableStrides);
872        }
873        mInitialProducedItemCount[i] = ic;
874        mStreamSetOutputBaseAddress[i] = baseBuffer;
875    }
876
877    BasicBlock * const segmentDone = b->CreateBasicBlock("SegmentDone");
878
879    Value * const initiallyFinal = mIsFinal;
880    if (LLVM_LIKELY(numOfStrides != nullptr)) {
881        mIsFinal = b->CreateAnd(mIsFinal, b->CreateICmpEQ(numOfStrides, ZERO));
882        if (LLVM_UNLIKELY(codegen::DebugOptionIsSet(codegen::EnableAsserts))) {
883            Value * const hasStride = b->CreateOr(b->CreateICmpNE(numOfStrides, ZERO), mIsFinal);
884            b->CreateAssert(hasStride, getName() + " has insufficient input data or output space for one stride");
885        }
886        for (unsigned i = 0; i < inputSetCount; ++i) {
887            const ProcessingRate & rate = mStreamSetInputs[i].getRate();
888            if (rate.isFixed() && mStreamSetInputs[i].nonDeferred()) {
889                mAvailableItemCount[i] = b->CreateSelect(mIsFinal, mAvailableItemCount[i], b->CreateMul(numOfStrides, inputStrideSize[i]));
890            }
891        }
892    }
893
894    //  We have one or more blocks of input data and output buffer space for all stream sets.
895    generateMultiBlockLogic(b, numOfStrides);
896
897    for (unsigned i = 0; i < inputSetCount; ++i) {
898        const ProcessingRate & rate = mStreamSetInputs[i].getRate();
899        if (rate.isFixed() && mStreamSetInputs[i].nonDeferred()) {
900            Value * const ic = b->CreateAdd(mInitialProcessedItemCount[i], mAvailableItemCount[i]);
901            b->setProcessedItemCount(mStreamSetInputs[i].getName(), ic);
902        }
903    }
904
905    for (unsigned i = 0; i < outputSetCount; ++i) {
906        const ProcessingRate & rate = mStreamSetOutputs[i].getRate();
907        if (rate.isFixed()) {
908            assert (mStreamSetOutputs[i].nonDeferred());
909            Value * const produced = b->CreateMul(numOfStrides, outputStrideSize[i]);
910            Value * const ic = b->CreateAdd(mInitialProducedItemCount[i], produced);
911            b->setProducedItemCount(mStreamSetOutputs[i].getName(), ic);
912        }
913    }
914
915    BasicBlock * const handleFinalBlock = b->CreateBasicBlock("HandleFinalBlock");
916    BasicBlock * const temporaryBufferCopyBack = b->CreateBasicBlock("TemporaryBufferCopyBack");
917    BasicBlock * const strideDone = b->CreateBasicBlock("MultiBlockDone");
918
919    b->CreateUnlikelyCondBr(mIsFinal, handleFinalBlock, temporaryBufferCopyBack);
920
921
922    /// FINAL STRIDE ADJUSTMENT
923    b->SetInsertPoint(handleFinalBlock);
924
925    // If this is our final stride, adjust the Fixed output item counts. The main loop assumes that
926    // the ITEM COUNT % FIXED RATE = 0 for all Fixed Input and Output streams. We correct that here
927    // to calculate them based on the actual input item counts.
928
929    reviseFinalProducedItemCounts(b);
930
931    b->CreateBr(temporaryBufferCopyBack);
932
933    /// TEMPORARY BUFFER COPY BACK
934    b->SetInsertPoint(temporaryBufferCopyBack);
935
936    // Copy back data to the actual output buffers.
937    for (unsigned i = 0; i < outputSetCount; i++) {
938        AllocaInst * const tempBuffer = temporaryOutputBuffer[i];
939        if (LLVM_UNLIKELY(tempBuffer == nullptr)) {
940            continue;
941        }
942        Value * const baseBuffer = mStreamSetOutputBaseAddress[i];
943        assert ("stack corruption likely" && (tempBuffer->getType() == baseBuffer->getType()));
944        const auto & name = mStreamSetOutputs[i].getName();
945        BasicBlock * const copyToBack = b->CreateBasicBlock(name + "CopyToBack");
946        BasicBlock * const copyToFront = b->CreateBasicBlock(name + "CopyToFront");
947        BasicBlock * const resume = b->CreateBasicBlock(name + "ResumeCopyBack");
948        // If we used a temporary buffer, copy it back to the original output buffer
949        b->CreateCondBr(b->CreateICmpEQ(tempBuffer, baseBuffer), copyToBack, resume);
950
951        b->SetInsertPoint(copyToBack);       
952        Value * const offset = b->CreateAnd(mInitialProducedItemCount[i], BLOCK_WIDTH_MASK);
953        Value * const newProducedItemCount = b->getProducedItemCount(name);
954        Value * const newlyProduced = b->CreateSub(newProducedItemCount, mInitialProducedItemCount[i]);
955        Value * const toWrite = b->CreateUMin(newlyProduced, linearlyWritable[i]);
956        const auto alignment = getItemAlignment(mStreamSetOutputs[i]);
957        b->CreateStreamCpy(name, baseBuffer, offset, tempBuffer, ZERO, toWrite, alignment);
958        // If we required a temporary output buffer, we will probably need to write to the beginning of the buffer as well.
959        b->CreateLikelyCondBr(b->CreateICmpULT(toWrite, newlyProduced), copyToFront, resume);
960
961        b->SetInsertPoint(copyToFront);
962        Value * const remaining = b->CreateSub(newlyProduced, toWrite);
963        Value * const baseAddress = b->getBaseAddress(name);
964        b->CreateStreamCpy(name, baseAddress, ZERO, tempBuffer, toWrite, remaining, alignment);
965        b->CreateBr(resume);
966
967        b->SetInsertPoint(resume);
968    }
969
970    //  We've dealt with the partial block processing and copied information back into the
971    //  actual buffers.  If this isn't the final block, loop back for more multiblock processing.
972    if (hasNoTerminateAttribute()) {
973        b->CreateCondBr(mIsFinal, segmentDone, strideDone);
974    } else {
975        BasicBlock * const setTermination = b->CreateBasicBlock("setTermination");
976        b->CreateCondBr(mIsFinal, setTermination, strideDone);
977
978        b->SetInsertPoint(setTermination);
979        b->setTerminationSignal();
980        b->CreateBr(segmentDone);       
981    }
982
983    /// STRIDE DONE
984    strideDone->moveAfter(b->GetInsertBlock());
985    b->SetInsertPoint(strideDone);
986
987    b->CreateAssertZero(mIsFinal, "stride done cannot process the final block");
988
989    // do we have enough data for another stride?
990    Value * hasMoreStrides = b->getTrue();
991    for (unsigned i = 0; i < inputSetCount; ++i) {
992        const auto & name = mStreamSetInputs[i].getName();
993        Value * const avail = mInitialAvailableItemCount[i];
994        Value * const processed = b->getProcessedItemCount(name);
995        if (LLVM_UNLIKELY(codegen::DebugOptionIsSet(codegen::EnableAsserts))) {
996            b->CreateAssert(b->CreateICmpULE(processed, avail), name + ": processed data cannot exceed available data");
997        }
998        Value * const remaining = b->CreateSub(avail, processed);
999        Value * const remainingStrides = b->CreateUDiv(remaining, inputStrideSize[i]);
1000        Value * const hasRemainingStrides = b->CreateICmpNE(remainingStrides, ZERO);
1001        hasMoreStrides = b->CreateAnd(hasMoreStrides, hasRemainingStrides);
1002    }
1003    // even if we do not have enough input data for a full stride, if this is our final stride, allow it ...
1004    hasMoreStrides = b->CreateOr(hasMoreStrides, initiallyFinal);
1005
1006    // do we have enough room for another stride?
1007    for (unsigned i = 0; i < outputSetCount; ++i) {
1008        const ProcessingRate & rate = mStreamSetOutputs[i].getRate();
1009        const auto & name = mStreamSetOutputs[i].getName();
1010        Value * const produced = b->getProducedItemCount(name);
1011        // If this output has a Fixed/Bounded rate, determine whether we have room for another stride.
1012        if (LLVM_LIKELY(outputStrideSize[i] != nullptr)) {
1013            Value * const consumed = b->getConsumedItemCount(name);
1014            if (LLVM_UNLIKELY(codegen::DebugOptionIsSet(codegen::EnableAsserts))) {
1015                b->CreateAssert(b->CreateICmpULE(consumed, produced), name + ": consumed data cannot exceed produced data");
1016            }
1017            Value * const unconsumed = b->CreateSub(produced, consumed);
1018            Value * const capacity = b->getCapacity(name);
1019            if (LLVM_UNLIKELY(codegen::DebugOptionIsSet(codegen::EnableAsserts))) {
1020                b->CreateAssert(b->CreateICmpULE(unconsumed, capacity), name + ": unconsumed data cannot exceed capacity");
1021            }
1022            Value * const remaining = b->CreateSub(capacity, unconsumed);
1023            Value * const remainingStrides = b->CreateUDiv(remaining, outputStrideSize[i]);
1024            Value * const hasRemainingStrides = b->CreateICmpNE(remainingStrides, ZERO);
1025            hasMoreStrides = b->CreateAnd(hasMoreStrides, hasRemainingStrides);
1026        }
1027        // Do copybacks if necessary.
1028        if (mStreamSetOutputBuffers[i]->supportsCopyBack() && requiresCopyBack(rate)) {
1029            b->CreateCopyBack(name, mInitialProducedItemCount[i], produced);
1030        }
1031    }
1032
1033    // b->CreateAssertZero(b->CreateOr(b->CreateNot(initiallyFinal), hasMoreStrides), getName() + " does not have enough output space for the final stride");
1034
1035    b->CreateCondBr(hasMoreStrides, segmentLoop, segmentDone);
1036
1037    /// SEGMENT DONE
1038    segmentDone->moveAfter(b->GetInsertBlock());
1039    b->SetInsertPoint(segmentDone);
1040
1041}
1042
1043/** ------------------------------------------------------------------------------------------------------------- *
1044 * @brief requiresCopyBack
1045 ** ------------------------------------------------------------------------------------------------------------- */
1046bool MultiBlockKernel::requiresCopyBack(const ProcessingRate & rate) const {
1047    if (rate.isBounded() || rate.isUnknown()) {
1048        return true;
1049    } else if (rate.isRelative()) {
1050        return requiresCopyBack(getBinding(rate.getReference()).getRate());
1051    }
1052    return false;
1053}
1054
1055/** ------------------------------------------------------------------------------------------------------------- *
1056 * @brief CreateUDivCeil
1057 ** ------------------------------------------------------------------------------------------------------------- */
1058inline Value * CreateUDivCeil(const std::unique_ptr<KernelBuilder> & b, Value * const number, const ProcessingRate::RateValue divisor, const Twine & Name = "") {
1059    Constant * const n = ConstantInt::get(number->getType(), divisor.numerator());
1060    if (LLVM_LIKELY(divisor.denominator() == 1)) {
1061        return b->CreateUDivCeil(number, n, Name);
1062    } else {
1063        //   âŒŠ(num + ratio - 1) / ratio⌋
1064        // = ⌊(num - 1) / (n/d)⌋ + (ratio/ratio)
1065        // = ⌊(d * (num - 1)) / n⌋ + 1
1066        Constant * const ONE = ConstantInt::get(number->getType(), 1);
1067        Constant * const d = ConstantInt::get(number->getType(), divisor.denominator());
1068        return b->CreateAdd(b->CreateUDiv(b->CreateMul(b->CreateSub(number, ONE), d), n), ONE, Name);
1069    }
1070}
1071
1072
1073/** ------------------------------------------------------------------------------------------------------------- *
1074 * @brief reviseFinalProducedItemCounts
1075 ** ------------------------------------------------------------------------------------------------------------- */
1076void MultiBlockKernel::reviseFinalProducedItemCounts(const std::unique_ptr<KernelBuilder> & b) {
1077
1078    if (LLVM_UNLIKELY(mStreamSetInputs.empty())) {
1079        return;
1080    }
1081
1082    const auto inputSetCount = mStreamSetInputs.size();
1083
1084    ProcessingRate::RateValue rateLCM(1);
1085    unsigned first = 0;
1086    unsigned last = inputSetCount;
1087
1088    for (unsigned i = 0; i < inputSetCount; ++i) {
1089        const ProcessingRate & pr = mStreamSetInputs[i].getRate();
1090        if (pr.isFixed()) {
1091            rateLCM = lcm(rateLCM, pr.getRate());
1092            if (mStreamSetInputs[i].isPrincipal()) {
1093                assert ("A kernel cannot have multiple principle input streams" && (first == 0 && last == inputSetCount));
1094                first = i;
1095                last = i + 1;
1096            }
1097        }       
1098    }
1099
1100    bool noFixedRateOutput = true;
1101
1102    for (const Binding & output : mStreamSetOutputs) {
1103        const ProcessingRate & pr = output.getRate();
1104        if (pr.isFixed()) {
1105            rateLCM = lcm(rateLCM, pr.getRate());
1106            noFixedRateOutput = false;
1107        }
1108    }
1109
1110    if (noFixedRateOutput) {
1111        return;
1112    }
1113
1114    Value * baseInitialProcessedItemCount = nullptr;
1115    Value * scaledInverseOfAvailItemCount = nullptr;
1116
1117    // For each Fixed output stream, this calculates:
1118
1119    //    CEILING(MIN(Available Item Count / Fixed Input Rate) * Fixed Output Rate)
1120
1121    // But avoids the possibility of overflow errors (assuming that each processed item count does not overflow)
1122
1123    for (unsigned i = first; i < last; ++i) {
1124        const ProcessingRate & pr = mStreamSetInputs[i].getRate();
1125        if (pr.isFixed()) {
1126            Value * p = mInitialProcessedItemCount[i];
1127            Value * a = b->CreateSub(mInitialAvailableItemCount[i], p);
1128            const auto & rate = pr.getRate();
1129            if (LLVM_UNLIKELY(rateLCM != rate)) {
1130                const auto factor = rateLCM / rate;
1131                if (LLVM_UNLIKELY(factor.numerator() > 1)) {
1132                    a = b->CreateMul(a, b->getSize(factor.numerator()));
1133                }
1134                if (LLVM_UNLIKELY(factor.denominator() > 1)) {
1135                    a = b->CreateUDiv(a, b->getSize(factor.denominator()));
1136                }
1137            }
1138            if (LLVM_UNLIKELY(rate.denominator() > 1)) {
1139                p = b->CreateMul(p, b->getSize(rate.denominator()));
1140            }
1141            if (LLVM_UNLIKELY(rate.numerator() > 1)) {
1142                p = b->CreateUDiv(p, b->getSize(rate.numerator()));
1143            }
1144            if (scaledInverseOfAvailItemCount) {
1145                scaledInverseOfAvailItemCount = b->CreateUMin(scaledInverseOfAvailItemCount, a);
1146                baseInitialProcessedItemCount = b->CreateUMin(baseInitialProcessedItemCount, p);
1147            } else {
1148                scaledInverseOfAvailItemCount = a;
1149                baseInitialProcessedItemCount = p;
1150            }
1151        }
1152    }
1153
1154    for (const Binding & output : mStreamSetOutputs) {
1155        const auto name = output.getName();
1156        const ProcessingRate & pr = output.getRate();
1157        Value * produced = nullptr;
1158        if (pr.isFixed() && output.nonDeferred()) {
1159            assert (baseInitialProcessedItemCount && scaledInverseOfAvailItemCount);
1160            const auto rate = pr.getRate();
1161            Value * p = baseInitialProcessedItemCount;
1162            if (LLVM_UNLIKELY(rate.numerator() != 1)) {
1163                p = b->CreateMul(p, b->getSize(rate.numerator()));
1164            }
1165            if (LLVM_UNLIKELY(rate.denominator() != 1)) {
1166                p = b->CreateUDiv(p, b->getSize(rate.denominator()));
1167            }
1168            Value * const ic = CreateUDivCeil(b, scaledInverseOfAvailItemCount, rateLCM / pr.getRate());
1169            produced = b->CreateAdd(p, ic);
1170        } else { // check if we have an attribute; if so, get the current produced count and adjust it
1171            bool noAttributes = true;
1172            for (const Attribute & attr : output.getAttributes()) {
1173                if (attr.isAdd() || attr.isRoundUpTo()) {
1174                    noAttributes = false;
1175                    break;
1176                }
1177            }
1178            if (noAttributes) {
1179                continue;
1180            }
1181            produced = b->getProducedItemCount(name);
1182        }
1183        for (const Attribute & attr : output.getAttributes()) {
1184            if (attr.isAdd()) {
1185                produced = b->CreateAdd(produced, b->getSize(attr.getAmount()));
1186            } else if (attr.isRoundUpTo()) {
1187                produced = b->CreateRoundUp(produced, b->getSize(attr.getAmount()));
1188            }
1189        }
1190        b->setProducedItemCount(name, produced);
1191    }
1192
1193}
1194
1195/** ------------------------------------------------------------------------------------------------------------- *
1196 * @brief generateMultiBlockLogic
1197 ** ------------------------------------------------------------------------------------------------------------- */
1198Value * BlockOrientedKernel::generateMultiBlockLogic(const std::unique_ptr<KernelBuilder> & b, Value * const numOfBlocks) {
1199
1200    if (LLVM_UNLIKELY(mStride != b->getBitBlockWidth())) {
1201        report_fatal_error(getName() + ": the Stride (" + std::to_string(mStride) + ") of BlockOrientedKernel "
1202                           "equal to the BitBlockWidth (" + std::to_string(b->getBitBlockWidth()) + ")");
1203    }
1204
1205    Constant * const LOG_2_BLOCK_WIDTH = b->getSize(std::log2(b->getBitBlockWidth()));
1206
1207    BasicBlock * const entryBlock = b->GetInsertBlock();
1208    mStrideLoopBody = b->CreateBasicBlock(getName() + "_strideLoopBody");
1209    BasicBlock * const stridesDone = b->CreateBasicBlock(getName() + "_stridesDone");
1210    BasicBlock * const doFinalBlock = b->CreateBasicBlock(getName() + "_doFinalBlock");
1211    BasicBlock * const segmentDone = b->CreateBasicBlock(getName() + "_segmentDone");
1212    if (LLVM_UNLIKELY(codegen::DebugOptionIsSet(codegen::EnableAsserts))) {
1213        b->CreateAssert(b->CreateXor(b->CreateIsNotNull(numOfBlocks), mIsFinal),
1214                        "numOfStrides cannot be 0 unless this is the final stride and must be 0 if it is");
1215    }
1216    const auto inputSetCount = mStreamSetInputs.size();
1217    Value * baseProcessedIndex[inputSetCount];
1218    Value * baseInputAddress[inputSetCount];
1219    for (unsigned i = 0; i < inputSetCount; i++) {
1220        const ProcessingRate & rate = mStreamSetInputs[i].getRate();
1221        if (LLVM_UNLIKELY(!rate.isFixed())) {
1222            Value * const ic = mInitialProcessedItemCount[i];
1223            baseProcessedIndex[i] = b->CreateLShr(ic, LOG_2_BLOCK_WIDTH);
1224        }
1225        baseInputAddress[i] = mStreamSetInputBaseAddress[i];
1226    }
1227
1228    const auto outputSetCount = mStreamSetOutputs.size();
1229    Value * baseProducedIndex[outputSetCount];
1230    Value * baseOutputAddress[inputSetCount];
1231    for (unsigned i = 0; i < outputSetCount; i++) {
1232        const ProcessingRate & rate = mStreamSetOutputs[i].getRate();
1233        if (LLVM_UNLIKELY(!rate.isFixed())) {
1234            Value * const ic = b->getProducedItemCount(mStreamSetOutputs[i].getName());
1235            baseProducedIndex[i] = b->CreateLShr(ic, LOG_2_BLOCK_WIDTH);
1236        }
1237        baseOutputAddress[i] = mStreamSetOutputBaseAddress[i];
1238    }
1239
1240    b->CreateUnlikelyCondBr(mIsFinal, doFinalBlock, mStrideLoopBody);
1241
1242    /// BLOCK BODY
1243
1244    b->SetInsertPoint(mStrideLoopBody);
1245
1246    if (b->supportsIndirectBr()) {
1247        Value * const baseTarget = BlockAddress::get(segmentDone);
1248        mStrideLoopTarget = b->CreatePHI(baseTarget->getType(), 2, "strideTarget");
1249        mStrideLoopTarget->addIncoming(baseTarget, entryBlock);
1250    }
1251
1252    mStrideBlockIndex = b->CreatePHI(b->getSizeTy(), 2);
1253    mStrideBlockIndex->addIncoming(b->getSize(0), entryBlock);
1254
1255    /// GENERATE DO BLOCK METHOD
1256
1257    for (unsigned i = 0; i < inputSetCount; ++i) {
1258        Value * index = mStrideBlockIndex;
1259        const ProcessingRate & rate = mStreamSetInputs[i].getRate();
1260        if (LLVM_UNLIKELY(!rate.isFixed())) {
1261            Value * ic = b->getProcessedItemCount(mStreamSetInputs[i].getName());
1262            index = b->CreateSub(b->CreateLShr(ic, LOG_2_BLOCK_WIDTH), baseProcessedIndex[i]);
1263        }
1264        mStreamSetInputBaseAddress[i] = b->CreateGEP(mStreamSetInputBaseAddress[i], index);
1265    }
1266
1267    for (unsigned i = 0; i < outputSetCount; ++i) {
1268        Value * index = mStrideBlockIndex;
1269        const ProcessingRate & rate = mStreamSetOutputs[i].getRate();
1270        if (LLVM_UNLIKELY(!rate.isFixed())) {
1271            Value * ic = b->getProducedItemCount(mStreamSetOutputs[i].getName());
1272            index = b->CreateSub(b->CreateLShr(ic, LOG_2_BLOCK_WIDTH), baseProducedIndex[i]);
1273        }
1274        mStreamSetOutputBaseAddress[i] = b->CreateGEP(mStreamSetOutputBaseAddress[i], index);
1275    }
1276
1277    writeDoBlockMethod(b);
1278
1279    BasicBlock * const bodyEnd = b->GetInsertBlock();
1280    if (mStrideLoopTarget) {
1281        mStrideLoopTarget->addIncoming(mStrideLoopTarget, bodyEnd);
1282    }
1283
1284    Value * const nextIndex = b->CreateAdd(mStrideBlockIndex, b->getSize(1));
1285    mStrideBlockIndex->addIncoming(nextIndex, bodyEnd);
1286    Value * const notDone = b->CreateICmpULT(nextIndex, numOfBlocks);
1287    b->CreateCondBr(notDone, mStrideLoopBody, stridesDone);
1288
1289    stridesDone->moveAfter(bodyEnd);
1290
1291    /// STRIDE DONE
1292
1293    b->SetInsertPoint(stridesDone);
1294
1295    // Now conditionally perform the final block processing depending on the doFinal parameter.
1296    if (mStrideLoopTarget) {
1297        mStrideLoopBranch = b->CreateIndirectBr(mStrideLoopTarget, 3);
1298        mStrideLoopBranch->addDestination(doFinalBlock);
1299        mStrideLoopBranch->addDestination(segmentDone);
1300    } else {
1301        b->CreateUnlikelyCondBr(mIsFinal, doFinalBlock, segmentDone);
1302    }
1303
1304    doFinalBlock->moveAfter(stridesDone);
1305
1306    /// DO FINAL BLOCK
1307
1308    b->SetInsertPoint(doFinalBlock);
1309    for (unsigned i = 0; i < inputSetCount; ++i) {
1310        mStreamSetInputBaseAddress[i] = baseInputAddress[i];
1311    }
1312
1313    for (unsigned i = 0; i < outputSetCount; ++i) {
1314        mStreamSetOutputBaseAddress[i] = baseOutputAddress[i];
1315    }
1316
1317    writeFinalBlockMethod(b, getRemainingItems(b));
1318
1319    b->CreateBr(segmentDone);
1320
1321    segmentDone->moveAfter(b->GetInsertBlock());
1322
1323    b->SetInsertPoint(segmentDone);
1324
1325    // Update the branch prediction metadata to indicate that the likely target will be segmentDone
1326    if (mStrideLoopTarget) {
1327        MDBuilder mdb(b->getContext());
1328        const auto destinations = mStrideLoopBranch->getNumDestinations();
1329        uint32_t weights[destinations];
1330        for (unsigned i = 0; i < destinations; ++i) {
1331            weights[i] = (mStrideLoopBranch->getDestination(i) == segmentDone) ? 100 : 1;
1332        }
1333        ArrayRef<uint32_t> bw(weights, destinations);
1334        mStrideLoopBranch->setMetadata(LLVMContext::MD_prof, mdb.createBranchWeights(bw));
1335    }
1336
1337    return numOfBlocks;
1338}
1339
1340/** ------------------------------------------------------------------------------------------------------------- *
1341 * @brief getRemainingItems
1342 ** ------------------------------------------------------------------------------------------------------------- */
1343Value * BlockOrientedKernel::getRemainingItems(const std::unique_ptr<KernelBuilder> & b) {
1344    Value * remainingItems = nullptr;
1345    const auto count = mStreamSetInputs.size();
1346    if (count == 1) {
1347        return mAvailableItemCount[0];
1348    } else {
1349        for (unsigned i = 0; i < count; i++) {
1350            if (mStreamSetInputs[i].isPrincipal()) {
1351                return mAvailableItemCount[i];
1352            }
1353        }
1354        for (unsigned i = 0; i < count; ++i) {
1355            const ProcessingRate & r = mStreamSetInputs[i].getRate();
1356            if (r.isFixed()) {
1357                Value * ic = CreateUDivCeil(b, mAvailableItemCount[i], r.getRate());
1358                if (remainingItems) {
1359                    remainingItems = b->CreateUMin(remainingItems, ic);
1360                } else {
1361                    remainingItems = ic;
1362                }
1363            }
1364        }
1365    }
1366    return remainingItems;
1367}
1368
1369/** ------------------------------------------------------------------------------------------------------------- *
1370 * @brief writeDoBlockMethod
1371 ** ------------------------------------------------------------------------------------------------------------- */
1372inline void BlockOrientedKernel::writeDoBlockMethod(const std::unique_ptr<KernelBuilder> & b) {
1373
1374    Value * const self = getInstance();
1375    Function * const cp = mCurrentMethod;
1376    auto ip = b->saveIP();
1377    std::vector<Value *> availableItemCount(0);
1378
1379    /// Check if the do block method is called and create the function if necessary
1380    if (!b->supportsIndirectBr()) {
1381
1382        std::vector<Type *> params;
1383        params.reserve(1 + mAvailableItemCount.size());
1384        params.push_back(self->getType());
1385        for (Value * avail : mAvailableItemCount) {
1386            params.push_back(avail->getType());
1387        }
1388
1389        FunctionType * const type = FunctionType::get(b->getVoidTy(), params, false);
1390        mCurrentMethod = Function::Create(type, GlobalValue::InternalLinkage, getName() + DO_BLOCK_SUFFIX, b->getModule());
1391        mCurrentMethod->setCallingConv(CallingConv::C);
1392        mCurrentMethod->setDoesNotThrow();
1393        auto args = mCurrentMethod->arg_begin();
1394        args->setName("self");
1395        setInstance(&*args);
1396        availableItemCount.reserve(mAvailableItemCount.size());
1397        while (++args != mCurrentMethod->arg_end()) {
1398            availableItemCount.push_back(&*args);
1399        }
1400        assert (availableItemCount.size() == mAvailableItemCount.size());
1401        mAvailableItemCount.swap(availableItemCount);
1402        b->SetInsertPoint(BasicBlock::Create(b->getContext(), "entry", mCurrentMethod));
1403    }
1404
1405    generateDoBlockMethod(b); // must be implemented by the BlockOrientedKernelBuilder subtype
1406
1407    if (!b->supportsIndirectBr()) {
1408        // Restore the DoSegment function state then call the DoBlock method
1409        b->CreateRetVoid();
1410        mDoBlockMethod = mCurrentMethod;
1411        b->restoreIP(ip);
1412        setInstance(self);
1413        mCurrentMethod = cp;
1414        mAvailableItemCount.swap(availableItemCount);
1415        CreateDoBlockMethodCall(b);
1416    }
1417
1418}
1419
1420/** ------------------------------------------------------------------------------------------------------------- *
1421 * @brief writeFinalBlockMethod
1422 ** ------------------------------------------------------------------------------------------------------------- */
1423inline void BlockOrientedKernel::writeFinalBlockMethod(const std::unique_ptr<KernelBuilder> & b, Value * remainingItems) {
1424
1425    Value * const self = getInstance();
1426    Function * const cp = mCurrentMethod;
1427    Value * const remainingItemCount = remainingItems;
1428    auto ip = b->saveIP();
1429    std::vector<Value *> availableItemCount(0);
1430
1431    if (!b->supportsIndirectBr()) {
1432        std::vector<Type *> params;
1433        params.reserve(2 + mAvailableItemCount.size());
1434        params.push_back(self->getType());
1435        params.push_back(b->getSizeTy());
1436        for (Value * avail : mAvailableItemCount) {
1437            params.push_back(avail->getType());
1438        }
1439        FunctionType * const type = FunctionType::get(b->getVoidTy(), params, false);
1440        mCurrentMethod = Function::Create(type, GlobalValue::InternalLinkage, getName() + FINAL_BLOCK_SUFFIX, b->getModule());
1441        mCurrentMethod->setCallingConv(CallingConv::C);
1442        mCurrentMethod->setDoesNotThrow();
1443        auto args = mCurrentMethod->arg_begin();
1444        args->setName("self");
1445        setInstance(&*args);
1446        remainingItems = &*(++args);
1447        remainingItems->setName("remainingItems");
1448        availableItemCount.reserve(mAvailableItemCount.size());
1449        while (++args != mCurrentMethod->arg_end()) {
1450            availableItemCount.push_back(&*args);
1451        }
1452        assert (availableItemCount.size() == mAvailableItemCount.size());
1453        mAvailableItemCount.swap(availableItemCount);
1454        b->SetInsertPoint(BasicBlock::Create(b->getContext(), "entry", mCurrentMethod));
1455    }
1456
1457    generateFinalBlockMethod(b, remainingItems); // may be implemented by the BlockOrientedKernel subtype
1458
1459    if (!b->supportsIndirectBr()) {
1460        b->CreateRetVoid();
1461        b->restoreIP(ip);
1462        setInstance(self);
1463        mAvailableItemCount.swap(availableItemCount);
1464        // Restore the DoSegment function state then call the DoFinal method
1465        std::vector<Value *> args;
1466        args.reserve(2 + mAvailableItemCount.size());
1467        args.push_back(self);
1468        args.push_back(remainingItemCount);
1469        args.insert(args.end(), mAvailableItemCount.begin(), mAvailableItemCount.end());
1470        b->CreateCall(mCurrentMethod, args);
1471        mCurrentMethod = cp;
1472    }
1473
1474}
1475
1476/** ------------------------------------------------------------------------------------------------------------- *
1477 * @brief generateFinalBlockMethod
1478 ** ------------------------------------------------------------------------------------------------------------- */
1479void BlockOrientedKernel::generateFinalBlockMethod(const std::unique_ptr<KernelBuilder> & b, Value * /* remainingItems */) {
1480    //  The default finalBlock method simply dispatches to the doBlock routine.
1481    CreateDoBlockMethodCall(b);
1482}
1483
1484void BlockOrientedKernel::CreateDoBlockMethodCall(const std::unique_ptr<KernelBuilder> & b) {
1485    if (b->supportsIndirectBr()) {
1486        BasicBlock * const bb = b->CreateBasicBlock("resume");
1487        mStrideLoopBranch->addDestination(bb);
1488        BasicBlock * const current = b->GetInsertBlock();
1489        mStrideLoopTarget->addIncoming(BlockAddress::get(bb), current);
1490        mStrideBlockIndex->addIncoming(b->getSize(0), current);
1491        b->CreateBr(mStrideLoopBody);
1492        bb->moveAfter(current);
1493        b->SetInsertPoint(bb);
1494    } else {
1495        std::vector<Value *> args;
1496        args.reserve(1 + mAvailableItemCount.size());
1497        args.push_back(getInstance());
1498        args.insert(args.end(), mAvailableItemCount.begin(), mAvailableItemCount.end());
1499        b->CreateCall(mDoBlockMethod, args);
1500    }
1501}
1502
1503static inline std::string annotateKernelNameWithDebugFlags(std::string && name) {
1504    if (LLVM_UNLIKELY(codegen::DebugOptionIsSet(codegen::EnableAsserts))) {
1505        name += "_EA";
1506    }
1507    name += "_O" + std::to_string((int)codegen::OptLevel);
1508    return name;
1509}
1510
1511// CONSTRUCTOR
1512Kernel::Kernel(std::string && kernelName,
1513               Bindings && stream_inputs,
1514               Bindings && stream_outputs,
1515               Bindings && scalar_parameters,
1516               Bindings && scalar_outputs,
1517               Bindings && internal_scalars)
1518: KernelInterface(annotateKernelNameWithDebugFlags(std::move(kernelName))
1519                  , std::move(stream_inputs), std::move(stream_outputs)
1520                  , std::move(scalar_parameters), std::move(scalar_outputs)
1521                  , std::move(internal_scalars))
1522, mCurrentMethod(nullptr)
1523, mAvailablePrincipalItemCount(nullptr)
1524, mNoTerminateAttribute(false)
1525, mIsGenerated(false)
1526, mStride(0)
1527, mIsFinal(nullptr)
1528, mOutputScalarResult(nullptr) {
1529
1530}
1531
1532Kernel::~Kernel() {
1533
1534}
1535
1536// MULTI-BLOCK KERNEL CONSTRUCTOR
1537MultiBlockKernel::MultiBlockKernel(std::string && kernelName,
1538                                   Bindings && stream_inputs,
1539                                   Bindings && stream_outputs,
1540                                   Bindings && scalar_parameters,
1541                                   Bindings && scalar_outputs,
1542                                   Bindings && internal_scalars)
1543: Kernel(std::move(kernelName), std::move(stream_inputs), std::move(stream_outputs), std::move(scalar_parameters), std::move(scalar_outputs), std::move(internal_scalars)) {
1544
1545}
1546
1547// CONSTRUCTOR
1548BlockOrientedKernel::BlockOrientedKernel(std::string && kernelName,
1549                                         Bindings && stream_inputs,
1550                                         Bindings && stream_outputs,
1551                                         Bindings && scalar_parameters,
1552                                         Bindings && scalar_outputs,
1553                                         Bindings && internal_scalars)
1554: MultiBlockKernel(std::move(kernelName), std::move(stream_inputs), std::move(stream_outputs), std::move(scalar_parameters), std::move(scalar_outputs), std::move(internal_scalars))
1555, mDoBlockMethod(nullptr)
1556, mStrideLoopBody(nullptr)
1557, mStrideLoopBranch(nullptr)
1558, mStrideLoopTarget(nullptr)
1559, mStrideBlockIndex(nullptr) {
1560
1561}
1562
1563// CONSTRUCTOR
1564SegmentOrientedKernel::SegmentOrientedKernel(std::string && kernelName,
1565                                             Bindings && stream_inputs,
1566                                             Bindings && stream_outputs,
1567                                             Bindings && scalar_parameters,
1568                                             Bindings && scalar_outputs,
1569                                             Bindings && internal_scalars)
1570: Kernel(std::move(kernelName), std::move(stream_inputs), std::move(stream_outputs), std::move(scalar_parameters), std::move(scalar_outputs), std::move(internal_scalars)) {
1571
1572}
1573
1574
1575}
Note: See TracBrowser for help on using the repository browser.