SCTP: API to configure some tunables
[vpp.git] / src / vnet / sctp / sctp.c
1 /*
2  * Copyright (c) 2017 SUSE LLC.
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 #include <vnet/sctp/sctp.h>
16 #include <vnet/sctp/sctp_debug.h>
17
18 sctp_main_t sctp_main;
19
20 static u32
21 sctp_connection_bind (u32 session_index, transport_endpoint_t * tep)
22 {
23   sctp_main_t *tm = &sctp_main;
24   sctp_connection_t *listener;
25   void *iface_ip;
26
27   pool_get (tm->listener_pool, listener);
28   memset (listener, 0, sizeof (*listener));
29
30   listener->sub_conn[SCTP_PRIMARY_PATH_IDX].subconn_idx =
31     SCTP_PRIMARY_PATH_IDX;
32   listener->sub_conn[SCTP_PRIMARY_PATH_IDX].c_c_index =
33     listener - tm->listener_pool;
34   listener->sub_conn[SCTP_PRIMARY_PATH_IDX].connection.lcl_port = tep->port;
35
36   /* If we are provided a sw_if_index, bind using one of its IPs */
37   if (ip_is_zero (&tep->ip, 1) && tep->sw_if_index != ENDPOINT_INVALID_INDEX)
38     {
39       if ((iface_ip = ip_interface_get_first_ip (tep->sw_if_index,
40                                                  tep->is_ip4)))
41         ip_set (&tep->ip, iface_ip, tep->is_ip4);
42     }
43   ip_copy (&listener->sub_conn[SCTP_PRIMARY_PATH_IDX].connection.lcl_ip,
44            &tep->ip, tep->is_ip4);
45
46   listener->sub_conn[SCTP_PRIMARY_PATH_IDX].PMTU =
47     vnet_sw_interface_get_mtu (vnet_get_main (), tep->sw_if_index, VLIB_TX);
48   listener->sub_conn[SCTP_PRIMARY_PATH_IDX].connection.is_ip4 = tep->is_ip4;
49   listener->sub_conn[SCTP_PRIMARY_PATH_IDX].connection.proto =
50     TRANSPORT_PROTO_SCTP;
51   listener->sub_conn[SCTP_PRIMARY_PATH_IDX].c_s_index = session_index;
52   listener->sub_conn[SCTP_PRIMARY_PATH_IDX].connection.fib_index =
53     tep->fib_index;
54   listener->state = SCTP_STATE_CLOSED;
55
56   sctp_connection_timers_init (listener);
57
58   return listener->sub_conn[SCTP_PRIMARY_PATH_IDX].c_c_index;
59 }
60
61 u32
62 sctp_session_bind (u32 session_index, transport_endpoint_t * tep)
63 {
64   return sctp_connection_bind (session_index, tep);
65 }
66
67 static void
68 sctp_connection_unbind (u32 listener_index)
69 {
70   sctp_main_t *tm = vnet_get_sctp_main ();
71   sctp_connection_t *sctp_conn;
72
73   sctp_conn = pool_elt_at_index (tm->listener_pool, listener_index);
74
75   /* Poison the entry */
76   if (CLIB_DEBUG > 0)
77     memset (sctp_conn, 0xFA, sizeof (*sctp_conn));
78
79   pool_put_index (tm->listener_pool, listener_index);
80 }
81
82 u32
83 sctp_session_unbind (u32 listener_index)
84 {
85   sctp_connection_unbind (listener_index);
86   return 0;
87 }
88
89 void
90 sctp_punt_unknown (vlib_main_t * vm, u8 is_ip4, u8 is_add)
91 {
92   sctp_main_t *tm = &sctp_main;
93   if (is_ip4)
94     tm->punt_unknown4 = is_add;
95   else
96     tm->punt_unknown6 = is_add;
97 }
98
99 static int
100 sctp_alloc_custom_local_endpoint (sctp_main_t * tm, ip46_address_t * lcl_addr,
101                                   u16 * lcl_port, u8 is_ip4)
102 {
103   int index, port;
104   if (is_ip4)
105     {
106       index = tm->last_v4_address_rotor++;
107       if (tm->last_v4_address_rotor >= vec_len (tm->ip4_src_addresses))
108         tm->last_v4_address_rotor = 0;
109       lcl_addr->ip4.as_u32 = tm->ip4_src_addresses[index].as_u32;
110     }
111   else
112     {
113       index = tm->last_v6_address_rotor++;
114       if (tm->last_v6_address_rotor >= vec_len (tm->ip6_src_addresses))
115         tm->last_v6_address_rotor = 0;
116       clib_memcpy (&lcl_addr->ip6, &tm->ip6_src_addresses[index],
117                    sizeof (ip6_address_t));
118     }
119   port = transport_alloc_local_port (TRANSPORT_PROTO_SCTP, lcl_addr);
120   if (port < 1)
121     {
122       clib_warning ("Failed to allocate src port");
123       return -1;
124     }
125   *lcl_port = port;
126   return 0;
127 }
128
129 /**
130  * Initialize all connection timers as invalid
131  */
132 void
133 sctp_connection_timers_init (sctp_connection_t * sctp_conn)
134 {
135   int i, j;
136
137   /* Set all to invalid */
138   for (i = 0; i < MAX_SCTP_CONNECTIONS; i++)
139     {
140       sctp_conn->sub_conn[i].RTO = SCTP_RTO_INIT;
141
142       for (j = 0; j < SCTP_N_TIMERS; j++)
143         {
144           sctp_conn->sub_conn[i].timers[j] = SCTP_TIMER_HANDLE_INVALID;
145         }
146     }
147 }
148
149 /**
150  * Stop all connection timers
151  */
152 void
153 sctp_connection_timers_reset (sctp_connection_t * sctp_conn)
154 {
155   int i, j;
156   for (i = 0; i < MAX_SCTP_CONNECTIONS; i++)
157     {
158       for (j = 0; j < SCTP_N_TIMERS; j++)
159         sctp_timer_reset (sctp_conn, i, j);
160     }
161 }
162
163 const char *sctp_fsm_states[] = {
164 #define _(sym, str) str,
165   foreach_sctp_fsm_state
166 #undef _
167 };
168
169 u8 *
170 format_sctp_state (u8 * s, va_list * args)
171 {
172   u32 state = va_arg (*args, u32);
173
174   if (state < SCTP_N_STATES)
175     s = format (s, "%s", sctp_fsm_states[state]);
176   else
177     s = format (s, "UNKNOWN (%d (0x%x))", state, state);
178   return s;
179 }
180
181 u8 *
182 format_sctp_connection_id (u8 * s, va_list * args)
183 {
184   sctp_connection_t *sctp_conn = va_arg (*args, sctp_connection_t *);
185   if (!sctp_conn)
186     return s;
187
188   u8 i;
189   for (i = 0; i < MAX_SCTP_CONNECTIONS; i++)
190     {
191       if (sctp_conn->sub_conn[i].connection.is_ip4)
192         {
193           s = format (s, "%U[#%d][%s] %U:%d->%U:%d",
194                       s,
195                       sctp_conn->sub_conn[i].connection.thread_index,
196                       "T",
197                       format_ip4_address,
198                       &sctp_conn->sub_conn[i].connection.lcl_ip.ip4,
199                       clib_net_to_host_u16 (sctp_conn->sub_conn[i].
200                                             connection.lcl_port),
201                       format_ip4_address,
202                       &sctp_conn->sub_conn[i].connection.rmt_ip.ip4,
203                       clib_net_to_host_u16 (sctp_conn->sub_conn[i].
204                                             connection.rmt_port));
205         }
206       else
207         {
208           s = format (s, "%U[#%d][%s] %U:%d->%U:%d",
209                       s,
210                       sctp_conn->sub_conn[i].connection.thread_index,
211                       "T",
212                       format_ip6_address,
213                       &sctp_conn->sub_conn[i].connection.lcl_ip.ip6,
214                       clib_net_to_host_u16 (sctp_conn->sub_conn[i].
215                                             connection.lcl_port),
216                       format_ip6_address,
217                       &sctp_conn->sub_conn[i].connection.rmt_ip.ip6,
218                       clib_net_to_host_u16 (sctp_conn->sub_conn[i].
219                                             connection.rmt_port));
220         }
221     }
222   return s;
223 }
224
225 u8 *
226 format_sctp_connection (u8 * s, va_list * args)
227 {
228   sctp_connection_t *sctp_conn = va_arg (*args, sctp_connection_t *);
229   u32 verbose = va_arg (*args, u32);
230
231   if (!sctp_conn)
232     return s;
233   s = format (s, "%-50U", format_sctp_connection_id, sctp_conn);
234   if (verbose)
235     {
236       s = format (s, "%-15U", format_sctp_state, sctp_conn->state);
237     }
238
239   return s;
240 }
241
242 /**
243  * Initialize connection send variables.
244  */
245 void
246 sctp_init_snd_vars (sctp_connection_t * sctp_conn)
247 {
248   u32 time_now;
249   /*
250    * We use the time to randomize iss and for setting up the initial
251    * timestamp. Make sure it's updated otherwise syn and ack in the
252    * handshake may make it look as if time has flown in the opposite
253    * direction for us.
254    */
255
256   sctp_set_time_now (vlib_get_thread_index ());
257   time_now = sctp_time_now ();
258
259   sctp_conn->local_initial_tsn = random_u32 (&time_now);
260   sctp_conn->last_unacked_tsn = sctp_conn->local_initial_tsn;
261   sctp_conn->next_tsn = sctp_conn->local_initial_tsn + 1;
262
263   sctp_conn->remote_initial_tsn = 0x0;
264   sctp_conn->last_rcvd_tsn = sctp_conn->remote_initial_tsn;
265 }
266
267 always_inline sctp_connection_t *
268 sctp_sub_connection_add (u8 thread_index)
269 {
270   sctp_main_t *tm = vnet_get_sctp_main ();
271   sctp_connection_t *sctp_conn = tm->connections[thread_index];
272
273   u8 subconn_idx = sctp_next_avail_subconn (sctp_conn);
274
275   ASSERT (subconn_idx < MAX_SCTP_CONNECTIONS);
276
277   sctp_conn->sub_conn[subconn_idx].connection.c_index =
278     sctp_conn->sub_conn[SCTP_PRIMARY_PATH_IDX].connection.c_index;
279   sctp_conn->sub_conn[subconn_idx].connection.thread_index = thread_index;
280   sctp_conn->sub_conn[subconn_idx].subconn_idx = subconn_idx;
281
282   return sctp_conn;
283 }
284
285 u8
286 sctp_sub_connection_add_ip4 (vlib_main_t * vm,
287                              ip4_address_t * lcl_addr,
288                              ip4_address_t * rmt_addr)
289 {
290   sctp_connection_t *sctp_conn = sctp_sub_connection_add (vm->thread_index);
291
292   u8 subconn_idx = sctp_next_avail_subconn (sctp_conn);
293
294   if (subconn_idx == MAX_SCTP_CONNECTIONS)
295     return SCTP_ERROR_MAX_CONNECTIONS;
296
297   clib_memcpy (&sctp_conn->sub_conn[subconn_idx].connection.lcl_ip,
298                &lcl_addr, sizeof (lcl_addr));
299
300   clib_memcpy (&sctp_conn->sub_conn[subconn_idx].connection.rmt_ip,
301                &rmt_addr, sizeof (rmt_addr));
302
303   sctp_conn->forming_association_changed = 1;
304
305   return SCTP_ERROR_NONE;
306 }
307
308 u8
309 sctp_sub_connection_del_ip4 (ip4_address_t * lcl_addr,
310                              ip4_address_t * rmt_addr)
311 {
312   sctp_main_t *sctp_main = vnet_get_sctp_main ();
313
314   u32 thread_idx = vlib_get_thread_index ();
315   u8 i;
316
317   ASSERT (thread_idx == 0);
318
319   for (i = 0; i < MAX_SCTP_CONNECTIONS; i++)
320     {
321       sctp_connection_t *sctp_conn = sctp_main->connections[thread_idx];
322       sctp_sub_connection_t *sub_conn =
323         &sctp_main->connections[thread_idx]->sub_conn[i];
324       ip46_address_t *lcl_ip =
325         &sctp_main->connections[thread_idx]->sub_conn[i].connection.lcl_ip;
326       ip46_address_t *rmt_ip =
327         &sctp_main->connections[thread_idx]->sub_conn[i].connection.rmt_ip;
328
329       if (!sub_conn->connection.is_ip4)
330         continue;
331       if (lcl_ip->ip4.as_u32 == lcl_addr->as_u32 &&
332           rmt_ip->ip4.as_u32 == rmt_addr->as_u32)
333         {
334           sub_conn->state = SCTP_SUBCONN_STATE_DOWN;
335           sctp_conn->forming_association_changed = 1;
336           break;
337         }
338     }
339   return SCTP_ERROR_NONE;
340 }
341
342 u8
343 sctp_sub_connection_add_ip6 (vlib_main_t * vm,
344                              ip6_address_t * lcl_addr,
345                              ip6_address_t * rmt_addr)
346 {
347   sctp_connection_t *sctp_conn = sctp_sub_connection_add (vm->thread_index);
348
349   u8 subconn_idx = sctp_next_avail_subconn (sctp_conn);
350
351   if (subconn_idx == MAX_SCTP_CONNECTIONS)
352     return SCTP_ERROR_MAX_CONNECTIONS;
353
354   clib_memcpy (&sctp_conn->sub_conn[subconn_idx].connection.lcl_ip,
355                &lcl_addr, sizeof (lcl_addr));
356
357   clib_memcpy (&sctp_conn->sub_conn[subconn_idx].connection.rmt_ip,
358                &rmt_addr, sizeof (rmt_addr));
359
360   sctp_conn->forming_association_changed = 1;
361
362   return SCTP_ERROR_NONE;
363 }
364
365 u8
366 sctp_sub_connection_del_ip6 (ip6_address_t * lcl_addr,
367                              ip6_address_t * rmt_addr)
368 {
369   sctp_main_t *sctp_main = vnet_get_sctp_main ();
370
371   u32 thread_idx = vlib_get_thread_index ();
372   u8 i;
373
374   ASSERT (thread_idx == 0);
375
376   for (i = 0; i < MAX_SCTP_CONNECTIONS; i++)
377     {
378       sctp_connection_t *sctp_conn = sctp_main->connections[thread_idx];
379       sctp_sub_connection_t *sub_conn =
380         &sctp_main->connections[thread_idx]->sub_conn[i];
381       ip46_address_t *lcl_ip =
382         &sctp_main->connections[thread_idx]->sub_conn[i].connection.lcl_ip;
383       ip46_address_t *rmt_ip =
384         &sctp_main->connections[thread_idx]->sub_conn[i].connection.rmt_ip;
385
386       if (!sub_conn->connection.is_ip4)
387         continue;
388       if ((lcl_ip->ip6.as_u64[0] == lcl_addr->as_u64[0]
389            && lcl_ip->ip6.as_u64[1] == lcl_addr->as_u64[1])
390           && (rmt_ip->ip6.as_u64[0] == rmt_addr->as_u64[0]
391               && rmt_ip->ip6.as_u64[1] == rmt_addr->as_u64[1]))
392         {
393           sub_conn->state = SCTP_SUBCONN_STATE_DOWN;
394           sctp_conn->forming_association_changed = 1;
395           break;
396         }
397     }
398   return SCTP_ERROR_NONE;
399 }
400
401 u8
402 sctp_configure (sctp_user_configuration_t config)
403 {
404   sctp_main_t *sctp_main = vnet_get_sctp_main ();
405
406   u32 thread_idx = vlib_get_thread_index ();
407
408   sctp_main->connections[thread_idx]->conn_config.never_delay_sack =
409     config.never_delay_sack;
410   sctp_main->connections[thread_idx]->conn_config.never_bundle =
411     config.never_bundle;
412
413   return 0;
414 }
415
416 sctp_connection_t *
417 sctp_connection_new (u8 thread_index)
418 {
419   sctp_main_t *sctp_main = vnet_get_sctp_main ();
420   sctp_connection_t *sctp_conn;
421
422   pool_get (sctp_main->connections[thread_index], sctp_conn);
423   memset (sctp_conn, 0, sizeof (*sctp_conn));
424   sctp_conn->sub_conn[SCTP_PRIMARY_PATH_IDX].subconn_idx =
425     SCTP_PRIMARY_PATH_IDX;
426   sctp_conn->sub_conn[SCTP_PRIMARY_PATH_IDX].c_c_index =
427     sctp_conn - sctp_main->connections[thread_index];
428   sctp_conn->sub_conn[SCTP_PRIMARY_PATH_IDX].c_thread_index = thread_index;
429   sctp_conn->local_tag = 0;
430
431   return sctp_conn;
432 }
433
434 sctp_connection_t *
435 sctp_half_open_connection_new (u8 thread_index)
436 {
437   sctp_main_t *tm = vnet_get_sctp_main ();
438   sctp_connection_t *sctp_conn = 0;
439   ASSERT (vlib_get_thread_index () == 0);
440   pool_get (tm->half_open_connections, sctp_conn);
441   memset (sctp_conn, 0, sizeof (*sctp_conn));
442   sctp_conn->sub_conn[SCTP_PRIMARY_PATH_IDX].c_c_index =
443     sctp_conn - tm->half_open_connections;
444   sctp_conn->sub_conn[SCTP_PRIMARY_PATH_IDX].subconn_idx =
445     SCTP_PRIMARY_PATH_IDX;
446   return sctp_conn;
447 }
448
449 static inline int
450 sctp_connection_open (transport_endpoint_t * rmt)
451 {
452   sctp_main_t *tm = vnet_get_sctp_main ();
453   sctp_connection_t *sctp_conn;
454   ip46_address_t lcl_addr;
455   u16 lcl_port;
456   uword thread_id;
457   int rv;
458
459   u8 idx = SCTP_PRIMARY_PATH_IDX;
460
461   /*
462    * Allocate local endpoint
463    */
464   if ((rmt->is_ip4 && vec_len (tm->ip4_src_addresses))
465       || (!rmt->is_ip4 && vec_len (tm->ip6_src_addresses)))
466     rv = sctp_alloc_custom_local_endpoint (tm, &lcl_addr, &lcl_port,
467                                            rmt->is_ip4);
468   else
469     rv = transport_alloc_local_endpoint (TRANSPORT_PROTO_SCTP,
470                                          rmt, &lcl_addr, &lcl_port);
471
472   if (rv)
473     return -1;
474
475   /*
476    * Create connection and send INIT CHUNK
477    */
478   thread_id = vlib_get_thread_index ();
479   ASSERT (thread_id == 0);
480
481   clib_spinlock_lock_if_init (&tm->half_open_lock);
482   sctp_conn = sctp_half_open_connection_new (thread_id);
483   sctp_conn->sub_conn[idx].PMTU =
484     vnet_sw_interface_get_mtu (vnet_get_main (), rmt->sw_if_index, VLIB_TX);
485
486   transport_connection_t *trans_conn = &sctp_conn->sub_conn[idx].connection;
487   ip_copy (&trans_conn->rmt_ip, &rmt->ip, rmt->is_ip4);
488   ip_copy (&trans_conn->lcl_ip, &lcl_addr, rmt->is_ip4);
489   sctp_conn->sub_conn[idx].subconn_idx = idx;
490   trans_conn->rmt_port = rmt->port;
491   trans_conn->lcl_port = clib_host_to_net_u16 (lcl_port);
492   trans_conn->is_ip4 = rmt->is_ip4;
493   trans_conn->proto = TRANSPORT_PROTO_SCTP;
494   trans_conn->fib_index = rmt->fib_index;
495
496   sctp_connection_timers_init (sctp_conn);
497   /* The other connection vars will be initialized after INIT_ACK chunk received */
498   sctp_init_snd_vars (sctp_conn);
499
500   sctp_send_init (sctp_conn);
501
502   clib_spinlock_unlock_if_init (&tm->half_open_lock);
503
504   return sctp_conn->sub_conn[idx].connection.c_index;
505 }
506
507 /**
508  * Cleans up connection state.
509  *
510  * No notifications.
511  */
512 void
513 sctp_connection_cleanup (sctp_connection_t * sctp_conn)
514 {
515   sctp_main_t *tm = &sctp_main;
516   u8 i;
517
518   /* Cleanup local endpoint if this was an active connect */
519   for (i = 0; i < MAX_SCTP_CONNECTIONS; i++)
520     transport_endpoint_cleanup (TRANSPORT_PROTO_SCTP,
521                                 &sctp_conn->sub_conn[i].connection.lcl_ip,
522                                 sctp_conn->sub_conn[i].connection.lcl_port);
523
524   int thread_index =
525     sctp_conn->sub_conn[SCTP_PRIMARY_PATH_IDX].connection.thread_index;
526
527   /* Make sure all timers are cleared */
528   sctp_connection_timers_reset (sctp_conn);
529
530   /* Poison the entry */
531   if (CLIB_DEBUG > 0)
532     memset (sctp_conn, 0xFA, sizeof (*sctp_conn));
533   pool_put (tm->connections[thread_index], sctp_conn);
534 }
535
536 int
537 sctp_session_open (transport_endpoint_t * tep)
538 {
539   return sctp_connection_open (tep);
540 }
541
542 u16
543 sctp_check_outstanding_data_chunks (sctp_connection_t * sctp_conn)
544 {
545   u8 i;
546   for (i = 0; i < MAX_SCTP_CONNECTIONS; i++)
547     {
548       if (sctp_conn->sub_conn[i].state == SCTP_SUBCONN_STATE_DOWN)
549         continue;
550
551       if (sctp_conn->sub_conn[i].is_retransmitting == 1 ||
552           sctp_conn->sub_conn[i].enqueue_state != SCTP_ERROR_ENQUEUED)
553         {
554           SCTP_DBG_OUTPUT
555             ("Connection %u has still DATA to be enqueued inboud / outboud",
556              sctp_conn->sub_conn[i].connection.c_index);
557           return 1;
558         }
559
560     }
561   return 0;                     /* Indicates no more data to be read/sent */
562 }
563
564 void
565 sctp_connection_close (sctp_connection_t * sctp_conn)
566 {
567   SCTP_DBG ("Closing connection %u...",
568             sctp_conn->sub_conn[SCTP_PRIMARY_PATH_IDX].connection.c_index);
569
570   sctp_conn->state = SCTP_STATE_SHUTDOWN_PENDING;
571
572   sctp_send_shutdown (sctp_conn);
573 }
574
575 void
576 sctp_session_close (u32 conn_index, u32 thread_index)
577 {
578   ASSERT (thread_index == 0);
579
580   sctp_connection_t *sctp_conn =
581     sctp_connection_get (conn_index, thread_index);
582   if (sctp_conn != NULL)
583     sctp_connection_close (sctp_conn);
584 }
585
586 void
587 sctp_session_cleanup (u32 conn_index, u32 thread_index)
588 {
589   sctp_connection_t *sctp_conn =
590     sctp_connection_get (conn_index, thread_index);
591
592   if (sctp_conn != NULL)
593     {
594       sctp_connection_timers_reset (sctp_conn);
595       /* Wait for the session tx events to clear */
596       sctp_conn->state = SCTP_STATE_CLOSED;
597     }
598 }
599
600 /**
601  * Compute maximum segment size for session layer.
602  */
603 u16
604 sctp_session_send_mss (transport_connection_t * trans_conn)
605 {
606   sctp_connection_t *sctp_conn =
607     sctp_get_connection_from_transport (trans_conn);
608
609   if (sctp_conn == NULL)
610     {
611       SCTP_DBG ("sctp_conn == NULL");
612       return 0;
613     }
614
615   update_cwnd (sctp_conn);
616   update_smallest_pmtu_idx (sctp_conn);
617
618   return sctp_conn->sub_conn[sctp_conn->smallest_PMTU_idx].cwnd;
619 }
620
621 u16
622 sctp_snd_space (sctp_connection_t * sctp_conn)
623 {
624   /* Finally, let's subtract the DATA chunk headers overhead */
625   return sctp_conn->sub_conn[sctp_conn->smallest_PMTU_idx].cwnd -
626     sizeof (sctp_payload_data_chunk_t) - sizeof (sctp_full_hdr_t);
627 }
628
629 /**
630  * Compute TX window session is allowed to fill.
631  */
632 u32
633 sctp_session_send_space (transport_connection_t * trans_conn)
634 {
635   sctp_connection_t *sctp_conn =
636     sctp_get_connection_from_transport (trans_conn);
637
638   return sctp_snd_space (sctp_conn);
639 }
640
641 transport_connection_t *
642 sctp_session_get_transport (u32 conn_index, u32 thread_index)
643 {
644   sctp_connection_t *sctp_conn =
645     sctp_connection_get (conn_index, thread_index);
646
647   if (PREDICT_TRUE (sctp_conn != NULL))
648     return &sctp_conn->sub_conn[SCTP_PRIMARY_PATH_IDX].connection;
649
650   return NULL;
651 }
652
653 transport_connection_t *
654 sctp_session_get_listener (u32 listener_index)
655 {
656   sctp_main_t *tm = vnet_get_sctp_main ();
657   sctp_connection_t *sctp_conn;
658   sctp_conn = pool_elt_at_index (tm->listener_pool, listener_index);
659   return &sctp_conn->sub_conn[SCTP_PRIMARY_PATH_IDX].connection;
660 }
661
662 u8 *
663 format_sctp_session (u8 * s, va_list * args)
664 {
665   u32 tci = va_arg (*args, u32);
666   u32 thread_index = va_arg (*args, u32);
667   u32 verbose = va_arg (*args, u32);
668   sctp_connection_t *tc;
669
670   tc = sctp_connection_get (tci, thread_index);
671   if (tc)
672     s = format (s, "%U", format_sctp_connection, tc, verbose);
673   else
674     s = format (s, "empty\n");
675   return s;
676 }
677
678 u8 *
679 format_sctp_listener_session (u8 * s, va_list * args)
680 {
681   u32 tci = va_arg (*args, u32);
682   sctp_connection_t *tc = sctp_listener_get (tci);
683   return format (s, "%U", format_sctp_connection_id, tc);
684 }
685
686 void
687 sctp_expired_timers_cb (u32 conn_index, u32 timer_id)
688 {
689   sctp_connection_t *sctp_conn;
690
691   sctp_conn = sctp_connection_get (conn_index, vlib_get_thread_index ());
692   /* note: the connection may have already disappeared */
693   if (PREDICT_FALSE (sctp_conn == 0))
694     return;
695
696   SCTP_DBG ("%s expired", sctp_timer_to_string (timer_id));
697
698   if (sctp_conn->sub_conn[conn_index].unacknowledged_hb >
699       SCTP_PATH_MAX_RETRANS)
700     {
701       // The remote-peer is considered to be unreachable hence shutting down
702       u8 i, total_subs_down = 1;
703       for (i = 0; i < MAX_SCTP_CONNECTIONS; i++)
704         {
705           if (sctp_conn->sub_conn[i].state == SCTP_SUBCONN_STATE_DOWN)
706             continue;
707
708           u32 now = sctp_time_now ();
709           if (now > (sctp_conn->sub_conn[i].last_seen + SCTP_HB_INTERVAL))
710             {
711               total_subs_down += 1;
712               sctp_conn->sub_conn[i].state = SCTP_SUBCONN_STATE_DOWN;
713             }
714         }
715
716       if (total_subs_down == MAX_SCTP_CONNECTIONS)
717         {
718           /* Start cleanup. App wasn't notified yet so use delete notify as
719            * opposed to delete to cleanup session layer state. */
720           stream_session_delete_notify (&sctp_conn->sub_conn
721                                         [SCTP_PRIMARY_PATH_IDX].connection);
722
723           sctp_connection_timers_reset (sctp_conn);
724
725           sctp_connection_cleanup (sctp_conn);
726         }
727       return;
728     }
729
730   switch (timer_id)
731     {
732     case SCTP_TIMER_T1_INIT:
733       sctp_send_init (sctp_conn);
734       break;
735     case SCTP_TIMER_T1_COOKIE:
736       sctp_send_cookie_echo (sctp_conn);
737       break;
738     case SCTP_TIMER_T2_SHUTDOWN:
739       sctp_send_shutdown (sctp_conn);
740       break;
741     case SCTP_TIMER_T3_RXTX:
742       sctp_timer_reset (sctp_conn, conn_index, timer_id);
743       sctp_data_retransmit (sctp_conn);
744       break;
745     case SCTP_TIMER_T4_HEARTBEAT:
746       sctp_timer_reset (sctp_conn, conn_index, timer_id);
747       goto heartbeat;
748     }
749   return;
750
751 heartbeat:
752   sctp_send_heartbeat (sctp_conn);
753 }
754
755 static void
756 sctp_expired_timers_dispatch (u32 * expired_timers)
757 {
758   int i;
759   u32 connection_index, timer_id;
760
761   for (i = 0; i < vec_len (expired_timers); i++)
762     {
763       /* Get session index and timer id */
764       connection_index = expired_timers[i] & 0x0FFFFFFF;
765       timer_id = expired_timers[i] >> 28;
766
767       SCTP_DBG ("Expired timer ID: %u", timer_id);
768
769       /* Handle expiration */
770       sctp_expired_timers_cb (connection_index, timer_id);
771     }
772 }
773
774 void
775 sctp_initialize_timer_wheels (sctp_main_t * tm)
776 {
777   tw_timer_wheel_16t_2w_512sl_t *tw;
778   /* *INDENT-OFF* */
779   foreach_vlib_main (({
780     tw = &tm->timer_wheels[ii];
781     tw_timer_wheel_init_16t_2w_512sl (tw, sctp_expired_timers_dispatch,
782                                       100e-3 /* timer period 100ms */ , ~0);
783     tw->last_run_time = vlib_time_now (this_vlib_main);
784   }));
785   /* *INDENT-ON* */
786 }
787
788 clib_error_t *
789 sctp_main_enable (vlib_main_t * vm)
790 {
791   sctp_main_t *tm = vnet_get_sctp_main ();
792   vlib_thread_main_t *vtm = vlib_get_thread_main ();
793   clib_error_t *error = 0;
794   u32 num_threads;
795   int thread;
796   sctp_connection_t *sctp_conn __attribute__ ((unused));
797   u32 preallocated_connections_per_thread;
798
799   if ((error = vlib_call_init_function (vm, ip_main_init)))
800     return error;
801   if ((error = vlib_call_init_function (vm, ip4_lookup_init)))
802     return error;
803   if ((error = vlib_call_init_function (vm, ip6_lookup_init)))
804     return error;
805
806   /*
807    * Registrations
808    */
809
810   ip4_register_protocol (IP_PROTOCOL_SCTP, sctp4_input_node.index);
811   ip6_register_protocol (IP_PROTOCOL_SCTP, sctp6_input_node.index);
812
813   /*
814    * Initialize data structures
815    */
816
817   num_threads = 1 /* main thread */  + vtm->n_threads;
818   vec_validate (tm->connections, num_threads - 1);
819
820   /*
821    * Preallocate connections. Assume that thread 0 won't
822    * use preallocated threads when running multi-core
823    */
824   if (num_threads == 1)
825     {
826       thread = 0;
827       preallocated_connections_per_thread = tm->preallocated_connections;
828     }
829   else
830     {
831       thread = 1;
832       preallocated_connections_per_thread =
833         tm->preallocated_connections / (num_threads - 1);
834     }
835   for (; thread < num_threads; thread++)
836     {
837       if (preallocated_connections_per_thread)
838         pool_init_fixed (tm->connections[thread],
839                          preallocated_connections_per_thread);
840     }
841
842   /* Initialize per worker thread tx buffers (used for control messages) */
843   vec_validate (tm->tx_buffers, num_threads - 1);
844
845   /* Initialize timer wheels */
846   vec_validate (tm->timer_wheels, num_threads - 1);
847   sctp_initialize_timer_wheels (tm);
848
849   /* Initialize clocks per tick for SCTP timestamp. Used to compute
850    * monotonically increasing timestamps. */
851   tm->tstamp_ticks_per_clock = vm->clib_time.seconds_per_clock
852     / SCTP_TSTAMP_RESOLUTION;
853
854   if (num_threads > 1)
855     {
856       clib_spinlock_init (&tm->half_open_lock);
857     }
858
859   vec_validate (tm->tx_frames[0], num_threads - 1);
860   vec_validate (tm->tx_frames[1], num_threads - 1);
861   vec_validate (tm->ip_lookup_tx_frames[0], num_threads - 1);
862   vec_validate (tm->ip_lookup_tx_frames[1], num_threads - 1);
863
864   tm->bytes_per_buffer = vlib_buffer_free_list_buffer_size
865     (vm, VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX);
866
867   vec_validate (tm->time_now, num_threads - 1);
868   return error;
869 }
870
871 clib_error_t *
872 sctp_enable_disable (vlib_main_t * vm, u8 is_en)
873 {
874   if (is_en)
875     {
876       if (sctp_main.is_enabled)
877         return 0;
878
879       return sctp_main_enable (vm);
880     }
881   else
882     {
883       sctp_main.is_enabled = 0;
884     }
885
886   return 0;
887 }
888
889 transport_connection_t *
890 sctp_half_open_session_get_transport (u32 conn_index)
891 {
892   sctp_connection_t *sctp_conn = sctp_half_open_connection_get (conn_index);
893   return &sctp_conn->sub_conn[SCTP_PRIMARY_PATH_IDX].connection;
894 }
895
896 u8 *
897 format_sctp_half_open (u8 * s, va_list * args)
898 {
899   u32 tci = va_arg (*args, u32);
900   sctp_connection_t *sctp_conn = sctp_half_open_connection_get (tci);
901   return format (s, "%U", format_sctp_connection_id, sctp_conn);
902 }
903
904 void
905 sctp_update_time (f64 now, u8 thread_index)
906 {
907   sctp_set_time_now (thread_index);
908   tw_timer_expire_timers_16t_2w_512sl (&sctp_main.timer_wheels[thread_index],
909                                        now);
910   sctp_flush_frames_to_output (thread_index);
911 }
912
913 /* *INDENT OFF* */
914 const static transport_proto_vft_t sctp_proto = {
915   .enable = sctp_enable_disable,
916   .bind = sctp_session_bind,
917   .unbind = sctp_session_unbind,
918   .open = sctp_session_open,
919   .close = sctp_session_close,
920   .cleanup = sctp_session_cleanup,
921   .push_header = sctp_push_header,
922   .send_mss = sctp_session_send_mss,
923   .send_space = sctp_session_send_space,
924   .update_time = sctp_update_time,
925   .get_connection = sctp_session_get_transport,
926   .get_listener = sctp_session_get_listener,
927   .get_half_open = sctp_half_open_session_get_transport,
928   .format_connection = format_sctp_session,
929   .format_listener = format_sctp_listener_session,
930   .format_half_open = format_sctp_half_open,
931   .tx_type = TRANSPORT_TX_DEQUEUE,
932   .service_type = TRANSPORT_SERVICE_VC,
933 };
934
935 /* *INDENT ON* */
936
937 clib_error_t *
938 sctp_init (vlib_main_t * vm)
939 {
940   sctp_main_t *tm = vnet_get_sctp_main ();
941   ip_main_t *im = &ip_main;
942   ip_protocol_info_t *pi;
943   /* Session layer, and by implication SCTP, are disabled by default */
944   tm->is_enabled = 0;
945
946   /* Register with IP for header parsing */
947   pi = ip_get_protocol_info (im, IP_PROTOCOL_SCTP);
948   if (pi == 0)
949     return clib_error_return (0, "SCTP protocol info AWOL");
950   pi->format_header = format_sctp_header;
951   pi->unformat_pg_edit = unformat_pg_sctp_header;
952
953   /* Register as transport with session layer */
954   transport_register_protocol (TRANSPORT_PROTO_SCTP, &sctp_proto,
955                                FIB_PROTOCOL_IP4, sctp4_output_node.index);
956   transport_register_protocol (TRANSPORT_PROTO_SCTP, &sctp_proto,
957                                FIB_PROTOCOL_IP6, sctp6_output_node.index);
958
959   sctp_api_reference ();
960
961   return 0;
962 }
963
964 VLIB_INIT_FUNCTION (sctp_init);
965
966 /*
967  * fd.io coding-style-patch-verification: ON
968  *
969  * Local Variables:
970  * eval: (c-set-style "gnu")
971  * End:
972  */