src/vnet/tcp/tcp.h

   1 /*
   2  * Copyright (c) 2016-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 #ifndef _vnet_tcp_h_
  17 #define _vnet_tcp_h_
  18
  19 #include <vnet/vnet.h>
  20 #include <vnet/ip/ip.h>
  21 #include <vnet/tcp/tcp_packet.h>
  22 #include <vnet/tcp/tcp_timer.h>
  23 #include <vnet/session/transport.h>
  24 #include <vnet/session/session.h>
  25 #include <vnet/tcp/tcp_debug.h>
  26
  27 #define TCP_TICK 0.001                  /**< TCP tick period (s) */
  28 #define THZ (u32) (1/TCP_TICK)          /**< TCP tick frequency */
  29 #define TCP_TSTAMP_RESOLUTION TCP_TICK  /**< Time stamp resolution */
  30 #define TCP_PAWS_IDLE 24 * 24 * 60 * 60 * THZ /**< 24 days */
  31 #define TCP_FIB_RECHECK_PERIOD  1 * THZ /**< Recheck every 1s */
  32 #define TCP_MAX_OPTION_SPACE 40
  33 #define TCP_CC_DATA_SZ 24
  34
  35 #define TCP_DUPACK_THRESHOLD    3
  36 #define TCP_MAX_RX_FIFO_SIZE    32 << 20
  37 #define TCP_MIN_RX_FIFO_SIZE    4 << 10
  38 #define TCP_IW_N_SEGMENTS       10
  39 #define TCP_ALWAYS_ACK          1       /**< On/off delayed acks */
  40 #define TCP_USE_SACKS           1       /**< Disable only for testing */
  41
  42 /** TCP FSM state definitions as per RFC793. */
  43 #define foreach_tcp_fsm_state   \
  44   _(CLOSED, "CLOSED")           \
  45   _(LISTEN, "LISTEN")           \
  46   _(SYN_SENT, "SYN_SENT")       \
  47   _(SYN_RCVD, "SYN_RCVD")       \
  48   _(ESTABLISHED, "ESTABLISHED") \
  49   _(CLOSE_WAIT, "CLOSE_WAIT")   \
  50   _(FIN_WAIT_1, "FIN_WAIT_1")   \
  51   _(LAST_ACK, "LAST_ACK")       \
  52   _(CLOSING, "CLOSING")         \
  53   _(FIN_WAIT_2, "FIN_WAIT_2")   \
  54   _(TIME_WAIT, "TIME_WAIT")
  55
  56 typedef enum _tcp_state
  57 {
  58 #define _(sym, str) TCP_STATE_##sym,
  59   foreach_tcp_fsm_state
  60 #undef _
  61   TCP_N_STATES
  62 } tcp_state_t;
  63
  64 format_function_t format_tcp_state;
  65 format_function_t format_tcp_flags;
  66 format_function_t format_tcp_sacks;
  67 format_function_t format_tcp_rcv_sacks;
  68
  69 /** TCP timers */
  70 #define foreach_tcp_timer               \
  71   _(RETRANSMIT, "RETRANSMIT")           \
  72   _(DELACK, "DELAYED ACK")              \
  73   _(PERSIST, "PERSIST")                 \
  74   _(KEEP, "KEEP")                       \
  75   _(WAITCLOSE, "WAIT CLOSE")            \
  76   _(RETRANSMIT_SYN, "RETRANSMIT SYN")   \
  77   _(ESTABLISH, "ESTABLISH")             \
  78   _(ESTABLISH_AO, "ESTABLISH_AO")       \
  79
  80 typedef enum _tcp_timers
  81 {
  82 #define _(sym, str) TCP_TIMER_##sym,
  83   foreach_tcp_timer
  84 #undef _
  85   TCP_N_TIMERS
  86 } tcp_timers_e;
  87
  88 typedef void (timer_expiration_handler) (u32 index);
  89
  90 extern timer_expiration_handler tcp_timer_delack_handler;
  91 extern timer_expiration_handler tcp_timer_retransmit_handler;
  92 extern timer_expiration_handler tcp_timer_persist_handler;
  93 extern timer_expiration_handler tcp_timer_retransmit_syn_handler;
  94
  95 #define TCP_TIMER_HANDLE_INVALID ((u32) ~0)
  96
  97 /* Timer delays as multiples of 100ms */
  98 #define TCP_TO_TIMER_TICK       TCP_TICK*10     /* Period for converting from TCP
  99                                                  * ticks to timer units */
 100 #define TCP_DELACK_TIME         1       /* 0.1s */
 101 #define TCP_ESTABLISH_TIME      750     /* 75s */
 102 #define TCP_SYN_RCVD_TIME       600     /* 60s */
 103 #define TCP_2MSL_TIME           300     /* 30s */
 104 #define TCP_CLOSEWAIT_TIME      20      /* 2s */
 105 #define TCP_TIMEWAIT_TIME       100     /* 10s */
 106 #define TCP_FINWAIT1_TIME       600     /* 60s */
 107 #define TCP_CLEANUP_TIME        1       /* 0.1s */
 108 #define TCP_TIMER_PERSIST_MIN   2       /* 0.2s */
 109
 110 #define TCP_RTO_MAX 60 * THZ    /* Min max RTO (60s) as per RFC6298 */
 111 #define TCP_RTO_MIN 0.2 * THZ   /* Min RTO (200ms) - lower than standard */
 112 #define TCP_RTT_MAX 30 * THZ    /* 30s (probably too much) */
 113 #define TCP_RTO_SYN_RETRIES 3   /* SYN retries without doubling RTO */
 114 #define TCP_RTO_INIT 1 * THZ    /* Initial retransmit timer */
 115 #define TCP_RTO_BOFF_MAX 8      /* Max number of retries before reset */
 116
 117 /** TCP connection flags */
 118 #define foreach_tcp_connection_flag             \
 119   _(SNDACK, "Send ACK")                         \
 120   _(FINSNT, "FIN sent")                         \
 121   _(RECOVERY, "Recovery")                       \
 122   _(FAST_RECOVERY, "Fast Recovery")             \
 123   _(DCNT_PENDING, "Disconnect pending")         \
 124   _(HALF_OPEN_DONE, "Half-open completed")      \
 125   _(FINPNDG, "FIN pending")                     \
 126   _(FRXT_PENDING, "Fast-retransmit pending")    \
 127   _(FRXT_FIRST, "Fast-retransmit first again")  \
 128   _(DEQ_PENDING, "Pending dequeue acked")       \
 129   _(PSH_PENDING, "PSH pending")                 \
 130   _(FINRCVD, "FIN received")                    \
 131   _(RATE_SAMPLE, "Conn does rate sampling")     \
 132   _(TRACK_BURST, "Track burst")                 \
 133
 134 typedef enum _tcp_connection_flag_bits
 135 {
 136 #define _(sym, str) TCP_CONN_##sym##_BIT,
 137   foreach_tcp_connection_flag
 138 #undef _
 139   TCP_CONN_N_FLAG_BITS
 140 } tcp_connection_flag_bits_e;
 141
 142 typedef enum _tcp_connection_flag
 143 {
 144 #define _(sym, str) TCP_CONN_##sym = 1 << TCP_CONN_##sym##_BIT,
 145   foreach_tcp_connection_flag
 146 #undef _
 147   TCP_CONN_N_FLAGS
 148 } tcp_connection_flags_e;
 149
 150 #define TCP_SCOREBOARD_TRACE (0)
 151 #define TCP_MAX_SACK_BLOCKS 256 /**< Max number of SACK blocks stored */
 152 #define TCP_INVALID_SACK_HOLE_INDEX ((u32)~0)
 153
 154 typedef struct _scoreboard_trace_elt
 155 {
 156   u32 start;
 157   u32 end;
 158   u32 ack;
 159   u32 snd_una_max;
 160   u32 group;
 161 } scoreboard_trace_elt_t;
 162
 163 typedef struct _sack_scoreboard_hole
 164 {
 165   u32 next;             /**< Index for next entry in linked list */
 166   u32 prev;             /**< Index for previous entry in linked list */
 167   u32 start;            /**< Start sequence number */
 168   u32 end;              /**< End sequence number */
 169   u8 is_lost;           /**< Mark hole as lost */
 170 } sack_scoreboard_hole_t;
 171
 172 typedef struct _sack_scoreboard
 173 {
 174   sack_scoreboard_hole_t *holes;        /**< Pool of holes */
 175   u32 head;                             /**< Index of first entry */
 176   u32 tail;                             /**< Index of last entry */
 177   u32 sacked_bytes;                     /**< Number of bytes sacked in sb */
 178   u32 last_sacked_bytes;                /**< Number of bytes last sacked */
 179   u32 last_bytes_delivered;             /**< Sack bytes delivered to app */
 180   u32 snd_una_adv;                      /**< Bytes to add to snd_una */
 181   u32 high_sacked;                      /**< Highest byte sacked (fack) */
 182   u32 high_rxt;                         /**< Highest retransmitted sequence */
 183   u32 rescue_rxt;                       /**< Rescue sequence number */
 184   u32 lost_bytes;                       /**< Bytes lost as per RFC6675 */
 185   u32 cur_rxt_hole;                     /**< Retransmitting from this hole */
 186
 187 #if TCP_SCOREBOARD_TRACE
 188   scoreboard_trace_elt_t *trace;
 189 #endif
 190
 191 } sack_scoreboard_t;
 192
 193 #if TCP_SCOREBOARD_TRACE
 194 #define tcp_scoreboard_trace_add(_tc, _ack)                             \
 195 {                                                                       \
 196     static u64 _group = 0;                                              \
 197     sack_scoreboard_t *_sb = &_tc->sack_sb;                             \
 198     sack_block_t *_sack, *_sacks;                                       \
 199     scoreboard_trace_elt_t *_elt;                                       \
 200     int i;                                                              \
 201     _group++;                                                           \
 202     _sacks = _tc->rcv_opts.sacks;                                       \
 203     for (i = 0; i < vec_len (_sacks); i++)                              \
 204       {                                                                 \
 205         _sack = &_sacks[i];                                             \
 206         vec_add2 (_sb->trace, _elt, 1);                                 \
 207         _elt->start = _sack->start;                                     \
 208         _elt->end = _sack->end;                                         \
 209         _elt->ack = _elt->end == _ack ? _ack : 0;                       \
 210         _elt->snd_una_max = _elt->end == _ack ? _tc->snd_una_max : 0;   \
 211         _elt->group = _group;                                           \
 212       }                                                                 \
 213 }
 214 #else
 215 #define tcp_scoreboard_trace_add(_tc, _ack)
 216 #endif
 217
 218 sack_scoreboard_hole_t *scoreboard_next_rxt_hole (sack_scoreboard_t * sb,
 219                                                   sack_scoreboard_hole_t *
 220                                                   start, u8 have_sent_1_smss,
 221                                                   u8 * can_rescue,
 222                                                   u8 * snd_limited);
 223 sack_scoreboard_hole_t *scoreboard_get_hole (sack_scoreboard_t * sb,
 224                                              u32 index);
 225
 226 sack_scoreboard_hole_t *scoreboard_next_hole (sack_scoreboard_t * sb,
 227                                               sack_scoreboard_hole_t * hole);
 228 sack_scoreboard_hole_t *scoreboard_prev_hole (sack_scoreboard_t * sb,
 229                                               sack_scoreboard_hole_t * hole);
 230 sack_scoreboard_hole_t *scoreboard_first_hole (sack_scoreboard_t * sb);
 231 sack_scoreboard_hole_t *scoreboard_last_hole (sack_scoreboard_t * sb);
 232 void scoreboard_clear (sack_scoreboard_t * sb);
 233 void scoreboard_init (sack_scoreboard_t * sb);
 234 u8 *format_tcp_scoreboard (u8 * s, va_list * args);
 235
 236 #define TCP_BTS_INVALID_INDEX   ((u32)~0)
 237
 238 typedef enum tcp_bts_flags_
 239 {
 240   TCP_BTS_IS_RXT = 1,
 241   TCP_BTS_IS_APP_LIMITED = 1 << 1,
 242 } __clib_packed tcp_bts_flags_t;
 243
 244 typedef struct tcp_bt_sample_
 245 {
 246   u32 next;                     /**< Next sample index in list */
 247   u32 prev;                     /**< Previous sample index in list */
 248   u32 min_seq;                  /**< Min seq number in sample */
 249   u32 max_seq;                  /**< Max seq number. Set for rxt samples */
 250   u64 delivered;                /**< Total delivered when sample taken */
 251   f64 delivered_time;           /**< Delivered time when sample taken */
 252   u64 tx_rate;                  /**< Tx pacing rate */
 253   tcp_bts_flags_t flags;        /**< Sample flag */
 254 } tcp_bt_sample_t;
 255
 256 typedef struct tcp_rate_sample_
 257 {
 258   u64 sample_delivered;         /**< Delivered of sample used for rate */
 259   u32 delivered;                /**< Bytes delivered in ack time */
 260   f64 ack_time;                 /**< Time to ack the bytes delivered */
 261   u64 tx_rate;                  /**< Tx pacing rate */
 262   tcp_bts_flags_t flags;        /**< Rate sample flags from bt sample */
 263 } tcp_rate_sample_t;
 264
 265 typedef struct tcp_byte_tracker_
 266 {
 267   tcp_bt_sample_t *samples;     /**< Pool of samples */
 268   rb_tree_t sample_lookup;      /**< Rbtree for sample lookup by min_seq */
 269   u32 head;                     /**< Head of samples linked list */
 270   u32 tail;                     /**< Tail of samples linked list */
 271   u32 last_ooo;                 /**< Cached last ooo sample */
 272 } tcp_byte_tracker_t;
 273
 274 typedef enum _tcp_cc_algorithm_type
 275 {
 276   TCP_CC_NEWRENO,
 277   TCP_CC_CUBIC,
 278   TCP_CC_LAST = TCP_CC_CUBIC
 279 } tcp_cc_algorithm_type_e;
 280
 281 typedef struct _tcp_cc_algorithm tcp_cc_algorithm_t;
 282
 283 typedef enum _tcp_cc_ack_t
 284 {
 285   TCP_CC_ACK,
 286   TCP_CC_DUPACK,
 287   TCP_CC_PARTIALACK
 288 } tcp_cc_ack_t;
 289
 290 typedef struct _tcp_connection
 291 {
 292   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 293   transport_connection_t connection;  /**< Common transport data. First! */
 294
 295   u8 state;                     /**< TCP state as per tcp_state_t */
 296   u16 flags;                    /**< Connection flags (see tcp_conn_flags_e) */
 297   u32 timers[TCP_N_TIMERS];     /**< Timer handles into timer wheel */
 298
 299   /* TODO RFC4898 */
 300
 301   /** Send sequence variables RFC793 */
 302   u32 snd_una;          /**< oldest unacknowledged sequence number */
 303   u32 snd_una_max;      /**< newest unacknowledged sequence number + 1*/
 304   u32 snd_wnd;          /**< send window */
 305   u32 snd_wl1;          /**< seq number used for last snd.wnd update */
 306   u32 snd_wl2;          /**< ack number used for last snd.wnd update */
 307   u32 snd_nxt;          /**< next seq number to be sent */
 308   u16 snd_mss;          /**< Effective send max seg (data) size */
 309
 310   /** Receive sequence variables RFC793 */
 311   u32 rcv_nxt;          /**< next sequence number expected */
 312   u32 rcv_wnd;          /**< receive window we expect */
 313
 314   u32 rcv_las;          /**< rcv_nxt at last ack sent/rcv_wnd update */
 315   u32 iss;              /**< initial sent sequence */
 316   u32 irs;              /**< initial remote sequence */
 317
 318   /* Options */
 319   u8 snd_opts_len;              /**< Tx options len */
 320   u8 rcv_wscale;                /**< Window scale to advertise to peer */
 321   u8 snd_wscale;                /**< Window scale to use when sending */
 322   u32 tsval_recent;             /**< Last timestamp received */
 323   u32 tsval_recent_age;         /**< When last updated tstamp_recent*/
 324   tcp_options_t snd_opts;       /**< Tx options for connection */
 325   tcp_options_t rcv_opts;       /**< Rx options for connection */
 326
 327   sack_block_t *snd_sacks;      /**< Vector of SACKs to send. XXX Fixed size? */
 328   u8 snd_sack_pos;              /**< Position in vec of first block to send */
 329   sack_block_t *snd_sacks_fl;   /**< Vector for building new list */
 330   sack_scoreboard_t sack_sb;    /**< SACK "scoreboard" that tracks holes */
 331
 332   u16 rcv_dupacks;      /**< Number of DUPACKs received */
 333   u8 pending_dupacks;   /**< Number of DUPACKs to be sent */
 334
 335   /* Congestion control */
 336   u32 cwnd;             /**< Congestion window */
 337   u32 cwnd_acc_bytes;   /**< Bytes accumulated for cwnd increment */
 338   u32 ssthresh;         /**< Slow-start threshold */
 339   u32 prev_ssthresh;    /**< ssthresh before congestion */
 340   u32 prev_cwnd;        /**< ssthresh before congestion */
 341   u32 bytes_acked;      /**< Bytes acknowledged by current segment */
 342   u32 burst_acked;      /**< Bytes acknowledged in current burst */
 343   u32 snd_rxt_bytes;    /**< Retransmitted bytes */
 344   u32 snd_rxt_ts;       /**< Timestamp when first packet is retransmitted */
 345   u32 tsecr_last_ack;   /**< Timestamp echoed to us in last healthy ACK */
 346   u32 snd_congestion;   /**< snd_una_max when congestion is detected */
 347   u32 tx_fifo_size;     /**< Tx fifo size. Used to constrain cwnd */
 348   tcp_cc_algorithm_t *cc_algo;  /**< Congestion control algorithm */
 349   u8 cc_data[TCP_CC_DATA_SZ];   /**< Congestion control algo private data */
 350
 351   /* RTT and RTO */
 352   u32 rto;              /**< Retransmission timeout */
 353   u32 rto_boff;         /**< Index for RTO backoff */
 354   u32 srtt;             /**< Smoothed RTT */
 355   u32 rttvar;           /**< Smoothed mean RTT difference. Approximates variance */
 356   u32 rtt_seq;          /**< Sequence number for tracked ACK */
 357   f64 rtt_ts;           /**< Timestamp for tracked ACK */
 358   f64 mrtt_us;          /**< High precision mrtt from tracked acks */
 359
 360   u32 psh_seq;          /**< Add psh header for seg that includes this */
 361   u32 next_node_index;  /**< Can be used to control next node in output */
 362   u32 next_node_opaque; /**< Opaque to pass to next node */
 363   u32 limited_transmit; /**< snd_nxt when limited transmit starts */
 364   u32 sw_if_index;      /**< Interface for the connection */
 365
 366   /* Delivery rate estimation */
 367   u64 delivered;                /**< Total bytes delivered to peer */
 368   u64 app_limited;              /**< Delivered when app-limited detected */
 369   f64 delivered_time;           /**< Time last bytes were acked */
 370   tcp_byte_tracker_t *bt;       /**< Tx byte tracker */
 371
 372   u32 last_fib_check;   /**< Last time we checked fib route for peer */
 373   u16 mss;              /**< Our max seg size that includes options */
 374 } tcp_connection_t;
 375
 376 /* *INDENT-OFF* */
 377 struct _tcp_cc_algorithm
 378 {
 379   const char *name;
 380   uword (*unformat_cfg) (unformat_input_t * input);
 381   void (*rcv_ack) (tcp_connection_t * tc, tcp_rate_sample_t *rs);
 382   void (*rcv_cong_ack) (tcp_connection_t * tc, tcp_cc_ack_t ack,
 383                         tcp_rate_sample_t *rs);
 384   void (*congestion) (tcp_connection_t * tc);
 385   void (*recovered) (tcp_connection_t * tc);
 386   void (*init) (tcp_connection_t * tc);
 387   void (*cleanup) (tcp_connection_t * tc);
 388 };
 389 /* *INDENT-ON* */
 390
 391 #define tcp_fastrecovery_on(tc) (tc)->flags |= TCP_CONN_FAST_RECOVERY
 392 #define tcp_fastrecovery_off(tc) (tc)->flags &= ~TCP_CONN_FAST_RECOVERY
 393 #define tcp_recovery_on(tc) (tc)->flags |= TCP_CONN_RECOVERY
 394 #define tcp_recovery_off(tc) (tc)->flags &= ~TCP_CONN_RECOVERY
 395 #define tcp_in_fastrecovery(tc) ((tc)->flags & TCP_CONN_FAST_RECOVERY)
 396 #define tcp_in_recovery(tc) ((tc)->flags & (TCP_CONN_RECOVERY))
 397 #define tcp_in_slowstart(tc) (tc->cwnd < tc->ssthresh)
 398 #define tcp_disconnect_pending(tc) ((tc)->flags & TCP_CONN_DCNT_PENDING)
 399 #define tcp_disconnect_pending_on(tc) ((tc)->flags |= TCP_CONN_DCNT_PENDING)
 400 #define tcp_disconnect_pending_off(tc) ((tc)->flags &= ~TCP_CONN_DCNT_PENDING)
 401 #define tcp_fastrecovery_first(tc) ((tc)->flags & TCP_CONN_FRXT_FIRST)
 402 #define tcp_fastrecovery_first_on(tc) ((tc)->flags |= TCP_CONN_FRXT_FIRST)
 403 #define tcp_fastrecovery_first_off(tc) ((tc)->flags &= ~TCP_CONN_FRXT_FIRST)
 404
 405 #define tcp_in_cong_recovery(tc) ((tc)->flags &                 \
 406           (TCP_CONN_FAST_RECOVERY | TCP_CONN_RECOVERY))
 407
 408 always_inline void
 409 tcp_cong_recovery_off (tcp_connection_t * tc)
 410 {
 411   tc->flags &= ~(TCP_CONN_FAST_RECOVERY | TCP_CONN_RECOVERY);
 412   tcp_fastrecovery_first_off (tc);
 413 }
 414
 415 typedef enum _tcp_error
 416 {
 417 #define tcp_error(n,s) TCP_ERROR_##n,
 418 #include <vnet/tcp/tcp_error.def>
 419 #undef tcp_error
 420   TCP_N_ERROR,
 421 } tcp_error_t;
 422
 423 typedef struct _tcp_lookup_dispatch
 424 {
 425   u8 next, error;
 426 } tcp_lookup_dispatch_t;
 427
 428 typedef struct tcp_worker_ctx_
 429 {
 430   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 431   /** worker time */
 432   u32 time_now;
 433
 434   /** worker timer wheel */
 435   tw_timer_wheel_16t_2w_512sl_t timer_wheel;
 436
 437   /** tx buffer free list */
 438   u32 *tx_buffers;
 439
 440   /** tx frames for tcp 4/6 output nodes */
 441   vlib_frame_t *tx_frames[2];
 442
 443   /** tx frames for ip 4/6 lookup nodes */
 444   vlib_frame_t *ip_lookup_tx_frames[2];
 445
 446   /** vector of connections needing fast rxt */
 447   u32 *pending_fast_rxt;
 448
 449   /** vector of connections now doing fast rxt */
 450   u32 *ongoing_fast_rxt;
 451
 452   /** vector of connections that will do fast rxt */
 453   u32 *postponed_fast_rxt;
 454
 455   /** vector of pending ack dequeues */
 456   u32 *pending_deq_acked;
 457
 458   /** vector of pending acks */
 459   u32 *pending_acks;
 460
 461   /** vector of pending disconnect notifications */
 462   u32 *pending_disconnects;
 463
 464   /** convenience pointer to this thread's vlib main */
 465   vlib_main_t *vm;
 466
 467     CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
 468
 469   /** cached 'on the wire' options for bursts */
 470   u8 cached_opts[40];
 471
 472 } tcp_worker_ctx_t;
 473
 474 typedef struct tcp_iss_seed_
 475 {
 476   u64 first;
 477   u64 second;
 478 } tcp_iss_seed_t;
 479
 480 typedef struct _tcp_main
 481 {
 482   /* Per-worker thread tcp connection pools */
 483   tcp_connection_t **connections;
 484
 485   /* Pool of listeners. */
 486   tcp_connection_t *listener_pool;
 487
 488   /** Dispatch table by state and flags */
 489   tcp_lookup_dispatch_t dispatch_table[TCP_N_STATES][64];
 490
 491   u8 log2_tstamp_clocks_per_tick;
 492   f64 tstamp_ticks_per_clock;
 493
 494   /** per-worker context */
 495   tcp_worker_ctx_t *wrk_ctx;
 496
 497   /* Pool of half-open connections on which we've sent a SYN */
 498   tcp_connection_t *half_open_connections;
 499   clib_spinlock_t half_open_lock;
 500
 501   /** vlib buffer size */
 502   u32 bytes_per_buffer;
 503
 504   /* Seed used to generate random iss */
 505   tcp_iss_seed_t iss_seed;
 506
 507   /* Congestion control algorithms registered */
 508   tcp_cc_algorithm_t *cc_algos;
 509
 510   /** Hash table of cc algorithms by name */
 511   uword *cc_algo_by_name;
 512
 513   /** Last cc algo registered */
 514   tcp_cc_algorithm_type_e cc_last_type;
 515
 516   /*
 517    * Configuration
 518    */
 519
 520   /* Flag that indicates if stack is on or off */
 521   u8 is_enabled;
 522
 523   /** Max rx fifo size for a session. It is used in to compute the
 524    *  rfc 7323 window scaling factor */
 525   u32 max_rx_fifo;
 526
 527   /** Default MTU to be used when establishing connections */
 528   u16 default_mtu;
 529
 530   /** Number of preallocated connections */
 531   u32 preallocated_connections;
 532   u32 preallocated_half_open_connections;
 533
 534   /** Vectors of src addresses. Optional unless one needs > 63K active-opens */
 535   ip4_address_t *ip4_src_addresses;
 536   u32 last_v4_address_rotor;
 537   u32 last_v6_address_rotor;
 538   ip6_address_t *ip6_src_addresses;
 539
 540   /** Enable tx pacing for new connections */
 541   u8 tx_pacing;
 542
 543   u8 punt_unknown4;
 544   u8 punt_unknown6;
 545
 546   /** fault-injection */
 547   f64 buffer_fail_fraction;
 548
 549   /** Default congestion control algorithm type */
 550   tcp_cc_algorithm_type_e cc_algo;
 551 } tcp_main_t;
 552
 553 extern tcp_main_t tcp_main;
 554 extern vlib_node_registration_t tcp4_input_node;
 555 extern vlib_node_registration_t tcp6_input_node;
 556 extern vlib_node_registration_t tcp4_output_node;
 557 extern vlib_node_registration_t tcp6_output_node;
 558 extern vlib_node_registration_t tcp4_established_node;
 559 extern vlib_node_registration_t tcp6_established_node;
 560 extern vlib_node_registration_t tcp4_syn_sent_node;
 561 extern vlib_node_registration_t tcp6_syn_sent_node;
 562 extern vlib_node_registration_t tcp4_rcv_process_node;
 563 extern vlib_node_registration_t tcp6_rcv_process_node;
 564 extern vlib_node_registration_t tcp4_listen_node;
 565 extern vlib_node_registration_t tcp6_listen_node;
 566
 567 always_inline tcp_main_t *
 568 vnet_get_tcp_main ()
 569 {
 570   return &tcp_main;
 571 }
 572
 573 always_inline tcp_worker_ctx_t *
 574 tcp_get_worker (u32 thread_index)
 575 {
 576   return &tcp_main.wrk_ctx[thread_index];
 577 }
 578
 579 always_inline tcp_header_t *
 580 tcp_buffer_hdr (vlib_buffer_t * b)
 581 {
 582   ASSERT ((signed) b->current_data >= (signed) -VLIB_BUFFER_PRE_DATA_SIZE);
 583   return (tcp_header_t *) (b->data + b->current_data
 584                            + vnet_buffer (b)->tcp.hdr_offset);
 585 }
 586
 587 #if (VLIB_BUFFER_TRACE_TRAJECTORY)
 588 #define tcp_trajectory_add_start(b, start)                      \
 589 {                                                               \
 590     (*vlib_buffer_trace_trajectory_cb) (b, start);              \
 591 }
 592 #else
 593 #define tcp_trajectory_add_start(b, start)
 594 #endif
 595
 596 clib_error_t *vnet_tcp_enable_disable (vlib_main_t * vm, u8 is_en);
 597
 598 void tcp_punt_unknown (vlib_main_t * vm, u8 is_ip4, u8 is_add);
 599
 600 always_inline tcp_connection_t *
 601 tcp_connection_get (u32 conn_index, u32 thread_index)
 602 {
 603   if (PREDICT_FALSE
 604       (pool_is_free_index (tcp_main.connections[thread_index], conn_index)))
 605     return 0;
 606   return pool_elt_at_index (tcp_main.connections[thread_index], conn_index);
 607 }
 608
 609 always_inline tcp_connection_t *
 610 tcp_connection_get_if_valid (u32 conn_index, u32 thread_index)
 611 {
 612   if (tcp_main.connections[thread_index] == 0)
 613     return 0;
 614   if (pool_is_free_index (tcp_main.connections[thread_index], conn_index))
 615     return 0;
 616   return pool_elt_at_index (tcp_main.connections[thread_index], conn_index);
 617 }
 618
 619 always_inline tcp_connection_t *
 620 tcp_get_connection_from_transport (transport_connection_t * tconn)
 621 {
 622   return (tcp_connection_t *) tconn;
 623 }
 624
 625 always_inline void
 626 tcp_connection_set_state (tcp_connection_t * tc, tcp_state_t state)
 627 {
 628   tc->state = state;
 629   TCP_EVT_DBG (TCP_EVT_STATE_CHANGE, tc);
 630 }
 631
 632 void tcp_connection_close (tcp_connection_t * tc);
 633 void tcp_connection_cleanup (tcp_connection_t * tc);
 634 void tcp_connection_del (tcp_connection_t * tc);
 635 int tcp_half_open_connection_cleanup (tcp_connection_t * tc);
 636 tcp_connection_t *tcp_connection_alloc (u8 thread_index);
 637 void tcp_connection_free (tcp_connection_t * tc);
 638 void tcp_connection_reset (tcp_connection_t * tc);
 639 int tcp_configure_v4_source_address_range (vlib_main_t * vm,
 640                                            ip4_address_t * start,
 641                                            ip4_address_t * end, u32 table_id);
 642 int tcp_configure_v6_source_address_range (vlib_main_t * vm,
 643                                            ip6_address_t * start,
 644                                            ip6_address_t * end, u32 table_id);
 645 void tcp_api_reference (void);
 646 u8 *format_tcp_connection (u8 * s, va_list * args);
 647
 648 always_inline tcp_connection_t *
 649 tcp_listener_get (u32 tli)
 650 {
 651   return pool_elt_at_index (tcp_main.listener_pool, tli);
 652 }
 653
 654 always_inline tcp_connection_t *
 655 tcp_half_open_connection_get (u32 conn_index)
 656 {
 657   tcp_connection_t *tc = 0;
 658   clib_spinlock_lock_if_init (&tcp_main.half_open_lock);
 659   if (!pool_is_free_index (tcp_main.half_open_connections, conn_index))
 660     tc = pool_elt_at_index (tcp_main.half_open_connections, conn_index);
 661   clib_spinlock_unlock_if_init (&tcp_main.half_open_lock);
 662   return tc;
 663 }
 664
 665 void tcp_make_fin (tcp_connection_t * tc, vlib_buffer_t * b);
 666 void tcp_make_synack (tcp_connection_t * ts, vlib_buffer_t * b);
 667 void tcp_send_reset_w_pkt (tcp_connection_t * tc, vlib_buffer_t * pkt,
 668                            u32 thread_index, u8 is_ip4);
 669 void tcp_send_reset (tcp_connection_t * tc);
 670 void tcp_send_syn (tcp_connection_t * tc);
 671 void tcp_send_synack (tcp_connection_t * tc);
 672 void tcp_send_fin (tcp_connection_t * tc);
 673 void tcp_init_mss (tcp_connection_t * tc);
 674 void tcp_update_burst_snd_vars (tcp_connection_t * tc);
 675 void tcp_update_rto (tcp_connection_t * tc);
 676 void tcp_flush_frame_to_output (tcp_worker_ctx_t * wrk, u8 is_ip4);
 677 void tcp_flush_frames_to_output (tcp_worker_ctx_t * wrk);
 678 void tcp_program_fastretransmit (tcp_worker_ctx_t * wrk,
 679                                  tcp_connection_t * tc);
 680 void tcp_do_fastretransmits (tcp_worker_ctx_t * wrk);
 681
 682 void tcp_program_ack (tcp_worker_ctx_t * wrk, tcp_connection_t * tc);
 683 void tcp_program_dupack (tcp_worker_ctx_t * wrk, tcp_connection_t * tc);
 684 void tcp_send_acks (tcp_worker_ctx_t * wrk);
 685
 686 /*
 687  * Rate estimation
 688  */
 689
 690 /**
 691  * Byte tracker initialize
 692  *
 693  * @param tc    connection for which the byte tracker should be allocated and
 694  *              initialized
 695  */
 696 void tcp_bt_init (tcp_connection_t * tc);
 697 /**
 698  * Byte tracker cleanup
 699  *
 700  * @param tc    connection for which the byte tracker should be cleaned up
 701  */
 702 void tcp_bt_cleanup (tcp_connection_t * tc);
 703 /**
 704  * Flush byte tracker samples
 705  *
 706  * @param tc    tcp connection for which samples should be flushed
 707  */
 708 void tcp_bt_flush_samples (tcp_connection_t * tc);
 709 /**
 710  * Track a tcp tx burst
 711  *
 712  * @param tc    tcp connection
 713  */
 714 void tcp_bt_track_tx (tcp_connection_t * tc);
 715 /**
 716  * Track a tcp retransmission
 717  *
 718  * @param tc    tcp connection
 719  * @param start start sequence number
 720  * @param end   end sequence number
 721  */
 722 void tcp_bt_track_rxt (tcp_connection_t * tc, u32 start, u32 end);
 723 /**
 724  * Generate a delivery rate sample from recently acked bytes
 725  *
 726  * @param tc    tcp connection
 727  * @param rs    resulting rate sample
 728  */
 729 void tcp_bt_sample_delivery_rate (tcp_connection_t * tc,
 730                                   tcp_rate_sample_t * rs);
 731 /**
 732  * Check if sample to be generated is app limited
 733  *
 734  * @param tc    tcp connection
 735  */
 736 void tcp_bt_check_app_limited (tcp_connection_t * tc);
 737 /**
 738  * Check if the byte tracker is in sane state
 739  *
 740  * Should be used only for testing
 741  *
 742  * @param bt    byte tracker
 743  */
 744 int tcp_bt_is_sane (tcp_byte_tracker_t * bt);
 745
 746 always_inline u32
 747 tcp_end_seq (tcp_header_t * th, u32 len)
 748 {
 749   return th->seq_number + tcp_is_syn (th) + tcp_is_fin (th) + len;
 750 }
 751
 752 /* Modulo arithmetic for TCP sequence numbers */
 753 #define seq_lt(_s1, _s2) ((i32)((_s1)-(_s2)) < 0)
 754 #define seq_leq(_s1, _s2) ((i32)((_s1)-(_s2)) <= 0)
 755 #define seq_gt(_s1, _s2) ((i32)((_s1)-(_s2)) > 0)
 756 #define seq_geq(_s1, _s2) ((i32)((_s1)-(_s2)) >= 0)
 757 #define seq_max(_s1, _s2) (seq_gt((_s1), (_s2)) ? (_s1) : (_s2))
 758
 759 /* Modulo arithmetic for timestamps */
 760 #define timestamp_lt(_t1, _t2) ((i32)((_t1)-(_t2)) < 0)
 761 #define timestamp_leq(_t1, _t2) ((i32)((_t1)-(_t2)) <= 0)
 762
 763 /**
 764  * Our estimate of the number of bytes that have left the network
 765  */
 766 always_inline u32
 767 tcp_bytes_out (const tcp_connection_t * tc)
 768 {
 769   if (tcp_opts_sack_permitted (&tc->rcv_opts))
 770     return tc->sack_sb.sacked_bytes + tc->sack_sb.lost_bytes;
 771   else
 772     return tc->rcv_dupacks * tc->snd_mss;
 773 }
 774
 775 /**
 776  * Our estimate of the number of bytes in flight (pipe size)
 777  */
 778 always_inline u32
 779 tcp_flight_size (const tcp_connection_t * tc)
 780 {
 781   int flight_size;
 782
 783   flight_size = (int) (tc->snd_nxt - tc->snd_una) - tcp_bytes_out (tc)
 784     + tc->snd_rxt_bytes;
 785
 786   if (flight_size < 0)
 787     {
 788       if (0)
 789         clib_warning
 790           ("Negative: %u %u %u dupacks %u sacked bytes %u flags %d",
 791            tc->snd_una_max - tc->snd_una, tcp_bytes_out (tc),
 792            tc->snd_rxt_bytes, tc->rcv_dupacks, tc->sack_sb.sacked_bytes,
 793            tc->rcv_opts.flags);
 794       return 0;
 795     }
 796
 797   return flight_size;
 798 }
 799
 800 /**
 801  * Initial cwnd as per RFC5681
 802  */
 803 always_inline u32
 804 tcp_initial_cwnd (const tcp_connection_t * tc)
 805 {
 806   if (tc->snd_mss > 2190)
 807     return 2 * tc->snd_mss;
 808   else if (tc->snd_mss > 1095)
 809     return 3 * tc->snd_mss;
 810   else
 811     return 4 * tc->snd_mss;
 812 }
 813
 814 /*
 815  * Accumulate acked bytes for cwnd increase
 816  *
 817  * Once threshold bytes are accumulated, snd_mss bytes are added
 818  * to the cwnd.
 819  */
 820 always_inline void
 821 tcp_cwnd_accumulate (tcp_connection_t * tc, u32 thresh, u32 bytes)
 822 {
 823   tc->cwnd_acc_bytes += bytes;
 824   if (tc->cwnd_acc_bytes >= thresh)
 825     {
 826       u32 inc = tc->cwnd_acc_bytes / thresh;
 827       tc->cwnd_acc_bytes -= inc * thresh;
 828       tc->cwnd += inc * tc->snd_mss;
 829       tc->cwnd = clib_min (tc->cwnd, tc->tx_fifo_size);
 830     }
 831 }
 832
 833 always_inline u32
 834 tcp_loss_wnd (const tcp_connection_t * tc)
 835 {
 836   return tc->snd_mss;
 837 }
 838
 839 always_inline u32
 840 tcp_available_snd_wnd (const tcp_connection_t * tc)
 841 {
 842   return clib_min (tc->cwnd, tc->snd_wnd);
 843 }
 844
 845 always_inline u32
 846 tcp_available_output_snd_space (const tcp_connection_t * tc)
 847 {
 848   u32 available_wnd = tcp_available_snd_wnd (tc);
 849   int flight_size = (int) (tc->snd_nxt - tc->snd_una);
 850
 851   if (available_wnd <= flight_size)
 852     return 0;
 853
 854   return available_wnd - flight_size;
 855 }
 856
 857 /**
 858  * Estimate of how many bytes we can still push into the network
 859  */
 860 always_inline u32
 861 tcp_available_cc_snd_space (const tcp_connection_t * tc)
 862 {
 863   u32 available_wnd = tcp_available_snd_wnd (tc);
 864   u32 flight_size = tcp_flight_size (tc);
 865
 866   if (available_wnd <= flight_size)
 867     return 0;
 868
 869   return available_wnd - flight_size;
 870 }
 871
 872 always_inline u8
 873 tcp_is_lost_fin (tcp_connection_t * tc)
 874 {
 875   if ((tc->flags & TCP_CONN_FINSNT) && tc->snd_una_max - tc->snd_una == 1)
 876     return 1;
 877   return 0;
 878 }
 879
 880 u32 tcp_snd_space (tcp_connection_t * tc);
 881 int tcp_retransmit_first_unacked (tcp_worker_ctx_t * wrk,
 882                                   tcp_connection_t * tc);
 883 int tcp_fast_retransmit_no_sack (tcp_worker_ctx_t * wrk,
 884                                  tcp_connection_t * tc, u32 burst_size);
 885 int tcp_fast_retransmit_sack (tcp_worker_ctx_t * wrk, tcp_connection_t * tc,
 886                               u32 burst_size);
 887 int tcp_fast_retransmit (tcp_worker_ctx_t * wrk, tcp_connection_t * tc,
 888                          u32 burst_size);
 889 void tcp_cc_init_congestion (tcp_connection_t * tc);
 890 void tcp_cc_fastrecovery_exit (tcp_connection_t * tc);
 891
 892 fib_node_index_t tcp_lookup_rmt_in_fib (tcp_connection_t * tc);
 893
 894 /* Made public for unit testing only */
 895 void tcp_update_sack_list (tcp_connection_t * tc, u32 start, u32 end);
 896 u32 tcp_sack_list_bytes (tcp_connection_t * tc);
 897
 898 always_inline u32
 899 tcp_time_now (void)
 900 {
 901   return tcp_main.wrk_ctx[vlib_get_thread_index ()].time_now;
 902 }
 903
 904 always_inline u32
 905 tcp_time_now_w_thread (u32 thread_index)
 906 {
 907   return tcp_main.wrk_ctx[thread_index].time_now;
 908 }
 909
 910 always_inline f64
 911 tcp_time_now_us (u32 thread_index)
 912 {
 913   return transport_time_now (thread_index);
 914 }
 915
 916 always_inline u32
 917 tcp_set_time_now (tcp_worker_ctx_t * wrk)
 918 {
 919   wrk->time_now = clib_cpu_time_now () * tcp_main.tstamp_ticks_per_clock;
 920   return wrk->time_now;
 921 }
 922
 923 u32 tcp_session_push_header (transport_connection_t * tconn,
 924                              vlib_buffer_t * b);
 925
 926 void tcp_connection_timers_init (tcp_connection_t * tc);
 927 void tcp_connection_timers_reset (tcp_connection_t * tc);
 928 void tcp_init_snd_vars (tcp_connection_t * tc);
 929 void tcp_connection_init_vars (tcp_connection_t * tc);
 930 void tcp_connection_tx_pacer_update (tcp_connection_t * tc);
 931 void tcp_connection_tx_pacer_reset (tcp_connection_t * tc, u32 window,
 932                                     u32 start_bucket);
 933
 934 always_inline void
 935 tcp_cc_rcv_ack (tcp_connection_t * tc, tcp_rate_sample_t * rs)
 936 {
 937   tc->cc_algo->rcv_ack (tc, rs);
 938   tc->tsecr_last_ack = tc->rcv_opts.tsecr;
 939 }
 940
 941 static inline void
 942 tcp_cc_rcv_cong_ack (tcp_connection_t * tc, tcp_cc_ack_t ack_type,
 943                      tcp_rate_sample_t * rs)
 944 {
 945   tc->cc_algo->rcv_cong_ack (tc, ack_type, rs);
 946 }
 947
 948 always_inline void
 949 tcp_timer_set (tcp_connection_t * tc, u8 timer_id, u32 interval)
 950 {
 951   ASSERT (tc->c_thread_index == vlib_get_thread_index ());
 952   ASSERT (tc->timers[timer_id] == TCP_TIMER_HANDLE_INVALID);
 953   tc->timers[timer_id] =
 954     tw_timer_start_16t_2w_512sl (&tcp_main.
 955                                  wrk_ctx[tc->c_thread_index].timer_wheel,
 956                                  tc->c_c_index, timer_id, interval);
 957 }
 958
 959 always_inline void
 960 tcp_timer_reset (tcp_connection_t * tc, u8 timer_id)
 961 {
 962   ASSERT (tc->c_thread_index == vlib_get_thread_index ());
 963   if (tc->timers[timer_id] == TCP_TIMER_HANDLE_INVALID)
 964     return;
 965
 966   tw_timer_stop_16t_2w_512sl (&tcp_main.
 967                               wrk_ctx[tc->c_thread_index].timer_wheel,
 968                               tc->timers[timer_id]);
 969   tc->timers[timer_id] = TCP_TIMER_HANDLE_INVALID;
 970 }
 971
 972 always_inline void
 973 tcp_timer_update (tcp_connection_t * tc, u8 timer_id, u32 interval)
 974 {
 975   ASSERT (tc->c_thread_index == vlib_get_thread_index ());
 976   if (tc->timers[timer_id] != TCP_TIMER_HANDLE_INVALID)
 977     tw_timer_update_16t_2w_512sl (&tcp_main.
 978                                   wrk_ctx[tc->c_thread_index].timer_wheel,
 979                                   tc->timers[timer_id], interval);
 980   else
 981     tc->timers[timer_id] =
 982       tw_timer_start_16t_2w_512sl (&tcp_main.
 983                                    wrk_ctx[tc->c_thread_index].timer_wheel,
 984                                    tc->c_c_index, timer_id, interval);
 985 }
 986
 987 always_inline void
 988 tcp_retransmit_timer_set (tcp_connection_t * tc)
 989 {
 990   ASSERT (tc->snd_una != tc->snd_una_max);
 991   tcp_timer_set (tc, TCP_TIMER_RETRANSMIT,
 992                  clib_max (tc->rto * TCP_TO_TIMER_TICK, 1));
 993 }
 994
 995 always_inline void
 996 tcp_retransmit_timer_reset (tcp_connection_t * tc)
 997 {
 998   tcp_timer_reset (tc, TCP_TIMER_RETRANSMIT);
 999 }
