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 symbol-hash (symbol) (integer 0 #.sb!xc:most-positive-fixnum)
61 (defknown %set-symbol-hash (symbol (integer 0 #.sb!xc:most-positive-fixnum))
64 (defknown vector-length (vector) index (flushable))
66 (defknown vector-sap ((simple-unboxed-array (*))) system-area-pointer
69 (defknown lowtag-of (t) (unsigned-byte #.sb!vm:n-lowtag-bits)
71 (defknown widetag-of (t) (unsigned-byte #.sb!vm:n-widetag-bits)
74 (defknown (get-header-data get-closure-length) (t) (unsigned-byte 24)
76 (defknown set-header-data (t (unsigned-byte 24)) t
79 (defknown %array-dimension (t index) index
81 (defknown %set-array-dimension (t index index) index
83 (defknown %array-rank (t) index
86 (defknown %make-instance (index) instance
88 (defknown %instance-layout (instance) layout
90 (defknown %set-instance-layout (instance layout) layout
92 (defknown %instance-length (instance) index
94 (defknown %instance-ref (instance index) t
96 (defknown %instance-set (instance index t) t
98 (defknown %layout-invalid-error (t layout) nil)
101 (sb!xc:deftype raw-vector () '(simple-array (unsigned-byte 32) (*)))
103 (defknown %raw-ref-single (raw-vector index) single-float
104 (foldable flushable))
105 (defknown %raw-ref-double (raw-vector index) double-float
106 (foldable flushable))
108 (defknown %raw-ref-long (raw-vector index) long-float
109 (foldable flushable))
110 (defknown %raw-set-single (raw-vector index single-float) single-float
112 (defknown %raw-set-double (raw-vector index double-float) double-float
115 (defknown %raw-set-long (raw-vector index long-float) long-float
118 (defknown %raw-ref-complex-single (raw-vector index) (complex single-float)
119 (foldable flushable))
120 (defknown %raw-ref-complex-double (raw-vector index) (complex double-float)
121 (foldable flushable))
123 (defknown %raw-set-complex-single (raw-vector index (complex single-float))
124 (complex single-float)
126 (defknown %raw-set-complex-double (raw-vector index (complex double-float))
127 (complex double-float)
131 (defknown %raw-bits (t fixnum) (unsigned-byte 32)
132 (foldable flushable))
133 (defknown (%set-raw-bits) (t fixnum (unsigned-byte 32)) (unsigned-byte 32)
137 (defknown allocate-vector ((unsigned-byte 8) index index) (simple-array * (*))
140 (defknown make-array-header ((unsigned-byte 8) (unsigned-byte 24)) array
144 (defknown make-weak-pointer (t) weak-pointer
147 (defknown %make-complex (real real) complex
149 (defknown %make-ratio (rational rational) ratio
151 (defknown make-value-cell (t) t
154 (defknown (dynamic-space-free-pointer binding-stack-pointer-sap
155 control-stack-pointer-sap) ()
159 ;;;; debugger support
161 (defknown current-sp () system-area-pointer (movable flushable))
162 (defknown current-fp () system-area-pointer (movable flushable))
163 (defknown stack-ref (system-area-pointer index) t (flushable))
164 (defknown %set-stack-ref (system-area-pointer index t) t (unsafe))
165 (defknown lra-code-header (t) t (movable flushable))
166 (defknown fun-code-header (t) t (movable flushable))
167 (defknown make-lisp-obj ((unsigned-byte 32)) t (movable flushable))
168 (defknown get-lisp-obj-address (t) (unsigned-byte 32) (movable flushable))
169 (defknown fun-word-offset (function) index (movable flushable))
171 ;;;; 32-bit logical operations
173 (defknown merge-bits ((unsigned-byte 5) (unsigned-byte 32) (unsigned-byte 32))
175 (foldable flushable movable))
177 (defknown 32bit-logical-not ((unsigned-byte 32)) (unsigned-byte 32)
178 (foldable flushable movable))
180 (defknown (32bit-logical-and 32bit-logical-nand
181 32bit-logical-or 32bit-logical-nor
182 32bit-logical-xor 32bit-logical-eqv
183 32bit-logical-andc1 32bit-logical-andc2
184 32bit-logical-orc1 32bit-logical-orc2)
185 ((unsigned-byte 32) (unsigned-byte 32)) (unsigned-byte 32)
186 (foldable flushable movable))
188 (defknown (shift-towards-start shift-towards-end) ((unsigned-byte 32) fixnum)
190 (foldable flushable movable))
192 ;;;; bignum operations
194 (defknown %allocate-bignum (bignum-index) bignum-type
197 (defknown %bignum-length (bignum-type) bignum-index
198 (foldable flushable movable))
200 (defknown %bignum-set-length (bignum-type bignum-index) bignum-type
203 (defknown %bignum-ref (bignum-type bignum-index) bignum-element-type
206 (defknown %bignum-set (bignum-type bignum-index bignum-element-type)
210 (defknown %digit-0-or-plusp (bignum-element-type) boolean
211 (foldable flushable movable))
213 (defknown (%add-with-carry %subtract-with-borrow)
214 (bignum-element-type bignum-element-type (mod 2))
215 (values bignum-element-type (mod 2))
216 (foldable flushable movable))
218 (defknown %multiply-and-add
219 (bignum-element-type bignum-element-type bignum-element-type
220 &optional bignum-element-type)
221 (values bignum-element-type bignum-element-type)
222 (foldable flushable movable))
224 (defknown %multiply (bignum-element-type bignum-element-type)
225 (values bignum-element-type bignum-element-type)
226 (foldable flushable movable))
228 (defknown %lognot (bignum-element-type) bignum-element-type
229 (foldable flushable movable))
231 (defknown (%logand %logior %logxor) (bignum-element-type bignum-element-type)
233 (foldable flushable movable))
235 (defknown %fixnum-to-digit (fixnum) bignum-element-type
236 (foldable flushable movable))
238 (defknown %floor (bignum-element-type bignum-element-type bignum-element-type)
239 (values bignum-element-type bignum-element-type)
240 (foldable flushable movable))
242 (defknown %fixnum-digit-with-correct-sign (bignum-element-type)
243 (signed-byte #.sb!vm:n-word-bits)
244 (foldable flushable movable))
246 (defknown (%ashl %ashr %digit-logical-shift-right)
247 (bignum-element-type (mod 32)) bignum-element-type
248 (foldable flushable movable))
250 ;;;; bit-bashing routines
252 (defknown copy-to-system-area
253 ((simple-unboxed-array (*)) index system-area-pointer index index)
257 (defknown copy-from-system-area
258 (system-area-pointer index (simple-unboxed-array (*)) index index)
262 (defknown system-area-copy
263 (system-area-pointer index system-area-pointer index index)
267 (defknown bit-bash-copy
268 ((simple-unboxed-array (*)) index
269 (simple-unboxed-array (*)) index index)
273 ;;; (not really a bit-bashing routine, but starting to take over from
274 ;;; bit-bashing routines in byte-sized copies as of sbcl-0.6.12.29:)
276 ((or (simple-unboxed-array (*)) system-area-pointer) index
277 (or (simple-unboxed-array (*)) system-area-pointer) index index)
281 ;;;; code/function/fdefn object manipulation routines
283 (defknown code-instructions (t) system-area-pointer (flushable movable))
284 (defknown code-header-ref (t index) t (flushable))
285 (defknown code-header-set (t index t) t ())
287 (defknown fun-subtype (function) (unsigned-byte #.sb!vm:n-widetag-bits)
289 (defknown ((setf fun-subtype))
290 ((unsigned-byte #.sb!vm:n-widetag-bits) function)
291 (unsigned-byte #.sb!vm:n-widetag-bits)
294 (defknown make-fdefn (t) fdefn (flushable movable))
295 (defknown fdefn-p (t) boolean (movable foldable flushable))
296 (defknown fdefn-name (fdefn) t (foldable flushable))
297 (defknown fdefn-fun (fdefn) (or function null) (flushable))
298 (defknown (setf fdefn-fun) (function fdefn) t (unsafe))
299 (defknown fdefn-makunbound (fdefn) t ())
301 (defknown %simple-fun-self (function) function
303 (defknown (setf %simple-fun-self) (function function) function
306 (defknown %closure-fun (function) function
309 (defknown %closure-index-ref (function index) t
312 (defknown %make-funcallable-instance (index layout) function
315 (defknown %funcallable-instance-info (function index) t (flushable))
316 (defknown %set-funcallable-instance-info (function index t) t (unsafe))
318 ;;;; mutator accessors
320 (defknown mutator-self () system-area-pointer (flushable movable))
322 (defknown %data-vector-and-index (array index)
323 (values (simple-array * (*)) index)
324 (foldable flushable))