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
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
|
// Copyright (C) 2013-2023 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 PGSQL_LEASE_MGR_H
#define PGSQL_LEASE_MGR_H
#include <asiolink/io_service.h>
#include <dhcp/hwaddr.h>
#include <dhcpsrv/dhcpsrv_exceptions.h>
#include <dhcpsrv/lease_mgr.h>
#include <dhcpsrv/tracking_lease_mgr.h>
#include <pgsql/pgsql_connection.h>
#include <pgsql/pgsql_exchange.h>
#include <boost/scoped_ptr.hpp>
#include <boost/utility.hpp>
#include <vector>
#include <mutex>
namespace isc {
namespace dhcp {
// Forward declaration of the Lease exchange objects. These classes are defined
// in the .cc file.
class PgSqlLease4Exchange;
class PgSqlLease6Exchange;
/// @brief PostgreSQL Lease Context
///
/// This class stores the thread context for the manager pool.
/// The class is needed by all get/update/delete functions which must use one
/// or more exchanges to perform database operations.
/// Each context provides a set of such exchanges for each thread.
/// The context instances are lazy initialized by the requesting thread by using
/// the manager's createContext function and are destroyed when the manager's
/// pool instance is destroyed.
class PgSqlLeaseContext {
public:
/// @brief Constructor
///
/// @param parameters See PgSqlLeaseMgr constructor.
/// @param io_service_accessor The IOService accessor function.
/// @param db_reconnect_callback The connection recovery callback.
PgSqlLeaseContext(const db::DatabaseConnection::ParameterMap& parameters,
db::IOServiceAccessorPtr io_service_accessor,
db::DbCallback db_reconnect_callback);
/// The exchange objects are used for transfer of data to/from the database.
/// They are pointed-to objects as the contents may change in "const" calls,
/// while the rest of this object does not. (At alternative would be to
/// declare them as "mutable".)
boost::scoped_ptr<PgSqlLease4Exchange> exchange4_; ///< Exchange object
boost::scoped_ptr<PgSqlLease6Exchange> exchange6_; ///< Exchange object
/// @brief PostgreSQL connection
db::PgSqlConnection conn_;
};
/// @brief Type of pointers to contexts.
typedef boost::shared_ptr<PgSqlLeaseContext> PgSqlLeaseContextPtr;
/// @brief PostgreSQL Lease Context Pool
///
/// This class provides a pool of contexts.
/// The manager will use this class to handle available contexts.
/// There is only one ContextPool per manager per back-end, which is created
/// and destroyed by the respective manager factory class.
class PgSqlLeaseContextPool {
public:
/// @brief The vector of available contexts.
std::vector<PgSqlLeaseContextPtr> pool_;
/// @brief The mutex to protect pool access.
std::mutex mutex_;
};
/// @brief Type of pointers to context pools.
typedef boost::shared_ptr<PgSqlLeaseContextPool> PgSqlLeaseContextPoolPtr;
/// @brief PostgreSQL Lease Manager
///
/// This class provides the \ref isc::dhcp::LeaseMgr interface to the PostgreSQL
/// database. Use of this backend presupposes that a PostgreSQL database is
/// available and that the Kea schema has been created within it.
class PgSqlLeaseMgr : public TrackingLeaseMgr {
public:
/// @brief Constructor
///
/// Uses the following keywords in the parameters passed to it to
/// connect to the database:
/// - name - Name of the database to which to connect (mandatory)
/// - host - Host to which to connect (optional, defaults to "localhost")
/// - user - Username under which to connect (optional)
/// - password - Password for "user" on the database (optional)
///
/// Check the schema version and create an initial context.
///
/// @param parameters A data structure relating keywords and values
/// concerned with the database.
///
/// @throw isc::dhcp::NoDatabaseName Mandatory database name not given
/// @throw isc::db::DbOpenError Error opening the database or the schema
/// version is incorrect.
/// @throw isc::db::DbOperationError An operation on the open database has
/// failed.
PgSqlLeaseMgr(const db::DatabaseConnection::ParameterMap& parameters);
/// @brief Destructor (closes database)
virtual ~PgSqlLeaseMgr();
/// @brief Create a new context.
///
/// The database is opened with all the SQL commands pre-compiled.
///
/// @return A new (never null) context.
/// @throw isc::dhcp::NoDatabaseName Mandatory database name not given.
/// @throw isc::db::DbOperationError An operation on the open database has
/// failed.
PgSqlLeaseContextPtr createContext() const;
/// @brief Attempts to reconnect the server to the lease DB backend manager.
///
/// This is a self-rescheduling function that attempts to reconnect to the
/// server's lease DB backends after connectivity to one or more have been
/// lost. Upon entry it will attempt to reconnect via
/// @ref LeaseMgrFactory::create.
/// If this is successful, DHCP servicing is re-enabled and server returns
/// to normal operation.
///
/// If reconnection fails and the maximum number of retries has not been
/// exhausted, it will schedule a call to itself to occur at the
/// configured retry interval. DHCP service remains disabled.
///
/// If the maximum number of retries has been exhausted an error is logged
/// and the server shuts down.
///
/// This function is passed to the connection recovery mechanism. It will be
/// invoked when a connection loss is detected.
///
/// @param db_reconnect_ctl pointer to the ReconnectCtl containing the
/// configured reconnect parameters.
/// @return true if connection has been recovered, false otherwise.
static bool dbReconnect(util::ReconnectCtlPtr db_reconnect_ctl);
/// @brief Local version of getDBVersion() class method
static std::string getDBVersion();
/// @brief Adds an IPv4 lease
///
/// @param lease lease to be added
///
/// @result true if the lease was added, false if not (because a lease
/// with the same address was already there).
///
/// @throw isc::db::DbOperationError An operation on the open database has
/// failed.
virtual bool addLease(const Lease4Ptr& lease) override;
/// @brief Adds an IPv6 lease
///
/// @param lease lease to be added
///
/// @result true if the lease was added, false if not (because a lease
/// with the same address was already there).
///
/// @throw isc::db::DbOperationError An operation on the open database has
/// failed.
virtual bool addLease(const Lease6Ptr& lease) override;
/// @brief Returns an IPv4 lease for specified IPv4 address
///
/// This method return a lease that is associated with a given address.
/// For other query types (by hardware addr, by Client ID) there can be
/// several leases in different subnets (e.g. for mobile clients that
/// got address in different subnets). However, for a single address
/// there can be only one lease, so this method returns a pointer to
/// a single lease, not a container of leases.
///
/// @param addr address of the searched lease
///
/// @return smart pointer to the lease (or NULL if a lease is not found)
///
/// @throw isc::db::DbOperationError An operation on the open database has
/// failed.
virtual Lease4Ptr getLease4(const isc::asiolink::IOAddress& addr) const override;
/// @brief Returns existing IPv4 leases for specified hardware address.
///
/// Although in the usual case there will be only one lease, for mobile
/// clients or clients with multiple static/fixed/reserved leases there
/// can be more than one. Thus return type is a container, not a single
/// pointer.
///
/// @param hwaddr hardware address of the client
///
/// @return lease collection
///
/// @throw isc::db::DbOperationError An operation on the open database has
/// failed.
virtual Lease4Collection getLease4(const isc::dhcp::HWAddr& hwaddr) const override;
/// @brief Returns existing IPv4 leases for specified hardware address
/// and a subnet
///
/// There can be at most one lease for a given HW address in a single
/// pool, so this method with either return a single lease or NULL.
///
/// @param hwaddr hardware address of the client
/// @param subnet_id identifier of the subnet that lease must belong to
///
/// @return a pointer to the lease (or NULL if a lease is not found)
///
/// @throw isc::db::DbOperationError An operation on the open database has
/// failed.
virtual Lease4Ptr getLease4(const isc::dhcp::HWAddr& hwaddr,
SubnetID subnet_id) const override;
/// @brief Returns existing IPv4 leases for specified client-id
///
/// Although in the usual case there will be only one lease, for mobile
/// clients or clients with multiple static/fixed/reserved leases there
/// can be more than one. Thus return type is a container, not a single
/// pointer.
///
/// @param clientid client identifier
///
/// @return lease collection
///
/// @throw isc::db::DbOperationError An operation on the open database has
/// failed.
virtual Lease4Collection getLease4(const ClientId& clientid) const override;
/// @brief Returns existing IPv4 lease for specified client-id
///
/// There can be at most one lease for a given HW address in a single
/// pool, so this method with either return a single lease or NULL.
///
/// @param clientid client identifier
/// @param subnet_id identifier of the subnet that lease must belong to
///
/// @return a pointer to the lease (or NULL if a lease is not found)
///
/// @throw isc::db::DbOperationError An operation on the open database has
/// failed.
virtual Lease4Ptr getLease4(const ClientId& clientid,
SubnetID subnet_id) const override;
/// @brief Returns all IPv4 leases for the particular subnet identifier.
///
/// @param subnet_id subnet identifier.
///
/// @return Lease collection (may be empty if no IPv4 lease found).
virtual Lease4Collection getLeases4(SubnetID subnet_id) const override;
/// @brief Returns all IPv4 leases for the particular hostname.
///
/// @param hostname hostname in lower case.
///
/// @return Lease collection (may be empty if no IPv4 lease found).
virtual Lease4Collection getLeases4(const std::string& hostname) const override;
/// @brief Returns all IPv4 leases.
///
/// @return Lease collection (may be empty if no IPv4 lease found).
virtual Lease4Collection getLeases4() const override;
/// @brief Returns range of IPv4 leases using paging.
///
/// This method implements paged browsing of the lease database. The first
/// parameter specifies a page size. The second parameter is optional and
/// specifies the starting address of the range. This address is excluded
/// from the returned range. The IPv4 zero address (default) denotes that
/// the first page should be returned. There is no guarantee about the
/// order of returned leases.
///
/// The typical usage of this method is as follows:
/// - Get the first page of leases by specifying IPv4 zero address as the
/// beginning of the range.
/// - Last address of the returned range should be used as a starting
/// address for the next page in the subsequent call.
/// - If the number of leases returned is lower than the page size, it
/// indicates that the last page has been retrieved.
/// - If there are no leases returned it indicates that the previous page
/// was the last page.
///
/// @param lower_bound_address IPv4 address used as lower bound for the
/// returned range.
/// @param page_size maximum size of the page returned.
///
/// @return Lease collection (may be empty if no IPv4 lease found).
virtual Lease4Collection
getLeases4(const asiolink::IOAddress& lower_bound_address,
const LeasePageSize& page_size) const override;
/// @brief Returns existing IPv6 lease for a given IPv6 address.
///
/// For a given address, we assume that there will be only one lease.
/// The assumption here is that there will not be site or link-local
/// addresses used, so there is no way of having address duplication.
///
/// @param type specifies lease type: (NA, TA or PD)
/// @param addr address of the searched lease
///
/// @return smart pointer to the lease (or NULL if a lease is not found)
///
/// @throw isc::BadValue record retrieved from database had an invalid
/// lease type field.
/// @throw isc::db::DbOperationError An operation on the open database has
/// failed.
virtual Lease6Ptr getLease6(Lease::Type type,
const isc::asiolink::IOAddress& addr) const override;
/// @brief Returns existing IPv6 leases for a given DUID+IA combination
///
/// Although in the usual case there will be only one lease, for mobile
/// clients or clients with multiple static/fixed/reserved leases there
/// can be more than one. Thus return type is a container, not a single
/// pointer.
///
/// @param type specifies lease type: (NA, TA or PD)
/// @param duid client DUID
/// @param iaid IA identifier
///
/// @return smart pointer to the lease (or NULL if a lease is not found)
///
/// @throw isc::BadValue record retrieved from database had an invalid
/// lease type field.
/// @throw isc::db::DbOperationError An operation on the open database has
/// failed.
virtual Lease6Collection getLeases6(Lease::Type type, const DUID& duid,
uint32_t iaid) const override;
/// @brief Returns existing IPv6 lease for a given DUID+IA combination
///
/// @param type specifies lease type: (NA, TA or PD)
/// @param duid client DUID
/// @param iaid IA identifier
/// @param subnet_id subnet id of the subnet the lease belongs to
///
/// @return lease collection (may be empty if no lease is found)
///
/// @throw isc::BadValue record retrieved from database had an invalid
/// lease type field.
/// @throw isc::db::DbOperationError An operation on the open database has
/// failed.
virtual Lease6Collection getLeases6(Lease::Type type, const DUID& duid,
uint32_t iaid, SubnetID subnet_id) const override;
/// @brief Returns all IPv6 leases for the particular subnet identifier.
///
/// @param subnet_id subnet identifier.
///
/// @return Lease collection (may be empty if no IPv6 lease found).
virtual Lease6Collection getLeases6(SubnetID subnet_id) const override;
/// @brief Returns all IPv6 leases for the particular hostname.
///
/// @param hostname hostname in lower case.
///
/// @return Lease collection (may be empty if no IPv6 lease found).
virtual Lease6Collection getLeases6(const std::string& hostname) const override;
/// @brief Returns all IPv6 leases.
///
/// @return Lease collection (may be empty if no IPv6 lease found).
virtual Lease6Collection getLeases6() const override;
/// @brief Returns all IPv6 leases for the DUID.
///
/// @todo: implement an optimised of the query using index.
/// @return Lease collection (may be empty if no IPv6 lease found)
/// for the DUID.
virtual Lease6Collection getLeases6(const DUID& duid) const override;
/// @brief Returns range of IPv6 leases using paging.
///
/// This method implements paged browsing of the lease database. The first
/// parameter specifies a page size. The second parameter is optional and
/// specifies the starting address of the range. This address is excluded
/// from the returned range. The IPv6 zero address (default) denotes that
/// the first page should be returned. There is no guarantee about the
/// order of returned leases.
///
/// The typical usage of this method is as follows:
/// - Get the first page of leases by specifying IPv6 zero address as the
/// beginning of the range.
/// - Last address of the returned range should be used as a starting
/// address for the next page in the subsequent call.
/// - If the number of leases returned is lower than the page size, it
/// indicates that the last page has been retrieved.
/// - If there are no leases returned it indicates that the previous page
/// was the last page.
///
/// @param lower_bound_address IPv6 address used as lower bound for the
/// returned range.
/// @param page_size maximum size of the page returned.
///
/// @return Lease collection (may be empty if no IPv6 lease found).
virtual Lease6Collection
getLeases6(const asiolink::IOAddress& lower_bound_address,
const LeasePageSize& page_size) const override;
/// @brief Returns a collection of expired DHCPv4 leases.
///
/// This method returns at most @c max_leases expired leases. The leases
/// returned haven't been reclaimed, i.e. the database query must exclude
/// reclaimed leases from the results returned.
///
/// @param [out] expired_leases A container to which expired leases returned
/// by the database backend are added.
/// @param max_leases A maximum number of leases to be returned. If this
/// value is set to 0, all expired (but not reclaimed) leases are returned.
virtual void getExpiredLeases4(Lease4Collection& expired_leases,
const size_t max_leases) const override;
/// @brief Returns a collection of expired DHCPv6 leases.
///
/// This method returns at most @c max_leases expired leases. The leases
/// returned haven't been reclaimed, i.e. the database query must exclude
/// reclaimed leases from the results returned.
///
/// @param [out] expired_leases A container to which expired leases returned
/// by the database backend are added.
/// @param max_leases A maximum number of leases to be returned. If this
/// value is set to 0, all expired (but not reclaimed) leases are returned.
virtual void getExpiredLeases6(Lease6Collection& expired_leases,
const size_t max_leases) const override;
/// @brief Updates IPv4 lease.
///
/// Updates the record of the lease in the database (as identified by the
/// address) with the data in the passed lease object.
///
/// @param lease4 The lease to be updated.
///
/// @throw isc::dhcp::NoSuchLease Attempt to update a lease that did not
/// exist.
/// @throw isc::db::DbOperationError An operation on the open database has
/// failed.
///
/// @note The current_cltt_ and current_valid_lft_ are used to maximize the
/// chance that only one thread or process performs an update or delete
/// operation on the lease by matching these values with the expiration time
/// data in the database.
/// @note The UPDATE query uses WHERE expire = ? to update the lease only if
/// the value matches the one received on the SELECT query, effectively
/// enforcing no update on the lease between SELECT and UPDATE with
/// different expiration time.
virtual void updateLease4(const Lease4Ptr& lease4) override;
/// @brief Updates IPv6 lease.
///
/// Updates the record of the lease in the database (as identified by the
/// address) with the data in the passed lease object.
///
/// @param lease6 The lease to be updated.
///
/// @throw isc::dhcp::NoSuchLease Attempt to update a lease that did not
/// exist.
/// @throw isc::db::DbOperationError An operation on the open database has
/// failed.
///
/// @note The current_cltt_ and current_valid_lft_ are used to maximize the
/// chance that only one thread or process performs an update or delete
/// operation on the lease by matching these values with the expiration time
/// data in the database.
/// @note The UPDATE query uses WHERE expire = ? to update the lease only if
/// the value matches the one received on the SELECT query, effectively
/// enforcing no update on the lease between SELECT and UPDATE with
/// different expiration time.
virtual void updateLease6(const Lease6Ptr& lease6) override;
/// @brief Deletes an IPv4 lease.
///
/// @param lease IPv4 lease being deleted.
///
/// @return true if deletion was successful, false if no such lease exists.
///
/// @note The current_cltt_ and current_valid_lft_ are used to maximize the
/// chance that only one thread or process performs an update or delete
/// operation on the lease by matching these values with the expiration time
/// data in the database.
/// @note The DELETE query uses WHERE expire = ? to delete the lease only if
/// the value matches the one received on the SELECT query, effectively
/// enforcing no update on the lease between SELECT and DELETE with
/// different expiration time.
virtual bool deleteLease(const Lease4Ptr& lease) override;
/// @brief Deletes an IPv6 lease.
///
/// @param lease IPv6 lease being deleted.
///
/// @return true if deletion was successful, false if no such lease exists.
///
/// @note The current_cltt_ and current_valid_lft_ are used to maximize the
/// chance that only one thread or process performs an update or delete
/// operation on the lease by matching these values with the expiration time
/// data in the database.
/// @note The DELETE query uses WHERE expire = ? to delete the lease only if
/// the value matches the one received on the SELECT query, effectively
/// enforcing no update on the lease between SELECT and DELETE with
/// different expiration time.
virtual bool deleteLease(const Lease6Ptr& lease) override;
/// @brief Deletes all expired-reclaimed DHCPv4 leases.
///
/// @param secs Number of seconds since expiration of leases before
/// they can be removed. Leases which have expired later than this
/// time will not be deleted.
///
/// @return Number of leases deleted.
virtual uint64_t deleteExpiredReclaimedLeases4(const uint32_t secs) override;
/// @brief Deletes all expired-reclaimed DHCPv6 leases.
///
/// @param secs Number of seconds since expiration of leases before
/// they can be removed. Leases which have expired later than this
/// time will not be deleted.
///
/// @return Number of leases deleted.
virtual uint64_t deleteExpiredReclaimedLeases6(const uint32_t secs) override;
/// @brief Creates and runs the IPv4 lease stats query
///
/// It creates an instance of a PgSqlLeaseStatsQuery4 and then
/// invokes its start method, which fetches its statistical data
/// result set by executing the ALL_LEASE_STATS4 query.
/// The query object is then returned.
///
/// @return The populated query as a pointer to an LeaseStatsQuery
virtual LeaseStatsQueryPtr startLeaseStatsQuery4() override;
/// @brief Creates and runs the IPv4 lease stats query for all subnets and
/// pools
///
/// LeaseMgr derivations implement this method such that it creates and
/// returns an instance of an LeaseStatsQuery whose result set has been
/// populated with up to date IPv4 lease statistical data for all subnets
/// and pools.
/// Each row of the result set is an LeaseStatRow which ordered ascending
/// by subnet ID and pool ID.
///
/// @return A populated LeaseStatsQuery
virtual LeaseStatsQueryPtr startPoolLeaseStatsQuery4() override;
/// @brief Creates and runs the IPv4 lease stats query for a single subnet
///
/// It creates an instance of a PgSqlLeaseStatsQuery4 for a single subnet
/// query and then invokes its start method in which the query constructs its
/// statistical data result set. The query object is then returned.
///
/// @param subnet_id id of the subnet for which stats are desired
/// @return A populated LeaseStatsQuery
virtual LeaseStatsQueryPtr startSubnetLeaseStatsQuery4(const SubnetID& subnet_id) override;
/// @brief Creates and runs the IPv4 lease stats query for a single subnet
///
/// It creates an instance of a PgSqlLeaseStatsQuery4 for a subnet range
/// query and then invokes its start method in which the query constructs its
/// statistical data result set. The query object is then returned.
///
/// @param first_subnet_id first subnet in the range of subnets
/// @param last_subnet_id last subnet in the range of subnets
/// @return A populated LeaseStatsQuery
virtual LeaseStatsQueryPtr startSubnetRangeLeaseStatsQuery4(const SubnetID& first_subnet_id,
const SubnetID& last_subnet_id) override;
/// @brief Creates and runs the IPv6 lease stats query
///
/// It creates an instance of a PgSqlLeaseStatsQuery and then
/// invokes its start method, which fetches its statistical data
/// result set by executing the ALL_LEASE_STATS6 query.
/// The query object is then returned.
///
/// @return The populated query as a pointer to an LeaseStatsQuery
virtual LeaseStatsQueryPtr startLeaseStatsQuery6() override;
/// @brief Creates and runs the IPv6 lease stats query for all subnets and
/// pools
///
/// LeaseMgr derivations implement this method such that it creates and
/// returns an instance of an LeaseStatsQuery whose result set has been
/// populated with up to date IPv6 lease statistical data for all subnets
/// and pools.
/// Each row of the result set is an LeaseStatRow which ordered ascending
/// by subnet ID and pool ID.
///
/// @return A populated LeaseStatsQuery
virtual LeaseStatsQueryPtr startPoolLeaseStatsQuery6() override;
/// @brief Creates and runs the IPv6 lease stats query for a single subnet
///
/// It creates an instance of a PgSqlLeaseStatsQuery6 for a single subnet
/// query and then invokes its start method in which the query constructs its
/// statistical data result set. The query object is then returned.
///
/// @param subnet_id id of the subnet for which stats are desired
/// @return A populated LeaseStatsQuery
virtual LeaseStatsQueryPtr startSubnetLeaseStatsQuery6(const SubnetID& subnet_id) override;
/// @brief Creates and runs the IPv6 lease stats query for a single subnet
///
/// It creates an instance of a PgSqlLeaseStatsQuery6 for a subnet range
/// query and then invokes its start method in which the query constructs its
/// statistical data result set. The query object is then returned.
///
/// @param first_subnet_id first subnet in the range of subnets
/// @param last_subnet_id last subnet in the range of subnets
/// @return A populated LeaseStatsQuery
virtual LeaseStatsQueryPtr startSubnetRangeLeaseStatsQuery6(const SubnetID& first_subnet_id,
const SubnetID& last_subnet_id) override;
/// @brief Removes specified IPv4 leases.
///
/// This rather dangerous method is able to remove all leases from specified
/// subnet.
///
/// @todo: Not implemented yet.
///
/// @param subnet_id identifier of the subnet
/// @return number of leases removed.
virtual size_t wipeLeases4(const SubnetID& subnet_id) override;
/// @brief Removed specified IPv6 leases.
///
/// This rather dangerous method is able to remove all leases from specified
/// subnet.
///
/// @todo: Not implemented yet.
///
/// @param subnet_id identifier of the subnet
/// @return number of leases removed.
virtual size_t wipeLeases6(const SubnetID& subnet_id) override;
/// @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 override {
return (std::string("postgresql"));
}
/// @brief Returns backend name.
///
/// Each backend have specific name.
///
/// @return Name of the backend.
virtual std::string getName() const override;
/// @brief Returns description of the backend.
///
/// This description may be multiline text that describes the backend.
///
/// @return Description of the backend.
virtual std::string getDescription() const override;
/// @brief Returns backend version.
///
/// @return Version number as a pair of unsigned integers. "first" is the
/// major version number, "second" the minor number.
///
/// @throw isc::db::DbOperationError An operation on the open database has
/// failed.
virtual std::pair<uint32_t, uint32_t> getVersion() const override;
/// @brief Commit Transactions
///
/// Commits all pending database operations. On databases that don't
/// support transactions, this is a no-op.
///
/// PostgreSQL supports transactions but this manager does not use them.
virtual void commit() override;
/// @brief Rollback Transactions
///
/// Rolls back all pending database operations. On databases that don't
/// support transactions, this is a no-op.
///
/// PostgreSQL supports transactions but this manager does not use them.
virtual void rollback() override;
/// @brief Statement Tags
///
/// The contents of the enum are indexes into the list of compiled SQL
/// statements
enum StatementIndex {
DELETE_LEASE4, // Delete from lease4 by address
DELETE_LEASE4_STATE_EXPIRED, // Delete expired lease4 in a given state
DELETE_LEASE6, // Delete from lease6 by address
DELETE_LEASE6_STATE_EXPIRED, // Delete expired lease6 in a given state
GET_LEASE4, // Get all IPv4 leases
GET_LEASE4_ADDR, // Get lease4 by address
GET_LEASE4_CLIENTID, // Get lease4 by client ID
GET_LEASE4_CLIENTID_SUBID, // Get lease4 by client ID & subnet ID
GET_LEASE4_HWADDR, // Get lease4 by HW address
GET_LEASE4_HWADDR_SUBID, // Get lease4 by HW address & subnet ID
GET_LEASE4_PAGE, // Get page of leases beginning with an address
GET_LEASE4_UCTX_PAGE, // Get page of leases with user context
GET_LEASE4_SUBID, // Get IPv4 leases by subnet ID
GET_LEASE4_HOSTNAME, // Get IPv4 leases by hostname
GET_LEASE4_EXPIRE, // Get lease4 by expiration.
GET_LEASE4_RELAYID, // Get page of lease by relay ID.
GET_LEASE4_RELAYID_QST, // Get page of leases by relay ID and query start time.
GET_LEASE4_RELAYID_QSET, // Get page of leases by relay ID and query start and end times.
GET_LEASE4_RELAYID_QET, // Get page of leases by relay ID and query end time.
GET_LEASE4_REMOTEID, // Get page of lease by remote ID.
GET_LEASE4_REMOTEID_QST, // Get page of leases by remote ID and query start time.
GET_LEASE4_REMOTEID_QSET, // Get page of leases by remote ID and query start and end times.
GET_LEASE4_REMOTEID_QET, // Get page of leases by remote ID and query end time.
GET_LEASE6, // Get all IPv6 leases
GET_LEASE6_ADDR, // Get lease6 by address
GET_LEASE6_DUID_IAID, // Get lease6 by DUID and IAID
GET_LEASE6_DUID_IAID_SUBID, // Get lease6 by DUID, IAID and subnet ID
GET_LEASE6_PAGE, // Get page of leases beginning with an address
GET_LEASE6_UCTX_PAGE, // Get page of leases with user context
GET_LEASE6_SUBID, // Get IPv6 leases by subnet ID
GET_LEASE6_DUID, // Get IPv6 leases by DUID
GET_LEASE6_HOSTNAME, // Get IPv6 leases by hostname
GET_LEASE6_EXPIRE, // Get lease6 by expiration.
GET_LEASE6_LINK, // Get page of lease6 by link
INSERT_LEASE4, // Add entry to lease4 table
INSERT_LEASE6, // Add entry to lease6 table
UPDATE_LEASE4, // Update a Lease4 entry
UPDATE_LEASE6, // Update a Lease6 entry
ALL_LEASE4_STATS, // Fetches IPv4 lease statistics
SUBNET_LEASE4_STATS, // Fetched IPv4 lease stats for a single subnet.
SUBNET_RANGE_LEASE4_STATS, // Fetched IPv4 lease stats for a subnet range.
ALL_POOL_LEASE4_STATS, // Fetches IPv4 lease pool statistics
ALL_LEASE6_STATS, // Fetches IPv6 lease statistics
SUBNET_LEASE6_STATS, // Fetched IPv6 lease stats for a single subnet.
SUBNET_RANGE_LEASE6_STATS, // Fetched IPv6 lease stats for a subnet range.
ALL_POOL_LEASE6_STATS, // Fetches IPv6 lease pool statistics
CHECK_LEASE4_LIMITS, // Check if allocated IPv4 leases are inside the set limits.
CHECK_LEASE6_LIMITS, // Check if allocated IPv6 leases are inside the set limits.
IS_JSON_SUPPORTED, // Checks if JSON support is enabled in the database.
GET_LEASE4_COUNT_BY_CLASS, // Fetches the IPv4 lease count for a given class.
GET_LEASE6_COUNT_BY_CLASS, // Fetches the IPv6 lease count for given class and lease type.
NUM_STATEMENTS // Number of statements
};
private:
/// @brief Add Lease Common Code
///
/// This method performs the common actions for both flavours (V4 and V6)
/// of the addLease method. It binds the contents of the lease object to
/// the prepared statement and adds it to the database.
///
/// @param ctx Context
/// @param stindex Index of statement being executed
/// @param bind_array array that has been created for the type
/// of lease in question.
///
/// @return true if the lease was added, false if it was not added because
/// a lease with that address already exists in the database.
///
/// @throw isc::db::DbOperationError An operation on the open database has
/// failed.
bool addLeaseCommon(PgSqlLeaseContextPtr& ctx,
StatementIndex stindex,
db::PsqlBindArray& bind_array);
/// @brief Get Lease Collection Common Code
///
/// This method performs the common actions for obtaining multiple leases
/// from the database.
///
/// @param ctx Context
/// @param stindex Index of statement being executed
/// @param bind_array array for input parameters
/// @param exchange Exchange object to use
/// @param result Returned collection of leases. Note that any leases in
/// the collection when this method is called are not erased: the
/// new data is appended to the end.
/// @param single If true, only a single data item is to be retrieved.
/// If more than one is present, a MultipleRecords exception will
/// be thrown.
///
/// @throw isc::dhcp::BadValue Data retrieved from the database was invalid.
/// @throw isc::db::DbOperationError An operation on the open database has
/// failed.
/// @throw isc::db::MultipleRecords Multiple records were retrieved
/// from the database where only one was expected.
template <typename Exchange, typename LeaseCollection>
void getLeaseCollection(PgSqlLeaseContextPtr& ctx,
StatementIndex stindex,
db::PsqlBindArray& bind_array,
Exchange& exchange, LeaseCollection& result,
bool single = false) const;
/// @brief Get Lease4 Collection
///
/// Gets a collection of Lease4 objects. This is just an interface to
/// the get lease collection common code.
///
/// @param ctx Context
/// @param stindex Index of statement being executed
/// @param bind_array array for input parameters
/// @param result LeaseCollection object returned. Note that any leases in
/// the collection when this method is called are not erased: the
/// new data is appended to the end.
///
/// @throw isc::dhcp::BadValue Data retrieved from the database was invalid.
/// @throw isc::db::DbOperationError An operation on the open database has
/// failed.
/// @throw isc::db::MultipleRecords Multiple records were retrieved
/// from the database where only one was expected.
void getLeaseCollection(PgSqlLeaseContextPtr& ctx,
StatementIndex stindex,
db::PsqlBindArray& bind_array,
Lease4Collection& result) const {
getLeaseCollection(ctx, stindex, bind_array, ctx->exchange4_, result);
}
/// @brief Get Lease6 Collection
///
/// Gets a collection of Lease6 objects. This is just an interface to
/// the get lease collection common code.
///
/// @param ctx Context
/// @param stindex Index of statement being executed
/// @param bind_array array for input parameters
/// @param result LeaseCollection object returned. Note that any existing
/// data in the collection is erased first.
///
/// @throw isc::dhcp::BadValue Data retrieved from the database was invalid.
/// @throw isc::db::DbOperationError An operation on the open database has
/// failed.
/// @throw isc::db::MultipleRecords Multiple records were retrieved
/// from the database where only one was expected.
void getLeaseCollection(PgSqlLeaseContextPtr& ctx,
StatementIndex stindex,
db::PsqlBindArray& bind_array,
Lease6Collection& result) const {
getLeaseCollection(ctx, stindex, bind_array, ctx->exchange6_, result);
}
/// @brief Get Lease4 Common Code
///
/// This method performs the common actions for the various getLease4()
/// methods. It acts as an interface to the getLeaseCollection() method,
/// but retrieving only a single lease.
///
/// @param ctx Context
/// @param stindex Index of statement being executed
/// @param bind_array array for input parameters
/// @param result Lease4 object returned
void getLease(PgSqlLeaseContextPtr& ctx,
StatementIndex stindex,
db::PsqlBindArray& bind_array,
Lease4Ptr& result) const;
/// @brief Get Lease6 Common Code
///
/// This method performs the common actions for the various getLease6()
/// methods. It acts as an interface to the getLeaseCollection() method,
/// but retrieving only a single lease.
///
/// @param ctx Context
/// @param stindex Index of statement being executed
/// @param bind_array array for input parameters
/// @param result Lease6 object returned
void getLease(PgSqlLeaseContextPtr& ctx,
StatementIndex stindex,
db::PsqlBindArray& bind_array,
Lease6Ptr& result) const;
/// @brief Get expired leases common code.
///
/// This method retrieves expired and not reclaimed leases from the
/// lease database. The returned leases are ordered by the expiration
/// time. The maximum number of leases to be returned is specified
/// as an argument.
///
/// @param [out] expired_leases Reference to the container where the
/// retrieved leases are put.
/// @param max_leases Maximum number of leases to be returned.
/// @param statement_index One of the @c GET_LEASE4_EXPIRE or
/// @c GET_LEASE6_EXPIRE.
///
/// @tparam One of the @c Lease4Collection or @c Lease6Collection.
template<typename LeaseCollection>
void getExpiredLeasesCommon(LeaseCollection& expired_leases,
const size_t max_leases,
StatementIndex statement_index) const;
/// @brief Update lease common code
///
/// Holds the common code for updating a lease. It binds the parameters
/// to the prepared statement, executes it, then checks how many rows
/// were affected.
///
/// @param ctx Context
/// @param stindex Index of prepared statement to be executed
/// @param bind_array Array containing lease values and where clause
/// parameters for the update.
/// @param lease Pointer to the lease object whose record is being updated.
///
/// @throw NoSuchLease Could not update a lease because no lease matches
/// the address given.
/// @throw isc::db::DbOperationError An operation on the open database has
/// failed.
template <typename LeasePtr>
void updateLeaseCommon(PgSqlLeaseContextPtr& ctx,
StatementIndex stindex,
db::PsqlBindArray& bind_array,
const LeasePtr& lease);
/// @brief Delete lease common code
///
/// Holds the common code for deleting a lease. It binds the parameters
/// to the prepared statement, executes the statement and checks to
/// see how many rows were deleted.
///
/// @param ctx Context
/// @param stindex Index of prepared statement to be executed
/// @param bind_array Array containing lease values and where clause
/// parameters for the delete
///
/// @return Number of deleted leases.
///
/// @throw isc::db::DbOperationError An operation on the open database has
/// failed.
uint64_t deleteLeaseCommon(PgSqlLeaseContextPtr& ctx,
StatementIndex stindex,
db::PsqlBindArray& bind_array);
/// @brief Delete expired-reclaimed leases.
///
/// @param secs Number of seconds since expiration of leases before
/// they can be removed. Leases which have expired later than this
/// time will not be deleted.
/// @param statement_index One of the @c DELETE_LEASE4_STATE_EXPIRED or
/// @c DELETE_LEASE6_STATE_EXPIRED.
///
/// @return Number of leases deleted.
uint64_t deleteExpiredReclaimedLeasesCommon(const uint32_t secs,
StatementIndex statement_index);
/// @brief Checks if the lease limits set in the given user context are exceeded.
/// Contains common logic used by @ref checkLimits4 and @ref checkLimits6.
///
/// @param user_context all or part of the lease's user context which, for the intents and
/// purposes of lease limiting should have the following format
/// (not all nodes are mandatory and values are given only as examples):
/// { "ISC": { "limits": { "client-classes": [ { "name": "foo", "address-limit": 2, "prefix-limit": 1 } ],
/// "subnet": { "id": 1, "address-limit": 2, "prefix-limit": 1 } } } }
///
/// @return a string describing a limit that is being exceeded, or an empty
/// string if no limits are exceeded
std::string
checkLimits(isc::data::ConstElementPtr const& user_context, StatementIndex const stindex) const;
/// @brief Checks if the IPv4 lease limits set in the given user context are exceeded.
/// PostgreSQL implementation.
///
/// @param user_context all or part of the lease's user context which, for the intents and
/// purposes of lease limiting should have the following format
/// (not all nodes are mandatory and values are given only as examples):
/// { "ISC": { "limits": { "client-classes": [ { "name": "foo", "address-limit": 2 } ],
/// "subnet": { "id": 1, "address-limit": 2 } } } }
///
/// @return a string describing a limit that is being exceeded, or an empty
/// string if no limits are exceeded
virtual std::string
checkLimits4(isc::data::ConstElementPtr const& user_context) const override;
/// @brief Checks if the IPv6 lease limits set in the given user context are exceeded.
/// MySQL implementation.
///
/// @param user_context all or part of the lease's user context which, for the intents and
/// purposes of lease limiting should have the following format
/// (not all nodes are mandatory and values are given only as examples):
/// { "ISC": { "limits": { "client-classes": [ { "name": "foo", "address-limit": 2, "prefix-limit": 1 } ],
/// "subnet": { "id": 1, "address-limit": 2, "prefix-limit": 1 } } } }
///
/// @return a string describing a limit that is being exceeded, or an empty
/// string if no limits are exceeded
virtual std::string
checkLimits6(isc::data::ConstElementPtr const& user_context) const override;
/// @brief Checks if JSON support is enabled in the database.
/// PostgreSQL implementation.
///
/// @return true if there is JSON support, false otherwise
virtual bool isJsonSupported() const override;
/// @brief Returns the class lease count for a given class and lease type.
///
/// @param client_class client class for which the count is desired
/// @param ltype type of lease for which the count is desired. Defaults to
/// Lease::TYPE_V4.
///
/// @return number of leases
virtual size_t getClassLeaseCount(const ClientClass& client_class,
const Lease::Type& ltype = Lease::TYPE_V4) const override;
/// @brief Recount the leases per class for V4 leases.
virtual void recountClassLeases4() override;
/// @brief Recount the leases per class for V6 leases.
virtual void recountClassLeases6() override;
/// @brief Clears the class-lease count map.
virtual void clearClassLeaseCounts() override;
/// The following queries are used to fulfill Bulk Lease Query
/// queries. They rely on relay data contained in lease's
/// user-context when the extended-store-info flag is enabled.
/// @brief Returns existing IPv4 leases with a given relay-id.
///
/// @param relay_id RAI Relay-ID sub-option value for relay_id of interest
/// @param lower_bound_address IPv4 address used as lower bound for the
/// returned range.
/// @param page_size maximum size of the page returned.
/// @param qry_start_time when not zero, only leases whose CLTT is greater than
/// or equal to this value will be included
/// @param qry_end_time when not zero, only leases whose CLTT is less than
/// or equal to this value will be included
///
/// @return collection of IPv4 leases
virtual Lease4Collection
getLeases4ByRelayId(const OptionBuffer& relay_id,
const asiolink::IOAddress& lower_bound_address,
const LeasePageSize& page_size,
const time_t& qry_start_time = 0,
const time_t& qry_end_time = 0) override;
/// @brief Returns existing IPv4 leases with a given remote-id.
///
/// @param remote_id RAI Remote-ID sub-option value for remote-id of interest
/// @param lower_bound_address IPv4 address used as lower bound for the
/// returned range.
/// @param page_size maximum size of the page returned.
/// @param qry_start_time when not zero, only leases whose CLTT is greater than
/// or equal to this value will be included. Defaults to zero.
/// @param qry_end_time when not zero, only leases whose CLTT is less than
/// or equal to this value will be included. Defaults to zero.
///
/// @return collection of IPv4 leases
virtual Lease4Collection
getLeases4ByRemoteId(const OptionBuffer& remote_id,
const asiolink::IOAddress& lower_bound_address,
const LeasePageSize& page_size,
const time_t& qry_start_time = 0,
const time_t& qry_end_time = 0) override;
/// @brief Returns existing IPv6 leases with a given relay-id.
///
/// @param relay_id DUID for relay_id of interest.
/// @param link_addr limit results to leases on this link (prefix).
/// @param link_len limit results to leases on this link (length).
/// @param lower_bound_address IPv4 address used as lower bound for the
/// returned range.
/// @param page_size maximum size of the page returned.
///
/// @return collection of IPv6 leases
virtual Lease6Collection
getLeases6ByRelayId(const DUID& relay_id,
const asiolink::IOAddress& link_addr,
uint8_t link_len,
const asiolink::IOAddress& lower_bound_address,
const LeasePageSize& page_size) override;
/// @brief Returns existing IPv6 leases with a given remote-id.
///
/// @param remote_id remote-id option data of interest.
/// @param link_addr limit results to leases on this link (prefix).
/// @param link_len limit results to leases on this link (length).
/// @param lower_bound_address IPv4 address used as lower bound for the
/// returned range.
/// @param page_size maximum size of the page returned.
///
/// @return collection of IPv6 leases
virtual Lease6Collection
getLeases6ByRemoteId(const OptionBuffer& remote_id,
const asiolink::IOAddress& link_addr,
uint8_t link_len,
const asiolink::IOAddress& lower_bound_address,
const LeasePageSize& page_size) override;
/// @brief Returns existing IPv6 leases with on a given link.
///
/// @param link_addr limit results to leases on this link (prefix).
/// @param link_len limit results to leases on this link (length).
/// @param lower_bound_address IPv4 address used as lower bound for the
/// returned range.
/// @param page_size maximum size of the page returned.
///
/// @return collection of IPv6 leases
virtual Lease6Collection
getLeases6ByLink(const asiolink::IOAddress& link_addr,
uint8_t link_len,
const asiolink::IOAddress& lower_bound_address,
const LeasePageSize& page_size) override;
/// @brief Upgrade extended info (v4).
///
/// For all leases with a not null user context.
/// - sanitize the user context
/// - update relay and remote ids
/// - when the lease was modified update it in the database
/// This function implements the new BLQ hook command named
/// "extended-info4-upgrade".
///
/// @param page_size The page size used for retrieval.
/// @return The number of updates in the database.
virtual size_t upgradeExtendedInfo4(const LeasePageSize& page_size) override;
/// @brief Build extended info v6 tables.
///
/// @param update Update extended info in database.
/// @param current specify whether to use current (true) or staging
/// (false) config.
/// @return The number of updates in the database or 0.
virtual size_t buildExtendedInfoTables6(bool update, bool current) override;
/// @brief Write V4 leases to a file.
virtual void writeLeases4(const std::string& /*filename*/) override;
/// @brief Write V6 leases to a file.
virtual void writeLeases6(const std::string& /*filename*/) override;
/// @brief Context RAII allocator.
class PgSqlLeaseContextAlloc {
public:
/// @brief Constructor
///
/// This constructor takes a context of the pool if one is available
/// or creates a new one.
///
/// @param mgr A parent instance
PgSqlLeaseContextAlloc(const PgSqlLeaseMgr& mgr);
/// @brief Destructor
///
/// This destructor puts back the context in the pool.
~PgSqlLeaseContextAlloc();
/// @brief The context
PgSqlLeaseContextPtr ctx_;
private:
/// @brief The manager
const PgSqlLeaseMgr& mgr_;
};
/// @brief Context RAII allocator for lease tracking.
///
/// This context should be used in the non-const calls that
/// may trigger callbacks for lease tracking.
class PgSqlLeaseTrackingContextAlloc {
public:
/// @brief Constructor
///
/// This constructor takes a context of the pool if one is available
/// or creates a new one.
///
/// @param mgr A parent instance
/// @param lease allocated or deallocated lease instance.
PgSqlLeaseTrackingContextAlloc(PgSqlLeaseMgr& mgr, const LeasePtr& lease);
/// @brief Destructor
///
/// This destructor puts back the context in the pool.
~PgSqlLeaseTrackingContextAlloc();
/// @brief The context
PgSqlLeaseContextPtr ctx_;
private:
/// @brief The manager
PgSqlLeaseMgr& mgr_;
/// @brief Tracked lease instance.
LeasePtr lease_;
};
protected:
/// Extended information / Bulk Lease Query shared interface.
/// @brief Modifies the setting whether the lease extended info tables
/// are enabled.
///
/// Transient redefine to refuse the enable setting.
/// @param enabled new setting.
virtual void setExtendedInfoTablesEnabled(const bool enabled) override {
if (enabled) {
isc_throw(isc::NotImplemented,
"extended info tables are not yet supported by postgresql");
}
}
/// @brief Decode parameters to set whether the lease extended info tables
/// are enabled.
///
/// @note: common code in constructors.
///
/// @param parameters The parameter map.
virtual void setExtendedInfoTablesEnabled(const db::DatabaseConnection::ParameterMap& parameters) override;
/// @brief Delete lease6 extended info from tables.
///
/// @param addr The address of the lease.
virtual void deleteExtendedInfo6(const isc::asiolink::IOAddress& addr) override;
/// @brief Add lease6 extended info into by-relay-id table.
///
/// @param lease_addr The address of the lease.
/// @param relay_id The relay id from the relay header options.
virtual void addRelayId6(const isc::asiolink::IOAddress& lease_addr,
const std::vector<uint8_t>& relay_id) override;
/// @brief Add lease6 extended info into by-remote-id table.
///
/// @param lease_addr The address of the lease.
/// @param remote_id The remote id from the relay header options.
virtual void addRemoteId6(const isc::asiolink::IOAddress& lease_addr,
const std::vector<uint8_t>& remote_id) override;
private:
// Members
/// @brief The parameters
db::DatabaseConnection::ParameterMap parameters_;
/// @brief The pool of contexts
PgSqlLeaseContextPoolPtr pool_;
/// @brief Timer name used to register database reconnect timer.
std::string timer_name_;
};
} // namespace dhcp
} // namespace isc
#endif // PGSQL_LEASE_MGR_H
|