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)
26 typedef struct _transport_options_t
28 transport_tx_fn_type_t tx_type;
29 transport_service_type_t service_type;
30 u8 half_open_has_fifos;
31 } transport_options_t;
34 * Transport protocol virtual function table
37 typedef struct _transport_proto_vft
42 u32 (*start_listen) (u32 session_index, transport_endpoint_t * lcl);
43 u32 (*stop_listen) (u32 conn_index);
44 int (*connect) (transport_endpoint_cfg_t * rmt);
45 void (*close) (u32 conn_index, u32 thread_index);
46 void (*reset) (u32 conn_index, u32 thread_index);
47 void (*cleanup) (u32 conn_index, u32 thread_index);
48 clib_error_t *(*enable) (vlib_main_t * vm, u8 is_en);
54 u32 (*push_header) (transport_connection_t * tconn, vlib_buffer_t * b);
55 u16 (*send_mss) (transport_connection_t * tc);
56 u32 (*send_space) (transport_connection_t * tc);
57 u32 (*tx_fifo_offset) (transport_connection_t * tc);
58 void (*update_time) (f64 time_now, u8 thread_index);
59 void (*flush_data) (transport_connection_t *tconn);
60 int (*custom_tx) (void *session, u32 max_burst_size);
61 int (*app_rx_evt) (transport_connection_t *tconn);
64 * Connection retrieval
66 transport_connection_t *(*get_connection) (u32 conn_idx, u32 thread_idx);
67 transport_connection_t *(*get_listener) (u32 conn_index);
68 transport_connection_t *(*get_half_open) (u32 conn_index);
73 u8 *(*format_connection) (u8 * s, va_list * args);
74 u8 *(*format_listener) (u8 * s, va_list * args);
75 u8 *(*format_half_open) (u8 * s, va_list * args);
78 * Properties retrieval
80 void (*get_transport_endpoint) (u32 conn_index, u32 thread_index,
81 transport_endpoint_t *tep, u8 is_lcl);
82 void (*get_transport_listener_endpoint) (u32 conn_index,
83 transport_endpoint_t *tep,
89 transport_options_t transport_options;
90 } transport_proto_vft_t;
93 extern transport_proto_vft_t *tp_vfts;
95 #define transport_proto_foreach(VAR, BODY) \
97 for (VAR = 0; VAR < vec_len (tp_vfts); VAR++) \
98 if (tp_vfts[VAR].push_header != 0) \
99 do { BODY; } while (0); \
102 int transport_connect (transport_proto_t tp, transport_endpoint_cfg_t * tep);
103 void transport_close (transport_proto_t tp, u32 conn_index, u8 thread_index);
104 void transport_reset (transport_proto_t tp, u32 conn_index, u8 thread_index);
105 u32 transport_start_listen (transport_proto_t tp, u32 session_index,
106 transport_endpoint_t * tep);
107 u32 transport_stop_listen (transport_proto_t tp, u32 conn_index);
108 void transport_cleanup (transport_proto_t tp, u32 conn_index,
110 void transport_get_endpoint (transport_proto_t tp, u32 conn_index,
111 u32 thread_index, transport_endpoint_t * tep,
113 void transport_get_listener_endpoint (transport_proto_t tp, u32 conn_index,
114 transport_endpoint_t * tep, u8 is_lcl);
116 static inline transport_connection_t *
117 transport_get_connection (transport_proto_t tp, u32 conn_index,
120 return tp_vfts[tp].get_connection (conn_index, thread_index);
123 static inline transport_connection_t *
124 transport_get_listener (transport_proto_t tp, u32 conn_index)
126 return tp_vfts[tp].get_listener (conn_index);
129 static inline transport_connection_t *
130 transport_get_half_open (transport_proto_t tp, u32 conn_index)
132 return tp_vfts[tp].get_half_open (conn_index);
136 transport_custom_tx (transport_proto_t tp, void *s, u32 max_burst_size)
138 return tp_vfts[tp].custom_tx (s, max_burst_size);
142 transport_app_rx_evt (transport_proto_t tp, u32 conn_index, u32 thread_index)
144 transport_connection_t *tc;
145 if (!tp_vfts[tp].app_rx_evt)
147 tc = transport_get_connection (tp, conn_index, thread_index);
148 return tp_vfts[tp].app_rx_evt (tc);
151 void transport_register_protocol (transport_proto_t transport_proto,
152 const transport_proto_vft_t * vft,
153 fib_protocol_t fib_proto, u32 output_node);
154 transport_proto_vft_t *transport_protocol_get_vft (transport_proto_t tp);
155 void transport_update_time (clib_time_type_t time_now, u8 thread_index);
157 int transport_alloc_local_port (u8 proto, ip46_address_t * ip);
158 int transport_alloc_local_endpoint (u8 proto, transport_endpoint_cfg_t * rmt,
159 ip46_address_t * lcl_addr,
161 void transport_endpoint_cleanup (u8 proto, ip46_address_t * lcl_ip, u16 port);
162 void transport_enable_disable (vlib_main_t * vm, u8 is_en);
163 void transport_init (void);
166 transport_elog_track_index (transport_connection_t * tc)
169 return tc->elog_track.track_index_plus_one - 1;
175 void transport_connection_tx_pacer_reset (transport_connection_t * tc,
176 u64 rate_bytes_per_sec,
179 * Initialize tx pacer for connection
181 * @param tc transport connection
182 * @param rate_bytes_per_second initial byte rate
183 * @param burst_bytes initial burst size in bytes
185 void transport_connection_tx_pacer_init (transport_connection_t * tc,
186 u64 rate_bytes_per_sec,
190 * Update tx pacer pacing rate
192 * @param tc transport connection
193 * @param bytes_per_sec new pacing rate
195 void transport_connection_tx_pacer_update (transport_connection_t * tc,
199 * Get maximum tx burst allowed for transport connection
201 * @param tc transport connection
202 * @param time_now current cpu time as returned by @ref clib_cpu_time_now
203 * @param mss transport's mss
205 u32 transport_connection_snd_space (transport_connection_t * tc, u16 mss);
208 * Get tx pacer max burst
210 * @param tc transport connection
211 * @param time_now current cpu time
212 * @return max burst for connection
214 u32 transport_connection_tx_pacer_burst (transport_connection_t * tc);
217 * Get tx pacer current rate
219 * @param tc transport connection
220 * @return rate for connection in bytes/s
222 u64 transport_connection_tx_pacer_rate (transport_connection_t * tc);
225 * Reset tx pacer bucket
227 * @param tc transport connection
228 * @param time_now current cpu time
230 void transport_connection_tx_pacer_reset_bucket (transport_connection_t * tc);
233 * Check if transport connection is paced
236 transport_connection_is_tx_paced (transport_connection_t * tc)
238 return (tc->flags & TRANSPORT_CONNECTION_F_IS_TX_PACED);
241 u8 *format_transport_pacer (u8 * s, va_list * args);
244 * Update tx bytes for paced transport connection
246 * If tx pacing is enabled, this update pacer bucket to account for the
247 * amount of bytes that have been sent.
249 * @param tc transport connection
250 * @param bytes bytes recently sent
252 void transport_connection_update_tx_bytes (transport_connection_t * tc,
256 transport_connection_tx_pacer_update_bytes (transport_connection_t * tc,
259 #endif /* SRC_VNET_SESSION_TRANSPORT_H_ */
262 * fd.io coding-style-patch-verification: ON
265 * eval: (c-set-style "gnu")