Kea  2.3.5-git
isc::perfdhcp::TestControl Class Reference

Test Control class. More...

#include <test_control.h>

+ Inheritance diagram for isc::perfdhcp::TestControl:

Classes

class  NumberGenerator
 Number generator class. More...
 
class  SequentialGenerator
 Sequential numbers generator class. More...
 

Public Types

typedef boost::shared_ptr< NumberGeneratorNumberGeneratorPtr
 The default generator pointer. More...
 
typedef std::vector< uint8_t > TemplateBuffer
 Packet template buffer. More...
 
typedef std::vector< TemplateBufferTemplateBufferCollection
 Packet template buffers list. More...
 

Public Member Functions

 TestControl (CommandOptions &options, BasePerfSocket &socket)
 Default constructor. More...
 
void cleanCachedPackets ()
 Removes cached DHCPv6 Reply packets every second. More...
 
unsigned int consumeReceivedPackets ()
 Pull packets from receiver and process them. More...
 
std::set< std::string > & getAllUniqueAddrAdvert ()
 Get set of unique advertised addresses. More...
 
std::set< std::string > & getAllUniqueAddrReply ()
 Get set of unique replied addresses. More...
 
std::string getServerId () const
 Get received server id. More...
 
StatsMgrgetStatsMgr ()
 Get stats manager. More...
 
bool haveAllPacketsBeenReceived () const
 Checks if all expected packets were already received. More...
 
bool interrupted () const
 Get interrupted flag. More...
 
void printIntermediateStats ()
 Print intermediate statistics. More...
 
void printStats () const
 Print performance statistics. More...
 
void printTemplates () const
 Print templates information. More...
 
void runWrapped (bool do_stop=false) const
 Run wrapped command. More...
 
uint64_t sendMultipleMessages4 (const uint32_t msg_type, const uint64_t msg_num)
 Send number of DHCPREQUEST (renew) messages to a server. More...
 
uint64_t sendMultipleMessages6 (const uint32_t msg_type, const uint64_t msg_num)
 Send number of DHCPv6 Renew or Release messages to the server. More...
 
void sendPackets (const uint64_t packets_num, const bool preload=false)
 Send number of packets to initiate new exchanges. More...
 
bool serverIdReceived () const
 Get received server id flag. More...
 
void setMacAddrGenerator (const NumberGeneratorPtr &generator)
 Set new MAC address generator. More...
 
void setTransidGenerator (const NumberGeneratorPtr &generator)
 Set new transaction id generator. More...
 
void start ()
 Start receiver. More...
 
void stop ()
 Stop receiver. More...
 
bool waitToExit ()
 Delay the exit by a fixed given time to catch up to all exchanges that were already started. More...
 

Static Public Member Functions

static std::string byte2Hex (const uint8_t b)
 Convert binary value to hex string. More...
 
static std::string vector2Hex (const std::vector< uint8_t > &vec, const std::string &separator="")
 Convert vector in hexadecimal string. More...
 

Public Attributes

boost::posix_time::ptime exit_time_
 Initialized at first exit condition with the time perfdhcp should exit. More...
 

Static Public Attributes

static const uint8_t HW_ETHER_LEN = 6
 Length of the Ethernet HW address (MAC) in bytes. More...
 

Protected Member Functions

void addExtraOpts (const dhcp::Pkt4Ptr &pkt4)
 Inserts extra options specified by user. More...
 
void addExtraOpts (const dhcp::Pkt6Ptr &pkt6)
 Inserts extra options specified by user. More...
 
void address4Uniqueness (const dhcp::Pkt4Ptr &pkt4, ExchangeType xchg_type)
 Process received v4 addresses uniqueness. More...
 
void address6Uniqueness (const dhcp::Pkt6Ptr &pkt6, ExchangeType xchg_type)
 Process received v6 addresses uniqueness. More...
 
void addUniqeAddr (const std::set< std::string > &current, ExchangeType xchg_type)
 add unique address to already assigned list. More...
 
void copyIaOptions (const dhcp::Pkt6Ptr &pkt_from, dhcp::Pkt6Ptr &pkt_to)
 Copies IA_NA or IA_PD option from one packet to another. More...
 
dhcp::Pkt4Ptr createMessageFromAck (const uint16_t msg_type, const dhcp::Pkt4Ptr &ack)
 Creates DHCPREQUEST from a DHCPACK message. More...
 
dhcp::Pkt6Ptr createMessageFromReply (const uint16_t msg_type, const dhcp::Pkt6Ptr &reply)
 Creates DHCPv6 message from the Reply packet. More...
 
dhcp::OptionPtr generateClientId (const dhcp::HWAddrPtr &hwaddr) const
 Generate DHCPv4 client identifier from HW address. More...
 
std::vector< uint8_t > generateDuid (uint8_t &randomized)
 Generate DUID. More...
 
std::vector< uint8_t > generateMacAddress (uint8_t &randomized)
 Generate MAC address. More...
 
uint32_t generateTransid ()
 generate transaction id. More...
 
template<class T >
uint32_t getElapsedTime (const T &pkt1, const T &pkt2)
 Calculate elapsed time between two packets. More...
 
int getElapsedTimeOffset () const
 Return elapsed time offset in a packet. More...
 
int getRandomOffset (const int arg_idx) const
 Return randomization offset in a packet. More...
 
int getRequestedIpOffset () const
 Return requested ip offset in a packet. More...
 
int getServerIdOffset () const
 Return server id offset in a packet. More...
 
TemplateBuffer getTemplateBuffer (const size_t idx) const
 Return template buffer. More...
 
int getTransactionIdOffset (const int arg_idx) const
 Return transaction id offset in a packet. More...
 
void initPacketTemplates ()
 Reads packet templates from files. More...
 
void printDiagnostics () const
 Print main diagnostics data. More...
 
void printRate () const
 Print rate statistics. More...
 
void printTemplate (const uint8_t packet_type) const
 Print template information. More...
 
void processReceivedPacket4 (const dhcp::Pkt4Ptr &pkt4)
 Process received DHCPv4 packet. More...
 
void processReceivedPacket6 (const dhcp::Pkt6Ptr &pkt6)
 Process received DHCPv6 packet. More...
 
void readPacketTemplate (const std::string &file_name)
 Read DHCP message template from file. More...
 
void registerOptionFactories () const
 Register option factory functions for DHCPv4 or DHCPv6. More...
 
void registerOptionFactories4 () const
 Register option factory functions for DHCPv4. More...
 
void registerOptionFactories6 () const
 Register option factory functions for DHCPv6. More...
 
void removeUniqueAddr (const std::set< std::string > &addr)
 remove unique address from list. More...
 
void reset ()
 Resets internal state of the object. More...
 
void saveFirstPacket (const dhcp::Pkt4Ptr &pkt)
 Save the first DHCPv4 sent packet of the specified type. More...
 
void saveFirstPacket (const dhcp::Pkt6Ptr &pkt)
 Save the first DHCPv6 sent packet of the specified type. More...
 
void sendDiscover4 (const bool preload=false)
 Send DHCPv4 DISCOVER message. More...
 
void sendDiscover4 (const std::vector< uint8_t > &template_buf, const bool preload=false)
 Send DHCPv4 DISCOVER message from template. More...
 
bool sendMessageFromAck (const uint16_t msg_type)
 Send DHCPv4 renew (DHCPREQUEST). More...
 
bool sendMessageFromReply (const uint16_t msg_type)
 Send DHCPv6 Renew or Release message. More...
 
void sendRequest4 (const dhcp::Pkt4Ptr &discover_pkt4, const dhcp::Pkt4Ptr &offer_pkt4)
 Send DHCPv4 REQUEST message. More...
 
void sendRequest4 (const std::vector< uint8_t > &template_buf, const dhcp::Pkt4Ptr &discover_pkt4, const dhcp::Pkt4Ptr &offer_pkt4)
 Send DHCPv4 REQUEST message from template. More...
 
void sendRequest6 (const dhcp::Pkt6Ptr &advertise_pkt6)
 Send DHCPv6 REQUEST message. More...
 
void sendRequest6 (const std::vector< uint8_t > &template_buf, const dhcp::Pkt6Ptr &advertise_pkt6)
 Send DHCPv6 REQUEST message from template. More...
 
void sendSolicit6 (const bool preload=false)
 Send DHCPv6 SOLICIT message. More...
 
void sendSolicit6 (const std::vector< uint8_t > &template_buf, const bool preload=false)
 Send DHCPv6 SOLICIT message from template. More...
 
void setDefaults4 (const dhcp::Pkt4Ptr &pkt)
 Set default DHCPv4 packet parameters. More...
 
void setDefaults6 (const dhcp::Pkt6Ptr &pkt)
 Set default DHCPv6 packet parameters. More...
 
