aboutsummaryrefslogtreecommitdiffstats
path: root/src/vnet/flow/flow_types.api
blob: 86f7ce128cb45f2a5f34404afe5cfc3f7a962a8c (plain)
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
237
238
239
240
241
242
/* Hey Emacs use -*- mode: C -*- */
/*
 * Copyright (c) 2020 Intel and/or its affiliates.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at:
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

option version = "0.0.3";
import "vnet/ethernet/ethernet_types.api";
import "vnet/ip/ip_types.api";

enum flow_type
{
  FLOW_TYPE_ETHERNET = 1,
  FLOW_TYPE_IP4,
  FLOW_TYPE_IP6,
  FLOW_TYPE_IP4_L2TPV3OIP,
  FLOW_TYPE_IP4_IPSEC_ESP,
  FLOW_TYPE_IP4_IPSEC_AH,
  FLOW_TYPE_IP4_N_TUPLE,
  FLOW_TYPE_IP6_N_TUPLE,
  FLOW_TYPE_IP4_N_TUPLE_TAGGED,
  FLOW_TYPE_IP6_N_TUPLE_TAGGED,
  FLOW_TYPE_IP4_VXLAN,
  FLOW_TYPE_IP6_VXLAN,
  FLOW_TYPE_IP4_GTPC,
  FLOW_TYPE_IP4_GTPU,
};

enum flow_action
{
  FLOW_ACTION_COUNT = 1,
  FLOW_ACTION_MARK = 2,
  FLOW_ACTION_BUFFER_ADVANCE = 4,
  FLOW_ACTION_REDIRECT_TO_NODE = 8,
  FLOW_ACTION_REDIRECT_TO_QUEUE = 16,
  FLOW_ACTION_DROP = 64,
};

typedef ip_port_and_mask
{
  u16 port;
  u16 mask;
};

typedef ip_prot_and_mask
{
  vl_api_ip_proto_t prot;
  u8 mask;
};

typedef flow_ethernet
{
  i32 foo;
  vl_api_mac_address_t src_addr;
  vl_api_mac_address_t dst_addr;
  u16 type;
};

typedef flow_ip4
{
  i32 foo;
  vl_api_ip4_address_and_mask_t src_addr;
  vl_api_ip4_address_and_mask_t dst_addr;
  vl_api_ip_prot_and_mask_t protocol;
};

typedef flow_ip6
{
  i32 foo;
  vl_api_ip6_address_and_mask_t src_addr;
  vl_api_ip6_address_and_mask_t dst_addr;
  vl_api_ip_prot_and_mask_t protocol;
};

typedef flow_ip4_n_tuple
{
  i32 foo;
  vl_api_ip4_address_and_mask_t src_addr;
  vl_api_ip4_address_and_mask_t dst_addr;
  vl_api_ip_prot_and_mask_t protocol;
  vl_api_ip_port_and_mask_t src_port;
  vl_api_ip_port_and_mask_t dst_port;
};

typedef flow_ip6_n_tuple
{
  i32 foo;
  vl_api_ip6_address_and_mask_t src_addr;
  vl_api_ip6_address_and_mask_t dst_addr;
  vl_api_ip_prot_and_mask_t protocol;
  vl_api_ip_port_and_mask_t src_port;
  vl_api_ip_port_and_mask_t dst_port;
};

typedef flow_ip4_n_tuple_tagged
{
  i32 foo;
  vl_api_ip4_address_and_mask_t src_addr;
  vl_api_ip4_address_and_mask_t dst_addr;
  vl_api_ip_prot_and_mask_t protocol;
  vl_api_ip_port_and_mask_t src_port;
  vl_api_ip_port_and_mask_t dst_port;
};

typedef flow_ip6_n_tuple_tagged
{
  i32 foo;
  vl_api_ip6_address_and_mask_t src_addr;
  vl_api_ip6_address_and_mask_t dst_addr;
  vl_api_ip_prot_and_mask_t protocol;
  vl_api_ip_port_and_mask_t src_port;
  vl_api_ip_port_and_mask_t dst_port;
};

typedef flow_ip4_l2tpv3oip
{
  i32 foo;
  vl_api_ip4_address_and_mask_t src_addr;
  vl_api_ip4_address_and_mask_t dst_addr;
  vl_api_ip_prot_and_mask_t protocol;
  u32 session_id;
};

typedef flow_ip4_ipsec_esp
{
  i32 foo;
  vl_api_ip4_address_and_mask_t src_addr;
  vl_api_ip4_address_and_mask_t dst_addr;
  vl_api_ip_prot_and_mask_t protocol;
  u32 spi;
};

typedef flow_ip4_ipsec_ah
{
  i32 foo;
  vl_api_ip4_address_and_mask_t src_addr;
  vl_api_ip4_address_and_mask_t dst_addr;
  vl_api_ip_prot_and_mask_t protocol;
  u32 spi;
};

typedef flow_ip4_vxlan
{
  i32 foo;
  vl_api_ip4_address_and_mask_t src_addr;
  vl_api_ip4_address_and_mask_t dst_addr;
  vl_api_ip_prot_and_mask_t protocol;
  vl_api_ip_port_and_mask_t src_port;
  vl_api_ip_port_and_mask_t dst_port;
  u32 vni;
};

typedef flow_ip6_vxlan
{
  i32 foo;
  vl_api_ip6_address_and_mask_t src_addr;
  vl_api_ip6_address_and_mask_t dst_addr;
  vl_api_ip_prot_and_mask_t protocol;
  vl_api_ip_port_and_mask_t src_port;
  vl_api_ip_port_and_mask_t dst_port;
  u32 vni;
};

typedef flow_ip4_gtpc
{
  i32 foo;
  vl_api_ip4_address_and_mask_t src_addr;
  vl_api_ip4_address_and_mask_t dst_addr;
  vl_api_ip_prot_and_mask_t protocol;
  vl_api_ip_port_and_mask_t src_port;
  vl_api_ip_port_and_mask_t dst_port;
  u32 teid;
};

typedef flow_ip4_gtpu
{
  i32 foo;
  vl_api_ip4_address_and_mask_t src_addr;
  vl_api_ip4_address_and_mask_t dst_addr;
  vl_api_ip_prot_and_mask_t protocol;
  vl_api_ip_port_and_mask_t src_port;
  vl_api_ip_port_and_mask_t dst_port;
  u32 teid;
};

union flow
{
  vl_api_flow_ethernet_t ethernet;
  vl_api_flow_ip4_t ip4;
  vl_api_flow_ip6_t ip6;
  vl_api_flow_ip4_l2tpv3oip_t ip4_l2tpv3oip;
  vl_api_flow_ip4_ipsec_esp_t ip4_ipsec_esp;
  vl_api_flow_ip4_ipsec_ah_t ip4_ipsec_ah;
  vl_api_flow_ip4_n_tuple_t ip4_n_tuple;
  vl_api_flow_ip6_n_tuple_t ip6_n_tuple;
  vl_api_flow_ip4_n_tuple_tagged_t ip4_n_tuple_tagged;
  vl_api_flow_ip6_n_tuple_tagged_t ip6_n_tuple_tagged;
  vl_api_flow_ip4_vxlan_t ip4_vxlan;
  vl_api_flow_ip6_vxlan_t ip6_vxlan;
  vl_api_flow_ip4_gtpc_t ip4_gtpc;
  vl_api_flow_ip4_gtpu_t ip4_gtpu;
};

/* main flow struct */
typedef flow_rule
{
  /* flow type */
  vl_api_flow_type_t type;
  
  /* flow index */
  u32 index;
  
  /* bitmap of flow actions (FLOW_ACTION_*) */
  vl_api_flow_action_t actions;

  /* flow id for VNET_FLOW_ACTION_MARK */
  u32 mark_flow_id;

  /* node index and next index for FLOW_ACTION_REDIRECT_TO_NODE */
  u32 redirect_node_index;
  u32 redirect_device_input_next_index;

  /* queue for FLOW_ACTION_REDIRECT_TO_QUEUE */
  u32 redirect_queue;

  /* buffer offset for FLOW_ACTION_BUFFER_ADVANCE */
  i32 buffer_advance;
  
  /* flow enum */
  vl_api_flow_t flow;
};