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