comparison src/buffer.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 f965e31a35f0
children 9e0b43d3095c
comparison
equal deleted inserted replaced
5156:6bff4f219697 5157:1fae11d56ad2
1750 1750
1751 #ifdef MEMORY_USAGE_STATS 1751 #ifdef MEMORY_USAGE_STATS
1752 1752
1753 struct buffer_stats 1753 struct buffer_stats
1754 { 1754 {
1755 int text; 1755 struct usage_stats u;
1756 int markers; 1756 Bytecount text;
1757 int extents; 1757 Bytecount markers;
1758 int other; 1758 Bytecount extents;
1759 }; 1759 };
1760 1760
1761 static Bytecount 1761 static Bytecount
1762 compute_buffer_text_usage (struct buffer *b, struct overhead_stats *ovstats) 1762 compute_buffer_text_usage (struct buffer *b, struct usage_stats *ustats)
1763 { 1763 {
1764 int was_requested = b->text->z - 1; 1764 Bytecount was_requested = b->text->z - 1;
1765 Bytecount gap = b->text->gap_size + b->text->end_gap_size; 1765 Bytecount gap = b->text->gap_size + b->text->end_gap_size;
1766 Bytecount malloc_use = malloced_storage_size (b->text->beg, was_requested + gap, 0); 1766 Bytecount malloc_use = malloced_storage_size (b->text->beg, was_requested + gap, 0);
1767 1767
1768 ovstats->gap_overhead += gap; 1768 ustats->gap_overhead += gap;
1769 ovstats->was_requested += was_requested; 1769 ustats->was_requested += was_requested;
1770 ovstats->malloc_overhead += malloc_use - (was_requested + gap); 1770 ustats->malloc_overhead += malloc_use - (was_requested + gap);
1771 return malloc_use; 1771 return malloc_use;
1772 } 1772 }
1773 1773
1774 static void 1774 static void
1775 compute_buffer_usage (struct buffer *b, struct buffer_stats *stats, 1775 compute_buffer_usage (struct buffer *b, struct buffer_stats *stats,
1776 struct overhead_stats *ovstats) 1776 struct usage_stats *ustats)
1777 { 1777 {
1778 xzero (*stats); 1778 stats->text += compute_buffer_text_usage (b, ustats);
1779 stats->other += lisp_object_storage_size (wrap_buffer (b), ovstats); 1779 stats->markers += compute_buffer_marker_usage (b, ustats);
1780 stats->text += compute_buffer_text_usage (b, ovstats); 1780 stats->extents += compute_buffer_extent_usage (b, ustats);
1781 stats->markers += compute_buffer_marker_usage (b, ovstats); 1781 }
1782 stats->extents += compute_buffer_extent_usage (b, ovstats); 1782
1783 } 1783 static void
1784 1784 buffer_memory_usage (Lisp_Object buffer, struct generic_usage_stats *gustats)
1785 DEFUN ("buffer-memory-usage", Fbuffer_memory_usage, 1, 1, 0, /* 1785 {
1786 Return stats about the memory usage of buffer BUFFER. 1786 struct buffer_stats *stats = (struct buffer_stats *) gustats;
1787 The values returned are in the form of an alist of usage types and byte 1787
1788 counts. The byte counts attempt to encompass all the memory used 1788 compute_buffer_usage (XBUFFER (buffer), stats, &stats->u);
1789 by the buffer (separate from the memory logically associated with a
1790 buffer or frame), including internal structures and any malloc()
1791 overhead associated with them. In practice, the byte counts are
1792 underestimated because certain memory usage is very hard to determine
1793 \(e.g. the amount of memory used inside the Xt library or inside the
1794 X server) and because there is other stuff that might logically
1795 be associated with a window, buffer, or frame (e.g. window configurations,
1796 glyphs) but should not obviously be included in the usage counts.
1797
1798 Multiple slices of the total memory usage may be returned, separated
1799 by a nil. Each slice represents a particular view of the memory, a
1800 particular way of partitioning it into groups. Within a slice, there
1801 is no overlap between the groups of memory, and each slice collectively
1802 represents all the memory concerned.
1803 */
1804 (buffer))
1805 {
1806 struct buffer_stats stats;
1807 struct overhead_stats ovstats;
1808 Lisp_Object val = Qnil;
1809
1810 CHECK_BUFFER (buffer); /* dead buffers should be allowed, no? */
1811 xzero (ovstats);
1812 compute_buffer_usage (XBUFFER (buffer), &stats, &ovstats);
1813
1814 val = acons (Qtext, make_int (stats.text), val);
1815 val = acons (Qmarkers, make_int (stats.markers), val);
1816 val = acons (Qextents, make_int (stats.extents), val);
1817 val = acons (Qother, make_int (stats.other), val);
1818 val = Fcons (Qnil, val);
1819 val = acons (Qactually_requested, make_int (ovstats.was_requested), val);
1820 val = acons (Qmalloc_overhead, make_int (ovstats.malloc_overhead), val);
1821 val = acons (Qgap_overhead, make_int (ovstats.gap_overhead), val);
1822 val = acons (Qdynarr_overhead, make_int (ovstats.dynarr_overhead), val);
1823
1824 return Fnreverse (val);
1825 } 1789 }
1826 1790
1827 #endif /* MEMORY_USAGE_STATS */ 1791 #endif /* MEMORY_USAGE_STATS */
1828 1792
1829 #if defined (DEBUG_XEMACS) && defined (MULE) 1793 #if defined (DEBUG_XEMACS) && defined (MULE)
1903 #endif /* defined (DEBUG_XEMACS) && defined (MULE) */ 1867 #endif /* defined (DEBUG_XEMACS) && defined (MULE) */
1904 1868
1905 1869
1906 1870
1907 void 1871 void
1872 buffer_objects_create (void)
1873 {
1874 #ifdef MEMORY_USAGE_STATS
1875 OBJECT_HAS_METHOD (buffer, memory_usage);
1876 #endif
1877 }
1878
1879 void
1908 syms_of_buffer (void) 1880 syms_of_buffer (void)
1909 { 1881 {
1910 INIT_LISP_OBJECT (buffer); 1882 INIT_LISP_OBJECT (buffer);
1911 #ifdef NEW_GC 1883 #ifdef NEW_GC
1912 INIT_LISP_OBJECT (buffer_text); 1884 INIT_LISP_OBJECT (buffer_text);
1967 DEFSUBR (Fcurrent_buffer); 1939 DEFSUBR (Fcurrent_buffer);
1968 DEFSUBR (Fset_buffer); 1940 DEFSUBR (Fset_buffer);
1969 DEFSUBR (Fbarf_if_buffer_read_only); 1941 DEFSUBR (Fbarf_if_buffer_read_only);
1970 DEFSUBR (Fbury_buffer); 1942 DEFSUBR (Fbury_buffer);
1971 DEFSUBR (Fkill_all_local_variables); 1943 DEFSUBR (Fkill_all_local_variables);
1972 #ifdef MEMORY_USAGE_STATS
1973 DEFSUBR (Fbuffer_memory_usage);
1974 #endif
1975 #if defined (DEBUG_XEMACS) && defined (MULE) 1944 #if defined (DEBUG_XEMACS) && defined (MULE)
1976 DEFSUBR (Fbuffer_char_byte_converion_info); 1945 DEFSUBR (Fbuffer_char_byte_converion_info);
1977 DEFSUBR (Fstring_char_byte_converion_info); 1946 DEFSUBR (Fstring_char_byte_converion_info);
1978 #endif 1947 #endif
1979 1948
1992 /* initialize the buffer routines */ 1961 /* initialize the buffer routines */
1993 void 1962 void
1994 vars_of_buffer (void) 1963 vars_of_buffer (void)
1995 { 1964 {
1996 /* This function can GC */ 1965 /* This function can GC */
1966 #ifdef MEMORY_USAGE_STATS
1967 OBJECT_HAS_PROPERTY
1968 (buffer, memusage_stats_list, list3 (Qtext, Qmarkers, Qextents));
1969 #endif /* MEMORY_USAGE_STATS */
1970
1997 staticpro (&QSFundamental); 1971 staticpro (&QSFundamental);
1998 staticpro (&QSscratch); 1972 staticpro (&QSscratch);
1999 1973
2000 QSFundamental = build_ascstring ("Fundamental"); 1974 QSFundamental = build_ascstring ("Fundamental");
2001 QSscratch = build_ascstring ("*scratch*"); 1975 QSscratch = build_ascstring ("*scratch*");