1 ;;; open-coding primitive procedures
3 ;; Copyright (C) 2009, 2010, 2011, 2012 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 (rnrs bytevectors)
24 #:use-module (system base syntax)
25 #:use-module (language tree-il)
26 #:use-module (srfi srfi-4)
27 #:use-module (srfi srfi-16)
28 #:export (resolve-primitives! add-interesting-primitive!
30 effect-free-primitive? effect+exception-free-primitive?
31 constructor-primitive? accessor-primitive?
32 singly-valued-primitive? equality-primitive?))
34 (define *interesting-primitive-names*
36 call-with-values @call-with-values
37 call-with-current-continuation @call-with-current-continuation
45 + * - / 1- 1+ quotient remainder modulo
46 ash logand logior logxor
48 pair? null? list? symbol? vector? string? struct?
59 caaar caadr cadar caddr cdaar cdadr cddar cdddr
61 caaaar caaadr caadar caaddr cadaar cadadr caddar cadddr
62 cdaaar cdaadr cdadar cdaddr cddaar cddadr cdddar cddddr
64 vector-length vector-ref vector-set!
65 variable-ref variable-set!
70 @prompt call-with-prompt @abort abort-to-prompt
73 string-length string-ref string-set!
75 struct-vtable make-struct struct-ref struct-set!
77 bytevector-u8-ref bytevector-u8-set!
78 bytevector-s8-ref bytevector-s8-set!
79 u8vector-ref u8vector-set! s8vector-ref s8vector-set!
81 bytevector-u16-ref bytevector-u16-set!
82 bytevector-u16-native-ref bytevector-u16-native-set!
83 bytevector-s16-ref bytevector-s16-set!
84 bytevector-s16-native-ref bytevector-s16-native-set!
85 u16vector-ref u16vector-set! s16vector-ref s16vector-set!
87 bytevector-u32-ref bytevector-u32-set!
88 bytevector-u32-native-ref bytevector-u32-native-set!
89 bytevector-s32-ref bytevector-s32-set!
90 bytevector-s32-native-ref bytevector-s32-native-set!
91 u32vector-ref u32vector-set! s32vector-ref s32vector-set!
93 bytevector-u64-ref bytevector-u64-set!
94 bytevector-u64-native-ref bytevector-u64-native-set!
95 bytevector-s64-ref bytevector-s64-set!
96 bytevector-s64-native-ref bytevector-s64-native-set!
97 u64vector-ref u64vector-set! s64vector-ref s64vector-set!
99 bytevector-ieee-single-ref bytevector-ieee-single-set!
100 bytevector-ieee-single-native-ref bytevector-ieee-single-native-set!
101 bytevector-ieee-double-ref bytevector-ieee-double-set!
102 bytevector-ieee-double-native-ref bytevector-ieee-double-native-set!
103 f32vector-ref f32vector-set! f64vector-ref f64vector-set!))
105 (define (add-interesting-primitive! name)
106 (hashq-set! *interesting-primitive-vars*
107 (or (module-variable (current-module) name)
108 (error "unbound interesting primitive" name))
111 (define *interesting-primitive-vars* (make-hash-table))
113 (for-each add-interesting-primitive! *interesting-primitive-names*)
115 (define *primitive-constructors*
116 ;; Primitives that return a fresh object.
117 '(acons cons cons* list vector make-struct make-struct/no-tail
120 (define *primitive-accessors*
121 ;; Primitives that are pure, but whose result depends on the mutable
122 ;; memory pointed to by their operands.
126 struct-vtable struct-ref
128 bytevector-u8-ref bytevector-s8-ref
129 bytevector-u16-ref bytevector-u16-native-ref
130 bytevector-s16-ref bytevector-s16-native-ref
131 bytevector-u32-ref bytevector-u32-native-ref
132 bytevector-s32-ref bytevector-s32-native-ref
133 bytevector-u64-ref bytevector-u64-native-ref
134 bytevector-s64-ref bytevector-s64-native-ref
135 bytevector-ieee-single-ref bytevector-ieee-single-native-ref
136 bytevector-ieee-double-ref bytevector-ieee-double-native-ref))
138 (define *effect-free-primitives*
142 + * - / 1- 1+ quotient remainder modulo
144 pair? null? list? symbol? vector? struct? string?
146 string-length vector-length
147 ;; These all should get expanded out by expand-primitives!.
149 caaar caadr cadar caddr cdaar cdadr cddar cdddr
150 caaaar caaadr caadar caaddr cadaar cadadr caddar cadddr
151 cdaaar cdaadr cdadar cdaddr cddaar cddadr cdddar cddddr
152 ,@*primitive-constructors*
153 ,@*primitive-accessors*))
155 ;; Like *effect-free-primitives* above, but further restricted in that they
156 ;; cannot raise exceptions.
157 (define *effect+exception-free-primitives*
161 pair? null? list? symbol? vector? struct? string?
162 acons cons cons* list vector))
164 ;; Primitives that only return one value.
165 (define *singly-valued-primitives*
169 + * - / 1- 1+ quotient remainder modulo
170 ash logand logior logxor
172 pair? null? list? symbol? vector? acons cons cons*
178 caaar caadr cadar caddr cdaar cdadr cddar cdddr
179 caaaar caaadr caadar caaddr cadaar cadadr caddar cadddr
180 cdaaar cdaadr cdadar cdaddr cddaar cddadr cdddar cddddr
181 vector-ref vector-set!
182 variable-ref variable-set!
186 struct? struct-vtable make-struct struct-ref struct-set!
187 string-length string-ref string-set!
188 bytevector-u8-ref bytevector-u8-set!
189 bytevector-s8-ref bytevector-s8-set!
190 u8vector-ref u8vector-set! s8vector-ref s8vector-set!
191 bytevector-u16-ref bytevector-u16-set!
192 bytevector-u16-native-ref bytevector-u16-native-set!
193 bytevector-s16-ref bytevector-s16-set!
194 bytevector-s16-native-ref bytevector-s16-native-set!
195 u16vector-ref u16vector-set! s16vector-ref s16vector-set!
196 bytevector-u32-ref bytevector-u32-set!
197 bytevector-u32-native-ref bytevector-u32-native-set!
198 bytevector-s32-ref bytevector-s32-set!
199 bytevector-s32-native-ref bytevector-s32-native-set!
200 u32vector-ref u32vector-set! s32vector-ref s32vector-set!
201 bytevector-u64-ref bytevector-u64-set!
202 bytevector-u64-native-ref bytevector-u64-native-set!
203 bytevector-s64-ref bytevector-s64-set!
204 bytevector-s64-native-ref bytevector-s64-native-set!
205 u64vector-ref u64vector-set! s64vector-ref s64vector-set!
206 bytevector-ieee-single-ref bytevector-ieee-single-set!
207 bytevector-ieee-single-native-ref bytevector-ieee-single-native-set!
208 bytevector-ieee-double-ref bytevector-ieee-double-set!
209 bytevector-ieee-double-native-ref bytevector-ieee-double-native-set!
210 f32vector-ref f32vector-set! f64vector-ref f64vector-set!))
212 (define *equality-primitives*
215 (define *effect-free-primitive-table* (make-hash-table))
216 (define *effect+exceptions-free-primitive-table* (make-hash-table))
217 (define *singly-valued-primitive-table* (make-hash-table))
218 (define *equality-primitive-table* (make-hash-table))
220 (for-each (lambda (x)
221 (hashq-set! *effect-free-primitive-table* x #t))
222 *effect-free-primitives*)
223 (for-each (lambda (x)
224 (hashq-set! *effect+exceptions-free-primitive-table* x #t))
225 *effect+exception-free-primitives*)
226 (for-each (lambda (x)
227 (hashq-set! *singly-valued-primitive-table* x #t))
228 *singly-valued-primitives*)
229 (for-each (lambda (x)
230 (hashq-set! *equality-primitive-table* x #t))
231 *equality-primitives*)
233 (define (constructor-primitive? prim)
234 (memq prim *primitive-constructors*))
235 (define (accessor-primitive? prim)
236 (memq prim *primitive-accessors*))
237 (define (effect-free-primitive? prim)
238 (hashq-ref *effect-free-primitive-table* prim))
239 (define (effect+exception-free-primitive? prim)
240 (hashq-ref *effect+exceptions-free-primitive-table* prim))
241 (define (singly-valued-primitive? prim)
242 (hashq-ref *singly-valued-primitive-table* prim))
243 (define (equality-primitive? prim)
244 (hashq-ref *equality-primitive-table* prim))
246 (define (resolve-primitives! x mod)
247 (define local-definitions
250 (let collect-local-definitions ((x x))
252 ((<toplevel-define> name)
253 (hashq-set! local-definitions name #t))
255 (collect-local-definitions head)
256 (collect-local-definitions tail))
262 ((<toplevel-ref> src name)
263 (and=> (and (not (hashq-ref local-definitions name))
264 (hashq-ref *interesting-primitive-vars*
265 (module-variable mod name)))
266 (lambda (name) (make-primitive-ref src name))))
267 ((<module-ref> src mod name public?)
268 ;; for the moment, we're disabling primitive resolution for
269 ;; public refs because resolve-interface can raise errors.
270 (and=> (and=> (resolve-module mod)
272 module-public-interface
275 (and=> (hashq-ref *interesting-primitive-vars*
276 (module-variable m name))
278 (make-primitive-ref src name))))))
279 ((<call> src proc args)
280 (and (primitive-ref? proc)
281 (make-primcall src (primitive-ref-name proc) args)))
287 (define *primitive-expand-table* (make-hash-table))
289 (define (expand-primitives! x)
293 ((<primcall> src name args)
294 (let ((expand (hashq-ref *primitive-expand-table* name)))
295 (and expand (apply expand src args))))
299 ;;; I actually did spend about 10 minutes trying to redo this with
300 ;;; syntax-rules. Patches appreciated.
302 (define-macro (define-primitive-expander sym . clauses)
303 (define (inline-args args)
304 (let lp ((in args) (out '()))
305 (cond ((null? in) `(list ,@(reverse out)))
306 ((symbol? in) `(cons* ,@(reverse out) ,in))
309 (cons (if (eq? (caar in) 'quote)
310 `(make-const src ,@(cdar in))
311 `(make-primcall src ',(caar in)
312 ,(inline-args (cdar in))))
315 ;; assume it's locally bound
316 (lp (cdr in) (cons (car in) out)))
317 ((self-evaluating? (car in))
318 (lp (cdr in) (cons `(make-const src ,(car in)) out)))
320 (error "what what" (car in))))))
321 (define (consequent exp)
325 ((if ,test ,then ,else)
330 `(make-primcall src ',(car exp)
331 ,(inline-args (cdr exp))))))
333 ;; assume locally bound
336 `(make-const src ,exp))
340 (else (error "bad consequent yall" exp))))
341 `(hashq-set! *primitive-expand-table*
344 ,@(let lp ((in clauses) (out '()))
346 (reverse (cons '(else #f) out))
348 (cons `((src . ,(car in))
349 ,(consequent (cadr in))) out)))))))
351 (define-primitive-expander zero? (x)
354 ;; FIXME: All the code that uses `const?' is redundant with `peval'.
356 (define-primitive-expander +
359 (x y) (if (and (const? y)
360 (let ((y (const-exp y)))
361 (and (number? y) (exact? y) (= y 1))))
364 (let ((y (const-exp y)))
365 (and (number? y) (exact? y) (= y -1))))
368 (let ((x (const-exp x)))
369 (and (number? x) (exact? x) (= x 1))))
372 (x y z . rest) (+ x (+ y z . rest)))
374 (define-primitive-expander *
377 (x y z . rest) (* x (* y z . rest)))
379 (define-primitive-expander -
381 (x y) (if (and (const? y)
382 (let ((y (const-exp y)))
383 (and (number? y) (exact? y) (= y 1))))
386 (x y z . rest) (- x (+ y z . rest)))
388 (define-primitive-expander /
390 (x y z . rest) (/ x (* y z . rest)))
392 (define-primitive-expander caar (x) (car (car x)))
393 (define-primitive-expander cadr (x) (car (cdr x)))
394 (define-primitive-expander cdar (x) (cdr (car x)))
395 (define-primitive-expander cddr (x) (cdr (cdr x)))
396 (define-primitive-expander caaar (x) (car (car (car x))))
397 (define-primitive-expander caadr (x) (car (car (cdr x))))
398 (define-primitive-expander cadar (x) (car (cdr (car x))))
399 (define-primitive-expander caddr (x) (car (cdr (cdr x))))
400 (define-primitive-expander cdaar (x) (cdr (car (car x))))
401 (define-primitive-expander cdadr (x) (cdr (car (cdr x))))
402 (define-primitive-expander cddar (x) (cdr (cdr (car x))))
403 (define-primitive-expander cdddr (x) (cdr (cdr (cdr x))))
404 (define-primitive-expander caaaar (x) (car (car (car (car x)))))
405 (define-primitive-expander caaadr (x) (car (car (car (cdr x)))))
406 (define-primitive-expander caadar (x) (car (car (cdr (car x)))))
407 (define-primitive-expander caaddr (x) (car (car (cdr (cdr x)))))
408 (define-primitive-expander cadaar (x) (car (cdr (car (car x)))))
409 (define-primitive-expander cadadr (x) (car (cdr (car (cdr x)))))
410 (define-primitive-expander caddar (x) (car (cdr (cdr (car x)))))
411 (define-primitive-expander cadddr (x) (car (cdr (cdr (cdr x)))))
412 (define-primitive-expander cdaaar (x) (cdr (car (car (car x)))))
413 (define-primitive-expander cdaadr (x) (cdr (car (car (cdr x)))))
414 (define-primitive-expander cdadar (x) (cdr (car (cdr (car x)))))
415 (define-primitive-expander cdaddr (x) (cdr (car (cdr (cdr x)))))
416 (define-primitive-expander cddaar (x) (cdr (cdr (car (car x)))))
417 (define-primitive-expander cddadr (x) (cdr (cdr (car (cdr x)))))
418 (define-primitive-expander cdddar (x) (cdr (cdr (cdr (car x)))))
419 (define-primitive-expander cddddr (x) (cdr (cdr (cdr (cdr x)))))
421 (define-primitive-expander cons*
424 (x y . rest) (cons x (cons* y . rest)))
426 (define-primitive-expander acons (x y z)
429 (define-primitive-expander apply (f a0 . args)
430 (@apply f a0 . args))
432 (define-primitive-expander call-with-values (producer consumer)
433 (@call-with-values producer consumer))
435 (define-primitive-expander call-with-current-continuation (proc)
436 (@call-with-current-continuation proc))
438 (define-primitive-expander call/cc (proc)
439 (@call-with-current-continuation proc))
441 (define-primitive-expander make-struct (vtable tail-size . args)
442 (if (and (const? tail-size)
443 (let ((n (const-exp tail-size)))
444 (and (number? n) (exact? n) (zero? n))))
445 (make-struct/no-tail vtable . args)
448 (define-primitive-expander u8vector-ref (vec i)
449 (bytevector-u8-ref vec i))
450 (define-primitive-expander u8vector-set! (vec i x)
451 (bytevector-u8-set! vec i x))
452 (define-primitive-expander s8vector-ref (vec i)
453 (bytevector-s8-ref vec i))
454 (define-primitive-expander s8vector-set! (vec i x)
455 (bytevector-s8-set! vec i x))
457 (define-primitive-expander u16vector-ref (vec i)
458 (bytevector-u16-native-ref vec (* i 2)))
459 (define-primitive-expander u16vector-set! (vec i x)
460 (bytevector-u16-native-set! vec (* i 2) x))
461 (define-primitive-expander s16vector-ref (vec i)
462 (bytevector-s16-native-ref vec (* i 2)))
463 (define-primitive-expander s16vector-set! (vec i x)
464 (bytevector-s16-native-set! vec (* i 2) x))
466 (define-primitive-expander u32vector-ref (vec i)
467 (bytevector-u32-native-ref vec (* i 4)))
468 (define-primitive-expander u32vector-set! (vec i x)
469 (bytevector-u32-native-set! vec (* i 4) x))
470 (define-primitive-expander s32vector-ref (vec i)
471 (bytevector-s32-native-ref vec (* i 4)))
472 (define-primitive-expander s32vector-set! (vec i x)
473 (bytevector-s32-native-set! vec (* i 4) x))
475 (define-primitive-expander u64vector-ref (vec i)
476 (bytevector-u64-native-ref vec (* i 8)))
477 (define-primitive-expander u64vector-set! (vec i x)
478 (bytevector-u64-native-set! vec (* i 8) x))
479 (define-primitive-expander s64vector-ref (vec i)
480 (bytevector-s64-native-ref vec (* i 8)))
481 (define-primitive-expander s64vector-set! (vec i x)
482 (bytevector-s64-native-set! vec (* i 8) x))
484 (define-primitive-expander f32vector-ref (vec i)
485 (bytevector-ieee-single-native-ref vec (* i 4)))
486 (define-primitive-expander f32vector-set! (vec i x)
487 (bytevector-ieee-single-native-set! vec (* i 4) x))
488 (define-primitive-expander f32vector-ref (vec i)
489 (bytevector-ieee-single-native-ref vec (* i 4)))
490 (define-primitive-expander f32vector-set! (vec i x)
491 (bytevector-ieee-single-native-set! vec (* i 4) x))
493 (define-primitive-expander f64vector-ref (vec i)
494 (bytevector-ieee-double-native-ref vec (* i 8)))
495 (define-primitive-expander f64vector-set! (vec i x)
496 (bytevector-ieee-double-native-set! vec (* i 8) x))
497 (define-primitive-expander f64vector-ref (vec i)
498 (bytevector-ieee-double-native-ref vec (* i 8)))
499 (define-primitive-expander f64vector-set! (vec i x)
500 (bytevector-ieee-double-native-set! vec (* i 8) x))
502 (hashq-set! *primitive-expand-table*
506 (let ((PRE (gensym "pre-"))
507 (POST (gensym "post-")))
515 (make-lexical-ref #f 'pre PRE)
516 (make-call #f (make-lexical-ref #f 'pre PRE) '())
518 (make-call #f (make-lexical-ref #f 'post POST) '())
519 (make-lexical-ref #f 'post POST)))))))
521 (hashq-set! *primitive-expand-table*
524 ((src fluid) (make-dynref src fluid))
527 (hashq-set! *primitive-expand-table*
530 ((src fluid exp) (make-dynset src fluid exp))
533 (hashq-set! *primitive-expand-table*
536 ((src tag exp handler)
537 (let ((args-sym (gensym)))
540 ;; If handler itself is a lambda, the inliner can do some
543 (tree-il-src handler) '() #f 'args #f '() (list args-sym)
544 (make-primcall #f 'apply
546 (make-lexical-ref #f 'args args-sym)))
550 (hashq-set! *primitive-expand-table*
553 ((src tag thunk handler)
554 (let ((handler-sym (gensym))
557 src '(handler) (list handler-sym) (list handler)
559 src tag (make-call #f thunk '())
560 ;; If handler itself is a lambda, the inliner can do some
563 (tree-il-src handler) '() #f 'args #f '() (list args-sym)
566 (list (make-lexical-ref #f 'handler handler-sym)
567 (make-lexical-ref #f 'args args-sym)))
571 (hashq-set! *primitive-expand-table*
575 (make-abort src tag '() tail-args))
577 (hashq-set! *primitive-expand-table*
581 (make-abort src tag args (make-const #f '())))