FD.io VPP  v19.08.3-2-gbabecb413
Vector Packet Processing
udp_input.c
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2016-2019 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 <vlibmemory/api.h>
17 #include <vlib/vlib.h>
18 
19 #include <vppinfra/hash.h>
20 #include <vppinfra/error.h>
21 #include <vppinfra/elog.h>
22 
23 #include <vnet/vnet.h>
24 #include <vnet/pg/pg.h>
25 #include <vnet/ip/ip.h>
26 #include <vnet/udp/udp.h>
27 #include <vnet/udp/udp_packet.h>
28 #include <vnet/session/session.h>
29 
30 static char *udp_error_strings[] = {
31 #define udp_error(n,s) s,
32 #include "udp_error.def"
33 #undef udp_error
34 };
35 
36 typedef struct
37 {
42 
43 /* packet trace format function */
44 static u8 *
45 format_udp_input_trace (u8 * s, va_list * args)
46 {
47  CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
48  CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
49  udp_input_trace_t *t = va_arg (*args, udp_input_trace_t *);
50 
51  s = format (s, "UDP_INPUT: connection %d, disposition %d, thread %d",
53  return s;
54 }
55 
56 #define foreach_udp_input_next \
57  _ (DROP, "error-drop")
58 
59 typedef enum
60 {
61 #define _(s, n) UDP_INPUT_NEXT_##s,
63 #undef _
66 
67 always_inline void
68 udp_input_inc_counter (vlib_main_t * vm, u8 is_ip4, u8 evt, u8 val)
69 {
70  if (PREDICT_TRUE (!val))
71  return;
72 
73  if (is_ip4)
74  vlib_node_increment_counter (vm, udp4_input_node.index, evt, val);
75  else
76  vlib_node_increment_counter (vm, udp6_input_node.index, evt, val);
77 }
78 
81  vlib_frame_t * frame, u8 is_ip4)
82 {
83  u32 n_left_from, *from;
84  u32 errors, *first_buffer;
85  u32 my_thread_index = vm->thread_index;
86 
87  from = first_buffer = vlib_frame_vector_args (frame);
88  n_left_from = frame->n_vectors;
89 
90  while (n_left_from > 0)
91  {
92  u32 bi0, fib_index0, data_len;
93  vlib_buffer_t *b0;
94  u32 error0 = UDP_ERROR_ENQUEUED;
95  udp_header_t *udp0;
96  ip4_header_t *ip40;
97  ip6_header_t *ip60;
98  u8 *data0;
99  session_t *s0;
100  udp_connection_t *uc0, *child0, *new_uc0;
102  int wrote0;
103  void *rmt_addr, *lcl_addr;
104  session_dgram_hdr_t hdr0;
105  u8 queue_event = 1;
106 
107  /* speculatively enqueue b0 to the current next frame */
108  bi0 = from[0];
109  from += 1;
110  n_left_from -= 1;
111 
112  b0 = vlib_get_buffer (vm, bi0);
113 
114  /* udp_local hands us a pointer to the udp data */
115  data0 = vlib_buffer_get_current (b0);
116  udp0 = (udp_header_t *) (data0 - sizeof (*udp0));
117  fib_index0 = vnet_buffer (b0)->ip.fib_index;
118 
119  if (is_ip4)
120  {
121  /* TODO: must fix once udp_local does ip options correctly */
122  ip40 = (ip4_header_t *) (((u8 *) udp0) - sizeof (*ip40));
123  s0 = session_lookup_safe4 (fib_index0, &ip40->dst_address,
124  &ip40->src_address, udp0->dst_port,
125  udp0->src_port, TRANSPORT_PROTO_UDP);
126  lcl_addr = &ip40->dst_address;
127  rmt_addr = &ip40->src_address;
128  data_len = clib_net_to_host_u16 (ip40->length);
129  data_len -= sizeof (ip4_header_t) + sizeof (udp_header_t);
130  }
131  else
132  {
133  ip60 = (ip6_header_t *) (((u8 *) udp0) - sizeof (*ip60));
134  s0 = session_lookup_safe6 (fib_index0, &ip60->dst_address,
135  &ip60->src_address, udp0->dst_port,
136  udp0->src_port, TRANSPORT_PROTO_UDP);
137  lcl_addr = &ip60->dst_address;
138  rmt_addr = &ip60->src_address;
139  data_len = clib_net_to_host_u16 (ip60->payload_length);
140  data_len -= sizeof (udp_header_t);
141  }
142 
143  if (PREDICT_FALSE (!s0))
144  {
145  error0 = UDP_ERROR_NO_LISTENER;
146  goto trace0;
147  }
148 
149  if (s0->session_state == SESSION_STATE_OPENED)
150  {
151  /* TODO optimization: move cl session to right thread
152  * However, since such a move would affect the session handle,
153  * which we pass 'raw' to the app, we'd also have notify the
154  * app of the change or change the way we pass handles to apps.
155  */
156  tc0 = session_get_transport (s0);
158  if (uc0->flags & UDP_CONN_F_CONNECTED)
159  {
160  if (s0->thread_index != vlib_get_thread_index ())
161  {
162  /*
163  * Clone the transport. It will be cleaned up with the
164  * session once we notify the session layer.
165  */
166  new_uc0 =
168  s0->thread_index);
169  ASSERT (s0->session_index == new_uc0->c_s_index);
170 
171  /*
172  * Drop the 'lock' on pool resize
173  */
176  s0->thread_index, &s0);
177  tc0 = &new_uc0->connection;
178  uc0 = new_uc0;
179  queue_event = 0;
180  }
181  else
182  s0->session_state = SESSION_STATE_READY;
183  }
184  }
185  else if (s0->session_state == SESSION_STATE_READY)
186  {
187  tc0 = session_get_transport (s0);
189  }
190  else if (s0->session_state == SESSION_STATE_LISTENING)
191  {
192  tc0 = listen_session_get_transport (s0);
194  if (uc0->flags & UDP_CONN_F_CONNECTED)
195  {
196  child0 = udp_connection_alloc (my_thread_index);
197  if (is_ip4)
198  {
199  ip_set (&child0->c_lcl_ip, &ip40->dst_address, 1);
200  ip_set (&child0->c_rmt_ip, &ip40->src_address, 1);
201  }
202  else
203  {
204  ip_set (&child0->c_lcl_ip, &ip60->dst_address, 0);
205  ip_set (&child0->c_rmt_ip, &ip60->src_address, 0);
206  }
207  child0->c_lcl_port = udp0->dst_port;
208  child0->c_rmt_port = udp0->src_port;
209  child0->c_is_ip4 = is_ip4;
210  child0->c_fib_index = tc0->fib_index;
211  child0->flags |= UDP_CONN_F_CONNECTED;
212 
213  if (session_stream_accept (&child0->connection,
214  tc0->s_index, tc0->thread_index, 1))
215  {
216  error0 = UDP_ERROR_CREATE_SESSION;
217  goto trace0;
218  }
219  s0 = session_get (child0->c_s_index, child0->c_thread_index);
220  s0->session_state = SESSION_STATE_READY;
221  tc0 = &child0->connection;
223  error0 = UDP_ERROR_LISTENER;
224  }
225  }
226  else
227  {
228  error0 = UDP_ERROR_NOT_READY;
229  goto trace0;
230  }
231 
232 
234  < data_len + sizeof (session_dgram_hdr_t))
235  {
236  error0 = UDP_ERROR_FIFO_FULL;
237  goto trace0;
238  }
239  hdr0.data_length = b0->current_length = data_len;
240  hdr0.data_offset = 0;
241  ip_set (&hdr0.lcl_ip, lcl_addr, is_ip4);
242  ip_set (&hdr0.rmt_ip, rmt_addr, is_ip4);
243  hdr0.lcl_port = udp0->dst_port;
244  hdr0.rmt_port = udp0->src_port;
245  hdr0.is_ip4 = is_ip4;
246 
247  clib_spinlock_lock (&uc0->rx_lock);
248  /* If session is owned by another thread and rx event needed,
249  * enqueue event now while we still have the peeker lock */
250  if (s0->thread_index != my_thread_index)
251  {
252  wrote0 = session_enqueue_dgram_connection (s0, &hdr0, b0,
253  TRANSPORT_PROTO_UDP,
254  /* queue event */ 0);
255  if (queue_event && !svm_fifo_has_event (s0->rx_fifo))
257  }
258  else
259  {
260  wrote0 = session_enqueue_dgram_connection (s0, &hdr0, b0,
261  TRANSPORT_PROTO_UDP,
262  queue_event);
263  }
265  ASSERT (wrote0 > 0);
266 
267  if (s0->session_state != SESSION_STATE_LISTENING)
269 
270  trace0:
271 
272  b0->error = node->errors[error0];
273 
275  && (b0->flags & VLIB_BUFFER_IS_TRACED)))
276  {
277  udp_input_trace_t *t = vlib_add_trace (vm, node, b0,
278  sizeof (*t));
279 
280  t->connection = s0 ? s0->connection_index : ~0;
281  t->disposition = error0;
282  t->thread_index = my_thread_index;
283  }
284  }
285 
286  vlib_buffer_free (vm, first_buffer, frame->n_vectors);
287  errors = session_main_flush_enqueue_events (TRANSPORT_PROTO_UDP,
288  my_thread_index);
289  udp_input_inc_counter (vm, is_ip4, UDP_ERROR_EVENT_FIFO_FULL, errors);
290  return frame->n_vectors;
291 }
292 
293 
294 static uword
296  vlib_frame_t * frame)
297 {
298  return udp46_input_inline (vm, node, frame, 1);
299 }
300 
301 /* *INDENT-OFF* */
303 {
304  .function = udp4_input,
305  .name = "udp4-input",
306  .vector_size = sizeof (u32),
307  .format_trace = format_udp_input_trace,
309  .n_errors = ARRAY_LEN (udp_error_strings),
310  .error_strings = udp_error_strings,
311  .n_next_nodes = UDP_INPUT_N_NEXT,
312  .next_nodes = {
313 #define _(s, n) [UDP_INPUT_NEXT_##s] = n,
315 #undef _
316  },
317 };
318 /* *INDENT-ON* */
319 
320 static uword
322  vlib_frame_t * frame)
323 {
324  return udp46_input_inline (vm, node, frame, 0);
325 }
326 
327 /* *INDENT-OFF* */
329 {
330  .function = udp6_input,
331  .name = "udp6-input",
332  .vector_size = sizeof (u32),
333  .format_trace = format_udp_input_trace,
335  .n_errors = ARRAY_LEN (udp_error_strings),
336  .error_strings = udp_error_strings,
337  .n_next_nodes = UDP_INPUT_N_NEXT,
338  .next_nodes = {
339 #define _(s, n) [UDP_INPUT_NEXT_##s] = n,
341 #undef _
342  },
343 };
344 /* *INDENT-ON* */
345 
346 /*
347  * fd.io coding-style-patch-verification: ON
348  *
349  * Local Variables:
350  * eval: (c-set-style "gnu")
351  * End:
352  */
u32 flags
buffer flags: VLIB_BUFFER_FREE_LIST_INDEX_MASK: bits used to store free list index, VLIB_BUFFER_IS_TRACED: trace this buffer.
Definition: buffer.h:124
u32 connection_index
Index of the transport connection associated to the session.
static_always_inline void clib_spinlock_unlock(clib_spinlock_t *p)
Definition: lock.h:102
static_always_inline void clib_spinlock_lock(clib_spinlock_t *p)
Definition: lock.h:80
#define CLIB_UNUSED(x)
Definition: clib.h:83
static u32 svm_fifo_max_enqueue_prod(svm_fifo_t *f)
Maximum number of bytes that can be enqueued into fifo.
Definition: svm_fifo.h:618
static void vlib_buffer_free(vlib_main_t *vm, u32 *buffers, u32 n_buffers)
Free buffers Frees the entire buffer chain for each buffer.
Definition: buffer_funcs.h:865
ip4_address_t src_address
Definition: ip4_packet.h:170
#define PREDICT_TRUE(x)
Definition: clib.h:113
u32 session_index
Index in thread pool where session was allocated.
transport_connection_t * listen_session_get_transport(session_t *s)
Definition: session.c:1491
static udp_connection_t * udp_get_connection_from_transport(transport_connection_t *tc)
Definition: udp.h:182
void ip_set(ip46_address_t *dst, void *src, u8 is_ip4)
Definition: ip.c:93
session_t * session_lookup_safe4(u32 fib_index, ip4_address_t *lcl, ip4_address_t *rmt, u16 lcl_port, u16 rmt_port, u8 proto)
Lookup session with ip4 and transport layer information.
transport_connection_t * session_get_transport(session_t *s)
Definition: session.c:1468
svm_fifo_t * rx_fifo
Pointers to rx/tx buffers.
u32 thread_index
Definition: main.h:218
int session_enqueue_dgram_connection(session_t *s, session_dgram_hdr_t *hdr, vlib_buffer_t *b, u8 proto, u8 queue_event)
Definition: session.c:467
u16 current_length
Nbytes between current data and the end of this buffer.
Definition: buffer.h:113
int session_main_flush_enqueue_events(u8 transport_proto, u32 thread_index)
Flushes queue of sessions that are to be notified of new data enqueued events.
Definition: session.c:664
udp_input_next_t
Definition: udp_input.c:59
static void session_pool_remove_peeker(u32 thread_index)
Definition: session.h:353
static session_t * session_get(u32 si, u32 thread_index)
Definition: session.h:295
u8 * format(u8 *s, const char *fmt,...)
Definition: format.c:424
session_t * session_lookup_safe6(u32 fib_index, ip6_address_t *lcl, ip6_address_t *rmt, u16 lcl_port, u16 rmt_port, u8 proto)
Lookup session with ip6 and transport layer information.
vlib_error_t * errors
Vector of errors for this node.
Definition: node.h:470
ip6_address_t src_address
Definition: ip6_packet.h:383
unsigned char u8
Definition: types.h:56
u8 flags
connection flags
Definition: udp.h:50
static void udp_input_inc_counter(vlib_main_t *vm, u8 is_ip4, u8 evt, u8 val)
Definition: udp_input.c:68
vlib_node_registration_t udp6_input_node
(constructor) VLIB_REGISTER_NODE (udp6_input_node)
Definition: udp_input.c:328
#define always_inline
Definition: clib.h:99
ip4_address_t dst_address
Definition: ip4_packet.h:170
static uword udp4_input(vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *frame)
Definition: udp_input.c:295
ip46_address_t lcl_ip
unsigned int u32
Definition: types.h:88
vl_api_fib_path_type_t type
Definition: fib_types.api:123
vlib_error_t error
Error code for buffers to be enqueued to error handler.
Definition: buffer.h:136
udp_connection_t * udp_connection_alloc(u32 thread_index)
Definition: udp.c:28
static void * vlib_buffer_get_current(vlib_buffer_t *b)
Get pointer to current data to process.
Definition: buffer.h:229
static uword udp46_input_inline(vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *frame, u8 is_ip4)
Definition: udp_input.c:80
#define PREDICT_FALSE(x)
Definition: clib.h:112
static void vlib_node_increment_counter(vlib_main_t *vm, u32 node_index, u32 counter_index, u64 increment)
Definition: node_funcs.h:1150
The fine-grained event logger allows lightweight, thread-safe event logging at minimum cost...
#define VLIB_REGISTER_NODE(x,...)
Definition: node.h:169
u16 n_vectors
Definition: node.h:397
static_always_inline uword vlib_get_thread_index(void)
Definition: threads.h:218
vlib_main_t * vm
Definition: buffer.c:323
int session_dgram_connect_notify(transport_connection_t *tc, u32 old_thread_index, session_t **new_session)
Move dgram session to the right thread.
Definition: session.c:823
struct _transport_connection transport_connection_t
#define ARRAY_LEN(x)
Definition: clib.h:63
connected mode
Definition: udp.h:39
#define ASSERT(truth)
static u8 * format_udp_input_trace(u8 *s, va_list *args)
Definition: udp_input.c:45
static char * udp_error_strings[]
Definition: udp_input.c:30
ip46_address_t rmt_ip
u8 thread_index
Index of the thread that allocated the session.
static void * vlib_add_trace(vlib_main_t *vm, vlib_node_runtime_t *r, vlib_buffer_t *b, u32 n_data_bytes)
Definition: trace_funcs.h:55
#define foreach_udp_input_next
Definition: udp_input.c:56
u16 payload_length
Definition: ip6_packet.h:374
vlib_node_registration_t udp4_input_node
(constructor) VLIB_REGISTER_NODE (udp4_input_node)
Definition: udp_input.c:302
transport_connection_t connection
must be first
Definition: udp.h:48
clib_spinlock_t rx_lock
rx fifo lock
Definition: udp.h:49
volatile u8 session_state
State in session layer state machine.
int session_enqueue_notify(session_t *s)
Definition: session.c:596
VLIB buffer representation.
Definition: buffer.h:102
u64 uword
Definition: types.h:112
static void * vlib_frame_vector_args(vlib_frame_t *f)
Get pointer to frame vector data.
Definition: node_funcs.h:244
#define vnet_buffer(b)
Definition: buffer.h:365
static int svm_fifo_has_event(svm_fifo_t *f)
Check if fifo has io event.
Definition: svm_fifo.h:734
static uword udp6_input(vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *frame)
Definition: udp_input.c:321
u16 flags
Copy of main node flags.
Definition: node.h:509
static udp_connection_t * udp_connection_clone_safe(u32 connection_index, u32 thread_index)
Definition: udp.h:227
int session_stream_accept(transport_connection_t *tc, u32 listener_index, u32 thread_index, u8 notify)
Accept a stream session.
Definition: session.c:1020
#define VLIB_NODE_FLAG_TRACE
Definition: node.h:302
static vlib_buffer_t * vlib_get_buffer(vlib_main_t *vm, u32 buffer_index)
Translate buffer index into buffer pointer.
Definition: buffer_funcs.h:85
ip6_address_t dst_address
Definition: ip6_packet.h:383