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));
47 if (!(cc->flags & CNAT_FLAG_EXCLUSIVE))
49 ASSERT (fib_entry_is_sourced (cc->cc_fei, cnat_fib_source));
50 fib_table_entry_delete_index (cc->cc_fei, cnat_fib_source);
52 cnat_client_db_remove (cc);
53 dpo_reset (&cc->cc_parent);
54 pool_put (cnat_client_pool, cc);
58 cnat_client_free_by_ip (ip46_address_t * ip, u8 af)
62 cnat_client_ip4_find (&ip->ip4) : cnat_client_ip6_find (&ip->ip6));
65 if ((0 == cnat_client_uncnt_session (cc))
66 && (cc->flags & CNAT_FLAG_EXPIRES) && (0 == cc->tr_refcnt))
67 cnat_client_destroy (cc);
71 cnat_client_throttle_pool_process ()
73 /* This processes ips stored in the throttle pool
74 to update session refcounts
75 and should be called before cnat_client_free_by_ip */
76 vlib_thread_main_t *tm = vlib_get_thread_main ();
79 u32 *del_vec = NULL, *ai;
81 nthreads = tm->n_threads + 1;
82 for (int i = 0; i < nthreads; i++)
84 vec_reset_length (del_vec);
85 clib_spinlock_lock (&cnat_client_db.throttle_pool_lock[i]);
87 pool_foreach (addr, cnat_client_db.throttle_pool[i]) {
88 cc = (AF_IP4 == addr->version ?
89 cnat_client_ip4_find (&ip_addr_v4(addr)) :
90 cnat_client_ip6_find (&ip_addr_v6(addr)));
91 /* Client might not already be created */
94 cnat_client_cnt_session (cc);
95 vec_add1(del_vec, addr - cnat_client_db.throttle_pool[i]);
99 vec_foreach (ai, del_vec)
101 addr = pool_elt_at_index (cnat_client_db.throttle_pool[i], *ai);
102 pool_put (cnat_client_db.throttle_pool[i], addr);
104 clib_spinlock_unlock (&cnat_client_db.throttle_pool_lock[i]);
109 cnat_client_translation_added (index_t cci)
112 if (INDEX_INVALID == cci)
115 cc = cnat_client_get (cci);
116 ASSERT (!(cc->flags & CNAT_FLAG_EXPIRES));
121 cnat_client_translation_deleted (index_t cci)
124 if (INDEX_INVALID == cci)
127 cc = cnat_client_get (cci);
128 ASSERT (!(cc->flags & CNAT_FLAG_EXPIRES));
131 if (0 == cc->tr_refcnt && 0 == cc->session_refcnt)
132 cnat_client_destroy (cc);
136 cnat_client_db_add (cnat_client_t * cc)
140 cci = cc - cnat_client_pool;
142 if (ip_addr_version (&cc->cc_ip) == AF_IP4)
143 hash_set (cnat_client_db.crd_cip4, ip_addr_v4 (&cc->cc_ip).as_u32, cci);
145 hash_set_mem_alloc (&cnat_client_db.crd_cip6,
146 &ip_addr_v6 (&cc->cc_ip), cci);
151 cnat_client_add (const ip_address_t * ip, u8 flags)
154 dpo_id_t tmp = DPO_INVALID;
155 fib_node_index_t fei;
161 /* check again if we need this client */
162 cc = (AF_IP4 == ip->version ?
163 cnat_client_ip4_find (&ip->ip.ip4) :
164 cnat_client_ip6_find (&ip->ip.ip6));
167 return (cc - cnat_client_pool);
170 pool_get_aligned (cnat_client_pool, cc, CLIB_CACHE_LINE_BYTES);
172 cci = cc - cnat_client_pool;
173 cc->parent_cci = cci;
176 cc->session_refcnt = 0;
178 ip_address_copy (&cc->cc_ip, ip);
179 cnat_client_db_add (cc);
181 ip_address_to_fib_prefix (&cc->cc_ip, &pfx);
183 dproto = fib_proto_to_dpo (pfx.fp_proto);
184 dpo_set (&tmp, cnat_client_dpo, dproto, cci);
185 dpo_stack (cnat_client_dpo, dproto, &cc->cc_parent, drop_dpo_get (dproto));
187 fib_flags = FIB_ENTRY_FLAG_LOOSE_URPF_EXEMPT;
188 fib_flags |= (flags & CNAT_FLAG_EXCLUSIVE) ?
189 FIB_ENTRY_FLAG_EXCLUSIVE : FIB_ENTRY_FLAG_INTERPOSE;
191 fei = fib_table_entry_special_dpo_add (CNAT_FIB_TABLE,
192 &pfx, cnat_fib_source, fib_flags,
195 cc = pool_elt_at_index (cnat_client_pool, cci);
202 cnat_client_learn (const cnat_learn_arg_t * l)
204 /* RPC call to add a client from the dataplane */
207 cci = cnat_client_add (&l->addr, CNAT_FLAG_EXPIRES);
208 cc = pool_elt_at_index (cnat_client_pool, cci);
209 cnat_client_cnt_session (cc);
210 /* Process throttled calls if any */
211 cnat_client_throttle_pool_process ();
215 * Interpose a policy DPO
218 cnat_client_dpo_interpose (const dpo_id_t * original,
219 const dpo_id_t * parent, dpo_id_t * clone)
221 cnat_client_t *cc, *cc_clone;
223 pool_get_zero (cnat_client_pool, cc_clone);
224 cc = cnat_client_get (original->dpoi_index);
226 cc_clone->cc_fei = FIB_NODE_INDEX_INVALID;
227 cc_clone->parent_cci = cc->parent_cci;
228 cc_clone->flags = cc->flags;
229 ip_address_copy (&cc_clone->cc_ip, &cc->cc_ip);
231 /* stack the clone on the FIB provided parent */
232 dpo_stack (cnat_client_dpo, original->dpoi_proto, &cc_clone->cc_parent,
235 /* return the clone */
238 original->dpoi_proto, cc_clone - cnat_client_pool);
242 cnat_client_purge (void)
244 vlib_thread_main_t *tm = vlib_get_thread_main ();
246 nthreads = tm->n_threads + 1;
247 ASSERT (0 == hash_elts (cnat_client_db.crd_cip6));
248 ASSERT (0 == hash_elts (cnat_client_db.crd_cip4));
249 ASSERT (0 == pool_elts (cnat_client_pool));
250 for (int i = 0; i < nthreads; i++)
252 ASSERT (0 == pool_elts (cnat_client_db.throttle_pool[i]));
258 format_cnat_client (u8 * s, va_list * args)
260 index_t cci = va_arg (*args, index_t);
261 u32 indent = va_arg (*args, u32);
263 cnat_client_t *cc = pool_elt_at_index (cnat_client_pool, cci);
265 s = format (s, "[%d] cnat-client:[%U] tr:%d sess:%d", cci,
266 format_ip_address, &cc->cc_ip,
267 cc->tr_refcnt, cc->session_refcnt);
268 if (cc->flags & CNAT_FLAG_EXPIRES)
269 s = format (s, " expires");
271 if (cc->flags & CNAT_FLAG_EXCLUSIVE)
272 s = format (s, " exclusive");
274 if (cnat_client_is_clone (cc))
275 s = format (s, "\n%Uclone of [%d]\n%U%U",
276 format_white_space, indent + 2, cc->parent_cci,
277 format_white_space, indent + 2,
278 format_dpo_id, &cc->cc_parent, indent + 4);
284 static clib_error_t *
285 cnat_client_show (vlib_main_t * vm,
286 unformat_input_t * input, vlib_cli_command_t * cmd)
292 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
294 if (unformat (input, "%d", &cci))
297 return (clib_error_return (0, "unknown input '%U'",
298 format_unformat_error, input));
301 if (INDEX_INVALID == cci)
304 pool_foreach_index (cci, cnat_client_pool)
305 vlib_cli_output(vm, "%U", format_cnat_client, cci, 0);
308 vlib_cli_output (vm, "%d clients", pool_elts (cnat_client_pool));
309 vlib_cli_output (vm, "%d timestamps", pool_elts (cnat_timestamps));
313 vlib_cli_output (vm, "Invalid policy ID:%d", cci);
320 VLIB_CLI_COMMAND (cnat_client_show_cmd_node, static) = {
321 .path = "show cnat client",
322 .function = cnat_client_show,
323 .short_help = "show cnat client",
328 const static char *const cnat_client_dpo_ip4_nodes[] = {
333 const static char *const cnat_client_dpo_ip6_nodes[] = {
338 const static char *const *const cnat_client_dpo_nodes[DPO_PROTO_NUM] = {
339 [DPO_PROTO_IP4] = cnat_client_dpo_ip4_nodes,
340 [DPO_PROTO_IP6] = cnat_client_dpo_ip6_nodes,
344 cnat_client_dpo_lock (dpo_id_t * dpo)
348 cc = cnat_client_get (dpo->dpoi_index);
354 cnat_client_dpo_unlock (dpo_id_t * dpo)
358 cc = cnat_client_get (dpo->dpoi_index);
362 if (0 == cc->cc_locks)
364 ASSERT (cnat_client_is_clone (cc));
365 pool_put (cnat_client_pool, cc);
370 format_cnat_client_dpo (u8 * s, va_list * ap)
372 index_t cci = va_arg (*ap, index_t);
373 u32 indent = va_arg (*ap, u32);
375 s = format (s, "%U", format_cnat_client, cci, indent);
380 const static dpo_vft_t cnat_client_dpo_vft = {
381 .dv_lock = cnat_client_dpo_lock,
382 .dv_unlock = cnat_client_dpo_unlock,
383 .dv_format = format_cnat_client_dpo,
384 .dv_mk_interpose = cnat_client_dpo_interpose,
387 static clib_error_t *
388 cnat_client_init (vlib_main_t * vm)
390 vlib_thread_main_t *tm = vlib_get_thread_main ();
391 int nthreads = tm->n_threads + 1;
393 cnat_client_dpo = dpo_register_new_type (&cnat_client_dpo_vft,
394 cnat_client_dpo_nodes);
396 cnat_client_db.crd_cip6 = hash_create_mem (0,
397 sizeof (ip6_address_t),
400 vec_validate (cnat_client_db.throttle_pool, nthreads);
401 vec_validate (cnat_client_db.throttle_pool_lock, nthreads);
402 for (i = 0; i < nthreads; i++)
403 clib_spinlock_init (&cnat_client_db.throttle_pool_lock[i]);
408 VLIB_INIT_FUNCTION (cnat_client_init);
411 * fd.io coding-style-patch-verification: ON
414 * eval: (c-set-style "gnu")