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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
16 #include <vnet/fib/fib_table.h>
17 #include <vnet/dpo/drop_dpo.h>
19 #include <cnat/cnat_client.h>
20 #include <cnat/cnat_translation.h>
22 cnat_client_t *cnat_client_pool;
24 cnat_client_db_t cnat_client_db;
26 dpo_type_t cnat_client_dpo;
28 static_always_inline u8
29 cnat_client_is_clone (cnat_client_t * cc)
31 return (FIB_NODE_INDEX_INVALID == cc->cc_fei);
35 cnat_client_db_remove (cnat_client_t * cc)
37 if (ip_addr_version (&cc->cc_ip) == AF_IP4)
38 hash_unset (cnat_client_db.crd_cip4, ip_addr_v4 (&cc->cc_ip).as_u32);
40 hash_unset_mem_free (&cnat_client_db.crd_cip6, &ip_addr_v6 (&cc->cc_ip));
44 cnat_client_destroy (cnat_client_t * cc)
46 ASSERT (!cnat_client_is_clone (cc));
48 ASSERT (fib_entry_is_sourced (cc->cc_fei, cnat_fib_source));
49 fib_table_entry_delete_index (cc->cc_fei, cnat_fib_source);
51 cnat_client_db_remove (cc);
52 dpo_reset (&cc->cc_parent);
53 pool_put (cnat_client_pool, cc);
57 cnat_client_free_by_ip (ip46_address_t * ip, u8 af)
61 cnat_client_ip4_find (&ip->ip4) : cnat_client_ip6_find (&ip->ip6));
64 if (0 == cnat_client_uncnt_session (cc) && 0 == cc->tr_refcnt)
65 cnat_client_destroy (cc);
69 cnat_client_throttle_pool_process ()
71 /* This processes ips stored in the throttle pool
72 to update session refcounts
73 and should be called before cnat_client_free_by_ip */
75 ip_address_t *addr, *del_vec = NULL;
78 vec_reset_length (del_vec);
79 clib_spinlock_lock (&cnat_client_db.throttle_lock);
80 hash_foreach_mem (addr, refcnt, cnat_client_db.throttle_mem, {
81 cc = (AF_IP4 == addr->version ? cnat_client_ip4_find (&ip_addr_v4 (addr)) :
82 cnat_client_ip6_find (&ip_addr_v6 (addr)));
83 /* Client might not already be created */
86 cnat_client_t *ccp = cnat_client_get (cc->parent_cci);
87 clib_atomic_add_fetch (&ccp->session_refcnt, refcnt);
88 vec_add1 (del_vec, *addr);
91 vec_foreach (addr, del_vec)
92 hash_unset_mem_free (&cnat_client_db.throttle_mem, addr);
93 clib_spinlock_unlock (&cnat_client_db.throttle_lock);
97 cnat_client_translation_added (index_t cci)
100 if (INDEX_INVALID == cci)
103 cc = cnat_client_get (cci);
108 cnat_client_translation_deleted (index_t cci)
111 if (INDEX_INVALID == cci)
114 cc = cnat_client_get (cci);
117 if (0 == cc->tr_refcnt && 0 == cc->session_refcnt)
118 cnat_client_destroy (cc);
122 cnat_client_db_add (cnat_client_t * cc)
126 cci = cc - cnat_client_pool;
128 if (ip_addr_version (&cc->cc_ip) == AF_IP4)
129 hash_set (cnat_client_db.crd_cip4, ip_addr_v4 (&cc->cc_ip).as_u32, cci);
131 hash_set_mem_alloc (&cnat_client_db.crd_cip6,
132 &ip_addr_v6 (&cc->cc_ip), cci);
137 cnat_client_add (const ip_address_t * ip, u8 flags)
140 dpo_id_t tmp = DPO_INVALID;
141 fib_node_index_t fei;
147 /* check again if we need this client */
148 cc = (AF_IP4 == ip->version ?
149 cnat_client_ip4_find (&ip->ip.ip4) :
150 cnat_client_ip6_find (&ip->ip.ip6));
153 return (cc - cnat_client_pool);
156 pool_get_aligned (cnat_client_pool, cc, CLIB_CACHE_LINE_BYTES);
158 cci = cc - cnat_client_pool;
159 cc->parent_cci = cci;
162 cc->session_refcnt = 0;
164 ip_address_copy (&cc->cc_ip, ip);
165 cnat_client_db_add (cc);
167 ip_address_to_fib_prefix (&cc->cc_ip, &pfx);
169 dproto = fib_proto_to_dpo (pfx.fp_proto);
170 dpo_set (&tmp, cnat_client_dpo, dproto, cci);
171 dpo_stack (cnat_client_dpo, dproto, &cc->cc_parent, drop_dpo_get (dproto));
173 fib_flags = FIB_ENTRY_FLAG_LOOSE_URPF_EXEMPT;
174 fib_flags |= (flags & CNAT_FLAG_EXCLUSIVE) ?
175 FIB_ENTRY_FLAG_EXCLUSIVE : FIB_ENTRY_FLAG_INTERPOSE;
177 fei = fib_table_entry_special_dpo_add (CNAT_FIB_TABLE,
178 &pfx, cnat_fib_source, fib_flags,
181 cc = pool_elt_at_index (cnat_client_pool, cci);
188 cnat_client_learn (const ip_address_t *addr)
190 /* RPC call to add a client from the dataplane */
193 cci = cnat_client_add (addr, 0 /* flags */);
194 cc = pool_elt_at_index (cnat_client_pool, cci);
195 cnat_client_cnt_session (cc);
196 /* Process throttled calls if any */
197 cnat_client_throttle_pool_process ();
201 * Interpose a policy DPO
204 cnat_client_dpo_interpose (const dpo_id_t * original,
205 const dpo_id_t * parent, dpo_id_t * clone)
207 cnat_client_t *cc, *cc_clone;
209 pool_get_zero (cnat_client_pool, cc_clone);
210 cc = cnat_client_get (original->dpoi_index);
212 cc_clone->cc_fei = FIB_NODE_INDEX_INVALID;
213 cc_clone->parent_cci = cc->parent_cci;
214 cc_clone->flags = cc->flags;
215 ip_address_copy (&cc_clone->cc_ip, &cc->cc_ip);
217 /* stack the clone on the FIB provided parent */
218 dpo_stack (cnat_client_dpo, original->dpoi_proto, &cc_clone->cc_parent,
221 /* return the clone */
224 original->dpoi_proto, cc_clone - cnat_client_pool);
228 cnat_client_purge (void)
231 if ((rv = hash_elts (cnat_client_db.crd_cip6)))
232 clib_warning ("len(crd_cip6) isnt 0 but %d", rv);
234 if ((rv = hash_elts (cnat_client_db.crd_cip4)))
235 clib_warning ("len(crd_cip4) isnt 0 but %d", rv);
237 if ((rv = pool_elts (cnat_client_pool)))
238 clib_warning ("len(cnat_client_pool) isnt 0 but %d", rv);
240 if ((rv = hash_elts (cnat_client_db.throttle_mem)))
241 clib_warning ("len(throttle_mem) isnt 0 but %d", rv);
247 format_cnat_client (u8 * s, va_list * args)
249 index_t cci = va_arg (*args, index_t);
250 u32 indent = va_arg (*args, u32);
252 cnat_client_t *cc = pool_elt_at_index (cnat_client_pool, cci);
254 s = format (s, "[%d] cnat-client:[%U] tr:%d sess:%d", cci,
255 format_ip_address, &cc->cc_ip,
256 cc->tr_refcnt, cc->session_refcnt);
258 if (cc->flags & CNAT_FLAG_EXCLUSIVE)
259 s = format (s, " exclusive");
261 if (cnat_client_is_clone (cc))
262 s = format (s, "\n%Uclone of [%d]\n%U%U",
263 format_white_space, indent + 2, cc->parent_cci,
264 format_white_space, indent + 2,
265 format_dpo_id, &cc->cc_parent, indent + 4);
271 static clib_error_t *
272 cnat_client_show (vlib_main_t * vm,
273 unformat_input_t * input, vlib_cli_command_t * cmd)
279 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
281 if (unformat (input, "%d", &cci))
284 return (clib_error_return (0, "unknown input '%U'",
285 format_unformat_error, input));
288 if (INDEX_INVALID == cci)
290 pool_foreach_index (cci, cnat_client_pool)
291 vlib_cli_output(vm, "%U", format_cnat_client, cci, 0);
293 vlib_cli_output (vm, "%d clients", pool_elts (cnat_client_pool));
294 vlib_cli_output (vm, "%d timestamps", pool_elts (cnat_timestamps));
298 vlib_cli_output (vm, "Invalid policy ID:%d", cci);
304 VLIB_CLI_COMMAND (cnat_client_show_cmd_node, static) = {
305 .path = "show cnat client",
306 .function = cnat_client_show,
307 .short_help = "show cnat client",
311 const static char *const cnat_client_dpo_ip4_nodes[] = {
316 const static char *const cnat_client_dpo_ip6_nodes[] = {
321 const static char *const *const cnat_client_dpo_nodes[DPO_PROTO_NUM] = {
322 [DPO_PROTO_IP4] = cnat_client_dpo_ip4_nodes,
323 [DPO_PROTO_IP6] = cnat_client_dpo_ip6_nodes,
327 cnat_client_dpo_lock (dpo_id_t * dpo)
331 cc = cnat_client_get (dpo->dpoi_index);
337 cnat_client_dpo_unlock (dpo_id_t * dpo)
341 cc = cnat_client_get (dpo->dpoi_index);
345 if (0 == cc->cc_locks)
347 ASSERT (cnat_client_is_clone (cc));
348 dpo_reset (&cc->cc_parent);
349 pool_put (cnat_client_pool, cc);
354 format_cnat_client_dpo (u8 * s, va_list * ap)
356 index_t cci = va_arg (*ap, index_t);
357 u32 indent = va_arg (*ap, u32);
359 s = format (s, "%U", format_cnat_client, cci, indent);
364 const static dpo_vft_t cnat_client_dpo_vft = {
365 .dv_lock = cnat_client_dpo_lock,
366 .dv_unlock = cnat_client_dpo_unlock,
367 .dv_format = format_cnat_client_dpo,
368 .dv_mk_interpose = cnat_client_dpo_interpose,
371 static clib_error_t *
372 cnat_client_init (vlib_main_t * vm)
374 cnat_client_dpo = dpo_register_new_type (&cnat_client_dpo_vft,
375 cnat_client_dpo_nodes);
377 cnat_client_db.crd_cip6 = hash_create_mem (0,
378 sizeof (ip6_address_t),
381 clib_spinlock_init (&cnat_client_db.throttle_lock);
382 cnat_client_db.throttle_mem =
383 hash_create_mem (0, sizeof (ip_address_t), sizeof (uword));
388 VLIB_INIT_FUNCTION (cnat_client_init);
391 * fd.io coding-style-patch-verification: ON
394 * eval: (c-set-style "gnu")