src/vnet/session/transport_interface.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_INTERFACE_H_
  17 #define SRC_VNET_SESSION_TRANSPORT_INTERFACE_H_
  18
  19 #include <vnet/vnet.h>
  20 #include <vnet/session/transport.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 (*bind) (u32 session_index, transport_endpoint_t * lcl);
  32   u32 (*unbind) (u32);
  33   int (*open) (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 void transport_register_protocol (transport_proto_t transport_proto,
  81                                   const transport_proto_vft_t * vft,
  82                                   fib_protocol_t fib_proto, u32 output_node);
  83 transport_proto_vft_t *transport_protocol_get_vft (transport_proto_t tp);
  84 void transport_update_time (f64 time_now, u8 thread_index);
  85 transport_connection_t *transport_get_connection (transport_proto_t tp,
  86                                                   u32 conn_index,
  87                                                   u8 thread_index);
  88 transport_connection_t *transport_get_listener (transport_proto_t tp,
  89                                                 u32 conn_index);
  90 void transport_enable_disable (vlib_main_t * vm, u8 is_en);
  91
  92 always_inline u32
  93 transport_elog_track_index (transport_connection_t * tc)
  94 {
  95 #if TRANSPORT_DEBUG
  96   return tc->elog_track.track_index_plus_one - 1;
  97 #else
  98   return ~0;
  99 #endif
 100 }
 101
 102 void transport_connection_tx_pacer_reset (transport_connection_t * tc,
 103                                           u32 rate_bytes_per_sec,
 104                                           u32 initial_bucket, u64 time_now);
 105 /**
 106  * Initialize tx pacer for connection
 107  *
 108  * @param tc                            transport connection
 109  * @param rate_bytes_per_second         initial byte rate
 110  * @param burst_bytes                   initial burst size in bytes
 111  */
 112 void transport_connection_tx_pacer_init (transport_connection_t * tc,
 113                                          u32 rate_bytes_per_sec,
 114                                          u32 initial_bucket);
 115
 116 /**
 117  * Update tx pacer pacing rate
 118  *
 119  * @param tc                    transport connection
 120  * @param bytes_per_sec         new pacing rate
 121  */
 122 void transport_connection_tx_pacer_update (transport_connection_t * tc,
 123                                            u64 bytes_per_sec);
 124
 125 /**
 126  * Get maximum tx burst allowed for transport connection
 127  *
 128  * @param tc            transport connection
 129  * @param time_now      current cpu time as returned by @ref clib_cpu_time_now
 130  * @param mss           transport's mss
 131  */
 132 u32 transport_connection_snd_space (transport_connection_t * tc,
 133                                     u64 time_now, u16 mss);
 134
 135 u32 transport_connection_tx_pacer_burst (transport_connection_t * tc,
 136                                          u64 time_now);
 137
 138 /**
 139  * Initialize period for tx pacers
 140  *
 141  * Defines a unit of time with respect to number of cpu cycles that is to
 142  * be used by all tx pacers.
 143  */
 144 void transport_init_tx_pacers_period (void);
 145
 146 /**
 147  * Check if transport connection is paced
 148  */
 149 always_inline u8
 150 transport_connection_is_tx_paced (transport_connection_t * tc)
 151 {
 152   return (tc->flags & TRANSPORT_CONNECTION_F_IS_TX_PACED);
 153 }
 154
 155 u8 *format_transport_pacer (u8 * s, va_list * args);
 156
 157 /**
 158  * Update tx byte stats for transport connection
 159  *
 160  * If tx pacing is enabled, this also updates pacer bucket to account for the
 161  * amount of bytes that have been sent.
 162  *
 163  * @param tc            transport connection
 164  * @param pkts          packets recently sent
 165  * @param bytes         bytes recently sent
 166  */
 167 void transport_connection_update_tx_stats (transport_connection_t * tc,
 168                                            u32 bytes);
 169
 170 void
 171 transport_connection_tx_pacer_update_bytes (transport_connection_t * tc,
 172                                             u32 bytes);
 173
 174 #endif /* SRC_VNET_SESSION_TRANSPORT_INTERFACE_H_ */
 175
 176 /*
 177  * fd.io coding-style-patch-verification: ON
 178  *
 179  * Local Variables:
 180  * eval: (c-set-style "gnu")
 181  * End:
 182  */