annotate src/profile.h @ 2898:578cac55e68a

[xemacs-hg @ 2005-08-15 21:51:36 by viteno] Update xemacs_extra_name.
author viteno
date Mon, 15 Aug 2005 21:51:36 +0000
parents b49d38bc659d
children facf3239ba30
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)
2514
b49d38bc659d [xemacs-hg @ 2005-01-26 10:09:19 by ben]
ben
parents: 1292
diff changeset
98
b49d38bc659d [xemacs-hg @ 2005-01-26 10:09:19 by ben]
ben
parents: 1292
diff changeset
99 #define RETURN_EXIT_PROFILING(tag, type, expr) \
b49d38bc659d [xemacs-hg @ 2005-01-26 10:09:19 by ben]
ben
parents: 1292
diff changeset
100 do \
b49d38bc659d [xemacs-hg @ 2005-01-26 10:09:19 by ben]
ben
parents: 1292
diff changeset
101 { \
b49d38bc659d [xemacs-hg @ 2005-01-26 10:09:19 by ben]
ben
parents: 1292
diff changeset
102 type _ret_exitpr_ = (expr); \
b49d38bc659d [xemacs-hg @ 2005-01-26 10:09:19 by ben]
ben
parents: 1292
diff changeset
103 PROFILE_RECORD_EXITING_SECTION (tag); \
b49d38bc659d [xemacs-hg @ 2005-01-26 10:09:19 by ben]
ben
parents: 1292
diff changeset
104 RETURN_SANS_WARNINGS _ret_exitpr_; \
b49d38bc659d [xemacs-hg @ 2005-01-26 10:09:19 by ben]
ben
parents: 1292
diff changeset
105 } while (0)
b49d38bc659d [xemacs-hg @ 2005-01-26 10:09:19 by ben]
ben
parents: 1292
diff changeset
106
b49d38bc659d [xemacs-hg @ 2005-01-26 10:09:19 by ben]
ben
parents: 1292
diff changeset
107 #define RETURN_LISP_EXIT_PROFILING(tag, expr) \
b49d38bc659d [xemacs-hg @ 2005-01-26 10:09:19 by ben]
ben
parents: 1292
diff changeset
108 RETURN_EXIT_PROFILING (tag, Lisp_Object, expr)
b49d38bc659d [xemacs-hg @ 2005-01-26 10:09:19 by ben]
ben
parents: 1292
diff changeset
109
b49d38bc659d [xemacs-hg @ 2005-01-26 10:09:19 by ben]
ben
parents: 1292
diff changeset
110 #define RETURN_UNGCPRO_EXIT_PROFILING(tag, expr) \
b49d38bc659d [xemacs-hg @ 2005-01-26 10:09:19 by ben]
ben
parents: 1292
diff changeset
111 { \
b49d38bc659d [xemacs-hg @ 2005-01-26 10:09:19 by ben]
ben
parents: 1292
diff changeset
112 Lisp_Object ret_ungc_val = (expr); \
b49d38bc659d [xemacs-hg @ 2005-01-26 10:09:19 by ben]
ben
parents: 1292
diff changeset
113 UNGCPRO; \
b49d38bc659d [xemacs-hg @ 2005-01-26 10:09:19 by ben]
ben
parents: 1292
diff changeset
114 PROFILE_RECORD_EXITING_SECTION (tag); \
b49d38bc659d [xemacs-hg @ 2005-01-26 10:09:19 by ben]
ben
parents: 1292
diff changeset
115 RETURN_SANS_WARNINGS ret_ungc_val; \
b49d38bc659d [xemacs-hg @ 2005-01-26 10:09:19 by ben]
ben
parents: 1292
diff changeset
116 } while (0)
b49d38bc659d [xemacs-hg @ 2005-01-26 10:09:19 by ben]
ben
parents: 1292
diff changeset
117
b49d38bc659d [xemacs-hg @ 2005-01-26 10:09:19 by ben]
ben
parents: 1292
diff changeset
118 #ifdef DEBUG_XEMACS
b49d38bc659d [xemacs-hg @ 2005-01-26 10:09:19 by ben]
ben
parents: 1292
diff changeset
119 extern Lisp_Object QSin_temp_spot_1;
b49d38bc659d [xemacs-hg @ 2005-01-26 10:09:19 by ben]
ben
parents: 1292
diff changeset
120 extern Lisp_Object QSin_temp_spot_2;
b49d38bc659d [xemacs-hg @ 2005-01-26 10:09:19 by ben]
ben
parents: 1292
diff changeset
121 extern Lisp_Object QSin_temp_spot_3;
b49d38bc659d [xemacs-hg @ 2005-01-26 10:09:19 by ben]
ben
parents: 1292
diff changeset
122 extern Lisp_Object QSin_temp_spot_4;
b49d38bc659d [xemacs-hg @ 2005-01-26 10:09:19 by ben]
ben
parents: 1292
diff changeset
123 extern Lisp_Object QSin_temp_spot_5;
b49d38bc659d [xemacs-hg @ 2005-01-26 10:09:19 by ben]
ben
parents: 1292
diff changeset
124 #endif /* DEBUG_XEMACS */