option_definition.h 30.9 KB
Newer Older
1
// Copyright (C) 2012-2014 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 OPTION_DEFINITION_H
#define OPTION_DEFINITION_H
17

Marcin Siodelski's avatar
Marcin Siodelski committed
18
#include <dhcp/option.h>
19 20
#include <dhcp/option_data_types.h>

21 22
#include <boost/multi_index/hashed_index.hpp>
#include <boost/multi_index/mem_fun.hpp>
23 24 25
#include <boost/multi_index/sequenced_index.hpp>
#include <boost/multi_index_container.hpp>
#include <boost/shared_ptr.hpp>
26
#include <map>
27 28 29 30

namespace isc {
namespace dhcp {

31 32 33 34 35 36 37 38
/// @brief Exception to be thrown when invalid option value has been
/// specified for a particular option definition.
class InvalidOptionValue : public Exception {
public:
    InvalidOptionValue(const char* file, size_t line, const char* what) :
        isc::Exception(file, line, what) { };
};

39 40 41 42 43 44 45
/// @brief Exception to be thrown when option definition is invalid.
class MalformedOptionDefinition : public Exception {
public:
    MalformedOptionDefinition(const char* file, size_t line, const char* what) :
        isc::Exception(file, line, what) { };
};

46 47 48 49 50 51 52 53
/// @brief Exception to be thrown when the particular option definition
/// duplicates existing option definition.
class DuplicateOptionDefinition : public Exception {
public:
    DuplicateOptionDefinition(const char* file, size_t line, const char* what) :
        isc::Exception(file, line, what) { };
};

54 55 56 57 58 59
/// @brief Forward declaration to OptionDefinition.
class OptionDefinition;

/// @brief Pointer to option definition object.
typedef boost::shared_ptr<OptionDefinition> OptionDefinitionPtr;

60
/// @brief Forward declaration to OptionInt.
61
///
62 63 64 65
/// This forward declaration is needed to access the OptionInt class without
/// having to include the option_int.h header file. It is required because
/// this header includes libdhcp++.h, and including option_int.h would cause
/// circular inclusion between libdhcp++.h, option_definition.h and
66 67
/// option6_int.h.
template<typename T>
68
class OptionInt;
69

70
/// @brief Forward declaration to OptionIntArray.
71
///
72 73 74 75 76
/// This forward declaration is needed to access the OptionIntArray class
/// without having to include the option_int_array.h header file. It is
/// required because this header includes libdhcp++.h, and including
/// option_int_array.h would cause circular inclusion between libdhcp++.h,
/// option_definition.h and option_int_array.h.
77
template<typename T>
78
class OptionIntArray;
79

80
/// @brief Base class representing a DHCP option definition.
81
///
82 83
/// This is a base class representing a DHCP option definition, which describes
/// the format of the option. In particular, it defines:
84 85 86 87 88
/// - option name,
/// - option code,
/// - data fields order and their types,
/// - sub options space that the particular option encapsulates.
///
89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104
/// The option type specifies the data type(s) which an option conveys.  If
/// this is a single value the option type points to the data type of the
/// value. For example, DHCPv6 option 8 comprises a two-byte option code, a
/// two-byte option length and two-byte field that carries a uint16 value
/// (RFC 3315 - http://ietf.org/rfc/rfc3315.txt).  In such a case, the option
/// type is defined as "uint16".
///
/// When the option has a more complex structure, the option type may be
/// defined as "array", "record" or even "array of records".
///
/// Array types should be used when the option contains multiple contiguous
/// data values of the same type laid. For example, DHCPv6 option 6 includes
/// multiple fields holding uint16 codes of requested DHCPv6 options (RFC 3315).
/// Such an option can be represented with this class by setting the option
/// type to "uint16" and the array indicator (array_type) to true.  The number
/// of elements in the array is effectively unlimited (although it is actually
105
/// limited by the maximal DHCPv6 option length).
106 107 108
///
/// Should the option comprise data fields of different types, the "record"
/// option type is used. In such cases the data field types within the record
109
/// are specified using \ref OptionDefinition::addRecordField.
110 111 112 113 114 115
///
/// When the OptionDefinition object has been sucessfully created, it can be
/// queried to return the appropriate option factory function for the specified
/// specified option format. There are a number of "standard" factory functions
/// that cover well known (common) formats.  If the particular format does not
/// match any common format the generic factory function is returned.
116 117
///
/// The following data type strings are supported:
118
/// - "empty" (option does not contain data fields)
119 120 121 122 123 124 125
/// - "boolean"
/// - "int8"
/// - "int16"
/// - "int32"
/// - "uint8"
/// - "uint16"
/// - "uint32"
126 127
/// - "ipv4-address" (IPv4 Address)
/// - "ipv6-address" (IPV6 Address)
128
/// - "string"
129 130
/// - "fqdn" (fully qualified name)
/// - "record" (set of data fields of different types)
131 132 133
///
/// @todo Extend the comment to describe "generic factories".
/// @todo Extend this class to use custom namespaces.
Marcin Siodelski's avatar
Marcin Siodelski committed
134
/// @todo Extend this class with more factory functions.
135 136 137 138
class OptionDefinition {
public:

