vcl/session: tx notifications for cut-thru sessions
[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
28 static void session_mq_accepted_reply_handler (void *data);
29
30 static void
31 accepted_notify_cb (void *data, u32 data_len)
32 {
33   session_mq_accepted_reply_handler (data);
34 }
35
36 static void
37 session_mq_accepted_reply_handler (void *data)
38 {
39   session_accepted_reply_msg_t *mp = (session_accepted_reply_msg_t *) data;
40   vnet_disconnect_args_t _a = { 0 }, *a = &_a;
41   session_state_t old_state;
42   app_worker_t *app_wrk;
43   session_t *s;
44
45   /* Server isn't interested, kill the session */
46   if (mp->retval)
47     {
48       a->app_index = mp->context;
49       a->handle = mp->handle;
50       vnet_disconnect_session (a);
51       return;
52     }
53
54   /* Mail this back from the main thread. We're not polling in main
55    * thread so we're using other workers for notifications. */
56   if (vlib_num_workers () && vlib_get_thread_index () != 0
57       && session_thread_from_handle (mp->handle) == 0)
58     {
59       vl_api_rpc_call_main_thread (accepted_notify_cb, data,
60                                    sizeof (session_accepted_reply_msg_t));
61       return;
62     }
63
64   s = session_get_from_handle_if_valid (mp->handle);
65   if (!s)
66     return;
67
68   app_wrk = app_worker_get (s->app_wrk_index);
69   if (app_wrk->app_index != mp->context)
70     {
71       clib_warning ("app doesn't own session");
72       return;
73     }
74
75   if (!session_has_transport (s))
76     {
77       s->session_state = SESSION_STATE_READY;
78       if (ct_session_connect_notify (s))
79         return;
80     }
81   else
82     {
83       old_state = s->session_state;
84       s->session_state = SESSION_STATE_READY;
85
86       if (!svm_fifo_is_empty_prod (s->rx_fifo))
87         app_worker_lock_and_send_event (app_wrk, s, SESSION_IO_EVT_RX);
88
89       /* Closed while waiting for app to reply. Resend disconnect */
90       if (old_state >= SESSION_STATE_TRANSPORT_CLOSING)
91         {
92           app_worker_close_notify (app_wrk, s);
93           s->session_state = old_state;
94           return;
95         }
96     }
97 }
98
99 static void
100 session_mq_reset_reply_handler (void *data)
101 {
102   vnet_disconnect_args_t _a = { 0 }, *a = &_a;
103   session_reset_reply_msg_t *mp;
104   app_worker_t *app_wrk;
105   session_t *s;
106   application_t *app;
107   u32 index, thread_index;
108
109   mp = (session_reset_reply_msg_t *) data;
110   app = application_lookup (mp->context);
111   if (!app)
112     return;
113
114   session_parse_handle (mp->handle, &index, &thread_index);
115   s = session_get_if_valid (index, thread_index);
116
117   /* Session was already closed or already cleaned up */
118   if (!s || s->session_state != SESSION_STATE_TRANSPORT_CLOSING)
119     return;
120
121   app_wrk = app_worker_get (s->app_wrk_index);
122   if (!app_wrk || app_wrk->app_index != app->app_index)
123     {
124       clib_warning ("App % does not own handle 0x%lx!", app->app_index,
125                     mp->handle);
126       return;
127     }
128
129   /* Client objected to resetting the session, log and continue */
130   if (mp->retval)
131     {
132       clib_warning ("client retval %d", mp->retval);
133       return;
134     }
135
136   /* This comes as a response to a reset, transport only waiting for
137    * confirmation to remove connection state, no need to disconnect */
138   a->handle = mp->handle;
139   a->app_index = app->app_index;
140   vnet_disconnect_session (a);
141 }
142
143 static void
144 session_mq_disconnected_handler (void *data)
145 {
146   session_disconnected_reply_msg_t *rmp;
147   vnet_disconnect_args_t _a, *a = &_a;
148   svm_msg_q_msg_t _msg, *msg = &_msg;
149   session_disconnected_msg_t *mp;
150   app_worker_t *app_wrk;
151   session_event_t *evt;
152   session_t *s;
153   application_t *app;
154   int rv = 0;
155
156   mp = (session_disconnected_msg_t *) data;
157   if (!(s = session_get_from_handle_if_valid (mp->handle)))
158     {
159       clib_warning ("could not disconnect handle %llu", mp->handle);
160       return;
161     }
162   app_wrk = app_worker_get (s->app_wrk_index);
163   app = application_lookup (mp->client_index);
164   if (!(app_wrk && app && app->app_index == app_wrk->app_index))
165     {
166       clib_warning ("could not disconnect session: %llu app: %u",
167                     mp->handle, mp->client_index);
168       return;
169     }
170
171   a->handle = mp->handle;
172   a->app_index = app_wrk->wrk_index;
173   rv = vnet_disconnect_session (a);
174
175   svm_msg_q_lock_and_alloc_msg_w_ring (app_wrk->event_queue,
176                                        SESSION_MQ_CTRL_EVT_RING,
177                                        SVM_Q_WAIT, msg);
178   svm_msg_q_unlock (app_wrk->event_queue);
179   evt = svm_msg_q_msg_data (app_wrk->event_queue, msg);
180   clib_memset (evt, 0, sizeof (*evt));
181   evt->event_type = SESSION_CTRL_EVT_DISCONNECTED_REPLY;
182   rmp = (session_disconnected_reply_msg_t *) evt->data;
183   rmp->handle = mp->handle;
184   rmp->context = mp->context;
185   rmp->retval = rv;
186   svm_msg_q_add (app_wrk->event_queue, msg, SVM_Q_WAIT);
187 }
188
189 static void
190 session_mq_disconnected_reply_handler (void *data)
191 {
192   session_disconnected_reply_msg_t *mp;
193   vnet_disconnect_args_t _a, *a = &_a;
194   application_t *app;
195
196   mp = (session_disconnected_reply_msg_t *) data;
197
198   /* Client objected to disconnecting the session, log and continue */
199   if (mp->retval)
200     {
201       clib_warning ("client retval %d", mp->retval);
202       return;
203     }
204
205   /* Disconnect has been confirmed. Confirm close to transport */
206   app = application_lookup (mp->context);
207   if (app)
208     {
209       a->handle = mp->handle;
210       a->app_index = app->app_index;
211       vnet_disconnect_session (a);
212     }
213 }
214
215 static void
216 session_mq_worker_update_handler (void *data)
217 {
218   session_worker_update_msg_t *mp = (session_worker_update_msg_t *) data;
219   session_worker_update_reply_msg_t *rmp;
220   svm_msg_q_msg_t _msg, *msg = &_msg;
221   app_worker_t *app_wrk;
222   u32 owner_app_wrk_map;
223   session_event_t *evt;
224   session_t *s;
225   application_t *app;
226
227   app = application_lookup (mp->client_index);
228   if (!app)
229     return;
230   if (!(s = session_get_from_handle_if_valid (mp->handle)))
231     {
232       clib_warning ("invalid handle %llu", mp->handle);
233       return;
234     }
235   app_wrk = app_worker_get (s->app_wrk_index);
236   if (app_wrk->app_index != app->app_index)
237     {
238       clib_warning ("app %u does not own session %llu", app->app_index,
239                     mp->handle);
240       return;
241     }
242   owner_app_wrk_map = app_wrk->wrk_map_index;
243   app_wrk = application_get_worker (app, mp->wrk_index);
244
245   /* This needs to come from the new owner */
246   if (mp->req_wrk_index == owner_app_wrk_map)
247     {
248       session_req_worker_update_msg_t *wump;
249
250       svm_msg_q_lock_and_alloc_msg_w_ring (app_wrk->event_queue,
251                                            SESSION_MQ_CTRL_EVT_RING,
252                                            SVM_Q_WAIT, msg);
253       svm_msg_q_unlock (app_wrk->event_queue);
254       evt = svm_msg_q_msg_data (app_wrk->event_queue, msg);
255       clib_memset (evt, 0, sizeof (*evt));
256       evt->event_type = SESSION_CTRL_EVT_REQ_WORKER_UPDATE;
257       wump = (session_req_worker_update_msg_t *) evt->data;
258       wump->session_handle = mp->handle;
259       svm_msg_q_add (app_wrk->event_queue, msg, SVM_Q_WAIT);
260       return;
261     }
262
263   app_worker_own_session (app_wrk, s);
264
265   /*
266    * Send reply
267    */
268   svm_msg_q_lock_and_alloc_msg_w_ring (app_wrk->event_queue,
269                                        SESSION_MQ_CTRL_EVT_RING,
270                                        SVM_Q_WAIT, msg);
271   svm_msg_q_unlock (app_wrk->event_queue);
272   evt = svm_msg_q_msg_data (app_wrk->event_queue, msg);
273   clib_memset (evt, 0, sizeof (*evt));
274   evt->event_type = SESSION_CTRL_EVT_WORKER_UPDATE_REPLY;
275   rmp = (session_worker_update_reply_msg_t *) evt->data;
276   rmp->handle = mp->handle;
277   rmp->rx_fifo = pointer_to_uword (s->rx_fifo);
278   rmp->tx_fifo = pointer_to_uword (s->tx_fifo);
279   rmp->segment_handle = session_segment_handle (s);
280   svm_msg_q_add (app_wrk->event_queue, msg, SVM_Q_WAIT);
281
282   /*
283    * Retransmit messages that may have been lost
284    */
285   if (s->tx_fifo && !svm_fifo_is_empty (s->tx_fifo))
286     session_send_io_evt_to_thread (s->tx_fifo, SESSION_IO_EVT_TX);
287
288   if (s->rx_fifo && !svm_fifo_is_empty (s->rx_fifo))
289     app_worker_lock_and_send_event (app_wrk, s, SESSION_IO_EVT_RX);
290
291   if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
292     app_worker_close_notify (app_wrk, s);
293 }
294
295 vlib_node_registration_t session_queue_node;
296
297 typedef struct
298 {
299   u32 session_index;
300   u32 server_thread_index;
301 } session_queue_trace_t;
302
303 /* packet trace format function */
304 static u8 *
305 format_session_queue_trace (u8 * s, va_list * args)
306 {
307   CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
308   CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
309   session_queue_trace_t *t = va_arg (*args, session_queue_trace_t *);
310
311   s = format (s, "SESSION_QUEUE: session index %d, server thread index %d",
312               t->session_index, t->server_thread_index);
313   return s;
314 }
315
316 #define foreach_session_queue_error             \
317 _(TX, "Packets transmitted")                    \
318 _(TIMER, "Timer events")                        \
319 _(NO_BUFFER, "Out of buffers")
320
321 typedef enum
322 {
323 #define _(sym,str) SESSION_QUEUE_ERROR_##sym,
324   foreach_session_queue_error
325 #undef _
326     SESSION_QUEUE_N_ERROR,
327 } session_queue_error_t;
328
329 static char *session_queue_error_strings[] = {
330 #define _(sym,string) string,
331   foreach_session_queue_error
332 #undef _
333 };
334
335 enum
336 {
337   SESSION_TX_NO_BUFFERS = -2,
338   SESSION_TX_NO_DATA,
339   SESSION_TX_OK
340 };
341
342 static void
343 session_tx_trace_frame (vlib_main_t * vm, vlib_node_runtime_t * node,
344                         u32 next_index, u32 * to_next, u16 n_segs,
345                         session_t * s, u32 n_trace)
346 {
347   session_queue_trace_t *t;
348   vlib_buffer_t *b;
349   int i;
350
351   for (i = 0; i < clib_min (n_trace, n_segs); i++)
352     {
353       b = vlib_get_buffer (vm, to_next[i - n_segs]);
354       vlib_trace_buffer (vm, node, next_index, b, 1 /* follow_chain */ );
355       t = vlib_add_trace (vm, node, b, sizeof (*t));
356       t->session_index = s->session_index;
357       t->server_thread_index = s->thread_index;
358     }
359   vlib_set_trace_count (vm, node, n_trace - i);
360 }
361
362 always_inline void
363 session_tx_fifo_chain_tail (vlib_main_t * vm, session_tx_context_t * ctx,
364                             vlib_buffer_t * b, u16 * n_bufs, u8 peek_data)
365 {
366   vlib_buffer_t *chain_b, *prev_b;
367   u32 chain_bi0, to_deq, left_from_seg;
368   session_worker_t *wrk;
369   u16 len_to_deq, n_bytes_read;
370   u8 *data, j;
371
372   wrk = session_main_get_worker (ctx->s->thread_index);
373   b->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
374   b->total_length_not_including_first_buffer = 0;
375
376   chain_b = b;
377   left_from_seg = clib_min (ctx->snd_mss - b->current_length,
378                             ctx->left_to_snd);
379   to_deq = left_from_seg;
380   for (j = 1; j < ctx->n_bufs_per_seg; j++)
381     {
382       prev_b = chain_b;
383       len_to_deq = clib_min (to_deq, ctx->deq_per_buf);
384
385       *n_bufs -= 1;
386       chain_bi0 = wrk->tx_buffers[*n_bufs];
387       chain_b = vlib_get_buffer (vm, chain_bi0);
388       chain_b->current_data = 0;
389       data = vlib_buffer_get_current (chain_b);
390       if (peek_data)
391         {
392           n_bytes_read = svm_fifo_peek (ctx->s->tx_fifo,
393                                         ctx->tx_offset, len_to_deq, data);
394           ctx->tx_offset += n_bytes_read;
395         }
396       else
397         {
398           if (ctx->transport_vft->tx_type == TRANSPORT_TX_DGRAM)
399             {
400               svm_fifo_t *f = ctx->s->tx_fifo;
401               session_dgram_hdr_t *hdr = &ctx->hdr;
402               u16 deq_now;
403               deq_now = clib_min (hdr->data_length - hdr->data_offset,
404                                   len_to_deq);
405               n_bytes_read = svm_fifo_peek (f, hdr->data_offset, deq_now,
406                                             data);
407               ASSERT (n_bytes_read > 0);
408
409               hdr->data_offset += n_bytes_read;
410               if (hdr->data_offset == hdr->data_length)
411                 {
412                   u32 offset = hdr->data_length + SESSION_CONN_HDR_LEN;
413                   svm_fifo_dequeue_drop (f, offset);
414                 }
415             }
416           else
417             n_bytes_read = svm_fifo_dequeue_nowait (ctx->s->tx_fifo,
418                                                     len_to_deq, data);
419         }
420       ASSERT (n_bytes_read == len_to_deq);
421       chain_b->current_length = n_bytes_read;
422       b->total_length_not_including_first_buffer += chain_b->current_length;
423
424       /* update previous buffer */
425       prev_b->next_buffer = chain_bi0;
426       prev_b->flags |= VLIB_BUFFER_NEXT_PRESENT;
427
428       /* update current buffer */
429       chain_b->next_buffer = 0;
430
431       to_deq -= n_bytes_read;
432       if (to_deq == 0)
433         break;
434     }
435   ASSERT (to_deq == 0
436           && b->total_length_not_including_first_buffer == left_from_seg);
437   ctx->left_to_snd -= left_from_seg;
438 }
439
440 always_inline void
441 session_tx_fill_buffer (vlib_main_t * vm, session_tx_context_t * ctx,
442                         vlib_buffer_t * b, u16 * n_bufs, u8 peek_data)
443 {
444   u32 len_to_deq;
445   u8 *data0;
446   int n_bytes_read;
447
448   /*
449    * Start with the first buffer in chain
450    */
451   b->error = 0;
452   b->flags = VNET_BUFFER_F_LOCALLY_ORIGINATED;
453   b->current_data = 0;
454
455   data0 = vlib_buffer_make_headroom (b, TRANSPORT_MAX_HDRS_LEN);
456   len_to_deq = clib_min (ctx->left_to_snd, ctx->deq_per_first_buf);
457
458   if (peek_data)
459     {
460       n_bytes_read = svm_fifo_peek (ctx->s->tx_fifo, ctx->tx_offset,
461                                     len_to_deq, data0);
462       ASSERT (n_bytes_read > 0);
463       /* Keep track of progress locally, transport is also supposed to
464        * increment it independently when pushing the header */
465       ctx->tx_offset += n_bytes_read;
466     }
467   else
468     {
469       if (ctx->transport_vft->tx_type == TRANSPORT_TX_DGRAM)
470         {
471           session_dgram_hdr_t *hdr = &ctx->hdr;
472           svm_fifo_t *f = ctx->s->tx_fifo;
473           u16 deq_now;
474           u32 offset;
475
476           ASSERT (hdr->data_length > hdr->data_offset);
477           deq_now = clib_min (hdr->data_length - hdr->data_offset,
478                               len_to_deq);
479           offset = hdr->data_offset + SESSION_CONN_HDR_LEN;
480           n_bytes_read = svm_fifo_peek (f, offset, deq_now, data0);
481           ASSERT (n_bytes_read > 0);
482
483           if (ctx->s->session_state == SESSION_STATE_LISTENING)
484             {
485               ip_copy (&ctx->tc->rmt_ip, &hdr->rmt_ip, ctx->tc->is_ip4);
486               ctx->tc->rmt_port = hdr->rmt_port;
487             }
488           hdr->data_offset += n_bytes_read;
489           if (hdr->data_offset == hdr->data_length)
490             {
491               offset = hdr->data_length + SESSION_CONN_HDR_LEN;
492               svm_fifo_dequeue_drop (f, offset);
493             }
494         }
495       else
496         {
497           n_bytes_read = svm_fifo_dequeue_nowait (ctx->s->tx_fifo,
498                                                   len_to_deq, data0);
499           ASSERT (n_bytes_read > 0);
500         }
501     }
502   b->current_length = n_bytes_read;
503   ctx->left_to_snd -= n_bytes_read;
504
505   /*
506    * Fill in the remaining buffers in the chain, if any
507    */
508   if (PREDICT_FALSE (ctx->n_bufs_per_seg > 1 && ctx->left_to_snd))
509     session_tx_fifo_chain_tail (vm, ctx, b, n_bufs, peek_data);
510
511   /* *INDENT-OFF* */
512   SESSION_EVT_DBG(SESSION_EVT_DEQ, ctx->s, ({
513         ed->data[0] = SESSION_IO_EVT_TX;
514         ed->data[1] = ctx->max_dequeue;
515         ed->data[2] = len_to_deq;
516         ed->data[3] = ctx->left_to_snd;
517   }));
518   /* *INDENT-ON* */
519 }
520
521 always_inline u8
522 session_tx_not_ready (session_t * s, u8 peek_data)
523 {
524   if (peek_data)
525     {
526       /* Can retransmit for closed sessions but can't send new data if
527        * session is not ready or closed */
528       if (s->session_state < SESSION_STATE_READY)
529         return 1;
530       if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSED)
531         return 2;
532     }
533   return 0;
534 }
535
536 always_inline transport_connection_t *
537 session_tx_get_transport (session_tx_context_t * ctx, u8 peek_data)
538 {
539   if (peek_data)
540     {
541       return ctx->transport_vft->get_connection (ctx->s->connection_index,
542                                                  ctx->s->thread_index);
543     }
544   else
545     {
546       if (ctx->s->session_state == SESSION_STATE_LISTENING)
547         return ctx->transport_vft->get_listener (ctx->s->connection_index);
548       else
549         {
550           return ctx->transport_vft->get_connection (ctx->s->connection_index,
551                                                      ctx->s->thread_index);
552         }
553     }
554 }
555
556 always_inline void
557 session_tx_set_dequeue_params (vlib_main_t * vm, session_tx_context_t * ctx,
558                                u32 max_segs, u8 peek_data)
559 {
560   u32 n_bytes_per_buf, n_bytes_per_seg;
561   ctx->max_dequeue = svm_fifo_max_dequeue_cons (ctx->s->tx_fifo);
562   if (peek_data)
563     {
564       /* Offset in rx fifo from where to peek data */
565       ctx->tx_offset = ctx->transport_vft->tx_fifo_offset (ctx->tc);
566       if (PREDICT_FALSE (ctx->tx_offset >= ctx->max_dequeue))
567         {
568           ctx->max_len_to_snd = 0;
569           return;
570         }
571       ctx->max_dequeue -= ctx->tx_offset;
572     }
573   else
574     {
575       if (ctx->transport_vft->tx_type == TRANSPORT_TX_DGRAM)
576         {
577           if (ctx->max_dequeue <= sizeof (ctx->hdr))
578             {
579               ctx->max_len_to_snd = 0;
580               return;
581             }
582           svm_fifo_peek (ctx->s->tx_fifo, 0, sizeof (ctx->hdr),
583                          (u8 *) & ctx->hdr);
584           ASSERT (ctx->hdr.data_length > ctx->hdr.data_offset);
585           ctx->max_dequeue = ctx->hdr.data_length - ctx->hdr.data_offset;
586         }
587     }
588   ASSERT (ctx->max_dequeue > 0);
589
590   /* Ensure we're not writing more than transport window allows */
591   if (ctx->max_dequeue < ctx->snd_space)
592     {
593       /* Constrained by tx queue. Try to send only fully formed segments */
594       ctx->max_len_to_snd =
595         (ctx->max_dequeue > ctx->snd_mss) ?
596         ctx->max_dequeue - ctx->max_dequeue % ctx->snd_mss : ctx->max_dequeue;
597       /* TODO Nagle ? */
598     }
599   else
600     {
601       /* Expectation is that snd_space0 is already a multiple of snd_mss */
602       ctx->max_len_to_snd = ctx->snd_space;
603     }
604
605   /* Check if we're tx constrained by the node */
606   ctx->n_segs_per_evt = ceil ((f64) ctx->max_len_to_snd / ctx->snd_mss);
607   if (ctx->n_segs_per_evt > max_segs)
608     {
609       ctx->n_segs_per_evt = max_segs;
610       ctx->max_len_to_snd = max_segs * ctx->snd_mss;
611     }
612
613   n_bytes_per_buf = vlib_buffer_get_default_data_size (vm);
614   ASSERT (n_bytes_per_buf > TRANSPORT_MAX_HDRS_LEN);
615   n_bytes_per_seg = TRANSPORT_MAX_HDRS_LEN + ctx->snd_mss;
616   ctx->n_bufs_per_seg = ceil ((f64) n_bytes_per_seg / n_bytes_per_buf);
617   ctx->deq_per_buf = clib_min (ctx->snd_mss, n_bytes_per_buf);
618   ctx->deq_per_first_buf = clib_min (ctx->snd_mss,
619                                      n_bytes_per_buf -
620                                      TRANSPORT_MAX_HDRS_LEN);
621 }
622
623 always_inline int
624 session_tx_fifo_read_and_snd_i (vlib_main_t * vm, vlib_node_runtime_t * node,
625                                 session_worker_t * wrk,
626                                 session_event_t * e, int *n_tx_packets,
627                                 u8 peek_data)
628 {
629   u32 next_index, next0, next1, *to_next, n_left_to_next, n_left, pbi;
630   u32 n_trace = vlib_get_trace_count (vm, node), n_bufs_needed = 0;
631   session_main_t *smm = &session_main;
632   session_tx_context_t *ctx = &wrk->ctx;
633   transport_proto_t tp;
634   vlib_buffer_t *pb;
635   u16 n_bufs, rv;
636
637   if (PREDICT_FALSE ((rv = session_tx_not_ready (ctx->s, peek_data))))
638     {
639       if (rv < 2)
640         vec_add1 (wrk->pending_event_vector, *e);
641       return SESSION_TX_NO_DATA;
642     }
643
644   next_index = smm->session_type_to_next[ctx->s->session_type];
645   next0 = next1 = next_index;
646
647   tp = session_get_transport_proto (ctx->s);
648   ctx->transport_vft = transport_protocol_get_vft (tp);
649   ctx->tc = session_tx_get_transport (ctx, peek_data);
650   ctx->snd_mss = ctx->transport_vft->send_mss (ctx->tc);
651
652   if (PREDICT_FALSE (e->event_type == SESSION_IO_EVT_TX_FLUSH))
653     {
654       if (ctx->transport_vft->flush_data)
655         ctx->transport_vft->flush_data (ctx->tc);
656     }
657
658   ctx->snd_space = transport_connection_snd_space (ctx->tc,
659                                                    vm->clib_time.
660                                                    last_cpu_time,
661                                                    ctx->snd_mss);
662   if (ctx->snd_space == 0 || ctx->snd_mss == 0)
663     {
664       vec_add1 (wrk->pending_event_vector, *e);
665       return SESSION_TX_NO_DATA;
666     }
667
668   /* Allow enqueuing of a new event */
669   svm_fifo_unset_event (ctx->s->tx_fifo);
670
671   /* Check how much we can pull. */
672   session_tx_set_dequeue_params (vm, ctx, VLIB_FRAME_SIZE - *n_tx_packets,
673                                  peek_data);
674
675   if (PREDICT_FALSE (!ctx->max_len_to_snd))
676     return SESSION_TX_NO_DATA;
677
678   n_bufs_needed = ctx->n_segs_per_evt * ctx->n_bufs_per_seg;
679   vec_validate_aligned (wrk->tx_buffers, n_bufs_needed - 1,
680                         CLIB_CACHE_LINE_BYTES);
681   n_bufs = vlib_buffer_alloc (vm, wrk->tx_buffers, n_bufs_needed);
682   if (PREDICT_FALSE (n_bufs < n_bufs_needed))
683     {
684       if (n_bufs)
685         vlib_buffer_free (vm, wrk->tx_buffers, n_bufs);
686       vec_add1 (wrk->pending_event_vector, *e);
687       return SESSION_TX_NO_BUFFERS;
688     }
689
690   /*
691    * Write until we fill up a frame
692    */
693   vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
694   if (PREDICT_FALSE (ctx->n_segs_per_evt > n_left_to_next))
695     {
696       ctx->n_segs_per_evt = n_left_to_next;
697       ctx->max_len_to_snd = ctx->snd_mss * n_left_to_next;
698     }
699   ctx->left_to_snd = ctx->max_len_to_snd;
700   n_left = ctx->n_segs_per_evt;
701
702   while (n_left >= 4)
703     {
704       vlib_buffer_t *b0, *b1;
705       u32 bi0, bi1;
706
707       pbi = wrk->tx_buffers[n_bufs - 3];
708       pb = vlib_get_buffer (vm, pbi);
709       vlib_prefetch_buffer_header (pb, STORE);
710       pbi = wrk->tx_buffers[n_bufs - 4];
711       pb = vlib_get_buffer (vm, pbi);
712       vlib_prefetch_buffer_header (pb, STORE);
713
714       to_next[0] = bi0 = wrk->tx_buffers[--n_bufs];
715       to_next[1] = bi1 = wrk->tx_buffers[--n_bufs];
716
717       b0 = vlib_get_buffer (vm, bi0);
718       b1 = vlib_get_buffer (vm, bi1);
719
720       session_tx_fill_buffer (vm, ctx, b0, &n_bufs, peek_data);
721       session_tx_fill_buffer (vm, ctx, b1, &n_bufs, peek_data);
722
723       ctx->transport_vft->push_header (ctx->tc, b0);
724       ctx->transport_vft->push_header (ctx->tc, b1);
725
726       to_next += 2;
727       n_left_to_next -= 2;
728       n_left -= 2;
729
730       VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b0);
731       VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b1);
732
733       vlib_validate_buffer_enqueue_x2 (vm, node, next_index, to_next,
734                                        n_left_to_next, bi0, bi1, next0,
735                                        next1);
736     }
737   while (n_left)
738     {
739       vlib_buffer_t *b0;
740       u32 bi0;
741
742       if (n_left > 1)
743         {
744           pbi = wrk->tx_buffers[n_bufs - 2];
745           pb = vlib_get_buffer (vm, pbi);
746           vlib_prefetch_buffer_header (pb, STORE);
747         }
748
749       to_next[0] = bi0 = wrk->tx_buffers[--n_bufs];
750       b0 = vlib_get_buffer (vm, bi0);
751       session_tx_fill_buffer (vm, ctx, b0, &n_bufs, peek_data);
752
753       /* Ask transport to push header after current_length and
754        * total_length_not_including_first_buffer are updated */
755       ctx->transport_vft->push_header (ctx->tc, b0);
756
757       to_next += 1;
758       n_left_to_next -= 1;
759       n_left -= 1;
760
761       VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b0);
762
763       vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
764                                        n_left_to_next, bi0, next0);
765     }
766
767   if (PREDICT_FALSE (n_trace > 0))
768     session_tx_trace_frame (vm, node, next_index, to_next,
769                             ctx->n_segs_per_evt, ctx->s, n_trace);
770   if (PREDICT_FALSE (n_bufs))
771     {
772       clib_warning ("not all buffers consumed");
773       vlib_buffer_free (vm, wrk->tx_buffers, n_bufs);
774     }
775   *n_tx_packets += ctx->n_segs_per_evt;
776   transport_connection_update_tx_stats (ctx->tc, ctx->max_len_to_snd);
777   vlib_put_next_frame (vm, node, next_index, n_left_to_next);
778
779   /* If we couldn't dequeue all bytes mark as partially read */
780   ASSERT (ctx->left_to_snd == 0);
781   if (ctx->max_len_to_snd < ctx->max_dequeue)
782     if (svm_fifo_set_event (ctx->s->tx_fifo))
783       vec_add1 (wrk->pending_event_vector, *e);
784
785   if (!peek_data && ctx->transport_vft->tx_type == TRANSPORT_TX_DGRAM)
786     {
787       /* Fix dgram pre header */
788       if (ctx->max_len_to_snd < ctx->max_dequeue)
789         svm_fifo_overwrite_head (ctx->s->tx_fifo, (u8 *) & ctx->hdr,
790                                  sizeof (session_dgram_pre_hdr_t));
791       /* More data needs to be read */
792       else if (svm_fifo_max_dequeue_cons (ctx->s->tx_fifo) > 0)
793         if (svm_fifo_set_event (ctx->s->tx_fifo))
794           vec_add1 (wrk->pending_event_vector, *e);
795     }
796   return SESSION_TX_OK;
797 }
798
799 int
800 session_tx_fifo_peek_and_snd (vlib_main_t * vm, vlib_node_runtime_t * node,
801                               session_worker_t * wrk,
802                               session_event_t * e, int *n_tx_pkts)
803 {
804   return session_tx_fifo_read_and_snd_i (vm, node, wrk, e, n_tx_pkts, 1);
805 }
806
807 int
808 session_tx_fifo_dequeue_and_snd (vlib_main_t * vm, vlib_node_runtime_t * node,
809                                  session_worker_t * wrk,
810                                  session_event_t * e, int *n_tx_pkts)
811 {
812   return session_tx_fifo_read_and_snd_i (vm, node, wrk, e, n_tx_pkts, 0);
813 }
814
815 int
816 session_tx_fifo_dequeue_internal (vlib_main_t * vm,
817                                   vlib_node_runtime_t * node,
818                                   session_worker_t * wrk,
819                                   session_event_t * e, int *n_tx_pkts)
820 {
821   session_t *s = wrk->ctx.s;
822
823   if (PREDICT_FALSE (s->session_state >= SESSION_STATE_TRANSPORT_CLOSED))
824     return 0;
825   svm_fifo_unset_event (s->tx_fifo);
826   return transport_custom_tx (session_get_transport_proto (s), s);
827 }
828
829 always_inline session_t *
830 session_event_get_session (session_event_t * e, u8 thread_index)
831 {
832   return session_get_if_valid (e->session_index, thread_index);
833 }
834
835 static void
836 session_update_dispatch_period (session_worker_t * wrk, f64 now,
837                                 u32 thread_index)
838 {
839   if (wrk->last_tx_packets)
840     {
841       f64 sample = now - wrk->last_vlib_time;
842       wrk->dispatch_period = (wrk->dispatch_period + sample) * 0.5;
843     }
844   wrk->last_vlib_time = now;
845 }
846
847 static uword
848 session_queue_node_fn (vlib_main_t * vm, vlib_node_runtime_t * node,
849                        vlib_frame_t * frame)
850 {
851   session_main_t *smm = vnet_get_session_main ();
852   u32 thread_index = vm->thread_index, n_to_dequeue, n_events;
853   session_worker_t *wrk = &smm->wrk[thread_index];
854   session_event_t *e, *fifo_events;
855   svm_msg_q_msg_t _msg, *msg = &_msg;
856   f64 now = vlib_time_now (vm);
857   int n_tx_packets = 0, i, rv;
858   app_worker_t *app_wrk;
859   svm_msg_q_t *mq;
860   void (*fp) (void *);
861
862   SESSION_EVT_DBG (SESSION_EVT_POLL_GAP_TRACK, smm, thread_index);
863
864   /*
865    *  Update transport time
866    */
867   session_update_dispatch_period (wrk, now, thread_index);
868   transport_update_time (now, thread_index);
869
870   SESSION_EVT_DBG (SESSION_EVT_DEQ_NODE, 0);
871
872   /* Make sure postponed events are handled first */
873   fifo_events = wrk->free_event_vector;
874   vec_append (fifo_events, wrk->postponed_event_vector);
875   _vec_len (wrk->postponed_event_vector) = 0;
876
877   /* Try to dequeue what is available. Don't wait for lock.
878    * XXX: we may need priorities here */
879   mq = wrk->vpp_event_queue;
880   n_to_dequeue = svm_msg_q_size (mq);
881   if (n_to_dequeue && svm_msg_q_try_lock (mq) == 0)
882     {
883       for (i = 0; i < n_to_dequeue; i++)
884         {
885           vec_add2 (fifo_events, e, 1);
886           svm_msg_q_sub_w_lock (mq, msg);
887           /* Works because reply messages are smaller than a session evt.
888            * If we ever need to support bigger messages this needs to be
889            * fixed */
890           clib_memcpy_fast (e, svm_msg_q_msg_data (mq, msg), sizeof (*e));
891           svm_msg_q_free_msg (mq, msg);
892         }
893       svm_msg_q_unlock (mq);
894     }
895
896   vec_append (fifo_events, wrk->pending_event_vector);
897   vec_append (fifo_events, wrk->pending_disconnects);
898
899   _vec_len (wrk->pending_event_vector) = 0;
900   _vec_len (wrk->pending_disconnects) = 0;
901
902   n_events = vec_len (fifo_events);
903   if (PREDICT_FALSE (!n_events))
904     return 0;
905
906   for (i = 0; i < n_events; i++)
907     {
908       session_t *s;             /* $$$ prefetch 1 ahead maybe */
909       session_event_t *e;
910       u8 need_tx_ntf;
911
912       e = &fifo_events[i];
913       switch (e->event_type)
914         {
915         case SESSION_IO_EVT_TX_FLUSH:
916         case SESSION_IO_EVT_TX:
917           /* Don't try to send more that one frame per dispatch cycle */
918           if (n_tx_packets == VLIB_FRAME_SIZE)
919             {
920               vec_add1 (wrk->postponed_event_vector, *e);
921               break;
922             }
923
924           s = session_event_get_session (e, thread_index);
925           if (PREDICT_FALSE (!s))
926             {
927               clib_warning ("session was freed!");
928               continue;
929             }
930           CLIB_PREFETCH (s->tx_fifo, 2 * CLIB_CACHE_LINE_BYTES, LOAD);
931           wrk->ctx.s = s;
932           /* Spray packets in per session type frames, since they go to
933            * different nodes */
934           rv = (smm->session_tx_fns[s->session_type]) (vm, node, wrk, e,
935                                                        &n_tx_packets);
936           if (PREDICT_TRUE (rv == SESSION_TX_OK))
937             {
938               need_tx_ntf = svm_fifo_needs_tx_ntf (s->tx_fifo,
939                                                    wrk->ctx.max_len_to_snd);
940               if (PREDICT_FALSE (need_tx_ntf))
941                 session_dequeue_notify (s);
942             }
943           else if (PREDICT_FALSE (rv == SESSION_TX_NO_BUFFERS))
944             {
945               vlib_node_increment_counter (vm, node->node_index,
946                                            SESSION_QUEUE_ERROR_NO_BUFFER, 1);
947               continue;
948             }
949           break;
950         case SESSION_IO_EVT_RX:
951           s = session_event_get_session (e, thread_index);
952           if (!s)
953             break;
954           transport_app_rx_evt (session_get_transport_proto (s),
955                                 s->connection_index, s->thread_index);
956           break;
957         case SESSION_CTRL_EVT_CLOSE:
958           s = session_get_from_handle_if_valid (e->session_handle);
959           if (PREDICT_FALSE (!s))
960             break;
961
962           /* Make sure session disconnects run after the pending list is
963            * drained, i.e., postpone if the first time. If not the first
964            * and the tx queue is still not empty, try to wait for some
965            * dispatch cycles */
966           if (!e->postponed
967               || (e->postponed < 200
968                   && svm_fifo_max_dequeue_cons (s->tx_fifo)))
969             {
970               e->postponed += 1;
971               vec_add1 (wrk->pending_disconnects, *e);
972               continue;
973             }
974
975           session_transport_close (s);
976           break;
977         case SESSION_IO_EVT_BUILTIN_RX:
978           s = session_event_get_session (e, thread_index);
979           if (PREDICT_FALSE (!s || s->session_state >= SESSION_STATE_CLOSING))
980             continue;
981           svm_fifo_unset_event (s->rx_fifo);
982           app_wrk = app_worker_get (s->app_wrk_index);
983           app_worker_builtin_rx (app_wrk, s);
984           break;
985         case SESSION_IO_EVT_BUILTIN_TX:
986           s = session_get_from_handle_if_valid (e->session_handle);
987           wrk->ctx.s = s;
988           if (PREDICT_TRUE (s != 0))
989             session_tx_fifo_dequeue_internal (vm, node, wrk, e,
990                                               &n_tx_packets);
991           break;
992         case SESSION_CTRL_EVT_RPC:
993           fp = e->rpc_args.fp;
994           (*fp) (e->rpc_args.arg);
995           break;
996         case SESSION_CTRL_EVT_DISCONNECTED:
997           session_mq_disconnected_handler (e->data);
998           break;
999         case SESSION_CTRL_EVT_ACCEPTED_REPLY:
1000           session_mq_accepted_reply_handler (e->data);
1001           break;
1002         case SESSION_CTRL_EVT_CONNECTED_REPLY:
1003           break;
1004         case SESSION_CTRL_EVT_DISCONNECTED_REPLY:
1005           session_mq_disconnected_reply_handler (e->data);
1006           break;
1007         case SESSION_CTRL_EVT_RESET_REPLY:
1008           session_mq_reset_reply_handler (e->data);
1009           break;
1010         case SESSION_CTRL_EVT_WORKER_UPDATE:
1011           session_mq_worker_update_handler (e->data);
1012           break;
1013         default:
1014           clib_warning ("unhandled event type %d", e->event_type);
1015         }
1016     }
1017
1018   _vec_len (fifo_events) = 0;
1019   wrk->free_event_vector = fifo_events;
1020   wrk->last_tx_packets = n_tx_packets;
1021
1022   vlib_node_increment_counter (vm, session_queue_node.index,
1023                                SESSION_QUEUE_ERROR_TX, n_tx_packets);
1024
1025   SESSION_EVT_DBG (SESSION_EVT_DISPATCH_END, smm, thread_index);
1026
1027   return n_tx_packets;
1028 }
1029
1030 /* *INDENT-OFF* */
1031 VLIB_REGISTER_NODE (session_queue_node) =
1032 {
1033   .function = session_queue_node_fn,
1034   .name = "session-queue",
1035   .format_trace = format_session_queue_trace,
1036   .type = VLIB_NODE_TYPE_INPUT,
1037   .n_errors = ARRAY_LEN (session_queue_error_strings),
1038   .error_strings = session_queue_error_strings,
1039   .state = VLIB_NODE_STATE_DISABLED,
1040 };
1041 /* *INDENT-ON* */
1042
1043 void
1044 dump_thread_0_event_queue (void)
1045 {
1046   session_main_t *smm = vnet_get_session_main ();
1047   vlib_main_t *vm = &vlib_global_main;
1048   u32 my_thread_index = vm->thread_index;
1049   session_event_t _e, *e = &_e;
1050   svm_msg_q_ring_t *ring;
1051   session_t *s0;
1052   svm_msg_q_msg_t *msg;
1053   svm_msg_q_t *mq;
1054   int i, index;
1055
1056   mq = smm->wrk[my_thread_index].vpp_event_queue;
1057   index = mq->q->head;
1058
1059   for (i = 0; i < mq->q->cursize; i++)
1060     {
1061       msg = (svm_msg_q_msg_t *) (&mq->q->data[0] + mq->q->elsize * index);
1062       ring = svm_msg_q_ring (mq, msg->ring_index);
1063       clib_memcpy_fast (e, svm_msg_q_msg_data (mq, msg), ring->elsize);
1064
1065       switch (e->event_type)
1066         {
1067         case SESSION_IO_EVT_TX:
1068           s0 = session_event_get_session (e, my_thread_index);
1069           fformat (stdout, "[%04d] TX session %d\n", i, s0->session_index);
1070           break;
1071
1072         case SESSION_CTRL_EVT_CLOSE:
1073           s0 = session_get_from_handle (e->session_handle);
1074           fformat (stdout, "[%04d] disconnect session %d\n", i,
1075                    s0->session_index);
1076           break;
1077
1078         case SESSION_IO_EVT_BUILTIN_RX:
1079           s0 = session_event_get_session (e, my_thread_index);
1080           fformat (stdout, "[%04d] builtin_rx %d\n", i, s0->session_index);
1081           break;
1082
1083         case SESSION_CTRL_EVT_RPC:
1084           fformat (stdout, "[%04d] RPC call %llx with %llx\n",
1085                    i, (u64) (uword) (e->rpc_args.fp),
1086                    (u64) (uword) (e->rpc_args.arg));
1087           break;
1088
1089         default:
1090           fformat (stdout, "[%04d] unhandled event type %d\n",
1091                    i, e->event_type);
1092           break;
1093         }
1094
1095       index++;
1096
1097       if (index == mq->q->maxsize)
1098         index = 0;
1099     }
1100 }
1101
1102 static u8
1103 session_node_cmp_event (session_event_t * e, svm_fifo_t * f)
1104 {
1105   session_t *s;
1106   switch (e->event_type)
1107     {
1108     case SESSION_IO_EVT_RX:
1109     case SESSION_IO_EVT_TX:
1110     case SESSION_IO_EVT_BUILTIN_RX:
1111       if (e->session_index == f->master_session_index)
1112         return 1;
1113       break;
1114     case SESSION_CTRL_EVT_CLOSE:
1115       break;
1116     case SESSION_CTRL_EVT_RPC:
1117       s = session_get_from_handle (e->session_handle);
1118       if (!s)
1119         {
1120           clib_warning ("session has event but doesn't exist!");
1121           break;
1122         }
1123       if (s->rx_fifo == f || s->tx_fifo == f)
1124         return 1;
1125       break;
1126     default:
1127       break;
1128     }
1129   return 0;
1130 }
1131
1132 u8
1133 session_node_lookup_fifo_event (svm_fifo_t * f, session_event_t * e)
1134 {
1135   session_event_t *pending_event_vector, *evt;
1136   session_worker_t *wrk;
1137   int i, index, found = 0;
1138   svm_msg_q_msg_t *msg;
1139   svm_msg_q_ring_t *ring;
1140   svm_msg_q_t *mq;
1141   u8 thread_index;
1142
1143   ASSERT (e);
1144   thread_index = f->master_thread_index;
1145   wrk = session_main_get_worker (thread_index);
1146
1147   /*
1148    * Search evt queue
1149    */
1150   mq = wrk->vpp_event_queue;
1151   index = mq->q->head;
1152   for (i = 0; i < mq->q->cursize; i++)
1153     {
1154       msg = (svm_msg_q_msg_t *) (&mq->q->data[0] + mq->q->elsize * index);
1155       ring = svm_msg_q_ring (mq, msg->ring_index);
1156       clib_memcpy_fast (e, svm_msg_q_msg_data (mq, msg), ring->elsize);
1157       found = session_node_cmp_event (e, f);
1158       if (found)
1159         return 1;
1160       if (++index == mq->q->maxsize)
1161         index = 0;
1162     }
1163   /*
1164    * Search pending events vector
1165    */
1166   pending_event_vector = wrk->pending_event_vector;
1167   vec_foreach (evt, pending_event_vector)
1168   {
1169     found = session_node_cmp_event (evt, f);
1170     if (found)
1171       {
1172         clib_memcpy_fast (e, evt, sizeof (*evt));
1173         break;
1174       }
1175   }
1176   return found;
1177 }
1178
1179 static clib_error_t *
1180 session_queue_exit (vlib_main_t * vm)
1181 {
1182   if (vec_len (vlib_mains) < 2)
1183     return 0;
1184
1185   /*
1186    * Shut off (especially) worker-thread session nodes.
1187    * Otherwise, vpp can crash as the main thread unmaps the
1188    * API segment.
1189    */
1190   vlib_worker_thread_barrier_sync (vm);
1191   session_node_enable_disable (0 /* is_enable */ );
1192   vlib_worker_thread_barrier_release (vm);
1193   return 0;
1194 }
1195
1196 VLIB_MAIN_LOOP_EXIT_FUNCTION (session_queue_exit);
1197
1198 static uword
1199 session_queue_process (vlib_main_t * vm, vlib_node_runtime_t * rt,
1200                        vlib_frame_t * f)
1201 {
1202   f64 now, timeout = 1.0;
1203   uword *event_data = 0;
1204   uword event_type;
1205
1206   while (1)
1207     {
1208       vlib_process_wait_for_event_or_clock (vm, timeout);
1209       now = vlib_time_now (vm);
1210       event_type = vlib_process_get_events (vm, (uword **) & event_data);
1211
1212       switch (event_type)
1213         {
1214         case SESSION_Q_PROCESS_FLUSH_FRAMES:
1215           /* Flush the frames by updating all transports times */
1216           transport_update_time (now, 0);
1217           break;
1218         case SESSION_Q_PROCESS_STOP:
1219           timeout = 100000.0;
1220           break;
1221         case ~0:
1222           /* Timed out. Update time for all transports to trigger all
1223            * outstanding retransmits. */
1224           transport_update_time (now, 0);
1225           break;
1226         }
1227       vec_reset_length (event_data);
1228     }
1229   return 0;
1230 }
1231
1232 /* *INDENT-OFF* */
1233 VLIB_REGISTER_NODE (session_queue_process_node) =
1234 {
1235   .function = session_queue_process,
1236   .type = VLIB_NODE_TYPE_PROCESS,
1237   .name = "session-queue-process",
1238   .state = VLIB_NODE_STATE_DISABLED,
1239 };
1240 /* *INDENT-ON* */
1241
1242 static_always_inline uword
1243 session_queue_pre_input_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
1244                                 vlib_frame_t * frame)
1245 {
1246   session_main_t *sm = &session_main;
1247   if (!sm->wrk[0].vpp_event_queue)
1248     return 0;
1249   return session_queue_node_fn (vm, node, frame);
1250 }
1251
1252 /* *INDENT-OFF* */
1253 VLIB_REGISTER_NODE (session_queue_pre_input_node) =
1254 {
1255   .function = session_queue_pre_input_inline,
1256   .type = VLIB_NODE_TYPE_PRE_INPUT,
1257   .name = "session-queue-main",
1258   .state = VLIB_NODE_STATE_DISABLED,
1259 };
1260 /* *INDENT-ON* */
1261
1262 /*
1263  * fd.io coding-style-patch-verification: ON
1264  *
1265  * Local Variables:
1266  * eval: (c-set-style "gnu")
1267  * End:
1268  */