#include <meta_live_range.h>

Inheritance diagram for MetadataLiveRange:

Public Types
enum	access_t { READ = 1 , WRITE = 2 }
	Type of access in a unit. OR these together for a Read/Write access (RW=3).

Public Types inherited from P4::Visitor
typedef Visitor_Context	Context

Public Member Functions
	MetadataLiveRange (PhvInfo &p, const DependencyGraph &g, FieldDefUse &f, const PHV::Pragmas &pragmas, const PhvUse &u, const MauBacktracker &)

const ordered_map< int, std::pair< int, int > > &	getMetadataLiveMap () const

const ordered_map< int, std::pair< int, int > > &	getMetadataLiveMapUsage () const

const ordered_map< int, ordered_set< const IR::MAU::Table * > > &	getMinStageMap () const

const ordered_set< const IR::MAU::Table * >	getTablesInStage (int stage) const

bool	hasPotentialLiveRangeOverlay (const PHV::Field f1, const PHV::Field f2) const

Public Member Functions inherited from P4::Inspector
const IR::Node *	apply_visitor (const IR::Node , const char name=0) override

profile_t	init_apply (const IR::Node *root) override

virtual void	loop_revisit (const IR::Node *)

virtual void	postorder (const IR::Node *)

virtual bool	preorder (const IR::Node *)

virtual void	revisit (const IR::Node *)

void	revisit_visited ()

bool	visit_in_progress (const IR::Node *n) const

void	visitAgain () const override

void	visitOnce () const override

Public Member Functions inherited from P4::Visitor
virtual bool	check_global (cstring)

virtual void	clear_globals ()

virtual Visitor *	clone () const

virtual ControlFlowVisitor *	controlFlowVisitor ()

virtual void	end_apply (const IR::Node *root)

virtual void	erase_global (cstring)

template<class T >
const T *	findContext () const

template<class T >
const T *	findContext (const Context *&c) const

template<class T >
const T *	findOrigCtxt () const

template<class T >
const T *	findOrigCtxt (const Context *&c) const

virtual Visitor &	flow_clone ()

virtual void	flow_merge (Visitor &)

virtual bool	flow_merge_closure (Visitor &)

virtual void	flow_merge_global_from (cstring)

virtual void	flow_merge_global_to (cstring)

const Context *	getChildContext () const

int	getChildrenVisited () const

const Context *	getContext () const

int	getContextDepth () const

const IR::Node *	getCurrentNode () const

template<class T >
const T *	getCurrentNode () const

const IR::Node *	getOriginal () const

template<class T >
const T *	getOriginal () const

template<class T >
const T *	getParent () const

virtual bool	has_flow_joins () const

profile_t	init_apply (const IR::Node root, const Context parent_context)

bool	isInContext (const IR::Node *n) const

virtual const char *	name () const

template<class T >
void	parallel_visit (const IR::Vector< T > &v, const char *name, int cidx)

template<class T >
void	parallel_visit (const IR::Vector< T > &v, const char *name=0)

template<class T >
void	parallel_visit (IR::Vector< T > &v, const char *name, int cidx)

template<class T >
void	parallel_visit (IR::Vector< T > &v, const char *name=0)

void	print_context () const

const Visitor &	setCalledBy (const Visitor *visitor)

void	setName (const char *name)

void	visit (const IR::Node &n, const char *name, int cidx)

void	visit (const IR::Node &n, const char *name=0)

void	visit (const IR::Node &n, const char name, int cidx)

void	visit (const IR::Node &n, const char name=0)

void	visit (const IR::Node const &n, const char name, int cidx)

void	visit (const IR::Node const &n, const char name=0)

void	visit (IR::Node &n, const char *name, int cidx)

void	visit (IR::Node &n, const char *name=0)

void	visit (IR::Node &, const char =0, int=0)

template<class T , typename = std::enable_if_t<Util::has_SourceInfo_v<T> && !std::is_pointer_v<T>>, class... Args>
void	warn (const int kind, const char *format, const T &node, Args &&...args)
	The const ref variant of the above.

template<class T , typename = std::enable_if_t<Util::has_SourceInfo_v<T>>, class... Args>
void	warn (const int kind, const char format, const T node, Args &&...args)

bool	warning_enabled (int warning_kind) const

Static Public Member Functions
static bool	notOverlapping (int minStage1, int maxStage1, int minStage2, int maxStage2, int depDist=DEP_DIST)

static bool	notOverlapping (std::pair< int, int > &range1, std::pair< int, int > &range2, int depDist=DEP_DIST)

static cstring	printAccess (int access)

Static Public Member Functions inherited from P4::Visitor
static cstring	demangle (const char *)

static bool	warning_enabled (const Visitor *visitor, int warning_kind)

Static Public Attributes
static constexpr int	DEP_DIST = 2

