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