session tcp: refactor pacer time
[vpp.git] / src / vnet / session / session.h
1 /*
2  * Copyright (c) 2017-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 #ifndef __included_session_h__
16 #define __included_session_h__
17
18 #include <vppinfra/llist.h>
19 #include <vnet/session/session_types.h>
20 #include <vnet/session/session_lookup.h>
21 #include <vnet/session/session_debug.h>
22 #include <svm/message_queue.h>
23 #include <svm/ssvm.h>
24
25 #define foreach_session_input_error                                     \
26 _(NO_SESSION, "No session drops")                                       \
27 _(NO_LISTENER, "No listener for dst port drops")                        \
28 _(ENQUEUED, "Packets pushed into rx fifo")                              \
29 _(NOT_READY, "Session not ready packets")                               \
30 _(FIFO_FULL, "Packets dropped for lack of rx fifo space")               \
31 _(EVENT_FIFO_FULL, "Events not sent for lack of event fifo space")      \
32 _(API_QUEUE_FULL, "Sessions not created for lack of API queue space")   \
33 _(NEW_SEG_NO_SPACE, "Created segment, couldn't allocate a fifo pair")   \
34 _(NO_SPACE, "Couldn't allocate a fifo pair")                            \
35 _(SEG_CREATE, "Couldn't create a new segment")
36
37 typedef enum
38 {
39 #define _(sym,str) SESSION_ERROR_##sym,
40   foreach_session_input_error
41 #undef _
42     SESSION_N_ERROR,
43 } session_error_t;
44
45 typedef struct session_tx_context_
46 {
47   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
48   session_t *s;
49   transport_proto_vft_t *transport_vft;
50   transport_connection_t *tc;
51   u32 max_dequeue;
52   u32 snd_space;
53   u32 left_to_snd;
54   u32 tx_offset;
55   u32 max_len_to_snd;
56   u16 deq_per_first_buf;
57   u16 deq_per_buf;
58   u16 snd_mss;
59   u16 n_segs_per_evt;
60   u8 n_bufs_per_seg;
61     CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
62   session_dgram_hdr_t hdr;
63 } session_tx_context_t;
64
65 typedef struct session_evt_elt
66 {
67   clib_llist_anchor_t evt_list;
68   session_event_t evt;
69 } session_evt_elt_t;
70
71 typedef struct session_ctrl_evt_data_
72 {
73   u8 data[SESSION_CTRL_MSG_MAX_SIZE];
74 } session_evt_ctrl_data_t;
75
76 typedef struct session_worker_
77 {
78   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
79
80   /** Worker session pool */
81   session_t *sessions;
82
83   /** vpp event message queue for worker */
84   svm_msg_q_t *vpp_event_queue;
85
86   /** vlib_time_now last time around the track */
87   clib_time_type_t last_vlib_time;
88
89   /** vlib_time_now rounded to us precision and as u64 */
90   clib_us_time_t last_vlib_us_time;
91
92   /** Convenience pointer to this worker's vlib_main */
93   vlib_main_t *vm;
94
95   /** Per-proto vector of sessions to enqueue */
96   u32 *session_to_enqueue[TRANSPORT_N_PROTO];
97
98   /** Context for session tx */
99   session_tx_context_t ctx;
100
101   /** Vector of tx buffer free lists */
102   u32 *tx_buffers;
103
104   /** Pool of session event list elements */
105   session_evt_elt_t *event_elts;
106
107   /** Pool of ctrl events data buffers */
108   session_evt_ctrl_data_t *ctrl_evts_data;
109
110   /** Head of control events list */
111   clib_llist_index_t ctrl_head;
112
113   /** Head of list of elements */
114   clib_llist_index_t new_head;
115
116   /** Head of list of pending events */
117   clib_llist_index_t old_head;
118
119   /** Peekers rw lock */
120   clib_rwlock_t peekers_rw_locks;
121
122   /** Vector of buffers to be sent */
123   u32 *pending_tx_buffers;
124
125   /** Vector of nexts for the pending tx buffers */
126   u16 *pending_tx_nexts;
127
128 #if SESSION_DEBUG
129   /** last event poll time by thread */
130   clib_time_type_t last_event_poll;
131 #endif
132 } session_worker_t;
133
134 typedef int (session_fifo_rx_fn) (session_worker_t * wrk,
135                                   vlib_node_runtime_t * node,
136                                   session_evt_elt_t * e, int *n_tx_packets);
137
138 extern session_fifo_rx_fn session_tx_fifo_peek_and_snd;
139 extern session_fifo_rx_fn session_tx_fifo_dequeue_and_snd;
140 extern session_fifo_rx_fn session_tx_fifo_dequeue_internal;
141
142 u8 session_node_lookup_fifo_event (svm_fifo_t * f, session_event_t * e);
143
144 typedef struct session_main_
145 {
146   /** Worker contexts */
147   session_worker_t *wrk;
148
149   /** Event queues memfd segment initialized only if so configured */
150   ssvm_private_t evt_qs_segment;
151
152   /** Unique segment name counter */
153   u32 unique_segment_name_counter;
154
155   /** Per transport rx function that can either dequeue or peek */
156   session_fifo_rx_fn **session_tx_fns;
157
158   /** Per session type output nodes. Could optimize to group nodes by
159    * fib but lookup would then require session type parsing in session node.
160    * Trade memory for speed, for now */
161   u32 *session_type_to_next;
162
163   /*
164    * Config parameters
165    */
166
167   /** Session manager is enabled */
168   u8 is_enabled;
169
170   /** vpp fifo event queue configured length */
171   u32 configured_event_queue_length;
172
173   /** Session ssvm segment configs*/
174   uword session_baseva;
175   uword session_va_space_size;
176   uword evt_qs_segment_size;
177   u8 evt_qs_use_memfd_seg;
178
179   /** Session table size parameters */
180   u32 configured_v4_session_table_buckets;
181   u32 configured_v4_session_table_memory;
182   u32 configured_v4_halfopen_table_buckets;
183   u32 configured_v4_halfopen_table_memory;
184   u32 configured_v6_session_table_buckets;
185   u32 configured_v6_session_table_memory;
186   u32 configured_v6_halfopen_table_buckets;
187   u32 configured_v6_halfopen_table_memory;
188
189   /** Transport table (preallocation) size parameters */
190   u32 local_endpoints_table_memory;
191   u32 local_endpoints_table_buckets;
192
193   /** Preallocate session config parameter */
194   u32 preallocated_sessions;
195
196 } session_main_t;
197
198 extern session_main_t session_main;
199 extern vlib_node_registration_t session_queue_node;
200 extern vlib_node_registration_t session_queue_process_node;
201 extern vlib_node_registration_t session_queue_pre_input_node;
202
203 #define SESSION_Q_PROCESS_FLUSH_FRAMES  1
204 #define SESSION_Q_PROCESS_STOP          2
205
206 static inline session_evt_elt_t *
207 session_evt_elt_alloc (session_worker_t * wrk)
208 {
209   session_evt_elt_t *elt;
210   pool_get (wrk->event_elts, elt);
211   return elt;
212 }
213
214 static inline void
215 session_evt_elt_free (session_worker_t * wrk, session_evt_elt_t * elt)
216 {
217   pool_put (wrk->event_elts, elt);
218 }
219
220 static inline void
221 session_evt_add_old (session_worker_t * wrk, session_evt_elt_t * elt)
222 {
223   clib_llist_add_tail (wrk->event_elts, evt_list, elt,
224                        pool_elt_at_index (wrk->event_elts, wrk->old_head));
225 }
226
227 static inline void
228 session_evt_add_head_old (session_worker_t * wrk, session_evt_elt_t * elt)
229 {
230   clib_llist_add (wrk->event_elts, evt_list, elt,
231                   pool_elt_at_index (wrk->event_elts, wrk->old_head));
232 }
233
234
235 static inline u32
236 session_evt_ctrl_data_alloc (session_worker_t * wrk)
237 {
238   session_evt_ctrl_data_t *data;
239   pool_get (wrk->ctrl_evts_data, data);
240   return (data - wrk->ctrl_evts_data);
241 }
242
243 static inline session_evt_elt_t *
244 session_evt_alloc_ctrl (session_worker_t * wrk)
245 {
246   session_evt_elt_t *elt;
247   elt = session_evt_elt_alloc (wrk);
248   clib_llist_add_tail (wrk->event_elts, evt_list, elt,
249                        pool_elt_at_index (wrk->event_elts, wrk->ctrl_head));
250   return elt;
251 }
252
253 static inline void *
254 session_evt_ctrl_data (session_worker_t * wrk, session_evt_elt_t * elt)
255 {
256   return (void *) (pool_elt_at_index (wrk->ctrl_evts_data,
257                                       elt->evt.ctrl_data_index));
258 }
259
260 static inline void
261 session_evt_ctrl_data_free (session_worker_t * wrk, session_evt_elt_t * elt)
262 {
263   ASSERT (elt->evt.event_type > SESSION_IO_EVT_BUILTIN_TX);
264   pool_put_index (wrk->ctrl_evts_data, elt->evt.ctrl_data_index);
265 }
266
267 static inline session_evt_elt_t *
268 session_evt_alloc_new (session_worker_t * wrk)
269 {
270   session_evt_elt_t *elt;
271   elt = session_evt_elt_alloc (wrk);
272   clib_llist_add_tail (wrk->event_elts, evt_list, elt,
273                        pool_elt_at_index (wrk->event_elts, wrk->new_head));
274   return elt;
275 }
276
277 static inline session_evt_elt_t *
278 session_evt_alloc_old (session_worker_t * wrk)
279 {
280   session_evt_elt_t *elt;
281   elt = session_evt_elt_alloc (wrk);
282   clib_llist_add_tail (wrk->event_elts, evt_list, elt,
283                        pool_elt_at_index (wrk->event_elts, wrk->old_head));
284   return elt;
285 }
286
287 always_inline u8
288 session_is_valid (u32 si, u8 thread_index)
289 {
290   session_t *s;
291   s = pool_elt_at_index (session_main.wrk[thread_index].sessions, si);
292   if (s->session_state == SESSION_STATE_CLOSED)
293     return 1;
294
295   if (s->thread_index != thread_index || s->session_index != si)
296     return 0;
297   return 1;
298 }
299
300 session_t *session_alloc (u32 thread_index);
301 void session_free (session_t * s);
302 void session_free_w_fifos (session_t * s);
303
304 always_inline session_t *
305 session_get (u32 si, u32 thread_index)
306 {
307   ASSERT (session_is_valid (si, thread_index));
308   return pool_elt_at_index (session_main.wrk[thread_index].sessions, si);
309 }
310
311 always_inline session_t *
312 session_get_if_valid (u64 si, u32 thread_index)
313 {
314   if (thread_index >= vec_len (session_main.wrk))
315     return 0;
316
317   if (pool_is_free_index (session_main.wrk[thread_index].sessions, si))
318     return 0;
319
320   ASSERT (session_is_valid (si, thread_index));
321   return pool_elt_at_index (session_main.wrk[thread_index].sessions, si);
322 }
323
324 always_inline session_t *
325 session_get_from_handle (session_handle_t handle)
326 {
327   session_main_t *smm = &session_main;
328   u32 session_index, thread_index;
329   session_parse_handle (handle, &session_index, &thread_index);
330   return pool_elt_at_index (smm->wrk[thread_index].sessions, session_index);
331 }
332
333 always_inline session_t *
334 session_get_from_handle_if_valid (session_handle_t handle)
335 {
336   u32 session_index, thread_index;
337   session_parse_handle (handle, &session_index, &thread_index);
338   return session_get_if_valid (session_index, thread_index);
339 }
340
341 u64 session_segment_handle (session_t * s);
342
343 /**
344  * Acquires a lock that blocks a session pool from expanding.
345  *
346  * This is typically used for safely peeking into other threads'
347  * pools in order to clone elements. Lock should be dropped as soon
348  * as possible by calling @ref session_pool_remove_peeker.
349  *
350  * NOTE: Avoid using pool_elt_at_index while the lock is held because
351  * it may lead to free elt bitmap expansion/contraction!
352  */
353 always_inline void
354 session_pool_add_peeker (u32 thread_index)
355 {
356   session_worker_t *wrk = &session_main.wrk[thread_index];
357   if (thread_index == vlib_get_thread_index ())
358     return;
359   clib_rwlock_reader_lock (&wrk->peekers_rw_locks);
360 }
361
362 always_inline void
363 session_pool_remove_peeker (u32 thread_index)
364 {
365   session_worker_t *wrk = &session_main.wrk[thread_index];
366   if (thread_index == vlib_get_thread_index ())
367     return;
368   clib_rwlock_reader_unlock (&wrk->peekers_rw_locks);
369 }
370
371 /**
372  * Get session from handle and 'lock' pool resize if not in same thread
373  *
374  * Caller should drop the peek 'lock' as soon as possible.
375  */
376 always_inline session_t *
377 session_get_from_handle_safe (u64 handle)
378 {
379   u32 thread_index = session_thread_from_handle (handle);
380   session_worker_t *wrk = &session_main.wrk[thread_index];
381
382   if (thread_index == vlib_get_thread_index ())
383     {
384       return pool_elt_at_index (wrk->sessions,
385                                 session_index_from_handle (handle));
386     }
387   else
388     {
389       session_pool_add_peeker (thread_index);
390       /* Don't use pool_elt_at index. See @ref session_pool_add_peeker */
391       return wrk->sessions + session_index_from_handle (handle);
392     }
393 }
394
395 always_inline u32
396 session_get_index (session_t * s)
397 {
398   return (s - session_main.wrk[s->thread_index].sessions);
399 }
400
401 always_inline session_t *
402 session_clone_safe (u32 session_index, u32 thread_index)
403 {
404   session_t *old_s, *new_s;
405   u32 current_thread_index = vlib_get_thread_index ();
406
407   /* If during the memcpy pool is reallocated AND the memory allocator
408    * decides to give the old chunk of memory to somebody in a hurry to
409    * scribble something on it, we have a problem. So add this thread as
410    * a session pool peeker.
411    */
412   session_pool_add_peeker (thread_index);
413   new_s = session_alloc (current_thread_index);
414   old_s = session_main.wrk[thread_index].sessions + session_index;
415   clib_memcpy_fast (new_s, old_s, sizeof (*new_s));
416   session_pool_remove_peeker (thread_index);
417   new_s->thread_index = current_thread_index;
418   new_s->session_index = session_get_index (new_s);
419   return new_s;
420 }
421
422 int session_open (u32 app_index, session_endpoint_t * tep, u32 opaque);
423 int session_listen (session_t * s, session_endpoint_cfg_t * sep);
424 int session_stop_listen (session_t * s);
425 void session_close (session_t * s);
426 void session_reset (session_t * s);
427 void session_transport_close (session_t * s);
428 void session_transport_reset (session_t * s);
429 void session_transport_cleanup (session_t * s);
430 int session_send_io_evt_to_thread (svm_fifo_t * f,
431                                    session_evt_type_t evt_type);
432 int session_enqueue_notify (session_t * s);
433 int session_dequeue_notify (session_t * s);
434 int session_send_io_evt_to_thread_custom (void *data, u32 thread_index,
435                                           session_evt_type_t evt_type);
436 void session_send_rpc_evt_to_thread (u32 thread_index, void *fp,
437                                      void *rpc_args);
438 void session_send_rpc_evt_to_thread_force (u32 thread_index, void *fp,
439                                            void *rpc_args);
440 void session_add_self_custom_tx_evt (transport_connection_t * tc,
441                                      u8 has_prio);
442 transport_connection_t *session_get_transport (session_t * s);
443 void session_get_endpoint (session_t * s, transport_endpoint_t * tep,
444                            u8 is_lcl);
445
446 u8 *format_session (u8 * s, va_list * args);
447 uword unformat_session (unformat_input_t * input, va_list * args);
448 uword unformat_transport_connection (unformat_input_t * input,
449                                      va_list * args);
450
451 /*
452  * Interface to transport protos
453  */
454
455 int session_enqueue_stream_connection (transport_connection_t * tc,
456                                        vlib_buffer_t * b, u32 offset,
457                                        u8 queue_event, u8 is_in_order);
458 int session_enqueue_dgram_connection (session_t * s,
459                                       session_dgram_hdr_t * hdr,
460                                       vlib_buffer_t * b, u8 proto,
461                                       u8 queue_event);
462 int session_stream_connect_notify (transport_connection_t * tc, u8 is_fail);
463 int session_dgram_connect_notify (transport_connection_t * tc,
464                                   u32 old_thread_index,
465                                   session_t ** new_session);
466 int session_stream_accept_notify (transport_connection_t * tc);
467 void session_transport_closing_notify (transport_connection_t * tc);
468 void session_transport_delete_notify (transport_connection_t * tc);
469 void session_transport_closed_notify (transport_connection_t * tc);
470 void session_transport_reset_notify (transport_connection_t * tc);
471 int session_stream_accept (transport_connection_t * tc, u32 listener_index,
472                            u32 thread_index, u8 notify);
473 void session_register_transport (transport_proto_t transport_proto,
474                                  const transport_proto_vft_t * vft, u8 is_ip4,
475                                  u32 output_node);
476 int session_tx_fifo_peek_bytes (transport_connection_t * tc, u8 * buffer,
477                                 u32 offset, u32 max_bytes);
478 u32 session_tx_fifo_dequeue_drop (transport_connection_t * tc, u32 max_bytes);
479
480 always_inline u32
481 transport_max_rx_enqueue (transport_connection_t * tc)
482 {
483   session_t *s = session_get (tc->s_index, tc->thread_index);
484   return svm_fifo_max_enqueue_prod (s->rx_fifo);
485 }
486
487 always_inline u32
488 transport_max_tx_dequeue (transport_connection_t * tc)
489 {
490   session_t *s = session_get (tc->s_index, tc->thread_index);
491   return svm_fifo_max_dequeue_cons (s->tx_fifo);
492 }
493
494 always_inline u32
495 transport_max_rx_dequeue (transport_connection_t * tc)
496 {
497   session_t *s = session_get (tc->s_index, tc->thread_index);
498   return svm_fifo_max_dequeue (s->rx_fifo);
499 }
500
501 always_inline u32
502 transport_rx_fifo_size (transport_connection_t * tc)
503 {
504   session_t *s = session_get (tc->s_index, tc->thread_index);
505   return s->rx_fifo->nitems;
506 }
507
508 always_inline u32
509 transport_tx_fifo_size (transport_connection_t * tc)
510 {
511   session_t *s = session_get (tc->s_index, tc->thread_index);
512   return s->tx_fifo->nitems;
513 }
514
515 always_inline u8
516 transport_rx_fifo_has_ooo_data (transport_connection_t * tc)
517 {
518   session_t *s = session_get (tc->c_index, tc->thread_index);
519   return svm_fifo_has_ooo_data (s->rx_fifo);
520 }
521
522 always_inline clib_time_type_t
523 transport_time_now (u32 thread_index)
524 {
525   return session_main.wrk[thread_index].last_vlib_time;
526 }
527
528 always_inline clib_us_time_t
529 transport_us_time_now (u32 thread_index)
530 {
531   return session_main.wrk[thread_index].last_vlib_us_time;
532 }
533
534 always_inline void
535 transport_add_tx_event (transport_connection_t * tc)
536 {
537   session_t *s = session_get (tc->s_index, tc->thread_index);
538   if (svm_fifo_has_event (s->tx_fifo))
539     return;
540   session_send_io_evt_to_thread (s->tx_fifo, SESSION_IO_EVT_TX);
541 }
542
543 /*
544  * Listen sessions
545  */
546
547 always_inline u64
548 listen_session_get_handle (session_t * s)
549 {
550   ASSERT (s->session_state == SESSION_STATE_LISTENING ||
551           session_get_transport_proto (s) == TRANSPORT_PROTO_QUIC);
552   return session_handle (s);
553 }
554
555 always_inline session_t *
556 listen_session_get_from_handle (session_handle_t handle)
557 {
558   return session_get_from_handle (handle);
559 }
560
561 always_inline void
562 listen_session_parse_handle (session_handle_t handle, u32 * index,
563                              u32 * thread_index)
564 {
565   session_parse_handle (handle, index, thread_index);
566 }
567
568 always_inline session_t *
569 listen_session_alloc (u8 thread_index, session_type_t type)
570 {
571   session_t *s;
572   s = session_alloc (thread_index);
573   s->session_type = type;
574   s->session_state = SESSION_STATE_LISTENING;
575   return s;
576 }
577
578 always_inline session_t *
579 listen_session_get (u32 ls_index)
580 {
581   return session_get (ls_index, 0);
582 }
583
584 always_inline void
585 listen_session_free (session_t * s)
586 {
587   session_free (s);
588 }
589
590 transport_connection_t *listen_session_get_transport (session_t * s);
591
592 /*
593  * Session layer functions
594  */
595
596 always_inline session_main_t *
597 vnet_get_session_main ()
598 {
599   return &session_main;
600 }
601
602 always_inline session_worker_t *
603 session_main_get_worker (u32 thread_index)
604 {
605   return &session_main.wrk[thread_index];
606 }
607
608 static inline session_worker_t *
609 session_main_get_worker_if_valid (u32 thread_index)
610 {
611   if (pool_is_free_index (session_main.wrk, thread_index))
612     return 0;
613   return &session_main.wrk[thread_index];
614 }
615
616 always_inline svm_msg_q_t *
617 session_main_get_vpp_event_queue (u32 thread_index)
618 {
619   return session_main.wrk[thread_index].vpp_event_queue;
620 }
621
622 always_inline u8
623 session_main_is_enabled ()
624 {
625   return session_main.is_enabled == 1;
626 }
627
628 #define session_cli_return_if_not_enabled()                             \
629 do {                                                                    \
630     if (!session_main.is_enabled)                                       \
631       return clib_error_return (0, "session layer is not enabled");     \
632 } while (0)
633
634 int session_main_flush_enqueue_events (u8 proto, u32 thread_index);
635 int session_main_flush_all_enqueue_events (u8 transport_proto);
636 void session_flush_frames_main_thread (vlib_main_t * vm);
637
638 always_inline void
639 session_add_pending_tx_buffer (session_type_t st, u32 thread_index, u32 bi)
640 {
641   session_worker_t *wrk = session_main_get_worker (thread_index);
642   vec_add1 (wrk->pending_tx_buffers, bi);
643   vec_add1 (wrk->pending_tx_nexts, session_main.session_type_to_next[st]);
644 }
645
646 ssvm_private_t *session_main_get_evt_q_segment (void);
647 void session_node_enable_disable (u8 is_en);
648 clib_error_t *vnet_session_enable_disable (vlib_main_t * vm, u8 is_en);
649
650 #endif /* __included_session_h__ */
651
652 /*
653  * fd.io coding-style-patch-verification: ON
654  *
655  * Local Variables:
656  * eval: (c-set-style "gnu")
657  * End:
658  */