P4C
The P4 Compiler
Loading...
Searching...
No Matches
p4RuntimeSerializer.h
1/*
2 * SPDX-FileCopyrightText: 2013 Barefoot Networks, Inc.
3 * Copyright 2013-present Barefoot Networks, Inc.
4 *
5 * SPDX-License-Identifier: Apache-2.0
6 */
7
8#ifndef CONTROL_PLANE_P4RUNTIMESERIALIZER_H_
9#define CONTROL_PLANE_P4RUNTIMESERIALIZER_H_
10
11#pragma GCC diagnostic push
12#pragma GCC diagnostic ignored "-Wunused-parameter"
13#pragma GCC diagnostic ignored "-Wpedantic"
14#include <google/protobuf/util/json_util.h>
15#pragma GCC diagnostic pop
16
17#include <iosfwd>
18#include <memory>
19#include <unordered_map>
20
21#include "lib/cstring.h"
22#include "p4RuntimeTypes.h"
23
24namespace p4 {
25namespace config {
26namespace v1 {
27class P4Info;
28} // namespace v1
29} // namespace config
30namespace v1 {
31class WriteRequest;
32} // namespace v1
33} // namespace p4
34
35namespace P4::IR {
36class P4Program;
37} // namespace P4::IR
38
39namespace P4 {
40class CompilerOptions;
41} // namespace P4
42
43namespace P4 {
44
45using namespace literals;
46
49struct P4RuntimeAPI {
52 void serializeP4InfoTo(std::ostream *destination, P4RuntimeFormat format) const;
55 void serializeEntriesTo(std::ostream *destination, P4RuntimeFormat format) const;
56
59 std::shared_ptr<const ::p4::config::v1::P4Info> p4Info;
62 std::shared_ptr<const ::p4::v1::WriteRequest> entries;
63
64 // Print options to use while outputting JSON.
65 google::protobuf::util::JsonPrintOptions jsonPrintOptions;
66
67 P4RuntimeAPI(std::shared_ptr<const ::p4::config::v1::P4Info> p4Info,
68 std::shared_ptr<const ::p4::v1::WriteRequest> entries)
69 : p4Info(std::move(p4Info)), entries(std::move(entries)) {
70 jsonPrintOptions.add_whitespace = true;
71 }
72
73 P4RuntimeAPI(std::shared_ptr<const ::p4::config::v1::P4Info> p4Info,
74 std::shared_ptr<const ::p4::v1::WriteRequest> entries,
75 google::protobuf::util::JsonPrintOptions jsonPrintOptions)
76 : p4Info(std::move(p4Info)),
77 entries(std::move(entries)),
78 jsonPrintOptions(jsonPrintOptions) {}
79};
80
81namespace ControlPlaneAPI {
83} // namespace ControlPlaneAPI
84
86class P4RuntimeSerializer {
87 public:
88 static P4RuntimeSerializer *get();
89
90 void registerArch(const cstring archName,
92
105 P4RuntimeAPI generateP4Runtime(const IR::P4Program *program, cstring arch);
106
116 void serializeP4RuntimeIfRequired(const IR::P4Program *program, const CompilerOptions &options);
117
126 void serializeP4RuntimeIfRequired(const P4RuntimeAPI &p4Runtime,
127 const CompilerOptions &options);
128
131 static cstring resolveArch(const CompilerOptions &options);
132
133 private:
134 P4RuntimeSerializer();
135
136 std::unordered_map<cstring,
137 std::shared_ptr<const ControlPlaneAPI::P4RuntimeArchHandlerBuilderIface>>
138 archHandlerBuilders{};
139};
140
143P4RuntimeAPI generateP4Runtime(const IR::P4Program *program, cstring arch = "v1model"_cs);
144
147void serializeP4RuntimeIfRequired(const IR::P4Program *program, const CompilerOptions &options);
148
149} // namespace P4
150
151#endif /* CONTROL_PLANE_P4RUNTIMESERIALIZER_H_ */
Definition frontends/common/options.h:22
Definition cstring.h:76
static cstring resolveArch(const CompilerOptions &options)
Definition p4RuntimeSerializer.cpp:1655
void serializeP4InfoTo(std::ostream *destination, P4RuntimeFormat format) const
Definition p4RuntimeSerializer.cpp:1501
P4RuntimeAPI generateP4Runtime(const IR::P4Program *program, cstring arch)
Definition p4RuntimeSerializer.cpp:1670
void serializeP4RuntimeIfRequired(const IR::P4Program *program, const CompilerOptions &options)
Definition p4RuntimeSerializer.cpp:1578
P4RuntimeAPI generateP4Runtime(const IR::P4Program *program, cstring arch)
Definition p4RuntimeSerializer.cpp:1460
void serializeP4RuntimeIfRequired(const IR::P4Program *program, const CompilerOptions &options)
Definition p4RuntimeSerializer.cpp:1674
void serializeEntriesTo(std::ostream *destination, P4RuntimeFormat format) const
Definition p4RuntimeSerializer.cpp:1522
TODO(antonin): High level goals of the generator go here!!
Definition dpdk/control-plane/bfruntime_arch_handler.h:44
Definition constantParsing.h:13
Definition cstring.h:71
TODO: this is not really specific to BMV2, it should reside somewhere else.
Definition applyOptionsPragmas.cpp:13
P4RuntimeFormat
P4Runtime serialization formats.
Definition p4RuntimeTypes.h:14
STL namespace.
Definition p4RuntimeArchHandler.h:195
Definition p4RuntimeSerializer.h:49
std::shared_ptr< const ::p4::config::v1::P4Info > p4Info
Definition p4RuntimeSerializer.h:59
std::shared_ptr< const ::p4::v1::WriteRequest > entries
Definition p4RuntimeSerializer.h:62