coverage.h

/*
 * SPDX-FileCopyrightText: 2022 The P4 Language Consortium
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef MIDEND_COVERAGE_H_
#define MIDEND_COVERAGE_H_
 
#include <set>
#include <vector>
 
#include "ir/ir.h"
#include "ir/visitor.h"
#include "lib/source_file.h"

 
namespace P4::Coverage {

struct SourceIdCmp {
    bool operator()(const IR::Node *s1, const IR::Node *s2) const;
};

struct CoverageOptions {
    bool coverStatements = false;
    bool coverTableEntries = false;
    bool coverActions = false;
    bool coverParserStates = false;

    bool onlyCoveringTests = false;
};

using CoverageSet = std::set<const IR::Node *, SourceIdCmp>;

class CollectNodes : public Inspector {
    CoverageSet coverableNodes;

    CoverageOptions coverageOptions;

    bool preorder(const IR::BaseAssignmentStatement *stmt) override;
    bool preorder(const IR::MethodCallStatement *stmt) override;
    bool preorder(const IR::ExitStatement *stmt) override;

    bool preorder(const IR::Entry *entry) override;

    bool preorder(const IR::P4Action *act) override;

    bool preorder(const IR::ParserState *state) override;
 
 public:
    explicit CollectNodes(CoverageOptions coverageOptions);

    const CoverageSet &getCoverableNodes();
};

void printCoverageReport(const CoverageSet &all, const CoverageSet &visited);

void logCoverage(const CoverageSet &all, const CoverageSet &visited, const CoverageSet &new_);
 
}  // namespace P4::Coverage
 
#endif /* MIDEND_COVERAGE_H_ */