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