    /// List of fields within the record.
139
    typedef std::vector<OptionDataType> RecordFieldsCollection;
140
    /// Const iterator for record data fields.
141
    typedef std::vector<OptionDataType>::const_iterator RecordFieldsConstIter;
142 143 144 145 146 147

    /// @brief Constructor.
    ///
    /// @param name option name.
    /// @param code option code.
    /// @param type option data type as string.
148
    /// @param array_type array indicator, if true it indicates that the
149
    /// option fields are the array.
150 151 152 153
    explicit OptionDefinition(const std::string& name,
                              const uint16_t code,
                              const std::string& type,
                              const bool array_type = false);
154 155 156 157 158 159

    /// @brief Constructor.
    ///
    /// @param name option name.
    /// @param code option code.
    /// @param type option data type.
160
    /// @param array_type array indicator, if true it indicates that the
161
    /// option fields are the array.
162 163 164 165 166 167 168 169 170
    explicit OptionDefinition(const std::string& name,
                              const uint16_t code,
                              const OptionDataType type,
                              const bool array_type = false);

    /// @brief Constructor.
    ///
    /// This constructor sets the name of the option space that is
    /// encapsulated by this option. The encapsulated option space
171
    /// identifies sub-options that are carried within this option.
172 173 174 175 176 177 178 179 180 181 182 183 184 185
    /// This constructor does not allow to set array indicator
    /// because options comprising an array of data fields must
    /// not be used with sub-options.
    ///
    /// @param name option name.
    /// @param code option code.
    /// @param type option data type given as string.
    /// @param encapsulated_space name of the option space being
    /// encapsulated by this option.
    explicit OptionDefinition(const std::string& name,
                              const uint16_t code,
                              const std::string& type,
                              const char* encapsulated_space);

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
    /// @brief Copy constructor.
    ///
    /// @param def Option definition to be used to create a new instance.
    explicit OptionDefinition(const OptionDefinition& def);

    /// @name Comparison functions and operators.
    ///
    //@{
    /// @brief Check if option definition is equal to other.
    ///
    /// @param other Option definition to compare to.
    ///
    /// @return true if two option definitions are equal, false otherwise.
    bool equals(const OptionDefinition& other) const;

    /// @brief Equality operator.
    ///
    /// @param other Option definition to compare to.
    ///
    /// @return true if two option definitions are equal, false otherwise.
    bool operator==(const OptionDefinition& other) const {
        return (equals(other));
    }

    /// @brief Inequality operator.
    ///
    /// @param other Option definition to compare to.
    ///
    /// @return true if option definitions are not equal, false otherwise.
    bool operator!=(const OptionDefinition& other) const {
        return (!equals(other));
    }
    //@}

220 221 222 223
    /// @brief Constructor.
    ///
    /// This constructor sets the name of the option space that is
    /// encapsulated by this option. The encapsulated option space
224
    /// identifies sub-options that are carried within this option.
225 226 227 228 229 230 231 232 233 234 235 236 237 238
    /// This constructor does not allow to set array indicator
    /// because options comprising an array of data fields must
    /// not be used with sub-options.
    ///
    /// @param name option name.
    /// @param code option code.
    /// @param type option data type.
    /// @param encapsulated_space name of the option space being
    /// encapsulated by this option.
    explicit OptionDefinition(const std::string& name,
                              const uint16_t code,
                              const OptionDataType type,
                              const char* encapsulated_space);

239 240 241 242 243 244 245 246 247 248 249 250 251 252 253

