FD.io VPP  v17.07.01-10-g3be13f0
Vector Packet Processing
adj_nbr.h
Go to the documentation of this file.
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  */
48  vnet_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  */
74  vnet_link_t link_type,
75  const ip46_address_t *nh_addr,
76  u32 sw_if_index,
77  u8 *rewrite);
78 /**
79  * @brief When adding a rewrite to an adjacency these are flags that
80  * apply to that rewrite
81  */
83 {
85 
86  /**
87  * An indication that the rewrite is incomplete, i.e. that it describes the
88  * ARP/ND rewrite when probing.
89  */
91 
92  /**
93  * An indication that the rewrite is complete, i.e. that it fully describes
94  * the link-layer addressing for the desintation.
95  * The opposite of this is an incomplete rewrite that describes the ARP/ND
96  * rewrite when probing.
97  */
100 
101 /**
102  * @brief
103  * Update the rewrite string for an existing adjacecny.
104  *
105  * @param
106  * The index of the adj to update
107  *
108  * @param
109  * The new rewrite
110  */
111 extern void adj_nbr_update_rewrite(adj_index_t adj_index,
113  u8 *rewrite);
114 
115 /**
116  * @brief
117  * Format aa incomplete neigbour (ARP) adjacency
118  */
119 extern u8* format_adj_nbr_incomplete(u8* s, va_list *ap);
120 
121 /**
122  * @brief
123  * Format a neigbour (REWRITE) adjacency
124  */
125 extern u8* format_adj_nbr(u8* s, va_list *ap);
126 
127 /**
128  * @brief Walk the neighbour Adjacencies on a given interface
129  */
130 extern void adj_nbr_walk (u32 sw_if_index,
131  fib_protocol_t adj_nh_proto,
132  adj_walk_cb_t cb,
133  void *ctx);
134 /**
135  * @brief Walk the neighbour Adjacencies on a given interface with a given next-hop
136  */
137 void
138 adj_nbr_walk_nh (u32 sw_if_index,
139  fib_protocol_t adj_nh_proto,
140  const ip46_address_t *nh,
141  adj_walk_cb_t cb,
142  void *ctx);
143 
144 /**
145  * @brief Walk adjacencies on a link with a given v4 next-hop.
146  * that is visit the adjacencies with different link types.
147  */
148 void
149 adj_nbr_walk_nh4 (u32 sw_if_index,
150  const ip4_address_t *addr,
151  adj_walk_cb_t cb,
152  void *ctx);
153 
154 /**
155  * @brief Walk adjacencies on a link with a given v6 next-hop.
156  * that is visit the adjacencies with different link types.
157  */
158 void
159 adj_nbr_walk_nh6 (u32 sw_if_index,
160  const ip6_address_t *addr,
161  adj_walk_cb_t cb,
162  void *ctx);
163 
164 /**
165  * @brief
166  * Module initialisation
167  */
168 extern void adj_nbr_module_init(void);
169 
170 /**
171  * @brief
172  * Return the size of the adjacency database. for testing purposes
173  */
174 extern u32 adj_nbr_db_size(void);
175 
176 #endif
adj_index_t adj_nbr_add_or_lock_w_rewrite(fib_protocol_t nh_proto, vnet_link_t link_type, const ip46_address_t *nh_addr, u32 sw_if_index, u8 *rewrite)
Add (and lock) a new or lock an existing neighbour adjacency.
Definition: adj_nbr.c:254
An indication that the rewrite is incomplete, i.e.
Definition: adj_nbr.h:90
An indication that the rewrite is complete, i.e.
Definition: adj_nbr.h:98
void adj_nbr_module_init(void)
Module initialisation.
Definition: adj_nbr.c:1116
void adj_nbr_walk_nh6(u32 sw_if_index, const ip6_address_t *addr, adj_walk_cb_t cb, void *ctx)
Walk adjacencies on a link with a given v6 next-hop.
Definition: adj_nbr.c:643
enum fib_protocol_t_ fib_protocol_t
Protocol Type.
void adj_nbr_walk_nh(u32 sw_if_index, fib_protocol_t adj_nh_proto, const ip46_address_t *nh, adj_walk_cb_t cb, void *ctx)
Walk the neighbour Adjacencies on a given interface with a given next-hop.
Definition: adj_nbr.c:672
u8 * format_adj_nbr(u8 *s, va_list *ap)
Format a neigbour (REWRITE) adjacency.
Definition: adj_nbr.c:1008
void adj_nbr_update_rewrite(adj_index_t adj_index, adj_nbr_rewrite_flag_t flags, u8 *rewrite)
Update the rewrite string for an existing adjacecny.
Definition: adj_nbr.c:291
adj_nbr_rewrite_flag_t_
When adding a rewrite to an adjacency these are flags that apply to that rewrite. ...
Definition: adj_nbr.h:82
void adj_nbr_walk(u32 sw_if_index, fib_protocol_t adj_nh_proto, adj_walk_cb_t cb, void *ctx)
Walk the neighbour Adjacencies on a given interface.
Definition: adj_nbr.c:567
void adj_nbr_walk_nh4(u32 sw_if_index, const ip4_address_t *addr, adj_walk_cb_t cb, void *ctx)
Walk adjacencies on a link with a given v4 next-hop.
Definition: adj_nbr.c:614
adj_index_t adj_nbr_add_or_lock(fib_protocol_t nh_proto, vnet_link_t link_type, const ip46_address_t *nh_addr, u32 sw_if_index)
Neighbour Adjacency sub-type.
Definition: adj_nbr.c:214
adj_walk_rc_t(* adj_walk_cb_t)(adj_index_t ai, void *ctx)
Call back function when walking adjacencies.
Definition: adj_types.h:50
u32 adj_index_t
An index for adjacencies.
Definition: adj_types.h:30
unsigned int u32
Definition: types.h:88
enum vnet_link_t_ vnet_link_t
Link Type: A description of the protocol of packets on the link.
unsigned char u8
Definition: types.h:56
enum adj_nbr_rewrite_flag_t_ adj_nbr_rewrite_flag_t
When adding a rewrite to an adjacency these are flags that apply to that rewrite. ...
vhost_vring_addr_t addr
Definition: vhost-user.h:82
u32 flags
Definition: vhost-user.h:76
u32 adj_nbr_db_size(void)
Return the size of the adjacency database.
Definition: adj_nbr.c:523
u8 * format_adj_nbr_incomplete(u8 *s, va_list *ap)
Format aa incomplete neigbour (ARP) adjacency.
Definition: adj_nbr.c:987