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
|
; Milawa - A Reflective Theorem Prover
; Copyright (C) 2005-2009 Kookamara LLC
;
; Contact:
;
; Kookamara LLC
; 11410 Windermere Meadows
; Austin, TX 78759, USA
; http://www.kookamara.com/
;
; License: (An MIT/X11-style license)
;
; Permission is hereby granted, free of charge, to any person obtaining a
; copy of this software and associated documentation files (the "Software"),
; to deal in the Software without restriction, including without limitation
; the rights to use, copy, modify, merge, publish, distribute, sublicense,
; and/or sell copies of the Software, and to permit persons to whom the
; Software is furnished to do so, subject to the following conditions:
;
; The above copyright notice and this permission notice shall be included in
; all copies or substantial portions of the Software.
;
; THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
; IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
; FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
; AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
; LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
; FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
; DEALINGS IN THE SOFTWARE.
;
; Original author: Jared Davis <jared@kookamara.com>
(in-package "ACL2")
(defun kwote-list (x)
(declare (xargs :mode :program))
(if (consp x)
(cons (kwote (car x))
(kwote-list (cdr x)))
nil))
(mutual-recursion
(defun add-tracing (term)
(declare (xargs :mode :program))
(cond ((variablep term)
term)
((fquotep term)
term)
((not (consp term))
term)
(t
(let* ((fn (ffn-symb term))
(args (fargs term))
(traced-args (add-tracing-list args)))
`(prog2$ (cw "~x0 ==> ~x1~%"
',term
,(cons fn traced-args))
,term)))))
(defun add-tracing-list (term-list)
(declare (xargs :mode :program))
(if (consp term-list)
(cons (add-tracing (car term-list))
(add-tracing-list (cdr term-list)))
nil)))
(defun debug-guards-fn (term world)
(declare (xargs :mode :program))
(let* ((fn (car term))
(actuals (kwote-list (cdr term)))
(formals (formals fn world))
(guard (guard fn nil world))
(sigma (pairlis$ formals actuals))
(guard-sub (sublis-expr sigma guard))
(guard-sub-untrans (untranslate guard-sub nil world)))
(add-tracing guard-sub-untrans)))
(defmacro debug-guards (form)
;;; The following legacy doc string was replaced Nov. 2014 by the
;;; auto-generated defxdoc form just below.
; ":Doc-Section Miscellaneous
; identify the cause of a guard violation. ~/
; If a function has an elaborate guard, it may be difficult to tell which
; part of the guard is being violated when a guard violation occurs. The
; ~c[debug-guards] function may be useful in identifying the problem. ~/
; Below is a trivial example. We define a function with several inputs
; and require that each input be a natural.
; ~bv[]
; ACL2 !> (defun f (a b c d e)
; (declare (xargs :guard (and (natp a)
; (natp b)
; (natp c)
; (natp d)
; (natp e))))
; (list a b c d e))
; ~ev[]
; We can now use debug-guards to see what would happen when we try to
; run this function on various arguments. For example, perhaps we do
; not realize that the symbol d is not a natural. Then, debug-guards
; will show us why this function call will fail:
; ~bv[]
; ACL2 !> (debug-guards '(f 1 2 3 d 5))
; (NATP 1) ==> T
; (NATP 2) ==> T
; (NATP 3) ==> T
; (NATP 'D) ==> NIL
; (AND (NATP 1) (NATP 2) (NATP 3) (NATP 'D) (NATP 5)) ==> NIL
; ~ev[]
; The argument to debug-guards should be a quoted function call, but
; you can also perform evaluation ahead of time, e.g., using ~c[list]
; as follows:
; ~bv[]
; ACL2 !> (defconst *d* 'd)
; ACL2 !> (debug-guards (list 'f 1 2 3 *d* 5))
; (NATP 1) ==> T
; (NATP 2) ==> T
; (NATP 3) ==> T
; (NATP 'D) ==> NIL
; (AND (NATP 1) (NATP 2) (NATP 3) (NATP 'D) (NATP 5)) ==> NIL
; ~ev[]
; ~/"
`(let ((dbg-form (debug-guards-fn ,form (w state))))
(er-progn (trans-eval dbg-form 'debug-guards state)
(value :invisible))))
(include-book "xdoc/top" :dir :system)
(defxdoc debug-guards
:parents (miscellaneous)
:short "Identify the cause of a guard violation."
:long "<p>If a function has an elaborate guard, it may be difficult to tell
which part of the guard is being violated when a guard violation occurs. The
@('debug-guards') function may be useful in identifying the problem.</p>
<p>Below is a trivial example. We define a function with several inputs and
require that each input be a natural.</p>
@({
ACL2 !> (defun f (a b c d e)
(declare (xargs :guard (and (natp a)
(natp b)
(natp c)
(natp d)
(natp e))))
(list a b c d e))
})
<p>We can now use debug-guards to see what would happen when we try to run
this function on various arguments. For example, perhaps we do not realize
that the symbol d is not a natural. Then, debug-guards will show us why this
function call will fail:</p>
@({
ACL2 !> (debug-guards '(f 1 2 3 d 5))
(NATP 1) ==> T
(NATP 2) ==> T
(NATP 3) ==> T
(NATP 'D) ==> NIL
(AND (NATP 1) (NATP 2) (NATP 3) (NATP 'D) (NATP 5)) ==> NIL
})
<p>The argument to debug-guards should be a quoted function call, but you can
also perform evaluation ahead of time, e.g., using @('list') as follows:</p>
@({
ACL2 !> (defconst *d* 'd)
ACL2 !> (debug-guards (list 'f 1 2 3 *d* 5))
(NATP 1) ==> T
(NATP 2) ==> T
(NATP 3) ==> T
(NATP 'D) ==> NIL
(AND (NATP 1) (NATP 2) (NATP 3) (NATP 'D) (NATP 5)) ==> NIL
})
")
|
