bfe7702388c488fbd1039317e7f04db8b9164635
[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->transport_options.tx_type ==
399               TRANSPORT_TX_DGRAM)
400             {
401               svm_fifo_t *f = ctx->s->tx_fifo;
402               session_dgram_hdr_t *hdr = &ctx->hdr;
403               u16 deq_now;
404               deq_now = clib_min (hdr->data_length - hdr->data_offset,
405                                   len_to_deq);
406               n_bytes_read = svm_fifo_peek (f, hdr->data_offset, deq_now,
407                                             data);
408               ASSERT (n_bytes_read > 0);
409
410               hdr->data_offset += n_bytes_read;
411               if (hdr->data_offset == hdr->data_length)
412                 {
413                   u32 offset = hdr->data_length + SESSION_CONN_HDR_LEN;
414                   svm_fifo_dequeue_drop (f, offset);
415                 }
416             }
417           else
418             n_bytes_read = svm_fifo_dequeue (ctx->s->tx_fifo,
419                                              len_to_deq, data);
420         }
421       ASSERT (n_bytes_read == len_to_deq);
422       chain_b->current_length = n_bytes_read;
423       b->total_length_not_including_first_buffer += chain_b->current_length;
424
425       /* update previous buffer */
426       prev_b->next_buffer = chain_bi0;
427       prev_b->flags |= VLIB_BUFFER_NEXT_PRESENT;
428
429       /* update current buffer */
430       chain_b->next_buffer = 0;
431
432       to_deq -= n_bytes_read;
433       if (to_deq == 0)
434         break;
435     }
436   ASSERT (to_deq == 0
437           && b->total_length_not_including_first_buffer == left_from_seg);
438   ctx->left_to_snd -= left_from_seg;
439 }
440
441 always_inline void
442 session_tx_fill_buffer (vlib_main_t * vm, session_tx_context_t * ctx,
443                         vlib_buffer_t * b, u16 * n_bufs, u8 peek_data)
444 {
445   u32 len_to_deq;
446   u8 *data0;
447   int n_bytes_read;
448
449   /*
450    * Start with the first buffer in chain
451    */
452   b->error = 0;
453   b->flags = VNET_BUFFER_F_LOCALLY_ORIGINATED;
454   b->current_data = 0;
455
456   data0 = vlib_buffer_make_headroom (b, TRANSPORT_MAX_HDRS_LEN);
457   len_to_deq = clib_min (ctx->left_to_snd, ctx->deq_per_first_buf);
458
459   if (peek_data)
460     {
461       n_bytes_read = svm_fifo_peek (ctx->s->tx_fifo, ctx->tx_offset,
462                                     len_to_deq, data0);
463       ASSERT (n_bytes_read > 0);
464       /* Keep track of progress locally, transport is also supposed to
465        * increment it independently when pushing the header */
466       ctx->tx_offset += n_bytes_read;
467     }
468   else
469     {
470       if (ctx->transport_vft->transport_options.tx_type == TRANSPORT_TX_DGRAM)
471         {
472           session_dgram_hdr_t *hdr = &ctx->hdr;
473           svm_fifo_t *f = ctx->s->tx_fifo;
474           u16 deq_now;
475           u32 offset;
476
477           ASSERT (hdr->data_length > hdr->data_offset);
478           deq_now = clib_min (hdr->data_length - hdr->data_offset,
479                               len_to_deq);
480           offset = hdr->data_offset + SESSION_CONN_HDR_LEN;
481           n_bytes_read = svm_fifo_peek (f, offset, deq_now, data0);
482           ASSERT (n_bytes_read > 0);
483
484           if (ctx->s->session_state == SESSION_STATE_LISTENING)
485             {
486               ip_copy (&ctx->tc->rmt_ip, &hdr->rmt_ip, ctx->tc->is_ip4);
487               ctx->tc->rmt_port = hdr->rmt_port;
488             }
489           hdr->data_offset += n_bytes_read;
490           if (hdr->data_offset == hdr->data_length)
491             {
492               offset = hdr->data_length + SESSION_CONN_HDR_LEN;
493               svm_fifo_dequeue_drop (f, offset);
494             }
495         }
496       else
497         {
498           n_bytes_read = svm_fifo_dequeue (ctx->s->tx_fifo,
499                                            len_to_deq, data0);
500           ASSERT (n_bytes_read > 0);
501         }
502     }
503   b->current_length = n_bytes_read;
504   ctx->left_to_snd -= n_bytes_read;
505
506   /*
507    * Fill in the remaining buffers in the chain, if any
508    */
509   if (PREDICT_FALSE (ctx->n_bufs_per_seg > 1 && ctx->left_to_snd))
510     session_tx_fifo_chain_tail (vm, ctx, b, n_bufs, peek_data);
511 }
512
513 always_inline u8
514 session_tx_not_ready (session_t * s, u8 peek_data)
515 {
516   if (peek_data)
517     {
518       /* Can retransmit for closed sessions but can't send new data if
519        * session is not ready or closed */
520       if (s->session_state < SESSION_STATE_READY)
521         return 1;
522       if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSED)
523         return 2;
524     }
525   return 0;
526 }
527
528 always_inline transport_connection_t *
529 session_tx_get_transport (session_tx_context_t * ctx, u8 peek_data)
530 {
531   if (peek_data)
532     {
533       return ctx->transport_vft->get_connection (ctx->s->connection_index,
534                                                  ctx->s->thread_index);
535     }
536   else
537     {
538       if (ctx->s->session_state == SESSION_STATE_LISTENING)
539         return ctx->transport_vft->get_listener (ctx->s->connection_index);
540       else
541         {
542           return ctx->transport_vft->get_connection (ctx->s->connection_index,
543                                                      ctx->s->thread_index);
544         }
545     }
546 }
547
548 always_inline void
549 session_tx_set_dequeue_params (vlib_main_t * vm, session_tx_context_t * ctx,
550                                u32 max_segs, u8 peek_data)
551 {
552   u32 n_bytes_per_buf, n_bytes_per_seg;
553   ctx->max_dequeue = svm_fifo_max_dequeue_cons (ctx->s->tx_fifo);
554   if (peek_data)
555     {
556       /* Offset in rx fifo from where to peek data */
557       ctx->tx_offset = ctx->transport_vft->tx_fifo_offset (ctx->tc);
558       if (PREDICT_FALSE (ctx->tx_offset >= ctx->max_dequeue))
559         {
560           ctx->max_len_to_snd = 0;
561           return;
562         }
563       ctx->max_dequeue -= ctx->tx_offset;
564     }
565   else
566     {
567       if (ctx->transport_vft->transport_options.tx_type == TRANSPORT_TX_DGRAM)
568         {
569           if (ctx->max_dequeue <= sizeof (ctx->hdr))
570             {
571               ctx->max_len_to_snd = 0;
572               return;
573             }
574           svm_fifo_peek (ctx->s->tx_fifo, 0, sizeof (ctx->hdr),
575                          (u8 *) & ctx->hdr);
576           ASSERT (ctx->hdr.data_length > ctx->hdr.data_offset);
577           ctx->max_dequeue = ctx->hdr.data_length - ctx->hdr.data_offset;
578         }
579     }
580   ASSERT (ctx->max_dequeue > 0);
581
582   /* Ensure we're not writing more than transport window allows */
583   if (ctx->max_dequeue < ctx->snd_space)
584     {
585       /* Constrained by tx queue. Try to send only fully formed segments */
586       ctx->max_len_to_snd =
587         (ctx->max_dequeue > ctx->snd_mss) ?
588         ctx->max_dequeue - ctx->max_dequeue % ctx->snd_mss : ctx->max_dequeue;
589       /* TODO Nagle ? */
590     }
591   else
592     {
593       /* Expectation is that snd_space0 is already a multiple of snd_mss */
594       ctx->max_len_to_snd = ctx->snd_space;
595     }
596
597   /* Check if we're tx constrained by the node */
598   ctx->n_segs_per_evt = ceil ((f64) ctx->max_len_to_snd / ctx->snd_mss);
599   if (ctx->n_segs_per_evt > max_segs)
600     {
601       ctx->n_segs_per_evt = max_segs;
602       ctx->max_len_to_snd = max_segs * ctx->snd_mss;
603     }
604
605   n_bytes_per_buf = vlib_buffer_get_default_data_size (vm);
606   ASSERT (n_bytes_per_buf > TRANSPORT_MAX_HDRS_LEN);
607   n_bytes_per_seg = TRANSPORT_MAX_HDRS_LEN + ctx->snd_mss;
608   ctx->n_bufs_per_seg = ceil ((f64) n_bytes_per_seg / n_bytes_per_buf);
609   ctx->deq_per_buf = clib_min (ctx->snd_mss, n_bytes_per_buf);
610   ctx->deq_per_first_buf = clib_min (ctx->snd_mss,
611                                      n_bytes_per_buf -
612                                      TRANSPORT_MAX_HDRS_LEN);
613 }
614
615 always_inline int
616 session_tx_fifo_read_and_snd_i (vlib_main_t * vm, vlib_node_runtime_t * node,
617                                 session_worker_t * wrk,
618                                 session_evt_elt_t * elt, int *n_tx_packets,
619                                 u8 peek_data)
620 {
621   u32 next_index, next0, next1, *to_next, n_left_to_next, n_left, pbi;
622   u32 n_trace = vlib_get_trace_count (vm, node), n_bufs_needed = 0;
623   session_main_t *smm = &session_main;
624   session_tx_context_t *ctx = &wrk->ctx;
625   session_event_t *e = &elt->evt;
626   transport_proto_t tp;
627   vlib_buffer_t *pb;
628   u16 n_bufs, rv;
629
630   if (PREDICT_FALSE ((rv = session_tx_not_ready (ctx->s, peek_data))))
631     {
632       if (rv < 2)
633         session_evt_add_pending (wrk, elt);
634       return SESSION_TX_NO_DATA;
635     }
636
637   next_index = smm->session_type_to_next[ctx->s->session_type];
638   next0 = next1 = next_index;
639
640   tp = session_get_transport_proto (ctx->s);
641   ctx->transport_vft = transport_protocol_get_vft (tp);
642   ctx->tc = session_tx_get_transport (ctx, peek_data);
643   ctx->snd_mss = ctx->transport_vft->send_mss (ctx->tc);
644
645   if (PREDICT_FALSE (e->event_type == SESSION_IO_EVT_TX_FLUSH))
646     {
647       if (ctx->transport_vft->flush_data)
648         ctx->transport_vft->flush_data (ctx->tc);
649     }
650
651   ctx->snd_space = transport_connection_snd_space (ctx->tc,
652                                                    vm->clib_time.
653                                                    last_cpu_time,
654                                                    ctx->snd_mss);
655   if (ctx->snd_space == 0 || ctx->snd_mss == 0)
656     {
657       session_evt_add_pending (wrk, elt);
658       return SESSION_TX_NO_DATA;
659     }
660
661   /* Allow enqueuing of a new event */
662   svm_fifo_unset_event (ctx->s->tx_fifo);
663
664   /* Check how much we can pull. */
665   session_tx_set_dequeue_params (vm, ctx, VLIB_FRAME_SIZE - *n_tx_packets,
666                                  peek_data);
667
668   if (PREDICT_FALSE (!ctx->max_len_to_snd))
669     return SESSION_TX_NO_DATA;
670
671   n_bufs_needed = ctx->n_segs_per_evt * ctx->n_bufs_per_seg;
672   vec_validate_aligned (wrk->tx_buffers, n_bufs_needed - 1,
673                         CLIB_CACHE_LINE_BYTES);
674   n_bufs = vlib_buffer_alloc (vm, wrk->tx_buffers, n_bufs_needed);
675   if (PREDICT_FALSE (n_bufs < n_bufs_needed))
676     {
677       if (n_bufs)
678         vlib_buffer_free (vm, wrk->tx_buffers, n_bufs);
679       session_evt_add_pending (wrk, elt);
680       return SESSION_TX_NO_BUFFERS;
681     }
682
683   /*
684    * Write until we fill up a frame
685    */
686   vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
687   if (PREDICT_FALSE (ctx->n_segs_per_evt > n_left_to_next))
688     {
689       ctx->n_segs_per_evt = n_left_to_next;
690       ctx->max_len_to_snd = ctx->snd_mss * n_left_to_next;
691     }
692   ctx->left_to_snd = ctx->max_len_to_snd;
693   n_left = ctx->n_segs_per_evt;
694
695   while (n_left >= 4)
696     {
697       vlib_buffer_t *b0, *b1;
698       u32 bi0, bi1;
699
700       pbi = wrk->tx_buffers[n_bufs - 3];
701       pb = vlib_get_buffer (vm, pbi);
702       vlib_prefetch_buffer_header (pb, STORE);
703       pbi = wrk->tx_buffers[n_bufs - 4];
704       pb = vlib_get_buffer (vm, pbi);
705       vlib_prefetch_buffer_header (pb, STORE);
706
707       to_next[0] = bi0 = wrk->tx_buffers[--n_bufs];
708       to_next[1] = bi1 = wrk->tx_buffers[--n_bufs];
709
710       b0 = vlib_get_buffer (vm, bi0);
711       b1 = vlib_get_buffer (vm, bi1);
712
713       session_tx_fill_buffer (vm, ctx, b0, &n_bufs, peek_data);
714       session_tx_fill_buffer (vm, ctx, b1, &n_bufs, peek_data);
715
716       ctx->transport_vft->push_header (ctx->tc, b0);
717       ctx->transport_vft->push_header (ctx->tc, b1);
718
719       to_next += 2;
720       n_left_to_next -= 2;
721       n_left -= 2;
722
723       VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b0);
724       VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b1);
725
726       vlib_validate_buffer_enqueue_x2 (vm, node, next_index, to_next,
727                                        n_left_to_next, bi0, bi1, next0,
728                                        next1);
729     }
730   while (n_left)
731     {
732       vlib_buffer_t *b0;
733       u32 bi0;
734
735       if (n_left > 1)
736         {
737           pbi = wrk->tx_buffers[n_bufs - 2];
738           pb = vlib_get_buffer (vm, pbi);
739           vlib_prefetch_buffer_header (pb, STORE);
740         }
741
742       to_next[0] = bi0 = wrk->tx_buffers[--n_bufs];
743       b0 = vlib_get_buffer (vm, bi0);
744       session_tx_fill_buffer (vm, ctx, b0, &n_bufs, peek_data);
745
746       /* Ask transport to push header after current_length and
747        * total_length_not_including_first_buffer are updated */
748       ctx->transport_vft->push_header (ctx->tc, b0);
749
750       to_next += 1;
751       n_left_to_next -= 1;
752       n_left -= 1;
753
754       VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b0);
755
756       vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
757                                        n_left_to_next, bi0, next0);
758     }
759
760   if (PREDICT_FALSE (n_trace > 0))
761     session_tx_trace_frame (vm, node, next_index, to_next,
762                             ctx->n_segs_per_evt, ctx->s, n_trace);
763   if (PREDICT_FALSE (n_bufs))
764     {
765       vlib_buffer_free (vm, wrk->tx_buffers, n_bufs);
766     }
767   *n_tx_packets += ctx->n_segs_per_evt;
768   transport_connection_update_tx_stats (ctx->tc, ctx->max_len_to_snd);
769   vlib_put_next_frame (vm, node, next_index, n_left_to_next);
770
771   SESSION_EVT (SESSION_EVT_DEQ, ctx->s, ctx->max_len_to_snd, ctx->max_dequeue,
772                ctx->s->tx_fifo->has_event, wrk->last_vlib_time);
773
774   /* If we couldn't dequeue all bytes mark as partially read */
775   ASSERT (ctx->left_to_snd == 0);
776   if (ctx->max_len_to_snd < ctx->max_dequeue)
777     if (svm_fifo_set_event (ctx->s->tx_fifo))
778       session_evt_add_pending (wrk, elt);
779
780   if (!peek_data
781       && ctx->transport_vft->transport_options.tx_type == TRANSPORT_TX_DGRAM)
782     {
783       /* Fix dgram pre header */
784       if (ctx->max_len_to_snd < ctx->max_dequeue)
785         svm_fifo_overwrite_head (ctx->s->tx_fifo, (u8 *) & ctx->hdr,
786                                  sizeof (session_dgram_pre_hdr_t));
787       /* More data needs to be read */
788       else if (svm_fifo_max_dequeue_cons (ctx->s->tx_fifo) > 0)
789         if (svm_fifo_set_event (ctx->s->tx_fifo))
790           session_evt_add_pending (wrk, elt);
791
792       if (svm_fifo_needs_deq_ntf (ctx->s->tx_fifo, ctx->max_len_to_snd))
793         session_dequeue_notify (ctx->s);
794     }
795   return SESSION_TX_OK;
796 }
797
798 int
799 session_tx_fifo_peek_and_snd (vlib_main_t * vm, vlib_node_runtime_t * node,
800                               session_worker_t * wrk,
801                               session_evt_elt_t * e, int *n_tx_pkts)
802 {
803   return session_tx_fifo_read_and_snd_i (vm, node, wrk, e, n_tx_pkts, 1);
804 }
805
806 int
807 session_tx_fifo_dequeue_and_snd (vlib_main_t * vm, vlib_node_runtime_t * node,
808                                  session_worker_t * wrk,
809                                  session_evt_elt_t * e, int *n_tx_pkts)
810 {
811   return session_tx_fifo_read_and_snd_i (vm, node, wrk, e, n_tx_pkts, 0);
812 }
813
814 int
815 session_tx_fifo_dequeue_internal (vlib_main_t * vm,
816                                   vlib_node_runtime_t * node,
817                                   session_worker_t * wrk,
818                                   session_evt_elt_t * e, int *n_tx_pkts)
819 {
820   session_t *s = wrk->ctx.s;
821
822   if (PREDICT_FALSE (s->session_state >= SESSION_STATE_TRANSPORT_CLOSED))
823     return 0;
824   svm_fifo_unset_event (s->tx_fifo);
825   return transport_custom_tx (session_get_transport_proto (s), s);
826 }
827
828 always_inline session_t *
829 session_event_get_session (session_event_t * e, u8 thread_index)
830 {
831   return session_get_if_valid (e->session_index, thread_index);
832 }
833
834 static void
835 session_update_dispatch_period (session_worker_t * wrk, f64 now,
836                                 u32 thread_index)
837 {
838   if (wrk->last_tx_packets)
839     {
840       f64 sample = now - wrk->last_vlib_time;
841       wrk->dispatch_period = (wrk->dispatch_period + sample) * 0.5;
842     }
843   wrk->last_vlib_time = now;
844 }
845
846 static uword
847 session_queue_node_fn (vlib_main_t * vm, vlib_node_runtime_t * node,
848                        vlib_frame_t * frame)
849 {
850   session_main_t *smm = vnet_get_session_main ();
851   u32 thread_index = vm->thread_index, n_to_dequeue;
852   session_worker_t *wrk = &smm->wrk[thread_index];
853   session_evt_elt_t *elt, *new_he, *new_te, *pending_he;
854   session_evt_elt_t *disconnects_he, *postponed_he;
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 (SESSION_EVT_DISPATCH_START, wrk);
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   /* Make sure postponed events are handled first */
871   new_he = pool_elt_at_index (wrk->event_elts, wrk->new_head);
872   new_te = clib_llist_prev (wrk->event_elts, evt_list, new_he);
873
874   postponed_he = pool_elt_at_index (wrk->event_elts, wrk->postponed_head);
875   clib_llist_splice (wrk->event_elts, evt_list, new_te, postponed_he);
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           elt = session_evt_elt_alloc (wrk);
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 (&elt->evt, svm_msg_q_msg_data (mq, msg),
891                             sizeof (elt->evt));
892           svm_msg_q_free_msg (mq, msg);
893           new_he = pool_elt_at_index (wrk->event_elts, wrk->new_head);
894           clib_llist_add_tail (wrk->event_elts, evt_list, elt, new_he);
895         }
896       svm_msg_q_unlock (mq);
897     }
898
899   pending_he = pool_elt_at_index (wrk->event_elts, wrk->pending_head);
900   postponed_he = pool_elt_at_index (wrk->event_elts, wrk->postponed_head);
901   disconnects_he = pool_elt_at_index (wrk->event_elts, wrk->disconnects_head);
902
903   new_te = clib_llist_prev (wrk->event_elts, evt_list, new_he);
904   clib_llist_splice (wrk->event_elts, evt_list, new_te, pending_he);
905   new_te = clib_llist_prev (wrk->event_elts, evt_list, new_he);
906   clib_llist_splice (wrk->event_elts, evt_list, new_te, disconnects_he);
907
908   while (!clib_llist_is_empty (wrk->event_elts, evt_list, new_he))
909     {
910       clib_llist_index_t ei;
911       session_event_t *e;
912       session_t *s;
913
914       clib_llist_pop_first (wrk->event_elts, evt_list, elt, new_he);
915       ei = clib_llist_entry_index (wrk->event_elts, elt);
916       e = &elt->evt;
917       switch (e->event_type)
918         {
919         case SESSION_IO_EVT_TX_FLUSH:
920         case SESSION_IO_EVT_TX:
921           /* Don't try to send more that one frame per dispatch cycle */
922           if (n_tx_packets == VLIB_FRAME_SIZE)
923             {
924               session_evt_add_postponed (wrk, elt);
925               continue;
926             }
927
928           s = session_event_get_session (e, thread_index);
929           if (PREDICT_FALSE (!s))
930             {
931               clib_warning ("session was freed!");
932               break;
933             }
934           CLIB_PREFETCH (s->tx_fifo, 2 * CLIB_CACHE_LINE_BYTES, LOAD);
935           wrk->ctx.s = s;
936           /* Spray packets in per session type frames, since they go to
937            * different nodes */
938           rv = (smm->session_tx_fns[s->session_type]) (vm, node, wrk, elt,
939                                                        &n_tx_packets);
940           if (PREDICT_FALSE (rv == SESSION_TX_NO_BUFFERS))
941             {
942               vlib_node_increment_counter (vm, node->node_index,
943                                            SESSION_QUEUE_ERROR_NO_BUFFER, 1);
944               break;
945             }
946           break;
947         case SESSION_IO_EVT_RX:
948           s = session_event_get_session (e, thread_index);
949           if (!s)
950             break;
951           transport_app_rx_evt (session_get_transport_proto (s),
952                                 s->connection_index, s->thread_index);
953           break;
954         case SESSION_CTRL_EVT_CLOSE:
955           s = session_get_from_handle_if_valid (e->session_handle);
956           if (PREDICT_FALSE (!s))
957             break;
958           session_transport_close (s);
959           break;
960         case SESSION_IO_EVT_BUILTIN_RX:
961           s = session_event_get_session (e, thread_index);
962           if (PREDICT_FALSE (!s || s->session_state >= SESSION_STATE_CLOSING))
963             break;
964           svm_fifo_unset_event (s->rx_fifo);
965           app_wrk = app_worker_get (s->app_wrk_index);
966           app_worker_builtin_rx (app_wrk, s);
967           break;
968         case SESSION_IO_EVT_BUILTIN_TX:
969           s = session_get_from_handle_if_valid (e->session_handle);
970           wrk->ctx.s = s;
971           if (PREDICT_TRUE (s != 0))
972             session_tx_fifo_dequeue_internal (vm, node, wrk, elt,
973                                               &n_tx_packets);
974           break;
975         case SESSION_CTRL_EVT_RPC:
976           fp = e->rpc_args.fp;
977           (*fp) (e->rpc_args.arg);
978           break;
979         case SESSION_CTRL_EVT_DISCONNECTED:
980           session_mq_disconnected_handler (e->data);
981           break;
982         case SESSION_CTRL_EVT_ACCEPTED_REPLY:
983           session_mq_accepted_reply_handler (e->data);
984           break;
985         case SESSION_CTRL_EVT_CONNECTED_REPLY:
986           break;
987         case SESSION_CTRL_EVT_DISCONNECTED_REPLY:
988           session_mq_disconnected_reply_handler (e->data);
989           break;
990         case SESSION_CTRL_EVT_RESET_REPLY:
991           session_mq_reset_reply_handler (e->data);
992           break;
993         case SESSION_CTRL_EVT_WORKER_UPDATE:
994           session_mq_worker_update_handler (e->data);
995           break;
996         default:
997           clib_warning ("unhandled event type %d", e->event_type);
998         }
999
1000       /* Regrab elements in case pool moved */
1001       elt = pool_elt_at_index (wrk->event_elts, ei);
1002       if (!clib_llist_elt_is_linked (elt, evt_list))
1003         session_evt_elt_free (wrk, elt);
1004
1005       new_he = pool_elt_at_index (wrk->event_elts, wrk->new_head);
1006     }
1007
1008   wrk->last_tx_packets = n_tx_packets;
1009
1010   vlib_node_increment_counter (vm, session_queue_node.index,
1011                                SESSION_QUEUE_ERROR_TX, n_tx_packets);
1012
1013   SESSION_EVT (SESSION_EVT_DISPATCH_END, wrk, n_tx_packets);
1014
1015   return n_tx_packets;
1016 }
1017
1018 /* *INDENT-OFF* */
1019 VLIB_REGISTER_NODE (session_queue_node) =
1020 {
1021   .function = session_queue_node_fn,
1022   .name = "session-queue",
1023   .format_trace = format_session_queue_trace,
1024   .type = VLIB_NODE_TYPE_INPUT,
1025   .n_errors = ARRAY_LEN (session_queue_error_strings),
1026   .error_strings = session_queue_error_strings,
1027   .state = VLIB_NODE_STATE_DISABLED,
1028 };
1029 /* *INDENT-ON* */
1030
1031 void
1032 dump_thread_0_event_queue (void)
1033 {
1034   session_main_t *smm = vnet_get_session_main ();
1035   vlib_main_t *vm = &vlib_global_main;
1036   u32 my_thread_index = vm->thread_index;
1037   session_event_t _e, *e = &_e;
1038   svm_msg_q_ring_t *ring;
1039   session_t *s0;
1040   svm_msg_q_msg_t *msg;
1041   svm_msg_q_t *mq;
1042   int i, index;
1043
1044   mq = smm->wrk[my_thread_index].vpp_event_queue;
1045   index = mq->q->head;
1046
1047   for (i = 0; i < mq->q->cursize; i++)
1048     {
1049       msg = (svm_msg_q_msg_t *) (&mq->q->data[0] + mq->q->elsize * index);
1050       ring = svm_msg_q_ring (mq, msg->ring_index);
1051       clib_memcpy_fast (e, svm_msg_q_msg_data (mq, msg), ring->elsize);
1052
1053       switch (e->event_type)
1054         {
1055         case SESSION_IO_EVT_TX:
1056           s0 = session_event_get_session (e, my_thread_index);
1057           fformat (stdout, "[%04d] TX session %d\n", i, s0->session_index);
1058           break;
1059
1060         case SESSION_CTRL_EVT_CLOSE:
1061           s0 = session_get_from_handle (e->session_handle);
1062           fformat (stdout, "[%04d] disconnect session %d\n", i,
1063                    s0->session_index);
1064           break;
1065
1066         case SESSION_IO_EVT_BUILTIN_RX:
1067           s0 = session_event_get_session (e, my_thread_index);
1068           fformat (stdout, "[%04d] builtin_rx %d\n", i, s0->session_index);
1069           break;
1070
1071         case SESSION_CTRL_EVT_RPC:
1072           fformat (stdout, "[%04d] RPC call %llx with %llx\n",
1073                    i, (u64) (uword) (e->rpc_args.fp),
1074                    (u64) (uword) (e->rpc_args.arg));
1075           break;
1076
1077         default:
1078           fformat (stdout, "[%04d] unhandled event type %d\n",
1079                    i, e->event_type);
1080           break;
1081         }
1082
1083       index++;
1084
1085       if (index == mq->q->maxsize)
1086         index = 0;
1087     }
1088 }
1089
1090 static u8
1091 session_node_cmp_event (session_event_t * e, svm_fifo_t * f)
1092 {
1093   session_t *s;
1094   switch (e->event_type)
1095     {
1096     case SESSION_IO_EVT_RX:
1097     case SESSION_IO_EVT_TX:
1098     case SESSION_IO_EVT_BUILTIN_RX:
1099       if (e->session_index == f->master_session_index)
1100         return 1;
1101       break;
1102     case SESSION_CTRL_EVT_CLOSE:
1103       break;
1104     case SESSION_CTRL_EVT_RPC:
1105       s = session_get_from_handle (e->session_handle);
1106       if (!s)
1107         {
1108           clib_warning ("session has event but doesn't exist!");
1109           break;
1110         }
1111       if (s->rx_fifo == f || s->tx_fifo == f)
1112         return 1;
1113       break;
1114     default:
1115       break;
1116     }
1117   return 0;
1118 }
1119
1120 u8
1121 session_node_lookup_fifo_event (svm_fifo_t * f, session_event_t * e)
1122 {
1123   session_evt_elt_t *elt;
1124   session_worker_t *wrk;
1125   int i, index, found = 0;
1126   svm_msg_q_msg_t *msg;
1127   svm_msg_q_ring_t *ring;
1128   svm_msg_q_t *mq;
1129   u8 thread_index;
1130
1131   ASSERT (e);
1132   thread_index = f->master_thread_index;
1133   wrk = session_main_get_worker (thread_index);
1134
1135   /*
1136    * Search evt queue
1137    */
1138   mq = wrk->vpp_event_queue;
1139   index = mq->q->head;
1140   for (i = 0; i < mq->q->cursize; i++)
1141     {
1142       msg = (svm_msg_q_msg_t *) (&mq->q->data[0] + mq->q->elsize * index);
1143       ring = svm_msg_q_ring (mq, msg->ring_index);
1144       clib_memcpy_fast (e, svm_msg_q_msg_data (mq, msg), ring->elsize);
1145       found = session_node_cmp_event (e, f);
1146       if (found)
1147         return 1;
1148       if (++index == mq->q->maxsize)
1149         index = 0;
1150     }
1151   /*
1152    * Search pending events vector
1153    */
1154
1155   /* *INDENT-OFF* */
1156   clib_llist_foreach (wrk->event_elts, evt_list,
1157                       session_evt_pending_head (wrk), elt, ({
1158     found = session_node_cmp_event (&elt->evt, f);
1159     if (found)
1160       {
1161         clib_memcpy_fast (e, &elt->evt, sizeof (*e));
1162         break;
1163       }
1164
1165   }));
1166   /* *INDENT-ON* */
1167
1168   return found;
1169 }
1170
1171 static clib_error_t *
1172 session_queue_exit (vlib_main_t * vm)
1173 {
1174   if (vec_len (vlib_mains) < 2)
1175     return 0;
1176
1177   /*
1178    * Shut off (especially) worker-thread session nodes.
1179    * Otherwise, vpp can crash as the main thread unmaps the
1180    * API segment.
1181    */
1182   vlib_worker_thread_barrier_sync (vm);
1183   session_node_enable_disable (0 /* is_enable */ );
1184   vlib_worker_thread_barrier_release (vm);
1185   return 0;
1186 }
1187
1188 VLIB_MAIN_LOOP_EXIT_FUNCTION (session_queue_exit);
1189
1190 static uword
1191 session_queue_process (vlib_main_t * vm, vlib_node_runtime_t * rt,
1192                        vlib_frame_t * f)
1193 {
1194   f64 now, timeout = 1.0;
1195   uword *event_data = 0;
1196   uword event_type;
1197
1198   while (1)
1199     {
1200       vlib_process_wait_for_event_or_clock (vm, timeout);
1201       now = vlib_time_now (vm);
1202       event_type = vlib_process_get_events (vm, (uword **) & event_data);
1203
1204       switch (event_type)
1205         {
1206         case SESSION_Q_PROCESS_FLUSH_FRAMES:
1207           /* Flush the frames by updating all transports times */
1208           transport_update_time (now, 0);
1209           break;
1210         case SESSION_Q_PROCESS_STOP:
1211           timeout = 100000.0;
1212           break;
1213         case ~0:
1214           /* Timed out. Update time for all transports to trigger all
1215            * outstanding retransmits. */
1216           transport_update_time (now, 0);
1217           break;
1218         }
1219       vec_reset_length (event_data);
1220     }
1221   return 0;
1222 }
1223
1224 /* *INDENT-OFF* */
1225 VLIB_REGISTER_NODE (session_queue_process_node) =
1226 {
1227   .function = session_queue_process,
1228   .type = VLIB_NODE_TYPE_PROCESS,
1229   .name = "session-queue-process",
1230   .state = VLIB_NODE_STATE_DISABLED,
1231 };
1232 /* *INDENT-ON* */
1233
1234 static_always_inline uword
1235 session_queue_pre_input_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
1236                                 vlib_frame_t * frame)
1237 {
1238   session_main_t *sm = &session_main;
1239   if (!sm->wrk[0].vpp_event_queue)
1240     return 0;
1241   return session_queue_node_fn (vm, node, frame);
1242 }
1243
1244 /* *INDENT-OFF* */
1245 VLIB_REGISTER_NODE (session_queue_pre_input_node) =
1246 {
1247   .function = session_queue_pre_input_inline,
1248   .type = VLIB_NODE_TYPE_PRE_INPUT,
1249   .name = "session-queue-main",
1250   .state = VLIB_NODE_STATE_DISABLED,
1251 };
1252 /* *INDENT-ON* */
1253
1254 /*
1255  * fd.io coding-style-patch-verification: ON
1256  *
1257  * Local Variables:
1258  * eval: (c-set-style "gnu")
1259  * End:
1260  */