tcp: set cc_algo on connection alloc
[vpp.git] / src / vnet / tcp / tcp.h
index b0c3ecc..c71b577 100644 (file)
@@ -33,8 +33,6 @@
 #define TCP_CC_DATA_SZ 24
 
 #define TCP_DUPACK_THRESHOLD   3
-#define TCP_MAX_RX_FIFO_SIZE   32 << 20
-#define TCP_MIN_RX_FIFO_SIZE   4 << 10
 #define TCP_IW_N_SEGMENTS      10
 #define TCP_ALWAYS_ACK         1       /**< On/off delayed acks */
 #define TCP_USE_SACKS          1       /**< Disable only for testing */
@@ -71,11 +69,8 @@ format_function_t format_tcp_rcv_sacks;
   _(RETRANSMIT, "RETRANSMIT")           \
   _(DELACK, "DELAYED ACK")              \
   _(PERSIST, "PERSIST")                 \
-  _(KEEP, "KEEP")                       \
   _(WAITCLOSE, "WAIT CLOSE")            \
   _(RETRANSMIT_SYN, "RETRANSMIT SYN")   \
-  _(ESTABLISH, "ESTABLISH")            \
-  _(ESTABLISH_AO, "ESTABLISH_AO")      \
 
 typedef enum _tcp_timers
 {
@@ -94,18 +89,9 @@ extern timer_expiration_handler tcp_timer_retransmit_syn_handler;
 
 #define TCP_TIMER_HANDLE_INVALID ((u32) ~0)
 
-/* Timer delays as multiples of 100ms */
-#define TCP_TO_TIMER_TICK       TCP_TICK*10    /* Period for converting from TCP
-                                                * ticks to timer units */
-#define TCP_DELACK_TIME         1      /* 0.1s */
-#define TCP_ESTABLISH_TIME      750    /* 75s */
-#define TCP_SYN_RCVD_TIME      600     /* 60s */
-#define TCP_2MSL_TIME           300    /* 30s */
-#define TCP_CLOSEWAIT_TIME     20      /* 2s */
-#define TCP_TIMEWAIT_TIME      100     /* 10s */
-#define TCP_FINWAIT1_TIME      600     /* 60s */
-#define TCP_CLEANUP_TIME       1       /* 0.1s */
-#define TCP_TIMER_PERSIST_MIN  2       /* 0.2s */
+#define TCP_TIMER_TICK         0.1             /**< Timer tick in seconds */
+#define TCP_TO_TIMER_TICK       TCP_TICK*10    /**< Factor for converting
+                                                    ticks to timer ticks */
 
 #define TCP_RTO_MAX 60 * THZ   /* Min max RTO (60s) as per RFC6298 */
 #define TCP_RTO_MIN 0.2 * THZ  /* Min RTO (200ms) - lower than standard */
@@ -113,6 +99,7 @@ extern timer_expiration_handler tcp_timer_retransmit_syn_handler;
 #define TCP_RTO_SYN_RETRIES 3  /* SYN retries without doubling RTO */
 #define TCP_RTO_INIT 1 * THZ   /* Initial retransmit timer */
 #define TCP_RTO_BOFF_MAX 8     /* Max number of retries before reset */
+#define TCP_ESTABLISH_TIME (60 * THZ)  /* Connection establish timeout */
 
 /** TCP connection flags */
 #define foreach_tcp_connection_flag             \
@@ -130,6 +117,7 @@ extern timer_expiration_handler tcp_timer_retransmit_syn_handler;
   _(FINRCVD, "FIN received")                   \
   _(RATE_SAMPLE, "Conn does rate sampling")    \
   _(TRACK_BURST, "Track burst")                        \
+  _(ZERO_RWND_SENT, "Zero RWND sent")          \
 
 typedef enum _tcp_connection_flag_bits
 {
@@ -182,6 +170,7 @@ typedef struct _sack_scoreboard
   u32 high_rxt;                                /**< Highest retransmitted sequence */
   u32 rescue_rxt;                      /**< Rescue sequence number */
   u32 lost_bytes;                      /**< Bytes lost as per RFC6675 */
+  u32 last_lost_bytes;                 /**< Number of bytes last lost */
   u32 cur_rxt_hole;                    /**< Retransmitting from this hole */
 
 #if TCP_SCOREBOARD_TRACE
@@ -247,18 +236,24 @@ typedef struct tcp_bt_sample_
   u32 prev;                    /**< Previous sample index in list */
   u32 min_seq;                 /**< Min seq number in sample */
   u32 max_seq;                 /**< Max seq number. Set for rxt samples */
-  u64 delivered;               /**< Total delivered when sample taken */
+  u64 delivered;               /**< Total delivered bytes for sample */
   f64 delivered_time;          /**< Delivered time when sample taken */
+  f64 tx_time;                 /**< Transmit time for the burst */
   u64 tx_rate;                 /**< Tx pacing rate */
   tcp_bts_flags_t flags;       /**< Sample flag */
 } tcp_bt_sample_t;
 
 typedef struct tcp_rate_sample_
 {
-  u64 sample_delivered;                /**< Delivered of sample used for rate */
-  u32 delivered;               /**< Bytes delivered in ack time */
-  f64 ack_time;                        /**< Time to ack the bytes delivered */
+  u64 prior_delivered;         /**< Delivered of sample used for rate, i.e.,
+                                    total bytes delivered at prior_time */
+  f64 prior_time;              /**< Delivered time of sample used for rate */
+  f64 interval_time;           /**< Time to ack the bytes delivered */
+  f64 rtt_time;                        /**< RTT for sample */
   u64 tx_rate;                 /**< Tx pacing rate */
+  u32 delivered;               /**< Bytes delivered in interval_time */
+  u32 acked_and_sacked;                /**< Bytes acked + sacked now */
+  u32 lost;                    /**< Bytes lost now */
   tcp_bts_flags_t flags;       /**< Rate sample flags from bt sample */
 } tcp_rate_sample_t;
 
@@ -287,6 +282,22 @@ typedef enum _tcp_cc_ack_t
   TCP_CC_PARTIALACK
 } tcp_cc_ack_t;
 
