src/compiler/mips/vm.lisp

   1 ;;;; miscellaneous VM definition noise for MIPS
   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 \f
  15 ;;;; Registers
  16
  17 (eval-when (:compile-toplevel :load-toplevel :execute)
  18   (defvar *register-names* (make-array 32 :initial-element nil)))
  19
  20 (macrolet ((defreg (name offset)
  21                (let ((offset-sym (symbolicate name "-OFFSET")))
  22                  `(eval-when (:compile-toplevel :load-toplevel :execute)
  23                    (def!constant ,offset-sym ,offset)
  24                    (setf (svref *register-names* ,offset-sym) ,(symbol-name name)))))
  25
  26            (defregset (name &rest regs)
  27                `(eval-when (:compile-toplevel :load-toplevel :execute)
  28                  (defparameter ,name
  29                    (list ,@(mapcar #'(lambda (name) (symbolicate name "-OFFSET")) regs))))))
  30   ;; Wired zero register.
  31   (defreg zero 0) ; NULL
  32   ;; Reserved for assembler use.
  33   (defreg nl3 1) ; untagged temporary 3
  34   ;; C return registers.
  35   (defreg cfunc 2) ; FF function address, wastes a register
  36   (defreg nl4 3) ; PA flag
  37   ;; C argument registers.
  38   (defreg nl0 4) ; untagged temporary 0
  39   (defreg nl1 5) ; untagged temporary 1
  40   (defreg nl2 6) ; untagged temporary 2
  41   (defreg nargs 7) ; number of function arguments
  42   ;; C unsaved temporaries.
  43   (defreg a0 8) ; function arg 0
  44   (defreg a1 9) ; function arg 1
  45   (defreg a2 10) ; function arg 2
  46   (defreg a3 11) ; function arg 3
  47   (defreg a4 12) ; function arg 4
  48   (defreg a5 13) ; function arg 5
  49   (defreg fdefn 14) ; ?
  50   (defreg lexenv 15) ; wastes a register
  51   ;; C saved registers.
  52   (defreg nfp 16) ; non-lisp frame pointer
  53   (defreg ocfp 17) ; caller's control frame pointer
  54   (defreg lra 18) ; tagged Lisp return address
  55   (defreg l0 19) ; tagged temporary 0
  56   (defreg null 20) ; NIL
  57   (defreg bsp 21) ; binding stack pointer
  58   (defreg cfp 22) ; control frame pointer
  59   (defreg csp 23) ; control stack pointer
  60   ;; More C unsaved temporaries.
  61   (defreg l1 24) ; tagged temporary 1
  62   (defreg alloc 25) ; ALLOC pointer
  63   ;; 26 and 27 are used by the system kernel.
  64   ;; 28 is the global pointer of our C runtime.
  65   (defreg nsp 29) ; number (native) stack pointer
  66   ;; C frame pointer, or additional saved register.
  67   (defreg code 30) ; current function object
  68   ;; Return link register.
  69   (defreg lip 31) ; Lisp interior pointer
  70
  71   (defregset non-descriptor-regs
  72       nl0 nl1 nl2 nl3 nl4 cfunc nargs)
  73
  74   (defregset descriptor-regs
  75       a0 a1 a2 a3 a4 a5 fdefn lexenv nfp ocfp lra l0 l1)
  76
  77   (defregset *register-arg-offsets*
  78       a0 a1 a2 a3 a4 a5)
  79
  80   (defregset reserve-descriptor-regs
  81       fdefn lexenv)
  82
  83   (defregset reserve-non-descriptor-regs
  84       nl4 cfunc))
  85
  86 \f
  87 ;;;; SB and SC definition:
  88
  89 (define-storage-base registers :finite :size 32)
  90 (define-storage-base float-registers :finite :size 32)
  91 (define-storage-base control-stack :unbounded :size 8)
  92 (define-storage-base non-descriptor-stack :unbounded :size 0)
  93 (define-storage-base constant :non-packed)
  94 (define-storage-base immediate-constant :non-packed)
  95
  96 ;;;
  97 ;;; Handy macro so we don't have to keep changing all the numbers whenever
  98 ;;; we insert a new storage class.
  99 ;;;
 100 (defmacro !define-storage-classes (&rest classes)
 101   (do ((forms (list 'progn)
 102               (let* ((class (car classes))
 103                      (sc-name (car class))
 104                      (constant-name (intern (concatenate 'simple-string
 105                                                          (string sc-name)
 106                                                          "-SC-NUMBER"))))
 107                 (list* `(define-storage-class ,sc-name ,index
 108                           ,@(cdr class))
 109                        `(defconstant ,constant-name ,index)
 110                        `(export ',constant-name)
 111                        forms)))
 112        (index 0 (1+ index))
 113        (classes classes (cdr classes)))
 114       ((null classes)
 115        (nreverse forms))))
 116
 117 (def!constant kludge-nondeterministic-catch-block-size 7)
 118
 119 (!define-storage-classes
 120
 121   ;; Non-immediate constants in the constant pool
 122   (constant constant)
 123
 124   ;; Immediate constant.
 125   (null immediate-constant)
 126   (zero immediate-constant)
 127   (immediate immediate-constant)
 128
 129   ;; **** The stacks.
 130
 131   ;; The control stack.  (Scanned by GC)
 132   (control-stack control-stack)
 133
 134   ;; The non-descriptor stacks.
 135   (signed-stack non-descriptor-stack) ; (signed-byte 32)
 136   (unsigned-stack non-descriptor-stack) ; (unsigned-byte 32)
 137   (character-stack non-descriptor-stack) ; non-descriptor characters.
 138   (sap-stack non-descriptor-stack) ; System area pointers.
 139   (single-stack non-descriptor-stack) ; single-floats
 140   (double-stack non-descriptor-stack :element-size 2) ; double floats.
 141   ;; complex-single-floats
 142   (complex-single-stack non-descriptor-stack :element-size 2)
 143   ;; complex-double-floats.
 144   (complex-double-stack non-descriptor-stack :element-size 4 :alignment 2)
 145
 146
 147   ;; **** Things that can go in the integer registers.
 148
 149   ;; Immediate descriptor objects.  Don't have to be seen by GC, but nothing
 150   ;; bad will happen if they are.  (fixnums, characters, header values, etc).
 151   (any-reg
 152    registers
 153    :locations #.(append non-descriptor-regs descriptor-regs)
 154    :reserve-locations #.(append reserve-non-descriptor-regs
 155                                 reserve-descriptor-regs)
 156    :constant-scs (constant zero immediate)
 157    :save-p t
 158    :alternate-scs (control-stack))
 159
 160   ;; Pointer descriptor objects.  Must be seen by GC.
 161   (descriptor-reg registers
 162    :locations #.descriptor-regs
 163    :reserve-locations #.reserve-descriptor-regs
 164    :constant-scs (constant null immediate)
 165    :save-p t
 166    :alternate-scs (control-stack))
 167
 168   ;; Non-Descriptor characters
 169   (character-reg registers
 170    :locations #.non-descriptor-regs
 171    :reserve-locations #.reserve-non-descriptor-regs
 172    :constant-scs (immediate)
 173    :save-p t
 174    :alternate-scs (character-stack))
 175
 176   ;; Non-Descriptor SAP's (arbitrary pointers into address space)
 177   (sap-reg registers
 178    :locations #.non-descriptor-regs
 179    :reserve-locations #.reserve-non-descriptor-regs
 180    :constant-scs (immediate)
 181    :save-p t
 182    :alternate-scs (sap-stack))
 183
 184   ;; Non-Descriptor (signed or unsigned) numbers.
 185   (signed-reg registers
 186    :locations #.non-descriptor-regs
 187    :reserve-locations #.reserve-non-descriptor-regs
 188    :constant-scs (zero immediate)
 189    :save-p t
 190    :alternate-scs (signed-stack))
 191   (unsigned-reg registers
 192    :locations #.non-descriptor-regs
 193    :reserve-locations #.reserve-non-descriptor-regs
 194    :constant-scs (zero immediate)
 195    :save-p t
 196    :alternate-scs (unsigned-stack))
 197
 198   ;; Random objects that must not be seen by GC.  Used only as temporaries.
 199   (non-descriptor-reg registers
 200    :locations #.non-descriptor-regs)
 201
 202   ;; Pointers to the interior of objects.  Used only as an temporary.
 203   (interior-reg registers
 204    :locations (#.lip-offset))
 205
 206
 207   ;; **** Things that can go in the floating point registers.
 208
 209   ;; Non-Descriptor single-floats.
 210   (single-reg float-registers
 211    :locations (0 2 4 6 8 10 12 14 16 18 20 22 24 26 28 30)
 212    :reserve-locations (26 28 30)
 213    :constant-scs ()
 214    :save-p t
 215    :alternate-scs (single-stack))
 216
 217   ;; Non-Descriptor double-floats.
 218   (double-reg float-registers
 219    :locations (0 2 4 6 8 10 12 14 16 18 20 22 24 26 28 30)
 220    :reserve-locations (26 28 30)
 221    ;; Note: we don't bother with the element size, 'cause nothing can be
 222    ;; allocated in the odd fp regs anyway.
 223    :constant-scs ()
 224    :save-p t
 225    :alternate-scs (double-stack))
 226
 227   (complex-single-reg float-registers
 228    :locations (0 4 8 12 16 20 24 28)
 229    :element-size 4
 230    :reserve-locations (24 28)
 231    :constant-scs ()
 232    :save-p t
 233    :alternate-scs (complex-single-stack))
 234
 235   (complex-double-reg float-registers
 236    :locations (0 4 8 12 16 20 24 28)
 237    :element-size 4
 238    :reserve-locations (24 28)
 239    :constant-scs ()
 240    :save-p t
 241    :alternate-scs (complex-double-stack))
 242
 243   ;; A catch or unwind block.
 244   (catch-block control-stack :element-size kludge-nondeterministic-catch-block-size)
 245
 246   ;; floating point numbers temporarily stuck in integer registers for c-call
 247   (single-int-carg-reg registers
 248                   :locations (4 5 6 7)
 249                   :alternate-scs ()
 250                   :constant-scs ())
 251   (double-int-carg-reg registers
 252                   :locations (4 6)
 253                   :constant-scs ()
 254                   :alternate-scs ()
 255                   :alignment 2          ;is this needed?
 256                   :element-size 2))
 257
 258
 259
 260 \f
 261 ;;;; Random TNs for interesting registers
 262
 263 (macrolet ((defregtn (name sc)
 264                (let ((offset-sym (symbolicate name "-OFFSET"))
 265                      (tn-sym (symbolicate name "-TN")))
 266                  `(defparameter ,tn-sym
 267                    (make-random-tn :kind :normal
 268                     :sc (sc-or-lose ',sc)
 269                     :offset ,offset-sym)))))
 270   (defregtn zero any-reg)
 271   (defregtn nargs any-reg)
 272
 273   (defregtn fdefn descriptor-reg)
 274   (defregtn lexenv descriptor-reg)
 275
 276   (defregtn nfp any-reg)
 277   (defregtn ocfp any-reg)
 278
 279   (defregtn null descriptor-reg)
 280
 281   (defregtn bsp any-reg)
 282   (defregtn cfp any-reg)
 283   (defregtn csp any-reg)
 284   (defregtn alloc any-reg)
 285   (defregtn nsp any-reg)
 286
 287   (defregtn code descriptor-reg)
 288   (defregtn lip interior-reg))
 289 \f
 290 ;;; If VALUE can be represented as an immediate constant, then return the
 291 ;;; appropriate SC number, otherwise return NIL.
 292 (!def-vm-support-routine immediate-constant-sc (value)
 293   (typecase value
 294     ((integer 0 0)
 295      (sc-number-or-lose 'zero))
 296     (null
 297      (sc-number-or-lose 'null))
 298     (symbol
 299      (if (static-symbol-p value)
 300          (sc-number-or-lose 'immediate)
 301          nil))
 302     ((or (integer #.sb!xc:most-negative-fixnum #.sb!xc:most-positive-fixnum)
 303          system-area-pointer character)
 304      (sc-number-or-lose 'immediate))
 305     (system-area-pointer
 306      (sc-number-or-lose 'immediate))
 307     (character
 308      (sc-number-or-lose 'immediate))))
 309
 310 \f
 311 ;;;; Function Call Parameters
 312
 313 ;;; The SC numbers for register and stack arguments/return values.
 314 ;;;
 315 (defconstant register-arg-scn (meta-sc-number-or-lose 'descriptor-reg))
 316 (defconstant immediate-arg-scn (meta-sc-number-or-lose 'any-reg))
 317 (defconstant control-stack-arg-scn (meta-sc-number-or-lose 'control-stack))
 318
 319 (eval-when (:compile-toplevel :load-toplevel :execute)
 320
 321 ;;; Offsets of special stack frame locations
 322 (defconstant ocfp-save-offset 0)
 323 (defconstant lra-save-offset 1)
 324 (defconstant nfp-save-offset 2)
 325
 326 ;;; The number of arguments/return values passed in registers.
 327 ;;;
 328 (defconstant register-arg-count 6)
 329
 330 ;;; The offsets within the register-arg SC that we pass values in, first
 331 ;;; value first.
 332 ;;;
 333
 334 ;;; Names to use for the argument registers.
 335 ;;;
 336 (defconstant-eqx register-arg-names '(a0 a1 a2 a3 a4 a5) #'equal)
 337
 338 ) ; EVAL-WHEN
 339
 340
 341 ;;; A list of TN's describing the register arguments.
 342 ;;;
 343 (defparameter register-arg-tns
 344   (mapcar #'(lambda (n)
 345               (make-random-tn :kind :normal
 346                               :sc (sc-or-lose 'descriptor-reg)
 347                               :offset n))
 348           *register-arg-offsets*))
 349
 350 ;;; This is used by the debugger.
 351 (defconstant single-value-return-byte-offset 8)
 352 \f
 353 ;;; This function is called by debug output routines that want a pretty name
 354 ;;; for a TN's location.  It returns a thing that can be printed with PRINC.
 355 (!def-vm-support-routine location-print-name (tn)
 356   (declare (type tn tn))
 357   (let ((sb (sb-name (sc-sb (tn-sc tn))))
 358         (offset (tn-offset tn)))
 359     (ecase sb
 360       (registers (or (svref *register-names* offset)
 361                      (format nil "R~D" offset)))
 362       (float-registers (format nil "F~D" offset))
 363       (control-stack (format nil "CS~D" offset))
 364       (non-descriptor-stack (format nil "NS~D" offset))
 365       (constant (format nil "Const~D" offset))
 366       (immediate-constant "Immed"))))
 367
 368