src/vnet/session/transport_interface.h

   1 /*
   2  * Copyright (c) 2017 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 SRC_VNET_SESSION_TRANSPORT_INTERFACE_H_
  17 #define SRC_VNET_SESSION_TRANSPORT_INTERFACE_H_
  18
  19 #include <vnet/vnet.h>
  20 #include <vnet/session/transport.h>
  21
  22 /*
  23  * Transport protocol virtual function table
  24  */
  25 typedef struct _transport_proto_vft
  26 {
  27   /*
  28    * Setup
  29    */
  30   u32 (*bind) (u32 session_index, transport_endpoint_t * lcl);
  31   u32 (*unbind) (u32);
  32   int (*open) (transport_endpoint_t * rmt);
  33   void (*close) (u32 conn_index, u32 thread_index);
  34   void (*cleanup) (u32 conn_index, u32 thread_index);
  35
  36   /*
  37    * Transmission
  38    */
  39     u32 (*push_header) (transport_connection_t * tconn, vlib_buffer_t * b);
  40     u16 (*send_mss) (transport_connection_t * tc);
  41     u32 (*send_space) (transport_connection_t * tc);
  42     u32 (*tx_fifo_offset) (transport_connection_t * tc);
  43
  44   /*
  45    * Connection retrieval
  46    */
  47   transport_connection_t *(*get_connection) (u32 conn_idx, u32 thread_idx);
  48   transport_connection_t *(*get_listener) (u32 conn_index);
  49   transport_connection_t *(*get_half_open) (u32 conn_index);
  50
  51   /*
  52    * Format
  53    */
  54   u8 *(*format_connection) (u8 * s, va_list * args);
  55   u8 *(*format_listener) (u8 * s, va_list * args);
  56   u8 *(*format_half_open) (u8 * s, va_list * args);
  57 } transport_proto_vft_t;
  58
  59 typedef clib_bihash_24_8_t transport_endpoint_table_t;
  60
  61 #define TRANSPORT_ENDPOINT_INVALID_INDEX ((u32)~0)
  62
  63 u32 transport_endpoint_lookup (transport_endpoint_table_t * ht,
  64                                ip46_address_t * ip, u16 port);
  65 void transport_endpoint_table_add (transport_endpoint_table_t * ht,
  66                                    transport_endpoint_t * te, u32 value);
  67 void transport_endpoint_table_del (transport_endpoint_table_t * ht,
  68                                    transport_endpoint_t * te);
  69
  70 void session_register_transport (transport_proto_t transport_proto, u8 is_ip4,
  71                                  const transport_proto_vft_t * vft);
  72 transport_proto_vft_t *session_get_transport_vft (u8 session_type);
  73
  74 #endif /* SRC_VNET_SESSION_TRANSPORT_INTERFACE_H_ */
  75
  76 /*
  77  * fd.io coding-style-patch-verification: ON
  78  *
  79  * Local Variables:
  80  * eval: (c-set-style "gnu")
  81  * End:
  82  */