0.6.7.22: removed CVS dollar-Header-dollar tags from sources
[sbcl.git] / src / code / fop.lisp
1 ;;;; FOP definitions
2
3 (in-package "SB!IMPL")
4
5 ;;; Define NAME as a fasl operation, with op-code FOP-CODE. PUSHP
6 ;;; describes what the body does to the fop stack:
7 ;;;   :NOPE
8 ;;;     The body neither pushes or pops the fop stack.
9 ;;;   T
10 ;;;     The body might pop the fop stack. The result of the body is 
11 ;;;     pushed on the fop stack.
12 ;;;   NIL
13 ;;;     The body might pop the fop stack. The result of the body is
14 ;;;     discarded.
15 ;;;
16 ;;; FIXME: Make PUSHP into a &KEY argument accepting a booleana value.
17 ;;; Handle the :PUSHP :NOPE case with a separate :STACKP NIL argument,
18 ;;; meaning "the body doesn't interact with the FOP stack."
19 (defmacro define-fop ((name fop-code &optional (pushp t)) &rest forms)
20   `(progn
21      (defun ,name ()
22        ,(if (eq pushp :nope)
23           `(progn ,@forms)
24           `(with-fop-stack ,pushp ,@forms)))
25      (%define-fop ',name ,fop-code)))
26
27 ;;; FIXME: This can be byte coded.
28 (defun %define-fop (name code)
29   (let ((oname (svref *fop-names* code)))
30     (when (and oname (not (eq oname name)))
31       (error "multiple names for fop code ~D: ~S and ~S" code name oname)))
32   ;; KLUDGE: It's mnemonically suboptimal to use 'FOP-CODE as the name of the
33   ;; tag which associates names with codes when it's also used as one of
34   ;; the names. Perhaps the fops named FOP-CODE and FOP-SMALL-CODE could
35   ;; be renamed to something more mnemonic? -- WHN 19990902
36   (let ((ocode (get name 'fop-code)))
37     (when (and ocode (/= ocode code))
38       (error "multiple codes for fop name ~S: ~D and ~D" name code ocode)))
39   (setf (svref *fop-names* code) name
40         (get name 'fop-code) code
41         (svref *fop-functions* code) (symbol-function name))
42   (values))
43
44 ;;; Define a pair of fops which are identical except that one reads
45 ;;; a four-byte argument while the other reads a one-byte argument. The
46 ;;; argument can be accessed by using the Clone-Arg macro.
47 ;;;
48 ;;; KLUDGE: It would be nice if the definition here encapsulated which
49 ;;; value ranges went with which fop variant, and chose the correct
50 ;;; fop code to use. Currently, since such logic isn't encapsulated,
51 ;;; we see callers doing stuff like
52 ;;;     (cond ((and (< num-consts #x100) (< total-length #x10000))
53 ;;;            (dump-fop 'sb!impl::fop-small-code file)
54 ;;;            (dump-byte num-consts file)
55 ;;;            (dump-integer-as-n-bytes total-length 2 file))
56 ;;;           (t
57 ;;;            (dump-fop 'sb!impl::fop-code file)
58 ;;;            (dump-unsigned-32 num-consts file)
59 ;;;            (dump-unsigned-32 total-length file))))
60 ;;; in several places. It would be cleaner if this could be replaced with
61 ;;; something like
62 ;;;     (dump-fop file fop-code num-consts total-length)
63 ;;; Some of this logic is already in DUMP-FOP*, but that still requires the
64 ;;; caller to know that it's a 1-byte-arg/4-byte-arg cloned fop pair, and to
65 ;;; know both the 1-byte-arg and the 4-byte-arg fop names. -- WHN 19990902
66 (defmacro define-cloned-fops ((name code &optional (pushp t))
67                               (small-name small-code) &rest forms)
68   (check-type pushp (member nil t :nope))
69   `(progn
70      (macrolet ((clone-arg () '(read-arg 4)))
71        (define-fop (,name ,code ,pushp) ,@forms))
72      (macrolet ((clone-arg () '(read-arg 1)))
73        (define-fop (,small-name ,small-code ,pushp) ,@forms))))
74
75 ;;; a helper function for reading string values from FASL files: sort of like
76 ;;; READ-SEQUENCE specialized for files of (UNSIGNED-BYTE 8), with an automatic
77 ;;; conversion from (UNSIGNED-BYTE 8) into CHARACTER for each element read
78 (declaim (ftype (function (stream simple-string &optional index) (values)) read-string-as-bytes))
79 (defun read-string-as-bytes (stream string &optional (length (length string)))
80   (dotimes (i length)
81     (setf (aref string i)
82           (code-char (read-byte stream))))
83   ;; FIXME: The classic CMU CL code to do this was
84   ;;   (READ-N-BYTES FILE STRING START END).
85   ;; It was changed for SBCL because we needed a portable version for
86   ;; bootstrapping. Benchmark the non-portable version and see whether it's
87   ;; significantly better than the portable version here. If it is, then use
88   ;; add as an alternate definition, protected with #-SB-XC-HOST.
89   (values))
90 \f
91 ;;;; miscellaneous fops
92
93 ;;; FIXME: POP-STACK should be called something more mnemonic. (POP-FOP-STACK?
94 ;;; But that would conflict with PUSH-FOP-TABLE. Something, anyway..)
95
96 ;;; Setting this variable causes execution of a FOP-NOP4 to produce
97 ;;; output to *DEBUG-IO*. This can be handy when trying to follow the
98 ;;; progress of FASLOAD.
99 #!+sb-show
100 (defvar *show-fop-nop4-p* nil)
101
102 ;;; CMU CL had a single no-op fop, FOP-NOP, with fop code 0. Since 0 occurs
103 ;;; disproportionately often in fasl files for other reasons, FOP-NOP is less
104 ;;; than ideal for writing human-readable patterns into fasl files for
105 ;;; debugging purposes. There's no shortage of unused fop codes, so we add this
106 ;;; second NOP, which reads 4 arbitrary bytes and discards them.
107 (define-fop (fop-nop4 137 :nope)
108   (let ((arg (read-arg 4)))
109     (declare (ignorable arg))
110     #!+sb-show
111     (when *show-fop-nop4-p*
112       (format *debug-io* "~&/FOP-NOP4 ARG=~D=#X~X~%" arg arg))))
113
114 (define-fop (fop-nop 0 :nope))
115 (define-fop (fop-pop 1 nil) (push-fop-table (pop-stack)))
116 (define-fop (fop-push 2) (svref *current-fop-table* (read-arg 4)))
117 (define-fop (fop-byte-push 3) (svref *current-fop-table* (read-arg 1)))
118
119 (define-fop (fop-empty-list 4) ())
120 (define-fop (fop-truth 5) t)
121 ;;; CMU CL had FOP-POP-FOR-EFFECT as fop 65, but it was never used and seemed
122 ;;; to have no possible use.
123 (define-fop (fop-misc-trap 66)
124   #+sb-xc-host ; since xc host doesn't know how to compile %PRIMITIVE
125   (error "FOP-MISC-TRAP can't be defined without %PRIMITIVE.")
126   #-sb-xc-host
127   (%primitive sb!c:make-other-immediate-type 0 sb!vm:unbound-marker-type))
128
129 (define-fop (fop-character 68)
130   (code-char (read-arg 3)))
131 ;;; CMU CL had FOP-CHARACTER as fop 68, but it's not needed in current
132 ;;; SBCL as we have no extended characters, only 1-byte characters.
133 ;;; (Ditto for CMU CL, actually: FOP-CHARACTER was speculative generality.)
134 (define-fop (fop-short-character 69)
135   (code-char (read-arg 1)))
136
137 (define-cloned-fops (fop-struct 48) (fop-small-struct 49)
138   (let* ((size (clone-arg))
139          (res (%make-instance size)))
140     (declare (type index size))
141     (do ((n (1- size) (1- n)))
142         ((minusp n))
143       (declare (type (integer -1 #.most-positive-fixnum) n))
144       (setf (%instance-ref res n) (pop-stack)))
145     res))
146
147 (define-fop (fop-layout 45)
148   (let ((length (pop-stack))
149         (depthoid (pop-stack))
150         (inherits (pop-stack))
151         (name (pop-stack)))
152     (find-and-init-or-check-layout name length inherits depthoid)))
153
154 (define-fop (fop-end-group 64 :nope)
155   (throw 'fasl-group-end t))
156
157 ;;; In the normal loader, we just ignore these. GENESIS overwrites
158 ;;; FOP-MAYBE-COLD-LOAD with something that knows whether to revert to
159 ;;; cold-loading or not.
160 (define-fop (fop-normal-load 81 :nope))
161 (define-fop (fop-maybe-cold-load 82 :nope))
162
163 (define-fop (fop-verify-table-size 62 :nope)
164   (let ((expected-index (read-arg 4)))
165     (unless (= *current-fop-table-index* expected-index)
166       (error "internal error: fasl table of improper size"))))
167 (define-fop (fop-verify-empty-stack 63 :nope)
168   (unless (= *fop-stack-pointer* *fop-stack-pointer-on-entry*)
169     (error "internal error: fasl stack not empty when it should be")))
170 \f
171 ;;;; fops for loading symbols
172
173 (defvar *load-symbol-buffer* (make-string 100))
174 (declaim (simple-string *load-symbol-buffer*))
175 (defvar *load-symbol-buffer-size* 100)
176 (declaim (type index *load-symbol-buffer-size*))
177 ;;; FIXME:
178 ;;;   (1) *LOAD-SYMBOL-BUFFER-SIZE* is redundant, should just be
179 ;;;       (LENGTH *LOAD-SYMBOL-BUFFER*).
180 ;;;   (2) *LOAD-SYMBOL-BUFFER* should not have a global value, but should
181 ;;;       be bound on entry to FASLOAD, and it should be renamed to
182 ;;;       *FASLOAD-SYMBOL-BUFFER*.
183
184 (macrolet (;; FIXME: Should all this code really be duplicated inside
185            ;; each fop? Perhaps it would be better for this shared
186            ;; code to live in FLET FROB1 and FLET FROB4 (for the
187            ;; two different sizes of counts).
188            (frob (name code name-size package)
189              (let ((n-package (gensym))
190                    (n-size (gensym))
191                    (n-buffer (gensym)))
192                `(define-fop (,name ,code)
193                   (prepare-for-fast-read-byte *fasl-file*
194                     (let ((,n-package ,package)
195                           (,n-size (fast-read-u-integer ,name-size)))
196                       (when (> ,n-size *load-symbol-buffer-size*)
197                         (setq *load-symbol-buffer*
198                               (make-string (setq *load-symbol-buffer-size*
199                                                  (* ,n-size 2)))))
200                       (done-with-fast-read-byte)
201                       (let ((,n-buffer *load-symbol-buffer*))
202                         (read-string-as-bytes *fasl-file*
203                                               ,n-buffer
204                                               ,n-size)
205                         (push-fop-table (intern* ,n-buffer
206                                                  ,n-size
207                                                  ,n-package)))))))))
208
209   ;; Note: CMU CL had FOP-SYMBOL-SAVE and FOP-SMALL-SYMBOL-SAVE, but since they
210   ;; made the behavior of the fasloader depend on the *PACKAGE* variable, not
211   ;; only were they a pain to support (because they required various hacks to
212   ;; handle *PACKAGE*-manipulation forms) they were basically broken by design,
213   ;; because ANSI gives the user so much flexibility in manipulating *PACKAGE*
214   ;; at load-time that no reasonable hacks could possibly make things work
215   ;; right. The ones used in CMU CL certainly didn't, as shown by e.g.
216   ;;   (IN-PACKAGE :CL-USER)
217   ;;     (DEFVAR CL::*FOO* 'FOO-VALUE)
218   ;;     (EVAL-WHEN (:COMPILE-TOPLEVEL :LOAD-TOPLEVEL :EXECUTE)
219   ;;       (SETF *PACKAGE* (FIND-PACKAGE :CL)))
220   ;; which in CMU CL 2.4.9 defines a variable CL-USER::*FOO* instead of
221   ;; defining CL::*FOO*. Therefore, we don't use those fops in SBCL.
222   ;;(frob fop-symbol-save               6 4 *package*)
223   ;;(frob fop-small-symbol-save   7 1 *package*)
224
225   (frob fop-lisp-symbol-save          75 4 *cl-package*)
226   (frob fop-lisp-small-symbol-save    76 1 *cl-package*)
227   (frob fop-keyword-symbol-save       77 4 *keyword-package*)
228   (frob fop-keyword-small-symbol-save 78 1 *keyword-package*)
229
230   ;; FIXME: Because we don't have FOP-SYMBOL-SAVE any more, an enormous number
231   ;; of symbols will fall through to this case, probably resulting in bloated
232   ;; fasl files. A new
233   ;; FOP-SYMBOL-IN-LAST-PACKAGE-SAVE/FOP-SMALL-SYMBOL-IN-LAST-PACKAGE-SAVE
234   ;; cloned fop pair could undo some of this bloat.
235   (frob fop-symbol-in-package-save 8 4
236     (svref *current-fop-table* (fast-read-u-integer 4)))
237   (frob fop-small-symbol-in-package-save 9 1
238     (svref *current-fop-table* (fast-read-u-integer 4)))
239   (frob fop-symbol-in-byte-package-save 10 4
240     (svref *current-fop-table* (fast-read-u-integer 1)))
241   (frob fop-small-symbol-in-byte-package-save 11 1
242     (svref *current-fop-table* (fast-read-u-integer 1))))
243
244 (define-cloned-fops (fop-uninterned-symbol-save 12)
245                     (fop-uninterned-small-symbol-save 13)
246   (let* ((arg (clone-arg))
247          (res (make-string arg)))
248     (read-string-as-bytes *fasl-file* res)
249     (push-fop-table (make-symbol res))))
250
251 (define-fop (fop-package 14)
252   (find-undeleted-package-or-lose (pop-stack)))
253 \f
254 ;;;; fops for loading numbers
255
256 ;;; Load a signed integer LENGTH bytes long from *FASL-FILE*.
257 (defun load-s-integer (length)
258   (declare (fixnum length))
259   ;; #+cmu (declare (optimize (inhibit-warnings 2)))
260   (do* ((index length (1- index))
261         (byte 0 (read-byte *fasl-file*))
262         (result 0 (+ result (ash byte bits)))
263         (bits 0 (+ bits 8)))
264        ((= index 0)
265         (if (logbitp 7 byte)    ; look at sign bit
266             (- result (ash 1 bits))
267             result))
268     (declare (fixnum index byte bits))))
269
270 (define-cloned-fops (fop-integer 33) (fop-small-integer 34)
271   (load-s-integer (clone-arg)))
272
273 (define-fop (fop-word-integer 35)
274   (prepare-for-fast-read-byte *fasl-file*
275     (prog1
276      (fast-read-s-integer 4)
277      (done-with-fast-read-byte))))
278
279 (define-fop (fop-byte-integer 36)
280   (prepare-for-fast-read-byte *fasl-file*
281     (prog1
282      (fast-read-s-integer 1)
283      (done-with-fast-read-byte))))
284
285 (define-fop (fop-ratio 70)
286   (let ((den (pop-stack)))
287     (%make-ratio (pop-stack) den)))
288
289 (define-fop (fop-complex 71)
290   (let ((im (pop-stack)))
291     (%make-complex (pop-stack) im)))
292
293 (define-fop (fop-complex-single-float 72)
294   (prepare-for-fast-read-byte *fasl-file*
295     (prog1
296         (complex (make-single-float (fast-read-s-integer 4))
297                  (make-single-float (fast-read-s-integer 4)))
298       (done-with-fast-read-byte))))
299
300 (define-fop (fop-complex-double-float 73)
301   (prepare-for-fast-read-byte *fasl-file*
302     (prog1
303         (let* ((re-lo (fast-read-u-integer 4))
304                (re-hi (fast-read-u-integer 4))
305                (re (make-double-float re-hi re-lo))
306                (im-lo (fast-read-u-integer 4))
307                (im-hi (fast-read-u-integer 4))
308                (im (make-double-float im-hi im-lo)))
309           (complex re im))
310       (done-with-fast-read-byte))))
311
312 #!+long-float
313 (define-fop (fop-complex-long-float 67)
314   (prepare-for-fast-read-byte *fasl-file*
315     (prog1
316         (let* ((re-lo (fast-read-u-integer 4))
317                #!+sparc (re-mid (fast-read-u-integer 4))
318                (re-hi (fast-read-u-integer 4))
319                (re-exp (fast-read-s-integer #!+x86 2 #!+sparc 4))
320                (re (make-long-float re-exp re-hi #!+sparc re-mid re-lo))
321                (im-lo (fast-read-u-integer 4))
322                #!+sparc (im-mid (fast-read-u-integer 4))
323                (im-hi (fast-read-u-integer 4))
324                (im-exp (fast-read-s-integer #!+x86 2 #!+sparc 4))
325                (im (make-long-float im-exp im-hi #!+sparc im-mid im-lo)))
326           (complex re im))
327       (done-with-fast-read-byte))))
328
329 (define-fop (fop-single-float 46)
330   (prepare-for-fast-read-byte *fasl-file*
331     (prog1 (make-single-float (fast-read-s-integer 4))
332       (done-with-fast-read-byte))))
333
334 (define-fop (fop-double-float 47)
335   (prepare-for-fast-read-byte *fasl-file*
336     (prog1
337         (let ((lo (fast-read-u-integer 4)))
338           (make-double-float (fast-read-s-integer 4) lo))
339       (done-with-fast-read-byte))))
340
341 #!+long-float
342 (define-fop (fop-long-float 52)
343   (prepare-for-fast-read-byte *fasl-file*
344     (prog1
345         (let ((lo (fast-read-u-integer 4))
346               #!+sparc (mid (fast-read-u-integer 4))
347               (hi (fast-read-u-integer 4))
348               (exp (fast-read-s-integer #!+x86 2 #!+sparc 4)))
349           (make-long-float exp hi #!+sparc mid lo))
350       (done-with-fast-read-byte))))
351 \f
352 ;;;; loading lists
353
354 (define-fop (fop-list 15)
355   (do ((res () (cons (pop-stack) res))
356        (n (read-arg 1) (1- n)))
357       ((zerop n) res)
358     (declare (type index n))))
359
360 (define-fop (fop-list* 16)
361   (do ((res (pop-stack) (cons (pop-stack) res))
362        (n (read-arg 1) (1- n)))
363       ((zerop n) res)
364     (declare (type index n))))
365
366 (macrolet ((frob (name op fun n)
367              `(define-fop (,name ,op)
368                 (call-with-popped-things ,fun ,n))))
369
370   (frob fop-list-1 17 list 1)
371   (frob fop-list-2 18 list 2)
372   (frob fop-list-3 19 list 3)
373   (frob fop-list-4 20 list 4)
374   (frob fop-list-5 21 list 5)
375   (frob fop-list-6 22 list 6)
376   (frob fop-list-7 23 list 7)
377   (frob fop-list-8 24 list 8)
378
379   (frob fop-list*-1 25 list* 2)
380   (frob fop-list*-2 26 list* 3)
381   (frob fop-list*-3 27 list* 4)
382   (frob fop-list*-4 28 list* 5)
383   (frob fop-list*-5 29 list* 6)
384   (frob fop-list*-6 30 list* 7)
385   (frob fop-list*-7 31 list* 8)
386   (frob fop-list*-8 32 list* 9))
387 \f
388 ;;;; fops for loading arrays
389
390 (define-cloned-fops (fop-string 37) (fop-small-string 38)
391   (let* ((arg (clone-arg))
392          (res (make-string arg)))
393     (read-string-as-bytes *fasl-file* res)
394     res))
395
396 (define-cloned-fops (fop-vector 39) (fop-small-vector 40)
397   (let* ((size (clone-arg))
398          (res (make-array size)))
399     (declare (fixnum size))
400     (do ((n (1- size) (1- n)))
401         ((minusp n))
402       (setf (svref res n) (pop-stack)))
403     res))
404
405 (define-fop (fop-array 83)
406   (let* ((rank (read-arg 4))
407          (vec (pop-stack))
408          (length (length vec))
409          (res (make-array-header sb!vm:simple-array-type rank)))
410     (declare (simple-array vec)
411              (type (unsigned-byte 24) rank))
412     (set-array-header res vec length length 0
413                       (do ((i rank (1- i))
414                            (dimensions () (cons (pop-stack) dimensions)))
415                           ((zerop i) dimensions)
416                         (declare (type index i)))
417                       nil)
418     res))
419
420 (define-fop (fop-single-float-vector 84)
421   (let* ((length (read-arg 4))
422          (result (make-array length :element-type 'single-float)))
423     (read-n-bytes *fasl-file* result 0 (* length sb!vm:word-bytes))
424     result))
425
426 (define-fop (fop-double-float-vector 85)
427   (let* ((length (read-arg 4))
428          (result (make-array length :element-type 'double-float)))
429     (read-n-bytes *fasl-file* result 0 (* length sb!vm:word-bytes 2))
430     result))
431
432 #!+long-float
433 (define-fop (fop-long-float-vector 88)
434   (let* ((length (read-arg 4))
435          (result (make-array length :element-type 'long-float)))
436     (read-n-bytes *fasl-file*
437                   result
438                   0
439                   (* length sb!vm:word-bytes #!+x86 3 #!+sparc 4))
440     result))
441
442 (define-fop (fop-complex-single-float-vector 86)
443   (let* ((length (read-arg 4))
444          (result (make-array length :element-type '(complex single-float))))
445     (read-n-bytes *fasl-file* result 0 (* length sb!vm:word-bytes 2))
446     result))
447
448 (define-fop (fop-complex-double-float-vector 87)
449   (let* ((length (read-arg 4))
450          (result (make-array length :element-type '(complex double-float))))
451     (read-n-bytes *fasl-file* result 0 (* length sb!vm:word-bytes 2 2))
452     result))
453
454 #!+long-float
455 (define-fop (fop-complex-long-float-vector 89)
456   (let* ((length (read-arg 4))
457          (result (make-array length :element-type '(complex long-float))))
458     (read-n-bytes *fasl-file* result 0
459                   (* length sb!vm:word-bytes #!+x86 3 #!+sparc 4 2))
460     result))
461
462 ;;; *** NOT *** the FOP-INT-VECTOR as currently documented in rtguts. Size
463 ;;; must be a directly supported I-vector element size, with no extra bits.
464 ;;; This must be packed according to the local byte-ordering, allowing us to
465 ;;; directly read the bits.
466 (define-fop (fop-int-vector 43)
467   (prepare-for-fast-read-byte *fasl-file*
468     (let* ((len (fast-read-u-integer 4))
469            (size (fast-read-byte))
470            (res (case size
471                   (1 (make-array len :element-type 'bit))
472                   (2 (make-array len :element-type '(unsigned-byte 2)))
473                   (4 (make-array len :element-type '(unsigned-byte 4)))
474                   (8 (make-array len :element-type '(unsigned-byte 8)))
475                   (16 (make-array len :element-type '(unsigned-byte 16)))
476                   (32 (make-array len :element-type '(unsigned-byte 32)))
477                   (t (error "internal error: losing i-vector element size: ~S"
478                             size)))))
479       (declare (type index len))
480       (done-with-fast-read-byte)
481       (read-n-bytes *fasl-file*
482                     res
483                     0
484                     (ceiling (the index (* size len))
485                              sb!vm:byte-bits))
486       res)))
487
488 ;;; FOP-SIGNED-INT-VECTOR
489 ;;;
490 ;;; Same as FOP-INT-VECTOR, except this is for signed simple-arrays.
491 ;;; It appears that entry 50 and 51 are clear.
492 (define-fop (fop-signed-int-vector 50)
493   (prepare-for-fast-read-byte *fasl-file*
494     (let* ((len (fast-read-u-integer 4))
495            (size (fast-read-byte))
496            (res (case size
497                   (8 (make-array len :element-type '(signed-byte 8)))
498                   (16 (make-array len :element-type '(signed-byte 16)))
499                   (30 (make-array len :element-type '(signed-byte 30)))
500                   (32 (make-array len :element-type '(signed-byte 32)))
501                   (t (error "internal error: losing si-vector element size: ~S"
502                             size)))))
503       (declare (type index len))
504       (done-with-fast-read-byte)
505       (read-n-bytes *fasl-file*
506                     res
507                     0
508                     (ceiling (the index (* (if (= size 30)
509                                                32 ; Adjust for (signed-byte 30)
510                                                size) len)) sb!vm:byte-bits))
511       res)))
512
513 (define-fop (fop-eval 53)
514   (let ((result (eval (pop-stack))))
515     ;; FIXME: CMU CL had this code here:
516     ;;   (when *load-print*
517     ;;     (load-fresh-line)
518     ;;     (prin1 result)
519     ;;     (terpri))
520     ;; Unfortunately, this dependence on the *LOAD-PRINT* global variable is
521     ;; non-ANSI, so for now we've just punted printing in fasload.
522     result))
523
524 (define-fop (fop-eval-for-effect 54 nil)
525   (let ((result (eval (pop-stack))))
526     ;; FIXME: See the comment about *LOAD-PRINT* in FOP-EVAL.
527     (declare (ignore result))
528     #+nil (when *load-print*
529             (load-fresh-line)
530             (prin1 result)
531             (terpri))))
532
533 (define-fop (fop-funcall 55)
534   (let ((arg (read-arg 1)))
535     (if (zerop arg)
536         (funcall (pop-stack))
537         (do ((args () (cons (pop-stack) args))
538              (n arg (1- n)))
539             ((zerop n) (apply (pop-stack) args))
540           (declare (type index n))))))
541
542 (define-fop (fop-funcall-for-effect 56 nil)
543   (let ((arg (read-arg 1)))
544     (if (zerop arg)
545         (funcall (pop-stack))
546         (do ((args () (cons (pop-stack) args))
547              (n arg (1- n)))
548             ((zerop n) (apply (pop-stack) args))
549           (declare (type index n))))))
550 \f
551 ;;;; fops for fixing up circularities
552
553 (define-fop (fop-rplaca 200 nil)
554   (let ((obj (svref *current-fop-table* (read-arg 4)))
555         (idx (read-arg 4))
556         (val (pop-stack)))
557     (setf (car (nthcdr idx obj)) val)))
558
559 (define-fop (fop-rplacd 201 nil)
560   (let ((obj (svref *current-fop-table* (read-arg 4)))
561         (idx (read-arg 4))
562         (val (pop-stack)))
563     (setf (cdr (nthcdr idx obj)) val)))
564
565 (define-fop (fop-svset 202 nil)
566   (let* ((obi (read-arg 4))
567          (obj (svref *current-fop-table* obi))
568          (idx (read-arg 4))
569          (val (pop-stack)))
570     (if (typep obj 'instance)
571         (setf (%instance-ref obj idx) val)
572         (setf (svref obj idx) val))))
573
574 (define-fop (fop-structset 204 nil)
575   (setf (%instance-ref (svref *current-fop-table* (read-arg 4))
576                        (read-arg 4))
577         (pop-stack)))
578
579 (define-fop (fop-nthcdr 203 t)
580   (nthcdr (read-arg 4) (pop-stack)))
581 \f
582 ;;;; fops for loading functions
583
584 ;;; (In CMU CL there was a FOP-CODE-FORMAT (47) which was
585 ;;; conventionally placed at the beginning of each fasl file to test
586 ;;; for compatibility between the fasl file and the CMU CL which
587 ;;; loaded it. In SBCL, this functionality has been replaced by
588 ;;; putting the implementation and version in required fields in the
589 ;;; fasl file header.)
590
591 (define-fop (fop-code 58 :nope)
592   (load-code (read-arg 4) (read-arg 4)))
593
594 (define-fop (fop-small-code 59 :nope)
595   (load-code (read-arg 1) (read-arg 2)))
596
597 (define-fop (fop-fdefinition 60)
598   (fdefinition-object (pop-stack) t))
599
600 (define-fop (fop-sanctify-for-execution 61)
601   (let ((component (pop-stack)))
602     (sb!vm:sanctify-for-execution component)
603     component))
604
605 ;;; This a no-op except in cold load. (In ordinary warm load, everything
606 ;;; involved with function definition can be handled nicely by ordinary
607 ;;; toplevel code.)
608 (define-fop (fop-fset 74 nil)
609   (pop-stack)
610   (pop-stack))
611
612 ;;; Modify a slot in a Constants object.
613 (define-cloned-fops (fop-alter-code 140 nil) (fop-byte-alter-code 141)
614   (let ((value (pop-stack))
615         (code (pop-stack)))
616     (setf (code-header-ref code (clone-arg)) value)
617     (values)))
618
619 (define-fop (fop-function-entry 142)
620   #+sb-xc-host ; since xc host doesn't know how to compile %PRIMITIVE
621   (error "FOP-FUNCTION-ENTRY can't be defined without %PRIMITIVE.")
622   #-sb-xc-host
623   (let ((type (pop-stack))
624         (arglist (pop-stack))
625         (name (pop-stack))
626         (code-object (pop-stack))
627         (offset (read-arg 4)))
628     (declare (type index offset))
629     (unless (zerop (logand offset sb!vm:lowtag-mask))
630       (error "internal error: unaligned function object, offset = #X~X"
631              offset))
632     (let ((fun (%primitive sb!c:compute-function code-object offset)))
633       (setf (%function-self fun) fun)
634       (setf (%function-next fun) (%code-entry-points code-object))
635       (setf (%code-entry-points code-object) fun)
636       (setf (%function-name fun) name)
637       (setf (%function-arglist fun) arglist)
638       (setf (%function-type fun) type)
639       ;; FIXME: See the comment about *LOAD-PRINT* in FOP-EVAL.
640       #+nil (when *load-print*
641               (load-fresh-line)
642               (format t "~S defined~%" fun))
643       fun)))
644
645 (define-fop (fop-make-byte-compiled-function 143)
646   (let* ((size (read-arg 1))
647          (layout (pop-stack))
648          (res (%make-funcallable-instance size layout)))
649     (declare (type index size))
650     (do ((n (1- size) (1- n)))
651         ((minusp n))
652       (declare (type (integer -1 #.most-positive-fixnum) n))
653       (setf (%funcallable-instance-info res n) (pop-stack)))
654     (initialize-byte-compiled-function res)
655     ;; FIXME: See the comment about *LOAD-PRINT* in FOP-EVAL.
656     #+nil (when *load-print*
657             (load-fresh-line)
658             (format t "~S defined~%" res))
659     res))
660 \f
661 ;;;; Some Dylan fops used to live here. By 1 November 1998 the code was
662 ;;;; sufficiently stale that the functions it called were no longer defined,
663 ;;;; so I (William Harold Newman) deleted it.
664 ;;;;
665 ;;;; In case someone in the future is trying to make sense of FOP layout,
666 ;;;; it might be worth recording that the Dylan FOPs were
667 ;;;;    100 FOP-DYLAN-SYMBOL-SAVE
668 ;;;;    101 FOP-SMALL-DYLAN-SYMBOL-SAVE
669 ;;;;    102 FOP-DYLAN-KEYWORD-SAVE
670 ;;;;    103 FOP-SMALL-DYLAN-KEYWORD-SAVE
671 ;;;;    104 FOP-DYLAN-VARINFO-VALUE
672 \f
673 ;;;; assemblerish fops
674
675 (define-fop (fop-foreign-fixup 147)
676   (let* ((kind (pop-stack))
677          (code-object (pop-stack))
678          (len (read-arg 1))
679          (sym (make-string len)))
680     (read-n-bytes *fasl-file* sym 0 len)
681     (sb!vm:fixup-code-object code-object
682                              (read-arg 4)
683                              (foreign-symbol-address-as-integer sym)
684                              kind)
685     code-object))
686
687 (define-fop (fop-assembler-code 144)
688   (error "cannot load assembler code except at cold load"))
689
690 (define-fop (fop-assembler-routine 145)
691   (error "cannot load assembler code except at cold load"))
692
693 (define-fop (fop-assembler-fixup 148)
694   (let ((routine (pop-stack))
695         (kind (pop-stack))
696         (code-object (pop-stack)))
697     (multiple-value-bind (value found) (gethash routine *assembler-routines*)
698       (unless found
699         (error "undefined assembler routine: ~S" routine))
700       (sb!vm:fixup-code-object code-object (read-arg 4) value kind))
701     code-object))
702
703 (define-fop (fop-code-object-fixup 149)
704   (let ((kind (pop-stack))
705         (code-object (pop-stack)))
706     ;; Note: We don't have to worry about GC moving the code-object after
707     ;; the GET-LISP-OBJ-ADDRESS and before that value is deposited, because
708     ;; we can only use code-object fixups when code-objects don't move.
709     (sb!vm:fixup-code-object code-object (read-arg 4)
710                              (get-lisp-obj-address code-object) kind)
711     code-object))