FD.io VPP  v21.06-3-gbb25fbf28
Vector Packet Processing
ip_unnumbered_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 #include <vapi/vpe.api.vapi.hpp>
19 
20 namespace VOM {
21 namespace ip_unnumbered_cmds {
22 
24  const handle_t& itf,
25  const handle_t& l3_itf)
26  : rpc_cmd(item)
27  , m_itf(itf)
28  , m_l3_itf(l3_itf)
29 {
30 }
31 
32 bool
34 {
35  return ((m_itf == o.m_itf) && (m_l3_itf == o.m_l3_itf));
36 }
37 
38 rc_t
40 {
41  msg_t req(con.ctx(), std::ref(*this));
42 
43  auto& payload = req.get_request().get_payload();
44  payload.is_add = 1;
45  payload.sw_if_index = m_l3_itf.value();
46  payload.unnumbered_sw_if_index = m_itf.value();
47 
48  VAPI_CALL(req.execute());
49 
50  return (wait());
51 }
52 
55 {
56  std::ostringstream s;
57  s << "IP-unnumberd-config: " << m_hw_item.to_string()
58  << " itf:" << m_itf.to_string() << " l3-itf:" << m_l3_itf.to_string();
59 
60  return (s.str());
61 }
62 
64  const handle_t& itf,
65  const handle_t& l3_itf)
66  : rpc_cmd(item)
67  , m_itf(itf)
68  , m_l3_itf(l3_itf)
69 {
70 }
71 
72 bool
74 {
75  return ((m_itf == o.m_itf) && (m_l3_itf == o.m_l3_itf));
76 }
77 
78 rc_t
80 {
81  msg_t req(con.ctx(), std::ref(*this));
82 
83  auto& payload = req.get_request().get_payload();
84  payload.is_add = 0;
85  payload.sw_if_index = m_l3_itf.value();
86  payload.unnumbered_sw_if_index = m_itf.value();
87 
88  VAPI_CALL(req.execute());
89 
90  wait();
92 
93  return rc_t::OK;
94 }
95 
98 {
99  std::ostringstream s;
100  s << "IP-unnumberd-unconfig: " << m_hw_item.to_string()
101  << " itf:" << m_itf.to_string() << " l3-itf:" << m_l3_itf.to_string();
102 
103  return (s.str());
104 }
105 
106 bool
107 dump_cmd::operator==(const dump_cmd& other) const
108 {
109  return (true);
110 }
111 
112 rc_t
114 {
115  m_dump.reset(new msg_t(con.ctx(), std::ref(*this)));
116 
117  auto& payload = m_dump->get_request().get_payload();
118  payload.sw_if_index = ~0;
119 
120  VAPI_CALL(m_dump->execute());
121 
122  wait();
123 
124  return rc_t::OK;
125 }
126 
129 {
130  return ("ip-unnumbered-dump");
131 }
132 
133 }; // namespace ip_unnumbered_cmds
134 }; // namespace VOM
135 
136 /*
137  * fd.io coding-style-patch-verification: OFF
138  *
139  * Local Variables:
140  * eval: (c-set-style "mozilla")
141  * End:
142  */
VOM::ip_unnumbered_cmds::config_cmd::to_string
std::string to_string() const
convert to string format for debug purposes
Definition: ip_unnumbered_cmds.cpp:54
VOM::HW::item< bool >
VOM::ip_unnumbered_cmds::unconfig_cmd
A cmd class that Unconfigs L3 Config from an interface.
Definition: ip_unnumbered_cmds.hpp:69
VOM::dump_cmd< vapi::Ip_unnumbered_dump >::msg_t
vapi::Ip_unnumbered_dump msg_t
Definition: dump_cmd.hpp:46
VOM::rpc_cmd< HW::item< bool >, vapi::Sw_interface_set_unnumbered >::wait
rc_t wait()
Wait on the commands promise.
Definition: rpc_cmd.hpp:82
VOM::HW::item::set
void set(const rc_t &rc)
Set the HW return code - should only be called from the family of Command objects.
Definition: hw.hpp:125
VOM
The VPP Object Model (VOM) library.
Definition: acl_binding.cpp:19
VOM::rc_t::OK
const static rc_t OK
The HW write was successfull.
Definition: types.hpp:109
VOM::handle_t::value
uint32_t value() const
get the value of the handle
Definition: types.cpp:93
VOM::rpc_cmd
A base class for all RPC commands to VPP.
Definition: rpc_cmd.hpp:40
VOM::ip_unnumbered_cmds::dump_cmd::issue
rc_t issue(connection &con)
Issue the command to VPP/HW.
Definition: ip_unnumbered_cmds.cpp:113
con
Connection con
Definition: vapi_cpp_test.cpp:56
VOM::ip_unnumbered_cmds::unconfig_cmd::issue
rc_t issue(connection &con)
Issue the command to VPP/HW.
Definition: ip_unnumbered_cmds.cpp:79
VOM::rpc_cmd< HW::item< bool >, vapi::Sw_interface_set_unnumbered >::m_hw_item
HW::item< bool > & m_hw_item
A reference to an object's HW::item that the command will update.
Definition: rpc_cmd.hpp:134
VOM::dump_cmd< vapi::Ip_unnumbered_dump >::m_dump
std::unique_ptr< vapi::Ip_unnumbered_dump > m_dump
The VAPI event registration.
Definition: dump_cmd.hpp:143
VOM::ip_unnumbered_cmds::dump_cmd
A cmd class that Dumps all the IP unnumbered interfaces.
Definition: ip_unnumbered_cmds.hpp:108
VOM::ip_unnumbered_cmds::unconfig_cmd::operator==
bool operator==(const unconfig_cmd &i) const
Comparison operator - only used for UT.
Definition: ip_unnumbered_cmds.cpp:73
VAPI_CALL
#define VAPI_CALL(_stmt)
Convenince wrapper macro for error handling in VAPI sends.
Definition: types.hpp:29
VOM::ip_unnumbered_cmds::config_cmd::operator==
bool operator==(const config_cmd &i) const
Comparison operator - only used for UT.
Definition: ip_unnumbered_cmds.cpp:33
VOM::ip_unnumbered_cmds::config_cmd::config_cmd
config_cmd(HW::item< bool > &item, const handle_t &itf, const handle_t &l3_itf)
Constructor.
Definition: ip_unnumbered_cmds.cpp:23
VOM::connection
A representation of the connection to VPP.
Definition: connection.hpp:33
VOM::ip_unnumbered_cmds::unconfig_cmd::to_string
std::string to_string() const
convert to string format for debug purposes
Definition: ip_unnumbered_cmds.cpp:97
VOM::dump_cmd< vapi::Ip_unnumbered_dump >::wait
rc_t wait()
Wait for the issue of the command to complete.
Definition: dump_cmd.hpp:93
VOM::rc_t::NOOP
const static rc_t NOOP
The HW write/update action was/has not been attempted.
Definition: types.hpp:104
VOM::ip_unnumbered_cmds::config_cmd
A command class that configures the IP unnumbered.
Definition: ip_unnumbered_cmds.hpp:32
VOM::handle_t
A type declaration of an interface handle in VPP.
Definition: types.hpp:233
VOM::ip_unnumbered_cmds::dump_cmd::to_string
std::string to_string() const
convert to string format for debug purposes
Definition: ip_unnumbered_cmds.cpp:128
VOM::HW::item::to_string
std::string to_string() const
convert to string format for debug purposes
Definition: hw.hpp:161
VOM::ip_unnumbered_cmds::unconfig_cmd::unconfig_cmd
unconfig_cmd(HW::item< bool > &item, const handle_t &itf, const handle_t &l3_itf)
Constructor.
Definition: ip_unnumbered_cmds.cpp:63
VOM::rpc_cmd< HW::item< bool >, vapi::Sw_interface_set_unnumbered >::msg_t
vapi::Sw_interface_set_unnumbered msg_t
convenient typedef
Definition: rpc_cmd.hpp:46
VOM::handle_t::to_string
std::string to_string() const
convert to string format for debug purposes
Definition: types.cpp:69
ip_unnumbered_cmds.hpp
item
cJSON * item
Definition: cJSON.h:222
VOM::ip_unnumbered_cmds::dump_cmd::operator==
bool operator==(const dump_cmd &i) const
Comparison operator - only used for UT.
Definition: ip_unnumbered_cmds.cpp:107
VOM::rc_t
Error codes that VPP will return during a HW write.
Definition: types.hpp:89
VOM::ip_unnumbered_cmds::config_cmd::issue
rc_t issue(connection &con)
Issue the command to VPP/HW.
Definition: ip_unnumbered_cmds.cpp:39
string
const char *const string
Definition: cJSON.h:172