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
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356 | // Copyright (C) 2018-2024 Internet Systems Consortium, Inc. ("ISC")
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
#ifndef MEMORY_HOST_DATA_SOURCE_H
#define MEMORY_HOST_DATA_SOURCE_H
#include <dhcpsrv/host_data_source_factory.h>
#include <boost/shared_ptr.hpp><--- Include file: not found. Please note: Cppcheck does not need standard library headers to get proper results.
#include <mutex><--- Include file: not found. Please note: Cppcheck does not need standard library headers to get proper results.
#include <string><--- Include file: not found. Please note: Cppcheck does not need standard library headers to get proper results.
#include <vector><--- Include file: not found. Please note: Cppcheck does not need standard library headers to get proper results.
namespace isc {
namespace dhcp {
namespace test {
/// @brief Simple host data source implementation for tests.
///
/// It used vector<HostPtr> as a storage and iterates through all hosts when
/// conducting operations. Most operations are skeleton methods that don't
/// work, just several are implemented. Those are used in the tests.
class MemHostDataSource : public virtual BaseHostDataSource {
public:
/// @brief Constructor.
MemHostDataSource() : next_host_id_(0) {
}
/// @brief Destructor.
virtual ~MemHostDataSource() = default;<--- Destructor in derived class
/// BaseHostDataSource methods.
/// @brief Return all hosts connected to any subnet for which reservations
/// have been made using a specified identifier.
///
/// This may return hosts from multiple subnets.
///
/// @param identifier_type Identifier type.
/// @param identifier_begin Pointer to a beginning of a buffer containing
/// an identifier.
/// @param identifier_len Identifier length.
virtual ConstHostCollection
getAll(const Host::IdentifierType& identifier_type,<--- Function in derived class
const uint8_t* identifier_begin,
const size_t identifier_len) const;
/// @brief Return all hosts in a DHCPv4 subnet.
///
/// @param subnet_id Subnet identifier.
virtual ConstHostCollection
getAll4(const SubnetID& subnet_id) const;<--- Function in derived class
/// @brief Return all hosts in a DHCPv6 subnet.
///
/// @param subnet_id Subnet identifier.
virtual ConstHostCollection
getAll6(const SubnetID& subnet_id) const;<--- Function in derived class
/// @brief Return all hosts with a hostname.
///
/// @param hostname The lower case hostname.
virtual ConstHostCollection
getAllbyHostname(const std::string& hostname) const;<--- Function in derived class
/// @brief Return all hosts with a hostname in a DHCPv4 subnet.
///
/// @param hostname The lower case hostname.
/// @param subnet_id Subnet identifier.
virtual ConstHostCollection
getAllbyHostname4(const std::string& hostname, const SubnetID& subnet_id) const;<--- Function in derived class
/// @brief Return all hosts with a hostname in a DHCPv6 subnet.
///
/// @param hostname The lower case hostname.
/// @param subnet_id Subnet identifier.
virtual ConstHostCollection
getAllbyHostname6(const std::string& hostname, const SubnetID& subnet_id) const;<--- Function in derived class
/// @brief Return range of hosts in a DHCPv4 subnet.
///
/// @param subnet_id Subnet identifier.
/// @param source_index Index of the source (unused).
/// @param lower_host_id Host identifier used as lower bound for the
/// returned range.
/// @param page_size maximum size of the page returned.
virtual ConstHostCollection
getPage4(const SubnetID& subnet_id,<--- Function in derived class
size_t& source_index,
uint64_t lower_host_id,
const HostPageSize& page_size) const;
/// @brief Return range of hosts in a DHCPv6 subnet.
///
/// @param subnet_id Subnet identifier.
/// @param source_index Index of the source (unused).
/// @param lower_host_id Host identifier used as lower bound for the
/// returned range.
/// @param page_size maximum size of the page returned.
virtual ConstHostCollection
getPage6(const SubnetID& subnet_id,<--- Function in derived class
size_t& source_index,
uint64_t lower_host_id,
const HostPageSize& page_size) const;
/// @brief Return range of hosts.
///
/// @param source_index Index of the source (unused).
/// @param lower_host_id Host identifier used as lower bound for the
/// returned range.
/// @param page_size maximum size of the page returned.
virtual ConstHostCollection
getPage4(size_t& source_index,<--- Function in derived class
uint64_t lower_host_id,
const HostPageSize& page_size) const;
/// @brief Return range of hosts.
///
/// @param source_index Index of the source (unused).
/// @param lower_host_id Host identifier used as lower bound for the
/// returned range.
/// @param page_size maximum size of the page returned.
virtual ConstHostCollection
getPage6(size_t& source_index,<--- Function in derived class
uint64_t lower_host_id,
const HostPageSize& page_size) const;
/// @brief Returns a collection of hosts using the specified IPv4 address.
///
/// Currently not implemented.
///
/// @param address IPv4 address for which the @c Host object is searched.
/// @return Empty collection of const @c Host objects.
virtual ConstHostCollection
getAll4(const asiolink::IOAddress& address) const;<--- Function in derived class
/// @brief Returns a host connected to the IPv4 subnet.
///
/// @param subnet_id Subnet identifier.
/// @param identifier_type Identifier type.
/// @param identifier_begin Pointer to a beginning of a buffer containing
/// an identifier.
/// @param identifier_len Identifier length.
/// @return Const @c Host object for which reservation has been made using
/// the specified identifier.
virtual ConstHostPtr
get4(const SubnetID& subnet_id,<--- Function in derived class
const Host::IdentifierType& identifier_type,
const uint8_t* identifier_begin,
const size_t identifier_len) const;
/// @brief Returns a host connected to the IPv4 subnet and having
/// a reservation for a specified IPv4 address.
///
/// @param subnet_id Subnet identifier.
/// @param address reserved IPv4 address.
/// @return Const @c Host object using a specified IPv4 address.
virtual ConstHostPtr
get4(const SubnetID& subnet_id,<--- Function in derived class
const asiolink::IOAddress& address) const;
/// @brief Returns all hosts connected to the IPv4 subnet and having
/// a reservation for a specified address.
///
/// @param subnet_id Subnet identifier.
/// @param address reserved IPv4 address.
///
/// @return Collection of const @c Host objects.
virtual ConstHostCollection
getAll4(const SubnetID& subnet_id,<--- Function in derived class
const asiolink::IOAddress& address) const;
/// @brief Returns a host connected to the IPv6 subnet.
///
/// @param subnet_id Subnet identifier.
/// @param identifier_type Identifier type.
/// @param identifier_begin Pointer to a beginning of a buffer containing
/// an identifier.
/// @param identifier_len Identifier length.
/// @return Const @c Host object for which reservation has been made using
/// the specified identifier.
virtual ConstHostPtr
get6(const SubnetID& subnet_id,<--- Function in derived class
const Host::IdentifierType& identifier_type,
const uint8_t* identifier_begin,
const size_t identifier_len) const;
/// @brief Returns a host using the specified IPv6 prefix.
///
/// Currently not implemented.
///
/// @param prefix IPv6 prefix for which the @c Host object is searched.
/// @param prefix_len IPv6 prefix length.
/// @return Const @c Host object using a specified IPv6 prefix.
virtual ConstHostPtr
get6(const asiolink::IOAddress& prefix, const uint8_t prefix_len) const;<--- Function in derived class
/// @brief Returns a host connected to the IPv6 subnet and having
/// a reservation for a specified IPv6 address or prefix.
///
/// @param subnet_id Subnet identifier.
/// @param address reserved IPv6 address/prefix.
/// @return Const @c Host object using a specified IPv6 address/prefix.
virtual ConstHostPtr
get6(const SubnetID& subnet_id, const asiolink::IOAddress& address) const;<--- Function in derived class
/// @brief Returns all hosts connected to the IPv6 subnet and having
/// a reservation for a specified address or delegated prefix (lease).
///
/// @param subnet_id Subnet identifier.
/// @param address reserved IPv6 address/prefix.
///
/// @return Collection of const @c Host objects.
virtual ConstHostCollection
getAll6(const SubnetID& subnet_id,<--- Function in derived class
const asiolink::IOAddress& address) const;
// @brief Returns all hosts having a reservation for a specified
// address or delegated prefix (lease).
///
/// @param address reserved IPv6 address/prefix.
///
/// @return Collection of const @c Host objects.
virtual ConstHostCollection
getAll6(const asiolink::IOAddress& address) const;<--- Function in derived class
/// @brief Adds a new host to the collection.
///
/// @param host Pointer to the new @c Host object being added.
virtual void add(const HostPtr& host);<--- Function in derived class
/// @brief Attempts to delete a host by (subnet-id, address)
///
/// @param subnet_id subnet identifier.
/// @param addr specified address.
/// @return true if deletion was successful, false if the host was not there.
/// @throw various exceptions in case of errors
virtual bool del(const SubnetID& subnet_id, const asiolink::IOAddress& addr);<--- Function in derived class
/// @brief Attempts to delete a host by (subnet-id4, identifier, identifier-type)
///
/// @param subnet_id IPv4 Subnet identifier.
/// @param identifier_type Identifier type.
/// @param identifier_begin Pointer to a beginning of a buffer containing
/// an identifier.
/// @param identifier_len Identifier length.
/// @return true if deletion was successful, false if the host was not there.
/// @throw various exceptions in case of errors
virtual bool del4(const SubnetID& subnet_id,<--- Function in derived class
const Host::IdentifierType& identifier_type,
const uint8_t* identifier_begin, const size_t identifier_len);
/// @brief Attempts to delete a host by (subnet-id6, identifier, identifier-type)
///
/// @param subnet_id IPv6 Subnet identifier.
/// @param identifier_type Identifier type.
/// @param identifier_begin Pointer to a beginning of a buffer containing
/// an identifier.
/// @param identifier_len Identifier length.
/// @return true if deletion was successful, false if the host was not there.
/// @throw various exceptions in case of errors
virtual bool del6(const SubnetID& subnet_id,<--- Function in derived class
const Host::IdentifierType& identifier_type,
const uint8_t* identifier_begin, const size_t identifier_len);
/// @brief Return backend type
///
/// Returns the type of the backend (e.g. "mysql", "memfile" etc.)
///
/// @return Type of the backend.
virtual std::string getType() const {<--- Function in derived class
return ("mem");
}
/// More lease backend?
/// @brief Returns name of the database or file used by the backend
/// @return "mem" string"
virtual std::string getName() const {
return (std::string("mem"));
}
/// @brief Returns description of the backend.
/// @return description
virtual std::string getDescription() const {
return (std::string("In memory storage, mostly useful for testing."));
}
/// @brief Returns version this backend
/// @return two numbers that each represent practical value of this backend.
virtual std::pair<uint32_t, uint32_t> getVersion() const {
return (std::make_pair(0,0));
}
/// Specific methods.
/// @brief Returns store size.
///
/// @return number of hosts in the store.
virtual size_t size() const;
/// @brief Controls whether IP reservations are unique or non-unique.
///
/// In a typical case, the IP reservations are unique and backends verify
/// prior to adding a host reservation to the database that the reservation
/// for a given IP address does not exist. In some cases it may be required
/// to allow non-unique IP reservations, e.g. in the case when a host has
/// several interfaces and independently of which interface is used by this
/// host to communicate with the DHCP server the same IP address should be
/// assigned. In this case the @c unique value should be set to false to
/// disable the checks for uniqueness on the backend side.
///
/// All backends are required to support the case when unique setting is
/// @c true and they must use this setting by default.
///
/// @param unique boolean flag indicating if the IP reservations must be
/// unique or can be non-unique.
/// @return true if the new setting was accepted by the backend or false
/// otherwise.
virtual bool setIPReservationsUnique(const bool) {<--- Function in derived class
return (true);
}
protected:
// This is very simple storage.
/// @brief Store
std::vector<HostPtr> store_;
/// @brief Next host id
uint64_t next_host_id_;
/// @brief Mutex to protect the store.
std::mutex mutable mutex_;
};
/// Pointer to the Mem host data source.
typedef boost::shared_ptr<MemHostDataSource> MemHostDataSourcePtr;
/// @brief Factory function.
///
/// @param parameters
/// @return A pointer to a base host data source instance.
HostDataSourcePtr
memFactory(const db::DatabaseConnection::ParameterMap& /*parameters*/);
} // namespace isc::dhcp::test
} // namespace isc::dhcp
} // namespace isc
#endif
|