1 ;;;; signatures of machine-specific functions
3 ;;;; This software is part of the SBCL system. See the README file for
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.
14 ;;;; internal type predicates
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
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
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
35 simple-array-unsigned-fixnum-p
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
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))
58 ;; #!+#.(cl:if (cl:= 32 sb!vm:n-word-bits) '(and) '(or))
60 #!+#.(cl:if (cl:= 64 sb!vm:n-word-bits) '(and) '(or))
62 #!+#.(cl:if (cl:= 64 sb!vm:n-word-bits) '(and) '(or))
64 weak-pointer-p code-component-p lra-p
65 funcallable-instance-p)
66 (t) boolean (movable foldable flushable))
68 (defknown #.(loop for (name) in *vector-without-complex-typecode-infos*
70 (t) boolean (movable foldable flushable))
72 (defknown %other-pointer-p (t) boolean
73 (movable foldable flushable always-translatable))
76 ;;;; miscellaneous "sub-primitives"
78 (defknown pointer-hash (t) hash (flushable))
80 (defknown %sp-string-compare
81 (simple-string index index simple-string index index)
85 (defknown %sxhash-simple-string (simple-string) hash
88 (defknown %sxhash-simple-substring (simple-string index) hash
91 (defknown symbol-hash (symbol) hash
94 (defknown %set-symbol-hash (symbol hash)
97 (defknown initialize-vector ((simple-array * (*)) &rest t)
99 (always-translatable flushable)
102 (defknown vector-fill* (t t t t) vector
106 (defknown vector-length (vector) index (flushable dx-safe))
108 (defknown vector-sap ((simple-unboxed-array (*))) system-area-pointer
111 (defknown lowtag-of (t) (unsigned-byte #.sb!vm:n-lowtag-bits)
113 (defknown widetag-of (t) (unsigned-byte #.sb!vm:n-widetag-bits)
116 (defknown (get-header-data get-closure-length) (t) (unsigned-byte 24)
118 (defknown set-header-data (t (unsigned-byte 24)) t
121 (defknown %array-dimension (t index) index
123 (defknown %set-array-dimension (t index index) index
125 (defknown %array-rank (t) index
128 (defknown %make-instance (index) instance
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
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)
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))
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))
178 ;;; These two are mostly used for bit-bashing operations.
179 (defknown %vector-raw-bits (t fixnum) sb!vm:word
181 (defknown (%set-vector-raw-bits) (t fixnum sb!vm:word) sb!vm:word
185 (defknown allocate-vector ((unsigned-byte 8) index index) (simple-array * (*))
188 (defknown make-array-header ((unsigned-byte 8) (unsigned-byte 24)) array
192 (defknown make-weak-pointer (t) weak-pointer
195 (defknown %make-complex (real real) complex
197 (defknown %make-ratio (rational rational) ratio
199 (defknown make-value-cell (t) t
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))
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))
219 (flushable movable foldable))
220 (defknown %make-simd-pack-ub64 ((unsigned-byte 64) (unsigned-byte 64))
222 (flushable movable foldable))
223 (defknown (%simd-pack-low %simd-pack-high) (simd-pack)
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)))
242 (defknown (dynamic-space-free-pointer binding-stack-pointer-sap
243 control-stack-pointer-sap) ()
247 ;;;; debugger support
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))
259 ;;;; 32-bit logical operations
261 (defknown word-logical-not (sb!vm:word) sb!vm:word
262 (foldable flushable movable))
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))
272 (defknown (shift-towards-start shift-towards-end) (sb!vm:word fixnum)
274 (foldable flushable movable))
276 ;;;; bignum operations
278 (defknown %allocate-bignum (bignum-index) bignum-type
281 (defknown %bignum-length (bignum-type) bignum-index
282 (foldable flushable movable))
284 (defknown %bignum-set-length (bignum-type bignum-index) bignum-type
287 (defknown %bignum-ref (bignum-type bignum-index) bignum-element-type
290 (defknown %bignum-ref-with-offset (bignum-type fixnum (signed-byte 24))
291 bignum-element-type (flushable always-translatable))
293 (defknown %bignum-set (bignum-type bignum-index bignum-element-type)
297 (defknown %digit-0-or-plusp (bignum-element-type) boolean
298 (foldable flushable movable))
300 (defknown (%add-with-carry %subtract-with-borrow)
301 (bignum-element-type bignum-element-type (mod 2))
302 (values bignum-element-type (mod 2))
303 (foldable flushable movable))
305 (defknown %multiply-and-add
306 (bignum-element-type bignum-element-type bignum-element-type
307 &optional bignum-element-type)
308 (values bignum-element-type bignum-element-type)
309 (foldable flushable movable))
311 (defknown %multiply (bignum-element-type bignum-element-type)
312 (values bignum-element-type bignum-element-type)
313 (foldable flushable movable))
315 (defknown %lognot (bignum-element-type) bignum-element-type
316 (foldable flushable movable))
318 (defknown (%logand %logior %logxor) (bignum-element-type bignum-element-type)
320 (foldable flushable movable))
322 (defknown %fixnum-to-digit (fixnum) bignum-element-type
323 (foldable flushable movable))
325 (defknown %bigfloor (bignum-element-type bignum-element-type bignum-element-type)
326 (values bignum-element-type bignum-element-type)
327 (foldable flushable movable))
329 (defknown %fixnum-digit-with-correct-sign (bignum-element-type)
330 (signed-byte #.sb!vm:n-word-bits)
331 (foldable flushable movable))
333 (defknown (%ashl %ashr %digit-logical-shift-right)
334 (bignum-element-type (mod #.sb!vm:n-word-bits)) bignum-element-type
335 (foldable flushable movable))
337 ;;;; bit-bashing routines
339 ;;; FIXME: there's some ugly duplication between the (INTERN (FORMAT ...))
340 ;;; magic here and the same magic in src/code/bit-bash.lisp. I don't know
341 ;;; of any good way to clean it up, but it's definitely violating OAOO.
342 (macrolet ((define-known-copiers ()
344 ,@(loop for i = 1 then (* i 2)
345 collect `(defknown ,(intern (format nil "UB~D-BASH-COPY" i)
346 (find-package "SB!KERNEL"))
347 ((simple-unboxed-array (*)) index (simple-unboxed-array (*)) index index)
350 collect `(defknown ,(intern (format nil "SYSTEM-AREA-UB~D-COPY" i)
351 (find-package "SB!KERNEL"))
352 (system-area-pointer index system-area-pointer index index)
355 collect `(defknown ,(intern (format nil "COPY-UB~D-TO-SYSTEM-AREA" i)
356 (find-package "SB!KERNEL"))
357 ((simple-unboxed-array (*)) index system-area-pointer index index)
360 collect `(defknown ,(intern (format nil "COPY-UB~D-FROM-SYSTEM-AREA" i)
361 (find-package "SB!KERNEL"))
362 (system-area-pointer index (simple-unboxed-array (*)) index index)
365 until (= i sb!vm:n-word-bits)))))
366 (define-known-copiers))
368 ;;; (not really a bit-bashing routine, but starting to take over from
369 ;;; bit-bashing routines in byte-sized copies as of sbcl-0.6.12.29:)
371 ((or (simple-unboxed-array (*)) system-area-pointer) index
372 (or (simple-unboxed-array (*)) system-area-pointer) index index)
376 ;;;; code/function/fdefn object manipulation routines
378 (defknown code-instructions (t) system-area-pointer (flushable movable))
379 (defknown code-header-ref (t index) t (flushable))
380 (defknown code-header-set (t index t) t ())
382 (defknown fun-subtype (function) (unsigned-byte #.sb!vm:n-widetag-bits)
384 (defknown ((setf fun-subtype))
385 ((unsigned-byte #.sb!vm:n-widetag-bits) function)
386 (unsigned-byte #.sb!vm:n-widetag-bits)
389 (defknown make-fdefn (t) fdefn (flushable movable))
390 (defknown fdefn-p (t) boolean (movable foldable flushable))
391 (defknown fdefn-name (fdefn) t (foldable flushable))
392 (defknown fdefn-fun (fdefn) (or function null) (flushable))
393 (defknown (setf fdefn-fun) (function fdefn) t ())
394 (defknown fdefn-makunbound (fdefn) t ())
396 (defknown %simple-fun-self (function) function
398 (defknown (setf %simple-fun-self) (function function) function
401 (defknown %closure-fun (function) function
404 (defknown %closure-index-ref (function index) t
407 (defknown %make-funcallable-instance (index) function
410 (defknown %funcallable-instance-info (function index) t (flushable))
411 (defknown %set-funcallable-instance-info (function index t) t ())
414 (defknown %data-vector-and-index (array index)
415 (values (simple-array * (*)) index)
416 (foldable flushable))