developer.intra2net.com Git - pingcheck/blob - src/icmp/icmppinger.cpp

   1 // Boost pinger (c) 2011 by Guilherme Maciel Ferreira / Intra2net AG
   2 // Based upon work copyright (c) 2003-2010 Christopher M. Kohlhoff (ping.cpp)
   3 //
   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"
   8
   9 #include <errno.h>
  10
  11 #include <ostream>
  12
  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>
  19
  20 #include <logfunc.hpp>
  21
  22 #include "boost_assert_handler.h"
  23 #include "icmp/icmppacketfactory.h"
  24 #include "host/networkinterface.hpp"
  25
  26 using namespace std;
  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;
  36
  37 using boost::asio::ip::icmp;
  38
  39 //-----------------------------------------------------------------------------
  40 // IcmpPinger
  41 //-----------------------------------------------------------------------------
  42
  43 /**
  44  * @brief factory function for IcmpPingers, ensures that set_myself is set
  45  *
  46  * @returns a shared pointer to a Pinger
  47  */
  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 )
  53 {
  54     // get distributor
  55     IcmpPacketDistributorItem distributor = IcmpPacketDistributor::get_distributor(
  56             protocol, source_network_interface, io_serv);
  57
  58     // create pinger
  59     IcmpPinger *ptr = new IcmpPinger(io_serv, protocol, echo_reply_timeout_in_sec, distributor);
  60     IcmpPingerItem shared_ptr_(ptr);
  61
  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_ );
  65
  66     // register in distributor
  67     distributor->register_pinger(shared_ptr_);
  68
  69     // done, return shared ptr
  70     return shared_ptr_;
  71 }
  72
  73 /**
  74  * @brief Parameterized constructor.
  75  *
  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
  79  * send the packets.
  80  * @param echo_reply_timeout_in_sec The amount of time to wait for a reply.
  81  */
  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
  87 ) :
  88     PacketDistributor( distributor ),
  89     DestinationEndpoint(),
  90     Protocol( protocol ),
  91     IcmpPacketReceiveTimer( *io_serv ),
  92     Identifier( 0 ),
  93     SequenceNumber( 0 ),
  94     TimeSent( microsec_clock::universal_time() ),
  95     ReplyReceived( false ),
  96     EchoReplyTimeoutInSec( echo_reply_timeout_in_sec ),
  97     PingerStatus( PingStatus_NotSent ),
  98     PingDoneCallback(),
  99     LogPrefix("IcmpPinger")
 100 {
 101     // Create "unique" identifier
 102     boost::uuids::random_generator random_gen;
 103     boost::uuids::uuid random_tag = random_gen();
 104
 105     BOOST_ASSERT( sizeof(Identifier) <= random_tag.size() );
 106     memcpy( &Identifier, random_tag.data, sizeof(Identifier) );
 107
 108     LogPrefix = "IPing(no IP yet): ";
 109 }
 110
 111 /**
 112  * @brief Destructor.
 113  */
 114 IcmpPinger::~IcmpPinger()
 115 {
 116 }
 117
 118 /**
 119  * @brief Ping a destination address from an available local source.
 120  *
 121  * @param destination_ip The address of the host to ping.
 122  * @param destination_port The port at the destination host to ping.
 123  * @param done_handler Done handler will be called on successful ping or timeout.
 124  *
 125  * @return void.
 126  */
 127 void IcmpPinger::ping(
 128         const address &destination_ip,
 129         const uint16_t /*destination_port*/, // the ICMP protocol does not use ports
 130         function<void(bool)> ping_done_callback
 131 )
 132 {
 133     PingDoneCallback = ping_done_callback;
 134
 135     // Prepare ping
 136     set_ping_status( PingStatus_NotSent );
 137
 138     set_destination_endpoint( destination_ip );
 139
 140     start_send();
 141 }
 142
 143 void IcmpPinger::stop_pinging()
 144 {
 145     GlobalLogger.debug() << LogPrefix << "stop_pinging" << endl;
 146
 147     GlobalLogger.debug() << LogPrefix << "cancel timer" << endl;
 148     IcmpPacketReceiveTimer.cancel();
 149
 150     GlobalLogger.debug() << LogPrefix << "unregister" << endl;
 151
 152     IcmpPingerItem icmp_item = boost::static_pointer_cast<IcmpPinger>( get_myself().lock() );
 153     if ( icmp_item )
 154     {
 155         PacketDistributor->unregister_pinger( icmp_item );
 156     } else
 157     {
 158         GlobalLogger.warning() << LogPrefix
 159             << "weak pointer to pinger broken is empty. Huh?" << endl;
 160     }
 161 }
 162
 163
 164 void IcmpPinger::set_destination_endpoint( const address &destination_ip )
 165 {
 166     uint16_t port = 0;
 167     DestinationEndpoint = icmp::endpoint( destination_ip, port );
 168
 169     // update LogPrefix
 170     std::stringstream temp;
 171     temp << "IPing(" << DestinationEndpoint.address().to_string() << "): ";
 172     LogPrefix = temp.str();
 173 }
 174
 175 bool IcmpPinger::start_send()
 176 {
 177     ++SequenceNumber;
 178
 179     IcmpPacketItem icmp_packet_echo_request = IcmpPacketFactory::create_icmp_packet_echo_request(
 180             Protocol, Identifier, SequenceNumber );
 181
 182     BOOST_ASSERT( PingerStatus == PingStatus_NotSent );
 183     return send_echo_request( icmp_packet_echo_request );
 184 }
 185
 186 bool IcmpPinger::send_echo_request( const IcmpPacketItem icmp_packet )
 187 {
 188     boost::asio::streambuf request_buffer;
 189     ostream os( &request_buffer );
 190     if ( !icmp_packet->write( os ) )
 191     {
 192         GlobalLogger.error() << LogPrefix << "fail writing ping data." << endl;
 193     }
 194
 195     TimeSent = microsec_clock::universal_time();
 196
 197     string dest_address_string = DestinationEndpoint.address().to_string();
 198     BOOST_ASSERT( !dest_address_string.empty() );
 199
 200     // Send the request
 201     size_t bytes_sent = 0;
 202     try
 203     {
 204         GlobalLogger.info() << LogPrefix << "sending ping" << endl;
 205         const_buffers_1 data = request_buffer.data();
 206
 207         // Block until send the data
 208         bytes_sent = PacketDistributor->get_socket()->send_to( data, DestinationEndpoint );
 209         if ( bytes_sent != buffer_size( data ) )
 210         {
 211             GlobalLogger.error() << LogPrefix << "fail sending ping data."
 212                                  << endl;
 213         }
 214     }
 215     catch ( const exception &ex )
 216     {
 217         GlobalLogger.error() << LogPrefix << "fail sending ping data. "
 218                              << ex.what() << endl;
 219     }
 220
 221     ReplyReceived = false;
 222     schedule_timeout_echo_reply();
 223
 224     return (bytes_sent > 0);
 225 }
 226
 227 void IcmpPinger::schedule_timeout_echo_reply()
 228 {
 229     // Wait up to N seconds for a reply.
 230     (void) IcmpPacketReceiveTimer.expires_at(
 231             TimeSent + seconds( EchoReplyTimeoutInSec )
 232     );
 233     IcmpPacketReceiveTimer.async_wait(
 234             boost::bind( &IcmpPinger::handle_timeout, this, boost::asio::placeholders::error )
 235     );
 236 }
 237
 238 /**
 239  * @brief Gets called when the ping is finished: Either on timeout or on ping reply
 240  *
 241  * @return void
 242  **/
 243 void IcmpPinger::handle_timeout(const boost::system::error_code& error)
 244 {
 245     if (error)
 246     {
 247         if ( error ==  boost::asio::error::operation_aborted )
 248         {
 249             if (! ReplyReceived)
 250                 GlobalLogger.notice() << LogPrefix
 251                     << "Timer waiting for ICMP echo reply was cancelled!"
 252                     << endl;
 253             // otherwise probably called by IcmpPacketReceiveTimer.cancel in
 254             // handle_receive_icmp_packet!
 255         }
 256         else
 257             GlobalLogger.notice() << LogPrefix << "Error " << error
 258                 << " waiting for ICMP echo reply!" << endl;
 259
 260         // Still continue with rest of function, so PingStatus is updated and Callback executed
 261         //   when timer was cancelled
 262     }
 263
 264     // Check ReplyReceived as the timer handler
 265     // is also called by Timer.cancel();
 266     if ( !ReplyReceived )
 267     {
 268         GlobalLogger.info() << LogPrefix << "Request timed out" << endl;
 269
 270         set_ping_status( PingStatus_FailureTimeout );
 271     }
 272
 273     // Call ping-done handler
 274     bool ping_success = (PingerStatus == PingStatus_SuccessReply);
 275     PingDoneCallback( ping_success );
 276 }
 277
 278
 279 /**
 280  * @brief Receive ICMP packets
 281  * @param bytes_transferred Number of bytes transferred.
 282  * @return true if packet matches a request from this pinger, false otherwise
 283  **/
 284 bool IcmpPinger::handle_receive_icmp_packet(const IcmpPacketItem icmp_packet,
 285                                             const size_t bytes_transferred )
 286 {
 287     bool does_match = false;
 288
 289     if ( ReplyReceived )
 290     {
 291         // continue, might be an old packet
 292         // or return false right away, do not want packet anyway...
 293         return does_match;
 294     }
 295     else if ( DestinationEndpoint.address() == address() )
 296     {   // we have no IP set yet
 297         return does_match;
 298     }
 299
 300     // We can receive all ICMP packets received by the host, so we need to
 301     // filter out only the echo replies that match our identifier,
 302     // expected sequence number, and destination host address (receive just
 303     // the ICMP packets from the host we had ping).
 304
 305     try
 306     {
 307         if ( icmp_packet->match_echo_reply(
 308                                 Identifier, SequenceNumber,
 309                                 DestinationEndpoint.address() ) )
 310         {
 311             GlobalLogger.info() << LogPrefix << "Received reply" << endl;
 312
 313             ReplyReceived = true;
 314             does_match = true;
 315
 316             icmp_packet->print( bytes_transferred, TimeSent );
 317
 318             set_ping_status( PingStatus_SuccessReply );
 319
 320             IcmpPacketReceiveTimer.cancel();                            //lint !e534
 321         }
 322         else if ( icmp_packet->match_destination_unreachable(
 323                                      Identifier, SequenceNumber,
 324                                      DestinationEndpoint.address() ) )
 325         {
 326             GlobalLogger.info() << LogPrefix
 327                                 << "Received destination unreachable" << endl;
 328
 329             ReplyReceived = true;
 330             does_match = true;
 331
 332             icmp_packet->print( bytes_transferred, TimeSent );
 333
 334             set_ping_status( PingStatus_FailureDestinationUnreachable );
 335
 336             IcmpPacketReceiveTimer.cancel();                            //lint !e534
 337         }
 338         else if ( icmp_packet->match_time_exceeded(
 339                                      Identifier, SequenceNumber,
 340                                      DestinationEndpoint.address() ) )
 341         {
 342             GlobalLogger.info() << LogPrefix
 343                                 << "Received time exceeded" << endl;
 344
 345             ReplyReceived = true;
 346             does_match = true;
 347
 348             icmp_packet->print( bytes_transferred, TimeSent );
 349
 350             set_ping_status( PingStatus_FailureDestinationUnreachable );
 351
 352             IcmpPacketReceiveTimer.cancel();                            //lint !e534
 353         }
 354         else
 355         {
 356             GlobalLogger.debug() << LogPrefix
 357                << "Received packet that does not match or has wrong seq.nr"
 358                << endl;
 359         }
 360     }
 361     catch ( std::exception &exc)
 362     {
 363         GlobalLogger.warning() << LogPrefix
 364             << "Caught exception in packet interpretation: " << exc.what()
 365             << std::endl;
 366         if ( IcmpPacketFactory::PacketDumpMode == DUMP_ALWAYS ||
 367              IcmpPacketFactory::PacketDumpMode == DUMP_IF_ERROR )
 368             IcmpPacketFactory::dump_packet(*icmp_packet);
 369         does_match = true;   // avoid the same procedure in all other pingers
 370     }
 371     catch ( ... )
 372     {
 373         GlobalLogger.warning() << LogPrefix
 374             << "Caught unspecified exception in packet interpretation!"
 375             << std::endl;
 376         if ( IcmpPacketFactory::PacketDumpMode == DUMP_ALWAYS ||
 377              IcmpPacketFactory::PacketDumpMode == DUMP_IF_ERROR )
 378             IcmpPacketFactory::dump_packet(*icmp_packet);
 379         does_match = true;   // avoid the same procedure in all other pingers
 380     }
 381
 382     return does_match;
 383 }
 384
 385 void IcmpPinger::set_ping_status( PingStatus ping_status )
 386 {
 387     PingerStatus = ping_status;
 388 }
 389
 390 //------------------------------------------------------------------------
 391 // IcmpPacketDistributor
 392 //------------------------------------------------------------------------
 393
 394 static const std::size_t SOCKET_BUFFER_SIZE = 65536;   // 64kB
 395
 396 typedef std::set<IcmpPingerItem>::iterator PingerListIterator;
 397
 398
 399 bool IcmpPacketDistributor::InstanceIdentifierComparator::operator() (
 400                 const IcmpPacketDistributor::DistributorInstanceIdentifier &a,
 401                 const IcmpPacketDistributor::DistributorInstanceIdentifier &b )
 402                                                                           const
 403 {
 404     if ( a.first == boost::asio::ip::icmp::v4() )
 405     {
 406         if ( b.first == boost::asio::ip::icmp::v4() )
 407             return a.second < b.second;   // v4 == v4
 408         else
 409             BOOST_ASSERT( b.first == boost::asio::ip::icmp::v6() );
 410             return true;    // a(v4) < b(b6)
 411     }
 412     else
 413     {
 414         BOOST_ASSERT( a.first == boost::asio::ip::icmp::v6() );
 415
 416         if ( b.first == boost::asio::ip::icmp::v4() )
 417             return false;   // a(v6) > b(v4)
 418         else
 419             BOOST_ASSERT( b.first == boost::asio::ip::icmp::v6() );
 420             return a.second < b.second;    // v6 == v6
 421     }
 422 }
 423
 424 //-----------------------------------------------------------------------------
 425 // Definition of IcmpPacketDistributor
 426 //-----------------------------------------------------------------------------
 427
 428 IcmpPacketDistributor::map_type IcmpPacketDistributor::Instances; // initialize
 429
 430
 431 IcmpPacketDistributorItem IcmpPacketDistributor::get_distributor(
 432         const icmp::socket::protocol_type &protocol,
 433         const std::string &network_interface,
 434         const IoServiceItem io_serv )
 435 {
 436     IcmpPacketDistributor::DistributorInstanceIdentifier identifier(
 437                                                   protocol, network_interface);
 438
 439     // check if there is an instance for this protocol and interface
 440     if ( Instances.count(identifier) == 0 )
 441     {   // need to create an instance for this protocol and network interface
 442         std::string protocol_str;
 443         if (protocol == icmp::v4())
 444             protocol_str = "ICMPv4";
 445         else if (protocol == icmp::v6())
 446             protocol_str = "ICMPv6";
 447         else
 448             protocol_str = "unknown protocol!";
 449
 450         GlobalLogger.info() << "Creating IcmpPacketDistributor for interface "
 451                             << network_interface << " and protocol "
 452                             << protocol_str << std::endl;
 453         IcmpPacketDistributorItem new_instance( new IcmpPacketDistributor(
 454                     protocol, network_interface, io_serv ) );
 455         Instances[identifier] = new_instance;
 456     }
 457
 458     BOOST_ASSERT( Instances.count(identifier) == 1 );
 459
 460     // return the one instance for this protocol and interface
 461     return Instances[identifier];
 462 }
 463
 464
 465 IcmpPacketDistributorItem IcmpPacketDistributor::get_distributor(
 466         const icmp::socket::protocol_type &protocol,
 467         const std::string &network_interface )
 468 {
 469     IcmpPacketDistributor::DistributorInstanceIdentifier identifier(
 470                                                   protocol, network_interface);
 471
 472     BOOST_ASSERT( Instances.count(identifier) == 1 );
 473
 474     // return the one instance for this protocol and interface
 475     return Instances[identifier];
 476 }
 477
 478
 479 IcmpPacketDistributor::IcmpPacketDistributor(
 480             const icmp::socket::protocol_type &protocol,
 481             const std::string &network_interface,
 482             const IoServiceItem io_serv ):
 483     Protocol( protocol ),
 484     Socket( new icmp::socket(*io_serv, protocol) ),
 485     ReplyBuffer(),
 486     PingerList()
 487 {
 488     // set TTL for testing
 489     //const boost::asio::ip::unicast::hops option( 3 );
 490     //Socket->set_option(option);
 491
 492     NetworkInterface<icmp::socket, boost::asio::ip::icmp>
 493                   NetInterface( network_interface, *Socket );
 494
 495     if ( !NetInterface.bind() )
 496     {
 497         GlobalLogger.error()
 498            << "Trouble creating IcmpPacketDistributor for interface "
 499            << network_interface// << " and protocol " << protocol
 500            << ": could not bind the socket with the local interface. "
 501            << ::strerror( errno )  << std::endl;
 502     }
 503
 504     register_receive_handler();
 505 }
 506
 507
 508 void IcmpPacketDistributor::register_receive_handler()
 509 {
 510     // wait for reply, prepare buffer to receive up to SOCKET_BUFFER_SIZE bytes
 511     Socket->async_receive(
 512             ReplyBuffer.prepare( SOCKET_BUFFER_SIZE ),
 513             boost::bind( &IcmpPacketDistributor::handle_receive, this,
 514                          boost::asio::placeholders::error,
 515                          boost::asio::placeholders::bytes_transferred )
 516     );
 517 }
 518
 519 void IcmpPacketDistributor::handle_receive(
 520                                         const boost::system::error_code &error,
 521                                         const size_t &bytes_transferred )
 522 {
 523     if ( error )
 524     {
 525         GlobalLogger.warning()
 526            << ": Received error " << error
 527            << " in ICMP packet distributor; end handler and schedule another.";
 528         register_receive_handler();
 529         return;
 530     }
 531
 532     // The actual number of bytes received is committed to the buffer so that we
 533     // can extract it using a std::istream object.
 534     ReplyBuffer.commit( bytes_transferred );
 535
 536     GlobalLogger.info() << "received packet in distributor" << std::endl;
 537
 538     std::istream is( &ReplyBuffer );
 539     if ( !is )
 540     {
 541         GlobalLogger.error() << "Can't handle ReplyBuffer" << std::endl;
 542         return;
 543     }
 544
 545     // Decode the reply packet.
 546     IcmpPacketItem icmp_packet = IcmpPacketFactory::create_icmp_packet(
 547                                                              Protocol, is );
 548     if ( !icmp_packet )
 549     {
 550         GlobalLogger.warning() << "Ignoring broken ICMP packet"
 551                                << std::endl;
 552     }
 553     else
 554     {
 555         GlobalLogger.debug() << "Succesfully parsed ICMP packet"
 556                              << std::endl;
 557
 558         // check which pinger wants this packet
 559         bool packet_matches = false;
 560         BOOST_FOREACH( const IcmpPingerItem &pinger, PingerList )
 561         {
 562             packet_matches = pinger->handle_receive_icmp_packet(
 563                                             icmp_packet, bytes_transferred);
 564             if (packet_matches)
 565                 break;
 566         }
 567         if (!packet_matches)
 568             GlobalLogger.info() << "Packet did not match any pinger"
 569                                 << std::endl;
 570     }
 571
 572     // re-register receive handler
 573     register_receive_handler();
 574 }
 575
 576 bool IcmpPacketDistributor::register_pinger( const IcmpPingerItem &new_pinger )
 577 {
 578     std::pair<PingerListIterator, bool> result = PingerList.insert(new_pinger);
 579     bool was_new = result.second;
 580     if (was_new)
 581         GlobalLogger.info() << "Register new pinger with IcmpPacketDistributor"
 582                             << std::endl;
 583     else
 584         GlobalLogger.warning()
 585             << "Pinger to register was already known in IcmpPacketDistributor"
 586             << std::endl;
 587     return was_new;
 588 }
 589
 590
 591 bool IcmpPacketDistributor::unregister_pinger( const IcmpPingerItem &old_pinger )
 592 {
 593     int n_erased = PingerList.erase(old_pinger);
 594     bool was_erased = n_erased > 0;
 595     if (was_erased)
 596         GlobalLogger.info() << "Removed pinger from IcmpPacketDistributor"
 597                             << std::endl;
 598     else
 599         GlobalLogger.warning()
 600             << "Could not find pinger to remove from IcmpPacketDistributor"
 601             << std::endl;
 602     return was_erased;
 603 }
 604
 605 /**
 606  * @brief for all instances: close sockets, unregister all pingers
 607  */
 608 void IcmpPacketDistributor::clean_up_all()
 609 {
 610     BOOST_FOREACH( IcmpPacketDistributor::map_type::value_type &instance,
 611                                                                     Instances )
 612     {
 613         instance.second->clean_up();
 614     }
 615
 616     Instances.clear();
 617 }
 618
 619 void IcmpPacketDistributor::clean_up()
 620 {
 621     if (PingerList.size() == 0)
 622         GlobalLogger.info() << "All IcmpPingers have de-registered"
 623                             << std::endl;
 624     else
 625         GlobalLogger.warning() << "There were still " << PingerList.size()
 626             << " pingers registered in IcmpPacketDistributor!" << std::endl;
 627     PingerList.clear();
 628
 629     boost::system::error_code error;
 630     //Socket->shutdown(icmp::socket::shutdown_both, error);  //both=send&receive
 631     //if ( error )
 632     //    GlobalLogger.warning() << "Received error " << error
 633     //                           << " when shutting down ICMP socket";
 634     // always gave an error system:9 (probably EBADF: Bad file descriptor)
 635
 636     Socket->close(error);
 637     if ( error )
 638         GlobalLogger.warning() << "Received error " << error
 639                                << " when closing ICMP socket";
 640 }
 641
 642 IcmpPacketDistributor::~IcmpPacketDistributor()
 643 {
 644     GlobalLogger.info() << "Destroying IcmpPacketDistributor" << std::endl;
 645 }
 646
 647 SocketItem IcmpPacketDistributor::get_socket() const
 648 {
 649     return Socket;
 650 }