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
30 transport_tx_fn_type_t tx_type;
31 transport_service_type_t service_type;
32 u8 half_open_has_fifos;
33 } transport_options_t;
36 * Transport protocol virtual function table
39 typedef struct _transport_proto_vft
44 u32 (*start_listen) (u32 session_index, transport_endpoint_t * lcl);
45 u32 (*stop_listen) (u32 conn_index);
46 int (*connect) (transport_endpoint_cfg_t * rmt);
47 void (*close) (u32 conn_index, u32 thread_index);
48 void (*reset) (u32 conn_index, u32 thread_index);
49 void (*cleanup) (u32 conn_index, u32 thread_index);
50 clib_error_t *(*enable) (vlib_main_t * vm, u8 is_en);
56 u32 (*push_header) (transport_connection_t * tconn, vlib_buffer_t * b);
57 u16 (*send_mss) (transport_connection_t * tc);
58 u32 (*send_space) (transport_connection_t * tc);
59 u32 (*tx_fifo_offset) (transport_connection_t * tc);
60 void (*update_time) (f64 time_now, u8 thread_index);
61 void (*flush_data) (transport_connection_t *tconn);
62 int (*custom_tx) (void *session, u32 max_burst_size);
63 int (*app_rx_evt) (transport_connection_t *tconn);
66 * Connection retrieval
68 transport_connection_t *(*get_connection) (u32 conn_idx, u32 thread_idx);
69 transport_connection_t *(*get_listener) (u32 conn_index);
70 transport_connection_t *(*get_half_open) (u32 conn_index);
75 u8 *(*format_connection) (u8 * s, va_list * args);
76 u8 *(*format_listener) (u8 * s, va_list * args);
77 u8 *(*format_half_open) (u8 * s, va_list * args);
80 * Properties retrieval
82 void (*get_transport_endpoint) (u32 conn_index, u32 thread_index,
83 transport_endpoint_t *tep, u8 is_lcl);
84 void (*get_transport_listener_endpoint) (u32 conn_index,
85 transport_endpoint_t *tep,
91 transport_options_t transport_options;
92 } transport_proto_vft_t;
95 extern transport_proto_vft_t *tp_vfts;
97 #define transport_proto_foreach(VAR, BODY) \
99 for (VAR = 0; VAR < vec_len (tp_vfts); VAR++) \
100 if (tp_vfts[VAR].push_header != 0) \
101 do { BODY; } while (0); \
104 int transport_connect (transport_proto_t tp, transport_endpoint_cfg_t * tep);
105 void transport_close (transport_proto_t tp, u32 conn_index, u8 thread_index);
106 void transport_reset (transport_proto_t tp, u32 conn_index, u8 thread_index);
107 u32 transport_start_listen (transport_proto_t tp, u32 session_index,
108 transport_endpoint_t * tep);
109 u32 transport_stop_listen (transport_proto_t tp, u32 conn_index);
110 void transport_cleanup (transport_proto_t tp, u32 conn_index,
112 void transport_get_endpoint (transport_proto_t tp, u32 conn_index,
113 u32 thread_index, transport_endpoint_t * tep,
115 void transport_get_listener_endpoint (transport_proto_t tp, u32 conn_index,
116 transport_endpoint_t * tep, u8 is_lcl);
118 static inline transport_connection_t *
119 transport_get_connection (transport_proto_t tp, u32 conn_index,
122 return tp_vfts[tp].get_connection (conn_index, thread_index);
125 static inline transport_connection_t *
126 transport_get_listener (transport_proto_t tp, u32 conn_index)
128 return tp_vfts[tp].get_listener (conn_index);
131 static inline transport_connection_t *
132 transport_get_half_open (transport_proto_t tp, u32 conn_index)
134 return tp_vfts[tp].get_half_open (conn_index);
138 transport_custom_tx (transport_proto_t tp, void *s, u32 max_burst_size)
140 return tp_vfts[tp].custom_tx (s, max_burst_size);
144 transport_app_rx_evt (transport_proto_t tp, u32 conn_index, u32 thread_index)
146 transport_connection_t *tc;
147 if (!tp_vfts[tp].app_rx_evt)
149 tc = transport_get_connection (tp, conn_index, thread_index);
150 return tp_vfts[tp].app_rx_evt (tc);
154 * Get maximum tx burst allowed for transport connection
156 * @param tc transport connection
159 transport_connection_snd_space (transport_connection_t * tc)
161 return tp_vfts[tc->proto].send_space (tc);
164 void transport_register_protocol (transport_proto_t transport_proto,
165 const transport_proto_vft_t * vft,
166 fib_protocol_t fib_proto, u32 output_node);
167 transport_proto_vft_t *transport_protocol_get_vft (transport_proto_t tp);
168 void transport_update_time (clib_time_type_t time_now, u8 thread_index);
170 int transport_alloc_local_port (u8 proto, ip46_address_t * ip);
171 int transport_alloc_local_endpoint (u8 proto, transport_endpoint_cfg_t * rmt,
172 ip46_address_t * lcl_addr,
174 void transport_endpoint_cleanup (u8 proto, ip46_address_t * lcl_ip, u16 port);
175 void transport_enable_disable (vlib_main_t * vm, u8 is_en);
176 void transport_init (void);
179 transport_elog_track_index (transport_connection_t * tc)
182 return tc->elog_track.track_index_plus_one - 1;
188 void transport_connection_tx_pacer_reset (transport_connection_t * tc,
189 u64 rate_bytes_per_sec,
193 * Initialize tx pacer for connection
195 * @param tc transport connection
196 * @param rate_bytes_per_second initial byte rate
197 * @param burst_bytes initial burst size in bytes
199 void transport_connection_tx_pacer_init (transport_connection_t * tc,
200 u64 rate_bytes_per_sec,
204 * Update tx pacer pacing rate
206 * @param tc transport connection
207 * @param bytes_per_sec new pacing rate
208 * @param rtt connection rtt that is used to compute
209 * inactivity time after which pacer bucket is
212 void transport_connection_tx_pacer_update (transport_connection_t * tc,
217 * Get tx pacer max burst
219 * @param tc transport connection
220 * @param time_now current cpu time
221 * @return max burst for connection
223 u32 transport_connection_tx_pacer_burst (transport_connection_t * tc);
226 * Get tx pacer current rate
228 * @param tc transport connection
229 * @return rate for connection in bytes/s
231 u64 transport_connection_tx_pacer_rate (transport_connection_t * tc);
234 * Reset tx pacer bucket
236 * @param tc transport connection
237 * @param bucket value the bucket will be reset to
239 void transport_connection_tx_pacer_reset_bucket (transport_connection_t * tc,
243 * Check if transport connection is paced
246 transport_connection_is_tx_paced (transport_connection_t * tc)
248 return (tc->flags & TRANSPORT_CONNECTION_F_IS_TX_PACED);
251 u8 *format_transport_pacer (u8 * s, va_list * args);
254 * Update tx bytes for paced transport connection
256 * If tx pacing is enabled, this update pacer bucket to account for the
257 * amount of bytes that have been sent.
259 * @param tc transport connection
260 * @param bytes bytes recently sent
262 void transport_connection_update_tx_bytes (transport_connection_t * tc,
266 transport_connection_tx_pacer_update_bytes (transport_connection_t * tc,
269 #endif /* SRC_VNET_SESSION_TRANSPORT_H_ */
272 * fd.io coding-style-patch-verification: ON
275 * eval: (c-set-style "gnu")