tcp/session: add tx pacer
[vpp.git] / src / vnet / session / session.h
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 #ifndef __included_session_h__
16 #define __included_session_h__
17
18 #include <vnet/session/stream_session.h>
19 #include <vnet/session/session_lookup.h>
20 #include <vnet/session/transport_interface.h>
21 #include <vnet/session/session_debug.h>
22 #include <vnet/session/segment_manager.h>
23 #include <svm/queue.h>
24
25 #define HALF_OPEN_LOOKUP_INVALID_VALUE ((u64)~0)
26 #define INVALID_INDEX ((u32)~0)
27 #define SESSION_PROXY_LISTENER_INDEX ((u8)~0 - 1)
28 #define SESSION_LOCAL_HANDLE_PREFIX 0x7FFFFFFF
29
30 /* TODO decide how much since we have pre-data as well */
31 #define MAX_HDRS_LEN    100     /* Max number of bytes for headers */
32
33 typedef enum
34 {
35   FIFO_EVENT_APP_RX,
36   SESSION_IO_EVT_CT_RX,
37   FIFO_EVENT_APP_TX,
38   SESSION_IO_EVT_CT_TX,
39   FIFO_EVENT_DISCONNECT,
40   FIFO_EVENT_BUILTIN_RX,
41   FIFO_EVENT_BUILTIN_TX,
42   FIFO_EVENT_RPC,
43   SESSION_CTRL_EVT_BOUND,
44   SESSION_CTRL_EVT_ACCEPTED,
45   SESSION_CTRL_EVT_ACCEPTED_REPLY,
46   SESSION_CTRL_EVT_CONNECTED,
47   SESSION_CTRL_EVT_CONNECTED_REPLY,
48   SESSION_CTRL_EVT_DISCONNECTED,
49   SESSION_CTRL_EVT_DISCONNECTED_REPLY,
50   SESSION_CTRL_EVT_RESET,
51   SESSION_CTRL_EVT_RESET_REPLY
52 } session_evt_type_t;
53
54 static inline const char *
55 fifo_event_type_str (session_evt_type_t et)
56 {
57   switch (et)
58     {
59     case FIFO_EVENT_APP_RX:
60       return "FIFO_EVENT_APP_RX";
61     case FIFO_EVENT_APP_TX:
62       return "FIFO_EVENT_APP_TX";
63     case FIFO_EVENT_DISCONNECT:
64       return "FIFO_EVENT_DISCONNECT";
65     case FIFO_EVENT_BUILTIN_RX:
66       return "FIFO_EVENT_BUILTIN_RX";
67     case FIFO_EVENT_RPC:
68       return "FIFO_EVENT_RPC";
69     default:
70       return "UNKNOWN FIFO EVENT";
71     }
72 }
73
74 typedef enum
75 {
76   SESSION_MQ_IO_EVT_RING,
77   SESSION_MQ_CTRL_EVT_RING,
78   SESSION_MQ_N_RINGS
79 } session_mq_rings_e;
80
81 #define foreach_session_input_error                                     \
82 _(NO_SESSION, "No session drops")                                       \
83 _(NO_LISTENER, "No listener for dst port drops")                        \
84 _(ENQUEUED, "Packets pushed into rx fifo")                              \
85 _(NOT_READY, "Session not ready packets")                               \
86 _(FIFO_FULL, "Packets dropped for lack of rx fifo space")               \
87 _(EVENT_FIFO_FULL, "Events not sent for lack of event fifo space")      \
88 _(API_QUEUE_FULL, "Sessions not created for lack of API queue space")   \
89 _(NEW_SEG_NO_SPACE, "Created segment, couldn't allocate a fifo pair")   \
90 _(NO_SPACE, "Couldn't allocate a fifo pair")                            \
91 _(SEG_CREATE, "Couldn't create a new segment")
92
93 typedef enum
94 {
95 #define _(sym,str) SESSION_ERROR_##sym,
96   foreach_session_input_error
97 #undef _
98     SESSION_N_ERROR,
99 } session_error_t;
100
101 typedef struct
102 {
103   void *fp;
104   void *arg;
105 } session_rpc_args_t;
106
107 typedef u64 session_handle_t;
108
109 /* *INDENT-OFF* */
110 typedef struct
111 {
112   u8 event_type;
113   u8 postponed;
114   union
115   {
116     svm_fifo_t *fifo;
117     session_handle_t session_handle;
118     session_rpc_args_t rpc_args;
119     struct
120     {
121       u8 data[0];
122     };
123   };
124 } __clib_packed session_event_t;
125 /* *INDENT-ON* */
126
127 #define SESSION_MSG_NULL { }
128
129 typedef struct session_dgram_pre_hdr_
130 {
131   u32 data_length;
132   u32 data_offset;
133 } session_dgram_pre_hdr_t;
134
135 /* *INDENT-OFF* */
136 typedef CLIB_PACKED (struct session_dgram_header_
137 {
138   u32 data_length;
139   u32 data_offset;
140   ip46_address_t rmt_ip;
141   ip46_address_t lcl_ip;
142   u16 rmt_port;
143   u16 lcl_port;
144   u8 is_ip4;
145 }) session_dgram_hdr_t;
146 /* *INDENT-ON* */
147
148 #define SESSION_CONN_ID_LEN 37
149 #define SESSION_CONN_HDR_LEN 45
150
151 STATIC_ASSERT (sizeof (session_dgram_hdr_t) == (SESSION_CONN_ID_LEN + 8),
152                "session conn id wrong length");
153
154 typedef struct session_tx_context_
155 {
156   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
157   stream_session_t *s;
158   transport_proto_vft_t *transport_vft;
159   transport_connection_t *tc;
160   vlib_buffer_t *b;
161   u32 max_dequeue;
162   u32 snd_space;
163   u32 left_to_snd;
164   u32 tx_offset;
165   u32 max_len_to_snd;
166   u16 deq_per_first_buf;
167   u16 deq_per_buf;
168   u16 snd_mss;
169   u16 n_segs_per_evt;
170   u8 n_bufs_per_seg;
171     CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
172   session_dgram_hdr_t hdr;
173 } session_tx_context_t;
174
175 /* Forward definition */
176 typedef struct _session_manager_main session_manager_main_t;
177
178 typedef int
179   (session_fifo_rx_fn) (vlib_main_t * vm, vlib_node_runtime_t * node,
180                         session_event_t * e0, stream_session_t * s0,
181                         int *n_tx_pkts);
182
183 extern session_fifo_rx_fn session_tx_fifo_peek_and_snd;
184 extern session_fifo_rx_fn session_tx_fifo_dequeue_and_snd;
185 extern session_fifo_rx_fn session_tx_fifo_dequeue_internal;
186
187 u8 session_node_lookup_fifo_event (svm_fifo_t * f, session_event_t * e);
188
189 struct _session_manager_main
190 {
191   /** Per worker thread session pools */
192   stream_session_t **sessions;
193
194   /** Per worker-thread session pool peekers rw locks */
195   clib_rwlock_t *peekers_rw_locks;
196
197   /** Per-proto, per-worker enqueue epoch counters */
198   u64 *current_enqueue_epoch[TRANSPORT_N_PROTO];
199
200   /** Per-proto, per-worker thread vector of sessions to enqueue */
201   u32 **session_to_enqueue[TRANSPORT_N_PROTO];
202
203   /** per-worker tx buffer free lists */
204   u32 **tx_buffers;
205
206   /** Per worker-thread vector of partially read events */
207   session_event_t **free_event_vector;
208
209   /** per-worker active event vectors */
210   session_event_t **pending_event_vector;
211
212   /** per-worker postponed disconnects */
213   session_event_t **pending_disconnects;
214
215   /** per-worker session context */
216   session_tx_context_t *ctx;
217
218   /** Our approximation of a "complete" dispatch loop period */
219   f64 *dispatch_period;
220
221   /** vlib_time_now last time around the track */
222   f64 *last_vlib_time;
223
224   /** vpp fifo event queue */
225   svm_msg_q_t **vpp_event_queues;
226
227   /** Event queues memfd segment initialized only if so configured */
228   ssvm_private_t evt_qs_segment;
229
230   /** Unique segment name counter */
231   u32 unique_segment_name_counter;
232
233   /** Per transport rx function that can either dequeue or peek */
234   session_fifo_rx_fn **session_tx_fns;
235
236   /** Per session type output nodes. Could optimize to group nodes by
237    * fib but lookup would then require session type parsing in session node.
238    * Trade memory for speed, for now */
239   u32 *session_type_to_next;
240
241   /** Session manager is enabled */
242   u8 is_enabled;
243
244   /** vpp fifo event queue configured length */
245   u32 configured_event_queue_length;
246
247   /*
248    * Config parameters
249    */
250
251   /** Session ssvm segment configs*/
252   uword session_baseva;
253   uword session_va_space_size;
254   u32 evt_qs_segment_size;
255   u8 evt_qs_use_memfd_seg;
256
257   /** Session table size parameters */
258   u32 configured_v4_session_table_buckets;
259   u32 configured_v4_session_table_memory;
260   u32 configured_v4_halfopen_table_buckets;
261   u32 configured_v4_halfopen_table_memory;
262   u32 configured_v6_session_table_buckets;
263   u32 configured_v6_session_table_memory;
264   u32 configured_v6_halfopen_table_buckets;
265   u32 configured_v6_halfopen_table_memory;
266
267   /** Transport table (preallocation) size parameters */
268   u32 local_endpoints_table_memory;
269   u32 local_endpoints_table_buckets;
270
271   /** Preallocate session config parameter */
272   u32 preallocated_sessions;
273
274 #if SESSION_DEBUG
275   /**
276    * last event poll time by thread
277    * Debug only. Will cause false cache-line sharing as-is
278    */
279   f64 *last_event_poll_by_thread;
280 #endif
281
282 };
283
284 extern session_manager_main_t session_manager_main;
285 extern vlib_node_registration_t session_queue_node;
286 extern vlib_node_registration_t session_queue_process_node;
287
288 #define SESSION_Q_PROCESS_FLUSH_FRAMES  1
289 #define SESSION_Q_PROCESS_STOP          2
290
291 /*
292  * Session manager function
293  */
294 always_inline session_manager_main_t *
295 vnet_get_session_manager_main ()
296 {
297   return &session_manager_main;
298 }
299
300 always_inline u8
301 stream_session_is_valid (u32 si, u8 thread_index)
302 {
303   stream_session_t *s;
304   s = pool_elt_at_index (session_manager_main.sessions[thread_index], si);
305   if (s->thread_index != thread_index || s->session_index != si
306       /* || s->server_rx_fifo->master_session_index != si
307          || s->server_tx_fifo->master_session_index != si
308          || s->server_rx_fifo->master_thread_index != thread_index
309          || s->server_tx_fifo->master_thread_index != thread_index */ )
310     return 0;
311   return 1;
312 }
313
314 stream_session_t *session_alloc (u32 thread_index);
315 int session_alloc_fifos (segment_manager_t * sm, stream_session_t * s);
316 void session_free (stream_session_t * s);
317 void session_free_w_fifos (stream_session_t * s);
318
319 always_inline stream_session_t *
320 session_get (u32 si, u32 thread_index)
321 {
322   ASSERT (stream_session_is_valid (si, thread_index));
323   return pool_elt_at_index (session_manager_main.sessions[thread_index], si);
324 }
325
326 always_inline stream_session_t *
327 session_get_if_valid (u64 si, u32 thread_index)
328 {
329   if (thread_index >= vec_len (session_manager_main.sessions))
330     return 0;
331
332   if (pool_is_free_index (session_manager_main.sessions[thread_index], si))
333     return 0;
334
335   ASSERT (stream_session_is_valid (si, thread_index));
336   return pool_elt_at_index (session_manager_main.sessions[thread_index], si);
337 }
338
339 always_inline session_handle_t
340 session_handle (stream_session_t * s)
341 {
342   return ((u64) s->thread_index << 32) | (u64) s->session_index;
343 }
344
345 always_inline u32
346 session_index_from_handle (session_handle_t handle)
347 {
348   return handle & 0xFFFFFFFF;
349 }
350
351 always_inline u32
352 session_thread_from_handle (session_handle_t handle)
353 {
354   return handle >> 32;
355 }
356
357 always_inline void
358 session_parse_handle (session_handle_t handle, u32 * index,
359                       u32 * thread_index)
360 {
361   *index = session_index_from_handle (handle);
362   *thread_index = session_thread_from_handle (handle);
363 }
364
365 always_inline stream_session_t *
366 session_get_from_handle (session_handle_t handle)
367 {
368   session_manager_main_t *smm = &session_manager_main;
369   u32 session_index, thread_index;
370   session_parse_handle (handle, &session_index, &thread_index);
371   return pool_elt_at_index (smm->sessions[thread_index], session_index);
372 }
373
374 always_inline stream_session_t *
375 session_get_from_handle_if_valid (session_handle_t handle)
376 {
377   u32 session_index, thread_index;
378   session_parse_handle (handle, &session_index, &thread_index);
379   return session_get_if_valid (session_index, thread_index);
380 }
381
382 always_inline u8
383 session_handle_is_local (session_handle_t handle)
384 {
385   if ((handle >> 32) == SESSION_LOCAL_HANDLE_PREFIX)
386     return 1;
387   return 0;
388 }
389
390 always_inline transport_proto_t
391 session_type_transport_proto (session_type_t st)
392 {
393   return (st >> 1);
394 }
395
396 always_inline u8
397 session_type_is_ip4 (session_type_t st)
398 {
399   return (st & 1);
400 }
401
402 always_inline transport_proto_t
403 session_get_transport_proto (stream_session_t * s)
404 {
405   return (s->session_type >> 1);
406 }
407
408 always_inline fib_protocol_t
409 session_get_fib_proto (stream_session_t * s)
410 {
411   u8 is_ip4 = s->session_type & 1;
412   return (is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6);
413 }
414
415 always_inline session_type_t
416 session_type_from_proto_and_ip (transport_proto_t proto, u8 is_ip4)
417 {
418   return (proto << 1 | is_ip4);
419 }
420
421 always_inline u8
422 session_has_transport (stream_session_t * s)
423 {
424   return (session_get_transport_proto (s) != TRANSPORT_PROTO_NONE);
425 }
426
427 transport_service_type_t session_transport_service_type (stream_session_t *);
428 transport_tx_fn_type_t session_transport_tx_fn_type (stream_session_t *);
429 u8 session_tx_is_dgram (stream_session_t * s);
430
431 /**
432  * Acquires a lock that blocks a session pool from expanding.
433  *
434  * This is typically used for safely peeking into other threads'
435  * pools in order to clone elements. Lock should be dropped as soon
436  * as possible by calling @ref session_pool_remove_peeker.
437  *
438  * NOTE: Avoid using pool_elt_at_index while the lock is held because
439  * it may lead to free elt bitmap expansion/contraction!
440  */
441 always_inline void
442 session_pool_add_peeker (u32 thread_index)
443 {
444   session_manager_main_t *smm = &session_manager_main;
445   if (thread_index == vlib_get_thread_index ())
446     return;
447   clib_rwlock_reader_lock (&smm->peekers_rw_locks[thread_index]);
448 }
449
450 always_inline void
451 session_pool_remove_peeker (u32 thread_index)
452 {
453   session_manager_main_t *smm = &session_manager_main;
454   if (thread_index == vlib_get_thread_index ())
455     return;
456   clib_rwlock_reader_unlock (&smm->peekers_rw_locks[thread_index]);
457 }
458
459 /**
460  * Get session from handle and 'lock' pool resize if not in same thread
461  *
462  * Caller should drop the peek 'lock' as soon as possible.
463  */
464 always_inline stream_session_t *
465 session_get_from_handle_safe (u64 handle)
466 {
467   session_manager_main_t *smm = &session_manager_main;
468   u32 thread_index = session_thread_from_handle (handle);
469   if (thread_index == vlib_get_thread_index ())
470     {
471       return pool_elt_at_index (smm->sessions[thread_index],
472                                 session_index_from_handle (handle));
473     }
474   else
475     {
476       session_pool_add_peeker (thread_index);
477       /* Don't use pool_elt_at index. See @ref session_pool_add_peeker */
478       return smm->sessions[thread_index] + session_index_from_handle (handle);
479     }
480 }
481
482 always_inline u32
483 transport_max_rx_enqueue (transport_connection_t * tc)
484 {
485   stream_session_t *s = session_get (tc->s_index, tc->thread_index);
486   return svm_fifo_max_enqueue (s->server_rx_fifo);
487 }
488
489 always_inline u32
490 transport_rx_fifo_size (transport_connection_t * tc)
491 {
492   stream_session_t *s = session_get (tc->s_index, tc->thread_index);
493   return s->server_rx_fifo->nitems;
494 }
495
496 always_inline u32
497 transport_tx_fifo_size (transport_connection_t * tc)
498 {
499   stream_session_t *s = session_get (tc->s_index, tc->thread_index);
500   return s->server_tx_fifo->nitems;
501 }
502
503 always_inline f64
504 transport_dispatch_period (u32 thread_index)
505 {
506   return session_manager_main.dispatch_period[thread_index];
507 }
508
509 always_inline f64
510 transport_time_now (u32 thread_index)
511 {
512   return session_manager_main.last_vlib_time[thread_index];
513 }
514
515 always_inline u32
516 session_get_index (stream_session_t * s)
517 {
518   return (s - session_manager_main.sessions[s->thread_index]);
519 }
520
521 always_inline stream_session_t *
522 session_clone_safe (u32 session_index, u32 thread_index)
523 {
524   stream_session_t *old_s, *new_s;
525   u32 current_thread_index = vlib_get_thread_index ();
526
527   /* If during the memcpy pool is reallocated AND the memory allocator
528    * decides to give the old chunk of memory to somebody in a hurry to
529    * scribble something on it, we have a problem. So add this thread as
530    * a session pool peeker.
531    */
532   session_pool_add_peeker (thread_index);
533   new_s = session_alloc (current_thread_index);
534   old_s = session_manager_main.sessions[thread_index] + session_index;
535   clib_memcpy (new_s, old_s, sizeof (*new_s));
536   session_pool_remove_peeker (thread_index);
537   new_s->thread_index = current_thread_index;
538   new_s->session_index = session_get_index (new_s);
539   return new_s;
540 }
541
542 transport_connection_t *session_get_transport (stream_session_t * s);
543
544 u32 session_tx_fifo_max_dequeue (transport_connection_t * tc);
545
546 int
547 session_enqueue_stream_connection (transport_connection_t * tc,
548                                    vlib_buffer_t * b, u32 offset,
549                                    u8 queue_event, u8 is_in_order);
550 int session_enqueue_dgram_connection (stream_session_t * s,
551                                       session_dgram_hdr_t * hdr,
552                                       vlib_buffer_t * b, u8 proto,
553                                       u8 queue_event);
554 int stream_session_peek_bytes (transport_connection_t * tc, u8 * buffer,
555                                u32 offset, u32 max_bytes);
556 u32 stream_session_dequeue_drop (transport_connection_t * tc, u32 max_bytes);
557
558 int session_stream_connect_notify (transport_connection_t * tc, u8 is_fail);
559 int session_dgram_connect_notify (transport_connection_t * tc,
560                                   u32 old_thread_index,
561                                   stream_session_t ** new_session);
562 int session_dequeue_notify (stream_session_t * s);
563 void stream_session_init_fifos_pointers (transport_connection_t * tc,
564                                          u32 rx_pointer, u32 tx_pointer);
565
566 void stream_session_accept_notify (transport_connection_t * tc);
567 void stream_session_disconnect_notify (transport_connection_t * tc);
568 void stream_session_delete_notify (transport_connection_t * tc);
569 void stream_session_reset_notify (transport_connection_t * tc);
570 int stream_session_accept (transport_connection_t * tc, u32 listener_index,
571                            u8 notify);
572 int session_open (u32 app_index, session_endpoint_t * tep, u32 opaque);
573 int session_listen (stream_session_t * s, session_endpoint_extended_t * sep);
574 int session_stop_listen (stream_session_t * s);
575 void stream_session_disconnect (stream_session_t * s);
576 void stream_session_disconnect_transport (stream_session_t * s);
577 void stream_session_cleanup (stream_session_t * s);
578 int session_send_io_evt_to_thread (svm_fifo_t * f,
579                                    session_evt_type_t evt_type);
580 int session_send_io_evt_to_thread_custom (void *data, u32 thread_index,
581                                           session_evt_type_t evt_type);
582 void session_send_rpc_evt_to_thread (u32 thread_index, void *fp,
583                                      void *rpc_args);
584
585 ssvm_private_t *session_manager_get_evt_q_segment (void);
586
587 u8 *format_stream_session (u8 * s, va_list * args);
588 uword unformat_stream_session (unformat_input_t * input, va_list * args);
589 uword unformat_transport_connection (unformat_input_t * input,
590                                      va_list * args);
591
592 void session_register_transport (transport_proto_t transport_proto,
593                                  const transport_proto_vft_t * vft, u8 is_ip4,
594                                  u32 output_node);
595
596 always_inline void
597 transport_add_tx_event (transport_connection_t * tc)
598 {
599   stream_session_t *s = session_get (tc->s_index, tc->thread_index);
600   if (svm_fifo_has_event (s->server_tx_fifo))
601     return;
602   session_send_io_evt_to_thread (s->server_tx_fifo, FIFO_EVENT_APP_TX);
603 }
604
605 clib_error_t *vnet_session_enable_disable (vlib_main_t * vm, u8 is_en);
606
607 always_inline svm_msg_q_t *
608 session_manager_get_vpp_event_queue (u32 thread_index)
609 {
610   return session_manager_main.vpp_event_queues[thread_index];
611 }
612
613 int session_manager_flush_enqueue_events (u8 proto, u32 thread_index);
614 int session_manager_flush_all_enqueue_events (u8 transport_proto);
615
616 always_inline u64
617 listen_session_get_handle (stream_session_t * s)
618 {
619   ASSERT (s->session_state == SESSION_STATE_LISTENING);
620   return session_handle (s);
621 }
622
623 always_inline stream_session_t *
624 listen_session_get_from_handle (session_handle_t handle)
625 {
626   return session_get_from_handle (handle);
627 }
628
629 always_inline void
630 listen_session_parse_handle (session_handle_t handle, u32 * index,
631                              u32 * thread_index)
632 {
633   session_parse_handle (handle, index, thread_index);
634 }
635
636 always_inline stream_session_t *
637 listen_session_new (u8 thread_index, session_type_t type)
638 {
639   stream_session_t *s;
640   s = session_alloc (thread_index);
641   s->session_type = type;
642   s->session_state = SESSION_STATE_LISTENING;
643   return s;
644 }
645
646 always_inline stream_session_t *
647 listen_session_get (u32 index)
648 {
649   return session_get (index, 0);
650 }
651
652 always_inline void
653 listen_session_del (stream_session_t * s)
654 {
655   session_free (s);
656 }
657
658 transport_connection_t *listen_session_get_transport (stream_session_t * s);
659
660 int
661 listen_session_get_local_session_endpoint (stream_session_t * listener,
662                                            session_endpoint_t * sep);
663
664 void session_flush_frames_main_thread (vlib_main_t * vm);
665
666 always_inline u8
667 session_manager_is_enabled ()
668 {
669   return session_manager_main.is_enabled == 1;
670 }
671
672 #define session_cli_return_if_not_enabled()                             \
673 do {                                                                    \
674     if (!session_manager_main.is_enabled)                               \
675       return clib_error_return(0, "session layer is not enabled");      \
676 } while (0)
677
678 void session_node_enable_disable (u8 is_en);
679
680 #endif /* __included_session_h__ */
681
682 /*
683  * fd.io coding-style-patch-verification: ON
684  *
685  * Local Variables:
686  * eval: (c-set-style "gnu")
687  * End:
688  */