// Copyright 2018 The Chromium OS Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef SHILL_ICMP_H_
#define SHILL_ICMP_H_

#include <netinet/ip_icmp.h>

#include <memory>

#include <base/macros.h>

#include "shill/net/ip_address.h"

namespace shill {

class IPAddress;
class ScopedSocketCloser;
class Sockets;

// The Icmp class encapsulates the task of sending ICMP frames.
class Icmp {
 public:
  static const int kIcmpEchoCode;

  Icmp();
  Icmp(const Icmp&) = delete;
  Icmp& operator=(const Icmp&) = delete;

  virtual ~Icmp();

  // Create a socket for transmission of ICMP frames.
  virtual bool Start(const IPAddress& destination, int interface_index);

  // Destroy the transmit socket.
  virtual void Stop();

  // Returns whether an ICMP socket is open.
  virtual bool IsStarted() const;

  // Send an ICMP Echo Request (Ping) packet to |destination_|. The ID and
  // sequence number fields of the echo request will be set to |id| and
  // |seq_num| respectively.
  virtual bool TransmitEchoRequest(uint16_t id, uint16_t seq_num);

  // IPv4 and IPv6 implementations of TransmitEchoRequest().
  bool TransmitV4EchoRequest(uint16_t id, uint16_t seq_num);
  bool TransmitV6EchoRequest(uint16_t id, uint16_t seq_num);

  int socket() const { return socket_; }
  const IPAddress& destination() const { return destination_; }
  int interface_index() const { return interface_index_; }

 private:
  friend class IcmpSessionTest;
  friend class IcmpTest;

  // Compute the checksum for Echo Request |hdr| of length |len| according to
  // specifications in RFC 792.
  static uint16_t ComputeIcmpChecksum(const struct icmphdr& hdr, size_t len);

  std::unique_ptr<Sockets> sockets_;
  std::unique_ptr<ScopedSocketCloser> socket_closer_;
  int socket_;
  IPAddress destination_;
  int interface_index_;
};

}  // namespace shill

#endif  // SHILL_ICMP_H_