bsd/netat/debug.h

   1 /*
   2  * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * Copyright (c) 1999-2003 Apple Computer, Inc.  All Rights Reserved.
   7  *
   8  * This file contains Original Code and/or Modifications of Original Code
   9  * as defined in and that are subject to the Apple Public Source License
  10  * Version 2.0 (the 'License'). You may not use this file except in
  11  * compliance with the License. Please obtain a copy of the License at
  12  * http://www.opensource.apple.com/apsl/ and read it before using this
  13  * file.
  14  *
  15  * The Original Code and all software distributed under the License are
  16  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  17  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  18  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  20  * Please see the License for the specific language governing rights and
  21  * limitations under the License.
  22  *
  23  * @APPLE_LICENSE_HEADER_END@
  24  */
  25 /*
  26  *      Copyright (c) 1988, 1989, 1997 Apple Computer, Inc.
  27  */
  28
  29 /* netat/debug.h */
  30
  31 #ifndef _NETAT_DEBUG_H_
  32 #define _NETAT_DEBUG_H_
  33 #include <sys/appleapiopts.h>
  34 #ifdef __APPLE_API_PRIVATE
  35
  36 #define D_L_FATAL               0x00000001
  37 #define D_L_ERROR               0x00000002
  38 #define D_L_WARNING             0x00000004
  39 #define D_L_INFO                0x00000008
  40 #define D_L_VERBOSE             0x00000010
  41 #define D_L_STARTUP             0x00000020
  42 #define D_L_STARTUP_LOW         0x00000040
  43 #define D_L_SHUTDN              0x00000080
  44 #define D_L_SHUTDN_LOW          0x00000100
  45 #define D_L_INPUT               0x00000200
  46 #define D_L_OUTPUT              0x00000400
  47 #define D_L_STATS               0x00000800
  48 #define D_L_STATE_CHG           0x00001000      /* re-aarp, ifState etc. */
  49 #define D_L_ROUTING             0x00002000
  50 #define D_L_DNSTREAM            0x00004000
  51 #define D_L_UPSTREAM            0x00008000
  52 #define D_L_STARTUP_INFO        0x00010000
  53 #define D_L_SHUTDN_INFO         0x00020000
  54 #define D_L_ROUTING_AT          0x00040000      /* atalk address routing */
  55 #define D_L_USR1                0x01000000
  56 #define D_L_USR2                0x02000000
  57 #define D_L_USR3                0x04000000
  58 #define D_L_USR4                0x08000000
  59 #define D_L_TRACE               0x10000000
  60
  61
  62 #define D_M_PAT                 0x00000001
  63 #define D_M_PAT_LOW             0x00000002
  64 #define D_M_ELAP                0x00000004
  65 #define D_M_ELAP_LOW            0x00000008
  66 #define D_M_DDP                 0x00000010
  67 #define D_M_DDP_LOW             0x00000020
  68 #define D_M_NBP                 0x00000040
  69 #define D_M_NBP_LOW             0x00000080
  70 #define D_M_ZIP                 0x00000100
  71 #define D_M_ZIP_LOW             0x00000200
  72 #define D_M_RTMP                0x00000400
  73 #define D_M_RTMP_LOW            0x00000800
  74 #define D_M_ATP                 0x00001000
  75 #define D_M_ATP_LOW             0x00002000
  76 #define D_M_ADSP                0x00004000
  77 #define D_M_ADSP_LOW            0x00008000
  78 #define D_M_AEP                 0x00010000
  79 #define D_M_AARP                0x00020000
  80 #define D_M_ASP                 0x00040000
  81 #define D_M_ASP_LOW             0x00080000
  82 #define D_M_AURP                0x00100000
  83 #define D_M_AURP_LOW            0x00200000
  84 #define D_M_TRACE               0x10000000
  85
  86         /* macros for working with atp data at the lap level.
  87          * These are for tracehook performance measurements only!!!
  88          * It is assumed that the ddp & atp headers are at the top of the
  89          * mblk, occupy contiguous memory and the atp headers are of the
  90          * extended type only.
  91          */
  92
  93 typedef struct dbgBits {
  94         unsigned long   dbgMod; /* debug module bitmap (used in dPrintf) */
  95         unsigned long   dbgLev; /* debug level bitmap */
  96 } dbgBits_t;
  97
  98 extern dbgBits_t        dbgBits;
  99
 100         /* macros for debugging */
 101 #ifdef DEBUG
 102 #define dPrintf(mod, lev, p) \
 103         if (((mod) & dbgBits.dbgMod) && ((lev) & dbgBits.dbgLev)) {\
 104                  kprintf p;  \
 105         }
 106 #else
 107 #define dPrintf(mod, lev, p)
 108 #endif
 109 \f
 110 /* 8/5/98 LD: Adds MacOSX kernel debugging facility */
 111 /* note: kdebug must be added to the "RELEASE" config in conf/MASTER.ppc */
 112
 113 #include <sys/kdebug.h>
 114 #if KDEBUG
 115 /*
 116   Strings for the "trace/codes" file:
 117
 118 0x02650004      AT_DDPinput
 119
 120 0x02680000      AT_ADSP_Misc
 121 0x02680004      AT_ADSP_RxData
 122 0x02680008      AT_ADSP_SndData
 123 0x0268000C      AT_ADSP_Read
 124 0x02680010      AT_ADSP_Write
 125 0x02680014      AT_ADSP_mbuf
 126 0x02680018      AT_ADSP_putnext
 127 0x0268001c      AT_ADSP_ATrw
 128
 129 */
 130
 131 /* usage:
 132       KERNEL_DEBUG(DBG_AT_DDP_INPUT | DBG_FUNC_START, 0,0,0,0,0);
 133       KERNEL_DEBUG(DBG_AT_DDP_INPUT, 0,0,0,0,0);
 134       KERNEL_DEBUG(DBG_AT_DDP_INPUT | DBG_FUNC_END, 0,0,0,0,0);
 135 */
 136
 137 #define DBG_AT_DDP_INPUT NETDBG_CODE(DBG_NETDDP, 1)
 138 #define DBG_AT_DDP_OUTPUT NETDBG_CODE(DBG_NETDDP, 2)
 139
 140 #define DBG_ADSP_MISC   NETDBG_CODE(DBG_NETADSP, 0)
 141 #define DBG_ADSP_RCV    NETDBG_CODE(DBG_NETADSP, 1)
 142 #define DBG_ADSP_SND    NETDBG_CODE(DBG_NETADSP, 2)
 143 #define DBG_ADSP_READ   NETDBG_CODE(DBG_NETADSP, 3)
 144 #define DBG_ADSP_WRITE  NETDBG_CODE(DBG_NETADSP, 4)
 145 #define DBG_ADSP_MBUF   NETDBG_CODE(DBG_NETADSP, 5)
 146 #define DBG_ADSP_PNEXT  NETDBG_CODE(DBG_NETADSP, 6)
 147 #define DBG_ADSP_ATRW   NETDBG_CODE(DBG_NETADSP, 7)
 148 #endif
 149
 150 #define trace_mbufs(pri, str, start)\
 151 { if (start)\
 152 {   int i; gbuf_t *tmp;\
 153     for (tmp=start, i=0; tmp && i < 10; tmp = gbuf_cont(tmp), i++) {\
 154         dPrintf(pri, D_L_TRACE, ("%s=0x%x, len=%d %s\n",\
 155                                  str, tmp, gbuf_len(tmp),\
 156                                  (((struct mbuf *)tmp)->m_flags & M_EXT)?"CL":""));\
 157         KERNEL_DEBUG(DBG_ADSP_MBUF,  0, tmp, gbuf_len(tmp), gbuf_next(tmp), \
 158                 ((struct mbuf *)tmp)->m_flags & M_EXT);\
 159 }}}
 160
 161 /* from h/atlog.h */
 162
 163 /* These pointers are non-NULL if logging or tracing are activated. */
 164 #ifndef LOG_DRIVER
 165 extern char *log_errp;
 166 extern char *log_trcp;
 167 #endif  /* LOG_DRIVER */
 168
 169 /* ATTRACE() macro.  Use this routine for calling
 170  * streams tracing and logging.  If `log' is TRUE, then
 171  * this event will also be logged if logging is on.
 172  */
 173 #if !defined(lint) && defined(AT_DEBUG)
 174 #define ATTRACE(mid,sid,level,log,fmt,arg1,arg2,arg3)           \
 175         if (log_trcp || (log && log_errp)) {                    \
 176                 strlog(mid,sid,level,SL_TRACE |                 \
 177                         (log ? SL_ERROR : 0)  |                 \
 178                         (level <= AT_LV_FATAL ? SL_FATAL : 0),  \
 179                         fmt,arg1,arg2,arg3);                    \
 180         }
 181 #else
 182 #define ATTRACE(mid,sid,level,log,fmt,arg1,arg2,arg3)           \
 183 /*      printf(fmt, arg1, arg2, arg3); */
 184
 185 #endif
 186
 187
 188 /* Levels for AppleTalk tracing */
 189
 190 #define AT_LV_FATAL     1
 191 #define AT_LV_ERROR     3
 192 #define AT_LV_WARNING   5
 193 #define AT_LV_INFO      7
 194 #define AT_LV_VERBOSE   9
 195
 196
 197 /* Sub-ids for AppleTalk tracing, add more if you can't figure
 198  * out where your event belongs.
 199  */
 200
 201 #define AT_SID_INPUT    1       /* Network incoming packets */
 202 #define AT_SID_OUTPUT   2       /* Network outgoing packets */
 203 #define AT_SID_TIMERS   3       /* Protocol timers */
 204 #define AT_SID_FLOWCTRL 4       /* Protocol flow control */
 205 #define AT_SID_USERREQ  5       /* User requests */
 206 #define AT_SID_RESOURCE 6       /* Resource limitations */
 207
 208
 209
 210 /* Module ID's for AppleTalk subsystems */
 211
 212 #define AT_MID(n)       (200+n)
 213
 214 /*
 215 #define AT_MID_MISC     AT_MID(0)       not used
 216 #define AT_MID_LLAP     AT_MID(1)       not_used
 217 #define AT_MID_ELAP     202             moved to lap.h
 218 #define AT_MID_DDP      203             moved to ddp.h
 219 #define AT_MID_RTMP     AT_MID(4)       not used
 220 #define AT_MID_NBP      AT_MID(5)       not used
 221 #define AT_MID_EP       AT_MID(6)       not used
 222 #define AT_MID_ATP      AT_MID(7)       not used
 223 #define AT_MID_ZIP      AT_MID(8)       not needed
 224 #define AT_MID_PAP      AT_MID(9)       not used
 225 #define AT_MID_ASP      AT_MID(10)      redefined in adsp.h
 226 #define AT_MID_AFP      AT_MID(11)      not used
 227 #define AT_MID_ADSP     212             moved to adsp.h
 228 #define AT_MID_NBPD     AT_MID(13)      not used
 229 #define AT_MID_LAP      214             moved to lap.h
 230 #define AT_MID_LAST     214
 231 */
 232
 233 #ifdef  AT_MID_STRINGS
 234 static char *at_mid_strings[] = {
 235         "misc",
 236         "LLAP",
 237         "ELAP",
 238         "DDP",
 239         "RTMP",
 240         "NBP",
 241         "EP",
 242         "ATP",
 243         "ZIP",
 244         "PAP",
 245         "ASP",
 246         "AFP",
 247         "ADSP",
 248         "NBPD",
 249         "LAP"
 250 };
 251 #endif
 252
 253
 254 #ifndef SL_FATAL
 255 /* Don't define these if they're already defined */
 256
 257 /* Flags for log messages */
 258
 259 #define SL_FATAL        01      /* indicates fatal error */
 260 #define SL_NOTIFY       02      /* logger must notify administrator */
 261 #define SL_ERROR        04      /* include on the error log */
 262 #define SL_TRACE        010     /* include on the trace log */
 263
 264 #endif
 265
 266 #endif /* __APPLE_API_PRIVATE */
 267 #endif /* _NETAT_DEBUG_H_ */
 268