src/vnet/session/transport.h

   1 /*
   2  * Copyright (c) 2017-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 SRC_VNET_SESSION_TRANSPORT_H_
  17 #define SRC_VNET_SESSION_TRANSPORT_H_
  18
  19 #include <vnet/vnet.h>
  20 #include <vnet/session/transport_types.h>
  21
  22 #define TRANSPORT_PACER_MIN_MSS         1460
  23 #define TRANSPORT_PACER_MIN_BURST       TRANSPORT_PACER_MIN_MSS
  24 #define TRANSPORT_PACER_MAX_BURST       (43 * TRANSPORT_PACER_MIN_MSS)
  25 #define TRANSPORT_PACER_MAX_BURST_PKTS  43
  26 #define TRANSPORT_PACER_MIN_IDLE        100
  27 #define TRANSPORT_PACER_IDLE_FACTOR     0.05
  28
  29 typedef struct _transport_options_t
  30 {
  31   char *name;
  32   char *short_name;
  33   transport_tx_fn_type_t tx_type;
  34   transport_service_type_t service_type;
  35   u8 half_open_has_fifos;
  36 } transport_options_t;
  37
  38 typedef enum transport_snd_flags_
  39 {
  40   TRANSPORT_SND_F_DESCHED = 1 << 0,
  41   TRANSPORT_SND_F_POSTPONE = 1 << 1,
  42   TRANSPORT_SND_N_FLAGS
  43 } __clib_packed transport_snd_flags_t;
  44
  45 typedef struct transport_send_params_
  46 {
  47   u32 snd_space;
  48   u32 tx_offset;
  49   u16 snd_mss;
  50   transport_snd_flags_t flags;
  51 } transport_send_params_t;
  52
  53 /*
  54  * Transport protocol virtual function table
  55  */
  56 /* *INDENT-OFF* */
  57 typedef struct _transport_proto_vft
  58 {
  59   /*
  60    * Setup
  61    */
  62   u32 (*start_listen) (u32 session_index, transport_endpoint_t * lcl);
  63   u32 (*stop_listen) (u32 conn_index);
  64   int (*connect) (transport_endpoint_cfg_t * rmt);
  65   void (*close) (u32 conn_index, u32 thread_index);
  66   void (*reset) (u32 conn_index, u32 thread_index);
  67   void (*cleanup) (u32 conn_index, u32 thread_index);
  68   clib_error_t *(*enable) (vlib_main_t * vm, u8 is_en);
  69
  70   /*
  71    * Transmission
  72    */
  73
  74   u32 (*push_header) (transport_connection_t * tconn, vlib_buffer_t * b);
  75   int (*send_params) (transport_connection_t * tconn,
  76                       transport_send_params_t *sp);
  77   void (*update_time) (f64 time_now, u8 thread_index);
  78   void (*flush_data) (transport_connection_t *tconn);
  79   int (*custom_tx) (void *session, u32 max_burst_size);
  80   int (*app_rx_evt) (transport_connection_t *tconn);
  81
  82   /*
  83    * Connection retrieval
  84    */
  85   transport_connection_t *(*get_connection) (u32 conn_idx, u32 thread_idx);
  86   transport_connection_t *(*get_listener) (u32 conn_index);
  87   transport_connection_t *(*get_half_open) (u32 conn_index);
  88
  89   /*
  90    * Format
  91    */
  92   u8 *(*format_connection) (u8 * s, va_list * args);
  93   u8 *(*format_listener) (u8 * s, va_list * args);
  94   u8 *(*format_half_open) (u8 * s, va_list * args);
  95
  96   /*
  97    *  Properties retrieval
  98    */
  99   void (*get_transport_endpoint) (u32 conn_index, u32 thread_index,
 100                                   transport_endpoint_t *tep, u8 is_lcl);
 101   void (*get_transport_listener_endpoint) (u32 conn_index,
 102                                            transport_endpoint_t *tep,
 103                                            u8 is_lcl);
 104
 105   /*
 106    * Properties
 107    */
 108   transport_options_t transport_options;
 109 } transport_proto_vft_t;
 110 /* *INDENT-ON* */
 111
 112 extern transport_proto_vft_t *tp_vfts;
 113
 114 #define transport_proto_foreach(VAR, BODY)                      \
 115 do {                                                            \
 116     for (VAR = 0; VAR < vec_len (tp_vfts); VAR++)               \
 117       if (tp_vfts[VAR].push_header != 0)                        \
 118         do { BODY; } while (0);                                 \
 119 } while (0)
 120
 121 int transport_connect (transport_proto_t tp, transport_endpoint_cfg_t * tep);
 122 void transport_close (transport_proto_t tp, u32 conn_index, u8 thread_index);
 123 void transport_reset (transport_proto_t tp, u32 conn_index, u8 thread_index);
 124 u32 transport_start_listen (transport_proto_t tp, u32 session_index,
 125                             transport_endpoint_t * tep);
 126 u32 transport_stop_listen (transport_proto_t tp, u32 conn_index);
 127 void transport_cleanup (transport_proto_t tp, u32 conn_index,
 128                         u8 thread_index);
 129 void transport_get_endpoint (transport_proto_t tp, u32 conn_index,
 130                              u32 thread_index, transport_endpoint_t * tep,
 131                              u8 is_lcl);
 132 void transport_get_listener_endpoint (transport_proto_t tp, u32 conn_index,
 133                                       transport_endpoint_t * tep, u8 is_lcl);
 134
 135 static inline transport_connection_t *
 136 transport_get_connection (transport_proto_t tp, u32 conn_index,
 137                           u8 thread_index)
 138 {
 139   return tp_vfts[tp].get_connection (conn_index, thread_index);
 140 }
 141
 142 static inline transport_connection_t *
 143 transport_get_listener (transport_proto_t tp, u32 conn_index)
 144 {
 145   return tp_vfts[tp].get_listener (conn_index);
 146 }
 147
 148 static inline transport_connection_t *
 149 transport_get_half_open (transport_proto_t tp, u32 conn_index)
 150 {
 151   return tp_vfts[tp].get_half_open (conn_index);
 152 }
 153
 154 static inline int
 155 transport_custom_tx (transport_proto_t tp, void *s, u32 max_burst_size)
 156 {
 157   return tp_vfts[tp].custom_tx (s, max_burst_size);
 158 }
 159
 160 static inline int
 161 transport_app_rx_evt (transport_proto_t tp, u32 conn_index, u32 thread_index)
 162 {
 163   transport_connection_t *tc;
 164   if (!tp_vfts[tp].app_rx_evt)
 165     return 0;
 166   tc = transport_get_connection (tp, conn_index, thread_index);
 167   return tp_vfts[tp].app_rx_evt (tc);
 168 }
 169
 170 /**
 171  * Get send parameters for transport connection
 172  *
 173  * These include maximum tx burst, mss, tx offset and other flags
 174  * transport might want to provide to sessin layer
 175  *
 176  * @param tc            transport connection
 177  * @param sp            send paramaters
 178  *
 179  */
 180 static inline u32
 181 transport_connection_snd_params (transport_connection_t * tc,
 182                                  transport_send_params_t * sp)
 183 {
 184   return tp_vfts[tc->proto].send_params (tc, sp);
 185 }
 186
 187 static inline u8
 188 transport_connection_is_descheduled (transport_connection_t * tc)
 189 {
 190   return ((tc->flags & TRANSPORT_CONNECTION_F_DESCHED) ? 1 : 0);
 191 }
 192
 193 static inline void
 194 transport_connection_deschedule (transport_connection_t * tc)
 195 {
 196   tc->flags |= TRANSPORT_CONNECTION_F_DESCHED;
 197 }
 198
 199 static inline u8
 200 transport_connection_is_cless (transport_connection_t * tc)
 201 {
 202   return ((tc->flags & TRANSPORT_CONNECTION_F_CLESS) ? 1 : 0);
 203 }
 204
 205 void transport_connection_reschedule (transport_connection_t * tc);
 206
 207 /**
 208  * Register transport virtual function table.
 209  *
 210  * @param transport_proto - transport protocol type (i.e., TCP, UDP ..)
 211  * @param vft - virtual function table for transport proto
 212  * @param fib_proto - network layer protocol
 213  * @param output_node - output node index that session layer will hand off
 214  *                      buffers to, for requested fib proto
 215  */
 216 void transport_register_protocol (transport_proto_t transport_proto,
 217                                   const transport_proto_vft_t * vft,
 218                                   fib_protocol_t fib_proto, u32 output_node);
 219 transport_proto_t
 220 transport_register_new_protocol (const transport_proto_vft_t * vft,
 221                                  fib_protocol_t fib_proto, u32 output_node);
 222 transport_proto_vft_t *transport_protocol_get_vft (transport_proto_t tp);
 223 void transport_update_time (clib_time_type_t time_now, u8 thread_index);
 224
 225 int transport_alloc_local_port (u8 proto, ip46_address_t * ip);
 226 int transport_alloc_local_endpoint (u8 proto, transport_endpoint_cfg_t * rmt,
 227                                     ip46_address_t * lcl_addr,
 228                                     u16 * lcl_port);
 229 void transport_endpoint_cleanup (u8 proto, ip46_address_t * lcl_ip, u16 port);
 230 void transport_enable_disable (vlib_main_t * vm, u8 is_en);
 231 void transport_init (void);
 232
 233 always_inline u32
 234 transport_elog_track_index (transport_connection_t * tc)
 235 {
 236 #if TRANSPORT_DEBUG
 237   return tc->elog_track.track_index_plus_one - 1;
 238 #else
 239   return ~0;
 240 #endif
 241 }
 242
 243 void transport_connection_tx_pacer_reset (transport_connection_t * tc,
 244                                           u64 rate_bytes_per_sec,
 245                                           u32 initial_bucket,
 246                                           clib_us_time_t rtt);
 247 /**
 248  * Initialize tx pacer for connection
 249  *
 250  * @param tc                            transport connection
 251  * @param rate_bytes_per_second         initial byte rate
 252  * @param burst_bytes                   initial burst size in bytes
 253  */
 254 void transport_connection_tx_pacer_init (transport_connection_t * tc,
 255                                          u64 rate_bytes_per_sec,
 256                                          u32 initial_bucket);
 257
 258 /**
 259  * Update tx pacer pacing rate
 260  *
 261  * @param tc                    transport connection
 262  * @param bytes_per_sec         new pacing rate
 263  * @param rtt                   connection rtt that is used to compute
 264  *                              inactivity time after which pacer bucket is
 265  *                              reset to 1 mtu
 266  */
 267 void transport_connection_tx_pacer_update (transport_connection_t * tc,
 268                                            u64 bytes_per_sec,
 269                                            clib_us_time_t rtt);
 270
 271 /**
 272  * Get tx pacer max burst
 273  *
 274  * @param tc            transport connection
 275  * @param time_now      current cpu time
 276  * @return              max burst for connection
 277  */
 278 u32 transport_connection_tx_pacer_burst (transport_connection_t * tc);
 279
 280 /**
 281  * Get tx pacer current rate
 282  *
 283  * @param tc            transport connection
 284  * @return              rate for connection in bytes/s
 285  */
 286 u64 transport_connection_tx_pacer_rate (transport_connection_t * tc);
 287
 288 /**
 289  * Reset tx pacer bucket
 290  *
 291  * @param tc            transport connection
 292  * @param bucket        value the bucket will be reset to
 293  */
 294 void transport_connection_tx_pacer_reset_bucket (transport_connection_t * tc,
 295                                                  u32 bucket);
 296
 297 /**
 298  * Check if transport connection is paced
 299  */
 300 always_inline u8
 301 transport_connection_is_tx_paced (transport_connection_t * tc)
 302 {
 303   return (tc->flags & TRANSPORT_CONNECTION_F_IS_TX_PACED);
 304 }
 305
 306 u8 *format_transport_pacer (u8 * s, va_list * args);
 307
 308 /**
 309  * Update tx bytes for paced transport connection
 310  *
 311  * If tx pacing is enabled, this update pacer bucket to account for the
 312  * amount of bytes that have been sent.
 313  *
 314  * @param tc            transport connection
 315  * @param bytes         bytes recently sent
 316  */
 317 void transport_connection_update_tx_bytes (transport_connection_t * tc,
 318                                            u32 bytes);
 319
 320 void
 321 transport_connection_tx_pacer_update_bytes (transport_connection_t * tc,
 322                                             u32 bytes);
 323
 324 #endif /* SRC_VNET_SESSION_TRANSPORT_H_ */
 325
 326 /*
 327  * fd.io coding-style-patch-verification: ON
 328  *
 329  * Local Variables:
 330  * eval: (c-set-style "gnu")
 331  * End:
 332  */