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

Last change on this file since 5402 was 5402, checked in by nmedfort, 2 years ago

Moved toolchain and object_cache to kernels directory. Continued work on providing input consumed information.

File size: 7.0 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 <string>  // for string
10#include <vector>  // for vector
11namespace IDISA { class IDISA_Builder; }
12//namespace llvm { class ConstantInt; }
13#include <llvm/IR/Constants.h>
14namespace llvm { class Function; }
15namespace llvm { class Module; }
16namespace llvm { class PointerType; }
17namespace llvm { class StructType; }
18namespace llvm { class Type; }
19namespace llvm { class Value; }
20
21
22// Processing rate attributes are required for all stream set bindings for a kernel.
23// These attributes describe the number of items that are processed or produced as
24// a ratio in comparison to the principal input stream set (or the principal output
25// stream set if there is no input.
26//
27// The default ratio is FixedRatio(1) which means that there is one item processed or
28// produced for every item of the principal input or output stream.
29// FixedRatio(m, n) means that for every group of n items of the principal stream,
30// there are m items in the output stream (rounding up).
31//
32// Kernels which produce a variable number of items use MaxRatio(n), for a maximum
33// of n items produced or consumed per principal input or output item.  MaxRatio(m, n)
34// means there are at most m items for every n items of the principal stream.
35//
36// RoundUpToMultiple(n) means that number of items produced is the same as the
37// number of input items, rounded up to an exact multiple of n.
38//
39
40struct ProcessingRate  {
41    enum class ProcessingRateKind : uint8_t { Fixed, RoundUp, Add1, Max, Unknown };
42    ProcessingRateKind getKind() const {return mKind;}
43    bool isExact() const {return (mKind == ProcessingRateKind::Fixed)||(mKind == ProcessingRateKind::RoundUp)||(mKind == ProcessingRateKind::Add1) ;}
44    bool isUnknown() const { return !isExact(); }
45    llvm::Value * CreateRatioCalculation(IDISA::IDISA_Builder * b, llvm::Value * principalInputItems, llvm::Value * doFinal = nullptr) const;
46    friend ProcessingRate FixedRatio(unsigned strmItemsPer, unsigned perPrincipalInputItems, std::string && referenceStreamSet);
47    friend ProcessingRate MaxRatio(unsigned strmItemsPer, unsigned perPrincipalInputItems, std::string && referenceStreamSet);
48    friend ProcessingRate RoundUpToMultiple(unsigned itemMultiple, std::string && referenceStreamSet);
49    friend ProcessingRate Add1(std::string && referenceStreamSet);
50    friend ProcessingRate UnknownRate();
51    std::string referenceStreamSet() const { return mReferenceStreamSet;}
52protected:
53    ProcessingRate(ProcessingRateKind k, unsigned numerator, unsigned denominator, std::string && referenceStreamSet)
54    : mKind(k), mRatioNumerator(numerator), mRatioDenominator(denominator), mReferenceStreamSet(referenceStreamSet) {}
55private:
56    const ProcessingRateKind mKind;
57    const uint16_t mRatioNumerator;
58    const uint16_t mRatioDenominator;
59    const std::string mReferenceStreamSet;
60}; 
61
62ProcessingRate FixedRatio(unsigned strmItemsPer, unsigned perPrincipalInputItems = 1, std::string && referenceStreamSet = "");
63ProcessingRate MaxRatio(unsigned strmItemsPer, unsigned perPrincipalInputItems = 1, std::string && referenceStreamSet = "");
64ProcessingRate RoundUpToMultiple(unsigned itemMultiple, std::string &&referenceStreamSet = "");
65ProcessingRate Add1(std::string && referenceStreamSet = "");
66ProcessingRate UnknownRate();
67
68struct Binding {
69    Binding(llvm::Type * type, const std::string & name, ProcessingRate r = FixedRatio(1))
70    : type(type), name(name), rate(r) { }
71    llvm::Type * const        type;
72    const std::string         name;
73    const ProcessingRate      rate;
74};
75
76class KernelInterface {
77
78public:
79    /*
80     
81     This class defines the methods to be used to generate the code 
82     necessary for declaring, allocating, calling and synchronizing
83     kernels.   The methods to be used for constructing kernels are defined
84     within the KernelBuilder class of kernel.h
85     
86     */
87   
88    const std::string & getName() const { return mKernelName; }
89
90    void setName(std::string newName) { mKernelName = newName; }
91       
92    const std::vector<Binding> & getStreamInputs() const { return mStreamSetInputs; }
93
94    const std::vector<Binding> & getStreamOutputs() const { return mStreamSetOutputs; }
95
96    const std::vector<Binding> & getScalarInputs() const { return mScalarInputs; }
97
98    const std::vector<Binding> & getScalarOutputs() const { return mScalarOutputs; }
99       
100    // Add ExternalLinkage method declarations for the kernel to a given client module.
101    void addKernelDeclarations(llvm::Module * client);
102
103    virtual void createInstance() = 0;
104
105    void setInitialArguments(std::vector<llvm::Value *> args);
106
107    llvm::Value * getInstance() const { return mKernelInstance; }
108
109    unsigned getLookAhead() const {
110        return mLookAheadPositions;
111    }
112   
113    IDISA::IDISA_Builder * getBuilder() const {
114        return iBuilder;
115    }
116
117    virtual llvm::Value * getProducedItemCount(llvm::Value * instance, const std::string & name, llvm::Value * doFinal = nullptr) const = 0;
118
119    virtual void setProducedItemCount(llvm::Value * instance, const std::string & name, llvm::Value * value) const = 0;
120
121    virtual llvm::Value * getProcessedItemCount(llvm::Value * instance, const std::string & name) const = 0;
122
123    virtual void setProcessedItemCount(llvm::Value * instance, const std::string & name, llvm::Value * value) const = 0;
124
125    virtual llvm::Value * getTerminationSignal(llvm::Value * instance) const = 0;
126
127    virtual void setTerminationSignal(llvm::Value * instance) const = 0;
128   
129    void setLookAhead(unsigned lookAheadPositions) {
130        mLookAheadPositions = lookAheadPositions;
131    }
132
133    llvm::Function * getInitFunction() const;
134
135    llvm::Function * getDoSegmentFunction() const;
136
137    llvm::Function * getAccumulatorFunction(const std::string & accumName) const;
138
139protected:
140
141    KernelInterface(IDISA::IDISA_Builder * builder,
142                    std::string kernelName,
143                    std::vector<Binding> && stream_inputs,
144                    std::vector<Binding> && stream_outputs,
145                    std::vector<Binding> && scalar_inputs,
146                    std::vector<Binding> && scalar_outputs,
147                    std::vector<Binding> && internal_scalars)
148    : iBuilder(builder)
149    , mKernelName(kernelName)
150    , mStreamSetInputs(stream_inputs)
151    , mStreamSetOutputs(stream_outputs)
152    , mScalarInputs(scalar_inputs)
153    , mScalarOutputs(scalar_outputs)
154    , mInternalScalars(internal_scalars)
155    , mKernelStateType(nullptr)
156    , mKernelInstance(nullptr)
157    , mLookAheadPositions(0) {
158
159    }
160   
161protected:
162   
163    IDISA::IDISA_Builder * const iBuilder;
164    std::string mKernelName;
165    std::vector<llvm::Value *> mInitialArguments;
166    std::vector<Binding> mStreamSetInputs;
167    std::vector<Binding> mStreamSetOutputs;
168    std::vector<Binding> mScalarInputs;
169    std::vector<Binding> mScalarOutputs;
170    std::vector<Binding> mInternalScalars;
171    llvm::StructType * mKernelStateType;
172    llvm::Value * mKernelInstance;
173    unsigned mLookAheadPositions;
174   
175};
176
177#endif
Note: See TracBrowser for help on using the repository browser.