misc: deprecate gbp and its dependents
[vpp.git] / extras / deprecated / 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 #include <vnet/dpo/load_balance.h>
21 #include <vnet/fib/ip4_fib.h>
22 #include <vnet/fib/ip6_fib.h>
23
24 /**
25  * @brief
26  * The GBP FWD DPO. Used in the L3 path to select the correct EPG uplink
27  * based on the source EPG.
28  */
29 typedef struct gbp_policy_dpo_t_
30 {
31   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
32
33   /**
34    * The protocol of packets using this DPO
35    */
36   dpo_proto_t gpd_proto;
37
38   /**
39    * SClass
40    */
41   sclass_t gpd_sclass;
42
43   /**
44    * sclass scope
45    */
46   gbp_scope_t gpd_scope;
47
48   /**
49    * output sw_if_index
50    */
51   u32 gpd_sw_if_index;
52
53   /**
54    * number of locks.
55    */
56   u16 gpd_locks;
57
58   /**
59    * Stacked DPO on DVR/ADJ of output interface
60    */
61   dpo_id_t gpd_dpo;
62 } gbp_policy_dpo_t;
63
64 extern void gbp_policy_dpo_add_or_lock (dpo_proto_t dproto,
65                                         gbp_scope_t scope,
66                                         sclass_t sclass,
67                                         u32 sw_if_index, dpo_id_t * dpo);
68
69 extern dpo_type_t gbp_policy_dpo_get_type (void);
70
71 extern vlib_node_registration_t ip4_gbp_policy_dpo_node;
72 extern vlib_node_registration_t ip6_gbp_policy_dpo_node;
73 extern vlib_node_registration_t gbp_policy_port_node;
74
75 /**
76  * Types exposed for the Data-plane
77  */
78 extern dpo_type_t gbp_policy_dpo_type;
79 extern gbp_policy_dpo_t *gbp_policy_dpo_pool;
80
81 always_inline gbp_policy_dpo_t *
82 gbp_policy_dpo_get (index_t index)
83 {
84   return (pool_elt_at_index (gbp_policy_dpo_pool, index));
85 }
86
87 static_always_inline const gbp_policy_dpo_t *
88 gbp_classify_get_gpd (const ip4_address_t * ip4, const ip6_address_t * ip6,
89                       const u32 fib_index)
90 {
91   const gbp_policy_dpo_t *gpd;
92   const dpo_id_t *dpo;
93   const load_balance_t *lb;
94   u32 lbi;
95
96   if (ip4)
97     lbi = ip4_fib_forwarding_lookup (fib_index, ip4);
98   else if (ip6)
99     lbi = ip6_fib_table_fwding_lookup (fib_index, ip6);
100   else
101     return 0;
102
103   lb = load_balance_get (lbi);
104   dpo = load_balance_get_bucket_i (lb, 0);
105
106   if (dpo->dpoi_type != gbp_policy_dpo_type)
107     return 0;
108
109   gpd = gbp_policy_dpo_get (dpo->dpoi_index);
110   return gpd;
111 }
112
113 /*
114  * fd.io coding-style-patch-verification: ON
115  *
116  * Local Variables:
117  * eval: (c-set-style "gnu")
118  * End:
119  */
120
121 #endif