+typedef enum tcp_cc_event_
+{
+  TCP_CC_EVT_START_TX,
+} tcp_cc_event_t;
+
+/*
+ * As per RFC4898 tcpEStatsStackSoftErrors
+ */
+typedef struct tcp_errors_
+{
+  u32 below_data_wnd;  /**< All data in seg is below snd_una */
+  u32 above_data_wnd;  /**< Some data in segment is above snd_wnd */
+  u32 below_ack_wnd;   /**< Acks for data below snd_una */
+  u32 above_ack_wnd;   /**< Acks for data not sent */
+} tcp_errors_t;
+
 typedef struct _tcp_connection
 {
   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
@@ -296,7 +307,10 @@ typedef struct _tcp_connection
   u16 flags;                   /**< Connection flags (see tcp_conn_flags_e) */
   u32 timers[TCP_N_TIMERS];    /**< Timer handles into timer wheel */
 
-  /* TODO RFC4898 */
+  u64 segs_in;         /** RFC4022/4898 tcpHCInSegs/tcpEStatsPerfSegsIn */
+  u64 bytes_in;                /** RFC4898 tcpEStatsPerfHCDataOctetsIn */
+  u64 segs_out;                /** RFC4898 tcpEStatsPerfSegsOut */
+  u64 bytes_out;       /** RFC4898 tcpEStatsPerfHCDataOctetsOut */
 
   /** Send sequence variables RFC793 */
   u32 snd_una;         /**< oldest unacknowledged sequence number */
@@ -307,6 +321,9 @@ typedef struct _tcp_connection
   u32 snd_nxt;         /**< next seq number to be sent */
   u16 snd_mss;         /**< Effective send max seg (data) size */
 
+  u64 data_segs_in;    /** RFC4898 tcpEStatsPerfDataSegsIn */
+  u64 data_segs_out;   /** RFC4898 tcpEStatsPerfDataSegsOut */
+
   /** Receive sequence variables RFC793 */
   u32 rcv_nxt;         /**< next sequence number expected */
   u32 rcv_wnd;         /**< receive window we expect */
@@ -329,8 +346,10 @@ typedef struct _tcp_connection
   sack_block_t *snd_sacks_fl;  /**< Vector for building new list */
   sack_scoreboard_t sack_sb;   /**< SACK "scoreboard" that tracks holes */
 
-  u16 rcv_dupacks;     /**< Number of DUPACKs received */
+  u16 rcv_dupacks;     /**< Number of recent DUPACKs received */
+  u32 dupacks_in;      /**< RFC4898 tcpEStatsStackDupAcksIn*/
   u8 pending_dupacks;  /**< Number of DUPACKs to be sent */
+  u32 dupacks_out;     /**< RFC4898 tcpEStatsPathDupAcksOut */
 
   /* Congestion control */
   u32 cwnd;            /**< Congestion window */
@@ -348,6 +367,12 @@ typedef struct _tcp_connection
   tcp_cc_algorithm_t *cc_algo; /**< Congestion control algorithm */
   u8 cc_data[TCP_CC_DATA_SZ];  /**< Congestion control algo private data */
 
+  u32 fr_occurences;   /**< fast-retransmit occurrences RFC4898
+                            tcpEStatsStackFastRetran */
+  u32 tr_occurences;   /**< timer-retransmit occurrences */
+  u64 bytes_retrans;   /**< RFC4898 tcpEStatsPerfOctetsRetrans */
+  u64 segs_retrans;    /**< RFC4898 tcpEStatsPerfSegsRetrans*/
+
   /* RTT and RTO */
   u32 rto;             /**< Retransmission timeout */
   u32 rto_boff;                /**< Index for RTO backoff */
@@ -369,8 +394,12 @@ typedef struct _tcp_connection
   f64 delivered_time;          /**< Time last bytes were acked */
   tcp_byte_tracker_t *bt;      /**< Tx byte tracker */
 
+  tcp_errors_t errors; /**< Soft connection errors */
+
+  f64 start_ts;                /**< Timestamp when connection initialized */
   u32 last_fib_check;  /**< Last time we checked fib route for peer */
   u16 mss;             /**< Our max seg size that includes options */
+  u32 timestamp_delta; /**< Offset for timestamp */
 } tcp_connection_t;
 
 /* *INDENT-OFF* */
