dpdkArch.h

/*
Copyright 2020 Intel Corp.
 
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.
*/
 
#ifndef BACKENDS_DPDK_DPDKARCH_H_
#define BACKENDS_DPDK_DPDKARCH_H_
 
#include "constants.h"
#include "dpdkProgramStructure.h"
#include "dpdkUtils.h"
#include "frontends/common/resolveReferences/resolveReferences.h"
#include "frontends/p4/evaluator/evaluator.h"
#include "frontends/p4/sideEffects.h"
#include "frontends/p4/typeMap.h"
#include "lib/error.h"
#include "lib/ordered_map.h"
#include "midend/flattenInterfaceStructs.h"
#include "midend/removeLeftSlices.h"
 
namespace P4::DPDK {
 
using namespace P4::literals;
 
cstring TypeStruct2Name(const cstring *s);
bool isSimpleExpression(const IR::Expression *e);
bool isNonConstantSimpleExpression(const IR::Expression *e);
void expressionUnrollSanityCheck(const IR::Expression *e);
 
using UserMeta = std::set<cstring>;
 
class CollectMetadataHeaderInfo;
 
/* According to the implementation of DPDK backend, for a control block, there
 * are only two parameters: header and metadata. Therefore, first we need to
 * rewrite the declaration of PSA architecture included in psa.p4 in order to
 * pass the type checking. In addition, this pass changes the definition of
 * P4Control and P4Parser(parameter list) in the P4 program provided by the
 * user.
 *
 * This pass also modifies all metadata references and header reference. For
 * metadata, struct_name.field_name -> m.struct_name_field_name. For header
 * headers.header_name.field_name -> h.header_name.field_name The parameter
 * named for header and metadata are also updated to "h" and "m" respectively.
 */
class ConvertToDpdkArch : public Transform {
    P4::ReferenceMap *refMap;
    DpdkProgramStructure *structure;
 
    const IR::Type_Control *rewriteControlType(const IR::Type_Control *, cstring);
    const IR::Type_Parser *rewriteParserType(const IR::Type_Parser *, cstring);
    const IR::Type_Control *rewriteDeparserType(const IR::Type_Control *, cstring);
    const IR::Node *postorder(IR::Type_Control *c) override;
    const IR::Node *postorder(IR::Type_Parser *p) override;
    const IR::Node *preorder(IR::Member *m) override;
    const IR::Node *preorder(IR::PathExpression *pe) override;
 
 public:
    ConvertToDpdkArch(P4::ReferenceMap *refMap, DpdkProgramStructure *structure)
        : refMap(refMap), structure(structure) {
        CHECK_NULL(structure);
    }
};
 
struct ConvertLookahead : public PassManager {
    class ReplacementMap {
        std::unordered_map<const IR::P4Program *, IR::IndexedVector<IR::Node>> newHeaderMap;
        std::unordered_map<const IR::P4Parser *, IR::IndexedVector<IR::Declaration>> newLocalVarMap;
        std::unordered_map<const IR::AssignmentStatement *, IR::IndexedVector<IR::StatOrDecl>>
            newStatMap;
 
     public:
        void insertHeader(const IR::P4Program *p, const IR::Type_Header *h) {
            if (newHeaderMap.count(p)) {
                newHeaderMap.at(p).push_back(h);
            } else {
                newHeaderMap.emplace(p, IR::IndexedVector<IR::Node>(h));
            }
            LOG5("Program: " << dbp(p));
            LOG2("Adding new header:" << std::endl << " " << h);
        }
        IR::IndexedVector<IR::Node> *getHeaders(const IR::P4Program *p) {
            if (newHeaderMap.count(p)) {
                return new IR::IndexedVector<IR::Node>(newHeaderMap.at(p));
            }
            return nullptr;
        }
        void insertVar(const IR::P4Parser *p, const IR::Declaration_Variable *v) {
            if (newLocalVarMap.count(p)) {
                newLocalVarMap.at(p).push_back(v);
            } else {
                newLocalVarMap.emplace(p, IR::IndexedVector<IR::Declaration>(v));
            }
            LOG5("Parser: " << dbp(p));
            LOG2("Adding new local variable:" << std::endl << " " << v);
        }
        IR::IndexedVector<IR::Declaration> *getVars(const IR::P4Parser *p) {
            if (newLocalVarMap.count(p)) {
                return new IR::IndexedVector<IR::Declaration>(newLocalVarMap.at(p));
            }
            return nullptr;
        }
        void insertStatements(const IR::AssignmentStatement *as,
                              IR::IndexedVector<IR::StatOrDecl> *vec) {
            BUG_CHECK(newStatMap.count(as) == 0,
                      "Unexpectedly converting statement %1% multiple times!", as);
            newStatMap.emplace(as, *vec);
            LOG5("AssignmentStatement: " << dbp(as));
            LOG2("Adding new statements:");
            for (auto s : *vec) {
                LOG2(" " << s);
            }
        }
        IR::IndexedVector<IR::StatOrDecl> *getStatements(const IR::AssignmentStatement *as) {
            if (newStatMap.count(as)) {
                return new IR::IndexedVector<IR::StatOrDecl>(newStatMap.at(as));
            }
            return nullptr;
        }
    };
 
    ReplacementMap repl;
 
    class Collect : public Inspector {
        P4::ReferenceMap *refMap;
        P4::TypeMap *typeMap;
        ReplacementMap *repl;
 
     public:
        Collect(P4::ReferenceMap *refMap, P4::TypeMap *typeMap, ReplacementMap *repl)
            : refMap(refMap), typeMap(typeMap), repl(repl) {}
        void postorder(const IR::AssignmentStatement *statement) override;
    };
 
    class Replace : public Transform {
        DpdkProgramStructure *structure;
        ReplacementMap *repl;
 
     public:
        Replace(DpdkProgramStructure *structure, ReplacementMap *repl)
            : structure(structure), repl(repl) {}
        const IR::Node *postorder(IR::AssignmentStatement *as) override;
        const IR::Node *postorder(IR::Type_Struct *s) override;
        const IR::Node *postorder(IR::P4Parser *parser) override;
    };
 
    ConvertLookahead(P4::ReferenceMap *refMap, P4::TypeMap *typeMap, DpdkProgramStructure *s) {
        passes.push_back(new P4::TypeChecking(refMap, typeMap));
        passes.push_back(new Collect(refMap, typeMap, &repl));
        passes.push_back(new Replace(s, &repl));
        passes.push_back(new P4::ClearTypeMap(typeMap));
    }
};
 
// This Pass collects infomation about the name of all metadata and header
// And it collects every field of metadata and renames all fields with a prefix
// according to the metadata struct name. Eventually, the reference of a fields
// will become m.$(struct_name)_$(field_name).
class CollectMetadataHeaderInfo : public Inspector {
    DpdkProgramStructure *structure;
 
    void pushMetadata(const IR::Parameter *p);
    void pushMetadata(const IR::ParameterList *, std::list<int> indices);
 
 public:
    explicit CollectMetadataHeaderInfo(DpdkProgramStructure *structure) : structure(structure) {}
    bool preorder(const IR::P4Program *p) override;
    bool preorder(const IR::Type_Struct *s) override;
};
 
// Previously, we have collected the information about how the single metadata
// struct looks like in CollectMetadataHeaderInfo. This pass finds a suitable
// place to inject this struct.
class InjectJumboStruct : public Transform {
    DpdkProgramStructure *structure;
 
