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
|
/*
* 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_NAT_BINDING_H__
#define __VOM_NAT_BINDING_H__
#include "vom/hw.hpp"
#include "vom/interface.hpp"
#include "vom/object_base.hpp"
#include "vom/om.hpp"
#include "vom/singular_db.hpp"
namespace VOM {
/**
* A Class representing the binding of an L2 interface to a bridge-domain
* and the properties of that binding.
*/
class nat_binding : public object_base
{
public:
/**
* NAT Zoness
*/
struct zone_t : public enum_base<zone_t>
{
/**
* Constructor
*/
zone_t(int v, const std::string s);
/**
* Destructor
*/
~zone_t() = default;
/**
* Permit Zone
*/
const static zone_t INSIDE;
/**
* Deny Zone
*/
const static zone_t OUTSIDE;
const static zone_t& from_vpp(u8 is_inside);
};
/**
* The key for a NAT Binding.
* The zoe is not included, since the same interface is never inside
* and outside.
*/
typedef std::tuple<interface::key_t, direction_t, l3_proto_t> key_t;
/**
* Construct a new object matching the desried state
* @param itf The interface onto which we bind/apply the feature
* @param dir The direction (input/output)
* @param proto The L3 proto used inside.
* @param zone The NAT zone for the link
*/
nat_binding(const interface& itf,
const direction_t& dir,
const l3_proto_t& proto,
const zone_t& zone);
/**
* Copy Constructor
*/
nat_binding(const nat_binding& o);
/**
* Destructor
*/
~nat_binding();
/**
* Comparison operator - for UT
*/
bool operator==(const nat_binding& n) const;
/**
* Return the binding's key
*/
const key_t key() const;
/**
* Return the 'singular instance' of the L2 config that matches this
* object
*/
std::shared_ptr<nat_binding> singular() const;
/**
* convert to string format for debug purposes
*/
std::string to_string() const;
/**
* Static function to find the bridge_domain in the model
*/
static std::shared_ptr<nat_binding> find(const key_t& key);
/**
* Dump all nat_bindings into the stream provided
*/
static void dump(std::ostream& os);
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 nat_binding& obj);
/**
* Find or Add the singular instance in the DB
*/
static std::shared_ptr<nat_binding> find_or_add(const nat_binding& temp);
/*
* It's the OM class that calls singular()
*/
friend class OM;
/**
* It's the singular_db class that calls replay()
*/
friend class singular_db<const key_t, nat_binding>;
/**
* Sweep/reap the object if still stale
*/
void sweep(void);
/**
* replay the object to create it in hardware
*/
void replay(void);
/**
* HW configuration for the binding. The bool representing the
* do/don't bind.
*/
HW::item<bool> m_binding;
/**
* A reference counting pointer the interface that this NAT binding
* represents. By holding the reference here, we can guarantee that
* this object will outlive the interface
*/
const std::shared_ptr<interface> m_itf;
/**
* The direction in which the feature applies
*/
direction_t m_dir;
/**
* The L3 protocol used on the inside
*/
l3_proto_t m_proto;
/**
* The NAT zone the interface is in
*/
zone_t m_zone;
/**
* A map of all L2 interfaces key against the interface's handle_t
*/
static singular_db<const key_t, nat_binding> m_db;
};
std::ostream& operator<<(std::ostream& os, const nat_binding::key_t& key);
};
/*
* fd.io coding-style-patch-verification: OFF
*
* Local Variables:
* eval: (c-set-style "mozilla")
* End:
*/
#endif
|
