srv_config.h 17.8 KB
Newer Older
1
// Copyright (C) 2014-2016 Internet Systems Consortium, Inc. ("ISC")
2
//
3 4 5
// 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/.
6

7 8
#ifndef DHCPSRV_CONFIG_H
#define DHCPSRV_CONFIG_H
9

10
#include <dhcpsrv/cfg_db_access.h>
11
#include <dhcpsrv/cfg_duid.h>
12
#include <dhcpsrv/cfg_expiration.h>
13
#include <dhcpsrv/cfg_hosts.h>
14
#include <dhcpsrv/cfg_iface.h>
15
#include <dhcpsrv/cfg_option.h>
16
#include <dhcpsrv/cfg_option_def.h>
17
#include <dhcpsrv/cfg_rsoo.h>
18
#include <dhcpsrv/cfg_subnets4.h>
19
#include <dhcpsrv/cfg_subnets6.h>
Tomek Mrugalski's avatar
Tomek Mrugalski committed
20
#include <dhcpsrv/cfg_mac_source.h>
21
#include <dhcpsrv/client_class_def.h>
22
#include <dhcpsrv/logging_info.h>
23
#include <cc/data.h>
24
#include <boost/shared_ptr.hpp>
25 26
#include <vector>
#include <stdint.h>
27 28 29 30

namespace isc {
namespace dhcp {

31 32
class CfgMgr;

33 34 35 36

/// @brief Specifies current DHCP configuration
///
/// @todo Migrate all other configuration parameters from cfgmgr.h here
37
class SrvConfig {
38
public:
39 40 41
    /// @name Constants for selection of parameters returned by @c getConfigSummary
    ///
    //@{
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61
    /// Nothing selected
    static const uint32_t CFGSEL_NONE    = 0x00000000;
    /// Number of IPv4 subnets
    static const uint32_t CFGSEL_SUBNET4 = 0x00000001;
    /// Number of IPv6 subnets
    static const uint32_t CFGSEL_SUBNET6 = 0x00000002;
    /// Number of enabled ifaces
    static const uint32_t CFGSEL_IFACE4  = 0x00000004;
    /// Number of v6 ifaces
    static const uint32_t CFGSEL_IFACE6  = 0x00000008;
    /// DDNS enabled/disabled
    static const uint32_t CFGSEL_DDNS    = 0x00000010;
    /// Number of all subnets
    static const uint32_t CFGSEL_SUBNET  = 0x00000003;
    /// IPv4 related config
    static const uint32_t CFGSEL_ALL4    = 0x00000015;
    /// IPv6 related config
    static const uint32_t CFGSEL_ALL6    = 0x0000001A;
    /// Whole config
    static const uint32_t CFGSEL_ALL     = 0xFFFFFFFF;
62
    //@}
63

64
    /// @brief Default constructor.
65
    ///
66
    /// This constructor sets configuration sequence number to 0.
67
    SrvConfig();
68 69 70 71

    /// @brief Constructor.
    ///
    /// Sets arbitrary configuration sequence number.
72
    SrvConfig(const uint32_t sequence);
73

74 75 76
    /// @brief Returns summary of the configuration in the textual format.
    ///
    /// This method returns the brief text describing the current configuration.
77
    /// It may be used for logging purposes, e.g. when the new configuration is
78 79 80 81 82 83
    /// committed to notify a user about the changes in configuration.
    ///
    /// @todo Currently this method uses @c CfgMgr accessors to get the
    /// configuration parameters. Once these parameters are migrated from the
    /// @c CfgMgr this method will have to be modified accordingly.
    ///
84 85 86 87
    /// @todo Implement reporting a summary of interfaces being used for
    /// receiving and sending DHCP messages. This will be implemented with
    /// ticket #3512.
    ///
88 89 90 91 92
    /// @param selection Is a bitfield which describes the parts of the
    /// configuration to be returned.
    ///
    /// @return Summary of the configuration in the textual format.
    std::string getConfigSummary(const uint32_t selection) const;
93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108

    /// @brief Returns configuration sequence number.
    uint32_t getSequence() const {
        return (sequence_);
    }

