1.0.29.34: hopefully thread-safe SB-PROFILE
[sbcl.git] / src / compiler / aliencomp.lisp
1 ;;;; transforms and other stuff used to compile ALIEN operations
2
3 ;;;; This software is part of the SBCL system. See the README file for
4 ;;;; more information.
5 ;;;;
6 ;;;; This software is derived from the CMU CL system, which was
7 ;;;; written at Carnegie Mellon University and released into the
8 ;;;; public domain. The software is in the public domain and is
9 ;;;; provided with absolutely no warranty. See the COPYING and CREDITS
10 ;;;; files for more information.
11
12 (in-package "SB!C")
13 \f
14 ;;;; DEFKNOWNs
15
16 (defknown %sap-alien (system-area-pointer alien-type) alien-value
17   (flushable movable))
18 (defknown alien-sap (alien-value) system-area-pointer
19   (flushable movable))
20
21 (defknown slot (alien-value symbol) t
22   (flushable recursive))
23 (defknown %set-slot (alien-value symbol t) t
24   (recursive))
25 (defknown %slot-addr (alien-value symbol) (alien (* t))
26   (flushable movable recursive))
27
28 (defknown deref (alien-value &rest index) t
29   (flushable))
30 (defknown %set-deref (alien-value t &rest index) t
31   ())
32 (defknown %deref-addr (alien-value &rest index) (alien (* t))
33   (flushable movable))
34
35 (defknown %heap-alien (heap-alien-info) t
36   (flushable))
37 (defknown %set-heap-alien (heap-alien-info t) t
38   ())
39 (defknown %heap-alien-addr (heap-alien-info) (alien (* t))
40   (flushable movable))
41
42 (defknown make-local-alien (local-alien-info) t
43   ())
44 (defknown note-local-alien-type (local-alien-info t) null
45   ())
46 (defknown local-alien (local-alien-info t) t
47   (flushable))
48 (defknown %local-alien-forced-to-memory-p (local-alien-info) (member t nil)
49   (movable))
50 (defknown %set-local-alien (local-alien-info t t) t
51   ())
52 (defknown %local-alien-addr (local-alien-info t) (alien (* t))
53   (flushable movable))
54 (defknown dispose-local-alien (local-alien-info t) t
55   ())
56
57 (defknown %cast (alien-value alien-type) alien
58   (flushable movable))
59
60 (defknown naturalize (t alien-type) alien
61   (flushable movable))
62 (defknown deport (alien alien-type) t
63   (flushable movable))
64 (defknown deport-alloc (alien alien-type) t
65   (flushable movable))
66 (defknown extract-alien-value (system-area-pointer unsigned-byte alien-type) t
67   (flushable))
68 (defknown deposit-alien-value (system-area-pointer unsigned-byte alien-type t) t
69   ())
70
71 (defknown alien-funcall (alien-value &rest *) *
72   (any recursive))
73 \f
74 ;;;; cosmetic transforms
75
76 (deftransform slot ((object slot)
77                     ((alien (* t)) symbol))
78   '(slot (deref object) slot))
79
80 (deftransform %set-slot ((object slot value)
81                          ((alien (* t)) symbol t))
82   '(%set-slot (deref object) slot value))
83
84 (deftransform %slot-addr ((object slot)
85                           ((alien (* t)) symbol))
86   '(%slot-addr (deref object) slot))
87 \f
88 ;;;; SLOT support
89
90 (defun find-slot-offset-and-type (alien slot)
91   (unless (constant-lvar-p slot)
92     (give-up-ir1-transform
93      "The slot is not constant, so access cannot be open coded."))
94   (let ((type (lvar-type alien)))
95     (unless (alien-type-type-p type)
96       (give-up-ir1-transform))
97     (let ((alien-type (alien-type-type-alien-type type)))
98       (unless (alien-record-type-p alien-type)
99         (give-up-ir1-transform))
100       (let* ((slot-name (lvar-value slot))
101              (field (find slot-name (alien-record-type-fields alien-type)
102                           :key #'alien-record-field-name)))
103         (unless field
104           (abort-ir1-transform "~S doesn't have a slot named ~S"
105                                alien
106                                slot-name))
107         (values (alien-record-field-offset field)
108                 (alien-record-field-type field))))))
109
110 #+nil ;; Shouldn't be necessary.
111 (defoptimizer (slot derive-type) ((alien slot))
112   (block nil
113     (catch 'give-up-ir1-transform
114       (multiple-value-bind (slot-offset slot-type)
115           (find-slot-offset-and-type alien slot)
116         (declare (ignore slot-offset))
117         (return (make-alien-type-type slot-type))))
118     *wild-type*))
119
120 (deftransform slot ((alien slot) * * :important t)
121   (multiple-value-bind (slot-offset slot-type)
122       (find-slot-offset-and-type alien slot)
123     `(extract-alien-value (alien-sap alien)
124                           ,slot-offset
125                           ',slot-type)))
126
127 #+nil ;; ### But what about coercions?
128 (defoptimizer (%set-slot derive-type) ((alien slot value))
129   (block nil
130     (catch 'give-up-ir1-transform
131       (multiple-value-bind (slot-offset slot-type)
132           (find-slot-offset-and-type alien slot)
133         (declare (ignore slot-offset))
134         (let ((type (make-alien-type-type slot-type)))
135           (assert-lvar-type value type)
136           (return type))))
137     *wild-type*))
138
139 (deftransform %set-slot ((alien slot value) * * :important t)
140   (multiple-value-bind (slot-offset slot-type)
141       (find-slot-offset-and-type alien slot)
142     `(deposit-alien-value (alien-sap alien)
143                           ,slot-offset
144                           ',slot-type
145                           value)))
146
147 (defoptimizer (%slot-addr derive-type) ((alien slot))
148   (block nil
149     (catch 'give-up-ir1-transform
150       (multiple-value-bind (slot-offset slot-type)
151           (find-slot-offset-and-type alien slot)
152         (declare (ignore slot-offset))
153         (return (make-alien-type-type
154                  (make-alien-pointer-type :to slot-type)))))
155     *wild-type*))
156
157 (deftransform %slot-addr ((alien slot) * * :important t)
158   (multiple-value-bind (slot-offset slot-type)
159       (find-slot-offset-and-type alien slot)
160     (/noshow "in DEFTRANSFORM %SLOT-ADDR, creating %SAP-ALIEN")
161     `(%sap-alien (sap+ (alien-sap alien) (/ ,slot-offset sb!vm:n-byte-bits))
162                  ',(make-alien-pointer-type :to slot-type))))
163 \f
164 ;;;; DEREF support
165
166 (defun find-deref-alien-type (alien)
167   (let ((alien-type (lvar-type alien)))
168     (unless (alien-type-type-p alien-type)
169       (give-up-ir1-transform))
170     (let ((alien-type (alien-type-type-alien-type alien-type)))
171       (if (alien-type-p alien-type)
172           alien-type
173           (give-up-ir1-transform)))))
174
175 (defun find-deref-element-type (alien)
176   (let ((alien-type (find-deref-alien-type alien)))
177     (typecase alien-type
178       (alien-pointer-type
179        (alien-pointer-type-to alien-type))
180       (alien-array-type
181        (alien-array-type-element-type alien-type))
182       (t
183        (give-up-ir1-transform)))))
184
185 (defun compute-deref-guts (alien indices)
186   (let ((alien-type (find-deref-alien-type alien)))
187     (typecase alien-type
188       (alien-pointer-type
189        (when (cdr indices)
190          (abort-ir1-transform "too many indices for pointer deref: ~W"
191                               (length indices)))
192        (let ((element-type (alien-pointer-type-to alien-type)))
193          (unless element-type
194            (give-up-ir1-transform "unable to open code deref of wild pointer type"))
195          (if indices
196              (let ((bits (alien-type-bits element-type))
197                    (alignment (alien-type-alignment element-type)))
198                (unless bits
199                  (abort-ir1-transform "unknown element size"))
200                (unless alignment
201                  (abort-ir1-transform "unknown element alignment"))
202                (values '(offset)
203                        `(* offset
204                            ,(align-offset bits alignment))
205                        element-type))
206              (values nil 0 element-type))))
207       (alien-array-type
208        (let* ((element-type (alien-array-type-element-type alien-type))
209               (bits (alien-type-bits element-type))
210               (alignment (alien-type-alignment element-type))
211               (dims (alien-array-type-dimensions alien-type)))
212          (unless (= (length indices) (length dims))
213            (give-up-ir1-transform "incorrect number of indices"))
214          (unless bits
215            (give-up-ir1-transform "Element size is unknown."))
216          (unless alignment
217            (give-up-ir1-transform "Element alignment is unknown."))
218          (if (null dims)
219              (values nil 0 element-type)
220              (let* ((arg (gensym))
221                     (args (list arg))
222                     (offsetexpr arg))
223                (dolist (dim (cdr dims))
224                  (let ((arg (gensym)))
225                    (push arg args)
226                    (setf offsetexpr `(+ (* ,offsetexpr ,dim) ,arg))))
227                (values (reverse args)
228                        `(* ,offsetexpr
229                            ,(align-offset bits alignment))
230                        element-type)))))
231       (t
232        (abort-ir1-transform "~S not either a pointer or array type."
233                             alien-type)))))
234
235 #+nil ;; Shouldn't be necessary.
236 (defoptimizer (deref derive-type) ((alien &rest noise))
237   (declare (ignore noise))
238   (block nil
239     (catch 'give-up-ir1-transform
240       (return (make-alien-type-type (find-deref-element-type alien))))
241     *wild-type*))
242
243 (deftransform deref ((alien &rest indices) * * :important t)
244   (multiple-value-bind (indices-args offset-expr element-type)
245       (compute-deref-guts alien indices)
246     `(lambda (alien ,@indices-args)
247        (extract-alien-value (alien-sap alien)
248                             ,offset-expr
249                             ',element-type))))
250
251 #+nil ;; ### Again, the value might be coerced.
252 (defoptimizer (%set-deref derive-type) ((alien value &rest noise))
253   (declare (ignore noise))
254   (block nil
255     (catch 'give-up-ir1-transform
256       (let ((type (make-alien-type-type
257                    (make-alien-pointer-type
258                     :to (find-deref-element-type alien)))))
259         (assert-lvar-type value type)
260         (return type)))
261     *wild-type*))
262
263 (deftransform %set-deref ((alien value &rest indices) * * :important t)
264   (multiple-value-bind (indices-args offset-expr element-type)
265       (compute-deref-guts alien indices)
266     `(lambda (alien value ,@indices-args)
267        (deposit-alien-value (alien-sap alien)
268                             ,offset-expr
269                             ',element-type
270                             value))))
271
272 (defoptimizer (%deref-addr derive-type) ((alien &rest noise))
273   (declare (ignore noise))
274   (block nil
275     (catch 'give-up-ir1-transform
276       (return (make-alien-type-type
277                (make-alien-pointer-type
278                 :to (find-deref-element-type alien)))))
279     *wild-type*))
280
281 (deftransform %deref-addr ((alien &rest indices) * * :important t)
282   (multiple-value-bind (indices-args offset-expr element-type)
283       (compute-deref-guts alien indices)
284     (/noshow "in DEFTRANSFORM %DEREF-ADDR, creating (LAMBDA .. %SAP-ALIEN)")
285     `(lambda (alien ,@indices-args)
286        (%sap-alien (sap+ (alien-sap alien) (/ ,offset-expr sb!vm:n-byte-bits))
287                    ',(make-alien-pointer-type :to element-type)))))
288 \f
289 ;;;; support for aliens on the heap
290
291 (defun heap-alien-sap-and-type (info)
292   (unless (constant-lvar-p info)
293     (give-up-ir1-transform "info not constant; can't open code"))
294   (let ((info (lvar-value info)))
295     (values (heap-alien-info-sap-form info)
296             (heap-alien-info-type info))))
297
298 #+nil ; shouldn't be necessary
299 (defoptimizer (%heap-alien derive-type) ((info))
300   (block nil
301     (catch 'give-up
302       (multiple-value-bind (sap type) (heap-alien-sap-and-type info)
303         (declare (ignore sap))
304         (return (make-alien-type-type type))))
305     *wild-type*))
306
307 (deftransform %heap-alien ((info) * * :important t)
308   (multiple-value-bind (sap type) (heap-alien-sap-and-type info)
309     `(extract-alien-value ,sap 0 ',type)))
310
311 #+nil ;; ### Again, deposit value might change the type.
312 (defoptimizer (%set-heap-alien derive-type) ((info value))
313   (block nil
314     (catch 'give-up-ir1-transform
315       (multiple-value-bind (sap type) (heap-alien-sap-and-type info)
316         (declare (ignore sap))
317         (let ((type (make-alien-type-type type)))
318           (assert-lvar-type value type)
319           (return type))))
320     *wild-type*))
321
322 (deftransform %set-heap-alien ((info value) (heap-alien-info *) * :important t)
323   (multiple-value-bind (sap type) (heap-alien-sap-and-type info)
324     `(deposit-alien-value ,sap 0 ',type value)))
325
326 (defoptimizer (%heap-alien-addr derive-type) ((info))
327   (block nil
328     (catch 'give-up-ir1-transform
329       (multiple-value-bind (sap type) (heap-alien-sap-and-type info)
330         (declare (ignore sap))
331         (return (make-alien-type-type (make-alien-pointer-type :to type)))))
332     *wild-type*))
333
334 (deftransform %heap-alien-addr ((info) * * :important t)
335   (multiple-value-bind (sap type) (heap-alien-sap-and-type info)
336     (/noshow "in DEFTRANSFORM %HEAP-ALIEN-ADDR, creating %SAP-ALIEN")
337     `(%sap-alien ,sap ',(make-alien-pointer-type :to type))))
338
339 \f
340 ;;;; support for local (stack or register) aliens
341
342 (deftransform make-local-alien ((info) * * :important t)
343   (unless (constant-lvar-p info)
344     (abort-ir1-transform "Local alien info isn't constant?"))
345   (let* ((info (lvar-value info))
346          (alien-type (local-alien-info-type info))
347          (bits (alien-type-bits alien-type)))
348     (unless bits
349       (abort-ir1-transform "unknown size: ~S" (unparse-alien-type alien-type)))
350     (/noshow "in DEFTRANSFORM MAKE-LOCAL-ALIEN" info)
351     (/noshow (local-alien-info-force-to-memory-p info))
352     (/noshow alien-type (unparse-alien-type alien-type) (alien-type-bits alien-type))
353     (if (local-alien-info-force-to-memory-p info)
354         #!+(or x86 x86-64)
355         `(%primitive alloc-alien-stack-space
356                      ,(ceiling (alien-type-bits alien-type)
357                                sb!vm:n-byte-bits))
358         #!-(or x86 x86-64)
359         `(%primitive alloc-number-stack-space
360                      ,(ceiling (alien-type-bits alien-type)
361                                sb!vm:n-byte-bits))
362         (let* ((alien-rep-type-spec (compute-alien-rep-type alien-type))
363                (alien-rep-type (specifier-type alien-rep-type-spec)))
364           (cond ((csubtypep (specifier-type 'system-area-pointer)
365                             alien-rep-type)
366                  '(int-sap 0))
367                 ((ctypep 0 alien-rep-type) 0)
368                 ((ctypep 0.0f0 alien-rep-type) 0.0f0)
369                 ((ctypep 0.0d0 alien-rep-type) 0.0d0)
370                 (t
371                  (compiler-error
372                   "Aliens of type ~S cannot be represented immediately."
373                   (unparse-alien-type alien-type))))))))
374
375 (deftransform note-local-alien-type ((info var) * * :important t)
376   ;; FIXME: This test and error occur about a zillion times. They
377   ;; could be factored into a function.
378   (unless (constant-lvar-p info)
379     (abort-ir1-transform "Local alien info isn't constant?"))
380   (let ((info (lvar-value info)))
381     (/noshow "in DEFTRANSFORM NOTE-LOCAL-ALIEN-TYPE" info)
382     (/noshow (local-alien-info-force-to-memory-p info))
383     (unless (local-alien-info-force-to-memory-p info)
384       (let ((var-node (lvar-uses var)))
385         (/noshow var-node (ref-p var-node))
386         (when (ref-p var-node)
387           (propagate-to-refs (ref-leaf var-node)
388                              (specifier-type
389                               (compute-alien-rep-type
390                                (local-alien-info-type info))))))))
391   nil)
392
393 (deftransform local-alien ((info var) * * :important t)
394   (unless (constant-lvar-p info)
395     (abort-ir1-transform "Local alien info isn't constant?"))
396   (let* ((info (lvar-value info))
397          (alien-type (local-alien-info-type info)))
398     (/noshow "in DEFTRANSFORM LOCAL-ALIEN" info alien-type)
399     (/noshow (local-alien-info-force-to-memory-p info))
400     (if (local-alien-info-force-to-memory-p info)
401         `(extract-alien-value var 0 ',alien-type)
402         `(naturalize var ',alien-type))))
403
404 (deftransform %local-alien-forced-to-memory-p ((info) * * :important t)
405   (unless (constant-lvar-p info)
406     (abort-ir1-transform "Local alien info isn't constant?"))
407   (let ((info (lvar-value info)))
408     (local-alien-info-force-to-memory-p info)))
409
410 (deftransform %set-local-alien ((info var value) * * :important t)
411   (unless (constant-lvar-p info)
412     (abort-ir1-transform "Local alien info isn't constant?"))
413   (let* ((info (lvar-value info))
414          (alien-type (local-alien-info-type info)))
415     (if (local-alien-info-force-to-memory-p info)
416         `(deposit-alien-value var 0 ',alien-type value)
417         '(error "This should be eliminated as dead code."))))
418
419 (defoptimizer (%local-alien-addr derive-type) ((info var))
420   (if (constant-lvar-p info)
421       (let* ((info (lvar-value info))
422              (alien-type (local-alien-info-type info)))
423         (make-alien-type-type (make-alien-pointer-type :to alien-type)))
424       *wild-type*))
425
426 (deftransform %local-alien-addr ((info var) * * :important t)
427   (unless (constant-lvar-p info)
428     (abort-ir1-transform "Local alien info isn't constant?"))
429   (let* ((info (lvar-value info))
430          (alien-type (local-alien-info-type info)))
431     (/noshow "in DEFTRANSFORM %LOCAL-ALIEN-ADDR, creating %SAP-ALIEN")
432     (if (local-alien-info-force-to-memory-p info)
433         `(%sap-alien var ',(make-alien-pointer-type :to alien-type))
434         (error "This shouldn't happen."))))
435
436 (deftransform dispose-local-alien ((info var) * * :important t)
437   (unless (constant-lvar-p info)
438     (abort-ir1-transform "Local alien info isn't constant?"))
439   (let* ((info (lvar-value info))
440          (alien-type (local-alien-info-type info)))
441     (if (local-alien-info-force-to-memory-p info)
442       #!+(or x86 x86-64) `(%primitive dealloc-alien-stack-space
443                           ,(ceiling (alien-type-bits alien-type)
444                                     sb!vm:n-byte-bits))
445       #!-(or x86 x86-64) `(%primitive dealloc-number-stack-space
446                           ,(ceiling (alien-type-bits alien-type)
447                                     sb!vm:n-byte-bits))
448       nil)))
449 \f
450 ;;;; %CAST
451
452 (defoptimizer (%cast derive-type) ((alien type))
453   (or (when (constant-lvar-p type)
454         (let ((alien-type (lvar-value type)))
455           (when (alien-type-p alien-type)
456             (make-alien-type-type alien-type))))
457       *wild-type*))
458
459 (deftransform %cast ((alien target-type) * * :important t)
460   (unless (constant-lvar-p target-type)
461     (give-up-ir1-transform
462      "The alien type is not constant, so access cannot be open coded."))
463   (let ((target-type (lvar-value target-type)))
464     (cond ((or (alien-pointer-type-p target-type)
465                (alien-array-type-p target-type)
466                (alien-fun-type-p target-type))
467            `(naturalize (alien-sap alien) ',target-type))
468           (t
469            (abort-ir1-transform "cannot cast to alien type ~S" target-type)))))
470 \f
471 ;;;; ALIEN-SAP, %SAP-ALIEN, %ADDR, etc.
472
473 (deftransform alien-sap ((alien) * * :important t)
474   (let ((alien-node (lvar-uses alien)))
475     (typecase alien-node
476       (combination
477        (splice-fun-args alien '%sap-alien 2)
478        '(lambda (sap type)
479           (declare (ignore type))
480           sap))
481       (t
482        (give-up-ir1-transform)))))
483
484 (defoptimizer (%sap-alien derive-type) ((sap type))
485   (declare (ignore sap))
486   (if (constant-lvar-p type)
487       (make-alien-type-type (lvar-value type))
488       *wild-type*))
489
490 (deftransform %sap-alien ((sap type) * * :important t)
491   (give-up-ir1-transform
492    ;; FIXME: The hardcoded newline here causes more-than-usually
493    ;; screwed-up formatting of the optimization note output.
494    "could not optimize away %SAP-ALIEN: forced to do runtime ~@
495     allocation of alien-value structure"))
496 \f
497 ;;;; NATURALIZE/DEPORT/EXTRACT/DEPOSIT magic
498
499 (flet ((%computed-lambda (compute-lambda type)
500          (declare (type function compute-lambda))
501          (unless (constant-lvar-p type)
502            (give-up-ir1-transform
503             "The type is not constant at compile time; can't open code."))
504          (handler-case
505              (let ((result (funcall compute-lambda (lvar-value type))))
506                (/noshow "in %COMPUTED-LAMBDA" (lvar-value type) result)
507                result)
508            (error (condition)
509                   (compiler-error "~A" condition)))))
510   (deftransform naturalize ((object type) * * :important t)
511     (%computed-lambda #'compute-naturalize-lambda type))
512   (deftransform deport ((alien type) * * :important t)
513     (%computed-lambda #'compute-deport-lambda type))
514   (deftransform deport-alloc ((alien type) * * :important t)
515     (%computed-lambda #'compute-deport-alloc-lambda type))
516   (deftransform extract-alien-value ((sap offset type) * * :important t)
517     (%computed-lambda #'compute-extract-lambda type))
518   (deftransform deposit-alien-value ((sap offset type value) * * :important t)
519     (%computed-lambda #'compute-deposit-lambda type)))
520 \f
521 ;;;; a hack to clean up divisions
522
523 (defun count-low-order-zeros (thing)
524   (typecase thing
525     (lvar
526      (if (constant-lvar-p thing)
527          (count-low-order-zeros (lvar-value thing))
528          (count-low-order-zeros (lvar-uses thing))))
529     (combination
530      (case (let ((name (lvar-fun-name (combination-fun thing))))
531              (or (modular-version-info name :untagged nil) name))
532        ((+ -)
533         (let ((min most-positive-fixnum)
534               (itype (specifier-type 'integer)))
535           (dolist (arg (combination-args thing) min)
536             (if (csubtypep (lvar-type arg) itype)
537                 (setf min (min min (count-low-order-zeros arg)))
538                 (return 0)))))
539        (*
540         (let ((result 0)
541               (itype (specifier-type 'integer)))
542           (dolist (arg (combination-args thing) result)
543             (if (csubtypep (lvar-type arg) itype)
544                 (setf result (+ result (count-low-order-zeros arg)))
545                 (return 0)))))
546        (ash
547         (let ((args (combination-args thing)))
548           (if (= (length args) 2)
549               (let ((amount (second args)))
550                 (if (constant-lvar-p amount)
551                     (max (+ (count-low-order-zeros (first args))
552                             (lvar-value amount))
553                          0)
554                     0))
555               0)))
556        (t
557         0)))
558     (integer
559      (if (zerop thing)
560          most-positive-fixnum
561          (do ((result 0 (1+ result))
562               (num thing (ash num -1)))
563              ((logbitp 0 num) result))))
564     (cast
565      (count-low-order-zeros (cast-value thing)))
566     (t
567      0)))
568
569 (deftransform / ((numerator denominator) (integer integer))
570   "convert x/2^k to shift"
571   (unless (constant-lvar-p denominator)
572     (give-up-ir1-transform))
573   (let* ((denominator (lvar-value denominator))
574          (bits (1- (integer-length denominator))))
575     (unless (and (> denominator 0) (= (ash 1 bits) denominator))
576       (give-up-ir1-transform))
577     (let ((alignment (count-low-order-zeros numerator)))
578       (unless (>= alignment bits)
579         (give-up-ir1-transform))
580       `(ash numerator ,(- bits)))))
581
582 (deftransform ash ((value amount))
583   (let ((value-node (lvar-uses value)))
584     (unless (combination-p value-node)
585       (give-up-ir1-transform))
586     (let ((inside-fun-name (lvar-fun-name (combination-fun value-node))))
587       (multiple-value-bind (prototype width)
588           (modular-version-info inside-fun-name :untagged nil)
589         (unless (eq (or prototype inside-fun-name) 'ash)
590           (give-up-ir1-transform))
591         (when (and width (not (constant-lvar-p amount)))
592           (give-up-ir1-transform))
593         (let ((inside-args (combination-args value-node)))
594           (unless (= (length inside-args) 2)
595             (give-up-ir1-transform))
596           (let ((inside-amount (second inside-args)))
597             (unless (and (constant-lvar-p inside-amount)
598                          (not (minusp (lvar-value inside-amount))))
599               (give-up-ir1-transform)))
600           (splice-fun-args value inside-fun-name 2)
601           (if width
602               `(lambda (value amount1 amount2)
603                  (logand (ash value (+ amount1 amount2))
604                          ,(1- (ash 1 (+ width (lvar-value amount))))))
605               `(lambda (value amount1 amount2)
606                  (ash value (+ amount1 amount2)))))))))
607 \f
608 ;;;; ALIEN-FUNCALL support
609
610 (deftransform alien-funcall ((function &rest args)
611                              ((alien (* t)) &rest *) *
612                              :important t)
613   (let ((names (make-gensym-list (length args))))
614     (/noshow "entering first DEFTRANSFORM ALIEN-FUNCALL" function args)
615     `(lambda (function ,@names)
616        (alien-funcall (deref function) ,@names))))
617
618 ;;; Frame pointer, program counter conses. In each thread it's bound
619 ;;; locally or not bound at all.
620 (defvar *saved-fp-and-pcs*)
621
622 #!+:c-stack-is-control-stack
623 (declaim (inline invoke-with-saved-fp-and-pc))
624 #!+:c-stack-is-control-stack
625 (defun invoke-with-saved-fp-and-pc (fn)
626   (declare #-sb-xc-host (muffle-conditions compiler-note)
627            (optimize (speed 3)))
628   (let* ((fp-and-pc (cons (%caller-frame)
629                           (sap-int (%caller-pc)))))
630     (declare (truly-dynamic-extent fp-and-pc))
631     (let ((*saved-fp-and-pcs* (if (boundp '*saved-fp-and-pcs*)
632                                   (cons fp-and-pc *saved-fp-and-pcs*)
633                                   (list fp-and-pc))))
634       (declare (truly-dynamic-extent *saved-fp-and-pcs*))
635       (funcall fn))))
636
637 (defun find-saved-fp-and-pc (fp)
638   (when (boundp '*saved-fp-and-pcs*)
639     (dolist (x *saved-fp-and-pcs*)
640       (when (#!+:stack-grows-downward-not-upward
641              sap>
642              #!-:stack-grows-downward-not-upward
643              sap<
644              (int-sap (get-lisp-obj-address (car x))) fp)
645         (return (values (car x) (cdr x)))))))
646
647 (deftransform alien-funcall ((function &rest args) * * :node node :important t)
648   (let ((type (lvar-type function)))
649     (unless (alien-type-type-p type)
650       (give-up-ir1-transform "can't tell function type at compile time"))
651     (/noshow "entering second DEFTRANSFORM ALIEN-FUNCALL" function)
652     (let ((alien-type (alien-type-type-alien-type type)))
653       (unless (alien-fun-type-p alien-type)
654         (give-up-ir1-transform))
655       (let ((arg-types (alien-fun-type-arg-types alien-type)))
656         (unless (= (length args) (length arg-types))
657           (abort-ir1-transform
658            "wrong number of arguments; expected ~W, got ~W"
659            (length arg-types)
660            (length args)))
661         (collect ((params) (deports))
662           (dolist (arg-type arg-types)
663             (let ((param (gensym)))
664               (params param)
665               (deports `(deport ,param ',arg-type))))
666           ;; Build BODY from the inside out.
667           (let ((return-type (alien-fun-type-result-type alien-type))
668                 ;; Innermost, we DEPORT the parameters (e.g. by taking SAPs
669                 ;; to them) and do the call.
670                 (body `(%alien-funcall (deport function ',alien-type)
671                                        ',alien-type
672                                        ,@(deports))))
673             ;; Wrap that in a WITH-PINNED-OBJECTS to ensure the values
674             ;; the SAPs are taken for won't be moved by the GC. (If
675             ;; needed: some alien types won't need it).
676             (setf body `(maybe-with-pinned-objects ,(params) ,arg-types
677                           ,body))
678             ;; Around that handle any memory allocation that's needed.
679             ;; Mostly the DEPORT-ALLOC alien-type-methods are just an
680             ;; identity operation, but for example for deporting a
681             ;; Unicode string we need to convert the string into an
682             ;; octet array. This step needs to be done before the pinning
683             ;; to ensure we pin the right objects, so it can't be combined
684             ;; with the deporting.
685             ;; -- JES 2006-03-16
686             (loop for param in (params)
687                   for arg-type in arg-types
688                   do (setf body
689                            `(let ((,param (deport-alloc ,param ',arg-type)))
690                               ,body)))
691             (if (alien-values-type-p return-type)
692                 (collect ((temps) (results))
693                   (dolist (type (alien-values-type-values return-type))
694                     (let ((temp (gensym)))
695                       (temps temp)
696                       (results `(naturalize ,temp ',type))))
697                   (setf body
698                         `(multiple-value-bind ,(temps) ,body
699                            (values ,@(results)))))
700                 (setf body `(naturalize ,body ',return-type)))
701             ;; Remember this frame to make sure that we can get back
702             ;; to it later regardless of how the foreign stack looks
703             ;; like.
704             #!+:c-stack-is-control-stack
705             (when (policy node (<= speed debug))
706               (setf body `(invoke-with-saved-fp-and-pc (lambda () ,body))))
707             (/noshow "returning from DEFTRANSFORM ALIEN-FUNCALL" (params) body)
708             `(lambda (function ,@(params))
709                ,body)))))))
710
711 (defoptimizer (%alien-funcall derive-type) ((function type &rest args))
712   (declare (ignore function args))
713   (unless (constant-lvar-p type)
714     (error "Something is broken."))
715   (let ((type (lvar-value type)))
716     (unless (alien-fun-type-p type)
717       (error "Something is broken."))
718     (values-specifier-type
719      (compute-alien-rep-type
720       (alien-fun-type-result-type type)
721       :result))))
722
723 (defoptimizer (%alien-funcall ltn-annotate)
724               ((function type &rest args) node ltn-policy)
725   (setf (basic-combination-info node) :funny)
726   (setf (node-tail-p node) nil)
727   (annotate-ordinary-lvar function)
728   (dolist (arg args)
729     (annotate-ordinary-lvar arg)))
730
731 ;;; We support both the stdcall and cdecl calling conventions on win32 by
732 ;;; resetting ESP after the foreign function returns. This way it works
733 ;;; correctly whether the party that is supposed to pop arguments from
734 ;;; the stack is the caller (cdecl) or the callee (stdcall).
735 (defoptimizer (%alien-funcall ir2-convert)
736               ((function type &rest args) call block)
737   (let ((type (if (constant-lvar-p type)
738                   (lvar-value type)
739                   (error "Something is broken.")))
740         (lvar (node-lvar call))
741         (args args)
742         #!+x86
743         (stack-pointer (make-stack-pointer-tn)))
744     (multiple-value-bind (nsp stack-frame-size arg-tns result-tns)
745         (make-call-out-tns type)
746       #!+x86
747       (progn
748         (vop set-fpu-word-for-c call block)
749         (vop current-stack-pointer call block stack-pointer))
750       (vop alloc-number-stack-space call block stack-frame-size nsp)
751       (dolist (tn arg-tns)
752         ;; On PPC, TN might be a list. This is used to indicate
753         ;; something special needs to happen. See below.
754         ;;
755         ;; FIXME: We should implement something better than this.
756         (let* ((first-tn (if (listp tn) (car tn) tn))
757                (arg (pop args))
758                (sc (tn-sc first-tn))
759                (scn (sc-number sc))
760                #!-(or x86 x86-64) (temp-tn (make-representation-tn
761                                             (tn-primitive-type first-tn) scn))
762                (move-arg-vops (svref (sc-move-arg-vops sc) scn)))
763           (aver arg)
764           (unless (= (length move-arg-vops) 1)
765             (error "no unique move-arg-vop for moves in SC ~S" (sc-name sc)))
766           #!+(or x86 x86-64) (emit-move-arg-template call
767                                                      block
768                                                      (first move-arg-vops)
769                                                      (lvar-tn call block arg)
770                                                      nsp
771                                                      first-tn)
772           #!-(or x86 x86-64) (progn
773                                (emit-move call
774                                           block
775                                           (lvar-tn call block arg)
776                                           temp-tn)
777                                (emit-move-arg-template call
778                                                        block
779                                                        (first move-arg-vops)
780                                                        temp-tn
781                                                        nsp
782                                                        first-tn))
783           #!+(and ppc darwin)
784           (when (listp tn)
785             ;; This means that we have a float arg that we need to
786             ;; also copy to some int regs. The list contains the TN
787             ;; for the float as well as the TNs to use for the int
788             ;; arg.
789             (destructuring-bind (float-tn i1-tn &optional i2-tn)
790                 tn
791               (if i2-tn
792                   (vop sb!vm::move-double-to-int-arg call block
793                        float-tn i1-tn i2-tn)
794                   (vop sb!vm::move-single-to-int-arg call block
795                        float-tn i1-tn))))))
796       (aver (null args))
797       (unless (listp result-tns)
798         (setf result-tns (list result-tns)))
799       (let ((arg-tns (flatten-list arg-tns)))
800         (vop* call-out call block
801               ((lvar-tn call block function)
802                (reference-tn-list arg-tns nil))
803               ((reference-tn-list result-tns t))))
804       #!-x86
805       (vop dealloc-number-stack-space call block stack-frame-size)
806       #!+x86
807       (progn
808         (vop reset-stack-pointer call block stack-pointer)
809         (vop set-fpu-word-for-lisp call block))
810       (move-lvar-result call block result-tns lvar))))