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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
16 * An adjacency is a representation of an attached L3 peer.
18 * Adjacency Sub-types:
19 * - neighbour: a representation of an attached L3 peer.
20 * Key:{addr,interface,link/ether-type}
22 * - glean: used to drive ARP/ND for packets destined to a local sub-net.
23 * 'glean' mean use the packet's destination address as the target
24 * address in the ARP packet.
25 * UNSHARED. Only one per-interface.
26 * - midchain: a nighbour adj on a virtual/tunnel interface.
28 * The API to create and update the adjacency is very sub-type specific. This
29 * is intentional as it encourages the user to carefully consider which adjacency
30 * sub-type they are really using, and hence assign it data in the appropriate
31 * sub-type space in the union of sub-types. This prevents the adj becoming a
32 * disorganised dumping group for 'my features needs a u16 somewhere' data. It
33 * is important to enforce this approach as space in the adjacency is a premium,
34 * as we need it to fit in 1 cache line.
36 * the API is also based around an index to an ajdacency not a raw pointer. This
37 * is so the user doesn't suffer the same limp inducing firearm injuries that
38 * the author suffered as the adjacenices can realloc.
44 #include <vnet/adj/adj_types.h>
45 #include <vnet/adj/adj_nbr.h>
46 #include <vnet/adj/adj_glean.h>
47 #include <vnet/adj/rewrite.h>
49 /** @brief Common (IP4/IP6) next index stored in adjacency. */
52 /** Adjacency to drop this packet. */
54 /** Adjacency to punt this packet. */
57 /** This packet is for one of our own IP addresses. */
60 /** This packet matches an "incomplete adjacency" and packets
61 need to be passed to ARP to find rewrite string for
65 /** This packet matches an "interface route" and packets
66 need to be passed to ARP to find rewrite string for
70 /** This packet is to be rewritten and forwarded to the next
71 processing node. This is typically the output interface but
72 might be another node for further output processing. */
73 IP_LOOKUP_NEXT_REWRITE,
75 /** This packets follow a mid-chain adjacency */
76 IP_LOOKUP_NEXT_MIDCHAIN,
78 /** This packets needs to go to ICMP error */
79 IP_LOOKUP_NEXT_ICMP_ERROR,
81 /** Multicast Adjacency. */
84 /** Broadcasr Adjacency. */
87 /** Multicast Midchain Adjacency. An Adjacency for sending macst packets
88 * on a tunnel/virtual interface */
89 IP_LOOKUP_NEXT_MCAST_MIDCHAIN,
92 } __attribute__ ((packed)) ip_lookup_next_t;
96 IP4_LOOKUP_N_NEXT = IP_LOOKUP_N_NEXT,
101 /* Hop-by-hop header handling */
102 IP6_LOOKUP_NEXT_HOP_BY_HOP = IP_LOOKUP_N_NEXT,
103 IP6_LOOKUP_NEXT_ADD_HOP_BY_HOP,
104 IP6_LOOKUP_NEXT_POP_HOP_BY_HOP,
108 #define IP4_LOOKUP_NEXT_NODES { \
109 [IP_LOOKUP_NEXT_DROP] = "ip4-drop", \
110 [IP_LOOKUP_NEXT_PUNT] = "ip4-punt", \
111 [IP_LOOKUP_NEXT_LOCAL] = "ip4-local", \
112 [IP_LOOKUP_NEXT_ARP] = "ip4-arp", \
113 [IP_LOOKUP_NEXT_GLEAN] = "ip4-glean", \
114 [IP_LOOKUP_NEXT_REWRITE] = "ip4-rewrite", \
115 [IP_LOOKUP_NEXT_MCAST] = "ip4-rewrite-mcast", \
116 [IP_LOOKUP_NEXT_BCAST] = "ip4-rewrite-bcast", \
117 [IP_LOOKUP_NEXT_MIDCHAIN] = "ip4-midchain", \
118 [IP_LOOKUP_NEXT_MCAST_MIDCHAIN] = "ip4-mcast-midchain", \
119 [IP_LOOKUP_NEXT_ICMP_ERROR] = "ip4-icmp-error", \
122 #define IP6_LOOKUP_NEXT_NODES { \
123 [IP_LOOKUP_NEXT_DROP] = "ip6-drop", \
124 [IP_LOOKUP_NEXT_PUNT] = "ip6-punt", \
125 [IP_LOOKUP_NEXT_LOCAL] = "ip6-local", \
126 [IP_LOOKUP_NEXT_ARP] = "ip6-discover-neighbor", \
127 [IP_LOOKUP_NEXT_GLEAN] = "ip6-glean", \
128 [IP_LOOKUP_NEXT_REWRITE] = "ip6-rewrite", \
129 [IP_LOOKUP_NEXT_BCAST] = "ip6-rewrite-bcast", \
130 [IP_LOOKUP_NEXT_MCAST] = "ip6-rewrite-mcast", \
131 [IP_LOOKUP_NEXT_MIDCHAIN] = "ip6-midchain", \
132 [IP_LOOKUP_NEXT_MCAST_MIDCHAIN] = "ip6-mcast-midchain", \
133 [IP_LOOKUP_NEXT_ICMP_ERROR] = "ip6-icmp-error", \
134 [IP6_LOOKUP_NEXT_HOP_BY_HOP] = "ip6-hop-by-hop", \
135 [IP6_LOOKUP_NEXT_ADD_HOP_BY_HOP] = "ip6-add-hop-by-hop", \
136 [IP6_LOOKUP_NEXT_POP_HOP_BY_HOP] = "ip6-pop-hop-by-hop", \
140 * The special broadcast address (to construct a broadcast adjacency
142 extern const ip46_address_t ADJ_BCAST_ADDR;
147 struct ip_adjacency_t_;
150 * @brief A function type for post-rewrite fixups on midchain adjacency
152 typedef void (*adj_midchain_fixup_t) (vlib_main_t * vm,
153 struct ip_adjacency_t_ * adj,
158 * @brief Flags on an IP adjacency
160 typedef enum ip_adjacency_flags_t_
165 * Currently a sync walk is active. Used to prevent re-entrant walking
167 ADJ_FLAG_SYNC_WALK_ACTIVE = (1 << 0),
170 * Packets TX through the midchain do not increment the interface
171 * counters. This should be used when the adj is associated with an L2
172 * interface and that L2 interface is in a bridege domain. In that case
173 * the packet will have traversed the interface's TX node, and hence have
174 * been counted, before it traverses ths midchain
176 ADJ_FLAG_MIDCHAIN_NO_COUNT = (1 << 1),
177 } __attribute__ ((packed)) adj_flags_t;
180 * @brief IP unicast adjacency.
181 * @note cache aligned.
183 * An adjacency is a represenation of a peer on a particular link.
185 typedef struct ip_adjacency_t_
187 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
190 * Linkage into the FIB node grpah. First member since this type
191 * has 8 byte alignment requirements.
196 * Next hop after ip4-lookup.
197 * This is not accessed in the rewrite nodes.
200 ip_lookup_next_t lookup_next_index;
209 * The protocol of the neighbor/peer. i.e. the protocol with
210 * which to interpret the 'next-hop' attirbutes of the sub-types.
213 fib_protocol_t ia_nh_proto;
216 * Flags on the adjacency
219 adj_flags_t ia_flags;
224 * IP_LOOKUP_NEXT_ARP/IP_LOOKUP_NEXT_REWRITE
226 * neighbour adjacency sub-type;
230 ip46_address_t next_hop;
233 * IP_LOOKUP_NEXT_MIDCHAIN
235 * A nbr adj that is also recursive. Think tunnels.
236 * A nbr adj can transition to be of type MDICHAIN
237 * so be sure to leave the two structs with the next_hop
243 * The recursive next-hop.
244 * This field MUST be at the same memory location as
245 * sub_type.nbr.next_hop
247 ip46_address_t next_hop;
249 * The next DPO to use
253 * A function to perform the post-rewrite fixup
255 adj_midchain_fixup_t fixup_func;
257 * Fixup data passed back to the client in the fixup function
259 const void *fixup_data;
262 * IP_LOOKUP_NEXT_GLEAN
264 * Glean the address to ARP for from the packet's destination.
265 * Technically these aren't adjacencies, i.e. they are not a
266 * representation of a peer. One day we might untangle this coupling
267 * and use a new Glean DPO.
271 ip46_address_t receive_addr;
275 CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
277 /* Rewrite in second/third cache lines */
278 vnet_declare_rewrite (VLIB_BUFFER_PRE_DATA_SIZE);
281 * more control plane members that do not fit on the first cacheline
284 * A sorted vector of delegates
286 struct adj_delegate_t_ *ia_delegates;
290 STATIC_ASSERT ((STRUCT_OFFSET_OF (ip_adjacency_t, cacheline0) == 0),
291 "IP adjacency cachline 0 is not offset");
292 STATIC_ASSERT ((STRUCT_OFFSET_OF (ip_adjacency_t, cacheline1) ==
293 CLIB_CACHE_LINE_BYTES),
294 "IP adjacency cachline 1 is more than one cachline size offset");
298 * Take a reference counting lock on the adjacency
300 extern void adj_lock(adj_index_t adj_index);
303 * Release a reference counting lock on the adjacency
305 extern void adj_unlock(adj_index_t adj_index);
309 * Add a child dependent to an adjacency. The child will
310 * thus be informed via its registerd back-walk function
311 * when the adjacency state changes.
313 extern u32 adj_child_add(adj_index_t adj_index,
314 fib_node_type_t type,
315 fib_node_index_t child_index);
318 * Remove a child dependent
320 extern void adj_child_remove(adj_index_t adj_index,
324 * @brief Walk the Adjacencies on a given interface
326 extern void adj_walk (u32 sw_if_index,
331 * @brief Return the link type of the adjacency
333 extern vnet_link_t adj_get_link_type (adj_index_t ai);
336 * @brief Return the sw interface index of the adjacency.
338 extern u32 adj_get_sw_if_index (adj_index_t ai);
341 * @brief Return true if the adjacency is 'UP', i.e. can be used for forwarding.
342 * 0 is down, !0 is up.
344 extern int adj_is_up (adj_index_t ai);
347 * @brief Return the link type of the adjacency
349 extern const u8* adj_get_rewrite (adj_index_t ai);
352 * @brief Notify the adjacency subsystem that the features settings for
353 * an interface have changed
355 extern void adj_feature_update (u32 sw_if_index, u8 arc_index, u8 is_enable);
359 * The global adjacnecy pool. Exposed for fast/inline data-plane access
361 extern ip_adjacency_t *adj_pool;
365 * Adjacency packet counters
367 extern vlib_combined_counter_main_t adjacency_counters;
370 * @brief Global Config for enabling per-adjacency counters
371 * This is configurable because it comes with a non-negligible
372 * performance cost. */
373 extern int adj_per_adj_counters;
377 * Get a pointer to an adjacency object from its index
379 static inline ip_adjacency_t *
380 adj_get (adj_index_t adj_index)
382 return (vec_elt_at_index(adj_pool, adj_index));
386 * @brief Get the global configuration option for enabling per-adj counters
389 adj_are_counters_enabled (void)
391 return (adj_per_adj_counters);