0.8.4.8
[sbcl.git] / src / compiler / generic / early-objdef.lisp
1 ;;;; type-based constants
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 ;;; FIXME: It's clever using :SUFFIX -TYPE for these things, but it's
15 ;;; a pain for people just learning to find their way around the code
16 ;;; who want to use lexical search to figure out where things like
17 ;;; EVEN-FIXNUM-LOWTAG are defined. Remove the :SUFFIXes and just expand
18 ;;; out the full names. Or even define them in DEF EVEN-FIXNUM-LOWTAG
19 ;;; style so searches like 'def.*even-fixnum-lowtag' can find them.
20
21 ;;; Tags for the main low-level types are stored in the low three
22 ;;; bits to identify the type of a machine word.  Certain constraints 
23 ;;; apply:
24 ;;;   * EVEN-FIXNUM-LOWTAG and ODD-FIXNUM-LOWTAG must be 0 and 4: code
25 ;;;     which shifts left two places to convert raw integers to tagged
26 ;;;     fixnums is ubiquitous.
27 ;;;   * LIST-POINTER-LOWTAG + 4 = OTHER-POINTER-LOWTAG: NIL is both a
28 ;;;     cons and a symbol (at the same address) and depends on this.
29 ;;;     See the definition of SYMBOL in objdef.lisp
30 ;;;   * OTHER-POINTER-LOWTAG > 4: Some code in the SPARC backend,
31 ;;;     which uses bit 2 of the ALLOC register to indicate that
32 ;;;     PSEUDO-ATOMIC is on, doesn't strip the low bits of reg_ALLOC
33 ;;;     before ORing in OTHER-POINTER-LOWTAG within a PSEUDO-ATOMIC
34 ;;;     section.
35 ;;; (These are just the ones we know about as of sbcl-0.7.1.22. There
36 ;;; might easily be more, since these values have stayed highly
37 ;;; constrained for more than a decade, an inviting target for
38 ;;; inventive abstraction-phobic maintainers.:-)
39 (eval-when (:compile-toplevel :load-toplevel :execute)
40   ;; The EVAL-WHEN is necessary (at least for Lispworks), because the
41   ;; second DEFENUM uses the value of OTHER-IMMEDIATE-0-LOWTAG, which is
42   ;; defined in the first DEFENUM. -- AL 20000216
43   (defenum (:suffix -lowtag)
44     even-fixnum
45     ;; Note: CMU CL, and SBCL < 0.pre7.39, had FUN-POINTER-LOWTAG
46     ;; here. We swapped FUN-POINTER-LOWTAG and
47     ;; INSTANCE-POINTER-LOWTAG in sbcl-0.pre7.39 in order to help with a
48     ;; low-level pun in the function call sequence on the PPC port.
49     ;; For more information, see the PPC port code. -- WHN 2001-10-03
50     instance-pointer
51     other-immediate-0
52     list-pointer
53     odd-fixnum
54     fun-pointer
55     other-immediate-1
56     other-pointer))
57
58 ;;; the heap types, stored in 8 bits of the header of an object on the
59 ;;; heap, to identify the type of the heap object (which'll be at
60 ;;; least two machine words, often more)
61 (defenum (:suffix -widetag
62           :start (+ (ash 1 n-lowtag-bits) other-immediate-0-lowtag)
63           :step (ash 1 (1- n-lowtag-bits)))
64   bignum
65   ratio
66   single-float
67   double-float
68   #!+long-float long-float
69   complex
70   complex-single-float
71   complex-double-float
72   #!+long-float complex-long-float
73
74   simple-array
75   simple-array-nil
76   simple-base-string
77   simple-bit-vector
78   simple-vector
79   simple-array-unsigned-byte-2
80   simple-array-unsigned-byte-4
81   simple-array-unsigned-byte-7
82   simple-array-unsigned-byte-8
83   simple-array-unsigned-byte-15
84   simple-array-unsigned-byte-16
85   simple-array-unsigned-byte-29
86   simple-array-unsigned-byte-31
87   simple-array-unsigned-byte-32
88   simple-array-signed-byte-8
89   simple-array-signed-byte-16
90   simple-array-signed-byte-30
91   simple-array-signed-byte-32
92   simple-array-single-float
93   simple-array-double-float
94   #!+long-float simple-array-long-float
95   simple-array-complex-single-float
96   simple-array-complex-double-float
97   #!+long-float simple-array-complex-long-float
98   complex-base-string
99   complex-vector-nil
100   complex-bit-vector
101   complex-vector
102   complex-array
103
104   code-header
105   simple-fun-header
106   closure-header
107   funcallable-instance-header
108   closure-fun-header
109
110   return-pc-header
111   value-cell-header
112   symbol-header
113   base-char
114   sap
115   unbound-marker
116   weak-pointer
117   instance-header
118   fdefn)
119
120 ;;; the different vector subtypes
121 (defenum (:prefix vector- :suffix -subtype)
122   normal
123   unused
124   valid-hashing
125   must-rehash)