srv_config.h 17.2 KB
Newer Older
1
// Copyright (C) 2014-2015 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_duid.h>
11
#include <dhcpsrv/cfg_expiration.h>
12
#include <dhcpsrv/cfg_hosts.h>
13
#include <dhcpsrv/cfg_iface.h>
14
#include <dhcpsrv/cfg_option.h>
15
#include <dhcpsrv/cfg_option_def.h>
16
#include <dhcpsrv/cfg_rsoo.h>
17
#include <dhcpsrv/cfg_subnets4.h>
18
#include <dhcpsrv/cfg_subnets6.h>
Tomek Mrugalski's avatar
Tomek Mrugalski committed
19
#include <dhcpsrv/cfg_mac_source.h>
20
#include <dhcpsrv/client_class_def.h>
21
#include <dhcpsrv/logging_info.h>
22
#include <cc/data.h>
23
#include <boost/shared_ptr.hpp>
24 25
#include <vector>
#include <stdint.h>
26 27 28 29

namespace isc {
namespace dhcp {

30 31
class CfgMgr;

32 33 34 35

/// @brief Specifies current DHCP configuration
///
/// @todo Migrate all other configuration parameters from cfgmgr.h here
36
class SrvConfig {
37
public:
38 39 40
    /// @name Constants for selection of parameters returned by @c getConfigSummary
    ///
    //@{
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60
    /// 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;
61
    //@}
62

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

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

73 74 75
    /// @brief Returns summary of the configuration in the textual format.
    ///
    /// This method returns the brief text describing the current configuration.
76
    /// It may be used for logging purposes, e.g. when the new configuration is
77 78 79 80 81 82
    /// 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.
    ///
83 84 85 86
    /// @todo Implement reporting a summary of interfaces being used for
    /// receiving and sending DHCP messages. This will be implemented with
    /// ticket #3512.
    ///
87 88 89 90 91
    /// @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;
92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107

    /// @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.
108
    bool sequenceEquals(const SrvConfig& other);
109

110 111 112 113 114 115 116
    /// @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.
    ///
    //@{
117 118 119 120 121 122 123 124 125 126 127 128
    /// @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);
    }

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

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

149 150
    /// @brief Return pointer to non-const object representing user-defined
    /// option definitions.
151
    ///
152 153 154 155 156 157 158 159 160 161 162 163
    /// 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
164 165
    /// user defined option definitions grouped by option space name.
    ///
166 167
    /// @return Pointer to an object holding option definitions.
    ConstCfgOptionDefPtr getCfgOptionDef() const {
168 169 170
        return (cfg_option_def_);
    }

171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190
    /// @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_);
    }

191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206
    /// @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_);
    }

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

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

223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238
    /// @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_);
    }

239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256
    /// @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_);
    }

257 258 259 260 261 262 263 264 265 266 267 268
    /// @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_);
    }

269 270 271 272 273 274 275 276 277 278 279 280
    /// @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_);
    }

Tomek Mrugalski's avatar
Tomek Mrugalski committed
281
    //@}
282

Tomek Mrugalski's avatar
Tomek Mrugalski committed
283 284
    /// @brief Returns non-const reference to an array that stores
    ///        MAC/hardware address sources.
285
    ///
Tomek Mrugalski's avatar
Tomek Mrugalski committed
286 287 288
    /// @return non-const reference to MAC/hardware address sources
    CfgMACSource& getMACSources() {
        return (cfg_mac_source_);
289 290
    }

Tomek Mrugalski's avatar
Tomek Mrugalski committed
291 292 293 294 295 296
    /// @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_);
297 298
    }

299 300 301 302 303 304 305 306 307 308 309 310
    /// @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;
    }

311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328
    /// @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;
    }

329 330 331 332 333 334
    /// @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.
    ///
335 336 337 338 339 340 341 342
    /// @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.
    ///
343 344
    /// @param [out] new_config An object to which the configuration will
    /// be copied.
345
    void copy(SrvConfig& new_config) const;
346

347 348 349
    /// @brief Apply logging configuration to log4cplus.
    void applyLoggingCfg() const;

350 351 352 353 354 355 356 357 358 359 360 361
    /// @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.
362
    bool equals(const SrvConfig& other) const;
363 364 365 366 367 368 369 370 371

    /// @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.
