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