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