    /// @brief Compares configuration sequence with other sequence.
    ///
    /// This method compares sequence numbers of two configurations for
    /// equality. The sequence numbers are meant to be unique, so if
    /// they are equal it means that they point to the same configuration.
    ///
    /// @param other Configuration which sequence number should be
    /// compared with the sequence number of this configuration.
    ///
    /// @return true if sequence numbers are equal.
109
    bool sequenceEquals(const SrvConfig& other);
110

111 112 113 114 115 116 117
    /// @name Modifiers and accesors for the configuration objects.
    ///
    /// @warning References to the objects returned by accessors are only
    /// valid during the lifetime of the @c SrvConfig object which
    /// returned them.
    ///
    //@{
118 119 120 121 122 123 124 125 126 127 128 129
    /// @brief Returns logging specific configuration.
    const LoggingInfoStorage& getLoggingInfo() const {
        return (logging_info_);
    }

    /// @brief Sets logging specific configuration.
    ///
    /// @param logging_info New logging configuration.
    void addLoggingInfo(const LoggingInfo& logging_info) {
        logging_info_.push_back(logging_info);
    }

130
    /// @brief Returns non-const pointer to interface configuration.
131
    ///
132 133
    /// This function returns a non-const pointer to the interface
    /// configuration.
134
    ///
135 136
    /// @return Object representing configuration of interfaces.
    CfgIfacePtr getCfgIface() {
137 138 139
        return (cfg_iface_);
    }

140
    /// @brief Returns const pointer to interface configuration.
141
    ///
142 143 144 145 146 147
    /// This function returns a const pointer to the interface
    /// configuration.
    ///
    /// @return Object representing configuration of interfaces.
    ConstCfgIfacePtr getCfgIface() const {
        return (cfg_iface_);
148 149
    }

150 151
    /// @brief Return pointer to non-const object representing user-defined
    /// option definitions.
152
    ///
153 154 155 156 157 158 159 160 161 162 163 164
    /// This function returns a pointer to the object which represents the
    /// user defined option definitions grouped by option space name.
    ///
    /// @return Pointer to an object holding option definitions.
    CfgOptionDefPtr getCfgOptionDef() {
        return (cfg_option_def_);
    }

    /// @brief Returns pointer to the const object representing user-defined
    /// option definitions.
    ///
    /// This function returns a pointer to the object which represents the
165 166
    /// user defined option definitions grouped by option space name.
    ///
167 168
    /// @return Pointer to an object holding option definitions.
    ConstCfgOptionDefPtr getCfgOptionDef() const {
169 170 171
        return (cfg_option_def_);
    }

172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191
    /// @brief Returns pointer to the non-const object holding options.
    ///
    /// This method returns a pointer to the object which holds instances
    /// of the options to be returned to the clients belonging to any subnet.
    ///
    /// @return Pointer to the object holding options.
    CfgOptionPtr getCfgOption() {
        return (cfg_option_);
    }

    /// @brief Returns pointer to the const object holding options.
    ///
    /// This method returns a pointer to the object which holds instances
    /// of the options to be returned to the clients belonging to any subnet.
    ///
    /// @return Pointer to the object holding options.
    const ConstCfgOptionPtr getCfgOption() const {
        return (cfg_option_);
    }

192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207
    /// @brief Returns pointer to non-const object holding subnets configuration
    /// for DHCPv4.
    ///
    /// @return Pointer to the object holding subnets configuration for DHCPv4.
    CfgSubnets4Ptr getCfgSubnets4() {
        return (cfg_subnets4_);
    }

    /// @brief Returns pointer to const object holding subnets configuration for
    /// DHCPv4.
    ///
    /// @return Pointer to the object holding subnets configuration for DHCPv4.
    ConstCfgSubnets4Ptr getCfgSubnets4() const {
        return (cfg_subnets4_);
    }

208 209 210
    /// @brief Returns pointer to non-const object holding subnets configuration
    /// for DHCPv6.
    ///
211
    /// @return Pointer to the object holding subnets configuration for DHCPv6.
212 213 214 215 216
    CfgSubnets6Ptr getCfgSubnets6() {
        return (cfg_subnets6_);
    }

