annotate lisp/post-gc.el @ 5142:f965e31a35f0

reduce lcrecord headers to 2 words, rename printing_unreadable_object -------------------- ChangeLog entries follow: -------------------- man/ChangeLog addition: 2010-03-13 Ben Wing <ben@xemacs.org> * internals/internals.texi (Working with Lisp Objects): * internals/internals.texi (Writing Macros): * internals/internals.texi (lrecords): More rewriting to correspond with changes from *LRECORD* to *LISP_OBJECT*. modules/ChangeLog addition: 2010-03-13 Ben Wing <ben@xemacs.org> * postgresql/postgresql.c (print_pgconn): * postgresql/postgresql.c (print_pgresult): printing_unreadable_object -> printing_unreadable_object_fmt. 2010-03-13 Ben Wing <ben@xemacs.org> * ldap/eldap.c (print_ldap): printing_unreadable_object -> printing_unreadable_object_fmt. src/ChangeLog addition: 2010-03-13 Ben Wing <ben@xemacs.org> * alloc.c (alloc_sized_lrecord_1): * alloc.c (alloc_sized_lrecord_array): * alloc.c (old_alloc_sized_lcrecord): * alloc.c (disksave_object_finalization_1): * alloc.c (mark_lcrecord_list): * alloc.c (alloc_managed_lcrecord): * alloc.c (free_managed_lcrecord): * alloc.c (tick_lcrecord_stats): * alloc.c (sweep_lcrecords_1): * buffer.c (print_buffer): * buffer.c (DEFVAR_BUFFER_LOCAL_1): * casetab.c: * casetab.c (print_case_table): * console.c (print_console): * console.c (DEFVAR_CONSOLE_LOCAL_1): * data.c (print_weak_list): * data.c (print_weak_box): * data.c (print_ephemeron): * data.c (ephemeron_equal): * database.c (print_database): * database.c (finalize_database): * device-msw.c (sync_printer_with_devmode): * device-msw.c (print_devmode): * device-msw.c (finalize_devmode): * device.c: * device.c (print_device): * elhash.c: * elhash.c (print_hash_table): * eval.c (print_subr): * eval.c (print_multiple_value): * event-stream.c (event_stream_resignal_wakeup): * events.c (clear_event_resource): * events.c (zero_event): * events.c (print_event): * extents.c: * extents.c (print_extent): * file-coding.c (print_coding_system): * font-mgr.c: * font-mgr.c (Ffc_init): * frame.c: * frame.c (print_frame): * gc.c: * gc.c (GC_CHECK_NOT_FREE): * glyphs.c: * glyphs.c (print_image_instance): * glyphs.c (print_glyph): * gui.c (print_gui_item): * gui.c (copy_gui_item): * keymap.c (print_keymap): * keymap.c (MARKED_SLOT): * lisp.h: * lisp.h (struct Lisp_String): * lisp.h (DEFUN): * lisp.h (DEFUN_NORETURN): * lrecord.h: * lrecord.h (NORMAL_LISP_OBJECT_UID): * lrecord.h (struct lrecord_header): * lrecord.h (set_lheader_implementation): * lrecord.h (struct old_lcrecord_header): * lrecord.h (struct free_lcrecord_header): * marker.c (print_marker): * mule-charset.c: * mule-charset.c (print_charset): * objects.c (print_color_instance): * objects.c (print_font_instance): * objects.c (finalize_font_instance): * print.c (print_cons): * print.c (printing_unreadable_object_fmt): * print.c (printing_unreadable_lisp_object): * print.c (external_object_printer): * print.c (internal_object_printer): * print.c (debug_p4): * print.c (ext_print_begin): * process.c (print_process): * rangetab.c (print_range_table): * rangetab.c (range_table_equal): * scrollbar.c (free_scrollbar_instance): * specifier.c (print_specifier): * specifier.c (finalize_specifier): * symbols.c (guts_of_unbound_marker): * symeval.h: * symeval.h (DEFVAR_SYMVAL_FWD): * tooltalk.c: * tooltalk.c (print_tooltalk_message): * tooltalk.c (print_tooltalk_pattern): * ui-gtk.c (ffi_object_printer): * ui-gtk.c (emacs_gtk_object_printer): * ui-gtk.c (emacs_gtk_boxed_printer): * window.c (print_window): * window.c (free_window_mirror): * window.c (debug_print_window): * xemacs.def.in.in: (1) printing_unreadable_object -> printing_unreadable_object_fmt. (2) printing_unreadable_lcrecord -> printing_unreadable_lisp_object and fix up so it no longer requires an lcrecord. These previous changes eliminate most of the remaining places where the terms `lcrecord' and `lrecord' occurred outside of specialized code. (3) Fairly major change: Reduce the number of words in an lcrecord from 3 to 2. The third word consisted of a uid that duplicated the lrecord uid, and a single free bit, which was moved into the lrecord structure. This reduces the size of the `uid' slot from 21 bits to 20 bits. Arguably this isn't enough -- we could easily have more than 1,000,000 or so objects created in a session. The answer is (a) It doesn't really matter if we overflow the uid field because it's only used for debugging, to identify an object uniquely (or pretty much so). (b) If we cared about it overflowing and wanted to reduce this, we could make it so that cons, string, float and certain other frob-block types that never print out the uid simply don't store a uid in them and don't increment the lrecord_uid_counter. (4) In conjunction with (3), create new macro NORMAL_LISP_OBJECT_UID() and use it to abstract out the differences between NEWGC and old-GC in accessing the `uid' value from a "normal Lisp Object pointer". (5) In events.c, use zero_nonsized_lisp_object() in place of custom- written equivalent. In font-mgr.c use external_object_printer() in place of custom-written equivalents.
author Ben Wing <ben@xemacs.org>
date Sat, 13 Mar 2010 05:38:08 -0600 (2010-03-13)
parents 75b8038f720e
children d27c1ee1943b 308d34e9f07d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
886
011e1bce6ece [xemacs-hg @ 2002-06-28 14:20:41 by michaels]
michaels
parents:
diff changeset
1 ;;; post-gc.el --- post-gc actions
011e1bce6ece [xemacs-hg @ 2002-06-28 14:20:41 by michaels]
michaels
parents:
diff changeset
2
011e1bce6ece [xemacs-hg @ 2002-06-28 14:20:41 by michaels]
michaels
parents:
diff changeset
3 ;; Copyright (C) 1985-1986, 1990, 1992-1997 Free Software Foundation, Inc.
011e1bce6ece [xemacs-hg @ 2002-06-28 14:20:41 by michaels]
michaels
parents:
diff changeset
4 ;; Copyright (c) 1993, 1994 Sun Microsystems, Inc.
011e1bce6ece [xemacs-hg @ 2002-06-28 14:20:41 by michaels]
michaels
parents:
diff changeset
5 ;; Copyright (C) 1995 Board of Trustees, University of Illinois
011e1bce6ece [xemacs-hg @ 2002-06-28 14:20:41 by michaels]
michaels
parents:
diff changeset
6
011e1bce6ece [xemacs-hg @ 2002-06-28 14:20:41 by michaels]
michaels
parents:
diff changeset
7 ;; Author: Mike Sperber <mike@xemacs.org>
011e1bce6ece [xemacs-hg @ 2002-06-28 14:20:41 by michaels]
michaels
parents:
diff changeset
8 ;; Maintainer: XEmacs Development Team
011e1bce6ece [xemacs-hg @ 2002-06-28 14:20:41 by michaels]
michaels
parents:
diff changeset
9 ;; Keywords: internal, dumped
011e1bce6ece [xemacs-hg @ 2002-06-28 14:20:41 by michaels]
michaels
parents:
diff changeset
10
011e1bce6ece [xemacs-hg @ 2002-06-28 14:20:41 by michaels]
michaels
parents:
diff changeset
11 ;; This file is part of XEmacs.
011e1bce6ece [xemacs-hg @ 2002-06-28 14:20:41 by michaels]
michaels
parents:
diff changeset
12
011e1bce6ece [xemacs-hg @ 2002-06-28 14:20:41 by michaels]
michaels
parents:
diff changeset
13 ;; XEmacs is free software; you can redistribute it and/or modify it
011e1bce6ece [xemacs-hg @ 2002-06-28 14:20:41 by michaels]
michaels
parents:
diff changeset
14 ;; under the terms of the GNU General Public License as published by
011e1bce6ece [xemacs-hg @ 2002-06-28 14:20:41 by michaels]
michaels
parents:
diff changeset
15 ;; the Free Software Foundation; either version 2, or (at your option)
011e1bce6ece [xemacs-hg @ 2002-06-28 14:20:41 by michaels]
michaels
parents:
diff changeset
16 ;; any later version.
011e1bce6ece [xemacs-hg @ 2002-06-28 14:20:41 by michaels]
michaels
parents:
diff changeset
17
011e1bce6ece [xemacs-hg @ 2002-06-28 14:20:41 by michaels]
michaels
parents:
diff changeset
18 ;; XEmacs is distributed in the hope that it will be useful, but
011e1bce6ece [xemacs-hg @ 2002-06-28 14:20:41 by michaels]
michaels
parents:
diff changeset
19 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
011e1bce6ece [xemacs-hg @ 2002-06-28 14:20:41 by michaels]
michaels
parents:
diff changeset
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
011e1bce6ece [xemacs-hg @ 2002-06-28 14:20:41 by michaels]
michaels
parents:
diff changeset
21 ;; General Public License for more details.
011e1bce6ece [xemacs-hg @ 2002-06-28 14:20:41 by michaels]
michaels
parents:
diff changeset
22
011e1bce6ece [xemacs-hg @ 2002-06-28 14:20:41 by michaels]
michaels
parents:
diff changeset
23 ;; You should have received a copy of the GNU General Public License
011e1bce6ece [xemacs-hg @ 2002-06-28 14:20:41 by michaels]
michaels
parents:
diff changeset
24 ;; along with XEmacs; see the file COPYING. If not, write to the
011e1bce6ece [xemacs-hg @ 2002-06-28 14:20:41 by michaels]
michaels
parents:
diff changeset
25 ;; Free Software Foundation, 59 Temple Place - Suite 330,
011e1bce6ece [xemacs-hg @ 2002-06-28 14:20:41 by michaels]
michaels
parents:
diff changeset
26 ;; Boston, MA 02111-1307, USA.
011e1bce6ece [xemacs-hg @ 2002-06-28 14:20:41 by michaels]
michaels
parents:
diff changeset
27
011e1bce6ece [xemacs-hg @ 2002-06-28 14:20:41 by michaels]
michaels
parents:
diff changeset
28 ;;; Synched up with: Not in FSF.
011e1bce6ece [xemacs-hg @ 2002-06-28 14:20:41 by michaels]
michaels
parents:
diff changeset
29
011e1bce6ece [xemacs-hg @ 2002-06-28 14:20:41 by michaels]
michaels
parents:
diff changeset
30 ;;; Commentary:
011e1bce6ece [xemacs-hg @ 2002-06-28 14:20:41 by michaels]
michaels
parents:
diff changeset
31
011e1bce6ece [xemacs-hg @ 2002-06-28 14:20:41 by michaels]
michaels
parents:
diff changeset
32 ;; This file is dumped with XEmacs.
011e1bce6ece [xemacs-hg @ 2002-06-28 14:20:41 by michaels]
michaels
parents:
diff changeset
33
011e1bce6ece [xemacs-hg @ 2002-06-28 14:20:41 by michaels]
michaels
parents:
diff changeset
34 ;; This file defines actions to happen after each GC to perform
011e1bce6ece [xemacs-hg @ 2002-06-28 14:20:41 by michaels]
michaels
parents:
diff changeset
35 ;; additional cleanup, call finalizers, etc.
011e1bce6ece [xemacs-hg @ 2002-06-28 14:20:41 by michaels]
michaels
parents:
diff changeset
36
011e1bce6ece [xemacs-hg @ 2002-06-28 14:20:41 by michaels]
michaels
parents:
diff changeset
37 (defun run-finalizers (alist)
011e1bce6ece [xemacs-hg @ 2002-06-28 14:20:41 by michaels]
michaels
parents:
diff changeset
38 "Run the finalizers for all objects that have just become unreachable."
011e1bce6ece [xemacs-hg @ 2002-06-28 14:20:41 by michaels]
michaels
parents:
diff changeset
39 (let ((info (assq 'finalize-list alist)))
011e1bce6ece [xemacs-hg @ 2002-06-28 14:20:41 by michaels]
michaels
parents:
diff changeset
40 (if info
011e1bce6ece [xemacs-hg @ 2002-06-28 14:20:41 by michaels]
michaels
parents:
diff changeset
41 (let ((finalize-list (cdr info)))
011e1bce6ece [xemacs-hg @ 2002-06-28 14:20:41 by michaels]
michaels
parents:
diff changeset
42 (while finalize-list
011e1bce6ece [xemacs-hg @ 2002-06-28 14:20:41 by michaels]
michaels
parents:
diff changeset
43 (funcall (cdr (car finalize-list)) (car (car finalize-list)))
011e1bce6ece [xemacs-hg @ 2002-06-28 14:20:41 by michaels]
michaels
parents:
diff changeset
44 (setq finalize-list (cdr finalize-list)))))))
011e1bce6ece [xemacs-hg @ 2002-06-28 14:20:41 by michaels]
michaels
parents:
diff changeset
45
011e1bce6ece [xemacs-hg @ 2002-06-28 14:20:41 by michaels]
michaels
parents:
diff changeset
46 (add-hook 'post-gc-hook 'run-finalizers)
011e1bce6ece [xemacs-hg @ 2002-06-28 14:20:41 by michaels]
michaels
parents:
diff changeset
47
1591
75b8038f720e [xemacs-hg @ 2003-07-26 14:01:23 by michaels]
michaels
parents: 886
diff changeset
48 (defvar simple-finalizer-ephemerons '()
75b8038f720e [xemacs-hg @ 2003-07-26 14:01:23 by michaels]
michaels
parents: 886
diff changeset
49 "List of ephemerons for objects that have a finalizer attached..")
886
011e1bce6ece [xemacs-hg @ 2002-06-28 14:20:41 by michaels]
michaels
parents:
diff changeset
50
1591
75b8038f720e [xemacs-hg @ 2003-07-26 14:01:23 by michaels]
michaels
parents: 886
diff changeset
51 (defun add-finalizer (object func)
75b8038f720e [xemacs-hg @ 2003-07-26 14:01:23 by michaels]
michaels
parents: 886
diff changeset
52 "Add FUNC as a finalizer for object OBJECT."
75b8038f720e [xemacs-hg @ 2003-07-26 14:01:23 by michaels]
michaels
parents: 886
diff changeset
53 (setq simple-finalizer-ephemerons
75b8038f720e [xemacs-hg @ 2003-07-26 14:01:23 by michaels]
michaels
parents: 886
diff changeset
54 (cons (make-ephemeron object object func)
75b8038f720e [xemacs-hg @ 2003-07-26 14:01:23 by michaels]
michaels
parents: 886
diff changeset
55 simple-finalizer-ephemerons)))
75b8038f720e [xemacs-hg @ 2003-07-26 14:01:23 by michaels]
michaels
parents: 886
diff changeset
56
75b8038f720e [xemacs-hg @ 2003-07-26 14:01:23 by michaels]
michaels
parents: 886
diff changeset
57 (defun cleanup-simple-finalizers (alist)
75b8038f720e [xemacs-hg @ 2003-07-26 14:01:23 by michaels]
michaels
parents: 886
diff changeset
58 "Clean up `simple-finalizer-ephemerons'."
75b8038f720e [xemacs-hg @ 2003-07-26 14:01:23 by michaels]
michaels
parents: 886
diff changeset
59 ;; We have to do this by hand because DELETE-IF isn't defined yet.
75b8038f720e [xemacs-hg @ 2003-07-26 14:01:23 by michaels]
michaels
parents: 886
diff changeset
60 (let ((current simple-finalizer-ephemerons)
75b8038f720e [xemacs-hg @ 2003-07-26 14:01:23 by michaels]
michaels
parents: 886
diff changeset
61 (prev nil))
75b8038f720e [xemacs-hg @ 2003-07-26 14:01:23 by michaels]
michaels
parents: 886
diff changeset
62 (while (not (null current))
75b8038f720e [xemacs-hg @ 2003-07-26 14:01:23 by michaels]
michaels
parents: 886
diff changeset
63 (if (not (ephemeron-ref (car current)))
75b8038f720e [xemacs-hg @ 2003-07-26 14:01:23 by michaels]
michaels
parents: 886
diff changeset
64 (if (null prev)
75b8038f720e [xemacs-hg @ 2003-07-26 14:01:23 by michaels]
michaels
parents: 886
diff changeset
65 (setq simple-finalizer-ephemerons (cdr current))
75b8038f720e [xemacs-hg @ 2003-07-26 14:01:23 by michaels]
michaels
parents: 886
diff changeset
66 (setcdr prev (cdr current)))
75b8038f720e [xemacs-hg @ 2003-07-26 14:01:23 by michaels]
michaels
parents: 886
diff changeset
67 (setq prev current))
75b8038f720e [xemacs-hg @ 2003-07-26 14:01:23 by michaels]
michaels
parents: 886
diff changeset
68 (setq current (cdr current)))))
75b8038f720e [xemacs-hg @ 2003-07-26 14:01:23 by michaels]
michaels
parents: 886
diff changeset
69
75b8038f720e [xemacs-hg @ 2003-07-26 14:01:23 by michaels]
michaels
parents: 886
diff changeset
70 (add-hook 'post-gc-hook 'cleanup-simple-finalizers)