FD.io VPP  v20.09-64-g4f7b92f0a
Vector Packet Processing
cnat_session.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2020 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 __CNAT_SESSION_H__
17 #define __CNAT_SESSION_H__
18 
19 #include <vnet/udp/udp.h>
20 
21 #include <cnat/cnat_types.h>
22 #include <cnat/cnat_client.h>
23 #include <cnat/bihash_40_48.h>
24 
25 
26 /**
27  * A session represents the memory of a translation.
28  * In the tx direction (from behind to in front of the NAT), the
29  * session is preserved so subsequent packets follow the same path
30  * even if the translation has been updated. In the tx direction
31  * the session represents the swap from the VIP to the server address
32  * In the RX direction the swap is from the server address/port to VIP.
33  *
34  * A session exists only as key and value in the bihash, there is no
35  * pool for this object. If there were a pool, one would need to be
36  * concerned about what worker is using it.
37  */
38 typedef struct cnat_session_t_
39 {
40  /**
41  * this key sits in the same memory location a 'key' in the bihash kvp
42  */
43  struct
44  {
45  /**
46  * IP 4/6 address in the rx/tx direction
47  */
48  ip46_address_t cs_ip[VLIB_N_DIR];
49 
50  /**
51  * ports in rx/tx
52  */
54 
55  /**
56  * The IP protocol TCP or UDP only supported
57  */
59 
60  /**
61  * The address family describing the IP addresses
62  */
64 
65  /**
66  * spare space
67  */
68  u8 __cs_pad[2];
69  } key;
70  /**
71  * this value sits in the same memory location a 'value' in the bihash kvp
72  */
73  struct
74  {
75  /**
76  * The IP address to translate to.
77  */
78  ip46_address_t cs_ip[VLIB_N_DIR];
79 
80  /**
81  * the port to translate to.
82  */
84 
85  /**
86  * The load balance object to use to forward
87  */
89 
90  /**
91  * Timestamp index this session was last used
92  */
94  /**
95  * Indicates a return path session that was source NATed
96  * on the way in.
97  */
99  } value;
101 
103 {
108 
109 extern u8 *format_cnat_session (u8 * s, va_list * args);
110 
111 /**
112  * Ensure the session object correctly overlays the bihash key/value pair
113  */
116  "key overlaps");
119  "value overlaps");
121  "session kvp");
122 
123 /**
124  * The DB of sessions
125  */
126 extern clib_bihash_40_48_t cnat_session_db;
127 
128 /**
129  * Callback function invoked during a walk of all translations
130  */
132  session, void *ctx);
133 
134 /**
135  * Walk/visit each of the cnat session
136  */
137 extern void cnat_session_walk (cnat_session_walk_cb_t cb, void *ctx);
138 
139 /**
140  * Scan the session DB for expired sessions
141  */
142 extern u64 cnat_session_scan (vlib_main_t * vm, f64 start_time, int i);
143 
144 /**
145  * Purge all the sessions
146  */
147 extern int cnat_session_purge (void);
148 
149 /*
150  * fd.io coding-style-patch-verification: ON
151  *
152  * Local Variables:
153  * eval: (c-set-style "gnu")
154  * End:
155  */
156 
157 #endif
unsigned long u64
Definition: types.h:89
u16 cs_port[VLIB_N_DIR]
ports in rx/tx
Definition: cnat_session.h:53
u32 index_t
A Data-Path Object is an object that represents actions that are applied to packets are they are swit...
Definition: dpo.h:41
#define STRUCT_OFFSET_OF(t, f)
Definition: clib.h:70
vlib_main_t * vm
Definition: in2out_ed.c:1582
unsigned char u8
Definition: types.h:56
double f64
Definition: types.h:142
A session represents the memory of a translation.
Definition: cnat_session.h:38
enum walk_rc_t_ walk_rc_t
Walk return code.
u8 cs_af
The address family describing the IP addresses.
Definition: cnat_session.h:63
STATIC_ASSERT(STRUCT_OFFSET_OF(cnat_session_t, key)==STRUCT_OFFSET_OF(clib_bihash_kv_40_48_t, key), "key overlaps")
Ensure the session object correctly overlays the bihash key/value pair.
cnat_session_flag_t_
Definition: cnat_session.h:102
unsigned int u32
Definition: types.h:88
ip46_address_t cs_ip[VLIB_N_DIR]
IP 4/6 address in the rx/tx direction.
Definition: cnat_session.h:48
u32 cs_ts_index
Timestamp index this session was last used.
Definition: cnat_session.h:93
enum ip_protocol ip_protocol_t
long ctx[MAX_CONNS]
Definition: main.c:144
unsigned short u16
Definition: types.h:57
int cnat_session_purge(void)
Purge all the sessions.
Definition: cnat_session.c:140
index_t cs_lbi
The load balance object to use to forward.
Definition: cnat_session.h:88
u8 * format_cnat_session(u8 *s, va_list *args)
Definition: cnat_session.c:70
sll srl srl sll sra u16x4 i
Definition: vector_sse42.h:317
u64 cnat_session_scan(vlib_main_t *vm, f64 start_time, int i)
Scan the session DB for expired sessions.
Definition: cnat_session.c:157
u32 flags
Indicates a return path session that was source NATed on the way in.
Definition: cnat_session.h:98
struct cnat_session_t_::@637 value
this value sits in the same memory location a &#39;value&#39; in the bihash kvp
#define VLIB_N_DIR
Definition: defs.h:57
struct cnat_session_t_ cnat_session_t
A session represents the memory of a translation.
void cnat_session_walk(cnat_session_walk_cb_t cb, void *ctx)
Walk/visit each of the cnat session.
Definition: cnat_session.c:44
ip_protocol_t cs_proto
The IP protocol TCP or UDP only supported.
Definition: cnat_session.h:58
clib_bihash_40_48_t cnat_session_db
The DB of sessions.
Definition: cnat_session.c:23
struct cnat_session_t_::@636 key
this key sits in the same memory location a &#39;key&#39; in the bihash kvp
walk_rc_t(* cnat_session_walk_cb_t)(const cnat_session_t *session, void *ctx)
Callback function invoked during a walk of all translations.
Definition: cnat_session.h:131
enum cnat_session_flag_t_ cnat_session_flag_t