|
428
|
1 /* The "lrecord" structure (header of a compound lisp object).
|
|
|
2 Copyright (C) 1993, 1994, 1995 Free Software Foundation, Inc.
|
|
2367
|
3 Copyright (C) 1996, 2001, 2002, 2004 Ben Wing.
|
|
428
|
4
|
|
|
5 This file is part of XEmacs.
|
|
|
6
|
|
|
7 XEmacs is free software; you can redistribute it and/or modify it
|
|
|
8 under the terms of the GNU General Public License as published by the
|
|
|
9 Free Software Foundation; either version 2, or (at your option) any
|
|
|
10 later version.
|
|
|
11
|
|
|
12 XEmacs is distributed in the hope that it will be useful, but WITHOUT
|
|
|
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
|
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
|
|
15 for more details.
|
|
|
16
|
|
|
17 You should have received a copy of the GNU General Public License
|
|
|
18 along with XEmacs; see the file COPYING. If not, write to
|
|
|
19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
|
|
|
20 Boston, MA 02111-1307, USA. */
|
|
|
21
|
|
|
22 /* Synched up with: Not in FSF. */
|
|
|
23
|
|
2367
|
24 /* This file has been Mule-ized, Ben Wing, 10-13-04. */
|
|
|
25
|
|
440
|
26 #ifndef INCLUDED_lrecord_h_
|
|
|
27 #define INCLUDED_lrecord_h_
|
|
428
|
28
|
|
|
29 /* The "lrecord" type of Lisp object is used for all object types
|
|
|
30 other than a few simple ones. This allows many types to be
|
|
442
|
31 implemented but only a few bits required in a Lisp object for type
|
|
|
32 information. (The tradeoff is that each object has its type marked
|
|
|
33 in it, thereby increasing its size.) All lrecords begin with a
|
|
|
34 `struct lrecord_header', which identifies the lisp object type, by
|
|
|
35 providing an index into a table of `struct lrecord_implementation',
|
|
|
36 which describes the behavior of the lisp object. It also contains
|
|
|
37 some other data bits.
|
|
428
|
38
|
|
|
39 Lrecords are of two types: straight lrecords, and lcrecords.
|
|
|
40 Straight lrecords are used for those types of objects that have
|
|
|
41 their own allocation routines (typically allocated out of 2K chunks
|
|
|
42 of memory called `frob blocks'). These objects have a `struct
|
|
|
43 lrecord_header' at the top, containing only the bits needed to find
|
|
|
44 the lrecord_implementation for the object. There are special
|
|
1204
|
45 routines in alloc.c to create an object of each such type.
|
|
428
|
46
|
|
442
|
47 Lcrecords are used for less common sorts of objects that don't do
|
|
|
48 their own allocation. Each such object is malloc()ed individually,
|
|
|
49 and the objects are chained together through a `next' pointer.
|
|
|
50 Lcrecords have a `struct lcrecord_header' at the top, which
|
|
|
51 contains a `struct lrecord_header' and a `next' pointer, and are
|
|
1204
|
52 allocated using alloc_lcrecord_type() or its variants.
|
|
428
|
53
|
|
|
54 Creating a new lcrecord type is fairly easy; just follow the
|
|
|
55 lead of some existing type (e.g. hash tables). Note that you
|
|
|
56 do not need to supply all the methods (see below); reasonable
|
|
|
57 defaults are provided for many of them. Alternatively, if you're
|
|
|
58 just looking for a way of encapsulating data (which possibly
|
|
|
59 could contain Lisp_Objects in it), you may well be able to use
|
|
1204
|
60 the opaque type. --ben
|
|
|
61 */
|
|
428
|
62
|
|
1743
|
63 BEGIN_C_DECLS
|
|
1650
|
64
|
|
428
|
65 struct lrecord_header
|
|
|
66 {
|
|
1204
|
67 /* Index into lrecord_implementations_table[]. Objects that have been
|
|
|
68 explicitly freed using e.g. free_cons() have lrecord_type_free in this
|
|
|
69 field. */
|
|
442
|
70 unsigned int type :8;
|
|
|
71
|
|
|
72 /* If `mark' is 0 after the GC mark phase, the object will be freed
|
|
|
73 during the GC sweep phase. There are 2 ways that `mark' can be 1:
|
|
|
74 - by being referenced from other objects during the GC mark phase
|
|
|
75 - because it is permanently on, for c_readonly objects */
|
|
|
76 unsigned int mark :1;
|
|
|
77
|
|
|
78 /* 1 if the object resides in logically read-only space, and does not
|
|
|
79 reference other non-c_readonly objects.
|
|
|
80 Invariant: if (c_readonly == 1), then (mark == 1 && lisp_readonly == 1) */
|
|
|
81 unsigned int c_readonly :1;
|
|
|
82
|
|
428
|
83 /* 1 if the object is readonly from lisp */
|
|
442
|
84 unsigned int lisp_readonly :1;
|
|
771
|
85
|
|
|
86 unsigned int unused :21;
|
|
934
|
87
|
|
428
|
88 };
|
|
|
89
|
|
|
90 struct lrecord_implementation;
|
|
442
|
91 int lrecord_type_index (const struct lrecord_implementation *implementation);
|
|
428
|
92
|
|
430
|
93 #define set_lheader_implementation(header,imp) do { \
|
|
428
|
94 struct lrecord_header* SLI_header = (header); \
|
|
442
|
95 SLI_header->type = (imp)->lrecord_type_index; \
|
|
430
|
96 SLI_header->mark = 0; \
|
|
|
97 SLI_header->c_readonly = 0; \
|
|
|
98 SLI_header->lisp_readonly = 0; \
|
|
428
|
99 } while (0)
|
|
|
100
|
|
|
101 struct lcrecord_header
|
|
|
102 {
|
|
|
103 struct lrecord_header lheader;
|
|
|
104
|
|
442
|
105 /* The `next' field is normally used to chain all lcrecords together
|
|
428
|
106 so that the GC can find (and free) all of them.
|
|
1204
|
107 `basic_alloc_lcrecord' threads lcrecords together.
|
|
428
|
108
|
|
|
109 The `next' field may be used for other purposes as long as some
|
|
|
110 other mechanism is provided for letting the GC do its work.
|
|
|
111
|
|
|
112 For example, the event and marker object types allocate members
|
|
|
113 out of memory chunks, and are able to find all unmarked members
|
|
|
114 by sweeping through the elements of the list of chunks. */
|
|
|
115 struct lcrecord_header *next;
|
|
|
116
|
|
|
117 /* The `uid' field is just for debugging/printing convenience.
|
|
|
118 Having this slot doesn't hurt us much spacewise, since an
|
|
|
119 lcrecord already has the above slots plus malloc overhead. */
|
|
|
120 unsigned int uid :31;
|
|
|
121
|
|
|
122 /* The `free' field is a flag that indicates whether this lcrecord
|
|
|
123 is on a "free list". Free lists are used to minimize the number
|
|
|
124 of calls to malloc() when we're repeatedly allocating and freeing
|
|
|
125 a number of the same sort of lcrecord. Lcrecords on a free list
|
|
|
126 always get marked in a different fashion, so we can use this flag
|
|
|
127 as a sanity check to make sure that free lists only have freed
|
|
|
128 lcrecords and there are no freed lcrecords elsewhere. */
|
|
|
129 unsigned int free :1;
|
|
|
130 };
|
|
|
131
|
|
|
132 /* Used for lcrecords in an lcrecord-list. */
|
|
|
133 struct free_lcrecord_header
|
|
|
134 {
|
|
|
135 struct lcrecord_header lcheader;
|
|
|
136 Lisp_Object chain;
|
|
|
137 };
|
|
|
138
|
|
442
|
139 enum lrecord_type
|
|
|
140 {
|
|
|
141 /* Symbol value magic types come first to make SYMBOL_VALUE_MAGIC_P fast.
|
|
|
142 #### This should be replaced by a symbol_value_magic_p flag
|
|
|
143 in the Lisp_Symbol lrecord_header. */
|
|
1204
|
144 lrecord_type_symbol_value_forward, /* 0 */
|
|
|
145 lrecord_type_symbol_value_varalias, /* 1 */
|
|
|
146 lrecord_type_symbol_value_lisp_magic, /* 2 */
|
|
|
147 lrecord_type_symbol_value_buffer_local, /* 3 */
|
|
442
|
148 lrecord_type_max_symbol_value_magic = lrecord_type_symbol_value_buffer_local,
|
|
|
149
|
|
1204
|
150 lrecord_type_symbol, /* 4 */
|
|
|
151 lrecord_type_subr, /* 5 */
|
|
|
152 lrecord_type_cons, /* 6 */
|
|
442
|
153 lrecord_type_vector,
|
|
|
154 lrecord_type_string,
|
|
|
155 lrecord_type_lcrecord_list,
|
|
|
156 lrecord_type_compiled_function,
|
|
|
157 lrecord_type_weak_list,
|
|
|
158 lrecord_type_bit_vector,
|
|
|
159 lrecord_type_float,
|
|
|
160 lrecord_type_hash_table,
|
|
|
161 lrecord_type_lstream,
|
|
|
162 lrecord_type_process,
|
|
|
163 lrecord_type_charset,
|
|
|
164 lrecord_type_coding_system,
|
|
|
165 lrecord_type_char_table,
|
|
|
166 lrecord_type_char_table_entry,
|
|
|
167 lrecord_type_range_table,
|
|
|
168 lrecord_type_opaque,
|
|
|
169 lrecord_type_opaque_ptr,
|
|
|
170 lrecord_type_buffer,
|
|
|
171 lrecord_type_extent,
|
|
|
172 lrecord_type_extent_info,
|
|
|
173 lrecord_type_extent_auxiliary,
|
|
|
174 lrecord_type_marker,
|
|
|
175 lrecord_type_event,
|
|
1204
|
176 #ifdef EVENT_DATA_AS_OBJECTS
|
|
934
|
177 lrecord_type_key_data,
|
|
|
178 lrecord_type_button_data,
|
|
|
179 lrecord_type_motion_data,
|
|
|
180 lrecord_type_process_data,
|
|
|
181 lrecord_type_timeout_data,
|
|
|
182 lrecord_type_eval_data,
|
|
|
183 lrecord_type_misc_user_data,
|
|
|
184 lrecord_type_magic_eval_data,
|
|
|
185 lrecord_type_magic_data,
|
|
1204
|
186 #endif /* EVENT_DATA_AS_OBJECTS */
|
|
442
|
187 lrecord_type_keymap,
|
|
|
188 lrecord_type_command_builder,
|
|
|
189 lrecord_type_timeout,
|
|
|
190 lrecord_type_specifier,
|
|
|
191 lrecord_type_console,
|
|
|
192 lrecord_type_device,
|
|
|
193 lrecord_type_frame,
|
|
|
194 lrecord_type_window,
|
|
617
|
195 lrecord_type_window_mirror,
|
|
442
|
196 lrecord_type_window_configuration,
|
|
|
197 lrecord_type_gui_item,
|
|
|
198 lrecord_type_popup_data,
|
|
|
199 lrecord_type_toolbar_button,
|
|
617
|
200 lrecord_type_scrollbar_instance,
|
|
442
|
201 lrecord_type_color_instance,
|
|
|
202 lrecord_type_font_instance,
|
|
|
203 lrecord_type_image_instance,
|
|
|
204 lrecord_type_glyph,
|
|
|
205 lrecord_type_face,
|
|
|
206 lrecord_type_database,
|
|
|
207 lrecord_type_tooltalk_message,
|
|
|
208 lrecord_type_tooltalk_pattern,
|
|
|
209 lrecord_type_ldap,
|
|
|
210 lrecord_type_pgconn,
|
|
|
211 lrecord_type_pgresult,
|
|
|
212 lrecord_type_devmode,
|
|
|
213 lrecord_type_mswindows_dialog_id,
|
|
446
|
214 lrecord_type_case_table,
|
|
462
|
215 lrecord_type_emacs_ffi,
|
|
|
216 lrecord_type_emacs_gtk_object,
|
|
|
217 lrecord_type_emacs_gtk_boxed,
|
|
858
|
218 lrecord_type_weak_box,
|
|
888
|
219 lrecord_type_ephemeron,
|
|
1983
|
220 lrecord_type_bignum,
|
|
|
221 lrecord_type_ratio,
|
|
|
222 lrecord_type_bigfloat,
|
|
454
|
223 lrecord_type_free, /* only used for "free" lrecords */
|
|
|
224 lrecord_type_undefined, /* only used for debugging */
|
|
442
|
225 lrecord_type_last_built_in_type /* must be last */
|
|
|
226 };
|
|
|
227
|
|
1632
|
228 extern MODULE_API int lrecord_type_count;
|
|
428
|
229
|
|
|
230 struct lrecord_implementation
|
|
|
231 {
|
|
2367
|
232 const Ascbyte *name;
|
|
442
|
233
|
|
934
|
234 /* information for the dumper: is the object dumpable and should it
|
|
|
235 be dumped. */
|
|
|
236 unsigned int dumpable :1;
|
|
|
237
|
|
442
|
238 /* `marker' is called at GC time, to make sure that all Lisp_Objects
|
|
428
|
239 pointed to by this object get properly marked. It should call
|
|
|
240 the mark_object function on all Lisp_Objects in the object. If
|
|
|
241 the return value is non-nil, it should be a Lisp_Object to be
|
|
|
242 marked (don't call the mark_object function explicitly on it,
|
|
|
243 because the GC routines will do this). Doing it this way reduces
|
|
|
244 recursion, so the object returned should preferably be the one
|
|
|
245 with the deepest level of Lisp_Object pointers. This function
|
|
1204
|
246 can be NULL, meaning no GC marking is necessary.
|
|
|
247
|
|
|
248 NOTE NOTE NOTE: This is not used by KKCC (which uses the data
|
|
|
249 description below instead), unless the data description is missing.
|
|
|
250 Yes, this currently means there is logic duplication. Eventually the
|
|
|
251 mark methods will be removed. */
|
|
428
|
252 Lisp_Object (*marker) (Lisp_Object);
|
|
442
|
253
|
|
|
254 /* `printer' converts the object to a printed representation.
|
|
|
255 This can be NULL; in this case default_object_printer() will be
|
|
|
256 used instead. */
|
|
428
|
257 void (*printer) (Lisp_Object, Lisp_Object printcharfun, int escapeflag);
|
|
442
|
258
|
|
|
259 /* `finalizer' is called at GC time when the object is about to
|
|
428
|
260 be freed, and at dump time (FOR_DISKSAVE will be non-zero in this
|
|
|
261 case). It should perform any necessary cleanup (e.g. freeing
|
|
442
|
262 malloc()ed memory). This can be NULL, meaning no special
|
|
428
|
263 finalization is necessary.
|
|
|
264
|
|
442
|
265 WARNING: remember that `finalizer' is called at dump time even
|
|
428
|
266 though the object is not being freed. */
|
|
|
267 void (*finalizer) (void *header, int for_disksave);
|
|
442
|
268
|
|
428
|
269 /* This can be NULL, meaning compare objects with EQ(). */
|
|
|
270 int (*equal) (Lisp_Object obj1, Lisp_Object obj2, int depth);
|
|
442
|
271
|
|
|
272 /* `hash' generates hash values for use with hash tables that have
|
|
|
273 `equal' as their test function. This can be NULL, meaning use
|
|
|
274 the Lisp_Object itself as the hash. But, you must still satisfy
|
|
|
275 the constraint that if two objects are `equal', then they *must*
|
|
|
276 hash to the same value in order for hash tables to work properly.
|
|
|
277 This means that `hash' can be NULL only if the `equal' method is
|
|
|
278 also NULL. */
|
|
428
|
279 unsigned long (*hash) (Lisp_Object, int);
|
|
|
280
|
|
1204
|
281 /* Data layout description for your object. See long comment below. */
|
|
|
282 const struct memory_description *description;
|
|
428
|
283
|
|
442
|
284 /* These functions allow any object type to have builtin property
|
|
|
285 lists that can be manipulated from the lisp level with
|
|
|
286 `get', `put', `remprop', and `object-plist'. */
|
|
428
|
287 Lisp_Object (*getprop) (Lisp_Object obj, Lisp_Object prop);
|
|
|
288 int (*putprop) (Lisp_Object obj, Lisp_Object prop, Lisp_Object val);
|
|
|
289 int (*remprop) (Lisp_Object obj, Lisp_Object prop);
|
|
|
290 Lisp_Object (*plist) (Lisp_Object obj);
|
|
|
291
|
|
442
|
292 /* Only one of `static_size' and `size_in_bytes_method' is non-0.
|
|
1204
|
293 If both are 0, this type is not instantiable by basic_alloc_lcrecord(). */
|
|
665
|
294 Bytecount static_size;
|
|
|
295 Bytecount (*size_in_bytes_method) (const void *header);
|
|
442
|
296
|
|
|
297 /* The (constant) index into lrecord_implementations_table */
|
|
|
298 enum lrecord_type lrecord_type_index;
|
|
|
299
|
|
428
|
300 /* A "basic" lrecord is any lrecord that's not an lcrecord, i.e.
|
|
|
301 one that does not have an lcrecord_header at the front and which
|
|
1204
|
302 is (usually) allocated in frob blocks. */
|
|
442
|
303 unsigned int basic_p :1;
|
|
428
|
304 };
|
|
|
305
|
|
617
|
306 /* All the built-in lisp object types are enumerated in `enum lrecord_type'.
|
|
442
|
307 Additional ones may be defined by a module (none yet). We leave some
|
|
|
308 room in `lrecord_implementations_table' for such new lisp object types. */
|
|
|
309 #define MODULE_DEFINABLE_TYPE_COUNT 32
|
|
|
310
|
|
1632
|
311 extern MODULE_API const struct lrecord_implementation *
|
|
|
312 lrecord_implementations_table[lrecord_type_last_built_in_type + MODULE_DEFINABLE_TYPE_COUNT];
|
|
428
|
313
|
|
|
314 #define XRECORD_LHEADER_IMPLEMENTATION(obj) \
|
|
442
|
315 LHEADER_IMPLEMENTATION (XRECORD_LHEADER (obj))
|
|
|
316 #define LHEADER_IMPLEMENTATION(lh) lrecord_implementations_table[(lh)->type]
|
|
428
|
317
|
|
|
318 extern int gc_in_progress;
|
|
|
319
|
|
442
|
320 #define MARKED_RECORD_P(obj) (XRECORD_LHEADER (obj)->mark)
|
|
428
|
321 #define MARKED_RECORD_HEADER_P(lheader) ((lheader)->mark)
|
|
|
322 #define MARK_RECORD_HEADER(lheader) ((void) ((lheader)->mark = 1))
|
|
|
323 #define UNMARK_RECORD_HEADER(lheader) ((void) ((lheader)->mark = 0))
|
|
|
324
|
|
|
325 #define C_READONLY_RECORD_HEADER_P(lheader) ((lheader)->c_readonly)
|
|
|
326 #define LISP_READONLY_RECORD_HEADER_P(lheader) ((lheader)->lisp_readonly)
|
|
442
|
327 #define SET_C_READONLY_RECORD_HEADER(lheader) do { \
|
|
|
328 struct lrecord_header *SCRRH_lheader = (lheader); \
|
|
|
329 SCRRH_lheader->c_readonly = 1; \
|
|
|
330 SCRRH_lheader->lisp_readonly = 1; \
|
|
|
331 SCRRH_lheader->mark = 1; \
|
|
|
332 } while (0)
|
|
428
|
333 #define SET_LISP_READONLY_RECORD_HEADER(lheader) \
|
|
|
334 ((void) ((lheader)->lisp_readonly = 1))
|
|
1676
|
335
|
|
|
336 #ifdef USE_KKCC
|
|
|
337 #define RECORD_DESCRIPTION(lheader) lrecord_memory_descriptions[(lheader)->type]
|
|
|
338 #else /* not USE_KKCC */
|
|
442
|
339 #define RECORD_MARKER(lheader) lrecord_markers[(lheader)->type]
|
|
1676
|
340 #endif /* not USE_KKCC */
|
|
428
|
341
|
|
934
|
342 #define RECORD_DUMPABLE(lheader) (lrecord_implementations_table[(lheader)->type])->dumpable
|
|
1204
|
343
|
|
|
344 /* Data description stuff
|
|
934
|
345
|
|
1204
|
346 Data layout descriptions describe blocks of memory (in particular, Lisp
|
|
|
347 objects and other objects on the heap, and global objects with pointers
|
|
|
348 to such heap objects), including their size and a list of the elements
|
|
|
349 that need relocating, marking or other special handling. They are
|
|
|
350 currently used in two places: by pdump [the new, portable dumper] and
|
|
|
351 KKCC [the new garbage collector]. The two subsystems use the
|
|
|
352 descriptions in different ways, and as a result some of the descriptions
|
|
|
353 are appropriate only for one or the other, when it is known that only
|
|
|
354 that subsystem will use the description. (This is particularly the case
|
|
|
355 with objects that can't be dumped, because pdump needs more info than
|
|
|
356 KKCC.) However, properly written descriptions are appropriate for both,
|
|
|
357 and you should strive to write your descriptions that way, since the
|
|
|
358 dumpable status of an object may change and new uses for the
|
|
|
359 descriptions may be created. (An example that comes to mind is a
|
|
|
360 facility for determining the memory usage of XEmacs data structures --
|
|
|
361 like `buffer-memory-usage', `window-memory-usage', etc. but more
|
|
|
362 general.)
|
|
|
363
|
|
|
364 More specifically:
|
|
428
|
365
|
|
1204
|
366 Pdump (the portable dumper) needs to write out all objects in heap
|
|
|
367 space, and later on (in another invocation of XEmacs) load them back
|
|
|
368 into the heap, relocating all pointers to the heap objects in the global
|
|
|
369 data space. ("Heap" means anything malloc()ed, including all Lisp
|
|
|
370 objects, and "global data" means anything declared globally or
|
|
|
371 `static'.) Pdump, then, needs to be told about the location of all
|
|
|
372 global pointers to heap objects, all the description of all such
|
|
|
373 objects, including their size and any pointers to other heap (aka
|
|
|
374 "relocatable") objects. (Pdump assumes that the heap may occur in
|
|
|
375 different places in different invocations -- therefore, it is not enough
|
|
|
376 simply to write out the entire heap and later reload it at the same
|
|
|
377 location -- but that global data is always in the same place, and hence
|
|
|
378 pointers to it do not need to be relocated. This assumption holds true
|
|
|
379 in general for modern operating systems, but would be broken, for
|
|
|
380 example, in a system without virtual memory, or when dealing with shared
|
|
|
381 libraries. Also, unlike unexec, pdump does not usually write out or
|
|
|
382 restore objects in the global data space, and thus they need to be
|
|
|
383 initialized every time XEmacs is loaded. This is the purpose of the
|
|
|
384 reinit_*() functions throughout XEmacs. [It's possible, however, to make
|
|
|
385 pdump restore global data. This must be done, of course, for heap
|
|
|
386 pointers, but is also done for other values that are not easy to
|
|
|
387 recompute -- in particular, values established by the Lisp code loaded
|
|
|
388 at dump time.]) Note that the data type `Lisp_Object' is basically just
|
|
|
389 a relocatable pointer disguised as a long, and in general pdump treats
|
|
|
390 the Lisp_Object values and pointers to Lisp objects (e.g. Lisp_Object
|
|
|
391 vs. `struct frame *') identically. (NOTE: This equivalence depends
|
|
|
392 crucially on the current "minimal tagbits" implementation of Lisp_Object
|
|
|
393 pointers.)
|
|
428
|
394
|
|
1204
|
395 Descriptions are used by pdump in three places: (a) descriptions of Lisp
|
|
|
396 objects, referenced in the DEFINE_*LRECORD_*IMPLEMENTATION*() call; (b)
|
|
|
397 descriptions of global objects to be dumped, registered by
|
|
|
398 dump_add_root_block(); (c) descriptions of global pointers to
|
|
2367
|
399 non-Lisp_Object heap objects, registered by dump_add_root_block_ptr().
|
|
1204
|
400 The descriptions need to tell pdump which elements of your structure are
|
|
|
401 Lisp_Objects or structure pointers, plus the descriptions in turn of the
|
|
|
402 non-Lisp_Object structures pointed to. If these structures are you own
|
|
|
403 private ones, you will have to write these recursive descriptions
|
|
|
404 yourself; otherwise, you are reusing a structure already in existence
|
|
|
405 elsewhere and there is probably already a description for it.
|
|
|
406
|
|
|
407 Pdump does not care about Lisp objects that cannot be dumped (the
|
|
|
408 dumpable flag to DEFINE_*LRECORD_*IMPLEMENTATION*() is 0).
|
|
|
409
|
|
|
410 KKCC also uses data layout descriptions, but differently. It cares
|
|
|
411 about all objects, dumpable or not, but specifically only wants to know
|
|
|
412 about Lisp_Objects in your object and in structures pointed to. Thus,
|
|
|
413 it doesn't care about things like pointers to structures ot other blocks
|
|
|
414 of memory with no Lisp Objects in them, which pdump would care a lot
|
|
|
415 about.
|
|
|
416
|
|
|
417 Technically, then, you could write your description differently
|
|
|
418 depending on whether your object is dumpable -- the full pdump
|
|
|
419 description if so, the abbreviated KKCC description if not. In fact,
|
|
|
420 some descriptions are written this way. This is dangerous, though,
|
|
|
421 because another use might come along for the data descriptions, that
|
|
|
422 doesn't care about the dumper flag and makes use of some of the stuff
|
|
|
423 normally omitted from the "abbreviated" description -- see above.
|
|
|
424
|
|
|
425 A memory_description is an array of values. (This is actually
|
|
771
|
426 misnamed, in that it does not just describe lrecords, but any
|
|
|
427 blocks of memory.) The first value of each line is a type, the
|
|
|
428 second the offset in the lrecord structure. The third and
|
|
|
429 following elements are parameters; their presence, type and number
|
|
|
430 is type-dependent.
|
|
|
431
|
|
1204
|
432 The description ends with an "XD_END" record.
|
|
771
|
433
|
|
|
434 The top-level description of an lrecord or lcrecord does not need
|
|
|
435 to describe every element, just the ones that need to be relocated,
|
|
|
436 since the size of the lrecord is known. (The same goes for nested
|
|
|
437 structures, whenever the structure size is given, rather than being
|
|
|
438 defaulted by specifying 0 for the size.)
|
|
|
439
|
|
1204
|
440 A sized_memory_description is a memory_description plus the size of the
|
|
|
441 block of memory. The size field in a sized_memory_description can be
|
|
|
442 given as zero, i.e. unspecified, meaning that the last element in the
|
|
|
443 structure is described in the description and the size of the block can
|
|
|
444 therefore be computed from it. (This is useful for stretchy arrays.)
|
|
|
445
|
|
|
446 memory_descriptions are used to describe lrecords (the size of the
|
|
|
447 lrecord is elsewhere in its description, attached to its methods, so it
|
|
|
448 does not need to be given here) and global objects, where the size is an
|
|
|
449 argument to the call to dump_add_root_block().
|
|
|
450 sized_memory_descriptions are used for pointers and arrays in
|
|
2367
|
451 memory_descriptions and for calls to dump_add_root_block_ptr(). (####
|
|
1204
|
452 It is not obvious why this is so in the latter case. Probably, calls to
|
|
2367
|
453 dump_add_root_block_ptr() should use plain memory_descriptions and have
|
|
1204
|
454 the size be an argument to the call.)
|
|
|
455
|
|
|
456 NOTE: Anywhere that a sized_memory_description occurs inside of a plain
|
|
|
457 memory_description, a "description map" can be substituted. Rather than
|
|
|
458 being an actual description, this describes how to find the description
|
|
|
459 by looking inside of the object being described. This is a convenient
|
|
|
460 way to describe Lisp objects with subtypes and corresponding
|
|
|
461 type-specific data.
|
|
428
|
462
|
|
|
463 Some example descriptions :
|
|
440
|
464
|
|
814
|
465 struct Lisp_String
|
|
|
466 {
|
|
|
467 struct lrecord_header lheader;
|
|
|
468 Bytecount size;
|
|
867
|
469 Ibyte *data;
|
|
814
|
470 Lisp_Object plist;
|
|
|
471 };
|
|
|
472
|
|
1204
|
473 static const struct memory_description cons_description[] = {
|
|
440
|
474 { XD_LISP_OBJECT, offsetof (Lisp_Cons, car) },
|
|
|
475 { XD_LISP_OBJECT, offsetof (Lisp_Cons, cdr) },
|
|
428
|
476 { XD_END }
|
|
|
477 };
|
|
|
478
|
|
440
|
479 Which means "two lisp objects starting at the 'car' and 'cdr' elements"
|
|
428
|
480
|
|
1204
|
481 static const struct memory_description string_description[] = {
|
|
814
|
482 { XD_BYTECOUNT, offsetof (Lisp_String, size) },
|
|
1204
|
483 { XD_OPAQUE_DATA_PTR, offsetof (Lisp_String, data), XD_INDIRECT (0, 1) },
|
|
814
|
484 { XD_LISP_OBJECT, offsetof (Lisp_String, plist) },
|
|
|
485 { XD_END }
|
|
|
486 };
|
|
|
487
|
|
|
488 "A pointer to string data at 'data', the size of the pointed array being
|
|
|
489 the value of the size variable plus 1, and one lisp object at 'plist'"
|
|
|
490
|
|
|
491 If your object has a pointer to an array of Lisp_Objects in it, something
|
|
|
492 like this:
|
|
|
493
|
|
|
494 struct Lisp_Foo
|
|
|
495 {
|
|
|
496 ...;
|
|
|
497 int count;
|
|
|
498 Lisp_Object *objects;
|
|
|
499 ...;
|
|
|
500 }
|
|
|
501
|
|
2367
|
502 You'd use XD_BLOCK_PTR, something like:
|
|
814
|
503
|
|
1204
|
504 static const struct memory_description foo_description[] = {
|
|
|
505 ...
|
|
|
506 { XD_INT, offsetof (Lisp_Foo, count) },
|
|
2367
|
507 { XD_BLOCK_PTR, offsetof (Lisp_Foo, objects),
|
|
1204
|
508 XD_INDIRECT (0, 0), &lisp_object_description },
|
|
|
509 ...
|
|
|
510 };
|
|
|
511
|
|
|
512 lisp_object_description is declared in alloc.c, like this:
|
|
|
513
|
|
|
514 static const struct memory_description lisp_object_description_1[] = {
|
|
814
|
515 { XD_LISP_OBJECT, 0 },
|
|
|
516 { XD_END }
|
|
|
517 };
|
|
|
518
|
|
1204
|
519 const struct sized_memory_description lisp_object_description = {
|
|
814
|
520 sizeof (Lisp_Object),
|
|
1204
|
521 lisp_object_description_1
|
|
814
|
522 };
|
|
|
523
|
|
2367
|
524 Another example of XD_BLOCK_PTR:
|
|
428
|
525
|
|
1204
|
526 typedef struct htentry
|
|
814
|
527 {
|
|
|
528 Lisp_Object key;
|
|
|
529 Lisp_Object value;
|
|
1204
|
530 } htentry;
|
|
814
|
531
|
|
|
532 struct Lisp_Hash_Table
|
|
|
533 {
|
|
|
534 struct lcrecord_header header;
|
|
|
535 Elemcount size;
|
|
|
536 Elemcount count;
|
|
|
537 Elemcount rehash_count;
|
|
|
538 double rehash_size;
|
|
|
539 double rehash_threshold;
|
|
|
540 Elemcount golden_ratio;
|
|
|
541 hash_table_hash_function_t hash_function;
|
|
|
542 hash_table_test_function_t test_function;
|
|
1204
|
543 htentry *hentries;
|
|
814
|
544 enum hash_table_weakness weakness;
|
|
|
545 Lisp_Object next_weak; // Used to chain together all of the weak
|
|
|
546 // hash tables. Don't mark through this.
|
|
|
547 };
|
|
|
548
|
|
1204
|
549 static const struct memory_description htentry_description_1[] = {
|
|
|
550 { XD_LISP_OBJECT, offsetof (htentry, key) },
|
|
|
551 { XD_LISP_OBJECT, offsetof (htentry, value) },
|
|
814
|
552 { XD_END }
|
|
|
553 };
|
|
|
554
|
|
1204
|
555 static const struct sized_memory_description htentry_description = {
|
|
|
556 sizeof (htentry),
|
|
|
557 htentry_description_1
|
|
814
|
558 };
|
|
|
559
|
|
1204
|
560 const struct memory_description hash_table_description[] = {
|
|
814
|
561 { XD_ELEMCOUNT, offsetof (Lisp_Hash_Table, size) },
|
|
2367
|
562 { XD_BLOCK_PTR, offsetof (Lisp_Hash_Table, hentries), XD_INDIRECT (0, 1),
|
|
1204
|
563 &htentry_description },
|
|
814
|
564 { XD_LO_LINK, offsetof (Lisp_Hash_Table, next_weak) },
|
|
|
565 { XD_END }
|
|
|
566 };
|
|
|
567
|
|
|
568 Note that we don't need to declare all the elements in the structure, just
|
|
|
569 the ones that need to be relocated (Lisp_Objects and structures) or that
|
|
|
570 need to be referenced as counts for relocated objects.
|
|
|
571
|
|
1204
|
572 A description map looks like this:
|
|
|
573
|
|
|
574 static const struct sized_memory_description specifier_extra_description_map [] = {
|
|
|
575 { offsetof (Lisp_Specifier, methods) },
|
|
|
576 { offsetof (struct specifier_methods, extra_description) },
|
|
|
577 { -1 }
|
|
|
578 };
|
|
|
579
|
|
|
580 const struct memory_description specifier_description[] = {
|
|
|
581 ...
|
|
2367
|
582 { XD_BLOCK_ARRAY, offset (Lisp_Specifier, data), 1,
|
|
1204
|
583 specifier_extra_description_map },
|
|
|
584 ...
|
|
|
585 { XD_END }
|
|
|
586 };
|
|
|
587
|
|
|
588 This would be appropriate for an object that looks like this:
|
|
|
589
|
|
|
590 struct specifier_methods
|
|
|
591 {
|
|
|
592 ...
|
|
|
593 const struct sized_memory_description *extra_description;
|
|
|
594 ...
|
|
|
595 };
|
|
|
596
|
|
|
597 struct Lisp_Specifier
|
|
|
598 {
|
|
|
599 struct lcrecord_header header;
|
|
|
600 struct specifier_methods *methods;
|
|
|
601
|
|
|
602 ...
|
|
|
603 // type-specific extra data attached to a specifier
|
|
|
604 max_align_t data[1];
|
|
|
605 };
|
|
|
606
|
|
|
607 The description map means "retrieve a pointer into the object at offset
|
|
|
608 `offsetof (Lisp_Specifier, methods)' , then in turn retrieve a pointer
|
|
|
609 into that object at offset `offsetof (struct specifier_methods,
|
|
|
610 extra_description)', and that is the sized_memory_description to use."
|
|
|
611 There can be any number of indirections, which can be either into
|
|
|
612 straight pointers or Lisp_Objects. The way that description maps are
|
|
|
613 distinguished from normal sized_memory_descriptions is that in the
|
|
|
614 former, the memory_description pointer is NULL.
|
|
|
615
|
|
|
616 --ben
|
|
|
617
|
|
814
|
618
|
|
|
619 The existing types :
|
|
|
620
|
|
|
621
|
|
428
|
622 XD_LISP_OBJECT
|
|
1204
|
623
|
|
|
624 A Lisp object. This is also the type to use for pointers to other lrecords
|
|
|
625 (e.g. struct frame *).
|
|
428
|
626
|
|
440
|
627 XD_LISP_OBJECT_ARRAY
|
|
1204
|
628
|
|
771
|
629 An array of Lisp objects or (equivalently) pointers to lrecords.
|
|
|
630 The parameter (i.e. third element) is the count. This would be declared
|
|
|
631 as Lisp_Object foo[666]. For something declared as Lisp_Object *foo,
|
|
2367
|
632 use XD_BLOCK_PTR, whose description parameter is a sized_memory_description
|
|
771
|
633 consisting of only XD_LISP_OBJECT and XD_END.
|
|
440
|
634
|
|
428
|
635 XD_LO_LINK
|
|
1204
|
636
|
|
771
|
637 Weak link in a linked list of objects of the same type. This is a
|
|
|
638 link that does NOT generate a GC reference. Thus the pdumper will
|
|
|
639 not automatically add the referenced object to the table of all
|
|
|
640 objects to be dumped, and when storing and loading the dumped data
|
|
|
641 will automatically prune unreferenced objects in the chain and link
|
|
|
642 each referenced object to the next referenced object, even if it's
|
|
|
643 many links away. We also need to special handling of a similar
|
|
|
644 nature for the root of the chain, which will be a staticpro()ed
|
|
|
645 object.
|
|
432
|
646
|
|
428
|
647 XD_OPAQUE_PTR
|
|
1204
|
648
|
|
428
|
649 Pointer to undumpable data. Must be NULL when dumping.
|
|
|
650
|
|
2367
|
651 XD_BLOCK_PTR
|
|
1204
|
652
|
|
771
|
653 Pointer to block of described memory. (This is misnamed: It is NOT
|
|
|
654 necessarily a pointer to a struct foo.) Parameters are number of
|
|
1204
|
655 contiguous blocks and sized_memory_description.
|
|
771
|
656
|
|
2367
|
657 XD_BLOCK_ARRAY
|
|
1204
|
658
|
|
771
|
659 Array of blocks of described memory. Parameters are number of
|
|
2367
|
660 structures and sized_memory_description. This differs from XD_BLOCK_PTR
|
|
771
|
661 in that the parameter is declared as struct foo[666] instead of
|
|
|
662 struct *foo. In other words, the block of memory holding the
|
|
|
663 structures is within the containing structure, rather than being
|
|
|
664 elsewhere, with a pointer in the containing structure.
|
|
428
|
665
|
|
1204
|
666 NOTE NOTE NOTE: Be sure that you understand the difference between
|
|
2367
|
667 XD_BLOCK_PTR and XD_BLOCK_ARRAY:
|
|
1204
|
668 - struct foo bar[666], i.e. 666 inline struct foos
|
|
2367
|
669 --> XD_BLOCK_ARRAY, argument 666, pointing to a description of
|
|
1204
|
670 struct foo
|
|
|
671 - struct foo *bar, i.e. pointer to a block of 666 struct foos
|
|
2367
|
672 --> XD_BLOCK_PTR, argument 666, pointing to a description of
|
|
1204
|
673 struct foo
|
|
|
674 - struct foo *bar[666], i.e. 666 pointers to separate blocks of struct foos
|
|
2367
|
675 --> XD_BLOCK_ARRAY, argument 666, pointing to a description of
|
|
1204
|
676 a single pointer to struct foo; the description is a single
|
|
2367
|
677 XD_BLOCK_PTR, argument 1, which in turn points to a description
|
|
1204
|
678 of struct foo.
|
|
|
679
|
|
2367
|
680 NOTE also that an XD_BLOCK_PTR of 666 foos is equivalent to an
|
|
|
681 XD_BLOCK_PTR of 1 bar, where the description of `bar' is an
|
|
|
682 XD_BLOCK_ARRAY of 666 foos.
|
|
|
683
|
|
428
|
684 XD_OPAQUE_DATA_PTR
|
|
1204
|
685
|
|
428
|
686 Pointer to dumpable opaque data. Parameter is the size of the data.
|
|
|
687 Pointed data must be relocatable without changes.
|
|
|
688
|
|
771
|
689 XD_UNION
|
|
1204
|
690
|
|
|
691 Union of two or more different types of data. Parameters are a constant
|
|
|
692 which determines which type the data is (this is usually an XD_INDIRECT,
|
|
|
693 referring to one of the fields in the structure), and a "sizing lobby" (a
|
|
|
694 sized_memory_description, which points to a memory_description and
|
|
|
695 indicates its size). The size field in the sizing lobby describes the
|
|
|
696 size of the union field in the object, and the memory_description in it
|
|
|
697 is referred to as a "union map" and has a special interpretation: The
|
|
|
698 offset field is replaced by a constant, which is compared to the first
|
|
|
699 parameter of the XD_UNION descriptor to determine if this description
|
|
|
700 applies to the union data, and XD_INDIRECT references refer to the
|
|
|
701 containing object and description. Note that the description applies
|
|
2367
|
702 "inline" to the union data, like XD_BLOCK_ARRAY and not XD_BLOCK_PTR.
|
|
1204
|
703 If the union data is a pointer to different types of structures, each
|
|
2367
|
704 element in the memory_description should be an XD_BLOCK_PTR. See
|
|
1204
|
705 unicode.c, redisplay.c and objects.c for examples of XD_UNION.
|
|
|
706
|
|
|
707 XD_UNION_DYNAMIC_SIZE
|
|
|
708
|
|
|
709 Same as XD_UNION except that this is used for objects where the size of
|
|
|
710 the object containing the union varies depending on the particular value
|
|
|
711 of the union constant. That is, an object with plain XD_UNION typically
|
|
|
712 has the union declared as `union foo' or as `void *', where an object
|
|
|
713 with XD_UNION_DYNAMIC_SIZE typically has the union as the last element,
|
|
2367
|
714 and declared as something like Rawbyte foo[1]. With plain XD_UNION, the
|
|
1204
|
715 object is (usually) of fixed size and always contains enough space for
|
|
|
716 the data associated with all possible union constants, and thus the union
|
|
|
717 constant can potentially change during the lifetime of the object. With
|
|
|
718 XD_UNION_DYNAMIC_SIZE, however, the union constant is fixed at the time
|
|
|
719 of creation of the object, and the size of the object is computed
|
|
|
720 dynamically at creation time based on the size of the data associated
|
|
|
721 with the union constant. Currently, the only difference between XD_UNION
|
|
|
722 and XD_UNION_DYNAMIC_SIZE is how the size of the union data is
|
|
|
723 calculated, when (a) the structure containing the union has no size
|
|
|
724 given; (b) the union occurs as the last element in the structure; and (c)
|
|
|
725 the union has no size given (in the first-level sized_memory_description
|
|
|
726 pointed to). In this circumstance, the size of XD_UNION comes from the
|
|
|
727 max size of the data associated with all possible union constants,
|
|
|
728 whereas the size of XD_UNION_DYNAMIC_SIZE comes from the size of the data
|
|
|
729 associated with the currently specified (and unchangeable) union
|
|
|
730 constant.
|
|
771
|
731
|
|
2367
|
732 XD_ASCII_STRING
|
|
1204
|
733
|
|
2367
|
734 Pointer to a C string, purely ASCII.
|
|
428
|
735
|
|
|
736 XD_DOC_STRING
|
|
1204
|
737
|
|
2367
|
738 Pointer to a doc string (C string in pure ASCII if positive,
|
|
|
739 opaque value if negative)
|
|
428
|
740
|
|
|
741 XD_INT_RESET
|
|
1204
|
742
|
|
428
|
743 An integer which will be reset to a given value in the dump file.
|
|
|
744
|
|
1204
|
745 XD_ELEMCOUNT
|
|
771
|
746
|
|
665
|
747 Elemcount value. Used for counts.
|
|
647
|
748
|
|
665
|
749 XD_BYTECOUNT
|
|
1204
|
750
|
|
665
|
751 Bytecount value. Used for counts.
|
|
647
|
752
|
|
665
|
753 XD_HASHCODE
|
|
1204
|
754
|
|
665
|
755 Hashcode value. Used for the results of hashing functions.
|
|
428
|
756
|
|
|
757 XD_INT
|
|
1204
|
758
|
|
428
|
759 int value. Used for counts.
|
|
|
760
|
|
|
761 XD_LONG
|
|
1204
|
762
|
|
428
|
763 long value. Used for counts.
|
|
|
764
|
|
771
|
765 XD_BYTECOUNT
|
|
1204
|
766
|
|
771
|
767 bytecount value. Used for counts.
|
|
|
768
|
|
428
|
769 XD_END
|
|
1204
|
770
|
|
428
|
771 Special type indicating the end of the array.
|
|
|
772
|
|
|
773
|
|
|
774 Special macros:
|
|
1204
|
775
|
|
|
776 XD_INDIRECT (line, delta)
|
|
|
777 Usable where a count, size, offset or union constant is requested. Gives
|
|
|
778 the value of the element which is at line number 'line' in the
|
|
|
779 description (count starts at zero) and adds delta to it, which must
|
|
|
780 (currently) be positive.
|
|
428
|
781 */
|
|
|
782
|
|
1204
|
783 enum memory_description_type
|
|
647
|
784 {
|
|
440
|
785 XD_LISP_OBJECT_ARRAY,
|
|
428
|
786 XD_LISP_OBJECT,
|
|
|
787 XD_LO_LINK,
|
|
|
788 XD_OPAQUE_PTR,
|
|
2367
|
789 XD_BLOCK_PTR,
|
|
|
790 XD_BLOCK_ARRAY,
|
|
428
|
791 XD_OPAQUE_DATA_PTR,
|
|
771
|
792 XD_UNION,
|
|
1204
|
793 XD_UNION_DYNAMIC_SIZE,
|
|
2367
|
794 XD_ASCII_STRING,
|
|
428
|
795 XD_DOC_STRING,
|
|
|
796 XD_INT_RESET,
|
|
665
|
797 XD_BYTECOUNT,
|
|
|
798 XD_ELEMCOUNT,
|
|
|
799 XD_HASHCODE,
|
|
428
|
800 XD_INT,
|
|
|
801 XD_LONG,
|
|
1204
|
802 XD_END
|
|
428
|
803 };
|
|
|
804
|
|
1204
|
805 enum data_description_entry_flags
|
|
647
|
806 {
|
|
1204
|
807 /* If set, KKCC does not process this entry.
|
|
|
808
|
|
|
809 (1) One obvious use is with things that pdump saves but which do not get
|
|
|
810 marked normally -- for example the next and prev fields in a marker. The
|
|
|
811 marker chain is weak, with its entries removed when they are finalized.
|
|
|
812
|
|
|
813 (2) This can be set on structures not containing any Lisp objects, or (more
|
|
|
814 usefully) on structures that contain Lisp objects but where the objects
|
|
|
815 always occur in another structure as well. For example, the extent lists
|
|
|
816 kept by a buffer keep the extents in two lists, one sorted by the start
|
|
|
817 of the extent and the other by the end. There's no point in marking
|
|
|
818 both, since each contains the same objects as the other; but when dumping
|
|
|
819 (if we were to dump such a structure), when computing memory size, etc.,
|
|
|
820 it's crucial to tag both sides.
|
|
|
821 */
|
|
|
822 XD_FLAG_NO_KKCC = 1,
|
|
|
823 /* If set, pdump does not process this entry. */
|
|
|
824 XD_FLAG_NO_PDUMP = 2,
|
|
|
825 /* Indicates that this is a "default" entry in a union map. */
|
|
|
826 XD_FLAG_UNION_DEFAULT_ENTRY = 4,
|
|
|
827 /* Indicates that this is a free Lisp object we're marking.
|
|
|
828 Only relevant for ERROR_CHECK_GC. This occurs when we're marking
|
|
|
829 lcrecord-lists, where the objects have had their type changed to
|
|
|
830 lrecord_type_free and also have had their free bit set, but we mark
|
|
|
831 them as normal. */
|
|
1429
|
832 XD_FLAG_FREE_LISP_OBJECT = 8
|
|
1204
|
833 #if 0
|
|
1429
|
834 ,
|
|
1204
|
835 /* Suggestions for other possible flags: */
|
|
|
836
|
|
|
837 /* Eliminate XD_UNION_DYNAMIC_SIZE and replace it with a flag, like this. */
|
|
|
838 XD_FLAG_UNION_DYNAMIC_SIZE = 16,
|
|
|
839 /* Require that everyone who uses a description map has to flag it, so
|
|
|
840 that it's easy to tell, when looking through the code, where the
|
|
|
841 description maps are and who's using them. This might also become
|
|
|
842 necessary if for some reason the format of the description map is
|
|
|
843 expanded and we need to stick a pointer in the second slot (although
|
|
|
844 we could still ensure that the second slot in the first entry was NULL
|
|
|
845 or <0). */
|
|
1429
|
846 XD_FLAG_DESCRIPTION_MAP = 32
|
|
1204
|
847 #endif
|
|
428
|
848 };
|
|
|
849
|
|
1204
|
850 struct memory_description
|
|
|
851 {
|
|
|
852 enum memory_description_type type;
|
|
|
853 Bytecount offset;
|
|
|
854 EMACS_INT data1;
|
|
|
855 const struct sized_memory_description *data2;
|
|
|
856 /* Indicates which subsystems process this entry, plus (potentially) other
|
|
|
857 flags that apply to this entry. */
|
|
|
858 int flags;
|
|
|
859 };
|
|
428
|
860
|
|
1204
|
861 struct sized_memory_description
|
|
|
862 {
|
|
|
863 Bytecount size;
|
|
|
864 const struct memory_description *description;
|
|
|
865 };
|
|
|
866
|
|
|
867 extern const struct sized_memory_description lisp_object_description;
|
|
|
868
|
|
|
869 #define XD_INDIRECT(val, delta) (-1 - (Bytecount) ((val) | ((delta) << 8)))
|
|
428
|
870
|
|
1204
|
871 #define XD_IS_INDIRECT(code) ((code) < 0)
|
|
|
872 #define XD_INDIRECT_VAL(code) ((-1 - (code)) & 255)
|
|
|
873 #define XD_INDIRECT_DELTA(code) ((-1 - (code)) >> 8)
|
|
|
874
|
|
|
875 #define XD_DYNARR_DESC(base_type, sub_desc) \
|
|
2367
|
876 { XD_BLOCK_PTR, offsetof (base_type, base), XD_INDIRECT(1, 0), sub_desc }, \
|
|
1204
|
877 { XD_INT, offsetof (base_type, cur) }, \
|
|
|
878 { XD_INT_RESET, offsetof (base_type, max), XD_INDIRECT(1, 0) } \
|
|
|
879
|
|
428
|
880
|
|
|
881 /* DEFINE_LRECORD_IMPLEMENTATION is for objects with constant size.
|
|
|
882 DEFINE_LRECORD_SEQUENCE_IMPLEMENTATION is for objects whose size varies.
|
|
|
883 */
|
|
|
884
|
|
800
|
885 #if defined (ERROR_CHECK_TYPES)
|
|
|
886 # define DECLARE_ERROR_CHECK_TYPES(c_name, structtype)
|
|
428
|
887 #else
|
|
800
|
888 # define DECLARE_ERROR_CHECK_TYPES(c_name, structtype)
|
|
428
|
889 #endif
|
|
|
890
|
|
934
|
891
|
|
|
892 #define DEFINE_BASIC_LRECORD_IMPLEMENTATION(name,c_name,dumpable,marker,printer,nuker,equal,hash,desc,structtype) \
|
|
|
893 DEFINE_BASIC_LRECORD_IMPLEMENTATION_WITH_PROPS(name,c_name,dumpable,marker,printer,nuker,equal,hash,desc,0,0,0,0,structtype)
|
|
|
894
|
|
|
895 #define DEFINE_BASIC_LRECORD_IMPLEMENTATION_WITH_PROPS(name,c_name,dumpable,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,structtype) \
|
|
|
896 MAKE_LRECORD_IMPLEMENTATION(name,c_name,dumpable,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,sizeof(structtype),0,1,structtype)
|
|
|
897
|
|
|
898 #define DEFINE_LRECORD_IMPLEMENTATION(name,c_name,dumpable,marker,printer,nuker,equal,hash,desc,structtype) \
|
|
|
899 DEFINE_LRECORD_IMPLEMENTATION_WITH_PROPS(name,c_name,dumpable,marker,printer,nuker,equal,hash,desc,0,0,0,0,structtype)
|
|
|
900
|
|
|
901 #define DEFINE_LRECORD_IMPLEMENTATION_WITH_PROPS(name,c_name,dumpable,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,structtype) \
|
|
|
902 MAKE_LRECORD_IMPLEMENTATION(name,c_name,dumpable,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,sizeof (structtype),0,0,structtype)
|
|
|
903
|
|
|
904 #define DEFINE_LRECORD_SEQUENCE_IMPLEMENTATION(name,c_name,dumpable,marker,printer,nuker,equal,hash,desc,sizer,structtype) \
|
|
|
905 DEFINE_LRECORD_SEQUENCE_IMPLEMENTATION_WITH_PROPS(name,c_name,dumpable,marker,printer,nuker,equal,hash,desc,0,0,0,0,sizer,structtype)
|
|
|
906
|
|
|
907 #define DEFINE_BASIC_LRECORD_SEQUENCE_IMPLEMENTATION(name,c_name,dumpable,marker,printer,nuker,equal,hash,desc,sizer,structtype) \
|
|
|
908 MAKE_LRECORD_IMPLEMENTATION(name,c_name,dumpable,marker,printer,nuker,equal,hash,desc,0,0,0,0,0,sizer,1,structtype)
|
|
|
909
|
|
|
910 #define DEFINE_LRECORD_SEQUENCE_IMPLEMENTATION_WITH_PROPS(name,c_name,dumpable,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,sizer,structtype) \
|
|
|
911 MAKE_LRECORD_IMPLEMENTATION(name,c_name,dumpable,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,0,sizer,0,structtype)
|
|
|
912
|
|
|
913 #define MAKE_LRECORD_IMPLEMENTATION(name,c_name,dumpable,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,size,sizer,basic_p,structtype) \
|
|
1204
|
914 DECLARE_ERROR_CHECK_TYPES(c_name, structtype) \
|
|
934
|
915 const struct lrecord_implementation lrecord_##c_name = \
|
|
|
916 { name, dumpable, marker, printer, nuker, equal, hash, desc, \
|
|
|
917 getprop, putprop, remprop, plist, size, sizer, \
|
|
|
918 lrecord_type_##c_name, basic_p }
|
|
|
919
|
|
|
920 #define DEFINE_EXTERNAL_LRECORD_IMPLEMENTATION(name,c_name,dumpable,marker,printer,nuker,equal,hash,desc,structtype) \
|
|
|
921 DEFINE_EXTERNAL_LRECORD_IMPLEMENTATION_WITH_PROPS(name,c_name,dumpable,marker,printer,nuker,equal,hash,desc,0,0,0,0,structtype)
|
|
|
922
|
|
|
923 #define DEFINE_EXTERNAL_LRECORD_IMPLEMENTATION_WITH_PROPS(name,c_name,dumpable,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,structtype) \
|
|
|
924 MAKE_EXTERNAL_LRECORD_IMPLEMENTATION(name,c_name,dumpable,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,sizeof (structtype),0,0,structtype)
|
|
|
925
|
|
|
926 #define DEFINE_EXTERNAL_LRECORD_SEQUENCE_IMPLEMENTATION(name,c_name,dumpable,marker,printer,nuker,equal,hash,desc,sizer,structtype) \
|
|
|
927 DEFINE_EXTERNAL_LRECORD_SEQUENCE_IMPLEMENTATION_WITH_PROPS(name,c_name,dumpable,marker,printer,nuker,equal,hash,desc,0,0,0,0,sizer,structtype)
|
|
|
928
|
|
|
929 #define DEFINE_EXTERNAL_LRECORD_SEQUENCE_IMPLEMENTATION_WITH_PROPS(name,c_name,dumpable,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,sizer,structtype) \
|
|
|
930 MAKE_EXTERNAL_LRECORD_IMPLEMENTATION(name,c_name,dumpable,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,0,sizer,0,structtype)
|
|
|
931
|
|
|
932 #define MAKE_EXTERNAL_LRECORD_IMPLEMENTATION(name,c_name,dumpable,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,size,sizer,basic_p,structtype) \
|
|
1204
|
933 DECLARE_ERROR_CHECK_TYPES(c_name, structtype) \
|
|
934
|
934 int lrecord_type_##c_name; \
|
|
|
935 struct lrecord_implementation lrecord_##c_name = \
|
|
|
936 { name, dumpable, marker, printer, nuker, equal, hash, desc, \
|
|
|
937 getprop, putprop, remprop, plist, size, sizer, \
|
|
|
938 lrecord_type_last_built_in_type, basic_p }
|
|
|
939
|
|
1676
|
940 #ifdef USE_KKCC
|
|
|
941 extern MODULE_API const struct memory_description *lrecord_memory_descriptions[];
|
|
|
942
|
|
|
943 #define INIT_LRECORD_IMPLEMENTATION(type) do { \
|
|
|
944 lrecord_implementations_table[lrecord_type_##type] = &lrecord_##type; \
|
|
|
945 lrecord_memory_descriptions[lrecord_type_##type] = \
|
|
|
946 lrecord_implementations_table[lrecord_type_##type]->description; \
|
|
|
947 } while (0)
|
|
|
948 #else /* not USE_KKCC */
|
|
1632
|
949 extern MODULE_API Lisp_Object (*lrecord_markers[]) (Lisp_Object);
|
|
442
|
950
|
|
|
951 #define INIT_LRECORD_IMPLEMENTATION(type) do { \
|
|
|
952 lrecord_implementations_table[lrecord_type_##type] = &lrecord_##type; \
|
|
|
953 lrecord_markers[lrecord_type_##type] = \
|
|
|
954 lrecord_implementations_table[lrecord_type_##type]->marker; \
|
|
|
955 } while (0)
|
|
1676
|
956 #endif /* not USE_KKCC */
|
|
428
|
957
|
|
444
|
958 #define INIT_EXTERNAL_LRECORD_IMPLEMENTATION(type) do { \
|
|
|
959 lrecord_type_##type = lrecord_type_count++; \
|
|
|
960 lrecord_##type.lrecord_type_index = lrecord_type_##type; \
|
|
|
961 INIT_LRECORD_IMPLEMENTATION(type); \
|
|
|
962 } while (0)
|
|
|
963
|
|
996
|
964 #ifdef HAVE_SHLIB
|
|
|
965 /* Allow undefining types in order to support module unloading. */
|
|
|
966
|
|
1676
|
967 #ifdef USE_KKCC
|
|
|
968 #define UNDEF_LRECORD_IMPLEMENTATION(type) do { \
|
|
|
969 lrecord_implementations_table[lrecord_type_##type] = NULL; \
|
|
|
970 lrecord_memory_descriptions[lrecord_type_##type] = NULL; \
|
|
|
971 } while (0)
|
|
|
972 #else /* not USE_KKCC */
|
|
996
|
973 #define UNDEF_LRECORD_IMPLEMENTATION(type) do { \
|
|
|
974 lrecord_implementations_table[lrecord_type_##type] = NULL; \
|
|
|
975 lrecord_markers[lrecord_type_##type] = NULL; \
|
|
|
976 } while (0)
|
|
1676
|
977 #endif /* not USE_KKCC */
|
|
996
|
978
|
|
|
979 #define UNDEF_EXTERNAL_LRECORD_IMPLEMENTATION(type) do { \
|
|
|
980 if (lrecord_##type.lrecord_type_index == lrecord_type_count - 1) { \
|
|
|
981 /* This is the most recently defined type. Clean up nicely. */ \
|
|
|
982 lrecord_type_##type = lrecord_type_count--; \
|
|
|
983 } /* Else we can't help leaving a hole with this implementation. */ \
|
|
|
984 UNDEF_LRECORD_IMPLEMENTATION(type); \
|
|
|
985 } while (0)
|
|
|
986
|
|
|
987 #endif /* HAVE_SHLIB */
|
|
|
988
|
|
428
|
989 #define LRECORDP(a) (XTYPE (a) == Lisp_Type_Record)
|
|
|
990 #define XRECORD_LHEADER(a) ((struct lrecord_header *) XPNTR (a))
|
|
|
991
|
|
|
992 #define RECORD_TYPEP(x, ty) \
|
|
647
|
993 (LRECORDP (x) && (XRECORD_LHEADER (x)->type == (unsigned int) (ty)))
|
|
442
|
994
|
|
|
995 /* Steps to create a new object:
|
|
|
996
|
|
|
997 1. Declare the struct for your object in a header file somewhere.
|
|
|
998 Remember that it must begin with
|
|
|
999
|
|
|
1000 struct lcrecord_header header;
|
|
|
1001
|
|
793
|
1002 2. Put the "standard junk" (DECLARE_RECORD()/XFOO/etc.) below the
|
|
617
|
1003 struct definition -- see below.
|
|
442
|
1004
|
|
|
1005 3. Add this header file to inline.c.
|
|
|
1006
|
|
|
1007 4. Create the methods for your object. Note that technically you don't
|
|
|
1008 need any, but you will almost always want at least a mark method.
|
|
|
1009
|
|
1204
|
1010 4. Create the data layout description for your object. See
|
|
|
1011 toolbar_button_description below; the comment above in `struct lrecord',
|
|
|
1012 describing the purpose of the descriptions; and comments elsewhere in
|
|
|
1013 this file describing the exact syntax of the description structures.
|
|
|
1014
|
|
|
1015 6. Define your object with DEFINE_LRECORD_IMPLEMENTATION() or some
|
|
442
|
1016 variant.
|
|
|
1017
|
|
1204
|
1018 7. Include the header file in the .c file where you defined the object.
|
|
442
|
1019
|
|
1204
|
1020 8. Put a call to INIT_LRECORD_IMPLEMENTATION() for the object in the
|
|
442
|
1021 .c file's syms_of_foo() function.
|
|
|
1022
|
|
1204
|
1023 9. Add a type enum for the object to enum lrecord_type, earlier in this
|
|
442
|
1024 file.
|
|
|
1025
|
|
1204
|
1026 --ben
|
|
|
1027
|
|
442
|
1028 An example:
|
|
428
|
1029
|
|
442
|
1030 ------------------------------ in toolbar.h -----------------------------
|
|
|
1031
|
|
|
1032 struct toolbar_button
|
|
|
1033 {
|
|
|
1034 struct lcrecord_header header;
|
|
|
1035
|
|
|
1036 Lisp_Object next;
|
|
|
1037 Lisp_Object frame;
|
|
|
1038
|
|
|
1039 Lisp_Object up_glyph;
|
|
|
1040 Lisp_Object down_glyph;
|
|
|
1041 Lisp_Object disabled_glyph;
|
|
|
1042
|
|
|
1043 Lisp_Object cap_up_glyph;
|
|
|
1044 Lisp_Object cap_down_glyph;
|
|
|
1045 Lisp_Object cap_disabled_glyph;
|
|
|
1046
|
|
|
1047 Lisp_Object callback;
|
|
|
1048 Lisp_Object enabled_p;
|
|
|
1049 Lisp_Object help_string;
|
|
|
1050
|
|
|
1051 char enabled;
|
|
|
1052 char down;
|
|
|
1053 char pushright;
|
|
|
1054 char blank;
|
|
|
1055
|
|
|
1056 int x, y;
|
|
|
1057 int width, height;
|
|
|
1058 int dirty;
|
|
|
1059 int vertical;
|
|
|
1060 int border_width;
|
|
|
1061 };
|
|
428
|
1062
|
|
617
|
1063 [[ the standard junk: ]]
|
|
|
1064
|
|
442
|
1065 DECLARE_LRECORD (toolbar_button, struct toolbar_button);
|
|
|
1066 #define XTOOLBAR_BUTTON(x) XRECORD (x, toolbar_button, struct toolbar_button)
|
|
617
|
1067 #define wrap_toolbar_button(p) wrap_record (p, toolbar_button)
|
|
442
|
1068 #define TOOLBAR_BUTTONP(x) RECORDP (x, toolbar_button)
|
|
|
1069 #define CHECK_TOOLBAR_BUTTON(x) CHECK_RECORD (x, toolbar_button)
|
|
|
1070 #define CONCHECK_TOOLBAR_BUTTON(x) CONCHECK_RECORD (x, toolbar_button)
|
|
|
1071
|
|
|
1072 ------------------------------ in toolbar.c -----------------------------
|
|
|
1073
|
|
|
1074 #include "toolbar.h"
|
|
|
1075
|
|
|
1076 ...
|
|
|
1077
|
|
1204
|
1078 static const struct memory_description toolbar_button_description [] = {
|
|
|
1079 { XD_LISP_OBJECT, offsetof (struct toolbar_button, next) },
|
|
|
1080 { XD_LISP_OBJECT, offsetof (struct toolbar_button, frame) },
|
|
|
1081 { XD_LISP_OBJECT, offsetof (struct toolbar_button, up_glyph) },
|
|
|
1082 { XD_LISP_OBJECT, offsetof (struct toolbar_button, down_glyph) },
|
|
|
1083 { XD_LISP_OBJECT, offsetof (struct toolbar_button, disabled_glyph) },
|
|
|
1084 { XD_LISP_OBJECT, offsetof (struct toolbar_button, cap_up_glyph) },
|
|
|
1085 { XD_LISP_OBJECT, offsetof (struct toolbar_button, cap_down_glyph) },
|
|
|
1086 { XD_LISP_OBJECT, offsetof (struct toolbar_button, cap_disabled_glyph) },
|
|
|
1087 { XD_LISP_OBJECT, offsetof (struct toolbar_button, callback) },
|
|
|
1088 { XD_LISP_OBJECT, offsetof (struct toolbar_button, enabled_p) },
|
|
|
1089 { XD_LISP_OBJECT, offsetof (struct toolbar_button, help_string) },
|
|
|
1090 { XD_END }
|
|
|
1091 };
|
|
|
1092
|
|
442
|
1093 static Lisp_Object
|
|
|
1094 mark_toolbar_button (Lisp_Object obj)
|
|
1204
|
1095 \{
|
|
442
|
1096 struct toolbar_button *data = XTOOLBAR_BUTTON (obj);
|
|
|
1097 mark_object (data->next);
|
|
|
1098 mark_object (data->frame);
|
|
|
1099 mark_object (data->up_glyph);
|
|
|
1100 mark_object (data->down_glyph);
|
|
|
1101 mark_object (data->disabled_glyph);
|
|
|
1102 mark_object (data->cap_up_glyph);
|
|
|
1103 mark_object (data->cap_down_glyph);
|
|
|
1104 mark_object (data->cap_disabled_glyph);
|
|
|
1105 mark_object (data->callback);
|
|
|
1106 mark_object (data->enabled_p);
|
|
|
1107 return data->help_string;
|
|
|
1108 }
|
|
|
1109
|
|
617
|
1110 [[ If your object should never escape to Lisp, declare its print method
|
|
|
1111 as internal_object_printer instead of 0. ]]
|
|
|
1112
|
|
442
|
1113 DEFINE_LRECORD_IMPLEMENTATION ("toolbar-button", toolbar_button,
|
|
1204
|
1114 0, mark_toolbar_button, 0, 0, 0, 0,
|
|
|
1115 toolbar_button_description,
|
|
|
1116 struct toolbar_button);
|
|
442
|
1117
|
|
|
1118 ...
|
|
|
1119
|
|
|
1120 void
|
|
|
1121 syms_of_toolbar (void)
|
|
|
1122 {
|
|
|
1123 INIT_LRECORD_IMPLEMENTATION (toolbar_button);
|
|
|
1124
|
|
|
1125 ...;
|
|
|
1126 }
|
|
|
1127
|
|
|
1128 ------------------------------ in inline.c -----------------------------
|
|
|
1129
|
|
|
1130 #ifdef HAVE_TOOLBARS
|
|
|
1131 #include "toolbar.h"
|
|
|
1132 #endif
|
|
|
1133
|
|
|
1134 ------------------------------ in lrecord.h -----------------------------
|
|
|
1135
|
|
|
1136 enum lrecord_type
|
|
|
1137 {
|
|
|
1138 ...
|
|
|
1139 lrecord_type_toolbar_button,
|
|
|
1140 ...
|
|
|
1141 };
|
|
|
1142
|
|
1204
|
1143
|
|
|
1144 --ben
|
|
|
1145
|
|
442
|
1146 */
|
|
|
1147
|
|
|
1148 /*
|
|
|
1149
|
|
|
1150 Note: Object types defined in external dynamically-loaded modules (not
|
|
|
1151 part of the XEmacs main source code) should use DECLARE_EXTERNAL_LRECORD
|
|
|
1152 and DEFINE_EXTERNAL_LRECORD_IMPLEMENTATION rather than DECLARE_LRECORD
|
|
|
1153 and DEFINE_LRECORD_IMPLEMENTATION.
|
|
|
1154
|
|
|
1155 */
|
|
|
1156
|
|
428
|
1157
|
|
800
|
1158 #ifdef ERROR_CHECK_TYPES
|
|
428
|
1159
|
|
788
|
1160 # define DECLARE_LRECORD(c_name, structtype) \
|
|
|
1161 extern const struct lrecord_implementation lrecord_##c_name; \
|
|
826
|
1162 DECLARE_INLINE_HEADER ( \
|
|
|
1163 structtype * \
|
|
2367
|
1164 error_check_##c_name (Lisp_Object obj, const Ascbyte *file, int line) \
|
|
826
|
1165 ) \
|
|
788
|
1166 { \
|
|
|
1167 assert_at_line (RECORD_TYPEP (obj, lrecord_type_##c_name), file, line); \
|
|
|
1168 return (structtype *) XPNTR (obj); \
|
|
|
1169 } \
|
|
428
|
1170 extern Lisp_Object Q##c_name##p
|
|
|
1171
|
|
1632
|
1172 # define DECLARE_MODULE_API_LRECORD(c_name, structtype) \
|
|
|
1173 extern MODULE_API const struct lrecord_implementation lrecord_##c_name; \
|
|
|
1174 DECLARE_INLINE_HEADER ( \
|
|
|
1175 structtype * \
|
|
2367
|
1176 error_check_##c_name (Lisp_Object obj, const Ascbyte *file, int line) \
|
|
1632
|
1177 ) \
|
|
|
1178 { \
|
|
|
1179 assert_at_line (RECORD_TYPEP (obj, lrecord_type_##c_name), file, line); \
|
|
|
1180 return (structtype *) XPNTR (obj); \
|
|
|
1181 } \
|
|
|
1182 extern MODULE_API Lisp_Object Q##c_name##p
|
|
|
1183
|
|
788
|
1184 # define DECLARE_EXTERNAL_LRECORD(c_name, structtype) \
|
|
|
1185 extern int lrecord_type_##c_name; \
|
|
|
1186 extern struct lrecord_implementation lrecord_##c_name; \
|
|
826
|
1187 DECLARE_INLINE_HEADER ( \
|
|
|
1188 structtype * \
|
|
2367
|
1189 error_check_##c_name (Lisp_Object obj, const Ascbyte *file, int line) \
|
|
826
|
1190 ) \
|
|
788
|
1191 { \
|
|
|
1192 assert_at_line (RECORD_TYPEP (obj, lrecord_type_##c_name), file, line); \
|
|
|
1193 return (structtype *) XPNTR (obj); \
|
|
|
1194 } \
|
|
444
|
1195 extern Lisp_Object Q##c_name##p
|
|
442
|
1196
|
|
788
|
1197 # define DECLARE_NONRECORD(c_name, type_enum, structtype) \
|
|
826
|
1198 DECLARE_INLINE_HEADER ( \
|
|
|
1199 structtype * \
|
|
2367
|
1200 error_check_##c_name (Lisp_Object obj, const Ascbyte *file, int line) \
|
|
826
|
1201 ) \
|
|
788
|
1202 { \
|
|
|
1203 assert_at_line (XTYPE (obj) == type_enum, file, line); \
|
|
|
1204 return (structtype *) XPNTR (obj); \
|
|
|
1205 } \
|
|
428
|
1206 extern Lisp_Object Q##c_name##p
|
|
|
1207
|
|
788
|
1208 # define XRECORD(x, c_name, structtype) \
|
|
|
1209 error_check_##c_name (x, __FILE__, __LINE__)
|
|
|
1210 # define XNONRECORD(x, c_name, type_enum, structtype) \
|
|
|
1211 error_check_##c_name (x, __FILE__, __LINE__)
|
|
428
|
1212
|
|
826
|
1213 DECLARE_INLINE_HEADER (
|
|
|
1214 Lisp_Object
|
|
2367
|
1215 wrap_record_1 (const void *ptr, enum lrecord_type ty, const Ascbyte *file,
|
|
800
|
1216 int line)
|
|
826
|
1217 )
|
|
617
|
1218 {
|
|
793
|
1219 Lisp_Object obj = wrap_pointer_1 (ptr);
|
|
|
1220
|
|
788
|
1221 assert_at_line (RECORD_TYPEP (obj, ty), file, line);
|
|
617
|
1222 return obj;
|
|
|
1223 }
|
|
|
1224
|
|
788
|
1225 #define wrap_record(ptr, ty) \
|
|
|
1226 wrap_record_1 (ptr, lrecord_type_##ty, __FILE__, __LINE__)
|
|
617
|
1227
|
|
800
|
1228 #else /* not ERROR_CHECK_TYPES */
|
|
428
|
1229
|
|
|
1230 # define DECLARE_LRECORD(c_name, structtype) \
|
|
|
1231 extern Lisp_Object Q##c_name##p; \
|
|
442
|
1232 extern const struct lrecord_implementation lrecord_##c_name
|
|
1638
|
1233 # define DECLARE_MODULE_API_LRECORD(c_name, structtype) \
|
|
|
1234 extern MODULE_API Lisp_Object Q##c_name##p; \
|
|
|
1235 extern MODULE_API const struct lrecord_implementation lrecord_##c_name
|
|
442
|
1236 # define DECLARE_EXTERNAL_LRECORD(c_name, structtype) \
|
|
|
1237 extern Lisp_Object Q##c_name##p; \
|
|
647
|
1238 extern int lrecord_type_##c_name; \
|
|
444
|
1239 extern struct lrecord_implementation lrecord_##c_name
|
|
428
|
1240 # define DECLARE_NONRECORD(c_name, type_enum, structtype) \
|
|
|
1241 extern Lisp_Object Q##c_name##p
|
|
|
1242 # define XRECORD(x, c_name, structtype) ((structtype *) XPNTR (x))
|
|
|
1243 # define XNONRECORD(x, c_name, type_enum, structtype) \
|
|
|
1244 ((structtype *) XPNTR (x))
|
|
617
|
1245 /* wrap_pointer_1 is so named as a suggestion not to use it unless you
|
|
|
1246 know what you're doing. */
|
|
|
1247 #define wrap_record(ptr, ty) wrap_pointer_1 (ptr)
|
|
428
|
1248
|
|
800
|
1249 #endif /* not ERROR_CHECK_TYPES */
|
|
428
|
1250
|
|
442
|
1251 #define RECORDP(x, c_name) RECORD_TYPEP (x, lrecord_type_##c_name)
|
|
428
|
1252
|
|
|
1253 /* Note: we now have two different kinds of type-checking macros.
|
|
|
1254 The "old" kind has now been renamed CONCHECK_foo. The reason for
|
|
|
1255 this is that the CONCHECK_foo macros signal a continuable error,
|
|
|
1256 allowing the user (through debug-on-error) to substitute a different
|
|
|
1257 value and return from the signal, which causes the lvalue argument
|
|
|
1258 to get changed. Quite a lot of code would crash if that happened,
|
|
|
1259 because it did things like
|
|
|
1260
|
|
|
1261 foo = XCAR (list);
|
|
|
1262 CHECK_STRING (foo);
|
|
|
1263
|
|
|
1264 and later on did XSTRING (XCAR (list)), assuming that the type
|
|
|
1265 is correct (when it might be wrong, if the user substituted a
|
|
|
1266 correct value in the debugger).
|
|
|
1267
|
|
|
1268 To get around this, I made all the CHECK_foo macros signal a
|
|
|
1269 non-continuable error. Places where a continuable error is OK
|
|
|
1270 (generally only when called directly on the argument of a Lisp
|
|
|
1271 primitive) should be changed to use CONCHECK().
|
|
|
1272
|
|
|
1273 FSF Emacs does not have this problem because RMS took the cheesy
|
|
|
1274 way out and disabled returning from a signal entirely. */
|
|
|
1275
|
|
|
1276 #define CONCHECK_RECORD(x, c_name) do { \
|
|
442
|
1277 if (!RECORD_TYPEP (x, lrecord_type_##c_name)) \
|
|
428
|
1278 x = wrong_type_argument (Q##c_name##p, x); \
|
|
|
1279 } while (0)
|
|
|
1280 #define CONCHECK_NONRECORD(x, lisp_enum, predicate) do {\
|
|
|
1281 if (XTYPE (x) != lisp_enum) \
|
|
|
1282 x = wrong_type_argument (predicate, x); \
|
|
|
1283 } while (0)
|
|
|
1284 #define CHECK_RECORD(x, c_name) do { \
|
|
442
|
1285 if (!RECORD_TYPEP (x, lrecord_type_##c_name)) \
|
|
428
|
1286 dead_wrong_type_argument (Q##c_name##p, x); \
|
|
|
1287 } while (0)
|
|
|
1288 #define CHECK_NONRECORD(x, lisp_enum, predicate) do { \
|
|
|
1289 if (XTYPE (x) != lisp_enum) \
|
|
|
1290 dead_wrong_type_argument (predicate, x); \
|
|
|
1291 } while (0)
|
|
|
1292
|
|
1204
|
1293 /*-------------------------- lcrecord-list -----------------------------*/
|
|
|
1294
|
|
|
1295 struct lcrecord_list
|
|
|
1296 {
|
|
|
1297 struct lcrecord_header header;
|
|
|
1298 Lisp_Object free;
|
|
|
1299 Elemcount size;
|
|
|
1300 const struct lrecord_implementation *implementation;
|
|
|
1301 };
|
|
|
1302
|
|
|
1303 DECLARE_LRECORD (lcrecord_list, struct lcrecord_list);
|
|
|
1304 #define XLCRECORD_LIST(x) XRECORD (x, lcrecord_list, struct lcrecord_list)
|
|
|
1305 #define wrap_lcrecord_list(p) wrap_record (p, lcrecord_list)
|
|
|
1306 #define LCRECORD_LISTP(x) RECORDP (x, lcrecord_list)
|
|
|
1307 /* #define CHECK_LCRECORD_LIST(x) CHECK_RECORD (x, lcrecord_list)
|
|
|
1308 Lcrecord lists should never escape to the Lisp level, so
|
|
|
1309 functions should not be doing this. */
|
|
|
1310
|
|
826
|
1311 /* Various ways of allocating lcrecords. All bytes (except lcrecord
|
|
1204
|
1312 header) are zeroed in returned structure.
|
|
|
1313
|
|
|
1314 See above for a discussion of the difference between plain lrecords and
|
|
|
1315 lrecords. lcrecords themselves are divided into three types: (1)
|
|
|
1316 auto-managed, (2) hand-managed, and (3) unmanaged. "Managed" refers to
|
|
|
1317 using a special object called an lcrecord-list to keep track of freed
|
|
|
1318 lcrecords, which can freed with free_lcrecord() or the like and later be
|
|
|
1319 recycled when a new lcrecord is required, rather than requiring new
|
|
|
1320 malloc(). Thus, allocation of lcrecords can be very
|
|
|
1321 cheap. (Technically, the lcrecord-list manager could divide up large
|
|
|
1322 chunks of memory and allocate out of that, mimicking what happens with
|
|
|
1323 lrecords. At that point, however, we'd want to rethink the whole
|
|
|
1324 division between lrecords and lcrecords.)
|
|
|
1325
|
|
|
1326 NOTE: There is a fundamental limitation of lcrecord-lists, which is that
|
|
|
1327 they only handle blocks of a particular, fixed size. Thus, objects that
|
|
|
1328 can be of varying sizes need to do various tricks. These considerations
|
|
|
1329 in particular dictate the various types of management:
|
|
|
1330
|
|
|
1331 -- "Auto-managed" means that you just go ahead and allocate the lcrecord
|
|
|
1332 whenever you want, using alloc_lcrecord_type(), and the appropriate
|
|
|
1333 lcrecord-list manager is automatically created. To free, you just call
|
|
|
1334 "free_lcrecord()" and the appropriate lcrecord-list manager is
|
|
|
1335 automatically located and called. The limitation here of course is that
|
|
|
1336 all your objects are of the same size. (#### Eventually we should have a
|
|
|
1337 more sophisticated system that tracks the sizes seen and creates one
|
|
|
1338 lcrecord list per size, indexed in a hash table. Usually there are only
|
|
|
1339 a limited number of sizes, so this works well.)
|
|
826
|
1340
|
|
1204
|
1341 -- "Hand-managed" exists because we haven't yet written the more
|
|
|
1342 sophisticated scheme for auto-handling different-sized lcrecords, as
|
|
|
1343 described in the end of the last paragraph. In this model, you go ahead
|
|
|
1344 and create the lcrecord-list objects yourself for the sizes you will
|
|
|
1345 need, using make_lcrecord_list(). Then, create lcrecords using
|
|
|
1346 alloc_managed_lcrecord(), passing in the lcrecord-list you created, and
|
|
|
1347 free them with free_managed_lcrecord().
|
|
|
1348
|
|
|
1349 -- "Unmanaged" means you simply allocate lcrecords, period. No
|
|
|
1350 lcrecord-lists, no way to free them. This may be suitable when the
|
|
|
1351 lcrecords are variable-sized and (a) you're too lazy to write the code
|
|
|
1352 to hand-manage them, or (b) the objects you create are always or almost
|
|
|
1353 always Lisp-visible, and thus there's no point in freeing them (and it
|
|
|
1354 wouldn't be safe to do so). You just create them with
|
|
|
1355 basic_alloc_lcrecord(), and that's it.
|
|
|
1356
|
|
|
1357 --ben
|
|
|
1358
|
|
|
1359 Here is an in-depth look at the steps required to create a allocate an
|
|
|
1360 lcrecord using the hand-managed style. Since this is the most
|
|
|
1361 complicated, you will learn a lot about the other styles as well. In
|
|
|
1362 addition, there is useful general information about what freeing an
|
|
|
1363 lcrecord really entails, and what are the precautions:
|
|
|
1364
|
|
|
1365 1) Create an lcrecord-list object using make_lcrecord_list(). This is
|
|
|
1366 often done at initialization. Remember to staticpro_nodump() this
|
|
|
1367 object! The arguments to make_lcrecord_list() are the same as would be
|
|
|
1368 passed to basic_alloc_lcrecord().
|
|
428
|
1369
|
|
1204
|
1370 2) Instead of calling basic_alloc_lcrecord(), call alloc_managed_lcrecord()
|
|
|
1371 and pass the lcrecord-list earlier created.
|
|
|
1372
|
|
|
1373 3) When done with the lcrecord, call free_managed_lcrecord(). The
|
|
|
1374 standard freeing caveats apply: ** make sure there are no pointers to
|
|
|
1375 the object anywhere! **
|
|
|
1376
|
|
|
1377 4) Calling free_managed_lcrecord() is just like kissing the
|
|
|
1378 lcrecord goodbye as if it were garbage-collected. This means:
|
|
|
1379 -- the contents of the freed lcrecord are undefined, and the
|
|
|
1380 contents of something produced by alloc_managed_lcrecord()
|
|
|
1381 are undefined, just like for basic_alloc_lcrecord().
|
|
|
1382 -- the mark method for the lcrecord's type will *NEVER* be called
|
|
|
1383 on freed lcrecords.
|
|
|
1384 -- the finalize method for the lcrecord's type will be called
|
|
|
1385 at the time that free_managed_lcrecord() is called.
|
|
|
1386 */
|
|
|
1387
|
|
|
1388 /* UNMANAGED MODEL: */
|
|
|
1389 void *basic_alloc_lcrecord (Bytecount size,
|
|
|
1390 const struct lrecord_implementation *);
|
|
|
1391
|
|
|
1392 /* HAND-MANAGED MODEL: */
|
|
|
1393 Lisp_Object make_lcrecord_list (Elemcount size,
|
|
|
1394 const struct lrecord_implementation
|
|
|
1395 *implementation);
|
|
|
1396 Lisp_Object alloc_managed_lcrecord (Lisp_Object lcrecord_list);
|
|
|
1397 void free_managed_lcrecord (Lisp_Object lcrecord_list, Lisp_Object lcrecord);
|
|
|
1398
|
|
|
1399 /* AUTO-MANAGED MODEL: */
|
|
1632
|
1400 MODULE_API void *
|
|
|
1401 alloc_automanaged_lcrecord (Bytecount size,
|
|
|
1402 const struct lrecord_implementation *);
|
|
428
|
1403 #define alloc_lcrecord_type(type, lrecord_implementation) \
|
|
771
|
1404 ((type *) alloc_automanaged_lcrecord (sizeof (type), lrecord_implementation))
|
|
|
1405 void free_lcrecord (Lisp_Object rec);
|
|
|
1406
|
|
428
|
1407
|
|
|
1408 /* Copy the data from one lcrecord structure into another, but don't
|
|
|
1409 overwrite the header information. */
|
|
|
1410
|
|
771
|
1411 #define copy_sized_lcrecord(dst, src, size) \
|
|
2367
|
1412 memcpy ((Rawbyte *) (dst) + sizeof (struct lcrecord_header), \
|
|
|
1413 (Rawbyte *) (src) + sizeof (struct lcrecord_header), \
|
|
771
|
1414 (size) - sizeof (struct lcrecord_header))
|
|
|
1415
|
|
|
1416 #define copy_lcrecord(dst, src) copy_sized_lcrecord (dst, src, sizeof (*(dst)))
|
|
428
|
1417
|
|
771
|
1418 #define zero_sized_lcrecord(lcr, size) \
|
|
2367
|
1419 memset ((Rawbyte *) (lcr) + sizeof (struct lcrecord_header), 0, \
|
|
771
|
1420 (size) - sizeof (struct lcrecord_header))
|
|
|
1421
|
|
1204
|
1422 #define zero_lcrecord(lcr) zero_sized_lcrecord (lcr, sizeof (*(lcr)))
|
|
|
1423
|
|
|
1424 DECLARE_INLINE_HEADER (
|
|
|
1425 Bytecount
|
|
|
1426 detagged_lisp_object_size (const struct lrecord_header *h)
|
|
|
1427 )
|
|
|
1428 {
|
|
|
1429 const struct lrecord_implementation *imp = LHEADER_IMPLEMENTATION (h);
|
|
|
1430
|
|
|
1431 return (imp->size_in_bytes_method ?
|
|
|
1432 imp->size_in_bytes_method (h) :
|
|
|
1433 imp->static_size);
|
|
|
1434 }
|
|
|
1435
|
|
|
1436 DECLARE_INLINE_HEADER (
|
|
|
1437 Bytecount
|
|
|
1438 lisp_object_size (Lisp_Object o)
|
|
|
1439 )
|
|
|
1440 {
|
|
|
1441 return detagged_lisp_object_size (XRECORD_LHEADER (o));
|
|
|
1442 }
|
|
|
1443
|
|
|
1444
|
|
|
1445 /************************************************************************/
|
|
|
1446 /* Dumping */
|
|
|
1447 /************************************************************************/
|
|
|
1448
|
|
2367
|
1449 /* dump_add_root_block_ptr (&var, &desc) dumps the structure pointed to by
|
|
1204
|
1450 `var'. This is for a single relocatable pointer located in the data
|
|
2367
|
1451 segment (i.e. the block pointed to is in the heap).
|
|
|
1452
|
|
|
1453 If the structure pointed to is not a `struct' but an array, you should
|
|
|
1454 set the size field of the sized_memory_description to 0, and use
|
|
|
1455 XD_BLOCK_ARRAY in the inner memory_description.
|
|
|
1456
|
|
|
1457 NOTE that a "root struct pointer" could also be described using
|
|
|
1458 dump_add_root_block(), with SIZE == sizeof (void *), and a description
|
|
|
1459 containing a single XD_BLOCK_PTR entry, offset 0, size 1, with a
|
|
|
1460 structure description the same as the value passed to
|
|
|
1461 dump_add_root_block_ptr(). That would require an extra level of
|
|
|
1462 description, though, as compared to using dump_add_root_block_ptr(),
|
|
|
1463 and thus this function is generally more convenient.
|
|
|
1464 */
|
|
1204
|
1465 #ifdef PDUMP
|
|
2367
|
1466 void dump_add_root_block_ptr (void *, const struct sized_memory_description *);
|
|
1204
|
1467 #else
|
|
2367
|
1468 #define dump_add_root_block_ptr(varaddr, descaddr) DO_NOTHING
|
|
1204
|
1469 #endif
|
|
|
1470
|
|
|
1471 /* dump_add_opaque (&var, size) dumps the opaque static structure `var'.
|
|
|
1472 This is for a static block of memory (in the data segment, not the
|
|
|
1473 heap), with no relocatable pointers in it. */
|
|
|
1474 #ifdef PDUMP
|
|
|
1475 #define dump_add_opaque(varaddr,size) dump_add_root_block (varaddr, size, NULL)
|
|
|
1476 #else
|
|
|
1477 #define dump_add_opaque(varaddr,size) DO_NOTHING
|
|
|
1478 #endif
|
|
|
1479
|
|
|
1480 /* dump_add_root_block (ptr, size, desc) dumps the static structure
|
|
|
1481 located at `var' of size SIZE and described by DESC. This is for a
|
|
|
1482 static block of memory (in the data segment, not the heap), with
|
|
|
1483 relocatable pointers in it. */
|
|
|
1484 #ifdef PDUMP
|
|
|
1485 void dump_add_root_block (const void *ptraddress, Bytecount size,
|
|
|
1486 const struct memory_description *desc);
|
|
|
1487 #else
|
|
2367
|
1488 #define dump_add_root_block(ptraddress, size, desc) DO_NOTHING
|
|
1204
|
1489 #endif
|
|
|
1490
|
|
|
1491 /* Call dump_add_opaque_int (&int_var) to dump `int_var', of type `int'. */
|
|
|
1492 #ifdef PDUMP
|
|
|
1493 #define dump_add_opaque_int(int_varaddr) do { \
|
|
|
1494 int *dao_ = (int_varaddr); /* type check */ \
|
|
|
1495 dump_add_opaque (dao_, sizeof (*dao_)); \
|
|
|
1496 } while (0)
|
|
|
1497 #else
|
|
|
1498 #define dump_add_opaque_int(int_varaddr) DO_NOTHING
|
|
|
1499 #endif
|
|
|
1500
|
|
|
1501 /* Call dump_add_opaque_fixnum (&fixnum_var) to dump `fixnum_var', of type
|
|
|
1502 `Fixnum'. */
|
|
|
1503 #ifdef PDUMP
|
|
|
1504 #define dump_add_opaque_fixnum(fixnum_varaddr) do { \
|
|
|
1505 Fixnum *dao_ = (fixnum_varaddr); /* type check */ \
|
|
|
1506 dump_add_opaque (dao_, sizeof (*dao_)); \
|
|
|
1507 } while (0)
|
|
|
1508 #else
|
|
|
1509 #define dump_add_opaque_fixnum(fixnum_varaddr) DO_NOTHING
|
|
|
1510 #endif
|
|
|
1511
|
|
|
1512 /* Call dump_add_root_lisp_object (&var) to ensure that var is properly
|
|
|
1513 updated after pdump. */
|
|
|
1514 #ifdef PDUMP
|
|
|
1515 void dump_add_root_lisp_object (Lisp_Object *);
|
|
|
1516 #else
|
|
|
1517 #define dump_add_root_lisp_object(varaddr) DO_NOTHING
|
|
|
1518 #endif
|
|
|
1519
|
|
|
1520 /* Call dump_add_weak_lisp_object (&var) to ensure that var is properly
|
|
|
1521 updated after pdump. var must point to a linked list of objects out of
|
|
|
1522 which some may not be dumped */
|
|
|
1523 #ifdef PDUMP
|
|
|
1524 void dump_add_weak_object_chain (Lisp_Object *);
|
|
|
1525 #else
|
|
|
1526 #define dump_add_weak_object_chain(varaddr) DO_NOTHING
|
|
|
1527 #endif
|
|
|
1528
|
|
|
1529 /* Nonzero means Emacs has already been initialized.
|
|
|
1530 Used during startup to detect startup of dumped Emacs. */
|
|
1632
|
1531 extern MODULE_API int initialized;
|
|
1204
|
1532
|
|
|
1533 #ifdef PDUMP
|
|
1688
|
1534 #include "dumper.h"
|
|
2367
|
1535 #define DUMPEDP(adr) ((((Rawbyte *) (adr)) < pdump_end) && \
|
|
|
1536 (((Rawbyte *) (adr)) >= pdump_start))
|
|
1204
|
1537 #else
|
|
|
1538 #define DUMPEDP(adr) 0
|
|
|
1539 #endif
|
|
|
1540
|
|
1330
|
1541 #define OBJECT_DUMPED_P(obj) DUMPEDP (XPNTR (obj))
|
|
|
1542
|
|
1204
|
1543 /***********************************************************************/
|
|
|
1544 /* data descriptions */
|
|
|
1545 /***********************************************************************/
|
|
|
1546
|
|
|
1547
|
|
|
1548 #if defined (USE_KKCC) || defined (PDUMP)
|
|
|
1549
|
|
|
1550 extern int in_pdump;
|
|
|
1551
|
|
|
1552 EMACS_INT lispdesc_indirect_count_1 (EMACS_INT code,
|
|
|
1553 const struct memory_description *idesc,
|
|
|
1554 const void *idata);
|
|
|
1555 const struct sized_memory_description *lispdesc_indirect_description_1
|
|
|
1556 (const void *obj, const struct sized_memory_description *sdesc);
|
|
2367
|
1557 Bytecount lispdesc_block_size_1 (const void *obj, Bytecount size,
|
|
|
1558 const struct memory_description *desc);
|
|
|
1559
|
|
|
1560 DECLARE_INLINE_HEADER (
|
|
|
1561 Bytecount lispdesc_block_size (const void *obj,
|
|
|
1562 const struct sized_memory_description *sdesc))
|
|
|
1563 {
|
|
|
1564 return lispdesc_block_size_1 (obj, sdesc->size, sdesc->description);
|
|
|
1565 }
|
|
1204
|
1566
|
|
|
1567 DECLARE_INLINE_HEADER (
|
|
|
1568 EMACS_INT
|
|
|
1569 lispdesc_indirect_count (EMACS_INT code,
|
|
|
1570 const struct memory_description *idesc,
|
|
|
1571 const void *idata)
|
|
|
1572 )
|
|
|
1573 {
|
|
|
1574 if (XD_IS_INDIRECT (code))
|
|
|
1575 code = lispdesc_indirect_count_1 (code, idesc, idata);
|
|
|
1576 return code;
|
|
|
1577 }
|
|
|
1578
|
|
|
1579 DECLARE_INLINE_HEADER (
|
|
|
1580 const struct sized_memory_description *
|
|
|
1581 lispdesc_indirect_description (const void *obj,
|
|
|
1582 const struct sized_memory_description *sdesc)
|
|
|
1583 )
|
|
|
1584 {
|
|
|
1585 if (sdesc->description)
|
|
|
1586 return sdesc;
|
|
|
1587 else
|
|
|
1588 return lispdesc_indirect_description_1 (obj, sdesc);
|
|
|
1589 }
|
|
|
1590
|
|
|
1591
|
|
|
1592 /* Do standard XD_UNION processing. DESC1 is an entry in DESC, which
|
|
|
1593 describes the entire data structure. Returns NULL (do nothing, nothing
|
|
|
1594 matched), or a new value for DESC1. In the latter case, assign to DESC1
|
|
|
1595 in your function and goto union_switcheroo. */
|
|
|
1596
|
|
|
1597 DECLARE_INLINE_HEADER (
|
|
|
1598 const struct memory_description *
|
|
|
1599 lispdesc_process_xd_union (const struct memory_description *desc1,
|
|
|
1600 const struct memory_description *desc,
|
|
|
1601 const void *data)
|
|
|
1602 )
|
|
|
1603 {
|
|
|
1604 int count = 0;
|
|
|
1605 EMACS_INT variant = lispdesc_indirect_count (desc1->data1, desc,
|
|
|
1606 data);
|
|
|
1607 desc1 =
|
|
|
1608 lispdesc_indirect_description (data, desc1->data2)->description;
|
|
|
1609
|
|
|
1610 for (count = 0; desc1[count].type != XD_END; count++)
|
|
|
1611 {
|
|
|
1612 if ((desc1[count].flags & XD_FLAG_UNION_DEFAULT_ENTRY) ||
|
|
|
1613 desc1[count].offset == variant)
|
|
|
1614 {
|
|
|
1615 return &desc1[count];
|
|
|
1616 }
|
|
|
1617 }
|
|
|
1618
|
|
|
1619 return NULL;
|
|
|
1620 }
|
|
|
1621
|
|
|
1622 #endif /* defined (USE_KKCC) || defined (PDUMP) */
|
|
428
|
1623
|
|
1743
|
1624 END_C_DECLS
|
|
1650
|
1625
|
|
440
|
1626 #endif /* INCLUDED_lrecord_h_ */
|