 public:
    explicit InjectJumboStruct(DpdkProgramStructure *structure) : structure(structure) {}
    const IR::Node *preorder(IR::Type_Struct *s) override;
};
 
// This pass injects metadata field which is used as port for 'tx' instruction
// into the single metadata struct.
// This pass has to be applied after CollectMetadataHeaderInfo fills
// local_metadata_type field in DpdkProgramStructure which is passed to the constructor.
class InjectFixedMetadataField : public Transform {
    DpdkProgramStructure *structure;
 
 public:
    explicit InjectFixedMetadataField(DpdkProgramStructure *structure) : structure(structure) {}
    const IR::Node *preorder(IR::Type_Struct *s) override;
};
 
class AlignHdrMetaField : public Transform {
    DpdkProgramStructure *structure;
 
    ordered_map<cstring, struct fieldInfo> field_name_list;
 
 public:
    explicit AlignHdrMetaField(DpdkProgramStructure *structure) : structure(structure) {
        CHECK_NULL(structure);
    }
    const IR::Node *preorder(IR::Type_StructLike *st) override;
    const IR::Node *preorder(IR::Member *m) override;
};
 
struct ByteAlignment : public PassManager {
    P4::TypeMap *typeMap;
    P4::ReferenceMap *refMap;
    DpdkProgramStructure *structure;
 
 public:
    ByteAlignment(P4::TypeMap *typeMap, P4::ReferenceMap *refMap, DpdkProgramStructure *structure)
        : typeMap(typeMap), refMap(refMap), structure(structure) {
        CHECK_NULL(structure);
        passes.push_back(new AlignHdrMetaField(structure));
        passes.push_back(new P4::ClearTypeMap(typeMap));
        passes.push_back(new P4::TypeChecking(refMap, typeMap, true));
        /* DoRemoveLeftSlices pass converts the slice Member (LHS in assn stm)
           resulting from above Pass into shift operation */
        passes.push_back(new P4::DoRemoveLeftSlices(typeMap));
        passes.push_back(new P4::ClearTypeMap(typeMap));
        passes.push_back(new P4::TypeChecking(refMap, typeMap, true));
    }
};
 
class ReplaceHdrMetaField : public Transform {
 public:
    const IR::Node *postorder(IR::Type_Struct *st) override;
};
 
struct fieldInfo {
    unsigned fieldWidth;
    fieldInfo() { fieldWidth = 0; }
};
 
// This class is helpful for StatementUnroll and IfStatementUnroll. Since dpdk
// asm is not able to process complex expression, e.g., a = b + c * d. We need
// break it down. Therefore, we need some temporary variables to hold the
// intermediate values. And this class is helpful to inject the declarations of
// temporary value into P4Control and P4Parser.
class DeclarationInjector {
    std::map<const IR::Node *, IR::IndexedVector<IR::Declaration> *> decl_map;
 
 public:
    // push the declaration to the right code block.
    void collect(const IR::P4Control *control, const IR::P4Parser *parser,
                 const IR::Declaration *decl) {
        IR::IndexedVector<IR::Declaration> *decls = nullptr;
        if (parser) {
            auto res = decl_map.find(parser);
            if (res != decl_map.end()) {
                decls = res->second;
            } else {
                decls = new IR::IndexedVector<IR::Declaration>;
                decl_map.emplace(parser, decls);
            }
        } else if (control) {
            auto res = decl_map.find(control);
            if (res != decl_map.end()) {
                decls = res->second;
            } else {
                decls = new IR::IndexedVector<IR::Declaration>;
                decl_map.emplace(control, decls);
            }
        }
        BUG_CHECK(decls != nullptr, "decls cannot be null");
        decls->push_back(decl);
    }
    IR::Node *inject_control(const IR::Node *orig, IR::P4Control *control) {
        auto res = decl_map.find(orig);
        if (res == decl_map.end()) {
            return control;
        }
        control->controlLocals.prepend(*res->second);
        return control;
    }
    IR::Node *inject_parser(const IR::Node *orig, IR::P4Parser *parser) {
        auto res = decl_map.find(orig);
        if (res == decl_map.end()) {
            return parser;
        }
        parser->parserLocals.prepend(*res->second);
        return parser;
    }
};
 
/* This pass breaks complex expressions down, since dpdk asm cannot describe
 * complex expression. This pass is not complete. MethodCallStatement should be
 * unrolled as well. Note that IfStatement should not be unrolled here, as we
 * have a separate pass for it, because IfStatement does not want to unroll
 * logical expression(dpdk asm has conditional jmp for these cases)
 */
class StatementUnroll : public Transform {
 private:
    P4::ReferenceMap *refMap;
    DpdkProgramStructure *structure;
    DeclarationInjector injector;
 
 public:
    StatementUnroll(P4::ReferenceMap *refMap, DpdkProgramStructure *structure)
        : refMap(refMap), structure(structure) {}
    const IR::Node *preorder(IR::AssignmentStatement *a) override;
    const IR::Node *postorder(IR::P4Control *a) override;
    const IR::Node *postorder(IR::P4Parser *a) override;
};
 
/* This pass helps StatementUnroll to unroll expressions inside statements.
 * For example, if an AssignmentStatement looks like this: a = b + c * d
 * StatementUnroll's AssignmentStatement preorder will call ExpressionUnroll
 * twice for BinaryExpression's left(b) and right(c * d). For left, since it is
 * a simple expression, ExpressionUnroll will set root to PathExpression(b) and
 * the decl and stmt is empty. For right, ExpressionUnroll will set root to
 * PathExpression(tmp), decl contains tmp's declaration and stmt contains:
 * tmp = c * d, which will be injected in front of the AssignmentStatement.
 */
class ExpressionUnroll : public Inspector {
    P4::ReferenceMap *refMap;
 
 public:
    IR::IndexedVector<IR::StatOrDecl> stmt;
    IR::IndexedVector<IR::Declaration> decl;
    IR::PathExpression *root;
    ExpressionUnroll(P4::ReferenceMap *refMap, DpdkProgramStructure *) : refMap(refMap) {
        setName("ExpressionUnroll");
    }
    bool preorder(const IR::Operation_Unary *a) override;
    bool preorder(const IR::Operation_Binary *a) override;
    bool preorder(const IR::MethodCallExpression *a) override;
    bool preorder(const IR::Member *a) override;
    bool preorder(const IR::PathExpression *a) override;
    bool preorder(const IR::Constant *a) override;
    bool preorder(const IR::BoolLiteral *a) override;
};
 
// This pass is similiar to StatementUnroll pass, the difference is that this
// pass will call LogicalExpressionUnroll to unroll the expression, which treat
// logical expression differently.
class IfStatementUnroll : public Transform {
 private:
    P4::ReferenceMap *refMap;
    DeclarationInjector injector;
 
 public:
    explicit IfStatementUnroll(P4::ReferenceMap *refMap) : refMap(refMap) {
        setName("IfStatementUnroll");
    }
    const IR::Node *postorder(IR::SwitchStatement *a) override;
    const IR::Node *postorder(IR::IfStatement *a) override;
    const IR::Node *postorder(IR::P4Control *a) override;
    const IR::Node *postorder(IR::P4Parser *a) override;
};
 
/* Assume one logical expression looks like this: a && (b + c > d), this pass
 * will unroll the expression to {tmp = b + c; if(a && (tmp > d))}. Logical
 * calculation will be unroll in a dedicated pass.
 */
class LogicalExpressionUnroll : public Inspector {
    P4::ReferenceMap *refMap;
 
 public:
    IR::IndexedVector<IR::StatOrDecl> stmt;
    IR::IndexedVector<IR::Declaration> decl;
    IR::Expression *root;
    static bool is_logical(const IR::Operation_Binary *bin) {
        if (bin->is<IR::LAnd>() || bin->is<IR::LOr>() || bin->is<IR::Leq>() || bin->is<IR::Equ>() ||
            bin->is<IR::Neq>() || bin->is<IR::Grt>() || bin->is<IR::Lss>() || bin->is<IR::Geq>() ||
            bin->is<IR::Leq>())
            return true;
        else
            return false;
    }
 
