session tcp vcl: api to update connection attributes
[vpp.git] / src / vnet / session / session_node.c
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
16 #include <math.h>
17 #include <vlib/vlib.h>
18 #include <vnet/vnet.h>
19 #include <vppinfra/elog.h>
20 #include <vnet/session/transport.h>
21 #include <vnet/session/session.h>
22 #include <vnet/session/application.h>
23 #include <vnet/session/application_interface.h>
24 #include <vnet/session/application_local.h>
25 #include <vnet/session/session_debug.h>
26 #include <svm/queue.h>
27 #include <sys/timerfd.h>
28
29 #define app_check_thread_and_barrier(_fn, _arg)                         \
30   if (!vlib_thread_is_main_w_barrier ())                                \
31     {                                                                   \
32      vlib_rpc_call_main_thread (_fn, (u8 *) _arg, sizeof(*_arg));       \
33       return;                                                           \
34    }
35
36 static void
37 session_mq_listen_handler (void *data)
38 {
39   session_listen_msg_t *mp = (session_listen_msg_t *) data;
40   vnet_listen_args_t _a, *a = &_a;
41   app_worker_t *app_wrk;
42   application_t *app;
43   int rv;
44
45   app_check_thread_and_barrier (session_mq_listen_handler, mp);
46
47   app = application_lookup (mp->client_index);
48   if (!app)
49     return;
50
51   clib_memset (a, 0, sizeof (*a));
52   a->sep.is_ip4 = mp->is_ip4;
53   ip_copy (&a->sep.ip, &mp->ip, mp->is_ip4);
54   a->sep.port = mp->port;
55   a->sep.fib_index = mp->vrf;
56   a->sep.sw_if_index = ENDPOINT_INVALID_INDEX;
57   a->sep.transport_proto = mp->proto;
58   a->sep_ext.ckpair_index = mp->ckpair_index;
59   a->sep_ext.crypto_engine = mp->crypto_engine;
60   a->app_index = app->app_index;
61   a->wrk_map_index = mp->wrk_index;
62   a->sep_ext.transport_flags = mp->flags;
63
64   if ((rv = vnet_listen (a)))
65     clib_warning ("listen returned: %U", format_session_error, rv);
66
67   app_wrk = application_get_worker (app, mp->wrk_index);
68   mq_send_session_bound_cb (app_wrk->wrk_index, mp->context, a->handle, rv);
69   return;
70 }
71
72 static void
73 session_mq_listen_uri_handler (void *data)
74 {
75   session_listen_uri_msg_t *mp = (session_listen_uri_msg_t *) data;
76   vnet_listen_args_t _a, *a = &_a;
77   app_worker_t *app_wrk;
78   application_t *app;
79   int rv;
80
81   app_check_thread_and_barrier (session_mq_listen_uri_handler, mp);
82
83   app = application_lookup (mp->client_index);
84   if (!app)
85     return;
86
87   clib_memset (a, 0, sizeof (*a));
88   a->uri = (char *) mp->uri;
89   a->app_index = app->app_index;
90   rv = vnet_bind_uri (a);
91
92   app_wrk = application_get_worker (app, 0);
93   mq_send_session_bound_cb (app_wrk->wrk_index, mp->context, a->handle, rv);
94 }
95
96 static void
97 session_mq_connect_handler (void *data)
98 {
99   session_connect_msg_t *mp = (session_connect_msg_t *) data;
100   vnet_connect_args_t _a, *a = &_a;
101   app_worker_t *app_wrk;
102   application_t *app;
103   int rv;
104
105   app_check_thread_and_barrier (session_mq_connect_handler, mp);
106
107   app = application_lookup (mp->client_index);
108   if (!app)
109     return;
110
111   clib_memset (a, 0, sizeof (*a));
112   a->sep.is_ip4 = mp->is_ip4;
113   clib_memcpy_fast (&a->sep.ip, &mp->ip, sizeof (mp->ip));
114   a->sep.port = mp->port;
115   a->sep.transport_proto = mp->proto;
116   a->sep.peer.fib_index = mp->vrf;
117   clib_memcpy_fast (&a->sep.peer.ip, &mp->lcl_ip, sizeof (mp->lcl_ip));
118   if (mp->is_ip4)
119     {
120       ip46_address_mask_ip4 (&a->sep.ip);
121       ip46_address_mask_ip4 (&a->sep.peer.ip);
122     }
123   a->sep.peer.port = mp->lcl_port;
124   a->sep.peer.sw_if_index = ENDPOINT_INVALID_INDEX;
125   a->sep_ext.parent_handle = mp->parent_handle;
126   a->sep_ext.ckpair_index = mp->ckpair_index;
127   a->sep_ext.crypto_engine = mp->crypto_engine;
128   a->sep_ext.transport_flags = mp->flags;
129   if (mp->hostname_len)
130     {
131       vec_validate (a->sep_ext.hostname, mp->hostname_len - 1);
132       clib_memcpy_fast (a->sep_ext.hostname, mp->hostname, mp->hostname_len);
133     }
134   a->api_context = mp->context;
135   a->app_index = app->app_index;
136   a->wrk_map_index = mp->wrk_index;
137
138   if ((rv = vnet_connect (a)))
139     {
140       clib_warning ("connect returned: %U", format_session_error, rv);
141       app_wrk = application_get_worker (app, mp->wrk_index);
142       mq_send_session_connected_cb (app_wrk->wrk_index, mp->context, 0, rv);
143     }
144
145   vec_free (a->sep_ext.hostname);
146 }
147
148 static void
149 session_mq_connect_uri_handler (void *data)
150 {
151   session_connect_uri_msg_t *mp = (session_connect_uri_msg_t *) data;
152   vnet_connect_args_t _a, *a = &_a;
153   app_worker_t *app_wrk;
154   application_t *app;
155   int rv;
156
157   app_check_thread_and_barrier (session_mq_connect_uri_handler, mp);
158
159   app = application_lookup (mp->client_index);
160   if (!app)
161     return;
162
163   clib_memset (a, 0, sizeof (*a));
164   a->uri = (char *) mp->uri;
165   a->api_context = mp->context;
166   a->app_index = app->app_index;
167   if ((rv = vnet_connect_uri (a)))
168     {
169       clib_warning ("connect_uri returned: %d", rv);
170       app_wrk = application_get_worker (app, 0 /* default wrk only */ );
171       mq_send_session_connected_cb (app_wrk->wrk_index, mp->context, 0, rv);
172     }
173 }
174
175 static void
176 session_mq_disconnect_handler (void *data)
177 {
178   session_disconnect_msg_t *mp = (session_disconnect_msg_t *) data;
179   vnet_disconnect_args_t _a, *a = &_a;
180   application_t *app;
181
182   app = application_lookup (mp->client_index);
183   if (!app)
184     return;
185
186   a->app_index = app->app_index;
187   a->handle = mp->handle;
188   vnet_disconnect_session (a);
189 }
190
191 static void
192 app_mq_detach_handler (void *data)
193 {
194   session_app_detach_msg_t *mp = (session_app_detach_msg_t *) data;
195   vnet_app_detach_args_t _a, *a = &_a;
196   application_t *app;
197
198   app_check_thread_and_barrier (app_mq_detach_handler, mp);
199
200   app = application_lookup (mp->client_index);
201   if (!app)
202     return;
203
204   a->app_index = app->app_index;
205   a->api_client_index = mp->client_index;
206   vnet_application_detach (a);
207 }
208
209 static void
210 session_mq_unlisten_handler (void *data)
211 {
212   session_unlisten_msg_t *mp = (session_unlisten_msg_t *) data;
213   vnet_unlisten_args_t _a, *a = &_a;
214   app_worker_t *app_wrk;
215   application_t *app;
216   int rv;
217
218   app_check_thread_and_barrier (session_mq_unlisten_handler, mp);
219
220   app = application_lookup (mp->client_index);
221   if (!app)
222     return;
223
224   clib_memset (a, 0, sizeof (*a));
225   a->app_index = app->app_index;
226   a->handle = mp->handle;
227   a->wrk_map_index = mp->wrk_index;
228   if ((rv = vnet_unlisten (a)))
229     clib_warning ("unlisten returned: %d", rv);
230
231   app_wrk = application_get_worker (app, a->wrk_map_index);
232   if (!app_wrk)
233     return;
234
235   mq_send_unlisten_reply (app_wrk, mp->handle, mp->context, rv);
236 }
237
238 static void
239 session_mq_accepted_reply_handler (void *data)
240 {
241   session_accepted_reply_msg_t *mp = (session_accepted_reply_msg_t *) data;
242   vnet_disconnect_args_t _a = { 0 }, *a = &_a;
243   session_state_t old_state;
244   app_worker_t *app_wrk;
245   session_t *s;
246
247   /* Server isn't interested, kill the session */
248   if (mp->retval)
249     {
250       a->app_index = mp->context;
251       a->handle = mp->handle;
252       vnet_disconnect_session (a);
253       return;
254     }
255
256   /* Mail this back from the main thread. We're not polling in main
257    * thread so we're using other workers for notifications. */
258   if (vlib_num_workers () && vlib_get_thread_index () != 0
259       && session_thread_from_handle (mp->handle) == 0)
260     {
261       vlib_rpc_call_main_thread (session_mq_accepted_reply_handler,
262                                  (u8 *) mp, sizeof (*mp));
263       return;
264     }
265
266   s = session_get_from_handle_if_valid (mp->handle);
267   if (!s)
268     return;
269
270   app_wrk = app_worker_get (s->app_wrk_index);
271   if (app_wrk->app_index != mp->context)
272     {
273       clib_warning ("app doesn't own session");
274       return;
275     }
276
277   if (!session_has_transport (s))
278     {
279       s->session_state = SESSION_STATE_READY;
280       if (ct_session_connect_notify (s))
281         return;
282     }
283   else
284     {
285       old_state = s->session_state;
286       s->session_state = SESSION_STATE_READY;
287
288       if (!svm_fifo_is_empty_prod (s->rx_fifo))
289         app_worker_lock_and_send_event (app_wrk, s, SESSION_IO_EVT_RX);
290
291       /* Closed while waiting for app to reply. Resend disconnect */
292       if (old_state >= SESSION_STATE_TRANSPORT_CLOSING)
293         {
294           app_worker_close_notify (app_wrk, s);
295           s->session_state = old_state;
296           return;
297         }
298     }
299 }
300
301 static void
302 session_mq_reset_reply_handler (void *data)
303 {
304   vnet_disconnect_args_t _a = { 0 }, *a = &_a;
305   session_reset_reply_msg_t *mp;
306   app_worker_t *app_wrk;
307   session_t *s;
308   application_t *app;
309   u32 index, thread_index;
310
311   mp = (session_reset_reply_msg_t *) data;
312   app = application_lookup (mp->context);
313   if (!app)
314     return;
315
316   session_parse_handle (mp->handle, &index, &thread_index);
317   s = session_get_if_valid (index, thread_index);
318
319   /* No session or not the right session */
320   if (!s || s->session_state < SESSION_STATE_TRANSPORT_CLOSING)
321     return;
322
323   app_wrk = app_worker_get (s->app_wrk_index);
324   if (!app_wrk || app_wrk->app_index != app->app_index)
325     {
326       clib_warning ("App %u does not own handle 0x%lx!", app->app_index,
327                     mp->handle);
328       return;
329     }
330
331   /* Client objected to resetting the session, log and continue */
332   if (mp->retval)
333     {
334       clib_warning ("client retval %d", mp->retval);
335       return;
336     }
337
338   /* This comes as a response to a reset, transport only waiting for
339    * confirmation to remove connection state, no need to disconnect */
340   a->handle = mp->handle;
341   a->app_index = app->app_index;
342   vnet_disconnect_session (a);
343 }
344
345 static void
346 session_mq_disconnected_handler (void *data)
347 {
348   session_disconnected_reply_msg_t *rmp;
349   vnet_disconnect_args_t _a, *a = &_a;
350   svm_msg_q_msg_t _msg, *msg = &_msg;
351   session_disconnected_msg_t *mp;
352   app_worker_t *app_wrk;
353   session_event_t *evt;
354   session_t *s;
355   application_t *app;
356   int rv = 0;
357
358   mp = (session_disconnected_msg_t *) data;
359   if (!(s = session_get_from_handle_if_valid (mp->handle)))
360     {
361       clib_warning ("could not disconnect handle %llu", mp->handle);
362       return;
363     }
364   app_wrk = app_worker_get (s->app_wrk_index);
365   app = application_lookup (mp->client_index);
366   if (!(app_wrk && app && app->app_index == app_wrk->app_index))
367     {
368       clib_warning ("could not disconnect session: %llu app: %u",
369                     mp->handle, mp->client_index);
370       return;
371     }
372
373   a->handle = mp->handle;
374   a->app_index = app_wrk->wrk_index;
375   rv = vnet_disconnect_session (a);
376
377   svm_msg_q_lock_and_alloc_msg_w_ring (app_wrk->event_queue,
378                                        SESSION_MQ_CTRL_EVT_RING,
379                                        SVM_Q_WAIT, msg);
380   evt = svm_msg_q_msg_data (app_wrk->event_queue, msg);
381   clib_memset (evt, 0, sizeof (*evt));
382   evt->event_type = SESSION_CTRL_EVT_DISCONNECTED_REPLY;
383   rmp = (session_disconnected_reply_msg_t *) evt->data;
384   rmp->handle = mp->handle;
385   rmp->context = mp->context;
386   rmp->retval = rv;
387   svm_msg_q_add_and_unlock (app_wrk->event_queue, msg);
388 }
389
390 static void
391 session_mq_disconnected_reply_handler (void *data)
392 {
393   session_disconnected_reply_msg_t *mp;
394   vnet_disconnect_args_t _a, *a = &_a;
395   application_t *app;
396
397   mp = (session_disconnected_reply_msg_t *) data;
398
399   /* Client objected to disconnecting the session, log and continue */
400   if (mp->retval)
401     {
402       clib_warning ("client retval %d", mp->retval);
403       return;
404     }
405
406   /* Disconnect has been confirmed. Confirm close to transport */
407   app = application_lookup (mp->context);
408   if (app)
409     {
410       a->handle = mp->handle;
411       a->app_index = app->app_index;
412       vnet_disconnect_session (a);
413     }
414 }
415
416 static void
417 session_mq_worker_update_handler (void *data)
418 {
419   session_worker_update_msg_t *mp = (session_worker_update_msg_t *) data;
420   session_worker_update_reply_msg_t *rmp;
421   svm_msg_q_msg_t _msg, *msg = &_msg;
422   app_worker_t *app_wrk;
423   u32 owner_app_wrk_map;
424   session_event_t *evt;
425   session_t *s;
426   application_t *app;
427
428   app = application_lookup (mp->client_index);
429   if (!app)
430     return;
431   if (!(s = session_get_from_handle_if_valid (mp->handle)))
432     {
433       clib_warning ("invalid handle %llu", mp->handle);
434       return;
435     }
436   app_wrk = app_worker_get (s->app_wrk_index);
437   if (app_wrk->app_index != app->app_index)
438     {
439       clib_warning ("app %u does not own session %llu", app->app_index,
440                     mp->handle);
441       return;
442     }
443   owner_app_wrk_map = app_wrk->wrk_map_index;
444   app_wrk = application_get_worker (app, mp->wrk_index);
445
446   /* This needs to come from the new owner */
447   if (mp->req_wrk_index == owner_app_wrk_map)
448     {
449       session_req_worker_update_msg_t *wump;
450
451       svm_msg_q_lock_and_alloc_msg_w_ring (app_wrk->event_queue,
452                                            SESSION_MQ_CTRL_EVT_RING,
453                                            SVM_Q_WAIT, msg);
454       evt = svm_msg_q_msg_data (app_wrk->event_queue, msg);
455       clib_memset (evt, 0, sizeof (*evt));
456       evt->event_type = SESSION_CTRL_EVT_REQ_WORKER_UPDATE;
457       wump = (session_req_worker_update_msg_t *) evt->data;
458       wump->session_handle = mp->handle;
459       svm_msg_q_add_and_unlock (app_wrk->event_queue, msg);
460       return;
461     }
462
463   app_worker_own_session (app_wrk, s);
464
465   /*
466    * Send reply
467    */
468   svm_msg_q_lock_and_alloc_msg_w_ring (app_wrk->event_queue,
469                                        SESSION_MQ_CTRL_EVT_RING,
470                                        SVM_Q_WAIT, msg);
471   evt = svm_msg_q_msg_data (app_wrk->event_queue, msg);
472   clib_memset (evt, 0, sizeof (*evt));
473   evt->event_type = SESSION_CTRL_EVT_WORKER_UPDATE_REPLY;
474   rmp = (session_worker_update_reply_msg_t *) evt->data;
475   rmp->handle = mp->handle;
476   if (s->rx_fifo)
477     rmp->rx_fifo = fifo_segment_fifo_offset (s->rx_fifo);
478   if (s->tx_fifo)
479     rmp->tx_fifo = fifo_segment_fifo_offset (s->tx_fifo);
480   rmp->segment_handle = session_segment_handle (s);
481   svm_msg_q_add_and_unlock (app_wrk->event_queue, msg);
482
483   /*
484    * Retransmit messages that may have been lost
485    */
486   if (s->tx_fifo && !svm_fifo_is_empty (s->tx_fifo))
487     session_send_io_evt_to_thread (s->tx_fifo, SESSION_IO_EVT_TX);
488
489   if (s->rx_fifo && !svm_fifo_is_empty (s->rx_fifo))
490     app_worker_lock_and_send_event (app_wrk, s, SESSION_IO_EVT_RX);
491
492   if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
493     app_worker_close_notify (app_wrk, s);
494 }
495
496 static void
497 session_mq_app_wrk_rpc_handler (void *data)
498 {
499   session_app_wrk_rpc_msg_t *mp = (session_app_wrk_rpc_msg_t *) data;
500   svm_msg_q_msg_t _msg, *msg = &_msg;
501   session_app_wrk_rpc_msg_t *rmp;
502   app_worker_t *app_wrk;
503   session_event_t *evt;
504   application_t *app;
505
506   app = application_lookup (mp->client_index);
507   if (!app)
508     return;
509
510   app_wrk = application_get_worker (app, mp->wrk_index);
511
512   svm_msg_q_lock_and_alloc_msg_w_ring (app_wrk->event_queue,
513                                        SESSION_MQ_CTRL_EVT_RING, SVM_Q_WAIT,
514                                        msg);
515   evt = svm_msg_q_msg_data (app_wrk->event_queue, msg);
516   clib_memset (evt, 0, sizeof (*evt));
517   evt->event_type = SESSION_CTRL_EVT_APP_WRK_RPC;
518   rmp = (session_app_wrk_rpc_msg_t *) evt->data;
519   clib_memcpy (rmp->data, mp->data, sizeof (mp->data));
520   svm_msg_q_add_and_unlock (app_wrk->event_queue, msg);
521 }
522
523 static void
524 session_mq_transport_attr_handler (void *data)
525 {
526   session_transport_attr_msg_t *mp = (session_transport_attr_msg_t *) data;
527   session_transport_attr_reply_msg_t *rmp;
528   svm_msg_q_msg_t _msg, *msg = &_msg;
529   app_worker_t *app_wrk;
530   session_event_t *evt;
531   application_t *app;
532   session_t *s;
533   int rv;
534
535   app = application_lookup (mp->client_index);
536   if (!app)
537     return;
538
539   if (!(s = session_get_from_handle_if_valid (mp->handle)))
540     {
541       clib_warning ("invalid handle %llu", mp->handle);
542       return;
543     }
544   app_wrk = app_worker_get (s->app_wrk_index);
545   if (app_wrk->app_index != app->app_index)
546     {
547       clib_warning ("app %u does not own session %llu", app->app_index,
548                     mp->handle);
549       return;
550     }
551
552   rv = session_transport_attribute (s, mp->is_get, &mp->attr);
553
554   svm_msg_q_lock_and_alloc_msg_w_ring (
555     app_wrk->event_queue, SESSION_MQ_CTRL_EVT_RING, SVM_Q_WAIT, msg);
556   evt = svm_msg_q_msg_data (app_wrk->event_queue, msg);
557   clib_memset (evt, 0, sizeof (*evt));
558   evt->event_type = SESSION_CTRL_EVT_TRANSPORT_ATTR_REPLY;
559   rmp = (session_transport_attr_reply_msg_t *) evt->data;
560   rmp->handle = mp->handle;
561   rmp->retval = rv;
562   rmp->is_get = mp->is_get;
563   if (!rv && mp->is_get)
564     rmp->attr = mp->attr;
565   svm_msg_q_add_and_unlock (app_wrk->event_queue, msg);
566 }
567
568 vlib_node_registration_t session_queue_node;
569
570 typedef struct
571 {
572   u32 session_index;
573   u32 server_thread_index;
574 } session_queue_trace_t;
575
576 /* packet trace format function */
577 static u8 *
578 format_session_queue_trace (u8 * s, va_list * args)
579 {
580   CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
581   CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
582   session_queue_trace_t *t = va_arg (*args, session_queue_trace_t *);
583
584   s = format (s, "session index %d thread index %d",
585               t->session_index, t->server_thread_index);
586   return s;
587 }
588
589 #define foreach_session_queue_error             \
590 _(TX, "Packets transmitted")                    \
591 _(TIMER, "Timer events")                        \
592 _(NO_BUFFER, "Out of buffers")
593
594 typedef enum
595 {
596 #define _(sym,str) SESSION_QUEUE_ERROR_##sym,
597   foreach_session_queue_error
598 #undef _
599     SESSION_QUEUE_N_ERROR,
600 } session_queue_error_t;
601
602 static char *session_queue_error_strings[] = {
603 #define _(sym,string) string,
604   foreach_session_queue_error
605 #undef _
606 };
607
608 enum
609 {
610   SESSION_TX_NO_BUFFERS = -2,
611   SESSION_TX_NO_DATA,
612   SESSION_TX_OK
613 };
614
615 static void
616 session_tx_trace_frame (vlib_main_t * vm, vlib_node_runtime_t * node,
617                         u32 next_index, u32 * to_next, u16 n_segs,
618                         session_t * s, u32 n_trace)
619 {
620   while (n_trace && n_segs)
621     {
622       vlib_buffer_t *b = vlib_get_buffer (vm, to_next[0]);
623       if (PREDICT_TRUE
624           (vlib_trace_buffer
625            (vm, node, next_index, b, 1 /* follow_chain */ )))
626         {
627           session_queue_trace_t *t =
628             vlib_add_trace (vm, node, b, sizeof (*t));
629           t->session_index = s->session_index;
630           t->server_thread_index = s->thread_index;
631           n_trace--;
632         }
633       to_next++;
634       n_segs--;
635     }
636   vlib_set_trace_count (vm, node, n_trace);
637 }
638
639 always_inline void
640 session_tx_fifo_chain_tail (vlib_main_t * vm, session_tx_context_t * ctx,
641                             vlib_buffer_t * b, u16 * n_bufs, u8 peek_data)
642 {
643   vlib_buffer_t *chain_b, *prev_b;
644   u32 chain_bi0, to_deq, left_from_seg;
645   session_worker_t *wrk;
646   u16 len_to_deq, n_bytes_read;
647   u8 *data, j;
648
649   wrk = session_main_get_worker (ctx->s->thread_index);
650   b->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
651   b->total_length_not_including_first_buffer = 0;
652
653   chain_b = b;
654   left_from_seg = clib_min (ctx->sp.snd_mss - b->current_length,
655                             ctx->left_to_snd);
656   to_deq = left_from_seg;
657   for (j = 1; j < ctx->n_bufs_per_seg; j++)
658     {
659       prev_b = chain_b;
660       len_to_deq = clib_min (to_deq, ctx->deq_per_buf);
661
662       *n_bufs -= 1;
663       chain_bi0 = wrk->tx_buffers[*n_bufs];
664       chain_b = vlib_get_buffer (vm, chain_bi0);
665       chain_b->current_data = 0;
666       data = vlib_buffer_get_current (chain_b);
667       if (peek_data)
668         {
669           n_bytes_read = svm_fifo_peek (ctx->s->tx_fifo,
670                                         ctx->sp.tx_offset, len_to_deq, data);
671           ctx->sp.tx_offset += n_bytes_read;
672         }
673       else
674         {
675           if (ctx->transport_vft->transport_options.tx_type ==
676               TRANSPORT_TX_DGRAM)
677             {
678               svm_fifo_t *f = ctx->s->tx_fifo;
679               session_dgram_hdr_t *hdr = &ctx->hdr;
680               u16 deq_now;
681               u32 offset;
682
683               deq_now = clib_min (hdr->data_length - hdr->data_offset,
684                                   len_to_deq);
685               offset = hdr->data_offset + SESSION_CONN_HDR_LEN;
686               n_bytes_read = svm_fifo_peek (f, offset, deq_now, data);
687               ASSERT (n_bytes_read > 0);
688
689               hdr->data_offset += n_bytes_read;
690               if (hdr->data_offset == hdr->data_length)
691                 {
692                   offset = hdr->data_length + SESSION_CONN_HDR_LEN;
693                   svm_fifo_dequeue_drop (f, offset);
694                   if (ctx->left_to_snd > n_bytes_read)
695                     svm_fifo_peek (ctx->s->tx_fifo, 0, sizeof (ctx->hdr),
696                                    (u8 *) & ctx->hdr);
697                 }
698               else if (ctx->left_to_snd == n_bytes_read)
699                 svm_fifo_overwrite_head (ctx->s->tx_fifo, (u8 *) & ctx->hdr,
700                                          sizeof (session_dgram_pre_hdr_t));
701             }
702           else
703             n_bytes_read = svm_fifo_dequeue (ctx->s->tx_fifo,
704                                              len_to_deq, data);
705         }
706       ASSERT (n_bytes_read == len_to_deq);
707       chain_b->current_length = n_bytes_read;
708       b->total_length_not_including_first_buffer += chain_b->current_length;
709
710       /* update previous buffer */
711       prev_b->next_buffer = chain_bi0;
712       prev_b->flags |= VLIB_BUFFER_NEXT_PRESENT;
713
714       /* update current buffer */
715       chain_b->next_buffer = 0;
716
717       to_deq -= n_bytes_read;
718       if (to_deq == 0)
719         break;
720     }
721   ASSERT (to_deq == 0
722           && b->total_length_not_including_first_buffer == left_from_seg);
723   ctx->left_to_snd -= left_from_seg;
724 }
725
726 always_inline void
727 session_tx_fill_buffer (vlib_main_t * vm, session_tx_context_t * ctx,
728                         vlib_buffer_t * b, u16 * n_bufs, u8 peek_data)
729 {
730   u32 len_to_deq;
731   u8 *data0;
732   int n_bytes_read;
733
734   /*
735    * Start with the first buffer in chain
736    */
737   b->error = 0;
738   b->flags = VNET_BUFFER_F_LOCALLY_ORIGINATED;
739   b->current_data = 0;
740
741   data0 = vlib_buffer_make_headroom (b, TRANSPORT_MAX_HDRS_LEN);
742   len_to_deq = clib_min (ctx->left_to_snd, ctx->deq_per_first_buf);
743
744   if (peek_data)
745     {
746       n_bytes_read = svm_fifo_peek (ctx->s->tx_fifo, ctx->sp.tx_offset,
747                                     len_to_deq, data0);
748       ASSERT (n_bytes_read > 0);
749       /* Keep track of progress locally, transport is also supposed to
750        * increment it independently when pushing the header */
751       ctx->sp.tx_offset += n_bytes_read;
752     }
753   else
754     {
755       if (ctx->transport_vft->transport_options.tx_type == TRANSPORT_TX_DGRAM)
756         {
757           session_dgram_hdr_t *hdr = &ctx->hdr;
758           svm_fifo_t *f = ctx->s->tx_fifo;
759           u16 deq_now;
760           u32 offset;
761
762           ASSERT (hdr->data_length > hdr->data_offset);
763           deq_now = clib_min (hdr->data_length - hdr->data_offset,
764                               len_to_deq);
765           offset = hdr->data_offset + SESSION_CONN_HDR_LEN;
766           n_bytes_read = svm_fifo_peek (f, offset, deq_now, data0);
767           ASSERT (n_bytes_read > 0);
768
769           if (ctx->s->session_state == SESSION_STATE_LISTENING)
770             {
771               ip_copy (&ctx->tc->rmt_ip, &hdr->rmt_ip, ctx->tc->is_ip4);
772               ctx->tc->rmt_port = hdr->rmt_port;
773             }
774           hdr->data_offset += n_bytes_read;
775           if (hdr->data_offset == hdr->data_length)
776             {
777               offset = hdr->data_length + SESSION_CONN_HDR_LEN;
778               svm_fifo_dequeue_drop (f, offset);
779               if (ctx->left_to_snd > n_bytes_read)
780                 svm_fifo_peek (ctx->s->tx_fifo, 0, sizeof (ctx->hdr),
781                                (u8 *) & ctx->hdr);
782             }
783           else if (ctx->left_to_snd == n_bytes_read)
784             svm_fifo_overwrite_head (ctx->s->tx_fifo, (u8 *) & ctx->hdr,
785                                      sizeof (session_dgram_pre_hdr_t));
786         }
787       else
788         {
789           n_bytes_read = svm_fifo_dequeue (ctx->s->tx_fifo,
790                                            len_to_deq, data0);
791           ASSERT (n_bytes_read > 0);
792         }
793     }
794   b->current_length = n_bytes_read;
795   ctx->left_to_snd -= n_bytes_read;
796
797   /*
798    * Fill in the remaining buffers in the chain, if any
799    */
800   if (PREDICT_FALSE (ctx->n_bufs_per_seg > 1 && ctx->left_to_snd))
801     session_tx_fifo_chain_tail (vm, ctx, b, n_bufs, peek_data);
802 }
803
804 always_inline u8
805 session_tx_not_ready (session_t * s, u8 peek_data)
806 {
807   if (peek_data)
808     {
809       if (PREDICT_TRUE (s->session_state == SESSION_STATE_READY))
810         return 0;
811       /* Can retransmit for closed sessions but can't send new data if
812        * session is not ready or closed */
813       else if (s->session_state < SESSION_STATE_READY)
814         return 1;
815       else if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSED)
816         {
817           /* Allow closed transports to still send custom packets.
818            * For instance, tcp may want to send acks in time-wait. */
819           if (s->session_state != SESSION_STATE_TRANSPORT_DELETED
820               && (s->flags & SESSION_F_CUSTOM_TX))
821             return 0;
822           return 2;
823         }
824     }
825   return 0;
826 }
827
828 always_inline transport_connection_t *
829 session_tx_get_transport (session_tx_context_t * ctx, u8 peek_data)
830 {
831   if (peek_data)
832     {
833       return ctx->transport_vft->get_connection (ctx->s->connection_index,
834                                                  ctx->s->thread_index);
835     }
836   else
837     {
838       if (ctx->s->session_state == SESSION_STATE_LISTENING)
839         return ctx->transport_vft->get_listener (ctx->s->connection_index);
840       else
841         {
842           return ctx->transport_vft->get_connection (ctx->s->connection_index,
843                                                      ctx->s->thread_index);
844         }
845     }
846 }
847
848 always_inline void
849 session_tx_set_dequeue_params (vlib_main_t * vm, session_tx_context_t * ctx,
850                                u32 max_segs, u8 peek_data)
851 {
852   u32 n_bytes_per_buf, n_bytes_per_seg;
853
854   n_bytes_per_buf = vlib_buffer_get_default_data_size (vm);
855   ctx->max_dequeue = svm_fifo_max_dequeue_cons (ctx->s->tx_fifo);
856
857   if (peek_data)
858     {
859       /* Offset in rx fifo from where to peek data */
860       if (PREDICT_FALSE (ctx->sp.tx_offset >= ctx->max_dequeue))
861         {
862           ctx->max_len_to_snd = 0;
863           return;
864         }
865       ctx->max_dequeue -= ctx->sp.tx_offset;
866     }
867   else
868     {
869       if (ctx->transport_vft->transport_options.tx_type == TRANSPORT_TX_DGRAM)
870         {
871           u32 len, chain_limit;
872
873           if (ctx->max_dequeue <= sizeof (ctx->hdr))
874             {
875               ctx->max_len_to_snd = 0;
876               return;
877             }
878
879           svm_fifo_peek (ctx->s->tx_fifo, 0, sizeof (ctx->hdr),
880                          (u8 *) & ctx->hdr);
881           ASSERT (ctx->hdr.data_length > ctx->hdr.data_offset);
882           len = ctx->hdr.data_length - ctx->hdr.data_offset;
883
884           /* Process multiple dgrams if smaller than min (buf_space, mss).
885            * This avoids handling multiple dgrams if they require buffer
886            * chains */
887           chain_limit = clib_min (n_bytes_per_buf - TRANSPORT_MAX_HDRS_LEN,
888                                   ctx->sp.snd_mss);
889           if (ctx->hdr.data_length <= chain_limit)
890             {
891               u32 first_dgram_len, dgram_len, offset, max_offset;
892               session_dgram_hdr_t hdr;
893
894               ctx->sp.snd_mss = clib_min (ctx->sp.snd_mss, len);
895               offset = ctx->hdr.data_length + sizeof (session_dgram_hdr_t);
896               first_dgram_len = len;
897               max_offset = clib_min (ctx->max_dequeue, 16 << 10);
898
899               while (offset < max_offset)
900                 {
901                   svm_fifo_peek (ctx->s->tx_fifo, offset, sizeof (ctx->hdr),
902                                  (u8 *) & hdr);
903                   ASSERT (hdr.data_length > hdr.data_offset);
904                   dgram_len = hdr.data_length - hdr.data_offset;
905                   if (len + dgram_len > ctx->max_dequeue
906                       || first_dgram_len != dgram_len)
907                     break;
908                   len += dgram_len;
909                   offset += sizeof (hdr) + hdr.data_length;
910                 }
911             }
912
913           ctx->max_dequeue = len;
914         }
915     }
916   ASSERT (ctx->max_dequeue > 0);
917
918   /* Ensure we're not writing more than transport window allows */
919   if (ctx->max_dequeue < ctx->sp.snd_space)
920     {
921       /* Constrained by tx queue. Try to send only fully formed segments */
922       ctx->max_len_to_snd = (ctx->max_dequeue > ctx->sp.snd_mss) ?
923         (ctx->max_dequeue - (ctx->max_dequeue % ctx->sp.snd_mss)) :
924         ctx->max_dequeue;
925       /* TODO Nagle ? */
926     }
927   else
928     {
929       /* Expectation is that snd_space0 is already a multiple of snd_mss */
930       ctx->max_len_to_snd = ctx->sp.snd_space;
931     }
932
933   /* Check if we're tx constrained by the node */
934   ctx->n_segs_per_evt = ceil ((f64) ctx->max_len_to_snd / ctx->sp.snd_mss);
935   if (ctx->n_segs_per_evt > max_segs)
936     {
937       ctx->n_segs_per_evt = max_segs;
938       ctx->max_len_to_snd = max_segs * ctx->sp.snd_mss;
939     }
940
941   ASSERT (n_bytes_per_buf > TRANSPORT_MAX_HDRS_LEN);
942   if (ctx->n_segs_per_evt > 1)
943     {
944       u32 n_bytes_last_seg, n_bufs_last_seg;
945
946       n_bytes_per_seg = TRANSPORT_MAX_HDRS_LEN + ctx->sp.snd_mss;
947       n_bytes_last_seg = TRANSPORT_MAX_HDRS_LEN + ctx->max_len_to_snd
948         - ((ctx->n_segs_per_evt - 1) * ctx->sp.snd_mss);
949       ctx->n_bufs_per_seg = ceil ((f64) n_bytes_per_seg / n_bytes_per_buf);
950       n_bufs_last_seg = ceil ((f64) n_bytes_last_seg / n_bytes_per_buf);
951       ctx->n_bufs_needed = ((ctx->n_segs_per_evt - 1) * ctx->n_bufs_per_seg)
952         + n_bufs_last_seg;
953     }
954   else
955     {
956       n_bytes_per_seg = TRANSPORT_MAX_HDRS_LEN + ctx->max_len_to_snd;
957       ctx->n_bufs_per_seg = ceil ((f64) n_bytes_per_seg / n_bytes_per_buf);
958       ctx->n_bufs_needed = ctx->n_bufs_per_seg;
959     }
960
961   ctx->deq_per_buf = clib_min (ctx->sp.snd_mss, n_bytes_per_buf);
962   ctx->deq_per_first_buf = clib_min (ctx->sp.snd_mss,
963                                      n_bytes_per_buf -
964                                      TRANSPORT_MAX_HDRS_LEN);
965 }
966
967 always_inline void
968 session_tx_maybe_reschedule (session_worker_t * wrk,
969                              session_tx_context_t * ctx,
970                              session_evt_elt_t * elt)
971 {
972   session_t *s = ctx->s;
973
974   svm_fifo_unset_event (s->tx_fifo);
975   if (svm_fifo_max_dequeue_cons (s->tx_fifo) > ctx->sp.tx_offset)
976     if (svm_fifo_set_event (s->tx_fifo))
977       session_evt_add_head_old (wrk, elt);
978 }
979
980 always_inline int
981 session_tx_fifo_read_and_snd_i (session_worker_t * wrk,
982                                 vlib_node_runtime_t * node,
983                                 session_evt_elt_t * elt,
984                                 int *n_tx_packets, u8 peek_data)
985 {
986   u32 n_trace, n_left, pbi, next_index, max_burst;
987   session_tx_context_t *ctx = &wrk->ctx;
988   session_main_t *smm = &session_main;
989   session_event_t *e = &elt->evt;
990   vlib_main_t *vm = wrk->vm;
991   transport_proto_t tp;
992   vlib_buffer_t *pb;
993   u16 n_bufs, rv;
994
995   if (PREDICT_FALSE ((rv = session_tx_not_ready (ctx->s, peek_data))))
996     {
997       if (rv < 2)
998         session_evt_add_old (wrk, elt);
999       return SESSION_TX_NO_DATA;
1000     }
1001
1002   next_index = smm->session_type_to_next[ctx->s->session_type];
1003   max_burst = SESSION_NODE_FRAME_SIZE - *n_tx_packets;
1004
1005   tp = session_get_transport_proto (ctx->s);
1006   ctx->transport_vft = transport_protocol_get_vft (tp);
1007   ctx->tc = session_tx_get_transport (ctx, peek_data);
1008
1009   if (PREDICT_FALSE (e->event_type == SESSION_IO_EVT_TX_FLUSH))
1010     {
1011       if (ctx->transport_vft->flush_data)
1012         ctx->transport_vft->flush_data (ctx->tc);
1013       e->event_type = SESSION_IO_EVT_TX;
1014     }
1015
1016   if (ctx->s->flags & SESSION_F_CUSTOM_TX)
1017     {
1018       u32 n_custom_tx;
1019       ctx->s->flags &= ~SESSION_F_CUSTOM_TX;
1020       ctx->sp.max_burst_size = max_burst;
1021       n_custom_tx = ctx->transport_vft->custom_tx (ctx->tc, &ctx->sp);
1022       *n_tx_packets += n_custom_tx;
1023       if (PREDICT_FALSE
1024           (ctx->s->session_state >= SESSION_STATE_TRANSPORT_CLOSED))
1025         return SESSION_TX_OK;
1026       max_burst -= n_custom_tx;
1027       if (!max_burst || (ctx->s->flags & SESSION_F_CUSTOM_TX))
1028         {
1029           session_evt_add_old (wrk, elt);
1030           return SESSION_TX_OK;
1031         }
1032     }
1033
1034   transport_connection_snd_params (ctx->tc, &ctx->sp);
1035
1036   if (!ctx->sp.snd_space)
1037     {
1038       /* If the deschedule flag was set, remove session from scheduler.
1039        * Transport is responsible for rescheduling this session. */
1040       if (ctx->sp.flags & TRANSPORT_SND_F_DESCHED)
1041         transport_connection_deschedule (ctx->tc);
1042       /* Request to postpone the session, e.g., zero-wnd and transport
1043        * is not currently probing */
1044       else if (ctx->sp.flags & TRANSPORT_SND_F_POSTPONE)
1045         session_evt_add_old (wrk, elt);
1046       /* This flow queue is "empty" so it should be re-evaluated before
1047        * the ones that have data to send. */
1048       else
1049         session_evt_add_head_old (wrk, elt);
1050
1051       return SESSION_TX_NO_DATA;
1052     }
1053
1054   if (transport_connection_is_tx_paced (ctx->tc))
1055     {
1056       u32 snd_space = transport_connection_tx_pacer_burst (ctx->tc);
1057       if (snd_space < TRANSPORT_PACER_MIN_BURST)
1058         {
1059           session_evt_add_head_old (wrk, elt);
1060           return SESSION_TX_NO_DATA;
1061         }
1062       snd_space = clib_min (ctx->sp.snd_space, snd_space);
1063       ctx->sp.snd_space = snd_space >= ctx->sp.snd_mss ?
1064         snd_space - snd_space % ctx->sp.snd_mss : snd_space;
1065     }
1066
1067   /* Check how much we can pull. */
1068   session_tx_set_dequeue_params (vm, ctx, max_burst, peek_data);
1069
1070   if (PREDICT_FALSE (!ctx->max_len_to_snd))
1071     {
1072       transport_connection_tx_pacer_reset_bucket (ctx->tc, 0);
1073       session_tx_maybe_reschedule (wrk, ctx, elt);
1074       return SESSION_TX_NO_DATA;
1075     }
1076
1077   vec_validate_aligned (wrk->tx_buffers, ctx->n_bufs_needed - 1,
1078                         CLIB_CACHE_LINE_BYTES);
1079   n_bufs = vlib_buffer_alloc (vm, wrk->tx_buffers, ctx->n_bufs_needed);
1080   if (PREDICT_FALSE (n_bufs < ctx->n_bufs_needed))
1081     {
1082       if (n_bufs)
1083         vlib_buffer_free (vm, wrk->tx_buffers, n_bufs);
1084       session_evt_add_head_old (wrk, elt);
1085       vlib_node_increment_counter (wrk->vm, node->node_index,
1086                                    SESSION_QUEUE_ERROR_NO_BUFFER, 1);
1087       return SESSION_TX_NO_BUFFERS;
1088     }
1089
1090   if (transport_connection_is_tx_paced (ctx->tc))
1091     transport_connection_tx_pacer_update_bytes (ctx->tc, ctx->max_len_to_snd);
1092
1093   ctx->left_to_snd = ctx->max_len_to_snd;
1094   n_left = ctx->n_segs_per_evt;
1095
1096   while (n_left >= 4)
1097     {
1098       vlib_buffer_t *b0, *b1;
1099       u32 bi0, bi1;
1100
1101       pbi = wrk->tx_buffers[n_bufs - 3];
1102       pb = vlib_get_buffer (vm, pbi);
1103       vlib_prefetch_buffer_header (pb, STORE);
1104       pbi = wrk->tx_buffers[n_bufs - 4];
1105       pb = vlib_get_buffer (vm, pbi);
1106       vlib_prefetch_buffer_header (pb, STORE);
1107
1108       bi0 = wrk->tx_buffers[--n_bufs];
1109       bi1 = wrk->tx_buffers[--n_bufs];
1110
1111       b0 = vlib_get_buffer (vm, bi0);
1112       b1 = vlib_get_buffer (vm, bi1);
1113
1114       session_tx_fill_buffer (vm, ctx, b0, &n_bufs, peek_data);
1115       session_tx_fill_buffer (vm, ctx, b1, &n_bufs, peek_data);
1116
1117       ctx->transport_vft->push_header (ctx->tc, b0);
1118       ctx->transport_vft->push_header (ctx->tc, b1);
1119
1120       n_left -= 2;
1121
1122       VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b0);
1123       VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b1);
1124
1125       vec_add1 (wrk->pending_tx_buffers, bi0);
1126       vec_add1 (wrk->pending_tx_buffers, bi1);
1127       vec_add1 (wrk->pending_tx_nexts, next_index);
1128       vec_add1 (wrk->pending_tx_nexts, next_index);
1129     }
1130   while (n_left)
1131     {
1132       vlib_buffer_t *b0;
1133       u32 bi0;
1134
1135       if (n_left > 1)
1136         {
1137           pbi = wrk->tx_buffers[n_bufs - 2];
1138           pb = vlib_get_buffer (vm, pbi);
1139           vlib_prefetch_buffer_header (pb, STORE);
1140         }
1141
1142       bi0 = wrk->tx_buffers[--n_bufs];
1143       b0 = vlib_get_buffer (vm, bi0);
1144       session_tx_fill_buffer (vm, ctx, b0, &n_bufs, peek_data);
1145
1146       /* Ask transport to push header after current_length and
1147        * total_length_not_including_first_buffer are updated */
1148       ctx->transport_vft->push_header (ctx->tc, b0);
1149
1150       n_left -= 1;
1151
1152       VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b0);
1153
1154       vec_add1 (wrk->pending_tx_buffers, bi0);
1155       vec_add1 (wrk->pending_tx_nexts, next_index);
1156     }
1157
1158   if (PREDICT_FALSE ((n_trace = vlib_get_trace_count (vm, node)) > 0))
1159     session_tx_trace_frame (vm, node, next_index, wrk->pending_tx_buffers,
1160                             ctx->n_segs_per_evt, ctx->s, n_trace);
1161
1162   if (PREDICT_FALSE (n_bufs))
1163     vlib_buffer_free (vm, wrk->tx_buffers, n_bufs);
1164
1165   *n_tx_packets += ctx->n_segs_per_evt;
1166
1167   SESSION_EVT (SESSION_EVT_DEQ, ctx->s, ctx->max_len_to_snd, ctx->max_dequeue,
1168                ctx->s->tx_fifo->has_event, wrk->last_vlib_time);
1169
1170   ASSERT (ctx->left_to_snd == 0);
1171
1172   /* If we couldn't dequeue all bytes reschedule as old flow. Otherwise,
1173    * check if application enqueued more data and reschedule accordingly */
1174   if (ctx->max_len_to_snd < ctx->max_dequeue)
1175     session_evt_add_old (wrk, elt);
1176   else
1177     session_tx_maybe_reschedule (wrk, ctx, elt);
1178
1179   if (!peek_data)
1180     {
1181       u32 n_dequeued = ctx->max_len_to_snd;
1182       if (ctx->transport_vft->transport_options.tx_type == TRANSPORT_TX_DGRAM)
1183         n_dequeued += ctx->n_segs_per_evt * SESSION_CONN_HDR_LEN;
1184       if (svm_fifo_needs_deq_ntf (ctx->s->tx_fifo, n_dequeued))
1185         session_dequeue_notify (ctx->s);
1186     }
1187   return SESSION_TX_OK;
1188 }
1189
1190 int
1191 session_tx_fifo_peek_and_snd (session_worker_t * wrk,
1192                               vlib_node_runtime_t * node,
1193                               session_evt_elt_t * e, int *n_tx_packets)
1194 {
1195   return session_tx_fifo_read_and_snd_i (wrk, node, e, n_tx_packets, 1);
1196 }
1197
1198 int
1199 session_tx_fifo_dequeue_and_snd (session_worker_t * wrk,
1200                                  vlib_node_runtime_t * node,
1201                                  session_evt_elt_t * e, int *n_tx_packets)
1202 {
1203   return session_tx_fifo_read_and_snd_i (wrk, node, e, n_tx_packets, 0);
1204 }
1205
1206 int
1207 session_tx_fifo_dequeue_internal (session_worker_t * wrk,
1208                                   vlib_node_runtime_t * node,
1209                                   session_evt_elt_t * elt, int *n_tx_packets)
1210 {
1211   transport_send_params_t *sp = &wrk->ctx.sp;
1212   session_t *s = wrk->ctx.s;
1213   u32 n_packets;
1214
1215   if (PREDICT_FALSE (s->session_state >= SESSION_STATE_TRANSPORT_CLOSED))
1216     return 0;
1217
1218   /* Clear custom-tx flag used to request reschedule for tx */
1219   s->flags &= ~SESSION_F_CUSTOM_TX;
1220
1221   sp->max_burst_size = clib_min (SESSION_NODE_FRAME_SIZE - *n_tx_packets,
1222                                  TRANSPORT_PACER_MAX_BURST_PKTS);
1223
1224   n_packets = transport_custom_tx (session_get_transport_proto (s), s, sp);
1225   *n_tx_packets += n_packets;
1226
1227   if (s->flags & SESSION_F_CUSTOM_TX)
1228     {
1229       session_evt_add_old (wrk, elt);
1230     }
1231   else if (!(sp->flags & TRANSPORT_SND_F_DESCHED))
1232     {
1233       svm_fifo_unset_event (s->tx_fifo);
1234       if (svm_fifo_max_dequeue_cons (s->tx_fifo))
1235         if (svm_fifo_set_event (s->tx_fifo))
1236           session_evt_add_head_old (wrk, elt);
1237     }
1238
1239   if (sp->max_burst_size &&
1240       svm_fifo_needs_deq_ntf (s->tx_fifo, sp->max_burst_size))
1241     session_dequeue_notify (s);
1242
1243   return n_packets;
1244 }
1245
1246 always_inline session_t *
1247 session_event_get_session (session_worker_t * wrk, session_event_t * e)
1248 {
1249   if (PREDICT_FALSE (pool_is_free_index (wrk->sessions, e->session_index)))
1250     return 0;
1251
1252   ASSERT (session_is_valid (e->session_index, wrk->vm->thread_index));
1253   return pool_elt_at_index (wrk->sessions, e->session_index);
1254 }
1255
1256 always_inline void
1257 session_event_dispatch_ctrl (session_worker_t * wrk, session_evt_elt_t * elt)
1258 {
1259   clib_llist_index_t ei;
1260   void (*fp) (void *);
1261   session_event_t *e;
1262   session_t *s;
1263
1264   ei = clib_llist_entry_index (wrk->event_elts, elt);
1265   e = &elt->evt;
1266
1267   switch (e->event_type)
1268     {
1269     case SESSION_CTRL_EVT_RPC:
1270       fp = e->rpc_args.fp;
1271       (*fp) (e->rpc_args.arg);
1272       break;
1273     case SESSION_CTRL_EVT_CLOSE:
1274       s = session_get_from_handle_if_valid (e->session_handle);
1275       if (PREDICT_FALSE (!s))
1276         break;
1277       session_transport_close (s);
1278       break;
1279     case SESSION_CTRL_EVT_RESET:
1280       s = session_get_from_handle_if_valid (e->session_handle);
1281       if (PREDICT_FALSE (!s))
1282         break;
1283       session_transport_reset (s);
1284       break;
1285     case SESSION_CTRL_EVT_LISTEN:
1286       session_mq_listen_handler (session_evt_ctrl_data (wrk, elt));
1287       break;
1288     case SESSION_CTRL_EVT_LISTEN_URI:
1289       session_mq_listen_uri_handler (session_evt_ctrl_data (wrk, elt));
1290       break;
1291     case SESSION_CTRL_EVT_UNLISTEN:
1292       session_mq_unlisten_handler (session_evt_ctrl_data (wrk, elt));
1293       break;
1294     case SESSION_CTRL_EVT_CONNECT:
1295       session_mq_connect_handler (session_evt_ctrl_data (wrk, elt));
1296       break;
1297     case SESSION_CTRL_EVT_CONNECT_URI:
1298       session_mq_connect_uri_handler (session_evt_ctrl_data (wrk, elt));
1299       break;
1300     case SESSION_CTRL_EVT_DISCONNECT:
1301       session_mq_disconnect_handler (session_evt_ctrl_data (wrk, elt));
1302       break;
1303     case SESSION_CTRL_EVT_DISCONNECTED:
1304       session_mq_disconnected_handler (session_evt_ctrl_data (wrk, elt));
1305       break;
1306     case SESSION_CTRL_EVT_ACCEPTED_REPLY:
1307       session_mq_accepted_reply_handler (session_evt_ctrl_data (wrk, elt));
1308       break;
1309     case SESSION_CTRL_EVT_DISCONNECTED_REPLY:
1310       session_mq_disconnected_reply_handler (session_evt_ctrl_data (wrk,
1311                                                                     elt));
1312       break;
1313     case SESSION_CTRL_EVT_RESET_REPLY:
1314       session_mq_reset_reply_handler (session_evt_ctrl_data (wrk, elt));
1315       break;
1316     case SESSION_CTRL_EVT_WORKER_UPDATE:
1317       session_mq_worker_update_handler (session_evt_ctrl_data (wrk, elt));
1318       break;
1319     case SESSION_CTRL_EVT_APP_DETACH:
1320       app_mq_detach_handler (session_evt_ctrl_data (wrk, elt));
1321       break;
1322     case SESSION_CTRL_EVT_APP_WRK_RPC:
1323       session_mq_app_wrk_rpc_handler (session_evt_ctrl_data (wrk, elt));
1324       break;
1325     case SESSION_CTRL_EVT_TRANSPORT_ATTR:
1326       session_mq_transport_attr_handler (session_evt_ctrl_data (wrk, elt));
1327       break;
1328     default:
1329       clib_warning ("unhandled event type %d", e->event_type);
1330     }
1331
1332   /* Regrab elements in case pool moved */
1333   elt = pool_elt_at_index (wrk->event_elts, ei);
1334   if (!clib_llist_elt_is_linked (elt, evt_list))
1335     {
1336       e = &elt->evt;
1337       if (e->event_type >= SESSION_CTRL_EVT_BOUND)
1338         session_evt_ctrl_data_free (wrk, elt);
1339       session_evt_elt_free (wrk, elt);
1340     }
1341   SESSION_EVT (SESSION_EVT_COUNTS, CNT_CTRL_EVTS, 1, wrk);
1342 }
1343
1344 always_inline void
1345 session_event_dispatch_io (session_worker_t * wrk, vlib_node_runtime_t * node,
1346                            session_evt_elt_t * elt, int *n_tx_packets)
1347 {
1348   session_main_t *smm = &session_main;
1349   app_worker_t *app_wrk;
1350   clib_llist_index_t ei;
1351   session_event_t *e;
1352   session_t *s;
1353
1354   ei = clib_llist_entry_index (wrk->event_elts, elt);
1355   e = &elt->evt;
1356
1357   switch (e->event_type)
1358     {
1359     case SESSION_IO_EVT_TX_FLUSH:
1360     case SESSION_IO_EVT_TX:
1361       s = session_event_get_session (wrk, e);
1362       if (PREDICT_FALSE (!s))
1363         break;
1364       CLIB_PREFETCH (s->tx_fifo, 2 * CLIB_CACHE_LINE_BYTES, LOAD);
1365       wrk->ctx.s = s;
1366       /* Spray packets in per session type frames, since they go to
1367        * different nodes */
1368       (smm->session_tx_fns[s->session_type]) (wrk, node, elt, n_tx_packets);
1369       break;
1370     case SESSION_IO_EVT_RX:
1371       s = session_event_get_session (wrk, e);
1372       if (!s)
1373         break;
1374       transport_app_rx_evt (session_get_transport_proto (s),
1375                             s->connection_index, s->thread_index);
1376       break;
1377     case SESSION_IO_EVT_BUILTIN_RX:
1378       s = session_event_get_session (wrk, e);
1379       if (PREDICT_FALSE (!s || s->session_state >= SESSION_STATE_CLOSING))
1380         break;
1381       svm_fifo_unset_event (s->rx_fifo);
1382       app_wrk = app_worker_get (s->app_wrk_index);
1383       app_worker_builtin_rx (app_wrk, s);
1384       break;
1385     case SESSION_IO_EVT_BUILTIN_TX:
1386       s = session_get_from_handle_if_valid (e->session_handle);
1387       wrk->ctx.s = s;
1388       if (PREDICT_TRUE (s != 0))
1389         session_tx_fifo_dequeue_internal (wrk, node, elt, n_tx_packets);
1390       break;
1391     default:
1392       clib_warning ("unhandled event type %d", e->event_type);
1393     }
1394
1395   SESSION_EVT (SESSION_IO_EVT_COUNTS, e->event_type, 1, wrk);
1396
1397   /* Regrab elements in case pool moved */
1398   elt = pool_elt_at_index (wrk->event_elts, ei);
1399   if (!clib_llist_elt_is_linked (elt, evt_list))
1400     session_evt_elt_free (wrk, elt);
1401 }
1402
1403 /* *INDENT-OFF* */
1404 static const u32 session_evt_msg_sizes[] = {
1405 #define _(symc, sym)                                                    \
1406   [SESSION_CTRL_EVT_ ## symc] = sizeof (session_ ## sym ##_msg_t),
1407   foreach_session_ctrl_evt
1408 #undef _
1409 };
1410 /* *INDENT-ON* */
1411
1412 always_inline void
1413 session_evt_add_to_list (session_worker_t * wrk, session_event_t * evt)
1414 {
1415   session_evt_elt_t *elt;
1416
1417   if (evt->event_type >= SESSION_CTRL_EVT_RPC)
1418     {
1419       elt = session_evt_alloc_ctrl (wrk);
1420       if (evt->event_type >= SESSION_CTRL_EVT_BOUND)
1421         {
1422           elt->evt.ctrl_data_index = session_evt_ctrl_data_alloc (wrk);
1423           elt->evt.event_type = evt->event_type;
1424           clib_memcpy_fast (session_evt_ctrl_data (wrk, elt), evt->data,
1425                             session_evt_msg_sizes[evt->event_type]);
1426         }
1427       else
1428         {
1429           /* Internal control events fit into io events footprint */
1430           clib_memcpy_fast (&elt->evt, evt, sizeof (elt->evt));
1431         }
1432     }
1433   else
1434     {
1435       elt = session_evt_alloc_new (wrk);
1436       clib_memcpy_fast (&elt->evt, evt, sizeof (elt->evt));
1437     }
1438 }
1439
1440 static void
1441 session_flush_pending_tx_buffers (session_worker_t * wrk,
1442                                   vlib_node_runtime_t * node)
1443 {
1444   vlib_buffer_enqueue_to_next (wrk->vm, node, wrk->pending_tx_buffers,
1445                                wrk->pending_tx_nexts,
1446                                vec_len (wrk->pending_tx_nexts));
1447   vec_reset_length (wrk->pending_tx_buffers);
1448   vec_reset_length (wrk->pending_tx_nexts);
1449 }
1450
1451 int
1452 session_wrk_handle_mq (session_worker_t *wrk, svm_msg_q_t *mq)
1453 {
1454   svm_msg_q_msg_t _msg, *msg = &_msg;
1455   u32 i, n_to_dequeue = 0;
1456   session_event_t *evt;
1457
1458   n_to_dequeue = svm_msg_q_size (mq);
1459   for (i = 0; i < n_to_dequeue; i++)
1460     {
1461       svm_msg_q_sub_raw (mq, msg);
1462       evt = svm_msg_q_msg_data (mq, msg);
1463       session_evt_add_to_list (wrk, evt);
1464       svm_msg_q_free_msg (mq, msg);
1465     }
1466
1467   return n_to_dequeue;
1468 }
1469
1470 static void
1471 session_wrk_timerfd_update (session_worker_t *wrk, u64 time_ns)
1472 {
1473   struct itimerspec its;
1474
1475   its.it_value.tv_sec = 0;
1476   its.it_value.tv_nsec = time_ns;
1477   its.it_interval.tv_sec = 0;
1478   its.it_interval.tv_nsec = its.it_value.tv_nsec;
1479
1480   if (timerfd_settime (wrk->timerfd, 0, &its, NULL) == -1)
1481     clib_warning ("timerfd_settime");
1482 }
1483
1484 always_inline u64
1485 session_wrk_tfd_timeout (session_wrk_state_t state, u32 thread_index)
1486 {
1487   if (state == SESSION_WRK_INTERRUPT)
1488     return thread_index ? 1e6 : vlib_num_workers () ? 5e8 : 1e6;
1489   else if (state == SESSION_WRK_IDLE)
1490     return thread_index ? 1e8 : vlib_num_workers () ? 5e8 : 1e8;
1491   else
1492     return 0;
1493 }
1494
1495 static inline void
1496 session_wrk_set_state (session_worker_t *wrk, session_wrk_state_t state)
1497 {
1498   u64 time_ns;
1499
1500   wrk->state = state;
1501   time_ns = session_wrk_tfd_timeout (state, wrk->vm->thread_index);
1502   session_wrk_timerfd_update (wrk, time_ns);
1503 }
1504
1505 static void
1506 session_wrk_update_state (session_worker_t *wrk)
1507 {
1508   vlib_main_t *vm = wrk->vm;
1509
1510   if (wrk->state == SESSION_WRK_POLLING)
1511     {
1512       if (pool_elts (wrk->event_elts) == 3 &&
1513           vlib_last_vectors_per_main_loop (vm) < 1)
1514         {
1515           session_wrk_set_state (wrk, SESSION_WRK_INTERRUPT);
1516           vlib_node_set_state (vm, session_queue_node.index,
1517                                VLIB_NODE_STATE_INTERRUPT);
1518         }
1519     }
1520   else if (wrk->state == SESSION_WRK_INTERRUPT)
1521     {
1522       if (pool_elts (wrk->event_elts) > 3 ||
1523           vlib_last_vectors_per_main_loop (vm) > 1)
1524         {
1525           session_wrk_set_state (wrk, SESSION_WRK_POLLING);
1526           vlib_node_set_state (vm, session_queue_node.index,
1527                                VLIB_NODE_STATE_POLLING);
1528         }
1529       else if (PREDICT_FALSE (!pool_elts (wrk->sessions)))
1530         {
1531           session_wrk_set_state (wrk, SESSION_WRK_IDLE);
1532         }
1533     }
1534   else
1535     {
1536       if (pool_elts (wrk->event_elts))
1537         {
1538           session_wrk_set_state (wrk, SESSION_WRK_INTERRUPT);
1539         }
1540     }
1541 }
1542
1543 static uword
1544 session_queue_node_fn (vlib_main_t * vm, vlib_node_runtime_t * node,
1545                        vlib_frame_t * frame)
1546 {
1547   u32 thread_index = vm->thread_index, __clib_unused n_evts;
1548   session_evt_elt_t *elt, *ctrl_he, *new_he, *old_he;
1549   session_main_t *smm = vnet_get_session_main ();
1550   session_worker_t *wrk = &smm->wrk[thread_index];
1551   clib_llist_index_t ei, next_ei, old_ti;
1552   int n_tx_packets;
1553
1554   SESSION_EVT (SESSION_EVT_DISPATCH_START, wrk);
1555
1556   session_wrk_update_time (wrk, vlib_time_now (vm));
1557
1558   /*
1559    *  Update transport time
1560    */
1561   transport_update_time (wrk->last_vlib_time, thread_index);
1562   n_tx_packets = vec_len (wrk->pending_tx_buffers);
1563   SESSION_EVT (SESSION_EVT_DSP_CNTRS, UPDATE_TIME, wrk);
1564
1565   /*
1566    *  Dequeue new internal mq events
1567    */
1568
1569   n_evts = session_wrk_handle_mq (wrk, wrk->vpp_event_queue);
1570   SESSION_EVT (SESSION_EVT_DSP_CNTRS, MQ_DEQ, wrk, n_evts);
1571
1572   /*
1573    * Handle control events
1574    */
1575
1576   ctrl_he = pool_elt_at_index (wrk->event_elts, wrk->ctrl_head);
1577
1578   clib_llist_foreach_safe (wrk->event_elts, evt_list, ctrl_he, elt, ({
1579     clib_llist_remove (wrk->event_elts, evt_list, elt);
1580     session_event_dispatch_ctrl (wrk, elt);
1581   }));
1582
1583   SESSION_EVT (SESSION_EVT_DSP_CNTRS, CTRL_EVTS, wrk);
1584
1585   /*
1586    * Handle the new io events.
1587    */
1588
1589   new_he = pool_elt_at_index (wrk->event_elts, wrk->new_head);
1590   old_he = pool_elt_at_index (wrk->event_elts, wrk->old_head);
1591   old_ti = clib_llist_prev_index (old_he, evt_list);
1592
1593   ei = clib_llist_next_index (new_he, evt_list);
1594   while (ei != wrk->new_head && n_tx_packets < SESSION_NODE_FRAME_SIZE)
1595     {
1596       elt = pool_elt_at_index (wrk->event_elts, ei);
1597       ei = clib_llist_next_index (elt, evt_list);
1598       clib_llist_remove (wrk->event_elts, evt_list, elt);
1599       session_event_dispatch_io (wrk, node, elt, &n_tx_packets);
1600     }
1601
1602   SESSION_EVT (SESSION_EVT_DSP_CNTRS, NEW_IO_EVTS, wrk);
1603
1604   /*
1605    * Handle the old io events, if we had any prior to processing the new ones
1606    */
1607
1608   if (old_ti != wrk->old_head)
1609     {
1610       old_he = pool_elt_at_index (wrk->event_elts, wrk->old_head);
1611       ei = clib_llist_next_index (old_he, evt_list);
1612
1613       while (n_tx_packets < SESSION_NODE_FRAME_SIZE)
1614         {
1615           elt = pool_elt_at_index (wrk->event_elts, ei);
1616           next_ei = clib_llist_next_index (elt, evt_list);
1617           clib_llist_remove (wrk->event_elts, evt_list, elt);
1618
1619           session_event_dispatch_io (wrk, node, elt, &n_tx_packets);
1620
1621           if (ei == old_ti)
1622             break;
1623
1624           ei = next_ei;
1625         };
1626     }
1627
1628   SESSION_EVT (SESSION_EVT_DSP_CNTRS, OLD_IO_EVTS, wrk);
1629
1630   if (vec_len (wrk->pending_tx_buffers))
1631     session_flush_pending_tx_buffers (wrk, node);
1632
1633   vlib_node_increment_counter (vm, session_queue_node.index,
1634                                SESSION_QUEUE_ERROR_TX, n_tx_packets);
1635
1636   SESSION_EVT (SESSION_EVT_DISPATCH_END, wrk, n_tx_packets);
1637
1638   if (wrk->flags & SESSION_WRK_F_ADAPTIVE)
1639     session_wrk_update_state (wrk);
1640
1641   return n_tx_packets;
1642 }
1643
1644 /* *INDENT-OFF* */
1645 VLIB_REGISTER_NODE (session_queue_node) =
1646 {
1647   .function = session_queue_node_fn,
1648   .flags = VLIB_NODE_FLAG_TRACE_SUPPORTED,
1649   .name = "session-queue",
1650   .format_trace = format_session_queue_trace,
1651   .type = VLIB_NODE_TYPE_INPUT,
1652   .n_errors = ARRAY_LEN (session_queue_error_strings),
1653   .error_strings = session_queue_error_strings,
1654   .state = VLIB_NODE_STATE_DISABLED,
1655 };
1656 /* *INDENT-ON* */
1657
1658 static clib_error_t *
1659 session_wrk_tfd_read_ready (clib_file_t *cf)
1660 {
1661   session_worker_t *wrk = session_main_get_worker (cf->private_data);
1662   u64 buf;
1663   int rv;
1664
1665   vlib_node_set_interrupt_pending (wrk->vm, session_queue_node.index);
1666   rv = read (wrk->timerfd, &buf, sizeof (buf));
1667   if (rv < 0 && errno != EAGAIN)
1668     clib_unix_warning ("failed");
1669   return 0;
1670 }
1671
1672 static clib_error_t *
1673 session_wrk_tfd_write_ready (clib_file_t *cf)
1674 {
1675   return 0;
1676 }
1677
1678 void
1679 session_wrk_enable_adaptive_mode (session_worker_t *wrk)
1680 {
1681   u32 thread_index = wrk->vm->thread_index;
1682   clib_file_t template = { 0 };
1683
1684   if ((wrk->timerfd = timerfd_create (CLOCK_MONOTONIC, TFD_NONBLOCK)) < 0)
1685     clib_warning ("timerfd_create");
1686
1687   template.read_function = session_wrk_tfd_read_ready;
1688   template.write_function = session_wrk_tfd_write_ready;
1689   template.file_descriptor = wrk->timerfd;
1690   template.private_data = thread_index;
1691   template.polling_thread_index = thread_index;
1692   template.description = format (0, "session-wrk-tfd-%u", thread_index);
1693
1694   wrk->timerfd_file = clib_file_add (&file_main, &template);
1695   wrk->flags |= SESSION_WRK_F_ADAPTIVE;
1696 }
1697
1698 static clib_error_t *
1699 session_queue_exit (vlib_main_t * vm)
1700 {
1701   if (vlib_get_n_threads () < 2)
1702     return 0;
1703
1704   /*
1705    * Shut off (especially) worker-thread session nodes.
1706    * Otherwise, vpp can crash as the main thread unmaps the
1707    * API segment.
1708    */
1709   vlib_worker_thread_barrier_sync (vm);
1710   session_node_enable_disable (0 /* is_enable */ );
1711   vlib_worker_thread_barrier_release (vm);
1712   return 0;
1713 }
1714
1715 VLIB_MAIN_LOOP_EXIT_FUNCTION (session_queue_exit);
1716
1717 static uword
1718 session_queue_run_on_main (vlib_main_t * vm)
1719 {
1720   vlib_node_runtime_t *node;
1721
1722   node = vlib_node_get_runtime (vm, session_queue_node.index);
1723   return session_queue_node_fn (vm, node, 0);
1724 }
1725
1726 static uword
1727 session_queue_process (vlib_main_t * vm, vlib_node_runtime_t * rt,
1728                        vlib_frame_t * f)
1729 {
1730   uword *event_data = 0;
1731   f64 timeout = 1.0;
1732   uword event_type;
1733
1734   while (1)
1735     {
1736       vlib_process_wait_for_event_or_clock (vm, timeout);
1737       event_type = vlib_process_get_events (vm, (uword **) & event_data);
1738
1739       switch (event_type)
1740         {
1741         case SESSION_Q_PROCESS_RUN_ON_MAIN:
1742           /* Run session queue node on main thread */
1743           session_queue_run_on_main (vm);
1744           break;
1745         case SESSION_Q_PROCESS_STOP:
1746           vlib_node_set_state (vm, session_queue_process_node.index,
1747                                VLIB_NODE_STATE_DISABLED);
1748           timeout = 100000.0;
1749           break;
1750         case ~0:
1751           /* Timed out. Run on main to ensure all events are handled */
1752           session_queue_run_on_main (vm);
1753           break;
1754         }
1755       vec_reset_length (event_data);
1756     }
1757   return 0;
1758 }
1759
1760 /* *INDENT-OFF* */
1761 VLIB_REGISTER_NODE (session_queue_process_node) =
1762 {
1763   .function = session_queue_process,
1764   .type = VLIB_NODE_TYPE_PROCESS,
1765   .name = "session-queue-process",
1766   .state = VLIB_NODE_STATE_DISABLED,
1767 };
1768 /* *INDENT-ON* */
1769
1770 static_always_inline uword
1771 session_queue_pre_input_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
1772                                 vlib_frame_t * frame)
1773 {
1774   session_main_t *sm = &session_main;
1775   if (!sm->wrk[0].vpp_event_queue)
1776     return 0;
1777   node = vlib_node_get_runtime (vm, session_queue_node.index);
1778   return session_queue_node_fn (vm, node, frame);
1779 }
1780
1781 /* *INDENT-OFF* */
1782 VLIB_REGISTER_NODE (session_queue_pre_input_node) =
1783 {
1784   .function = session_queue_pre_input_inline,
1785   .type = VLIB_NODE_TYPE_PRE_INPUT,
1786   .name = "session-queue-main",
1787   .state = VLIB_NODE_STATE_DISABLED,
1788 };
1789 /* *INDENT-ON* */
1790
1791 /*
1792  * fd.io coding-style-patch-verification: ON
1793  *
1794  * Local Variables:
1795  * eval: (c-set-style "gnu")
1796  * End:
1797  */