annotate src/profile.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
children b49d38bc659d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1292
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
1 /* Profiling.
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
2 Copyright (C) 2003 Ben Wing.
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
3
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
4 This file is part of XEmacs.
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
5
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
6 XEmacs is free software; you can redistribute it and/or modify it
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
7 under the terms of the GNU General Public License as published by the
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
8 Free Software Foundation; either version 2, or (at your option) any
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
9 later version.
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
10
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
11 XEmacs is distributed in the hope that it will be useful, but WITHOUT
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
12 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
13 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
14 for more details.
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
15
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
16 You should have received a copy of the GNU General Public License
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
17 along with XEmacs; see the file COPYING. If not, write to
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
19 Boston, MA 02111-1307, USA. */
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
20
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
21 /* Synched up with: Not in FSF. */
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
22
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
23 /* Authorship:
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
24
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
25 Ben Wing: Feb 2003.
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
26 */
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
27
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
28 #include "backtrace.h"
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
29
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
30 void mark_profiling_info (void);
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
31 void profile_record_unwind (struct backtrace *);
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
32 void profile_record_about_to_call (struct backtrace *);
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
33 void profile_record_just_called (struct backtrace *);
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
34 void profile_record_consing (EMACS_INT size);
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
35 void profile_record_unconsing (EMACS_INT size);
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
36 extern int profiling_active;
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
37
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
38 /* We call about_to_call() and just_called() depending on the current
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
39 *dynamic* value of profiling_active (which could change as a result of
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
40 calling the function) but if we push a backtrace, we must pop it later,
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
41 so we need to remember the status of this. */
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
42 #define PROFILE_DECLARE() \
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
43 int do_backtrace = profiling_active || backtrace_with_internal_sections; \
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
44 struct backtrace backtrace
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
45
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
46 /* As just mentioned, we rely on the dynamic value of profiling_active.
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
47 This ensures correct behavior (e.g. we never modify the profiling info
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
48 when profiling is not active) because we seed and reap all functions
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
49 currently on the stack when starting and stopping. See
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
50 `start-profiling'. */
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
51 #define PROFILE_ENTER_FUNCTION() \
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
52 do \
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
53 { \
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
54 if (profiling_active) \
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
55 profile_record_about_to_call (&backtrace); \
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
56 } \
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
57 while (0)
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
58
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
59 #define PROFILE_EXIT_FUNCTION() \
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
60 do \
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
61 { \
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
62 if (profiling_active) \
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
63 profile_record_just_called (&backtrace); \
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
64 } \
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
65 while (0)
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
66
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
67 /* We are entering a section that we would like to record profile information
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
68 about. We put this information into the backtrace list, just like
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
69 normal functions do. That is one easy way to make sure that we always
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
70 record info on the innermost section or function, whether section or
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
71 function. (To do this, we always need some sort of collusion between
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
72 profile and eval; this is one way.) */
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
73
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
74 #define PROFILE_RECORD_ENTERING_SECTION(var) \
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
75 do \
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
76 { \
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
77 if (do_backtrace) \
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
78 { \
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
79 backtrace.function = &var; \
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
80 backtrace.args = NULL; \
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
81 backtrace.nargs = UNEVALLED; \
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
82 backtrace.evalargs = 0; \
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
83 backtrace.pdlcount = specpdl_depth (); \
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
84 backtrace.debug_on_exit = 0; \
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
85 backtrace.function_being_called = 0; \
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
86 PUSH_BACKTRACE (backtrace); \
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
87 } \
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
88 PROFILE_ENTER_FUNCTION (); \
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
89 } while (0)
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
90
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
91 #define PROFILE_RECORD_EXITING_SECTION(var) \
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
92 do \
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
93 { \
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
94 PROFILE_EXIT_FUNCTION (); \
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
95 if (do_backtrace) \
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
96 POP_BACKTRACE (backtrace); \
f3437b56874d [xemacs-hg @ 2003-02-13 09:57:04 by ben]
ben
parents:
diff changeset
97 } while (0)