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 included_ip_neighbor_h
19 #define included_ip_neighbor_h
21 #define IP_SCAN_DISABLED 0
22 #define IP_SCAN_V4_NEIGHBORS (1 << 0)
23 #define IP_SCAN_V6_NEIGHBORS (1 << 1)
24 #define IP_SCAN_V46_NEIGHBORS (IP_SCAN_V4_NEIGHBORS | IP_SCAN_V6_NEIGHBORS)
28 u8 mode; /* 0: disable, 1: ip4, 2: ip6, 3: both */
29 u8 scan_interval; /* neighbor scan interval in minutes */
30 u8 max_proc_time; /* max processing time per run, in usecs */
31 u8 max_update; /* max probe/delete operations per run */
32 u8 scan_int_delay; /* delay in msecs, to resume scan on max */
33 u8 stale_threshold; /* Threashold in minutes to delete nei entry */
34 } ip_neighbor_scan_arg_t;
36 void ip_neighbor_scan_enable_disable (ip_neighbor_scan_arg_t * arg);
38 typedef enum ip_neighbor_flags_t_
40 IP_NEIGHBOR_FLAG_NONE = 0,
41 IP_NEIGHBOR_FLAG_STATIC = (1 << 0),
42 IP_NEIGHBOR_FLAG_DYNAMIC = (1 << 1),
43 IP_NEIGHBOR_FLAG_NO_FIB_ENTRY = (1 << 2),
44 } __attribute__ ((packed)) ip_neighbor_flags_t;
46 extern u8 *format_ip_neighbor_flags (u8 * s, va_list * args);
48 extern int ip_neighbor_add (const ip46_address_t * ip,
50 const mac_address_t * mac,
52 ip_neighbor_flags_t flags, u32 * stats_index);
54 extern int ip_neighbor_del (const ip46_address_t * ip,
55 ip46_type_t type, u32 sw_if_index);
57 #endif /* included_ip_neighbor_h */
60 * fd.io coding-style-patch-verification: ON
63 * eval: (c-set-style "gnu")