session: api to add new transport types
[vpp.git] / src / vnet / session / transport.h
index 058a9ae..e5c09cd 100644 (file)
 #include <vnet/vnet.h>
 #include <vnet/session/transport_types.h>
 
+#define TRANSPORT_PACER_MIN_MSS        1460
+#define TRANSPORT_PACER_MIN_BURST      TRANSPORT_PACER_MIN_MSS
+#define TRANSPORT_PACER_MAX_BURST      (43 * TRANSPORT_PACER_MIN_MSS)
+#define TRANSPORT_PACER_MIN_IDLE       100
+#define TRANSPORT_PACER_IDLE_FACTOR    0.05
+
 typedef struct _transport_options_t
 {
+  char *name;
+  char *short_name;
   transport_tx_fn_type_t tx_type;
   transport_service_type_t service_type;
   u8 half_open_has_fifos;
 } transport_options_t;
 
+typedef enum transport_snd_flags_
+{
+  TRANSPORT_SND_F_DESCHED = 1 << 0,
+  TRANSPORT_SND_F_POSTPONE = 1 << 1,
+  TRANSPORT_SND_N_FLAGS
+} __clib_packed transport_snd_flags_t;
+
+typedef struct transport_send_params_
+{
+  u32 snd_space;
+  u32 tx_offset;
+  u16 snd_mss;
+  transport_snd_flags_t flags;
+} transport_send_params_t;
+
 /*
  * Transport protocol virtual function table
  */
@@ -39,6 +62,7 @@ typedef struct _transport_proto_vft
   u32 (*stop_listen) (u32 conn_index);
   int (*connect) (transport_endpoint_cfg_t * rmt);
   void (*close) (u32 conn_index, u32 thread_index);
+  void (*reset) (u32 conn_index, u32 thread_index);
   void (*cleanup) (u32 conn_index, u32 thread_index);
   clib_error_t *(*enable) (vlib_main_t * vm, u8 is_en);
 
@@ -47,9 +71,8 @@ typedef struct _transport_proto_vft
    */
 
   u32 (*push_header) (transport_connection_t * tconn, vlib_buffer_t * b);
-  u16 (*send_mss) (transport_connection_t * tc);
-  u32 (*send_space) (transport_connection_t * tc);
-  u32 (*tx_fifo_offset) (transport_connection_t * tc);
+  int (*send_params) (transport_connection_t * tconn,
+                     transport_send_params_t *sp);
   void (*update_time) (f64 time_now, u8 thread_index);
   void (*flush_data) (transport_connection_t *tconn);
   int (*custom_tx) (void *session, u32 max_burst_size);
@@ -96,6 +119,7 @@ do {                                                         \
 
 int transport_connect (transport_proto_t tp, transport_endpoint_cfg_t * tep);
 void transport_close (transport_proto_t tp, u32 conn_index, u8 thread_index);
+void transport_reset (transport_proto_t tp, u32 conn_index, u8 thread_index);
 u32 transport_start_listen (transport_proto_t tp, u32 session_index,
                            transport_endpoint_t * tep);
 u32 transport_stop_listen (transport_proto_t tp, u32 conn_index);
@@ -142,11 +166,54 @@ transport_app_rx_evt (transport_proto_t tp, u32 conn_index, u32 thread_index)
   return tp_vfts[tp].app_rx_evt (tc);
 }
 
+/**
+ * Get send parameters for transport connection
+ *
+ * These include maximum tx burst, mss, tx offset and other flags
+ * transport might want to provide to sessin layer
+ *
+ * @param tc           transport connection
+ * @param sp           send paramaters
+ *
+ */
+static inline u32
+transport_connection_snd_params (transport_connection_t * tc,
+                                transport_send_params_t * sp)
+{
+  return tp_vfts[tc->proto].send_params (tc, sp);
+}
+
+static inline u8
+transport_connection_is_descheduled (transport_connection_t * tc)
+{
+  return ((tc->flags & TRANSPORT_CONNECTION_F_DESCHED) ? 1 : 0);
+}
+
+static inline void
+transport_connection_deschedule (transport_connection_t * tc)
+{
+  tc->flags |= TRANSPORT_CONNECTION_F_DESCHED;
+}
+
+void transport_connection_reschedule (transport_connection_t * tc);
+
+/**
+ * Register transport virtual function table.
+ *
+ * @param transport_proto - transport protocol type (i.e., TCP, UDP ..)
+ * @param vft - virtual function table for transport proto
+ * @param fib_proto - network layer protocol
+ * @param output_node - output node index that session layer will hand off
+ *                     buffers to, for requested fib proto
+ */
 void transport_register_protocol (transport_proto_t transport_proto,
                                  const transport_proto_vft_t * vft,
                                  fib_protocol_t fib_proto, u32 output_node);
