1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
|
/*
* Copyright (c) 2017 Cisco and/or its affiliates.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef __VOM_VXLAN_TUNNEL_H__
#define __VOM_VXLAN_TUNNEL_H__
#include "vom/hw.hpp"
#include "vom/inspect.hpp"
#include "vom/interface.hpp"
#include "vom/object_base.hpp"
#include "vom/om.hpp"
#include "vom/prefix.hpp"
#include "vom/route_domain.hpp"
#include "vom/singular_db.hpp"
namespace VOM {
/**
* A representation of a VXLAN Tunnel in VPP
*/
class vxlan_tunnel : public interface
{
public:
/**
* Combaintion of attributes that are a unique key
* for a VXLAN tunnel
*/
struct endpoint_t
{
/**
* Default constructor
*/
endpoint_t();
/**
* Constructor taking endpoint values
*/
endpoint_t(const boost::asio::ip::address& src,
const boost::asio::ip::address& dst,
uint32_t vni);
/**
* Comparison operator
*/
bool operator==(const endpoint_t& o) const;
/**
* Debug print function
*/
std::string to_string() const;
/**
* The src IP address of the endpoint
*/
boost::asio::ip::address src;
/**
* The destination IP address of the endpoint
*/
boost::asio::ip::address dst;
/**
* The VNI of the endpoint
*/
uint32_t vni;
};
/**
* mode for the tunnel
*/
struct mode_t : public enum_base<mode_t>
{
~mode_t() = default;
const static mode_t STANDARD;
const static mode_t GBP;
const static mode_t GPE;
private:
mode_t(int v, const std::string s);
mode_t() = default;
};
/**
* Construct a new object matching the desried state
*/
vxlan_tunnel(const boost::asio::ip::address& src,
const boost::asio::ip::address& dst,
uint32_t vni,
const mode_t& mode = mode_t::STANDARD);
vxlan_tunnel(const boost::asio::ip::address& src,
const boost::asio::ip::address& dst,
uint32_t vni,
const interface& mcast_itf,
const mode_t& mode = mode_t::STANDARD);
/*
* Destructor
*/
~vxlan_tunnel();
/**
* Copy constructor
*/
vxlan_tunnel(const vxlan_tunnel& o);
/**
* Return the matching 'singular instance'
*/
std::shared_ptr<vxlan_tunnel> singular() const;
/**
* Debug rpint function
*/
virtual std::string to_string() const;
/**
* Return VPP's handle to this object
*/
const handle_t& handle() const;
/**
* Fond the singular instance of the interface in the DB by key
*/
static std::shared_ptr<vxlan_tunnel> find(const interface::key_t& k);
private:
/**
* Class definition for listeners to OM events
*/
class event_handler : public OM::listener, public inspect::command_handler
{
public:
event_handler();
virtual ~event_handler() = default;
/**
* Handle a populate event
*/
void handle_populate(const client_db::key_t& key);
/**
* Handle a replay event
*/
void handle_replay();
/**
* Show the object in the Singular DB
*/
void show(std::ostream& os);
/**
* Get the sortable Id of the listener
*/
dependency_t order() const;
};
/**
* Event handle to register with OM
*/
static event_handler m_evh;
/**
* Commit the acculmulated changes into VPP. i.e. to a 'HW" write.
*/
void update(const vxlan_tunnel& obj);
/**
* Return the matching 'instance' of the sub-interface
* over-ride from the base class
*/
std::shared_ptr<interface> singular_i() const;
/**
* Find the VXLAN tunnel in the OM
*/
static std::shared_ptr<vxlan_tunnel> find_or_add(const vxlan_tunnel& temp);
/*
* It's the VPPHW class that updates the objects in HW
*/
friend class OM;
/**
* It's the singular_db class that calls replay()
*/
friend class singular_db<endpoint_t, vxlan_tunnel>;
/**
* Sweep/reap the object if still stale
*/
void sweep(void);
/**
* replay the object to create it in hardware
*/
void replay(void);
/**
* Tunnel enpoint/key
*/
endpoint_t m_tep;
/**
* The tunnel mode
*/
mode_t m_mode;
/**
* The interface on which to send the packets if the destination
* is multicast
*/
std::shared_ptr<interface> m_mcast_itf;
/**
* Construct a unique name for the tunnel
*/
static std::string mk_name(const boost::asio::ip::address& src,
const boost::asio::ip::address& dst,
const mode_t& mode,
uint32_t vni);
};
/**
* Ostream output for a tunnel endpoint
*/
std::ostream& operator<<(std::ostream& os, const vxlan_tunnel::endpoint_t& ep);
}; // namespace VOM
/*
* fd.io coding-style-patch-verification: ON
*
* Local Variables:
* eval: (c-set-style "mozilla")
* End:
*/
#endif
|
