FD.io VPP  v18.07.1-19-g511ce25
Vector Packet Processing
gbp_endpoint.hpp
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2017 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 __VOM_GBP_ENDPOINT_H__
17 #define __VOM_GBP_ENDPOINT_H__
18 
19 #include <ostream>
20 
22 #include "vom/interface.hpp"
23 #include "vom/singular_db.hpp"
24 
25 namespace VOM {
26 /**
27  * A GBP Enpoint (i.e. a VM)
28  */
29 class gbp_endpoint : public object_base
30 {
31 public:
32  /**
33  * The key for a GBP endpoint; interface and IP
34  */
35  typedef std::pair<interface::key_t, boost::asio::ip::address> key_t;
36 
37  /**
38  * Construct a GBP endpoint
39  */
40  gbp_endpoint(const interface& itf,
41  const boost::asio::ip::address& ip_addr,
42  const mac_address_t& mac,
43  const gbp_endpoint_group& epg);
44 
45  /**
46  * Copy Construct
47  */
48  gbp_endpoint(const gbp_endpoint& r);
49 
50  /**
51  * Destructor
52  */
53  ~gbp_endpoint();
54 
55  /**
56  * Return the object's key
57  */
58  const key_t key() const;
59 
60  /**
61  * comparison operator
62  */
63  bool operator==(const gbp_endpoint& bdae) const;
64 
65  /**
66  * Return the matching 'singular instance'
67  */
68  std::shared_ptr<gbp_endpoint> singular() const;
69 
70  /**
71  * Find the instnace of the bridge_domain domain in the OM
72  */
73  static std::shared_ptr<gbp_endpoint> find(const key_t& k);
74 
75  /**
76  * Dump all bridge_domain-doamin into the stream provided
77  */
78  static void dump(std::ostream& os);
79 
80  /**
81  * replay the object to create it in hardware
82  */
83  void replay(void);
84 
85  /**
86  * Convert to string for debugging
87  */
88  std::string to_string() const;
89 
90 private:
91  /**
92  * Class definition for listeners to OM events
93  */
95  {
96  public:
97  event_handler();
98  virtual ~event_handler() = default;
99 
100  /**
101  * Handle a populate event
102  */
103  void handle_populate(const client_db::key_t& key);
104 
105  /**
106  * Handle a replay event
107  */
108  void handle_replay();
109 
110  /**
111  * Show the object in the Singular DB
112  */
113  void show(std::ostream& os);
114 
115  /**
116  * Get the sortable Id of the listener
117  */
118  dependency_t order() const;
119  };
120 
121  /**
122  * event_handler to register with OM
123  */
124  static event_handler m_evh;
125 
126  /**
127  * Commit the acculmulated changes into VPP. i.e. to a 'HW" write.
128  */
129  void update(const gbp_endpoint& obj);
130 
131  /**
132  * Find or add the instnace of the bridge_domain domain in the OM
133  */
134  static std::shared_ptr<gbp_endpoint> find_or_add(const gbp_endpoint& temp);
135 
136  /*
137  * It's the VPPHW class that updates the objects in HW
138  */
139  friend class OM;
140 
141  /**
142  * It's the singular_db class that calls replay()
143  */
144  friend class singular_db<key_t, gbp_endpoint>;
145 
146  /**
147  * Sweep/reap the object if still stale
148  */
149  void sweep(void);
150 
151  /**
152  * HW configuration for the result of creating the endpoint
153  */
154  HW::item<bool> m_hw;
155 
156  /**
157  * The interface the endpoint is attached to.
158  */
159  std::shared_ptr<interface> m_itf;
160 
161  /**
162  * The IP address of the endpoint
163  */
165 
166  /**
167  * The MAC address of the endpoint
168  */
169  mac_address_t m_mac;
170 
171  /**
172  * The EPG the endpoint is in
173  */
174  std::shared_ptr<gbp_endpoint_group> m_epg;
175 
176  /**
177  * A map of all bridge_domains
178  */
180 };
181 
182 std::ostream& operator<<(std::ostream& os, const gbp_endpoint::key_t& key);
183 }; // namespace
184 
185 /*
186  * fd.io coding-style-patch-verification: ON
187  *
188  * Local Variables:
189  * eval: (c-set-style "mozilla")
190  * End:
191  */
192 
193 #endif
std::pair< interface::key_t, boost::asio::ip::address > key_t
The key for a GBP endpoint; interface and IP.
const key_t key() const
Return the object&#39;s key.
typedef address
Definition: ip_types.api:35
const std::string key_t
In the opflex world each entity is known by a URI which can be converted into a string.
Definition: client_db.hpp:51
std::shared_ptr< gbp_endpoint > singular() const
Return the matching &#39;singular instance&#39;.
~gbp_endpoint()
Destructor.
gbp_endpoint(const interface &itf, const boost::asio::ip::address &ip_addr, const mac_address_t &mac, const gbp_endpoint_group &epg)
Construct a GBP endpoint.
A GBP Enpoint (i.e.
A Database to store the unique &#39;singular&#39; instances of a single object type.
Definition: singular_db.hpp:33
static void dump(std::ostream &os)
Dump all bridge_domain-doamin into the stream provided.
A representation of an interface in VPP.
Definition: interface.hpp:41
A entry in the ARP termination table of a Bridge Domain.
Class definition for listeners to OM events.
Definition: om.hpp:284
inspect command handler Handler
Definition: inspect.hpp:54
void event_handler(void *tls_async)
Definition: tls_async.c:311
dependency_t
There needs to be a strict order in which object types are read from VPP (at boot time) and replayed ...
Definition: types.hpp:43
The interface to writing objects into VPP OM.
Definition: om.hpp:140
void replay(void)
replay the object to create it in hardware
A base class for all object_base in the VPP object_base-Model.
Definition: object_base.hpp:29
std::string to_string() const
Convert to string for debugging.
std::ostream & operator<<(std::ostream &os, const std::pair< direction_t, interface::key_t > &key)
The VPP Object Model (VOM) library.
Definition: acl_binding.cpp:19
static std::shared_ptr< gbp_endpoint > find(const key_t &k)
Find the instnace of the bridge_domain domain in the OM.
void show(char *chroot_path, int verbose)
Definition: svmtool.c:105
bool operator==(const gbp_endpoint &bdae) const
comparison operator
Type def of a Ethernet address.
Definition: types.hpp:290