src/vnet/session/transport.h

   1 /*
   2  * Copyright (c) 2016 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_H_
  17 #define VNET_VNET_URI_TRANSPORT_H_
  18
  19 #include <vnet/vnet.h>
  20 #include <vnet/ip/ip.h>
  21 #include <vnet/tcp/tcp_debug.h>
  22
  23 /*
  24  * Protocol independent transport properties associated to a session
  25  */
  26 typedef struct _transport_connection
  27 {
  28   /** Connection ID */
  29   union
  30   {
  31     /*
  32      * Network connection ID tuple
  33      */
  34     struct
  35     {
  36       ip46_address_t rmt_ip;    /**< Remote IP */
  37       ip46_address_t lcl_ip;    /**< Local IP */
  38       u16 lcl_port;             /**< Local port */
  39       u16 rmt_port;             /**< Remote port */
  40       u8 proto;                 /**< Protocol id */
  41       u8 is_ip4;                /**< Flag if IP4 connection */
  42       u32 fib_index;            /**< Network namespace */
  43     };
  44     /*
  45      * Opaque connection ID
  46      */
  47     u8 opaque_conn_id[42];
  48   };
  49
  50   u32 s_index;                  /**< Parent session index */
  51   u32 c_index;                  /**< Connection index in transport pool */
  52   u32 thread_index;             /**< Worker-thread index */
  53
  54   /*fib_node_index_t rmt_fei;
  55      dpo_id_t rmt_dpo; */
  56
  57 #if TRANSPORT_DEBUG
  58   elog_track_t elog_track;      /**< Event logging */
  59   u32 cc_stat_tstamp;           /**< CC stats timestamp */
  60 #endif
  61
  62   /** Macros for 'derived classes' where base is named "connection" */
  63 #define c_lcl_ip connection.lcl_ip
  64 #define c_rmt_ip connection.rmt_ip
  65 #define c_lcl_ip4 connection.lcl_ip.ip4
  66 #define c_rmt_ip4 connection.rmt_ip.ip4
  67 #define c_lcl_ip6 connection.lcl_ip.ip6
  68 #define c_rmt_ip6 connection.rmt_ip.ip6
  69 #define c_lcl_port connection.lcl_port
  70 #define c_rmt_port connection.rmt_port
  71 #define c_proto connection.proto
  72 #define c_fib_index connection.fib_index
  73 #define c_s_index connection.s_index
  74 #define c_c_index connection.c_index
  75 #define c_is_ip4 connection.is_ip4
  76 #define c_thread_index connection.thread_index
  77 #define c_elog_track connection.elog_track
  78 #define c_cc_stat_tstamp connection.cc_stat_tstamp
  79 #define c_rmt_fei connection.rmt_fei
  80 #define c_rmt_dpo connection.rmt_dpo
  81 #define c_opaque_id connection.opaque_conn_id
  82 } transport_connection_t;
  83
  84 typedef enum _transport_proto
  85 {
  86   TRANSPORT_PROTO_TCP,
  87   TRANSPORT_PROTO_UDP,
  88   TRANSPORT_PROTO_SCTP,
  89   TRANSPORT_PROTO_NONE,
  90   TRANSPORT_PROTO_TLS,
  91   TRANSPORT_N_PROTO
  92 } transport_proto_t;
  93
  94 u8 *format_transport_proto (u8 * s, va_list * args);
  95 u8 *format_transport_proto_short (u8 * s, va_list * args);
  96 uword unformat_transport_proto (unformat_input_t * input, va_list * args);
  97
  98 #define foreach_transport_connection_fields                             \
  99   _(u32, sw_if_index)   /**< interface endpoint is associated with  */  \
 100   _(ip46_address_t, ip) /**< ip address */                              \
 101   _(u32, fib_index)     /**< fib table endpoint is associated with */   \
 102   _(u8, is_ip4) /**< 1 if ip4 */                                        \
 103   _(u16, port)          /**< port in net order */                       \
 104
 105 typedef struct _transport_endpoint
 106 {
 107 #define _(type, name) type name;
 108   foreach_transport_connection_fields
 109 #undef _
 110 } transport_endpoint_t;
 111
 112 typedef clib_bihash_24_8_t transport_endpoint_table_t;
 113
 114 #define ENDPOINT_INVALID_INDEX ((u32)~0)
 115
 116 always_inline u8
 117 transport_connection_fib_proto (transport_connection_t * tc)
 118 {
 119   return tc->is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
 120 }
 121
 122 always_inline u8
 123 transport_endpoint_fib_proto (transport_endpoint_t * tep)
 124 {
 125   return tep->is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
 126 }
 127
 128 always_inline u8
 129 transport_is_stream (u8 proto)
 130 {
 131   return ((proto == TRANSPORT_PROTO_TCP) || (proto == TRANSPORT_PROTO_SCTP));
 132 }
 133
 134 always_inline u8
 135 transport_is_dgram (u8 proto)
 136 {
 137   return (proto == TRANSPORT_PROTO_UDP);
 138 }
 139
 140 int transport_alloc_local_port (u8 proto, ip46_address_t * ip);
 141 int transport_alloc_local_endpoint (u8 proto, transport_endpoint_t * rmt,
 142                                     ip46_address_t * lcl_addr,
 143                                     u16 * lcl_port);
 144 void transport_endpoint_cleanup (u8 proto, ip46_address_t * lcl_ip, u16 port);
 145 void transport_init (void);
 146
 147 #endif /* VNET_VNET_URI_TRANSPORT_H_ */
 148
 149 /*
 150  * fd.io coding-style-patch-verification: ON
 151  *
 152  * Local Variables:
 153  * eval: (c-set-style "gnu")
 154  * End:
 155  */