FD.io VPP  v21.06-3-gbb25fbf28
Vector Packet Processing
vxlan_gbp_api.c
Go to the documentation of this file.
1 /*
2  *------------------------------------------------------------------
3  * vxlan_gbp_api.c - vxlan gbp api
4  *
5  * Copyright (c) 2018 Cisco and/or its affiliates.
6  * Licensed under the Apache License, Version 2.0 (the "License");
7  * you may not use this file except in compliance with the License.
8  * You may obtain a copy of the License at:
9  *
10  * http://www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing, software
13  * distributed under the License is distributed on an "AS IS" BASIS,
14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15  * See the License for the specific language governing permissions and
16  * limitations under the License.
17  *------------------------------------------------------------------
18  */
19 
20 #include <vnet/vnet.h>
21 #include <vlibmemory/api.h>
22 
23 #include <vnet/interface.h>
24 #include <vnet/api_errno.h>
25 #include <vnet/feature/feature.h>
27 #include <vnet/fib/fib_table.h>
28 #include <vnet/ip/ip_types_api.h>
29 
30 #include <vnet/vnet_msg_enum.h>
31 
32 #define vl_typedefs /* define message structures */
33 #include <vnet/vnet_all_api_h.h>
34 #undef vl_typedefs
35 
36 #define vl_endianfun /* define message structures */
37 #include <vnet/vnet_all_api_h.h>
38 #undef vl_endianfun
39 
40 /* instantiate all the print functions we know about */
41 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
42 #define vl_printfun
43 #include <vnet/vnet_all_api_h.h>
44 #undef vl_printfun
45 
47 
48 #define foreach_vpe_api_msg \
49 _(SW_INTERFACE_SET_VXLAN_GBP_BYPASS, sw_interface_set_vxlan_gbp_bypass) \
50 _(VXLAN_GBP_TUNNEL_ADD_DEL, vxlan_gbp_tunnel_add_del) \
51 _(VXLAN_GBP_TUNNEL_DUMP, vxlan_gbp_tunnel_dump)
52 
53 static void
56 {
57  vl_api_sw_interface_set_vxlan_gbp_bypass_reply_t *rmp;
58  int rv = 0;
59  u32 sw_if_index = ntohl (mp->sw_if_index);
60 
62 
65 
66  REPLY_MACRO (VL_API_SW_INTERFACE_SET_VXLAN_GBP_BYPASS_REPLY);
67 }
68 
69 static int
70 vxlan_gbp_tunnel_mode_decode (vl_api_vxlan_gbp_api_tunnel_mode_t in,
72 {
73  in = clib_net_to_host_u32 (in);
74 
75  switch (in)
76  {
79  return (0);
82  return (0);
83  }
84  return (VNET_API_ERROR_INVALID_VALUE);
85 }
86 
89 {
92  ip46_address_t src, dst;
93  ip46_type_t itype;
94  int rv = 0;
95  u32 sw_if_index = ~0;
96  u32 fib_index;
97 
98  itype = ip_address_decode (&mp->tunnel.src, &src);
99  itype = ip_address_decode (&mp->tunnel.dst, &dst);
100 
101  fib_index = fib_table_find (fib_proto_from_ip46 (itype),
102  ntohl (mp->tunnel.encap_table_id));
103  if (fib_index == ~0)
104  {
105  rv = VNET_API_ERROR_NO_SUCH_FIB;
106  goto out;
107  }
108 
110 
111  if (rv)
112  goto out;
113 
115  .is_add = mp->is_add,
116  .is_ip6 = (itype == IP46_TYPE_IP6),
117  .instance = ntohl (mp->tunnel.instance),
118  .mcast_sw_if_index = ntohl (mp->tunnel.mcast_sw_if_index),
119  .encap_fib_index = fib_index,
120  .vni = ntohl (mp->tunnel.vni),
121  .dst = dst,
122  .src = src,
123  .mode = mode,
124  };
125 
126  /* Check src & dst are different */
127  if (ip46_address_cmp (&a.dst, &a.src) == 0)
128  {
129  rv = VNET_API_ERROR_SAME_SRC_DST;
130  goto out;
131  }
132  if (ip46_address_is_multicast (&a.dst) &&
133  !vnet_sw_if_index_is_api_valid (a.mcast_sw_if_index))
134  {
135  rv = VNET_API_ERROR_INVALID_SW_IF_INDEX;
136  goto out;
137  }
138 
140 
141 out:
142  /* *INDENT-OFF* */
143  REPLY_MACRO2(VL_API_VXLAN_GBP_TUNNEL_ADD_DEL_REPLY,
144  ({
145  rmp->sw_if_index = ntohl (sw_if_index);
146  }));
147  /* *INDENT-ON* */
148 }
149 
152 {
154  ip46_type_t itype = (ip46_address_is_ip4 (&t->dst) ?
156 
157  rmp = vl_msg_api_alloc (sizeof (*rmp));
158  clib_memset (rmp, 0, sizeof (*rmp));
159  rmp->_vl_msg_id = ntohs (VL_API_VXLAN_GBP_TUNNEL_DETAILS);
160 
161  ip_address_encode (&t->src, itype, &rmp->tunnel.src);
162  ip_address_encode (&t->dst, itype, &rmp->tunnel.dst);
163  rmp->tunnel.encap_table_id =
165 
166  rmp->tunnel.instance = htonl (t->user_instance);
167  rmp->tunnel.mcast_sw_if_index = htonl (t->mcast_sw_if_index);
168  rmp->tunnel.vni = htonl (t->vni);
169  rmp->tunnel.sw_if_index = htonl (t->sw_if_index);
170  rmp->context = context;
171 
172  vl_api_send_msg (reg, (u8 *) rmp);
173 }
174 
177 {
182 
184  if (!reg)
185  return;
186 
187  sw_if_index = ntohl (mp->sw_if_index);
188 
189  if (~0 == sw_if_index)
190  {
191  /* *INDENT-OFF* */
192  pool_foreach (t, vxm->tunnels)
193  {
195  }
196  /* *INDENT-ON* */
197  }
198  else
199  {
202  {
203  return;
204  }
207  }
208 }
209 
210 /*
211  * vpe_api_hookup
212  * Add vpe's API message handlers to the table.
213  * vlib has already mapped shared memory and
214  * added the client registration handlers.
215  * See .../vlib-api/vlibmemory/memclnt_vlib.c:memclnt_process()
216  */
217 #define vl_msg_name_crc_list
218 #include <vnet/vnet_all_api_h.h>
219 #undef vl_msg_name_crc_list
220 
221 static void
223 {
224 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
225  foreach_vl_msg_name_crc_vxlan_gbp;
226 #undef _
227 }
228 
229 static clib_error_t *
231 {
233 
234 #define _(N,n) \
235  vl_msg_api_set_handlers(VL_API_##N, #n, \
236  vl_api_##n##_t_handler, \
237  vl_noop_handler, \
238  vl_api_##n##_t_endian, \
239  vl_api_##n##_t_print, \
240  sizeof(vl_api_##n##_t), 1);
242 #undef _
243 
244  /*
245  * Set up the (msg_name, crc, message-id) table
246  */
248 
249  return 0;
250 }
251 
253 
254 /*
255  * fd.io coding-style-patch-verification: ON
256  *
257  * Local Variables:
258  * eval: (c-set-style "gnu")
259  * End:
260  */
vnet_int_vxlan_gbp_bypass_mode
void vnet_int_vxlan_gbp_bypass_mode(u32 sw_if_index, u8 is_ip6, u8 is_enable)
Definition: vxlan_gbp.c:971
fib_proto_from_ip46
fib_protocol_t fib_proto_from_ip46(ip46_type_t iproto)
Convert from ip46_type to fib_protocol.
Definition: fib_types.c:409
foreach_vpe_api_msg
#define foreach_vpe_api_msg
Definition: vxlan_gbp_api.c:48
VALIDATE_SW_IF_INDEX
#define VALIDATE_SW_IF_INDEX(mp)
Definition: api_helper_macros.h:281
vl_api_client_index_to_registration
static vl_api_registration_t * vl_api_client_index_to_registration(u32 index)
Definition: api.h:79
api.h
ntohs
#define ntohs(x)
Definition: af_xdp.bpf.c:29
vl_api_vxlan_gbp_tunnel_details_t::context
u32 context
Definition: vxlan_gbp.api:80
vl_api_vxlan_gbp_tunnel_add_del_t::tunnel
vl_api_vxlan_gbp_tunnel_t tunnel
Definition: vxlan_gbp.api:58
REPLY_MACRO2
#define REPLY_MACRO2(t, body)
Definition: api_helper_macros.h:65
vl_api_vxlan_gbp_tunnel_details_t
Definition: vxlan_gbp.api:78
fib_table_get_table_id
u32 fib_table_get_table_id(u32 fib_index, fib_protocol_t proto)
Get the Table-ID of the FIB from protocol and index.
Definition: fib_table.c:1095
vl_api_send_msg
static void vl_api_send_msg(vl_api_registration_t *rp, u8 *elem)
Definition: api.h:35
ip46_address_is_multicast
static uword ip46_address_is_multicast(const ip46_address_t *a)
Definition: ip46_address.h:154
vxlan_gbp_main_t::tunnels
vxlan_gbp_tunnel_t * tunnels
Definition: vxlan_gbp.h:168
VXLAN_GBP_TUNNEL_MODE_L2
@ VXLAN_GBP_TUNNEL_MODE_L2
Definition: vxlan_gbp.h:65
VXLAN_GBP_API_TUNNEL_MODE_L3
@ VXLAN_GBP_API_TUNNEL_MODE_L3
Definition: vxlan_gbp.api:24
ip46_address_cmp
static int ip46_address_cmp(const ip46_address_t *ip46_1, const ip46_address_t *ip46_2)
Definition: ip46_address.h:80
ip46_address_is_ip4
static u8 ip46_address_is_ip4(const ip46_address_t *ip46)
Definition: ip46_address.h:55
IP46_TYPE_IP4
@ IP46_TYPE_IP4
Definition: ip46_address.h:26
vl_api_vxlan_gbp_tunnel_dump_t_handler
static void vl_api_vxlan_gbp_tunnel_dump_t_handler(vl_api_vxlan_gbp_tunnel_dump_t *mp)
Definition: vxlan_gbp_api.c:176
fib_table.h
vl_api_vxlan_gbp_tunnel_add_del_t
Create or delete a VXLAN-GBP tunnel.
Definition: vxlan_gbp.api:53
setup_message_id_table
static void setup_message_id_table(api_main_t *am)
Definition: vxlan_gbp_api.c:222
mode
vl_api_tunnel_mode_t mode
Definition: gre.api:48
am
app_main_t * am
Definition: application.c:489
vxlan_gbp_tunnel_t::vni
u32 vni
Definition: vxlan_gbp.h:83
vm
vlib_main_t * vm
X-connect all packets from the HOST to the PHY.
Definition: nat44_ei.c:3047
vl_api_vxlan_gbp_tunnel_add_del_t::is_add
bool is_add[default=true]
Definition: vxlan_gbp.api:57
vl_api_vxlan_gbp_tunnel_dump_t
Definition: vxlan_gbp.api:70
vxlan_gbp_tunnel_mode_t
enum vxlan_gbp_tunnel_mode_t_ vxlan_gbp_tunnel_mode_t
VXLAN_GBP_TUNNEL_MODE_L3
@ VXLAN_GBP_TUNNEL_MODE_L3
Definition: vxlan_gbp.h:66
vl_api_sw_interface_set_vxlan_gbp_bypass_t::enable
bool enable[default=true]
Definition: vxlan_gbp.api:98
vxlan_gbp_tunnel_mode_decode
static int vxlan_gbp_tunnel_mode_decode(vl_api_vxlan_gbp_api_tunnel_mode_t in, vxlan_gbp_tunnel_mode_t *out)
Definition: vxlan_gbp_api.c:70
vxlan_gbp_tunnel_t::mcast_sw_if_index
u32 mcast_sw_if_index
Definition: vxlan_gbp.h:90
ip_address_decode
ip46_type_t ip_address_decode(const vl_api_address_t *in, ip46_address_t *out)
Decode/Encode for struct/union types.
Definition: ip_types_api.c:186
vl_api_vxlan_gbp_tunnel_add_del_reply_t
Definition: vxlan_gbp.api:62
vl_api_vxlan_gbp_tunnel_dump_t::context
u32 context
Definition: vxlan_gbp.api:73
pool_foreach
#define pool_foreach(VAR, POOL)
Iterate through pool.
Definition: pool.h:534
vec_len
#define vec_len(v)
Number of elements in vector (rvalue-only, NULL tolerant)
Definition: vec_bootstrap.h:142
vxlan_gbp_tunnel_t::encap_fib_index
u32 encap_fib_index
Definition: vxlan_gbp.h:93
vxlan_gbp_api_hookup
static clib_error_t * vxlan_gbp_api_hookup(vlib_main_t *vm)
Definition: vxlan_gbp_api.c:230
feature.h
vnet_msg_enum.h
vl_api_registration_
An API client registration, only in vpp/vlib.
Definition: api_common.h:47
REPLY_MACRO
#define REPLY_MACRO(t)
Definition: api_helper_macros.h:30
vxlan_gbp_tunnel_t::dst
ip46_address_t dst
Definition: vxlan_gbp.h:87
vl_api_vxlan_gbp_tunnel_add_del_t_handler
static void vl_api_vxlan_gbp_tunnel_add_del_t_handler(vl_api_vxlan_gbp_tunnel_add_del_t *mp)
Definition: vxlan_gbp_api.c:88
send_vxlan_gbp_tunnel_details
static void send_vxlan_gbp_tunnel_details(vxlan_gbp_tunnel_t *t, vl_api_registration_t *reg, u32 context)
Definition: vxlan_gbp_api.c:151
vlibapi_get_main
static api_main_t * vlibapi_get_main(void)
Definition: api_common.h:390
interface.h
vl_api_vxlan_gbp_tunnel_dump_t::sw_if_index
vl_api_interface_index_t sw_if_index[default=0xffffffff]
Definition: vxlan_gbp.api:74
VLIB_API_INIT_FUNCTION
VLIB_API_INIT_FUNCTION(vxlan_gbp_api_hookup)
src
vl_api_address_t src
Definition: gre.api:54
IP46_TYPE_IP6
@ IP46_TYPE_IP6
Definition: ip46_address.h:27
vxlan_gbp_tunnel_t::sw_if_index
u32 sw_if_index
Definition: vxlan_gbp.h:96
BAD_SW_IF_INDEX_LABEL
#define BAD_SW_IF_INDEX_LABEL
Definition: api_helper_macros.h:289
api_main_t
API main structure, used by both vpp and binary API clients.
Definition: api_common.h:228
vnet_vxlan_gbp_tunnel_add_del_args_t
Definition: vxlan_gbp.h:212
vl_api_sw_interface_set_vxlan_gbp_bypass_t
Interface set vxlan-bypass request.
Definition: vxlan_gbp.api:92
vnet_sw_if_index_is_api_valid
static uword vnet_sw_if_index_is_api_valid(u32 sw_if_index)
Definition: api_helper_macros.h:276
vxlan_gbp_tunnel_t
Definition: vxlan_gbp.h:71
vxlan_gbp_main_t
Definition: vxlan_gbp.h:165
u32
unsigned int u32
Definition: types.h:88
vxlan_gbp_main_t::tunnel_index_by_sw_if_index
u32 * tunnel_index_by_sw_if_index
Definition: vxlan_gbp.h:183
vl_api_vxlan_gbp_tunnel_details_t::tunnel
vl_api_vxlan_gbp_tunnel_t tunnel
Definition: vxlan_gbp.api:81
dst
vl_api_ip4_address_t dst
Definition: pnat.api:41
api_helper_macros.h
instance
u32 instance
Definition: gre.api:51
vnet_vxlan_gbp_tunnel_add_del
int vnet_vxlan_gbp_tunnel_add_del(vnet_vxlan_gbp_tunnel_add_del_args_t *a, u32 *sw_if_indexp)
Definition: vxlan_gbp.c:385
vl_api_vxlan_gbp_tunnel_dump_t::client_index
u32 client_index
Definition: vxlan_gbp.api:72
clib_memset
clib_memset(h->entries, 0, sizeof(h->entries[0]) *entries)
vlib_main_t
Definition: main.h:102
ip_address_encode
void ip_address_encode(const ip46_address_t *in, ip46_type_t type, vl_api_address_t *out)
Definition: ip_types_api.c:220
u8
unsigned char u8
Definition: types.h:56
clib_error_t
Definition: clib_error.h:21
a
a
Definition: bitmap.h:544
vl_api_sw_interface_set_vxlan_gbp_bypass_t::sw_if_index
vl_api_interface_index_t sw_if_index
Definition: vxlan_gbp.api:96
ip46_type_t
ip46_type_t
Definition: ip46_address.h:22
vnet_all_api_h.h
context
u32 context
Definition: ip.api:780
rv
int __clib_unused rv
Definition: application.c:491
vxlan_gbp_tunnel_t::user_instance
u32 user_instance
Definition: vxlan_gbp.h:129
VXLAN_GBP_API_TUNNEL_MODE_L2
@ VXLAN_GBP_API_TUNNEL_MODE_L2
Definition: vxlan_gbp.api:23
vnet.h
api_errno.h
vxlan_gbp_tunnel_t::src
ip46_address_t src
Definition: vxlan_gbp.h:86
fib_table_find
u32 fib_table_find(fib_protocol_t proto, u32 table_id)
Get the index of the FIB for a Table-ID.
Definition: fib_table.c:1106
vl_api_sw_interface_set_vxlan_gbp_bypass_t::is_ipv6
bool is_ipv6
Definition: vxlan_gbp.api:97
sw_if_index
vl_api_interface_index_t sw_if_index
Definition: wireguard.api:34
vl_api_vxlan_gbp_tunnel_add_del_reply_t::sw_if_index
vl_api_interface_index_t sw_if_index
Definition: vxlan_gbp.api:66
ip_types_api.h
vxlan_gbp_main
vxlan_gbp_main_t vxlan_gbp_main
Definition: vxlan_gbp.c:35
vxlan_gbp.h
vl_api_sw_interface_set_vxlan_gbp_bypass_t_handler
static void vl_api_sw_interface_set_vxlan_gbp_bypass_t_handler(vl_api_sw_interface_set_vxlan_gbp_bypass_t *mp)
Definition: vxlan_gbp_api.c:55
vl_msg_api_alloc
void * vl_msg_api_alloc(int nbytes)
Definition: memory_shared.c:199