FD.io VPP  v18.01.2-1-g9b554f3
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 
22 /*
23  * Transport protocol virtual function table
24  */
25 typedef struct _transport_proto_vft
26 {
27  /*
28  * Setup
29  */
30  u32 (*bind) (u32 session_index, transport_endpoint_t * lcl);
31  u32 (*unbind) (u32);
32  int (*open) (transport_endpoint_t * rmt);
33  void (*close) (u32 conn_index, u32 thread_index);
34  void (*cleanup) (u32 conn_index, u32 thread_index);
35  clib_error_t *(*enable) (vlib_main_t * vm, u8 is_en);
36 
37  /*
38  * Transmission
39  */
40  u32 (*push_header) (transport_connection_t * tconn, vlib_buffer_t * b);
41  u16 (*send_mss) (transport_connection_t * tc);
42  u32 (*send_space) (transport_connection_t * tc);
43  u32 (*tx_fifo_offset) (transport_connection_t * tc);
44  void (*update_time) (f64 time_now, u8 thread_index);
45 
46  /*
47  * Connection retrieval
48  */
49  transport_connection_t *(*get_connection) (u32 conn_idx, u32 thread_idx);
50  transport_connection_t *(*get_listener) (u32 conn_index);
51  transport_connection_t *(*get_half_open) (u32 conn_index);
52 
53  /*
54  * Format
55  */
56  u8 *(*format_connection) (u8 * s, va_list * args);
57  u8 *(*format_listener) (u8 * s, va_list * args);
58  u8 *(*format_half_open) (u8 * s, va_list * args);
60 
62 
63 #define transport_proto_foreach(VAR, BODY) \
64 do { \
65  for (VAR = 0; VAR < vec_len (tp_vfts); VAR++) \
66  if (tp_vfts[VAR].push_header != 0) \
67  do { BODY; } while (0); \
68 } while (0)
69 
71  const transport_proto_vft_t * vft,
72  fib_protocol_t fib_proto, u32 output_node);
74 void transport_update_time (f64 time_now, u8 thread_index);
76 
77 #endif /* SRC_VNET_SESSION_TRANSPORT_INTERFACE_H_ */
78 
79 /*
80  * fd.io coding-style-patch-verification: ON
81  *
82  * Local Variables:
83  * eval: (c-set-style "gnu")
84  * End:
85  */
struct _transport_connection transport_connection_t
struct _transport_proto_vft transport_proto_vft_t
enum fib_protocol_t_ fib_protocol_t
Protocol Type.
void transport_enable_disable(vlib_main_t *vm, u8 is_en)
Definition: transport.c:342
void transport_update_time(f64 time_now, u8 thread_index)
Definition: transport.c:331
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:149
transport_proto_vft_t * tp_vfts
Per-type vector of transport protocol virtual function tables.
Definition: transport.c:23
static void cleanup(void)
Definition: client.c:90
vlib_main_t * vm
Definition: buffer.c:283
unsigned int u32
Definition: types.h:88
transport_proto_vft_t * transport_protocol_get_vft(transport_proto_t tp)
Get transport virtual function table.
Definition: transport.c:167
unsigned short u16
Definition: types.h:57
enum _transport_proto transport_proto_t
double f64
Definition: types.h:142
unsigned char u8
Definition: types.h:56
struct _transport_endpoint transport_endpoint_t