locality.h

Go to the documentation of this file.

#pragma once
 
#include <optional>
#include <utility>
#include <vector>
 
#include "sdfg/analysis/analysis.h"
#include "sdfg/structured_control_flow/structured_loop.h"
#include "sdfg/tiles/tile.h"
 
namespace sdfg {
namespace tiles {

class LocalityPlan {
    std::vector<TileAxis> axes_; 
    bool loop_is_outermost_ = false; 
    bool loop_has_scratchpad_ = false; 
    bool has_scratchpad_descendant_ = false; 
    bool enclosing_cooperative_ = false;
 
public:
    LocalityPlan() = default; // an empty plan; fill via analyze()

    LocalityPlan(
        std::vector<TileAxis> axes,
        bool loop_is_outermost = false,
        bool loop_has_scratchpad = false,
        bool has_scratchpad_descendant = false,
        bool enclosing_cooperative = false
    )
        : axes_(std::move(axes)), loop_is_outermost_(loop_is_outermost), loop_has_scratchpad_(loop_has_scratchpad),
          has_scratchpad_descendant_(has_scratchpad_descendant), enclosing_cooperative_(enclosing_cooperative) {
    }

    static LocalityPlan analyze(
        structured_control_flow::StructuredLoop& loop,
        const std::vector<TileAxis>& axes,
        analysis::AnalysisManager& analysis_manager
    );
 
    const std::vector<TileAxis>& axes() const {
        return axes_;
    }
    bool loop_is_outermost() const {
        return loop_is_outermost_;
    }
    bool loop_has_scratchpad() const {
        return loop_has_scratchpad_;
    }
    bool has_scratchpad_descendant() const {
        return has_scratchpad_descendant_;
    }
    bool enclosing_cooperative() const {
        return enclosing_cooperative_;
    }

    bool inside_scratchpad_scope() const;
    bool has_scratchpad_cooperative() const;
    bool has_cooperative_at(Level level) const;
    bool has_global_cooperative() const;
    std::vector<TileAxis> private_axes() const;
    std::vector<TileAxis> cooperative_axes() const;

    std::optional<Space> required_space(bool container_written) const;
};

structured_control_flow::StructuredLoop* find_block_scheduled_descendant(
    structured_control_flow::StructuredLoop& loop, analysis::AnalysisManager& analysis_manager
);
 
} // namespace tiles
} // namespace sdfg