1 ;;;; streams for UNIX file descriptors
3 ;;;; This software is part of the SBCL system. See the README file for
6 ;;;; This software is derived from the CMU CL system, which was
7 ;;;; written at Carnegie Mellon University and released into the
8 ;;;; public domain. The software is in the public domain and is
9 ;;;; provided with absolutely no warranty. See the COPYING and CREDITS
10 ;;;; files for more information.
12 (in-package "SB!IMPL")
14 ;;;; buffer manipulation routines
16 ;;; FIXME: Is it really good to maintain this pool separate from the
17 ;;; GC and the C malloc logic?
18 (defvar *available-buffers* ()
20 "List of available buffers. Each buffer is an sap pointing to
21 bytes-per-buffer of memory.")
23 (defconstant bytes-per-buffer (* 4 1024)
25 "Number of bytes per buffer.")
27 ;;; Return the next available buffer, creating one if necessary.
28 #!-sb-fluid (declaim (inline next-available-buffer))
29 (defun next-available-buffer ()
30 (if *available-buffers*
31 (pop *available-buffers*)
32 (allocate-system-memory bytes-per-buffer)))
34 ;;;; the FD-STREAM structure
37 (:constructor %make-fd-stream)
38 (:conc-name fd-stream-)
39 (:predicate fd-stream-p)
41 (misc #'fd-stream-misc-routine))
44 ;; the name of this stream
46 ;; the file this stream is for
48 ;; the backup file namestring for the old file, for :IF-EXISTS
49 ;; :RENAME or :RENAME-AND-DELETE.
50 (original nil :type (or simple-string null))
51 (delete-original nil) ; for :if-exists :rename-and-delete
52 ;;; the number of bytes per element
53 (element-size 1 :type index)
54 ;; the type of element being transfered
55 (element-type 'base-char)
56 ;; the Unix file descriptor
58 ;; controls when the output buffer is flushed
59 (buffering :full :type (member :full :line :none))
60 ;; character position (if known)
61 (char-pos nil :type (or index null))
62 ;; T if input is waiting on FD. :EOF if we hit EOF.
63 (listen nil :type (member nil t :eof))
67 (ibuf-sap nil :type (or system-area-pointer null))
68 (ibuf-length nil :type (or index null))
69 (ibuf-head 0 :type index)
70 (ibuf-tail 0 :type index)
73 (obuf-sap nil :type (or system-area-pointer null))
74 (obuf-length nil :type (or index null))
75 (obuf-tail 0 :type index)
77 ;; output flushed, but not written due to non-blocking io?
80 ;; timeout specified for this stream, or NIL if none
81 (timeout nil :type (or index null))
82 ;; pathname of the file this stream is opened to (returned by PATHNAME)
83 (pathname nil :type (or pathname null))
84 (external-format :default)
85 (output-bytes #'ill-out :type function))
86 (def!method print-object ((fd-stream fd-stream) stream)
87 (declare (type stream stream))
88 (print-unreadable-object (fd-stream stream :type t :identity t)
89 (format stream "for ~S" (fd-stream-name fd-stream))))
91 ;;;; output routines and related noise
93 (defvar *output-routines* ()
95 "List of all available output routines. Each element is a list of the
96 element-type output, the kind of buffering, the function name, and the number
97 of bytes per element.")
99 ;;; common idioms for reporting low-level stream and file problems
100 (defun simple-stream-perror (note-format stream errno)
101 (error 'simple-stream-error
103 :format-control "~@<~?: ~2I~_~A~:>"
104 :format-arguments (list note-format (list stream) (strerror errno))))
105 (defun simple-file-perror (note-format pathname errno)
106 (error 'simple-file-error
108 :format-control "~@<~?: ~2I~_~A~:>"
110 (list note-format (list pathname) (strerror errno))))
112 (defun stream-decoding-error (stream octets)
113 (error 'stream-decoding-error
115 ;; FIXME: dunno how to get at OCTETS currently, or even if
116 ;; that's the right thing to report.
118 (defun stream-encoding-error (stream code)
119 (error 'stream-encoding-error
123 ;;; Returning true goes into end of file handling, false will enter another
124 ;;; round of input buffer filling followed by re-entering character decode.
125 (defun stream-decoding-error-and-handle (stream octet-count)
127 (stream-decoding-error stream
128 (let ((sap (fd-stream-ibuf-sap stream))
129 (head (fd-stream-ibuf-head stream)))
130 (loop for i from 0 below octet-count
131 collect (sap-ref-8 sap (+ head i)))))
133 :report (lambda (stream)
135 "~@<Attempt to resync the stream at a character ~
136 character boundary and continue.~@:>"))
137 (fd-stream-resync stream)
139 (force-end-of-file ()
140 :report (lambda (stream)
141 (format stream "~@<Force an end of file.~@:>"))
144 (defun stream-encoding-error-and-handle (stream code)
146 (stream-encoding-error stream code)
148 :report (lambda (stream)
149 (format stream "~@<Skip output of this character.~@:>"))
150 (throw 'output-nothing nil))))
152 ;;; This is called by the server when we can write to the given file
153 ;;; descriptor. Attempt to write the data again. If it worked, remove
154 ;;; the data from the OUTPUT-LATER list. If it didn't work, something
156 (defun frob-output-later (stream)
157 (let* ((stuff (pop (fd-stream-output-later stream)))
161 (reuse-sap (cadddr stuff))
162 (length (- end start)))
163 (declare (type index start end length))
164 (multiple-value-bind (count errno)
165 (sb!unix:unix-write (fd-stream-fd stream)
170 (if (= errno sb!unix:ewouldblock)
171 (error "Write would have blocked, but SERVER told us to go.")
172 (simple-stream-perror "couldn't write to ~S" stream errno)))
173 ((eql count length) ; Hot damn, it worked.
175 (push base *available-buffers*)))
176 ((not (null count)) ; sorta worked..
178 (the index (+ start count))
180 (fd-stream-output-later stream))))))
181 (unless (fd-stream-output-later stream)
182 (sb!sys:remove-fd-handler (fd-stream-handler stream))
183 (setf (fd-stream-handler stream) nil)))
185 ;;; Arange to output the string when we can write on the file descriptor.
186 (defun output-later (stream base start end reuse-sap)
187 (cond ((null (fd-stream-output-later stream))
188 (setf (fd-stream-output-later stream)
189 (list (list base start end reuse-sap)))
190 (setf (fd-stream-handler stream)
191 (sb!sys:add-fd-handler (fd-stream-fd stream)
194 (declare (ignore fd))
195 (frob-output-later stream)))))
197 (nconc (fd-stream-output-later stream)
198 (list (list base start end reuse-sap)))))
200 (let ((new-buffer (next-available-buffer)))
201 (setf (fd-stream-obuf-sap stream) new-buffer)
202 (setf (fd-stream-obuf-length stream) bytes-per-buffer))))
204 ;;; Output the given noise. Check to see whether there are any pending
205 ;;; writes. If so, just queue this one. Otherwise, try to write it. If
206 ;;; this would block, queue it.
207 (defun frob-output (stream base start end reuse-sap)
208 (declare (type fd-stream stream)
209 (type (or system-area-pointer (simple-array * (*))) base)
210 (type index start end))
211 (if (not (null (fd-stream-output-later stream))) ; something buffered.
213 (output-later stream base start end reuse-sap)
214 ;; ### check to see whether any of this noise can be output
216 (let ((length (- end start)))
217 (multiple-value-bind (count errno)
218 (sb!unix:unix-write (fd-stream-fd stream) base start length)
220 (if (= errno sb!unix:ewouldblock)
221 (output-later stream base start end reuse-sap)
222 (simple-stream-perror "couldn't write to ~S"
225 ((not (eql count length))
226 (output-later stream base (the index (+ start count))
229 ;;; Flush any data in the output buffer.
230 (defun flush-output-buffer (stream)
231 (let ((length (fd-stream-obuf-tail stream)))
233 (frob-output stream (fd-stream-obuf-sap stream) 0 length t)
234 (setf (fd-stream-obuf-tail stream) 0))))
236 (defmacro output-wrapper/variable-width ((stream size buffering restart)
238 (let ((stream-var (gensym)))
239 `(let ((,stream-var ,stream)
241 ,(unless (eq (car buffering) :none)
242 `(when (< (fd-stream-obuf-length ,stream-var)
243 (+ (fd-stream-obuf-tail ,stream-var)
245 (flush-output-buffer ,stream-var)))
246 ,(unless (eq (car buffering) :none)
247 `(when (> (fd-stream-ibuf-tail ,stream-var)
248 (fd-stream-ibuf-head ,stream-var))
249 (file-position ,stream-var (file-position ,stream-var))))
251 `(catch 'output-nothing
253 (incf (fd-stream-obuf-tail ,stream-var) size))
256 (incf (fd-stream-obuf-tail ,stream-var) size)))
257 ,(ecase (car buffering)
259 `(flush-output-buffer ,stream-var))
261 `(when (eq (char-code byte) (char-code #\Newline))
262 (flush-output-buffer ,stream-var)))
266 (defmacro output-wrapper ((stream size buffering restart) &body body)
267 (let ((stream-var (gensym)))
268 `(let ((,stream-var ,stream))
269 ,(unless (eq (car buffering) :none)
270 `(when (< (fd-stream-obuf-length ,stream-var)
271 (+ (fd-stream-obuf-tail ,stream-var)
273 (flush-output-buffer ,stream-var)))
274 ,(unless (eq (car buffering) :none)
275 `(when (> (fd-stream-ibuf-tail ,stream-var)
276 (fd-stream-ibuf-head ,stream-var))
277 (file-position ,stream-var (file-position ,stream-var))))
279 `(catch 'output-nothing
281 (incf (fd-stream-obuf-tail ,stream-var) ,size))
284 (incf (fd-stream-obuf-tail ,stream-var) ,size)))
285 ,(ecase (car buffering)
287 `(flush-output-buffer ,stream-var))
289 `(when (eq (char-code byte) (char-code #\Newline))
290 (flush-output-buffer ,stream-var)))
294 (defmacro def-output-routines/variable-width
295 ((name-fmt size restart external-format &rest bufferings)
297 (declare (optimize (speed 1)))
302 (intern (format nil name-fmt (string (car buffering))))))
304 (defun ,function (stream byte)
305 (output-wrapper/variable-width (stream ,size ,buffering ,restart)
307 (setf *output-routines*
308 (nconc *output-routines*
316 (cdr buffering)))))))
319 ;;; Define output routines that output numbers SIZE bytes long for the
320 ;;; given bufferings. Use BODY to do the actual output.
321 (defmacro def-output-routines ((name-fmt size restart &rest bufferings)
323 (declare (optimize (speed 1)))
328 (intern (format nil name-fmt (string (car buffering))))))
330 (defun ,function (stream byte)
331 (output-wrapper (stream ,size ,buffering ,restart)
333 (setf *output-routines*
334 (nconc *output-routines*
342 (cdr buffering)))))))
345 ;;; FIXME: is this used anywhere any more?
346 (def-output-routines ("OUTPUT-CHAR-~A-BUFFERED"
352 (if (char= byte #\Newline)
353 (setf (fd-stream-char-pos stream) 0)
354 (incf (fd-stream-char-pos stream)))
355 (setf (sap-ref-8 (fd-stream-obuf-sap stream) (fd-stream-obuf-tail stream))
358 (def-output-routines ("OUTPUT-UNSIGNED-BYTE-~A-BUFFERED"
361 (:none (unsigned-byte 8))
362 (:full (unsigned-byte 8)))
363 (setf (sap-ref-8 (fd-stream-obuf-sap stream) (fd-stream-obuf-tail stream))
366 (def-output-routines ("OUTPUT-SIGNED-BYTE-~A-BUFFERED"
369 (:none (signed-byte 8))
370 (:full (signed-byte 8)))
371 (setf (signed-sap-ref-8 (fd-stream-obuf-sap stream)
372 (fd-stream-obuf-tail stream))
375 (def-output-routines ("OUTPUT-UNSIGNED-SHORT-~A-BUFFERED"
378 (:none (unsigned-byte 16))
379 (:full (unsigned-byte 16)))
380 (setf (sap-ref-16 (fd-stream-obuf-sap stream) (fd-stream-obuf-tail stream))
383 (def-output-routines ("OUTPUT-SIGNED-SHORT-~A-BUFFERED"
386 (:none (signed-byte 16))
387 (:full (signed-byte 16)))
388 (setf (signed-sap-ref-16 (fd-stream-obuf-sap stream)
389 (fd-stream-obuf-tail stream))
392 (def-output-routines ("OUTPUT-UNSIGNED-LONG-~A-BUFFERED"
395 (:none (unsigned-byte 32))
396 (:full (unsigned-byte 32)))
397 (setf (sap-ref-32 (fd-stream-obuf-sap stream) (fd-stream-obuf-tail stream))
400 (def-output-routines ("OUTPUT-SIGNED-LONG-~A-BUFFERED"
403 (:none (signed-byte 32))
404 (:full (signed-byte 32)))
405 (setf (signed-sap-ref-32 (fd-stream-obuf-sap stream)
406 (fd-stream-obuf-tail stream))
409 ;;; Do the actual output. If there is space to buffer the string,
410 ;;; buffer it. If the string would normally fit in the buffer, but
411 ;;; doesn't because of other stuff in the buffer, flush the old noise
412 ;;; out of the buffer and put the string in it. Otherwise we have a
413 ;;; very long string, so just send it directly (after flushing the
414 ;;; buffer, of course).
415 (defun output-raw-bytes (fd-stream thing &optional start end)
417 "Output THING to FD-STREAM. THING can be any kind of vector or a SAP. If
418 THING is a SAP, END must be supplied (as length won't work)."
419 (let ((start (or start 0))
420 (end (or end (length (the (simple-array * (*)) thing)))))
421 (declare (type index start end))
422 (when (> (fd-stream-ibuf-tail fd-stream)
423 (fd-stream-ibuf-head fd-stream))
424 (file-position fd-stream (file-position fd-stream)))
425 (let* ((len (fd-stream-obuf-length fd-stream))
426 (tail (fd-stream-obuf-tail fd-stream))
428 (bytes (- end start))
429 (newtail (+ tail bytes)))
430 (cond ((minusp bytes) ; error case
431 (error ":END before :START!"))
432 ((zerop bytes)) ; easy case
434 (if (system-area-pointer-p thing)
435 (system-area-ub8-copy thing start
436 (fd-stream-obuf-sap fd-stream)
439 ;; FIXME: There should be some type checking somewhere to
440 ;; verify that THING here is a vector, not just <not a SAP>.
441 (copy-ub8-to-system-area thing start
442 (fd-stream-obuf-sap fd-stream)
445 (setf (fd-stream-obuf-tail fd-stream) newtail))
447 (flush-output-buffer fd-stream)
448 (if (system-area-pointer-p thing)
449 (system-area-ub8-copy thing
451 (fd-stream-obuf-sap fd-stream)
454 ;; FIXME: There should be some type checking somewhere to
455 ;; verify that THING here is a vector, not just <not a SAP>.
456 (copy-ub8-to-system-area thing
458 (fd-stream-obuf-sap fd-stream)
461 (setf (fd-stream-obuf-tail fd-stream) bytes))
463 (flush-output-buffer fd-stream)
464 (frob-output fd-stream thing start end nil))))))
466 ;;; the routine to use to output a string. If the stream is
467 ;;; unbuffered, slam the string down the file descriptor, otherwise
468 ;;; use OUTPUT-RAW-BYTES to buffer the string. Update charpos by
469 ;;; checking to see where the last newline was.
471 ;;; Note: some bozos (the FASL dumper) call write-string with things
472 ;;; other than strings. Therefore, we must make sure we have a string
473 ;;; before calling POSITION on it.
474 ;;; KLUDGE: It would be better to fix the bozos instead of trying to
475 ;;; cover for them here. -- WHN 20000203
476 (defun fd-sout (stream thing start end)
477 (let ((start (or start 0))
478 (end (or end (length (the vector thing)))))
479 (declare (fixnum start end))
481 (let ((last-newline (and (find #\newline (the simple-string thing)
482 :start start :end end)
483 ;; FIXME why do we need both calls?
484 ;; Is find faster forwards than
485 ;; position is backwards?
486 (position #\newline (the simple-string thing)
490 (if (and (typep thing 'base-string)
491 (eq (fd-stream-external-format stream) :latin-1))
492 (ecase (fd-stream-buffering stream)
494 (output-raw-bytes stream thing start end))
496 (output-raw-bytes stream thing start end)
498 (flush-output-buffer stream)))
500 (frob-output stream thing start end nil)))
501 (ecase (fd-stream-buffering stream)
502 (:full (funcall (fd-stream-output-bytes stream)
503 stream thing nil start end))
504 (:line (funcall (fd-stream-output-bytes stream)
505 stream thing last-newline start end))
506 (:none (funcall (fd-stream-output-bytes stream)
507 stream thing t start end))))
509 (setf (fd-stream-char-pos stream)
510 (- end last-newline 1))
511 (incf (fd-stream-char-pos stream)
513 (ecase (fd-stream-buffering stream)
515 (output-raw-bytes stream thing start end))
517 (frob-output stream thing start end nil))))))
519 (defvar *external-formats* ()
521 "List of all available external formats. Each element is a list of the
522 element-type, string input function name, character input function name,
523 and string output function name.")
525 ;;; Find an output routine to use given the type and buffering. Return
526 ;;; as multiple values the routine, the real type transfered, and the
527 ;;; number of bytes per element.
528 (defun pick-output-routine (type buffering &optional external-format)
529 (when (subtypep type 'character)
530 (dolist (entry *external-formats*)
531 (when (member external-format (first entry))
532 (return-from pick-output-routine
533 (values (symbol-function (nth (ecase buffering
540 (symbol-function (fourth entry))
541 (first (first entry)))))))
542 (dolist (entry *output-routines*)
543 (when (and (subtypep type (first entry))
544 (eq buffering (second entry))
545 (or (not (fifth entry))
546 (eq external-format (fifth entry))))
547 (return-from pick-output-routine
548 (values (symbol-function (third entry))
551 ;; KLUDGE: dealing with the buffering here leads to excessive code
554 ;; KLUDGE: also see comments in PICK-INPUT-ROUTINE
555 (loop for i from 40 by 8 to 1024 ; ARB (KLUDGE)
556 if (subtypep type `(unsigned-byte ,i))
557 do (return-from pick-output-routine
561 (lambda (stream byte)
562 (output-wrapper (stream (/ i 8) (:none) nil)
563 (loop for j from 0 below (/ i 8)
565 (fd-stream-obuf-sap stream)
566 (+ j (fd-stream-obuf-tail stream)))
567 (ldb (byte 8 (- i 8 (* j 8))) byte))))))
569 (lambda (stream byte)
570 (output-wrapper (stream (/ i 8) (:full) nil)
571 (loop for j from 0 below (/ i 8)
573 (fd-stream-obuf-sap stream)
574 (+ j (fd-stream-obuf-tail stream)))
575 (ldb (byte 8 (- i 8 (* j 8))) byte)))))))
578 (loop for i from 40 by 8 to 1024 ; ARB (KLUDGE)
579 if (subtypep type `(signed-byte ,i))
580 do (return-from pick-output-routine
584 (lambda (stream byte)
585 (output-wrapper (stream (/ i 8) (:none) nil)
586 (loop for j from 0 below (/ i 8)
588 (fd-stream-obuf-sap stream)
589 (+ j (fd-stream-obuf-tail stream)))
590 (ldb (byte 8 (- i 8 (* j 8))) byte))))))
592 (lambda (stream byte)
593 (output-wrapper (stream (/ i 8) (:full) nil)
594 (loop for j from 0 below (/ i 8)
596 (fd-stream-obuf-sap stream)
597 (+ j (fd-stream-obuf-tail stream)))
598 (ldb (byte 8 (- i 8 (* j 8))) byte)))))))
602 ;;;; input routines and related noise
604 ;;; a list of all available input routines. Each element is a list of
605 ;;; the element-type input, the function name, and the number of bytes
607 (defvar *input-routines* ())
609 ;;; Fill the input buffer, and return the number of bytes read. Throw
610 ;;; to EOF-INPUT-CATCHER if the eof was reached. Drop into
611 ;;; SYSTEM:SERVER if necessary.
612 (defun refill-buffer/fd (stream)
613 (let ((fd (fd-stream-fd stream))
614 (ibuf-sap (fd-stream-ibuf-sap stream))
615 (buflen (fd-stream-ibuf-length stream))
616 (head (fd-stream-ibuf-head stream))
617 (tail (fd-stream-ibuf-tail stream)))
618 (declare (type index head tail))
620 (cond ((eql head tail)
623 (setf (fd-stream-ibuf-head stream) 0)
624 (setf (fd-stream-ibuf-tail stream) 0))
627 (system-area-ub8-copy ibuf-sap head
630 (setf (fd-stream-ibuf-head stream) 0)
631 (setf (fd-stream-ibuf-tail stream) tail))))
632 (setf (fd-stream-listen stream) nil)
633 (multiple-value-bind (count errno)
634 ;; FIXME: Judging from compiler warnings, this WITH-ALIEN form expands
635 ;; into something which uses the not-yet-defined type
636 ;; (SB!ALIEN-INTERNALS:ALIEN (* (SB!ALIEN:STRUCT SB!UNIX:FD-SET))).
637 ;; This is probably inefficient and unsafe and generally bad, so
638 ;; try to find some way to make that type known before
640 (sb!alien:with-alien ((read-fds (sb!alien:struct sb!unix:fd-set)))
641 (sb!unix:fd-zero read-fds)
642 (sb!unix:fd-set fd read-fds)
643 (sb!unix:unix-fast-select (1+ fd)
644 (sb!alien:addr read-fds)
652 (unless (sb!sys:wait-until-fd-usable
653 fd :input (fd-stream-timeout stream))
654 (error 'io-timeout :stream stream :direction :read)))
656 (simple-stream-perror "couldn't check whether ~S is readable"
659 (multiple-value-bind (count errno)
660 (sb!unix:unix-read fd
661 (sb!sys:int-sap (+ (sb!sys:sap-int ibuf-sap) tail))
664 (if (eql errno sb!unix:ewouldblock)
666 (unless (sb!sys:wait-until-fd-usable
667 fd :input (fd-stream-timeout stream))
668 (error 'io-timeout :stream stream :direction :read))
669 (refill-buffer/fd stream))
670 (simple-stream-perror "couldn't read from ~S" stream errno)))
672 (setf (fd-stream-listen stream) :eof)
673 (/show0 "THROWing EOF-INPUT-CATCHER")
674 (throw 'eof-input-catcher nil))
676 (incf (fd-stream-ibuf-tail stream) count)
679 ;;; Make sure there are at least BYTES number of bytes in the input
680 ;;; buffer. Keep calling REFILL-BUFFER/FD until that condition is met.
681 (defmacro input-at-least (stream bytes)
682 (let ((stream-var (gensym))
683 (bytes-var (gensym)))
684 `(let ((,stream-var ,stream)
687 (when (>= (- (fd-stream-ibuf-tail ,stream-var)
688 (fd-stream-ibuf-head ,stream-var))
691 (refill-buffer/fd ,stream-var)))))
693 (defmacro input-wrapper/variable-width ((stream bytes eof-error eof-value)
695 (let ((stream-var (gensym))
697 (element-var (gensym)))
698 `(let ((,stream-var ,stream)
700 (if (fd-stream-unread ,stream-var)
702 (fd-stream-unread ,stream-var)
703 (setf (fd-stream-unread ,stream-var) nil)
704 (setf (fd-stream-listen ,stream-var) nil))
705 (let ((,element-var nil)
706 (decode-break-reason nil))
710 (catch 'eof-input-catcher
711 (setf decode-break-reason
712 (block decode-break-reason
713 (input-at-least ,stream-var 1)
714 (let* ((byte (sap-ref-8 (fd-stream-ibuf-sap
719 (input-at-least ,stream-var size)
720 (setq ,element-var (locally ,@read-forms))
721 (setq ,retry-var nil))
723 (when decode-break-reason
724 (stream-decoding-error-and-handle stream
725 decode-break-reason))
727 (let ((octet-count (- (fd-stream-ibuf-tail ,stream-var)
728 (fd-stream-ibuf-head ,stream-var))))
729 (when (or (zerop octet-count)
730 (and (not ,element-var)
731 (not decode-break-reason)
732 (stream-decoding-error-and-handle
733 stream octet-count)))
734 (setq ,retry-var nil)))))
736 (incf (fd-stream-ibuf-head ,stream-var) size)
739 (eof-or-lose ,stream-var ,eof-error ,eof-value))))))))
741 ;;; a macro to wrap around all input routines to handle EOF-ERROR noise
742 (defmacro input-wrapper ((stream bytes eof-error eof-value) &body read-forms)
743 (let ((stream-var (gensym))
744 (element-var (gensym)))
745 `(let ((,stream-var ,stream))
746 (if (fd-stream-unread ,stream-var)
748 (fd-stream-unread ,stream-var)
749 (setf (fd-stream-unread ,stream-var) nil)
750 (setf (fd-stream-listen ,stream-var) nil))
752 (catch 'eof-input-catcher
753 (input-at-least ,stream-var ,bytes)
754 (locally ,@read-forms))))
756 (incf (fd-stream-ibuf-head ,stream-var) ,bytes)
759 (eof-or-lose ,stream-var ,eof-error ,eof-value))))))))
761 (defmacro def-input-routine/variable-width (name
762 (type external-format size sap head)
765 (defun ,name (stream eof-error eof-value)
766 (input-wrapper/variable-width (stream ,size eof-error eof-value)
767 (let ((,sap (fd-stream-ibuf-sap stream))
768 (,head (fd-stream-ibuf-head stream)))
770 (setf *input-routines*
771 (nconc *input-routines*
772 (list (list ',type ',name 1 ',external-format))))))
774 (defmacro def-input-routine (name
778 (defun ,name (stream eof-error eof-value)
779 (input-wrapper (stream ,size eof-error eof-value)
780 (let ((,sap (fd-stream-ibuf-sap stream))
781 (,head (fd-stream-ibuf-head stream)))
783 (setf *input-routines*
784 (nconc *input-routines*
785 (list (list ',type ',name ',size nil))))))
787 ;;; STREAM-IN routine for reading a string char
788 (def-input-routine input-character
789 (character 1 sap head)
790 (code-char (sap-ref-8 sap head)))
792 ;;; STREAM-IN routine for reading an unsigned 8 bit number
793 (def-input-routine input-unsigned-8bit-byte
794 ((unsigned-byte 8) 1 sap head)
795 (sap-ref-8 sap head))
797 ;;; STREAM-IN routine for reading a signed 8 bit number
798 (def-input-routine input-signed-8bit-number
799 ((signed-byte 8) 1 sap head)
800 (signed-sap-ref-8 sap head))
802 ;;; STREAM-IN routine for reading an unsigned 16 bit number
803 (def-input-routine input-unsigned-16bit-byte
804 ((unsigned-byte 16) 2 sap head)
805 (sap-ref-16 sap head))
807 ;;; STREAM-IN routine for reading a signed 16 bit number
808 (def-input-routine input-signed-16bit-byte
809 ((signed-byte 16) 2 sap head)
810 (signed-sap-ref-16 sap head))
812 ;;; STREAM-IN routine for reading a unsigned 32 bit number
813 (def-input-routine input-unsigned-32bit-byte
814 ((unsigned-byte 32) 4 sap head)
815 (sap-ref-32 sap head))
817 ;;; STREAM-IN routine for reading a signed 32 bit number
818 (def-input-routine input-signed-32bit-byte
819 ((signed-byte 32) 4 sap head)
820 (signed-sap-ref-32 sap head))
824 ;;; Find an input routine to use given the type. Return as multiple
825 ;;; values the routine, the real type transfered, and the number of
826 ;;; bytes per element (and for character types string input routine).
827 (defun pick-input-routine (type &optional external-format)
828 (when (subtypep type 'character)
829 (dolist (entry *external-formats*)
830 (when (member external-format (first entry))
831 (return-from pick-input-routine
832 (values (symbol-function (third entry))
835 (symbol-function (second entry))
836 (first (first entry)))))))
837 (dolist (entry *input-routines*)
838 (when (and (subtypep type (first entry))
839 (or (not (fourth entry))
840 (eq external-format (fourth entry))))
841 (return-from pick-input-routine
842 (values (symbol-function (second entry))
845 ;; FIXME: let's do it the hard way, then (but ignore things like
846 ;; endianness, efficiency, and the necessary coupling between these
847 ;; and the output routines). -- CSR, 2004-02-09
848 (loop for i from 40 by 8 to 1024 ; ARB (well, KLUDGE really)
849 if (subtypep type `(unsigned-byte ,i))
850 do (return-from pick-input-routine
852 (lambda (stream eof-error eof-value)
853 (input-wrapper (stream (/ i 8) eof-error eof-value)
854 (let ((sap (fd-stream-ibuf-sap stream))
855 (head (fd-stream-ibuf-head stream)))
856 (loop for j from 0 below (/ i 8)
860 (sap-ref-8 sap (+ head j))))
861 finally (return result)))))
864 (loop for i from 40 by 8 to 1024 ; ARB (well, KLUDGE really)
865 if (subtypep type `(signed-byte ,i))
866 do (return-from pick-input-routine
868 (lambda (stream eof-error eof-value)
869 (input-wrapper (stream (/ i 8) eof-error eof-value)
870 (let ((sap (fd-stream-ibuf-sap stream))
871 (head (fd-stream-ibuf-head stream)))
872 (loop for j from 0 below (/ i 8)
876 (sap-ref-8 sap (+ head j))))
877 finally (return (if (logbitp (1- i) result)
878 (dpb result (byte i 0) -1)
883 ;;; Return a string constructed from SAP, START, and END.
884 (defun string-from-sap (sap start end)
885 (declare (type index start end))
886 (let* ((length (- end start))
887 (string (make-string length)))
888 (copy-ub8-from-system-area sap start
893 ;;; the N-BIN method for FD-STREAMs
895 ;;; Note that this blocks in UNIX-READ. It is generally used where
896 ;;; there is a definite amount of reading to be done, so blocking
897 ;;; isn't too problematical.
898 (defun fd-stream-read-n-bytes (stream buffer start requested eof-error-p
899 &aux (total-copied 0))
900 (declare (type fd-stream stream))
901 (declare (type index start requested total-copied))
902 (let ((unread (fd-stream-unread stream)))
904 ;; AVERs designed to fail when we have more complicated
905 ;; character representations.
906 (aver (typep unread 'base-char))
907 (aver (= (fd-stream-element-size stream) 1))
908 ;; KLUDGE: this is a slightly-unrolled-and-inlined version of
912 (setf (sap-ref-8 buffer start) (char-code unread)))
913 ((simple-unboxed-array (*))
914 (setf (aref buffer start) unread)))
915 (setf (fd-stream-unread stream) nil)
916 (setf (fd-stream-listen stream) nil)
917 (incf total-copied)))
920 (let* ((remaining-request (- requested total-copied))
921 (head (fd-stream-ibuf-head stream))
922 (tail (fd-stream-ibuf-tail stream))
923 (available (- tail head))
924 (n-this-copy (min remaining-request available))
925 (this-start (+ start total-copied))
926 (this-end (+ this-start n-this-copy))
927 (sap (fd-stream-ibuf-sap stream)))
928 (declare (type index remaining-request head tail available))
929 (declare (type index n-this-copy))
930 ;; Copy data from stream buffer into user's buffer.
931 (%byte-blt sap head buffer this-start this-end)
932 (incf (fd-stream-ibuf-head stream) n-this-copy)
933 (incf total-copied n-this-copy)
934 ;; Maybe we need to refill the stream buffer.
935 (cond (;; If there were enough data in the stream buffer, we're done.
936 (= total-copied requested)
937 (return total-copied))
938 (;; If EOF, we're done in another way.
939 (null (catch 'eof-input-catcher (refill-buffer/fd stream)))
941 (error 'end-of-file :stream stream)
942 (return total-copied)))
943 ;; Otherwise we refilled the stream buffer, so fall
944 ;; through into another pass of the loop.
947 (defun fd-stream-resync (stream)
948 (dolist (entry *external-formats*)
949 (when (member (fd-stream-external-format stream) (first entry))
950 (return-from fd-stream-resync
951 (funcall (symbol-function (eighth entry)) stream)))))
953 (defmacro define-external-format (external-format size output-restart
955 (let* ((name (first external-format))
956 (out-function (symbolicate "OUTPUT-BYTES/" name))
957 (format (format nil "OUTPUT-CHAR-~A-~~A-BUFFERED" (string name)))
958 (in-function (symbolicate "FD-STREAM-READ-N-CHARACTERS/" name))
959 (in-char-function (symbolicate "INPUT-CHAR/" name)))
961 (defun ,out-function (stream string flush-p start end)
962 (let ((start (or start 0))
963 (end (or end (length string))))
964 (declare (type index start end))
965 (when (> (fd-stream-ibuf-tail stream)
966 (fd-stream-ibuf-head stream))
967 (file-position stream (file-position stream)))
969 (error ":END before :START!"))
972 (setf (fd-stream-obuf-tail stream)
973 (do* ((len (fd-stream-obuf-length stream))
974 (sap (fd-stream-obuf-sap stream))
975 (tail (fd-stream-obuf-tail stream)))
976 ((or (= start end) (< (- len tail) 4)) tail)
978 `(catch 'output-nothing
979 (let* ((byte (aref string start))
980 (bits (char-code byte)))
983 `(let* ((byte (aref string start))
984 (bits (char-code byte)))
989 (flush-output-buffer stream)))
991 (flush-output-buffer stream))))
992 (def-output-routines (,format
998 (if (char= byte #\Newline)
999 (setf (fd-stream-char-pos stream) 0)
1000 (incf (fd-stream-char-pos stream)))
1001 (let ((bits (char-code byte))
1002 (sap (fd-stream-obuf-sap stream))
1003 (tail (fd-stream-obuf-tail stream)))
1005 (defun ,in-function (stream buffer start requested eof-error-p
1006 &aux (total-copied 0))
1007 (declare (type fd-stream stream))
1008 (declare (type index start requested total-copied))
1009 (let ((unread (fd-stream-unread stream)))
1011 (setf (aref buffer start) unread)
1012 (setf (fd-stream-unread stream) nil)
1013 (setf (fd-stream-listen stream) nil)
1014 (incf total-copied)))
1017 (let* ((head (fd-stream-ibuf-head stream))
1018 (tail (fd-stream-ibuf-tail stream))
1019 (sap (fd-stream-ibuf-sap stream)))
1020 (declare (type index head tail))
1021 ;; Copy data from stream buffer into user's buffer.
1023 ((or (= tail head) (= requested total-copied)))
1024 (let* ((byte (sap-ref-8 sap head)))
1025 (when (> ,size (- tail head))
1027 (setf (aref buffer (+ start total-copied)) ,in-expr)
1030 (setf (fd-stream-ibuf-head stream) head)
1031 ;; Maybe we need to refill the stream buffer.
1032 (cond ( ;; If there were enough data in the stream buffer, we're done.
1033 (= total-copied requested)
1034 (return total-copied))
1035 ( ;; If EOF, we're done in another way.
1036 (null (catch 'eof-input-catcher (refill-buffer/fd stream)))
1038 (error 'end-of-file :stream stream)
1039 (return total-copied)))
1040 ;; Otherwise we refilled the stream buffer, so fall
1041 ;; through into another pass of the loop.
1043 (def-input-routine ,in-char-function (character ,size sap head)
1044 (let ((byte (sap-ref-8 sap head)))
1046 (setf *external-formats*
1047 (cons '(,external-format ,in-function ,in-char-function ,out-function
1048 ,@(mapcar #'(lambda (buffering)
1049 (intern (format nil format (string buffering))))
1050 '(:none :line :full)))
1051 *external-formats*)))))
1053 (defmacro define-external-format/variable-width
1054 (external-format output-restart out-size-expr
1055 out-expr in-size-expr in-expr)
1056 (let* ((name (first external-format))
1057 (out-function (symbolicate "OUTPUT-BYTES/" name))
1058 (format (format nil "OUTPUT-CHAR-~A-~~A-BUFFERED" (string name)))
1059 (in-function (symbolicate "FD-STREAM-READ-N-CHARACTERS/" name))
1060 (in-char-function (symbolicate "INPUT-CHAR/" name))
1061 (resync-function (symbolicate "RESYNC/" name)))
1063 (defun ,out-function (fd-stream string flush-p start end)
1064 (let ((start (or start 0))
1065 (end (or end (length string))))
1066 (declare (type index start end))
1067 (when (> (fd-stream-ibuf-tail fd-stream)
1068 (fd-stream-ibuf-head fd-stream))
1069 (file-position fd-stream (file-position fd-stream)))
1071 (error ":END before :START!"))
1074 (setf (fd-stream-obuf-tail fd-stream)
1075 (do* ((len (fd-stream-obuf-length fd-stream))
1076 (sap (fd-stream-obuf-sap fd-stream))
1077 (tail (fd-stream-obuf-tail fd-stream)))
1078 ((or (= start end) (< (- len tail) 4)) tail)
1080 `(catch 'output-nothing
1081 (let* ((byte (aref string start))
1082 (bits (char-code byte))
1083 (size ,out-size-expr))
1087 `(let* ((byte (aref string start))
1088 (bits (char-code byte))
1089 (size ,out-size-expr))
1094 (flush-output-buffer fd-stream)))
1096 (flush-output-buffer fd-stream))))
1097 (def-output-routines/variable-width (,format
1104 (if (char= byte #\Newline)
1105 (setf (fd-stream-char-pos stream) 0)
1106 (incf (fd-stream-char-pos stream)))
1107 (let ((bits (char-code byte))
1108 (sap (fd-stream-obuf-sap stream))
1109 (tail (fd-stream-obuf-tail stream)))
1111 (defun ,in-function (stream buffer start requested eof-error-p
1112 &aux (total-copied 0))
1113 (declare (type fd-stream stream))
1114 (declare (type index start requested total-copied))
1115 (let ((unread (fd-stream-unread stream)))
1117 (setf (aref buffer start) unread)
1118 (setf (fd-stream-unread stream) nil)
1119 (setf (fd-stream-listen stream) nil)
1120 (incf total-copied)))
1123 (let* ((head (fd-stream-ibuf-head stream))
1124 (tail (fd-stream-ibuf-tail stream))
1125 (sap (fd-stream-ibuf-sap stream))
1127 (decode-break-reason nil))
1128 (declare (type index head tail))
1129 ;; Copy data from stream buffer into user's buffer.
1130 (do ((size nil nil))
1131 ((or (= tail head) (= requested total-copied)))
1132 (setf decode-break-reason
1133 (block decode-break-reason
1134 (let ((byte (sap-ref-8 sap head)))
1135 (setq size ,in-size-expr)
1136 (when (> size (- tail head))
1138 (setf (aref buffer (+ start total-copied)) ,in-expr)
1142 (setf (fd-stream-ibuf-head stream) head)
1143 (when (and decode-break-reason
1144 (= head head-start))
1145 (when (stream-decoding-error-and-handle
1146 stream decode-break-reason)
1148 (error 'end-of-file :stream stream)
1149 (return-from ,in-function total-copied)))
1150 (setf head (fd-stream-ibuf-head stream))
1151 (setf tail (fd-stream-ibuf-tail stream)))
1152 (when (plusp total-copied)
1153 (return-from ,in-function total-copied)))
1154 (setf (fd-stream-ibuf-head stream) head)
1155 ;; Maybe we need to refill the stream buffer.
1156 (cond ( ;; If there were enough data in the stream buffer, we're done.
1157 (= total-copied requested)
1158 (return total-copied))
1159 ( ;; If EOF, we're done in another way.
1160 (or (eq decode-break-reason 'eof)
1161 (null (catch 'eof-input-catcher
1162 (refill-buffer/fd stream))))
1164 (error 'end-of-file :stream stream)
1165 (return total-copied)))
1166 ;; Otherwise we refilled the stream buffer, so fall
1167 ;; through into another pass of the loop.
1169 (def-input-routine/variable-width ,in-char-function (character
1173 (let ((byte (sap-ref-8 sap head)))
1175 (defun ,resync-function (stream)
1176 (loop (input-at-least stream 1)
1177 (incf (fd-stream-ibuf-head stream))
1178 (unless (block decode-break-reason
1179 (let* ((sap (fd-stream-ibuf-sap stream))
1180 (head (fd-stream-ibuf-head stream))
1181 (byte (sap-ref-8 sap head))
1182 (size ,in-size-expr))
1186 (setf *external-formats*
1187 (cons '(,external-format ,in-function ,in-char-function ,out-function
1188 ,@(mapcar #'(lambda (buffering)
1189 (intern (format nil format (string buffering))))
1190 '(:none :line :full))
1192 *external-formats*)))))
1194 (define-external-format (:latin-1 :latin1 :iso-8859-1)
1197 (stream-encoding-error-and-handle stream bits)
1198 (setf (sap-ref-8 sap tail) bits))
1201 (define-external-format (:ascii :us-ascii :ansi_x3.4-1968)
1204 (stream-encoding-error-and-handle stream bits)
1205 (setf (sap-ref-8 sap tail) bits))
1208 (let* ((table (let ((s (make-string 256)))
1209 (map-into s #'code-char
1210 '(#x00 #x01 #x02 #x03 #x9c #x09 #x86 #x7f #x97 #x8d #x8e #x0b #x0c #x0d #x0e #x0f
1211 #x10 #x11 #x12 #x13 #x9d #x85 #x08 #x87 #x18 #x19 #x92 #x8f #x1c #x1d #x1e #x1f
1212 #x80 #x81 #x82 #x83 #x84 #x0a #x17 #x1b #x88 #x89 #x8a #x8b #x8c #x05 #x06 #x07
1213 #x90 #x91 #x16 #x93 #x94 #x95 #x96 #x04 #x98 #x99 #x9a #x9b #x14 #x15 #x9e #x1a
1214 #x20 #xa0 #xe2 #xe4 #xe0 #xe1 #xe3 #xe5 #xe7 #xf1 #xa2 #x2e #x3c #x28 #x2b #x7c
1215 #x26 #xe9 #xea #xeb #xe8 #xed #xee #xef #xec #xdf #x21 #x24 #x2a #x29 #x3b #xac
1216 #x2d #x2f #xc2 #xc4 #xc0 #xc1 #xc3 #xc5 #xc7 #xd1 #xa6 #x2c #x25 #x5f #x3e #x3f
1217 #xf8 #xc9 #xca #xcb #xc8 #xcd #xce #xcf #xcc #x60 #x3a #x23 #x40 #x27 #x3d #x22
1218 #xd8 #x61 #x62 #x63 #x64 #x65 #x66 #x67 #x68 #x69 #xab #xbb #xf0 #xfd #xfe #xb1
1219 #xb0 #x6a #x6b #x6c #x6d #x6e #x6f #x70 #x71 #x72 #xaa #xba #xe6 #xb8 #xc6 #xa4
1220 #xb5 #x7e #x73 #x74 #x75 #x76 #x77 #x78 #x79 #x7a #xa1 #xbf #xd0 #xdd #xde #xae
1221 #x5e #xa3 #xa5 #xb7 #xa9 #xa7 #xb6 #xbc #xbd #xbe #x5b #x5d #xaf #xa8 #xb4 #xd7
1222 #x7b #x41 #x42 #x43 #x44 #x45 #x46 #x47 #x48 #x49 #xad #xf4 #xf6 #xf2 #xf3 #xf5
1223 #x7d #x4a #x4b #x4c #x4d #x4e #x4f #x50 #x51 #x52 #xb9 #xfb #xfc #xf9 #xfa #xff
1224 #x5c #xf7 #x53 #x54 #x55 #x56 #x57 #x58 #x59 #x5a #xb2 #xd4 #xd6 #xd2 #xd3 #xd5
1225 #x30 #x31 #x32 #x33 #x34 #x35 #x36 #x37 #x38 #x39 #xb3 #xdb #xdc #xd9 #xda #x9f))
1227 (reverse-table (let ((rt (make-array 256 :element-type '(unsigned-byte 8) :initial-element 0)))
1228 (loop for char across table for i from 0
1229 do (aver (= 0 (aref rt (char-code char))))
1230 do (setf (aref rt (char-code char)) i))
1232 (define-external-format (:ebcdic-us :ibm-037 :ibm037)
1235 (stream-encoding-error-and-handle stream bits)
1236 (setf (sap-ref-8 sap tail) (aref reverse-table bits)))
1241 (let ((latin-9-table (let ((table (make-string 256)))
1244 (setf (aref table i) (code-char i)))
1245 (setf (aref table #xa4) (code-char #x20ac))
1246 (setf (aref table #xa6) (code-char #x0160))
1247 (setf (aref table #xa8) (code-char #x0161))
1248 (setf (aref table #xb4) (code-char #x017d))
1249 (setf (aref table #xb8) (code-char #x017e))
1250 (setf (aref table #xbc) (code-char #x0152))
1251 (setf (aref table #xbd) (code-char #x0153))
1252 (setf (aref table #xbe) (code-char #x0178))
1254 (latin-9-reverse-1 (make-array 16
1255 :element-type '(unsigned-byte 21)
1256 :initial-contents '(#x0160 #x0161 #x0152 #x0153 0 0 0 0 #x0178 0 0 0 #x20ac #x017d #x017e 0)))
1257 (latin-9-reverse-2 (make-array 16
1258 :element-type '(unsigned-byte 8)
1259 :initial-contents '(#xa6 #xa8 #xbc #xbd 0 0 0 0 #xbe 0 0 0 #xa4 #xb4 #xb8 0))))
1260 (define-external-format (:latin-9 :latin9 :iso-8859-15)
1262 (setf (sap-ref-8 sap tail)
1264 (if (= bits (char-code (aref latin-9-table bits)))
1266 (stream-encoding-error-and-handle stream byte))
1267 (if (= (aref latin-9-reverse-1 (logand bits 15)) bits)
1268 (aref latin-9-reverse-2 (logand bits 15))
1269 (stream-encoding-error-and-handle stream byte))))
1270 (aref latin-9-table byte)))
1272 (define-external-format/variable-width (:utf-8 :utf8) nil
1273 (let ((bits (char-code byte)))
1274 (cond ((< bits #x80) 1)
1276 ((< bits #x10000) 3)
1279 (1 (setf (sap-ref-8 sap tail) bits))
1280 (2 (setf (sap-ref-8 sap tail) (logior #xc0 (ldb (byte 5 6) bits))
1281 (sap-ref-8 sap (1+ tail)) (logior #x80 (ldb (byte 6 0) bits))))
1282 (3 (setf (sap-ref-8 sap tail) (logior #xe0 (ldb (byte 4 12) bits))
1283 (sap-ref-8 sap (1+ tail)) (logior #x80 (ldb (byte 6 6) bits))
1284 (sap-ref-8 sap (+ 2 tail)) (logior #x80 (ldb (byte 6 0) bits))))
1285 (4 (setf (sap-ref-8 sap tail) (logior #xf0 (ldb (byte 3 18) bits))
1286 (sap-ref-8 sap (1+ tail)) (logior #x80 (ldb (byte 6 12) bits))
1287 (sap-ref-8 sap (+ 2 tail)) (logior #x80 (ldb (byte 6 6) bits))
1288 (sap-ref-8 sap (+ 3 tail)) (logior #x80 (ldb (byte 6 0) bits)))))
1289 (cond ((< byte #x80) 1)
1290 ((< byte #xc2) (return-from decode-break-reason 1))
1294 (code-char (ecase size
1296 (2 (let ((byte2 (sap-ref-8 sap (1+ head))))
1297 (unless (<= #x80 byte2 #xbf)
1298 (return-from decode-break-reason 2))
1299 (dpb byte (byte 5 6) byte2)))
1300 (3 (let ((byte2 (sap-ref-8 sap (1+ head)))
1301 (byte3 (sap-ref-8 sap (+ 2 head))))
1302 (unless (and (<= #x80 byte2 #xbf)
1303 (<= #x80 byte3 #xbf))
1304 (return-from decode-break-reason 3))
1305 (dpb byte (byte 4 12) (dpb byte2 (byte 6 6) byte3))))
1306 (4 (let ((byte2 (sap-ref-8 sap (1+ head)))
1307 (byte3 (sap-ref-8 sap (+ 2 head)))
1308 (byte4 (sap-ref-8 sap (+ 3 head))))
1309 (unless (and (<= #x80 byte2 #xbf)
1310 (<= #x80 byte3 #xbf)
1311 (<= #x80 byte4 #xbf))
1312 (return-from decode-break-reason 4))
1313 (dpb byte (byte 3 18)
1314 (dpb byte2 (byte 6 12)
1315 (dpb byte3 (byte 6 6) byte4))))))))
1317 ;;;; utility functions (misc routines, etc)
1319 ;;; Fill in the various routine slots for the given type. INPUT-P and
1320 ;;; OUTPUT-P indicate what slots to fill. The buffering slot must be
1321 ;;; set prior to calling this routine.
1322 (defun set-fd-stream-routines (fd-stream type input-p output-p buffer-p)
1323 (let ((target-type (case type
1324 ((:default unsigned-byte)
1334 (character-stream-p (subtypep type 'character)))
1336 (when (fd-stream-obuf-sap fd-stream)
1337 (push (fd-stream-obuf-sap fd-stream) *available-buffers*)
1338 (setf (fd-stream-obuf-sap fd-stream) nil))
1339 (when (fd-stream-ibuf-sap fd-stream)
1340 (push (fd-stream-ibuf-sap fd-stream) *available-buffers*)
1341 (setf (fd-stream-ibuf-sap fd-stream) nil))
1343 (when (and character-stream-p
1344 (eq (fd-stream-external-format fd-stream) :default))
1345 (setf (fd-stream-external-format fd-stream)
1346 (intern (or (alien-funcall
1347 (extern-alien "nl_langinfo"
1348 (function c-string int))
1352 (dolist (entry *external-formats*
1353 (setf (fd-stream-external-format fd-stream) :latin-1))
1354 (when (member (fd-stream-external-format fd-stream) (first entry))
1358 (multiple-value-bind (routine type size read-n-characters
1359 normalized-external-format)
1360 (pick-input-routine target-type
1361 (fd-stream-external-format fd-stream))
1362 (when normalized-external-format
1363 (setf (fd-stream-external-format fd-stream)
1364 normalized-external-format))
1366 (error "could not find any input routine for ~S" target-type))
1367 (setf (fd-stream-ibuf-sap fd-stream) (next-available-buffer))
1368 (setf (fd-stream-ibuf-length fd-stream) bytes-per-buffer)
1369 (setf (fd-stream-ibuf-tail fd-stream) 0)
1370 (if character-stream-p
1371 (setf (fd-stream-in fd-stream) routine
1372 (fd-stream-bin fd-stream) #'ill-bin)
1373 (setf (fd-stream-in fd-stream) #'ill-in
1374 (fd-stream-bin fd-stream) routine))
1376 (setf (fd-stream-n-bin fd-stream)
1377 (if character-stream-p
1379 #'fd-stream-read-n-bytes))
1381 ;; We only create this buffer for streams of type
1382 ;; (unsigned-byte 8). Because there's no buffer, the
1383 ;; other element-types will dispatch to the appropriate
1384 ;; input (output) routine in fast-read-byte.
1385 (or character-stream-p
1386 (equal target-type '(unsigned-byte 8)))
1387 (not output-p) ; temporary disable on :io streams
1389 (or (eq type 'unsigned-byte)
1390 (eq type :default)))
1391 (if character-stream-p
1392 (setf (ansi-stream-cin-buffer fd-stream)
1393 (make-array +ansi-stream-in-buffer-length+
1394 :element-type 'character))
1395 (setf (ansi-stream-in-buffer fd-stream)
1396 (make-array +ansi-stream-in-buffer-length+
1397 :element-type '(unsigned-byte 8))))))
1398 (setf input-size size)
1399 (setf input-type type)))
1402 (multiple-value-bind (routine type size output-bytes
1403 normalized-external-format)
1404 (pick-output-routine target-type
1405 (fd-stream-buffering fd-stream)
1406 (fd-stream-external-format fd-stream))
1407 (when normalized-external-format
1408 (setf (fd-stream-external-format fd-stream)
1409 normalized-external-format))
1411 (error "could not find any output routine for ~S buffered ~S"
1412 (fd-stream-buffering fd-stream)
1414 (setf (fd-stream-obuf-sap fd-stream) (next-available-buffer))
1415 (setf (fd-stream-obuf-length fd-stream) bytes-per-buffer)
1416 (setf (fd-stream-obuf-tail fd-stream) 0)
1417 (when character-stream-p
1418 (setf (fd-stream-output-bytes fd-stream) output-bytes))
1419 (if character-stream-p
1420 (setf (fd-stream-out fd-stream) routine
1421 (fd-stream-bout fd-stream) #'ill-bout)
1422 (setf (fd-stream-out fd-stream)
1423 (or (if (eql size 1)
1424 (pick-output-routine
1425 'base-char (fd-stream-buffering fd-stream)))
1427 (fd-stream-bout fd-stream) routine))
1428 (setf (fd-stream-sout fd-stream)
1429 (if (eql size 1) #'fd-sout #'ill-out))
1430 (setf (fd-stream-char-pos fd-stream) 0)
1431 (setf output-size size)
1432 (setf output-type type)))
1434 (when (and input-size output-size
1435 (not (eq input-size output-size)))
1436 (error "Element sizes for input (~S:~S) and output (~S:~S) differ?"
1437 input-type input-size
1438 output-type output-size))
1439 (setf (fd-stream-element-size fd-stream)
1440 (or input-size output-size))
1442 (setf (fd-stream-element-type fd-stream)
1443 (cond ((equal input-type output-type)
1449 ((subtypep input-type output-type)
1451 ((subtypep output-type input-type)
1454 (error "Input type (~S) and output type (~S) are unrelated?"
1458 ;;; Handle miscellaneous operations on FD-STREAM.
1459 (defun fd-stream-misc-routine (fd-stream operation &optional arg1 arg2)
1460 (declare (ignore arg2))
1463 (or (not (eql (fd-stream-ibuf-head fd-stream)
1464 (fd-stream-ibuf-tail fd-stream)))
1465 (fd-stream-listen fd-stream)
1466 (setf (fd-stream-listen fd-stream)
1467 (eql (sb!alien:with-alien ((read-fds (sb!alien:struct
1469 (sb!unix:fd-zero read-fds)
1470 (sb!unix:fd-set (fd-stream-fd fd-stream) read-fds)
1471 (sb!unix:unix-fast-select (1+ (fd-stream-fd fd-stream))
1472 (sb!alien:addr read-fds)
1476 (setf (fd-stream-unread fd-stream) arg1)
1477 (setf (fd-stream-listen fd-stream) t))
1479 (cond (arg1 ; We got us an abort on our hands.
1480 (when (fd-stream-handler fd-stream)
1481 (sb!sys:remove-fd-handler (fd-stream-handler fd-stream))
1482 (setf (fd-stream-handler fd-stream) nil))
1483 ;; We can't do anything unless we know what file were
1484 ;; dealing with, and we don't want to do anything
1485 ;; strange unless we were writing to the file.
1486 (when (and (fd-stream-file fd-stream)
1487 (fd-stream-obuf-sap fd-stream))
1488 (if (fd-stream-original fd-stream)
1489 ;; If the original is EQ to file we are appending
1490 ;; and can just close the file without renaming.
1491 (unless (eq (fd-stream-original fd-stream)
1492 (fd-stream-file fd-stream))
1493 ;; We have a handle on the original, just revert.
1494 (multiple-value-bind (okay err)
1495 (sb!unix:unix-rename (fd-stream-original fd-stream)
1496 (fd-stream-file fd-stream))
1498 (simple-stream-perror
1499 "couldn't restore ~S to its original contents"
1502 ;; We can't restore the original, and aren't
1503 ;; appending, so nuke that puppy.
1505 ;; FIXME: This is currently the fate of superseded
1506 ;; files, and according to the CLOSE spec this is
1507 ;; wrong. However, there seems to be no clean way to
1508 ;; do that that doesn't involve either copying the
1509 ;; data (bad if the :abort resulted from a full
1510 ;; disk), or renaming the old file temporarily
1511 ;; (probably bad because stream opening becomes more
1513 (multiple-value-bind (okay err)
1514 (sb!unix:unix-unlink (fd-stream-file fd-stream))
1516 (error 'simple-file-error
1517 :pathname (fd-stream-file fd-stream)
1519 "~@<couldn't remove ~S: ~2I~_~A~:>"
1520 :format-arguments (list (fd-stream-file fd-stream)
1521 (strerror err))))))))
1523 (fd-stream-misc-routine fd-stream :finish-output)
1524 (when (and (fd-stream-original fd-stream)
1525 (fd-stream-delete-original fd-stream))
1526 (multiple-value-bind (okay err)
1527 (sb!unix:unix-unlink (fd-stream-original fd-stream))
1529 (error 'simple-file-error
1530 :pathname (fd-stream-original fd-stream)
1532 "~@<couldn't delete ~S during close of ~S: ~
1535 (list (fd-stream-original fd-stream)
1537 (strerror err))))))))
1538 (when (fboundp 'cancel-finalization)
1539 (cancel-finalization fd-stream))
1540 (sb!unix:unix-close (fd-stream-fd fd-stream))
1541 (when (fd-stream-obuf-sap fd-stream)
1542 (push (fd-stream-obuf-sap fd-stream) *available-buffers*)
1543 (setf (fd-stream-obuf-sap fd-stream) nil))
1544 (when (fd-stream-ibuf-sap fd-stream)
1545 (push (fd-stream-ibuf-sap fd-stream) *available-buffers*)
1546 (setf (fd-stream-ibuf-sap fd-stream) nil))
1547 (sb!impl::set-closed-flame fd-stream))
1549 (setf (fd-stream-unread fd-stream) nil)
1550 (setf (fd-stream-ibuf-head fd-stream) 0)
1551 (setf (fd-stream-ibuf-tail fd-stream) 0)
1552 (catch 'eof-input-catcher
1554 (let ((count (sb!alien:with-alien ((read-fds (sb!alien:struct
1556 (sb!unix:fd-zero read-fds)
1557 (sb!unix:fd-set (fd-stream-fd fd-stream) read-fds)
1558 (sb!unix:unix-fast-select (1+ (fd-stream-fd fd-stream))
1559 (sb!alien:addr read-fds)
1564 (cond ((eql count 1)
1565 (refill-buffer/fd fd-stream)
1566 (setf (fd-stream-ibuf-head fd-stream) 0)
1567 (setf (fd-stream-ibuf-tail fd-stream) 0))
1571 (flush-output-buffer fd-stream))
1573 (flush-output-buffer fd-stream)
1575 ((null (fd-stream-output-later fd-stream)))
1576 (sb!sys:serve-all-events)))
1578 (fd-stream-element-type fd-stream))
1580 (= 1 (the (member 0 1)
1581 (sb!unix:unix-isatty (fd-stream-fd fd-stream)))))
1585 (fd-stream-char-pos fd-stream))
1587 (unless (fd-stream-file fd-stream)
1588 ;; This is a TYPE-ERROR because ANSI's species FILE-LENGTH
1589 ;; "should signal an error of type TYPE-ERROR if stream is not
1590 ;; a stream associated with a file". Too bad there's no very
1591 ;; appropriate value for the EXPECTED-TYPE slot..
1592 (error 'simple-type-error
1594 :expected-type 'fd-stream
1595 :format-control "~S is not a stream associated with a file."
1596 :format-arguments (list fd-stream)))
1597 (multiple-value-bind (okay dev ino mode nlink uid gid rdev size
1598 atime mtime ctime blksize blocks)
1599 (sb!unix:unix-fstat (fd-stream-fd fd-stream))
1600 (declare (ignore ino nlink uid gid rdev
1601 atime mtime ctime blksize blocks))
1603 (simple-stream-perror "failed Unix fstat(2) on ~S" fd-stream dev))
1606 (truncate size (fd-stream-element-size fd-stream)))))
1608 (fd-stream-file-position fd-stream arg1))))
1610 (defun fd-stream-file-position (stream &optional newpos)
1611 (declare (type fd-stream stream)
1612 (type (or (alien sb!unix:off-t) (member nil :start :end)) newpos))
1614 (sb!sys:without-interrupts
1615 ;; First, find the position of the UNIX file descriptor in the file.
1616 (multiple-value-bind (posn errno)
1617 (sb!unix:unix-lseek (fd-stream-fd stream) 0 sb!unix:l_incr)
1618 (declare (type (or (alien sb!unix:off-t) null) posn))
1619 (cond ((integerp posn)
1620 ;; Adjust for buffered output: If there is any output
1621 ;; buffered, the *real* file position will be larger
1622 ;; than reported by lseek() because lseek() obviously
1623 ;; cannot take into account output we have not sent
1625 (dolist (later (fd-stream-output-later stream))
1626 (incf posn (- (caddr later)
1628 (incf posn (fd-stream-obuf-tail stream))
1629 ;; Adjust for unread input: If there is any input
1630 ;; read from UNIX but not supplied to the user of the
1631 ;; stream, the *real* file position will smaller than
1632 ;; reported, because we want to look like the unread
1633 ;; stuff is still available.
1634 (decf posn (- (fd-stream-ibuf-tail stream)
1635 (fd-stream-ibuf-head stream)))
1636 (when (fd-stream-unread stream)
1638 ;; Divide bytes by element size.
1639 (truncate posn (fd-stream-element-size stream)))
1640 ((eq errno sb!unix:espipe)
1643 (sb!sys:with-interrupts
1644 (simple-stream-perror "failure in Unix lseek() on ~S"
1647 (let ((offset 0) origin)
1648 (declare (type (alien sb!unix:off-t) offset))
1649 ;; Make sure we don't have any output pending, because if we
1650 ;; move the file pointer before writing this stuff, it will be
1651 ;; written in the wrong location.
1652 (flush-output-buffer stream)
1654 ((null (fd-stream-output-later stream)))
1655 (sb!sys:serve-all-events))
1656 ;; Clear out any pending input to force the next read to go to
1658 (setf (fd-stream-unread stream) nil)
1659 (setf (fd-stream-ibuf-head stream) 0)
1660 (setf (fd-stream-ibuf-tail stream) 0)
1661 ;; Trash cached value for listen, so that we check next time.
1662 (setf (fd-stream-listen stream) nil)
1664 (cond ((eq newpos :start)
1665 (setf offset 0 origin sb!unix:l_set))
1667 (setf offset 0 origin sb!unix:l_xtnd))
1668 ((typep newpos '(alien sb!unix:off-t))
1669 (setf offset (* newpos (fd-stream-element-size stream))
1670 origin sb!unix:l_set))
1672 (error "invalid position given to FILE-POSITION: ~S" newpos)))
1673 (multiple-value-bind (posn errno)
1674 (sb!unix:unix-lseek (fd-stream-fd stream) offset origin)
1675 (cond ((typep posn '(alien sb!unix:off-t))
1677 ((eq errno sb!unix:espipe)
1680 (simple-stream-perror "error in Unix lseek() on ~S"
1684 ;;;; creation routines (MAKE-FD-STREAM and OPEN)
1686 ;;; Create a stream for the given Unix file descriptor.
1688 ;;; If INPUT is non-NIL, allow input operations. If OUTPUT is non-nil,
1689 ;;; allow output operations. If neither INPUT nor OUTPUT is specified,
1690 ;;; default to allowing input.
1692 ;;; ELEMENT-TYPE indicates the element type to use (as for OPEN).
1694 ;;; BUFFERING indicates the kind of buffering to use.
1696 ;;; TIMEOUT (if true) is the number of seconds to wait for input. If
1697 ;;; NIL (the default), then wait forever. When we time out, we signal
1700 ;;; FILE is the name of the file (will be returned by PATHNAME).
1702 ;;; NAME is used to identify the stream when printed.
1703 (defun make-fd-stream (fd
1706 (output nil output-p)
1707 (element-type 'base-char)
1709 (external-format :default)
1717 (format nil "file ~S" file)
1718 (format nil "descriptor ~W" fd)))
1720 (declare (type index fd) (type (or index null) timeout)
1721 (type (member :none :line :full) buffering))
1722 (cond ((not (or input-p output-p))
1724 ((not (or input output))
1725 (error "File descriptor must be opened either for input or output.")))
1726 (let ((stream (%make-fd-stream :fd fd
1730 :delete-original delete-original
1732 :buffering buffering
1733 :external-format external-format
1735 (set-fd-stream-routines stream element-type input output input-buffer-p)
1736 (when (and auto-close (fboundp 'finalize))
1739 (sb!unix:unix-close fd)
1741 (format *terminal-io* "** closed file descriptor ~W **~%"
1745 ;;; Pick a name to use for the backup file for the :IF-EXISTS
1746 ;;; :RENAME-AND-DELETE and :RENAME options.
1747 (defun pick-backup-name (name)
1748 (declare (type simple-base-string name))
1749 (concatenate 'simple-base-string name ".bak"))
1751 ;;; Ensure that the given arg is one of the given list of valid
1752 ;;; things. Allow the user to fix any problems.
1753 (defun ensure-one-of (item list what)
1754 (unless (member item list)
1755 (error 'simple-type-error
1757 :expected-type `(member ,@list)
1758 :format-control "~@<~S is ~_invalid for ~S; ~_need one of~{ ~S~}~:>"
1759 :format-arguments (list item what list))))
1761 ;;; Rename NAMESTRING to ORIGINAL. First, check whether we have write
1762 ;;; access, since we don't want to trash unwritable files even if we
1763 ;;; technically can. We return true if we succeed in renaming.
1764 (defun rename-the-old-one (namestring original)
1765 (unless (sb!unix:unix-access namestring sb!unix:w_ok)
1766 (error "~@<The file ~2I~_~S ~I~_is not writable.~:>" namestring))
1767 (multiple-value-bind (okay err) (sb!unix:unix-rename namestring original)
1770 (error 'simple-file-error
1771 :pathname namestring
1773 "~@<couldn't rename ~2I~_~S ~I~_to ~2I~_~S: ~4I~_~A~:>"
1774 :format-arguments (list namestring original (strerror err))))))
1776 (defun open (filename
1779 (element-type 'base-char)
1780 (if-exists nil if-exists-given)
1781 (if-does-not-exist nil if-does-not-exist-given)
1782 (external-format :default)
1783 &aux ; Squelch assignment warning.
1784 (direction direction)
1785 (if-does-not-exist if-does-not-exist)
1786 (if-exists if-exists))
1788 "Return a stream which reads from or writes to FILENAME.
1790 :DIRECTION - one of :INPUT, :OUTPUT, :IO, or :PROBE
1791 :ELEMENT-TYPE - the type of object to read or write, default BASE-CHAR
1792 :IF-EXISTS - one of :ERROR, :NEW-VERSION, :RENAME, :RENAME-AND-DELETE,
1793 :OVERWRITE, :APPEND, :SUPERSEDE or NIL
1794 :IF-DOES-NOT-EXIST - one of :ERROR, :CREATE or NIL
1795 See the manual for details."
1797 ;; Calculate useful stuff.
1798 (multiple-value-bind (input output mask)
1800 (:input (values t nil sb!unix:o_rdonly))
1801 (:output (values nil t sb!unix:o_wronly))
1802 (:io (values t t sb!unix:o_rdwr))
1803 (:probe (values t nil sb!unix:o_rdonly)))
1804 (declare (type index mask))
1805 (let* ((pathname (merge-pathnames filename))
1807 (cond ((unix-namestring pathname input))
1808 ((and input (eq if-does-not-exist :create))
1809 (unix-namestring pathname nil))
1810 ((and (eq direction :io) (not if-does-not-exist-given))
1811 (unix-namestring pathname nil)))))
1812 ;; Process if-exists argument if we are doing any output.
1814 (unless if-exists-given
1816 (if (eq (pathname-version pathname) :newest)
1819 (ensure-one-of if-exists
1820 '(:error :new-version :rename
1821 :rename-and-delete :overwrite
1822 :append :supersede nil)
1825 ((:new-version :error nil)
1826 (setf mask (logior mask sb!unix:o_excl)))
1827 ((:rename :rename-and-delete)
1828 (setf mask (logior mask sb!unix:o_creat)))
1830 (setf mask (logior mask sb!unix:o_trunc)))
1832 (setf mask (logior mask sb!unix:o_append)))))
1834 (setf if-exists :ignore-this-arg)))
1836 (unless if-does-not-exist-given
1837 (setf if-does-not-exist
1838 (cond ((eq direction :input) :error)
1840 (member if-exists '(:overwrite :append)))
1842 ((eq direction :probe)
1846 (ensure-one-of if-does-not-exist
1847 '(:error :create nil)
1849 (if (eq if-does-not-exist :create)
1850 (setf mask (logior mask sb!unix:o_creat)))
1852 (let ((original (case if-exists
1853 ((:rename :rename-and-delete)
1854 (pick-backup-name namestring))
1855 ((:append :overwrite)
1856 ;; KLUDGE: Provent CLOSE from deleting
1857 ;; appending streams when called with :ABORT T
1859 (delete-original (eq if-exists :rename-and-delete))
1861 (when (and original (not (eq original namestring)))
1862 ;; We are doing a :RENAME or :RENAME-AND-DELETE. Determine
1863 ;; whether the file already exists, make sure the original
1864 ;; file is not a directory, and keep the mode.
1867 (multiple-value-bind (okay err/dev inode orig-mode)
1868 (sb!unix:unix-stat namestring)
1869 (declare (ignore inode)
1870 (type (or index null) orig-mode))
1873 (when (and output (= (logand orig-mode #o170000)
1875 (error 'simple-file-error
1876 :pathname namestring
1878 "can't open ~S for output: is a directory"
1879 :format-arguments (list namestring)))
1880 (setf mode (logand orig-mode #o777))
1882 ((eql err/dev sb!unix:enoent)
1885 (simple-file-perror "can't find ~S"
1889 (rename-the-old-one namestring original))
1891 (setf delete-original nil)
1892 ;; In order to use :SUPERSEDE instead, we have to make
1893 ;; sure SB!UNIX:O_CREAT corresponds to
1894 ;; IF-DOES-NOT-EXIST. SB!UNIX:O_CREAT was set before
1895 ;; because of IF-EXISTS being :RENAME.
1896 (unless (eq if-does-not-exist :create)
1898 (logior (logandc2 mask sb!unix:o_creat)
1900 (setf if-exists :supersede))))
1902 ;; Now we can try the actual Unix open(2).
1903 (multiple-value-bind (fd errno)
1905 (sb!unix:unix-open namestring mask mode)
1906 (values nil sb!unix:enoent))
1907 (labels ((open-error (format-control &rest format-arguments)
1908 (error 'simple-file-error
1910 :format-control format-control
1911 :format-arguments format-arguments))
1912 (vanilla-open-error ()
1913 (simple-file-perror "error opening ~S" pathname errno)))
1916 ((:input :output :io)
1920 :element-type element-type
1921 :external-format external-format
1924 :delete-original delete-original
1930 (%make-fd-stream :name namestring
1933 :element-type element-type)))
1936 ((eql errno sb!unix:enoent)
1937 (case if-does-not-exist
1938 (:error (vanilla-open-error))
1940 (open-error "~@<The path ~2I~_~S ~I~_does not exist.~:>"
1943 ((and (eql errno sb!unix:eexist) (null if-exists))
1946 (vanilla-open-error)))))))))
1950 ;;; the stream connected to the controlling terminal, or NIL if there is none
1953 ;;; the stream connected to the standard input (file descriptor 0)
1956 ;;; the stream connected to the standard output (file descriptor 1)
1959 ;;; the stream connected to the standard error output (file descriptor 2)
1962 ;;; This is called when the cold load is first started up, and may also
1963 ;;; be called in an attempt to recover from nested errors.
1964 (defun stream-cold-init-or-reset ()
1966 (setf *terminal-io* (make-synonym-stream '*tty*))
1967 (setf *standard-output* (make-synonym-stream '*stdout*))
1968 (setf *standard-input* (make-synonym-stream '*stdin*))
1969 (setf *error-output* (make-synonym-stream '*stderr*))
1970 (setf *query-io* (make-synonym-stream '*terminal-io*))
1971 (setf *debug-io* *query-io*)
1972 (setf *trace-output* *standard-output*)
1975 ;;; This is called whenever a saved core is restarted.
1976 (defun stream-reinit ()
1977 (setf *available-buffers* nil)
1979 (make-fd-stream 0 :name "standard input" :input t :buffering :line))
1981 (make-fd-stream 1 :name "standard output" :output t :buffering :line))
1983 (make-fd-stream 2 :name "standard error" :output t :buffering :line))
1984 (let* ((ttyname #.(coerce "/dev/tty" 'simple-base-string))
1985 (tty (sb!unix:unix-open ttyname sb!unix:o_rdwr #o666)))
1989 :name "the terminal"
1994 (setf *tty* (make-two-way-stream *stdin* *stdout*))))
1999 ;;; the Unix way to beep
2000 (defun beep (stream)
2001 (write-char (code-char bell-char-code) stream)
2002 (finish-output stream))
2004 ;;; This is kind of like FILE-POSITION, but is an internal hack used
2005 ;;; by the filesys stuff to get and set the file name.
2007 ;;; FIXME: misleading name, screwy interface
2008 (defun file-name (stream &optional new-name)
2009 (when (typep stream 'fd-stream)
2011 (setf (fd-stream-pathname stream) new-name)
2012 (setf (fd-stream-file stream)
2013 (unix-namestring new-name nil))
2016 (fd-stream-pathname stream)))))
2018 ;;;; international character support (which is trivial for our simple
2019 ;;;; character sets)
2021 ;;;; (Those who do Lisp only in English might not remember that ANSI
2022 ;;;; requires these functions to be exported from package
2025 (defun file-string-length (stream object)
2026 (declare (type (or string character) object) (type fd-stream stream))
2028 "Return the delta in STREAM's FILE-POSITION that would be caused by writing
2029 OBJECT to STREAM. Non-trivial only in implementations that support
2030 international character sets."
2031 (declare (ignore stream))
2034 (string (length object))))
2036 (defun stream-external-format (stream)
2037 (declare (type fd-stream stream))
2039 "Return the actual external format for fd-streams, otherwise :DEFAULT."
2040 (if (typep stream 'fd-stream)
2041 (fd-stream-external-format stream)