FD.io VPP  v19.08-27-gf4dcae4
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, *to_next;
84  u32 next_index, errors;
85  u32 my_thread_index = vm->thread_index;
86 
87  from = vlib_frame_vector_args (frame);
88  n_left_from = frame->n_vectors;
89  next_index = node->cached_next_index;
90 
91  while (n_left_from > 0)
92  {
93  u32 n_left_to_next;
94 
95  vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
96 
97  while (n_left_from > 0 && n_left_to_next > 0)
98  {
99  u32 bi0, fib_index0;
100  vlib_buffer_t *b0;
101  u32 next0 = UDP_INPUT_NEXT_DROP;
102  u32 error0 = UDP_ERROR_ENQUEUED;
103  udp_header_t *udp0;
104  ip4_header_t *ip40;
105  ip6_header_t *ip60;
106  u8 *data0;
107  session_t *s0;
108  udp_connection_t *uc0, *child0, *new_uc0;
110  int wrote0;
111  void *rmt_addr, *lcl_addr;
112  session_dgram_hdr_t hdr0;
113  u8 queue_event = 1;
114 
115  /* speculatively enqueue b0 to the current next frame */
116  bi0 = from[0];
117  to_next[0] = bi0;
118  from += 1;
119  to_next += 1;
120  n_left_from -= 1;
121  n_left_to_next -= 1;
122 
123  b0 = vlib_get_buffer (vm, bi0);
124 
125  /* udp_local hands us a pointer to the udp data */
126  data0 = vlib_buffer_get_current (b0);
127  udp0 = (udp_header_t *) (data0 - sizeof (*udp0));
128  fib_index0 = vnet_buffer (b0)->ip.fib_index;
129 
130  if (is_ip4)
131  {
132  /* TODO: must fix once udp_local does ip options correctly */
133  ip40 = (ip4_header_t *) (((u8 *) udp0) - sizeof (*ip40));
134  s0 = session_lookup_safe4 (fib_index0, &ip40->dst_address,
135  &ip40->src_address, udp0->dst_port,
137  lcl_addr = &ip40->dst_address;
138  rmt_addr = &ip40->src_address;
139 
140  }
141  else
142  {
143  ip60 = (ip6_header_t *) (((u8 *) udp0) - sizeof (*ip60));
144  s0 = session_lookup_safe6 (fib_index0, &ip60->dst_address,
145  &ip60->src_address, udp0->dst_port,
147  lcl_addr = &ip60->dst_address;
148  rmt_addr = &ip60->src_address;
149  }
150 
151  if (PREDICT_FALSE (!s0))
152  {
153  error0 = UDP_ERROR_NO_LISTENER;
154  goto trace0;
155  }
156 
158  {
159  /* TODO optimization: move cl session to right thread
160  * However, since such a move would affect the session handle,
161  * which we pass 'raw' to the app, we'd also have notify the
162  * app of the change or change the way we pass handles to apps.
163  */
164  tc0 = session_get_transport (s0);
166  if (uc0->flags & UDP_CONN_F_CONNECTED)
167  {
168  if (s0->thread_index != vlib_get_thread_index ())
169  {
170  /*
171  * Clone the transport. It will be cleaned up with the
172  * session once we notify the session layer.
173  */
174  new_uc0 =
176  s0->thread_index);
177  ASSERT (s0->session_index == new_uc0->c_s_index);
178 
179  /*
180  * Drop the 'lock' on pool resize
181  */
184  s0->thread_index, &s0);
185  tc0 = &new_uc0->connection;
186  uc0 = new_uc0;
187  queue_event = 0;
188  }
189  else
191  }
192  }
193  else if (s0->session_state == SESSION_STATE_READY)
194  {
195  tc0 = session_get_transport (s0);
197  }
198  else if (s0->session_state == SESSION_STATE_LISTENING)
199  {
200  tc0 = listen_session_get_transport (s0);
202  if (uc0->flags & UDP_CONN_F_CONNECTED)
203  {
204  child0 = udp_connection_alloc (my_thread_index);
205  if (is_ip4)
206  {
207  ip_set (&child0->c_lcl_ip, &ip40->dst_address, 1);
208  ip_set (&child0->c_rmt_ip, &ip40->src_address, 1);
209  }
210  else
211  {
212  ip_set (&child0->c_lcl_ip, &ip60->dst_address, 0);
213  ip_set (&child0->c_rmt_ip, &ip60->src_address, 0);
214  }
215  child0->c_lcl_port = udp0->dst_port;
216  child0->c_rmt_port = udp0->src_port;
217  child0->c_is_ip4 = is_ip4;
218  child0->c_fib_index = tc0->fib_index;
219  child0->flags |= UDP_CONN_F_CONNECTED;
220 
221  if (session_stream_accept (&child0->connection,
222  tc0->s_index, tc0->thread_index,
223  1))
224  {
225  error0 = UDP_ERROR_CREATE_SESSION;
226  goto trace0;
227  }
228  s0 = session_get (child0->c_s_index,
229  child0->c_thread_index);
231  tc0 = &child0->connection;
233  error0 = UDP_ERROR_LISTENER;
234  }
235  }
236  else
237  {
238  error0 = UDP_ERROR_NOT_READY;
239  goto trace0;
240  }
241 
242 
244  < b0->current_length + sizeof (session_dgram_hdr_t))
245  {
246  error0 = UDP_ERROR_FIFO_FULL;
247  goto trace0;
248  }
249  hdr0.data_length = b0->current_length;
250  hdr0.data_offset = 0;
251  ip_set (&hdr0.lcl_ip, lcl_addr, is_ip4);
252  ip_set (&hdr0.rmt_ip, rmt_addr, is_ip4);
253  hdr0.lcl_port = udp0->dst_port;
254  hdr0.rmt_port = udp0->src_port;
255  hdr0.is_ip4 = is_ip4;
256 
257  clib_spinlock_lock (&uc0->rx_lock);
258  /* If session is owned by another thread and rx event needed,
259  * enqueue event now while we still have the peeker lock */
260  if (s0->thread_index != my_thread_index)
261  {
262  wrote0 = session_enqueue_dgram_connection (s0, &hdr0, b0,
264  /* queue event */ 0);
265  if (queue_event && !svm_fifo_has_event (s0->rx_fifo))
267  }
268  else
269  {
270  wrote0 = session_enqueue_dgram_connection (s0, &hdr0, b0,
272  queue_event);
273  }
275  ASSERT (wrote0 > 0);
276 
279 
280  trace0:
281 
282  b0->error = node->errors[error0];
283 
285  && (b0->flags & VLIB_BUFFER_IS_TRACED)))
286  {
287  udp_input_trace_t *t = vlib_add_trace (vm, node, b0,
288  sizeof (*t));
289 
290  t->connection = s0 ? s0->connection_index : ~0;
291  t->disposition = error0;
292  t->thread_index = my_thread_index;
293  }
294 
295  vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
296  to_next, n_left_to_next,
297  bi0, next0);
298  }
299 
300  vlib_put_next_frame (vm, node, next_index, n_left_to_next);
301  }
302 
304  my_thread_index);
305  udp_input_inc_counter (vm, is_ip4, UDP_ERROR_EVENT_FIFO_FULL, errors);
306  return frame->n_vectors;
307 }
308 
309 
310 static uword
312  vlib_frame_t * frame)
313 {
314  return udp46_input_inline (vm, node, frame, 1);
315 }
316 
317 /* *INDENT-OFF* */
319 {
320  .function = udp4_input,
321  .name = "udp4-input",
322  .vector_size = sizeof (u32),
323  .format_trace = format_udp_input_trace,
325  .n_errors = ARRAY_LEN (udp_error_strings),
326  .error_strings = udp_error_strings,
327  .n_next_nodes = UDP_INPUT_N_NEXT,
328  .next_nodes = {
329 #define _(s, n) [UDP_INPUT_NEXT_##s] = n,
331 #undef _
332  },
333 };
334 /* *INDENT-ON* */
335 
336 static uword
338  vlib_frame_t * frame)
339 {
340  return udp46_input_inline (vm, node, frame, 0);
341 }
342 
343 /* *INDENT-OFF* */
345 {
346  .function = udp6_input,
347  .name = "udp6-input",
348  .vector_size = sizeof (u32),
349  .format_trace = format_udp_input_trace,
351  .n_errors = ARRAY_LEN (udp_error_strings),
352  .error_strings = udp_error_strings,
353  .n_next_nodes = UDP_INPUT_N_NEXT,
354  .next_nodes = {
355 #define _(s, n) [UDP_INPUT_NEXT_##s] = n,
357 #undef _
358  },
359 };
360 /* *INDENT-ON* */
361 
362 /*
363  * fd.io coding-style-patch-verification: ON
364  *
365  * Local Variables:
366  * eval: (c-set-style "gnu")
367  * End:
368  */
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:100
static_always_inline void clib_spinlock_lock(clib_spinlock_t *p)
Definition: lock.h:78
#define CLIB_UNUSED(x)
Definition: clib.h:82
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:609
ip4_address_t src_address
Definition: ip4_packet.h:170
#define PREDICT_TRUE(x)
Definition: clib.h:112
u32 session_index
Index in thread pool where session was allocated.
transport_connection_t * listen_session_get_transport(session_t *s)
Definition: session.c:1421
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:90
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:1398
svm_fifo_t * rx_fifo
Pointers to rx/tx buffers.
u32 thread_index
Definition: main.h:197
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:439
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:631
udp_input_next_t
Definition: udp_input.c:59
static void session_pool_remove_peeker(u32 thread_index)
Definition: session.h:316
static session_t * session_get(u32 si, u32 thread_index)
Definition: session.h:258
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:468
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:344
#define always_inline
Definition: clib.h:98
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:311
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:111
#define vlib_validate_buffer_enqueue_x1(vm, node, next_index, to_next, n_left_to_next, bi0, next0)
Finish enqueueing one buffer forward in the graph.
Definition: buffer_node.h:218
#define vlib_get_next_frame(vm, node, next_index, vectors, n_vectors_left)
Get pointer to next frame vector data by (vlib_node_runtime_t, next_index).
Definition: node_funcs.h:338
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:395
static_always_inline uword vlib_get_thread_index(void)
Definition: threads.h:213
vlib_main_t * vm
Definition: buffer.c:312
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:787
struct _transport_connection transport_connection_t
#define ARRAY_LEN(x)
Definition: clib.h:62
void vlib_put_next_frame(vlib_main_t *vm, vlib_node_runtime_t *r, u32 next_index, u32 n_vectors_left)
Release pointer to next frame vector data.
Definition: main.c:458
connected mode
Definition: udp.h:39
u16 cached_next_index
Next frame index that vector arguments were last enqueued to last time this node ran.
Definition: node.h:513
#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
vlib_node_registration_t udp4_input_node
(constructor) VLIB_REGISTER_NODE (udp4_input_node)
Definition: udp_input.c:318
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:563
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:361
static int svm_fifo_has_event(svm_fifo_t *f)
Check if fifo has io event.
Definition: svm_fifo.h:725
static uword udp6_input(vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *frame)
Definition: udp_input.c:337
u16 flags
Copy of main node flags.
Definition: node.h:507
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:983
#define VLIB_NODE_FLAG_TRACE
Definition: node.h:301
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