@@ -378,13 +407,17 @@ struct _tcp_cc_algorithm
 {
   const char *name;
   uword (*unformat_cfg) (unformat_input_t * input);
+  void (*init) (tcp_connection_t * tc);
+  void (*cleanup) (tcp_connection_t * tc);
   void (*rcv_ack) (tcp_connection_t * tc, tcp_rate_sample_t *rs);
   void (*rcv_cong_ack) (tcp_connection_t * tc, tcp_cc_ack_t ack,
                        tcp_rate_sample_t *rs);
   void (*congestion) (tcp_connection_t * tc);
+  void (*loss) (tcp_connection_t * tc);
   void (*recovered) (tcp_connection_t * tc);
-  void (*init) (tcp_connection_t * tc);
-  void (*cleanup) (tcp_connection_t * tc);
+  void (*undo_recovery) (tcp_connection_t * tc);
+  void (*event) (tcp_connection_t *tc, tcp_cc_event_t evt);
+  u64 (*get_pacing_rate) (tcp_connection_t *tc);
 };
 /* *INDENT-ON* */
 
@@ -412,6 +445,10 @@ tcp_cong_recovery_off (tcp_connection_t * tc)
   tcp_fastrecovery_first_off (tc);
 }
 
+#define tcp_zero_rwnd_sent(tc) ((tc)->flags & TCP_CONN_ZERO_RWND_SENT)
+#define tcp_zero_rwnd_sent_on(tc) (tc)->flags |= TCP_CONN_ZERO_RWND_SENT
+#define tcp_zero_rwnd_sent_off(tc) (tc)->flags &= ~TCP_CONN_ZERO_RWND_SENT
+
 typedef enum _tcp_error
 {
 #define tcp_error(n,s) TCP_ERROR_##n,
@@ -443,21 +480,9 @@ typedef struct tcp_worker_ctx_
   /** tx frames for ip 4/6 lookup nodes */
   vlib_frame_t *ip_lookup_tx_frames[2];
 
-  /** vector of connections needing fast rxt */
-  u32 *pending_fast_rxt;
-
-  /** vector of connections now doing fast rxt */
-  u32 *ongoing_fast_rxt;
-
-  /** vector of connections that will do fast rxt */
-  u32 *postponed_fast_rxt;
-
   /** vector of pending ack dequeues */
   u32 *pending_deq_acked;
 
-  /** vector of pending acks */
-  u32 *pending_acks;
-
   /** vector of pending disconnect notifications */
   u32 *pending_disconnects;
 
@@ -477,6 +502,66 @@ typedef struct tcp_iss_seed_
   u64 second;
 } tcp_iss_seed_t;
 
