targets/tofino/test_spec.h

/*******************************************************************************
 *  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
 ******************************************************************************/
 
#ifndef BACKENDS_P4TOOLS_MODULES_TESTGEN_TARGETS_TOFINO_TEST_SPEC_H_
#define BACKENDS_P4TOOLS_MODULES_TESTGEN_TARGETS_TOFINO_TEST_SPEC_H_
 
#include <cstddef>
#include <utility>
#include <vector>
 
#include "backends/p4tools/common/lib/model.h"
#include "ir/ir.h"
#include "lib/cstring.h"
 
#include "backends/p4tools/modules/testgen/lib/test_spec.h"
 
namespace P4::P4Tools::P4Testgen::Tofino {
 
/* =========================================================================================
 *  IndexExpression
 * ========================================================================================= */
class IndexExpression : public TestObject {
 private:
    const IR::Expression *index;

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

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

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

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

    [[nodiscard]] const IR::Expression *getValue() const;
 
    [[nodiscard]] const IndexExpression *evaluate(const Model &model,
                                                  bool doComplete) const override;
 
    [[nodiscard]] cstring getObjectName() const override;
 
    DECLARE_TYPEINFO(IndexExpression, TestObject);
};
 
/* =========================================================================================
 *  IndexMap
 * ========================================================================================= */
class IndexMap : public TestObject {
 protected:
    const IR::Expression *initialValue;

    std::vector<IndexExpression> indexConditions;
 
 public:
    explicit IndexMap(const IR::Expression *initialValue);

    void writeToIndex(const IR::Expression *index, const IR::Expression *value);

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

    [[nodiscard]] const IR::Expression *getValueAtIndex(const IR::Expression *index) const;

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

    [[nodiscard]] std::map<big_int, std::pair<int, const IR::Constant *>> unravelMap() const;
 
    DECLARE_TYPEINFO(IndexMap, TestObject);
};
 
/* =========================================================================================
 *  TofinoRegisterValue
 * ========================================================================================= */
class TofinoRegisterValue : public IndexMap {
 private:
    const IR::Declaration_Instance *decl;

    const IR::Expression *initialIndex;
 
 public:
    explicit TofinoRegisterValue(const IR::Declaration_Instance *decl,
                                 const IR::Expression *initialValue,
                                 const IR::Expression *initialIndex);
 
    [[nodiscard]] cstring getObjectName() const override;
 
    [[nodiscard]] const TofinoRegisterValue *evaluate(const Model &model,
                                                      bool doComplete) const override;

    [[nodiscard]] const IR::Declaration_Instance *getRegisterDeclaration() const;

    [[nodiscard]] const IR::Constant *getEvaluatedInitialIndex() const;
 
    DECLARE_TYPEINFO(TofinoRegisterValue, TestObject);
};
 
/* =========================================================================================
 *  TofinoDirectRegisterValue
 * ========================================================================================= */
class TofinoDirectRegisterValue : public TestObject {
 private:
    const IR::Expression *initialValue;

    const IR::Declaration_Instance *decl;

    const IR::P4Table *table;
 
 public:
    explicit TofinoDirectRegisterValue(const IR::Declaration_Instance *decl,
                                       const IR::Expression *initialValue,
                                       const IR::P4Table *table);
 
    [[nodiscard]] cstring getObjectName() const override;
 
    [[nodiscard]] const TofinoDirectRegisterValue *evaluate(const Model &model,
                                                            bool doComplete) const override;

    [[nodiscard]] const IR::Declaration_Instance *getRegisterDeclaration() const;

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

    [[nodiscard]] const IR::P4Table *getRegisterTable() const;

    [[nodiscard]] const IR::Expression *getEvaluatedInitialValue() const;
 
    DECLARE_TYPEINFO(TofinoDirectRegisterValue, TestObject);
};
 
/* =========================================================================================
 *  TofinoRegisterParam
 * ========================================================================================= */
class TofinoRegisterParam : public TestObject {
 private:
    const IR::Declaration_Instance *decl;

    const IR::Expression *initialValue;
 
 public:
    explicit TofinoRegisterParam(const IR::Declaration_Instance *decl,
                                 const IR::Expression *initialValue);
 
    [[nodiscard]] cstring getObjectName() const override;
 
    [[nodiscard]] const TofinoRegisterParam *evaluate(const Model &model,
                                                      bool doComplete) const override;
    [[nodiscard]] const IR::Expression *getInitialValue() const;

    [[nodiscard]] const IR::Declaration_Instance *getRegisterParamDeclaration() const;

    [[nodiscard]] const IR::Constant *getEvaluatedInitialValue() const;
 
    DECLARE_TYPEINFO(TofinoRegisterParam, TestObject);
};
 
/* =========================================================================================
 *  TofinoActionProfile
 * ========================================================================================= */
class TofinoActionProfile : public TestObject {
 private:
    std::vector<std::pair<cstring, std::vector<ActionArg>>> actions;

    const IR::IDeclaration *profileDecl;
 
 public:
    explicit TofinoActionProfile(const IR::IDeclaration *profileDecl);
 
    cstring getObjectName() const override;

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

    const IR::IDeclaration *getProfileDecl() const;

    size_t getActionMapSize() const;

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

    const TofinoActionProfile *actionProfile;
 
 public:
    explicit TofinoActionSelector(const IR::IDeclaration *selectorDecl,
                                  const TofinoActionProfile *actionProfile);
 
    cstring getObjectName() const override;

    const IR::IDeclaration *getSelectorDecl() const;

    const TofinoActionProfile *getActionProfile() const;
 
    const TofinoActionSelector *evaluate(const Model &model, bool doComplete) const override;
 
    DECLARE_TYPEINFO(TofinoActionSelector, TestObject);
};
 
/* =========================================================================================
 * Table Key Match Types
 * ========================================================================================= */
 
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::Tofino
 
#endif /* BACKENDS_P4TOOLS_MODULES_TESTGEN_TARGETS_TOFINO_TEST_SPEC_H_ */