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
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
|
// Copyright (C) 2020-2021 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/.
#include <config.h>
#include <dhcp/option.h>
#include <dhcp6/client_handler.h>
#include <dhcp6/tests/dhcp6_test_utils.h>
#include <stats/stats_mgr.h>
#include <util/multi_threading_mgr.h>
#include <unistd.h>
using namespace isc;
using namespace isc::dhcp;
using namespace isc::dhcp::test;
using namespace isc::stats;
using namespace isc::util;
namespace {
/// @brief Test fixture class for testing client handler.
class ClientHandleTest : public ::testing::Test {
public:
/// @brief Constructor.
///
/// Creates the pkt6-receive-drop statistic.
ClientHandleTest() : called1_(false), called2_(false), called3_(false) {
MultiThreadingMgr::instance().apply(false, 0, 0);
StatsMgr::instance().setValue("pkt6-receive-drop", static_cast<int64_t>(0));
}
/// @brief Destructor.
///
/// Removes statistics.
~ClientHandleTest() {
MultiThreadingMgr::instance().apply(false, 0, 0);
StatsMgr::instance().removeAll();
}
/// @brief Generates a client-id option.
///
/// (from dhcp6_test_utils.h)
///
/// @return A random client-id option.
OptionPtr generateClientId(uint8_t base = 100) {
const size_t len = 32;
OptionBuffer duid(len);
for (size_t i = 0; i < len; ++i) {
duid[i] = base + i;
}
return (OptionPtr(new Option(Option::V6, D6O_CLIENTID, duid)));
}
/// @brief Check statistics.
///
/// @param bumped True if pkt6-receive-drop should have been bumped by one,
/// false otherwise.
void checkStat(bool bumped) {
ObservationPtr obs = StatsMgr::instance().getObservation("pkt6-receive-drop");
ASSERT_TRUE(obs);
if (bumped) {
EXPECT_EQ(1, obs->getInteger().first);
} else {
EXPECT_EQ(0, obs->getInteger().first);
}
}
/// @brief Waits for pending continuations.
void waitForThreads() {
MultiThreadingMgr::instance().getThreadPool().wait(3);
}
/// @brief Set called1_ to true.
void setCalled1() {
called1_ = true;
}
/// @brief Set called2_ to true.
void setCalled2() {
called2_ = true;
}
/// @brief Set called3_ to true.
void setCalled3() {
called3_ = true;
}
/// @brief The called flag number 1.
bool called1_;
/// @brief The called flag number 2.
bool called2_;
/// @brief The called flag number 3.
bool called3_;
};
// Verifies behavior with empty block.
TEST_F(ClientHandleTest, empty) {
try {
// Get a client handler.
ClientHandler client_handler;
} catch (const std::exception& ex) {
ADD_FAILURE() << "unexpected exception: " << ex.what();
}
checkStat(false);
}
// Verifies behavior with one query.
TEST_F(ClientHandleTest, oneQuery) {
// Get a query.
Pkt6Ptr sol(new Pkt6(DHCPV6_SOLICIT, 1234));
sol->addOption(generateClientId());
try {
// Get a client handler.
ClientHandler client_handler;
// Try to lock it.
bool duplicate = false;
EXPECT_NO_THROW(duplicate = !client_handler.tryLock(sol));
// Should return false (no duplicate).
EXPECT_FALSE(duplicate);
} catch (const std::exception& ex) {
ADD_FAILURE() << "unexpected exception: " << ex.what();
}
checkStat(false);
}
// Verifies behavior with two queries for the same client.
TEST_F(ClientHandleTest, sharedQueries) {
// Get two queries.
Pkt6Ptr sol(new Pkt6(DHCPV6_SOLICIT, 1234));
Pkt6Ptr req(new Pkt6(DHCPV6_REQUEST, 2345));
OptionPtr client_id = generateClientId();
// Same client ID: same client.
sol->addOption(client_id);
req->addOption(client_id);
try {
// Get a client handler.
ClientHandler client_handler;
// Try to lock it with the solicit.
bool duplicate = false;
EXPECT_NO_THROW(duplicate = !client_handler.tryLock(sol));
// Should return false (no duplicate).
EXPECT_FALSE(duplicate);
// Get a second client handler.
ClientHandler client_handler2;
// Try to lock it with a request.
EXPECT_NO_THROW(duplicate = !client_handler2.tryLock(req));
// Should return true (race with the duplicate).
EXPECT_TRUE(duplicate);
} catch (const std::exception& ex) {
ADD_FAILURE() << "unexpected exception: " << ex.what();
}
checkStat(true);
}
// Verifies behavior with a sequence of two queries.
TEST_F(ClientHandleTest, sequence) {
// Get two queries.
Pkt6Ptr sol(new Pkt6(DHCPV6_SOLICIT, 1234));
Pkt6Ptr req(new Pkt6(DHCPV6_REQUEST, 2345));
OptionPtr client_id = generateClientId();
// Same client ID: same client.
sol->addOption(client_id);
req->addOption(client_id);
try {
// Get a client handler.
ClientHandler client_handler;
// Try to lock it with the solicit.
bool duplicate = false;
EXPECT_NO_THROW(duplicate = !client_handler.tryLock(sol));
// Should return false (no duplicate).
EXPECT_FALSE(duplicate);
} catch (const std::exception& ex) {
ADD_FAILURE() << "unexpected exception: " << ex.what();
}
// As it is a different block the lock was released.
try {
// Get a second client handler.
ClientHandler client_handler2;
// Try to lock it with a request.
bool duplicate = false;
EXPECT_NO_THROW(duplicate = !client_handler2.tryLock(req));
// Should return false (no duplicate).
EXPECT_FALSE(duplicate);
} catch (const std::exception& ex) {
ADD_FAILURE() << "unexpected exception: " << ex.what();
}
checkStat(false);
}
// Verifies behavior with different clients.
TEST_F(ClientHandleTest, notSharedQueries) {
// Get two queries.
Pkt6Ptr sol(new Pkt6(DHCPV6_SOLICIT, 1234));
Pkt6Ptr req(new Pkt6(DHCPV6_REQUEST, 2345));
OptionPtr client_id = generateClientId();
OptionPtr client_id2 = generateClientId(111);
// Different client ID: different client.
sol->addOption(client_id);
req->addOption(client_id2);
try {
// Get a client handler.
ClientHandler client_handler;
// Try to lock it with the solicit.
bool duplicate = false;
EXPECT_NO_THROW(duplicate = !client_handler.tryLock(sol));
// Should return false (no duplicate).
EXPECT_FALSE(duplicate);
// Get a second client handler.
ClientHandler client_handler2;
// Try to lock it with a request.
EXPECT_NO_THROW(duplicate = !client_handler2.tryLock(req));
// Should return false (no duplicate).
EXPECT_FALSE(duplicate);
} catch (const std::exception& ex) {
ADD_FAILURE() << "unexpected exception: " << ex.what();
}
checkStat(false);
}
// Verifies behavior without client ID.
TEST_F(ClientHandleTest, noClientId) {
// Get two queries.
Pkt6Ptr sol(new Pkt6(DHCPV6_SOLICIT, 1234));
Pkt6Ptr req(new Pkt6(DHCPV6_REQUEST, 2345));
// No client id: nothing to recognize the client.
try {
// Get a client handler.
ClientHandler client_handler;
// Try to lock it with the solicit.
bool duplicate = false;
EXPECT_NO_THROW(duplicate = !client_handler.tryLock(sol));
// Should return false (no duplicate).
EXPECT_FALSE(duplicate);
// Get a second client handler.
ClientHandler client_handler2;
// Try to lock it with a request.
EXPECT_NO_THROW(duplicate = !client_handler2.tryLock(req));
// Should return false (no duplicate).
EXPECT_FALSE(duplicate);
} catch (const std::exception& ex) {
ADD_FAILURE() << "unexpected exception: " << ex.what();
}
checkStat(false);
}
// Verifies the query is required.
TEST_F(ClientHandleTest, noQuery) {
Pkt6Ptr no_pkt;
try {
// Get a client handler.
ClientHandler client_handler;
EXPECT_THROW(client_handler.tryLock(no_pkt), InvalidParameter);
} catch (const std::exception& ex) {
ADD_FAILURE() << "unexpected exception: " << ex.what();
}
}
// Verifies that double tryLock call fails.
TEST_F(ClientHandleTest, doubleTryLock) {
// Get a query.
Pkt6Ptr sol(new Pkt6(DHCPV6_SOLICIT, 1234));
sol->addOption(generateClientId());
try {
// Get a client handler.
ClientHandler client_handler;
// Try to lock it.
bool duplicate = false;
EXPECT_NO_THROW(duplicate = !client_handler.tryLock(sol));
// Should return false (no duplicate).
EXPECT_FALSE(duplicate);
// Try to lock a second time.
EXPECT_THROW(client_handler.tryLock(sol), Unexpected);
} catch (const std::exception& ex) {
ADD_FAILURE() << "unexpected exception: " << ex.what();
}
}
// Cannot verifies that empty client ID fails because getClientId() handles
// this condition and replaces it by no client ID.
// Verifies behavior with two queries for the same client and multi-threading.
TEST_F(ClientHandleTest, serializeTwoQueries) {
// Get two queries.
Pkt6Ptr sol(new Pkt6(DHCPV6_SOLICIT, 1234));
Pkt6Ptr req(new Pkt6(DHCPV6_REQUEST, 2345));
OptionPtr client_id = generateClientId();
// Same client ID: same client.
sol->addOption(client_id);
req->addOption(client_id);
// Start multi-threading.
EXPECT_NO_THROW(MultiThreadingMgr::instance().apply(true, 1, 0));
try {
// Get a client handler.
ClientHandler client_handler;
// Create a continuation.
ContinuationPtr cont1 =
makeContinuation(std::bind(&ClientHandleTest::setCalled1, this));
// Try to lock it with the solicit.
bool duplicate = false;
EXPECT_NO_THROW(duplicate = !client_handler.tryLock(sol, cont1));
// Should return false (no duplicate).
EXPECT_FALSE(duplicate);
// Get a second client handler.
ClientHandler client_handler2;
// Create a continuation.
ContinuationPtr cont2 =
makeContinuation(std::bind(&ClientHandleTest::setCalled2, this));
// Try to lock it with a request.
EXPECT_NO_THROW(duplicate = !client_handler2.tryLock(req, cont2));
// Should return true (race with the duplicate).
EXPECT_TRUE(duplicate);
} catch (const std::exception& ex) {
ADD_FAILURE() << "unexpected exception: " << ex.what();
}
// Give the second continuation a chance.
waitForThreads();
// Force multi-threading to stop;
MultiThreadingCriticalSection cs;
checkStat(false);
EXPECT_FALSE(called1_);
EXPECT_TRUE(called2_);
}
// Verifies behavior with two queries for the same client and multi-threading.
// Continuations are required for serialization.
TEST_F(ClientHandleTest, serializeNoCont) {
// Get two queries.
Pkt6Ptr sol(new Pkt6(DHCPV6_SOLICIT, 1234));
Pkt6Ptr req(new Pkt6(DHCPV6_REQUEST, 2345));
OptionPtr client_id = generateClientId();
// Same client ID: same client.
sol->addOption(client_id);
req->addOption(client_id);
// Start multi-threading.
EXPECT_NO_THROW(MultiThreadingMgr::instance().apply(true, 1, 0));
try {
// Get a client handler.
ClientHandler client_handler;
// Try to lock it with the solicit.
bool duplicate = false;
EXPECT_NO_THROW(duplicate = !client_handler.tryLock(sol));
// Should return false (no duplicate).
EXPECT_FALSE(duplicate);
// Get a second client handler.
ClientHandler client_handler2;
// Try to lock it with a request.
EXPECT_NO_THROW(duplicate = !client_handler2.tryLock(req));
// Should return true (race with the duplicate).
EXPECT_TRUE(duplicate);
} catch (const std::exception& ex) {
ADD_FAILURE() << "unexpected exception: " << ex.what();
}
// Give the second continuation a chance even there is none...
waitForThreads();
// Force multi-threading to stop;
MultiThreadingCriticalSection cs;
checkStat(true);
}
// Verifies behavior with three queries for the same client and
// multi-threading: currently we accept only two queries,
// a third one replaces second so we get the first (oldest) query and
// the last (newest) query when the client is busy.
TEST_F(ClientHandleTest, serializeThreeQueries) {
// Get two queries.
Pkt6Ptr sol(new Pkt6(DHCPV6_SOLICIT, 1234));
Pkt6Ptr req(new Pkt6(DHCPV6_REQUEST, 2345));
Pkt6Ptr ren(new Pkt6(DHCPV6_RENEW, 3456));
OptionPtr client_id = generateClientId();
// Same client ID: same client.
sol->addOption(client_id);
req->addOption(client_id);
ren->addOption(client_id);
// Start multi-threading.
EXPECT_NO_THROW(MultiThreadingMgr::instance().apply(true, 1, 0));
try {
// Get a client handler.
ClientHandler client_handler;
// Create a continuation.
ContinuationPtr cont1 =
makeContinuation(std::bind(&ClientHandleTest::setCalled1, this));
// Try to lock it with the solicit.
bool duplicate = false;
EXPECT_NO_THROW(duplicate = !client_handler.tryLock(sol, cont1));
// Should return false (no duplicate).
EXPECT_FALSE(duplicate);
// Get a second client handler.
ClientHandler client_handler2;
// Create a continuation.
ContinuationPtr cont2 =
makeContinuation(std::bind(&ClientHandleTest::setCalled2, this));
// Try to lock it with a request.
EXPECT_NO_THROW(duplicate = !client_handler2.tryLock(req, cont2));
// Should return true (race with the duplicate).
EXPECT_TRUE(duplicate);
// Get a third client handler.
ClientHandler client_handler3;
// Create a continuation.
ContinuationPtr cont3 =
makeContinuation(std::bind(&ClientHandleTest::setCalled3, this));
// Try to lock it with a renew.
EXPECT_NO_THROW(duplicate = !client_handler3.tryLock(ren, cont3));
// Should return true (race with the duplicate).
EXPECT_TRUE(duplicate);
} catch (const std::exception& ex) {
ADD_FAILURE() << "unexpected exception: " << ex.what();
}
// Give the second continuation a chance.
waitForThreads();
// Force multi-threading to stop;
MultiThreadingCriticalSection cs;
checkStat(true);
EXPECT_FALSE(called1_);
EXPECT_FALSE(called2_);
EXPECT_TRUE(called3_);
}
} // end of anonymous namespace
|