FD.io VPP  v19.01.3-6-g70449b9b9
Vector Packet Processing
transport.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2016 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_H_
17 #define VNET_VNET_URI_TRANSPORT_H_
18 
19 #include <vnet/vnet.h>
20 #include <vnet/ip/ip.h>
21 #include <vnet/tcp/tcp_debug.h>
22 
23 typedef struct _transport_stats
24 {
25  u64 tx_bytes;
27 
28 typedef struct _spacer
29 {
30  u64 bucket;
31  u32 max_burst_size;
32  f32 tokens_per_period;
33  u64 last_update;
34 } spacer_t;
35 
36 /*
37  * Protocol independent transport properties associated to a session
38  */
39 typedef struct _transport_connection
40 {
41  /** Connection ID */
42  union
43  {
44  /*
45  * Network connection ID tuple
46  */
47  struct
48  {
49  ip46_address_t rmt_ip; /**< Remote IP */
50  ip46_address_t lcl_ip; /**< Local IP */
51  u16 rmt_port; /**< Remote port */
52  u16 lcl_port; /**< Local port */
53  u8 is_ip4; /**< Flag if IP4 connection */
54  u8 proto; /**< Protocol id */
55  u32 fib_index; /**< Network namespace */
56  };
57  /*
58  * Opaque connection ID
59  */
60  u8 opaque_conn_id[42];
61  };
62 
63  u32 s_index; /**< Parent session index */
64  u32 c_index; /**< Connection index in transport pool */
65  u32 thread_index; /**< Worker-thread index */
66 
67  /*fib_node_index_t rmt_fei;
68  dpo_id_t rmt_dpo; */
69 
70  u8 flags; /**< Transport specific flags */
71  transport_stats_t stats; /**< Transport connection stats */
72  spacer_t pacer; /**< Simple transport pacer */
73 
74 #if TRANSPORT_DEBUG
75  elog_track_t elog_track; /**< Event logging */
76  u32 cc_stat_tstamp; /**< CC stats timestamp */
77 #endif
78 
79  /** Macros for 'derived classes' where base is named "connection" */
80 #define c_lcl_ip connection.lcl_ip
81 #define c_rmt_ip connection.rmt_ip
82 #define c_lcl_ip4 connection.lcl_ip.ip4
83 #define c_rmt_ip4 connection.rmt_ip.ip4
84 #define c_lcl_ip6 connection.lcl_ip.ip6
85 #define c_rmt_ip6 connection.rmt_ip.ip6
86 #define c_lcl_port connection.lcl_port
87 #define c_rmt_port connection.rmt_port
88 #define c_proto connection.proto
89 #define c_fib_index connection.fib_index
90 #define c_s_index connection.s_index
91 #define c_c_index connection.c_index
92 #define c_is_ip4 connection.is_ip4
93 #define c_thread_index connection.thread_index
94 #define c_elog_track connection.elog_track
95 #define c_cc_stat_tstamp connection.cc_stat_tstamp
96 #define c_rmt_fei connection.rmt_fei
97 #define c_rmt_dpo connection.rmt_dpo
98 #define c_opaque_id connection.opaque_conn_id
99 #define c_stats connection.stats
100 #define c_pacer connection.pacer
101 #define c_flags connection.flags
103 
104 #define TRANSPORT_CONNECTION_F_IS_TX_PACED 1 << 0
105 
106 typedef enum _transport_proto
107 {
116 
117 u8 *format_transport_proto (u8 * s, va_list * args);
118 u8 *format_transport_proto_short (u8 * s, va_list * args);
119 u8 *format_transport_connection (u8 * s, va_list * args);
120 u8 *format_transport_listen_connection (u8 * s, va_list * args);
121 u8 *format_transport_half_open_connection (u8 * s, va_list * args);
122 
123 uword unformat_transport_proto (unformat_input_t * input, va_list * args);
124 
125 #define foreach_transport_endpoint_fields \
126  _(ip46_address_t, ip) /**< ip address in net order */ \
127  _(u16, port) /**< port in net order */ \
128  _(u8, is_ip4) /**< set if ip4 */ \
129  _(u32, sw_if_index) /**< interface endpoint is associated with */ \
130  _(u32, fib_index) /**< fib table endpoint is associated with */ \
131 
132 typedef struct transport_endpoint_
133 {
134 #define _(type, name) type name;
136 #undef _
138 
139 #define foreach_transport_endpoint_cfg_fields \
140  foreach_transport_endpoint_fields \
141  _(transport_endpoint_t, peer) \
142 
143 typedef struct transport_endpoint_pair_
144 {
145 #define _(type, name) type name;
147 #undef _
149 
150 typedef clib_bihash_24_8_t transport_endpoint_table_t;
152 #define ENDPOINT_INVALID_INDEX ((u32)~0)
156 {
157  return tc->is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
158 }
159 
162 {
163  return tep->is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
164 }
165 
166 int transport_alloc_local_port (u8 proto, ip46_address_t * ip);
168  ip46_address_t * lcl_addr,
169  u16 * lcl_port);
170 void transport_endpoint_cleanup (u8 proto, ip46_address_t * lcl_ip, u16 port);
172 void transport_init (void);
173 
174 #endif /* VNET_VNET_URI_TRANSPORT_H_ */
175 
176 /*
177  * fd.io coding-style-patch-verification: ON
178  *
179  * Local Variables:
180  * eval: (c-set-style "gnu")
181  * End:
182  */
u32 flags
Definition: vhost_user.h:115
struct _transport_connection transport_connection_t
unsigned long u64
Definition: types.h:89
void transport_init(void)
Definition: transport.c:647
static u8 transport_endpoint_fib_proto(transport_endpoint_t *tep)
Definition: transport.h:162
u8 * format_transport_proto_short(u8 *s, va_list *args)
Definition: transport.c:76
unsigned char u8
Definition: types.h:56
#define always_inline
Definition: clib.h:98
unsigned int u32
Definition: types.h:88
u8 * format_transport_half_open_connection(u8 *s, va_list *args)
Definition: transport.c:140
struct _unformat_input_t unformat_input_t
unsigned short u16
Definition: types.h:57
struct _transport_stats transport_stats_t
u8 * format_transport_listen_connection(u8 *s, va_list *args)
Definition: transport.c:125
u8 * format_transport_connection(u8 *s, va_list *args)
Definition: transport.c:98
struct _spacer spacer_t
clib_bihash_24_8_t transport_endpoint_table_t
Definition: transport.h:151
void transport_endpoint_cleanup(u8 proto, ip46_address_t *lcl_ip, u16 port)
Definition: transport.c:300
static u8 transport_connection_fib_proto(transport_connection_t *tc)
Definition: transport.h:156
uword unformat_transport_proto(unformat_input_t *input, va_list *args)
Definition: transport.c:155
u8 * format_transport_proto(u8 *s, va_list *args)
Definition: transport.c:54
#define foreach_transport_endpoint_cfg_fields
Definition: transport.h:140
float f32
Definition: types.h:143
enum _transport_proto transport_proto_t
u64 uword
Definition: types.h:112
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:276
#define foreach_transport_endpoint_fields
fib table endpoint is associated with
Definition: transport.h:125
int transport_alloc_local_endpoint(u8 proto, transport_endpoint_cfg_t *rmt, ip46_address_t *lcl_addr, u16 *lcl_port)
Definition: transport.c:431
int transport_alloc_local_port(u8 proto, ip46_address_t *ip)
Allocate local port and add if successful add entry to local endpoint table to mark the pair as used...
Definition: transport.c:334
struct transport_endpoint_ transport_endpoint_t
struct transport_endpoint_pair_ transport_endpoint_cfg_t