    explicit LogicalExpressionUnroll(P4::ReferenceMap *refMap) : refMap(refMap) {
        visitDagOnce = false;
    }
    bool preorder(const IR::Operation_Unary *a) override;
    bool preorder(const IR::Operation_Binary *a) override;
    bool preorder(const IR::MethodCallExpression *a) override;
    bool preorder(const IR::Member *a) override;
    bool preorder(const IR::PathExpression *a) override;
    bool preorder(const IR::Constant *a) override;
    bool preorder(const IR::BoolLiteral *a) override;
};
 
// According to dpdk spec, Binary Operation will only have two parameters, which
// looks like: a = a + b. Therefore, this pass transform all AssignStatement
// that has Binary_Operation to become two-parameter form.
class ConvertBinaryOperationTo2Params : public Transform {
    DeclarationInjector injector;
    P4::ReferenceMap *refMap;
 
 public:
    explicit ConvertBinaryOperationTo2Params(P4::ReferenceMap *refMap) : refMap(refMap) {}
    const IR::Node *postorder(IR::AssignmentStatement *a) override;
    const IR::Node *postorder(IR::P4Control *a) override;
    const IR::Node *postorder(IR::P4Parser *a) override;
};
 
// Since in dpdk asm, there is no local variable declaration, we need to collect
// all local variables and inject them into the metadata struct.
// Local variables which are of header types are injected into headers struct
// instead of metadata struct, so that they can be instantiated as headers in the
// resulting dpdk asm file.
class CollectLocalVariables : public Transform {
    ordered_map<const IR::Declaration_Variable *, const cstring> localsMap;
    P4::ReferenceMap *refMap;
    P4::TypeMap *typeMap;
    DpdkProgramStructure *structure;
 
    void insert(const cstring prefix, const IR::IndexedVector<IR::Declaration> *locals) {
        for (auto d : *locals) {
            if (auto dv = d->to<IR::Declaration_Variable>()) {
                const cstring name = refMap->newName(prefix + "_" + dv->name.name);
                localsMap.emplace(dv, name);
            } else if (!d->is<IR::P4Action>() && !d->is<IR::P4Table>() &&
                       !d->is<IR::Declaration_Instance>()) {
                BUG("%1%: Unhandled declaration type", d);
            }
        }
    }
 
 public:
    CollectLocalVariables(P4::ReferenceMap *refMap, P4::TypeMap *typeMap,
                          DpdkProgramStructure *structure)
        : refMap(refMap), typeMap(typeMap), structure(structure) {}
    const IR::Node *preorder(IR::P4Program *p) override;
    const IR::Node *postorder(IR::Type_Struct *s) override;
    const IR::Node *postorder(IR::Member *m) override;
    const IR::Node *postorder(IR::PathExpression *path) override;
    const IR::Node *postorder(IR::P4Control *c) override;
    const IR::Node *postorder(IR::P4Parser *p) override;
};
 
// According to dpdk spec, action parameters should prepend a p. In order to
// respect this, we need at first make all action parameter lists into separate
// structs and declare that struct in the P4 program. Then we modify the action
// parameter list. Eventually, it will only contain one parameter `t`, which is a
// struct containing all parameters previously defined. Next, we prepend t. in
// front of action parameters. Please note that it is possible that the user
// defines a struct paremeter himself or define multiple struct parameters in
// action parameterlist. Current implementation does not support this.
class PrependPDotToActionArgs : public Transform {
    P4::TypeMap *typeMap;
    P4::ReferenceMap *refMap;
    DpdkProgramStructure *structure;
 
 public:
    PrependPDotToActionArgs(P4::TypeMap *typeMap, P4::ReferenceMap *refMap,
                            DpdkProgramStructure *structure)
        : typeMap(typeMap), refMap(refMap), structure(structure) {}
    const IR::Node *postorder(IR::P4Action *a) override;
    const IR::Node *postorder(IR::P4Program *s) override;
    const IR::Node *preorder(IR::PathExpression *path) override;
    const IR::Node *preorder(IR::MethodCallExpression *) override;
};
 
/* This class is used to process the default action
   and store the parameter list for each table.
   Later, this infomation is passed and saved in table
   properties and then used for generating instruction
   for default action in each table.
*/
class DefActionValue : public Inspector {
    P4::TypeMap *typeMap;
    P4::ReferenceMap *refMap;
    DpdkProgramStructure *structure;
 
 public:
    DefActionValue(P4::TypeMap *typeMap, P4::ReferenceMap *refMap, DpdkProgramStructure *structure)
        : typeMap(typeMap), refMap(refMap), structure(structure) {}
    void postorder(const IR::P4Table *t) override;
};
 
// dpdk does not support ternary operator so we need to translate ternary operator
// to corresponding if else statement
// Taken from frontend pass DoSimplifyExpressions in sideEffects.h
class DismantleMuxExpressions : public Transform {
    P4::TypeMap *typeMap;
    P4::ReferenceMap *refMap;
    IR::IndexedVector<IR::Declaration> toInsert;  // temporaries
    IR::IndexedVector<IR::StatOrDecl> statements;
 
    cstring createTemporary(const IR::Type *type);
    const IR::Expression *addAssignment(Util::SourceInfo srcInfo, cstring varName,
                                        const IR::Expression *expression);
 
 public:
    DismantleMuxExpressions(P4::TypeMap *typeMap, P4::ReferenceMap *refMap)
        : typeMap(typeMap), refMap(refMap) {}
    const IR::Node *preorder(IR::Mux *expression) override;
    const IR::Node *postorder(IR::P4Parser *parser) override;
    const IR::Node *postorder(IR::Function *function) override;
    const IR::Node *postorder(IR::P4Control *control) override;
    const IR::Node *postorder(IR::P4Action *action) override;
    const IR::Node *postorder(IR::AssignmentStatement *statement) override;
};
 
// For dpdk asm, there is not object-oriented. Therefore, we cannot define a
// checksum in dpdk asm. And dpdk asm only provides ckadd(checksum add) and
// cksub(checksum sub). So we need to define a explicit state for each checksum
// declaration. Essentially, this state will be declared in header struct and
// initilized to 0. And for cksum.add(x), it will be translated to ckadd state
// x. For dst = cksum.get(), it will be translated to mov dst state. This pass
// collects checksum instances and index them.
class CollectInternetChecksumInstance : public Inspector {
    P4::TypeMap *typeMap;
    DpdkProgramStructure *structure;
    std::vector<cstring> *csum_vec;
    int index = 0;
 
 public:
    CollectInternetChecksumInstance(P4::TypeMap *typeMap, DpdkProgramStructure *structure,
                                    std::vector<cstring> *csum_vec)
        : typeMap(typeMap), structure(structure), csum_vec(csum_vec) {}
    bool preorder(const IR::Declaration_Instance *d) override {
        auto type = typeMap->getType(d, true);
        if (auto extn = type->to<IR::Type_Extern>()) {
            if (extn->name == "InternetChecksum") {
                std::ostringstream s;
                s << "state_" << index++;
                csum_vec->push_back(s.str());
                structure->csum_map.emplace(d, s.str());
            }
        }
        return false;
    }
};
 
// This pass will inject checksum states into header. The reason why we inject
// state into header instead of metadata is due to the implementation of dpdk
// side(a question related to endianness)
class InjectInternetChecksumIntermediateValue : public Transform {
    DpdkProgramStructure *structure;
    std::vector<cstring> *csum_vec;
 
