0.8.4.15:
[sbcl.git] / src / compiler / x86 / arith.lisp
1 ;;;; the VM definition arithmetic VOPs for the x86
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!VM")
13 \f
14 ;;;; unary operations
15
16 (define-vop (fast-safe-arith-op)
17   (:policy :fast-safe)
18   (:effects)
19   (:affected))
20
21 (define-vop (fixnum-unop fast-safe-arith-op)
22   (:args (x :scs (any-reg) :target res))
23   (:results (res :scs (any-reg)))
24   (:note "inline fixnum arithmetic")
25   (:arg-types tagged-num)
26   (:result-types tagged-num))
27
28 (define-vop (signed-unop fast-safe-arith-op)
29   (:args (x :scs (signed-reg) :target res))
30   (:results (res :scs (signed-reg)))
31   (:note "inline (signed-byte 32) arithmetic")
32   (:arg-types signed-num)
33   (:result-types signed-num))
34
35 (define-vop (fast-negate/fixnum fixnum-unop)
36   (:translate %negate)
37   (:generator 1
38     (move res x)
39     (inst neg res)))
40
41 (define-vop (fast-negate/signed signed-unop)
42   (:translate %negate)
43   (:generator 2
44     (move res x)
45     (inst neg res)))
46
47 (define-vop (fast-lognot/fixnum fixnum-unop)
48   (:translate lognot)
49   (:generator 2
50     (move res x)
51     (inst xor res (fixnumize -1))))
52
53 (define-vop (fast-lognot/signed signed-unop)
54   (:translate lognot)
55   (:generator 1
56     (move res x)
57     (inst not res)))
58 \f
59 ;;;; binary fixnum operations
60
61 ;;; Assume that any constant operand is the second arg...
62
63 (define-vop (fast-fixnum-binop fast-safe-arith-op)
64   (:args (x :target r :scs (any-reg)
65             :load-if (not (and (sc-is x control-stack)
66                                (sc-is y any-reg)
67                                (sc-is r control-stack)
68                                (location= x r))))
69          (y :scs (any-reg control-stack)))
70   (:arg-types tagged-num tagged-num)
71   (:results (r :scs (any-reg) :from (:argument 0)
72                :load-if (not (and (sc-is x control-stack)
73                                   (sc-is y any-reg)
74                                   (sc-is r control-stack)
75                                   (location= x r)))))
76   (:result-types tagged-num)
77   (:note "inline fixnum arithmetic"))
78
79 (define-vop (fast-unsigned-binop fast-safe-arith-op)
80   (:args (x :target r :scs (unsigned-reg)
81             :load-if (not (and (sc-is x unsigned-stack)
82                                (sc-is y unsigned-reg)
83                                (sc-is r unsigned-stack)
84                                (location= x r))))
85          (y :scs (unsigned-reg unsigned-stack)))
86   (:arg-types unsigned-num unsigned-num)
87   (:results (r :scs (unsigned-reg) :from (:argument 0)
88             :load-if (not (and (sc-is x unsigned-stack)
89                                (sc-is y unsigned-reg)
90                                (sc-is r unsigned-stack)
91                                (location= x r)))))
92   (:result-types unsigned-num)
93   (:note "inline (unsigned-byte 32) arithmetic"))
94
95 (define-vop (fast-signed-binop fast-safe-arith-op)
96   (:args (x :target r :scs (signed-reg)
97             :load-if (not (and (sc-is x signed-stack)
98                                (sc-is y signed-reg)
99                                (sc-is r signed-stack)
100                                (location= x r))))
101          (y :scs (signed-reg signed-stack)))
102   (:arg-types signed-num signed-num)
103   (:results (r :scs (signed-reg) :from (:argument 0)
104             :load-if (not (and (sc-is x signed-stack)
105                                (sc-is y signed-reg)
106                                (sc-is r signed-stack)
107                                (location= x r)))))
108   (:result-types signed-num)
109   (:note "inline (signed-byte 32) arithmetic"))
110
111 (define-vop (fast-fixnum-binop-c fast-safe-arith-op)
112   (:args (x :target r :scs (any-reg control-stack)))
113   (:info y)
114   (:arg-types tagged-num (:constant (signed-byte 30)))
115   (:results (r :scs (any-reg)
116                :load-if (not (location= x r))))
117   (:result-types tagged-num)
118   (:note "inline fixnum arithmetic"))
119
120 (define-vop (fast-unsigned-binop-c fast-safe-arith-op)
121   (:args (x :target r :scs (unsigned-reg unsigned-stack)))
122   (:info y)
123   (:arg-types unsigned-num (:constant (unsigned-byte 32)))
124   (:results (r :scs (unsigned-reg)
125                :load-if (not (location= x r))))
126   (:result-types unsigned-num)
127   (:note "inline (unsigned-byte 32) arithmetic"))
128
129 (define-vop (fast-signed-binop-c fast-safe-arith-op)
130   (:args (x :target r :scs (signed-reg signed-stack)))
131   (:info y)
132   (:arg-types signed-num (:constant (signed-byte 32)))
133   (:results (r :scs (signed-reg)
134                :load-if (not (location= x r))))
135   (:result-types signed-num)
136   (:note "inline (signed-byte 32) arithmetic"))
137
138 (macrolet ((define-binop (translate untagged-penalty op)
139              `(progn
140                 (define-vop (,(symbolicate "FAST-" translate "/FIXNUM=>FIXNUM")
141                              fast-fixnum-binop)
142                   (:translate ,translate)
143                   (:generator 2
144                               (move r x)
145                               (inst ,op r y)))
146                 (define-vop (,(symbolicate 'fast- translate '-c/fixnum=>fixnum)
147                              fast-fixnum-binop-c)
148                   (:translate ,translate)
149                   (:generator 1
150                   (move r x)
151                   (inst ,op r (fixnumize y))))
152                 (define-vop (,(symbolicate "FAST-" translate "/SIGNED=>SIGNED")
153                              fast-signed-binop)
154                   (:translate ,translate)
155                   (:generator ,(1+ untagged-penalty)
156                   (move r x)
157                   (inst ,op r y)))
158                 (define-vop (,(symbolicate 'fast- translate '-c/signed=>signed)
159                              fast-signed-binop-c)
160                   (:translate ,translate)
161                   (:generator ,untagged-penalty
162                   (move r x)
163                   (inst ,op r y)))
164                 (define-vop (,(symbolicate "FAST-"
165                                            translate
166                                            "/UNSIGNED=>UNSIGNED")
167                 fast-unsigned-binop)
168                   (:translate ,translate)
169                   (:generator ,(1+ untagged-penalty)
170                   (move r x)
171                   (inst ,op r y)))
172                 (define-vop (,(symbolicate 'fast-
173                                            translate
174                                            '-c/unsigned=>unsigned)
175                              fast-unsigned-binop-c)
176                   (:translate ,translate)
177                   (:generator ,untagged-penalty
178                   (move r x)
179                   (inst ,op r y))))))
180
181   ;;(define-binop + 4 add)
182   (define-binop - 4 sub)
183   (define-binop logand 2 and)
184   (define-binop logior 2 or)
185   (define-binop logxor 2 xor))
186
187 ;;; Special handling of add on the x86; can use lea to avoid a
188 ;;; register load, otherwise it uses add.
189 (define-vop (fast-+/fixnum=>fixnum fast-safe-arith-op)
190   (:translate +)
191   (:args (x :scs (any-reg) :target r
192             :load-if (not (and (sc-is x control-stack)
193                                (sc-is y any-reg)
194                                (sc-is r control-stack)
195                                (location= x r))))
196          (y :scs (any-reg control-stack)))
197   (:arg-types tagged-num tagged-num)
198   (:results (r :scs (any-reg) :from (:argument 0)
199                :load-if (not (and (sc-is x control-stack)
200                                   (sc-is y any-reg)
201                                   (sc-is r control-stack)
202                                   (location= x r)))))
203   (:result-types tagged-num)
204   (:note "inline fixnum arithmetic")
205   (:generator 2
206     (cond ((and (sc-is x any-reg) (sc-is y any-reg) (sc-is r any-reg)
207                 (not (location= x r)))
208            (inst lea r (make-ea :dword :base x :index y :scale 1)))
209           (t
210            (move r x)
211            (inst add r y)))))
212
213 (define-vop (fast-+-c/fixnum=>fixnum fast-safe-arith-op)
214   (:translate +)
215   (:args (x :target r :scs (any-reg control-stack)))
216   (:info y)
217   (:arg-types tagged-num (:constant (signed-byte 30)))
218   (:results (r :scs (any-reg)
219                :load-if (not (location= x r))))
220   (:result-types tagged-num)
221   (:note "inline fixnum arithmetic")
222   (:generator 1
223     (cond ((and (sc-is x any-reg) (sc-is r any-reg) (not (location= x r)))
224            (inst lea r (make-ea :dword :base x :disp (fixnumize y))))
225           (t
226            (move r x)
227            (inst add r (fixnumize y))))))
228
229 (define-vop (fast-+/signed=>signed fast-safe-arith-op)
230   (:translate +)
231   (:args (x :scs (signed-reg) :target r
232             :load-if (not (and (sc-is x signed-stack)
233                                (sc-is y signed-reg)
234                                (sc-is r signed-stack)
235                                (location= x r))))
236          (y :scs (signed-reg signed-stack)))
237   (:arg-types signed-num signed-num)
238   (:results (r :scs (signed-reg) :from (:argument 0)
239                :load-if (not (and (sc-is x signed-stack)
240                                   (sc-is y signed-reg)
241                                   (location= x r)))))
242   (:result-types signed-num)
243   (:note "inline (signed-byte 32) arithmetic")
244   (:generator 5
245     (cond ((and (sc-is x signed-reg) (sc-is y signed-reg) (sc-is r signed-reg)
246                 (not (location= x r)))
247            (inst lea r (make-ea :dword :base x :index y :scale 1)))
248           (t
249            (move r x)
250            (inst add r y)))))
251
252
253 ;;;; Special logand cases: (logand signed unsigned) => unsigned
254
255 (define-vop (fast-logand/signed-unsigned=>unsigned
256              fast-logand/unsigned=>unsigned)
257   (:args (x :target r :scs (signed-reg)
258             :load-if (not (and (sc-is x signed-stack)
259                                (sc-is y unsigned-reg)
260                                (sc-is r unsigned-stack)
261                                (location= x r))))
262          (y :scs (unsigned-reg unsigned-stack)))
263   (:arg-types signed-num unsigned-num))
264
265 (define-vop (fast-logand-c/signed-unsigned=>unsigned
266              fast-logand-c/unsigned=>unsigned)
267   (:args (x :target r :scs (signed-reg signed-stack)))
268   (:arg-types signed-num (:constant (unsigned-byte 32))))
269
270 (define-vop (fast-logand/unsigned-signed=>unsigned
271              fast-logand/unsigned=>unsigned)
272   (:args (x :target r :scs (unsigned-reg)
273             :load-if (not (and (sc-is x unsigned-stack)
274                                (sc-is y signed-reg)
275                                (sc-is r unsigned-stack)
276                                (location= x r))))
277          (y :scs (signed-reg signed-stack)))
278   (:arg-types unsigned-num signed-num))
279 \f
280
281 (define-vop (fast-+-c/signed=>signed fast-safe-arith-op)
282   (:translate +)
283   (:args (x :target r :scs (signed-reg signed-stack)))
284   (:info y)
285   (:arg-types signed-num (:constant (signed-byte 32)))
286   (:results (r :scs (signed-reg)
287                :load-if (not (location= x r))))
288   (:result-types signed-num)
289   (:note "inline (signed-byte 32) arithmetic")
290   (:generator 4
291     (cond ((and (sc-is x signed-reg) (sc-is r signed-reg)
292                 (not (location= x r)))
293            (inst lea r (make-ea :dword :base x :disp y)))
294           (t
295            (move r x)
296            (if (= y 1)
297                (inst inc r)
298              (inst add r y))))))
299
300 (define-vop (fast-+/unsigned=>unsigned fast-safe-arith-op)
301   (:translate +)
302   (:args (x :scs (unsigned-reg) :target r
303             :load-if (not (and (sc-is x unsigned-stack)
304                                (sc-is y unsigned-reg)
305                                (sc-is r unsigned-stack)
306                                (location= x r))))
307          (y :scs (unsigned-reg unsigned-stack)))
308   (:arg-types unsigned-num unsigned-num)
309   (:results (r :scs (unsigned-reg) :from (:argument 0)
310                :load-if (not (and (sc-is x unsigned-stack)
311                                   (sc-is y unsigned-reg)
312                                   (sc-is r unsigned-stack)
313                                   (location= x r)))))
314   (:result-types unsigned-num)
315   (:note "inline (unsigned-byte 32) arithmetic")
316   (:generator 5
317     (cond ((and (sc-is x unsigned-reg) (sc-is y unsigned-reg)
318                 (sc-is r unsigned-reg) (not (location= x r)))
319            (inst lea r (make-ea :dword :base x :index y :scale 1)))
320           (t
321            (move r x)
322            (inst add r y)))))
323
324 (define-vop (fast-+-c/unsigned=>unsigned fast-safe-arith-op)
325   (:translate +)
326   (:args (x :target r :scs (unsigned-reg unsigned-stack)))
327   (:info y)
328   (:arg-types unsigned-num (:constant (unsigned-byte 32)))
329   (:results (r :scs (unsigned-reg)
330                :load-if (not (location= x r))))
331   (:result-types unsigned-num)
332   (:note "inline (unsigned-byte 32) arithmetic")
333   (:generator 4
334     (cond ((and (sc-is x unsigned-reg) (sc-is r unsigned-reg)
335                 (not (location= x r)))
336            (inst lea r (make-ea :dword :base x :disp y)))
337           (t
338            (move r x)
339            (if (= y 1)
340                (inst inc r)
341              (inst add r y))))))
342 \f
343 ;;;; multiplication and division
344
345 (define-vop (fast-*/fixnum=>fixnum fast-safe-arith-op)
346   (:translate *)
347   ;; We need different loading characteristics.
348   (:args (x :scs (any-reg) :target r)
349          (y :scs (any-reg control-stack)))
350   (:arg-types tagged-num tagged-num)
351   (:results (r :scs (any-reg) :from (:argument 0)))
352   (:result-types tagged-num)
353   (:note "inline fixnum arithmetic")
354   (:generator 4
355     (move r x)
356     (inst sar r 2)
357     (inst imul r y)))
358
359 (define-vop (fast-*-c/fixnum=>fixnum fast-safe-arith-op)
360   (:translate *)
361   ;; We need different loading characteristics.
362   (:args (x :scs (any-reg control-stack)))
363   (:info y)
364   (:arg-types tagged-num (:constant (signed-byte 30)))
365   (:results (r :scs (any-reg)))
366   (:result-types tagged-num)
367   (:note "inline fixnum arithmetic")
368   (:generator 3
369     (inst imul r x y)))
370
371 (define-vop (fast-*/signed=>signed fast-safe-arith-op)
372   (:translate *)
373   ;; We need different loading characteristics.
374   (:args (x :scs (signed-reg) :target r)
375          (y :scs (signed-reg signed-stack)))
376   (:arg-types signed-num signed-num)
377   (:results (r :scs (signed-reg) :from (:argument 0)))
378   (:result-types signed-num)
379   (:note "inline (signed-byte 32) arithmetic")
380   (:generator 5
381     (move r x)
382     (inst imul r y)))
383
384 (define-vop (fast-*-c/signed=>signed fast-safe-arith-op)
385   (:translate *)
386   ;; We need different loading characteristics.
387   (:args (x :scs (signed-reg signed-stack)))
388   (:info y)
389   (:arg-types signed-num (:constant (signed-byte 32)))
390   (:results (r :scs (signed-reg)))
391   (:result-types signed-num)
392   (:note "inline (signed-byte 32) arithmetic")
393   (:generator 4
394     (inst imul r x y)))
395
396 (define-vop (fast-*/unsigned=>unsigned fast-safe-arith-op)
397   (:translate *)
398   (:args (x :scs (unsigned-reg) :target eax)
399          (y :scs (unsigned-reg unsigned-stack)))
400   (:arg-types unsigned-num unsigned-num)
401   (:temporary (:sc unsigned-reg :offset eax-offset :target result
402                    :from (:argument 0) :to :result) eax)
403   (:temporary (:sc unsigned-reg :offset edx-offset
404                    :from :eval :to :result) edx)
405   (:ignore edx)
406   (:results (result :scs (unsigned-reg)))
407   (:result-types unsigned-num)
408   (:note "inline (unsigned-byte 32) arithmetic")
409   (:vop-var vop)
410   (:save-p :compute-only)
411   (:generator 6
412     (move eax x)
413     (inst mul eax y)
414     (move result eax)))
415
416
417 (define-vop (fast-truncate/fixnum=>fixnum fast-safe-arith-op)
418   (:translate truncate)
419   (:args (x :scs (any-reg) :target eax)
420          (y :scs (any-reg control-stack)))
421   (:arg-types tagged-num tagged-num)
422   (:temporary (:sc signed-reg :offset eax-offset :target quo
423                    :from (:argument 0) :to (:result 0)) eax)
424   (:temporary (:sc unsigned-reg :offset edx-offset :target rem
425                    :from (:argument 0) :to (:result 1)) edx)
426   (:results (quo :scs (any-reg))
427             (rem :scs (any-reg)))
428   (:result-types tagged-num tagged-num)
429   (:note "inline fixnum arithmetic")
430   (:vop-var vop)
431   (:save-p :compute-only)
432   (:generator 31
433     (let ((zero (generate-error-code vop division-by-zero-error x y)))
434       (if (sc-is y any-reg)
435           (inst test y y)  ; smaller instruction
436           (inst cmp y 0))
437       (inst jmp :eq zero))
438     (move eax x)
439     (inst cdq)
440     (inst idiv eax y)
441     (if (location= quo eax)
442         (inst shl eax 2)
443         (inst lea quo (make-ea :dword :index eax :scale 4)))
444     (move rem edx)))
445
446 (define-vop (fast-truncate-c/fixnum=>fixnum fast-safe-arith-op)
447   (:translate truncate)
448   (:args (x :scs (any-reg) :target eax))
449   (:info y)
450   (:arg-types tagged-num (:constant (signed-byte 30)))
451   (:temporary (:sc signed-reg :offset eax-offset :target quo
452                    :from :argument :to (:result 0)) eax)
453   (:temporary (:sc any-reg :offset edx-offset :target rem
454                    :from :eval :to (:result 1)) edx)
455   (:temporary (:sc any-reg :from :eval :to :result) y-arg)
456   (:results (quo :scs (any-reg))
457             (rem :scs (any-reg)))
458   (:result-types tagged-num tagged-num)
459   (:note "inline fixnum arithmetic")
460   (:vop-var vop)
461   (:save-p :compute-only)
462   (:generator 30
463     (move eax x)
464     (inst cdq)
465     (inst mov y-arg (fixnumize y))
466     (inst idiv eax y-arg)
467     (if (location= quo eax)
468         (inst shl eax 2)
469         (inst lea quo (make-ea :dword :index eax :scale 4)))
470     (move rem edx)))
471
472 (define-vop (fast-truncate/unsigned=>unsigned fast-safe-arith-op)
473   (:translate truncate)
474   (:args (x :scs (unsigned-reg) :target eax)
475          (y :scs (unsigned-reg signed-stack)))
476   (:arg-types unsigned-num unsigned-num)
477   (:temporary (:sc unsigned-reg :offset eax-offset :target quo
478                    :from (:argument 0) :to (:result 0)) eax)
479   (:temporary (:sc unsigned-reg :offset edx-offset :target rem
480                    :from (:argument 0) :to (:result 1)) edx)
481   (:results (quo :scs (unsigned-reg))
482             (rem :scs (unsigned-reg)))
483   (:result-types unsigned-num unsigned-num)
484   (:note "inline (unsigned-byte 32) arithmetic")
485   (:vop-var vop)
486   (:save-p :compute-only)
487   (:generator 33
488     (let ((zero (generate-error-code vop division-by-zero-error x y)))
489       (if (sc-is y unsigned-reg)
490           (inst test y y)  ; smaller instruction
491           (inst cmp y 0))
492       (inst jmp :eq zero))
493     (move eax x)
494     (inst xor edx edx)
495     (inst div eax y)
496     (move quo eax)
497     (move rem edx)))
498
499 (define-vop (fast-truncate-c/unsigned=>unsigned fast-safe-arith-op)
500   (:translate truncate)
501   (:args (x :scs (unsigned-reg) :target eax))
502   (:info y)
503   (:arg-types unsigned-num (:constant (unsigned-byte 32)))
504   (:temporary (:sc unsigned-reg :offset eax-offset :target quo
505                    :from :argument :to (:result 0)) eax)
506   (:temporary (:sc unsigned-reg :offset edx-offset :target rem
507                    :from :eval :to (:result 1)) edx)
508   (:temporary (:sc unsigned-reg :from :eval :to :result) y-arg)
509   (:results (quo :scs (unsigned-reg))
510             (rem :scs (unsigned-reg)))
511   (:result-types unsigned-num unsigned-num)
512   (:note "inline (unsigned-byte 32) arithmetic")
513   (:vop-var vop)
514   (:save-p :compute-only)
515   (:generator 32
516     (move eax x)
517     (inst xor edx edx)
518     (inst mov y-arg y)
519     (inst div eax y-arg)
520     (move quo eax)
521     (move rem edx)))
522
523 (define-vop (fast-truncate/signed=>signed fast-safe-arith-op)
524   (:translate truncate)
525   (:args (x :scs (signed-reg) :target eax)
526          (y :scs (signed-reg signed-stack)))
527   (:arg-types signed-num signed-num)
528   (:temporary (:sc signed-reg :offset eax-offset :target quo
529                    :from (:argument 0) :to (:result 0)) eax)
530   (:temporary (:sc signed-reg :offset edx-offset :target rem
531                    :from (:argument 0) :to (:result 1)) edx)
532   (:results (quo :scs (signed-reg))
533             (rem :scs (signed-reg)))
534   (:result-types signed-num signed-num)
535   (:note "inline (signed-byte 32) arithmetic")
536   (:vop-var vop)
537   (:save-p :compute-only)
538   (:generator 33
539     (let ((zero (generate-error-code vop division-by-zero-error x y)))
540       (if (sc-is y signed-reg)
541           (inst test y y)  ; smaller instruction
542           (inst cmp y 0))
543       (inst jmp :eq zero))
544     (move eax x)
545     (inst cdq)
546     (inst idiv eax y)
547     (move quo eax)
548     (move rem edx)))
549
550 (define-vop (fast-truncate-c/signed=>signed fast-safe-arith-op)
551   (:translate truncate)
552   (:args (x :scs (signed-reg) :target eax))
553   (:info y)
554   (:arg-types signed-num (:constant (signed-byte 32)))
555   (:temporary (:sc signed-reg :offset eax-offset :target quo
556                    :from :argument :to (:result 0)) eax)
557   (:temporary (:sc signed-reg :offset edx-offset :target rem
558                    :from :eval :to (:result 1)) edx)
559   (:temporary (:sc signed-reg :from :eval :to :result) y-arg)
560   (:results (quo :scs (signed-reg))
561             (rem :scs (signed-reg)))
562   (:result-types signed-num signed-num)
563   (:note "inline (signed-byte 32) arithmetic")
564   (:vop-var vop)
565   (:save-p :compute-only)
566   (:generator 32
567     (move eax x)
568     (inst cdq)
569     (inst mov y-arg y)
570     (inst idiv eax y-arg)
571     (move quo eax)
572     (move rem edx)))
573
574
575 \f
576 ;;;; Shifting
577 (define-vop (fast-ash-c/fixnum=>fixnum)
578   (:translate ash)
579   (:policy :fast-safe)
580   (:args (number :scs (any-reg) :target result
581                  :load-if (not (and (sc-is number any-reg control-stack)
582                                     (sc-is result any-reg control-stack)
583                                     (location= number result)))))
584   (:info amount)
585   (:arg-types tagged-num (:constant integer))
586   (:results (result :scs (any-reg)
587                     :load-if (not (and (sc-is number control-stack)
588                                        (sc-is result control-stack)
589                                        (location= number result)))))
590   (:result-types tagged-num)
591   (:note "inline ASH")
592   (:generator 2
593     (cond ((and (= amount 1) (not (location= number result)))
594            (inst lea result (make-ea :dword :index number :scale 2)))
595           ((and (= amount 2) (not (location= number result)))
596            (inst lea result (make-ea :dword :index number :scale 4)))
597           ((and (= amount 3) (not (location= number result)))
598            (inst lea result (make-ea :dword :index number :scale 8)))
599           (t
600            (move result number)
601            (cond ((plusp amount)
602                   ;; We don't have to worry about overflow because of the
603                   ;; result type restriction.
604                   (inst shl result amount))
605                  (t
606                   ;; If the amount is greater than 31, only shift by 31. We
607                   ;; have to do this because the shift instructions only look
608                   ;; at the low five bits of the result.
609                   (inst sar result (min 31 (- amount)))
610                   ;; Fixnum correction.
611                   (inst and result #xfffffffc)))))))
612
613 (define-vop (fast-ash-left/fixnum=>fixnum)
614   (:translate ash)
615   (:args (number :scs (any-reg) :target result
616                  :load-if (not (and (sc-is number control-stack)
617                                     (sc-is result control-stack)
618                                     (location= number result))))
619          (amount :scs (unsigned-reg) :target ecx))
620   (:arg-types tagged-num positive-fixnum)
621   (:temporary (:sc unsigned-reg :offset ecx-offset :from (:argument 1)) ecx)
622   (:results (result :scs (any-reg) :from (:argument 0)
623                     :load-if (not (and (sc-is number control-stack)
624                                        (sc-is result control-stack)
625                                        (location= number result)))))
626   (:result-types tagged-num)
627   (:policy :fast-safe)
628   (:note "inline ASH")
629   (:generator 3
630     (move result number)
631     (move ecx amount)
632     ;; The result-type ensures us that this shift will not overflow.
633     (inst shl result :cl)))
634
635 (define-vop (fast-ash-c/signed=>signed)
636   (:translate ash)
637   (:policy :fast-safe)
638   (:args (number :scs (signed-reg) :target result
639                  :load-if (not (and (sc-is number signed-stack)
640                                     (sc-is result signed-stack)
641                                     (location= number result)))))
642   (:info amount)
643   (:arg-types signed-num (:constant integer))
644   (:results (result :scs (signed-reg)
645                     :load-if (not (and (sc-is number signed-stack)
646                                        (sc-is result signed-stack)
647                                        (location= number result)))))
648   (:result-types signed-num)
649   (:note "inline ASH")
650   (:generator 3
651     (cond ((and (= amount 1) (not (location= number result)))
652            (inst lea result (make-ea :dword :index number :scale 2)))
653           ((and (= amount 2) (not (location= number result)))
654            (inst lea result (make-ea :dword :index number :scale 4)))
655           ((and (= amount 3) (not (location= number result)))
656            (inst lea result (make-ea :dword :index number :scale 8)))
657           (t
658            (move result number)
659            (cond ((plusp amount) (inst shl result amount))
660                  (t (inst sar result (min 31 (- amount)))))))))
661
662 (define-vop (fast-ash-c/unsigned=>unsigned)
663   (:translate ash)
664   (:policy :fast-safe)
665   (:args (number :scs (unsigned-reg) :target result
666                  :load-if (not (and (sc-is number unsigned-stack)
667                                     (sc-is result unsigned-stack)
668                                     (location= number result)))))
669   (:info amount)
670   (:arg-types unsigned-num (:constant integer))
671   (:results (result :scs (unsigned-reg)
672                     :load-if (not (and (sc-is number unsigned-stack)
673                                        (sc-is result unsigned-stack)
674                                        (location= number result)))))
675   (:result-types unsigned-num)
676   (:note "inline ASH")
677   (:generator 3
678     (cond ((and (= amount 1) (not (location= number result)))
679            (inst lea result (make-ea :dword :index number :scale 2)))
680           ((and (= amount 2) (not (location= number result)))
681            (inst lea result (make-ea :dword :index number :scale 4)))
682           ((and (= amount 3) (not (location= number result)))
683            (inst lea result (make-ea :dword :index number :scale 8)))
684           (t
685            (move result number)
686            (cond ((plusp amount) (inst shl result amount))
687                  ((< amount -31) (inst xor result result))
688                  (t (inst shr result (- amount))))))))
689
690 (define-vop (fast-ash-left/signed=>signed)
691   (:translate ash)
692   (:args (number :scs (signed-reg) :target result
693                  :load-if (not (and (sc-is number signed-stack)
694                                     (sc-is result signed-stack)
695                                     (location= number result))))
696          (amount :scs (unsigned-reg) :target ecx))
697   (:arg-types signed-num positive-fixnum)
698   (:temporary (:sc unsigned-reg :offset ecx-offset :from (:argument 1)) ecx)
699   (:results (result :scs (signed-reg) :from (:argument 0)
700                     :load-if (not (and (sc-is number signed-stack)
701                                        (sc-is result signed-stack)
702                                        (location= number result)))))
703   (:result-types signed-num)
704   (:policy :fast-safe)
705   (:note "inline ASH")
706   (:generator 4
707     (move result number)
708     (move ecx amount)
709     (inst shl result :cl)))
710
711 (define-vop (fast-ash-left/unsigned=>unsigned)
712   (:translate ash)
713   (:args (number :scs (unsigned-reg) :target result
714                  :load-if (not (and (sc-is number unsigned-stack)
715                                     (sc-is result unsigned-stack)
716                                     (location= number result))))
717          (amount :scs (unsigned-reg) :target ecx))
718   (:arg-types unsigned-num positive-fixnum)
719   (:temporary (:sc unsigned-reg :offset ecx-offset :from (:argument 1)) ecx)
720   (:results (result :scs (unsigned-reg) :from (:argument 0)
721                     :load-if (not (and (sc-is number unsigned-stack)
722                                        (sc-is result unsigned-stack)
723                                        (location= number result)))))
724   (:result-types unsigned-num)
725   (:policy :fast-safe)
726   (:note "inline ASH")
727   (:generator 4
728     (move result number)
729     (move ecx amount)
730     (inst shl result :cl)))
731
732 (define-vop (fast-ash/signed=>signed)
733   (:translate ash)
734   (:policy :fast-safe)
735   (:args (number :scs (signed-reg) :target result)
736          (amount :scs (signed-reg) :target ecx))
737   (:arg-types signed-num signed-num)
738   (:results (result :scs (signed-reg) :from (:argument 0)))
739   (:result-types signed-num)
740   (:temporary (:sc signed-reg :offset ecx-offset :from (:argument 1)) ecx)
741   (:note "inline ASH")
742   (:generator 5
743     (move result number)
744     (move ecx amount)
745     (inst or ecx ecx)
746     (inst jmp :ns positive)
747     (inst neg ecx)
748     (inst cmp ecx 31)
749     (inst jmp :be okay)
750     (inst mov ecx 31)
751     OKAY
752     (inst sar result :cl)
753     (inst jmp done)
754
755     POSITIVE
756     ;; The result-type ensures us that this shift will not overflow.
757     (inst shl result :cl)
758
759     DONE))
760
761 (define-vop (fast-ash/unsigned=>unsigned)
762   (:translate ash)
763   (:policy :fast-safe)
764   (:args (number :scs (unsigned-reg) :target result)
765          (amount :scs (signed-reg) :target ecx))
766   (:arg-types unsigned-num signed-num)
767   (:results (result :scs (unsigned-reg) :from (:argument 0)))
768   (:result-types unsigned-num)
769   (:temporary (:sc signed-reg :offset ecx-offset :from (:argument 1)) ecx)
770   (:note "inline ASH")
771   (:generator 5
772     (move result number)
773     (move ecx amount)
774     (inst or ecx ecx)
775     (inst jmp :ns positive)
776     (inst neg ecx)
777     (inst cmp ecx 31)
778     (inst jmp :be okay)
779     (inst xor result result)
780     (inst jmp done)
781     OKAY
782     (inst shr result :cl)
783     (inst jmp done)
784
785     POSITIVE
786     ;; The result-type ensures us that this shift will not overflow.
787     (inst shl result :cl)
788
789     DONE))
790
791 ;;; FIXME: before making knowledge of this too public, it needs to be
792 ;;; fixed so that it's actually _faster_ than the non-CMOV version; at
793 ;;; least on my Celeron-XXX laptop, this version is marginally slower
794 ;;; than the above version with branches.  -- CSR, 2003-09-04
795 (define-vop (fast-cmov-ash/unsigned=>unsigned)
796   (:translate ash)
797   (:policy :fast-safe)
798   (:args (number :scs (unsigned-reg) :target result)
799          (amount :scs (signed-reg) :target ecx))
800   (:arg-types unsigned-num signed-num)
801   (:results (result :scs (unsigned-reg) :from (:argument 0)))
802   (:result-types unsigned-num)
803   (:temporary (:sc signed-reg :offset ecx-offset :from (:argument 1)) ecx)
804   (:temporary (:sc any-reg :from (:eval 0) :to (:eval 1)) zero)
805   (:note "inline ASH")
806   (:guard (member :cmov *backend-subfeatures*))
807   (:generator 4
808     (move result number)
809     (move ecx amount)
810     (inst or ecx ecx)
811     (inst jmp :ns positive)
812     (inst neg ecx)
813     (inst xor zero zero)
814     (inst shr result :cl)
815     (inst cmp ecx 31)
816     (inst cmov :nbe result zero)
817     (inst jmp done)
818     
819     POSITIVE
820     ;; The result-type ensures us that this shift will not overflow.
821     (inst shl result :cl)
822
823     DONE))
824 \f
825 ;;; Note: documentation for this function is wrong - rtfm
826 (define-vop (signed-byte-32-len)
827   (:translate integer-length)
828   (:note "inline (signed-byte 32) integer-length")
829   (:policy :fast-safe)
830   (:args (arg :scs (signed-reg) :target res))
831   (:arg-types signed-num)
832   (:results (res :scs (unsigned-reg)))
833   (:result-types unsigned-num)
834   (:generator 28
835     (move res arg)
836     (inst cmp res 0)
837     (inst jmp :ge POS)
838     (inst not res)
839     POS
840     (inst bsr res res)
841     (inst jmp :z zero)
842     (inst inc res)
843     (inst jmp done)
844     ZERO
845     (inst xor res res)
846     DONE))
847
848 (define-vop (unsigned-byte-32-len)
849   (:translate integer-length)
850   (:note "inline (unsigned-byte 32) integer-length")
851   (:policy :fast-safe)
852   (:args (arg :scs (unsigned-reg)))
853   (:arg-types unsigned-num)
854   (:results (res :scs (unsigned-reg)))
855   (:result-types unsigned-num)
856   (:generator 26
857     (inst bsr res arg)
858     (inst jmp :z zero)
859     (inst inc res)
860     (inst jmp done)
861     ZERO
862     (inst xor res res)
863     DONE))
864
865 (define-vop (unsigned-byte-32-count)
866   (:translate logcount)
867   (:note "inline (unsigned-byte 32) logcount")
868   (:policy :fast-safe)
869   (:args (arg :scs (unsigned-reg)))
870   (:arg-types unsigned-num)
871   (:results (result :scs (unsigned-reg)))
872   (:result-types positive-fixnum)
873   (:temporary (:sc unsigned-reg :from (:argument 0)) temp)
874   (:generator 30
875     (move result arg)
876
877     (inst mov temp result)
878     (inst shr temp 1)
879     (inst and result #x55555555)
880     (inst and temp #x55555555)
881     (inst add result temp)
882
883     (inst mov temp result)
884     (inst shr temp 2)
885     (inst and result #x33333333)
886     (inst and temp #x33333333)
887     (inst add result temp)
888
889     (inst mov temp result)
890     (inst shr temp 4)
891     (inst and result #x0f0f0f0f)
892     (inst and temp #x0f0f0f0f)
893     (inst add result temp)
894
895     (inst mov temp result)
896     (inst shr temp 8)
897     (inst and result #x00ff00ff)
898     (inst and temp #x00ff00ff)
899     (inst add result temp)
900
901     (inst mov temp result)
902     (inst shr temp 16)
903     (inst and result #x0000ffff)
904     (inst and temp #x0000ffff)
905     (inst add result temp)))
906 \f
907 ;;;; binary conditional VOPs
908
909 (define-vop (fast-conditional)
910   (:conditional)
911   (:info target not-p)
912   (:effects)
913   (:affected)
914   (:policy :fast-safe))
915
916 (define-vop (fast-conditional/fixnum fast-conditional)
917   (:args (x :scs (any-reg)
918             :load-if (not (and (sc-is x control-stack)
919                                (sc-is y any-reg))))
920          (y :scs (any-reg control-stack)))
921   (:arg-types tagged-num tagged-num)
922   (:note "inline fixnum comparison"))
923
924 (define-vop (fast-conditional-c/fixnum fast-conditional/fixnum)
925   (:args (x :scs (any-reg control-stack)))
926   (:arg-types tagged-num (:constant (signed-byte 30)))
927   (:info target not-p y))
928
929 (define-vop (fast-conditional/signed fast-conditional)
930   (:args (x :scs (signed-reg)
931             :load-if (not (and (sc-is x signed-stack)
932                                (sc-is y signed-reg))))
933          (y :scs (signed-reg signed-stack)))
934   (:arg-types signed-num signed-num)
935   (:note "inline (signed-byte 32) comparison"))
936
937 (define-vop (fast-conditional-c/signed fast-conditional/signed)
938   (:args (x :scs (signed-reg signed-stack)))
939   (:arg-types signed-num (:constant (signed-byte 32)))
940   (:info target not-p y))
941
942 (define-vop (fast-conditional/unsigned fast-conditional)
943   (:args (x :scs (unsigned-reg)
944             :load-if (not (and (sc-is x unsigned-stack)
945                                (sc-is y unsigned-reg))))
946          (y :scs (unsigned-reg unsigned-stack)))
947   (:arg-types unsigned-num unsigned-num)
948   (:note "inline (unsigned-byte 32) comparison"))
949
950 (define-vop (fast-conditional-c/unsigned fast-conditional/unsigned)
951   (:args (x :scs (unsigned-reg unsigned-stack)))
952   (:arg-types unsigned-num (:constant (unsigned-byte 32)))
953   (:info target not-p y))
954
955
956 (macrolet ((define-conditional-vop (tran cond unsigned not-cond not-unsigned)
957              `(progn
958                 ,@(mapcar
959                    (lambda (suffix cost signed)
960                      `(define-vop (;; FIXME: These could be done more
961                                    ;; cleanly with SYMBOLICATE.
962                                    ,(intern (format nil "~:@(FAST-IF-~A~A~)"
963                                                     tran suffix))
964                                    ,(intern
965                                      (format nil "~:@(FAST-CONDITIONAL~A~)"
966                                              suffix)))
967                         (:translate ,tran)
968                         (:generator ,cost
969                                     (inst cmp x
970                                           ,(if (eq suffix '-c/fixnum)
971                                                '(fixnumize y)
972                                                'y))
973                                     (inst jmp (if not-p
974                                                   ,(if signed
975                                                        not-cond
976                                                        not-unsigned)
977                                                   ,(if signed
978                                                        cond
979                                                        unsigned))
980                                           target))))
981                    '(/fixnum -c/fixnum /signed -c/signed /unsigned -c/unsigned)
982                    '(4 3 6 5 6 5)
983                    '(t t t t nil nil)))))
984
985   (define-conditional-vop < :l :b :ge :ae)
986   (define-conditional-vop > :g :a :le :be))
987
988 (define-vop (fast-if-eql/signed fast-conditional/signed)
989   (:translate eql)
990   (:generator 6
991     (inst cmp x y)
992     (inst jmp (if not-p :ne :e) target)))
993
994 (define-vop (fast-if-eql-c/signed fast-conditional-c/signed)
995   (:translate eql)
996   (:generator 5
997     (cond ((and (sc-is x signed-reg) (zerop y))
998            (inst test x x))  ; smaller instruction
999           (t
1000            (inst cmp x y)))
1001     (inst jmp (if not-p :ne :e) target)))
1002
1003 (define-vop (fast-if-eql/unsigned fast-conditional/unsigned)
1004   (:translate eql)
1005   (:generator 6
1006     (inst cmp x y)
1007     (inst jmp (if not-p :ne :e) target)))
1008
1009 (define-vop (fast-if-eql-c/unsigned fast-conditional-c/unsigned)
1010   (:translate eql)
1011   (:generator 5
1012     (cond ((and (sc-is x unsigned-reg) (zerop y))
1013            (inst test x x))  ; smaller instruction
1014           (t
1015            (inst cmp x y)))
1016     (inst jmp (if not-p :ne :e) target)))
1017
1018 ;;; EQL/FIXNUM is funny because the first arg can be of any type, not just a
1019 ;;; known fixnum.
1020
1021 ;;; These versions specify a fixnum restriction on their first arg. We have
1022 ;;; also generic-eql/fixnum VOPs which are the same, but have no restriction on
1023 ;;; the first arg and a higher cost. The reason for doing this is to prevent
1024 ;;; fixnum specific operations from being used on word integers, spuriously
1025 ;;; consing the argument.
1026
1027 (define-vop (fast-eql/fixnum fast-conditional)
1028   (:args (x :scs (any-reg)
1029             :load-if (not (and (sc-is x control-stack)
1030                                (sc-is y any-reg))))
1031          (y :scs (any-reg control-stack)))
1032   (:arg-types tagged-num tagged-num)
1033   (:note "inline fixnum comparison")
1034   (:translate eql)
1035   (:generator 4
1036     (inst cmp x y)
1037     (inst jmp (if not-p :ne :e) target)))
1038 (define-vop (generic-eql/fixnum fast-eql/fixnum)
1039   (:args (x :scs (any-reg descriptor-reg)
1040             :load-if (not (and (sc-is x control-stack)
1041                                (sc-is y any-reg))))
1042          (y :scs (any-reg control-stack)))
1043   (:arg-types * tagged-num)
1044   (:variant-cost 7))
1045
1046 (define-vop (fast-eql-c/fixnum fast-conditional/fixnum)
1047   (:args (x :scs (any-reg control-stack)))
1048   (:arg-types tagged-num (:constant (signed-byte 30)))
1049   (:info target not-p y)
1050   (:translate eql)
1051   (:generator 2
1052     (cond ((and (sc-is x any-reg) (zerop y))
1053            (inst test x x))  ; smaller instruction
1054           (t
1055            (inst cmp x (fixnumize y))))
1056     (inst jmp (if not-p :ne :e) target)))
1057 (define-vop (generic-eql-c/fixnum fast-eql-c/fixnum)
1058   (:args (x :scs (any-reg descriptor-reg control-stack)))
1059   (:arg-types * (:constant (signed-byte 30)))
1060   (:variant-cost 6))
1061 \f
1062 ;;;; 32-bit logical operations
1063
1064 (define-vop (merge-bits)
1065   (:translate merge-bits)
1066   (:args (shift :scs (signed-reg unsigned-reg) :target ecx)
1067          (prev :scs (unsigned-reg) :target result)
1068          (next :scs (unsigned-reg)))
1069   (:arg-types tagged-num unsigned-num unsigned-num)
1070   (:temporary (:sc signed-reg :offset ecx-offset :from (:argument 0)) ecx)
1071   (:results (result :scs (unsigned-reg) :from (:argument 1)))
1072   (:result-types unsigned-num)
1073   (:policy :fast-safe)
1074   (:generator 4
1075     (move ecx shift)
1076     (move result prev)
1077     (inst shrd result next :cl)))
1078
1079 (define-source-transform 32bit-logical-not (x)
1080   `(logand (lognot (the (unsigned-byte 32) ,x)) #.(1- (ash 1 32))))
1081
1082 (deftransform 32bit-logical-and ((x y))
1083   '(logand x y))
1084
1085 (define-source-transform 32bit-logical-nand (x y)
1086   `(32bit-logical-not (32bit-logical-and ,x ,y)))
1087
1088 (deftransform 32bit-logical-or ((x y))
1089   '(logior x y))
1090
1091 (define-source-transform 32bit-logical-nor (x y)
1092   `(32bit-logical-not (32bit-logical-or ,x ,y)))
1093
1094 (deftransform 32bit-logical-xor ((x y))
1095   '(logxor x y))
1096
1097 (define-source-transform 32bit-logical-eqv (x y)
1098   `(32bit-logical-not (32bit-logical-xor ,x ,y)))
1099
1100 (define-source-transform 32bit-logical-orc1 (x y)
1101   `(32bit-logical-or (32bit-logical-not ,x) ,y))
1102
1103 (define-source-transform 32bit-logical-orc2 (x y)
1104   `(32bit-logical-or ,x (32bit-logical-not ,y)))
1105
1106 (define-source-transform 32bit-logical-andc1 (x y)
1107   `(32bit-logical-and (32bit-logical-not ,x) ,y))
1108
1109 (define-source-transform 32bit-logical-andc2 (x y)
1110   `(32bit-logical-and ,x (32bit-logical-not ,y)))
1111
1112 ;;; Only the lower 5 bits of the shift amount are significant.
1113 (define-vop (shift-towards-someplace)
1114   (:policy :fast-safe)
1115   (:args (num :scs (unsigned-reg) :target r)
1116          (amount :scs (signed-reg) :target ecx))
1117   (:arg-types unsigned-num tagged-num)
1118   (:temporary (:sc signed-reg :offset ecx-offset :from (:argument 1)) ecx)
1119   (:results (r :scs (unsigned-reg) :from (:argument 0)))
1120   (:result-types unsigned-num))
1121
1122 (define-vop (shift-towards-start shift-towards-someplace)
1123   (:translate shift-towards-start)
1124   (:note "SHIFT-TOWARDS-START")
1125   (:generator 1
1126     (move r num)
1127     (move ecx amount)
1128     (inst shr r :cl)))
1129
1130 (define-vop (shift-towards-end shift-towards-someplace)
1131   (:translate shift-towards-end)
1132   (:note "SHIFT-TOWARDS-END")
1133   (:generator 1
1134     (move r num)
1135     (move ecx amount)
1136     (inst shl r :cl)))
1137 \f
1138 ;;;; Modular functions
1139
1140 (define-modular-fun +-mod32 (x y) + 32)
1141 (define-vop (fast-+-mod32/unsigned=>unsigned fast-+/unsigned=>unsigned)
1142   (:translate +-mod32))
1143 (define-vop (fast-+-mod32-c/unsigned=>unsigned fast-+-c/unsigned=>unsigned)
1144   (:translate +-mod32))
1145 (define-modular-fun --mod32 (x y) - 32)
1146 (define-vop (fast---mod32/unsigned=>unsigned fast--/unsigned=>unsigned)
1147   (:translate --mod32))
1148 (define-vop (fast---mod32-c/unsigned=>unsigned fast---c/unsigned=>unsigned)
1149   (:translate --mod32))
1150
1151 (define-vop (fast-ash-left-mod32-c/unsigned=>unsigned
1152              fast-ash-c/unsigned=>unsigned)
1153   (:translate ash-left-mod32))
1154
1155 ;;; logical operations
1156 (define-modular-fun lognot-mod32 (x) lognot 32)
1157 (define-vop (lognot-mod32/unsigned=>unsigned)
1158   (:translate lognot-mod32)
1159   (:args (x :scs (unsigned-reg unsigned-stack) :target r
1160             :load-if (not (and (sc-is x unsigned-stack)
1161                                (sc-is r unsigned-stack)
1162                                (location= x r)))))
1163   (:arg-types unsigned-num)
1164   (:results (r :scs (unsigned-reg)
1165                :load-if (not (and (sc-is x unsigned-stack)
1166                                   (sc-is r unsigned-stack)
1167                                   (location= x r)))))
1168   (:result-types unsigned-num)
1169   (:policy :fast-safe)
1170   (:generator 1
1171     (move r x)
1172     (inst not r)))
1173
1174 (define-modular-fun logxor-mod32 (x y) logxor 32)
1175 (define-vop (fast-logxor-mod32/unsigned=>unsigned
1176              fast-logxor/unsigned=>unsigned)
1177   (:translate logxor-mod32))
1178 (define-vop (fast-logxor-mod32-c/unsigned=>unsigned
1179              fast-logxor-c/unsigned=>unsigned)
1180   (:translate logxor-mod32))
1181
1182 (define-source-transform logeqv (&rest args)
1183   (if (oddp (length args))
1184       `(logxor ,@args)
1185       `(lognot (logxor ,@args))))
1186 (define-source-transform logandc1 (x y)
1187   `(logand (lognot ,x) ,y))
1188 (define-source-transform logandc2 (x y)
1189   `(logand ,x (lognot ,y)))
1190 (define-source-transform logorc1 (x y)
1191   `(logior (lognot ,x) ,y))
1192 (define-source-transform logorc2 (x y)
1193   `(logior ,x (lognot ,y)))
1194 (define-source-transform lognor (x y)
1195   `(lognot (logior ,x ,y)))
1196 (define-source-transform lognand (x y)
1197   `(lognot (logand ,x ,y)))
1198 \f
1199 ;;;; bignum stuff
1200
1201 (define-vop (bignum-length get-header-data)
1202   (:translate sb!bignum::%bignum-length)
1203   (:policy :fast-safe))
1204
1205 (define-vop (bignum-set-length set-header-data)
1206   (:translate sb!bignum::%bignum-set-length)
1207   (:policy :fast-safe))
1208
1209 (define-full-reffer bignum-ref * bignum-digits-offset other-pointer-lowtag
1210   (unsigned-reg) unsigned-num sb!bignum::%bignum-ref)
1211
1212 (define-full-setter bignum-set * bignum-digits-offset other-pointer-lowtag
1213   (unsigned-reg) unsigned-num sb!bignum::%bignum-set)
1214
1215 (define-vop (digit-0-or-plus)
1216   (:translate sb!bignum::%digit-0-or-plusp)
1217   (:policy :fast-safe)
1218   (:args (digit :scs (unsigned-reg)))
1219   (:arg-types unsigned-num)
1220   (:conditional)
1221   (:info target not-p)
1222   (:generator 3
1223     (inst or digit digit)
1224     (inst jmp (if not-p :s :ns) target)))
1225
1226
1227 ;;; For add and sub with carry the sc of carry argument is any-reg so
1228 ;;; the it may be passed as a fixnum or word and thus may be 0, 1, or
1229 ;;; 4. This is easy to deal with and may save a fixnum-word
1230 ;;; conversion.
1231 (define-vop (add-w/carry)
1232   (:translate sb!bignum::%add-with-carry)
1233   (:policy :fast-safe)
1234   (:args (a :scs (unsigned-reg) :target result)
1235          (b :scs (unsigned-reg unsigned-stack) :to :eval)
1236          (c :scs (any-reg) :target temp))
1237   (:arg-types unsigned-num unsigned-num positive-fixnum)
1238   (:temporary (:sc any-reg :from (:argument 2) :to :eval) temp)
1239   (:results (result :scs (unsigned-reg) :from (:argument 0))
1240             (carry :scs (unsigned-reg)))
1241   (:result-types unsigned-num positive-fixnum)
1242   (:generator 4
1243     (move result a)
1244     (move temp c)
1245     (inst neg temp) ; Set the carry flag to 0 if c=0 else to 1
1246     (inst adc result b)
1247     (inst mov carry 0)
1248     (inst adc carry carry)))
1249
1250 ;;; Note: the borrow is the oppostite of the x86 convention - 1 for no
1251 ;;; borrow and 0 for a borrow.
1252 (define-vop (sub-w/borrow)
1253   (:translate sb!bignum::%subtract-with-borrow)
1254   (:policy :fast-safe)
1255   (:args (a :scs (unsigned-reg) :to :eval :target result)
1256          (b :scs (unsigned-reg unsigned-stack) :to :result)
1257          (c :scs (any-reg control-stack)))
1258   (:arg-types unsigned-num unsigned-num positive-fixnum)
1259   (:results (result :scs (unsigned-reg) :from :eval)
1260             (borrow :scs (unsigned-reg)))
1261   (:result-types unsigned-num positive-fixnum)
1262   (:generator 5
1263     (inst cmp c 1) ; Set the carry flag to 1 if c=0 else to 0
1264     (move result a)
1265     (inst sbb result b)
1266     (inst mov borrow 0)
1267     (inst adc borrow borrow)
1268     (inst xor borrow 1)))
1269
1270
1271 (define-vop (bignum-mult-and-add-3-arg)
1272   (:translate sb!bignum::%multiply-and-add)
1273   (:policy :fast-safe)
1274   (:args (x :scs (unsigned-reg) :target eax)
1275          (y :scs (unsigned-reg unsigned-stack))
1276          (carry-in :scs (unsigned-reg unsigned-stack)))
1277   (:arg-types unsigned-num unsigned-num unsigned-num)
1278   (:temporary (:sc unsigned-reg :offset eax-offset :from (:argument 0)
1279                    :to (:result 1) :target lo) eax)
1280   (:temporary (:sc unsigned-reg :offset edx-offset :from (:argument 1)
1281                    :to (:result 0) :target hi) edx)
1282   (:results (hi :scs (unsigned-reg))
1283             (lo :scs (unsigned-reg)))
1284   (:result-types unsigned-num unsigned-num)
1285   (:generator 20
1286     (move eax x)
1287     (inst mul eax y)
1288     (inst add eax carry-in)
1289     (inst adc edx 0)
1290     (move hi edx)
1291     (move lo eax)))
1292
1293 (define-vop (bignum-mult-and-add-4-arg)
1294   (:translate sb!bignum::%multiply-and-add)
1295   (:policy :fast-safe)
1296   (:args (x :scs (unsigned-reg) :target eax)
1297          (y :scs (unsigned-reg unsigned-stack))
1298          (prev :scs (unsigned-reg unsigned-stack))
1299          (carry-in :scs (unsigned-reg unsigned-stack)))
1300   (:arg-types unsigned-num unsigned-num unsigned-num unsigned-num)
1301   (:temporary (:sc unsigned-reg :offset eax-offset :from (:argument 0)
1302                    :to (:result 1) :target lo) eax)
1303   (:temporary (:sc unsigned-reg :offset edx-offset :from (:argument 1)
1304                    :to (:result 0) :target hi) edx)
1305   (:results (hi :scs (unsigned-reg))
1306             (lo :scs (unsigned-reg)))
1307   (:result-types unsigned-num unsigned-num)
1308   (:generator 20
1309     (move eax x)
1310     (inst mul eax y)
1311     (inst add eax prev)
1312     (inst adc edx 0)
1313     (inst add eax carry-in)
1314     (inst adc edx 0)
1315     (move hi edx)
1316     (move lo eax)))
1317
1318
1319 (define-vop (bignum-mult)
1320   (:translate sb!bignum::%multiply)
1321   (:policy :fast-safe)
1322   (:args (x :scs (unsigned-reg) :target eax)
1323          (y :scs (unsigned-reg unsigned-stack)))
1324   (:arg-types unsigned-num unsigned-num)
1325   (:temporary (:sc unsigned-reg :offset eax-offset :from (:argument 0)
1326                    :to (:result 1) :target lo) eax)
1327   (:temporary (:sc unsigned-reg :offset edx-offset :from (:argument 1)
1328                    :to (:result 0) :target hi) edx)
1329   (:results (hi :scs (unsigned-reg))
1330             (lo :scs (unsigned-reg)))
1331   (:result-types unsigned-num unsigned-num)
1332   (:generator 20
1333     (move eax x)
1334     (inst mul eax y)
1335     (move hi edx)
1336     (move lo eax)))
1337
1338 (define-vop (bignum-lognot lognot-mod32/unsigned=>unsigned)
1339   (:translate sb!bignum::%lognot))
1340
1341 (define-vop (fixnum-to-digit)
1342   (:translate sb!bignum::%fixnum-to-digit)
1343   (:policy :fast-safe)
1344   (:args (fixnum :scs (any-reg control-stack) :target digit))
1345   (:arg-types tagged-num)
1346   (:results (digit :scs (unsigned-reg)
1347                    :load-if (not (and (sc-is fixnum control-stack)
1348                                       (sc-is digit unsigned-stack)
1349                                       (location= fixnum digit)))))
1350   (:result-types unsigned-num)
1351   (:generator 1
1352     (move digit fixnum)
1353     (inst sar digit 2)))
1354
1355 (define-vop (bignum-floor)
1356   (:translate sb!bignum::%floor)
1357   (:policy :fast-safe)
1358   (:args (div-high :scs (unsigned-reg) :target edx)
1359          (div-low :scs (unsigned-reg) :target eax)
1360          (divisor :scs (unsigned-reg unsigned-stack)))
1361   (:arg-types unsigned-num unsigned-num unsigned-num)
1362   (:temporary (:sc unsigned-reg :offset eax-offset :from (:argument 1)
1363                    :to (:result 0) :target quo) eax)
1364   (:temporary (:sc unsigned-reg :offset edx-offset :from (:argument 0)
1365                    :to (:result 1) :target rem) edx)
1366   (:results (quo :scs (unsigned-reg))
1367             (rem :scs (unsigned-reg)))
1368   (:result-types unsigned-num unsigned-num)
1369   (:generator 300
1370     (move edx div-high)
1371     (move eax div-low)
1372     (inst div eax divisor)
1373     (move quo eax)
1374     (move rem edx)))
1375
1376 (define-vop (signify-digit)
1377   (:translate sb!bignum::%fixnum-digit-with-correct-sign)
1378   (:policy :fast-safe)
1379   (:args (digit :scs (unsigned-reg unsigned-stack) :target res))
1380   (:arg-types unsigned-num)
1381   (:results (res :scs (any-reg signed-reg)
1382                  :load-if (not (and (sc-is digit unsigned-stack)
1383                                     (sc-is res control-stack signed-stack)
1384                                     (location= digit res)))))
1385   (:result-types signed-num)
1386   (:generator 1
1387     (move res digit)
1388     (when (sc-is res any-reg control-stack)
1389       (inst shl res 2))))
1390
1391 (define-vop (digit-ashr)
1392   (:translate sb!bignum::%ashr)
1393   (:policy :fast-safe)
1394   (:args (digit :scs (unsigned-reg unsigned-stack) :target result)
1395          (count :scs (unsigned-reg) :target ecx))
1396   (:arg-types unsigned-num positive-fixnum)
1397   (:temporary (:sc unsigned-reg :offset ecx-offset :from (:argument 1)) ecx)
1398   (:results (result :scs (unsigned-reg) :from (:argument 0)
1399                     :load-if (not (and (sc-is result unsigned-stack)
1400                                        (location= digit result)))))
1401   (:result-types unsigned-num)
1402   (:generator 1
1403     (move result digit)
1404     (move ecx count)
1405     (inst sar result :cl)))
1406
1407 (define-vop (digit-lshr digit-ashr)
1408   (:translate sb!bignum::%digit-logical-shift-right)
1409   (:generator 1
1410     (move result digit)
1411     (move ecx count)
1412     (inst shr result :cl)))
1413
1414 (define-vop (digit-ashl digit-ashr)
1415   (:translate sb!bignum::%ashl)
1416   (:generator 1
1417     (move result digit)
1418     (move ecx count)
1419     (inst shl result :cl)))
1420 \f
1421 ;;;; static functions
1422
1423 (define-static-fun two-arg-/ (x y) :translate /)
1424
1425 (define-static-fun two-arg-gcd (x y) :translate gcd)
1426 (define-static-fun two-arg-lcm (x y) :translate lcm)
1427
1428 (define-static-fun two-arg-and (x y) :translate logand)
1429 (define-static-fun two-arg-ior (x y) :translate logior)
1430 (define-static-fun two-arg-xor (x y) :translate logxor)
1431
1432 \f
1433 ;;; Support for the Mersenne Twister, MT19937, random number generator
1434 ;;; due to Matsumoto and Nishimura.
1435 ;;;
1436 ;;; Makoto Matsumoto and T. Nishimura, "Mersenne twister: A
1437 ;;; 623-dimensionally equidistributed uniform pseudorandom number
1438 ;;; generator.", ACM Transactions on Modeling and Computer Simulation,
1439 ;;; 1997, to appear.
1440 ;;;
1441 ;;; State:
1442 ;;;  0-1:   Constant matrix A. [0, #x9908b0df] (not used here)
1443 ;;;  2:     Index; init. to 1.
1444 ;;;  3-626: State.
1445 (defknown random-mt19937 ((simple-array (unsigned-byte 32) (*)))
1446   (unsigned-byte 32) ())
1447 (define-vop (random-mt19937)
1448   (:policy :fast-safe)
1449   (:translate random-mt19937)
1450   (:args (state :scs (descriptor-reg) :to :result))
1451   (:arg-types simple-array-unsigned-byte-32)
1452   (:temporary (:sc unsigned-reg :from (:eval 0) :to :result) k)
1453   (:temporary (:sc unsigned-reg :offset eax-offset
1454                    :from (:eval 0) :to :result) tmp)
1455   (:results (y :scs (unsigned-reg) :from (:eval 0)))
1456   (:result-types unsigned-num)
1457   (:generator 50
1458     (inst mov k (make-ea :dword :base state
1459                          :disp (- (* (+ 2 vector-data-offset)
1460                                      n-word-bytes)
1461                                   other-pointer-lowtag)))
1462     (inst cmp k 624)
1463     (inst jmp :ne no-update)
1464     (inst mov tmp state)        ; The state is passed in EAX.
1465     (inst call (make-fixup 'random-mt19937-update :assembly-routine))
1466     ;; Restore k, and set to 0.
1467     (inst xor k k)
1468     NO-UPDATE
1469     ;; y = ptgfsr[k++];
1470     (inst mov y (make-ea :dword :base state :index k :scale 4
1471                          :disp (- (* (+ 3 vector-data-offset)
1472                                      n-word-bytes)
1473                                   other-pointer-lowtag)))
1474     ;; y ^= (y >> 11);
1475     (inst shr y 11)
1476     (inst xor y (make-ea :dword :base state :index k :scale 4
1477                          :disp (- (* (+ 3 vector-data-offset)
1478                                      n-word-bytes)
1479                                   other-pointer-lowtag)))
1480     ;; y ^= (y << 7) & #x9d2c5680
1481     (inst mov tmp y)
1482     (inst inc k)
1483     (inst shl tmp 7)
1484     (inst mov (make-ea :dword :base state
1485                        :disp (- (* (+ 2 vector-data-offset)
1486                                    n-word-bytes)
1487                                 other-pointer-lowtag))
1488           k)
1489     (inst and tmp #x9d2c5680)
1490     (inst xor y tmp)
1491     ;; y ^= (y << 15) & #xefc60000
1492     (inst mov tmp y)
1493     (inst shl tmp 15)
1494     (inst and tmp #xefc60000)
1495     (inst xor y tmp)
1496     ;; y ^= (y >> 18);
1497     (inst mov tmp y)
1498     (inst shr tmp 18)
1499     (inst xor y tmp)))
1500
1501 (in-package "SB!C")
1502
1503 (defknown %lea ((or (signed-byte 32) (unsigned-byte 32))
1504                 (or (signed-byte 32) (unsigned-byte 32))
1505                 (member 1 2 4 8) (signed-byte 32))
1506   (or (signed-byte 32) (unsigned-byte 32))
1507   (foldable flushable))
1508
1509 (defoptimizer (%lea derive-type) ((base index scale disp))
1510   (when (and (constant-lvar-p scale)
1511              (constant-lvar-p disp))
1512     (let ((scale (lvar-value scale))
1513           (disp (lvar-value disp))
1514           (base-type (lvar-type base))
1515           (index-type (lvar-type index)))
1516       (when (and (numeric-type-p base-type)
1517                  (numeric-type-p index-type))
1518         (let ((base-lo (numeric-type-low base-type))
1519               (base-hi (numeric-type-high base-type))
1520               (index-lo (numeric-type-low index-type))
1521               (index-hi (numeric-type-high index-type)))
1522           (make-numeric-type :class 'integer
1523                              :complexp :real
1524                              :low (when (and base-lo index-lo)
1525                                     (+ base-lo (* index-lo scale) disp))
1526                              :high (when (and base-hi index-hi)
1527                                      (+ base-hi (* index-hi scale) disp))))))))
1528
1529 (defun %lea (base index scale disp)
1530   (+ base (* index scale) disp))
1531
1532 (in-package "SB!VM")
1533
1534 (define-vop (%lea/unsigned=>unsigned)
1535   (:translate %lea)
1536   (:policy :fast-safe)
1537   (:args (base :scs (unsigned-reg))
1538          (index :scs (unsigned-reg)))
1539   (:info scale disp)
1540   (:arg-types unsigned-num unsigned-num
1541               (:constant (member 1 2 4 8))
1542               (:constant (signed-byte 32)))
1543   (:results (r :scs (unsigned-reg)))
1544   (:result-types unsigned-num)
1545   (:generator 5
1546     (inst lea r (make-ea :dword :base base :index index
1547                          :scale scale :disp disp))))
1548
1549 (define-vop (%lea/signed=>signed)
1550   (:translate %lea)
1551   (:policy :fast-safe)
1552   (:args (base :scs (signed-reg))
1553          (index :scs (signed-reg)))
1554   (:info scale disp)
1555   (:arg-types signed-num signed-num
1556               (:constant (member 1 2 4 8))
1557               (:constant (signed-byte 32)))
1558   (:results (r :scs (signed-reg)))
1559   (:result-types signed-num)
1560   (:generator 4
1561     (inst lea r (make-ea :dword :base base :index index
1562                          :scale scale :disp disp))))
1563
1564 (define-vop (%lea/fixnum=>fixnum)
1565   (:translate %lea)
1566   (:policy :fast-safe)
1567   (:args (base :scs (any-reg))
1568          (index :scs (any-reg)))
1569   (:info scale disp)
1570   (:arg-types tagged-num tagged-num
1571               (:constant (member 1 2 4 8))
1572               (:constant (signed-byte 32)))
1573   (:results (r :scs (any-reg)))
1574   (:result-types tagged-num)
1575   (:generator 3
1576     (inst lea r (make-ea :dword :base base :index index
1577                          :scale scale :disp disp))))
1578
1579 (in-package "SB!C")
1580
1581 ;;; This is essentially a straight implementation of the algorithm in
1582 ;;; "Strength Reduction of Multiplications by Integer Constants",
1583 ;;; Youfeng Wu, ACM SIGPLAN Notices, Vol. 30, No.2, February 1995.
1584 (defun basic-decompose-multiplication (arg num n-bits condensed)
1585   (case (aref condensed 0)
1586     (0
1587      (let ((tmp (min 3 (aref condensed 1))))
1588        (decf (aref condensed 1) tmp)
1589        `(logand #xffffffff
1590          (%lea ,arg
1591                ,(decompose-multiplication
1592                  arg (ash (1- num) (- tmp)) (1- n-bits) (subseq condensed 1))
1593                ,(ash 1 tmp) 0))))
1594     ((1 2 3)
1595      (let ((r0 (aref condensed 0)))
1596        (incf (aref condensed 1) r0)
1597        `(logand #xffffffff
1598          (%lea ,(decompose-multiplication
1599                  arg (- num (ash 1 r0)) (1- n-bits) (subseq condensed 1))
1600                ,arg
1601                ,(ash 1 r0) 0))))
1602     (t (let ((r0 (aref condensed 0)))
1603          (setf (aref condensed 0) 0)
1604          `(logand #xffffffff
1605            (ash ,(decompose-multiplication
1606                   arg (ash num (- r0)) n-bits condensed)
1607                 ,r0))))))
1608
1609 (defun decompose-multiplication (arg num n-bits condensed)
1610   (cond
1611     ((= n-bits 0) 0)
1612     ((= num 1) arg)
1613     ((= n-bits 1)
1614      `(logand #xffffffff (ash ,arg ,(1- (integer-length num)))))
1615     ((let ((max 0) (end 0))
1616        (loop for i from 2 to (length condensed)
1617              for j = (reduce #'+ (subseq condensed 0 i))
1618              when (and (> (- (* 2 i) 3 j) max)
1619                        (< (+ (ash 1 (1+ j))
1620                              (ash (ldb (byte (- 32 (1+ j)) (1+ j)) num)
1621                                   (1+ j)))
1622                           (ash 1 32)))
1623                do (setq max (- (* 2 i) 3 j)
1624                         end i))
1625        (when (> max 0)
1626          (let ((j (reduce #'+ (subseq condensed 0 end))))
1627            (let ((n2 (+ (ash 1 (1+ j))
1628                         (ash (ldb (byte (- 32 (1+ j)) (1+ j)) num) (1+ j))))
1629                  (n1 (1+ (ldb (byte (1+ j) 0) (lognot num)))))
1630            `(logand #xffffffff
1631              (- ,(optimize-multiply arg n2) ,(optimize-multiply arg n1))))))))
1632     ((dolist (i '(9 5 3))
1633        (when (integerp (/ num i))
1634          (when (< (logcount (/ num i)) (logcount num))
1635            (let ((x (gensym)))
1636              (return `(let ((,x ,(optimize-multiply arg (/ num i))))
1637                        (logand #xffffffff
1638                         (%lea ,x ,x (1- ,i) 0)))))))))
1639     (t (basic-decompose-multiplication arg num n-bits condensed))))
1640            
1641 (defun optimize-multiply (arg x)
1642   (let* ((n-bits (logcount x))
1643          (condensed (make-array n-bits)))
1644     (let ((count 0) (bit 0))
1645       (dotimes (i 32)
1646         (cond ((logbitp i x)
1647                (setf (aref condensed bit) count)
1648                (setf count 1)
1649                (incf bit))
1650               (t (incf count)))))
1651     (decompose-multiplication arg x n-bits condensed)))
1652
1653 (deftransform * ((x y)
1654                  ((unsigned-byte 32) (constant-arg (unsigned-byte 32)))
1655                  (unsigned-byte 32))
1656   "recode as leas, shifts and adds"
1657   (let ((y (lvar-value y)))
1658     (cond
1659       ((= y (ash 1 (integer-length y)))
1660        ;; there's a generic transform for y = 2^k
1661        (give-up-ir1-transform))
1662       ((member y '(3 5 9))
1663        ;; we can do these multiplications directly using LEA
1664        `(%lea x x ,(1- y) 0))
1665       ((member :pentium4 *backend-subfeatures*)
1666        ;; the pentium4's multiply unit is reportedly very good
1667        (give-up-ir1-transform))
1668       ;; FIXME: should make this more fine-grained.  If nothing else,
1669       ;; there should probably be a cutoff of about 9 instructions on
1670       ;; pentium-class machines.
1671       (t (optimize-multiply 'x y)))))
1672
1673 ;;; FIXME: we should also be able to write an optimizer or two to
1674 ;;; convert (+ (* x 2) 17), (- (* x 9) 5) to a %LEA.