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

Last change on this file since 5782 was 5782, checked in by nmedfort, 13 months ago

Initial check-in of LookAhead? support; modified LineBreakKernel? to compute CR+LF using LookAhead?(1) + misc. fixes.

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