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