1 /* 2 * Copyright (c) 1999, 2012, Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. Oracle designates this 8 * particular file as subject to the "Classpath" exception as provided 9 * by Oracle in the LICENSE file that accompanied this code. 10 * 11 * This code is distributed in the hope that it will be useful, but WITHOUT 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 14 * version 2 for more details (a copy is included in the LICENSE file that 15 * accompanied this code). 16 * 17 * You should have received a copy of the GNU General Public License version 18 * 2 along with this work; if not, write to the Free Software Foundation, 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 20 * 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22 * or visit www.oracle.com if you need additional information or have any 23 * questions. 24 */ 25 26 #if !defined(_DEBUG_TRACE_H) 27 #define _DEBUG_TRACE_H 28 29 #if defined(__cplusplus) 30 extern "C" { 31 #endif 32 33 #if defined(DEBUG) 34 35 #include "debug_util.h" 36 37 /* Use THIS_FILE when it is available. */ 38 #ifndef THIS_FILE 39 #define THIS_FILE __FILE__ 40 #endif 41 42 typedef int dtrace_id; 43 enum { 44 UNDEFINED_TRACE_ID = -1 /* indicates trace point has not been registered yet */ 45 }; 46 47 /* prototype for client provided output callback function */ 48 typedef void (*DTRACE_OUTPUT_CALLBACK)(const char * msg); 49 50 /* prototype for client provided print callback function */ 51 typedef void (*DTRACE_PRINT_CALLBACK)(const char * file, int line, int argc, const char * fmt, va_list arglist); 52 53 extern void DTrace_EnableAll(dbool_t enabled); 54 extern void DTrace_EnableFile(const char * file, dbool_t enabled); 55 extern void DTrace_EnableLine(const char * file, int linenum, dbool_t enabled); 56 extern void DTrace_SetOutputCallback(DTRACE_OUTPUT_CALLBACK pfn); 57 extern void DTrace_Initialize(); 58 extern void DTrace_Shutdown(); 59 void DTrace_DisableMutex(); 60 extern void DTrace_VPrintImpl(const char * fmt, va_list arglist); 61 extern void DTrace_PrintImpl(const char * fmt, ...); 62 extern void DTrace_PrintFunction(DTRACE_PRINT_CALLBACK pfn, dtrace_id * pFileTraceId, dtrace_id * pTraceId, const char * file, int line, int argc, const char * fmt, ...); 63 64 /* these functions are exported only for use in macros-- do not call them directly!!! */ 65 extern void DTrace_VPrint(const char * file, int line, int argc, const char * fmt, va_list arglist); 66 extern void DTrace_VPrintln(const char * file, int line, int argc, const char * fmt, va_list arglist); 67 68 /* each file includes this flag indicating module trace status */ 69 static dtrace_id _Dt_FileTraceId = UNDEFINED_TRACE_ID; 70 71 /* not meant to be called from client code-- 72 * it's just a template for the other macros 73 */ 74 #define _DTrace_Template(_func, _ac, _f, _a1, _a2, _a3, _a4, _a5, _a6, _a7, _a8) \ 75 { \ 76 static dtrace_id _dt_lineid_ = UNDEFINED_TRACE_ID; \ 77 DTrace_PrintFunction((_func), &_Dt_FileTraceId, &_dt_lineid_, THIS_FILE, __LINE__, (_ac), (_f), (_a1), (_a2), (_a3), (_a4), (_a5), (_a6), (_a7), (_a8) ); \ 78 } 79 80 /* printf style trace macros */ 81 #define DTRACE_PRINT(_fmt) \ 82 _DTrace_Template(DTrace_VPrint, 0, (_fmt), 0, 0, 0, 0, 0, 0, 0, 0) 83 #define DTRACE_PRINT1(_fmt, _arg1) \ 84 _DTrace_Template(DTrace_VPrint, 1, (_fmt), (_arg1), 0, 0, 0, 0, 0, 0, 0) 85 #define DTRACE_PRINT2(_fmt, _arg1, _arg2) \ 86 _DTrace_Template(DTrace_VPrint, 2, (_fmt), (_arg1), (_arg2), 0, 0, 0, 0, 0, 0) 87 #define DTRACE_PRINT3(_fmt, _arg1, _arg2, _arg3) \ 88 _DTrace_Template(DTrace_VPrint, 3, (_fmt), (_arg1), (_arg2), (_arg3), 0, 0, 0, 0, 0) 89 #define DTRACE_PRINT4(_fmt, _arg1, _arg2, _arg3, _arg4) \ 90 _DTrace_Template(DTrace_VPrint, 4, (_fmt), (_arg1), (_arg2), (_arg3), (_arg4), 0, 0, 0, 0) 91 #define DTRACE_PRINT5(_fmt, _arg1, _arg2, _arg3, _arg4, _arg5) \ 92 _DTrace_Template(DTrace_VPrint, 5, (_fmt), (_arg1), (_arg2), (_arg3), (_arg4), (_arg5), 0, 0, 0) 93 #define DTRACE_PRINT6(_fmt, _arg1, _arg2, _arg3, _arg4, _arg5, _arg6) \ 94 _DTrace_Template(DTrace_VPrint, 6, (_fmt), (_arg1), (_arg2), (_arg3), (_arg4), (_arg5), (_arg6), 0, 0) 95 #define DTRACE_PRINT7(_fmt, _arg1, _arg2, _arg3, _arg4, _arg5, _arg6, _arg7) \ 96 _DTrace_Template(DTrace_VPrint, 7, (_fmt), (_arg1), (_arg2), (_arg3), (_arg4), (_arg5), (_arg6), (_arg7), 0) 97 #define DTRACE_PRINT8(_fmt, _arg1, _arg2, _arg3, _arg4, _arg5, _arg6, _arg7, _arg8) \ 98 _DTrace_Template(DTrace_VPrint, 8, (_fmt), (_arg1), (_arg2), (_arg3), (_arg4), (_arg5), (_arg6), (_arg7), (_arg8)) 99 100 /* printf style trace macros that automatically output a newline */ 101 #define DTRACE_PRINTLN(_fmt) \ 102 _DTrace_Template(DTrace_VPrintln, 0, (_fmt), 0, 0, 0, 0, 0, 0, 0, 0) 103 #define DTRACE_PRINTLN1(_fmt, _arg1) \ 104 _DTrace_Template(DTrace_VPrintln, 1, (_fmt), (_arg1), 0, 0, 0, 0, 0, 0, 0) 105 #define DTRACE_PRINTLN2(_fmt, _arg1, _arg2) \ 106 _DTrace_Template(DTrace_VPrintln, 2, (_fmt), (_arg1), (_arg2), 0, 0, 0, 0, 0, 0) 107 #define DTRACE_PRINTLN3(_fmt, _arg1, _arg2, _arg3) \ 108 _DTrace_Template(DTrace_VPrintln, 3, (_fmt), (_arg1), (_arg2), (_arg3), 0, 0, 0, 0, 0) 109 #define DTRACE_PRINTLN4(_fmt, _arg1, _arg2, _arg3, _arg4) \ 110 _DTrace_Template(DTrace_VPrintln, 4, (_fmt), (_arg1), (_arg2), (_arg3), (_arg4), 0, 0, 0, 0) 111 #define DTRACE_PRINTLN5(_fmt, _arg1, _arg2, _arg3, _arg4, _arg5) \ 112 _DTrace_Template(DTrace_VPrintln, 5, (_fmt), (_arg1), (_arg2), (_arg3), (_arg4), (_arg5), 0, 0, 0) 113 #define DTRACE_PRINTLN6(_fmt, _arg1, _arg2, _arg3, _arg4, _arg5, _arg6) \ 114 _DTrace_Template(DTrace_VPrintln, 6, (_fmt), (_arg1), (_arg2), (_arg3), (_arg4), (_arg5), (_arg6), 0, 0) 115 #define DTRACE_PRINTLN7(_fmt, _arg1, _arg2, _arg3, _arg4, _arg5, _arg6, _arg7) \ 116 _DTrace_Template(DTrace_VPrintln, 7, (_fmt), (_arg1), (_arg2), (_arg3), (_arg4), (_arg5), (_arg6), (_arg7), 0) 117 #define DTRACE_PRINTLN8(_fmt, _arg1, _arg2, _arg3, _arg4, _arg5, _arg6, _arg7, _arg8) \ 118 _DTrace_Template(DTrace_VPrintln, 8, (_fmt), (_arg1), (_arg2), (_arg3), (_arg4), (_arg5), (_arg6), (_arg7), (_arg8)) 119 120 #else /* else DEBUG not defined */ 121 122 /* printf style trace macros */ 123 #define DTRACE_PRINT(_fmt) 124 #define DTRACE_PRINT1(_fmt, _arg1) 125 #define DTRACE_PRINT2(_fmt, _arg1, _arg2) 126 #define DTRACE_PRINT3(_fmt, _arg1, _arg2, _arg3) 127 #define DTRACE_PRINT4(_fmt, _arg1, _arg2, _arg3, _arg4) 128 #define DTRACE_PRINT5(_fmt, _arg1, _arg2, _arg3, _arg4, _arg5) 129 #define DTRACE_PRINT6(_fmt, _arg1, _arg2, _arg3, _arg4, _arg5, _arg6) 130 #define DTRACE_PRINT7(_fmt, _arg1, _arg2, _arg3, _arg4, _arg5, _arg6, _arg7) 131 #define DTRACE_PRINT8(_fmt, _arg1, _arg2, _arg3, _arg4, _arg5, _arg6, _arg7, _arg8) 132 133 /* printf style trace macros that automatically output a newline */ 134 #define DTRACE_PRINTLN(_fmt) 135 #define DTRACE_PRINTLN1(_fmt, _arg1) 136 #define DTRACE_PRINTLN2(_fmt, _arg1, _arg2) 137 #define DTRACE_PRINTLN3(_fmt, _arg1, _arg2, _arg3) 138 #define DTRACE_PRINTLN4(_fmt, _arg1, _arg2, _arg3, _arg4) 139 #define DTRACE_PRINTLN5(_fmt, _arg1, _arg2, _arg3, _arg4, _arg5) 140 #define DTRACE_PRINTLN6(_fmt, _arg1, _arg2, _arg3, _arg4, _arg5, _arg6) 141 #define DTRACE_PRINTLN7(_fmt, _arg1, _arg2, _arg3, _arg4, _arg5, _arg6, _arg7) 142 #define DTRACE_PRINTLN8(_fmt, _arg1, _arg2, _arg3, _arg4, _arg5, _arg6, _arg7, _arg8) 143 144 #endif /* endif DEBUG defined */ 145 146 #if defined(__cplusplus) 147 } /* extern "C" */ 148 #endif 149 150 #endif /* _DEBUG_TRACE_H */ 151