Blob Blame History Raw
/*
    mtr  --  a network diagnostic tool
    Copyright (C) 1997,1998  Matt Kimball
    Copyright (C) 2005 R.E.Wolff@BitWizard.nl

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License version 2 as 
    published by the Free Software Foundation.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/

#ifndef MTR_MTR_H
#define MTR_MTR_H

#include "config.h"

#include <stdint.h>
#include <sys/socket.h>
#include <arpa/inet.h>

#ifdef HAVE_NETINET_IN_H
#include <netinet/in.h>
#endif

/* Typedefs */
#ifdef ENABLE_IPV6
typedef struct in6_addr ip_t;
#else
typedef struct in_addr ip_t;
#endif

#ifndef HAVE_TIME_T
typedef int time_t;
#endif

/* The __unused__ attribute was added in gcc 3.2.7.  */
#if __GNUC__ >= 3 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 7)
#define ATTRIBUTE_UNUSED __attribute__((__unused__))
#else
#define ATTRIBUTE_UNUSED        /* empty */
#endif

/* The __const__ attribute was added in gcc 2.95.  */
#if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 95)
#define ATTRIBUTE_CONST __attribute__ ((__const__))
#else
#define ATTRIBUTE_CONST         /* empty */
#endif

/* stuff used by display such as report, curses... */
#define MAXFLD 20               /* max stats fields to display */
#define FLD_INDEX_SZ 256

/* net related definitions */
#define SAVED_PINGS 200
#define MAXPATH 8
#define MaxHost 256
#define MinPort 1024
#define MaxPort 65535
#define MAXPACKET 4470          /* largest test packet size */
#define MINPACKET 28            /* 20 bytes IP header and 8 bytes ICMP or UDP */
#define MAXLABELS 8             /* http://kb.juniper.net/KB2190 (+ 3 just in case) */

/* Stream Control Transmission Protocol is defined in netinet/in.h */
#ifdef IPPROTO_SCTP
#define HAS_SCTP 1
#endif

#ifndef HAVE_SOCKLEN_T
typedef int socklen_t;
#endif

struct mtr_ctl {
    int MaxPing;
    float WaitTime;
    float GraceTime;
    char *Hostname;
    char *InterfaceAddress;
    char LocalHostname[128];
    int ipinfo_no;
    int ipinfo_max;
    int cpacketsize;            /* packet size used by ping */
    int bitpattern;             /* packet bit pattern used by ping */
    int tos;                    /* type of service set in ping packet */
#ifdef SO_MARK
    uint32_t mark;
#endif
    ip_t unspec_addr;
    int af;                     /* address family of remote target */
    int mtrtype;                /* type of query packet used */
    int fstTTL;                 /* initial hub(ttl) to ping byMin */
    int maxTTL;                 /* last hub to ping byMin */
    int maxUnknown;             /* stop ping threshold */
    int remoteport;             /* target port for TCP tracing */
    int localport;              /* source port for UDP tracing */
    int probe_timeout;          /* timeout for probe sockets */
    unsigned char fld_active[2 * MAXFLD];       /* SO_MARK to set for ping packet */
    int display_mode;           /* display mode selector */
    int fld_index[FLD_INDEX_SZ];        /* default display field (defined by key in net.h) and order */
    char available_options[MAXFLD];
    int display_offset;         /* only used in text mode */
    void *gtk_data;             /* pointer to hold arbitrary gtk data */
    unsigned int                /* bit field to hold named booleans */
     ForceMaxPing:1,
        use_dns:1,
        show_ips:1,
        enablempls:1, dns:1, reportwide:1, Interactive:1, DisplayMode:5;
};

/* dynamic field drawing */
struct fields {
    const unsigned char key;
    const char *descr;
    const char *title;
    const char *format;
    const int length;
    int (
    *net_xxx) (
    int);
};
/* defined in mtr.c */
extern const struct fields data_fields[MAXFLD];

/* MPLS label object */
struct mplslen {
    unsigned long label[MAXLABELS];     /* label value */
    uint8_t exp[MAXLABELS];     /* experimental bits */
    uint8_t ttl[MAXLABELS];     /* MPLS TTL */
    char s[MAXLABELS];          /* bottom of stack */
    char labels;                /* how many labels did we get? */
};

#endif                          /* MTR_MTR_H */