targets/pna/test_spec.h

/*
 * SPDX-FileCopyrightText: 2023 Intel Corporation
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef BACKENDS_P4TOOLS_MODULES_TESTGEN_TARGETS_PNA_TEST_SPEC_H_
#define BACKENDS_P4TOOLS_MODULES_TESTGEN_TARGETS_PNA_TEST_SPEC_H_
 
#include <cstddef>
#include <map>
#include <utility>
#include <vector>
 
#include "backends/p4tools/common/lib/model.h"
#include "ir/declaration.h"
#include "ir/ir.h"
#include "lib/cstring.h"
 
#include "backends/p4tools/modules/testgen/lib/test_object.h"
#include "backends/p4tools/modules/testgen/lib/test_spec.h"
 
namespace P4::P4Tools::P4Testgen::Pna {
 
/* =========================================================================================
 *  PnaDpdkRegister
 * ========================================================================================= */
 
class PnaDpdkRegisterCondition : public TestObject {
 public:
    const IR::Expression *index;

    const IR::Expression *value;
 
    explicit PnaDpdkRegisterCondition(const IR::Expression *index, const IR::Expression *value);

    [[nodiscard]] const IR::Constant *getEvaluatedIndex() const;

    [[nodiscard]] const IR::Constant *getEvaluatedValue() const;
 
    [[nodiscard]] const PnaDpdkRegisterCondition *evaluate(const Model &model,
                                                           bool doComplete) const override;
 
    [[nodiscard]] cstring getObjectName() const override;
 
    DECLARE_TYPEINFO(PnaDpdkRegisterCondition, TestObject);
};

class PnaDpdkRegisterValue : public TestObject {
 private:
    const IR::Expression *initialValue;

    std::vector<PnaDpdkRegisterCondition> registerConditions;
 
 public:
    explicit PnaDpdkRegisterValue(const IR::Expression *initialValue);
 
    [[nodiscard]] cstring getObjectName() const override;

    void addRegisterCondition(PnaDpdkRegisterCondition cond);

    [[nodiscard]] const IR::Expression *getInitialValue() const;

    const IR::Expression *getCurrentValue(const IR::Expression *index) const;

    [[nodiscard]] const IR::Constant *getEvaluatedValue() const;
 
    [[nodiscard]] const PnaDpdkRegisterValue *evaluate(const Model &model,
                                                       bool doComplete) const override;
 
    DECLARE_TYPEINFO(PnaDpdkRegisterValue, TestObject);
};
 
/* =========================================================================================
 *  PnaDpdkActionProfile
 * ========================================================================================= */
class PnaDpdkActionProfile : public TestObject {
 private:
    std::vector<std::pair<cstring, std::vector<ActionArg>>> actions;

    const IR::IDeclaration *profileDecl;
 
 public:
    explicit PnaDpdkActionProfile(const IR::IDeclaration *profileDecl);
 
    [[nodiscard]] cstring getObjectName() const override;

    [[nodiscard]] const std::vector<std::pair<cstring, std::vector<ActionArg>>> *getActions() const;

    [[nodiscard]] const IR::IDeclaration *getProfileDecl() const;

    size_t getActionMapSize() const;

    void addToActionMap(cstring actionName, std::vector<ActionArg> actionArgs);
 
    [[nodiscard]] const PnaDpdkActionProfile *evaluate(const Model &model,
                                                       bool doComplete) const override;
 
    DECLARE_TYPEINFO(PnaDpdkActionProfile, TestObject);
};
 
/* =========================================================================================
 *  ActionSelector
 * ========================================================================================= */
class PnaDpdkActionSelector : public TestObject {
 private:
    const IR::IDeclaration *selectorDecl;

    const PnaDpdkActionProfile *actionProfile;
 
 public:
    explicit PnaDpdkActionSelector(const IR::IDeclaration *selectorDecl,
                                   const PnaDpdkActionProfile *actionProfile);
 
    [[nodiscard]] cstring getObjectName() const override;

    [[nodiscard]] const IR::IDeclaration *getSelectorDecl() const;

    [[nodiscard]] const PnaDpdkActionProfile *getActionProfile() const;
 
    [[nodiscard]] const PnaDpdkActionSelector *evaluate(const Model &model,
                                                        bool doComplete) const override;
 
    DECLARE_TYPEINFO(PnaDpdkActionSelector, TestObject);
};
 
/* =========================================================================================
 *  MetadataCollection
 * ========================================================================================= */
class MetadataCollection : public TestObject {
 private:
    std::map<cstring, const IR::Literal *> metadataFields;
 
 public:
    MetadataCollection();
 
    [[nodiscard]] cstring getObjectName() const override;
 
    [[nodiscard]] const MetadataCollection *evaluate(const Model & /*model*/,
                                                     bool doComplete) const override;

    [[nodiscard]] const std::map<cstring, const IR::Literal *> &getMetadataFields() const;
 
    void addMetaDataField(cstring name, const IR::Literal *metadataField);
 
    const IR::Literal *getMetadataField(cstring name);
 
    DECLARE_TYPEINFO(MetadataCollection, TestObject);
};
 
/* =========================================================================================
 * Table Key Match Types
 * ========================================================================================= */
 
class Optional : public TableMatch {
 private:
    const IR::Expression *value;

    bool addMatch;
 
 public:
    explicit Optional(const IR::KeyElement *key, const IR::Expression *value, bool addMatch);
 
    const Optional *evaluate(const Model &model, bool doComplete) const override;
 
    cstring getObjectName() const override;

    const IR::Constant *getEvaluatedValue() const;

    bool addAsExactMatch() const;
 
    DECLARE_TYPEINFO(Optional, TableMatch);
};
 
class Range : public TableMatch {
 private:
    const IR::Expression *low;

    const IR::Expression *high;
 
 public:
    explicit Range(const IR::KeyElement *key, const IR::Expression *low,
                   const IR::Expression *high);
 
    const Range *evaluate(const Model &model, bool doComplete) const override;
 
    cstring getObjectName() const override;

    const IR::Constant *getEvaluatedLow() const;

    const IR::Constant *getEvaluatedHigh() const;
 
    DECLARE_TYPEINFO(Range, TableMatch);
};
 
}  // namespace P4::P4Tools::P4Testgen::Pna
 
#endif /* BACKENDS_P4TOOLS_MODULES_TESTGEN_TARGETS_PNA_TEST_SPEC_H_ */