FD.io VPP  v21.10.1-2-g0a485f517
Vector Packet Processing
transport_types.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2016-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 VNET_VNET_URI_TRANSPORT_TYPES_H_
17 #define VNET_VNET_URI_TRANSPORT_TYPES_H_
18 
19 #include <vnet/vnet.h>
20 #include <vnet/ip/ip.h>
21 #include <vnet/tcp/tcp_debug.h>
22 #include <vppinfra/bihash_24_8.h>
23 
24 
25 #define TRANSPORT_MAX_HDRS_LEN 140 /* Max number of bytes for headers */
26 
27 
29 {
30  TRANSPORT_TX_PEEK, /**< reliable transport protos */
31  TRANSPORT_TX_DEQUEUE, /**< unreliable transport protos */
32  TRANSPORT_TX_INTERNAL, /**< apps acting as transports */
33  TRANSPORT_TX_DGRAM, /**< datagram mode */
36 
38 {
39  TRANSPORT_SERVICE_VC, /**< virtual circuit service */
40  TRANSPORT_SERVICE_CL, /**< connectionless service */
41  TRANSPORT_SERVICE_APP, /**< app transport service */
44 
46 {
48  /**
49  * Don't register connection in lookup. Does not apply to local apps
50  * and transports using the network layer (udp/tcp)
51  */
53  /**
54  * Connection descheduled by the session layer.
55  */
57  /**
58  * Connection is "connection less". Some important implications of that
59  * are that connections are not pinned to workers and listeners will
60  * have fifos associated to them
61  */
64 
65 typedef struct _spacer
66 {
67  u64 bytes_per_sec;
68  i64 bucket;
69  clib_us_time_t last_update;
70  f32 tokens_per_period;
71  u32 max_burst;
72 } spacer_t;
73 
74 #define TRANSPORT_CONN_ID_LEN 44
75 
76 /*
77  * Protocol independent transport properties associated to a session
78  */
79 typedef struct _transport_connection
80 {
81  /** Connection ID */
82  union
83  {
84  /*
85  * Network connection ID tuple
86  */
87  struct
88  {
89  ip46_address_t rmt_ip; /**< Remote IP */
90  ip46_address_t lcl_ip; /**< Local IP */
91  u32 fib_index; /**< Network namespace */
92  u16 rmt_port; /**< Remote port */
93  u16 lcl_port; /**< Local port */
94  u8 is_ip4; /**< Flag if IP4 connection */
95  u8 proto; /**< Protocol id */
96  u8 unused[2]; /**< First field after id wants to be
97  4-byte aligned) */
98  };
99  /*
100  * Opaque connection ID
101  */
102  u8 opaque_conn_id[TRANSPORT_CONN_ID_LEN];
103  };
104 
105  u32 s_index; /**< Parent session index */
106  u32 c_index; /**< Connection index in transport pool */
107  u32 thread_index; /**< Worker-thread index */
108  u8 flags; /**< Transport specific flags */
109 
110  /*fib_node_index_t rmt_fei;
111  dpo_id_t rmt_dpo; */
112 
113  spacer_t pacer; /**< Simple transport pacer */
114 
115 #if TRANSPORT_DEBUG
116  elog_track_t elog_track; /**< Event logging */
117  u32 cc_stat_tstamp; /**< CC stats timestamp */
118 #endif
119 
120  /**
121  * Transport specific state starts in next cache line. Meant to avoid
122  * alignment surprises in transports when base class changes.
123  */
125 
126  /** Macros for 'derived classes' where base is named "connection" */
127 #define c_lcl_ip connection.lcl_ip
128 #define c_rmt_ip connection.rmt_ip
129 #define c_lcl_ip4 connection.lcl_ip.ip4
130 #define c_rmt_ip4 connection.rmt_ip.ip4
131 #define c_lcl_ip6 connection.lcl_ip.ip6
132 #define c_rmt_ip6 connection.rmt_ip.ip6
133 #define c_lcl_port connection.lcl_port
134 #define c_rmt_port connection.rmt_port
135 #define c_proto connection.proto
136 #define c_fib_index connection.fib_index
137 #define c_s_index connection.s_index
138 #define c_c_index connection.c_index
139 #define c_is_ip4 connection.is_ip4
140 #define c_thread_index connection.thread_index
141 #define c_elog_track connection.elog_track
142 #define c_cc_stat_tstamp connection.cc_stat_tstamp
143 #define c_rmt_fei connection.rmt_fei
144 #define c_rmt_dpo connection.rmt_dpo
145 #define c_opaque_id connection.opaque_conn_id
146 #define c_stats connection.stats
147 #define c_pacer connection.pacer
148 #define c_flags connection.flags
149 #define s_ho_handle pacer.bytes_per_sec
151 
153  == TRANSPORT_CONN_ID_LEN, "update conn id len");
154 
155 /* Warn if size changes. Two cache lines is already generous, hopefully we
156  * won't have to outgrow that. */
157 STATIC_ASSERT (sizeof (transport_connection_t) <= 128,
158  "moved into 3rd cache line");
159 
160 #define foreach_transport_proto \
161  _ (TCP, "tcp", "T") \
162  _ (UDP, "udp", "U") \
163  _ (NONE, "ct", "C") \
164  _ (TLS, "tls", "J") \
165  _ (QUIC, "quic", "Q") \
166  _ (DTLS, "dtls", "D") \
167  _ (SRTP, "srtp", "R")
168 
169 typedef enum _transport_proto
170 {
171 #define _(sym, str, sstr) TRANSPORT_PROTO_ ## sym,
173 #undef _
175 
176 u8 *format_transport_proto (u8 * s, va_list * args);
177 u8 *format_transport_proto_short (u8 * s, va_list * args);
178 u8 *format_transport_connection (u8 * s, va_list * args);
179 u8 *format_transport_listen_connection (u8 * s, va_list * args);
180 u8 *format_transport_half_open_connection (u8 * s, va_list * args);
181 
182 uword unformat_transport_proto (unformat_input_t * input, va_list * args);
183 u8 *format_transport_protos (u8 * s, va_list * args);
184 
185 #define foreach_transport_endpoint_fields \
186  _(ip46_address_t, ip) /**< ip address in net order */ \
187  _(u16, port) /**< port in net order */ \
188  _(u8, is_ip4) /**< set if ip4 */ \
189  _(u32, sw_if_index) /**< interface endpoint is associated with */ \
190  _(u32, fib_index) /**< fib table endpoint is associated with */ \
191 
192 typedef struct transport_endpoint_
193 {
194 #define _(type, name) type name;
196 #undef _
198 
199 typedef enum transport_endpt_cfg_flags_
200 {
201  TRANSPORT_CFG_F_CONNECTED = 1 << 0,
204 
205 /* clang-format off */
206 #define foreach_transport_endpoint_cfg_fields \
207  foreach_transport_endpoint_fields \
208  _ (transport_endpoint_t, peer) \
209  _ (u32, next_node_index) \
210  _ (u32, next_node_opaque) \
211  _ (u16, mss) \
212  _ (u8, transport_flags) \
213 /* clang-format on */
214 
215 typedef struct transport_endpoint_pair_
216 {
217 #define _(type, name) type name;
219 #undef _
221 
222 #define foreach_transport_endpt_cfg_flags \
223  _ (CSUM_OFFLOAD) \
224  _ (GSO) \
225  _ (RATE_SAMPLING)
226 
228 {
229 #define _(name) TRANSPORT_ENDPT_ATTR_F_BIT_##name,
231 #undef _
232 } __clib_packed transport_endpt_attr_flag_bit_t;
233 
234 typedef enum transport_endpt_attr_flag_
235 {
236 #define _(name) \
237  TRANSPORT_ENDPT_ATTR_F_##name = 1 << TRANSPORT_ENDPT_ATTR_F_BIT_##name,
239 #undef _
240 } __clib_packed transport_endpt_attr_flag_t;
241 
242 #define foreach_transport_attr_fields \
243  _ (u64, next_output_node, NEXT_OUTPUT_NODE) \
244  _ (u16, mss, MSS) \
245  _ (u8, flags, FLAGS) \
246  _ (u8, cc_algo, CC_ALGO)
247 
248 typedef enum transport_endpt_attr_type_
249 {
250 #define _(type, name, str) TRANSPORT_ENDPT_ATTR_##str,
252 #undef _
253 } __clib_packed transport_endpt_attr_type_t;
254 
255 typedef struct transport_endpt_attr_
256 {
258  union
259  {
260 #define _(type, name, str) type name;
262 #undef _
263  };
265 
267 {
271 
272 typedef struct transport_endpt_crypto_cfg_
273 {
276  u8 hostname[256]; /**< full domain len is 255 as per rfc 3986 */
278 
279 typedef struct transport_endpt_ext_cfg_
280 {
281  u16 type;
283  union
284  {
286  u8 data[0];
287  };
289 
290 typedef clib_bihash_24_8_t transport_endpoint_table_t;
291 
292 #define ENDPOINT_INVALID_INDEX ((u32)~0)
293 
296 {
297  return tc->is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
298 }
299 
302 {
303  return tep->is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
304 }
305 
309 
310 #endif /* VNET_VNET_URI_TRANSPORT_TYPES_H_ */
311 
312 /*
313  * fd.io coding-style-patch-verification: ON
314  *
315  * Local Variables:
316  * eval: (c-set-style "gnu")
317  * End:
318  */
transport_endpt_attr_flag_bit_
transport_endpt_attr_flag_bit_
Definition: transport_types.h:228
bihash_24_8.h
transport_protocol_is_cl
u8 transport_protocol_is_cl(transport_proto_t tp)
Definition: transport.c:356
thread_index
u32 thread_index
Definition: nat44_ei_hairpinning.c:495
transport_protocol_service_type
transport_service_type_t transport_protocol_service_type(transport_proto_t)
Definition: transport.c:290
transport_endpt_attr_type_
transport_endpt_attr_type_
Definition: transport_types.h:249
transport_endpt_cfg_flags_
transport_endpt_cfg_flags_
Definition: transport_types.h:200
foreach_transport_proto
#define foreach_transport_proto
Definition: transport_types.h:160
CLIB_CACHE_LINE_ALIGN_MARK
#define CLIB_CACHE_LINE_ALIGN_MARK(mark)
Definition: cache.h:60
transport_dequeue_type_
transport_dequeue_type_
Definition: transport_types.h:28
format_transport_proto
u8 * format_transport_proto(u8 *s, va_list *args)
Definition: transport.c:52
transport_service_type_t
enum transport_service_type_ transport_service_type_t
TRANSPORT_ENDPT_EXT_CFG_NONE
@ TRANSPORT_ENDPT_EXT_CFG_NONE
Definition: transport_types.h:269
transport_endpt_ext_cfg_::type
u16 type
Definition: transport_types.h:282
u16
unsigned short u16
Definition: types.h:57
format_transport_proto_short
u8 * format_transport_proto_short(u8 *s, va_list *args)
Definition: transport.c:65
f32
float f32
Definition: types.h:143
transport_service_type_
transport_service_type_
Definition: transport_types.h:37
transport_endpt_ext_cfg_::data
u8 data[0]
Definition: transport_types.h:287
transport_connection_t
struct _transport_connection transport_connection_t
unformat_input_t
struct _unformat_input_t unformat_input_t
transport_endpoint_pair_
Definition: transport_types.h:216
TRANSPORT_TX_N_FNS
@ TRANSPORT_TX_N_FNS
Definition: transport_types.h:34
i64
signed long i64
Definition: types.h:78
format_transport_protos
u8 * format_transport_protos(u8 *s, va_list *args)
Definition: transport.c:190
transport_endpt_crypto_cfg_::hostname
u8 hostname[256]
full domain len is 255 as per rfc 3986
Definition: transport_types.h:277
transport_endpt_ext_cfg_type_
transport_endpt_ext_cfg_type_
Definition: transport_types.h:267
foreach_transport_endpoint_fields
#define foreach_transport_endpoint_fields
fib table endpoint is associated with
Definition: transport_types.h:185
transport_tx_fn_type_t
enum transport_dequeue_type_ transport_tx_fn_type_t
STRUCT_OFFSET_OF
#define STRUCT_OFFSET_OF(t, f)
Definition: clib.h:73
TRANSPORT_CONNECTION_F_CLESS
@ TRANSPORT_CONNECTION_F_CLESS
Connection is "connection less".
Definition: transport_types.h:62
elog_track
static void elog_track(elog_main_t *em, elog_event_type_t *type, elog_track_t *track, u32 data)
Log a single-datum event to a specific track, non-inline version.
Definition: elog.h:398
transport_endpt_attr_::type
transport_endpt_attr_type_t type
Definition: transport_types.h:258
transport_endpt_ext_cfg_
Definition: transport_types.h:280
transport_connection_flags_
transport_connection_flags_
Definition: transport_types.h:45
foreach_transport_endpt_cfg_flags
#define foreach_transport_endpt_cfg_flags
Definition: transport_types.h:223
transport_endpoint_fib_proto
static u8 transport_endpoint_fib_proto(transport_endpoint_t *tep)
Definition: transport_types.h:302
transport_endpt_crypto_cfg_t
struct transport_endpt_crypto_cfg_ transport_endpt_crypto_cfg_t
end
f64 end
end of the time range
Definition: mactime.api:44
transport_endpt_attr_
Definition: transport_types.h:256
uword
u64 uword
Definition: types.h:112
transport_endpt_ext_cfg_::len
u16 len
Definition: transport_types.h:283
foreach_transport_attr_fields
#define foreach_transport_attr_fields
Definition: transport_types.h:243
TRANSPORT_SERVICE_APP
@ TRANSPORT_SERVICE_APP
app transport service
Definition: transport_types.h:41
TRANSPORT_CONNECTION_F_IS_TX_PACED
@ TRANSPORT_CONNECTION_F_IS_TX_PACED
Definition: transport_types.h:47
TRANSPORT_CFG_F_CONNECTED
@ TRANSPORT_CFG_F_CONNECTED
Definition: transport_types.h:202
transport_endpt_crypto_cfg_::ckpair_index
u32 ckpair_index
Definition: transport_types.h:275
spacer_t
struct _spacer spacer_t
transport_endpt_crypto_cfg_::crypto_engine
u8 crypto_engine
Definition: transport_types.h:276
FIB_PROTOCOL_IP4
@ FIB_PROTOCOL_IP4
Definition: fib_types.h:36
transport_connection_flags_t
enum transport_connection_flags_ transport_connection_flags_t
transport_protocol_tx_fn_type
transport_tx_fn_type_t transport_protocol_tx_fn_type(transport_proto_t tp)
Definition: transport.c:296
format_transport_listen_connection
u8 * format_transport_listen_connection(u8 *s, va_list *args)
Definition: transport.c:110
transport_endpoint_table_t
clib_bihash_24_8_t transport_endpoint_table_t
Definition: transport_types.h:291
TRANSPORT_TX_INTERNAL
@ TRANSPORT_TX_INTERNAL
apps acting as transports
Definition: transport_types.h:32
unformat_transport_proto
uword unformat_transport_proto(unformat_input_t *input, va_list *args)
Definition: transport.c:155
TRANSPORT_SERVICE_VC
@ TRANSPORT_SERVICE_VC
virtual circuit service
Definition: transport_types.h:39
always_inline
#define always_inline
Definition: rdma_mlx5dv.h:23
TRANSPORT_TX_DGRAM
@ TRANSPORT_TX_DGRAM
datagram mode
Definition: transport_types.h:33
transport_endpt_ext_cfg_t
struct transport_endpt_ext_cfg_ transport_endpt_ext_cfg_t
TRANSPORT_CONNECTION_F_NO_LOOKUP
@ TRANSPORT_CONNECTION_F_NO_LOOKUP
Don't register connection in lookup.
Definition: transport_types.h:52
elog_track_t
Definition: elog.h:113
u64
unsigned long u64
Definition: types.h:89
TRANSPORT_TX_PEEK
@ TRANSPORT_TX_PEEK
reliable transport protos
Definition: transport_types.h:30
transport_endpoint_t
struct transport_endpoint_ transport_endpoint_t
format_transport_half_open_connection
u8 * format_transport_half_open_connection(u8 *s, va_list *args)
Definition: transport.c:124
ip.h
u32
unsigned int u32
Definition: types.h:88
transport_endpoint_
Definition: transport_types.h:193
transport_proto_t
enum _transport_proto transport_proto_t
FIB_PROTOCOL_IP6
@ FIB_PROTOCOL_IP6
Definition: fib_types.h:37
transport_endpt_attr_flag_
transport_endpt_attr_flag_
Definition: transport_types.h:235
TRANSPORT_N_SERVICES
@ TRANSPORT_N_SERVICES
Definition: transport_types.h:42
TRANSPORT_CFG_F_UNIDIRECTIONAL
@ TRANSPORT_CFG_F_UNIDIRECTIONAL
Definition: transport_types.h:203
TRANSPORT_SERVICE_CL
@ TRANSPORT_SERVICE_CL
connectionless service
Definition: transport_types.h:40
clib_us_time_t
u64 clib_us_time_t
Definition: time.h:204
transport_endpoint_cfg_t
struct transport_endpoint_pair_ transport_endpoint_cfg_t
u8
unsigned char u8
Definition: types.h:56
transport_endpt_attr_type_t
enum transport_endpt_attr_type_ transport_endpt_attr_type_t
transport_endpt_cfg_flags_t
enum transport_endpt_cfg_flags_ transport_endpt_cfg_flags_t
STATIC_ASSERT
STATIC_ASSERT(sizeof(transport_connection_t)<=128, "moved into 3rd cache line")
foreach_transport_endpoint_cfg_fields
#define foreach_transport_endpoint_cfg_fields
Definition: transport_types.h:207
transport_endpt_crypto_cfg_
Definition: transport_types.h:273
transport_endpt_ext_cfg_type_t
enum transport_endpt_ext_cfg_type_ transport_endpt_ext_cfg_type_t
transport_endpt_attr_flag_bit_t
enum transport_endpt_attr_flag_bit_ transport_endpt_attr_flag_bit_t
vnet.h
transport_endpt_attr_flag_t
enum transport_endpt_attr_flag_ transport_endpt_attr_flag_t
format_transport_connection
u8 * format_transport_connection(u8 *s, va_list *args)
Definition: transport.c:80
proto
vl_api_ip_proto_t proto
Definition: acl_types.api:51
tcp_debug.h
TRANSPORT_TX_DEQUEUE
@ TRANSPORT_TX_DEQUEUE
unreliable transport protos
Definition: transport_types.h:31
transport_endpt_attr_t
struct transport_endpt_attr_ transport_endpt_attr_t
TRANSPORT_CONNECTION_F_DESCHED
@ TRANSPORT_CONNECTION_F_DESCHED
Connection descheduled by the session layer.
Definition: transport_types.h:56
transport_endpt_ext_cfg_::crypto
transport_endpt_crypto_cfg_t crypto
Definition: transport_types.h:286
TRANSPORT_CONN_ID_LEN
#define TRANSPORT_CONN_ID_LEN
Definition: transport_types.h:74
TRANSPORT_ENDPT_EXT_CFG_CRYPTO
@ TRANSPORT_ENDPT_EXT_CFG_CRYPTO
Definition: transport_types.h:270
flags
vl_api_wireguard_peer_flags_t flags
Definition: wireguard.api:105
transport_connection_fib_proto
static u8 transport_connection_fib_proto(transport_connection_t *tc)
Definition: transport_types.h:296