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