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
|
; C Library
;
; Copyright (C) 2021 Kestrel Institute (http://www.kestrel.edu)
; Copyright (C) 2021 Kestrel Technology LLC (http://kestreltechnology.com)
;
; License: A 3-clause BSD license. See the LICENSE file distributed with ACL2.
;
; Author: Alessandro Coglio (coglio@kestrel.edu)
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
(in-package "C")
(include-book "integer-operations")
(include-book "kestrel/std/system/check-and-call" :dir :system)
(include-book "kestrel/std/system/check-or-call" :dir :system)
(include-book "kestrel/std/system/check-list-call" :dir :system)
(include-book "kestrel/std/system/check-mv-let-call" :dir :system)
(include-book "kestrel/std/system/irecursivep-plus" :dir :system)
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
(defxdoc+ atc-term-recognizers
:parents (atc-implementation)
:short "Recognizers of ACL2 terms for ATC."
:long
(xdoc::topstring
(xdoc::p
"The user documentation of ATC
defines various kinds of ACL2 terms
that represent various C constructs.
ATC checks these various kinds of terms
as part of translating them to C.")
(xdoc::p
"Here we provide utilities to recognize these terms.
While these utilities are not needed, and are not part of,
ATC's C code generation code,
they may be useful for external tools,
such as APT transformations that work in synergy with ATC.")
(xdoc::p
"For now we provide shallow recognizers,
which do not thoroughly check the terms and their subterms,
but that suffice to distinguish the various kinds of terms.
We only provide these recognizers for some kinds of terms for now."))
:order-subtopics t
:default-parent t)
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
(defval *atc-boolean-from-type-fns*
:short "List of the @('boolean-from-<type>') functions
described in the user documentation."
(atc-boolean-from-type-fns-gen *integer-nonbool-nonchar-types*)
:prepwork
((defun atc-boolean-from-type-fns-gen (types)
(cond ((endp types) nil)
(t (cons (pack 'boolean-from- (type-kind (car types)))
(atc-boolean-from-type-fns-gen (cdr types))))))))
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
(defval *atc-type-base-const-fns*
:short "List of the @('<type>-<base>-const') functions
described in the user documentation."
(atc-type-base-const-fns-gen *integer-nonbool-nonchar-types*)
:prepwork
((defun atc-type-base-const-fns-gen-aux (type bases)
(cond ((endp bases) nil)
(t (cons (pack (type-kind type) '- (car bases) '-const)
(atc-type-base-const-fns-gen-aux type (cdr bases))))))
(defun atc-type-base-const-fns-gen (types)
(cond ((endp types) nil)
(t (append (atc-type-base-const-fns-gen-aux (car types)
'(dec
oct
hex))
(atc-type-base-const-fns-gen (cdr types))))))))
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
(defval *atc-op-type-fns*
:short "List of the @('<op>-<type>') functions
described in the user documentation."
(atc-op-type-fns-gen *integer-nonbool-nonchar-types*)
:prepwork
((defun atc-op-type-fns-gen-aux (type ops)
(cond ((endp ops) nil)
(t (cons (pack (car ops) '- (type-kind type))
(atc-op-type-fns-gen-aux type (cdr ops))))))
(defun atc-op-type-fns-gen (types)
(cond ((endp types) nil)
(t (append (atc-op-type-fns-gen-aux (car types)
'(plus
minus
bitnot
lognot))
(atc-op-type-fns-gen (cdr types))))))))
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
(defval *atc-op-type1-type2-fns*
:short "List of the @('<op>-<type1>-<type2>') functions
described in the user documentation."
(atc-op-type1-type2-fns-gen *integer-nonbool-nonchar-types*)
:prepwork
((defun atc-op-type1-type2-fns-gen-aux-aux (type1 type2 ops)
(cond ((endp ops) nil)
(t (cons (pack (car ops) '- (type-kind type1) '- (type-kind type2))
(atc-op-type1-type2-fns-gen-aux-aux type1
type2
(cdr ops))))))
(defun atc-op-type1-type2-fns-gen-aux (type1 type2s)
(cond ((endp type2s) nil)
(t (append (atc-op-type1-type2-fns-gen-aux-aux type1
(car type2s)
'(add
sub
mul
div
rem
shl
shr
lt
gt
le
ge
eq
ne
bitand
bitxor
bitior))
(atc-op-type1-type2-fns-gen-aux type1
(cdr type2s))))))
(defun atc-op-type1-type2-fns-gen (type1s)
(cond ((endp type1s) nil)
(t (append (atc-op-type1-type2-fns-gen-aux
(car type1s)
*integer-nonbool-nonchar-types*)
(atc-op-type1-type2-fns-gen (cdr type1s))))))))
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
(defval *atc-type1-from-type2-fns*
:short "List of the @('<type1>-from-<type2>') functions
described in the user documentation."
(atc-type1-from-type2-fns-gen *integer-nonbool-nonchar-types*)
:prepwork
((defun atc-type1-from-type2-fns-gen-aux (type1 type2s)
(cond ((endp type2s) nil)
(t (append (and (not (equal type1 (car type2s)))
(list (pack (type-kind type1)
'-from-
(type-kind (car type2s)))))
(atc-type1-from-type2-fns-gen-aux type1 (cdr type2s))))))
(defun atc-type1-from-type2-fns-gen (type1s)
(cond ((endp type1s) nil)
(t (append (atc-type1-from-type2-fns-gen-aux
(car type1s)
*integer-nonbool-nonchar-types*)
(atc-type1-from-type2-fns-gen (cdr type1s))))))))
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
(define atc-boolean-termp ((term pseudo-termp))
:returns (yes/no booleanp)
:short "Recognize expression terms returning booleans."
:long
(xdoc::topstring
(xdoc::p
"We just check whether the term is
a call of a @('boolean-from-<type>') function
or a call of @(tsee not), @(tsee and), or @(tsee or)."))
(b* (((mv andp & &) (check-and-call term))
((when andp) t)
((mv orp & &) (check-or-call term))
((when orp) t))
(case-match term
((fn . &) (if (or (member-eq fn *atc-boolean-from-type-fns*)
(eq fn 'not))
t
nil))
(& nil))))
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
(define atc-pure-c-valued-termp ((term pseudo-termp))
:returns (yes/no booleanp)
:short "Recognize pure expression terms returning C values terms."
:long
(xdoc::topstring
(xdoc::p
"We just check that the term is either a variable
or a call of one of the functions
listed in the user documentation for
pure expression terms returning C values."))
(b* (((when (variablep term)) t))
(case-match term
((fn . &)
(if (or (member-eq fn *atc-type-base-const-fns*)
(member-eq fn *atc-op-type-fns*)
(member-eq fn *atc-op-type1-type2-fns*)
(member-eq fn *atc-type1-from-type2-fns*)
(eq fn 'uchar-array-read-sint)
(eq fn 'sint-from-boolean)
(eq fn 'condexpr))
t
nil))
(& nil))))
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
(define atc-c-valued-termp ((term pseudo-termp) (wrld plist-worldp))
:returns (yes/no booleanp)
:short "Recognize expression terms returning C values."
:long
(xdoc::topstring
(xdoc::p
"We just check whether the term is
either a pure expression term returning a C value
or is a call of a non-recursive function,
which we therefore assume to be a target function."))
(b* (((when (atc-pure-c-valued-termp term)) t))
(case-match term
((fn . &) (and (symbolp fn)
(not (irecursivep+ fn wrld))))
(& nil))))
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
(define atc-stmt-noncval-termp ((term pseudo-termp) (wrld plist-worldp))
:returns (yes/no booleanp)
:short "Recognize statement terms that are not
expression terms returning C values."
:long
(xdoc::topstring
(xdoc::p
"We just check if the term is
an @(tsee if), an @(tsee mv), a @(tsee let), an @(tsee mv-let),
or a call of a recursive function,
which we therefore assume to be a target function."))
(b* (((mv ifp & & &) (check-if-call term))
((when ifp) t)
((mv mvp &) (check-list-call term))
((when mvp) t)
((mv mv-letp & & & & & &) (check-mv-let-call term))
((when mv-letp) t))
(case-match term
((fn . &) (or (consp fn) ; lambda
(consp (irecursivep+ fn wrld))))
(& nil))))
|
