diff src/backtrace.h @ 1292:f3437b56874d

[xemacs-hg @ 2003-02-13 09:57:04 by ben] profile updates profile.c: Major reworking. Keep track of new information -- total function timing (includes descendants), GC usage, total GC usage (includes descendants). New functions to be called appropriately from eval.c, alloc.c to keep track of this information. Keep track of when we're actually in a function vs. in its profile, for more accurate timing counts. Track profile overhead separately. Create new mechanism for specifying "internal sections" that are tracked just like regular Lisp functions and even appear in the backtrace if `backtrace-with-internal-sections' is non-nil (t by default for error-checking builds). Add some KKCC information for the straight (non-Elisp) hash table used by profile, which contains Lisp objects in its keys -- but not used yet. Remove old ad-hoc methods for tracking garbage collection, redisplay (which was incorrect anyway when Lisp was called within these sections). Don't record any tick info when blocking under MS Windows, since the timer there is in real time rather than in process time. Make `start-profiling', `stop-profiling' interactive. Be consistent wrt. recursive functions and functions currently on the stack when starting or stopping -- together these make implementing the `total' values extremely difficult. When we start profiling, we act as if we just entered all the functions currently on the stack. Likewise when exiting. Create vars in_profile for tracking time spent inside of profiling, and profiling_lock for setting exclusive access to the main hash table when reading from it or modifying it. (protects against getting screwed up by the signal handle going off at the same time. profile.h: New file. Create macros for declaring internal profiling sections. lisp.h: Move profile-related stuff to profile.h. alloc.c: Keep track of total consing, for profile. Tell profile when we are consing. Use new profile-section method for noting garbage-collection. alloc.c: Abort if we attempt to call the allocator reentrantly. backtrace.h, eval.c: Add info for use by profile in the backtrace frame and transfer PUSH_BACKTRACE/POP_BACKTRACE from eval.c, for use with profile. elhash.c: Author comment. eval.c, lisp.h: New Lisp var `backtrace-with-internal-sections'. Set to t when error-checking is on. eval.c: When unwinding, eval.c: Report to profile when we are about-to-call and just-called wrt. a function. alloc.c, eval.c: Allow for "fake" backtrace frames, for internal sections (used by profile and `backtrace-with-internal-sections'. event-Xt.c, event-gtk.c, event-msw.c, event-tty.c: Record when we are actually blocking on an event, for profile's sake. event-stream.c: Record internal profiling sections for getting, dispatching events. extents.c: Record internal profiling sections for map_extents. hash.c, hash.h: Add pregrow_hash_table_if_necessary(). (Used in profile code since the signal handler is the main grower but can't allow a realloc(). We make sure, at critical points, that the table is large enough.) lread.c: Create internal profiling sections for `load' (which may be triggered internally by autoload, etc.). redisplay.c: Remove old profile_redisplay_flag. Use new macros to declare internal profiling section for redisplay. text.c: Use new macros to declare internal profiling sections for char-byte conversion and internal-external conversion. SEMI-UNRELATED CHANGES: ----------------------- text.c: Update the long comments.
author ben
date Thu, 13 Feb 2003 09:57:08 +0000
parents 2b6fa2618f76
children 989a7680c221
line wrap: on
line diff
--- a/src/backtrace.h	Wed Feb 12 22:52:33 2003 +0000
+++ b/src/backtrace.h	Thu Feb 13 09:57:08 2003 +0000
@@ -1,6 +1,6 @@
 /* The lisp stack.
    Copyright (C) 1985, 1986, 1987, 1992, 1993 Free Software Foundation, Inc.
-   Copyright (C) 2002 Ben Wing.
+   Copyright (C) 2002, 2003 Ben Wing.
 
 This file is part of XEmacs.
 
@@ -63,6 +63,51 @@
     char evalargs;
     /* Nonzero means call value of debugger when done with this operation. */
     char debug_on_exit;
+
+    /* All the rest is information for the use of the profiler.  The only
+       thing that eval.c does is set the first value to 0 so that it can
+       be relied upon. */
+
+    /* ----------------------------------------------------------------- */
+
+    /* 0 = profiling not turned on when function called.
+           Since profiling can be turned on and off dynamically, we can't
+           always count on having info recorded when a function was called
+           and need to take evasive action if necessary.
+       1 = profiling turned on but function not yet actually called.  Lots of
+           stuff can happen between when a function is pushed onto the
+           backtrace list and when it's actually called (e.g. evalling its
+           arguments, autoloading, etc.).  For greater accuracy we don't
+           treat the preamble stuff as part of the function itself.
+       2 = profiling turned on, function called.
+    */
+    char function_being_called;
+    /* The trick here is handling recursive functions and dealing with the
+       dynamicity of in-profile/not-in-profile.  I used to just use a bunch
+       of hash tables for all info but that fails in the presence of
+       recursive functions because they can modify values out from under
+       you.  The algorithm here is that we record the total_ticks and
+       total_consing, as well as the current values of `total-timing' and
+       `total-gc-usage' for the OBJ -- that's because recursive functions,
+       which get called later and exit early, will go ahead and modify the
+       `total-timing' and `total-gc-usage' for the fun, even though it's
+       not "correct" because the outer function is still running.  However,
+       if we ask for profiling info at this point, at least we're getting
+       SOME info.
+
+       So ... On entry, we record these four values.  On exit, we compute
+       an offset from the recorded value to the current value and then
+       store it into the appropriate hash table entry, using the recorded
+       value in the entry rather than the actual one. (Inner recursive
+       functions may have added their own values to the total-counts, and
+       we want to subsume them, not add to them.)
+
+       #### Also we need to go through the backtrace list during
+       stop-profiling and record values, just like for unwind_to. */
+    EMACS_INT  current_total_timing_val;
+    EMACS_INT  current_total_gc_usage_val;
+    EMACS_UINT total_ticks_at_start;
+    EMACS_UINT total_consing_at_start;
   };
 
 /* This structure helps implement the `catch' and `throw' control
@@ -349,4 +394,17 @@
     Fset (FFU_sym, FFU_newval);						\
 } while (0)
 
+/* Note: you must always fill in all of the fields in a backtrace structure
+   before pushing them on the backtrace_list.  The profiling code depends
+   on this. */
+
+#define PUSH_BACKTRACE(bt) do {		\
+  (bt).next = backtrace_list;		\
+  backtrace_list = &(bt);		\
+} while (0)
+
+#define POP_BACKTRACE(bt) do {		\
+  backtrace_list = (bt).next;		\
+} while (0)
+
 #endif /* INCLUDED_backtrace_h_ */