bool validateIA (const dhcp::Pkt6Ptr &pkt6)
 Process IA in received DHCPv6 packet. More...
 

Static Protected Member Functions

static dhcp::OptionPtr factoryElapsedTime6 (dhcp::Option::Universe u, uint16_t type, const dhcp::OptionBuffer &buf)
 Factory function to create DHCPv6 ELAPSED_TIME option. More...
 
static dhcp::OptionPtr factoryGeneric (dhcp::Option::Universe u, uint16_t type, const dhcp::OptionBuffer &buf)
 Factory function to create generic option. More...
 
static dhcp::OptionPtr factoryIana6 (dhcp::Option::Universe u, uint16_t type, const dhcp::OptionBuffer &buf)
 Factory function to create IA_NA option. More...
 
static dhcp::OptionPtr factoryIapd6 (dhcp::Option::Universe u, uint16_t type, const dhcp::OptionBuffer &buf)
 Factory function to create IA_PD option. More...
 
static dhcp::OptionPtr factoryOptionRequestOption6 (dhcp::Option::Universe u, uint16_t type, const dhcp::OptionBuffer &buf)
 Factory function to create DHCPv6 ORO option. More...
 
static dhcp::OptionPtr factoryRapidCommit6 (dhcp::Option::Universe u, uint16_t type, const dhcp::OptionBuffer &buf)
 Factory function to create DHCPv6 RAPID_COMMIT option instance. More...
 
static dhcp::OptionPtr factoryRequestList4 (dhcp::Option::Universe u, uint16_t type, const dhcp::OptionBuffer &buf)
 Factory function to create DHCPv4 Request List option. More...
 
static void handleChild (int sig)
 Handle child signal. More...
 
static void handleInterrupt (int sig)
 Handle interrupt signal. More...
 

Protected Attributes

PacketStorage< dhcp::Pkt4ack_storage_
 Storage for DHCPACK messages. More...
 
dhcp::OptionBuffer first_packet_serverid_
 Buffer holding server id received in first packet. More...
 
boost::posix_time::ptime last_report_
 Last intermediate report time. More...
 
NumberGeneratorPtr macaddr_gen_
 Numbers generator for MAC address. More...
 
UniformRandomIntegerGenerator number_generator_
 Generate uniformly distributed integers in range of [min, max]. More...
 
CommandOptionsoptions_
 Command options. More...
 
Receiver receiver_
 Receiver used to receive DHCP traffic. More...
 
PacketStorage< dhcp::Pkt6reply_storage_
 Storage for reply messages. More...
 
BasePerfSocketsocket_
 Socket used for DHCP traffic. More...
 
StatsMgr stats_mgr_
 Statistics Manager. More...
 
TemplateBufferCollection template_buffers_
 Packet template buffers. More...
 
std::map< uint8_t, dhcp::Pkt4Ptrtemplate_packets_v4_
 First packets send. More...
 
std::map< uint8_t, dhcp::Pkt6Ptrtemplate_packets_v6_
 Template for v6. More...
 
NumberGeneratorPtr transid_gen_
 Transaction id generator. More...
 
std::set< std::string > unique_address_
 Keep addresses and prefixes from advertise msg for uniqueness checks. More...
 
std::set< std::string > unique_reply_address_
 Keep addresses and prefixes from reply msg for uniqueness checks. More...
 

Static Protected Attributes

static bool interrupted_ = false
 Program interrupted flag. More...
 

Detailed Description

Test Control class.

This class is used to run the performance test with with TestControl::runWrapped function. This function can be executed multiple times if desired because it resets TestControl's internal state every time it is executed. Prior to running TestControl::runWrapped, one must make sure to parse command line options by calling CommandOptions::parse. Failing to do this will result in an exception.

The following major stages of the test are performed by this class:

  • set default transaction id and MAC address generators - the generator is an object of TestControl::NumberGenerator type and it provides the custom randomization algorithms,
  • print command line arguments,
  • register option factory functions which are used to generate DHCP options being sent to a server,
  • create the socket for communication with a server,
  • read packet templates if user specified template files with '-T' command line option,
  • set the interrupt handler (invoked when ^C is pressed) which makes perfdhcp stop gracefully and print the test results before exiting,
  • executes an external command (if specified '-w' option), e.g. if user specified -w ./foo in the command line then program will execute "./foo start" at the beginning of the test and "./foo stop" when the test ends,
  • initialize the Statistics Manager,
  • executes the main loop:
    • calculate how many packets must be send to satisfy desired rate,
    • receive incoming packets from the server,
    • check the exit conditions - terminate the program if the exit criteria are fulfilled, e.g. reached maximum number of packet drops,
    • send the number of packets appropriate to satisfy the desired rate,
    • optionally print intermediate reports,
  • print statistics, e.g. achieved rate,
  • optionally print some diagnostics.

With the '-w' command line option user may specify the external application or script to be executed. This is executed twice, first when the test starts and second time when the test ends. This external script or application must accept 'start' and 'stop' arguments. The first time it is called, it is called with the argument 'start' and the second time with the argument 'stop'.

The application is executed by calling fork() to fork the current perfdhcp process and then call execlp() to replace the current process image with the new one.

Option factory functions are registered using dhcp::LibDHCP::OptionFactoryRegister. Registered factory functions provide a way to create options of the same type in the same way. When a new option instance is needed, the corresponding factory function is called to create it. This is done by calling dhcp::Option::factory with DHCP message type specified as one of parameters. Some of the parameters passed to factory function may be ignored (e.g. option buffer). Please note that naming convention for factory functions within this class is as follows:

  • factoryABC4 - factory function for DHCPv4 option,
  • factoryDEF6 - factory function for DHCPv6 option,
  • factoryGHI - factory function that can be used to create either DHCPv4 or DHCPv6 option.

Definition at line 118 of file test_control.h.

Member Typedef Documentation

◆ NumberGeneratorPtr

The default generator pointer.

Definition at line 155 of file test_control.h.

◆ TemplateBuffer

typedef std::vector<uint8_t> isc::perfdhcp::TestControl::TemplateBuffer

Packet template buffer.

Definition at line 124 of file test_control.h.

◆ TemplateBufferCollection

Packet template buffers list.

Definition at line 126 of file test_control.h.

Constructor & Destructor Documentation

◆ TestControl()

Member Function Documentation

◆ addExtraOpts() [1/2]

void isc::perfdhcp::TestControl::addExtraOpts ( const dhcp::Pkt4Ptr pkt4)
protected

Inserts extra options specified by user.

Note: addExtraOpts for v4 and v6 could easily be turned into a template. However, this would require putting code here that uses CommandOptions, and that would create dependency between test_control.h and command_options.h.

Parameters
pkt4options will be added here.

Definition at line 1924 of file test_control.cc.

References isc::perfdhcp::CommandOptions::getExtraOpts(), and options_.

Referenced by removeUniqueAddr(), sendDiscover4(), sendMessageFromAck(), sendMessageFromReply(), sendRequest4(), sendRequest6(), and sendSolicit6().

+ Here is the call graph for this function:

◆ addExtraOpts() [2/2]

void isc::perfdhcp::TestControl::addExtraOpts ( const dhcp::Pkt6Ptr pkt6)
protected

Inserts extra options specified by user.

Note: addExtraOpts for v4 and v6 could easily be turned into a template. However, this would require putting code here that uses CommandOptions, and that would create dependency between test_control.h and command_options.h.

Parameters
pkt6options will be added here.

Definition at line 1933 of file test_control.cc.

References isc::perfdhcp::CommandOptions::getExtraOpts(), and options_.

+ Here is the call graph for this function:

◆ address4Uniqueness()

void isc::perfdhcp::TestControl::address4Uniqueness ( const dhcp::Pkt4Ptr pkt4,
ExchangeType  xchg_type 
)
protected

Process received v4 addresses uniqueness.

Generate list of addresses and check for uniqueness.

Parameters
pkt4object representing received DHCPv4 packet
xchg_typeExchangeType enum value.

Definition at line 896 of file test_control.cc.

Referenced by generateTransid(), and sendMessageFromAck().

◆ address6Uniqueness()

void isc::perfdhcp::TestControl::address6Uniqueness ( const dhcp::Pkt6Ptr pkt6,
ExchangeType  xchg_type 
)
protected

Process received v6 addresses uniqueness.

Generate list of addresses and check for uniqueness.

Parameters
pkt6object representing received DHCPv6 packet
xchg_typeExchangeType enum value.

Definition at line 858 of file test_control.cc.

References D6O_IA_NA, D6O_IA_PD, D6O_IAADDR, D6O_IAPREFIX, isc::dhcp::Option6IAAddr::toText(), and isc::dhcp::Option6IAPrefix::toText().

