FD.io VPP  v19.01.2-3-gf61a1a8
Vector Packet Processing
transport_interface.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2017 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_INTERFACE_H_
17 #define SRC_VNET_SESSION_TRANSPORT_INTERFACE_H_
18 
19 #include <vnet/vnet.h>
20 #include <vnet/session/transport.h>
21 
23 {
24  TRANSPORT_TX_PEEK, /**< reliable transport protos */
25  TRANSPORT_TX_DEQUEUE, /**< unreliable transport protos */
26  TRANSPORT_TX_INTERNAL, /**< apps acting as transports */
27  TRANSPORT_TX_DGRAM, /**< datagram mode */
30 
32 {
33  TRANSPORT_SERVICE_VC, /**< virtual circuit service */
34  TRANSPORT_SERVICE_CL, /**< connectionless service */
35  TRANSPORT_SERVICE_APP, /**< app transport service */
38 
39 /*
40  * Transport protocol virtual function table
41  */
42 /* *INDENT-OFF* */
43 typedef struct _transport_proto_vft
44 {
45  /*
46  * Setup
47  */
48  u32 (*bind) (u32 session_index, transport_endpoint_t * lcl);
49  u32 (*unbind) (u32);
50  int (*open) (transport_endpoint_cfg_t * rmt);
51  void (*close) (u32 conn_index, u32 thread_index);
52  void (*cleanup) (u32 conn_index, u32 thread_index);
53  clib_error_t *(*enable) (vlib_main_t * vm, u8 is_en);
54 
55  /*
56  * Transmission
57  */
58 
59  u32 (*push_header) (transport_connection_t * tconn, vlib_buffer_t * b);
60  u16 (*send_mss) (transport_connection_t * tc);
61  u32 (*send_space) (transport_connection_t * tc);
62  u32 (*tx_fifo_offset) (transport_connection_t * tc);
63  void (*update_time) (f64 time_now, u8 thread_index);
64  void (*flush_data) (transport_connection_t *tconn);
65 
66  /*
67  * Connection retrieval
68  */
69  transport_connection_t *(*get_connection) (u32 conn_idx, u32 thread_idx);
70  transport_connection_t *(*get_listener) (u32 conn_index);
71  transport_connection_t *(*get_half_open) (u32 conn_index);
72 
73  /*
74  * Format
75  */
76  u8 *(*format_connection) (u8 * s, va_list * args);
77  u8 *(*format_listener) (u8 * s, va_list * args);
78  u8 *(*format_half_open) (u8 * s, va_list * args);
79 
80  /*
81  * Properties
82  */
83  transport_tx_fn_type_t tx_type;
84  transport_service_type_t service_type;
86 /* *INDENT-ON* */
87 
89 
90 #define transport_proto_foreach(VAR, BODY) \
91 do { \
92  for (VAR = 0; VAR < vec_len (tp_vfts); VAR++) \
93  if (tp_vfts[VAR].push_header != 0) \
94  do { BODY; } while (0); \
95 } while (0)
96 
98  const transport_proto_vft_t * vft,
99  fib_protocol_t fib_proto, u32 output_node);
103 void transport_update_time (f64 time_now, u8 thread_index);
104 void transport_enable_disable (vlib_main_t * vm, u8 is_en);
105 
108 {
109 #if TRANSPORT_DEBUG
110  return tc->elog_track.track_index_plus_one - 1;
111 #else
112  return ~0;
113 #endif
114 }
115 
117  u32 rate_bytes_per_sec,
118  u32 initial_bucket, u64 time_now);
119 /**
120  * Initialize tx pacer for connection
121  *
122  * @param tc transport connection
123  * @param rate_bytes_per_second initial byte rate
124  * @param burst_bytes initial burst size in bytes
125  */
127  u32 rate_bytes_per_sec,
128  u32 initial_bucket);
129 
130 /**
131  * Update tx pacer pacing rate
132  *
133  * @param tc transport connection
134  * @param bytes_per_sec new pacing rate
135  */
137  u64 bytes_per_sec);
138 
139 /**
140  * Get maximum tx burst allowed for transport connection
141  *
142  * @param tc transport connection
143  * @param time_now current cpu time as returned by @ref clib_cpu_time_now
144  * @param mss transport's mss
145  */
147  u64 time_now, u16 mss);
148 
150  u64 time_now);
151 
152 /**
153  * Initialize period for tx pacers
154  *
155  * Defines a unit of time with respect to number of cpu cycles that is to
156  * be used by all tx pacers.
157  */
159 
160 /**
161  * Check if transport connection is paced
162  */
165 {
166  return (tc->flags & TRANSPORT_CONNECTION_F_IS_TX_PACED);
167 }
168 
169 u8 *format_transport_pacer (u8 * s, va_list * args);
170 
171 /**
172  * Update tx byte stats for transport connection
173  *
174  * If tx pacing is enabled, this also updates pacer bucket to account for the
175  * amount of bytes that have been sent.
176  *
177  * @param tc transport connection
178  * @param pkts packets recently sent
179  * @param bytes bytes recently sent
180  */
182  u32 bytes);
183 
184 void
186  u32 bytes);
187 
188 #endif /* SRC_VNET_SESSION_TRANSPORT_INTERFACE_H_ */
189 
190 /*
191  * fd.io coding-style-patch-verification: ON
192  *
193  * Local Variables:
194  * eval: (c-set-style "gnu")
195  * End:
196  */
virtual circuit service
struct _transport_connection transport_connection_t
unsigned long u64
Definition: types.h:89
struct _transport_proto_vft transport_proto_vft_t
static u8 transport_connection_is_tx_paced(transport_connection_t *tc)
Check if transport connection is paced.
enum transport_service_type_ transport_service_type_t
unsigned char u8
Definition: types.h:56
app transport service
enum fib_protocol_t_ fib_protocol_t
Protocol Type.
double f64
Definition: types.h:142
void transport_enable_disable(vlib_main_t *vm, u8 is_en)
Definition: transport.c:636
connectionless service
u32 transport_connection_snd_space(transport_connection_t *tc, u64 time_now, u16 mss)
Get maximum tx burst allowed for transport connection.
Definition: transport.c:585
u32 transport_connection_tx_pacer_burst(transport_connection_t *tc, u64 time_now)
Definition: transport.c:577
#define always_inline
Definition: clib.h:98
void transport_connection_tx_pacer_init(transport_connection_t *tc, u32 rate_bytes_per_sec, u32 initial_bucket)
Initialize tx pacer for connection.
Definition: transport.c:555
unsigned int u32
Definition: types.h:88
void transport_update_time(f64 time_now, u8 thread_index)
Definition: transport.c:625
#define TRANSPORT_CONNECTION_F_IS_TX_PACED
Definition: transport.h:104
enum transport_dequeue_type_ transport_tx_fn_type_t
void transport_connection_update_tx_stats(transport_connection_t *tc, u32 bytes)
Update tx byte stats for transport connection.
Definition: transport.c:603
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:238
void transport_init_tx_pacers_period(void)
Initialize period for tx pacers.
Definition: transport.c:618
transport_proto_vft_t * tp_vfts
Per-type vector of transport protocol virtual function tables.
Definition: transport.c:23
unsigned short u16
Definition: types.h:57
static void cleanup(void)
Definition: client.c:130
reliable transport protos
static u32 transport_elog_track_index(transport_connection_t *tc)
transport_tx_fn_type_t transport_protocol_tx_fn_type(transport_proto_t tp)
Definition: transport.c:270
void transport_connection_tx_pacer_update(transport_connection_t *tc, u64 bytes_per_sec)
Update tx pacer pacing rate.
Definition: transport.c:567
vlib_main_t * vm
Definition: buffer.c:301
apps acting as transports
transport_service_type_
transport_dequeue_type_
void transport_connection_tx_pacer_update_bytes(transport_connection_t *tc, u32 bytes)
Definition: transport.c:611
transport_proto_vft_t * transport_protocol_get_vft(transport_proto_t tp)
Get transport virtual function table.
Definition: transport.c:256
unreliable transport protos
enum _transport_proto transport_proto_t
transport_service_type_t transport_protocol_service_type(transport_proto_t)
Definition: transport.c:264
u8 * format_transport_pacer(u8 *s, va_list *args)
Definition: transport.c:491
void transport_connection_tx_pacer_reset(transport_connection_t *tc, u32 rate_bytes_per_sec, u32 initial_bucket, u64 time_now)
Definition: transport.c:538