[cabec2]: src / compiler / typetran.lisp Maximize Restore History

Download this file

typetran.lisp    565 lines (532 with data), 22.3 kB

  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
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
;;;; This file contains stuff that implements the portable IR1
;;;; semantics of type tests and coercion. The main thing we do is
;;;; convert complex type operations into simpler code that can be
;;;; compiled inline.
;;;; This software is part of the SBCL system. See the README file for
;;;; more information.
;;;;
;;;; This software is derived from the CMU CL system, which was
;;;; written at Carnegie Mellon University and released into the
;;;; public domain. The software is in the public domain and is
;;;; provided with absolutely no warranty. See the COPYING and CREDITS
;;;; files for more information.
(in-package "SB!C")
;;;; type predicate translation
;;;;
;;;; We maintain a bidirectional association between type predicates
;;;; and the tested type. The presence of a predicate in this
;;;; association implies that it is desirable to implement tests of
;;;; this type using the predicate. These are either predicates that
;;;; the back end is likely to have special knowledge about, or
;;;; predicates so complex that the only reasonable implentation is
;;;; via function call.
;;;;
;;;; Some standard types (such as SEQUENCE) are best tested by letting
;;;; the TYPEP source transform do its thing with the expansion. These
;;;; types (and corresponding predicates) are not maintained in this
;;;; association. In this case, there need not be any predicate
;;;; function unless it is required by the Common Lisp specification.
;;;;
;;;; The mapping between predicates and type structures is considered
;;;; part of the backend; different backends can support different
;;;; sets of predicates.
;;; Establish an association between the type predicate NAME and the
;;; corresponding TYPE. This causes the type predicate to be
;;; recognized for purposes of optimization.
(defmacro define-type-predicate (name type)
`(%define-type-predicate ',name ',type))
(defun %define-type-predicate (name specifier)
(let ((type (specifier-type specifier)))
(setf (gethash name *backend-predicate-types*) type)
(setf *backend-type-predicates*
(cons (cons type name)
(remove name *backend-type-predicates*
:key #'cdr)))
(%deftransform name '(function (t) *) #'fold-type-predicate)
name))
;;;; IR1 transforms
;;; If we discover the type argument is constant during IR1
;;; optimization, then give the source transform another chance. The
;;; source transform can't pass, since we give it an explicit
;;; constant. At worst, it will convert to %TYPEP, which will prevent
;;; spurious attempts at transformation (and possible repeated
;;; warnings.)
(deftransform typep ((object type))
(unless (constant-continuation-p type)
(give-up-ir1-transform "can't open-code test of non-constant type"))
`(typep object ',(continuation-value type)))
;;; If the continuation OBJECT definitely is or isn't of the specified
;;; type, then return T or NIL as appropriate. Otherwise quietly
;;; GIVE-UP-IR1-TRANSFORM.
(defun ir1-transform-type-predicate (object type)
(declare (type continuation object) (type ctype type))
(let ((otype (continuation-type object)))
(cond ((not (types-equal-or-intersect otype type))
nil)
((csubtypep otype type)
t)
((eq type *empty-type*)
nil)
(t
(give-up-ir1-transform)))))
;;; Flush %TYPEP tests whose result is known at compile time.
(deftransform %typep ((object type))
(unless (constant-continuation-p type)
(give-up-ir1-transform))
(ir1-transform-type-predicate
object
(ir1-transform-specifier-type (continuation-value type))))
;;; This is the IR1 transform for simple type predicates. It checks
;;; whether the single argument is known to (not) be of the
;;; appropriate type, expanding to T or NIL as appropriate.
(deftransform fold-type-predicate ((object) * * :node node :defun-only t)
(let ((ctype (gethash (leaf-source-name
(ref-leaf
(continuation-use
(basic-combination-fun node))))
*backend-predicate-types*)))
(aver ctype)
(ir1-transform-type-predicate object ctype)))
;;; If FIND-CLASS is called on a constant class, locate the CLASS-CELL
;;; at load time.
(deftransform find-class ((name) ((constant-arg symbol)) *)
(let* ((name (continuation-value name))
(cell (find-class-cell name)))
`(or (class-cell-class ',cell)
(error "class not yet defined: ~S" name))))
;;;; standard type predicates, i.e. those defined in package COMMON-LISP,
;;;; plus at least one oddball (%INSTANCEP)
;;;;
;;;; Various other type predicates (e.g. low-level representation
;;;; stuff like SIMPLE-ARRAY-SINGLE-FLOAT-P) are defined elsewhere.
;;; FIXME: This function is only called once, at top level. Why not
;;; just expand all its operations into toplevel code?
(defun !define-standard-type-predicates ()
(define-type-predicate arrayp array)
; (The ATOM predicate is handled separately as (NOT CONS).)
(define-type-predicate bit-vector-p bit-vector)
(define-type-predicate characterp character)
(define-type-predicate compiled-function-p compiled-function)
(define-type-predicate complexp complex)
(define-type-predicate complex-rational-p (complex rational))
(define-type-predicate complex-float-p (complex float))
(define-type-predicate consp cons)
(define-type-predicate floatp float)
(define-type-predicate functionp function)
(define-type-predicate integerp integer)
(define-type-predicate keywordp keyword)
(define-type-predicate listp list)
(define-type-predicate null null)
(define-type-predicate numberp number)
(define-type-predicate rationalp rational)
(define-type-predicate realp real)
(define-type-predicate simple-bit-vector-p simple-bit-vector)
(define-type-predicate simple-string-p simple-string)
(define-type-predicate simple-vector-p simple-vector)
(define-type-predicate stringp string)
(define-type-predicate %instancep instance)
(define-type-predicate funcallable-instance-p funcallable-instance)
(define-type-predicate symbolp symbol)
(define-type-predicate vectorp vector))
(!define-standard-type-predicates)
;;;; transforms for type predicates not implemented primitively
;;;;
;;;; See also VM dependent transforms.
(define-source-transform atom (x)
`(not (consp ,x)))
;;;; TYPEP source transform
;;; Return a form that tests the variable N-OBJECT for being in the
;;; binds specified by TYPE. BASE is the name of the base type, for
;;; declaration. We make SAFETY locally 0 to inhibit any checking of
;;; this assertion.
#!-negative-zero-is-not-zero
(defun transform-numeric-bound-test (n-object type base)
(declare (type numeric-type type))
(let ((low (numeric-type-low type))
(high (numeric-type-high type)))
`(locally
(declare (optimize (safety 0)))
(and ,@(when low
(if (consp low)
`((> (truly-the ,base ,n-object) ,(car low)))
`((>= (truly-the ,base ,n-object) ,low))))
,@(when high
(if (consp high)
`((< (truly-the ,base ,n-object) ,(car high)))
`((<= (truly-the ,base ,n-object) ,high))))))))
#!+negative-zero-is-not-zero
(defun transform-numeric-bound-test (n-object type base)
(declare (type numeric-type type))
(let ((low (numeric-type-low type))
(high (numeric-type-high type))
(float-type-p (csubtypep type (specifier-type 'float)))
(x (gensym))
(y (gensym)))
`(locally
(declare (optimize (safety 0)))
(and ,@(when low
(if (consp low)
`((let ((,x (truly-the ,base ,n-object))
(,y ,(car low)))
,(if (not float-type-p)
`(> ,x ,y)
`(if (and (zerop ,x) (zerop ,y))
(> (float-sign ,x) (float-sign ,y))
(> ,x ,y)))))
`((let ((,x (truly-the ,base ,n-object))
(,y ,low))
,(if (not float-type-p)
`(>= ,x ,y)
`(if (and (zerop ,x) (zerop ,y))
(>= (float-sign ,x) (float-sign ,y))
(>= ,x ,y)))))))
,@(when high
(if (consp high)
`((let ((,x (truly-the ,base ,n-object))
(,y ,(car high)))
,(if (not float-type-p)
`(< ,x ,y)
`(if (and (zerop ,x) (zerop ,y))
(< (float-sign ,x) (float-sign ,y))
(< ,x ,y)))))
`((let ((,x (truly-the ,base ,n-object))
(,y ,high))
,(if (not float-type-p)
`(<= ,x ,y)
`(if (and (zerop ,x) (zerop ,y))
(<= (float-sign ,x) (float-sign ,y))
(<= ,x ,y)))))))))))
;;; Do source transformation of a test of a known numeric type. We can
;;; assume that the type doesn't have a corresponding predicate, since
;;; those types have already been picked off. In particular, CLASS
;;; must be specified, since it is unspecified only in NUMBER and
;;; COMPLEX. Similarly, we assume that COMPLEXP is always specified.
;;;
;;; For non-complex types, we just test that the number belongs to the
;;; base type, and then test that it is in bounds. When CLASS is
;;; INTEGER, we check to see whether the range is no bigger than
;;; FIXNUM. If so, we check for FIXNUM instead of INTEGER. This allows
;;; us to use fixnum comparison to test the bounds.
;;;
;;; For complex types, we must test for complex, then do the above on
;;; both the real and imaginary parts. When CLASS is float, we need
;;; only check the type of the realpart, since the format of the
;;; realpart and the imagpart must be the same.
(defun source-transform-numeric-typep (object type)
(let* ((class (numeric-type-class type))
(base (ecase class
(integer (containing-integer-type type))
(rational 'rational)
(float (or (numeric-type-format type) 'float))
((nil) 'real))))
(once-only ((n-object object))
(ecase (numeric-type-complexp type)
(:real
`(and (typep ,n-object ',base)
,(transform-numeric-bound-test n-object type base)))
(:complex
`(and (complexp ,n-object)
,(once-only ((n-real `(realpart (truly-the complex ,n-object)))
(n-imag `(imagpart (truly-the complex ,n-object))))
`(progn
,n-imag ; ignorable
(and (typep ,n-real ',base)
,@(when (eq class 'integer)
`((typep ,n-imag ',base)))
,(transform-numeric-bound-test n-real type base)
,(transform-numeric-bound-test n-imag type
base))))))))))
;;; Do the source transformation for a test of a hairy type. AND,
;;; SATISFIES and NOT are converted into the obvious code. We convert
;;; unknown types to %TYPEP, emitting an efficiency note if
;;; appropriate.
(defun source-transform-hairy-typep (object type)
(declare (type hairy-type type))
(let ((spec (hairy-type-specifier type)))
(cond ((unknown-type-p type)
(when (policy *lexenv* (> speed inhibit-warnings))
(compiler-note "can't open-code test of unknown type ~S"
(type-specifier type)))
`(%typep ,object ',spec))
(t
(ecase (first spec)
(satisfies `(if (funcall #',(second spec) ,object) t nil))
((not and)
(once-only ((n-obj object))
`(,(first spec) ,@(mapcar (lambda (x)
`(typep ,n-obj ',x))
(rest spec))))))))))
(defun source-transform-negation-typep (object type)
(declare (type negation-type type))
(let ((spec (type-specifier (negation-type-type type))))
`(not (typep ,object ',spec))))
;;; Do source transformation for TYPEP of a known union type. If a
;;; union type contains LIST, then we pull that out and make it into a
;;; single LISTP call. Note that if SYMBOL is in the union, then LIST
;;; will be a subtype even without there being any (member NIL). We
;;; just drop through to the general code in this case, rather than
;;; trying to optimize it.
(defun source-transform-union-typep (object type)
(let* ((types (union-type-types type))
(ltype (specifier-type 'list))
(mtype (find-if #'member-type-p types)))
(if (and mtype (csubtypep ltype type))
(let ((members (member-type-members mtype)))
(once-only ((n-obj object))
`(or (listp ,n-obj)
(typep ,n-obj
'(or ,@(mapcar #'type-specifier
(remove (specifier-type 'cons)
(remove mtype types)))
(member ,@(remove nil members)))))))
(once-only ((n-obj object))
`(or ,@(mapcar (lambda (x)
`(typep ,n-obj ',(type-specifier x)))
types))))))
;;; Do source transformation for TYPEP of a known intersection type.
(defun source-transform-intersection-typep (object type)
(once-only ((n-obj object))
`(and ,@(mapcar (lambda (x)
`(typep ,n-obj ',(type-specifier x)))
(intersection-type-types type)))))
;;; If necessary recurse to check the cons type.
(defun source-transform-cons-typep (object type)
(let* ((car-type (cons-type-car-type type))
(cdr-type (cons-type-cdr-type type)))
(let ((car-test-p (not (or (type= car-type *wild-type*)
(type= car-type (specifier-type t)))))
(cdr-test-p (not (or (type= cdr-type *wild-type*)
(type= cdr-type (specifier-type t))))))
(if (and (not car-test-p) (not cdr-test-p))
`(consp ,object)
(once-only ((n-obj object))
`(and (consp ,n-obj)
,@(if car-test-p
`((typep (car ,n-obj)
',(type-specifier car-type))))
,@(if cdr-test-p
`((typep (cdr ,n-obj)
',(type-specifier cdr-type))))))))))
;;; Return the predicate and type from the most specific entry in
;;; *TYPE-PREDICATES* that is a supertype of TYPE.
(defun find-supertype-predicate (type)
(declare (type ctype type))
(let ((res nil)
(res-type nil))
(dolist (x *backend-type-predicates*)
(let ((stype (car x)))
(when (and (csubtypep type stype)
(or (not res-type)
(csubtypep stype res-type)))
(setq res-type stype)
(setq res (cdr x)))))
(values res res-type)))
;;; Return forms to test that OBJ has the rank and dimensions
;;; specified by TYPE, where STYPE is the type we have checked against
;;; (which is the same but for dimensions.)
(defun test-array-dimensions (obj type stype)
(declare (type array-type type stype))
(let ((obj `(truly-the ,(type-specifier stype) ,obj))
(dims (array-type-dimensions type)))
(unless (eq dims '*)
(collect ((res))
(when (eq (array-type-dimensions stype) '*)
(res `(= (array-rank ,obj) ,(length dims))))
(do ((i 0 (1+ i))
(dim dims (cdr dim)))
((null dim))
(let ((dim (car dim)))
(unless (eq dim '*)
(res `(= (array-dimension ,obj ,i) ,dim)))))
(res)))))
;;; If we can find a type predicate that tests for the type without
;;; dimensions, then use that predicate and test for dimensions.
;;; Otherwise, just do %TYPEP.
(defun source-transform-array-typep (obj type)
(multiple-value-bind (pred stype) (find-supertype-predicate type)
(if (and (array-type-p stype)
;; (If the element type hasn't been defined yet, it's
;; not safe to assume here that it will eventually
;; have (UPGRADED-ARRAY-ELEMENT-TYPE type)=T, so punt.)
(not (unknown-type-p (array-type-element-type type)))
(type= (array-type-specialized-element-type stype)
(array-type-specialized-element-type type))
(eq (array-type-complexp stype) (array-type-complexp type)))
(once-only ((n-obj obj))
`(and (,pred ,n-obj)
,@(test-array-dimensions n-obj type stype)))
`(%typep ,obj ',(type-specifier type)))))
;;; Transform a type test against some instance type. The type test is
;;; flushed if the result is known at compile time. If not properly
;;; named, error. If sealed and has no subclasses, just test for
;;; layout-EQ. If a structure then test for layout-EQ and then a
;;; general test based on layout-inherits. If safety is important,
;;; then we also check whether the layout for the object is invalid
;;; and signal an error if so. Otherwise, look up the indirect
;;; class-cell and call CLASS-CELL-TYPEP at runtime.
(deftransform %instance-typep ((object spec) (* *) * :node node)
(aver (constant-continuation-p spec))
(let* ((spec (continuation-value spec))
(class (specifier-type spec))
(name (sb!xc:class-name class))
(otype (continuation-type object))
(layout (let ((res (info :type :compiler-layout name)))
(if (and res (not (layout-invalid res)))
res
nil))))
(cond
;; Flush tests whose result is known at compile time.
((not (types-equal-or-intersect otype class))
nil)
((csubtypep otype class)
t)
;; If not properly named, error.
((not (and name (eq (sb!xc:find-class name) class)))
(compiler-error "can't compile TYPEP of anonymous or undefined ~
class:~% ~S"
class))
(t
;; Delay the type transform to give type propagation a chance.
(delay-ir1-transform node :constraint)
;; Otherwise transform the type test.
(multiple-value-bind (pred get-layout)
(cond
((csubtypep class (specifier-type 'funcallable-instance))
(values 'funcallable-instance-p '%funcallable-instance-layout))
((csubtypep class (specifier-type 'instance))
(values '%instancep '%instance-layout))
(t
(values '(lambda (x) (declare (ignore x)) t) 'layout-of)))
(cond
((and (eq (class-state class) :sealed) layout
(not (class-subclasses class)))
;; Sealed and has no subclasses.
(let ((n-layout (gensym)))
`(and (,pred object)
(let ((,n-layout (,get-layout object)))
,@(when (policy *lexenv* (>= safety speed))
`((when (layout-invalid ,n-layout)
(%layout-invalid-error object ',layout))))
(eq ,n-layout ',layout)))))
((and (typep class 'basic-structure-class) layout)
;; structure type tests; hierarchical layout depths
(let ((depthoid (layout-depthoid layout))
(n-layout (gensym)))
`(and (,pred object)
(let ((,n-layout (,get-layout object)))
,@(when (policy *lexenv* (>= safety speed))
`((when (layout-invalid ,n-layout)
(%layout-invalid-error object ',layout))))
(if (eq ,n-layout ',layout)
t
(and (> (layout-depthoid ,n-layout)
,depthoid)
(locally (declare (optimize (safety 0)))
(eq (svref (layout-inherits ,n-layout)
,depthoid)
',layout))))))))
((and layout (>= (layout-depthoid layout) 0))
;; hierarchical layout depths for other things (e.g.
;; CONDITIONs)
(let ((depthoid (layout-depthoid layout))
(n-layout (gensym))
(n-inherits (gensym)))
`(and (,pred object)
(let ((,n-layout (,get-layout object)))
,@(when (policy *lexenv* (>= safety speed))
`((when (layout-invalid ,n-layout)
(%layout-invalid-error object ',layout))))
(if (eq ,n-layout ',layout)
t
(let ((,n-inherits (layout-inherits ,n-layout)))
(declare (optimize (safety 0)))
(and (> (length ,n-inherits) ,depthoid)
(eq (svref ,n-inherits ,depthoid)
',layout))))))))
(t
(/noshow "default case -- ,PRED and CLASS-CELL-TYPEP")
`(and (,pred object)
(class-cell-typep (,get-layout object)
',(find-class-cell name)
object)))))))))
;;; If the specifier argument is a quoted constant, then we consider
;;; converting into a simple predicate or other stuff. If the type is
;;; constant, but we can't transform the call, then we convert to
;;; %TYPEP. We only pass when the type is non-constant. This allows us
;;; to recognize between calls that might later be transformed
;;; successfully when a constant type is discovered. We don't give an
;;; efficiency note when we pass, since the IR1 transform will give
;;; one if necessary and appropriate.
;;;
;;; If the type is TYPE= to a type that has a predicate, then expand
;;; to that predicate. Otherwise, we dispatch off of the type's type.
;;; These transformations can increase space, but it is hard to tell
;;; when, so we ignore policy and always do them.
(define-source-transform typep (object spec)
;; KLUDGE: It looks bad to only do this on explicitly quoted forms,
;; since that would overlook other kinds of constants. But it turns
;; out that the DEFTRANSFORM for TYPEP detects any constant
;; continuation, transforms it into a quoted form, and gives this
;; source transform another chance, so it all works out OK, in a
;; weird roundabout way. -- WHN 2001-03-18
(if (and (consp spec) (eq (car spec) 'quote))
(let ((type (careful-specifier-type (cadr spec))))
(or (when (not type)
(compiler-warn "illegal type specifier for TYPEP: ~S"
(cadr spec))
`(%typep ,object ,spec))
(let ((pred (cdr (assoc type *backend-type-predicates*
:test #'type=))))
(when pred `(,pred ,object)))
(typecase type
(hairy-type
(source-transform-hairy-typep object type))
(negation-type
(source-transform-negation-typep object type))
(union-type
(source-transform-union-typep object type))
(intersection-type
(source-transform-intersection-typep object type))
(member-type
`(member ,object ',(member-type-members type)))
(args-type
(compiler-warn "illegal type specifier for TYPEP: ~S"
(cadr spec))
`(%typep ,object ,spec))
(t nil))
(typecase type
(numeric-type
(source-transform-numeric-typep object type))
(sb!xc:class
`(%instance-typep ,object ,spec))
(array-type
(source-transform-array-typep object type))
(cons-type
(source-transform-cons-typep object type))
(t nil))
`(%typep ,object ,spec)))
(values nil t)))
;;;; coercion
(deftransform coerce ((x type) (* *) * :node node)
(unless (constant-continuation-p type)
(give-up-ir1-transform))
(let ((tspec (ir1-transform-specifier-type (continuation-value type))))
(if (csubtypep (continuation-type x) tspec)
'x
;; Note: The THE here makes sure that specifiers like
;; (SINGLE-FLOAT 0.0 1.0) can raise a TYPE-ERROR.
`(the ,(continuation-value type)
,(cond
((csubtypep tspec (specifier-type 'double-float))
'(%double-float x))
;; FIXME: #!+long-float (t ,(error "LONG-FLOAT case needed"))
((csubtypep tspec (specifier-type 'float))
'(%single-float x))
((and (csubtypep tspec (specifier-type 'simple-vector))
(policy node (< safety 3)))
`(if (simple-vector-p x)
x
(replace (make-array (length x)) x)))
;; FIXME: other VECTOR types?
(t
(give-up-ir1-transform)))))))