FD.io VPP  v19.08.3-2-gbabecb413
Vector Packet Processing
gre_api.c
Go to the documentation of this file.
1 /*
2  *------------------------------------------------------------------
3  * gre_api.c - gre api
4  *
5  * Copyright (c) 2016 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 
26 #include <vnet/gre/gre.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 _(GRE_TUNNEL_ADD_DEL, gre_tunnel_add_del) \
50 _(GRE_TUNNEL_DUMP, gre_tunnel_dump)
51 
52 static int
53 gre_tunnel_type_decode (vl_api_gre_tunnel_type_t in, gre_tunnel_type_t * out)
54 {
55  in = clib_net_to_host_u32 (in);
56 
57  switch (in)
58  {
60  *out = GRE_TUNNEL_TYPE_L3;
61  return (0);
63  *out = GRE_TUNNEL_TYPE_TEB;
64  return (0);
67  return (0);
68  }
69 
70  return (VNET_API_ERROR_INVALID_VALUE);
71 }
72 
73 static vl_api_gre_tunnel_type_t
75 {
76  vl_api_gre_tunnel_type_t out = GRE_API_TUNNEL_TYPE_L3;
77 
78  switch (in)
79  {
80  case GRE_TUNNEL_TYPE_L3:
82  break;
85  break;
88  break;
89  }
90 
91  out = clib_net_to_host_u32 (out);
92 
93  return (out);
94 }
95 
98 {
99  vnet_gre_tunnel_add_del_args_t _a = { }, *a = &_a;
101  u32 sw_if_index = ~0;
102  ip46_type_t itype[2];
103  int rv = 0;
104 
105  itype[0] = ip_address_decode (&mp->tunnel.src, &a->src);
106  itype[1] = ip_address_decode (&mp->tunnel.dst, &a->dst);
107 
108  if (itype[0] != itype[1])
109  {
110  rv = VNET_API_ERROR_INVALID_PROTOCOL;
111  goto out;
112  }
113 
114  if (ip46_address_is_equal (&a->src, &a->dst))
115  {
116  rv = VNET_API_ERROR_SAME_SRC_DST;
117  goto out;
118  }
119 
120  rv = gre_tunnel_type_decode (mp->tunnel.type, &a->type);
121 
122  if (rv)
123  goto out;
124 
125  a->is_add = mp->is_add;
126  a->is_ipv6 = (itype[0] == IP46_TYPE_IP6);
127  a->instance = ntohl (mp->tunnel.instance);
128  a->session_id = ntohs (mp->tunnel.session_id);
129  a->outer_fib_id = ntohl (mp->tunnel.outer_fib_id);
130 
131  rv = vnet_gre_tunnel_add_del (a, &sw_if_index);
132 
133 out:
134  /* *INDENT-OFF* */
135  REPLY_MACRO2(VL_API_GRE_TUNNEL_ADD_DEL_REPLY,
136  ({
137  rmp->sw_if_index = ntohl (sw_if_index);
138  }));
139  /* *INDENT-ON* */
140 }
141 
142 static void send_gre_tunnel_details
143  (gre_tunnel_t * t, vl_api_registration_t * reg, u32 context)
144 {
146 
147  rmp = vl_msg_api_alloc (sizeof (*rmp));
148  clib_memset (rmp, 0, sizeof (*rmp));
149  rmp->_vl_msg_id = htons (VL_API_GRE_TUNNEL_DETAILS);
150 
153 
154  rmp->tunnel.outer_fib_id =
157 
158  rmp->tunnel.type = gre_tunnel_type_encode (t->type);
159  rmp->tunnel.instance = htonl (t->user_instance);
160  rmp->tunnel.sw_if_index = htonl (t->sw_if_index);
161  rmp->tunnel.session_id = htons (t->session_id);
162  rmp->context = context;
163 
164  vl_api_send_msg (reg, (u8 *) rmp);
165 }
166 
167 static void
169 {
171  gre_main_t *gm = &gre_main;
172  gre_tunnel_t *t;
174 
176  if (!reg)
177  return;
178 
179  sw_if_index = ntohl (mp->sw_if_index);
180 
181  if (~0 == sw_if_index)
182  {
183  /* *INDENT-OFF* */
184  pool_foreach (t, gm->tunnels,
185  ({
186  send_gre_tunnel_details(t, reg, mp->context);
187  }));
188  /* *INDENT-ON* */
189  }
190  else
191  {
192  if ((sw_if_index >= vec_len (gm->tunnel_index_by_sw_if_index)) ||
193  (~0 == gm->tunnel_index_by_sw_if_index[sw_if_index]))
194  {
195  return;
196  }
198  send_gre_tunnel_details (t, reg, mp->context);
199  }
200 }
201 
202 /*
203  * gre_api_hookup
204  * Add vpe's API message handlers to the table.
205  * vlib has already mapped shared memory and
206  * added the client registration handlers.
207  * See .../vlib-api/vlibmemory/memclnt_vlib.c:memclnt_process()
208  */
209 #define vl_msg_name_crc_list
210 #include <vnet/vnet_all_api_h.h>
211 #undef vl_msg_name_crc_list
212 
213 static void
215 {
216 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
217  foreach_vl_msg_name_crc_gre;
218 #undef _
219 }
220 
221 static clib_error_t *
223 {
224  api_main_t *am = &api_main;
225 
226 #define _(N,n) \
227  vl_msg_api_set_handlers(VL_API_##N, #n, \
228  vl_api_##n##_t_handler, \
229  vl_noop_handler, \
230  vl_api_##n##_t_endian, \
231  vl_api_##n##_t_print, \
232  sizeof(vl_api_##n##_t), 1);
234 #undef _
235 
236  /*
237  * Set up the (msg_name, crc, message-id) table
238  */
240 
241  return 0;
242 }
243 
245 
246 /*
247  * fd.io coding-style-patch-verification: ON
248  *
249  * Local Variables:
250  * eval: (c-set-style "gnu")
251  * End:
252  */
fib_protocol_t fp_proto
protocol type
Definition: fib_types.h:212
GRE related global data.
Definition: gre.h:237
static clib_error_t * gre_api_hookup(vlib_main_t *vm)
Definition: gre_api.c:222
a
Definition: bitmap.h:538
Transparent Ethernet Bridging - the tunnel is in L2 mode.
Definition: gre.h:50
static int gre_tunnel_type_decode(vl_api_gre_tunnel_type_t in, gre_tunnel_type_t *out)
Definition: gre_api.c:53
#define REPLY_MACRO2(t, body)
clib_memset(h->entries, 0, sizeof(h->entries[0]) *entries)
VLIB_API_INIT_FUNCTION(gre_api_hookup)
static void vl_api_send_msg(vl_api_registration_t *rp, u8 *elem)
Definition: api.h:35
int vnet_gre_tunnel_add_del(vnet_gre_tunnel_add_del_args_t *a, u32 *sw_if_indexp)
Definition: interface.c:369
u32 outer_fib_index
The FIB in which the src.dst address are present.
Definition: gre.h:200
static vl_api_gre_tunnel_type_t gre_tunnel_type_encode(gre_tunnel_type_t in)
Definition: gre_api.c:74
void * vl_msg_api_alloc(int nbytes)
unsigned char u8
Definition: types.h:56
u32 * tunnel_index_by_sw_if_index
Mapping from sw_if_index to tunnel index.
Definition: gre.h:272
static void vl_api_gre_tunnel_dump_t_handler(vl_api_gre_tunnel_dump_t *mp)
Definition: gre_api.c:168
enum gre_tunnel_type_t_ gre_tunnel_type_t
The GRE tunnel type.
u32 sw_if_index
Definition: gre.h:202
vl_api_interface_index_t sw_if_index
Definition: gre.api:67
#define pool_foreach(VAR, POOL, BODY)
Iterate through pool.
Definition: pool.h:493
vl_api_interface_index_t sw_if_index
Definition: gre.api:50
unsigned int u32
Definition: types.h:88
ip46_address_t tunnel_src
The tunnel&#39;s source/local address.
Definition: gre.h:192
ip46_type_t ip_address_decode(const vl_api_address_t *in, ip46_address_t *out)
Definition: ip_types_api.c:161
A representation of a GRE tunnel.
Definition: gre.h:176
static void send_gre_tunnel_details(gre_tunnel_t *t, vl_api_registration_t *reg, u32 context)
Definition: gre_api.c:143
ip46_address_t fp_addr
The address type is not deriveable from the fp_addr member.
Definition: fib_types.h:226
#define gm
Definition: dlmalloc.c:1217
API main structure, used by both vpp and binary API clients.
Definition: api_common.h:203
vl_api_gre_tunnel_t tunnel
Definition: gre.api:80
An API client registration, only in vpp/vlib.
Definition: api_common.h:46
gre_tunnel_type_t type
Definition: gre.h:203
vlib_main_t * vm
Definition: buffer.c:323
vl_api_gre_tunnel_t tunnel
Definition: gre.api:60
static void setup_message_id_table(api_main_t *am)
Definition: gre_api.c:214
static vl_api_registration_t * vl_api_client_index_to_registration(u32 index)
Definition: api.h:57
vl_api_interface_index_t sw_if_index
Definition: gre.api:74
static void vl_api_gre_tunnel_add_del_t_handler(vl_api_gre_tunnel_add_del_t *mp)
Definition: gre_api.c:97
ip46_type_t
Definition: ip6_packet.h:70
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:1069
gre_tunnel_t * tunnels
pool of tunnel instances
Definition: gre.h:242
u32 user_instance
Definition: gre.h:225
ERSPAN type 2 - the tunnel is for port mirror SPAN output.
Definition: gre.h:57
#define ip46_address_is_equal(a1, a2)
Definition: ip6_packet.h:94
#define vec_len(v)
Number of elements in vector (rvalue-only, NULL tolerant)
L3 GRE (i.e.
Definition: gre.h:46
#define foreach_vpe_api_msg
Definition: gre_api.c:48
void ip_address_encode(const ip46_address_t *in, ip46_type_t type, vl_api_address_t *out)
Definition: ip_types_api.c:178
fib_prefix_t tunnel_dst
The tunnel&#39;s destination/remote address.
Definition: gre.h:196
u32 context
Definition: gre.api:45
api_main_t api_main
Definition: api_shared.c:35
gre_main_t gre_main
Definition: gre.c:25
u16 session_id
ERSPAN type 2 session ID, least significant 10 bits of u16.
Definition: gre.h:213