Icmp.h

Go to the documentation of this file.

/*
 * Copyright (C) 1996-2025 The Squid Software Foundation and contributors
 *
 * Squid software is distributed under GPLv2+ license and includes
 * contributions from numerous individuals and organizations.
 * Please see the COPYING and CONTRIBUTORS files for details.
 */
 
/* DEBUG: section 37    ICMP Routines */
 
#ifndef SQUID_SRC_ICMP_ICMP_H
#define SQUID_SRC_ICMP_ICMP_H
 
#include "ip/Address.h"
 
#define PINGER_PAYLOAD_SZ   8192
 
#define MAX_PAYLOAD 256 // WAS: SQUIDHOSTNAMELEN
#define MAX_PKT4_SZ (sizeof(struct icmphdr) + sizeof(struct icmpEchoData) + 1)
#define MAX_PKT6_SZ (sizeof(struct icmp6_hdr) + sizeof(struct icmpEchoData) + 1)
 
#if USE_ICMP
 
/* This is a line-data format struct. DO NOT alter. */
struct pingerEchoData
{
    pingerEchoData() { memset(&payload, 0, sizeof(payload)); }
    Ip::Address to;
    unsigned char opcode = '\0';
    int psize = 0;
    char payload[PINGER_PAYLOAD_SZ];
};
 
/* This is a line-data format struct. DO NOT alter. */
struct pingerReplyData {
    pingerReplyData() { memset(&payload, 0, sizeof(payload)); }
    Ip::Address from;
    unsigned char opcode = '\0';
    int rtt = 0;
    int hops = 0;
    int psize = 0;
    char payload[PINGER_PAYLOAD_SZ];
};
 
struct icmpEchoData {
    struct timeval tv;
    unsigned char opcode;
    char payload[MAX_PAYLOAD];
};
 
extern int icmp_pkts_sent;
 
#endif /* USE_ICMP */
 
class Icmp
{
public:
    Icmp();
    virtual ~Icmp() {}
 
    virtual int Open() =0;
 
    virtual void Close();
 
#if USE_ICMP
 
    virtual void SendEcho(Ip::Address &to, int opcode, const char *payload=nullptr, int len=0) =0;
 
    virtual void Recv(void) =0;
 
protected:
    /* shared internal methods */
 
    int CheckSum(unsigned short *ptr, int size);
 
    int ipHops(int ttl);
 
    void Log(const Ip::Address &addr, const uint8_t type, const char* pkt_str, const int rtt, const int hops);
 
    /* no use wasting memory */
    int icmp_sock;
    int icmp_ident;
#endif /* USE_ICMP */
};
 
#endif /* SQUID_SRC_ICMP_ICMP_H */