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
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
|
; VL 2014 -- VL Verilog Toolkit, 2014 Edition
; Copyright (C) 2008-2015 Centaur Technology
;
; Contact:
; Centaur Technology Formal Verification Group
; 7600-C N. Capital of Texas Highway, Suite 300, Austin, TX 78731, USA.
; http://www.centtech.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@centtech.com>
(in-package "VL2014")
(include-book "base")
(include-book "../paramdecls")
(define vl-pretty-paramtype ((x vl-paramtype-p))
(vl-paramtype-case x
(:vl-implicitvalueparam
(append '(:implicit)
(if x.sign (list x.sign) nil)
(if x.range (list (vl-pretty-range x.range)) nil)
(if x.default
(list '= (vl-pretty-expr x.default))
nil)))
(:vl-explicitvalueparam
(append '(:explicit)
(list (vl-pretty-datatype x.type))
(if x.default
(list '= (vl-pretty-expr x.default))
nil)))
(:vl-typeparam
(append '(:type)
(if x.default
(list '= (vl-pretty-datatype x.default))
nil)))))
(define vl-pretty-paramdecl ((x vl-paramdecl-p))
(b* (((vl-paramdecl x) x))
(append (list x.name)
(if x.localp (list :local) nil)
(vl-pretty-paramtype x.type))))
(define vl-pretty-paramdecls ((x vl-paramdecllist-p))
(if (atom x)
nil
(cons (vl-pretty-paramdecl (car x))
(vl-pretty-paramdecls (cdr x)))))
(defaggregate vl-paramdecltest
((input stringp)
(expect "pretty paramdecls that we expect.")
(successp booleanp :default t)
(pre-usertypes string-listp "pre-defined user types")))
(deflist vl-paramdecltestlist-p (x)
(vl-paramdecltest-p x))
(define make-paramdecltests-fail ((x vl-paramdecltestlist-p))
(if (atom x)
nil
(cons (change-vl-paramdecltest (car x) :successp nil)
(make-paramdecltests-fail (cdr x)))))
(local (defthm crock
(implies (string-listp x)
(vl-usertypes-p (make-lookup-alist x)))
:hints(("Goal" :in-theory (enable make-lookup-alist)))))
(defparser-top vl-parse-param-or-localparam-declaration
:guard (and (vl-atts-p atts)
;; Types says what kinds (local or nonlocal) of parameters we permit
(true-listp types)
(subsetp types '(:vl-kwd-parameter :vl-kwd-localparam)))
:resulttype vl-paramdecllist-p)
(define vl-run-paramdecltest ((test vl-paramdecltest-p)
(config vl-loadconfig-p))
(b* (((vl-paramdecltest test) test)
(tokens (make-test-tokens test.input))
(pstate (make-vl-parsestate :warnings 'blah-warnings
:usertypes (make-lookup-alist test.pre-usertypes)))
(atts '(("blah")))
(- (cw "~|-----~%Parsing as ~x0: ~s1~%" (vl-loadconfig->edition config) test.input))
((mv err val ?tokens (vl-parsestate pstate))
(vl-parse-param-or-localparam-declaration-top atts '(:vl-kwd-parameter :vl-kwd-localparam)))
(- (vl-parsestate-free pstate))
((when err)
(if test.successp
(raise "Expected successful test but got error: ~s0" err)
(prog2$ (cw "ERR: ~x0.~%" err) t)))
(pretty (vl-pretty-paramdecls val))
(- (cw "VAL: ~x0.~%" val))
(- (cw "Pretty value: ~x0.~%" pretty))
(- (cw "Expected: ~x0.~%" test.expect))
(- (or (equal pstate.warnings 'blah-warnings)
(raise "warnings aren't right?")))
((unless test.successp)
(or err
(raise "Expected failure, but no error.~%"))))
(or (equal pretty test.expect)
(raise "Pretty value not as expected."))))
(define vl-run-paramdecltests ((tests vl-paramdecltestlist-p)
(config vl-loadconfig-p))
(or (atom tests)
(and (vl-run-paramdecltest (car tests) config)
(vl-run-paramdecltests (cdr tests) config))))
(progn
(defconst *basic-tests*
(list
;; Basic tests for implicitly/partially typed value parameters
(make-vl-paramdecltest :input "" :successp nil)
(make-vl-paramdecltest :input "a" :successp nil)
(make-vl-paramdecltest :input "3" :successp nil)
(make-vl-paramdecltest :input "hello = 1" :successp nil)
(make-vl-paramdecltest :input "parameter" :successp nil)
(make-vl-paramdecltest :input "localparam" :successp nil)
;; Local parameters are required to have default value expressions
(make-vl-paramdecltest :input "localparam a" :successp nil)
(make-vl-paramdecltest :input "localparam a, b" :successp nil)
;; Some tests with default values
(make-vl-paramdecltest :input "parameter a = 1"
:expect '(("a" :implicit = 1)))
(make-vl-paramdecltest :input "localparam a = 1"
:expect '(("a" :local :implicit = 1)))
(make-vl-paramdecltest :input "localparam a = 1, b" ;; b must have a default value
:successp nil)
(make-vl-paramdecltest :input "parameter a = 1, b = 2"
:expect '(("a" :implicit = 1)
("b" :implicit = 2)))
(make-vl-paramdecltest :input "parameter a = 1, b = 2"
:expect '(("a" :implicit = 1)
("b" :implicit = 2)))
(make-vl-paramdecltest :input "localparam a = 1, b = 2"
:expect '(("a" :local :implicit = 1)
("b" :local :implicit = 2)))
(make-vl-paramdecltest :input "parameter a = 1 : 2 : 3"
:expect '(("a" :implicit = (:vl-mintypmax nil 1 2 3))))
(make-vl-paramdecltest :input "localparam a = 1 : 2 : 3"
:expect '(("a" :local :implicit = (:vl-mintypmax nil 1 2 3))))
(make-vl-paramdecltest :input "localparam a = 1, b = 1 : 2 : 3"
:expect '(("a" :local :implicit = 1)
("b" :local :implicit = (:vl-mintypmax nil 1 2 3))))
(make-vl-paramdecltest :input "localparam signed a = 1, b = 1 : 2 : 3"
:expect '(("a" :local :implicit :vl-signed = 1)
("b" :local :implicit :vl-signed = (:vl-mintypmax nil 1 2 3))))
(make-vl-paramdecltest :input "localparam signed a = 1, c, b = 1 : 2 : 3" ;; c has no default value
:successp nil)
(make-vl-paramdecltest :input "localparam signed [7:8] a = 1, b = 1 : 2 : 3"
:expect '(("a" :local :implicit :vl-signed (range 7 8) = 1)
("b" :local :implicit :vl-signed (range 7 8) = (:vl-mintypmax nil 1 2 3))))
(make-vl-paramdecltest :input "localparam [7:8] signed a = 1, b = 1 : 2 : 3" ;; signed must come before range
:successp nil)
(make-vl-paramdecltest :input "parameter [7:8] unsigned a" ;; unsigned must come before range
:successp nil)
(make-vl-paramdecltest :input "parameter [7:8] a = 1, b = 1 : 2 : 3"
:expect '(("a" :implicit (range 7 8) = 1)
("b" :implicit (range 7 8) = (:vl-mintypmax nil 1 2 3))))
(make-vl-paramdecltest :input "localparam [7:8] a = 1, b = 1 : 2 : 3"
:expect '(("a" :local :implicit (range 7 8) = 1)
("b" :local :implicit (range 7 8) = (:vl-mintypmax nil 1 2 3))))
;; Special types that are supported in both Verilog-2005 and SystemVerilog-2012.
(make-vl-paramdecltest :input "parameter integer a = 1, b = 2"
:expect '(("a" :explicit (:vl-integer signed) = 1)
("b" :explicit (:vl-integer signed) = 2)))
(make-vl-paramdecltest :input "parameter integer [7:0] a = 1, b = 2" ;; no ranges on integer
:successp nil)
(make-vl-paramdecltest :input "parameter [7:0] integer a = 1, b = 2" ;; no ranges on integer
:successp nil)
(make-vl-paramdecltest :input "parameter real a = 1, b = 2"
:expect '(("a" :explicit (:vl-real unsigned) = 1)
("b" :explicit (:vl-real unsigned) = 2)))
(make-vl-paramdecltest :input "parameter real [7:0] a = 1, b = 2" ;; no ranges on real
:successp nil)
(make-vl-paramdecltest :input "parameter [7:0] real a = 1, b = 2" ;; no ranges on real
:successp nil)
(make-vl-paramdecltest :input "parameter real signed a = 1, b = 2" ;; no signed for real
:successp nil)
(make-vl-paramdecltest :input "parameter signed real a = 1, b = 2" ;; no signed for real
:successp nil)
(make-vl-paramdecltest :input "parameter time a = 1, b = 2"
:expect '(("a" :explicit (:vl-time unsigned) = 1)
("b" :explicit (:vl-time unsigned) = 2)))
(make-vl-paramdecltest :input "parameter time [7:0] a = 1, b = 2" ;; no ranges on time
:successp nil)
(make-vl-paramdecltest :input "parameter [7:0] time a = 1, b = 2" ;; no ranges on time
:successp nil)
(make-vl-paramdecltest :input "parameter realtime a = 1, b = 2"
:expect '(("a" :explicit (:vl-realtime unsigned) = 1)
("b" :explicit (:vl-realtime unsigned) = 2)))
(make-vl-paramdecltest :input "parameter realtime [7:0] a = 1, b = 2" ;; no ranges on realtime
:successp nil)
(make-vl-paramdecltest :input "parameter [7:0] realtime a = 1, b = 2" ;; no ranges on realtime
:successp nil)
(make-vl-paramdecltest :input "parameter foo_t = 1"
:pre-usertypes nil
:expect '(("foo_t" :implicit = 1)))
))
(assert! (vl-run-paramdecltests *basic-tests* (make-vl-loadconfig :edition :system-verilog-2012)))
(assert! (vl-run-paramdecltests *basic-tests* (make-vl-loadconfig :edition :verilog-2005)))
(defconst *sysv-only-tests*
;; Tests that should work in SystemVerilog but not in Verilog-2005.
(list
;; In SystemVerilog, global parameters are not required to have default
;; values:
(make-vl-paramdecltest :input "parameter a"
:expect '(("a" :implicit)))
(make-vl-paramdecltest :input "parameter a, b"
:expect '(("a" :implicit)
("b" :implicit)))
(make-vl-paramdecltest :input "parameter a = 1, b"
:expect '(("a" :implicit = 1)
("b" :implicit)))
(make-vl-paramdecltest :input "parameter a = 1, b = 1 : 2 : 3, c"
:expect '(("a" :implicit = 1)
("b" :implicit = (:vl-mintypmax nil 1 2 3))
("c" :implicit)))
(make-vl-paramdecltest :input "parameter signed a = 1, c, b = 1 : 2 : 3"
:expect '(("a" :implicit :vl-signed = 1)
("c" :implicit :vl-signed)
("b" :implicit :vl-signed = (:vl-mintypmax nil 1 2 3))))
(make-vl-paramdecltest :input "parameter [7:8] a = 1, c, b = 1 : 2 : 3"
:expect '(("a" :implicit (range 7 8) = 1)
("c" :implicit (range 7 8))
("b" :implicit (range 7 8) = (:vl-mintypmax nil 1 2 3))))
(make-vl-paramdecltest :input "parameter signed [7:8] a = 1, c, b = 1 : 2 : 3"
:expect '(("a" :implicit :vl-signed (range 7 8) = 1)
("c" :implicit :vl-signed (range 7 8))
("b" :implicit :vl-signed (range 7 8) = (:vl-mintypmax nil 1 2 3))))
(make-vl-paramdecltest :input "parameter integer a = 1, b = 2, c"
:expect '(("a" :explicit (:vl-integer signed) = 1)
("b" :explicit (:vl-integer signed) = 2)
("c" :explicit (:vl-integer signed))))
;; In SystemVerilog the signing can also be 'unsigned', which isn't permitted in Verilog-2005.
(make-vl-paramdecltest :input "parameter unsigned a"
:expect '(("a" :implicit :vl-unsigned)))
(make-vl-paramdecltest :input "parameter unsigned [7:0] a"
:expect '(("a" :implicit :vl-unsigned (range 7 0))))
(make-vl-paramdecltest :input "parameter unsigned [7:0] a, b = 3"
:expect '(("a" :implicit :vl-unsigned (range 7 0))
("b" :implicit :vl-unsigned (range 7 0) = 3)))
;; In SystemVerilog the rhs can be a dollar sign.
(make-vl-paramdecltest :input "parameter a = $"
:expect '(("a" :implicit = (key :vl-$))))
;; In SystemVerilog the parameters can be of arbitrary data types.
(make-vl-paramdecltest :input "parameter foo_t = 1" ;; don't allow shadowed params to avoid ambiguity
:pre-usertypes '("foo_t")
:successp nil)
(make-vl-paramdecltest :input "parameter foo_t a = 1"
:expect '(("a" :explicit (:vl-usertype (type "foo_t")) = 1))
:pre-usertypes '("foo_t"))
(make-vl-paramdecltest :input "parameter foo_t a = 1, b"
:expect '(("a" :explicit (:vl-usertype (type "foo_t")) = 1)
("b" :explicit (:vl-usertype (type "foo_t"))))
:pre-usertypes '("foo_t"))
(make-vl-paramdecltest :input "parameter struct { int field; } a = 1"
:expect '(("a" :explicit (:vl-struct ("field" :vl-int signed)) = 1)))
(make-vl-paramdecltest :input "parameter struct { int field; } a = 1, b, c = 2"
:expect '(("a" :explicit (:vl-struct ("field" :vl-int signed)) = 1)
("b" :explicit (:vl-struct ("field" :vl-int signed)))
("c" :explicit (:vl-struct ("field" :vl-int signed)) = 2)))
))
(assert! (vl-run-paramdecltests *sysv-only-tests*
(make-vl-loadconfig :edition :system-verilog-2012)))
(assert! (vl-run-paramdecltests (make-paramdecltests-fail *sysv-only-tests*)
(make-vl-loadconfig :edition :verilog-2005))))
#||
(defmacro trace-parser (fn)
`(trace$ (,fn
:entry (list ',fn
:tokens (vl-tokenlist->string-with-spaces tokens)
:pstate pstate)
:exit (list :errmsg (first values)
:val (second values)
:remainder (vl-tokenlist->string-with-spaces
(third values))
:next-token (and (consp (third values))
(vl-token->type (car (third values))))
:pstate (fourth values)))))
(trace-parser vl-parse-param-or-localparam-declaration-fn)
(trace-parser vl-parse-param-assignment-fn)
(trace-parser vl-parse-type-assignment-fn)
(trace-parser vl-parse-datatype-fn)
(trace-parser vl-parse-simple-type-fn)
||#
|
