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