src/compiler/x86/arith.lisp

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