FD.io VPP  v20.09-64-g4f7b92f0a
Vector Packet Processing
transport.h
Go to the documentation of this file.
1 /*
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:
6  *
7  * http://www.apache.org/licenses/LICENSE-2.0
8  *
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.
14  */
15 
16 #ifndef SRC_VNET_SESSION_TRANSPORT_H_
17 #define SRC_VNET_SESSION_TRANSPORT_H_
18 
19 #include <vnet/vnet.h>
21 
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
28 
29 typedef struct _transport_options_t
30 {
31  char *name;
32  char *short_name;
33  transport_tx_fn_type_t tx_type;
34  transport_service_type_t service_type;
36 
38 {
42 } __clib_packed transport_snd_flags_t;
43 
44 typedef struct transport_send_params_
45 {
46  union
47  {
48  /* Used to retrieve snd params from transports */
49  struct
50  {
54  };
55  /* Used by custom tx functions */
56  struct
57  {
59  };
60  };
63 
64 /*
65  * Transport protocol virtual function table
66  */
67 /* *INDENT-OFF* */
68 typedef struct _transport_proto_vft
69 {
70  /*
71  * Setup
72  */
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);
81 
82  /*
83  * Transmission
84  */
85 
86  u32 (*push_header) (transport_connection_t * tconn, vlib_buffer_t * b);
87  int (*send_params) (transport_connection_t * tconn,
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);
93 
94  /*
95  * Connection retrieval
96  */
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);
100 
101  /*
102  * Format
103  */
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);
107 
108  /*
109  * Properties retrieval
110  */
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,
115  u8 is_lcl);
116 
117  /*
118  * Properties
119  */
120  transport_options_t transport_options;
122 /* *INDENT-ON* */
123 
125 
126 #define transport_proto_foreach(VAR, BODY) \
127 do { \
128  for (VAR = 0; VAR < vec_len (tp_vfts); VAR++) \
129  if (tp_vfts[VAR].push_header != 0) \
130  do { BODY; } while (0); \
131 } while (0)
132 
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);
137  transport_endpoint_t * tep);
139 void transport_cleanup (transport_proto_t tp, u32 conn_index,
140  u8 thread_index);
142 void transport_get_endpoint (transport_proto_t tp, u32 conn_index,
143  u32 thread_index, transport_endpoint_t * tep,
144  u8 is_lcl);
146  transport_endpoint_t * tep, u8 is_lcl);
147 
148 static inline transport_connection_t *
150  u8 thread_index)
151 {
152  return tp_vfts[tp].get_connection (conn_index, thread_index);
153 }
154 
155 static inline transport_connection_t *
157 {
158  return tp_vfts[tp].get_listener (conn_index);
159 }
160 
161 static inline transport_connection_t *
163 {
164  return tp_vfts[tp].get_half_open (conn_index);
165 }
166 
167 static inline int
170 {
171  return tp_vfts[tp].custom_tx (s, sp);
172 }
173 
174 static inline int
175 transport_app_rx_evt (transport_proto_t tp, u32 conn_index, u32 thread_index)
176 {
178  if (!tp_vfts[tp].app_rx_evt)
179  return 0;
180  tc = transport_get_connection (tp, conn_index, thread_index);
181  return tp_vfts[tp].app_rx_evt (tc);
182 }
183 
184 /**
185  * Get send parameters for transport connection
186  *
187  * These include maximum tx burst, mss, tx offset and other flags
188  * transport might want to provide to sessin layer
189  *
190  * @param tc transport connection
191  * @param sp send paramaters
192  *
193  */
194 static inline u32
197 {
198  return tp_vfts[tc->proto].send_params (tc, sp);
199 }
200 
201 static inline u8
203 {
204  return ((tc->flags & TRANSPORT_CONNECTION_F_DESCHED) ? 1 : 0);
205 }
206 
207 static inline void
209 {
210  tc->flags |= TRANSPORT_CONNECTION_F_DESCHED;
211 }
212 
213 static inline u8
215 {
216  return ((tc->flags & TRANSPORT_CONNECTION_F_CLESS) ? 1 : 0);
217 }
218 
220 
221 /**
222  * Register transport virtual function table.
223  *
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
229  */
231  const transport_proto_vft_t * vft,
232  fib_protocol_t fib_proto, u32 output_node);
235  fib_protocol_t fib_proto, u32 output_node);
237 void transport_update_time (clib_time_type_t time_now, u8 thread_index);
238 
239 int transport_alloc_local_port (u8 proto, ip46_address_t * ip);
241  ip46_address_t * lcl_addr,
242  u16 * lcl_port);
243 void transport_share_local_endpoint (u8 proto, ip46_address_t * lcl_ip,
244  u16 port);
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);
248 
251 {
252 #if TRANSPORT_DEBUG
253  return tc->elog_track.track_index_plus_one - 1;
254 #else
255  return ~0;
256 #endif
257 }
258 
260  u64 rate_bytes_per_sec,
261  u32 initial_bucket,
262  clib_us_time_t rtt);
263 /**
264  * Initialize tx pacer for connection
265  *
266  * @param tc transport connection
267  * @param rate_bytes_per_second initial byte rate
268  * @param burst_bytes initial burst size in bytes
269  */
271  u64 rate_bytes_per_sec,
272  u32 initial_bucket);
273 
274 /**
275  * Update tx pacer pacing rate
276  *
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
281  * reset to 1 mtu
282  */
284  u64 bytes_per_sec,
285  clib_us_time_t rtt);
286 
287 /**
288  * Get tx pacer max burst
289  *
290  * @param tc transport connection
291  * @param time_now current cpu time
292  * @return max burst for connection
293  */
295 
296 /**
297  * Get tx pacer current rate
298  *
299  * @param tc transport connection
300  * @return rate for connection in bytes/s
301  */
303 
304 /**
305  * Reset tx pacer bucket
306  *
307  * @param tc transport connection
308  * @param bucket value the bucket will be reset to
309  */
311  u32 bucket);
312 
313 /**
314  * Check if transport connection is paced
315  */
318 {
319  return (tc->flags & TRANSPORT_CONNECTION_F_IS_TX_PACED);
320 }
321 
322 u8 *format_transport_pacer (u8 * s, va_list * args);
323 
324 /**
325  * Update tx bytes for paced transport connection
326  *
327  * If tx pacing is enabled, this update pacer bucket to account for the
328  * amount of bytes that have been sent.
329  *
330  * @param tc transport connection
331  * @param bytes bytes recently sent
332  */
334  u32 bytes);
335 
336 void
338  u32 bytes);
339 
340 #endif /* SRC_VNET_SESSION_TRANSPORT_H_ */
341 
342 /*
343  * fd.io coding-style-patch-verification: ON
344  *
345  * Local Variables:
346  * eval: (c-set-style "gnu")
347  * End:
348  */
void transport_connection_update_tx_bytes(transport_connection_t *tc, u32 bytes)
Update tx bytes for paced transport connection.
Definition: transport.c:742
u32 transport_stop_listen(transport_proto_t tp, u32 conn_index)
Definition: transport.c:343
u64 transport_connection_tx_pacer_rate(transport_connection_t *tc)
Get tx pacer current rate.
Definition: transport.c:736
f64 clib_time_type_t
Definition: time.h:203
void transport_connection_reschedule(transport_connection_t *tc)
Definition: transport.c:756
transport_snd_flags_
Definition: transport.h:37
transport_proto
Definition: session.api:22
static int start_listen(u16 port)
unsigned long u64
Definition: types.h:89
void transport_init(void)
Definition: transport.c:795
#define thread_idx
Definition: tls_async.c:40
transport_proto_vft_t * tp_vfts
Per-type vector of transport protocol virtual function tables.
Definition: transport.c:29
vlib_main_t * vm
Definition: in2out_ed.c:1582
static u32 transport_connection_snd_params(transport_connection_t *tc, transport_send_params_t *sp)
Get send parameters for transport connection.
Definition: transport.h:195
struct transport_send_params_ transport_send_params_t
unsigned char u8
Definition: types.h:56
enum fib_protocol_t_ fib_protocol_t
Protocol Type.
double f64
Definition: types.h:142
Connection is "connection less".
void transport_update_time(clib_time_type_t time_now, u8 thread_index)
Definition: transport.c:773
void transport_register_protocol(transport_proto_t transport_proto, const transport_proto_vft_t *vft, fib_protocol_t fib_proto, u32 output_node)
Register transport virtual function table.
Definition: transport.c:246
void transport_connection_tx_pacer_reset(transport_connection_t *tc, u64 rate_bytes_per_sec, u32 initial_bucket, clib_us_time_t rtt)
Definition: transport.c:695
unsigned int u32
Definition: types.h:88
struct _transport_proto_vft transport_proto_vft_t
void transport_reset(transport_proto_t tp, u32 conn_index, u8 thread_index)
Definition: transport.c:327
u32 transport_start_listen(transport_proto_t tp, u32 session_index, transport_endpoint_t *tep)
Definition: transport.c:336
transport_proto_t transport_register_new_protocol(const transport_proto_vft_t *vft, fib_protocol_t fib_proto, u32 output_node)
Definition: transport.c:259
void transport_connection_tx_pacer_update_bytes(transport_connection_t *tc, u32 bytes)
Definition: transport.c:749
vl_api_ip_proto_t proto
Definition: acl_types.api:50
unsigned short u16
Definition: types.h:57
u32 transport_connection_tx_pacer_burst(transport_connection_t *tc)
Get tx pacer max burst.
Definition: transport.c:729
static void cleanup(void)
Definition: client.c:120
enum transport_service_type_ transport_service_type_t
#define always_inline
Definition: ipsec.h:28
static u8 transport_connection_is_tx_paced(transport_connection_t *tc)
Check if transport connection is paced.
Definition: transport.h:317
void transport_connection_tx_pacer_reset_bucket(transport_connection_t *tc, u32 bucket)
Reset tx pacer bucket.
Definition: transport.c:705
static transport_connection_t * transport_get_connection(transport_proto_t tp, u32 conn_index, u8 thread_index)
Definition: transport.h:149
void transport_endpoint_cleanup(u8 proto, ip46_address_t *lcl_ip, u16 port)
Definition: transport.c:421
struct _transport_connection transport_connection_t
static u32 transport_elog_track_index(transport_connection_t *tc)
Definition: transport.h:250
static u8 transport_connection_is_cless(transport_connection_t *tc)
Definition: transport.h:214
string name[64]
Definition: ip.api:44
transport_snd_flags_t flags
Definition: transport.h:61
static int transport_custom_tx(transport_proto_t tp, void *s, transport_send_params_t *sp)
Definition: transport.h:168
int transport_connect(transport_proto_t tp, transport_endpoint_cfg_t *tep)
Definition: transport.c:315
enum _transport_proto transport_proto_t
void transport_get_endpoint(transport_proto_t tp, u32 conn_index, u32 thread_index, transport_endpoint_t *tep, u8 is_lcl)
Definition: transport.c:373
void transport_cleanup_half_open(transport_proto_t tp, u32 conn_index)
Definition: transport.c:308
static int transport_app_rx_evt(transport_proto_t tp, u32 conn_index, u32 thread_index)
Definition: transport.h:175
enum transport_snd_flags_ transport_snd_flags_t
static transport_connection_t * transport_get_half_open(transport_proto_t tp, u32 conn_index)
Definition: transport.h:162
vl_api_address_t ip
Definition: l2.api:501
void transport_connection_tx_pacer_update(transport_connection_t *tc, u64 bytes_per_sec, clib_us_time_t rtt)
Update tx pacer pacing rate.
Definition: transport.c:722
struct _transport_options_t transport_options_t
VLIB buffer representation.
Definition: buffer.h:102
void transport_cleanup(transport_proto_t tp, u32 conn_index, u8 thread_index)
Definition: transport.c:302
u16 port
Definition: lb_types.api:72
void transport_get_listener_endpoint(transport_proto_t tp, u32 conn_index, transport_endpoint_t *tep, u8 is_lcl)
Definition: transport.c:389
Connection descheduled by the session layer.
transport_proto_vft_t * transport_protocol_get_vft(transport_proto_t tp)
Get transport virtual function table.
Definition: transport.c:282
void transport_close(transport_proto_t tp, u32 conn_index, u8 thread_index)
Definition: transport.c:321
void transport_connection_tx_pacer_init(transport_connection_t *tc, u64 rate_bytes_per_sec, u32 initial_bucket)
Initialize tx pacer for connection.
Definition: transport.c:712
void transport_share_local_endpoint(u8 proto, ip46_address_t *lcl_ip, u16 port)
Definition: transport.c:456
u8 * format_transport_pacer(u8 *s, va_list *args)
Definition: transport.c:627
static transport_connection_t * transport_get_listener(transport_proto_t tp, u32 conn_index)
Definition: transport.h:156
u64 clib_us_time_t
Definition: time.h:204
int transport_alloc_local_endpoint(u8 proto, transport_endpoint_cfg_t *rmt, ip46_address_t *lcl_addr, u16 *lcl_port)
Definition: transport.c:565
void transport_enable_disable(vlib_main_t *vm, u8 is_en)
Definition: transport.c:784
enum transport_dequeue_type_ transport_tx_fn_type_t
int transport_alloc_local_port(u8 proto, ip46_address_t *ip)
Allocate local port and add if successful add entry to local endpoint table to mark the pair as used...
Definition: transport.c:475
static void transport_connection_deschedule(transport_connection_t *tc)
Definition: transport.h:208
static u8 transport_connection_is_descheduled(transport_connection_t *tc)
Definition: transport.h:202