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 typedef walk_rc_t (*ip_neighbor_walk_cb_t) (index_t ipni, void *ctx);
45 extern void ip_neighbor_walk (ip46_type_t type,
47 ip_neighbor_walk_cb_t fn, void *ctx);
49 extern const ip46_address_t *ip_neighbor_get_ip (const ip_neighbor_t * ipn);
50 extern const mac_address_t *ip_neighbor_get_mac (const ip_neighbor_t * ipn);
51 extern const u32 ip_neighbor_get_sw_if_index (const ip_neighbor_t * ipn);
53 extern void ip_neighbor_learn (const ip_neighbor_learn_t * l);
55 extern void ip_neighbor_update (vnet_main_t * vnm, adj_index_t ai);
57 extern void ip_neighbor_advertise (vlib_main_t * vm,
59 const ip46_address_t * addr,
61 extern void ip_neighbor_probe (const ip_adjacency_t * adj);
62 extern void ip_neighbor_probe_dst (const ip_adjacency_t * adj,
63 const ip46_address_t * ip);
66 * From the watcher to the API to publish a new neighbor
68 extern void ip_neighbor_handle_event (const ip_neighbor_event_t * ipne);
71 * The set of function that vnet requires from the IP neighbour module.
72 * Note that an implementation of these functions will not exist
73 * if the ip-neighbour plugin is not loaded. so check the error codes!
75 extern int ip4_neighbor_proxy_add (u32 fib_index,
76 const ip4_address_t * start,
77 const ip4_address_t * end);
78 extern int ip4_neighbor_proxy_delete (u32 fib_index,
79 const ip4_address_t * start,
80 const ip4_address_t * end);
81 extern int ip4_neighbor_proxy_enable (u32 sw_if_index);
82 extern int ip4_neighbor_proxy_disable (u32 sw_if_index);
83 extern int ip6_neighbor_proxy_add (u32 sw_if_index,
84 const ip6_address_t * addr);
85 extern int ip6_neighbor_proxy_del (u32 sw_if_index,
86 const ip6_address_t * addr);
89 * neighbor protocol implementation registration functions
90 * this are provided by ARP and IP-ND
92 typedef int (*ip4_neighbor_proxy_addr_t) (u32 fib_index,
93 const ip4_address_t * start,
94 const ip4_address_t * end);
95 typedef int (*ip4_neighbor_proxy_cfg_t) (u32 sw_if_index);
96 typedef int (*ip6_neighbor_proxy_cfg_t) (u32 sw_if_index,
97 const ip6_address_t * addr);
100 * Virtual function Table for neighbor protocol implementations to register
102 typedef struct ip_neighbor_vft_t_
104 ip4_neighbor_proxy_cfg_t inv_proxy4_enable;
105 ip4_neighbor_proxy_cfg_t inv_proxy4_disable;
106 ip4_neighbor_proxy_addr_t inv_proxy4_add;
107 ip4_neighbor_proxy_addr_t inv_proxy4_del;
108 ip6_neighbor_proxy_cfg_t inv_proxy6_add;
109 ip6_neighbor_proxy_cfg_t inv_proxy6_del;
112 extern void ip_neighbor_register (ip46_type_t type,
113 const ip_neighbor_vft_t * vft);
116 #endif /* __INCLUDE_IP_NEIGHBOR_H__ */
119 * fd.io coding-style-patch-verification: ON
122 * eval: (c-set-style "gnu")