ligang/vpp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

vom: Add ip punt redirect

Browse Source 
Change-Id: I5c7b925b22b53f18b0c45374883a6a4bff580c75
Signed-off-by: Mohsin Kazmi <sykazmi@cisco.com>
This commit is contained in:
Mohsin Kazmi
2018-09-25 18:26:52 +02:00
committed by Neale Ranns
parent 84f36cb096
commit e23edac38e
6 changed files with 647 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
extras/vom/vom/CMakeLists.txt
View File

@ -112,6 +112,8 @@ list(APPEND VOM_SOURCES
interface_span_cmds.cpp
interface_span.cpp
interface_types.cpp
ip_punt_redirect_cmds.cpp
ip_punt_redirect.cpp
ip_unnumbered_cmds.cpp
ip_unnumbered.cpp
l2_binding_cmds.cpp
@ -202,6 +204,7 @@ list(APPEND VOM_HEADERS
interface_cmds.hpp
interface_ip6_nd.hpp
interface_span.hpp
ip_punt_redirect.hpp
ip_unnumbered.hpp
l2_binding.hpp
l2_xconnect.hpp

147
extras/vom/vom/ip_punt_redirect.cpp Normal file
View File

@ -0,0 +1,147 @@
/*
* Copyright (c) 2018 Cisco and/or its affiliates.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#include "vom/ip_punt_redirect.hpp"
#include "vom/ip_punt_redirect_cmds.hpp"
#include "vom/singular_db_funcs.hpp"
namespace VOM {
/**
* A DB of all IP Punt configs
*/
singular_db<ip_punt_redirect::key_t, ip_punt_redirect> ip_punt_redirect::m_db;
ip_punt_redirect::event_handler ip_punt_redirect::m_evh;
ip_punt_redirect::ip_punt_redirect(const interface& rx_itf,
const interface& tx_itf,
const boost::asio::ip::address& addr)
: m_rx_itf(rx_itf.singular())
, m_tx_itf(tx_itf.singular())
, m_addr(addr)
{
}
ip_punt_redirect::ip_punt_redirect(const ip_punt_redirect& o)
: m_rx_itf(o.m_rx_itf)
, m_tx_itf(o.m_tx_itf)
, m_addr(o.m_addr)
, m_config(o.m_config)
{
}
ip_punt_redirect::~ip_punt_redirect()
{
sweep();
// not in the DB anymore.
m_db.release(m_rx_itf->key(), this);
}
void
ip_punt_redirect::sweep()
{
if (m_config) {
HW::enqueue(new ip_punt_redirect_cmds::unconfig_cmd(
m_config, m_rx_itf->handle(), m_tx_itf->handle(), m_addr));
}
HW::write();
}
void
ip_punt_redirect::dump(std::ostream& os)
{
db_dump(m_db, os);
}
void
ip_punt_redirect::replay()
{
if (m_config) {
HW::enqueue(new ip_punt_redirect_cmds::config_cmd(
m_config, m_rx_itf->handle(), m_tx_itf->handle(), m_addr));
}
}
std::string
ip_punt_redirect::to_string() const
{
std::ostringstream s;
s << "IP-punt-redirect-config:"
<< " rx-itf:" << m_rx_itf->to_string()
<< " tx-itf:" << m_tx_itf->to_string() << " next-hop:" << m_addr;
return (s.str());
}
void
ip_punt_redirect::update(const ip_punt_redirect& desired)
{
if (!m_config) {
HW::enqueue(new ip_punt_redirect_cmds::config_cmd(
m_config, m_rx_itf->handle(), m_tx_itf->handle(), m_addr));
}
}
std::shared_ptr<ip_punt_redirect>
ip_punt_redirect::find_or_add(const ip_punt_redirect& temp)
{
return (m_db.find_or_add(temp.m_rx_itf->key(), temp));
}
std::shared_ptr<ip_punt_redirect>
ip_punt_redirect::singular() const
{
return find_or_add(*this);
}
ip_punt_redirect::event_handler::event_handler()
{
OM::register_listener(this);
inspect::register_handler({ "ip-punt-redirect" },
"IP punt redirect configurations", this);
}
void
ip_punt_redirect::event_handler::handle_replay()
{
m_db.replay();
}
void
ip_punt_redirect::event_handler::handle_populate(const client_db::key_t& key)
{
}
dependency_t
ip_punt_redirect::event_handler::order() const
{
return (dependency_t::BINDING);
}
void
ip_punt_redirect::event_handler::show(std::ostream& os)
{
db_dump(m_db, os);
}
}
/*
* fd.io coding-style-patch-verification: ON
*
* Local Variables:
* eval: (c-set-style "mozilla")
* End:
*/

182
extras/vom/vom/ip_punt_redirect.hpp Normal file
View File

@ -0,0 +1,182 @@
/*
* Copyright (c) 2018 Cisco and/or its affiliates.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef __VOM_IP_PUNT_REDIRECT_H__
#define __VOM_IP_PUNT_REDIRECT_H__
#include "vom/hw.hpp"
#include "vom/inspect.hpp"
#include "vom/interface.hpp"
#include "vom/object_base.hpp"
#include "vom/om.hpp"
#include "vom/singular_db.hpp"
namespace VOM {
/**
* A representation of IP punt_redirect configuration on an interface
*/
class ip_punt_redirect : public object_base
{
public:
/**
* Construct a new object matching the desried state
*
* @param rx_itf - The interface from where the punt traffic should come.
* @param tx_itf - The interface to which traffic should be redirected.
* @param addr - The next hop ip address to redirect the traffic.
*/
ip_punt_redirect(const interface& rx_itf,
const interface& tx_itf,
const boost::asio::ip::address& addr);
/**
* Copy Constructor
*/
ip_punt_redirect(const ip_punt_redirect& o);
/**
* Destructor
*/
~ip_punt_redirect();
/**
* Return the 'singular instance' of the ip_punt_redirect that matches this
* object
*/
std::shared_ptr<ip_punt_redirect> singular() const;
/**
* convert to string format for debug purposes
*/
std::string to_string() const;
/**
* Dump all ip_punt_redirects into the stream provided
*/
static void dump(std::ostream& os);
/**
* The key type for ip_punt_redirects
*/
typedef interface::key_t key_t;
/**
* Find an singular instance in the DB for the interface passed
*/
static std::shared_ptr<ip_punt_redirect> find(const interface& i);
private:
/**
* Class definition for listeners to OM events
*/
class event_handler : public OM::listener, public inspect::command_handler
{
public:
event_handler();
virtual ~event_handler() = default;
/**
* Handle a populate event
*/
void handle_populate(const client_db::key_t& key);
/**
* Handle a replay event
*/
void handle_replay();
/**
* Show the object in the Singular DB
*/
void show(std::ostream& os);
/**
* Get the sortable Id of the listener
*/
dependency_t order() const;
};
/**
* event_handler to register with OM
*/
static event_handler m_evh;
/**
* Enquue commonds to the VPP command Q for the update
*/
void update(const ip_punt_redirect& obj);
/**
* Find or add the singular instance in the DB
*/
static std::shared_ptr<ip_punt_redirect> find_or_add(
const ip_punt_redirect& temp);
/*
* It's the VPPHW class that updates the objects in HW
*/
friend class OM;
/**
* It's the singular_db class that calls replay
*/
friend class singular_db<key_t, ip_punt_redirect>;
/**
* Sweep/reap the object if still stale
*/
void sweep(void);
/**
* replay the object to create it in hardware
*/
void replay(void);
/**
* A reference counting pointer the interface that requires an address.
*/
const std::shared_ptr<interface> m_rx_itf;
/**
* A reference counting pointer the interface that has an address.
*/
const std::shared_ptr<interface> m_tx_itf;
/**
* host Ip Prefix to redirect traffic to
*/
const boost::asio::ip::address m_addr;
/**
* HW configuration for the binding. The bool representing the
* do/don't bind.
*/
HW::item<bool> m_config;
/**
* A map of all ip punt redirect keyed against a combination of the interface.
*/
static singular_db<key_t, ip_punt_redirect> m_db;
};
};
/*
* fd.io coding-style-patch-verification: ON
*
* Local Variables:
* eval: (c-set-style "mozilla")
* End:
*/
#endif

