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