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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
16 #ifndef SRC_VNET_SESSION_TRANSPORT_H_
17 #define SRC_VNET_SESSION_TRANSPORT_H_
19 #include <vnet/vnet.h>
20 #include <vnet/session/transport_types.h>
22 #define TRANSPORT_PACER_MIN_MSS 1460
23 #define TRANSPORT_PACER_MIN_BURST TRANSPORT_PACER_MIN_MSS
24 #define TRANSPORT_PACER_MAX_BURST (43 * TRANSPORT_PACER_MIN_MSS)
25 #define TRANSPORT_PACER_MAX_BURST_PKTS 43
26 #define TRANSPORT_PACER_BURSTS_PER_RTT 20
27 #define TRANSPORT_PACER_MIN_IDLE 100
28 #define TRANSPORT_PACER_IDLE_FACTOR 0.05
30 typedef struct _transport_options_t
34 transport_tx_fn_type_t tx_type;
35 transport_service_type_t service_type;
36 } transport_options_t;
38 typedef enum transport_snd_flags_
40 TRANSPORT_SND_F_DESCHED = 1 << 0,
41 TRANSPORT_SND_F_POSTPONE = 1 << 1,
43 } __clib_packed transport_snd_flags_t;
45 typedef struct transport_send_params_
49 /* Used to retrieve snd params from transports */
56 /* Used by custom tx functions */
63 transport_snd_flags_t flags;
64 } transport_send_params_t;
67 * Transport protocol virtual function table
69 typedef struct _transport_proto_vft
74 u32 (*start_listen) (u32 session_index, transport_endpoint_cfg_t *lcl);
75 u32 (*stop_listen) (u32 conn_index);
76 int (*connect) (transport_endpoint_cfg_t * rmt);
77 void (*half_close) (u32 conn_index, u32 thread_index);
78 void (*close) (u32 conn_index, u32 thread_index);
79 void (*reset) (u32 conn_index, u32 thread_index);
80 void (*cleanup) (u32 conn_index, u32 thread_index);
81 void (*cleanup_ho) (u32 conn_index);
82 clib_error_t *(*enable) (vlib_main_t * vm, u8 is_en);
88 u32 (*push_header) (transport_connection_t *tconn, vlib_buffer_t **b,
90 int (*send_params) (transport_connection_t * tconn,
91 transport_send_params_t *sp);
92 void (*update_time) (f64 time_now, u8 thread_index);
93 void (*flush_data) (transport_connection_t *tconn);
94 int (*custom_tx) (void *session, transport_send_params_t *sp);
95 int (*app_rx_evt) (transport_connection_t *tconn);
98 * Connection retrieval
100 transport_connection_t *(*get_connection) (u32 conn_idx, u32 thread_idx);
101 transport_connection_t *(*get_listener) (u32 conn_index);
102 transport_connection_t *(*get_half_open) (u32 conn_index);
107 u8 *(*format_connection) (u8 * s, va_list * args);
108 u8 *(*format_listener) (u8 * s, va_list * args);
109 u8 *(*format_half_open) (u8 * s, va_list * args);
112 * Properties retrieval/setting
114 void (*get_transport_endpoint) (u32 conn_index, u32 thread_index,
115 transport_endpoint_t *tep, u8 is_lcl);
116 void (*get_transport_listener_endpoint) (u32 conn_index,
117 transport_endpoint_t *tep,
119 int (*attribute) (u32 conn_index, u32 thread_index, u8 is_get,
120 transport_endpt_attr_t *attr);
125 transport_options_t transport_options;
126 } transport_proto_vft_t;
128 extern transport_proto_vft_t *tp_vfts;
130 #define transport_proto_foreach(VAR, VAR_ALLOW_BM) \
131 for (VAR = 0; VAR < vec_len (tp_vfts); VAR++) \
132 if (tp_vfts[VAR].push_header != 0) \
133 if (VAR_ALLOW_BM & (1 << VAR))
135 int transport_connect (transport_proto_t tp, transport_endpoint_cfg_t * tep);
136 void transport_half_close (transport_proto_t tp, u32 conn_index,
138 void transport_close (transport_proto_t tp, u32 conn_index, u8 thread_index);
139 void transport_reset (transport_proto_t tp, u32 conn_index, u8 thread_index);
140 u32 transport_start_listen (transport_proto_t tp, u32 session_index,
141 transport_endpoint_cfg_t *tep);
142 u32 transport_stop_listen (transport_proto_t tp, u32 conn_index);
143 void transport_cleanup (transport_proto_t tp, u32 conn_index,
145 void transport_cleanup_half_open (transport_proto_t tp, u32 conn_index);
146 void transport_get_endpoint (transport_proto_t tp, u32 conn_index,
147 u32 thread_index, transport_endpoint_t * tep,
149 void transport_get_listener_endpoint (transport_proto_t tp, u32 conn_index,
150 transport_endpoint_t * tep, u8 is_lcl);
151 int transport_connection_attribute (transport_proto_t tp, u32 conn_index,
152 u8 thread_index, u8 is_get,
153 transport_endpt_attr_t *attr);
155 static inline transport_connection_t *
156 transport_get_connection (transport_proto_t tp, u32 conn_index,
159 return tp_vfts[tp].get_connection (conn_index, thread_index);
162 static inline transport_connection_t *
163 transport_get_listener (transport_proto_t tp, u32 conn_index)
165 return tp_vfts[tp].get_listener (conn_index);
168 static inline transport_connection_t *
169 transport_get_half_open (transport_proto_t tp, u32 conn_index)
171 return tp_vfts[tp].get_half_open (conn_index);
175 transport_custom_tx (transport_proto_t tp, void *s,
176 transport_send_params_t * sp)
178 return tp_vfts[tp].custom_tx (s, sp);
182 transport_app_rx_evt (transport_proto_t tp, u32 conn_index, u32 thread_index)
184 transport_connection_t *tc;
185 if (!tp_vfts[tp].app_rx_evt)
187 tc = transport_get_connection (tp, conn_index, thread_index);
188 return tp_vfts[tp].app_rx_evt (tc);
192 * Get send parameters for transport connection
194 * These include maximum tx burst, mss, tx offset and other flags
195 * transport might want to provide to sessin layer
197 * @param tc transport connection
198 * @param sp send paramaters
202 transport_connection_snd_params (transport_connection_t * tc,
203 transport_send_params_t * sp)
205 return tp_vfts[tc->proto].send_params (tc, sp);
209 transport_connection_is_descheduled (transport_connection_t * tc)
211 return ((tc->flags & TRANSPORT_CONNECTION_F_DESCHED) ? 1 : 0);
215 transport_connection_deschedule (transport_connection_t * tc)
217 tc->flags |= TRANSPORT_CONNECTION_F_DESCHED;
221 transport_connection_is_cless (transport_connection_t * tc)
223 return ((tc->flags & TRANSPORT_CONNECTION_F_CLESS) ? 1 : 0);
226 void transport_connection_reschedule (transport_connection_t * tc);
227 void transport_fifos_init_ooo (transport_connection_t * tc);
230 * Register transport virtual function table.
232 * @param transport_proto - transport protocol type (i.e., TCP, UDP ..)
233 * @param vft - virtual function table for transport proto
234 * @param fib_proto - network layer protocol
235 * @param output_node - output node index that session layer will hand off
236 * buffers to, for requested fib proto
238 void transport_register_protocol (transport_proto_t transport_proto,
239 const transport_proto_vft_t * vft,
240 fib_protocol_t fib_proto, u32 output_node);
242 transport_register_new_protocol (const transport_proto_vft_t * vft,
243 fib_protocol_t fib_proto, u32 output_node);
244 transport_proto_vft_t *transport_protocol_get_vft (transport_proto_t tp);
245 void transport_update_time (clib_time_type_t time_now, u8 thread_index);
247 int transport_alloc_local_port (u8 proto, ip46_address_t *ip,
248 transport_endpoint_cfg_t *rmt);
249 int transport_alloc_local_endpoint (u8 proto, transport_endpoint_cfg_t *rmt,
250 ip46_address_t *lcl_addr, u16 *lcl_port);
251 void transport_share_local_endpoint (u8 proto, ip46_address_t * lcl_ip,
253 int transport_release_local_endpoint (u8 proto, ip46_address_t *lcl_ip,
255 void transport_enable_disable (vlib_main_t * vm, u8 is_en);
256 void transport_init (void);
259 transport_elog_track_index (transport_connection_t * tc)
262 return tc->elog_track.track_index_plus_one - 1;
268 void transport_connection_tx_pacer_reset (transport_connection_t * tc,
269 u64 rate_bytes_per_sec,
273 * Initialize tx pacer for connection
275 * @param tc transport connection
276 * @param rate_bytes_per_second initial byte rate
277 * @param burst_bytes initial burst size in bytes
279 void transport_connection_tx_pacer_init (transport_connection_t * tc,
280 u64 rate_bytes_per_sec,
284 * Update tx pacer pacing rate
286 * @param tc transport connection
287 * @param bytes_per_sec new pacing rate
288 * @param rtt connection rtt that is used to compute
289 * inactivity time after which pacer bucket is
292 void transport_connection_tx_pacer_update (transport_connection_t * tc,
297 * Get tx pacer max burst
299 * @param tc transport connection
300 * @param time_now current cpu time
301 * @return max burst for connection
303 u32 transport_connection_tx_pacer_burst (transport_connection_t * tc);
306 * Get tx pacer current rate
308 * @param tc transport connection
309 * @return rate for connection in bytes/s
311 u64 transport_connection_tx_pacer_rate (transport_connection_t * tc);
314 * Reset tx pacer bucket
316 * @param tc transport connection
317 * @param bucket value the bucket will be reset to
319 void transport_connection_tx_pacer_reset_bucket (transport_connection_t * tc,
323 * Check if transport connection is paced
326 transport_connection_is_tx_paced (transport_connection_t * tc)
328 return (tc->flags & TRANSPORT_CONNECTION_F_IS_TX_PACED);
332 * Clear descheduled flag and update pacer if needed
334 * To add session to scheduler use @ref transport_connection_reschedule
337 transport_connection_clear_descheduled (transport_connection_t *tc)
339 tc->flags &= ~TRANSPORT_CONNECTION_F_DESCHED;
340 if (transport_connection_is_tx_paced (tc))
341 transport_connection_tx_pacer_reset_bucket (tc, 0 /* bucket */);
344 u8 *format_transport_pacer (u8 * s, va_list * args);
347 * Update tx bytes for paced transport connection
349 * If tx pacing is enabled, this update pacer bucket to account for the
350 * amount of bytes that have been sent.
352 * @param tc transport connection
353 * @param bytes bytes recently sent
355 void transport_connection_update_tx_bytes (transport_connection_t * tc,
359 transport_connection_tx_pacer_update_bytes (transport_connection_t * tc,
363 * Request pacer time update
365 * @param thread_index thread for which time is updated
366 * @param now time now
368 void transport_update_pacer_time (u32 thread_index, clib_time_type_t now);
370 #endif /* SRC_VNET_SESSION_TRANSPORT_H_ */
373 * fd.io coding-style-patch-verification: ON
376 * eval: (c-set-style "gnu")