FD.io VPP  v19.08.3-2-gbabecb413
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 
23 #define TRANSPORT_MAX_HDRS_LEN 100 /* Max number of bytes for headers */
24 
26 {
27  TRANSPORT_TX_PEEK, /**< reliable transport protos */
28  TRANSPORT_TX_DEQUEUE, /**< unreliable transport protos */
29  TRANSPORT_TX_INTERNAL, /**< apps acting as transports */
30  TRANSPORT_TX_DGRAM, /**< datagram mode */
33 
35 {
36  TRANSPORT_SERVICE_VC, /**< virtual circuit service */
37  TRANSPORT_SERVICE_CL, /**< connectionless service */
38  TRANSPORT_SERVICE_APP, /**< app transport service */
41 
43 {
45  TRANSPORT_CONNECTION_F_NO_LOOKUP = 1 << 1, /**< Don't register connection in lookup
46  Does not apply to local apps and
47  transports using the network layer (udp/tcp) */
49 
50 typedef struct _spacer
51 {
52  u64 bytes_per_sec;
53  u64 bucket;
54  clib_us_time_t last_update;
55  f32 tokens_per_period;
56 } spacer_t;
57 
58 #define TRANSPORT_CONN_ID_LEN 44
59 
60 /*
61  * Protocol independent transport properties associated to a session
62  */
63 typedef struct _transport_connection
64 {
65  /** Connection ID */
66  union
67  {
68  /*
69  * Network connection ID tuple
70  */
71  struct
72  {
73  ip46_address_t rmt_ip; /**< Remote IP */
74  ip46_address_t lcl_ip; /**< Local IP */
75  u32 fib_index; /**< Network namespace */
76  u16 rmt_port; /**< Remote port */
77  u16 lcl_port; /**< Local port */
78  u8 is_ip4; /**< Flag if IP4 connection */
79  u8 proto; /**< Protocol id */
80  u8 unused[2]; /**< First field after id wants to be
81  4-byte aligned) */
82  };
83  /*
84  * Opaque connection ID
85  */
86  u8 opaque_conn_id[TRANSPORT_CONN_ID_LEN];
87  };
88 
89  u32 s_index; /**< Parent session index */
90  u32 c_index; /**< Connection index in transport pool */
91  u32 thread_index; /**< Worker-thread index */
92  u8 flags; /**< Transport specific flags */
93 
94  /*fib_node_index_t rmt_fei;
95  dpo_id_t rmt_dpo; */
96 
97  spacer_t pacer; /**< Simple transport pacer */
98 
99 #if TRANSPORT_DEBUG
100  elog_track_t elog_track; /**< Event logging */
101  u32 cc_stat_tstamp; /**< CC stats timestamp */
102 #endif
103 
104  /**
105  * Transport specific state starts in next cache line. Meant to avoid
106  * alignment surprises in transports when base class changes.
107  */
109 
110  /** Macros for 'derived classes' where base is named "connection" */
111 #define c_lcl_ip connection.lcl_ip
112 #define c_rmt_ip connection.rmt_ip
113 #define c_lcl_ip4 connection.lcl_ip.ip4
114 #define c_rmt_ip4 connection.rmt_ip.ip4
115 #define c_lcl_ip6 connection.lcl_ip.ip6
116 #define c_rmt_ip6 connection.rmt_ip.ip6
117 #define c_lcl_port connection.lcl_port
118 #define c_rmt_port connection.rmt_port
119 #define c_proto connection.proto
120 #define c_fib_index connection.fib_index
121 #define c_s_index connection.s_index
122 #define c_c_index connection.c_index
123 #define c_is_ip4 connection.is_ip4
124 #define c_thread_index connection.thread_index
125 #define c_elog_track connection.elog_track
126 #define c_cc_stat_tstamp connection.cc_stat_tstamp
127 #define c_rmt_fei connection.rmt_fei
128 #define c_rmt_dpo connection.rmt_dpo
129 #define c_opaque_id connection.opaque_conn_id
130 #define c_stats connection.stats
131 #define c_pacer connection.pacer
132 #define c_flags connection.flags
134 
136  == TRANSPORT_CONN_ID_LEN, "update conn id len");
137 
138 /* Warn if size changes. Two cache lines is already generous, hopefully we
139  * won't have to outgrow that. */
140 STATIC_ASSERT (sizeof (transport_connection_t) <= 128,
141  "moved into 3rd cache line");
142 
143 #define foreach_transport_proto \
144  _(TCP, "tcp", "T") \
145  _(UDP, "udp", "U") \
146  _(SCTP, "sctp", "S") \
147  _(NONE, "ct", "C") \
148  _(TLS, "tls", "J") \
149  _(UDPC, "udpc", "U") \
150  _(QUIC, "quic", "Q") \
151 
152 typedef enum _transport_proto
153 {
154 #define _(sym, str, sstr) TRANSPORT_PROTO_ ## sym,
156 #undef _
159 
160 u8 *format_transport_proto (u8 * s, va_list * args);
161 u8 *format_transport_proto_short (u8 * s, va_list * args);
162 u8 *format_transport_connection (u8 * s, va_list * args);
163 u8 *format_transport_listen_connection (u8 * s, va_list * args);
164 u8 *format_transport_half_open_connection (u8 * s, va_list * args);
165 
166 uword unformat_transport_proto (unformat_input_t * input, va_list * args);
167 
168 #define foreach_transport_endpoint_fields \
169  _(ip46_address_t, ip) /**< ip address in net order */ \
170  _(u16, port) /**< port in net order */ \
171  _(u8, is_ip4) /**< set if ip4 */ \
172  _(u32, sw_if_index) /**< interface endpoint is associated with */ \
173  _(u32, fib_index) /**< fib table endpoint is associated with */ \
174 
175 typedef struct transport_endpoint_
176 {
177 #define _(type, name) type name;
179 #undef _
181 
182 #define foreach_transport_endpoint_cfg_fields \
183  foreach_transport_endpoint_fields \
184  _(transport_endpoint_t, peer) \
185 
186 typedef struct transport_endpoint_pair_
187 {
188 #define _(type, name) type name;
190 #undef _
192 
193 typedef clib_bihash_24_8_t transport_endpoint_table_t;
195 #define ENDPOINT_INVALID_INDEX ((u32)~0)
199 {
200  return tc->is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
201 }
202 
204 transport_endpoint_fib_proto (transport_endpoint_t * tep)
205 {
206  return tep->is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
207 }
208 
209 u8 transport_protocol_is_cl (transport_proto_t tp);
210 u8 transport_half_open_has_fifos (transport_proto_t tp);
211 transport_service_type_t transport_protocol_service_type (transport_proto_t);
212 transport_tx_fn_type_t transport_protocol_tx_fn_type (transport_proto_t tp);
213 
214 #endif /* VNET_VNET_URI_TRANSPORT_TYPES_H_ */
215 
216 /*
217  * fd.io coding-style-patch-verification: ON
218  *
219  * Local Variables:
220  * eval: (c-set-style "gnu")
221  * End:
222  */
#define CLIB_CACHE_LINE_ALIGN_MARK(mark)
Definition: cache.h:60
u32 flags
Definition: vhost_user.h:141
uword unformat_transport_proto(unformat_input_t *input, va_list *args)
Definition: transport.c:156
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:66
struct _spacer spacer_t
unsigned char u8
Definition: types.h:56
#define foreach_transport_proto
u8 transport_half_open_has_fifos(transport_proto_t tp)
Definition: transport.c:265
#define always_inline
Definition: clib.h:99
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:271
u8 * format_transport_proto(u8 *s, va_list *args)
Definition: transport.c:46
struct _unformat_input_t unformat_input_t
unsigned short u16
Definition: types.h:57
#define foreach_transport_endpoint_cfg_fields
enum transport_service_type_ transport_service_type_t
u8 * format_transport_connection(u8 *s, va_list *args)
Definition: transport.c:84
app transport service
struct transport_endpoint_pair_ transport_endpoint_cfg_t
virtual circuit service
Don&#39;t register connection in lookup Does not apply to local apps and transports using the network lay...
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:277
u8 * format_transport_listen_connection(u8 *s, va_list *args)
Definition: transport.c:111
apps acting as transports
datagram mode
enum _transport_proto transport_proto_t
reliable transport protos
float f32
Definition: types.h:143
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:323
u8 * format_transport_proto_short(u8 *s, va_list *args)
Definition: transport.c:65
clib_bihash_24_8_t transport_endpoint_table_t
u8 * format_transport_half_open_connection(u8 *s, va_list *args)
Definition: transport.c:125
u64 clib_us_time_t
Definition: time.h:204
transport_service_type_
enum transport_dequeue_type_ transport_tx_fn_type_t
vl_api_fib_path_nh_proto_t proto
Definition: fib_types.api:125