FD.io VPP  v21.06-3-gbb25fbf28
Vector Packet Processing
ipip.api
Go to the documentation of this file.
1 /* Hey Emacs use -*- mode: C -*- */
2 /*
3  * Copyright (c) 2018 Cisco and/or its affiliates.
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at:
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 /**
18  * The IPIP module implements IP{v4,v6} over IP{v4,v6} tunnelling as
19  * described in RFC2473 and to some extent the largely historical
20  * RFC1853. The module also supports an IPv4 over IPv6 automatic
21  * tunnelling mechanism called 6RD (RFC5969).
22  *
23  * The IPIP API module supports a CRD model for adding, deleting and
24  * listing tunnels. A tunnel is represented as an interface in
25  * VPP. The "handle" representing a tunnel is the sw_if_index. As any
26  * interface, the user must configure an IPv4 and/or IPv6 address on
27  * the interface. This is the inner or payload protocol.
28  *
29  * Tunnel MTU: The tunnel MTU (the payload MTU) is configurable per
30  * protocol. If a tunnel MTU is larger than the path MTU, the outer
31  * packet will be fragmented. Fragmentation support is configurable,
32  * as it can have severe performance issues, and might be used as an
33  * attack vector (the remote side must reassemble.)
34  *
35  * Traffic class / TOS field can either be configured to a fixed
36  * value, or can be copied from the inner to the outer header.
37  * (For now we have stolen ~0 to indicate copy).
38  *
39  * Note:
40  *
41  * - The Tunnel encapsulation limit described in RFC2473 is not
42  * implemented.
43  *
44  * - ICMP proxying, as in a tunnel head-end receiving ICMP erors on
45  * the outer packet is currently not relayed to the original source
46  * of the packet.
47  *
48  * - PMTUD / MTU probing and tunnel keepalives are not yet implemented.
49  *
50  */
51 
52 option version = "2.0.2";
53 
54 import "vnet/interface_types.api";
55 import "vnet/ip/ip_types.api";
56 import "vnet/tunnel/tunnel_types.api";
57 
58 /**
59  * An IP{v4,v6} over IP{v4,v6} tunnel.
60  */
61 typedef ipip_tunnel
62 {
63  u32 instance; /* If non-~0, specifies a custom dev instance */
64  vl_api_address_t src;
65  vl_api_address_t dst;
66  vl_api_interface_index_t sw_if_index; /* ignored on create, set in
67  details/dump */
69  vl_api_tunnel_encap_decap_flags_t flags;
70  vl_api_tunnel_mode_t mode;
71  vl_api_ip_dscp_t dscp; /* DSCP value for the tunnel encap,
72  ignored if ECNAP_COPY_DSCP flag is set */
73 };
74 
75 /**
76  * Create an IP{v4,v6} over IP{v4,v6} tunnel.
77  */
79 {
82  vl_api_ipip_tunnel_t tunnel;
83 };
84 
85 define ipip_add_tunnel_reply
86 {
89  vl_api_interface_index_t sw_if_index;
90 };
91 
92 /**
93  * Delete an IP{v4,v6} over IP{v4,v6} tunnel.
94  */
95 autoreply define ipip_del_tunnel
96 {
99  vl_api_interface_index_t sw_if_index;
100 };
101 
102 /**
103  * Create an IPv4 over IPv6 automatic tunnel (6RD)
104  */
105 define ipip_6rd_add_tunnel
106 {
111  vl_api_ip6_prefix_t ip6_prefix;
112  vl_api_ip4_prefix_t ip4_prefix;
113  vl_api_ip4_address_t ip4_src;
115  u8 tc_tos; /* If ~0, the TOS/TC value is copied from
116  inner packet, otherwise set to value */
117 };
118 
119 define ipip_6rd_add_tunnel_reply
120 {
123  vl_api_interface_index_t sw_if_index;
124 };
125 
126 /**
127  * Delete an IPv4 over IPv6 automatic tunnel (6RD)
128  */
129 autoreply define ipip_6rd_del_tunnel
130 {
133  vl_api_interface_index_t sw_if_index;
134 };
135 
136 /**
137  * List all IPIP tunnels
138  */
139 define ipip_tunnel_dump
140 {
143  vl_api_interface_index_t sw_if_index;
144 };
145 
146 define ipip_tunnel_details
147 {
149  vl_api_ipip_tunnel_t tunnel;
150 };
vl_api_ipip_6rd_add_tunnel_t::security_check
bool security_check
Definition: ipip.api:114
vl_api_ipip_add_tunnel_reply_t::retval
i32 retval
Definition: ipip.api:88
vl_api_ipip_6rd_add_tunnel_t::ip4_src
vl_api_ip4_address_t ip4_src
Definition: ipip.api:113
vl_api_ipip_add_tunnel_reply_t::sw_if_index
vl_api_interface_index_t sw_if_index
Definition: ipip.api:89
vl_api_ipip_add_tunnel_t::context
u32 context
Definition: ipip.api:81
vl_api_ipip_6rd_del_tunnel_t::sw_if_index
vl_api_interface_index_t sw_if_index
Definition: ipip.api:133
vl_api_ipip_6rd_add_tunnel_reply_t::sw_if_index
vl_api_interface_index_t sw_if_index
Definition: ipip.api:123
vl_api_ipip_tunnel_dump_t
List all IPIP tunnels.
Definition: ipip.api:139
src
vl_api_address_t src
Definition: ipip.api:64
i32
signed int i32
Definition: types.h:77
vl_api_ipip_del_tunnel_t::context
u32 context
Definition: ipip.api:98
vl_api_ipip_6rd_add_tunnel_t::ip4_table_id
u32 ip4_table_id
Definition: ipip.api:110
vl_api_ipip_tunnel_details_t
Definition: ipip.api:146
vl_api_ipip_tunnel_details_t::context
u32 context
Definition: ipip.api:148
version
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:52
dscp
vl_api_ip_dscp_t dscp
Definition: ipip.api:71
vl_api_ipip_tunnel_dump_t::context
u32 context
Definition: ipip.api:142
vl_api_ipip_6rd_add_tunnel_t::context
u32 context
Definition: ipip.api:108
vl_api_ipip_6rd_add_tunnel_reply_t::retval
i32 retval
Definition: ipip.api:122
ipip_del_tunnel
int ipip_del_tunnel(u32 sw_if_index)
Definition: ipip.c:832
vl_api_ipip_6rd_del_tunnel_t
Delete an IPv4 over IPv6 automatic tunnel (6RD)
Definition: ipip.api:129
vl_api_ipip_del_tunnel_t::client_index
u32 client_index
Definition: ipip.api:97
table_id
u32 table_id
Definition: ipip.api:68
vl_api_ipip_add_tunnel_reply_t::context
u32 context
Definition: ipip.api:87
vl_api_ipip_6rd_add_tunnel_t
Create an IPv4 over IPv6 automatic tunnel (6RD)
Definition: ipip.api:105
vl_api_ipip_del_tunnel_t::sw_if_index
vl_api_interface_index_t sw_if_index
Definition: ipip.api:99
vl_api_ipip_6rd_add_tunnel_t::ip4_prefix
vl_api_ip4_prefix_t ip4_prefix
Definition: ipip.api:112
vl_api_ipip_6rd_add_tunnel_reply_t::context
u32 context
Definition: ipip.api:121
u32
unsigned int u32
Definition: types.h:88
vl_api_ipip_tunnel_dump_t::client_index
u32 client_index
Definition: ipip.api:141
vl_api_ipip_6rd_del_tunnel_t::context
u32 context
Definition: ipip.api:132
vl_api_ipip_tunnel_dump_t::sw_if_index
vl_api_interface_index_t sw_if_index
Definition: ipip.api:143
vl_api_ipip_add_tunnel_t
Create an IP{v4,v6} over IP{v4,v6} tunnel.
Definition: ipip.api:78
instance
u32 instance
Definition: gre.api:51
vl_api_ipip_6rd_add_tunnel_t::tc_tos
u8 tc_tos
Definition: ipip.api:115
vl_api_ipip_add_tunnel_t::tunnel
vl_api_ipip_tunnel_t tunnel
Definition: ipip.api:82
u8
unsigned char u8
Definition: types.h:56
mode
vl_api_tunnel_mode_t mode
Definition: ipip.api:70
dst
vl_api_address_t dst
Definition: ipip.api:65
vl_api_ipip_add_tunnel_reply_t
Definition: ipip.api:85
vl_api_ipip_tunnel_details_t::tunnel
vl_api_ipip_tunnel_t tunnel
Definition: ipip.api:149
flags
vl_api_tunnel_encap_decap_flags_t flags
Definition: ipip.api:69
vl_api_ipip_6rd_del_tunnel_t::client_index
u32 client_index
Definition: ipip.api:131
vl_api_ipip_6rd_add_tunnel_t::ip6_prefix
vl_api_ip6_prefix_t ip6_prefix
Definition: ipip.api:111
vl_api_ipip_del_tunnel_t
Delete an IP{v4,v6} over IP{v4,v6} tunnel.
Definition: ipip.api:95
ipip_tunnel
typedef ipip_tunnel
An IP{v4,v6} over IP{v4,v6} tunnel.
Definition: ipip.api:62
vl_api_ipip_6rd_add_tunnel_t::ip6_table_id
u32 ip6_table_id
Definition: ipip.api:109
vl_api_ipip_6rd_add_tunnel_reply_t
Definition: ipip.api:119
sw_if_index
vl_api_interface_index_t sw_if_index
Definition: ipip.api:66
vl_api_ipip_6rd_add_tunnel_t::client_index
u32 client_index
Definition: ipip.api:107
ipip_add_tunnel
int ipip_add_tunnel(ipip_transport_t transport, u32 instance, ip46_address_t *src, ip46_address_t *dst, u32 fib_index, tunnel_encap_decap_flags_t flags, ip_dscp_t dscp, tunnel_mode_t tmode, u32 *sw_if_indexp)
Definition: ipip.c:722
vl_api_ipip_add_tunnel_t::client_index
u32 client_index
Definition: ipip.api:80