f17ace50876372113ddca99f431ffd0388c92682
[vpp.git] / src / vnet / dpo / l3_proxy_dpo.h
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 L3 proxy. An L3 proxy is when VPP has
18  * an address in the FIB that is also assigned to an attached host.
19  */
20
21 #ifndef __L3_PROXY_DPO_H__
22 #define __L3_PROXY_DPO_H__
23
24 #include <vnet/dpo/dpo.h>
25 #include <vnet/ip/ip6.h>
26
27 typedef struct l3_proxy_dpo_t_
28 {
29     /**
30      * The Software interface index on which traffic is l3_proxyd
31      */
32     u32 l3p_sw_if_index;
33
34     /**
35      * number oflocks.
36      */
37     u16 l3p_locks;
38 } l3_proxy_dpo_t;
39
40 extern void l3_proxy_dpo_add_or_lock (dpo_proto_t proto,
41                                       u32 sw_if_index,
42                                       dpo_id_t *dpo);
43
44 extern void l3_proxy_dpo_module_init(void);
45
46 /**
47  * @brief pool of all l3_proxy DPOs
48  */
49 l3_proxy_dpo_t *l3_proxy_dpo_pool;
50
51 static inline l3_proxy_dpo_t *
52 l3_proxy_dpo_get (index_t index)
53 {
54     return (pool_elt_at_index(l3_proxy_dpo_pool, index));
55 }
56
57 #endif