+typedef struct tcp_configuration_
+{
+  /** Max rx fifo size for a session (in bytes). It is used in to compute the
+   *  rfc 7323 window scaling factor */
+  u32 max_rx_fifo;
+
+  /** Min rx fifo for a session (in bytes) */
+  u32 min_rx_fifo;
+
+  /** Default MTU to be used when establishing connections */
+  u16 default_mtu;
+
+  /** Initial CWND multiplier, which multiplies MSS to determine initial CWND.
+   *  Set 0 to determine the initial CWND by another way */
+  u16 initial_cwnd_multiplier;
+
+  /** Enable tx pacing for new connections */
+  u8 enable_tx_pacing;
+
+  /** Default congestion control algorithm type */
+  tcp_cc_algorithm_type_e cc_algo;
+
+  /** Delayed ack time (disabled) */
+  u16 delack_time;
+
+  /** Timer ticks to wait for close from app */
+  u16 closewait_time;
+
+  /** Timer ticks to wait in time-wait. Also known as 2MSL */
+  u16 timewait_time;
+
+  /** Timer ticks to wait in fin-wait1 to send fin and rcv fin-ack */
+  u16 finwait1_time;
+
+  /** Timer ticks to wait in last ack for ack */
+  u16 lastack_time;
+
+  /** Timer ticks to wait in fin-wait2 for fin */
+  u16 finwait2_time;
+
+  /** Timer ticks to wait in closing for fin ack */
+  u16 closing_time;
+
+  /** Timer ticks to wait before cleaning up the connection */
+  u16 cleanup_time;
+
+  /** Number of preallocated connections */
+  u32 preallocated_connections;
+
+  /** Number of preallocated half-open connections */
+  u32 preallocated_half_open_connections;
+
+  /** Vectors of src addresses. Optional unless one needs > 63K active-opens */
+  ip4_address_t *ip4_src_addrs;
+  ip6_address_t *ip6_src_addrs;
+
+  /** Fault-injection. Debug only */
+  f64 buffer_fail_fraction;
+} tcp_configuration_t;
+
 typedef struct _tcp_main
 {
   /* Per-worker thread tcp connection pools */
@@ -494,17 +579,17 @@ typedef struct _tcp_main
   /** per-worker context */
   tcp_worker_ctx_t *wrk_ctx;
 
-  /* Pool of half-open connections on which we've sent a SYN */
+  /** Pool of half-open connections on which we've sent a SYN */
   tcp_connection_t *half_open_connections;
   clib_spinlock_t half_open_lock;
 
   /** vlib buffer size */
   u32 bytes_per_buffer;
 
-  /* Seed used to generate random iss */
+  /** Seed used to generate random iss */
   tcp_iss_seed_t iss_seed;
 
-  /* Congestion control algorithms registered */
+  /** Congestion control algorithms registered */
   tcp_cc_algorithm_t *cc_algos;
 
   /** Hash table of cc algorithms by name */
@@ -513,41 +598,23 @@ typedef struct _tcp_main
   /** Last cc algo registered */
   tcp_cc_algorithm_type_e cc_last_type;
 
-  /*
-   * Configuration
-   */
-
-  /* Flag that indicates if stack is on or off */
+  /** Flag that indicates if stack is on or off */
   u8 is_enabled;
 
-  /** Max rx fifo size for a session. It is used in to compute the
-   *  rfc 7323 window scaling factor */
-  u32 max_rx_fifo;
-
-  /** Default MTU to be used when establishing connections */
-  u16 default_mtu;
-
-  /** Number of preallocated connections */
-  u32 preallocated_connections;
-  u32 preallocated_half_open_connections;
-
-  /** Vectors of src addresses. Optional unless one needs > 63K active-opens */
-  ip4_address_t *ip4_src_addresses;
-  u32 last_v4_address_rotor;
-  u32 last_v6_address_rotor;
-  ip6_address_t *ip6_src_addresses;
-
-  /** Enable tx pacing for new connections */
-  u8 tx_pacing;
-
+  /** Flag that indicates if v4 punting is enabled */
   u8 punt_unknown4;
+
+  /** Flag that indicates if v6 punting is enabled */
   u8 punt_unknown6;
 
-  /** fault-injection */
-  f64 buffer_fail_fraction;
+  /** Rotor for v4 source addresses */
+  u32 last_v4_addr_rotor;
 
-  /** Default congestion control algorithm type */
-  tcp_cc_algorithm_type_e cc_algo;
+  /** Rotor for v6 source addresses */
+  u32 last_v6_addr_rotor;
+
+  /** Protocol configuration */
+  tcp_configuration_t cfg;
 } tcp_main_t;
 
 extern tcp_main_t tcp_main;
