misc: deprecate gbp and its dependents
[vpp.git] / extras / deprecated / plugins / gbp / gbp_fwd_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_FWD_DPO_H__
17 #define __GBP_FWD_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_fwd_dpo_t_
27 {
28   /**
29    * The protocol of packets using this DPO
30    */
31   dpo_proto_t gfd_proto;
32
33   /**
34    * number of locks.
35    */
36   u16 gfd_locks;
37 } gbp_fwd_dpo_t;
38
39 extern void gbp_fwd_dpo_add_or_lock (dpo_proto_t dproto, dpo_id_t * dpo);
40
41 extern dpo_type_t gbp_fwd_dpo_get_type (void);
42
43 /**
44  * @brief pool of all interface DPOs
45  */
46 extern gbp_fwd_dpo_t *gbp_fwd_dpo_pool;
47
48 static inline gbp_fwd_dpo_t *
49 gbp_fwd_dpo_get (index_t index)
50 {
51   return (pool_elt_at_index (gbp_fwd_dpo_pool, index));
52 }
53
54 /*
55  * fd.io coding-style-patch-verification: ON
56  *
57  * Local Variables:
58  * eval: (c-set-style "gnu")
59  * End:
60  */
61
62 #endif