Periodic scan and probe of IP neighbors to maintain neighbor pools
[vpp.git] / src / vnet / ip / ip_neighbor.h
1 /*
2  * ip_neighboor.h: ip neighbor generic services
3  *
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:
8  *
9  *     http://www.apache.org/licenses/LICENSE-2.0
10  *
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.
16  */
17
18 #ifndef included_ip_neighbor_h
19 #define included_ip_neighbor_h
20
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)
25
26 typedef struct
27 {
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;
35
36 void ip_neighbor_scan_enable_disable (ip_neighbor_scan_arg_t * arg);
37
38 #endif /* included_ip_neighbor_h */
39
40 /*
41  * fd.io coding-style-patch-verification: ON
42  *
43  * Local Variables:
44  * eval: (c-set-style "gnu")
45  * End:
46  */