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