1 // Boost pinger (c) 2011 by Guilherme Maciel Ferreira / Intra2net AG
2 // Based upon work copyright (c) 2003-2010 Christopher M. Kohlhoff (ping.cpp)
4 // Distributed under the Boost Software License, Version 1.0.
5 // (See accompanying file LICENSE_1_0.txt or copy at
6 // http://www.boost.org/LICENSE_1_0.txt)
7 #include "icmp/icmppinger.h"
13 #include <boost/bind.hpp>
14 #include <boost/date_time/posix_time/posix_time.hpp>
15 #include <boost/date_time/posix_time/posix_time_types.hpp>
16 #include <boost/uuid/uuid.hpp>
17 #include <boost/uuid/uuid_generators.hpp>
18 #include <boost/foreach.hpp>
20 #include <logfunc.hpp>
22 #include "boost_assert_handler.h"
23 #include "icmp/icmppacketfactory.h"
24 #include "host/networkinterface.hpp"
27 using boost::asio::const_buffers_1;
28 using boost::asio::io_service;
29 using boost::asio::ip::address;
30 using boost::asio::ip::icmp;
31 using boost::function;
32 using boost::posix_time::microsec_clock;
33 using boost::posix_time::seconds;
34 using boost::shared_ptr;
35 using I2n::Logger::GlobalLogger;
37 using boost::asio::ip::icmp;
39 //-----------------------------------------------------------------------------
41 //-----------------------------------------------------------------------------
44 * @brief factory function for IcmpPingers, ensures that set_myself is set
46 * @returns a shared pointer to a Pinger
48 PingerItem IcmpPinger::create(
49 const IoServiceItem io_serv,
50 const icmp::socket::protocol_type &protocol,
51 const string &source_network_interface,
52 const int echo_reply_timeout_in_sec )
55 IcmpPacketDistributorItem distributor = IcmpPacketDistributor::get_distributor(
56 icmp::v4(), source_network_interface, io_serv);
59 IcmpPinger *ptr = new IcmpPinger(io_serv, protocol, echo_reply_timeout_in_sec, distributor);
60 IcmpPingerItem shared_ptr_(ptr);
62 // keep weak pointer to self
63 //shared_ptr_->set_myself( weak_ptr ); //Error: Pinger::set_myself is protected
64 ptr->set_myself( shared_ptr_ );
66 // register in distributor
67 distributor->register_pinger(shared_ptr_);
69 // done, return shared ptr
74 * @brief Parameterized constructor.
76 * @param io_serv The one @c io_service object that controls async processing
77 * @param protocol The network layer protocol to use.
78 * @param source_network_interface The network interface name from where to
80 * @param echo_reply_timeout_in_sec The amount of time to wait for a reply.
82 IcmpPinger::IcmpPinger(
83 const IoServiceItem io_serv,
84 const icmp::socket::protocol_type &protocol,
85 const int echo_reply_timeout_in_sec,
86 const IcmpPacketDistributorItem distributor
88 PacketDistributor( distributor ),
89 DestinationEndpoint(),
91 IcmpPacketReceiveTimer( *io_serv ),
94 TimeSent( microsec_clock::universal_time() ),
95 ReplyReceived( false ),
96 EchoReplyTimeoutInSec( echo_reply_timeout_in_sec ),
97 PingerStatus( PingStatus_NotSent ),
100 // Create "unique" identifier
101 boost::uuids::random_generator random_gen;
102 boost::uuids::uuid random_tag = random_gen();
104 BOOST_ASSERT( sizeof(Identifier) <= random_tag.size() );
105 memcpy( &Identifier, random_tag.data, sizeof(Identifier) );
111 IcmpPinger::~IcmpPinger()
116 * @brief Ping a destination address from an available local source.
118 * @param destination_ip The address of the host to ping.
119 * @param destination_port The port at the destination host to ping.
120 * @param done_handler Done handler will be called on successful ping or timeout.
124 void IcmpPinger::ping(
125 const address &destination_ip,
126 const uint16_t /*destination_port*/, // the ICMP protocol does not use ports
127 function<void(bool)> ping_done_callback
130 PingDoneCallback = ping_done_callback;
133 set_ping_status( PingStatus_NotSent );
135 set_destination_endpoint( destination_ip );
140 void IcmpPinger::stop_pinging()
143 << DestinationEndpoint.address().to_string()
144 << ": stop_pinging" << endl;
147 << DestinationEndpoint.address().to_string()
148 << ": cancel timer" << endl;
149 IcmpPacketReceiveTimer.cancel();
152 << DestinationEndpoint.address().to_string()
153 << ": unregister" << endl;
155 IcmpPingerItem icmp_item = boost::static_pointer_cast<IcmpPinger>( get_myself().lock() );
158 PacketDistributor->unregister_pinger( icmp_item );
161 GlobalLogger.warning()
162 << DestinationEndpoint.address().to_string()
163 << ": weak pointer to pinger broken is empty. Huh?" << endl;
168 void IcmpPinger::set_destination_endpoint( const address &destination_ip )
171 DestinationEndpoint = icmp::endpoint( destination_ip, port );
174 bool IcmpPinger::start_send()
178 IcmpPacketItem icmp_packet_echo_request = IcmpPacketFactory::create_icmp_packet_echo_request(
179 Protocol, Identifier, SequenceNumber );
181 BOOST_ASSERT( PingerStatus == PingStatus_NotSent );
182 return send_echo_request( icmp_packet_echo_request );
185 bool IcmpPinger::send_echo_request( const IcmpPacketItem icmp_packet )
187 boost::asio::streambuf request_buffer;
188 ostream os( &request_buffer );
189 if ( !icmp_packet->write( os ) )
192 << DestinationEndpoint.address().to_string()
193 << ": fail writing ping data." << endl;
196 TimeSent = microsec_clock::universal_time();
198 string dest_address_string = DestinationEndpoint.address().to_string();
199 BOOST_ASSERT( !dest_address_string.empty() );
202 size_t bytes_sent = 0;
206 << DestinationEndpoint.address().to_string()
207 << ": sending ping" << endl;
208 const_buffers_1 data = request_buffer.data();
210 // Block until send the data
211 bytes_sent = PacketDistributor->get_socket()->send_to( data, DestinationEndpoint );
212 if ( bytes_sent != buffer_size( data ) )
215 << DestinationEndpoint.address().to_string()
216 << ": fail sending ping data." << endl;
219 catch ( const exception &ex )
222 << DestinationEndpoint.address().to_string()
223 << ": fail sending ping data. " << ex.what() << endl;
226 ReplyReceived = false;
227 schedule_timeout_echo_reply();
229 return (bytes_sent > 0);
232 void IcmpPinger::schedule_timeout_echo_reply()
234 // Wait up to N seconds for a reply.
235 (void) IcmpPacketReceiveTimer.expires_at(
236 TimeSent + seconds( EchoReplyTimeoutInSec )
238 IcmpPacketReceiveTimer.async_wait(
239 boost::bind( &IcmpPinger::handle_timeout, this, boost::asio::placeholders::error )
244 * @brief Gets called when the ping is finished: Either on timeout or on ping reply
248 void IcmpPinger::handle_timeout(const boost::system::error_code& error)
252 if ( error == boost::asio::error::operation_aborted )
255 GlobalLogger.notice() << "Timer waiting for ICMP echo reply was cancelled!" << endl;
256 // otherwise probably called by IcmpPacketReceiveTimer.cancel in handle_receive_icmp_packet!
259 GlobalLogger.notice() << "Error " << error << " waiting for ICMP echo reply!" << endl;
261 // Still continue with rest of function, so PingStatus is updated and Callback executed
262 // when timer was cancelled
265 // Check ReplyReceived as the timer handler
266 // is also called by Timer.cancel();
267 if ( !ReplyReceived )
270 << DestinationEndpoint.address().to_string()
271 << ": Request timed out" << endl;
273 set_ping_status( PingStatus_FailureTimeout );
276 // Call ping-done handler
277 bool ping_success = (PingerStatus == PingStatus_SuccessReply);
278 PingDoneCallback( ping_success );
283 * @brief Receive ICMP packets
284 * @param bytes_transferred Number of bytes transferred.
285 * @return true if packet matches a request from this pinger, false otherwise
287 bool IcmpPinger::handle_receive_icmp_packet(const IcmpPacketItem icmp_packet,
288 const size_t bytes_transferred )
290 bool does_match = false;
294 // continue, might be an old packet
295 // or return false right away, do not want packet anyway...
297 << DestinationEndpoint.address().to_string()
298 << ": Not interested in packets since we already got a reply"
303 // We can receive all ICMP packets received by the host, so we need to
304 // filter out only the echo replies that match our identifier,
305 // expected sequence number, and destination host address (receive just
306 // the ICMP packets from the host we had ping).
308 if ( icmp_packet->match_echo_reply(
309 Identifier, SequenceNumber,
310 DestinationEndpoint.address() ) )
313 << DestinationEndpoint.address().to_string()
314 << ": Received reply" << endl;
316 ReplyReceived = true;
319 icmp_packet->print( bytes_transferred, TimeSent );
321 set_ping_status( PingStatus_SuccessReply );
323 IcmpPacketReceiveTimer.cancel(); //lint !e534
325 else if ( icmp_packet->match_destination_unreachable(
326 Identifier, SequenceNumber,
327 DestinationEndpoint.address() ) )
330 << DestinationEndpoint.address().to_string()
331 << ": Received destination unreachable" << endl;
333 ReplyReceived = true;
336 icmp_packet->print( bytes_transferred, TimeSent );
338 set_ping_status( PingStatus_FailureDestinationUnreachable );
340 IcmpPacketReceiveTimer.cancel(); //lint !e534
342 else if ( icmp_packet->match_time_exceeded(
343 Identifier, SequenceNumber,
344 DestinationEndpoint.address() ) )
347 << DestinationEndpoint.address().to_string()
348 << ": Received time exceeded" << endl;
350 ReplyReceived = true;
353 icmp_packet->print( bytes_transferred, TimeSent );
355 set_ping_status( PingStatus_FailureDestinationUnreachable );
357 IcmpPacketReceiveTimer.cancel(); //lint !e534
362 << DestinationEndpoint.address().to_string()
363 << ": Received packet that does not match or has wrong seq.nr"
370 void IcmpPinger::set_ping_status( PingStatus ping_status )
372 PingerStatus = ping_status;
375 //------------------------------------------------------------------------
376 // IcmpPacketDistributor
377 //------------------------------------------------------------------------
379 static const std::size_t SOCKET_BUFFER_SIZE = 65536; // 64kB
381 typedef std::set<IcmpPingerItem>::iterator PingerListIterator;
384 bool IcmpPacketDistributor::InstanceIdentifierComparator::operator() (
385 const IcmpPacketDistributor::DistributorInstanceIdentifier &a,
386 const IcmpPacketDistributor::DistributorInstanceIdentifier &b )
389 if ( a.first == boost::asio::ip::icmp::v4() )
391 if ( b.first == boost::asio::ip::icmp::v4() )
392 return a.second < b.second; // v4 == v4
394 BOOST_ASSERT( b.first == boost::asio::ip::icmp::v6() );
395 return true; // a(v4) < b(b6)
399 BOOST_ASSERT( a.first == boost::asio::ip::icmp::v6() );
401 if ( b.first == boost::asio::ip::icmp::v4() )
402 return false; // a(v6) > b(v4)
404 BOOST_ASSERT( b.first == boost::asio::ip::icmp::v6() );
405 return a.second < b.second; // v6 == v6
409 //-----------------------------------------------------------------------------
410 // Definition of IcmpPacketDistributor
411 //-----------------------------------------------------------------------------
413 IcmpPacketDistributor::map_type IcmpPacketDistributor::Instances; // initialize
416 IcmpPacketDistributorItem IcmpPacketDistributor::get_distributor(
417 const icmp::socket::protocol_type &protocol,
418 const std::string &network_interface,
419 const IoServiceItem io_serv )
421 IcmpPacketDistributor::DistributorInstanceIdentifier identifier(
422 protocol, network_interface);
424 // check if there is an instance for this protocol and interface
425 if ( Instances.count(identifier) == 0 )
426 { // need to create an instance for this protocol and network interface
427 GlobalLogger.info() << "Creating IcmpPacketDistributor for interface "
428 << network_interface << std::endl;
429 IcmpPacketDistributorItem new_instance( new IcmpPacketDistributor(
430 protocol, network_interface, io_serv ) );
431 Instances[identifier] = new_instance;
434 BOOST_ASSERT( Instances.count(identifier) == 1 );
436 // return the one instance for this protocol and interface
437 return Instances[identifier];
441 IcmpPacketDistributorItem IcmpPacketDistributor::get_distributor(
442 const icmp::socket::protocol_type &protocol,
443 const std::string &network_interface )
445 IcmpPacketDistributor::DistributorInstanceIdentifier identifier(
446 protocol, network_interface);
448 BOOST_ASSERT( Instances.count(identifier) == 1 );
450 // return the one instance for this protocol and interface
451 return Instances[identifier];
455 IcmpPacketDistributor::IcmpPacketDistributor(
456 const icmp::socket::protocol_type &protocol,
457 const std::string &network_interface,
458 const IoServiceItem io_serv ):
459 Protocol( protocol ),
460 Socket( new icmp::socket(*io_serv, protocol) ),
464 // set TTL for testing
465 //const boost::asio::ip::unicast::hops option( 3 );
466 //Socket->set_option(option);
468 NetworkInterface<icmp::socket, boost::asio::ip::icmp>
469 NetInterface( network_interface, *Socket );
471 if ( !NetInterface.bind() )
474 << "Trouble creating IcmpPacketDistributor for interface "
475 << network_interface// << " and protocol " << protocol
476 << ": could not bind the socket with the local interface. "
477 << ::strerror( errno ) << std::endl;
480 register_receive_handler();
484 void IcmpPacketDistributor::register_receive_handler()
486 // wait for reply, prepare buffer to receive up to SOCKET_BUFFER_SIZE bytes
487 Socket->async_receive(
488 ReplyBuffer.prepare( SOCKET_BUFFER_SIZE ),
489 boost::bind( &IcmpPacketDistributor::handle_receive, this,
490 boost::asio::placeholders::error,
491 boost::asio::placeholders::bytes_transferred )
495 void IcmpPacketDistributor::handle_receive(
496 const boost::system::error_code &error,
497 const size_t &bytes_transferred )
501 GlobalLogger.warning()
502 << ": Received error " << error
503 << " in ICMP packet distributor; end handler and schedule another.";
504 register_receive_handler();
508 // The actual number of bytes received is committed to the buffer so that we
509 // can extract it using a std::istream object.
510 ReplyBuffer.commit( bytes_transferred );
512 GlobalLogger.info() << "received packet in distributor" << std::endl;
514 std::istream is( &ReplyBuffer );
517 GlobalLogger.error() << "Can't handle ReplyBuffer" << std::endl;
521 // Decode the reply packet.
522 IcmpPacketItem icmp_packet = IcmpPacketFactory::create_icmp_packet(
526 GlobalLogger.warning() << "Ignoring broken ICMP packet"
531 GlobalLogger.debug() << "Succesfully parsed ICMP packet"
534 // check which pinger wants this packet
535 bool packet_matches = false;
536 BOOST_FOREACH( const IcmpPingerItem &pinger, PingerList )
538 packet_matches = pinger->handle_receive_icmp_packet(
539 icmp_packet, bytes_transferred);
544 GlobalLogger.info() << "Packet did not match any pinger"
548 // re-register receive handler
549 register_receive_handler();
552 bool IcmpPacketDistributor::register_pinger( const IcmpPingerItem &new_pinger )
554 std::pair<PingerListIterator, bool> result = PingerList.insert(new_pinger);
555 bool was_new = result.second;
557 GlobalLogger.info() << "Register new pinger with IcmpPacketDistributor"
560 GlobalLogger.warning()
561 << "Pinger to register was already known in IcmpPacketDistributor"
567 bool IcmpPacketDistributor::unregister_pinger( const IcmpPingerItem &old_pinger )
569 int n_erased = PingerList.erase(old_pinger);
570 bool was_erased = n_erased > 0;
572 GlobalLogger.info() << "Removed pinger from IcmpPacketDistributor"
575 GlobalLogger.warning()
576 << "Could not find pinger to remove from IcmpPacketDistributor"
582 * @brief for all instances: close sockets, unregister all pingers
584 void IcmpPacketDistributor::clean_up_all()
586 BOOST_FOREACH( IcmpPacketDistributor::map_type::value_type &instance,
589 instance.second->clean_up();
595 void IcmpPacketDistributor::clean_up()
597 if (PingerList.size() == 0)
598 GlobalLogger.notice() << "All IcmpPingers have de-registered :-)"
601 GlobalLogger.warning() << "There were still " << PingerList.size()
602 << " pingers registered in IcmpPacketDistributor!" << std::endl;
605 boost::system::error_code error;
606 //Socket->shutdown(icmp::socket::shutdown_both, error); //both=send&receive
608 // GlobalLogger.warning() << "Received error " << error
609 // << " when shutting down ICMP socket";
610 // always gave an error system:9 (probably EBADF: Bad file descriptor)
612 Socket->close(error);
614 GlobalLogger.warning() << "Received error " << error
615 << " when closing ICMP socket";
618 IcmpPacketDistributor::~IcmpPacketDistributor()
620 GlobalLogger.info() << "Destroying IcmpPacketDistributor" << std::endl;
623 SocketItem IcmpPacketDistributor::get_socket() const