    /// @brief Adds data field to the record.
    ///
    /// @param data_type_name name of the data type for the field.
    ///
    /// @throw isc::InvalidOperation if option type is not set to RECORD_TYPE.
    /// @throw isc::BadValue if specified invalid data type.
    void addRecordField(const std::string& data_type_name);

    /// @brief Adds data field to the record.
    ///
    /// @param data_type data type for the field.
    ///
    /// @throw isc::InvalidOperation if option type is not set to RECORD_TYPE.
    /// @throw isc::BadValue if specified invalid data type.
254
    void addRecordField(const OptionDataType data_type);
255 256 257

    /// @brief Return array type indicator.
    ///
258 259
    /// The method returns the bool value to indicate whether the option is a
    /// a single value or an array of values.
260 261 262 263 264 265 266 267 268
    ///
    /// @return true if option comprises an array of values.
    bool getArrayType() const { return (array_type_); }

    /// @brief Return option code.
    ///
    /// @return option code.
    uint16_t getCode() const { return (code_); }

269 270 271
    /// @brief Return name of the encapsulated option space.
    ///
    /// @return name of the encapsulated option space.
272
    std::string getEncapsulatedSpace() const {
273 274 275
        return (encapsulated_space_);
    }

276 277 278
    /// @brief Return option name.
    ///
    /// @return option name.
279
    std::string getName() const { return (name_); }
280 281 282 283

    /// @brief Return list of record fields.
    ///
    /// @return list of record fields.
284 285 286
    const RecordFieldsCollection& getRecordFields() const {
        return (record_fields_);
    }
287 288 289 290

    /// @brief Return option data type.
    ///
    /// @return option data type.
291
    OptionDataType getType() const { return (type_); };
292

Marcin Siodelski's avatar
Marcin Siodelski committed
293 294
    /// @brief Check if the option definition is valid.
    ///
295 296 297 298 299 300 301
    /// Note that it is a responsibility of the code that created
    /// the OptionDefinition object to validate that it is valid.
    /// This function will not be called internally anywhere in this
    /// class to verify that the option definition is valid. Using
    /// invalid option definition to create an instance of the
    /// DHCP option leads to undefined behavior.
    ///
302
    /// @throw MalformedOptionDefinition option definition is invalid.
Marcin Siodelski's avatar
Marcin Siodelski committed
303 304
    void validate() const;

305 306 307 308 309 310 311 312 313 314
    /// @brief Check if specified format is IA_NA option format.
    ///
    /// @return true if specified format is IA_NA option format.
    bool haveIA6Format() const;

    /// @brief Check if specified format is IAADDR option format.
    ///
    /// @return true if specified format is IAADDR option format.
    bool haveIAAddr6Format() const;

315 316 317 318 319
    /// @brief Check if specified format is IAPREFIX option format.
    ///
    /// @return true if specified format is IAPREFIX option format.
    bool haveIAPrefix6Format() const;

320 321 322 323 324 325
    /// @brief Check if specified format is OPTION_CLIENT_FQDN option format.
    ///
    /// @return true of specified format is OPTION_CLIENT_FQDN option format,
    /// false otherwise.
    bool haveClientFqdnFormat() const;

326 327 328 329 330 331 332 333 334 335 336 337 338 339 340
    /// @brief Check if option has format of the DHCPv4 Client FQDN
    /// %Option.
    ///
    /// The encoding of the domain-name carried by the FQDN option is
    /// conditional and is specified in the flags field of the option.
    /// The domain-name can be encoded in the ASCII format or canonical
    /// wire format. The ASCII format is deprecated, therefore canonical
    /// format is selected for the FQDN option definition and this function
    /// returns true if the option definition comprises the domain-name
    /// field encoded in canonical format.
    ///
    /// @return true if option has the format of DHCPv4 Client FQDN
    /// %Option.
    bool haveFqdn4Format() const;

341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362
    /// @brief Check if the option has format of Vendor-Identifying Vendor
    /// Specific Options.
    ///
    /// @return Always true.
    /// @todo The Vendor-Identifying Vendor-Specific Option has a complex format
    /// which we do not support here. Therefore it is not really possible to
    /// check that the current definition is valid. We may need to add support
    /// for such option format or simply do not check the format for certain
    /// options, e.g. vendor options, IA_NA, IAADDR and always return objects
    /// of the certain type.
    bool haveVendor4Format() const;

