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