FD.io VPP  v18.01.2-1-g9b554f3
Vector Packet Processing
udp_api.c
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2017 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 #include <vnet/vnet.h>
17 #include <vlibmemory/api.h>
18 
19 #include <vnet/udp/udp_encap.h>
20 #include <vnet/fib/fib_table.h>
21 
22 #include <vnet/vnet_msg_enum.h>
23 
24 #define vl_typedefs /* define message structures */
25 #include <vnet/vnet_all_api_h.h>
26 #undef vl_typedefs
27 
28 #define vl_endianfun /* define message structures */
29 #include <vnet/vnet_all_api_h.h>
30 #undef vl_endianfun
31 
32 /* instantiate all the print functions we know about */
33 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
34 #define vl_printfun
35 #include <vnet/vnet_all_api_h.h>
36 #undef vl_printfun
37 
39 
40 
41 #define foreach_udp_api_msg \
42  _(UDP_ENCAP_ADD_DEL, udp_encap_add_del) \
43 _(UDP_ENCAP_DUMP, udp_encap_dump)
44 
45 static void
47  unix_shared_memory_queue_t * q, u32 context)
48 {
50  fib_table_t *fib_table;
51 
52  mp = vl_msg_api_alloc (sizeof (*mp));
53  memset (mp, 0, sizeof (*mp));
54  mp->_vl_msg_id = ntohs (VL_API_UDP_ENCAP_DETAILS);
55  mp->context = context;
56 
57  mp->is_ip6 = (ue->ue_ip_proto == FIB_PROTOCOL_IP6);
58 
59  if (FIB_PROTOCOL_IP4 == ue->ue_ip_proto)
60  {
61  clib_memcpy (mp->src_ip, &ue->ue_hdrs.ip4.ue_ip4.src_address, 4);
62  clib_memcpy (mp->dst_ip, &ue->ue_hdrs.ip4.ue_ip4.dst_address, 4);
63  mp->src_port = htons (ue->ue_hdrs.ip4.ue_udp.src_port);
64  mp->dst_port = htons (ue->ue_hdrs.ip4.ue_udp.dst_port);
65  }
66  else
67  {
68  clib_memcpy (mp->src_ip, &ue->ue_hdrs.ip6.ue_ip6.src_address, 16);
69  clib_memcpy (mp->dst_ip, &ue->ue_hdrs.ip6.ue_ip6.dst_address, 16);
70  mp->src_port = htons (ue->ue_hdrs.ip6.ue_udp.src_port);
71  mp->dst_port = htons (ue->ue_hdrs.ip6.ue_udp.dst_port);
72  }
73 
74  fib_table = fib_table_get (ue->ue_fib_index, ue->ue_ip_proto);
75  mp->table_id = htonl (fib_table->ft_table_id);
76  mp->id = htonl (ue->ue_id);
77 
78  vl_msg_api_send_shmem (q, (u8 *) & mp);
79 }
80 
81 static void
83  vlib_main_t * vm)
84 {
86  udp_encap_t *ue;
87 
89  if (q == 0)
90  return;
91 
92  /* *INDENT-OFF* */
94  ({
95  send_udp_encap_details(ue, q, mp->context);
96  }));
97  /* *INDENT-OFF* */
98 }
99 
100 static void
102  vlib_main_t * vm)
103 {
104  vl_api_udp_encap_add_del_reply_t *rmp;
105  ip46_address_t src_ip, dst_ip;
106  u32 fib_index, table_id, ue_id;
107  fib_protocol_t fproto;
108  int rv = 0;
109 
110  ue_id = ntohl(mp->id);
111  table_id = ntohl(mp->table_id);
112  fproto = (mp->is_ip6 ? FIB_PROTOCOL_IP6 : FIB_PROTOCOL_IP4);
113 
114  fib_index = fib_table_find(fproto, table_id);
115 
116  if (~0 == fib_index)
117  {
118  rv = VNET_API_ERROR_NO_SUCH_TABLE;
119  goto done;
120  }
121 
122  if (FIB_PROTOCOL_IP4 == fproto)
123  {
124  clib_memcpy(&src_ip.ip4, mp->src_ip, 4);
125  clib_memcpy(&dst_ip.ip4, mp->dst_ip, 4);
126  }
127  else
128  {
129  clib_memcpy(&src_ip.ip6, mp->src_ip, 16);
130  clib_memcpy(&dst_ip.ip6, mp->dst_ip, 16);
131  }
132 
133  if (mp->is_add)
134  {
135  udp_encap_add_and_lock(ue_id, fproto, fib_index,
136  &src_ip, &dst_ip,
137  ntohs(mp->src_port),
138  ntohs(mp->dst_port),
140  }
141  else
142  {
143  udp_encap_unlock(ue_id);
144  }
145 
146  done:
147  REPLY_MACRO (VL_API_UDP_ENCAP_ADD_DEL_REPLY);
148 }
149 
150 #define vl_msg_name_crc_list
151 #include <vnet/udp/udp.api.h>
152 #undef vl_msg_name_crc_list
153 
154 static void
156 {
157 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
158  foreach_vl_msg_name_crc_udp;
159 #undef _
160 }
161 
162 static clib_error_t *
164 {
165  api_main_t *am = &api_main;
166 
167 #define _(N,n) \
168  vl_msg_api_set_handlers(VL_API_##N, #n, \
169  vl_api_##n##_t_handler, \
170  vl_noop_handler, \
171  vl_api_##n##_t_endian, \
172  vl_api_##n##_t_print, \
173  sizeof(vl_api_##n##_t), 1);
175 #undef _
176 
177  /*
178  * Set up the (msg_name, crc, message-id) table
179  */
181 
182  return 0;
183 }
184 
186 
187 /*
188  * fd.io coding-style-patch-verification: ON
189  *
190  * Local Variables:
191  * eval: (c-set-style "gnu")
192  * End:
193  */
fib_protocol_t ue_ip_proto
the protocol of the IP header imposed
Definition: udp_encap.h:83
#define foreach_udp_api_msg
Definition: udp_api.c:41
The UDP encap represenation.
Definition: udp_encap.h:46
udp_encap_t * udp_encap_pool
Pool of encaps.
Definition: udp_encap.c:34
static clib_error_t * udp_api_hookup(vlib_main_t *vm)
Definition: udp_api.c:163
VLIB_API_INIT_FUNCTION(udp_api_hookup)
static void vl_api_udp_encap_dump_t_handler(vl_api_udp_encap_dump_t *mp, vlib_main_t *vm)
Definition: udp_api.c:82
struct udp_encap_t_::@293::@295 ip6
enum fib_protocol_t_ fib_protocol_t
Protocol Type.
u32 ue_id
The ID given by the user/client.
Definition: udp_encap.h:96
#define pool_foreach(VAR, POOL, BODY)
Iterate through pool.
Definition: pool.h:438
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:1028
void udp_encap_unlock(u32 id)
Definition: udp_encap.c:223
void * vl_msg_api_alloc(int nbytes)
index_t udp_encap_add_and_lock(u32 id, fib_protocol_t proto, index_t fib_index, const ip46_address_t *src_ip, const ip46_address_t *dst_ip, u16 src_port, u16 dst_port, udp_encap_fixup_flags_t flags)
Definition: udp_encap.c:62
#define REPLY_MACRO(t)
API main structure, used by both vpp and binary API clients.
Definition: api_common.h:198
index_t ue_fib_index
The FIB index in which the encap destination resides.
Definition: udp_encap.h:107
api_main_t api_main
Definition: api_shared.c:35
u32 ft_table_id
Table ID (hash key) for this FIB.
Definition: fib_table.h:50
vlib_main_t * vm
Definition: buffer.c:283
#define clib_memcpy(a, b, c)
Definition: string.h:75
unix_shared_memory_queue_t * vl_api_client_index_to_input_queue(u32 index)
static void setup_message_id_table(api_main_t *am)
Definition: udp_api.c:155
void vl_msg_api_send_shmem(unix_shared_memory_queue_t *q, u8 *elem)
unsigned int u32
Definition: types.h:88
Add / del table request A table can be added multiple times, but need be deleted only once...
Definition: udp.api:31
struct udp_encap_t_::@293::@294 ip4
unsigned char u8
Definition: types.h:56
union udp_encap_t_::@293 ue_hdrs
The headers to paint, in packet painting order.
static void vl_api_udp_encap_add_del_t_handler(vl_api_udp_encap_add_del_t *mp, vlib_main_t *vm)
Definition: udp_api.c:101
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
static void send_udp_encap_details(const udp_encap_t *ue, unix_shared_memory_queue_t *q, u32 context)
Definition: udp_api.c:46
A protocol Independent FIB table.
Definition: fib_table.h:35
struct _unix_shared_memory_queue unix_shared_memory_queue_t