Mercurial > hg > xemacs-beta
diff src/alloc.c @ 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 | 88bd4f3ef8e4 |
| children | 9e0b43d3095c |
line wrap: on
line diff
--- a/src/alloc.c Thu Mar 18 10:19:08 2010 -0500 +++ b/src/alloc.c Thu Mar 18 10:50:06 2010 -0500 @@ -105,7 +105,7 @@ /* All the built-in lisp object types are enumerated in `enum lrecord_type'. Additional ones may be defined by a module (none yet). We leave some room in `lrecord_implementations_table' for such new lisp object types. */ -const struct lrecord_implementation *lrecord_implementations_table[(int)lrecord_type_last_built_in_type + MODULE_DEFINABLE_TYPE_COUNT]; +struct lrecord_implementation *lrecord_implementations_table[(int)lrecord_type_last_built_in_type + MODULE_DEFINABLE_TYPE_COUNT]; int lrecord_type_count = lrecord_type_last_built_in_type; /* This is just for use by the printer, to allow things to print uniquely. @@ -127,6 +127,12 @@ #endif +#ifdef MEMORY_USAGE_STATS +Lisp_Object Qobject_actually_requested, Qobject_malloc_overhead; +Lisp_Object Qother_memory_actually_requested, Qother_memory_malloc_overhead; +Lisp_Object Qother_memory_dynarr_overhead, Qother_memory_gap_overhead; +#endif /* MEMORY_USAGE_STATS */ + /* Very cheesy ways of figuring out how much memory is being used for data. #### Need better (system-dependent) ways. */ void *minimum_address_seen; @@ -760,8 +766,8 @@ debug_print (wrap_pointer_1 (header)); } #endif - if (imp->disksaver && !objh->free) - (imp->disksaver) (wrap_pointer_1 (header)); + if (imp->disksave && !objh->free) + (imp->disksave) (wrap_pointer_1 (header)); } #endif /* not NEW_GC */ } @@ -842,7 +848,7 @@ #ifdef MEMORY_USAGE_STATS Bytecount -lisp_object_storage_size (Lisp_Object obj, struct overhead_stats *ovstats) +lisp_object_storage_size (Lisp_Object obj, struct usage_stats *ustats) { #ifndef NEW_GC const struct lrecord_implementation *imp = @@ -851,20 +857,20 @@ Bytecount size = lisp_object_size (obj); #ifdef NEW_GC - return mc_alloced_storage_size (size, ovstats); + return mc_alloced_storage_size (size, ustats); #else if (imp->frob_block_p) { Bytecount overhead = fixed_type_block_overhead (size); - if (ovstats) + if (ustats) { - ovstats->was_requested += size; - ovstats->malloc_overhead += overhead; + ustats->was_requested += size; + ustats->malloc_overhead += overhead; } return size + overhead; } else - return malloced_storage_size (XPNTR (obj), size, ovstats); + return malloced_storage_size (XPNTR (obj), size, ustats); #endif } @@ -1480,6 +1486,46 @@ return Fcons (obj0, Fcons (obj1, Fcons (obj2, Fcons (obj3, Fcons (obj4, Fcons (obj5, Qnil)))))); } +/* Return a list of arbitrary length, terminated by Qunbound. */ + +Lisp_Object +listu (Lisp_Object first, ...) +{ + Lisp_Object obj = Qnil; + Lisp_Object val; + va_list va; + + va_start (va, first); + val = first; + while (!UNBOUNDP (val)) + { + obj = Fcons (val, obj); + val = va_arg (va, Lisp_Object); + } + va_end (va); + return Fnreverse (obj); +} + +/* Return a list of arbitrary length, with length specified and remaining + args making up the list. */ + +Lisp_Object +listn (int num_args, ...) +{ + int i; + Lisp_Object obj = Qnil; + va_list va; + + va_start (va, num_args); + for (i = 0; i < num_args; i++) + obj = Fcons (va_arg (va, Lisp_Object), obj); + va_end (va); + return Fnreverse (obj); +} + +/* Return a list of arbitrary length, with length specified and an array + of elements. */ + DEFUN ("make-list", Fmake_list, 2, 2, 0, /* Return a new list of length LENGTH, with each element being OBJECT. */ @@ -2434,16 +2480,11 @@ standard way to do finalization when using SWEEP_FIXED_TYPE_BLOCK(). */ -DEFINE_DUMPABLE_FROB_BLOCK_GENERAL_LISP_OBJECT ("string", string, - mark_string, print_string, - 0, string_equal, 0, - string_description, - string_getprop, - string_putprop, - string_remprop, - string_plist, - 0 /* no disksaver */, - Lisp_String); +DEFINE_DUMPABLE_FROB_BLOCK_LISP_OBJECT ("string", string, + mark_string, print_string, + 0, string_equal, 0, + string_description, + Lisp_String); #endif /* not NEW_GC */ #ifdef NEW_GC @@ -2484,17 +2525,9 @@ #endif /* not NEW_GC */ #ifdef NEW_GC -DEFINE_DUMPABLE_GENERAL_LISP_OBJECT ("string", string, - mark_string, print_string, - 0, - string_equal, 0, - string_description, - string_getprop, - string_putprop, - string_remprop, - string_plist, - 0 /* no disksaver */, - Lisp_String); +DEFINE_DUMPABLE_LISP_OBJECT ("string", string, mark_string, print_string, + 0, string_equal, 0, + string_description, Lisp_String); static const struct memory_description string_direct_data_description[] = { @@ -4748,7 +4781,7 @@ return pl; } -DEFUN("object-memory-usage-stats", Fobject_memory_usage_stats, 0, 0 ,"", /* +DEFUN ("object-memory-usage-stats", Fobject_memory_usage_stats, 0, 0, 0, /* Return statistics about memory usage of Lisp objects. */ ()) @@ -4758,6 +4791,127 @@ #endif /* ALLOC_TYPE_STATS */ +#ifdef MEMORY_USAGE_STATS + +/* Compute the number of extra memory-usage statistics associated with an + object. We can't compute this at the time INIT_LISP_OBJECT() is called + because the value of the `memusage_stats_list' property is generally + set afterwards. So we compute the values for all types of objects + after all objects have been initialized. */ + +static void +compute_memusage_stats_length (void) +{ + int i; + + for (i = 0; i < countof (lrecord_implementations_table); i++) + { + int len = 0; + struct lrecord_implementation *imp = lrecord_implementations_table[i]; + + if (!imp) + continue; + /* For some of the early objects, Qnil was not yet initialized at + the time of object initialization, so it came up as Qnull_pointer. + Fix that now. */ + if (EQ (imp->memusage_stats_list, Qnull_pointer)) + imp->memusage_stats_list = Qnil; + { + LIST_LOOP_2 (item, imp->memusage_stats_list) + { + if (!NILP (item) && !EQ (item, Qt)) + len++; + } + } + + imp->num_extra_memusage_stats = len; + } +} + +DEFUN ("object-memory-usage", Fobject_memory_usage, 1, 1, 0, /* +Return stats about the memory usage of OBJECT. +The values returned are in the form of an alist of usage types and byte +counts. The byte counts attempt to encompass all the memory used +by the object (separate from the memory logically associated with any +other object), including internal structures and any malloc() +overhead associated with them. In practice, the byte counts are +underestimated because certain memory usage is very hard to determine +\(e.g. the amount of memory used inside the Xt library or inside the +X server). + +Multiple slices of the total memory usage may be returned, separated +by a nil. Each slice represents a particular view of the memory, a +particular way of partitioning it into groups. Within a slice, there +is no overlap between the groups of memory, and each slice collectively +represents all the memory concerned. The rightmost slice typically +represents the total memory used plus malloc and dynarr overhead. + +Slices describing other Lisp objects logically associated with the +object may be included, separated from other slices by `t' and from +each other by nil if there is more than one. + +#### We have to figure out how to handle the memory used by the object +itself vs. the memory used by substructures. Probably the memory_usage +method should return info only about substructures and related Lisp +objects, since the caller can always find and all info about the object +itself. +*/ + (object)) +{ + struct generic_usage_stats gustats; + struct usage_stats object_stats; + int i; + Lisp_Object val = Qnil; + Lisp_Object stats_list = OBJECT_PROPERTY (object, memusage_stats_list); + + xzero (object_stats); + lisp_object_storage_size (object, &object_stats); + + val = acons (Qobject_actually_requested, + make_int (object_stats.was_requested), val); + val = acons (Qobject_malloc_overhead, + make_int (object_stats.malloc_overhead), val); + assert (!object_stats.dynarr_overhead); + assert (!object_stats.gap_overhead); + + if (!NILP (stats_list)) + { + xzero (gustats); + MAYBE_OBJECT_METH (object, memory_usage, (object, &gustats)); + + val = Fcons (Qt, val); + val = acons (Qother_memory_actually_requested, + make_int (gustats.u.was_requested), val); + val = acons (Qother_memory_malloc_overhead, + make_int (gustats.u.malloc_overhead), val); + if (gustats.u.dynarr_overhead) + val = acons (Qother_memory_dynarr_overhead, + make_int (gustats.u.dynarr_overhead), val); + if (gustats.u.gap_overhead) + val = acons (Qother_memory_gap_overhead, + make_int (gustats.u.gap_overhead), val); + val = Fcons (Qnil, val); + + i = 0; + { + LIST_LOOP_2 (item, stats_list) + { + if (NILP (item) || EQ (item, Qt)) + val = Fcons (item, val); + else + { + val = acons (item, make_int (gustats.othervals[i]), val); + i++; + } + } + } + } + + return Fnreverse (val); +} + +#endif /* MEMORY_USAGE_STATS */ + /* Debugging aids. */ DEFUN ("garbage-collect", Fgarbage_collect, 0, 0, "", /* @@ -4858,7 +5012,7 @@ } #ifdef ALLOC_TYPE_STATS -DEFUN ("object-memory-usage", Fobject_memory_usage, 0, 0, 0, /* +DEFUN ("total-object-memory-usage", Ftotal_object_memory_usage, 0, 0, 0, /* Return total number of bytes used for object storage in XEmacs. This may be helpful in debugging XEmacs's memory usage. See also `consing-since-gc' and `object-memory-usage-stats'. @@ -4950,7 +5104,7 @@ Bytecount malloced_storage_size (void * UNUSED (ptr), Bytecount claimed_size, - struct overhead_stats *stats) + struct usage_stats *stats) { Bytecount orig_claimed_size = claimed_size; @@ -5056,6 +5210,7 @@ #ifndef NEW_GC init_string_chars_alloc (); init_string_alloc (); + /* #### Is it intentional that this is called twice? --ben */ init_string_chars_alloc (); init_cons_alloc (); init_symbol_alloc (); @@ -5164,6 +5319,15 @@ #endif /* defined (__cplusplus) && defined (ERROR_CHECK_GC) */ } +static void +reinit_alloc_objects_early (void) +{ + OBJECT_HAS_METHOD (string, getprop); + OBJECT_HAS_METHOD (string, putprop); + OBJECT_HAS_METHOD (string, remprop); + OBJECT_HAS_METHOD (string, plist); +} + void reinit_alloc_early (void) { @@ -5171,6 +5335,7 @@ #ifndef NEW_GC init_lcrecord_lists (); #endif /* not NEW_GC */ + reinit_alloc_objects_early (); } void @@ -5186,18 +5351,6 @@ dump_add_opaque (lrecord_uid_counter, sizeof (lrecord_uid_counter)); - INIT_LISP_OBJECT (cons); - INIT_LISP_OBJECT (vector); - INIT_LISP_OBJECT (string); -#ifdef NEW_GC - INIT_LISP_OBJECT (string_indirect_data); - INIT_LISP_OBJECT (string_direct_data); -#endif /* NEW_GC */ -#ifndef NEW_GC - INIT_LISP_OBJECT (lcrecord_list); - INIT_LISP_OBJECT (free); -#endif /* not NEW_GC */ - staticpros = Dynarr_new2 (Lisp_Object_ptr_dynarr, Lisp_Object *); Dynarr_resize (staticpros, 1410); /* merely a small optimization */ dump_add_root_block_ptr (&staticpros, &staticpros_description); @@ -5221,6 +5374,21 @@ #else /* not NEW_GC */ init_lcrecord_lists (); #endif /* not NEW_GC */ + + INIT_LISP_OBJECT (cons); + INIT_LISP_OBJECT (vector); + INIT_LISP_OBJECT (string); + +#ifdef NEW_GC + INIT_LISP_OBJECT (string_indirect_data); + INIT_LISP_OBJECT (string_direct_data); +#endif /* NEW_GC */ +#ifndef NEW_GC + INIT_LISP_OBJECT (lcrecord_list); + INIT_LISP_OBJECT (free); +#endif /* not NEW_GC */ + + reinit_alloc_objects_early (); } void @@ -5228,6 +5396,15 @@ { DEFSYMBOL (Qgarbage_collecting); +#ifdef MEMORY_USAGE_STATS + DEFSYMBOL (Qobject_actually_requested); + DEFSYMBOL (Qobject_malloc_overhead); + DEFSYMBOL (Qother_memory_actually_requested); + DEFSYMBOL (Qother_memory_malloc_overhead); + DEFSYMBOL (Qother_memory_dynarr_overhead); + DEFSYMBOL (Qother_memory_gap_overhead); +#endif /* MEMORY_USAGE_STATS */ + DEFSUBR (Fcons); DEFSUBR (Flist); DEFSUBR (Fvector); @@ -5243,8 +5420,11 @@ DEFSUBR (Fpurecopy); #ifdef ALLOC_TYPE_STATS DEFSUBR (Fobject_memory_usage_stats); + DEFSUBR (Ftotal_object_memory_usage); +#endif /* ALLOC_TYPE_STATS */ +#ifdef MEMORY_USAGE_STATS DEFSUBR (Fobject_memory_usage); -#endif /* ALLOC_TYPE_STATS */ +#endif /* MEMORY_USAGE_STATS */ DEFSUBR (Fgarbage_collect); #if 0 DEFSUBR (Fmemory_limit); @@ -5258,6 +5438,14 @@ } void +reinit_vars_of_alloc (void) +{ +#ifdef MEMORY_USAGE_STATS + compute_memusage_stats_length (); +#endif /* MEMORY_USAGE_STATS */ +} + +void vars_of_alloc (void) { #ifdef DEBUG_XEMACS