transport: cleanup

- move transport specific types to transport_types
- add transport wrapper functions for interaction with transport
protocol vfts

Change-Id: I93f70d884585fc2f41c4a605e310c80e8a8972f2
Signed-off-by: Florin Coras <fcoras@cisco.com>

1 files changed, 197 insertions, 0 deletions

diff --git a/src/vnet/session/transport_types.h b/src/vnet/session/transport_types.h
new file mode 100644
index 00000000000..d309c581db8
--- /dev/null
+++ b/src/vnet/session/transport_types.h
@@ -0,0 +1,197 @@
+/*
+ * Copyright (c) 2016-2019 Cisco and/or its affiliates.
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at:
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#ifndef VNET_VNET_URI_TRANSPORT_TYPES_H_
+#define VNET_VNET_URI_TRANSPORT_TYPES_H_
+
+#include <vnet/vnet.h>
+#include <vnet/ip/ip.h>
+#include <vnet/tcp/tcp_debug.h>
+
+#define TRANSPORT_MAX_HDRS_LEN    100	/* Max number of bytes for headers */
+
+typedef enum transport_dequeue_type_
+{
+  TRANSPORT_TX_PEEK,		/**< reliable transport protos */
+  TRANSPORT_TX_DEQUEUE,		/**< unreliable transport protos */
+  TRANSPORT_TX_INTERNAL,	/**< apps acting as transports */
+  TRANSPORT_TX_DGRAM,		/**< datagram mode */
+  TRANSPORT_TX_N_FNS
+} transport_tx_fn_type_t;
+
+typedef enum transport_service_type_
+{
+  TRANSPORT_SERVICE_VC,		/**< virtual circuit service */
+  TRANSPORT_SERVICE_CL,		/**< connectionless service */
+  TRANSPORT_SERVICE_APP,	/**< app transport service */
+  TRANSPORT_N_SERVICES
+} transport_service_type_t;
+
+typedef struct _transport_stats
+{
+  u64 tx_bytes;
+} transport_stats_t;
+
+typedef struct _spacer
+{
+  u64 bucket;
+  u32 max_burst_size;
+  f32 tokens_per_period;
+  u64 last_update;
+} spacer_t;
+
+/*
+ * Protocol independent transport properties associated to a session
+ */
+typedef struct _transport_connection
+{
+  /** Connection ID */
+  union
+  {
+    /*
+     * Network connection ID tuple
+     */
+    struct
+    {
+      ip46_address_t rmt_ip;	/**< Remote IP */
+      ip46_address_t lcl_ip;	/**< Local IP */
+      u16 rmt_port;		/**< Remote port */
+      u16 lcl_port;		/**< Local port */
+      u8 is_ip4;		/**< Flag if IP4 connection */
+      u8 proto;			/**< Protocol id */
+      u32 fib_index;		/**< Network namespace */
+    };
+    /*
+     * Opaque connection ID
+     */
+    u8 opaque_conn_id[42];
+  };
+
+  u32 s_index;			/**< Parent session index */
+  u32 c_index;			/**< Connection index in transport pool */
+  u32 thread_index;		/**< Worker-thread index */
+
+  /*fib_node_index_t rmt_fei;
+     dpo_id_t rmt_dpo; */
+
+  u8 flags;			/**< Transport specific flags */
+  transport_stats_t stats;	/**< Transport connection stats */
+  spacer_t pacer;		/**< Simple transport pacer */
+
+#if TRANSPORT_DEBUG
+  elog_track_t elog_track;	/**< Event logging */
+  u32 cc_stat_tstamp;		/**< CC stats timestamp */
+#endif
+
+  /** Macros for 'derived classes' where base is named "connection" */
+#define c_lcl_ip connection.lcl_ip
+#define c_rmt_ip connection.rmt_ip
+#define c_lcl_ip4 connection.lcl_ip.ip4
+#define c_rmt_ip4 connection.rmt_ip.ip4
+#define c_lcl_ip6 connection.lcl_ip.ip6
+#define c_rmt_ip6 connection.rmt_ip.ip6
+#define c_lcl_port connection.lcl_port
+#define c_rmt_port connection.rmt_port
+#define c_proto connection.proto
+#define c_fib_index connection.fib_index
+#define c_s_index connection.s_index
+#define c_c_index connection.c_index
+#define c_is_ip4 connection.is_ip4
+#define c_thread_index connection.thread_index
+#define c_elog_track connection.elog_track
+#define c_cc_stat_tstamp connection.cc_stat_tstamp
+#define c_rmt_fei connection.rmt_fei
+#define c_rmt_dpo connection.rmt_dpo
+#define c_opaque_id connection.opaque_conn_id
+#define c_stats connection.stats
+#define c_pacer connection.pacer
+#define c_flags connection.flags
+} transport_connection_t;
+
+#define TRANSPORT_CONNECTION_F_IS_TX_PACED	1 << 0
+
+typedef enum _transport_proto
+{
+  TRANSPORT_PROTO_TCP,
+  TRANSPORT_PROTO_UDP,
+  TRANSPORT_PROTO_SCTP,
+  TRANSPORT_PROTO_NONE,
+  TRANSPORT_PROTO_TLS,
+  TRANSPORT_PROTO_UDPC,
+  TRANSPORT_N_PROTO
+} transport_proto_t;
+
+u8 *format_transport_proto (u8 * s, va_list * args);
+u8 *format_transport_proto_short (u8 * s, va_list * args);
+u8 *format_transport_connection (u8 * s, va_list * args);
+u8 *format_transport_listen_connection (u8 * s, va_list * args);
+u8 *format_transport_half_open_connection (u8 * s, va_list * args);
+
+uword unformat_transport_proto (unformat_input_t * input, va_list * args);
+
+#define foreach_transport_endpoint_fields				\
+  _(ip46_address_t, ip) /**< ip address in net order */			\
+  _(u16, port)		/**< port in net order */			\
+  _(u8, is_ip4)		/**< set if ip4 */				\
+  _(u32, sw_if_index) 	/**< interface endpoint is associated with  */	\
+  _(u32, fib_index)	/**< fib table endpoint is associated with */	\
+
+typedef struct transport_endpoint_
+{
+#define _(type, name) type name;
+  foreach_transport_endpoint_fields
+#undef _
+} transport_endpoint_t;
+
+#define foreach_transport_endpoint_cfg_fields				\
+  foreach_transport_endpoint_fields					\
+  _(transport_endpoint_t, peer)						\
+
+typedef struct transport_endpoint_pair_
+{
+#define _(type, name) type name;
+  foreach_transport_endpoint_cfg_fields
+#undef _
+} transport_endpoint_cfg_t;
+
+typedef clib_bihash_24_8_t transport_endpoint_table_t;
+
+#define ENDPOINT_INVALID_INDEX ((u32)~0)
+
+always_inline u8
+transport_connection_fib_proto (transport_connection_t * tc)
+{
+  return tc->is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
+}
+
+always_inline u8
+transport_endpoint_fib_proto (transport_endpoint_t * tep)
+{
+  return tep->is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
+}
+
+u8 transport_protocol_is_cl (transport_proto_t tp);
+transport_service_type_t transport_protocol_service_type (transport_proto_t);
+transport_tx_fn_type_t transport_protocol_tx_fn_type (transport_proto_t tp);
+
+#endif /* VNET_VNET_URI_TRANSPORT_TYPES_H_ */
+
+/*
+ * fd.io coding-style-patch-verification: ON
+ *
+ * Local Variables:
+ * eval: (c-set-style "gnu")
+ * End:
+ */