1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
|
// SPDX-License-Identifier: ISC
//
// fpm.proto
//
// @copyright Copyright (C) 2016 Sproute Networks, Inc.
//
// @author Avneesh Sachdev <avneesh@sproute.com>
//
// Portions:
// Copyright (C) 2024 Carmine Scarpitta (for SRv6)
//
// Permission to use, copy, modify, and/or distribute this software
// for any purpose with or without fee is hereby granted, provided
// that the above copyright notice and this permission notice appear
// in all copies.
//
// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
// WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
// WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
// AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR
// CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
// OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
// NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
// CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
//
syntax = "proto2";
//
// Protobuf definitions pertaining to the Forwarding Plane Manager component.
//
package fpm;
import "qpb/qpb.proto";
//
// A Nexthop for a route. It indicates how packets to a given prefix
// should be forwarded (for instance, send them out of a specified
// interface to a specified address).
//
message Nexthop {
optional qpb.IfIdentifier if_id = 2;
optional qpb.L3Address address = 3;
}
message RouteKey {
optional qpb.L3Prefix prefix = 1;
}
message DeleteRoute {
required uint32 vrf_id = 1;
required qpb.AddressFamily address_family = 2;
required qpb.SubAddressFamily sub_address_family = 3;
required RouteKey key = 4;
}
enum RouteType {
UNKNOWN = 0;
NORMAL = 1;
UNREACHABLE = 2;
BLACKHOLE = 3;
}
message AddRoute {
required uint32 vrf_id = 1;
required qpb.AddressFamily address_family = 2;
required qpb.SubAddressFamily sub_address_family = 3;
required RouteKey key = 4;
optional RouteType route_type = 5;
required qpb.Protocol protocol = 6;
required int32 metric = 8;
repeated Nexthop nexthops = 9;
/* Source Address of outer encapsulating IPv6 header */
optional qpb.Ipv6Address srv6_encap_source_address = 10;
/* SRv6 SID for VPN use cases */
optional qpb.Ipv6Address srv6_vpn_sid = 11;
}
/* SID Format - as per RFC 8986 section #3.1 */
message SRv6SIDFormat
{
/* Locator block length */
required uint32 locator_block_length = 1;
/* Locator node length */
required uint32 locator_node_length = 2;
/* Function length */
required uint32 function_length = 3;
/* Argument length */
required uint32 argument_length = 4;
}
/* SRv6 Local SID */
message SRv6LocalSID
{
/* SRv6 SID value */
required qpb.Ipv6Address sid = 1;
/* SID Format - as per RFC 8986 section #3.1 */
optional SRv6SIDFormat sid_format = 2;
/* SRv6 Endpoint Behavior associated with the SID */
oneof end_behavior
{
/* Endpoint */
End end = 3;
/* Endpoint with L3 cross-connect */
EndX end_x = 4;
/* Endpoint with specific IPv6 table lookup */
EndT end_t = 5;
/* Endpoint with decapsulation and IPv6 cross-connect */
EndDX6 end_dx6 = 7;
/* Endpoint with decapsulation and IPv4 cross-connect */
EndDX4 end_dx4 = 8;
/* Endpoint with decapsulation and specific IPv6 table lookup */
EndDT6 end_dt6 = 9;
/* Endpoint with decapsulation and specific IPv4 table lookup */
EndDT4 end_dt4 = 10;
/* Endpoint with decapsulation and specific IP table lookup */
EndDT46 end_dt46 = 11;
/* Endpoint behavior with NEXT-CSID, PSP and USD flavors */
UN un = 12;
/* End.X behavior with NEXT-CSID, PSP and USD flavors */
UA ua = 13;
/* End.DT6 behavior with NEXT-CSID flavor */
UDT6 udt6 = 14;
/* End.DT4 behavior with NEXT-CSID flavor */
UDT4 udt4 = 15;
/* End.DT46 behavior with NEXT-CSID flavor */
UDT46 udt46 = 16;
}
/* Endpoint */
message End
{
}
/* Endpoint with L3 cross-connect */
message EndX
{
required Nexthop nexthop = 1;
}
/* Endpoint with specific IPv6 table lookup */
message EndT
{
required uint32 vrf_id = 1;
}
/* Endpoint with decapsulation and IPv6 cross-connect */
message EndDX6
{
required Nexthop nexthop = 1;
}
/* Endpoint with decapsulation and IPv4 cross-connect */
message EndDX4
{
required Nexthop nexthop = 1;
}
/* Endpoint with decapsulation and specific IPv6 table lookup */
message EndDT6
{
required uint32 vrf_id = 1;
}
/* Endpoint with decapsulation and specific IPv4 table lookup */
message EndDT4
{
required uint32 vrf_id = 1;
}
/* Endpoint with decapsulation and specific IP table lookup */
message EndDT46
{
required uint32 vrf_id = 1;
}
/* Endpoint behavior with NEXT-CSID, PSP and USD flavors */
message UN
{
}
/* End.X behavior with NEXT-CSID, PSP and USD flavors */
message UA
{
required Nexthop nexthop = 1;
}
/* End.DT6 behavior with NEXT-CSID flavor */
message UDT6
{
required uint32 vrf_id = 1;
}
/* End.DT4 behavior with NEXT-CSID flavor */
message UDT4
{
required uint32 vrf_id = 1;
}
/* End.DT46 behavior with NEXT-CSID flavor */
message UDT46
{
required uint32 vrf_id = 1;
}
}
//
// Any message from the FPM.
//
message Message {
enum Type {
UNKNOWN_MSG = 0;
ADD_ROUTE = 1;
DELETE_ROUTE = 2;
/* Install an SRv6 Local SID */
ADD_SRV6_LOCALSID = 3;
/* Remove an SRv6 Local SID */
DELETE_SRV6_LOCALSID = 4;
};
optional Type type = 1;
optional AddRoute add_route = 2;
optional DeleteRoute delete_route = 3;
/* SRv6 Local SID */
optional SRv6LocalSID srv6_localsid = 4;
}
|
