FD.io VPP  v21.06-3-gbb25fbf28
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_BURSTS_PER_RTT 20
27 #define TRANSPORT_PACER_MIN_IDLE 100
28 #define TRANSPORT_PACER_IDLE_FACTOR 0.05
29 
30 typedef struct _transport_options_t
31 {
32  char *name;
33  char *short_name;
34  transport_tx_fn_type_t tx_type;
35  transport_service_type_t service_type;
37 
39 {
43 } __clib_packed transport_snd_flags_t;
44 
45 typedef struct transport_send_params_
46 {
47  union
48  {
49  /* Used to retrieve snd params from transports */
50  struct
51  {
55  };
56  /* Used by custom tx functions */
57  struct
58  {
60  };
61  };
64 
65 /*
66  * Transport protocol virtual function table
67  */
68 /* *INDENT-OFF* */
69 typedef struct _transport_proto_vft
70 {
71  /*
72  * Setup
73  */
74  u32 (*start_listen) (u32 session_index, transport_endpoint_t * lcl);
75  u32 (*stop_listen) (u32 conn_index);
76  int (*connect) (transport_endpoint_cfg_t * rmt);
77  void (*half_close) (u32 conn_index, u32 thread_index);
78  void (*close) (u32 conn_index, u32 thread_index);
79  void (*reset) (u32 conn_index, u32 thread_index);
80  void (*cleanup) (u32 conn_index, u32 thread_index);
81  void (*cleanup_ho) (u32 conn_index);
82  clib_error_t *(*enable) (vlib_main_t * vm, u8 is_en);
83 
84  /*
85  * Transmission
86  */
87 
88  u32 (*push_header) (transport_connection_t * tconn, vlib_buffer_t * b);
89  int (*send_params) (transport_connection_t * tconn,
91  void (*update_time) (f64 time_now, u8 thread_index);
92  void (*flush_data) (transport_connection_t *tconn);
93  int (*custom_tx) (void *session, transport_send_params_t *sp);
94  int (*app_rx_evt) (transport_connection_t *tconn);
95 
96  /*
97  * Connection retrieval
98  */
99  transport_connection_t *(*get_connection) (u32 conn_idx, u32 thread_idx);
100  transport_connection_t *(*get_listener) (u32 conn_index);
101  transport_connection_t *(*get_half_open) (u32 conn_index);
102 
103  /*
104  * Format
105  */
106  u8 *(*format_connection) (u8 * s, va_list * args);
107  u8 *(*format_listener) (u8 * s, va_list * args);
108  u8 *(*format_half_open) (u8 * s, va_list * args);
109 
110  /*
111  * Properties retrieval/setting
112  */
113  void (*get_transport_endpoint) (u32 conn_index, u32 thread_index,
114  transport_endpoint_t *tep, u8 is_lcl);
115  void (*get_transport_listener_endpoint) (u32 conn_index,
117  u8 is_lcl);
118  int (*attribute) (u32 conn_index, u32 thread_index, u8 is_get,
119  transport_endpt_attr_t *attr);
120 
121  /*
122  * Properties
123  */
124  transport_options_t transport_options;
126 /* *INDENT-ON* */
127 
129 
130 #define transport_proto_foreach(VAR, BODY) \
131 do { \
132  for (VAR = 0; VAR < vec_len (tp_vfts); VAR++) \
133  if (tp_vfts[VAR].push_header != 0) \
134  do { BODY; } while (0); \
135 } while (0)
136 
138 void transport_half_close (transport_proto_t tp, u32 conn_index,
139  u8 thread_index);
140 void transport_close (transport_proto_t tp, u32 conn_index, u8 thread_index);
141 void transport_reset (transport_proto_t tp, u32 conn_index, u8 thread_index);
143  transport_endpoint_t * tep);
145 void transport_cleanup (transport_proto_t tp, u32 conn_index,
146  u8 thread_index);
148 void transport_get_endpoint (transport_proto_t tp, u32 conn_index,
150  u8 is_lcl);
152  transport_endpoint_t * tep, u8 is_lcl);
154  u8 thread_index, u8 is_get,
155  transport_endpt_attr_t *attr);
156 
157 static inline transport_connection_t *
160 {
161  return tp_vfts[tp].get_connection (conn_index, thread_index);
162 }
163 
164 static inline transport_connection_t *
166 {
167  return tp_vfts[tp].get_listener (conn_index);
168 }
169 
170 static inline transport_connection_t *
172 {
173  return tp_vfts[tp].get_half_open (conn_index);
174 }
175 
176 static inline int
179 {
180  return tp_vfts[tp].custom_tx (s, sp);
181 }
182 
183 static inline int
185 {
187  if (!tp_vfts[tp].app_rx_evt)
188  return 0;
189  tc = transport_get_connection (tp, conn_index, thread_index);
190  return tp_vfts[tp].app_rx_evt (tc);
191 }
192 
193 /**
194  * Get send parameters for transport connection
195  *
196  * These include maximum tx burst, mss, tx offset and other flags
197  * transport might want to provide to sessin layer
198  *
199  * @param tc transport connection
200  * @param sp send paramaters
201  *
202  */
203 static inline u32
206 {
207  return tp_vfts[tc->proto].send_params (tc, sp);
208 }
209 
210 static inline u8
212 {
213  return ((tc->flags & TRANSPORT_CONNECTION_F_DESCHED) ? 1 : 0);
214 }
215 
216 static inline void
218 {
219  tc->flags |= TRANSPORT_CONNECTION_F_DESCHED;
220 }
221 
222 static inline u8
224 {
225  return ((tc->flags & TRANSPORT_CONNECTION_F_CLESS) ? 1 : 0);
226 }
227 
230 
231 /**
232  * Register transport virtual function table.
233  *
234  * @param transport_proto - transport protocol type (i.e., TCP, UDP ..)
235  * @param vft - virtual function table for transport proto
236  * @param fib_proto - network layer protocol
237  * @param output_node - output node index that session layer will hand off
238  * buffers to, for requested fib proto
239  */
241  const transport_proto_vft_t * vft,
242  fib_protocol_t fib_proto, u32 output_node);
245  fib_protocol_t fib_proto, u32 output_node);
248 
249 int transport_alloc_local_port (u8 proto, ip46_address_t * ip);
251  ip46_address_t * lcl_addr,
252  u16 * lcl_port);
253 void transport_share_local_endpoint (u8 proto, ip46_address_t * lcl_ip,
254  u16 port);
255 void transport_endpoint_cleanup (u8 proto, ip46_address_t * lcl_ip, u16 port);
256 void transport_enable_disable (vlib_main_t * vm, u8 is_en);
257 void transport_init (void);
258 
261 {
262 #if TRANSPORT_DEBUG
263  return tc->elog_track.track_index_plus_one - 1;
264 #else
265  return ~0;
266 #endif
267 }
268 
270  u64 rate_bytes_per_sec,
271  u32 initial_bucket,
272  clib_us_time_t rtt);
273 /**
274  * Initialize tx pacer for connection
275  *
276  * @param tc transport connection
277  * @param rate_bytes_per_second initial byte rate
278  * @param burst_bytes initial burst size in bytes
279  */
281  u64 rate_bytes_per_sec,
282  u32 initial_bucket);
283 
284 /**
285  * Update tx pacer pacing rate
286  *
287  * @param tc transport connection
288  * @param bytes_per_sec new pacing rate
289  * @param rtt connection rtt that is used to compute
290  * inactivity time after which pacer bucket is
291  * reset to 1 mtu
292  */
294  u64 bytes_per_sec,
295  clib_us_time_t rtt);
296 
297 /**
298  * Get tx pacer max burst
299  *
300  * @param tc transport connection
301  * @param time_now current cpu time
302  * @return max burst for connection
303  */
305 
306 /**
307  * Get tx pacer current rate
308  *
309  * @param tc transport connection
310  * @return rate for connection in bytes/s
311  */
313 
314 /**
315  * Reset tx pacer bucket
316  *
317  * @param tc transport connection
318  * @param bucket value the bucket will be reset to
319  */
321  u32 bucket);
322 
323 /**
324  * Check if transport connection is paced
325  */
328 {
329  return (tc->flags & TRANSPORT_CONNECTION_F_IS_TX_PACED);
330 }
331 
332 u8 *format_transport_pacer (u8 * s, va_list * args);
333 
334 /**
335  * Update tx bytes for paced transport connection
336  *
337  * If tx pacing is enabled, this update pacer bucket to account for the
338  * amount of bytes that have been sent.
339  *
340  * @param tc transport connection
341  * @param bytes bytes recently sent
342  */
344  u32 bytes);
345 
346 void
348  u32 bytes);
349 
350 /**
351  * Request pacer time update
352  *
353  * @param thread_index thread for which time is updated
354  * @param now time now
355  */
357 
358 #endif /* SRC_VNET_SESSION_TRANSPORT_H_ */
359 
360 /*
361  * fd.io coding-style-patch-verification: ON
362  *
363  * Local Variables:
364  * eval: (c-set-style "gnu")
365  * End:
366  */
TRANSPORT_SND_F_POSTPONE
@ TRANSPORT_SND_F_POSTPONE
Definition: transport.h:41
transport_register_protocol
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
thread_index
u32 thread_index
Definition: nat44_ei_hairpinning.c:492
transport_half_close
void transport_half_close(transport_proto_t tp, u32 conn_index, u8 thread_index)
Definition: transport.c:321
transport_get_endpoint
void transport_get_endpoint(transport_proto_t tp, u32 conn_index, u32 thread_index, transport_endpoint_t *tep, u8 is_lcl)
Definition: transport.c:380
transport_update_time
void transport_update_time(clib_time_type_t time_now, u8 thread_index)
Definition: transport.c:815
transport_alloc_local_port
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:493
transport_snd_flags_
transport_snd_flags_
Definition: transport.h:38
name
string name[64]
Definition: fib.api:25
transport_connection_is_tx_paced
static u8 transport_connection_is_tx_paced(transport_connection_t *tc)
Check if transport connection is paced.
Definition: transport.h:327
transport_service_type_t
enum transport_service_type_ transport_service_type_t
transport_proto_vft_t
struct _transport_proto_vft transport_proto_vft_t
transport_reset
void transport_reset(transport_proto_t tp, u32 conn_index, u8 thread_index)
Definition: transport.c:334
u16
unsigned short u16
Definition: types.h:57
transport_register_new_protocol
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
format_transport_pacer
u8 * format_transport_pacer(u8 *s, va_list *args)
Definition: transport.c:645
vm
vlib_main_t * vm
X-connect all packets from the HOST to the PHY.
Definition: nat44_ei.c:3047
port
u16 port
Definition: lb_types.api:73
transport_send_params_::snd_mss
u16 snd_mss
Definition: transport.h:54
transport_connection_t
struct _transport_connection transport_connection_t
transport_enable_disable
void transport_enable_disable(vlib_main_t *vm, u8 is_en)
Definition: transport.c:826
transport_endpoint_pair_
Definition: transport_types.h:212
clib_time_type_t
f64 clib_time_type_t
Definition: time.h:203
tp_vfts
transport_proto_vft_t * tp_vfts
Per-type vector of transport protocol virtual function tables.
Definition: transport.c:29
TRANSPORT_SND_N_FLAGS
@ TRANSPORT_SND_N_FLAGS
Definition: transport.h:42
transport_connection_update_tx_bytes
void transport_connection_update_tx_bytes(transport_connection_t *tc, u32 bytes)
Update tx bytes for paced transport connection.
Definition: transport.c:770
transport_connection_tx_pacer_rate
u64 transport_connection_tx_pacer_rate(transport_connection_t *tc)
Get tx pacer current rate.
Definition: transport.c:764
transport_tx_fn_type_t
enum transport_dequeue_type_ transport_tx_fn_type_t
TRANSPORT_SND_F_DESCHED
@ TRANSPORT_SND_F_DESCHED
Definition: transport.h:40
TRANSPORT_CONNECTION_F_CLESS
@ TRANSPORT_CONNECTION_F_CLESS
Connection is "connection less".
Definition: transport_types.h:62
transport_types.h
transport_connect
int transport_connect(transport_proto_t tp, transport_endpoint_cfg_t *tep)
Definition: transport.c:315
transport_connection_tx_pacer_update_bytes
void transport_connection_tx_pacer_update_bytes(transport_connection_t *tc, u32 bytes)
Definition: transport.c:777
transport_send_params_::tx_offset
u32 tx_offset
Definition: transport.h:53
transport_connection_snd_params
static u32 transport_connection_snd_params(transport_connection_t *tc, transport_send_params_t *sp)
Get send parameters for transport connection.
Definition: transport.h:204
transport_endpt_attr_
Definition: transport_types.h:252
TRANSPORT_CONNECTION_F_IS_TX_PACED
@ TRANSPORT_CONNECTION_F_IS_TX_PACED
Definition: transport_types.h:47
transport_fifos_init_ooo
void transport_fifos_init_ooo(transport_connection_t *tc)
Definition: transport.c:807
f64
double f64
Definition: types.h:142
transport_connection_tx_pacer_reset_bucket
void transport_connection_tx_pacer_reset_bucket(transport_connection_t *tc, u32 bucket)
Reset tx pacer bucket.
Definition: transport.c:732
transport_custom_tx
static int transport_custom_tx(transport_proto_t tp, void *s, transport_send_params_t *sp)
Definition: transport.h:177
transport_cleanup_half_open
void transport_cleanup_half_open(transport_proto_t tp, u32 conn_index)
Definition: transport.c:308
transport_update_pacer_time
void transport_update_pacer_time(u32 thread_index, clib_time_type_t now)
Request pacer time update.
Definition: transport.c:784
transport_app_rx_evt
static int transport_app_rx_evt(transport_proto_t tp, u32 conn_index, u32 thread_index)
Definition: transport.h:184
transport_snd_flags_t
enum transport_snd_flags_ transport_snd_flags_t
fib_protocol_t
enum fib_protocol_t_ fib_protocol_t
Protocol Type.
transport_start_listen
u32 transport_start_listen(transport_proto_t tp, u32 session_index, transport_endpoint_t *tep)
Definition: transport.c:343
transport_send_params_::snd_space
u32 snd_space
Definition: transport.h:52
transport_connection_tx_pacer_reset
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:721
transport_send_params_t
struct transport_send_params_ transport_send_params_t
transport_send_params_
Definition: transport.h:45
always_inline
#define always_inline
Definition: rdma_mlx5dv.h:23
u64
unsigned long u64
Definition: types.h:89
transport_stop_listen
u32 transport_stop_listen(transport_proto_t tp, u32 conn_index)
Definition: transport.c:350
u32
unsigned int u32
Definition: types.h:88
transport_endpoint_
Definition: transport_types.h:193
transport_proto_t
enum _transport_proto transport_proto_t
transport_alloc_local_endpoint
int transport_alloc_local_endpoint(u8 proto, transport_endpoint_cfg_t *rmt, ip46_address_t *lcl_addr, u16 *lcl_port)
Definition: transport.c:583
transport_connection_reschedule
void transport_connection_reschedule(transport_connection_t *tc)
Definition: transport.c:790
transport_protocol_get_vft
transport_proto_vft_t * transport_protocol_get_vft(transport_proto_t tp)
Get transport virtual function table.
Definition: transport.c:282
transport_connection_is_descheduled
static u8 transport_connection_is_descheduled(transport_connection_t *tc)
Definition: transport.h:211
now
f64 now
Definition: nat44_ei_out2in.c:710
transport_connection_is_cless
static u8 transport_connection_is_cless(transport_connection_t *tc)
Definition: transport.h:223
clib_us_time_t
u64 clib_us_time_t
Definition: time.h:204
vlib_main_t
Definition: main.h:102
transport_options_t
struct _transport_options_t transport_options_t
transport_connection_tx_pacer_burst
u32 transport_connection_tx_pacer_burst(transport_connection_t *tc)
Get tx pacer max burst.
Definition: transport.c:757
transport_get_connection
static transport_connection_t * transport_get_connection(transport_proto_t tp, u32 conn_index, u8 thread_index)
Definition: transport.h:158
transport_send_params_::max_burst_size
u32 max_burst_size
Definition: transport.h:59
b
vlib_buffer_t ** b
Definition: nat44_ei_out2in.c:717
u8
unsigned char u8
Definition: types.h:56
clib_error_t
Definition: clib_error.h:21
ip
vl_api_address_t ip
Definition: l2.api:558
transport_endpoint_cleanup
void transport_endpoint_cleanup(u8 proto, ip46_address_t *lcl_ip, u16 port)
Definition: transport.c:439
transport_connection_attribute
int transport_connection_attribute(transport_proto_t tp, u32 conn_index, u8 thread_index, u8 is_get, transport_endpt_attr_t *attr)
Definition: transport.c:410
transport_get_half_open
static transport_connection_t * transport_get_half_open(transport_proto_t tp, u32 conn_index)
Definition: transport.h:171
transport_close
void transport_close(transport_proto_t tp, u32 conn_index, u8 thread_index)
Definition: transport.c:328
transport_elog_track_index
static u32 transport_elog_track_index(transport_connection_t *tc)
Definition: transport.h:260
transport_connection_tx_pacer_init
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:739
transport_send_params_::flags
transport_snd_flags_t flags
Definition: transport.h:62
cleanup
static void cleanup(void)
Definition: client.c:98
transport_proto
transport_proto
Definition: session.api:22
transport_cleanup
void transport_cleanup(transport_proto_t tp, u32 conn_index, u8 thread_index)
Definition: transport.c:302
vnet.h
transport_get_listener
static transport_connection_t * transport_get_listener(transport_proto_t tp, u32 conn_index)
Definition: transport.h:165
transport_get_listener_endpoint
void transport_get_listener_endpoint(transport_proto_t tp, u32 conn_index, transport_endpoint_t *tep, u8 is_lcl)
Definition: transport.c:396
proto
vl_api_ip_proto_t proto
Definition: acl_types.api:51
thread_idx
#define thread_idx
Definition: tls_async.c:40
transport_init
void transport_init(void)
Definition: transport.c:837
transport_share_local_endpoint
void transport_share_local_endpoint(u8 proto, ip46_address_t *lcl_ip, u16 port)
Definition: transport.c:474
start_listen
static int start_listen(u16 port)
Definition: vpp_prometheus_export.c:188
TRANSPORT_CONNECTION_F_DESCHED
@ TRANSPORT_CONNECTION_F_DESCHED
Connection descheduled by the session layer.
Definition: transport_types.h:56
transport_connection_tx_pacer_update
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:749
vlib_buffer_t
VLIB buffer representation.
Definition: buffer.h:111
transport_connection_deschedule
static void transport_connection_deschedule(transport_connection_t *tc)
Definition: transport.h:217