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