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