FD.io VPP  v21.01.1
Vector Packet Processing
adj_midchain.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  * 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.
20  */
21 
22 #ifndef __ADJ_MIDCHAIN_H__
23 #define __ADJ_MIDCHAIN_H__
24 
25 #include <vnet/adj/adj.h>
26 
27 /**
28  * @brief
29  * Convert an existing neighbour adjacency into a midchain
30  *
31  * @param adj_index
32  * The index of the neighbour adjacency.
33  *
34  * @param fixup
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).
37  * @param fixup_data
38  * Context data set by the caller that is provided as an argument in the
39  * fixup function.
40  *
41  * @param flags
42  * Flags controlling the adjacency behaviour
43  *
44  * @param rewrite
45  * The rewrite.
46  */
47 extern void adj_nbr_midchain_update_rewrite(adj_index_t adj_index,
49  const void *fixup_data,
51  u8 *rewrite);
52 
53 /**
54  * @brief
55  * Return the adjacency's next node to its default value
56  *
57  * @param adj_index
58  * The index of the neighbour adjacency.
59  */
60 extern void adj_nbr_midchain_reset_next_node(adj_index_t adj_index);
61 
62 /**
63  * @brief
64  * Update the VLIB node to which packets are sent post processing
65  *
66  * @param adj_index
67  * The index of the neighbour adjacency.
68  *
69  * @param node node-index to send to
70  */
72  u32 node_index);
73 
74 /**
75  * @brief
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.
79  *
80  * @param adj_index
81  * The index of the midchain to stack
82  *
83  * @param dpo
84  * The parent DPO to stack onto (i.e. become a child of).
85  */
86 extern void adj_nbr_midchain_stack(adj_index_t adj_index,
87  const dpo_id_t *dpo);
88 
89 /**
90  * @brief
91  * [re]stack a midchain. 'Stacking' is the act of forming parent-child
92  * relationships in the data-plane graph. Since function performs recursive
93  * loop detection.
94  *
95  * @param adj_index
96  * The index of the midchain to stack
97  *
98  * @param fei
99  * The FIB entry to stack on
100  *
101  * @param fct
102  * The chain type to use from the fib entry fowarding
103  */
105  fib_node_index_t fei,
107 
108 /**
109  * @brief
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
112  *
113  * @param adj_index
114  * The index of the midchain to stack
115  */
116 extern void adj_nbr_midchain_unstack(adj_index_t adj_index);
117 
118 /**
119  * @brief descend the FIB graph looking for loops
120  *
121  * @param ai
122  * The adj index to traverse
123  *
124  * @param entry_indicies)
125  * A pointer to a vector of FIB entries already visited.
126  */
128  fib_node_index_t **entry_indicies);
129 
130 /**
131  * @brief
132  * Module initialisation
133  */
134 extern void adj_midchain_module_init(void);
135 
136 /**
137  * @brief
138  * Format a midchain adjacency
139  */
140 extern u8* format_adj_midchain(u8* s, va_list *ap);
141 
142 /**
143  * @brief
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
148  */
150  u32 fib_index,
151  const fib_prefix_t *pfx);
152 
153 /**
154  * @brief restack a midchain delegate
155  */
157 
158 /**
159  * @brief unstack a midchain delegate (this stacks it on a drop)
160  */
162 
163 extern u8 adj_is_midchain (adj_index_t ai);
164 
165 #endif
int adj_ndr_midchain_recursive_loop_detect(adj_index_t ai, fib_node_index_t **entry_indicies)
descend the FIB graph looking for loops
Definition: adj_midchain.c:659
vl_api_wireguard_peer_flags_t flags
Definition: wireguard.api:105
void adj_midchain_delegate_stack(adj_index_t ai, u32 fib_index, const fib_prefix_t *pfx)
create/attach a midchain delegate and stack it on the prefix passed
void adj_nbr_midchain_unstack(adj_index_t adj_index)
unstack a midchain.
Definition: adj_midchain.c:530
void(* adj_midchain_fixup_t)(vlib_main_t *vm, const struct ip_adjacency_t_ *adj, vlib_buffer_t *b0, const void *data)
A function type for post-rewrite fixups on midchain adjacency.
Definition: adj.h:152
u8 adj_is_midchain(adj_index_t ai)
Definition: adj_midchain.c:256
unsigned char u8
Definition: types.h:56
u8 * format_adj_midchain(u8 *s, va_list *ap)
Format a midchain adjacency.
Definition: adj_midchain.c:686
void adj_nbr_midchain_reset_next_node(adj_index_t adj_index)
Return the adjacency&#39;s next node to its default value.
Definition: adj_midchain.c:499
void adj_nbr_midchain_stack(adj_index_t adj_index, const dpo_id_t *dpo)
[re]stack a midchain.
Definition: adj_midchain.c:641
Aggregate type for a prefix.
Definition: fib_types.h:202
unsigned int u32
Definition: types.h:88
The identity of a DPO is a combination of its type and its instance number/index of objects of that t...
Definition: dpo.h:170
void adj_nbr_midchain_update_next_node(adj_index_t adj_index, u32 node_index)
Update the VLIB node to which packets are sent post processing.
Definition: adj_midchain.c:473
void adj_midchain_delegate_restack(adj_index_t ai)
restack a midchain delegate
void adj_nbr_midchain_stack_on_fib_entry(adj_index_t adj_index, fib_node_index_t fei, fib_forward_chain_type_t fct)
[re]stack a midchain.
Definition: adj_midchain.c:562
u32 fib_node_index_t
A typedef of a node index.
Definition: fib_types.h:29
u32 adj_index_t
An index for adjacencies.
Definition: adj_types.h:30
void adj_midchain_delegate_unstack(adj_index_t ai)
unstack a midchain delegate (this stacks it on a drop)
enum fib_forward_chain_type_t_ fib_forward_chain_type_t
FIB output chain type.
enum adj_flags_t_ adj_flags_t
Flags on an IP adjacency.
void adj_nbr_midchain_update_rewrite(adj_index_t adj_index, adj_midchain_fixup_t fixup, const void *fixup_data, adj_flags_t flags, u8 *rewrite)
Midchain Adjacency sub-type.
Definition: adj_midchain.c:440
void adj_midchain_module_init(void)
Module initialisation.
Definition: adj_midchain.c:777