FD.io VPP  v20.09-64-g4f7b92f0a
Vector Packet Processing
cnat_client.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_CLIENT_H__
17 #define __CNAT_CLIENT_H__
18 
19 #include <cnat/cnat_types.h>
20 
21 /**
22  * A client is a representation of an IP address behind the NAT.
23  * A client thus sends packet to a VIP.
24  * Clients are learned in the Data-plane when they send packets,
25  * but, since they make additions to the FIB they must be programmed
26  * in the main thread. They are aged out when they become idle.
27  *
28  * A client interposes in the FIB graph for the prefix corresponding
29  * to the client (e.g. client's-IP/32). As a result this client object
30  * is cloned as the interpose DPO. The clones are removed when the lock
31  * count drops to zero. The originals are removed when the client ages.
32  * At forwarding time the client preforms the reverse translation and
33  * then ships the packet to where the FIB would send it.
34  */
35 typedef struct cnat_client_t_
36 {
37  CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
38 
39  /**
40  * the client's IP address
41  */
43 
44  /**
45  * How to send packets to this client post translation
46  */
48 
49  /**
50  * the FIB entry this client sources
51  */
53 
54  /**
55  * number of DPO locks
56  */
58 
59  /**
60  * Translations refcount for cleanup
61  */
63 
64  /**
65  * Session refcount for cleanup
66  */
68 
69  /**
70  * Parent cnat_client index if cloned via interpose
71  * or own index if vanilla client.
72  * Used to get translations & update session_refcnt
73  */
75 
76  /**
77  * Client flags
78  */
81 
82 extern u8 *format_cnat_client (u8 * s, va_list * args);
83 extern void cnat_client_free_by_ip (ip46_address_t * addr, u8 af);
84 
87 
88 #define CC_INDEX_INVALID ((u32)(~0))
89 
92 {
93  return (pool_elt_at_index (cnat_client_pool, i));
94 }
95 
96 typedef struct cnat_learn_arg_t_
97 {
100 
101 /**
102  * A translation that references this VIP was deleted
103  */
104 extern void cnat_client_translation_deleted (index_t cci);
105 
106 /**
107  * A translation that references this VIP was added
108  */
109 extern void cnat_client_translation_added (index_t cci);
110 /**
111  * Called in the main thread by RPC from the workers to learn a
112  * new client
113  */
114 extern void cnat_client_learn (const cnat_learn_arg_t * l);
115 
116 extern index_t cnat_client_add (const ip_address_t * ip, u8 flags);
117 
118 /**
119  * Check all the clients were purged by translation & session purge
120  */
121 extern int cnat_client_purge (void);
122 
123 /**
124  * CNat Client (dpo) flags
125  */
126 typedef enum
127 {
128  /* IP already present in the FIB, need to interpose dpo */
130  /* Prune this entry */
131  CNAT_FLAG_EXPIRES = (1 << 2),
133 
134 
135 extern void cnat_client_throttle_pool_process ();
136 
137 /**
138  * DB of clients
139  */
140 typedef struct cnat_client_db_t_
141 {
144  /* Pool of addresses that have been throttled
145  and need to be refcounted before calling
146  cnat_client_free_by_ip */
150 
152 
153 /**
154  * Find a client from an IP4 address
155  */
158 {
159  uword *p;
160 
161  p = hash_get (cnat_client_db.crd_cip4, ip->as_u32);
162 
163  if (p)
164  return (pool_elt_at_index (cnat_client_pool, p[0]));
165 
166  return (NULL);
167 }
168 
171 {
172  uword *p;
173 
174  p = hash_get (cnat_client_db.crd_cip4, ip->as_u32);
175 
176  if (p)
177  return p[0];
178 
179  return -1;
180 }
181 
182 /**
183  * Find a client from an IP6 address
184  */
186 cnat_client_ip6_find (const ip6_address_t * ip)
187 {
188  uword *p;
189 
190  p = hash_get_mem (cnat_client_db.crd_cip6, ip);
191 
192  if (p)
193  return (pool_elt_at_index (cnat_client_pool, p[0]));
194 
195  return (NULL);
196 }
197 
198 /**
199  * Add a session refcnt to this client
200  */
203 {
205  return clib_atomic_add_fetch (&ccp->session_refcnt, 1);
206 }
207 
208 /**
209  * Del a session refcnt to this client
210  */
213 {
215  return clib_atomic_sub_fetch (&ccp->session_refcnt, 1);
216 }
217 
218 /*
219  * fd.io coding-style-patch-verification: ON
220  *
221  * Local Variables:
222  * eval: (c-set-style "gnu")
223  * End:
224  */
225 
226 #endif
u32 session_refcnt
Session refcount for cleanup.
Definition: cnat_client.h:67
ip_address_t ** throttle_pool
Definition: cnat_client.h:147
u8 * format_cnat_client(u8 *s, va_list *args)
Definition: cnat_client.c:248
#define clib_atomic_add_fetch(a, b)
Definition: atomics.h:30
struct cnat_client_t_ cnat_client_t
A client is a representation of an IP address behind the NAT.
cnat_client_db_t cnat_client_db
Definition: cnat_client.c:24
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
dpo_id_t cc_parent
How to send packets to this client post translation.
Definition: cnat_client.h:47
u32 tr_refcnt
Translations refcount for cleanup.
Definition: cnat_client.h:62
index_t parent_cci
Parent cnat_client index if cloned via interpose or own index if vanilla client.
Definition: cnat_client.h:74
vhost_vring_addr_t addr
Definition: vhost_user.h:111
unsigned char u8
Definition: types.h:56
int cnat_client_purge(void)
Check all the clients were purged by translation & session purge.
Definition: cnat_client.c:239
struct cnat_client_db_t_ cnat_client_db_t
DB of clients.
#define static_always_inline
Definition: clib.h:108
cnat_client_t * cnat_client_pool
Definition: cnat_client.c:22
enum dpo_type_t_ dpo_type_t
Common types of data-path objects New types can be dynamically added using dpo_register_new_type() ...
static_always_inline u32 cnat_client_uncnt_session(cnat_client_t *cc)
Del a session refcnt to this client.
Definition: cnat_client.h:212
unsigned int u32
Definition: types.h:88
CLIB_CACHE_LINE_ALIGN_MARK(cacheline0)
static_always_inline u32 cnat_client_cnt_session(cnat_client_t *cc)
Add a session refcnt to this client.
Definition: cnat_client.h:202
The identity of a DPO is a combination of its type and its instance number/index of objects of that t...
Definition: dpo.h:170
#define hash_get(h, key)
Definition: hash.h:249
#define pool_elt_at_index(p, i)
Returns pointer to element at given index.
Definition: pool.h:534
ip_address_t addr
Definition: cnat_client.h:98
static_always_inline cnat_client_t * cnat_client_ip4_find(const ip4_address_t *ip)
Find a client from an IP4 address.
Definition: cnat_client.h:157
static_always_inline cnat_client_t * cnat_client_get(index_t i)
Definition: cnat_client.h:91
void cnat_client_learn(const cnat_learn_arg_t *l)
Called in the main thread by RPC from the workers to learn a new client.
Definition: cnat_client.c:199
#define clib_atomic_sub_fetch(a, b)
Definition: atomics.h:31
fib_node_index_t cc_fei
the FIB entry this client sources
Definition: cnat_client.h:52
clib_spinlock_t * throttle_pool_lock
Definition: cnat_client.h:148
sll srl srl sll sra u16x4 i
Definition: vector_sse42.h:317
u32 fib_node_index_t
A typedef of a node index.
Definition: fib_types.h:30
u32 cc_locks
number of DPO locks
Definition: cnat_client.h:57
cnat_entry_flag_t
CNat Client (dpo) flags.
Definition: cnat_client.h:126
void cnat_client_translation_added(index_t cci)
A translation that references this VIP was added.
Definition: cnat_client.c:113
static_always_inline cnat_client_t * cnat_client_ip6_find(const ip6_address_t *ip)
Find a client from an IP6 address.
Definition: cnat_client.h:186
void cnat_client_throttle_pool_process()
Definition: cnat_client.c:74
DB of clients.
Definition: cnat_client.h:140
vl_api_address_t ip
Definition: l2.api:501
u64 uword
Definition: types.h:112
void cnat_client_translation_deleted(index_t cci)
A translation that references this VIP was deleted.
Definition: cnat_client.c:122
#define hash_get_mem(h, key)
Definition: hash.h:269
ip_address_t cc_ip
the client&#39;s IP address
Definition: cnat_client.h:42
static_always_inline u32 cnat_client_ip4_find_index(const ip4_address_t *ip)
Definition: cnat_client.h:170
struct cnat_learn_arg_t_ cnat_learn_arg_t
index_t cnat_client_add(const ip_address_t *ip, u8 flags)
Definition: cnat_client.c:150
void cnat_client_free_by_ip(ip46_address_t *addr, u8 af)
Definition: cnat_client.c:59
u8 flags
Client flags.
Definition: cnat_client.h:79
dpo_type_t cnat_client_dpo
Definition: cnat_client.c:26
A client is a representation of an IP address behind the NAT.
Definition: cnat_client.h:35