    /// @brief Check if option has a format of the Vendor-Specific Information
    /// %Option.
    ///
    /// The Vendor-Specific Information %Option comprises 32-bit enterprise id
    /// and the suboptions.
    ///
    /// @return true if option definition conforms to the format of the
    /// Vendor-Specific Information %Option.
    bool haveVendor6Format() const;

363 364 365 366 367
    /// @brief Check if the option has format of DHCPv4 V-I Vendor Class option.
    ///
    /// @return true if the option has the format of DHCPv4 Vendor Class option.
    bool haveVendorClass4Format() const;

368 369 370 371 372
    /// @brief Check if the option has format of DHCPv6 Vendor Class option.
    ///
    /// @return true if option has the format of DHCPv6 Vendor Class option.
    bool haveVendorClass6Format() const;

373 374 375 376 377 378
    /// @brief Option factory.
    ///
    /// This function creates an instance of DHCP option using
    /// provided chunk of buffer. This function may be used to
    /// create option which is to be sent in the outgoing packet.
    ///
379 380 381 382
    /// @warning calling this function on invalid option definition
    /// yields undefined behavior. Use \ref validate to test that
    /// the option definition is valid.
    ///
383
    /// @param u option universe (V4 or V6).
384 385 386
    /// @param type option type.
    /// @param begin beginning of the option buffer.
    /// @param end end of the option buffer.
387 388 389 390
    /// @param callback An instance of the function which parses packet options.
    /// If this is set to non NULL value this function will be used instead of
    /// @c isc::dhcp::LibDHCP::unpackOptions6 and
    /// isc::dhcp::LibDHCP::unpackOptions4.
391 392
    ///
    /// @return instance of the DHCP option.
393
    /// @throw InvalidOptionValue if data for the option is invalid.
394 395
    OptionPtr optionFactory(Option::Universe u, uint16_t type,
                            OptionBufferConstIter begin,
396 397
                            OptionBufferConstIter end,
                            UnpackOptionsCallback callback = NULL) const;
398 399 400 401 402 403 404

    /// @brief Option factory.
    ///
    /// This function creates an instance of DHCP option using
    /// whole provided buffer. This function may be used to
    /// create option which is to be sent in the outgoing packet.
    ///
405 406 407 408
    /// @warning calling this function on invalid option definition
    /// yields undefined behavior. Use \ref validate to test that
    /// the option definition is valid.
    ///
409
    /// @param u option universe (V4 or V6).
410 411
    /// @param type option type.
    /// @param buf option buffer.
412 413 414 415
    /// @param callback An instance of the function which parses packet options.
    /// If this is set to non NULL value this function will be used instead of
    /// @c isc::dhcp::LibDHCP::unpackOptions6 and
    /// isc::dhcp::LibDHCP::unpackOptions4.
416 417
    ///
    /// @return instance of the DHCP option.
418
    /// @throw InvalidOptionValue if data for the option is invalid.
419
    OptionPtr optionFactory(Option::Universe u, uint16_t type,
420 421
                            const OptionBuffer& buf = OptionBuffer(),
                            UnpackOptionsCallback callback = NULL) const;
422 423 424 425 426 427 428 429 430 431 432 433 434 435 436

    /// @brief Option factory.
    ///
    /// This function creates an instance of DHCP option using the vector
    /// of strings which carry data values for option data fields.
    /// The order of values in the vector corresponds to the order of data
    /// fields in the option. The supplied string values are cast to
    /// their actual data types which are determined based on the
    /// option definition. If cast fails due to type mismatch, an exception
    /// is thrown. This factory function can be used to create option
    /// instance when user specified option value in the <b>comma separated
    /// values</b> format in the configuration database. Provided string
    /// must be tokenized into the vector of string values and this vector
    /// can be supplied to this function.
    ///
437 438 439 440
    /// @warning calling this function on invalid option definition
    /// yields undefined behavior. Use \ref validate to test that
    /// the option definition is valid.
    ///
441
    /// @param u option universe (V4 or V6).
442 443 444 445
    /// @param type option type.
    /// @param values a vector of values to be used to set data for an option.
    ///
    /// @return instance of the DHCP option.
446
    /// @throw InvalidOptionValue if data for the option is invalid.
447 448
    OptionPtr optionFactory(Option::Universe u, uint16_t type,
                            const std::vector<std::string>& values) const;
449

450 451 452
    /// @brief Factory to create option with address list.
    ///
    /// @param type option type.
453 454 455 456
    /// @param begin iterator pointing to the beginning of the buffer
    /// with a list of IPv4 addresses.
    /// @param end iterator pointing to the end of the buffer with
    /// a list of IPv4 addresses.
Marcin Siodelski's avatar
Marcin Siodelski committed
457 458 459
    ///
    /// @throw isc::OutOfRange if length of the provided option buffer
    /// is not multiple of IPV4 address length.
460
    static OptionPtr factoryAddrList4(uint16_t type,
461 462
                                      OptionBufferConstIter begin,
                                      OptionBufferConstIter end);
463 464 465 466

