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 * Midchain Adjacency sub-type. These adjs represent an L3 peer on a
17 * tunnel interface. The tunnel's adjacency is thus not the end of the chain,
18 * and needs to stack on/link to another chain (or portion of the graph) to
19 * reach the tunnel's destination.
22 #ifndef __ADJ_MIDCHAIN_H__
23 #define __ADJ_MIDCHAIN_H__
25 #include <vnet/adj/adj.h>
29 * Convert an existing neighbour adjacency into a midchain
32 * The index of the neighbour adjacency.
35 * The function that will be invoked at paket switch time to 'fixup'
36 * the rewrite applied with necessary per-packet info (i.e. length, checksums).
38 * Context data set by the caller that is provided as an argument in the
42 * Flags controlling the adjacency behaviour
47 extern void adj_nbr_midchain_update_rewrite(adj_index_t adj_index,
48 adj_midchain_fixup_t fixup,
49 const void *fixup_data,
55 * Return the adjacency's next node to its default value
58 * The index of the neighbour adjacency.
60 extern void adj_nbr_midchain_reset_next_node(adj_index_t adj_index);
64 * Update the VLIB node to which packets are sent post processing
67 * The index of the neighbour adjacency.
69 * @param node node-index to send to
71 extern void adj_nbr_midchain_update_next_node(adj_index_t adj_index,
76 * [re]stack a midchain. 'Stacking' is the act of forming parent-child
77 * relationships in the data-plane graph. Do NOT use this function to
78 * stack on a DPO type that might form a loop.
81 * The index of the midchain to stack
84 * The parent DPO to stack onto (i.e. become a child of).
86 extern void adj_nbr_midchain_stack(adj_index_t adj_index,
91 * [re]stack a midchain. 'Stacking' is the act of forming parent-child
92 * relationships in the data-plane graph. Since function performs recursive
96 * The index of the midchain to stack
99 * The FIB entry to stack on
102 * The chain type to use from the fib entry forwarding
104 extern void adj_nbr_midchain_stack_on_fib_entry(adj_index_t adj_index,
105 fib_node_index_t fei,
106 fib_forward_chain_type_t fct);
110 * unstack a midchain. This will break the chain between the midchain and
111 * the next graph section. This is a implemented as stack-on-drop
114 * The index of the midchain to stack
116 extern void adj_nbr_midchain_unstack(adj_index_t adj_index);
119 * @brief descend the FIB graph looking for loops
122 * The adj index to traverse
124 * @param entry_indicies)
125 * A pointer to a vector of FIB entries already visited.
127 extern int adj_ndr_midchain_recursive_loop_detect(adj_index_t ai,
128 fib_node_index_t **entry_indicies);
132 * Module initialisation
134 extern void adj_midchain_module_init(void);
138 * Format a midchain adjacency
140 extern u8* format_adj_midchain(u8* s, va_list *ap);
144 * create/attach a midchain delegate and stack it on the prefix passed
145 * @param ai - the index of the adjacency to stack
146 * @param fib_index - The FIB index of the prefix on which to stack
147 * @param pfx - The prefix on which to stack
149 extern void adj_midchain_delegate_stack(adj_index_t ai,
151 const fib_prefix_t *pfx);
154 * @brief restack a midchain delegate
156 extern void adj_midchain_delegate_restack(adj_index_t ai);
159 * @brief unstack a midchain delegate (this stacks it on a drop)
161 extern void adj_midchain_delegate_unstack(adj_index_t ai);
163 extern u8 adj_is_midchain (adj_index_t ai);