src/compiler/generic/vm-fndb.lisp

   1 ;;;; signatures of machine-specific functions
   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!C")
  13 \f
  14 ;;;; internal type predicates
  15
  16 ;;; Simple TYPEP uses that don't have any standard predicate are
  17 ;;; translated into non-standard unary predicates.
  18 (defknown (fixnump bignump ratiop
  19            short-float-p single-float-p double-float-p long-float-p
  20            complex-rational-p complex-float-p complex-single-float-p
  21            complex-double-float-p #!+long-float complex-long-float-p
  22            complex-vector-p
  23            base-char-p %standard-char-p %instancep
  24            base-string-p simple-base-string-p
  25            array-header-p
  26            simple-array-p simple-array-nil-p vector-nil-p
  27            simple-array-unsigned-byte-2-p
  28            simple-array-unsigned-byte-4-p simple-array-unsigned-byte-7-p
  29            simple-array-unsigned-byte-8-p simple-array-unsigned-byte-15-p
  30            simple-array-unsigned-byte-16-p simple-array-unsigned-byte-29-p
  31            simple-array-unsigned-byte-31-p
  32            simple-array-unsigned-byte-32-p
  33            simple-array-signed-byte-8-p simple-array-signed-byte-16-p
  34            simple-array-signed-byte-30-p simple-array-signed-byte-32-p
  35            simple-array-single-float-p simple-array-double-float-p
  36            #!+long-float simple-array-long-float-p
  37            simple-array-complex-single-float-p
  38            simple-array-complex-double-float-p
  39            #!+long-float simple-array-complex-long-float-p
  40            system-area-pointer-p realp unsigned-byte-32-p signed-byte-32-p
  41            vector-t-p weak-pointer-p code-component-p lra-p
  42            funcallable-instance-p)
  43   (t) boolean (movable foldable flushable))
  44 \f
  45 ;;;; miscellaneous "sub-primitives"
  46
  47 (defknown %sp-string-compare
  48   (simple-string index index simple-string index index)
  49   (or index null)
  50   (foldable flushable))
  51
  52 (defknown %sxhash-simple-string (simple-string) index
  53   (foldable flushable))
  54
  55 (defknown %sxhash-simple-substring (simple-string index) index
  56   (foldable flushable))
  57
  58 (defknown symbol-hash (symbol) (integer 0 #.sb!xc:most-positive-fixnum)
  59   (flushable movable))
  60
  61 (defknown %set-symbol-hash (symbol (integer 0 #.sb!xc:most-positive-fixnum))
  62   t (unsafe))
  63
  64 (defknown vector-length (vector) index (flushable))
  65
  66 (defknown vector-sap ((simple-unboxed-array (*))) system-area-pointer
  67   (flushable))
  68
  69 (defknown lowtag-of (t) (unsigned-byte #.sb!vm:n-lowtag-bits)
  70   (flushable movable))
  71 (defknown widetag-of (t) (unsigned-byte #.sb!vm:n-widetag-bits)
  72   (flushable movable))
  73
  74 (defknown (get-header-data get-closure-length) (t) (unsigned-byte 24)
  75   (flushable))
  76 (defknown set-header-data (t (unsigned-byte 24)) t
  77   (unsafe))
  78
  79 (defknown %array-dimension (t index) index
  80   (flushable))
  81 (defknown %set-array-dimension (t index index) index
  82   ())
  83 (defknown %array-rank (t) index
  84   (flushable))
  85
  86 (defknown %make-instance (index) instance
  87   (unsafe))
  88 (defknown %instance-layout (instance) layout
  89   (foldable flushable))
  90 (defknown %set-instance-layout (instance layout) layout
  91   (unsafe))
  92 (defknown %instance-length (instance) index
  93   (foldable flushable))
  94 (defknown %instance-ref (instance index) t
  95   (flushable))
  96 (defknown %instance-set (instance index t) t
  97   (unsafe))
  98 (defknown %layout-invalid-error (t layout) nil)
  99
 100
 101 (sb!xc:deftype raw-vector () '(simple-array sb!vm:word (*)))
 102
 103 (defknown %raw-ref-single (raw-vector index) single-float
 104   (foldable flushable))
 105 (defknown %raw-ref-double (raw-vector index) double-float
 106   (foldable flushable))
 107 #!+long-float
 108 (defknown %raw-ref-long (raw-vector index) long-float
 109   (foldable flushable))
 110 (defknown %raw-set-single (raw-vector index single-float) single-float
 111   (unsafe))
 112 (defknown %raw-set-double (raw-vector index double-float) double-float
 113   (unsafe))
 114 #!+long-float
 115 (defknown %raw-set-long (raw-vector index long-float) long-float
 116   (unsafe))
 117
 118 (defknown %raw-ref-complex-single (raw-vector index) (complex single-float)
 119   (foldable flushable))
 120 (defknown %raw-ref-complex-double (raw-vector index) (complex double-float)
 121   (foldable flushable))
 122
 123 (defknown %raw-set-complex-single (raw-vector index (complex single-float))
 124   (complex single-float)
 125   (unsafe))
 126 (defknown %raw-set-complex-double (raw-vector index (complex double-float))
 127   (complex double-float)
 128   (unsafe))
 129
 130
 131 (defknown %raw-bits (t fixnum) sb!vm:word
 132   (foldable flushable))
 133 (defknown (%set-raw-bits) (t fixnum sb!vm:word) sb!vm:word
 134   (unsafe))
 135
 136
 137 (defknown allocate-vector ((unsigned-byte 8) index index) (simple-array * (*))
 138   (flushable movable))
 139
 140 (defknown make-array-header ((unsigned-byte 8) (unsigned-byte 24)) array
 141   (flushable movable))
 142
 143
 144 (defknown make-weak-pointer (t) weak-pointer
 145   (flushable))
 146
 147 (defknown %make-complex (real real) complex
 148   (flushable movable))
 149 (defknown %make-ratio (rational rational) ratio
 150   (flushable movable))
 151 (defknown make-value-cell (t) t
 152   (flushable movable))
 153
 154 (defknown (dynamic-space-free-pointer binding-stack-pointer-sap
 155                                       control-stack-pointer-sap)  ()
 156   system-area-pointer
 157   (flushable))
 158 \f
 159 ;;;; debugger support
 160
 161 (defknown current-sp () system-area-pointer (movable flushable))
 162 (defknown current-fp () system-area-pointer (movable flushable))
 163 (defknown stack-ref (system-area-pointer index) t (flushable))
 164 (defknown %set-stack-ref (system-area-pointer index t) t (unsafe))
 165 (defknown lra-code-header (t) t (movable flushable))
 166 (defknown fun-code-header (t) t (movable flushable))
 167 (defknown make-lisp-obj (sb!vm:word) t (movable flushable))
 168 (defknown get-lisp-obj-address (t) sb!vm:word (movable flushable))
 169 (defknown fun-word-offset (function) index (movable flushable))
 170 \f
 171 ;;;; 32-bit logical operations
 172
 173 (defknown merge-bits ((unsigned-byte 5) sb!vm:word sb!vm:word)
 174   sb!vm:word
 175   (foldable flushable movable))
 176
 177 (defknown 32bit-logical-not (sb!vm:word) sb!vm:word
 178   (foldable flushable movable))
 179
 180 (defknown (32bit-logical-and 32bit-logical-nand
 181            32bit-logical-or 32bit-logical-nor
 182            32bit-logical-xor 32bit-logical-eqv
 183            32bit-logical-andc1 32bit-logical-andc2
 184            32bit-logical-orc1 32bit-logical-orc2)
 185           (sb!vm:word sb!vm:word) sb!vm:word
 186   (foldable flushable movable))
 187
 188 (defknown (shift-towards-start shift-towards-end) (sb!vm:word fixnum)
 189   sb!vm:word
 190   (foldable flushable movable))
 191 \f
 192 ;;;; bignum operations
 193
 194 (defknown %allocate-bignum (bignum-index) bignum-type
 195   (flushable))
 196
 197 (defknown %bignum-length (bignum-type) bignum-index
 198   (foldable flushable movable))
 199
 200 (defknown %bignum-set-length (bignum-type bignum-index) bignum-type
 201   (unsafe))
 202
 203 (defknown %bignum-ref (bignum-type bignum-index) bignum-element-type
 204   (flushable))
 205
 206 (defknown %bignum-set (bignum-type bignum-index bignum-element-type)
 207   bignum-element-type
 208   (unsafe))
 209
 210 (defknown %digit-0-or-plusp (bignum-element-type) boolean
 211   (foldable flushable movable))
 212
 213 (defknown (%add-with-carry %subtract-with-borrow)
 214           (bignum-element-type bignum-element-type (mod 2))
 215   (values bignum-element-type (mod 2))
 216   (foldable flushable movable))
 217
 218 (defknown %multiply-and-add
 219           (bignum-element-type bignum-element-type bignum-element-type
 220                                &optional bignum-element-type)
 221   (values bignum-element-type bignum-element-type)
 222   (foldable flushable movable))
 223
 224 (defknown %multiply (bignum-element-type bignum-element-type)
 225   (values bignum-element-type bignum-element-type)
 226   (foldable flushable movable))
 227
 228 (defknown %lognot (bignum-element-type) bignum-element-type
 229   (foldable flushable movable))
 230
 231 (defknown (%logand %logior %logxor) (bignum-element-type bignum-element-type)
 232   bignum-element-type
 233   (foldable flushable movable))
 234
 235 (defknown %fixnum-to-digit (fixnum) bignum-element-type
 236   (foldable flushable movable))
 237
 238 (defknown %floor (bignum-element-type bignum-element-type bignum-element-type)
 239   (values bignum-element-type bignum-element-type)
 240   (foldable flushable movable))
 241
 242 (defknown %fixnum-digit-with-correct-sign (bignum-element-type)
 243   (signed-byte #.sb!vm:n-word-bits)
 244   (foldable flushable movable))
 245
 246 (defknown (%ashl %ashr %digit-logical-shift-right)
 247           (bignum-element-type (mod 32)) bignum-element-type
 248   (foldable flushable movable))
 249 \f
 250 ;;;; bit-bashing routines
 251
 252 (defknown copy-to-system-area
 253           ((simple-unboxed-array (*)) index system-area-pointer index index)
 254   (values)
 255   ())
 256
 257 (defknown copy-from-system-area
 258           (system-area-pointer index (simple-unboxed-array (*)) index index)
 259   (values)
 260   ())
 261
 262 (defknown system-area-copy
 263           (system-area-pointer index system-area-pointer index index)
 264   (values)
 265   ())
 266
 267 (defknown bit-bash-copy
 268           ((simple-unboxed-array (*)) index
 269            (simple-unboxed-array (*)) index index)
 270   (values)
 271   ())
 272
 273 ;;; (not really a bit-bashing routine, but starting to take over from
 274 ;;; bit-bashing routines in byte-sized copies as of sbcl-0.6.12.29:)
 275 (defknown %byte-blt
 276   ((or (simple-unboxed-array (*)) system-area-pointer) index
 277    (or (simple-unboxed-array (*)) system-area-pointer) index index)
 278   (values)
 279   ())
 280 \f
 281 ;;;; code/function/fdefn object manipulation routines
 282
 283 (defknown code-instructions (t) system-area-pointer (flushable movable))
 284 (defknown code-header-ref (t index) t (flushable))
 285 (defknown code-header-set (t index t) t ())
 286
 287 (defknown fun-subtype (function) (unsigned-byte #.sb!vm:n-widetag-bits)
 288   (flushable))
 289 (defknown ((setf fun-subtype))
 290           ((unsigned-byte #.sb!vm:n-widetag-bits) function)
 291   (unsigned-byte #.sb!vm:n-widetag-bits)
 292   ())
 293
 294 (defknown make-fdefn (t) fdefn (flushable movable))
 295 (defknown fdefn-p (t) boolean (movable foldable flushable))
 296 (defknown fdefn-name (fdefn) t (foldable flushable))
 297 (defknown fdefn-fun (fdefn) (or function null) (flushable))
 298 (defknown (setf fdefn-fun) (function fdefn) t (unsafe))
 299 (defknown fdefn-makunbound (fdefn) t ())
 300
 301 (defknown %simple-fun-self (function) function
 302   (flushable))
 303 (defknown (setf %simple-fun-self) (function function) function
 304   (unsafe))
 305
 306 (defknown %closure-fun (function) function
 307   (flushable))
 308
 309 (defknown %closure-index-ref (function index) t
 310   (flushable))
 311
 312 (defknown %make-funcallable-instance (index layout) function
 313   (unsafe))
 314
 315 (defknown %funcallable-instance-info (function index) t (flushable))
 316 (defknown %set-funcallable-instance-info (function index t) t (unsafe))
 317 \f
 318 ;;;; mutator accessors
 319
 320 (defknown mutator-self () system-area-pointer (flushable movable))
 321
 322 (defknown %data-vector-and-index (array index)
 323                                  (values (simple-array * (*)) index)
 324                                  (foldable flushable))