Mercurial > hg > xemacs-beta
annotate man/lispref/errors.texi @ 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 | 576fb035e263 |
| children |
| rev | line source |
|---|---|
| 428 | 1 @c -*-texinfo-*- |
| 2 @c This is part of the XEmacs Lisp Reference Manual. | |
| 444 | 3 @c Copyright (C) 1990, 1991, 1992, 1993 Free Software Foundation, Inc. |
| 428 | 4 @c See the file lispref.texi for copying conditions. |
| 5 @setfilename ../../info/errors.info | |
| 6 @node Standard Errors, Standard Buffer-Local Variables, Building XEmacs and Object Allocation, Top | |
| 7 @appendix Standard Errors | |
| 8 | |
| 9 Here is the complete list of the error symbols in standard Emacs, | |
| 10 grouped by concept. The list includes each symbol's message (on the | |
| 11 @code{error-message} property of the symbol) and a cross reference to a | |
| 12 description of how the error can occur. | |
| 13 | |
| 14 Each error symbol has an @code{error-conditions} property that is a | |
| 15 list of symbols. Normally this list includes the error symbol itself | |
| 16 and the symbol @code{error}. Occasionally it includes additional | |
| 17 symbols, which are intermediate classifications, narrower than | |
| 18 @code{error} but broader than a single error symbol. For example, all | |
| 19 the errors in accessing files have the condition @code{file-error}. | |
| 20 | |
| 21 As a special exception, the error symbol @code{quit} does not have the | |
| 22 condition @code{error}, because quitting is not considered an error. | |
| 23 | |
| 24 @xref{Errors}, for an explanation of how errors are generated and | |
| 25 handled. | |
| 26 | |
| 27 @table @code | |
| 28 @item @var{symbol} | |
| 29 @var{string}; @var{reference}. | |
| 30 | |
| 31 @item error | |
| 32 @code{"error"}@* | |
| 33 @xref{Errors}. | |
| 34 | |
| 35 @item quit | |
| 36 @code{"Quit"}@* | |
| 37 @xref{Quitting}. | |
| 38 | |
| 39 @item args-out-of-range | |
| 40 @code{"Args out of range"}@* | |
| 41 @xref{Sequences Arrays Vectors}. | |
| 42 | |
| 43 @item arith-error | |
| 44 @code{"Arithmetic error"}@* | |
| 45 See @code{/} and @code{%} in @ref{Numbers}. | |
| 46 | |
| 47 @item beginning-of-buffer | |
| 48 @code{"Beginning of buffer"}@* | |
| 49 @xref{Motion}. | |
| 50 | |
| 51 @item buffer-read-only | |
| 52 @code{"Buffer is read-only"}@* | |
| 53 @xref{Read Only Buffers}. | |
| 54 | |
| 55 @item cyclic-function-indirection | |
| 56 @code{"Symbol's chain of function indirections contains a loop"}@* | |
| 57 @xref{Function Indirection}. | |
| 58 | |
| 59 @c XEmacs feature | |
| 60 @item domain-error | |
| 61 @code{"Arithmetic domain error"}@* | |
| 62 | |
| 63 @item end-of-buffer | |
| 64 @code{"End of buffer"}@* | |
| 65 @xref{Motion}. | |
| 66 | |
| 67 @item end-of-file | |
| 68 @code{"End of file during parsing"}@* | |
| 69 This is not a @code{file-error}.@* | |
| 70 @xref{Input Functions}. | |
| 71 | |
| 72 @item file-error | |
| 73 This error and its subcategories do not have error-strings, because the | |
| 74 error message is constructed from the data items alone when the error | |
| 75 condition @code{file-error} is present.@* | |
| 76 @xref{Files}. | |
| 77 | |
| 444 | 78 @item file-locked |
| 428 | 79 This is a @code{file-error}.@* |
| 80 @xref{File Locks}. | |
| 81 | |
| 82 @item file-already-exists | |
| 83 This is a @code{file-error}.@* | |
| 84 @xref{Writing to Files}. | |
| 85 | |
| 86 @item file-supersession | |
| 87 This is a @code{file-error}.@* | |
| 88 @xref{Modification Time}. | |
| 89 | |
| 90 @item invalid-byte-code | |
| 91 @code{"Invalid byte code"}@* | |
| 92 @xref{Byte Compilation}. | |
| 93 | |
| 94 @item invalid-function | |
| 95 @code{"Invalid function"}@* | |
| 96 @xref{Classifying Lists}. | |
| 97 | |
| 98 @item invalid-read-syntax | |
| 99 @code{"Invalid read syntax"}@* | |
| 100 @xref{Input Functions}. | |
| 101 | |
| 102 @item invalid-regexp | |
| 103 @code{"Invalid regexp"}@* | |
| 104 @xref{Regular Expressions}. | |
| 105 | |
| 106 @c XEmacs feature | |
| 107 @item mark-inactive | |
| 108 @code{"The mark is not active now"}@* | |
| 109 | |
| 110 @item no-catch | |
| 111 @code{"No catch for tag"}@* | |
| 112 @xref{Catch and Throw}. | |
| 113 | |
| 114 @c XEmacs feature | |
| 115 @item overflow-error | |
| 116 @code{"Arithmetic overflow error"}@* | |
| 117 | |
| 118 @c XEmacs feature | |
| 119 @item protected-field | |
| 120 @code{"Attempt to modify a protected field"}@* | |
| 121 | |
| 122 @c XEmacs feature | |
| 123 @item range-error | |
| 124 @code{"Arithmetic range error"}@* | |
| 125 | |
| 126 @item search-failed | |
| 127 @code{"Search failed"}@* | |
| 128 @xref{Searching and Matching}. | |
| 129 | |
| 130 @item setting-constant | |
| 444 | 131 @code{"Attempt to set a constant symbol"}@* |
| 428 | 132 @xref{Constant Variables, , Variables that Never Change}. |
| 133 | |
| 134 @c XEmacs feature | |
| 135 @item singularity-error | |
| 136 @code{"Arithmetic singularity error"}@* | |
| 137 | |
| 138 @c XEmacs feature | |
| 139 @item tooltalk-error | |
| 140 @code{"ToolTalk error"}@* | |
| 141 @xref{ToolTalk Support}. | |
| 142 | |
| 143 @c XEmacs feature | |
| 144 @item undefined-keystroke-sequence | |
| 145 @code{"Undefined keystroke sequence"}@* | |
| 146 | |
| 147 @ignore FSF Emacs only | |
| 148 @item undefined-color | |
| 149 @code{"Undefined color"}@* | |
| 150 @xref{Color Names}. | |
| 151 @end ignore | |
| 152 | |
| 153 @item void-function | |
| 154 @code{"Symbol's function definition is void"}@* | |
| 155 @xref{Function Cells}. | |
| 156 | |
| 157 @item void-variable | |
| 158 @code{"Symbol's value as variable is void"}@* | |
| 159 @xref{Accessing Variables}. | |
| 160 | |
| 161 @item wrong-number-of-arguments | |
| 162 @code{"Wrong number of arguments"}@* | |
| 163 @xref{Classifying Lists}. | |
| 164 | |
| 165 @item wrong-type-argument | |
| 166 @code{"Wrong type argument"}@* | |
| 167 @xref{Type Predicates}. | |
| 168 @end table | |
| 169 | |
| 170 These error types, which are all classified as special cases of | |
| 171 @code{arith-error}, can occur on certain systems for invalid use of | |
| 172 mathematical functions. | |
| 173 | |
| 174 @table @code | |
| 175 @item domain-error | |
| 176 @code{"Arithmetic domain error"}@* | |
| 177 @xref{Math Functions}. | |
| 178 | |
| 179 @item overflow-error | |
| 180 @code{"Arithmetic overflow error"}@* | |
| 181 @xref{Math Functions}. | |
| 182 | |
| 183 @item range-error | |
| 184 @code{"Arithmetic range error"}@* | |
| 185 @xref{Math Functions}. | |
| 186 | |
| 187 @item singularity-error | |
| 188 @code{"Arithmetic singularity error"}@* | |
| 189 @xref{Math Functions}. | |
| 190 | |
| 191 @item underflow-error | |
| 192 @code{"Arithmetic underflow error"}@* | |
| 193 @xref{Math Functions}. | |
| 194 @end table |