srv_config.h 16.5 KB
Newer Older
1
// Copyright (C) 2014-2015 Internet Systems Consortium, Inc. ("ISC")
2 3 4 5 6 7 8 9 10 11 12 13 14
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
// copyright notice and this permission notice appear in all copies.
//
// THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
// AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.

15 16
#ifndef DHCPSRV_CONFIG_H
#define DHCPSRV_CONFIG_H
17

18
#include <dhcpsrv/cfg_expiration.h>
19
#include <dhcpsrv/cfg_hosts.h>
20
#include <dhcpsrv/cfg_iface.h>
21
#include <dhcpsrv/cfg_option.h>
22
#include <dhcpsrv/cfg_option_def.h>
23
#include <dhcpsrv/cfg_rsoo.h>
24
#include <dhcpsrv/cfg_subnets4.h>
25
#include <dhcpsrv/cfg_subnets6.h>
Tomek Mrugalski's avatar
Tomek Mrugalski committed
26
#include <dhcpsrv/cfg_mac_source.h>
27
#include <dhcpsrv/logging_info.h>
28
#include <cc/data.h>
29
#include <boost/shared_ptr.hpp>
30 31
#include <vector>
#include <stdint.h>
32 33 34 35

namespace isc {
namespace dhcp {

36 37
class CfgMgr;

38 39 40 41

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

69
    /// @brief Default constructor.
70
    ///
71
    /// This constructor sets configuration sequence number to 0.
72
    SrvConfig();
73 74 75 76

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

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

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

116 117 118 119 120 121 122
    /// @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.
    ///
    //@{
123 124 125 126 127 128 129 130 131 132 133 134
    /// @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);
    }

135
    /// @brief Returns non-const pointer to interface configuration.
136
    ///
137 138
    /// This function returns a non-const pointer to the interface
    /// configuration.
139
    ///
140 141
    /// @return Object representing configuration of interfaces.
    CfgIfacePtr getCfgIface() {
142 143 144
        return (cfg_iface_);
    }

145
    /// @brief Returns const pointer to interface configuration.
146
    ///
147 148 149 150 151 152
    /// This function returns a const pointer to the interface
    /// configuration.
    ///
    /// @return Object representing configuration of interfaces.
    ConstCfgIfacePtr getCfgIface() const {
        return (cfg_iface_);
153 154
    }

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

177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196
    /// @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_);
    }

197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212
    /// @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_);
    }

213 214 215
    /// @brief Returns pointer to non-const object holding subnets configuration
    /// for DHCPv6.
    ///
216
    /// @return Pointer to the object holding subnets configuration for DHCPv6.
217 218 219 220 221
    CfgSubnets6Ptr getCfgSubnets6() {
        return (cfg_subnets6_);
    }

    /// @brief Returns pointer to const object holding subnets configuration for
222
    /// DHCPv6.
223 224 225 226 227 228
    ///
    /// @return Pointer to the object holding subnets configuration for DHCPv6.
    ConstCfgSubnets6Ptr getCfgSubnets6() const {
        return (cfg_subnets6_);
    }

229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244
    /// @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_);
    }

245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262
    /// @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_);
    }

263 264 265 266 267 268 269 270 271 272 273 274
    /// @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_);
    }

Tomek Mrugalski's avatar
Tomek Mrugalski committed
275
    //@}
276

Tomek Mrugalski's avatar
Tomek Mrugalski committed
277 278
    /// @brief Returns non-const reference to an array that stores
    ///        MAC/hardware address sources.
279
    ///
Tomek Mrugalski's avatar
Tomek Mrugalski committed
280 281 282
    /// @return non-const reference to MAC/hardware address sources
    CfgMACSource& getMACSources() {
        return (cfg_mac_source_);
283 284
    }

Tomek Mrugalski's avatar
Tomek Mrugalski committed
285 286 287 288 289 290
    /// @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_);
291 292
    }

293 294 295 296 297 298 299 300 301 302 303 304
    /// @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;
    }

305 306 307 308 309 310
    /// @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.
    ///
311 312 313 314 315 316 317 318
    /// @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.
    ///
319 320
    /// @param [out] new_config An object to which the configuration will
    /// be copied.
321
    void copy(SrvConfig& new_config) const;
322

323 324 325
    /// @brief Apply logging configuration to log4cplus.
    void applyLoggingCfg() const;

