FD.io VPP  v21.06-3-gbb25fbf28
Vector Packet Processing
session_lookup.h
Go to the documentation of this file.
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 
22 
23 #define HALF_OPEN_LOOKUP_INVALID_VALUE ((u64)~0)
24 
26 {
31 
33  ip4_address_t * rmt, u16 lcl_port,
34  u16 rmt_port, u8 proto);
35 session_t *session_lookup_safe6 (u32 fib_index, ip6_address_t * lcl,
36  ip6_address_t * rmt, u16 lcl_port,
37  u16 rmt_port, u8 proto);
39  ip4_address_t * lcl,
40  ip4_address_t * rmt,
41  u16 lcl_port,
42  u16 rmt_port, u8 proto,
44  u8 * is_filtered);
46  ip4_address_t * lcl,
47  ip4_address_t * rmt,
48  u16 lcl_port,
49  u16 rmt_port, u8 proto);
51  ip6_address_t * lcl,
52  ip6_address_t * rmt,
53  u16 lcl_port,
54  u16 rmt_port, u8 proto,
56  u8 * is_filtered);
58  ip6_address_t * lcl,
59  ip6_address_t * rmt,
60  u16 lcl_port,
61  u16 rmt_port, u8 proto);
63  ip46_address_t * lcl,
64  ip46_address_t * rmt,
65  u16 lcl_port, u16 rmt_port,
66  u8 proto, u8 is_ip4);
68  u16 lcl_port, u8 proto, u8 use_wildcard);
69 session_t *session_lookup_listener6 (u32 fib_index, ip6_address_t * lcl,
70  u16 lcl_port, u8 proto, u8 use_wildcard);
72  session_endpoint_t * sep);
74  session_endpoint_t * sep);
78  session_endpoint_t * sepi,
79  u8 use_rules);
85  session_endpoint_t * sep);
92  u8 proto,
93  u8 is_ip4);
94 u32 session_lookup_get_index_for_fib (u32 fib_proto, u32 fib_index);
95 
97  session_table_t * table, u8 type,
98  u8 is_local);
99 
100 void session_lookup_dump_rules_table (u32 fib_index, u8 fib_proto,
102 void session_lookup_dump_local_rules_table (u32 fib_index, u8 fib_proto,
104 
105 typedef enum _session_rule_scope
106 {
110 
111 typedef struct _session_rule_add_del_args
112 {
113  /**
114  * Actual arguments to adding the rule to a session rules table
115  */
117  /**
118  * Application namespace where rule should be applied. If 0,
119  * default namespace is used.
120  */
121  u32 appns_index;
122  /**
123  * Rule scope flag.
124  */
125  u8 scope;
126  /**
127  * Transport protocol for the rule
128  */
131 
134 
135 void session_lookup_init (void);
136 
137 #endif /* SRC_VNET_SESSION_SESSION_LOOKUP_H_ */
138 
139 /*
140  * fd.io coding-style-patch-verification: ON
141  *
142  * Local Variables:
143  * eval: (c-set-style "gnu")
144  * End:
145  */
thread_index
u32 thread_index
Definition: nat44_ei_hairpinning.c:492
session_types.h
session_lookup_add_connection
int session_lookup_add_connection(transport_connection_t *tc, u64 value)
Add transport connection to a session table.
Definition: session_lookup.c:229
SESSION_LOOKUP_RESULT_NONE
@ SESSION_LOOKUP_RESULT_NONE
Definition: session_lookup.h:27
session_lookup_dump_local_rules_table
void session_lookup_dump_local_rules_table(u32 fib_index, u8 fib_proto, u8 transport_proto)
Definition: session_lookup.c:1583
app_namespace_t
struct _app_namespace app_namespace_t
session_lookup_show_table_entries
void session_lookup_show_table_entries(vlib_main_t *vm, session_table_t *table, u8 type, u8 is_local)
Definition: session_lookup.c:1419
application_namespace.h
session_
Definition: session_types.h:175
SESSION_LOOKUP_RESULT_FILTERED
@ SESSION_LOOKUP_RESULT_FILTERED
Definition: session_lookup.h:29
session_lookup_listener_wildcard
session_t * session_lookup_listener_wildcard(u32 table_index, session_endpoint_t *sep)
Lookup listener wildcard match.
Definition: session_lookup.c:761
session_lookup_safe6
session_t * session_lookup_safe6(u32 fib_index, ip6_address_t *lcl, ip6_address_t *rmt, u16 lcl_port, u16 rmt_port, u8 proto)
Lookup session with ip6 and transport layer information.
Definition: session_lookup.c:1260
u16
unsigned short u16
Definition: types.h:57
session_lookup_del_half_open
int session_lookup_del_half_open(transport_connection_t *tc)
Definition: session_lookup.c:805
session_lookup_init
void session_lookup_init(void)
Definition: session_lookup.c:1702
vm
vlib_main_t * vm
X-connect all packets from the HOST to the PHY.
Definition: nat44_ei.c:3047
transport_connection_t
struct _transport_connection transport_connection_t
session_lookup_connection4
transport_connection_t * session_lookup_connection4(u32 fib_index, ip4_address_t *lcl, ip4_address_t *rmt, u16 lcl_port, u16 rmt_port, u8 proto)
Lookup connection with ip4 and transport layer information.
Definition: session_lookup.c:980
session_lookup_endpoint_listener
u64 session_lookup_endpoint_listener(u32 table_index, session_endpoint_t *sepi, u8 use_rules)
Lookup listener for session endpoint in table.
Definition: session_lookup.c:466
session_lookup_del_session_endpoint
int session_lookup_del_session_endpoint(u32 table_index, session_endpoint_t *sep)
Definition: session_lookup.c:282
session_rule_scope_e
enum _session_rule_scope session_rule_scope_e
session_lookup_half_open_connection
transport_connection_t * session_lookup_half_open_connection(u64 handle, u8 proto, u8 is_ip4)
Definition: session_lookup.c:860
session_lookup_listener4
session_t * session_lookup_listener4(u32 fib_index, ip4_address_t *lcl, u16 lcl_port, u8 proto, u8 use_wildcard)
Definition: session_lookup.c:685
session_lookup_connection6
transport_connection_t * session_lookup_connection6(u32 fib_index, ip6_address_t *lcl, ip6_address_t *rmt, u16 lcl_port, u16 rmt_port, u8 proto)
Lookup connection with ip6 and transport layer information.
Definition: session_lookup.c:1197
session_lookup_result_
session_lookup_result_
Definition: session_lookup.h:25
scope
vl_api_gbp_scope_t scope
Definition: gbp.api:78
session_lookup_safe4
session_t * session_lookup_safe4(u32 fib_index, ip4_address_t *lcl, ip4_address_t *rmt, u16 lcl_port, u16 rmt_port, u8 proto)
Lookup session with ip4 and transport layer information.
Definition: session_lookup.c:1052
ip4_address_t
Definition: ip4_packet.h:50
SESSION_LOOKUP_RESULT_WRONG_THREAD
@ SESSION_LOOKUP_RESULT_WRONG_THREAD
Definition: session_lookup.h:28
session_lookup_global_session_endpoint
session_t * session_lookup_global_session_endpoint(session_endpoint_t *)
u64
unsigned long u64
Definition: types.h:89
session_lookup_add_session_endpoint
int session_lookup_add_session_endpoint(u32 table_index, session_endpoint_t *sep, u64 value)
Definition: session_lookup.c:255
session_lookup_connection
transport_connection_t * session_lookup_connection(u32 fib_index, ip46_address_t *lcl, ip46_address_t *rmt, u16 lcl_port, u16 rmt_port, u8 proto, u8 is_ip4)
Definition: session_lookup.c:1296
session_lookup_listener6
session_t * session_lookup_listener6(u32 fib_index, ip6_address_t *lcl, u16 lcl_port, u8 proto, u8 use_wildcard)
Definition: session_lookup.c:728
session_lookup_half_open_handle
u64 session_lookup_half_open_handle(transport_connection_t *tc)
Definition: session_lookup.c:829
u32
unsigned int u32
Definition: types.h:88
session_lookup_get_index_for_fib
u32 session_lookup_get_index_for_fib(u32 fib_proto, u32 fib_index)
Definition: session_lookup.c:210
session_rule_table_add_del_args_t
struct _session_rules_table_add_del_args session_rule_table_add_del_args_t
SESSION_RULE_SCOPE_LOCAL
@ SESSION_RULE_SCOPE_LOCAL
Definition: session_lookup.h:108
session_lookup_dump_rules_table
void session_lookup_dump_rules_table(u32 fib_index, u8 fib_proto, u8 transport_proto)
Definition: session_lookup.c:1571
session_lookup_del_session
int session_lookup_del_session(session_t *s)
Definition: session_lookup.c:365
session_endpoint_t
struct _session_endpoint session_endpoint_t
session_lookup_local_endpoint
u64 session_lookup_local_endpoint(u32 table_index, session_endpoint_t *sep)
Look up endpoint in local session table.
Definition: session_lookup.c:538
value
u8 value
Definition: qos.api:54
session_lookup_set_tables_appns
void session_lookup_set_tables_appns(app_namespace_t *app_ns)
Mark (global) tables as pertaining to app ns.
Definition: session_lookup.c:1353
vlib_main_t
Definition: main.h:102
u8
unsigned char u8
Definition: types.h:56
session_lookup_connection_wt4
transport_connection_t * session_lookup_connection_wt4(u32 fib_index, ip4_address_t *lcl, ip4_address_t *rmt, u16 lcl_port, u16 rmt_port, u8 proto, u32 thread_index, u8 *is_filtered)
Lookup connection with ip4 and transport layer information.
Definition: session_lookup.c:897
session_lookup_del_connection
int session_lookup_del_connection(transport_connection_t *tc)
Delete transport connection from session table.
Definition: session_lookup.c:341
session_lookup_result_t
enum session_lookup_result_ session_lookup_result_t
session_lookup_add_half_open
int session_lookup_add_half_open(transport_connection_t *tc, u64 value)
Definition: session_lookup.c:779
session_table.h
transport_proto
transport_proto
Definition: session.api:22
vnet_session_rule_add_del
int vnet_session_rule_add_del(session_rule_add_del_args_t *args)
Definition: session_lookup.c:1309
proto
vl_api_ip_proto_t proto
Definition: acl_types.api:51
session_lookup_connection_wt6
transport_connection_t * session_lookup_connection_wt6(u32 fib_index, ip6_address_t *lcl, ip6_address_t *rmt, u16 lcl_port, u16 rmt_port, u8 proto, u32 thread_index, u8 *is_filtered)
Lookup connection with ip6 and transport layer information.
Definition: session_lookup.c:1121
is_local
bool is_local
Definition: ikev2_types.api:33
type
vl_api_fib_path_type_t type
Definition: fib_types.api:123
session_table_t
struct _session_lookup_table session_table_t
SESSION_RULE_SCOPE_GLOBAL
@ SESSION_RULE_SCOPE_GLOBAL
Definition: session_lookup.h:107
session_lookup_del_session_endpoint2
int session_lookup_del_session_endpoint2(session_endpoint_t *sep)
Definition: session_lookup.c:307
session_lookup_listener
session_t * session_lookup_listener(u32 table_index, session_endpoint_t *sep)
Lookup listener, exact or proxy (inaddr_any:0) match.
Definition: session_lookup.c:742
session_rule_add_del_args_t
struct _session_rule_add_del_args session_rule_add_del_args_t