FD.io VPP  v21.01.1
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
150 #define c_s_ho_handle connection.pacer.bytes_per_sec
152 
154  == TRANSPORT_CONN_ID_LEN, "update conn id len");
155 
156 /* Warn if size changes. Two cache lines is already generous, hopefully we
157  * won't have to outgrow that. */
158 STATIC_ASSERT (sizeof (transport_connection_t) <= 128,
159  "moved into 3rd cache line");
160 
161 #define foreach_transport_proto \
162  _(TCP, "tcp", "T") \
163  _(UDP, "udp", "U") \
164  _(NONE, "ct", "C") \
165  _(TLS, "tls", "J") \
166  _(QUIC, "quic", "Q") \
167 
168 typedef enum _transport_proto
169 {
170 #define _(sym, str, sstr) TRANSPORT_PROTO_ ## sym,
172 #undef _
174 
175 u8 *format_transport_proto (u8 * s, va_list * args);
176 u8 *format_transport_proto_short (u8 * s, va_list * args);
177 u8 *format_transport_connection (u8 * s, va_list * args);
178 u8 *format_transport_listen_connection (u8 * s, va_list * args);
179 u8 *format_transport_half_open_connection (u8 * s, va_list * args);
180 
181 uword unformat_transport_proto (unformat_input_t * input, va_list * args);
182 u8 *format_transport_protos (u8 * s, va_list * args);
183 
184 #define foreach_transport_endpoint_fields \
185  _(ip46_address_t, ip) /**< ip address in net order */ \
186  _(u16, port) /**< port in net order */ \
187  _(u8, is_ip4) /**< set if ip4 */ \
188  _(u32, sw_if_index) /**< interface endpoint is associated with */ \
189  _(u32, fib_index) /**< fib table endpoint is associated with */ \
190 
191 typedef struct transport_endpoint_
192 {
193 #define _(type, name) type name;
195 #undef _
197 
198 typedef enum transport_endpt_cfg_flags_
199 {
200  TRANSPORT_CFG_F_CONNECTED = 1 << 0,
203 
204 #define foreach_transport_endpoint_cfg_fields \
205  foreach_transport_endpoint_fields \
206  _(transport_endpoint_t, peer) \
207  _(u16, mss) \
208  _(u8, transport_flags) \
209 
210 typedef struct transport_endpoint_pair_
211 {
212 #define _(type, name) type name;
214 #undef _
216 
217 typedef clib_bihash_24_8_t transport_endpoint_table_t;
219 #define ENDPOINT_INVALID_INDEX ((u32)~0)
223 {
224  return tc->is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
225 }
226 
228 transport_endpoint_fib_proto (transport_endpoint_t * tep)
229 {
230  return tep->is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
231 }
232 
233 u8 transport_protocol_is_cl (transport_proto_t tp);
234 transport_service_type_t transport_protocol_service_type (transport_proto_t);
235 transport_tx_fn_type_t transport_protocol_tx_fn_type (transport_proto_t tp);
236 
237 #endif /* VNET_VNET_URI_TRANSPORT_TYPES_H_ */
238 
239 /*
240  * fd.io coding-style-patch-verification: ON
241  *
242  * Local Variables:
243  * eval: (c-set-style "gnu")
244  * End:
245  */
#define CLIB_CACHE_LINE_ALIGN_MARK(mark)
Definition: cache.h:60
uword unformat_transport_proto(unformat_input_t *input, va_list *args)
Definition: transport.c:155
vl_api_wireguard_peer_flags_t flags
Definition: wireguard.api:105
transport_dequeue_type_
static u8 transport_connection_fib_proto(transport_connection_t *tc)
transport_connection_flags_
unsigned long u64
Definition: types.h:89
struct transport_endpoint_ transport_endpoint_t
#define STRUCT_OFFSET_OF(t, f)
Definition: clib.h:70
struct _spacer spacer_t
unsigned char u8
Definition: types.h:56
#define foreach_transport_proto
Connection is "connection less".
enum transport_connection_flags_ transport_connection_flags_t
unsigned int u32
Definition: types.h:88
transport_service_type_t transport_protocol_service_type(transport_proto_t)
Definition: transport.c:290
u8 * format_transport_proto(u8 *s, va_list *args)
Definition: transport.c:52
vl_api_ip_proto_t proto
Definition: acl_types.api:51
struct _unformat_input_t unformat_input_t
unsigned short u16
Definition: types.h:57
signed long i64
Definition: types.h:78
#define foreach_transport_endpoint_cfg_fields
enum transport_service_type_ transport_service_type_t
#define always_inline
Definition: ipsec.h:28
u8 * format_transport_connection(u8 *s, va_list *args)
Definition: transport.c:80
app transport service
struct transport_endpoint_pair_ transport_endpoint_cfg_t
virtual circuit service
Don&#39;t register connection in lookup.
u8 * format_transport_protos(u8 *s, va_list *args)
Definition: transport.c:190
struct _transport_connection transport_connection_t
STATIC_ASSERT(sizeof(transport_connection_t)<=128, "moved into 3rd cache line")
#define foreach_transport_endpoint_fields
fib table endpoint is associated with
#define TRANSPORT_CONN_ID_LEN
transport_tx_fn_type_t transport_protocol_tx_fn_type(transport_proto_t tp)
Definition: transport.c:296
u8 * format_transport_listen_connection(u8 *s, va_list *args)
Definition: transport.c:110
apps acting as transports
datagram mode
enum _transport_proto transport_proto_t
reliable transport protos
float f32
Definition: types.h:143
transport_endpt_cfg_flags_
u64 uword
Definition: types.h:112
connectionless service
static u8 transport_endpoint_fib_proto(transport_endpoint_t *tep)
unreliable transport protos
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
u8 transport_protocol_is_cl(transport_proto_t tp)
Definition: transport.c:349
Connection descheduled by the session layer.
f64 end
end of the time range
Definition: mactime.api:44
u8 * format_transport_proto_short(u8 *s, va_list *args)
Definition: transport.c:65
clib_bihash_24_8_t transport_endpoint_table_t
enum transport_endpt_cfg_flags_ transport_endpt_cfg_flags_t
u8 * format_transport_half_open_connection(u8 *s, va_list *args)
Definition: transport.c:124
u64 clib_us_time_t
Definition: time.h:204
transport_service_type_
enum transport_dequeue_type_ transport_tx_fn_type_t