annotate tests/automated/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 74fd4e045ea6
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
398
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
1 This directory contains XEmacs' automated test suite. The usual way
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
2 of running all the tests is running `make check' from the top-level
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
3 source directory.
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
4
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
5 The test suite is unfinished and it's still lacking some essential
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
6 features. It is nevertheless recommended that you run the tests to
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
7 confirm that XEmacs behaves correctly.
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
8
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
9 If you want to run a specific test case, you can do it from the
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
10 command-line like this:
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
11
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
12 $ xemacs -batch -l test-harness.elc -f batch-test-emacs TEST-FILE
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
13
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
14 If something goes wrong, you can run the test suite interactively by
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
15 loading `test-harness.el' into a running XEmacs and typing
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
16 `M-x test-emacs-test-file RET <filename> RET'. You will see a log of
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
17 passed and failed tests, which should allow you to investigate the
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
18 source of the error and ultimately fix the bug.
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
19
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
20 Adding a new test file is trivial: just create a new file here and it
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
21 will be run. There is no need to byte-compile any of the files in
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
22 this directory -- the test-harness will take care of any necessary
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
23 byte-compilation.
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
24
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
25 Look at the existing test cases for the examples of coding test cases.
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
26 It all boils down to your imagination and judicious use of the macros
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
27 `Assert', `Check-Error', `Check-Error-Message', and `Check-Message'.