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