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