P4C
The P4 Compiler
Loading...
Searching...
No Matches
PHV::Pragmas Class Reference
Inheritance diagram for PHV::Pragmas:
[legend]

Public Member Functions

 Pragmas (PhvInfo &phv)
 
 Pragmas (PhvInfo &phv, const ordered_map< cstring, std::vector< PHV::Size > > &container_size_constr, const ordered_map< cstring, ordered_set< cstring > > &no_pack_constr)
 
PragmaAtomicpa_atomic ()
 
const PragmaAtomicpa_atomic () const
 
PragmaBytePackpa_byte_pack ()
 
const PragmaBytePackpa_byte_pack () const
 
PragmaContainerSizepa_container_sizes ()
 
const PragmaContainerSizepa_container_sizes () const
 
PragmaContainerTypepa_container_type ()
 
const PragmaContainerTypepa_container_type () const
 
PragmaDeparserZeropa_deparser_zero ()
 
const PragmaDeparserZeropa_deparser_zero () const
 
PragmaMutuallyExclusivepa_mutually_exclusive ()
 
const PragmaMutuallyExclusivepa_mutually_exclusive () const
 
PragmaNoInitpa_no_init ()
 
const PragmaNoInitpa_no_init () const
 
PragmaNoOverlaypa_no_overlay ()
 
const PragmaNoOverlaypa_no_overlay () const
 
PragmaNoPackpa_no_pack ()
 
const PragmaNoPackpa_no_pack () const
 
PragmaSolitarypa_solitary ()
 
const PragmaSolitarypa_solitary () const
 
- Public Member Functions inherited from P4::PassManager
 PassManager (const PassManager &)=default
 
 PassManager (const std::initializer_list< VisitorRef > &init)
 
 PassManager (PassManager &&)=default
 
void addDebugHook (DebugHook h, bool recursive=false)
 
void addDebugHooks (std::vector< DebugHook > hooks, bool recursive=false)
 
void addPasses (const std::initializer_list< VisitorRef > &init)
 
const IR::Nodeapply_visitor (const IR::Node *, const char *=0) override
 
bool backtrack (trigger &trig) override
 
PassManagerclone () const override
 
void early_exit ()
 
void listPasses (std::ostream &, cstring sep) const
 
bool never_backtracks () override
 
void removePasses (const std::vector< cstring > &exclude)
 
void setStopOnError (bool stop)
 
- Public Member Functions inherited from P4::Visitor
virtual bool check_clone (const Visitor *a)
 
virtual bool check_global (cstring)
 
virtual void clear_globals ()
 
virtual ControlFlowVisitorcontrolFlowVisitor ()
 
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 Visitorflow_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 ContextgetChildContext () const
 
int getChildrenVisited () const
 
const ContextgetContext () const
 
int getContextDepth () const
 
const IR::NodegetCurrentNode () const
 
template<class T >
const T * getCurrentNode () const
 
const IR::NodegetOriginal () 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 VisitorsetCalledBy (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
 
- Public Member Functions inherited from P4::Backtrack

Static Public Member Functions

static bool checkNumberArgs (const IR::Annotation *annotation, unsigned required_args, const unsigned min_required_args, bool exact_number_of_args, cstring pragma_name, cstring pragma_args_wo_pipe)
 
static bool checkPipeApplication (const IR::Annotation *annotation, const IR::BFN::Pipe *pipe, const IR::StringLiteral *pipe_arg)
 
static bool checkStringLiteralArgs (const IR::Vector< IR::Expression > &exprs)
 
static bool determinePipeGressArgs (const IR::Vector< IR::Expression > &exprs, unsigned &expr_index, unsigned &required_args, const IR::StringLiteral *&pipe_arg, const IR::StringLiteral *&gress_arg)
 
static bool gressValid (cstring gress)
 
static void reportNoMatchingPHV (const IR::BFN::Pipe *pipe, const IR::Expression *expr, cstring field_name=""_cs)
 
- Static Public Member Functions inherited from P4::Visitor
static cstring demangle (const char *)
 
static bool warning_enabled (const Visitor *visitor, int warning_kind)
 

Additional Inherited Members

- Public Types inherited from P4::Visitor
typedef Visitor_Context Context
 
- Public Attributes inherited from P4::Visitor
const Visitorcalled_by = nullptr
 
cstring internalName
 
SplitFlowVisit_base *& split_link
 
SplitFlowVisit_basesplit_link_mem = nullptr
 
- Protected Member Functions inherited from P4::PassManager
profile_t init_apply (const IR::Node *root) override
 
void runDebugHooks (const char *visitorName, const IR::Node *node)
 
- 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)
 
