1 ;;; find-gc.el --- detect functions that call the garbage collector
3 ;; Copyright (C) 1992, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
7 ;; This file is part of GNU Emacs.
9 ;; GNU Emacs is free software; you can redistribute it and/or modify
10 ;; it under the terms of the GNU General Public License as published by
11 ;; the Free Software Foundation; either version 2, or (at your option)
14 ;; GNU Emacs is distributed in the hope that it will be useful,
15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 ;; GNU General Public License for more details.
19 ;; You should have received a copy of the GNU General Public License
20 ;; along with GNU Emacs; see the file COPYING. If not, write to the
21 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
22 ;; Boston, MA 02110-1301, USA.
26 ;; Produce in find-gc-unsafe-list the set of all functions that may invoke GC.
27 ;; This expects the Emacs sources to live in find-gc-source-directory.
28 ;; It creates a temporary working directory /tmp/esrc.
32 (defvar find-gc-unsafe-list nil
33 "The list of unsafe functions is placed here by `find-gc-unsafe'.")
35 (defvar find-gc-source-directory
)
37 (defvar find-gc-subrs-callers nil
38 "Alist of users of subrs, from GC testing.
39 Each entry has the form (FUNCTION . FUNCTIONS-THAT-CALL-IT).")
41 (defvar find-gc-subrs-called nil
42 "Alist of subrs called, in GC testing.
43 Each entry has the form (FUNCTION . FUNCTIONS-IT-CALLS).")
46 ;;; Functions on this list are safe, even if they appear to be able
47 ;;; to call the target.
49 (defvar find-gc-noreturn-list
'(Fsignal Fthrow wrong_type_argument
))
51 ;;; This was originally generated directory-files, but there were
52 ;;; too many files there that were not actually compiled. The
53 ;;; list below was created for a HP-UX 7.0 system.
55 (defvar find-gc-source-files
56 '("dispnew.c" "scroll.c" "xdisp.c" "window.c"
57 "term.c" "cm.c" "emacs.c" "keyboard.c" "macros.c"
58 "keymap.c" "sysdep.c" "buffer.c" "filelock.c"
59 "insdel.c" "marker.c" "minibuf.c" "fileio.c"
60 "dired.c" "filemode.c" "cmds.c" "casefiddle.c"
61 "indent.c" "search.c" "regex.c" "undo.c"
62 "alloc.c" "data.c" "doc.c" "editfns.c"
63 "callint.c" "eval.c" "fns.c" "print.c" "lread.c"
64 "abbrev.c" "syntax.c" "unexec.c"
65 "bytecode.c" "process.c" "callproc.c" "doprnt.c"
66 "x11term.c" "x11fns.c"))
69 (defun find-gc-unsafe ()
70 "Return a list of unsafe functions--that is, which can call GC.
71 Also store it in `find-gc-unsafe'."
74 (find-unsafe-funcs 'Fgarbage_collect
)
75 (setq find-gc-unsafe-list
76 (sort find-gc-unsafe-list
77 (function (lambda (x y
)
78 (string-lessp (car x
) (car y
))))))
81 ;;; This does a depth-first search to find all functions that can
82 ;;; ultimately call the function "target". The result is an a-list
83 ;;; in find-gc-unsafe-list; the cars are the unsafe functions, and the cdrs
84 ;;; are (one of) the unsafe functions that these functions directly
87 (defun find-unsafe-funcs (target)
88 (setq find-gc-unsafe-list
(list (list target
)))
92 (defun trace-unsafe (func)
93 (let ((used (assq func find-gc-subrs-callers
)))
95 (error "No find-gc-subrs-callers for %s" (car find-gc-unsafe-list
)))
96 (while (setq used
(cdr used
))
97 (or (assq (car used
) find-gc-unsafe-list
)
98 (memq (car used
) find-gc-noreturn-list
)
100 (push (cons (car used
) func
) find-gc-unsafe-list
)
101 (trace-unsafe (car used
))))))
107 (defun trace-call-tree (&optional already-setup
)
108 (message "Setting up directories...")
111 ;; Gee, wouldn't a built-in "system" function be handy here.
112 (call-process "csh" nil nil nil
"-c" "rm -rf /tmp/esrc")
113 (call-process "csh" nil nil nil
"-c" "mkdir /tmp/esrc")
114 (call-process "csh" nil nil nil
"-c"
115 (format "ln -s %s/*.[ch] /tmp/esrc"
116 find-gc-source-directory
))))
118 (set-buffer (get-buffer-create "*Trace Call Tree*"))
119 (setq find-gc-subrs-called nil
)
120 (let ((case-fold-search nil
)
121 (files find-gc-source-files
)
124 (message "Compiling %s..." (car files
))
125 (call-process "csh" nil nil nil
"-c"
126 (format "gcc -dr -c /tmp/esrc/%s -o /dev/null"
129 (insert-file-contents (concat "/tmp/esrc/" (car files
) ".rtl"))
130 (while (re-search-forward ";; Function \\|(call_insn " nil t
)
131 (if (= (char-after (- (point) 3)) ?o
)
133 (looking-at "[a-zA-Z0-9_]+")
134 (setq name
(intern (buffer-substring (match-beginning 0)
136 (message "%s : %s" (car files
) name
)
137 (setq entry
(list name
)
138 find-gc-subrs-called
(cons entry find-gc-subrs-called
)))
139 (if (looking-at ".*\n?.*\"\\([A-Za-z0-9_]+\\)\"")
141 (setq name
(intern (buffer-substring (match-beginning 1)
143 (or (memq name
(cdr entry
))
144 (setcdr entry
(cons name
(cdr entry
))))))))
145 (delete-file (concat "/tmp/esrc/" (car files
) ".rtl"))
146 (setq files
(cdr files
)))))
150 (defun trace-use-tree ()
151 (setq find-gc-subrs-callers
(mapcar 'list
(mapcar 'car find-gc-subrs-called
)))
152 (let ((ptr find-gc-subrs-called
)
156 (while (setq p2
(cdr p2
))
157 (if (setq found
(assq (car p2
) find-gc-subrs-callers
))
158 (setcdr found
(cons (car (car ptr
)) (cdr found
)))))
159 (setq ptr
(cdr ptr
))))
164 ;;; arch-tag: 4a26a538-a008-40d9-a1ef-23bb6dbecef4
165 ;;; find-gc.el ends here