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 #!+sb-unicode base-char-p
24 %standard-char-p %instancep
25 base-string-p simple-base-string-p
26 #!+sb-unicode character-string-p
27 #!+sb-unicode simple-character-string-p
29 sequencep extended-sequence-p
30 simple-array-p simple-array-nil-p vector-nil-p
31 simple-array-unsigned-byte-2-p
32 simple-array-unsigned-byte-4-p simple-array-unsigned-byte-7-p
33 simple-array-unsigned-byte-8-p simple-array-unsigned-byte-15-p
34 simple-array-unsigned-byte-16-p
36 simple-array-unsigned-fixnum-p
38 simple-array-unsigned-byte-31-p
39 simple-array-unsigned-byte-32-p
40 #!+#.(cl:if (cl:= 64 sb!vm:n-word-bits) '(and) '(or))
41 simple-array-unsigned-byte-63-p
42 #!+#.(cl:if (cl:= 64 sb!vm:n-word-bits) '(and) '(or))
43 simple-array-unsigned-byte-64-p
44 simple-array-signed-byte-8-p simple-array-signed-byte-16-p
48 simple-array-signed-byte-32-p
49 #!+#.(cl:if (cl:= 64 sb!vm:n-word-bits) '(and) '(or))
50 simple-array-signed-byte-64-p
51 simple-array-single-float-p simple-array-double-float-p
52 #!+long-float simple-array-long-float-p
53 simple-array-complex-single-float-p
54 simple-array-complex-double-float-p
55 #!+long-float simple-array-complex-long-float-p
56 system-area-pointer-p realp
57 ;; #!+#.(cl:if (cl:= 32 sb!vm:n-word-bits) '(and) '(or))
59 ;; #!+#.(cl:if (cl:= 32 sb!vm:n-word-bits) '(and) '(or))
61 #!+#.(cl:if (cl:= 64 sb!vm:n-word-bits) '(and) '(or))
63 #!+#.(cl:if (cl:= 64 sb!vm:n-word-bits) '(and) '(or))
65 weak-pointer-p code-component-p lra-p
66 funcallable-instance-p)
67 (t) boolean (movable foldable flushable))
69 (defknown #.(loop for (name) in *vector-without-complex-typecode-infos*
71 (t) boolean (movable foldable flushable))
73 (defknown %other-pointer-p (t) boolean
74 (movable foldable flushable always-translatable))
77 ;;;; miscellaneous "sub-primitives"
79 (defknown pointer-hash (t) hash (flushable))
81 (defknown %sp-string-compare
82 (simple-string index index simple-string index index)
86 (defknown %sxhash-simple-string (simple-string) hash
89 (defknown %sxhash-simple-substring (simple-string index) hash
92 (defknown symbol-hash (symbol) hash
95 (defknown %set-symbol-hash (symbol hash)
98 (defknown initialize-vector ((simple-array * (*)) &rest t)
100 (always-translatable flushable)
103 (defknown vector-fill* (t t t t) vector
107 (defknown vector-length (vector) index (flushable dx-safe))
109 (defknown vector-sap ((simple-unboxed-array (*))) system-area-pointer
112 (defknown lowtag-of (t) (unsigned-byte #.sb!vm:n-lowtag-bits)
114 (defknown widetag-of (t) (unsigned-byte #.sb!vm:n-widetag-bits)
117 (defknown (get-header-data get-closure-length) (t) (unsigned-byte 24)
119 (defknown set-header-data (t (unsigned-byte 24)) t
122 (defknown %array-dimension (t index) index
124 (defknown %set-array-dimension (t index index) index
126 (defknown %array-rank (t) index
129 (defknown %make-instance (index) instance
131 (defknown %make-structure-instance (defstruct-description list &rest t) instance
132 (flushable always-translatable))
133 (defknown %instance-layout (instance) layout
134 (foldable flushable))
135 (defknown %set-instance-layout (instance layout) layout
137 (defknown %instance-length (instance) index
138 (foldable flushable))
139 (defknown %instance-ref (instance index) t
140 (flushable always-translatable))
141 (defknown %instance-set (instance index t) t
142 (always-translatable))
143 (defknown %layout-invalid-error (t layout) nil)
145 (defknown %raw-instance-ref/word (instance index) sb!vm:word
146 (flushable always-translatable))
147 (defknown %raw-instance-set/word (instance index sb!vm:word) sb!vm:word
148 (always-translatable))
149 (defknown %raw-instance-ref/single (instance index) single-float
150 (flushable always-translatable))
151 (defknown %raw-instance-set/single (instance index single-float) single-float
152 (always-translatable))
153 (defknown %raw-instance-ref/double (instance index) double-float
154 (flushable always-translatable))
155 (defknown %raw-instance-set/double (instance index double-float) double-float
156 (always-translatable))
157 (defknown %raw-instance-ref/complex-single (instance index)
158 (complex single-float)
159 (flushable always-translatable))
160 (defknown %raw-instance-set/complex-single
161 (instance index (complex single-float))
162 (complex single-float)
163 (always-translatable))
164 (defknown %raw-instance-ref/complex-double (instance index)
165 (complex double-float)
166 (flushable always-translatable))
167 (defknown %raw-instance-set/complex-double
168 (instance index (complex double-float))
169 (complex double-float)
170 (always-translatable))
172 #!+(or x86 x86-64 ppc)
173 (defknown %raw-instance-atomic-incf/word (instance index sb!vm:word) sb!vm:word
174 (always-translatable))
175 #!+(or x86 x86-64 ppc)
176 (defknown %array-atomic-incf/word (t index sb!vm:word) sb!vm:word
177 (always-translatable))
179 ;;; These two are mostly used for bit-bashing operations.
180 (defknown %vector-raw-bits (t fixnum) sb!vm:word
182 (defknown (%set-vector-raw-bits) (t fixnum sb!vm:word) sb!vm:word
186 (defknown allocate-vector ((unsigned-byte 8) index index) (simple-array * (*))
189 (defknown make-array-header ((unsigned-byte 8) (unsigned-byte 24)) array
193 (defknown make-weak-pointer (t) weak-pointer
196 (defknown %make-complex (real real) complex
198 (defknown %make-ratio (rational rational) ratio
200 (defknown make-value-cell (t) t
205 (defknown simd-pack-p (t) boolean (foldable movable flushable))
206 (defknown %simd-pack-tag (simd-pack) fixnum (movable flushable))
207 (defknown %make-simd-pack (fixnum (unsigned-byte 64) (unsigned-byte 64))
209 (flushable movable foldable))
210 (defknown %make-simd-pack-double (double-float double-float)
211 (simd-pack double-float)
212 (flushable movable foldable))
213 (defknown %make-simd-pack-single (single-float single-float
214 single-float single-float)
215 (simd-pack single-float)
216 (flushable movable foldable))
217 (defknown %make-simd-pack-ub32 ((unsigned-byte 32) (unsigned-byte 32)
218 (unsigned-byte 32) (unsigned-byte 32))
220 (flushable movable foldable))
221 (defknown %make-simd-pack-ub64 ((unsigned-byte 64) (unsigned-byte 64))
223 (flushable movable foldable))
224 (defknown (%simd-pack-low %simd-pack-high) (simd-pack)
226 (flushable movable foldable))
227 (defknown %simd-pack-ub32s (simd-pack)
228 (values (unsigned-byte 32) (unsigned-byte 32)
229 (unsigned-byte 32) (unsigned-byte 32))
230 (flushable movable foldable))
231 (defknown %simd-pack-ub64s (simd-pack)
232 (values (unsigned-byte 64) (unsigned-byte 64))
233 (flushable movable foldable))
234 (defknown %simd-pack-singles (simd-pack)
235 (values single-float single-float single-float single-float)
236 (flushable movable foldable))
237 (defknown %simd-pack-doubles (simd-pack)
238 (values double-float double-float)
239 (flushable movable foldable)))
243 (defknown (dynamic-space-free-pointer binding-stack-pointer-sap
244 control-stack-pointer-sap) ()
248 ;;;; debugger support
250 (defknown current-sp () system-area-pointer (movable flushable))
251 (defknown current-fp () system-area-pointer (movable flushable))
252 (defknown stack-ref (system-area-pointer index) t (flushable))
253 (defknown %set-stack-ref (system-area-pointer index t) t ())
254 (defknown lra-code-header (t) t (movable flushable))
255 (defknown fun-code-header (t) t (movable flushable))
256 (defknown %make-lisp-obj (sb!vm:word) t (movable flushable))
257 (defknown get-lisp-obj-address (t) sb!vm:word (movable flushable))
258 (defknown fun-word-offset (function) index (movable flushable))
260 ;;;; 32-bit logical operations
262 (defknown word-logical-not (sb!vm:word) sb!vm:word
263 (foldable flushable movable))
265 (defknown (word-logical-and word-logical-nand
266 word-logical-or word-logical-nor
267 word-logical-xor word-logical-eqv
268 word-logical-andc1 word-logical-andc2
269 word-logical-orc1 word-logical-orc2)
270 (sb!vm:word sb!vm:word) sb!vm:word
271 (foldable flushable movable))
273 (defknown (shift-towards-start shift-towards-end) (sb!vm:word fixnum)
275 (foldable flushable movable))
277 ;;;; bignum operations
279 (defknown %allocate-bignum (bignum-index) bignum-type
282 (defknown %bignum-length (bignum-type) bignum-index
283 (foldable flushable movable))
285 (defknown %bignum-set-length (bignum-type bignum-index) bignum-type
288 (defknown %bignum-ref (bignum-type bignum-index) bignum-element-type
291 (defknown %bignum-ref-with-offset (bignum-type fixnum (signed-byte 24))
292 bignum-element-type (flushable always-translatable))
294 (defknown %bignum-set (bignum-type bignum-index bignum-element-type)
298 (defknown %digit-0-or-plusp (bignum-element-type) boolean
299 (foldable flushable movable))
301 (defknown (%add-with-carry %subtract-with-borrow)
302 (bignum-element-type bignum-element-type (mod 2))
303 (values bignum-element-type (mod 2))
304 (foldable flushable movable))
306 (defknown %multiply-and-add
307 (bignum-element-type bignum-element-type bignum-element-type
308 &optional bignum-element-type)
309 (values bignum-element-type bignum-element-type)
310 (foldable flushable movable))
312 (defknown %multiply (bignum-element-type bignum-element-type)
313 (values bignum-element-type bignum-element-type)
314 (foldable flushable movable))
316 (defknown %lognot (bignum-element-type) bignum-element-type
317 (foldable flushable movable))
319 (defknown (%logand %logior %logxor) (bignum-element-type bignum-element-type)
321 (foldable flushable movable))
323 (defknown %fixnum-to-digit (fixnum) bignum-element-type
324 (foldable flushable movable))
326 (defknown %bigfloor (bignum-element-type bignum-element-type bignum-element-type)
327 (values bignum-element-type bignum-element-type)
328 (foldable flushable movable))
330 (defknown %fixnum-digit-with-correct-sign (bignum-element-type)
331 (signed-byte #.sb!vm:n-word-bits)
332 (foldable flushable movable))
334 (defknown (%ashl %ashr %digit-logical-shift-right)
335 (bignum-element-type (mod #.sb!vm:n-word-bits)) bignum-element-type
336 (foldable flushable movable))
338 ;;;; bit-bashing routines
340 ;;; FIXME: there's some ugly duplication between the (INTERN (FORMAT ...))
341 ;;; magic here and the same magic in src/code/bit-bash.lisp. I don't know
342 ;;; of any good way to clean it up, but it's definitely violating OAOO.
343 (macrolet ((define-known-copiers ()
345 ,@(loop for i = 1 then (* i 2)
346 collect `(defknown ,(intern (format nil "UB~D-BASH-COPY" i)
347 (find-package "SB!KERNEL"))
348 ((simple-unboxed-array (*)) index (simple-unboxed-array (*)) index index)
351 collect `(defknown ,(intern (format nil "SYSTEM-AREA-UB~D-COPY" i)
352 (find-package "SB!KERNEL"))
353 (system-area-pointer index system-area-pointer index index)
356 collect `(defknown ,(intern (format nil "COPY-UB~D-TO-SYSTEM-AREA" i)
357 (find-package "SB!KERNEL"))
358 ((simple-unboxed-array (*)) index system-area-pointer index index)
361 collect `(defknown ,(intern (format nil "COPY-UB~D-FROM-SYSTEM-AREA" i)
362 (find-package "SB!KERNEL"))
363 (system-area-pointer index (simple-unboxed-array (*)) index index)
366 until (= i sb!vm:n-word-bits)))))
367 (define-known-copiers))
369 ;;; (not really a bit-bashing routine, but starting to take over from
370 ;;; bit-bashing routines in byte-sized copies as of sbcl-0.6.12.29:)
372 ((or (simple-unboxed-array (*)) system-area-pointer) index
373 (or (simple-unboxed-array (*)) system-area-pointer) index index)
377 ;;;; code/function/fdefn object manipulation routines
379 (defknown code-instructions (t) system-area-pointer (flushable movable))
380 (defknown code-header-ref (t index) t (flushable))
381 (defknown code-header-set (t index t) t ())
383 (defknown fun-subtype (function) (unsigned-byte #.sb!vm:n-widetag-bits)
385 (defknown ((setf fun-subtype))
386 ((unsigned-byte #.sb!vm:n-widetag-bits) function)
387 (unsigned-byte #.sb!vm:n-widetag-bits)
390 (defknown make-fdefn (t) fdefn (flushable movable))
391 (defknown fdefn-p (t) boolean (movable foldable flushable))
392 (defknown fdefn-name (fdefn) t (foldable flushable))
393 (defknown fdefn-fun (fdefn) (or function null) (flushable))
394 (defknown (setf fdefn-fun) (function fdefn) t ())
395 (defknown fdefn-makunbound (fdefn) t ())
397 (defknown %simple-fun-self (function) function
399 (defknown (setf %simple-fun-self) (function function) function
402 (defknown %closure-fun (function) function
405 (defknown %closure-index-ref (function index) t
408 (defknown %make-funcallable-instance (index) function
411 (defknown %funcallable-instance-info (function index) t (flushable))
412 (defknown %set-funcallable-instance-info (function index t) t ())
415 (defknown %data-vector-and-index (array index)
416 (values (simple-array * (*)) index)
417 (foldable flushable))