source: icGREP/icgrep-devel/icgrep/kernels/kernel.h @ 5133

Last change on this file since 5133 was 5133, checked in by cameron, 3 years ago

Defer binding of buffers to stream sets until kernel generation

File size: 4.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_BUILDER_H
7#define KERNEL_BUILDER_H
8
9
10#include "streamset.h"
11#include "interface.h"
12#include <vector>
13#include <llvm/IR/Type.h>
14#include <IDISA/idisa_builder.h>
15#include <boost/container/flat_map.hpp>
16
17const std::string blockNoScalar = "blockNo";
18const std::string basePtrSuffix = "_basePtr";
19const std::string blkMaskSuffix = "_blkMask";
20
21using namespace parabix;
22namespace kernel {
23   
24class KernelBuilder : public KernelInterface {
25    using NameMap = boost::container::flat_map<std::string, unsigned>;
26
27public:
28    KernelBuilder(IDISA::IDISA_Builder * builder,
29                    std::string kernelName,
30                    std::vector<StreamSetBinding> stream_inputs,
31                    std::vector<StreamSetBinding> stream_outputs,
32                    std::vector<ScalarBinding> scalar_parameters,
33                    std::vector<ScalarBinding> scalar_outputs,
34                    std::vector<ScalarBinding> internal_scalars);
35   
36    // Create a module for the kernel, including the kernel state type declaration and
37    // the full implementation of all required methods.     
38    //
39    std::unique_ptr<llvm::Module> createKernelModule(std::vector<StreamSetBuffer *> input_buffers, std::vector<StreamSetBuffer *> output_buffers);
40   
41    // Generate the Kernel to the current module (iBuilder->getModule()).
42    void generateKernel(std::vector<StreamSetBuffer *> input_buffers, std::vector<StreamSetBuffer *> output_buffers);
43   
44    llvm::Value * createInstance(std::vector<Value *> args) override;
45   
46protected:
47    //
48    // Kernel builder subtypes define their logic of kernel construction
49    // in terms of 3 virtual methods for
50    // (a) preparing the Kernel state data structure
51    // (b) defining the logic of the doBlock function, and
52    // (c) defining the logic of the finalBlock function.
53    //
54    // Note: the kernel state data structure must only be finalized after
55    // all scalar fields have been added.   If there are no fields to
56    // be added, the default method for preparing kernel state may be used.
57   
58    virtual void prepareKernel();
59   
60    // Each kernel builder subtype must provide its own logic for generating
61    // doBlock calls.
62    virtual void generateDoBlockMethod() = 0;
63   
64    // Each kernel builder subtypre must also specify the logic for processing the
65    // final block of stream data, if there is any special processing required
66    // beyond simply calling the doBlock function.   In the case that the final block
67    // processing may be trivially implemented by dispatching to the doBlock method
68    // without additional preparation, the default generateFinalBlockMethod need
69    // not be overridden.
70   
71    virtual void generateFinalBlockMethod();
72   
73    virtual void generateDoSegmentMethod();
74   
75    // Add an additional scalar field to the KernelState struct.
76    // Must occur before any call to addKernelDeclarations or createKernelModule.
77    void addScalar(llvm::Type * t, std::string scalarName);
78   
79    // Run-time access of Kernel State and parameters of methods for
80    // use in implementing kernels.
81   
82    // Get the index of a named scalar field within the kernel state struct.
83    llvm::Value * getScalarIndex(std::string);
84   
85    // Get the value of a scalar field for a given instance.
86    llvm::Value * getScalarField(llvm::Value * self, std::string fieldName);
87   
88    // Set the value of a scalar field for a given instance.
89    void setScalarField(llvm::Value * self, std::string fieldName, llvm::Value * newFieldVal);
90   
91    // Get a parameter by name.
92    llvm::Value * getParameter(llvm::Function * f, std::string paramName);
93   
94    // Stream set helpers.
95    unsigned getStreamSetIndex(std::string ssName);
96   
97    llvm::Value * getStreamSetBasePtr(Value * self, std::string ssName);
98    size_t getStreamSetBufferSize(Value * self, std::string ssName);
99
100    llvm::Value * getStreamSetBlockPtr(Value * self, std::string ssName, Value * blockNo);
101
102       
103protected:
104
105    std::vector<llvm::Type *>  mKernelFields;
106    NameMap                    mInternalStateNameMap;
107    NameMap                    mStreamSetNameMap;
108    std::vector<StreamSetBuffer *> mStreamSetInputBuffers;
109    std::vector<StreamSetBuffer *> mStreamSetOutputBuffers;
110
111};
112}
113#endif
Note: See TracBrowser for help on using the repository browser.