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
 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
 118   /*
 119    * Properties
 120    */
 121   transport_options_t transport_options;
 122 } transport_proto_vft_t;
 123 /* *INDENT-ON* */
 124
 125 extern transport_proto_vft_t *tp_vfts;
 126
 127 #define transport_proto_foreach(VAR, BODY)                      \
 128 do {                                                            \
 129     for (VAR = 0; VAR < vec_len (tp_vfts); VAR++)               \
 130       if (tp_vfts[VAR].push_header != 0)                        \
 131         do { BODY; } while (0);                                 \
 132 } while (0)
 133
 134 int transport_connect (transport_proto_t tp, transport_endpoint_cfg_t * tep);
 135 void transport_close (transport_proto_t tp, u32 conn_index, u8 thread_index);
 136 void transport_reset (transport_proto_t tp, u32 conn_index, u8 thread_index);
 137 u32 transport_start_listen (transport_proto_t tp, u32 session_index,
 138                             transport_endpoint_t * tep);
 139 u32 transport_stop_listen (transport_proto_t tp, u32 conn_index);
 140 void transport_cleanup (transport_proto_t tp, u32 conn_index,
 141                         u8 thread_index);
 142 void transport_cleanup_half_open (transport_proto_t tp, u32 conn_index);
 143 void transport_get_endpoint (transport_proto_t tp, u32 conn_index,
 144                              u32 thread_index, transport_endpoint_t * tep,
 145                              u8 is_lcl);
 146 void transport_get_listener_endpoint (transport_proto_t tp, u32 conn_index,
 147                                       transport_endpoint_t * tep, u8 is_lcl);
 148
 149 static inline transport_connection_t *
 150 transport_get_connection (transport_proto_t tp, u32 conn_index,
 151                           u8 thread_index)
 152 {
 153   return tp_vfts[tp].get_connection (conn_index, thread_index);
 154 }
 155
 156 static inline transport_connection_t *
 157 transport_get_listener (transport_proto_t tp, u32 conn_index)
 158 {
 159   return tp_vfts[tp].get_listener (conn_index);
 160 }
 161
 162 static inline transport_connection_t *
 163 transport_get_half_open (transport_proto_t tp, u32 conn_index)
 164 {
 165   return tp_vfts[tp].get_half_open (conn_index);
 166 }
 167
 168 static inline int
 169 transport_custom_tx (transport_proto_t tp, void *s,
 170                      transport_send_params_t * sp)
 171 {
 172   return tp_vfts[tp].custom_tx (s, sp);
 173 }
 174
 175 static inline int
 176 transport_app_rx_evt (transport_proto_t tp, u32 conn_index, u32 thread_index)
 177 {
 178   transport_connection_t *tc;
 179   if (!tp_vfts[tp].app_rx_evt)
 180     return 0;
 181   tc = transport_get_connection (tp, conn_index, thread_index);
 182   return tp_vfts[tp].app_rx_evt (tc);
 183 }
 184
 185 /**
 186  * Get send parameters for transport connection
 187  *
 188  * These include maximum tx burst, mss, tx offset and other flags
 189  * transport might want to provide to sessin layer
 190  *
 191  * @param tc            transport connection
 192  * @param sp            send paramaters
 193  *
 194  */
 195 static inline u32
 196 transport_connection_snd_params (transport_connection_t * tc,
 197                                  transport_send_params_t * sp)
 198 {
 199   return tp_vfts[tc->proto].send_params (tc, sp);
 200 }
 201
 202 static inline u8
 203 transport_connection_is_descheduled (transport_connection_t * tc)
 204 {
 205   return ((tc->flags & TRANSPORT_CONNECTION_F_DESCHED) ? 1 : 0);
 206 }
 207
 208 static inline void
 209 transport_connection_deschedule (transport_connection_t * tc)
 210 {
 211   tc->flags |= TRANSPORT_CONNECTION_F_DESCHED;
 212 }
 213
 214 static inline u8
 215 transport_connection_is_cless (transport_connection_t * tc)
 216 {
 217   return ((tc->flags & TRANSPORT_CONNECTION_F_CLESS) ? 1 : 0);
 218 }
 219
 220 void transport_connection_reschedule (transport_connection_t * tc);
 221 void transport_fifos_init_ooo (transport_connection_t * tc);
 222
 223 /**
 224  * Register transport virtual function table.
 225  *
 226  * @param transport_proto - transport protocol type (i.e., TCP, UDP ..)
 227  * @param vft - virtual function table for transport proto
 228  * @param fib_proto - network layer protocol
 229  * @param output_node - output node index that session layer will hand off
 230  *                      buffers to, for requested fib proto
 231  */
 232 void transport_register_protocol (transport_proto_t transport_proto,
 233                                   const transport_proto_vft_t * vft,
 234                                   fib_protocol_t fib_proto, u32 output_node);
 235 transport_proto_t
 236 transport_register_new_protocol (const transport_proto_vft_t * vft,
 237                                  fib_protocol_t fib_proto, u32 output_node);
 238 transport_proto_vft_t *transport_protocol_get_vft (transport_proto_t tp);
 239 void transport_update_time (clib_time_type_t time_now, u8 thread_index);
 240
 241 int transport_alloc_local_port (u8 proto, ip46_address_t * ip);
 242 int transport_alloc_local_endpoint (u8 proto, transport_endpoint_cfg_t * rmt,
 243                                     ip46_address_t * lcl_addr,
 244                                     u16 * lcl_port);
 245 void transport_share_local_endpoint (u8 proto, ip46_address_t * lcl_ip,
 246                                      u16 port);
 247 void transport_endpoint_cleanup (u8 proto, ip46_address_t * lcl_ip, u16 port);
 248 void transport_enable_disable (vlib_main_t * vm, u8 is_en);
 249 void transport_init (void);
 250
 251 always_inline u32
 252 transport_elog_track_index (transport_connection_t * tc)
 253 {
 254 #if TRANSPORT_DEBUG
 255   return tc->elog_track.track_index_plus_one - 1;
 256 #else
 257   return ~0;
 258 #endif
 259 }
 260
 261 void transport_connection_tx_pacer_reset (transport_connection_t * tc,
 262                                           u64 rate_bytes_per_sec,
 263                                           u32 initial_bucket,
 264                                           clib_us_time_t rtt);
 265 /**
 266  * Initialize tx pacer for connection
 267  *
 268  * @param tc                            transport connection
 269  * @param rate_bytes_per_second         initial byte rate
 270  * @param burst_bytes                   initial burst size in bytes
 271  */
 272 void transport_connection_tx_pacer_init (transport_connection_t * tc,
 273                                          u64 rate_bytes_per_sec,
 274                                          u32 initial_bucket);
 275
 276 /**
 277  * Update tx pacer pacing rate
 278  *
 279  * @param tc                    transport connection
 280  * @param bytes_per_sec         new pacing rate
 281  * @param rtt                   connection rtt that is used to compute
 282  *                              inactivity time after which pacer bucket is
 283  *                              reset to 1 mtu
 284  */
 285 void transport_connection_tx_pacer_update (transport_connection_t * tc,
 286                                            u64 bytes_per_sec,
 287                                            clib_us_time_t rtt);
 288
 289 /**
 290  * Get tx pacer max burst
 291  *
 292  * @param tc            transport connection
 293  * @param time_now      current cpu time
 294  * @return              max burst for connection
 295  */
 296 u32 transport_connection_tx_pacer_burst (transport_connection_t * tc);
 297
 298 /**
 299  * Get tx pacer current rate
 300  *
 301  * @param tc            transport connection
 302  * @return              rate for connection in bytes/s
 303  */
 304 u64 transport_connection_tx_pacer_rate (transport_connection_t * tc);
 305
 306 /**
 307  * Reset tx pacer bucket
 308  *
 309  * @param tc            transport connection
 310  * @param bucket        value the bucket will be reset to
 311  */
 312 void transport_connection_tx_pacer_reset_bucket (transport_connection_t * tc,
 313                                                  u32 bucket);
 314
 315 /**
 316  * Check if transport connection is paced
 317  */
 318 always_inline u8
 319 transport_connection_is_tx_paced (transport_connection_t * tc)
 320 {
 321   return (tc->flags & TRANSPORT_CONNECTION_F_IS_TX_PACED);
 322 }
 323
 324 u8 *format_transport_pacer (u8 * s, va_list * args);
 325
 326 /**
 327  * Update tx bytes for paced transport connection
 328  *
 329  * If tx pacing is enabled, this update pacer bucket to account for the
 330  * amount of bytes that have been sent.
 331  *
 332  * @param tc            transport connection
 333  * @param bytes         bytes recently sent
 334  */
 335 void transport_connection_update_tx_bytes (transport_connection_t * tc,
 336                                            u32 bytes);
 337
 338 void
 339 transport_connection_tx_pacer_update_bytes (transport_connection_t * tc,
 340                                             u32 bytes);
 341
 342 /**
 343  * Request pacer time update
 344  *
 345  * @param thread_index  thread for which time is updated
 346  * @param now           time now
 347  */
 348 void transport_update_pacer_time (u32 thread_index, clib_time_type_t now);
 349
 350 #endif /* SRC_VNET_SESSION_TRANSPORT_H_ */
 351
 352 /*
 353  * fd.io coding-style-patch-verification: ON
 354  *
 355  * Local Variables:
 356  * eval: (c-set-style "gnu")
 357  * End:
 358  */