Mercurial > hg > xemacs-beta
annotate lisp/cus-dep.el @ 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 | b4a8cd0dd8df |
| children | 308d34e9f07d |
| rev | line source |
|---|---|
| 428 | 1 ;;; cus-dep.el --- Find customization dependencies. |
| 2 ;; | |
| 3 ;; Copyright (C) 1997 Free Software Foundation, Inc. | |
| 1298 | 4 ;; Copyright (C) 2003 Ben Wing. |
| 428 | 5 ;; |
| 6 ;; Author: Per Abrahamsen <abraham@dina.kvl.dk>, then | |
| 7 ;; Richard Stallman <rms@gnu.ai.mit.edu>, then | |
| 8 ;; Hrvoje Niksic <hniksic@xemacs.org> (rewritten for XEmacs) | |
| 9 ;; Maintainer: Hrvoje Niksic <hniksic@xemacs.org> | |
| 10 ;; Keywords: internal | |
| 11 | |
| 12 ;; This file is part of XEmacs. | |
| 13 | |
| 14 ;; XEmacs is free software; you can redistribute it and/or modify | |
| 15 ;; it under the terms of the GNU General Public License as published by | |
| 16 ;; the Free Software Foundation; either version 2, or (at your option) | |
| 17 ;; any later version. | |
| 18 | |
| 19 ;; XEmacs is distributed in the hope that it will be useful, | |
| 20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
| 22 ;; GNU General Public License for more details. | |
| 23 | |
| 24 ;; You should have received a copy of the GNU General Public License | |
| 25 ;; along with XEmacs; see the file COPYING. If not, write to the | |
| 26 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
| 27 ;; Boston, MA 02111-1307, USA. | |
| 28 | |
| 29 ;;; Synched up with: Not synched with FSF. | |
| 30 | |
| 31 | |
| 32 ;;; Commentary: | |
| 33 | |
| 34 ;; This file generates the custom-load files, loaded by cus-load.el. | |
| 442 | 35 ;; Entry points are `Custom-make-dependencies' and |
| 36 ;; `Custom-make-one-dependency'. | |
| 428 | 37 |
| 38 ;; It works by scanning all the `.el' files in a directory, and | |
| 39 ;; evaluates any `defcustom', `defgroup', or `defface' expression that | |
| 40 ;; it finds. The symbol changed by this expression is stored to a | |
| 41 ;; hash table as the hash key, file name being the value. | |
| 42 | |
| 43 ;; After all the files have been examined, custom-loads.el is | |
| 44 ;; generated by mapping all the atoms, and seeing if any of them | |
| 45 ;; contains a `custom-group' property. This property is a list whose | |
| 46 ;; each element's car is the "child" group symbol. If that property | |
| 47 ;; is in the hash-table, the file name will be looked up from the | |
| 48 ;; hash-table, and added to cusload-file. Because the hash-table is | |
| 49 ;; cleared whenever we process a new directory, we cannot get confused | |
| 50 ;; by custom-loads from another directory, or from a previous | |
| 51 ;; installation. This is also why it is perfectly safe to have old | |
| 52 ;; custom-loads around, and have them loaded by `cus-load.el' (as | |
| 53 ;; invoked by `cus-edit.el'). | |
| 54 | |
| 55 ;; A trivial, but useful optimization is that if cusload-file exists, | |
| 56 ;; and no .el files in the directory are newer than cusload-file, it | |
| 57 ;; will not be generated. This means that the directories where | |
| 58 ;; nothing has changed will be skipped. | |
| 59 | |
| 60 ;; The `custom-add-loads' function, used by files generated by | |
| 61 ;; `Custom-make-dependencies', updates the symbol's `custom-loads' | |
| 62 ;; property (a list of strings) with a new list of strings, | |
| 63 ;; eliminating the duplicates. Additionally, it adds the symbol to | |
| 64 ;; `custom-group-hash-table'. It is defined in `cus-load.el'. | |
| 65 | |
| 66 ;; Example: | |
| 67 | |
| 68 ;; (custom-add-loads 'foo 'custom-loads '("bar" "baz")) | |
| 69 ;; (get 'foo 'custom-loads) | |
| 70 ;; => ("bar" "baz") | |
| 71 ;; | |
| 72 ;; (custom-add-loads 'foo 'custom-loads '("hmph" "baz" "quz")) | |
| 73 ;; (get 'foo 'custom-loads) | |
| 74 ;; => ("bar" "baz" "hmph" "qux") | |
| 75 | |
| 76 ;; Obviously, this allows correct incremental loading of custom-load | |
| 77 ;; files. This is not necessary under FSF (they simply use `put'), | |
| 78 ;; since they have only one file with custom dependencies. With the | |
| 79 ;; advent of packages, we cannot afford the same luxury. | |
| 1298 | 80 ;; |
| 81 ;; Feb 2003: Added code to speed up building by caching the values we've | |
| 82 ;; constructed, and using them instead of scanning a file when custom-load | |
| 83 ;; is up-to-date w.r.t. the file. Also use `message' not `princ' to print | |
| 84 ;; out messages so nl's are correctly inserted when necessary. --ben | |
| 428 | 85 |
| 86 | |
| 87 ;;; Code: | |
| 88 | |
| 89 (require 'cl) | |
| 90 (require 'widget) | |
| 91 (require 'cus-face) | |
| 92 | |
| 1244 | 93 ;; #### This and the autoloads file naming variables belong in a separate |
| 94 ;; file to be required here. | |
| 95 ;; #### Compare this with the autoloads handling. | |
| 428 | 96 ;; Don't change this, unless you plan to change the code in |
| 97 ;; cus-start.el, too. | |
| 98 (defconst cusload-base-file "custom-load.el") | |
| 1298 | 99 (defconst cusload-hash-table-marker ";old-cus-dep-hash: ") |
| 428 | 100 |
| 101 ;; Be very careful when changing this function. It looks easy to | |
| 102 ;; understand, but is in fact very easy to break. Be sure to read and | |
| 103 ;; understand the commentary above! | |
| 104 | |
| 442 | 105 (defun Custom-make-dependencies-1 (subdirs) |
| 428 | 106 (setq subdirs (mapcar #'expand-file-name subdirs)) |
| 107 (with-temp-buffer | |
| 108 (let ((enable-local-eval nil) | |
| 1298 | 109 (hash (make-hash-table :test 'eq)) |
| 110 (hash-cache (make-hash-table :test 'equal)) | |
| 111 old-hash) | |
| 428 | 112 (dolist (dir subdirs) |
| 1298 | 113 (message "Processing %s\n" dir) |
| 428 | 114 (let ((cusload-file (expand-file-name cusload-base-file dir)) |
| 115 (files (directory-files dir t "\\`[^=].*\\.el\\'"))) | |
| 116 ;; A trivial optimization: if no file in the directory is | |
| 117 ;; newer than custom-load.el, no need to do anything! | |
| 118 (if (and (file-exists-p cusload-file) | |
| 119 (dolist (file files t) | |
| 120 (when (file-newer-than-file-p file cusload-file) | |
| 121 (return nil)))) | |
| 1298 | 122 (message "(No changes need to be written)") |
| 123 (when (file-exists-p cusload-file) | |
| 124 (let ((buf (find-file-noselect cusload-file))) | |
| 125 (with-current-buffer buf | |
| 126 (goto-char (point-min)) | |
| 127 (when (search-forward cusload-hash-table-marker nil t) | |
| 128 (setq old-hash (read buf)))) | |
| 129 (kill-buffer buf))) | |
| 428 | 130 ;; Process directory |
| 131 (dolist (file files) | |
| 1298 | 132 (let ((old-cache (if (hash-table-p old-hash) |
| 133 (gethash file old-hash t) | |
| 134 t))) | |
| 135 (if (and (not (file-newer-than-file-p file cusload-file)) | |
| 136 (not (eq old-cache t))) | |
| 137 (progn | |
| 138 (dolist (c old-cache) | |
| 139 (puthash (car c) (cdr c) hash)) | |
| 140 (puthash file old-cache hash-cache)) | |
| 141 (erase-buffer) | |
| 142 (insert-file-contents file) | |
| 143 (goto-char (point-min)) | |
| 144 (let ((name (file-name-sans-extension | |
| 145 (file-name-nondirectory file))) | |
| 146 cache | |
| 147 (first t)) | |
| 148 ;; Search for defcustom/defface/defgroup | |
| 149 ;; expressions, and evaluate them. | |
| 150 (while (re-search-forward | |
| 151 "^(defcustom\\|^(defface\\|^(defgroup" | |
| 152 nil t) | |
| 153 (when first | |
| 154 (message "Computing custom-loads for %s..." name) | |
| 155 (setq first nil)) | |
| 156 (beginning-of-line) | |
| 157 (let ((expr (read (current-buffer)))) | |
| 158 ;; We need to ignore errors here, so that | |
| 159 ;; defcustoms with :set don't bug out. Of | |
| 160 ;; course, their values will not be assigned in | |
| 161 ;; case of errors, but their `custom-group' | |
| 162 ;; properties will by that time be in place, and | |
| 163 ;; that's all we care about. | |
| 164 (ignore-errors | |
| 165 (eval expr)) | |
| 166 ;; Hash the file of the affected symbol. | |
| 167 (setf (gethash (nth 1 expr) hash) name) | |
| 168 ;; Remember the values computed. | |
| 169 (push (cons (nth 1 expr) name) cache))) | |
| 170 (or cache | |
| 171 (message "No custom-loads for %s" name)) | |
| 172 (puthash file cache hash-cache))) | |
| 173 )) | |
| 428 | 174 (cond |
| 175 ((zerop (hash-table-count hash)) | |
| 2544 | 176 (message "(No customization dependencies)") |
| 177 (write-region "" nil cusload-file)) | |
| 428 | 178 (t |
| 1298 | 179 (message "Generating %s...\n" cusload-base-file) |
| 428 | 180 (with-temp-file cusload-file |
| 181 (insert ";;; " cusload-base-file | |
| 182 " --- automatically extracted custom dependencies\n" | |
| 1298 | 183 "\n;;; Code:\n\n") |
| 184 (insert cusload-hash-table-marker) | |
| 185 (let ((print-readably t) | |
| 186 (standard-output (current-buffer))) | |
| 187 (princ hash-cache) | |
| 188 (terpri)) | |
| 189 (insert "(autoload 'custom-add-loads \"cus-load\")\n\n") | |
| 428 | 190 (mapatoms |
| 191 (lambda (sym) | |
| 192 (let ((members (get sym 'custom-group)) | |
| 193 item where found) | |
| 194 (when members | |
| 195 (while members | |
| 196 (setq item (car (car members)) | |
| 197 members (cdr members) | |
| 198 where (gethash item hash)) | |
| 199 (unless (or (null where) | |
| 200 (member where found)) | |
| 201 (if found | |
| 202 (insert " ") | |
| 203 (insert "(custom-add-loads '" | |
| 204 (prin1-to-string sym) " '(")) | |
| 205 (prin1 where (current-buffer)) | |
| 206 (push where found))) | |
| 207 (when found | |
| 208 (insert "))\n")))))) | |
| 209 (insert "\n;;; custom-load.el ends here\n")) | |
| 210 (clrhash hash))))))))) | |
| 211 | |
| 442 | 212 (defun Custom-make-one-dependency () |
| 213 "Extract custom dependencies from .el files in one dir, on the command line. | |
| 214 Like `Custom-make-dependencies' but snarfs only one command-line argument, | |
| 215 making it useful in a chain of batch commands in a single XEmacs invocation." | |
| 216 (let ((subdir (car command-line-args-left))) | |
| 217 (setq command-line-args-left (cdr command-line-args-left)) | |
| 218 (Custom-make-dependencies-1 (list subdir)))) | |
| 219 | |
| 220 ;;;###autoload | |
| 221 (defun Custom-make-dependencies (&optional subdirs) | |
| 222 "Extract custom dependencies from .el files in SUBDIRS. | |
| 223 SUBDIRS is a list of directories. If it is nil, the command-line | |
| 224 arguments are used. If it is a string, only that directory is | |
| 225 processed. This function is especially useful in batch mode. | |
| 226 | |
| 227 Batch usage: xemacs -batch -l cus-dep.el -f Custom-make-dependencies DIRS" | |
| 228 (interactive "DDirectory: ") | |
| 229 (and (stringp subdirs) | |
| 230 (setq subdirs (list subdirs))) | |
| 231 (or subdirs | |
| 232 ;; Usurp the command-line-args | |
| 233 (setq subdirs command-line-args-left | |
| 234 command-line-args-left nil)) | |
| 235 (Custom-make-dependencies-1 subdirs)) | |
| 236 | |
| 428 | 237 (provide 'cus-dep) |
| 238 | |
| 239 ;;; cus-dep.el ends here |