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