@@ -564,6 +631,10 @@ extern vlib_node_registration_t tcp6_rcv_process_node;
 extern vlib_node_registration_t tcp4_listen_node;
 extern vlib_node_registration_t tcp6_listen_node;
 
+#define tcp_cfg tcp_main.cfg
+#define tcp_node_index(node_id, is_ip4)                                \
+  ((is_ip4) ? tcp4_##node_id##_node.index : tcp6_##node_id##_node.index)
+
 always_inline tcp_main_t *
 vnet_get_tcp_main ()
 {
@@ -634,6 +705,8 @@ void tcp_connection_cleanup (tcp_connection_t * tc);
 void tcp_connection_del (tcp_connection_t * tc);
 int tcp_half_open_connection_cleanup (tcp_connection_t * tc);
 tcp_connection_t *tcp_connection_alloc (u8 thread_index);
+tcp_connection_t *tcp_connection_alloc_w_base (u8 thread_index,
+                                              tcp_connection_t * base);
 void tcp_connection_free (tcp_connection_t * tc);
 void tcp_connection_reset (tcp_connection_t * tc);
 int tcp_configure_v4_source_address_range (vlib_main_t * vm,
@@ -675,13 +748,11 @@ void tcp_update_burst_snd_vars (tcp_connection_t * tc);
 void tcp_update_rto (tcp_connection_t * tc);
 void tcp_flush_frame_to_output (tcp_worker_ctx_t * wrk, u8 is_ip4);
 void tcp_flush_frames_to_output (tcp_worker_ctx_t * wrk);
-void tcp_program_fastretransmit (tcp_worker_ctx_t * wrk,
-                                tcp_connection_t * tc);
-void tcp_do_fastretransmits (tcp_worker_ctx_t * wrk);
+void tcp_send_window_update_ack (tcp_connection_t * tc);
 
-void tcp_program_ack (tcp_worker_ctx_t * wrk, tcp_connection_t * tc);
-void tcp_program_dupack (tcp_worker_ctx_t * wrk, tcp_connection_t * tc);
-void tcp_send_acks (tcp_worker_ctx_t * wrk);
+void tcp_program_ack (tcp_connection_t * tc);
+void tcp_program_dupack (tcp_connection_t * tc);
+void tcp_program_fastretransmit (tcp_connection_t * tc);
 
 /*
  * Rate estimation
@@ -803,6 +874,9 @@ tcp_flight_size (const tcp_connection_t * tc)
 always_inline u32
 tcp_initial_cwnd (const tcp_connection_t * tc)
 {
+  if (tcp_cfg.initial_cwnd_multiplier > 0)
+    return tcp_cfg.initial_cwnd_multiplier * tc->snd_mss;
+
   if (tc->snd_mss > 2190)
     return 2 * tc->snd_mss;
   else if (tc->snd_mss > 1095)
@@ -887,7 +961,7 @@ int tcp_fast_retransmit_sack (tcp_worker_ctx_t * wrk, tcp_connection_t * tc,
 int tcp_fast_retransmit (tcp_worker_ctx_t * wrk, tcp_connection_t * tc,
                         u32 burst_size);
 void tcp_cc_init_congestion (tcp_connection_t * tc);
-void tcp_cc_fastrecovery_exit (tcp_connection_t * tc);
+void tcp_cc_fastrecovery_clear (tcp_connection_t * tc);
 
 fib_node_index_t tcp_lookup_rmt_in_fib (tcp_connection_t * tc);
 
@@ -907,6 +981,16 @@ tcp_time_now_w_thread (u32 thread_index)
   return tcp_main.wrk_ctx[thread_index].time_now;
 }
 
+/**
+ * Generate timestamp for tcp connection
+ */
+always_inline u32
+tcp_tstamp (tcp_connection_t * tc)
+{
+  return (tcp_main.wrk_ctx[tc->c_thread_index].time_now -
+         tc->timestamp_delta);
+}
+
 always_inline f64
 tcp_time_now_us (u32 thread_index)
 {
@@ -922,6 +1006,7 @@ tcp_set_time_now (tcp_worker_ctx_t * wrk)
 
 u32 tcp_session_push_header (transport_connection_t * tconn,
                             vlib_buffer_t * b);
+int tcp_session_custom_tx (void *conn, u32 max_burst_size);
 
 void tcp_connection_timers_init (tcp_connection_t * tc);
 void tcp_connection_timers_reset (tcp_connection_t * tc);
@@ -945,6 +1030,44 @@ tcp_cc_rcv_cong_ack (tcp_connection_t * tc, tcp_cc_ack_t ack_type,
   tc->cc_algo->rcv_cong_ack (tc, ack_type, rs);
 }
 
+static inline void
+tcp_cc_loss (tcp_connection_t * tc)
+{
+  tc->cc_algo->loss (tc);
+}
+
+static inline void
+tcp_cc_recovered (tcp_connection_t * tc)
+{
+  tc->cc_algo->recovered (tc);
+}
+
+static inline void
+tcp_cc_undo_recovery (tcp_connection_t * tc)
+{
+  if (tc->cc_algo->undo_recovery)
+    tc->cc_algo->undo_recovery (tc);
+}
+
+static inline void
+tcp_cc_event (tcp_connection_t * tc, tcp_cc_event_t evt)
+{
+  if (tc->cc_algo->event)
+    tc->cc_algo->event (tc, evt);
+}
+
+static inline u64
+tcp_cc_get_pacing_rate (tcp_connection_t * tc)
+{
+  if (tc->cc_algo->get_pacing_rate)
+    return tc->cc_algo->get_pacing_rate (tc);
+
+  f64 srtt = clib_min ((f64) tc->srtt * TCP_TICK, tc->mrtt_us);
+  /* TODO should constrain to interface's max throughput but
+   * we don't have link speeds for sw ifs ..*/
+  return (tc->cwnd / srtt);
+}
+
 always_inline void
 tcp_timer_set (tcp_connection_t * tc, u8 timer_id, u32 interval)
 {
@@ -1010,16 +1133,14 @@ tcp_persist_timer_set (tcp_connection_t * tc)
 {
   /* Reuse RTO. It's backed off in handler */
   tcp_timer_set (tc, TCP_TIMER_PERSIST,
-                clib_max (tc->rto * TCP_TO_TIMER_TICK,
-                          TCP_TIMER_PERSIST_MIN));
+                clib_max (tc->rto * TCP_TO_TIMER_TICK, 1));
 }
 
 always_inline void
 tcp_persist_timer_update (tcp_connection_t * tc)
 {
   tcp_timer_update (tc, TCP_TIMER_PERSIST,
-                   clib_max (tc->rto * TCP_TO_TIMER_TICK,
-                             TCP_TIMER_PERSIST_MIN));
+                   clib_max (tc->rto * TCP_TO_TIMER_TICK, 1));
 }
 
 always_inline void