src/vnet/session/session_lookup.h

   1 /*
   2  * Copyright (c) 2017-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 SRC_VNET_SESSION_SESSION_LOOKUP_H_
  17 #define SRC_VNET_SESSION_SESSION_LOOKUP_H_
  18
  19 #include <vnet/session/session_table.h>
  20 #include <vnet/session/session_types.h>
  21 #include <vnet/session/application_namespace.h>
  22
  23 #define HALF_OPEN_LOOKUP_INVALID_VALUE ((u64)~0)
  24
  25 typedef enum session_lookup_result_
  26 {
  27   SESSION_LOOKUP_RESULT_NONE,
  28   SESSION_LOOKUP_RESULT_WRONG_THREAD,
  29   SESSION_LOOKUP_RESULT_FILTERED
  30 } session_lookup_result_t;
  31
  32 typedef struct session_lookup_main_
  33 {
  34   clib_spinlock_t st_alloc_lock;
  35 } session_lookup_main_t;
  36
  37 session_t *session_lookup_safe4 (u32 fib_index, ip4_address_t * lcl,
  38                                  ip4_address_t * rmt, u16 lcl_port,
  39                                  u16 rmt_port, u8 proto);
  40 session_t *session_lookup_safe6 (u32 fib_index, ip6_address_t * lcl,
  41                                  ip6_address_t * rmt, u16 lcl_port,
  42                                  u16 rmt_port, u8 proto);
  43 transport_connection_t *session_lookup_connection_wt4 (u32 fib_index,
  44                                                        ip4_address_t * lcl,
  45                                                        ip4_address_t * rmt,
  46                                                        u16 lcl_port,
  47                                                        u16 rmt_port, u8 proto,
  48                                                        u32 thread_index,
  49                                                        u8 * is_filtered);
  50 transport_connection_t *session_lookup_connection4 (u32 fib_index,
  51                                                     ip4_address_t * lcl,
  52                                                     ip4_address_t * rmt,
  53                                                     u16 lcl_port,
  54                                                     u16 rmt_port, u8 proto);
  55 transport_connection_t *session_lookup_connection_wt6 (u32 fib_index,
  56                                                        ip6_address_t * lcl,
  57                                                        ip6_address_t * rmt,
  58                                                        u16 lcl_port,
  59                                                        u16 rmt_port, u8 proto,
  60                                                        u32 thread_index,
  61                                                        u8 * is_filtered);
  62 transport_connection_t *session_lookup_connection6 (u32 fib_index,
  63                                                     ip6_address_t * lcl,
  64                                                     ip6_address_t * rmt,
  65                                                     u16 lcl_port,
  66                                                     u16 rmt_port, u8 proto);
  67 transport_connection_t *session_lookup_connection (u32 fib_index,
  68                                                    ip46_address_t * lcl,
  69                                                    ip46_address_t * rmt,
  70                                                    u16 lcl_port, u16 rmt_port,
  71                                                    u8 proto, u8 is_ip4);
  72 session_t *session_lookup_listener4 (u32 fib_index, ip4_address_t * lcl,
  73                                      u16 lcl_port, u8 proto, u8 use_wildcard);
  74 session_t *session_lookup_listener6 (u32 fib_index, ip6_address_t * lcl,
  75                                      u16 lcl_port, u8 proto, u8 use_wildcard);
  76 session_t *session_lookup_listener (u32 table_index,
  77                                     session_endpoint_t * sep);
  78 session_t *session_lookup_listener_wildcard (u32 table_index,
  79                                              session_endpoint_t * sep);
  80 int session_lookup_add_connection (transport_connection_t * tc, u64 value);
  81 int session_lookup_del_connection (transport_connection_t * tc);
  82 u64 session_lookup_endpoint_listener (u32 table_index,
  83                                       session_endpoint_t * sepi,
  84                                       u8 use_rules);
  85 u64 session_lookup_local_endpoint (u32 table_index, session_endpoint_t * sep);
  86 session_t *session_lookup_global_session_endpoint (session_endpoint_t *);
  87 int session_lookup_add_session_endpoint (u32 table_index,
  88                                          session_endpoint_t * sep, u64 value);
  89 int session_lookup_del_session_endpoint (u32 table_index,
  90                                          session_endpoint_t * sep);
  91 int session_lookup_del_session_endpoint2 (session_endpoint_t * sep);
  92 int session_lookup_del_session (session_t * s);
  93 int session_lookup_del_half_open (transport_connection_t * tc);
  94 int session_lookup_add_half_open (transport_connection_t * tc, u64 value);
  95 u64 session_lookup_half_open_handle (transport_connection_t * tc);
  96 transport_connection_t *session_lookup_half_open_connection (u64 handle,
  97                                                              u8 proto,
  98                                                              u8 is_ip4);
  99 u32 session_lookup_get_index_for_fib (u32 fib_proto, u32 fib_index);
 100 u32 session_lookup_get_or_alloc_index_for_fib (u32 fib_proto, u32 fib_index);
 101
 102 void session_lookup_show_table_entries (vlib_main_t * vm,
 103                                         session_table_t * table, u8 type,
 104                                         u8 is_local);
 105
 106 void session_lookup_dump_rules_table (u32 fib_index, u8 fib_proto,
 107                                       u8 transport_proto);
 108 void session_lookup_dump_local_rules_table (u32 fib_index, u8 fib_proto,
 109                                             u8 transport_proto);
 110
 111 typedef enum _session_rule_scope
 112 {
 113   SESSION_RULE_SCOPE_GLOBAL = 1,
 114   SESSION_RULE_SCOPE_LOCAL = 2,
 115 } session_rule_scope_e;
 116
 117 typedef struct _session_rule_add_del_args
 118 {
 119   /**
 120    * Actual arguments to adding the rule to a session rules table
 121    */
 122   session_rule_table_add_del_args_t table_args;
 123   /**
 124    * Application namespace where rule should be applied. If 0,
 125    * default namespace is used.
 126    */
 127   u32 appns_index;
 128   /**
 129    * Rule scope flag.
 130    */
 131   u8 scope;
 132   /**
 133    * Transport protocol for the rule
 134    */
 135   u8 transport_proto;
 136 } session_rule_add_del_args_t;
 137
 138 session_error_t vnet_session_rule_add_del (session_rule_add_del_args_t *args);
 139 void session_lookup_set_tables_appns (app_namespace_t * app_ns);
 140
 141 void session_lookup_init (void);
 142
 143 #endif /* SRC_VNET_SESSION_SESSION_LOOKUP_H_ */
 144
 145 /*
 146  * fd.io coding-style-patch-verification: ON
 147  *
 148  * Local Variables:
 149  * eval: (c-set-style "gnu")
 150  * End:
 151  */