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
  14 ;;;; KLUDGE: The primitive objects here may look like self-contained
  15 ;;;; definitions, but in general they're not. In particular, if you
  16 ;;;; try to add a slot to them, beware of the following:
  17 ;;;;   * The GC scavenging code (and for all I know other GC code too)
  18 ;;;;     is not automatically generated from these layouts, but instead
  19 ;;;;     was hand-written to correspond to them. The offsets are
  20 ;;;;     automatically propagated into the GC scavenging code, but the
  21 ;;;;     existence of slots, and whether they should be scavenged, is
  22 ;;;;     not automatically propagated. Thus e.g. if you add a
  23 ;;;;     SIMPLE-FUN-DEBUG-INFO slot holding a tagged object which needs
  24 ;;;;     to be GCed, you need to tweak scav_code_header() and
  25 ;;;;     verify_space() in gencgc.c, and the corresponding code in gc.c.
  26 ;;;;   * The src/runtime/print.c code (used by LDB) is implemented
  27 ;;;;     using hand-written lists of slot names, which aren't automatically
  28 ;;;;     generated from the code in this file.
  29 ;;;;   * Various code (e.g. STATIC-FSET in genesis.lisp) is hard-wired
  30 ;;;;     to know the name of the last slot of the object the code works
  31 ;;;;     with, and implicitly to know that the last slot is special (being
  32 ;;;;     the beginning of an arbitrary-length sequence of bytes following
  33 ;;;;     the fixed-layout slots).
  34 ;;;; -- WHN 2001-12-29
  35 \f
  36 ;;;; the primitive objects themselves
  37
  38 (define-primitive-object (cons :lowtag list-pointer-lowtag
  39                                :alloc-trans cons)
  40   (car :ref-trans car :set-trans sb!c::%rplaca :init :arg
  41        :cas-trans %compare-and-swap-car)
  42   (cdr :ref-trans cdr :set-trans sb!c::%rplacd :init :arg
  43        :cas-trans %compare-and-swap-cdr))
  44
  45 (define-primitive-object (instance :lowtag instance-pointer-lowtag
  46                                    :widetag instance-header-widetag
  47                                    :alloc-trans %make-instance)
  48   (slots :rest-p t))
  49
  50 (define-primitive-object (bignum :lowtag other-pointer-lowtag
  51                                  :widetag bignum-widetag
  52                                  :alloc-trans sb!bignum::%allocate-bignum)
  53   (digits :rest-p t :c-type #!-alpha "long" #!+alpha "u32"))
  54
  55 (define-primitive-object (ratio :type ratio
  56                                 :lowtag other-pointer-lowtag
  57                                 :widetag ratio-widetag
  58                                 :alloc-trans %make-ratio)
  59   (numerator :type integer
  60              :ref-known (flushable movable)
  61              :ref-trans %numerator
  62              :init :arg)
  63   (denominator :type integer
  64                :ref-known (flushable movable)
  65                :ref-trans %denominator
  66                :init :arg))
  67
  68 #!+#.(cl:if (cl:= sb!vm:n-word-bits 32) '(and) '(or))
  69 (define-primitive-object (single-float :lowtag other-pointer-lowtag
  70                                        :widetag single-float-widetag)
  71   (value :c-type "float"))
  72
  73 (define-primitive-object (double-float :lowtag other-pointer-lowtag
  74                                        :widetag double-float-widetag)
  75   #!-x86-64 (filler)
  76   (value :c-type "double" :length #!-x86-64 2 #!+x86-64 1))
  77
  78 #!+long-float
  79 (define-primitive-object (long-float :lowtag other-pointer-lowtag
  80                                      :widetag long-float-widetag)
  81   #!+sparc (filler)
  82   (value :c-type "long double" :length #!+x86 3 #!+sparc 4))
  83
  84 (define-primitive-object (complex :type complex
  85                                   :lowtag other-pointer-lowtag
  86                                   :widetag complex-widetag
  87                                   :alloc-trans %make-complex)
  88   (real :type real
  89         :ref-known (flushable movable)
  90         :ref-trans %realpart
  91         :init :arg)
  92   (imag :type real
  93         :ref-known (flushable movable)
  94         :ref-trans %imagpart
  95         :init :arg))
  96
  97 (define-primitive-object (array :lowtag other-pointer-lowtag
  98                                 :widetag t)
  99   ;; FILL-POINTER of an ARRAY is in the same place as LENGTH of a
 100   ;; VECTOR -- see SHRINK-VECTOR.
 101   (fill-pointer :type index
 102                 :ref-trans %array-fill-pointer
 103                 :ref-known (flushable foldable)
 104                 :set-trans (setf %array-fill-pointer)
 105                 :set-known (unsafe))
 106   (fill-pointer-p :type (member t nil)
 107                   :ref-trans %array-fill-pointer-p
 108                   :ref-known (flushable foldable)
 109                   :set-trans (setf %array-fill-pointer-p)
 110                   :set-known (unsafe))
 111   (elements :type index
 112             :ref-trans %array-available-elements
 113             :ref-known (flushable foldable)
 114             :set-trans (setf %array-available-elements)
 115             :set-known (unsafe))
 116   (data :type array
 117         :ref-trans %array-data-vector
 118         :ref-known (flushable foldable)
 119         :set-trans (setf %array-data-vector)
 120         :set-known (unsafe))
 121   (displacement :type (or index null)
 122                 :ref-trans %array-displacement
 123                 :ref-known (flushable foldable)
 124                 :set-trans (setf %array-displacement)
 125                 :set-known (unsafe))
 126   (displaced-p :type t
 127                :ref-trans %array-displaced-p
 128                :ref-known (flushable foldable)
 129                :set-trans (setf %array-displaced-p)
 130                :set-known (unsafe))
 131   (displaced-from :type list
 132                   :ref-trans %array-displaced-from
 133                   :ref-known (flushable)
 134                   :set-trans (setf %array-displaced-from)
 135                   :set-known (unsafe))
 136   (dimensions :rest-p t))
 137
 138 (define-primitive-object (vector :type vector
 139                                  :lowtag other-pointer-lowtag
 140                                  :widetag t)
 141   ;; FILL-POINTER of an ARRAY is in the same place as LENGTH of a
 142   ;; VECTOR -- see SHRINK-VECTOR.
 143   (length :ref-trans sb!c::vector-length
 144           :type index)
 145   (data :rest-p t :c-type #!-alpha "unsigned long" #!+alpha "u32"))
 146
 147 (define-primitive-object (code :type code-component
 148                                :lowtag other-pointer-lowtag
 149                                :widetag t)
 150   (code-size :type index
 151              :ref-known (flushable movable)
 152              :ref-trans %code-code-size)
 153   (entry-points :type (or function null)
 154                 :ref-known (flushable)
 155                 :ref-trans %code-entry-points
 156                 :set-known (unsafe)
 157                 :set-trans (setf %code-entry-points))
 158   (debug-info :type t
 159               :ref-known (flushable)
 160               :ref-trans %code-debug-info
 161               :set-known (unsafe)
 162               :set-trans (setf %code-debug-info))
 163   (trace-table-offset)
 164   (constants :rest-p t))
 165
 166 (define-primitive-object (fdefn :type fdefn
 167                                 :lowtag other-pointer-lowtag
 168                                 :widetag fdefn-widetag)
 169   (name :ref-trans fdefn-name)
 170   (fun :type (or function null) :ref-trans fdefn-fun)
 171   (raw-addr :c-type #!-alpha "char *" #!+alpha "u32"))
 172
 173 ;;; a simple function (as opposed to hairier things like closures
 174 ;;; which are also subtypes of Common Lisp's FUNCTION type)
 175 (define-primitive-object (simple-fun :type function
 176                                      :lowtag fun-pointer-lowtag
 177                                      :widetag simple-fun-header-widetag)
 178   #!-(or x86 x86-64) (self :ref-trans %simple-fun-self
 179                :set-trans (setf %simple-fun-self))
 180   #!+(or x86 x86-64) (self
 181           ;; KLUDGE: There's no :SET-KNOWN, :SET-TRANS, :REF-KNOWN, or
 182           ;; :REF-TRANS here in this case. Instead, there's separate
 183           ;; DEFKNOWN/DEFINE-VOP/DEFTRANSFORM stuff in
 184           ;; compiler/x86/system.lisp to define and declare them by
 185           ;; hand. I don't know why this is, but that's (basically)
 186           ;; the way it was done in CMU CL, and it works. (It's not
 187           ;; exactly the same way it was done in CMU CL in that CMU
 188           ;; CL's allows duplicate DEFKNOWNs, blithely overwriting any
 189           ;; previous data associated with the previous DEFKNOWN, and
 190           ;; that property was used to mask the definitions here. In
 191           ;; SBCL as of 0.6.12.64 that's not allowed -- too confusing!
 192           ;; -- so we have to explicitly suppress the DEFKNOWNish
 193           ;; stuff here in order to allow this old hack to work in the
 194           ;; new world. -- WHN 2001-08-82
 195           )
 196   (next :type (or function null)
 197         :ref-known (flushable)
 198         :ref-trans %simple-fun-next
 199         :set-known (unsafe)
 200         :set-trans (setf %simple-fun-next))
 201   (name :ref-known (flushable)
 202         :ref-trans %simple-fun-name
 203         :set-known (unsafe)
 204         :set-trans (setf %simple-fun-name))
 205   (arglist :type list
 206            :ref-known (flushable)
 207            :ref-trans %simple-fun-arglist
 208            :set-known (unsafe)
 209            :set-trans (setf %simple-fun-arglist))
 210   (type :ref-known (flushable)
 211         :ref-trans %simple-fun-type
 212         :set-known (unsafe)
 213         :set-trans (setf %simple-fun-type))
 214   ;; NIL for empty, STRING for a docstring, SIMPLE-VECTOR for XREFS, and (CONS
 215   ;; STRING SIMPLE-VECTOR) for both.
 216   (info :init :null
 217         :ref-trans %simple-fun-info
 218         :ref-known (flushable)
 219         :set-trans (setf %simple-fun-info)
 220         :set-known (unsafe))
 221   ;; the SB!C::DEBUG-FUN object corresponding to this object, or NIL for none
 222   #+nil ; FIXME: doesn't work (gotcha, lowly maintenoid!) See notes on bug 137.
 223   (debug-fun :ref-known (flushable)
 224              :ref-trans %simple-fun-debug-fun
 225              :set-known (unsafe)
 226              :set-trans (setf %simple-fun-debug-fun))
 227   (code :rest-p t :c-type "unsigned char"))
 228
 229 (define-primitive-object (return-pc :lowtag other-pointer-lowtag :widetag t)
 230   (return-point :c-type "unsigned char" :rest-p t))
 231
 232 (define-primitive-object (closure :lowtag fun-pointer-lowtag
 233                                   :widetag closure-header-widetag)
 234   (fun :init :arg :ref-trans %closure-fun)
 235   (info :rest-p t))
 236
 237 (define-primitive-object (funcallable-instance
 238                           :lowtag fun-pointer-lowtag
 239                           :widetag funcallable-instance-header-widetag
 240                           :alloc-trans %make-funcallable-instance)
 241   (trampoline :init :funcallable-instance-tramp)
 242   (function :ref-known (flushable) :ref-trans %funcallable-instance-function
 243             :set-known (unsafe) :set-trans (setf %funcallable-instance-function))
 244   (info :rest-p t))
 245
 246 (define-primitive-object (value-cell :lowtag other-pointer-lowtag
 247                                      :widetag value-cell-header-widetag
 248                                      ;; FIXME: We also have an explicit VOP
 249                                      ;; for this. Is this needed as well?
 250                                      :alloc-trans make-value-cell)
 251   (value :set-trans value-cell-set
 252          :set-known (unsafe)
 253          :ref-trans value-cell-ref
 254          :ref-known (flushable)
 255          :init :arg))
 256
 257 #!+alpha
 258 (define-primitive-object (sap :lowtag other-pointer-lowtag
 259                               :widetag sap-widetag)
 260   (padding)
 261   (pointer :c-type "char *" :length 2))
 262
 263 #!-alpha
 264 (define-primitive-object (sap :lowtag other-pointer-lowtag
 265                               :widetag sap-widetag)
 266   (pointer :c-type "char *"))
 267
 268
 269 (define-primitive-object (weak-pointer :type weak-pointer
 270                                        :lowtag other-pointer-lowtag
 271                                        :widetag weak-pointer-widetag
 272                                        :alloc-trans make-weak-pointer)
 273   (value :ref-trans sb!c::%weak-pointer-value :ref-known (flushable)
 274          :init :arg)
 275   (broken :type (member t nil)
 276           :ref-trans sb!c::%weak-pointer-broken :ref-known (flushable)
 277           :init :null)
 278   (next :c-type #!-alpha "struct weak_pointer *" #!+alpha "u32"))
 279
 280 ;;;; other non-heap data blocks
 281
 282 (define-primitive-object (binding)
 283   value
 284   symbol)
 285
 286 (define-primitive-object (unwind-block)
 287   (current-uwp :c-type #!-alpha "struct unwind_block *" #!+alpha "u32")
 288   (current-cont :c-type #!-alpha "lispobj *" #!+alpha "u32")
 289   #!-(or x86 x86-64) current-code
 290   entry-pc
 291   #!+win32 next-seh-frame
 292   #!+win32 seh-frame-handler)
 293
 294 (define-primitive-object (catch-block)
 295   (current-uwp :c-type #!-alpha "struct unwind_block *" #!+alpha "u32")
 296   (current-cont :c-type #!-alpha "lispobj *" #!+alpha "u32")
 297   #!-(or x86 x86-64) current-code
 298   entry-pc
 299   #!+win32 next-seh-frame
 300   #!+win32 seh-frame-handler
 301   tag
 302   (previous-catch :c-type #!-alpha "struct catch_block *" #!+alpha "u32"))
 303
 304 ;;; (For an explanation of this, see the comments at the definition of
 305 ;;; KLUDGE-NONDETERMINISTIC-CATCH-BLOCK-SIZE.)
 306 (aver (= kludge-nondeterministic-catch-block-size catch-block-size))
 307 \f
 308 ;;;; symbols
 309
 310 (define-primitive-object (symbol :lowtag other-pointer-lowtag
 311                                  :widetag symbol-header-widetag
 312                                  :alloc-trans %make-symbol)
 313
 314   ;; Beware when changing this definition.  NIL-the-symbol is defined
 315   ;; using this layout, and NIL-the-end-of-list-marker is the cons
 316   ;; ( NIL . NIL ), living in the first two slots of NIL-the-symbol
 317   ;; (conses have no header).  Careful selection of lowtags ensures
 318   ;; that the same pointer can be used for both purposes:
 319   ;; OTHER-POINTER-LOWTAG is 7, LIST-POINTER-LOWTAG is 3, so if you
 320   ;; subtract 3 from (SB-KERNEL:GET-LISP-OBJ-ADDRESS 'NIL) you get the
 321   ;; first data slot, and if you subtract 7 you get a symbol header.
 322
 323   ;; also the CAR of NIL-as-end-of-list
 324   (value :init :unbound
 325          :set-trans %set-symbol-global-value
 326          :set-known (unsafe))
 327   ;; also the CDR of NIL-as-end-of-list.  Its reffer needs special
 328   ;; care for this reason, as hash values must be fixnums.
 329   (hash :set-trans %set-symbol-hash)
 330
 331   (plist :ref-trans symbol-plist
 332          :set-trans %set-symbol-plist
 333          :cas-trans %compare-and-swap-symbol-plist
 334          :type list
 335          :init :null)
 336   (name :ref-trans symbol-name :init :arg)
 337   (package :ref-trans symbol-package
 338            :set-trans %set-symbol-package
 339            :init :null)
 340   #!+sb-thread (tls-index :ref-known (flushable) :ref-trans symbol-tls-index))
 341
 342 (define-primitive-object (complex-single-float
 343                           :lowtag other-pointer-lowtag
 344                           :widetag complex-single-float-widetag)
 345   #!+x86-64
 346   (data :c-type "struct { float data[2]; } ")
 347   #!-x86-64
 348   (real :c-type "float")
 349   #!-x86-64
 350   (imag :c-type "float"))
 351
 352 (define-primitive-object (complex-double-float
 353                           :lowtag other-pointer-lowtag
 354                           :widetag complex-double-float-widetag)
 355   (filler)
 356   (real :c-type "double" :length #!-x86-64 2 #!+x86-64 1)
 357   (imag :c-type "double" :length #!-x86-64 2 #!+x86-64 1))
 358
 359 ;;; this isn't actually a lisp object at all, it's a c structure that lives
 360 ;;; in c-land.  However, we need sight of so many parts of it from Lisp that
 361 ;;; it makes sense to define it here anyway, so that the GENESIS machinery
 362 ;;; can take care of maintaining Lisp and C versions.
 363 (define-primitive-object (thread)
 364   ;; no_tls_value_marker is borrowed very briefly at thread startup to
 365   ;; pass the address of initial-function into new_thread_trampoline.
 366   ;; tls[0] = NO_TLS_VALUE_MARKER_WIDETAG because a the tls index slot
 367   ;; of a symbol is initialized to zero
 368   (no-tls-value-marker)
 369   (os-thread :c-type "os_thread_t")
 370   ;; This is the original address at which the memory was allocated,
 371   ;; which may have different alignment then what we prefer to use.
 372   ;; Kept here so that when the thread dies we can release the whole
 373   ;; memory we reserved.
 374   (os-address :c-type "void *" :length #!+alpha 2 #!-alpha 1)
 375   #!+sb-thread
 376   (os-attr :c-type "pthread_attr_t *" :length #!+alpha 2 #!-alpha 1)
 377   #!+sb-thread
 378   (state-lock :c-type "pthread_mutex_t *" :length #!+alpha 2 #!-alpha 1)
 379   #!+sb-thread
 380   (state-cond :c-type "pthread_cond_t *" :length #!+alpha 2 #!-alpha 1)
 381   (binding-stack-start :c-type "lispobj *" :length #!+alpha 2 #!-alpha 1)
 382   (binding-stack-pointer :c-type "lispobj *" :length #!+alpha 2 #!-alpha 1)
 383   (control-stack-start :c-type "lispobj *" :length #!+alpha 2 #!-alpha 1)
 384   (control-stack-end :c-type "lispobj *" :length #!+alpha 2 #!-alpha 1)
 385   (control-stack-guard-page-protected)
 386   (alien-stack-start :c-type "lispobj *" :length #!+alpha 2 #!-alpha 1)
 387   (alien-stack-pointer :c-type "lispobj *" :length #!+alpha 2 #!-alpha 1)
 388   #!+gencgc (alloc-region :c-type "struct alloc_region" :length 5)
 389   (this :c-type "struct thread *" :length #!+alpha 2 #!-alpha 1)
 390   (prev :c-type "struct thread *" :length #!+alpha 2 #!-alpha 1)
 391   (next :c-type "struct thread *" :length #!+alpha 2 #!-alpha 1)
 392   ;; starting, running, suspended, dead
 393   (state :c-type "lispobj")
 394   (tls-cookie)                          ;  on x86, the LDT index
 395   #!+(or x86 x86-64 sb-thread) (pseudo-atomic-bits)
 396   (interrupt-data :c-type "struct interrupt_data *"
 397                   :length #!+alpha 2 #!-alpha 1)
 398   (stepping)
 399   ;; For various reasons related to pseudo-atomic and interrupt
 400   ;; handling, we need to know if the machine context is in Lisp code
 401   ;; or not.  On non-threaded targets, this is a global variable in
 402   ;; the runtime, but it's clearly a per-thread value.
 403   #!+sb-thread
 404   (foreign-function-call-active :c-type "boolean")
 405   ;; Same as above for the location of the current control stack frame.
 406   #!+(and sb-thread (not (or x86 x86-64)))
 407   (control-frame-pointer :c-type "lispobj *")
 408   ;; Same as above for the location of the current control stack
 409   ;; pointer.  This is also used on threaded x86oids to allow LDB to
 410   ;; print an approximation of the CSP as needed.
 411   #!+(and sb-thread)
 412   (control-stack-pointer :c-type "lispobj *")
 413   ;; KLUDGE: On alpha, until STEPPING we have been lucky and the 32
 414   ;; bit slots came in pairs. However the C compiler will align
 415   ;; interrupt_contexts on a double word boundary. This logic should
 416   ;; be handled by DEFINE-PRIMITIVE-OBJECT.
 417   #!+alpha
 418   (padding)
 419   (interrupt-contexts :c-type "os_context_t *" :rest-p t))