FD.io VPP  v19.04.4-rc0-5-ge88582fac
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 
29 #include <vnet/vnet_msg_enum.h>
30 
31 #define vl_typedefs /* define message structures */
32 #include <vnet/vnet_all_api_h.h>
33 #undef vl_typedefs
34 
35 #define vl_endianfun /* define message structures */
36 #include <vnet/vnet_all_api_h.h>
37 #undef vl_endianfun
38 
39 /* instantiate all the print functions we know about */
40 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
41 #define vl_printfun
42 #include <vnet/vnet_all_api_h.h>
43 #undef vl_printfun
44 
46 
47 #define foreach_vpe_api_msg \
48 _(GRE_ADD_DEL_TUNNEL, gre_add_del_tunnel) \
49 _(GRE_TUNNEL_DUMP, gre_tunnel_dump)
50 
53 {
55  int rv = 0;
57  u32 sw_if_index = ~0;
58 
59  /* Check src & dst are different */
60  if ((mp->is_ipv6 && memcmp (mp->src_address, mp->dst_address, 16) == 0) ||
61  (!mp->is_ipv6 && memcmp (mp->src_address, mp->dst_address, 4) == 0))
62  {
63  rv = VNET_API_ERROR_SAME_SRC_DST;
64  goto out;
65  }
66  clib_memset (a, 0, sizeof (*a));
67 
68  a->is_add = mp->is_add;
69  a->tunnel_type = mp->tunnel_type;
70  a->is_ipv6 = mp->is_ipv6;
71  a->instance = ntohl (mp->instance);
72  a->session_id = ntohs (mp->session_id);
73 
74  /* ip addresses sent in network byte order */
75  if (!mp->is_ipv6)
76  {
77  clib_memcpy (&(a->src.ip4), mp->src_address, 4);
78  clib_memcpy (&(a->dst.ip4), mp->dst_address, 4);
79  }
80  else
81  {
82  clib_memcpy (&(a->src.ip6), mp->src_address, 16);
83  clib_memcpy (&(a->dst.ip6), mp->dst_address, 16);
84  }
85 
86  a->outer_fib_id = ntohl (mp->outer_fib_id);
87  rv = vnet_gre_add_del_tunnel (a, &sw_if_index);
88 
89 out:
90  /* *INDENT-OFF* */
91  REPLY_MACRO2(VL_API_GRE_ADD_DEL_TUNNEL_REPLY,
92  ({
93  rmp->sw_if_index = ntohl (sw_if_index);
94  }));
95  /* *INDENT-ON* */
96 }
97 
98 static void send_gre_tunnel_details
99  (gre_tunnel_t * t, vl_api_registration_t * reg, u32 context)
100 {
102  u8 is_ipv6 = t->tunnel_dst.fp_proto == FIB_PROTOCOL_IP6 ? 1 : 0;
103  fib_table_t *ft;
104 
105  rmp = vl_msg_api_alloc (sizeof (*rmp));
106  clib_memset (rmp, 0, sizeof (*rmp));
107  rmp->_vl_msg_id = htons (VL_API_GRE_TUNNEL_DETAILS);
108  if (!is_ipv6)
109  {
110  clib_memcpy (rmp->src_address, &(t->tunnel_src.ip4.as_u8), 4);
111  clib_memcpy (rmp->dst_address, &(t->tunnel_dst.fp_addr.ip4.as_u8), 4);
113  rmp->outer_fib_id = htonl (ft->ft_table_id);
114  }
115  else
116  {
117  clib_memcpy (rmp->src_address, &(t->tunnel_src.ip6.as_u8), 16);
118  clib_memcpy (rmp->dst_address, &(t->tunnel_dst.fp_addr.ip6.as_u8), 16);
120  rmp->outer_fib_id = htonl (ft->ft_table_id);
121  }
122  rmp->tunnel_type = t->type;
123  rmp->instance = htonl (t->user_instance);
124  rmp->sw_if_index = htonl (t->sw_if_index);
125  rmp->session_id = htons (t->session_id);
126  rmp->context = context;
127  rmp->is_ipv6 = is_ipv6;
128 
129  vl_api_send_msg (reg, (u8 *) rmp);
130 }
131 
132 static void
134 {
136  gre_main_t *gm = &gre_main;
137  gre_tunnel_t *t;
139 
141  if (!reg)
142  return;
143 
144  sw_if_index = ntohl (mp->sw_if_index);
145 
146  if (~0 == sw_if_index)
147  {
148  /* *INDENT-OFF* */
149  pool_foreach (t, gm->tunnels,
150  ({
151  send_gre_tunnel_details(t, reg, mp->context);
152  }));
153  /* *INDENT-ON* */
154  }
155  else
156  {
157  if ((sw_if_index >= vec_len (gm->tunnel_index_by_sw_if_index)) ||
158  (~0 == gm->tunnel_index_by_sw_if_index[sw_if_index]))
159  {
160  return;
161  }
163  send_gre_tunnel_details (t, reg, mp->context);
164  }
165 }
166 
167 /*
168  * gre_api_hookup
169  * Add vpe's API message handlers to the table.
170  * vlib has already mapped shared memory and
171  * added the client registration handlers.
172  * See .../vlib-api/vlibmemory/memclnt_vlib.c:memclnt_process()
173  */
174 #define vl_msg_name_crc_list
175 #include <vnet/vnet_all_api_h.h>
176 #undef vl_msg_name_crc_list
177 
178 static void
180 {
181 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
182  foreach_vl_msg_name_crc_gre;
183 #undef _
184 }
185 
186 static clib_error_t *
188 {
189  api_main_t *am = &api_main;
190 
191 #define _(N,n) \
192  vl_msg_api_set_handlers(VL_API_##N, #n, \
193  vl_api_##n##_t_handler, \
194  vl_noop_handler, \
195  vl_api_##n##_t_endian, \
196  vl_api_##n##_t_print, \
197  sizeof(vl_api_##n##_t), 1);
199 #undef _
200 
201  /*
202  * Set up the (msg_name, crc, message-id) table
203  */
205 
206  return 0;
207 }
208 
210 
211 /*
212  * fd.io coding-style-patch-verification: ON
213  *
214  * Local Variables:
215  * eval: (c-set-style "gnu")
216  * End:
217  */
u32 sw_if_index
Definition: ipsec_gre.api:37
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:187
a
Definition: bitmap.h:538
#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:34
u32 outer_fib_index
The FIB in which the src.dst address are present.
Definition: gre.h:200
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
#define clib_memcpy(d, s, n)
Definition: string.h:180
static void vl_api_gre_tunnel_dump_t_handler(vl_api_gre_tunnel_dump_t *mp)
Definition: gre_api.c:133
u32 sw_if_index
Definition: gre.h:202
#define pool_foreach(VAR, POOL, BODY)
Iterate through pool.
Definition: pool.h:493
static void vl_api_gre_add_del_tunnel_t_handler(vl_api_gre_add_del_tunnel_t *mp)
Definition: gre_api.c:52
unsigned int u32
Definition: types.h:88
ip46_address_t tunnel_src
The tunnel&#39;s source/local address.
Definition: gre.h:192
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:99
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:202
An API client registration, only in vpp/vlib.
Definition: api_common.h:45
gre_tunnel_type_t type
Definition: gre.h:203
u32 ft_table_id
Table ID (hash key) for this FIB.
Definition: fib_table.h:89
vlib_main_t * vm
Definition: buffer.c:312
static void setup_message_id_table(api_main_t *am)
Definition: gre_api.c:179
u32 context
Definition: ipsec_gre.api:33
static vl_api_registration_t * vl_api_client_index_to_registration(u32 index)
Definition: api.h:56
Create or delete a GRE tunnel.
Definition: gre.api:30
gre_tunnel_t * tunnels
pool of tunnel instances
Definition: gre.h:242
u32 user_instance
Definition: gre.h:225
int vnet_gre_add_del_tunnel(vnet_gre_add_del_tunnel_args_t *a, u32 *sw_if_indexp)
Definition: interface.c:365
#define vec_len(v)
Number of elements in vector (rvalue-only, NULL tolerant)
#define foreach_vpe_api_msg
Definition: gre_api.c:47
fib_table_t * fib_table_get(fib_node_index_t index, fib_protocol_t proto)
Get a pointer to a FIB table.
Definition: fib_table.c:27
ip46_address_t dst
Definition: gre.h:353
fib_prefix_t tunnel_dst
The tunnel&#39;s destination/remote address.
Definition: gre.h:196
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
ip46_address_t src
Definition: gre.h:353
A protocol Independent FIB table.
Definition: fib_table.h:69