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>
23 #define TRANSPORT_MAX_HDRS_LEN 140 /* Max number of bytes for headers */
26 typedef enum transport_dequeue_type_
28 TRANSPORT_TX_PEEK, /**< reliable transport protos */
29 TRANSPORT_TX_DEQUEUE, /**< unreliable transport protos */
30 TRANSPORT_TX_INTERNAL, /**< apps acting as transports */
31 TRANSPORT_TX_DGRAM, /**< datagram mode */
33 } transport_tx_fn_type_t;
35 typedef enum transport_service_type_
37 TRANSPORT_SERVICE_VC, /**< virtual circuit service */
38 TRANSPORT_SERVICE_CL, /**< connectionless service */
39 TRANSPORT_SERVICE_APP, /**< app transport service */
41 } transport_service_type_t;
43 typedef enum transport_connection_flags_
45 TRANSPORT_CONNECTION_F_IS_TX_PACED = 1 << 0,
47 * Don't register connection in lookup. Does not apply to local apps
48 * and transports using the network layer (udp/tcp)
50 TRANSPORT_CONNECTION_F_NO_LOOKUP = 1 << 1,
52 * Connection descheduled by the session layer.
54 TRANSPORT_CONNECTION_F_DESCHED = 1 << 2,
56 * Connection is "connection less". Some important implications of that
57 * are that connections are not pinned to workers and listeners will
58 * have fifos associated to them
60 TRANSPORT_CONNECTION_F_CLESS = 1 << 3,
61 } transport_connection_flags_t;
63 typedef struct _spacer
67 clib_us_time_t last_update;
68 f32 tokens_per_period;
72 #define TRANSPORT_CONN_ID_LEN 44
75 * Protocol independent transport properties associated to a session
77 typedef struct _transport_connection
83 * Network connection ID tuple
87 ip46_address_t rmt_ip; /**< Remote IP */
88 ip46_address_t lcl_ip; /**< Local IP */
89 u32 fib_index; /**< Network namespace */
90 u16 rmt_port; /**< Remote port */
91 u16 lcl_port; /**< Local port */
92 u8 is_ip4; /**< Flag if IP4 connection */
93 u8 proto; /**< Protocol id */
94 u8 unused[2]; /**< First field after id wants to be
98 * Opaque connection ID
100 u8 opaque_conn_id[TRANSPORT_CONN_ID_LEN];
103 u32 s_index; /**< Parent session index */
104 u32 c_index; /**< Connection index in transport pool */
105 u32 thread_index; /**< Worker-thread index */
106 u8 flags; /**< Transport specific flags */
108 /*fib_node_index_t rmt_fei;
111 spacer_t pacer; /**< Simple transport pacer */
114 elog_track_t elog_track; /**< Event logging */
115 u32 cc_stat_tstamp; /**< CC stats timestamp */
119 * Transport specific state starts in next cache line. Meant to avoid
120 * alignment surprises in transports when base class changes.
122 CLIB_CACHE_LINE_ALIGN_MARK (end);
124 /** Macros for 'derived classes' where base is named "connection" */
125 #define c_lcl_ip connection.lcl_ip
126 #define c_rmt_ip connection.rmt_ip
127 #define c_lcl_ip4 connection.lcl_ip.ip4
128 #define c_rmt_ip4 connection.rmt_ip.ip4
129 #define c_lcl_ip6 connection.lcl_ip.ip6
130 #define c_rmt_ip6 connection.rmt_ip.ip6
131 #define c_lcl_port connection.lcl_port
132 #define c_rmt_port connection.rmt_port
133 #define c_proto connection.proto
134 #define c_fib_index connection.fib_index
135 #define c_s_index connection.s_index
136 #define c_c_index connection.c_index
137 #define c_is_ip4 connection.is_ip4
138 #define c_thread_index connection.thread_index
139 #define c_elog_track connection.elog_track
140 #define c_cc_stat_tstamp connection.cc_stat_tstamp
141 #define c_rmt_fei connection.rmt_fei
142 #define c_rmt_dpo connection.rmt_dpo
143 #define c_opaque_id connection.opaque_conn_id
144 #define c_stats connection.stats
145 #define c_pacer connection.pacer
146 #define c_flags connection.flags
147 } transport_connection_t;
149 STATIC_ASSERT (STRUCT_OFFSET_OF (transport_connection_t, s_index)
150 == TRANSPORT_CONN_ID_LEN, "update conn id len");
152 /* Warn if size changes. Two cache lines is already generous, hopefully we
153 * won't have to outgrow that. */
154 STATIC_ASSERT (sizeof (transport_connection_t) <= 128,
155 "moved into 3rd cache line");
157 #define foreach_transport_proto \
162 _(UDPC, "udpc", "U") \
163 _(QUIC, "quic", "Q") \
165 typedef enum _transport_proto
167 #define _(sym, str, sstr) TRANSPORT_PROTO_ ## sym,
168 foreach_transport_proto
172 u8 *format_transport_proto (u8 * s, va_list * args);
173 u8 *format_transport_proto_short (u8 * s, va_list * args);
174 u8 *format_transport_connection (u8 * s, va_list * args);
175 u8 *format_transport_listen_connection (u8 * s, va_list * args);
176 u8 *format_transport_half_open_connection (u8 * s, va_list * args);
178 uword unformat_transport_proto (unformat_input_t * input, va_list * args);
179 u8 *format_transport_protos (u8 * s, va_list * args);
181 #define foreach_transport_endpoint_fields \
182 _(ip46_address_t, ip) /**< ip address in net order */ \
183 _(u16, port) /**< port in net order */ \
184 _(u8, is_ip4) /**< set if ip4 */ \
185 _(u32, sw_if_index) /**< interface endpoint is associated with */ \
186 _(u32, fib_index) /**< fib table endpoint is associated with */ \
188 typedef struct transport_endpoint_
190 #define _(type, name) type name;
191 foreach_transport_endpoint_fields
193 } transport_endpoint_t;
195 typedef enum transport_endpt_cfg_flags_
197 TRANSPORT_CFG_F_CONNECTED = 1 << 0,
198 } transport_endpt_cfg_flags_t;
200 #define foreach_transport_endpoint_cfg_fields \
201 foreach_transport_endpoint_fields \
202 _(transport_endpoint_t, peer) \
204 _(u8, transport_flags) \
206 typedef struct transport_endpoint_pair_
208 #define _(type, name) type name;
209 foreach_transport_endpoint_cfg_fields
211 } transport_endpoint_cfg_t;
213 typedef clib_bihash_24_8_t transport_endpoint_table_t;
215 #define ENDPOINT_INVALID_INDEX ((u32)~0)
218 transport_connection_fib_proto (transport_connection_t * tc)
220 return tc->is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
224 transport_endpoint_fib_proto (transport_endpoint_t * tep)
226 return tep->is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
229 u8 transport_protocol_is_cl (transport_proto_t tp);
230 u8 transport_half_open_has_fifos (transport_proto_t tp);
231 transport_service_type_t transport_protocol_service_type (transport_proto_t);
232 transport_tx_fn_type_t transport_protocol_tx_fn_type (transport_proto_t tp);
234 #endif /* VNET_VNET_URI_TRANSPORT_TYPES_H_ */
237 * fd.io coding-style-patch-verification: ON
240 * eval: (c-set-style "gnu")