2 * Copyright (c) 2016 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.
17 * @brief Common utility functions for IPv4, IPv6 and L2 LISP-GPE adjacencys.
21 #include <vnet/dpo/load_balance.h>
22 #include <vnet/lisp-cp/lisp_types.h>
23 #include <vnet/lisp-gpe/lisp_gpe_sub_interface.h>
24 #include <vnet/lisp-gpe/lisp_gpe_adjacency.h>
25 #include <vnet/lisp-gpe/lisp_gpe_tunnel.h>
26 #include <vnet/fib/fib_entry.h>
27 #include <vnet/adj/adj_midchain.h>
30 * Memory pool of all adjacencies
32 static lisp_gpe_adjacency_t *lisp_adj_pool;
35 * Hash table of all adjacencies. key:{nh, itf}
36 * We never have an all zeros address since the interfaces are multi-access,
37 * therefore there is no ambiguity between a v4 and v6 next-hop, so we don't
38 * need to add the protocol to the key.
44 #define LISP_ADJ_SET_KEY(_key, _itf, _nh) \
46 _key.key[0] = (_nh)->ip.v6.as_u64[0]; \
47 _key.key[1] = (_nh)->ip.v6.as_u64[1]; \
48 _key.key[2] = (_itf); \
51 static index_t lisp_adj_find (const ip_address_t * addr, u32 sw_if_index)
53 BVT (clib_bihash_kv) kv;
55 LISP_ADJ_SET_KEY (kv, sw_if_index, addr);
57 if (BV (clib_bihash_search) (&lisp_adj_db, &kv, &kv) < 0)
59 return (INDEX_INVALID);
68 lisp_adj_insert (const ip_address_t * addr, u32 sw_if_index, index_t ai)
70 BVT (clib_bihash_kv) kv;
72 LISP_ADJ_SET_KEY (kv, sw_if_index, addr);
75 BV (clib_bihash_add_del) (&lisp_adj_db, &kv, 1);
79 lisp_adj_remove (const ip_address_t * addr, u32 sw_if_index)
81 BVT (clib_bihash_kv) kv;
83 LISP_ADJ_SET_KEY (kv, sw_if_index, addr);
85 BV (clib_bihash_add_del) (&lisp_adj_db, &kv, 0);
88 static lisp_gpe_adjacency_t *
89 lisp_gpe_adjacency_get_i (index_t lai)
91 return (pool_elt_at_index (lisp_adj_pool, lai));
94 fib_forward_chain_type_t
95 lisp_gpe_adj_get_fib_chain_type (const lisp_gpe_adjacency_t * ladj)
97 switch (ip_addr_version (&ladj->remote_rloc))
100 return (FIB_FORW_CHAIN_TYPE_UNICAST_IP4);
102 return (FIB_FORW_CHAIN_TYPE_UNICAST_IP6);
107 return (FIB_FORW_CHAIN_TYPE_UNICAST_IP4);
111 ip46_address_to_ip_address (const ip46_address_t * a, ip_address_t * b)
113 if (ip46_address_is_ip4 (a))
115 memset (b, 0, sizeof (*b));
116 ip_address_set (b, &a->ip4, IP4);
120 ip_address_set (b, &a->ip6, IP6);
125 * @brief Stack the tunnel's midchain on the IP forwarding chain of the via
128 lisp_gpe_adj_stack_one (lisp_gpe_adjacency_t * ladj, adj_index_t ai)
130 const lisp_gpe_tunnel_t *lgt;
131 dpo_id_t tmp = DPO_INVALID;
133 lgt = lisp_gpe_tunnel_get (ladj->tunnel_index);
134 fib_entry_contribute_forwarding (lgt->fib_entry_index,
135 lisp_gpe_adj_get_fib_chain_type (ladj),
138 if (DPO_LOAD_BALANCE == tmp.dpoi_type)
141 * post LISP rewrite we will load-balance. However, the LISP encap
142 * is always the same for this adjacency/tunnel and hence the IP/UDP src,dst
143 * hash is always the same result too. So we do that hash now and
144 * stack on the choice.
145 * If the choice is an incomplete adj then we will need a poke when
146 * it becomes complete. This happens since the adj update walk propagates
147 * as far a recursive paths.
149 const dpo_id_t *choice;
153 lb = load_balance_get (tmp.dpoi_index);
155 if (IP4 == ip_addr_version (&ladj->remote_rloc))
157 hash = ip4_compute_flow_hash ((ip4_header_t *) adj_get_rewrite (ai),
162 hash = ip6_compute_flow_hash ((ip6_header_t *) adj_get_rewrite (ai),
167 load_balance_get_bucket_i (lb, hash & lb->lb_n_buckets_minus_1);
168 dpo_copy (&tmp, choice);
171 adj_nbr_midchain_stack (ai, &tmp);
176 * @brief Call back when restacking all adjacencies on a GRE interface
179 lisp_gpe_adj_walk_cb (adj_index_t ai, void *ctx)
181 lisp_gpe_adjacency_t *ladj = ctx;
183 lisp_gpe_adj_stack_one (ladj, ai);
185 return (ADJ_WALK_RC_CONTINUE);
189 lisp_gpe_adj_stack (lisp_gpe_adjacency_t * ladj)
191 fib_protocol_t nh_proto;
194 ip_address_to_46 (&ladj->remote_rloc, &nh, &nh_proto);
197 * walk all the adjacencies on th lisp interface and restack them
199 adj_nbr_walk_nh (ladj->sw_if_index,
200 nh_proto, &nh, lisp_gpe_adj_walk_cb, ladj);
203 static lisp_gpe_next_protocol_e
204 lisp_gpe_adj_proto_from_vnet_link_type (vnet_link_t linkt)
209 return (LISP_GPE_NEXT_PROTO_IP4);
211 return (LISP_GPE_NEXT_PROTO_IP6);
212 case VNET_LINK_ETHERNET:
213 return (LISP_GPE_NEXT_PROTO_ETHERNET);
217 return (LISP_GPE_NEXT_PROTO_IP4);
220 #define is_v4_packet(_h) ((*(u8*) _h) & 0xF0) == 0x40
223 lisp_gpe_fixup (vlib_main_t * vm, ip_adjacency_t * adj, vlib_buffer_t * b)
225 /* Fixup the checksum and len fields in the LISP tunnel encap
226 * that was applied at the midchain node */
227 ip_udp_fixup_one (vm, b, is_v4_packet (vlib_buffer_get_current (b)));
231 * @brief The LISP-GPE interface registered function to update, i.e.
232 * provide an rewrite string for, an adjacency.
235 lisp_gpe_update_adjacency (vnet_main_t * vnm, u32 sw_if_index, adj_index_t ai)
237 const lisp_gpe_tunnel_t *lgt;
238 lisp_gpe_adjacency_t *ladj;
245 ip46_address_to_ip_address (&adj->sub_type.nbr.next_hop, &rloc);
248 * find an existing or create a new adj
250 lai = lisp_adj_find (&rloc, sw_if_index);
252 ASSERT (INDEX_INVALID != lai);
254 ladj = pool_elt_at_index (lisp_adj_pool, lai);
255 lgt = lisp_gpe_tunnel_get (ladj->tunnel_index);
256 linkt = adj_get_link_type (ai);
258 adj_nbr_midchain_update_rewrite
260 (VNET_LINK_ETHERNET == linkt ?
261 ADJ_MIDCHAIN_FLAG_NO_COUNT :
262 ADJ_MIDCHAIN_FLAG_NONE),
263 lisp_gpe_tunnel_build_rewrite
264 (lgt, ladj, lisp_gpe_adj_proto_from_vnet_link_type (linkt)));
266 lisp_gpe_adj_stack_one (ladj, ai);
270 lisp_gpe_build_rewrite (vnet_main_t * vnm,
272 vnet_link_t link_type, const void *dst_address)
279 lisp_gpe_adjacency_find_or_create_and_lock (const locator_pair_t * pair,
280 u32 overlay_table_id, u32 vni)
282 const lisp_gpe_sub_interface_t *l3s;
283 const lisp_gpe_tunnel_t *lgt;
284 lisp_gpe_adjacency_t *ladj;
288 * first find the L3 sub-interface that corresponds to the loacl-rloc and vni
290 l3si = lisp_gpe_sub_interface_find_or_create_and_lock (&pair->lcl_loc,
293 l3s = lisp_gpe_sub_interface_get (l3si);
296 * find an existing or create a new adj
298 lai = lisp_adj_find (&pair->rmt_loc, l3s->sw_if_index);
300 if (INDEX_INVALID == lai)
303 pool_get (lisp_adj_pool, ladj);
304 memset (ladj, 0, sizeof (*ladj));
305 lai = (ladj - lisp_adj_pool);
307 ip_address_copy (&ladj->remote_rloc, &pair->rmt_loc);
309 /* transfer the lock to the adj */
310 ladj->lisp_l3_sub_index = l3si;
311 ladj->sw_if_index = l3s->sw_if_index;
313 /* if vni is non-default */
315 ladj->flags = LISP_GPE_FLAGS_I;
317 /* work in lisp-gpe not legacy mode */
318 ladj->flags |= LISP_GPE_FLAGS_P;
321 * find the tunnel that will provide the underlying transport
322 * and hence the rewrite.
323 * The RLOC FIB index is default table - always.
325 ladj->tunnel_index = lisp_gpe_tunnel_find_or_create_and_lock (pair, 0);
327 lgt = lisp_gpe_tunnel_get (ladj->tunnel_index);
330 * become of child of the RLOC FIB entry so we are updated when
331 * its reachability changes, allowing us to re-stack the midcahins
333 ladj->fib_entry_child_index = fib_entry_child_add (lgt->fib_entry_index,
334 FIB_NODE_TYPE_LISP_ADJ,
337 lisp_adj_insert (&ladj->remote_rloc, ladj->sw_if_index, lai);
341 /* unlock the interface from the find. */
342 lisp_gpe_sub_interface_unlock (l3si);
343 ladj = lisp_gpe_adjacency_get_i (lai);
352 * @brief Get a pointer to a tunnel from a pointer to a FIB node
354 static lisp_gpe_adjacency_t *
355 lisp_gpe_adjacency_from_fib_node (const fib_node_t * node)
357 return ((lisp_gpe_adjacency_t *)
359 STRUCT_OFFSET_OF (lisp_gpe_adjacency_t, fib_node)));
363 lisp_gpe_adjacency_last_lock_gone (lisp_gpe_adjacency_t * ladj)
365 const lisp_gpe_tunnel_t *lgt;
368 * no children so we are not counting locks. no-op.
369 * at least not counting
371 lisp_adj_remove (&ladj->remote_rloc, ladj->sw_if_index);
374 * unlock the resources this adj holds
376 lgt = lisp_gpe_tunnel_get (ladj->tunnel_index);
378 fib_entry_child_remove (lgt->fib_entry_index, ladj->fib_entry_child_index);
380 lisp_gpe_tunnel_unlock (ladj->tunnel_index);
381 lisp_gpe_sub_interface_unlock (ladj->lisp_l3_sub_index);
383 pool_put (lisp_adj_pool, ladj);
387 lisp_gpe_adjacency_unlock (index_t lai)
389 lisp_gpe_adjacency_t *ladj;
391 ladj = lisp_gpe_adjacency_get_i (lai);
395 if (0 == ladj->locks)
397 lisp_gpe_adjacency_last_lock_gone (ladj);
401 const lisp_gpe_adjacency_t *
402 lisp_gpe_adjacency_get (index_t lai)
404 return (lisp_gpe_adjacency_get_i (lai));
409 * @brief LISP GPE tunnel back walk
411 * The FIB entry through which this tunnel resolves has been updated.
412 * re-stack the midchain on the new forwarding.
414 static fib_node_back_walk_rc_t
415 lisp_gpe_adjacency_back_walk (fib_node_t * node,
416 fib_node_back_walk_ctx_t * ctx)
418 lisp_gpe_adj_stack (lisp_gpe_adjacency_from_fib_node (node));
420 return (FIB_NODE_BACK_WALK_CONTINUE);
424 lisp_gpe_adjacency_get_fib_node (fib_node_index_t index)
426 lisp_gpe_adjacency_t *ladj;
428 ladj = pool_elt_at_index (lisp_adj_pool, index);
429 return (&ladj->fib_node);
433 lisp_gpe_adjacency_last_fib_lock_gone (fib_node_t * node)
435 lisp_gpe_adjacency_last_lock_gone (lisp_gpe_adjacency_from_fib_node (node));
438 const static fib_node_vft_t lisp_gpe_tuennel_vft = {
439 .fnv_get = lisp_gpe_adjacency_get_fib_node,
440 .fnv_back_walk = lisp_gpe_adjacency_back_walk,
441 .fnv_last_lock = lisp_gpe_adjacency_last_fib_lock_gone,
445 format_lisp_gpe_adjacency (u8 * s, va_list * args)
447 lisp_gpe_adjacency_t *ladj = va_arg (*args, lisp_gpe_adjacency_t *);
448 lisp_gpe_adjacency_format_flags_t flags =
449 va_arg (*args, lisp_gpe_adjacency_format_flags_t);
451 if (flags & LISP_GPE_ADJ_FORMAT_FLAG_DETAIL)
454 format (s, "index %d locks:%d\n", ladj - lisp_adj_pool, ladj->locks);
457 s = format (s, " vni: %d,", ladj->vni);
458 s = format (s, " remote-RLOC: %U,", format_ip_address, &ladj->remote_rloc);
460 if (flags & LISP_GPE_ADJ_FORMAT_FLAG_DETAIL)
462 s = format (s, " %U\n",
463 format_lisp_gpe_sub_interface,
464 lisp_gpe_sub_interface_get (ladj->lisp_l3_sub_index));
465 s = format (s, " %U\n",
466 format_lisp_gpe_tunnel,
467 lisp_gpe_tunnel_get (ladj->tunnel_index));
471 s = format (s, " LISP L3 sub-interface index: %d,",
472 ladj->lisp_l3_sub_index);
473 s = format (s, " LISP tunnel index: %d", ladj->tunnel_index);
480 static clib_error_t *
481 lisp_gpe_adjacency_show (vlib_main_t * vm,
482 unformat_input_t * input, vlib_cli_command_t * cmd)
484 lisp_gpe_adjacency_t *ladj;
487 if (pool_elts (lisp_adj_pool) == 0)
488 vlib_cli_output (vm, "No lisp-gpe Adjacencies");
490 if (unformat (input, "%d", &index))
492 ladj = lisp_gpe_adjacency_get_i (index);
493 vlib_cli_output (vm, "%U", format_lisp_gpe_adjacency, ladj,
494 LISP_GPE_ADJ_FORMAT_FLAG_DETAIL);
499 pool_foreach (ladj, lisp_adj_pool,
501 vlib_cli_output (vm, "[%d] %U\n",
502 ladj - lisp_adj_pool,
503 format_lisp_gpe_adjacency, ladj,
504 LISP_GPE_ADJ_FORMAT_FLAG_NONE);
513 VLIB_CLI_COMMAND (show_lisp_gpe_tunnel_command, static) =
515 .path = "show lisp gpe adjacency",
516 .function = lisp_gpe_adjacency_show,
520 #define LISP_ADJ_NBR_DEFAULT_HASH_NUM_BUCKETS (256)
521 #define LISP_ADJ_NBR_DEFAULT_HASH_MEMORY_SIZE (1<<20)
523 static clib_error_t *
524 lisp_gpe_adj_module_init (vlib_main_t * vm)
526 BV (clib_bihash_init) (&lisp_adj_db,
527 "Adjacency Neighbour table",
528 LISP_ADJ_NBR_DEFAULT_HASH_NUM_BUCKETS,
529 LISP_ADJ_NBR_DEFAULT_HASH_MEMORY_SIZE);
531 fib_node_register_type (FIB_NODE_TYPE_LISP_ADJ, &lisp_gpe_tuennel_vft);
535 VLIB_INIT_FUNCTION (lisp_gpe_adj_module_init)
537 * fd.io coding-style-patch-verification: ON
540 * eval: (c-set-style "gnu")