frontends/p4/frontend.h

/*
 * SPDX-FileCopyrightText: 2013 Barefoot Networks, Inc.
 * Copyright 2013-present Barefoot Networks, Inc.
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef FRONTENDS_P4_FRONTEND_H_
#define FRONTENDS_P4_FRONTEND_H_
 
#include "../common/options.h"
#include "ir/ir.h"
#include "parseAnnotations.h"
#include "unusedDeclarations.h"
 
namespace P4 {
 
class ConstantFoldingPolicy;    // forward declare to avoid having to include
class StrengthReductionPolicy;  // forward declare to avoid having to include

class FrontEndPolicy : public RemoveUnusedPolicy {
 public:
    virtual ~FrontEndPolicy() = default;

    virtual std::vector<DebugHook> getDebugHooks() const { return {}; }

    virtual ParseAnnotations *getParseAnnotations() const { return nullptr; }

    virtual bool removeOpAssign() const { return true; }

    // TODO: This should probably not be allowed to be skipped at all.
    virtual bool skipSideEffectOrdering() const { return false; }

    virtual bool foldInlinedFrom() const { return true; }

    virtual bool optimize(const CompilerOptions &options) const {
        return options.optimizationLevel > 0;
    }

    virtual ConstantFoldingPolicy *getConstantFoldingPolicy() const { return nullptr; }

    virtual StrengthReductionPolicy *getStrengthReductionPolicy() const { return nullptr; }
};
 
class FrontEnd {
    FrontEndPolicy *policy;
    std::vector<DebugHook> hooks;
 
 public:
    FrontEnd() : FrontEnd(new FrontEndPolicy()) {}
    explicit FrontEnd(FrontEndPolicy *policy) : policy(policy), hooks(policy->getDebugHooks()) {}
 
    void addDebugHook(const DebugHook &hook) { hooks.push_back(hook); }
    // If p4c is run with option '--listFrontendPasses', outStream is used for printing passes names
    const IR::P4Program *run(const CompilerOptions &options, const IR::P4Program *program,
                             std::ostream *outStream = nullptr);
};
 
}  // namespace P4
 
#endif /* FRONTENDS_P4_FRONTEND_H_ */