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 #xfffffffc)))))))
 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)))
 957   (:arg-types unsigned-num)
 958   (:results (result :scs (unsigned-reg)))
 959   (:result-types positive-fixnum)
 960   (:temporary (:sc unsigned-reg :from (:argument 0)) temp)
 961   (:generator 30
 962     (move result arg)
 963
 964     (inst mov temp result)
 965     (inst shr temp 1)
 966     (inst and result #x55555555)
 967     (inst and temp #x55555555)
 968     (inst add result temp)
 969
 970     (inst mov temp result)
 971     (inst shr temp 2)
 972     (inst and result #x33333333)
 973     (inst and temp #x33333333)
 974     (inst add result temp)
 975
 976     (inst mov temp result)
 977     (inst shr temp 4)
 978     (inst and result #x0f0f0f0f)
 979     (inst and temp #x0f0f0f0f)
 980     (inst add result temp)
 981
 982     (inst mov temp result)
 983     (inst shr temp 8)
 984     (inst and result #x00ff00ff)
 985     (inst and temp #x00ff00ff)
 986     (inst add result temp)
 987
 988     (inst mov temp result)
 989     (inst shr temp 16)
 990     (inst and result #x0000ffff)
 991     (inst and temp #x0000ffff)
 992     (inst add result temp)))
 993 \f
 994 ;;;; binary conditional VOPs
 995
 996 (define-vop (fast-conditional)
 997   (:conditional)
 998   (:info target not-p)
 999   (:effects)
1000   (:affected)
1001   (:policy :fast-safe))
1002
1003 (define-vop (fast-conditional/fixnum fast-conditional)
1004   (:args (x :scs (any-reg)
1005             :load-if (not (and (sc-is x control-stack)
1006                                (sc-is y any-reg))))
1007          (y :scs (any-reg control-stack)))
1008   (:arg-types tagged-num tagged-num)
1009   (:note "inline fixnum comparison"))
1010
1011 (define-vop (fast-conditional-c/fixnum fast-conditional/fixnum)
1012   (:args (x :scs (any-reg control-stack)))
1013   (:arg-types tagged-num (:constant (signed-byte 30)))
1014   (:info target not-p y))
1015
1016 (define-vop (fast-conditional/signed fast-conditional)
1017   (:args (x :scs (signed-reg)
1018             :load-if (not (and (sc-is x signed-stack)
1019                                (sc-is y signed-reg))))
1020          (y :scs (signed-reg signed-stack)))
1021   (:arg-types signed-num signed-num)
1022   (:note "inline (signed-byte 32) comparison"))
1023
1024 (define-vop (fast-conditional-c/signed fast-conditional/signed)
1025   (:args (x :scs (signed-reg signed-stack)))
1026   (:arg-types signed-num (:constant (signed-byte 32)))
1027   (:info target not-p y))
1028
1029 (define-vop (fast-conditional/unsigned fast-conditional)
1030   (:args (x :scs (unsigned-reg)
1031             :load-if (not (and (sc-is x unsigned-stack)
1032                                (sc-is y unsigned-reg))))
1033          (y :scs (unsigned-reg unsigned-stack)))
1034   (:arg-types unsigned-num unsigned-num)
1035   (:note "inline (unsigned-byte 32) comparison"))
1036
1037 (define-vop (fast-conditional-c/unsigned fast-conditional/unsigned)
1038   (:args (x :scs (unsigned-reg unsigned-stack)))
1039   (:arg-types unsigned-num (:constant (unsigned-byte 32)))
1040   (:info target not-p y))
1041
1042 (macrolet ((define-logtest-vops ()
1043              `(progn
1044                ,@(loop for suffix in '(/fixnum -c/fixnum
1045                                        /signed -c/signed
1046                                        /unsigned -c/unsigned)
1047                        for cost in '(4 3 6 5 6 5)
1048                        collect
1049                        `(define-vop (,(symbolicate "FAST-LOGTEST" suffix)
1050                                      ,(symbolicate "FAST-CONDITIONAL" suffix))
1051                          (:translate logtest)
1052                          (:generator ,cost
1053                           (inst test x ,(if (eq suffix '-c/fixnum)
1054                                             '(fixnumize y)
1055                                             'y))
1056                           (inst jmp (if not-p :e :ne) target)))))))
1057   (define-logtest-vops))
1058
1059 (defknown %logbitp (integer unsigned-byte) boolean
1060   (movable foldable flushable))
1061
1062 (defun %logbitp (integer index)
1063   (logbitp index integer))
1064
1065 ;;; too much work to do the non-constant case (maybe?)
1066 (define-vop (fast-logbitp-c/fixnum fast-conditional-c/fixnum)
1067   (:translate %logbitp)
1068   (:arg-types tagged-num (:constant (integer 0 29)))
1069   (:generator 4
1070     (inst bt x (+ y n-fixnum-tag-bits))
1071     (inst jmp (if not-p :nc :c) target)))
1072
1073 (define-vop (fast-logbitp/signed fast-conditional/signed)
1074   (:translate %logbitp)
1075   (:generator 6
1076     (inst bt x y)
1077     (inst jmp (if not-p :nc :c) target)))
1078
1079 (define-vop (fast-logbitp-c/signed fast-conditional-c/signed)
1080   (:translate %logbitp)
1081   (:arg-types signed-num (:constant (integer 0 31)))
1082   (:generator 5
1083     (inst bt x y)
1084     (inst jmp (if not-p :nc :c) target)))
1085
1086 (define-vop (fast-logbitp/unsigned fast-conditional/unsigned)
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/unsigned fast-conditional-c/unsigned)
1093   (:translate %logbitp)
1094   (:arg-types unsigned-num (:constant (integer 0 31)))
1095   (:generator 5
1096     (inst bt x y)
1097     (inst jmp (if not-p :nc :c) target)))
1098
1099 (macrolet ((define-conditional-vop (tran cond unsigned not-cond not-unsigned)
1100              `(progn
1101                 ,@(mapcar
1102                    (lambda (suffix cost signed)
1103                      `(define-vop (;; FIXME: These could be done more
1104                                    ;; cleanly with SYMBOLICATE.
1105                                    ,(intern (format nil "~:@(FAST-IF-~A~A~)"
1106                                                     tran suffix))
1107                                    ,(intern
1108                                      (format nil "~:@(FAST-CONDITIONAL~A~)"
1109                                              suffix)))
1110                         (:translate ,tran)
1111                         (:generator ,cost
1112                                     (inst cmp x
1113                                           ,(if (eq suffix '-c/fixnum)
1114                                                '(fixnumize y)
1115                                                'y))
1116                                     (inst jmp (if not-p
1117                                                   ,(if signed
1118                                                        not-cond
1119                                                        not-unsigned)
1120                                                   ,(if signed
1121                                                        cond
1122                                                        unsigned))
1123                                           target))))
1124                    '(/fixnum -c/fixnum /signed -c/signed /unsigned -c/unsigned)
1125                    '(4 3 6 5 6 5)
1126                    '(t t t t nil nil)))))
1127
1128   (define-conditional-vop < :l :b :ge :ae)
1129   (define-conditional-vop > :g :a :le :be))
1130
1131 (define-vop (fast-if-eql/signed fast-conditional/signed)
1132   (:translate eql)
1133   (:generator 6
1134     (inst cmp x y)
1135     (inst jmp (if not-p :ne :e) target)))
1136
1137 (define-vop (fast-if-eql-c/signed fast-conditional-c/signed)
1138   (:translate eql)
1139   (:generator 5
1140     (cond ((and (sc-is x signed-reg) (zerop y))
1141            (inst test x x))  ; smaller instruction
1142           (t
1143            (inst cmp x y)))
1144     (inst jmp (if not-p :ne :e) target)))
1145
1146 (define-vop (fast-if-eql/unsigned fast-conditional/unsigned)
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/unsigned fast-conditional-c/unsigned)
1153   (:translate eql)
1154   (:generator 5
1155     (cond ((and (sc-is x unsigned-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 ;;; EQL/FIXNUM is funny because the first arg can be of any type, not just a
1162 ;;; known fixnum.
1163
1164 ;;; These versions specify a fixnum restriction on their first arg. We have
1165 ;;; also generic-eql/fixnum VOPs which are the same, but have no restriction on
1166 ;;; the first arg and a higher cost. The reason for doing this is to prevent
1167 ;;; fixnum specific operations from being used on word integers, spuriously
1168 ;;; consing the argument.
1169
1170 (define-vop (fast-eql/fixnum fast-conditional)
1171   (:args (x :scs (any-reg)
1172             :load-if (not (and (sc-is x control-stack)
1173                                (sc-is y any-reg))))
1174          (y :scs (any-reg control-stack)))
1175   (:arg-types tagged-num tagged-num)
1176   (:note "inline fixnum comparison")
1177   (:translate eql)
1178   (:generator 4
1179     (inst cmp x y)
1180     (inst jmp (if not-p :ne :e) target)))
1181 (define-vop (generic-eql/fixnum fast-eql/fixnum)
1182   (:args (x :scs (any-reg descriptor-reg)
1183             :load-if (not (and (sc-is x control-stack)
1184                                (sc-is y any-reg))))
1185          (y :scs (any-reg control-stack)))
1186   (:arg-types * tagged-num)
1187   (:variant-cost 7))
1188
1189 (define-vop (fast-eql-c/fixnum fast-conditional/fixnum)
1190   (:args (x :scs (any-reg control-stack)))
1191   (:arg-types tagged-num (:constant (signed-byte 30)))
1192   (:info target not-p y)
1193   (:translate eql)
1194   (:generator 2
1195     (cond ((and (sc-is x any-reg) (zerop y))
1196            (inst test x x))  ; smaller instruction
1197           (t
1198            (inst cmp x (fixnumize y))))
1199     (inst jmp (if not-p :ne :e) target)))
1200 (define-vop (generic-eql-c/fixnum fast-eql-c/fixnum)
1201   (:args (x :scs (any-reg descriptor-reg control-stack)))
1202   (:arg-types * (:constant (signed-byte 30)))
1203   (:variant-cost 6))
1204 \f
1205 ;;;; 32-bit logical operations
1206
1207 (define-vop (merge-bits)
1208   (:translate merge-bits)
1209   (:args (shift :scs (signed-reg unsigned-reg) :target ecx)
1210          (prev :scs (unsigned-reg) :target result)
1211          (next :scs (unsigned-reg)))
1212   (:arg-types tagged-num unsigned-num unsigned-num)
1213   (:temporary (:sc signed-reg :offset ecx-offset :from (:argument 0)) ecx)
1214   (:results (result :scs (unsigned-reg) :from (:argument 1)))
1215   (:result-types unsigned-num)
1216   (:policy :fast-safe)
1217   (:generator 4
1218     (move ecx shift)
1219     (move result prev)
1220     (inst shrd result next :cl)))
1221
1222 ;;; Only the lower 5 bits of the shift amount are significant.
1223 (define-vop (shift-towards-someplace)
1224   (:policy :fast-safe)
1225   (:args (num :scs (unsigned-reg) :target r)
1226          (amount :scs (signed-reg) :target ecx))
1227   (:arg-types unsigned-num tagged-num)
1228   (:temporary (:sc signed-reg :offset ecx-offset :from (:argument 1)) ecx)
1229   (:results (r :scs (unsigned-reg) :from (:argument 0)))
1230   (:result-types unsigned-num))
1231
1232 (define-vop (shift-towards-start shift-towards-someplace)
1233   (:translate shift-towards-start)
1234   (:note "SHIFT-TOWARDS-START")
1235   (:generator 1
1236     (move r num)
1237     (move ecx amount)
1238     (inst shr r :cl)))
1239
1240 (define-vop (shift-towards-end shift-towards-someplace)
1241   (:translate shift-towards-end)
1242   (:note "SHIFT-TOWARDS-END")
1243   (:generator 1
1244     (move r num)
1245     (move ecx amount)
1246     (inst shl r :cl)))
1247 \f
1248 ;;;; Modular functions
1249 (defmacro define-mod-binop ((name prototype) function)
1250   `(define-vop (,name ,prototype)
1251        (:args (x :target r :scs (unsigned-reg signed-reg)
1252                  :load-if (not (and (or (sc-is x unsigned-stack)
1253                                         (sc-is x signed-stack))
1254                                     (or (sc-is y unsigned-reg)
1255                                         (sc-is y signed-reg))
1256                                     (or (sc-is r unsigned-stack)
1257                                         (sc-is r signed-stack))
1258                                     (location= x r))))
1259               (y :scs (unsigned-reg signed-reg unsigned-stack signed-stack)))
1260      (:arg-types untagged-num untagged-num)
1261      (:results (r :scs (unsigned-reg signed-reg) :from (:argument 0)
1262                   :load-if (not (and (or (sc-is x unsigned-stack)
1263                                          (sc-is x signed-stack))
1264                                      (or (sc-is y unsigned-reg)
1265                                          (sc-is y unsigned-reg))
1266                                      (or (sc-is r unsigned-stack)
1267                                          (sc-is r unsigned-stack))
1268                                      (location= x r)))))
1269      (:result-types unsigned-num)
1270      (:translate ,function)))
1271 (defmacro define-mod-binop-c ((name prototype) function)
1272   `(define-vop (,name ,prototype)
1273        (:args (x :target r :scs (unsigned-reg signed-reg)
1274                  :load-if (not (and (or (sc-is x unsigned-stack)
1275                                         (sc-is x signed-stack))
1276                                     (or (sc-is r unsigned-stack)
1277                                         (sc-is r signed-stack))
1278                                     (location= x r)))))
1279      (:info y)
1280      (:arg-types untagged-num (:constant (or (unsigned-byte 32) (signed-byte 32))))
1281      (:results (r :scs (unsigned-reg signed-reg) :from (:argument 0)
1282                   :load-if (not (and (or (sc-is x unsigned-stack)
1283                                          (sc-is x signed-stack))
1284                                      (or (sc-is r unsigned-stack)
1285                                          (sc-is r unsigned-stack))
1286                                      (location= x r)))))
1287      (:result-types unsigned-num)
1288      (:translate ,function)))
1289
1290 (macrolet ((def (name -c-p)
1291              (let ((fun32 (intern (format nil "~S-MOD32" name)))
1292                    (vopu (intern (format nil "FAST-~S/UNSIGNED=>UNSIGNED" name)))
1293                    (vopcu (intern (format nil "FAST-~S-C/UNSIGNED=>UNSIGNED" name)))
1294                    (vopf (intern (format nil "FAST-~S/FIXNUM=>FIXNUM" name)))
1295                    (vopcf (intern (format nil "FAST-~S-C/FIXNUM=>FIXNUM" name)))
1296                    (vop32u (intern (format nil "FAST-~S-MOD32/WORD=>UNSIGNED" name)))
1297                    (vop32f (intern (format nil "FAST-~S-MOD32/FIXNUM=>FIXNUM" name)))
1298                    (vop32cu (intern (format nil "FAST-~S-MOD32-C/WORD=>UNSIGNED" name)))
1299                    (vop32cf (intern (format nil "FAST-~S-MOD32-C/FIXNUM=>FIXNUM" name)))
1300                    (sfun30 (intern (format nil "~S-SMOD30" name)))
1301                    (svop30f (intern (format nil "FAST-~S-SMOD30/FIXNUM=>FIXNUM" name)))
1302                    (svop30cf (intern (format nil "FAST-~S-SMOD30-C/FIXNUM=>FIXNUM" name))))
1303                `(progn
1304                   (define-modular-fun ,fun32 (x y) ,name :unsigned 32)
1305                   (define-modular-fun ,sfun30 (x y) ,name :signed 30)
1306                   (define-mod-binop (,vop32u ,vopu) ,fun32)
1307                   (define-vop (,vop32f ,vopf) (:translate ,fun32))
1308                   (define-vop (,svop30f ,vopf) (:translate ,sfun30))
1309                   ,@(when -c-p
1310                       `((define-mod-binop-c (,vop32cu ,vopcu) ,fun32)
1311                         (define-vop (,svop30cf ,vopcf) (:translate ,sfun30))))))))
1312   (def + t)
1313   (def - t)
1314   ;; (no -C variant as x86 MUL instruction doesn't take an immediate)
1315   (def * nil))
1316
1317
1318 (define-vop (fast-ash-left-mod32-c/unsigned=>unsigned
1319              fast-ash-c/unsigned=>unsigned)
1320   (:translate ash-left-mod32))
1321
1322 (define-vop (fast-ash-left-mod32/unsigned=>unsigned
1323              fast-ash-left/unsigned=>unsigned))
1324 (deftransform ash-left-mod32 ((integer count)
1325                               ((unsigned-byte 32) (unsigned-byte 5)))
1326   (when (sb!c::constant-lvar-p count)
1327     (sb!c::give-up-ir1-transform))
1328   '(%primitive fast-ash-left-mod32/unsigned=>unsigned integer count))
1329
1330 (define-vop (fast-ash-left-smod30-c/fixnum=>fixnum
1331              fast-ash-c/fixnum=>fixnum)
1332   (:translate ash-left-smod30))
1333
1334 (define-vop (fast-ash-left-smod30/fixnum=>fixnum
1335              fast-ash-left/fixnum=>fixnum))
1336 (deftransform ash-left-smod30 ((integer count)
1337                                ((signed-byte 30) (unsigned-byte 5)))
1338   (when (sb!c::constant-lvar-p count)
1339     (sb!c::give-up-ir1-transform))
1340   '(%primitive fast-ash-left-smod30/fixnum=>fixnum integer count))
1341
1342 (in-package "SB!C")
1343
1344 (defknown sb!vm::%lea-mod32 (integer integer (member 1 2 4 8) (signed-byte 32))
1345   (unsigned-byte 32)
1346   (foldable flushable movable))
1347 (defknown sb!vm::%lea-smod30 (integer integer (member 1 2 4 8) (signed-byte 32))
1348   (signed-byte 30)
1349   (foldable flushable movable))
1350
1351 (define-modular-fun-optimizer %lea ((base index scale disp) :unsigned :width width)
1352   (when (and (<= width 32)
1353              (constant-lvar-p scale)
1354              (constant-lvar-p disp))
1355     (cut-to-width base :unsigned width)
1356     (cut-to-width index :unsigned width)
1357     'sb!vm::%lea-mod32))
1358 (define-modular-fun-optimizer %lea ((base index scale disp) :signed :width width)
1359   (when (and (<= width 30)
1360              (constant-lvar-p scale)
1361              (constant-lvar-p disp))
1362     (cut-to-width base :signed width)
1363     (cut-to-width index :signed width)
1364     'sb!vm::%lea-smod30))
1365
1366 #+sb-xc-host
1367 (progn
1368   (defun sb!vm::%lea-mod32 (base index scale disp)
1369     (ldb (byte 32 0) (%lea base index scale disp)))
1370   (defun sb!vm::%lea-smod30 (base index scale disp)
1371     (mask-signed-field 30 (%lea base index scale disp))))
1372 #-sb-xc-host
1373 (progn
1374   (defun sb!vm::%lea-mod32 (base index scale disp)
1375     (let ((base (logand base #xffffffff))
1376           (index (logand index #xffffffff)))
1377       ;; can't use modular version of %LEA, as we only have VOPs for
1378       ;; constant SCALE and DISP.
1379       (ldb (byte 32 0) (+ base (* index scale) disp))))
1380   (defun sb!vm::%lea-smod30 (base index scale disp)
1381     (let ((base (mask-signed-field 30 base))
1382           (index (mask-signed-field 30 index)))
1383       ;; can't use modular version of %LEA, as we only have VOPs for
1384       ;; constant SCALE and DISP.
1385       (mask-signed-field 30 (+ base (* index scale) disp)))))
1386
1387 (in-package "SB!VM")
1388
1389 (define-vop (%lea-mod32/unsigned=>unsigned
1390              %lea/unsigned=>unsigned)
1391   (:translate %lea-mod32))
1392 (define-vop (%lea-smod30/fixnum=>fixnum
1393              %lea/fixnum=>fixnum)
1394   (:translate %lea-smod30))
1395
1396 ;;; logical operations
1397 (define-modular-fun lognot-mod32 (x) lognot :unsigned 32)
1398 (define-vop (lognot-mod32/word=>unsigned)
1399   (:translate lognot-mod32)
1400   (:args (x :scs (unsigned-reg signed-reg unsigned-stack signed-stack) :target r
1401             :load-if (not (and (or (sc-is x unsigned-stack)
1402                                    (sc-is x signed-stack))
1403                                (or (sc-is r unsigned-stack)
1404                                    (sc-is r signed-stack))
1405                                (location= x r)))))
1406   (:arg-types unsigned-num)
1407   (:results (r :scs (unsigned-reg)
1408                :load-if (not (and (or (sc-is x unsigned-stack)
1409                                       (sc-is x signed-stack))
1410                                   (or (sc-is r unsigned-stack)
1411                                       (sc-is r signed-stack))
1412                                   (sc-is r unsigned-stack)
1413                                   (location= x r)))))
1414   (:result-types unsigned-num)
1415   (:policy :fast-safe)
1416   (:generator 1
1417     (move r x)
1418     (inst not r)))
1419
1420 (define-modular-fun logxor-mod32 (x y) logxor :unsigned 32)
1421 (define-mod-binop (fast-logxor-mod32/word=>unsigned
1422                    fast-logxor/unsigned=>unsigned)
1423     logxor-mod32)
1424 (define-mod-binop-c (fast-logxor-mod32-c/word=>unsigned
1425                      fast-logxor-c/unsigned=>unsigned)
1426     logxor-mod32)
1427 (define-vop (fast-logxor-mod32/fixnum=>fixnum
1428              fast-logxor/fixnum=>fixnum)
1429   (:translate logxor-mod32))
1430 (define-vop (fast-logxor-mod32-c/fixnum=>fixnum
1431              fast-logxor-c/fixnum=>fixnum)
1432   (:translate logxor-mod32))
1433
1434 (define-source-transform logeqv (&rest args)
1435   (if (oddp (length args))
1436       `(logxor ,@args)
1437       `(lognot (logxor ,@args))))
1438 (define-source-transform logandc1 (x y)
1439   `(logand (lognot ,x) ,y))
1440 (define-source-transform logandc2 (x y)
1441   `(logand ,x (lognot ,y)))
1442 (define-source-transform logorc1 (x y)
1443   `(logior (lognot ,x) ,y))
1444 (define-source-transform logorc2 (x y)
1445   `(logior ,x (lognot ,y)))
1446 (define-source-transform lognor (x y)
1447   `(lognot (logior ,x ,y)))
1448 (define-source-transform lognand (x y)
1449   `(lognot (logand ,x ,y)))
1450 \f
1451 ;;;; bignum stuff
1452
1453 (define-vop (bignum-length get-header-data)
1454   (:translate sb!bignum:%bignum-length)
1455   (:policy :fast-safe))
1456
1457 (define-vop (bignum-set-length set-header-data)
1458   (:translate sb!bignum:%bignum-set-length)
1459   (:policy :fast-safe))
1460
1461 (define-full-reffer bignum-ref * bignum-digits-offset other-pointer-lowtag
1462   (unsigned-reg) unsigned-num sb!bignum:%bignum-ref)
1463
1464 (define-full-setter bignum-set * bignum-digits-offset other-pointer-lowtag
1465   (unsigned-reg) unsigned-num sb!bignum:%bignum-set)
1466
1467 (define-vop (digit-0-or-plus)
1468   (:translate sb!bignum:%digit-0-or-plusp)
1469   (:policy :fast-safe)
1470   (:args (digit :scs (unsigned-reg)))
1471   (:arg-types unsigned-num)
1472   (:conditional)
1473   (:info target not-p)
1474   (:generator 3
1475     (inst or digit digit)
1476     (inst jmp (if not-p :s :ns) target)))
1477
1478
1479 ;;; For add and sub with carry the sc of carry argument is any-reg so
1480 ;;; that it may be passed as a fixnum or word and thus may be 0, 1, or
1481 ;;; 4. This is easy to deal with and may save a fixnum-word
1482 ;;; conversion.
1483 (define-vop (add-w/carry)
1484   (:translate sb!bignum:%add-with-carry)
1485   (:policy :fast-safe)
1486   (:args (a :scs (unsigned-reg) :target result)
1487          (b :scs (unsigned-reg unsigned-stack) :to :eval)
1488          (c :scs (any-reg) :target temp))
1489   (:arg-types unsigned-num unsigned-num positive-fixnum)
1490   (:temporary (:sc any-reg :from (:argument 2) :to :eval) temp)
1491   (:results (result :scs (unsigned-reg) :from (:argument 0))
1492             (carry :scs (unsigned-reg)))
1493   (:result-types unsigned-num positive-fixnum)
1494   (:generator 4
1495     (move result a)
1496     (move temp c)
1497     (inst neg temp) ; Set the carry flag to 0 if c=0 else to 1
1498     (inst adc result b)
1499     (inst mov carry 0)
1500     (inst adc carry carry)))
1501
1502 ;;; Note: the borrow is 1 for no borrow and 0 for a borrow, the opposite
1503 ;;; of the x86 convention.
1504 (define-vop (sub-w/borrow)
1505   (:translate sb!bignum:%subtract-with-borrow)
1506   (:policy :fast-safe)
1507   (:args (a :scs (unsigned-reg) :to :eval :target result)
1508          (b :scs (unsigned-reg unsigned-stack) :to :result)
1509          (c :scs (any-reg control-stack)))
1510   (:arg-types unsigned-num unsigned-num positive-fixnum)
1511   (:results (result :scs (unsigned-reg) :from :eval)
1512             (borrow :scs (unsigned-reg)))
1513   (:result-types unsigned-num positive-fixnum)
1514   (:generator 5
1515     (inst cmp c 1) ; Set the carry flag to 1 if c=0 else to 0
1516     (move result a)
1517     (inst sbb result b)
1518     (inst mov borrow 1)
1519     (inst sbb borrow 0)))
1520
1521
1522 (define-vop (bignum-mult-and-add-3-arg)
1523   (:translate sb!bignum:%multiply-and-add)
1524   (:policy :fast-safe)
1525   (:args (x :scs (unsigned-reg) :target eax)
1526          (y :scs (unsigned-reg unsigned-stack))
1527          (carry-in :scs (unsigned-reg unsigned-stack)))
1528   (:arg-types unsigned-num unsigned-num unsigned-num)
1529   (:temporary (:sc unsigned-reg :offset eax-offset :from (:argument 0)
1530                    :to (:result 1) :target lo) eax)
1531   (:temporary (:sc unsigned-reg :offset edx-offset :from (:argument 1)
1532                    :to (:result 0) :target hi) edx)
1533   (:results (hi :scs (unsigned-reg))
1534             (lo :scs (unsigned-reg)))
1535   (:result-types unsigned-num unsigned-num)
1536   (:generator 20
1537     (move eax x)
1538     (inst mul eax y)
1539     (inst add eax carry-in)
1540     (inst adc edx 0)
1541     (move hi edx)
1542     (move lo eax)))
1543
1544 (define-vop (bignum-mult-and-add-4-arg)
1545   (:translate sb!bignum:%multiply-and-add)
1546   (:policy :fast-safe)
1547   (:args (x :scs (unsigned-reg) :target eax)
1548          (y :scs (unsigned-reg unsigned-stack))
1549          (prev :scs (unsigned-reg unsigned-stack))
1550          (carry-in :scs (unsigned-reg unsigned-stack)))
1551   (:arg-types unsigned-num unsigned-num unsigned-num unsigned-num)
1552   (:temporary (:sc unsigned-reg :offset eax-offset :from (:argument 0)
1553                    :to (:result 1) :target lo) eax)
1554   (:temporary (:sc unsigned-reg :offset edx-offset :from (:argument 1)
1555                    :to (:result 0) :target hi) edx)
1556   (:results (hi :scs (unsigned-reg))
1557             (lo :scs (unsigned-reg)))
1558   (:result-types unsigned-num unsigned-num)
1559   (:generator 20
1560     (move eax x)
1561     (inst mul eax y)
1562     (inst add eax prev)
1563     (inst adc edx 0)
1564     (inst add eax carry-in)
1565     (inst adc edx 0)
1566     (move hi edx)
1567     (move lo eax)))
1568
1569
1570 (define-vop (bignum-mult)
1571   (:translate sb!bignum:%multiply)
1572   (:policy :fast-safe)
1573   (:args (x :scs (unsigned-reg) :target eax)
1574          (y :scs (unsigned-reg unsigned-stack)))
1575   (:arg-types unsigned-num unsigned-num)
1576   (:temporary (:sc unsigned-reg :offset eax-offset :from (:argument 0)
1577                    :to (:result 1) :target lo) eax)
1578   (:temporary (:sc unsigned-reg :offset edx-offset :from (:argument 1)
1579                    :to (:result 0) :target hi) edx)
1580   (:results (hi :scs (unsigned-reg))
1581             (lo :scs (unsigned-reg)))
1582   (:result-types unsigned-num unsigned-num)
1583   (:generator 20
1584     (move eax x)
1585     (inst mul eax y)
1586     (move hi edx)
1587     (move lo eax)))
1588
1589 (define-vop (bignum-lognot lognot-mod32/word=>unsigned)
1590   (:translate sb!bignum:%lognot))
1591
1592 (define-vop (fixnum-to-digit)
1593   (:translate sb!bignum:%fixnum-to-digit)
1594   (:policy :fast-safe)
1595   (:args (fixnum :scs (any-reg control-stack) :target digit))
1596   (:arg-types tagged-num)
1597   (:results (digit :scs (unsigned-reg)
1598                    :load-if (not (and (sc-is fixnum control-stack)
1599                                       (sc-is digit unsigned-stack)
1600                                       (location= fixnum digit)))))
1601   (:result-types unsigned-num)
1602   (:generator 1
1603     (move digit fixnum)
1604     (inst sar digit 2)))
1605
1606 (define-vop (bignum-floor)
1607   (:translate sb!bignum:%floor)
1608   (:policy :fast-safe)
1609   (:args (div-high :scs (unsigned-reg) :target edx)
1610          (div-low :scs (unsigned-reg) :target eax)
1611          (divisor :scs (unsigned-reg unsigned-stack)))
1612   (:arg-types unsigned-num unsigned-num unsigned-num)
1613   (:temporary (:sc unsigned-reg :offset eax-offset :from (:argument 1)
1614                    :to (:result 0) :target quo) eax)
1615   (:temporary (:sc unsigned-reg :offset edx-offset :from (:argument 0)
1616                    :to (:result 1) :target rem) edx)
1617   (:results (quo :scs (unsigned-reg))
1618             (rem :scs (unsigned-reg)))
1619   (:result-types unsigned-num unsigned-num)
1620   (:generator 300
1621     (move edx div-high)
1622     (move eax div-low)
1623     (inst div eax divisor)
1624     (move quo eax)
1625     (move rem edx)))
1626
1627 (define-vop (signify-digit)
1628   (:translate sb!bignum:%fixnum-digit-with-correct-sign)
1629   (:policy :fast-safe)
1630   (:args (digit :scs (unsigned-reg unsigned-stack) :target res))
1631   (:arg-types unsigned-num)
1632   (:results (res :scs (any-reg signed-reg)
1633                  :load-if (not (and (sc-is digit unsigned-stack)
1634                                     (sc-is res control-stack signed-stack)
1635                                     (location= digit res)))))
1636   (:result-types signed-num)
1637   (:generator 1
1638     (move res digit)
1639     (when (sc-is res any-reg control-stack)
1640       (inst shl res 2))))
1641
1642 (define-vop (digit-ashr)
1643   (:translate sb!bignum:%ashr)
1644   (:policy :fast-safe)
1645   (:args (digit :scs (unsigned-reg unsigned-stack) :target result)
1646          (count :scs (unsigned-reg) :target ecx))
1647   (:arg-types unsigned-num positive-fixnum)
1648   (:temporary (:sc unsigned-reg :offset ecx-offset :from (:argument 1)) ecx)
1649   (:results (result :scs (unsigned-reg) :from (:argument 0)
1650                     :load-if (not (and (sc-is result unsigned-stack)
1651                                        (location= digit result)))))
1652   (:result-types unsigned-num)
1653   (:generator 1
1654     (move result digit)
1655     (move ecx count)
1656     (inst sar result :cl)))
1657
1658 (define-vop (digit-lshr digit-ashr)
1659   (:translate sb!bignum:%digit-logical-shift-right)
1660   (:generator 1
1661     (move result digit)
1662     (move ecx count)
1663     (inst shr result :cl)))
1664
1665 (define-vop (digit-ashl digit-ashr)
1666   (:translate sb!bignum:%ashl)
1667   (:generator 1
1668     (move result digit)
1669     (move ecx count)
1670     (inst shl result :cl)))
1671 \f
1672 ;;;; static functions
1673
1674 (define-static-fun two-arg-/ (x y) :translate /)
1675
1676 (define-static-fun two-arg-gcd (x y) :translate gcd)
1677 (define-static-fun two-arg-lcm (x y) :translate lcm)
1678
1679 (define-static-fun two-arg-and (x y) :translate logand)
1680 (define-static-fun two-arg-ior (x y) :translate logior)
1681 (define-static-fun two-arg-xor (x y) :translate logxor)
1682
1683 \f
1684 ;;; Support for the Mersenne Twister, MT19937, random number generator
1685 ;;; due to Matsumoto and Nishimura.
1686 ;;;
1687 ;;; Makoto Matsumoto and T. Nishimura, "Mersenne twister: A
1688 ;;; 623-dimensionally equidistributed uniform pseudorandom number
1689 ;;; generator.", ACM Transactions on Modeling and Computer Simulation,
1690 ;;; 1997, to appear.
1691 ;;;
1692 ;;; State:
1693 ;;;  0-1:   Constant matrix A. [0, #x9908b0df] (not used here)
1694 ;;;  2:     Index; init. to 1.
1695 ;;;  3-626: State.
1696 (defknown random-mt19937 ((simple-array (unsigned-byte 32) (*)))
1697   (unsigned-byte 32) ())
1698 (define-vop (random-mt19937)
1699   (:policy :fast-safe)
1700   (:translate random-mt19937)
1701   (:args (state :scs (descriptor-reg) :to :result))
1702   (:arg-types simple-array-unsigned-byte-32)
1703   (:temporary (:sc unsigned-reg :from (:eval 0) :to :result) k)
1704   (:temporary (:sc unsigned-reg :offset eax-offset
1705                    :from (:eval 0) :to :result) tmp)
1706   (:results (y :scs (unsigned-reg) :from (:eval 0)))
1707   (:result-types unsigned-num)
1708   (:generator 50
1709     (inst mov k (make-ea :dword :base state
1710                          :disp (- (* (+ 2 vector-data-offset)
1711                                      n-word-bytes)
1712                                   other-pointer-lowtag)))
1713     (inst cmp k 624)
1714     (inst jmp :ne no-update)
1715     (inst mov tmp state)        ; The state is passed in EAX.
1716     (inst call (make-fixup 'random-mt19937-update :assembly-routine))
1717     ;; Restore k, and set to 0.
1718     (inst xor k k)
1719     NO-UPDATE
1720     ;; y = ptgfsr[k++];
1721     (inst mov y (make-ea :dword :base state :index k :scale 4
1722                          :disp (- (* (+ 3 vector-data-offset)
1723                                      n-word-bytes)
1724                                   other-pointer-lowtag)))
1725     ;; y ^= (y >> 11);
1726     (inst shr y 11)
1727     (inst xor y (make-ea :dword :base state :index k :scale 4
1728                          :disp (- (* (+ 3 vector-data-offset)
1729                                      n-word-bytes)
1730                                   other-pointer-lowtag)))
1731     ;; y ^= (y << 7) & #x9d2c5680
1732     (inst mov tmp y)
1733     (inst inc k)
1734     (inst shl tmp 7)
1735     (inst mov (make-ea :dword :base state
1736                        :disp (- (* (+ 2 vector-data-offset)
1737                                    n-word-bytes)
1738                                 other-pointer-lowtag))
1739           k)
1740     (inst and tmp #x9d2c5680)
1741     (inst xor y tmp)
1742     ;; y ^= (y << 15) & #xefc60000
1743     (inst mov tmp y)
1744     (inst shl tmp 15)
1745     (inst and tmp #xefc60000)
1746     (inst xor y tmp)
1747     ;; y ^= (y >> 18);
1748     (inst mov tmp y)
1749     (inst shr tmp 18)
1750     (inst xor y tmp)))
1751
1752 (in-package "SB!C")
1753
1754 (defun mask-result (class width result)
1755   (ecase class
1756     (:unsigned
1757      `(logand ,result ,(1- (ash 1 width))))
1758     (:signed
1759      `(mask-signed-field ,width ,result))))
1760
1761 ;;; This is essentially a straight implementation of the algorithm in
1762 ;;; "Strength Reduction of Multiplications by Integer Constants",
1763 ;;; Youfeng Wu, ACM SIGPLAN Notices, Vol. 30, No.2, February 1995.
1764 (defun basic-decompose-multiplication (class width arg num n-bits condensed)
1765   (case (aref condensed 0)
1766     (0
1767      (let ((tmp (min 3 (aref condensed 1))))
1768        (decf (aref condensed 1) tmp)
1769        (mask-result class width
1770                     `(%lea ,arg
1771                            ,(decompose-multiplication class width
1772                              arg (ash (1- num) (- tmp)) (1- n-bits) (subseq condensed 1))
1773                            ,(ash 1 tmp) 0))))
1774     ((1 2 3)
1775      (let ((r0 (aref condensed 0)))
1776        (incf (aref condensed 1) r0)
1777        (mask-result class width
1778                     `(%lea ,(decompose-multiplication class width
1779                              arg (- num (ash 1 r0)) (1- n-bits) (subseq condensed 1))
1780                            ,arg
1781                            ,(ash 1 r0) 0))))
1782     (t (let ((r0 (aref condensed 0)))
1783          (setf (aref condensed 0) 0)
1784          (mask-result class width
1785                       `(ash ,(decompose-multiplication class width
1786                               arg (ash num (- r0)) n-bits condensed)
1787                             ,r0))))))
1788
1789 (defun decompose-multiplication (class width arg num n-bits condensed)
1790   (cond
1791     ((= n-bits 0) 0)
1792     ((= num 1) arg)
1793     ((= n-bits 1)
1794      (mask-result class width `(ash ,arg ,(1- (integer-length num)))))
1795     ((let ((max 0) (end 0))
1796        (loop for i from 2 to (length condensed)
1797              for j = (reduce #'+ (subseq condensed 0 i))
1798              when (and (> (- (* 2 i) 3 j) max)
1799                        (< (+ (ash 1 (1+ j))
1800                              (ash (ldb (byte (- 32 (1+ j)) (1+ j)) num)
1801                                   (1+ j)))
1802                           (ash 1 32)))
1803                do (setq max (- (* 2 i) 3 j)
1804                         end i))
1805        (when (> max 0)
1806          (let ((j (reduce #'+ (subseq condensed 0 end))))
1807            (let ((n2 (+ (ash 1 (1+ j))
1808                         (ash (ldb (byte (- 32 (1+ j)) (1+ j)) num) (1+ j))))
1809                  (n1 (1+ (ldb (byte (1+ j) 0) (lognot num)))))
1810            (mask-result class width
1811                         `(- ,(optimize-multiply class width arg n2)
1812                             ,(optimize-multiply  class width arg n1))))))))
1813     ((dolist (i '(9 5 3))
1814        (when (integerp (/ num i))
1815          (when (< (logcount (/ num i)) (logcount num))
1816            (let ((x (gensym)))
1817              (return `(let ((,x ,(optimize-multiply class width arg (/ num i))))
1818                        ,(mask-result class width
1819                                      `(%lea ,x ,x (1- ,i) 0)))))))))
1820     (t (basic-decompose-multiplication class width arg num n-bits condensed))))
1821
1822 (defun optimize-multiply (class width arg x)
1823   (let* ((n-bits (logcount x))
1824          (condensed (make-array n-bits)))
1825     (let ((count 0) (bit 0))
1826       (dotimes (i 32)
1827         (cond ((logbitp i x)
1828                (setf (aref condensed bit) count)
1829                (setf count 1)
1830                (incf bit))
1831               (t (incf count)))))
1832     (decompose-multiplication class width arg x n-bits condensed)))
1833
1834 (defun *-transformer (class width y)
1835   (cond
1836     ((= y (ash 1 (integer-length y)))
1837      ;; there's a generic transform for y = 2^k
1838      (give-up-ir1-transform))
1839     ((member y '(3 5 9))
1840      ;; we can do these multiplications directly using LEA
1841      `(%lea x x ,(1- y) 0))
1842     ((member :pentium4 *backend-subfeatures*)
1843      ;; the pentium4's multiply unit is reportedly very good
1844      (give-up-ir1-transform))
1845     ;; FIXME: should make this more fine-grained.  If nothing else,
1846     ;; there should probably be a cutoff of about 9 instructions on
1847     ;; pentium-class machines.
1848     (t (optimize-multiply class width 'x y))))
1849
1850 (deftransform * ((x y)
1851                  ((unsigned-byte 32) (constant-arg (unsigned-byte 32)))
1852                  (unsigned-byte 32))
1853   "recode as leas, shifts and adds"
1854   (let ((y (lvar-value y)))
1855     (*-transformer :unsigned 32 y)))
1856 (deftransform sb!vm::*-mod32
1857     ((x y) ((unsigned-byte 32) (constant-arg (unsigned-byte 32)))
1858      (unsigned-byte 32))
1859   "recode as leas, shifts and adds"
1860   (let ((y (lvar-value y)))
1861     (*-transformer :unsigned 32 y)))
1862
1863 (deftransform * ((x y)
1864                  ((signed-byte 30) (constant-arg (unsigned-byte 32)))
1865                  (signed-byte 30))
1866   "recode as leas, shifts and adds"
1867   (let ((y (lvar-value y)))
1868     (*-transformer :signed 30 y)))
1869 (deftransform sb!vm::*-smod30
1870     ((x y) ((signed-byte 30) (constant-arg (unsigned-byte 32)))
1871      (signed-byte 30))
1872   "recode as leas, shifts and adds"
1873   (let ((y (lvar-value y)))
1874     (*-transformer :signed 30 y)))
1875
1876 ;;; FIXME: we should also be able to write an optimizer or two to
1877 ;;; convert (+ (* x 2) 17), (- (* x 9) 5) to a %LEA.