svm: rename fifo tx notifications to reflect use
[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   /* *INDENT-OFF* */
513   SESSION_EVT_DBG(SESSION_EVT_DEQ, ctx->s, ({
514         ed->data[0] = SESSION_IO_EVT_TX;
515         ed->data[1] = ctx->max_dequeue;
516         ed->data[2] = len_to_deq;
517         ed->data[3] = ctx->left_to_snd;
518   }));
519   /* *INDENT-ON* */
520 }
521
522 always_inline u8
523 session_tx_not_ready (session_t * s, u8 peek_data)
524 {
525   if (peek_data)
526     {
527       /* Can retransmit for closed sessions but can't send new data if
528        * session is not ready or closed */
529       if (s->session_state < SESSION_STATE_READY)
530         return 1;
531       if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSED)
532         return 2;
533     }
534   return 0;
535 }
536
537 always_inline transport_connection_t *
538 session_tx_get_transport (session_tx_context_t * ctx, u8 peek_data)
539 {
540   if (peek_data)
541     {
542       return ctx->transport_vft->get_connection (ctx->s->connection_index,
543                                                  ctx->s->thread_index);
544     }
545   else
546     {
547       if (ctx->s->session_state == SESSION_STATE_LISTENING)
548         return ctx->transport_vft->get_listener (ctx->s->connection_index);
549       else
550         {
551           return ctx->transport_vft->get_connection (ctx->s->connection_index,
552                                                      ctx->s->thread_index);
553         }
554     }
555 }
556
557 always_inline void
558 session_tx_set_dequeue_params (vlib_main_t * vm, session_tx_context_t * ctx,
559                                u32 max_segs, u8 peek_data)
560 {
561   u32 n_bytes_per_buf, n_bytes_per_seg;
562   ctx->max_dequeue = svm_fifo_max_dequeue_cons (ctx->s->tx_fifo);
563   if (peek_data)
564     {
565       /* Offset in rx fifo from where to peek data */
566       ctx->tx_offset = ctx->transport_vft->tx_fifo_offset (ctx->tc);
567       if (PREDICT_FALSE (ctx->tx_offset >= ctx->max_dequeue))
568         {
569           ctx->max_len_to_snd = 0;
570           return;
571         }
572       ctx->max_dequeue -= ctx->tx_offset;
573     }
574   else
575     {
576       if (ctx->transport_vft->transport_options.tx_type == TRANSPORT_TX_DGRAM)
577         {
578           if (ctx->max_dequeue <= sizeof (ctx->hdr))
579             {
580               ctx->max_len_to_snd = 0;
581               return;
582             }
583           svm_fifo_peek (ctx->s->tx_fifo, 0, sizeof (ctx->hdr),
584                          (u8 *) & ctx->hdr);
585           ASSERT (ctx->hdr.data_length > ctx->hdr.data_offset);
586           ctx->max_dequeue = ctx->hdr.data_length - ctx->hdr.data_offset;
587         }
588     }
589   ASSERT (ctx->max_dequeue > 0);
590
591   /* Ensure we're not writing more than transport window allows */
592   if (ctx->max_dequeue < ctx->snd_space)
593     {
594       /* Constrained by tx queue. Try to send only fully formed segments */
595       ctx->max_len_to_snd =
596         (ctx->max_dequeue > ctx->snd_mss) ?
597         ctx->max_dequeue - ctx->max_dequeue % ctx->snd_mss : ctx->max_dequeue;
598       /* TODO Nagle ? */
599     }
600   else
601     {
602       /* Expectation is that snd_space0 is already a multiple of snd_mss */
603       ctx->max_len_to_snd = ctx->snd_space;
604     }
605
606   /* Check if we're tx constrained by the node */
607   ctx->n_segs_per_evt = ceil ((f64) ctx->max_len_to_snd / ctx->snd_mss);
608   if (ctx->n_segs_per_evt > max_segs)
609     {
610       ctx->n_segs_per_evt = max_segs;
611       ctx->max_len_to_snd = max_segs * ctx->snd_mss;
612     }
613
614   n_bytes_per_buf = vlib_buffer_get_default_data_size (vm);
615   ASSERT (n_bytes_per_buf > TRANSPORT_MAX_HDRS_LEN);
616   n_bytes_per_seg = TRANSPORT_MAX_HDRS_LEN + ctx->snd_mss;
617   ctx->n_bufs_per_seg = ceil ((f64) n_bytes_per_seg / n_bytes_per_buf);
618   ctx->deq_per_buf = clib_min (ctx->snd_mss, n_bytes_per_buf);
619   ctx->deq_per_first_buf = clib_min (ctx->snd_mss,
620                                      n_bytes_per_buf -
621                                      TRANSPORT_MAX_HDRS_LEN);
622 }
623
624 always_inline int
625 session_tx_fifo_read_and_snd_i (vlib_main_t * vm, vlib_node_runtime_t * node,
626                                 session_worker_t * wrk,
627                                 session_event_t * e, int *n_tx_packets,
628                                 u8 peek_data)
629 {
630   u32 next_index, next0, next1, *to_next, n_left_to_next, n_left, pbi;
631   u32 n_trace = vlib_get_trace_count (vm, node), n_bufs_needed = 0;
632   session_main_t *smm = &session_main;
633   session_tx_context_t *ctx = &wrk->ctx;
634   transport_proto_t tp;
635   vlib_buffer_t *pb;
636   u16 n_bufs, rv;
637
638   if (PREDICT_FALSE ((rv = session_tx_not_ready (ctx->s, peek_data))))
639     {
640       if (rv < 2)
641         vec_add1 (wrk->pending_event_vector, *e);
642       return SESSION_TX_NO_DATA;
643     }
644
645   next_index = smm->session_type_to_next[ctx->s->session_type];
646   next0 = next1 = next_index;
647
648   tp = session_get_transport_proto (ctx->s);
649   ctx->transport_vft = transport_protocol_get_vft (tp);
650   ctx->tc = session_tx_get_transport (ctx, peek_data);
651   ctx->snd_mss = ctx->transport_vft->send_mss (ctx->tc);
652
653   if (PREDICT_FALSE (e->event_type == SESSION_IO_EVT_TX_FLUSH))
654     {
655       if (ctx->transport_vft->flush_data)
656         ctx->transport_vft->flush_data (ctx->tc);
657     }
658
659   ctx->snd_space = transport_connection_snd_space (ctx->tc,
660                                                    vm->clib_time.
661                                                    last_cpu_time,
662                                                    ctx->snd_mss);
663   if (ctx->snd_space == 0 || ctx->snd_mss == 0)
664     {
665       vec_add1 (wrk->pending_event_vector, *e);
666       return SESSION_TX_NO_DATA;
667     }
668
669   /* Allow enqueuing of a new event */
670   svm_fifo_unset_event (ctx->s->tx_fifo);
671
672   /* Check how much we can pull. */
673   session_tx_set_dequeue_params (vm, ctx, VLIB_FRAME_SIZE - *n_tx_packets,
674                                  peek_data);
675
676   if (PREDICT_FALSE (!ctx->max_len_to_snd))
677     return SESSION_TX_NO_DATA;
678
679   n_bufs_needed = ctx->n_segs_per_evt * ctx->n_bufs_per_seg;
680   vec_validate_aligned (wrk->tx_buffers, n_bufs_needed - 1,
681                         CLIB_CACHE_LINE_BYTES);
682   n_bufs = vlib_buffer_alloc (vm, wrk->tx_buffers, n_bufs_needed);
683   if (PREDICT_FALSE (n_bufs < n_bufs_needed))
684     {
685       if (n_bufs)
686         vlib_buffer_free (vm, wrk->tx_buffers, n_bufs);
687       vec_add1 (wrk->pending_event_vector, *e);
688       return SESSION_TX_NO_BUFFERS;
689     }
690
691   /*
692    * Write until we fill up a frame
693    */
694   vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
695   if (PREDICT_FALSE (ctx->n_segs_per_evt > n_left_to_next))
696     {
697       ctx->n_segs_per_evt = n_left_to_next;
698       ctx->max_len_to_snd = ctx->snd_mss * n_left_to_next;
699     }
700   ctx->left_to_snd = ctx->max_len_to_snd;
701   n_left = ctx->n_segs_per_evt;
702
703   while (n_left >= 4)
704     {
705       vlib_buffer_t *b0, *b1;
706       u32 bi0, bi1;
707
708       pbi = wrk->tx_buffers[n_bufs - 3];
709       pb = vlib_get_buffer (vm, pbi);
710       vlib_prefetch_buffer_header (pb, STORE);
711       pbi = wrk->tx_buffers[n_bufs - 4];
712       pb = vlib_get_buffer (vm, pbi);
713       vlib_prefetch_buffer_header (pb, STORE);
714
715       to_next[0] = bi0 = wrk->tx_buffers[--n_bufs];
716       to_next[1] = bi1 = wrk->tx_buffers[--n_bufs];
717
718       b0 = vlib_get_buffer (vm, bi0);
719       b1 = vlib_get_buffer (vm, bi1);
720
721       session_tx_fill_buffer (vm, ctx, b0, &n_bufs, peek_data);
722       session_tx_fill_buffer (vm, ctx, b1, &n_bufs, peek_data);
723
724       ctx->transport_vft->push_header (ctx->tc, b0);
725       ctx->transport_vft->push_header (ctx->tc, b1);
726
727       to_next += 2;
728       n_left_to_next -= 2;
729       n_left -= 2;
730
731       VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b0);
732       VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b1);
733
734       vlib_validate_buffer_enqueue_x2 (vm, node, next_index, to_next,
735                                        n_left_to_next, bi0, bi1, next0,
736                                        next1);
737     }
738   while (n_left)
739     {
740       vlib_buffer_t *b0;
741       u32 bi0;
742
743       if (n_left > 1)
744         {
745           pbi = wrk->tx_buffers[n_bufs - 2];
746           pb = vlib_get_buffer (vm, pbi);
747           vlib_prefetch_buffer_header (pb, STORE);
748         }
749
750       to_next[0] = bi0 = wrk->tx_buffers[--n_bufs];
751       b0 = vlib_get_buffer (vm, bi0);
752       session_tx_fill_buffer (vm, ctx, b0, &n_bufs, peek_data);
753
754       /* Ask transport to push header after current_length and
755        * total_length_not_including_first_buffer are updated */
756       ctx->transport_vft->push_header (ctx->tc, b0);
757
758       to_next += 1;
759       n_left_to_next -= 1;
760       n_left -= 1;
761
762       VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b0);
763
764       vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
765                                        n_left_to_next, bi0, next0);
766     }
767
768   if (PREDICT_FALSE (n_trace > 0))
769     session_tx_trace_frame (vm, node, next_index, to_next,
770                             ctx->n_segs_per_evt, ctx->s, n_trace);
771   if (PREDICT_FALSE (n_bufs))
772     {
773       clib_warning ("not all buffers consumed");
774       vlib_buffer_free (vm, wrk->tx_buffers, n_bufs);
775     }
776   *n_tx_packets += ctx->n_segs_per_evt;
777   transport_connection_update_tx_stats (ctx->tc, ctx->max_len_to_snd);
778   vlib_put_next_frame (vm, node, next_index, n_left_to_next);
779
780   /* If we couldn't dequeue all bytes mark as partially read */
781   ASSERT (ctx->left_to_snd == 0);
782   if (ctx->max_len_to_snd < ctx->max_dequeue)
783     if (svm_fifo_set_event (ctx->s->tx_fifo))
784       vec_add1 (wrk->pending_event_vector, *e);
785
786   if (!peek_data
787       && ctx->transport_vft->transport_options.tx_type == TRANSPORT_TX_DGRAM)
788     {
789       /* Fix dgram pre header */
790       if (ctx->max_len_to_snd < ctx->max_dequeue)
791         svm_fifo_overwrite_head (ctx->s->tx_fifo, (u8 *) & ctx->hdr,
792                                  sizeof (session_dgram_pre_hdr_t));
793       /* More data needs to be read */
794       else if (svm_fifo_max_dequeue_cons (ctx->s->tx_fifo) > 0)
795         if (svm_fifo_set_event (ctx->s->tx_fifo))
796           vec_add1 (wrk->pending_event_vector, *e);
797
798       if (svm_fifo_needs_deq_ntf (ctx->s->tx_fifo, ctx->max_len_to_snd))
799         session_dequeue_notify (ctx->s);
800     }
801   return SESSION_TX_OK;
802 }
803
804 int
805 session_tx_fifo_peek_and_snd (vlib_main_t * vm, vlib_node_runtime_t * node,
806                               session_worker_t * wrk,
807                               session_event_t * e, int *n_tx_pkts)
808 {
809   return session_tx_fifo_read_and_snd_i (vm, node, wrk, e, n_tx_pkts, 1);
810 }
811
812 int
813 session_tx_fifo_dequeue_and_snd (vlib_main_t * vm, vlib_node_runtime_t * node,
814                                  session_worker_t * wrk,
815                                  session_event_t * e, int *n_tx_pkts)
816 {
817   return session_tx_fifo_read_and_snd_i (vm, node, wrk, e, n_tx_pkts, 0);
818 }
819
820 int
821 session_tx_fifo_dequeue_internal (vlib_main_t * vm,
822                                   vlib_node_runtime_t * node,
823                                   session_worker_t * wrk,
824                                   session_event_t * e, int *n_tx_pkts)
825 {
826   session_t *s = wrk->ctx.s;
827
828   if (PREDICT_FALSE (s->session_state >= SESSION_STATE_TRANSPORT_CLOSED))
829     return 0;
830   svm_fifo_unset_event (s->tx_fifo);
831   return transport_custom_tx (session_get_transport_proto (s), s);
832 }
833
834 always_inline session_t *
835 session_event_get_session (session_event_t * e, u8 thread_index)
836 {
837   return session_get_if_valid (e->session_index, thread_index);
838 }
839
840 static void
841 session_update_dispatch_period (session_worker_t * wrk, f64 now,
842                                 u32 thread_index)
843 {
844   if (wrk->last_tx_packets)
845     {
846       f64 sample = now - wrk->last_vlib_time;
847       wrk->dispatch_period = (wrk->dispatch_period + sample) * 0.5;
848     }
849   wrk->last_vlib_time = now;
850 }
851
852 static uword
853 session_queue_node_fn (vlib_main_t * vm, vlib_node_runtime_t * node,
854                        vlib_frame_t * frame)
855 {
856   session_main_t *smm = vnet_get_session_main ();
857   u32 thread_index = vm->thread_index, n_to_dequeue, n_events;
858   session_worker_t *wrk = &smm->wrk[thread_index];
859   session_event_t *e, *fifo_events;
860   svm_msg_q_msg_t _msg, *msg = &_msg;
861   f64 now = vlib_time_now (vm);
862   int n_tx_packets = 0, i, rv;
863   app_worker_t *app_wrk;
864   svm_msg_q_t *mq;
865   void (*fp) (void *);
866
867   SESSION_EVT_DBG (SESSION_EVT_POLL_GAP_TRACK, smm, thread_index);
868
869   /*
870    *  Update transport time
871    */
872   session_update_dispatch_period (wrk, now, thread_index);
873   transport_update_time (now, thread_index);
874
875   SESSION_EVT_DBG (SESSION_EVT_DEQ_NODE, 0);
876
877   /* Make sure postponed events are handled first */
878   fifo_events = wrk->free_event_vector;
879   vec_append (fifo_events, wrk->postponed_event_vector);
880   _vec_len (wrk->postponed_event_vector) = 0;
881
882   /* Try to dequeue what is available. Don't wait for lock.
883    * XXX: we may need priorities here */
884   mq = wrk->vpp_event_queue;
885   n_to_dequeue = svm_msg_q_size (mq);
886   if (n_to_dequeue && svm_msg_q_try_lock (mq) == 0)
887     {
888       for (i = 0; i < n_to_dequeue; i++)
889         {
890           vec_add2 (fifo_events, e, 1);
891           svm_msg_q_sub_w_lock (mq, msg);
892           /* Works because reply messages are smaller than a session evt.
893            * If we ever need to support bigger messages this needs to be
894            * fixed */
895           clib_memcpy_fast (e, svm_msg_q_msg_data (mq, msg), sizeof (*e));
896           svm_msg_q_free_msg (mq, msg);
897         }
898       svm_msg_q_unlock (mq);
899     }
900
901   vec_append (fifo_events, wrk->pending_event_vector);
902   vec_append (fifo_events, wrk->pending_disconnects);
903
904   _vec_len (wrk->pending_event_vector) = 0;
905   _vec_len (wrk->pending_disconnects) = 0;
906
907   n_events = vec_len (fifo_events);
908   if (PREDICT_FALSE (!n_events))
909     return 0;
910
911   for (i = 0; i < n_events; i++)
912     {
913       session_event_t *e;
914       session_t *s;
915
916       e = &fifo_events[i];
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               vec_add1 (wrk->postponed_event_vector, *e);
925               break;
926             }
927
928           s = session_event_get_session (e, thread_index);
929           if (PREDICT_FALSE (!s))
930             {
931               clib_warning ("session was freed!");
932               continue;
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, e,
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               continue;
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
959           /* Make sure session disconnects run after the pending list is
960            * drained, i.e., postpone if the first time. If not the first
961            * and the tx queue is still not empty, try to wait for some
962            * dispatch cycles */
963           if (!e->postponed
964               || (e->postponed < 200
965                   && svm_fifo_max_dequeue_cons (s->tx_fifo)))
966             {
967               e->postponed += 1;
968               vec_add1 (wrk->pending_disconnects, *e);
969               continue;
970             }
971
972           session_transport_close (s);
973           break;
974         case SESSION_IO_EVT_BUILTIN_RX:
975           s = session_event_get_session (e, thread_index);
976           if (PREDICT_FALSE (!s || s->session_state >= SESSION_STATE_CLOSING))
977             continue;
978           svm_fifo_unset_event (s->rx_fifo);
979           app_wrk = app_worker_get (s->app_wrk_index);
980           app_worker_builtin_rx (app_wrk, s);
981           break;
982         case SESSION_IO_EVT_BUILTIN_TX:
983           s = session_get_from_handle_if_valid (e->session_handle);
984           wrk->ctx.s = s;
985           if (PREDICT_TRUE (s != 0))
986             session_tx_fifo_dequeue_internal (vm, node, wrk, e,
987                                               &n_tx_packets);
988           break;
989         case SESSION_CTRL_EVT_RPC:
990           fp = e->rpc_args.fp;
991           (*fp) (e->rpc_args.arg);
992           break;
993         case SESSION_CTRL_EVT_DISCONNECTED:
994           session_mq_disconnected_handler (e->data);
995           break;
996         case SESSION_CTRL_EVT_ACCEPTED_REPLY:
997           session_mq_accepted_reply_handler (e->data);
998           break;
999         case SESSION_CTRL_EVT_CONNECTED_REPLY:
1000           break;
1001         case SESSION_CTRL_EVT_DISCONNECTED_REPLY:
1002           session_mq_disconnected_reply_handler (e->data);
1003           break;
1004         case SESSION_CTRL_EVT_RESET_REPLY:
1005           session_mq_reset_reply_handler (e->data);
1006           break;
1007         case SESSION_CTRL_EVT_WORKER_UPDATE:
1008           session_mq_worker_update_handler (e->data);
1009           break;
1010         default:
1011           clib_warning ("unhandled event type %d", e->event_type);
1012         }
1013     }
1014
1015   _vec_len (fifo_events) = 0;
1016   wrk->free_event_vector = fifo_events;
1017   wrk->last_tx_packets = n_tx_packets;
1018
1019   vlib_node_increment_counter (vm, session_queue_node.index,
1020                                SESSION_QUEUE_ERROR_TX, n_tx_packets);
1021
1022   SESSION_EVT_DBG (SESSION_EVT_DISPATCH_END, smm, thread_index);
1023
1024   return n_tx_packets;
1025 }
1026
1027 /* *INDENT-OFF* */
1028 VLIB_REGISTER_NODE (session_queue_node) =
1029 {
1030   .function = session_queue_node_fn,
1031   .name = "session-queue",
1032   .format_trace = format_session_queue_trace,
1033   .type = VLIB_NODE_TYPE_INPUT,
1034   .n_errors = ARRAY_LEN (session_queue_error_strings),
1035   .error_strings = session_queue_error_strings,
1036   .state = VLIB_NODE_STATE_DISABLED,
1037 };
1038 /* *INDENT-ON* */
1039
1040 void
1041 dump_thread_0_event_queue (void)
1042 {
1043   session_main_t *smm = vnet_get_session_main ();
1044   vlib_main_t *vm = &vlib_global_main;
1045   u32 my_thread_index = vm->thread_index;
1046   session_event_t _e, *e = &_e;
1047   svm_msg_q_ring_t *ring;
1048   session_t *s0;
1049   svm_msg_q_msg_t *msg;
1050   svm_msg_q_t *mq;
1051   int i, index;
1052
1053   mq = smm->wrk[my_thread_index].vpp_event_queue;
1054   index = mq->q->head;
1055
1056   for (i = 0; i < mq->q->cursize; i++)
1057     {
1058       msg = (svm_msg_q_msg_t *) (&mq->q->data[0] + mq->q->elsize * index);
1059       ring = svm_msg_q_ring (mq, msg->ring_index);
1060       clib_memcpy_fast (e, svm_msg_q_msg_data (mq, msg), ring->elsize);
1061
1062       switch (e->event_type)
1063         {
1064         case SESSION_IO_EVT_TX:
1065           s0 = session_event_get_session (e, my_thread_index);
1066           fformat (stdout, "[%04d] TX session %d\n", i, s0->session_index);
1067           break;
1068
1069         case SESSION_CTRL_EVT_CLOSE:
1070           s0 = session_get_from_handle (e->session_handle);
1071           fformat (stdout, "[%04d] disconnect session %d\n", i,
1072                    s0->session_index);
1073           break;
1074
1075         case SESSION_IO_EVT_BUILTIN_RX:
1076           s0 = session_event_get_session (e, my_thread_index);
1077           fformat (stdout, "[%04d] builtin_rx %d\n", i, s0->session_index);
1078           break;
1079
1080         case SESSION_CTRL_EVT_RPC:
1081           fformat (stdout, "[%04d] RPC call %llx with %llx\n",
1082                    i, (u64) (uword) (e->rpc_args.fp),
1083                    (u64) (uword) (e->rpc_args.arg));
1084           break;
1085
1086         default:
1087           fformat (stdout, "[%04d] unhandled event type %d\n",
1088                    i, e->event_type);
1089           break;
1090         }
1091
1092       index++;
1093
1094       if (index == mq->q->maxsize)
1095         index = 0;
1096     }
1097 }
1098
1099 static u8
1100 session_node_cmp_event (session_event_t * e, svm_fifo_t * f)
1101 {
1102   session_t *s;
1103   switch (e->event_type)
1104     {
1105     case SESSION_IO_EVT_RX:
1106     case SESSION_IO_EVT_TX:
1107     case SESSION_IO_EVT_BUILTIN_RX:
1108       if (e->session_index == f->master_session_index)
1109         return 1;
1110       break;
1111     case SESSION_CTRL_EVT_CLOSE:
1112       break;
1113     case SESSION_CTRL_EVT_RPC:
1114       s = session_get_from_handle (e->session_handle);
1115       if (!s)
1116         {
1117           clib_warning ("session has event but doesn't exist!");
1118           break;
1119         }
1120       if (s->rx_fifo == f || s->tx_fifo == f)
1121         return 1;
1122       break;
1123     default:
1124       break;
1125     }
1126   return 0;
1127 }
1128
1129 u8
1130 session_node_lookup_fifo_event (svm_fifo_t * f, session_event_t * e)
1131 {
1132   session_event_t *pending_event_vector, *evt;
1133   session_worker_t *wrk;
1134   int i, index, found = 0;
1135   svm_msg_q_msg_t *msg;
1136   svm_msg_q_ring_t *ring;
1137   svm_msg_q_t *mq;
1138   u8 thread_index;
1139
1140   ASSERT (e);
1141   thread_index = f->master_thread_index;
1142   wrk = session_main_get_worker (thread_index);
1143
1144   /*
1145    * Search evt queue
1146    */
1147   mq = wrk->vpp_event_queue;
1148   index = mq->q->head;
1149   for (i = 0; i < mq->q->cursize; i++)
1150     {
1151       msg = (svm_msg_q_msg_t *) (&mq->q->data[0] + mq->q->elsize * index);
1152       ring = svm_msg_q_ring (mq, msg->ring_index);
1153       clib_memcpy_fast (e, svm_msg_q_msg_data (mq, msg), ring->elsize);
1154       found = session_node_cmp_event (e, f);
1155       if (found)
1156         return 1;
1157       if (++index == mq->q->maxsize)
1158         index = 0;
1159     }
1160   /*
1161    * Search pending events vector
1162    */
1163   pending_event_vector = wrk->pending_event_vector;
1164   vec_foreach (evt, pending_event_vector)
1165   {
1166     found = session_node_cmp_event (evt, f);
1167     if (found)
1168       {
1169         clib_memcpy_fast (e, evt, sizeof (*evt));
1170         break;
1171       }
1172   }
1173   return found;
1174 }
1175
1176 static clib_error_t *
1177 session_queue_exit (vlib_main_t * vm)
1178 {
1179   if (vec_len (vlib_mains) < 2)
1180     return 0;
1181
1182   /*
1183    * Shut off (especially) worker-thread session nodes.
1184    * Otherwise, vpp can crash as the main thread unmaps the
1185    * API segment.
1186    */
1187   vlib_worker_thread_barrier_sync (vm);
1188   session_node_enable_disable (0 /* is_enable */ );
1189   vlib_worker_thread_barrier_release (vm);
1190   return 0;
1191 }
1192
1193 VLIB_MAIN_LOOP_EXIT_FUNCTION (session_queue_exit);
1194
1195 static uword
1196 session_queue_process (vlib_main_t * vm, vlib_node_runtime_t * rt,
1197                        vlib_frame_t * f)
1198 {
1199   f64 now, timeout = 1.0;
1200   uword *event_data = 0;
1201   uword event_type;
1202
1203   while (1)
1204     {
1205       vlib_process_wait_for_event_or_clock (vm, timeout);
1206       now = vlib_time_now (vm);
1207       event_type = vlib_process_get_events (vm, (uword **) & event_data);
1208
1209       switch (event_type)
1210         {
1211         case SESSION_Q_PROCESS_FLUSH_FRAMES:
1212           /* Flush the frames by updating all transports times */
1213           transport_update_time (now, 0);
1214           break;
1215         case SESSION_Q_PROCESS_STOP:
1216           timeout = 100000.0;
1217           break;
1218         case ~0:
1219           /* Timed out. Update time for all transports to trigger all
1220            * outstanding retransmits. */
1221           transport_update_time (now, 0);
1222           break;
1223         }
1224       vec_reset_length (event_data);
1225     }
1226   return 0;
1227 }
1228
1229 /* *INDENT-OFF* */
1230 VLIB_REGISTER_NODE (session_queue_process_node) =
1231 {
1232   .function = session_queue_process,
1233   .type = VLIB_NODE_TYPE_PROCESS,
1234   .name = "session-queue-process",
1235   .state = VLIB_NODE_STATE_DISABLED,
1236 };
1237 /* *INDENT-ON* */
1238
1239 static_always_inline uword
1240 session_queue_pre_input_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
1241                                 vlib_frame_t * frame)
1242 {
1243   session_main_t *sm = &session_main;
1244   if (!sm->wrk[0].vpp_event_queue)
1245     return 0;
1246   return session_queue_node_fn (vm, node, frame);
1247 }
1248
1249 /* *INDENT-OFF* */
1250 VLIB_REGISTER_NODE (session_queue_pre_input_node) =
1251 {
1252   .function = session_queue_pre_input_inline,
1253   .type = VLIB_NODE_TYPE_PRE_INPUT,
1254   .name = "session-queue-main",
1255   .state = VLIB_NODE_STATE_DISABLED,
1256 };
1257 /* *INDENT-ON* */
1258
1259 /*
1260  * fd.io coding-style-patch-verification: ON
1261  *
1262  * Local Variables:
1263  * eval: (c-set-style "gnu")
1264  * End:
1265  */