/[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.40.2.9 - (hide annotations)
Wed Apr 3 18:32:24 2002 UTC (12 years ago) by pw
Branch: RELENG_18
CVS Tags: RELEASE_18d
Changes since 1.40.2.8: +2 -2 lines
Include fix for READ-BYTE on multi-byte elements.
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.40.2.9 "$Header: /tiger/var/lib/cvsroots/cmucl/src/code/fd-stream.lisp,v 1.40.2.9 2002/04/03 18:32:24 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 pw 1.40.2.8 (declaim (inline next-available-buffer))
52 ram 1.1 ;;;
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 pw 1.40.2.1 (: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.40.2.4 (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.40.2.4 (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 pw 1.40.2.1 (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 pw 1.40.2.3 ;; 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 pw 1.40.2.1 (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 pw 1.40.2.1 (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 pw 1.40.2.3 ;;; 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 pw 1.40.2.3 (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 pw 1.40.2.3 ;;; 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.40.2.3 (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 pw 1.40.2.8 (when (or (eql size 1)
856     (eql size 2)
857     (eql size 4))
858     ;; Support for n-byte operations on 8-, 16-, and 32-bit streams
859 ram 1.24 (setf (fd-stream-n-bin stream) #'fd-stream-read-n-bytes)
860 pw 1.40.2.9 (when (and buffer-p (eql size 1))
861 pw 1.40.2.1 (setf (lisp-stream-in-buffer stream)
862 ram 1.24 (make-array in-buffer-length
863     :element-type '(unsigned-byte 8)))))
864 ram 1.1 (setf input-size size)
865     (setf input-type type)))
866    
867     (when output-p
868     (multiple-value-bind
869     (routine type size)
870     (pick-output-routine target-type (fd-stream-buffering stream))
871     (unless routine
872     (error "Could not find any output routine for ~S buffered ~S."
873     (fd-stream-buffering stream)
874     target-type))
875 wlott 1.5 (setf (fd-stream-obuf-sap stream) (next-available-buffer))
876     (setf (fd-stream-obuf-length stream) bytes-per-buffer)
877 ram 1.1 (setf (fd-stream-obuf-tail stream) 0)
878     (if (subtypep type 'character)
879     (setf (fd-stream-out stream) routine
880     (fd-stream-bout stream) #'ill-bout)
881     (setf (fd-stream-out stream)
882     (or (if (eql size 1)
883 wlott 1.16 (pick-output-routine 'base-char
884 ram 1.1 (fd-stream-buffering stream)))
885     #'ill-out)
886     (fd-stream-bout stream) routine))
887     (setf (fd-stream-sout stream)
888     (if (eql size 1) #'fd-sout #'ill-out))
889     (setf (fd-stream-char-pos stream) 0)
890     (setf output-size size)
891     (setf output-type type)))
892    
893     (when (and input-size output-size
894     (not (eq input-size output-size)))
895     (error "Element sizes for input (~S:~S) and output (~S:~S) differ?"
896     input-type input-size
897     output-type output-size))
898     (setf (fd-stream-element-size stream)
899     (or input-size output-size))
900    
901     (setf (fd-stream-element-type stream)
902     (cond ((equal input-type output-type)
903     input-type)
904 dtc 1.39 ((null output-type)
905     input-type)
906     ((null input-type)
907     output-type)
908     ((subtypep input-type output-type)
909 ram 1.1 input-type)
910     ((subtypep output-type input-type)
911     output-type)
912     (t
913     (error "Input type (~S) and output type (~S) are unrelated?"
914     input-type
915     output-type))))))
916    
917     ;;; FD-STREAM-MISC-ROUTINE -- input
918     ;;;
919     ;;; Handle the various misc operations on fd-stream.
920     ;;;
921     (defun fd-stream-misc-routine (stream operation &optional arg1 arg2)
922 ram 1.24 (declare (ignore arg2))
923 ram 1.1 (case operation
924 ram 1.24 (:listen
925 ram 1.1 (or (not (eql (fd-stream-ibuf-head stream)
926     (fd-stream-ibuf-tail stream)))
927     (fd-stream-listen stream)
928     (setf (fd-stream-listen stream)
929 pw 1.40.2.1 (eql (alien:with-alien ((read-fds (alien:struct unix:fd-set)))
930     (unix:fd-zero read-fds)
931     (unix:fd-set (fd-stream-fd stream) read-fds)
932     (unix:unix-fast-select (1+ (fd-stream-fd stream))
933     (alien:addr read-fds) nil nil
934     0 0))
935 ram 1.13 1))))
936 ram 1.1 (:unread
937 wlott 1.5 (setf (fd-stream-unread stream) arg1)
938     (setf (fd-stream-listen stream) t))
939 ram 1.1 (:close
940     (cond (arg1
941     ;; We got us an abort on our hands.
942 dtc 1.40 (when (fd-stream-handler stream)
943     (system:remove-fd-handler (fd-stream-handler stream))
944     (setf (fd-stream-handler stream) nil))
945 ram 1.1 (when (and (fd-stream-file stream)
946 wlott 1.5 (fd-stream-obuf-sap stream))
947 ram 1.1 ;; Can't do anything unless we know what file were dealing with,
948     ;; and we don't want to do anything strange unless we were
949     ;; writing to the file.
950     (if (fd-stream-original stream)
951     ;; Have an handle on the original, just revert.
952     (multiple-value-bind
953     (okay err)
954 wlott 1.19 (unix:unix-rename (fd-stream-original stream)
955 ram 1.1 (fd-stream-file stream))
956     (unless okay
957     (cerror "Go on as if nothing bad happened."
958     "Could not restore ~S to it's original contents: ~A"
959     (fd-stream-file stream)
960 wlott 1.19 (unix:get-unix-error-msg err))))
961 ram 1.1 ;; Can't restore the orignal, so nuke that puppy.
962     (multiple-value-bind
963     (okay err)
964 wlott 1.19 (unix:unix-unlink (fd-stream-file stream))
965 ram 1.1 (unless okay
966     (cerror "Go on as if nothing bad happened."
967     "Could not remove ~S: ~A"
968     (fd-stream-file stream)
969 wlott 1.19 (unix:get-unix-error-msg err)))))))
970 ram 1.1 (t
971     (fd-stream-misc-routine stream :finish-output)
972     (when (and (fd-stream-original stream)
973     (fd-stream-delete-original stream))
974     (multiple-value-bind
975     (okay err)
976 wlott 1.19 (unix:unix-unlink (fd-stream-original stream))
977 ram 1.1 (unless okay
978     (cerror "Go on as if nothing bad happened."
979     "Could not delete ~S during close of ~S: ~A"
980     (fd-stream-original stream)
981     stream
982 wlott 1.19 (unix:get-unix-error-msg err)))))))
983 wlott 1.17 (when (fboundp 'cancel-finalization)
984     (cancel-finalization stream))
985 wlott 1.19 (unix:unix-close (fd-stream-fd stream))
986 wlott 1.5 (when (fd-stream-obuf-sap stream)
987     (push (fd-stream-obuf-sap stream) *available-buffers*)
988     (setf (fd-stream-obuf-sap stream) nil))
989     (when (fd-stream-ibuf-sap stream)
990     (push (fd-stream-ibuf-sap stream) *available-buffers*)
991     (setf (fd-stream-ibuf-sap stream) nil))
992 ram 1.1 (lisp::set-closed-flame stream))
993 wlott 1.6 (:clear-input
994 wlott 1.25 (setf (fd-stream-unread stream) nil)
995 wlott 1.6 (setf (fd-stream-ibuf-head stream) 0)
996     (setf (fd-stream-ibuf-tail stream) 0)
997 ram 1.38 (catch 'eof-input-catcher
998     (loop
999 pw 1.40.2.3 (multiple-value-bind
1000     (count errno)
1001     (alien:with-alien ((read-fds (alien:struct unix:fd-set)))
1002     (unix:fd-zero read-fds)
1003     (unix:fd-set (fd-stream-fd stream) read-fds)
1004     (unix:unix-fast-select (1+ (fd-stream-fd stream))
1005     (alien:addr read-fds) nil nil 0 0))
1006 ram 1.38 (cond ((eql count 1)
1007     (do-input stream)
1008     (setf (fd-stream-ibuf-head stream) 0)
1009     (setf (fd-stream-ibuf-tail stream) 0))
1010 pw 1.40.2.3 ((and (not count) (eql errno unix:eintr)))
1011 ram 1.38 (t
1012     (return t)))))))
1013 ram 1.1 (:force-output
1014     (flush-output-buffer stream))
1015     (:finish-output
1016     (flush-output-buffer stream)
1017     (do ()
1018     ((null (fd-stream-output-later stream)))
1019     (system:serve-all-events)))
1020     (:element-type
1021     (fd-stream-element-type stream))
1022 ram 1.22 (:interactive-p
1023     (unix:unix-isatty (fd-stream-fd stream)))
1024 ram 1.1 (:line-length
1025     80)
1026     (:charpos
1027     (fd-stream-char-pos stream))
1028     (:file-length
1029 pw 1.40.2.8 (unless (fd-stream-file stream)
1030     (error 'simple-type-error
1031     :datum stream
1032     :expected-type 'file-stream
1033     :format-control "~s is not a stream associated with a file."
1034     :format-arguments (list stream)))
1035 ram 1.1 (multiple-value-bind
1036     (okay dev ino mode nlink uid gid rdev size
1037     atime mtime ctime blksize blocks)
1038 wlott 1.19 (unix:unix-fstat (fd-stream-fd stream))
1039 ram 1.1 (declare (ignore ino nlink uid gid rdev
1040     atime mtime ctime blksize blocks))
1041     (unless okay
1042     (error "Error fstating ~S: ~A"
1043     stream
1044 wlott 1.19 (unix:get-unix-error-msg dev)))
1045 dtc 1.40.2.4 (if (zerop mode)
1046 ram 1.23 nil
1047 dtc 1.40.2.4 (truncate size (fd-stream-element-size stream)))))
1048 ram 1.1 (:file-position
1049 ram 1.29 (fd-stream-file-position stream arg1))))
1050 ram 1.1
1051 ram 1.28
1052 ram 1.1 ;;; FD-STREAM-FILE-POSITION -- internal.
1053     ;;;
1054     (defun fd-stream-file-position (stream &optional newpos)
1055 ram 1.14 (declare (type fd-stream stream)
1056 dtc 1.40.2.4 (type (or (integer 0) (member nil :start :end)) newpos))
1057 ram 1.1 (if (null newpos)
1058     (system:without-interrupts
1059 dtc 1.40.2.4 ;; First, find the position of the UNIX file descriptor in the file.
1060 ram 1.1 (multiple-value-bind
1061 dtc 1.40.2.4 (posn errno)
1062 wlott 1.19 (unix:unix-lseek (fd-stream-fd stream) 0 unix:l_incr)
1063 dtc 1.40.2.4 (declare (type (or (integer 0) null) posn))
1064     (cond (posn
1065 ram 1.1 ;; Adjust for buffered output:
1066     ;; If there is any output buffered, the *real* file position
1067     ;; will be larger than reported by lseek because lseek
1068 ram 1.28 ;; obviously cannot take< into account output we have not
1069 ram 1.1 ;; sent yet.
1070     (dolist (later (fd-stream-output-later stream))
1071 ram 1.14 (incf posn (- (the index (caddr later))
1072     (the index (cadr later)))))
1073 ram 1.1 (incf posn (fd-stream-obuf-tail stream))
1074     ;; Adjust for unread input:
1075     ;; If there is any input read from UNIX but not supplied to
1076     ;; the user of the stream, the *real* file position will
1077     ;; smaller than reported, because we want to look like the
1078     ;; unread stuff is still available.
1079     (decf posn (- (fd-stream-ibuf-tail stream)
1080     (fd-stream-ibuf-head stream)))
1081     (when (fd-stream-unread stream)
1082     (decf posn))
1083     ;; Divide bytes by element size.
1084 ram 1.14 (truncate posn (fd-stream-element-size stream)))
1085 wlott 1.19 ((eq errno unix:espipe)
1086 ram 1.1 nil)
1087     (t
1088     (system:with-interrupts
1089     (error "Error lseek'ing ~S: ~A"
1090     stream
1091 wlott 1.19 (unix:get-unix-error-msg errno)))))))
1092 dtc 1.40.2.4 (let ((offset 0)
1093     origin)
1094     (declare (type (integer 0) offset))
1095 ram 1.1 ;; Make sure we don't have any output pending, because if we move the
1096     ;; file pointer before writing this stuff, it will be written in the
1097     ;; wrong location.
1098     (flush-output-buffer stream)
1099     (do ()
1100     ((null (fd-stream-output-later stream)))
1101     (system:serve-all-events))
1102 ram 1.4 ;; Clear out any pending input to force the next read to go to the
1103     ;; disk.
1104     (setf (fd-stream-unread stream) nil)
1105     (setf (fd-stream-ibuf-head stream) 0)
1106     (setf (fd-stream-ibuf-tail stream) 0)
1107 dtc 1.40.2.4 ;; Trash cached value for listen, so that we check next time.
1108 wlott 1.5 (setf (fd-stream-listen stream) nil)
1109 ram 1.4 ;; Now move it.
1110 ram 1.1 (cond ((eq newpos :start)
1111 dtc 1.40.2.4 (setf offset 0
1112     origin unix:l_set))
1113 ram 1.1 ((eq newpos :end)
1114 dtc 1.40.2.4 (setf offset 0
1115     origin unix:l_xtnd))
1116     ((typep newpos '(integer 0))
1117 ram 1.1 (setf offset (* newpos (fd-stream-element-size stream))
1118 wlott 1.19 origin unix:l_set))
1119 ram 1.1 (t
1120     (error "Invalid position given to file-position: ~S" newpos)))
1121     (multiple-value-bind
1122     (posn errno)
1123 wlott 1.19 (unix:unix-lseek (fd-stream-fd stream) offset origin)
1124 dtc 1.40.2.4 (cond (posn
1125 ram 1.1 t)
1126 wlott 1.19 ((eq errno unix:espipe)
1127 ram 1.1 nil)
1128     (t
1129     (error "Error lseek'ing ~S: ~A"
1130     stream
1131 wlott 1.19 (unix:get-unix-error-msg errno))))))))
1132 ram 1.1
1133    
1134    
1135     ;;;; Creation routines (MAKE-FD-STREAM and OPEN)
1136    
1137     ;;; MAKE-FD-STREAM -- Public.
1138     ;;;
1139     ;;; Returns a FD-STREAM on the given file.
1140     ;;;
1141     (defun make-fd-stream (fd
1142     &key
1143     (input nil input-p)
1144     (output nil output-p)
1145 wlott 1.16 (element-type 'base-char)
1146 ram 1.1 (buffering :full)
1147 ram 1.15 timeout
1148 ram 1.1 file
1149     original
1150     delete-original
1151 ram 1.28 pathname
1152 ram 1.24 input-buffer-p
1153 ram 1.1 (name (if file
1154     (format nil "file ~S" file)
1155 wlott 1.17 (format nil "descriptor ~D" fd)))
1156     auto-close)
1157 ram 1.15 (declare (type index fd) (type (or index null) timeout)
1158     (type (member :none :line :full) buffering))
1159     "Create a stream for the given unix file descriptor.
1160     If input is non-nil, allow input operations.
1161     If output is non-nil, allow output operations.
1162     If neither input nor output are specified, default to allowing input.
1163     Element-type indicates the element type to use (as for open).
1164     Buffering indicates the kind of buffering to use.
1165     Timeout (if true) is the number of seconds to wait for input. If NIL (the
1166     default), then wait forever. When we time out, we signal IO-TIMEOUT.
1167     File is the name of the file (will be returned by PATHNAME).
1168     Name is used to identify the stream when printed."
1169 ram 1.1 (cond ((not (or input-p output-p))
1170     (setf input t))
1171     ((not (or input output))
1172     (error "File descriptor must be opened either for input or output.")))
1173     (let ((stream (%make-fd-stream :fd fd
1174     :name name
1175     :file file
1176     :original original
1177     :delete-original delete-original
1178 ram 1.28 :pathname pathname
1179 ram 1.15 :buffering buffering
1180     :timeout timeout)))
1181 ram 1.24 (set-routines stream element-type input output input-buffer-p)
1182 wlott 1.17 (when (and auto-close (fboundp 'finalize))
1183     (finalize stream
1184     #'(lambda ()
1185 wlott 1.19 (unix:unix-close fd)
1186 wlott 1.17 (format *terminal-io* "** Closed file descriptor ~D~%"
1187     fd))))
1188 ram 1.1 stream))
1189    
1190 ram 1.24
1191 ram 1.1 ;;; PICK-PACKUP-NAME -- internal
1192     ;;;
1193     ;;; Pick a name to use for the backup file.
1194     ;;;
1195     (defvar *backup-extension* ".BAK"
1196     "This is a string that OPEN tacks on the end of a file namestring to produce
1197     a name for the :if-exists :rename-and-delete and :rename options. Also,
1198     this can be a function that takes a namestring and returns a complete
1199     namestring.")
1200     ;;;
1201     (defun pick-backup-name (name)
1202 ram 1.14 (declare (type simple-string name))
1203     (let ((ext *backup-extension*))
1204     (etypecase ext
1205     (simple-string (concatenate 'simple-string name ext))
1206     (function (funcall ext name)))))
1207 ram 1.1
1208     ;;; ASSURE-ONE-OF -- internal
1209     ;;;
1210     ;;; Assure that the given arg is one of the given list of valid things.
1211     ;;; Allow the user to fix any problems.
1212     ;;;
1213     (defun assure-one-of (item list what)
1214     (unless (member item list)
1215     (loop
1216     (cerror "Enter new value for ~*~S"
1217     "~S is invalid for ~S. Must be one of~{ ~S~}"
1218     item
1219     what
1220     list)
1221 ram 1.14 (format (the stream *query-io*) "Enter new value for ~S: " what)
1222 ram 1.1 (force-output *query-io*)
1223     (setf item (read *query-io*))
1224     (when (member item list)
1225     (return))))
1226     item)
1227    
1228 ram 1.14 ;;; DO-OLD-RENAME -- Internal
1229     ;;;
1230     ;;; Rename Namestring to Original. First, check if we have write access,
1231     ;;; since we don't want to trash unwritable files even if we technically can.
1232     ;;; We return true if we suceed in renaming.
1233     ;;;
1234     (defun do-old-rename (namestring original)
1235 wlott 1.19 (unless (unix:unix-access namestring unix:w_ok)
1236 ram 1.14 (cerror "Try to rename it anyway." "File ~S is not writable." namestring))
1237     (multiple-value-bind
1238     (okay err)
1239 wlott 1.19 (unix:unix-rename namestring original)
1240 ram 1.14 (cond (okay t)
1241     (t
1242     (cerror "Use :SUPERSEDE instead."
1243     "Could not rename ~S to ~S: ~A."
1244     namestring
1245     original
1246 wlott 1.19 (unix:get-unix-error-msg err))
1247 ram 1.14 nil))))
1248    
1249 pw 1.40.2.8 ;;; RETURN-STREAM -- internal
1250     ;;;
1251     ;;; (this is just to save having to reindent the code in OPEN...move it there)
1252     ;;;
1253     (defmacro return-stream (class &body body)
1254     (let ((stream (gensym)))
1255     `(let ((,stream (progn ,@body)))
1256     (return (if ,class
1257     (make-instance ,class :lisp-stream ,stream)
1258     ,stream)))))
1259 ram 1.14
1260 ram 1.1 ;;; OPEN -- public
1261     ;;;
1262     ;;; Open the given file.
1263     ;;;
1264     (defun open (filename
1265     &key
1266     (direction :input)
1267 wlott 1.16 (element-type 'base-char)
1268 ram 1.1 (if-exists nil if-exists-given)
1269 ram 1.27 (if-does-not-exist nil if-does-not-exist-given)
1270 ram 1.35 (external-format :default)
1271 pw 1.40.2.8 class
1272 ram 1.35 &aux ; Squelch assignment warning.
1273     (direction direction)
1274     (if-does-not-exist if-does-not-exist)
1275     (if-exists if-exists))
1276 ram 1.1 "Return a stream which reads from or writes to Filename.
1277     Defined keywords:
1278     :direction - one of :input, :output, :io, or :probe
1279 wlott 1.16 :element-type - Type of object to read or write, default BASE-CHAR
1280 ram 1.1 :if-exists - one of :error, :new-version, :rename, :rename-and-delete,
1281     :overwrite, :append, :supersede or nil
1282     :if-does-not-exist - one of :error, :create or nil
1283     See the manual for details."
1284 ram 1.34 (declare (ignore external-format))
1285 pw 1.40.2.3
1286 ram 1.1 ;; First, make sure that DIRECTION is valid. Allow it to be changed if not.
1287     (setf direction
1288     (assure-one-of direction
1289     '(:input :output :io :probe)
1290     :direction))
1291    
1292     ;; Calculate useful stuff.
1293     (multiple-value-bind
1294     (input output mask)
1295     (case direction
1296 wlott 1.19 (:input (values t nil unix:o_rdonly))
1297     (:output (values nil t unix:o_wronly))
1298     (:io (values t t unix:o_rdwr))
1299     (:probe (values t nil unix:o_rdonly)))
1300 ram 1.14 (declare (type index mask))
1301 ram 1.1 (let* ((pathname (pathname filename))
1302 ram 1.34 (namestring
1303     (cond ((unix-namestring pathname input))
1304     ((and input (eq if-does-not-exist :create))
1305     (unix-namestring pathname nil)))))
1306 ram 1.1 ;; Process if-exists argument if we are doing any output.
1307     (cond (output
1308     (unless if-exists-given
1309     (setf if-exists
1310     (if (eq (pathname-version pathname) :newest)
1311 ram 1.34 :new-version
1312     :error)))
1313 ram 1.1 (setf if-exists
1314     (assure-one-of if-exists
1315     '(:error :new-version :rename
1316     :rename-and-delete :overwrite
1317     :append :supersede nil)
1318     :if-exists))
1319     (case if-exists
1320     ((:error nil)
1321 wlott 1.19 (setf mask (logior mask unix:o_excl)))
1322 ram 1.1 ((:rename :rename-and-delete)
1323 wlott 1.19 (setf mask (logior mask unix:o_creat)))
1324 ram 1.1 ((:new-version :supersede)
1325 wlott 1.19 (setf mask (logior mask unix:o_trunc)))
1326 ram 1.1 (:append
1327 wlott 1.19 (setf mask (logior mask unix:o_append)))))
1328 ram 1.1 (t
1329     (setf if-exists :ignore-this-arg)))
1330    
1331     (unless if-does-not-exist-given
1332     (setf if-does-not-exist
1333     (cond ((eq direction :input) :error)
1334     ((and output
1335     (member if-exists '(:overwrite :append)))
1336     :error)
1337     ((eq direction :probe)
1338     nil)
1339     (t
1340     :create))))
1341     (setf if-does-not-exist
1342     (assure-one-of if-does-not-exist
1343     '(:error :create nil)
1344     :if-does-not-exist))
1345     (if (eq if-does-not-exist :create)
1346 wlott 1.19 (setf mask (logior mask unix:o_creat)))
1347 ram 1.1
1348     (let ((original (if (member if-exists
1349     '(:rename :rename-and-delete))
1350 ram 1.14 (pick-backup-name namestring)))
1351 ram 1.1 (delete-original (eq if-exists :rename-and-delete))
1352     (mode #o666))
1353     (when original
1354     ;; We are doing a :rename or :rename-and-delete.
1355     ;; Determine if the file already exists, make sure the original
1356     ;; file is not a directory and keep the mode
1357     (let ((exists
1358 wlott 1.18 (and namestring
1359     (multiple-value-bind
1360     (okay err/dev inode orig-mode)
1361 wlott 1.19 (unix:unix-stat namestring)
1362 wlott 1.18 (declare (ignore inode)
1363     (type (or index null) orig-mode))
1364     (cond
1365     (okay
1366 ram 1.1 (when (and output (= (logand orig-mode #o170000)
1367     #o40000))
1368     (error "Cannot open ~S for output: Is a directory."
1369     namestring))
1370     (setf mode (logand orig-mode #o777))
1371     t)
1372 wlott 1.19 ((eql err/dev unix:enoent)
1373 ram 1.1 nil)
1374     (t
1375     (error "Cannot find ~S: ~A"
1376     namestring
1377 wlott 1.19 (unix:get-unix-error-msg err/dev))))))))
1378 ram 1.14 (unless (and exists
1379     (do-old-rename namestring original))
1380 ram 1.1 (setf original nil)
1381     (setf delete-original nil)
1382     ;; In order to use SUPERSEDE instead, we have
1383 wlott 1.19 ;; to make sure unix:o_creat corresponds to
1384     ;; if-does-not-exist. unix:o_creat was set
1385 ram 1.1 ;; before because of if-exists being :rename.
1386     (unless (eq if-does-not-exist :create)
1387 wlott 1.19 (setf mask (logior (logandc2 mask unix:o_creat) unix:o_trunc)))
1388 ram 1.1 (setf if-exists :supersede))))
1389    
1390     ;; Okay, now we can try the actual open.
1391 wlott 1.9 (loop
1392     (multiple-value-bind
1393     (fd errno)
1394 wlott 1.18 (if namestring
1395 wlott 1.19 (unix:unix-open namestring mask mode)
1396     (values nil unix:enoent))
1397 wlott 1.9 (cond ((numberp fd)
1398 pw 1.40.2.8 (return-stream class
1399 wlott 1.9 (case direction
1400     ((:input :output :io)
1401     (make-fd-stream fd
1402     :input input
1403     :output output
1404     :element-type element-type
1405     :file namestring
1406     :original original
1407 wlott 1.17 :delete-original delete-original
1408 ram 1.28 :pathname pathname
1409 ram 1.24 :input-buffer-p t
1410 wlott 1.17 :auto-close t))
1411 wlott 1.9 (:probe
1412     (let ((stream
1413     (%make-fd-stream :name namestring :fd fd
1414 ram 1.28 :pathname pathname
1415 wlott 1.9 :element-type element-type)))
1416     (close stream)
1417     stream)))))
1418 wlott 1.19 ((eql errno unix:enoent)
1419 wlott 1.9 (case if-does-not-exist
1420     (:error
1421     (cerror "Return NIL."
1422 dtc 1.40.2.2 'simple-file-error
1423     :pathname pathname
1424     :format-control "Error opening ~S, ~A."
1425     :format-arguments
1426     (list pathname (unix:get-unix-error-msg errno))))
1427 wlott 1.9 (:create
1428     (cerror "Return NIL."
1429     "Error creating ~S, path does not exist."
1430     pathname)))
1431     (return nil))
1432 wlott 1.19 ((eql errno unix:eexist)
1433 wlott 1.9 (unless (eq nil if-exists)
1434     (cerror "Return NIL."
1435 dtc 1.40.2.2 'simple-file-error
1436     :pathname pathname
1437     :format-control "Error opening ~S, ~A."
1438     :format-arguments
1439     (list pathname (unix:get-unix-error-msg errno))))
1440 wlott 1.9 (return nil))
1441 wlott 1.19 ((eql errno unix:eacces)
1442 wlott 1.9 (cerror "Try again."
1443     "Error opening ~S, ~A."
1444     pathname
1445 wlott 1.19 (unix:get-unix-error-msg errno)))
1446 wlott 1.9 (t
1447 ram 1.1 (cerror "Return NIL."
1448     "Error opening ~S, ~A."
1449     pathname
1450 wlott 1.19 (unix:get-unix-error-msg errno))
1451 wlott 1.9 (return nil)))))))))
1452 ram 1.1
1453     ;;;; Initialization.
1454    
1455     (defvar *tty* nil
1456     "The stream connected to the controlling terminal or NIL if there is none.")
1457     (defvar *stdin* nil
1458     "The stream connected to the standard input (file descriptor 0).")
1459     (defvar *stdout* nil
1460     "The stream connected to the standard output (file descriptor 1).")
1461     (defvar *stderr* nil
1462     "The stream connected to the standard error output (file descriptor 2).")
1463    
1464     ;;; STREAM-INIT -- internal interface
1465     ;;;
1466     ;;; Called when the cold load is first started up.
1467     ;;;
1468     (defun stream-init ()
1469     (stream-reinit)
1470     (setf *terminal-io* (make-synonym-stream '*tty*))
1471     (setf *standard-output* (make-synonym-stream '*stdout*))
1472 ram 1.11 (setf *standard-input*
1473     (make-two-way-stream (make-synonym-stream '*stdin*)
1474     *standard-output*))
1475 ram 1.1 (setf *error-output* (make-synonym-stream '*stderr*))
1476     (setf *query-io* (make-synonym-stream '*terminal-io*))
1477 pw 1.40.2.6 (setf *debug-io* *query-io*)
1478 ram 1.1 (setf *trace-output* *standard-output*)
1479     nil)
1480    
1481     ;;; STREAM-REINIT -- internal interface
1482     ;;;
1483     ;;; Called whenever a saved core is restarted.
1484     ;;;
1485     (defun stream-reinit ()
1486     (setf *available-buffers* nil)
1487     (setf *stdin*
1488     (make-fd-stream 0 :name "Standard Input" :input t :buffering :line))
1489     (setf *stdout*
1490     (make-fd-stream 1 :name "Standard Output" :output t :buffering :line))
1491     (setf *stderr*
1492     (make-fd-stream 2 :name "Standard Error" :output t :buffering :line))
1493 dtc 1.40.2.7 (let ((tty (and (not *batch-mode*)
1494     (unix:unix-open "/dev/tty" unix:o_rdwr #o666))))
1495     (setf *tty*
1496     (if tty
1497 ram 1.1 (make-fd-stream tty :name "the Terminal" :input t :output t
1498 dtc 1.40.2.7 :buffering :line :auto-close t)
1499     (make-two-way-stream *stdin* *stdout*))))
1500 ram 1.1 nil)
1501    
1502    
1503     ;;;; Beeping.
1504    
1505     (defun default-beep-function (stream)
1506     (write-char #\bell stream)
1507     (finish-output stream))
1508    
1509     (defvar *beep-function* #'default-beep-function
1510     "This is called in BEEP to feep the user. It takes a stream.")
1511    
1512     (defun beep (&optional (stream *terminal-io*))
1513     (funcall *beep-function* stream))
1514    
1515    
1516     ;;; File-Name -- internal interface
1517     ;;;
1518     ;;; Kind of like File-Position, but is an internal hack used by the filesys
1519     ;;; stuff to get and set the file name.
1520     ;;;
1521     (defun file-name (stream &optional new-name)
1522 ram 1.29 (when (typep stream 'fd-stream)
1523 ram 1.30 (cond (new-name
1524     (setf (fd-stream-pathname stream) new-name)
1525     (setf (fd-stream-file stream)
1526     (unix-namestring new-name nil))
1527 ram 1.29 t)
1528     (t
1529     (fd-stream-pathname stream)))))
1530    
1531 ram 1.27
1532     ;;;; Degenerate international character support:
1533    
1534     (defun file-string-length (stream object)
1535     (declare (type (or string character) object) (type file-stream stream))
1536     "Return the delta in Stream's FILE-POSITION that would be caused by writing
1537     Object to Stream. Non-trivial only in implementations that support
1538     international character sets."
1539 ram 1.28 (declare (ignore stream))
1540 ram 1.27 (etypecase object
1541     (character 1)
1542     (string (length object))))
1543    
1544     (defun stream-external-format (stream)
1545 ram 1.28 (declare (type file-stream stream) (ignore stream))
1546 ram 1.27 "Returns :DEFAULT."
1547     :default)

  ViewVC Help
Powered by ViewVC 1.1.5