 public:
    InjectInternetChecksumIntermediateValue(DpdkProgramStructure *structure,
                                            std::vector<cstring> *csum_vec)
        : structure(structure), csum_vec(csum_vec) {}
 
    const IR::Node *postorder(IR::P4Program *p) override {
        auto new_objs = new IR::Vector<IR::Node>;
        bool inserted = false;
        for (auto obj : p->objects) {
            if (obj->to<IR::Type_Header>() && !inserted) {
                inserted = true;
                if (csum_vec->size() > 0) {
                    auto fields = new IR::IndexedVector<IR::StructField>;
                    for (auto fld : *csum_vec) {
                        fields->push_back(
                            new IR::StructField(IR::ID(fld), IR::Type::Bits::get(16, false)));
                    }
                    new_objs->push_back(new IR::Type_Header(IR::ID("cksum_state_t"), *fields));
                }
            }
            new_objs->push_back(obj);
        }
        p->objects = *new_objs;
        return p;
    }
 
    const IR::Node *postorder(IR::Type_Struct *s) override {
        if (s->name.name == structure->header_type) {
            if (structure->csum_map.size() > 0)
                s->fields.push_back(new IR::StructField(
                    IR::ID("cksum_state"), new IR::Type_Name(IR::ID("cksum_state_t"))));
        }
        return s;
    }
};
 
class ConvertInternetChecksum : public PassManager {
    std::vector<cstring> csum_vec;
 
 public:
    ConvertInternetChecksum(P4::TypeMap *typeMap, DpdkProgramStructure *structure) {
        passes.push_back(new CollectInternetChecksumInstance(typeMap, structure, &csum_vec));
        passes.push_back(new InjectInternetChecksumIntermediateValue(structure, &csum_vec));
    }
};
 
/* This pass collects PSA extern meter, counter and register declaration instances and
   push them to a vector for emitting to the .spec file later */
class CollectExternDeclaration : public Inspector {
    DpdkProgramStructure *structure;
 
 public:
    explicit CollectExternDeclaration(DpdkProgramStructure *structure) : structure(structure) {}
    bool preorder(const IR::Declaration_Instance *d) override {
        if (auto type = d->type->to<IR::Type_Name>()) {
            auto externTypeName = type->path->name.name;
            if (externTypeName == "DirectMeter") {
                if (d->arguments->size() != 1) {
                    ::P4::error(ErrorType::ERR_EXPECTED,
                                "%1%: expected type of meter as the only argument", d);
                } else {
                    /* Check if the Direct meter is of PACKETS (0) type */
                    if (d->arguments->at(0)->expression->to<IR::Constant>()->asUnsigned() == 0)
                        warn(ErrorType::WARN_UNSUPPORTED,
                             "%1%: Packet metering is not supported."
                             " Falling back to byte metering.",
                             d);
                }
            } else {
                // unsupported extern type
                return false;
            }
            structure->externDecls.push_back(d);
        } else if (auto type = d->type->to<IR::Type_Specialized>()) {
            auto externTypeName = type->baseType->path->name.name;
            if (externTypeName == "Meter") {
                if (d->arguments->size() != 2) {
                    ::P4::error(ErrorType::ERR_EXPECTED,
                                "%1%: expected number of meters and type of meter as arguments", d);
                } else {
                    /* Check if the meter is of PACKETS (0) type */
                    if (d->arguments->at(1)->expression->to<IR::Constant>()->asUnsigned() == 0)
                        warn(ErrorType::WARN_UNSUPPORTED,
                             "%1%: Packet metering is not supported."
                             " Falling back to byte metering.",
                             d);
                }
            } else if (externTypeName == "Counter") {
                if (d->arguments->size() != 2) {
                    ::P4::error(ErrorType::ERR_EXPECTED,
                                "%1%: expected number of counters and type of counter as arguments",
                                d);
                }
            } else if (externTypeName == "DirectCounter") {
                if (d->arguments->size() != 1) {
                    ::P4::error(ErrorType::ERR_EXPECTED,
                                "%1%: expected type of counter as the only argument", d);
                }
            } else if (externTypeName == "Register") {
                if (d->arguments->size() != 1 && d->arguments->size() != 2) {
                    ::P4::error(ErrorType::ERR_EXPECTED,
                                "%1%: expected size and optionally init_val as arguments", d);
                }
            } else if (externTypeName == "Hash") {
                if (d->arguments->size() != 1) {
                    ::P4::error(ErrorType::ERR_EXPECTED,
                                "%1%: expected hash algorithm as the only argument", d);
                }
            } else {
                // unsupported extern type
                return false;
            }
            structure->externDecls.push_back(d);
        }
        return false;
    }
};
 
// This pass is preparing logical expression for following branching statement
// optimization. This pass breaks parenthesis looks liks this: (a && b) && c.
// After this pass, the expression looks like this: a && b && c. (The AST is
// different).
class BreakLogicalExpressionParenthesis : public Transform {
 public:
    const IR::Node *postorder(IR::LAnd *land) {
        if (auto land2 = land->left->to<IR::LAnd>()) {
            auto sub = new IR::LAnd(land2->right, land->right);
            return new IR::LAnd(land2->left, sub);
        } else if (!land->left->is<IR::LOr>() && !land->left->is<IR::Equ>() &&
                   !land->left->is<IR::Neq>() && !land->left->is<IR::Leq>() &&
                   !land->left->is<IR::Geq>() && !land->left->is<IR::Lss>() &&
                   !land->left->is<IR::Grt>() && !land->left->is<IR::MethodCallExpression>() &&
                   !land->left->is<IR::PathExpression>() && !land->left->is<IR::Member>()) {
            BUG("Logical Expression Unroll pass failed");
        }
        return land;
    }
    const IR::Node *postorder(IR::LOr *lor) {
        if (auto lor2 = lor->left->to<IR::LOr>()) {
            auto sub = new IR::LOr(lor2->right, lor->right);
            return new IR::LOr(lor2->left, sub);
        } else if (!lor->left->is<IR::LAnd>() && !lor->left->is<IR::Equ>() &&
                   !lor->left->is<IR::Neq>() && !lor->left->is<IR::Lss>() &&
                   !lor->left->is<IR::Grt>() && !lor->left->is<IR::MethodCallExpression>() &&
                   !lor->left->is<IR::PathExpression>() && !lor->left->is<IR::Member>()) {
            BUG("Logical Expression Unroll pass failed");
        }
        return lor;
    }
};
 
// This pass will swap the simple expression to the front of an logical
// expression. Note that even for a subexpression of a logical expression, we
// will swap it as well. For example, a && ((b && c) || d), will become
// a && (d || (b && c))
class SwapSimpleExpressionToFrontOfLogicalExpression : public Transform {
    bool is_simple(const IR::Node *n) {
        if (n->is<IR::Equ>() || n->is<IR::Neq>() || n->is<IR::Lss>() || n->is<IR::Grt>() ||
            n->is<IR::Geq>() || n->is<IR::Leq>() || n->is<IR::MethodCallExpression>() ||
            n->is<IR::PathExpression>() || n->is<IR::Member>()) {
            return true;
        } else if (!n->is<IR::LAnd>() && !n->is<IR::LOr>()) {
            BUG("Logical Expression Unroll pass failed");
        } else {
            return false;
        }
    }
 