    /// @brief Returns pointer to const object holding subnets configuration for
217
    /// DHCPv6.
218 219 220 221 222 223
    ///
    /// @return Pointer to the object holding subnets configuration for DHCPv6.
    ConstCfgSubnets6Ptr getCfgSubnets6() const {
        return (cfg_subnets6_);
    }

224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239
    /// @brief Returns pointer to the non-const objects representing host
    /// reservations for different IPv4 and IPv6 subnets.
    ///
    /// @return Pointer to the non-const object holding host reservations.
    CfgHostsPtr getCfgHosts() {
        return (cfg_hosts_);
    }

    /// @brief Returns pointer to the const objects representing host
    /// reservations for different IPv4 and IPv6 subnets.
    ///
    /// @return Pointer to the const object holding host reservations.
    ConstCfgHostsPtr getCfgHosts() const {
        return (cfg_hosts_);
    }

240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257
    /// @brief Returns pointer to the non-const object representing
    /// set of RSOO-enabled options.
    ///
    /// @return Pointer to the non-const object holding RSOO-enabled
    /// options.
    CfgRSOOPtr getCfgRSOO() {
        return (cfg_rsoo_);
    }

    /// @brief Returns pointer to the const object representing set
    /// of RSOO-enabled options.
    ///
    /// @return Pointer to the const object holding RSOO-enabled
    /// options.
    ConstCfgRSOOPtr getCfgRSOO() const {
        return (cfg_rsoo_);
    }

258 259 260 261 262 263 264 265 266 267 268 269
    /// @brief Returns pointer to the object holding configuration pertaining
    /// to processing expired leases.
    CfgExpirationPtr getCfgExpiration() {
        return (cfg_expiration_);
    }

    /// @brief Returns pointer to the const object holding configuration
    /// pertaining to processing expired leases.
    ConstCfgExpirationPtr getCfgExpiration() const {
        return (cfg_expiration_);
    }

270 271 272 273 274 275 276 277 278 279 280 281
    /// @brief Returns pointer to the object holding configuration of the
    /// server identifier.
    CfgDUIDPtr getCfgDUID() {
        return (cfg_duid_);
    }

    /// @brief Returns const pointer to the object holding configuration
    /// of the server identifier.
    ConstCfgDUIDPtr getCfgDUID() const {
        return (cfg_duid_);
    }

282
    /// @brief Returns pointer to the object holding configuration of the
283 284 285 286 287 288 289 290 291 292 293
    /// lease and host database connection parameters.
    CfgDbAccessPtr getCfgDbAccess() {
        return (cfg_db_access_);
    }

    /// @brief Returns const pointer to the object holding configuration of
    /// the lease and host database connection parameters.
    ConstCfgDbAccessPtr getCfgDbAccess() const {
        return (cfg_db_access_);
    }

Tomek Mrugalski's avatar
Tomek Mrugalski committed
294
    //@}
295

Tomek Mrugalski's avatar
Tomek Mrugalski committed
296 297
    /// @brief Returns non-const reference to an array that stores
    ///        MAC/hardware address sources.
298
    ///
Tomek Mrugalski's avatar
Tomek Mrugalski committed
299 300 301
    /// @return non-const reference to MAC/hardware address sources
    CfgMACSource& getMACSources() {
        return (cfg_mac_source_);
302 303
    }

Tomek Mrugalski's avatar
Tomek Mrugalski committed
304 305 306 307 308 309
    /// @brief Returns const reference to an array that stores
    ///        MAC/hardware address sources.
    ///
    /// @return const reference to MAC/hardware address sources
    const CfgMACSource& getMACSources() const {
        return (cfg_mac_source_);
310 311
    }

312 313 314 315 316 317 318 319 320 321 322 323
    /// @brief Returns information about control socket
    /// @return pointer to the Element that holds control-socket map
    const isc::data::ConstElementPtr getControlSocketInfo() const {
        return (control_socket_);
    }

