FD.io VPP  v19.04.4-rc0-5-ge88582fac
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 
42 typedef struct _transport_stats
43 {
44  u64 tx_bytes;
46 
47 typedef struct _spacer
48 {
49  u64 bucket;
50  u32 max_burst_size;
51  f32 tokens_per_period;
52  u64 last_update;
53 } spacer_t;
54 
55 /*
56  * Protocol independent transport properties associated to a session
57  */
58 typedef struct _transport_connection
59 {
60  /** Connection ID */
61  union
62  {
63  /*
64  * Network connection ID tuple
65  */
66  struct
67  {
68  ip46_address_t rmt_ip; /**< Remote IP */
69  ip46_address_t lcl_ip; /**< Local IP */
70  u16 rmt_port; /**< Remote port */
71  u16 lcl_port; /**< Local port */
72  u8 is_ip4; /**< Flag if IP4 connection */
73  u8 proto; /**< Protocol id */
74  u32 fib_index; /**< Network namespace */
75  };
76  /*
77  * Opaque connection ID
78  */
79  u8 opaque_conn_id[42];
80  };
81 
82  u32 s_index; /**< Parent session index */
83  u32 c_index; /**< Connection index in transport pool */
84  u32 thread_index; /**< Worker-thread index */
85 
86  /*fib_node_index_t rmt_fei;
87  dpo_id_t rmt_dpo; */
88 
89  u8 flags; /**< Transport specific flags */
90  transport_stats_t stats; /**< Transport connection stats */
91  spacer_t pacer; /**< Simple transport pacer */
92 
93 #if TRANSPORT_DEBUG
94  elog_track_t elog_track; /**< Event logging */
95  u32 cc_stat_tstamp; /**< CC stats timestamp */
96 #endif
97 
98  /** Macros for 'derived classes' where base is named "connection" */
99 #define c_lcl_ip connection.lcl_ip
100 #define c_rmt_ip connection.rmt_ip
101 #define c_lcl_ip4 connection.lcl_ip.ip4
102 #define c_rmt_ip4 connection.rmt_ip.ip4
103 #define c_lcl_ip6 connection.lcl_ip.ip6
104 #define c_rmt_ip6 connection.rmt_ip.ip6
105 #define c_lcl_port connection.lcl_port
106 #define c_rmt_port connection.rmt_port
107 #define c_proto connection.proto
108 #define c_fib_index connection.fib_index
109 #define c_s_index connection.s_index
110 #define c_c_index connection.c_index
111 #define c_is_ip4 connection.is_ip4
112 #define c_thread_index connection.thread_index
113 #define c_elog_track connection.elog_track
114 #define c_cc_stat_tstamp connection.cc_stat_tstamp
115 #define c_rmt_fei connection.rmt_fei
116 #define c_rmt_dpo connection.rmt_dpo
117 #define c_opaque_id connection.opaque_conn_id
118 #define c_stats connection.stats
119 #define c_pacer connection.pacer
120 #define c_flags connection.flags
122 
123 #define TRANSPORT_CONNECTION_F_IS_TX_PACED 1 << 0
124 
125 typedef enum _transport_proto
126 {
136 
137 u8 *format_transport_proto (u8 * s, va_list * args);
138 u8 *format_transport_proto_short (u8 * s, va_list * args);
139 u8 *format_transport_connection (u8 * s, va_list * args);
140 u8 *format_transport_listen_connection (u8 * s, va_list * args);
141 u8 *format_transport_half_open_connection (u8 * s, va_list * args);
142 
143 uword unformat_transport_proto (unformat_input_t * input, va_list * args);
144 
145 #define foreach_transport_endpoint_fields \
146  _(ip46_address_t, ip) /**< ip address in net order */ \
147  _(u16, port) /**< port in net order */ \
148  _(u8, is_ip4) /**< set if ip4 */ \
149  _(u32, sw_if_index) /**< interface endpoint is associated with */ \
150  _(u32, fib_index) /**< fib table endpoint is associated with */ \
151 
152 typedef struct transport_endpoint_
153 {
154 #define _(type, name) type name;
156 #undef _
158 
159 #define foreach_transport_endpoint_cfg_fields \
160  foreach_transport_endpoint_fields \
161  _(transport_endpoint_t, peer) \
162 
163 typedef struct transport_endpoint_pair_
164 {
165 #define _(type, name) type name;
167 #undef _
169 
170 typedef clib_bihash_24_8_t transport_endpoint_table_t;
172 #define ENDPOINT_INVALID_INDEX ((u32)~0)
176 {
177  return tc->is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
178 }
179 
182 {
183  return tep->is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
184 }
185 
189 
190 #endif /* VNET_VNET_URI_TRANSPORT_TYPES_H_ */
191 
192 /*
193  * fd.io coding-style-patch-verification: ON
194  *
195  * Local Variables:
196  * eval: (c-set-style "gnu")
197  * End:
198  */
u32 flags
Definition: vhost_user.h:115
uword unformat_transport_proto(unformat_input_t *input, va_list *args)
Definition: transport.c:161
transport_dequeue_type_
static u8 transport_connection_fib_proto(transport_connection_t *tc)
unsigned long u64
Definition: types.h:89
struct transport_endpoint_ transport_endpoint_t
struct _spacer spacer_t
unsigned char u8
Definition: types.h:56
#define always_inline
Definition: clib.h:98
struct _transport_stats transport_stats_t
unsigned int u32
Definition: types.h:88
transport_service_type_t transport_protocol_service_type(transport_proto_t)
Definition: transport.c:274
u8 * format_transport_proto(u8 *s, va_list *args)
Definition: transport.c:55
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:105
app transport service
struct transport_endpoint_pair_ transport_endpoint_cfg_t
virtual circuit service
struct _transport_connection transport_connection_t
#define foreach_transport_endpoint_fields
fib table endpoint is associated with
transport_tx_fn_type_t transport_protocol_tx_fn_type(transport_proto_t tp)
Definition: transport.c:280
u8 * format_transport_listen_connection(u8 *s, va_list *args)
Definition: transport.c:132
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:317
u8 * format_transport_proto_short(u8 *s, va_list *args)
Definition: transport.c:80
clib_bihash_24_8_t transport_endpoint_table_t
u8 * format_transport_half_open_connection(u8 *s, va_list *args)
Definition: transport.c:146
transport_service_type_
enum transport_dequeue_type_ transport_tx_fn_type_t