326 327 328 329 330 331 332 333 334 335 336 337
    /// @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.
338
    bool equals(const SrvConfig& other) const;
339 340 341 342 343 344 345 346 347

    /// @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.
348
    bool nequals(const SrvConfig& other) const {
349 350 351 352 353 354 355 356 357 358 359
        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.
360
    bool operator==(const SrvConfig& other) const {
361 362 363 364 365 366 367 368 369 370 371
        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.
372
    bool operator!=(const SrvConfig& other) const {
373 374 375 376 377
        return (nequals(other));
    }

    //@}

Tomek Mrugalski's avatar
Tomek Mrugalski committed
378 379 380
    /// @brief Updates statistics.
    ///
    /// This method calls appropriate methods in child objects that update
381 382
    /// related statistics. See @ref CfgSubnets4::updateStatistics and
    /// @ref CfgSubnets6::updateStatistics for details.
Tomek Mrugalski's avatar
Tomek Mrugalski committed
383 384 385 386 387
    void updateStatistics();

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

392
    /// @brief Sets decline probation-period
Tomek Mrugalski's avatar
Tomek Mrugalski committed
393 394 395 396
    ///
    /// Probation-period is the timer, expressed, in seconds, that specifies how
    /// long a lease is unavailable after reported as declined.
    ///
397
    /// @param decline_timer number of seconds after declined lease is restored
Tomek Mrugalski's avatar
Tomek Mrugalski committed
398
    void setDeclinePeriod(const uint32_t decline_timer) {
399 400 401
        decline_timer_ = decline_timer;
    }

Tomek Mrugalski's avatar
Tomek Mrugalski committed
402 403 404 405
    /// @brief Returns probation-period
    ///
    /// See @ref setDeclinePeriod for brief discussion.
    /// @return value of probation-period, expressed in seconds
406 407 408 409
    uint32_t getDeclinePeriod() const {
        return (decline_timer_);
    }

410 411 412 413 414
private:

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

415 416 417
    /// @brief Logging specific information.
    LoggingInfoStorage logging_info_;

418 419 420 421
    /// @brief Interface configuration.
    ///
    /// Used to select interfaces on which the DHCP server will listen to
    /// queries.
422
    CfgIfacePtr cfg_iface_;
423

424
    /// @brief Pointer to option definitions configuration.
425 426 427
    ///
    /// This object holds the user-defined option definitions grouped
    /// by option space name.
428
    CfgOptionDefPtr cfg_option_def_;
429

430 431 432 433 434 435
    /// @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_;

436 437 438
    /// @brief Pointer to subnets configuration for IPv4.
    CfgSubnets4Ptr cfg_subnets4_;

439
    /// @brief Pointer to subnets configuration for IPv6.
440 441
    CfgSubnets6Ptr cfg_subnets6_;

442 443 444 445 446 447
    /// @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_;

448
    /// @brief A list of configured MAC sources.
Tomek Mrugalski's avatar
Tomek Mrugalski committed
449
    CfgMACSource cfg_mac_source_;
450 451 452

    /// @brief Pointer to the configuration for RSOO-enabled options.
    ///
453 454
    /// This object holds a set of RSOO-enabled options. See
    /// RFC 6422 for the definition of the RSOO-enabled option.
455
    CfgRSOOPtr cfg_rsoo_;
456

457 458 459 460
    /// @brief Pointer to the configuration pertaining to processing of
    /// expired leases.
    CfgExpirationPtr cfg_expiration_;

461 462
    /// @brief Pointer to the control-socket information
    isc::data::ConstElementPtr control_socket_;
463 464

    /// @brief Decline Period time
Tomek Mrugalski's avatar
Tomek Mrugalski committed
465 466 467
    ///
    /// This timer specifies decline probation period, the time after a declined
    /// lease is recovered back to available state. Expressed in seconds.
468
    uint32_t decline_timer_;
469 470
};

471
/// @name Pointers to the @c SrvConfig object.
472 473
///
//@{
474 475
/// @brief Non-const pointer to the @c SrvConfig.
typedef boost::shared_ptr<SrvConfig> SrvConfigPtr;
476

477 478
/// @brief Const pointer to the @c SrvConfig.
typedef boost::shared_ptr<const SrvConfig> ConstSrvConfigPtr;
479 480
//@}

481 482 483
} // namespace isc::dhcp
} // namespace isc

484
#endif // DHCPSRV_CONFIG_H