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>
23 * Transport protocol virtual function table
26 typedef struct _transport_proto_vft
31 u32 (*start_listen) (u32 session_index, transport_endpoint_t * lcl);
32 u32 (*stop_listen) (u32 conn_index);
33 int (*connect) (transport_endpoint_cfg_t * rmt);
34 void (*close) (u32 conn_index, u32 thread_index);
35 void (*cleanup) (u32 conn_index, u32 thread_index);
36 clib_error_t *(*enable) (vlib_main_t * vm, u8 is_en);
42 u32 (*push_header) (transport_connection_t * tconn, vlib_buffer_t * b);
43 u16 (*send_mss) (transport_connection_t * tc);
44 u32 (*send_space) (transport_connection_t * tc);
45 u32 (*tx_fifo_offset) (transport_connection_t * tc);
46 void (*update_time) (f64 time_now, u8 thread_index);
47 void (*flush_data) (transport_connection_t *tconn);
48 int (*custom_tx) (void *session);
49 int (*app_rx_evt) (transport_connection_t *tconn);
52 * Connection retrieval
54 transport_connection_t *(*get_connection) (u32 conn_idx, u32 thread_idx);
55 transport_connection_t *(*get_listener) (u32 conn_index);
56 transport_connection_t *(*get_half_open) (u32 conn_index);
61 u8 *(*format_connection) (u8 * s, va_list * args);
62 u8 *(*format_listener) (u8 * s, va_list * args);
63 u8 *(*format_half_open) (u8 * s, va_list * args);
68 transport_tx_fn_type_t tx_type;
69 transport_service_type_t service_type;
70 } transport_proto_vft_t;
73 extern transport_proto_vft_t *tp_vfts;
75 #define transport_proto_foreach(VAR, BODY) \
77 for (VAR = 0; VAR < vec_len (tp_vfts); VAR++) \
78 if (tp_vfts[VAR].push_header != 0) \
79 do { BODY; } while (0); \
82 int transport_connect (transport_proto_t tp, transport_endpoint_cfg_t * tep);
83 void transport_close (transport_proto_t tp, u32 conn_index, u8 thread_index);
84 u32 transport_start_listen (transport_proto_t tp, u32 session_index,
85 transport_endpoint_t * tep);
86 u32 transport_stop_listen (transport_proto_t tp, u32 conn_index);
87 void transport_cleanup (transport_proto_t tp, u32 conn_index,
90 static inline transport_connection_t *
91 transport_get_connection (transport_proto_t tp, u32 conn_index,
94 return tp_vfts[tp].get_connection (conn_index, thread_index);
97 static inline transport_connection_t *
98 transport_get_listener (transport_proto_t tp, u32 conn_index)
100 return tp_vfts[tp].get_listener (conn_index);
103 static inline transport_connection_t *
104 transport_get_half_open (transport_proto_t tp, u32 conn_index)
106 return tp_vfts[tp].get_half_open (conn_index);
110 transport_custom_tx (transport_proto_t tp, void *s)
112 return tp_vfts[tp].custom_tx (s);
116 transport_app_rx_evt (transport_proto_t tp, u32 conn_index, u32 thread_index)
118 transport_connection_t *tc;
119 if (!tp_vfts[tp].app_rx_evt)
121 tc = transport_get_connection (tp, conn_index, thread_index);
122 return tp_vfts[tp].app_rx_evt (tc);
125 void transport_register_protocol (transport_proto_t transport_proto,
126 const transport_proto_vft_t * vft,
127 fib_protocol_t fib_proto, u32 output_node);
128 transport_proto_vft_t *transport_protocol_get_vft (transport_proto_t tp);
129 void transport_update_time (f64 time_now, u8 thread_index);
131 int transport_alloc_local_port (u8 proto, ip46_address_t * ip);
132 int transport_alloc_local_endpoint (u8 proto, transport_endpoint_cfg_t * rmt,
133 ip46_address_t * lcl_addr,
135 void transport_endpoint_cleanup (u8 proto, ip46_address_t * lcl_ip, u16 port);
136 void transport_enable_disable (vlib_main_t * vm, u8 is_en);
137 void transport_init (void);
140 transport_elog_track_index (transport_connection_t * tc)
143 return tc->elog_track.track_index_plus_one - 1;
149 void transport_connection_tx_pacer_reset (transport_connection_t * tc,
150 u32 rate_bytes_per_sec,
151 u32 initial_bucket, u64 time_now);
153 * Initialize tx pacer for connection
155 * @param tc transport connection
156 * @param rate_bytes_per_second initial byte rate
157 * @param burst_bytes initial burst size in bytes
159 void transport_connection_tx_pacer_init (transport_connection_t * tc,
160 u32 rate_bytes_per_sec,
164 * Update tx pacer pacing rate
166 * @param tc transport connection
167 * @param bytes_per_sec new pacing rate
169 void transport_connection_tx_pacer_update (transport_connection_t * tc,
173 * Get maximum tx burst allowed for transport connection
175 * @param tc transport connection
176 * @param time_now current cpu time as returned by @ref clib_cpu_time_now
177 * @param mss transport's mss
179 u32 transport_connection_snd_space (transport_connection_t * tc,
180 u64 time_now, u16 mss);
182 u32 transport_connection_tx_pacer_burst (transport_connection_t * tc,
186 * Initialize period for tx pacers
188 * Defines a unit of time with respect to number of cpu cycles that is to
189 * be used by all tx pacers.
191 void transport_init_tx_pacers_period (void);
194 * Check if transport connection is paced
197 transport_connection_is_tx_paced (transport_connection_t * tc)
199 return (tc->flags & TRANSPORT_CONNECTION_F_IS_TX_PACED);
202 u8 *format_transport_pacer (u8 * s, va_list * args);
205 * Update tx byte stats for transport connection
207 * If tx pacing is enabled, this also updates pacer bucket to account for the
208 * amount of bytes that have been sent.
210 * @param tc transport connection
211 * @param pkts packets recently sent
212 * @param bytes bytes recently sent
214 void transport_connection_update_tx_stats (transport_connection_t * tc,
218 transport_connection_tx_pacer_update_bytes (transport_connection_t * tc,
221 #endif /* SRC_VNET_SESSION_TRANSPORT_H_ */
224 * fd.io coding-style-patch-verification: ON
227 * eval: (c-set-style "gnu")