FD.io VPP  v21.06-3-gbb25fbf28
Vector Packet Processing
gbp_contract_cmds.hpp
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 #ifndef __VOM_GBP_CONTRACT_CMDS_H__
17 #define __VOM_GBP_CONTRACT_CMDS_H__
18 
19 #include "vom/dump_cmd.hpp"
20 #include "vom/gbp_contract.hpp"
21 
22 #include <vapi/gbp.api.vapi.hpp>
23 
24 namespace VOM {
25 namespace gbp_contract_cmds {
26 
27 /**
28  * A command class that creates or updates the GBP contract
29  */
31  : public rpc_cmd<HW::item<uint32_t>, vapi::Gbp_contract_add_del>
32 {
33 public:
34  /**
35  * Constructor
36  */
38  scope_t scope,
41  const handle_t& acl,
42  const gbp_contract::gbp_rules_t& gbp_rules,
44 
45  /**
46  * Issue the command to VPP/HW
47  */
49 
50  /**
51  * convert to string format for debug purposes
52  */
53  std::string to_string() const;
54 
55  /**
56  * Comparison operator - only used for UT
57  */
58  bool operator==(const create_cmd& i) const;
59 
60 private:
61  const scope_t m_scope;
62  const sclass_t m_sclass;
63  const sclass_t m_dclass;
64  const handle_t m_acl;
65  const gbp_contract::gbp_rules_t& m_gbp_rules;
66  const gbp_contract::ethertype_set_t& m_allowed_ethertypes;
67 };
68 
69 /**
70  * A cmd class that deletes a GBP contract
71  */
73  : public rpc_cmd<HW::item<uint32_t>, vapi::Gbp_contract_add_del>
74 {
75 public:
76  /**
77  * Constructor
78  */
80  scope_t scope,
83 
84  /**
85  * Issue the command to VPP/HW
86  */
88 
89  /**
90  * convert to string format for debug purposes
91  */
92  std::string to_string() const;
93 
94  /**
95  * Comparison operator - only used for UT
96  */
97  bool operator==(const delete_cmd& i) const;
98 
99 private:
100  const scope_t m_scope;
101  const sclass_t m_sclass;
102  const sclass_t m_dclass;
103 };
104 
105 /**
106  * A cmd class that Dumps all the GBP contracts
107  */
108 class dump_cmd : public VOM::dump_cmd<vapi::Gbp_contract_dump>
109 {
110 public:
111  /**
112  * Constructor
113  */
114  dump_cmd() = default;
115 
116  /**
117  * Issue the command to VPP/HW
118  */
120  /**
121  * convert to string format for debug purposes
122  */
123  std::string to_string() const;
124 
125  /**
126  * Comparison operator - only used for UT
127  */
128  bool operator==(const dump_cmd& i) const;
129 
130 private:
131  /**
132  * HW reutrn code
133  */
134  HW::item<bool> item;
135 };
136 }; // namespace gbp_contract_cmds
137 }; // namespace VOM
138 
139 /*
140  * fd.io coding-style-patch-verification: OFF
141  *
142  * Local Variables:
143  * eval: (c-set-style "mozilla")
144  * End:
145  */
146 
147 #endif
VOM::HW::item< uint32_t >
VOM::gbp_contract_cmds::create_cmd::to_string
std::string to_string() const
convert to string format for debug purposes
Definition: gbp_contract_cmds.cpp:110
VOM::gbp_contract_cmds::delete_cmd::delete_cmd
delete_cmd(HW::item< uint32_t > &item, scope_t scope, sclass_t sclass, sclass_t dclass)
Constructor.
Definition: gbp_contract_cmds.cpp:123
VOM
The VPP Object Model (VOM) library.
Definition: acl_binding.cpp:19
VOM::scope_t
uint16_t scope_t
Definition: gbp_types.hpp:28
VOM::rpc_cmd
A base class for all RPC commands to VPP.
Definition: rpc_cmd.hpp:40
VOM::gbp_contract_cmds::create_cmd::operator==
bool operator==(const create_cmd &i) const
Comparison operator - only used for UT.
Definition: gbp_contract_cmds.cpp:40
VOM::gbp_contract_cmds::create_cmd
A command class that creates or updates the GBP contract.
Definition: gbp_contract_cmds.hpp:30
con
Connection con
Definition: vapi_cpp_test.cpp:56
VOM::gbp_contract_cmds::dump_cmd::to_string
std::string to_string() const
convert to string format for debug purposes
Definition: gbp_contract_cmds.cpp:186
VOM::sclass_t
uint16_t sclass_t
Definition: gbp_types.hpp:27
allowed_ethertypes
u16 allowed_ethertypes[16]
Definition: gbp.api:336
VOM::gbp_contract_cmds::delete_cmd::to_string
std::string to_string() const
convert to string format for debug purposes
Definition: gbp_contract_cmds.cpp:158
gbp_contract.hpp
VOM::gbp_contract::ethertype_set_t
std::set< ethertype_t > ethertype_set_t
A set of allowed ethertypes.
Definition: gbp_contract.hpp:47
VOM::gbp_contract_cmds::delete_cmd
A cmd class that deletes a GBP contract.
Definition: gbp_contract_cmds.hpp:72
VOM::gbp_contract_cmds::create_cmd::create_cmd
create_cmd(HW::item< uint32_t > &item, scope_t scope, sclass_t sclass, sclass_t dclass, const handle_t &acl, const gbp_contract::gbp_rules_t &gbp_rules, const gbp_contract::ethertype_set_t &allowed_ethertypes)
Constructor.
Definition: gbp_contract_cmds.cpp:22
VOM::connection
A representation of the connection to VPP.
Definition: connection.hpp:33
VOM::gbp_contract_cmds::dump_cmd::dump_cmd
dump_cmd()=default
Constructor.
VOM::gbp_contract_cmds::create_cmd::issue
rc_t issue(connection &con)
Issue the command to VPP/HW.
Definition: gbp_contract_cmds.cpp:51
scope
vl_api_gbp_scope_t scope
Definition: gbp.api:78
i
sll srl srl sll sra u16x4 i
Definition: vector_sse42.h:261
VOM::handle_t
A type declaration of an interface handle in VPP.
Definition: types.hpp:233
sclass
u16 sclass
Definition: gbp.api:131
dump_cmd.hpp
VOM::gbp_contract_cmds::dump_cmd
A cmd class that Dumps all the GBP contracts.
Definition: gbp_contract_cmds.hpp:108
dclass
u16 dclass
Definition: gbp.api:333
VOM::gbp_contract_cmds::delete_cmd::operator==
bool operator==(const delete_cmd &i) const
Comparison operator - only used for UT.
Definition: gbp_contract_cmds.cpp:135
VOM::rpc_cmd< HW::item< uint32_t >, vapi::Gbp_contract_add_del >::item
HW::item< uint32_t > & item()
return the HW item the command updates
Definition: rpc_cmd.hpp:66
VOM::gbp_contract::gbp_rules_t
std::set< gbp_rule > gbp_rules_t
set of gbp rules
Definition: gbp_contract.hpp:37
VOM::rc_t
Error codes that VPP will return during a HW write.
Definition: types.hpp:89
VOM::dump_cmd
A base class for VPP dump commands.
Definition: dump_cmd.hpp:43
VOM::gbp_contract_cmds::dump_cmd::operator==
bool operator==(const dump_cmd &i) const
Comparison operator - only used for UT.
Definition: gbp_contract_cmds.cpp:168
VOM::gbp_contract_cmds::dump_cmd::issue
rc_t issue(connection &con)
Issue the command to VPP/HW.
Definition: gbp_contract_cmds.cpp:174
VOM::gbp_contract_cmds::delete_cmd::issue
rc_t issue(connection &con)
Issue the command to VPP/HW.
Definition: gbp_contract_cmds.cpp:141
string
const char *const string
Definition: cJSON.h:172