0.pre7.4:
[sbcl.git] / src / code / fd-stream.lisp
index 3d0e8b7..4b6f09d 100644 (file)
   element-type output, the kind of buffering, the function name, and the number
   of bytes per element.")
 
+;;; common idioms for reporting low-level stream and file problems
+(defun simple-stream-perror (note-format stream errno)
+  (error 'simple-stream-error
+        :stream stream
+        :format-control "~@<~?: ~2I~_~A~:>"
+        :format-arguments (list note-format (list stream) (strerror errno))))
+(defun simple-file-perror (note-format pathname errno)
+  (error 'simple-stream-error
+        :pathname pathname
+        :format-control "~@<~?: ~2I~_~A~:>"
+        :format-arguments
+        (list note-format (list pathname) (strerror errno))))
+
 ;;; This is called by the server when we can write to the given file
 ;;; descriptor. Attempt to write the data again. If it worked, remove
 ;;; the data from the OUTPUT-LATER list. If it didn't work, something
       (cond ((not count)
             (if (= errno sb!unix:ewouldblock)
                 (error "Write would have blocked, but SERVER told us to go.")
-                (error "while writing ~S: ~A"
-                       stream
-                       (sb!unix:get-unix-error-msg errno))))
+                (simple-stream-perror "couldn't write to ~S" stream errno)))
            ((eql count length) ; Hot damn, it worked.
             (when reuse-sap
               (push base *available-buffers*)))
-           ((not (null count)) ; Sorta worked.
+           ((not (null count)) ; sorta worked..
             (push (list base
                         (the index (+ start count))
                         end)
          (cond ((not count)
                 (if (= errno sb!unix:ewouldblock)
                     (output-later stream base start end reuse-sap)
-                    ;; FIXME: This and various other errors in this file
-                    ;; should probably be STREAM-ERROR.
-                    (error "while writing ~S: ~A"
-                           stream
-                           (sb!unix:get-unix-error-msg errno))))
+                    (simple-stream-perror "couldn't write to ~S"
+                                          stream
+                                          errno)))
                ((not (eql count length))
                 (output-later stream base (the index (+ start count))
                               end reuse-sap)))))))
                       fd :input (fd-stream-timeout stream))
           (error 'io-timeout :stream stream :direction :read)))
        (t
-        (error "problem checking to see whether ~S is readable: ~A"
-               stream
-               (sb!unix:get-unix-error-msg errno)))))
+        (simple-stream-perror "couldn't check whether ~S is readable"
+                              stream
+                              errno))))
     (multiple-value-bind (count errno)
        (sb!unix:unix-read fd
                           (sb!sys:int-sap (+ (sb!sys:sap-int ibuf-sap) tail))
                                 fd :input (fd-stream-timeout stream))
                     (error 'io-timeout :stream stream :direction :read))
                   (do-input stream))
-                (error "error reading ~S: ~A"
-                       stream
-                       (sb!unix:get-unix-error-msg errno))))
+                (simple-stream-perror "couldn't read from ~S" stream errno)))
            ((zerop count)
             (setf (fd-stream-listen stream) :eof)
             (throw 'eof-input-catcher nil))
                      (car entry)
                      (caddr entry))))))
 
-;;; Returns a string constructed from the sap, start, and end.
+;;; Return a string constructed from SAP, START, and END.
 (defun string-from-sap (sap start end)
   (declare (type index start end))
   (let* ((length (- end start))
                           (* length sb!vm:byte-bits))
     string))
 
-;;; the N-BIN method for FD-STREAMs. This blocks in UNIX-READ. It is
-;;; generally used where there is a definite amount of reading to be
-;;; done, so blocking isn't too problematical.
+;;; the N-BIN method for FD-STREAMs
+;;;
+;;; Note that this blocks in UNIX-READ. It is generally used where
+;;; there is a definite amount of reading to be done, so blocking
+;;; isn't too problematical.
 (defun fd-stream-read-n-bytes (stream buffer start requested eof-error-p)
   (declare (type fd-stream stream))
   (declare (type index start requested))
           (head (fd-stream-ibuf-head stream))
           (tail (fd-stream-ibuf-tail stream))
           (available (- tail head))
-          (this-copy (min remaining-request available))
+          (n-this-copy (min remaining-request available))
           (this-start (+ start total-copied))
+          (this-end (+ this-start n-this-copy))
           (sap (fd-stream-ibuf-sap stream)))
       (declare (type index remaining-request head tail available))
-      (declare (type index this-copy))
+      (declare (type index n-this-copy))
       ;; Copy data from stream buffer into user's buffer. 
