1 /****************************************************************************
2 * Copyright (c) 1998-2007,2008 Free Software Foundation, Inc. *
4 * Permission is hereby granted, free of charge, to any person obtaining a *
5 * copy of this software and associated documentation files (the *
6 * "Software"), to deal in the Software without restriction, including *
7 * without limitation the rights to use, copy, modify, merge, publish, *
8 * distribute, distribute with modifications, sublicense, and/or sell *
9 * copies of the Software, and to permit persons to whom the Software is *
10 * furnished to do so, subject to the following conditions: *
12 * The above copyright notice and this permission notice shall be included *
13 * in all copies or substantial portions of the Software. *
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
16 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
17 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
18 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
19 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
20 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
21 * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
23 * Except as contained in this notice, the name(s) of the above copyright *
24 * holders shall not be used in advertising or otherwise to promote the *
25 * sale, use or other dealings in this Software without prior written *
27 ****************************************************************************/
29 /****************************************************************************
30 * Author: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995 *
31 * and: Eric S. Raymond <esr@snark.thyrsus.com> *
32 * and: Thomas E. Dickey 1996-on *
33 ****************************************************************************/
36 * lib_trace.c - Tracing/Debugging routines
38 * The _tracef() function is originally from pcurses (by Pavel Curtis) in 1982.
39 * pcurses allowed one to enable/disable tracing using traceon() and traceoff()
40 * functions. ncurses provides a trace() function which allows one to
41 * selectively enable or disable several tracing features.
44 #include <curses.priv.h>
49 MODULE_ID("$Id: lib_trace.c,v 1.71 2008/08/23 18:04:29 tom Exp $")
51 NCURSES_EXPORT_VAR(unsigned) _nc_tracing = 0; /* always define this */
56 NCURSES_EXPORT(const char *)
57 NCURSES_PUBLIC_VAR(_nc_tputs_trace) (void)
59 return SP ? SP->_tputs_trace : _nc_prescreen._tputs_trace;
62 NCURSES_PUBLIC_VAR(_nc_outchars) (void)
64 return SP ? SP->_outchars : _nc_prescreen._outchars;
67 _nc_set_tputs_trace(const char *s)
72 _nc_prescreen._tputs_trace = s;
75 _nc_count_outchars(long increment)
78 SP->_outchars += increment;
80 _nc_prescreen._outchars += increment;
83 NCURSES_EXPORT_VAR(const char *) _nc_tputs_trace = "";
84 NCURSES_EXPORT_VAR(long) _nc_outchars = 0;
87 #define TraceFP _nc_globals.trace_fp
88 #define TracePath _nc_globals.trace_fname
89 #define TraceLevel _nc_globals.trace_level
92 trace(const unsigned int tracelevel)
94 if ((TraceFP == 0) && tracelevel) {
95 const char *mode = _nc_globals.init_trace ? "ab" : "wb";
97 if (TracePath[0] == '\0') {
98 int size = sizeof(TracePath) - 12;
99 if (getcwd(TracePath, size) == 0) {
100 perror("curses: Can't get working directory");
103 TracePath[size] = '\0';
104 assert(strlen(TracePath) <= size);
105 strcat(TracePath, "/trace");
106 if (_nc_is_dir_path(TracePath)) {
107 strcat(TracePath, ".log");
111 _nc_globals.init_trace = TRUE;
112 _nc_tracing = tracelevel;
113 if (_nc_access(TracePath, W_OK) < 0
114 || (TraceFP = fopen(TracePath, mode)) == 0) {
115 perror("curses: Can't open 'trace' file");
118 /* Try to set line-buffered mode, or (failing that) unbuffered,
119 * so that the trace-output gets flushed automatically at the
120 * end of each line. This is useful in case the program dies.
122 #if HAVE_SETVBUF /* ANSI */
123 (void) setvbuf(TraceFP, (char *) 0, _IOLBF, 0);
124 #elif HAVE_SETBUF /* POSIX */
125 (void) setbuffer(TraceFP, (char *) 0);
127 _tracef("TRACING NCURSES version %s.%d (tracelevel=%#x)",
129 NCURSES_VERSION_PATCH,
131 } else if (tracelevel == 0) {
136 _nc_tracing = tracelevel;
137 } else if (_nc_tracing != tracelevel) {
138 _nc_tracing = tracelevel;
139 _tracef("tracelevel=%#x", tracelevel);
144 _nc_va_tracef(const char *fmt, va_list ap)
146 static const char Called[] = T_CALLED("");
147 static const char Return[] = T_RETURN("");
151 unsigned doit = _nc_tracing;
152 int save_err = errno;
154 if (strlen(fmt) >= sizeof(Called) - 1) {
155 if (!strncmp(fmt, Called, sizeof(Called) - 1)) {
158 } else if (!strncmp(fmt, Return, sizeof(Return) - 1)) {
161 if (before || after) {
162 if ((TraceLevel <= 1)
163 || (doit & TRACE_ICALLS) != 0)
164 doit &= (TRACE_CALLS | TRACE_CCALLS);
175 * TRACE_ICALLS is "really" needed to show normal use with threaded
176 * applications, since anything can be running during a napms(),
177 * making it appear in the hierarchical trace as it other functions
180 * Rather than add the complication of a per-thread stack, just
181 * show the thread-id in each line of the trace.
183 # if USE_WEAK_SYMBOLS
186 fprintf(TraceFP, "%#lx:", (long) (void *) pthread_self());
188 if (before || after) {
190 for (n = 1; n < TraceLevel; n++)
191 fputs("+ ", TraceFP);
193 vfprintf(TraceFP, fmt, ap);
194 fputc('\n', TraceFP);
198 if (after && TraceLevel)
205 _tracef(const char *fmt,...)
210 _nc_va_tracef(fmt, ap);
214 /* Trace 'bool' return-values */
215 NCURSES_EXPORT(NCURSES_BOOL)
216 _nc_retrace_bool(NCURSES_BOOL code)
218 T((T_RETURN("%s"), code ? "TRUE" : "FALSE"));
222 /* Trace 'int' return-values */
224 _nc_retrace_int(int code)
226 T((T_RETURN("%d"), code));
230 /* Trace 'unsigned' return-values */
231 NCURSES_EXPORT(unsigned)
232 _nc_retrace_unsigned(unsigned code)
234 T((T_RETURN("%#x"), code));
238 /* Trace 'char*' return-values */
239 NCURSES_EXPORT(char *)
240 _nc_retrace_ptr(char *code)
242 T((T_RETURN("%s"), _nc_visbuf(code)));
246 /* Trace 'const char*' return-values */
247 NCURSES_EXPORT(const char *)
248 _nc_retrace_cptr(const char *code)
250 T((T_RETURN("%s"), _nc_visbuf(code)));
254 /* Trace 'NCURSES_CONST void*' return-values */
255 NCURSES_EXPORT(NCURSES_CONST void *)
256 _nc_retrace_cvoid_ptr(NCURSES_CONST void *code)
258 T((T_RETURN("%p"), code));
262 /* Trace 'void*' return-values */
263 NCURSES_EXPORT(void *)
264 _nc_retrace_void_ptr(void *code)
266 T((T_RETURN("%p"), code));
270 /* Trace 'SCREEN *' return-values */
271 NCURSES_EXPORT(SCREEN *)
272 _nc_retrace_sp(SCREEN *code)
274 T((T_RETURN("%p"), code));
278 /* Trace 'WINDOW *' return-values */
279 NCURSES_EXPORT(WINDOW *)
280 _nc_retrace_win(WINDOW *code)
282 T((T_RETURN("%p"), code));
288 * Check if the given trace-mask is enabled.
290 * This function may be called from within one of the functions that fills
291 * in parameters for _tracef(), but in that case we do not want to lock the
292 * mutex, since it is already locked.
295 _nc_use_tracef(unsigned mask)
299 _nc_lock_global(tst_tracef);
300 if (!_nc_globals.nested_tracef++) {
301 if ((result = (_nc_tracing & (mask))) != 0
302 && _nc_try_global(tracef) == 0) {
303 /* we will call _nc_locked_tracef(), no nesting so far */
305 /* we will not call _nc_locked_tracef() */
306 _nc_globals.nested_tracef = 0;
309 /* we may call _nc_locked_tracef(), but with nested_tracef > 0 */
310 result = (_nc_tracing & (mask));
312 _nc_unlock_global(tst_tracef);
317 * We call this if _nc_use_tracef() returns true, which means we must unlock
321 _nc_locked_tracef(const char *fmt,...)
326 _nc_va_tracef(fmt, ap);
329 if (--(_nc_globals.nested_tracef) == 0)
330 _nc_unlock_global(tracef);
332 #endif /* USE_REENTRANT */