 public:
    const IR::Node *postorder(IR::LAnd *land) {
        if (!is_simple(land->left) && is_simple(land->right)) {
            return new IR::LAnd(land->right, land->left);
        } else if (!is_simple(land->left)) {
            if (auto land2 = land->right->to<IR::LAnd>()) {
                if (is_simple(land2->left)) {
                    auto sub = new IR::LAnd(land->left, land2->right);
                    return new IR::LAnd(land2->left, sub);
                }
            }
        }
        return land;
    }
    const IR::Node *postorder(IR::LOr *lor) {
        if (!is_simple(lor->left) && is_simple(lor->right)) {
            return new IR::LOr(lor->right, lor->left);
        } else if (!is_simple(lor->left)) {
            if (auto lor2 = lor->right->to<IR::LOr>()) {
                if (is_simple(lor2->left)) {
                    auto sub = new IR::LOr(lor->left, lor2->right);
                    return new IR::LOr(lor2->left, sub);
                }
            }
        }
        return lor;
    }
};
 
// This passmanager togethor transform logical expression into a form that
// the simple expression will go to the front of the expression. And for
// expression at the same level(the same level is that expressions that are
// connected directly by && or ||) should be traversed from left to right
// (a && b) && c is not a valid expression here.
class ConvertLogicalExpression : public PassManager {
 public:
    ConvertLogicalExpression() {
        auto r = new PassRepeated{new BreakLogicalExpressionParenthesis};
        passes.push_back(r);
        r = new PassRepeated{new SwapSimpleExpressionToFrontOfLogicalExpression};
        passes.push_back(r);
    }
};
 
// This Pass collects infomation about the table keys for each table. This information
// is later used for generating the context JSON output for use by the control plane
// software.
class CollectTableInfo : public Inspector {
    DpdkProgramStructure *structure;
 
 public:
    explicit CollectTableInfo(DpdkProgramStructure *structure) : structure(structure) {
        setName("CollectTableInfo");
    }
    bool preorder(const IR::Key *key) override;
};
 
// This pass transforms the tables such that all the Match keys are part of the same
// header/metadata struct. If the match keys are from different headers, this pass creates
// mirror copies of the struct field into the metadata struct and updates the table to use
// the metadata copy.
// This pass must be called right before CollectLocalVariables pass as the temporary
// variables created for holding copy of the table keys are inserted to Metadata by
// CollectLocalVariables pass.
struct keyElementInfo {
    int offsetInMetadata;
    int size;
};
 
struct keyInfo {
    int numElements;
    int numExistingMetaFields;
    bool isLearner;
    bool isExact;
    int size;
    std::vector<struct keyElementInfo *> elements;
};
 
class CopyMatchKeysToSingleStruct : public P4::KeySideEffect {
    IR::IndexedVector<IR::Declaration> decls;
    DpdkProgramStructure *structure;
    bool metaCopyNeeded = false;
 
 public:
    CopyMatchKeysToSingleStruct(P4::TypeMap *typeMap, std::set<const IR::P4Table *> *invokedInKey,
                                DpdkProgramStructure *structure)
        : P4::KeySideEffect(typeMap, invokedInKey), structure(structure) {
        setName("CopyMatchKeysToSingleStruct");
    }
 
    const IR::Node *preorder(IR::Key *key) override;
    const IR::Node *postorder(IR::KeyElement *element) override;
    const IR::Node *doStatement(const IR::Statement *statement, const IR::Expression *expression,
                                const Visitor::Context *ctxt) override;
    struct keyInfo *getKeyInfo(IR::Key *keys);
    cstring getTableKeyName(const IR::Expression *e);
    int getFieldSizeBits(const IR::Type *field_type);
    bool isLearnerTable(const IR::P4Table *t);
};
 
class SwitchHandler {
    // Map which holds the switch expression variable and constant tuple per switch statement for
    // each action.
    // action_name: {<switch_var, constant_value>, <switch_var1, constant_value1>, ...}
    std::map<cstring, std::vector<std::tuple<cstring, IR::Constant *>>> actionCaseMap;
 
 public:
    // Fill Switch Action Map
    void addToSwitchMap(cstring actionName, cstring switchExprTmp, IR::Constant *caseLabelValue) {
        actionCaseMap[actionName].push_back(std::make_tuple(switchExprTmp, caseLabelValue));
    }
 
    const IR::Node *setSwitchVarInAction(IR::P4Action *action) {
        if (actionCaseMap.count(action->name.name)) {
            // Insert assignment statements for each switch statement which uses this action name as
            // switch case.
            auto acm = actionCaseMap[action->name.name];
            auto body = new IR::BlockStatement(action->body->srcInfo);
            for (auto pair : acm) {
                auto assn = new IR::AssignmentStatement(
                    new IR::PathExpression(IR::ID(get<0>(pair))), get<1>(pair));
                body->push_back(assn);
            }
            for (auto s : action->body->components) body->push_back(s);
            action->body = body;
            actionCaseMap.erase(action->name.name);
        }
        return action;
    }
};
 
class SplitP4TableCommon : public Transform {
    cstring switchExprTmp;
    DeclarationInjector injector;
 
 public:
    enum class TableImplementation { DEFAULT, ACTION_PROFILE, ACTION_SELECTOR };
    P4::ReferenceMap *refMap;
    P4::TypeMap *typeMap;
    DpdkProgramStructure *structure;
    SwitchHandler &sw;
    TableImplementation implementation;
    std::set<cstring> match_tables;
    std::map<cstring, cstring> group_tables;
    std::map<cstring, cstring> member_tables;
    std::map<cstring, cstring> member_ids;
    std::map<cstring, cstring> group_ids;
 
    SplitP4TableCommon(P4::ReferenceMap *refMap, P4::TypeMap *typeMap,
                       DpdkProgramStructure *structure, SwitchHandler &sw)
        : refMap(refMap), typeMap(typeMap), structure(structure), sw(sw) {
        implementation = TableImplementation::DEFAULT;
    }
 
    const IR::Node *postorder(IR::MethodCallStatement *) override;
    const IR::Node *postorder(IR::IfStatement *) override;
    const IR::Node *postorder(IR::SwitchStatement *) override;
    const IR::Node *postorder(IR::P4Control *) override;
    std::tuple<const IR::P4Table *, cstring, cstring> create_match_table(
        const IR::P4Table * /* tbl */);
    const IR::P4Action *create_action(cstring /* actionName */, cstring /* id */, cstring);
    const IR::P4Table *create_member_table(const IR::P4Table *, cstring, cstring);
    const IR::P4Table *create_group_table(const IR::P4Table *, cstring, cstring, cstring, unsigned,
                                          unsigned);
    IR::Expression *initializeMemberAndGroupId(cstring tableName,
                                               IR::IndexedVector<IR::StatOrDecl> *decls);
};
 
class SplitActionSelectorTable : public SplitP4TableCommon {
 public:
    SplitActionSelectorTable(P4::ReferenceMap *refMap, P4::TypeMap *typeMap,
                             DpdkProgramStructure *structure, SwitchHandler &sw)
        : SplitP4TableCommon(refMap, typeMap, structure, sw) {
        implementation = TableImplementation::ACTION_SELECTOR;
    }
    const IR::Node *postorder(IR::P4Table *tbl) override;
};
 
class SplitActionProfileTable : public SplitP4TableCommon {
 public:
    SplitActionProfileTable(P4::ReferenceMap *refMap, P4::TypeMap *typeMap,
                            DpdkProgramStructure *structure, SwitchHandler &sw)
        : SplitP4TableCommon(refMap, typeMap, structure, sw) {
        implementation = TableImplementation::ACTION_PROFILE;
    }
    const IR::Node *postorder(IR::P4Table *tbl) override;
};
 
class UpdateActionForSwitch : public Transform {
    SwitchHandler &sw;
 
