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:
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_IP_PUNT_REDIRECT_H__
17 #define __VOM_IP_PUNT_REDIRECT_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 IP punt_redirect configuration on an interface
30 class ip_punt_redirect : public object_base
34 * Construct a new object matching the desried state
36 * @param rx_itf - The interface from where the punt traffic should come.
37 * @param tx_itf - The interface to which traffic should be redirected.
38 * @param addr - The next hop ip address to redirect the traffic.
40 ip_punt_redirect(const interface& rx_itf,
41 const interface& tx_itf,
42 const boost::asio::ip::address& addr);
45 * Construct a new object matching the desried state
47 * @param tx_itf - The interface to which traffic should be redirected.
48 * @param addr - The next hop ip address to redirect the traffic.
50 ip_punt_redirect(const interface& tx_itf,
51 const boost::asio::ip::address& addr);
56 ip_punt_redirect(const ip_punt_redirect& o);
64 * Return the 'singular instance' of the ip_punt_redirect that matches this
67 std::shared_ptr<ip_punt_redirect> singular() const;
70 * convert to string format for debug purposes
72 std::string to_string() const;
75 * Dump all ip_punt_redirects into the stream provided
77 static void dump(std::ostream& os);
80 * The key type for ip_punt_redirects
82 typedef interface::key_t key_t;
85 * return the object's key
87 const key_t key() const;
90 * Find an singular instance in the DB for the interface passed
92 static std::shared_ptr<ip_punt_redirect> find(const interface& i);
96 * Class definition for listeners to OM events
98 class event_handler : public OM::listener, public inspect::command_handler
102 virtual ~event_handler() = default;
105 * Handle a populate event
107 void handle_populate(const client_db::key_t& key);
110 * Handle a replay event
112 void handle_replay();
115 * Show the object in the Singular DB
117 void show(std::ostream& os);
120 * Get the sortable Id of the listener
122 dependency_t order() const;
126 * event_handler to register with OM
128 static event_handler m_evh;
131 * Enquue commonds to the VPP command Q for the update
133 void update(const ip_punt_redirect& obj);
136 * Find or add the singular instance in the DB
138 static std::shared_ptr<ip_punt_redirect> find_or_add(
139 const ip_punt_redirect& temp);
142 * It's the VPPHW class that updates the objects in HW
147 * It's the singular_db class that calls replay
149 friend class singular_db<key_t, ip_punt_redirect>;
152 * Sweep/reap the object if still stale
157 * replay the object to create it in hardware
162 * A reference counting pointer the interface that requires an address.
164 const std::shared_ptr<interface> m_rx_itf;
166 * A reference counting pointer the interface that has an address.
168 const std::shared_ptr<interface> m_tx_itf;
171 * host Ip Prefix to redirect traffic to
173 const boost::asio::ip::address m_addr;
176 * HW configuration for the binding. The bool representing the
179 HW::item<bool> m_config;
182 * A map of all ip punt redirect keyed against a combination of the interface.
184 static singular_db<key_t, ip_punt_redirect> m_db;
189 * fd.io coding-style-patch-verification: ON
192 * eval: (c-set-style "mozilla")