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