routed.tproj/trace.h

   1 /*
   2  * Copyright (c) 1999 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * "Portions Copyright (c) 1999 Apple Computer, Inc.  All Rights
   7  * Reserved.  This file contains Original Code and/or Modifications of
   8  * Original Code as defined in and that are subject to the Apple Public
   9  * Source License Version 1.0 (the 'License').  You may not use this file
  10  * except in compliance with the License.  Please obtain a copy of the
  11  * License at http://www.apple.com/publicsource and read it before using
  12  * this file.
  13  *
  14  * The Original Code and all software distributed under the License are
  15  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  16  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  17  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
  19  * License for the specific language governing rights and limitations
  20  * under the License."
  21  *
  22  * @APPLE_LICENSE_HEADER_END@
  23  */
  24 /*
  25  * Copyright (c) 1983, 1988, 1993
  26  *      The Regents of the University of California.  All rights reserved.
  27  *
  28  * Redistribution and use in source and binary forms, with or without
  29  * modification, are permitted provided that the following conditions
  30  * are met:
  31  * 1. Redistributions of source code must retain the above copyright
  32  *    notice, this list of conditions and the following disclaimer.
  33  * 2. Redistributions in binary form must reproduce the above copyright
  34  *    notice, this list of conditions and the following disclaimer in the
  35  *    documentation and/or other materials provided with the distribution.
  36  * 3. All advertising materials mentioning features or use of this software
  37  *    must display the following acknowledgment:
  38  *      This product includes software developed by the University of
  39  *      California, Berkeley and its contributors.
  40  * 4. Neither the name of the University nor the names of its contributors
  41  *    may be used to endorse or promote products derived from this software
  42  *    without specific prior written permission.
  43  *
  44  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  45  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  46  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  47  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  48  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  49  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  50  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  51  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  52  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  53  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  54  * SUCH DAMAGE.
  55  *
  56  *      @(#)defs.h      8.1 (Berkeley) 6/5/93
  57  */
  58
  59 /*
  60  * Routing table management daemon.
  61  */
  62
  63 /*
  64  * Trace record format.
  65  */
  66 struct  iftrace {
  67         struct  timeval ift_stamp;      /* time stamp */
  68         struct  sockaddr ift_who;       /* from/to */
  69         char    *ift_packet;            /* pointer to packet */
  70         short   ift_size;               /* size of packet */
  71         short   ift_metric;             /* metric on associated metric */
  72 };
  73
  74 /*
  75  * Per interface packet tracing buffers.  An incoming and
  76  * outgoing circular buffer of packets is maintained, per
  77  * interface, for debugging.  Buffers are dumped whenever
  78  * an interface is marked down.
  79  */
  80 struct  ifdebug {
  81         struct  iftrace *ifd_records;   /* array of trace records */
  82         struct  iftrace *ifd_front;     /* next empty trace record */
  83         int     ifd_count;              /* number of unprinted records */
  84         struct  interface *ifd_if;      /* for locating stuff */
  85 };
  86
  87 /*
  88  * Packet tracing stuff.
  89  */
  90 EXTERN int      tracepackets;           /* watch packets as they go by */
  91 EXTERN int      tracecontents;          /* watch packet contents as they go by */
  92 EXTERN int      traceactions;           /* on/off */
  93 EXTERN int      tracehistory;           /* on/off */
  94 EXTERN FILE     *ftrace;                /* output trace file */
  95
  96 void traceinit(struct interface *);
  97 void traceon(char *);
  98 void traceoff(void);
  99 void sigtrace(int);
 100 void bumploglevel(void);
 101 void trace(struct ifdebug *, struct sockaddr *, char *, int, int);
 102 struct rt_entry; /* forward reference */
 103 void traceaction(FILE *, char *, struct rt_entry *);
 104 void tracenewmetric(FILE *, struct rt_entry *, int);
 105 void dumpif(FILE *, struct interface *);
 106 void dumptrace(FILE *, char *, struct ifdebug *);
 107 void dumppacket(FILE *, char *, struct sockaddr_in *, char *, int, struct timeval *);
 108
 109 #define TRACE_ACTION(action, route) { \
 110           if (traceactions) \
 111                 traceaction(ftrace, action, route); \
 112         }
 113 #define TRACE_NEWMETRIC(route, newmetric) { \
 114           if (traceactions) \
 115                 tracenewmetric(ftrace, route, newmetric); \
 116         }
 117 #define TRACE_INPUT(ifp, src, pack, size) { \
 118           if (tracehistory) { \
 119                 ifp = if_iflookup(src); \
 120                 if (ifp) \
 121                         trace(&ifp->int_input, src, pack, size, \
 122                                 ntohl(ifp->int_metric)); \
 123           } \
 124           if (tracepackets) \
 125                 dumppacket(ftrace, "from", (struct sockaddr_in *)src, pack, size, &now); \
 126         }
 127 #define TRACE_OUTPUT(ifp, dst, size) { \
 128           if (tracehistory && ifp) \
 129                 trace(&ifp->int_output, dst, packet, size, ifp->int_metric); \
 130           if (tracepackets) \
 131                 dumppacket(ftrace, "to", (struct sockaddr_in *)dst, packet, size, &now); \
 132         }