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