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_MIN_IDLE 100
26 #define TRANSPORT_PACER_IDLE_FACTOR 0.05
28 typedef struct _transport_options_t
32 transport_tx_fn_type_t tx_type;
33 transport_service_type_t service_type;
34 u8 half_open_has_fifos;
35 } transport_options_t;
37 typedef enum transport_snd_flags_
39 TRANSPORT_SND_F_DESCHED = 1 << 0,
40 TRANSPORT_SND_F_POSTPONE = 1 << 1,
42 } __clib_packed transport_snd_flags_t;
44 typedef struct transport_send_params_
49 transport_snd_flags_t flags;
50 } transport_send_params_t;
53 * Transport protocol virtual function table
56 typedef struct _transport_proto_vft
61 u32 (*start_listen) (u32 session_index, transport_endpoint_t * lcl);
62 u32 (*stop_listen) (u32 conn_index);
63 int (*connect) (transport_endpoint_cfg_t * rmt);
64 void (*close) (u32 conn_index, u32 thread_index);
65 void (*reset) (u32 conn_index, u32 thread_index);
66 void (*cleanup) (u32 conn_index, u32 thread_index);
67 clib_error_t *(*enable) (vlib_main_t * vm, u8 is_en);
73 u32 (*push_header) (transport_connection_t * tconn, vlib_buffer_t * b);
74 int (*send_params) (transport_connection_t * tconn,
75 transport_send_params_t *sp);
76 void (*update_time) (f64 time_now, u8 thread_index);
77 void (*flush_data) (transport_connection_t *tconn);
78 int (*custom_tx) (void *session, u32 max_burst_size);
79 int (*app_rx_evt) (transport_connection_t *tconn);
82 * Connection retrieval
84 transport_connection_t *(*get_connection) (u32 conn_idx, u32 thread_idx);
85 transport_connection_t *(*get_listener) (u32 conn_index);
86 transport_connection_t *(*get_half_open) (u32 conn_index);
91 u8 *(*format_connection) (u8 * s, va_list * args);
92 u8 *(*format_listener) (u8 * s, va_list * args);
93 u8 *(*format_half_open) (u8 * s, va_list * args);
96 * Properties retrieval
98 void (*get_transport_endpoint) (u32 conn_index, u32 thread_index,
99 transport_endpoint_t *tep, u8 is_lcl);
100 void (*get_transport_listener_endpoint) (u32 conn_index,
101 transport_endpoint_t *tep,
107 transport_options_t transport_options;
108 } transport_proto_vft_t;
111 extern transport_proto_vft_t *tp_vfts;
113 #define transport_proto_foreach(VAR, BODY) \
115 for (VAR = 0; VAR < vec_len (tp_vfts); VAR++) \
116 if (tp_vfts[VAR].push_header != 0) \
117 do { BODY; } while (0); \
120 int transport_connect (transport_proto_t tp, transport_endpoint_cfg_t * tep);
121 void transport_close (transport_proto_t tp, u32 conn_index, u8 thread_index);
122 void transport_reset (transport_proto_t tp, u32 conn_index, u8 thread_index);
123 u32 transport_start_listen (transport_proto_t tp, u32 session_index,
124 transport_endpoint_t * tep);
125 u32 transport_stop_listen (transport_proto_t tp, u32 conn_index);
126 void transport_cleanup (transport_proto_t tp, u32 conn_index,
128 void transport_get_endpoint (transport_proto_t tp, u32 conn_index,
129 u32 thread_index, transport_endpoint_t * tep,
131 void transport_get_listener_endpoint (transport_proto_t tp, u32 conn_index,
132 transport_endpoint_t * tep, u8 is_lcl);
134 static inline transport_connection_t *
135 transport_get_connection (transport_proto_t tp, u32 conn_index,
138 return tp_vfts[tp].get_connection (conn_index, thread_index);
141 static inline transport_connection_t *
142 transport_get_listener (transport_proto_t tp, u32 conn_index)
144 return tp_vfts[tp].get_listener (conn_index);
147 static inline transport_connection_t *
148 transport_get_half_open (transport_proto_t tp, u32 conn_index)
150 return tp_vfts[tp].get_half_open (conn_index);
154 transport_custom_tx (transport_proto_t tp, void *s, u32 max_burst_size)
156 return tp_vfts[tp].custom_tx (s, max_burst_size);
160 transport_app_rx_evt (transport_proto_t tp, u32 conn_index, u32 thread_index)
162 transport_connection_t *tc;
163 if (!tp_vfts[tp].app_rx_evt)
165 tc = transport_get_connection (tp, conn_index, thread_index);
166 return tp_vfts[tp].app_rx_evt (tc);
170 * Get send parameters for transport connection
172 * These include maximum tx burst, mss, tx offset and other flags
173 * transport might want to provide to sessin layer
175 * @param tc transport connection
176 * @param sp send paramaters
180 transport_connection_snd_params (transport_connection_t * tc,
181 transport_send_params_t * sp)
183 return tp_vfts[tc->proto].send_params (tc, sp);
187 transport_connection_is_descheduled (transport_connection_t * tc)
189 return ((tc->flags & TRANSPORT_CONNECTION_F_DESCHED) ? 1 : 0);
193 transport_connection_deschedule (transport_connection_t * tc)
195 tc->flags |= TRANSPORT_CONNECTION_F_DESCHED;
199 transport_connection_is_cless (transport_connection_t * tc)
201 return ((tc->flags & TRANSPORT_CONNECTION_F_CLESS) ? 1 : 0);
204 void transport_connection_reschedule (transport_connection_t * tc);
207 * Register transport virtual function table.
209 * @param transport_proto - transport protocol type (i.e., TCP, UDP ..)
210 * @param vft - virtual function table for transport proto
211 * @param fib_proto - network layer protocol
212 * @param output_node - output node index that session layer will hand off
213 * buffers to, for requested fib proto
215 void transport_register_protocol (transport_proto_t transport_proto,
216 const transport_proto_vft_t * vft,
217 fib_protocol_t fib_proto, u32 output_node);
219 transport_register_new_protocol (const transport_proto_vft_t * vft,
220 fib_protocol_t fib_proto, u32 output_node);
221 transport_proto_vft_t *transport_protocol_get_vft (transport_proto_t tp);
222 void transport_update_time (clib_time_type_t time_now, u8 thread_index);
224 int transport_alloc_local_port (u8 proto, ip46_address_t * ip);
225 int transport_alloc_local_endpoint (u8 proto, transport_endpoint_cfg_t * rmt,
226 ip46_address_t * lcl_addr,
228 void transport_endpoint_cleanup (u8 proto, ip46_address_t * lcl_ip, u16 port);
229 void transport_enable_disable (vlib_main_t * vm, u8 is_en);
230 void transport_init (void);
233 transport_elog_track_index (transport_connection_t * tc)
236 return tc->elog_track.track_index_plus_one - 1;
242 void transport_connection_tx_pacer_reset (transport_connection_t * tc,
243 u64 rate_bytes_per_sec,
247 * Initialize tx pacer for connection
249 * @param tc transport connection
250 * @param rate_bytes_per_second initial byte rate
251 * @param burst_bytes initial burst size in bytes
253 void transport_connection_tx_pacer_init (transport_connection_t * tc,
254 u64 rate_bytes_per_sec,
258 * Update tx pacer pacing rate
260 * @param tc transport connection
261 * @param bytes_per_sec new pacing rate
262 * @param rtt connection rtt that is used to compute
263 * inactivity time after which pacer bucket is
266 void transport_connection_tx_pacer_update (transport_connection_t * tc,
271 * Get tx pacer max burst
273 * @param tc transport connection
274 * @param time_now current cpu time
275 * @return max burst for connection
277 u32 transport_connection_tx_pacer_burst (transport_connection_t * tc);
280 * Get tx pacer current rate
282 * @param tc transport connection
283 * @return rate for connection in bytes/s
285 u64 transport_connection_tx_pacer_rate (transport_connection_t * tc);
288 * Reset tx pacer bucket
290 * @param tc transport connection
291 * @param bucket value the bucket will be reset to
293 void transport_connection_tx_pacer_reset_bucket (transport_connection_t * tc,
297 * Check if transport connection is paced
300 transport_connection_is_tx_paced (transport_connection_t * tc)
302 return (tc->flags & TRANSPORT_CONNECTION_F_IS_TX_PACED);
305 u8 *format_transport_pacer (u8 * s, va_list * args);
308 * Update tx bytes for paced transport connection
310 * If tx pacing is enabled, this update pacer bucket to account for the
311 * amount of bytes that have been sent.
313 * @param tc transport connection
314 * @param bytes bytes recently sent
316 void transport_connection_update_tx_bytes (transport_connection_t * tc,
320 transport_connection_tx_pacer_update_bytes (transport_connection_t * tc,
323 #endif /* SRC_VNET_SESSION_TRANSPORT_H_ */
326 * fd.io coding-style-patch-verification: ON
329 * eval: (c-set-style "gnu")