FD.io VPP  v21.06-3-gbb25fbf28
Vector Packet Processing
route_domain_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 route_domain_cmds {
20 
24  : rpc_cmd(item)
25  , m_id(id)
26  , m_proto(proto)
27 {
28 }
29 
30 bool
32 {
33  return (m_id == other.m_id);
34 }
35 
36 rc_t
38 {
39  msg_t req(con.ctx(), std::ref(*this));
40 
41  auto& payload = req.get_request().get_payload();
42  payload.table.table_id = m_id;
43  payload.table.is_ip6 = m_proto.is_ipv6();
44  payload.is_add = 1;
45 
46  VAPI_CALL(req.execute());
47 
48  return (wait());
49 }
50 
53 {
54  std::ostringstream s;
55  s << "ip-table-create: " << m_hw_item.to_string() << " id:" << m_id
56  << " af:" << m_proto.to_string();
57 
58  return (s.str());
59 }
60 
64  : rpc_cmd(item)
65  , m_id(id)
66  , m_proto(proto)
67 {
68 }
69 
70 bool
72 {
73  return (m_id == other.m_id);
74 }
75 
76 rc_t
78 {
79  msg_t req(con.ctx(), std::ref(*this));
80 
81  auto& payload = req.get_request().get_payload();
82  payload.table.table_id = m_id;
83  payload.table.is_ip6 = m_proto.is_ipv6();
84  payload.is_add = 0;
85 
86  VAPI_CALL(req.execute());
87 
88  wait();
90 
91  return (rc_t::OK);
92 }
93 
96 {
97  std::ostringstream s;
98  s << "ip-table-delete: " << m_hw_item.to_string() << " id:" << m_id
99  << " af:" << m_proto.to_string();
100 
101  return (s.str());
102 }
103 
105 {
106 }
107 
108 bool
109 dump_cmd::operator==(const dump_cmd& other) const
110 {
111  return (true);
112 }
113 
114 rc_t
116 {
117  m_dump.reset(new msg_t(con.ctx(), std::ref(*this)));
118 
119  VAPI_CALL(m_dump->execute());
120 
121  wait();
122 
123  return rc_t::OK;
124 }
125 
128 {
129  return ("ip-table-dump");
130 }
131 
132 } // namespace route_domain_cmds
133 } // namespace VOM
134  /*
135  * fd.io coding-style-patch-verification: OFF
136  *
137  * Local Variables:
138  * eval: (c-set-style "mozilla")
139  * End:
140  */
VOM::HW::item< bool >
VOM::dump_cmd< vapi::Ip_table_dump >::msg_t
vapi::Ip_table_dump msg_t
Definition: dump_cmd.hpp:46
VOM::route_domain_cmds::create_cmd::to_string
std::string to_string() const
convert to string format for debug purposes
Definition: route_domain_cmds.cpp:52
VOM::route_domain_cmds::dump_cmd::dump_cmd
dump_cmd()
Constructor.
Definition: route_domain_cmds.cpp:104
VOM::rpc_cmd< HW::item< bool >, vapi::Ip_table_add_del >::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
route_domain_cmds.hpp
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::route_domain_cmds::delete_cmd::operator==
bool operator==(const delete_cmd &i) const
Comparison operator - only used for UT.
Definition: route_domain_cmds.cpp:71
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::rpc_cmd< HW::item< bool >, vapi::Ip_table_add_del >::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_table_dump >::m_dump
std::unique_ptr< vapi::Ip_table_dump > m_dump
The VAPI event registration.
Definition: dump_cmd.hpp:143
VOM::route_domain_cmds::delete_cmd::delete_cmd
delete_cmd(HW::item< bool > &item, l3_proto_t proto, route::table_id_t id)
Constructor.
Definition: route_domain_cmds.cpp:61
VOM::route_domain_cmds::dump_cmd::operator==
bool operator==(const dump_cmd &i) const
Comparison operator - only used for UT.
Definition: route_domain_cmds.cpp:109
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::Ip_table_dump >::wait
rc_t wait()
Wait for the issue of the command to complete.
Definition: dump_cmd.hpp:93
VOM::route_domain_cmds::create_cmd::create_cmd
create_cmd(HW::item< bool > &item, l3_proto_t proto, route::table_id_t id)
Constructor.
Definition: route_domain_cmds.cpp:21
VOM::rc_t::NOOP
const static rc_t NOOP
The HW write/update action was/has not been attempted.
Definition: types.hpp:104
VOM::HW::item::to_string
std::string to_string() const
convert to string format for debug purposes
Definition: hw.hpp:161
VOM::l3_proto_t::is_ipv6
bool is_ipv6() const
Definition: prefix.cpp:35
VOM::route_domain_cmds::create_cmd
A command class that creates the IP table.
Definition: route_domain_cmds.hpp:31
VOM::route_domain_cmds::delete_cmd::issue
rc_t issue(connection &con)
Issue the command to VPP/HW.
Definition: route_domain_cmds.cpp:77
id
u8 id[64]
Definition: dhcp.api:160
VOM::rpc_cmd< HW::item< bool >, vapi::Ip_table_add_del >::msg_t
vapi::Ip_table_add_del msg_t
convenient typedef
Definition: rpc_cmd.hpp:46
VOM::enum_base::to_string
const std::string & to_string() const
convert to string format for debug purposes
Definition: enum_base.hpp:36
VOM::l3_proto_t
An L3 protocol can be used to construct a prefix that is used to match packets are part of a route.
Definition: prefix.hpp:52
VOM::route_domain_cmds::delete_cmd::to_string
std::string to_string() const
convert to string format for debug purposes
Definition: route_domain_cmds.cpp:95
VOM::route_domain_cmds::delete_cmd
A cmd class that Deletes the IP Table.
Definition: route_domain_cmds.hpp:69
VOM::route_domain_cmds::dump_cmd::issue
rc_t issue(connection &con)
Issue the command to VPP/HW.
Definition: route_domain_cmds.cpp:115
VOM::route_domain_cmds::dump_cmd
A cmd class that Dumps IP fib tables.
Definition: route_domain_cmds.hpp:107
item
cJSON * item
Definition: cJSON.h:222
VOM::route_domain_cmds::create_cmd::operator==
bool operator==(const create_cmd &i) const
Comparison operator - only used for UT.
Definition: route_domain_cmds.cpp:31
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
proto
vl_api_ip_proto_t proto
Definition: acl_types.api:51
VOM::route_domain_cmds::create_cmd::issue
rc_t issue(connection &con)
Issue the command to VPP/HW.
Definition: route_domain_cmds.cpp:37
VOM::route_domain_cmds::dump_cmd::to_string
std::string to_string() const
convert to string format for debug purposes
Definition: route_domain_cmds.cpp:127
string
const char *const string
Definition: cJSON.h:172