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 :type cons
  39                                :lowtag list-pointer-lowtag
  40                                :alloc-trans cons)
  41   (car :ref-trans car :set-trans sb!c::%rplaca :init :arg
  42        :cas-trans %compare-and-swap-car)
  43   (cdr :ref-trans cdr :set-trans sb!c::%rplacd :init :arg
  44        :cas-trans %compare-and-swap-cdr))
  45
  46 (!define-primitive-object (instance :lowtag instance-pointer-lowtag
  47                                    :widetag instance-header-widetag
  48                                    :alloc-trans %make-instance)
  49   (slots :rest-p t))
  50
  51 (!define-primitive-object (bignum :lowtag other-pointer-lowtag
  52                                  :widetag bignum-widetag
  53                                  :alloc-trans sb!bignum::%allocate-bignum)
  54   (digits :rest-p t :c-type #!-alpha "sword_t" #!+alpha "u32"))
  55
  56 (!define-primitive-object (ratio :type ratio
  57                                 :lowtag other-pointer-lowtag
  58                                 :widetag ratio-widetag
  59                                 :alloc-trans %make-ratio)
  60   (numerator :type integer
  61              :ref-known (flushable movable)
  62              :ref-trans %numerator
  63              :init :arg)
  64   (denominator :type integer
  65                :ref-known (flushable movable)
  66                :ref-trans %denominator
  67                :init :arg))
  68
  69 #!-64-bit
  70 (!define-primitive-object (single-float :lowtag other-pointer-lowtag
  71                                        :widetag single-float-widetag)
  72   (value :c-type "float"))
  73
  74 (!define-primitive-object (double-float :lowtag other-pointer-lowtag
  75                                        :widetag double-float-widetag)
  76   #!-64-bit (filler)
  77   (value :c-type "double" :length #.(/ 64 n-word-bits)))
  78
  79 #!+long-float
  80 (!define-primitive-object (long-float :lowtag other-pointer-lowtag
  81                                      :widetag long-float-widetag)
  82   #!+sparc (filler)
  83   (value :c-type "long double" :length #!+x86 3 #!+sparc 4))
  84
  85 (!define-primitive-object (complex :type complex
  86                                   :lowtag other-pointer-lowtag
  87                                   :widetag complex-widetag
  88                                   :alloc-trans %make-complex)
  89   (real :type real
  90         :ref-known (flushable movable)
  91         :ref-trans %realpart
  92         :init :arg)
  93   (imag :type real
  94         :ref-known (flushable movable)
  95         :ref-trans %imagpart
  96         :init :arg))
  97
  98 (!define-primitive-object (array :lowtag other-pointer-lowtag
  99                                 :widetag t)
 100   ;; FILL-POINTER of an ARRAY is in the same place as LENGTH of a
 101   ;; VECTOR -- see SHRINK-VECTOR.
 102   (fill-pointer :type index
 103                 :ref-trans %array-fill-pointer
 104                 :ref-known (flushable foldable)
 105                 :set-trans (setf %array-fill-pointer)
 106                 :set-known ())
 107   (fill-pointer-p :type (member t nil)
 108                   :ref-trans %array-fill-pointer-p
 109                   :ref-known (flushable foldable)
 110                   :set-trans (setf %array-fill-pointer-p)
 111                   :set-known ())
 112   (elements :type index
 113             :ref-trans %array-available-elements
 114             :ref-known (flushable foldable)
 115             :set-trans (setf %array-available-elements)
 116             :set-known ())
 117   (data :type array
 118         ;; FIXME: terrible name for the accessor.
 119         ;; It is in general just an ARRAY,
 120         ;; and should be named %ARRAY-DATA.
 121         :ref-trans %array-data-vector
 122         :ref-known (flushable foldable)
 123         :set-trans (setf %array-data-vector)
 124         :set-known ())
 125   (displacement :type (or index null)
 126                 :ref-trans %array-displacement
 127                 :ref-known (flushable foldable)
 128                 :set-trans (setf %array-displacement)
 129                 :set-known ())
 130   (displaced-p :type t
 131                :ref-trans %array-displaced-p
 132                :ref-known (flushable foldable)
 133                :set-trans (setf %array-displaced-p)
 134                :set-known ())
 135   (displaced-from :type list
 136                   :ref-trans %array-displaced-from
 137                   :ref-known (flushable)
 138                   :set-trans (setf %array-displaced-from)
 139                   :set-known ())
 140   (dimensions :rest-p t))
 141
 142 (!define-primitive-object (vector :type vector
 143                                  :lowtag other-pointer-lowtag
 144                                  :widetag t)
 145   ;; FILL-POINTER of an ARRAY is in the same place as LENGTH of a
 146   ;; VECTOR -- see SHRINK-VECTOR.
 147   (length :ref-trans sb!c::vector-length
 148           :type index)
 149   (data :rest-p t :c-type #!-alpha "uword_t" #!+alpha "u32"))
 150
 151 ;;; The header contains the size of slots and constants in words.
 152 (!define-primitive-object (code :type code-component
 153                                :lowtag other-pointer-lowtag
 154                                :widetag t)
 155   ;; This is the size of instructions in bytes, not aligned.
 156   ;; Adding the size from the header and aligned code-size will yield
 157   ;; the total size of the code-object.
 158   (code-size :type index
 159              :ref-known (flushable movable)
 160              :ref-trans %code-code-size)
 161   (debug-info :type t
 162               :ref-known (flushable)
 163               :ref-trans %code-debug-info
 164               :set-known ()
 165               :set-trans (setf %code-debug-info))
 166   #!-64-bit
 167   (n-entries :type fixnum
 168              :set-known ()
 169              :set-trans (setf %code-n-entries)
 170              :ref-trans %code-n-entries
 171              :ref-known (flushable foldable))
 172   #!+x86
 173   (fixups :type t
 174           :ref-known (flushable)
 175           :ref-trans %code-fixups
 176           :set-known ()
 177           :set-trans (setf %code-fixups))
 178   (constants :rest-p t))
 179
 180 (!define-primitive-object (fdefn :type fdefn
 181                                 :lowtag other-pointer-lowtag
 182                                 :widetag fdefn-widetag)
 183   (name :ref-trans fdefn-name
 184         :set-trans %set-fdefn-name :set-known ())
 185   (fun :type (or function null) :ref-trans fdefn-fun)
 186   (raw-addr :c-type #!-alpha "char *" #!+alpha "u32"))
 187
 188 ;;; a simple function (as opposed to hairier things like closures
 189 ;;; which are also subtypes of Common Lisp's FUNCTION type)
 190 (!define-primitive-object (simple-fun :type function
 191                                      :lowtag fun-pointer-lowtag
 192                                      :widetag simple-fun-header-widetag)
 193   #!-(or x86 x86-64) (self :ref-trans %simple-fun-self
 194                :set-trans (setf %simple-fun-self))
 195   ;; FIXME: we don't currently detect/prevent at compile-time the bad
 196   ;; scenario this comment claims to disallow, as determined by re-enabling
 197   ;; these SET- and REF- specifiers, which led to a cold-init crash.
 198   #!+(or x86 x86-64) (self
 199           ;; KLUDGE: There's no :SET-KNOWN, :SET-TRANS, :REF-KNOWN, or
 200           ;; :REF-TRANS here in this case. Instead, there's separate
 201           ;; DEFKNOWN/DEFINE-VOP/DEFTRANSFORM stuff in
 202           ;; compiler/x86/system.lisp to define and declare them by
 203           ;; hand. I don't know why this is, but that's (basically)
 204           ;; the way it was done in CMU CL, and it works. (It's not
 205           ;; exactly the same way it was done in CMU CL in that CMU
 206           ;; CL's allows duplicate DEFKNOWNs, blithely overwriting any
 207           ;; previous data associated with the previous DEFKNOWN, and
 208           ;; that property was used to mask the definitions here. In
 209           ;; SBCL as of 0.6.12.64 that's not allowed -- too confusing!
 210           ;; -- so we have to explicitly suppress the DEFKNOWNish
 211           ;; stuff here in order to allow this old hack to work in the
 212           ;; new world. -- WHN 2001-08-82
 213           )
 214   (name :ref-known (flushable)
 215         :ref-trans %simple-fun-name
 216         :set-known ()
 217         :set-trans (setf %simple-fun-name))
 218   (arglist :type list
 219            :ref-known (flushable)
 220            :ref-trans %simple-fun-arglist
 221            :set-known ()
 222            :set-trans (setf %simple-fun-arglist))
 223   (type :ref-known (flushable)
 224         ;; %%SIMPLE-FUN-TYPE is used only by %SIMPLE-FUN-TYPE.
 225         ;; Nobody should care that %SIMPLE-FUN-TYPE isn't open-coded.
 226         :ref-trans %%simple-fun-type
 227         :set-known ()
 228         :set-trans (setf %simple-fun-type))
 229   ;; NIL for empty, STRING for a docstring, SIMPLE-VECTOR for XREFS, and (CONS
 230   ;; STRING SIMPLE-VECTOR) for both.
 231   (info :init :null
 232         :ref-trans %simple-fun-info
 233         :ref-known (flushable)
 234         :set-trans (setf %simple-fun-info)
 235         :set-known ())
 236   ;; the SB!C::DEBUG-FUN object corresponding to this object, or NIL for none
 237   #+nil ; FIXME: doesn't work (gotcha, lowly maintenoid!) See notes on bug 137.
 238   (debug-fun :ref-known (flushable)
 239              :ref-trans %simple-fun-debug-fun
 240              :set-known ()
 241              :set-trans (setf %simple-fun-debug-fun))
 242   (code :rest-p t :c-type "unsigned char"))
 243
 244 #!-(or x86 x86-64)
 245 (!define-primitive-object (return-pc :lowtag other-pointer-lowtag :widetag t)
 246   (return-point :c-type "unsigned char" :rest-p t))
 247
 248 (!define-primitive-object (closure :lowtag fun-pointer-lowtag
 249                                   :widetag closure-header-widetag)
 250   ;; %CLOSURE-FUN should never be invoked on x86[-64].
 251   ;; The above remark at %SIMPLE-FUN-SELF is relevant in its sentiment,
 252   ;; but actually no longer true - the confusing situation is not caught
 253   ;; until too late. But at least this one was nonfatal.
 254   #!-(or x86 x86-64) (fun :init :arg :ref-trans %closure-fun)
 255   #!+(or x86 x86-64) (fun :init :arg)
 256   (info :rest-p t))
 257
 258 (!define-primitive-object (funcallable-instance
 259                           :lowtag fun-pointer-lowtag
 260                           :widetag funcallable-instance-header-widetag
 261                           :alloc-trans %make-funcallable-instance)
 262   (trampoline :init :funcallable-instance-tramp)
 263   ;; TODO: if we can switch places of 'function' and 'fsc-instance-slots'
 264   ;; (at least for the builds with compact-instance-header)
 265   ;; then for both funcallable and non-funcallable instances,
 266   ;; the CLOS slot vector will be in the word 5 bytes past the tagged pointer.
 267   ;; This shouldn't be too hard to arrange, since nothing needs to know where
 268   ;; the tagged function lives except the funcallable instance trampoline.
 269   (function :ref-known (flushable) :ref-trans %funcallable-instance-function
 270             :set-known () :set-trans (setf %funcallable-instance-function))
 271   (info :rest-p t))
 272
 273 (!define-primitive-object (value-cell :lowtag other-pointer-lowtag
 274                                      :widetag value-cell-header-widetag
 275                                      ;; FIXME: We also have an explicit VOP
 276                                      ;; for this. Is this needed as well?
 277                                      :alloc-trans make-value-cell)
 278   (value :set-trans value-cell-set
 279          :set-known ()
 280          :ref-trans value-cell-ref
 281          :ref-known (flushable)
 282          :init :arg))
 283
 284 (!define-primitive-object (sap :lowtag other-pointer-lowtag
 285                               :widetag sap-widetag)
 286   (pointer :c-type "char *" :pointer t))
 287
 288
 289 (!define-primitive-object (weak-pointer :type weak-pointer
 290                                        :lowtag other-pointer-lowtag
 291                                        :widetag weak-pointer-widetag
 292                                        :alloc-trans make-weak-pointer)
 293   ;; FIXME: SB!C should be almost *anything* but that. Probably SB!KERNEL
 294   (value :ref-trans sb!c::%weak-pointer-value :ref-known (flushable)
 295          :init :arg)
 296   (broken :type (member t nil)
 297           :ref-trans sb!c::%weak-pointer-broken :ref-known (flushable)
 298           :init :null)
 299   (next :c-type #!-alpha "struct weak_pointer *" #!+alpha "u32"))
 300
 301 ;;;; other non-heap data blocks
 302
 303 (!define-primitive-object (binding)
 304   value
 305   symbol) ;; on sb-thread, this is actually a tls-index
 306
 307 (!define-primitive-object (unwind-block)
 308   (uwp :c-type #!-alpha "struct unwind_block *" #!+alpha "u32")
 309   (cfp :c-type #!-alpha "lispobj *" #!+alpha "u32")
 310   #!-(or x86 x86-64) code
 311   entry-pc
 312   #!+win32 next-seh-frame
 313   #!+win32 seh-frame-handler)
 314
 315 (!define-primitive-object (catch-block)
 316   (uwp :c-type #!-alpha "struct unwind_block *" #!+alpha "u32")
 317   (cfp :c-type #!-alpha "lispobj *" #!+alpha "u32")
 318   #!-(or x86 x86-64) code
 319   entry-pc
 320   #!+(and win32 x86) next-seh-frame
 321   #!+(and win32 x86) seh-frame-handler
 322   tag
 323   (previous-catch :c-type #!-alpha "struct catch_block *" #!+alpha "u32"))
 324 \f
 325 ;;;; symbols
 326
 327 (!define-primitive-object (symbol :lowtag other-pointer-lowtag
 328                                  :widetag symbol-header-widetag
 329                                  :alloc-trans %%make-symbol
 330                                  :type symbol)
 331
 332   ;; Beware when changing this definition.  NIL-the-symbol is defined
 333   ;; using this layout, and NIL-the-end-of-list-marker is the cons
 334   ;; ( NIL . NIL ), living in the first two slots of NIL-the-symbol
 335   ;; (conses have no header).  Careful selection of lowtags ensures
 336   ;; that the same pointer can be used for both purposes:
 337   ;; OTHER-POINTER-LOWTAG is 7, LIST-POINTER-LOWTAG is 3, so if you
 338   ;; subtract 3 from (SB-KERNEL:GET-LISP-OBJ-ADDRESS 'NIL) you get the
 339   ;; first data slot, and if you subtract 7 you get a symbol header.
 340
 341   ;; also the CAR of NIL-as-end-of-list
 342   (value :init :unbound
 343          :set-trans %set-symbol-global-value
 344          :set-known ())
 345   ;; also the CDR of NIL-as-end-of-list.  Its reffer needs special
 346   ;; care for this reason, as hash values must be fixnums.
 347   (hash :set-trans %set-symbol-hash)
 348
 349   (info :ref-trans symbol-info :ref-known (flushable)
 350         :set-trans (setf symbol-info)
 351         :set-known ()
 352         :cas-trans %compare-and-swap-symbol-info
 353         :type (or simple-vector list)
 354         :init :null)
 355   (name :ref-trans symbol-name :init :arg)
 356   (package :ref-trans symbol-package
 357            :set-trans %set-symbol-package
 358            :init :null)
 359   ;; 0 tls-index means no tls-index is allocated
 360   ;; 64-bit put the tls-index in the header word.
 361   #!+(and sb-thread (not 64-bit))
 362   (tls-index :ref-known (flushable) :ref-trans symbol-tls-index))
 363
 364 (!define-primitive-object (complex-single-float
 365                           :lowtag other-pointer-lowtag
 366                           :widetag complex-single-float-widetag)
 367   #!+64-bit
 368   (data :c-type "struct { float data[2]; } ")
 369   #!-64-bit
 370   (real :c-type "float")
 371   #!-64-bit
 372   (imag :c-type "float"))
 373
 374 (!define-primitive-object (complex-double-float
 375                           :lowtag other-pointer-lowtag
 376                           :widetag complex-double-float-widetag)
 377   (filler)
 378   (real :c-type "double" :length #.(/ 64 n-word-bits))
 379   (imag :c-type "double" :length #.(/ 64 n-word-bits)))
 380
 381 #!+sb-simd-pack
 382 (!define-primitive-object (simd-pack
 383                           :lowtag other-pointer-lowtag
 384                           :widetag simd-pack-widetag)
 385   (tag :ref-trans %simd-pack-tag
 386        :attributes (movable flushable)
 387        :type fixnum)
 388   (lo-value :c-type "long" :type (unsigned-byte 64))
 389   (hi-value :c-type "long" :type (unsigned-byte 64)))
 390
 391 ;;; this isn't actually a lisp object at all, it's a c structure that lives
 392 ;;; in c-land.  However, we need sight of so many parts of it from Lisp that
 393 ;;; it makes sense to define it here anyway, so that the GENESIS machinery
 394 ;;; can take care of maintaining Lisp and C versions.
 395 (!define-primitive-object (thread)
 396   ;; no_tls_value_marker is borrowed very briefly at thread startup to
 397   ;; pass the address of initial-function into new_thread_trampoline.
 398   ;; tls[0] = NO_TLS_VALUE_MARKER_WIDETAG because a the tls index slot
 399   ;; of a symbol is initialized to zero
 400   (no-tls-value-marker)
 401   (os-thread :c-type "os_thread_t")
 402   ;; This is the original address at which the memory was allocated,
 403   ;; which may have different alignment then what we prefer to use.
 404   ;; Kept here so that when the thread dies we can release the whole
 405   ;; memory we reserved.
 406   (os-address :c-type "void *" :pointer t)
 407
 408   ;; Keep these next six slots (alloc-region being figured in as 1 slot)
 409   ;; near the beginning of the structure so that x86[-64] assembly code
 410   ;; can use single-byte displacements from thread-base-tn.
 411   ;; Doing so reduces code size for allocation sequences and special variable
 412   ;; manipulations by fixing their TLS offsets to be < 2^7, the largest
 413   ;; aligned displacement fitting in a signed byte.
 414   #!+gencgc (alloc-region :c-type "struct alloc_region" :length 5)
 415   #!+sb-thread (pseudo-atomic-bits #!+(or x86 x86-64) :special #!+(or x86 x86-64) *pseudo-atomic-bits*)
 416   ;; next two not used in C, but this wires the TLS offsets to small values
 417   #!+(and x86-64 sb-thread)
 418   (current-catch-block :special *current-catch-block*)
 419   #!+(and x86-64 sb-thread)
 420   (current-unwind-protect-block :special *current-unwind-protect-block*)
 421   (alien-stack-pointer :c-type "lispobj *" :pointer t
 422                        :special *alien-stack-pointer*)
 423   (binding-stack-pointer :c-type "lispobj *" :pointer t
 424                          :special *binding-stack-pointer*)
 425   (stepping)
 426   ;; END of slots to keep near the beginning.
 427
 428   ;; These aren't accessed (much) from Lisp, so don't really care
 429   ;; if it takes a 4-byte displacement.
 430   (alien-stack-start :c-type "lispobj *" :pointer t)
 431   (binding-stack-start :c-type "lispobj *" :pointer t
 432                        :special *binding-stack-start*)
 433
 434   #!+sb-thread
 435   (os-attr :c-type "pthread_attr_t *" :pointer t)
 436   #!+(and sb-thread (not sb-safepoint))
 437   (state-sem :c-type "os_sem_t *" :pointer t)
 438   #!+(and sb-thread (not sb-safepoint))
 439   (state-not-running-sem :c-type "os_sem_t *" :pointer t)
 440   #!+(and sb-thread (not sb-safepoint))
 441   (state-not-running-waitcount :c-type "int" :length 1)
 442   #!+(and sb-thread (not sb-safepoint))
 443   (state-not-stopped-sem :c-type "os_sem_t *" :pointer t)
 444   #!+(and sb-thread (not sb-safepoint))
 445   (state-not-stopped-waitcount :c-type "int" :length 1)
 446   (control-stack-start :c-type "lispobj *" :pointer t
 447                        :special *control-stack-start*)
 448   (control-stack-end :c-type "lispobj *" :pointer t
 449                      :special *control-stack-end*)
 450   (control-stack-guard-page-protected)
 451   #!+win32 (private-events :c-type "struct private_events" :length 2)
 452   (this :c-type "struct thread *" :pointer t)
 453   (prev :c-type "struct thread *" :pointer t)
 454   (next :c-type "struct thread *" :pointer t)
 455   ;; starting, running, suspended, dead
 456   (state :c-type "lispobj")
 457
 458   #!+x86 (tls-cookie)                          ;  LDT index
 459   (interrupt-data :c-type "struct interrupt_data *"
 460                   :pointer t)
 461   ;; For various reasons related to pseudo-atomic and interrupt
 462   ;; handling, we need to know if the machine context is in Lisp code
 463   ;; or not.  On non-threaded targets, this is a global variable in
 464   ;; the runtime, but it's clearly a per-thread value.
 465   #!+sb-thread
 466   (foreign-function-call-active :c-type "boolean")
 467   ;; Same as above for the location of the current control stack frame.
 468   #!+(and sb-thread (not (or x86 x86-64)))
 469   (control-frame-pointer :c-type "lispobj *")
 470   ;; Same as above for the location of the current control stack
 471   ;; pointer.  This is also used on threaded x86oids to allow LDB to
 472   ;; print an approximation of the CSP as needed.
 473   #!+sb-thread
 474   (control-stack-pointer :c-type "lispobj *")
 475   #!+mach-exception-handler
 476   (mach-port-name :c-type "mach_port_name_t")
 477   ;; Context base pointer for running on top of system libraries built using
 478   ;; -fomit-frame-pointer.  Currently truly required and implemented only
 479   ;; for (and win32 x86-64), but could be generalized to other platforms if
 480   ;; needed:
 481   #!+win32 (carried-base-pointer :c-type "os_context_register_t")
 482   #!+sb-safepoint (csp-around-foreign-call :c-type "lispobj *")
 483   #!+sb-safepoint (pc-around-foreign-call :c-type "lispobj *")
 484   #!+win32 (synchronous-io-handle-and-flag :c-type "HANDLE" :length 1)
 485   #!+(and sb-safepoint-strictly (not win32))
 486   (sprof-alloc-region :c-type "struct alloc_region" :length 5)
 487   (interrupt-contexts :c-type "os_context_t *" :rest-p t :pointer t))