core/small_step/table_stepper.h

/*
 * SPDX-FileCopyrightText: 2022 The P4 Language Consortium
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef BACKENDS_P4TOOLS_MODULES_TESTGEN_CORE_SMALL_STEP_TABLE_STEPPER_H_
#define BACKENDS_P4TOOLS_MODULES_TESTGEN_CORE_SMALL_STEP_TABLE_STEPPER_H_
 
#include <cstddef>
#include <optional>
#include <vector>
 
#include "backends/p4tools/common/lib/table_utils.h"
#include "ir/ir.h"
#include "lib/cstring.h"
 
#include "backends/p4tools/modules/testgen/core/program_info.h"
#include "backends/p4tools/modules/testgen/core/small_step/expr_stepper.h"
#include "backends/p4tools/modules/testgen/lib/execution_state.h"
#include "backends/p4tools/modules/testgen/lib/test_spec.h"
 
namespace P4::P4Tools::P4Testgen {

class TableStepper {
 protected:
    ExprStepper *stepper;

    const IR::P4Table *table;

    TableUtils::TableProperties properties;
 
 public:
    /* =========================================================================================
     * Table Variable Getter functions
     * ========================================================================================= */
    static const IR::StateVariable &getTableStateVariable(
        const IR::Type *type, const IR::P4Table *table, cstring name,
        std::optional<int> idx1_opt = std::nullopt, std::optional<int> idx2_opt = std::nullopt);

    static const IR::StateVariable &getActiveTableVar();

    static const IR::StateVariable &getTableHitVar(const IR::P4Table *table);

    static const IR::StateVariable &getTableActionVar(const IR::P4Table *table);
 
    static const IR::StateVariable &getTableResultVar(const IR::P4Table *table);
 
 protected:
    /* =========================================================================================
     * Table Utility functions
     * ========================================================================================= */
    const ExecutionState *getExecutionState();

    const ProgramInfo *getProgramInfo();

    ExprStepper::Result getResult();

    void addDefaultAction(std::optional<const IR::Expression *> tableMissCondition);

    std::vector<const IR::ActionListElement *> buildTableActionList();

    static const IR::StringLiteral *getTableActionString(
        const IR::MethodCallExpression *actionCall);

    bool resolveTableKeys();

    virtual const IR::Expression *computeTargetMatchType(
        const TableUtils::KeyProperties &keyProperties, TableMatchMap *matches,
        const IR::Expression *hitCondition);

    const IR::Expression *computeHit(TableMatchMap *matches);

    virtual void checkTargetProperties(
        const std::vector<const IR::ActionListElement *> &tableActionList);
 
    /* =========================================================================================
     * Table Evaluation functions
     * ========================================================================================= */
    void evalTableCall();

    const IR::Expression *evalTableConstEntries();

    void evalTableControlEntries(const std::vector<const IR::ActionListElement *> &tableActionList);

    void evalTaintedTable();

    virtual void evalTargetTable(const std::vector<const IR::ActionListElement *> &tableActionList);
 
    void setTableDefaultEntries(const std::vector<const IR::ActionListElement *> &tableActionList);
 
 public:
    bool eval();
 
    explicit TableStepper(ExprStepper *stepper, const IR::P4Table *table);
 
    virtual ~TableStepper() = default;
};
 
}  // namespace P4::P4Tools::P4Testgen
 
#endif /* BACKENDS_P4TOOLS_MODULES_TESTGEN_CORE_SMALL_STEP_TABLE_STEPPER_H_ */