4aaa900f0c9e8438245a46785deea6d73c031cd7
[vpp.git] / src / vnet / session / session_table.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_TABLE_H_
17 #define SRC_VNET_SESSION_SESSION_TABLE_H_
18
19 #include <vppinfra/bihash_16_8.h>
20 #include <vppinfra/bihash_48_8.h>
21 #include <vnet/session/session_rules_table.h>
22
23 typedef struct _session_lookup_table
24 {
25   /**
26    * Lookup tables for established sessions and listeners
27    */
28   clib_bihash_16_8_t v4_session_hash;
29   clib_bihash_48_8_t v6_session_hash;
30
31   /**
32    * Lookup tables for half-open sessions
33    */
34   clib_bihash_16_8_t v4_half_open_hash;
35   clib_bihash_48_8_t v6_half_open_hash;
36
37   /**
38    * Per fib proto and transport proto session rules tables
39    */
40   session_rules_table_t session_rules[TRANSPORT_N_PROTO];
41
42   /** Flag that indicates if table has local scope */
43   u8 is_local;
44
45   /** Namespace this table belongs to */
46   u32 appns_index;
47
48   /** For global tables only one fib proto is active. This is a
49    * byproduct of fib table ids not necessarily being the same for
50    * identical fib idices of v4 and v6 fib protos */
51   u8 active_fib_proto;
52   /* Required for pool_get_aligned(...) */
53     CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
54 } session_table_t;
55
56 #define SESSION_TABLE_INVALID_INDEX ((u32)~0)
57 #define SESSION_LOCAL_TABLE_PREFIX ((u32)~0)
58 #define SESSION_DROP_HANDLE (((u64)~0) - 1)
59
60 typedef int (*ip4_session_table_walk_fn_t) (clib_bihash_kv_16_8_t * kvp,
61                                             void *ctx);
62
63 void ip4_session_table_walk_cb (clib_bihash_kv_16_8_t * kvp, void *arg);
64 void ip4_session_table_walk (clib_bihash_16_8_t * hash,
65                              ip4_session_table_walk_fn_t fn, void *arg);
66
67 session_table_t *session_table_alloc (void);
68 session_table_t *session_table_get (u32 table_index);
69 u32 session_table_index (session_table_t * slt);
70 void session_table_init (session_table_t * slt, u8 fib_proto);
71
72 /* Internal, try not to use it! */
73 session_table_t *_get_session_tables ();
74
75 #define session_table_foreach(VAR, BODY)                \
76   pool_foreach(VAR, _get_session_tables (), BODY)
77
78 #endif /* SRC_VNET_SESSION_SESSION_TABLE_H_ */
79 /* *INDENT-ON* */
80 /*
81  * fd.io coding-style-patch-verification: ON
82  *
83  * Local Variables:
84  * eval: (c-set-style "gnu")
85  * End:
86  */