Periodic scan and probe of IP neighbors to maintain neighbor pools
[vpp.git] / src / vnet / ip / ip6_neighbor.h
1 /*
2  *
3  * ip6_neighboor.h: ip6 neighbor structures
4  *
5  * Copyright (c) 2016 Cisco and/or its affiliates.
6  * Licensed under the Apache License, Version 2.0 (the "License");
7  * you may not use this file except in compliance with the License.
8  * You may obtain a copy of the License at:
9  *
10  *     http://www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing, software
13  * distributed under the License is distributed on an "AS IS" BASIS,
14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15  * See the License for the specific language governing permissions and
16  * limitations under the License.
17  */
18
19 #ifndef included_ip6_neighbor_h
20 #define included_ip6_neighbor_h
21
22 #include <vnet/fib/fib_types.h>
23
24 typedef struct
25 {
26   ip6_address_t ip6_address;
27   u32 sw_if_index;
28   u32 pad;
29 } ip6_neighbor_key_t;
30
31 typedef enum ip6_neighbor_flags_t_
32 {
33   IP6_NEIGHBOR_FLAG_STATIC = (1 << 0),
34   IP6_NEIGHBOR_FLAG_DYNAMIC = (1 << 1),
35   IP6_NEIGHBOR_FLAG_NO_FIB_ENTRY = (1 << 2),
36 } __attribute__ ((packed)) ip6_neighbor_flags_t;
37
38 typedef struct
39 {
40   ip6_neighbor_key_t key;
41   u8 link_layer_address[8];
42   ip6_neighbor_flags_t flags;
43   f64 time_last_updated;
44   fib_node_index_t fib_entry_index;
45 } ip6_neighbor_t;
46
47 extern ip6_neighbor_t *ip6_neighbors_pool (void);
48
49 extern ip6_neighbor_t *ip6_neighbors_entries (u32 sw_if_index);
50
51 extern int ip6_neighbor_ra_config (vlib_main_t * vm, u32 sw_if_index,
52                                    u8 suppress, u8 managed, u8 other,
53                                    u8 ll_option, u8 send_unicast, u8 cease,
54                                    u8 use_lifetime, u32 lifetime,
55                                    u32 initial_count, u32 initial_interval,
56                                    u32 max_interval, u32 min_interval,
57                                    u8 is_no);
58
59 extern int ip6_neighbor_ra_prefix (vlib_main_t * vm, u32 sw_if_index,
60                                    ip6_address_t * prefix_addr, u8 prefix_len,
61                                    u8 use_default, u32 val_lifetime,
62                                    u32 pref_lifetime, u8 no_advertise,
63                                    u8 off_link, u8 no_autoconfig,
64                                    u8 no_onlink, u8 is_no);
65
66 extern clib_error_t *ip6_set_neighbor_limit (u32 neighbor_limit);
67
68 extern void vnet_register_ip6_neighbor_resolution_event (vnet_main_t * vnm,
69                                                          void *address_arg,
70                                                          uword node_index,
71                                                          uword type_opaque,
72                                                          uword data);
73
74 extern int vnet_set_ip6_ethernet_neighbor (vlib_main_t * vm,
75                                            u32 sw_if_index,
76                                            ip6_address_t * a,
77                                            u8 * link_layer_address,
78                                            uword n_bytes_link_layer_address,
79                                            int is_static,
80                                            int is_no_fib_entry);
81
82 extern int vnet_unset_ip6_ethernet_neighbor (vlib_main_t * vm,
83                                              u32 sw_if_index,
84                                              ip6_address_t * a,
85                                              u8 * link_layer_address,
86                                              uword
87                                              n_bytes_link_layer_address);
88
89 extern int ip6_neighbor_proxy_add_del (u32 sw_if_index,
90                                        ip6_address_t * addr, u8 is_add);
91
92 u32 ip6_neighbor_sw_interface_add_del (vnet_main_t * vnm, u32 sw_if_index,
93                                        u32 is_add);
94 typedef struct
95 {
96   u32 sw_if_index;
97   ip6_address_t ip6;
98   u8 mac[6];
99 } wc_nd_report_t;
100
101 void wc_nd_set_publisher_node (uword node_index, uword event_type);
102
103 typedef struct
104 {
105   u32 irt;
106   u32 mrt;
107   u32 mrc;
108   u32 mrd;
109 } icmp6_send_router_solicitation_params_t;
110
111 void icmp6_send_router_solicitation (vlib_main_t * vm, u32 sw_if_index,
112                                      u8 stop,
113                                      icmp6_send_router_solicitation_params_t *
114                                      params);
115
116 typedef struct
117 {
118   ip6_address_t dst_address;
119   u8 dst_address_length;
120   u8 flags;
121   u32 valid_time;
122   u32 preferred_time;
123 } ra_report_prefix_info_t;
124
125 typedef struct
126 {
127   u32 sw_if_index;
128   u8 router_address[16];
129   u8 current_hop_limit;
130   u8 flags;
131   u16 router_lifetime_in_sec;
132   u32 neighbor_reachable_time_in_msec;
133   u32 time_in_msec_between_retransmitted_neighbor_solicitations;
134   u8 slla[6];
135   u32 mtu;
136   ra_report_prefix_info_t *prefixes;
137 } ra_report_t;
138
139 void ra_set_publisher_node (uword node_index, uword event_type);
140
141 #endif /* included_ip6_neighbor_h */
142
143 /*
144  * fd.io coding-style-patch-verification: ON
145  *
146  * Local Variables:
147  * eval: (c-set-style "gnu")
148  * End:
149  */