P4C
The P4 Compiler
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | List of all members
PragmaMutuallyExclusive Class Reference

#include <pa_mutually_exclusive.h>

Inheritance diagram for PragmaMutuallyExclusive:
[legend]

Public Member Functions

 PragmaMutuallyExclusive (const PhvInfo &phv)
 
const ordered_map< const PHV::Field *, ordered_set< const PHV::Field * > > & mutex_fields () const
 
const ordered_map< cstring, ordered_set< cstring > > & mutex_headers () 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 ()
 
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 Attributes

static const char * description
 
static const char * help
 
static const char * name = "pa_mutually_exclusive"
 BFN::Pragma interface.
 

Additional Inherited Members

- Public Types inherited from P4::Visitor
typedef Visitor_Context Context
 
- Static Public Member Functions inherited from P4::Visitor
static cstring demangle (const char *)
 
static bool warning_enabled (const Visitor *visitor, int warning_kind)
 
- 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

pa_mutually_exclusive pragma support.

This pass will gather all pa_mutually_exclusive pragmas and generate pa_mutually_exclusive_i: mapping from a field to the set of fields it is mutually exclusive with.

Member Data Documentation

◆ description

const char * PragmaMutuallyExclusive::description
static
Initial value:
=
"Specifies that the two fields/headers are mutually exclusive with each other."

◆ help

const char * PragmaMutuallyExclusive::help
static
Initial value:
=
"@pragma pa_mutually_exclusive [pipe] gress inst_1.node_1 inst_2.node_2\n"
"+ attached to P4 header instances\n"
"\n"
"Specifies that the two indicated nodes which may be either single "
"fields or headers can be considered mutually exclusive of one "
"another. In the case of header nodes, the exclusivity applies to "
"the fields of the header. "
"PHV allocation uses field exclusivity to optimize container usage "
"by overlaying mutually exclusive fields in the same container. "
"This pragma does not guarantee that the mutually exclusive fields "
"will occupy the same container. It gives the compiler the "
"option to do so. The gress value can be either ingress or egress. "
"If the optional pipe value is provided, the pragma is applied only "
"to the corresponding pipeline. If not provided, it is applied to "
"all pipelines."

◆ name

const char * PragmaMutuallyExclusive::name = "pa_mutually_exclusive"
static

BFN::Pragma interface.

Copyright (C) 2024 Intel Corporation

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