+transport_proto_t
+transport_register_new_protocol (const transport_proto_vft_t * vft,
+                                fib_protocol_t fib_proto, u32 output_node);
 transport_proto_vft_t *transport_protocol_get_vft (transport_proto_t tp);
-void transport_update_time (f64 time_now, u8 thread_index);
+void transport_update_time (clib_time_type_t time_now, u8 thread_index);
 
 int transport_alloc_local_port (u8 proto, ip46_address_t * ip);
 int transport_alloc_local_endpoint (u8 proto, transport_endpoint_cfg_t * rmt,
@@ -167,8 +234,9 @@ transport_elog_track_index (transport_connection_t * tc)
 }
 
 void transport_connection_tx_pacer_reset (transport_connection_t * tc,
-                                         u32 rate_bytes_per_sec,
-                                         u32 initial_bucket, u64 time_now);
+                                         u64 rate_bytes_per_sec,
+                                         u32 initial_bucket,
+                                         clib_us_time_t rtt);
 /**
  * Initialize tx pacer for connection
  *
@@ -177,7 +245,7 @@ void transport_connection_tx_pacer_reset (transport_connection_t * tc,
  * @param burst_bytes                  initial burst size in bytes
  */
 void transport_connection_tx_pacer_init (transport_connection_t * tc,
-                                        u32 rate_bytes_per_sec,
+                                        u64 rate_bytes_per_sec,
                                         u32 initial_bucket);
 
 /**
@@ -185,19 +253,13 @@ void transport_connection_tx_pacer_init (transport_connection_t * tc,
  *
  * @param tc                   transport connection
  * @param bytes_per_sec                new pacing rate
+ * @param rtt                  connection rtt that is used to compute
+ *                             inactivity time after which pacer bucket is
+ *                             reset to 1 mtu
  */
 void transport_connection_tx_pacer_update (transport_connection_t * tc,
-                                          u64 bytes_per_sec);
-
-/**
- * Get maximum tx burst allowed for transport connection
- *
- * @param tc           transport connection
- * @param time_now     current cpu time as returned by @ref clib_cpu_time_now
- * @param mss          transport's mss
- */
-u32 transport_connection_snd_space (transport_connection_t * tc,
-                                   u64 time_now, u16 mss);
+                                          u64 bytes_per_sec,
+                                          clib_us_time_t rtt);
 
 /**
  * Get tx pacer max burst
@@ -206,8 +268,7 @@ u32 transport_connection_snd_space (transport_connection_t * tc,
  * @param time_now     current cpu time
  * @return             max burst for connection
  */
-u32 transport_connection_tx_pacer_burst (transport_connection_t * tc,
-                                        u64 time_now);
+u32 transport_connection_tx_pacer_burst (transport_connection_t * tc);
 
 /**
  * Get tx pacer current rate
@@ -218,12 +279,13 @@ u32 transport_connection_tx_pacer_burst (transport_connection_t * tc,
 u64 transport_connection_tx_pacer_rate (transport_connection_t * tc);
 
 /**
- * Initialize period for tx pacers
+ * Reset tx pacer bucket
  *
- * Defines a unit of time with respect to number of cpu cycles that is to
- * be used by all tx pacers.
+ * @param tc           transport connection
+ * @param bucket       value the bucket will be reset to
  */
-void transport_init_tx_pacers_period (void);
+void transport_connection_tx_pacer_reset_bucket (transport_connection_t * tc,
+                                                u32 bucket);
 
 /**
  * Check if transport connection is paced
@@ -237,16 +299,15 @@ transport_connection_is_tx_paced (transport_connection_t * tc)
 u8 *format_transport_pacer (u8 * s, va_list * args);
 
 /**
- * Update tx byte stats for transport connection
+ * Update tx bytes for paced transport connection
  *
- * If tx pacing is enabled, this also updates pacer bucket to account for the
+ * If tx pacing is enabled, this update pacer bucket to account for the
  * amount of bytes that have been sent.
  *
  * @param tc           transport connection
- * @param pkts         packets recently sent
  * @param bytes                bytes recently sent
  */
-void transport_connection_update_tx_stats (transport_connection_t * tc,
+void transport_connection_update_tx_bytes (transport_connection_t * tc,
                                           u32 bytes);
 
 void