mirror of
https://git.savannah.gnu.org/git/guile.git
synced 2025-05-05 15:10:27 +02:00
664a8b0d66
* module/system/xref.scm (source-procedures): New public procedure, gives the procedures defined at a given source location.
353 lines
13 KiB
Scheme
353 lines
13 KiB
Scheme
;;;; Copyright (C) 2009, 2010 Free Software Foundation, Inc.
|
||
;;;;
|
||
;;;; This library is free software; you can redistribute it and/or
|
||
;;;; modify it under the terms of the GNU Lesser General Public
|
||
;;;; License as published by the Free Software Foundation; either
|
||
;;;; version 2.1 of the License, or (at your option) any later version.
|
||
;;;;
|
||
;;;; This library is distributed in the hope that it will be useful,
|
||
;;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||
;;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||
;;;; Lesser General Public License for more details.
|
||
;;;;
|
||
;;;; You should have received a copy of the GNU Lesser General Public
|
||
;;;; License along with this library; if not, write to the Free Software
|
||
;;;; Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
||
;;;;
|
||
|
||
|
||
(define-module (system xref)
|
||
#:use-module (system base pmatch)
|
||
#:use-module (system base compile)
|
||
#:use-module (system vm program)
|
||
#:use-module (srfi srfi-1)
|
||
#:export (*xref-ignored-modules*
|
||
procedure-callees
|
||
procedure-callers
|
||
source-procedures))
|
||
|
||
;;;
|
||
;;; The cross-reference database: who calls whom.
|
||
;;;
|
||
|
||
(define (program-callee-rev-vars prog)
|
||
(define (cons-uniq x y)
|
||
(if (memq x y) y (cons x y)))
|
||
(cond
|
||
((program-objects prog)
|
||
=> (lambda (objects)
|
||
(let ((n (vector-length objects))
|
||
(progv (make-vector (vector-length objects) #f))
|
||
(asm (decompile (program-objcode prog) #:to 'assembly)))
|
||
(pmatch asm
|
||
((load-program ,labels ,len . ,body)
|
||
(for-each
|
||
(lambda (x)
|
||
(pmatch x
|
||
((toplevel-ref ,n) (vector-set! progv n #t))
|
||
((toplevel-set ,n) (vector-set! progv n #t))))
|
||
body)))
|
||
(let lp ((i 0) (out '()))
|
||
(cond
|
||
((= i n) out)
|
||
((program? (vector-ref objects i))
|
||
(lp (1+ i)
|
||
(fold cons-uniq out
|
||
(program-callee-rev-vars (vector-ref objects i)))))
|
||
((vector-ref progv i)
|
||
(let ((obj (vector-ref objects i)))
|
||
(if (variable? obj)
|
||
(lp (1+ i) (cons-uniq obj out))
|
||
;; otherwise it's an unmemoized binding
|
||
(pmatch obj
|
||
(,sym (guard (symbol? sym))
|
||
(let ((v (module-variable (or (program-module prog)
|
||
the-root-module)
|
||
sym)))
|
||
(lp (1+ i) (if v (cons-uniq v out) out))))
|
||
((,mod ,sym ,public?)
|
||
;; hm, hacky.
|
||
(let* ((m (nested-ref-module (resolve-module '() #f)
|
||
mod))
|
||
(v (and m
|
||
(module-variable
|
||
(if public?
|
||
(module-public-interface m)
|
||
m)
|
||
sym))))
|
||
(lp (1+ i)
|
||
(if v (cons-uniq v out) out))))))))
|
||
(else (lp (1+ i) out)))))))
|
||
(else '())))
|
||
|
||
(define (procedure-callee-rev-vars proc)
|
||
(cond
|
||
((program? proc) (program-callee-rev-vars proc))
|
||
(else '())))
|
||
|
||
(define (procedure-callees prog)
|
||
"Evaluates to a list of the given program callees."
|
||
(let lp ((in (procedure-callee-rev-vars prog)) (out '()))
|
||
(cond ((null? in) out)
|
||
((variable-bound? (car in))
|
||
(lp (cdr in) (cons (variable-ref (car in)) out)))
|
||
(else (lp (cdr in) out)))))
|
||
|
||
;; var -> ((module-name caller ...) ...)
|
||
(define *callers-db* #f)
|
||
;; module-name -> (callee ...)
|
||
(define *module-callees-db* (make-hash-table))
|
||
;; (module-name ...)
|
||
(define *tainted-modules* '())
|
||
|
||
(define *xref-ignored-modules* '((value-history)))
|
||
(define (on-module-modified m)
|
||
(let ((name (module-name m)))
|
||
(if (and (not (member name *xref-ignored-modules*))
|
||
(not (member name *tainted-modules*))
|
||
(pair? name))
|
||
(set! *tainted-modules* (cons name *tainted-modules*)))))
|
||
|
||
(define (add-caller callee caller mod-name)
|
||
(let ((all-callers (hashq-ref *callers-db* callee)))
|
||
(if (not all-callers)
|
||
(hashq-set! *callers-db* callee `((,mod-name ,caller)))
|
||
(let ((callers (assoc mod-name all-callers)))
|
||
(if callers
|
||
(if (not (member caller callers))
|
||
(set-cdr! callers (cons caller (cdr callers))))
|
||
(hashq-set! *callers-db* callee
|
||
(cons `(,mod-name ,caller) all-callers)))))))
|
||
|
||
(define (forget-callers callee mod-name)
|
||
(hashq-set! *callers-db* callee
|
||
(assoc-remove! (hashq-ref *callers-db* callee '()) mod-name)))
|
||
|
||
(define (add-callees callees mod-name)
|
||
(hash-set! *module-callees-db* mod-name
|
||
(append callees (hash-ref *module-callees-db* mod-name '()))))
|
||
|
||
(define (untaint-modules)
|
||
(define (untaint m)
|
||
(for-each (lambda (callee) (forget-callers callee m))
|
||
(hash-ref *module-callees-db* m '()))
|
||
(ensure-callers-db m))
|
||
(ensure-callers-db #f)
|
||
(for-each untaint *tainted-modules*)
|
||
(set! *tainted-modules* '()))
|
||
|
||
(define (ensure-callers-db mod-name)
|
||
(let ((mod (and mod-name (resolve-module mod-name)))
|
||
(visited #f))
|
||
(define (visit-variable var mod-name)
|
||
(if (variable-bound? var)
|
||
(let ((x (variable-ref var)))
|
||
(cond
|
||
((and visited (hashq-ref visited x)))
|
||
((procedure? x)
|
||
(if visited (hashq-set! visited x #t))
|
||
(let ((callees (filter variable-bound?
|
||
(procedure-callee-rev-vars x))))
|
||
(for-each (lambda (callee)
|
||
(add-caller callee x mod-name))
|
||
callees)
|
||
(add-callees callees mod-name)))))))
|
||
|
||
(define (visit-module mod)
|
||
(if visited (hashq-set! visited mod #t))
|
||
(if (not (memq on-module-modified (module-observers mod)))
|
||
(module-observe mod on-module-modified))
|
||
(let ((name (module-name mod)))
|
||
(module-for-each (lambda (sym var)
|
||
(visit-variable var name))
|
||
mod)))
|
||
|
||
(define (visit-submodules mod)
|
||
(hash-for-each
|
||
(lambda (name sub)
|
||
(if (not (and visited (hashq-ref visited sub)))
|
||
(begin
|
||
(visit-module sub)
|
||
(visit-submodules sub))))
|
||
(module-submodules mod)))
|
||
|
||
(cond ((and (not mod-name) (not *callers-db*))
|
||
(set! *callers-db* (make-hash-table 1000))
|
||
(set! visited (make-hash-table 1000))
|
||
(visit-submodules (resolve-module '() #f)))
|
||
(mod-name (visit-module mod)))))
|
||
|
||
(define (procedure-callers var)
|
||
"Returns an association list, keyed by module name, of known callers
|
||
of the given procedure. The latter can specified directly as a
|
||
variable, a symbol (which gets resolved in the current module) or a
|
||
pair of the form (module-name . variable-name), "
|
||
(let ((v (cond ((variable? var) var)
|
||
((symbol? var) (module-variable (current-module) var))
|
||
(else
|
||
(pmatch var
|
||
((,modname . ,sym)
|
||
(module-variable (resolve-module modname) sym))
|
||
(else
|
||
(error "expected a variable, symbol, or (modname . sym)" var)))))))
|
||
(untaint-modules)
|
||
(hashq-ref *callers-db* v '())))
|
||
|
||
|
||
|
||
;;;
|
||
;;; The source database: procedures defined at a given source location.
|
||
;;;
|
||
|
||
;; FIXME: refactor to share code with the xref database.
|
||
|
||
;; ((ip file line . col) ...)
|
||
(define (procedure-sources proc)
|
||
(cond
|
||
((program? proc) (program-sources proc))
|
||
(else '())))
|
||
|
||
;; file -> line -> (proc ...)
|
||
(define *sources-db* #f)
|
||
;; module-name -> proc -> sources
|
||
(define *module-sources-db* (make-hash-table))
|
||
;; (module-name ...)
|
||
(define *tainted-sources* '())
|
||
|
||
(define (on-source-modified m)
|
||
(let ((name (module-name m)))
|
||
(if (and (not (member name *xref-ignored-modules*))
|
||
(not (member name *tainted-sources*))
|
||
(pair? name))
|
||
(set! *tainted-sources* (cons name *tainted-sources*)))))
|
||
|
||
(define (add-source proc file line)
|
||
(let ((file-table (or (hash-ref *sources-db* file)
|
||
(let ((table (make-hash-table)))
|
||
(hash-set! *sources-db* file table)
|
||
table))))
|
||
(hashv-set! file-table
|
||
line
|
||
(cons proc (hashv-ref file-table line '())))))
|
||
|
||
(define (forget-source proc file line)
|
||
(let ((file-table (hash-ref *sources-db* file)))
|
||
(if file-table
|
||
(let ((procs (delq proc (hashv-ref file-table line '()))))
|
||
(if (pair? procs)
|
||
(hashv-set! file-table line procs)
|
||
(hashv-remove! file-table line))))))
|
||
|
||
(define (add-sources proc mod-name)
|
||
(let ((sources (procedure-sources proc)))
|
||
(if (pair? sources)
|
||
(begin
|
||
;; Add proc to *module-sources-db*, for book-keeping.
|
||
(hashq-set! (or (hash-ref *module-sources-db* mod-name)
|
||
(let ((table (make-hash-table)))
|
||
(hash-set! *module-sources-db* mod-name table)
|
||
table))
|
||
proc
|
||
sources)
|
||
;; Actually add the source entries.
|
||
(for-each (lambda (source)
|
||
(pmatch source
|
||
((,ip ,file ,line . ,col)
|
||
(add-source proc file line))
|
||
(else (error "unexpected source format" source))))
|
||
sources)))))
|
||
|
||
(define (forget-sources proc mod-name)
|
||
(let ((mod-table (hash-ref *module-sources-db* mod-name)))
|
||
(if mod-table
|
||
(begin
|
||
;; Forget source entries.
|
||
(for-each (lambda (source)
|
||
(pmatch source
|
||
((,ip ,file ,line . ,col)
|
||
(forget-source proc file line))
|
||
(else (error "unexpected source format" source))))
|
||
(hashq-ref mod-table proc '()))
|
||
;; Forget the proc.
|
||
(hashq-remove! mod-table proc)))))
|
||
|
||
(define (untaint-sources)
|
||
(define (untaint m)
|
||
(for-each (lambda (proc) (forget-sources proc m))
|
||
(cond
|
||
((hash-ref *module-sources-db* m)
|
||
=> (lambda (table)
|
||
(hash-for-each (lambda (proc sources) proc) table)))
|
||
(else '())))
|
||
(ensure-sources-db m))
|
||
(ensure-sources-db #f)
|
||
(for-each untaint *tainted-sources*)
|
||
(set! *tainted-sources* '()))
|
||
|
||
(define (ensure-sources-db mod-name)
|
||
(define (visit-module mod)
|
||
(if (not (memq on-source-modified (module-observers mod)))
|
||
(module-observe mod on-source-modified))
|
||
(let ((name (module-name mod)))
|
||
(module-for-each
|
||
(lambda (sym var)
|
||
(if (variable-bound? var)
|
||
(let ((x (variable-ref var)))
|
||
(if (procedure? x)
|
||
(add-sources x name)))))
|
||
mod)))
|
||
|
||
(define visit-submodules
|
||
(let ((visited #f))
|
||
(lambda (mod)
|
||
(if (not visited)
|
||
(set! visited (make-hash-table)))
|
||
(hash-for-each
|
||
(lambda (name sub)
|
||
(if (not (hashq-ref visited sub))
|
||
(begin
|
||
(hashq-set! visited sub #t)
|
||
(visit-module sub)
|
||
(visit-submodules sub))))
|
||
(module-submodules mod)))))
|
||
|
||
(cond ((and (not mod-name) (not *sources-db*))
|
||
(set! *sources-db* (make-hash-table 1000))
|
||
(visit-submodules (resolve-module '() #f)))
|
||
(mod-name (visit-module (resolve-module mod-name)))))
|
||
|
||
(define (lines->ranges file-table)
|
||
(let ((ranges (make-hash-table)))
|
||
(hash-for-each
|
||
(lambda (line procs)
|
||
(for-each
|
||
(lambda (proc)
|
||
(cond
|
||
((hashq-ref ranges proc)
|
||
=> (lambda (pair)
|
||
(if (< line (car pair))
|
||
(set-car! pair line))
|
||
(if (> line (cdr pair))
|
||
(set-cdr! pair line))))
|
||
(else
|
||
(hashq-set! ranges proc (cons line line)))))
|
||
procs))
|
||
file-table)
|
||
(sort! (hash-map->list cons ranges)
|
||
(lambda (x y) (< (cadr x) (cadr y))))))
|
||
|
||
(define* (source-procedures file line #:key (canonicalization 'relative))
|
||
(ensure-sources-db #f)
|
||
(let* ((port (with-fluids ((%file-port-name-canonicalization canonicalization))
|
||
(false-if-exception (open-input-file file))))
|
||
(file (if port (port-filename port) file))
|
||
(file-table (hash-ref *sources-db* file)))
|
||
(if file-table
|
||
(let lp ((ranges (lines->ranges file-table))
|
||
(procs '()))
|
||
(cond
|
||
((null? ranges) (reverse procs))
|
||
((<= (cadar ranges) line (cddar ranges))
|
||
(lp (cdr ranges) (cons (caar ranges) procs)))
|
||
(else
|
||
(lp (cdr ranges) procs)))))))
|