FD.io VPP  v19.08.3-2-gbabecb413
Vector Packet Processing
ipip.api
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2018 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 /**
17  * The IPIP module implements IP{v4,v6} over IP{v4,v6} tunnelling as
18  * described in RFC2473 and to some extent the largely historical
19  * RFC1853. The module also supports an IPv4 over IPv6 automatic
20  * tunnelling mechanism called 6RD (RFC5969).
21  *
22  * The IPIP API module supports a CRD model for adding, deleting and
23  * listing tunnels. A tunnel is represented as an interface in
24  * VPP. The "handle" representing a tunnel is the sw_if_index. As any
25  * interface, the user must configure an IPv4 and/or IPv6 address on
26  * the interface. This is the inner or payload protocol.
27  *
28  * Tunnel MTU: The tunnel MTU (the payload MTU) is configurable per
29  * protocol. If a tunnel MTU is larger than the path MTU, the outer
30  * packet will be fragmented. Fragmentation support is configurable,
31  * as it can have severe performance issues, and might be used as an
32  * attack vector (the remote side must reassemble.)
33  *
34  * Traffic class / TOS field can either be configured to a fixed
35  * value, or can be copied from the inner to the outer header.
36  * (For now we have stolen ~0 to indicate copy).
37  *
38  * Note:
39  *
40  * - The Tunnel encapsulation limit described in RFC2473 is not
41  * implemented.
42  *
43  * - ICMP proxying, as in a tunnel head-end receiving ICMP erors on
44  * the outer packet is currently not relayed to the original source
45  * of the packet.
46  *
47  * - PMTUD / MTU probing and tunnel keepalives are not yet implemented.
48  *
49  */
50 
51 option version = "1.2.0";
52 import "vnet/interface_types.api";
53 import "vnet/ip/ip_types.api";
54 
55 /**
56  * An IP{v4,v6} over IP{v4,v6} tunnel.
57  */
58 typedef ipip_tunnel
59 {
60  u32 instance; /* If non-~0, specifies a custom dev instance */
61  vl_api_address_t src;
62  vl_api_address_t dst;
63  vl_api_interface_index_t sw_if_index; /* ignored on create, set in
64  details/dump */
66  u8 tc_tos; /* If ~0, the TOS/TC value is copied from
67  inner packet, otherwise set to value */
68 };
69 
70 /**
71  * Create an IP{v4,v6} over IP{v4,v6} tunnel.
72  */
74 {
77  vl_api_ipip_tunnel_t tunnel;
78 };
79 
80 define ipip_add_tunnel_reply
81 {
84  vl_api_interface_index_t sw_if_index;
85 };
86 
87 /**
88  * Delete an IP{v4,v6} over IP{v4,v6} tunnel.
89  */
90 autoreply define ipip_del_tunnel
91 {
94  vl_api_interface_index_t sw_if_index;
95 };
96 
97 /**
98  * Create an IPv4 over IPv6 automatic tunnel (6RD)
99  */
100 define ipip_6rd_add_tunnel
101 {
106  vl_api_ip6_prefix_t ip6_prefix;
107  vl_api_ip4_prefix_t ip4_prefix;
110  u8 tc_tos; /* If ~0, the TOS/TC value is copied from
111  inner packet, otherwise set to value */
112 };
113 
114 define ipip_6rd_add_tunnel_reply
115 {
118  vl_api_interface_index_t sw_if_index;
119 };
120 
121 /**
122  * Delete an IPv4 over IPv6 automatic tunnel (6RD)
123  */
124 autoreply define ipip_6rd_del_tunnel
125 {
128  vl_api_interface_index_t sw_if_index;
129 };
130 
131 /**
132  * List all IPIP tunnels
133  */
134 define ipip_tunnel_dump
135 {
138  vl_api_interface_index_t sw_if_index;
139 };
140 
141 define ipip_tunnel_details
142 {
144  vl_api_ipip_tunnel_t tunnel;
145 };
vl_api_interface_index_t sw_if_index
Definition: ipip.api:94
vl_api_address_t src
Definition: ipip.api:61
vl_api_interface_index_t sw_if_index
Definition: ipip.api:128
typedef ipip_tunnel
An IP{v4,v6} over IP{v4,v6} tunnel.
Definition: ipip.api:59
int ipip_add_tunnel(ipip_transport_t transport, u32 instance, ip46_address_t *src, ip46_address_t *dst, u32 fib_index, u8 tc_tos, u32 *sw_if_indexp)
Definition: ipip.c:385
vl_api_ipip_tunnel_t tunnel
Definition: ipip.api:77
vl_api_ip4_address_t ip4_src
Definition: ipip.api:108
u8 tc_tos
Definition: ipip.api:66
vl_api_interface_index_t sw_if_index
Definition: ipip.api:84
unsigned char u8
Definition: types.h:56
option version
The IPIP module implements IP{v4,v6} over IP{v4,v6} tunnelling as described in RFC2473 and to some ex...
Definition: ipip.api:51
unsigned int u32
Definition: types.h:88
vl_api_ip4_prefix_t ip4_prefix
Definition: ipip.api:107
u8 vl_api_ip4_address_t[4]
Definition: ip_types_api.h:31
vl_api_address_t dst
Definition: ipip.api:62
signed int i32
Definition: types.h:77
u32 table_id
Definition: ipip.api:65
vl_api_ipip_tunnel_t tunnel
Definition: ipip.api:144
vl_api_interface_index_t sw_if_index
Definition: ipip.api:118
vl_api_interface_index_t sw_if_index
Definition: ipip.api:63
u32 instance
Definition: gre.api:48
int ipip_del_tunnel(u32 sw_if_index)
Definition: ipip.c:477
vl_api_interface_index_t sw_if_index
Definition: ipip.api:138
vl_api_ip6_prefix_t ip6_prefix
Definition: ipip.api:106