FD.io VPP  v20.01-48-g3e0dafb74
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_MIN_IDLE 100
26 #define TRANSPORT_PACER_IDLE_FACTOR 0.05
27 
28 typedef struct _transport_options_t
29 {
30  transport_tx_fn_type_t tx_type;
31  transport_service_type_t service_type;
32  u8 half_open_has_fifos;
34 
35 /*
36  * Transport protocol virtual function table
37  */
38 /* *INDENT-OFF* */
39 typedef struct _transport_proto_vft
40 {
41  /*
42  * Setup
43  */
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);
51 
52  /*
53  * Transmission
54  */
55 
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);
64 
65  /*
66  * Connection retrieval
67  */
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);
71 
72  /*
73  * Format
74  */
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);
78 
79  /*
80  * Properties retrieval
81  */
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,
86  u8 is_lcl);
87 
88  /*
89  * Properties
90  */
91  transport_options_t transport_options;
93 /* *INDENT-ON* */
94 
96 
97 #define transport_proto_foreach(VAR, BODY) \
98 do { \
99  for (VAR = 0; VAR < vec_len (tp_vfts); VAR++) \
100  if (tp_vfts[VAR].push_header != 0) \
101  do { BODY; } while (0); \
102 } while (0)
103 
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);
108  transport_endpoint_t * tep);
110 void transport_cleanup (transport_proto_t tp, u32 conn_index,
111  u8 thread_index);
112 void transport_get_endpoint (transport_proto_t tp, u32 conn_index,
113  u32 thread_index, transport_endpoint_t * tep,
114  u8 is_lcl);
116  transport_endpoint_t * tep, u8 is_lcl);
117 
118 static inline transport_connection_t *
120  u8 thread_index)
121 {
122  return tp_vfts[tp].get_connection (conn_index, thread_index);
123 }
124 
125 static inline transport_connection_t *
127 {
128  return tp_vfts[tp].get_listener (conn_index);
129 }
130 
131 static inline transport_connection_t *
133 {
134  return tp_vfts[tp].get_half_open (conn_index);
135 }
136 
137 static inline int
138 transport_custom_tx (transport_proto_t tp, void *s, u32 max_burst_size)
139 {
140  return tp_vfts[tp].custom_tx (s, max_burst_size);
141 }
142 
143 static inline int
144 transport_app_rx_evt (transport_proto_t tp, u32 conn_index, u32 thread_index)
145 {
147  if (!tp_vfts[tp].app_rx_evt)
148  return 0;
149  tc = transport_get_connection (tp, conn_index, thread_index);
150  return tp_vfts[tp].app_rx_evt (tc);
151 }
152 
153 /**
154  * Get maximum tx burst allowed for transport connection
155  *
156  * @param tc transport connection
157  */
158 static inline u32
160 {
161  return tp_vfts[tc->proto].send_space (tc);
162 }
163 
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);
168 void transport_update_time (clib_time_type_t time_now, u8 thread_index);
169 
170 int transport_alloc_local_port (u8 proto, ip46_address_t * ip);
172  ip46_address_t * lcl_addr,
173  u16 * lcl_port);
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);
177 
180 {
181 #if TRANSPORT_DEBUG
182  return tc->elog_track.track_index_plus_one - 1;
183 #else
184  return ~0;
185 #endif
186 }
187 
189  u64 rate_bytes_per_sec,
190  u32 initial_bucket,
191  clib_us_time_t rtt);
192 /**
193  * Initialize tx pacer for connection
194  *
195  * @param tc transport connection
196  * @param rate_bytes_per_second initial byte rate
197  * @param burst_bytes initial burst size in bytes
198  */
200  u64 rate_bytes_per_sec,
201  u32 initial_bucket);
202 
203 /**
204  * Update tx pacer pacing rate
205  *
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
210  * reset to 1 mtu
211  */
213  u64 bytes_per_sec,
214  clib_us_time_t rtt);
215 
216 /**
217  * Get tx pacer max burst
218  *
219  * @param tc transport connection
220  * @param time_now current cpu time
221  * @return max burst for connection
222  */
224 
225 /**
226  * Get tx pacer current rate
227  *
228  * @param tc transport connection
229  * @return rate for connection in bytes/s
230  */
232 
233 /**
234  * Reset tx pacer bucket
235  *
236  * @param tc transport connection
237  * @param bucket value the bucket will be reset to
238  */
240  u32 bucket);
241 
242 /**
243  * Check if transport connection is paced
244  */
247 {
248  return (tc->flags & TRANSPORT_CONNECTION_F_IS_TX_PACED);
249 }
250 
251 u8 *format_transport_pacer (u8 * s, va_list * args);
252 
253 /**
254  * Update tx bytes for paced transport connection
255  *
256  * If tx pacing is enabled, this update pacer bucket to account for the
257  * amount of bytes that have been sent.
258  *
259  * @param tc transport connection
260  * @param bytes bytes recently sent
261  */
263  u32 bytes);
264 
265 void
267  u32 bytes);
268 
269 #endif /* SRC_VNET_SESSION_TRANSPORT_H_ */
270 
271 /*
272  * fd.io coding-style-patch-verification: ON
273  *
274  * Local Variables:
275  * eval: (c-set-style "gnu")
276  * End:
277  */
void transport_connection_update_tx_bytes(transport_connection_t *tc, u32 bytes)
Update tx bytes for paced transport connection.
Definition: transport.c:709
u32 transport_stop_listen(transport_proto_t tp, u32 conn_index)
Definition: transport.c:317
u64 transport_connection_tx_pacer_rate(transport_connection_t *tc)
Get tx pacer current rate.
Definition: transport.c:703
u8 proto
Definition: acl_types.api:47
f64 clib_time_type_t
Definition: time.h:197
static int start_listen(u16 port)
unsigned long u64
Definition: types.h:89
void transport_init(void)
Definition: transport.c:745
transport_proto_vft_t * tp_vfts
Per-type vector of transport protocol virtual function tables.
Definition: transport.c:23
unsigned char u8
Definition: types.h:56
enum fib_protocol_t_ fib_protocol_t
Protocol Type.
double f64
Definition: types.h:142
void transport_update_time(clib_time_type_t time_now, u8 thread_index)
Definition: transport.c:723
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:239
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:662
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:301
u32 transport_start_listen(transport_proto_t tp, u32 session_index, transport_endpoint_t *tep)
Definition: transport.c:310
void transport_connection_tx_pacer_update_bytes(transport_connection_t *tc, u32 bytes)
Definition: transport.c:716
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:696
static void cleanup(void)
Definition: client.c:131
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:246
vlib_main_t * vm
Definition: in2out_ed.c:1810
void transport_connection_tx_pacer_reset_bucket(transport_connection_t *tc, u32 bucket)
Reset tx pacer bucket.
Definition: transport.c:672
static transport_connection_t * transport_get_connection(transport_proto_t tp, u32 conn_index, u8 thread_index)
Definition: transport.h:119
void transport_endpoint_cleanup(u8 proto, ip46_address_t *lcl_ip, u16 port)
Definition: transport.c:395
struct _transport_connection transport_connection_t
static u32 transport_elog_track_index(transport_connection_t *tc)
Definition: transport.h:179
static int transport_custom_tx(transport_proto_t tp, void *s, u32 max_burst_size)
Definition: transport.h:138
int transport_connect(transport_proto_t tp, transport_endpoint_cfg_t *tep)
Definition: transport.c:289
static u32 transport_connection_snd_space(transport_connection_t *tc)
Get maximum tx burst allowed for transport connection.
Definition: transport.h:159
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:347
static int transport_app_rx_evt(transport_proto_t tp, u32 conn_index, u32 thread_index)
Definition: transport.h:144
static transport_connection_t * transport_get_half_open(transport_proto_t tp, u32 conn_index)
Definition: transport.h:132
vl_api_address_t ip
Definition: l2.api:490
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:689
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:283
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:363
transport_proto_vft_t * transport_protocol_get_vft(transport_proto_t tp)
Get transport virtual function table.
Definition: transport.c:257
void transport_close(transport_proto_t tp, u32 conn_index, u8 thread_index)
Definition: transport.c:295
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:679
u8 * format_transport_pacer(u8 *s, va_list *args)
Definition: transport.c:594
static transport_connection_t * transport_get_listener(transport_proto_t tp, u32 conn_index)
Definition: transport.h:126
u64 clib_us_time_t
Definition: time.h:198
int transport_alloc_local_endpoint(u8 proto, transport_endpoint_cfg_t *rmt, ip46_address_t *lcl_addr, u16 *lcl_port)
Definition: transport.c:526
void transport_enable_disable(vlib_main_t *vm, u8 is_en)
Definition: transport.c:734
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:429