blob: 96e46ce575b0bc563ee145c47273e5deda8b68a5 (
plain)
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
|
/*
* 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_ROUTE_DOMAIN_H__
#define __VOM_ROUTE_DOMAIN_H__
#include "vom/inspect.hpp"
#include "vom/object_base.hpp"
#include "vom/om.hpp"
#include "vom/prefix.hpp"
#include "vom/singular_db.hpp"
namespace VOM {
/**
* A route-domain is a VRF.
* creating a route-domain object will construct both an IPv4
* and IPv6 table.
*/
class route_domain : public object_base
{
public:
/**
* The Key for a route-domain
*/
typedef route::table_id_t key_t;
/**
* Construct a new object matching the desried state
*/
route_domain(route::table_id_t id);
/**
* Copy Constructor
*/
route_domain(const route_domain& o);
/**
* Destructor
*/
~route_domain();
/**
* comparison operator - for UT
*/
bool operator==(const route_domain& r) const;
/**
* Return the matching 'singular instance'
*/
std::shared_ptr<route_domain> singular() const;
/**
* Debug print function
*/
std::string to_string() const;
/**
* Get the table ID
*/
route::table_id_t table_id() const;
/**
* Get the route-domain's key
*/
key_t key() const;
/**
* Find the instnace of the route domain in the OM
*/
static std::shared_ptr<route_domain> find(const key_t& temp);
/**
* Dump all route-doamin into the stream provided
*/
static void dump(std::ostream& os);
/**
* Return the sigular instance for the default table
*/
static std::shared_ptr<route_domain> get_default();
/**
* replay the object to create it in hardware
*/
void replay(void);
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;
};
/**
* Instance of the event handler to register with OM
*/
static event_handler m_evh;
/**
* Commit the acculmulated changes into VPP. i.e. to a 'HW" write.
*/
void update(const route_domain& obj);
/**
* Find or add the instnace of the route domain in the OM
*/
static std::shared_ptr<route_domain> find_or_add(const route_domain& temp);
/*
* It's the OM class that updates the objects in HW
*/
friend class OM;
/**
* It's the singular_db class that calls replay()
*/
friend class singular_db<route::table_id_t, route_domain>;
/**
* Sweep/reap the object if still stale
*/
void sweep(void);
/**
* HW configuration for the result of creating the v4 table
*/
HW::item<bool> m_hw_v4;
/**
* HW configuration for the result of creating the v6 table
*/
HW::item<bool> m_hw_v6;
/**
* VPP understands Table-IDs not table names.
* The table IDs for V4 and V6 are the same.
*/
route::table_id_t m_table_id;
/**
* A map of all interfaces key against the interface's name
*/
static singular_db<route::table_id_t, route_domain> m_db;
};
}; // namespace VOM
/*
* fd.io coding-style-patch-verification: ON
*
* Local Variables:
* eval: (c-set-style "mozilla")
* End:
*/
#endif
|
