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            #!+sb-unicode character-string-p
  26            #!+sb-unicode simple-character-string-p
  27            array-header-p
  28            sequencep extended-sequence-p
  29            simple-array-p simple-array-nil-p vector-nil-p
  30            simple-array-unsigned-byte-2-p
  31            simple-array-unsigned-byte-4-p simple-array-unsigned-byte-7-p
  32            simple-array-unsigned-byte-8-p simple-array-unsigned-byte-15-p
  33            simple-array-unsigned-byte-16-p
  34
  35            simple-array-unsigned-fixnum-p
  36
  37            simple-array-unsigned-byte-31-p
  38            simple-array-unsigned-byte-32-p
  39            #!+#.(cl:if (cl:= 64 sb!vm:n-word-bits) '(and) '(or))
  40            simple-array-unsigned-byte-63-p
  41            #!+#.(cl:if (cl:= 64 sb!vm:n-word-bits) '(and) '(or))
  42            simple-array-unsigned-byte-64-p
  43            simple-array-signed-byte-8-p simple-array-signed-byte-16-p
  44
  45            simple-array-fixnum-p
  46
  47            simple-array-signed-byte-32-p
  48            #!+#.(cl:if (cl:= 64 sb!vm:n-word-bits) '(and) '(or))
  49            simple-array-signed-byte-64-p
  50            simple-array-single-float-p simple-array-double-float-p
  51            #!+long-float simple-array-long-float-p
  52            simple-array-complex-single-float-p
  53            simple-array-complex-double-float-p
  54            #!+long-float simple-array-complex-long-float-p
  55            system-area-pointer-p realp
  56            ;; #!+#.(cl:if (cl:= 32 sb!vm:n-word-bits) '(and) '(or))
  57            unsigned-byte-32-p
  58            ;; #!+#.(cl:if (cl:= 32 sb!vm:n-word-bits) '(and) '(or))
  59            signed-byte-32-p
  60            #!+#.(cl:if (cl:= 64 sb!vm:n-word-bits) '(and) '(or))
  61            unsigned-byte-64-p
  62            #!+#.(cl:if (cl:= 64 sb!vm:n-word-bits) '(and) '(or))
  63            signed-byte-64-p
  64            weak-pointer-p code-component-p lra-p
  65            funcallable-instance-p)
  66   (t) boolean (movable foldable flushable))
  67
  68 (defknown #.(loop for (name) in *vector-without-complex-typecode-infos*
  69                   collect name)
  70     (t) boolean (movable foldable flushable))
  71
  72 (defknown %other-pointer-p (t) boolean
  73   (movable foldable flushable always-translatable))
  74
  75 \f
  76 ;;;; miscellaneous "sub-primitives"
  77
  78 (defknown pointer-hash (t) hash (flushable))
  79
  80 (defknown %sp-string-compare
  81   (simple-string index index simple-string index index)
  82   (or index null)
  83   (foldable flushable))
  84
  85 (defknown %sxhash-simple-string (simple-string) hash
  86   (foldable flushable))
  87
  88 (defknown %sxhash-simple-substring (simple-string index) hash
  89   (foldable flushable))
  90
  91 (defknown symbol-hash (symbol) hash
  92   (flushable movable))
  93
  94 (defknown %set-symbol-hash (symbol hash)
  95   t ())
  96
  97 (defknown initialize-vector ((simple-array * (*)) &rest t)
  98   (simple-array * (*))
  99   (always-translatable flushable)
 100   :result-arg 0)
 101
 102 (defknown vector-fill* (t t t t) vector
 103   ()
 104   :result-arg 0)
 105
 106 (defknown vector-length (vector) index (flushable dx-safe))
 107
 108 (defknown vector-sap ((simple-unboxed-array (*))) system-area-pointer
 109   (flushable))
 110
 111 (defknown lowtag-of (t) (unsigned-byte #.sb!vm:n-lowtag-bits)
 112   (flushable movable))
 113 (defknown widetag-of (t) (unsigned-byte #.sb!vm:n-widetag-bits)
 114   (flushable movable))
 115
 116 (defknown (get-header-data get-closure-length) (t) (unsigned-byte 24)
 117   (flushable))
 118 (defknown set-header-data (t (unsigned-byte 24)) t
 119   ())
 120
 121 (defknown %array-dimension (t index) index
 122   (flushable))
 123 (defknown %set-array-dimension (t index index) index
 124   ())
 125 (defknown %array-rank (t) index
 126   (flushable))
 127
 128 (defknown %make-instance (index) instance
 129   (flushable))
 130 (defknown %make-structure-instance (defstruct-description list &rest t) instance
 131   (flushable always-translatable))
 132 (defknown %instance-layout (instance) layout
 133   (foldable flushable))
 134 (defknown %set-instance-layout (instance layout) layout
 135   ())
 136 (defknown %instance-length (instance) index
 137   (foldable flushable))
 138 (defknown %instance-ref (instance index) t
 139   (flushable always-translatable))
 140 (defknown %instance-set (instance index t) t
 141   (always-translatable))
 142 (defknown %layout-invalid-error (t layout) nil)
 143
 144 (defknown %raw-instance-ref/word (instance index) sb!vm:word
 145   (flushable always-translatable))
 146 (defknown %raw-instance-set/word (instance index sb!vm:word) sb!vm:word
 147   (always-translatable))
 148 (defknown %raw-instance-ref/single (instance index) single-float
 149   (flushable always-translatable))
 150 (defknown %raw-instance-set/single (instance index single-float) single-float
 151   (always-translatable))
 152 (defknown %raw-instance-ref/double (instance index) double-float
 153   (flushable always-translatable))
 154 (defknown %raw-instance-set/double (instance index double-float) double-float
 155   (always-translatable))
 156 (defknown %raw-instance-ref/complex-single (instance index)
 157   (complex single-float)
 158   (flushable always-translatable))
 159 (defknown %raw-instance-set/complex-single
 160     (instance index (complex single-float))
 161   (complex single-float)
 162   (always-translatable))
 163 (defknown %raw-instance-ref/complex-double (instance index)
 164   (complex double-float)
 165   (flushable always-translatable))
 166 (defknown %raw-instance-set/complex-double
 167     (instance index (complex double-float))
 168   (complex double-float)
 169   (always-translatable))
 170
 171 #!+(or x86 x86-64 ppc)
 172 (defknown %raw-instance-atomic-incf/word (instance index sb!vm:word) sb!vm:word
 173     (always-translatable))
 174 #!+(or x86 x86-64 ppc)
 175 (defknown %array-atomic-incf/word (t index sb!vm:word) sb!vm:word
 176   (always-translatable))
 177
 178 ;;; These two are mostly used for bit-bashing operations.
 179 (defknown %vector-raw-bits (t fixnum) sb!vm:word
 180   (flushable))
 181 (defknown (%set-vector-raw-bits) (t fixnum sb!vm:word) sb!vm:word
 182   ())
 183
 184
 185 (defknown allocate-vector ((unsigned-byte 8) index index) (simple-array * (*))
 186   (flushable movable))
 187
 188 (defknown make-array-header ((unsigned-byte 8) (unsigned-byte 24)) array
 189   (flushable movable))
 190
 191
 192 (defknown make-weak-pointer (t) weak-pointer
 193   (flushable))
 194
 195 (defknown %make-complex (real real) complex
 196   (flushable movable))
 197 (defknown %make-ratio (rational rational) ratio
 198   (flushable movable))
 199 (defknown make-value-cell (t) t
 200   (flushable movable))
 201
 202 #!+sb-simd-pack
 203 (progn
 204   (defknown simd-pack-p (t) boolean (foldable movable flushable))
 205   (defknown %simd-pack-tag (simd-pack) fixnum (movable flushable))
 206   (defknown %make-simd-pack (fixnum (unsigned-byte 64) (unsigned-byte 64))
 207       simd-pack
 208       (flushable movable foldable))
 209   (defknown %make-simd-pack-double (double-float double-float)
 210       (simd-pack double-float)
 211       (flushable movable foldable))
 212   (defknown %make-simd-pack-single (single-float single-float
 213                                     single-float single-float)
 214       (simd-pack single-float)
 215       (flushable movable foldable))
 216   (defknown %make-simd-pack-ub32 ((unsigned-byte 32) (unsigned-byte 32)
 217                                   (unsigned-byte 32) (unsigned-byte 32))
 218       (simd-pack integer)
 219       (flushable movable foldable))
 220   (defknown %make-simd-pack-ub64 ((unsigned-byte 64) (unsigned-byte 64))
 221       (simd-pack integer)
 222       (flushable movable foldable))
 223   (defknown (%simd-pack-low %simd-pack-high) (simd-pack)
 224       (unsigned-byte 64)
 225       (flushable movable foldable))
 226   (defknown %simd-pack-ub32s (simd-pack)
 227       (values (unsigned-byte 32) (unsigned-byte 32)
 228               (unsigned-byte 32) (unsigned-byte 32))
 229       (flushable movable foldable))
 230   (defknown %simd-pack-ub64s (simd-pack)
 231       (values (unsigned-byte 64) (unsigned-byte 64))
 232       (flushable movable foldable))
 233   (defknown %simd-pack-singles (simd-pack)
 234       (values single-float single-float single-float single-float)
 235       (flushable movable foldable))
 236   (defknown %simd-pack-doubles (simd-pack)
 237       (values double-float double-float)
 238       (flushable movable foldable)))
 239
 240 ;;;; threading
 241
 242 (defknown (dynamic-space-free-pointer binding-stack-pointer-sap
 243                                       control-stack-pointer-sap)  ()
 244   system-area-pointer
 245   (flushable))
 246 \f
 247 ;;;; debugger support
 248
 249 (defknown current-sp () system-area-pointer (movable flushable))
 250 (defknown current-fp () system-area-pointer (movable flushable))
 251 (defknown stack-ref (system-area-pointer index) t (flushable))
 252 (defknown %set-stack-ref (system-area-pointer index t) t ())
 253 (defknown lra-code-header (t) t (movable flushable))
 254 (defknown fun-code-header (t) t (movable flushable))
 255 (defknown %make-lisp-obj (sb!vm:word) t (movable flushable))
 256 (defknown get-lisp-obj-address (t) sb!vm:word (movable flushable))
 257 (defknown fun-word-offset (function) index (movable flushable))
 258 \f
 259 ;;;; 32-bit logical operations
 260
 261 (defknown word-logical-not (sb!vm:word) sb!vm:word
 262   (foldable flushable movable))
 263
 264 (defknown (word-logical-and word-logical-nand
 265            word-logical-or word-logical-nor
 266            word-logical-xor word-logical-eqv
 267            word-logical-andc1 word-logical-andc2
 268            word-logical-orc1 word-logical-orc2)
 269           (sb!vm:word sb!vm:word) sb!vm:word
 270   (foldable flushable movable))
 271
 272 (defknown (shift-towards-start shift-towards-end) (sb!vm:word fixnum)
 273   sb!vm:word
 274   (foldable flushable movable))
 275 \f
 276 ;;;; bignum operations
 277
 278 (defknown %allocate-bignum (bignum-index) bignum-type
 279   (flushable))
 280
 281 (defknown %bignum-length (bignum-type) bignum-index
 282   (foldable flushable movable))
 283
 284 (defknown %bignum-set-length (bignum-type bignum-index) bignum-type
 285   ())
 286
 287 (defknown %bignum-ref (bignum-type bignum-index) bignum-element-type
 288   (flushable))
 289 #!+(or x86 x86-64)
 290 (defknown %bignum-ref-with-offset (bignum-type bignum-index (signed-byte 24))
 291   bignum-element-type (flushable always-translatable))
 292
 293 (defknown %bignum-set (bignum-type bignum-index bignum-element-type)
 294   bignum-element-type
 295   ())
 296 #!+(or x86 x86-64)
 297 (defknown %bignum-set-with-offset
 298   (bignum-type bignum-index (signed-byte 24) bignum-element-type)
 299   bignum-element-type (always-translatable))
 300
 301 (defknown %digit-0-or-plusp (bignum-element-type) boolean
 302   (foldable flushable movable))
 303
 304 (defknown (%add-with-carry %subtract-with-borrow)
 305           (bignum-element-type bignum-element-type (mod 2))
 306   (values bignum-element-type (mod 2))
 307   (foldable flushable movable))
 308
 309 (defknown %multiply-and-add
 310           (bignum-element-type bignum-element-type bignum-element-type
 311                                &optional bignum-element-type)
 312   (values bignum-element-type bignum-element-type)
 313   (foldable flushable movable))
 314
 315 (defknown %multiply (bignum-element-type bignum-element-type)
 316   (values bignum-element-type bignum-element-type)
 317   (foldable flushable movable))
 318
 319 (defknown %lognot (bignum-element-type) bignum-element-type
 320   (foldable flushable movable))
 321
 322 (defknown (%logand %logior %logxor) (bignum-element-type bignum-element-type)
 323   bignum-element-type
 324   (foldable flushable movable))
 325
 326 (defknown %fixnum-to-digit (fixnum) bignum-element-type
 327   (foldable flushable movable))
 328
 329 (defknown %bigfloor (bignum-element-type bignum-element-type bignum-element-type)
 330   (values bignum-element-type bignum-element-type)
 331   (foldable flushable movable))
 332
 333 (defknown %fixnum-digit-with-correct-sign (bignum-element-type)
 334   (signed-byte #.sb!vm:n-word-bits)
 335   (foldable flushable movable))
 336
 337 (defknown (%ashl %ashr %digit-logical-shift-right)
 338           (bignum-element-type (mod #.sb!vm:n-word-bits)) bignum-element-type
 339   (foldable flushable movable))
 340 \f
 341 ;;;; bit-bashing routines
 342
 343 ;;; FIXME: there's some ugly duplication between the (INTERN (FORMAT ...))
 344 ;;; magic here and the same magic in src/code/bit-bash.lisp.  I don't know
 345 ;;; of any good way to clean it up, but it's definitely violating OAOO.
 346 (macrolet ((define-known-copiers ()
 347             `(progn
 348               ,@(loop for i = 1 then (* i 2)
 349                       collect `(defknown ,(intern (format nil "UB~D-BASH-COPY" i)
 350                                                   (find-package "SB!KERNEL"))
 351                                 ((simple-unboxed-array (*)) index (simple-unboxed-array (*)) index index)
 352                                 (values)
 353                                 ())
 354                       collect `(defknown ,(intern (format nil "SYSTEM-AREA-UB~D-COPY" i)
 355                                                   (find-package "SB!KERNEL"))
 356                                 (system-area-pointer index system-area-pointer index index)
 357                                 (values)
 358                                 ())
 359                       collect `(defknown ,(intern (format nil "COPY-UB~D-TO-SYSTEM-AREA" i)
 360                                                   (find-package "SB!KERNEL"))
 361                                 ((simple-unboxed-array (*)) index system-area-pointer index index)
 362                                 (values)
 363                                 ())
 364                       collect `(defknown ,(intern (format nil "COPY-UB~D-FROM-SYSTEM-AREA" i)
 365                                                   (find-package "SB!KERNEL"))
 366                                 (system-area-pointer index (simple-unboxed-array (*)) index index)
 367                                 (values)
 368                                 ())
 369                       until (= i sb!vm:n-word-bits)))))
 370   (define-known-copiers))
 371
 372 ;;; (not really a bit-bashing routine, but starting to take over from
 373 ;;; bit-bashing routines in byte-sized copies as of sbcl-0.6.12.29:)
 374 (defknown %byte-blt
 375   ((or (simple-unboxed-array (*)) system-area-pointer) index
 376    (or (simple-unboxed-array (*)) system-area-pointer) index index)
 377   (values)
 378   ())
 379 \f
 380 ;;;; code/function/fdefn object manipulation routines
 381
 382 (defknown code-instructions (t) system-area-pointer (flushable movable))
 383 (defknown code-header-ref (t index) t (flushable))
 384 (defknown code-header-set (t index t) t ())
 385
 386 (defknown fun-subtype (function) (unsigned-byte #.sb!vm:n-widetag-bits)
 387   (flushable))
 388 (defknown ((setf fun-subtype))
 389           ((unsigned-byte #.sb!vm:n-widetag-bits) function)
 390   (unsigned-byte #.sb!vm:n-widetag-bits)
 391   ())
 392
 393 (defknown make-fdefn (t) fdefn (flushable movable))
 394 (defknown fdefn-p (t) boolean (movable foldable flushable))
 395 (defknown fdefn-name (fdefn) t (foldable flushable))
 396 (defknown fdefn-fun (fdefn) (or function null) (flushable))
 397 (defknown (setf fdefn-fun) (function fdefn) t ())
 398 (defknown fdefn-makunbound (fdefn) t ())
 399
 400 (defknown %simple-fun-self (function) function
 401   (flushable))
 402 (defknown (setf %simple-fun-self) (function function) function
 403   ())
 404
 405 (defknown %closure-fun (function) function
 406   (flushable))
 407
 408 (defknown %closure-index-ref (function index) t
 409   (flushable))
 410
 411 (defknown %make-funcallable-instance (index) function
 412   ())
 413
 414 (defknown %funcallable-instance-info (function index) t (flushable))
 415 (defknown %set-funcallable-instance-info (function index t) t ())
 416 \f
 417 ;;;; mutator accessors
 418
 419 (defknown mutator-self () system-area-pointer (flushable movable))
 420
 421 (defknown %data-vector-and-index (array index)
 422                                  (values (simple-array * (*)) index)
 423                                  (foldable flushable))