Referenced by generateTransid(), and sendMessageFromReply().

+ Here is the call graph for this function:

◆ addUniqeAddr()

void isc::perfdhcp::TestControl::addUniqeAddr ( const std::set< std::string > &  current,
ExchangeType  xchg_type 
)
inlineprotected

add unique address to already assigned list.

Add address and/or prefix to unique set if it's not already there, otherwise increment the number of non unique addresses.

Parameters
currentset of addresses that should be added to unique list
xchg_typeExchangeType enum value.

Definition at line 615 of file test_control.h.

References isc::perfdhcp::DO, isc::perfdhcp::RA, removeUniqueAddr(), isc::perfdhcp::RL, isc::perfdhcp::RLA, isc::perfdhcp::RN, isc::perfdhcp::RNA, isc::perfdhcp::RR, isc::perfdhcp::SA, stats_mgr_, unique_address_, unique_reply_address_, and isc::perfdhcp::StatsMgr::updateNonUniqueAddrNum().

+ Here is the call graph for this function:

◆ byte2Hex()

std::string isc::perfdhcp::TestControl::byte2Hex ( const uint8_t  b)
static

Convert binary value to hex string.

Todo:
Consider moving this function to src/lib/util.
Parameters
bbyte to convert.
Returns
hex string.

Definition at line 155 of file test_control.cc.

Referenced by getAllUniqueAddrAdvert().

◆ cleanCachedPackets()

void isc::perfdhcp::TestControl::cleanCachedPackets ( )

Removes cached DHCPv6 Reply packets every second.

This function wipes cached Reply packets from the storage. The number of packets left in the storage after the call to this function should guarantee that the Renew packets can be sent at the given rate. Note that the Renew packets are generated for the existing leases, represented here as replies from the server.

Todo:
Instead of cleaning packets periodically we could just stop adding new packets when the certain threshold has been reached.
Todo:
The cache size might be controlled from the command line.

Definition at line 96 of file test_control.cc.

Referenced by setMacAddrGenerator().

◆ consumeReceivedPackets()

unsigned int isc::perfdhcp::TestControl::consumeReceivedPackets ( )

Pull packets from receiver and process them.

It runs in a loop until there are no packets in receiver.

Definition at line 1007 of file test_control.cc.

Referenced by getServerId().

◆ copyIaOptions()

void isc::perfdhcp::TestControl::copyIaOptions ( const dhcp::Pkt6Ptr pkt_from,
dhcp::Pkt6Ptr pkt_to 
)
protected

Copies IA_NA or IA_PD option from one packet to another.

This function checks the lease-type specified in the command line with option -e<lease-type>. If 'address-only' value has been specified this function expects that IA_NA option is present in the packet encapsulated by pkt_from object. If 'prefix-only' value has been specified, this function expects that IA_PD option is present in the packet encapsulated by pkt_to object.

Parameters
[in]pkt_fromA packet from which options should be copied.
[out]pkt_toA packet to which options should be copied.
Exceptions
isc::NotFoundif a required option is not found in the packet from which options should be copied.
isc::BadValueif any of the specified pointers to packets is NULL.

Definition at line 127 of file test_control.cc.

References D6O_IA_NA, D6O_IA_PD, and isc_throw.

Referenced by removeUniqueAddr(), and sendRequest6().

◆ createMessageFromAck()

Pkt4Ptr isc::perfdhcp::TestControl::createMessageFromAck ( const uint16_t  msg_type,
const dhcp::Pkt4Ptr ack 
)
protected

Creates DHCPREQUEST from a DHCPACK message.

Parameters
msg_typethe message type to be created (DHCPREQUEST or DHCPRELEASE)
ackAn instance of the DHCPACK message to be used to create a new message.
Returns
Pointer to the created message.

Definition at line 164 of file test_control.cc.

References isc::dhcp::DHCPRELEASE, isc::dhcp::DHCPREQUEST, isc::dhcp::DHO_DHCP_SERVER_IDENTIFIER, and isc_throw.

Referenced by sendMessageFromAck().

◆ createMessageFromReply()

Pkt6Ptr isc::perfdhcp::TestControl::createMessageFromReply ( const uint16_t  msg_type,
const dhcp::Pkt6Ptr reply 
)
protected

Creates DHCPv6 message from the Reply packet.

This function creates DHCPv6 Renew or Release message using the data from the Reply message by copying options from the Reply message.

Parameters
msg_typeA type of the message to be created.
replyAn instance of the Reply packet which contents should be used to create an instance of the new message.
Returns
created Release or Renew message
Exceptions
isc::BadValueif the msg_type is neither DHCPV6_RENEW nor DHCPV6_RELEASE or if the reply is NULL.
isc::Unexpectedif mandatory options are missing in the Reply message.

Definition at line 225 of file test_control.cc.

References D6O_CLIENTID, D6O_SERVERID, DHCPV6_RELEASE, DHCPV6_RENEW, and isc_throw.

Referenced by sendMessageFromReply().

◆ factoryElapsedTime6()

OptionPtr isc::perfdhcp::TestControl::factoryElapsedTime6 ( dhcp::Option::Universe  u,
uint16_t  type,
const dhcp::OptionBuffer buf 
)
staticprotected

Factory function to create DHCPv6 ELAPSED_TIME option.

This factory function creates DHCPv6 ELAPSED_TIME option instance. If empty buffer is passed the option buffer will be initialized to length 2 and values will be initialized to zeros. Otherwise function will initialize option buffer with values in passed buffer.

Parameters
uuniverse (ignored)
typeoption-type (ignored).
bufoption-buffer containing option content (2 bytes) or empty buffer if option content has to be set to default (0) value.
Exceptions
ifelapsed time buffer size is neither 2 nor 0.
Returns
instance o the option.

Definition at line 269 of file test_control.cc.

References D6O_ELAPSED_TIME, and isc_throw.

◆ factoryGeneric()

OptionPtr isc::perfdhcp::TestControl::factoryGeneric ( dhcp::Option::Universe  u,
uint16_t  type,
const dhcp::OptionBuffer buf 
)
staticprotected

Factory function to create generic option.

This factory function creates option with specified universe, type and buf. It does not have any additional logic validating the buffer contents, size etc.

Parameters
uuniverse (V6 or V4).
typeoption-type (ignored).
bufoption-buffer.
Returns
instance o the option.

Definition at line 282 of file test_control.cc.

◆ factoryIana6()

OptionPtr isc::perfdhcp::TestControl::factoryIana6 ( dhcp::Option::Universe  u,
uint16_t  type,
const dhcp::OptionBuffer buf 
)
staticprotected

Factory function to create IA_NA option.

This factory function creates DHCPv6 IA_NA option instance.

Todo:
add support for IA Address options.
Parameters
uuniverse (ignored).
typeoption-type (ignored).
bufoption-buffer carrying IANA suboptions.
Returns
instance of IA_NA option.
Todo:
allow different values of T1, T2 and IAID.

Definition at line 289 of file test_control.cc.

References D6O_IA_NA.

◆ factoryIapd6()

OptionPtr isc::perfdhcp::TestControl::factoryIapd6 ( dhcp::Option::Universe  u,
uint16_t  type,
const dhcp::OptionBuffer buf 
)
staticprotected

Factory function to create IA_PD option.

this factory function creates DHCPv6 IA_PD option instance.

Parameters
uuniverse (ignored).
typeoption-type (ignored).
bufoption-buffer carrying sub-options.
Todo:
allow different values of T1, T2 and IAID.

Definition at line 305 of file test_control.cc.

References D6O_IA_PD.

◆ factoryOptionRequestOption6()

OptionPtr isc::perfdhcp::TestControl::factoryOptionRequestOption6 ( dhcp::Option::Universe  u,
uint16_t  type,
const dhcp::OptionBuffer buf 
)
staticprotected

Factory function to create DHCPv6 ORO option.

This factory function creates DHCPv6 Option Request Option instance. The created option will contain the following set of requested options:

  • D6O_NAME_SERVERS
  • D6O_DOMAIN_SEARCH
Parameters
uuniverse (ignored).
typeoption-type (ignored).
bufoption-buffer (ignored).
Returns
instance of ORO option.

Definition at line 327 of file test_control.cc.

References D6O_DOMAIN_SEARCH, D6O_NAME_SERVERS, and D6O_ORO.

◆ factoryRapidCommit6()

OptionPtr isc::perfdhcp::TestControl::factoryRapidCommit6 ( dhcp::Option::Universe  u,
uint16_t  type,
const dhcp::OptionBuffer buf 
)
staticprotected

Factory function to create DHCPv6 RAPID_COMMIT option instance.

