src/vnet/sctp/sctp.h

   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 #ifndef included_vnet_sctp_h
  16 #define included_vnet_sctp_h
  17
  18 #include <vnet/vnet.h>
  19 #include <vnet/ip/ip.h>
  20 #include <vnet/sctp/sctp_timer.h>
  21 #include <vnet/sctp/sctp_packet.h>
  22 #include <vnet/session/transport.h>
  23 #include <vnet/session/session.h>
  24
  25 /* SCTP timers */
  26 #define foreach_sctp_timer                      \
  27   _(T1_INIT, "T1_INIT")                                 \
  28   _(T1_COOKIE, "T1_COOKIE")                             \
  29   _(T2_SHUTDOWN, "T2_SHUTDOWN")                 \
  30   _(T3_RXTX, "T3_RXTX")                                         \
  31   _(T4_HEARTBEAT, "T4_HB")                                      \
  32   _(T5_SHUTDOWN_GUARD, "T5_SHUTDOWN_GUARD")
  33
  34 typedef enum _sctp_timers
  35 {
  36 #define _(sym, str) SCTP_TIMER_##sym,
  37   foreach_sctp_timer
  38 #undef _
  39   SCTP_N_TIMERS
  40 } sctp_timers_e;
  41
  42 #define SCTP_TIMER_HANDLE_INVALID ((u32) ~0)
  43
  44 always_inline char *
  45 sctp_timer_to_string (u8 timer_id)
  46 {
  47   switch (timer_id)
  48     {
  49     case SCTP_TIMER_T1_INIT:
  50       return "SCTP_TIMER_T1_INIT";
  51     case SCTP_TIMER_T1_COOKIE:
  52       return "SCTP_TIMER_T1_COOKIE";
  53     case SCTP_TIMER_T2_SHUTDOWN:
  54       return "SCTP_TIMER_T2_SHUTDOWN";
  55     case SCTP_TIMER_T3_RXTX:
  56       return "SCTP_TIMER_T3_RXTX";
  57     case SCTP_TIMER_T4_HEARTBEAT:
  58       return "SCTP_TIMER_T4_HEARTBEAT";
  59     case SCTP_TIMER_T5_SHUTDOWN_GUARD:
  60       return "SCTP_TIMER_T5_SHUTDOWN_GUARD";
  61     }
  62   return NULL;
  63 }
  64
  65 typedef enum _sctp_error
  66 {
  67 #define sctp_error(n,s) SCTP_ERROR_##n,
  68 #include <vnet/sctp/sctp_error.def>
  69 #undef sctp_error
  70   SCTP_N_ERROR,
  71 } sctp_error_t;
  72
  73 #define NO_FLAG 0
  74
  75 #define IS_T_BIT_SET(var) ((var) & (1))
  76 #define IS_E_BIT_SET(var) ((var) & (1))
  77 #define IS_B_BIT_SET(var) ((var) & (1<<1))
  78 #define IS_U_BIT_SET(var) ((var) & (1<<2))
  79
  80 #define MAX_SCTP_CONNECTIONS 32
  81 #define MAIN_SCTP_SUB_CONN_IDX 0
  82
  83 #if (VLIB_BUFFER_TRACE_TRAJECTORY)
  84 #define sctp_trajectory_add_start(b, start)                     \
  85 {                                                               \
  86     (*vlib_buffer_trace_trajectory_cb) (b, start);              \
  87 }
  88 #else
  89 #define sctp_trajectory_add_start(b, start)
  90 #endif
  91
  92 typedef struct _sctp_sub_connection
  93 {
  94   transport_connection_t connection;          /**< Common transport data. First! */
  95   void *parent;                                                         /**< Link to the parent-super connection */
  96
  97   u32 error_count; /**< The current error count for this destination. */
  98   u32 error_threshold; /**< Current error threshold for this destination,
  99                                 i.e. what value marks the destination down if error count reaches this value. */
 100   u32 cwnd; /**< The current congestion window. */
 101   u32 ssthresh; /**< The current ssthresh value. */
 102
 103   u32 rtt_ts;   /**< USED to hold the timestamp of when the packet has been sent */
 104
 105   u32 RTO; /**< The current retransmission timeout value. */
 106   u32 SRTT; /**< The current smoothed round-trip time. */
 107   f32 RTTVAR; /**< The current RTT variation. */
 108
 109   u32 partially_acked_bytes; /**< The tracking method for increase of cwnd when in
 110                                   congestion avoidance mode (see Section 7.2.2).*/
 111
 112   u8 state; /**< The current state of this destination, i.e., DOWN, UP, ALLOW-HB, NO-HEARTBEAT, etc. */
 113
 114   u16 PMTU; /**< The current known path MTU. */
 115
 116   u32 timers[SCTP_N_TIMERS]; /**< A timer used by each destination. */
 117
 118   u8 RTO_pending; /**< A flag used to track if one of the DATA chunks sent to
 119                                   this address is currently being used to compute an RTT.
 120                                   If this flag is 0, the next DATA chunk sent to this destination
 121                                   should be used to compute an RTT and this flag should be set.
 122                                   Every time the RTT calculation completes (i.e., the DATA chunk is SACK'd),
 123                                   clear this flag. */
 124
 125   u32 last_time; /**< The time to which this destination was last sent a packet to.
 126                                   This can be used to determine if a HEARTBEAT is needed. */
 127
 128   u8 unacknowledged_hb; /**< Used to track how many unacknowledged heartbeats we had;
 129                                   If more than Max.Retransmit then connetion is considered unreachable. */
 130
 131 } sctp_sub_connection_t;
 132
 133 typedef struct
 134 {
 135   u32 a_rwnd; /**< Maximum segment size advertised */
 136
 137 } sctp_options_t;
 138
 139 /* Useful macros to deal with the out_of_order_map (array of bit) */
 140 #define SET_BIT(A,k)     ( A[(k/32)] |= (1 << (k%32)) )
 141 #define CLEAR_BIT(A,k)   ( A[(k/32)] &= ~(1 << (k%32)) )
 142 #define TEST_BIT(A,k)    ( A[(k/32)] & (1 << (k%32)) )
 143
 144 always_inline void
 145 _bytes_swap (void *pv, size_t n)
 146 {
 147   char *p = pv;
 148   size_t lo, hi;
 149   for (lo = 0, hi = n - 1; hi > lo; lo++, hi--)
 150     {
 151       char tmp = p[lo];
 152       p[lo] = p[hi];
 153       p[hi] = tmp;
 154     }
 155 }
 156
 157 #define ENDIANESS_SWAP(x) _bytes_swap(&x, sizeof(x));
 158
 159 #define MAX_INFLIGHT_PACKETS    128
 160 #define MAX_ENQUEABLE_SACKS 2
 161
 162 /* This parameter indicates to the receiver how much increment in
 163  * milliseconds the sender wishes the receiver to add to its default
 164  * cookie life-span.
 165  */
 166 #define SUGGESTED_COOKIE_LIFE_SPAN_INCREMENT 1000
 167
 168 typedef struct _sctp_connection
 169 {
 170   sctp_sub_connection_t sub_conn[MAX_SCTP_CONNECTIONS]; /**< Common transport data. First! */
 171
 172   u8 state;                     /**< SCTP state as per sctp_state_t */
 173   u16 flags;            /**< Chunk flag (see sctp_chunks_common_hdr_t) */
 174
 175   u32 local_tag;        /**< INIT_TAG generated locally */
 176   u32 remote_tag;       /**< INIT_TAG generated by the remote peer */
 177
 178   u32 local_initial_tsn; /**< Initial TSN generated locally */
 179   u32 remote_initial_tsn; /**< Initial TSN generated by the remote-peer */
 180
 181   u32 peer_cookie_life_span_increment;
 182
 183   u32 overall_err_count; /**< The overall association error count. */
 184   u32 overall_err_treshold; /**< The threshold for this association that if the Overall Error Count
 185                                   reaches will cause this association to be torn down. */
 186
 187   u32 peer_rwnd; /**< Current calculated value of the peer's rwnd. */
 188
 189   u32 next_tsn; /**< The next TSN number to be assigned to a new DATA chunk.
 190                  This is sent in the INIT or INIT ACK chunk to the peer
 191                  and incremented each time a DATA chunk is assigned a
 192                  TSN (normally just prior to transmit or during
 193                  fragmentation). */
 194
 195   u32 next_tsn_expected; /**< The next TSN number expected to be received. */
 196
 197   u32 last_rcvd_tsn; /**< This is the last TSN received in sequence. This value
 198                          is set initially by taking the peer's initial TSN,
 199                  received in the INIT or INIT ACK chunk, and
 200                  subtracting one from it. */
 201
 202   u32 out_of_order_map[MAX_INFLIGHT_PACKETS]; /**< An array of bits or bytes indicating which out-of-order
 203                                 TSNs have been received (relative to the Last Rcvd TSN).
 204                                 If no gaps exist, i.e., no out-of-order packets have been received,
 205                                 this array will be set to all zero. */
 206
 207   u8 ack_state; /**< This flag indicates if the next received packet is set to be responded to with a SACK.
 208                                 This is initialized to 0. When a packet is received it is incremented.
 209                                 If this value reaches 2 or more, a SACK is sent and the value is reset to 0.
 210                                 Note: This is used only when no DATA chunks are received out-of-order.
 211                                 When DATA chunks are out-of-order, SACKs are not delayed (see Section 6). */
 212
 213   u32 a_rwnd; /** This value represents the dedicated buffer space, in number of bytes,
 214                                 the sender of the INIT has reserved in association with this window.
 215                                 During the life of the association, this buffer space SHOULD NOT be lessened
 216                                 (i.e., dedicated buffers taken away from this association);
 217                                 however, an endpoint MAY change the value of a_rwnd it sends in SACK chunks. */
 218
 219   u32 smallest_PMTU; /** The smallest PMTU discovered for all of the peer's transport addresses. */
 220
 221   u32 rcv_a_rwnd;               /**< LOCAL max seg size that includes options. To be updated by congestion algos, etc. */
 222   u32 snd_a_rwnd;               /**< REMOTE max seg size that includes options. To be updated if peer pushes back on window, etc.*/
 223
 224   u8 overall_sending_status; /**< 0 indicates first fragment of a user message
 225                                                                   1 indicates normal stream
 226                                                                   2 indicates last fragment of a user message */
 227
 228   sctp_options_t rcv_opts;
 229   sctp_options_t snd_opts;
 230
 231   u32 snd_hdr_length;   /**< BASE HEADER LENGTH for the DATA chunk when sending */
 232   u8 next_avail_sub_conn; /**< Represent the index of the next free slot in sub_conn */
 233
 234 } sctp_connection_t;
 235
 236 typedef void (sctp_timer_expiration_handler) (u32 conn_index, u32 timer_id);
 237
 238 sctp_connection_t *sctp_connection_new (u8 thread_index);
 239 void sctp_sub_connection_add_ip4 (u8 thread_index,
 240                                   sctp_ipv4_addr_param_t * ipv4_addr);
 241 void sctp_sub_connection_add_ip6 (u8 thread_index,
 242                                   sctp_ipv6_addr_param_t * ipv6_addr);
 243 void sctp_connection_close (sctp_connection_t * sctp_conn);
 244 void sctp_connection_cleanup (sctp_connection_t * sctp_conn);
 245 void sctp_connection_del (sctp_connection_t * sctp_conn);
 246
 247 u32 sctp_push_header (transport_connection_t * tconn, vlib_buffer_t * b);
 248 void sctp_send_init (sctp_connection_t * sctp_conn);
 249 void sctp_send_shutdown (sctp_connection_t * sctp_conn);
 250 void sctp_send_shutdown_ack (sctp_connection_t * sctp_conn);
 251 void sctp_send_shutdown_complete (sctp_connection_t * sctp_conn);
 252 void sctp_send_heartbeat (sctp_connection_t * sctp_conn);
 253 void sctp_flush_frame_to_output (vlib_main_t * vm, u8 thread_index,
 254                                  u8 is_ip4);
 255 void sctp_flush_frames_to_output (u8 thread_index);
 256 void sctp_punt_unknown (vlib_main_t * vm, u8 is_ip4, u8 is_add);
 257
 258 format_function_t format_sctp_state;
 259
 260 u8 *format_sctp_connection_id (u8 * s, va_list * args);
 261 u8 *format_sctp_connection (u8 * s, va_list * args);
 262 u8 *format_sctp_scoreboard (u8 * s, va_list * args);
 263 u8 *format_sctp_header (u8 * s, va_list * args);
 264 u8 *format_sctp_tx_trace (u8 * s, va_list * args);
 265
 266 clib_error_t *sctp_init (vlib_main_t * vm);
 267 void sctp_connection_timers_init (sctp_connection_t * tc);
 268 void sctp_connection_timers_reset (sctp_connection_t * tc);
 269 void sctp_init_snd_vars (sctp_connection_t * tc);
 270 void sctp_init_mss (sctp_connection_t * tc);
 271
 272 void sctp_prepare_initack_chunk (sctp_connection_t * ts, vlib_buffer_t * b,
 273                                  ip4_address_t * ip4_addr,
 274                                  ip6_address_t * ip6_addr);
 275 void sctp_prepare_cookie_echo_chunk (sctp_connection_t * tc,
 276                                      vlib_buffer_t * b,
 277                                      sctp_state_cookie_param_t * sc);
 278 void sctp_prepare_cookie_ack_chunk (sctp_connection_t * tc,
 279                                     vlib_buffer_t * b);
 280 void sctp_prepare_sack_chunk (sctp_connection_t * tc, vlib_buffer_t * b);
 281 void sctp_prepare_heartbeat_ack_chunk (sctp_connection_t * sctp_conn,
 282                                        vlib_buffer_t * b);
 283
 284 u16 sctp_check_outstanding_data_chunks (sctp_connection_t * tc);
 285
 286 #define SCTP_TICK 0.001                 /**< SCTP tick period (s) */
 287 #define STHZ (u32) (1/SCTP_TICK)                /**< SCTP tick frequency */
 288 #define SCTP_TSTAMP_RESOLUTION SCTP_TICK        /**< Time stamp resolution */
 289 #define SCTP_PAWS_IDLE 24 * 24 * 60 * 60 * THZ /**< 24 days */
 290 #define SCTP_FIB_RECHECK_PERIOD 1 * THZ /**< Recheck every 1s */
 291 #define SCTP_MAX_OPTION_SPACE 40
 292
 293 #define SCTP_DUPACK_THRESHOLD   3
 294 #define SCTP_MAX_RX_FIFO_SIZE   4 << 20
 295 #define SCTP_MIN_RX_FIFO_SIZE   4 << 10
 296 #define SCTP_IW_N_SEGMENTS      10
 297 #define SCTP_ALWAYS_ACK         1       /**< On/off delayed acks */
 298 #define SCTP_USE_SACKS          1       /**< Disable only for testing */
 299
 300 #define IP_PROTOCOL_SCTP        132
 301
 302 /** SSCTP FSM state definitions as per RFC4960. */
 303 #define foreach_sctp_fsm_state                \
 304   _(CLOSED, "CLOSED")                         \
 305   _(COOKIE_WAIT, "COOKIE_WAIT")               \
 306   _(COOKIE_ECHOED, "COOKIE_ECHOED")           \
 307   _(ESTABLISHED, "ESTABLISHED")               \
 308   _(SHUTDOWN_PENDING, "SHUTDOWN_PENDING")     \
 309   _(SHUTDOWN_SENT, "SHUTDOWN_SENT")           \
 310   _(SHUTDOWN_RECEIVED, "SHUTDOWN_RECEIVED")   \
 311   _(SHUTDOWN_ACK_SENT, "SHUTDOWN_ACK_SENT")
 312
 313 typedef enum _sctp_state
 314 {
 315 #define _(sym, str) SCTP_STATE_##sym,
 316   foreach_sctp_fsm_state
 317 #undef _
 318   SCTP_N_STATES
 319 } sctp_state_t;
 320
 321 always_inline char *
 322 sctp_state_to_string (u8 state)
 323 {
 324   switch (state)
 325     {
 326     case SCTP_STATE_CLOSED:
 327       return "SCTP_STATE_CLOSED";
 328     case SCTP_STATE_COOKIE_WAIT:
 329       return "SCTP_STATE_COOKIE_WAIT";
 330     case SCTP_STATE_COOKIE_ECHOED:
 331       return "SCTP_STATE_COOKIE_ECHOED";
 332     case SCTP_STATE_ESTABLISHED:
 333       return "SCTP_STATE_ESTABLISHED";
 334     case SCTP_STATE_SHUTDOWN_PENDING:
 335       return "SCTP_STATE_SHUTDOWN_PENDING";
 336     case SCTP_STATE_SHUTDOWN_SENT:
 337       return "SCTP_STATE_SHUTDOWN_SENT";
 338     case SCTP_STATE_SHUTDOWN_RECEIVED:
 339       return "SCTP_STATE_SHUTDOWN_RECEIVED";
 340     case SCTP_STATE_SHUTDOWN_ACK_SENT:
 341       return "SCTP_STATE_SHUTDOWN_ACK_SENT";
 342     }
 343   return NULL;
 344 }
 345
 346 always_inline char *
 347 sctp_chunk_to_string (u8 type)
 348 {
 349   switch (type)
 350     {
 351     case DATA:
 352       return "DATA";
 353     case INIT:
 354       return "INIT";
 355     case INIT_ACK:
 356       return "INIT_ACK";
 357     case SACK:
 358       return "SACK";
 359     case HEARTBEAT:
 360       return "HEARTBEAT";
 361     case HEARTBEAT_ACK:
 362       return "HEARTBEAT_ACK";
 363     case ABORT:
 364       return "ABORT";
 365     case SHUTDOWN:
 366       return "SHUTDOWN";
 367     case SHUTDOWN_ACK:
 368       return "SHUTDOWN_ACK";
 369     case OPERATION_ERROR:
 370       return "OPERATION_ERROR";
 371     case COOKIE_ECHO:
 372       return "COOKIE_ECHO";
 373     case COOKIE_ACK:
 374       return "COOKIE_ACK";
 375     case ECNE:
 376       return "ECNE";
 377     case CWR:
 378       return "CWR";
 379     case SHUTDOWN_COMPLETE:
 380       return "SHUTDOWN_COMPLETE";
 381     }
 382   return NULL;
 383 }
 384
 385 always_inline char *
 386 sctp_optparam_type_to_string (u8 type)
 387 {
 388   switch (type)
 389     {
 390     case SCTP_IPV4_ADDRESS_TYPE:
 391       return "SCTP_IPV4_ADDRESS_TYPE";
 392     case SCTP_IPV6_ADDRESS_TYPE:
 393       return "SCTP_IPV6_ADDRESS_TYPE";
 394     case SCTP_STATE_COOKIE_TYPE:
 395       return "SCTP_STATE_COOKIE_TYPE";
 396     case SCTP_UNRECOGNIZED_TYPE:
 397       return "SCTP_UNRECOGNIZED_TYPE";
 398     case SCTP_COOKIE_PRESERVATIVE_TYPE:
 399       return "SCTP_COOKIE_PRESERVATIVE_TYPE";
 400     case SCTP_HOSTNAME_ADDRESS_TYPE:
 401       return "SCTP_HOSTNAME_ADDRESS_TYPE";
 402     case SCTP_SUPPORTED_ADDRESS_TYPES:
 403       return "SCTP_SUPPORTED_ADDRESS_TYPES";
 404     }
 405   return NULL;
 406 }
 407
 408 #define SCTP_TICK 0.001                 /**< SCTP tick period (s) */
 409 #define SHZ (u32) (1/SCTP_TICK)         /**< SCTP tick frequency */
 410
 411 /* As per RFC4960, page 83 */
 412 #define SCTP_RTO_INIT 3 * SHZ   /* 3 seconds */
 413 #define SCTP_RTO_MIN 1 * SHZ    /* 1 second */
 414 #define SCTP_RTO_MAX 60 * SHZ   /* 60 seconds */
 415 #define SCTP_RTO_BURST  4
 416 #define SCTP_RTO_ALPHA 1/8
 417 #define SCTP_RTO_BETA 1/4
 418 #define SCTP_VALID_COOKIE_LIFE 60 * SHZ /* 60 seconds */
 419 #define SCTP_ASSOCIATION_MAX_RETRANS 10
 420
 421 #define SCTP_TO_TIMER_TICK       SCTP_TICK*10   /* Period for converting from SCTP_TICK */
 422
 423 typedef struct _sctp_lookup_dispatch
 424 {
 425   u8 next, error;
 426 } sctp_lookup_dispatch_t;
 427
 428 typedef struct _sctp_main
 429 {
 430   /* Per-worker thread SCTP connection pools */
 431   sctp_connection_t **connections;
 432
 433   /* Pool of listeners. */
 434   sctp_connection_t *listener_pool;
 435
 436           /** Dispatch table by state and flags */
 437   sctp_lookup_dispatch_t dispatch_table[SCTP_N_STATES][64];
 438
 439   u8 log2_tstamp_clocks_per_tick;
 440   f64 tstamp_ticks_per_clock;
 441   u32 *time_now;
 442
 443           /** per-worker tx buffer free lists */
 444   u32 **tx_buffers;
 445           /** per-worker tx frames to SCTP 4/6 output nodes */
 446   vlib_frame_t **tx_frames[2];
 447           /** per-worker tx frames to ip 4/6 lookup nodes */
 448   vlib_frame_t **ip_lookup_tx_frames[2];
 449
 450   /* Per worker-thread timer wheel for connections timers */
 451   tw_timer_wheel_16t_2w_512sl_t *timer_wheels;
 452
 453   /* Pool of half-open connections on which we've sent a SYN */
 454   sctp_connection_t *half_open_connections;
 455   clib_spinlock_t half_open_lock;
 456
 457   /* TODO: Congestion control algorithms registered */
 458   /* sctp_cc_algorithm_t *cc_algos; */
 459
 460   /* Flag that indicates if stack is on or off */
 461   u8 is_enabled;
 462
 463           /** Number of preallocated connections */
 464   u32 preallocated_connections;
 465
 466           /** Transport table (preallocation) size parameters */
 467   u32 local_endpoints_table_memory;
 468   u32 local_endpoints_table_buckets;
 469
 470           /** Vectors of src addresses. Optional unless one needs > 63K active-opens */
 471   ip4_address_t *ip4_src_addresses;
 472   u32 last_v4_address_rotor;
 473   u32 last_v6_address_rotor;
 474   ip6_address_t *ip6_src_addresses;
 475
 476           /** vlib buffer size */
 477   u32 bytes_per_buffer;
 478
 479   u8 punt_unknown4;
 480   u8 punt_unknown6;
 481
 482 } sctp_main_t;
 483
 484 extern sctp_main_t sctp_main;
 485 extern vlib_node_registration_t sctp4_input_node;
 486 extern vlib_node_registration_t sctp6_input_node;
 487 extern vlib_node_registration_t sctp4_output_node;
 488 extern vlib_node_registration_t sctp6_output_node;
 489
 490 always_inline sctp_main_t *
 491 vnet_get_sctp_main ()
 492 {
 493   return &sctp_main;
 494 }
 495
 496 always_inline sctp_header_t *
 497 sctp_buffer_hdr (vlib_buffer_t * b)
 498 {
 499   ASSERT ((signed) b->current_data >= (signed) -VLIB_BUFFER_PRE_DATA_SIZE);
 500   return (sctp_header_t *) (b->data + b->current_data
 501                             + vnet_buffer (b)->sctp.hdr_offset);
 502 }
 503
 504 clib_error_t *vnet_sctp_enable_disable (vlib_main_t * vm, u8 is_en);
 505
 506 always_inline sctp_connection_t *
 507 sctp_half_open_connection_get (u32 conn_index)
 508 {
 509   sctp_connection_t *tc = 0;
 510   clib_spinlock_lock_if_init (&sctp_main.half_open_lock);
 511   if (!pool_is_free_index (sctp_main.half_open_connections, conn_index))
 512     tc = pool_elt_at_index (sctp_main.half_open_connections, conn_index);
 513   tc->sub_conn[MAIN_SCTP_SUB_CONN_IDX].parent = tc;
 514   clib_spinlock_unlock_if_init (&sctp_main.half_open_lock);
 515   return tc;
 516 }
 517
 518 /**
 519  * Cleanup half-open connection
 520  *
 521  */
 522 always_inline void
 523 sctp_half_open_connection_del (sctp_connection_t * tc)
 524 {
 525   sctp_main_t *tm = vnet_get_sctp_main ();
 526   clib_spinlock_lock_if_init (&tm->half_open_lock);
 527   pool_put_index (tm->half_open_connections,
 528                   tc->sub_conn[MAIN_SCTP_SUB_CONN_IDX].c_c_index);
 529   if (CLIB_DEBUG)
 530     memset (tc, 0xFA, sizeof (*tc));
 531   clib_spinlock_unlock_if_init (&tm->half_open_lock);
 532 }
 533
 534 always_inline u32
 535 sctp_set_time_now (u32 thread_index)
 536 {
 537   sctp_main.time_now[thread_index] = clib_cpu_time_now ()
 538     * sctp_main.tstamp_ticks_per_clock;
 539   return sctp_main.time_now[thread_index];
 540 }
 541
 542 always_inline void
 543 sctp_timer_set (sctp_connection_t * tc, u8 conn_idx, u8 timer_id,
 544                 u32 interval)
 545 {
 546   ASSERT (tc->sub_conn[conn_idx].connection.thread_index ==
 547           vlib_get_thread_index ());
 548   ASSERT (tc->sub_conn[conn_idx].timers[timer_id] ==
 549           SCTP_TIMER_HANDLE_INVALID);
 550
 551   sctp_sub_connection_t *sub = &tc->sub_conn[conn_idx];
 552   sub->timers[timer_id] =
 553     tw_timer_start_16t_2w_512sl (&sctp_main.timer_wheels[sub->c_thread_index],
 554                                  sub->c_c_index, timer_id, interval);
 555 }
 556
 557 always_inline void
 558 sctp_timer_reset (sctp_connection_t * tc, u8 conn_idx, u8 timer_id)
 559 {
 560   ASSERT (tc->sub_conn[conn_idx].c_thread_index == vlib_get_thread_index ());
 561   if (tc->sub_conn[conn_idx].timers[timer_id] == SCTP_TIMER_HANDLE_INVALID)
 562     return;
 563
 564   sctp_sub_connection_t *sub = &tc->sub_conn[conn_idx];
 565
 566   tw_timer_stop_16t_2w_512sl (&sctp_main.timer_wheels[sub->c_thread_index],
 567                               sub->timers[timer_id]);
 568   sub->timers[timer_id] = SCTP_TIMER_HANDLE_INVALID;
 569 }
 570
 571 /**
 572  * Try to cleanup half-open connection
 573  *
 574  * If called from a thread that doesn't own tc, the call won't have any
 575  * effect.
 576  *
 577  * @param tc - connection to be cleaned up
 578  * @return non-zero if cleanup failed.
 579  */
 580 always_inline int
 581 sctp_half_open_connection_cleanup (sctp_connection_t * tc)
 582 {
 583   /* Make sure this is the owning thread */
 584   if (tc->sub_conn[MAIN_SCTP_SUB_CONN_IDX].c_thread_index !=
 585       vlib_get_thread_index ())
 586     return 1;
 587   sctp_timer_reset (tc, MAIN_SCTP_SUB_CONN_IDX, SCTP_TIMER_T1_INIT);
 588   sctp_half_open_connection_del (tc);
 589   return 0;
 590 }
 591
 592 always_inline u32
 593 sctp_header_bytes ()
 594 {
 595   return sizeof (sctp_header_t);
 596 }
 597
 598 always_inline sctp_connection_t *
 599 sctp_get_connection_from_transport (transport_connection_t * tconn)
 600 {
 601   ASSERT (tconn != NULL);
 602
 603   sctp_sub_connection_t *sub = (sctp_sub_connection_t *) tconn;
 604 #if SCTP_ADV_DEBUG
 605   if (sub == NULL)
 606     SCTP_ADV_DBG ("sub == NULL");
 607   if (sub->parent == NULL)
 608     SCTP_ADV_DBG ("sub->parent == NULL");
 609 #endif
 610   return (sctp_connection_t *) sub->parent;
 611 }
 612
 613 always_inline u32
 614 sctp_time_now (void)
 615 {
 616   return sctp_main.time_now[vlib_get_thread_index ()];
 617 }
 618
 619 #define ABS(x) ((x) > 0) ? (x) : -(x);
 620
 621 always_inline void
 622 sctp_calculate_rto (sctp_connection_t * sctp_conn, u8 conn_idx)
 623 {
 624   /* See RFC4960, 6.3.1.  RTO Calculation */
 625   u32 RTO = 0;
 626   f32 RTTVAR = 0;
 627   u32 now = sctp_time_now ();
 628   u32 prev_ts = sctp_conn->sub_conn[conn_idx].rtt_ts;
 629   u32 R = prev_ts - now;
 630
 631   if (sctp_conn->sub_conn[conn_idx].RTO == 0)   // C1: Let's initialize our RTO
 632     {
 633       sctp_conn->sub_conn[conn_idx].RTO = SCTP_RTO_MIN;
 634       return;
 635     }
 636
 637   if (sctp_conn->sub_conn[conn_idx].RTO == SCTP_RTO_MIN && sctp_conn->sub_conn[conn_idx].SRTT == 0)     // C2: First RTT calculation
 638     {
 639       sctp_conn->sub_conn[conn_idx].SRTT = R;
 640       RTTVAR = R / 2;
 641
 642       if (RTTVAR == 0)
 643         RTTVAR = 100e-3;        /* 100 ms */
 644
 645       sctp_conn->sub_conn[conn_idx].RTTVAR = RTTVAR;
 646     }
 647   else                          // C3: RTT already exists; let's recalculate
 648     {
 649       RTTVAR = (1 - SCTP_RTO_BETA) * sctp_conn->sub_conn[conn_idx].RTTVAR +
 650         SCTP_RTO_BETA * ABS (sctp_conn->sub_conn[conn_idx].SRTT - R);
 651
 652       if (RTTVAR == 0)
 653         RTTVAR = 100e-3;        /* 100 ms */
 654
 655       sctp_conn->sub_conn[conn_idx].RTTVAR = RTTVAR;
 656
 657       sctp_conn->sub_conn[conn_idx].SRTT =
 658         (1 - SCTP_RTO_ALPHA) * sctp_conn->sub_conn[conn_idx].SRTT +
 659         SCTP_RTO_ALPHA * R;
 660     }
 661
 662   RTO =
 663     sctp_conn->sub_conn[conn_idx].SRTT +
 664     4 * sctp_conn->sub_conn[conn_idx].RTTVAR;
 665   if (RTO < SCTP_RTO_MIN)       // C6
 666     RTO = SCTP_RTO_MIN;
 667
 668   if (RTO > SCTP_RTO_MAX)       // C7
 669     RTO = SCTP_RTO_MAX;
 670
 671   sctp_conn->sub_conn[conn_idx].RTO = RTO;
 672 }
 673
 674 always_inline void
 675 sctp_timer_update (sctp_connection_t * tc, u8 conn_idx, u8 timer_id,
 676                    u32 interval)
 677 {
 678   ASSERT (tc->sub_conn[conn_idx].connection.thread_index ==
 679           vlib_get_thread_index ());
 680   sctp_sub_connection_t *sub = &tc->sub_conn[conn_idx];
 681
 682   if (tc->sub_conn[conn_idx].timers[timer_id] != SCTP_TIMER_HANDLE_INVALID)
 683     tw_timer_stop_16t_2w_512sl (&sctp_main.timer_wheels[sub->c_thread_index],
 684                                 sub->timers[timer_id]);
 685
 686   tc->sub_conn[conn_idx].timers[timer_id] =
 687     tw_timer_start_16t_2w_512sl (&sctp_main.timer_wheels[sub->c_thread_index],
 688                                  sub->c_c_index, timer_id, interval);
 689 }
 690
 691 always_inline sctp_connection_t *
 692 sctp_listener_get (u32 tli)
 693 {
 694   return pool_elt_at_index (sctp_main.listener_pool, tli);
 695 }
 696
 697 #endif
 698
 699 always_inline sctp_connection_t *
 700 sctp_connection_get (u32 conn_index, u32 thread_index)
 701 {
 702   if (PREDICT_FALSE
 703       (pool_is_free_index (sctp_main.connections[thread_index], conn_index)))
 704     return 0;
 705   return pool_elt_at_index (sctp_main.connections[thread_index], conn_index);
 706 }
 707
 708 always_inline u8
 709 sctp_pick_conn_idx_on_chunk (sctp_chunk_type chunk_type)
 710 {
 711   u8 idx = MAIN_SCTP_SUB_CONN_IDX;
 712
 713   switch (chunk_type)
 714     {
 715     case DATA:
 716     case INIT:
 717     case INIT_ACK:
 718     case SACK:
 719     case HEARTBEAT:
 720     case HEARTBEAT_ACK:
 721     case ABORT:
 722     case SHUTDOWN:
 723     case SHUTDOWN_ACK:
 724     case OPERATION_ERROR:
 725     case COOKIE_ECHO:
 726     case COOKIE_ACK:
 727     case ECNE:
 728     case CWR:
 729     case SHUTDOWN_COMPLETE:
 730       idx = MAIN_SCTP_SUB_CONN_IDX;
 731     }
 732   return idx;
 733 }
 734
 735 always_inline u8
 736 sctp_pick_conn_idx_on_state (sctp_state_t state)
 737 {
 738   u8 idx = MAIN_SCTP_SUB_CONN_IDX;
 739
 740   switch (state)
 741     {
 742     case SCTP_STATE_CLOSED:
 743     case SCTP_STATE_COOKIE_WAIT:
 744     case SCTP_STATE_COOKIE_ECHOED:
 745     case SCTP_STATE_ESTABLISHED:
 746     case SCTP_STATE_SHUTDOWN_PENDING:
 747     case SCTP_STATE_SHUTDOWN_SENT:
 748     case SCTP_STATE_SHUTDOWN_RECEIVED:
 749     case SCTP_STATE_SHUTDOWN_ACK_SENT:
 750       idx = MAIN_SCTP_SUB_CONN_IDX;
 751     default:
 752       idx = MAIN_SCTP_SUB_CONN_IDX;
 753     }
 754   return idx;
 755 }
 756
 757 /**
 758  * Push SCTP header to buffer
 759  *
 760  * @param vm - vlib_main
 761  * @param b - buffer to write the header to
 762  * @param sp_net - source port net order
 763  * @param dp_net - destination port net order
 764  * @param sctp_hdr_opts_len - header and options length in bytes
 765  *
 766  * @return - pointer to start of SCTP header
 767  */
 768 always_inline void *
 769 vlib_buffer_push_sctp_net_order (vlib_buffer_t * b, u16 sp, u16 dp,
 770                                  u8 sctp_hdr_opts_len)
 771 {
 772   sctp_full_hdr_t *full_hdr;
 773
 774   full_hdr = vlib_buffer_push_uninit (b, sctp_hdr_opts_len);
 775
 776   full_hdr->hdr.src_port = sp;
 777   full_hdr->hdr.dst_port = dp;
 778   full_hdr->hdr.checksum = 0;
 779   return full_hdr;
 780 }
 781
 782 /**
 783  * Push SCTP header to buffer
 784  *
 785  * @param b - buffer to write the header to
 786  * @param sp_net - source port net order
 787  * @param dp_net - destination port net order
 788  * @param sctp_hdr_opts_len - header and options length in bytes
 789  *
 790  * @return - pointer to start of SCTP header
 791  */
 792 always_inline void *
 793 vlib_buffer_push_sctp (vlib_buffer_t * b, u16 sp_net, u16 dp_net,
 794                        u8 sctp_hdr_opts_len)
 795 {
 796   return vlib_buffer_push_sctp_net_order (b, sp_net, dp_net,
 797                                           sctp_hdr_opts_len);
 798 }
 799
 800 /*
 801  * fd.io coding-style-patch-verification: ON
 802  *
 803  * Local Variables:
 804  * eval: (c-set-style "gnu")
 805  * End:
 806  */