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