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