 public:
    explicit UpdateActionForSwitch(SwitchHandler &sw) : sw(sw) { setName("UpdateActionForSwitch"); }
    const IR::Node *postorder(IR::P4Action *action) { return sw.setSwitchVarInAction(action); }
};
class ConvertActionSelectorAndProfile : public PassManager {
    SwitchHandler sw;
 
 public:
    ConvertActionSelectorAndProfile(P4::ReferenceMap *refMap, P4::TypeMap *typeMap,
                                    DpdkProgramStructure *structure) {
        passes.emplace_back(new P4::TypeChecking(refMap, typeMap));
        passes.emplace_back(new SplitActionSelectorTable(refMap, typeMap, structure, sw));
        passes.emplace_back(new UpdateActionForSwitch(sw));
        passes.push_back(new P4::ClearTypeMap(typeMap));
        passes.emplace_back(new P4::TypeChecking(refMap, typeMap, true));
        passes.emplace_back(new SplitActionProfileTable(refMap, typeMap, structure, sw));
        passes.emplace_back(new UpdateActionForSwitch(sw));
        passes.push_back(new P4::ClearTypeMap(typeMap));
        passes.emplace_back(new P4::TypeChecking(refMap, typeMap, true));
    }
};
 
/* Collect size information from the owner table for direct counter and meter extern objects
 * and validate some of the constraints on usage of Direct Meter and Direct Counter extern
 * methods */
class CollectDirectCounterMeter : public Inspector {
    P4::ReferenceMap *refMap;
    P4::TypeMap *typeMap;
    DpdkProgramStructure *structure;
    // To validate presence of specified method call for instancename within given action
    cstring method;
    cstring instancename;
    // To validate that same method call for different direct meter/counter instance does not exist
    // in any action
    cstring oneInstance;
    bool methodCallFound;
    int getTableSize(const IR::P4Table *tbl);
    bool ifMethodFound(const IR::P4Action *a, cstring method,
                       cstring instancename = cstring::empty);
    void checkMethodCallInAction(const P4::ExternMethod *);
 
 public:
    static ordered_map<cstring, int> directMeterCounterSizeMap;
    CollectDirectCounterMeter(P4::ReferenceMap *refMap, P4::TypeMap *typeMap,
                              DpdkProgramStructure *structure)
        : refMap(refMap), typeMap(typeMap), structure(structure) {
        setName("CollectDirectCounterMeter");
        visitDagOnce = false;
        method = cstring::empty;
        instancename = cstring::empty;
        oneInstance = cstring::empty;
        methodCallFound = false;
    }
 
    bool preorder(const IR::MethodCallStatement *mcs) override;
    bool preorder(const IR::AssignmentStatement *assn) override;
    bool preorder(const IR::P4Action *a) override;
    bool preorder(const IR::P4Table *t) override;
};
 
class ValidateDirectCounterMeter : public Inspector {
    P4::ReferenceMap *refMap;
    P4::TypeMap *typeMap;
    DpdkProgramStructure *structure;
    void validateMethodInvocation(P4::ExternMethod *);
 
 public:
    ValidateDirectCounterMeter(P4::ReferenceMap *refMap, P4::TypeMap *typeMap,
                               DpdkProgramStructure *structure)
        : refMap(refMap), typeMap(typeMap), structure(structure) {}
 
    void postorder(const IR::AssignmentStatement *) override;
    void postorder(const IR::MethodCallStatement *) override;
};
 
class CollectAddOnMissTable : public Inspector {
    P4::ReferenceMap *refMap;
    P4::TypeMap *typeMap;
    DpdkProgramStructure *structure;
 
 public:
    CollectAddOnMissTable(P4::ReferenceMap *refMap, P4::TypeMap *typeMap,
                          DpdkProgramStructure *structure)
        : refMap(refMap), typeMap(typeMap), structure(structure) {}
 
    void postorder(const IR::P4Table *t) override;
    void postorder(const IR::MethodCallStatement *) override;
};
 
class ValidateAddOnMissExterns : public Inspector {
    P4::ReferenceMap *refMap;
    P4::TypeMap *typeMap;
    DpdkProgramStructure *structure;
 
 public:
    ValidateAddOnMissExterns(P4::ReferenceMap *refMap, P4::TypeMap *typeMap,
                             DpdkProgramStructure *structure)
        : refMap(refMap), typeMap(typeMap), structure(structure) {}
 
    void postorder(const IR::MethodCallStatement *) override;
    cstring getDefActionName(const IR::P4Table *t) {
        auto act = t->getDefaultAction();
        BUG_CHECK(act != nullptr, "%1%: default action does not exist", t);
        if (auto mc = act->to<IR::MethodCallExpression>()) {
            auto method = mc->method->to<IR::PathExpression>();
            return method->path->name;
        }
        return NULL;
    }
};
 
// Dpdk does not allow operations (arithmetic, logical, bitwise, relational etc) on operands
// greater than 64-bit.
class ValidateOperandSize : public Inspector {
 public:
    ValidateOperandSize() { setName("ValidateOperandSize"); }
    void isValidOperandSize(const IR::Expression *e) {
        if (auto t = e->type->to<IR::Type_Bits>()) {
            if (t->width_bits() > dpdk_max_operand_size) {
                ::P4::error(ErrorType::ERR_UNSUPPORTED_ON_TARGET, "Unsupported bitwidth %1% in %2%",
                            t->width_bits(), e);
                return;
            }
        }
    }
 
    void postorder(const IR::Operation_Binary *binop) override {
        if (binop->is<IR::BOr>() || binop->is<IR::BAnd>() || binop->is<IR::BXor>() ||
            binop->is<IR::Equ>() || binop->is<IR::Neq>()) {
            if (auto src1Type = binop->left->type->to<IR::Type_Bits>()) {
                if (src1Type->width_bits() == 128) return;
            }
        }
        isValidOperandSize(binop->left);
        isValidOperandSize(binop->right);
    }
 
    // Reject all operations except typecast if the operand size is beyond the supported limit
    void postorder(const IR::Operation_Unary *unop) override {
        if (unop->is<IR::Cast>()) return;
        if (unop->is<IR::Cmpl>()) {
            if (auto src1Type = unop->expr->type->to<IR::Type_Bits>()) {
                if (src1Type->width_bits() == 128) return;
            }
        }
        isValidOperandSize(unop->expr);
    }
 
    void postorder(const IR::Operation_Ternary *top) override {
        isValidOperandSize(top->e0);
        isValidOperandSize(top->e1);
        isValidOperandSize(top->e2);
    }
};
 
class CollectErrors : public Inspector {
    DpdkProgramStructure *structure;
 
 public:
    explicit CollectErrors(DpdkProgramStructure *structure) : structure(structure) {
        CHECK_NULL(structure);
    }
    void postorder(const IR::Type_Error *error) override {
        int id = 0;
        for (auto err : error->members) {
            if (structure->error_map.count(err->name.name) == 0) {
                structure->error_map.emplace(err->name.name, id++);
            }
        }
    }
};
 
class ElimHeaderCopy : public Transform {
    P4::TypeMap *typeMap;
    ordered_map<cstring, const IR::Member *> replacementMap;
 
