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
  23 #define TRANSPORT_MAX_HDRS_LEN    140   /* Max number of bytes for headers */
  24
  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 } transport_connection_flags_t;
  56
  57 typedef struct _spacer
  58 {
  59   u64 bytes_per_sec;
  60   u64 bucket;
  61   clib_us_time_t last_update;
  62   f32 tokens_per_period;
  63   u32 idle_timeout_us;
  64 } spacer_t;
  65
  66 #define TRANSPORT_CONN_ID_LEN   44
  67
  68 /*
  69  * Protocol independent transport properties associated to a session
  70  */
  71 typedef struct _transport_connection
  72 {
  73   /** Connection ID */
  74   union
  75   {
  76     /*
  77      * Network connection ID tuple
  78      */
  79     struct
  80     {
  81       ip46_address_t rmt_ip;    /**< Remote IP */
  82       ip46_address_t lcl_ip;    /**< Local IP */
  83       u32 fib_index;            /**< Network namespace */
  84       u16 rmt_port;             /**< Remote port */
  85       u16 lcl_port;             /**< Local port */
  86       u8 is_ip4;                /**< Flag if IP4 connection */
  87       u8 proto;                 /**< Protocol id */
  88       u8 unused[2];             /**< First field after id wants to be
  89                                      4-byte aligned) */
  90     };
  91     /*
  92      * Opaque connection ID
  93      */
  94     u8 opaque_conn_id[TRANSPORT_CONN_ID_LEN];
  95   };
  96
  97   u32 s_index;                  /**< Parent session index */
  98   u32 c_index;                  /**< Connection index in transport pool */
  99   u32 thread_index;             /**< Worker-thread index */
 100   u8 flags;                     /**< Transport specific flags */
 101
 102   /*fib_node_index_t rmt_fei;
 103      dpo_id_t rmt_dpo; */
 104
 105   spacer_t pacer;               /**< Simple transport pacer */
 106
 107 #if TRANSPORT_DEBUG
 108   elog_track_t elog_track;      /**< Event logging */
 109   u32 cc_stat_tstamp;           /**< CC stats timestamp */
 110 #endif
 111
 112   /**
 113    * Transport specific state starts in next cache line. Meant to avoid
 114    * alignment surprises in transports when base class changes.
 115    */
 116     CLIB_CACHE_LINE_ALIGN_MARK (end);
 117
 118   /** Macros for 'derived classes' where base is named "connection" */
 119 #define c_lcl_ip connection.lcl_ip
 120 #define c_rmt_ip connection.rmt_ip
 121 #define c_lcl_ip4 connection.lcl_ip.ip4
 122 #define c_rmt_ip4 connection.rmt_ip.ip4
 123 #define c_lcl_ip6 connection.lcl_ip.ip6
 124 #define c_rmt_ip6 connection.rmt_ip.ip6
 125 #define c_lcl_port connection.lcl_port
 126 #define c_rmt_port connection.rmt_port
 127 #define c_proto connection.proto
 128 #define c_fib_index connection.fib_index
 129 #define c_s_index connection.s_index
 130 #define c_c_index connection.c_index
 131 #define c_is_ip4 connection.is_ip4
 132 #define c_thread_index connection.thread_index
 133 #define c_elog_track connection.elog_track
 134 #define c_cc_stat_tstamp connection.cc_stat_tstamp
 135 #define c_rmt_fei connection.rmt_fei
 136 #define c_rmt_dpo connection.rmt_dpo
 137 #define c_opaque_id connection.opaque_conn_id
 138 #define c_stats connection.stats
 139 #define c_pacer connection.pacer
 140 #define c_flags connection.flags
 141 } transport_connection_t;
 142
 143 STATIC_ASSERT (STRUCT_OFFSET_OF (transport_connection_t, s_index)
 144                == TRANSPORT_CONN_ID_LEN, "update conn id len");
 145
 146 /* Warn if size changes. Two cache lines is already generous, hopefully we
 147  * won't have to outgrow that. */
 148 STATIC_ASSERT (sizeof (transport_connection_t) <= 128,
 149                "moved into 3rd cache line");
 150
 151 #define foreach_transport_proto                         \
 152   _(TCP, "tcp", "T")                                    \
 153   _(UDP, "udp", "U")                                    \
 154   _(NONE, "ct", "C")                                    \
 155   _(TLS, "tls", "J")                                    \
 156   _(UDPC, "udpc", "U")                                  \
 157   _(QUIC, "quic", "Q")                                  \
 158
 159 typedef enum _transport_proto
 160 {
 161 #define _(sym, str, sstr) TRANSPORT_PROTO_ ## sym,
 162   foreach_transport_proto
 163 #undef _
 164 } transport_proto_t;
 165
 166 u8 *format_transport_proto (u8 * s, va_list * args);
 167 u8 *format_transport_proto_short (u8 * s, va_list * args);
 168 u8 *format_transport_connection (u8 * s, va_list * args);
 169 u8 *format_transport_listen_connection (u8 * s, va_list * args);
 170 u8 *format_transport_half_open_connection (u8 * s, va_list * args);
 171
 172 uword unformat_transport_proto (unformat_input_t * input, va_list * args);
 173 u8 *format_transport_protos (u8 * s, va_list * args);
 174
 175 #define foreach_transport_endpoint_fields                               \
 176   _(ip46_address_t, ip) /**< ip address in net order */                 \
 177   _(u16, port)          /**< port in net order */                       \
 178   _(u8, is_ip4)         /**< set if ip4 */                              \
 179   _(u32, sw_if_index)   /**< interface endpoint is associated with  */  \
 180   _(u32, fib_index)     /**< fib table endpoint is associated with */   \
 181
 182 typedef struct transport_endpoint_
 183 {
 184 #define _(type, name) type name;
 185   foreach_transport_endpoint_fields
 186 #undef _
 187 } transport_endpoint_t;
 188
 189 #define foreach_transport_endpoint_cfg_fields                           \
 190   foreach_transport_endpoint_fields                                     \
 191   _(transport_endpoint_t, peer)                                         \
 192   _(u16, mss)                                                           \
 193
 194 typedef struct transport_endpoint_pair_
 195 {
 196 #define _(type, name) type name;
 197   foreach_transport_endpoint_cfg_fields
 198 #undef _
 199 } transport_endpoint_cfg_t;
 200
 201 typedef clib_bihash_24_8_t transport_endpoint_table_t;
 202
 203 #define ENDPOINT_INVALID_INDEX ((u32)~0)
 204
 205 always_inline u8
 206 transport_connection_fib_proto (transport_connection_t * tc)
 207 {
 208   return tc->is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
 209 }
 210
 211 always_inline u8
 212 transport_endpoint_fib_proto (transport_endpoint_t * tep)
 213 {
 214   return tep->is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
 215 }
 216
 217 u8 transport_protocol_is_cl (transport_proto_t tp);
 218 u8 transport_half_open_has_fifos (transport_proto_t tp);
 219 transport_service_type_t transport_protocol_service_type (transport_proto_t);
 220 transport_tx_fn_type_t transport_protocol_tx_fn_type (transport_proto_t tp);
 221
 222 #endif /* VNET_VNET_URI_TRANSPORT_TYPES_H_ */
 223
 224 /*
 225  * fd.io coding-style-patch-verification: ON
 226  *
 227  * Local Variables:
 228  * eval: (c-set-style "gnu")
 229  * End:
 230  */