1 ;;; open-coding primitive procedures
3 ;; Copyright (C) 2009, 2010, 2011, 2012, 2013 Free Software Foundation, Inc.
5 ;;;; This library is free software; you can redistribute it and/or
6 ;;;; modify it under the terms of the GNU Lesser General Public
7 ;;;; License as published by the Free Software Foundation; either
8 ;;;; version 3 of the License, or (at your option) any later version.
10 ;;;; This library is distributed in the hope that it will be useful,
11 ;;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
12 ;;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 ;;;; Lesser General Public License for more details.
15 ;;;; You should have received a copy of the GNU Lesser General Public
16 ;;;; License along with this library; if not, write to the Free Software
17 ;;;; Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 (define-module (language tree-il primitives)
22 #:use-module (system base pmatch)
23 #:use-module (ice-9 match)
24 #:use-module (rnrs bytevectors)
25 #:use-module (system base syntax)
26 #:use-module (language tree-il)
27 #:use-module (srfi srfi-4)
28 #:use-module (srfi srfi-16)
29 #:export (resolve-primitives add-interesting-primitive!
31 effect-free-primitive? effect+exception-free-primitive?
32 constructor-primitive?
33 singly-valued-primitive? equality-primitive?
37 ;; When adding to this, be sure to update *multiply-valued-primitives*
39 (define *interesting-primitive-names*
42 call-with-current-continuation
49 + * - / 1- 1+ quotient remainder modulo
50 ash logand logior logxor lognot
52 pair? null? list? symbol? vector? string? struct? number? char? nil?
56 complex? real? rational? inf? nan? integer? exact? inexact? even? odd?
58 char<? char<=? char>=? char>?
60 integer->char char->integer number->string string->number
71 caaar caadr cadar caddr cdaar cdadr cddar cdddr
73 caaaar caaadr caadar caaddr cadaar cadadr caddar cadddr
74 cdaaar cdaadr cdadar cdaddr cddaar cddadr cdddar cddddr
78 make-vector vector-length vector-ref vector-set!
79 variable? variable-ref variable-set!
82 current-module define!
84 fluid-ref fluid-set! with-fluid*
87 abort-to-prompt* abort-to-prompt
92 string-length string-ref string-set!
94 allocate-struct struct-vtable make-struct struct-ref struct-set!
96 bytevector-u8-ref bytevector-u8-set!
97 bytevector-s8-ref bytevector-s8-set!
98 u8vector-ref u8vector-set! s8vector-ref s8vector-set!
100 bytevector-u16-ref bytevector-u16-set!
101 bytevector-u16-native-ref bytevector-u16-native-set!
102 bytevector-s16-ref bytevector-s16-set!
103 bytevector-s16-native-ref bytevector-s16-native-set!
104 u16vector-ref u16vector-set! s16vector-ref s16vector-set!
106 bytevector-u32-ref bytevector-u32-set!
107 bytevector-u32-native-ref bytevector-u32-native-set!
108 bytevector-s32-ref bytevector-s32-set!
109 bytevector-s32-native-ref bytevector-s32-native-set!
110 u32vector-ref u32vector-set! s32vector-ref s32vector-set!
112 bytevector-u64-ref bytevector-u64-set!
113 bytevector-u64-native-ref bytevector-u64-native-set!
114 bytevector-s64-ref bytevector-s64-set!
115 bytevector-s64-native-ref bytevector-s64-native-set!
116 u64vector-ref u64vector-set! s64vector-ref s64vector-set!
118 bytevector-ieee-single-ref bytevector-ieee-single-set!
119 bytevector-ieee-single-native-ref bytevector-ieee-single-native-set!
120 bytevector-ieee-double-ref bytevector-ieee-double-set!
121 bytevector-ieee-double-native-ref bytevector-ieee-double-native-set!
122 f32vector-ref f32vector-set! f64vector-ref f64vector-set!))
124 (define (add-interesting-primitive! name)
125 (hashq-set! *interesting-primitive-vars*
126 (or (module-variable (current-module) name)
127 (error "unbound interesting primitive" name))
130 (define *interesting-primitive-vars* (make-hash-table))
132 (for-each add-interesting-primitive! *interesting-primitive-names*)
134 (define *primitive-constructors*
135 ;; Primitives that return a fresh object.
136 '(acons cons cons* list vector make-vector
137 allocate-struct make-struct make-struct/no-tail
140 (define *primitive-accessors*
141 ;; Primitives that are pure, but whose result depends on the mutable
142 ;; memory pointed to by their operands.
144 ;; Note: if you add an accessor here, be sure to add a corresponding
145 ;; case in (language tree-il effects)!
151 bytevector-u8-ref bytevector-s8-ref
152 bytevector-u16-ref bytevector-u16-native-ref
153 bytevector-s16-ref bytevector-s16-native-ref
154 bytevector-u32-ref bytevector-u32-native-ref
155 bytevector-s32-ref bytevector-s32-native-ref
156 bytevector-u64-ref bytevector-u64-native-ref
157 bytevector-s64-ref bytevector-s64-native-ref
158 bytevector-ieee-single-ref bytevector-ieee-single-native-ref
159 bytevector-ieee-double-ref bytevector-ieee-double-native-ref))
161 (define *effect-free-primitives*
165 ash logand logior logxor lognot
166 + * - / 1- 1+ quotient remainder modulo
168 pair? null? nil? list?
169 symbol? variable? vector? struct? string? number? char?
170 complex? real? rational? inf? nan? integer? exact? inexact? even? odd?
171 char<? char<=? char>=? char>?
172 integer->char char->integer number->string string->number
174 length string-length vector-length
175 ;; These all should get expanded out by expand-primitives.
177 caaar caadr cadar caddr cdaar cdadr cddar cdddr
178 caaaar caaadr caadar caaddr cadaar cadadr caddar cadddr
179 cdaaar cdaadr cdadar cdaddr cddaar cddadr cdddar cddddr
180 ,@*primitive-constructors*
181 ,@*primitive-accessors*))
183 ;; Like *effect-free-primitives* above, but further restricted in that they
184 ;; cannot raise exceptions.
185 (define *effect+exception-free-primitives*
189 pair? null? nil? list?
190 symbol? variable? vector? struct? string? number? char?
192 acons cons cons* list vector))
194 ;; Primitives that don't always return one value.
195 (define *multiply-valued-primitives*
198 call-with-current-continuation
203 @abort abort-to-prompt))
205 ;; Procedures that cause a nonlocal, non-resumable abort.
206 (define *bailout-primitives*
207 '(throw error scm-error))
209 ;; Negatable predicates.
210 (define *negatable-primitives*
213 ;; (< <= > >=) are not negatable because of NaNs.
217 (define *equality-primitives*
220 (define *effect-free-primitive-table* (make-hash-table))
221 (define *effect+exceptions-free-primitive-table* (make-hash-table))
222 (define *equality-primitive-table* (make-hash-table))
223 (define *multiply-valued-primitive-table* (make-hash-table))
224 (define *bailout-primitive-table* (make-hash-table))
225 (define *negatable-primitive-table* (make-hash-table))
227 (for-each (lambda (x)
228 (hashq-set! *effect-free-primitive-table* x #t))
229 *effect-free-primitives*)
230 (for-each (lambda (x)
231 (hashq-set! *effect+exceptions-free-primitive-table* x #t))
232 *effect+exception-free-primitives*)
233 (for-each (lambda (x)
234 (hashq-set! *equality-primitive-table* x #t))
235 *equality-primitives*)
236 (for-each (lambda (x)
237 (hashq-set! *multiply-valued-primitive-table* x #t))
238 *multiply-valued-primitives*)
239 (for-each (lambda (x)
240 (hashq-set! *bailout-primitive-table* x #t))
241 *bailout-primitives*)
242 (for-each (lambda (x)
243 (hashq-set! *negatable-primitive-table* (car x) (cdr x))
244 (hashq-set! *negatable-primitive-table* (cdr x) (car x)))
245 *negatable-primitives*)
247 (define (constructor-primitive? prim)
248 (memq prim *primitive-constructors*))
249 (define (effect-free-primitive? prim)
250 (hashq-ref *effect-free-primitive-table* prim))
251 (define (effect+exception-free-primitive? prim)
252 (hashq-ref *effect+exceptions-free-primitive-table* prim))
253 (define (equality-primitive? prim)
254 (hashq-ref *equality-primitive-table* prim))
255 (define (singly-valued-primitive? prim)
256 (not (hashq-ref *multiply-valued-primitive-table* prim)))
257 (define (bailout-primitive? prim)
258 (hashq-ref *bailout-primitive-table* prim))
259 (define (negate-primitive prim)
260 (hashq-ref *negatable-primitive-table* prim))
262 (define (resolve-primitives x mod)
263 (define local-definitions
266 ;; Assume that any definitions with primitive names in the root module
267 ;; have the same semantics as the primitives.
268 (unless (eq? mod the-root-module)
269 (let collect-local-definitions ((x x))
271 ((<toplevel-define> name)
272 (hashq-set! local-definitions name #t))
274 (collect-local-definitions head)
275 (collect-local-definitions tail))
282 ((<toplevel-ref> src name)
283 (and=> (and (not (hashq-ref local-definitions name))
284 (hashq-ref *interesting-primitive-vars*
285 (module-variable mod name)))
286 (lambda (name) (make-primitive-ref src name))))
287 ((<module-ref> src mod name public?)
288 ;; for the moment, we're disabling primitive resolution for
289 ;; public refs because resolve-interface can raise errors.
290 (and=> (and=> (resolve-module mod)
292 module-public-interface
295 (and=> (hashq-ref *interesting-primitive-vars*
296 (module-variable m name))
298 (make-primitive-ref src name))))))
299 ((<call> src proc args)
300 (and (primitive-ref? proc)
301 (make-primcall src (primitive-ref-name proc) args)))
308 (define *primitive-expand-table* (make-hash-table))
310 (define (expand-primitives x)
314 ((<primcall> src name args)
315 (let ((expand (hashq-ref *primitive-expand-table* name)))
316 (or (and expand (apply expand src args))
321 ;;; I actually did spend about 10 minutes trying to redo this with
322 ;;; syntax-rules. Patches appreciated.
324 (define-macro (define-primitive-expander sym . clauses)
325 (define (inline-args args)
326 (let lp ((in args) (out '()))
327 (cond ((null? in) `(list ,@(reverse out)))
328 ((symbol? in) `(cons* ,@(reverse out) ,in))
331 (cons (if (eq? (caar in) 'quote)
332 `(make-const src ,@(cdar in))
333 `(make-primcall src ',(caar in)
334 ,(inline-args (cdar in))))
337 ;; assume it's locally bound
338 (lp (cdr in) (cons (car in) out)))
339 ((self-evaluating? (car in))
340 (lp (cdr in) (cons `(make-const src ,(car in)) out)))
342 (error "what what" (car in))))))
343 (define (consequent exp)
347 ((if ,test ,then ,else)
352 `(make-primcall src ',(car exp)
353 ,(inline-args (cdr exp))))))
355 ;; assume locally bound
358 `(make-const src ,exp))
362 (else (error "bad consequent yall" exp))))
363 `(hashq-set! *primitive-expand-table*
366 ,@(let lp ((in clauses) (out '()))
368 (reverse (cons '(_ #f) out))
370 (cons `((src . ,(car in))
371 ,(consequent (cadr in)))
374 (define-primitive-expander zero? (x)
377 ;; FIXME: All the code that uses `const?' is redundant with `peval'.
379 (define-primitive-expander +
382 (x y) (if (and (const? y) (eqv? (const-exp y) 1))
384 (if (and (const? y) (eqv? (const-exp y) -1))
386 (if (and (const? x) (eqv? (const-exp x) 1))
388 (if (and (const? x) (eqv? (const-exp x) -1))
391 (x y z ... last) (+ (+ x y . z) last))
393 (define-primitive-expander *
396 (x y z ... last) (* (* x y . z) last))
398 (define-primitive-expander -
400 (x y) (if (and (const? y) (eqv? (const-exp y) 1))
403 (x y z ... last) (- (- x y . z) last))
405 (define-primitive-expander /
407 (x y z ... last) (/ (/ x y . z) last))
409 (define-primitive-expander logior
413 (x y z ... last) (logior (logior x y . z) last))
415 (define-primitive-expander logand
419 (x y z ... last) (logand (logand x y . z) last))
421 (define-primitive-expander caar (x) (car (car x)))
422 (define-primitive-expander cadr (x) (car (cdr x)))
423 (define-primitive-expander cdar (x) (cdr (car x)))
424 (define-primitive-expander cddr (x) (cdr (cdr x)))
425 (define-primitive-expander caaar (x) (car (car (car x))))
426 (define-primitive-expander caadr (x) (car (car (cdr x))))
427 (define-primitive-expander cadar (x) (car (cdr (car x))))
428 (define-primitive-expander caddr (x) (car (cdr (cdr x))))
429 (define-primitive-expander cdaar (x) (cdr (car (car x))))
430 (define-primitive-expander cdadr (x) (cdr (car (cdr x))))
431 (define-primitive-expander cddar (x) (cdr (cdr (car x))))
432 (define-primitive-expander cdddr (x) (cdr (cdr (cdr x))))
433 (define-primitive-expander caaaar (x) (car (car (car (car x)))))
434 (define-primitive-expander caaadr (x) (car (car (car (cdr x)))))
435 (define-primitive-expander caadar (x) (car (car (cdr (car x)))))
436 (define-primitive-expander caaddr (x) (car (car (cdr (cdr x)))))
437 (define-primitive-expander cadaar (x) (car (cdr (car (car x)))))
438 (define-primitive-expander cadadr (x) (car (cdr (car (cdr x)))))
439 (define-primitive-expander caddar (x) (car (cdr (cdr (car x)))))
440 (define-primitive-expander cadddr (x) (car (cdr (cdr (cdr x)))))
441 (define-primitive-expander cdaaar (x) (cdr (car (car (car x)))))
442 (define-primitive-expander cdaadr (x) (cdr (car (car (cdr x)))))
443 (define-primitive-expander cdadar (x) (cdr (car (cdr (car x)))))
444 (define-primitive-expander cdaddr (x) (cdr (car (cdr (cdr x)))))
445 (define-primitive-expander cddaar (x) (cdr (cdr (car (car x)))))
446 (define-primitive-expander cddadr (x) (cdr (cdr (car (cdr x)))))
447 (define-primitive-expander cdddar (x) (cdr (cdr (cdr (car x)))))
448 (define-primitive-expander cddddr (x) (cdr (cdr (cdr (cdr x)))))
450 (define-primitive-expander cons*
453 (x y . rest) (cons x (cons* y . rest)))
455 (define-primitive-expander acons (x y z)
458 (define-primitive-expander call/cc (proc)
459 (call-with-current-continuation proc))
461 (define-primitive-expander make-struct (vtable tail-size . args)
462 (if (and (const? tail-size)
463 (let ((n (const-exp tail-size)))
464 (and (number? n) (exact? n) (zero? n))))
465 (make-struct/no-tail vtable . args)
468 (define-primitive-expander u8vector-ref (vec i)
469 (bytevector-u8-ref vec i))
470 (define-primitive-expander u8vector-set! (vec i x)
471 (bytevector-u8-set! vec i x))
472 (define-primitive-expander s8vector-ref (vec i)
473 (bytevector-s8-ref vec i))
474 (define-primitive-expander s8vector-set! (vec i x)
475 (bytevector-s8-set! vec i x))
477 (define-primitive-expander u16vector-ref (vec i)
478 (bytevector-u16-native-ref vec (* i 2)))
479 (define-primitive-expander u16vector-set! (vec i x)
480 (bytevector-u16-native-set! vec (* i 2) x))
481 (define-primitive-expander s16vector-ref (vec i)
482 (bytevector-s16-native-ref vec (* i 2)))
483 (define-primitive-expander s16vector-set! (vec i x)
484 (bytevector-s16-native-set! vec (* i 2) x))
486 (define-primitive-expander u32vector-ref (vec i)
487 (bytevector-u32-native-ref vec (* i 4)))
488 (define-primitive-expander u32vector-set! (vec i x)
489 (bytevector-u32-native-set! vec (* i 4) x))
490 (define-primitive-expander s32vector-ref (vec i)
491 (bytevector-s32-native-ref vec (* i 4)))
492 (define-primitive-expander s32vector-set! (vec i x)
493 (bytevector-s32-native-set! vec (* i 4) x))
495 (define-primitive-expander u64vector-ref (vec i)
496 (bytevector-u64-native-ref vec (* i 8)))
497 (define-primitive-expander u64vector-set! (vec i x)
498 (bytevector-u64-native-set! vec (* i 8) x))
499 (define-primitive-expander s64vector-ref (vec i)
500 (bytevector-s64-native-ref vec (* i 8)))
501 (define-primitive-expander s64vector-set! (vec i x)
502 (bytevector-s64-native-set! vec (* i 8) x))
504 (define-primitive-expander f32vector-ref (vec i)
505 (bytevector-ieee-single-native-ref vec (* i 4)))
506 (define-primitive-expander f32vector-set! (vec i x)
507 (bytevector-ieee-single-native-set! vec (* i 4) x))
508 (define-primitive-expander f32vector-ref (vec i)
509 (bytevector-ieee-single-native-ref vec (* i 4)))
510 (define-primitive-expander f32vector-set! (vec i x)
511 (bytevector-ieee-single-native-set! vec (* i 4) x))
513 (define-primitive-expander f64vector-ref (vec i)
514 (bytevector-ieee-double-native-ref vec (* i 8)))
515 (define-primitive-expander f64vector-set! (vec i x)
516 (bytevector-ieee-double-native-set! vec (* i 8) x))
517 (define-primitive-expander f64vector-ref (vec i)
518 (bytevector-ieee-double-native-ref vec (* i 8)))
519 (define-primitive-expander f64vector-set! (vec i x)
520 (bytevector-ieee-double-native-set! vec (* i 8) x))
522 ;; Appropriate for use with either 'eqv?' or 'equal?'.
523 (define (maybe-simplify-to-eq prim)
525 ((src) (make-const src #t))
526 ((src a) (make-const src #t))
528 ;; Simplify cases where either A or B is constant.
529 (define (maybe-simplify a b)
531 (let ((v (const-exp a)))
532 (and (or (memq v '(#f #t () #nil))
536 (<= v most-positive-fixnum)
537 (>= v most-negative-fixnum)))
538 (make-primcall src 'eq? (list a b))))))
539 (or (maybe-simplify a b) (maybe-simplify b a)))
541 (make-conditional src (make-primcall src prim (list a b))
542 (make-primcall src prim (cons b rest))
543 (make-const src #f)))
546 (hashq-set! *primitive-expand-table* 'eqv? (maybe-simplify-to-eq 'eqv?))
547 (hashq-set! *primitive-expand-table* 'equal? (maybe-simplify-to-eq 'equal?))
549 (define (expand-chained-comparisons prim)
551 ((src) (make-const src #t))
552 ((src a) (make-const src #t))
555 (make-conditional src (make-primcall src prim (list a b))
556 (make-primcall src prim (cons b rest))
557 (make-const src #f)))
560 (for-each (lambda (prim)
561 (hashq-set! *primitive-expand-table* prim
562 (expand-chained-comparisons prim)))
565 (hashq-set! *primitive-expand-table*
568 ((src tag thunk handler)
569 (make-prompt src #f tag thunk handler))
572 (hashq-set! *primitive-expand-table*
576 (make-abort src tag '() tail-args))
578 (hashq-set! *primitive-expand-table*
582 (make-abort src tag args (make-const #f '())))