 public:
    explicit ElimHeaderCopy(P4::TypeMap *typeMap) : typeMap{typeMap} {}
    bool isHeader(const IR::Expression *e);
    const IR::Node *preorder(IR::AssignmentStatement *as) override;
    const IR::Node *preorder(IR::MethodCallStatement *mcs) override;
    const IR::Node *postorder(IR::Member *m) override;
};
 
class EliminateHeaderCopy : public PassManager {
 public:
    EliminateHeaderCopy(P4::ReferenceMap *refMap, P4::TypeMap *typeMap) {
        passes.push_back(new P4::ClearTypeMap(typeMap));
        passes.push_back(new P4::ResolveReferences(refMap));
        passes.push_back(new P4::TypeInference(typeMap, false));
        passes.push_back(new P4::TypeChecking(refMap, typeMap, true));
        passes.push_back(new ElimHeaderCopy(typeMap));
    }
};
 
// If one operand is >64-bit and other is <= 64-bit, the smaller operand should be a header field
// to maintain the endianness for copy. This pass detects if these conditions are satisfied or not.
class HaveNonHeaderLargeOperandAssignment : public Inspector {
    bool &is_all_arg_header_fields;
 
 public:
    explicit HaveNonHeaderLargeOperandAssignment(bool &is_all_arg_header_fields)
        : is_all_arg_header_fields(is_all_arg_header_fields) {}
    bool preorder(const IR::AssignmentStatement *assn) override {
        if (!is_all_arg_header_fields) return false;
        if ((isLargeFieldOperand(assn->left) && !isLargeFieldOperand(assn->right) &&
             !isInsideHeader(assn->right)) ||
            (isLargeFieldOperand(assn->left) && assn->right->is<IR::Constant>()) ||
            (!isLargeFieldOperand(assn->left) && isLargeFieldOperand(assn->right) &&
             !isInsideHeader(assn->left))) {
            is_all_arg_header_fields &= false;
            return false;
        }
        return false;
    }
};
 
class HaveNonHeaderChecksumArgs : public Inspector {
    P4::TypeMap *typeMap;
    bool &is_all_arg_header_fields;
 
 public:
    HaveNonHeaderChecksumArgs(P4::TypeMap *typeMap, bool &is_all_arg_header_fields)
        : typeMap(typeMap), is_all_arg_header_fields(is_all_arg_header_fields) {}
    bool preorder(const IR::MethodCallExpression *mce) override {
        if (!is_all_arg_header_fields) return false;
        if (auto *m = mce->method->to<IR::Member>()) {
            if (auto *type = typeMap->getType(m->expr)->to<IR::Type_Extern>()) {
                if (type->name == "InternetChecksum") {
                    if (m->member == "add" || m->member == "subtract") {
                        for (auto arg : *mce->arguments) {
                            if (auto se = arg->expression->to<IR::StructExpression>()) {
                                for (auto c : se->components) {
                                    if (auto m0 = c->expression->to<IR::Member>()) {
                                        if (!typeMap->getType(m0->expr, true)
                                                 ->is<IR::Type_Header>()) {
                                            is_all_arg_header_fields = false;
                                            return false;
                                        }
                                    } else {
                                        is_all_arg_header_fields = false;
                                        return false;
                                    }
                                }
                            } else if (arg->expression->to<IR::Constant>()) {
                                is_all_arg_header_fields = false;
                                return false;
                            } else if (auto m = arg->expression->to<IR::Member>()) {
                                if (!(typeMap->getType(m->expr, true)->is<IR::Type_Header>() ||
                                      typeMap->getType(m, true)->is<IR::Type_Header>())) {
                                    is_all_arg_header_fields = false;
                                    return false;
                                }
                            }
                        }
                    }
                }
            }
        }
        return false;
    }
};
 
class DpdkAddPseudoHeaderDecl : public Transform {
    P4::ReferenceMap *refMap;
    P4::TypeMap *typeMap;
    bool &is_all_args_header;
    IR::Vector<IR::Node> allTypeDecls;
 
 public:
    static cstring pseudoHeaderInstanceName;
    static cstring pseudoHeaderTypeName;
    DpdkAddPseudoHeaderDecl(P4::ReferenceMap *refMap, P4::TypeMap *typeMap,
                            bool &is_all_args_header)
        : refMap(refMap), typeMap(typeMap), is_all_args_header(is_all_args_header) {
        pseudoHeaderInstanceName = refMap->newName("dpdk_pseudo_header");
        pseudoHeaderTypeName = refMap->newName("dpdk_pseudo_header_t");
        (void)this->typeMap;
        (void)this->refMap;
    }
 
    const IR::Node *preorder(IR::P4Program *program) override;
    const IR::Node *preorder(IR::Type_Struct *st) override;
};
 
 
class MoveNonHeaderFieldsToPseudoHeader : public Transform {
    P4::ReferenceMap *refMap;
    P4::TypeMap *typeMap;
    bool &is_all_args_header;
    IR::Vector<IR::Node> newStructTypes;
 
 public:
    static std::vector<std::pair<cstring, const IR::Type *>> pseudoFieldNameType;
    MoveNonHeaderFieldsToPseudoHeader(P4::ReferenceMap *refMap, P4::TypeMap *typeMap,
                                      bool &is_all_args_header)
        : refMap(refMap), typeMap(typeMap), is_all_args_header(is_all_args_header) {}
    std::pair<IR::AssignmentStatement *, IR::Member *> addAssignmentStmt(const IR::Expression *ne);
 
    const IR::Node *postorder(IR::P4Program *p) override {
        if (newStructTypes.size() > 0) {
            IR::Vector<IR::Node> allTypeDecls;
            allTypeDecls.append(newStructTypes);
            allTypeDecls.append(p->objects);
            p->objects = allTypeDecls;
        }
        return p;
    }
    const IR::Node *postorder(IR::MethodCallStatement *statement) override;
    const IR::Node *postorder(IR::AssignmentStatement *statement) override;
};
 
class AddFieldsToPseudoHeader : public Transform {
    P4::ReferenceMap *refMap;
    P4::TypeMap *typeMap;
    bool &is_all_args_header;
 
 public:
    AddFieldsToPseudoHeader(P4::ReferenceMap *refMap, P4::TypeMap *typeMap,
                            bool &is_all_args_header)
        : refMap(refMap), typeMap(typeMap), is_all_args_header(is_all_args_header) {
        (void)this->typeMap;
        (void)this->refMap;
    }
    const IR::Node *preorder(IR::Type_Header *h) override;
};
 
struct DpdkAddPseudoHeader : public PassManager {
    P4::ReferenceMap *refMap;
    P4::TypeMap *typeMap;
    bool &is_all_args_header;
 
 public:
    DpdkAddPseudoHeader(P4::ReferenceMap *refMap, P4::TypeMap *typeMap,
                        bool &is_all_args_header_fields)
        : refMap(refMap), typeMap(typeMap), is_all_args_header(is_all_args_header_fields) {
        passes.push_back(new HaveNonHeaderChecksumArgs(typeMap, is_all_args_header));
        passes.push_back(new HaveNonHeaderLargeOperandAssignment(is_all_args_header));
        passes.push_back(new DpdkAddPseudoHeaderDecl(refMap, typeMap, is_all_args_header));
        passes.push_back(new P4::ClearTypeMap(typeMap));
        passes.push_back(new P4::TypeChecking(refMap, typeMap));
        passes.push_back(
            new MoveNonHeaderFieldsToPseudoHeader(refMap, typeMap, is_all_args_header));
        passes.push_back(new AddFieldsToPseudoHeader(refMap, typeMap, is_all_args_header));
        passes.push_back(new P4::ClearTypeMap(typeMap));
        passes.push_back(new P4::TypeChecking(refMap, typeMap));
    }
};
 
class DpdkArchFirst : public PassManager {
 public:
    DpdkArchFirst() { setName("DpdkArchFirst"); }
};
 
class DpdkArchLast : public PassManager {
 public:
    DpdkArchLast() { setName("DpdkArchLast"); }
};
 
class CollectProgramStructure : public PassManager {
 public:
    CollectProgramStructure(P4::ReferenceMap *refMap, P4::TypeMap *typeMap,
                            DpdkProgramStructure *structure) {
        auto *evaluator = new P4::EvaluatorPass(refMap, typeMap);
        auto *parseDpdk = new ParseDpdkArchitecture(structure);
        passes.push_back(evaluator);
        passes.push_back(new VisitFunctor([evaluator, parseDpdk]() {
            auto toplevel = evaluator->getToplevelBlock();
            auto main = toplevel->getMain();
            if (main == nullptr) {
                ::P4::error(ErrorType::ERR_NOT_FOUND,
                            "Could not locate top-level block; is there a %1% module?",
                            IR::P4Program::main);
                return;
            }
            main->apply(*parseDpdk);
        }));
    }
};
 
// Add collected local struct variable decls as a field in metadata
// struct
class MoveCollectedStructLocalVariableToMetadata : public Transform {
    P4::TypeMap *typeMap;
 
