/[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.97 - (hide annotations)
Mon Jan 25 13:58:01 2010 UTC (4 years, 2 months ago) by rtoy
Branch: MAIN
CVS Tags: intl-2-branch-base, pre-merge-intl-branch, snapshot-2010-03, snapshot-2010-02, intl-branch-base
Branch point for: intl-branch, intl-2-branch
Changes since 1.96: +6 -6 lines
STRING-ENCODE has start and end indices.  Use them instead of consing
up another string.
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 rtoy 1.97 "$Header: /tiger/var/lib/cvsroots/cmucl/src/code/fd-stream.lisp,v 1.97 2010/01/25 13:58:01 rtoy 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 rtoy 1.83 *tty* *stdin* *stdout* *stderr*
25     binary-text-stream))
26 ram 1.1
27    
28     (in-package "EXTENSIONS")
29    
30     (export '(*backup-extension*))
31    
32    
33     (in-package "LISP")
34    
35 toy 1.66 (export '(file-stream file-string-length))
36 ram 1.22
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 rtoy 1.92 (defvar lisp::*enable-stream-buffer-p* nil)
45    
46 ram 1.1 (defconstant bytes-per-buffer (* 4 1024)
47     "Number of bytes per buffer.")
48    
49 rtoy 1.79 ;; This limit is rather arbitrary
50     (defconstant max-stream-element-size 1024
51     "The maximum supported byte size for a stream element-type.")
52    
53 ram 1.1 ;;; NEXT-AVAILABLE-BUFFER -- Internal.
54     ;;;
55 ram 1.12 ;;; Returns the next available buffer, creating one if necessary.
56 ram 1.1 ;;;
57 pw 1.55 (declaim (inline next-available-buffer))
58 ram 1.1 ;;;
59     (defun next-available-buffer ()
60     (if *available-buffers*
61     (pop *available-buffers*)
62 wlott 1.5 (allocate-system-memory bytes-per-buffer)))
63 ram 1.1
64 rtoy 1.85 (declaim (inline buffer-sap bref (setf bref) buffer-copy))
65    
66     (defun buffer-sap (thing &optional offset)
67     (declare (type simple-stream-buffer thing) (type (or fixnum null) offset)
68     (optimize (speed 3) (space 2) (debug 0) (safety 0)
69     ;; Suppress the note about having to box up the return:
70     (ext:inhibit-warnings 3)))
71     (let ((sap (if (vectorp thing) (sys:vector-sap thing) thing)))
72     (if offset (sys:sap+ sap offset) sap)))
73    
74     (defun bref (buffer index)
75     (declare (type simple-stream-buffer buffer)
76     (type (integer 0 #.most-positive-fixnum) index))
77     (sys:sap-ref-8 (buffer-sap buffer) index))
78    
79     (defun (setf bref) (octet buffer index)
80     (declare (type (unsigned-byte 8) octet)
81     (type simple-stream-buffer buffer)
82     (type (integer 0 #.most-positive-fixnum) index))
83     (setf (sys:sap-ref-8 (buffer-sap buffer) index) octet))
84    
85     (defun buffer-copy (src soff dst doff length)
86     (declare (type simple-stream-buffer src dst)
87     (type fixnum soff doff length))
88     (sys:without-gcing ;; is this necessary??
89     (kernel:system-area-copy (buffer-sap src) (* soff 8)
90     (buffer-sap dst) (* doff 8)
91     (* length 8))))
92    
93     #-(or big-endian little-endian)
94     (eval-when (:compile-toplevel)
95     (push (c::backend-byte-order c::*target-backend*) *features*))
96    
97     (defun vector-elt-width (vector)
98     ;; Return octet-width of vector elements
99     (etypecase vector
100     ;; (simple-array fixnum (*)) not supported
101     ;; (simple-array base-char (*)) treated specially; don't call this
102 rtoy 1.86 ((simple-array bit (*)) 1/8)
103     ((simple-array (unsigned-byte 2) (*)) 1/4)
104     ((simple-array (unsigned-byte 4) (*)) 1/2)
105 rtoy 1.85 ((simple-array (signed-byte 8) (*)) 1)
106     ((simple-array (unsigned-byte 8) (*)) 1)
107     ((simple-array (signed-byte 16) (*)) 2)
108     ((simple-array (unsigned-byte 16) (*)) 2)
109     ((simple-array (signed-byte 32) (*)) 4)
110     ((simple-array (unsigned-byte 32) (*)) 4)
111     ((simple-array single-float (*)) 4)
112     ((simple-array double-float (*)) 8)
113     ((simple-array (complex single-float) (*)) 8)
114     ((simple-array (complex double-float) (*)) 16)
115     #+long-float
116     ((simple-array long-float (*)) 10)
117     #+long-float
118     ((simple-array (complex long-float) (*)) 20)
119     #+double-double
120     ((simple-array double-double-float (*)) 16)
121     #+double-double
122     ((simple-array (complex double-double-float) (*)) 32)))
123    
124     (defun endian-swap-value (vector endian-swap)
125     (case endian-swap
126 rtoy 1.86 (:network-order
127     #+big-endian 0
128     ;; This is needed because the little-endian (x86) architectures
129     ;; store the lowest indexed element in the least significant part
130     ;; of a byte. On a big-endian machine (sparc, ppc), the lowest
131     ;; indexed element is at the most significant part of a byte.
132     #+little-endian
133     (typecase vector
134     ((array (unsigned-byte 4) (*))
135     -1)
136     ((array (unsigned-byte 2) (*))
137     -2)
138     ((array (unsigned-byte 1) (*))
139     -8)
140     (t
141     (1- (vector-elt-width vector)))))
142 rtoy 1.85 (:byte-8 0)
143     (:byte-16 1)
144     (:byte-32 3)
145     (:byte-64 7)
146     (:byte-128 15)
147     ;; additions by Lynn Quam
148     (:machine-endian 0)
149 rtoy 1.86 (:big-endian
150     #+big-endian 0
151     #+little-endian
152     (typecase vector
153     ((array (unsigned-byte 4) (*))
154     -1)
155     ((array (unsigned-byte 2) (*))
156     -2)
157     ((array (unsigned-byte 1) (*))
158     -8)
159     (t
160     (1- (vector-elt-width vector)))))
161     (:little-endian
162     #+big-endian
163     (typecase vector
164     ((array (unsigned-byte 4) (*))
165     -1)
166     ((array (unsigned-byte 2) (*))
167     -2)
168     ((array (unsigned-byte 1) (*))
169     -8)
170     (t
171     (1- (vector-elt-width vector))))
172     #+little-endian 0)
173 rtoy 1.85 (otherwise endian-swap)))
174    
175 ram 1.1
176     ;;;; The FD-STREAM structure.
177    
178 moore 1.62 ;;;; Superclass defined by the ANSI Spec
179     (defstruct (file-stream
180     (:include lisp-stream)
181     (:constructor nil)
182     (:copier nil)))
183    
184 ram 1.1 (defstruct (fd-stream
185     (:print-function %print-fd-stream)
186     (:constructor %make-fd-stream)
187 moore 1.62 (:include file-stream
188 ram 1.1 (misc #'fd-stream-misc-routine)))
189    
190     (name nil) ; The name of this stream
191     (file nil) ; The file this stream is for
192 ram 1.28 ;;
193     ;; The backup file namestring for the old file, for :if-exists :rename or
194     ;; :rename-and-delete.
195     (original nil :type (or simple-string null))
196 ram 1.1 (delete-original nil) ; for :if-exists :rename-and-delete
197 ram 1.14 ;;
198     ;;; Number of bytes per element.
199     (element-size 1 :type index)
200 wlott 1.16 (element-type 'base-char) ; The type of element being transfered.
201 ram 1.1 (fd -1 :type fixnum) ; The file descriptor
202 ram 1.14 ;;
203     ;; Controls when the output buffer is flushed.
204     (buffering :full :type (member :full :line :none))
205     ;;
206     ;; Character position if known.
207     (char-pos nil :type (or index null))
208     ;;
209     ;; T if input is waiting on FD. :EOF if we hit EOF.
210     (listen nil :type (member nil t :eof))
211     ;;
212 ram 1.1 ;; The input buffer.
213     (unread nil)
214 ram 1.14 (ibuf-sap nil :type (or system-area-pointer null))
215     (ibuf-length nil :type (or index null))
216     (ibuf-head 0 :type index)
217     (ibuf-tail 0 :type index)
218 ram 1.1
219     ;; The output buffer.
220 ram 1.14 (obuf-sap nil :type (or system-area-pointer null))
221     (obuf-length nil :type (or index null))
222     (obuf-tail 0 :type index)
223 ram 1.1
224     ;; Output flushed, but not written due to non-blocking io.
225     (output-later nil)
226 ram 1.15 (handler nil)
227     ;;
228     ;; Timeout specified for this stream, or NIL if none.
229 ram 1.28 (timeout nil :type (or index null))
230     ;;
231     ;; Pathname of the file this stream is opened to (returned by PATHNAME.)
232 rtoy 1.86 (pathname nil :type (or pathname null))
233     ;;
234     ;; External format support
235     ;;
236     ;; @@ I want to use :default here, but keyword pkg isn't set up yet at boot
237     ;; so initialize to NIL and fix it in SET-ROUTINES
238     #+unicode
239     (external-format nil :type (or null keyword cons))
240 rtoy 1.90 ;;
241     ;; State for octets-to-char (for reading from a stream). The
242     ;; contents of the state can be anything and is defined by the
243     ;; external format.
244 rtoy 1.86 #+unicode
245     (oc-state nil)
246 rtoy 1.90 ;;
247     ;; State for char-to-octets (for writing to a stream). The contents
248     ;; of the state can be anything and is defined by the external
249     ;; format. If not NIL, then the CAR is used by char-to-octets to
250     ;; hold some state information, and the CDR is available to the
251     ;; external format to hold whatever state information is needed.
252 rtoy 1.86 #+unicode
253     (co-state nil)
254     #+unicode
255 rtoy 1.92 (last-char-read-size 0 :type index)
256     ;; Saved state needed for (setf stream-external-format) when the
257     ;; fast string-buffer is used.
258     #+unicode
259     (saved-oc-state nil)
260     ;;
261     ;; The number of octets in in-buffer. Normally equal to
262     ;; in-buffer-length, but could be less if we reached the
263     ;; end-of-file.
264     #+unicode
265     (in-length 0 :type index))
266 ram 1.1
267     (defun %print-fd-stream (fd-stream stream depth)
268 ram 1.14 (declare (ignore depth) (stream stream))
269 ram 1.1 (format stream "#<Stream for ~A>"
270     (fd-stream-name fd-stream)))
271    
272 rtoy 1.83 ;; CMUCL extension. This is a FD-STREAM, but it allows reading and
273     ;; writing of 8-bit characters and unsigned bytes from the stream.
274     (defstruct (binary-text-stream
275     (:print-function %print-binary-text-stream)
276     (:constructor %make-binary-text-stream)
277     (:include fd-stream)))
278    
279     (defun %print-binary-text-stream (fd-stream stream depth)
280     (declare (ignore depth) (stream stream))
281     (format stream "#<Binary-text Stream for ~A>"
282     (fd-stream-name fd-stream)))
283 ram 1.1
284 ram 1.31 (define-condition io-timeout (stream-error)
285     ((direction :reader io-timeout-direction :initarg :direction))
286 ram 1.15 (:report
287     (lambda (condition stream)
288 ram 1.23 (declare (stream stream))
289 ram 1.15 (format stream "Timeout ~(~A~)ing ~S."
290     (io-timeout-direction condition)
291     (stream-error-stream condition)))))
292    
293 ram 1.1
294     ;;;; Output routines and related noise.
295    
296     (defvar *output-routines* ()
297     "List of all available output routines. Each element is a list of the
298     element-type output, the kind of buffering, the function name, and the number
299     of bytes per element.")
300    
301     ;;; DO-OUTPUT-LATER -- internal
302     ;;;
303     ;;; Called by the server when we can write to the given file descriptor.
304 toy 1.67 ;;; Attempt to write the data again. If it worked, remove the data from the
305 ram 1.1 ;;; output-later list. If it didn't work, something is wrong.
306     ;;;
307     (defun do-output-later (stream)
308     (let* ((stuff (pop (fd-stream-output-later stream)))
309     (base (car stuff))
310     (start (cadr stuff))
311     (end (caddr stuff))
312 wlott 1.5 (reuse-sap (cadddr stuff))
313 ram 1.1 (length (- end start)))
314 ram 1.14 (declare (type index start end length))
315 ram 1.1 (multiple-value-bind
316     (count errno)
317 wlott 1.19 (unix:unix-write (fd-stream-fd stream)
318 ram 1.1 base
319     start
320     length)
321 ram 1.14 (cond ((not count)
322 wlott 1.19 (if (= errno unix:ewouldblock)
323 ram 1.14 (error "Write would have blocked, but SERVER told us to go.")
324     (error "While writing ~S: ~A"
325 wlott 1.19 stream (unix:get-unix-error-msg errno))))
326 toy 1.67 ((eql count length) ; Hot damn, it worked.
327 wlott 1.5 (when reuse-sap
328     (push base *available-buffers*)))
329 ram 1.1 ((not (null count)) ; Sorta worked.
330     (push (list base
331 ram 1.23 (the index (+ start count))
332 wlott 1.5 end)
333 ram 1.14 (fd-stream-output-later stream))))))
334 ram 1.1 (unless (fd-stream-output-later stream)
335     (system:remove-fd-handler (fd-stream-handler stream))
336     (setf (fd-stream-handler stream) nil)))
337    
338     ;;; OUTPUT-LATER -- internal
339     ;;;
340 toy 1.67 ;;; Arrange to output the string when we can write on the file descriptor.
341 ram 1.1 ;;;
342 wlott 1.5 (defun output-later (stream base start end reuse-sap)
343 ram 1.1 (cond ((null (fd-stream-output-later stream))
344     (setf (fd-stream-output-later stream)
345 wlott 1.5 (list (list base start end reuse-sap)))
346 ram 1.1 (setf (fd-stream-handler stream)
347     (system:add-fd-handler (fd-stream-fd stream)
348     :output
349     #'(lambda (fd)
350     (declare (ignore fd))
351     (do-output-later stream)))))
352     (t
353     (nconc (fd-stream-output-later stream)
354 wlott 1.5 (list (list base start end reuse-sap)))))
355     (when reuse-sap
356 ram 1.1 (let ((new-buffer (next-available-buffer)))
357 wlott 1.5 (setf (fd-stream-obuf-sap stream) new-buffer)
358 ram 1.14 (setf (fd-stream-obuf-length stream) bytes-per-buffer))))
359 ram 1.1
360     ;;; DO-OUTPUT -- internal
361     ;;;
362     ;;; Output the given noise. Check to see if there are any pending writes. If
363     ;;; so, just queue this one. Otherwise, try to write it. If this would block,
364     ;;; queue it.
365     ;;;
366 wlott 1.5 (defun do-output (stream base start end reuse-sap)
367 ram 1.14 (declare (type fd-stream stream)
368     (type (or system-area-pointer (simple-array * (*))) base)
369     (type index start end))
370 ram 1.1 (if (not (null (fd-stream-output-later stream))) ; something buffered.
371 ram 1.14 (progn
372     (output-later stream base start end reuse-sap)
373     ;; ### check to see if any of this noise can be output
374     )
375     (let ((length (- end start)))
376     (multiple-value-bind
377 dtc 1.51 (count errno)
378 wlott 1.19 (unix:unix-write (fd-stream-fd stream) base start length)
379 ram 1.14 (cond ((not count)
380 wlott 1.19 (if (= errno unix:ewouldblock)
381 ram 1.14 (output-later stream base start end reuse-sap)
382 emarsden 1.75 (error 'simple-stream-error
383     :stream stream
384     :format-control "while writing: ~A"
385     :format-arguments (list (unix:get-unix-error-msg errno)))))
386 ram 1.14 ((not (eql count length))
387 ram 1.23 (output-later stream base (the index (+ start count))
388     end reuse-sap)))))))
389 ram 1.1
390 rtoy 1.90 #+unicode
391     (stream::def-ef-macro ef-flush (extfmt lisp stream::+ef-max+ stream::+ef-flush+)
392     `(lambda (stream)
393     (declare (type fd-stream stream))
394     (let* ((tail (fd-stream-obuf-tail stream)))
395     (declare (type index tail))
396     (cond
397 rtoy 1.91 ((stream::ef-flush-state ,(stream::find-external-format extfmt))
398 rtoy 1.90 (stream::flush-state ,extfmt
399     (fd-stream-co-state stream)
400     (lambda (byte)
401     (when (= tail len)
402     (do-output stream sap 0 tail t)
403     (setq sap (fd-stream-obuf-sap stream)
404     tail 0))
405     (setf (bref sap (1- (incf tail))) byte)))
406     (setf (fd-stream-obuf-tail stream) tail))
407     (t
408     ;; No flush-state function, so just output a replacement
409     ;; character. We hack the co-state to what we need for this
410     ;; to work. This should be ok because we're closing the
411     ;; file anyway.
412     (let ((state (fd-stream-co-state stream)))
413     (when (and state (car state))
414     (setf (fd-stream-co-state stream)
415     (cons nil (cdr state)))
416     (funcall (ef-cout (fd-stream-external-format stream))
417     stream (code-char stream::+replacement-character-code+))))))
418     (values))))
419    
420 ram 1.1 ;;; FLUSH-OUTPUT-BUFFER -- internal
421     ;;;
422     ;;; Flush any data in the output buffer.
423     ;;;
424     (defun flush-output-buffer (stream)
425     (let ((length (fd-stream-obuf-tail stream)))
426     (unless (= length 0)
427 wlott 1.5 (do-output stream (fd-stream-obuf-sap stream) 0 length t)
428 ram 1.1 (setf (fd-stream-obuf-tail stream) 0))))
429    
430     ;;; DEF-OUTPUT-ROUTINES -- internal
431     ;;;
432     ;;; Define output routines that output numbers size bytes long for the
433     ;;; given bufferings. Use body to do the actual output.
434     ;;;
435     (defmacro def-output-routines ((name size &rest bufferings) &body body)
436 ram 1.23 (declare (optimize (speed 1)))
437 ram 1.1 (cons 'progn
438     (mapcar
439     #'(lambda (buffering)
440     (let ((function
441     (intern (let ((*print-case* :upcase))
442     (format nil name (car buffering))))))
443     `(progn
444     (defun ,function (stream byte)
445     ,(unless (eq (car buffering) :none)
446     `(when (< (fd-stream-obuf-length stream)
447     (+ (fd-stream-obuf-tail stream)
448     ,size))
449     (flush-output-buffer stream)))
450 gerd 1.73 ;;
451     ;; If there is any input read from UNIX but not
452     ;; supplied to the user of the stream, reposition
453     ;; to the real file position as seen from Lisp.
454     ,(unless (eq (car buffering) :none)
455     `(when (> (fd-stream-ibuf-tail stream)
456     (fd-stream-ibuf-head stream))
457     (file-position stream (file-position stream))))
458 ram 1.1 ,@body
459     (incf (fd-stream-obuf-tail stream) ,size)
460     ,(ecase (car buffering)
461     (:none
462     `(flush-output-buffer stream))
463     (:line
464 rtoy 1.86 `(when (eql (char-code byte) (char-code #\Newline))
465 ram 1.1 (flush-output-buffer stream)))
466     (:full
467     ))
468     (values))
469     (setf *output-routines*
470     (nconc *output-routines*
471     ',(mapcar
472     #'(lambda (type)
473     (list type
474     (car buffering)
475     function
476     size))
477     (cdr buffering)))))))
478     bufferings)))
479    
480 rtoy 1.86 #-unicode
481 wlott 1.5 (def-output-routines ("OUTPUT-CHAR-~A-BUFFERED"
482     1
483 wlott 1.6 (:none character)
484     (:line character)
485     (:full character))
486 ram 1.37 (if (char= byte #\Newline)
487 wlott 1.5 (setf (fd-stream-char-pos stream) 0)
488     (incf (fd-stream-char-pos stream)))
489     (setf (sap-ref-8 (fd-stream-obuf-sap stream) (fd-stream-obuf-tail stream))
490     (char-code byte)))
491    
492 rtoy 1.86 #+unicode
493     (def-output-routines ("OUTPUT-CHAR-~A-BUFFERED"
494     1
495     (:none character)
496     (:line character)
497     (:full character))
498     (if (char= byte #\Newline)
499     (setf (fd-stream-char-pos stream) 0)
500     (incf (fd-stream-char-pos stream)))
501     ;; FIXME! We only use the low 8 bits of a character!
502     (setf (sap-ref-8 (fd-stream-obuf-sap stream) (fd-stream-obuf-tail stream))
503     (logand #xff (char-code byte))))
504    
505 ram 1.37 (def-output-routines ("OUTPUT-UNSIGNED-BYTE-~A-BUFFERED"
506 ram 1.1 1
507 ram 1.37 (:none (unsigned-byte 8))
508     (:full (unsigned-byte 8)))
509 wlott 1.5 (setf (sap-ref-8 (fd-stream-obuf-sap stream) (fd-stream-obuf-tail stream))
510     byte))
511 ram 1.1
512 ram 1.37 (def-output-routines ("OUTPUT-SIGNED-BYTE-~A-BUFFERED"
513     1
514     (:none (signed-byte 8))
515     (:full (signed-byte 8)))
516     (setf (signed-sap-ref-8 (fd-stream-obuf-sap stream)
517     (fd-stream-obuf-tail stream))
518     byte))
519    
520     (def-output-routines ("OUTPUT-UNSIGNED-SHORT-~A-BUFFERED"
521 ram 1.1 2
522 ram 1.37 (:none (unsigned-byte 16))
523     (:full (unsigned-byte 16)))
524 wlott 1.20 (setf (sap-ref-16 (fd-stream-obuf-sap stream) (fd-stream-obuf-tail stream))
525 wlott 1.5 byte))
526    
527 ram 1.37 (def-output-routines ("OUTPUT-SIGNED-SHORT-~A-BUFFERED"
528     2
529     (:none (signed-byte 16))
530     (:full (signed-byte 16)))
531     (setf (signed-sap-ref-16 (fd-stream-obuf-sap stream)
532     (fd-stream-obuf-tail stream))
533     byte))
534    
535     (def-output-routines ("OUTPUT-UNSIGNED-LONG-~A-BUFFERED"
536 ram 1.1 4
537 ram 1.37 (:none (unsigned-byte 32))
538     (:full (unsigned-byte 32)))
539 wlott 1.20 (setf (sap-ref-32 (fd-stream-obuf-sap stream) (fd-stream-obuf-tail stream))
540 wlott 1.5 byte))
541 ram 1.37
542     (def-output-routines ("OUTPUT-SIGNED-LONG-~A-BUFFERED"
543     4
544     (:none (signed-byte 32))
545     (:full (signed-byte 32)))
546     (setf (signed-sap-ref-32 (fd-stream-obuf-sap stream)
547     (fd-stream-obuf-tail stream))
548     byte))
549    
550 rtoy 1.86 (stream::def-ef-macro ef-cout (extfmt lisp stream::+ef-max+ stream::+ef-cout+)
551     `(lambda (stream char)
552     (declare (type fd-stream stream)
553     (type character char)
554     (optimize (speed 3) (space 0) (debug 0) (safety 0)))
555     ;; If there is any input read from UNIX but not
556     ;; supplied to the user of the stream, reposition
557     ;; to the real file position as seen from Lisp.
558     (when (> (fd-stream-ibuf-tail stream)
559     (fd-stream-ibuf-head stream))
560     (file-position stream (file-position stream)))
561     (let* ((sap (fd-stream-obuf-sap stream))
562     (len (fd-stream-obuf-length stream))
563     (tail (fd-stream-obuf-tail stream)))
564     (declare (type sys:system-area-pointer sap) (type index len tail))
565     (stream::char-to-octets ,extfmt
566     char
567     (fd-stream-co-state stream)
568     (lambda (byte)
569     (when (= tail len)
570     (do-output stream sap 0 tail t)
571     (setq sap (fd-stream-obuf-sap stream)
572     tail 0))
573     (setf (bref sap (1- (incf tail))) byte)))
574 rtoy 1.89 (setf (fd-stream-obuf-tail stream) tail))
575     (if (char= char #\Newline)
576     (setf (fd-stream-char-pos stream) 0)
577     (incf (fd-stream-char-pos stream)))
578     (ecase (fd-stream-buffering stream)
579     (:none (flush-output-buffer stream))
580     (:line (when (char= char #\Newline) (flush-output-buffer stream)))
581     (:full #| do nothing |#))
582     (values)))
583 rtoy 1.86
584 ram 1.1
585     ;;; OUTPUT-RAW-BYTES -- public
586     ;;;
587     ;;; Does the actual output. If there is space to buffer the string, buffer
588     ;;; it. If the string would normally fit in the buffer, but doesn't because
589     ;;; of other stuff in the buffer, flush the old noise out of the buffer and
590     ;;; put the string in it. Otherwise we have a very long string, so just
591     ;;; send it directly (after flushing the buffer, of course).
592     ;;;
593     (defun output-raw-bytes (stream thing &optional start end)
594     "Output THING to stream. THING can be any kind of vector or a sap. If THING
595     is a SAP, END must be supplied (as length won't work)."
596     (let ((start (or start 0))
597 ram 1.14 (end (or end (length (the (simple-array * (*)) thing)))))
598     (declare (type index start end))
599 gerd 1.74 ;;
600     ;; If there is any input read from UNIX but not
601     ;; supplied to the user of the stream, reposition
602     ;; to the real file position as seen from Lisp.
603     (when (> (fd-stream-ibuf-tail stream)
604     (fd-stream-ibuf-head stream))
605     (file-position stream (file-position stream)))
606 ram 1.1 (let* ((len (fd-stream-obuf-length stream))
607     (tail (fd-stream-obuf-tail stream))
608     (space (- len tail))
609     (bytes (- end start))
610     (newtail (+ tail bytes)))
611     (cond ((minusp bytes) ; Error case
612     (cerror "Just go on as if nothing happened..."
613     "~S called with :END before :START!"
614     'output-raw-bytes))
615     ((zerop bytes)) ; Easy case
616     ((<= bytes space)
617 wlott 1.5 (if (system-area-pointer-p thing)
618     (system-area-copy thing
619     (* start vm:byte-bits)
620     (fd-stream-obuf-sap stream)
621     (* tail vm:byte-bits)
622     (* bytes vm:byte-bits))
623     (copy-to-system-area thing
624     (+ (* start vm:byte-bits)
625     (* vm:vector-data-offset vm:word-bits))
626     (fd-stream-obuf-sap stream)
627     (* tail vm:byte-bits)
628     (* bytes vm:byte-bits)))
629 ram 1.1 (setf (fd-stream-obuf-tail stream) newtail))
630     ((<= bytes len)
631     (flush-output-buffer stream)
632 wlott 1.5 (if (system-area-pointer-p thing)
633     (system-area-copy thing
634     (* start vm:byte-bits)
635     (fd-stream-obuf-sap stream)
636     0
637     (* bytes vm:byte-bits))
638     (copy-to-system-area thing
639     (+ (* start vm:byte-bits)
640     (* vm:vector-data-offset vm:word-bits))
641     (fd-stream-obuf-sap stream)
642     0
643     (* bytes vm:byte-bits)))
644 ram 1.1 (setf (fd-stream-obuf-tail stream) bytes))
645     (t
646     (flush-output-buffer stream)
647     (do-output stream thing start end nil))))))
648    
649     ;;; FD-SOUT -- internal
650     ;;;
651     ;;; Routine to use to output a string. If the stream is unbuffered, slam
652     ;;; the string down the file descriptor, otherwise use OUTPUT-RAW-BYTES to
653     ;;; buffer the string. Update charpos by checking to see where the last newline
654     ;;; was.
655     ;;;
656     ;;; Note: some bozos (the FASL dumper) call write-string with things other
657     ;;; than strings. Therefore, we must make sure we have a string before calling
658     ;;; position on it.
659 rtoy 1.86 ;;;
660    
661     (stream::def-ef-macro ef-sout (extfmt lisp stream::+ef-max+ stream::+ef-sout+)
662     `(lambda (stream string start end)
663     (declare (type fd-stream stream)
664     (type simple-string string)
665     (type index start end)
666     (optimize (speed 3) (space 0) (safety 0) (debug 0)))
667     ;; If there is any input read from UNIX but not
668     ;; supplied to the user of the stream, reposition
669     ;; to the real file position as seen from Lisp.
670     ;; (maybe the caller should do this?)
671     (when (> (fd-stream-ibuf-tail stream)
672     (fd-stream-ibuf-head stream))
673     (file-position stream (file-position stream)))
674     (let* ((sap (fd-stream-obuf-sap stream))
675     (len (fd-stream-obuf-length stream))
676     (tail (fd-stream-obuf-tail stream)))
677     (declare (type sys:system-area-pointer sap) (type index len tail))
678 rtoy 1.89 (dotimes (i (- end start))
679     (stream::char-to-octets ,extfmt
680     (schar string (+ i start))
681     (fd-stream-co-state stream)
682     (lambda (byte)
683     (when (= tail len)
684     (do-output stream sap 0 tail t)
685     (setq sap (fd-stream-obuf-sap stream)
686     tail 0))
687     (setf (bref sap (1- (incf tail))) byte))))
688 rtoy 1.86 (setf (fd-stream-obuf-tail stream) tail))))
689    
690    
691     #-unicode
692 ram 1.1 (defun fd-sout (stream thing start end)
693     (let ((start (or start 0))
694 ram 1.14 (end (or end (length (the vector thing)))))
695 dtc 1.51 (declare (type index start end))
696 ram 1.1 (if (stringp thing)
697 wlott 1.5 (let ((last-newline (and (find #\newline (the simple-string thing)
698     :start start :end end)
699     (position #\newline (the simple-string thing)
700     :from-end t
701     :start start
702     :end end))))
703     (ecase (fd-stream-buffering stream)
704     (:full
705     (output-raw-bytes stream thing start end))
706     (:line
707     (output-raw-bytes stream thing start end)
708     (when last-newline
709     (flush-output-buffer stream)))
710     (:none
711     (do-output stream thing start end nil)))
712     (if last-newline
713     (setf (fd-stream-char-pos stream)
714     (- end last-newline 1))
715     (incf (fd-stream-char-pos stream)
716     (- end start))))
717 ram 1.1 (ecase (fd-stream-buffering stream)
718 wlott 1.5 ((:line :full)
719 ram 1.1 (output-raw-bytes stream thing start end))
720     (:none
721 wlott 1.5 (do-output stream thing start end nil))))))
722 ram 1.1
723 rtoy 1.86 #+unicode
724 rtoy 1.89 ;; Temporary. The final version is defined in fd-stream-extfmt.lisp
725 rtoy 1.86 (defun fd-sout (stream thing start end)
726     (declare (type string thing))
727     (let ((start (or start 0))
728     (end (or end (length (the vector thing)))))
729     (declare (type index start end))
730     (cond
731     ((stringp thing) ; FIXME - remove this test
732     (let ((out (fd-stream-out stream)))
733     (do ((index start (+ index 1)))
734     ((>= index end))
735     (funcall out stream (elt thing index))))))))
736    
737 rtoy 1.79 (defmacro output-wrapper ((stream size buffering) &body body)
738     (let ((stream-var (gensym)))
739     `(let ((,stream-var ,stream))
740     ,(unless (eq (car buffering) :none)
741     `(when (< (fd-stream-obuf-length ,stream-var)
742     (+ (fd-stream-obuf-tail ,stream-var)
743     ,size))
744     (flush-output-buffer ,stream-var)))
745     ,(unless (eq (car buffering) :none)
746     `(when (> (fd-stream-ibuf-tail ,stream-var)
747     (fd-stream-ibuf-head ,stream-var))
748     (file-position ,stream-var (file-position ,stream-var))))
749    
750     ,@body
751     (incf (fd-stream-obuf-tail ,stream-var) ,size)
752     ,(ecase (car buffering)
753     (:none
754     `(flush-output-buffer ,stream-var))
755     (:line
756     `(when (eq (char-code byte) (char-code #\Newline))
757     (flush-output-buffer ,stream-var)))
758     (:full))
759     (values))))
760    
761 ram 1.1 ;;; PICK-OUTPUT-ROUTINE -- internal
762     ;;;
763     ;;; Find an output routine to use given the type and buffering. Return as
764     ;;; multiple values the routine, the real type transfered, and the number of
765     ;;; bytes per element.
766     ;;;
767     (defun pick-output-routine (type buffering)
768     (dolist (entry *output-routines*)
769     (when (and (subtypep type (car entry))
770     (eq buffering (cadr entry)))
771 rtoy 1.79 (return-from pick-output-routine
772     (values (symbol-function (caddr entry))
773     (car entry)
774     (cadddr entry)))))
775     ;; KLUDGE: also see comments in PICK-INPUT-ROUTINE
776     (loop for i from 40 by 8 to max-stream-element-size ; ARB (KLUDGE)
777     if (subtypep type `(unsigned-byte ,i))
778     do (return-from pick-output-routine
779     (values
780     (ecase buffering
781     (:none
782     (lambda (stream byte)
783     (output-wrapper (stream (/ i 8) (:none))
784     (loop for j from 0 below (/ i 8)
785     do (setf (sap-ref-8
786     (fd-stream-obuf-sap stream)
787     (+ j (fd-stream-obuf-tail stream)))
788     (ldb (byte 8 (- i 8 (* j 8))) byte))))))
789     (:full
790     (lambda (stream byte)
791     (output-wrapper (stream (/ i 8) (:full))
792     (loop for j from 0 below (/ i 8)
793     do (setf (sap-ref-8
794     (fd-stream-obuf-sap stream)
795     (+ j (fd-stream-obuf-tail stream)))
796     (ldb (byte 8 (- i 8 (* j 8))) byte)))))))
797     `(unsigned-byte ,i)
798     (/ i 8))))
799     (loop for i from 40 by 8 to max-stream-element-size ; ARB (KLUDGE)
800     if (subtypep type `(signed-byte ,i))
801     do (return-from pick-output-routine
802     (values
803     (ecase buffering
804     (:none
805     (lambda (stream byte)
806     (output-wrapper (stream (/ i 8) (:none))
807     (loop for j from 0 below (/ i 8)
808     do (setf (sap-ref-8
809     (fd-stream-obuf-sap stream)
810     (+ j (fd-stream-obuf-tail stream)))
811     (ldb (byte 8 (- i 8 (* j 8))) byte))))))
812     (:full
813     (lambda (stream byte)
814     (output-wrapper (stream (/ i 8) (:full))
815     (loop for j from 0 below (/ i 8)
816     do (setf (sap-ref-8
817     (fd-stream-obuf-sap stream)
818     (+ j (fd-stream-obuf-tail stream)))
819     (ldb (byte 8 (- i 8 (* j 8))) byte)))))))
820     `(signed-byte ,i)
821     (/ i 8)))))
822 ram 1.1
823     ;;;; Input routines and related noise.
824    
825     (defvar *input-routines* ()
826     "List of all available input routines. Each element is a list of the
827     element-type input, the function name, and the number of bytes per element.")
828    
829     ;;; DO-INPUT -- internal
830     ;;;
831     ;;; Fills the input buffer, and returns the first character. Throws to
832     ;;; eof-input-catcher if the eof was reached. Drops into system:server if
833     ;;; necessary.
834     ;;;
835     (defun do-input (stream)
836     (let ((fd (fd-stream-fd stream))
837     (ibuf-sap (fd-stream-ibuf-sap stream))
838     (buflen (fd-stream-ibuf-length stream))
839     (head (fd-stream-ibuf-head stream))
840 rtoy 1.86 (lcrs #-unicode 0
841     #+unicode (fd-stream-last-char-read-size stream))
842 ram 1.1 (tail (fd-stream-ibuf-tail stream)))
843 rtoy 1.86 (declare (type index head lcrs tail))
844 ram 1.1 (unless (zerop head)
845 ram 1.14 (cond ((eql head tail)
846 rtoy 1.86 (setf head lcrs)
847     (setf tail lcrs)
848     (setf (fd-stream-ibuf-head stream) lcrs)
849     (setf (fd-stream-ibuf-tail stream) lcrs))
850 ram 1.1 (t
851 rtoy 1.86 (decf tail (- head lcrs))
852     (system-area-copy ibuf-sap (* (- head lcrs) vm:byte-bits)
853 wlott 1.5 ibuf-sap 0 (* tail vm:byte-bits))
854 rtoy 1.86 (setf head lcrs)
855     (setf (fd-stream-ibuf-head stream) lcrs)
856 ram 1.1 (setf (fd-stream-ibuf-tail stream) tail))))
857     (setf (fd-stream-listen stream) nil)
858     (multiple-value-bind
859 dtc 1.41 (count errno)
860     (alien:with-alien ((read-fds (alien:struct unix:fd-set)))
861     (unix:fd-zero read-fds)
862     (unix:fd-set fd read-fds)
863     (unix:unix-fast-select (1+ fd) (alien:addr read-fds) nil nil 0 0))
864 dtc 1.49 ;; Wait if input is not available or if interrupted.
865     (when (or (eql count 0)
866     (and (not count) (eql errno unix:eintr)))
867     (unless #-mp (system:wait-until-fd-usable
868     fd :input (fd-stream-timeout stream))
869     #+mp (mp:process-wait-until-fd-usable
870     fd :input (fd-stream-timeout stream))
871     (error 'io-timeout :stream stream :direction :read))))
872 ram 1.1 (multiple-value-bind
873 dtc 1.42 (count errno)
874 wlott 1.19 (unix:unix-read fd
875 ram 1.1 (system:int-sap (+ (system:sap-int ibuf-sap) tail))
876     (- buflen tail))
877     (cond ((null count)
878 rtoy 1.81 ;; What kinds of errors do we want to look at and what do
879     ;; we want them to do?
880     (cond ((eql errno unix:ewouldblock)
881     (unless #-mp (system:wait-until-fd-usable
882     fd :input (fd-stream-timeout stream))
883     #+mp (mp:process-wait-until-fd-usable
884     fd :input (fd-stream-timeout stream))
885     (error 'io-timeout :stream stream :direction :read))
886     (do-input stream))
887     ((eql errno unix:econnreset)
888     (error 'socket-error
889     :format-control "Socket connection reset: ~A"
890     :format-arguments (list (unix:get-unix-error-msg errno))
891     :errno errno))
892     (t
893     (error "Error reading ~S: ~A"
894     stream
895     (unix:get-unix-error-msg errno)))))
896 ram 1.1 ((zerop count)
897 ram 1.12 (setf (fd-stream-listen stream) :eof)
898 ram 1.1 (throw 'eof-input-catcher nil))
899     (t
900     (incf (fd-stream-ibuf-tail stream) count))))))
901 rtoy 1.86
902 ram 1.1 ;;; INPUT-AT-LEAST -- internal
903     ;;;
904     ;;; Makes sure there are at least ``bytes'' number of bytes in the input
905     ;;; buffer. Keeps calling do-input until that condition is met.
906     ;;;
907     (defmacro input-at-least (stream bytes)
908     (let ((stream-var (gensym))
909     (bytes-var (gensym)))
910     `(let ((,stream-var ,stream)
911     (,bytes-var ,bytes))
912     (loop
913     (when (>= (- (fd-stream-ibuf-tail ,stream-var)
914     (fd-stream-ibuf-head ,stream-var))
915     ,bytes-var)
916     (return))
917     (do-input ,stream-var)))))
918    
919 rtoy 1.86 ;;; INPUT-WRAPPER -- internal
920 ram 1.1 ;;;
921 ram 1.24 ;;; Macro to wrap around all input routines to handle eof-error noise.
922 ram 1.1 ;;;
923 rtoy 1.82 (defmacro input-wrapper ((stream bytes eof-error eof-value &optional type) &body read-forms)
924 ram 1.1 (let ((stream-var (gensym))
925     (element-var (gensym)))
926     `(let ((,stream-var ,stream))
927 rtoy 1.86 (if (fd-stream-unread ,stream-var) ;;@@
928 ram 1.26 (prog1
929 rtoy 1.82 ,(if (eq type 'character)
930     `(fd-stream-unread ,stream-var)
931     `(char-code (fd-stream-unread ,stream-var)))
932 ram 1.26 (setf (fd-stream-unread ,stream-var) nil)
933     (setf (fd-stream-listen ,stream-var) nil))
934     (let ((,element-var
935     (catch 'eof-input-catcher
936     (input-at-least ,stream-var ,bytes)
937     ,@read-forms)))
938     (cond (,element-var
939     (incf (fd-stream-ibuf-head ,stream-var) ,bytes)
940     ,element-var)
941     (t
942     (eof-or-lose ,stream-var ,eof-error ,eof-value))))))))
943 ram 1.1
944     ;;; DEF-INPUT-ROUTINE -- internal
945     ;;;
946     ;;; Defines an input routine.
947     ;;;
948     (defmacro def-input-routine (name
949     (type size sap head)
950     &rest body)
951     `(progn
952     (defun ,name (stream eof-error eof-value)
953 rtoy 1.82 (input-wrapper (stream ,size eof-error eof-value ,type)
954 ram 1.1 (let ((,sap (fd-stream-ibuf-sap stream))
955     (,head (fd-stream-ibuf-head stream)))
956     ,@body)))
957     (setf *input-routines*
958     (nconc *input-routines*
959     (list (list ',type ',name ',size))))))
960    
961 wlott 1.6 ;;; INPUT-CHARACTER -- internal
962 ram 1.1 ;;;
963     ;;; Routine to use in stream-in slot for reading string chars.
964     ;;;
965 wlott 1.6 (def-input-routine input-character
966     (character 1 sap head)
967 wlott 1.5 (code-char (sap-ref-8 sap head)))
968 ram 1.1
969     ;;; INPUT-UNSIGNED-8BIT-BYTE -- internal
970     ;;;
971     ;;; Routine to read in an unsigned 8 bit number.
972     ;;;
973     (def-input-routine input-unsigned-8bit-byte
974     ((unsigned-byte 8) 1 sap head)
975 wlott 1.5 (sap-ref-8 sap head))
976 ram 1.1
977     ;;; INPUT-SIGNED-8BIT-BYTE -- internal
978     ;;;
979     ;;; Routine to read in a signed 8 bit number.
980     ;;;
981     (def-input-routine input-signed-8bit-number
982     ((signed-byte 8) 1 sap head)
983 wlott 1.5 (signed-sap-ref-8 sap head))
984 ram 1.1
985     ;;; INPUT-UNSIGNED-16BIT-BYTE -- internal
986     ;;;
987     ;;; Routine to read in an unsigned 16 bit number.
988     ;;;
989     (def-input-routine input-unsigned-16bit-byte
990     ((unsigned-byte 16) 2 sap head)
991 wlott 1.20 (sap-ref-16 sap head))
992 ram 1.1
993     ;;; INPUT-SIGNED-16BIT-BYTE -- internal
994     ;;;
995     ;;; Routine to read in a signed 16 bit number.
996     ;;;
997     (def-input-routine input-signed-16bit-byte
998     ((signed-byte 16) 2 sap head)
999 wlott 1.20 (signed-sap-ref-16 sap head))
1000 ram 1.1
1001     ;;; INPUT-UNSIGNED-32BIT-BYTE -- internal
1002     ;;;
1003     ;;; Routine to read in a unsigned 32 bit number.
1004     ;;;
1005     (def-input-routine input-unsigned-32bit-byte
1006     ((unsigned-byte 32) 4 sap head)
1007 wlott 1.20 (sap-ref-32 sap head))
1008 ram 1.1
1009     ;;; INPUT-SIGNED-32BIT-BYTE -- internal
1010     ;;;
1011     ;;; Routine to read in a signed 32 bit number.
1012     ;;;
1013     (def-input-routine input-signed-32bit-byte
1014     ((signed-byte 32) 4 sap head)
1015 wlott 1.20 (signed-sap-ref-32 sap head))
1016 ram 1.1
1017 rtoy 1.86 (stream::def-ef-macro ef-cin (extfmt lisp stream::+ef-max+ stream::+ef-cin+)
1018 rtoy 1.89 `(lambda (stream eof-error-p eof-value)
1019 rtoy 1.86 (declare (type fd-stream stream)
1020 rtoy 1.89 #|(optimize (speed 3) (space 0) (debug 0) (safety 0))|#)
1021     (let* ((head (fd-stream-ibuf-head stream))
1022     (ch (catch 'eof-input-catcher
1023     (stream::octets-to-char ,extfmt
1024     (fd-stream-oc-state stream)
1025     (fd-stream-last-char-read-size stream)
1026     ;;@@ Note: need proper EOF handling...
1027     (progn
1028     (when (= head (fd-stream-ibuf-tail stream))
1029     (let ((sofar (- head (fd-stream-ibuf-head
1030     stream))))
1031     (do-input stream)
1032     (setf head (+ (fd-stream-ibuf-head stream)
1033     sofar))))
1034     (bref (fd-stream-ibuf-sap stream)
1035     (1- (incf head))))
1036     (lambda (n) (decf head n))))))
1037     (declare (type index head))
1038     (if ch
1039     (progn
1040     (setf (fd-stream-ibuf-head stream) head)
1041     ch)
1042     (eof-or-lose stream eof-error-p eof-value)))))
1043 rtoy 1.86
1044     #+(or)
1045     (stream::def-ef-macro ef-sin (extfmt lisp stream::+ef-max+ stream::+ef-sin+)
1046     `(lambda (stream string char start end)
1047     (declare (type fd-stream stream)
1048     (type simple-string string)
1049     (type (or character null) char)
1050     (type index start end)
1051     (optimize (speed 3) (space 0) (debug 0) (safety 0)))
1052     (let ((sap (fd-stream-ibuf-sap stream))
1053     (head (fd-stream-ibuf-head stream))
1054     (tail (fd-stream-ibuf-tail stream))
1055     (curr start))
1056     (declare (type sys:system-area-pointer sap)
1057     (type index head tail curr))
1058     (loop
1059     ;;@@ Fix EOF handling
1060     (let* ((sz 0)
1061     (ch (catch 'eof-input-catcher
1062     (stream::octets-to-char ,extfmt
1063 rtoy 1.89 (fd-stream-oc-state stream)
1064     sz
1065     (progn
1066     (when (= head tail)
1067     (let ((sofar (- head
1068     (fd-stream-ibuf-head
1069     stream))))
1070     (do-input stream)
1071     (setq head
1072     (+ (fd-stream-ibuf-head
1073     stream)
1074     sofar)
1075     tail
1076     (fd-stream-ibuf-tail
1077     stream))))
1078     (bref sap (1- (incf head))))
1079     (lambda (n) (decf head n))))))
1080 rtoy 1.86 (declare (type index sz)
1081     (type (or null character) ch))
1082     (when (null ch)
1083     (return (values (- curr start) :eof)))
1084     (setf (fd-stream-last-char-read-size stream) sz)
1085     (incf (fd-stream-ibuf-head stream) sz)
1086     (when (and char (char= ch char))
1087     (return (values (- curr start) t)))
1088     (setf (schar string (1- (incf curr))) ch)
1089     (when (= curr end)
1090     (return (values (- curr start) nil))))))))
1091    
1092 ram 1.1 ;;; PICK-INPUT-ROUTINE -- internal
1093     ;;;
1094     ;;; Find an input routine to use given the type. Return as multiple values
1095     ;;; the routine, the real type transfered, and the number of bytes per element.
1096     ;;;
1097     (defun pick-input-routine (type)
1098     (dolist (entry *input-routines*)
1099     (when (subtypep type (car entry))
1100 rtoy 1.79 (return-from pick-input-routine
1101     (values (symbol-function (cadr entry))
1102     (car entry)
1103     (caddr entry)))))
1104     ;; FIXME: let's do it the hard way, then (but ignore things like
1105     ;; endianness, efficiency, and the necessary coupling between these
1106     ;; and the output routines). -- CSR, 2004-02-09
1107     (loop for i from 40 by 8 to max-stream-element-size ; ARB (well, KLUDGE really)
1108     if (subtypep type `(unsigned-byte ,i))
1109     do (return-from pick-input-routine
1110     (values
1111     (lambda (stream eof-error eof-value)
1112     (input-wrapper (stream (/ i 8) eof-error eof-value)
1113     (let ((sap (fd-stream-ibuf-sap stream))
1114     (head (fd-stream-ibuf-head stream)))
1115     (loop for j from 0 below (/ i 8)
1116     with result = 0
1117     do (setf result
1118     (+ (* 256 result)
1119     (sap-ref-8 sap (+ head j))))
1120     finally (return result)))))
1121     `(unsigned-byte ,i)
1122     (/ i 8))))
1123     (loop for i from 40 by 8 to max-stream-element-size ; ARB (well, KLUDGE really)
1124     if (subtypep type `(signed-byte ,i))
1125     do (return-from pick-input-routine
1126     (values
1127     (lambda (stream eof-error eof-value)
1128     (input-wrapper (stream (/ i 8) eof-error eof-value)
1129     (let ((sap (fd-stream-ibuf-sap stream))
1130     (head (fd-stream-ibuf-head stream)))
1131     (loop for j from 0 below (/ i 8)
1132     with result = 0
1133     do (setf result
1134     (+ (* 256 result)
1135     (sap-ref-8 sap (+ head j))))
1136 rtoy 1.80 finally (return (if (logbitp (1- i) result)
1137     (dpb result (byte i 0) -1)
1138     result))))))
1139 rtoy 1.79 `(signed-byte ,i)
1140     (/ i 8)))))
1141 ram 1.1
1142     ;;; STRING-FROM-SAP -- internal
1143     ;;;
1144     ;;; Returns a string constructed from the sap, start, and end.
1145     ;;;
1146     (defun string-from-sap (sap start end)
1147 ram 1.14 (declare (type index start end))
1148 ram 1.1 (let* ((length (- end start))
1149     (string (make-string length)))
1150 wlott 1.5 (copy-from-system-area sap (* start vm:byte-bits)
1151     string (* vm:vector-data-offset vm:word-bits)
1152     (* length vm:byte-bits))
1153 ram 1.1 string))
1154    
1155 ram 1.13 #|
1156 ram 1.1 ;;; FD-STREAM-READ-N-BYTES -- internal
1157     ;;;
1158 dtc 1.50 ;;; This version waits using server. I changed to the non-server version
1159     ;;; because it allows this method to be used by CLX w/o confusing serve-event.
1160     ;;; The non-server method is also significantly more efficient for large
1161     ;;; reads. -- Ram
1162     ;;;
1163 ram 1.1 ;;; The n-bin routine.
1164     ;;;
1165     (defun fd-stream-read-n-bytes (stream buffer start requested eof-error-p)
1166 dtc 1.50 (declare (type stream stream) (type index start requested))
1167 ram 1.1 (let* ((sap (fd-stream-ibuf-sap stream))
1168     (elsize (fd-stream-element-size stream))
1169     (offset (* elsize start))
1170     (bytes (* elsize requested))
1171 wlott 1.5 (result
1172     (catch 'eof-input-catcher
1173     (loop
1174     (input-at-least stream 1)
1175     (let* ((head (fd-stream-ibuf-head stream))
1176     (tail (fd-stream-ibuf-tail stream))
1177     (available (- tail head))
1178     (copy (min available bytes)))
1179     (if (typep buffer 'system-area-pointer)
1180     (system-area-copy sap (* head vm:byte-bits)
1181     buffer (* offset vm:byte-bits)
1182     (* copy vm:byte-bits))
1183     (copy-from-system-area sap (* head vm:byte-bits)
1184     buffer (+ (* offset vm:byte-bits)
1185     (* vm:vector-data-offset
1186     vm:word-bits))
1187     (* copy vm:byte-bits)))
1188     (incf (fd-stream-ibuf-head stream) copy)
1189     (incf offset copy)
1190     (decf bytes copy))
1191     (when (zerop bytes)
1192     (return requested))))))
1193 ram 1.26 (or result
1194     (eof-or-lose stream eof-error-p
1195     (- requested (/ bytes elsize))))))
1196 ram 1.13 |#
1197 ram 1.1
1198 ram 1.13
1199     ;;; FD-STREAM-READ-N-BYTES -- internal
1200     ;;;
1201 dtc 1.50 ;;; The N-Bin method for FD-STREAMs. This doesn't use the SERVER; it blocks
1202 rtoy 1.86 ;;; in UNIX-READ. This allows the method to be used to implement reading
1203 ram 1.13 ;;; for CLX. It is generally used where there is a definite amount of reading
1204 ram 1.14 ;;; to be done, so blocking isn't too problematical.
1205 ram 1.13 ;;;
1206     ;;; We copy buffered data into the buffer. If there is enough, just return.
1207     ;;; Otherwise, we see if the amount of additional data needed will fit in the
1208     ;;; stream buffer. If not, inhibit GCing (so we can have a SAP into the Buffer
1209     ;;; argument), and read directly into the user supplied buffer. Otherwise,
1210     ;;; read a buffer-full into the stream buffer and then copy the amount we need
1211     ;;; out.
1212     ;;;
1213     ;;; We loop doing the reads until we either get enough bytes or hit EOF. We
1214 ram 1.24 ;;; must loop when eof-errorp is T because some streams (like pipes) may return
1215     ;;; a partial amount without hitting EOF.
1216     ;;;
1217 ram 1.13 (defun fd-stream-read-n-bytes (stream buffer start requested eof-error-p)
1218     (declare (type stream stream) (type index start requested))
1219     (let* ((sap (fd-stream-ibuf-sap stream))
1220 ram 1.24 (offset start)
1221 ram 1.13 (head (fd-stream-ibuf-head stream))
1222     (tail (fd-stream-ibuf-tail stream))
1223     (available (- tail head))
1224 ram 1.24 (copy (min requested available)))
1225     (declare (type index offset head tail available copy))
1226 gerd 1.72 ;;
1227     ;; If something has been unread, put that at buffer + start,
1228     ;; and read the rest to start + 1.
1229 rtoy 1.86 (when (fd-stream-unread stream) ;;@@
1230 gerd 1.72 (etypecase buffer
1231     (system-area-pointer
1232     (assert (= 1 (fd-stream-element-size stream)))
1233     (setf (sap-ref-8 buffer start) (char-code (read-char stream))))
1234 rtoy 1.82 (string
1235     (setf (aref buffer start) (read-char stream)))
1236 gerd 1.72 (vector
1237 rtoy 1.82 (setf (aref buffer start) (char-code(read-char stream)))))
1238 gerd 1.72 (return-from fd-stream-read-n-bytes
1239     (1+ (fd-stream-read-n-bytes stream buffer (1+ start) (1- requested)
1240     eof-error-p))))
1241     ;;
1242 ram 1.13 (unless (zerop copy)
1243     (if (typep buffer 'system-area-pointer)
1244     (system-area-copy sap (* head vm:byte-bits)
1245     buffer (* offset vm:byte-bits)
1246     (* copy vm:byte-bits))
1247     (copy-from-system-area sap (* head vm:byte-bits)
1248     buffer (+ (* offset vm:byte-bits)
1249     (* vm:vector-data-offset
1250     vm:word-bits))
1251     (* copy vm:byte-bits)))
1252     (incf (fd-stream-ibuf-head stream) copy))
1253     (cond
1254 ram 1.24 ((or (= copy requested)
1255     (and (not eof-error-p) (/= copy 0)))
1256     copy)
1257     (t
1258 ram 1.13 (setf (fd-stream-ibuf-head stream) 0)
1259     (setf (fd-stream-ibuf-tail stream) 0)
1260     (setf (fd-stream-listen stream) nil)
1261 ram 1.24 (let ((now-needed (- requested copy))
1262 ram 1.13 (len (fd-stream-ibuf-length stream)))
1263     (declare (type index now-needed len))
1264     (cond
1265     ((> now-needed len)
1266 ram 1.32 ;;
1267     ;; If the desired amount is greater than the stream buffer size, then
1268     ;; read directly into the destination, incrementing the start
1269     ;; accordingly. In this case, we never leave anything in the stream
1270     ;; buffer.
1271 ram 1.13 (system:without-gcing
1272     (loop
1273     (multiple-value-bind
1274     (count err)
1275 wlott 1.19 (unix:unix-read (fd-stream-fd stream)
1276 ram 1.13 (sap+ (if (typep buffer 'system-area-pointer)
1277     buffer
1278     (vector-sap buffer))
1279     (+ offset copy))
1280     now-needed)
1281     (declare (type (or index null) count))
1282     (unless count
1283     (error "Error reading ~S: ~A" stream
1284 wlott 1.19 (unix:get-unix-error-msg err)))
1285 pw 1.48 (decf now-needed count)
1286 ram 1.33 (if eof-error-p
1287     (when (zerop count)
1288     (error 'end-of-file :stream stream))
1289     (return (- requested now-needed)))
1290 ram 1.13 (when (zerop now-needed) (return requested))
1291     (incf offset count)))))
1292     (t
1293 ram 1.32 ;;
1294     ;; If we want less than the buffer size, then loop trying to fill the
1295     ;; stream buffer and copying what we get into the destination. When
1296     ;; we have enough, we leave what's left in the stream buffer.
1297 ram 1.13 (loop
1298     (multiple-value-bind
1299     (count err)
1300 wlott 1.19 (unix:unix-read (fd-stream-fd stream) sap len)
1301 ram 1.13 (declare (type (or index null) count))
1302     (unless count
1303     (error "Error reading ~S: ~A" stream
1304 wlott 1.19 (unix:get-unix-error-msg err)))
1305 ram 1.33 (when (and eof-error-p (zerop count))
1306     (error 'end-of-file :stream stream))
1307    
1308 ram 1.13 (let* ((copy (min now-needed count))
1309     (copy-bits (* copy vm:byte-bits))
1310     (buffer-start-bits
1311     (* (+ offset available) vm:byte-bits)))
1312     (declare (type index copy copy-bits buffer-start-bits))
1313     (if (typep buffer 'system-area-pointer)
1314     (system-area-copy sap 0
1315     buffer buffer-start-bits
1316     copy-bits)
1317     (copy-from-system-area sap 0
1318     buffer (+ buffer-start-bits
1319     (* vm:vector-data-offset
1320     vm:word-bits))
1321     copy-bits))
1322 ram 1.32
1323 ram 1.13 (decf now-needed copy)
1324 ram 1.33 (when (or (zerop now-needed) (not eof-error-p))
1325 ram 1.32 (setf (fd-stream-ibuf-head stream) copy)
1326     (setf (fd-stream-ibuf-tail stream) count)
1327 ram 1.33 (return (- requested now-needed)))
1328 ram 1.24 (incf offset copy)))))))))))
1329 ram 1.13
1330 ram 1.1
1331     ;;;; Utility functions (misc routines, etc)
1332    
1333     ;;; SET-ROUTINES -- internal
1334     ;;;
1335 ram 1.24 ;;; Fill in the various routine slots for the given type. Input-p and
1336     ;;; output-p indicate what slots to fill. The buffering slot must be set prior
1337     ;;; to calling this routine.
1338 ram 1.1 ;;;
1339 rtoy 1.82
1340 rtoy 1.83 (defun set-routines (stream type input-p output-p buffer-p &key binary-stream-p)
1341 ram 1.1 (let ((target-type (case type
1342     ((:default unsigned-byte)
1343     '(unsigned-byte 8))
1344     (signed-byte
1345     '(signed-byte 8))
1346     (t
1347     type)))
1348     (input-type nil)
1349     (output-type nil)
1350     (input-size nil)
1351     (output-size nil))
1352    
1353 wlott 1.5 (when (fd-stream-obuf-sap stream)
1354     (push (fd-stream-obuf-sap stream) *available-buffers*)
1355     (setf (fd-stream-obuf-sap stream) nil))
1356     (when (fd-stream-ibuf-sap stream)
1357     (push (fd-stream-ibuf-sap stream) *available-buffers*)
1358     (setf (fd-stream-ibuf-sap stream) nil))
1359 rtoy 1.86
1360     #+unicode
1361     (when (null (fd-stream-external-format stream))
1362     (setf (fd-stream-external-format stream) :default))
1363 ram 1.1
1364     (when input-p
1365     (multiple-value-bind
1366     (routine type size)
1367     (pick-input-routine target-type)
1368     (unless routine
1369     (error "Could not find any input routine for ~S" target-type))
1370 wlott 1.5 (setf (fd-stream-ibuf-sap stream) (next-available-buffer))
1371     (setf (fd-stream-ibuf-length stream) bytes-per-buffer)
1372     (setf (fd-stream-ibuf-tail stream) 0)
1373 ram 1.1 (if (subtypep type 'character)
1374 ram 1.14 (setf (fd-stream-in stream) routine
1375 ram 1.24 (fd-stream-bin stream) #'ill-bin)
1376 rtoy 1.83 (setf (fd-stream-in stream) (if (and binary-stream-p
1377 rtoy 1.82 (eql size 1))
1378     (pick-input-routine 'character)
1379     #'ill-in)
1380 ram 1.24 (fd-stream-bin stream) routine))
1381 toy 1.58 (when (or (eql size 1)
1382     (eql size 2)
1383     (eql size 4))
1384     ;; Support for n-byte operations on 8-, 16-, and 32-bit streams
1385 ram 1.24 (setf (fd-stream-n-bin stream) #'fd-stream-read-n-bytes)
1386 toy 1.60 (when (and buffer-p (eql size 1)
1387 rtoy 1.91 (or
1388     ;; FIXME: Do this better. We want to check for
1389     ;; (unsigned-byte 8). The 8 is unnecessary
1390     ;; since we already have size = 1.
1391     (or (eq 'unsigned-byte (and (consp type) (car type)))
1392     (eq type :default))
1393 rtoy 1.92 (eq type 'character)))
1394 toy 1.60 ;; We only create this buffer for streams of type
1395 rtoy 1.91 ;; (unsigned-byte 8) or character streams with an external
1396     ;; format of :iso8859-1. Because there's no buffer, the
1397 toy 1.60 ;; other element-types will dispatch to the appropriate
1398 rtoy 1.91 ;; input (output) routine in fast-read-byte/fast-read-char.
1399 rtoy 1.92 (when *enable-stream-buffer-p*
1400     (setf (lisp-stream-in-buffer stream)
1401     (make-array in-buffer-length
1402     :element-type '(unsigned-byte 8)))
1403     #+unicode
1404     (when (and (eq type 'character)
1405     (not (eq :iso8859-1 (fd-stream-external-format stream))))
1406     ;; For character streams, we create the string-buffer so
1407     ;; we can convert all available octets at once instead
1408     ;; of for each character. The string is one element
1409     ;; longer than in-buffer-length to leave room for
1410     ;; unreading.
1411     ;;
1412     ;; For ISO8859-1, we don't want this because it's very
1413     ;; easy and quick to convert octets to iso8859-1. (See
1414     ;; FAST-READ-CHAR.)
1415     (setf (lisp-stream-string-buffer stream)
1416     (make-string (1+ in-buffer-length)))
1417     (setf (lisp-stream-string-buffer-len stream) 0)
1418     (setf (lisp-stream-string-index stream) 0)))))
1419 ram 1.1 (setf input-size size)
1420     (setf input-type type)))
1421    
1422     (when output-p
1423     (multiple-value-bind
1424     (routine type size)
1425     (pick-output-routine target-type (fd-stream-buffering stream))
1426     (unless routine
1427     (error "Could not find any output routine for ~S buffered ~S."
1428     (fd-stream-buffering stream)
1429     target-type))
1430 wlott 1.5 (setf (fd-stream-obuf-sap stream) (next-available-buffer))
1431     (setf (fd-stream-obuf-length stream) bytes-per-buffer)
1432 ram 1.1 (setf (fd-stream-obuf-tail stream) 0)
1433     (if (subtypep type 'character)
1434     (setf (fd-stream-out stream) routine
1435     (fd-stream-bout stream) #'ill-bout)
1436     (setf (fd-stream-out stream)
1437     (or (if (eql size 1)
1438 wlott 1.16 (pick-output-routine 'base-char
1439 ram 1.1 (fd-stream-buffering stream)))
1440     #'ill-out)
1441     (fd-stream-bout stream) routine))
1442     (setf (fd-stream-sout stream)
1443 rtoy 1.91 (if (eql size 1) #'fd-sout #'ill-out))
1444 ram 1.1 (setf (fd-stream-char-pos stream) 0)
1445     (setf output-size size)
1446     (setf output-type type)))
1447    
1448     (when (and input-size output-size
1449 rtoy 1.86 (not (eql input-size output-size)))
1450 ram 1.1 (error "Element sizes for input (~S:~S) and output (~S:~S) differ?"
1451     input-type input-size
1452     output-type output-size))
1453     (setf (fd-stream-element-size stream)
1454     (or input-size output-size))
1455    
1456     (setf (fd-stream-element-type stream)
1457     (cond ((equal input-type output-type)
1458     input-type)
1459 dtc 1.39 ((null output-type)
1460     input-type)
1461     ((null input-type)
1462     output-type)
1463     ((subtypep input-type output-type)
1464 ram 1.1 input-type)
1465     ((subtypep output-type input-type)
1466     output-type)
1467     (t
1468     (error "Input type (~S) and output type (~S) are unrelated?"
1469     input-type
1470     output-type))))))
1471    
1472 toy 1.66 ;;; REVERT-FILE -- internal
1473     ;;;
1474 rtoy 1.84 ;;; Revert a file, if possible; otherwise do nothing. Used during
1475 toy 1.66 ;;; CLOSE when the abort flag is set.
1476     ;;;
1477     (defun revert-file (filename original)
1478     (declare (type simple-base-string filename)
1479     (type (or simple-base-string null) original))
1480 rtoy 1.84 (when original
1481     (multiple-value-bind (okay err)
1482     (unix:unix-rename original filename)
1483     (unless okay
1484 toy 1.66 (cerror "Go on as if nothing bad happened."
1485 emarsden 1.71 "Could not restore ~S to its original contents: ~A"
1486 toy 1.66 filename (unix:get-unix-error-msg err))))))
1487    
1488     ;;; DELETE-ORIGINAL -- internal
1489     ;;;
1490     ;;; Delete a backup file. Used during CLOSE.
1491     ;;;
1492     (defun delete-original (filename original)
1493     (declare (type simple-base-string filename)
1494     (type (or simple-base-string null) original))
1495     (when original
1496     (multiple-value-bind (okay err) (unix:unix-unlink original)
1497     (unless okay
1498     (cerror "Go on as if nothing bad happened."
1499     "Could not delete ~S during close of ~S: ~A"
1500 emarsden 1.69 original filename (unix:get-unix-error-msg err))))))
1501 toy 1.66
1502 ram 1.1 ;;; FD-STREAM-MISC-ROUTINE -- input
1503     ;;;
1504     ;;; Handle the various misc operations on fd-stream.
1505     ;;;
1506     (defun fd-stream-misc-routine (stream operation &optional arg1 arg2)
1507 ram 1.24 (declare (ignore arg2))
1508 ram 1.1 (case operation
1509 ram 1.24 (:listen
1510 ram 1.1 (or (not (eql (fd-stream-ibuf-head stream)
1511     (fd-stream-ibuf-tail stream)))
1512     (fd-stream-listen stream)
1513     (setf (fd-stream-listen stream)
1514 dtc 1.41 (eql (alien:with-alien ((read-fds (alien:struct unix:fd-set)))
1515     (unix:fd-zero read-fds)
1516     (unix:fd-set (fd-stream-fd stream) read-fds)
1517     (unix:unix-fast-select (1+ (fd-stream-fd stream))
1518     (alien:addr read-fds) nil nil
1519     0 0))
1520 ram 1.13 1))))
1521 ram 1.1 (:unread
1522 rtoy 1.86 #-unicode
1523 wlott 1.5 (setf (fd-stream-unread stream) arg1)
1524 rtoy 1.86 #+unicode
1525 rtoy 1.92 (cond ((lisp-stream-string-buffer stream)
1526     (if (zerop (lisp-stream-string-index stream))
1527     (setf (fd-stream-unread stream) arg1)
1528     (decf (lisp-stream-string-index stream))))
1529     (t
1530     (if (zerop (fd-stream-last-char-read-size stream))
1531     (setf (fd-stream-unread stream) arg1)
1532     (decf (fd-stream-ibuf-head stream)
1533     (fd-stream-last-char-read-size stream)))))
1534 rtoy 1.86 ;; Paul says:
1535     ;;
1536     ;; Not needed for unicode when unreading is implemented by backing up in
1537     ;; the buffer (e.g., with last-char-read-size...)
1538     ;;
1539     ;; (AFAICS there's nothing wrong with setting it there, but it
1540     ;; screws up read-interactive in my toplevel command thing -
1541     ;; leaves it expecting to read arguments when it shouldn't,
1542     ;; because LISTEN returns T when there's no input pending, but I
1543     ;; don't understand why...)
1544     #-unicode
1545 wlott 1.5 (setf (fd-stream-listen stream) t))
1546 ram 1.1 (:close
1547     (cond (arg1
1548     ;; We got us an abort on our hands.
1549 dtc 1.40 (when (fd-stream-handler stream)
1550     (system:remove-fd-handler (fd-stream-handler stream))
1551     (setf (fd-stream-handler stream) nil))
1552 toy 1.66 (when (and (fd-stream-file stream) (fd-stream-obuf-sap stream))
1553     (revert-file (fd-stream-file stream)
1554     (fd-stream-original stream))))
1555 ram 1.1 (t
1556 rtoy 1.90 #+(and unicode (not unicode-bootstrap))
1557     (when (and (output-stream-p stream)
1558     (eq (stream-element-type stream) 'character))
1559     ;; For output character streams, we need to flush out
1560     ;; any state that the external format might have.
1561     #+nil (format *debug-io* "state = ~S~%" (fd-stream-co-state stream))
1562     (funcall (ef-flush (fd-stream-external-format stream))
1563     stream))
1564 ram 1.1 (fd-stream-misc-routine stream :finish-output)
1565 toy 1.66 (when (fd-stream-delete-original stream)
1566     (delete-original (fd-stream-file stream)
1567     (fd-stream-original stream)))))
1568 wlott 1.17 (when (fboundp 'cancel-finalization)
1569     (cancel-finalization stream))
1570 wlott 1.19 (unix:unix-close (fd-stream-fd stream))
1571 wlott 1.5 (when (fd-stream-obuf-sap stream)
1572     (push (fd-stream-obuf-sap stream) *available-buffers*)
1573     (setf (fd-stream-obuf-sap stream) nil))
1574     (when (fd-stream-ibuf-sap stream)
1575     (push (fd-stream-ibuf-sap stream) *available-buffers*)
1576     (setf (fd-stream-ibuf-sap stream) nil))
1577 ram 1.1 (lisp::set-closed-flame stream))
1578 wlott 1.6 (:clear-input
1579 rtoy 1.86 (setf (fd-stream-unread stream) nil) ;;@@
1580     #+unicode (setf (fd-stream-last-char-read-size stream) 0)
1581 wlott 1.6 (setf (fd-stream-ibuf-head stream) 0)
1582     (setf (fd-stream-ibuf-tail stream) 0)
1583 ram 1.38 (catch 'eof-input-catcher
1584     (loop
1585 dtc 1.49 (multiple-value-bind
1586     (count errno)
1587     (alien:with-alien ((read-fds (alien:struct unix:fd-set)))
1588     (unix:fd-zero read-fds)
1589     (unix:fd-set (fd-stream-fd stream) read-fds)
1590     (unix:unix-fast-select (1+ (fd-stream-fd stream))
1591     (alien:addr read-fds) nil nil 0 0))
1592 ram 1.38 (cond ((eql count 1)
1593     (do-input stream)
1594     (setf (fd-stream-ibuf-head stream) 0)
1595     (setf (fd-stream-ibuf-tail stream) 0))
1596 dtc 1.49 ((and (not count) (eql errno unix:eintr)))
1597 ram 1.38 (t
1598     (return t)))))))
1599 ram 1.1 (:force-output
1600     (flush-output-buffer stream))
1601     (:finish-output
1602     (flush-output-buffer stream)
1603     (do ()
1604     ((null (fd-stream-output-later stream)))
1605     (system:serve-all-events)))
1606     (:element-type
1607     (fd-stream-element-type stream))
1608 ram 1.22 (:interactive-p
1609     (unix:unix-isatty (fd-stream-fd stream)))
1610 ram 1.1 (:line-length
1611     80)
1612     (:charpos
1613     (fd-stream-char-pos stream))
1614     (:file-length
1615 pw 1.56 (unless (fd-stream-file stream)
1616     (error 'simple-type-error
1617     :datum stream
1618     :expected-type 'file-stream
1619     :format-control "~s is not a stream associated with a file."
1620     :format-arguments (list stream)))
1621 ram 1.1 (multiple-value-bind
1622     (okay dev ino mode nlink uid gid rdev size
1623     atime mtime ctime blksize blocks)
1624 wlott 1.19 (unix:unix-fstat (fd-stream-fd stream))
1625 ram 1.1 (declare (ignore ino nlink uid gid rdev
1626     atime mtime ctime blksize blocks))
1627     (unless okay
1628 pmai 1.61 (error 'simple-file-error
1629     :format-control "Error fstating ~S: ~A"
1630     :format-arguments (list stream (unix:get-unix-error-msg dev))))
1631 dtc 1.51 (if (zerop mode)
1632 ram 1.23 nil
1633 toy 1.64 (values (truncate size (fd-stream-element-size stream))))))
1634 ram 1.1 (:file-position
1635 ram 1.29 (fd-stream-file-position stream arg1))))
1636 ram 1.1
1637 ram 1.28
1638 ram 1.1 ;;; FD-STREAM-FILE-POSITION -- internal.
1639     ;;;
1640     (defun fd-stream-file-position (stream &optional newpos)
1641 ram 1.14 (declare (type fd-stream stream)
1642 dtc 1.51 (type (or (integer 0) (member nil :start :end)) newpos))
1643 ram 1.1 (if (null newpos)
1644     (system:without-interrupts
1645 dtc 1.51 ;; First, find the position of the UNIX file descriptor in the file.
1646 ram 1.1 (multiple-value-bind
1647 dtc 1.51 (posn errno)
1648 wlott 1.19 (unix:unix-lseek (fd-stream-fd stream) 0 unix:l_incr)
1649 dtc 1.51 (declare (type (or (integer 0) null) posn))
1650     (cond (posn
1651 ram 1.1 ;; Adjust for buffered output:
1652     ;; If there is any output buffered, the *real* file position
1653     ;; will be larger than reported by lseek because lseek
1654 toy 1.70 ;; obviously cannot take into account output we have not
1655 ram 1.1 ;; sent yet.
1656     (dolist (later (fd-stream-output-later stream))
1657 ram 1.14 (incf posn (- (the index (caddr later))
1658     (the index (cadr later)))))
1659 ram 1.1 (incf posn (fd-stream-obuf-tail stream))
1660     ;; Adjust for unread input:
1661     ;; If there is any input read from UNIX but not supplied to
1662     ;; the user of the stream, the *real* file position will
1663     ;; smaller than reported, because we want to look like the
1664     ;; unread stuff is still available.
1665 rtoy 1.93 #-unicode
1666 ram 1.1 (decf posn (- (fd-stream-ibuf-tail stream)
1667     (fd-stream-ibuf-head stream)))
1668 rtoy 1.93 #+unicode
1669     (if (fd-stream-string-buffer stream)
1670 rtoy 1.94 ;; The string buffer contains Lisp characters,
1671     ;; not octets! To figure out how many octets
1672     ;; have not been already supplied, we need to
1673     ;; convert them back to the encoded format and
1674     ;; count the number of octets.
1675 rtoy 1.97 (decf posn
1676     (length (string-encode (fd-stream-string-buffer stream)
1677     (fd-stream-external-format stream)
1678     (fd-stream-string-index stream)
1679     (fd-stream-string-buffer-len stream))))
1680 rtoy 1.93 (decf posn (- (fd-stream-ibuf-tail stream)
1681 rtoy 1.94 (fd-stream-ibuf-head stream))))
1682 rtoy 1.86 (when (fd-stream-unread stream) ;;@@
1683 ram 1.1 (decf posn))
1684     ;; Divide bytes by element size.
1685 ram 1.14 (truncate posn (fd-stream-element-size stream)))
1686 wlott 1.19 ((eq errno unix:espipe)
1687 ram 1.1 nil)
1688     (t
1689     (system:with-interrupts
1690     (error "Error lseek'ing ~S: ~A"
1691     stream
1692 wlott 1.19 (unix:get-unix-error-msg errno)))))))
1693 dtc 1.51 (let ((offset 0)
1694     origin)
1695     (declare (type (integer 0) offset))
1696 ram 1.1 ;; Make sure we don't have any output pending, because if we move the
1697     ;; file pointer before writing this stuff, it will be written in the
1698     ;; wrong location.
1699     (flush-output-buffer stream)
1700     (do ()
1701     ((null (fd-stream-output-later stream)))
1702     (system:serve-all-events))
1703 ram 1.4 ;; Clear out any pending input to force the next read to go to the
1704     ;; disk.
1705 rtoy 1.86 (setf (fd-stream-unread stream) nil) ;;@@
1706 rtoy 1.93 #+unicode
1707     (progn
1708     (setf (fd-stream-last-char-read-size stream) 0)
1709     (setf (fd-stream-string-index stream)
1710     (fd-stream-string-buffer-len stream)))
1711 ram 1.4 (setf (fd-stream-ibuf-head stream) 0)
1712     (setf (fd-stream-ibuf-tail stream) 0)
1713 dtc 1.51 ;; Trash cached value for listen, so that we check next time.
1714 wlott 1.5 (setf (fd-stream-listen stream) nil)
1715 ram 1.4 ;; Now move it.
1716 ram 1.1 (cond ((eq newpos :start)
1717 dtc 1.51 (setf offset 0
1718     origin unix:l_set))
1719 ram 1.1 ((eq newpos :end)
1720 dtc 1.51 (setf offset 0
1721     origin unix:l_xtnd))
1722     ((typep newpos '(integer 0))
1723 ram 1.1 (setf offset (* newpos (fd-stream-element-size stream))
1724 wlott 1.19 origin unix:l_set))
1725 ram 1.1 (t
1726     (error "Invalid position given to file-position: ~S" newpos)))
1727     (multiple-value-bind
1728     (posn errno)
1729 wlott 1.19 (unix:unix-lseek (fd-stream-fd stream) offset origin)
1730 dtc 1.51 (cond (posn
1731 ram 1.1 t)
1732 wlott 1.19 ((eq errno unix:espipe)
1733 ram 1.1 nil)
1734     (t
1735     (error "Error lseek'ing ~S: ~A"
1736     stream
1737 wlott 1.19 (unix:get-unix-error-msg errno))))))))
1738 ram 1.1
1739    
1740    
1741     ;;;; Creation routines (MAKE-FD-STREAM and OPEN)
1742    
1743     ;;; MAKE-FD-STREAM -- Public.
1744     ;;;
1745     ;;; Returns a FD-STREAM on the given file.
1746     ;;;
1747     (defun make-fd-stream (fd
1748     &key
1749     (input nil input-p)
1750     (output nil output-p)
1751 wlott 1.16 (element-type 'base-char)
1752 ram 1.1 (buffering :full)
1753 ram 1.15 timeout
1754 ram 1.1 file
1755     original
1756     delete-original
1757 ram 1.28 pathname
1758 ram 1.24 input-buffer-p
1759 ram 1.1 (name (if file
1760     (format nil "file ~S" file)
1761 wlott 1.17 (format nil "descriptor ~D" fd)))
1762 rtoy 1.83 auto-close
1763 rtoy 1.86 (external-format :default)
1764 rtoy 1.83 binary-stream-p)
1765 ram 1.15 (declare (type index fd) (type (or index null) timeout)
1766     (type (member :none :line :full) buffering))
1767     "Create a stream for the given unix file descriptor.
1768     If input is non-nil, allow input operations.
1769     If output is non-nil, allow output operations.
1770     If neither input nor output are specified, default to allowing input.
1771     Element-type indicates the element type to use (as for open).
1772     Buffering indicates the kind of buffering to use.
1773     Timeout (if true) is the number of seconds to wait for input. If NIL (the
1774     default), then wait forever. When we time out, we signal IO-TIMEOUT.
1775     File is the name of the file (will be returned by PATHNAME).
1776     Name is used to identify the stream when printed."
1777 ram 1.1 (cond ((not (or input-p output-p))
1778     (setf input t))
1779     ((not (or input output))
1780     (error "File descriptor must be opened either for input or output.")))
1781 rtoy 1.83 (let ((stream (if binary-stream-p
1782     (%make-binary-text-stream :fd fd
1783     :name name
1784     :file file
1785     :original original
1786     :delete-original delete-original
1787     :pathname pathname
1788     :buffering buffering
1789     :timeout timeout)
1790     (%make-fd-stream :fd fd
1791     :name name
1792     :file file
1793     :original original
1794     :delete-original delete-original
1795     :pathname pathname
1796     :buffering buffering
1797     :timeout timeout))))
1798 rtoy 1.91 ;; FIXME: setting the external format here should be better
1799     ;; integrated into set-routines. We do it before so that
1800     ;; set-routines can create an in-buffer if appropriate. But we
1801     ;; need to do it after to put the correct input routines for the
1802     ;; external format.
1803     ;;
1804     ;;#-unicode-bootstrap ; fails in stream-reinit otherwise
1805     #+(and unicode (not unicode-bootstrap))
1806 rtoy 1.96 (%set-fd-stream-external-format stream external-format nil)
1807 rtoy 1.83 (set-routines stream element-type input output input-buffer-p
1808     :binary-stream-p binary-stream-p)
1809 rtoy 1.86 #+(and unicode (not unicode-bootstrap))
1810 rtoy 1.95 (%set-fd-stream-external-format stream external-format nil)
1811 wlott 1.17 (when (and auto-close (fboundp 'finalize))
1812     (finalize stream
1813     #'(lambda ()
1814 wlott 1.19 (unix:unix-close fd)
1815 toy 1.70 (format *terminal-io* "** Closed ~A~%" name)
1816     (when original
1817     (revert-file file original)))))
1818 ram 1.1 stream))
1819    
1820 ram 1.24
1821 toy 1.66 ;;; PICK-BACKUP-NAME -- internal
1822 ram 1.1 ;;;
1823     ;;; Pick a name to use for the backup file.
1824     ;;;
1825     (defvar *backup-extension* ".BAK"
1826     "This is a string that OPEN tacks on the end of a file namestring to produce
1827     a name for the :if-exists :rename-and-delete and :rename options. Also,
1828     this can be a function that takes a namestring and returns a complete
1829     namestring.")
1830     ;;;
1831     (defun pick-backup-name (name)
1832 ram 1.14 (declare (type simple-string name))
1833     (let ((ext *backup-extension*))
1834     (etypecase ext
1835     (simple-string (concatenate 'simple-string name ext))
1836     (function (funcall ext name)))))
1837 ram 1.1
1838 toy 1.65 ;;; NEXT-VERSION -- internal
1839     ;;;
1840     ;;; Find the next available versioned name for a file.
1841     ;;;
1842     (defun next-version (name)
1843     (declare (type simple-string name))
1844     (let* ((sep (position #\/ name :from-end t))
1845     (base (if sep (subseq name 0 (1+ sep)) ""))
1846     (dir (unix:open-dir base)))
1847     (multiple-value-bind (name type version)
1848     (extract-name-type-and-version name (if sep (1+ sep) 0) (length name))
1849     (let ((version (if (symbolp version) 1 (1+ version)))
1850 toy 1.67 (match (if type
1851     (concatenate 'string name "." type ".~")
1852     (concatenate 'string name ".~"))))
1853 toy 1.65 (when dir
1854     (unwind-protect
1855     (loop
1856     (let ((name (unix:read-dir dir)))
1857     (cond ((null name) (return))
1858     ((and (> (length name) (length match))
1859     (string= name match :end1 (length match)))
1860     (multiple-value-bind (v e)
1861     (parse-integer name :start (length match)
1862     :junk-allowed t)
1863     (when (and v
1864     (= (length name) (1+ e))
1865     (char= (schar name e) #\~))
1866     (setq version (max version (1+ v)))))))))
1867     (unix:close-dir dir)))
1868     (concatenate 'string base
1869     match (quick-integer-to-string version) "~")))))
1870    
1871 ram 1.1 ;;; ASSURE-ONE-OF -- internal
1872     ;;;
1873     ;;; Assure that the given arg is one of the given list of valid things.
1874     ;;; Allow the user to fix any problems.
1875     ;;;
1876     (defun assure-one-of (item list what)
1877     (unless (member item list)
1878     (loop
1879     (cerror "Enter new value for ~*~S"
1880     "~S is invalid for ~S. Must be one of~{ ~S~}"
1881     item
1882     what
1883     list)
1884 ram 1.14 (format (the stream *query-io*) "Enter new value for ~S: " what)
1885 ram 1.1 (force-output *query-io*)
1886     (setf item (read *query-io*))
1887     (when (member item list)
1888     (return))))
1889     item)
1890    
1891 ram 1.14 ;;; DO-OLD-RENAME -- Internal
1892     ;;;
1893     ;;; Rename Namestring to Original. First, check if we have write access,
1894     ;;; since we don't want to trash unwritable files even if we technically can.
1895 toy 1.70 ;;; We return true if we succeed in renaming.
1896 ram 1.14 ;;;
1897     (defun do-old-rename (namestring original)
1898 wlott 1.19 (unless (unix:unix-access namestring unix:w_ok)
1899 ram 1.14 (cerror "Try to rename it anyway." "File ~S is not writable." namestring))
1900     (multiple-value-bind
1901     (okay err)
1902 wlott 1.19 (unix:unix-rename namestring original)
1903 ram 1.14 (cond (okay t)
1904     (t
1905     (cerror "Use :SUPERSEDE instead."
1906     "Could not rename ~S to ~S: ~A."
1907     namestring
1908     original
1909 wlott 1.19 (unix:get-unix-error-msg err))
1910 ram 1.14 nil))))
1911    
1912 toy 1.66 ;;; FD-OPEN -- Internal
1913 pw 1.57 ;;;
1914 toy 1.66 ;;; Open a file.
1915 pw 1.57 ;;;
1916 toy 1.66 (defun fd-open (pathname direction if-exists if-exists-given
1917     if-does-not-exist if-does-not-exist-given)
1918     (declare (type pathname pathname)
1919     (type (member :input :output :io :probe) direction)
1920     (type (member :error :new-version :rename :rename-and-delete
1921     :overwrite :append :supersede nil) if-exists)
1922     (type (member :error :create nil) if-does-not-exist))
1923     (multiple-value-bind (input output mask)
1924     (ecase direction
1925     (:input (values t nil unix:o_rdonly))
1926     (:output (values nil t unix:o_wronly))
1927     (:io (values t t unix:o_rdwr))
1928     (:probe (values t nil unix:o_rdonly)))
1929     (declare (type index mask))
1930 emarsden 1.76 ;; Process if-exists argument if we are doing any output.
1931     (cond (output
1932     (unless if-exists-given
1933     (setf if-exists
1934     (if (eq (pathname-version pathname) :newest)
1935     :new-version
1936     :error)))
1937     (case if-exists
1938     ((:error nil)
1939     (setf mask (logior mask unix:o_excl)))
1940     ((:new-version :rename :rename-and-delete)
1941     (setf mask (logior mask unix:o_creat)))
1942     (:supersede
1943     (setf mask (logior mask unix:o_trunc)))))
1944     (t
1945     (setf if-exists nil))) ; :ignore-this-arg
1946    
1947     (unless if-does-not-exist-given
1948     (setf if-does-not-exist
1949     (cond ((eq direction :input) :error)
1950     ((and output
1951     (member if-exists '(:overwrite :append)))
1952     :error)
1953     ((eq direction :probe)
1954     nil)
1955     (t
1956     :create))))
1957     (if (eq if-does-not-exist :create)
1958     (setf mask (logior mask unix:o_creat)))
1959    
1960 toy 1.66 (let ((name (cond ((unix-namestring pathname input))
1961     ((and input (eq if-does-not-exist :create))
1962     (unix-namestring pathname nil)))))
1963     (let ((original (cond ((eq if-exists :new-version)
1964     (next-version name))
1965     ((member if-exists '(:rename :rename-and-delete))
1966     (pick-backup-name name))))
1967     (delete-original (eq if-exists :rename-and-delete))
1968     (mode #o666))
1969     (when original
1970     ;; We are doing a :rename or :rename-and-delete.
1971     ;; Determine if the file already exists, make sure the original
1972     ;; file is not a directory and keep the mode
1973     (let ((exists
1974     (and name
1975     (multiple-value-bind
1976     (okay err/dev inode orig-mode)
1977     (unix:unix-stat name)
1978     (declare (ignore inode)
1979     (type (or index null) orig-mode))
1980     (cond
1981     (okay
1982     (when (and output (= (logand orig-mode #o170000)
1983     #o40000))
1984     (error 'simple-file-error
1985     :pathname pathname
1986     :format-control
1987     "Cannot open ~S for output: Is a directory."
1988     :format-arguments (list name)))
1989     (setf mode (logand orig-mode #o777))
1990     t)
1991     ((eql err/dev unix:enoent)
1992     nil)
1993     (t
1994     (error 'simple-file-error
1995     :pathname pathname
1996     :format-control "Cannot find ~S: ~A"
1997     :format-arguments
1998     (list name
1999     (unix:get-unix-error-msg err/dev)))))))))
2000     (unless (and exists
2001     (do-old-rename name original))
2002     (setf original nil)
2003     (setf delete-original nil)
2004     ;; In order to use SUPERSEDE instead, we have
2005     ;; to make sure unix:o_creat corresponds to
2006     ;; if-does-not-exist. unix:o_creat was set
2007     ;; before because of if-exists being :rename.
2008     (unless (eq if-does-not-exist :create)
2009     (setf mask (logior (logandc2 mask unix:o_creat)
2010     unix:o_trunc)))
2011     (setf if-exists :supersede))))
2012    
2013     ;; Okay, now we can try the actual open.
2014     (loop
2015     (multiple-value-bind (fd errno)
2016     (if name
2017     (unix:unix-open name mask mode)
2018     (values nil unix:enoent))
2019     (cond ((fixnump fd)
2020 toy 1.68 (when (eq if-exists :append)
2021     (unix:unix-lseek fd 0 unix:l_xtnd)) ; SEEK_END
2022 toy 1.66 (return (values fd name original delete-original)))
2023     ((eql errno unix:enoent)
2024     (case if-does-not-exist
2025     (:error
2026     (cerror "Return NIL."
2027     'simple-file-error
2028     :pathname pathname
2029     :format-control "Error opening ~S, ~A."
2030     :format-arguments
2031     (list pathname
2032     (unix:get-unix-error-msg errno))))
2033     (:create
2034     (cerror "Return NIL."
2035     'simple-file-error
2036     :pathname pathname
2037     :format-control
2038     "Error creating ~S, path does not exist."
2039     :format-arguments (list pathname))))
2040     (return nil))
2041     ((eql errno unix:eexist)
2042     (unless (eq nil if-exists)
2043     (cerror "Return NIL."
2044     'simple-file-error
2045     :pathname pathname
2046     :format-control "Error opening ~S, ~A."
2047     :format-arguments
2048     (list pathname
2049     (unix:get-unix-error-msg errno))))
2050     (return nil))
2051     ((eql errno unix:eacces)
2052     (cerror "Try again."
2053