FD.io VPP  v18.01.2-1-g9b554f3
Vector Packet Processing
transport.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 
17 #include <vnet/session/session.h>
18 #include <vnet/fib/fib.h>
19 
20 /**
21  * Per-type vector of transport protocol virtual function tables
22  */
24 
25 /*
26  * Port allocator seed
27  */
29 
30 /*
31  * Local endpoints table
32  */
34 
35 /*
36  * Pool of local endpoints
37  */
39 
40 /*
41  * Local endpoints pool lock
42  */
44 
45 u8 *
46 format_transport_proto (u8 * s, va_list * args)
47 {
48  u32 transport_proto = va_arg (*args, u32);
49  switch (transport_proto)
50  {
52  s = format (s, "TCP");
53  break;
55  s = format (s, "UDP");
56  break;
57  }
58  return s;
59 }
60 
61 u8 *
62 format_transport_proto_short (u8 * s, va_list * args)
63 {
64  u32 transport_proto = va_arg (*args, u32);
65  switch (transport_proto)
66  {
68  s = format (s, "T");
69  break;
71  s = format (s, "U");
72  break;
73  }
74  return s;
75 }
76 
77 uword
78 unformat_transport_proto (unformat_input_t * input, va_list * args)
79 {
80  u32 *proto = va_arg (*args, u32 *);
81  if (unformat (input, "tcp"))
82  *proto = TRANSPORT_PROTO_TCP;
83  else if (unformat (input, "TCP"))
84  *proto = TRANSPORT_PROTO_TCP;
85  else if (unformat (input, "udp"))
86  *proto = TRANSPORT_PROTO_UDP;
87  else if (unformat (input, "UDP"))
88  *proto = TRANSPORT_PROTO_UDP;
89  else
90  return 0;
91  return 1;
92 }
93 
94 u32
96  ip46_address_t * ip, u16 port)
97 {
99  int rv;
100 
101  kv.key[0] = ip->as_u64[0];
102  kv.key[1] = ip->as_u64[1];
103  kv.key[2] = (u64) port << 8 | (u64) proto;
104 
105  rv = clib_bihash_search_inline_24_8 (ht, &kv);
106  if (rv == 0)
107  return kv.value;
108 
109  return ENDPOINT_INVALID_INDEX;
110 }
111 
112 void
114  transport_endpoint_t * te, u32 value)
115 {
117 
118  kv.key[0] = te->ip.as_u64[0];
119  kv.key[1] = te->ip.as_u64[1];
120  kv.key[2] = (u64) te->port << 8 | (u64) proto;
121  kv.value = value;
122 
123  clib_bihash_add_del_24_8 (ht, &kv, 1);
124 }
125 
126 void
129 {
131 
132  kv.key[0] = te->ip.as_u64[0];
133  kv.key[1] = te->ip.as_u64[1];
134  kv.key[2] = (u64) te->port << 8 | (u64) proto;
135 
136  clib_bihash_add_del_24_8 (ht, &kv, 0);
137 }
138 
139 /**
140  * Register transport virtual function table.
141  *
142  * @param transport_proto - transport protocol type (i.e., TCP, UDP ..)
143  * @param vft - virtual function table for transport proto
144  * @param fib_proto - network layer protocol
145  * @param output_node - output node index that session layer will hand off
146  * buffers to, for requested fib proto
147  */
148 void
150  const transport_proto_vft_t * vft,
151  fib_protocol_t fib_proto, u32 output_node)
152 {
153  u8 is_ip4 = fib_proto == FIB_PROTOCOL_IP4;
154 
155  vec_validate (tp_vfts, transport_proto);
156  tp_vfts[transport_proto] = *vft;
157 
158  session_register_transport (transport_proto, vft, is_ip4, output_node);
159 }
160 
161 /**
162  * Get transport virtual function table
163  *
164  * @param type - session type (not protocol type)
165  */
168 {
169  if (transport_proto >= vec_len (tp_vfts))
170  return 0;
171  return &tp_vfts[transport_proto];
172 }
173 
174 #define PORT_MASK ((1 << 16)- 1)
175 
176 void
178 {
179  clib_spinlock_lock_if_init (&local_endpoints_lock);
181  clib_spinlock_unlock_if_init (&local_endpoints_lock);
182 }
183 
186 {
188  pool_get (local_endpoints, tep);
189  return tep;
190 }
191 
192 void
193 transport_endpoint_cleanup (u8 proto, ip46_address_t * lcl_ip, u16 port)
194 {
195  u32 tepi;
197 
198  /* Cleanup local endpoint if this was an active connect */
199  tepi = transport_endpoint_lookup (&local_endpoints_table, proto, lcl_ip,
200  clib_net_to_host_u16 (port));
201  if (tepi != ENDPOINT_INVALID_INDEX)
202  {
203  tep = pool_elt_at_index (local_endpoints, tepi);
205  transport_endpoint_del (tepi);
206  }
207 }
208 
209 /**
210  * Allocate local port and add if successful add entry to local endpoint
211  * table to mark the pair as used.
212  */
213 int
214 transport_alloc_local_port (u8 proto, ip46_address_t * ip)
215 {
217  u32 tei;
218  u16 min = 1024, max = 65535; /* XXX configurable ? */
219  int tries, limit;
220 
221  limit = max - min;
222 
223  /* Only support active opens from thread 0 */
224  ASSERT (vlib_get_thread_index () == 0);
225 
226  /* Search for first free slot */
227  for (tries = 0; tries < limit; tries++)
228  {
229  u16 port = 0;
230 
231  /* Find a port in the specified range */
232  while (1)
233  {
235  if (PREDICT_TRUE (port >= min && port < max))
236  break;
237  }
238 
239  /* Look it up. If not found, we're done */
241  port);
242  if (tei == ENDPOINT_INVALID_INDEX)
243  {
244  clib_spinlock_lock_if_init (&local_endpoints_lock);
245  tep = transport_endpoint_new ();
246  clib_memcpy (&tep->ip, ip, sizeof (*ip));
247  tep->port = port;
249  tep - local_endpoints);
250  clib_spinlock_unlock_if_init (&local_endpoints_lock);
251 
252  return tep->port;
253  }
254  }
255  return -1;
256 }
257 
258 int
260  ip46_address_t * lcl_addr, u16 * lcl_port)
261 {
262  fib_prefix_t prefix;
263  fib_node_index_t fei;
264  u32 sw_if_index;
265  int port;
266 
267  /*
268  * Find the local address and allocate port
269  */
270 
271  /* Find a FIB path to the destination */
272  clib_memcpy (&prefix.fp_addr, &rmt->ip, sizeof (rmt->ip));
273  prefix.fp_proto = rmt->is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
274  prefix.fp_len = rmt->is_ip4 ? 32 : 128;
275 
276  ASSERT (rmt->fib_index != ENDPOINT_INVALID_INDEX);
277  fei = fib_table_lookup (rmt->fib_index, &prefix);
278 
279  /* Couldn't find route to destination. Bail out. */
280  if (fei == FIB_NODE_INDEX_INVALID)
281  {
282  clib_warning ("no route to destination");
283  return -1;
284  }
285 
286  sw_if_index = rmt->sw_if_index;
287  if (sw_if_index == ENDPOINT_INVALID_INDEX)
288  sw_if_index = fib_entry_get_resolving_interface (fei);
289 
290  if (sw_if_index == ENDPOINT_INVALID_INDEX)
291  {
292  clib_warning ("no resolving interface for %U", format_ip46_address,
293  &rmt->ip, (rmt->is_ip4 == 0) + 1);
294  return -1;
295  }
296 
297  memset (lcl_addr, 0, sizeof (*lcl_addr));
298 
299  if (rmt->is_ip4)
300  {
301  ip4_address_t *ip4;
302  ip4 = ip_interface_get_first_ip (sw_if_index, 1);
303  lcl_addr->ip4.as_u32 = ip4->as_u32;
304  }
305  else
306  {
307  ip6_address_t *ip6;
308  ip6 = ip_interface_get_first_ip (sw_if_index, 0);
309  if (ip6 == 0)
310  {
311  clib_warning ("no routable ip6 addresses on %U",
313  sw_if_index);
314  return -1;
315  }
316  clib_memcpy (&lcl_addr->ip6, ip6, sizeof (*ip6));
317  }
318 
319  /* Allocate source port */
320  port = transport_alloc_local_port (proto, lcl_addr);
321  if (port < 1)
322  {
323  clib_warning ("Failed to allocate src port");
324  return -1;
325  }
326  *lcl_port = port;
327  return 0;
328 }
329 
330 void
331 transport_update_time (f64 time_now, u8 thread_index)
332 {
334  vec_foreach (vft, tp_vfts)
335  {
336  if (vft->update_time)
337  (vft->update_time) (time_now, thread_index);
338  }
339 }
340 
341 void
343 {
345  vec_foreach (vft, tp_vfts)
346  {
347  if (vft->enable)
348  (vft->enable) (vm, is_en);
349  }
350 }
351 
352 void
354 {
357  u32 num_threads;
358 
359  if (smm->local_endpoints_table_buckets == 0)
360  smm->local_endpoints_table_buckets = 250000;
361  if (smm->local_endpoints_table_memory == 0)
362  smm->local_endpoints_table_memory = 512 << 20;
363 
364  /* Initialize [port-allocator] random number seed */
366 
367  clib_bihash_init_24_8 (&local_endpoints_table, "local endpoints table",
368  smm->local_endpoints_table_buckets,
369  smm->local_endpoints_table_memory);
370  num_threads = 1 /* main thread */ + vtm->n_threads;
371  if (num_threads > 1)
372  clib_spinlock_init (&local_endpoints_lock);
373 }
374 
375 /*
376  * fd.io coding-style-patch-verification: ON
377  *
378  * Local Variables:
379  * eval: (c-set-style "gnu")
380  * End:
381  */
#define vec_validate(V, I)
Make sure vector is long enough for given index (no header, unspecified alignment) ...
Definition: vec.h:432
fib_protocol_t fp_proto
protocol type
Definition: fib_types.h:181
u32 transport_endpoint_lookup(transport_endpoint_table_t *ht, u8 proto, ip46_address_t *ip, u16 port)
Definition: transport.c:95
u8 * format_transport_proto_short(u8 *s, va_list *args)
Definition: transport.c:62
vnet_main_t * vnet_get_main(void)
Definition: misc.c:47
void transport_endpoint_table_add(transport_endpoint_table_t *ht, u8 proto, transport_endpoint_t *te, u32 value)
Definition: transport.c:113
#define PREDICT_TRUE(x)
Definition: clib.h:106
static transport_endpoint_table_t local_endpoints_table
Definition: transport.c:33
static_always_inline void clib_spinlock_unlock_if_init(clib_spinlock_t *p)
Definition: lock.h:85
struct _transport_proto_vft transport_proto_vft_t
static u64 clib_cpu_time_now(void)
Definition: time.h:73
format_function_t format_ip46_address
Definition: format.h:61
void * ip_interface_get_first_ip(u32 sw_if_index, u8 is_ip4)
Definition: ip.c:119
u8 * format(u8 *s, const char *fmt,...)
Definition: format.c:419
#define pool_get(P, E)
Allocate an object E from a pool P (unspecified alignment).
Definition: pool.h:225
void transport_endpoint_del(u32 tepi)
Definition: transport.c:177
format_function_t format_vnet_sw_if_index_name
void transport_update_time(f64 time_now, u8 thread_index)
Definition: transport.c:331
enum fib_protocol_t_ fib_protocol_t
Protocol Type.
#define always_inline
Definition: clib.h:92
Aggregrate type for a prefix.
Definition: fib_types.h:172
unsigned long u64
Definition: types.h:89
u16 fp_len
The mask length.
Definition: fib_types.h:176
static clib_spinlock_t local_endpoints_lock
Definition: transport.c:43
fib_node_index_t fib_table_lookup(u32 fib_index, const fib_prefix_t *prefix)
Perfom a longest prefix match in the non-forwarding table.
Definition: fib_table.c:66
static void clib_spinlock_init(clib_spinlock_t *p)
Definition: lock.h:33
transport_proto_vft_t * transport_protocol_get_vft(transport_proto_t transport_proto)
Get transport virtual function table.
Definition: transport.c:167
static session_manager_main_t * vnet_get_session_manager_main()
Definition: session.h:207
#define pool_elt_at_index(p, i)
Returns pointer to element at given index.
Definition: pool.h:459
void transport_endpoint_table_del(transport_endpoint_table_t *ht, u8 proto, transport_endpoint_t *te)
Definition: transport.c:127
ip46_address_t fp_addr
The address type is not deriveable from the fp_addr member.
Definition: fib_types.h:195
struct _unformat_input_t unformat_input_t
static transport_endpoint_t * local_endpoints
Definition: transport.c:38
transport_proto_vft_t * tp_vfts
Per-type vector of transport protocol virtual function tables.
Definition: transport.c:23
struct _session_manager_main session_manager_main_t
Definition: session.h:103
u32 fib_entry_get_resolving_interface(fib_node_index_t entry_index)
Definition: fib_entry.c:1352
void transport_init(void)
Definition: transport.c:353
static_always_inline uword vlib_get_thread_index(void)
Definition: threads.h:221
vlib_main_t * vm
Definition: buffer.c:283
clib_bihash_24_8_t transport_endpoint_table_t
Definition: transport.h:95
#define ENDPOINT_INVALID_INDEX
Definition: transport.h:97
#define clib_warning(format, args...)
Definition: error.h:59
#define PORT_MASK
Definition: transport.c:174
#define clib_memcpy(a, b, c)
Definition: string.h:75
u32 fib_node_index_t
A typedef of a node index.
Definition: fib_types.h:29
void transport_enable_disable(vlib_main_t *vm, u8 is_en)
Definition: transport.c:342
void transport_endpoint_cleanup(u8 proto, ip46_address_t *lcl_ip, u16 port)
Definition: transport.c:193
void transport_register_protocol(transport_proto_t transport_proto, const transport_proto_vft_t *vft, fib_protocol_t fib_proto, u32 output_node)
Register transport virtual function table.
Definition: transport.c:149
#define pool_put_index(p, i)
Free pool element with given index.
Definition: pool.h:294
#define ASSERT(truth)
unsigned int u32
Definition: types.h:88
uword unformat_transport_proto(unformat_input_t *input, va_list *args)
Definition: transport.c:78
static transport_endpoint_t * transport_endpoint_new(void)
Definition: transport.c:185
u64 uword
Definition: types.h:112
static u32 port_allocator_seed
Definition: transport.c:28
unsigned short u16
Definition: types.h:57
#define FIB_NODE_INDEX_INVALID
Definition: fib_types.h:30
enum _transport_proto transport_proto_t
#define vec_len(v)
Number of elements in vector (rvalue-only, NULL tolerant)
double f64
Definition: types.h:142
unsigned char u8
Definition: types.h:56
struct _transport_endpoint transport_endpoint_t
static u32 random_u32(u32 *seed)
32-bit random number generator
Definition: random.h:69
static vlib_thread_main_t * vlib_get_thread_main()
Definition: global_funcs.h:32
#define vec_foreach(var, vec)
Vector iterator.
int transport_alloc_local_endpoint(u8 proto, transport_endpoint_t *rmt, ip46_address_t *lcl_addr, u16 *lcl_port)
Definition: transport.c:259
int transport_alloc_local_port(u8 proto, ip46_address_t *ip)
Allocate local port and add if successful add entry to local endpoint table to mark the pair as used...
Definition: transport.c:214
void session_register_transport(transport_proto_t transport_proto, const transport_proto_vft_t *vft, u8 is_ip4, u32 output_node)
Initialize session layer for given transport proto and ip version.
Definition: session.c:999
static_always_inline void clib_spinlock_lock_if_init(clib_spinlock_t *p)
Definition: lock.h:65
u8 * format_transport_proto(u8 *s, va_list *args)
Definition: transport.c:46
uword unformat(unformat_input_t *i, const char *fmt,...)
Definition: unformat.c:972