src/vnet/tcp/tcp.h

   1 /*
   2  * Copyright (c) 2016 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
  26 #define TCP_TICK 10e-3                  /**< TCP tick period (s) */
  27 #define THZ 1/TCP_TICK                  /**< TCP tick frequency */
  28 #define TCP_TSTAMP_RESOLUTION TCP_TICK  /**< Time stamp resolution */
  29 #define TCP_PAWS_IDLE 24 * 24 * 60 * 60 * THZ /**< 24 days */
  30 #define TCP_MAX_OPTION_SPACE 40
  31
  32 #define TCP_DUPACK_THRESHOLD 3
  33 #define TCP_MAX_RX_FIFO_SIZE 2 << 20
  34 #define TCP_IW_N_SEGMENTS 10
  35
  36 /** TCP FSM state definitions as per RFC793. */
  37 #define foreach_tcp_fsm_state   \
  38   _(CLOSED, "CLOSED")           \
  39   _(LISTEN, "LISTEN")           \
  40   _(SYN_SENT, "SYN_SENT")       \
  41   _(SYN_RCVD, "SYN_RCVD")       \
  42   _(ESTABLISHED, "ESTABLISHED") \
  43   _(CLOSE_WAIT, "CLOSE_WAIT")   \
  44   _(FIN_WAIT_1, "FIN_WAIT_1")   \
  45   _(LAST_ACK, "LAST_ACK")       \
  46   _(CLOSING, "CLOSING")         \
  47   _(FIN_WAIT_2, "FIN_WAIT_2")   \
  48   _(TIME_WAIT, "TIME_WAIT")
  49
  50 typedef enum _tcp_state
  51 {
  52 #define _(sym, str) TCP_STATE_##sym,
  53   foreach_tcp_fsm_state
  54 #undef _
  55   TCP_N_STATES
  56 } tcp_state_t;
  57
  58 format_function_t format_tcp_state;
  59
  60 /** TCP timers */
  61 #define foreach_tcp_timer               \
  62   _(RETRANSMIT, "RETRANSMIT")           \
  63   _(DELACK, "DELAYED ACK")              \
  64   _(PERSIST, "PERSIST")                 \
  65   _(KEEP, "KEEP")                       \
  66   _(2MSL, "2MSL")                       \
  67   _(RETRANSMIT_SYN, "RETRANSMIT_SYN")   \
  68   _(ESTABLISH, "ESTABLISH")
  69
  70 typedef enum _tcp_timers
  71 {
  72 #define _(sym, str) TCP_TIMER_##sym,
  73   foreach_tcp_timer
  74 #undef _
  75   TCP_N_TIMERS
  76 } tcp_timers_e;
  77
  78 typedef void (timer_expiration_handler) (u32 index);
  79
  80 extern timer_expiration_handler tcp_timer_delack_handler;
  81 extern timer_expiration_handler tcp_timer_retransmit_handler;
  82 extern timer_expiration_handler tcp_timer_retransmit_syn_handler;
  83
  84 #define TCP_TIMER_HANDLE_INVALID ((u32) ~0)
  85
  86 /* Timer delays as multiples of 100ms */
  87 #define TCP_TO_TIMER_TICK       TCP_TICK*10     /* Period for converting from TCP
  88                                                  * ticks to timer units */
  89 #define TCP_DELACK_TIME         1       /* 0.1s */
  90 #define TCP_ESTABLISH_TIME      750     /* 75s */
  91 #define TCP_2MSL_TIME           300     /* 30s */
  92
  93 #define TCP_RTO_MAX 60 * THZ    /* Min max RTO (60s) as per RFC6298 */
  94 #define TCP_RTT_MAX 30 * THZ    /* 30s (probably too much) */
  95 #define TCP_RTO_SYN_RETRIES 3   /* SYN retries without doubling RTO */
  96 #define TCP_RTO_INIT 1 * THZ    /* Initial retransmit timer */
  97
  98 void tcp_update_time (f64 now, u32 thread_index);
  99
 100 /** TCP connection flags */
 101 #define foreach_tcp_connection_flag             \
 102   _(DELACK, "Delay ACK")                        \
 103   _(SNDACK, "Send ACK")                         \
 104   _(BURSTACK, "Burst ACK set")                  \
 105   _(SENT_RCV_WND0, "Sent 0 receive window")     \
 106   _(RECOVERY, "Recovery on")                    \
 107   _(FAST_RECOVERY, "Fast Recovery on")
 108
 109 typedef enum _tcp_connection_flag_bits
 110 {
 111 #define _(sym, str) TCP_CONN_##sym##_BIT,
 112   foreach_tcp_connection_flag
 113 #undef _
 114   TCP_CONN_N_FLAG_BITS
 115 } tcp_connection_flag_bits_e;
 116
 117 typedef enum _tcp_connection_flag
 118 {
 119 #define _(sym, str) TCP_CONN_##sym = 1 << TCP_CONN_##sym##_BIT,
 120   foreach_tcp_connection_flag
 121 #undef _
 122   TCP_CONN_N_FLAGS
 123 } tcp_connection_flags_e;
 124
 125 /** TCP buffer flags */
 126 #define foreach_tcp_buf_flag                            \
 127   _ (ACK)       /**< Sending ACK. */                    \
 128   _ (DUPACK)    /**< Sending DUPACK. */                 \
 129
 130 enum
 131 {
 132 #define _(f) TCP_BUF_BIT_##f,
 133   foreach_tcp_buf_flag
 134 #undef _
 135     TCP_N_BUF_BITS,
 136 };
 137
 138 enum
 139 {
 140 #define _(f) TCP_BUF_FLAG_##f = 1 << TCP_BUF_BIT_##f,
 141   foreach_tcp_buf_flag
 142 #undef _
 143 };
 144
 145 #define TCP_MAX_SACK_BLOCKS 5   /**< Max number of SACK blocks stored */
 146 #define TCP_INVALID_SACK_HOLE_INDEX ((u32)~0)
 147
 148 typedef struct _sack_scoreboard_hole
 149 {
 150   u32 next;             /**< Index for next entry in linked list */
 151   u32 prev;             /**< Index for previous entry in linked list */
 152   u32 start;            /**< Start sequence number */
 153   u32 end;              /**< End sequence number */
 154 } sack_scoreboard_hole_t;
 155
 156 typedef struct _sack_scoreboard
 157 {
 158   sack_scoreboard_hole_t *holes;        /**< Pool of holes */
 159   u32 head;                             /**< Index to first entry */
 160   u32 sacked_bytes;                     /**< Number of bytes sacked in sb */
 161 } sack_scoreboard_t;
 162
 163 typedef enum _tcp_cc_algorithm_type
 164 {
 165   TCP_CC_NEWRENO,
 166 } tcp_cc_algorithm_type_e;
 167
 168 typedef struct _tcp_cc_algorithm tcp_cc_algorithm_t;
 169
 170 typedef enum _tcp_cc_ack_t
 171 {
 172   TCP_CC_ACK,
 173   TCP_CC_DUPACK,
 174   TCP_CC_PARTIALACK
 175 } tcp_cc_ack_t;
 176
 177 typedef struct _tcp_connection
 178 {
 179   transport_connection_t connection;  /**< Common transport data. First! */
 180
 181   u8 state;                     /**< TCP state as per tcp_state_t */
 182   u16 flags;                    /**< Connection flags (see tcp_conn_flags_e) */
 183   u32 timers[TCP_N_TIMERS];     /**< Timer handles into timer wheel */
 184
 185   /* TODO RFC4898 */
 186
 187   /** Send sequence variables RFC793 */
 188   u32 snd_una;          /**< oldest unacknowledged sequence number */
 189   u32 snd_una_max;      /**< newest unacknowledged sequence number + 1*/
 190   u32 snd_wnd;          /**< send window */
 191   u32 snd_wl1;          /**< seq number used for last snd.wnd update */
 192   u32 snd_wl2;          /**< ack number used for last snd.wnd update */
 193   u32 snd_nxt;          /**< next seq number to be sent */
 194
 195   /** Receive sequence variables RFC793 */
 196   u32 rcv_nxt;          /**< next sequence number expected */
 197   u32 rcv_wnd;          /**< receive window we expect */
 198
 199   u32 rcv_las;          /**< rcv_nxt at last ack sent/rcv_wnd update */
 200   u32 iss;              /**< initial sent sequence */
 201   u32 irs;              /**< initial remote sequence */
 202
 203   /* Options */
 204   tcp_options_t opt;    /**< TCP connection options parsed */
 205   u8 rcv_wscale;        /**< Window scale to advertise to peer */
 206   u8 snd_wscale;        /**< Window scale to use when sending */
 207   u32 tsval_recent;     /**< Last timestamp received */
 208   u32 tsval_recent_age; /**< When last updated tstamp_recent*/
 209
 210   sack_block_t *snd_sacks;      /**< Vector of SACKs to send. XXX Fixed size? */
 211   sack_scoreboard_t sack_sb;    /**< SACK "scoreboard" that tracks holes */
 212
 213   u8 rcv_dupacks;       /**< Number of DUPACKs received */
 214   u8 snt_dupacks;       /**< Number of DUPACKs sent in a burst */
 215
 216   /* Congestion control */
 217   u32 cwnd;             /**< Congestion window */
 218   u32 ssthresh;         /**< Slow-start threshold */
 219   u32 prev_ssthresh;    /**< ssthresh before congestion */
 220   u32 bytes_acked;      /**< Bytes acknowledged by current segment */
 221   u32 rtx_bytes;        /**< Retransmitted bytes */
 222   u32 tsecr_last_ack;   /**< Timestamp echoed to us in last health ACK */
 223   tcp_cc_algorithm_t *cc_algo;  /**< Congestion control algorithm */
 224
 225   /* RTT and RTO */
 226   u32 rto;              /**< Retransmission timeout */
 227   u32 rto_boff;         /**< Index for RTO backoff */
 228   u32 srtt;             /**< Smoothed RTT */
 229   u32 rttvar;           /**< Smoothed mean RTT difference. Approximates variance */
 230   u32 rtt_ts;           /**< Timestamp for tracked ACK */
 231   u32 rtt_seq;          /**< Sequence number for tracked ACK */
 232
 233   u16 snd_mss;          /**< Send MSS */
 234 } tcp_connection_t;
 235
 236 struct _tcp_cc_algorithm
 237 {
 238   void (*rcv_ack) (tcp_connection_t * tc);
 239   void (*rcv_cong_ack) (tcp_connection_t * tc, tcp_cc_ack_t ack);
 240   void (*congestion) (tcp_connection_t * tc);
 241   void (*recovered) (tcp_connection_t * tc);
 242   void (*init) (tcp_connection_t * tc);
 243 };
 244
 245 #define tcp_fastrecovery_on(tc) (tc)->flags |= TCP_CONN_FAST_RECOVERY
 246 #define tcp_fastrecovery_off(tc) (tc)->flags &= ~TCP_CONN_FAST_RECOVERY
 247 #define tcp_in_fastrecovery(tc) ((tc)->flags & TCP_CONN_FAST_RECOVERY)
 248 #define tcp_in_recovery(tc) ((tc)->flags & (TCP_CONN_FAST_RECOVERY | TCP_CONN_RECOVERY))
 249 #define tcp_recovery_off(tc) ((tc)->flags &= ~(TCP_CONN_FAST_RECOVERY | TCP_CONN_RECOVERY))
 250 #define tcp_in_slowstart(tc) (tc->cwnd < tc->ssthresh)
 251
 252 typedef enum
 253 {
 254   TCP_IP4,
 255   TCP_IP6,
 256   TCP_N_AF,
 257 } tcp_af_t;
 258
 259 typedef enum _tcp_error
 260 {
 261 #define tcp_error(n,s) TCP_ERROR_##n,
 262 #include <vnet/tcp/tcp_error.def>
 263 #undef tcp_error
 264   TCP_N_ERROR,
 265 } tcp_error_t;
 266
 267 typedef struct _tcp_lookup_dispatch
 268 {
 269   u8 next, error;
 270 } tcp_lookup_dispatch_t;
 271
 272 typedef struct _tcp_main
 273 {
 274   /* Per-worker thread tcp connection pools */
 275   tcp_connection_t **connections;
 276
 277   /* Pool of listeners. */
 278   tcp_connection_t *listener_pool;
 279
 280   /** Dispatch table by state and flags */
 281   tcp_lookup_dispatch_t dispatch_table[TCP_N_STATES][64];
 282
 283   u8 log2_tstamp_clocks_per_tick;
 284   f64 tstamp_ticks_per_clock;
 285
 286   /** per-worker tx buffer free lists */
 287   u32 **tx_buffers;
 288
 289   /* Per worker-thread timer wheel for connections timers */
 290   tw_timer_wheel_16t_2w_512sl_t *timer_wheels;
 291
 292   /* Convenience per worker-thread vector of connections to DELACK */
 293   u32 **delack_connections;
 294
 295   /* Pool of half-open connections on which we've sent a SYN */
 296   tcp_connection_t *half_open_connections;
 297
 298   /* Pool of local TCP endpoints */
 299   transport_endpoint_t *local_endpoints;
 300
 301   /* Local endpoints lookup table */
 302   transport_endpoint_table_t local_endpoints_table;
 303
 304   /* Congestion control algorithms registered */
 305   tcp_cc_algorithm_t *cc_algos;
 306
 307   /* Flag that indicates if stack is on or off */
 308   u8 is_enabled;
 309
 310   /* convenience */
 311   vlib_main_t *vlib_main;
 312   vnet_main_t *vnet_main;
 313   ip4_main_t *ip4_main;
 314   ip6_main_t *ip6_main;
 315 } tcp_main_t;
 316
 317 extern tcp_main_t tcp_main;
 318 extern vlib_node_registration_t tcp4_input_node;
 319 extern vlib_node_registration_t tcp6_input_node;
 320 extern vlib_node_registration_t tcp4_output_node;
 321 extern vlib_node_registration_t tcp6_output_node;
 322
 323 always_inline tcp_main_t *
 324 vnet_get_tcp_main ()
 325 {
 326   return &tcp_main;
 327 }
 328
 329 clib_error_t *vnet_tcp_enable_disable (vlib_main_t * vm, u8 is_en);
 330
 331 always_inline tcp_connection_t *
 332 tcp_connection_get (u32 conn_index, u32 thread_index)
 333 {
 334   return pool_elt_at_index (tcp_main.connections[thread_index], conn_index);
 335 }
 336
 337 always_inline tcp_connection_t *
 338 tcp_connection_get_if_valid (u32 conn_index, u32 thread_index)
 339 {
 340   if (tcp_main.connections[thread_index] == 0)
 341     return 0;
 342   if (pool_is_free_index (tcp_main.connections[thread_index], conn_index))
 343     return 0;
 344   return pool_elt_at_index (tcp_main.connections[thread_index], conn_index);
 345 }
 346
 347 void tcp_connection_close (tcp_connection_t * tc);
 348 void tcp_connection_cleanup (tcp_connection_t * tc);
 349 void tcp_connection_del (tcp_connection_t * tc);
 350
 351 always_inline tcp_connection_t *
 352 tcp_listener_get (u32 tli)
 353 {
 354   return pool_elt_at_index (tcp_main.listener_pool, tli);
 355 }
 356
 357 always_inline tcp_connection_t *
 358 tcp_half_open_connection_get (u32 conn_index)
 359 {
 360   return pool_elt_at_index (tcp_main.half_open_connections, conn_index);
 361 }
 362
 363 void tcp_make_ack (tcp_connection_t * ts, vlib_buffer_t * b);
 364 void tcp_make_finack (tcp_connection_t * tc, vlib_buffer_t * b);
 365 void tcp_make_synack (tcp_connection_t * ts, vlib_buffer_t * b);
 366 void tcp_send_reset (vlib_buffer_t * pkt, u8 is_ip4);
 367 void tcp_send_syn (tcp_connection_t * tc);
 368 void tcp_send_fin (tcp_connection_t * tc);
 369 void tcp_set_snd_mss (tcp_connection_t * tc);
 370
 371 always_inline u32
 372 tcp_end_seq (tcp_header_t * th, u32 len)
 373 {
 374   return th->seq_number + tcp_is_syn (th) + tcp_is_fin (th) + len;
 375 }
 376
 377 /* Modulo arithmetic for TCP sequence numbers */
 378 #define seq_lt(_s1, _s2) ((i32)((_s1)-(_s2)) < 0)
 379 #define seq_leq(_s1, _s2) ((i32)((_s1)-(_s2)) <= 0)
 380 #define seq_gt(_s1, _s2) ((i32)((_s1)-(_s2)) > 0)
 381 #define seq_geq(_s1, _s2) ((i32)((_s1)-(_s2)) >= 0)
 382
 383 /* Modulo arithmetic for timestamps */
 384 #define timestamp_lt(_t1, _t2) ((i32)((_t1)-(_t2)) < 0)
 385 #define timestamp_leq(_t1, _t2) ((i32)((_t1)-(_t2)) <= 0)
 386
 387 always_inline u32
 388 tcp_flight_size (const tcp_connection_t * tc)
 389 {
 390   return tc->snd_una_max - tc->snd_una - tc->sack_sb.sacked_bytes
 391     + tc->rtx_bytes;
 392 }
 393
 394 /**
 395  * Initial cwnd as per RFC5681
 396  */
 397 always_inline u32
 398 tcp_initial_cwnd (const tcp_connection_t * tc)
 399 {
 400   if (tc->snd_mss > 2190)
 401     return 2 * tc->snd_mss;
 402   else if (tc->snd_mss > 1095)
 403     return 3 * tc->snd_mss;
 404   else
 405     return 4 * tc->snd_mss;
 406 }
 407
 408 always_inline u32
 409 tcp_loss_wnd (const tcp_connection_t * tc)
 410 {
 411   return tc->snd_mss;
 412 }
 413
 414 always_inline u32
 415 tcp_available_wnd (const tcp_connection_t * tc)
 416 {
 417   return clib_min (tc->cwnd, tc->snd_wnd);
 418 }
 419
 420 always_inline u32
 421 tcp_available_snd_space (const tcp_connection_t * tc)
 422 {
 423   u32 available_wnd = tcp_available_wnd (tc);
 424   u32 flight_size = tcp_flight_size (tc);
 425
 426   if (available_wnd <= flight_size)
 427     return 0;
 428
 429   return available_wnd - flight_size;
 430 }
 431
 432 void tcp_retransmit_first_unacked (tcp_connection_t * tc);
 433
 434 void tcp_fast_retransmit (tcp_connection_t * tc);
 435
 436 always_inline u32
 437 tcp_time_now (void)
 438 {
 439   return clib_cpu_time_now () * tcp_main.tstamp_ticks_per_clock;
 440 }
 441
 442 u32 tcp_push_header (transport_connection_t * tconn, vlib_buffer_t * b);
 443
 444 u32
 445 tcp_prepare_retransmit_segment (tcp_connection_t * tc, vlib_buffer_t * b,
 446                                 u32 max_bytes);
 447
 448 void tcp_connection_timers_init (tcp_connection_t * tc);
 449 void tcp_connection_timers_reset (tcp_connection_t * tc);
 450
 451 void tcp_connection_init_vars (tcp_connection_t * tc);
 452
 453 always_inline void
 454 tcp_connection_force_ack (tcp_connection_t * tc, vlib_buffer_t * b)
 455 {
 456   /* Reset flags, make sure ack is sent */
 457   tc->flags = TCP_CONN_SNDACK;
 458   vnet_buffer (b)->tcp.flags &= ~TCP_BUF_FLAG_DUPACK;
 459 }
 460
 461 always_inline void
 462 tcp_timer_set (tcp_connection_t * tc, u8 timer_id, u32 interval)
 463 {
 464   tc->timers[timer_id]
 465     = tw_timer_start_16t_2w_512sl (&tcp_main.timer_wheels[tc->c_thread_index],
 466                                    tc->c_c_index, timer_id, interval);
 467 }
 468
 469 always_inline void
 470 tcp_retransmit_timer_set (tcp_main_t * tm, tcp_connection_t * tc)
 471 {
 472   /* XXX Switch to faster TW */
 473   tcp_timer_set (tc, TCP_TIMER_RETRANSMIT,
 474                  clib_max (tc->rto * TCP_TO_TIMER_TICK, 1));
 475 }
 476
 477 always_inline void
 478 tcp_timer_reset (tcp_connection_t * tc, u8 timer_id)
 479 {
 480   if (tc->timers[timer_id] == TCP_TIMER_HANDLE_INVALID)
 481     return;
 482
 483   tw_timer_stop_16t_2w_512sl (&tcp_main.timer_wheels[tc->c_thread_index],
 484                               tc->timers[timer_id]);
 485   tc->timers[timer_id] = TCP_TIMER_HANDLE_INVALID;
 486 }
 487
 488 always_inline void
 489 tcp_timer_update (tcp_connection_t * tc, u8 timer_id, u32 interval)
 490 {
 491   if (tc->timers[timer_id] != TCP_TIMER_HANDLE_INVALID)
 492     tw_timer_stop_16t_2w_512sl (&tcp_main.timer_wheels[tc->c_thread_index],
 493                                 tc->timers[timer_id]);
 494   tc->timers[timer_id] =
 495     tw_timer_start_16t_2w_512sl (&tcp_main.timer_wheels[tc->c_thread_index],
 496                                  tc->c_c_index, timer_id, interval);
 497 }
 498
 499 always_inline u8
 500 tcp_timer_is_active (tcp_connection_t * tc, tcp_timers_e timer)
 501 {
 502   return tc->timers[timer] != TCP_TIMER_HANDLE_INVALID;
 503 }
 504
 505 void
 506 scoreboard_remove_hole (sack_scoreboard_t * sb,
 507                         sack_scoreboard_hole_t * hole);
 508
 509 always_inline sack_scoreboard_hole_t *
 510 scoreboard_next_hole (sack_scoreboard_t * sb, sack_scoreboard_hole_t * hole)
 511 {
 512   if (hole->next != TCP_INVALID_SACK_HOLE_INDEX)
 513     return pool_elt_at_index (sb->holes, hole->next);
 514   return 0;
 515 }
 516
 517 always_inline sack_scoreboard_hole_t *
 518 scoreboard_first_hole (sack_scoreboard_t * sb)
 519 {
 520   if (sb->head != TCP_INVALID_SACK_HOLE_INDEX)
 521     return pool_elt_at_index (sb->holes, sb->head);
 522   return 0;
 523 }
 524
 525 always_inline void
 526 scoreboard_clear (sack_scoreboard_t * sb)
 527 {
 528   sack_scoreboard_hole_t *hole = scoreboard_first_hole (sb);
 529   while ((hole = scoreboard_first_hole (sb)))
 530     {
 531       scoreboard_remove_hole (sb, hole);
 532     }
 533 }
 534
 535 always_inline u32
 536 scoreboard_hole_bytes (sack_scoreboard_hole_t * hole)
 537 {
 538   return hole->end - hole->start;
 539 }
 540
 541 always_inline void
 542 tcp_cc_algo_register (tcp_cc_algorithm_type_e type,
 543                       const tcp_cc_algorithm_t * vft)
 544 {
 545   tcp_main_t *tm = vnet_get_tcp_main ();
 546   vec_validate (tm->cc_algos, type);
 547
 548   tm->cc_algos[type] = *vft;
 549 }
 550
 551 always_inline tcp_cc_algorithm_t *
 552 tcp_cc_algo_get (tcp_cc_algorithm_type_e type)
 553 {
 554   tcp_main_t *tm = vnet_get_tcp_main ();
 555   return &tm->cc_algos[type];
 556 }
 557
 558 void tcp_cc_init (tcp_connection_t * tc);
 559
 560 /**
 561  * Push TCP header to buffer
 562  *
 563  * @param vm - vlib_main
 564  * @param b - buffer to write the header to
 565  * @param sp_net - source port net order
 566  * @param dp_net - destination port net order
 567  * @param seq - sequence number net order
 568  * @param ack - ack number net order
 569  * @param tcp_hdr_opts_len - header and options length in bytes
 570  * @param flags - header flags
 571  * @param wnd - window size
 572  *
 573  * @return - pointer to start of TCP header
 574  */
 575 always_inline void *
 576 vlib_buffer_push_tcp_net_order (vlib_buffer_t * b, u16 sp, u16 dp, u32 seq,
 577                                 u32 ack, u8 tcp_hdr_opts_len, u8 flags,
 578                                 u16 wnd)
 579 {
 580   tcp_header_t *th;
 581
 582   th = vlib_buffer_push_uninit (b, tcp_hdr_opts_len);
 583
 584   th->src_port = sp;
 585   th->dst_port = dp;
 586   th->seq_number = seq;
 587   th->ack_number = ack;
 588   th->data_offset_and_reserved = (tcp_hdr_opts_len >> 2) << 4;
 589   th->flags = flags;
 590   th->window = wnd;
 591   th->checksum = 0;
 592   th->urgent_pointer = 0;
 593   return th;
 594 }
 595
 596 /**
 597  * Push TCP header to buffer
 598  *
 599  * @param b - buffer to write the header to
 600  * @param sp_net - source port net order
 601  * @param dp_net - destination port net order
 602  * @param seq - sequence number host order
 603  * @param ack - ack number host order
 604  * @param tcp_hdr_opts_len - header and options length in bytes
 605  * @param flags - header flags
 606  * @param wnd - window size
 607  *
 608  * @return - pointer to start of TCP header
 609  */
 610 always_inline void *
 611 vlib_buffer_push_tcp (vlib_buffer_t * b, u16 sp_net, u16 dp_net, u32 seq,
 612                       u32 ack, u8 tcp_hdr_opts_len, u8 flags, u16 wnd)
 613 {
 614   return vlib_buffer_push_tcp_net_order (b, sp_net, dp_net,
 615                                          clib_host_to_net_u32 (seq),
 616                                          clib_host_to_net_u32 (ack),
 617                                          tcp_hdr_opts_len, flags,
 618                                          clib_host_to_net_u16 (wnd));
 619 }
 620
 621 #endif /* _vnet_tcp_h_ */
 622
 623 /*
 624  * fd.io coding-style-patch-verification: ON
 625  *
 626  * Local Variables:
 627  * eval: (c-set-style "gnu")
 628  * End:
 629  */