ip: Protocol Independent IP Neighbors
[vpp.git] / src / vnet / ip / ip6_link.h
1 /*
2  * Copyright (c) 2019 Cisco and/or its affiliates.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at:
6  *
7  *     http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15
16 #include <vnet/ip/ip.h>
17
18 /**
19  * IPv6 Configuration on an interface
20  */
21
22 extern int ip6_link_enable (u32 sw_if_index);
23 extern bool ip6_link_is_enabled (u32 sw_if_index);
24 extern int ip6_link_disable (u32 sw_if_index);
25
26 extern const ip6_address_t *ip6_get_link_local_address (u32 sw_if_index);
27
28 extern int ip6_set_link_local_address (u32 sw_if_index,
29                                        const ip6_address_t * address);
30 extern adj_index_t ip6_link_get_mcast_adj (u32 sw_if_index);
31
32 extern int
33 ip6_src_address_for_packet (u32 sw_if_index,
34                             const ip6_address_t * dst, ip6_address_t * src);
35
36 /**
37  * Delegates for the interfaces
38  *
39  * delegates are a means for a external component to 'extend' the config
40  * object by adding their own objects (aka delegates).
41  */
42
43 /**
44  * Callback functions for handling actions on the link
45  */
46 typedef void (*ip6_link_enable_fn_t) (u32 sw_if_index);
47 typedef void (*ip6_link_disable_fn_t) (index_t ildi);
48 typedef void (*ip6_link_ll_change_fn_t) (u32 ildi, const ip6_address_t * a);
49 typedef void (*ip6_link_address_change_fn_t) (u32 ildi,
50                                               const ip6_address_t * a,
51                                               u8 address_oength);
52
53 typedef struct ip6_link_delegate_vft_t_
54 {
55   ip6_link_enable_fn_t ildv_enable;
56   ip6_link_disable_fn_t ildv_disable;
57   ip6_link_ll_change_fn_t ildv_ll_change;
58   ip6_link_address_change_fn_t ildv_addr_add;
59   ip6_link_address_change_fn_t ildv_addr_del;
60   format_function_t *ildv_format;
61 } ip6_link_delegate_vft_t;
62
63 typedef u32 ip6_link_delegate_id_t;
64
65
66 extern ip6_link_delegate_id_t ip6_link_delegate_register (const
67                                                           ip6_link_delegate_vft_t
68                                                           * vft);
69 extern index_t ip6_link_delegate_get (u32 sw_if_index,
70                                       ip6_link_delegate_id_t id);
71 extern bool ip6_link_delegate_update (u32 sw_if_index,
72                                       ip6_link_delegate_id_t id, index_t ii);
73 extern void ip6_link_delegate_remove (u32 sw_if_index,
74                                       ip6_link_delegate_id_t id, index_t ii);
75
76 /*
77  * fd.io coding-style-patch-verification: ON
78  *
79  * Local Variables:
80  * eval: (c-set-style "gnu")
81  * End:
82  */