1000
1001 always_inline void
1002 tcp_retransmit_timer_force_update (tcp_connection_t * tc)
1003 {
1004   tcp_timer_update (tc, TCP_TIMER_RETRANSMIT,
1005                     clib_max (tc->rto * TCP_TO_TIMER_TICK, 1));
1006 }
1007
1008 always_inline void
1009 tcp_persist_timer_set (tcp_connection_t * tc)
1010 {
1011   /* Reuse RTO. It's backed off in handler */
1012   tcp_timer_set (tc, TCP_TIMER_PERSIST,
1013                  clib_max (tc->rto * TCP_TO_TIMER_TICK,
1014                            TCP_TIMER_PERSIST_MIN));
1015 }
1016
1017 always_inline void
1018 tcp_persist_timer_update (tcp_connection_t * tc)
1019 {
1020   tcp_timer_update (tc, TCP_TIMER_PERSIST,
1021                     clib_max (tc->rto * TCP_TO_TIMER_TICK,
1022                               TCP_TIMER_PERSIST_MIN));
1023 }
1024
1025 always_inline void
1026 tcp_persist_timer_reset (tcp_connection_t * tc)
1027 {
1028   tcp_timer_reset (tc, TCP_TIMER_PERSIST);
1029 }
1030
1031 always_inline void
1032 tcp_retransmit_timer_update (tcp_connection_t * tc)
1033 {
1034   if (tc->snd_una == tc->snd_nxt)
1035     {
1036       tcp_retransmit_timer_reset (tc);
1037       if (tc->snd_wnd < tc->snd_mss)
1038         tcp_persist_timer_update (tc);
1039     }
1040   else
1041     tcp_timer_update (tc, TCP_TIMER_RETRANSMIT,
1042                       clib_max (tc->rto * TCP_TO_TIMER_TICK, 1));
1043 }
1044
1045 always_inline u8
1046 tcp_timer_is_active (tcp_connection_t * tc, tcp_timers_e timer)
1047 {
1048   return tc->timers[timer] != TCP_TIMER_HANDLE_INVALID;
1049 }
1050
1051 #define tcp_validate_txf_size(_tc, _a)                                  \
1052   ASSERT(_tc->state != TCP_STATE_ESTABLISHED                            \
1053          || transport_max_tx_dequeue (&_tc->connection) >= _a)
1054
1055 void tcp_rcv_sacks (tcp_connection_t * tc, u32 ack);
1056 u8 *tcp_scoreboard_replay (u8 * s, tcp_connection_t * tc, u8 verbose);
1057
1058 /**
1059  * Register exiting cc algo type
1060  */
1061 void tcp_cc_algo_register (tcp_cc_algorithm_type_e type,
1062                            const tcp_cc_algorithm_t * vft);
1063
1064 /**
1065  * Register new cc algo type
1066  */
1067 tcp_cc_algorithm_type_e tcp_cc_algo_new_type (const tcp_cc_algorithm_t * vft);
1068 tcp_cc_algorithm_t *tcp_cc_algo_get (tcp_cc_algorithm_type_e type);
1069
1070 static inline void *
1071 tcp_cc_data (tcp_connection_t * tc)
1072 {
1073   return (void *) tc->cc_data;
1074 }
1075
1076 void newreno_rcv_cong_ack (tcp_connection_t * tc, tcp_cc_ack_t ack_type,
1077                            tcp_rate_sample_t * rs);
1078
1079 /**
1080  * Push TCP header to buffer
1081  *
1082  * @param vm - vlib_main
1083  * @param b - buffer to write the header to
1084  * @param sp_net - source port net order
1085  * @param dp_net - destination port net order
1086  * @param seq - sequence number net order
1087  * @param ack - ack number net order
1088  * @param tcp_hdr_opts_len - header and options length in bytes
1089  * @param flags - header flags
1090  * @param wnd - window size
1091  *
1092  * @return - pointer to start of TCP header
1093  */
1094 always_inline void *
1095 vlib_buffer_push_tcp_net_order (vlib_buffer_t * b, u16 sp, u16 dp, u32 seq,
1096                                 u32 ack, u8 tcp_hdr_opts_len, u8 flags,
1097                                 u16 wnd)
1098 {
1099   tcp_header_t *th;
1100
1101   th = vlib_buffer_push_uninit (b, tcp_hdr_opts_len);
1102
1103   th->src_port = sp;
1104   th->dst_port = dp;
1105   th->seq_number = seq;
1106   th->ack_number = ack;
1107   th->data_offset_and_reserved = (tcp_hdr_opts_len >> 2) << 4;
1108   th->flags = flags;
1109   th->window = wnd;
1110   th->checksum = 0;
1111   th->urgent_pointer = 0;
1112   return th;
1113 }
1114
1115 /**
1116  * Push TCP header to buffer
1117  *
1118  * @param b - buffer to write the header to
1119  * @param sp_net - source port net order
1120  * @param dp_net - destination port net order
1121  * @param seq - sequence number host order
1122  * @param ack - ack number host order
1123  * @param tcp_hdr_opts_len - header and options length in bytes
1124  * @param flags - header flags
1125  * @param wnd - window size
1126  *
1127  * @return - pointer to start of TCP header
1128  */
1129 always_inline void *
1130 vlib_buffer_push_tcp (vlib_buffer_t * b, u16 sp_net, u16 dp_net, u32 seq,
1131                       u32 ack, u8 tcp_hdr_opts_len, u8 flags, u16 wnd)
1132 {
1133   return vlib_buffer_push_tcp_net_order (b, sp_net, dp_net,
1134                                          clib_host_to_net_u32 (seq),
1135                                          clib_host_to_net_u32 (ack),
1136                                          tcp_hdr_opts_len, flags,
1137                                          clib_host_to_net_u16 (wnd));
1138 }
1139
1140 #endif /* _vnet_tcp_h_ */
1141
1142 /*
1143  * fd.io coding-style-patch-verification: ON
1144  *
1145  * Local Variables:
1146  * eval: (c-set-style "gnu")
1147  * End:
1148  */