/[cmucl]/src/code/fd-stream.lisp
ViewVC logotype

Contents of /src/code/fd-stream.lisp

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.53 - (hide annotations)
Fri Aug 25 09:53:47 2000 UTC (13 years, 7 months ago) by pw
Branch: MAIN
Changes since 1.52: +2 -2 lines
Backout previous offensive revision.
1 ram 1.1 ;;; -*- Log: code.log; Package: LISP -*-
2 ram 1.11 ;;;
3 ram 1.1 ;;; **********************************************************************
4 ram 1.10 ;;; This code was written as part of the CMU Common Lisp project at
5     ;;; Carnegie Mellon University, and has been placed in the public domain.
6     ;;;
7     (ext:file-comment
8 pw 1.53 "$Header: /tiger/var/lib/cvsroots/cmucl/src/code/fd-stream.lisp,v 1.53 2000/08/25 09:53:47 pw Exp $")
9 ram 1.10 ;;;
10 ram 1.1 ;;; **********************************************************************
11     ;;;
12     ;;; Streams for UNIX file descriptors.
13     ;;;
14     ;;; Written by William Lott, July 1989 - January 1990.
15 ram 1.15 ;;; Some tuning by Rob MacLachlan.
16 ram 1.1 ;;;
17     ;;; **********************************************************************
18    
19    
20     (in-package "SYSTEM")
21    
22     (export '(fd-stream fd-stream-p fd-stream-fd make-fd-stream
23 ram 1.15 io-timeout beep *beep-function* output-raw-bytes
24 ram 1.1 *tty* *stdin* *stdout* *stderr*))
25    
26    
27     (in-package "EXTENSIONS")
28    
29     (export '(*backup-extension*))
30    
31    
32     (in-package "LISP")
33    
34 ram 1.27 (export '(file-stream file-string-length stream-external-format))
35 ram 1.22 (deftype file-stream () 'fd-stream)
36    
37 ram 1.1
38     ;;;; Buffer manipulation routines.
39    
40     (defvar *available-buffers* ()
41 ram 1.12 "List of available buffers. Each buffer is an sap pointing to
42     bytes-per-buffer of memory.")
43 ram 1.1
44     (defconstant bytes-per-buffer (* 4 1024)
45     "Number of bytes per buffer.")
46    
47     ;;; NEXT-AVAILABLE-BUFFER -- Internal.
48     ;;;
49 ram 1.12 ;;; Returns the next available buffer, creating one if necessary.
50 ram 1.1 ;;;
51     (proclaim '(inline next-available-buffer))
52     ;;;
53     (defun next-available-buffer ()
54     (if *available-buffers*
55     (pop *available-buffers*)
56 wlott 1.5 (allocate-system-memory bytes-per-buffer)))
57 ram 1.1
58    
59     ;;;; The FD-STREAM structure.
60    
61     (defstruct (fd-stream
62     (:print-function %print-fd-stream)
63     (:constructor %make-fd-stream)
64 dtc 1.43 (:include lisp-stream
65 ram 1.1 (misc #'fd-stream-misc-routine)))
66    
67     (name nil) ; The name of this stream
68     (file nil) ; The file this stream is for
69 ram 1.28 ;;
70     ;; The backup file namestring for the old file, for :if-exists :rename or
71     ;; :rename-and-delete.
72     (original nil :type (or simple-string null))
73 ram 1.1 (delete-original nil) ; for :if-exists :rename-and-delete
74 ram 1.14 ;;
75     ;;; Number of bytes per element.
76     (element-size 1 :type index)
77 wlott 1.16 (element-type 'base-char) ; The type of element being transfered.
78 ram 1.1 (fd -1 :type fixnum) ; The file descriptor
79 ram 1.14 ;;
80     ;; Controls when the output buffer is flushed.
81     (buffering :full :type (member :full :line :none))
82     ;;
83     ;; Character position if known.
84     (char-pos nil :type (or index null))
85     ;;
86     ;; T if input is waiting on FD. :EOF if we hit EOF.
87     (listen nil :type (member nil t :eof))
88     ;;
89 ram 1.1 ;; The input buffer.
90     (unread nil)
91 ram 1.14 (ibuf-sap nil :type (or system-area-pointer null))
92     (ibuf-length nil :type (or index null))
93     (ibuf-head 0 :type index)
94     (ibuf-tail 0 :type index)
95 ram 1.1
96     ;; The output buffer.
97 ram 1.14 (obuf-sap nil :type (or system-area-pointer null))
98     (obuf-length nil :type (or index null))
99     (obuf-tail 0 :type index)
100 ram 1.1
101     ;; Output flushed, but not written due to non-blocking io.
102     (output-later nil)
103 ram 1.15 (handler nil)
104     ;;
105     ;; Timeout specified for this stream, or NIL if none.
106 ram 1.28 (timeout nil :type (or index null))
107     ;;
108     ;; Pathname of the file this stream is opened to (returned by PATHNAME.)
109     (pathname nil :type (or pathname null)))
110 ram 1.1
111     (defun %print-fd-stream (fd-stream stream depth)
112 ram 1.14 (declare (ignore depth) (stream stream))
113 ram 1.1 (format stream "#<Stream for ~A>"
114     (fd-stream-name fd-stream)))
115    
116    
117 ram 1.31 (define-condition io-timeout (stream-error)
118     ((direction :reader io-timeout-direction :initarg :direction))
119 ram 1.15 (:report
120     (lambda (condition stream)
121 ram 1.23 (declare (stream stream))
122 ram 1.15 (format stream "Timeout ~(~A~)ing ~S."
123     (io-timeout-direction condition)
124     (stream-error-stream condition)))))
125    
126 ram 1.1
127     ;;;; Output routines and related noise.
128    
129     (defvar *output-routines* ()
130     "List of all available output routines. Each element is a list of the
131     element-type output, the kind of buffering, the function name, and the number
132     of bytes per element.")
133    
134     ;;; DO-OUTPUT-LATER -- internal
135     ;;;
136     ;;; Called by the server when we can write to the given file descriptor.
137     ;;; Attemt to write the data again. If it worked, remove the data from the
138     ;;; output-later list. If it didn't work, something is wrong.
139     ;;;
140     (defun do-output-later (stream)
141     (let* ((stuff (pop (fd-stream-output-later stream)))
142     (base (car stuff))
143     (start (cadr stuff))
144     (end (caddr stuff))
145 wlott 1.5 (reuse-sap (cadddr stuff))
146 ram 1.1 (length (- end start)))
147 ram 1.14 (declare (type index start end length))
148 ram 1.1 (multiple-value-bind
149     (count errno)
150 wlott 1.19 (unix:unix-write (fd-stream-fd stream)
151 ram 1.1 base
152     start
153     length)
154 ram 1.14 (cond ((not count)
155 wlott 1.19 (if (= errno unix:ewouldblock)
156 ram 1.14 (error "Write would have blocked, but SERVER told us to go.")
157     (error "While writing ~S: ~A"
158 wlott 1.19 stream (unix:get-unix-error-msg errno))))
159 ram 1.14 ((eql count length) ; Hot damn, it workded.
160 wlott 1.5 (when reuse-sap
161     (push base *available-buffers*)))
162 ram 1.1 ((not (null count)) ; Sorta worked.
163     (push (list base
164 ram 1.23 (the index (+ start count))
165 wlott 1.5 end)
166 ram 1.14 (fd-stream-output-later stream))))))
167 ram 1.1 (unless (fd-stream-output-later stream)
168     (system:remove-fd-handler (fd-stream-handler stream))
169     (setf (fd-stream-handler stream) nil)))
170    
171     ;;; OUTPUT-LATER -- internal
172     ;;;
173     ;;; Arange to output the string when we can write on the file descriptor.
174     ;;;
175 wlott 1.5 (defun output-later (stream base start end reuse-sap)
176 ram 1.1 (cond ((null (fd-stream-output-later stream))
177     (setf (fd-stream-output-later stream)
178 wlott 1.5 (list (list base start end reuse-sap)))
179 ram 1.1 (setf (fd-stream-handler stream)
180     (system:add-fd-handler (fd-stream-fd stream)
181     :output
182     #'(lambda (fd)
183     (declare (ignore fd))
184     (do-output-later stream)))))
185     (t
186     (nconc (fd-stream-output-later stream)
187 wlott 1.5 (list (list base start end reuse-sap)))))
188     (when reuse-sap
189 ram 1.1 (let ((new-buffer (next-available-buffer)))
190 wlott 1.5 (setf (fd-stream-obuf-sap stream) new-buffer)
191 ram 1.14 (setf (fd-stream-obuf-length stream) bytes-per-buffer))))
192 ram 1.1
193     ;;; DO-OUTPUT -- internal
194     ;;;
195     ;;; Output the given noise. Check to see if there are any pending writes. If
196     ;;; so, just queue this one. Otherwise, try to write it. If this would block,
197     ;;; queue it.
198     ;;;
199 wlott 1.5 (defun do-output (stream base start end reuse-sap)
200 ram 1.14 (declare (type fd-stream stream)
201     (type (or system-area-pointer (simple-array * (*))) base)
202     (type index start end))
203 ram 1.1 (if (not (null (fd-stream-output-later stream))) ; something buffered.
204 ram 1.14 (progn
205     (output-later stream base start end reuse-sap)
206     ;; ### check to see if any of this noise can be output
207     )
208     (let ((length (- end start)))
209     (multiple-value-bind
210 dtc 1.51 (count errno)
211 wlott 1.19 (unix:unix-write (fd-stream-fd stream) base start length)
212 ram 1.14 (cond ((not count)
213 wlott 1.19 (if (= errno unix:ewouldblock)
214 ram 1.14 (output-later stream base start end reuse-sap)
215     (error "While writing ~S: ~A"
216 wlott 1.19 stream (unix:get-unix-error-msg errno))))
217 ram 1.14 ((not (eql count length))
218 ram 1.23 (output-later stream base (the index (+ start count))
219     end reuse-sap)))))))
220 ram 1.1
221 ram 1.14
222 ram 1.1 ;;; FLUSH-OUTPUT-BUFFER -- internal
223     ;;;
224     ;;; Flush any data in the output buffer.
225     ;;;
226     (defun flush-output-buffer (stream)
227     (let ((length (fd-stream-obuf-tail stream)))
228     (unless (= length 0)
229 wlott 1.5 (do-output stream (fd-stream-obuf-sap stream) 0 length t)
230 ram 1.1 (setf (fd-stream-obuf-tail stream) 0))))
231    
232     ;;; DEF-OUTPUT-ROUTINES -- internal
233     ;;;
234     ;;; Define output routines that output numbers size bytes long for the
235     ;;; given bufferings. Use body to do the actual output.
236     ;;;
237     (defmacro def-output-routines ((name size &rest bufferings) &body body)
238 ram 1.23 (declare (optimize (speed 1)))
239 ram 1.1 (cons 'progn
240     (mapcar
241     #'(lambda (buffering)
242     (let ((function
243     (intern (let ((*print-case* :upcase))
244     (format nil name (car buffering))))))
245     `(progn
246     (defun ,function (stream byte)
247     ,(unless (eq (car buffering) :none)
248     `(when (< (fd-stream-obuf-length stream)
249     (+ (fd-stream-obuf-tail stream)
250     ,size))
251     (flush-output-buffer stream)))
252     ,@body
253     (incf (fd-stream-obuf-tail stream) ,size)
254     ,(ecase (car buffering)
255     (:none
256     `(flush-output-buffer stream))
257     (:line
258     `(when (eq (char-code byte) (char-code #\Newline))
259     (flush-output-buffer stream)))
260     (:full
261     ))
262     (values))
263     (setf *output-routines*
264     (nconc *output-routines*
265     ',(mapcar
266     #'(lambda (type)
267     (list type
268     (car buffering)
269     function
270     size))
271     (cdr buffering)))))))
272     bufferings)))
273    
274 wlott 1.5 (def-output-routines ("OUTPUT-CHAR-~A-BUFFERED"
275     1
276 wlott 1.6 (:none character)
277     (:line character)
278     (:full character))
279 ram 1.37 (if (char= byte #\Newline)
280 wlott 1.5 (setf (fd-stream-char-pos stream) 0)
281     (incf (fd-stream-char-pos stream)))
282     (setf (sap-ref-8 (fd-stream-obuf-sap stream) (fd-stream-obuf-tail stream))
283     (char-code byte)))
284    
285 ram 1.37 (def-output-routines ("OUTPUT-UNSIGNED-BYTE-~A-BUFFERED"
286 ram 1.1 1
287 ram 1.37 (:none (unsigned-byte 8))
288     (:full (unsigned-byte 8)))
289 wlott 1.5 (setf (sap-ref-8 (fd-stream-obuf-sap stream) (fd-stream-obuf-tail stream))
290     byte))
291 ram 1.1
292 ram 1.37 (def-output-routines ("OUTPUT-SIGNED-BYTE-~A-BUFFERED"
293     1
294     (:none (signed-byte 8))
295     (:full (signed-byte 8)))
296     (setf (signed-sap-ref-8 (fd-stream-obuf-sap stream)
297     (fd-stream-obuf-tail stream))
298     byte))
299    
300     (def-output-routines ("OUTPUT-UNSIGNED-SHORT-~A-BUFFERED"
301 ram 1.1 2
302 ram 1.37 (:none (unsigned-byte 16))
303     (:full (unsigned-byte 16)))
304 wlott 1.20 (setf (sap-ref-16 (fd-stream-obuf-sap stream) (fd-stream-obuf-tail stream))
305 wlott 1.5 byte))
306    
307 ram 1.37 (def-output-routines ("OUTPUT-SIGNED-SHORT-~A-BUFFERED"
308     2
309     (:none (signed-byte 16))
310     (:full (signed-byte 16)))
311     (setf (signed-sap-ref-16 (fd-stream-obuf-sap stream)
312     (fd-stream-obuf-tail stream))
313     byte))
314    
315     (def-output-routines ("OUTPUT-UNSIGNED-LONG-~A-BUFFERED"
316 ram 1.1 4
317 ram 1.37 (:none (unsigned-byte 32))
318     (:full (unsigned-byte 32)))
319 wlott 1.20 (setf (sap-ref-32 (fd-stream-obuf-sap stream) (fd-stream-obuf-tail stream))
320 wlott 1.5 byte))
321 ram 1.37
322     (def-output-routines ("OUTPUT-SIGNED-LONG-~A-BUFFERED"
323     4
324     (:none (signed-byte 32))
325     (:full (signed-byte 32)))
326     (setf (signed-sap-ref-32 (fd-stream-obuf-sap stream)
327     (fd-stream-obuf-tail stream))
328     byte))
329    
330 ram 1.1
331     ;;; OUTPUT-RAW-BYTES -- public
332     ;;;
333     ;;; Does the actual output. If there is space to buffer the string, buffer
334     ;;; it. If the string would normally fit in the buffer, but doesn't because
335     ;;; of other stuff in the buffer, flush the old noise out of the buffer and
336     ;;; put the string in it. Otherwise we have a very long string, so just
337     ;;; send it directly (after flushing the buffer, of course).
338     ;;;
339     (defun output-raw-bytes (stream thing &optional start end)
340     "Output THING to stream. THING can be any kind of vector or a sap. If THING
341     is a SAP, END must be supplied (as length won't work)."
342     (let ((start (or start 0))
343 ram 1.14 (end (or end (length (the (simple-array * (*)) thing)))))
344     (declare (type index start end))
345 ram 1.1 (let* ((len (fd-stream-obuf-length stream))
346     (tail (fd-stream-obuf-tail stream))
347     (space (- len tail))
348     (bytes (- end start))
349     (newtail (+ tail bytes)))
350     (cond ((minusp bytes) ; Error case
351     (cerror "Just go on as if nothing happened..."
352     "~S called with :END before :START!"
353     'output-raw-bytes))
354     ((zerop bytes)) ; Easy case
355     ((<= bytes space)
356 wlott 1.5 (if (system-area-pointer-p thing)
357     (system-area-copy thing
358     (* start vm:byte-bits)
359     (fd-stream-obuf-sap stream)
360     (* tail vm:byte-bits)
361     (* bytes vm:byte-bits))
362     (copy-to-system-area thing
363     (+ (* start vm:byte-bits)
364     (* vm:vector-data-offset vm:word-bits))
365     (fd-stream-obuf-sap stream)
366     (* tail vm:byte-bits)
367     (* bytes vm:byte-bits)))
368 ram 1.1 (setf (fd-stream-obuf-tail stream) newtail))
369     ((<= bytes len)
370     (flush-output-buffer stream)
371 wlott 1.5 (if (system-area-pointer-p thing)
372     (system-area-copy thing
373     (* start vm:byte-bits)
374     (fd-stream-obuf-sap stream)
375     0
376     (* bytes vm:byte-bits))
377     (copy-to-system-area thing
378     (+ (* start vm:byte-bits)
379     (* vm:vector-data-offset vm:word-bits))
380     (fd-stream-obuf-sap stream)
381     0
382     (* bytes vm:byte-bits)))
383 ram 1.1 (setf (fd-stream-obuf-tail stream) bytes))
384     (t
385     (flush-output-buffer stream)
386     (do-output stream thing start end nil))))))
387    
388     ;;; FD-SOUT -- internal
389     ;;;
390     ;;; Routine to use to output a string. If the stream is unbuffered, slam
391     ;;; the string down the file descriptor, otherwise use OUTPUT-RAW-BYTES to
392     ;;; buffer the string. Update charpos by checking to see where the last newline
393     ;;; was.
394     ;;;
395     ;;; Note: some bozos (the FASL dumper) call write-string with things other
396     ;;; than strings. Therefore, we must make sure we have a string before calling
397     ;;; position on it.
398     ;;;
399     (defun fd-sout (stream thing start end)
400     (let ((start (or start 0))
401 ram 1.14 (end (or end (length (the vector thing)))))
402 dtc 1.51 (declare (type index start end))
403 ram 1.1 (if (stringp thing)
404 wlott 1.5 (let ((last-newline (and (find #\newline (the simple-string thing)
405     :start start :end end)
406     (position #\newline (the simple-string thing)
407     :from-end t
408     :start start
409     :end end))))
410     (ecase (fd-stream-buffering stream)
411     (:full
412     (output-raw-bytes stream thing start end))
413     (:line
414     (output-raw-bytes stream thing start end)
415     (when last-newline
416     (flush-output-buffer stream)))
417     (:none
418     (do-output stream thing start end nil)))
419     (if last-newline
420     (setf (fd-stream-char-pos stream)
421     (- end last-newline 1))
422     (incf (fd-stream-char-pos stream)
423     (- end start))))
424 ram 1.1 (ecase (fd-stream-buffering stream)
425 wlott 1.5 ((:line :full)
426 ram 1.1 (output-raw-bytes stream thing start end))
427     (:none
428 wlott 1.5 (do-output stream thing start end nil))))))
429 ram 1.1
430     ;;; PICK-OUTPUT-ROUTINE -- internal
431     ;;;
432     ;;; Find an output routine to use given the type and buffering. Return as
433     ;;; multiple values the routine, the real type transfered, and the number of
434     ;;; bytes per element.
435     ;;;
436     (defun pick-output-routine (type buffering)
437     (dolist (entry *output-routines*)
438     (when (and (subtypep type (car entry))
439     (eq buffering (cadr entry)))
440     (return (values (symbol-function (caddr entry))
441     (car entry)
442     (cadddr entry))))))
443    
444    
445     ;;;; Input routines and related noise.
446    
447     (defvar *input-routines* ()
448     "List of all available input routines. Each element is a list of the
449     element-type input, the function name, and the number of bytes per element.")
450    
451     ;;; DO-INPUT -- internal
452     ;;;
453     ;;; Fills the input buffer, and returns the first character. Throws to
454     ;;; eof-input-catcher if the eof was reached. Drops into system:server if
455     ;;; necessary.
456     ;;;
457     (defun do-input (stream)
458     (let ((fd (fd-stream-fd stream))
459     (ibuf-sap (fd-stream-ibuf-sap stream))
460     (buflen (fd-stream-ibuf-length stream))
461     (head (fd-stream-ibuf-head stream))
462     (tail (fd-stream-ibuf-tail stream)))
463 ram 1.14 (declare (type index head tail))
464 ram 1.1 (unless (zerop head)
465 ram 1.14 (cond ((eql head tail)
466 ram 1.1 (setf head 0)
467     (setf tail 0)
468     (setf (fd-stream-ibuf-head stream) 0)
469     (setf (fd-stream-ibuf-tail stream) 0))
470     (t
471     (decf tail head)
472 wlott 1.5 (system-area-copy ibuf-sap (* head vm:byte-bits)
473     ibuf-sap 0 (* tail vm:byte-bits))
474 ram 1.1 (setf head 0)
475     (setf (fd-stream-ibuf-head stream) 0)
476     (setf (fd-stream-ibuf-tail stream) tail))))
477     (setf (fd-stream-listen stream) nil)
478     (multiple-value-bind
479 dtc 1.41 (count errno)
480     (alien:with-alien ((read-fds (alien:struct unix:fd-set)))
481     (unix:fd-zero read-fds)
482     (unix:fd-set fd read-fds)
483     (unix:unix-fast-select (1+ fd) (alien:addr read-fds) nil nil 0 0))
484 dtc 1.49 ;; Wait if input is not available or if interrupted.
485     (when (or (eql count 0)
486     (and (not count) (eql errno unix:eintr)))
487     (unless #-mp (system:wait-until-fd-usable
488     fd :input (fd-stream-timeout stream))
489     #+mp (mp:process-wait-until-fd-usable
490     fd :input (fd-stream-timeout stream))
491     (error 'io-timeout :stream stream :direction :read))))
492 ram 1.1 (multiple-value-bind
493 dtc 1.42 (count errno)
494 wlott 1.19 (unix:unix-read fd
495 ram 1.1 (system:int-sap (+ (system:sap-int ibuf-sap) tail))
496     (- buflen tail))
497     (cond ((null count)
498 wlott 1.21 (if (eql errno unix:ewouldblock)
499     (progn
500 dtc 1.42 (unless #-mp (system:wait-until-fd-usable
501     fd :input (fd-stream-timeout stream))
502     #+mp (mp:process-wait-until-fd-usable
503     fd :input (fd-stream-timeout stream))
504 wlott 1.21 (error 'io-timeout :stream stream :direction :read))
505     (do-input stream))
506     (error "Error reading ~S: ~A"
507     stream
508     (unix:get-unix-error-msg errno))))
509 ram 1.1 ((zerop count)
510 ram 1.12 (setf (fd-stream-listen stream) :eof)
511 ram 1.1 (throw 'eof-input-catcher nil))
512     (t
513     (incf (fd-stream-ibuf-tail stream) count))))))
514    
515     ;;; INPUT-AT-LEAST -- internal
516     ;;;
517     ;;; Makes sure there are at least ``bytes'' number of bytes in the input
518     ;;; buffer. Keeps calling do-input until that condition is met.
519     ;;;
520     (defmacro input-at-least (stream bytes)
521     (let ((stream-var (gensym))
522     (bytes-var (gensym)))
523     `(let ((,stream-var ,stream)
524     (,bytes-var ,bytes))
525     (loop
526     (when (>= (- (fd-stream-ibuf-tail ,stream-var)
527     (fd-stream-ibuf-head ,stream-var))
528     ,bytes-var)
529     (return))
530     (do-input ,stream-var)))))
531    
532     ;;; INPUT-WRAPPER -- intenal
533     ;;;
534 ram 1.24 ;;; Macro to wrap around all input routines to handle eof-error noise.
535 ram 1.1 ;;;
536     (defmacro input-wrapper ((stream bytes eof-error eof-value) &body read-forms)
537     (let ((stream-var (gensym))
538     (element-var (gensym)))
539     `(let ((,stream-var ,stream))
540 ram 1.26 (if (fd-stream-unread ,stream-var)
541     (prog1
542     (fd-stream-unread ,stream-var)
543     (setf (fd-stream-unread ,stream-var) nil)
544     (setf (fd-stream-listen ,stream-var) nil))
545     (let ((,element-var
546     (catch 'eof-input-catcher
547     (input-at-least ,stream-var ,bytes)
548     ,@read-forms)))
549     (cond (,element-var
550     (incf (fd-stream-ibuf-head ,stream-var) ,bytes)
551     ,element-var)
552     (t
553     (eof-or-lose ,stream-var ,eof-error ,eof-value))))))))
554 ram 1.1
555     ;;; DEF-INPUT-ROUTINE -- internal
556     ;;;
557     ;;; Defines an input routine.
558     ;;;
559     (defmacro def-input-routine (name
560     (type size sap head)
561     &rest body)
562     `(progn
563     (defun ,name (stream eof-error eof-value)
564     (input-wrapper (stream ,size eof-error eof-value)
565     (let ((,sap (fd-stream-ibuf-sap stream))
566     (,head (fd-stream-ibuf-head stream)))
567     ,@body)))
568     (setf *input-routines*
569     (nconc *input-routines*
570     (list (list ',type ',name ',size))))))
571    
572 wlott 1.6 ;;; INPUT-CHARACTER -- internal
573 ram 1.1 ;;;
574     ;;; Routine to use in stream-in slot for reading string chars.
575     ;;;
576 wlott 1.6 (def-input-routine input-character
577     (character 1 sap head)
578 wlott 1.5 (code-char (sap-ref-8 sap head)))
579 ram 1.1
580     ;;; INPUT-UNSIGNED-8BIT-BYTE -- internal
581     ;;;
582     ;;; Routine to read in an unsigned 8 bit number.
583     ;;;
584     (def-input-routine input-unsigned-8bit-byte
585     ((unsigned-byte 8) 1 sap head)
586 wlott 1.5 (sap-ref-8 sap head))
587 ram 1.1
588     ;;; INPUT-SIGNED-8BIT-BYTE -- internal
589     ;;;
590     ;;; Routine to read in a signed 8 bit number.
591     ;;;
592     (def-input-routine input-signed-8bit-number
593     ((signed-byte 8) 1 sap head)
594 wlott 1.5 (signed-sap-ref-8 sap head))
595 ram 1.1
596     ;;; INPUT-UNSIGNED-16BIT-BYTE -- internal
597     ;;;
598     ;;; Routine to read in an unsigned 16 bit number.
599     ;;;
600     (def-input-routine input-unsigned-16bit-byte
601     ((unsigned-byte 16) 2 sap head)
602 wlott 1.20 (sap-ref-16 sap head))
603 ram 1.1
604     ;;; INPUT-SIGNED-16BIT-BYTE -- internal
605     ;;;
606     ;;; Routine to read in a signed 16 bit number.
607     ;;;
608     (def-input-routine input-signed-16bit-byte
609     ((signed-byte 16) 2 sap head)
610 wlott 1.20 (signed-sap-ref-16 sap head))
611 ram 1.1
612     ;;; INPUT-UNSIGNED-32BIT-BYTE -- internal
613     ;;;
614     ;;; Routine to read in a unsigned 32 bit number.
615     ;;;
616     (def-input-routine input-unsigned-32bit-byte
617     ((unsigned-byte 32) 4 sap head)
618 wlott 1.20 (sap-ref-32 sap head))
619 ram 1.1
620     ;;; INPUT-SIGNED-32BIT-BYTE -- internal
621     ;;;
622     ;;; Routine to read in a signed 32 bit number.
623     ;;;
624     (def-input-routine input-signed-32bit-byte
625     ((signed-byte 32) 4 sap head)
626 wlott 1.20 (signed-sap-ref-32 sap head))
627 ram 1.1
628     ;;; PICK-INPUT-ROUTINE -- internal
629     ;;;
630     ;;; Find an input routine to use given the type. Return as multiple values
631     ;;; the routine, the real type transfered, and the number of bytes per element.
632     ;;;
633     (defun pick-input-routine (type)
634     (dolist (entry *input-routines*)
635     (when (subtypep type (car entry))
636     (return (values (symbol-function (cadr entry))
637     (car entry)
638     (caddr entry))))))
639    
640     ;;; STRING-FROM-SAP -- internal
641     ;;;
642     ;;; Returns a string constructed from the sap, start, and end.
643     ;;;
644     (defun string-from-sap (sap start end)
645 ram 1.14 (declare (type index start end))
646 ram 1.1 (let* ((length (- end start))
647     (string (make-string length)))
648 wlott 1.5 (copy-from-system-area sap (* start vm:byte-bits)
649     string (* vm:vector-data-offset vm:word-bits)
650     (* length vm:byte-bits))
651 ram 1.1 string))
652    
653 ram 1.13 #|
654 ram 1.1 ;;; FD-STREAM-READ-N-BYTES -- internal
655     ;;;
656 dtc 1.50 ;;; This version waits using server. I changed to the non-server version
657     ;;; because it allows this method to be used by CLX w/o confusing serve-event.
658     ;;; The non-server method is also significantly more efficient for large
659     ;;; reads. -- Ram
660     ;;;
661 ram 1.1 ;;; The n-bin routine.
662     ;;;
663     (defun fd-stream-read-n-bytes (stream buffer start requested eof-error-p)
664 dtc 1.50 (declare (type stream stream) (type index start requested))
665 ram 1.1 (let* ((sap (fd-stream-ibuf-sap stream))
666     (elsize (fd-stream-element-size stream))
667     (offset (* elsize start))
668     (bytes (* elsize requested))
669 wlott 1.5 (result
670     (catch 'eof-input-catcher
671     (loop
672     (input-at-least stream 1)
673     (let* ((head (fd-stream-ibuf-head stream))
674     (tail (fd-stream-ibuf-tail stream))
675     (available (- tail head))
676     (copy (min available bytes)))
677     (if (typep buffer 'system-area-pointer)
678     (system-area-copy sap (* head vm:byte-bits)
679     buffer (* offset vm:byte-bits)
680     (* copy vm:byte-bits))
681     (copy-from-system-area sap (* head vm:byte-bits)
682     buffer (+ (* offset vm:byte-bits)
683     (* vm:vector-data-offset
684     vm:word-bits))
685     (* copy vm:byte-bits)))
686     (incf (fd-stream-ibuf-head stream) copy)
687     (incf offset copy)
688     (decf bytes copy))
689     (when (zerop bytes)
690     (return requested))))))
691 ram 1.26 (or result
692     (eof-or-lose stream eof-error-p
693     (- requested (/ bytes elsize))))))
694 ram 1.13 |#
695 ram 1.1
696 ram 1.13
697     ;;; FD-STREAM-READ-N-BYTES -- internal
698     ;;;
699 dtc 1.50 ;;; The N-Bin method for FD-STREAMs. This doesn't use the SERVER; it blocks
700 ram 1.13 ;;; in UNIX-READ. This allows the method to be used to implementing reading
701     ;;; for CLX. It is generally used where there is a definite amount of reading
702 ram 1.14 ;;; to be done, so blocking isn't too problematical.
703 ram 1.13 ;;;
704     ;;; We copy buffered data into the buffer. If there is enough, just return.
705     ;;; Otherwise, we see if the amount of additional data needed will fit in the
706     ;;; stream buffer. If not, inhibit GCing (so we can have a SAP into the Buffer
707     ;;; argument), and read directly into the user supplied buffer. Otherwise,
708     ;;; read a buffer-full into the stream buffer and then copy the amount we need
709     ;;; out.
710     ;;;
711     ;;; We loop doing the reads until we either get enough bytes or hit EOF. We
712 ram 1.24 ;;; must loop when eof-errorp is T because some streams (like pipes) may return
713     ;;; a partial amount without hitting EOF.
714     ;;;
715 ram 1.13 (defun fd-stream-read-n-bytes (stream buffer start requested eof-error-p)
716     (declare (type stream stream) (type index start requested))
717     (let* ((sap (fd-stream-ibuf-sap stream))
718 ram 1.24 (offset start)
719 ram 1.13 (head (fd-stream-ibuf-head stream))
720     (tail (fd-stream-ibuf-tail stream))
721     (available (- tail head))
722 ram 1.24 (copy (min requested available)))
723     (declare (type index offset head tail available copy))
724 ram 1.13 (unless (zerop copy)
725     (if (typep buffer 'system-area-pointer)
726     (system-area-copy sap (* head vm:byte-bits)
727     buffer (* offset vm:byte-bits)
728     (* copy vm:byte-bits))
729     (copy-from-system-area sap (* head vm:byte-bits)
730     buffer (+ (* offset vm:byte-bits)
731     (* vm:vector-data-offset
732     vm:word-bits))
733     (* copy vm:byte-bits)))
734     (incf (fd-stream-ibuf-head stream) copy))
735     (cond
736 ram 1.24 ((or (= copy requested)
737     (and (not eof-error-p) (/= copy 0)))
738     copy)
739     (t
740 ram 1.13 (setf (fd-stream-ibuf-head stream) 0)
741     (setf (fd-stream-ibuf-tail stream) 0)
742     (setf (fd-stream-listen stream) nil)
743 ram 1.24 (let ((now-needed (- requested copy))
744 ram 1.13 (len (fd-stream-ibuf-length stream)))
745     (declare (type index now-needed len))
746     (cond
747     ((> now-needed len)
748 ram 1.32 ;;
749     ;; If the desired amount is greater than the stream buffer size, then
750     ;; read directly into the destination, incrementing the start
751     ;; accordingly. In this case, we never leave anything in the stream
752     ;; buffer.
753 ram 1.13 (system:without-gcing
754     (loop
755     (multiple-value-bind
756     (count err)
757 wlott 1.19 (unix:unix-read (fd-stream-fd stream)
758 ram 1.13 (sap+ (if (typep buffer 'system-area-pointer)
759     buffer
760     (vector-sap buffer))
761     (+ offset copy))
762     now-needed)
763     (declare (type (or index null) count))
764     (unless count
765     (error "Error reading ~S: ~A" stream
766 wlott 1.19 (unix:get-unix-error-msg err)))
767 pw 1.48 (decf now-needed count)
768 ram 1.33 (if eof-error-p
769     (when (zerop count)
770     (error 'end-of-file :stream stream))
771     (return (- requested now-needed)))
772 ram 1.13 (when (zerop now-needed) (return requested))
773     (incf offset count)))))
774     (t
775 ram 1.32 ;;
776     ;; If we want less than the buffer size, then loop trying to fill the
777     ;; stream buffer and copying what we get into the destination. When
778     ;; we have enough, we leave what's left in the stream buffer.
779 ram 1.13 (loop
780     (multiple-value-bind
781     (count err)
782 wlott 1.19 (unix:unix-read (fd-stream-fd stream) sap len)
783 ram 1.13 (declare (type (or index null) count))
784     (unless count
785     (error "Error reading ~S: ~A" stream
786 wlott 1.19 (unix:get-unix-error-msg err)))
787 ram 1.33 (when (and eof-error-p (zerop count))
788     (error 'end-of-file :stream stream))
789    
790 ram 1.13 (let* ((copy (min now-needed count))
791     (copy-bits (* copy vm:byte-bits))
792     (buffer-start-bits
793     (* (+ offset available) vm:byte-bits)))
794     (declare (type index copy copy-bits buffer-start-bits))
795     (if (typep buffer 'system-area-pointer)
796     (system-area-copy sap 0
797     buffer buffer-start-bits
798     copy-bits)
799     (copy-from-system-area sap 0
800     buffer (+ buffer-start-bits
801     (* vm:vector-data-offset
802     vm:word-bits))
803     copy-bits))
804 ram 1.32
805 ram 1.13 (decf now-needed copy)
806 ram 1.33 (when (or (zerop now-needed) (not eof-error-p))
807 ram 1.32 (setf (fd-stream-ibuf-head stream) copy)
808     (setf (fd-stream-ibuf-tail stream) count)
809 ram 1.33 (return (- requested now-needed)))
810 ram 1.24 (incf offset copy)))))))))))
811 ram 1.13
812 ram 1.1
813     ;;;; Utility functions (misc routines, etc)
814    
815     ;;; SET-ROUTINES -- internal
816     ;;;
817 ram 1.24 ;;; Fill in the various routine slots for the given type. Input-p and
818     ;;; output-p indicate what slots to fill. The buffering slot must be set prior
819     ;;; to calling this routine.
820 ram 1.1 ;;;
821 ram 1.24 (defun set-routines (stream type input-p output-p buffer-p)
822 ram 1.1 (let ((target-type (case type
823     ((:default unsigned-byte)
824     '(unsigned-byte 8))
825     (signed-byte
826     '(signed-byte 8))
827     (t
828     type)))
829     (input-type nil)
830     (output-type nil)
831     (input-size nil)
832     (output-size nil))
833    
834 wlott 1.5 (when (fd-stream-obuf-sap stream)
835     (push (fd-stream-obuf-sap stream) *available-buffers*)
836     (setf (fd-stream-obuf-sap stream) nil))
837     (when (fd-stream-ibuf-sap stream)
838     (push (fd-stream-ibuf-sap stream) *available-buffers*)
839     (setf (fd-stream-ibuf-sap stream) nil))
840 ram 1.1
841     (when input-p
842     (multiple-value-bind
843     (routine type size)
844     (pick-input-routine target-type)
845     (unless routine
846     (error "Could not find any input routine for ~S" target-type))
847 wlott 1.5 (setf (fd-stream-ibuf-sap stream) (next-available-buffer))
848     (setf (fd-stream-ibuf-length stream) bytes-per-buffer)
849     (setf (fd-stream-ibuf-tail stream) 0)
850 ram 1.1 (if (subtypep type 'character)
851 ram 1.14 (setf (fd-stream-in stream) routine
852 ram 1.24 (fd-stream-bin stream) #'ill-bin)
853 ram 1.14 (setf (fd-stream-in stream) #'ill-in
854 ram 1.24 (fd-stream-bin stream) routine))
855     (when (eql size 1)
856     (setf (fd-stream-n-bin stream) #'fd-stream-read-n-bytes)
857     (when buffer-p
858 dtc 1.43 (setf (lisp-stream-in-buffer stream)
859 ram 1.24 (make-array in-buffer-length
860     :element-type '(unsigned-byte 8)))))
861 ram 1.1 (setf input-size size)
862     (setf input-type type)))
863    
864     (when output-p
865     (multiple-value-bind
866     (routine type size)
867     (pick-output-routine target-type (fd-stream-buffering stream))
868     (unless routine
869     (error "Could not find any output routine for ~S buffered ~S."
870     (fd-stream-buffering stream)
871     target-type))
872 wlott 1.5 (setf (fd-stream-obuf-sap stream) (next-available-buffer))
873     (setf (fd-stream-obuf-length stream) bytes-per-buffer)
874 ram 1.1 (setf (fd-stream-obuf-tail stream) 0)
875     (if (subtypep type 'character)
876     (setf (fd-stream-out stream) routine
877     (fd-stream-bout stream) #'ill-bout)
878     (setf (fd-stream-out stream)
879     (or (if (eql size 1)
880 wlott 1.16 (pick-output-routine 'base-char
881 ram 1.1 (fd-stream-buffering stream)))
882     #'ill-out)
883     (fd-stream-bout stream) routine))
884     (setf (fd-stream-sout stream)
885     (if (eql size 1) #'fd-sout #'ill-out))
886     (setf (fd-stream-char-pos stream) 0)
887     (setf output-size size)
888     (setf output-type type)))
889    
890     (when (and input-size output-size
891     (not (eq input-size output-size)))
892     (error "Element sizes for input (~S:~S) and output (~S:~S) differ?"
893     input-type input-size
894     output-type output-size))
895     (setf (fd-stream-element-size stream)
896     (or input-size output-size))
897    
898     (setf (fd-stream-element-type stream)
899     (cond ((equal input-type output-type)
900     input-type)
901 dtc 1.39 ((null output-type)
902     input-type)
903     ((null input-type)
904     output-type)
905     ((subtypep input-type output-type)
906 ram 1.1 input-type)
907     ((subtypep output-type input-type)
908     output-type)
909     (t
910     (error "Input type (~S) and output type (~S) are unrelated?"
911     input-type
912     output-type))))))
913    
914     ;;; FD-STREAM-MISC-ROUTINE -- input
915     ;;;
916     ;;; Handle the various misc operations on fd-stream.
917     ;;;
918     (defun fd-stream-misc-routine (stream operation &optional arg1 arg2)
919 ram 1.24 (declare (ignore arg2))
920 ram 1.1 (case operation
921 ram 1.24 (:listen
922 ram 1.1 (or (not (eql (fd-stream-ibuf-head stream)
923     (fd-stream-ibuf-tail stream)))
924     (fd-stream-listen stream)
925     (setf (fd-stream-listen stream)
926 dtc 1.41 (eql (alien:with-alien ((read-fds (alien:struct unix:fd-set)))
927     (unix:fd-zero read-fds)
928     (unix:fd-set (fd-stream-fd stream) read-fds)
929     (unix:unix-fast-select (1+ (fd-stream-fd stream))
930     (alien:addr read-fds) nil nil
931     0 0))
932 ram 1.13 1))))
933 ram 1.1 (:unread
934 wlott 1.5 (setf (fd-stream-unread stream) arg1)
935     (setf (fd-stream-listen stream) t))
936 ram 1.1 (:close
937     (cond (arg1
938     ;; We got us an abort on our hands.
939 dtc 1.40 (when (fd-stream-handler stream)
940     (system:remove-fd-handler (fd-stream-handler stream))
941     (setf (fd-stream-handler stream) nil))
942 ram 1.1 (when (and (fd-stream-file stream)
943 wlott 1.5 (fd-stream-obuf-sap stream))
944 ram 1.1 ;; Can't do anything unless we know what file were dealing with,
945     ;; and we don't want to do anything strange unless we were
946     ;; writing to the file.
947     (if (fd-stream-original stream)
948     ;; Have an handle on the original, just revert.
949     (multiple-value-bind
950     (okay err)
951 wlott 1.19 (unix:unix-rename (fd-stream-original stream)
952 ram 1.1 (fd-stream-file stream))
953     (unless okay
954     (cerror "Go on as if nothing bad happened."
955     "Could not restore ~S to it's original contents: ~A"
956     (fd-stream-file stream)
957 wlott 1.19 (unix:get-unix-error-msg err))))
958 ram 1.1 ;; Can't restore the orignal, so nuke that puppy.
959     (multiple-value-bind
960     (okay err)
961 wlott 1.19 (unix:unix-unlink (fd-stream-file stream))
962 ram 1.1 (unless okay
963     (cerror "Go on as if nothing bad happened."
964     "Could not remove ~S: ~A"
965     (fd-stream-file stream)
966 wlott 1.19 (unix:get-unix-error-msg err)))))))
967 ram 1.1 (t
968     (fd-stream-misc-routine stream :finish-output)
969     (when (and (fd-stream-original stream)
970     (fd-stream-delete-original stream))
971     (multiple-value-bind
972     (okay err)
973 wlott 1.19 (unix:unix-unlink (fd-stream-original stream))
974 ram 1.1 (unless okay
975     (cerror "Go on as if nothing bad happened."
976     "Could not delete ~S during close of ~S: ~A"
977     (fd-stream-original stream)
978     stream
979 wlott 1.19 (unix:get-unix-error-msg err)))))))
980 wlott 1.17 (when (fboundp 'cancel-finalization)
981     (cancel-finalization stream))
982 wlott 1.19 (unix:unix-close (fd-stream-fd stream))
983 wlott 1.5 (when (fd-stream-obuf-sap stream)
984     (push (fd-stream-obuf-sap stream) *available-buffers*)
985     (setf (fd-stream-obuf-sap stream) nil))
986     (when (fd-stream-ibuf-sap stream)
987     (push (fd-stream-ibuf-sap stream) *available-buffers*)
988     (setf (fd-stream-ibuf-sap stream) nil))
989 ram 1.1 (lisp::set-closed-flame stream))
990 wlott 1.6 (:clear-input
991 wlott 1.25 (setf (fd-stream-unread stream) nil)
992 wlott 1.6 (setf (fd-stream-ibuf-head stream) 0)
993     (setf (fd-stream-ibuf-tail stream) 0)
994 ram 1.38 (catch 'eof-input-catcher
995     (loop
996 dtc 1.49 (multiple-value-bind
997     (count errno)
998     (alien:with-alien ((read-fds (alien:struct unix:fd-set)))
999     (unix:fd-zero read-fds)
1000     (unix:fd-set (fd-stream-fd stream) read-fds)
1001     (unix:unix-fast-select (1+ (fd-stream-fd stream))
1002     (alien:addr read-fds) nil nil 0 0))
1003 ram 1.38 (cond ((eql count 1)
1004     (do-input stream)
1005     (setf (fd-stream-ibuf-head stream) 0)
1006     (setf (fd-stream-ibuf-tail stream) 0))
1007 dtc 1.49 ((and (not count) (eql errno unix:eintr)))
1008 ram 1.38 (t
1009     (return t)))))))
1010 ram 1.1 (:force-output
1011     (flush-output-buffer stream))
1012     (:finish-output
1013     (flush-output-buffer stream)
1014     (do ()
1015     ((null (fd-stream-output-later stream)))
1016     (system:serve-all-events)))
1017     (:element-type
1018     (fd-stream-element-type stream))
1019 ram 1.22 (:interactive-p
1020     (unix:unix-isatty (fd-stream-fd stream)))
1021 ram 1.1 (:line-length
1022     80)
1023     (:charpos
1024     (fd-stream-char-pos stream))
1025     (:file-length
1026     (multiple-value-bind
1027     (okay dev ino mode nlink uid gid rdev size
1028     atime mtime ctime blksize blocks)
1029 wlott 1.19 (unix:unix-fstat (fd-stream-fd stream))
1030 ram 1.1 (declare (ignore ino nlink uid gid rdev
1031     atime mtime ctime blksize blocks))
1032     (unless okay
1033     (error "Error fstating ~S: ~A"
1034     stream
1035 wlott 1.19 (unix:get-unix-error-msg dev)))
1036 dtc 1.51 (if (zerop mode)
1037 ram 1.23 nil
1038 dtc 1.51 (truncate size (fd-stream-element-size stream)))))
1039 ram 1.1 (:file-position
1040 ram 1.29 (fd-stream-file-position stream arg1))))
1041 ram 1.1
1042 ram 1.28
1043 ram 1.1 ;;; FD-STREAM-FILE-POSITION -- internal.
1044     ;;;
1045     (defun fd-stream-file-position (stream &optional newpos)
1046 ram 1.14 (declare (type fd-stream stream)
1047 dtc 1.51 (type (or (integer 0) (member nil :start :end)) newpos))
1048 ram 1.1 (if (null newpos)
1049     (system:without-interrupts
1050 dtc 1.51 ;; First, find the position of the UNIX file descriptor in the file.
1051 ram 1.1 (multiple-value-bind
1052 dtc 1.51 (posn errno)
1053 wlott 1.19 (unix:unix-lseek (fd-stream-fd stream) 0 unix:l_incr)
1054 dtc 1.51 (declare (type (or (integer 0) null) posn))
1055     (cond (posn
1056 ram 1.1 ;; Adjust for buffered output:
1057     ;; If there is any output buffered, the *real* file position
1058     ;; will be larger than reported by lseek because lseek
1059 ram 1.28 ;; obviously cannot take< into account output we have not
1060 ram 1.1 ;; sent yet.
1061     (dolist (later (fd-stream-output-later stream))
1062 ram 1.14 (incf posn (- (the index (caddr later))
1063     (the index (cadr later)))))
1064 ram 1.1 (incf posn (fd-stream-obuf-tail stream))
1065     ;; Adjust for unread input:
1066     ;; If there is any input read from UNIX but not supplied to
1067     ;; the user of the stream, the *real* file position will
1068     ;; smaller than reported, because we want to look like the
1069     ;; unread stuff is still available.
1070     (decf posn (- (fd-stream-ibuf-tail stream)
1071     (fd-stream-ibuf-head stream)))
1072     (when (fd-stream-unread stream)
1073     (decf posn))
1074     ;; Divide bytes by element size.
1075 ram 1.14 (truncate posn (fd-stream-element-size stream)))
1076 wlott 1.19 ((eq errno unix:espipe)
1077 ram 1.1 nil)
1078     (t
1079     (system:with-interrupts
1080     (error "Error lseek'ing ~S: ~A"
1081     stream
1082 wlott 1.19 (unix:get-unix-error-msg errno)))))))
1083 dtc 1.51 (let ((offset 0)
1084     origin)
1085     (declare (type (integer 0) offset))
1086 ram 1.1 ;; Make sure we don't have any output pending, because if we move the
1087     ;; file pointer before writing this stuff, it will be written in the
1088     ;; wrong location.
1089     (flush-output-buffer stream)
1090     (do ()
1091     ((null (fd-stream-output-later stream)))
1092     (system:serve-all-events))
1093 ram 1.4 ;; Clear out any pending input to force the next read to go to the
1094     ;; disk.
1095     (setf (fd-stream-unread stream) nil)
1096     (setf (fd-stream-ibuf-head stream) 0)
1097     (setf (fd-stream-ibuf-tail stream) 0)
1098 dtc 1.51 ;; Trash cached value for listen, so that we check next time.
1099 wlott 1.5 (setf (fd-stream-listen stream) nil)
1100 ram 1.4 ;; Now move it.
1101 ram 1.1 (cond ((eq newpos :start)
1102 dtc 1.51 (setf offset 0
1103     origin unix:l_set))
1104 ram 1.1 ((eq newpos :end)
1105 dtc 1.51 (setf offset 0
1106     origin unix:l_xtnd))
1107     ((typep newpos '(integer 0))
1108 ram 1.1 (setf offset (* newpos (fd-stream-element-size stream))
1109 wlott 1.19 origin unix:l_set))
1110 ram 1.1 (t
1111     (error "Invalid position given to file-position: ~S" newpos)))
1112     (multiple-value-bind
1113     (posn errno)
1114 wlott 1.19 (unix:unix-lseek (fd-stream-fd stream) offset origin)
1115 dtc 1.51 (cond (posn
1116 ram 1.1 t)
1117 wlott 1.19 ((eq errno unix:espipe)
1118 ram 1.1 nil)
1119     (t
1120     (error "Error lseek'ing ~S: ~A"
1121     stream
1122 wlott 1.19 (unix:get-unix-error-msg errno))))))))
1123 ram 1.1
1124    
1125    
1126     ;;;; Creation routines (MAKE-FD-STREAM and OPEN)
1127    
1128     ;;; MAKE-FD-STREAM -- Public.
1129     ;;;
1130     ;;; Returns a FD-STREAM on the given file.
1131     ;;;
1132     (defun make-fd-stream (fd
1133     &key
1134     (input nil input-p)
1135     (output nil output-p)
1136 wlott 1.16 (element-type 'base-char)
1137 ram 1.1 (buffering :full)
1138 ram 1.15 timeout
1139 ram 1.1 file
1140     original
1141     delete-original
1142 ram 1.28 pathname
1143 ram 1.24 input-buffer-p
1144 ram 1.1 (name (if file
1145     (format nil "file ~S" file)
1146 wlott 1.17 (format nil "descriptor ~D" fd)))
1147     auto-close)
1148 ram 1.15 (declare (type index fd) (type (or index null) timeout)
1149     (type (member :none :line :full) buffering))
1150     "Create a stream for the given unix file descriptor.
1151     If input is non-nil, allow input operations.
1152     If output is non-nil, allow output operations.
1153     If neither input nor output are specified, default to allowing input.
1154     Element-type indicates the element type to use (as for open).
1155     Buffering indicates the kind of buffering to use.
1156     Timeout (if true) is the number of seconds to wait for input. If NIL (the
1157     default), then wait forever. When we time out, we signal IO-TIMEOUT.
1158     File is the name of the file (will be returned by PATHNAME).
1159     Name is used to identify the stream when printed."
1160 ram 1.1 (cond ((not (or input-p output-p))
1161     (setf input t))
1162     ((not (or input output))
1163     (error "File descriptor must be opened either for input or output.")))
1164     (let ((stream (%make-fd-stream :fd fd
1165     :name name
1166     :file file
1167     :original original
1168     :delete-original delete-original
1169 ram 1.28 :pathname pathname
1170 ram 1.15 :buffering buffering
1171     :timeout timeout)))
1172 ram 1.24 (set-routines stream element-type input output input-buffer-p)
1173 wlott 1.17 (when (and auto-close (fboundp 'finalize))
1174     (finalize stream
1175     #'(lambda ()
1176 wlott 1.19 (unix:unix-close fd)
1177 wlott 1.17 (format *terminal-io* "** Closed file descriptor ~D~%"
1178     fd))))
1179 ram 1.1 stream))
1180    
1181 ram 1.24
1182 ram 1.1 ;;; PICK-PACKUP-NAME -- internal
1183     ;;;
1184     ;;; Pick a name to use for the backup file.
1185     ;;;
1186     (defvar *backup-extension* ".BAK"
1187     "This is a string that OPEN tacks on the end of a file namestring to produce
1188     a name for the :if-exists :rename-and-delete and :rename options. Also,
1189     this can be a function that takes a namestring and returns a complete
1190     namestring.")
1191     ;;;
1192     (defun pick-backup-name (name)
1193 ram 1.14 (declare (type simple-string name))
1194     (let ((ext *backup-extension*))
1195     (etypecase ext
1196     (simple-string (concatenate 'simple-string name ext))
1197     (function (funcall ext name)))))
1198 ram 1.1
1199     ;;; ASSURE-ONE-OF -- internal
1200     ;;;
1201     ;;; Assure that the given arg is one of the given list of valid things.
1202     ;;; Allow the user to fix any problems.
1203     ;;;
1204     (defun assure-one-of (item list what)
1205     (unless (member item list)
1206     (loop
1207     (cerror "Enter new value for ~*~S"
1208     "~S is invalid for ~S. Must be one of~{ ~S~}"
1209     item
1210     what
1211     list)
1212 ram 1.14 (format (the stream *query-io*) "Enter new value for ~S: " what)
1213 ram 1.1 (force-output *query-io*)
1214     (setf item (read *query-io*))
1215     (when (member item list)
1216     (return))))
1217     item)
1218    
1219 ram 1.14 ;;; DO-OLD-RENAME -- Internal
1220     ;;;
1221     ;;; Rename Namestring to Original. First, check if we have write access,
1222     ;;; since we don't want to trash unwritable files even if we technically can.
1223     ;;; We return true if we suceed in renaming.
1224     ;;;
1225     (defun do-old-rename (namestring original)
1226 wlott 1.19 (unless (unix:unix-access namestring unix:w_ok)
1227 ram 1.14 (cerror "Try to rename it anyway." "File ~S is not writable." namestring))
1228     (multiple-value-bind
1229     (okay err)
1230 wlott 1.19 (unix:unix-rename namestring original)
1231 ram 1.14 (cond (okay t)
1232     (t
1233     (cerror "Use :SUPERSEDE instead."
1234     "Could not rename ~S to ~S: ~A."
1235     namestring
1236     original
1237 wlott 1.19 (unix:get-unix-error-msg err))
1238 ram 1.14 nil))))
1239    
1240    
1241 ram 1.1 ;;; OPEN -- public
1242     ;;;
1243     ;;; Open the given file.
1244     ;;;
1245     (defun open (filename
1246     &key
1247     (direction :input)
1248 wlott 1.16 (element-type 'base-char)
1249 ram 1.1 (if-exists nil if-exists-given)
1250 ram 1.27 (if-does-not-exist nil if-does-not-exist-given)
1251 ram 1.35 (external-format :default)
1252     &aux ; Squelch assignment warning.
1253     (direction direction)
1254     (if-does-not-exist if-does-not-exist)
1255     (if-exists if-exists))
1256 ram 1.1 "Return a stream which reads from or writes to Filename.
1257     Defined keywords:
1258     :direction - one of :input, :output, :io, or :probe
1259 wlott 1.16 :element-type - Type of object to read or write, default BASE-CHAR
1260 ram 1.1 :if-exists - one of :error, :new-version, :rename, :rename-and-delete,
1261     :overwrite, :append, :supersede or nil
1262     :if-does-not-exist - one of :error, :create or nil
1263     See the manual for details."
1264 dtc 1.47 (declare (ignore external-format))
1265 dtc 1.46
1266 ram 1.1 ;; First, make sure that DIRECTION is valid. Allow it to be changed if not.
1267     (setf direction
1268     (assure-one-of direction
1269     '(:input :output :io :probe)
1270     :direction))
1271    
1272     ;; Calculate useful stuff.
1273     (multiple-value-bind
1274     (input output mask)
1275     (case direction
1276 wlott 1.19 (:input (values t nil unix:o_rdonly))
1277     (:output (values nil t unix:o_wronly))
1278     (:io (values t t unix:o_rdwr))
1279     (:probe (values t nil unix:o_rdonly)))
1280 ram 1.14 (declare (type index mask))
1281 ram 1.1 (let* ((pathname (pathname filename))
1282 ram 1.34 (namestring
1283     (cond ((unix-namestring pathname input))
1284     ((and input (eq if-does-not-exist :create))
1285     (unix-namestring pathname nil)))))
1286 ram 1.1 ;; Process if-exists argument if we are doing any output.
1287     (cond (output
1288     (unless if-exists-given
1289     (setf if-exists
1290     (if (eq (pathname-version pathname) :newest)
1291 ram 1.34 :new-version
1292     :error)))
1293 ram 1.1 (setf if-exists
1294     (assure-one-of if-exists
1295     '(:error :new-version :rename
1296     :rename-and-delete :overwrite
1297     :append :supersede nil)
1298     :if-exists))
1299     (case if-exists
1300     ((:error nil)
1301 wlott 1.19 (setf mask (logior mask unix:o_excl)))
1302 ram 1.1 ((:rename :rename-and-delete)
1303 wlott 1.19 (setf mask (logior mask unix:o_creat)))
1304 ram 1.1 ((:new-version :supersede)
1305 wlott 1.19 (setf mask (logior mask unix:o_trunc)))
1306 ram 1.1 (:append
1307 wlott 1.19 (setf mask (logior mask unix:o_append)))))
1308 ram 1.1 (t
1309     (setf if-exists :ignore-this-arg)))
1310    
1311     (unless if-does-not-exist-given
1312     (setf if-does-not-exist
1313     (cond ((eq direction :input) :error)
1314     ((and output
1315     (member if-exists '(:overwrite :append)))
1316     :error)
1317     ((eq direction :probe)
1318     nil)
1319     (t
1320     :create))))
1321     (setf if-does-not-exist
1322     (assure-one-of if-does-not-exist
1323     '(:error :create nil)
1324     :if-does-not-exist))
1325     (if (eq if-does-not-exist :create)
1326 wlott 1.19 (setf mask (logior mask unix:o_creat)))
1327 ram 1.1
1328     (let ((original (if (member if-exists
1329     '(:rename :rename-and-delete))
1330 ram 1.14 (pick-backup-name namestring)))
1331 ram 1.1 (delete-original (eq if-exists :rename-and-delete))
1332     (mode #o666))
1333     (when original
1334     ;; We are doing a :rename or :rename-and-delete.
1335     ;; Determine if the file already exists, make sure the original
1336     ;; file is not a directory and keep the mode
1337     (let ((exists
1338 wlott 1.18 (and namestring
1339     (multiple-value-bind
1340     (okay err/dev inode orig-mode)
1341 wlott 1.19 (unix:unix-stat namestring)
1342 wlott 1.18 (declare (ignore inode)
1343     (type (or index null) orig-mode))
1344     (cond
1345     (okay
1346 ram 1.1 (when (and output (= (logand orig-mode #o170000)
1347     #o40000))
1348     (error "Cannot open ~S for output: Is a directory."
1349     namestring))
1350     (setf mode (logand orig-mode #o777))
1351     t)
1352 wlott 1.19 ((eql err/dev unix:enoent)
1353 ram 1.1 nil)
1354     (t
1355     (error "Cannot find ~S: ~A"
1356     namestring
1357 wlott 1.19 (unix:get-unix-error-msg err/dev))))))))
1358 ram 1.14 (unless (and exists
1359     (do-old-rename namestring original))
1360 ram 1.1 (setf original nil)
1361     (setf delete-original nil)
1362     ;; In order to use SUPERSEDE instead, we have
1363 wlott 1.19 ;; to make sure unix:o_creat corresponds to
1364     ;; if-does-not-exist. unix:o_creat was set
1365 ram 1.1 ;; before because of if-exists being :rename.
1366     (unless (eq if-does-not-exist :create)
1367 wlott 1.19 (setf mask (logior (logandc2 mask unix:o_creat) unix:o_trunc)))
1368 ram 1.1 (setf if-exists :supersede))))
1369    
1370     ;; Okay, now we can try the actual open.
1371 wlott 1.9 (loop
1372     (multiple-value-bind
1373     (fd errno)
1374 wlott 1.18 (if namestring
1375 wlott 1.19 (unix:unix-open namestring mask mode)
1376     (values nil unix:enoent))
1377 wlott 1.9 (cond ((numberp fd)
1378     (return
1379     (case direction
1380     ((:input :output :io)
1381     (make-fd-stream fd
1382     :input input
1383     :output output
1384     :element-type element-type
1385     :file namestring
1386     :original original
1387 wlott 1.17 :delete-original delete-original
1388 ram 1.28 :pathname pathname
1389 ram 1.24 :input-buffer-p t
1390 wlott 1.17 :auto-close t))
1391 wlott 1.9 (:probe
1392     (let ((stream
1393     (%make-fd-stream :name namestring :fd fd
1394 ram 1.28 :pathname pathname
1395 wlott 1.9 :element-type element-type)))
1396     (close stream)
1397     stream)))))
1398 wlott 1.19 ((eql errno unix:enoent)
1399 wlott 1.9 (case if-does-not-exist
1400     (:error
1401     (cerror "Return NIL."
1402 pw 1.44 'simple-file-error
1403     :pathname pathname
1404     :format-control "Error opening ~S, ~A."
1405     :format-arguments
1406     (list pathname (unix:get-unix-error-msg errno))))
1407 wlott 1.9 (:create
1408     (cerror "Return NIL."
1409     "Error creating ~S, path does not exist."
1410     pathname)))
1411     (return nil))
1412 wlott 1.19 ((eql errno unix:eexist)
1413 wlott 1.9 (unless (eq nil if-exists)
1414     (cerror "Return NIL."
1415 pw 1.44 'simple-file-error
1416     :pathname pathname
1417     :format-control "Error opening ~S, ~A."
1418     :format-arguments
1419     (list pathname (unix:get-unix-error-msg errno))))
1420 wlott 1.9 (return nil))
1421 wlott 1.19 ((eql errno unix:eacces)
1422 wlott 1.9 (cerror "Try again."
1423     "Error opening ~S, ~A."
1424     pathname
1425 wlott 1.19 (unix:get-unix-error-msg errno)))
1426 wlott 1.9 (t
1427 ram 1.1 (cerror "Return NIL."
1428     "Error opening ~S, ~A."
1429     pathname
1430 wlott 1.19 (unix:get-unix-error-msg errno))
1431 wlott 1.9 (return nil)))))))))
1432 ram 1.1
1433     ;;;; Initialization.
1434    
1435     (defvar *tty* nil
1436     "The stream connected to the controlling terminal or NIL if there is none.")
1437     (defvar *stdin* nil
1438     "The stream connected to the standard input (file descriptor 0).")
1439     (defvar *stdout* nil
1440     "The stream connected to the standard output (file descriptor 1).")
1441     (defvar *stderr* nil
1442     "The stream connected to the standard error output (file descriptor 2).")
1443    
1444     ;;; STREAM-INIT -- internal interface
1445     ;;;
1446     ;;; Called when the cold load is first started up.
1447     ;;;
1448     (defun stream-init ()
1449     (stream-reinit)
1450     (setf *terminal-io* (make-synonym-stream '*tty*))
1451     (setf *standard-output* (make-synonym-stream '*stdout*))
1452 ram 1.11 (setf *standard-input*
1453     (make-two-way-stream (make-synonym-stream '*stdin*)
1454     *standard-output*))
1455 ram 1.1 (setf *error-output* (make-synonym-stream '*stderr*))
1456     (setf *query-io* (make-synonym-stream '*terminal-io*))
1457 pw 1.53 (setf *debug-io* *query-io*)
1458 ram 1.1 (setf *trace-output* *standard-output*)
1459     nil)
1460    
1461     ;;; STREAM-REINIT -- internal interface
1462     ;;;
1463     ;;; Called whenever a saved core is restarted.
1464     ;;;
1465     (defun stream-reinit ()
1466     (setf *available-buffers* nil)
1467     (setf *stdin*
1468     (make-fd-stream 0 :name "Standard Input" :input t :buffering :line))
1469     (setf *stdout*
1470     (make-fd-stream 1 :name "Standard Output" :output t :buffering :line))
1471     (setf *stderr*
1472     (make-fd-stream 2 :name "Standard Error" :output t :buffering :line))
1473 wlott 1.19 (let ((tty (unix:unix-open "/dev/tty" unix:o_rdwr #o666)))
1474 ram 1.1 (if tty
1475     (setf *tty*
1476     (make-fd-stream tty :name "the Terminal" :input t :output t
1477 wlott 1.17 :buffering :line :auto-close t))
1478 ram 1.1 (setf *tty* (make-two-way-stream *stdin* *stdout*))))
1479     nil)
1480    
1481    
1482     ;;;; Beeping.
1483    
1484     (defun default-beep-function (stream)
1485     (write-char #\bell stream)
1486     (finish-output stream))
1487    
1488     (defvar *beep-function* #'default-beep-function
1489     "This is called in BEEP to feep the user. It takes a stream.")
1490    
1491     (defun beep (&optional (stream *terminal-io*))
1492     (funcall *beep-function* stream))
1493    
1494    
1495     ;;; File-Name -- internal interface
1496     ;;;
1497     ;;; Kind of like File-Position, but is an internal hack used by the filesys
1498     ;;; stuff to get and set the file name.
1499     ;;;
1500     (defun file-name (stream &optional new-name)
1501 ram 1.29 (when (typep stream 'fd-stream)
1502 ram 1.30 (cond (new-name
1503     (setf (fd-stream-pathname stream) new-name)
1504     (setf (fd-stream-file stream)
1505     (unix-namestring new-name nil))
1506 ram 1.29 t)
1507     (t
1508     (fd-stream-pathname stream)))))
1509    
1510 ram 1.27
1511     ;;;; Degenerate international character support:
1512    
1513     (defun file-string-length (stream object)
1514     (declare (type (or string character) object) (type file-stream stream))
1515     "Return the delta in Stream's FILE-POSITION that would be caused by writing
1516     Object to Stream. Non-trivial only in implementations that support
1517     international character sets."
1518 ram 1.28 (declare (ignore stream))
1519 ram 1.27 (etypecase object
1520     (character 1)
1521     (string (length object))))
1522    
1523     (defun stream-external-format (stream)
1524 ram 1.28 (declare (type file-stream stream) (ignore stream))
1525 ram 1.27 "Returns :DEFAULT."
1526     :default)

  ViewVC Help
Powered by ViewVC 1.1.5