p4RuntimeSerializer.h

/*
 * SPDX-FileCopyrightText: 2013 Barefoot Networks, Inc.
 * Copyright 2013-present Barefoot Networks, Inc.
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef CONTROL_PLANE_P4RUNTIMESERIALIZER_H_
#define CONTROL_PLANE_P4RUNTIMESERIALIZER_H_
 
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wunused-parameter"
#pragma GCC diagnostic ignored "-Wpedantic"
#include <google/protobuf/util/json_util.h>
#pragma GCC diagnostic pop
 
#include <iosfwd>
#include <unordered_map>
 
#include "lib/cstring.h"
#include "p4RuntimeTypes.h"
 
namespace p4 {
namespace config {
namespace v1 {
class P4Info;
}  // namespace v1
}  // namespace config
namespace v1 {
class WriteRequest;
}  // namespace v1
}  // namespace p4
 
namespace P4::IR {
class P4Program;
}  // namespace P4::IR
 
namespace P4 {
class CompilerOptions;
}  // namespace P4
 
namespace P4 {
 
using namespace literals;

struct P4RuntimeAPI {
    void serializeP4InfoTo(std::ostream *destination, P4RuntimeFormat format) const;
    void serializeEntriesTo(std::ostream *destination, P4RuntimeFormat format) const;

    const ::p4::config::v1::P4Info *p4Info;
    const ::p4::v1::WriteRequest *entries;
 
    // Print options to use while outputting JSON.
    google::protobuf::util::JsonPrintOptions jsonPrintOptions;
 
    P4RuntimeAPI(const ::p4::config::v1::P4Info *p4Info, const ::p4::v1::WriteRequest *entries)
        : p4Info(p4Info), entries(entries) {
        jsonPrintOptions.add_whitespace = true;
    }
 
    P4RuntimeAPI(const ::p4::config::v1::P4Info *p4Info, const ::p4::v1::WriteRequest *entries,
                 google::protobuf::util::JsonPrintOptions jsonPrintOptions)
        : p4Info(p4Info), entries(entries), jsonPrintOptions(jsonPrintOptions) {}
};
 
namespace ControlPlaneAPI {
struct P4RuntimeArchHandlerBuilderIface;
}  // namespace ControlPlaneAPI

class P4RuntimeSerializer {
 public:
    static P4RuntimeSerializer *get();
 
    void registerArch(const cstring archName,
                      const ControlPlaneAPI::P4RuntimeArchHandlerBuilderIface *builder);

    P4RuntimeAPI generateP4Runtime(const IR::P4Program *program, cstring arch);

    void serializeP4RuntimeIfRequired(const IR::P4Program *program, const CompilerOptions &options);

    void serializeP4RuntimeIfRequired(const P4RuntimeAPI &p4Runtime,
                                      const CompilerOptions &options);

    static cstring resolveArch(const CompilerOptions &options);
 
 private:
    P4RuntimeSerializer();
 
    std::unordered_map<cstring, const ControlPlaneAPI::P4RuntimeArchHandlerBuilderIface *>
        archHandlerBuilders{};
};

P4RuntimeAPI generateP4Runtime(const IR::P4Program *program, cstring arch = "v1model"_cs);

void serializeP4RuntimeIfRequired(const IR::P4Program *program, const CompilerOptions &options);
 
}  // namespace P4
 
#endif /* CONTROL_PLANE_P4RUNTIMESERIALIZER_H_ */