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_MIN_IDLE 100
27 #define TRANSPORT_PACER_IDLE_FACTOR 0.05
29 typedef struct _transport_options_t
33 transport_tx_fn_type_t tx_type;
34 transport_service_type_t service_type;
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_
48 /* Used to retrieve snd params from transports */
55 /* Used by custom tx functions */
61 transport_snd_flags_t flags;
62 } transport_send_params_t;
65 * Transport protocol virtual function table
68 typedef struct _transport_proto_vft
73 u32 (*start_listen) (u32 session_index, transport_endpoint_t * lcl);
74 u32 (*stop_listen) (u32 conn_index);
75 int (*connect) (transport_endpoint_cfg_t * rmt);
76 void (*close) (u32 conn_index, u32 thread_index);
77 void (*reset) (u32 conn_index, u32 thread_index);
78 void (*cleanup) (u32 conn_index, u32 thread_index);
79 void (*cleanup_ho) (u32 conn_index);
80 clib_error_t *(*enable) (vlib_main_t * vm, u8 is_en);
86 u32 (*push_header) (transport_connection_t * tconn, vlib_buffer_t * b);
87 int (*send_params) (transport_connection_t * tconn,
88 transport_send_params_t *sp);
89 void (*update_time) (f64 time_now, u8 thread_index);
90 void (*flush_data) (transport_connection_t *tconn);
91 int (*custom_tx) (void *session, transport_send_params_t *sp);
92 int (*app_rx_evt) (transport_connection_t *tconn);
95 * Connection retrieval
97 transport_connection_t *(*get_connection) (u32 conn_idx, u32 thread_idx);
98 transport_connection_t *(*get_listener) (u32 conn_index);
99 transport_connection_t *(*get_half_open) (u32 conn_index);
104 u8 *(*format_connection) (u8 * s, va_list * args);
105 u8 *(*format_listener) (u8 * s, va_list * args);
106 u8 *(*format_half_open) (u8 * s, va_list * args);
109 * Properties retrieval
111 void (*get_transport_endpoint) (u32 conn_index, u32 thread_index,
112 transport_endpoint_t *tep, u8 is_lcl);
113 void (*get_transport_listener_endpoint) (u32 conn_index,
114 transport_endpoint_t *tep,
120 transport_options_t transport_options;
121 } transport_proto_vft_t;
124 extern transport_proto_vft_t *tp_vfts;
126 #define transport_proto_foreach(VAR, BODY) \
128 for (VAR = 0; VAR < vec_len (tp_vfts); VAR++) \
129 if (tp_vfts[VAR].push_header != 0) \
130 do { BODY; } while (0); \
133 int transport_connect (transport_proto_t tp, transport_endpoint_cfg_t * tep);
134 void transport_close (transport_proto_t tp, u32 conn_index, u8 thread_index);
135 void transport_reset (transport_proto_t tp, u32 conn_index, u8 thread_index);
136 u32 transport_start_listen (transport_proto_t tp, u32 session_index,
137 transport_endpoint_t * tep);
138 u32 transport_stop_listen (transport_proto_t tp, u32 conn_index);
139 void transport_cleanup (transport_proto_t tp, u32 conn_index,
141 void transport_cleanup_half_open (transport_proto_t tp, u32 conn_index);
142 void transport_get_endpoint (transport_proto_t tp, u32 conn_index,
143 u32 thread_index, transport_endpoint_t * tep,
145 void transport_get_listener_endpoint (transport_proto_t tp, u32 conn_index,
146 transport_endpoint_t * tep, u8 is_lcl);
148 static inline transport_connection_t *
149 transport_get_connection (transport_proto_t tp, u32 conn_index,
152 return tp_vfts[tp].get_connection (conn_index, thread_index);
155 static inline transport_connection_t *
156 transport_get_listener (transport_proto_t tp, u32 conn_index)
158 return tp_vfts[tp].get_listener (conn_index);
161 static inline transport_connection_t *
162 transport_get_half_open (transport_proto_t tp, u32 conn_index)
164 return tp_vfts[tp].get_half_open (conn_index);
168 transport_custom_tx (transport_proto_t tp, void *s,
169 transport_send_params_t * sp)
171 return tp_vfts[tp].custom_tx (s, sp);
175 transport_app_rx_evt (transport_proto_t tp, u32 conn_index, u32 thread_index)
177 transport_connection_t *tc;
178 if (!tp_vfts[tp].app_rx_evt)
180 tc = transport_get_connection (tp, conn_index, thread_index);
181 return tp_vfts[tp].app_rx_evt (tc);
185 * Get send parameters for transport connection
187 * These include maximum tx burst, mss, tx offset and other flags
188 * transport might want to provide to sessin layer
190 * @param tc transport connection
191 * @param sp send paramaters
195 transport_connection_snd_params (transport_connection_t * tc,
196 transport_send_params_t * sp)
198 return tp_vfts[tc->proto].send_params (tc, sp);
202 transport_connection_is_descheduled (transport_connection_t * tc)
204 return ((tc->flags & TRANSPORT_CONNECTION_F_DESCHED) ? 1 : 0);
208 transport_connection_deschedule (transport_connection_t * tc)
210 tc->flags |= TRANSPORT_CONNECTION_F_DESCHED;
214 transport_connection_is_cless (transport_connection_t * tc)
216 return ((tc->flags & TRANSPORT_CONNECTION_F_CLESS) ? 1 : 0);
219 void transport_connection_reschedule (transport_connection_t * tc);
222 * Register transport virtual function table.
224 * @param transport_proto - transport protocol type (i.e., TCP, UDP ..)
225 * @param vft - virtual function table for transport proto
226 * @param fib_proto - network layer protocol
227 * @param output_node - output node index that session layer will hand off
228 * buffers to, for requested fib proto
230 void transport_register_protocol (transport_proto_t transport_proto,
231 const transport_proto_vft_t * vft,
232 fib_protocol_t fib_proto, u32 output_node);
234 transport_register_new_protocol (const transport_proto_vft_t * vft,
235 fib_protocol_t fib_proto, u32 output_node);
236 transport_proto_vft_t *transport_protocol_get_vft (transport_proto_t tp);
237 void transport_update_time (clib_time_type_t time_now, u8 thread_index);
239 int transport_alloc_local_port (u8 proto, ip46_address_t * ip);
240 int transport_alloc_local_endpoint (u8 proto, transport_endpoint_cfg_t * rmt,
241 ip46_address_t * lcl_addr,
243 void transport_share_local_endpoint (u8 proto, ip46_address_t * lcl_ip,
245 void transport_endpoint_cleanup (u8 proto, ip46_address_t * lcl_ip, u16 port);
246 void transport_enable_disable (vlib_main_t * vm, u8 is_en);
247 void transport_init (void);
250 transport_elog_track_index (transport_connection_t * tc)
253 return tc->elog_track.track_index_plus_one - 1;
259 void transport_connection_tx_pacer_reset (transport_connection_t * tc,
260 u64 rate_bytes_per_sec,
264 * Initialize tx pacer for connection
266 * @param tc transport connection
267 * @param rate_bytes_per_second initial byte rate
268 * @param burst_bytes initial burst size in bytes
270 void transport_connection_tx_pacer_init (transport_connection_t * tc,
271 u64 rate_bytes_per_sec,
275 * Update tx pacer pacing rate
277 * @param tc transport connection
278 * @param bytes_per_sec new pacing rate
279 * @param rtt connection rtt that is used to compute
280 * inactivity time after which pacer bucket is
283 void transport_connection_tx_pacer_update (transport_connection_t * tc,
288 * Get tx pacer max burst
290 * @param tc transport connection
291 * @param time_now current cpu time
292 * @return max burst for connection
294 u32 transport_connection_tx_pacer_burst (transport_connection_t * tc);
297 * Get tx pacer current rate
299 * @param tc transport connection
300 * @return rate for connection in bytes/s
302 u64 transport_connection_tx_pacer_rate (transport_connection_t * tc);
305 * Reset tx pacer bucket
307 * @param tc transport connection
308 * @param bucket value the bucket will be reset to
310 void transport_connection_tx_pacer_reset_bucket (transport_connection_t * tc,
314 * Check if transport connection is paced
317 transport_connection_is_tx_paced (transport_connection_t * tc)
319 return (tc->flags & TRANSPORT_CONNECTION_F_IS_TX_PACED);
322 u8 *format_transport_pacer (u8 * s, va_list * args);
325 * Update tx bytes for paced transport connection
327 * If tx pacing is enabled, this update pacer bucket to account for the
328 * amount of bytes that have been sent.
330 * @param tc transport connection
331 * @param bytes bytes recently sent
333 void transport_connection_update_tx_bytes (transport_connection_t * tc,
337 transport_connection_tx_pacer_update_bytes (transport_connection_t * tc,
340 #endif /* SRC_VNET_SESSION_TRANSPORT_H_ */
343 * fd.io coding-style-patch-verification: ON
346 * eval: (c-set-style "gnu")