frontends/common/options.h

/*
 * SPDX-FileCopyrightText: 2013 Barefoot Networks, Inc.
 * Copyright 2013-present Barefoot Networks, Inc.
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
/* -*-C++-*- */
 
#ifndef FRONTENDS_COMMON_OPTIONS_H_
#define FRONTENDS_COMMON_OPTIONS_H_
 
#include <filesystem>
#include <unordered_set>
 
#include "parser_options.h"
// for p4::P4RuntimeFormat definition
#include "control-plane/p4RuntimeTypes.h"
 
namespace P4 {
 
class CompilerOptions : public ParserOptions {
 protected:
    bool validateOptions() const override;
 
 public:
    explicit CompilerOptions(std::string_view defaultMessage = "Compile a P4 program");
 
    // If true, skip frontend passes whose names are contained in
    // passesToExcludeFrontend vector.
    bool excludeFrontendPasses = false;
    bool listFrontendPasses = false;
    // If true, skip midend passes whose names are contained in
    // passesToExcludeMidend vector.
    bool excludeMidendPasses = false;
    bool listMidendPasses = false;
    // If true, skip backend passes whose names are contained in
    // passesToExcludeBackend vector.
    bool excludeBackendPasses = false;
    // Strings matched against pass names that should be excluded from frontend
    // passes.
    std::vector<cstring> passesToExcludeFrontend;
    // Strings matched against pass names that should be excluded from midend
    // passes.
    std::vector<cstring> passesToExcludeMidend;
    // Strings matched against pass names that should be excluded from backend
    // passes.
    std::vector<cstring> passesToExcludeBackend;
    // Dump a JSON representation of the IR in the file.
    std::filesystem::path dumpJsonFile;
    // Dump and undump the IR tree.
    bool debugJson = false;
    // if this flag is true, compile program in non-debug mode.
    bool ndebug = false;
    // Write a P4Runtime control plane API description to the specified file.
    cstring p4RuntimeFile = nullptr;
    // Write static table entries as a P4Runtime WriteRequest message to the
    // specified file.
    cstring p4RuntimeEntriesFile = nullptr;
    // Write P4Runtime control plane API description to the specified files.
    cstring p4RuntimeFiles = nullptr;
    // Write static table entries as a P4Runtime WriteRequest message to the
    // specified files.
    cstring p4RuntimeEntriesFiles = nullptr;
    // Choose format for P4Runtime API description.
    P4::P4RuntimeFormat p4RuntimeFormat = P4::P4RuntimeFormat::BINARY;
    // Pretty-print the program in the specified file.
    std::filesystem::path prettyPrintFile;
    // Target.
    cstring target = nullptr;
    // Architecture.
    cstring arch = nullptr;
    // If true, unroll all parser loops inside the midend.
    bool loopsUnrolling = false;
    // List of code metrics input by user.
    cstring inputMetrics = nullptr;
    // Code metrics to be collected.
    std::set<cstring> selectedMetrics;
 
    // General optimization options -- can be interpreted by backends in various ways
    int optimizationLevel = 1;
    bool optimizeDebug = false;  // optimize favoring debuggability
    bool optimizeSize = false;   // optimize favoring size
 
    virtual bool enable_intrinsic_metadata_fix();

    virtual bool controlPlaneAPIGenEnabled() const {
        if (p4RuntimeFile.isNullOrEmpty() && p4RuntimeFiles.isNullOrEmpty() &&
            p4RuntimeEntriesFile.isNullOrEmpty() && p4RuntimeEntriesFiles.isNullOrEmpty()) {
            return false;
        }
        return true;
    }
};
 
}  // namespace P4
 
#endif /* FRONTENDS_COMMON_OPTIONS_H_ */