GBP: l3-out subnets
[vpp.git] / src / plugins / gbp / gbp_recirc.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_RECIRC_H__
17 #define __GBP_RECIRC_H__
18
19 #include <plugins/gbp/gbp_types.h>
20 #include <vnet/fib/fib_types.h>
21
22 /**
23  * A GBP recirculation interface representation
24  *  Thes interfaces join Bridge domains that are internal to those that are
25  * NAT external, so the packets can be NAT translated and then undergo the
26  * whole policy process again.
27  */
28 typedef struct gpb_recirc_t_
29 {
30   /**
31    * EPG ID that packets will classify to when they arrive on this recirc
32    */
33   epg_id_t gr_epg;
34
35   /**
36    * The index of the EPG
37    */
38   index_t gr_epgi;
39
40   /**
41    * FIB indices the EPG is mapped to
42    */
43   u32 gr_fib_index[DPO_PROTO_NUM];
44
45   /**
46    * Is the interface for packets post-NAT translation (i.e. ext)
47    * or pre-NAT translation (i.e. internal)
48    */
49   u8 gr_is_ext;
50
51   /**
52    */
53   u32 gr_sw_if_index;
54   u32 gr_itf;
55
56   /**
57    * The endpoint created to represent the reric interface
58    */
59   index_t gr_ep;
60 } gbp_recirc_t;
61
62 extern int gbp_recirc_add (u32 sw_if_index, epg_id_t epg_id, u8 is_ext);
63 extern void gbp_recirc_delete (u32 sw_if_index);
64
65 typedef walk_rc_t (*gbp_recirc_cb_t) (gbp_recirc_t * gbpe, void *ctx);
66 extern void gbp_recirc_walk (gbp_recirc_cb_t bgpe, void *ctx);
67
68 /**
69  * Data plane functions
70  */
71 extern gbp_recirc_t *gbp_recirc_pool;
72 extern index_t *gbp_recirc_db;
73
74 always_inline gbp_recirc_t *
75 gbp_recirc_get (u32 sw_if_index)
76 {
77   return (pool_elt_at_index (gbp_recirc_pool, gbp_recirc_db[sw_if_index]));
78 }
79 #endif
80
81 /*
82  * fd.io coding-style-patch-verification: ON
83  *
84  * Local Variables:
85  * eval: (c-set-style "gnu")
86  * End:
87  */