src/vnet/session/transport_types.h

   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 #include <vppinfra/bihash_24_8.h>
  23
  24
  25 #define TRANSPORT_MAX_HDRS_LEN    140   /* Max number of bytes for headers */
  26
  27
  28 typedef enum transport_dequeue_type_
  29 {
  30   TRANSPORT_TX_PEEK,            /**< reliable transport protos */
  31   TRANSPORT_TX_DEQUEUE,         /**< unreliable transport protos */
  32   TRANSPORT_TX_INTERNAL,        /**< apps acting as transports */
  33   TRANSPORT_TX_DGRAM,           /**< datagram mode */
  34   TRANSPORT_TX_N_FNS
  35 } transport_tx_fn_type_t;
  36
  37 typedef enum transport_service_type_
  38 {
  39   TRANSPORT_SERVICE_VC,         /**< virtual circuit service */
  40   TRANSPORT_SERVICE_CL,         /**< connectionless service */
  41   TRANSPORT_SERVICE_APP,        /**< app transport service */
  42   TRANSPORT_N_SERVICES
  43 } transport_service_type_t;
  44
  45 typedef enum transport_connection_flags_
  46 {
  47   TRANSPORT_CONNECTION_F_IS_TX_PACED = 1 << 0,
  48   /**
  49    * Don't register connection in lookup. Does not apply to local apps
  50    * and transports using the network layer (udp/tcp)
  51    */
  52   TRANSPORT_CONNECTION_F_NO_LOOKUP = 1 << 1,
  53   /**
  54    * Connection descheduled by the session layer.
  55    */
  56   TRANSPORT_CONNECTION_F_DESCHED = 1 << 2,
  57   /**
  58    * Connection is "connection less". Some important implications of that
  59    * are that connections are not pinned to workers and listeners will
  60    * have fifos associated to them
  61    */
  62   TRANSPORT_CONNECTION_F_CLESS = 1 << 3,
  63 } transport_connection_flags_t;
  64
  65 typedef struct _spacer
  66 {
  67   u64 bytes_per_sec;
  68   i64 bucket;
  69   clib_us_time_t last_update;
  70   f32 tokens_per_period;
  71   u32 max_burst;
  72 } spacer_t;
  73
  74 #define TRANSPORT_CONN_ID_LEN   44
  75
  76 /*
  77  * Protocol independent transport properties associated to a session
  78  */
  79 typedef struct _transport_connection
  80 {
  81   /** Connection ID */
  82   union
  83   {
  84     /*
  85      * Network connection ID tuple
  86      */
  87     struct
  88     {
  89       ip46_address_t rmt_ip;    /**< Remote IP */
  90       ip46_address_t lcl_ip;    /**< Local IP */
  91       u32 fib_index;            /**< Network namespace */
  92       u16 rmt_port;             /**< Remote port */
  93       u16 lcl_port;             /**< Local port */
  94       u8 is_ip4;                /**< Flag if IP4 connection */
  95       u8 proto;                 /**< Protocol id */
  96       u8 unused[2];             /**< First field after id wants to be
  97                                      4-byte aligned) */
  98     };
  99     /*
 100      * Opaque connection ID
 101      */
 102     u8 opaque_conn_id[TRANSPORT_CONN_ID_LEN];
 103   };
 104
 105   u32 s_index;                  /**< Parent session index */
 106   u32 c_index;                  /**< Connection index in transport pool */
 107   u32 thread_index;             /**< Worker-thread index */
 108   u8 flags;                     /**< Transport specific flags */
 109
 110   /*fib_node_index_t rmt_fei;
 111      dpo_id_t rmt_dpo; */
 112
 113   spacer_t pacer;               /**< Simple transport pacer */
 114
 115 #if TRANSPORT_DEBUG
 116   elog_track_t elog_track;      /**< Event logging */
 117   u32 cc_stat_tstamp;           /**< CC stats timestamp */
 118 #endif
 119
 120   /**
 121    * Transport specific state starts in next cache line. Meant to avoid
 122    * alignment surprises in transports when base class changes.
 123    */
 124     CLIB_CACHE_LINE_ALIGN_MARK (end);
 125
 126   /** Macros for 'derived classes' where base is named "connection" */
 127 #define c_lcl_ip connection.lcl_ip
 128 #define c_rmt_ip connection.rmt_ip
 129 #define c_lcl_ip4 connection.lcl_ip.ip4
 130 #define c_rmt_ip4 connection.rmt_ip.ip4
 131 #define c_lcl_ip6 connection.lcl_ip.ip6
 132 #define c_rmt_ip6 connection.rmt_ip.ip6
 133 #define c_lcl_port connection.lcl_port
 134 #define c_rmt_port connection.rmt_port
 135 #define c_proto connection.proto
 136 #define c_fib_index connection.fib_index
 137 #define c_s_index connection.s_index
 138 #define c_c_index connection.c_index
 139 #define c_is_ip4 connection.is_ip4
 140 #define c_thread_index connection.thread_index
 141 #define c_elog_track connection.elog_track
 142 #define c_cc_stat_tstamp connection.cc_stat_tstamp
 143 #define c_rmt_fei connection.rmt_fei
 144 #define c_rmt_dpo connection.rmt_dpo
 145 #define c_opaque_id connection.opaque_conn_id
 146 #define c_stats connection.stats
 147 #define c_pacer connection.pacer
 148 #define c_flags connection.flags
 149 #define s_ho_handle pacer.bytes_per_sec
 150 #define c_s_ho_handle connection.pacer.bytes_per_sec
 151 } transport_connection_t;
 152
 153 STATIC_ASSERT (STRUCT_OFFSET_OF (transport_connection_t, s_index)
 154                == TRANSPORT_CONN_ID_LEN, "update conn id len");
 155
 156 /* Warn if size changes. Two cache lines is already generous, hopefully we
 157  * won't have to outgrow that. */
 158 STATIC_ASSERT (sizeof (transport_connection_t) <= 128,
 159                "moved into 3rd cache line");
 160
 161 #define foreach_transport_proto                                               \
 162   _ (TCP, "tcp", "T")                                                         \
 163   _ (UDP, "udp", "U")                                                         \
 164   _ (NONE, "ct", "C")                                                         \
 165   _ (TLS, "tls", "J")                                                         \
 166   _ (QUIC, "quic", "Q")                                                       \
 167   _ (DTLS, "dtls", "D")
 168
 169 typedef enum _transport_proto
 170 {
 171 #define _(sym, str, sstr) TRANSPORT_PROTO_ ## sym,
 172   foreach_transport_proto
 173 #undef _
 174 } transport_proto_t;
 175
 176 u8 *format_transport_proto (u8 * s, va_list * args);
 177 u8 *format_transport_proto_short (u8 * s, va_list * args);
 178 u8 *format_transport_connection (u8 * s, va_list * args);
 179 u8 *format_transport_listen_connection (u8 * s, va_list * args);
 180 u8 *format_transport_half_open_connection (u8 * s, va_list * args);
 181
 182 uword unformat_transport_proto (unformat_input_t * input, va_list * args);
 183 u8 *format_transport_protos (u8 * s, va_list * args);
 184
 185 #define foreach_transport_endpoint_fields                               \
 186   _(ip46_address_t, ip) /**< ip address in net order */                 \
 187   _(u16, port)          /**< port in net order */                       \
 188   _(u8, is_ip4)         /**< set if ip4 */                              \
 189   _(u32, sw_if_index)   /**< interface endpoint is associated with  */  \
 190   _(u32, fib_index)     /**< fib table endpoint is associated with */   \
 191
 192 typedef struct transport_endpoint_
 193 {
 194 #define _(type, name) type name;
 195   foreach_transport_endpoint_fields
 196 #undef _
 197 } transport_endpoint_t;
 198
 199 typedef enum transport_endpt_cfg_flags_
 200 {
 201   TRANSPORT_CFG_F_CONNECTED = 1 << 0,
 202   TRANSPORT_CFG_F_UNIDIRECTIONAL = 1 << 1,
 203 } transport_endpt_cfg_flags_t;
 204
 205 #define foreach_transport_endpoint_cfg_fields                           \
 206   foreach_transport_endpoint_fields                                     \
 207   _(transport_endpoint_t, peer)                                         \
 208   _(u16, mss)                                                           \
 209   _(u8, transport_flags)                                                \
 210
 211 typedef struct transport_endpoint_pair_
 212 {
 213 #define _(type, name) type name;
 214   foreach_transport_endpoint_cfg_fields
 215 #undef _
 216 } transport_endpoint_cfg_t;
 217
 218 typedef clib_bihash_24_8_t transport_endpoint_table_t;
 219
 220 #define ENDPOINT_INVALID_INDEX ((u32)~0)
 221
 222 always_inline u8
 223 transport_connection_fib_proto (transport_connection_t * tc)
 224 {
 225   return tc->is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
 226 }
 227
 228 always_inline u8
 229 transport_endpoint_fib_proto (transport_endpoint_t * tep)
 230 {
 231   return tep->is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
 232 }
 233
 234 u8 transport_protocol_is_cl (transport_proto_t tp);
 235 transport_service_type_t transport_protocol_service_type (transport_proto_t);
 236 transport_tx_fn_type_t transport_protocol_tx_fn_type (transport_proto_t tp);
 237
 238 #endif /* VNET_VNET_URI_TRANSPORT_TYPES_H_ */
 239
 240 /*
 241  * fd.io coding-style-patch-verification: ON
 242  *
 243  * Local Variables:
 244  * eval: (c-set-style "gnu")
 245  * End:
 246  */