1 ;;;; This file contains portable versions of low-level functions and macros
2 ;;;; which are ripe for implementation specific customization. None of the code
3 ;;;; in this file *has* to be customized for a particular Common Lisp
4 ;;;; implementation. Moreover, in some implementations it may not make any
5 ;;;; sense to customize some of this code.
7 ;;;; The original version was intended to support portable customization to
8 ;;;; lotso different Lisp implementations. This functionality is gone in the
9 ;;;; current version, and it now runs only under SBCL. (Now that ANSI Common
10 ;;;; Lisp has mixed CLOS into the insides of the system (e.g. error handling
11 ;;;; and printing) so deeply that it's not very meaningful to bootstrap Common
12 ;;;; Lisp without CLOS, the old functionality is of dubious use. -- WHN
15 ;;;; This software is part of the SBCL system. See the README file for more
18 ;;;; This software is derived from software originally released by Xerox
19 ;;;; Corporation. Copyright and release statements follow. Later modifications
20 ;;;; to the software are in the public domain and are provided with
21 ;;;; absolutely no warranty. See the COPYING and CREDITS files for more
24 ;;;; copyright information from original PCL sources:
26 ;;;; Copyright (c) 1985, 1986, 1987, 1988, 1989, 1990 Xerox Corporation.
27 ;;;; All rights reserved.
29 ;;;; Use and copying of this software and preparation of derivative works based
30 ;;;; upon this software are permitted. Any distribution of this software or
31 ;;;; derivative works must comply with all applicable United States export
34 ;;;; This software is made available AS IS, and Xerox Corporation makes no
35 ;;;; warranty about the software, its performance or its conformity to any
40 (eval-when (:compile-toplevel
:load-toplevel
:execute
)
41 (defvar *optimize-speed
*
42 '(optimize (speed 3) (safety 0) (sb-ext:inhibit-warnings
3)))
45 (defmacro dotimes-fixnum
((var count
&optional
(result nil
)) &body body
)
46 `(dotimes (,var
(the fixnum
,count
) ,result
)
47 (declare (fixnum ,var
))
50 (declaim (inline random-fixnum
))
51 (defun random-fixnum ()
52 (random (1+ most-positive-fixnum
)))
54 ;;; Lambda which executes its body (or not) randomly. Used to drop
55 ;;; random cache entries.
56 (defmacro randomly-punting-lambda
(lambda-list &body body
)
57 (with-unique-names (drops drop-pos
)
58 `(let ((,drops
(random-fixnum))
59 (,drop-pos sb-vm
:n-fixnum-bits
))
60 (declare (fixnum ,drops
)
61 (type (integer 0 #.sb-vm
:n-fixnum-bits
) ,drop-pos
))
63 (when (logbitp (the unsigned-byte
(decf ,drop-pos
)) ,drops
)
65 (when (zerop ,drop-pos
)
66 (setf ,drops
(random-fixnum)
67 ,drop-pos sb-vm
:n-fixnum-bits
))))))
69 ;;;; PCL's view of funcallable instances
71 (!defstruct-with-alternate-metaclass standard-funcallable-instance
72 ;; KLUDGE: Note that neither of these slots is ever accessed by its
73 ;; accessor name as of sbcl-0.pre7.63. Presumably everything works
74 ;; by puns based on absolute locations. Fun fun fun.. -- WHN 2001-10-30
75 :slot-names
(clos-slots name hash-code
)
76 :boa-constructor %make-standard-funcallable-instance
77 :superclass-name function
78 :metaclass-name standard-classoid
79 :metaclass-constructor make-standard-classoid
80 :dd-type funcallable-structure
81 ;; Only internal implementation code will access these, and these
82 ;; accesses (slot readers in particular) could easily be a
83 ;; bottleneck, so it seems reasonable to suppress runtime type
86 ;; (Except note KLUDGE above that these accessors aren't used at all
87 ;; (!) as of sbcl-0.pre7.63, so for now it's academic.)
88 :runtime-type-checks-p nil
)
90 (import 'sb-kernel
:funcallable-instance-p
)
92 (defun set-funcallable-instance-function (fin new-value
)
93 (declare (type function new-value
)
94 ;; KLUDGE: it might be nice to restrict
95 ;; SB-MOP:SET-FUNCALLABLE-INSTANCE-FUNCTION to operate only
96 ;; on generalized instances of
97 ;; SB-MOP:FUNCALLABLE-STANDARD-OBJECT; at present, even
98 ;; PCL's internal use of SET-FUNCALLABLE-INSTANCE-FUNCTION
99 ;; doesn't obey this restriction.
100 (type funcallable-instance fin
))
101 (setf (funcallable-instance-fun fin
) new-value
))
103 ;;; FIXME: these macros should just go away. It's not clear whether
104 ;;; the inline functions defined by
105 ;;; !DEFSTRUCT-WITH-ALTERNATE-METACLASS are as efficient as they could
106 ;;; be; ordinary defstruct accessors are defined as source transforms.
107 (defun fsc-instance-p (fin)
108 (funcallable-instance-p fin
))
109 (define-compiler-macro fsc-instance-p
(fin)
110 `(funcallable-instance-p ,fin
))
111 (defmacro fsc-instance-wrapper
(fin)
112 `(%funcallable-instance-layout
,fin
))
113 (defmacro fsc-instance-slots
(fin)
114 `(%funcallable-instance-info
,fin
1))
115 (defmacro fsc-instance-hash
(fin)
116 `(%funcallable-instance-info
,fin
3))
118 (declaim (inline clos-slots-ref
(setf clos-slots-ref
)))
119 (declaim (ftype (function (simple-vector index
) t
) clos-slots-ref
))
120 (defun clos-slots-ref (slots index
)
122 (declaim (ftype (function (t simple-vector index
) t
) (setf clos-slots-ref
)))
123 (defun (setf clos-slots-ref
) (new-value slots index
)
124 (setf (svref slots index
) new-value
))
126 ;;; Note on implementation under CMU CL >=17 and SBCL: STD-INSTANCE-P
127 ;;; is only used to discriminate between functions (including FINs)
128 ;;; and normal instances, so we can return true on structures also. A
129 ;;; few uses of (OR STD-INSTANCE-P FSC-INSTANCE-P) are changed to
131 (defun std-instance-p (x)
133 (define-compiler-macro std-instance-p
(x)
136 ;; a temporary definition used for debugging the bootstrap
138 (defun print-std-instance (instance stream depth
)
139 (declare (ignore depth
))
140 (print-unreadable-object (instance stream
:type t
:identity t
)
141 (let ((class (class-of instance
)))
142 (when (or (eq class
(find-class 'standard-class nil
))
143 (eq class
(find-class 'funcallable-standard-class nil
))
144 (eq class
(find-class 'system-class nil
))
145 (eq class
(find-class 'built-in-class nil
)))
146 (princ (early-class-name instance
) stream
)))))
148 ;;; This is the value that we stick into a slot to tell us that it is
149 ;;; unbound. It may seem gross, but for performance reasons, we make
150 ;;; this an interned symbol. That means that the fast check to see
151 ;;; whether a slot is unbound is to say (EQ <val> '..SLOT-UNBOUND..).
152 ;;; That is considerably faster than looking at the value of a special
155 ;;; It seems only reasonable to also export this for users, since
156 ;;; otherwise dealing with STANDARD-INSTANCE-ACCESS becomes harder
157 ;;; -- and slower -- than it needs to be.
158 (defconstant +slot-unbound
+ '..slot-unbound..
160 "SBCL specific extensions to MOP: if this value is read from an
161 instance using STANDARD-INSTANCE-ACCESS, the slot is unbound.
162 Similarly, an :INSTANCE allocated slot can be made unbound by
163 assigning this to it using (SETF STANDARD-INSTANCE-ACCESS).
165 Value of +SLOT-UNBOUND+ is unspecified, and should not be relied to be
166 of any particular type, but it is guaranteed to be suitable for EQ
169 (defmacro %allocate-static-slot-storage--class
(no-of-slots)
170 `(make-array ,no-of-slots
:initial-element
+slot-unbound
+))
172 (defmacro std-instance-class
(instance)
173 `(wrapper-class* (std-instance-wrapper ,instance
)))
175 ;;; When given a funcallable instance, SET-FUN-NAME *must* side-effect
176 ;;; that FIN to give it the name. When given any other kind of
177 ;;; function SET-FUN-NAME is allowed to return a new function which is
178 ;;; "the same" except that it has the name.
180 ;;; In all cases, SET-FUN-NAME must return the new (or same)
181 ;;; function. (Unlike other functions to set stuff, it does not return
183 (declaim (ftype function class-of
))
184 (defun set-fun-name (fun new-name
)
186 "Set the name of a compiled function object. Return the function."
187 (when (valid-function-name-p fun
)
188 (setq fun
(fdefinition fun
)))
190 (%method-function
(setf (%method-function-name fun
) new-name
))
192 (sb-eval:interpreted-function
193 (setf (sb-eval:interpreted-function-name fun
) new-name
))
194 (funcallable-instance ;; KLUDGE: probably a generic function...
195 (cond ((if (eq **boot-state
** 'complete
)
196 (typep fun
'generic-function
) ; FIXME: inefficient forward-ref
197 (eq (class-of fun
) *the-class-standard-generic-function
*))
198 (setf (%funcallable-instance-info fun
2) new-name
))
200 (bug "unanticipated function type")))))
201 ;; Fixup name-to-function mappings in cases where the function
202 ;; hasn't been defined by DEFUN. (FIXME: is this right? This logic
203 ;; comes from CMUCL). -- CSR, 2004-12-31
204 (when (and (consp new-name
)
205 (member (car new-name
) '(slow-method fast-method slot-accessor
)))
206 (setf (fdefinition new-name
) fun
))
209 ;;; FIXME: probably no longer needed after init
210 (defmacro precompile-random-code-segments
(&optional system
)
212 (eval-when (:compile-toplevel
)
213 (update-dispatch-dfuns))
214 (precompile-function-generators ,system
)
215 (precompile-dfun-constructors ,system
)
218 ;;; Return true of any object which is either a funcallable-instance,
219 ;;; or an ordinary instance that is not a structure-object.
220 ;;; This definition is for interpreted code.
221 (defun pcl-instance-p (x)
222 (layout-for-std-class-p (layout-of x
)))
225 ;;; We define this as STANDARD-INSTANCE, since we're going to
226 ;;; clobber the layout with some standard-instance layout as soon as
227 ;;; we make it, and we want the accessor to still be type-correct.
229 (defstruct (standard-instance
231 (:constructor %%allocate-instance--class
())
233 (:alternate-metaclass instance
235 make-standard-class
))
238 (!defstruct-with-alternate-metaclass standard-instance
239 :slot-names
(slots hash-code
)
240 :boa-constructor %make-standard-instance
242 :metaclass-name standard-classoid
243 :metaclass-constructor make-standard-classoid
245 :runtime-type-checks-p nil
)
247 ;;; Both of these operations "work" on structures, which allows the above
248 ;;; weakening of STD-INSTANCE-P.
249 (defmacro std-instance-slots
(x) `(%instance-ref
,x
1))
250 (defmacro std-instance-wrapper
(x) `(%instance-layout
,x
))
251 ;;; KLUDGE: This one doesn't "work" on structures. However, we
252 ;;; ensure, in SXHASH and friends, never to call it on structures.
253 (defmacro std-instance-hash
(x) `(%instance-ref
,x
2))
255 ;;; FIXME: These functions are called every place we do a
256 ;;; CALL-NEXT-METHOD, and probably other places too. It's likely worth
257 ;;; selectively optimizing them with DEFTRANSFORMs and stuff, rather
258 ;;; than just indiscriminately expanding them inline everywhere.
259 (declaim (inline get-slots get-slots-or-nil
))
260 (declaim (ftype (function (t) simple-vector
) get-slots
))
261 (declaim (ftype (function (t) (or simple-vector null
)) get-slots-or-nil
))
262 (defun get-slots (instance)
263 (if (std-instance-p instance
)
264 (std-instance-slots instance
)
265 (fsc-instance-slots instance
)))
266 (defun get-slots-or-nil (instance)
267 ;; Suppress a code-deletion note. FIXME: doing the FIXME above,
268 ;; integrating PCL more with the compiler, would remove the need for
270 (declare (optimize (inhibit-warnings 3)))
271 (when (pcl-instance-p instance
)
272 (get-slots instance
)))
274 (defmacro get-wrapper
(inst)
275 (once-only ((wrapper `(layout-of ,inst
)))
277 (aver (layout-for-std-class-p ,wrapper
))
280 ;;;; support for useful hashing of PCL instances
282 (defvar *instance-hash-code-random-state
* (make-random-state))
283 (defun get-instance-hash-code ()
284 ;; ANSI SXHASH wants us to make a good-faith effort to produce
285 ;; hash-codes that are well distributed within the range of
286 ;; non-negative fixnums, and this RANDOM operation does that, unlike
287 ;; the sbcl<=0.8.16 implementation of this operation as
290 ;; Hopefully there was no virtue to the old counter implementation
291 ;; that I am insufficiently insightful to insee. -- WHN 2004-10-28
292 (random most-positive-fixnum
293 *instance-hash-code-random-state
*))
295 (defun sb-impl::sxhash-instance
(x)
297 ((std-instance-p x
) (std-instance-hash x
))
298 ((fsc-instance-p x
) (fsc-instance-hash x
))
299 (t (bug "SXHASH-INSTANCE called on some weird thing: ~S" x
))))
301 ;;;; structure-instance stuff
303 ;;;; FIXME: Now that the code is SBCL-only, this extra layer of
304 ;;;; abstraction around our native structure representation doesn't
305 ;;;; seem to add anything useful, and could probably go away.
307 ;;; The definition of STRUCTURE-TYPE-P was moved to early-low.lisp.
309 (defun structure-type-slot-description-list (type)
310 (let* ((dd (find-defstruct-description type
))
311 (include (dd-include dd
))
312 (all-slots (dd-slots dd
)))
313 (multiple-value-bind (super slot-overrides
)
315 (values (car include
) (mapcar #'car
(cdr include
)))
316 (values include nil
))
317 (let ((included-slots
319 (dd-slots (find-defstruct-description super
)))))
320 (loop for slot
= (pop all-slots
)
321 for included-slot
= (pop included-slots
)
323 when
(or (not included-slot
)
324 (member (dsd-name included-slot
) slot-overrides
:test
#'eq
))
327 (defun uninitialized-accessor-function (type slotd
)
329 (declare (ignore args
))
330 (error "~:(~A~) function~@[ for ~S ~] not yet initialized."
333 (defun structure-slotd-name (slotd)
336 (defun structure-slotd-accessor-symbol (slotd)
337 (dsd-accessor-name slotd
))
339 (defun structure-slotd-reader-function (slotd)
340 (let ((name (dsd-accessor-name slotd
)))
343 (uninitialized-accessor-function :reader slotd
))))
345 (defun structure-slotd-writer-function (type slotd
)
346 (if (dsd-read-only slotd
)
347 (let ((dd (find-defstruct-description type
)))
348 (coerce (slot-setter-lambda-form dd slotd
) 'function
))
349 (let ((name `(setf ,(dsd-accessor-name slotd
))))
352 (uninitialized-accessor-function :writer slotd
)))))
354 (defun structure-slotd-type (slotd)
357 (defun structure-slotd-init-form (slotd)
360 ;;; method function stuff.
362 ;;; PCL historically included a so-called method-fast-function, which
363 ;;; is essentially a method function but with (a) a precomputed
364 ;;; continuation for CALL-NEXT-METHOD and (b) a permutation vector for
365 ;;; slot access. [ FIXME: see if we can understand these two
366 ;;; optimizations before commit. ] However, the presence of the
367 ;;; fast-function meant that we violated AMOP and the effect of the
368 ;;; :FUNCTION initarg, and furthermore got to potentially confusing
369 ;;; situations where the function and the fast-function got out of
370 ;;; sync, so that calling (method-function method) with the defined
371 ;;; protocol would do different things from (call-method method) in
372 ;;; method combination.
374 ;;; So we define this internal method function structure, which we use
375 ;;; when we create a method function ourselves. This means that we
376 ;;; can hang the various bits of information that we want off the
377 ;;; method function itself, and also that if a user overrides method
378 ;;; function creation there is no danger of having the system get
380 (!defstruct-with-alternate-metaclass %method-function
381 :slot-names
(fast-function name
)
382 :boa-constructor %make-method-function
383 :superclass-name function
384 :metaclass-name static-classoid
385 :metaclass-constructor make-static-classoid
386 :dd-type funcallable-structure
)