Kea 3.1.0
cfg_globals.cc
Go to the documentation of this file.
1// Copyright (C) 2021-2025 Internet Systems Consortium, Inc. ("ISC")
2//
3// This Source Code Form is subject to the terms of the Mozilla Public
4// License, v. 2.0. If a copy of the MPL was not distributed with this
5// file, You can obtain one at http://mozilla.org/MPL/2.0/.
6
7#include <config.h>
9
10using namespace isc::data;
11
12namespace isc {
13namespace dhcp {
14
15const std::map<std::string, int>
17 // Common parameters.
18 { "valid-lifetime", VALID_LIFETIME },
19 { "min-valid-lifetime", MIN_VALID_LIFETIME },
20 { "max-valid-lifetime", MAX_VALID_LIFETIME },
21 { "renew-timer", RENEW_TIMER },
22 { "rebind-timer", REBIND_TIMER },
23 { "decline-probation-period", DECLINE_PROBATION_PERIOD },
24 { "dhcp4o6-port", DHCP4O6_PORT },
25 { "comment", COMMENT },
26 { "server-tag", SERVER_TAG },
27 { "reservations-global", RESERVATIONS_GLOBAL },
28 { "reservations-in-subnet", RESERVATIONS_IN_SUBNET },
29 { "reservations-out-of-pool", RESERVATIONS_OUT_OF_POOL },
30 { "calculate-tee-times", CALCULATE_TEE_TIMES },
31 { "t1-percent", T1_PERCENT },
32 { "t2-percent", T2_PERCENT },
33 { "hostname-char-set", HOSTNAME_CHAR_SET },
34 { "hostname-char-replacement", HOSTNAME_CHAR_REPLACEMENT },
35 { "ddns-send-updates", DDNS_SEND_UPDATES },
36 { "ddns-override-no-update", DDNS_OVERRIDE_NO_UPDATE },
37 { "ddns-override-client-update", DDNS_OVERRIDE_CLIENT_UPDATE },
38 { "ddns-replace-client-name", DDNS_REPLACE_CLIENT_NAME },
39 { "ddns-generated-prefix", DDNS_GENERATED_PREFIX },
40 { "ddns-qualifying-suffix", DDNS_QUALIFYING_SUFFIX },
41 { "store-extended-info", STORE_EXTENDED_INFO },
42 { "statistic-default-sample-count", STATISTIC_DEFAULT_SAMPLE_COUNT },
43 { "statistic-default-sample-age", STATISTIC_DEFAULT_SAMPLE_AGE },
44 { "cache-threshold", CACHE_THRESHOLD },
45 { "cache-max-age", CACHE_MAX_AGE },
46 { "early-global-reservations-lookup", EARLY_GLOBAL_RESERVATIONS_LOOKUP },
47 { "ip-reservations-unique", IP_RESERVATIONS_UNIQUE },
48 { "reservations-lookup-first", RESERVATIONS_LOOKUP_FIRST },
49 { "ddns-update-on-renew", DDNS_UPDATE_ON_RENEW },
50 { "parked-packet-limit", PARKED_PACKET_LIMIT },
51 { "allocator", ALLOCATOR },
52 { "ddns-ttl-percent", DDNS_TTL_PERCENT },
53 { "ddns-conflict-resolution-mode", DDNS_CONFLICT_RESOLUTION_MODE },
54 { "compatibility", COMPATIBILITY },
55 { "dhcp-ddns", DHCP_DDNS },
56 { "expired-leases-processing", EXPIRED_LEASES_PROCESSING },
57 { "multi-threading", MULTI_THREADING },
58 { "sanity-checks", SANITY_CHECKS },
59 { "dhcp-queue-control", DHCP_QUEUE_CONTROL },
60 { "ddns-ttl", DDNS_TTL },
61 { "ddns-ttl-min", DDNS_TTL_MIN },
62 { "ddns-ttl-max", DDNS_TTL_MAX },
63 { "host-reservation-identifiers", HOST_RESERVATION_IDENTIFIERS },
64
65 // DHCPv4 specific parameters.
66 { "echo-client-id", ECHO_CLIENT_ID },
67 { "match-client-id", MATCH_CLIENT_ID },
68 { "authoritative", AUTHORITATIVE },
69 { "next-server", NEXT_SERVER },
70 { "server-hostname", SERVER_HOSTNAME },
71 { "boot-file-name", BOOT_FILE_NAME },
72 { "offer-lifetime", OFFER_LIFETIME },
73 { "stash-agent-options", STASH_AGENT_OPTIONS },
74
75 // DHCPv6 specific parameters.
76 { "data-directory", DATA_DIRECTORY },
77 { "preferred-lifetime", PREFERRED_LIFETIME },
78 { "min-preferred-lifetime", MIN_PREFERRED_LIFETIME },
79 { "max-preferred-lifetime", MAX_PREFERRED_LIFETIME },
80 { "pd-allocator", PD_ALLOCATOR },
81 { "server-id", SERVER_ID }
82};
83
84// Load time sanity check.
85namespace {
86struct CfgGlobalsChecks {
87 CfgGlobalsChecks() {
88 // Check the size for missing entries.
90 isc_throw(Unexpected, "CfgGlobals::nameToIndex has "
92 << " elements (expected " << CfgGlobals::SIZE << ")");
93 }
94
95 // Build the name vector.
96 std::vector<std::string> names;
97 names.resize(CfgGlobals::SIZE);
98 for (auto const& it : CfgGlobals::nameToIndex) {
99 int idx = it.second;
100 if ((idx < 0) || (idx >= CfgGlobals::SIZE)) {
101 isc_throw(Unexpected, "invalid index " << idx
102 << " for name " << it.first);
103 }
104 if (!names[idx].empty()) {
105 isc_throw(Unexpected, "duplicated names for " << idx
106 << " got " << names[idx]);
107 }
108 names[idx] = it.first;
109 }
110
111 // No name should be empty.
112 for (int idx = 0; idx < CfgGlobals::SIZE; ++idx) {
113 if (names[idx].empty()) {
114 isc_throw(Unexpected, "missing name for " << idx);
115 }
116 }
117 }
118};
119
120CfgGlobalsChecks check;
121} // end of anonymous namespace
122
125
127CfgGlobals::get(const std::string& name) const {
128 auto const& it = nameToIndex.find(name);
129 if (it == nameToIndex.cend()) {
130 isc_throw(NotFound, "invalid global parameter name '" << name << "'");
131 }
132 return (get(it->second));
133}
134
136CfgGlobals::get(int index) const {
137 if ((index < 0) || (index >= CfgGlobals::SIZE)) {
138 isc_throw(OutOfRange, "invalid global parameter index " << index);
139 }
140 return (values_[index]);
141}
142
143void
144CfgGlobals::set(const std::string& name, ConstElementPtr value) {
145 auto const& it = nameToIndex.find(name);
146 if (it == nameToIndex.cend()) {
147 isc_throw(NotFound, "invalid global parameter name '" << name << "'");
148 }
149
150 set(it->second, value);
151}
152
153void
155 if ((index < 0) || (index >= CfgGlobals::SIZE)) {
156 isc_throw(OutOfRange, "invalid global parameter index " << index);
157 }
158 values_[index] = value;
159}
160
161void
163 for (int idx = 0; idx < CfgGlobals::SIZE; ++idx) {
164 if (values_[idx]) {
165 values_[idx] = ConstElementPtr();
166 }
167 }
168}
169
172 MapType map;
173 for (auto const& it : nameToIndex) {
174 int idx = it.second;
175 ConstElementPtr value = values_[idx];
176 if (value) {
177 map.insert(make_pair(it.first, value));
178 }
179 }
180 return (map);
181}
182
186 for (auto const& it : nameToIndex) {
187 int idx = it.second;
188 ConstElementPtr value = values_[idx];
189 if (value) {
190 result->set(it.first, value);
191 }
192 }
193 return (result);
194}
195
196} // namespace isc::dhcp
197} // namespace isc
#define COMMENT
A generic exception that is thrown when an object can not be found.
A generic exception that is thrown if a parameter given to a method would refer to or modify out-of-r...
static ElementPtr createMap(const Position &pos=ZERO_POSITION())
Creates an empty MapElement type ElementPtr.
Definition data.cc:304
void clear()
Clear configured parameter values.
void set(const std::string &name, isc::data::ConstElementPtr value)
Set a configured parameter value by name.
const MapType valuesMap() const
Returns configured parameters as a map.
CfgGlobals()
Instance members.
static const std::map< std::string, int > nameToIndex
Name to index map.
std::map< std::string, isc::data::ConstElementPtr > MapType
Type of name and value map.
isc::data::ElementPtr toElement() const
Unparse configured global parameters.
isc::data::ConstElementPtr get(const std::string &name) const
Get a configured parameter value by name.
std::vector< isc::data::ConstElementPtr > values_
Vectors of values.
#define isc_throw(type, stream)
A shortcut macro to insert known values into exception arguments.
boost::shared_ptr< const Element > ConstElementPtr
Definition data.h:29
boost::shared_ptr< Element > ElementPtr
Definition data.h:28
Defines the logger used by the top-level component of kea-lfc.