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-type
  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-type
  22                                    :header instance-header-type
  23                                    :alloc-trans %make-instance)
  24   (slots :rest-p t))
  25
  26 (define-primitive-object (bignum :lowtag other-pointer-type
  27                                  :header bignum-type
  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-type
  33                                 :header ratio-type
  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-type
  45                                        :header single-float-type)
  46   (value :c-type "float"))
  47
  48 (define-primitive-object (double-float :lowtag other-pointer-type
  49                                        :header double-float-type)
  50   (filler)
  51   (value :c-type "double" :length 2))
  52
  53 #!+long-float
  54 (define-primitive-object (long-float :lowtag other-pointer-type
  55                                      :header long-float-type)
  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-type
  61                                   :header complex-type
  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-type
  73                                 :header 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-type
 108                                  :header 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-type
 115                                :header 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-type
 134                                 :header fdefn-type)
 135   (name :ref-trans fdefn-name)
 136   (function :type (or function null) :ref-trans fdefn-function)
 137   (raw-addr :c-type #!-alpha "char *" #!+alpha "u32"))
 138
 139 (define-primitive-object (function :type function
 140                                    :lowtag function-pointer-type
 141                                    :header function-header-type)
 142   #!-gengc (self :ref-trans %function-self :set-trans (setf %function-self))
 143   #!+gengc (entry-point :c-type "char *")
 144   (next :type (or function null)
 145         :ref-known (flushable)
 146         :ref-trans %function-next
 147         :set-known (unsafe)
 148         :set-trans (setf %function-next))
 149   (name :ref-known (flushable)
 150         :ref-trans %function-name
 151         :set-known (unsafe)
 152         :set-trans (setf %function-name))
 153   (arglist :ref-known (flushable)
 154            :ref-trans %function-arglist
 155            :set-known (unsafe)
 156            :set-trans (setf %function-arglist))
 157   (type :ref-known (flushable)
 158         :ref-trans %function-type
 159         :set-known (unsafe)
 160         :set-trans (setf %function-type))
 161   (code :rest-p t :c-type "unsigned char"))
 162
 163 #!-gengc
 164 (define-primitive-object (return-pc :lowtag other-pointer-type :header t)
 165   (return-point :c-type "unsigned char" :rest-p t))
 166
 167 (define-primitive-object (closure :lowtag function-pointer-type
 168                                   :header closure-header-type)
 169   #!-gengc (function :init :arg :ref-trans %closure-function)
 170   #!+gengc (entry-point :c-type "char *")
 171   (info :rest-p t))
 172
 173 (define-primitive-object (funcallable-instance
 174                           :lowtag function-pointer-type
 175                           :header funcallable-instance-header-type
 176                           :alloc-trans %make-funcallable-instance)
 177   #!-gengc
 178   (function
 179    :ref-known (flushable) :ref-trans %funcallable-instance-function
 180    :set-known (unsafe) :set-trans (setf %funcallable-instance-function))
 181   #!+gengc (entry-point :c-type "char *")
 182   (lexenv :ref-known (flushable) :ref-trans %funcallable-instance-lexenv
 183           :set-known (unsafe) :set-trans (setf %funcallable-instance-lexenv))
 184   (layout :init :arg
 185           :ref-known (flushable) :ref-trans %funcallable-instance-layout
 186           :set-known (unsafe) :set-trans (setf %funcallable-instance-layout))
 187   (info :rest-p t))
 188
 189 (define-primitive-object (value-cell :lowtag other-pointer-type
 190                                      :header value-cell-header-type
 191                                      :alloc-trans make-value-cell)
 192   (value :set-trans value-cell-set
 193          :set-known (unsafe)
 194          :ref-trans value-cell-ref
 195          :ref-known (flushable)
 196          :init :arg))
 197
 198 #!+alpha
 199 (define-primitive-object (sap :lowtag other-pointer-type
 200                               :header sap-type)
 201   (padding)
 202   (pointer :c-type "char *" :length 2))
 203
 204 #!-alpha
 205 (define-primitive-object (sap :lowtag other-pointer-type
 206                               :header sap-type)
 207   (pointer :c-type "char *"))
 208
 209
 210 (define-primitive-object (weak-pointer :type weak-pointer
 211                                        :lowtag other-pointer-type
 212                                        :header weak-pointer-type
 213                                        :alloc-trans make-weak-pointer)
 214   (value :ref-trans sb!c::%weak-pointer-value :ref-known (flushable)
 215          :init :arg)
 216   (broken :type (member t nil)
 217           :ref-trans sb!c::%weak-pointer-broken :ref-known (flushable)
 218           :init :null)
 219   (next :c-type #!-alpha "struct weak_pointer *" #!+alpha "u32"))
 220
 221 ;;;; other non-heap data blocks
 222
 223 (define-primitive-object (binding)
 224   value
 225   symbol)
 226
 227 (define-primitive-object (unwind-block)
 228   (current-uwp :c-type #!-alpha "struct unwind_block *" #!+alpha "u32")
 229   (current-cont :c-type #!-alpha "lispobj *" #!+alpha "u32")
 230   #!-x86 current-code
 231   entry-pc)
 232
 233 (define-primitive-object (catch-block)
 234   (current-uwp :c-type #!-alpha "struct unwind_block *" #!+alpha "u32")
 235   (current-cont :c-type #!-alpha "lispobj *" #!+alpha "u32")
 236   #!-x86 current-code
 237   entry-pc
 238   tag
 239   (previous-catch :c-type #!-alpha "struct catch_block *" #!+alpha "u32")
 240   size)
 241
 242 ;;; (For an explanation of this, see the comments at the definition of
 243 ;;; KLUDGE-NONDETERMINISTIC-CATCH-BLOCK-SIZE.)
 244 (assert (= sb!vm::kludge-nondeterministic-catch-block-size catch-block-size))
 245 \f
 246 ;;;; symbols
 247
 248 #!+gengc
 249 (defknown %make-symbol (index simple-string) symbol
 250   (flushable movable))
 251
 252 #!+gengc
 253 (defknown symbol-hash (symbol) index
 254   (flushable movable))
 255
 256 #!+x86
 257 (defknown symbol-hash (symbol) (integer 0 #.*target-most-positive-fixnum*)
 258   (flushable movable))
 259
 260 (define-primitive-object (symbol :lowtag other-pointer-type
 261                                  :header symbol-header-type
 262                                  #!-x86 :alloc-trans
 263                                  #!-(or gengc x86) make-symbol
 264                                  #!+gengc %make-symbol)
 265   (value :set-trans %set-symbol-value
 266          :init :unbound)
 267   #!-(or gengc x86) unused
 268   #!+gengc (hash :init :arg)
 269   #!+x86 (hash)
 270   (plist :ref-trans symbol-plist
 271          :set-trans %set-symbol-plist
 272          :init :null)
 273   (name :ref-trans symbol-name :init :arg)
 274   (package :ref-trans symbol-package
 275            :set-trans %set-symbol-package
 276            :init :null))
 277
 278 (define-primitive-object (complex-single-float
 279                           :lowtag other-pointer-type
 280                           :header complex-single-float-type)
 281   (real :c-type "float")
 282   (imag :c-type "float"))
 283
 284 (define-primitive-object (complex-double-float
 285                           :lowtag other-pointer-type
 286                           :header complex-double-float-type)
 287   (filler)
 288   (real :c-type "double" :length 2)
 289   (imag :c-type "double" :length 2))
 290
 291 #!+long-float
 292 (define-primitive-object (complex-long-float
 293                           :lowtag other-pointer-type
 294                           :header complex-long-float-type)
 295   #!+sparc (filler)
 296   (real :c-type "long double" :length #!+x86 3 #!+sparc 4)
 297   (imag :c-type "long double" :length #!+x86 3 #!+sparc 4))
 298