Florin Coras | 04e5344 | 2017-07-16 17:12:15 -0700 | [diff] [blame] | 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 | |
Florin Coras | 371ca50 | 2018-02-21 12:07:41 -0800 | [diff] [blame] | 22 | typedef enum transport_dequeue_type_ |
| 23 | { |
| 24 | TRANSPORT_TX_PEEK, /**< reliable transport protos */ |
| 25 | TRANSPORT_TX_DEQUEUE, /**< unreliable transport protos */ |
Florin Coras | 7fb0fe1 | 2018-04-09 09:24:52 -0700 | [diff] [blame] | 26 | TRANSPORT_TX_INTERNAL, /**< apps acting as transports */ |
| 27 | TRANSPORT_TX_DGRAM, /**< datagram mode */ |
Florin Coras | 371ca50 | 2018-02-21 12:07:41 -0800 | [diff] [blame] | 28 | TRANSPORT_TX_N_FNS |
| 29 | } transport_tx_fn_type_t; |
| 30 | |
| 31 | typedef enum transport_service_type_ |
| 32 | { |
| 33 | TRANSPORT_SERVICE_VC, /**< virtual circuit service */ |
| 34 | TRANSPORT_SERVICE_CL, /**< connectionless service */ |
Florin Coras | 7fb0fe1 | 2018-04-09 09:24:52 -0700 | [diff] [blame] | 35 | TRANSPORT_SERVICE_APP, /**< app transport service */ |
Florin Coras | 371ca50 | 2018-02-21 12:07:41 -0800 | [diff] [blame] | 36 | TRANSPORT_N_SERVICES |
| 37 | } transport_service_type_t; |
| 38 | |
Florin Coras | 04e5344 | 2017-07-16 17:12:15 -0700 | [diff] [blame] | 39 | /* |
| 40 | * Transport protocol virtual function table |
| 41 | */ |
Florin Coras | 371ca50 | 2018-02-21 12:07:41 -0800 | [diff] [blame] | 42 | /* *INDENT-OFF* */ |
Florin Coras | 04e5344 | 2017-07-16 17:12:15 -0700 | [diff] [blame] | 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); |
Florin Coras | 561af9b | 2017-12-09 10:19:43 -0800 | [diff] [blame] | 53 | clib_error_t *(*enable) (vlib_main_t * vm, u8 is_en); |
Florin Coras | 04e5344 | 2017-07-16 17:12:15 -0700 | [diff] [blame] | 54 | |
| 55 | /* |
| 56 | * Transmission |
| 57 | */ |
Florin Coras | 371ca50 | 2018-02-21 12:07:41 -0800 | [diff] [blame] | 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); |
Florin Coras | 561af9b | 2017-12-09 10:19:43 -0800 | [diff] [blame] | 63 | void (*update_time) (f64 time_now, u8 thread_index); |
Florin Coras | 04e5344 | 2017-07-16 17:12:15 -0700 | [diff] [blame] | 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); |
Florin Coras | 371ca50 | 2018-02-21 12:07:41 -0800 | [diff] [blame] | 78 | |
| 79 | /* |
| 80 | * Properties |
| 81 | */ |
| 82 | transport_tx_fn_type_t tx_type; |
| 83 | transport_service_type_t service_type; |
Florin Coras | 04e5344 | 2017-07-16 17:12:15 -0700 | [diff] [blame] | 84 | } transport_proto_vft_t; |
Florin Coras | 371ca50 | 2018-02-21 12:07:41 -0800 | [diff] [blame] | 85 | /* *INDENT-ON* */ |
Florin Coras | 04e5344 | 2017-07-16 17:12:15 -0700 | [diff] [blame] | 86 | |
Florin Coras | 561af9b | 2017-12-09 10:19:43 -0800 | [diff] [blame] | 87 | extern transport_proto_vft_t *tp_vfts; |
| 88 | |
Florin Coras | 371ca50 | 2018-02-21 12:07:41 -0800 | [diff] [blame] | 89 | #define transport_proto_foreach(VAR, BODY) \ |
Florin Coras | 561af9b | 2017-12-09 10:19:43 -0800 | [diff] [blame] | 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 | |
Florin Coras | 3cbc04b | 2017-10-02 00:18:51 -0700 | [diff] [blame] | 96 | void transport_register_protocol (transport_proto_t transport_proto, |
Florin Coras | 561af9b | 2017-12-09 10:19:43 -0800 | [diff] [blame] | 97 | const transport_proto_vft_t * vft, |
| 98 | fib_protocol_t fib_proto, u32 output_node); |
| 99 | transport_proto_vft_t *transport_protocol_get_vft (transport_proto_t tp); |
Florin Coras | 7fb0fe1 | 2018-04-09 09:24:52 -0700 | [diff] [blame] | 100 | transport_service_type_t transport_protocol_service_type (transport_proto_t); |
Florin Coras | f08f26d | 2018-05-10 13:20:47 -0700 | [diff] [blame] | 101 | transport_tx_fn_type_t transport_protocol_tx_fn_type (transport_proto_t tp); |
Florin Coras | 561af9b | 2017-12-09 10:19:43 -0800 | [diff] [blame] | 102 | void transport_update_time (f64 time_now, u8 thread_index); |
| 103 | void transport_enable_disable (vlib_main_t * vm, u8 is_en); |
Florin Coras | 04e5344 | 2017-07-16 17:12:15 -0700 | [diff] [blame] | 104 | |
Florin Coras | d67f112 | 2018-05-21 17:47:40 -0700 | [diff] [blame] | 105 | /** |
| 106 | * Initialize tx pacer for connection |
| 107 | * |
| 108 | * @param tc transport connection |
| 109 | * @param rate_bytes_per_second initial byte rate |
| 110 | * @param burst_bytes initial burst size in bytes |
| 111 | */ |
| 112 | void transport_connection_tx_pacer_init (transport_connection_t * tc, |
| 113 | u32 rate_bytes_per_sec, |
| 114 | u32 burst_bytes); |
| 115 | |
| 116 | /** |
| 117 | * Update tx pacer pacing rate |
| 118 | * |
| 119 | * @param tc transport connection |
| 120 | * @param bytes_per_sec new pacing rate |
| 121 | */ |
| 122 | void transport_connection_tx_pacer_update (transport_connection_t * tc, |
| 123 | u64 bytes_per_sec); |
| 124 | |
| 125 | /** |
| 126 | * Get maximum tx burst allowed for transport connection |
| 127 | * |
| 128 | * @param tc transport connection |
| 129 | * @param time_now current cpu time as returned by @ref clib_cpu_time_now |
| 130 | */ |
| 131 | u32 transport_connection_max_tx_burst (transport_connection_t * tc, |
| 132 | u64 time_now); |
| 133 | |
| 134 | /** |
| 135 | * Initialize period for tx pacers |
| 136 | * |
| 137 | * Defines a unit of time with respect to number of cpu cycles that is to |
| 138 | * be used by all tx pacers. |
| 139 | */ |
| 140 | void transport_init_tx_pacers_period (void); |
| 141 | |
| 142 | /** |
| 143 | * Check if transport connection is paced |
| 144 | */ |
| 145 | always_inline u8 |
| 146 | transport_connection_is_tx_paced (transport_connection_t * tc) |
| 147 | { |
| 148 | return (tc->flags & TRANSPORT_CONNECTION_F_IS_TX_PACED); |
| 149 | } |
| 150 | |
| 151 | u8 *format_transport_pacer (u8 * s, va_list * args); |
| 152 | |
| 153 | /** |
| 154 | * Update tx byte stats for transport connection |
| 155 | * |
| 156 | * If tx pacing is enabled, this also updates pacer bucket to account for the |
| 157 | * amount of bytes that have been sent. |
| 158 | * |
| 159 | * @param tc transport connection |
| 160 | * @param pkts packets recently sent |
| 161 | * @param bytes bytes recently sent |
| 162 | */ |
| 163 | void transport_connection_update_tx_stats (transport_connection_t * tc, |
| 164 | u32 bytes); |
| 165 | |
Florin Coras | 04e5344 | 2017-07-16 17:12:15 -0700 | [diff] [blame] | 166 | #endif /* SRC_VNET_SESSION_TRANSPORT_INTERFACE_H_ */ |
| 167 | |
| 168 | /* |
| 169 | * fd.io coding-style-patch-verification: ON |
| 170 | * |
| 171 | * Local Variables: |
| 172 | * eval: (c-set-style "gnu") |
| 173 | * End: |
| 174 | */ |