data_flow_node.h

Go to the documentation of this file.

 
#pragma once
 
#include <boost/lexical_cast.hpp>
#include <nlohmann/json.hpp>
 
#include "sdfg/element.h"
#include "sdfg/graph/graph.h"
 
using json = nlohmann::json;
 
namespace sdfg {
 
namespace builder {
class SDFGBuilder;
class StructuredSDFGBuilder;
} // namespace builder
 
namespace data_flow {
 
enum class EdgeRemoveOption {
    NotRemovable,
    Trivially,
    RequiresUpdate,
    RemoveNodeAfter
};
 
class DataFlowGraph;
class Memlet;

class DataFlowNode : public Element {
    friend class sdfg::builder::SDFGBuilder;
    friend class sdfg::builder::StructuredSDFGBuilder;
 
private:
    // Remark: Exclusive resource
    graph::Vertex vertex_; 
 
    DataFlowGraph* parent_; 
 
protected:
    DataFlowNode(size_t element_id, const DebugInfo& debug_info, const graph::Vertex vertex, DataFlowGraph& parent);
 
public:
    static constexpr ElementType TypeGroup = ElementType::AccessNode | ElementType::ConstantNode |
                                             ElementType::Tasklet | ElementType::LibraryNode;

    static bool classof(const Element& element) {
        return is_a(element.type_id(), TypeGroup);
    }
 
    // Remark: Exclusive resource
    DataFlowNode(const DataFlowNode& data_node) = delete;
    DataFlowNode& operator=(const DataFlowNode&) = delete;

    [[nodiscard]] virtual bool side_effect() const = 0;

    graph::Vertex vertex() const;

    const DataFlowGraph& get_parent() const;

    DataFlowGraph& get_parent();

    virtual std::unique_ptr<DataFlowNode>
    clone(size_t element_id, const graph::Vertex vertex, DataFlowGraph& parent) const = 0;

    virtual EdgeRemoveOption can_remove_out_edge(const data_flow::DataFlowGraph& graph, const Memlet* memlet) const = 0;
 
    virtual EdgeRemoveOption can_remove_in_edge(const data_flow::DataFlowGraph& graph, const Memlet* memlet) const = 0;

    virtual bool update_edge_removed(const std::string& out_conn) {
        return false;
    }
};
} // namespace data_flow
} // namespace sdfg