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 #ifndef LISP_GPE_ADJACENCY_H__
22 #define LISP_GPE_ADJACENCY_H__
24 #include <vnet/fib/fib_node.h>
25 #include <vnet/lisp-gpe/lisp_gpe.h>
28 * @brief A LISP GPE Adjacency.
30 * A adjacency represents peer on an L3 sub-interface to which to send traffic.
31 * adjacencies are thus present in the EID space.
32 * The peer is identified by the key:{remote-rloc, sub-interface}, which is
33 * equivalent to the usal adjacency key {next-hop, interface}. So curiously
34 * the rloc address from the underlay is used as a next hop address in the overlay
36 * 1 - the RLOC is unique in the underlay AND there is only one underlay VRF per
38 * 2 - the RLOC may overlap with an address in the overlay, but we do not create
39 * an adj-fib (i.e. a route in the overlay FIB for the rloc)
43 typedef struct lisp_gpe_adjacency_t_
46 * The LISP adj is a part of the FIB control plane graph.
51 * remote RLOC. The adjacency's next-hop
53 ip_address_t remote_rloc;
56 * The VNI. Used in combination with the local-rloc to get the sub-interface
61 * The number of locks/reference counts on the adjacency.
66 * The index of the LISP L3 subinterface
68 u32 lisp_l3_sub_index;
71 * The SW IF index of the sub-interface this adjacency uses.
72 * Cached for convenience from the LISP L3 sub-interface
77 * The index of the LISP GPE tunnel that provides the transport
83 * This adjacency is a child of the FIB entry to reach the RLOC.
84 * This is so when the reachability of that RLOC changes, we can restack
85 * the FIB adjacnecies.
87 u32 fib_entry_child_index;
90 * LISP header fields in HOST byte order
97 } lisp_gpe_adjacency_t;
99 extern index_t lisp_gpe_adjacency_find_or_create_and_lock (const
105 extern void lisp_gpe_adjacency_unlock (index_t l3si);
107 extern const lisp_gpe_adjacency_t *lisp_gpe_adjacency_get (index_t l3si);
109 extern void lisp_gpe_update_adjacency (vnet_main_t * vnm,
110 u32 sw_if_index, adj_index_t ai);
111 extern u8 *lisp_gpe_build_rewrite (vnet_main_t * vnm,
113 vnet_link_t link_type,
114 const void *dst_address);
118 * @brief Flags for displaying the adjacency
120 typedef enum lisp_gpe_adjacency_format_flags_t_
122 LISP_GPE_ADJ_FORMAT_FLAG_NONE,
123 LISP_GPE_ADJ_FORMAT_FLAG_DETAIL,
124 } lisp_gpe_adjacency_format_flags_t;
126 extern u8 *format_lisp_gpe_adjacency (u8 * s, va_list * args);
131 * fd.io coding-style-patch-verification: ON
134 * eval: (c-set-style "gnu")