Mercurial > hg > xemacs-beta
annotate lib-src/sorted-doc.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 | ecf1ebac70d8 |
| children | 061f4f90f874 06dd936cde16 |
| rev | line source |
|---|---|
| 428 | 1 /* Give this program DOCSTR.mm.nn as standard input |
| 2 and it outputs to standard output | |
| 3 a file of texinfo input containing the doc strings. | |
| 4 | |
| 5 This version sorts the output by function name. | |
| 6 */ | |
| 7 | |
| 8 /* Synched up with: FSF 19.28. */ | |
| 9 | |
| 438 | 10 #include <config.h> |
| 428 | 11 |
| 12 #include <stdio.h> | |
| 13 #include <ctype.h> | |
| 440 | 14 #include <stdlib.h> /* for qsort() and malloc() */ |
| 15 #include <string.h> | |
| 16 static void *xmalloc (size_t); | |
| 428 | 17 |
| 18 #define NUL '\0' | |
| 19 #define MARKER '\037' | |
| 20 | |
| 21 #define DEBUG 0 | |
| 22 | |
| 440 | 23 typedef struct LINE LINE; |
| 428 | 24 |
| 440 | 25 struct LINE |
| 428 | 26 { |
| 27 LINE *next; /* ptr to next or NULL */ | |
| 28 char *line; /* text of the line */ | |
| 29 }; | |
| 30 | |
| 31 typedef struct docstr DOCSTR; | |
| 32 | |
| 33 struct docstr /* Allocated thing for an entry. */ | |
| 34 { | |
| 35 DOCSTR *next; /* next in the chain */ | |
| 36 char *name; /* name of the function or var */ | |
| 37 LINE *first; /* first line of doc text. */ | |
| 38 char type; /* 'F' for function, 'V' for variable */ | |
| 39 }; | |
| 40 | |
| 41 | |
| 42 /* Print error message. `s1' is printf control string, `s2' is arg for it. */ | |
| 43 | |
| 44 static void | |
| 45 error (char *s1, char *s2) | |
| 46 { | |
| 47 fprintf (stderr, "sorted-doc: "); | |
| 48 fprintf (stderr, s1, s2); | |
| 49 fprintf (stderr, "\n"); | |
| 50 } | |
| 51 | |
| 52 /* Print error message and exit. */ | |
| 53 | |
| 54 static void | |
| 55 fatal (char *s1, char *s2) | |
| 56 { | |
| 57 error (s1, s2); | |
| 58 exit (1); | |
| 59 } | |
| 60 | |
| 61 /* Like malloc but get fatal error if memory is exhausted. */ | |
| 62 | |
| 63 static void * | |
| 440 | 64 xmalloc (size_t size) |
| 428 | 65 { |
| 440 | 66 void *result = malloc (size); |
| 428 | 67 if (result == NULL) |
| 68 fatal ("%s", "virtual memory exhausted"); | |
| 69 return result; | |
| 70 } | |
| 71 | |
| 72 static char * | |
| 73 strsav (char *str) | |
| 74 { | |
| 440 | 75 char *buf = (char *) xmalloc (strlen (str) + 1); |
| 76 strcpy (buf, str); | |
| 77 return buf; | |
| 428 | 78 } |
| 79 | |
| 80 /* Comparison function for qsort to call. */ | |
| 81 | |
| 82 static int | |
| 83 cmpdoc (DOCSTR **a, DOCSTR **b) | |
| 84 { | |
| 85 register int val = strcmp ((*a)->name, (*b)->name); | |
| 86 if (val) return val; | |
| 87 return (*a)->type - (*b)->type; | |
| 88 } | |
| 89 | |
| 90 | |
| 91 enum state | |
| 92 { | |
| 93 WAITING, BEG_NAME, NAME_GET, BEG_DESC, DESC_GET | |
| 94 }; | |
| 95 | |
| 442 | 96 const char *states[] = |
| 428 | 97 { |
| 98 "WAITING", "BEG_NAME", "NAME_GET", "BEG_DESC", "DESC_GET" | |
| 99 }; | |
| 100 | |
| 101 int | |
| 2367 | 102 main (int argc, char **argv) |
| 428 | 103 { |
| 104 register DOCSTR *dp = NULL; /* allocated DOCSTR */ | |
| 105 register LINE *lp = NULL; /* allocated line */ | |
| 106 register char *bp = 0; /* ptr inside line buffer */ | |
| 107 /* int notfirst = 0; / * set after read something */ | |
| 108 register enum state state = WAITING; /* state at start */ | |
| 109 int cnt = 0; /* number of DOCSTRs read */ | |
| 110 | |
| 111 DOCSTR *docs = 0; /* chain of allocated DOCSTRS */ | |
| 112 char buf[512]; /* line buffer */ | |
| 113 | |
| 114 while (1) /* process one char at a time */ | |
| 115 { | |
| 116 /* this char from the DOCSTR file */ | |
| 117 register int ch = getchar (); | |
| 118 | |
| 119 /* Beginnings */ | |
| 120 | |
| 121 if (state == WAITING) | |
| 122 { | |
| 123 if (ch == MARKER) | |
| 124 state = BEG_NAME; | |
| 125 } | |
| 126 else if (state == BEG_NAME) | |
| 127 { | |
| 128 cnt++; | |
| 129 if (dp == NULL) /* first dp allocated */ | |
| 130 { | |
| 131 docs = dp = (DOCSTR*) xmalloc (sizeof (DOCSTR)); | |
| 132 } | |
| 133 else /* all the rest */ | |
| 134 { | |
| 135 dp->next = (DOCSTR*) xmalloc (sizeof (DOCSTR)); | |
| 136 dp = dp->next; | |
| 137 } | |
| 138 lp = NULL; | |
| 139 dp->next = NULL; | |
| 140 bp = buf; | |
| 141 state = NAME_GET; | |
| 142 /* Record whether function or variable. */ | |
| 143 dp->type = ch; | |
| 144 ch = getchar (); | |
| 145 } | |
| 146 else if (state == BEG_DESC) | |
| 147 { | |
| 148 if (lp == NULL) /* first line for dp */ | |
| 149 { | |
| 150 dp->first = lp = (LINE*)xmalloc (sizeof (LINE)); | |
| 151 } | |
| 152 else /* continuing lines */ | |
| 153 { | |
| 154 lp->next = (LINE*)xmalloc (sizeof (LINE)); | |
| 155 lp = lp->next; | |
| 156 } | |
| 157 lp->next = NULL; | |
| 158 bp = buf; | |
| 159 state = DESC_GET; | |
| 160 } | |
| 161 | |
| 162 /* process gets */ | |
| 163 | |
| 164 if (state == NAME_GET || state == DESC_GET) | |
| 165 { | |
| 166 if (ch != MARKER && ch != '\n' && ch != EOF) | |
| 167 { | |
| 168 *bp++ = ch; | |
| 169 } | |
| 170 else /* saving and changing state */ | |
| 171 { | |
| 172 *bp = NUL; | |
| 173 bp = strsav (buf); | |
| 174 | |
| 175 if (state == NAME_GET) | |
| 176 dp->name = bp; | |
| 177 else | |
| 178 lp->line = bp; | |
| 179 | |
| 180 bp = buf; | |
| 181 state = (ch == MARKER) ? BEG_NAME : BEG_DESC; | |
| 182 } | |
| 183 } /* NAME_GET || DESC_GET */ | |
| 184 if (ch == EOF) | |
| 185 break; | |
| 186 } | |
| 187 | |
| 188 { | |
| 189 DOCSTR **array; | |
| 190 register int i; /* counter */ | |
| 191 | |
| 192 /* build array of ptrs to DOCSTRs */ | |
| 193 | |
| 194 array = (DOCSTR**)xmalloc (cnt * sizeof (*array)); | |
| 195 for (dp = docs, i = 0; dp != NULL ; dp = dp->next) | |
| 196 array[i++] = dp; | |
| 197 | |
| 198 /* sort the array by name; within each name, by type */ | |
| 199 | |
| 200 qsort ((char*)array, cnt, sizeof (DOCSTR*), | |
| 442 | 201 (int (*)(const void *, const void *)) cmpdoc); |
| 428 | 202 |
| 203 /* write the output header */ | |
| 204 | |
| 205 printf ("\\input texinfo @c -*-texinfo-*-\n"); | |
| 206 printf ("@setfilename ../info/summary\n"); | |
| 613 | 207 printf ("@settitle Command Summary for XEmacs\n"); |
| 208 printf ("@unnumbered Command Summary for XEmacs\n"); | |
| 428 | 209 printf ("@table @asis\n"); |
| 210 printf ("\n"); | |
| 211 printf ("@iftex\n"); | |
| 212 printf ("@global@let@ITEM=@item\n"); | |
| 213 printf ("@def@item{@filbreak@vskip5pt@ITEM}\n"); | |
| 214 printf ("@font@tensy cmsy10 scaled @magstephalf\n"); | |
| 215 printf ("@font@teni cmmi10 scaled @magstephalf\n"); | |
| 216 printf ("@def\\{{@tensy@char110}}\n"); /* this backslash goes with cmr10 */ | |
| 217 printf ("@def|{{@tensy@char106}}\n"); | |
| 218 printf ("@def@{{{@tensy@char102}}\n"); | |
| 219 printf ("@def@}{{@tensy@char103}}\n"); | |
| 220 printf ("@def<{{@teni@char62}}\n"); | |
| 221 printf ("@def>{{@teni@char60}}\n"); | |
| 222 printf ("@chardef@@64\n"); | |
| 223 printf ("@catcode43=12\n"); | |
| 224 printf ("@tableindent-0.2in\n"); | |
| 225 printf ("@end iftex\n"); | |
| 226 | |
| 227 /* print each function from the array */ | |
| 228 | |
| 229 for (i = 0; i < cnt; i++) | |
| 230 { | |
| 231 printf ("\n@item %s @code{%s}\n@display\n", | |
| 232 array[i]->type == 'F' ? "Function" : "Variable", | |
| 233 array[i]->name); | |
| 234 | |
| 235 for (lp = array[i]->first; lp != NULL ; lp = lp->next) | |
| 236 { | |
| 237 for (bp = lp->line; *bp; bp++) | |
| 238 { | |
| 239 /* the characters "@{}" need special treatment */ | |
| 240 if (*bp == '@' || *bp == '{' || *bp == '}') | |
| 241 { | |
| 242 putchar('@'); | |
| 243 } | |
| 244 putchar(*bp); | |
| 245 } | |
| 246 putchar ('\n'); | |
| 247 } | |
| 248 printf("@end display\n"); | |
| 249 if ( i%200 == 0 && i != 0 ) printf("@end table\n\n@table @asis\n"); | |
| 250 } | |
| 251 | |
| 252 printf ("@end table\n"); | |
| 253 printf ("@bye\n"); | |
| 254 } | |
| 255 | |
| 256 return 0; | |
| 257 } |