phv_kit.h

 
#ifndef BF_P4C_PHV_V2_PHV_KIT_H_
#define BF_P4C_PHV_V2_PHV_KIT_H_
 
#include "backends/tofino/bf-p4c/common/field_defuse.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/phv/action_phv_constraints.h"
#include "backends/tofino/bf-p4c/phv/action_source_tracker.h"
#include "backends/tofino/bf-p4c/phv/alloc_setting.h"
#include "backends/tofino/bf-p4c/phv/analysis/critical_path_clusters.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/phv.h"
#include "backends/tofino/bf-p4c/phv/phv_fields.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/slicing/types.h"
#include "backends/tofino/bf-p4c/phv/v2/action_packing_validator.h"
#include "backends/tofino/bf-p4c/phv/v2/parser_packing_validator.h"
 
namespace PHV {
namespace v2 {
 
struct PhvKit {
    // PHV fields and clot info.
    const PhvInfo &phv;
    const ClotInfo &clot;
 
    // clustering results (super clusters) and no_pack constraint found during clustering.
    const Clustering &clustering;
 
    // defuses and action constraints.
    const PhvUse &uses;
    const FieldDefUse &defuse;
 
    // action-related constraints
    const ActionPhvConstraints &actions;
    const ActionSourceTracker &source_tracker;
    const CollectTableKeys &tb_keys;
    const TablesMutuallyExclusive &table_mutex;
    const DependencyGraph &deps;
 
    // packing validator that checks whether a set of packing is valid
    // in terms of action phv constraints.
    const ActionPackingValidator *packing_validator;
 
    // Set of fieldSlice's that require explicit initialization in MAU
    // (selected during trivial allocation in alt-phv-alloc flow)
    std::set<PHV::FieldRange> &mauInitFields;
 
    const ParserPackingValidator *parser_packing_validator;
 
    // parser-related
    const MapFieldToParserStates &field_to_parser_states;
    const CalcParserCriticalPath &parser_critical_path;
    const CollectParserInfo &parser_info;
    const CollectStridedHeaders &strided_headers;
 
    // physical live range (available only after table has been allocated)
    const PHV::FieldSliceLiveRangeDB &physical_liverange_db;
 
    // pragma
    const PHV::Pragmas &pragmas;
 
    // misc allocation settings.
    const AllocSetting &settings;
 
    // provide access to information of last round of table placement.
    const MauBacktracker &mau;
 
    PhvKit(const PhvInfo &phv, const ClotInfo &clot, const Clustering &clustering,
           const PhvUse &uses, const FieldDefUse &defuse, const ActionPhvConstraints &actions,
           const MapFieldToParserStates &field_to_parser_states,
           const CalcParserCriticalPath &parser_critical_path, const CollectParserInfo &parser_info,
           const CollectStridedHeaders &strided_headers,
           const FieldSliceLiveRangeDB &physical_liverange_db,
           const ActionSourceTracker &source_tracker, const CollectTableKeys &tb_keys,
           const TablesMutuallyExclusive &table_mutex, const DependencyGraph &deps,
           std::set<PHV::FieldRange> &mauInitFields, const Pragmas &pragmas,
           const AllocSetting &settings, const MauBacktracker &mau)
        : phv(phv),
          clot(clot),
          clustering(clustering),
          uses(uses),
          defuse(defuse),
          actions(actions),
          source_tracker(source_tracker),
          tb_keys(tb_keys),
          table_mutex(table_mutex),
          deps(deps),
          packing_validator(new ActionPackingValidator(source_tracker, uses)),
          mauInitFields(mauInitFields),
          parser_packing_validator(new ParserPackingValidator(phv, field_to_parser_states,
                                                              parser_info, defuse,
                                                              pragmas.pa_no_init(), mauInitFields)),
          field_to_parser_states(field_to_parser_states),
          parser_critical_path(parser_critical_path),
          parser_info(parser_info),
          strided_headers(strided_headers),
          physical_liverange_db(physical_liverange_db),
          pragmas(pragmas),
          settings(settings),
          mau(mau) {}
 
    const SymBitMatrix &mutex() const { return phv.field_mutex(); }
 
    // has_pack_conflict should be used as the only source of pack conflict checks.
    // It checks mutex + pack conflict from mau + no pack constraint from cluster.
    bool has_pack_conflict(const PHV::FieldSlice &fs1, const PHV::FieldSlice &fs2) const;
 
    HasPackConflict get_has_pack_conflict() const {
        return [this](const PHV::FieldSlice &fs1, const PHV::FieldSlice &fs2) {
            return this->has_pack_conflict(fs1, fs2);
        };
    }
 
    // return true if field is used and not padding.
    bool is_referenced(const PHV::Field *f) const { return !f->padding && uses.is_referenced(f); };
 
    std::list<PHV::SuperCluster *> make_superclusters() const {
        return clustering.cluster_groups();
    }
 
    // @returns a slicing iterator.
    PHV::Slicing::IteratorInterface *make_slicing_ctx(const PHV::SuperCluster *sc) const;
 
    // @returns true if @p a and @p b can be overlaid,
    // because of their logical live ranges are disjoint and both fieldslices are
    // qualified to be overlaid. This is important that we don't have cross dependencies between
    // @p a and @p b if we need to redo table placement.
    bool can_logical_liverange_be_overlaid(const PHV::AllocSlice &a,
                                           const PHV::AllocSlice &b) const;
    // @returns true if @p a and @p b can be overlaid,
    // because of their physical live ranges are disjoint and both fieldslices are
    // qualified to be overlaid:
    // (1) not pov, deparsed_to_tm, nor is_invalidate_from_arch.
    // (2) not in pa_no_overlay.
    bool can_physical_liverange_be_overlaid(const PHV::AllocSlice &a,
                                            const PHV::AllocSlice &b) const;
 
    static bool is_clot_allocated(const ClotInfo &clots, const PHV::SuperCluster &sc);
 
    static std::list<PHV::ContainerGroup *> make_device_container_groups();
 
    static void clear_slices(PhvInfo &phv);
 
    static void bind_slices(const PHV::ConcreteAllocation &alloc, PhvInfo &phv);
 
    static void sort_and_merge_alloc_slices(PhvInfo &phv);
 
    static std::list<PHV::SuperCluster *> remove_singleton_metadata_slicelist(
        const std::list<PHV::SuperCluster *> &cluster_groups);
 
    static std::list<PHV::SuperCluster *> remove_unref_clusters(
        const PhvUse &uses, const std::list<PHV::SuperCluster *> &cluster_groups_input);
 
    static std::list<PHV::SuperCluster *> remove_clot_allocated_clusters(
        const ClotInfo &clot, std::list<PHV::SuperCluster *> clusters);
 
    static std::list<PHV::SuperCluster *> create_strided_clusters(
        const CollectStridedHeaders &strided_headers,
        const std::list<PHV::SuperCluster *> &cluster_groups);
 
    static bool is_ternary(const IR::MAU::Table *tbl);
};
 
}  // namespace v2
}  // namespace PHV
 
#endif /* BF_P4C_PHV_V2_PHV_KIT_H_ */