FD.io VPP  v18.10-34-gcce845e
Vector Packet Processing
bridge_domain_arp_entry_cmds.cpp
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 
17 
18 namespace VOM {
19 namespace bridge_domain_arp_entry_cmds {
20 
22  uint32_t bd,
23  const mac_address_t& mac,
24  const boost::asio::ip::address& ip_addr)
25  : rpc_cmd(item)
26  , m_bd(bd)
27  , m_mac(mac)
28  , m_ip_addr(ip_addr)
29 {
30 }
31 
32 bool
34 {
35  return ((m_mac == other.m_mac) && (m_ip_addr == other.m_ip_addr) &&
36  (m_bd == other.m_bd));
37 }
38 
39 rc_t
41 {
42  msg_t req(con.ctx(), std::ref(*this));
43 
44  auto& payload = req.get_request().get_payload();
45  payload.bd_id = m_bd;
46  payload.is_add = 1;
47  m_mac.to_bytes(payload.mac_address, 6);
48  to_bytes(m_ip_addr, &payload.is_ipv6, payload.ip_address);
49 
50  VAPI_CALL(req.execute());
51 
52  return (wait());
53 }
54 
55 std::string
57 {
58  std::ostringstream s;
59  s << "bridge-domain-arp-entry-create: " << m_hw_item.to_string()
60  << " bd:" << m_bd << " mac:" << m_mac.to_string()
61  << " ip:" << m_ip_addr.to_string();
62 
63  return (s.str());
64 }
65 
67  uint32_t bd,
68  const mac_address_t& mac,
69  const boost::asio::ip::address& ip_addr)
70  : rpc_cmd(item)
71  , m_bd(bd)
72  , m_mac(mac)
73  , m_ip_addr(ip_addr)
74 {
75 }
76 
77 bool
79 {
80  return ((m_mac == other.m_mac) && (m_ip_addr == other.m_ip_addr) &&
81  (m_bd == other.m_bd));
82 }
83 
84 rc_t
86 {
87  msg_t req(con.ctx(), std::ref(*this));
88 
89  auto& payload = req.get_request().get_payload();
90  payload.bd_id = m_bd;
91  payload.is_add = 0;
92  m_mac.to_bytes(payload.mac_address, 6);
93  to_bytes(m_ip_addr, &payload.is_ipv6, payload.ip_address);
94 
95  VAPI_CALL(req.execute());
96 
97  wait();
99 
100  return rc_t::OK;
101 }
102 
103 std::string
105 {
106  std::ostringstream s;
107  s << "bridge-domain-arp-entry-delete: " << m_hw_item.to_string()
108  << " bd:" << m_bd << " mac:" << m_mac.to_string()
109  << " ip:" << m_ip_addr.to_string();
110 
111  return (s.str());
112 }
113 
114 dump_cmd::dump_cmd(uint32_t bd_id)
115  : m_bd(bd_id)
116 {
117 }
118 
120  : m_bd(d.m_bd)
121 {
122 }
123 
124 bool
125 dump_cmd::operator==(const dump_cmd& other) const
126 {
127  return (true);
128 }
129 
130 rc_t
132 {
133  m_dump.reset(new msg_t(con.ctx(), std::ref(*this)));
134 
135  auto& payload = m_dump->get_request().get_payload();
136  payload.bd_id = m_bd;
137 
138  VAPI_CALL(m_dump->execute());
139 
140  wait();
141 
142  return rc_t::OK;
143 }
144 
145 std::string
147 {
148  return ("bridge-domain-arp-entry-dump");
149 }
150 
151 }; // namespace bridge_domain_arp_entry
152 }; // namespace VOM
153 
154 /*
155  * fd.io coding-style-patch-verification: ON
156  *
157  * Local Variables:
158  * eval: (c-set-style "mozilla")
159  * End:
160  */
static const rc_t NOOP
The HW write/update action was/has not been attempted.
Definition: types.hpp:99
typedef address
Definition: ip_types.api:35
bool operator==(const create_cmd &i) const
Comparison operator - only used for UT.
std::string to_string() const
convert to string format for debug purposes
std::string to_string() const
String conversion.
Definition: types.cpp:148
Error codes that VPP will return during a HW write.
Definition: types.hpp:84
std::string to_string() const
convert to string format for debug purposes
Definition: hw.hpp:160
rc_t wait()
Wait on the commands promise.
Definition: rpc_cmd.hpp:80
A cmd class that Dumps all arp termination tables.
void to_bytes(const boost::asio::ip::address_v6 &addr, uint8_t *array)
Definition: prefix.cpp:218
A representation of the connection to VPP.
Definition: connection.hpp:33
rc_t issue(connection &con)
Issue the command to VPP/HW.
dump_cmd()
Default Constructor.
Definition: dump_cmd.hpp:55
std::string to_string() const
convert to string format for debug purposes
A base class for all RPC commands to VPP.
Definition: rpc_cmd.hpp:38
#define VAPI_CALL(_stmt)
Convenince wrapper macro for error handling in VAPI sends.
Definition: types.hpp:29
delete_cmd(HW::item< bool > &item, uint32_t id, const mac_address_t &mac, const boost::asio::ip::address &ip_addr)
Constructor.
A cmd class that deletes a bridge domain ARP entry.
static const rc_t OK
The HW write was successfull.
Definition: types.hpp:104
rc_t wait()
Wait for the issue of the command to complete.
Definition: dump_cmd.hpp:93
vapi::Connection & ctx()
Retrun the VAPI context the commands will use.
Definition: connection.cpp:49
void to_bytes(uint8_t *array, uint8_t len) const
Convert to byte array.
Definition: types.cpp:140
The VPP Object Model (VOM) library.
Definition: acl_binding.cpp:19
rc_t issue(connection &con)
Issue the command to VPP/HW.
bool operator==(const dump_cmd &i) const
Comparison operator - only used for UT.
create_cmd(HW::item< bool > &item, uint32_t id, const mac_address_t &mac, const boost::asio::ip::address &ip_addr)
Constructor.
void set(const rc_t &rc)
Set the HW return code - should only be called from the family of Command objects.
Definition: hw.hpp:124
std::unique_ptr< vapi::Bd_ip_mac_dump > m_dump
The VAPI event registration.
Definition: dump_cmd.hpp:143
rc_t issue(connection &con)
Issue the command to VPP/HW.
Type def of a Ethernet address.
Definition: types.hpp:290
A command class that creates or updates the bridge domain ARP Entry.
bool operator==(const delete_cmd &i) const
Comparison operator - only used for UT.
vl_api_mac_address_t mac
Definition: gbp.api:31
HW::item< bool > & m_hw_item
A reference to an object&#39;s HW::item that the command will update.
Definition: rpc_cmd.hpp:132
HW::item< bool > & item()
return the HW item the command updates
Definition: rpc_cmd.hpp:64
vapi::Bd_ip_mac_add_del msg_t
convenient typedef
Definition: rpc_cmd.hpp:44
std::string to_string() const
convert to string format for debug purposes