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