FD.io VPP  v18.01.2-1-g9b554f3
Vector Packet Processing
dhcp_config_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 
16 #include "vom/dhcp_config_cmds.hpp"
17 
19 
20 namespace VOM {
21 namespace dhcp_config_cmds {
22 
24  const handle_t& itf,
25  const std::string& hostname,
26  const l2_address_t& client_id)
27  : rpc_cmd(item)
28  , m_itf(itf)
29  , m_hostname(hostname)
30  , m_client_id(client_id)
31 {
32 }
33 
34 bool
35 bind_cmd::operator==(const bind_cmd& other) const
36 {
37  return ((m_itf == other.m_itf) && (m_hostname == other.m_hostname));
38 }
39 
40 rc_t
42 {
43  msg_t req(con.ctx(), std::ref(*this));
44 
45  auto& payload = req.get_request().get_payload();
46  payload.sw_if_index = m_itf.value();
47  payload.is_add = 1;
48  payload.pid = getpid();
49  payload.want_dhcp_event = 1;
50 
51  memset(payload.hostname, 0, sizeof(payload.hostname));
52  memcpy(payload.hostname, m_hostname.c_str(),
53  std::min(sizeof(payload.hostname), m_hostname.length()));
54 
55  memset(payload.client_id, 0, sizeof(payload.client_id));
56  payload.client_id[0] = 1;
57  std::copy_n(begin(m_client_id.bytes),
58  std::min(sizeof(payload.client_id), m_client_id.bytes.size()),
59  payload.client_id + 1);
60 
61  VAPI_CALL(req.execute());
62 
63  m_hw_item.set(wait());
64 
65  return rc_t::OK;
66 }
67 
68 std::string
70 {
71  std::ostringstream s;
72  s << "Dhcp-config-bind: " << m_hw_item.to_string()
73  << " itf:" << m_itf.to_string() << " hostname:" << m_hostname;
74 
75  return (s.str());
76 }
77 
79  const handle_t& itf,
80  const std::string& hostname)
81  : rpc_cmd(item)
82  , m_itf(itf)
83  , m_hostname(hostname)
84 {
85 }
86 
87 bool
89 {
90  return ((m_itf == other.m_itf) && (m_hostname == other.m_hostname));
91 }
92 
93 rc_t
95 {
96  msg_t req(con.ctx(), std::ref(*this));
97 
98  auto& payload = req.get_request().get_payload();
99  payload.sw_if_index = m_itf.value();
100  payload.is_add = 0;
101  payload.pid = getpid();
102  payload.want_dhcp_event = 0;
103 
104  memcpy(payload.hostname, m_hostname.c_str(),
105  std::min(sizeof(payload.hostname), m_hostname.length()));
106 
107  VAPI_CALL(req.execute());
108 
109  wait();
111 
112  return rc_t::OK;
113 }
114 
115 std::string
117 {
118  std::ostringstream s;
119  s << "Dhcp-config-unbind: " << m_hw_item.to_string()
120  << " itf:" << m_itf.to_string() << " hostname:" << m_hostname;
121 
122  return (s.str());
123 }
124 
126  : event_cmd(el.status())
127  , m_listener(el)
128 {
129 }
130 
131 bool
133 {
134  return (true);
135 }
136 
137 rc_t
139 {
140  /*
141  * Set the call back to handle DHCP complete envets.
142  */
143  m_reg.reset(new reg_t(con.ctx(), std::ref(*this)));
144 
145  /*
146  * return in-progress so the command stays in the pending list.
147  */
148  return (rc_t::OK);
149 }
150 
151 void
153 {
154 }
155 
156 void
158 {
159  m_listener.handle_dhcp_event(this);
160 }
161 
162 std::string
164 {
165  return ("dhcp-events");
166 }
167 }
168 };
169 /*
170  * fd.io coding-style-patch-verification: ON
171  *
172  * Local Variables:
173  * eval: (c-set-style "mozilla")
174  * End:
175  */
static const rc_t NOOP
The HW write/update action was/has not been attempted.
Definition: types.hpp:101
HW::item< bool > & m_hw_item
A reference to an object&#39;s HW::item that the command will update.
Definition: rpc_cmd.hpp:131
unbind_cmd(HW::item< bool > &item, const handle_t &itf, const std::string &hostname)
Constructor.
A command class that binds the DHCP config to the interface.
uint32_t value() const
get the value of the handle
Definition: types.cpp:92
bind_cmd(HW::item< bool > &item, const handle_t &itf, const std::string &hostname, const l2_address_t &client_id)
Constructor.
virtual void handle_dhcp_event(dhcp_config_cmds::events_cmd *cmd)=0
listener&#39;s virtual function invoked when a DHCP event is available to read
rc_t issue(connection &con)
Issue the command to VPP/HW.
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
Type def of a L2 address as read from VPP.
Definition: types.hpp:265
events_cmd(dhcp_config::event_listener &el)
Constructor.
std::string to_string() const
convert to string format for debug purposes
Definition: types.cpp:68
std::string to_string() const
convert to string format for debug purposes
A cmd class that Unbinds Dhcp Config from an interface.
A representation of the connection to VPP.
Definition: connection.hpp:33
rc_t issue(connection &con)
Issue the command to VPP/HW.
std::string to_string() const
convert to string format for debug purposes
HW::item< bool > & item()
return the HW item the command updates
Definition: rpc_cmd.hpp:64
void notify()
called in the VAPI RX thread when data is available.
A base class for all RPC commands to VPP.
Definition: rpc_cmd.hpp:38
bool operator==(const events_cmd &i) const
Comparison operator - only used for UT.
void retire(connection &con)
Retire the command - unsubscribe.
std::vector< uint8_t > bytes
Underlying bytes array - filled from least to most significant.
Definition: types.hpp:309
#define VAPI_CALL(_stmt)
Convenince wrapper macro for error handling in VAPI sends.
Definition: types.hpp:29
A functor class represents our desire to recieve interface events.
std::unique_ptr< vapi::Event_registration< vapi::Dhcp_compl_event > > m_reg
The VAPI event registration.
Definition: event_cmd.hpp:100
A type declaration of an interface handle in VPP.
Definition: types.hpp:164
vapi::Event_registration< vapi::Dhcp_compl_event > reg_t
Definition: event_cmd.hpp:59
static const rc_t OK
The HW write was successfull.
Definition: types.hpp:106
vapi::Connection & ctx()
Retrun the VAPI context the commands will use.
Definition: connection.cpp:51
The VPP Object Model (VOM) library.
Definition: acl_binding.cpp:19
bool operator==(const bind_cmd &i) const
Comparison operator - only used for UT.
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
vapi::Dhcp_client_config msg_t
convenient typedef
Definition: rpc_cmd.hpp:44
An Event command base class.
Definition: event_cmd.hpp:39
std::string to_string() const
convert to string format for debug purposes
rc_t issue(connection &con)
Issue the command to VPP/HW - subscribe to DHCP events.
A class that listens to DHCP Events.
Definition: dhcp_config.hpp:96
DEFINE_VAPI_MSG_IDS_DHCP_API_JSON
bool operator==(const unbind_cmd &i) const
Comparison operator - only used for UT.