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
249
250
251
252
253
254
|
/*
* 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_IP_UNNUMBERED_H__
#define __VOM_IP_UNNUMBERED_H__
#include "vom/hw.hpp"
#include "vom/inspect.hpp"
#include "vom/interface.hpp"
#include "vom/object_base.hpp"
#include "vom/om.hpp"
#include "vom/rpc_cmd.hpp"
#include "vom/singular_db.hpp"
namespace VOM {
/**
* A representation of IP unnumbered configuration on an interface
*/
class ip_unnumbered : public object_base
{
public:
/**
* Construct a new object matching the desried state
*
* @param itf - The interface with no IP address
* @param l3_itf - The interface that has the IP address we wish to
* share.
*/
ip_unnumbered(const interface& itf, const interface& l3_itf);
/**
* Copy Constructor
*/
ip_unnumbered(const ip_unnumbered& o);
/**
* Destructor
*/
~ip_unnumbered();
/**
* Return the 'singular instance' of the L3-Config that matches this
* object
*/
std::shared_ptr<ip_unnumbered> singular() const;
/**
* convert to string format for debug purposes
*/
std::string to_string() const;
/**
* Dump all ip_unnumbereds into the stream provided
*/
static void dump(std::ostream& os);
/**
* The key type for ip_unnumbereds
*/
typedef interface::key_type key_t;
/**
* Find an singular instance in the DB for the interface passed
*/
static std::shared_ptr<ip_unnumbered> find(const interface& i);
/**
* A command class that configures the IP unnumbered
*/
class config_cmd
: public rpc_cmd<HW::item<bool>, rc_t, vapi::Sw_interface_set_unnumbered>
{
public:
/**
* Constructor
*/
config_cmd(HW::item<bool>& item,
const handle_t& itf,
const handle_t& l3_itf);
/**
* Issue the command to VPP/HW
*/
rc_t issue(connection& con);
/**
* convert to string format for debug purposes
*/
std::string to_string() const;
/**
* Comparison operator - only used for UT
*/
bool operator==(const config_cmd& i) const;
private:
/**
* Reference to the interface for which the address is required
*/
const handle_t& m_itf;
/**
* Reference to the interface which has an address
*/
const handle_t& m_l3_itf;
};
/**
* A cmd class that Unconfigs L3 Config from an interface
*/
class unconfig_cmd
: public rpc_cmd<HW::item<bool>, rc_t, vapi::Sw_interface_set_unnumbered>
{
public:
/**
* Constructor
*/
unconfig_cmd(HW::item<bool>& item,
const handle_t& itf,
const handle_t& l3_itf);
/**
* Issue the command to VPP/HW
*/
rc_t issue(connection& con);
/**
* convert to string format for debug purposes
*/
std::string to_string() const;
/**
* Comparison operator - only used for UT
*/
bool operator==(const unconfig_cmd& i) const;
private:
/**
* Reference to the interface for which the address is required
*/
const handle_t& m_itf;
/**
* Reference to the interface which has an address
*/
const handle_t& m_l3_itf;
};
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_handler to register with OM
*/
static event_handler m_evh;
/**
* Enquue commonds to the VPP command Q for the update
*/
void update(const ip_unnumbered& obj);
/**
* Find or add the singular instance in the DB
*/
static std::shared_ptr<ip_unnumbered> find_or_add(const ip_unnumbered& 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<key_t, ip_unnumbered>;
/**
* Sweep/reap the object if still stale
*/
void sweep(void);
/**
* replay the object to create it in hardware
*/
void replay(void);
/**
* A reference counting pointer the interface that requires an address.
*/
const std::shared_ptr<interface> m_itf;
/**
* A reference counting pointer the interface that has an address.
*/
const std::shared_ptr<interface> m_l3_itf;
/**
* HW configuration for the binding. The bool representing the
* do/don't bind.
*/
HW::item<bool> m_config;
/**
* A map of all L3 configs keyed against a combination of the interface
* and subnet's keys.
*/
static singular_db<key_t, ip_unnumbered> m_db;
};
};
/*
* fd.io coding-style-patch-verification: ON
*
* Local Variables:
* eval: (c-set-style "mozilla")
* End:
*/
#endif
|
