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                             const ip6_address_t * link_local_addr);
  24 extern bool ip6_link_is_enabled (u32 sw_if_index);
  25 extern int ip6_link_disable (u32 sw_if_index);
  26
  27 extern const ip6_address_t *ip6_get_link_local_address (u32 sw_if_index);
  28
  29 extern int ip6_link_set_local_address (u32 sw_if_index,
  30                                        const ip6_address_t * address);
  31 extern adj_index_t ip6_link_get_mcast_adj (u32 sw_if_index);
  32
  33 /**
  34  * Delegates for the interfaces
  35  *
  36  * delegates are a means for a external component to 'extend' the config
  37  * object by adding their own objects (aka delegates).
  38  */
  39
  40 /**
  41  * Callback functions for handling actions on the link
  42  */
  43 typedef void (*ip6_link_enable_fn_t) (u32 sw_if_index);
  44 typedef void (*ip6_link_disable_fn_t) (index_t ildi);
  45 typedef void (*ip6_link_ll_change_fn_t) (u32 ildi, const ip6_address_t * a);
  46 typedef void (*ip6_link_address_change_fn_t) (u32 ildi,
  47                                               const ip6_address_t * a,
  48                                               u8 address_oength);
  49
  50 typedef struct ip6_link_delegate_vft_t_
  51 {
  52   ip6_link_enable_fn_t ildv_enable;
  53   ip6_link_disable_fn_t ildv_disable;
  54   ip6_link_ll_change_fn_t ildv_ll_change;
  55   ip6_link_address_change_fn_t ildv_addr_add;
  56   ip6_link_address_change_fn_t ildv_addr_del;
  57   format_function_t *ildv_format;
  58 } ip6_link_delegate_vft_t;
  59
  60 typedef u32 ip6_link_delegate_id_t;
  61
  62
  63 extern ip6_link_delegate_id_t ip6_link_delegate_register (const
  64                                                           ip6_link_delegate_vft_t
  65                                                           * vft);
  66 extern index_t ip6_link_delegate_get (u32 sw_if_index,
  67                                       ip6_link_delegate_id_t id);
  68 extern bool ip6_link_delegate_update (u32 sw_if_index,
  69                                       ip6_link_delegate_id_t id, index_t ii);
  70 extern void ip6_link_delegate_remove (u32 sw_if_index,
  71                                       ip6_link_delegate_id_t id, index_t ii);
  72
  73 /*
  74  * fd.io coding-style-patch-verification: ON
  75  *
  76  * Local Variables:
  77  * eval: (c-set-style "gnu")
  78  * End:
  79  */