src/assembly/x86/arith.lisp

   1 ;;;; simple cases for generic arithmetic
   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 ;;;; addition, subtraction, and multiplication
  15
  16 (macrolet ((define-generic-arith-routine ((fun cost) &body body)
  17              `(define-assembly-routine (,(symbolicate "GENERIC-" fun)
  18                                         (:cost ,cost)
  19                                         (:return-style :full-call)
  20                                         (:translate ,fun)
  21                                         (:policy :safe)
  22                                         (:save-p t))
  23                 ((:arg x (descriptor-reg any-reg) edx-offset)
  24                  (:arg y (descriptor-reg any-reg)
  25                        ;; this seems wrong esi-offset -- FIXME: What's it mean?
  26                        edi-offset)
  27
  28                  (:res res (descriptor-reg any-reg) edx-offset)
  29
  30                  (:temp eax unsigned-reg eax-offset)
  31                  (:temp ebx unsigned-reg ebx-offset)
  32                  (:temp ecx unsigned-reg ecx-offset))
  33
  34                 (declare (ignorable ebx))
  35
  36                 (inst test x 3)  ; fixnum?
  37                 (inst jmp :nz DO-STATIC-FUN) ; no - do generic
  38                 (inst test y 3)  ; fixnum?
  39                 (inst jmp :z DO-BODY)   ; yes - doit here
  40
  41                 DO-STATIC-FUN
  42                 (inst pop eax)
  43                 (inst push ebp-tn)
  44                 (inst lea
  45                       ebp-tn
  46                       (make-ea :dword :base esp-tn :disp n-word-bytes))
  47                 (inst sub esp-tn (fixnumize 2))
  48                 (inst push eax)  ; callers return addr
  49                 (inst mov ecx (fixnumize 2)) ; arg count
  50                 (inst jmp
  51                       (make-ea :dword
  52                                :disp (+ nil-value
  53                                         (static-fun-offset
  54                                          ',(symbolicate "TWO-ARG-" fun)))))
  55
  56                 DO-BODY
  57                 ,@body)))
  58
  59   (define-generic-arith-routine (+ 10)
  60     (move res x)
  61     (inst add res y)
  62     (inst jmp :no OKAY)
  63     (inst rcr res 1)                  ; carry has correct sign
  64     (inst sar res 1)                  ; remove type bits
  65
  66     (move ecx res)
  67
  68     (with-fixed-allocation (res bignum-widetag (1+ bignum-digits-offset))
  69       (storew ecx res bignum-digits-offset other-pointer-lowtag))
  70
  71     OKAY)
  72
  73   (define-generic-arith-routine (- 10)
  74     ;; FIXME: This is screwed up.
  75       ;;; I can't figure out the flags on subtract. Overflow never gets
  76       ;;; set and carry always does. (- 0 most-negative-fixnum) can't be
  77       ;;; easily detected so just let the upper level stuff do it.
  78     (inst jmp DO-STATIC-FUN)
  79
  80     (move res x)
  81     (inst sub res y)
  82     (inst jmp :no OKAY)
  83     (inst rcr res 1)
  84     (inst sar res 1)                  ; remove type bits
  85
  86     (move ecx res)
  87
  88     (with-fixed-allocation (res bignum-widetag (1+ bignum-digits-offset))
  89       (storew ecx res bignum-digits-offset other-pointer-lowtag))
  90     OKAY)
  91
  92   (define-generic-arith-routine (* 30)
  93     (move eax x)                          ; must use eax for 64-bit result
  94     (inst sar eax 2)                  ; remove *4 fixnum bias
  95     (inst imul y)                        ; result in edx:eax
  96     (inst jmp :no okay)            ; still fixnum
  97
  98     ;; zzz jrd changed edx to ebx in here, as edx isn't listed as a temp, above
  99     ;;     pfw says that loses big -- edx is target for arg x and result res
 100     ;;     note that 'edx' is not defined -- using x
 101     (inst shrd eax x 2)            ; high bits from edx
 102     (inst sar x 2)                      ; now shift edx too
 103
 104     (move ecx x)                          ; save high bits from cdq
 105     (inst cdq)                      ; edx:eax <- sign-extend of eax
 106     (inst cmp x ecx)
 107     (inst jmp :e SINGLE-WORD-BIGNUM)
 108
 109     (with-fixed-allocation (res bignum-widetag (+ bignum-digits-offset 2))
 110       (storew eax res bignum-digits-offset other-pointer-lowtag)
 111       (storew ecx res (1+ bignum-digits-offset) other-pointer-lowtag))
 112     (inst jmp DONE)
 113
 114     SINGLE-WORD-BIGNUM
 115
 116     (with-fixed-allocation (res bignum-widetag (1+ bignum-digits-offset))
 117       (storew eax res bignum-digits-offset other-pointer-lowtag))
 118     (inst jmp DONE)
 119
 120     OKAY
 121     (move res eax)
 122     DONE))
 123 \f
 124 ;;;; negation
 125
 126 (define-assembly-routine (generic-negate
 127                           (:cost 10)
 128                           (:return-style :full-call)
 129                           (:policy :safe)
 130                           (:translate %negate)
 131                           (:save-p t))
 132                          ((:arg x (descriptor-reg any-reg) edx-offset)
 133                           (:res res (descriptor-reg any-reg) edx-offset)
 134
 135                           (:temp eax unsigned-reg eax-offset)
 136                           (:temp ecx unsigned-reg ecx-offset))
 137   (inst test x 3)
 138   (inst jmp :z FIXNUM)
 139
 140   (inst pop eax)
 141   (inst push ebp-tn)
 142   (inst lea ebp-tn (make-ea :dword :base esp-tn :disp n-word-bytes))
 143   (inst sub esp-tn (fixnumize 2))
 144   (inst push eax)
 145   (inst mov ecx (fixnumize 1))    ; arg count
 146   (inst jmp (make-ea :dword
 147                      :disp (+ nil-value (static-fun-offset '%negate))))
 148
 149   FIXNUM
 150   (move res x)
 151   (inst neg res)                        ; (- most-negative-fixnum) is BIGNUM
 152   (inst jmp :no OKAY)
 153   (inst shr res 2)                    ; sign bit is data - remove type bits
 154   (move ecx res)
 155
 156   (with-fixed-allocation (res bignum-widetag (1+ bignum-digits-offset))
 157     (storew ecx res bignum-digits-offset other-pointer-lowtag))
 158
 159   OKAY)
 160 \f
 161 ;;;; comparison
 162
 163 (macrolet ((define-cond-assem-rtn (name translate static-fn test)
 164              `(define-assembly-routine (,name
 165                                         (:cost 10)
 166                                         (:return-style :full-call)
 167                                         (:policy :safe)
 168                                         (:translate ,translate)
 169                                         (:save-p t))
 170                 ((:arg x (descriptor-reg any-reg) edx-offset)
 171                  (:arg y (descriptor-reg any-reg) edi-offset)
 172
 173                  (:res res descriptor-reg edx-offset)
 174
 175                  (:temp eax unsigned-reg eax-offset)
 176                  (:temp ecx unsigned-reg ecx-offset))
 177
 178                 ;; KLUDGE: The "3" here is a mask for the bits which will be
 179                 ;; zero in a fixnum. It should have a symbolic name. (Actually,
 180                 ;; it might already have a symbolic name which the coder
 181                 ;; couldn't be bothered to use..) -- WHN 19990917
 182                 (inst test x 3)
 183                 (inst jmp :nz TAIL-CALL-TO-STATIC-FN)
 184                 (inst test y 3)
 185                 (inst jmp :z INLINE-FIXNUM-COMPARE)
 186
 187                 TAIL-CALL-TO-STATIC-FN
 188                 (inst pop eax)
 189                 (inst push ebp-tn)
 190                 (inst lea ebp-tn (make-ea :dword
 191                                           :base esp-tn
 192                                           :disp n-word-bytes))
 193                 (inst sub esp-tn (fixnumize 2)) ; FIXME: Push 2 words on stack,
 194                                                 ; weirdly?
 195                 (inst push eax)
 196                 (inst mov ecx (fixnumize 2)) ; FIXME: FIXNUMIZE and
 197                                         ; SINGLE-FLOAT-BITS are parallel,
 198                                         ; should be named parallelly.
 199                 (inst jmp (make-ea :dword
 200                                    :disp (+ nil-value
 201                                             (static-fun-offset ',static-fn))))
 202
 203                 INLINE-FIXNUM-COMPARE
 204                 (inst cmp x y)
 205                 (inst jmp ,test RETURN-TRUE)
 206                 (inst mov res nil-value)
 207                 ;; FIXME: A note explaining this return convention, or a
 208                 ;; symbolic name for it, would be nice. (It looks as though we
 209                 ;; should be hand-crafting the same return sequence as would be
 210                 ;; produced by GENERATE-RETURN-SEQUENCE, but in that case it's
 211                 ;; not clear why we don't just jump to the end of this function
 212                 ;; to share the return sequence there.
 213                 (inst pop eax)
 214                 (inst add eax 2)
 215                 (inst jmp eax)
 216
 217                 RETURN-TRUE
 218                 (load-symbol res t))))
 219
 220   (define-cond-assem-rtn generic-< < two-arg-< :l)
 221   (define-cond-assem-rtn generic-> > two-arg-> :g))
 222
 223 (define-assembly-routine (generic-eql
 224                           (:cost 10)
 225                           (:return-style :full-call)
 226                           (:policy :safe)
 227                           (:translate eql)
 228                           (:save-p t))
 229                          ((:arg x (descriptor-reg any-reg) edx-offset)
 230                           (:arg y (descriptor-reg any-reg) edi-offset)
 231
 232                           (:res res descriptor-reg edx-offset)
 233
 234                           (:temp eax unsigned-reg eax-offset)
 235                           (:temp ecx unsigned-reg ecx-offset))
 236   (inst cmp x y)
 237   (inst jmp :e RETURN-T)
 238   (inst test x 3)
 239   (inst jmp :z RETURN-NIL)
 240   (inst test y 3)
 241   (inst jmp :nz DO-STATIC-FN)
 242
 243   RETURN-NIL
 244   (inst mov res nil-value)
 245   (inst pop eax)
 246   (inst add eax 2)
 247   (inst jmp eax)
 248
 249   DO-STATIC-FN
 250   (inst pop eax)
 251   (inst push ebp-tn)
 252   (inst lea ebp-tn (make-ea :dword :base esp-tn :disp n-word-bytes))
 253   (inst sub esp-tn (fixnumize 2))
 254   (inst push eax)
 255   (inst mov ecx (fixnumize 2))
 256   (inst jmp (make-ea :dword
 257                      :disp (+ nil-value (static-fun-offset 'eql))))
 258
 259   RETURN-T
 260   (load-symbol res t)
 261   ;; FIXME: I don't understand how we return from here..
 262   )
 263
 264 (define-assembly-routine (generic-=
 265                           (:cost 10)
 266                           (:return-style :full-call)
 267                           (:policy :safe)
 268                           (:translate =)
 269                           (:save-p t))
 270                          ((:arg x (descriptor-reg any-reg) edx-offset)
 271                           (:arg y (descriptor-reg any-reg) edi-offset)
 272
 273                           (:res res descriptor-reg edx-offset)
 274
 275                           (:temp eax unsigned-reg eax-offset)
 276                           (:temp ecx unsigned-reg ecx-offset)
 277                           )
 278   (inst test x 3)                      ; descriptor?
 279   (inst jmp :nz DO-STATIC-FN)          ; yes, do it here
 280   (inst test y 3)                      ; descriptor?
 281   (inst jmp :nz DO-STATIC-FN)
 282   (inst cmp x y)
 283   (inst jmp :e RETURN-T)                ; ok
 284
 285   (inst mov res nil-value)
 286   (inst pop eax)
 287   (inst add eax 2)
 288   (inst jmp eax)
 289
 290   DO-STATIC-FN
 291   (inst pop eax)
 292   (inst push ebp-tn)
 293   (inst lea ebp-tn (make-ea :dword :base esp-tn :disp n-word-bytes))
 294   (inst sub esp-tn (fixnumize 2))
 295   (inst push eax)
 296   (inst mov ecx (fixnumize 2))
 297   (inst jmp (make-ea :dword
 298                      :disp (+ nil-value (static-fun-offset 'two-arg-=))))
 299
 300   RETURN-T
 301   (load-symbol res t))
 302
 303 \f
 304 ;;; Support for the Mersenne Twister, MT19937, random number generator
 305 ;;; due to Matsumoto and Nishimura.
 306 ;;;
 307 ;;; Makoto Matsumoto and T. Nishimura, "Mersenne twister: A
 308 ;;; 623-dimensionally equidistributed uniform pseudorandom number
 309 ;;; generator.", ACM Transactions on Modeling and Computer Simulation,
 310 ;;; 1997, to appear.
 311 ;;;
 312 ;;; State:
 313 ;;;  0-1:   Constant matrix A. [0, #x9908b0df] (not used here)
 314 ;;;  2:     Index; init. to 1.
 315 ;;;  3-626: State.
 316
 317 ;;; This assembly routine is called from the inline VOP and updates
 318 ;;; the state vector with new random numbers. The state vector is
 319 ;;; passed in the EAX register.
 320 #+sb-assembling ; We don't want a vop for this one.
 321 (define-assembly-routine
 322     (random-mt19937-update)
 323     ((:temp state unsigned-reg eax-offset)
 324      (:temp k unsigned-reg ebx-offset)
 325      (:temp y unsigned-reg ecx-offset)
 326      (:temp tmp unsigned-reg edx-offset))
 327
 328   ;; Save the temporary registers.
 329   (inst push k)
 330   (inst push y)
 331   (inst push tmp)
 332
 333   ;; Generate a new set of results.
 334   (inst xor k k)
 335   LOOP1
 336   (inst mov y (make-ea :dword :base state :index k :scale 4
 337                        :disp (- (* (+ 3 vector-data-offset)
 338                                    n-word-bytes)
 339                                 other-pointer-lowtag)))
 340   (inst mov tmp (make-ea :dword :base state :index k :scale 4
 341                          :disp (- (* (+ 1 3 vector-data-offset)
 342                                      n-word-bytes)
 343                                   other-pointer-lowtag)))
 344   (inst and y #x80000000)
 345   (inst and tmp #x7fffffff)
 346   (inst or y tmp)
 347   (inst shr y 1)
 348   (inst jmp :nc skip1)
 349   (inst xor y #x9908b0df)
 350   SKIP1
 351   (inst xor y (make-ea :dword :base state :index k :scale 4
 352                        :disp (- (* (+ 397 3 vector-data-offset)
 353                                    n-word-bytes)
 354                                 other-pointer-lowtag)))
 355   (inst mov (make-ea :dword :base state :index k :scale 4
 356                      :disp (- (* (+ 3 vector-data-offset)
 357                                  n-word-bytes)
 358                               other-pointer-lowtag))
 359         y)
 360   (inst inc k)
 361   (inst cmp k (- 624 397))
 362   (inst jmp :b loop1)
 363   LOOP2
 364   (inst mov y (make-ea :dword :base state :index k :scale 4
 365                        :disp (- (* (+ 3 vector-data-offset)
 366                                    n-word-bytes)
 367                                 other-pointer-lowtag)))
 368   (inst mov tmp (make-ea :dword :base state :index k :scale 4
 369                          :disp (- (* (+ 1 3 vector-data-offset)
 370                                      n-word-bytes)
 371                                   other-pointer-lowtag)))
 372   (inst and y #x80000000)
 373   (inst and tmp #x7fffffff)
 374   (inst or y tmp)
 375   (inst shr y 1)
 376   (inst jmp :nc skip2)
 377   (inst xor y #x9908b0df)
 378   SKIP2
 379   (inst xor y (make-ea :dword :base state :index k :scale 4
 380                        :disp (- (* (+ (- 397 624) 3 vector-data-offset)
 381                                    n-word-bytes)
 382                                 other-pointer-lowtag)))
 383   (inst mov (make-ea :dword :base state :index k :scale 4
 384                      :disp (- (* (+ 3 vector-data-offset)
 385                                  n-word-bytes)
 386                               other-pointer-lowtag))
 387         y)
 388   (inst inc k)
 389   (inst cmp k (- 624 1))
 390   (inst jmp :b loop2)
 391
 392   (inst mov y (make-ea :dword :base state
 393                        :disp (- (* (+ (- 624 1) 3 vector-data-offset)
 394                                    n-word-bytes)
 395                                 other-pointer-lowtag)))
 396   (inst mov tmp (make-ea :dword :base state
 397                          :disp (- (* (+ 0 3 vector-data-offset)
 398                                      n-word-bytes)
 399                                   other-pointer-lowtag)))
 400   (inst and y #x80000000)
 401   (inst and tmp #x7fffffff)
 402   (inst or y tmp)
 403   (inst shr y 1)
 404   (inst jmp :nc skip3)
 405   (inst xor y #x9908b0df)
 406   SKIP3
 407   (inst xor y (make-ea :dword :base state
 408                        :disp (- (* (+ (- 397 1) 3 vector-data-offset)
 409                                    n-word-bytes)
 410                                 other-pointer-lowtag)))
 411   (inst mov (make-ea :dword :base state
 412                      :disp (- (* (+ (- 624 1) 3 vector-data-offset)
 413                                  n-word-bytes)
 414                               other-pointer-lowtag))
 415         y)
 416
 417   ;; Restore the temporary registers and return.
 418   (inst pop tmp)
 419   (inst pop y)
 420   (inst pop k)
 421   (inst ret))