src/compiler/alpha/macros.lisp

   1 ;;;; various useful macros for generating Alpha code
   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
  14 ;;; a handy macro for defining top level forms that depend on the
  15 ;;; compile environment
  16 (defmacro expand (expr)
  17   (let ((gensym (gensym)))
  18     `(macrolet
  19          ((,gensym ()
  20             ,expr))
  21        (,gensym))))
  22 \f
  23 ;;; instruction-like macros
  24
  25 ;;; c.f. x86 backend:
  26 ;;(defmacro move (dst src)
  27 ;;  #!+sb-doc
  28 ;;  "Move SRC into DST unless they are location=."
  29 ;;  (once-only ((n-dst dst)
  30 ;;              (n-src src))
  31 ;;    `(unless (location= ,n-dst ,n-src)
  32 ;;       (inst mov ,n-dst ,n-src))))
  33
  34 (defmacro move (src dst)
  35   "Move SRC into DST unless they are location=."
  36   (once-only ((n-src src) (n-dst dst))
  37     `(unless (location= ,n-src ,n-dst)
  38        (inst move ,n-src ,n-dst))))
  39
  40 (defmacro loadw (result base &optional (offset 0) (lowtag 0))
  41   (once-only ((result result) (base base))
  42     `(inst ldl ,result (- (ash ,offset word-shift) ,lowtag) ,base)))
  43
  44 (defmacro loadq (result base &optional (offset 0) (lowtag 0))
  45   (once-only ((result result) (base base))
  46     `(inst ldq ,result (- (ash ,offset word-shift) ,lowtag) ,base)))
  47
  48 (defmacro storew (value base &optional (offset 0) (lowtag 0))
  49   (once-only ((value value) (base base) (offset offset) (lowtag lowtag))
  50     `(inst stl ,value (- (ash ,offset word-shift) ,lowtag) ,base)))
  51
  52 (defmacro storeq (value base &optional (offset 0) (lowtag 0))
  53   (once-only ((value value) (base base) (offset offset) (lowtag lowtag))
  54     `(inst stq ,value (- (ash ,offset word-shift) ,lowtag) ,base)))
  55
  56 (defmacro load-symbol (reg symbol)
  57   (once-only ((reg reg) (symbol symbol))
  58     `(inst lda ,reg (static-symbol-offset ,symbol) null-tn)))
  59
  60 (defmacro load-symbol-value (reg symbol)
  61   `(inst ldl ,reg
  62          (+ (static-symbol-offset ',symbol)
  63             (ash symbol-value-slot word-shift)
  64             (- other-pointer-lowtag))
  65          null-tn))
  66
  67 (defmacro store-symbol-value (reg symbol)
  68   `(inst stl ,reg
  69          (+ (static-symbol-offset ',symbol)
  70             (ash symbol-value-slot word-shift)
  71             (- other-pointer-lowtag))
  72          null-tn))
  73
  74 (defmacro load-type (target source &optional (offset 0))
  75   "Loads the type bits of a pointer into target independent of
  76   byte-ordering issues."
  77   (once-only ((n-target target)
  78               (n-source source)
  79               (n-offset offset))
  80      `(progn
  81         (inst ldl ,n-target ,n-offset ,n-source)
  82         (inst and ,n-target #xff ,n-target))))
  83
  84 ;;; macros to handle the fact that we cannot use the machine native
  85 ;;; call and return instructions
  86
  87 (defmacro lisp-jump (function lip)
  88   "Jump to the lisp function FUNCTION.  LIP is an interior-reg temporary."
  89   `(progn
  90      (inst lda ,lip (- (ash sb!vm:simple-fun-code-offset sb!vm:word-shift)
  91                        sb!vm:fun-pointer-lowtag)
  92             ,function)
  93      (move ,function code-tn)
  94      (inst jsr zero-tn ,lip 1)))
  95
  96 (defmacro lisp-return (return-pc lip &key (offset 0) (frob-code t))
  97   "Return to RETURN-PC.  LIP is an interior-reg temporary."
  98   `(progn
  99      (inst lda ,lip
 100            (- (* (1+ ,offset) n-word-bytes) other-pointer-lowtag)
 101             ,return-pc)
 102      ,@(when frob-code
 103          `((move ,return-pc code-tn)))
 104      (inst ret zero-tn ,lip 1)))
 105
 106
 107 (defmacro emit-return-pc (label)
 108   "Emit a return-pc header word.  LABEL is the label to use for this
 109    return-pc."
 110   `(progn
 111      (align n-lowtag-bits)
 112      (emit-label ,label)
 113      (inst lra-header-word)))
 114
 115
 116 \f
 117 ;;;; stack TN's
 118
 119 ;;;    Move a stack TN to a register and vice-versa.
 120 (defmacro load-stack-tn (reg stack)
 121   `(let ((reg ,reg)
 122          (stack ,stack))
 123      (let ((offset (tn-offset stack)))
 124        (sc-case stack
 125          ((control-stack)
 126           (loadw reg cfp-tn offset))))))
 127 (defmacro store-stack-tn (stack reg)
 128   `(let ((stack ,stack)
 129          (reg ,reg))
 130      (let ((offset (tn-offset stack)))
 131        (sc-case stack
 132          ((control-stack)
 133           (storew reg cfp-tn offset))))))
 134
 135 ;;; Move the TN Reg-Or-Stack into Reg if it isn't already there.
 136 (defmacro maybe-load-stack-tn (reg reg-or-stack)
 137   (once-only ((n-reg reg)
 138               (n-stack reg-or-stack))
 139     `(sc-case ,n-reg
 140        ((any-reg descriptor-reg)
 141         (sc-case ,n-stack
 142           ((any-reg descriptor-reg)
 143            (move ,n-stack ,n-reg))
 144           ((control-stack)
 145            (loadw ,n-reg cfp-tn (tn-offset ,n-stack))))))))
 146
 147 ;;; Move the TN Reg-Or-Stack into Reg if it isn't already there.
 148 (defmacro maybe-load-stack-nfp-tn (reg reg-or-stack temp)
 149   (once-only ((n-reg reg)
 150               (n-stack reg-or-stack))
 151      `(when ,reg
 152         (sc-case ,n-reg
 153          ((any-reg descriptor-reg)
 154           (sc-case ,n-stack
 155            ((any-reg descriptor-reg)
 156             (move ,n-stack ,n-reg))
 157            ((control-stack)
 158             (loadw ,n-reg cfp-tn (tn-offset ,n-stack))
 159             (inst mskll nsp-tn 0 ,temp)
 160             (inst bis ,temp ,n-reg ,n-reg))))))))
 161 \f
 162 ;;;; storage allocation
 163
 164 ;;; Do stuff to allocate an other-pointer object of fixed SIZE with a
 165 ;;; single word header having the specified WIDETAG value. The result is
 166 ;;; placed in RESULT-TN, Flag-Tn must be wired to NL3-OFFSET, and
 167 ;;; Temp-TN is a non- descriptor temp (which may be randomly used by
 168 ;;; the body.) The body is placed inside the PSEUDO-ATOMIC, and
 169 ;;; presumably initializes the object.
 170 (defmacro with-fixed-allocation ((result-tn temp-tn widetag size)
 171                                  &body body)
 172   `(pseudo-atomic (:extra (pad-data-block ,size))
 173      (inst bis alloc-tn other-pointer-lowtag ,result-tn)
 174      (inst li (logior (ash (1- ,size) n-widetag-bits) ,widetag) ,temp-tn)
 175      (storew ,temp-tn ,result-tn 0 other-pointer-lowtag)
 176      ,@body))
 177 \f
 178 ;;;; error code
 179
 180 (defvar *adjustable-vectors* nil)
 181
 182 (defmacro with-adjustable-vector ((var) &rest body)
 183   `(let ((,var (or (pop *adjustable-vectors*)
 184                    (make-array 16
 185                                :element-type '(unsigned-byte 8)
 186                                :fill-pointer 0
 187                                :adjustable t))))
 188      (declare (type (vector (unsigned-byte 8) 16) ,var))
 189      (setf (fill-pointer ,var) 0)
 190      (unwind-protect
 191          (progn
 192            ,@body)
 193        (push ,var *adjustable-vectors*))))
 194
 195 (eval-when (:compile-toplevel :load-toplevel :execute)
 196   (defun emit-error-break (vop kind code values)
 197     (let ((vector (gensym)))
 198       `((let ((vop ,vop))
 199           (when vop
 200             (note-this-location vop :internal-error)))
 201         (inst gentrap ,kind)
 202         (with-adjustable-vector (,vector)
 203           (write-var-integer (error-number-or-lose ',code) ,vector)
 204           ,@(mapcar (lambda (tn)
 205                       `(let ((tn ,tn))
 206                          (write-var-integer (make-sc-offset (sc-number
 207                                                              (tn-sc tn))
 208                                                             (tn-offset tn))
 209                                             ,vector)))
 210                     values)
 211           (inst byte (length ,vector))
 212           (dotimes (i (length ,vector))
 213             (inst byte (aref ,vector i))))
 214         (align word-shift)))))
 215
 216 (defmacro error-call (vop error-code &rest values)
 217   "Cause an error.  ERROR-CODE is the error to cause."
 218   (cons 'progn
 219         (emit-error-break vop error-trap error-code values)))
 220
 221
 222 (defmacro cerror-call (vop label error-code &rest values)
 223   "Cause a continuable error.  If the error is continued, execution resumes at
 224   LABEL."
 225   `(progn
 226      (inst br zero-tn ,label)
 227      ,@(emit-error-break vop cerror-trap error-code values)))
 228
 229 (defmacro generate-error-code (vop error-code &rest values)
 230   "Generate-Error-Code Error-code Value*
 231   Emit code for an error with the specified Error-Code and context Values."
 232   `(assemble (*elsewhere*)
 233      (let ((start-lab (gen-label)))
 234        (emit-label start-lab)
 235        (error-call ,vop ,error-code ,@values)
 236        start-lab)))
 237
 238 (defmacro generate-cerror-code (vop error-code &rest values)
 239   "Generate-CError-Code Error-code Value*
 240   Emit code for a continuable error with the specified Error-Code and
 241   context Values.  If the error is continued, execution resumes after
 242   the GENERATE-CERROR-CODE form."
 243   (let ((continue (gensym "CONTINUE-LABEL-"))
 244         (error (gensym "ERROR-LABEL-")))
 245     `(let ((,continue (gen-label)))
 246        (emit-label ,continue)
 247        (assemble (*elsewhere*)
 248          (let ((,error (gen-label)))
 249            (emit-label ,error)
 250            (cerror-call ,vop ,continue ,error-code ,@values)
 251            ,error)))))
 252
 253 \f
 254 ;;; a handy macro for making sequences look atomic
 255 (defmacro pseudo-atomic ((&key (extra 0)) &rest forms)
 256   `(progn
 257      (inst addq alloc-tn 1 alloc-tn)
 258      ,@forms
 259      (inst lda alloc-tn (1- ,extra) alloc-tn)
 260      (inst stl zero-tn 0 alloc-tn)))
 261 \f
 262 ;;;; memory accessor vop generators
 263
 264 (defmacro define-full-reffer (name type offset lowtag scs el-type
 265                                    &optional translate)
 266   `(progn
 267      (define-vop (,name)
 268        ,@(when translate
 269            `((:translate ,translate)))
 270        (:policy :fast-safe)
 271        (:args (object :scs (descriptor-reg))
 272               (index :scs (any-reg)))
 273        (:arg-types ,type tagged-num)
 274        (:temporary (:scs (interior-reg)) lip)
 275        (:results (value :scs ,scs))
 276        (:result-types ,el-type)
 277        (:generator 5
 278          (inst addq object index lip)
 279          (inst ldl value (- (* ,offset n-word-bytes) ,lowtag) lip)
 280          ,@(when (equal scs '(unsigned-reg))
 281              '((inst mskll value 4 value)))))
 282      (define-vop (,(symbolicate name "-C"))
 283        ,@(when translate
 284            `((:translate ,translate)))
 285        (:policy :fast-safe)
 286        (:args (object :scs (descriptor-reg)))
 287        (:info index)
 288        (:arg-types ,type
 289                    (:constant (load/store-index ,n-word-bytes ,(eval lowtag)
 290                                                 ,(eval offset))))
 291        (:results (value :scs ,scs))
 292        (:result-types ,el-type)
 293        (:generator 4
 294          (inst ldl value (- (* (+ ,offset index) n-word-bytes) ,lowtag)
 295                object)
 296          ,@(when (equal scs '(unsigned-reg))
 297              '((inst mskll value 4 value)))))))
 298
 299 (defmacro define-full-setter (name type offset lowtag scs el-type
 300                                    &optional translate #!+gengc (remember t))
 301   `(progn
 302      (define-vop (,name)
 303        ,@(when translate
 304            `((:translate ,translate)))
 305        (:policy :fast-safe)
 306        (:args (object :scs (descriptor-reg))
 307               (index :scs (any-reg))
 308               (value :scs ,scs :target result))
 309        (:arg-types ,type tagged-num ,el-type)
 310        (:temporary (:scs (interior-reg)) lip)
 311        (:results (result :scs ,scs))
 312        (:result-types ,el-type)
 313        (:generator 2
 314          (inst addq index object lip)
 315          (inst stl value (- (* ,offset n-word-bytes) ,lowtag) lip)
 316          (move value result)))
 317      (define-vop (,(symbolicate name "-C"))
 318        ,@(when translate
 319            `((:translate ,translate)))
 320        (:policy :fast-safe)
 321        (:args (object :scs (descriptor-reg))
 322               (value :scs ,scs))
 323        (:info index)
 324        (:arg-types ,type
 325                    (:constant (load/store-index ,n-word-bytes ,(eval lowtag)
 326                                                 ,(eval offset)))
 327                    ,el-type)
 328        (:results (result :scs ,scs))
 329        (:result-types ,el-type)
 330        (:generator 1
 331          (inst stl value (- (* (+ ,offset index) n-word-bytes) ,lowtag)
 332                object)
 333          (move value result)))))
 334
 335
 336 (defmacro define-partial-reffer (name type size signed offset lowtag scs
 337                                       el-type &optional translate)
 338   (let ((scale (ecase size (:byte 1) (:short 2))))
 339     `(progn
 340        (define-vop (,name)
 341          ,@(when translate
 342              `((:translate ,translate)))
 343          (:policy :fast-safe)
 344          (:args (object :scs (descriptor-reg))
 345                 (index :scs (unsigned-reg)))
 346          (:arg-types ,type positive-fixnum)
 347          (:results (value :scs ,scs))
 348          (:result-types ,el-type)
 349          (:temporary (:scs (interior-reg)) lip)
 350          (:temporary (:sc non-descriptor-reg) temp)
 351          (:temporary (:sc non-descriptor-reg) temp1)
 352          (:generator 5
 353            (inst addq object index lip)
 354            ,@(when (eq size :short)
 355                '((inst addq index lip lip)))
 356            ,@(ecase size
 357                (:byte
 358                 (if signed
 359                     `((inst ldq_u temp (- (* ,offset n-word-bytes) ,lowtag)
 360                             lip)
 361                       (inst lda temp1 (1+ (- (* ,offset n-word-bytes) ,lowtag))
 362                             lip)
 363                       (inst extqh temp temp1 temp)
 364                       (inst sra temp 56 value))
 365                     `((inst ldq_u
 366                             temp
 367                             (- (* ,offset n-word-bytes) ,lowtag)
 368                             lip)
 369                       (inst lda temp1 (- (* ,offset n-word-bytes) ,lowtag)
 370                                           lip)
 371                       (inst extbl temp temp1 value))))
 372                (:short
 373                 (if signed
 374                     `((inst ldq_u temp (- (* ,offset n-word-bytes) ,lowtag)
 375                             lip)
 376                       (inst lda temp1 (- (* ,offset n-word-bytes) ,lowtag)
 377                             lip)
 378                       (inst extwl temp temp1 temp)
 379                       (inst sll temp 48 temp)
 380                       (inst sra temp 48 value))
 381                     `((inst ldq_u temp (- (* ,offset n-word-bytes) ,lowtag)
 382                             lip)
 383                       (inst lda temp1 (- (* ,offset n-word-bytes) ,lowtag) lip)
 384                       (inst extwl temp temp1 value)))))))
 385        (define-vop (,(symbolicate name "-C"))
 386          ,@(when translate
 387              `((:translate ,translate)))
 388          (:policy :fast-safe)
 389          (:args (object :scs (descriptor-reg)))
 390          (:info index)
 391          (:arg-types ,type
 392                      (:constant (load/store-index ,scale
 393                                                   ,(eval lowtag)
 394                                                   ,(eval offset))))
 395          (:results (value :scs ,scs))
 396          (:result-types ,el-type)
 397          (:temporary (:sc non-descriptor-reg) temp)
 398          (:temporary (:sc non-descriptor-reg) temp1)
 399          (:generator 5
 400            ,@(ecase size
 401                (:byte
 402                 (if signed
 403                     `((inst ldq_u temp (- (+ (* ,offset n-word-bytes)
 404                                              (* index ,scale)) ,lowtag)
 405                             object)
 406                       (inst lda temp1 (1+ (- (+ (* ,offset n-word-bytes)
 407                                                 (* index ,scale)) ,lowtag))
 408                             object)
 409                       (inst extqh temp temp1 temp)
 410                       (inst sra temp 56 value))
 411                     `((inst ldq_u temp (- (+ (* ,offset n-word-bytes)
 412                                              (* index ,scale)) ,lowtag)
 413                             object)
 414                       (inst lda temp1 (- (+ (* ,offset n-word-bytes)
 415                                             (* index ,scale)) ,lowtag)
 416                             object)
 417                       (inst extbl temp temp1 value))))
 418                (:short
 419                 (if signed
 420                     `((inst ldq_u temp (- (+ (* ,offset n-word-bytes)
 421                                              (* index ,scale)) ,lowtag)
 422                             object)
 423                       (inst lda temp1 (- (+ (* ,offset n-word-bytes)
 424                                             (* index ,scale)) ,lowtag)
 425                             object)
 426                       (inst extwl temp temp1 temp)
 427                       (inst sll temp 48 temp)
 428                       (inst sra temp 48 value))
 429                     `((inst ldq_u temp (- (+ (* ,offset n-word-bytes)
 430                                              (* index ,scale)) ,lowtag)
 431                             object)
 432                       (inst lda temp1 (- (+ (* ,offset n-word-bytes)
 433                                             (* index ,scale)) ,lowtag)
 434                             object)
 435                       (inst extwl temp temp1 value))))))))))
 436
 437 (defmacro define-partial-setter (name type size offset lowtag scs el-type
 438                                       &optional translate)
 439   (let ((scale (ecase size (:byte 1) (:short 2))))
 440     `(progn
 441        (define-vop (,name)
 442          ,@(when translate
 443              `((:translate ,translate)))
 444          (:policy :fast-safe)
 445          (:args (object :scs (descriptor-reg))
 446                 (index :scs (unsigned-reg))
 447                 (value :scs ,scs :target result))
 448          (:arg-types ,type positive-fixnum ,el-type)
 449          (:temporary (:scs (interior-reg)) lip)
 450          (:temporary (:sc non-descriptor-reg) temp)
 451          (:temporary (:sc non-descriptor-reg) temp1)
 452          (:temporary (:sc non-descriptor-reg) temp2)
 453          (:results (result :scs ,scs))
 454          (:result-types ,el-type)
 455          (:generator 5
 456            (inst addq object index lip)
 457            ,@(when (eq size :short)
 458                '((inst addq lip index lip)))
 459            ,@(ecase size
 460                (:byte
 461                 `((inst lda temp (- (* ,offset n-word-bytes) ,lowtag) lip)
 462                   (inst ldq_u temp1 (- (* ,offset n-word-bytes) ,lowtag) lip)
 463                   (inst insbl value  temp temp2)
 464                   (inst mskbl temp1 temp temp1)
 465                   (inst bis temp1 temp2 temp1)
 466                   (inst stq_u temp1 (- (* ,offset n-word-bytes) ,lowtag) lip)))
 467                (:short
 468                 `((inst lda temp (- (* ,offset n-word-bytes) ,lowtag) lip)
 469                   (inst ldq_u temp1 (- (* ,offset n-word-bytes) ,lowtag) lip)
 470                   (inst mskwl temp1 temp temp1)
 471                   (inst inswl value temp temp2)
 472                   (inst bis temp1 temp2 temp)
 473                   (inst stq_u temp (- (* ,offset n-word-bytes) ,lowtag) lip))))
 474            (move value result)))
 475        (define-vop (,(symbolicate name "-C"))
 476          ,@(when translate
 477              `((:translate ,translate)))
 478          (:policy :fast-safe)
 479          (:args (object :scs (descriptor-reg))
 480                 (value :scs ,scs :target result))
 481          (:info index)
 482          (:arg-types ,type
 483                      (:constant (load/store-index ,scale
 484                                                   ,(eval lowtag)
 485                                                   ,(eval offset)))
 486                      ,el-type)
 487          (:temporary (:sc non-descriptor-reg) temp)
 488          (:temporary (:sc non-descriptor-reg) temp1)
 489          (:temporary (:sc non-descriptor-reg) temp2)
 490          (:results (result :scs ,scs))
 491          (:result-types ,el-type)
 492          (:generator 5
 493            ,@(ecase size
 494                (:byte
 495                 `((inst lda temp (- (* ,offset n-word-bytes)
 496                                     (* index ,scale) ,lowtag)
 497                         object)
 498                   (inst ldq_u temp1 (- (* ,offset n-word-bytes)
 499                                        (* index ,scale) ,lowtag)
 500                         object)
 501                   (inst insbl value temp temp2)
 502                   (inst mskbl temp1 temp temp1)
 503                   (inst bis temp1 temp2 temp1)
 504                   (inst stq_u temp1 (- (* ,offset n-word-bytes)
 505                                        (* index ,scale) ,lowtag) object)))
 506                (:short
 507                 `((inst lda temp (- (* ,offset n-word-bytes)
 508                                     (* index ,scale) ,lowtag)
 509                         object)
 510                   (inst ldq_u temp1 (- (* ,offset n-word-bytes)
 511                                        (* index ,scale) ,lowtag)
 512                         object)
 513                   (inst mskwl temp1 temp temp1)
 514                   (inst inswl value temp temp2)
 515                   (inst bis temp1 temp2 temp)
 516                   (inst stq_u temp (- (* ,offset n-word-bytes)
 517                                       (* index ,scale) ,lowtag) object))))
 518            (move value result))))))