FD.io VPP  v18.10-34-gcce845e
Vector Packet Processing
transport_interface.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2017 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 SRC_VNET_SESSION_TRANSPORT_INTERFACE_H_
17 #define SRC_VNET_SESSION_TRANSPORT_INTERFACE_H_
18 
19 #include <vnet/vnet.h>
20 #include <vnet/session/transport.h>
21 
23 {
24  TRANSPORT_TX_PEEK, /**< reliable transport protos */
25  TRANSPORT_TX_DEQUEUE, /**< unreliable transport protos */
26  TRANSPORT_TX_INTERNAL, /**< apps acting as transports */
27  TRANSPORT_TX_DGRAM, /**< datagram mode */
30 
32 {
33  TRANSPORT_SERVICE_VC, /**< virtual circuit service */
34  TRANSPORT_SERVICE_CL, /**< connectionless service */
35  TRANSPORT_SERVICE_APP, /**< app transport service */
38 
39 /*
40  * Transport protocol virtual function table
41  */
42 /* *INDENT-OFF* */
43 typedef struct _transport_proto_vft
44 {
45  /*
46  * Setup
47  */
48  u32 (*bind) (u32 session_index, transport_endpoint_t * lcl);
49  u32 (*unbind) (u32);
50  int (*open) (transport_endpoint_t * rmt);
51  void (*close) (u32 conn_index, u32 thread_index);
52  void (*cleanup) (u32 conn_index, u32 thread_index);
53  clib_error_t *(*enable) (vlib_main_t * vm, u8 is_en);
54 
55  /*
56  * Transmission
57  */
58 
59  u32 (*push_header) (transport_connection_t * tconn, vlib_buffer_t * b);
60  u16 (*send_mss) (transport_connection_t * tc);
61  u32 (*send_space) (transport_connection_t * tc);
62  u32 (*tx_fifo_offset) (transport_connection_t * tc);
63  void (*update_time) (f64 time_now, u8 thread_index);
64 
65  /*
66  * Connection retrieval
67  */
68  transport_connection_t *(*get_connection) (u32 conn_idx, u32 thread_idx);
69  transport_connection_t *(*get_listener) (u32 conn_index);
70  transport_connection_t *(*get_half_open) (u32 conn_index);
71 
72  /*
73  * Format
74  */
75  u8 *(*format_connection) (u8 * s, va_list * args);
76  u8 *(*format_listener) (u8 * s, va_list * args);
77  u8 *(*format_half_open) (u8 * s, va_list * args);
78 
79  /*
80  * Properties
81  */
82  transport_tx_fn_type_t tx_type;
83  transport_service_type_t service_type;
85 /* *INDENT-ON* */
86 
88 
89 #define transport_proto_foreach(VAR, BODY) \
90 do { \
91  for (VAR = 0; VAR < vec_len (tp_vfts); VAR++) \
92  if (tp_vfts[VAR].push_header != 0) \
93  do { BODY; } while (0); \
94 } while (0)
95 
97  const transport_proto_vft_t * vft,
98  fib_protocol_t fib_proto, u32 output_node);
102 void transport_update_time (f64 time_now, u8 thread_index);
103 void transport_enable_disable (vlib_main_t * vm, u8 is_en);
104 
105 #endif /* SRC_VNET_SESSION_TRANSPORT_INTERFACE_H_ */
106 
107 /*
108  * fd.io coding-style-patch-verification: ON
109  *
110  * Local Variables:
111  * eval: (c-set-style "gnu")
112  * End:
113  */
virtual circuit service
struct _transport_connection transport_connection_t
struct _transport_proto_vft transport_proto_vft_t
enum transport_service_type_ transport_service_type_t
unsigned char u8
Definition: types.h:56
app transport service
enum fib_protocol_t_ fib_protocol_t
Protocol Type.
double f64
Definition: types.h:142
void transport_enable_disable(vlib_main_t *vm, u8 is_en)
Definition: transport.c:391
connectionless service
unsigned int u32
Definition: types.h:88
void transport_update_time(f64 time_now, u8 thread_index)
Definition: transport.c:380
enum transport_dequeue_type_ transport_tx_fn_type_t
void transport_register_protocol(transport_proto_t transport_proto, const transport_proto_vft_t *vft, fib_protocol_t fib_proto, u32 output_node)
Register transport virtual function table.
Definition: transport.c:173
transport_proto_vft_t * tp_vfts
Per-type vector of transport protocol virtual function tables.
Definition: transport.c:23
unsigned short u16
Definition: types.h:57
static void cleanup(void)
Definition: client.c:130
reliable transport protos
transport_tx_fn_type_t transport_protocol_tx_fn_type(transport_proto_t tp)
Definition: transport.c:205
vlib_main_t * vm
Definition: buffer.c:294
apps acting as transports
transport_service_type_
transport_dequeue_type_
transport_proto_vft_t * transport_protocol_get_vft(transport_proto_t tp)
Get transport virtual function table.
Definition: transport.c:191
unreliable transport protos
enum _transport_proto transport_proto_t
struct _transport_endpoint transport_endpoint_t
transport_service_type_t transport_protocol_service_type(transport_proto_t)
Definition: transport.c:199