FD.io VPP  v19.04.4-rc0-5-ge88582fac
Vector Packet Processing
map.api
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2016 Cisco and/or its affiliates.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at:
6  *
7  * http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15 
16 option version = "3.1.0";
17 
18 import "vnet/ip/ip_types.api";
19 
20 /** \brief Add MAP domains
21  @param client_index - opaque cookie to identify the sender
22  @param context - sender context, to match reply w/ request
23  @param ip6_prefix - Rule IPv6 prefix
24  @param ip4_prefix - Rule IPv4 prefix
25  @param ip6_src - MAP domain IPv6 BR address / Tunnel source
26  @param ea_bits_len - Embedded Address bits length
27  @param psid_offset - Port Set Identifider (PSID) offset
28  @param psid_length - PSID length
29  @param mtu - MTU
30  @param tag - A user field stored with the MAP
31 */
32 define map_add_domain
33 {
36  vl_api_ip6_prefix_t ip6_prefix;
37  vl_api_ip4_prefix_t ip4_prefix;
38  vl_api_ip6_prefix_t ip6_src;
43  string tag;
44 };
45 
46 /** \brief Reply for MAP domain add
47  @param context - returned sender context, to match reply w/ request
48  @param index - MAP domain index
49  @param retval - return code
50 */
51 define map_add_domain_reply
52 {
56 };
57 
58 /** \brief Delete MAP domain
59  @param client_index - opaque cookie to identify the sender
60  @param context - sender context, to match reply w/ request
61  @param index - MAP Domain index
62 */
63 autoreply define map_del_domain
64 {
68 };
69 
70 
71 /** \brief Add or Delete MAP rule from a domain (Only used for shared IPv4 per subscriber)
72  @param client_index - opaque cookie to identify the sender
73  @param context - sender context, to match reply w/ request
74  @param index - MAP Domain index
75  @param is_add - If 1 add rule, if 0 delete rule
76  @param ip6_dst - MAP CE IPv6 address
77  @param psid - Rule PSID
78 */
79 autoreply define map_add_del_rule
80 {
84  bool is_add;
87 };
88 
89 
90 /** \brief Get list of map domains
91  @param client_index - opaque cookie to identify the sender
92 */
93 define map_domain_dump
94 {
97 };
98 
99 /** \brief Details about a single MAP domain
100  @param context - returned sender context, to match reply w/ request
101  @param domain_index - MAP domain index
102  @param ip6_prefix - Rule IPv6 prefix
103  @param ip4_prefix - Rule IPv4 prefix
104  @param ip6_src - MAP domain IPv6 BR address / Tunnel source
105  @param ea_bits_len - Embedded Address bits length
106  @param psid_offset - Port Set Identifider (PSID) offset
107  @param psid_length - PSID length
108  @param flags -
109  @param mtu - MTU
110  @param tag - The user field stored with the MAP at creation time
111 */
112 define map_domain_details
113 {
116  vl_api_ip6_prefix_t ip6_prefix;
117  vl_api_ip4_prefix_t ip4_prefix;
118  vl_api_ip6_prefix_t ip6_src;
124  string tag;
125 };
126 
127 define map_rule_dump
128 {
132 };
133 
134 define map_rule_details
135 {
139 };
140 
141 /** \brief Enable or disable a MAP interface
142  @param client_index - opaque cookie to identify the sender
143  @param context - sender context, to match reply w/ request
144  @param sw_if_index -
145  @param is_enable - 0=disable, 1=enable interface
146  @param is_translation - 0=encapsulation, 1=translation
147 */
148 autoreply define map_if_enable_disable
149 {
153  bool is_enable;
154  bool is_translation; /* 0 - encapsulation, 1 - translation */
155 };
156 
157 /** \brief Request for a single block of summary stats
158  @param client_index - opaque cookie to identify the sender
159  @param context - sender context, to match reply w/ request
160 */
161 define map_summary_stats
162 {
165 };
166 
167 /** \brief Reply for map_summary_stats request
168  @param context - sender context, to match reply w/ request
169  @param retval - return code for request
170  @param total_bindings -
171  @param total_pkts -
172  @param total_ip4_fragments -
173  @param total_security_check -
174 */
175 define map_summary_stats_reply
176 {
180  u64 total_pkts[2];
181  u64 total_bytes[2];
183  u64 total_security_check[2];
184 };
185 
186 
187 /** \brief Set MAP fragmentation parameters
188  @param client_index - opaque cookie to identify the sender
189  @param context - sender context, to match reply w/ request
190  @param inner - 1=frag inner packet, 0=frag tunnel packets
191  @param ignore_df - 1=IP4 fragment despite DF bit, 0=honor DF
192 */
194 {
197  bool inner;
198  bool ignore_df;
199 };
200 
201 
202 /** \brief Set MAP ICMP parameters
203  @param client_index - opaque cookie to identify the sender
204  @param context - sender context, to match reply w/ request
205  @param icmp4_err_relay_src - IPv4 ICMP err relay src address
206 */
207 autoreply define map_param_set_icmp
208 {
212 };
213 
214 
215 /** \brief Set MAP ICMP6 parameters
216  @param client_index - opaque cookie to identify the sender
217  @param context - sender context, to match reply w/ request
218  @param enable_unreachable - 1 = send ICMP unreachable err msgs
219 */
220 autoreply define map_param_set_icmp6
221 {
225 };
226 
227 
228 /** \brief Add/delete MAP pre-resolve IP addresses parameters
229  @param client_index - opaque cookie to identify the sender
230  @param context - sender context, to match reply w/ request
231  @param is_add - 1 = Add non-zero IP addresses, 0 = delete
232  @param ip4_nh_address - direct IP4 next-hop address
233  @param ip6_nh_address - direct IP6 next-hop address
234 */
235 autoreply define map_param_add_del_pre_resolve
236 {
239  bool is_add;
242 };
243 
244 
245 /** \brief Set MAP reassembly parameters
246  @param client_index - opaque cookie to identify the sender
247  @param context - sender context, to match reply w/ request
248  @param is_ip6 - 1 = params apply to IPv6, 0 = params apply to IPv4
249  @param lifetime_ms - reassembly valid lifetime, or ~0
250  @param pool_size - max number of reassemblies, or ~0
251  @param buffers - max number of reassembly buffers, or ~0
252  @param ht_ratio - hash-table size factor, or ~0
253 */
254 autoreply define map_param_set_reassembly
255 {
258  bool is_ip6;
263 };
264 
265 
266 /** \brief Set MAP security-check parameters
267  @param client_index - opaque cookie to identify the sender
268  @param context - sender context, to match reply w/ request
269  @param enable - 1=enable security check on first inbound packet
270  @param fragments - 1=enable check on (subsequent) fragments too
271 */
273 {
276  bool enable;
277  bool fragments;
278 };
279 
280 
281 /** \brief Set MAP traffic class parameters
282  @param client_index - opaque cookie to identify the sender
283  @param context - sender context, to match reply w/ request
284  @param copy - 1 = copy packet class/TOS field, 0 = use class instead
285  @param class - class field value when copy == 0
286 */
288 {
291  bool copy;
292  u8 class;
293 };
294 
295 
296 /** \brief Set MAP TCP parammeters
297  @param client_index - opaque cookie to identify the sender
298  @param context - sender context, to match reply w/ request
299  @parma tcp_mss - TCP MSS clamping value
300 */
301 autoreply define map_param_set_tcp
302 {
306 };
307 
308 
309 /** \brief Request for a single block of MAP parameters
310  @param client_index - opaque cookie to identify the sender
311  @param context - sender context, to match reply w/ request
312 */
313 define map_param_get
314 {
317 };
318 
319 
320 /** \brief Reply for map_param_get request
321  @param context - sender context, to match reply w/ request
322  @param retval - return code for request
323  @param inner - 1=frag inner packet, 0=frag tunnel packets, ~0=untouched
324  @param ignore_df - 1=IP4 fragm despite DF bit, 0=honor DF, ~0=untouched
325  @param icmp_ip4_err_relay_src - IPv4 ICMP err relay src address
326  @param icmp6_enable_unreachable - 1 = send ICMP unreachable err msgs
327  @param ip4_nh_address - direct IP4 next-hop address
328  @param ip6_nh_address - direct IP6 next-hop address
329  @param ip4_lifetime_ms - reassembly valid lifetime, or ~0
330  @param ip4_pool_size - max number of reassemblies, or ~0
331  @param ip4_buffers - max number of reassembly buffers, or ~0
332  @param ip4_ht_ratio - reassembly valid lifetime, or ~0
333  @param ip6_lifetime_ms - max number of reassemblies, or ~0
334  @param ip6_pool_size - max number of reassemblies, or ~0
335  @param ip6_buffers - max number of reassembly buffers, or ~0
336  @param ip6_ht_ratio - hash-table size factor, or ~0
337  @param sec_check_enable - 1=enable security check on first inbound packet
338  @param sec_check_fragments - 1=enable check on (subsequent) fragments too
339  @param tc_copy - 1 = copy packet class/TOS field, 0 = use class instead
340  @param tc_class - class field value when copy == 0
341 */
342 define map_param_get_reply
343 {
362  bool tc_copy;
364 };
int map_param_set_icmp(ip4_address_t *ip4_err_relay_src)
Definition: map_api.c:306
int map_if_enable_disable(bool is_enable, u32 sw_if_index, bool is_translation)
Definition: map_api.c:632
vl_api_ip6_prefix_t ip6_src
Definition: map.api:38
unsigned long u64
Definition: types.h:89
u8 vl_api_ip6_address_t[16]
Conversion functions to/from (decode/encode) API types to VPP internal types.
Definition: ip_types_api.h:30
vl_api_ip6_prefix_t ip6_src
Definition: map.api:118
unsigned char u8
Definition: types.h:56
vl_api_ip6_address_t ip6_dst
Definition: map.api:85
double f64
Definition: types.h:142
vl_api_ip4_prefix_t ip4_prefix
Definition: map.api:37
unsigned int u32
Definition: types.h:88
int map_param_set_traffic_class(bool copy, u8 tc)
Definition: map_api.c:529
unsigned short u16
Definition: types.h:57
vl_api_ip4_address_t ip4_nh_address
Definition: map.api:350
vl_api_ip4_address_t ip4_nh_address
Definition: map.api:240
option version
Definition: map.api:16
vl_api_ip6_prefix_t ip6_prefix
Definition: map.api:116
u8 vl_api_ip4_address_t[4]
Definition: ip_types_api.h:31
vl_api_ip6_address_t ip6_nh_address
Definition: map.api:351
int map_param_set_fragmentation(bool inner, bool ignore_df)
Definition: map_api.c:281
vl_api_ip6_address_t ip6_dst
Definition: map.api:137
signed int i32
Definition: types.h:77
vl_api_ip6_address_t ip6_nh_address
Definition: map.api:241
int map_param_set_security_check(bool enable, bool fragments)
Definition: map_api.c:504
vl_api_ip4_address_t ip4_err_relay_src
Definition: map.api:211
int map_param_set_icmp6(u8 enable_unreachable)
Definition: map_api.c:333
vl_api_ip4_prefix_t ip4_prefix
Definition: map.api:117
vl_api_ip4_address_t icmp_ip4_err_relay_src
Definition: map.api:348
vl_api_ip6_prefix_t ip6_prefix
Definition: map.api:36
int map_param_set_tcp(u16 tcp_mss)
Definition: map_api.c:554
int map_param_set_reassembly(bool is_ipv6, u16 lifetime_ms, u16 pool_size, u32 buffers, f64 ht_ratio, u32 *reass, u32 *packets)
Definition: map_api.c:371