/* * teib.h: next-hop resolution * * Copyright (c) 2016 Cisco and/or its affiliates. * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at: * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ #ifndef __TEIB_H__ #define __TEIB_H__ #include <vnet/ip/ip.h> /** * Tunnel Endpoint Information Base. * * A TEIB entry represents the mapping between a peer on an interface in the overlay * and a next-hop address in the underlay. * i.e. there's a multipoint tunnel providing the overlay (henace a peer on * that tunnel) which is reachable via 'tunnel destination' address in the * underlay. * * Such overlay to underlay mappings might be providied by a protocol like NHRP */ typedef struct teib_entry_t_ teib_entry_t; /** accessors for the opaque struct */ extern u32 teib_entry_get_sw_if_index (const teib_entry_t * ne); extern u32 teib_entry_get_fib_index (const teib_entry_t * ne); extern const ip46_address_t *teib_entry_get_peer (const teib_entry_t * ne); extern const fib_prefix_t *teib_entry_get_nh (const teib_entry_t * ne); extern u8 *format_teib_entry (u8 * s, va_list * args); /** * Create a new TEIB entry */ extern int teib_entry_add (u32 sw_if_index, const ip46_address_t * peer, u32 nh_table_id, const ip46_address_t * nh); extern int teib_entry_del (u32 sw_if_index, const ip46_address_t * peer); extern teib_entry_t *teib_entry_find (u32 sw_if_index, const ip46_address_t * peer); extern teib_entry_t *teib_entry_get (index_t nei); extern void teib_entry_adj_stack (const teib_entry_t * ne, adj_index_t ai); typedef walk_rc_t (*teib_walk_cb_t) (index_t nei, void *ctx); extern void teib_walk (teib_walk_cb_t fn, void *ctx); extern void teib_walk_itf (u32 sw_if_index, teib_walk_cb_t fn, void *ctx); /** * Notifications for the creation and deletion of TEIB entries */ typedef void (*teib_entry_added_t) (const teib_entry_t * ne); typedef void (*teib_entry_deleted_t) (const teib_entry_t * ne); typedef struct teib_vft_t_ { teib_entry_added_t nv_added; teib_entry_deleted_t nv_deleted; } teib_vft_t; extern void teib_register (const teib_vft_t * vft); #endif /* * fd.io coding-style-patch-verification: ON * * Local Variables: * eval: (c-set-style "gnu") * End: */