This factory function creates DHCPv6 RAPID_COMMIT option instance. The buffer passed to this option must be empty because option does not have any payload.

Parameters
uuniverse (ignored).
typeoption-type (ignored).
bufoption-buffer (ignored).
Returns
instance of RAPID_COMMIT option..

Definition at line 321 of file test_control.cc.

References D6O_RAPID_COMMIT.

◆ factoryRequestList4()

OptionPtr isc::perfdhcp::TestControl::factoryRequestList4 ( dhcp::Option::Universe  u,
uint16_t  type,
const dhcp::OptionBuffer buf 
)
staticprotected

Factory function to create DHCPv4 Request List option.

This factory function creates DHCPv4 PARAMETER_REQUEST_LIST option instance with the following set of requested options:

  • DHO_SUBNET_MASK,
  • DHO_BROADCAST_ADDRESS,
  • DHO_TIME_OFFSET,
  • DHO_ROUTERS,
  • DHO_DOMAIN_NAME,
  • DHO_DOMAIN_NAME_SERVERS,
  • DHO_HOST_NAME.
Parameters
uuniverse (ignored).
typeoption-type (ignored).
bufoption-buffer (ignored).
Returns
instance o the generic option.

Definition at line 340 of file test_control.cc.

References isc::dhcp::DHO_BROADCAST_ADDRESS, isc::dhcp::DHO_DOMAIN_NAME, isc::dhcp::DHO_DOMAIN_NAME_SERVERS, isc::dhcp::DHO_HOST_NAME, isc::dhcp::DHO_ROUTERS, isc::dhcp::DHO_SUBNET_MASK, and isc::dhcp::DHO_TIME_OFFSET.

◆ generateClientId()

OptionPtr isc::perfdhcp::TestControl::generateClientId ( const dhcp::HWAddrPtr hwaddr) const
protected

Generate DHCPv4 client identifier from HW address.

This method generates DHCPv4 client identifier option from a HW address.

Parameters
hwaddrHW address.
Returns
Pointer to an instance of the generated option.

Definition at line 406 of file test_control.cc.

References isc::dhcp::DHO_DHCP_CLIENT_IDENTIFIER.

Referenced by sendDiscover4(), and sendRequest4().

◆ generateDuid()

std::vector< uint8_t > isc::perfdhcp::TestControl::generateDuid ( uint8_t &  randomized)
protected

Generate DUID.

Method generates unique DUID. The number of DUIDs it can generate depends on the number of simulated clients, which is specified from the command line. It uses CommandOptions object to retrieve number of clients. Since the last six octets of DUID are constructed from the MAC address, this function uses generateMacAddress internally to randomize the DUID.

Todo:
add support for other types of DUID.
Parameters
[out]randomizednumber of bytes randomized (initial value is ignored).
Exceptions
isc::BadValueif generateMacAddress throws.
Returns
vector representing DUID.
Todo:
: add support for DUIDs of different sizes.

Definition at line 415 of file test_control.cc.

References isc::data::copy().

Referenced by sendSolicit6().

+ Here is the call graph for this function:

◆ generateMacAddress()

std::vector< uint8_t > isc::perfdhcp::TestControl::generateMacAddress ( uint8_t &  randomized)
protected

Generate MAC address.

This method generates MAC address. The number of unique MAC addresses it can generate is determined by the number simulated DHCP clients specified from command line. It uses CommandOptions object to retrieve number of clients. Based on this the random value is generated and added to the MAC address template (default MAC address).

Parameters
[out]randomizednumber of bytes randomized (initial value is ignored).
Exceptions
isc::BadValueif MAC address template (default or specified from the command line) has invalid size (expected 6 octets).
Returns
generated MAC address.

Definition at line 360 of file test_control.cc.

References isc_throw.

Referenced by sendDiscover4().

◆ generateTransid()

uint32_t isc::perfdhcp::TestControl::generateTransid ( )
inlineprotected

generate transaction id.

Generate transaction id value (32-bit for DHCPv4, 24-bit for DHCPv6).

Returns
generated transaction id.

Definition at line 538 of file test_control.h.

References address4Uniqueness(), address6Uniqueness(), getTemplateBuffer(), initPacketTemplates(), printRate(), processReceivedPacket4(), transid_gen_, and validateIA().

Referenced by sendDiscover4(), sendRequest6(), and sendSolicit6().

+ Here is the call graph for this function:

◆ getAllUniqueAddrAdvert()

std::set<std::string>& isc::perfdhcp::TestControl::getAllUniqueAddrAdvert ( )
inline

Get set of unique advertised addresses.

Definition at line 320 of file test_control.h.

References byte2Hex(), unique_address_, and vector2Hex().

+ Here is the call graph for this function:

◆ getAllUniqueAddrReply()

std::set<std::string>& isc::perfdhcp::TestControl::getAllUniqueAddrReply ( )
inline

Get set of unique replied addresses.

Definition at line 315 of file test_control.h.

References unique_reply_address_.

◆ getElapsedTime()

template<class T >
uint32_t isc::perfdhcp::TestControl::getElapsedTime ( const T &  pkt1,
const T &  pkt2 
)
protected

Calculate elapsed time between two packets.

This function calculates the time elapsed between two packets. If the timestamp of the pkt2 is greater than timestamp of the pkt1, the positive value is returned. If the pkt2 timestamp is equal or less than pkt1 timestamp, 0 is returned.

Template Parameters
TPkt4Ptr or Pkt6Ptr class.
Parameters
pkt1first packet.
pkt2second packet.
Exceptions
InvalidOperationif packet timestamps are invalid.
Returns
elapsed time in milliseconds between pkt1 and pkt2.

Definition at line 472 of file test_control.cc.

References isc_throw.

Referenced by removeUniqueAddr().

◆ getElapsedTimeOffset()

int isc::perfdhcp::TestControl::getElapsedTimeOffset ( ) const
protected

Return elapsed time offset in a packet.

Returns
elapsed time offset in packet.

Definition at line 461 of file test_control.cc.

Referenced by removeUniqueAddr(), sendRequest4(), and sendRequest6().

◆ getRandomOffset()

int isc::perfdhcp::TestControl::getRandomOffset ( const int  arg_idx) const
protected

Return randomization offset in a packet.

Returns
randomization offset in packet.

Definition at line 486 of file test_control.cc.

Referenced by removeUniqueAddr(), sendDiscover4(), sendRequest4(), sendRequest6(), and sendSolicit6().

◆ getRequestedIpOffset()

int isc::perfdhcp::TestControl::getRequestedIpOffset ( ) const
protected

Return requested ip offset in a packet.

Returns
randomization offset in a packet.

Definition at line 496 of file test_control.cc.

Referenced by removeUniqueAddr(), sendRequest4(), and sendRequest6().

◆ getServerId()

std::string isc::perfdhcp::TestControl::getServerId ( ) const
inline

Get received server id.

Definition at line 245 of file test_control.h.

References consumeReceivedPackets(), first_packet_serverid_, printIntermediateStats(), printStats(), printTemplates(), sendMultipleMessages4(), sendMultipleMessages6(), sendPackets(), and vector2Hex().

+ Here is the call graph for this function:

◆ getServerIdOffset()

int isc::perfdhcp::TestControl::getServerIdOffset ( ) const
protected

Return server id offset in a packet.

Returns
server id offset in packet.

Definition at line 506 of file test_control.cc.

Referenced by removeUniqueAddr(), sendRequest4(), and sendRequest6().

◆ getStatsMgr()

StatsMgr& isc::perfdhcp::TestControl::getStatsMgr ( )
inline

Get stats manager.

Definition at line 228 of file test_control.h.

References stats_mgr_.

◆ getTemplateBuffer()

TestControl::TemplateBuffer isc::perfdhcp::TestControl::getTemplateBuffer ( const size_t  idx) const
protected

Return template buffer.

Method returns template buffer at specified index.

Parameters
idxindex of template buffer.
Exceptions
isc::OutOfRangeif buffer index out of bounds.
Returns
reference to template buffer.

Definition at line 516 of file test_control.cc.

References isc_throw.

Referenced by generateTransid().

◆ getTransactionIdOffset()

int isc::perfdhcp::TestControl::getTransactionIdOffset ( const int  arg_idx) const
protected

Return transaction id offset in a packet.

Parameters
arg_idxcommand line argument index to be used. If multiple -X parameters specified it points to the one to be used.
Returns
transaction id offset in packet.

Definition at line 524 of file test_control.cc.

Referenced by removeUniqueAddr(), sendDiscover4(), sendRequest4(), sendRequest6(), and sendSolicit6().

◆ handleChild()

void isc::perfdhcp::TestControl::handleChild ( int  sig)
staticprotected

Handle child signal.

Function handles child signal by waiting for the process to complete.

