FD.io VPP  v21.10.1-2-g0a485f517
Vector Packet Processing
gbp_endpoint_group_cmds.cpp
Go to the documentation of this file.
1 /*
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:
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 gbp_endpoint_group_cmds {
20 
22  vnid_t vnid,
23  uint16_t sclass,
24  uint32_t bd_id,
27  const handle_t& itf)
28  : rpc_cmd(item)
29  , m_vnid(vnid)
30  , m_sclass(sclass)
31  , m_bd_id(bd_id)
32  , m_rd_id(rd_id)
33  , m_itf(itf)
34  , m_retention(retention)
35 {
36 }
37 
38 bool
40 {
41  return ((m_itf == other.m_itf) && (m_bd_id == other.m_bd_id) &&
42  (m_rd_id == other.m_rd_id) && (m_vnid == other.m_vnid) &&
43  (m_retention == other.m_retention));
44 }
45 
46 rc_t
48 {
49  msg_t req(con.ctx(), std::ref(*this));
50 
51  auto& payload = req.get_request().get_payload();
52  payload.epg.uplink_sw_if_index = m_itf.value();
53  payload.epg.vnid = m_vnid;
54  payload.epg.sclass = m_sclass;
55  payload.epg.bd_id = m_bd_id;
56  payload.epg.rd_id = m_rd_id;
57  payload.epg.retention.remote_ep_timeout = m_retention.remote_ep_timeout;
58 
59  VAPI_CALL(req.execute());
60 
61  return (wait());
62 }
63 
66 {
67  std::ostringstream s;
68  s << "gbp-endpoint-group-create: " << m_hw_item.to_string()
69  << " vnid:" << m_vnid << " bd-id:" << m_bd_id << " rd-id:" << m_rd_id
70  << " itf:" << m_itf;
71 
72  return (s.str());
73 }
74 
76  : rpc_cmd(item)
77  , m_sclass(sclass)
78 {
79 }
80 
81 bool
83 {
84  return (m_sclass == other.m_sclass);
85 }
86 
87 rc_t
89 {
90  msg_t req(con.ctx(), std::ref(*this));
91 
92  auto& payload = req.get_request().get_payload();
93  payload.sclass = m_sclass;
94 
95  VAPI_CALL(req.execute());
96 
97  return (wait());
98 }
99 
102 {
103  std::ostringstream s;
104  s << "gbp-endpoint-group-delete: " << m_hw_item.to_string()
105  << " sclass:" << m_sclass;
106 
107  return (s.str());
108 }
109 
111 {
112 }
113 
114 bool
115 dump_cmd::operator==(const dump_cmd& other) const
116 {
117  return (true);
118 }
119 
120 rc_t
122 {
123  m_dump.reset(new msg_t(con.ctx(), std::ref(*this)));
124 
125  VAPI_CALL(m_dump->execute());
126 
127  wait();
128 
129  return rc_t::OK;
130 }
131 
134 {
135  return ("gbp-endpoint-group-dump");
136 }
137 
138 }; // namespace gbp_endpoint_group_cmds
139 }; // namespace VOM
140 
141 /*
142  * fd.io coding-style-patch-verification: OFF
143  *
144  * Local Variables:
145  * eval: (c-set-style "mozilla")
146  * End:
147  */
VOM::HW::item< bool >
VOM::dump_cmd< vapi::Gbp_endpoint_group_dump >::msg_t
vapi::Gbp_endpoint_group_dump msg_t
Definition: dump_cmd.hpp:46
VOM::rpc_cmd< HW::item< bool >, vapi::Gbp_endpoint_group_add >::wait
rc_t wait()
Wait on the commands promise.
Definition: rpc_cmd.hpp:82
VOM::gbp_endpoint_group_cmds::delete_cmd::to_string
std::string to_string() const
convert to string format for debug purposes
Definition: gbp_endpoint_group_cmds.cpp:101
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::gbp_endpoint_group_cmds::create_cmd::create_cmd
create_cmd(HW::item< bool > &item, vnid_t vnid, uint16_t sclass, uint32_t bd_id, route::table_id_t rd_id, const gbp_endpoint_group::retention_t &retention, const handle_t &itf)
Constructor.
Definition: gbp_endpoint_group_cmds.cpp:21
VOM::gbp_endpoint_group_cmds::delete_cmd::delete_cmd
delete_cmd(HW::item< bool > &item, sclass_t sclass)
Constructor.
Definition: gbp_endpoint_group_cmds.cpp:75
VOM::handle_t::value
uint32_t value() const
get the value of the handle
Definition: types.cpp:93
VOM::gbp_endpoint_group_cmds::dump_cmd::dump_cmd
dump_cmd()
Constructor.
Definition: gbp_endpoint_group_cmds.cpp:110
VOM::rpc_cmd
A base class for all RPC commands to VPP.
Definition: rpc_cmd.hpp:40
con
Connection con
Definition: vapi_cpp_test.cpp:56
VOM::gbp_endpoint_group_cmds::dump_cmd
A cmd class that Dumps all the GBP endpoint_groups.
Definition: gbp_endpoint_group_cmds.hpp:101
VOM::sclass_t
uint16_t sclass_t
Definition: gbp_types.hpp:27
VOM::rpc_cmd< HW::item< bool >, vapi::Gbp_endpoint_group_add >::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::Gbp_endpoint_group_dump >::m_dump
std::unique_ptr< vapi::Gbp_endpoint_group_dump > m_dump
The VAPI event registration.
Definition: dump_cmd.hpp:143
VOM::gbp_endpoint_group_cmds::create_cmd::to_string
std::string to_string() const
convert to string format for debug purposes
Definition: gbp_endpoint_group_cmds.cpp:65
bd_id
u32 bd_id
Definition: gbp.api:188
VAPI_CALL
#define VAPI_CALL(_stmt)
Convenince wrapper macro for error handling in VAPI sends.
Definition: types.hpp:29
VOM::connection
A representation of the connection to VPP.
Definition: connection.hpp:33
VOM::dump_cmd< vapi::Gbp_endpoint_group_dump >::wait
rc_t wait()
Wait for the issue of the command to complete.
Definition: dump_cmd.hpp:93
VOM::gbp_endpoint_group_cmds::delete_cmd::operator==
bool operator==(const delete_cmd &i) const
Comparison operator - only used for UT.
Definition: gbp_endpoint_group_cmds.cpp:82
retention
vl_api_gbp_endpoint_retention_t retention
Definition: gbp.api:191
VOM::handle_t
A type declaration of an interface handle in VPP.
Definition: types.hpp:233
sclass
u16 sclass
Definition: gbp.api:131
VOM::gbp_endpoint_group::retention_t::remote_ep_timeout
uint32_t remote_ep_timeout
Remote Endpoint timeout/ageing.
Definition: gbp_endpoint_group.hpp:52
VOM::HW::item::to_string
std::string to_string() const
convert to string format for debug purposes
Definition: hw.hpp:161
VOM::rpc_cmd< HW::item< bool >, vapi::Gbp_endpoint_group_add >::msg_t
vapi::Gbp_endpoint_group_add msg_t
convenient typedef
Definition: rpc_cmd.hpp:46
VOM::vnid_t
uint32_t vnid_t
EPG IDs are 32 bit integers.
Definition: gbp_types.hpp:26
rd_id
u32 rd_id
Definition: gbp.api:35
VOM::gbp_endpoint_group_cmds::delete_cmd::issue
rc_t issue(connection &con)
Issue the command to VPP/HW.
Definition: gbp_endpoint_group_cmds.cpp:88
VOM::gbp_endpoint_group::retention_t
Endpoint Retention Policy Settings.
Definition: gbp_endpoint_group.hpp:38
VOM::gbp_endpoint_group_cmds::create_cmd
A command class that creates or updates the GBP endpoint_group.
Definition: gbp_endpoint_group_cmds.hpp:30
gbp_endpoint_group_cmds.hpp
VOM::gbp_endpoint_group_cmds::dump_cmd::to_string
std::string to_string() const
convert to string format for debug purposes
Definition: gbp_endpoint_group_cmds.cpp:133
VOM::gbp_endpoint_group_cmds::dump_cmd::issue
rc_t issue(connection &con)
Issue the command to VPP/HW.
Definition: gbp_endpoint_group_cmds.cpp:121
VOM::gbp_endpoint_group_cmds::create_cmd::operator==
bool operator==(const create_cmd &i) const
Comparison operator - only used for UT.
Definition: gbp_endpoint_group_cmds.cpp:39
VOM::gbp_endpoint_group_cmds::dump_cmd::operator==
bool operator==(const dump_cmd &i) const
Comparison operator - only used for UT.
Definition: gbp_endpoint_group_cmds.cpp:115
item
cJSON * item
Definition: cJSON.h:222
VOM::gbp_endpoint_group_cmds::create_cmd::issue
rc_t issue(connection &con)
Issue the command to VPP/HW.
Definition: gbp_endpoint_group_cmds.cpp:47
VOM::route::table_id_t
uint32_t table_id_t
type def the table-id
Definition: prefix.hpp:121
VOM::rc_t
Error codes that VPP will return during a HW write.
Definition: types.hpp:89
VOM::gbp_endpoint_group_cmds::delete_cmd
A cmd class that deletes a GBP endpoint_group.
Definition: gbp_endpoint_group_cmds.hpp:71
string
const char *const string
Definition: cJSON.h:172