session: cleanup session tx function
[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/session_debug.h>
24 #include <svm/queue.h>
25
26 vlib_node_registration_t session_queue_node;
27
28 typedef struct
29 {
30   u32 session_index;
31   u32 server_thread_index;
32 } session_queue_trace_t;
33
34 /* packet trace format function */
35 static u8 *
36 format_session_queue_trace (u8 * s, va_list * args)
37 {
38   CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
39   CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
40   session_queue_trace_t *t = va_arg (*args, session_queue_trace_t *);
41
42   s = format (s, "SESSION_QUEUE: session index %d, server thread index %d",
43               t->session_index, t->server_thread_index);
44   return s;
45 }
46
47 vlib_node_registration_t session_queue_node;
48
49 #define foreach_session_queue_error             \
50 _(TX, "Packets transmitted")                    \
51 _(TIMER, "Timer events")                        \
52 _(NO_BUFFER, "Out of buffers")
53
54 typedef enum
55 {
56 #define _(sym,str) SESSION_QUEUE_ERROR_##sym,
57   foreach_session_queue_error
58 #undef _
59     SESSION_QUEUE_N_ERROR,
60 } session_queue_error_t;
61
62 static char *session_queue_error_strings[] = {
63 #define _(sym,string) string,
64   foreach_session_queue_error
65 #undef _
66 };
67
68 always_inline void
69 session_tx_trace_buffer (vlib_main_t * vm, vlib_node_runtime_t * node,
70                          u32 next_index, vlib_buffer_t * b,
71                          stream_session_t * s, u32 * n_trace)
72 {
73   session_queue_trace_t *t;
74   vlib_trace_buffer (vm, node, next_index, b, 1 /* follow_chain */ );
75   vlib_set_trace_count (vm, node, --*n_trace);
76   t = vlib_add_trace (vm, node, b, sizeof (*t));
77   t->session_index = s->session_index;
78   t->server_thread_index = s->thread_index;
79 }
80
81 always_inline void
82 session_tx_fifo_chain_tail (vlib_main_t * vm, session_tx_context_t * ctx,
83                             vlib_buffer_t * b, u16 * n_bufs, u8 peek_data)
84 {
85   session_manager_main_t *smm = &session_manager_main;
86   vlib_buffer_t *chain_b, *prev_b;
87   u32 chain_bi0, to_deq, left_from_seg;
88   u16 len_to_deq, n_bytes_read;
89   u8 *data, j;
90
91   b->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
92   b->total_length_not_including_first_buffer = 0;
93
94   chain_b = b;
95   left_from_seg = clib_min (ctx->snd_mss - b->current_length,
96                             ctx->left_to_snd);
97   to_deq = left_from_seg;
98   for (j = 1; j < ctx->n_bufs_per_seg; j++)
99     {
100       prev_b = chain_b;
101       len_to_deq = clib_min (to_deq, ctx->deq_per_buf);
102
103       *n_bufs -= 1;
104       chain_bi0 = smm->tx_buffers[ctx->s->thread_index][*n_bufs];
105       _vec_len (smm->tx_buffers[ctx->s->thread_index]) = *n_bufs;
106
107       chain_b = vlib_get_buffer (vm, chain_bi0);
108       chain_b->current_data = 0;
109       data = vlib_buffer_get_current (chain_b);
110       if (peek_data)
111         {
112           n_bytes_read = svm_fifo_peek (ctx->s->server_tx_fifo,
113                                         ctx->tx_offset, len_to_deq, data);
114           ctx->tx_offset += n_bytes_read;
115         }
116       else
117         {
118           if (ctx->transport_vft->tx_type == TRANSPORT_TX_DGRAM)
119             {
120               svm_fifo_t *f = ctx->s->server_tx_fifo;
121               session_dgram_hdr_t *hdr = &ctx->hdr;
122               u16 deq_now;
123               deq_now = clib_min (hdr->data_length - hdr->data_offset,
124                                   len_to_deq);
125               n_bytes_read = svm_fifo_peek (f, hdr->data_offset, deq_now,
126                                             data);
127               ASSERT (n_bytes_read > 0);
128
129               hdr->data_offset += n_bytes_read;
130               if (hdr->data_offset == hdr->data_length)
131                 svm_fifo_dequeue_drop (f, hdr->data_length);
132             }
133           else
134             n_bytes_read = svm_fifo_dequeue_nowait (ctx->s->server_tx_fifo,
135                                                     len_to_deq, data);
136         }
137       ASSERT (n_bytes_read == len_to_deq);
138       chain_b->current_length = n_bytes_read;
139       b->total_length_not_including_first_buffer += chain_b->current_length;
140
141       /* update previous buffer */
142       prev_b->next_buffer = chain_bi0;
143       prev_b->flags |= VLIB_BUFFER_NEXT_PRESENT;
144
145       /* update current buffer */
146       chain_b->next_buffer = 0;
147
148       to_deq -= n_bytes_read;
149       if (to_deq == 0)
150         break;
151     }
152   ASSERT (to_deq == 0
153           && b->total_length_not_including_first_buffer == left_from_seg);
154   ctx->left_to_snd -= left_from_seg;
155 }
156
157 always_inline int
158 session_output_try_get_buffers (vlib_main_t * vm,
159                                 session_manager_main_t * smm,
160                                 u32 thread_index, u16 * n_bufs, u32 wanted)
161 {
162   u32 bufs_alloc = 0, bufs_now;
163   vec_validate_aligned (smm->tx_buffers[thread_index], *n_bufs + wanted - 1,
164                         CLIB_CACHE_LINE_BYTES);
165   do
166     {
167       bufs_now =
168         vlib_buffer_alloc (vm,
169                            &smm->tx_buffers[thread_index][*n_bufs +
170                                                           bufs_alloc],
171                            wanted - bufs_alloc);
172       bufs_alloc += bufs_now;
173     }
174   while (bufs_now > 0 && ((bufs_alloc + *n_bufs < wanted)));
175
176   *n_bufs += bufs_alloc;
177   _vec_len (smm->tx_buffers[thread_index]) = *n_bufs;
178   return bufs_alloc;
179 }
180
181 always_inline void
182 session_tx_fill_buffer (vlib_main_t * vm, session_tx_context_t * ctx,
183                         vlib_buffer_t * b, u16 * n_bufs, u8 peek_data)
184 {
185   u32 len_to_deq;
186   u8 *data0;
187   int n_bytes_read;
188
189   /*
190    * Start with the first buffer in chain
191    */
192   b->error = 0;
193   b->flags = VNET_BUFFER_F_LOCALLY_ORIGINATED;
194   b->current_data = 0;
195   b->total_length_not_including_first_buffer = 0;
196
197   data0 = vlib_buffer_make_headroom (b, MAX_HDRS_LEN);
198   len_to_deq = clib_min (ctx->left_to_snd, ctx->deq_per_first_buf);
199
200   if (peek_data)
201     {
202       n_bytes_read = svm_fifo_peek (ctx->s->server_tx_fifo, ctx->tx_offset,
203                                     len_to_deq, data0);
204       ASSERT (n_bytes_read > 0);
205       /* Keep track of progress locally, transport is also supposed to
206        * increment it independently when pushing the header */
207       ctx->tx_offset += n_bytes_read;
208     }
209   else
210     {
211       if (ctx->transport_vft->tx_type == TRANSPORT_TX_DGRAM)
212         {
213           session_dgram_hdr_t *hdr = &ctx->hdr;
214           svm_fifo_t *f = ctx->s->server_tx_fifo;
215           u16 deq_now;
216           u32 offset;
217
218           ASSERT (hdr->data_length > hdr->data_offset);
219           deq_now = clib_min (hdr->data_length - hdr->data_offset,
220                               len_to_deq);
221           offset = hdr->data_offset + SESSION_CONN_HDR_LEN;
222           n_bytes_read = svm_fifo_peek (f, offset, deq_now, data0);
223           ASSERT (n_bytes_read > 0);
224
225           if (ctx->s->session_state == SESSION_STATE_LISTENING)
226             {
227               ip_copy (&ctx->tc->rmt_ip, &hdr->rmt_ip, ctx->tc->is_ip4);
228               ctx->tc->rmt_port = hdr->rmt_port;
229             }
230           hdr->data_offset += n_bytes_read;
231           if (hdr->data_offset == hdr->data_length)
232             {
233               offset = hdr->data_length + SESSION_CONN_HDR_LEN;
234               svm_fifo_dequeue_drop (f, offset);
235             }
236         }
237       else
238         {
239           n_bytes_read = svm_fifo_dequeue_nowait (ctx->s->server_tx_fifo,
240                                                   len_to_deq, data0);
241           ASSERT (n_bytes_read > 0);
242         }
243     }
244   b->current_length = n_bytes_read;
245   ctx->left_to_snd -= n_bytes_read;
246
247   /*
248    * Fill in the remaining buffers in the chain, if any
249    */
250   if (PREDICT_FALSE (ctx->n_bufs_per_seg > 1 && ctx->left_to_snd))
251     session_tx_fifo_chain_tail (vm, ctx, b, n_bufs, peek_data);
252
253   /* *INDENT-OFF* */
254   SESSION_EVT_DBG(SESSION_EVT_DEQ, s, ({
255         ed->data[0] = e->event_type;
256         ed->data[1] = max_dequeue;
257         ed->data[2] = len_to_deq;
258         ed->data[3] = left_to_snd;
259   }));
260   /* *INDENT-ON* */
261 }
262
263 always_inline u8
264 session_tx_not_ready (stream_session_t * s, u8 peek_data)
265 {
266   if (peek_data)
267     {
268       /* Can retransmit for closed sessions but can't send new data if
269        * session is not ready or closed */
270       if (s->session_state < SESSION_STATE_READY)
271         return 1;
272     }
273   return 0;
274 }
275
276 always_inline transport_connection_t *
277 session_tx_get_transport (session_tx_context_t * ctx, u8 peek_data)
278 {
279   if (peek_data)
280     {
281       return ctx->transport_vft->get_connection (ctx->s->connection_index,
282                                                  ctx->s->thread_index);
283     }
284   else
285     {
286       if (ctx->s->session_state == SESSION_STATE_LISTENING)
287         return ctx->transport_vft->get_listener (ctx->s->connection_index);
288       else
289         {
290           return ctx->transport_vft->get_connection (ctx->s->connection_index,
291                                                      ctx->s->thread_index);
292         }
293     }
294 }
295
296 always_inline void
297 session_tx_set_dequeue_params (vlib_main_t * vm, session_tx_context_t * ctx,
298                                u8 peek_data)
299 {
300   u32 n_bytes_per_buf, n_bytes_per_seg;
301   ctx->max_dequeue = svm_fifo_max_dequeue (ctx->s->server_tx_fifo);
302   if (peek_data)
303     {
304       /* Offset in rx fifo from where to peek data */
305       ctx->tx_offset = ctx->transport_vft->tx_fifo_offset (ctx->tc);
306       if (PREDICT_FALSE (ctx->tx_offset >= ctx->max_dequeue))
307         {
308           ctx->max_len_to_snd = 0;
309           return;
310         }
311       ctx->max_dequeue -= ctx->tx_offset;
312     }
313   else
314     {
315       if (ctx->transport_vft->tx_type == TRANSPORT_TX_DGRAM)
316         {
317           if (ctx->max_dequeue <= sizeof (ctx->hdr))
318             {
319               ctx->max_len_to_snd = 0;
320               return;
321             }
322           svm_fifo_peek (ctx->s->server_tx_fifo, 0, sizeof (ctx->hdr),
323                          (u8 *) & ctx->hdr);
324           ASSERT (ctx->hdr.data_length > ctx->hdr.data_offset);
325           ctx->max_dequeue = ctx->hdr.data_length - ctx->hdr.data_offset;
326         }
327     }
328   ASSERT (ctx->max_dequeue > 0);
329
330   /* Ensure we're not writing more than transport window allows */
331   if (ctx->max_dequeue < ctx->snd_space)
332     {
333       /* Constrained by tx queue. Try to send only fully formed segments */
334       ctx->max_len_to_snd =
335         (ctx->max_dequeue > ctx->snd_mss) ?
336         ctx->max_dequeue - ctx->max_dequeue % ctx->snd_mss : ctx->max_dequeue;
337       /* TODO Nagle ? */
338     }
339   else
340     {
341       /* Expectation is that snd_space0 is already a multiple of snd_mss */
342       ctx->max_len_to_snd = ctx->snd_space;
343     }
344
345   n_bytes_per_buf = vlib_buffer_free_list_buffer_size (vm,
346                                                        VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX);
347   ASSERT (n_bytes_per_buf > MAX_HDRS_LEN);
348   n_bytes_per_seg = MAX_HDRS_LEN + ctx->snd_mss;
349   ctx->n_bufs_per_seg = ceil ((double) n_bytes_per_seg / n_bytes_per_buf);
350   ctx->deq_per_buf = clib_min (ctx->snd_mss, n_bytes_per_buf);
351   ctx->deq_per_first_buf = clib_min (ctx->snd_mss,
352                                      n_bytes_per_buf - MAX_HDRS_LEN);
353 }
354
355 always_inline int
356 session_tx_fifo_read_and_snd_i (vlib_main_t * vm, vlib_node_runtime_t * node,
357                                 session_fifo_event_t * e,
358                                 stream_session_t * s, int *n_tx_packets,
359                                 u8 peek_data)
360 {
361   u32 next_index, next0, next1, next2, next3, *to_next, n_left_to_next;
362   u32 n_trace = vlib_get_trace_count (vm, node), n_packets = 0, pbi;
363   u32 n_bufs_per_frame, thread_index = s->thread_index;
364   session_manager_main_t *smm = &session_manager_main;
365   session_tx_context_t *ctx = &smm->ctx[thread_index];
366   transport_proto_t tp;
367   vlib_buffer_t *pb;
368   u16 n_bufs;
369
370   if (PREDICT_FALSE (session_tx_not_ready (s, peek_data)))
371     {
372       vec_add1 (smm->pending_event_vector[thread_index], *e);
373       return 0;
374     }
375
376   next_index = smm->session_type_to_next[s->session_type];
377   next0 = next1 = next2 = next3 = next_index;
378
379   tp = session_get_transport_proto (s);
380   ctx->s = s;
381   ctx->transport_vft = transport_protocol_get_vft (tp);
382   ctx->tc = session_tx_get_transport (ctx, peek_data);
383   ctx->snd_mss = ctx->transport_vft->send_mss (ctx->tc);
384   ctx->snd_space = ctx->transport_vft->send_space (ctx->tc);
385   if (ctx->snd_space == 0 || ctx->snd_mss == 0)
386     {
387       vec_add1 (smm->pending_event_vector[thread_index], *e);
388       return 0;
389     }
390
391   /* Allow enqueuing of a new event */
392   svm_fifo_unset_event (s->server_tx_fifo);
393
394   /* Check how much we can pull. */
395   session_tx_set_dequeue_params (vm, ctx, peek_data);
396   if (PREDICT_FALSE (!ctx->max_len_to_snd))
397     return 0;
398
399   n_bufs = vec_len (smm->tx_buffers[thread_index]);
400   ctx->left_to_snd = ctx->max_len_to_snd;
401
402   /*
403    * Make sure we have at least one full frame of buffers ready
404    */
405   n_bufs_per_frame = ctx->n_bufs_per_seg * VLIB_FRAME_SIZE;
406   if (n_bufs < n_bufs_per_frame)
407     {
408       session_output_try_get_buffers (vm, smm, thread_index, &n_bufs,
409                                       n_bufs_per_frame);
410       if (PREDICT_FALSE (n_bufs < n_bufs_per_frame))
411         {
412           vec_add1 (smm->pending_event_vector[thread_index], *e);
413           return -1;
414         }
415     }
416
417   /*
418    * Write until we fill up a frame
419    */
420   vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
421   while (ctx->left_to_snd && n_left_to_next)
422     {
423       while (ctx->left_to_snd > 3 * ctx->snd_mss && n_left_to_next >= 4)
424         {
425           vlib_buffer_t *b0, *b1;
426           u32 bi0, bi1;
427
428           pbi = smm->tx_buffers[thread_index][n_bufs - 3];
429           pb = vlib_get_buffer (vm, pbi);
430           vlib_prefetch_buffer_header (pb, STORE);
431           pbi = smm->tx_buffers[thread_index][n_bufs - 4];
432           pb = vlib_get_buffer (vm, pbi);
433           vlib_prefetch_buffer_header (pb, STORE);
434
435           to_next[0] = bi0 = smm->tx_buffers[thread_index][--n_bufs];
436           to_next[1] = bi1 = smm->tx_buffers[thread_index][--n_bufs];
437
438           b0 = vlib_get_buffer (vm, bi0);
439           b1 = vlib_get_buffer (vm, bi1);
440
441           session_tx_fill_buffer (vm, ctx, b0, &n_bufs, peek_data);
442           session_tx_fill_buffer (vm, ctx, b1, &n_bufs, peek_data);
443
444           ctx->transport_vft->push_header (ctx->tc, b0);
445           ctx->transport_vft->push_header (ctx->tc, b1);
446
447           to_next += 2;
448           n_left_to_next -= 2;
449           n_packets += 2;
450
451           VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b0);
452           VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b1);
453
454           if (PREDICT_FALSE (n_trace > 0))
455             {
456               session_tx_trace_buffer (vm, node, next_index, b0, s, &n_trace);
457               if (n_trace)
458                 session_tx_trace_buffer (vm, node, next_index, b1, s,
459                                          &n_trace);
460             }
461
462           vlib_validate_buffer_enqueue_x2 (vm, node, next_index, to_next,
463                                            n_left_to_next, bi0, bi1,
464                                            next0, next1);
465         }
466       while (ctx->left_to_snd && n_left_to_next)
467         {
468           vlib_buffer_t *b0;
469           u32 bi0;
470
471           ASSERT (n_bufs >= 1);
472           to_next[0] = bi0 = smm->tx_buffers[thread_index][--n_bufs];
473           b0 = vlib_get_buffer (vm, bi0);
474           session_tx_fill_buffer (vm, ctx, b0, &n_bufs, peek_data);
475
476           /* Ask transport to push header after current_length and
477            * total_length_not_including_first_buffer are updated */
478           ctx->transport_vft->push_header (ctx->tc, b0);
479
480           to_next += 1;
481           n_left_to_next -= 1;
482           n_packets += 1;
483
484           VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b0);
485           if (PREDICT_FALSE (n_trace > 0))
486             session_tx_trace_buffer (vm, node, next_index, b0, s, &n_trace);
487
488           vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
489                                            n_left_to_next, bi0, next0);
490         }
491     }
492   _vec_len (smm->tx_buffers[thread_index]) = n_bufs;
493   *n_tx_packets += n_packets;
494   vlib_put_next_frame (vm, node, next_index, n_left_to_next);
495
496   /* If we couldn't dequeue all bytes mark as partially read */
497   if (ctx->max_len_to_snd < ctx->max_dequeue)
498     if (svm_fifo_set_event (s->server_tx_fifo))
499       vec_add1 (smm->pending_event_vector[thread_index], *e);
500
501   if (!peek_data && ctx->transport_vft->tx_type == TRANSPORT_TX_DGRAM)
502     {
503       /* Fix dgram pre header */
504       if (ctx->max_len_to_snd < ctx->max_dequeue)
505         svm_fifo_overwrite_head (s->server_tx_fifo, (u8 *) & ctx->hdr,
506                                  sizeof (session_dgram_pre_hdr_t));
507       /* More data needs to be read */
508       else if (svm_fifo_max_dequeue (s->server_tx_fifo) > 0)
509         if (svm_fifo_set_event (s->server_tx_fifo))
510           vec_add1 (smm->pending_event_vector[thread_index], *e);
511     }
512   return 0;
513 }
514
515 int
516 session_tx_fifo_peek_and_snd (vlib_main_t * vm, vlib_node_runtime_t * node,
517                               session_fifo_event_t * e0,
518                               stream_session_t * s0, int *n_tx_pkts)
519 {
520   return session_tx_fifo_read_and_snd_i (vm, node, e0, s0, n_tx_pkts, 1);
521 }
522
523 int
524 session_tx_fifo_dequeue_and_snd (vlib_main_t * vm, vlib_node_runtime_t * node,
525                                  session_fifo_event_t * e0,
526                                  stream_session_t * s0, int *n_tx_pkts)
527 {
528   return session_tx_fifo_read_and_snd_i (vm, node, e0, s0, n_tx_pkts, 0);
529 }
530
531 int
532 session_tx_fifo_dequeue_internal (vlib_main_t * vm,
533                                   vlib_node_runtime_t * node,
534                                   session_fifo_event_t * e0,
535                                   stream_session_t * s0, int *n_tx_pkts)
536 {
537   application_t *app;
538   app = application_get (s0->opaque);
539   svm_fifo_unset_event (s0->server_tx_fifo);
540   return app->cb_fns.builtin_app_tx_callback (s0);
541 }
542
543 always_inline stream_session_t *
544 session_event_get_session (session_fifo_event_t * e, u8 thread_index)
545 {
546   return session_get_if_valid (e->fifo->master_session_index, thread_index);
547 }
548
549 void
550 dump_thread_0_event_queue (void)
551 {
552   session_manager_main_t *smm = vnet_get_session_manager_main ();
553   vlib_main_t *vm = &vlib_global_main;
554   u32 my_thread_index = vm->thread_index;
555   session_fifo_event_t _e, *e = &_e;
556   stream_session_t *s0;
557   int i, index;
558   i8 *headp;
559
560   svm_queue_t *q;
561   q = smm->vpp_event_queues[my_thread_index];
562
563   index = q->head;
564
565   for (i = 0; i < q->cursize; i++)
566     {
567       headp = (i8 *) (&q->data[0] + q->elsize * index);
568       clib_memcpy (e, headp, q->elsize);
569
570       switch (e->event_type)
571         {
572         case FIFO_EVENT_APP_TX:
573           s0 = session_event_get_session (e, my_thread_index);
574           fformat (stdout, "[%04d] TX session %d\n", i, s0->session_index);
575           break;
576
577         case FIFO_EVENT_DISCONNECT:
578           s0 = session_get_from_handle (e->session_handle);
579           fformat (stdout, "[%04d] disconnect session %d\n", i,
580                    s0->session_index);
581           break;
582
583         case FIFO_EVENT_BUILTIN_RX:
584           s0 = session_event_get_session (e, my_thread_index);
585           fformat (stdout, "[%04d] builtin_rx %d\n", i, s0->session_index);
586           break;
587
588         case FIFO_EVENT_RPC:
589           fformat (stdout, "[%04d] RPC call %llx with %llx\n",
590                    i, (u64) (e->rpc_args.fp), (u64) (e->rpc_args.arg));
591           break;
592
593         default:
594           fformat (stdout, "[%04d] unhandled event type %d\n",
595                    i, e->event_type);
596           break;
597         }
598
599       index++;
600
601       if (index == q->maxsize)
602         index = 0;
603     }
604 }
605
606 static u8
607 session_node_cmp_event (session_fifo_event_t * e, svm_fifo_t * f)
608 {
609   stream_session_t *s;
610   switch (e->event_type)
611     {
612     case FIFO_EVENT_APP_RX:
613     case FIFO_EVENT_APP_TX:
614     case FIFO_EVENT_BUILTIN_RX:
615       if (e->fifo == f)
616         return 1;
617       break;
618     case FIFO_EVENT_DISCONNECT:
619       break;
620     case FIFO_EVENT_RPC:
621       s = session_get_from_handle (e->session_handle);
622       if (!s)
623         {
624           clib_warning ("session has event but doesn't exist!");
625           break;
626         }
627       if (s->server_rx_fifo == f || s->server_tx_fifo == f)
628         return 1;
629       break;
630     default:
631       break;
632     }
633   return 0;
634 }
635
636 u8
637 session_node_lookup_fifo_event (svm_fifo_t * f, session_fifo_event_t * e)
638 {
639   session_manager_main_t *smm = vnet_get_session_manager_main ();
640   svm_queue_t *q;
641   session_fifo_event_t *pending_event_vector, *evt;
642   int i, index, found = 0;
643   i8 *headp;
644   u8 thread_index;
645
646   ASSERT (e);
647   thread_index = f->master_thread_index;
648   /*
649    * Search evt queue
650    */
651   q = smm->vpp_event_queues[thread_index];
652   index = q->head;
653   for (i = 0; i < q->cursize; i++)
654     {
655       headp = (i8 *) (&q->data[0] + q->elsize * index);
656       clib_memcpy (e, headp, q->elsize);
657       found = session_node_cmp_event (e, f);
658       if (found)
659         return 1;
660       if (++index == q->maxsize)
661         index = 0;
662     }
663   /*
664    * Search pending events vector
665    */
666   pending_event_vector = smm->pending_event_vector[thread_index];
667   vec_foreach (evt, pending_event_vector)
668   {
669     found = session_node_cmp_event (evt, f);
670     if (found)
671       {
672         clib_memcpy (e, evt, sizeof (*evt));
673         break;
674       }
675   }
676   return found;
677 }
678
679 static uword
680 session_queue_node_fn (vlib_main_t * vm, vlib_node_runtime_t * node,
681                        vlib_frame_t * frame)
682 {
683   session_manager_main_t *smm = vnet_get_session_manager_main ();
684   session_fifo_event_t *my_pending_event_vector, *pending_disconnects, *e;
685   session_fifo_event_t *my_fifo_events;
686   u32 n_to_dequeue, n_events;
687   svm_queue_t *q;
688   application_t *app;
689   int n_tx_packets = 0;
690   u32 my_thread_index = vm->thread_index;
691   int i, rv;
692   f64 now = vlib_time_now (vm);
693   void (*fp) (void *);
694
695   SESSION_EVT_DBG (SESSION_EVT_POLL_GAP_TRACK, smm, my_thread_index);
696
697   /*
698    *  Update transport time
699    */
700   transport_update_time (now, my_thread_index);
701
702   /*
703    * Get vpp queue events
704    */
705   q = smm->vpp_event_queues[my_thread_index];
706   if (PREDICT_FALSE (q == 0))
707     return 0;
708
709   my_fifo_events = smm->free_event_vector[my_thread_index];
710
711   /* min number of events we can dequeue without blocking */
712   n_to_dequeue = q->cursize;
713   my_pending_event_vector = smm->pending_event_vector[my_thread_index];
714   pending_disconnects = smm->pending_disconnects[my_thread_index];
715
716   if (!n_to_dequeue && !vec_len (my_pending_event_vector)
717       && !vec_len (pending_disconnects))
718     return 0;
719
720   SESSION_EVT_DBG (SESSION_EVT_DEQ_NODE, 0);
721
722   /*
723    * If we didn't manage to process previous events try going
724    * over them again without dequeuing new ones.
725    */
726   /* XXX: Block senders to sessions that can't keep up */
727   if (0 && vec_len (my_pending_event_vector) >= 100)
728     {
729       clib_warning ("too many fifo events unsolved");
730       goto skip_dequeue;
731     }
732
733   /* See you in the next life, don't be late */
734   if (pthread_mutex_trylock (&q->mutex))
735     return 0;
736
737   for (i = 0; i < n_to_dequeue; i++)
738     {
739       vec_add2 (my_fifo_events, e, 1);
740       svm_queue_sub_raw (q, (u8 *) e);
741     }
742
743   /* The other side of the connection is not polling */
744   if (q->cursize < (q->maxsize / 8))
745     (void) pthread_cond_broadcast (&q->condvar);
746   pthread_mutex_unlock (&q->mutex);
747
748   vec_append (my_fifo_events, my_pending_event_vector);
749   vec_append (my_fifo_events, smm->pending_disconnects[my_thread_index]);
750
751   _vec_len (my_pending_event_vector) = 0;
752   smm->pending_event_vector[my_thread_index] = my_pending_event_vector;
753   _vec_len (smm->pending_disconnects[my_thread_index]) = 0;
754
755 skip_dequeue:
756   n_events = vec_len (my_fifo_events);
757   for (i = 0; i < n_events; i++)
758     {
759       stream_session_t *s0;     /* $$$ prefetch 1 ahead maybe */
760       session_fifo_event_t *e0;
761
762       e0 = &my_fifo_events[i];
763
764       switch (e0->event_type)
765         {
766         case FIFO_EVENT_APP_TX:
767           s0 = session_event_get_session (e0, my_thread_index);
768
769           if (PREDICT_FALSE (!s0))
770             {
771               clib_warning ("It's dead, Jim!");
772               continue;
773             }
774           /* Spray packets in per session type frames, since they go to
775            * different nodes */
776           rv = (smm->session_tx_fns[s0->session_type]) (vm, node, e0, s0,
777                                                         &n_tx_packets);
778           /* Out of buffers */
779           if (PREDICT_FALSE (rv < 0))
780             {
781               vlib_node_increment_counter (vm, node->node_index,
782                                            SESSION_QUEUE_ERROR_NO_BUFFER, 1);
783               continue;
784             }
785           break;
786         case FIFO_EVENT_DISCONNECT:
787           /* Make sure disconnects run after the pending list is drained */
788           s0 = session_get_from_handle (e0->session_handle);
789           if (!e0->postponed || svm_fifo_max_dequeue (s0->server_tx_fifo))
790             {
791               e0->postponed = 1;
792               vec_add1 (smm->pending_disconnects[my_thread_index], *e0);
793               continue;
794             }
795           stream_session_disconnect_transport (s0);
796           break;
797         case FIFO_EVENT_BUILTIN_RX:
798           s0 = session_event_get_session (e0, my_thread_index);
799           if (PREDICT_FALSE (!s0))
800             continue;
801           svm_fifo_unset_event (s0->server_rx_fifo);
802           app = application_get (s0->app_index);
803           app->cb_fns.builtin_app_rx_callback (s0);
804           break;
805         case FIFO_EVENT_RPC:
806           fp = e0->rpc_args.fp;
807           (*fp) (e0->rpc_args.arg);
808           break;
809
810         default:
811           clib_warning ("unhandled event type %d", e0->event_type);
812         }
813     }
814
815   _vec_len (my_fifo_events) = 0;
816   smm->free_event_vector[my_thread_index] = my_fifo_events;
817
818   vlib_node_increment_counter (vm, session_queue_node.index,
819                                SESSION_QUEUE_ERROR_TX, n_tx_packets);
820
821   SESSION_EVT_DBG (SESSION_EVT_DEQ_NODE, 1);
822
823   return n_tx_packets;
824 }
825
826 /* *INDENT-OFF* */
827 VLIB_REGISTER_NODE (session_queue_node) =
828 {
829   .function = session_queue_node_fn,
830   .name = "session-queue",
831   .format_trace = format_session_queue_trace,
832   .type = VLIB_NODE_TYPE_INPUT,
833   .n_errors = ARRAY_LEN (session_queue_error_strings),
834   .error_strings = session_queue_error_strings,
835   .state = VLIB_NODE_STATE_DISABLED,
836 };
837 /* *INDENT-ON* */
838
839 static clib_error_t *
840 session_queue_exit (vlib_main_t * vm)
841 {
842   if (vec_len (vlib_mains) < 2)
843     return 0;
844
845   /*
846    * Shut off (especially) worker-thread session nodes.
847    * Otherwise, vpp can crash as the main thread unmaps the
848    * API segment.
849    */
850   vlib_worker_thread_barrier_sync (vm);
851   session_node_enable_disable (0 /* is_enable */ );
852   vlib_worker_thread_barrier_release (vm);
853   return 0;
854 }
855
856 VLIB_MAIN_LOOP_EXIT_FUNCTION (session_queue_exit);
857
858 /*
859  * fd.io coding-style-patch-verification: ON
860  *
861  * Local Variables:
862  * eval: (c-set-style "gnu")
863  * End:
864  */