    /// @brief Factory to create option with address list.
    ///
    /// @param type option type.
467 468 469 470
    /// @param begin iterator pointing to the beginning of the buffer
    /// with a list of IPv6 addresses.
    /// @param end iterator pointing to the end of the buffer with
    /// a list of IPv6 addresses.
Marcin Siodelski's avatar
Marcin Siodelski committed
471 472 473
    ///
    /// @throw isc::OutOfaRange if length of provided option buffer
    /// is not multiple of IPV6 address length.
474
    static OptionPtr factoryAddrList6(uint16_t type,
475 476
                                      OptionBufferConstIter begin,
                                      OptionBufferConstIter end);
477 478 479 480 481

    /// @brief Empty option factory.
    ///
    /// @param u universe (V6 or V4).
    /// @param type option type.
482
    static OptionPtr factoryEmpty(Option::Universe u, uint16_t type);
483

Marcin Siodelski's avatar
Marcin Siodelski committed
484
    /// @brief Factory to create generic option.
485 486 487
    ///
    /// @param u universe (V6 or V4).
    /// @param type option type.
488 489
    /// @param begin iterator pointing to the beginning of the buffer.
    /// @param end iterator pointing to the end of the buffer.
490
    static OptionPtr factoryGeneric(Option::Universe u, uint16_t type,
491 492
                                    OptionBufferConstIter begin,
                                    OptionBufferConstIter end);
493

494 495 496
    /// @brief Factory for IA-type of option.
    ///
    /// @param type option type.
497 498
    /// @param begin iterator pointing to the beginning of the buffer.
    /// @param end iterator pointing to the end of the buffer.
499 500 501
    ///
    /// @throw isc::OutOfRange if provided option buffer is too short or
    /// too long. Expected size is 12 bytes.
502
    static OptionPtr factoryIA6(uint16_t type,
503 504
                                OptionBufferConstIter begin,
                                OptionBufferConstIter end);
505 506 507 508

    /// @brief Factory for IAADDR-type of option.
    ///
    /// @param type option type.
509 510
    /// @param begin iterator pointing to the beginning of the buffer.
    /// @param end iterator pointing to the end of the buffer.
511 512 513
    ///
    /// @throw isc::OutOfRange if provided option buffer is too short or
    /// too long. Expected size is 24 bytes.
514
    static OptionPtr factoryIAAddr6(uint16_t type,
515 516
                                    OptionBufferConstIter begin,
                                    OptionBufferConstIter end);
517

518 519 520 521 522 523
    /// @brief Factory for IAPREFIX-type of option.
    ///
    /// @param type option type.
    /// @param begin iterator pointing to the beginning of the buffer.
    /// @param end iterator pointing to the end of the buffer.
    ///
Tomek Mrugalski's avatar
Tomek Mrugalski committed
524 525
    /// @throw isc::OutOfRange if provided option buffer is too short.
    /// Expected minimum size is 25 bytes.
526 527 528 529
    static OptionPtr factoryIAPrefix6(uint16_t type,
                                      OptionBufferConstIter begin,
                                      OptionBufferConstIter end);

530 531
    /// @brief Factory function to create option with integer value.
    ///
532
    /// @param u universe (V4 or V6).
533
    /// @param type option type.
534 535 536
    /// @param encapsulated_space An option space being encapsulated by the
    /// options created by this factory function. The options which belong to
    /// encapsulated option space are sub options of this option.
537 538
    /// @param begin iterator pointing to the beginning of the buffer.
    /// @param end iterator pointing to the end of the buffer.
539 540 541 542
    /// @param callback An instance of the function which parses packet options.
    /// If this is set to non NULL value this function will be used instead of
    /// @c isc::dhcp::LibDHCP::unpackOptions6 and
    /// isc::dhcp::LibDHCP::unpackOptions4.
Marcin Siodelski's avatar
Marcin Siodelski committed
543 544 545
    /// @tparam T type of the data field (must be one of the uintX_t or intX_t).
    ///
    /// @throw isc::OutOfRange if provided option buffer length is invalid.
546
    template<typename T>
547
    static OptionPtr factoryInteger(Option::Universe u, uint16_t type,
548
                                    const std::string& encapsulated_space,
549
                                    OptionBufferConstIter begin,
550 551 552 553 554 555
                                    OptionBufferConstIter end,
                                    UnpackOptionsCallback callback) {
        OptionPtr option(new OptionInt<T>(u, type, 0));
        option->setEncapsulatedSpace(encapsulated_space);
        option->setCallback(callback);
        option->unpack(begin, end);
556 557 558 559 560
        return (option);
    }

