phv_analysis.h

 
#ifndef BACKENDS_TOFINO_BF_P4C_PHV_PHV_ANALYSIS_H_
#define BACKENDS_TOFINO_BF_P4C_PHV_PHV_ANALYSIS_H_
 
#include "backends/tofino/bf-p4c/bf-p4c-options.h"
#include "backends/tofino/bf-p4c/common/field_defuse.h"
#include "backends/tofino/bf-p4c/common/map_tables_to_actions.h"
#include "backends/tofino/bf-p4c/logging/pass_manager.h"
#include "backends/tofino/bf-p4c/logging/phv_logging.h"
#include "backends/tofino/bf-p4c/mau/action_mutex.h"
#include "backends/tofino/bf-p4c/mau/table_dependency_graph.h"
#include "backends/tofino/bf-p4c/mau/table_flow_graph.h"
#include "backends/tofino/bf-p4c/mau/table_mutex.h"
#include "backends/tofino/bf-p4c/parde/clot/clot_info.h"
#include "backends/tofino/bf-p4c/parde/decaf.h"
#include "backends/tofino/bf-p4c/phv/action_phv_constraints.h"
#include "backends/tofino/bf-p4c/phv/action_source_tracker.h"
#include "backends/tofino/bf-p4c/phv/allocate_phv.h"
#include "backends/tofino/bf-p4c/phv/analysis/critical_path_clusters.h"
#include "backends/tofino/bf-p4c/phv/analysis/dark_live_range.h"
#include "backends/tofino/bf-p4c/phv/analysis/dominator_tree.h"
#include "backends/tofino/bf-p4c/phv/analysis/live_range_shrinking.h"
#include "backends/tofino/bf-p4c/phv/analysis/meta_live_range.h"
#include "backends/tofino/bf-p4c/phv/analysis/non_mocha_dark_fields.h"
#include "backends/tofino/bf-p4c/phv/analysis/pack_conflicts.h"
#include "backends/tofino/bf-p4c/phv/analysis/parser_critical_path.h"
#include "backends/tofino/bf-p4c/phv/collect_strided_headers.h"
#include "backends/tofino/bf-p4c/phv/collect_table_keys.h"
#include "backends/tofino/bf-p4c/phv/fieldslice_live_range.h"
#include "backends/tofino/bf-p4c/phv/make_clusters.h"
#include "backends/tofino/bf-p4c/phv/mau_backtracker.h"
#include "backends/tofino/bf-p4c/phv/phv_parde_mau_use.h"
#include "backends/tofino/bf-p4c/phv/pragma/phv_pragmas.h"
#include "backends/tofino/bf-p4c/phv/utils/tables_to_ids.h"
#include "backends/tofino/bf-p4c/phv/v2/phv_kit.h"
#include "backends/tofino/bf-p4c/phv/v2/table_replay_friendly_constraints.h"
 
void applyGlobalPragmas(const PhvSpec &phvspec,
                        const std::vector<const IR::Annotation *> &global_pragmas);

class PHV_AnalysisPass : public Logging::PassManager {
 private:
    PhvInfo &phv_i;
    PhvUse &uses_i;
    const ClotInfo &clot_i;
    FieldDefUse &defuse_i;
    DependencyGraph &deps_i;
    const BFN_Options &options_i;
    MauBacktracker &table_alloc;
    // alt-phv-alloc ONLY
    // collect information about which field is allocated to what containers at the end of
    // phv analysis
    PHV::v2::CollectPHVAllocationResult phv_allocation_result;
    // alt-phv-alloc ONLY
    // Based on the feedback from table summary after table replay failed, it adds phv container
    // size constraints so that table replay can progress.
    PHV::v2::TableReplayFriendlyPhvConstraints table_replay_phv_constr;
    PHV::Pragmas pragmas;
    MapFieldToParserStates field_to_parser_states;
    CalcParserCriticalPath parser_critical_path;
    CalcCriticalPathClusters critical_path_clusters;
    TablesMutuallyExclusive table_mutex;
    ActionMutuallyExclusive action_mutex;
    PackConflicts pack_conflicts;
    ActionPhvConstraints action_constraints;
    ordered_map<gress_t, FlowGraph> flowGraph;
    BuildDominatorTree domTree;
    MapTablesToActions tableActionsMap;
    MetadataLiveRange meta_live_range;
    // Gets fields that are not mocha and/or dark compatible.
    NonMochaDarkFields non_mocha_dark;
    DarkOverlay dark_live_range;
    LiveRangeShrinking meta_init;
    Clustering clustering;
    MapTablesToIDs table_ids;
    CollectStridedHeaders strided_headers;
    CollectParserInfo parser_info;
    // table key properties.
    PHV::CollectTableKeys tb_keys;
    // physical live ranges of field slices.
    PHV::FieldSliceLiveRangeDB physical_liverange_db;
    // sources of any field slices classified by actions.
    PHV::ActionSourceTracker source_tracker;
    // allocation settings.
    PHV::AllocSetting settings;
    // Collect field packing that table/ixbar would benefit from.
    TableFieldPackOptimization tablePackOpt;
 
    // a collection class of above passe.
    PHV::AllocUtils utils;
 
    // Similar as AllocUtils but only used by v2::allocator.
    PHV::v2::PhvKit kit;
 
    AllocatePHV allocate_phv;
    std::list<const PHV::SuperCluster *> unallocated;
 
 public:
    PHV_AnalysisPass(const BFN_Options &options, PhvInfo &phv, PhvUse &uses, const ClotInfo &clot,
                     FieldDefUse &defuse, DependencyGraph &deps, const DeparserCopyOpt &decaf,
                     MauBacktracker &alloc, CollectPhvLoggingInfo *phvLoggingInfo,
                     std::set<PHV::FieldRange> &mauInitFields, const TableSummary &table_summary);
 
    Visitor *make_incremental_alloc_pass(const ordered_set<PHV::Field *> &temp_vars);
 
    void set_trivial_alloc(bool enable) { settings.trivial_alloc = enable; }
    void set_no_code_change(bool enable) { settings.no_code_change = enable; }
    void set_physical_liverange_overlay(bool enable) {
        settings.physical_liverange_overlay = enable;
    }
    void set_physical_stage_trivial(bool enable) { settings.physical_stage_trivial = enable; }
    const bool &get_limit_tmp_creation() { return settings.limit_tmp_creation; }
    const PHV::Pragmas &get_pragmas() { return pragmas; }
    void end_apply() override;
};
 
#endif /* BACKENDS_TOFINO_BF_P4C_PHV_PHV_ANALYSIS_H_ */