Parameters
sigsignal (ignored).

Definition at line 534 of file test_control.cc.

Referenced by removeUniqueAddr(), and runWrapped().

◆ handleInterrupt()

void isc::perfdhcp::TestControl::handleInterrupt ( int  sig)
staticprotected

Handle interrupt signal.

Function sets flag indicating that program has been interrupted.

Parameters
sigsignal (ignored).

Definition at line 542 of file test_control.cc.

Referenced by removeUniqueAddr(), and TestControl().

◆ haveAllPacketsBeenReceived()

bool isc::perfdhcp::TestControl::haveAllPacketsBeenReceived ( ) const

Checks if all expected packets were already received.

Definition at line 69 of file test_control.cc.

◆ initPacketTemplates()

void isc::perfdhcp::TestControl::initPacketTemplates ( )
protected

Reads packet templates from files.

Method iterates through all specified template files, reads their content and stores it in class internal buffers. Template file names are specified from the command line with -T option.

Exceptions
isc::BadValueif any of the template files does not exist, contains characters other than hexadecimal digits or spaces.
OutOfRangeif any of the template files is empty or has odd number of hexadecimal digits.

Definition at line 547 of file test_control.cc.

Referenced by generateTransid(), and TestControl().

◆ interrupted()

bool isc::perfdhcp::TestControl::interrupted ( ) const
inline

Get interrupted flag.

Definition at line 225 of file test_control.h.

References interrupted_.

◆ printDiagnostics()

void isc::perfdhcp::TestControl::printDiagnostics ( ) const
protected

Print main diagnostics data.

Method prints main diagnostics data.

Definition at line 609 of file test_control.cc.

Referenced by removeUniqueAddr(), and TestControl().

◆ printIntermediateStats()

void isc::perfdhcp::TestControl::printIntermediateStats ( )

Print intermediate statistics.

Print brief statistics regarding number of sent packets, received packets and dropped packets so far.

Definition at line 729 of file test_control.cc.

Referenced by getServerId().

◆ printRate()

void isc::perfdhcp::TestControl::printRate ( ) const
protected

Print rate statistics.

Method print packet exchange rate statistics.

Definition at line 691 of file test_control.cc.

Referenced by generateTransid().

◆ printStats()

void isc::perfdhcp::TestControl::printStats ( ) const

Print performance statistics.

Method prints performance statistics.

Exceptions
isc::InvalidOperationif Statistics Manager was not initialized.

Definition at line 741 of file test_control.cc.

Referenced by getServerId().

◆ printTemplate()

void isc::perfdhcp::TestControl::printTemplate ( const uint8_t  packet_type) const
protected

Print template information.

Parameters
packet_typepacket type.

Definition at line 623 of file test_control.cc.

References isc::dhcp::DHCPREQUEST, and DHCPV6_REQUEST.

Referenced by removeUniqueAddr().

◆ printTemplates()

void isc::perfdhcp::TestControl::printTemplates ( ) const

Print templates information.

Method prints information about data offsets in packet templates and their contents.

Definition at line 680 of file test_control.cc.

References isc::dhcp::DHCPDISCOVER, isc::dhcp::DHCPREQUEST, DHCPV6_REQUEST, and DHCPV6_SOLICIT.

Referenced by getServerId().

◆ processReceivedPacket4()

void isc::perfdhcp::TestControl::processReceivedPacket4 ( const dhcp::Pkt4Ptr pkt4)
protected

Process received DHCPv4 packet.

Method performs processing of the received DHCPv4 packet, updates statistics and responds to the server if required, e.g. when OFFER packet arrives, this function will initiate REQUEST message to the server.

Warning
this method does not check if provided socket is valid (specifically if v4 socket for received v4 packet).
Parameters
[in]pkt4object representing DHCPv4 packet received.
Exceptions
isc::BadValueif unknown message type received.
isc::Unexpectedif unexpected error occurred.
Todo:
add defines for packet type index that can be used to access template_buffers_.

Definition at line 814 of file test_control.cc.

References isc::dhcp::DHCPACK, and isc::dhcp::DHCPOFFER.

Referenced by generateTransid().

◆ processReceivedPacket6()

void isc::perfdhcp::TestControl::processReceivedPacket6 ( const dhcp::Pkt6Ptr pkt6)
protected

Process received DHCPv6 packet.

Method performs processing of the received DHCPv6 packet, updates statistics and responds to the server if required, e.g. when ADVERTISE packet arrives, this function will initiate REQUEST message to the server.

Parameters
[in]pkt6object representing DHCPv6 packet received.
Exceptions
isc::BadValueif unknown message type received.
isc::Unexpectedif unexpected error occurred.
Todo:
add defines for packet type index that can be used to access template_buffers_.

Definition at line 943 of file test_control.cc.

References DHCPV6_ADVERTISE, DHCPV6_REPLY, and isc::dhcp::Option::getType().

Referenced by removeUniqueAddr().

+ Here is the call graph for this function:

◆ readPacketTemplate()

void isc::perfdhcp::TestControl::readPacketTemplate ( const std::string &  file_name)
protected

Read DHCP message template from file.

Method reads DHCP message template from file and converts it to binary format. Read data is appended to template_buffers_ vector.

Parameters
file_namename of the packet template file.
Exceptions
isc::OutOfRangeif file is empty or has odd number of hexadecimal digits.
isc::BadValueif file contains characters other than spaces or hexadecimal digits.

Definition at line 766 of file test_control.cc.

References isc_throw.

Referenced by removeUniqueAddr().

◆ registerOptionFactories()

void isc::perfdhcp::TestControl::registerOptionFactories ( ) const
protected

Register option factory functions for DHCPv4 or DHCPv6.

Method registers option factory functions for DHCPv4 or DHCPv6, depending in which mode test is currently running.

Definition at line 1082 of file test_control.cc.

References isc_throw.

Referenced by removeUniqueAddr(), and TestControl().

◆ registerOptionFactories4()

void isc::perfdhcp::TestControl::registerOptionFactories4 ( ) const
protected

Register option factory functions for DHCPv4.

Method registers option factory functions for DHCPv4. These functions are called to create instances of DHCPv4 options. Call dhcp::Option::factory to invoke factory function for particular option. Don't use this function directly. Use registerOptionFactories instead.

Definition at line 1023 of file test_control.cc.

References isc::dhcp::DHO_DHCP_MESSAGE_TYPE, isc::dhcp::DHO_DHCP_PARAMETER_REQUEST_LIST, and isc::dhcp::DHO_DHCP_SERVER_IDENTIFIER.

Referenced by removeUniqueAddr().

◆ registerOptionFactories6()

void isc::perfdhcp::TestControl::registerOptionFactories6 ( ) const
protected

Register option factory functions for DHCPv6.

Method registers option factory functions for DHCPv6. These functions are called to create instances of DHCPv6 options. Call dhcp::Option::factory to invoke factory function for particular option. Don't use this function directly. Use registerOptionFactories instead.

Definition at line 1043 of file test_control.cc.

References D6O_CLIENTID, D6O_ELAPSED_TIME, D6O_IA_NA, D6O_IA_PD, D6O_ORO, D6O_RAPID_COMMIT, and D6O_SERVERID.

Referenced by removeUniqueAddr().

◆ removeUniqueAddr()

void isc::perfdhcp::TestControl::removeUniqueAddr ( const std::set< std::string > &  addr)
inlineprotected

◆ reset()

void isc::perfdhcp::TestControl::reset ( )
protected

Resets internal state of the object.

Method resets internal state of the object. It has to be called before new test is started.

Definition at line 1097 of file test_control.cc.

Referenced by removeUniqueAddr(), and TestControl().

◆ runWrapped()

void isc::perfdhcp::TestControl::runWrapped ( bool  do_stop = false) const

Run wrapped command.

Parameters
do_stopexecute wrapped command with "stop" argument.

Definition at line 1161 of file test_control.cc.

References isc::perfdhcp::CommandOptions::getWrapped(), handleChild(), isc_throw, and options_.

Referenced by stop().

+ Here is the call graph for this function:

◆ saveFirstPacket() [1/2]

void isc::perfdhcp::TestControl::saveFirstPacket ( const dhcp::Pkt4Ptr pkt)
inlineprotected

Save the first DHCPv4 sent packet of the specified type.

This method saves first packet of the specified being sent to the server if user requested diagnostics flag 'T'. In such case program has to print contents of selected packets being sent to the server. It collects first packets of each type and keeps them around until test finishes. Then they are printed to the user. If packet of specified type has been already stored this function performs no operation. This function does not perform sanity check if packet pointer is valid. Make sure it is before calling it.

Parameters
pktpacket to be stored.

Definition at line 1175 of file test_control.cc.

