FD.io VPP  v19.04.1-1-ge4a0f9f
Vector Packet Processing
receive_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  * @brief
17  * The data-path object representing receiveing the packet, i.e. it's for-us
18  */
19 
20 #ifndef __RECEIVE_DPO_H__
21 #define __RECEIVE_DPO_H__
22 
23 #include <vnet/dpo/dpo.h>
24 #include <vnet/ip/ip6.h>
25 
26 typedef struct receive_dpo_t_
27 {
28  /**
29  * required for pool_get_aligned.
30  * memebers used in the switch path come first!
31  */
32  CLIB_CACHE_LINE_ALIGN_MARK(cacheline0);
33 
34  /**
35  * The Software interface index on which traffic is received
36  */
38 
39  /**
40  * The address on the receive interface. packet are destined to this address
41  */
42  ip46_address_t rd_addr;
43 
44  /**
45  * number oflocks.
46  */
49 
50 extern int dpo_is_receive(const dpo_id_t *dpo);
51 
52 extern void receive_dpo_add_or_lock (dpo_proto_t proto,
54  const ip46_address_t *nh_addr,
55  dpo_id_t *dpo);
56 
57 extern void receive_dpo_module_init(void);
58 
59 /**
60  * @brief pool of all receive DPOs
61  */
63 
64 static inline receive_dpo_t *
66 {
67  return (pool_elt_at_index(receive_dpo_pool, index));
68 }
69 
70 #endif
u32 sw_if_index
Definition: ipsec_gre.api:37
void receive_dpo_add_or_lock(dpo_proto_t proto, u32 sw_if_index, const ip46_address_t *nh_addr, dpo_id_t *dpo)
Definition: receive_dpo.c:62
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
int dpo_is_receive(const dpo_id_t *dpo)
Definition: receive_dpo.c:29
unsigned int u32
Definition: types.h:88
enum dpo_proto_t_ dpo_proto_t
Data path protocol.
CLIB_CACHE_LINE_ALIGN_MARK(cacheline0)
required for pool_get_aligned.
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
void receive_dpo_module_init(void)
Definition: receive_dpo.c:173
static receive_dpo_t * receive_dpo_get(index_t index)
Definition: receive_dpo.h:65
struct receive_dpo_t_ receive_dpo_t
The data-path object representing receiveing the packet, i.e.
u32 rd_sw_if_index
The Software interface index on which traffic is received.
Definition: receive_dpo.h:37
The data-path object representing receiveing the packet, i.e.
Definition: receive_dpo.h:26
ip46_address_t rd_addr
The address on the receive interface.
Definition: receive_dpo.h:42
u16 rd_locks
number oflocks.
Definition: receive_dpo.h:47
receive_dpo_t * receive_dpo_pool
pool of all receive DPOs
Definition: receive_dpo.c:26