;;;; files for more information.
(in-package "SB!VM")
+
+;;;; KLUDGE: The primitive objects here may look like self-contained
+;;;; definitions, but in general they're not. In particular, if you
+;;;; try to add a slot to them, beware of the following:
+;;;; * (mysterious crashes which occur after changing the length
+;;;; of SIMPLE-FUN, just adding a new slot not even doing anything
+;;;; with it, still dunno why)
+;;;; * The GC scavenging code (and for all I know other GC code too)
+;;;; is not automatically generated from these layouts, but instead
+;;;; was hand-written to correspond to them. The offsets are
+;;;; automatically propagated into the GC scavenging code, but the
+;;;; existence of slots, and whether they should be scavenged, is
+;;;; not automatically propagated. Thus e.g. if you add a
+;;;; SIMPLE-FUN-DEBUG-INFO slot holding a tagged object which needs
+;;;; to be GCed, you need to tweak scav_code_header() and
+;;;; verify_space() in gencgc.c, and the corresponding code in gc.c.
+;;;; * The src/runtime/print.c code (used by LDB) is implemented
+;;;; using hand-written lists of slot names, which aren't automatically
+;;;; generated from the code in this file.
+;;;; * Various code (e.g. STATIC-FSET in genesis.lisp) is hard-wired
+;;;; to know the name of the last slot of the object the code works
+;;;; with, and implicitly to know that the last slot is special (being
+;;;; the beginning of an arbitrary-length sequence of bytes following
+;;;; the fixed-layout slots).
+;;;; -- WHN 2001-12-29
\f
;;;; the primitive objects themselves
(cdr :ref-trans cdr :set-trans sb!c::%rplacd :init :arg))
(define-primitive-object (instance :lowtag instance-pointer-lowtag
- :header instance-header-widetag
+ :widetag instance-header-widetag
:alloc-trans %make-instance)
(slots :rest-p t))
(define-primitive-object (bignum :lowtag other-pointer-lowtag
- :header bignum-widetag
+ :widetag bignum-widetag
:alloc-trans sb!bignum::%allocate-bignum)
(digits :rest-p t :c-type #!-alpha "long" #!+alpha "u32"))
(define-primitive-object (ratio :type ratio
:lowtag other-pointer-lowtag
- :header ratio-widetag
+ :widetag ratio-widetag
:alloc-trans %make-ratio)
(numerator :type integer
:ref-known (flushable movable)
:init :arg))
(define-primitive-object (single-float :lowtag other-pointer-lowtag
- :header single-float-widetag)
+ :widetag single-float-widetag)
(value :c-type "float"))
(define-primitive-object (double-float :lowtag other-pointer-lowtag
- :header double-float-widetag)
+ :widetag double-float-widetag)
(filler)
(value :c-type "double" :length 2))
#!+long-float
(define-primitive-object (long-float :lowtag other-pointer-lowtag
- :header long-float-widetag)
+ :widetag long-float-widetag)
#!+sparc (filler)
(value :c-type "long double" :length #!+x86 3 #!+sparc 4))
(define-primitive-object (complex :type complex
:lowtag other-pointer-lowtag
- :header complex-widetag
+ :widetag complex-widetag
:alloc-trans %make-complex)
(real :type real
:ref-known (flushable movable)
:init :arg))
(define-primitive-object (array :lowtag other-pointer-lowtag
- :header t)
+ :widetag t)
+ ;; FILL-POINTER of an ARRAY is in the same place as LENGTH of a
+ ;; VECTOR -- see SHRINK-VECTOR.
(fill-pointer :type index
:ref-trans %array-fill-pointer
:ref-known (flushable foldable)
(define-primitive-object (vector :type vector
:lowtag other-pointer-lowtag
- :header t)
+ :widetag t)
+ ;; FILL-POINTER of an ARRAY is in the same place as LENGTH of a
+ ;; VECTOR -- see SHRINK-VECTOR.
(length :ref-trans sb!c::vector-length
:type index)
(data :rest-p t :c-type #!-alpha "unsigned long" #!+alpha "u32"))
(define-primitive-object (code :type code-component
:lowtag other-pointer-lowtag
- :header t)
+ :widetag t)
(code-size :type index
:ref-known (flushable movable)
:ref-trans %code-code-size)
(define-primitive-object (fdefn :type fdefn
:lowtag other-pointer-lowtag
- :header fdefn-widetag)
+ :widetag fdefn-widetag)
(name :ref-trans fdefn-name)
(fun :type (or function null) :ref-trans fdefn-fun)
(raw-addr :c-type #!-alpha "char *" #!+alpha "u32"))
;;; which are also subtypes of Common Lisp's FUNCTION type)
(define-primitive-object (simple-fun :type function
:lowtag fun-pointer-lowtag
- :header simple-fun-header-widetag)
+ :widetag simple-fun-header-widetag)
#!-x86 (self :ref-trans %simple-fun-self
:set-trans (setf %simple-fun-self))
#!+x86 (self
:ref-trans %simple-fun-name
:set-known (unsafe)
:set-trans (setf %simple-fun-name))
- (arglist :ref-known (flushable)
+ (arglist :type list
+ :ref-known (flushable)
:ref-trans %simple-fun-arglist
:set-known (unsafe)
:set-trans (setf %simple-fun-arglist))
:ref-trans %simple-fun-type
:set-known (unsafe)
:set-trans (setf %simple-fun-type))
+ ;; the SB!C::DEBUG-FUN object corresponding to this object, or NIL for none
+ #+nil ; FIXME: doesn't work (gotcha, lowly maintenoid!) See notes on bug 137.
+ (debug-fun :ref-known (flushable)
+ :ref-trans %simple-fun-debug-fun
+ :set-known (unsafe)
+ :set-trans (setf %simple-fun-debug-fun))
(code :rest-p t :c-type "unsigned char"))
-(define-primitive-object (return-pc :lowtag other-pointer-lowtag :header t)
+(define-primitive-object (return-pc :lowtag other-pointer-lowtag :widetag t)
(return-point :c-type "unsigned char" :rest-p t))
(define-primitive-object (closure :lowtag fun-pointer-lowtag
- :header closure-header-widetag)
+ :widetag closure-header-widetag)
(fun :init :arg :ref-trans %closure-fun)
(info :rest-p t))
(define-primitive-object (funcallable-instance
:lowtag fun-pointer-lowtag
- :header funcallable-instance-header-widetag
+ :widetag funcallable-instance-header-widetag
:alloc-trans %make-funcallable-instance)
#!-x86
(fun
(info :rest-p t))
(define-primitive-object (value-cell :lowtag other-pointer-lowtag
- :header value-cell-header-widetag
+ :widetag value-cell-header-widetag
:alloc-trans make-value-cell)
(value :set-trans value-cell-set
:set-known (unsafe)
#!+alpha
(define-primitive-object (sap :lowtag other-pointer-lowtag
- :header sap-widetag)
+ :widetag sap-widetag)
(padding)
(pointer :c-type "char *" :length 2))
#!-alpha
(define-primitive-object (sap :lowtag other-pointer-lowtag
- :header sap-widetag)
+ :widetag sap-widetag)
(pointer :c-type "char *"))
(define-primitive-object (weak-pointer :type weak-pointer
:lowtag other-pointer-lowtag
- :header weak-pointer-widetag
+ :widetag weak-pointer-widetag
:alloc-trans make-weak-pointer)
(value :ref-trans sb!c::%weak-pointer-value :ref-known (flushable)
:init :arg)
;;; (For an explanation of this, see the comments at the definition of
;;; KLUDGE-NONDETERMINISTIC-CATCH-BLOCK-SIZE.)
-(aver (= sb!vm::kludge-nondeterministic-catch-block-size catch-block-size))
+(aver (= kludge-nondeterministic-catch-block-size catch-block-size))
\f
;;;; symbols
#!+x86
-(defknown symbol-hash (symbol) (integer 0 #.*target-most-positive-fixnum*)
+(defknown symbol-hash (symbol) (integer 0 #.sb!xc:most-positive-fixnum)
(flushable movable))
(define-primitive-object (symbol :lowtag other-pointer-lowtag
- :header symbol-header-widetag
+ :widetag symbol-header-widetag
#!-x86 :alloc-trans #!-x86 make-symbol)
- (value :set-trans %set-symbol-value
- :init :unbound)
- #!+x86 (hash)
+
+ ;; Beware when changing this definition. NIL-the-symbol is defined
+ ;; using this layout, and NIL-the-end-of-list-marker is the cons
+ ;; ( NIL . NIL ), living in the first two slots of NIL-the-symbol
+ ;; (conses have no header). Careful selection of lowtags ensures
+ ;; that the same pointer can be used for both purposes:
+ ;; OTHER-POINTER-LOWTAG is 7, LIST-POINTER-LOWTAG is 3, so if you
+ ;; subtract 3 from (sb-kernel:get-lisp-obj-address 'NIL) you get the
+ ;; first data slot, and if you subtract 7 you get a symbol header.
+
+ (value :init :unbound) ;also the CAR of NIL-as-end-of-list
+ (hash) ;the CDR of NIL-as-end-of-list
+
(plist :ref-trans symbol-plist
:set-trans %set-symbol-plist
:init :null)
(name :ref-trans symbol-name :init :arg)
(package :ref-trans symbol-package
:set-trans %set-symbol-package
- :init :null))
+ :init :null)
+ #!+sb-thread (tls-index))
(define-primitive-object (complex-single-float
:lowtag other-pointer-lowtag
- :header complex-single-float-widetag)
+ :widetag complex-single-float-widetag)
(real :c-type "float")
(imag :c-type "float"))
(define-primitive-object (complex-double-float
:lowtag other-pointer-lowtag
- :header complex-double-float-widetag)
+ :widetag complex-double-float-widetag)
(filler)
(real :c-type "double" :length 2)
(imag :c-type "double" :length 2))
#!+long-float
(define-primitive-object (complex-long-float
:lowtag other-pointer-lowtag
- :header complex-long-float-widetag)
+ :widetag complex-long-float-widetag)
#!+sparc (filler)
(real :c-type "long double" :length #!+x86 3 #!+sparc 4)
(imag :c-type "long double" :length #!+x86 3 #!+sparc 4))
+;;; this isn't actually a lisp object at all, it's a c structure that lives
+;;; in c-land. However, we need sight of so many parts of it from Lisp that
+;;; it makes sense to define it here anyway, so that the GENESIS machinery
+;;; can take care of maintaining Lisp and C versions.
+;;; Hence the even-fixnum lowtag just so we don't get odd(sic) numbers
+;;; added to the slot offsets
+(define-primitive-object (thread :lowtag even-fixnum-lowtag)
+ ;; unbound_marker is borrowed very briefly at thread startup to
+ ;; pass the address of initial-function into new_thread_trampoline
+ (unbound-marker :init :unbound) ; tls[0] = UNBOUND_MARKER_WIDETAG
+ (pid :c-type "pid_t")
+ (binding-stack-start :c-type "lispobj *" :length #!+alpha 2 #!-alpha 1)
+ (binding-stack-pointer :c-type "lispobj *" :length #!+alpha 2 #!-alpha 1)
+ (control-stack-start :c-type "lispobj *" :length #!+alpha 2 #!-alpha 1)
+ (control-stack-end :c-type "lispobj *" :length #!+alpha 2 #!-alpha 1)
+ (alien-stack-start :c-type "lispobj *" :length #!+alpha 2 #!-alpha 1)
+ (alien-stack-pointer :c-type "lispobj *" :length #!+alpha 2 #!-alpha 1)
+ #!+gencgc (alloc-region :c-type "struct alloc_region" :length 5)
+ (tls-cookie) ; on x86, the LDT index
+ (this :c-type "struct thread *" :length #!+alpha 2 #!-alpha 1)
+ (next :c-type "struct thread *" :length #!+alpha 2 #!-alpha 1)
+ #!+x86 (pseudo-atomic-atomic)
+ #!+x86 (pseudo-atomic-interrupted)
+ (interrupt-data :c-type "struct interrupt_data *"
+ :length #!+alpha 2 #!-alpha 1)
+ (interrupt-contexts :c-type "os_context_t *" :rest-p t))