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
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))
45 ;;;; miscellaneous "sub-primitives"
47 (defknown %sp-string-compare
48 (simple-string index index simple-string index index)
52 (defknown %sxhash-simple-string (simple-string) index
55 (defknown %sxhash-simple-substring (simple-string index) index
58 (defknown vector-length (vector) index (flushable))
60 (defknown vector-sap ((simple-unboxed-array (*))) system-area-pointer
63 (defknown lowtag-of (t) (unsigned-byte #.sb!vm:n-lowtag-bits)
65 (defknown widetag-of (t) (unsigned-byte #.sb!vm:n-widetag-bits)
68 (defknown (get-header-data get-closure-length) (t) (unsigned-byte 24)
70 (defknown set-header-data (t (unsigned-byte 24)) t
73 (defknown %array-dimension (t index) index
75 (defknown %set-array-dimension (t index index) index
77 (defknown %array-rank (t) index
80 (defknown %make-instance (index) instance
82 (defknown %instance-layout (instance) layout
84 (defknown %set-instance-layout (instance layout) layout
86 (defknown %instance-length (instance) index
88 (defknown %instance-ref (instance index) t
90 (defknown %instance-set (instance index t) t
92 (defknown %layout-invalid-error (t layout) nil)
95 (sb!xc:deftype raw-vector () '(simple-array (unsigned-byte 32) (*)))
97 (defknown %raw-ref-single (raw-vector index) single-float
99 (defknown %raw-ref-double (raw-vector index) double-float
100 (foldable flushable))
102 (defknown %raw-ref-long (raw-vector index) long-float
103 (foldable flushable))
104 (defknown %raw-set-single (raw-vector index single-float) single-float
106 (defknown %raw-set-double (raw-vector index double-float) double-float
109 (defknown %raw-set-long (raw-vector index long-float) long-float
112 (defknown %raw-ref-complex-single (raw-vector index) (complex single-float)
113 (foldable flushable))
114 (defknown %raw-ref-complex-double (raw-vector index) (complex double-float)
115 (foldable flushable))
117 (defknown %raw-ref-complex-long (raw-vector index) (complex long-float)
118 (foldable flushable))
119 (defknown %raw-set-complex-single (raw-vector index (complex single-float))
120 (complex single-float)
122 (defknown %raw-set-complex-double (raw-vector index (complex double-float))
123 (complex double-float)
126 (defknown %raw-set-complex-long (raw-vector index (complex long-float))
130 (defknown %raw-bits (t fixnum) (unsigned-byte 32)
131 (foldable flushable))
132 (defknown (%set-raw-bits) (t fixnum (unsigned-byte 32)) (unsigned-byte 32)
136 (defknown allocate-vector ((unsigned-byte 8) index index) (simple-array * (*))
139 (defknown make-array-header ((unsigned-byte 8) (unsigned-byte 24)) array
143 (defknown make-weak-pointer (t) weak-pointer
146 (defknown %make-complex (real real) complex
148 (defknown %make-ratio (rational rational) ratio
150 (defknown make-value-cell (t) t
153 (defknown (dynamic-space-free-pointer binding-stack-pointer-sap
154 control-stack-pointer-sap) ()
158 ;;;; debugger support
160 (defknown current-sp () system-area-pointer (movable flushable))
161 (defknown current-fp () system-area-pointer (movable flushable))
162 (defknown stack-ref (system-area-pointer index) t (flushable))
163 (defknown %set-stack-ref (system-area-pointer index t) t (unsafe))
164 (defknown lra-code-header (t) t (movable flushable))
165 (defknown fun-code-header (t) t (movable flushable))
166 (defknown make-lisp-obj ((unsigned-byte 32)) t (movable flushable))
167 (defknown get-lisp-obj-address (t) (unsigned-byte 32) (movable flushable))
168 (defknown fun-word-offset (function) index (movable flushable))
170 ;;;; 32-bit logical operations
172 (defknown merge-bits ((unsigned-byte 5) (unsigned-byte 32) (unsigned-byte 32))
174 (foldable flushable movable))
176 (defknown 32bit-logical-not ((unsigned-byte 32)) (unsigned-byte 32)
177 (foldable flushable movable))
179 (defknown (32bit-logical-and 32bit-logical-nand
180 32bit-logical-or 32bit-logical-nor
181 32bit-logical-xor 32bit-logical-eqv
182 32bit-logical-andc1 32bit-logical-andc2
183 32bit-logical-orc1 32bit-logical-orc2)
184 ((unsigned-byte 32) (unsigned-byte 32)) (unsigned-byte 32)
185 (foldable flushable movable))
187 (defknown (shift-towards-start shift-towards-end) ((unsigned-byte 32) fixnum)
189 (foldable flushable movable))
191 ;;;; bignum operations
193 (defknown %allocate-bignum (bignum-index) bignum-type
196 (defknown %bignum-length (bignum-type) bignum-index
197 (foldable flushable movable))
199 (defknown %bignum-set-length (bignum-type bignum-index) bignum-type
202 (defknown %bignum-ref (bignum-type bignum-index) bignum-element-type
205 (defknown %bignum-set (bignum-type bignum-index bignum-element-type)
209 (defknown %digit-0-or-plusp (bignum-element-type) boolean
210 (foldable flushable movable))
212 (defknown (%add-with-carry %subtract-with-borrow)
213 (bignum-element-type bignum-element-type (mod 2))
214 (values bignum-element-type (mod 2))
215 (foldable flushable movable))
217 (defknown %multiply-and-add
218 (bignum-element-type bignum-element-type bignum-element-type
219 &optional bignum-element-type)
220 (values bignum-element-type bignum-element-type)
221 (foldable flushable movable))
223 (defknown %multiply (bignum-element-type bignum-element-type)
224 (values bignum-element-type bignum-element-type)
225 (foldable flushable movable))
227 (defknown %lognot (bignum-element-type) bignum-element-type
228 (foldable flushable movable))
230 (defknown (%logand %logior %logxor) (bignum-element-type bignum-element-type)
232 (foldable flushable movable))
234 (defknown %fixnum-to-digit (fixnum) bignum-element-type
235 (foldable flushable movable))
237 (defknown %floor (bignum-element-type bignum-element-type bignum-element-type)
238 (values bignum-element-type bignum-element-type)
239 (foldable flushable movable))
241 (defknown %fixnum-digit-with-correct-sign (bignum-element-type)
242 (signed-byte #.sb!vm:n-word-bits)
243 (foldable flushable movable))
245 (defknown (%ashl %ashr %digit-logical-shift-right)
246 (bignum-element-type (mod 32)) bignum-element-type
247 (foldable flushable movable))
249 ;;;; bit-bashing routines
251 (defknown copy-to-system-area
252 ((simple-unboxed-array (*)) index system-area-pointer index index)
256 (defknown copy-from-system-area
257 (system-area-pointer index (simple-unboxed-array (*)) index index)
261 (defknown system-area-copy
262 (system-area-pointer index system-area-pointer index index)
266 (defknown bit-bash-copy
267 ((simple-unboxed-array (*)) index
268 (simple-unboxed-array (*)) index index)
272 ;;; (not really a bit-bashing routine, but starting to take over from
273 ;;; bit-bashing routines in byte-sized copies as of sbcl-0.6.12.29:)
275 ((or (simple-unboxed-array (*)) system-area-pointer) index
276 (or (simple-unboxed-array (*)) system-area-pointer) index index)
280 ;;;; code/function/fdefn object manipulation routines
282 (defknown code-instructions (t) system-area-pointer (flushable movable))
283 (defknown code-header-ref (t index) t (flushable))
284 (defknown code-header-set (t index t) t ())
286 (defknown fun-subtype (function) (unsigned-byte #.sb!vm:n-widetag-bits)
288 (defknown ((setf fun-subtype))
289 ((unsigned-byte #.sb!vm:n-widetag-bits) function)
290 (unsigned-byte #.sb!vm:n-widetag-bits)
293 (defknown make-fdefn (t) fdefn (flushable movable))
294 (defknown fdefn-p (t) boolean (movable foldable flushable))
295 (defknown fdefn-name (fdefn) t (foldable flushable))
296 (defknown fdefn-fun (fdefn) (or function null) (flushable))
297 (defknown (setf fdefn-fun) (function fdefn) t (unsafe))
298 (defknown fdefn-makunbound (fdefn) t ())
300 (defknown %simple-fun-self (function) function
302 (defknown (setf %simple-fun-self) (function function) function
305 (defknown %closure-fun (function) function
308 (defknown %closure-index-ref (function index) t
311 (defknown %make-funcallable-instance (index layout) function
314 (defknown %funcallable-instance-info (function index) t (flushable))
315 (defknown %set-funcallable-instance-info (function index t) t (unsafe))
317 ;;;; mutator accessors
319 (defknown mutator-self () system-area-pointer (flushable movable))
321 (defknown %data-vector-and-index (array index)
322 (values (simple-array * (*)) index)
323 (foldable flushable))