ffd540ade8cb2fc615e2479933ca8d377d2c4270
[sbcl.git] / src / compiler / x86 / arith.lisp
1 ;;;; the VM definition of 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                   ,(if (eq translate 'logand)
180                        ;; for the -C/UNSIGNED=>UNSIGNED VOP, this case
181                        ;; is optimized away as an identity somewhere
182                        ;; along the lines.  However, this VOP is used in
183                        ;; -C/SIGNED=>UNSIGNED, below, when the
184                        ;; higher-level lisp code can't optimize away the
185                        ;; non-trivial identity.
186                        `(unless (= y #.(1- (ash 1 n-word-bits)))
187                           (inst ,op r y))
188                        `(inst ,op r y)))))))
189   (define-binop - 4 sub)
190   (define-binop logand 2 and)
191   (define-binop logior 2 or)
192   (define-binop logxor 2 xor))
193
194 ;;; Special handling of add on the x86; can use lea to avoid a
195 ;;; register load, otherwise it uses add.
196 (define-vop (fast-+/fixnum=>fixnum fast-safe-arith-op)
197   (:translate +)
198   (:args (x :scs (any-reg) :target r
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          (y :scs (any-reg control-stack)))
204   (:arg-types tagged-num tagged-num)
205   (:results (r :scs (any-reg) :from (:argument 0)
206                :load-if (not (and (sc-is x control-stack)
207                                   (sc-is y any-reg)
208                                   (sc-is r control-stack)
209                                   (location= x r)))))
210   (:result-types tagged-num)
211   (:note "inline fixnum arithmetic")
212   (:generator 2
213     (cond ((and (sc-is x any-reg) (sc-is y any-reg) (sc-is r any-reg)
214                 (not (location= x r)))
215            (inst lea r (make-ea :dword :base x :index y :scale 1)))
216           (t
217            (move r x)
218            (inst add r y)))))
219
220 (define-vop (fast-+-c/fixnum=>fixnum fast-safe-arith-op)
221   (:translate +)
222   (:args (x :target r :scs (any-reg control-stack)))
223   (:info y)
224   (:arg-types tagged-num (:constant (signed-byte 30)))
225   (:results (r :scs (any-reg)
226                :load-if (not (location= x r))))
227   (:result-types tagged-num)
228   (:note "inline fixnum arithmetic")
229   (:generator 1
230     (cond ((and (sc-is x any-reg) (sc-is r any-reg) (not (location= x r)))
231            (inst lea r (make-ea :dword :base x :disp (fixnumize y))))
232           (t
233            (move r x)
234            (inst add r (fixnumize y))))))
235
236 (define-vop (fast-+/signed=>signed fast-safe-arith-op)
237   (:translate +)
238   (:args (x :scs (signed-reg) :target r
239             :load-if (not (and (sc-is x signed-stack)
240                                (sc-is y signed-reg)
241                                (sc-is r signed-stack)
242                                (location= x r))))
243          (y :scs (signed-reg signed-stack)))
244   (:arg-types signed-num signed-num)
245   (:results (r :scs (signed-reg) :from (:argument 0)
246                :load-if (not (and (sc-is x signed-stack)
247                                   (sc-is y signed-reg)
248                                   (location= x r)))))
249   (:result-types signed-num)
250   (:note "inline (signed-byte 32) arithmetic")
251   (:generator 5
252     (cond ((and (sc-is x signed-reg) (sc-is y signed-reg) (sc-is r signed-reg)
253                 (not (location= x r)))
254            (inst lea r (make-ea :dword :base x :index y :scale 1)))
255           (t
256            (move r x)
257            (inst add r y)))))
258
259 ;;;; Special logand cases: (logand signed unsigned) => unsigned
260
261 (define-vop (fast-logand/signed-unsigned=>unsigned
262              fast-logand/unsigned=>unsigned)
263   (:args (x :target r :scs (signed-reg)
264             :load-if (not (and (sc-is x signed-stack)
265                                (sc-is y unsigned-reg)
266                                (sc-is r unsigned-stack)
267                                (location= x r))))
268          (y :scs (unsigned-reg unsigned-stack)))
269   (:arg-types signed-num unsigned-num))
270
271 (define-vop (fast-logand-c/signed-unsigned=>unsigned
272              fast-logand-c/unsigned=>unsigned)
273   (:args (x :target r :scs (signed-reg signed-stack)))
274   (:arg-types signed-num (:constant (unsigned-byte 32))))
275
276 (define-vop (fast-logand/unsigned-signed=>unsigned
277              fast-logand/unsigned=>unsigned)
278   (:args (x :target r :scs (unsigned-reg)
279             :load-if (not (and (sc-is x unsigned-stack)
280                                (sc-is y signed-reg)
281                                (sc-is r unsigned-stack)
282                                (location= x r))))
283          (y :scs (signed-reg signed-stack)))
284   (:arg-types unsigned-num signed-num))
285 \f
286
287 (define-vop (fast-+-c/signed=>signed fast-safe-arith-op)
288   (:translate +)
289   (:args (x :target r :scs (signed-reg signed-stack)))
290   (:info y)
291   (:arg-types signed-num (:constant (signed-byte 32)))
292   (:results (r :scs (signed-reg)
293                :load-if (not (location= x r))))
294   (:result-types signed-num)
295   (:note "inline (signed-byte 32) arithmetic")
296   (:generator 4
297     (cond ((and (sc-is x signed-reg) (sc-is r signed-reg)
298                 (not (location= x r)))
299            (inst lea r (make-ea :dword :base x :disp y)))
300           (t
301            (move r x)
302            (if (= y 1)
303                (inst inc r)
304              (inst add r y))))))
305
306 (define-vop (fast-+/unsigned=>unsigned fast-safe-arith-op)
307   (:translate +)
308   (:args (x :scs (unsigned-reg) :target r
309             :load-if (not (and (sc-is x unsigned-stack)
310                                (sc-is y unsigned-reg)
311                                (sc-is r unsigned-stack)
312                                (location= x r))))
313          (y :scs (unsigned-reg unsigned-stack)))
314   (:arg-types unsigned-num unsigned-num)
315   (:results (r :scs (unsigned-reg) :from (:argument 0)
316                :load-if (not (and (sc-is x unsigned-stack)
317                                   (sc-is y unsigned-reg)
318                                   (sc-is r unsigned-stack)
319                                   (location= x r)))))
320   (:result-types unsigned-num)
321   (:note "inline (unsigned-byte 32) arithmetic")
322   (:generator 5
323     (cond ((and (sc-is x unsigned-reg) (sc-is y unsigned-reg)
324                 (sc-is r unsigned-reg) (not (location= x r)))
325            (inst lea r (make-ea :dword :base x :index y :scale 1)))
326           (t
327            (move r x)
328            (inst add r y)))))
329
330 (define-vop (fast-+-c/unsigned=>unsigned fast-safe-arith-op)
331   (:translate +)
332   (:args (x :target r :scs (unsigned-reg unsigned-stack)))
333   (:info y)
334   (:arg-types unsigned-num (:constant (unsigned-byte 32)))
335   (:results (r :scs (unsigned-reg)
336                :load-if (not (location= x r))))
337   (:result-types unsigned-num)
338   (:note "inline (unsigned-byte 32) arithmetic")
339   (:generator 4
340     (cond ((and (sc-is x unsigned-reg) (sc-is r unsigned-reg)
341                 (not (location= x r)))
342            (inst lea r (make-ea :dword :base x :disp y)))
343           (t
344            (move r x)
345            (if (= y 1)
346                (inst inc r)
347              (inst add r y))))))
348 \f
349 ;;;; multiplication and division
350
351 (define-vop (fast-*/fixnum=>fixnum fast-safe-arith-op)
352   (:translate *)
353   ;; We need different loading characteristics.
354   (:args (x :scs (any-reg) :target r)
355          (y :scs (any-reg control-stack)))
356   (:arg-types tagged-num tagged-num)
357   (:results (r :scs (any-reg) :from (:argument 0)))
358   (:result-types tagged-num)
359   (:note "inline fixnum arithmetic")
360   (:generator 4
361     (move r x)
362     (inst sar r 2)
363     (inst imul r y)))
364
365 (define-vop (fast-*-c/fixnum=>fixnum fast-safe-arith-op)
366   (:translate *)
367   ;; We need different loading characteristics.
368   (:args (x :scs (any-reg control-stack)))
369   (:info y)
370   (:arg-types tagged-num (:constant (signed-byte 30)))
371   (:results (r :scs (any-reg)))
372   (:result-types tagged-num)
373   (:note "inline fixnum arithmetic")
374   (:generator 3
375     (inst imul r x y)))
376
377 (define-vop (fast-*/signed=>signed fast-safe-arith-op)
378   (:translate *)
379   ;; We need different loading characteristics.
380   (:args (x :scs (signed-reg) :target r)
381          (y :scs (signed-reg signed-stack)))
382   (:arg-types signed-num signed-num)
383   (:results (r :scs (signed-reg) :from (:argument 0)))
384   (:result-types signed-num)
385   (:note "inline (signed-byte 32) arithmetic")
386   (:generator 5
387     (move r x)
388     (inst imul r y)))
389
390 (define-vop (fast-*-c/signed=>signed fast-safe-arith-op)
391   (:translate *)
392   ;; We need different loading characteristics.
393   (:args (x :scs (signed-reg signed-stack)))
394   (:info y)
395   (:arg-types signed-num (:constant (signed-byte 32)))
396   (:results (r :scs (signed-reg)))
397   (:result-types signed-num)
398   (:note "inline (signed-byte 32) arithmetic")
399   (:generator 4
400     (inst imul r x y)))
401
402 (define-vop (fast-*/unsigned=>unsigned fast-safe-arith-op)
403   (:translate *)
404   (:args (x :scs (unsigned-reg) :target eax)
405          (y :scs (unsigned-reg unsigned-stack)))
406   (:arg-types unsigned-num unsigned-num)
407   (:temporary (:sc unsigned-reg :offset eax-offset :target r
408                    :from (:argument 0) :to :result) eax)
409   (:temporary (:sc unsigned-reg :offset edx-offset
410                    :from :eval :to :result) edx)
411   (:ignore edx)
412   (:results (r :scs (unsigned-reg)))
413   (:result-types unsigned-num)
414   (:note "inline (unsigned-byte 32) arithmetic")
415   (:vop-var vop)
416   (:save-p :compute-only)
417   (:generator 6
418     (move eax x)
419     (inst mul eax y)
420     (move r eax)))
421
422
423 (define-vop (fast-truncate/fixnum=>fixnum fast-safe-arith-op)
424   (:translate truncate)
425   (:args (x :scs (any-reg) :target eax)
426          (y :scs (any-reg control-stack)))
427   (:arg-types tagged-num tagged-num)
428   (:temporary (:sc signed-reg :offset eax-offset :target quo
429                    :from (:argument 0) :to (:result 0)) eax)
430   (:temporary (:sc unsigned-reg :offset edx-offset :target rem
431                    :from (:argument 0) :to (:result 1)) edx)
432   (:results (quo :scs (any-reg))
433             (rem :scs (any-reg)))
434   (:result-types tagged-num tagged-num)
435   (:note "inline fixnum arithmetic")
436   (:vop-var vop)
437   (:save-p :compute-only)
438   (:generator 31
439     (let ((zero (generate-error-code vop division-by-zero-error x y)))
440       (if (sc-is y any-reg)
441           (inst test y y)  ; smaller instruction
442           (inst cmp y 0))
443       (inst jmp :eq zero))
444     (move eax x)
445     (inst cdq)
446     (inst idiv eax y)
447     (if (location= quo eax)
448         (inst shl eax 2)
449         (inst lea quo (make-ea :dword :index eax :scale 4)))
450     (move rem edx)))
451
452 (define-vop (fast-truncate-c/fixnum=>fixnum fast-safe-arith-op)
453   (:translate truncate)
454   (:args (x :scs (any-reg) :target eax))
455   (:info y)
456   (:arg-types tagged-num (:constant (signed-byte 30)))
457   (:temporary (:sc signed-reg :offset eax-offset :target quo
458                    :from :argument :to (:result 0)) eax)
459   (:temporary (:sc any-reg :offset edx-offset :target rem
460                    :from :eval :to (:result 1)) edx)
461   (:temporary (:sc any-reg :from :eval :to :result) y-arg)
462   (:results (quo :scs (any-reg))
463             (rem :scs (any-reg)))
464   (:result-types tagged-num tagged-num)
465   (:note "inline fixnum arithmetic")
466   (:vop-var vop)
467   (:save-p :compute-only)
468   (:generator 30
469     (move eax x)
470     (inst cdq)
471     (inst mov y-arg (fixnumize y))
472     (inst idiv eax y-arg)
473     (if (location= quo eax)
474         (inst shl eax 2)
475         (inst lea quo (make-ea :dword :index eax :scale 4)))
476     (move rem edx)))
477
478 (define-vop (fast-truncate/unsigned=>unsigned fast-safe-arith-op)
479   (:translate truncate)
480   (:args (x :scs (unsigned-reg) :target eax)
481          (y :scs (unsigned-reg signed-stack)))
482   (:arg-types unsigned-num unsigned-num)
483   (:temporary (:sc unsigned-reg :offset eax-offset :target quo
484                    :from (:argument 0) :to (:result 0)) eax)
485   (:temporary (:sc unsigned-reg :offset edx-offset :target rem
486                    :from (:argument 0) :to (:result 1)) edx)
487   (:results (quo :scs (unsigned-reg))
488             (rem :scs (unsigned-reg)))
489   (:result-types unsigned-num unsigned-num)
490   (:note "inline (unsigned-byte 32) arithmetic")
491   (:vop-var vop)
492   (:save-p :compute-only)
493   (:generator 33
494     (let ((zero (generate-error-code vop division-by-zero-error x y)))
495       (if (sc-is y unsigned-reg)
496           (inst test y y)  ; smaller instruction
497           (inst cmp y 0))
498       (inst jmp :eq zero))
499     (move eax x)
500     (inst xor edx edx)
501     (inst div eax y)
502     (move quo eax)
503     (move rem edx)))
504
505 (define-vop (fast-truncate-c/unsigned=>unsigned fast-safe-arith-op)
506   (:translate truncate)
507   (:args (x :scs (unsigned-reg) :target eax))
508   (:info y)
509   (:arg-types unsigned-num (:constant (unsigned-byte 32)))
510   (:temporary (:sc unsigned-reg :offset eax-offset :target quo
511                    :from :argument :to (:result 0)) eax)
512   (:temporary (:sc unsigned-reg :offset edx-offset :target rem
513                    :from :eval :to (:result 1)) edx)
514   (:temporary (:sc unsigned-reg :from :eval :to :result) y-arg)
515   (:results (quo :scs (unsigned-reg))
516             (rem :scs (unsigned-reg)))
517   (:result-types unsigned-num unsigned-num)
518   (:note "inline (unsigned-byte 32) arithmetic")
519   (:vop-var vop)
520   (:save-p :compute-only)
521   (:generator 32
522     (move eax x)
523     (inst xor edx edx)
524     (inst mov y-arg y)
525     (inst div eax y-arg)
526     (move quo eax)
527     (move rem edx)))
528
529 (define-vop (fast-truncate/signed=>signed fast-safe-arith-op)
530   (:translate truncate)
531   (:args (x :scs (signed-reg) :target eax)
532          (y :scs (signed-reg signed-stack)))
533   (:arg-types signed-num signed-num)
534   (:temporary (:sc signed-reg :offset eax-offset :target quo
535                    :from (:argument 0) :to (:result 0)) eax)
536   (:temporary (:sc signed-reg :offset edx-offset :target rem
537                    :from (:argument 0) :to (:result 1)) edx)
538   (:results (quo :scs (signed-reg))
539             (rem :scs (signed-reg)))
540   (:result-types signed-num signed-num)
541   (:note "inline (signed-byte 32) arithmetic")
542   (:vop-var vop)
543   (:save-p :compute-only)
544   (:generator 33
545     (let ((zero (generate-error-code vop division-by-zero-error x y)))
546       (if (sc-is y signed-reg)
547           (inst test y y)  ; smaller instruction
548           (inst cmp y 0))
549       (inst jmp :eq zero))
550     (move eax x)
551     (inst cdq)
552     (inst idiv eax y)
553     (move quo eax)
554     (move rem edx)))
555
556 (define-vop (fast-truncate-c/signed=>signed fast-safe-arith-op)
557   (:translate truncate)
558   (:args (x :scs (signed-reg) :target eax))
559   (:info y)
560   (:arg-types signed-num (:constant (signed-byte 32)))
561   (:temporary (:sc signed-reg :offset eax-offset :target quo
562                    :from :argument :to (:result 0)) eax)
563   (:temporary (:sc signed-reg :offset edx-offset :target rem
564                    :from :eval :to (:result 1)) edx)
565   (:temporary (:sc signed-reg :from :eval :to :result) y-arg)
566   (:results (quo :scs (signed-reg))
567             (rem :scs (signed-reg)))
568   (:result-types signed-num signed-num)
569   (:note "inline (signed-byte 32) arithmetic")
570   (:vop-var vop)
571   (:save-p :compute-only)
572   (:generator 32
573     (move eax x)
574     (inst cdq)
575     (inst mov y-arg y)
576     (inst idiv eax y-arg)
577     (move quo eax)
578     (move rem edx)))
579
580
581 \f
582 ;;;; Shifting
583 (define-vop (fast-ash-c/fixnum=>fixnum)
584   (:translate ash)
585   (:policy :fast-safe)
586   (:args (number :scs (any-reg) :target result
587                  :load-if (not (and (sc-is number any-reg control-stack)
588                                     (sc-is result any-reg control-stack)
589                                     (location= number result)))))
590   (:info amount)
591   (:arg-types tagged-num (:constant integer))
592   (:results (result :scs (any-reg)
593                     :load-if (not (and (sc-is number control-stack)
594                                        (sc-is result control-stack)
595                                        (location= number result)))))
596   (:result-types tagged-num)
597   (:note "inline ASH")
598   (:generator 2
599     (cond ((and (= amount 1) (not (location= number result)))
600            (inst lea result (make-ea :dword :index number :scale 2)))
601           ((and (= amount 2) (not (location= number result)))
602            (inst lea result (make-ea :dword :index number :scale 4)))
603           ((and (= amount 3) (not (location= number result)))
604            (inst lea result (make-ea :dword :index number :scale 8)))
605           (t
606            (move result number)
607            (cond ((plusp amount)
608                   ;; We don't have to worry about overflow because of the
609                   ;; result type restriction.
610                   (inst shl result amount))
611                  (t
612                   ;; If the amount is greater than 31, only shift by 31. We
613                   ;; have to do this because the shift instructions only look
614                   ;; at the low five bits of the result.
615                   (inst sar result (min 31 (- amount)))
616                   ;; Fixnum correction.
617                   (inst and result (lognot fixnum-tag-mask))))))))
618
619 (define-vop (fast-ash-left/fixnum=>fixnum)
620   (:translate ash)
621   (:args (number :scs (any-reg) :target result
622                  :load-if (not (and (sc-is number control-stack)
623                                     (sc-is result control-stack)
624                                     (location= number result))))
625          (amount :scs (unsigned-reg) :target ecx))
626   (:arg-types tagged-num positive-fixnum)
627   (:temporary (:sc unsigned-reg :offset ecx-offset :from (:argument 1)) ecx)
628   (:results (result :scs (any-reg) :from (:argument 0)
629                     :load-if (not (and (sc-is number control-stack)
630                                        (sc-is result control-stack)
631                                        (location= number result)))))
632   (:result-types tagged-num)
633   (:policy :fast-safe)
634   (:note "inline ASH")
635   (:generator 3
636     (move result number)
637     (move ecx amount)
638     ;; The result-type ensures us that this shift will not overflow.
639     (inst shl result :cl)))
640
641 (define-vop (fast-ash-c/signed=>signed)
642   (:translate ash)
643   (:policy :fast-safe)
644   (:args (number :scs (signed-reg) :target result
645                  :load-if (not (and (sc-is number signed-stack)
646                                     (sc-is result signed-stack)
647                                     (location= number result)))))
648   (:info amount)
649   (:arg-types signed-num (:constant integer))
650   (:results (result :scs (signed-reg)
651                     :load-if (not (and (sc-is number signed-stack)
652                                        (sc-is result signed-stack)
653                                        (location= number result)))))
654   (:result-types signed-num)
655   (:note "inline ASH")
656   (:generator 3
657     (cond ((and (= amount 1) (not (location= number result)))
658            (inst lea result (make-ea :dword :index number :scale 2)))
659           ((and (= amount 2) (not (location= number result)))
660            (inst lea result (make-ea :dword :index number :scale 4)))
661           ((and (= amount 3) (not (location= number result)))
662            (inst lea result (make-ea :dword :index number :scale 8)))
663           (t
664            (move result number)
665            (cond ((plusp amount) (inst shl result amount))
666                  (t (inst sar result (min 31 (- amount)))))))))
667
668 (define-vop (fast-ash-c/unsigned=>unsigned)
669   (:translate ash)
670   (:policy :fast-safe)
671   (:args (number :scs (unsigned-reg) :target result
672                  :load-if (not (and (sc-is number unsigned-stack)
673                                     (sc-is result unsigned-stack)
674                                     (location= number result)))))
675   (:info amount)
676   (:arg-types unsigned-num (:constant integer))
677   (:results (result :scs (unsigned-reg)
678                     :load-if (not (and (sc-is number unsigned-stack)
679                                        (sc-is result unsigned-stack)
680                                        (location= number result)))))
681   (:result-types unsigned-num)
682   (:note "inline ASH")
683   (:generator 3
684     (cond ((and (= amount 1) (not (location= number result)))
685            (inst lea result (make-ea :dword :index number :scale 2)))
686           ((and (= amount 2) (not (location= number result)))
687            (inst lea result (make-ea :dword :index number :scale 4)))
688           ((and (= amount 3) (not (location= number result)))
689            (inst lea result (make-ea :dword :index number :scale 8)))
690           (t
691            (move result number)
692            (cond ((< -32 amount 32)
693                   ;; this code is used both in ASH and ASH-MOD32, so
694                   ;; be careful
695                   (if (plusp amount)
696                       (inst shl result amount)
697                       (inst shr result (- amount))))
698                  (t (if (sc-is result unsigned-reg)
699                         (inst xor result result)
700                         (inst mov result 0))))))))
701
702 (define-vop (fast-ash-left/signed=>signed)
703   (:translate ash)
704   (:args (number :scs (signed-reg) :target result
705                  :load-if (not (and (sc-is number signed-stack)
706                                     (sc-is result signed-stack)
707                                     (location= number result))))
708          (amount :scs (unsigned-reg) :target ecx))
709   (:arg-types signed-num positive-fixnum)
710   (:temporary (:sc unsigned-reg :offset ecx-offset :from (:argument 1)) ecx)
711   (:results (result :scs (signed-reg) :from (:argument 0)
712                     :load-if (not (and (sc-is number signed-stack)
713                                        (sc-is result signed-stack)
714                                        (location= number result)))))
715   (:result-types signed-num)
716   (:policy :fast-safe)
717   (:note "inline ASH")
718   (:generator 4
719     (move result number)
720     (move ecx amount)
721     (inst shl result :cl)))
722
723 (define-vop (fast-ash-left/unsigned=>unsigned)
724   (:translate ash)
725   (:args (number :scs (unsigned-reg) :target result
726                  :load-if (not (and (sc-is number unsigned-stack)
727                                     (sc-is result unsigned-stack)
728                                     (location= number result))))
729          (amount :scs (unsigned-reg) :target ecx))
730   (:arg-types unsigned-num positive-fixnum)
731   (:temporary (:sc unsigned-reg :offset ecx-offset :from (:argument 1)) ecx)
732   (:results (result :scs (unsigned-reg) :from (:argument 0)
733                     :load-if (not (and (sc-is number unsigned-stack)
734                                        (sc-is result unsigned-stack)
735                                        (location= number result)))))
736   (:result-types unsigned-num)
737   (:policy :fast-safe)
738   (:note "inline ASH")
739   (:generator 4
740     (move result number)
741     (move ecx amount)
742     (inst shl result :cl)))
743
744 (define-vop (fast-ash/signed=>signed)
745   (:translate ash)
746   (:policy :fast-safe)
747   (:args (number :scs (signed-reg) :target result)
748          (amount :scs (signed-reg) :target ecx))
749   (:arg-types signed-num signed-num)
750   (:results (result :scs (signed-reg) :from (:argument 0)))
751   (:result-types signed-num)
752   (:temporary (:sc signed-reg :offset ecx-offset :from (:argument 1)) ecx)
753   (:note "inline ASH")
754   (:generator 5
755     (move result number)
756     (move ecx amount)
757     (inst or ecx ecx)
758     (inst jmp :ns positive)
759     (inst neg ecx)
760     (inst cmp ecx 31)
761     (inst jmp :be okay)
762     (inst mov ecx 31)
763     OKAY
764     (inst sar result :cl)
765     (inst jmp done)
766
767     POSITIVE
768     ;; The result-type ensures us that this shift will not overflow.
769     (inst shl result :cl)
770
771     DONE))
772
773 (define-vop (fast-ash/unsigned=>unsigned)
774   (:translate ash)
775   (:policy :fast-safe)
776   (:args (number :scs (unsigned-reg) :target result)
777          (amount :scs (signed-reg) :target ecx))
778   (:arg-types unsigned-num signed-num)
779   (:results (result :scs (unsigned-reg) :from (:argument 0)))
780   (:result-types unsigned-num)
781   (:temporary (:sc signed-reg :offset ecx-offset :from (:argument 1)) ecx)
782   (:note "inline ASH")
783   (:generator 5
784     (move result number)
785     (move ecx amount)
786     (inst or ecx ecx)
787     (inst jmp :ns positive)
788     (inst neg ecx)
789     (inst cmp ecx 31)
790     (inst jmp :be okay)
791     (inst xor result result)
792     (inst jmp done)
793     OKAY
794     (inst shr result :cl)
795     (inst jmp done)
796
797     POSITIVE
798     ;; The result-type ensures us that this shift will not overflow.
799     (inst shl result :cl)
800
801     DONE))
802
803 (in-package "SB!C")
804
805 (defknown %lea (integer integer (member 1 2 4 8) (signed-byte 32))
806   integer
807   (foldable flushable movable))
808
809 (defoptimizer (%lea derive-type) ((base index scale disp))
810   (when (and (constant-lvar-p scale)
811              (constant-lvar-p disp))
812     (let ((scale (lvar-value scale))
813           (disp (lvar-value disp))
814           (base-type (lvar-type base))
815           (index-type (lvar-type index)))
816       (when (and (numeric-type-p base-type)
817                  (numeric-type-p index-type))
818         (let ((base-lo (numeric-type-low base-type))
819               (base-hi (numeric-type-high base-type))
820               (index-lo (numeric-type-low index-type))
821               (index-hi (numeric-type-high index-type)))
822           (make-numeric-type :class 'integer
823                              :complexp :real
824                              :low (when (and base-lo index-lo)
825                                     (+ base-lo (* index-lo scale) disp))
826                              :high (when (and base-hi index-hi)
827                                      (+ base-hi (* index-hi scale) disp))))))))
828
829 (defun %lea (base index scale disp)
830   (+ base (* index scale) disp))
831
832 (in-package "SB!VM")
833
834 (define-vop (%lea/unsigned=>unsigned)
835   (:translate %lea)
836   (:policy :fast-safe)
837   (:args (base :scs (unsigned-reg))
838          (index :scs (unsigned-reg)))
839   (:info scale disp)
840   (:arg-types unsigned-num unsigned-num
841               (:constant (member 1 2 4 8))
842               (:constant (signed-byte 32)))
843   (:results (r :scs (unsigned-reg)))
844   (:result-types unsigned-num)
845   (:generator 5
846     (inst lea r (make-ea :dword :base base :index index
847                          :scale scale :disp disp))))
848
849 (define-vop (%lea/signed=>signed)
850   (:translate %lea)
851   (:policy :fast-safe)
852   (:args (base :scs (signed-reg))
853          (index :scs (signed-reg)))
854   (:info scale disp)
855   (:arg-types signed-num signed-num
856               (:constant (member 1 2 4 8))
857               (:constant (signed-byte 32)))
858   (:results (r :scs (signed-reg)))
859   (:result-types signed-num)
860   (:generator 4
861     (inst lea r (make-ea :dword :base base :index index
862                          :scale scale :disp disp))))
863
864 (define-vop (%lea/fixnum=>fixnum)
865   (:translate %lea)
866   (:policy :fast-safe)
867   (:args (base :scs (any-reg))
868          (index :scs (any-reg)))
869   (:info scale disp)
870   (:arg-types tagged-num tagged-num
871               (:constant (member 1 2 4 8))
872               (:constant (signed-byte 32)))
873   (:results (r :scs (any-reg)))
874   (:result-types tagged-num)
875   (:generator 3
876     (inst lea r (make-ea :dword :base base :index index
877                          :scale scale :disp disp))))
878
879 ;;; FIXME: before making knowledge of this too public, it needs to be
880 ;;; fixed so that it's actually _faster_ than the non-CMOV version; at
881 ;;; least on my Celeron-XXX laptop, this version is marginally slower
882 ;;; than the above version with branches.  -- CSR, 2003-09-04
883 (define-vop (fast-cmov-ash/unsigned=>unsigned)
884   (:translate ash)
885   (:policy :fast-safe)
886   (:args (number :scs (unsigned-reg) :target result)
887          (amount :scs (signed-reg) :target ecx))
888   (:arg-types unsigned-num signed-num)
889   (:results (result :scs (unsigned-reg) :from (:argument 0)))
890   (:result-types unsigned-num)
891   (:temporary (:sc signed-reg :offset ecx-offset :from (:argument 1)) ecx)
892   (:temporary (:sc any-reg :from (:eval 0) :to (:eval 1)) zero)
893   (:note "inline ASH")
894   (:guard (member :cmov *backend-subfeatures*))
895   (:generator 4
896     (move result number)
897     (move ecx amount)
898     (inst or ecx ecx)
899     (inst jmp :ns positive)
900     (inst neg ecx)
901     (inst xor zero zero)
902     (inst shr result :cl)
903     (inst cmp ecx 31)
904     (inst cmov :nbe result zero)
905     (inst jmp done)
906
907     POSITIVE
908     ;; The result-type ensures us that this shift will not overflow.
909     (inst shl result :cl)
910
911     DONE))
912 \f
913 (define-vop (signed-byte-32-len)
914   (:translate integer-length)
915   (:note "inline (signed-byte 32) integer-length")
916   (:policy :fast-safe)
917   (:args (arg :scs (signed-reg) :target res))
918   (:arg-types signed-num)
919   (:results (res :scs (unsigned-reg)))
920   (:result-types unsigned-num)
921   (:generator 28
922     (move res arg)
923     (inst cmp res 0)
924     (inst jmp :ge POS)
925     (inst not res)
926     POS
927     (inst bsr res res)
928     (inst jmp :z zero)
929     (inst inc res)
930     (inst jmp done)
931     ZERO
932     (inst xor res res)
933     DONE))
934
935 (define-vop (unsigned-byte-32-len)
936   (:translate integer-length)
937   (:note "inline (unsigned-byte 32) integer-length")
938   (:policy :fast-safe)
939   (:args (arg :scs (unsigned-reg)))
940   (:arg-types unsigned-num)
941   (:results (res :scs (unsigned-reg)))
942   (:result-types unsigned-num)
943   (:generator 26
944     (inst bsr res arg)
945     (inst jmp :z zero)
946     (inst inc res)
947     (inst jmp done)
948     ZERO
949     (inst xor res res)
950     DONE))
951
952 (define-vop (unsigned-byte-32-count)
953   (:translate logcount)
954   (:note "inline (unsigned-byte 32) logcount")
955   (:policy :fast-safe)
956   (:args (arg :scs (unsigned-reg) :target result))
957   (:arg-types unsigned-num)
958   (:results (result :scs (unsigned-reg)))
959   (:result-types positive-fixnum)
960   (:temporary (:sc unsigned-reg) temp)
961   (:generator 14
962     ;; See the comments below for how the algorithm works. The tricks
963     ;; used can be found for example in AMD's software optimization
964     ;; guide or at "http://www.hackersdelight.org/HDcode/pop.cc" in the
965     ;; function "pop1".
966     ;; Calculate 2-bit sums. Note that the value of a two-digit binary
967     ;; number is the sum of the right digit and twice the left digit.
968     ;; Thus we can calculate the sum of the two digits by shifting the
969     ;; left digit to the right position and doing a two-bit subtraction.
970     ;; This subtraction will never create a borrow and thus can be made
971     ;; on all 16 2-digit numbers at once.
972     (move result arg)
973     (move temp arg)
974     (inst shr result 1)
975     (inst and result #x55555555)
976     (inst sub temp result)
977     ;; Calculate 4-bit sums by straightforward shift, mask and add.
978     ;; Note that we shift the source operand of the MOV and not its
979     ;; destination so that the SHR and the MOV can execute in the same
980     ;; clock cycle.
981     (inst mov result temp)
982     (inst shr temp 2)
983     (inst and result #x33333333)
984     (inst and temp #x33333333)
985     (inst add result temp)
986     ;; Calculate 8-bit sums. Since each sum is at most 8, which fits
987     ;; into 4 bits, we can apply the mask after the addition, saving one
988     ;; instruction.
989     (inst mov temp result)
990     (inst shr result 4)
991     (inst add result temp)
992     (inst and result #x0f0f0f0f)
993     ;; Calculate the two 16-bit sums and the 32-bit sum. No masking is
994     ;; necessary inbetween since the final sum is at most 32 which fits
995     ;; into 6 bits.
996     (inst mov temp result)
997     (inst shr result 8)
998     (inst add result temp)
999     (inst mov temp result)
1000     (inst shr result 16)
1001     (inst add result temp)
1002     (inst and result #xff)))
1003 \f
1004 ;;;; binary conditional VOPs
1005
1006 (define-vop (fast-conditional)
1007   (:conditional)
1008   (:info target not-p)
1009   (:effects)
1010   (:affected)
1011   (:policy :fast-safe))
1012
1013 (define-vop (fast-conditional/fixnum fast-conditional)
1014   (:args (x :scs (any-reg)
1015             :load-if (not (and (sc-is x control-stack)
1016                                (sc-is y any-reg))))
1017          (y :scs (any-reg control-stack)))
1018   (:arg-types tagged-num tagged-num)
1019   (:note "inline fixnum comparison"))
1020
1021 (define-vop (fast-conditional-c/fixnum fast-conditional/fixnum)
1022   (:args (x :scs (any-reg control-stack)))
1023   (:arg-types tagged-num (:constant (signed-byte 30)))
1024   (:info target not-p y))
1025
1026 (define-vop (fast-conditional/signed fast-conditional)
1027   (:args (x :scs (signed-reg)
1028             :load-if (not (and (sc-is x signed-stack)
1029                                (sc-is y signed-reg))))
1030          (y :scs (signed-reg signed-stack)))
1031   (:arg-types signed-num signed-num)
1032   (:note "inline (signed-byte 32) comparison"))
1033
1034 (define-vop (fast-conditional-c/signed fast-conditional/signed)
1035   (:args (x :scs (signed-reg signed-stack)))
1036   (:arg-types signed-num (:constant (signed-byte 32)))
1037   (:info target not-p y))
1038
1039 (define-vop (fast-conditional/unsigned fast-conditional)
1040   (:args (x :scs (unsigned-reg)
1041             :load-if (not (and (sc-is x unsigned-stack)
1042                                (sc-is y unsigned-reg))))
1043          (y :scs (unsigned-reg unsigned-stack)))
1044   (:arg-types unsigned-num unsigned-num)
1045   (:note "inline (unsigned-byte 32) comparison"))
1046
1047 (define-vop (fast-conditional-c/unsigned fast-conditional/unsigned)
1048   (:args (x :scs (unsigned-reg unsigned-stack)))
1049   (:arg-types unsigned-num (:constant (unsigned-byte 32)))
1050   (:info target not-p y))
1051
1052 (macrolet ((define-logtest-vops ()
1053              `(progn
1054                ,@(loop for suffix in '(/fixnum -c/fixnum
1055                                        /signed -c/signed
1056                                        /unsigned -c/unsigned)
1057                        for cost in '(4 3 6 5 6 5)
1058                        collect
1059                        `(define-vop (,(symbolicate "FAST-LOGTEST" suffix)
1060                                      ,(symbolicate "FAST-CONDITIONAL" suffix))
1061                          (:translate logtest)
1062                          (:generator ,cost
1063                           (inst test x ,(if (eq suffix '-c/fixnum)
1064                                             '(fixnumize y)
1065                                             'y))
1066                           (inst jmp (if not-p :e :ne) target)))))))
1067   (define-logtest-vops))
1068
1069 (defknown %logbitp (integer unsigned-byte) boolean
1070   (movable foldable flushable always-translatable))
1071
1072 ;;; only for constant folding within the compiler
1073 (defun %logbitp (integer index)
1074   (logbitp index integer))
1075
1076 ;;; too much work to do the non-constant case (maybe?)
1077 (define-vop (fast-logbitp-c/fixnum fast-conditional-c/fixnum)
1078   (:translate %logbitp)
1079   (:arg-types tagged-num (:constant (integer 0 29)))
1080   (:generator 4
1081     (inst bt x (+ y n-fixnum-tag-bits))
1082     (inst jmp (if not-p :nc :c) target)))
1083
1084 (define-vop (fast-logbitp/signed fast-conditional/signed)
1085   (:args (x :scs (signed-reg signed-stack))
1086          (y :scs (signed-reg)))
1087   (:translate %logbitp)
1088   (:generator 6
1089     (inst bt x y)
1090     (inst jmp (if not-p :nc :c) target)))
1091
1092 (define-vop (fast-logbitp-c/signed fast-conditional-c/signed)
1093   (:translate %logbitp)
1094   (:arg-types signed-num (:constant (integer 0 31)))
1095   (:generator 5
1096     (inst bt x y)
1097     (inst jmp (if not-p :nc :c) target)))
1098
1099 (define-vop (fast-logbitp/unsigned fast-conditional/unsigned)
1100   (:args (x :scs (unsigned-reg unsigned-stack))
1101          (y :scs (unsigned-reg)))
1102   (:translate %logbitp)
1103   (:generator 6
1104     (inst bt x y)
1105     (inst jmp (if not-p :nc :c) target)))
1106
1107 (define-vop (fast-logbitp-c/unsigned fast-conditional-c/unsigned)
1108   (:translate %logbitp)
1109   (:arg-types unsigned-num (:constant (integer 0 31)))
1110   (:generator 5
1111     (inst bt x y)
1112     (inst jmp (if not-p :nc :c) target)))
1113
1114 (macrolet ((define-conditional-vop (tran cond unsigned not-cond not-unsigned)
1115              `(progn
1116                 ,@(mapcar
1117                    (lambda (suffix cost signed)
1118                      `(define-vop (;; FIXME: These could be done more
1119                                    ;; cleanly with SYMBOLICATE.
1120                                    ,(intern (format nil "~:@(FAST-IF-~A~A~)"
1121                                                     tran suffix))
1122                                    ,(intern
1123                                      (format nil "~:@(FAST-CONDITIONAL~A~)"
1124                                              suffix)))
1125                         (:translate ,tran)
1126                         (:generator ,cost
1127                                     (inst cmp x
1128                                           ,(if (eq suffix '-c/fixnum)
1129                                                '(fixnumize y)
1130                                                'y))
1131                                     (inst jmp (if not-p
1132                                                   ,(if signed
1133                                                        not-cond
1134                                                        not-unsigned)
1135                                                   ,(if signed
1136                                                        cond
1137                                                        unsigned))
1138                                           target))))
1139                    '(/fixnum -c/fixnum /signed -c/signed /unsigned -c/unsigned)
1140                    '(4 3 6 5 6 5)
1141                    '(t t t t nil nil)))))
1142
1143   (define-conditional-vop < :l :b :ge :ae)
1144   (define-conditional-vop > :g :a :le :be))
1145
1146 (define-vop (fast-if-eql/signed fast-conditional/signed)
1147   (:translate eql)
1148   (:generator 6
1149     (inst cmp x y)
1150     (inst jmp (if not-p :ne :e) target)))
1151
1152 (define-vop (fast-if-eql-c/signed fast-conditional-c/signed)
1153   (:translate eql)
1154   (:generator 5
1155     (cond ((and (sc-is x signed-reg) (zerop y))
1156            (inst test x x))  ; smaller instruction
1157           (t
1158            (inst cmp x y)))
1159     (inst jmp (if not-p :ne :e) target)))
1160
1161 (define-vop (fast-if-eql/unsigned fast-conditional/unsigned)
1162   (:translate eql)
1163   (:generator 6
1164     (inst cmp x y)
1165     (inst jmp (if not-p :ne :e) target)))
1166
1167 (define-vop (fast-if-eql-c/unsigned fast-conditional-c/unsigned)
1168   (:translate eql)
1169   (:generator 5
1170     (cond ((and (sc-is x unsigned-reg) (zerop y))
1171            (inst test x x))  ; smaller instruction
1172           (t
1173            (inst cmp x y)))
1174     (inst jmp (if not-p :ne :e) target)))
1175
1176 ;;; EQL/FIXNUM is funny because the first arg can be of any type, not just a
1177 ;;; known fixnum.
1178
1179 ;;; These versions specify a fixnum restriction on their first arg. We have
1180 ;;; also generic-eql/fixnum VOPs which are the same, but have no restriction on
1181 ;;; the first arg and a higher cost. The reason for doing this is to prevent
1182 ;;; fixnum specific operations from being used on word integers, spuriously
1183 ;;; consing the argument.
1184
1185 (define-vop (fast-eql/fixnum fast-conditional)
1186   (:args (x :scs (any-reg)
1187             :load-if (not (and (sc-is x control-stack)
1188                                (sc-is y any-reg))))
1189          (y :scs (any-reg control-stack)))
1190   (:arg-types tagged-num tagged-num)
1191   (:note "inline fixnum comparison")
1192   (:translate eql)
1193   (:generator 4
1194     (inst cmp x y)
1195     (inst jmp (if not-p :ne :e) target)))
1196 (define-vop (generic-eql/fixnum fast-eql/fixnum)
1197   (:args (x :scs (any-reg descriptor-reg)
1198             :load-if (not (and (sc-is x control-stack)
1199                                (sc-is y any-reg))))
1200          (y :scs (any-reg control-stack)))
1201   (:arg-types * tagged-num)
1202   (:variant-cost 7))
1203
1204 (define-vop (fast-eql-c/fixnum fast-conditional/fixnum)
1205   (:args (x :scs (any-reg control-stack)))
1206   (:arg-types tagged-num (:constant (signed-byte 30)))
1207   (:info target not-p y)
1208   (:translate eql)
1209   (:generator 2
1210     (cond ((and (sc-is x any-reg) (zerop y))
1211            (inst test x x))  ; smaller instruction
1212           (t
1213            (inst cmp x (fixnumize y))))
1214     (inst jmp (if not-p :ne :e) target)))
1215 (define-vop (generic-eql-c/fixnum fast-eql-c/fixnum)
1216   (:args (x :scs (any-reg descriptor-reg control-stack)))
1217   (:arg-types * (:constant (signed-byte 30)))
1218   (:variant-cost 6))
1219 \f
1220 ;;;; 32-bit logical operations
1221
1222 (define-vop (merge-bits)
1223   (:translate merge-bits)
1224   (:args (shift :scs (signed-reg unsigned-reg) :target ecx)
1225          (prev :scs (unsigned-reg) :target result)
1226          (next :scs (unsigned-reg)))
1227   (:arg-types tagged-num unsigned-num unsigned-num)
1228   (:temporary (:sc signed-reg :offset ecx-offset :from (:argument 0)) ecx)
1229   (:results (result :scs (unsigned-reg) :from (:argument 1)))
1230   (:result-types unsigned-num)
1231   (:policy :fast-safe)
1232   (:generator 4
1233     (move ecx shift)
1234     (move result prev)
1235     (inst shrd result next :cl)))
1236
1237 ;;; Only the lower 5 bits of the shift amount are significant.
1238 (define-vop (shift-towards-someplace)
1239   (:policy :fast-safe)
1240   (:args (num :scs (unsigned-reg) :target r)
1241          (amount :scs (signed-reg) :target ecx))
1242   (:arg-types unsigned-num tagged-num)
1243   (:temporary (:sc signed-reg :offset ecx-offset :from (:argument 1)) ecx)
1244   (:results (r :scs (unsigned-reg) :from (:argument 0)))
1245   (:result-types unsigned-num))
1246
1247 (define-vop (shift-towards-start shift-towards-someplace)
1248   (:translate shift-towards-start)
1249   (:note "SHIFT-TOWARDS-START")
1250   (:generator 1
1251     (move r num)
1252     (move ecx amount)
1253     (inst shr r :cl)))
1254
1255 (define-vop (shift-towards-end shift-towards-someplace)
1256   (:translate shift-towards-end)
1257   (:note "SHIFT-TOWARDS-END")
1258   (:generator 1
1259     (move r num)
1260     (move ecx amount)
1261     (inst shl r :cl)))
1262 \f
1263 ;;;; Modular functions
1264 (defmacro define-mod-binop ((name prototype) function)
1265   `(define-vop (,name ,prototype)
1266        (:args (x :target r :scs (unsigned-reg signed-reg)
1267                  :load-if (not (and (or (sc-is x unsigned-stack)
1268                                         (sc-is x signed-stack))
1269                                     (or (sc-is y unsigned-reg)
1270                                         (sc-is y signed-reg))
1271                                     (or (sc-is r unsigned-stack)
1272                                         (sc-is r signed-stack))
1273                                     (location= x r))))
1274               (y :scs (unsigned-reg signed-reg unsigned-stack signed-stack)))
1275      (:arg-types untagged-num untagged-num)
1276      (:results (r :scs (unsigned-reg signed-reg) :from (:argument 0)
1277                   :load-if (not (and (or (sc-is x unsigned-stack)
1278                                          (sc-is x signed-stack))
1279                                      (or (sc-is y unsigned-reg)
1280                                          (sc-is y unsigned-reg))
1281                                      (or (sc-is r unsigned-stack)
1282                                          (sc-is r unsigned-stack))
1283                                      (location= x r)))))
1284      (:result-types unsigned-num)
1285      (:translate ,function)))
1286 (defmacro define-mod-binop-c ((name prototype) function)
1287   `(define-vop (,name ,prototype)
1288        (:args (x :target r :scs (unsigned-reg signed-reg)
1289                  :load-if (not (and (or (sc-is x unsigned-stack)
1290                                         (sc-is x signed-stack))
1291                                     (or (sc-is r unsigned-stack)
1292                                         (sc-is r signed-stack))
1293                                     (location= x r)))))
1294      (:info y)
1295      (:arg-types untagged-num (:constant (or (unsigned-byte 32) (signed-byte 32))))
1296      (:results (r :scs (unsigned-reg signed-reg) :from (:argument 0)
1297                   :load-if (not (and (or (sc-is x unsigned-stack)
1298                                          (sc-is x signed-stack))
1299                                      (or (sc-is r unsigned-stack)
1300                                          (sc-is r unsigned-stack))
1301                                      (location= x r)))))
1302      (:result-types unsigned-num)
1303      (:translate ,function)))
1304
1305 (macrolet ((def (name -c-p)
1306              (let ((fun32 (intern (format nil "~S-MOD32" name)))
1307                    (vopu (intern (format nil "FAST-~S/UNSIGNED=>UNSIGNED" name)))
1308                    (vopcu (intern (format nil "FAST-~S-C/UNSIGNED=>UNSIGNED" name)))
1309                    (vopf (intern (format nil "FAST-~S/FIXNUM=>FIXNUM" name)))
1310                    (vopcf (intern (format nil "FAST-~S-C/FIXNUM=>FIXNUM" name)))
1311                    (vop32u (intern (format nil "FAST-~S-MOD32/WORD=>UNSIGNED" name)))
1312                    (vop32f (intern (format nil "FAST-~S-MOD32/FIXNUM=>FIXNUM" name)))
1313                    (vop32cu (intern (format nil "FAST-~S-MOD32-C/WORD=>UNSIGNED" name)))
1314                    (vop32cf (intern (format nil "FAST-~S-MOD32-C/FIXNUM=>FIXNUM" name)))
1315                    (sfun30 (intern (format nil "~S-SMOD30" name)))
1316                    (svop30f (intern (format nil "FAST-~S-SMOD30/FIXNUM=>FIXNUM" name)))
1317                    (svop30cf (intern (format nil "FAST-~S-SMOD30-C/FIXNUM=>FIXNUM" name))))
1318                `(progn
1319                   (define-modular-fun ,fun32 (x y) ,name :unsigned 32)
1320                   (define-modular-fun ,sfun30 (x y) ,name :signed 30)
1321                   (define-mod-binop (,vop32u ,vopu) ,fun32)
1322                   (define-vop (,vop32f ,vopf) (:translate ,fun32))
1323                   (define-vop (,svop30f ,vopf) (:translate ,sfun30))
1324                   ,@(when -c-p
1325                       `((define-mod-binop-c (,vop32cu ,vopcu) ,fun32)
1326                         (define-vop (,svop30cf ,vopcf) (:translate ,sfun30))))))))
1327   (def + t)
1328   (def - t)
1329   ;; (no -C variant as x86 MUL instruction doesn't take an immediate)
1330   (def * nil))
1331
1332
1333 (define-vop (fast-ash-left-mod32-c/unsigned=>unsigned
1334              fast-ash-c/unsigned=>unsigned)
1335   (:translate ash-left-mod32))
1336
1337 (define-vop (fast-ash-left-mod32/unsigned=>unsigned
1338              fast-ash-left/unsigned=>unsigned))
1339 (deftransform ash-left-mod32 ((integer count)
1340                               ((unsigned-byte 32) (unsigned-byte 5)))
1341   (when (sb!c::constant-lvar-p count)
1342     (sb!c::give-up-ir1-transform))
1343   '(%primitive fast-ash-left-mod32/unsigned=>unsigned integer count))
1344
1345 (define-vop (fast-ash-left-smod30-c/fixnum=>fixnum
1346              fast-ash-c/fixnum=>fixnum)
1347   (:translate ash-left-smod30))
1348
1349 (define-vop (fast-ash-left-smod30/fixnum=>fixnum
1350              fast-ash-left/fixnum=>fixnum))
1351 (deftransform ash-left-smod30 ((integer count)
1352                                ((signed-byte 30) (unsigned-byte 5)))
1353   (when (sb!c::constant-lvar-p count)
1354     (sb!c::give-up-ir1-transform))
1355   '(%primitive fast-ash-left-smod30/fixnum=>fixnum integer count))
1356
1357 (in-package "SB!C")
1358
1359 (defknown sb!vm::%lea-mod32 (integer integer (member 1 2 4 8) (signed-byte 32))
1360   (unsigned-byte 32)
1361   (foldable flushable movable))
1362 (defknown sb!vm::%lea-smod30 (integer integer (member 1 2 4 8) (signed-byte 32))
1363   (signed-byte 30)
1364   (foldable flushable movable))
1365
1366 (define-modular-fun-optimizer %lea ((base index scale disp) :unsigned :width width)
1367   (when (and (<= width 32)
1368              (constant-lvar-p scale)
1369              (constant-lvar-p disp))
1370     (cut-to-width base :unsigned width)
1371     (cut-to-width index :unsigned width)
1372     'sb!vm::%lea-mod32))
1373 (define-modular-fun-optimizer %lea ((base index scale disp) :signed :width width)
1374   (when (and (<= width 30)
1375              (constant-lvar-p scale)
1376              (constant-lvar-p disp))
1377     (cut-to-width base :signed width)
1378     (cut-to-width index :signed width)
1379     'sb!vm::%lea-smod30))
1380
1381 #+sb-xc-host
1382 (progn
1383   (defun sb!vm::%lea-mod32 (base index scale disp)
1384     (ldb (byte 32 0) (%lea base index scale disp)))
1385   (defun sb!vm::%lea-smod30 (base index scale disp)
1386     (mask-signed-field 30 (%lea base index scale disp))))
1387 #-sb-xc-host
1388 (progn
1389   (defun sb!vm::%lea-mod32 (base index scale disp)
1390     (let ((base (logand base #xffffffff))
1391           (index (logand index #xffffffff)))
1392       ;; can't use modular version of %LEA, as we only have VOPs for
1393       ;; constant SCALE and DISP.
1394       (ldb (byte 32 0) (+ base (* index scale) disp))))
1395   (defun sb!vm::%lea-smod30 (base index scale disp)
1396     (let ((base (mask-signed-field 30 base))
1397           (index (mask-signed-field 30 index)))
1398       ;; can't use modular version of %LEA, as we only have VOPs for
1399       ;; constant SCALE and DISP.
1400       (mask-signed-field 30 (+ base (* index scale) disp)))))
1401
1402 (in-package "SB!VM")
1403
1404 (define-vop (%lea-mod32/unsigned=>unsigned
1405              %lea/unsigned=>unsigned)
1406   (:translate %lea-mod32))
1407 (define-vop (%lea-smod30/fixnum=>fixnum
1408              %lea/fixnum=>fixnum)
1409   (:translate %lea-smod30))
1410
1411 ;;; logical operations
1412 (define-modular-fun lognot-mod32 (x) lognot :unsigned 32)
1413 (define-vop (lognot-mod32/word=>unsigned)
1414   (:translate lognot-mod32)
1415   (:args (x :scs (unsigned-reg signed-reg unsigned-stack signed-stack) :target r
1416             :load-if (not (and (or (sc-is x unsigned-stack)
1417                                    (sc-is x signed-stack))
1418                                (or (sc-is r unsigned-stack)
1419                                    (sc-is r signed-stack))
1420                                (location= x r)))))
1421   (:arg-types unsigned-num)
1422   (:results (r :scs (unsigned-reg)
1423                :load-if (not (and (or (sc-is x unsigned-stack)
1424                                       (sc-is x signed-stack))
1425                                   (or (sc-is r unsigned-stack)
1426                                       (sc-is r signed-stack))
1427                                   (sc-is r unsigned-stack)
1428                                   (location= x r)))))
1429   (:result-types unsigned-num)
1430   (:policy :fast-safe)
1431   (:generator 1
1432     (move r x)
1433     (inst not r)))
1434
1435 (define-modular-fun logxor-mod32 (x y) logxor :unsigned 32)
1436 (define-mod-binop (fast-logxor-mod32/word=>unsigned
1437                    fast-logxor/unsigned=>unsigned)
1438     logxor-mod32)
1439 (define-mod-binop-c (fast-logxor-mod32-c/word=>unsigned
1440                      fast-logxor-c/unsigned=>unsigned)
1441     logxor-mod32)
1442 (define-vop (fast-logxor-mod32/fixnum=>fixnum
1443              fast-logxor/fixnum=>fixnum)
1444   (:translate logxor-mod32))
1445 (define-vop (fast-logxor-mod32-c/fixnum=>fixnum
1446              fast-logxor-c/fixnum=>fixnum)
1447   (:translate logxor-mod32))
1448
1449 (define-source-transform logeqv (&rest args)
1450   (if (oddp (length args))
1451       `(logxor ,@args)
1452       `(lognot (logxor ,@args))))
1453 (define-source-transform logandc1 (x y)
1454   `(logand (lognot ,x) ,y))
1455 (define-source-transform logandc2 (x y)
1456   `(logand ,x (lognot ,y)))
1457 (define-source-transform logorc1 (x y)
1458   `(logior (lognot ,x) ,y))
1459 (define-source-transform logorc2 (x y)
1460   `(logior ,x (lognot ,y)))
1461 (define-source-transform lognor (x y)
1462   `(lognot (logior ,x ,y)))
1463 (define-source-transform lognand (x y)
1464   `(lognot (logand ,x ,y)))
1465 \f
1466 ;;;; bignum stuff
1467
1468 (define-vop (bignum-length get-header-data)
1469   (:translate sb!bignum:%bignum-length)
1470   (:policy :fast-safe))
1471
1472 (define-vop (bignum-set-length set-header-data)
1473   (:translate sb!bignum:%bignum-set-length)
1474   (:policy :fast-safe))
1475
1476 (define-full-reffer bignum-ref * bignum-digits-offset other-pointer-lowtag
1477   (unsigned-reg) unsigned-num sb!bignum:%bignum-ref)
1478
1479 (define-full-setter bignum-set * bignum-digits-offset other-pointer-lowtag
1480   (unsigned-reg) unsigned-num sb!bignum:%bignum-set)
1481
1482 (define-vop (digit-0-or-plus)
1483   (:translate sb!bignum:%digit-0-or-plusp)
1484   (:policy :fast-safe)
1485   (:args (digit :scs (unsigned-reg)))
1486   (:arg-types unsigned-num)
1487   (:conditional)
1488   (:info target not-p)
1489   (:generator 3
1490     (inst or digit digit)
1491     (inst jmp (if not-p :s :ns) target)))
1492
1493
1494 ;;; For add and sub with carry the sc of carry argument is any-reg so
1495 ;;; that it may be passed as a fixnum or word and thus may be 0, 1, or
1496 ;;; 4. This is easy to deal with and may save a fixnum-word
1497 ;;; conversion.
1498 (define-vop (add-w/carry)
1499   (:translate sb!bignum:%add-with-carry)
1500   (:policy :fast-safe)
1501   (:args (a :scs (unsigned-reg) :target result)
1502          (b :scs (unsigned-reg unsigned-stack) :to :eval)
1503          (c :scs (any-reg) :target temp))
1504   (:arg-types unsigned-num unsigned-num positive-fixnum)
1505   (:temporary (:sc any-reg :from (:argument 2) :to :eval) temp)
1506   (:results (result :scs (unsigned-reg) :from (:argument 0))
1507             (carry :scs (unsigned-reg)))
1508   (:result-types unsigned-num positive-fixnum)
1509   (:generator 4
1510     (move result a)
1511     (move temp c)
1512     (inst neg temp) ; Set the carry flag to 0 if c=0 else to 1
1513     (inst adc result b)
1514     (inst mov carry 0)
1515     (inst adc carry carry)))
1516
1517 ;;; Note: the borrow is 1 for no borrow and 0 for a borrow, the opposite
1518 ;;; of the x86 convention.
1519 (define-vop (sub-w/borrow)
1520   (:translate sb!bignum:%subtract-with-borrow)
1521   (:policy :fast-safe)
1522   (:args (a :scs (unsigned-reg) :to :eval :target result)
1523          (b :scs (unsigned-reg unsigned-stack) :to :result)
1524          (c :scs (any-reg control-stack)))
1525   (:arg-types unsigned-num unsigned-num positive-fixnum)
1526   (:results (result :scs (unsigned-reg) :from :eval)
1527             (borrow :scs (unsigned-reg)))
1528   (:result-types unsigned-num positive-fixnum)
1529   (:generator 5
1530     (inst cmp c 1) ; Set the carry flag to 1 if c=0 else to 0
1531     (move result a)
1532     (inst sbb result b)
1533     (inst mov borrow 1)
1534     (inst sbb borrow 0)))
1535
1536
1537 (define-vop (bignum-mult-and-add-3-arg)
1538   (:translate sb!bignum:%multiply-and-add)
1539   (:policy :fast-safe)
1540   (:args (x :scs (unsigned-reg) :target eax)
1541          (y :scs (unsigned-reg unsigned-stack))
1542          (carry-in :scs (unsigned-reg unsigned-stack)))
1543   (:arg-types unsigned-num unsigned-num unsigned-num)
1544   (:temporary (:sc unsigned-reg :offset eax-offset :from (:argument 0)
1545                    :to (:result 1) :target lo) eax)
1546   (:temporary (:sc unsigned-reg :offset edx-offset :from (:argument 1)
1547                    :to (:result 0) :target hi) edx)
1548   (:results (hi :scs (unsigned-reg))
1549             (lo :scs (unsigned-reg)))
1550   (:result-types unsigned-num unsigned-num)
1551   (:generator 20
1552     (move eax x)
1553     (inst mul eax y)
1554     (inst add eax carry-in)
1555     (inst adc edx 0)
1556     (move hi edx)
1557     (move lo eax)))
1558
1559 (define-vop (bignum-mult-and-add-4-arg)
1560   (:translate sb!bignum:%multiply-and-add)
1561   (:policy :fast-safe)
1562   (:args (x :scs (unsigned-reg) :target eax)
1563          (y :scs (unsigned-reg unsigned-stack))
1564          (prev :scs (unsigned-reg unsigned-stack))
1565          (carry-in :scs (unsigned-reg unsigned-stack)))
1566   (:arg-types unsigned-num unsigned-num unsigned-num unsigned-num)
1567   (:temporary (:sc unsigned-reg :offset eax-offset :from (:argument 0)
1568                    :to (:result 1) :target lo) eax)
1569   (:temporary (:sc unsigned-reg :offset edx-offset :from (:argument 1)
1570                    :to (:result 0) :target hi) edx)
1571   (:results (hi :scs (unsigned-reg))
1572             (lo :scs (unsigned-reg)))
1573   (:result-types unsigned-num unsigned-num)
1574   (:generator 20
1575     (move eax x)
1576     (inst mul eax y)
1577     (inst add eax prev)
1578     (inst adc edx 0)
1579     (inst add eax carry-in)
1580     (inst adc edx 0)
1581     (move hi edx)
1582     (move lo eax)))
1583
1584
1585 (define-vop (bignum-mult)
1586   (:translate sb!bignum:%multiply)
1587   (:policy :fast-safe)
1588   (:args (x :scs (unsigned-reg) :target eax)
1589          (y :scs (unsigned-reg unsigned-stack)))
1590   (:arg-types unsigned-num unsigned-num)
1591   (:temporary (:sc unsigned-reg :offset eax-offset :from (:argument 0)
1592                    :to (:result 1) :target lo) eax)
1593   (:temporary (:sc unsigned-reg :offset edx-offset :from (:argument 1)
1594                    :to (:result 0) :target hi) edx)
1595   (:results (hi :scs (unsigned-reg))
1596             (lo :scs (unsigned-reg)))
1597   (:result-types unsigned-num unsigned-num)
1598   (:generator 20
1599     (move eax x)
1600     (inst mul eax y)
1601     (move hi edx)
1602     (move lo eax)))
1603
1604 (define-vop (bignum-lognot lognot-mod32/word=>unsigned)
1605   (:translate sb!bignum:%lognot))
1606
1607 (define-vop (fixnum-to-digit)
1608   (:translate sb!bignum:%fixnum-to-digit)
1609   (:policy :fast-safe)
1610   (:args (fixnum :scs (any-reg control-stack) :target digit))
1611   (:arg-types tagged-num)
1612   (:results (digit :scs (unsigned-reg)
1613                    :load-if (not (and (sc-is fixnum control-stack)
1614                                       (sc-is digit unsigned-stack)
1615                                       (location= fixnum digit)))))
1616   (:result-types unsigned-num)
1617   (:generator 1
1618     (move digit fixnum)
1619     (inst sar digit 2)))
1620
1621 (define-vop (bignum-floor)
1622   (:translate sb!bignum:%floor)
1623   (:policy :fast-safe)
1624   (:args (div-high :scs (unsigned-reg) :target edx)
1625          (div-low :scs (unsigned-reg) :target eax)
1626          (divisor :scs (unsigned-reg unsigned-stack)))
1627   (:arg-types unsigned-num unsigned-num unsigned-num)
1628   (:temporary (:sc unsigned-reg :offset eax-offset :from (:argument 1)
1629                    :to (:result 0) :target quo) eax)
1630   (:temporary (:sc unsigned-reg :offset edx-offset :from (:argument 0)
1631                    :to (:result 1) :target rem) edx)
1632   (:results (quo :scs (unsigned-reg))
1633             (rem :scs (unsigned-reg)))
1634   (:result-types unsigned-num unsigned-num)
1635   (:generator 300
1636     (move edx div-high)
1637     (move eax div-low)
1638     (inst div eax divisor)
1639     (move quo eax)
1640     (move rem edx)))
1641
1642 (define-vop (signify-digit)
1643   (:translate sb!bignum:%fixnum-digit-with-correct-sign)
1644   (:policy :fast-safe)
1645   (:args (digit :scs (unsigned-reg unsigned-stack) :target res))
1646   (:arg-types unsigned-num)
1647   (:results (res :scs (any-reg signed-reg)
1648                  :load-if (not (and (sc-is digit unsigned-stack)
1649                                     (sc-is res control-stack signed-stack)
1650                                     (location= digit res)))))
1651   (:result-types signed-num)
1652   (:generator 1
1653     (move res digit)
1654     (when (sc-is res any-reg control-stack)
1655       (inst shl res 2))))
1656
1657 (define-vop (digit-ashr)
1658   (:translate sb!bignum:%ashr)
1659   (:policy :fast-safe)
1660   (:args (digit :scs (unsigned-reg unsigned-stack) :target result)
1661          (count :scs (unsigned-reg) :target ecx))
1662   (:arg-types unsigned-num positive-fixnum)
1663   (:temporary (:sc unsigned-reg :offset ecx-offset :from (:argument 1)) ecx)
1664   (:results (result :scs (unsigned-reg) :from (:argument 0)
1665                     :load-if (not (and (sc-is result unsigned-stack)
1666                                        (location= digit result)))))
1667   (:result-types unsigned-num)
1668   (:generator 2
1669     (move result digit)
1670     (move ecx count)
1671     (inst sar result :cl)))
1672
1673 (define-vop (digit-ashr/c)
1674   (:translate sb!bignum:%ashr)
1675   (:policy :fast-safe)
1676   (:args (digit :scs (unsigned-reg unsigned-stack) :target result))
1677   (:arg-types unsigned-num (:constant (integer 0 31)))
1678   (:info count)
1679   (:results (result :scs (unsigned-reg) :from (:argument 0)
1680                     :load-if (not (and (sc-is result unsigned-stack)
1681                                        (location= digit result)))))
1682   (:result-types unsigned-num)
1683   (:generator 1
1684     (move result digit)
1685     (inst sar result count)))
1686
1687 (define-vop (digit-lshr digit-ashr)
1688   (:translate sb!bignum:%digit-logical-shift-right)
1689   (:generator 1
1690     (move result digit)
1691     (move ecx count)
1692     (inst shr result :cl)))
1693
1694 (define-vop (digit-ashl digit-ashr)
1695   (:translate sb!bignum:%ashl)
1696   (:generator 1
1697     (move result digit)
1698     (move ecx count)
1699     (inst shl result :cl)))
1700 \f
1701 ;;;; static functions
1702
1703 (define-static-fun two-arg-/ (x y) :translate /)
1704
1705 (define-static-fun two-arg-gcd (x y) :translate gcd)
1706 (define-static-fun two-arg-lcm (x y) :translate lcm)
1707
1708 (define-static-fun two-arg-and (x y) :translate logand)
1709 (define-static-fun two-arg-ior (x y) :translate logior)
1710 (define-static-fun two-arg-xor (x y) :translate logxor)
1711
1712 \f
1713 ;;; Support for the Mersenne Twister, MT19937, random number generator
1714 ;;; due to Matsumoto and Nishimura.
1715 ;;;
1716 ;;; Makoto Matsumoto and T. Nishimura, "Mersenne twister: A
1717 ;;; 623-dimensionally equidistributed uniform pseudorandom number
1718 ;;; generator.", ACM Transactions on Modeling and Computer Simulation,
1719 ;;; 1997, to appear.
1720 ;;;
1721 ;;; State:
1722 ;;;  0-1:   Constant matrix A. [0, #x9908b0df] (not used here)
1723 ;;;  2:     Index; init. to 1.
1724 ;;;  3-626: State.
1725 (defknown random-mt19937 ((simple-array (unsigned-byte 32) (*)))
1726   (unsigned-byte 32) ())
1727 (define-vop (random-mt19937)
1728   (:policy :fast-safe)
1729   (:translate random-mt19937)
1730   (:args (state :scs (descriptor-reg) :to :result))
1731   (:arg-types simple-array-unsigned-byte-32)
1732   (:temporary (:sc unsigned-reg :from (:eval 0) :to :result) k)
1733   (:temporary (:sc unsigned-reg :offset eax-offset
1734                    :from (:eval 0) :to :result) tmp)
1735   (:results (y :scs (unsigned-reg) :from (:eval 0)))
1736   (:result-types unsigned-num)
1737   (:generator 50
1738     (inst mov k (make-ea :dword :base state
1739                          :disp (- (* (+ 2 vector-data-offset)
1740                                      n-word-bytes)
1741                                   other-pointer-lowtag)))
1742     (inst cmp k 624)
1743     (inst jmp :ne no-update)
1744     (inst mov tmp state)        ; The state is passed in EAX.
1745     (inst call (make-fixup 'random-mt19937-update :assembly-routine))
1746     ;; Restore k, and set to 0.
1747     (inst xor k k)
1748     NO-UPDATE
1749     ;; y = ptgfsr[k++];
1750     (inst mov y (make-ea :dword :base state :index k :scale 4
1751                          :disp (- (* (+ 3 vector-data-offset)
1752                                      n-word-bytes)
1753                                   other-pointer-lowtag)))
1754     ;; y ^= (y >> 11);
1755     (inst shr y 11)
1756     (inst xor y (make-ea :dword :base state :index k :scale 4
1757                          :disp (- (* (+ 3 vector-data-offset)
1758                                      n-word-bytes)
1759                                   other-pointer-lowtag)))
1760     ;; y ^= (y << 7) & #x9d2c5680
1761     (inst mov tmp y)
1762     (inst inc k)
1763     (inst shl tmp 7)
1764     (inst mov (make-ea :dword :base state
1765                        :disp (- (* (+ 2 vector-data-offset)
1766                                    n-word-bytes)
1767                                 other-pointer-lowtag))
1768           k)
1769     (inst and tmp #x9d2c5680)
1770     (inst xor y tmp)
1771     ;; y ^= (y << 15) & #xefc60000
1772     (inst mov tmp y)
1773     (inst shl tmp 15)
1774     (inst and tmp #xefc60000)
1775     (inst xor y tmp)
1776     ;; y ^= (y >> 18);
1777     (inst mov tmp y)
1778     (inst shr tmp 18)
1779     (inst xor y tmp)))
1780
1781 (in-package "SB!C")
1782
1783 (defun mask-result (class width result)
1784   (ecase class
1785     (:unsigned
1786      `(logand ,result ,(1- (ash 1 width))))
1787     (:signed
1788      `(mask-signed-field ,width ,result))))
1789
1790 ;;; This is essentially a straight implementation of the algorithm in
1791 ;;; "Strength Reduction of Multiplications by Integer Constants",
1792 ;;; Youfeng Wu, ACM SIGPLAN Notices, Vol. 30, No.2, February 1995.
1793 (defun basic-decompose-multiplication (class width arg num n-bits condensed)
1794   (case (aref condensed 0)
1795     (0
1796      (let ((tmp (min 3 (aref condensed 1))))
1797        (decf (aref condensed 1) tmp)
1798        (mask-result class width
1799                     `(%lea ,arg
1800                            ,(decompose-multiplication class width
1801                              arg (ash (1- num) (- tmp)) (1- n-bits) (subseq condensed 1))
1802                            ,(ash 1 tmp) 0))))
1803     ((1 2 3)
1804      (let ((r0 (aref condensed 0)))
1805        (incf (aref condensed 1) r0)
1806        (mask-result class width
1807                     `(%lea ,(decompose-multiplication class width
1808                              arg (- num (ash 1 r0)) (1- n-bits) (subseq condensed 1))
1809                            ,arg
1810                            ,(ash 1 r0) 0))))
1811     (t (let ((r0 (aref condensed 0)))
1812          (setf (aref condensed 0) 0)
1813          (mask-result class width
1814                       `(ash ,(decompose-multiplication class width
1815                               arg (ash num (- r0)) n-bits condensed)
1816                             ,r0))))))
1817
1818 (defun decompose-multiplication (class width arg num n-bits condensed)
1819   (cond
1820     ((= n-bits 0) 0)
1821     ((= num 1) arg)
1822     ((= n-bits 1)
1823      (mask-result class width `(ash ,arg ,(1- (integer-length num)))))
1824     ((let ((max 0) (end 0))
1825        (loop for i from 2 to (length condensed)
1826              for j = (reduce #'+ (subseq condensed 0 i))
1827              when (and (> (- (* 2 i) 3 j) max)
1828                        (< (+ (ash 1 (1+ j))
1829                              (ash (ldb (byte (- 32 (1+ j)) (1+ j)) num)
1830                                   (1+ j)))
1831                           (ash 1 32)))
1832                do (setq max (- (* 2 i) 3 j)
1833                         end i))
1834        (when (> max 0)
1835          (let ((j (reduce #'+ (subseq condensed 0 end))))
1836            (let ((n2 (+ (ash 1 (1+ j))
1837                         (ash (ldb (byte (- 32 (1+ j)) (1+ j)) num) (1+ j))))
1838                  (n1 (1+ (ldb (byte (1+ j) 0) (lognot num)))))
1839            (mask-result class width
1840                         `(- ,(optimize-multiply class width arg n2)
1841                             ,(optimize-multiply  class width arg n1))))))))
1842     ((dolist (i '(9 5 3))
1843        (when (integerp (/ num i))
1844          (when (< (logcount (/ num i)) (logcount num))
1845            (let ((x (gensym)))
1846              (return `(let ((,x ,(optimize-multiply class width arg (/ num i))))
1847                        ,(mask-result class width
1848                                      `(%lea ,x ,x (1- ,i) 0)))))))))
1849     (t (basic-decompose-multiplication class width arg num n-bits condensed))))
1850
1851 (defun optimize-multiply (class width arg x)
1852   (let* ((n-bits (logcount x))
1853          (condensed (make-array n-bits)))
1854     (let ((count 0) (bit 0))
1855       (dotimes (i 32)
1856         (cond ((logbitp i x)
1857                (setf (aref condensed bit) count)
1858                (setf count 1)
1859                (incf bit))
1860               (t (incf count)))))
1861     (decompose-multiplication class width arg x n-bits condensed)))
1862
1863 (defun *-transformer (class width y)
1864   (cond
1865     ((= y (ash 1 (integer-length y)))
1866      ;; there's a generic transform for y = 2^k
1867      (give-up-ir1-transform))
1868     ((member y '(3 5 9))
1869      ;; we can do these multiplications directly using LEA
1870      `(%lea x x ,(1- y) 0))
1871     ((member :pentium4 *backend-subfeatures*)
1872      ;; the pentium4's multiply unit is reportedly very good
1873      (give-up-ir1-transform))
1874     ;; FIXME: should make this more fine-grained.  If nothing else,
1875     ;; there should probably be a cutoff of about 9 instructions on
1876     ;; pentium-class machines.
1877     (t (optimize-multiply class width 'x y))))
1878
1879 (deftransform * ((x y)
1880                  ((unsigned-byte 32) (constant-arg (unsigned-byte 32)))
1881                  (unsigned-byte 32))
1882   "recode as leas, shifts and adds"
1883   (let ((y (lvar-value y)))
1884     (*-transformer :unsigned 32 y)))
1885 (deftransform sb!vm::*-mod32
1886     ((x y) ((unsigned-byte 32) (constant-arg (unsigned-byte 32)))
1887      (unsigned-byte 32))
1888   "recode as leas, shifts and adds"
1889   (let ((y (lvar-value y)))
1890     (*-transformer :unsigned 32 y)))
1891
1892 (deftransform * ((x y)
1893                  ((signed-byte 30) (constant-arg (unsigned-byte 32)))
1894                  (signed-byte 30))
1895   "recode as leas, shifts and adds"
1896   (let ((y (lvar-value y)))
1897     (*-transformer :signed 30 y)))
1898 (deftransform sb!vm::*-smod30
1899     ((x y) ((signed-byte 30) (constant-arg (unsigned-byte 32)))
1900      (signed-byte 30))
1901   "recode as leas, shifts and adds"
1902   (let ((y (lvar-value y)))
1903     (*-transformer :signed 30 y)))
1904
1905 ;;; FIXME: we should also be able to write an optimizer or two to
1906 ;;; convert (+ (* x 2) 17), (- (* x 9) 5) to a %LEA.