xref: /386bsd/usr/src/sbin/routed/trace.h (revision a2142627)
1 /*
2  * Copyright (c) 1983, 1988 Regents of the University of California.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. All advertising materials mentioning features or use of this software
14  *    must display the following acknowledgement:
15  *	This product includes software developed by the University of
16  *	California, Berkeley and its contributors.
17  * 4. Neither the name of the University nor the names of its contributors
18  *    may be used to endorse or promote products derived from this software
19  *    without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  *
33  *	@(#)trace.h	5.8 (Berkeley) 6/1/90
34  */
35 
36 /*
37  * Routing table management daemon.
38  */
39 
40 /*
41  * Trace record format.
42  */
43 struct	iftrace {
44 	struct	timeval ift_stamp;	/* time stamp */
45 	struct	sockaddr ift_who;	/* from/to */
46 	char	*ift_packet;		/* pointer to packet */
47 	short	ift_size;		/* size of packet */
48 	short	ift_metric;		/* metric on associated metric */
49 };
50 
51 /*
52  * Per interface packet tracing buffers.  An incoming and
53  * outgoing circular buffer of packets is maintained, per
54  * interface, for debugging.  Buffers are dumped whenever
55  * an interface is marked down.
56  */
57 struct	ifdebug {
58 	struct	iftrace *ifd_records;	/* array of trace records */
59 	struct	iftrace *ifd_front;	/* next empty trace record */
60 	int	ifd_count;		/* number of unprinted records */
61 	struct	interface *ifd_if;	/* for locating stuff */
62 };
63 
64 /*
65  * Packet tracing stuff.
66  */
67 int	tracepackets;		/* watch packets as they go by */
68 int	tracecontents;		/* watch packet contents as they go by */
69 int	traceactions;		/* on/off */
70 int	tracehistory;		/* on/off */
71 FILE	*ftrace;		/* output trace file */
72 
73 #define	TRACE_ACTION(action, route) { \
74 	  if (traceactions) \
75 		traceaction(ftrace, action, route); \
76 	}
77 #define	TRACE_NEWMETRIC(route, newmetric) { \
78 	  if (traceactions) \
79 		tracenewmetric(ftrace, route, newmetric); \
80 	}
81 #define	TRACE_INPUT(ifp, src, pack, size) { \
82 	  if (tracehistory) { \
83 		ifp = if_iflookup(src); \
84 		if (ifp) \
85 			trace(&ifp->int_input, src, pack, size, \
86 				ntohl(ifp->int_metric)); \
87 	  } \
88 	  if (tracepackets) \
89 		dumppacket(ftrace, "from", src, pack, size, &now); \
90 	}
91 #define	TRACE_OUTPUT(ifp, dst, size) { \
92 	  if (tracehistory && ifp) \
93 		trace(&ifp->int_output, dst, packet, size, ifp->int_metric); \
94 	  if (tracepackets) \
95 		dumppacket(ftrace, "to", dst, packet, size, &now); \
96 	}
97