gbp: VRF scoped contracts
[vpp.git] / src / plugins / gbp / gbp_policy_dpo.h
1 /*
2  * Copyright (c) 2018 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 __GBP_POLICY_DPO_H__
17 #define __GBP_POLICY_DPO_H__
18
19 #include <vnet/dpo/dpo.h>
20
21 /**
22  * @brief
23  * The GBP FWD DPO. Used in the L3 path to select the correct EPG uplink
24  * based on the source EPG.
25  */
26 typedef struct gbp_policy_dpo_t_
27 {
28   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
29
30   /**
31    * The protocol of packets using this DPO
32    */
33   dpo_proto_t gpd_proto;
34
35   /**
36    * SClass
37    */
38   sclass_t gpd_sclass;
39
40   /**
41    * sclass scope
42    */
43   gbp_scope_t gpd_scope;
44
45   /**
46    * output sw_if_index
47    */
48   u32 gpd_sw_if_index;
49
50   /**
51    * number of locks.
52    */
53   u16 gpd_locks;
54
55   /**
56    * Stacked DPO on DVR/ADJ of output interface
57    */
58   dpo_id_t gpd_dpo;
59 } gbp_policy_dpo_t;
60
61 extern void gbp_policy_dpo_add_or_lock (dpo_proto_t dproto,
62                                         gbp_scope_t scope,
63                                         sclass_t sclass,
64                                         u32 sw_if_index, dpo_id_t * dpo);
65
66 extern dpo_type_t gbp_policy_dpo_get_type (void);
67
68 extern vlib_node_registration_t ip4_gbp_policy_dpo_node;
69 extern vlib_node_registration_t ip6_gbp_policy_dpo_node;
70 extern vlib_node_registration_t gbp_policy_port_node;
71
72 /**
73  * Types exposed for the Data-plane
74  */
75 extern dpo_type_t gbp_policy_dpo_type;
76 extern gbp_policy_dpo_t *gbp_policy_dpo_pool;
77
78 always_inline gbp_policy_dpo_t *
79 gbp_policy_dpo_get (index_t index)
80 {
81   return (pool_elt_at_index (gbp_policy_dpo_pool, index));
82 }
83
84 /*
85  * fd.io coding-style-patch-verification: ON
86  *
87  * Local Variables:
88  * eval: (c-set-style "gnu")
89  * End:
90  */
91
92 #endif