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