FD.io VPP  v19.08.3-2-gbabecb413
Vector Packet Processing
gbp_bridge_domain_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_BRIDGE_DOMAIN_CMDS_H__
17 #define __VOM_GBP_BRIDGE_DOMAIN_CMDS_H__
18 
19 #include "vom/dump_cmd.hpp"
21 #include "vom/rpc_cmd.hpp"
22 
23 #include <vapi/gbp.api.vapi.hpp>
24 
25 namespace VOM {
26 namespace gbp_bridge_domain_cmds {
27 /**
28  * A command class that creates an Bridge-Domain
29  */
31  : public rpc_cmd<HW::item<uint32_t>, vapi::Gbp_bridge_domain_add>
32 {
33 public:
34  /**
35  * Constructor
36  */
38  u32 rd_id,
39  const handle_t bvi,
40  const handle_t uu_fwd,
41  const handle_t bm_flood,
43 
44  /**
45  * Issue the command to VPP/HW
46  */
47  rc_t issue(connection& con);
48  /**
49  * convert to string format for debug purposes
50  */
51  std::string to_string() const;
52 
53  /**
54  * Comparison operator - only used for UT
55  */
56  bool operator==(const create_cmd& i) const;
57 
58 private:
59  u32 m_rd_id;
60  const handle_t m_bvi;
61  const handle_t m_uu_fwd;
62  const handle_t m_bm_flood;
63  const gbp_bridge_domain::flags_t& m_flags;
64 };
65 
66 /**
67  * A cmd class that Delete an Bridge-Domain
68  */
70  : public rpc_cmd<HW::item<uint32_t>, vapi::Gbp_bridge_domain_del>
71 {
72 public:
73  /**
74  * Constructor
75  */
77 
78  /**
79  * Issue the command to VPP/HW
80  */
81  rc_t issue(connection& con);
82  /**
83  * convert to string format for debug purposes
84  */
85  std::string to_string() const;
86 
87  /**
88  * Comparison operator - only used for UT
89  */
90  bool operator==(const delete_cmd& i) const;
91 };
92 
93 /**
94  * A cmd class that Dumps all the bridge domains
95  */
96 class dump_cmd : public VOM::dump_cmd<vapi::Gbp_bridge_domain_dump>
97 {
98 public:
99  /**
100  * Constructor
101  */
102  dump_cmd() = default;
103  dump_cmd(const dump_cmd& d) = default;
104 
105  /**
106  * Issue the command to VPP/HW
107  */
108  rc_t issue(connection& con);
109  /**
110  * convert to string format for debug purposes
111  */
112  std::string to_string() const;
113 
114  /**
115  * Comparison operator - only used for UT
116  */
117  bool operator==(const dump_cmd& i) const;
118 
119 private:
120  /**
121  * HW reutrn code
122  */
124 };
125 
126 }; // gbp_bridge_domain_cmds
127 }; // VOM
128 
129 /*
130  * fd.io coding-style-patch-verification: ON
131  *
132  * Local Variables:
133  * eval: (c-set-style "mozilla")
134  * End:
135  */
136 
137 #endif
u32 flags
Definition: vhost_user.h:141
rc_t issue(connection &con)
Issue the command to VPP/HW.
A cmd class that Delete an Bridge-Domain.
int i
u32 rd_id
Definition: gbp.api:34
Error codes that VPP will return during a HW write.
Definition: types.hpp:89
A cmd class that Dumps all the bridge domains.
A command class that creates an Bridge-Domain.
unsigned int u32
Definition: types.h:88
A representation of the connection to VPP.
Definition: connection.hpp:33
create_cmd(HW::item< uint32_t > &item, u32 rd_id, const handle_t bvi, const handle_t uu_fwd, const handle_t bm_flood, const gbp_bridge_domain::flags_t &flags)
Constructor.
A base class for all RPC commands to VPP.
Definition: rpc_cmd.hpp:40
std::string to_string() const
convert to string format for debug purposes
A type declaration of an interface handle in VPP.
Definition: types.hpp:233
bool operator==(const create_cmd &i) const
Comparison operator - only used for UT.
The VPP Object Model (VOM) library.
Definition: acl_binding.cpp:19
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