static constexpr char const *	EGRESS_PARSER_ENTRY = "$entry_point.$egress_tna_entry_point"

static constexpr char const *	INGRESS_PARSER_ENTRY = "$entry_point.$ingress_tna_entry_point"

static const ordered_set< cstring >	noInitIntrinsicFields
	Set of intrinsic metadata fields that must not be initialized.

Additional Inherited Members
Public Attributes inherited from P4::Visitor
const Visitor *	called_by = nullptr

cstring	internalName

SplitFlowVisit_base *&	split_link

SplitFlowVisit_base *	split_link_mem = nullptr

Protected Member Functions inherited from P4::Visitor
virtual void	init_join_flows (const IR::Node *)

virtual bool	join_flows (const IR::Node *)

virtual void	post_join_flows (const IR::Node , const IR::Node )

void	visit_children (const IR::Node *, std::function< void()> fn)

Protected Attributes inherited from P4::Visitor
bool	dontForwardChildrenBeforePreorder = false

bool	joinFlows = false

bool	visitDagOnce = true

Detailed Description

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

SPDX-License-Identifier: Apache-2.0 This class calculates the live range of metadata fields (as well as other fields whose live ranges are affected by programmer specified pragmas). The calculated live ranges use the min_stage value for tables determined using the table dependency graph.

This pass will be a producer for a future LiveRangeShrinking class which will use these calculated live ranges to speculatively shrink the live ranges for metadata fields and initialize those fields accordingly, thereby creating considerably more opportunities for metadata fields sharing PHVs.

Member Function Documentation

◆ getMetadataLiveMap()

const ordered_map< int, std::pair< int, int > > & MetadataLiveRange::getMetadataLiveMap ( ) const

inline

Returns: the live ranges of all metadata fields: key is field ID and the value is the live range pair [minStage, maxStage], where parser = -1 and deparser = Device::numStages().

◆ getMetadataLiveMapUsage()

const ordered_map< int, std::pair< int, int > > & MetadataLiveRange::getMetadataLiveMapUsage ( ) const

inline

Returns: the usages of the min and max stage for all metadata fields: key is field ID and the value is the access_t pair [access in minStage, access in maxStage].

◆ getMinStageMap()

const ordered_map< int, ordered_set< const IR::MAU::Table * > > & MetadataLiveRange::getMinStageMap ( ) const

inline

Returns: a map of stage to the set of tables whose min_stage is the key stage.

◆ getTablesInStage()

const ordered_set< const IR::MAU::Table * > MetadataLiveRange::getTablesInStage ( int stage ) const

inline

Returns: the set of tables that have min_stage equal to stage.

◆ hasPotentialLiveRangeOverlay()

bool MetadataLiveRange::hasPotentialLiveRangeOverlay	(	const PHV::Field *	f1,
		const PHV::Field *	f2 ) const

inline

Returns: true if fields f1 and f2 are found to be potentially overlayable because of their live ranges.

◆ notOverlapping() [1/2]

bool MetadataLiveRange::notOverlapping	(	int	minStage1,
		int	maxStage1,
		int	minStage2,
		int	maxStage2,
		int	depDist = DEP_DIST )

static

Returns: true if the live ranges indicated by [minStage1, maxStage1] and [minStage2, maxStage2] are not-overlapping with clearance of at least depDist stages.

◆ notOverlapping() [2/2]

bool MetadataLiveRange::notOverlapping	(	std::pair< int, int > &	range1,
		std::pair< int, int > &	range2,
		int	depDist = DEP_DIST )

static

Returns: true if the live ranges indicated by range1 range2 are not-overlapping with clearance of at least depDist stages.

◆ printAccess()

cstring MetadataLiveRange::printAccess ( int access )

static

Returns: a string representation of an access value.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

SPDX-License-Identifier: Apache-2.0

Member Data Documentation

◆ EGRESS_PARSER_ENTRY

char const* MetadataLiveRange::EGRESS_PARSER_ENTRY = "$entry_point.$egress_tna_entry_point"

staticconstexpr

Name of the egress parser state, where the compiler adds all the implicit initializations for fields with uninitialized reads.

◆ INGRESS_PARSER_ENTRY

char const* MetadataLiveRange::INGRESS_PARSER_ENTRY = "$entry_point.$ingress_tna_entry_point"

staticconstexpr

Name of the ingress parser state, where the compiler adds all the implicit initializations for fields with uninitialized reads.

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getMetadataLiveMap()

◆ getMetadataLiveMapUsage()

◆ getMinStageMap()

◆ getTablesInStage()

◆ hasPotentialLiveRangeOverlay()

◆ notOverlapping() [1/2]

◆ notOverlapping() [2/2]

◆ printAccess()

Member Data Documentation

◆ EGRESS_PARSER_ENTRY

◆ INGRESS_PARSER_ENTRY