FD.io VPP  v19.04.4-rc0-5-ge88582fac
Vector Packet Processing
dvr_dpo.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 #ifndef __DVR_DPO_H__
17 #define __DVR_DPO_H__
18 
19 #include <vnet/dpo/dpo.h>
20 
21 /**
22  * @brief
23  * The DVR DPO. Used as the resolving object for a DVR route.
24  * This is used, in place of the usual L3 Adjacency, to retransmit
25  * the packet with the original L2 header intact but also to run L3 features.
26  * After running L3 features the packet is re-injected back into the L2 path
27  * so it can pick up the necessary VLAN tags of the egress interface.
28  * This re-injection is done with an output feature.
29  */
30 typedef struct dvr_dpo_t_
31 {
32  /**
33  * The Software interface index that the packets will output on
34  */
36 
37  /**
38  * The protocol of packets using this DPO
39  */
41 
42  /**
43  * number of locks.
44  */
46 } dvr_dpo_t;
47 
49  dpo_proto_t dproto,
50  dpo_id_t *dpo);
51 
52 extern void dvr_dpo_module_init(void);
53 
54 /**
55  * @brief pool of all interface DPOs
56  */
57 extern dvr_dpo_t *dvr_dpo_pool;
58 
59 static inline dvr_dpo_t *
61 {
62  return (pool_elt_at_index(dvr_dpo_pool, index));
63 }
64 
65 #endif
u32 sw_if_index
Definition: ipsec_gre.api:37
u32 index_t
A Data-Path Object is an object that represents actions that are applied to packets are they are swit...
Definition: dpo.h:41
static dvr_dpo_t * dvr_dpo_get(index_t index)
Definition: dvr_dpo.h:60
u16 dd_locks
number of locks.
Definition: dvr_dpo.h:45
void dvr_dpo_add_or_lock(u32 sw_if_index, dpo_proto_t dproto, dpo_id_t *dpo)
Definition: dvr_dpo.c:90
unsigned int u32
Definition: types.h:88
enum dpo_proto_t_ dpo_proto_t
Data path protocol.
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
#define pool_elt_at_index(p, i)
Returns pointer to element at given index.
Definition: pool.h:514
unsigned short u16
Definition: types.h:57
struct dvr_dpo_t_ dvr_dpo_t
The DVR DPO.
dpo_proto_t dd_proto
The protocol of packets using this DPO.
Definition: dvr_dpo.h:40
u32 dd_sw_if_index
The Software interface index that the packets will output on.
Definition: dvr_dpo.h:35
void dvr_dpo_module_init(void)
Definition: dvr_dpo.c:226
dvr_dpo_t * dvr_dpo_pool
pool of all interface DPOs
Definition: dvr_dpo.c:22
The DVR DPO.
Definition: dvr_dpo.h:30