FD.io VPP  v18.04-17-g3a0d853
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  * [re]stack a midchain. 'Stacking' is the act of forming parent-child
56  * relationships in the data-plane graph.
57  *
58  * @param adj_index
59  * The index of the midchain to stack
60  *
61  * @param dpo
62  * The parent DPO to stack onto (i.e. become a child of).
63  */
64 extern void adj_nbr_midchain_stack(adj_index_t adj_index,
65  const dpo_id_t *dpo);
66 
67 /**
68  * @brief
69  * unstack a midchain. This will break the chain between the midchain and
70  * the next graph section. This is a implemented as stack-on-drop
71  *
72  * @param adj_index
73  * The index of the midchain to stack
74  */
75 extern void adj_nbr_midchain_unstack(adj_index_t adj_index);
76 
77 /**
78  * @brief
79  * Module initialisation
80  */
81 extern void adj_midchain_module_init(void);
82 
83 /**
84  * @brief
85  * Format a midchain adjacency
86  */
87 extern u8* format_adj_midchain(u8* s, va_list *ap);
88 
89 #endif
void adj_nbr_midchain_unstack(adj_index_t adj_index)
unstack a midchain.
Definition: adj_midchain.c:548
u8 * format_adj_midchain(u8 *s, va_list *ap)
Format a midchain adjacency.
Definition: adj_midchain.c:588
enum ip_adjacency_flags_t_ adj_flags_t
Flags on an IP adjacency.
void adj_nbr_midchain_stack(adj_index_t adj_index, const dpo_id_t *dpo)
[re]stack a midchain.
Definition: adj_midchain.c:570
The identity of a DPO is a combination of its type and its instance number/index of objects of that t...
Definition: dpo.h:168
void(* adj_midchain_fixup_t)(vlib_main_t *vm, 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:142
u32 adj_index_t
An index for adjacencies.
Definition: adj_types.h:30
unsigned char u8
Definition: types.h:56
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:506
void adj_midchain_module_init(void)
Module initialisation.
Definition: adj_midchain.c:670
u32 flags
Definition: vhost-user.h:77