372
    bool nequals(const SrvConfig& other) const {
373 374 375 376 377 378 379 380 381 382 383
        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.
384
    bool operator==(const SrvConfig& other) const {
385 386 387 388 389 390 391 392 393 394 395
        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.
396
    bool operator!=(const SrvConfig& other) const {
397 398 399 400 401
        return (nequals(other));
    }

    //@}

Tomek Mrugalski's avatar
Tomek Mrugalski committed
402 403 404
    /// @brief Updates statistics.
    ///
    /// This method calls appropriate methods in child objects that update
405 406
    /// related statistics. See @ref CfgSubnets4::updateStatistics and
    /// @ref CfgSubnets6::updateStatistics for details.
Tomek Mrugalski's avatar
Tomek Mrugalski committed
407 408 409 410 411
    void updateStatistics();

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

416
    /// @brief Sets decline probation-period
Tomek Mrugalski's avatar
Tomek Mrugalski committed
417 418 419 420
    ///
    /// Probation-period is the timer, expressed, in seconds, that specifies how
    /// long a lease is unavailable after reported as declined.
    ///
421
    /// @param decline_timer number of seconds after declined lease is restored
Tomek Mrugalski's avatar
Tomek Mrugalski committed
422
    void setDeclinePeriod(const uint32_t decline_timer) {
423 424 425
        decline_timer_ = decline_timer;
    }

Tomek Mrugalski's avatar
Tomek Mrugalski committed
426 427 428 429
    /// @brief Returns probation-period
    ///
    /// See @ref setDeclinePeriod for brief discussion.
    /// @return value of probation-period, expressed in seconds
430 431 432 433
    uint32_t getDeclinePeriod() const {
        return (decline_timer_);
    }

434 435 436 437 438
private:

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

439 440 441
    /// @brief Logging specific information.
    LoggingInfoStorage logging_info_;

442 443 444 445
    /// @brief Interface configuration.
    ///
    /// Used to select interfaces on which the DHCP server will listen to
    /// queries.
446
    CfgIfacePtr cfg_iface_;
447

448
    /// @brief Pointer to option definitions configuration.
449 450 451
    ///
    /// This object holds the user-defined option definitions grouped
    /// by option space name.
452
    CfgOptionDefPtr cfg_option_def_;
453

454 455 456 457 458 459
    /// @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_;

460 461 462
    /// @brief Pointer to subnets configuration for IPv4.
    CfgSubnets4Ptr cfg_subnets4_;

463
    /// @brief Pointer to subnets configuration for IPv6.
464 465
    CfgSubnets6Ptr cfg_subnets6_;

466 467 468 469 470 471
    /// @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_;

472
    /// @brief A list of configured MAC sources.
Tomek Mrugalski's avatar
Tomek Mrugalski committed
473
    CfgMACSource cfg_mac_source_;
474 475 476

    /// @brief Pointer to the configuration for RSOO-enabled options.
    ///
477 478
    /// This object holds a set of RSOO-enabled options. See
    /// RFC 6422 for the definition of the RSOO-enabled option.
479
    CfgRSOOPtr cfg_rsoo_;
480

481 482 483 484
    /// @brief Pointer to the configuration pertaining to processing of
    /// expired leases.
    CfgExpirationPtr cfg_expiration_;

485 486 487
    /// @brief Pointer to the configuration of the server identifier.
    CfgDUIDPtr cfg_duid_;

488 489
    /// @brief Pointer to the control-socket information
    isc::data::ConstElementPtr control_socket_;
490

491 492 493
    /// @brief Pointer to the dictionary of global client class definitions
    ClientClassDictionaryPtr class_dictionary_;

494
    /// @brief Decline Period time
Tomek Mrugalski's avatar
Tomek Mrugalski committed
495 496 497
    ///
    /// This timer specifies decline probation period, the time after a declined
    /// lease is recovered back to available state. Expressed in seconds.
498
    uint32_t decline_timer_;
499 500
};

501
/// @name Pointers to the @c SrvConfig object.
502 503
///
//@{
504 505
/// @brief Non-const pointer to the @c SrvConfig.
typedef boost::shared_ptr<SrvConfig> SrvConfigPtr;
506

507 508
/// @brief Const pointer to the @c SrvConfig.
typedef boost::shared_ptr<const SrvConfig> ConstSrvConfigPtr;
509 510
//@}

511 512 513
} // namespace isc::dhcp
} // namespace isc

514
#endif // DHCPSRV_CONFIG_H