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