xref: /dragonfly/sys/net/altq/altq_rmclass_debug.h (revision 0085a56d)
1 /*	$KAME: altq_rmclass_debug.h,v 1.3 2002/11/29 04:36:24 kjc Exp $	*/
2 /*	$DragonFly: src/sys/net/altq/altq_rmclass_debug.h,v 1.3 2005/06/03 18:20:36 swildner Exp $ */
3 
4 /*
5  * Copyright (c) Sun Microsystems, Inc. 1998 All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  *
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  *
18  * 3. All advertising materials mentioning features or use of this software
19  *    must display the following acknowledgement:
20  *      This product includes software developed by the SMCC Technology
21  *      Development Group at Sun Microsystems, Inc.
22  *
23  * 4. The name of the Sun Microsystems, Inc nor may not be used to endorse or
24  *      promote products derived from this software without specific prior
25  *      written permission.
26  *
27  * SUN MICROSYSTEMS DOES NOT CLAIM MERCHANTABILITY OF THIS SOFTWARE OR THE
28  * SUITABILITY OF THIS SOFTWARE FOR ANY PARTICULAR PURPOSE.  The software is
29  * provided "as is" without express or implied warranty of any kind.
30  *
31  * These notices must be retained in any copies of any part of this software.
32  */
33 
34 #ifndef _ALTQ_ALTQ_RMCLASS_DEBUG_H_
35 #define	_ALTQ_ALTQ_RMCLASS_DEBUG_H_
36 
37 #ifdef _KERNEL
38 #include <sys/thread2.h>
39 #endif
40 
41 /* #pragma ident	"@(#)rm_class_debug.h	1.7	98/05/04 SMI" */
42 
43 /*
44  * Cbq debugging macros
45  */
46 
47 #ifdef	CBQ_TRACE
48 #ifndef NCBQTRACE
49 #define	NCBQTRACE (16 * 1024)
50 #endif
51 
52 /*
53  * To view the trace output, using adb, type:
54  *	adb -k /dev/ksyms /dev/mem <cr>, then type
55  *	cbqtrace_count/D to get the count, then type
56  *	cbqtrace_buffer,0tcount/Dp4C" "Xn
57  *	This will dump the trace buffer from 0 to count.
58  */
59 /*
60  * in ALTQ, "call cbqtrace_dump(N)" from DDB to display 20 events
61  * from Nth event in the circular buffer.
62  */
63 
64 struct cbqtrace {
65 	int count;
66 	int function;		/* address of function */
67 	int trace_action;	/* descriptive 4 characters */
68 	int object;		/* object operated on */
69 };
70 
71 #define	CBQTRACEINIT() {				\
72 	if (cbqtrace_ptr == NULL)		\
73 		cbqtrace_ptr = cbqtrace_buffer; \
74 	else { \
75 		cbqtrace_ptr = cbqtrace_buffer; \
76 		bzero((void *)cbqtrace_ptr, sizeof(cbqtrace_buffer)); \
77 		cbqtrace_count = 0; \
78 	} \
79 }
80 
81 #define	LOCK_TRACE()	crit_enter();
82 #define	UNLOCK_TRACE()	crit_exit();
83 
84 #define	CBQTRACE(func, act, obj) {		\
85 	LOCK_TRACE();				\
86 	int *_p = &cbqtrace_ptr->count;	\
87 	*_p++ = ++cbqtrace_count;		\
88 	*_p++ = (int)(func);			\
89 	*_p++ = (int)(act);			\
90 	*_p++ = (int)(obj);			\
91 	if ((struct cbqtrace *)(void *)_p >= &cbqtrace_buffer[NCBQTRACE])\
92 		cbqtrace_ptr = cbqtrace_buffer; \
93 	else					\
94 		cbqtrace_ptr = (struct cbqtrace *)(void *)_p; \
95 	UNLOCK_TRACE();				\
96 	}
97 #else
98 
99 /* If no tracing, define no-ops */
100 #define	CBQTRACEINIT()
101 #define	CBQTRACE(a, b, c)
102 
103 #endif	/* !CBQ_TRACE */
104 
105 #endif	/* _ALTQ_ALTQ_RMCLASS_DEBUG_H_ */
106