    /// @brief Sets information about the control socket
    /// @param control_socket Element that holds control-socket map
    void setControlSocketInfo(const isc::data::ConstElementPtr& control_socket) {
        control_socket_ = control_socket;
    }

324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341
    /// @brief Returns pointer to the dictionary of global client
    /// class definitions
    ClientClassDictionaryPtr getClientClassDictionary() {
        return (class_dictionary_);
    }

    /// @brief Returns pointer to const dictionary of global client
    /// class definitions
    const ClientClassDictionaryPtr getClientClassDictionary() const {
        return (class_dictionary_);
    }

    /// @brief Sets the client class dictionary
    /// @param dictionary pointer to the new class dictionary
    void setClientClassDictionary(const ClientClassDictionaryPtr& dictionary) {
        class_dictionary_ = dictionary;
    }

342 343 344 345 346 347
    /// @brief Copies the currnet configuration to a new configuration.
    ///
    /// This method copies the parameters stored in the configuration to
    /// an object passed as parameter. The configuration sequence is not
    /// copied.
    ///
348 349 350 351 352 353 354 355
    /// @warning Some of the configuration objects are not copied at
    /// this point, e.g. subnets. This is because they contain quite complex
    /// data structures and they make use of pointers, so in many cases
    /// the default copy constructors can't be used. Implementing this
    /// requires quite a lot of time so this is left as is for now.
    /// The lack of ability to copy the entire configuration makes
    /// revert function of the @c CfgMgr unsuable.
    ///
356 357
    /// @param [out] new_config An object to which the configuration will
    /// be copied.
358
    void copy(SrvConfig& new_config) const;
359

360 361 362
    /// @brief Apply logging configuration to log4cplus.
    void applyLoggingCfg() const;

363 364 365 366 367 368 369 370 371 372 373 374
    /// @name Methods and operators used to compare configurations.
    ///
    //@{
    ///
    /// @brief Compares two objects for equality.
    ///
    /// It ignores the configuration sequence number when checking for
    /// equality of objects.
    ///
    /// @param other An object to be compared with this object.
    ///
    /// @return true if two objects are equal, false otherwise.
375
    bool equals(const SrvConfig& other) const;
376 377 378 379 380 381 382 383 384

    /// @brief Compares two objects for inequality.
    ///
    /// It ignores the configuration sequence number when checking for
    /// inequality of objects.
    ///
    /// @param other An object to be compared with this object.
    ///
    /// @return true if two objects are not equal, false otherwise.
385
    bool nequals(const SrvConfig& other) const {
386 387 388 389 390 391 392 393 394 395 396
        return (!equals(other));
    }

    /// @brief Equality operator.
    ///
    /// It ignores the configuration sequence number when checking for
    /// equality of objects.
    ///
    /// @param other An object to be compared with this object.
    ///
    /// @return true if two objects are equal, false otherwise.
397
    bool operator==(const SrvConfig& other) const {
398 399 400 401 402 403 404 405 406 407 408
        return (equals(other));
    }

    /// @param other An object to be compared with this object.
    ///
    /// It ignores the configuration sequence number when checking for
    /// inequality of objects.
    ///
    /// @param other An object to be compared with this object.
    ///
    /// @return true if two objects are not equal, false otherwise.
409
    bool operator!=(const SrvConfig& other) const {
410 411 412 413 414
        return (nequals(other));
    }

    //@}

Tomek Mrugalski's avatar
Tomek Mrugalski committed
415 416 417
    /// @brief Updates statistics.
    ///
    /// This method calls appropriate methods in child objects that update
418 419
    /// related statistics. See @ref CfgSubnets4::updateStatistics and
    /// @ref CfgSubnets6::updateStatistics for details.
Tomek Mrugalski's avatar
Tomek Mrugalski committed
420 421 422 423 424
    void updateStatistics();

