src/compiler/generic/objdef.lisp

   1 ;;;; machine-independent aspects of the object representation
   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 ;;;; the primitive objects themselves
  15
  16 (define-primitive-object (cons :lowtag list-pointer-lowtag
  17                                :alloc-trans cons)
  18   (car :ref-trans car :set-trans sb!c::%rplaca :init :arg)
  19   (cdr :ref-trans cdr :set-trans sb!c::%rplacd :init :arg))
  20
  21 (define-primitive-object (instance :lowtag instance-pointer-lowtag
  22                                    :widetag instance-header-widetag
  23                                    :alloc-trans %make-instance)
  24   (slots :rest-p t))
  25
  26 (define-primitive-object (bignum :lowtag other-pointer-lowtag
  27                                  :widetag bignum-widetag
  28                                  :alloc-trans sb!bignum::%allocate-bignum)
  29   (digits :rest-p t :c-type #!-alpha "long" #!+alpha "u32"))
  30
  31 (define-primitive-object (ratio :type ratio
  32                                 :lowtag other-pointer-lowtag
  33                                 :widetag ratio-widetag
  34                                 :alloc-trans %make-ratio)
  35   (numerator :type integer
  36              :ref-known (flushable movable)
  37              :ref-trans %numerator
  38              :init :arg)
  39   (denominator :type integer
  40                :ref-known (flushable movable)
  41                :ref-trans %denominator
  42                :init :arg))
  43
  44 (define-primitive-object (single-float :lowtag other-pointer-lowtag
  45                                        :widetag single-float-widetag)
  46   (value :c-type "float"))
  47
  48 (define-primitive-object (double-float :lowtag other-pointer-lowtag
  49                                        :widetag double-float-widetag)
  50   (filler)
  51   (value :c-type "double" :length 2))
  52
  53 #!+long-float
  54 (define-primitive-object (long-float :lowtag other-pointer-lowtag
  55                                      :widetag long-float-widetag)
  56   #!+sparc (filler)
  57   (value :c-type "long double" :length #!+x86 3 #!+sparc 4))
  58
  59 (define-primitive-object (complex :type complex
  60                                   :lowtag other-pointer-lowtag
  61                                   :widetag complex-widetag
  62                                   :alloc-trans %make-complex)
  63   (real :type real
  64         :ref-known (flushable movable)
  65         :ref-trans %realpart
  66         :init :arg)
  67   (imag :type real
  68         :ref-known (flushable movable)
  69         :ref-trans %imagpart
  70         :init :arg))
  71
  72 (define-primitive-object (array :lowtag other-pointer-lowtag
  73                                 :widetag t)
  74   (fill-pointer :type index
  75                 :ref-trans %array-fill-pointer
  76                 :ref-known (flushable foldable)
  77                 :set-trans (setf %array-fill-pointer)
  78                 :set-known (unsafe))
  79   (fill-pointer-p :type (member t nil)
  80                   :ref-trans %array-fill-pointer-p
  81                   :ref-known (flushable foldable)
  82                   :set-trans (setf %array-fill-pointer-p)
  83                   :set-known (unsafe))
  84   (elements :type index
  85             :ref-trans %array-available-elements
  86             :ref-known (flushable foldable)
  87             :set-trans (setf %array-available-elements)
  88             :set-known (unsafe))
  89   (data :type array
  90         :ref-trans %array-data-vector
  91         :ref-known (flushable foldable)
  92         :set-trans (setf %array-data-vector)
  93         :set-known (unsafe))
  94   (displacement :type (or index null)
  95                 :ref-trans %array-displacement
  96                 :ref-known (flushable foldable)
  97                 :set-trans (setf %array-displacement)
  98                 :set-known (unsafe))
  99   (displaced-p :type (member t nil)
 100                :ref-trans %array-displaced-p
 101                :ref-known (flushable foldable)
 102                :set-trans (setf %array-displaced-p)
 103                :set-known (unsafe))
 104   (dimensions :rest-p t))
 105
 106 (define-primitive-object (vector :type vector
 107                                  :lowtag other-pointer-lowtag
 108                                  :widetag t)
 109   (length :ref-trans sb!c::vector-length
 110           :type index)
 111   (data :rest-p t :c-type #!-alpha "unsigned long" #!+alpha "u32"))
 112
 113 (define-primitive-object (code :type code-component
 114                                :lowtag other-pointer-lowtag
 115                                :widetag t)
 116   (code-size :type index
 117              :ref-known (flushable movable)
 118              :ref-trans %code-code-size)
 119   (entry-points :type (or function null)
 120                 :ref-known (flushable)
 121                 :ref-trans %code-entry-points
 122                 :set-known (unsafe)
 123                 :set-trans (setf %code-entry-points))
 124   (debug-info :type t
 125               :ref-known (flushable)
 126               :ref-trans %code-debug-info
 127               :set-known (unsafe)
 128               :set-trans (setf %code-debug-info))
 129   (trace-table-offset)
 130   (constants :rest-p t))
 131
 132 (define-primitive-object (fdefn :type fdefn
 133                                 :lowtag other-pointer-lowtag
 134                                 :widetag fdefn-widetag)
 135   (name :ref-trans fdefn-name)
 136   (fun :type (or function null) :ref-trans fdefn-fun)
 137   (raw-addr :c-type #!-alpha "char *" #!+alpha "u32"))
 138
 139 ;;; a simple function (as opposed to hairier things like closures
 140 ;;; which are also subtypes of Common Lisp's FUNCTION type)
 141 (define-primitive-object (simple-fun :type function
 142                                      :lowtag fun-pointer-lowtag
 143                                      :widetag simple-fun-header-widetag)
 144   #!-x86 (self :ref-trans %simple-fun-self
 145                :set-trans (setf %simple-fun-self))
 146   #!+x86 (self
 147           ;; KLUDGE: There's no :SET-KNOWN, :SET-TRANS, :REF-KNOWN, or
 148           ;; :REF-TRANS here in this case. Instead, there's separate
 149           ;; DEFKNOWN/DEFINE-VOP/DEFTRANSFORM stuff in
 150           ;; compiler/x86/system.lisp to define and declare them by
 151           ;; hand. I don't know why this is, but that's (basically)
 152           ;; the way it was done in CMU CL, and it works. (It's not
 153           ;; exactly the same way it was done in CMU CL in that CMU
 154           ;; CL's allows duplicate DEFKNOWNs, blithely overwriting any
 155           ;; previous data associated with the previous DEFKNOWN, and
 156           ;; that property was used to mask the definitions here. In
 157           ;; SBCL as of 0.6.12.64 that's not allowed -- too confusing!
 158           ;; -- so we have to explicitly suppress the DEFKNOWNish
 159           ;; stuff here in order to allow this old hack to work in the
 160           ;; new world. -- WHN 2001-08-82
 161           )
 162   (next :type (or function null)
 163         :ref-known (flushable)
 164         :ref-trans %simple-fun-next
 165         :set-known (unsafe)
 166         :set-trans (setf %simple-fun-next))
 167   (name :ref-known (flushable)
 168         :ref-trans %simple-fun-name
 169         :set-known (unsafe)
 170         :set-trans (setf %simple-fun-name))
 171   (arglist :ref-known (flushable)
 172            :ref-trans %simple-fun-arglist
 173            :set-known (unsafe)
 174            :set-trans (setf %simple-fun-arglist))
 175   (type :ref-known (flushable)
 176         :ref-trans %simple-fun-type
 177         :set-known (unsafe)
 178         :set-trans (setf %simple-fun-type))
 179   (code :rest-p t :c-type "unsigned char"))
 180
 181 (define-primitive-object (return-pc :lowtag other-pointer-lowtag :widetag t)
 182   (return-point :c-type "unsigned char" :rest-p t))
 183
 184 (define-primitive-object (closure :lowtag fun-pointer-lowtag
 185                                   :widetag closure-header-widetag)
 186   (fun :init :arg :ref-trans %closure-fun)
 187   (info :rest-p t))
 188
 189 (define-primitive-object (funcallable-instance
 190                           :lowtag fun-pointer-lowtag
 191                           :widetag funcallable-instance-header-widetag
 192                           :alloc-trans %make-funcallable-instance)
 193   #!-x86
 194   (fun
 195    :ref-known (flushable) :ref-trans %funcallable-instance-fun
 196    :set-known (unsafe) :set-trans (setf %funcallable-instance-fun))
 197   #!+x86
 198   (fun
 199    :ref-known (flushable) :ref-trans %funcallable-instance-fun
 200    ;; KLUDGE: There's no :SET-KNOWN or :SET-TRANS in this case.
 201    ;; Instead, later in compiler/x86/system.lisp there's a separate
 202    ;; DEFKNOWN for (SETF %FUNCALLABLE-INSTANCE-FUN), and a weird
 203    ;; unexplained DEFTRANSFORM from (SETF %SIMPLE-FUN-INSTANCE-FUN)
 204    ;; into (SETF %SIMPLE-FUN-SELF). The #!+X86 wrapped around this case
 205    ;; is a literal translation of the old CMU CL implementation into
 206    ;; the new world of sbcl-0.6.12.63, where multiple DEFKNOWNs for
 207    ;; the same operator cause an error (instead of silently deleting
 208    ;; all information associated with the old DEFKNOWN, as before).
 209    ;; It's definitely not very clean, with too many #!+ conditionals and
 210    ;; too little documentation, but I have more urgent things to
 211    ;; clean up right now, so I've just left it as a literal
 212    ;; translation without trying to fix it. -- WHN 2001-08-02
 213    )
 214   (lexenv :ref-known (flushable) :ref-trans %funcallable-instance-lexenv
 215           :set-known (unsafe) :set-trans (setf %funcallable-instance-lexenv))
 216   (layout :init :arg
 217           :ref-known (flushable) :ref-trans %funcallable-instance-layout
 218           :set-known (unsafe) :set-trans (setf %funcallable-instance-layout))
 219   (info :rest-p t))
 220
 221 (define-primitive-object (value-cell :lowtag other-pointer-lowtag
 222                                      :widetag value-cell-header-widetag
 223                                      :alloc-trans make-value-cell)
 224   (value :set-trans value-cell-set
 225          :set-known (unsafe)
 226          :ref-trans value-cell-ref
 227          :ref-known (flushable)
 228          :init :arg))
 229
 230 #!+alpha
 231 (define-primitive-object (sap :lowtag other-pointer-lowtag
 232                               :widetag sap-widetag)
 233   (padding)
 234   (pointer :c-type "char *" :length 2))
 235
 236 #!-alpha
 237 (define-primitive-object (sap :lowtag other-pointer-lowtag
 238                               :widetag sap-widetag)
 239   (pointer :c-type "char *"))
 240
 241
 242 (define-primitive-object (weak-pointer :type weak-pointer
 243                                        :lowtag other-pointer-lowtag
 244                                        :widetag weak-pointer-widetag
 245                                        :alloc-trans make-weak-pointer)
 246   (value :ref-trans sb!c::%weak-pointer-value :ref-known (flushable)
 247          :init :arg)
 248   (broken :type (member t nil)
 249           :ref-trans sb!c::%weak-pointer-broken :ref-known (flushable)
 250           :init :null)
 251   (next :c-type #!-alpha "struct weak_pointer *" #!+alpha "u32"))
 252
 253 ;;;; other non-heap data blocks
 254
 255 (define-primitive-object (binding)
 256   value
 257   symbol)
 258
 259 (define-primitive-object (unwind-block)
 260   (current-uwp :c-type #!-alpha "struct unwind_block *" #!+alpha "u32")
 261   (current-cont :c-type #!-alpha "lispobj *" #!+alpha "u32")
 262   #!-x86 current-code
 263   entry-pc)
 264
 265 (define-primitive-object (catch-block)
 266   (current-uwp :c-type #!-alpha "struct unwind_block *" #!+alpha "u32")
 267   (current-cont :c-type #!-alpha "lispobj *" #!+alpha "u32")
 268   #!-x86 current-code
 269   entry-pc
 270   tag
 271   (previous-catch :c-type #!-alpha "struct catch_block *" #!+alpha "u32")
 272   size)
 273
 274 ;;; (For an explanation of this, see the comments at the definition of
 275 ;;; KLUDGE-NONDETERMINISTIC-CATCH-BLOCK-SIZE.)
 276 (aver (= kludge-nondeterministic-catch-block-size catch-block-size))
 277 \f
 278 ;;;; symbols
 279
 280 #!+x86
 281 (defknown symbol-hash (symbol) (integer 0 #.*target-most-positive-fixnum*)
 282   (flushable movable))
 283
 284 (define-primitive-object (symbol :lowtag other-pointer-lowtag
 285                                  :widetag symbol-header-widetag
 286                                  #!-x86 :alloc-trans #!-x86 make-symbol)
 287   (value :set-trans %set-symbol-value
 288          :init :unbound)
 289   #!+x86 (hash)
 290   (plist :ref-trans symbol-plist
 291          :set-trans %set-symbol-plist
 292          :init :null)
 293   (name :ref-trans symbol-name :init :arg)
 294   (package :ref-trans symbol-package
 295            :set-trans %set-symbol-package
 296            :init :null))
 297
 298 (define-primitive-object (complex-single-float
 299                           :lowtag other-pointer-lowtag
 300                           :widetag complex-single-float-widetag)
 301   (real :c-type "float")
 302   (imag :c-type "float"))
 303
 304 (define-primitive-object (complex-double-float
 305                           :lowtag other-pointer-lowtag
 306                           :widetag complex-double-float-widetag)
 307   (filler)
 308   (real :c-type "double" :length 2)
 309   (imag :c-type "double" :length 2))
 310
 311 #!+long-float
 312 (define-primitive-object (complex-long-float
 313                           :lowtag other-pointer-lowtag
 314                           :widetag complex-long-float-widetag)
 315   #!+sparc (filler)
 316   (real :c-type "long double" :length #!+x86 3 #!+sparc 4)
 317   (imag :c-type "long double" :length #!+x86 3 #!+sparc 4))
 318