References options_, template_packets_v4_, and isc::perfdhcp::CommandOptions::testDiags().

Referenced by removeUniqueAddr(), sendDiscover4(), sendRequest4(), sendRequest6(), and sendSolicit6().

+ Here is the call graph for this function:

◆ saveFirstPacket() [2/2]

void isc::perfdhcp::TestControl::saveFirstPacket ( const dhcp::Pkt6Ptr pkt)
inlineprotected

Save the first DHCPv6 sent packet of the specified type.

This method saves first packet of the specified being sent to the server if user requested diagnostics flag 'T'. In such case program has to print contents of selected packets being sent to the server. It collects first packets of each type and keeps them around until test finishes. Then they are printed to the user. If packet of specified type has been already stored this function performs no operation. This function does not perform sanity check if packet pointer is valid. Make sure it is before calling it.

Parameters
pktpacket to be stored.

Definition at line 1184 of file test_control.cc.

References options_, template_packets_v6_, and isc::perfdhcp::CommandOptions::testDiags().

+ Here is the call graph for this function:

◆ sendDiscover4() [1/2]

void isc::perfdhcp::TestControl::sendDiscover4 ( const bool  preload = false)
protected

Send DHCPv4 DISCOVER message.

Method creates and sends DHCPv4 DISCOVER message to the server with the following options:

  • MESSAGE_TYPE set to DHCPDISCOVER
  • PARAMETER_REQUEST_LIST with the same list of requested options as described in factoryRequestList4. The transaction id and MAC address are randomly generated for the message. Range of unique MAC addresses generated depends on the number of clients specified from the command line. Copy of sent packet is stored in the stats_mgr_ object to update statistics.
Parameters
preloadpreload mode, packets not included in statistics.
Exceptions
isc::Unexpectedif failed to create new packet instance.
isc::BadValueif MAC address has invalid length.
isc::dhcp::SocketWriteErrorif failed to send the packet.

Definition at line 1193 of file test_control.cc.

References addExtraOpts(), isc::dhcp::DHCPDISCOVER, isc::dhcp::DHO_DHCP_MESSAGE_TYPE, isc::dhcp::DHO_DHCP_PARAMETER_REQUEST_LIST, isc::perfdhcp::DO, generateClientId(), generateMacAddress(), generateTransid(), isc::perfdhcp::CommandOptions::getIncreaseElapsedTime(), isc::perfdhcp::StatsMgr::getTestPeriod(), isc::perfdhcp::CommandOptions::getWaitForElapsedTime(), isc::dhcp::HTYPE_ETHER, isc_throw, options_, isc::perfdhcp::StatsMgr::passSentPacket(), saveFirstPacket(), isc::perfdhcp::BasePerfSocket::send(), setDefaults4(), socket_, and stats_mgr_.

Referenced by removeUniqueAddr().

+ Here is the call graph for this function:

◆ sendDiscover4() [2/2]

void isc::perfdhcp::TestControl::sendDiscover4 ( const std::vector< uint8_t > &  template_buf,
const bool  preload = false 
)
protected

Send DHCPv4 DISCOVER message from template.

Method sends DHCPv4 DISCOVER message from template. The template data is expected to be in binary format. Provided buffer is copied and parts of it are replaced with actual data (e.g. MAC address, transaction id etc.). Copy of sent packet is stored in the stats_mgr_ object to update statistics.

Parameters
template_bufbuffer holding template packet.
preloadpreload mode, packets not included in statistics.
Exceptions
isc::OutOfRangeif randomization offset is out of bounds.
isc::dhcp::SocketWriteErrorif failed to send the packet.

Definition at line 1254 of file test_control.cc.

References isc::perfdhcp::DO, generateMacAddress(), generateTransid(), getRandomOffset(), getTransactionIdOffset(), HW_ETHER_LEN, isc_throw, isc::perfdhcp::StatsMgr::passSentPacket(), saveFirstPacket(), isc::perfdhcp::BasePerfSocket::send(), setDefaults4(), socket_, and stats_mgr_.

+ Here is the call graph for this function:

◆ sendMessageFromAck()

bool isc::perfdhcp::TestControl::sendMessageFromAck ( const uint16_t  msg_type)
protected

Send DHCPv4 renew (DHCPREQUEST).

Parameters
msg_typeA type of the message to be sent (DHCPREQUEST or DHCPRELEASE).
Returns
true if the message has been sent, false otherwise.

Definition at line 1300 of file test_control.cc.

References ack_storage_, addExtraOpts(), address4Uniqueness(), createMessageFromAck(), isc::dhcp::DHCPRELEASE, isc::dhcp::DHCPREQUEST, isc_throw, isc::perfdhcp::StatsMgr::passSentPacket(), isc::perfdhcp::RLA, isc::perfdhcp::RNA, isc::perfdhcp::BasePerfSocket::send(), setDefaults4(), socket_, and stats_mgr_.

Referenced by removeUniqueAddr().

+ Here is the call graph for this function:

◆ sendMessageFromReply()

bool isc::perfdhcp::TestControl::sendMessageFromReply ( const uint16_t  msg_type)
protected

Send DHCPv6 Renew or Release message.

This method will select an existing lease from the Reply packet cache If there is no lease that can be renewed or released this method will return false.

Parameters
msg_typeA type of the message to be sent (DHCPV6_RENEW or DHCPV6_RELEASE).
Returns
true if the message has been sent, false otherwise.

Definition at line 1340 of file test_control.cc.

References addExtraOpts(), address6Uniqueness(), createMessageFromReply(), DHCPV6_RELEASE, DHCPV6_RENEW, isc_throw, isc::perfdhcp::StatsMgr::passSentPacket(), reply_storage_, isc::perfdhcp::RL, isc::perfdhcp::RN, isc::perfdhcp::BasePerfSocket::send(), setDefaults6(), socket_, and stats_mgr_.

Referenced by removeUniqueAddr().

+ Here is the call graph for this function:

◆ sendMultipleMessages4()

uint64_t isc::perfdhcp::TestControl::sendMultipleMessages4 ( const uint32_t  msg_type,
const uint64_t  msg_num 
)

Send number of DHCPREQUEST (renew) messages to a server.

Parameters
msg_typeA type of the messages to be sent (DHCPREQUEST or DHCPRELEASE).
msg_numA number of messages to be sent.
Returns
A number of messages actually sent.

Definition at line 587 of file test_control.cc.

Referenced by getServerId().

◆ sendMultipleMessages6()

uint64_t isc::perfdhcp::TestControl::sendMultipleMessages6 ( const uint32_t  msg_type,
const uint64_t  msg_num 
)

Send number of DHCPv6 Renew or Release messages to the server.

Parameters
msg_typeA type of the messages to be sent (DHCPV6_RENEW or DHCPV6_RELEASE).
msg_numA number of messages to be sent.
Returns
A number of messages actually sent.

Definition at line 598 of file test_control.cc.

Referenced by getServerId().

◆ sendPackets()

void isc::perfdhcp::TestControl::sendPackets ( const uint64_t  packets_num,
const bool  preload = false 
)

Send number of packets to initiate new exchanges.

Method initiates the new DHCP exchanges by sending number of DISCOVER (DHCPv4) or SOLICIT (DHCPv6) packets. If preload mode was requested sent packets will not be counted in the statistics. The responses from the server will be received and counted as orphans because corresponding sent packets are not included in StatsMgr for match. When preload mode is disabled and diagnostics flag 'i' is specified then function will be trying to receive late packets before new packets are sent to the server. Statistics of late received packets is updated accordingly.

Todo:
do not count responses in preload mode as orphans.
Parameters
packets_numnumber of packets to be sent.
preloadpreload mode, packets not included in statistics.
Exceptions
isc::Unexpectedif thrown by packet sending method.
isc::InvalidOperationif thrown by packet sending method.
isc::OutOfRangeif thrown by packet sending method.
Todo:
add defines for packet type index that can be used to access template_buffers_.
Todo:
add defines for packet type index that can be used to access template_buffers_.

Definition at line 559 of file test_control.cc.

Referenced by getServerId().

◆ sendRequest4() [1/2]

void isc::perfdhcp::TestControl::sendRequest4 ( const dhcp::Pkt4Ptr discover_pkt4,
const dhcp::Pkt4Ptr offer_pkt4 
)
protected

Send DHCPv4 REQUEST message.

Method creates and sends DHCPv4 REQUEST message to the server. Copy of sent packet is stored in the stats_mgr_ object to update statistics.

Parameters
discover_pkt4DISCOVER packet sent.
offer_pkt4OFFER packet object.
Exceptions
isc::Unexpectedif unexpected error occurred.
isc::InvalidOperationif Statistics Manager has not been initialized.
isc::dhcp::SocketWriteErrorif failed to send the packet.

