7#ifndef BACKENDS_EBPF_PSA_EBPFPIPELINE_H_
8#define BACKENDS_EBPF_PSA_EBPFPIPELINE_H_
10#include "backends/ebpf/ebpfProgram.h"
11#include "backends/ebpf/target.h"
12#include "ebpfPsaControl.h"
13#include "ebpfPsaDeparser.h"
45 cstring cpumapUserMetadataField =
"cpumap_usermeta"_cs;
52 :
EBPFProgram(options, nullptr, refMap, typeMap, nullptr),
58 functionName =
name.replace(
'-',
'_') +
"_func";
59 errorEnum =
"ParserError_t"_cs;
60 packetStartVar =
"pkt"_cs;
61 headerStartVar =
"hdr_start"_cs;
63 lengthVar =
"pkt_len"_cs;
64 endLabel =
"deparser"_cs;
71 oneKey = EBPFModel::reserved(
"one"_cs);
80 virtual cstring dropReturnCode() {
86 return "TC_ACT_SHOT"_cs;
88 virtual cstring forwardReturnCode() {
94 return "TC_ACT_OK"_cs;
97 virtual void emit(CodeBuilder *builder) = 0;
98 virtual void emitTrafficManager(CodeBuilder *builder) = 0;
99 virtual void emitPSAControlInputMetadata(CodeBuilder *builder) = 0;
100 virtual void emitPSAControlOutputMetadata(CodeBuilder *builder) = 0;
116 virtual void emitCPUMAPInitializers(CodeBuilder *builder);
117 virtual void emitCPUMAPLookup(CodeBuilder *builder);
122 virtual void emitPacketLength(CodeBuilder *builder);
123 virtual void emitTimestamp(CodeBuilder *builder);
124 void emitInputPortMapping(CodeBuilder *builder);
126 void emitHeadersFromCPUMAP(CodeBuilder *builder);
127 void emitMetadataFromCPUMAP(CodeBuilder *builder);
129 bool hasAnyMeter()
const {
130 auto directMeter = std::find_if(control->tables.begin(), control->tables.end(),
131 [](std::pair<const cstring, EBPFTable *> elem) {
132 return !elem.second->to<EBPFTablePSA>()->meters.empty();
134 bool anyDirectMeter = directMeter != control->tables.end();
135 return anyDirectMeter || (!control->meters.empty());
149class EBPFIngressPipeline :
public EBPFPipeline {
151 unsigned int maxResubmitDepth;
158 : EBPFPipeline(
name, options, refMap, typeMap) {
160 maxResubmitDepth = 4;
166 void emitSharedMetadataInitializer(
CodeBuilder *builder);
169 void emitPSAControlInputMetadata(
CodeBuilder *builder)
override;
170 void emitPSAControlOutputMetadata(
CodeBuilder *builder)
override;
177class EBPFEgressPipeline :
public EBPFPipeline {
181 : EBPFPipeline(
name, options, refMap, typeMap) {}
184 void emitPSAControlInputMetadata(
CodeBuilder *builder)
override;
185 void emitPSAControlOutputMetadata(
CodeBuilder *builder)
override;
186 void emitCPUMAPLookup(
CodeBuilder *builder)
override;
188 virtual void emitCheckPacketMarkMetadata(
CodeBuilder *builder) = 0;
190 DECLARE_TYPEINFO(EBPFEgressPipeline, EBPFPipeline);
193class TCIngressPipeline :
public EBPFIngressPipeline {
197 : EBPFIngressPipeline(
name, options, refMap, typeMap) {}
207 void emitTCWorkaroundUsingMeta(
CodeBuilder *builder);
208 void emitTCWorkaroundUsingHead(
CodeBuilder *builder);
209 void emitTCWorkaroundUsingCPUMAP(
CodeBuilder *builder);
211 DECLARE_TYPEINFO(TCIngressPipeline, EBPFIngressPipeline);
214class TCEgressPipeline :
public EBPFEgressPipeline {
218 : EBPFEgressPipeline(
name, options, refMap, typeMap) {}
220 void emitTrafficManager(
CodeBuilder *builder)
override;
221 void emitCheckPacketMarkMetadata(
CodeBuilder *builder)
override;
223 DECLARE_TYPEINFO(TCEgressPipeline, EBPFEgressPipeline);
226class XDPIngressPipeline :
public EBPFIngressPipeline {
230 : EBPFIngressPipeline(
name, options, refMap, typeMap) {
234 progTarget =
new XdpTarget(options.emitTraceMessages);
238 void emitTrafficManager(
CodeBuilder *builder)
override;
240 DECLARE_TYPEINFO(XDPIngressPipeline, EBPFIngressPipeline);
243class XDPEgressPipeline :
public EBPFEgressPipeline {
247 : EBPFEgressPipeline(
name, options, refMap, typeMap) {
252 pktInstanceVar =
"0"_cs;
254 progTarget =
new XdpTarget(options.emitTraceMessages);
258 void emitTrafficManager(
CodeBuilder *builder)
override;
259 void emitCheckPacketMarkMetadata(
CodeBuilder *builder)
override;
261 DECLARE_TYPEINFO(XDPEgressPipeline, EBPFEgressPipeline);
264class TCTrafficManagerForXDP :
public TCIngressPipeline {
268 : TCIngressPipeline(
name, options, refMap, typeMap) {}
274 void emitReadXDP2TCMetadataFromHead(
CodeBuilder *builder);
275 void emitReadXDP2TCMetadataFromCPUMAP(
CodeBuilder *builder);
277 DECLARE_TYPEINFO(TCTrafficManagerForXDP, TCIngressPipeline);
Definition ebpf/codeGen.h:24
Definition ebpfPsaControl.h:53
Definition ebpfPsaDeparser.h:29
Definition ebpfPipeline.h:149
int actUnspecCode
Definition ebpfPipeline.h:154
EBPFPipeline represents a single eBPF program in the TC/XDP hook.
Definition ebpfPipeline.h:18
void emitLocalHeaderInstancesAsPointers(CodeBuilder *builder)
Generates a pointer to struct Headers_t and puts it on the BPF program's stack.
Definition ebpfPipeline.cpp:93
cstring name
A custom name of eBPF program.
Definition ebpfPipeline.h:21
void emitHeaderInstances(CodeBuilder *builder) override
Definition ebpfPipeline.cpp:105
cstring packetPathVar
Variables storing global metadata (packet_path & instance).
Definition ebpfPipeline.h:33
cstring inputPortVar
A variable to store ifindex after mapping (e.g. due to recirculation).
Definition ebpfPipeline.h:41
bool shouldEmitTimestamp() const
Definition ebpfPipeline.h:142
cstring ifindexVar
Variable storing ingress interface index.
Definition ebpfPipeline.h:29
cstring oneKey
A variable name storing "1" value. Used to access BPF array map index.
Definition ebpfPipeline.h:37
virtual void emitGlobalMetadataInitializer(CodeBuilder *builder)
Definition ebpfPipeline.cpp:142
cstring cpumapHeadersField
Fields of struct hdr_md that hold this pipeline's headers and user metadata.
Definition ebpfPipeline.h:44
void emitLocalVariables(CodeBuilder *builder) override
Generates a set of helper variables that are used during packet processing.
Definition ebpfPipeline.cpp:38
bool isEmpty() const
Definition ebpfPipeline.cpp:11
unsigned packetMark
A unique mark used to differentiate packets processed by P4/eBPF from others.
Definition ebpfPipeline.h:39
void emitCPUMAPHeadersInitializers(CodeBuilder *builder)
Generates a pointer to struct hdr_md. The pointer is used to access data from per-CPU map.
Definition ebpfPipeline.cpp:100
cstring sectionName
eBPF section name, which should a concatenation of classifier/ + a custom name.
Definition ebpfPipeline.h:23
cstring compilerGlobalMetadata
A name of an internal variable storing global metadata.
Definition ebpfPipeline.h:35
cstring timestampVar
Variable name storing current timestamp retrieved from bpf_ktime_get_ns().
Definition ebpfPipeline.h:27
cstring priorityVar
Variable storing skb->priority value (TC only).
Definition ebpfPipeline.h:31
void emitUserMetadataInstance(CodeBuilder *builder)
Definition ebpfPipeline.cpp:82
cstring contextVar
Variable name storing pointer to eBPF packet descriptor (e.g., __sk_buff).
Definition ebpfPipeline.h:25
Definition ebpfProgram.h:30
EBPFProgram(const EbpfOptions &options, const IR::P4Program *program, P4::ReferenceMap *refMap, P4::TypeMap *typeMap, const IR::ToplevelBlock *toplevel)
return 'true' on success
Definition ebpfProgram.h:56
Definition ebpf/target.h:121
void emitTrafficManager(CodeBuilder *builder) override
Definition ebpfPipeline.cpp:559
void emitGlobalMetadataInitializer(CodeBuilder *builder) override
Definition ebpfPipeline.cpp:474
void emitResetUnmarkedGlobalMetadata(CodeBuilder *builder)
Clears the global metadata of a packet that this pipeline has not marked yet.
Definition ebpfPipeline.cpp:461
void emitGlobalMetadataInitializer(CodeBuilder *builder) override
Definition ebpfPipeline.cpp:753
void emitGlobalMetadataInitializer(CodeBuilder *builder) override
Definition ebpfPipeline.cpp:709
void emitGlobalMetadataInitializer(CodeBuilder *builder) override
Definition ebpfPipeline.cpp:685
Target XDP.
Definition ebpf/target.h:240
Definition ebpfOptions.h:17
Class used to encode maps from paths to declarations.
Definition referenceMap.h:58
Definition codeGen.cpp:14