FD.io VPP  v19.08.3-2-gbabecb413
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 
26 typedef struct _transport_options_t
27 {
28  transport_tx_fn_type_t tx_type;
29  transport_service_type_t service_type;
30  u8 half_open_has_fifos;
32 
33 /*
34  * Transport protocol virtual function table
35  */
36 /* *INDENT-OFF* */
37 typedef struct _transport_proto_vft
38 {
39  /*
40  * Setup
41  */
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);
49 
50  /*
51  * Transmission
52  */
53 
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);
62 
63  /*
64  * Connection retrieval
65  */
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);
69 
70  /*
71  * Format
72  */
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);
76 
77  /*
78  * Properties retrieval
79  */
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,
84  u8 is_lcl);
85 
86  /*
87  * Properties
88  */
89  transport_options_t transport_options;
91 /* *INDENT-ON* */
92 
94 
95 #define transport_proto_foreach(VAR, BODY) \
96 do { \
97  for (VAR = 0; VAR < vec_len (tp_vfts); VAR++) \
98  if (tp_vfts[VAR].push_header != 0) \
99  do { BODY; } while (0); \
100 } while (0)
101 
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);
106  transport_endpoint_t * tep);
108 void transport_cleanup (transport_proto_t tp, u32 conn_index,
109  u8 thread_index);
110 void transport_get_endpoint (transport_proto_t tp, u32 conn_index,
111  u32 thread_index, transport_endpoint_t * tep,
112  u8 is_lcl);
114  transport_endpoint_t * tep, u8 is_lcl);
115 
116 static inline transport_connection_t *
118  u8 thread_index)
119 {
120  return tp_vfts[tp].get_connection (conn_index, thread_index);
121 }
122 
123 static inline transport_connection_t *
125 {
126  return tp_vfts[tp].get_listener (conn_index);
127 }
128 
129 static inline transport_connection_t *
131 {
132  return tp_vfts[tp].get_half_open (conn_index);
133 }
134 
135 static inline int
136 transport_custom_tx (transport_proto_t tp, void *s, u32 max_burst_size)
137 {
138  return tp_vfts[tp].custom_tx (s, max_burst_size);
139 }
140 
141 static inline int
142 transport_app_rx_evt (transport_proto_t tp, u32 conn_index, u32 thread_index)
143 {
145  if (!tp_vfts[tp].app_rx_evt)
146  return 0;
147  tc = transport_get_connection (tp, conn_index, thread_index);
148  return tp_vfts[tp].app_rx_evt (tc);
149 }
150 
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);
155 void transport_update_time (clib_time_type_t time_now, u8 thread_index);
156 
157 int transport_alloc_local_port (u8 proto, ip46_address_t * ip);
159  ip46_address_t * lcl_addr,
160  u16 * lcl_port);
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);
164 
167 {
168 #if TRANSPORT_DEBUG
169  return tc->elog_track.track_index_plus_one - 1;
170 #else
171  return ~0;
172 #endif
173 }
174 
176  u64 rate_bytes_per_sec,
177  u32 initial_bucket);
178 /**
179  * Initialize tx pacer for connection
180  *
181  * @param tc transport connection
182  * @param rate_bytes_per_second initial byte rate
183  * @param burst_bytes initial burst size in bytes
184  */
186  u64 rate_bytes_per_sec,
187  u32 initial_bucket);
188 
189 /**
190  * Update tx pacer pacing rate
191  *
192  * @param tc transport connection
193  * @param bytes_per_sec new pacing rate
194  */
196  u64 bytes_per_sec);
197 
198 /**
199  * Get maximum tx burst allowed for transport connection
200  *
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
204  */
206 
207 /**
208  * Get tx pacer max burst
209  *
210  * @param tc transport connection
211  * @param time_now current cpu time
212  * @return max burst for connection
213  */
215 
216 /**
217  * Get tx pacer current rate
218  *
219  * @param tc transport connection
220  * @return rate for connection in bytes/s
221  */
223 
224 /**
225  * Reset tx pacer bucket
226  *
227  * @param tc transport connection
228  * @param time_now current cpu time
229  */
231 
232 /**
233  * Check if transport connection is paced
234  */
237 {
238  return (tc->flags & TRANSPORT_CONNECTION_F_IS_TX_PACED);
239 }
240 
241 u8 *format_transport_pacer (u8 * s, va_list * args);
242 
243 /**
244  * Update tx bytes for paced transport connection
245  *
246  * If tx pacing is enabled, this update pacer bucket to account for the
247  * amount of bytes that have been sent.
248  *
249  * @param tc transport connection
250  * @param bytes bytes recently sent
251  */
253  u32 bytes);
254 
255 void
257  u32 bytes);
258 
259 #endif /* SRC_VNET_SESSION_TRANSPORT_H_ */
260 
261 /*
262  * fd.io coding-style-patch-verification: ON
263  *
264  * Local Variables:
265  * eval: (c-set-style "gnu")
266  * End:
267  */
void transport_connection_update_tx_bytes(transport_connection_t *tc, u32 bytes)
Update tx bytes for paced transport connection.
Definition: transport.c:723
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:717
f64 clib_time_type_t
Definition: time.h:203
static int start_listen(u16 port)
unsigned long u64
Definition: types.h:89
void transport_init(void)
Definition: transport.c:759
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:737
#define always_inline
Definition: clib.h:99
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
unsigned int u32
Definition: types.h:88
void transport_connection_tx_pacer_reset(transport_connection_t *tc, u64 rate_bytes_per_sec, u32 initial_bucket)
Definition: transport.c:660
u32 transport_connection_snd_space(transport_connection_t *tc, u16 mss)
Get maximum tx burst allowed for transport connection.
Definition: transport.c:699
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:730
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:692
static void cleanup(void)
Definition: client.c:131
enum transport_service_type_ transport_service_type_t
u16 port
Definition: punt.api:40
static u8 transport_connection_is_tx_paced(transport_connection_t *tc)
Check if transport connection is paced.
Definition: transport.h:236
vlib_main_t * vm
Definition: buffer.c:323
static transport_connection_t * transport_get_connection(transport_proto_t tp, u32 conn_index, u8 thread_index)
Definition: transport.h:117
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:166
void transport_connection_tx_pacer_update(transport_connection_t *tc, u64 bytes_per_sec)
Update tx pacer pacing rate.
Definition: transport.c:685
static int transport_custom_tx(transport_proto_t tp, void *s, u32 max_burst_size)
Definition: transport.h:136
int transport_connect(transport_proto_t tp, transport_endpoint_cfg_t *tep)
Definition: transport.c:289
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:142
static transport_connection_t * transport_get_half_open(transport_proto_t tp, u32 conn_index)
Definition: transport.h:130
vl_api_address_t ip
Definition: l2.api:489
struct _transport_options_t transport_options_t
void transport_connection_tx_pacer_reset_bucket(transport_connection_t *tc)
Reset tx pacer bucket.
Definition: transport.c:669
VLIB buffer representation.
Definition: buffer.h:102
void transport_cleanup(transport_proto_t tp, u32 conn_index, u8 thread_index)
Definition: transport.c:283
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:675
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:124
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:748
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
vl_api_fib_path_nh_proto_t proto
Definition: fib_types.api:125