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