Mercurial > hg > xemacs-beta
annotate lisp/README @ 5157:1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
-------------------- ChangeLog entries follow: --------------------
lisp/ChangeLog addition:
2010-03-18 Ben Wing <ben@xemacs.org>
* diagnose.el (show-memory-usage):
Rewrite to take into account API changes in memory-usage functions.
src/ChangeLog addition:
2010-03-18 Ben Wing <ben@xemacs.org>
* alloc.c:
* alloc.c (disksave_object_finalization_1):
* alloc.c (lisp_object_storage_size):
* alloc.c (listu):
* alloc.c (listn):
* alloc.c (Fobject_memory_usage_stats):
* alloc.c (compute_memusage_stats_length):
* alloc.c (Fobject_memory_usage):
* alloc.c (Ftotal_object_memory_usage):
* alloc.c (malloced_storage_size):
* alloc.c (common_init_alloc_early):
* alloc.c (reinit_alloc_objects_early):
* alloc.c (reinit_alloc_early):
* alloc.c (init_alloc_once_early):
* alloc.c (syms_of_alloc):
* alloc.c (reinit_vars_of_alloc):
* buffer.c:
* buffer.c (struct buffer_stats):
* buffer.c (compute_buffer_text_usage):
* buffer.c (compute_buffer_usage):
* buffer.c (buffer_memory_usage):
* buffer.c (buffer_objects_create):
* buffer.c (syms_of_buffer):
* buffer.c (vars_of_buffer):
* console-impl.h (struct console_methods):
* dynarr.c (Dynarr_memory_usage):
* emacs.c (main_1):
* events.c (clear_event_resource):
* extents.c:
* extents.c (compute_buffer_extent_usage):
* extents.c (extent_objects_create):
* extents.h:
* faces.c:
* faces.c (compute_face_cachel_usage):
* faces.c (face_objects_create):
* faces.h:
* general-slots.h:
* glyphs.c:
* glyphs.c (compute_glyph_cachel_usage):
* glyphs.c (glyph_objects_create):
* glyphs.h:
* lisp.h:
* lisp.h (struct usage_stats):
* lrecord.h:
* lrecord.h (enum lrecord_type):
* lrecord.h (struct lrecord_implementation):
* lrecord.h (MC_ALLOC_CALL_FINALIZER_FOR_DISKSAVE):
* lrecord.h (DEFINE_DUMPABLE_LISP_OBJECT):
* lrecord.h (DEFINE_DUMPABLE_SIZABLE_LISP_OBJECT):
* lrecord.h (DEFINE_DUMPABLE_FROB_BLOCK_LISP_OBJECT):
* lrecord.h (DEFINE_DUMPABLE_FROB_BLOCK_SIZABLE_LISP_OBJECT):
* lrecord.h (DEFINE_DUMPABLE_INTERNAL_LISP_OBJECT):
* lrecord.h (DEFINE_DUMPABLE_SIZABLE_INTERNAL_LISP_OBJECT):
* lrecord.h (DEFINE_NODUMP_LISP_OBJECT):
* lrecord.h (DEFINE_NODUMP_SIZABLE_LISP_OBJECT):
* lrecord.h (DEFINE_NODUMP_FROB_BLOCK_LISP_OBJECT):
* lrecord.h (DEFINE_NODUMP_FROB_BLOCK_SIZABLE_LISP_OBJECT):
* lrecord.h (DEFINE_NODUMP_INTERNAL_LISP_OBJECT):
* lrecord.h (DEFINE_NODUMP_SIZABLE_INTERNAL_LISP_OBJECT):
* lrecord.h (MAKE_LISP_OBJECT):
* lrecord.h (DEFINE_DUMPABLE_MODULE_LISP_OBJECT):
* lrecord.h (DEFINE_DUMPABLE_MODULE_SIZABLE_LISP_OBJECT):
* lrecord.h (DEFINE_NODUMP_MODULE_LISP_OBJECT):
* lrecord.h (DEFINE_NODUMP_MODULE_SIZABLE_LISP_OBJECT):
* lrecord.h (MAKE_MODULE_LISP_OBJECT):
* lrecord.h (INIT_LISP_OBJECT):
* lrecord.h (INIT_MODULE_LISP_OBJECT):
* lrecord.h (UNDEF_LISP_OBJECT):
* lrecord.h (UNDEF_MODULE_LISP_OBJECT):
* lrecord.h (DECLARE_LISP_OBJECT):
* lrecord.h (DECLARE_MODULE_API_LISP_OBJECT):
* lrecord.h (DECLARE_MODULE_LISP_OBJECT):
* lstream.c:
* lstream.c (syms_of_lstream):
* lstream.c (vars_of_lstream):
* marker.c:
* marker.c (compute_buffer_marker_usage):
* mc-alloc.c (mc_alloced_storage_size):
* mc-alloc.h:
* mule-charset.c:
* mule-charset.c (struct charset_stats):
* mule-charset.c (compute_charset_usage):
* mule-charset.c (charset_memory_usage):
* mule-charset.c (mule_charset_objects_create):
* mule-charset.c (syms_of_mule_charset):
* mule-charset.c (vars_of_mule_charset):
* redisplay.c:
* redisplay.c (compute_rune_dynarr_usage):
* redisplay.c (compute_display_block_dynarr_usage):
* redisplay.c (compute_glyph_block_dynarr_usage):
* redisplay.c (compute_display_line_dynarr_usage):
* redisplay.c (compute_line_start_cache_dynarr_usage):
* redisplay.h:
* scrollbar-gtk.c (gtk_compute_scrollbar_instance_usage):
* scrollbar-msw.c (mswindows_compute_scrollbar_instance_usage):
* scrollbar-x.c (x_compute_scrollbar_instance_usage):
* scrollbar.c (compute_scrollbar_instance_usage):
* scrollbar.h:
* symbols.c:
* symbols.c (reinit_symbol_objects_early):
* symbols.c (init_symbols_once_early):
* symbols.c (reinit_symbols_early):
* symbols.c (defsymbol_massage_name_1):
* symsinit.h:
* ui-gtk.c:
* ui-gtk.c (emacs_gtk_object_getprop):
* ui-gtk.c (emacs_gtk_object_putprop):
* ui-gtk.c (ui_gtk_objects_create):
* unicode.c (compute_from_unicode_table_size_1):
* unicode.c (compute_to_unicode_table_size_1):
* unicode.c (compute_from_unicode_table_size):
* unicode.c (compute_to_unicode_table_size):
* window.c:
* window.c (struct window_stats):
* window.c (compute_window_mirror_usage):
* window.c (compute_window_usage):
* window.c (window_memory_usage):
* window.c (window_objects_create):
* window.c (syms_of_window):
* window.c (vars_of_window):
* window.h:
Redo memory-usage mechanism, make it general; add way of dynamically
initializing Lisp object types -- OBJECT_HAS_METHOD(), similar to
CONSOLE_HAS_METHOD().
(1) Create OBJECT_HAS_METHOD(), OBJECT_HAS_PROPERTY() etc. for
specifying that a Lisp object type has a particular method or
property. Call such methods with OBJECT_METH, MAYBE_OBJECT_METH,
OBJECT_METH_OR_GIVEN; retrieve properties with OBJECT_PROPERTY.
Methods that formerly required a DEFINE_*GENERAL_LISP_OBJECT() to
specify them (getprop, putprop, remprop, plist, disksave) now
instead use the dynamic-method mechanism. The main benefit of
this is that new methods or properties can be added without
requiring that the declaration statements of all existing methods
be modified. We have to make the `struct lrecord_implementation'
non-const, but I don't think this should have any effect on speed --
the only possible method that's really speed-critical is the
mark method, and we already extract those out into a separate
(non-const) array for increased cache locality.
Object methods need to be reinitialized after pdump, so we put
them in separate functions such as face_objects_create(),
extent_objects_create() and call them appropriately from emacs.c
The only current object property (`memusage_stats_list') that
objects can specify is a Lisp object and gets staticpro()ed so it
only needs to be set during dump time, but because it references
symbols that might not exist in a syms_of_() function, we
initialize it in vars_of_(). There is also an object property
(`num_extra_memusage_stats') that is automatically initialized based
on `memusage_stats_list'; we do that in reinit_vars_of_alloc(),
which is called after all vars_of_() functions are called.
`disksaver' method was renamed `disksave' to correspond with the
name normally given to the function (e.g. disksave_lstream()).
(2) Generalize the memory-usage mechanism in `buffer-memory-usage',
`window-memory-usage', `charset-memory-usage' into an object-type-
specific mechanism called by a single function
`object-memory-usage'. (Former function `object-memory-usage'
renamed to `total-object-memory-usage'). Generalize the mechanism
of different "slices" so that we can have different "classes" of
memory described and different "slices" onto each class; `t'
separates classes, `nil' separates slices. Currently we have
three classes defined: the memory of an object itself,
non-Lisp-object memory associated with the object (e.g. arrays or
dynarrs stored as fields in the object), and Lisp-object memory
associated with the object (other internal Lisp objects stored in
the object). This isn't completely finished yet and we might need
to further separate the "other internal Lisp objects" class into
two classes.
The memory-usage mechanism uses a `struct usage_stats' (renamed
from `struct overhead_stats') to describe a malloc-view onto a set
of allocated memory (listing how much was requested and various
types of overhead) and a more general `struct generic_usage_stats'
(with a `struct usage_stats' in it) to hold all statistics about
object memory. `struct generic_usage_stats' contains an array of
32 Bytecounts, which are statistics of unspecified semantics. The
intention is that individual types declare a corresponding struct
(e.g. `struct window_stats') with the same structure but with
specific fields in place of the array, corresponding to specific
statistics. The number of such statistics is an object property
computed from the list of tags (Lisp symbols describing the
statistics) stored in `memusage_stats_list'. The idea here is to
allow particular object types to customize the number and
semantics of the statistics where completely avoiding consing.
This doesn't matter so much yet, but the intention is to have the
memory usage of all objects computed at the end of GC, at the same
time as other statistics are currently computed. The values for
all statistics for a single type would be added up to compute
aggregate values for all objects of a specific type. To make this
efficient, we can't allow any memory allocation at all.
(3) Create some additional functions for creating lists that
specify the elements directly as args rather than indirectly through
an array: listn() (number of args given), listu() (list terminated
by Qunbound).
(4) Delete a bit of remaining unused C window_config stuff, also
unused lrecord_type_popup_data.
| author | Ben Wing <ben@xemacs.org> |
|---|---|
| date | Thu, 18 Mar 2010 10:50:06 -0500 |
| parents | 2cf5d151eeb9 |
| children |
| rev | line source |
|---|---|
| 652 | 1 The files in this directory contain source code for the core XEmacs |
| 2 facilities written in Emacs Lisp. *.el files are Elisp source, and | |
| 3 *.elc files are byte-compiled versions of the corresponding *.el | |
| 4 files. Byte-compiled files are architecture-independent. | |
| 5 | |
| 6 Functions used only by files in this directory are considered | |
| 7 "internal" and are subject to change at any time. All commands, and | |
| 8 most functions with docstrings, are part of the exported API. In | |
| 9 particular, it is considered good style to use the Common Lisp | |
| 10 facilities provided in cl*.el. (Yes, that's ambiguous. Sorry, we | |
| 11 don't have a full specification of the API, as the Lispref is | |
| 12 chronically incomplete. Anything described in the Lispref is part of | |
| 13 the API, of course.) | |
| 14 | |
| 15 Libraries which implement applications and enhancements are placed in | |
| 16 the "packages", which are distributed separately from the core | |
| 17 sources. | |
| 18 | |
| 19 #### Someone please update this. | |
| 20 #### Partially updated 2001-08-25 by sjt. Needs more work. Mike? | |
| 21 | |
| 22 When XEmacs starts up, it adds certain directories in various | |
| 23 hierarchies containing Lisp libraries to `load-path' (the list of | |
| 24 directories to be searched when loading files). These are: this | |
| 25 directory, its subdirectory ./mule (in Mule-enabled XEmacs only), the | |
| 26 site-lisp directory (deprecated), and all the lisp/PACKAGE | |
| 27 subdirectories of the xemacs-packages, mule-packages, and | |
| 28 site-packages hierarchies. See setup-paths.el. | |
| 29 | |
| 30 #### Is the following true or relevant any more? | |
| 31 bogus> Directories whose names begin with "-" or "." are not added to | |
| 32 bogus> the default load-path. | |
| 33 | |
| 34 Some files which you might reasonably want to alter when installing or | |
| 35 customizing XEmacs at your site are: | |
| 36 | |
| 37 paths.el You may need to change the default pathnames here, | |
| 38 but probably not. This is loaded before XEmacs is | |
| 39 dumped. | |
| 40 | |
| 41 site-init.el #### obsolete and removed? | |
| 42 To pre-load additional libraries into XEmacs and dump | |
| 43 them in the executable, load them from this file. | |
| 44 Read the instructions in this file for a description | |
| 45 of how to do this. | |
| 46 | |
| 47 site-load.el #### description is obsolete | |
| 48 This is like site-init.el, but if you want the | |
| 49 docstrings of your preloaded libraries to be kept in | |
| 50 the DOC file instead of in the executable, you should | |
| 51 load them from this file instead. To do this, you must | |
| 52 also cause them to be scanned when the DOC file is | |
| 53 generated by editing ../src/Makefile.in.in and | |
| 54 rerunning configure. | |
| 55 #### new semantics | |
| 56 This file will preload additional libraries listed in | |
| 57 ../site-packages and dump them into XEmacs. | |
| 58 | |
| 59 ../site-packages List of additional libraries read by site-load.el. | |
| 60 | |
| 61 site-start.el This is loaded each time XEmacs starts up, before the | |
| 62 user's .emacs file. (Sysadmin must create.) Can be | |
| 63 inhibited for a given invocation with `--no-site-file'. | |
| 64 | |
| 65 default.el This is loaded each time XEmacs starts up, after the | |
| 66 user's .emacs file, unless .emacs sets the variable | |
| 67 inhibit-default-init to t. (Sysadmin must create.) | |
| 68 Can be inhibited for a given invocation with `-q'. | |
| 69 | |
| 70 version.el This contains the version information for XEmacs. | |
| 71 | |
| 72 ======================================================================== | |
| 73 Original text follows: | |
| 74 | |
| 428 | 75 The files in this directory contain source code for the XEmacs |
| 76 facilities written in Emacs Lisp. *.el files are Elisp source, and | |
| 77 *.elc files are byte-compiled versions of the corresponding *.el | |
| 78 files. Byte-compiled files are architecture-independent. | |
| 79 | |
| 80 #### Someone please update this. | |
| 81 | |
| 82 bogus> When XEmacs starts up, it adds all subdirectories of the | |
| 83 bogus> site-lisp directory. The site-lisp directory normally exists | |
| 84 bogus> only in installation trees. For more information about the | |
| 85 bogus> site-lisp directory see the NEWS file. | |
| 86 | |
| 87 bogus> After XEmacs adds all subdirectories of the site-lisp | |
| 88 bogus> directory, it adds all subdirectories of this directory to the | |
| 89 bogus> load-path (the list of directories to be searched when loading | |
| 90 bogus> files.) To speed up this process, this directory has been | |
| 91 bogus> rearranged to have very few files at the top-level, so that | |
| 92 bogus> emacs doesn't have to stat() several hundred files to find the | |
| 93 bogus> dozen or so which are actually subdirectories. | |
| 94 | |
| 95 bogus> Directories whose names begin with "-" or "." are not added to | |
| 96 bogus> the default load-path. | |
| 97 | |
| 98 The only files which remain at top-level are those which you might | |
| 99 reasonably want to alter when installing or customizing XEmacs at your | |
| 100 site. The files which may appear at top level are: | |
| 101 | |
| 102 paths.el You may need to change the default pathnames here, | |
| 103 but probably not. This is loaded before XEmacs is | |
| 104 dumped. | |
| 105 | |
| 106 site-init.el To pre-load additional libraries into XEmacs and dump | |
| 107 them in the executable, load them from this file. | |
| 108 Read the instructions in this file for a description | |
| 109 of how to do this. | |
| 110 | |
| 111 site-load.el This is like site-init.el, but if you want the | |
| 112 docstrings of your preloaded libraries to be kept in | |
| 113 the DOC file instead of in the executable, you should | |
| 114 load them from this file instead. To do this, you must | |
| 115 also cause them to be scanned when the DOC file is | |
| 116 generated by editing ../src/Makefile.in.in and | |
| 117 rerunning configure. | |
| 118 | |
| 119 site-start.el This is loaded each time XEmacs starts up, before the | |
| 120 user's .emacs file. | |
| 121 | |
| 122 default.el This is loaded each time XEmacs starts up, after the | |
| 123 user's .emacs file, unless .emacs sets the variable | |
| 124 inhibit-default-init to t. | |
| 125 | |
| 126 version.el This contains the version information for XEmacs. |