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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
16 #ifndef __VOM_L3_BINDING_H__
17 #define __VOM_L3_BINDING_H__
20 #include "vom/inspect.hpp"
21 #include "vom/interface.hpp"
22 #include "vom/object_base.hpp"
24 #include "vom/singular_db.hpp"
28 * A representation of L3 configuration on an interface
30 class l3_binding : public object_base
34 * The key type for l3_bindings
36 typedef std::pair<interface::key_t, route::prefix_t> key_t;
39 * Construct a new object matching the desried state
41 l3_binding(const interface& itf, const route::prefix_t& pfx);
46 l3_binding(const l3_binding& o);
56 bool operator==(const l3_binding& l) const;
59 * Get the object's key
61 const key_t key() const;
66 typedef singular_db<key_t, l3_binding>::const_iterator const_iterator_t;
68 static const_iterator_t cbegin();
69 static const_iterator_t cend();
72 * Return the 'singular instance' of the L3-Config that matches this
75 std::shared_ptr<l3_binding> singular() const;
78 * convert to string format for debug purposes
80 std::string to_string() const;
83 * Return the prefix associated with this L3 binding
85 const route::prefix_t& prefix() const;
88 * Return the interface associated with this L3 binding
90 const interface& itf() const;
93 * Dump all l3_bindings into the stream provided
95 static void dump(std::ostream& os);
98 * Find a binding from its key
100 static std::shared_ptr<l3_binding> find(const key_t& k);
104 * Class definition for listeners to OM events
106 class event_handler : public OM::listener, public inspect::command_handler
110 virtual ~event_handler() = default;
113 * Handle a populate event
115 void handle_populate(const client_db::key_t& key);
118 * Handle a replay event
120 void handle_replay();
123 * Show the object in the Singular DB
125 void show(std::ostream& os);
128 * Get the sortable Id of the listener
130 dependency_t order() const;
134 * event_handler to register with OM
136 static event_handler m_evh;
139 * Enquue commonds to the VPP command Q for the update
141 void update(const l3_binding& obj);
144 * Find or add the singular instance in the DB
146 static std::shared_ptr<l3_binding> find_or_add(const l3_binding& temp);
149 * It's the VPPHW class that updates the objects in HW
154 e* It's the singular_db class that calls replay()
156 friend class singular_db<key_t, l3_binding>;
159 * Sweep/reap the object if still stale
164 * replay the object to create it in hardware
168 friend class interface;
171 * A reference counting pointer the interface that this L3 layer
172 * represents. By holding the reference here, we can guarantee that
173 * this object will outlive the interface
175 const std::shared_ptr<interface> m_itf;
178 * The prefix for this L3 configuration
180 const route::prefix_t m_pfx;
183 * HW configuration for the binding. The bool representing the
186 HW::item<bool> m_binding;
189 * A map of all L3 configs keyed against a combination of the interface
192 static singular_db<key_t, l3_binding> m_db;
196 * Ostream output for the key
198 std::ostream& operator<<(std::ostream& os, const l3_binding::key_t& key);
202 * fd.io coding-style-patch-verification: ON
205 * eval: (c-set-style "mozilla")