libguile/debug.c

   1 /* Debugging extensions for Guile
   2  * Copyright (C) 1995,1996,1997,1998,1999,2000,2001, 2002, 2003, 2006, 2008, 2009, 2010, 2011, 2012, 2013 Free Software Foundation
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public License
   6  * as published by the Free Software Foundation; either version 3 of
   7  * the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful, but
  10  * WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the Free Software
  16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  17  * 02110-1301 USA
  18  */
  19
  20
  21 #ifdef HAVE_CONFIG_H
  22 # include <config.h>
  23 #endif
  24
  25 #ifdef HAVE_GETRLIMIT
  26 #include <sys/time.h>
  27 #include <sys/resource.h>
  28 #endif
  29
  30 #include "libguile/_scm.h"
  31 #include "libguile/async.h"
  32 #include "libguile/eval.h"
  33 #include "libguile/list.h"
  34 #include "libguile/stackchk.h"
  35 #include "libguile/throw.h"
  36 #include "libguile/macros.h"
  37 #include "libguile/smob.h"
  38 #include "libguile/struct.h"
  39 #include "libguile/procprop.h"
  40 #include "libguile/srcprop.h"
  41 #include "libguile/alist.h"
  42 #include "libguile/continuations.h"
  43 #include "libguile/strports.h"
  44 #include "libguile/read.h"
  45 #include "libguile/feature.h"
  46 #include "libguile/dynwind.h"
  47 #include "libguile/modules.h"
  48 #include "libguile/ports.h"
  49 #include "libguile/root.h"
  50 #include "libguile/fluids.h"
  51 #include "libguile/programs.h"
  52 #include "libguile/memoize.h"
  53 #include "libguile/vm.h"
  54
  55 #include "libguile/validate.h"
  56 #include "libguile/debug.h"
  57
  58 #include "libguile/private-options.h"
  59 \f
  60
  61
  62 /*
  63  * Debugging options.
  64  */
  65
  66 scm_t_option scm_debug_opts[] = {
  67   { SCM_OPTION_BOOLEAN, "backwards", 0,
  68     "Display backtrace in anti-chronological order." },
  69   { SCM_OPTION_INTEGER, "width", 79, "Maximal width of backtrace." },
  70   { SCM_OPTION_INTEGER, "depth", 20, "Maximal length of printed backtrace." },
  71   { SCM_OPTION_BOOLEAN, "backtrace", 1, "Show backtrace on error." },
  72   /* This default stack limit will be overridden by init_stack_limit(),
  73      if we have getrlimit() and the stack limit is not INFINITY. But it is still
  74      important, as some systems have both the soft and the hard limits set to
  75      INFINITY; in that case we fall back to this value.
  76
  77      The situation is aggravated by certain compilers, which can consume
  78      "beaucoup de stack", as they say in France.
  79
  80      See http://thread.gmane.org/gmane.lisp.guile.devel/8599/focus=8662 for
  81      more discussion. This setting is 640 KB on 32-bit arches (should be enough
  82      for anyone!) or a whoppin' 1280 KB on 64-bit arches.
  83   */
  84   { SCM_OPTION_INTEGER, "stack", 160000, "Stack size limit (measured in words; 0 = no check)." },
  85   { SCM_OPTION_SCM, "show-file-name", SCM_BOOL_T_BITS,
  86     "Show file names and line numbers "
  87     "in backtraces when not `#f'.  A value of `base' "
  88     "displays only base names, while `#t' displays full names."},
  89   { SCM_OPTION_BOOLEAN, "warn-deprecated", 0,
  90     "Warn when deprecated features are used." },
  91   { 0 },
  92 };
  93
  94
  95 /* {Run time control of the debugging evaluator}
  96  */
  97
  98 SCM_DEFINE (scm_debug_options, "debug-options-interface", 0, 1, 0,
  99             (SCM setting),
 100             "Option interface for the debug options. Instead of using\n"
 101             "this procedure directly, use the procedures @code{debug-enable},\n"
 102             "@code{debug-disable}, @code{debug-set!} and @code{debug-options}.")
 103 #define FUNC_NAME s_scm_debug_options
 104 {
 105   SCM ans;
 106
 107   scm_dynwind_begin (0);
 108   scm_dynwind_critical_section (SCM_BOOL_F);
 109
 110   ans = scm_options (setting, scm_debug_opts, FUNC_NAME);
 111   scm_stack_checking_enabled_p = SCM_STACK_CHECKING_P;
 112
 113   scm_dynwind_end ();
 114   return ans;
 115 }
 116 #undef FUNC_NAME
 117
 118
 119 \f
 120
 121 #if 0
 122 SCM_REGISTER_PROC (s_reverse_lookup, "reverse-lookup", 2, 0, 0, scm_reverse_lookup);
 123 #endif
 124
 125 SCM
 126 scm_reverse_lookup (SCM env, SCM data)
 127 {
 128   while (scm_is_pair (env) && scm_is_pair (SCM_CAR (env)))
 129     {
 130       SCM names = SCM_CAAR (env);
 131       SCM values = SCM_CDAR (env);
 132       while (scm_is_pair (names))
 133         {
 134           if (scm_is_eq (SCM_CAR (values), data))
 135             return SCM_CAR (names);
 136           names = SCM_CDR (names);
 137           values = SCM_CDR (values);
 138         }
 139       if (!scm_is_null (names) && scm_is_eq (values, data))
 140         return names;
 141       env = SCM_CDR (env);
 142     }
 143   return SCM_BOOL_F;
 144 }
 145
 146 \f
 147
 148 /* Undocumented debugging procedure */
 149 #ifdef GUILE_DEBUG
 150 SCM_DEFINE (scm_debug_hang, "debug-hang", 0, 1, 0,
 151             (SCM obj),
 152             "Go into an endless loop, which can be only terminated with\n"
 153             "a debugger.")
 154 #define FUNC_NAME s_scm_debug_hang
 155 {
 156   int go = 0;
 157   while (!go) ;
 158   return SCM_UNSPECIFIED;
 159 }
 160 #undef FUNC_NAME
 161 #endif
 162
 163 SCM
 164 scm_local_eval (SCM exp, SCM env)
 165 {
 166   static SCM local_eval_var = SCM_UNDEFINED;
 167   static scm_i_pthread_mutex_t local_eval_var_mutex
 168     = SCM_I_PTHREAD_MUTEX_INITIALIZER;
 169
 170   scm_i_scm_pthread_mutex_lock (&local_eval_var_mutex);
 171   if (SCM_UNBNDP (local_eval_var))
 172     local_eval_var = scm_c_public_variable ("ice-9 local-eval", "local-eval");
 173   scm_i_pthread_mutex_unlock (&local_eval_var_mutex);
 174
 175   return scm_call_2 (SCM_VARIABLE_REF (local_eval_var), exp, env);
 176 }
 177
 178 static void
 179 init_stack_limit (void)
 180 {
 181 #ifdef HAVE_GETRLIMIT
 182   struct rlimit lim;
 183   if (getrlimit (RLIMIT_STACK, &lim) == 0)
 184       {
 185         rlim_t bytes = lim.rlim_cur;
 186
 187         /* set our internal stack limit to 80% of the rlimit. */
 188         if (bytes == RLIM_INFINITY)
 189           bytes = lim.rlim_max;
 190
 191         if (bytes != RLIM_INFINITY)
 192           SCM_STACK_LIMIT = bytes * 8 / 10 / sizeof (scm_t_bits);
 193       }
 194   errno = 0;
 195 #endif
 196 }
 197
 198 \f
 199
 200 void
 201 scm_init_debug ()
 202 {
 203   init_stack_limit ();
 204   scm_init_opts (scm_debug_options, scm_debug_opts);
 205
 206   scm_add_feature ("debug-extensions");
 207
 208 #include "libguile/debug.x"
 209 }
 210
 211 /*
 212   Local Variables:
 213   c-file-style: "gnu"
 214   End:
 215 */