1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
|
/*
* Copyright (c) 2020 Cisco and/or its affiliates.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef __CNAT_SESSION_H__
#define __CNAT_SESSION_H__
#include <vnet/udp/udp_packet.h>
#include <cnat/cnat_types.h>
#include <cnat/cnat_client.h>
#include <cnat/cnat_bihash.h>
/**
* A session represents the memory of a translation.
* In the tx direction (from behind to in front of the NAT), the
* session is preserved so subsequent packets follow the same path
* even if the translation has been updated. In the tx direction
* the session represents the swap from the VIP to the server address
* In the RX direction the swap is from the server address/port to VIP.
*
* A session exists only as key and value in the bihash, there is no
* pool for this object. If there were a pool, one would need to be
* concerned about what worker is using it.
*/
typedef struct cnat_session_t_
{
/**
* this key sits in the same memory location a 'key' in the bihash kvp
*/
struct
{
/**
* IP 4/6 address in the rx/tx direction
*/
ip46_address_t cs_ip[VLIB_N_DIR];
/**
* ports in rx/tx
*/
u16 cs_port[VLIB_N_DIR];
/**
* The IP protocol TCP or UDP only supported
*/
ip_protocol_t cs_proto;
/**
* The address family describing the IP addresses
*/
u8 cs_af;
/**
* input / output / fib session
*/
u8 cs_loc;
u8 __cs_pad;
} key;
/**
* this value sits in the same memory location a 'value' in the bihash kvp
*/
struct
{
/**
* The IP address to translate to.
*/
ip46_address_t cs_ip[VLIB_N_DIR];
/**
* the port to translate to.
*/
u16 cs_port[VLIB_N_DIR];
/**
* The load balance object to use to forward
*/
index_t cs_lbi;
/**
* Persist translation->ct_lb.dpoi_next_node
*/
u32 dpoi_next_node;
/**
* Timestamp index this session was last used
*/
u32 cs_ts_index;
/**
* session flags
*/
u32 flags;
u32 __pad;
} value;
} cnat_session_t;
typedef enum cnat_session_flag_t_
{
/**
* Indicates a return path session that was source NATed
* on the way in.
*/
CNAT_SESSION_FLAG_HAS_SNAT = (1 << 0),
/**
* This session source port was allocated, free it on cleanup
*/
CNAT_SESSION_FLAG_ALLOC_PORT = (1 << 1),
/**
* This session doesn't have a client, do not attempt to free it
*/
CNAT_SESSION_FLAG_NO_CLIENT = (1 << 2),
} cnat_session_flag_t;
typedef enum cnat_session_location_t_
{
CNAT_LOCATION_INPUT = 0,
CNAT_LOCATION_OUTPUT = 1,
CNAT_LOCATION_FIB = 0xff,
} cnat_session_location_t;
extern u8 *format_cnat_session (u8 * s, va_list * args);
/**
* Ensure the session object correctly overlays the bihash key/value pair
*/
STATIC_ASSERT (STRUCT_OFFSET_OF (cnat_session_t, key) ==
STRUCT_OFFSET_OF (cnat_bihash_kv_t, key),
"key overlaps");
STATIC_ASSERT (STRUCT_OFFSET_OF (cnat_session_t, value) ==
STRUCT_OFFSET_OF (cnat_bihash_kv_t, value),
"value overlaps");
STATIC_ASSERT (sizeof (cnat_session_t) == sizeof (cnat_bihash_kv_t),
"session kvp");
/**
* The DB of sessions
*/
extern cnat_bihash_t cnat_session_db;
/**
* Callback function invoked during a walk of all translations
*/
typedef walk_rc_t (*cnat_session_walk_cb_t) (const cnat_session_t *
session, void *ctx);
/**
* Walk/visit each of the cnat session
*/
extern void cnat_session_walk (cnat_session_walk_cb_t cb, void *ctx);
/**
* Scan the session DB for expired sessions
*/
extern u64 cnat_session_scan (vlib_main_t * vm, f64 start_time, int i);
/**
* Purge all the sessions
*/
extern int cnat_session_purge (void);
/**
* Free a session & update refcounts
*/
extern void cnat_session_free (cnat_session_t * session);
/**
* Port cleanup callback
*/
extern void (*cnat_free_port_cb) (u16 port, ip_protocol_t iproto);
/*
* fd.io coding-style-patch-verification: ON
*
* Local Variables:
* eval: (c-set-style "gnu")
* End:
*/
#endif
|
