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 -LOWTAG for these things, but
  15 ;;; it's a pain for people just learning to find their way around the
  16 ;;; code who want to use lexical search to figure out where things
  17 ;;; like EVEN-FIXNUM-LOWTAG are defined. Remove the :SUFFIXes and just
  18 ;;; expand out the full names. Or even define them in DEF
  19 ;;; EVEN-FIXNUM-LOWTAG style so searches like
  20 ;;; 'def.*even-fixnum-lowtag' can find them.
  21
  22 ;;; Tags for the main low-level types are stored in the low n (usually three)
  23 ;;; bits to identify the type of a machine word.  Certain constraints
  24 ;;; apply:
  25 ;;;   * EVEN-FIXNUM-LOWTAG and ODD-FIXNUM-LOWTAG must be 0 and 4: code
  26 ;;;     which shifts left two places to convert raw integers to tagged
  27 ;;;     fixnums is ubiquitous.
  28 ;;;   * LIST-POINTER-LOWTAG + N-WORD-BYTES = OTHER-POINTER-LOWTAG: NIL
  29 ;;;     is both a cons and a symbol (at the same address) and depends on this.
  30 ;;;     See the definition of SYMBOL in objdef.lisp
  31 ;;;   * OTHER-POINTER-LOWTAG > 4: Some code in the SPARC backend,
  32 ;;;     which uses bit 2 of the ALLOC register to indicate that
  33 ;;;     PSEUDO-ATOMIC is on, doesn't strip the low bits of reg_ALLOC
  34 ;;;     before ORing in OTHER-POINTER-LOWTAG within a PSEUDO-ATOMIC
  35 ;;;     section.
  36 ;;;   * OTHER-IMMEDIATE-0-LOWTAG are spaced 4 apart: various code wants to
  37 ;;;     iterate through these
  38 ;;; (These are just the ones we know about as of sbcl-0.7.1.22. There
  39 ;;; might easily be more, since these values have stayed highly
  40 ;;; constrained for more than a decade, an inviting target for
  41 ;;; inventive abstraction-phobic maintainers.:-)
  42 (eval-when (:compile-toplevel :load-toplevel :execute)
  43   ;; The EVAL-WHEN is necessary (at least for Lispworks), because the
  44   ;; second DEFENUM uses the value of OTHER-IMMEDIATE-0-LOWTAG, which is
  45   ;; defined in the first DEFENUM. -- AL 20000216
  46   #!+x86-64
  47   (defenum (:suffix -lowtag)
  48     even-fixnum
  49     instance-pointer
  50     other-immediate-0
  51     pad0 pad1 pad2
  52     other-immediate-1
  53     list-pointer
  54     odd-fixnum
  55     fun-pointer
  56     other-immediate-2
  57     pad3 pad4 pad5
  58     other-immediate-3
  59     other-pointer)
  60   #!-x86-64
  61   (defenum (:suffix -lowtag)
  62     even-fixnum
  63     instance-pointer
  64     other-immediate-0
  65     list-pointer
  66     odd-fixnum
  67     fun-pointer
  68     other-immediate-1
  69     other-pointer))
  70
  71 (def!constant nil-value
  72     (+ static-space-start n-word-bytes other-pointer-lowtag))
  73
  74 ;;; the heap types, stored in 8 bits of the header of an object on the
  75 ;;; heap, to identify the type of the heap object (which'll be at
  76 ;;; least two machine words, often more)
  77 ;;;
  78 ;;; Note: the order specified here is not critical for correctness,
  79 ;;; but (FIXME) with %TEST-HEADERS as currently defined, BIGNUM must
  80 ;;; be first, and COMPLEX-ARRAY must be last.
  81 ;;;
  82 ;;; However, for efficiency, we prefer contiguous sets of widetags for
  83 ;;; "similar" objects, so that type checking can be done with a range
  84 ;;; check, rather than several individual checks.
  85 ;;;
  86 ;;; * BIGNUM + RATIO (+ FIXNUM) = RATIONAL
  87 ;;;
  88 ;;; * SINGLE-FLOAT + DOUBLE-FLOAT + LONG-FLOAT = FLOAT
  89 ;;;
  90 ;;; * RATIONAL + FLOAT = REAL
  91 ;;;
  92 ;;; * (FIXME: COMPLEX example, which needs fixing anyway -- see
  93 ;;;   UPGRADED-COMPLEX-PART-TYPE)
  94 ;;;
  95 ;;; * SIMPLE-ARRAY-* = (SIMPLE-ARRAY * (*))
  96 ;;;
  97 ;;; * SIMPLE-ARRAY-NIL + SIMPLE-BASE-STRING = SIMPLE-STRING
  98 ;;;
  99 ;;; * SIMPLE-ARRAY + COMPLEX-ARRAYOID = (SATISFIES ARRAY-HEADER-P)
 100 ;;;
 101 ;;; In addition, with
 102 ;;; sufficient care we can cause extra combinations to appear with
 103 ;;; differences in only one bit, permitting a more efficient type
 104 ;;; test.  As an example, if SIMPLE-BASE-STRING = 0xA6 and
 105 ;;; COMPLEX-BASE-STRING = 0xE6, then the type test for BASE-STRING is
 106 ;;;
 107 ;;;   AND   tag, ~0x40, tag
 108 ;;;   ANDcc tag,  0xA6, tag
 109 ;;;   JNE   tag, label
 110 ;;;
 111 ;;; rather than two separate tests and jumps
 112 (defenum (:suffix -widetag
 113           :start (+ (ash 1 n-lowtag-bits) other-immediate-0-lowtag)
 114           :step 4)
 115   bignum                            ; 00001010
 116   ratio                             ; 00001110
 117   single-float                      ; 00010010
 118   double-float                      ; 00010110
 119   complex                           ; 00011010
 120   complex-single-float              ; 00011110
 121   complex-double-float              ; 00100010
 122
 123   code-header                       ; 00100110
 124
 125   simple-fun-header                 ; 00101010
 126   closure-header                    ; 00101110
 127   funcallable-instance-header       ; 00110010
 128
 129   return-pc-header                  ; 00110110
 130   value-cell-header                 ; 00111010
 131   symbol-header                     ; 00111110
 132   base-char                         ; 01000010
 133   sap                               ; 01000110
 134   unbound-marker                    ; 01001010
 135   weak-pointer                      ; 01001110
 136   instance-header                   ; 01010010
 137   fdefn                             ; 01010110
 138
 139   unused00                          ; 01011010
 140   unused01                          ; 01011110
 141   unused02                          ; 01100010
 142   unused03                          ; 01100110
 143   unused04                          ; 01101010
 144   unused05                          ; 01101110
 145   unused06                          ; 01110010
 146   unused07                          ; 01110110
 147   unused08                          ; 01111010
 148   unused09                          ; 01111110
 149
 150   unused10                          ; 10000010
 151   unused11                          ; 10000110
 152
 153   simple-array-unsigned-byte-2      ; 10001010
 154   simple-array-unsigned-byte-4      ; 10001110
 155   simple-array-unsigned-byte-7      ; 10010010
 156   simple-array-unsigned-byte-8      ; 10010110
 157   simple-array-unsigned-byte-15     ; 10011010
 158   simple-array-unsigned-byte-16     ; 10011110
 159   simple-array-nil                  ; 10100010
 160   simple-base-string                ; 10100110
 161   simple-bit-vector                 ; 10101010
 162   simple-vector                     ; 10101110
 163   simple-array-unsigned-byte-29     ; 10110010
 164   simple-array-unsigned-byte-31     ; 10110110
 165   simple-array-unsigned-byte-32     ; 10111010
 166   simple-array-signed-byte-8        ; 10111110
 167   simple-array-signed-byte-16       ; 11000010
 168   simple-array-signed-byte-30       ; 11000110
 169   simple-array-signed-byte-32       ; 11001010
 170   simple-array-single-float         ; 11001110
 171   simple-array-double-float         ; 11010010
 172   simple-array-complex-single-float ; 11010110
 173   simple-array-complex-double-float ; 11011010
 174   simple-array                      ; 11011110
 175   complex-vector-nil                ; 11100010
 176   complex-base-string               ; 11100110
 177   complex-bit-vector                ; 11101010
 178   complex-vector                    ; 11101110
 179   complex-array                     ; 11110010
 180
 181   unused12                          ; 11110110
 182   unused13                          ; 11111010
 183   unused14                          ; 11111110
 184 )
 185
 186 ;;; the different vector subtypes
 187 (defenum (:prefix vector- :suffix -subtype)
 188   normal
 189   unused
 190   valid-hashing
 191   must-rehash)