/usr/share/acl2-8.0dfsg/allegro-acl2-trace.lisp is in acl2-source 8.0dfsg-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 | ; ACL2 Version 8.0 -- A Computational Logic for Applicative Common Lisp
; Copyright (C) 2017, Regents of the University of Texas
; This version of ACL2 is a descendent of ACL2 Version 1.9, Copyright
; (C) 1997 Computational Logic, Inc. See the documentation topic NOTE-2-0.
; This program is free software; you can redistribute it and/or modify
; it under the terms of the LICENSE file distributed with ACL2.
; This program 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
; LICENSE for more details.
; This file originally written by: Robert Krug
; email: rkrug@cs.utexas.edu
; Department of Computer Science
; University of Texas at Austin
; Austin, TX 78712 U.S.A.
; Written by: Matt Kaufmann and J Strother Moore
; email: Kaufmann@cs.utexas.edu and Moore@cs.utexas.edu
; Department of Computer Science
; University of Texas at Austin
; Austin, TX 78712 U.S.A.
; We don't intend this file to be compiled.
; TRACE stuff
; Allegro's trace facilities are somewhat limited. However it does have a
; function, advise, which is sufficiently general to allow it to imitate GCL's
; trace facilities as provided within ACL2. See Franz's documentation for
; information on advise and unadvise.
; We put over into old-trace the macro for trace that comes with Allegro.
; Thus one can type (old-trace foo) and get the effect that (trace
; foo) would have previously provided. We do not guarantee that using
; old-trace works well with trace$, however.
(cond ((null (macro-function 'old-trace))
(setf (macro-function 'old-trace) (macro-function 'trace))))
(cond ((null (macro-function 'old-untrace))
(setf (macro-function 'old-untrace) (macro-function 'untrace))))
; The variables *trace-arglist* and *trace-values* will contain the
; cleaned up arglist and values of a traced function. The alist
; *trace-sublis* allows one to refer to these variables by more
; common names.
(defvar *trace-arglist*)
(defvar *trace-values*)
(defconst *trace-sublis* '((values . *trace-values*)
(si::values . *trace-values*)
(arglist . *trace-arglist*)
(si::arglist . *trace-arglist*)))
; What I am trying to do:
; Trace is called with a list of functions to be traced. Each element of
; this list can be;
; (Let foo be defined in common lisp but not in ACL2, and
; bar be defined within ACL2.)
; 1. the name of a non-acl2 function --- foo,
; 2. the name of an acl2 function --- bar,
; 3. a list whose only element is the name of a non-acl2 function --- (foo),
; 4. a list whose only element is the name of an acl2 function --- (bar),
; 5. a list whose car is the name of a non-acl2 function and whose
; cdr may contain the keywords :entry and :exit, each of which
; are followed by a function whose value will be printed upon
; entry and exit respectively of the function being traced ---
; (foo :entry (list (list 'arg-one (car si::arglist))
; (list 'arg-two (nth 1 si::arglist))))),
; 6. a list whose car is the name of an acl2 function and whose
; cdr may contain the keywords :entry and :exit, each of which
; are followed by a function whose value will be printed upon
; entry and exit respectively of the function being traced ---
; (bar :entry si::arglist
; :exit (if (eql (nth 1 si::arglist)
; (nth 0 values))
; 'FAILED
; (pretty-print-arg (nth 1 values))))
;
; In trace-pre-process we generate a new list as follows, where *1*bar denotes
; (*1*-symbol bar).
; 1. replacing foo with (foo foo),
; 2. replacing bar with (bar bar) & adding (*1*bar bar),
; 3, replacing (foo ...) with (foo foo ...)
; 4. replacing (bar ...) with (bar bar ...) & adding ((*1*bar ...) (bar ...)).
;
; In trace-process we generate suitable calls of advise and unadvise.
;
; Unless explicitly overridden by the :entry or :exit keywords,
; <entry trace-instructions> and <exit trace-instructions> print the
; arguments and returned values respectively. A minor amount of
; cleaning up is done, such as printing |*STATE*| instead of the
; entire state if it is one of the arguments or values.
(defun trace-pre-process (lst)
(let ((new-lst nil))
(dolist (x lst new-lst)
(let ((sym (cond
((symbolp x) x)
((and (consp x) (symbolp (car x)))
(car x))
(t (interface-er "Not a symbol or a cons of a symbol: ~s0" x)))))
(if (function-symbolp sym (w *the-live-state*))
; We have an ACL2 function.
(cond ((symbolp x)
(push (list (*1*-symbol x) x) new-lst)
(push (list x x) new-lst))
(t
(push (list* (*1*-symbol (car x)) (car x) (cdr x))
new-lst)
(push (list* (car x) (car x) (cdr x)) new-lst)))
; We do not have an ACL2 function.
(if (fboundp sym)
(if (symbolp x)
(push (list x x) new-lst)
(push (list* (car x) (car x) (cdr x)) new-lst))
(interface-er "~s0 is not a bound function symbol." sym)))))))
(defun trace-entry-rec (name l entry evisc-tuple)
; We construct the (excl:advise <fn-name> :before ...) form that performs the
; tracing on entry.
(cond ((null l)
`(excl:advise ,name :before nil nil
(progn (setq *trace-arglist* si::arglist)
(custom-trace-ppr
:in
(cons ',name
(trace-hide-world-and-state
,(if entry
(sublis *trace-sublis*
entry)
'*trace-arglist*)))
,@(and evisc-tuple
(list evisc-tuple))))))
((eq (car l) :entry)
(trace-entry-rec name (cdr l) (cadr l) evisc-tuple))
((eq (car l) :evisc-tuple)
(trace-entry-rec name (cdr l) entry (cadr l)))
(t
(trace-entry-rec name (cdr l) entry evisc-tuple))))
(defun trace-entry (name l)
(trace-entry-rec name l nil nil))
; These next two functions were blindly copied from akcl-acl2-trace.lisp
#-acl2-mv-as-values
(defun trace-values (name)
(list* 'list
'(car values)
(let ((mul (trace-multiplicity name *the-live-state*)))
(cond ((or (null mul)
(eql mul 1))
nil)
(t (mv-refs-fn (1- mul)))))))
#+acl2-mv-as-values
(defun trace-values (name)
(declare (ignore name))
'values)
#-acl2-mv-as-values
(defun make-nths (i n var)
(if (zerop n)
nil
(cons `(nth ,i ,var)
(make-nths (1+ i) (1- n) var))))
(defun trace-exit-rec (name original-name l state exit evisc-tuple)
; We construct the (excl:advise <fn-name> :after ...) form that performs the
; tracing on entry.
(cond ((null l)
(cond
((null exit)
`(excl:advise
,name :after nil nil
(progn (setq *trace-values*
(trace-hide-world-and-state
,(trace-values original-name)))
,(protect-mv
`(custom-trace-ppr
:out
(cons ',name *trace-values*)
,@(and evisc-tuple
(list evisc-tuple)))
(trace-multiplicity original-name state)))))
(t
(let ((multiplicity (trace-multiplicity original-name state)))
`(excl:advise
,name :after nil nil
(progn ,(protect-mv
`(progn (setq *trace-values*
(trace-hide-world-and-state
,(trace-values original-name)))
(setq *trace-arglist* (trace-hide-world-and-state
si::arglist)))
multiplicity)
,(protect-mv
`(custom-trace-ppr
:out
(cons ',name
,(sublis *trace-sublis* exit))
,@(and evisc-tuple
(list evisc-tuple)))
multiplicity)))))))
((eq (car l) :exit)
(trace-exit-rec name original-name (cdr l) state (cadr l) evisc-tuple))
((eq (car l) :evisc-tuple)
(trace-exit-rec name original-name (cdr l) state exit (cadr l)))
(t
(trace-exit-rec name original-name (cdr l) state exit evisc-tuple))))
(defun trace-exit (name original-name l)
(trace-exit-rec name original-name l *the-live-state* nil nil))
(defun traced-fns-lst (lst)
(list 'QUOTE (mapcar #'car lst)))
(defun trace-process (lst)
; We perform a little error checking, and gather together all the (excl:advise
; ...) functions.
(let ((new-lst (list (traced-fns-lst lst)))) ; for the returned value
(dolist (x lst new-lst)
(cond ((member :cond (cddr x))
(interface-er "The use of :cond is not supported in ~
Allegro."))
((member :break (cddr x))
(interface-er "The use of :break is not supported in ~
Allegro. However, you can use either ~
(~s0 :entry (break$)) or (~s0 :exit (break$)). ~
See any Lisp documentation for more on ~
break and its options." (car x)))
(t
(push (trace-exit (car x) (cadr x) (cddr x)) new-lst)
(push (trace-entry (car x) (cddr x)) new-lst)
(push `(excl:unadvise ,(car x)) new-lst))))))
(excl:without-package-locks
(defmacro trace (&rest fns)
(if fns
(cons 'progn
(trace-process (trace-pre-process fns)))
'(excl::advised-functions))))
(excl:without-package-locks
(defmacro untrace (&rest fns)
(if (null fns)
'(prog1 (excl::advised-functions)
(excl:unadvise))
(cons
'progn
(let ((ans nil))
(dolist (fn fns ans)
(push `(excl:unadvise ,fn) ans)
(push `(excl:unadvise ,(*1*-symbol fn)) ans)))))))
|