tofino/test_backend/ptf.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_BACKEND_PTF_H_
#define BACKENDS_P4TOOLS_MODULES_TESTGEN_TARGETS_TOFINO_TEST_BACKEND_PTF_H_
 
#include <cstddef>
#include <fstream>
#include <optional>
#include <string>
#include <utility>
#include <vector>
 
#include <inja/inja.hpp>
 
#include "ir/ir.h"
#include "lib/cstring.h"
 
#include "backends/p4tools/modules/testgen/lib/test_framework.h"
 
namespace P4::P4Tools::P4Testgen::Tofino {

class PTF : public TestFramework {
    bool preambleEmitted = false;

    std::ofstream ptfFileStream;
 
 public:
    ~PTF() override = default;
 
    PTF(const PTF &) = delete;
 
    PTF(PTF &&) = delete;
 
    PTF &operator=(const PTF &) = delete;
 
    PTF &operator=(PTF &&) = delete;
 
    explicit PTF(const TestBackendConfiguration &testBackendConfiguration);

    void writeTestToFile(const TestSpec *spec, cstring selectedBranches, size_t testIdx,
                         float currentCoverage) override;
 
 private:
    void emitPreamble();

    void emitTestcase(const TestSpec *testSpec, cstring selectedBranches, size_t testIdx,
                      const std::string &testCase, float currentCoverage);

    static std::string getTestCaseTemplate();

    static inja::json getControlPlane(const TestSpec *testSpec);

    static inja::json getSend(const TestSpec *testSpec);

    static inja::json getVerify(const TestSpec *testSpec);

    static std::vector<std::pair<size_t, size_t>> getIgnoreMasks(const IR::Constant *mask);

    static inja::json getControlPlaneForTable(const TableMatchMap &matches,
                                              const std::vector<ActionArg> &args);
};
 
}  // namespace P4::P4Tools::P4Testgen::Tofino
 
#endif /* BACKENDS_P4TOOLS_MODULES_TESTGEN_TARGETS_TOFINO_TEST_BACKEND_PTF_H_ */