session: detach server from client on connect failure
[vpp.git] / src / vnet / session / application_local.c
1 /*
2  * Copyright (c) 2019 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 <vnet/session/application_local.h>
17 #include <vnet/session/session.h>
18
19 typedef enum ct_segment_flags_
20 {
21   CT_SEGMENT_F_CLIENT_DETACHED = 1 << 0,
22   CT_SEGMENT_F_SERVER_DETACHED = 1 << 1,
23 } ct_segment_flags_t;
24
25 typedef struct ct_segment_
26 {
27   u32 client_n_sessions;
28   u32 server_n_sessions;
29   u32 seg_ctx_index;
30   u32 ct_seg_index;
31   u32 segment_index;
32   ct_segment_flags_t flags;
33 } ct_segment_t;
34
35 typedef struct ct_segments_
36 {
37   u32 sm_index;
38   u32 server_wrk;
39   u32 client_wrk;
40   u32 fifo_pair_bytes;
41   ct_segment_t *segments;
42 } ct_segments_ctx_t;
43
44 typedef struct ct_cleanup_req_
45 {
46   u32 ct_index;
47 } ct_cleanup_req_t;
48
49 typedef struct ct_worker_
50 {
51   ct_connection_t *connections;       /**< Per-worker connection pools */
52   u32 *pending_connects;              /**< Fifo of pending ho indices */
53   ct_cleanup_req_t *pending_cleanups; /**< Fifo of pending indices */
54   u8 have_connects;                   /**< Set if connect rpc pending */
55   u8 have_cleanups;                   /**< Set if cleanup rpc pending */
56 } ct_worker_t;
57
58 typedef struct ct_main_
59 {
60   ct_worker_t *wrk;                     /**< Per-worker state */
61   u32 n_workers;                        /**< Number of vpp workers */
62   u32 n_sessions;                       /**< Cumulative sessions counter */
63   u32 *ho_reusable;                     /**< Vector of reusable ho indices */
64   clib_spinlock_t ho_reuseable_lock;    /**< Lock for reusable ho indices */
65   clib_rwlock_t app_segs_lock;          /**< RW lock for seg contexts */
66   uword *app_segs_ctxs_table;           /**< App handle to segment pool map */
67   ct_segments_ctx_t *app_seg_ctxs;      /**< Pool of ct segment contexts */
68 } ct_main_t;
69
70 static ct_main_t ct_main;
71
72 static inline ct_worker_t *
73 ct_worker_get (u32 thread_index)
74 {
75   return &ct_main.wrk[thread_index];
76 }
77
78 static ct_connection_t *
79 ct_connection_alloc (u32 thread_index)
80 {
81   ct_worker_t *wrk = ct_worker_get (thread_index);
82   ct_connection_t *ct;
83
84   pool_get_zero (wrk->connections, ct);
85   ct->c_c_index = ct - wrk->connections;
86   ct->c_thread_index = thread_index;
87   ct->client_wrk = ~0;
88   ct->server_wrk = ~0;
89   ct->seg_ctx_index = ~0;
90   ct->ct_seg_index = ~0;
91   return ct;
92 }
93
94 static ct_connection_t *
95 ct_connection_get (u32 ct_index, u32 thread_index)
96 {
97   ct_worker_t *wrk = ct_worker_get (thread_index);
98
99   if (pool_is_free_index (wrk->connections, ct_index))
100     return 0;
101   return pool_elt_at_index (wrk->connections, ct_index);
102 }
103
104 static void
105 ct_connection_free (ct_connection_t * ct)
106 {
107   ct_worker_t *wrk = ct_worker_get (ct->c_thread_index);
108
109   if (CLIB_DEBUG)
110     {
111       clib_memset (ct, 0xfc, sizeof (*ct));
112       pool_put (wrk->connections, ct);
113       return;
114     }
115   pool_put (wrk->connections, ct);
116 }
117
118 static ct_connection_t *
119 ct_half_open_alloc (void)
120 {
121   ct_main_t *cm = &ct_main;
122   u32 *hip;
123
124   clib_spinlock_lock (&cm->ho_reuseable_lock);
125   vec_foreach (hip, cm->ho_reusable)
126     pool_put_index (cm->wrk[0].connections, *hip);
127   vec_reset_length (cm->ho_reusable);
128   clib_spinlock_unlock (&cm->ho_reuseable_lock);
129
130   return ct_connection_alloc (0);
131 }
132
133 void
134 ct_half_open_add_reusable (u32 ho_index)
135 {
136   ct_main_t *cm = &ct_main;
137
138   clib_spinlock_lock (&cm->ho_reuseable_lock);
139   vec_add1 (cm->ho_reusable, ho_index);
140   clib_spinlock_unlock (&cm->ho_reuseable_lock);
141 }
142
143 session_t *
144 ct_session_get_peer (session_t * s)
145 {
146   ct_connection_t *ct, *peer_ct;
147   ct = ct_connection_get (s->connection_index, s->thread_index);
148   peer_ct = ct_connection_get (ct->peer_index, s->thread_index);
149   return session_get (peer_ct->c_s_index, s->thread_index);
150 }
151
152 void
153 ct_session_endpoint (session_t * ll, session_endpoint_t * sep)
154 {
155   ct_connection_t *ct;
156   ct = (ct_connection_t *) session_get_transport (ll);
157   sep->transport_proto = ct->actual_tp;
158   sep->port = ct->c_lcl_port;
159   sep->is_ip4 = ct->c_is_ip4;
160   ip_copy (&sep->ip, &ct->c_lcl_ip, ct->c_is_ip4);
161 }
162
163 static void
164 ct_set_invalid_app_wrk (ct_connection_t *ct, u8 is_client)
165 {
166   ct_connection_t *peer_ct;
167
168   peer_ct = ct_connection_get (ct->peer_index, ct->c_thread_index);
169
170   if (is_client)
171     {
172       ct->client_wrk = APP_INVALID_INDEX;
173       if (peer_ct)
174         ct->client_wrk = APP_INVALID_INDEX;
175     }
176   else
177     {
178       ct->server_wrk = APP_INVALID_INDEX;
179       if (peer_ct)
180         ct->server_wrk = APP_INVALID_INDEX;
181     }
182 }
183
184 static void
185 ct_session_dealloc_fifos (ct_connection_t *ct, svm_fifo_t *rx_fifo,
186                           svm_fifo_t *tx_fifo)
187 {
188   ct_segments_ctx_t *seg_ctx;
189   ct_main_t *cm = &ct_main;
190   segment_manager_t *sm;
191   app_worker_t *app_wrk;
192   ct_segment_t *ct_seg;
193   fifo_segment_t *fs;
194   u32 seg_index;
195   session_t *s;
196   int cnt;
197
198   /*
199    * Cleanup fifos
200    */
201
202   sm = segment_manager_get (rx_fifo->segment_manager);
203   seg_index = rx_fifo->segment_index;
204
205   fs = segment_manager_get_segment_w_lock (sm, seg_index);
206   fifo_segment_free_fifo (fs, rx_fifo);
207   fifo_segment_free_fifo (fs, tx_fifo);
208   segment_manager_segment_reader_unlock (sm);
209
210   /*
211    * Atomically update segment context with readers lock
212    */
213
214   clib_rwlock_reader_lock (&cm->app_segs_lock);
215
216   seg_ctx = pool_elt_at_index (cm->app_seg_ctxs, ct->seg_ctx_index);
217   ct_seg = pool_elt_at_index (seg_ctx->segments, ct->ct_seg_index);
218
219   if (ct->flags & CT_CONN_F_CLIENT)
220     {
221       cnt =
222         __atomic_sub_fetch (&ct_seg->client_n_sessions, 1, __ATOMIC_RELAXED);
223     }
224   else
225     {
226       cnt =
227         __atomic_sub_fetch (&ct_seg->server_n_sessions, 1, __ATOMIC_RELAXED);
228     }
229
230   clib_rwlock_reader_unlock (&cm->app_segs_lock);
231
232   /*
233    * No need to do any app updates, return
234    */
235   ASSERT (cnt >= 0);
236   if (cnt)
237     return;
238
239   /*
240    * Grab exclusive lock and update flags unless some other thread
241    * added more sessions
242    */
243   clib_rwlock_writer_lock (&cm->app_segs_lock);
244
245   seg_ctx = pool_elt_at_index (cm->app_seg_ctxs, ct->seg_ctx_index);
246   ct_seg = pool_elt_at_index (seg_ctx->segments, ct->ct_seg_index);
247   if (ct->flags & CT_CONN_F_CLIENT)
248     {
249       cnt = ct_seg->client_n_sessions;
250       if (cnt)
251         goto done;
252       ct_seg->flags |= CT_SEGMENT_F_CLIENT_DETACHED;
253       s = session_get (ct->c_s_index, ct->c_thread_index);
254       if (s->app_wrk_index == APP_INVALID_INDEX)
255         ct_set_invalid_app_wrk (ct, 1 /* is_client */);
256     }
257   else
258     {
259       cnt = ct_seg->server_n_sessions;
260       if (cnt)
261         goto done;
262       ct_seg->flags |= CT_SEGMENT_F_SERVER_DETACHED;
263       s = session_get (ct->c_s_index, ct->c_thread_index);
264       if (s->app_wrk_index == APP_INVALID_INDEX)
265         ct_set_invalid_app_wrk (ct, 0 /* is_client */);
266     }
267
268   if (!(ct_seg->flags & CT_SEGMENT_F_CLIENT_DETACHED) ||
269       !(ct_seg->flags & CT_SEGMENT_F_SERVER_DETACHED))
270     goto done;
271
272   /*
273    * Remove segment context because both client and server detached
274    */
275
276   pool_put_index (seg_ctx->segments, ct->ct_seg_index);
277
278   /*
279    * No more segment indices left, remove the segments context
280    */
281   if (!pool_elts (seg_ctx->segments))
282     {
283       u64 table_handle = seg_ctx->client_wrk << 16 | seg_ctx->server_wrk;
284       table_handle = (u64) seg_ctx->sm_index << 32 | table_handle;
285       hash_unset (cm->app_segs_ctxs_table, table_handle);
286       pool_free (seg_ctx->segments);
287       pool_put_index (cm->app_seg_ctxs, ct->seg_ctx_index);
288     }
289
290   /*
291    * Segment to be removed so notify both apps
292    */
293
294   app_wrk = app_worker_get_if_valid (ct->client_wrk);
295   /* Determine if client app still needs notification, i.e., if it is
296    * still attached. If client detached and this is the last ct session
297    * on this segment, then its connects segment manager should also be
298    * detached, so do not send notification */
299   if (app_wrk)
300     {
301       segment_manager_t *csm;
302       csm = app_worker_get_connect_segment_manager (app_wrk);
303       if (!segment_manager_app_detached (csm))
304         app_worker_del_segment_notify (app_wrk, ct->segment_handle);
305     }
306
307   if (!segment_manager_app_detached (sm))
308     {
309       app_wrk = app_worker_get (ct->server_wrk);
310       app_worker_del_segment_notify (app_wrk, ct->segment_handle);
311     }
312
313   segment_manager_lock_and_del_segment (sm, seg_index);
314
315   /* Cleanup segment manager if needed. If server detaches there's a chance
316    * the client's sessions will hold up segment removal */
317   if (segment_manager_app_detached (sm) && !segment_manager_has_fifos (sm))
318     segment_manager_free_safe (sm);
319
320 done:
321
322   clib_rwlock_writer_unlock (&cm->app_segs_lock);
323 }
324
325 int
326 ct_session_connect_notify (session_t *ss, session_error_t err)
327 {
328   u32 ss_index, opaque, thread_index;
329   ct_connection_t *sct, *cct;
330   app_worker_t *client_wrk;
331   session_t *cs;
332
333   ss_index = ss->session_index;
334   thread_index = ss->thread_index;
335   sct = (ct_connection_t *) session_get_transport (ss);
336   client_wrk = app_worker_get (sct->client_wrk);
337   opaque = sct->client_opaque;
338
339   cct = ct_connection_get (sct->peer_index, thread_index);
340
341   /* Client closed while waiting for reply from server */
342   if (PREDICT_FALSE (!cct))
343     {
344       session_transport_closing_notify (&sct->connection);
345       session_transport_delete_notify (&sct->connection);
346       ct_connection_free (sct);
347       return 0;
348     }
349
350   session_half_open_delete_notify (&cct->connection);
351   cct->flags &= ~CT_CONN_F_HALF_OPEN;
352
353   if (PREDICT_FALSE (err))
354     goto connect_error;
355
356   /*
357    * Alloc client session
358    */
359
360   cs = session_alloc (thread_index);
361   ss = session_get (ss_index, thread_index);
362   cs->session_type = ss->session_type;
363   cs->listener_handle = SESSION_INVALID_HANDLE;
364   cs->session_state = SESSION_STATE_CONNECTING;
365   cs->app_wrk_index = client_wrk->wrk_index;
366   cs->connection_index = cct->c_c_index;
367   cct->c_s_index = cs->session_index;
368
369   /* This will allocate fifos for the session. They won't be used for
370    * exchanging data but they will be used to close the connection if
371    * the segment manager/worker is freed */
372   if ((err = app_worker_init_connected (client_wrk, cs)))
373     {
374       session_free (cs);
375       session_close (ss);
376       err = SESSION_E_ALLOC;
377       goto connect_error;
378     }
379
380   cs->session_state = SESSION_STATE_CONNECTING;
381
382   if (app_worker_connect_notify (client_wrk, cs, 0, opaque))
383     {
384       segment_manager_dealloc_fifos (cs->rx_fifo, cs->tx_fifo);
385       session_free (cs);
386       session_close (ss);
387       goto cleanup_client;
388     }
389
390   cs = session_get (cct->c_s_index, cct->c_thread_index);
391   cs->session_state = SESSION_STATE_READY;
392
393   return 0;
394
395 connect_error:
396
397   app_worker_connect_notify (client_wrk, 0, err, cct->client_opaque);
398
399 cleanup_client:
400
401   sct->peer_index = ~0;
402
403   if (cct->client_rx_fifo)
404     ct_session_dealloc_fifos (cct, cct->client_rx_fifo, cct->client_tx_fifo);
405   ct_connection_free (cct);
406   return -1;
407 }
408
409 static inline ct_segment_t *
410 ct_lookup_free_segment (ct_main_t *cm, segment_manager_t *sm,
411                         u32 seg_ctx_index)
412 {
413   uword free_bytes, max_free_bytes;
414   ct_segment_t *ct_seg, *res = 0;
415   ct_segments_ctx_t *seg_ctx;
416   fifo_segment_t *fs;
417   u32 max_fifos;
418
419   seg_ctx = pool_elt_at_index (cm->app_seg_ctxs, seg_ctx_index);
420   max_free_bytes = seg_ctx->fifo_pair_bytes;
421
422   pool_foreach (ct_seg, seg_ctx->segments)
423     {
424       /* Client or server has detached so segment cannot be used */
425       fs = segment_manager_get_segment (sm, ct_seg->segment_index);
426       free_bytes = fifo_segment_available_bytes (fs);
427       max_fifos = fifo_segment_size (fs) / seg_ctx->fifo_pair_bytes;
428       if (free_bytes > max_free_bytes &&
429           fifo_segment_num_fifos (fs) / 2 < max_fifos)
430         {
431           max_free_bytes = free_bytes;
432           res = ct_seg;
433         }
434     }
435
436   return res;
437 }
438
439 static ct_segment_t *
440 ct_alloc_segment (ct_main_t *cm, app_worker_t *server_wrk, u64 table_handle,
441                   segment_manager_t *sm, u32 client_wrk_index)
442 {
443   u32 seg_ctx_index = ~0, sm_index, pair_bytes;
444   segment_manager_props_t *props;
445   const u32 margin = 16 << 10;
446   ct_segments_ctx_t *seg_ctx;
447   app_worker_t *client_wrk;
448   u64 seg_size, seg_handle;
449   application_t *server;
450   ct_segment_t *ct_seg;
451   uword *spp;
452   int fs_index;
453
454   server = application_get (server_wrk->app_index);
455   props = application_segment_manager_properties (server);
456   sm_index = segment_manager_index (sm);
457   pair_bytes = props->rx_fifo_size + props->tx_fifo_size + margin;
458
459   /*
460    * Make sure another thread did not alloc a segment while acquiring the lock
461    */
462
463   spp = hash_get (cm->app_segs_ctxs_table, table_handle);
464   if (spp)
465     {
466       seg_ctx_index = *spp;
467       ct_seg = ct_lookup_free_segment (cm, sm, seg_ctx_index);
468       if (ct_seg)
469         return ct_seg;
470     }
471
472   /*
473    * No segment, try to alloc one and notify the server and the client.
474    * Make sure the segment is not used for other fifos
475    */
476   seg_size = clib_max (props->segment_size, 128 << 20);
477   fs_index =
478     segment_manager_add_segment2 (sm, seg_size, FIFO_SEGMENT_F_CUSTOM_USE);
479   if (fs_index < 0)
480     return 0;
481
482   if (seg_ctx_index == ~0)
483     {
484       pool_get_zero (cm->app_seg_ctxs, seg_ctx);
485       seg_ctx_index = seg_ctx - cm->app_seg_ctxs;
486       hash_set (cm->app_segs_ctxs_table, table_handle, seg_ctx_index);
487       seg_ctx->server_wrk = server_wrk->wrk_index;
488       seg_ctx->client_wrk = client_wrk_index;
489       seg_ctx->sm_index = sm_index;
490       seg_ctx->fifo_pair_bytes = pair_bytes;
491     }
492   else
493     {
494       seg_ctx = pool_elt_at_index (cm->app_seg_ctxs, seg_ctx_index);
495     }
496
497   pool_get_zero (seg_ctx->segments, ct_seg);
498   ct_seg->segment_index = fs_index;
499   ct_seg->server_n_sessions = 0;
500   ct_seg->client_n_sessions = 0;
501   ct_seg->ct_seg_index = ct_seg - seg_ctx->segments;
502   ct_seg->seg_ctx_index = seg_ctx_index;
503
504   /* New segment, notify the server and client */
505   seg_handle = segment_manager_make_segment_handle (sm_index, fs_index);
506   if (app_worker_add_segment_notify (server_wrk, seg_handle))
507     goto error;
508
509   client_wrk = app_worker_get (client_wrk_index);
510   if (app_worker_add_segment_notify (client_wrk, seg_handle))
511     {
512       app_worker_del_segment_notify (server_wrk, seg_handle);
513       goto error;
514     }
515
516   return ct_seg;
517
518 error:
519
520   segment_manager_lock_and_del_segment (sm, fs_index);
521   pool_put_index (seg_ctx->segments, ct_seg->seg_ctx_index);
522   return 0;
523 }
524
525 static int
526 ct_init_accepted_session (app_worker_t *server_wrk, ct_connection_t *ct,
527                           session_t *ls, session_t *ll)
528 {
529   segment_manager_props_t *props;
530   u64 seg_handle, table_handle;
531   u32 sm_index, fs_index = ~0;
532   ct_segments_ctx_t *seg_ctx;
533   ct_main_t *cm = &ct_main;
534   application_t *server;
535   segment_manager_t *sm;
536   ct_segment_t *ct_seg;
537   fifo_segment_t *fs;
538   uword *spp;
539   int rv;
540
541   sm = app_worker_get_listen_segment_manager (server_wrk, ll);
542   sm_index = segment_manager_index (sm);
543   server = application_get (server_wrk->app_index);
544   props = application_segment_manager_properties (server);
545
546   table_handle = ct->client_wrk << 16 | server_wrk->wrk_index;
547   table_handle = (u64) sm_index << 32 | table_handle;
548
549   /*
550    * Check if we already have a segment that can hold the fifos
551    */
552
553   clib_rwlock_reader_lock (&cm->app_segs_lock);
554
555   spp = hash_get (cm->app_segs_ctxs_table, table_handle);
556   if (spp)
557     {
558       ct_seg = ct_lookup_free_segment (cm, sm, *spp);
559       if (ct_seg)
560         {
561           ct->seg_ctx_index = ct_seg->seg_ctx_index;
562           ct->ct_seg_index = ct_seg->ct_seg_index;
563           fs_index = ct_seg->segment_index;
564           ct_seg->flags &=
565             ~(CT_SEGMENT_F_SERVER_DETACHED | CT_SEGMENT_F_CLIENT_DETACHED);
566           __atomic_add_fetch (&ct_seg->server_n_sessions, 1, __ATOMIC_RELAXED);
567           __atomic_add_fetch (&ct_seg->client_n_sessions, 1, __ATOMIC_RELAXED);
568         }
569     }
570
571   clib_rwlock_reader_unlock (&cm->app_segs_lock);
572
573   /*
574    * If not, grab exclusive lock and allocate segment
575    */
576   if (fs_index == ~0)
577     {
578       clib_rwlock_writer_lock (&cm->app_segs_lock);
579
580       ct_seg =
581         ct_alloc_segment (cm, server_wrk, table_handle, sm, ct->client_wrk);
582       if (!ct_seg)
583         {
584           clib_rwlock_writer_unlock (&cm->app_segs_lock);
585           return -1;
586         }
587
588       ct->seg_ctx_index = ct_seg->seg_ctx_index;
589       ct->ct_seg_index = ct_seg->ct_seg_index;
590       ct_seg->server_n_sessions += 1;
591       ct_seg->client_n_sessions += 1;
592       fs_index = ct_seg->segment_index;
593
594       clib_rwlock_writer_unlock (&cm->app_segs_lock);
595     }
596
597   /*
598    * Allocate and initialize the fifos
599    */
600   fs = segment_manager_get_segment_w_lock (sm, fs_index);
601   rv = segment_manager_try_alloc_fifos (
602     fs, ls->thread_index, props->rx_fifo_size, props->tx_fifo_size,
603     &ls->rx_fifo, &ls->tx_fifo);
604   if (rv)
605     {
606       segment_manager_segment_reader_unlock (sm);
607
608       clib_rwlock_reader_lock (&cm->app_segs_lock);
609
610       seg_ctx = pool_elt_at_index (cm->app_seg_ctxs, ct->seg_ctx_index);
611       ct_seg = pool_elt_at_index (seg_ctx->segments, ct->ct_seg_index);
612       __atomic_sub_fetch (&ct_seg->server_n_sessions, 1, __ATOMIC_RELAXED);
613       __atomic_sub_fetch (&ct_seg->client_n_sessions, 1, __ATOMIC_RELAXED);
614
615       clib_rwlock_reader_unlock (&cm->app_segs_lock);
616
617       return rv;
618     }
619
620   ls->rx_fifo->shr->master_session_index = ls->session_index;
621   ls->tx_fifo->shr->master_session_index = ls->session_index;
622   ls->rx_fifo->master_thread_index = ls->thread_index;
623   ls->tx_fifo->master_thread_index = ls->thread_index;
624   ls->rx_fifo->segment_manager = sm_index;
625   ls->tx_fifo->segment_manager = sm_index;
626   ls->rx_fifo->segment_index = fs_index;
627   ls->tx_fifo->segment_index = fs_index;
628
629   seg_handle = segment_manager_segment_handle (sm, fs);
630   segment_manager_segment_reader_unlock (sm);
631
632   ct->segment_handle = seg_handle;
633
634   return 0;
635 }
636
637 static void
638 ct_accept_one (u32 thread_index, u32 ho_index)
639 {
640   ct_connection_t *sct, *cct, *ho;
641   transport_connection_t *ll_ct;
642   app_worker_t *server_wrk;
643   u32 cct_index, ll_index;
644   session_t *ss, *ll;
645
646   /*
647    * Alloc client ct and initialize from ho
648    */
649   cct = ct_connection_alloc (thread_index);
650   cct_index = cct->c_c_index;
651
652   ho = ct_connection_get (ho_index, 0);
653
654   /* Unlikely but half-open session and transport could have been freed */
655   if (PREDICT_FALSE (!ho))
656     {
657       ct_connection_free (cct);
658       return;
659     }
660
661   clib_memcpy (cct, ho, sizeof (*ho));
662   cct->c_c_index = cct_index;
663   cct->c_thread_index = thread_index;
664   cct->flags |= CT_CONN_F_HALF_OPEN;
665
666   /* Notify session layer that half-open is on a different thread
667    * and mark ho connection index reusable. Avoids another rpc
668    */
669   session_half_open_migrate_notify (&cct->connection);
670   session_half_open_migrated_notify (&cct->connection);
671   ct_half_open_add_reusable (ho_index);
672
673   /*
674    * Alloc and init server transport
675    */
676
677   ll_index = cct->peer_index;
678   ll = listen_session_get (ll_index);
679   sct = ct_connection_alloc (thread_index);
680   /* Transport not necessarily ct but it might, so grab after sct alloc */
681   ll_ct = listen_session_get_transport (ll);
682
683   /* Make sure cct is valid after sct alloc */
684   cct = ct_connection_get (cct_index, thread_index);
685
686   sct->c_rmt_port = 0;
687   sct->c_lcl_port = ll_ct->lcl_port;
688   sct->c_is_ip4 = cct->c_is_ip4;
689   clib_memcpy (&sct->c_lcl_ip, &cct->c_rmt_ip, sizeof (cct->c_rmt_ip));
690   sct->client_wrk = cct->client_wrk;
691   sct->c_proto = TRANSPORT_PROTO_NONE;
692   sct->client_opaque = cct->client_opaque;
693   sct->actual_tp = cct->actual_tp;
694
695   sct->peer_index = cct->c_c_index;
696   cct->peer_index = sct->c_c_index;
697
698   /*
699    * Accept server session. Client session is created only after
700    * server confirms accept.
701    */
702   ss = session_alloc (thread_index);
703   ll = listen_session_get (ll_index);
704   ss->session_type = session_type_from_proto_and_ip (TRANSPORT_PROTO_NONE,
705                                                      sct->c_is_ip4);
706   ss->connection_index = sct->c_c_index;
707   ss->listener_handle = listen_session_get_handle (ll);
708   ss->session_state = SESSION_STATE_CREATED;
709
710   server_wrk = application_listener_select_worker (ll);
711   ss->app_wrk_index = server_wrk->wrk_index;
712
713   sct->c_s_index = ss->session_index;
714   sct->server_wrk = ss->app_wrk_index;
715
716   if (ct_init_accepted_session (server_wrk, sct, ss, ll))
717     {
718       ct_session_connect_notify (ss, SESSION_E_ALLOC);
719       ct_connection_free (sct);
720       session_free (ss);
721       return;
722     }
723
724   cct->server_wrk = sct->server_wrk;
725   cct->seg_ctx_index = sct->seg_ctx_index;
726   cct->ct_seg_index = sct->ct_seg_index;
727   cct->client_rx_fifo = ss->tx_fifo;
728   cct->client_tx_fifo = ss->rx_fifo;
729   cct->client_rx_fifo->refcnt++;
730   cct->client_tx_fifo->refcnt++;
731   cct->segment_handle = sct->segment_handle;
732
733   ss->session_state = SESSION_STATE_ACCEPTING;
734   if (app_worker_accept_notify (server_wrk, ss))
735     {
736       ct_session_connect_notify (ss, SESSION_E_REFUSED);
737       ct_session_dealloc_fifos (sct, ss->rx_fifo, ss->tx_fifo);
738       ct_connection_free (sct);
739       session_free (ss);
740     }
741 }
742
743 static void
744 ct_accept_rpc_wrk_handler (void *rpc_args)
745 {
746   u32 thread_index, ho_index, n_connects, i, n_pending;
747   const u32 max_connects = 32;
748   ct_worker_t *wrk;
749
750   thread_index = pointer_to_uword (rpc_args);
751   wrk = ct_worker_get (thread_index);
752
753   /* Sub without lock as main enqueues with worker barrier */
754   n_pending = clib_fifo_elts (wrk->pending_connects);
755   n_connects = clib_min (n_pending, max_connects);
756
757   for (i = 0; i < n_connects; i++)
758     {
759       clib_fifo_sub1 (wrk->pending_connects, ho_index);
760       ct_accept_one (thread_index, ho_index);
761     }
762
763   if (n_pending == n_connects)
764     wrk->have_connects = 0;
765   else
766     session_send_rpc_evt_to_thread_force (
767       thread_index, ct_accept_rpc_wrk_handler,
768       uword_to_pointer (thread_index, void *));
769 }
770
771 static int
772 ct_connect (app_worker_t * client_wrk, session_t * ll,
773             session_endpoint_cfg_t * sep)
774 {
775   u32 thread_index, ho_index;
776   ct_main_t *cm = &ct_main;
777   ct_connection_t *ho;
778   ct_worker_t *wrk;
779
780   /* Simple round-robin policy for spreading sessions over workers. We skip
781    * thread index 0, i.e., offset the index by 1, when we have workers as it
782    * is the one dedicated to main thread. Note that n_workers does not include
783    * main thread */
784   cm->n_sessions += 1;
785   thread_index = cm->n_workers ? (cm->n_sessions % cm->n_workers) + 1 : 0;
786
787   /*
788    * Alloc and init client half-open transport
789    */
790
791   ho = ct_half_open_alloc ();
792   ho_index = ho->c_c_index;
793   ho->c_rmt_port = sep->port;
794   ho->c_lcl_port = 0;
795   ho->c_is_ip4 = sep->is_ip4;
796   ho->client_opaque = sep->opaque;
797   ho->client_wrk = client_wrk->wrk_index;
798   ho->peer_index = ll->session_index;
799   ho->c_proto = TRANSPORT_PROTO_NONE;
800   ho->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
801   clib_memcpy (&ho->c_rmt_ip, &sep->ip, sizeof (sep->ip));
802   ho->flags |= CT_CONN_F_CLIENT;
803   ho->c_s_index = ~0;
804   ho->actual_tp = sep->original_tp;
805
806   /*
807    * Accept connection on thread selected above. Connected reply comes
808    * after server accepts the connection.
809    */
810
811   wrk = ct_worker_get (thread_index);
812
813   /* Worker barrier held, add without additional lock */
814   clib_fifo_add1 (wrk->pending_connects, ho_index);
815   if (!wrk->have_connects)
816     {
817       wrk->have_connects = 1;
818       session_send_rpc_evt_to_thread_force (
819         thread_index, ct_accept_rpc_wrk_handler,
820         uword_to_pointer (thread_index, void *));
821     }
822
823   return ho_index;
824 }
825
826 static u32
827 ct_start_listen (u32 app_listener_index, transport_endpoint_t * tep)
828 {
829   session_endpoint_cfg_t *sep;
830   ct_connection_t *ct;
831
832   sep = (session_endpoint_cfg_t *) tep;
833   ct = ct_connection_alloc (0);
834   ct->server_wrk = sep->app_wrk_index;
835   ct->c_is_ip4 = sep->is_ip4;
836   clib_memcpy (&ct->c_lcl_ip, &sep->ip, sizeof (sep->ip));
837   ct->c_lcl_port = sep->port;
838   ct->c_s_index = app_listener_index;
839   ct->actual_tp = sep->transport_proto;
840   return ct->c_c_index;
841 }
842
843 static u32
844 ct_stop_listen (u32 ct_index)
845 {
846   ct_connection_t *ct;
847   ct = ct_connection_get (ct_index, 0);
848   ct_connection_free (ct);
849   return 0;
850 }
851
852 static transport_connection_t *
853 ct_listener_get (u32 ct_index)
854 {
855   return (transport_connection_t *) ct_connection_get (ct_index, 0);
856 }
857
858 static transport_connection_t *
859 ct_half_open_get (u32 ct_index)
860 {
861   return (transport_connection_t *) ct_connection_get (ct_index, 0);
862 }
863
864 static void
865 ct_session_cleanup (u32 conn_index, u32 thread_index)
866 {
867   ct_connection_t *ct, *peer_ct;
868
869   ct = ct_connection_get (conn_index, thread_index);
870   if (!ct)
871     return;
872
873   peer_ct = ct_connection_get (ct->peer_index, thread_index);
874   if (peer_ct)
875     peer_ct->peer_index = ~0;
876
877   ct_connection_free (ct);
878 }
879
880 static void
881 ct_cleanup_ho (u32 ho_index)
882 {
883   ct_connection_free (ct_connection_get (ho_index, 0));
884 }
885
886 static int
887 ct_session_connect (transport_endpoint_cfg_t * tep)
888 {
889   session_endpoint_cfg_t *sep_ext;
890   session_endpoint_t _sep, *sep = &_sep;
891   app_worker_t *app_wrk;
892   session_handle_t lh;
893   application_t *app;
894   app_listener_t *al;
895   u32 table_index;
896   session_t *ll;
897   u8 fib_proto;
898
899   sep_ext = (session_endpoint_cfg_t *) tep;
900   _sep = *(session_endpoint_t *) tep;
901   app_wrk = app_worker_get (sep_ext->app_wrk_index);
902   app = application_get (app_wrk->app_index);
903
904   sep->transport_proto = sep_ext->original_tp;
905   table_index = application_local_session_table (app);
906   lh = session_lookup_local_endpoint (table_index, sep);
907   if (lh == SESSION_DROP_HANDLE)
908     return SESSION_E_FILTERED;
909
910   if (lh == SESSION_INVALID_HANDLE)
911     goto global_scope;
912
913   ll = listen_session_get_from_handle (lh);
914   al = app_listener_get_w_session (ll);
915
916   /*
917    * Break loop if rule in local table points to connecting app. This
918    * can happen if client is a generic proxy. Route connect through
919    * global table instead.
920    */
921   if (al->app_index == app->app_index)
922     goto global_scope;
923
924   return ct_connect (app_wrk, ll, sep_ext);
925
926   /*
927    * If nothing found, check the global scope for locally attached
928    * destinations. Make sure first that we're allowed to.
929    */
930
931 global_scope:
932   if (session_endpoint_is_local (sep))
933     return SESSION_E_NOROUTE;
934
935   if (!application_has_global_scope (app))
936     return SESSION_E_SCOPE;
937
938   fib_proto = session_endpoint_fib_proto (sep);
939   table_index = session_lookup_get_index_for_fib (fib_proto, sep->fib_index);
940   ll = session_lookup_listener_wildcard (table_index, sep);
941
942   /* Avoid connecting app to own listener */
943   if (ll && ll->app_index != app->app_index)
944     return ct_connect (app_wrk, ll, sep_ext);
945
946   /* Failed to connect but no error */
947   return SESSION_E_LOCAL_CONNECT;
948 }
949
950 static void
951 ct_session_postponed_cleanup (ct_connection_t *ct)
952 {
953   app_worker_t *app_wrk;
954   session_t *s;
955
956   s = session_get (ct->c_s_index, ct->c_thread_index);
957   app_wrk = app_worker_get_if_valid (s->app_wrk_index);
958
959   if (ct->flags & CT_CONN_F_CLIENT)
960     {
961       if (app_wrk)
962         app_worker_cleanup_notify (app_wrk, s, SESSION_CLEANUP_TRANSPORT);
963
964       /* Normal free for client session as the fifos are allocated through
965        * the connects segment manager in a segment that's not shared with
966        * the server */
967       ct_session_dealloc_fifos (ct, ct->client_rx_fifo, ct->client_tx_fifo);
968       session_free_w_fifos (s);
969     }
970   else
971     {
972       /* Manual session and fifo segment cleanup to avoid implicit
973        * segment manager cleanups and notifications */
974       app_wrk = app_worker_get_if_valid (s->app_wrk_index);
975       if (app_wrk)
976         {
977           app_worker_cleanup_notify (app_wrk, s, SESSION_CLEANUP_TRANSPORT);
978           app_worker_cleanup_notify (app_wrk, s, SESSION_CLEANUP_SESSION);
979         }
980
981       ct_session_dealloc_fifos (ct, s->rx_fifo, s->tx_fifo);
982       session_free (s);
983     }
984
985   ct_connection_free (ct);
986 }
987
988 static void
989 ct_handle_cleanups (void *args)
990 {
991   uword thread_index = pointer_to_uword (args);
992   const u32 max_cleanups = 100;
993   ct_cleanup_req_t *req;
994   ct_connection_t *ct;
995   u32 n_to_handle = 0;
996   ct_worker_t *wrk;
997   session_t *s;
998
999   wrk = ct_worker_get (thread_index);
1000   wrk->have_cleanups = 0;
1001   n_to_handle = clib_fifo_elts (wrk->pending_cleanups);
1002   n_to_handle = clib_min (n_to_handle, max_cleanups);
1003
1004   while (n_to_handle)
1005     {
1006       clib_fifo_sub2 (wrk->pending_cleanups, req);
1007       ct = ct_connection_get (req->ct_index, thread_index);
1008       s = session_get (ct->c_s_index, ct->c_thread_index);
1009       if (!svm_fifo_has_event (s->tx_fifo))
1010         ct_session_postponed_cleanup (ct);
1011       else
1012         clib_fifo_add1 (wrk->pending_cleanups, *req);
1013       n_to_handle -= 1;
1014     }
1015
1016   if (clib_fifo_elts (wrk->pending_cleanups))
1017     {
1018       wrk->have_cleanups = 1;
1019       session_send_rpc_evt_to_thread_force (
1020         thread_index, ct_handle_cleanups,
1021         uword_to_pointer (thread_index, void *));
1022     }
1023 }
1024
1025 static void
1026 ct_program_cleanup (ct_connection_t *ct)
1027 {
1028   ct_cleanup_req_t *req;
1029   uword thread_index;
1030   ct_worker_t *wrk;
1031
1032   thread_index = ct->c_thread_index;
1033   wrk = ct_worker_get (ct->c_thread_index);
1034
1035   clib_fifo_add2 (wrk->pending_cleanups, req);
1036   req->ct_index = ct->c_c_index;
1037
1038   if (wrk->have_cleanups)
1039     return;
1040
1041   wrk->have_cleanups = 1;
1042   session_send_rpc_evt_to_thread_force (
1043     thread_index, ct_handle_cleanups, uword_to_pointer (thread_index, void *));
1044 }
1045
1046 static inline int
1047 ct_close_is_reset (ct_connection_t *ct, session_t *s)
1048 {
1049   if (ct->flags & CT_CONN_F_CLIENT)
1050     return (svm_fifo_max_dequeue (ct->client_rx_fifo) > 0);
1051   else
1052     return (svm_fifo_max_dequeue (s->rx_fifo) > 0);
1053 }
1054
1055 static void
1056 ct_session_close (u32 ct_index, u32 thread_index)
1057 {
1058   ct_connection_t *ct, *peer_ct;
1059   session_t *s;
1060
1061   ct = ct_connection_get (ct_index, thread_index);
1062   s = session_get (ct->c_s_index, ct->c_thread_index);
1063   peer_ct = ct_connection_get (ct->peer_index, thread_index);
1064   if (peer_ct)
1065     {
1066       peer_ct->peer_index = ~0;
1067       /* Make sure session was allocated */
1068       if (peer_ct->flags & CT_CONN_F_HALF_OPEN)
1069         {
1070           ct_session_connect_notify (s, SESSION_E_REFUSED);
1071         }
1072       else if (peer_ct->c_s_index != ~0)
1073         {
1074           if (ct_close_is_reset (ct, s))
1075             session_transport_reset_notify (&peer_ct->connection);
1076           else
1077             session_transport_closing_notify (&peer_ct->connection);
1078         }
1079       else
1080         {
1081           /* should not happen */
1082           clib_warning ("ct peer without session");
1083           ct_connection_free (peer_ct);
1084         }
1085     }
1086
1087   /* Do not send closed notify to make sure pending tx events are
1088    * still delivered and program cleanup */
1089   ct_program_cleanup (ct);
1090 }
1091
1092 static transport_connection_t *
1093 ct_session_get (u32 ct_index, u32 thread_index)
1094 {
1095   return (transport_connection_t *) ct_connection_get (ct_index,
1096                                                        thread_index);
1097 }
1098
1099 static u8 *
1100 format_ct_connection_id (u8 * s, va_list * args)
1101 {
1102   ct_connection_t *ct = va_arg (*args, ct_connection_t *);
1103   if (!ct)
1104     return s;
1105   if (ct->c_is_ip4)
1106     {
1107       s = format (s, "[%d:%d][CT:%U] %U:%d->%U:%d", ct->c_thread_index,
1108                   ct->c_s_index, format_transport_proto_short, ct->actual_tp,
1109                   format_ip4_address, &ct->c_lcl_ip4,
1110                   clib_net_to_host_u16 (ct->c_lcl_port), format_ip4_address,
1111                   &ct->c_rmt_ip4, clib_net_to_host_u16 (ct->c_rmt_port));
1112     }
1113   else
1114     {
1115       s = format (s, "[%d:%d][CT:%U] %U:%d->%U:%d", ct->c_thread_index,
1116                   ct->c_s_index, format_transport_proto_short, ct->actual_tp,
1117                   format_ip6_address, &ct->c_lcl_ip6,
1118                   clib_net_to_host_u16 (ct->c_lcl_port), format_ip6_address,
1119                   &ct->c_rmt_ip6, clib_net_to_host_u16 (ct->c_rmt_port));
1120     }
1121
1122   return s;
1123 }
1124
1125 static int
1126 ct_custom_tx (void *session, transport_send_params_t * sp)
1127 {
1128   session_t *s = (session_t *) session;
1129   if (session_has_transport (s))
1130     return 0;
1131   /* If event enqueued towards peer, remove from scheduler and remove
1132    * session tx flag, i.e., accept new tx events. Unset fifo flag now to
1133    * avoid missing events if peer did not clear fifo flag yet, which is
1134    * interpreted as successful notification and session is descheduled. */
1135   svm_fifo_unset_event (s->tx_fifo);
1136   if (!ct_session_tx (s))
1137     sp->flags = TRANSPORT_SND_F_DESCHED;
1138
1139   /* The scheduler uses packet count as a means of upper bounding the amount
1140    * of work done per dispatch. So make it look like we have sent something */
1141   return 1;
1142 }
1143
1144 static int
1145 ct_app_rx_evt (transport_connection_t * tc)
1146 {
1147   ct_connection_t *ct = (ct_connection_t *) tc, *peer_ct;
1148   session_t *ps;
1149
1150   peer_ct = ct_connection_get (ct->peer_index, tc->thread_index);
1151   if (!peer_ct)
1152     return -1;
1153   ps = session_get (peer_ct->c_s_index, peer_ct->c_thread_index);
1154   return session_dequeue_notify (ps);
1155 }
1156
1157 static u8 *
1158 format_ct_listener (u8 * s, va_list * args)
1159 {
1160   u32 tc_index = va_arg (*args, u32);
1161   u32 __clib_unused thread_index = va_arg (*args, u32);
1162   u32 __clib_unused verbose = va_arg (*args, u32);
1163   ct_connection_t *ct = ct_connection_get (tc_index, 0);
1164   s = format (s, "%-" SESSION_CLI_ID_LEN "U", format_ct_connection_id, ct);
1165   if (verbose)
1166     s = format (s, "%-" SESSION_CLI_STATE_LEN "s", "LISTEN");
1167   return s;
1168 }
1169
1170 static u8 *
1171 format_ct_half_open (u8 *s, va_list *args)
1172 {
1173   u32 ho_index = va_arg (*args, u32);
1174   u32 verbose = va_arg (*args, u32);
1175   ct_connection_t *ct = ct_connection_get (ho_index, 0);
1176   s = format (s, "%-" SESSION_CLI_ID_LEN "U", format_ct_connection_id, ct);
1177   if (verbose)
1178     s = format (s, "%-" SESSION_CLI_STATE_LEN "s", "HALF-OPEN");
1179   return s;
1180 }
1181
1182 static u8 *
1183 format_ct_connection (u8 * s, va_list * args)
1184 {
1185   ct_connection_t *ct = va_arg (*args, ct_connection_t *);
1186   u32 verbose = va_arg (*args, u32);
1187
1188   if (!ct)
1189     return s;
1190   s = format (s, "%-" SESSION_CLI_ID_LEN "U", format_ct_connection_id, ct);
1191   if (verbose)
1192     {
1193       s = format (s, "%-" SESSION_CLI_STATE_LEN "s", "ESTABLISHED");
1194       if (verbose > 1)
1195         {
1196           s = format (s, "\n");
1197         }
1198     }
1199   return s;
1200 }
1201
1202 static u8 *
1203 format_ct_session (u8 * s, va_list * args)
1204 {
1205   u32 ct_index = va_arg (*args, u32);
1206   u32 thread_index = va_arg (*args, u32);
1207   u32 verbose = va_arg (*args, u32);
1208   ct_connection_t *ct;
1209
1210   ct = ct_connection_get (ct_index, thread_index);
1211   if (!ct)
1212     {
1213       s = format (s, "empty\n");
1214       return s;
1215     }
1216
1217   s = format (s, "%U", format_ct_connection, ct, verbose);
1218   return s;
1219 }
1220
1221 clib_error_t *
1222 ct_enable_disable (vlib_main_t * vm, u8 is_en)
1223 {
1224   vlib_thread_main_t *vtm = &vlib_thread_main;
1225   ct_main_t *cm = &ct_main;
1226
1227   cm->n_workers = vlib_num_workers ();
1228   vec_validate (cm->wrk, vtm->n_vlib_mains);
1229   clib_spinlock_init (&cm->ho_reuseable_lock);
1230   clib_rwlock_init (&cm->app_segs_lock);
1231   return 0;
1232 }
1233
1234 /* *INDENT-OFF* */
1235 static const transport_proto_vft_t cut_thru_proto = {
1236   .enable = ct_enable_disable,
1237   .start_listen = ct_start_listen,
1238   .stop_listen = ct_stop_listen,
1239   .get_connection = ct_session_get,
1240   .get_listener = ct_listener_get,
1241   .get_half_open = ct_half_open_get,
1242   .cleanup = ct_session_cleanup,
1243   .cleanup_ho = ct_cleanup_ho,
1244   .connect = ct_session_connect,
1245   .close = ct_session_close,
1246   .custom_tx = ct_custom_tx,
1247   .app_rx_evt = ct_app_rx_evt,
1248   .format_listener = format_ct_listener,
1249   .format_half_open = format_ct_half_open,
1250   .format_connection = format_ct_session,
1251   .transport_options = {
1252     .name = "ct",
1253     .short_name = "C",
1254     .tx_type = TRANSPORT_TX_INTERNAL,
1255     .service_type = TRANSPORT_SERVICE_VC,
1256   },
1257 };
1258 /* *INDENT-ON* */
1259
1260 int
1261 ct_session_tx (session_t * s)
1262 {
1263   ct_connection_t *ct, *peer_ct;
1264   session_t *peer_s;
1265
1266   ct = (ct_connection_t *) session_get_transport (s);
1267   peer_ct = ct_connection_get (ct->peer_index, ct->c_thread_index);
1268   if (!peer_ct)
1269     return 0;
1270   peer_s = session_get (peer_ct->c_s_index, peer_ct->c_thread_index);
1271   if (peer_s->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
1272     return 0;
1273   return session_enqueue_notify (peer_s);
1274 }
1275
1276 static clib_error_t *
1277 ct_transport_init (vlib_main_t * vm)
1278 {
1279   transport_register_protocol (TRANSPORT_PROTO_NONE, &cut_thru_proto,
1280                                FIB_PROTOCOL_IP4, ~0);
1281   transport_register_protocol (TRANSPORT_PROTO_NONE, &cut_thru_proto,
1282                                FIB_PROTOCOL_IP6, ~0);
1283   return 0;
1284 }
1285
1286 VLIB_INIT_FUNCTION (ct_transport_init);
1287
1288 /*
1289  * fd.io coding-style-patch-verification: ON
1290  *
1291  * Local Variables:
1292  * eval: (c-set-style "gnu")
1293  * End:
1294  */