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