Mercurial > hg > xemacs-beta
annotate src/extents-impl.h @ 5167:e374ea766cc1
clean up, rearrange allocation statistics code
-------------------- ChangeLog entries follow: --------------------
src/ChangeLog addition:
2010-03-21 Ben Wing <ben@xemacs.org>
* alloc.c:
* alloc.c (assert_proper_sizing):
* alloc.c (c_readonly):
* alloc.c (malloced_storage_size):
* alloc.c (fixed_type_block_overhead):
* alloc.c (lisp_object_storage_size):
* alloc.c (inc_lrecord_stats):
* alloc.c (dec_lrecord_stats):
* alloc.c (pluralize_word):
* alloc.c (object_memory_usage_stats):
* alloc.c (Fobject_memory_usage):
* alloc.c (compute_memusage_stats_length):
* alloc.c (disksave_object_finalization_1):
* alloc.c (Fgarbage_collect):
* mc-alloc.c:
* mc-alloc.c (mc_alloced_storage_size):
* mc-alloc.h:
No functionality change here. Collect the allocations-statistics
code that was scattered throughout alloc.c into one place. Add
remaining section headings so that all sections have headings
clearly identifying the start of the section and its purpose.
Expose mc_alloced_storage_size() even when not MEMORY_USAGE_STATS;
this fixes build problems and is related to the export of
lisp_object_storage_size() and malloced_storage_size() when
non-MEMORY_USAGE_STATS in the previous change set.
author | Ben Wing <ben@xemacs.org> |
---|---|
date | Sun, 21 Mar 2010 04:41:49 -0500 |
parents | a9c41067dd88 |
children | 308d34e9f07d |
rev | line source |
---|---|
872 | 1 /* Copyright (c) 1994, 1995 Free Software Foundation. |
5127
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
2 Copyright (c) 1995, 1996, 2002, 2010 Ben Wing. |
872 | 3 |
4 This file is part of XEmacs. | |
5 | |
6 XEmacs is free software; you can redistribute it and/or modify it | |
7 under the terms of the GNU General Public License as published by the | |
8 Free Software Foundation; either version 2, or (at your option) any | |
9 later version. | |
10 | |
11 XEmacs is distributed in the hope that it will be useful, but WITHOUT | |
12 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
13 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
14 for more details. | |
15 | |
16 You should have received a copy of the GNU General Public License | |
17 along with XEmacs; see the file COPYING. If not, write to | |
18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
19 Boston, MA 02111-1307, USA. */ | |
20 | |
21 /* Synched up with: Not in FSF. */ | |
22 | |
23 #ifndef INCLUDED_extents_impl_h_ | |
24 #define INCLUDED_extents_impl_h_ | |
25 | |
26 #include "extents.h" | |
27 | |
28 struct extent | |
29 { | |
5120
d1247f3cc363
latest work on lisp-object workspace;
Ben Wing <ben@xemacs.org>
parents:
3017
diff
changeset
|
30 FROB_BLOCK_LISP_OBJECT_HEADER lheader; |
872 | 31 |
32 Memxpos start; | |
33 Memxpos end; | |
34 Lisp_Object object; /* A buffer, string, Qnil (extent detached from no | |
35 buffer), Qt (destroyed extent) */ | |
36 | |
37 /* Extent properties are conceptually a plist, but the most common | |
38 props are implemented as bits instead of conses. */ | |
39 struct | |
40 { | |
41 Lisp_Object face; | |
42 | |
43 /* These flags are simply an optimization for common boolean properties | |
44 which go onto the extent's property list. Any of them would work if | |
45 done in the normal way, but the space savings of doing these in this | |
46 way is significant. Note that if you add a flag, there are numerous | |
47 places in extents.c that need to know about it. | |
48 | |
49 Another consideration is that some of these properties are accessed | |
50 during redisplay, so it's good for access to them to be fast (a bit | |
51 reference instead of a search down a plist). | |
52 | |
53 `begin_glyph_layout' and `end_glyph_layout' are unusual in that | |
54 they have 4 states instead of 2. | |
55 | |
56 Other special extent properties are stored in an auxiliary | |
57 structure that sits at the beginning of the plist. The has_aux | |
58 flag indicates whether this structure exists. The has_parent | |
59 flag is an optimization indicating whether the extent has a parent | |
60 (this could also be determined by looking in the aux structure). */ | |
61 | |
62 enum_field (glyph_layout) begin_glyph_layout :2; | |
63 /* 2 text, margins, or whitespace */ | |
64 enum_field (glyph_layout) end_glyph_layout :2; | |
65 /* 4 text, margins, or whitespace */ | |
66 unsigned int has_parent :1; /* 5 extent has a parent */ | |
67 unsigned int has_aux :1; /* 6 extent has an aux. structure */ | |
68 unsigned int start_open :1; /* 7 insertion behavior at start */ | |
69 unsigned int end_open :1; /* 8 insertion behavior at end */ | |
70 unsigned int unique :1; /* 9 there may be only one attached */ | |
71 unsigned int duplicable :1; /* 10 copied to strings by kill/undo */ | |
72 unsigned int detachable :1; /* 11 extent detaches if text deleted */ | |
73 unsigned int internal :1; /* 12 used by map-extents etc. */ | |
74 unsigned int in_red_event :1; /* 13 An event has been spawned for | |
75 initial redisplay. | |
76 (not exported to lisp) */ | |
77 unsigned int unused16 :1; /* 16 unused bits */ | |
78 /* --- Adding more flags will cause the extent struct to grow by another | |
79 word. It's not clear that this would make a difference, however, | |
80 because on 32-bit machines things tend to get allocated in chunks | |
81 of 4 bytes. */ | |
82 } flags; | |
83 /* The plist may have an auxiliary structure as its first element */ | |
84 Lisp_Object plist; | |
85 }; | |
86 | |
87 /* Basic properties of an extent (not affected by the extent's parent) */ | |
88 #define extent_object(e) ((e)->object) | |
89 #define extent_start(e) ((e)->start + 0) | |
90 #define extent_end(e) ((e)->end + 0) | |
91 #define set_extent_start(e, val) ((void) ((e)->start = (val))) | |
92 #define set_extent_end(e, val) ((void) ((e)->end = (val))) | |
93 #define extent_endpoint(e, endp) ((endp) ? extent_end (e) : extent_start (e)) | |
94 #define set_extent_endpoint(e, val, endp) \ | |
95 ((endp) ? set_extent_end (e, val) : set_extent_start (e, val)) | |
96 #define extent_detached_p(e) (extent_start (e) < 0) | |
97 | |
98 /* Additional information that may be present in an extent. The idea is | |
99 that fast access is provided to this information, but since (hopefully) | |
100 most extents won't have this set on them, we usually don't need to | |
101 have this structure around and thus the size of an extent is smaller. */ | |
102 | |
103 typedef struct extent_auxiliary extent_auxiliary; | |
5127
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
104 |
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
105 #define EXTENT_AUXILIARY_SLOTS \ |
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
106 SLOT (begin_glyph) \ |
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
107 SLOT (end_glyph) \ |
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
108 SLOT (parent) \ |
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
109 /* We use a weak list here. Originally I didn't do this and \ |
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
110 depended on having the extent's finalization method remove \ |
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
111 itself from its parent's children list. This runs into \ |
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
112 lots and lots of problems though because everything is in \ |
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
113 a really really bizarre state when an extent's finalization \ |
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
114 method is called (it happens in sweep_extents() by way of \ |
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
115 ADDITIONAL_FREE_extent()) and it's extremely difficult to \ |
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
116 avoid getting hosed by just-freed objects. */ \ |
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
117 SLOT (children) \ |
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
118 SLOT (invisible) \ |
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
119 SLOT (read_only) \ |
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
120 SLOT (mouse_face) \ |
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
121 SLOT (initial_redisplay_function) \ |
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
122 SLOT (before_change_functions) \ |
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
123 SLOT (after_change_functions) |
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
124 |
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
125 |
872 | 126 struct extent_auxiliary |
127 { | |
5127
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
128 NORMAL_LISP_OBJECT_HEADER header; |
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
129 #define SLOT(x) Lisp_Object x; |
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
130 EXTENT_AUXILIARY_SLOTS |
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
131 #undef SLOT |
872 | 132 int priority; |
133 }; | |
134 | |
5127
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
135 extern Lisp_Object Vextent_auxiliary_defaults; |
872 | 136 |
137 struct extent_info | |
138 { | |
5127
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
139 NORMAL_LISP_OBJECT_HEADER header; |
872 | 140 |
141 struct extent_list *extents; | |
142 struct stack_of_extents *soe; | |
143 }; | |
144 | |
145 /* A "normal" field is one that is stored in the `struct flags' structure | |
146 in an extent. an "aux" field is one that is stored in the extent's | |
147 auxiliary structure. | |
148 | |
149 The functions below that have `extent_no_chase' in their name operate | |
150 on an extent directly (ignoring its parent), and should normally | |
151 only be used on extents known not to have a parent. The other | |
152 versions chase down any parent links. */ | |
153 | |
154 #define extent_no_chase_normal_field(e, field) ((e)->flags.field) | |
155 | |
156 DECLARE_INLINE_HEADER ( | |
157 struct extent_auxiliary * | |
158 extent_aux_or_default (EXTENT e) | |
159 ) | |
160 { | |
161 return e->flags.has_aux ? | |
162 XEXTENT_AUXILIARY (XCAR (e->plist)) : | |
5127
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
163 XEXTENT_AUXILIARY (Vextent_auxiliary_defaults); |
872 | 164 } |
165 | |
166 #define extent_no_chase_aux_field(e, field) (extent_aux_or_default(e)->field) | |
167 | |
168 #define extent_normal_field(e, field) \ | |
169 extent_no_chase_normal_field (extent_ancestor (e), field) | |
170 | |
171 #define extent_aux_field(e, field) \ | |
172 extent_no_chase_aux_field (extent_ancestor (e), field) | |
173 | |
174 #define set_extent_no_chase_aux_field(e, field, value) do { \ | |
175 EXTENT sencaf_e = (e); \ | |
176 if (! sencaf_e->flags.has_aux) \ | |
5127
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
177 attach_extent_auxiliary (sencaf_e); \ |
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
178 XEXTENT_AUXILIARY (XCAR (sencaf_e->plist))->field = (value); \ |
872 | 179 } while (0) |
180 | |
181 #define set_extent_no_chase_normal_field(e, field, value) \ | |
182 extent_no_chase_normal_field (e, field) = (value) | |
183 | |
184 #define set_extent_aux_field(e, field, value) \ | |
185 set_extent_no_chase_aux_field (extent_ancestor (e), field, value) | |
186 | |
187 #define set_extent_normal_field(e, field, value) \ | |
188 set_extent_no_chase_normal_field (extent_ancestor (e), field, value) | |
189 | |
190 /* The `parent' and `children' fields are not affected by any | |
191 parent links. We don't provide any settors for these fields | |
192 because they need special handling and it's cleaner just to | |
193 do this in the particular functions that need to do this. */ | |
194 | |
195 #define extent_parent(e) extent_no_chase_aux_field (e, parent) | |
196 #define extent_children(e) extent_no_chase_aux_field (e, children) | |
197 | |
198 EXTENT extent_ancestor_1 (EXTENT e); | |
199 | |
200 /* extent_ancestor() chases all the parent links until there aren't any | |
201 more. extent_ancestor_1() does the same thing but it a function; | |
202 the following optimizes the most common case. */ | |
203 DECLARE_INLINE_HEADER ( | |
204 EXTENT | |
205 extent_ancestor (EXTENT e) | |
206 ) | |
207 { | |
208 return e->flags.has_parent ? extent_ancestor_1 (e) : e; | |
209 } | |
210 | |
211 #define extent_begin_glyph(e) extent_aux_field (e, begin_glyph) | |
212 #define extent_end_glyph(e) extent_aux_field (e, end_glyph) | |
213 #define extent_priority(e) extent_aux_field (e, priority) | |
214 #define extent_invisible(e) extent_aux_field (e, invisible) | |
215 #define extent_read_only(e) extent_aux_field (e, read_only) | |
216 #define extent_mouse_face(e) extent_aux_field (e, mouse_face) | |
217 #define extent_initial_redisplay_function(e) extent_aux_field (e, initial_redisplay_function) | |
218 #define extent_before_change_functions(e) extent_aux_field (e, before_change_functions) | |
219 #define extent_after_change_functions(e) extent_aux_field (e, after_change_functions) | |
220 | |
221 #define set_extent_begin_glyph(e, value) \ | |
222 set_extent_aux_field (e, begin_glyph, value) | |
223 #define set_extent_end_glyph(e, value) \ | |
224 set_extent_aux_field (e, end_glyph, value) | |
225 #define set_extent_priority(e, value) \ | |
226 set_extent_aux_field (e, priority, value) | |
227 #define set_extent_invisible_1(e, value) \ | |
228 set_extent_aux_field (e, invisible, value) | |
229 #define set_extent_read_only(e, value) \ | |
230 set_extent_aux_field (e, read_only, value) | |
231 #define set_extent_mouse_face(e, value) \ | |
232 set_extent_aux_field (e, mouse_face, value) | |
233 /* Use Fset_extent_initial_redisplay_function unless you know what you're doing */ | |
234 #define set_extent_initial_redisplay_function(e, value) \ | |
235 set_extent_aux_field (e, initial_redisplay_function, value) | |
236 #define set_extent_before_change_functions(e, value) \ | |
237 set_extent_aux_field (e, before_change_functions, value) | |
238 #define set_extent_after_change_functions(e, value) \ | |
239 set_extent_aux_field (e, after_change_functions, value) | |
240 | |
241 #define extent_face(e) extent_normal_field (e, face) | |
242 #define extent_begin_glyph_layout(e) ((enum glyph_layout) extent_normal_field (e, begin_glyph_layout)) | |
243 #define extent_end_glyph_layout(e) ((enum glyph_layout) extent_normal_field (e, end_glyph_layout)) | |
244 #define extent_start_open_p(e) extent_normal_field (e, start_open) | |
245 #define extent_end_open_p(e) extent_normal_field (e, end_open) | |
246 #define extent_unique_p(e) extent_normal_field (e, unique) | |
247 #define extent_duplicable_p(e) extent_normal_field (e, duplicable) | |
248 #define extent_detachable_p(e) extent_normal_field (e, detachable) | |
249 #define extent_internal_p(e) extent_normal_field (e, internal) | |
250 #define extent_in_red_event_p(e) extent_normal_field (e, in_red_event) | |
251 | |
252 #define set_extent_face(e, val) \ | |
253 set_extent_normal_field (e, face, val) | |
254 #define set_extent_begin_glyph_layout(e, val) \ | |
255 set_extent_normal_field (e, begin_glyph_layout, val) | |
256 #define set_extent_end_glyph_layout(e, val) \ | |
257 set_extent_normal_field (e, end_glyph_layout, val) | |
258 #define set_extent_start_open_p(e, val) \ | |
259 set_extent_normal_field (e, start_open, val) | |
260 #define set_extent_end_open_p(e, val) \ | |
261 set_extent_normal_field (e, end_open, val) | |
262 #define set_extent_unique_p(e, val) \ | |
263 set_extent_normal_field (e, unique, val) | |
264 #define set_extent_duplicable_p(e, val) \ | |
265 set_extent_normal_field (e, duplicable, val) | |
266 #define set_extent_detachable_p(e, val) \ | |
267 set_extent_normal_field (e, detachable, val) | |
268 #define set_extent_internal_p(e, val) \ | |
269 set_extent_normal_field (e, internal, val) | |
270 #define set_extent_in_red_event_p(e, val) \ | |
271 set_extent_normal_field (e, in_red_event, val) | |
272 | |
273 DECLARE_INLINE_HEADER ( | |
274 Lisp_Object * | |
275 extent_no_chase_plist_addr (EXTENT e) | |
276 ) | |
277 { | |
278 return e->flags.has_aux ? &XCDR (e->plist) : &e->plist; | |
279 } | |
280 | |
281 #define extent_no_chase_plist(e) (*extent_no_chase_plist_addr (e)) | |
282 | |
283 #define extent_plist_addr(e) extent_no_chase_plist_addr (extent_ancestor (e)) | |
284 #define extent_plist_slot(e) extent_no_chase_plist (extent_ancestor (e)) | |
285 | |
286 | |
287 #define EXTENT_LIVE_P(e) (!EQ (extent_object (e), Qt)) | |
288 | |
289 #define CHECK_LIVE_EXTENT(x) do { \ | |
290 CHECK_EXTENT (x); \ | |
291 if (!EXTENT_LIVE_P (XEXTENT (x))) \ | |
292 dead_wrong_type_argument (Qextent_live_p, (x)); \ | |
293 } while (0) | |
294 #define CONCHECK_LIVE_EXTENT(x) do { \ | |
295 CONCHECK_EXTENT (x); \ | |
296 if (!EXTENT_LIVE_P (XEXTENT (x))) \ | |
297 x = wrong_type_argument (Qextent_live_p, (x)); \ | |
298 } while (0) | |
299 | |
300 #endif /* INCLUDED_extents_impl_h_ */ |