Set client address.

Definition at line 1371 of file test_control.cc.

References addExtraOpts(), isc::dhcp::DHCPREQUEST, isc::dhcp::DHO_DHCP_PARAMETER_REQUEST_LIST, isc::dhcp::DHO_DHCP_REQUESTED_ADDRESS, isc::dhcp::DHO_DHCP_SERVER_IDENTIFIER, isc::perfdhcp::DO, first_packet_serverid_, generateClientId(), isc::perfdhcp::StatsMgr::getRcvdPacketsNum(), isc_throw, isc::perfdhcp::CommandOptions::isUseFirst(), isc::asiolink::IOAddress::isV4(), options_, isc::perfdhcp::StatsMgr::passSentPacket(), isc::perfdhcp::RA, saveFirstPacket(), isc::perfdhcp::BasePerfSocket::send(), setDefaults4(), socket_, stats_mgr_, and isc::asiolink::IOAddress::toUint32().

Referenced by removeUniqueAddr().

+ Here is the call graph for this function:

◆ sendRequest4() [2/2]

void isc::perfdhcp::TestControl::sendRequest4 ( const std::vector< uint8_t > &  template_buf,
const dhcp::Pkt4Ptr discover_pkt4,
const dhcp::Pkt4Ptr offer_pkt4 
)
protected

Send DHCPv4 REQUEST message from template.

Method sends DHCPv4 REQUEST message from template. Copy of sent packet is stored in the stats_mgr_ object to update statistics.

Parameters
template_bufbuffer holding template packet.
discover_pkt4DISCOVER packet sent.
offer_pkt4OFFER packet received.
Exceptions
isc::dhcp::SocketWriteErrorif failed to send the packet.

Set client address.

Definition at line 1432 of file test_control.cc.

References addExtraOpts(), isc::dhcp::DHO_DHCP_REQUESTED_ADDRESS, isc::dhcp::DHO_DHCP_SERVER_IDENTIFIER, isc::perfdhcp::DO, first_packet_serverid_, getElapsedTimeOffset(), getRandomOffset(), isc::perfdhcp::StatsMgr::getRcvdPacketsNum(), getRequestedIpOffset(), getServerIdOffset(), getTransactionIdOffset(), HW_ETHER_LEN, isc_throw, isc::perfdhcp::CommandOptions::isUseFirst(), isc::asiolink::IOAddress::isV4(), options_, isc::perfdhcp::StatsMgr::passSentPacket(), isc::perfdhcp::RA, saveFirstPacket(), isc::perfdhcp::BasePerfSocket::send(), setDefaults4(), socket_, stats_mgr_, and isc::asiolink::IOAddress::toUint32().

+ Here is the call graph for this function:

◆ sendRequest6() [1/2]

void isc::perfdhcp::TestControl::sendRequest6 ( const dhcp::Pkt6Ptr advertise_pkt6)
protected

Send DHCPv6 REQUEST message.

Method creates and sends DHCPv6 REQUEST message to the server with the following options:

  • D6O_ELAPSED_TIME
  • D6O_CLIENTID
  • D6O_SERVERID Copy of sent packet is stored in the stats_mgr_ object to update statistics.
Parameters
advertise_pkt6ADVERTISE packet object.
Exceptions
isc::Unexpectedif unexpected error occurred.
isc::InvalidOperationif Statistics Manager has not been initialized.
isc::dhcp::SocketWriteErrorif failed to send the packet.

Definition at line 1541 of file test_control.cc.

References addExtraOpts(), copyIaOptions(), D6O_CLIENTID, D6O_ELAPSED_TIME, D6O_SERVERID, DHCPV6_REQUEST, first_packet_serverid_, generateTransid(), isc::perfdhcp::StatsMgr::getRcvdPacketsNum(), isc_throw, isc::perfdhcp::CommandOptions::isUseFirst(), options_, isc::perfdhcp::StatsMgr::passSentPacket(), isc::perfdhcp::RR, isc::perfdhcp::SA, saveFirstPacket(), isc::perfdhcp::BasePerfSocket::send(), setDefaults6(), socket_, and stats_mgr_.

Referenced by removeUniqueAddr().

+ Here is the call graph for this function:

◆ sendRequest6() [2/2]

void isc::perfdhcp::TestControl::sendRequest6 ( const std::vector< uint8_t > &  template_buf,
const dhcp::Pkt6Ptr advertise_pkt6 
)
protected

Send DHCPv6 REQUEST message from template.

Method sends DHCPv6 REQUEST message from template. Copy of sent packet is stored in the stats_mgr_ object to update statistics.

Parameters
template_bufpacket template buffer.
advertise_pkt6ADVERTISE packet object.
Exceptions
isc::dhcp::SocketWriteErrorif failed to send the packet.

Definition at line 1593 of file test_control.cc.

References addExtraOpts(), D6O_CLIENTID, D6O_ELAPSED_TIME, D6O_IA_NA, D6O_SERVERID, DHCPV6_REQUEST, first_packet_serverid_, generateTransid(), getElapsedTimeOffset(), getRandomOffset(), isc::perfdhcp::StatsMgr::getRcvdPacketsNum(), getRequestedIpOffset(), getServerIdOffset(), getTransactionIdOffset(), isc_throw, isc::perfdhcp::CommandOptions::isUseFirst(), options_, isc::perfdhcp::StatsMgr::passSentPacket(), isc::perfdhcp::RR, isc::perfdhcp::SA, isc::perfdhcp::BasePerfSocket::send(), setDefaults6(), socket_, stats_mgr_, template_packets_v6_, and isc::perfdhcp::CommandOptions::testDiags().

+ Here is the call graph for this function:

◆ sendSolicit6() [1/2]

void isc::perfdhcp::TestControl::sendSolicit6 ( const bool  preload = false)
protected

Send DHCPv6 SOLICIT message.

Method creates and sends DHCPv6 SOLICIT message to the server with the following options:

  • D6O_ELAPSED_TIME,
  • D6O_RAPID_COMMIT if rapid commit is requested in command line,
  • D6O_CLIENTID,
  • D6O_ORO (Option Request Option),
  • D6O_IA_NA. Copy of sent packet is stored in the stats_mgr_ object to update statistics.
Parameters
preloadmode, packets not included in statistics.
Exceptions
isc::Unexpectedif failed to create new packet instance.
isc::dhcp::SocketWriteErrorif failed to send the packet.

Definition at line 1707 of file test_control.cc.

References addExtraOpts(), isc::perfdhcp::CommandOptions::LeaseType::ADDRESS, D6O_CLIENTID, D6O_ELAPSED_TIME, D6O_IA_NA, D6O_IA_PD, D6O_ORO, D6O_RAPID_COMMIT, DHCPV6_SOLICIT, generateDuid(), generateTransid(), isc::perfdhcp::CommandOptions::getIncreaseElapsedTime(), isc::perfdhcp::CommandOptions::getLeaseType(), isc::perfdhcp::StatsMgr::getTestPeriod(), isc::perfdhcp::CommandOptions::getWaitForElapsedTime(), isc::perfdhcp::CommandOptions::LeaseType::includes(), isc_throw, isc::perfdhcp::CommandOptions::isRapidCommit(), options_, isc::perfdhcp::StatsMgr::passSentPacket(), isc::perfdhcp::CommandOptions::LeaseType::PREFIX, isc::perfdhcp::SA, saveFirstPacket(), isc::perfdhcp::BasePerfSocket::send(), setDefaults6(), socket_, and stats_mgr_.

Referenced by removeUniqueAddr().

+ Here is the call graph for this function:

◆ sendSolicit6() [2/2]

void isc::perfdhcp::TestControl::sendSolicit6 ( const std::vector< uint8_t > &  template_buf,
const bool  preload = false 
)
protected

Send DHCPv6 SOLICIT message from template.

Method sends DHCPv6 SOLICIT message from template. Copy of sent packet is stored in the stats_mgr_ object to update statistics.

Parameters
template_bufpacket template buffer.
preloadmode, packets not included in statistics.
Exceptions
isc::dhcp::SocketWriteErrorif failed to send the packet.

in template.

Definition at line 1771 of file test_control.cc.

References addExtraOpts(), generateDuid(), generateTransid(), getRandomOffset(), getTransactionIdOffset(), isc_throw, isc::perfdhcp::StatsMgr::passSentPacket(), isc::perfdhcp::SA, saveFirstPacket(), isc::perfdhcp::BasePerfSocket::send(), setDefaults6(), socket_, and stats_mgr_.

+ Here is the call graph for this function:

◆ serverIdReceived()

bool isc::perfdhcp::TestControl::serverIdReceived ( ) const
inline

Get received server id flag.

Definition at line 242 of file test_control.h.

