ncurses/trace/lib_trace.c

   1 /****************************************************************************
   2  * Copyright (c) 1998-2009,2010 Free Software Foundation, Inc.              *
   3  *                                                                          *
   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:                 *
  11  *                                                                          *
  12  * The above copyright notice and this permission notice shall be included  *
  13  * in all copies or substantial portions of the Software.                   *
  14  *                                                                          *
  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.                               *
  22  *                                                                          *
  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       *
  26  * authorization.                                                           *
  27  ****************************************************************************/
  28
  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  ****************************************************************************/
  35
  36 /*
  37  *      lib_trace.c - Tracing/Debugging routines
  38  *
  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.
  43  */
  44
  45 #include <curses.priv.h>
  46 #include <tic.h>
  47
  48 #include <ctype.h>
  49
  50 MODULE_ID("$Id: lib_trace.c,v 1.74 2010/01/16 16:31:38 tom Exp $")
  51
  52 NCURSES_EXPORT_VAR(unsigned) _nc_tracing = 0; /* always define this */
  53
  54 #ifdef TRACE
  55
  56 #if USE_REENTRANT
  57 NCURSES_EXPORT(const char *)
  58 NCURSES_PUBLIC_VAR(_nc_tputs_trace) (void)
  59 {
  60     return CURRENT_SCREEN ? CURRENT_SCREEN->_tputs_trace : _nc_prescreen._tputs_trace;
  61 }
  62 NCURSES_EXPORT(long)
  63 NCURSES_PUBLIC_VAR(_nc_outchars) (void)
  64 {
  65     return CURRENT_SCREEN ? CURRENT_SCREEN->_outchars : _nc_prescreen._outchars;
  66 }
  67 NCURSES_EXPORT(void)
  68 _nc_set_tputs_trace(const char *s)
  69 {
  70     if (CURRENT_SCREEN)
  71         CURRENT_SCREEN->_tputs_trace = s;
  72     else
  73         _nc_prescreen._tputs_trace = s;
  74 }
  75 NCURSES_EXPORT(void)
  76 _nc_count_outchars(long increment)
  77 {
  78     if (CURRENT_SCREEN)
  79         CURRENT_SCREEN->_outchars += increment;
  80     else
  81         _nc_prescreen._outchars += increment;
  82 }
  83 #else
  84 NCURSES_EXPORT_VAR(const char *) _nc_tputs_trace = "";
  85 NCURSES_EXPORT_VAR(long) _nc_outchars = 0;
  86 #endif
  87
  88 #define TraceFP         _nc_globals.trace_fp
  89 #define TracePath       _nc_globals.trace_fname
  90 #define TraceLevel      _nc_globals.trace_level
  91
  92 NCURSES_EXPORT(void)
  93 trace(const unsigned int tracelevel)
  94 {
  95     if ((TraceFP == 0) && tracelevel) {
  96         const char *mode = _nc_globals.init_trace ? "ab" : "wb";
  97
  98         if (TracePath[0] == '\0') {
  99             int size = sizeof(TracePath) - 12;
 100             if (getcwd(TracePath, size) == 0) {
 101                 perror("curses: Can't get working directory");
 102                 exit(EXIT_FAILURE);
 103             }
 104             TracePath[size] = '\0';
 105             assert(strlen(TracePath) <= size);
 106             strcat(TracePath, "/trace");
 107             if (_nc_is_dir_path(TracePath)) {
 108                 strcat(TracePath, ".log");
 109             }
 110         }
 111
 112         _nc_globals.init_trace = TRUE;
 113         _nc_tracing = tracelevel;
 114         if (_nc_access(TracePath, W_OK) < 0
 115             || (TraceFP = fopen(TracePath, mode)) == 0) {
 116             perror("curses: Can't open 'trace' file");
 117             exit(EXIT_FAILURE);
 118         }
 119         /* Try to set line-buffered mode, or (failing that) unbuffered,
 120          * so that the trace-output gets flushed automatically at the
 121          * end of each line.  This is useful in case the program dies.
 122          */
 123 #if HAVE_SETVBUF                /* ANSI */
 124         (void) setvbuf(TraceFP, (char *) 0, _IOLBF, 0);
 125 #elif HAVE_SETBUF               /* POSIX */
 126         (void) setbuffer(TraceFP, (char *) 0);
 127 #endif
 128         _tracef("TRACING NCURSES version %s.%d (tracelevel=%#x)",
 129                 NCURSES_VERSION,
 130                 NCURSES_VERSION_PATCH,
 131                 tracelevel);
 132     } else if (tracelevel == 0) {
 133         if (TraceFP != 0) {
 134             fclose(TraceFP);
 135             TraceFP = 0;
 136         }
 137         _nc_tracing = tracelevel;
 138     } else if (_nc_tracing != tracelevel) {
 139         _nc_tracing = tracelevel;
 140         _tracef("tracelevel=%#x", tracelevel);
 141     }
 142 }
 143
 144 static void
 145 _nc_va_tracef(const char *fmt, va_list ap)
 146 {
 147     static const char Called[] = T_CALLED("");
 148     static const char Return[] = T_RETURN("");
 149
 150     bool before = FALSE;
 151     bool after = FALSE;
 152     unsigned doit = _nc_tracing;
 153     int save_err = errno;
 154
 155     if (strlen(fmt) >= sizeof(Called) - 1) {
 156         if (!strncmp(fmt, Called, sizeof(Called) - 1)) {
 157             before = TRUE;
 158             TraceLevel++;
 159         } else if (!strncmp(fmt, Return, sizeof(Return) - 1)) {
 160             after = TRUE;
 161         }
 162         if (before || after) {
 163             if ((TraceLevel <= 1)
 164                 || (doit & TRACE_ICALLS) != 0)
 165                 doit &= (TRACE_CALLS | TRACE_CCALLS);
 166             else
 167                 doit = 0;
 168         }
 169     }
 170
 171     if (doit != 0) {
 172         if (TraceFP == 0)
 173             TraceFP = stderr;
 174 #ifdef USE_PTHREADS
 175         /*
 176          * TRACE_ICALLS is "really" needed to show normal use with threaded
 177          * applications, since anything can be running during a napms(),
 178          * making it appear in the hierarchical trace as it other functions
 179          * are being called.
 180          *
 181          * Rather than add the complication of a per-thread stack, just
 182          * show the thread-id in each line of the trace.
 183          */
 184 # if USE_WEAK_SYMBOLS
 185         if ((pthread_self))
 186 # endif
 187             fprintf(TraceFP, "%#lx:", (long) (void *) pthread_self());
 188 #endif
 189         if (before || after) {
 190             int n;
 191             for (n = 1; n < TraceLevel; n++)
 192                 fputs("+ ", TraceFP);
 193         }
 194         vfprintf(TraceFP, fmt, ap);
 195         fputc('\n', TraceFP);
 196         fflush(TraceFP);
 197     }
 198
 199     if (after && TraceLevel)
 200         TraceLevel--;
 201
 202     errno = save_err;
 203 }
 204
 205 NCURSES_EXPORT(void)
 206 _tracef(const char *fmt,...)
 207 {
 208     va_list ap;
 209
 210     va_start(ap, fmt);
 211     _nc_va_tracef(fmt, ap);
 212     va_end(ap);
 213 }
 214
 215 /* Trace 'bool' return-values */
 216 NCURSES_EXPORT(NCURSES_BOOL)
 217 _nc_retrace_bool(NCURSES_BOOL code)
 218 {
 219     T((T_RETURN("%s"), code ? "TRUE" : "FALSE"));
 220     return code;
 221 }
 222
 223 /* Trace 'char' return-values */
 224 NCURSES_EXPORT(char)
 225 _nc_retrace_char(char code)
 226 {
 227     T((T_RETURN("%c"), code));
 228     return code;
 229 }
 230
 231 /* Trace 'int' return-values */
 232 NCURSES_EXPORT(int)
 233 _nc_retrace_int(int code)
 234 {
 235     T((T_RETURN("%d"), code));
 236     return code;
 237 }
 238
 239 /* Trace 'unsigned' return-values */
 240 NCURSES_EXPORT(unsigned)
 241 _nc_retrace_unsigned(unsigned code)
 242 {
 243     T((T_RETURN("%#x"), code));
 244     return code;
 245 }
 246
 247 /* Trace 'char*' return-values */
 248 NCURSES_EXPORT(char *)
 249 _nc_retrace_ptr(char *code)
 250 {
 251     T((T_RETURN("%s"), _nc_visbuf(code)));
 252     return code;
 253 }
 254
 255 /* Trace 'const char*' return-values */
 256 NCURSES_EXPORT(const char *)
 257 _nc_retrace_cptr(const char *code)
 258 {
 259     T((T_RETURN("%s"), _nc_visbuf(code)));
 260     return code;
 261 }
 262
 263 /* Trace 'NCURSES_CONST void*' return-values */
 264 NCURSES_EXPORT(NCURSES_CONST void *)
 265 _nc_retrace_cvoid_ptr(NCURSES_CONST void *code)
 266 {
 267     T((T_RETURN("%p"), code));
 268     return code;
 269 }
 270
 271 /* Trace 'void*' return-values */
 272 NCURSES_EXPORT(void *)
 273 _nc_retrace_void_ptr(void *code)
 274 {
 275     T((T_RETURN("%p"), code));
 276     return code;
 277 }
 278
 279 /* Trace 'SCREEN *' return-values */
 280 NCURSES_EXPORT(SCREEN *)
 281 _nc_retrace_sp(SCREEN *code)
 282 {
 283     T((T_RETURN("%p"), (void *) code));
 284     return code;
 285 }
 286
 287 /* Trace 'WINDOW *' return-values */
 288 NCURSES_EXPORT(WINDOW *)
 289 _nc_retrace_win(WINDOW *code)
 290 {
 291     T((T_RETURN("%p"), (void *) code));
 292     return code;
 293 }
 294
 295 #if USE_REENTRANT
 296 /*
 297  * Check if the given trace-mask is enabled.
 298  *
 299  * This function may be called from within one of the functions that fills
 300  * in parameters for _tracef(), but in that case we do not want to lock the
 301  * mutex, since it is already locked.
 302  */
 303 NCURSES_EXPORT(int)
 304 _nc_use_tracef(unsigned mask)
 305 {
 306     bool result = FALSE;
 307
 308     _nc_lock_global(tst_tracef);
 309     if (!_nc_globals.nested_tracef++) {
 310         if ((result = (_nc_tracing & (mask))) != 0
 311             && _nc_try_global(tracef) == 0) {
 312             /* we will call _nc_locked_tracef(), no nesting so far */
 313         } else {
 314             /* we will not call _nc_locked_tracef() */
 315             _nc_globals.nested_tracef = 0;
 316         }
 317     } else {
 318         /* we may call _nc_locked_tracef(), but with nested_tracef > 0 */
 319         result = (_nc_tracing & (mask));
 320     }
 321     _nc_unlock_global(tst_tracef);
 322     return result;
 323 }
 324
 325 /*
 326  * We call this if _nc_use_tracef() returns true, which means we must unlock
 327  * the tracef mutex.
 328  */
 329 NCURSES_EXPORT(void)
 330 _nc_locked_tracef(const char *fmt,...)
 331 {
 332     va_list ap;
 333
 334     va_start(ap, fmt);
 335     _nc_va_tracef(fmt, ap);
 336     va_end(ap);
 337
 338     if (--(_nc_globals.nested_tracef) == 0)
 339         _nc_unlock_global(tracef);
 340 }
 341 #endif /* USE_REENTRANT */
 342
 343 #endif /* TRACE */