4b6f09d19b42a70ca9f9907b3cef9fde9f65942a
[sbcl.git] / src / code / fd-stream.lisp
1 ;;;; streams for UNIX file descriptors
2
3 ;;;; This software is part of the SBCL system. See the README file for
4 ;;;; more information.
5 ;;;;
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.
11
12 (in-package "SB!IMPL")
13
14 ;;; FIXME: Wouldn't it be clearer to just have the structure
15 ;;; definition be DEFSTRUCT FILE-STREAM (instead of DEFSTRUCT
16 ;;; FD-STREAM)? That way we'd have TYPE-OF and PRINT-OBJECT refer to
17 ;;; these objects as FILE-STREAMs (the ANSI name) instead of the
18 ;;; internal implementation name FD-STREAM, and there might be other
19 ;;; benefits as well.
20 (deftype file-stream () 'fd-stream)
21 \f
22 ;;;; buffer manipulation routines
23
24 ;;; FIXME: Is it really good to maintain this pool separate from the
25 ;;; GC and the C malloc logic?
26 (defvar *available-buffers* ()
27   #!+sb-doc
28   "List of available buffers. Each buffer is an sap pointing to
29   bytes-per-buffer of memory.")
30
31 (defconstant bytes-per-buffer (* 4 1024)
32   #!+sb-doc
33   "Number of bytes per buffer.")
34
35 ;;; Return the next available buffer, creating one if necessary.
36 #!-sb-fluid (declaim (inline next-available-buffer))
37 (defun next-available-buffer ()
38   (if *available-buffers*
39       (pop *available-buffers*)
40       (allocate-system-memory bytes-per-buffer)))
41 \f
42 ;;;; the FD-STREAM structure
43
44 (defstruct (fd-stream
45             (:constructor %make-fd-stream)
46             (:include lisp-stream
47                       (misc #'fd-stream-misc-routine))
48             (:copier nil))
49
50   ;; the name of this stream
51   (name nil)
52   ;; the file this stream is for
53   (file nil)
54   ;; the backup file namestring for the old file, for :IF-EXISTS
55   ;; :RENAME or :RENAME-AND-DELETE.
56   (original nil :type (or simple-string null))
57   (delete-original nil)       ; for :if-exists :rename-and-delete
58   ;;; the number of bytes per element
59   (element-size 1 :type index)
60   ;; the type of element being transfered
61   (element-type 'base-char)   
62   ;; the Unix file descriptor
63   (fd -1 :type fixnum)        
64   ;; controls when the output buffer is flushed
65   (buffering :full :type (member :full :line :none))
66   ;; character position (if known)
67   (char-pos nil :type (or index null))
68   ;; T if input is waiting on FD. :EOF if we hit EOF.
69   (listen nil :type (member nil t :eof))
70
71   ;; the input buffer
72   (unread nil)
73   (ibuf-sap nil :type (or system-area-pointer null))
74   (ibuf-length nil :type (or index null))
75   (ibuf-head 0 :type index)
76   (ibuf-tail 0 :type index)
77
78   ;; the output buffer
79   (obuf-sap nil :type (or system-area-pointer null))
80   (obuf-length nil :type (or index null))
81   (obuf-tail 0 :type index)
82
83   ;; output flushed, but not written due to non-blocking io?
84   (output-later nil)
85   (handler nil)
86   ;; timeout specified for this stream, or NIL if none
87   (timeout nil :type (or index null))
88   ;; pathname of the file this stream is opened to (returned by PATHNAME)
89   (pathname nil :type (or pathname null)))
90 (def!method print-object ((fd-stream fd-stream) stream)
91   (declare (type stream stream))
92   (print-unreadable-object (fd-stream stream :type t :identity t)
93     (format stream "for ~S" (fd-stream-name fd-stream))))
94 \f
95 ;;;; output routines and related noise
96
97 (defvar *output-routines* ()
98   #!+sb-doc
99   "List of all available output routines. Each element is a list of the
100   element-type output, the kind of buffering, the function name, and the number
101   of bytes per element.")
102
103 ;;; common idioms for reporting low-level stream and file problems
104 (defun simple-stream-perror (note-format stream errno)
105   (error 'simple-stream-error
106          :stream stream
107          :format-control "~@<~?: ~2I~_~A~:>"
108          :format-arguments (list note-format (list stream) (strerror errno))))
109 (defun simple-file-perror (note-format pathname errno)
110   (error 'simple-stream-error
111          :pathname pathname
112          :format-control "~@<~?: ~2I~_~A~:>"
113          :format-arguments
114          (list note-format (list pathname) (strerror errno))))
115
116 ;;; This is called by the server when we can write to the given file
117 ;;; descriptor. Attempt to write the data again. If it worked, remove
118 ;;; the data from the OUTPUT-LATER list. If it didn't work, something
119 ;;; is wrong.
120 (defun do-output-later (stream)
121   (let* ((stuff (pop (fd-stream-output-later stream)))
122          (base (car stuff))
123          (start (cadr stuff))
124          (end (caddr stuff))
125          (reuse-sap (cadddr stuff))
126          (length (- end start)))
127     (declare (type index start end length))
128     (multiple-value-bind (count errno)
129         (sb!unix:unix-write (fd-stream-fd stream)
130                             base
131                             start
132                             length)
133       (cond ((not count)
134              (if (= errno sb!unix:ewouldblock)
135                  (error "Write would have blocked, but SERVER told us to go.")
136                  (simple-stream-perror "couldn't write to ~S" stream errno)))
137             ((eql count length) ; Hot damn, it worked.
138              (when reuse-sap
139                (push base *available-buffers*)))
140             ((not (null count)) ; sorta worked..
141              (push (list base
142                          (the index (+ start count))
143                          end)
144                    (fd-stream-output-later stream))))))
145   (unless (fd-stream-output-later stream)
146     (sb!sys:remove-fd-handler (fd-stream-handler stream))
147     (setf (fd-stream-handler stream) nil)))
148
149 ;;; Arange to output the string when we can write on the file descriptor.
150 (defun output-later (stream base start end reuse-sap)
151   (cond ((null (fd-stream-output-later stream))
152          (setf (fd-stream-output-later stream)
153                (list (list base start end reuse-sap)))
154          (setf (fd-stream-handler stream)
155                (sb!sys:add-fd-handler (fd-stream-fd stream)
156                                       :output
157                                       #'(lambda (fd)
158                                           (declare (ignore fd))
159                                           (do-output-later stream)))))
160         (t
161          (nconc (fd-stream-output-later stream)
162                 (list (list base start end reuse-sap)))))
163   (when reuse-sap
164     (let ((new-buffer (next-available-buffer)))
165       (setf (fd-stream-obuf-sap stream) new-buffer)
166       (setf (fd-stream-obuf-length stream) bytes-per-buffer))))
167
168 ;;; Output the given noise. Check to see whether there are any pending
169 ;;; writes. If so, just queue this one. Otherwise, try to write it. If
170 ;;; this would block, queue it.
171 (defun do-output (stream base start end reuse-sap)
172   (declare (type fd-stream stream)
173            (type (or system-area-pointer (simple-array * (*))) base)
174            (type index start end))
175   (if (not (null (fd-stream-output-later stream))) ; something buffered.
176       (progn
177         (output-later stream base start end reuse-sap)
178         ;; ### check to see whether any of this noise can be output
179         )
180       (let ((length (- end start)))
181         (multiple-value-bind (count errno)
182             (sb!unix:unix-write (fd-stream-fd stream) base start length)
183           (cond ((not count)
184                  (if (= errno sb!unix:ewouldblock)
185                      (output-later stream base start end reuse-sap)
186                      (simple-stream-perror "couldn't write to ~S"
187                                            stream
188                                            errno)))
189                 ((not (eql count length))
190                  (output-later stream base (the index (+ start count))
191                                end reuse-sap)))))))
192
193 ;;; Flush any data in the output buffer.
194 (defun flush-output-buffer (stream)
195   (let ((length (fd-stream-obuf-tail stream)))
196     (unless (= length 0)
197       (do-output stream (fd-stream-obuf-sap stream) 0 length t)
198       (setf (fd-stream-obuf-tail stream) 0))))
199
200 ;;; Define output routines that output numbers SIZE bytes long for the
201 ;;; given bufferings. Use BODY to do the actual output.
202 (defmacro def-output-routines ((name-fmt size &rest bufferings) &body body)
203   (declare (optimize (speed 1)))
204   (cons 'progn
205         (mapcar
206             #'(lambda (buffering)
207                 (let ((function
208                        (intern (let ((*print-case* :upcase))
209                                  (format nil name-fmt (car buffering))))))
210                   `(progn
211                      (defun ,function (stream byte)
212                        ,(unless (eq (car buffering) :none)
213                           `(when (< (fd-stream-obuf-length stream)
214                                     (+ (fd-stream-obuf-tail stream)
215                                        ,size))
216                              (flush-output-buffer stream)))
217                        ,@body
218                        (incf (fd-stream-obuf-tail stream) ,size)
219                        ,(ecase (car buffering)
220                           (:none
221                            `(flush-output-buffer stream))
222                           (:line
223                            `(when (eq (char-code byte) (char-code #\Newline))
224                               (flush-output-buffer stream)))
225                           (:full
226                            ))
227                        (values))
228                      (setf *output-routines*
229                            (nconc *output-routines*
230                                   ',(mapcar
231                                         #'(lambda (type)
232                                             (list type
233                                                   (car buffering)
234                                                   function
235                                                   size))
236                                       (cdr buffering)))))))
237           bufferings)))
238
239 (def-output-routines ("OUTPUT-CHAR-~A-BUFFERED"
240                       1
241                       (:none character)
242                       (:line character)
243                       (:full character))
244   (if (and (base-char-p byte) (char= byte #\Newline))
245       (setf (fd-stream-char-pos stream) 0)
246       (incf (fd-stream-char-pos stream)))
247   (setf (sap-ref-8 (fd-stream-obuf-sap stream) (fd-stream-obuf-tail stream))
248         (char-code byte)))
249
250 (def-output-routines ("OUTPUT-UNSIGNED-BYTE-~A-BUFFERED"
251                       1
252                       (:none (unsigned-byte 8))
253                       (:full (unsigned-byte 8)))
254   (setf (sap-ref-8 (fd-stream-obuf-sap stream) (fd-stream-obuf-tail stream))
255         byte))
256
257 (def-output-routines ("OUTPUT-SIGNED-BYTE-~A-BUFFERED"
258                       1
259                       (:none (signed-byte 8))
260                       (:full (signed-byte 8)))
261   (setf (signed-sap-ref-8 (fd-stream-obuf-sap stream)
262                           (fd-stream-obuf-tail stream))
263         byte))
264
265 (def-output-routines ("OUTPUT-UNSIGNED-SHORT-~A-BUFFERED"
266                       2
267                       (:none (unsigned-byte 16))
268                       (:full (unsigned-byte 16)))
269   (setf (sap-ref-16 (fd-stream-obuf-sap stream) (fd-stream-obuf-tail stream))
270         byte))
271
272 (def-output-routines ("OUTPUT-SIGNED-SHORT-~A-BUFFERED"
273                       2
274                       (:none (signed-byte 16))
275                       (:full (signed-byte 16)))
276   (setf (signed-sap-ref-16 (fd-stream-obuf-sap stream)
277                            (fd-stream-obuf-tail stream))
278         byte))
279
280 (def-output-routines ("OUTPUT-UNSIGNED-LONG-~A-BUFFERED"
281                       4
282                       (:none (unsigned-byte 32))
283                       (:full (unsigned-byte 32)))
284   (setf (sap-ref-32 (fd-stream-obuf-sap stream) (fd-stream-obuf-tail stream))
285         byte))
286
287 (def-output-routines ("OUTPUT-SIGNED-LONG-~A-BUFFERED"
288                       4
289                       (:none (signed-byte 32))
290                       (:full (signed-byte 32)))
291   (setf (signed-sap-ref-32 (fd-stream-obuf-sap stream)
292                            (fd-stream-obuf-tail stream))
293         byte))
294
295 ;;; Do the actual output. If there is space to buffer the string,
296 ;;; buffer it. If the string would normally fit in the buffer, but
297 ;;; doesn't because of other stuff in the buffer, flush the old noise
298 ;;; out of the buffer and put the string in it. Otherwise we have a
299 ;;; very long string, so just send it directly (after flushing the
300 ;;; buffer, of course).
301 (defun output-raw-bytes (fd-stream thing &optional start end)
302   #!+sb-doc
303   "Output THING to FD-STREAM. THING can be any kind of vector or a SAP. If
304   THING is a SAP, END must be supplied (as length won't work)."
305   (let ((start (or start 0))
306         (end (or end (length (the (simple-array * (*)) thing)))))
307     (declare (type index start end))
308     (let* ((len (fd-stream-obuf-length fd-stream))
309            (tail (fd-stream-obuf-tail fd-stream))
310            (space (- len tail))
311            (bytes (- end start))
312            (newtail (+ tail bytes)))
313       (cond ((minusp bytes) ; error case
314              (error ":END before :START!"))
315             ((zerop bytes)) ; easy case
316             ((<= bytes space)
317              (if (system-area-pointer-p thing)
318                  (system-area-copy thing
319                                    (* start sb!vm:byte-bits)
320                                    (fd-stream-obuf-sap fd-stream)
321                                    (* tail sb!vm:byte-bits)
322                                    (* bytes sb!vm:byte-bits))
323                  ;; FIXME: There should be some type checking somewhere to
324                  ;; verify that THING here is a vector, not just <not a SAP>.
325                  (copy-to-system-area thing
326                                       (+ (* start sb!vm:byte-bits)
327                                          (* sb!vm:vector-data-offset
328                                             sb!vm:word-bits))
329                                       (fd-stream-obuf-sap fd-stream)
330                                       (* tail sb!vm:byte-bits)
331                                       (* bytes sb!vm:byte-bits)))
332              (setf (fd-stream-obuf-tail fd-stream) newtail))
333             ((<= bytes len)
334              (flush-output-buffer fd-stream)
335              (if (system-area-pointer-p thing)
336                  (system-area-copy thing
337                                    (* start sb!vm:byte-bits)
338                                    (fd-stream-obuf-sap fd-stream)
339                                    0
340                                    (* bytes sb!vm:byte-bits))
341                  ;; FIXME: There should be some type checking somewhere to
342                  ;; verify that THING here is a vector, not just <not a SAP>.
343                  (copy-to-system-area thing
344                                       (+ (* start sb!vm:byte-bits)
345                                          (* sb!vm:vector-data-offset
346                                             sb!vm:word-bits))
347                                       (fd-stream-obuf-sap fd-stream)
348                                       0
349                                       (* bytes sb!vm:byte-bits)))
350              (setf (fd-stream-obuf-tail fd-stream) bytes))
351             (t
352              (flush-output-buffer fd-stream)
353              (do-output fd-stream thing start end nil))))))
354
355 ;;; the routine to use to output a string. If the stream is
356 ;;; unbuffered, slam the string down the file descriptor, otherwise
357 ;;; use OUTPUT-RAW-BYTES to buffer the string. Update charpos by
358 ;;; checking to see where the last newline was.
359 ;;;
360 ;;; Note: some bozos (the FASL dumper) call write-string with things
361 ;;; other than strings. Therefore, we must make sure we have a string
362 ;;; before calling POSITION on it.
363 ;;; KLUDGE: It would be better to fix the bozos instead of trying to
364 ;;; cover for them here. -- WHN 20000203
365 (defun fd-sout (stream thing start end)
366   (let ((start (or start 0))
367         (end (or end (length (the vector thing)))))
368     (declare (fixnum start end))
369     (if (stringp thing)
370         (let ((last-newline (and (find #\newline (the simple-string thing)
371                                        :start start :end end)
372                                  (position #\newline (the simple-string thing)
373                                            :from-end t
374                                            :start start
375                                            :end end))))
376           (ecase (fd-stream-buffering stream)
377             (:full
378              (output-raw-bytes stream thing start end))
379             (:line
380              (output-raw-bytes stream thing start end)
381              (when last-newline
382                (flush-output-buffer stream)))
383             (:none
384              (do-output stream thing start end nil)))
385           (if last-newline
386               (setf (fd-stream-char-pos stream)
387                     (- end last-newline 1))
388               (incf (fd-stream-char-pos stream)
389                     (- end start))))
390         (ecase (fd-stream-buffering stream)
391           ((:line :full)
392            (output-raw-bytes stream thing start end))
393           (:none
394            (do-output stream thing start end nil))))))
395
396 ;;; Find an output routine to use given the type and buffering. Return
397 ;;; as multiple values the routine, the real type transfered, and the
398 ;;; number of bytes per element.
399 (defun pick-output-routine (type buffering)
400   (dolist (entry *output-routines*)
401     (when (and (subtypep type (car entry))
402                (eq buffering (cadr entry)))
403       (return (values (symbol-function (caddr entry))
404                       (car entry)
405                       (cadddr entry))))))
406 \f
407 ;;;; input routines and related noise
408
409 ;;; a list of all available input routines. Each element is a list of
410 ;;; the element-type input, the function name, and the number of bytes
411 ;;; per element.
412 (defvar *input-routines* ())
413
414 ;;; Fill the input buffer, and return the first character. Throw to
415 ;;; EOF-INPUT-CATCHER if the eof was reached. Drop into SYSTEM:SERVER
416 ;;; if necessary.
417 (defun do-input (stream)
418   (let ((fd (fd-stream-fd stream))
419         (ibuf-sap (fd-stream-ibuf-sap stream))
420         (buflen (fd-stream-ibuf-length stream))
421         (head (fd-stream-ibuf-head stream))
422         (tail (fd-stream-ibuf-tail stream)))
423     (declare (type index head tail))
424     (unless (zerop head)
425       (cond ((eql head tail)
426              (setf head 0)
427              (setf tail 0)
428              (setf (fd-stream-ibuf-head stream) 0)
429              (setf (fd-stream-ibuf-tail stream) 0))
430             (t
431              (decf tail head)
432              (system-area-copy ibuf-sap (* head sb!vm:byte-bits)
433                                ibuf-sap 0 (* tail sb!vm:byte-bits))
434              (setf head 0)
435              (setf (fd-stream-ibuf-head stream) 0)
436              (setf (fd-stream-ibuf-tail stream) tail))))
437     (setf (fd-stream-listen stream) nil)
438     (multiple-value-bind (count errno)
439         ;; FIXME: Judging from compiler warnings, this WITH-ALIEN form expands
440         ;; into something which uses the not-yet-defined type
441         ;;   (SB!ALIEN-INTERNALS:ALIEN (* (SB!ALIEN:STRUCT SB!UNIX:FD-SET))).
442         ;; This is probably inefficient and unsafe and generally bad, so
443         ;; try to find some way to make that type known before
444         ;; this is compiled.
445         (sb!alien:with-alien ((read-fds (sb!alien:struct sb!unix:fd-set)))
446           (sb!unix:fd-zero read-fds)
447           (sb!unix:fd-set fd read-fds)
448           (sb!unix:unix-fast-select (1+ fd)
449                                     (sb!alien:addr read-fds)
450                                     nil
451                                     nil
452                                     0
453                                     0))
454       (case count
455         (1)
456         (0
457          (unless #!-mp (sb!sys:wait-until-fd-usable
458                        fd :input (fd-stream-timeout stream))
459                  #!+mp (sb!mp:process-wait-until-fd-usable
460                        fd :input (fd-stream-timeout stream))
461            (error 'io-timeout :stream stream :direction :read)))
462         (t
463          (simple-stream-perror "couldn't check whether ~S is readable"
464                                stream
465                                errno))))
466     (multiple-value-bind (count errno)
467         (sb!unix:unix-read fd
468                            (sb!sys:int-sap (+ (sb!sys:sap-int ibuf-sap) tail))
469                            (- buflen tail))
470       (cond ((null count)
471              (if (eql errno sb!unix:ewouldblock)
472                  (progn
473                    (unless #!-mp (sb!sys:wait-until-fd-usable
474                                  fd :input (fd-stream-timeout stream))
475                            #!+mp (sb!mp:process-wait-until-fd-usable
476                                  fd :input (fd-stream-timeout stream))
477                      (error 'io-timeout :stream stream :direction :read))
478                    (do-input stream))
479                  (simple-stream-perror "couldn't read from ~S" stream errno)))
480             ((zerop count)
481              (setf (fd-stream-listen stream) :eof)
482              (throw 'eof-input-catcher nil))
483             (t
484              (incf (fd-stream-ibuf-tail stream) count))))))
485                         
486 ;;; Make sure there are at least BYTES number of bytes in the input
487 ;;; buffer. Keep calling DO-INPUT until that condition is met.
488 (defmacro input-at-least (stream bytes)
489   (let ((stream-var (gensym))
490         (bytes-var (gensym)))
491     `(let ((,stream-var ,stream)
492            (,bytes-var ,bytes))
493        (loop
494          (when (>= (- (fd-stream-ibuf-tail ,stream-var)
495                       (fd-stream-ibuf-head ,stream-var))
496                    ,bytes-var)
497            (return))
498          (do-input ,stream-var)))))
499
500 ;;; a macro to wrap around all input routines to handle EOF-ERROR noise
501 (defmacro input-wrapper ((stream bytes eof-error eof-value) &body read-forms)
502   (let ((stream-var (gensym))
503         (element-var (gensym)))
504     `(let ((,stream-var ,stream))
505        (if (fd-stream-unread ,stream-var)
506            (prog1
507                (fd-stream-unread ,stream-var)
508              (setf (fd-stream-unread ,stream-var) nil)
509              (setf (fd-stream-listen ,stream-var) nil))
510            (let ((,element-var
511                   (catch 'eof-input-catcher
512                     (input-at-least ,stream-var ,bytes)
513                     ,@read-forms)))
514              (cond (,element-var
515                     (incf (fd-stream-ibuf-head ,stream-var) ,bytes)
516                     ,element-var)
517                    (t
518                     (eof-or-lose ,stream-var ,eof-error ,eof-value))))))))
519
520 (defmacro def-input-routine (name
521                              (type size sap head)
522                              &rest body)
523   `(progn
524      (defun ,name (stream eof-error eof-value)
525        (input-wrapper (stream ,size eof-error eof-value)
526          (let ((,sap (fd-stream-ibuf-sap stream))
527                (,head (fd-stream-ibuf-head stream)))
528            ,@body)))
529      (setf *input-routines*
530            (nconc *input-routines*
531                   (list (list ',type ',name ',size))))))
532
533 ;;; STREAM-IN routine for reading a string char
534 (def-input-routine input-character
535                    (character 1 sap head)
536   (code-char (sap-ref-8 sap head)))
537
538 ;;; STREAM-IN routine for reading an unsigned 8 bit number
539 (def-input-routine input-unsigned-8bit-byte
540                    ((unsigned-byte 8) 1 sap head)
541   (sap-ref-8 sap head))
542
543 ;;; STREAM-IN routine for reading a signed 8 bit number
544 (def-input-routine input-signed-8bit-number
545                    ((signed-byte 8) 1 sap head)
546   (signed-sap-ref-8 sap head))
547
548 ;;; STREAM-IN routine for reading an unsigned 16 bit number
549 (def-input-routine input-unsigned-16bit-byte
550                    ((unsigned-byte 16) 2 sap head)
551   (sap-ref-16 sap head))
552
553 ;;; STREAM-IN routine for reading a signed 16 bit number
554 (def-input-routine input-signed-16bit-byte
555                    ((signed-byte 16) 2 sap head)
556   (signed-sap-ref-16 sap head))
557
558 ;;; STREAM-IN routine for reading a unsigned 32 bit number
559 (def-input-routine input-unsigned-32bit-byte
560                    ((unsigned-byte 32) 4 sap head)
561   (sap-ref-32 sap head))
562
563 ;;; STREAM-IN routine for reading a signed 32 bit number
564 (def-input-routine input-signed-32bit-byte
565                    ((signed-byte 32) 4 sap head)
566   (signed-sap-ref-32 sap head))
567
568 ;;; Find an input routine to use given the type. Return as multiple
569 ;;; values the routine, the real type transfered, and the number of
570 ;;; bytes per element.
571 (defun pick-input-routine (type)
572   (dolist (entry *input-routines*)
573     (when (subtypep type (car entry))
574       (return (values (symbol-function (cadr entry))
575                       (car entry)
576                       (caddr entry))))))
577
578 ;;; Return a string constructed from SAP, START, and END.
579 (defun string-from-sap (sap start end)
580   (declare (type index start end))
581   (let* ((length (- end start))
582          (string (make-string length)))
583     (copy-from-system-area sap (* start sb!vm:byte-bits)
584                            string (* sb!vm:vector-data-offset sb!vm:word-bits)
585                            (* length sb!vm:byte-bits))
586     string))
587
588 ;;; the N-BIN method for FD-STREAMs
589 ;;;
590 ;;; Note that this blocks in UNIX-READ. It is generally used where
591 ;;; there is a definite amount of reading to be done, so blocking
592 ;;; isn't too problematical.
593 (defun fd-stream-read-n-bytes (stream buffer start requested eof-error-p)
594   (declare (type fd-stream stream))
595   (declare (type index start requested))
596   (do ((total-copied 0))
597       (nil)
598     (declare (type index total-copied))
599     (let* ((remaining-request (- requested total-copied))
600            (head (fd-stream-ibuf-head stream))
601            (tail (fd-stream-ibuf-tail stream))
602            (available (- tail head))
603            (n-this-copy (min remaining-request available))
604            (this-start (+ start total-copied))
605            (this-end (+ this-start n-this-copy))
606            (sap (fd-stream-ibuf-sap stream)))
607       (declare (type index remaining-request head tail available))
608       (declare (type index n-this-copy))
609       ;; Copy data from stream buffer into user's buffer. 
610       (%byte-blt sap head buffer this-start this-end)
611       (incf (fd-stream-ibuf-head stream) n-this-copy)
612       (incf total-copied n-this-copy)
613       ;; Maybe we need to refill the stream buffer.
614       (cond (;; If there were enough data in the stream buffer, we're done.
615              (= total-copied requested)
616              (return total-copied))
617             (;; If EOF, we're done in another way.
618              (zerop (refill-fd-stream-buffer stream))
619              (if eof-error-p
620                  (error 'end-of-file :stream stream)
621                  (return total-copied)))
622             ;; Otherwise we refilled the stream buffer, so fall
623             ;; through into another pass of the loop.
624             ))))
625
626 ;;; Try to refill the stream buffer. Return the number of bytes read.
627 ;;; (For EOF, the return value will be zero, otherwise positive.)
628 (defun refill-fd-stream-buffer (stream)
629   ;; We don't have any logic to preserve leftover bytes in the buffer,
630   ;; so we should only be called when the buffer is empty.
631   (aver (= (fd-stream-ibuf-head stream) (fd-stream-ibuf-tail stream)))
632   (multiple-value-bind (count err)
633       (sb!unix:unix-read (fd-stream-fd stream)
634                          (fd-stream-ibuf-sap stream)
635                          (fd-stream-ibuf-length stream))
636     (declare (type (or index null) count))
637     (when (null count)
638       (simple-stream-perror "couldn't read from ~S" stream err))
639     (setf (fd-stream-listen stream) nil
640           (fd-stream-ibuf-head stream) 0
641           (fd-stream-ibuf-tail stream) count)
642     count))
643 \f
644 ;;;; utility functions (misc routines, etc)
645
646 ;;; Fill in the various routine slots for the given type. INPUT-P and
647 ;;; OUTPUT-P indicate what slots to fill. The buffering slot must be
648 ;;; set prior to calling this routine.
649 (defun set-fd-stream-routines (fd-stream type input-p output-p buffer-p)
650   (let ((target-type (case type
651                        ((:default unsigned-byte)
652                         '(unsigned-byte 8))
653                        (signed-byte
654                         '(signed-byte 8))
655                        (t
656                         type)))
657         (input-type nil)
658         (output-type nil)
659         (input-size nil)
660         (output-size nil))
661
662     (when (fd-stream-obuf-sap fd-stream)
663       (push (fd-stream-obuf-sap fd-stream) *available-buffers*)
664       (setf (fd-stream-obuf-sap fd-stream) nil))
665     (when (fd-stream-ibuf-sap fd-stream)
666       (push (fd-stream-ibuf-sap fd-stream) *available-buffers*)
667       (setf (fd-stream-ibuf-sap fd-stream) nil))
668
669     (when input-p
670       (multiple-value-bind (routine type size)
671           (pick-input-routine target-type)
672         (unless routine
673           (error "could not find any input routine for ~S" target-type))
674         (setf (fd-stream-ibuf-sap fd-stream) (next-available-buffer))
675         (setf (fd-stream-ibuf-length fd-stream) bytes-per-buffer)
676         (setf (fd-stream-ibuf-tail fd-stream) 0)
677         (if (subtypep type 'character)
678             (setf (fd-stream-in fd-stream) routine
679                   (fd-stream-bin fd-stream) #'ill-bin)
680             (setf (fd-stream-in fd-stream) #'ill-in
681                   (fd-stream-bin fd-stream) routine))
682         (when (eql size 1)
683           (setf (fd-stream-n-bin fd-stream) #'fd-stream-read-n-bytes)
684           (when buffer-p
685             (setf (lisp-stream-in-buffer fd-stream)
686                   (make-array +in-buffer-length+
687                               :element-type '(unsigned-byte 8)))))
688         (setf input-size size)
689         (setf input-type type)))
690
691     (when output-p
692       (multiple-value-bind (routine type size)
693           (pick-output-routine target-type (fd-stream-buffering fd-stream))
694         (unless routine
695           (error "could not find any output routine for ~S buffered ~S"
696                  (fd-stream-buffering fd-stream)
697                  target-type))
698         (setf (fd-stream-obuf-sap fd-stream) (next-available-buffer))
699         (setf (fd-stream-obuf-length fd-stream) bytes-per-buffer)
700         (setf (fd-stream-obuf-tail fd-stream) 0)
701         (if (subtypep type 'character)
702           (setf (fd-stream-out fd-stream) routine
703                 (fd-stream-bout fd-stream) #'ill-bout)
704           (setf (fd-stream-out fd-stream)
705                 (or (if (eql size 1)
706                       (pick-output-routine 'base-char
707                                            (fd-stream-buffering fd-stream)))
708                     #'ill-out)
709                 (fd-stream-bout fd-stream) routine))
710         (setf (fd-stream-sout fd-stream)
711               (if (eql size 1) #'fd-sout #'ill-out))
712         (setf (fd-stream-char-pos fd-stream) 0)
713         (setf output-size size)
714         (setf output-type type)))
715
716     (when (and input-size output-size
717                (not (eq input-size output-size)))
718       (error "Element sizes for input (~S:~S) and output (~S:~S) differ?"
719              input-type input-size
720              output-type output-size))
721     (setf (fd-stream-element-size fd-stream)
722           (or input-size output-size))
723
724     (setf (fd-stream-element-type fd-stream)
725           (cond ((equal input-type output-type)
726                  input-type)
727                 ((null output-type)
728                  input-type)
729                 ((null input-type)
730                  output-type)
731                 ((subtypep input-type output-type)
732                  input-type)
733                 ((subtypep output-type input-type)
734                  output-type)
735                 (t
736                  (error "Input type (~S) and output type (~S) are unrelated?"
737                         input-type
738                         output-type))))))
739
740 ;;; Handle miscellaneous operations on FD-STREAM.
741 (defun fd-stream-misc-routine (fd-stream operation &optional arg1 arg2)
742   (declare (ignore arg2))
743   (case operation
744     (:listen
745      (or (not (eql (fd-stream-ibuf-head fd-stream)
746                    (fd-stream-ibuf-tail fd-stream)))
747          (fd-stream-listen fd-stream)
748          (setf (fd-stream-listen fd-stream)
749                (eql (sb!alien:with-alien ((read-fds (sb!alien:struct
750                                                      sb!unix:fd-set)))
751                       (sb!unix:fd-zero read-fds)
752                       (sb!unix:fd-set (fd-stream-fd fd-stream) read-fds)
753                       (sb!unix:unix-fast-select (1+ (fd-stream-fd fd-stream))
754                                                 (sb!alien:addr read-fds)
755                                                 nil nil 0 0))
756                     1))))
757     (:unread
758      (setf (fd-stream-unread fd-stream) arg1)
759      (setf (fd-stream-listen fd-stream) t))
760     (:close
761      (cond (arg1
762             ;; We got us an abort on our hands.
763             (when (fd-stream-handler fd-stream)
764                   (sb!sys:remove-fd-handler (fd-stream-handler fd-stream))
765                   (setf (fd-stream-handler fd-stream) nil))
766             (when (and (fd-stream-file fd-stream)
767                        (fd-stream-obuf-sap fd-stream))
768               ;; We can't do anything unless we know what file were
769               ;; dealing with, and we don't want to do anything
770               ;; strange unless we were writing to the file.
771               (if (fd-stream-original fd-stream)
772                   ;; We have a handle on the original, just revert.
773                   (multiple-value-bind (okay err)
774                       (sb!unix:unix-rename (fd-stream-original fd-stream)
775                                            (fd-stream-file fd-stream))
776                     (unless okay
777                       (simple-stream-perror
778                        "couldn't restore ~S to its original contents"
779                        fd-stream
780                        err)))
781                   ;; We can't restore the original, so nuke that puppy.
782                   (multiple-value-bind (okay err)
783                       (sb!unix:unix-unlink (fd-stream-file fd-stream))
784                     (unless okay
785                       (error 'simple-file-error
786                              :pathname (fd-stream-file fd-stream)
787                              :format-control
788                              "~@<couldn't remove ~S: ~2I~_~A~:>"
789                              :format-arguments (list (fd-stream-file fd-stream)
790                                                      (strerror err))))))))
791            (t
792             (fd-stream-misc-routine fd-stream :finish-output)
793             (when (and (fd-stream-original fd-stream)
794                        (fd-stream-delete-original fd-stream))
795               (multiple-value-bind (okay err)
796                   (sb!unix:unix-unlink (fd-stream-original fd-stream))
797                 (unless okay
798                   (error 'simple-file-error
799                          :pathname (fd-stream-original fd-stream)
800                          :format-control 
801                          "~@<couldn't delete ~S during close of ~S: ~
802                           ~2I~_~A~:>"
803                          :format-arguments
804                          (list (fd-stream-original fd-stream)
805                                fd-stream
806                                (strerror err))))))))
807      (when (fboundp 'cancel-finalization)
808        (cancel-finalization fd-stream))
809      (sb!unix:unix-close (fd-stream-fd fd-stream))
810      (when (fd-stream-obuf-sap fd-stream)
811        (push (fd-stream-obuf-sap fd-stream) *available-buffers*)
812        (setf (fd-stream-obuf-sap fd-stream) nil))
813      (when (fd-stream-ibuf-sap fd-stream)
814        (push (fd-stream-ibuf-sap fd-stream) *available-buffers*)
815        (setf (fd-stream-ibuf-sap fd-stream) nil))
816      (sb!impl::set-closed-flame fd-stream))
817     (:clear-input
818      (setf (fd-stream-unread fd-stream) nil)
819      (setf (fd-stream-ibuf-head fd-stream) 0)
820      (setf (fd-stream-ibuf-tail fd-stream) 0)
821      (catch 'eof-input-catcher
822        (loop
823         (let ((count (sb!alien:with-alien ((read-fds (sb!alien:struct
824                                                       sb!unix:fd-set)))
825                        (sb!unix:fd-zero read-fds)
826                        (sb!unix:fd-set (fd-stream-fd fd-stream) read-fds)
827                        (sb!unix:unix-fast-select (1+ (fd-stream-fd fd-stream))
828                                                  (sb!alien:addr read-fds)
829                                                  nil
830                                                  nil
831                                                  0
832                                                  0))))
833           (cond ((eql count 1)
834                  (do-input fd-stream)
835                  (setf (fd-stream-ibuf-head fd-stream) 0)
836                  (setf (fd-stream-ibuf-tail fd-stream) 0))
837                 (t
838                  (return t)))))))
839     (:force-output
840      (flush-output-buffer fd-stream))
841     (:finish-output
842      (flush-output-buffer fd-stream)
843      (do ()
844          ((null (fd-stream-output-later fd-stream)))
845        (sb!sys:serve-all-events)))
846     (:element-type
847      (fd-stream-element-type fd-stream))
848     (:interactive-p
849       ;; FIXME: sb!unix:unix-isatty is undefined.
850      (sb!unix:unix-isatty (fd-stream-fd fd-stream)))
851     (:line-length
852      80)
853     (:charpos
854      (fd-stream-char-pos fd-stream))
855     (:file-length
856      (unless (fd-stream-file fd-stream)
857        ;; This is a TYPE-ERROR because ANSI's species FILE-LENGTH
858        ;; "should signal an error of type TYPE-ERROR if stream is not
859        ;; a stream associated with a file". Too bad there's no very
860        ;; appropriate value for the EXPECTED-TYPE slot..
861        (error 'simple-type-error
862               :datum fd-stream
863               :expected-type 'file-stream
864               :format-control "~S is not a stream associated with a file."
865               :format-arguments (list fd-stream)))
866      (multiple-value-bind (okay dev ino mode nlink uid gid rdev size
867                            atime mtime ctime blksize blocks)
868          (sb!unix:unix-fstat (fd-stream-fd fd-stream))
869        (declare (ignore ino nlink uid gid rdev
870                         atime mtime ctime blksize blocks))
871        (unless okay
872          (simple-stream-perror "failed Unix fstat(2) on ~S" fd-stream dev))
873        (if (zerop mode)
874            nil
875            (truncate size (fd-stream-element-size fd-stream)))))
876     (:file-position
877      (fd-stream-file-position fd-stream arg1))))
878
879 (defun fd-stream-file-position (stream &optional newpos)
880   (declare (type fd-stream stream)
881            (type (or index (member nil :start :end)) newpos))
882   (if (null newpos)
883       (sb!sys:without-interrupts
884         ;; First, find the position of the UNIX file descriptor in the file.
885         (multiple-value-bind (posn errno)
886             (sb!unix:unix-lseek (fd-stream-fd stream) 0 sb!unix:l_incr)
887           (declare (type (or index null) posn))
888           (cond ((fixnump posn)
889                  ;; Adjust for buffered output: If there is any output
890                  ;; buffered, the *real* file position will be larger
891                  ;; than reported by lseek because lseek obviously
892                  ;; cannot take into account output we have not sent
893                  ;; yet.
894                  (dolist (later (fd-stream-output-later stream))
895                    (incf posn (- (the index (caddr later))
896                                  (the index (cadr later)))))
897                  (incf posn (fd-stream-obuf-tail stream))
898                  ;; Adjust for unread input: If there is any input
899                  ;; read from UNIX but not supplied to the user of the
900                  ;; stream, the *real* file position will smaller than
901                  ;; reported, because we want to look like the unread
902                  ;; stuff is still available.
903                  (decf posn (- (fd-stream-ibuf-tail stream)
904                                (fd-stream-ibuf-head stream)))
905                  (when (fd-stream-unread stream)
906                    (decf posn))
907                  ;; Divide bytes by element size.
908                  (truncate posn (fd-stream-element-size stream)))
909                 ((eq errno sb!unix:espipe)
910                  nil)
911                 (t
912                  (sb!sys:with-interrupts
913                    (simple-stream-perror "failure in Unix lseek() on ~S"
914                                          stream
915                                          errno))))))
916       (let ((offset 0) origin)
917         (declare (type index offset))
918         ;; Make sure we don't have any output pending, because if we
919         ;; move the file pointer before writing this stuff, it will be
920         ;; written in the wrong location.
921         (flush-output-buffer stream)
922         (do ()
923             ((null (fd-stream-output-later stream)))
924           (sb!sys:serve-all-events))
925         ;; Clear out any pending input to force the next read to go to
926         ;; the disk.
927         (setf (fd-stream-unread stream) nil)
928         (setf (fd-stream-ibuf-head stream) 0)
929         (setf (fd-stream-ibuf-tail stream) 0)
930         ;; Trash cached value for listen, so that we check next time.
931         (setf (fd-stream-listen stream) nil)
932         ;; Now move it.
933         (cond ((eq newpos :start)
934                (setf offset 0 origin sb!unix:l_set))
935               ((eq newpos :end)
936                (setf offset 0 origin sb!unix:l_xtnd))
937               ((typep newpos 'index)
938                (setf offset (* newpos (fd-stream-element-size stream))
939                      origin sb!unix:l_set))
940               (t
941                (error "invalid position given to FILE-POSITION: ~S" newpos)))
942         (multiple-value-bind (posn errno)
943             (sb!unix:unix-lseek (fd-stream-fd stream) offset origin)
944           (cond ((typep posn 'fixnum)
945                  t)
946                 ((eq errno sb!unix:espipe)
947                  nil)
948                 (t
949                  (simple-stream-perror "error in Unix lseek() on ~S"
950                                        stream
951                                        errno)))))))
952 \f
953 ;;;; creation routines (MAKE-FD-STREAM and OPEN)
954
955 ;;; Create a stream for the given Unix file descriptor.
956 ;;;
957 ;;; If INPUT is non-NIL, allow input operations. If OUTPUT is non-nil,
958 ;;; allow output operations. If neither INPUT nor OUTPUT is specified,
959 ;;; default to allowing input.
960 ;;;
961 ;;; ELEMENT-TYPE indicates the element type to use (as for OPEN).
962 ;;;
963 ;;; BUFFERING indicates the kind of buffering to use.
964 ;;;
965 ;;; TIMEOUT (if true) is the number of seconds to wait for input. If
966 ;;; NIL (the default), then wait forever. When we time out, we signal
967 ;;; IO-TIMEOUT.
968 ;;;
969 ;;; FILE is the name of the file (will be returned by PATHNAME).
970 ;;;
971 ;;; NAME is used to identify the stream when printed.
972 (defun make-fd-stream (fd
973                        &key
974                        (input nil input-p)
975                        (output nil output-p)
976                        (element-type 'base-char)
977                        (buffering :full)
978                        timeout
979                        file
980                        original
981                        delete-original
982                        pathname
983                        input-buffer-p
984                        (name (if file
985                                  (format nil "file ~S" file)
986                                  (format nil "descriptor ~D" fd)))
987                        auto-close)
988   (declare (type index fd) (type (or index null) timeout)
989            (type (member :none :line :full) buffering))
990   (cond ((not (or input-p output-p))
991          (setf input t))
992         ((not (or input output))
993          (error "File descriptor must be opened either for input or output.")))
994   (let ((stream (%make-fd-stream :fd fd
995                                  :name name
996                                  :file file
997                                  :original original
998                                  :delete-original delete-original
999                                  :pathname pathname
1000                                  :buffering buffering
1001                                  :timeout timeout)))
1002     (set-fd-stream-routines stream element-type input output input-buffer-p)
1003     (when (and auto-close (fboundp 'finalize))
1004       (finalize stream
1005                 (lambda ()
1006                   (sb!unix:unix-close fd)
1007                   #!+sb-show
1008                   (format *terminal-io* "** closed file descriptor ~D **~%"
1009                           fd))))
1010     stream))
1011
1012 ;;; Pick a name to use for the backup file for the :IF-EXISTS
1013 ;;; :RENAME-AND-DELETE and :RENAME options.
1014 (defun pick-backup-name (name)
1015   (declare (type simple-string name))
1016   (concatenate 'simple-string name ".bak"))
1017
1018 ;;; Ensure that the given arg is one of the given list of valid
1019 ;;; things. Allow the user to fix any problems.
1020 (defun ensure-one-of (item list what)
1021   (unless (member item list)
1022     (error 'simple-type-error
1023            :datum item
1024            :expected-type `(member ,@list)
1025            :format-control "~@<~S is ~_invalid for ~S; ~_need one of~{ ~S~}~:>"
1026            :format-arguments (list item what list))))
1027
1028 ;;; Rename NAMESTRING to ORIGINAL. First, check whether we have write
1029 ;;; access, since we don't want to trash unwritable files even if we
1030 ;;; technically can. We return true if we succeed in renaming.
1031 (defun do-old-rename (namestring original)
1032   (unless (sb!unix:unix-access namestring sb!unix:w_ok)
1033     (error "~@<The file ~2I~_~S ~I~_is not writable.~:>" namestring))
1034   (multiple-value-bind (okay err) (sb!unix:unix-rename namestring original)
1035     (if okay
1036         t
1037         (error 'simple-file-error
1038                :pathname namestring
1039                :format-control 
1040                "~@<couldn't rename ~2I~_~S ~I~_to ~2I~_~S: ~4I~_~A~:>"
1041                :format-arguments (list namestring original (strerror err))))))
1042
1043 (defun open (filename
1044              &key
1045              (direction :input)
1046              (element-type 'base-char)
1047              (if-exists nil if-exists-given)
1048              (if-does-not-exist nil if-does-not-exist-given)
1049              (external-format :default)
1050              &aux ; Squelch assignment warning.
1051              (direction direction)
1052              (if-does-not-exist if-does-not-exist)
1053              (if-exists if-exists))
1054   #!+sb-doc
1055   "Return a stream which reads from or writes to FILENAME.
1056   Defined keywords:
1057    :DIRECTION - one of :INPUT, :OUTPUT, :IO, or :PROBE
1058    :ELEMENT-TYPE - the type of object to read or write, default BASE-CHAR
1059    :IF-EXISTS - one of :ERROR, :NEW-VERSION, :RENAME, :RENAME-AND-DELETE,
1060                        :OVERWRITE, :APPEND, :SUPERSEDE or NIL
1061    :IF-DOES-NOT-EXIST - one of :ERROR, :CREATE or nil
1062   See the manual for details."
1063
1064   (unless (eq external-format :default)
1065     (error "Any external format other than :DEFAULT isn't recognized."))
1066
1067   ;; First, make sure that DIRECTION is valid.
1068   (ensure-one-of direction
1069                  '(:input :output :io :probe)
1070                  :direction)
1071
1072   ;; Calculate useful stuff.
1073   (multiple-value-bind (input output mask)
1074       (case direction
1075         (:input  (values   t nil sb!unix:o_rdonly))
1076         (:output (values nil   t sb!unix:o_wronly))
1077         (:io     (values   t   t sb!unix:o_rdwr))
1078         (:probe  (values   t nil sb!unix:o_rdonly)))
1079     (declare (type index mask))
1080     (let* ((pathname (pathname filename))
1081            (namestring
1082             (cond ((unix-namestring pathname input))
1083                   ((and input (eq if-does-not-exist :create))
1084                    (unix-namestring pathname nil)))))
1085       ;; Process if-exists argument if we are doing any output.
1086       (cond (output
1087              (unless if-exists-given
1088                (setf if-exists
1089                      (if (eq (pathname-version pathname) :newest)
1090                          :new-version
1091                          :error)))
1092              (ensure-one-of if-exists
1093                             '(:error :new-version :rename
1094                                      :rename-and-delete :overwrite
1095                                      :append :supersede nil)
1096                             :if-exists)
1097              (case if-exists
1098                ((:error nil)
1099                 (setf mask (logior mask sb!unix:o_excl)))
1100                ((:rename :rename-and-delete)
1101                 (setf mask (logior mask sb!unix:o_creat)))
1102                ((:new-version :supersede)
1103                 (setf mask (logior mask sb!unix:o_trunc)))
1104                (:append
1105                 (setf mask (logior mask sb!unix:o_append)))))
1106             (t
1107              (setf if-exists :ignore-this-arg)))
1108
1109       (unless if-does-not-exist-given
1110         (setf if-does-not-exist
1111               (cond ((eq direction :input) :error)
1112                     ((and output
1113                           (member if-exists '(:overwrite :append)))
1114                      :error)
1115                     ((eq direction :probe)
1116                      nil)
1117                     (t
1118                      :create))))
1119       (ensure-one-of if-does-not-exist
1120                      '(:error :create nil)
1121                      :if-does-not-exist)
1122       (if (eq if-does-not-exist :create)
1123         (setf mask (logior mask sb!unix:o_creat)))
1124
1125       (let ((original (if (member if-exists
1126                                   '(:rename :rename-and-delete))
1127                           (pick-backup-name namestring)))
1128             (delete-original (eq if-exists :rename-and-delete))
1129             (mode #o666))
1130         (when original
1131           ;; We are doing a :RENAME or :RENAME-AND-DELETE. Determine
1132           ;; whether the file already exists, make sure the original
1133           ;; file is not a directory, and keep the mode.
1134           (let ((exists
1135                  (and namestring
1136                       (multiple-value-bind (okay err/dev inode orig-mode)
1137                           (sb!unix:unix-stat namestring)
1138                         (declare (ignore inode)
1139                                  (type (or index null) orig-mode))
1140                         (cond
1141                          (okay
1142                           (when (and output (= (logand orig-mode #o170000)
1143                                                #o40000))
1144                             (error 'simple-file-error
1145                                    :pathname namestring
1146                                    :format-control
1147                                    "can't open ~S for output: is a directory"
1148                                    :format-arguments (list namestring)))
1149                           (setf mode (logand orig-mode #o777))
1150                           t)
1151                          ((eql err/dev sb!unix:enoent)
1152                           nil)
1153                          (t
1154                           (simple-file-perror "can't find ~S"
1155                                               namestring
1156                                               err/dev)))))))
1157             (unless (and exists
1158                          (do-old-rename namestring original))
1159               (setf original nil)
1160               (setf delete-original nil)
1161               ;; In order to use :SUPERSEDE instead, we have to make
1162               ;; sure SB!UNIX:O_CREAT corresponds to
1163               ;; IF-DOES-NOT-EXIST. SB!UNIX:O_CREAT was set before
1164               ;; because of IF-EXISTS being :RENAME.
1165               (unless (eq if-does-not-exist :create)
1166                 (setf mask
1167                       (logior (logandc2 mask sb!unix:o_creat)
1168                               sb!unix:o_trunc)))
1169               (setf if-exists :supersede))))
1170         
1171         ;; Now we can try the actual Unix open(2).
1172         (multiple-value-bind (fd errno)
1173             (if namestring
1174                 (sb!unix:unix-open namestring mask mode)
1175                 (values nil sb!unix:enoent))
1176           (labels ((open-error (format-control &rest format-arguments)
1177                      (error 'simple-file-error
1178                             :pathname pathname
1179                             :format-control format-control
1180                             :format-arguments format-arguments))
1181                    (vanilla-open-error ()
1182                      (simple-file-perror "error opening ~S" pathname errno)))
1183             (cond ((numberp fd)
1184                    (case direction
1185                      ((:input :output :io)
1186                       (make-fd-stream fd
1187                                       :input input
1188                                       :output output
1189                                       :element-type element-type
1190                                       :file namestring
1191                                       :original original
1192                                       :delete-original delete-original
1193                                       :pathname pathname
1194                                       :input-buffer-p t
1195                                       :auto-close t))
1196                      (:probe
1197                       (let ((stream
1198                              (%make-fd-stream :name namestring
1199                                               :fd fd
1200                                               :pathname pathname
1201                                               :element-type element-type)))
1202                         (close stream)
1203                         stream))))
1204                   ((eql errno sb!unix:enoent)
1205                    (case if-does-not-exist
1206                      (:error (vanilla-open-error))
1207                      (:create
1208                       (open-error "~@<The path ~2I~_~S ~I~_does not exist.~:>"
1209                                   pathname))
1210                      (t nil)))
1211                   ((and (eql errno sb!unix:eexist) if-exists)
1212                    nil)
1213                   (t
1214                    (vanilla-open-error)))))))))
1215 \f
1216 ;;;; initialization
1217
1218 ;;; the stream connected to the controlling terminal, or NIL if there is none
1219 (defvar *tty*)
1220
1221 ;;; the stream connected to the standard input (file descriptor 0)
1222 (defvar *stdin*)
1223
1224 ;;; the stream connected to the standard output (file descriptor 1)
1225 (defvar *stdout*)
1226
1227 ;;; the stream connected to the standard error output (file descriptor 2)
1228 (defvar *stderr*)
1229
1230 ;;; This is called when the cold load is first started up, and may also
1231 ;;; be called in an attempt to recover from nested errors.
1232 (defun stream-cold-init-or-reset ()
1233   (stream-reinit)
1234   (setf *terminal-io* (make-synonym-stream '*tty*))
1235   (setf *standard-output* (make-synonym-stream '*stdout*))
1236   (setf *standard-input*
1237         (#!-high-security
1238          ;; FIXME: Why is *STANDARD-INPUT* a TWO-WAY-STREAM? ANSI says
1239          ;; it's an input stream.
1240          make-two-way-stream
1241          #!+high-security
1242          %make-two-way-stream (make-synonym-stream '*stdin*)
1243                              *standard-output*))
1244   (setf *error-output* (make-synonym-stream '*stderr*))
1245   (setf *query-io* (make-synonym-stream '*terminal-io*))
1246   (setf *debug-io* *query-io*)
1247   (setf *trace-output* *standard-output*)
1248   (values))
1249
1250 ;;; This is called whenever a saved core is restarted.
1251 (defun stream-reinit ()
1252   (setf *available-buffers* nil)
1253   (setf *stdin*
1254         (make-fd-stream 0 :name "standard input" :input t :buffering :line))
1255   (setf *stdout*
1256         (make-fd-stream 1 :name "standard output" :output t :buffering :line))
1257   (setf *stderr*
1258         (make-fd-stream 2 :name "standard error" :output t :buffering :line))
1259   (let ((tty (sb!unix:unix-open "/dev/tty" sb!unix:o_rdwr #o666)))
1260     (if tty
1261         (setf *tty*
1262               (make-fd-stream tty
1263                               :name "the terminal"
1264                               :input t
1265                               :output t
1266                               :buffering :line
1267                               :auto-close t))
1268         (setf *tty* (make-two-way-stream *stdin* *stdout*))))
1269   (values))
1270 \f
1271 ;;;; miscellany
1272
1273 ;;; the Unix way to beep
1274 (defun beep (stream)
1275   (write-char (code-char bell-char-code) stream)
1276   (finish-output stream))
1277
1278 ;;; This is kind of like FILE-POSITION, but is an internal hack used
1279 ;;; by the filesys stuff to get and set the file name.
1280 ;;;
1281 ;;; FIXME: misleading name, screwy interface
1282 (defun file-name (stream &optional new-name)
1283   (when (typep stream 'fd-stream)
1284       (cond (new-name
1285              (setf (fd-stream-pathname stream) new-name)
1286              (setf (fd-stream-file stream)
1287                    (unix-namestring new-name nil))
1288              t)
1289             (t
1290              (fd-stream-pathname stream)))))
1291 \f
1292 ;;;; international character support (which is trivial for our simple
1293 ;;;; character sets)
1294
1295 ;;;; (Those who do Lisp only in English might not remember that ANSI
1296 ;;;; requires these functions to be exported from package
1297 ;;;; COMMON-LISP.)
1298
1299 (defun file-string-length (stream object)
1300   (declare (type (or string character) object) (type file-stream stream))
1301   #!+sb-doc
1302   "Return the delta in STREAM's FILE-POSITION that would be caused by writing
1303    OBJECT to STREAM. Non-trivial only in implementations that support
1304    international character sets."
1305   (declare (ignore stream))
1306   (etypecase object
1307     (character 1)
1308     (string (length object))))
1309
1310 (defun stream-external-format (stream)
1311   (declare (type file-stream stream) (ignore stream))
1312   #!+sb-doc
1313   "Return :DEFAULT."
1314   :default)