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