 public:
    explicit MoveCollectedStructLocalVariableToMetadata(P4::TypeMap *typeMap) : typeMap(typeMap) {}
    const IR::Node *preorder(IR::Type_Struct *s) override;
    const IR::Node *postorder(IR::P4Control *c) override;
    const IR::Node *postorder(IR::P4Program *p) override;
    const IR::Node *postorder(IR::P4Parser *c) override;
};
 
// Collect all local struct variable and metadata struct type
class CollectStructLocalVariables : public Transform {
    P4::ReferenceMap *refMap;
    P4::TypeMap *typeMap;
 
 public:
    CollectStructLocalVariables(P4::ReferenceMap *refMap, P4::TypeMap *typeMap)
        : refMap(refMap), typeMap(typeMap) {}
    const IR::Node *postorder(IR::P4Parser *c) override;
    const IR::Node *preorder(IR::PathExpression *path) override;
    static const IR::Type_Struct *metadataStrct;
    static std::map<cstring, const IR::Type *> fieldNameType;
    static IR::Vector<IR::Node> type_tobe_moved_at_top;
};
 
// Collect all local struct decls and move it to metadata struct and finally
// flatten the metadata struct.
class CollectLocalStructAndFlatten : public PassManager {
 public:
    CollectLocalStructAndFlatten(P4::ReferenceMap *refMap, P4::TypeMap *typeMap) {
        passes.push_back(new P4::ClearTypeMap(typeMap));
        passes.push_back(new P4::ResolveReferences(refMap));
        passes.push_back(new P4::TypeInference(typeMap, false));
        passes.push_back(new P4::TypeChecking(refMap, typeMap, true));
        passes.push_back(new CollectStructLocalVariables(refMap, typeMap));
        passes.push_back(new MoveCollectedStructLocalVariableToMetadata(typeMap));
        passes.push_back(new P4::ClearTypeMap(typeMap));
        passes.push_back(new P4::ResolveReferences(refMap));
        passes.push_back(new P4::TypeInference(typeMap, false));
        passes.push_back(new P4::TypeChecking(refMap, typeMap, true));
        passes.push_back(new P4::FlattenInterfaceStructs(typeMap));
    }
};
 
/* Helper class to detect use of IPSec accelerator */
class CollectIPSecInfo : public Inspector {
    bool &is_ipsec_used;
    int &sa_id_width;
    P4::ReferenceMap *refMap;
    P4::TypeMap *typeMap;
    DpdkProgramStructure *structure;
 
 public:
    CollectIPSecInfo(bool &is_ipsec_used, int &sa_id_width, P4::ReferenceMap *refMap,
                     P4::TypeMap *typeMap, DpdkProgramStructure *structure)
        : is_ipsec_used(is_ipsec_used),
          sa_id_width(sa_id_width),
          refMap(refMap),
          typeMap(typeMap),
          structure(structure) {}
    bool preorder(const IR::MethodCallStatement *mcs) override {
        auto mi = P4::MethodInstance::resolve(mcs, refMap, typeMap);
        if (auto a = mi->to<P4::ExternMethod>()) {
            if (a->originalExternType->getName().name == "ipsec_accelerator") {
                if (structure->isPSA()) {
                    ::P4::error(ErrorType::ERR_MODEL, "%1% is not available for PSA programs",
                                a->originalExternType->getName().name);
                    return false;
                }
                if (a->method->getName().name == "enable") {
                    is_ipsec_used = true;
                } else if (a->method->getName().name == "set_sa_index") {
                    auto typeArgs = a->expr->typeArguments;
                    if (typeArgs->size() != 1) {
                        ::P4::error(ErrorType::ERR_MODEL,
                                    "Unexpected number of type arguments for %1%", a->method->name);
                        return false;
                    }
                    auto width = typeArgs->at(0);
                    if (!width->is<IR::Type_Bits>()) {
                        ::P4::error(ErrorType::ERR_MODEL, "Unexpected width type %1% for sa_index",
                                    width);
                        return false;
                    }
                    sa_id_width = width->to<IR::Type_Bits>()->width_bits();
                }
            }
        }
        return false;
    }
};
 
/* DPDK uses some fixed registers to hold the ipsec inbound/outbound input and output ports and a
 * pseudo compiler inserted header which shall be emitted in front of all headers. This class helps
 * insert required registers and a pseudo header for enabling IPSec encryption and decryption. It
 * also handles setting of output port in the deparser.
 */
class InsertReqDeclForIPSec : public Transform {
    P4::ReferenceMap *refMap;
    DpdkProgramStructure *structure;
    bool &is_ipsec_used;
    int &sa_id_width;
    cstring newHeaderName = "platform_hdr_t"_cs;
    IR::Type_Header *ipsecHeader = nullptr;
    std::vector<cstring> registerInstanceNames = {
        "ipsec_port_out_inbound"_cs, "ipsec_port_out_outbound"_cs, "ipsec_port_in_inbound"_cs,
        "ipsec_port_in_outbound"_cs};
 
 public:
    InsertReqDeclForIPSec(P4::ReferenceMap *refMap, DpdkProgramStructure *structure,
                          bool &is_ipsec_used, int &sa_id_width)
        : refMap(refMap),
          structure(structure),
          is_ipsec_used(is_ipsec_used),
          sa_id_width(sa_id_width) {
        setName("InsertReqDeclForIPSec");
    }
 
    const IR::Node *preorder(IR::P4Program *program) override;
    const IR::Node *preorder(IR::Type_Struct *s) override;
    const IR::Node *preorder(IR::P4Control *c) override;
    IR::IndexedVector<IR::StatOrDecl> *addRegDeclInstance(std::vector<cstring> portRegs);
};
 
struct DpdkHandleIPSec : public PassManager {
    P4::ReferenceMap *refMap;
    P4::TypeMap *typeMap;
    DpdkProgramStructure *structure;
    bool is_ipsec_used = false;
    int sa_id_width = 32;
 
 public:
    DpdkHandleIPSec(P4::ReferenceMap *refMap, P4::TypeMap *typeMap, DpdkProgramStructure *structure)
        : refMap(refMap), typeMap(typeMap), structure(structure) {
        passes.push_back(
            new CollectIPSecInfo(is_ipsec_used, sa_id_width, refMap, typeMap, structure));
        passes.push_back(new InsertReqDeclForIPSec(refMap, structure, is_ipsec_used, sa_id_width));
        passes.push_back(new P4::ClearTypeMap(typeMap));
        passes.push_back(new P4::ResolveReferences(refMap));
        passes.push_back(new P4::TypeInference(typeMap, false));
    }
};
 
}  // namespace P4::DPDK
#endif /* BACKENDS_DPDK_DPDKARCH_H_ */