    /// @brief Factory function to create option with array of integer values.
    ///
561
    /// @param u universe (V4 or V6).
562
    /// @param type option type.
563 564
    /// @param begin iterator pointing to the beginning of the buffer.
    /// @param end iterator pointing to the end of the buffer.
Marcin Siodelski's avatar
Marcin Siodelski committed
565 566 567
    /// @tparam T type of the data field (must be one of the uintX_t or intX_t).
    ///
    /// @throw isc::OutOfRange if provided option buffer length is invalid.
568
    template<typename T>
569 570
    static OptionPtr factoryIntegerArray(Option::Universe u,
                                         uint16_t type,
571 572
                                         OptionBufferConstIter begin,
                                         OptionBufferConstIter end) {
573
        OptionPtr option(new OptionIntArray<T>(u, type, begin, end));
574 575 576 577 578
        return (option);
    }

private:

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
    /// @brief Creates an instance of an option having special format.
    ///
    /// The option with special formats are encapsulated by the dedicated
    /// classes derived from @c Option class. In particular these are:
    /// - IA_NA
    /// - IAADDR
    /// - FQDN
    /// - VIVSO.
    ///
    /// @param u A universe (V4 or V6).
    /// @param begin beginning of the option buffer.
    /// @param end end of the option buffer.
    /// @param callback An instance of the function which parses packet options.
    /// If this is set to non NULL value this function will be used instead of
    /// @c isc::dhcp::LibDHCP::unpackOptions6 and
    /// isc::dhcp::LibDHCP::unpackOptions4.
    ///
    /// @return An instance of the option having special format or NULL if
    /// such an option can't be created because an option with the given
    /// option code hasn't got the special format.
    OptionPtr factorySpecialFormatOption(Option::Universe u,
                                         OptionBufferConstIter begin,
                                         OptionBufferConstIter end,
                                         UnpackOptionsCallback callback) const;

604 605 606 607 608 609 610 611 612
    /// @brief Check if specified option format is a record with 3 fields
    /// where first one is custom, and two others are uint32.
    ///
    /// This is a helper function for functions that detect IA_NA and IAAddr
    /// option formats.
    ///
    /// @param first_type type of the first data field.
    ///
    /// @return true if actual option format matches expected format.
613
    bool haveIAx6Format(const OptionDataType first_type) const;
614

615 616 617
    /// @brief Check if specified type matches option definition type.
    ///
    /// @return true if specified type matches option definition type.
618
    inline bool haveType(const OptionDataType type) const {
619 620 621
        return (type == type_);
    }

622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641
    /// @brief Converts a string value to a boolean value.
    ///
    /// This function converts the value represented as string to a boolean
    /// value. The following conversions are acceptable:
    /// - "true" => true
    /// - "false" => false
    /// - "1" => true
    /// - "0" => false
    /// The first two conversions are case insensitive, so as conversions from
    /// strings such as "TRUE", "trUE" etc. will be accepted. Note that the
    /// only acceptable integer values, carried as strings are: "0" and "1".
    /// For other values, e.g. "2", "3" etc. an exception will be thrown
    /// during conversion.
    ///
    /// @param value_str Input value.
    ///
    /// @return boolean representation of the string specified as the parameter.
    /// @throw isc::dhcp::BadDataTypeCast if failed to perform the conversion.
    bool convertToBool(const std::string& value_str) const;

642 643 644
    /// @brief Perform lexical cast of the value and validate its range.
    ///
    /// This function performs lexical cast of a string value to integer
645 646 647
    /// value and checks if the resulting value is within a range of a
    /// target type. The target type should be one of the supported
    /// integer types.
648 649
    ///
    /// @param value_str input value given as string.
650
    /// @tparam T target integer type for lexical cast.
651
    ///
652 653
    /// @return Integer value after conversion from the string.
    /// @throw isc::dhcp::BadDataTypeCast if conversion was not successful.
654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674
    template<typename T>
    T lexicalCastWithRangeCheck(const std::string& value_str) const;