References first_packet_serverid_.

◆ setDefaults4()

void isc::perfdhcp::TestControl::setDefaults4 ( const dhcp::Pkt4Ptr pkt)
protected

Set default DHCPv4 packet parameters.

This method sets default parameters on the DHCPv4 packet:

  • interface name,
  • local port = 68 (DHCP client port),
  • remote port = 67 (DHCP server port),
  • server's address,
  • GIADDR = local address where socket is bound to,
  • hops = 1 (pretending that we are a relay)
Parameters
pktreference to packet to be configured.

Definition at line 1815 of file test_control.cc.

References isc::perfdhcp::BasePerfSocket::getIface(), isc::perfdhcp::BasePerfSocket::ifindex_, isc_throw, and socket_.

Referenced by removeUniqueAddr(), sendDiscover4(), sendMessageFromAck(), and sendRequest4().

+ Here is the call graph for this function:

◆ setDefaults6()

void isc::perfdhcp::TestControl::setDefaults6 ( const dhcp::Pkt6Ptr pkt)
protected

Set default DHCPv6 packet parameters.

This method sets default parameters on the DHCPv6 packet:

  • interface name,
  • interface index,
  • local port,
  • remote port,
  • local address,
  • remote address (server).
Parameters
pktreference to packet to be configured.
Todo:
: support more level of encapsulation, at the moment we only support one, via -A1 option.

Definition at line 1848 of file test_control.cc.

References isc::perfdhcp::BasePerfSocket::getIface(), isc::perfdhcp::BasePerfSocket::ifindex_, isc_throw, and socket_.

Referenced by removeUniqueAddr(), sendMessageFromReply(), sendRequest6(), and sendSolicit6().

+ Here is the call graph for this function:

◆ setMacAddrGenerator()

void isc::perfdhcp::TestControl::setMacAddrGenerator ( const NumberGeneratorPtr generator)
inline

Set new MAC address generator.

Set numbers generator that will be used to generate various MAC addresses to simulate number of clients.

Parameters
generatorobject to be used.

Definition at line 206 of file test_control.h.

References cleanCachedPackets(), and macaddr_gen_.

Referenced by TestControl().

+ Here is the call graph for this function:

◆ setTransidGenerator()

void isc::perfdhcp::TestControl::setTransidGenerator ( const NumberGeneratorPtr generator)
inline

Set new transaction id generator.

Parameters
generatorgenerator object to be used.

Definition at line 195 of file test_control.h.

References transid_gen_.

Referenced by TestControl().

◆ start()

void isc::perfdhcp::TestControl::start ( )
inline

Start receiver.

Definition at line 231 of file test_control.h.

References receiver_, and isc::perfdhcp::Receiver::start().

+ Here is the call graph for this function:

◆ stop()

void isc::perfdhcp::TestControl::stop ( )
inline

Stop receiver.

Definition at line 234 of file test_control.h.

References receiver_, runWrapped(), and isc::perfdhcp::Receiver::stop().

+ Here is the call graph for this function:

◆ validateIA()

bool isc::perfdhcp::TestControl::validateIA ( const dhcp::Pkt6Ptr pkt6)
protected

Process IA in received DHCPv6 packet.

Process IA in received message to check if it contain proper address and/or prefix

Parameters
[in]pkt6object representing DHCPv6 packet received.
Returns
true if the message include correct IA, false otherwise.

Definition at line 909 of file test_control.cc.

References D6O_IA_NA, D6O_IA_PD, D6O_IAADDR, and D6O_IAPREFIX.

Referenced by generateTransid().

◆ vector2Hex()

std::string isc::perfdhcp::TestControl::vector2Hex ( const std::vector< uint8_t > &  vec,
const std::string &  separator = "" 
)
static

Convert vector in hexadecimal string.

Todo:
Consider moving this function to src/lib/util.
Parameters
vecvector to be converted.
separatorseparator.

Definition at line 750 of file test_control.cc.

Referenced by getAllUniqueAddrAdvert(), getServerId(), and isc::perfdhcp::ExchangeStats::receivedLeases().

◆ waitToExit()

bool isc::perfdhcp::TestControl::waitToExit ( )

Delay the exit by a fixed given time to catch up to all exchanges that were already started.

Returns
true if need to wait, false = ok to exit now

Definition at line 48 of file test_control.cc.

Member Data Documentation

◆ ack_storage_

PacketStorage<dhcp::Pkt4> isc::perfdhcp::TestControl::ack_storage_
protected

Storage for DHCPACK messages.

Definition at line 1080 of file test_control.h.

Referenced by sendMessageFromAck().

◆ exit_time_

boost::posix_time::ptime isc::perfdhcp::TestControl::exit_time_

Initialized at first exit condition with the time perfdhcp should exit.

Definition at line 343 of file test_control.h.

◆ first_packet_serverid_

dhcp::OptionBuffer isc::perfdhcp::TestControl::first_packet_serverid_
protected

Buffer holding server id received in first packet.

Definition at line 1092 of file test_control.h.

Referenced by getServerId(), sendRequest4(), sendRequest6(), and serverIdReceived().

◆ HW_ETHER_LEN

const uint8_t isc::perfdhcp::TestControl::HW_ETHER_LEN = 6
static

Length of the Ethernet HW address (MAC) in bytes.

Todo:
Make this variable length as there are cases when HW address is longer than this (e.g. 20 bytes).

Definition at line 190 of file test_control.h.

Referenced by sendDiscover4(), and sendRequest4().

◆ interrupted_

bool isc::perfdhcp::TestControl::interrupted_ = false
staticprotected

Program interrupted flag.

Definition at line 1107 of file test_control.h.

Referenced by interrupted().

◆ last_report_

boost::posix_time::ptime isc::perfdhcp::TestControl::last_report_
protected

Last intermediate report time.

Definition at line 1074 of file test_control.h.

◆ macaddr_gen_

NumberGeneratorPtr isc::perfdhcp::TestControl::macaddr_gen_
protected

Numbers generator for MAC address.

Definition at line 1089 of file test_control.h.

Referenced by setMacAddrGenerator().

◆ number_generator_

UniformRandomIntegerGenerator isc::perfdhcp::TestControl::number_generator_
protected

Generate uniformly distributed integers in range of [min, max].

Definition at line 351 of file test_control.h.

◆ options_

CommandOptions& isc::perfdhcp::TestControl::options_
protected

◆ receiver_

Receiver isc::perfdhcp::TestControl::receiver_
protected

Receiver used to receive DHCP traffic.

Definition at line 1071 of file test_control.h.

Referenced by start(), and stop().

◆ reply_storage_

PacketStorage<dhcp::Pkt6> isc::perfdhcp::TestControl::reply_storage_
protected

Storage for reply messages.

Definition at line 1083 of file test_control.h.

Referenced by sendMessageFromReply().

◆ socket_

BasePerfSocket& isc::perfdhcp::TestControl::socket_
protected

◆ stats_mgr_

StatsMgr isc::perfdhcp::TestControl::stats_mgr_
protected

◆ template_buffers_

TemplateBufferCollection isc::perfdhcp::TestControl::template_buffers_
protected

Packet template buffers.

Definition at line 1095 of file test_control.h.

◆ template_packets_v4_

std::map<uint8_t, dhcp::Pkt4Ptr> isc::perfdhcp::TestControl::template_packets_v4_
protected

First packets send.

They are used at the end of the test to print packet templates when diagnostics flag T is specified. Template for v4.

Definition at line 1101 of file test_control.h.

Referenced by saveFirstPacket().

◆ template_packets_v6_

std::map<uint8_t, dhcp::Pkt6Ptr> isc::perfdhcp::TestControl::template_packets_v6_
protected

Template for v6.

Definition at line 1104 of file test_control.h.

Referenced by saveFirstPacket(), and sendRequest6().

◆ transid_gen_

NumberGeneratorPtr isc::perfdhcp::TestControl::transid_gen_
protected

Transaction id generator.

Definition at line 1086 of file test_control.h.

Referenced by generateTransid(), and setTransidGenerator().

◆ unique_address_

std::set<std::string> isc::perfdhcp::TestControl::unique_address_
protected

Keep addresses and prefixes from advertise msg for uniqueness checks.

Definition at line 1062 of file test_control.h.

Referenced by addUniqeAddr(), getAllUniqueAddrAdvert(), and removeUniqueAddr().

◆ unique_reply_address_

std::set<std::string> isc::perfdhcp::TestControl::unique_reply_address_
protected

Keep addresses and prefixes from reply msg for uniqueness checks.

Definition at line 1065 of file test_control.h.

Referenced by addUniqeAddr(), getAllUniqueAddrReply(), and removeUniqueAddr().


The documentation for this class was generated from the following files: