1 /****************************************************************************
2 * Copyright (c) 1998-2013,2016 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 * and: Juergen Pfeifer *
34 ****************************************************************************/
37 * lib_trace.c - Tracing/Debugging routines
39 * The _tracef() function is originally from pcurses (by Pavel Curtis) in 1982.
40 * pcurses allowed one to enable/disable tracing using traceon() and traceoff()
41 * functions. ncurses provides a trace() function which allows one to
42 * selectively enable or disable several tracing features.
45 #include <curses.priv.h>
50 MODULE_ID("$Id: lib_trace.c,v 1.84 2016/11/27 02:35:17 tom Exp $")
52 NCURSES_EXPORT_VAR(unsigned) _nc_tracing = 0; /* always define this */
57 NCURSES_EXPORT(const char *)
58 NCURSES_PUBLIC_VAR(_nc_tputs_trace) (void)
60 return CURRENT_SCREEN ? CURRENT_SCREEN->_tputs_trace : _nc_prescreen._tputs_trace;
63 NCURSES_PUBLIC_VAR(_nc_outchars) (void)
65 return CURRENT_SCREEN ? CURRENT_SCREEN->_outchars : _nc_prescreen._outchars;
68 _nc_set_tputs_trace(const char *s)
71 CURRENT_SCREEN->_tputs_trace = s;
73 _nc_prescreen._tputs_trace = s;
76 _nc_count_outchars(long increment)
79 CURRENT_SCREEN->_outchars += increment;
81 _nc_prescreen._outchars += increment;
84 NCURSES_EXPORT_VAR(const char *) _nc_tputs_trace = "";
85 NCURSES_EXPORT_VAR(long) _nc_outchars = 0;
88 #define MyFP _nc_globals.trace_fp
89 #define MyFD _nc_globals.trace_fd
90 #define MyPath _nc_globals.trace_fname
91 #define MyLevel _nc_globals.trace_level
92 #define MyNested _nc_globals.nested_tracef
95 trace(const unsigned int tracelevel)
97 if ((MyFP == 0) && tracelevel) {
99 MyFP = fdopen(MyFD, "wb");
101 if (MyPath[0] == '\0') {
102 size_t size = sizeof(MyPath) - 12;
103 if (getcwd(MyPath, size) == 0) {
104 perror("curses: Can't get working directory");
108 assert(strlen(MyPath) <= size);
109 _nc_STRCAT(MyPath, "/trace", sizeof(MyPath));
110 if (_nc_is_dir_path(MyPath)) {
111 _nc_STRCAT(MyPath, ".log", sizeof(MyPath));
114 if (_nc_access(MyPath, W_OK) < 0
115 || (MyFD = open(MyPath, O_CREAT | O_EXCL | O_RDWR, 0600)) < 0
116 || (MyFP = fdopen(MyFD, "wb")) == 0) {
120 _nc_tracing = tracelevel;
121 /* Try to set line-buffered mode, or (failing that) unbuffered,
122 * so that the trace-output gets flushed automatically at the
123 * end of each line. This is useful in case the program dies.
126 #if HAVE_SETVBUF /* ANSI */
127 (void) setvbuf(MyFP, (char *) 0, _IOLBF, (size_t) 0);
128 #elif HAVE_SETBUF /* POSIX */
129 (void) setbuffer(MyFP, (char *) 0);
132 _tracef("TRACING NCURSES version %s.%d (tracelevel=%#x)",
134 NCURSES_VERSION_PATCH,
136 } else if (tracelevel == 0) {
138 MyFD = dup(MyFD); /* allow reopen of same file */
142 _nc_tracing = tracelevel;
143 } else if (_nc_tracing != tracelevel) {
144 _nc_tracing = tracelevel;
145 _tracef("tracelevel=%#x", tracelevel);
150 _nc_va_tracef(const char *fmt, va_list ap)
152 static const char Called[] = T_CALLED("");
153 static const char Return[] = T_RETURN("");
157 unsigned doit = _nc_tracing;
158 int save_err = errno;
160 if (strlen(fmt) >= sizeof(Called) - 1) {
161 if (!strncmp(fmt, Called, sizeof(Called) - 1)) {
164 } else if (!strncmp(fmt, Return, sizeof(Return) - 1)) {
167 if (before || after) {
169 || (doit & TRACE_ICALLS) != 0)
170 doit &= (TRACE_CALLS | TRACE_CCALLS);
176 if (doit != 0 && MyFP != 0) {
179 * TRACE_ICALLS is "really" needed to show normal use with threaded
180 * applications, since anything can be running during a napms(),
181 * making it appear in the hierarchical trace as it other functions
184 * Rather than add the complication of a per-thread stack, just
185 * show the thread-id in each line of the trace.
187 # if USE_WEAK_SYMBOLS
191 fprintf(MyFP, "%#lx:", (long) (intptr_t) pthread_self().p);
193 fprintf(MyFP, "%#lx:", (long) (intptr_t) pthread_self());
196 if (before || after) {
198 for (n = 1; n < MyLevel; n++)
201 vfprintf(MyFP, fmt, ap);
206 if (after && MyLevel)
213 _tracef(const char *fmt,...)
218 _nc_va_tracef(fmt, ap);
222 /* Trace 'bool' return-values */
223 NCURSES_EXPORT(NCURSES_BOOL)
224 _nc_retrace_bool(int code)
226 T((T_RETURN("%s"), code ? "TRUE" : "FALSE"));
230 /* Trace 'char' return-values */
232 _nc_retrace_char(int code)
234 T((T_RETURN("%c"), code));
238 /* Trace 'int' return-values */
240 _nc_retrace_int(int code)
242 T((T_RETURN("%d"), code));
246 /* Trace 'unsigned' return-values */
247 NCURSES_EXPORT(unsigned)
248 _nc_retrace_unsigned(unsigned code)
250 T((T_RETURN("%#x"), code));
254 /* Trace 'char*' return-values */
255 NCURSES_EXPORT(char *)
256 _nc_retrace_ptr(char *code)
258 T((T_RETURN("%s"), _nc_visbuf(code)));
262 /* Trace 'const char*' return-values */
263 NCURSES_EXPORT(const char *)
264 _nc_retrace_cptr(const char *code)
266 T((T_RETURN("%s"), _nc_visbuf(code)));
270 /* Trace 'NCURSES_CONST void*' return-values */
271 NCURSES_EXPORT(NCURSES_CONST void *)
272 _nc_retrace_cvoid_ptr(NCURSES_CONST void *code)
274 T((T_RETURN("%p"), code));
278 /* Trace 'void*' return-values */
279 NCURSES_EXPORT(void *)
280 _nc_retrace_void_ptr(void *code)
282 T((T_RETURN("%p"), code));
286 /* Trace 'SCREEN *' return-values */
287 NCURSES_EXPORT(SCREEN *)
288 _nc_retrace_sp(SCREEN *code)
290 T((T_RETURN("%p"), (void *) code));
294 /* Trace 'WINDOW *' return-values */
295 NCURSES_EXPORT(WINDOW *)
296 _nc_retrace_win(WINDOW *code)
298 T((T_RETURN("%p"), (void *) code));
304 * Check if the given trace-mask is enabled.
306 * This function may be called from within one of the functions that fills
307 * in parameters for _tracef(), but in that case we do not want to lock the
308 * mutex, since it is already locked.
311 _nc_use_tracef(unsigned mask)
315 _nc_lock_global(tst_tracef);
317 if ((result = (_nc_tracing & (mask))) != 0
318 && _nc_try_global(tracef) == 0) {
319 /* we will call _nc_locked_tracef(), no nesting so far */
321 /* we will not call _nc_locked_tracef() */
325 /* we may call _nc_locked_tracef(), but with nested_tracef > 0 */
326 result = (_nc_tracing & (mask));
328 _nc_unlock_global(tst_tracef);
333 * We call this if _nc_use_tracef() returns true, which means we must unlock
337 _nc_locked_tracef(const char *fmt,...)
342 _nc_va_tracef(fmt, ap);
345 if (--(MyNested) == 0) {
346 _nc_unlock_global(tracef);
349 #endif /* USE_REENTRANT */