    /// @brief Write the string value into the provided buffer.
    ///
    /// This method writes the given value to the specified buffer.
    /// The provided string value may represent data of different types.
    /// The actual data type is specified with the second argument.
    /// Based on a value of this argument, this function will first
    /// try to cast the string value to the particular data type and
    /// if it is successful it will store the data in the buffer
    /// in a binary format.
    ///
    /// @param value string representation of the value to be written.
    /// @param type the actual data type to be stored.
    /// @param [in, out] buf buffer where the value is to be stored.
    ///
    /// @throw BadDataTypeCast if data write was unsuccessful.
    void writeToBuffer(const std::string& value, const OptionDataType type,
                       OptionBuffer& buf) const;

675 676 677 678 679
    /// Option name.
    std::string name_;
    /// Option code.
    uint16_t code_;
    /// Option data type.
680
    OptionDataType type_;
681 682
    /// Indicates wheter option is a single value or array.
    bool array_type_;
683 684
    /// Name of the space being encapsulated by this option.
    std::string encapsulated_space_;
685 686 687 688 689
    /// Collection of data fields within the record.
    RecordFieldsCollection record_fields_;
};


690 691 692 693
/// @brief Multi index container for DHCP option definitions.
///
/// This container allows to search for DHCP option definition
/// using two indexes:
694
/// - sequenced: used to access elements in the order they have
695
/// been added to the container
696
/// - option code: used to search definitions of options
697
/// with a specified option code (aka option type).
698 699
/// Note that this container can hold multiple options with the
/// same code. For this reason, the latter index can be used to
700
/// obtain a range of options for a particular option code.
701
///
702 703 704 705 706 707 708 709 710 711 712 713 714 715 716
/// @todo: need an index to search options using option space name
/// once option spaces are implemented.
typedef boost::multi_index_container<
    // Container comprises elements of OptionDefinition type.
    OptionDefinitionPtr,
    // Here we start enumerating various indexes.
    boost::multi_index::indexed_by<
        // Sequenced index allows accessing elements in the same way
        // as elements in std::list. Sequenced is an index #0.
        boost::multi_index::sequenced<>,
        // Start definition of index #1.
        boost::multi_index::hashed_non_unique<
            // Use option type as the index key. The type is held
            // in OptionDefinition object so we have to call
            // OptionDefinition::getCode to retrieve this key
717 718 719
            // for each element. The option code is non-unique so
            // multiple elements with the same option code can
            // be returned by this index.
720 721 722 723 724 725 726 727 728
            boost::multi_index::const_mem_fun<
                OptionDefinition,
                uint16_t,
                &OptionDefinition::getCode
            >
        >
    >
> OptionDefContainer;

729 730 731
/// Pointer to an option definition container.
typedef boost::shared_ptr<OptionDefContainer> OptionDefContainerPtr;

732 733 734
/// Container that holds various vendor option containers
typedef std::map<uint32_t, OptionDefContainer> VendorOptionDefContainers;

735 736 737 738
/// Type of the index #1 - option type.
typedef OptionDefContainer::nth_index<1>::type OptionDefContainerTypeIndex;
/// Pair of iterators to represent the range of options definitions
///  having the same option type value. The first element in this pair
739
///  represents the beginning of the range, the second element
740 741 742 743 744
///  represents the end.
typedef std::pair<OptionDefContainerTypeIndex::const_iterator,
                  OptionDefContainerTypeIndex::const_iterator> OptionDefContainerTypeRange;


745 746 747
} // namespace isc::dhcp
} // namespace isc

748
#endif // OPTION_DEFINITION_H