127
extras/vom/vom/ip_punt_redirect_cmds.cpp Normal file
View File

@ -0,0 +1,127 @@
/*
* Copyright (c) 2018 Cisco and/or its affiliates.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#include "vom/ip_punt_redirect_cmds.hpp"
namespace VOM {
namespace ip_punt_redirect_cmds {
config_cmd::config_cmd(HW::item<bool>& item,
const handle_t& rx_itf,
const handle_t& tx_itf,
const boost::asio::ip::address& addr)
: rpc_cmd(item)
, m_rx_itf(rx_itf)
, m_tx_itf(tx_itf)
, m_addr(addr)
{
}
bool
config_cmd::operator==(const config_cmd& o) const
{
return ((m_rx_itf == o.m_rx_itf) && (m_tx_itf == o.m_tx_itf) &&
(m_addr == o.m_addr));
}
rc_t
config_cmd::issue(connection& con)
{
msg_t req(con.ctx(), std::ref(*this));
auto& payload = req.get_request().get_payload();
payload.is_add = 1;
payload.rx_sw_if_index = m_rx_itf.value();
payload.tx_sw_if_index = m_tx_itf.value();
to_bytes(m_addr, &payload.is_ip6, payload.nh);
VAPI_CALL(req.execute());
return (wait());
}
std::string
config_cmd::to_string() const
{
std::ostringstream s;
s << "IP-punt-redirect-config: " << m_hw_item.to_string()
<< " rx-itf:" << m_rx_itf.to_string() << " tx-itf:" << m_tx_itf.to_string()
<< " next-hop:" << m_addr;
return (s.str());
}
unconfig_cmd::unconfig_cmd(HW::item<bool>& item,
const handle_t& rx_itf,
const handle_t& tx_itf,
const boost::asio::ip::address& addr)
: rpc_cmd(item)
, m_rx_itf(rx_itf)
, m_tx_itf(tx_itf)
, m_addr(addr)
{
}
bool
unconfig_cmd::operator==(const unconfig_cmd& o) const
{
return ((m_rx_itf == o.m_rx_itf) && (m_tx_itf == o.m_tx_itf) &&
(m_addr == o.m_addr));
}
rc_t
unconfig_cmd::issue(connection& con)
{
msg_t req(con.ctx(), std::ref(*this));
auto& payload = req.get_request().get_payload();
payload.is_add = 0;
payload.rx_sw_if_index = m_rx_itf.value();
payload.tx_sw_if_index = m_tx_itf.value();
to_bytes(m_addr, &payload.is_ip6, payload.nh);
VAPI_CALL(req.execute());
wait();
m_hw_item.set(rc_t::NOOP);
return rc_t::OK;
}
std::string
unconfig_cmd::to_string() const
{
std::ostringstream s;
s << "IP-punt-redirect-unconfig: " << m_hw_item.to_string()
<< " rx-itf:" << m_rx_itf.to_string() << " tx-itf:" << m_tx_itf.to_string()
<< " next-hop:" << m_addr.to_string();
return (s.str());
}
}; // namespace ip_punt_redirect_cmds
}; // namespace VOM
/*
* fd.io coding-style-patch-verification: ON
*
* Local Variables:
* eval: (c-set-style "mozilla")
* End:
*/

