vnet/vnet/adj/adj_nbr.h

   1 /*
   2  * Copyright (c) 2016 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  * @brief
  17  * Neighbour Adjacency sub-type. These adjs represent an L3 peer on a
  18  * connected link.
  19  */
  20
  21 #ifndef __ADJ_NBR_H__
  22 #define __ADJ_NBR_H__
  23
  24 #include <vnet/vnet.h>
  25 #include <vnet/adj/adj_types.h>
  26 #include <vnet/fib/fib_node.h>
  27 #include <vnet/dpo/dpo.h>
  28
  29 /**
  30  * @brief
  31  *  Add (and lock) a new or lock an existing neighbour adjacency
  32  *
  33  * @param nh_proto
  34  *  The protocol for the next-hop address (v4 or v6)
  35  *
  36  * @param link_type
  37  *  A description of the protocol of the packets that will forward
  38  *  through this adj. On an ethernet interface this is the MAC header's
  39  *  ether-type
  40  *
  41  * @param nh_addr
  42  *  The address of the next-hop/peer to send the packet to
  43  *
  44  * @param sw_if_index
  45  *  The interface on which the peer resides
  46  */
  47 extern adj_index_t adj_nbr_add_or_lock(fib_protocol_t nh_proto,
  48                                        fib_link_t link_type,
  49                                        const ip46_address_t *nh_addr,
  50                                        u32 sw_if_index);
  51
  52 /**
  53  * @brief
  54  *  Add (and lock) a new or lock an existing neighbour adjacency
  55  *
  56  * @param nh_proto
  57  *  The protocol for the next-hop address (v4 or v6)
  58  *
  59  * @param link_type
  60  *  A description of the protocol of the packets that will forward
  61  *  through this adj. On an ethernet interface this is the MAC header's
  62  *  ether-type
  63  *
  64  * @param nh_addr
  65  *  The address of the next-hop/peer to send the packet to
  66  *
  67  * @param sw_if_index
  68  *  The interface on which the peer resides
  69  *
  70  * @param rewrite
  71  *  The rewrite to prepend to packets
  72  */
  73 extern adj_index_t adj_nbr_add_or_lock_w_rewrite(fib_protocol_t nh_proto,
  74                                                  fib_link_t link_type,
  75                                                  const ip46_address_t *nh_addr,
  76                                                  u32 sw_if_index,
  77                                                  u8 *rewrite);
  78
  79 /**
  80  * @brief
  81  *  Update the rewrite string for an existing adjacecny.
  82  *
  83  * @param
  84  *  The index of the adj to update
  85  *
  86  * @param
  87  *  The new rewrite
  88  */
  89 extern void adj_nbr_update_rewrite(adj_index_t adj_index,
  90                                    u8 *rewrite);
  91
  92 /**
  93  * @brief
  94  * Format aa incomplete neigbour (ARP) adjacency
  95  */
  96 extern u8* format_adj_nbr_incomplete(u8* s, va_list *ap);
  97
  98 /**
  99  * @brief
 100  * Format a neigbour (REWRITE) adjacency
 101  */
 102 extern u8* format_adj_nbr(u8* s, va_list *ap);
 103
 104 /**
 105  * @brief
 106  *  Module initialisation
 107  */
 108 extern void adj_nbr_module_init(void);
 109
 110 /**
 111  * @brief
 112  *  Return the size of the adjacency database. for testing purposes
 113  */
 114 extern u32 adj_nbr_db_size(void);
 115
 116 #endif