source: icGREP/icgrep-devel/icgrep/kernels/interface.h @ 5522

Last change on this file since 5522 was 5522, checked in by cameron, 22 months ago

Fixes for processing rates; multiblock kernel builder

File size: 8.3 KB
Line 
1/*
2 *  Copyright (c) 2016 International Characters.
3 *  This software is licensed to the public under the Open Software License 3.0.
4 */
5
6#ifndef KERNEL_INTERFACE_H
7#define KERNEL_INTERFACE_H
8
9#include <llvm/IR/Constants.h>
10#include <string>
11#include <vector>
12
13namespace IDISA { class IDISA_Builder; }
14namespace kernel { class Kernel; }
15namespace kernel { class KernelBuilder; }
16
17// Processing rate attributes are required for all stream set bindings for a kernel.
18// These attributes describe the number of items that are processed or produced as
19// a ratio in comparison to a reference stream set, normally the principal input stream set
20// by default (or the principal output stream set if there is no input).
21//
22// The default ratio is FixedRatio(1) which means that there is one item processed or
23// produced for every item of the reference stream.
24// FixedRatio(m, n) means that for every group of n items of the refrence stream,
25// there are m items in the output stream (rounding up).
26//
27// Kernels which produce a variable number of items use MaxRatio(n), for a maximum
28// of n items produced or consumed per principal input or output item.  MaxRatio(m, n)
29// means there are at most m items for every n items of the reference stream.
30//
31// RoundUpToMultiple(n) means that number of items produced is the same as the
32// number of reference items, rounded up to an exact multiple of n.
33//
34
35struct ProcessingRate  {
36    friend class kernel::Kernel;
37    enum class ProcessingRateKind : uint8_t { FixedRatio, RoundUp, Add1, MaxRatio, Unknown };
38    ProcessingRateKind getKind() const {return mKind;}
39    bool isFixedRatio() const {return mKind == ProcessingRateKind::FixedRatio;}
40    bool isMaxRatio() const {return mKind == ProcessingRateKind::MaxRatio;}
41    bool isExact() const {return (mKind == ProcessingRateKind::FixedRatio)||(mKind == ProcessingRateKind::RoundUp)||(mKind == ProcessingRateKind::Add1) ;}
42    bool isUnknownRate() const { return mKind == ProcessingRateKind::Unknown; }
43    unsigned calculateRatio(unsigned referenceItems, bool doFinal = false) const;
44    unsigned calculateMaxReferenceItems(unsigned outputItems, bool doFinal = false) const;
45    llvm::Value * CreateRatioCalculation(IDISA::IDISA_Builder * const b, llvm::Value * referenceItems, llvm::Value * doFinal = nullptr) const;
46    llvm::Value * CreateMaxReferenceItemsCalculation(IDISA::IDISA_Builder * const b, llvm::Value * outputItems, llvm::Value * doFinal = nullptr) const;
47    friend ProcessingRate FixedRatio(unsigned strmItems, unsigned referenceItems, std::string && referenceStreamSet);
48    friend ProcessingRate MaxRatio(unsigned strmItems, unsigned referenceItems, std::string && referenceStreamSet);
49    friend ProcessingRate RoundUpToMultiple(unsigned itemMultiple, std::string && referenceStreamSet);
50    friend ProcessingRate Add1(std::string && referenceStreamSet);
51    friend ProcessingRate UnknownRate();
52    uint16_t getRatioNumerator() const { return mRatioNumerator;}
53    uint16_t getRatioDenominator() const { return mRatioDenominator;}
54    const std::string & referenceStreamSet() const { return mReferenceStreamSet;}
55protected:
56    ProcessingRate(ProcessingRateKind k, unsigned numerator, unsigned denominator, std::string && referenceStreamSet)
57    : mKind(k), mRatioNumerator(numerator), mRatioDenominator(denominator), mReferenceStreamSet(referenceStreamSet) {}
58    void setReferenceStreamSet(const std::string & s) {mReferenceStreamSet = s;}
59private:
60    const ProcessingRateKind mKind;
61    const uint16_t mRatioNumerator;
62    const uint16_t mRatioDenominator;
63    std::string mReferenceStreamSet;
64}; 
65
66ProcessingRate FixedRatio(unsigned strmItems, unsigned referenceItems = 1, std::string && referenceStreamSet = "");
67ProcessingRate MaxRatio(unsigned strmItems, unsigned referenceItems = 1, std::string && referenceStreamSet = "");
68ProcessingRate RoundUpToMultiple(unsigned itemMultiple, std::string &&referenceStreamSet = "");
69ProcessingRate Add1(std::string && referenceStreamSet = "");
70ProcessingRate UnknownRate();
71
72struct Binding {
73    Binding(llvm::Type * type, const std::string & name, ProcessingRate r = FixedRatio(1))
74    : type(type), name(name), rate(r) { }
75    llvm::Type * const        type;
76    const std::string         name;
77    ProcessingRate      rate;
78};
79
80class KernelInterface {
81public:
82    /*
83     
84     This class defines the methods to be used to generate the code 
85     necessary for declaring, allocating, calling and synchronizing
86     kernels.   The methods to be used for constructing kernels are defined
87     within the KernelBuilder class of kernel.h
88     
89     */
90   
91    const std::string & getName() const {
92        return mKernelName;
93    }
94       
95    virtual bool isCachable() const = 0;
96
97    virtual std::string makeSignature(const std::unique_ptr<kernel::KernelBuilder> & idb) = 0;
98
99    const std::vector<Binding> & getStreamInputs() const {
100        return mStreamSetInputs;
101    }
102
103    const Binding & getStreamInput(const unsigned i) const {
104        return mStreamSetInputs[i];
105    }
106
107    const std::vector<Binding> & getStreamOutputs() const {
108        return mStreamSetOutputs;
109    }
110
111    const Binding & getStreamOutput(const unsigned i) const {
112        return mStreamSetOutputs[i];
113    }
114
115    const std::vector<Binding> & getScalarInputs() const {
116        return mScalarInputs;
117    }
118
119    const Binding & getScalarInput(const unsigned i) const {
120        return mScalarInputs[i];
121    }
122
123    const std::vector<Binding> & getScalarOutputs() const {
124        return mScalarOutputs;
125    }
126
127    const Binding & getScalarOutput(const unsigned i) const {
128        return mScalarOutputs[i];
129    }
130
131    // Add ExternalLinkage method declarations for the kernel to a given client module.
132    void addKernelDeclarations(const std::unique_ptr<kernel::KernelBuilder> & idb);
133
134    virtual void linkExternalMethods(const std::unique_ptr<kernel::KernelBuilder> & idb) = 0;
135
136    virtual llvm::Value * createInstance(const std::unique_ptr<kernel::KernelBuilder> & idb) = 0;
137
138    virtual void initializeInstance(const std::unique_ptr<kernel::KernelBuilder> & idb) = 0;
139
140    virtual void finalizeInstance(const std::unique_ptr<kernel::KernelBuilder> & idb) = 0;
141
142    void setInitialArguments(std::vector<llvm::Value *> && args) {
143        mInitialArguments.swap(args);
144    }
145
146    llvm::Value * getInstance() const {
147        return mKernelInstance;
148    }
149
150    void setInstance(llvm::Value * const instance) {
151        assert ("kernel instance cannot be null!" && instance);
152        assert ("kernel instance must point to a valid kernel state type!" && (instance->getType()->getPointerElementType() == mKernelStateType));
153        mKernelInstance = instance;
154    }
155
156    unsigned getLookAhead() const {
157        return mLookAheadPositions;
158    }
159
160    void setLookAhead(const unsigned lookAheadPositions) {
161        mLookAheadPositions = lookAheadPositions;
162    }
163
164protected:
165
166    llvm::Function * getInitFunction(llvm::Module * const module) const;
167
168    llvm::Function * getDoSegmentFunction(llvm::Module * const module) const;
169
170    llvm::Function * getTerminateFunction(llvm::Module * const module) const;
171
172    KernelInterface(std::string kernelName,
173                    std::vector<Binding> && stream_inputs,
174                    std::vector<Binding> && stream_outputs,
175                    std::vector<Binding> && scalar_inputs,
176                    std::vector<Binding> && scalar_outputs,
177                    std::vector<Binding> && internal_scalars)
178    : mKernelInstance(nullptr)
179    , mModule(nullptr)
180    , mKernelStateType(nullptr)
181    , mLookAheadPositions(0)
182    , mKernelName(kernelName)
183    , mStreamSetInputs(stream_inputs)
184    , mStreamSetOutputs(stream_outputs)
185    , mScalarInputs(scalar_inputs)
186    , mScalarOutputs(scalar_outputs)
187    , mInternalScalars(internal_scalars) {
188
189    }
190   
191protected:
192
193    llvm::Value *                           mKernelInstance;
194    llvm::Module *                          mModule;
195    llvm::StructType *                      mKernelStateType;
196    unsigned                                mLookAheadPositions;
197    const std::string                       mKernelName;
198    std::vector<llvm::Value *>              mInitialArguments;
199    std::vector<Binding>                    mStreamSetInputs;
200    std::vector<Binding>                    mStreamSetOutputs;
201    std::vector<Binding>                    mScalarInputs;
202    std::vector<Binding>                    mScalarOutputs;
203    std::vector<Binding>                    mInternalScalars;
204};
205
206#endif
Note: See TracBrowser for help on using the repository browser.