126
extras/vom/vom/ip_punt_redirect_cmds.hpp Normal file
View File

@ -0,0 +1,126 @@
/*
* Copyright (c) 2018 Cisco and/or its affiliates.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef __VOM_IP_PUNT_REDIRECT_CMDS_H__
#define __VOM_IP_PUNT_REDIRECT_CMDS_H__
#include "vom/ip_punt_redirect.hpp"
#include "vom/rpc_cmd.hpp"
#include <vapi/ip.api.vapi.hpp>
namespace VOM {
namespace ip_punt_redirect_cmds {
/**
*A command class that configures the IP punt_redirect
*/
class config_cmd : public rpc_cmd<HW::item<bool>, vapi::Ip_punt_redirect>
{
public:
/**
* Constructor
*/
config_cmd(HW::item<bool>& item,
const handle_t& rx_itf,
const handle_t& tx_itf,
const boost::asio::ip::address& addr);
/**
* Issue the command to VPP/HW
*/
rc_t issue(connection& con);
/**
* convert to string format for debug purposes
*/
std::string to_string() const;
/**
* Comparison operator - only used for UT
*/
bool operator==(const config_cmd& i) const;
private:
/**
* Reference to the interface from which traffic is coming
*/
const handle_t& m_rx_itf;
/**
* Reference to the interface where traffic will be redirected
*/
const handle_t& m_tx_itf;
/**
* Reference to nexh hop ip address
*/
const boost::asio::ip::address& m_addr;
};
/**
* A cmd class that Unconfigs Ip punt redirect
*/
class unconfig_cmd : public rpc_cmd<HW::item<bool>, vapi::Ip_punt_redirect>
{
public:
/**
* Constructor
*/
unconfig_cmd(HW::item<bool>& item,
const handle_t& rx_itf,
const handle_t& tx_itf,
const boost::asio::ip::address& addr);
/**
* Issue the command to VPP/HW
*/
rc_t issue(connection& con);
/**
* convert to string format for debug purposes
*/
std::string to_string() const;
/**
* Comparison operator - only used for UT
*/
bool operator==(const unconfig_cmd& i) const;
private:
/**
* Reference to the interface from which traffic is coming
*/
const handle_t& m_rx_itf;
/**
* Reference to the interface where traffic will be redirected
*/
const handle_t& m_tx_itf;
/**
* Reference to nexh hop ip address
*/
const boost::asio::ip::address& m_addr;
};
}; // namespace ip_punt_redirect_cmds
}; // namespace VOM
/*
* fd.io coding-style-patch-verification: ON
*
* Local Variables:
* eval: (c-set-style "mozilla")
* End:
*/
#endif

