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