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