FD.io VPP  v20.09-64-g4f7b92f0a
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 (is_ip4)
71  vlib_node_increment_counter (vm, udp4_input_node.index, evt, val);
72  else
73  vlib_node_increment_counter (vm, udp6_input_node.index, evt, val);
74 }
75 
76 #define udp_store_err_counters(vm, is_ip4, cnts) \
77 { \
78  int i; \
79  for (i = 0; i < UDP_N_ERROR; i++) \
80  if (cnts[i]) \
81  udp_input_inc_counter(vm, is_ip4, i, cnts[i]); \
82 }
83 
84 #define udp_inc_err_counter(cnts, err, val) \
85 { \
86  cnts[err] += val; \
87 }
88 
89 static void
91  vlib_buffer_t * b, session_t * s, u16 error0)
92 {
94 
95  if (PREDICT_TRUE (!(b->flags & VLIB_BUFFER_IS_TRACED)))
96  return;
97 
98  t = vlib_add_trace (vm, node, b, sizeof (*t));
99  t->connection = s ? s->connection_index : ~0;
100  t->disposition = error0;
101  t->thread_index = s ? s->thread_index : vm->thread_index;
102 }
103 
104 static udp_connection_t *
106  u32 thread_index)
107 {
108  udp_connection_t *uc;
109 
110  uc = udp_connection_alloc (thread_index);
111  ip_copy (&uc->c_lcl_ip, &hdr->lcl_ip, hdr->is_ip4);
112  ip_copy (&uc->c_rmt_ip, &hdr->rmt_ip, hdr->is_ip4);
113  uc->c_lcl_port = hdr->lcl_port;
114  uc->c_rmt_port = hdr->rmt_port;
115  uc->c_is_ip4 = hdr->is_ip4;
116  uc->c_fib_index = listener->c_fib_index;
117  uc->mss = listener->mss;
118  uc->flags |= UDP_CONN_F_CONNECTED;
119 
120  if (session_dgram_accept (&uc->connection, listener->c_s_index,
121  listener->c_thread_index))
122  {
123  udp_connection_free (uc);
124  return 0;
125  }
126  udp_connection_share_port (clib_net_to_host_u16
127  (uc->c_lcl_port), uc->c_is_ip4);
128  return uc;
129 }
130 
131 static void
133  session_dgram_hdr_t * hdr0, u32 thread_index,
134  vlib_buffer_t * b, u8 queue_event, u32 * error0)
135 {
136  int wrote0;
137 
138  clib_spinlock_lock (&uc0->rx_lock);
139 
141  < hdr0->data_length + sizeof (session_dgram_hdr_t))
142  {
143  *error0 = UDP_ERROR_FIFO_FULL;
144  goto unlock_rx_lock;
145  }
146 
147  /* If session is owned by another thread and rx event needed,
148  * enqueue event now while we still have the peeker lock */
149  if (s0->thread_index != thread_index)
150  {
151  wrote0 = session_enqueue_dgram_connection (s0, hdr0, b,
152  TRANSPORT_PROTO_UDP,
153  /* queue event */ 0);
154  if (queue_event && !svm_fifo_has_event (s0->rx_fifo))
156  }
157  else
158  {
159  wrote0 = session_enqueue_dgram_connection (s0, hdr0, b,
160  TRANSPORT_PROTO_UDP,
161  queue_event);
162  }
163  ASSERT (wrote0 > 0);
164 
165 unlock_rx_lock:
166 
168 }
169 
172  u8 is_ip4)
173 {
174  udp_header_t *udp;
175  u32 fib_index;
176  session_t *s;
177 
178  /* udp_local hands us a pointer to the udp data */
179  udp = (udp_header_t *) (vlib_buffer_get_current (b) - sizeof (*udp));
180  fib_index = vnet_buffer (b)->ip.fib_index;
181 
182  hdr->data_offset = 0;
183  hdr->lcl_port = udp->dst_port;
184  hdr->rmt_port = udp->src_port;
185  hdr->is_ip4 = is_ip4;
186 
187  if (is_ip4)
188  {
189  ip4_header_t *ip4;
190 
191  /* TODO: must fix once udp_local does ip options correctly */
192  ip4 = (ip4_header_t *) (((u8 *) udp) - sizeof (*ip4));
193  ip_set (&hdr->lcl_ip, &ip4->dst_address, 1);
194  ip_set (&hdr->rmt_ip, &ip4->src_address, 1);
195  hdr->data_length = clib_net_to_host_u16 (ip4->length);
196  hdr->data_length -= sizeof (ip4_header_t) + sizeof (udp_header_t);
197  s = session_lookup_safe4 (fib_index, &ip4->dst_address,
198  &ip4->src_address, udp->dst_port,
199  udp->src_port, TRANSPORT_PROTO_UDP);
200  }
201  else
202  {
203  ip6_header_t *ip60;
204 
205  ip60 = (ip6_header_t *) (((u8 *) udp) - sizeof (*ip60));
206  ip_set (&hdr->lcl_ip, &ip60->dst_address, 0);
207  ip_set (&hdr->rmt_ip, &ip60->src_address, 0);
208  hdr->data_length = clib_net_to_host_u16 (ip60->payload_length);
209  hdr->data_length -= sizeof (udp_header_t);
210  s = session_lookup_safe6 (fib_index, &ip60->dst_address,
211  &ip60->src_address, udp->dst_port,
212  udp->src_port, TRANSPORT_PROTO_UDP);
213  }
214 
215  if (PREDICT_TRUE (!(b->flags & VLIB_BUFFER_NEXT_PRESENT)))
216  b->current_length = hdr->data_length;
217  else
219  - b->current_length;
220 
221  return s;
222 }
223 
226  vlib_frame_t * frame, u8 is_ip4)
227 {
228  u32 n_left_from, *from, errors, *first_buffer;
229  vlib_buffer_t *bufs[VLIB_FRAME_SIZE], **b;
230  u16 err_counters[UDP_N_ERROR] = { 0 };
231  u32 thread_index = vm->thread_index;
232 
233  from = first_buffer = vlib_frame_vector_args (frame);
234  n_left_from = frame->n_vectors;
235  vlib_get_buffers (vm, from, bufs, n_left_from);
236 
237  b = bufs;
238 
239  while (n_left_from > 0)
240  {
241  u32 error0 = UDP_ERROR_ENQUEUED;
242  session_dgram_hdr_t hdr0;
243  udp_connection_t *uc0;
244  session_t *s0;
245 
246  s0 = udp_parse_and_lookup_buffer (b[0], &hdr0, is_ip4);
247  if (PREDICT_FALSE (!s0))
248  {
249  error0 = UDP_ERROR_NO_LISTENER;
250  goto done;
251  }
252 
253  /*
254  * If session exists pool peeker lock is taken at this point unless
255  * the session is already on the right thread or is a listener
256  */
257 
258  if (s0->session_state == SESSION_STATE_OPENED)
259  {
260  u8 queue_event = 1;
262  if (uc0->flags & UDP_CONN_F_CONNECTED)
263  {
264  if (s0->thread_index != thread_index)
265  {
266  /*
267  * Clone the transport. It will be cleaned up with the
268  * session once we notify the session layer.
269  */
271  s0->thread_index);
272  ASSERT (s0->session_index == uc0->c_s_index);
273 
274  /*
275  * Drop the peeker lock on pool resize and ask session
276  * layer for a new session.
277  */
280  s0->thread_index, &s0);
281  queue_event = 0;
282  }
283  else
284  s0->session_state = SESSION_STATE_READY;
285  }
286  udp_connection_enqueue (uc0, s0, &hdr0, thread_index, b[0],
287  queue_event, &error0);
289  }
290  else if (s0->session_state == SESSION_STATE_READY)
291  {
293  udp_connection_enqueue (uc0, s0, &hdr0, thread_index, b[0], 1,
294  &error0);
295  }
296  else if (s0->session_state == SESSION_STATE_LISTENING)
297  {
299  if (uc0->flags & UDP_CONN_F_CONNECTED)
300  {
301  uc0 = udp_connection_accept (uc0, &hdr0, thread_index);
302  if (!uc0)
303  {
304  error0 = UDP_ERROR_CREATE_SESSION;
305  goto done;
306  }
307  s0 = session_get (uc0->c_s_index, uc0->c_thread_index);
308  error0 = UDP_ERROR_ACCEPT;
309  }
310  udp_connection_enqueue (uc0, s0, &hdr0, thread_index, b[0], 1,
311  &error0);
312  }
313  else
314  {
315  error0 = UDP_ERROR_NOT_READY;
317  }
318 
319  done:
321  udp_trace_buffer (vm, node, b[0], s0, error0);
322 
323  b += 1;
324  n_left_from -= 1;
325 
326  udp_inc_err_counter (err_counters, error0, 1);
327  }
328 
329  vlib_buffer_free (vm, first_buffer, frame->n_vectors);
330  errors = session_main_flush_enqueue_events (TRANSPORT_PROTO_UDP,
331  thread_index);
332  err_counters[UDP_ERROR_MQ_FULL] = errors;
333  udp_store_err_counters (vm, is_ip4, err_counters);
334  return frame->n_vectors;
335 }
336 
337 static uword
340 {
341  return udp46_input_inline (vm, node, frame, 1);
342 }
343 
344 /* *INDENT-OFF* */
346 {
347  .function = udp4_input,
348  .name = "udp4-input",
349  .vector_size = sizeof (u32),
350  .format_trace = format_udp_input_trace,
352  .n_errors = ARRAY_LEN (udp_error_strings),
353  .error_strings = udp_error_strings,
354  .n_next_nodes = UDP_INPUT_N_NEXT,
355  .next_nodes = {
356 #define _(s, n) [UDP_INPUT_NEXT_##s] = n,
358 #undef _
359  },
360 };
361 /* *INDENT-ON* */
362 
363 static uword
366 {
367  return udp46_input_inline (vm, node, frame, 0);
368 }
369 
370 /* *INDENT-OFF* */
372 {
373  .function = udp6_input,
374  .name = "udp6-input",
375  .vector_size = sizeof (u32),
376  .format_trace = format_udp_input_trace,
378  .n_errors = ARRAY_LEN (udp_error_strings),
379  .error_strings = udp_error_strings,
380  .n_next_nodes = UDP_INPUT_N_NEXT,
381  .next_nodes = {
382 #define _(s, n) [UDP_INPUT_NEXT_##s] = n,
384 #undef _
385  },
386 };
387 /* *INDENT-ON* */
388 
389 /*
390  * fd.io coding-style-patch-verification: ON
391  *
392  * Local Variables:
393  * eval: (c-set-style "gnu")
394  * End:
395  */
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
static udp_connection_t * udp_connection_from_transport(transport_connection_t *tc)
Definition: udp.h:206
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:119
static_always_inline void clib_spinlock_lock(clib_spinlock_t *p)
Definition: lock.h:80
#define CLIB_UNUSED(x)
Definition: clib.h:87
void ip_copy(ip46_address_t *dst, ip46_address_t *src, u8 is_ip4)
Definition: ip.c:81
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:524
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:937
ip4_address_t src_address
Definition: ip4_packet.h:125
void udp_connection_share_port(u16 lcl_port, u8 is_ip4)
Definition: udp.c:80
#define PREDICT_TRUE(x)
Definition: clib.h:121
u32 session_index
Index in thread pool where session was allocated.
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:1620
svm_fifo_t * rx_fifo
Pointers to rx/tx buffers.
u32 thread_index
Definition: main.h:249
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:515
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:715
#define udp_store_err_counters(vm, is_ip4, cnts)
Definition: udp_input.c:76
udp_input_next_t
Definition: udp_input.c:59
vlib_main_t * vm
Definition: in2out_ed.c:1582
static void session_pool_remove_peeker(u32 thread_index)
Definition: session.h:359
static session_t * session_get(u32 si, u32 thread_index)
Definition: session.h:301
u8 * format(u8 *s, const char *fmt,...)
Definition: format.c:424
static void udp_trace_buffer(vlib_main_t *vm, vlib_node_runtime_t *node, vlib_buffer_t *b, session_t *s, u16 error0)
Definition: udp_input.c:90
#define udp_inc_err_counter(cnts, err, val)
Definition: udp_input.c:84
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.
u16 mss
connection mss
Definition: udp.h:67
ip6_address_t src_address
Definition: ip6_packet.h:310
unsigned char u8
Definition: types.h:56
u8 flags
connection flags
Definition: udp.h:66
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:371
void udp_connection_free(udp_connection_t *uc)
Definition: udp.c:123
ip4_address_t dst_address
Definition: ip4_packet.h:125
static uword udp4_input(vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *frame)
Definition: udp_input.c:338
ip46_address_t lcl_ip
unsigned int u32
Definition: types.h:88
#define VLIB_FRAME_SIZE
Definition: node.h:377
vl_api_fib_path_type_t type
Definition: fib_types.api:123
udp_connection_t * udp_connection_alloc(u32 thread_index)
Definition: udp.c:92
unsigned short u16
Definition: types.h:57
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:225
#define PREDICT_FALSE(x)
Definition: clib.h:120
#define always_inline
Definition: ipsec.h:28
vl_api_ip4_address_t ip4
Definition: one.api:376
static udp_connection_t * udp_connection_accept(udp_connection_t *listener, session_dgram_hdr_t *hdr, u32 thread_index)
Definition: udp_input.c:105
static void vlib_node_increment_counter(vlib_main_t *vm, u32 node_index, u32 counter_index, u64 increment)
Definition: node_funcs.h:1231
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:396
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:906
#define ARRAY_LEN(x)
Definition: clib.h:67
vlib_main_t vlib_node_runtime_t * node
Definition: in2out_ed.c:1582
#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 session_t * udp_parse_and_lookup_buffer(vlib_buffer_t *b, session_dgram_hdr_t *hdr, u8 is_ip4)
Definition: udp_input.c:171
#define foreach_udp_input_next
Definition: udp_input.c:56
u16 payload_length
Definition: ip6_packet.h:301
vlib_node_registration_t udp4_input_node
(constructor) VLIB_REGISTER_NODE (udp4_input_node)
Definition: udp_input.c:345
transport_connection_t connection
must be first
Definition: udp.h:64
clib_spinlock_t rx_lock
rx fifo lock
Definition: udp.h:65
volatile u8 session_state
State in session layer state machine.
vlib_main_t vlib_node_runtime_t vlib_frame_t * frame
Definition: in2out_ed.c:1583
int session_enqueue_notify(session_t *s)
Definition: session.c:647
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:297
#define vnet_buffer(b)
Definition: buffer.h:417
static int svm_fifo_has_event(svm_fifo_t *f)
Check if fifo has io event.
Definition: svm_fifo.h:687
static uword udp6_input(vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *frame)
Definition: udp_input.c:364
u16 flags
Copy of main node flags.
Definition: node.h:500
void * vlib_add_trace(vlib_main_t *vm, vlib_node_runtime_t *r, vlib_buffer_t *b, u32 n_data_bytes)
Definition: trace.c:577
static udp_connection_t * udp_connection_clone_safe(u32 connection_index, u32 thread_index)
Definition: udp.h:252
int session_dgram_accept(transport_connection_t *tc, u32 listener_index, u32 thread_index)
Definition: session.c:1145
static_always_inline void vlib_get_buffers(vlib_main_t *vm, u32 *bi, vlib_buffer_t **b, int count)
Translate array of buffer indices into buffer pointers.
Definition: buffer_funcs.h:280
#define VLIB_NODE_FLAG_TRACE
Definition: node.h:301
u32 total_length_not_including_first_buffer
Only valid for first buffer in chain.
Definition: buffer.h:167
static void udp_connection_enqueue(udp_connection_t *uc0, session_t *s0, session_dgram_hdr_t *hdr0, u32 thread_index, vlib_buffer_t *b, u8 queue_event, u32 *error0)
Definition: udp_input.c:132
ip6_address_t dst_address
Definition: ip6_packet.h:310