-      (if (typep buffer 'system-area-pointer)
-         (system-area-copy sap (* head sb!vm:byte-bits)
-                           buffer (* this-start sb!vm:byte-bits)
-                           (* this-copy sb!vm:byte-bits))
-         (copy-from-system-area sap (* head sb!vm:byte-bits)
-                                buffer (+ (* this-start sb!vm:byte-bits)
-                                          (* sb!vm:vector-data-offset
-                                             sb!vm:word-bits))
-                                (* this-copy sb!vm:byte-bits)))
-      (incf (fd-stream-ibuf-head stream) this-copy)
-      (incf total-copied this-copy)
+      (%byte-blt sap head buffer this-start this-end)
+      (incf (fd-stream-ibuf-head stream) n-this-copy)
+      (incf total-copied n-this-copy)
       ;; Maybe we need to refill the stream buffer.
       (cond (;; If there were enough data in the stream buffer, we're done.
             (= total-copied requested)
                         (fd-stream-ibuf-length stream))
     (declare (type (or index null) count))
     (when (null count)
-      (error "error reading ~S: ~A"
-            stream
-            (sb!unix:get-unix-error-msg err)))
+      (simple-stream-perror "couldn't read from ~S" stream err))
     (setf (fd-stream-listen stream) nil
          (fd-stream-ibuf-head stream) 0
          (fd-stream-ibuf-tail stream) count)
-;    (format t "~%buffer=~%--~%")
-;    (dotimes (i count)
-;      (write-char (code-char (sap-ref-8 (fd-stream-ibuf-sap stream) i))))
-;    (format t "~%--~%")
-    #+nil
-    (format t "/REFILL-FD-STREAM-BUFFER = ~D~%" count)
     count))
 \f
 ;;;; utility functions (misc routines, etc)
                      (sb!unix:unix-rename (fd-stream-original fd-stream)
                                           (fd-stream-file fd-stream))
                    (unless okay
-                     (error "~@<could not restore ~S to its original ~
-                              contents: ~2I~_~A~:>"
-                            (fd-stream-file fd-stream)
-                            (sb!unix:get-unix-error-msg err))))
+                     (simple-stream-perror
+                      "couldn't restore ~S to its original contents"
+                      fd-stream
+                      err)))
                  ;; We can't restore the original, so nuke that puppy.
                  (multiple-value-bind (okay err)
                      (sb!unix:unix-unlink (fd-stream-file fd-stream))
                    (unless okay
-                     (error "~@<could not remove ~S: ~2I~_~A~:>"
-                            (fd-stream-file fd-stream)
-                            (sb!unix:get-unix-error-msg err)))))))
+                     (error 'simple-file-error
+                            :pathname (fd-stream-file fd-stream)
+                            :format-control
+                            "~@<couldn't remove ~S: ~2I~_~A~:>"
+                            :format-arguments (list (fd-stream-file fd-stream)
+                                                    (strerror err))))))))
           (t
            (fd-stream-misc-routine fd-stream :finish-output)
            (when (and (fd-stream-original fd-stream)
              (multiple-value-bind (okay err)
                  (sb!unix:unix-unlink (fd-stream-original fd-stream))
                (unless okay
-                 (error "~@<could not delete ~S during close ~
-                           of ~S: ~2I~_~A~:>"
-                        (fd-stream-original fd-stream)
-                        fd-stream
-                        (sb!unix:get-unix-error-msg err)))))))
+                 (error 'simple-file-error
+                        :pathname (fd-stream-original fd-stream)
+                        :format-control 
+                        "~@<couldn't delete ~S during close of ~S: ~
+                          ~2I~_~A~:>"
+                        :format-arguments
+                        (list (fd-stream-original fd-stream)
+                              fd-stream
+                              (strerror err))))))))
      (when (fboundp 'cancel-finalization)
        (cancel-finalization fd-stream))
      (sb!unix:unix-close (fd-stream-fd fd-stream))
     (:charpos
      (fd-stream-char-pos fd-stream))
     (:file-length
+     (unless (fd-stream-file fd-stream)
+       ;; This is a TYPE-ERROR because ANSI's species FILE-LENGTH
+       ;; "should signal an error of type TYPE-ERROR if stream is not
+       ;; a stream associated with a file". Too bad there's no very
+       ;; appropriate value for the EXPECTED-TYPE slot..
+       (error 'simple-type-error
+              :datum fd-stream
+              :expected-type 'file-stream
+              :format-control "~S is not a stream associated with a file."
+              :format-arguments (list fd-stream)))
      (multiple-value-bind (okay dev ino mode nlink uid gid rdev size
                           atime mtime ctime blksize blocks)
         (sb!unix:unix-fstat (fd-stream-fd fd-stream))
        (declare (ignore ino nlink uid gid rdev
                        atime mtime ctime blksize blocks))
        (unless okay
-        (error "error in Unix fstat(2) on ~S: ~A"
-               fd-stream
-               (sb!unix:get-unix-error-msg dev)))
+        (simple-stream-perror "failed Unix fstat(2) on ~S" fd-stream dev))
        (if (zerop mode)
           nil
           (truncate size (fd-stream-element-size fd-stream)))))
           (type (or index (member nil :start :end)) newpos))
   (if (null newpos)
       (sb!sys:without-interrupts
-       ;; First, find the position of the UNIX file descriptor in the
-       ;; file.
+       ;; First, find the position of the UNIX file descriptor in the file.
        (multiple-value-bind (posn errno)
            (sb!unix:unix-lseek (fd-stream-fd stream) 0 sb!unix:l_incr)
          (declare (type (or index null) posn))
                 nil)
                (t
                 (sb!sys:with-interrupts
-                  (error "error LSEEK'ing ~S: ~A"
-                         stream
-                         (sb!unix:get-unix-error-msg errno)))))))
+                  (simple-stream-perror "failure in Unix lseek() on ~S"
+                                        stream
+                                        errno))))))
       (let ((offset 0) origin)
        (declare (type index offset))
        ;; Make sure we don't have any output pending, because if we
               (setf offset (* newpos (fd-stream-element-size stream))
                     origin sb!unix:l_set))
              (t
-              (error "invalid position given to file-position: ~S" newpos)))
+              (error "invalid position given to FILE-POSITION: ~S" newpos)))
        (multiple-value-bind (posn errno)
            (sb!unix:unix-lseek (fd-stream-fd stream) offset origin)
          (cond ((typep posn 'fixnum)
                ((eq errno sb!unix:espipe)
                 nil)
                (t
-                (error "error lseek'ing ~S: ~A"
-                       stream
-                       (sb!unix:get-unix-error-msg errno))))))))
+                (simple-stream-perror "error in Unix lseek() on ~S"
+                                      stream
+                                      errno)))))))
 \f
 ;;;; creation routines (MAKE-FD-STREAM and OPEN)
 
   (unless (sb!unix:unix-access namestring sb!unix:w_ok)
     (error "~@<The file ~2I~_~S ~I~_is not writable.~:>" namestring))
   (multiple-value-bind (okay err) (sb!unix:unix-rename namestring original)
-    (cond (okay t)
-         (t
-          (error "~@<could not rename ~2I~_~S ~I~_to ~2I~_~S: ~4I~_~A~:>"
-                 namestring
-                 original
-                 (sb!unix:get-unix-error-msg err))
-          nil))))
+    (if okay
+       t
+       (error 'simple-file-error
+              :pathname namestring
+              :format-control 
+              "~@<couldn't rename ~2I~_~S ~I~_to ~2I~_~S: ~4I~_~A~:>"
+              :format-arguments (list namestring original (strerror err))))))
 
 (defun open (filename
             &key
            (delete-original (eq if-exists :rename-and-delete))
            (mode #o666))
        (when original
-         ;; We are doing a :RENAME or :RENAME-AND-DELETE.
-         ;; Determine whether the file already exists, make sure the original
+         ;; We are doing a :RENAME or :RENAME-AND-DELETE. Determine
+         ;; whether the file already exists, make sure the original
          ;; file is not a directory, and keep the mode.
          (let ((exists
                 (and namestring
                         (okay
                          (when (and output (= (logand orig-mode #o170000)
                                               #o40000))
-                           (error "cannot open ~S for output: is a directory"
-                                  namestring))
+                           (error 'simple-file-error
+                                  :pathname namestring
+                                  :format-control
+                                  "can't open ~S for output: is a directory"
+                                  :format-arguments (list namestring)))
                          (setf mode (logand orig-mode #o777))
                          t)
                         ((eql err/dev sb!unix:enoent)
                          nil)
                         (t
-                         (error "cannot find ~S: ~A"
-                                namestring
-                                (sb!unix:get-unix-error-msg err/dev))))))))
+                         (simple-file-perror "can't find ~S"
+                                             namestring
+                                             err/dev)))))))
            (unless (and exists
                         (do-old-rename namestring original))
              (setf original nil)
              (setf delete-original nil)
-             ;; In order to use :SUPERSEDE instead, we have to make sure
-             ;; SB!UNIX:O_CREAT corresponds to IF-DOES-NOT-EXIST.
-             ;; SB!UNIX:O_CREAT was set before because of IF-EXISTS being
-             ;; :RENAME.
+             ;; In order to use :SUPERSEDE instead, we have to make
+             ;; sure SB!UNIX:O_CREAT corresponds to
+             ;; IF-DOES-NOT-EXIST. SB!UNIX:O_CREAT was set before
+             ;; because of IF-EXISTS being :RENAME.
              (unless (eq if-does-not-exist :create)
                (setf mask
                      (logior (logandc2 mask sb!unix:o_creat)
                            :format-control format-control
                            :format-arguments format-arguments))
                   (vanilla-open-error ()
-                    (open-error "~@<error opening ~S: ~2I~_~A~:>"
-                                pathname
-                                (sb!unix:get-unix-error-msg errno))))
+                    (simple-file-perror "error opening ~S" pathname errno)))
            (cond ((numberp fd)
                   (case direction
                     ((:input :output :io)
                   (case if-does-not-exist
                     (:error (vanilla-open-error))
                     (:create
-                     (open-error
-                      "~@<The path ~2I~_~S ~I~_does not exist.~:>"
-                      pathname))
+                     (open-error "~@<The path ~2I~_~S ~I~_does not exist.~:>"
+                                 pathname))
                     (t nil)))
                  ((and (eql errno sb!unix:eexist) if-exists)
                   nil)
 
 ;;; This is kind of like FILE-POSITION, but is an internal hack used
 ;;; by the filesys stuff to get and set the file name.
+;;;
+;;; FIXME: misleading name, screwy interface
 (defun file-name (stream &optional new-name)
   (when (typep stream 'fd-stream)
       (cond (new-name