    /// @brief Removes statistics.
    ///
    /// This method calls appropriate methods in child objects that remove
425 426
    /// related statistics. See @ref CfgSubnets4::removeStatistics and
    /// @ref CfgSubnets6::removeStatistics for details.
Tomek Mrugalski's avatar
Tomek Mrugalski committed
427
    void removeStatistics();
428

429
    /// @brief Sets decline probation-period
Tomek Mrugalski's avatar
Tomek Mrugalski committed
430 431 432 433
    ///
    /// Probation-period is the timer, expressed, in seconds, that specifies how
    /// long a lease is unavailable after reported as declined.
    ///
434
    /// @param decline_timer number of seconds after declined lease is restored
Tomek Mrugalski's avatar
Tomek Mrugalski committed
435
    void setDeclinePeriod(const uint32_t decline_timer) {
436 437 438
        decline_timer_ = decline_timer;
    }

Tomek Mrugalski's avatar
Tomek Mrugalski committed
439 440 441 442
    /// @brief Returns probation-period
    ///
    /// See @ref setDeclinePeriod for brief discussion.
    /// @return value of probation-period, expressed in seconds
443 444 445 446
    uint32_t getDeclinePeriod() const {
        return (decline_timer_);
    }

447 448 449 450 451
private:

    /// @brief Sequence number identifying the configuration.
    uint32_t sequence_;

452 453 454
    /// @brief Logging specific information.
    LoggingInfoStorage logging_info_;

455 456 457 458
    /// @brief Interface configuration.
    ///
    /// Used to select interfaces on which the DHCP server will listen to
    /// queries.
459
    CfgIfacePtr cfg_iface_;
460

461
    /// @brief Pointer to option definitions configuration.
462 463 464
    ///
    /// This object holds the user-defined option definitions grouped
    /// by option space name.
465
    CfgOptionDefPtr cfg_option_def_;
466

467 468 469 470 471 472
    /// @brief Pointer to options (data) configuration.
    ///
    /// This object holds the instances of the options to be sent to clients
    /// connected to any subnet.
    CfgOptionPtr cfg_option_;

473 474 475
    /// @brief Pointer to subnets configuration for IPv4.
    CfgSubnets4Ptr cfg_subnets4_;

476
    /// @brief Pointer to subnets configuration for IPv6.
477 478
    CfgSubnets6Ptr cfg_subnets6_;

479 480 481 482 483 484
    /// @brief Pointer to the configuration for hosts reservation.
    ///
    /// This object holds a list of @c Host objects representing host
    /// reservations for different IPv4 and IPv6 subnets.
    CfgHostsPtr cfg_hosts_;

485
    /// @brief A list of configured MAC sources.
Tomek Mrugalski's avatar
Tomek Mrugalski committed
486
    CfgMACSource cfg_mac_source_;
487 488 489

    /// @brief Pointer to the configuration for RSOO-enabled options.
    ///
490 491
    /// This object holds a set of RSOO-enabled options. See
    /// RFC 6422 for the definition of the RSOO-enabled option.
492
    CfgRSOOPtr cfg_rsoo_;
493

494 495 496 497
    /// @brief Pointer to the configuration pertaining to processing of
    /// expired leases.
    CfgExpirationPtr cfg_expiration_;

498 499 500
    /// @brief Pointer to the configuration of the server identifier.
    CfgDUIDPtr cfg_duid_;

501 502 503 504
    /// @brief Pointer to the configuration of the lease and host database
    /// connection parameters.
    CfgDbAccessPtr cfg_db_access_;

505 506
    /// @brief Pointer to the control-socket information
    isc::data::ConstElementPtr control_socket_;
507

508 509 510
    /// @brief Pointer to the dictionary of global client class definitions
    ClientClassDictionaryPtr class_dictionary_;

511
    /// @brief Decline Period time
Tomek Mrugalski's avatar
Tomek Mrugalski committed
512 513 514
    ///
    /// This timer specifies decline probation period, the time after a declined
    /// lease is recovered back to available state. Expressed in seconds.
515
    uint32_t decline_timer_;
516 517
};

518
/// @name Pointers to the @c SrvConfig object.
519 520
///
//@{
521 522
/// @brief Non-const pointer to the @c SrvConfig.
typedef boost::shared_ptr<SrvConfig> SrvConfigPtr;
523

524 525
/// @brief Const pointer to the @c SrvConfig.
typedef boost::shared_ptr<const SrvConfig> ConstSrvConfigPtr;
526 527
//@}

528 529 530
} // namespace isc::dhcp
} // namespace isc

531
#endif // DHCPSRV_CONFIG_H