/* * Copyright (c) 1994, 1995, 1996, 1997 * Ohio University. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that: (1) source code * distributions retain the above copyright notice and this paragraph * in its entirety, (2) distributions including binary code include * the above copyright notice and this paragraph in its entirety in * the documentation or other materials provided with the * distribution, and (3) all advertising materials mentioning features * or use of this software display the following acknowledgment: * ``This product includes software developed by the Ohio University * Internetworking Research Laboratory.'' Neither the name of the * University nor the names of its contributors may be used to endorse * or promote products derived from this software without specific * prior written permission. * THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. * * Author: Shawn Ostermann * School of Electrical Engineering and Computer Science * Ohio University * Athens, OH * ostermann@cs.ohiou.edu */ static char const rcsid_tcptrace[] = "@(#)$Header: /home/sdo/src/tcptrace/RCS/tcptrace.h,v 3.31 1997/12/11 21:23:00 sdo Exp $"; #include #include #include #include #include #include #include #if __FreeBSD__ >= 2 #include #if __FreeBSD_version >= 300000 #include #endif #endif #include #include #include #include #include #include #include #include #include #include #include #include /* plotter information */ typedef int PLOTTER; #define NO_PLOTTER -1 #define NCOLORS 8 extern char *ColorNames[NCOLORS]; /* {"green", "red", "blue", "yellow", "purple", "orange", "magenta", "pink"}; */ /* type for a TCP sequence number, ACK, FIN, or SYN */ typedef u_long seqnum; /* length of a segment */ typedef u_long seglen; /* type for a quadrant number */ typedef u_char quadnum; /* 1,2,3,4 */ /* type for a TCP port number */ typedef u_short portnum; /* type for an IP address */ typedef struct in_addr ipaddr; /* type for a timestamp */ typedef struct timeval timeval; #define ZERO_TIME(ptv)(((ptv)->tv_sec == 0) && ((ptv)->tv_usec == 0)) /* type for a Boolean */ typedef u_char Bool; #define TRUE 1 #define FALSE 0 /* type for an internal file pointer */ typedef struct mfile MFILE; /* test 2 IP addresses for equality */ #define IP_SAMEADDR(addr1,addr2) (((addr1).s_addr) == ((addr2).s_addr)) /* copy IP addresses */ #define IP_COPYADDR(toaddr,fromaddr) ((toaddr).s_addr = (fromaddr).s_addr) typedef struct segment { seqnum seq_firstbyte; /* seqnumber of first byte */ seqnum seq_lastbyte; /* seqnumber of last byte */ Bool acked; /* has it been acknowledged? */ u_char retrans; /* retransmit count */ timeval time; /* time the segment was sent */ struct segment *next; struct segment *prev; } segment; typedef struct quadrant { segment *seglist_head; segment *seglist_tail; Bool full; struct quadrant *prev; struct quadrant *next; } quadrant; typedef struct seqspace { quadrant *pquad[4]; } seqspace; typedef struct tcb { /* parent pointer */ struct stcp_pair *ptp; struct tcb *ptwin; /* TCP information */ seqnum ack; seqnum seq; seqnum syn; seqnum fin; seqnum windowend; timeval time; /* TCP options */ u_int mss; Bool f1323_ws; /* did he request 1323 window scaling? */ Bool f1323_ts; /* did he request 1323 timestamps? */ Bool fsack_req; /* did he request SACKs? */ u_char window_scale; /* statistics added */ u_long data_bytes; u_long data_pkts; u_long rexmit_bytes; u_long rexmit_pkts; u_long ack_pkts; u_long win_max; u_long win_min; u_long win_tot; u_long win_zero_ct; u_long min_seq; u_long max_seq; u_long packets; u_char syn_count; u_char fin_count; u_char reset_count; /* resets SENT */ u_long min_seg_size; u_long max_seg_size; u_long out_order_pkts; /* out of order packets */ u_long sacks_sent; /* sacks returned */ /* added for initial window stats (for Mallman) */ u_long initialwin_bytes; /* initial window (in bytes) */ u_long initialwin_segs; /* initial window (in segments) */ Bool data_acked; /* has any non-SYN data been acked? */ /* added for (estimated) congestions window stats (for Mallman) */ u_long cwin_max; u_long cwin_min; u_long cwin_tot; /* RTT stats for singly-transmitted segments */ u_long rtt_min; u_long rtt_max; double rtt_sum; /* for averages */ double rtt_sum2; /* sum of squares, for stdev */ u_long rtt_count; /* for averages */ /* RTT stats for multiply-transmitted segments */ u_long rtt_min_last; u_long rtt_max_last; double rtt_sum_last; /* from last transmission, for averages */ double rtt_sum2_last; /* sum of squares, for stdev */ u_long rtt_count_last; /* from last transmission, for averages */ /* ACK Counters */ u_long rtt_amback; /* ambiguous ACK */ u_long rtt_cumack; /* segments only cumulativly ACKed */ u_long rtt_unkack; /* unknown ACKs ??? */ u_long rtt_dupack; /* duplicate ACKs */ /* retransmission information */ seqspace *ss; /* the sequence space*/ u_long retr_max; /* maximum retransmissions ct */ u_long retr_min_tm; /* minimum retransmissions time */ u_long retr_max_tm; /* maximum retransmissions time */ double retr_tm_sum; /* for averages */ double retr_tm_sum2; /* sum of squares, for stdev */ u_long retr_tm_count; /* for averages */ /* Instantaneous throughput info */ timeval thru_firsttime; /* time of first packet this interval */ double thru_lastthru_i; /* last instantaneous throughput value */ u_long thru_bytes; /* number of bytes this interval */ u_long thru_pkts; /* number of packets this interval */ double thru_lastthru_t; /* last average throughput value */ PLOTTER thru_plotter; /* throughput data dump file */ timeval thru_lasttime; /* time of previous segment */ /* data transfer time stamps - mallman */ timeval first_data_time; timeval last_data_time; /* Time Sequence Graph info for this one */ PLOTTER tsg_plotter; char *tsg_plotfile; /* Dumped RTT samples */ MFILE *rtt_dump_file; /* Extracted stream contents */ MFILE *extracted_contents_file; u_long trunc_bytes; /* data bytes not see due to trace file truncation */ u_long trunc_segs; /* segments with trunc'd bytes */ u_long extr_lastseq; /* last sequence number we stored */ /* RTT Graph info for this one */ PLOTTER rtt_plotter; u_long rtt_lastrtt; timeval rtt_lasttime; /* host name letter(s) */ char *host_letter; } tcb; typedef u_short hash; typedef struct { ipaddr a_address; ipaddr b_address; portnum a_port; portnum b_port; hash hash; } tcp_pair_addrblock; struct stcp_pair { /* are we ignoring this one?? */ Bool ignore_pair; /* inactive (previous instance of current connection */ Bool inactive; /* endpoint identification */ tcp_pair_addrblock addr_pair; /* connection information */ char *a_endpoint; char *b_endpoint; timeval first_time; timeval last_time; u_long packets; tcb a2b; tcb b2a; /* module-specific structures, if requested */ void **pmod_info; /* linked list of usage */ struct stcp_pair *next; }; typedef struct stcp_pair tcp_pair; typedef struct tcphdr tcphdr; extern int num_tcp_pairs; /* how many pairs are in use */ extern tcp_pair **ttp; /* array of pointers to allocated pairs */ /* option flags */ extern Bool colorplot; extern Bool dump_rtt; extern Bool graph_rtt; extern Bool graph_tput; extern Bool graph_tsg; extern Bool hex; extern Bool ignore_non_comp; extern Bool nonames; extern Bool print_rtt; extern Bool print_cwin; extern Bool printbrief; extern Bool printsuppress; extern Bool printem; extern Bool printticks; extern Bool printtrunc; extern Bool show_out_order; extern Bool show_rexmit; extern Bool show_zero_window; extern Bool use_short_names; extern Bool save_tcp_data; extern Bool graph_time_zero; extern int debug; extern int thru_interval; extern int pnum; extern int ctrunc; extern timeval current_time; #define MAX_NAME 20 /* external routine decls */ double sqrt(double x); char *ether_ntoa(struct ether_addr *e); void free(void *); int finite(double); /* global routine decls */ void *MallocZ(int); void *ReallocZ(void *oldptr, int obytes, int nbytes); void trace_init(void); void trace_done(void); void seglist_init(tcb *); void printpacket(int, int, void *, int, struct ip *, void *plast); void plotter_vtick(PLOTTER, timeval, u_long); void plotter_utick(PLOTTER, timeval, u_long); void plotter_uarrow(PLOTTER, timeval, u_long); void plotter_tick(PLOTTER, timeval, u_long, char); void plotter_text(PLOTTER, timeval, u_long, char *, char *); void plotter_temp_color(PLOTTER, char *color); void plotter_ltick(PLOTTER, timeval, u_long); void plotter_rtick(PLOTTER, timeval, u_long); void plotter_rarrow(PLOTTER, timeval, u_long); void plotter_plus(PLOTTER, timeval, u_long); void plotter_perm_color(PLOTTER, char *color); void plotter_line(PLOTTER, timeval, u_long, timeval, u_long); void plotter_larrow(PLOTTER, timeval, u_long); void plotter_htick(PLOTTER, timeval, u_long); void plotter_dtick(PLOTTER, timeval, u_long); void plotter_dot(PLOTTER, timeval, u_long); void plotter_done(void); void plotter_dline(PLOTTER, timeval, u_long, timeval, u_long); void plotter_diamond(PLOTTER, timeval, u_long); void plotter_darrow(PLOTTER, timeval, u_long); void plotter_box(PLOTTER, timeval, u_long); void plotter_arrow(PLOTTER, timeval, u_long, char); void plot_init(void); tcp_pair *dotrace(struct ip *, void *plast); void PrintRawData(char *label, void *pfirst, void *plast); void PrintTrace(tcp_pair *); void PrintBrief(tcp_pair *); void OnlyConn(int); void IgnoreConn(int); double elapsed(timeval, timeval); int ConnReset(tcp_pair *); int ConnComplete(tcp_pair *); char *ts2ascii(timeval *); char *ServiceName(portnum); char *HostName(ipaddr); char *HostLetter(u_int); char *EndpointName(ipaddr,portnum); PLOTTER new_plotter(tcb *plast, char *filename, char *title, char *xlabel, char *ylabel, char *suffix); int rexmit(tcb *, seqnum, seglen, Bool *); void ack_in(tcb *, seqnum); void DoThru(tcb *ptcb, int nbytes); struct mfile *Mfopen(char *fname, char *mode); void Minit(void); int Mfileno(MFILE *pmf); int Mvfprintf(MFILE *pmf, char *format, va_list ap); int Mfwrite(char *buf, u_long size, u_long nitems, MFILE *pmf); long Mftell(MFILE *pmf); int Mfseek(MFILE *pmf, long offset, int ptrname); int Mfprintf(MFILE *pmf, char *format, ...); int Mfflush(MFILE *pmf); int Mfclose(MFILE *pmf); struct tcp_options *ParseOptions(struct tcphdr *ptcp, void *plast); FILE *CompOpenHeader(char *filename); FILE *CompOpenFile(char *filename); void CompCloseFile(char *filename); void CompFormats(void); int CompIsCompressed(void); /* TCP flags macros */ #define SYN_SET(ptcp)((ptcp)->th_flags & TH_SYN) #define FIN_SET(ptcp)((ptcp)->th_flags & TH_FIN) #define ACK_SET(ptcp)((ptcp)->th_flags & TH_ACK) #define RESET_SET(ptcp)((ptcp)->th_flags & TH_RST) #define PUSH_SET(ptcp)((ptcp)->th_flags & TH_PUSH) #define URGENT_SET(ptcp)((ptcp)->th_flags & TH_URG) /* connection directions */ #define A2B 1 #define B2A -1 /*macros for maintaining the seqspace used for rexmit*/ #define QUADSIZE (0x40000000) #define QUADNUM(seq) ((seq>>30)+1) #define IN_Q1(seq) (QUADNUM(seq)==1) #define IN_Q2(seq) (QUADNUM(seq)==2) #define IN_Q3(seq) (QUADNUM(seq)==3) #define IN_Q4(seq) (QUADNUM(seq)==4) #define FIRST_SEQ(quadnum) (QUADSIZE*(quadnum-1)) #define LAST_SEQ(quadnum) ((QUADSIZE-1)*quadnum) #define BOUNDARY(beg,fin) (QUADNUM((beg)) != QUADNUM((fin))) /* physical layers currently understood */ #define PHYS_ETHER 1 #define PHYS_FDDI 2 /* * SEQCMP - sequence space comparator * This handles sequence space wrap-around. Overlow/Underflow makes * the result below correct ( -, 0, + ) for any a, b in the sequence * space. Results: result implies * - a < b * 0 a = b * + a > b */ #define SEQCMP(a, b) ((long)(a) - (long)(b)) #define SEQ_LESSTHAN(a, b) (SEQCMP(a,b) < 0) #define SEQ_GREATERTHAN(a, b) (SEQCMP(a,b) > 0) /* SACK TCP options (not an RFC yet, mostly from draft and RFC 1072) */ /* I'm assuming, for now, that the draft version is correct */ /* sdo -- Tue Aug 20, 1996 */ #define TCPOPT_SACK_PERM 4 /* sack-permitted option */ #define TCPOPT_SACK 5 /* sack attached option */ #define MAX_SACKS 10 /* max number of sacks per segment (rfc1072) */ typedef struct sack_block { seqnum sack_left; /* left edge */ seqnum sack_right; /* right edge */ } sack_block; /* RFC 1323 TCP options (not usually in tcp.h yet) */ #define TCPOPT_WS 3 /* window scaling */ #define TCPOPT_TS 8 /* timestamp */ struct tcp_options { short mss; /* maximum segment size */ char ws; /* window scale (1323) */ long tsval; /* Time Stamp Val (1323) */ long tsecr; /* Time Stamp Echo Reply (1323) */ Bool sack_req; /* sacks requested */ char sack_count; /* sack count in this packet */ sack_block sacks[MAX_SACKS]; /* sack blocks */ }; /* * File extensions to use * */ #define RTT_DUMP_FILE_EXTENSION "_rttraw.dat" #define RTT_GRAPH_FILE_EXTENSION "_rtt.xpl" #define PLOT_FILE_EXTENSION "_tsg.xpl" #define THROUGHPUT_FILE_EXTENSION "_tput.xpl" #define CONTENTS_FILE_EXTENSION "_contents.dat" /* packet-reading options... */ /* the type for a packet reading routine */ typedef int pread_f(struct timeval *, int *, int *, void **, int *, struct ip **, void **); /* give the prototypes for the is_GLORP() routines supported */ #ifdef GROK_SNOOP pread_f *is_snoop(void); #endif /* GROK_SNOOP */ #ifdef GROK_NETM pread_f *is_netm(void); #endif /* GROK_NETM */ #ifdef GROK_TCPDUMP pread_f *is_tcpdump(void); #endif /* GROK_TCPDUMP */ #ifdef GROK_ETHERPEEK pread_f *is_EP(void); #endif /* GROK_ETHERPEEK */ /* I've had problems with the memcpy function that gcc stuffs into the program and alignment problems. This should fix it! */ void *MemCpy(void *p1, void *p2, size_t n); /* in tcptrace.c */ #define memcpy(p1,p2,n) MemCpy(p1,p2,n); /* * fixes for various systems that aren't exactly like Solaris */ #ifndef IP_MAXPACKET #define IP_MAXPACKET 65535 #endif /* IP_MAXPACKET */ #ifndef ETHERTYPE_REVARP #define ETHERTYPE_REVARP 0x8035 #endif /* ETHERTYPE_REVARP */