2 * ip_neighboor.h: ip neighbor generic services
4 * Copyright (c) 2018 Cisco and/or its affiliates.
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at:
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
18 #ifndef __INCLUDE_IP_NEIGHBOR_H__
19 #define __INCLUDE_IP_NEIGHBOR_H__
21 #include <vnet/ip-neighbor/ip_neighbor_types.h>
23 #include <vnet/adj/adj.h>
25 void ip_neighbor_scan_enable_disable (ip_neighbor_scan_arg_t * arg);
29 * APIs external modules can invoke on the neighbor subsystem
32 extern ip_neighbor_t *ip_neighbor_get (index_t ipni);
33 extern int ip_neighbor_add (const ip46_address_t * ip,
35 const mac_address_t * mac,
37 ip_neighbor_flags_t flags, u32 * stats_index);
38 extern int ip_neighbor_del (const ip46_address_t * ip,
39 ip46_type_t type, u32 sw_if_index);
41 extern int ip_neighbor_config (ip46_type_t type, u32 limit, u32 age,
44 extern void ip_neighbor_del_all (ip46_type_t type, u32 sw_if_index);
46 typedef walk_rc_t (*ip_neighbor_walk_cb_t) (index_t ipni, void *ctx);
47 extern void ip_neighbor_walk (ip46_type_t type,
49 ip_neighbor_walk_cb_t fn, void *ctx);
51 extern const ip46_address_t *ip_neighbor_get_ip (const ip_neighbor_t * ipn);
52 extern const mac_address_t *ip_neighbor_get_mac (const ip_neighbor_t * ipn);
53 extern const u32 ip_neighbor_get_sw_if_index (const ip_neighbor_t * ipn);
55 extern void ip_neighbor_learn (const ip_neighbor_learn_t * l);
57 extern void ip_neighbor_update (vnet_main_t * vnm, adj_index_t ai);
59 extern void ip_neighbor_advertise (vlib_main_t * vm,
61 const ip46_address_t * addr,
63 extern void ip_neighbor_probe (const ip_adjacency_t * adj);
64 extern void ip_neighbor_probe_dst (const ip_adjacency_t * adj,
65 const ip46_address_t * ip);
67 extern void ip_neighbor_mark (ip46_type_t type);
68 extern void ip_neighbor_sweep (ip46_type_t type);
71 * From the watcher to the API to publish a new neighbor
73 extern void ip_neighbor_handle_event (const ip_neighbor_event_t * ipne);
76 * The set of function that vnet requires from the IP neighbour module.
77 * Note that an implementation of these functions will not exist
78 * if the ip-neighbour plugin is not loaded. so check the error codes!
80 extern int ip4_neighbor_proxy_add (u32 fib_index,
81 const ip4_address_t * start,
82 const ip4_address_t * end);
83 extern int ip4_neighbor_proxy_delete (u32 fib_index,
84 const ip4_address_t * start,
85 const ip4_address_t * end);
86 extern int ip4_neighbor_proxy_enable (u32 sw_if_index);
87 extern int ip4_neighbor_proxy_disable (u32 sw_if_index);
88 extern int ip6_neighbor_proxy_add (u32 sw_if_index,
89 const ip6_address_t * addr);
90 extern int ip6_neighbor_proxy_del (u32 sw_if_index,
91 const ip6_address_t * addr);
94 * neighbor protocol implementation registration functions
95 * this are provided by ARP and IP-ND
97 typedef int (*ip4_neighbor_proxy_addr_t) (u32 fib_index,
98 const ip4_address_t * start,
99 const ip4_address_t * end);
100 typedef int (*ip4_neighbor_proxy_cfg_t) (u32 sw_if_index);
101 typedef int (*ip6_neighbor_proxy_cfg_t) (u32 sw_if_index,
102 const ip6_address_t * addr);
105 * Virtual function Table for neighbor protocol implementations to register
107 typedef struct ip_neighbor_vft_t_
109 ip4_neighbor_proxy_cfg_t inv_proxy4_enable;
110 ip4_neighbor_proxy_cfg_t inv_proxy4_disable;
111 ip4_neighbor_proxy_addr_t inv_proxy4_add;
112 ip4_neighbor_proxy_addr_t inv_proxy4_del;
113 ip6_neighbor_proxy_cfg_t inv_proxy6_add;
114 ip6_neighbor_proxy_cfg_t inv_proxy6_del;
117 extern void ip_neighbor_register (ip46_type_t type,
118 const ip_neighbor_vft_t * vft);
121 #endif /* __INCLUDE_IP_NEIGHBOR_H__ */
124 * fd.io coding-style-patch-verification: ON
127 * eval: (c-set-style "gnu")