source: icGREP/icgrep-devel/icgrep/pablo/pablo_kernel.h @ 5435

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

Continued refactoring work.

File size: 4.5 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 PABLO_KERNEL_H
7#define PABLO_KERNEL_H
8
9#include <kernels/kernel.h>
10#include <pablo/pabloAST.h>
11#include <pablo/symbol_generator.h>
12#include <util/slab_allocator.h>
13#include <llvm/ADT/StringRef.h>
14#include <boost/container/flat_map.hpp>
15
16namespace IDISA { class IDISA_Builder; }
17namespace llvm { class Type; }
18namespace pablo { class Integer; }
19namespace pablo { class Ones; }
20namespace pablo { class PabloBlock; }
21namespace pablo { class PabloCompiler; }
22namespace pablo { class String; }
23namespace pablo { class Var; }
24namespace pablo { class Zeroes; }
25
26namespace pablo {
27
28class PabloKernel : public kernel::BlockOrientedKernel, public PabloAST {
29
30    friend class PabloCompiler;
31    friend class PabloBlock;
32    friend class CarryManager;
33
34public:
35
36    using Allocator = SlabAllocator<PabloAST *>;
37
38    static inline bool classof(const PabloAST * e) {
39        return e->getClassTypeId()  == PabloAST::ClassTypeId::Kernel;
40    }
41    static inline bool classof(const PabloKernel *) {
42        return true;
43    }
44    static inline bool classof(const void *) {
45        return false;
46    }
47
48    PabloKernel(const std::unique_ptr<IDISA::IDISA_Builder> & builder, std::string kernelName,
49                std::vector<Binding> stream_inputs = {},
50                std::vector<Binding> stream_outputs = {},
51                std::vector<Binding> scalar_parameters = {},
52                std::vector<Binding> scalar_outputs = {});
53
54    virtual ~PabloKernel();
55
56    PabloBlock * getEntryBlock() const {
57        return mEntryBlock;
58    }
59
60    PabloBlock * setEntryBlock(PabloBlock * entryBlock) {
61        assert (entryBlock);
62        std::swap(mEntryBlock, entryBlock);
63        return entryBlock;
64    }
65   
66    Var * getInputStreamVar(const std::string & name);
67
68    Var * getInput(const unsigned index) {
69        return mInputs[index];
70    }
71
72    const Var * getInput(const unsigned index) const {
73        return mInputs[index];
74    }
75
76    Var * addInput(const std::string & name, llvm::Type * const type);
77
78    unsigned getNumOfInputs() const {
79        return mInputs.size();
80    }
81   
82    Var * getOutputStreamVar(const std::string & name);
83   
84    Var * getOutputScalarVar(const std::string & name);
85
86    Var * getOutput(const unsigned index) {
87        return mOutputs[index];
88    }
89
90    const Var * getOutput(const unsigned index) const {
91        return mOutputs[index];
92    }
93
94    Var * addOutput(const std::string & name, llvm::Type * const type);
95
96    unsigned getNumOfOutputs() const {
97        return mOutputs.size();
98    }
99
100    Var * makeVariable(String * name, llvm::Type * const type);
101
102    Var * getVariable(const unsigned index) {
103        return mVariables[index];
104    }
105
106    unsigned getNumOfVariables() const {
107        return mVariables.size();
108    }
109
110    Zeroes * getNullValue(llvm::Type * const type);
111
112    Ones * getAllOnesValue(llvm::Type * const type);
113
114    inline SymbolGenerator * getSymbolTable() const {
115        return mSymbolTable;
116    }
117
118    void * operator new (std::size_t size) noexcept {
119        return std::malloc(size);
120    }
121
122    void operator delete(void* ptr) noexcept {
123        std::free(ptr);
124    }
125
126protected:
127
128    // A custom method for preparing kernel declarations is needed,
129    // so that the carry data requirements may be accommodated before
130    // finalizing the KernelStateType.
131    void prepareKernel()  override;
132
133    void generateDoBlockMethod() override final;
134
135    // The default method for Pablo final block processing sets the
136    // EOFmark bit and then calls the standard DoBlock function.
137    // This may be overridden for specialized processing.
138    virtual void generateFinalBlockMethod(llvm::Value * remainingBytes) override final;
139
140    inline String * makeName(const llvm::StringRef & prefix) const {
141        return mSymbolTable->makeString(iBuilder->getContext(), prefix);
142    }
143
144    inline Integer * getInteger(const int64_t value) const {
145        return mSymbolTable->getInteger(iBuilder->getContext(), value);
146    }
147
148private:
149
150    Allocator                       mAllocator;
151    PabloCompiler * const           mPabloCompiler;
152    SymbolGenerator *               mSymbolTable;
153    PabloBlock *                    mEntryBlock;
154
155    std::vector<Var *>              mInputs;
156    std::vector<Var *>              mOutputs;
157    std::vector<PabloAST *>         mConstants;
158    std::vector<Var *>              mVariables;
159    boost::container::flat_map<std::string, Var *> mScalarOutputNameMap;
160};
161
162}
163
164#endif // PABLO_KERNEL_H
Note: See TracBrowser for help on using the repository browser.