FD.io VPP  v19.01.3-6-g70449b9b9
Vector Packet Processing
gbp_endpoint_group.h
Go to the documentation of this file.
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_ENDPOINT_GROUP_H__
17 #define __GBP_ENDPOINT_GROUP_H__
18 
19 #include <plugins/gbp/gbp_types.h>
20 
21 #include <vnet/fib/fib_types.h>
22 
23 /**
24  * An Endpoint Group representation
25  */
26 typedef struct gpb_endpoint_group_t_
27 {
28  /**
29  * ID
30  */
32 
33  /**
34  * Bridge-domain ID the EPG is in
35  */
38 
39  /**
40  * route-domain/IP-table ID the EPG is in
41  */
43 
44  /**
45  * Is the EPG an external/NAT
46  */
48 
49  /**
50  * the uplink interface dedicated to the EPG
51  */
53 
54  /**
55  * The DPO used in the L3 path for forwarding internal subnets
56  */
58 
59  /**
60  * Locks/references to this EPG
61  */
64 
65 /**
66  * EPG DB, key'd on EGP-ID
67  */
69 {
72 
74  u32 bd_id,
75  u32 rd_id,
76  u32 uplink_sw_if_index);
79 extern void gbp_endpoint_group_unlock (index_t index);
80 extern void gbp_endpoint_group_lock (index_t index);
82 
85  gg, fib_protocol_t fproto);
86 
88  void *ctx);
89 extern void gbp_endpoint_group_walk (gbp_endpoint_group_cb_t bgpe, void *ctx);
90 
91 
92 extern u8 *format_gbp_endpoint_group (u8 * s, va_list * args);
93 
94 /**
95  * DP functions and databases
96  */
99 
102 {
103  uword *p;
104 
105  p = hash_get (gbp_endpoint_group_db.gg_hash, epg);
106 
107  if (NULL != p)
108  {
110 
111  gg = pool_elt_at_index (gbp_endpoint_group_pool, p[0]);
112  return (gg->gg_uplink_sw_if_index);
113  }
114  return (~0);
115 }
116 
117 always_inline const dpo_id_t *
119 {
120  uword *p;
121 
122  p = hash_get (gbp_endpoint_group_db.gg_hash, epg);
123 
124  if (NULL != p)
125  {
127 
128  gg = pool_elt_at_index (gbp_endpoint_group_pool, p[0]);
129  return (&gg->gg_dpo[fproto]);
130  }
131  return (NULL);
132 }
133 
134 #endif
135 
136 /*
137  * fd.io coding-style-patch-verification: ON
138  *
139  * Local Variables:
140  * eval: (c-set-style "gnu")
141  * End:
142  */
EPG DB, key&#39;d on EGP-ID.
u16 epg_id_t
Definition: gbp_types.h:21
void gbp_endpoint_group_walk(gbp_endpoint_group_cb_t bgpe, void *ctx)
#define NULL
Definition: clib.h:58
#define FIB_PROTOCOL_IP_MAX
Definition outside of enum so it does not need to be included in non-defaulted switch statements...
Definition: fib_types.h:58
u32 index_t
A Data-Path Object is an object that represents actions that are applied to packets are they are swit...
Definition: dpo.h:41
int i
u32 rd_id
Definition: gbp.api:261
index_t gg_rd
route-domain/IP-table ID the EPG is in
unsigned char u8
Definition: types.h:56
enum fib_protocol_t_ fib_protocol_t
Protocol Type.
static u32 gbp_epg_itf_lookup(epg_id_t epg)
struct gpb_endpoint_group_t_ gbp_endpoint_group_t
An Endpoint Group representation.
gbp_endpoint_group_t * gbp_endpoint_group_pool
Pool of GBP endpoint_groups.
u8 gg_is_ext
Is the EPG an external/NAT.
#define always_inline
Definition: clib.h:98
index_t gbp_endpoint_group_find(epg_id_t epg_id)
unsigned int u32
Definition: types.h:88
int(* gbp_endpoint_group_cb_t)(gbp_endpoint_group_t *gbpe, void *ctx)
u8 * format_gbp_endpoint_group(u8 *s, va_list *args)
The identity of a DPO is a combination of its type and its instance number/index of objects of that t...
Definition: dpo.h:168
#define hash_get(h, key)
Definition: hash.h:249
#define pool_elt_at_index(p, i)
Returns pointer to element at given index.
Definition: pool.h:511
static const dpo_id_t * gbp_epg_dpo_lookup(epg_id_t epg, fib_protocol_t fproto)
long ctx[MAX_CONNS]
Definition: main.c:144
u32 bd_id
Definition: gbp.api:260
u16 epg_id
Definition: gbp.api:116
gbp_endpoint_group_db_t gbp_endpoint_group_db
DP functions and databases.
An Endpoint Group representation.
gbp_endpoint_group_t * gbp_endpoint_group_get(index_t i)
u32 gbp_endpoint_group_get_bd_id(const gbp_endpoint_group_t *)
u32 gg_locks
Locks/references to this EPG.
int gbp_endpoint_group_add_and_lock(epg_id_t epg_id, u32 bd_id, u32 rd_id, u32 uplink_sw_if_index)
int gbp_endpoint_group_delete(epg_id_t epg_id)
struct gbp_endpoint_group_db_t_ gbp_endpoint_group_db_t
EPG DB, key&#39;d on EGP-ID.
index_t gbp_endpoint_group_get_fib_index(const gbp_endpoint_group_t *gg, fib_protocol_t fproto)
dpo_id_t gg_dpo[FIB_PROTOCOL_IP_MAX]
The DPO used in the L3 path for forwarding internal subnets.
void gbp_endpoint_group_unlock(index_t index)
void gbp_endpoint_group_lock(index_t index)
u32 gg_uplink_sw_if_index
the uplink interface dedicated to the EPG
u64 uword
Definition: types.h:112
index_t gg_gbd
Bridge-domain ID the EPG is in.