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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
16 #ifndef VNET_VNET_URI_TRANSPORT_TYPES_H_
17 #define VNET_VNET_URI_TRANSPORT_TYPES_H_
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>
25 #define TRANSPORT_MAX_HDRS_LEN 140 /* Max number of bytes for headers */
28 typedef enum transport_dequeue_type_
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 */
35 } transport_tx_fn_type_t;
37 typedef enum transport_service_type_
39 TRANSPORT_SERVICE_VC, /**< virtual circuit service */
40 TRANSPORT_SERVICE_CL, /**< connectionless service */
41 TRANSPORT_SERVICE_APP, /**< app transport service */
43 } transport_service_type_t;
45 typedef enum transport_connection_flags_
47 TRANSPORT_CONNECTION_F_IS_TX_PACED = 1 << 0,
49 * Don't register connection in lookup. Does not apply to local apps
50 * and transports using the network layer (udp/tcp)
52 TRANSPORT_CONNECTION_F_NO_LOOKUP = 1 << 1,
54 * Connection descheduled by the session layer.
56 TRANSPORT_CONNECTION_F_DESCHED = 1 << 2,
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
62 TRANSPORT_CONNECTION_F_CLESS = 1 << 3,
63 } transport_connection_flags_t;
65 typedef struct _spacer
69 clib_us_time_t last_update;
70 f32 tokens_per_period;
74 #define TRANSPORT_CONN_ID_LEN 44
77 * Protocol independent transport properties associated to a session
79 typedef struct _transport_connection
85 * Network connection ID tuple
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
100 * Opaque connection ID
102 u8 opaque_conn_id[TRANSPORT_CONN_ID_LEN];
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 u8 dscp; /**< Differentiated Services Code Point */
111 /*fib_node_index_t rmt_fei;
114 spacer_t pacer; /**< Simple transport pacer */
117 elog_track_t elog_track; /**< Event logging */
118 u32 cc_stat_tstamp; /**< CC stats timestamp */
122 * Transport specific state starts in next cache line. Meant to avoid
123 * alignment surprises in transports when base class changes.
125 CLIB_CACHE_LINE_ALIGN_MARK (end);
127 /** Macros for 'derived classes' where base is named "connection" */
128 #define c_lcl_ip connection.lcl_ip
129 #define c_rmt_ip connection.rmt_ip
130 #define c_lcl_ip4 connection.lcl_ip.ip4
131 #define c_rmt_ip4 connection.rmt_ip.ip4
132 #define c_lcl_ip6 connection.lcl_ip.ip6
133 #define c_rmt_ip6 connection.rmt_ip.ip6
134 #define c_lcl_port connection.lcl_port
135 #define c_rmt_port connection.rmt_port
136 #define c_proto connection.proto
137 #define c_fib_index connection.fib_index
138 #define c_s_index connection.s_index
139 #define c_c_index connection.c_index
140 #define c_is_ip4 connection.is_ip4
141 #define c_thread_index connection.thread_index
142 #define c_elog_track connection.elog_track
143 #define c_cc_stat_tstamp connection.cc_stat_tstamp
144 #define c_rmt_fei connection.rmt_fei
145 #define c_rmt_dpo connection.rmt_dpo
146 #define c_opaque_id connection.opaque_conn_id
147 #define c_stats connection.stats
148 #define c_pacer connection.pacer
149 #define c_flags connection.flags
150 #define c_dscp connection.dscp
151 #define s_ho_handle pacer.bytes_per_sec
152 } transport_connection_t;
154 STATIC_ASSERT (STRUCT_OFFSET_OF (transport_connection_t, s_index)
155 == TRANSPORT_CONN_ID_LEN, "update conn id len");
157 /* Warn if size changes. Two cache lines is already generous, hopefully we
158 * won't have to outgrow that. */
159 STATIC_ASSERT (sizeof (transport_connection_t) <= 128,
160 "moved into 3rd cache line");
162 #define foreach_transport_proto \
163 _ (TCP, "tcp", "T") \
164 _ (UDP, "udp", "U") \
165 _ (NONE, "ct", "C") \
166 _ (TLS, "tls", "J") \
167 _ (QUIC, "quic", "Q") \
168 _ (DTLS, "dtls", "D") \
169 _ (SRTP, "srtp", "R")
171 typedef enum _transport_proto
173 #define _(sym, str, sstr) TRANSPORT_PROTO_ ## sym,
174 foreach_transport_proto
178 u8 *format_transport_proto (u8 * s, va_list * args);
179 u8 *format_transport_proto_short (u8 * s, va_list * args);
180 u8 *format_transport_connection (u8 * s, va_list * args);
181 u8 *format_transport_listen_connection (u8 * s, va_list * args);
182 u8 *format_transport_half_open_connection (u8 * s, va_list * args);
184 uword unformat_transport_proto (unformat_input_t * input, va_list * args);
185 u8 *format_transport_protos (u8 * s, va_list * args);
187 #define foreach_transport_endpoint_fields \
188 _(ip46_address_t, ip) /**< ip address in net order */ \
189 _(u16, port) /**< port in net order */ \
190 _(u8, is_ip4) /**< set if ip4 */ \
191 _(u32, sw_if_index) /**< interface endpoint is associated with */ \
192 _(u32, fib_index) /**< fib table endpoint is associated with */ \
194 typedef struct transport_endpoint_
196 #define _(type, name) type name;
197 foreach_transport_endpoint_fields
199 } transport_endpoint_t;
201 typedef enum transport_endpt_cfg_flags_
203 TRANSPORT_CFG_F_CONNECTED = 1 << 0,
204 TRANSPORT_CFG_F_UNIDIRECTIONAL = 1 << 1,
205 } transport_endpt_cfg_flags_t;
207 /* clang-format off */
208 #define foreach_transport_endpoint_cfg_fields \
209 foreach_transport_endpoint_fields \
210 _ (transport_endpoint_t, peer) \
211 _ (u32, next_node_index) \
212 _ (u32, next_node_opaque) \
215 _ (u8, transport_flags) \
216 /* clang-format on */
218 typedef struct transport_endpoint_pair_
220 #define _(type, name) type name;
221 foreach_transport_endpoint_cfg_fields
223 } transport_endpoint_cfg_t;
225 #define foreach_transport_endpt_cfg_flags \
230 typedef enum transport_endpt_attr_flag_bit_
232 #define _(name) TRANSPORT_ENDPT_ATTR_F_BIT_##name,
233 foreach_transport_endpt_cfg_flags
235 } __clib_packed transport_endpt_attr_flag_bit_t;
237 typedef enum transport_endpt_attr_flag_
240 TRANSPORT_ENDPT_ATTR_F_##name = 1 << TRANSPORT_ENDPT_ATTR_F_BIT_##name,
241 foreach_transport_endpt_cfg_flags
243 } __clib_packed transport_endpt_attr_flag_t;
245 #define foreach_transport_attr_fields \
246 _ (u64, next_output_node, NEXT_OUTPUT_NODE) \
248 _ (u8, flags, FLAGS) \
249 _ (u8, cc_algo, CC_ALGO)
251 typedef enum transport_endpt_attr_type_
253 #define _(type, name, str) TRANSPORT_ENDPT_ATTR_##str,
254 foreach_transport_attr_fields
256 } __clib_packed transport_endpt_attr_type_t;
258 typedef struct transport_endpt_attr_
260 transport_endpt_attr_type_t type;
263 #define _(type, name, str) type name;
264 foreach_transport_attr_fields
267 } transport_endpt_attr_t;
269 typedef enum transport_endpt_ext_cfg_type_
271 TRANSPORT_ENDPT_EXT_CFG_NONE,
272 TRANSPORT_ENDPT_EXT_CFG_CRYPTO,
273 } transport_endpt_ext_cfg_type_t;
275 typedef struct transport_endpt_crypto_cfg_
279 u8 hostname[256]; /**< full domain len is 255 as per rfc 3986 */
280 } transport_endpt_crypto_cfg_t;
282 typedef struct transport_endpt_ext_cfg_
288 transport_endpt_crypto_cfg_t crypto;
291 } transport_endpt_ext_cfg_t;
293 typedef clib_bihash_24_8_t transport_endpoint_table_t;
295 #define ENDPOINT_INVALID_INDEX ((u32)~0)
298 transport_connection_fib_proto (transport_connection_t * tc)
300 return tc->is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
304 transport_endpoint_fib_proto (transport_endpoint_t * tep)
306 return tep->is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
309 u8 transport_protocol_is_cl (transport_proto_t tp);
310 transport_service_type_t transport_protocol_service_type (transport_proto_t);
311 transport_tx_fn_type_t transport_protocol_tx_fn_type (transport_proto_t tp);
313 #endif /* VNET_VNET_URI_TRANSPORT_TYPES_H_ */
316 * fd.io coding-style-patch-verification: ON
319 * eval: (c-set-style "gnu")