FD.io VPP  v19.04.2-12-g66b1689
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  */
40  const handle_t& acl,
41  const gbp_contract::gbp_rules_t& gbp_rules,
43 
44  /**
45  * Issue the command to VPP/HW
46  */
47  rc_t issue(connection& con);
48 
49  /**
50  * convert to string format for debug purposes
51  */
52  std::string to_string() const;
53 
54  /**
55  * Comparison operator - only used for UT
56  */
57  bool operator==(const create_cmd& i) const;
58 
59 private:
60  const sclass_t m_sclass;
61  const sclass_t m_dclass;
62  const handle_t m_acl;
63  const gbp_contract::gbp_rules_t& m_gbp_rules;
64  const gbp_contract::ethertype_set_t& m_allowed_ethertypes;
65 };
66 
67 /**
68  * A cmd class that deletes a GBP contract
69  */
71  : public rpc_cmd<HW::item<uint32_t>, vapi::Gbp_contract_add_del>
72 {
73 public:
74  /**
75  * Constructor
76  */
78 
79  /**
80  * Issue the command to VPP/HW
81  */
82  rc_t issue(connection& con);
83 
84  /**
85  * convert to string format for debug purposes
86  */
87  std::string to_string() const;
88 
89  /**
90  * Comparison operator - only used for UT
91  */
92  bool operator==(const delete_cmd& i) const;
93 
94 private:
95  const sclass_t m_sclass;
96  const sclass_t m_dclass;
97 };
98 
99 /**
100  * A cmd class that Dumps all the GBP contracts
101  */
102 class dump_cmd : public VOM::dump_cmd<vapi::Gbp_contract_dump>
103 {
104 public:
105  /**
106  * Constructor
107  */
108  dump_cmd() = default;
109 
110  /**
111  * Issue the command to VPP/HW
112  */
113  rc_t issue(connection& con);
114  /**
115  * convert to string format for debug purposes
116  */
117  std::string to_string() const;
118 
119  /**
120  * Comparison operator - only used for UT
121  */
122  bool operator==(const dump_cmd& i) const;
123 
124 private:
125  /**
126  * HW reutrn code
127  */
129 };
130 }; // namespace gbp_contract_cmds
131 }; // namespace VOM
132 
133 /*
134  * fd.io coding-style-patch-verification: ON
135  *
136  * Local Variables:
137  * eval: (c-set-style "mozilla")
138  * End:
139  */
140 
141 #endif
std::string to_string() const
convert to string format for debug purposes
uint16_t sclass_t
int i
A cmd class that Dumps all the GBP contracts.
Error codes that VPP will return during a HW write.
Definition: types.hpp:89
create_cmd(HW::item< uint32_t > &item, 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.
std::set< ethertype_t > ethertype_set_t
A set of allowed ethertypes.
A representation of the connection to VPP.
Definition: connection.hpp:33
u16 sclass
Definition: gbp.api:118
A base class for all RPC commands to VPP.
Definition: rpc_cmd.hpp:40
bool operator==(const create_cmd &i) const
Comparison operator - only used for UT.
rc_t issue(connection &con)
Issue the command to VPP/HW.
A type declaration of an interface handle in VPP.
Definition: types.hpp:233
A command class that creates or updates the GBP contract.
std::set< gbp_rule > gbp_rules_t
set of gbp rules
The VPP Object Model (VOM) library.
Definition: acl_binding.cpp:19
A cmd class that deletes a GBP contract.
u16 allowed_ethertypes[16]
Definition: gbp.api:306
u16 dclass
Definition: gbp.api:303
A base class for VPP dump commands.
Definition: dump_cmd.hpp:43
HW::item< uint32_t > & item()
return the HW item the command updates
Definition: rpc_cmd.hpp:66