62
test/ext/vom_test.cpp
View File

@ -56,6 +56,8 @@
#include "vom/arp_proxy_binding.hpp"
#include "vom/arp_proxy_config_cmds.hpp"
#include "vom/arp_proxy_binding_cmds.hpp"
#include "vom/ip_punt_redirect.hpp"
#include "vom/ip_punt_redirect_cmds.hpp"
#include "vom/ip_unnumbered.hpp"
#include "vom/ip_unnumbered_cmds.hpp"
#include "vom/interface_ip6_nd.hpp"
@ -377,6 +379,14 @@ public:
{
rc = handle_derived<arp_proxy_config_cmds::unconfig_cmd>(f_exp, f_act);
}
else if (typeid(*f_exp) == typeid(ip_punt_redirect_cmds::config_cmd))
{
rc = handle_derived<ip_punt_redirect_cmds::config_cmd>(f_exp, f_act);
}
else if (typeid(*f_exp) == typeid(ip_punt_redirect_cmds::unconfig_cmd))
{
rc = handle_derived<ip_punt_redirect_cmds::unconfig_cmd>(f_exp, f_act);
}
else if (typeid(*f_exp) == typeid(ip_unnumbered_cmds::config_cmd))
{
rc = handle_derived<ip_unnumbered_cmds::config_cmd>(f_exp, f_act);
@ -1329,6 +1339,58 @@ BOOST_AUTO_TEST_CASE(test_arp_proxy) {
TRY_CHECK(OM::remove(kurt));
}
BOOST_AUTO_TEST_CASE(test_ip_punt_redirect) {
VppInit vi;
const std::string eliot = "EliotReed";
rc_t rc = rc_t::OK;
/*
* Interface 1 is the tx interface
*/
std::string itf1_name = "tx-itf";
interface itf1(itf1_name,
interface::type_t::AFPACKET,
interface::admin_state_t::UP);
HW::item<handle_t> hw_ifh(2, rc_t::OK);
HW::item<interface::admin_state_t> hw_as_up(interface::admin_state_t::UP, rc_t::OK);
ADD_EXPECT(interface_cmds::af_packet_create_cmd(hw_ifh, itf1_name));
ADD_EXPECT(interface_cmds::state_change_cmd(hw_as_up, hw_ifh));
TRY_CHECK_RC(OM::write(eliot, itf1));
boost::asio::ip::address addr = boost::asio::ip::address::from_string("192.168.0.20");
/*
* Interface 2 is the rx interface
*/
std::string itf2_name = "rx-itf";
interface itf2(itf2_name,
interface::type_t::AFPACKET,
interface::admin_state_t::UP);
HW::item<handle_t> hw_ifh2(4, rc_t::OK);
ADD_EXPECT(interface_cmds::af_packet_create_cmd(hw_ifh2, itf2_name));
ADD_EXPECT(interface_cmds::state_change_cmd(hw_as_up, hw_ifh2));
TRY_CHECK_RC(OM::write(eliot, itf2));
ip_punt_redirect *ip_punt = new ip_punt_redirect(itf2, itf1, addr);
HW::item<bool> hw_ip_cfg(true, rc_t::OK);
HW::item<bool> hw_ip_uncfg(false, rc_t::OK);
ADD_EXPECT(ip_punt_redirect_cmds::config_cmd(hw_ip_cfg, hw_ifh2.data(), hw_ifh.data(), addr));
TRY_CHECK_RC(OM::write(eliot, *ip_punt));
delete ip_punt;
HW::item<interface::admin_state_t> hw_as_down(interface::admin_state_t::DOWN, rc_t::OK);
STRICT_ORDER_OFF();
ADD_EXPECT(ip_punt_redirect_cmds::unconfig_cmd(hw_ip_uncfg, hw_ifh2.data(), hw_ifh.data(), addr));
ADD_EXPECT(interface_cmds::state_change_cmd(hw_as_down, hw_ifh));
ADD_EXPECT(interface_cmds::af_packet_delete_cmd(hw_ifh, itf1_name));
ADD_EXPECT(interface_cmds::state_change_cmd(hw_as_down, hw_ifh2));
ADD_EXPECT(interface_cmds::af_packet_delete_cmd(hw_ifh2, itf2_name));
TRY_CHECK(OM::remove(eliot));
}
BOOST_AUTO_TEST_CASE(test_ip_unnumbered) {
VppInit vi;
const std::string eric = "EricAmbler";