annotate dynodump/README @ 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 376386a54a3c
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
1 DYNODUMP
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
2 --------
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
3
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
4 Dynodump, not to be confused with DinoTurd (as seen in Jurassic Park),
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
5 is a shared object that provides one function:
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
6
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
7 int dynodump(char *new_file);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
8
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
9 dynodump(), called from a running program will write a new executable
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
10 in new_file a la unexec() in GNU Emacs. The difference lies in the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
11 relocations.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
12
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
13 dynodump() will create an image with any relocations (which were
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
14 performed by the run-time dynamic linker) undone. This allows the new
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
15 image to be run in a different environment. There is, however, one
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
16 potentially major caveat. If a symbol reference gets updated during
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
17 the running of the calling program, its updated value will be lost.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
18 An example (with additional blank lines for legibility):
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
19
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
20 $ cat lib.c
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
21 char _foo[] = "hello";
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
22 char _bar[] = "world";
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
23
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
24 $ cc -G -o lib.so lib.c
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
25
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
26 $ cat prog.c
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
27 extern char _foo, _bar;
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
28
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
29 int beenhere = 0;
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
30 char * foo = &_foo;
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
31 char * bar = &_bar;
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
32
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
33 int
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
34 main(void)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
35 {
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
36 (void) printf("%d: foo = %x\n", beenhere, foo);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
37 (void) printf("%d: bar = %x, ", beenhere, bar);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
38
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
39 if (!beenhere) {
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
40 beenhere = 1;
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
41 bar++;
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
42 dynodump("newfile");
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
43 }
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
44 (void) printf("%x\n", bar);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
45 }
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
46
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
47 $ cc -o prog prog.c -R. lib.so dynodump.so
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
48
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
49 $ ./prog
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
50 0: foo = ef7503cc
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
51 0: bar = ef7503d2, ef7503d3
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
52
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
53 $ ./newfile
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
54 1: foo = ef7503cc
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
55 1: bar = ef7503d2, ef7503d2
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
56
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
57 Notice that in the run of newfile, bar points at "world" instead of
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
58 the perhaps expected "orld".
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
59
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
60 Dynodump supports sparc, intel, and power pc architectures.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
61
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
62 Dynodump is buildable with GNU make and gcc. If it works for you
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
63 with these tools, let me know.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
64
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
65 unexec()
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
66 --------
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
67
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
68 Also supplied is an unexsol2.c which belongs in the XEmacs src
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
69 directory with the other unex*.c files. The src/s/sol2.h should be
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
70 have the following added to it:
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
71
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
72 #ifdef UNEXEC
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
73 #undef UNEXEC
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
74 #endif
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
75 #define UNEXEC unexsol2.o
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
76
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
77 This unexec() will attempt to dlopen() the dynodump.so to find the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
78 dynodump function. The default is "../dynodump/dynodump.so" which
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
79 should be appropriate for the typical XEmacs build (unless you used
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
80 configure to set up separate build and source trees). You may change
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
81 it by setting the DYNODUMP environment variable to the full path of
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
82 the dynodump shared object.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
83
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
84 Other notes:
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
85
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
86 If you're using the 4.0 C compiler from Sun, you should arrange to
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
87 shut off the incremental linker. This is done with the -xildoff
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
88 option to the compiler. The common.mk and testsuite/Makefile files
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
89 have commentary and ready made lines for uncommenting for this
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
90 purpose.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
91
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
92 If you're interested in playing with the UltraSPARC specific options
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
93 to the aforementioned compiler, then the same makefiles have some
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
94 commentary and flags settings to point you in that direction.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
95
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
96 Questions:
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
97
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
98 dynodump() was developed by Rod.Evans@Eng.Sun.COM and
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
99 Georg.Nikodym@Canada.Sun.COM. If you have questions, feel free to ask
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
100 them but be aware that Rod, "don't know jack about emacs."
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
101