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.")
24 (defvar *available-buffers-mutex* (sb!thread:make-mutex
25 :name "lock for *AVAILABLE-BUFFERS*")
27 "Mutex for access to *AVAILABLE-BUFFERS*.")
29 (defmacro with-available-buffers-lock ((&optional) &body body)
30 ;; WITHOUT-INTERRUPTS because streams are low-level enough to be
31 ;; async signal safe, and in particular a C-c that brings up the
32 ;; debugger while holding the mutex would lose badly
34 (sb!thread:with-mutex (*available-buffers-mutex*)
37 (defconstant bytes-per-buffer (* 4 1024)
39 "Number of bytes per buffer.")
41 ;;; Return the next available buffer, creating one if necessary.
42 #!-sb-fluid (declaim (inline next-available-buffer))
43 (defun next-available-buffer ()
44 (with-available-buffers-lock ()
45 (if *available-buffers*
46 (pop *available-buffers*)
47 (allocate-system-memory bytes-per-buffer))))
49 ;;;; the FD-STREAM structure
52 (:constructor %make-fd-stream)
53 (:conc-name fd-stream-)
54 (:predicate fd-stream-p)
56 (misc #'fd-stream-misc-routine))
59 ;; the name of this stream
61 ;; the file this stream is for
63 ;; the backup file namestring for the old file, for :IF-EXISTS
64 ;; :RENAME or :RENAME-AND-DELETE.
65 (original nil :type (or simple-string null))
66 (delete-original nil) ; for :if-exists :rename-and-delete
67 ;;; the number of bytes per element
68 (element-size 1 :type index)
69 ;; the type of element being transfered
70 (element-type 'base-char)
71 ;; the Unix file descriptor
73 ;; controls when the output buffer is flushed
74 (buffering :full :type (member :full :line :none))
75 ;; controls whether the input buffer must be cleared before output
76 ;; (must be done for files, not for sockets, pipes and other data
77 ;; sources where input and output aren't related). non-NIL means
78 ;; don't clear input buffer.
80 ;; character position (if known)
81 (char-pos nil :type (or index null))
82 ;; T if input is waiting on FD. :EOF if we hit EOF.
83 (listen nil :type (member nil t :eof))
87 (ibuf-sap nil :type (or system-area-pointer null))
88 (ibuf-length nil :type (or index null))
89 (ibuf-head 0 :type index)
90 (ibuf-tail 0 :type index)
93 (obuf-sap nil :type (or system-area-pointer null))
94 (obuf-length nil :type (or index null))
95 (obuf-tail 0 :type index)
97 ;; output flushed, but not written due to non-blocking io?
100 ;; timeout specified for this stream, or NIL if none
101 (timeout nil :type (or index null))
102 ;; pathname of the file this stream is opened to (returned by PATHNAME)
103 (pathname nil :type (or pathname null))
104 (external-format :default)
105 (output-bytes #'ill-out :type function))
106 (def!method print-object ((fd-stream fd-stream) stream)
107 (declare (type stream stream))
108 (print-unreadable-object (fd-stream stream :type t :identity t)
109 (format stream "for ~S" (fd-stream-name fd-stream))))
111 ;;;; output routines and related noise
113 (defvar *output-routines* ()
115 "List of all available output routines. Each element is a list of the
116 element-type output, the kind of buffering, the function name, and the number
117 of bytes per element.")
119 ;;; common idioms for reporting low-level stream and file problems
120 (defun simple-stream-perror (note-format stream errno)
121 (error 'simple-stream-error
123 :format-control "~@<~?: ~2I~_~A~:>"
124 :format-arguments (list note-format (list stream) (strerror errno))))
125 (defun simple-file-perror (note-format pathname errno)
126 (error 'simple-file-error
128 :format-control "~@<~?: ~2I~_~A~:>"
130 (list note-format (list pathname) (strerror errno))))
132 (defun stream-decoding-error (stream octets)
133 (error 'stream-decoding-error
135 ;; FIXME: dunno how to get at OCTETS currently, or even if
136 ;; that's the right thing to report.
138 (defun stream-encoding-error (stream code)
139 (error 'stream-encoding-error
143 ;;; Returning true goes into end of file handling, false will enter another
144 ;;; round of input buffer filling followed by re-entering character decode.
145 (defun stream-decoding-error-and-handle (stream octet-count)
147 (stream-decoding-error stream
148 (let ((sap (fd-stream-ibuf-sap stream))
149 (head (fd-stream-ibuf-head stream)))
150 (loop for i from 0 below octet-count
151 collect (sap-ref-8 sap (+ head i)))))
153 :report (lambda (stream)
155 "~@<Attempt to resync the stream at a character ~
156 character boundary and continue.~@:>"))
157 (fd-stream-resync stream)
159 (force-end-of-file ()
160 :report (lambda (stream)
161 (format stream "~@<Force an end of file.~@:>"))
164 (defun stream-encoding-error-and-handle (stream code)
166 (stream-encoding-error stream code)
168 :report (lambda (stream)
169 (format stream "~@<Skip output of this character.~@:>"))
170 (throw 'output-nothing nil))))
172 ;;; This is called by the server when we can write to the given file
173 ;;; descriptor. Attempt to write the data again. If it worked, remove
174 ;;; the data from the OUTPUT-LATER list. If it didn't work, something
176 (defun frob-output-later (stream)
177 (let* ((stuff (pop (fd-stream-output-later stream)))
181 (reuse-sap (cadddr stuff))
182 (length (- end start)))
183 (declare (type index start end length))
184 (multiple-value-bind (count errno)
185 (sb!unix:unix-write (fd-stream-fd stream)
190 (if #!-win32 (= errno sb!unix:ewouldblock) #!+win32 t #!-win32
191 (error "Write would have blocked, but SERVER told us to go.")
192 (simple-stream-perror "couldn't write to ~S" stream errno)))
193 ((eql count length) ; Hot damn, it worked.
195 (with-available-buffers-lock ()
196 (push base *available-buffers*))))
197 ((not (null count)) ; sorta worked..
199 (the index (+ start count))
201 (fd-stream-output-later stream))))))
202 (unless (fd-stream-output-later stream)
203 (sb!sys:remove-fd-handler (fd-stream-handler stream))
204 (setf (fd-stream-handler stream) nil)))
206 ;;; Arange to output the string when we can write on the file descriptor.
207 (defun output-later (stream base start end reuse-sap)
208 (cond ((null (fd-stream-output-later stream))
209 (setf (fd-stream-output-later stream)
210 (list (list base start end reuse-sap)))
211 (setf (fd-stream-handler stream)
212 (sb!sys:add-fd-handler (fd-stream-fd stream)
215 (declare (ignore fd))
216 (frob-output-later stream)))))
218 (nconc (fd-stream-output-later stream)
219 (list (list base start end reuse-sap)))))
221 (let ((new-buffer (next-available-buffer)))
222 (setf (fd-stream-obuf-sap stream) new-buffer)
223 (setf (fd-stream-obuf-length stream) bytes-per-buffer))))
225 ;;; Output the given noise. Check to see whether there are any pending
226 ;;; writes. If so, just queue this one. Otherwise, try to write it. If
227 ;;; this would block, queue it.
228 (defun frob-output (stream base start end reuse-sap)
229 (declare (type fd-stream stream)
230 (type (or system-area-pointer (simple-array * (*))) base)
231 (type index start end))
232 (if (not (null (fd-stream-output-later stream))) ; something buffered.
234 (output-later stream base start end reuse-sap)
235 ;; ### check to see whether any of this noise can be output
237 (let ((length (- end start)))
238 (multiple-value-bind (count errno)
239 (sb!unix:unix-write (fd-stream-fd stream) base start length)
241 (if #!-win32 (= errno sb!unix:ewouldblock) #!+win32 t #!-win32
242 (output-later stream base start end reuse-sap)
243 (simple-stream-perror "couldn't write to ~S"
246 ((not (eql count length))
247 (output-later stream base (the index (+ start count))
250 ;;; Flush any data in the output buffer.
251 (defun flush-output-buffer (stream)
252 (let ((length (fd-stream-obuf-tail stream)))
254 (frob-output stream (fd-stream-obuf-sap stream) 0 length t)
255 (setf (fd-stream-obuf-tail stream) 0))))
257 (defmacro output-wrapper/variable-width ((stream size buffering restart)
259 (let ((stream-var (gensym)))
260 `(let ((,stream-var ,stream)
262 ,(unless (eq (car buffering) :none)
263 `(when (< (fd-stream-obuf-length ,stream-var)
264 (+ (fd-stream-obuf-tail ,stream-var)
266 (flush-output-buffer ,stream-var)))
267 ,(unless (eq (car buffering) :none)
268 `(when (and (not (fd-stream-dual-channel-p ,stream-var))
269 (> (fd-stream-ibuf-tail ,stream-var)
270 (fd-stream-ibuf-head ,stream-var)))
271 (file-position ,stream-var (file-position ,stream-var))))
273 `(catch 'output-nothing
275 (incf (fd-stream-obuf-tail ,stream-var) size))
278 (incf (fd-stream-obuf-tail ,stream-var) size)))
279 ,(ecase (car buffering)
281 `(flush-output-buffer ,stream-var))
283 `(when (eq (char-code byte) (char-code #\Newline))
284 (flush-output-buffer ,stream-var)))
288 (defmacro output-wrapper ((stream size buffering restart) &body body)
289 (let ((stream-var (gensym)))
290 `(let ((,stream-var ,stream))
291 ,(unless (eq (car buffering) :none)
292 `(when (< (fd-stream-obuf-length ,stream-var)
293 (+ (fd-stream-obuf-tail ,stream-var)
295 (flush-output-buffer ,stream-var)))
296 ,(unless (eq (car buffering) :none)
297 `(when (and (not (fd-stream-dual-channel-p ,stream-var))
298 (> (fd-stream-ibuf-tail ,stream-var)
299 (fd-stream-ibuf-head ,stream-var)))
300 (file-position ,stream-var (file-position ,stream-var))))
302 `(catch 'output-nothing
304 (incf (fd-stream-obuf-tail ,stream-var) ,size))
307 (incf (fd-stream-obuf-tail ,stream-var) ,size)))
308 ,(ecase (car buffering)
310 `(flush-output-buffer ,stream-var))
312 `(when (eq (char-code byte) (char-code #\Newline))
313 (flush-output-buffer ,stream-var)))
317 (defmacro def-output-routines/variable-width
318 ((name-fmt size restart external-format &rest bufferings)
320 (declare (optimize (speed 1)))
325 (intern (format nil name-fmt (string (car buffering))))))
327 (defun ,function (stream byte)
328 (output-wrapper/variable-width (stream ,size ,buffering ,restart)
330 (setf *output-routines*
331 (nconc *output-routines*
339 (cdr buffering)))))))
342 ;;; Define output routines that output numbers SIZE bytes long for the
343 ;;; given bufferings. Use BODY to do the actual output.
344 (defmacro def-output-routines ((name-fmt size restart &rest bufferings)
346 (declare (optimize (speed 1)))
351 (intern (format nil name-fmt (string (car buffering))))))
353 (defun ,function (stream byte)
354 (output-wrapper (stream ,size ,buffering ,restart)
356 (setf *output-routines*
357 (nconc *output-routines*
365 (cdr buffering)))))))
368 ;;; FIXME: is this used anywhere any more?
369 (def-output-routines ("OUTPUT-CHAR-~A-BUFFERED"
375 (if (char= byte #\Newline)
376 (setf (fd-stream-char-pos stream) 0)
377 (incf (fd-stream-char-pos stream)))
378 (setf (sap-ref-8 (fd-stream-obuf-sap stream) (fd-stream-obuf-tail stream))
381 (def-output-routines ("OUTPUT-UNSIGNED-BYTE-~A-BUFFERED"
384 (:none (unsigned-byte 8))
385 (:full (unsigned-byte 8)))
386 (setf (sap-ref-8 (fd-stream-obuf-sap stream) (fd-stream-obuf-tail stream))
389 (def-output-routines ("OUTPUT-SIGNED-BYTE-~A-BUFFERED"
392 (:none (signed-byte 8))
393 (:full (signed-byte 8)))
394 (setf (signed-sap-ref-8 (fd-stream-obuf-sap stream)
395 (fd-stream-obuf-tail stream))
398 (def-output-routines ("OUTPUT-UNSIGNED-SHORT-~A-BUFFERED"
401 (:none (unsigned-byte 16))
402 (:full (unsigned-byte 16)))
403 (setf (sap-ref-16 (fd-stream-obuf-sap stream) (fd-stream-obuf-tail stream))
406 (def-output-routines ("OUTPUT-SIGNED-SHORT-~A-BUFFERED"
409 (:none (signed-byte 16))
410 (:full (signed-byte 16)))
411 (setf (signed-sap-ref-16 (fd-stream-obuf-sap stream)
412 (fd-stream-obuf-tail stream))
415 (def-output-routines ("OUTPUT-UNSIGNED-LONG-~A-BUFFERED"
418 (:none (unsigned-byte 32))
419 (:full (unsigned-byte 32)))
420 (setf (sap-ref-32 (fd-stream-obuf-sap stream) (fd-stream-obuf-tail stream))
423 (def-output-routines ("OUTPUT-SIGNED-LONG-~A-BUFFERED"
426 (:none (signed-byte 32))
427 (:full (signed-byte 32)))
428 (setf (signed-sap-ref-32 (fd-stream-obuf-sap stream)
429 (fd-stream-obuf-tail stream))
432 ;;; Do the actual output. If there is space to buffer the string,
433 ;;; buffer it. If the string would normally fit in the buffer, but
434 ;;; doesn't because of other stuff in the buffer, flush the old noise
435 ;;; out of the buffer and put the string in it. Otherwise we have a
436 ;;; very long string, so just send it directly (after flushing the
437 ;;; buffer, of course).
438 (defun output-raw-bytes (fd-stream thing &optional start end)
440 "Output THING to FD-STREAM. THING can be any kind of vector or a SAP. If
441 THING is a SAP, END must be supplied (as length won't work)."
442 (let ((start (or start 0))
443 (end (or end (length (the (simple-array * (*)) thing)))))
444 (declare (type index start end))
445 (when (and (not (fd-stream-dual-channel-p fd-stream))
446 (> (fd-stream-ibuf-tail fd-stream)
447 (fd-stream-ibuf-head fd-stream)))
448 (file-position fd-stream (file-position fd-stream)))
449 (let* ((len (fd-stream-obuf-length fd-stream))
450 (tail (fd-stream-obuf-tail fd-stream))
452 (bytes (- end start))
453 (newtail (+ tail bytes)))
454 (cond ((minusp bytes) ; error case
455 (error ":END before :START!"))
456 ((zerop bytes)) ; easy case
458 (if (system-area-pointer-p thing)
459 (system-area-ub8-copy thing start
460 (fd-stream-obuf-sap fd-stream)
463 ;; FIXME: There should be some type checking somewhere to
464 ;; verify that THING here is a vector, not just <not a SAP>.
465 (copy-ub8-to-system-area thing start
466 (fd-stream-obuf-sap fd-stream)
469 (setf (fd-stream-obuf-tail fd-stream) newtail))
471 (flush-output-buffer fd-stream)
472 (if (system-area-pointer-p thing)
473 (system-area-ub8-copy thing
475 (fd-stream-obuf-sap fd-stream)
478 ;; FIXME: There should be some type checking somewhere to
479 ;; verify that THING here is a vector, not just <not a SAP>.
480 (copy-ub8-to-system-area thing
482 (fd-stream-obuf-sap fd-stream)
485 (setf (fd-stream-obuf-tail fd-stream) bytes))
487 (flush-output-buffer fd-stream)
488 (frob-output fd-stream thing start end nil))))))
490 ;;; the routine to use to output a string. If the stream is
491 ;;; unbuffered, slam the string down the file descriptor, otherwise
492 ;;; use OUTPUT-RAW-BYTES to buffer the string. Update charpos by
493 ;;; checking to see where the last newline was.
495 ;;; Note: some bozos (the FASL dumper) call write-string with things
496 ;;; other than strings. Therefore, we must make sure we have a string
497 ;;; before calling POSITION on it.
498 ;;; KLUDGE: It would be better to fix the bozos instead of trying to
499 ;;; cover for them here. -- WHN 20000203
500 (defun fd-sout (stream thing start end)
501 (let ((start (or start 0))
502 (end (or end (length (the vector thing)))))
503 (declare (fixnum start end))
506 (string-dispatch (simple-base-string
508 (simple-array character)
511 (and (find #\newline thing :start start :end end)
512 ;; FIXME why do we need both calls?
513 ;; Is find faster forwards than
514 ;; position is backwards?
515 (position #\newline thing
519 (if (and (typep thing 'base-string)
520 (eq (fd-stream-external-format stream) :latin-1))
521 (ecase (fd-stream-buffering stream)
523 (output-raw-bytes stream thing start end))
525 (output-raw-bytes stream thing start end)
527 (flush-output-buffer stream)))
529 (frob-output stream thing start end nil)))
530 (ecase (fd-stream-buffering stream)
531 (:full (funcall (fd-stream-output-bytes stream)
532 stream thing nil start end))
533 (:line (funcall (fd-stream-output-bytes stream)
534 stream thing last-newline start end))
535 (:none (funcall (fd-stream-output-bytes stream)
536 stream thing t start end))))
538 (setf (fd-stream-char-pos stream)
539 (- end last-newline 1))
540 (incf (fd-stream-char-pos stream)
542 (ecase (fd-stream-buffering stream)
544 (output-raw-bytes stream thing start end))
546 (frob-output stream thing start end nil))))))
548 (defvar *external-formats* ()
550 "List of all available external formats. Each element is a list of the
551 element-type, string input function name, character input function name,
552 and string output function name.")
554 ;;; Find an output routine to use given the type and buffering. Return
555 ;;; as multiple values the routine, the real type transfered, and the
556 ;;; number of bytes per element.
557 (defun pick-output-routine (type buffering &optional external-format)
558 (when (subtypep type 'character)
559 (dolist (entry *external-formats*)
560 (when (member external-format (first entry))
561 (return-from pick-output-routine
562 (values (symbol-function (nth (ecase buffering
569 (symbol-function (fourth entry))
570 (first (first entry)))))))
571 (dolist (entry *output-routines*)
572 (when (and (subtypep type (first entry))
573 (eq buffering (second entry))
574 (or (not (fifth entry))
575 (eq external-format (fifth entry))))
576 (return-from pick-output-routine
577 (values (symbol-function (third entry))
580 ;; KLUDGE: dealing with the buffering here leads to excessive code
583 ;; KLUDGE: also see comments in PICK-INPUT-ROUTINE
584 (loop for i from 40 by 8 to 1024 ; ARB (KLUDGE)
585 if (subtypep type `(unsigned-byte ,i))
586 do (return-from pick-output-routine
590 (lambda (stream byte)
591 (output-wrapper (stream (/ i 8) (:none) nil)
592 (loop for j from 0 below (/ i 8)
594 (fd-stream-obuf-sap stream)
595 (+ j (fd-stream-obuf-tail stream)))
596 (ldb (byte 8 (- i 8 (* j 8))) byte))))))
598 (lambda (stream byte)
599 (output-wrapper (stream (/ i 8) (:full) nil)
600 (loop for j from 0 below (/ i 8)
602 (fd-stream-obuf-sap stream)
603 (+ j (fd-stream-obuf-tail stream)))
604 (ldb (byte 8 (- i 8 (* j 8))) byte)))))))
607 (loop for i from 40 by 8 to 1024 ; ARB (KLUDGE)
608 if (subtypep type `(signed-byte ,i))
609 do (return-from pick-output-routine
613 (lambda (stream byte)
614 (output-wrapper (stream (/ i 8) (:none) nil)
615 (loop for j from 0 below (/ i 8)
617 (fd-stream-obuf-sap stream)
618 (+ j (fd-stream-obuf-tail stream)))
619 (ldb (byte 8 (- i 8 (* j 8))) byte))))))
621 (lambda (stream byte)
622 (output-wrapper (stream (/ i 8) (:full) nil)
623 (loop for j from 0 below (/ i 8)
625 (fd-stream-obuf-sap stream)
626 (+ j (fd-stream-obuf-tail stream)))
627 (ldb (byte 8 (- i 8 (* j 8))) byte)))))))
631 ;;;; input routines and related noise
633 ;;; a list of all available input routines. Each element is a list of
634 ;;; the element-type input, the function name, and the number of bytes
636 (defvar *input-routines* ())
638 ;;; Return whether a primitive partial read operation on STREAM's FD
639 ;;; would (probably) block. Signal a `simple-stream-error' if the
640 ;;; system call implementing this operation fails.
642 ;;; It is "may" instead of "would" because "would" is not quite
643 ;;; correct on win32. However, none of the places that use it require
644 ;;; further assurance than "may" versus "will definitely not".
645 (defun sysread-may-block-p (stream)
647 ;; This answers T at EOF on win32, I think.
648 (not (sb!win32:fd-listen (fd-stream-fd stream)))
650 (sb!unix:with-restarted-syscall (count errno)
651 (sb!alien:with-alien ((read-fds (sb!alien:struct sb!unix:fd-set)))
652 (sb!unix:fd-zero read-fds)
653 (sb!unix:fd-set (fd-stream-fd stream) read-fds)
654 (sb!unix:unix-fast-select (1+ (fd-stream-fd stream))
655 (sb!alien:addr read-fds)
661 (simple-stream-perror "couldn't check whether ~S is readable"
665 ;;; Fill the input buffer, and return the number of bytes read. Throw
666 ;;; to EOF-INPUT-CATCHER if the eof was reached. Drop into
667 ;;; SYSTEM:SERVER if necessary.
668 (defun refill-buffer/fd (stream)
669 (let ((fd (fd-stream-fd stream))
670 (ibuf-sap (fd-stream-ibuf-sap stream))
671 (buflen (fd-stream-ibuf-length stream))
672 (head (fd-stream-ibuf-head stream))
673 (tail (fd-stream-ibuf-tail stream)))
674 (declare (type index head tail))
676 (cond ((eql head tail)
679 (setf (fd-stream-ibuf-head stream) 0)
680 (setf (fd-stream-ibuf-tail stream) 0))
683 (system-area-ub8-copy ibuf-sap head
686 (setf (fd-stream-ibuf-head stream) 0)
687 (setf (fd-stream-ibuf-tail stream) tail))))
688 (setf (fd-stream-listen stream) nil)
689 ;;This isn't quite the same on win32. Then again, neither was
690 ;;(not (sb!win32:fd-listen fd)), as was originally here. See
691 ;;comment in `sysread-may-block-p'.
692 (when (sysread-may-block-p stream)
693 (unless (sb!sys:wait-until-fd-usable
694 fd :input (fd-stream-timeout stream))
695 (error 'io-timeout :stream stream :direction :read)))
696 (multiple-value-bind (count errno)
697 (sb!unix:unix-read fd
698 (sb!sys:int-sap (+ (sb!sys:sap-int ibuf-sap) tail))
701 (if #!-win32 (eql errno sb!unix:ewouldblock) #!+win32 t #!-win32
703 (unless (sb!sys:wait-until-fd-usable
704 fd :input (fd-stream-timeout stream))
705 (error 'io-timeout :stream stream :direction :read))
706 (refill-buffer/fd stream))
707 (simple-stream-perror "couldn't read from ~S" stream errno)))
709 (setf (fd-stream-listen stream) :eof)
710 (/show0 "THROWing EOF-INPUT-CATCHER")
711 (throw 'eof-input-catcher nil))
713 (incf (fd-stream-ibuf-tail stream) count)
716 ;;; Make sure there are at least BYTES number of bytes in the input
717 ;;; buffer. Keep calling REFILL-BUFFER/FD until that condition is met.
718 (defmacro input-at-least (stream bytes)
719 (let ((stream-var (gensym))
720 (bytes-var (gensym)))
721 `(let ((,stream-var ,stream)
724 (when (>= (- (fd-stream-ibuf-tail ,stream-var)
725 (fd-stream-ibuf-head ,stream-var))
728 (refill-buffer/fd ,stream-var)))))
730 (defmacro input-wrapper/variable-width ((stream bytes eof-error eof-value)
732 (let ((stream-var (gensym))
734 (element-var (gensym)))
735 `(let ((,stream-var ,stream)
737 (if (fd-stream-unread ,stream-var)
739 (fd-stream-unread ,stream-var)
740 (setf (fd-stream-unread ,stream-var) nil)
741 (setf (fd-stream-listen ,stream-var) nil))
742 (let ((,element-var nil)
743 (decode-break-reason nil))
747 (catch 'eof-input-catcher
748 (setf decode-break-reason
749 (block decode-break-reason
750 (input-at-least ,stream-var 1)
751 (let* ((byte (sap-ref-8 (fd-stream-ibuf-sap
756 (input-at-least ,stream-var size)
757 (setq ,element-var (locally ,@read-forms))
758 (setq ,retry-var nil))
760 (when decode-break-reason
761 (stream-decoding-error-and-handle stream
762 decode-break-reason))
764 (let ((octet-count (- (fd-stream-ibuf-tail ,stream-var)
765 (fd-stream-ibuf-head ,stream-var))))
766 (when (or (zerop octet-count)
767 (and (not ,element-var)
768 (not decode-break-reason)
769 (stream-decoding-error-and-handle
770 stream octet-count)))
771 (setq ,retry-var nil)))))
773 (incf (fd-stream-ibuf-head ,stream-var) size)
776 (eof-or-lose ,stream-var ,eof-error ,eof-value))))))))
778 ;;; a macro to wrap around all input routines to handle EOF-ERROR noise
779 (defmacro input-wrapper ((stream bytes eof-error eof-value) &body read-forms)
780 (let ((stream-var (gensym))
781 (element-var (gensym)))
782 `(let ((,stream-var ,stream))
783 (if (fd-stream-unread ,stream-var)
785 (fd-stream-unread ,stream-var)
786 (setf (fd-stream-unread ,stream-var) nil)
787 (setf (fd-stream-listen ,stream-var) nil))
789 (catch 'eof-input-catcher
790 (input-at-least ,stream-var ,bytes)
791 (locally ,@read-forms))))
793 (incf (fd-stream-ibuf-head ,stream-var) ,bytes)
796 (eof-or-lose ,stream-var ,eof-error ,eof-value))))))))
798 (defmacro def-input-routine/variable-width (name
799 (type external-format size sap head)
802 (defun ,name (stream eof-error eof-value)
803 (input-wrapper/variable-width (stream ,size eof-error eof-value)
804 (let ((,sap (fd-stream-ibuf-sap stream))
805 (,head (fd-stream-ibuf-head stream)))
807 (setf *input-routines*
808 (nconc *input-routines*
809 (list (list ',type ',name 1 ',external-format))))))
811 (defmacro def-input-routine (name
815 (defun ,name (stream eof-error eof-value)
816 (input-wrapper (stream ,size eof-error eof-value)
817 (let ((,sap (fd-stream-ibuf-sap stream))
818 (,head (fd-stream-ibuf-head stream)))
820 (setf *input-routines*
821 (nconc *input-routines*
822 (list (list ',type ',name ',size nil))))))
824 ;;; STREAM-IN routine for reading a string char
825 (def-input-routine input-character
826 (character 1 sap head)
827 (code-char (sap-ref-8 sap head)))
829 ;;; STREAM-IN routine for reading an unsigned 8 bit number
830 (def-input-routine input-unsigned-8bit-byte
831 ((unsigned-byte 8) 1 sap head)
832 (sap-ref-8 sap head))
834 ;;; STREAM-IN routine for reading a signed 8 bit number
835 (def-input-routine input-signed-8bit-number
836 ((signed-byte 8) 1 sap head)
837 (signed-sap-ref-8 sap head))
839 ;;; STREAM-IN routine for reading an unsigned 16 bit number
840 (def-input-routine input-unsigned-16bit-byte
841 ((unsigned-byte 16) 2 sap head)
842 (sap-ref-16 sap head))
844 ;;; STREAM-IN routine for reading a signed 16 bit number
845 (def-input-routine input-signed-16bit-byte
846 ((signed-byte 16) 2 sap head)
847 (signed-sap-ref-16 sap head))
849 ;;; STREAM-IN routine for reading a unsigned 32 bit number
850 (def-input-routine input-unsigned-32bit-byte
851 ((unsigned-byte 32) 4 sap head)
852 (sap-ref-32 sap head))
854 ;;; STREAM-IN routine for reading a signed 32 bit number
855 (def-input-routine input-signed-32bit-byte
856 ((signed-byte 32) 4 sap head)
857 (signed-sap-ref-32 sap head))
861 ;;; Find an input routine to use given the type. Return as multiple
862 ;;; values the routine, the real type transfered, and the number of
863 ;;; bytes per element (and for character types string input routine).
864 (defun pick-input-routine (type &optional external-format)
865 (when (subtypep type 'character)
866 (dolist (entry *external-formats*)
867 (when (member external-format (first entry))
868 (return-from pick-input-routine
869 (values (symbol-function (third entry))
872 (symbol-function (second entry))
873 (first (first entry)))))))
874 (dolist (entry *input-routines*)
875 (when (and (subtypep type (first entry))
876 (or (not (fourth entry))
877 (eq external-format (fourth entry))))
878 (return-from pick-input-routine
879 (values (symbol-function (second entry))
882 ;; FIXME: let's do it the hard way, then (but ignore things like
883 ;; endianness, efficiency, and the necessary coupling between these
884 ;; and the output routines). -- CSR, 2004-02-09
885 (loop for i from 40 by 8 to 1024 ; ARB (well, KLUDGE really)
886 if (subtypep type `(unsigned-byte ,i))
887 do (return-from pick-input-routine
889 (lambda (stream eof-error eof-value)
890 (input-wrapper (stream (/ i 8) eof-error eof-value)
891 (let ((sap (fd-stream-ibuf-sap stream))
892 (head (fd-stream-ibuf-head stream)))
893 (loop for j from 0 below (/ i 8)
897 (sap-ref-8 sap (+ head j))))
898 finally (return result)))))
901 (loop for i from 40 by 8 to 1024 ; ARB (well, KLUDGE really)
902 if (subtypep type `(signed-byte ,i))
903 do (return-from pick-input-routine
905 (lambda (stream eof-error eof-value)
906 (input-wrapper (stream (/ i 8) eof-error eof-value)
907 (let ((sap (fd-stream-ibuf-sap stream))
908 (head (fd-stream-ibuf-head stream)))
909 (loop for j from 0 below (/ i 8)
913 (sap-ref-8 sap (+ head j))))
914 finally (return (if (logbitp (1- i) result)
915 (dpb result (byte i 0) -1)
920 ;;; Return a string constructed from SAP, START, and END.
921 (defun string-from-sap (sap start end)
922 (declare (type index start end))
923 (let* ((length (- end start))
924 (string (make-string length)))
925 (copy-ub8-from-system-area sap start
930 ;;; the N-BIN method for FD-STREAMs
932 ;;; Note that this blocks in UNIX-READ. It is generally used where
933 ;;; there is a definite amount of reading to be done, so blocking
934 ;;; isn't too problematical.
935 (defun fd-stream-read-n-bytes (stream buffer start requested eof-error-p
936 &aux (total-copied 0))
937 (declare (type fd-stream stream))
938 (declare (type index start requested total-copied))
939 (let ((unread (fd-stream-unread stream)))
941 ;; AVERs designed to fail when we have more complicated
942 ;; character representations.
943 (aver (typep unread 'base-char))
944 (aver (= (fd-stream-element-size stream) 1))
945 ;; KLUDGE: this is a slightly-unrolled-and-inlined version of
949 (setf (sap-ref-8 buffer start) (char-code unread)))
950 ((simple-unboxed-array (*))
951 (setf (aref buffer start) unread)))
952 (setf (fd-stream-unread stream) nil)
953 (setf (fd-stream-listen stream) nil)
954 (incf total-copied)))
957 (let* ((remaining-request (- requested total-copied))
958 (head (fd-stream-ibuf-head stream))
959 (tail (fd-stream-ibuf-tail stream))
960 (available (- tail head))
961 (n-this-copy (min remaining-request available))
962 (this-start (+ start total-copied))
963 (this-end (+ this-start n-this-copy))
964 (sap (fd-stream-ibuf-sap stream)))
965 (declare (type index remaining-request head tail available))
966 (declare (type index n-this-copy))
967 ;; Copy data from stream buffer into user's buffer.
968 (%byte-blt sap head buffer this-start this-end)
969 (incf (fd-stream-ibuf-head stream) n-this-copy)
970 (incf total-copied n-this-copy)
971 ;; Maybe we need to refill the stream buffer.
972 (cond (;; If there were enough data in the stream buffer, we're done.
973 (= total-copied requested)
974 (return total-copied))
975 (;; If EOF, we're done in another way.
976 (null (catch 'eof-input-catcher (refill-buffer/fd stream)))
978 (error 'end-of-file :stream stream)
979 (return total-copied)))
980 ;; Otherwise we refilled the stream buffer, so fall
981 ;; through into another pass of the loop.
984 (defun fd-stream-resync (stream)
985 (dolist (entry *external-formats*)
986 (when (member (fd-stream-external-format stream) (first entry))
987 (return-from fd-stream-resync
988 (funcall (symbol-function (eighth entry)) stream)))))
990 (defun get-fd-stream-character-sizer (stream)
991 (dolist (entry *external-formats*)
992 (when (member (fd-stream-external-format stream) (first entry))
993 (return-from get-fd-stream-character-sizer (ninth entry)))))
995 (defun fd-stream-character-size (stream char)
996 (let ((sizer (get-fd-stream-character-sizer stream)))
997 (when sizer (funcall sizer char))))
999 (defun fd-stream-string-size (stream string)
1000 (let ((sizer (get-fd-stream-character-sizer stream)))
1002 (loop for char across string summing (funcall sizer char)))))
1004 (defun find-external-format (external-format)
1005 (when external-format
1006 (find external-format *external-formats* :test #'member :key #'car)))
1008 (defun variable-width-external-format-p (ef-entry)
1009 (when (eighth ef-entry) t))
1011 (defun bytes-for-char-fun (ef-entry)
1012 (if ef-entry (symbol-function (ninth ef-entry)) (constantly 1)))
1014 ;;; FIXME: OAOOM here vrt. *EXTERNAL-FORMAT-FUNCTIONS* in fd-stream.lisp
1015 (defmacro define-external-format (external-format size output-restart
1017 (let* ((name (first external-format))
1018 (out-function (symbolicate "OUTPUT-BYTES/" name))
1019 (format (format nil "OUTPUT-CHAR-~A-~~A-BUFFERED" (string name)))
1020 (in-function (symbolicate "FD-STREAM-READ-N-CHARACTERS/" name))
1021 (in-char-function (symbolicate "INPUT-CHAR/" name))
1022 (size-function (symbolicate "BYTES-FOR-CHAR/" name)))
1024 (defun ,size-function (byte)
1025 (declare (ignore byte))
1027 (defun ,out-function (stream string flush-p start end)
1028 (let ((start (or start 0))
1029 (end (or end (length string))))
1030 (declare (type index start end))
1031 (when (and (not (fd-stream-dual-channel-p stream))
1032 (> (fd-stream-ibuf-tail stream)
1033 (fd-stream-ibuf-head stream)))
1034 (file-position stream (file-position stream)))
1035 (unless (<= 0 start end (length string))
1036 (signal-bounding-indices-bad-error string start end))
1039 (setf (fd-stream-obuf-tail stream)
1040 (string-dispatch (simple-base-string
1042 (simple-array character)
1045 (let ((len (fd-stream-obuf-length stream))
1046 (sap (fd-stream-obuf-sap stream))
1047 (tail (fd-stream-obuf-tail stream)))
1048 (declare (type index tail)
1049 ;; STRING bounds have already been checked.
1050 (optimize (safety 0)))
1052 (,@(if output-restart
1053 `(catch 'output-nothing)
1056 ((or (= start end) (< (- len tail) 4)))
1057 (let* ((byte (aref string start))
1058 (bits (char-code byte)))
1062 ;; Exited from the loop normally
1064 ;; Exited via CATCH. Skip the current character
1065 ;; and try the inner loop again.
1068 (flush-output-buffer stream)))
1070 (flush-output-buffer stream))))
1071 (def-output-routines (,format
1077 (if (char= byte #\Newline)
1078 (setf (fd-stream-char-pos stream) 0)
1079 (incf (fd-stream-char-pos stream)))
1080 (let ((bits (char-code byte))
1081 (sap (fd-stream-obuf-sap stream))
1082 (tail (fd-stream-obuf-tail stream)))
1084 (defun ,in-function (stream buffer start requested eof-error-p
1085 &aux (index start) (end (+ start requested)))
1086 (declare (type fd-stream stream))
1087 (declare (type index start requested index end))
1088 (declare (type (simple-array character (#.+ansi-stream-in-buffer-length+)) buffer))
1089 (let ((unread (fd-stream-unread stream)))
1091 (setf (aref buffer index) unread)
1092 (setf (fd-stream-unread stream) nil)
1093 (setf (fd-stream-listen stream) nil)
1097 (let* ((head (fd-stream-ibuf-head stream))
1098 (tail (fd-stream-ibuf-tail stream))
1099 (sap (fd-stream-ibuf-sap stream)))
1100 (declare (type index head tail)
1101 (type system-area-pointer sap))
1102 ;; Copy data from stream buffer into user's buffer.
1103 (dotimes (i (min (truncate (- tail head) ,size)
1105 (declare (optimize speed))
1106 (let* ((byte (sap-ref-8 sap head)))
1107 (setf (aref buffer index) ,in-expr)
1110 (setf (fd-stream-ibuf-head stream) head)
1111 ;; Maybe we need to refill the stream buffer.
1112 (cond ( ;; If there was enough data in the stream buffer, we're done.
1114 (return (- index start)))
1115 ( ;; If EOF, we're done in another way.
1116 (null (catch 'eof-input-catcher (refill-buffer/fd stream)))
1118 (error 'end-of-file :stream stream)
1119 (return (- index start))))
1120 ;; Otherwise we refilled the stream buffer, so fall
1121 ;; through into another pass of the loop.
1123 (def-input-routine ,in-char-function (character ,size sap head)
1124 (let ((byte (sap-ref-8 sap head)))
1126 (setf *external-formats*
1127 (cons '(,external-format ,in-function ,in-char-function ,out-function
1128 ,@(mapcar #'(lambda (buffering)
1129 (intern (format nil format (string buffering))))
1130 '(:none :line :full))
1131 nil ; no resync-function
1133 *external-formats*)))))
1135 (defmacro define-external-format/variable-width
1136 (external-format output-restart out-size-expr
1137 out-expr in-size-expr in-expr)
1138 (let* ((name (first external-format))
1139 (out-function (symbolicate "OUTPUT-BYTES/" name))
1140 (format (format nil "OUTPUT-CHAR-~A-~~A-BUFFERED" (string name)))
1141 (in-function (symbolicate "FD-STREAM-READ-N-CHARACTERS/" name))
1142 (in-char-function (symbolicate "INPUT-CHAR/" name))
1143 (resync-function (symbolicate "RESYNC/" name))
1144 (size-function (symbolicate "BYTES-FOR-CHAR/" name)))
1146 (defun ,size-function (byte)
1148 (defun ,out-function (stream string flush-p start end)
1149 (let ((start (or start 0))
1150 (end (or end (length string))))
1151 (declare (type index start end))
1152 (when (and (not (fd-stream-dual-channel-p stream))
1153 (> (fd-stream-ibuf-tail stream)
1154 (fd-stream-ibuf-head stream)))
1155 (file-position stream (file-position stream)))
1156 (unless (<= 0 start end (length string))
1157 (signal-bounding-indices-bad-error string start end))
1160 (setf (fd-stream-obuf-tail stream)
1161 (string-dispatch (simple-base-string
1163 (simple-array character)
1166 (let ((len (fd-stream-obuf-length stream))
1167 (sap (fd-stream-obuf-sap stream))
1168 (tail (fd-stream-obuf-tail stream)))
1169 (declare (type index tail)
1170 ;; STRING bounds have already been checked.
1171 (optimize (safety 0)))
1173 (,@(if output-restart
1174 `(catch 'output-nothing)
1177 ((or (= start end) (< (- len tail) 4)))
1178 (let* ((byte (aref string start))
1179 (bits (char-code byte))
1180 (size ,out-size-expr))
1184 ;; Exited from the loop normally
1186 ;; Exited via CATCH. Skip the current character
1187 ;; and try the inner loop again.
1190 (flush-output-buffer stream)))
1192 (flush-output-buffer stream))))
1193 (def-output-routines/variable-width (,format
1200 (if (char= byte #\Newline)
1201 (setf (fd-stream-char-pos stream) 0)
1202 (incf (fd-stream-char-pos stream)))
1203 (let ((bits (char-code byte))
1204 (sap (fd-stream-obuf-sap stream))
1205 (tail (fd-stream-obuf-tail stream)))
1207 (defun ,in-function (stream buffer start requested eof-error-p
1208 &aux (total-copied 0))
1209 (declare (type fd-stream stream))
1210 (declare (type index start requested total-copied))
1211 (declare (type (simple-array character (#.+ansi-stream-in-buffer-length+)) buffer))
1212 (let ((unread (fd-stream-unread stream)))
1214 (setf (aref buffer start) unread)
1215 (setf (fd-stream-unread stream) nil)
1216 (setf (fd-stream-listen stream) nil)
1217 (incf total-copied)))
1220 (let* ((head (fd-stream-ibuf-head stream))
1221 (tail (fd-stream-ibuf-tail stream))
1222 (sap (fd-stream-ibuf-sap stream))
1223 (decode-break-reason nil))
1224 (declare (type index head tail))
1225 ;; Copy data from stream buffer into user's buffer.
1226 (do ((size nil nil))
1227 ((or (= tail head) (= requested total-copied)))
1228 (setf decode-break-reason
1229 (block decode-break-reason
1230 (let ((byte (sap-ref-8 sap head)))
1231 (setq size ,in-size-expr)
1232 (when (> size (- tail head))
1234 (setf (aref buffer (+ start total-copied)) ,in-expr)
1238 (setf (fd-stream-ibuf-head stream) head)
1239 (when decode-break-reason
1240 ;; If we've already read some characters on when the invalid
1241 ;; code sequence is detected, we return immediately. The
1242 ;; handling of the error is deferred until the next call
1243 ;; (where this check will be false). This allows establishing
1244 ;; high-level handlers for decode errors (for example
1245 ;; automatically resyncing in Lisp comments).
1246 (when (plusp total-copied)
1247 (return-from ,in-function total-copied))
1248 (when (stream-decoding-error-and-handle
1249 stream decode-break-reason)
1251 (error 'end-of-file :stream stream)
1252 (return-from ,in-function total-copied)))
1253 (setf head (fd-stream-ibuf-head stream))
1254 (setf tail (fd-stream-ibuf-tail stream))))
1255 (setf (fd-stream-ibuf-head stream) head)
1256 ;; Maybe we need to refill the stream buffer.
1257 (cond ( ;; If there were enough data in the stream buffer, we're done.
1258 (= total-copied requested)
1259 (return total-copied))
1260 ( ;; If EOF, we're done in another way.
1261 (or (eq decode-break-reason 'eof)
1262 (null (catch 'eof-input-catcher
1263 (refill-buffer/fd stream))))
1265 (error 'end-of-file :stream stream)
1266 (return total-copied)))
1267 ;; Otherwise we refilled the stream buffer, so fall
1268 ;; through into another pass of the loop.
1270 (def-input-routine/variable-width ,in-char-function (character
1274 (let ((byte (sap-ref-8 sap head)))
1276 (defun ,resync-function (stream)
1277 (loop (input-at-least stream 2)
1278 (incf (fd-stream-ibuf-head stream))
1279 (unless (block decode-break-reason
1280 (let* ((sap (fd-stream-ibuf-sap stream))
1281 (head (fd-stream-ibuf-head stream))
1282 (byte (sap-ref-8 sap head))
1283 (size ,in-size-expr))
1284 (input-at-least stream size)
1285 (let ((sap (fd-stream-ibuf-sap stream))
1286 (head (fd-stream-ibuf-head stream)))
1290 (setf *external-formats*
1291 (cons '(,external-format ,in-function ,in-char-function ,out-function
1292 ,@(mapcar #'(lambda (buffering)
1293 (intern (format nil format (string buffering))))
1294 '(:none :line :full))
1297 *external-formats*)))))
1299 ;;; Multiple names for the :ISO{,-}8859-* families are needed because on
1300 ;;; FreeBSD (and maybe other BSD systems), nl_langinfo("LATIN-1") will
1301 ;;; return "ISO8859-1" instead of "ISO-8859-1".
1302 (define-external-format (:latin-1 :latin1 :iso-8859-1 :iso8859-1)
1305 (stream-encoding-error-and-handle stream bits)
1306 (setf (sap-ref-8 sap tail) bits))
1309 (define-external-format (:ascii :us-ascii :ansi_x3.4-1968
1310 :iso-646 :iso-646-us :|646|)
1313 (stream-encoding-error-and-handle stream bits)
1314 (setf (sap-ref-8 sap tail) bits))
1317 (let* ((table (let ((s (make-string 256)))
1318 (map-into s #'code-char
1319 '(#x00 #x01 #x02 #x03 #x9c #x09 #x86 #x7f #x97 #x8d #x8e #x0b #x0c #x0d #x0e #x0f
1320 #x10 #x11 #x12 #x13 #x9d #x85 #x08 #x87 #x18 #x19 #x92 #x8f #x1c #x1d #x1e #x1f
1321 #x80 #x81 #x82 #x83 #x84 #x0a #x17 #x1b #x88 #x89 #x8a #x8b #x8c #x05 #x06 #x07
1322 #x90 #x91 #x16 #x93 #x94 #x95 #x96 #x04 #x98 #x99 #x9a #x9b #x14 #x15 #x9e #x1a
1323 #x20 #xa0 #xe2 #xe4 #xe0 #xe1 #xe3 #xe5 #xe7 #xf1 #xa2 #x2e #x3c #x28 #x2b #x7c
1324 #x26 #xe9 #xea #xeb #xe8 #xed #xee #xef #xec #xdf #x21 #x24 #x2a #x29 #x3b #xac
1325 #x2d #x2f #xc2 #xc4 #xc0 #xc1 #xc3 #xc5 #xc7 #xd1 #xa6 #x2c #x25 #x5f #x3e #x3f
1326 #xf8 #xc9 #xca #xcb #xc8 #xcd #xce #xcf #xcc #x60 #x3a #x23 #x40 #x27 #x3d #x22
1327 #xd8 #x61 #x62 #x63 #x64 #x65 #x66 #x67 #x68 #x69 #xab #xbb #xf0 #xfd #xfe #xb1
1328 #xb0 #x6a #x6b #x6c #x6d #x6e #x6f #x70 #x71 #x72 #xaa #xba #xe6 #xb8 #xc6 #xa4
1329 #xb5 #x7e #x73 #x74 #x75 #x76 #x77 #x78 #x79 #x7a #xa1 #xbf #xd0 #xdd #xde #xae
1330 #x5e #xa3 #xa5 #xb7 #xa9 #xa7 #xb6 #xbc #xbd #xbe #x5b #x5d #xaf #xa8 #xb4 #xd7
1331 #x7b #x41 #x42 #x43 #x44 #x45 #x46 #x47 #x48 #x49 #xad #xf4 #xf6 #xf2 #xf3 #xf5
1332 #x7d #x4a #x4b #x4c #x4d #x4e #x4f #x50 #x51 #x52 #xb9 #xfb #xfc #xf9 #xfa #xff
1333 #x5c #xf7 #x53 #x54 #x55 #x56 #x57 #x58 #x59 #x5a #xb2 #xd4 #xd6 #xd2 #xd3 #xd5
1334 #x30 #x31 #x32 #x33 #x34 #x35 #x36 #x37 #x38 #x39 #xb3 #xdb #xdc #xd9 #xda #x9f))
1336 (reverse-table (let ((rt (make-array 256 :element-type '(unsigned-byte 8) :initial-element 0)))
1337 (loop for char across table for i from 0
1338 do (aver (= 0 (aref rt (char-code char))))
1339 do (setf (aref rt (char-code char)) i))
1341 (define-external-format (:ebcdic-us :ibm-037 :ibm037)
1344 (stream-encoding-error-and-handle stream bits)
1345 (setf (sap-ref-8 sap tail) (aref reverse-table bits)))
1350 (let ((latin-9-table (let ((table (make-string 256)))
1353 (setf (aref table i) (code-char i)))
1354 (setf (aref table #xa4) (code-char #x20ac))
1355 (setf (aref table #xa6) (code-char #x0160))
1356 (setf (aref table #xa8) (code-char #x0161))
1357 (setf (aref table #xb4) (code-char #x017d))
1358 (setf (aref table #xb8) (code-char #x017e))
1359 (setf (aref table #xbc) (code-char #x0152))
1360 (setf (aref table #xbd) (code-char #x0153))
1361 (setf (aref table #xbe) (code-char #x0178))
1363 (latin-9-reverse-1 (make-array 16
1364 :element-type '(unsigned-byte 21)
1365 :initial-contents '(#x0160 #x0161 #x0152 #x0153 0 0 0 0 #x0178 0 0 0 #x20ac #x017d #x017e 0)))
1366 (latin-9-reverse-2 (make-array 16
1367 :element-type '(unsigned-byte 8)
1368 :initial-contents '(#xa6 #xa8 #xbc #xbd 0 0 0 0 #xbe 0 0 0 #xa4 #xb4 #xb8 0))))
1369 (define-external-format (:latin-9 :latin9 :iso-8859-15 :iso8859-15)
1371 (setf (sap-ref-8 sap tail)
1373 (if (= bits (char-code (aref latin-9-table bits)))
1375 (stream-encoding-error-and-handle stream byte))
1376 (if (= (aref latin-9-reverse-1 (logand bits 15)) bits)
1377 (aref latin-9-reverse-2 (logand bits 15))
1378 (stream-encoding-error-and-handle stream byte))))
1379 (aref latin-9-table byte)))
1381 (define-external-format/variable-width (:utf-8 :utf8) nil
1382 (let ((bits (char-code byte)))
1383 (cond ((< bits #x80) 1)
1385 ((< bits #x10000) 3)
1388 (1 (setf (sap-ref-8 sap tail) bits))
1389 (2 (setf (sap-ref-8 sap tail) (logior #xc0 (ldb (byte 5 6) bits))
1390 (sap-ref-8 sap (1+ tail)) (logior #x80 (ldb (byte 6 0) bits))))
1391 (3 (setf (sap-ref-8 sap tail) (logior #xe0 (ldb (byte 4 12) bits))
1392 (sap-ref-8 sap (1+ tail)) (logior #x80 (ldb (byte 6 6) bits))
1393 (sap-ref-8 sap (+ 2 tail)) (logior #x80 (ldb (byte 6 0) bits))))
1394 (4 (setf (sap-ref-8 sap tail) (logior #xf0 (ldb (byte 3 18) bits))
1395 (sap-ref-8 sap (1+ tail)) (logior #x80 (ldb (byte 6 12) bits))
1396 (sap-ref-8 sap (+ 2 tail)) (logior #x80 (ldb (byte 6 6) bits))
1397 (sap-ref-8 sap (+ 3 tail)) (logior #x80 (ldb (byte 6 0) bits)))))
1398 (cond ((< byte #x80) 1)
1399 ((< byte #xc2) (return-from decode-break-reason 1))
1403 (code-char (ecase size
1405 (2 (let ((byte2 (sap-ref-8 sap (1+ head))))
1406 (unless (<= #x80 byte2 #xbf)
1407 (return-from decode-break-reason 2))
1408 (dpb byte (byte 5 6) byte2)))
1409 (3 (let ((byte2 (sap-ref-8 sap (1+ head)))
1410 (byte3 (sap-ref-8 sap (+ 2 head))))
1411 (unless (and (<= #x80 byte2 #xbf)
1412 (<= #x80 byte3 #xbf))
1413 (return-from decode-break-reason 3))
1414 (dpb byte (byte 4 12) (dpb byte2 (byte 6 6) byte3))))
1415 (4 (let ((byte2 (sap-ref-8 sap (1+ head)))
1416 (byte3 (sap-ref-8 sap (+ 2 head)))
1417 (byte4 (sap-ref-8 sap (+ 3 head))))
1418 (unless (and (<= #x80 byte2 #xbf)
1419 (<= #x80 byte3 #xbf)
1420 (<= #x80 byte4 #xbf))
1421 (return-from decode-break-reason 4))
1422 (dpb byte (byte 3 18)
1423 (dpb byte2 (byte 6 12)
1424 (dpb byte3 (byte 6 6) byte4))))))))
1426 ;;;; utility functions (misc routines, etc)
1428 ;;; Fill in the various routine slots for the given type. INPUT-P and
1429 ;;; OUTPUT-P indicate what slots to fill. The buffering slot must be
1430 ;;; set prior to calling this routine.
1431 (defun set-fd-stream-routines (fd-stream element-type external-format
1432 input-p output-p buffer-p)
1433 (let* ((target-type (case element-type
1434 (unsigned-byte '(unsigned-byte 8))
1435 (signed-byte '(signed-byte 8))
1436 (:default 'character)
1438 (character-stream-p (subtypep target-type 'character))
1439 (bivalent-stream-p (eq element-type :default))
1440 normalized-external-format
1441 (bin-routine #'ill-bin)
1444 (cin-routine #'ill-in)
1447 (input-type nil) ;calculated from bin-type/cin-type
1448 (input-size nil) ;calculated from bin-size/cin-size
1449 (read-n-characters #'ill-in)
1450 (bout-routine #'ill-bout)
1453 (cout-routine #'ill-out)
1458 (output-bytes #'ill-bout))
1460 ;; drop buffers when direction changes
1461 (when (and (fd-stream-obuf-sap fd-stream) (not output-p))
1462 (with-available-buffers-lock ()
1463 (push (fd-stream-obuf-sap fd-stream) *available-buffers*)
1464 (setf (fd-stream-obuf-sap fd-stream) nil)))
1465 (when (and (fd-stream-ibuf-sap fd-stream) (not input-p))
1466 (with-available-buffers-lock ()
1467 (push (fd-stream-ibuf-sap fd-stream) *available-buffers*)
1468 (setf (fd-stream-ibuf-sap fd-stream) nil)))
1470 (setf (fd-stream-ibuf-sap fd-stream) (next-available-buffer))
1471 (setf (fd-stream-ibuf-length fd-stream) bytes-per-buffer)
1472 (setf (fd-stream-ibuf-tail fd-stream) 0))
1474 (setf (fd-stream-obuf-sap fd-stream) (next-available-buffer))
1475 (setf (fd-stream-obuf-length fd-stream) bytes-per-buffer)
1476 (setf (fd-stream-obuf-tail fd-stream) 0)
1477 (setf (fd-stream-char-pos fd-stream) 0))
1479 (when (and character-stream-p
1480 (eq external-format :default))
1481 (/show0 "/getting default external format")
1482 (setf external-format (default-external-format)))
1485 (when (or (not character-stream-p) bivalent-stream-p)
1486 (multiple-value-setq (bin-routine bin-type bin-size read-n-characters
1487 normalized-external-format)
1488 (pick-input-routine (if bivalent-stream-p '(unsigned-byte 8)
1492 (error "could not find any input routine for ~S" target-type)))
1493 (when character-stream-p
1494 (multiple-value-setq (cin-routine cin-type cin-size read-n-characters
1495 normalized-external-format)
1496 (pick-input-routine target-type external-format))
1498 (error "could not find any input routine for ~S" target-type)))
1499 (setf (fd-stream-in fd-stream) cin-routine
1500 (fd-stream-bin fd-stream) bin-routine)
1501 ;; character type gets preferential treatment
1502 (setf input-size (or cin-size bin-size))
1503 (setf input-type (or cin-type bin-type))
1504 (when normalized-external-format
1505 (setf (fd-stream-external-format fd-stream)
1506 normalized-external-format))
1507 (when (= (or cin-size 1) (or bin-size 1) 1)
1508 (setf (fd-stream-n-bin fd-stream) ;XXX
1509 (if (and character-stream-p (not bivalent-stream-p))
1511 #'fd-stream-read-n-bytes))
1512 ;; Sometimes turn on fast-read-char/fast-read-byte. Switch on
1513 ;; for character and (unsigned-byte 8) streams. In these
1514 ;; cases, fast-read-* will read from the
1515 ;; ansi-stream-(c)in-buffer, saving function calls.
1516 ;; Otherwise, the various data-reading functions in the stream
1517 ;; structure will be called.
1519 (not bivalent-stream-p)
1520 ;; temporary disable on :io streams
1522 (cond (character-stream-p
1523 (setf (ansi-stream-cin-buffer fd-stream)
1524 (make-array +ansi-stream-in-buffer-length+
1525 :element-type 'character)))
1526 ((equal target-type '(unsigned-byte 8))
1527 (setf (ansi-stream-in-buffer fd-stream)
1528 (make-array +ansi-stream-in-buffer-length+
1529 :element-type '(unsigned-byte 8))))))))
1532 (when (or (not character-stream-p) bivalent-stream-p)
1533 (multiple-value-setq (bout-routine bout-type bout-size output-bytes
1534 normalized-external-format)
1535 (pick-output-routine (if bivalent-stream-p
1538 (fd-stream-buffering fd-stream)
1540 (unless bout-routine
1541 (error "could not find any output routine for ~S buffered ~S"
1542 (fd-stream-buffering fd-stream)
1544 (when character-stream-p
1545 (multiple-value-setq (cout-routine cout-type cout-size output-bytes
1546 normalized-external-format)
1547 (pick-output-routine target-type
1548 (fd-stream-buffering fd-stream)
1550 (unless cout-routine
1551 (error "could not find any output routine for ~S buffered ~S"
1552 (fd-stream-buffering fd-stream)
1554 (when normalized-external-format
1555 (setf (fd-stream-external-format fd-stream)
1556 normalized-external-format))
1557 (when character-stream-p
1558 (setf (fd-stream-output-bytes fd-stream) output-bytes))
1559 (setf (fd-stream-out fd-stream) cout-routine
1560 (fd-stream-bout fd-stream) bout-routine
1561 (fd-stream-sout fd-stream) (if (eql cout-size 1)
1562 #'fd-sout #'ill-out))
1563 (setf output-size (or cout-size bout-size))
1564 (setf output-type (or cout-type bout-type)))
1566 (when (and input-size output-size
1567 (not (eq input-size output-size)))
1568 (error "Element sizes for input (~S:~S) and output (~S:~S) differ?"
1569 input-type input-size
1570 output-type output-size))
1571 (setf (fd-stream-element-size fd-stream)
1572 (or input-size output-size))
1574 (setf (fd-stream-element-type fd-stream)
1575 (cond ((equal input-type output-type)
1581 ((subtypep input-type output-type)
1583 ((subtypep output-type input-type)
1586 (error "Input type (~S) and output type (~S) are unrelated?"
1590 ;;; Handle miscellaneous operations on FD-STREAM.
1591 (defun fd-stream-misc-routine (fd-stream operation &optional arg1 arg2)
1592 (declare (ignore arg2))
1595 (labels ((do-listen ()
1596 (or (not (eql (fd-stream-ibuf-head fd-stream)
1597 (fd-stream-ibuf-tail fd-stream)))
1598 (fd-stream-listen fd-stream)
1600 (sb!win32:fd-listen (fd-stream-fd fd-stream))
1602 ;; If the read can block, LISTEN will certainly return NIL.
1603 (if (sysread-may-block-p fd-stream)
1605 ;; Otherwise select(2) and CL:LISTEN have slightly
1606 ;; different semantics. The former returns that an FD
1607 ;; is readable when a read operation wouldn't block.
1608 ;; That includes EOF. However, LISTEN must return NIL
1610 (progn (catch 'eof-input-catcher
1611 ;; r-b/f too calls select, but it shouldn't
1612 ;; block as long as read can return once w/o
1614 (refill-buffer/fd fd-stream))
1615 ;; At this point either IBUF-HEAD != IBUF-TAIL
1616 ;; and FD-STREAM-LISTEN is NIL, in which case
1617 ;; we should return T, or IBUF-HEAD ==
1618 ;; IBUF-TAIL and FD-STREAM-LISTEN is :EOF, in
1619 ;; which case we should return :EOF for this
1620 ;; call and all future LISTEN call on this stream.
1621 ;; Call ourselves again to determine which case
1626 (setf (fd-stream-unread fd-stream) arg1)
1627 (setf (fd-stream-listen fd-stream) t))
1629 (cond (arg1 ; We got us an abort on our hands.
1630 (when (fd-stream-handler fd-stream)
1631 (sb!sys:remove-fd-handler (fd-stream-handler fd-stream))
1632 (setf (fd-stream-handler fd-stream) nil))
1633 ;; We can't do anything unless we know what file were
1634 ;; dealing with, and we don't want to do anything
1635 ;; strange unless we were writing to the file.
1636 (when (and (fd-stream-file fd-stream)
1637 (fd-stream-obuf-sap fd-stream))
1638 (if (fd-stream-original fd-stream)
1639 ;; If the original is EQ to file we are appending
1640 ;; and can just close the file without renaming.
1641 (unless (eq (fd-stream-original fd-stream)
1642 (fd-stream-file fd-stream))
1643 ;; We have a handle on the original, just revert.
1644 (multiple-value-bind (okay err)
1645 (sb!unix:unix-rename (fd-stream-original fd-stream)
1646 (fd-stream-file fd-stream))
1648 (simple-stream-perror
1649 "couldn't restore ~S to its original contents"
1652 ;; We can't restore the original, and aren't
1653 ;; appending, so nuke that puppy.
1655 ;; FIXME: This is currently the fate of superseded
1656 ;; files, and according to the CLOSE spec this is
1657 ;; wrong. However, there seems to be no clean way to
1658 ;; do that that doesn't involve either copying the
1659 ;; data (bad if the :abort resulted from a full
1660 ;; disk), or renaming the old file temporarily
1661 ;; (probably bad because stream opening becomes more
1663 (multiple-value-bind (okay err)
1664 (sb!unix:unix-unlink (fd-stream-file fd-stream))
1666 (error 'simple-file-error
1667 :pathname (fd-stream-file fd-stream)
1669 "~@<couldn't remove ~S: ~2I~_~A~:>"
1670 :format-arguments (list (fd-stream-file fd-stream)
1671 (strerror err))))))))
1673 (fd-stream-misc-routine fd-stream :finish-output)
1674 (when (and (fd-stream-original fd-stream)
1675 (fd-stream-delete-original fd-stream))
1676 (multiple-value-bind (okay err)
1677 (sb!unix:unix-unlink (fd-stream-original fd-stream))
1679 (error 'simple-file-error
1680 :pathname (fd-stream-original fd-stream)
1682 "~@<couldn't delete ~S during close of ~S: ~
1685 (list (fd-stream-original fd-stream)
1687 (strerror err))))))))
1688 (when (fboundp 'cancel-finalization)
1689 (cancel-finalization fd-stream))
1690 (sb!unix:unix-close (fd-stream-fd fd-stream))
1691 (when (fd-stream-obuf-sap fd-stream)
1692 (with-available-buffers-lock ()
1693 (push (fd-stream-obuf-sap fd-stream) *available-buffers*)
1694 (setf (fd-stream-obuf-sap fd-stream) nil)))
1695 (when (fd-stream-ibuf-sap fd-stream)
1696 (with-available-buffers-lock ()
1697 (push (fd-stream-ibuf-sap fd-stream) *available-buffers*)
1698 (setf (fd-stream-ibuf-sap fd-stream) nil)))
1699 (sb!impl::set-closed-flame fd-stream))
1701 (setf (fd-stream-unread fd-stream) nil)
1702 (setf (fd-stream-ibuf-head fd-stream) 0)
1703 (setf (fd-stream-ibuf-tail fd-stream) 0)
1706 (sb!win32:fd-clear-input (fd-stream-fd fd-stream))
1707 (setf (fd-stream-listen fd-stream) nil))
1709 (catch 'eof-input-catcher
1710 (loop until (sysread-may-block-p fd-stream)
1712 (refill-buffer/fd fd-stream)
1713 (setf (fd-stream-ibuf-head fd-stream) 0)
1714 (setf (fd-stream-ibuf-tail fd-stream) 0))
1717 (flush-output-buffer fd-stream))
1719 (flush-output-buffer fd-stream)
1721 ((null (fd-stream-output-later fd-stream)))
1722 (sb!sys:serve-all-events)))
1724 (fd-stream-element-type fd-stream))
1726 (fd-stream-external-format fd-stream))
1728 (= 1 (the (member 0 1)
1729 (sb!unix:unix-isatty (fd-stream-fd fd-stream)))))
1733 (fd-stream-char-pos fd-stream))
1735 (unless (fd-stream-file fd-stream)
1736 ;; This is a TYPE-ERROR because ANSI's species FILE-LENGTH
1737 ;; "should signal an error of type TYPE-ERROR if stream is not
1738 ;; a stream associated with a file". Too bad there's no very
1739 ;; appropriate value for the EXPECTED-TYPE slot..
1740 (error 'simple-type-error
1742 :expected-type 'fd-stream
1743 :format-control "~S is not a stream associated with a file."
1744 :format-arguments (list fd-stream)))
1745 (multiple-value-bind (okay dev ino mode nlink uid gid rdev size
1746 atime mtime ctime blksize blocks)
1747 (sb!unix:unix-fstat (fd-stream-fd fd-stream))
1748 (declare (ignore ino nlink uid gid rdev
1749 atime mtime ctime blksize blocks))
1751 (simple-stream-perror "failed Unix fstat(2) on ~S" fd-stream dev))
1754 (truncate size (fd-stream-element-size fd-stream)))))
1755 (:file-string-length
1757 (character (fd-stream-character-size fd-stream arg1))
1758 (string (fd-stream-string-size fd-stream arg1))))
1760 (fd-stream-file-position fd-stream arg1))))
1762 (defun fd-stream-file-position (stream &optional newpos)
1763 (declare (type fd-stream stream)
1764 (type (or (alien sb!unix:off-t) (member nil :start :end)) newpos))
1766 (sb!sys:without-interrupts
1767 ;; First, find the position of the UNIX file descriptor in the file.
1768 (multiple-value-bind (posn errno)
1769 (sb!unix:unix-lseek (fd-stream-fd stream) 0 sb!unix:l_incr)
1770 (declare (type (or (alien sb!unix:off-t) null) posn))
1771 (cond ((integerp posn)
1772 ;; Adjust for buffered output: If there is any output
1773 ;; buffered, the *real* file position will be larger
1774 ;; than reported by lseek() because lseek() obviously
1775 ;; cannot take into account output we have not sent
1777 (dolist (later (fd-stream-output-later stream))
1778 (incf posn (- (caddr later)
1780 (incf posn (fd-stream-obuf-tail stream))
1781 ;; Adjust for unread input: If there is any input
1782 ;; read from UNIX but not supplied to the user of the
1783 ;; stream, the *real* file position will smaller than
1784 ;; reported, because we want to look like the unread
1785 ;; stuff is still available.
1786 (decf posn (- (fd-stream-ibuf-tail stream)
1787 (fd-stream-ibuf-head stream)))
1788 (when (fd-stream-unread stream)
1790 ;; Divide bytes by element size.
1791 (truncate posn (fd-stream-element-size stream)))
1792 ((eq errno sb!unix:espipe)
1795 (sb!sys:with-interrupts
1796 (simple-stream-perror "failure in Unix lseek() on ~S"
1799 (let ((offset 0) origin)
1800 (declare (type (alien sb!unix:off-t) offset))
1801 ;; Make sure we don't have any output pending, because if we
1802 ;; move the file pointer before writing this stuff, it will be
1803 ;; written in the wrong location.
1804 (flush-output-buffer stream)
1806 ((null (fd-stream-output-later stream)))
1807 (sb!sys:serve-all-events))
1808 ;; Clear out any pending input to force the next read to go to
1810 (setf (fd-stream-unread stream) nil)
1811 (setf (fd-stream-ibuf-head stream) 0)
1812 (setf (fd-stream-ibuf-tail stream) 0)
1813 ;; Trash cached value for listen, so that we check next time.
1814 (setf (fd-stream-listen stream) nil)
1816 (cond ((eq newpos :start)
1817 (setf offset 0 origin sb!unix:l_set))
1819 (setf offset 0 origin sb!unix:l_xtnd))
1820 ((typep newpos '(alien sb!unix:off-t))
1821 (setf offset (* newpos (fd-stream-element-size stream))
1822 origin sb!unix:l_set))
1824 (error "invalid position given to FILE-POSITION: ~S" newpos)))
1825 (multiple-value-bind (posn errno)
1826 (sb!unix:unix-lseek (fd-stream-fd stream) offset origin)
1827 (cond ((typep posn '(alien sb!unix:off-t))
1829 ((eq errno sb!unix:espipe)
1832 (simple-stream-perror "error in Unix lseek() on ~S"
1836 ;;;; creation routines (MAKE-FD-STREAM and OPEN)
1838 ;;; Create a stream for the given Unix file descriptor.
1840 ;;; If INPUT is non-NIL, allow input operations. If OUTPUT is non-nil,
1841 ;;; allow output operations. If neither INPUT nor OUTPUT is specified,
1842 ;;; default to allowing input.
1844 ;;; ELEMENT-TYPE indicates the element type to use (as for OPEN).
1846 ;;; BUFFERING indicates the kind of buffering to use.
1848 ;;; TIMEOUT (if true) is the number of seconds to wait for input. If
1849 ;;; NIL (the default), then wait forever. When we time out, we signal
1852 ;;; FILE is the name of the file (will be returned by PATHNAME).
1854 ;;; NAME is used to identify the stream when printed.
1855 (defun make-fd-stream (fd
1858 (output nil output-p)
1859 (element-type 'base-char)
1861 (external-format :default)
1870 (format nil "file ~A" file)
1871 (format nil "descriptor ~W" fd)))
1873 (declare (type index fd) (type (or index null) timeout)
1874 (type (member :none :line :full) buffering))
1875 (cond ((not (or input-p output-p))
1877 ((not (or input output))
1878 (error "File descriptor must be opened either for input or output.")))
1879 (let ((stream (%make-fd-stream :fd fd
1883 :delete-original delete-original
1885 :buffering buffering
1886 :dual-channel-p dual-channel-p
1887 :external-format external-format
1889 (set-fd-stream-routines stream element-type external-format
1890 input output input-buffer-p)
1891 (when (and auto-close (fboundp 'finalize))
1894 (sb!unix:unix-close fd)
1896 (format *terminal-io* "** closed file descriptor ~W **~%"
1900 ;;; Pick a name to use for the backup file for the :IF-EXISTS
1901 ;;; :RENAME-AND-DELETE and :RENAME options.
1902 (defun pick-backup-name (name)
1903 (declare (type simple-base-string name))
1904 (concatenate 'simple-base-string name ".bak"))
1906 ;;; Ensure that the given arg is one of the given list of valid
1907 ;;; things. Allow the user to fix any problems.
1908 (defun ensure-one-of (item list what)
1909 (unless (member item list)
1910 (error 'simple-type-error
1912 :expected-type `(member ,@list)
1913 :format-control "~@<~S is ~_invalid for ~S; ~_need one of~{ ~S~}~:>"
1914 :format-arguments (list item what list))))
1916 ;;; Rename NAMESTRING to ORIGINAL. First, check whether we have write
1917 ;;; access, since we don't want to trash unwritable files even if we
1918 ;;; technically can. We return true if we succeed in renaming.
1919 (defun rename-the-old-one (namestring original)
1920 (unless (sb!unix:unix-access namestring sb!unix:w_ok)
1921 (error "~@<The file ~2I~_~S ~I~_is not writable.~:>" namestring))
1922 (multiple-value-bind (okay err) (sb!unix:unix-rename namestring original)
1925 (error 'simple-file-error
1926 :pathname namestring
1928 "~@<couldn't rename ~2I~_~S ~I~_to ~2I~_~S: ~4I~_~A~:>"
1929 :format-arguments (list namestring original (strerror err))))))
1931 (defun open (filename
1934 (element-type 'base-char)
1935 (if-exists nil if-exists-given)
1936 (if-does-not-exist nil if-does-not-exist-given)
1937 (external-format :default)
1938 &aux ; Squelch assignment warning.
1939 (direction direction)
1940 (if-does-not-exist if-does-not-exist)
1941 (if-exists if-exists))
1943 "Return a stream which reads from or writes to FILENAME.
1945 :DIRECTION - one of :INPUT, :OUTPUT, :IO, or :PROBE
1946 :ELEMENT-TYPE - the type of object to read or write, default BASE-CHAR
1947 :IF-EXISTS - one of :ERROR, :NEW-VERSION, :RENAME, :RENAME-AND-DELETE,
1948 :OVERWRITE, :APPEND, :SUPERSEDE or NIL
1949 :IF-DOES-NOT-EXIST - one of :ERROR, :CREATE or NIL
1950 See the manual for details."
1952 ;; Calculate useful stuff.
1953 (multiple-value-bind (input output mask)
1955 (:input (values t nil sb!unix:o_rdonly))
1956 (:output (values nil t sb!unix:o_wronly))
1957 (:io (values t t sb!unix:o_rdwr))
1958 (:probe (values t nil sb!unix:o_rdonly)))
1959 (declare (type index mask))
1960 (let* ((pathname (merge-pathnames filename))
1962 (cond ((unix-namestring pathname input))
1963 ((and input (eq if-does-not-exist :create))
1964 (unix-namestring pathname nil))
1965 ((and (eq direction :io) (not if-does-not-exist-given))
1966 (unix-namestring pathname nil)))))
1967 ;; Process if-exists argument if we are doing any output.
1969 (unless if-exists-given
1971 (if (eq (pathname-version pathname) :newest)
1974 (ensure-one-of if-exists
1975 '(:error :new-version :rename
1976 :rename-and-delete :overwrite
1977 :append :supersede nil)
1980 ((:new-version :error nil)
1981 (setf mask (logior mask sb!unix:o_excl)))
1982 ((:rename :rename-and-delete)
1983 (setf mask (logior mask sb!unix:o_creat)))
1985 (setf mask (logior mask sb!unix:o_trunc)))
1987 (setf mask (logior mask sb!unix:o_append)))))
1989 (setf if-exists :ignore-this-arg)))
1991 (unless if-does-not-exist-given
1992 (setf if-does-not-exist
1993 (cond ((eq direction :input) :error)
1995 (member if-exists '(:overwrite :append)))
1997 ((eq direction :probe)
2001 (ensure-one-of if-does-not-exist
2002 '(:error :create nil)
2004 (if (eq if-does-not-exist :create)
2005 (setf mask (logior mask sb!unix:o_creat)))
2007 (let ((original (case if-exists
2008 ((:rename :rename-and-delete)
2009 (pick-backup-name namestring))
2010 ((:append :overwrite)
2011 ;; KLUDGE: Provent CLOSE from deleting
2012 ;; appending streams when called with :ABORT T
2014 (delete-original (eq if-exists :rename-and-delete))
2016 (when (and original (not (eq original namestring)))
2017 ;; We are doing a :RENAME or :RENAME-AND-DELETE. Determine
2018 ;; whether the file already exists, make sure the original
2019 ;; file is not a directory, and keep the mode.
2022 (multiple-value-bind (okay err/dev inode orig-mode)
2023 (sb!unix:unix-stat namestring)
2024 (declare (ignore inode)
2025 (type (or index null) orig-mode))
2028 (when (and output (= (logand orig-mode #o170000)
2030 (error 'simple-file-error
2031 :pathname namestring
2033 "can't open ~S for output: is a directory"
2034 :format-arguments (list namestring)))
2035 (setf mode (logand orig-mode #o777))
2037 ((eql err/dev sb!unix:enoent)
2040 (simple-file-perror "can't find ~S"
2044 (rename-the-old-one namestring original))
2046 (setf delete-original nil)
2047 ;; In order to use :SUPERSEDE instead, we have to make
2048 ;; sure SB!UNIX:O_CREAT corresponds to
2049 ;; IF-DOES-NOT-EXIST. SB!UNIX:O_CREAT was set before
2050 ;; because of IF-EXISTS being :RENAME.
2051 (unless (eq if-does-not-exist :create)
2053 (logior (logandc2 mask sb!unix:o_creat)
2055 (setf if-exists :supersede))))
2057 ;; Now we can try the actual Unix open(2).
2058 (multiple-value-bind (fd errno)
2060 (sb!unix:unix-open namestring mask mode)
2061 (values nil sb!unix:enoent))
2062 (labels ((open-error (format-control &rest format-arguments)
2063 (error 'simple-file-error
2065 :format-control format-control
2066 :format-arguments format-arguments))
2067 (vanilla-open-error ()
2068 (simple-file-perror "error opening ~S" pathname errno)))
2071 ((:input :output :io)
2075 :element-type element-type
2076 :external-format external-format
2079 :delete-original delete-original
2086 (%make-fd-stream :name namestring
2089 :element-type element-type)))
2092 ((eql errno sb!unix:enoent)
2093 (case if-does-not-exist
2094 (:error (vanilla-open-error))
2096 (open-error "~@<The path ~2I~_~S ~I~_does not exist.~:>"
2099 ((and (eql errno sb!unix:eexist) (null if-exists))
2102 (vanilla-open-error)))))))))
2106 ;;; the stream connected to the controlling terminal, or NIL if there is none
2109 ;;; the stream connected to the standard input (file descriptor 0)
2112 ;;; the stream connected to the standard output (file descriptor 1)
2115 ;;; the stream connected to the standard error output (file descriptor 2)
2118 ;;; This is called when the cold load is first started up, and may also
2119 ;;; be called in an attempt to recover from nested errors.
2120 (defun stream-cold-init-or-reset ()
2122 (setf *terminal-io* (make-synonym-stream '*tty*))
2123 (setf *standard-output* (make-synonym-stream '*stdout*))
2124 (setf *standard-input* (make-synonym-stream '*stdin*))
2125 (setf *error-output* (make-synonym-stream '*stderr*))
2126 (setf *query-io* (make-synonym-stream '*terminal-io*))
2127 (setf *debug-io* *query-io*)
2128 (setf *trace-output* *standard-output*)
2131 ;;; This is called whenever a saved core is restarted.
2132 (defun stream-reinit ()
2133 (setf *available-buffers* nil)
2134 (with-output-to-string (*error-output*)
2136 (make-fd-stream 0 :name "standard input" :input t :buffering :line
2137 #!+win32 :external-format #!+win32 (sb!win32::console-input-codepage)))
2139 (make-fd-stream 1 :name "standard output" :output t :buffering :line
2140 #!+win32 :external-format #!+win32 (sb!win32::console-output-codepage)))
2142 (make-fd-stream 2 :name "standard error" :output t :buffering :line
2143 #!+win32 :external-format #!+win32 (sb!win32::console-output-codepage)))
2144 (let* ((ttyname #.(coerce "/dev/tty" 'simple-base-string))
2145 (tty (sb!unix:unix-open ttyname sb!unix:o_rdwr #o666)))
2149 :name "the terminal"
2154 (setf *tty* (make-two-way-stream *stdin* *stdout*))))
2155 (princ (get-output-stream-string *error-output*) *stderr*))
2160 ;;; the Unix way to beep
2161 (defun beep (stream)
2162 (write-char (code-char bell-char-code) stream)
2163 (finish-output stream))
2165 ;;; This is kind of like FILE-POSITION, but is an internal hack used
2166 ;;; by the filesys stuff to get and set the file name.
2168 ;;; FIXME: misleading name, screwy interface
2169 (defun file-name (stream &optional new-name)
2170 (when (typep stream 'fd-stream)
2172 (setf (fd-stream-pathname stream) new-name)
2173 (setf (fd-stream-file stream)
2174 (unix-namestring new-name nil))
2177 (fd-stream-pathname stream)))))