virtual void visitAgain () const
 
virtual void visitOnce () const
 
- Protected Attributes inherited from P4::PassManager
safe_vector< DebugHookdebugHooks
 
safe_vector< Visitor * > passes
 
bool running = false
 
unsigned seqNo = 0
 
bool stop_on_error = true
 
- Protected Attributes inherited from P4::Visitor
bool dontForwardChildrenBeforePreorder = false
 
bool joinFlows = false
 
bool visitDagOnce = true
 

Member Function Documentation

◆ checkNumberArgs()

bool PHV::Pragmas::checkNumberArgs ( const IR::Annotation * annotation,
unsigned required_args,
const unsigned min_required_args,
bool exact_number_of_args,
cstring pragma_name,
cstring pragma_args_wo_pipe )
static

Check if the number of arguments is suitable for the specified pragma.

Parameters
[in]annotationAnnotation IR
[in]required_argsNumber of required arguments
[in]min_required_argsMinimal number of required arguments
[in]exact_number_of_argsNumber of required arguments is exact or minimal
[in]pragma_namePragma name
[in]pragma_args_wo_pipeArguments of the pragma excluding pipe argument
Returns
Returns true if suitable number of arguments is passed, false otherwise.

◆ checkPipeApplication()

bool PHV::Pragmas::checkPipeApplication ( const IR::Annotation * annotation,
const IR::BFN::Pipe * pipe,
const IR::StringLiteral * pipe_arg )
static

Check whether the pragma should be applied in the specified pipe.

Parameters
[in]annotationPragma
[in]pipePipe IR argument
[in]pipe_argPipe argument delivered in the pragma
Returns
Returns true if the pragma should be applied in the specified pipe, false otherwise.

◆ checkStringLiteralArgs()

bool PHV::Pragmas::checkStringLiteralArgs ( const IR::Vector< IR::Expression > & exprs)
static

Check if all arguments of the pragma are string literals.

Parameters
[in]exprsList of expressions
Returns
true if all arguments of the pragma are string literals, false otherwise.

◆ determinePipeGressArgs()

bool PHV::Pragmas::determinePipeGressArgs ( const IR::Vector< IR::Expression > & exprs,
unsigned & expr_index,
unsigned & required_args,
const IR::StringLiteral *& pipe_arg,
const IR::StringLiteral *& gress_arg )
static

Check if valid combination of pipe and gress arguments is passed.

Parameters
[in]exprsList of expressions
[in,out]expr_indexIndex of the first argument that is not pipe or gress
[in,out]required_argsMinimal number of arguments without the pipe argument
[out]pipe_argPointer to the pipe argument
[out]gress_argPointer to the gress argument
Returns
true if valid combination of pipe and gress arguments is found, false otherwise.

◆ gressValid()

bool PHV::Pragmas::gressValid ( cstring gress)
static

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

Returns
true if for the associated @pragmaName, the gress is either ingress or egress.

◆ reportNoMatchingPHV()

void PHV::Pragmas::reportNoMatchingPHV ( const IR::BFN::Pipe * pipe,
const IR::Expression * expr,
cstring field_name = ""_cs )
static

Report no matching PHV field.

Parameters
[in]pipePipe IR. If null, pipe name is not shown.
[in]exprExpression IR with source info.
[in]field_nameIf expr is null, use this argument as the field name.