src/code/fd-stream.lisp

   1 ;;;; streams for UNIX file descriptors
   2
   3 ;;;; This software is part of the SBCL system. See the README file for
   4 ;;;; more information.
   5 ;;;;
   6 ;;;; This software is derived from the CMU CL system, which was
   7 ;;;; written at Carnegie Mellon University and released into the
   8 ;;;; public domain. The software is in the public domain and is
   9 ;;;; provided with absolutely no warranty. See the COPYING and CREDITS
  10 ;;;; files for more information.
  11
  12 (in-package "SB!IMPL")
  13
  14 ;;;; buffer manipulation routines
  15
  16 ;;; FIXME: Is it really good to maintain this pool separate from the
  17 ;;; GC and the C malloc logic?
  18 (defvar *available-buffers* ()
  19   #!+sb-doc
  20   "List of available buffers. Each buffer is an sap pointing to
  21   bytes-per-buffer of memory.")
  22
  23 #!+sb-thread
  24 (defvar *available-buffers-mutex* (sb!thread:make-mutex
  25                                    :name "lock for *AVAILABLE-BUFFERS*")
  26   #!+sb-doc
  27   "Mutex for access to *AVAILABLE-BUFFERS*.")
  28
  29 (defmacro with-available-buffers-lock ((&optional) &body body)
  30   ;; WITHOUT-INTERRUPTS because streams are low-level enough to be
  31   ;; async signal safe, and in particular a C-c that brings up the
  32   ;; debugger while holding the mutex would lose badly
  33   `(without-interrupts
  34     (sb!thread:with-mutex (*available-buffers-mutex*)
  35       ,@body)))
  36
  37 (defconstant bytes-per-buffer (* 4 1024)
  38   #!+sb-doc
  39   "Number of bytes per buffer.")
  40
  41 ;;; Return the next available buffer, creating one if necessary.
  42 #!-sb-fluid (declaim (inline next-available-buffer))
  43 (defun next-available-buffer ()
  44   (with-available-buffers-lock ()
  45     (if *available-buffers*
  46         (pop *available-buffers*)
  47         (allocate-system-memory bytes-per-buffer))))
  48 \f
  49 ;;;; the FD-STREAM structure
  50
  51 (defstruct (fd-stream
  52             (:constructor %make-fd-stream)
  53             (:conc-name fd-stream-)
  54             (:predicate fd-stream-p)
  55             (:include ansi-stream
  56                       (misc #'fd-stream-misc-routine))
  57             (:copier nil))
  58
  59   ;; the name of this stream
  60   (name nil)
  61   ;; the file this stream is for
  62   (file nil)
  63   ;; the backup file namestring for the old file, for :IF-EXISTS
  64   ;; :RENAME or :RENAME-AND-DELETE.
  65   (original nil :type (or simple-string null))
  66   (delete-original nil)       ; for :if-exists :rename-and-delete
  67   ;;; the number of bytes per element
  68   (element-size 1 :type index)
  69   ;; the type of element being transfered
  70   (element-type 'base-char)
  71   ;; the Unix file descriptor
  72   (fd -1 :type fixnum)
  73   ;; controls when the output buffer is flushed
  74   (buffering :full :type (member :full :line :none))
  75   ;; controls whether the input buffer must be cleared before output
  76   ;; (must be done for files, not for sockets, pipes and other data
  77   ;; sources where input and output aren't related).  non-NIL means
  78   ;; don't clear input buffer.
  79   (dual-channel-p nil)
  80   ;; character position (if known)
  81   (char-pos nil :type (or index null))
  82   ;; T if input is waiting on FD. :EOF if we hit EOF.
  83   (listen nil :type (member nil t :eof))
  84
  85   ;; the input buffer
  86   (unread nil)
  87   (ibuf-sap nil :type (or system-area-pointer null))
  88   (ibuf-length nil :type (or index null))
  89   (ibuf-head 0 :type index)
  90   (ibuf-tail 0 :type index)
  91
  92   ;; the output buffer
  93   (obuf-sap nil :type (or system-area-pointer null))
  94   (obuf-length nil :type (or index null))
  95   (obuf-tail 0 :type index)
  96
  97   ;; output flushed, but not written due to non-blocking io?
  98   (output-later nil)
  99   (handler nil)
 100   ;; timeout specified for this stream, or NIL if none
 101   (timeout nil :type (or index null))
 102   ;; pathname of the file this stream is opened to (returned by PATHNAME)
 103   (pathname nil :type (or pathname null))
 104   (external-format :default)
 105   (output-bytes #'ill-out :type function))
 106 (def!method print-object ((fd-stream fd-stream) stream)
 107   (declare (type stream stream))
 108   (print-unreadable-object (fd-stream stream :type t :identity t)
 109     (format stream "for ~S" (fd-stream-name fd-stream))))
 110 \f
 111 ;;;; output routines and related noise
 112
 113 (defvar *output-routines* ()
 114   #!+sb-doc
 115   "List of all available output routines. Each element is a list of the
 116   element-type output, the kind of buffering, the function name, and the number
 117   of bytes per element.")
 118
 119 ;;; common idioms for reporting low-level stream and file problems
 120 (defun simple-stream-perror (note-format stream errno)
 121   (error 'simple-stream-error
 122          :stream stream
 123          :format-control "~@<~?: ~2I~_~A~:>"
 124          :format-arguments (list note-format (list stream) (strerror errno))))
 125 (defun simple-file-perror (note-format pathname errno)
 126   (error 'simple-file-error
 127          :pathname pathname
 128          :format-control "~@<~?: ~2I~_~A~:>"
 129          :format-arguments
 130          (list note-format (list pathname) (strerror errno))))
 131
 132 (defun stream-decoding-error (stream octets)
 133   (error 'stream-decoding-error
 134          :stream stream
 135          ;; FIXME: dunno how to get at OCTETS currently, or even if
 136          ;; that's the right thing to report.
 137          :octets octets))
 138 (defun stream-encoding-error (stream code)
 139   (error 'stream-encoding-error
 140          :stream stream
 141          :code code))
 142
 143 ;;; Returning true goes into end of file handling, false will enter another
 144 ;;; round of input buffer filling followed by re-entering character decode.
 145 (defun stream-decoding-error-and-handle (stream octet-count)
 146   (restart-case
 147       (stream-decoding-error stream
 148                              (let ((sap (fd-stream-ibuf-sap stream))
 149                                    (head (fd-stream-ibuf-head stream)))
 150                                (loop for i from 0 below octet-count
 151                                      collect (sap-ref-8 sap (+ head i)))))
 152     (attempt-resync ()
 153       :report (lambda (stream)
 154                 (format stream
 155                         "~@<Attempt to resync the stream at a character ~
 156                         character boundary and continue.~@:>"))
 157       (fd-stream-resync stream)
 158       nil)
 159     (force-end-of-file ()
 160       :report (lambda (stream)
 161                 (format stream "~@<Force an end of file.~@:>"))
 162       t)))
 163
 164 (defun stream-encoding-error-and-handle (stream code)
 165   (restart-case
 166       (stream-encoding-error stream code)
 167     (output-nothing ()
 168       :report (lambda (stream)
 169                 (format stream "~@<Skip output of this character.~@:>"))
 170       (throw 'output-nothing nil))))
 171
 172 ;;; This is called by the server when we can write to the given file
 173 ;;; descriptor. Attempt to write the data again. If it worked, remove
 174 ;;; the data from the OUTPUT-LATER list. If it didn't work, something
 175 ;;; is wrong.
 176 (defun frob-output-later (stream)
 177   (let* ((stuff (pop (fd-stream-output-later stream)))
 178          (base (car stuff))
 179          (start (cadr stuff))
 180          (end (caddr stuff))
 181          (reuse-sap (cadddr stuff))
 182          (length (- end start)))
 183     (declare (type index start end length))
 184     (multiple-value-bind (count errno)
 185         (sb!unix:unix-write (fd-stream-fd stream)
 186                             base
 187                             start
 188                             length)
 189       (cond ((not count)
 190              (if #!-win32 (= errno sb!unix:ewouldblock) #!+win32 t #!-win32
 191                  (error "Write would have blocked, but SERVER told us to go.")
 192                  (simple-stream-perror "couldn't write to ~S" stream errno)))
 193             ((eql count length) ; Hot damn, it worked.
 194              (when reuse-sap
 195                (with-available-buffers-lock ()
 196                  (push base *available-buffers*))))
 197             ((not (null count)) ; sorta worked..
 198              (push (list base
 199                          (the index (+ start count))
 200                          end)
 201                    (fd-stream-output-later stream))))))
 202   (unless (fd-stream-output-later stream)
 203     (sb!sys:remove-fd-handler (fd-stream-handler stream))
 204     (setf (fd-stream-handler stream) nil)))
 205
 206 ;;; Arange to output the string when we can write on the file descriptor.
 207 (defun output-later (stream base start end reuse-sap)
 208   (cond ((null (fd-stream-output-later stream))
 209          (setf (fd-stream-output-later stream)
 210                (list (list base start end reuse-sap)))
 211          (setf (fd-stream-handler stream)
 212                (sb!sys:add-fd-handler (fd-stream-fd stream)
 213                                       :output
 214                                       (lambda (fd)
 215                                         (declare (ignore fd))
 216                                         (frob-output-later stream)))))
 217         (t
 218          (nconc (fd-stream-output-later stream)
 219                 (list (list base start end reuse-sap)))))
 220   (when reuse-sap
 221     (let ((new-buffer (next-available-buffer)))
 222       (setf (fd-stream-obuf-sap stream) new-buffer)
 223       (setf (fd-stream-obuf-length stream) bytes-per-buffer))))
 224
 225 ;;; Output the given noise. Check to see whether there are any pending
 226 ;;; writes. If so, just queue this one. Otherwise, try to write it. If
 227 ;;; this would block, queue it.
 228 (defun frob-output (stream base start end reuse-sap)
 229   (declare (type fd-stream stream)
 230            (type (or system-area-pointer (simple-array * (*))) base)
 231            (type index start end))
 232   (if (not (null (fd-stream-output-later stream))) ; something buffered.
 233       (progn
 234         (output-later stream base start end reuse-sap)
 235         ;; ### check to see whether any of this noise can be output
 236         )
 237       (let ((length (- end start)))
 238         (multiple-value-bind (count errno)
 239             (sb!unix:unix-write (fd-stream-fd stream) base start length)
 240           (cond ((not count)
 241                  (if #!-win32 (= errno sb!unix:ewouldblock) #!+win32 t #!-win32
 242                      (output-later stream base start end reuse-sap)
 243                      (simple-stream-perror "couldn't write to ~S"
 244                                            stream
 245                                            errno)))
 246                 ((not (eql count length))
 247                  (output-later stream base (the index (+ start count))
 248                                end reuse-sap)))))))
 249
 250 ;;; Flush any data in the output buffer.
 251 (defun flush-output-buffer (stream)
 252   (let ((length (fd-stream-obuf-tail stream)))
 253     (unless (= length 0)
 254       (frob-output stream (fd-stream-obuf-sap stream) 0 length t)
 255       (setf (fd-stream-obuf-tail stream) 0))))
 256
 257 (defmacro output-wrapper/variable-width ((stream size buffering restart)
 258                                          &body body)
 259   (let ((stream-var (gensym)))
 260     `(let ((,stream-var ,stream)
 261            (size ,size))
 262       ,(unless (eq (car buffering) :none)
 263          `(when (< (fd-stream-obuf-length ,stream-var)
 264                    (+ (fd-stream-obuf-tail ,stream-var)
 265                        size))
 266             (flush-output-buffer ,stream-var)))
 267       ,(unless (eq (car buffering) :none)
 268          `(when (and (not (fd-stream-dual-channel-p ,stream-var))
 269                      (> (fd-stream-ibuf-tail ,stream-var)
 270                         (fd-stream-ibuf-head ,stream-var)))
 271             (file-position ,stream-var (file-position ,stream-var))))
 272       ,(if restart
 273            `(catch 'output-nothing
 274               ,@body
 275               (incf (fd-stream-obuf-tail ,stream-var) size))
 276            `(progn
 277              ,@body
 278              (incf (fd-stream-obuf-tail ,stream-var) size)))
 279       ,(ecase (car buffering)
 280          (:none
 281           `(flush-output-buffer ,stream-var))
 282          (:line
 283           `(when (eq (char-code byte) (char-code #\Newline))
 284              (flush-output-buffer ,stream-var)))
 285          (:full))
 286     (values))))
 287
 288 (defmacro output-wrapper ((stream size buffering restart) &body body)
 289   (let ((stream-var (gensym)))
 290     `(let ((,stream-var ,stream))
 291       ,(unless (eq (car buffering) :none)
 292          `(when (< (fd-stream-obuf-length ,stream-var)
 293                    (+ (fd-stream-obuf-tail ,stream-var)
 294                        ,size))
 295             (flush-output-buffer ,stream-var)))
 296       ,(unless (eq (car buffering) :none)
 297          `(when (and (not (fd-stream-dual-channel-p ,stream-var))
 298                      (> (fd-stream-ibuf-tail ,stream-var)
 299                         (fd-stream-ibuf-head ,stream-var)))
 300             (file-position ,stream-var (file-position ,stream-var))))
 301       ,(if restart
 302            `(catch 'output-nothing
 303               ,@body
 304               (incf (fd-stream-obuf-tail ,stream-var) ,size))
 305            `(progn
 306              ,@body
 307              (incf (fd-stream-obuf-tail ,stream-var) ,size)))
 308       ,(ecase (car buffering)
 309          (:none
 310           `(flush-output-buffer ,stream-var))
 311          (:line
 312           `(when (eq (char-code byte) (char-code #\Newline))
 313              (flush-output-buffer ,stream-var)))
 314          (:full))
 315     (values))))
 316
 317 (defmacro def-output-routines/variable-width
 318     ((name-fmt size restart external-format &rest bufferings)
 319      &body body)
 320   (declare (optimize (speed 1)))
 321   (cons 'progn
 322         (mapcar
 323             (lambda (buffering)
 324               (let ((function
 325                      (intern (format nil name-fmt (string (car buffering))))))
 326                 `(progn
 327                    (defun ,function (stream byte)
 328                      (output-wrapper/variable-width (stream ,size ,buffering ,restart)
 329                        ,@body))
 330                    (setf *output-routines*
 331                          (nconc *output-routines*
 332                                 ',(mapcar
 333                                    (lambda (type)
 334                                      (list type
 335                                            (car buffering)
 336                                            function
 337                                            1
 338                                            external-format))
 339                                    (cdr buffering)))))))
 340             bufferings)))
 341
 342 ;;; Define output routines that output numbers SIZE bytes long for the
 343 ;;; given bufferings. Use BODY to do the actual output.
 344 (defmacro def-output-routines ((name-fmt size restart &rest bufferings)
 345                                &body body)
 346   (declare (optimize (speed 1)))
 347   (cons 'progn
 348         (mapcar
 349             (lambda (buffering)
 350               (let ((function
 351                      (intern (format nil name-fmt (string (car buffering))))))
 352                 `(progn
 353                    (defun ,function (stream byte)
 354                      (output-wrapper (stream ,size ,buffering ,restart)
 355                        ,@body))
 356                    (setf *output-routines*
 357                          (nconc *output-routines*
 358                                 ',(mapcar
 359                                    (lambda (type)
 360                                      (list type
 361                                            (car buffering)
 362                                            function
 363                                            size
 364                                            nil))
 365                                    (cdr buffering)))))))
 366             bufferings)))
 367
 368 ;;; FIXME: is this used anywhere any more?
 369 (def-output-routines ("OUTPUT-CHAR-~A-BUFFERED"
 370                       1
 371                       t
 372                       (:none character)
 373                       (:line character)
 374                       (:full character))
 375   (if (char= byte #\Newline)
 376       (setf (fd-stream-char-pos stream) 0)
 377       (incf (fd-stream-char-pos stream)))
 378   (setf (sap-ref-8 (fd-stream-obuf-sap stream) (fd-stream-obuf-tail stream))
 379         (char-code byte)))
 380
 381 (def-output-routines ("OUTPUT-UNSIGNED-BYTE-~A-BUFFERED"
 382                       1
 383                       nil
 384                       (:none (unsigned-byte 8))
 385                       (:full (unsigned-byte 8)))
 386   (setf (sap-ref-8 (fd-stream-obuf-sap stream) (fd-stream-obuf-tail stream))
 387         byte))
 388
 389 (def-output-routines ("OUTPUT-SIGNED-BYTE-~A-BUFFERED"
 390                       1
 391                       nil
 392                       (:none (signed-byte 8))
 393                       (:full (signed-byte 8)))
 394   (setf (signed-sap-ref-8 (fd-stream-obuf-sap stream)
 395                           (fd-stream-obuf-tail stream))
 396         byte))
 397
 398 (def-output-routines ("OUTPUT-UNSIGNED-SHORT-~A-BUFFERED"
 399                       2
 400                       nil
 401                       (:none (unsigned-byte 16))
 402                       (:full (unsigned-byte 16)))
 403   (setf (sap-ref-16 (fd-stream-obuf-sap stream) (fd-stream-obuf-tail stream))
 404         byte))
 405
 406 (def-output-routines ("OUTPUT-SIGNED-SHORT-~A-BUFFERED"
 407                       2
 408                       nil
 409                       (:none (signed-byte 16))
 410                       (:full (signed-byte 16)))
 411   (setf (signed-sap-ref-16 (fd-stream-obuf-sap stream)
 412                            (fd-stream-obuf-tail stream))
 413         byte))
 414
 415 (def-output-routines ("OUTPUT-UNSIGNED-LONG-~A-BUFFERED"
 416                       4
 417                       nil
 418                       (:none (unsigned-byte 32))
 419                       (:full (unsigned-byte 32)))
 420   (setf (sap-ref-32 (fd-stream-obuf-sap stream) (fd-stream-obuf-tail stream))
 421         byte))
 422
 423 (def-output-routines ("OUTPUT-SIGNED-LONG-~A-BUFFERED"
 424                       4
 425                       nil
 426                       (:none (signed-byte 32))
 427                       (:full (signed-byte 32)))
 428   (setf (signed-sap-ref-32 (fd-stream-obuf-sap stream)
 429                            (fd-stream-obuf-tail stream))
 430         byte))
 431
 432 ;;; Do the actual output. If there is space to buffer the string,
 433 ;;; buffer it. If the string would normally fit in the buffer, but
 434 ;;; doesn't because of other stuff in the buffer, flush the old noise
 435 ;;; out of the buffer and put the string in it. Otherwise we have a
 436 ;;; very long string, so just send it directly (after flushing the
 437 ;;; buffer, of course).
 438 (defun output-raw-bytes (fd-stream thing &optional start end)
 439   #!+sb-doc
 440   "Output THING to FD-STREAM. THING can be any kind of vector or a SAP. If
 441   THING is a SAP, END must be supplied (as length won't work)."
 442   (let ((start (or start 0))
 443         (end (or end (length (the (simple-array * (*)) thing)))))
 444     (declare (type index start end))
 445     (when (and (not (fd-stream-dual-channel-p fd-stream))
 446                (> (fd-stream-ibuf-tail fd-stream)
 447                   (fd-stream-ibuf-head fd-stream)))
 448       (file-position fd-stream (file-position fd-stream)))
 449     (let* ((len (fd-stream-obuf-length fd-stream))
 450            (tail (fd-stream-obuf-tail fd-stream))
 451            (space (- len tail))
 452            (bytes (- end start))
 453            (newtail (+ tail bytes)))
 454       (cond ((minusp bytes) ; error case
 455              (error ":END before :START!"))
 456             ((zerop bytes)) ; easy case
 457             ((<= bytes space)
 458              (if (system-area-pointer-p thing)
 459                  (system-area-ub8-copy thing start
 460                                        (fd-stream-obuf-sap fd-stream)
 461                                        tail
 462                                        bytes)
 463                  ;; FIXME: There should be some type checking somewhere to
 464                  ;; verify that THING here is a vector, not just <not a SAP>.
 465                  (copy-ub8-to-system-area thing start
 466                                           (fd-stream-obuf-sap fd-stream)
 467                                           tail
 468                                           bytes))
 469              (setf (fd-stream-obuf-tail fd-stream) newtail))
 470             ((<= bytes len)
 471              (flush-output-buffer fd-stream)
 472              (if (system-area-pointer-p thing)
 473                  (system-area-ub8-copy thing
 474                                        start
 475                                        (fd-stream-obuf-sap fd-stream)
 476                                        0
 477                                        bytes)
 478                  ;; FIXME: There should be some type checking somewhere to
 479                  ;; verify that THING here is a vector, not just <not a SAP>.
 480                  (copy-ub8-to-system-area thing
 481                                           start
 482                                           (fd-stream-obuf-sap fd-stream)
 483                                           0
 484                                           bytes))
 485              (setf (fd-stream-obuf-tail fd-stream) bytes))
 486             (t
 487              (flush-output-buffer fd-stream)
 488              (frob-output fd-stream thing start end nil))))))
 489
 490 ;;; the routine to use to output a string. If the stream is
 491 ;;; unbuffered, slam the string down the file descriptor, otherwise
 492 ;;; use OUTPUT-RAW-BYTES to buffer the string. Update charpos by
 493 ;;; checking to see where the last newline was.
 494 ;;;
 495 ;;; Note: some bozos (the FASL dumper) call write-string with things
 496 ;;; other than strings. Therefore, we must make sure we have a string
 497 ;;; before calling POSITION on it.
 498 ;;; KLUDGE: It would be better to fix the bozos instead of trying to
 499 ;;; cover for them here. -- WHN 20000203
 500 (defun fd-sout (stream thing start end)
 501   (let ((start (or start 0))
 502         (end (or end (length (the vector thing)))))
 503     (declare (fixnum start end))
 504     (if (stringp thing)
 505         (let ((last-newline
 506                (string-dispatch (simple-base-string
 507                                  #!+sb-unicode
 508                                  (simple-array character)
 509                                  string)
 510                    thing
 511                  (and (find #\newline thing :start start :end end)
 512                       ;; FIXME why do we need both calls?
 513                       ;; Is find faster forwards than
 514                       ;; position is backwards?
 515                       (position #\newline thing
 516                                 :from-end t
 517                                 :start start
 518                                 :end end)))))
 519           (if (and (typep thing 'base-string)
 520                    (eq (fd-stream-external-format stream) :latin-1))
 521               (ecase (fd-stream-buffering stream)
 522                 (:full
 523                  (output-raw-bytes stream thing start end))
 524                 (:line
 525                  (output-raw-bytes stream thing start end)
 526                  (when last-newline
 527                    (flush-output-buffer stream)))
 528                 (:none
 529                  (frob-output stream thing start end nil)))
 530               (ecase (fd-stream-buffering stream)
 531                 (:full (funcall (fd-stream-output-bytes stream)
 532                                 stream thing nil start end))
 533                 (:line (funcall (fd-stream-output-bytes stream)
 534                                 stream thing last-newline start end))
 535                 (:none (funcall (fd-stream-output-bytes stream)
 536                                 stream thing t start end))))
 537           (if last-newline
 538               (setf (fd-stream-char-pos stream)
 539                     (- end last-newline 1))
 540               (incf (fd-stream-char-pos stream)
 541                     (- end start))))
 542         (ecase (fd-stream-buffering stream)
 543           ((:line :full)
 544            (output-raw-bytes stream thing start end))
 545           (:none
 546            (frob-output stream thing start end nil))))))
 547
 548 (defvar *external-formats* ()
 549   #!+sb-doc
 550   "List of all available external formats. Each element is a list of the
 551   element-type, string input function name, character input function name,
 552   and string output function name.")
 553
 554 ;;; Find an output routine to use given the type and buffering. Return
 555 ;;; as multiple values the routine, the real type transfered, and the
 556 ;;; number of bytes per element.
 557 (defun pick-output-routine (type buffering &optional external-format)
 558   (when (subtypep type 'character)
 559     (dolist (entry *external-formats*)
 560       (when (member external-format (first entry))
 561         (return-from pick-output-routine
 562           (values (symbol-function (nth (ecase buffering
 563                                           (:none 4)
 564                                           (:line 5)
 565                                           (:full 6))
 566                                         entry))
 567                   'character
 568                   1
 569                   (symbol-function (fourth entry))
 570                   (first (first entry)))))))
 571   (dolist (entry *output-routines*)
 572     (when (and (subtypep type (first entry))
 573                (eq buffering (second entry))
 574                (or (not (fifth entry))
 575                    (eq external-format (fifth entry))))
 576       (return-from pick-output-routine
 577         (values (symbol-function (third entry))
 578                 (first entry)
 579                 (fourth entry)))))
 580   ;; KLUDGE: dealing with the buffering here leads to excessive code
 581   ;; explosion.
 582   ;;
 583   ;; KLUDGE: also see comments in PICK-INPUT-ROUTINE
 584   (loop for i from 40 by 8 to 1024 ; ARB (KLUDGE)
 585         if (subtypep type `(unsigned-byte ,i))
 586         do (return-from pick-output-routine
 587              (values
 588               (ecase buffering
 589                 (:none
 590                  (lambda (stream byte)
 591                    (output-wrapper (stream (/ i 8) (:none) nil)
 592                      (loop for j from 0 below (/ i 8)
 593                            do (setf (sap-ref-8
 594                                      (fd-stream-obuf-sap stream)
 595                                      (+ j (fd-stream-obuf-tail stream)))
 596                                     (ldb (byte 8 (- i 8 (* j 8))) byte))))))
 597                 (:full
 598                  (lambda (stream byte)
 599                    (output-wrapper (stream (/ i 8) (:full) nil)
 600                      (loop for j from 0 below (/ i 8)
 601                            do (setf (sap-ref-8
 602                                      (fd-stream-obuf-sap stream)
 603                                      (+ j (fd-stream-obuf-tail stream)))
 604                                     (ldb (byte 8 (- i 8 (* j 8))) byte)))))))
 605               `(unsigned-byte ,i)
 606               (/ i 8))))
 607   (loop for i from 40 by 8 to 1024 ; ARB (KLUDGE)
 608         if (subtypep type `(signed-byte ,i))
 609         do (return-from pick-output-routine
 610              (values
 611               (ecase buffering
 612                 (:none
 613                  (lambda (stream byte)
 614                    (output-wrapper (stream (/ i 8) (:none) nil)
 615                      (loop for j from 0 below (/ i 8)
 616                            do (setf (sap-ref-8
 617                                      (fd-stream-obuf-sap stream)
 618                                      (+ j (fd-stream-obuf-tail stream)))
 619                                     (ldb (byte 8 (- i 8 (* j 8))) byte))))))
 620                 (:full
 621                  (lambda (stream byte)
 622                    (output-wrapper (stream (/ i 8) (:full) nil)
 623                      (loop for j from 0 below (/ i 8)
 624                            do (setf (sap-ref-8
 625                                      (fd-stream-obuf-sap stream)
 626                                      (+ j (fd-stream-obuf-tail stream)))
 627                                     (ldb (byte 8 (- i 8 (* j 8))) byte)))))))
 628               `(signed-byte ,i)
 629               (/ i 8)))))
 630 \f
 631 ;;;; input routines and related noise
 632
 633 ;;; a list of all available input routines. Each element is a list of
 634 ;;; the element-type input, the function name, and the number of bytes
 635 ;;; per element.
 636 (defvar *input-routines* ())
 637
 638 ;;; Fill the input buffer, and return the number of bytes read. Throw
 639 ;;; to EOF-INPUT-CATCHER if the eof was reached. Drop into
 640 ;;; SYSTEM:SERVER if necessary.
 641 (defun refill-buffer/fd (stream)
 642   (let ((fd (fd-stream-fd stream))
 643         (ibuf-sap (fd-stream-ibuf-sap stream))
 644         (buflen (fd-stream-ibuf-length stream))
 645         (head (fd-stream-ibuf-head stream))
 646         (tail (fd-stream-ibuf-tail stream)))
 647     (declare (type index head tail))
 648     (unless (zerop head)
 649       (cond ((eql head tail)
 650              (setf head 0)
 651              (setf tail 0)
 652              (setf (fd-stream-ibuf-head stream) 0)
 653              (setf (fd-stream-ibuf-tail stream) 0))
 654             (t
 655              (decf tail head)
 656              (system-area-ub8-copy ibuf-sap head
 657                                    ibuf-sap 0 tail)
 658              (setf head 0)
 659              (setf (fd-stream-ibuf-head stream) 0)
 660              (setf (fd-stream-ibuf-tail stream) tail))))
 661     (setf (fd-stream-listen stream) nil)
 662     (sb!unix:with-restarted-syscall (count errno)
 663       ;; FIXME: Judging from compiler warnings, this WITH-ALIEN form expands
 664       ;; into something which uses the not-yet-defined type
 665       ;;   (SB!ALIEN-INTERNALS:ALIEN (* (SB!ALIEN:STRUCT SB!UNIX:FD-SET))).
 666       ;; This is probably inefficient and unsafe and generally bad, so
 667       ;; try to find some way to make that type known before
 668       ;; this is compiled.
 669       (sb!alien:with-alien ((read-fds (sb!alien:struct sb!unix:fd-set)))
 670         (sb!unix:fd-zero read-fds)
 671         (sb!unix:fd-set fd read-fds)
 672         (sb!unix:unix-fast-select (1+ fd)
 673                                   (sb!alien:addr read-fds)
 674                                   nil nil 0 0))
 675       (case count
 676         (1)
 677         (0
 678          (unless (sb!sys:wait-until-fd-usable
 679                   fd :input (fd-stream-timeout stream))
 680            (error 'io-timeout :stream stream :direction :read)))
 681         (t
 682          (simple-stream-perror "couldn't check whether ~S is readable"
 683                                stream
 684                                errno))))
 685     (multiple-value-bind (count errno)
 686         (sb!unix:unix-read fd
 687                            (sb!sys:int-sap (+ (sb!sys:sap-int ibuf-sap) tail))
 688                            (- buflen tail))
 689       (cond ((null count)
 690              (if #!-win32 (eql errno sb!unix:ewouldblock) #!+win32 t #!-win32
 691                  (progn
 692                    (unless (sb!sys:wait-until-fd-usable
 693                             fd :input (fd-stream-timeout stream))
 694                      (error 'io-timeout :stream stream :direction :read))
 695                    (refill-buffer/fd stream))
 696                  (simple-stream-perror "couldn't read from ~S" stream errno)))
 697             ((zerop count)
 698              (setf (fd-stream-listen stream) :eof)
 699              (/show0 "THROWing EOF-INPUT-CATCHER")
 700              (throw 'eof-input-catcher nil))
 701             (t
 702              (incf (fd-stream-ibuf-tail stream) count)
 703              count)))))
 704
 705 ;;; Make sure there are at least BYTES number of bytes in the input
 706 ;;; buffer. Keep calling REFILL-BUFFER/FD until that condition is met.
 707 (defmacro input-at-least (stream bytes)
 708   (let ((stream-var (gensym))
 709         (bytes-var (gensym)))
 710     `(let ((,stream-var ,stream)
 711            (,bytes-var ,bytes))
 712        (loop
 713          (when (>= (- (fd-stream-ibuf-tail ,stream-var)
 714                       (fd-stream-ibuf-head ,stream-var))
 715                    ,bytes-var)
 716            (return))
 717          (refill-buffer/fd ,stream-var)))))
 718
 719 (defmacro input-wrapper/variable-width ((stream bytes eof-error eof-value)
 720                                         &body read-forms)
 721   (let ((stream-var (gensym))
 722         (retry-var (gensym))
 723         (element-var (gensym)))
 724     `(let ((,stream-var ,stream)
 725            (size nil))
 726        (if (fd-stream-unread ,stream-var)
 727            (prog1
 728                (fd-stream-unread ,stream-var)
 729              (setf (fd-stream-unread ,stream-var) nil)
 730              (setf (fd-stream-listen ,stream-var) nil))
 731            (let ((,element-var nil)
 732                  (decode-break-reason nil))
 733              (do ((,retry-var t))
 734                  ((not ,retry-var))
 735                (unless
 736                    (catch 'eof-input-catcher
 737                      (setf decode-break-reason
 738                            (block decode-break-reason
 739                              (input-at-least ,stream-var 1)
 740                              (let* ((byte (sap-ref-8 (fd-stream-ibuf-sap
 741                                                       ,stream-var)
 742                                                      (fd-stream-ibuf-head
 743                                                       ,stream-var))))
 744                                (setq size ,bytes)
 745                                (input-at-least ,stream-var size)
 746                                (setq ,element-var (locally ,@read-forms))
 747                                (setq ,retry-var nil))
 748                              nil))
 749                      (when decode-break-reason
 750                        (stream-decoding-error-and-handle stream
 751                                                          decode-break-reason))
 752                      t)
 753                  (let ((octet-count (- (fd-stream-ibuf-tail ,stream-var)
 754                                       (fd-stream-ibuf-head ,stream-var))))
 755                    (when (or (zerop octet-count)
 756                              (and (not ,element-var)
 757                                   (not decode-break-reason)
 758                                   (stream-decoding-error-and-handle
 759                                    stream octet-count)))
 760                      (setq ,retry-var nil)))))
 761              (cond (,element-var
 762                     (incf (fd-stream-ibuf-head ,stream-var) size)
 763                     ,element-var)
 764                    (t
 765                     (eof-or-lose ,stream-var ,eof-error ,eof-value))))))))
 766
 767 ;;; a macro to wrap around all input routines to handle EOF-ERROR noise
 768 (defmacro input-wrapper ((stream bytes eof-error eof-value) &body read-forms)
 769   (let ((stream-var (gensym))
 770         (element-var (gensym)))
 771     `(let ((,stream-var ,stream))
 772        (if (fd-stream-unread ,stream-var)
 773            (prog1
 774                (fd-stream-unread ,stream-var)
 775              (setf (fd-stream-unread ,stream-var) nil)
 776              (setf (fd-stream-listen ,stream-var) nil))
 777            (let ((,element-var
 778                   (catch 'eof-input-catcher
 779                     (input-at-least ,stream-var ,bytes)
 780                     (locally ,@read-forms))))
 781              (cond (,element-var
 782                     (incf (fd-stream-ibuf-head ,stream-var) ,bytes)
 783                     ,element-var)
 784                    (t
 785                     (eof-or-lose ,stream-var ,eof-error ,eof-value))))))))
 786
 787 (defmacro def-input-routine/variable-width (name
 788                                             (type external-format size sap head)
 789                                             &rest body)
 790   `(progn
 791      (defun ,name (stream eof-error eof-value)
 792        (input-wrapper/variable-width (stream ,size eof-error eof-value)
 793          (let ((,sap (fd-stream-ibuf-sap stream))
 794                (,head (fd-stream-ibuf-head stream)))
 795            ,@body)))
 796      (setf *input-routines*
 797            (nconc *input-routines*
 798                   (list (list ',type ',name 1 ',external-format))))))
 799
 800 (defmacro def-input-routine (name
 801                              (type size sap head)
 802                              &rest body)
 803   `(progn
 804      (defun ,name (stream eof-error eof-value)
 805        (input-wrapper (stream ,size eof-error eof-value)
 806          (let ((,sap (fd-stream-ibuf-sap stream))
 807                (,head (fd-stream-ibuf-head stream)))
 808            ,@body)))
 809      (setf *input-routines*
 810            (nconc *input-routines*
 811                   (list (list ',type ',name ',size nil))))))
 812
 813 ;;; STREAM-IN routine for reading a string char
 814 (def-input-routine input-character
 815                    (character 1 sap head)
 816   (code-char (sap-ref-8 sap head)))
 817
 818 ;;; STREAM-IN routine for reading an unsigned 8 bit number
 819 (def-input-routine input-unsigned-8bit-byte
 820                    ((unsigned-byte 8) 1 sap head)
 821   (sap-ref-8 sap head))
 822
 823 ;;; STREAM-IN routine for reading a signed 8 bit number
 824 (def-input-routine input-signed-8bit-number
 825                    ((signed-byte 8) 1 sap head)
 826   (signed-sap-ref-8 sap head))
 827
 828 ;;; STREAM-IN routine for reading an unsigned 16 bit number
 829 (def-input-routine input-unsigned-16bit-byte
 830                    ((unsigned-byte 16) 2 sap head)
 831   (sap-ref-16 sap head))
 832
 833 ;;; STREAM-IN routine for reading a signed 16 bit number
 834 (def-input-routine input-signed-16bit-byte
 835                    ((signed-byte 16) 2 sap head)
 836   (signed-sap-ref-16 sap head))
 837
 838 ;;; STREAM-IN routine for reading a unsigned 32 bit number
 839 (def-input-routine input-unsigned-32bit-byte
 840                    ((unsigned-byte 32) 4 sap head)
 841   (sap-ref-32 sap head))
 842
 843 ;;; STREAM-IN routine for reading a signed 32 bit number
 844 (def-input-routine input-signed-32bit-byte
 845                    ((signed-byte 32) 4 sap head)
 846   (signed-sap-ref-32 sap head))
 847
 848
 849
 850 ;;; Find an input routine to use given the type. Return as multiple
 851 ;;; values the routine, the real type transfered, and the number of
 852 ;;; bytes per element (and for character types string input routine).
 853 (defun pick-input-routine (type &optional external-format)
 854   (when (subtypep type 'character)
 855     (dolist (entry *external-formats*)
 856       (when (member external-format (first entry))
 857         (return-from pick-input-routine
 858           (values (symbol-function (third entry))
 859                   'character
 860                   1
 861                   (symbol-function (second entry))
 862                   (first (first entry)))))))
 863   (dolist (entry *input-routines*)
 864     (when (and (subtypep type (first entry))
 865                (or (not (fourth entry))
 866                    (eq external-format (fourth entry))))
 867       (return-from pick-input-routine
 868         (values (symbol-function (second entry))
 869                 (first entry)
 870                 (third entry)))))
 871   ;; FIXME: let's do it the hard way, then (but ignore things like
 872   ;; endianness, efficiency, and the necessary coupling between these
 873   ;; and the output routines).  -- CSR, 2004-02-09
 874   (loop for i from 40 by 8 to 1024 ; ARB (well, KLUDGE really)
 875         if (subtypep type `(unsigned-byte ,i))
 876         do (return-from pick-input-routine
 877              (values
 878               (lambda (stream eof-error eof-value)
 879                 (input-wrapper (stream (/ i 8) eof-error eof-value)
 880                   (let ((sap (fd-stream-ibuf-sap stream))
 881                         (head (fd-stream-ibuf-head stream)))
 882                     (loop for j from 0 below (/ i 8)
 883                           with result = 0
 884                           do (setf result
 885                                    (+ (* 256 result)
 886                                       (sap-ref-8 sap (+ head j))))
 887                           finally (return result)))))
 888               `(unsigned-byte ,i)
 889               (/ i 8))))
 890   (loop for i from 40 by 8 to 1024 ; ARB (well, KLUDGE really)
 891         if (subtypep type `(signed-byte ,i))
 892         do (return-from pick-input-routine
 893              (values
 894               (lambda (stream eof-error eof-value)
 895                 (input-wrapper (stream (/ i 8) eof-error eof-value)
 896                   (let ((sap (fd-stream-ibuf-sap stream))
 897                         (head (fd-stream-ibuf-head stream)))
 898                     (loop for j from 0 below (/ i 8)
 899                           with result = 0
 900                           do (setf result
 901                                    (+ (* 256 result)
 902                                       (sap-ref-8 sap (+ head j))))
 903                           finally (return (if (logbitp (1- i) result)
 904                                               (dpb result (byte i 0) -1)
 905                                               result))))))
 906               `(signed-byte ,i)
 907               (/ i 8)))))
 908
 909 ;;; Return a string constructed from SAP, START, and END.
 910 (defun string-from-sap (sap start end)
 911   (declare (type index start end))
 912   (let* ((length (- end start))
 913          (string (make-string length)))
 914     (copy-ub8-from-system-area sap start
 915                                string 0
 916                                length)
 917     string))
 918
 919 ;;; the N-BIN method for FD-STREAMs
 920 ;;;
 921 ;;; Note that this blocks in UNIX-READ. It is generally used where
 922 ;;; there is a definite amount of reading to be done, so blocking
 923 ;;; isn't too problematical.
 924 (defun fd-stream-read-n-bytes (stream buffer start requested eof-error-p
 925                                &aux (total-copied 0))
 926   (declare (type fd-stream stream))
 927   (declare (type index start requested total-copied))
 928   (let ((unread (fd-stream-unread stream)))
 929     (when unread
 930       ;; AVERs designed to fail when we have more complicated
 931       ;; character representations.
 932       (aver (typep unread 'base-char))
 933       (aver (= (fd-stream-element-size stream) 1))
 934       ;; KLUDGE: this is a slightly-unrolled-and-inlined version of
 935       ;; %BYTE-BLT
 936       (etypecase buffer
 937         (system-area-pointer
 938          (setf (sap-ref-8 buffer start) (char-code unread)))
 939         ((simple-unboxed-array (*))
 940          (setf (aref buffer start) unread)))
 941       (setf (fd-stream-unread stream) nil)
 942       (setf (fd-stream-listen stream) nil)
 943       (incf total-copied)))
 944   (do ()
 945       (nil)
 946     (let* ((remaining-request (- requested total-copied))
 947            (head (fd-stream-ibuf-head stream))
 948            (tail (fd-stream-ibuf-tail stream))
 949            (available (- tail head))
 950            (n-this-copy (min remaining-request available))
 951            (this-start (+ start total-copied))
 952            (this-end (+ this-start n-this-copy))
 953            (sap (fd-stream-ibuf-sap stream)))
 954       (declare (type index remaining-request head tail available))
 955       (declare (type index n-this-copy))
 956       ;; Copy data from stream buffer into user's buffer.
 957       (%byte-blt sap head buffer this-start this-end)
 958       (incf (fd-stream-ibuf-head stream) n-this-copy)
 959       (incf total-copied n-this-copy)
 960       ;; Maybe we need to refill the stream buffer.
 961       (cond (;; If there were enough data in the stream buffer, we're done.
 962              (= total-copied requested)
 963              (return total-copied))
 964             (;; If EOF, we're done in another way.
 965              (null (catch 'eof-input-catcher (refill-buffer/fd stream)))
 966              (if eof-error-p
 967                  (error 'end-of-file :stream stream)
 968                  (return total-copied)))
 969             ;; Otherwise we refilled the stream buffer, so fall
 970             ;; through into another pass of the loop.
 971             ))))
 972
 973 (defun fd-stream-resync (stream)
 974   (dolist (entry *external-formats*)
 975     (when (member (fd-stream-external-format stream) (first entry))
 976       (return-from fd-stream-resync
 977         (funcall (symbol-function (eighth entry)) stream)))))
 978
 979 (defun get-fd-stream-character-sizer (stream)
 980   (dolist (entry *external-formats*)
 981     (when (member (fd-stream-external-format stream) (first entry))
 982       (return-from get-fd-stream-character-sizer (ninth entry)))))
 983
 984 (defun fd-stream-character-size (stream char)
 985   (let ((sizer (get-fd-stream-character-sizer stream)))
 986     (when sizer (funcall sizer char))))
 987
 988 (defun fd-stream-string-size (stream string)
 989   (let ((sizer (get-fd-stream-character-sizer stream)))
 990     (when sizer
 991       (loop for char across string summing (funcall sizer char)))))
 992
 993 ;;; FIXME: OAOOM here vrt. *EXTERNAL-FORMAT-FUNCTIONS* in fd-stream.lisp
 994 (defmacro define-external-format (external-format size output-restart
 995                                   out-expr in-expr)
 996   (let* ((name (first external-format))
 997          (out-function (symbolicate "OUTPUT-BYTES/" name))
 998          (format (format nil "OUTPUT-CHAR-~A-~~A-BUFFERED" (string name)))
 999          (in-function (symbolicate "FD-STREAM-READ-N-CHARACTERS/" name))
1000          (in-char-function (symbolicate "INPUT-CHAR/" name))
1001          (size-function (symbolicate "BYTES-FOR-CHAR/" name)))
1002     `(progn
1003       (defun ,size-function (byte)
1004         (declare (ignore byte))
1005         ,size)
1006       (defun ,out-function (stream string flush-p start end)
1007         (let ((start (or start 0))
1008               (end (or end (length string))))
1009           (declare (type index start end))
1010           (when (and (not (fd-stream-dual-channel-p stream))
1011                      (> (fd-stream-ibuf-tail stream)
1012                         (fd-stream-ibuf-head stream)))
1013             (file-position stream (file-position stream)))
1014           (unless (<= 0 start end (length string))
1015             (signal-bounding-indices-bad-error string start end))
1016           (do ()
1017               ((= end start))
1018             (setf (fd-stream-obuf-tail stream)
1019                   (string-dispatch (simple-base-string
1020                                     #!+sb-unicode
1021                                     (simple-array character)
1022                                     string)
1023                       string
1024                     (let ((len (fd-stream-obuf-length stream))
1025                           (sap (fd-stream-obuf-sap stream))
1026                           (tail (fd-stream-obuf-tail stream)))
1027                       (declare (type index tail)
1028                                ;; STRING bounds have already been checked.
1029                                (optimize (safety 0)))
1030                       (loop
1031                          (,@(if output-restart
1032                                 `(catch 'output-nothing)
1033                                 `(progn))
1034                             (do* ()
1035                                  ((or (= start end) (< (- len tail) 4)))
1036                               (let* ((byte (aref string start))
1037                                      (bits (char-code byte)))
1038                                 ,out-expr
1039                                 (incf tail ,size)
1040                                 (incf start)))
1041                             ;; Exited from the loop normally
1042                             (return tail))
1043                          ;; Exited via CATCH. Skip the current character
1044                          ;; and try the inner loop again.
1045                          (incf start)))))
1046             (when (< start end)
1047               (flush-output-buffer stream)))
1048           (when flush-p
1049             (flush-output-buffer stream))))
1050       (def-output-routines (,format
1051                             ,size
1052                             ,output-restart
1053                             (:none character)
1054                             (:line character)
1055                             (:full character))
1056           (if (char= byte #\Newline)
1057               (setf (fd-stream-char-pos stream) 0)
1058               (incf (fd-stream-char-pos stream)))
1059         (let ((bits (char-code byte))
1060               (sap (fd-stream-obuf-sap stream))
1061               (tail (fd-stream-obuf-tail stream)))
1062           ,out-expr))
1063       (defun ,in-function (stream buffer start requested eof-error-p
1064                            &aux (index start) (end (+ start requested)))
1065         (declare (type fd-stream stream))
1066         (declare (type index start requested index end))
1067         (declare (type (simple-array character (#.+ansi-stream-in-buffer-length+)) buffer))
1068         (let ((unread (fd-stream-unread stream)))
1069           (when unread
1070             (setf (aref buffer index) unread)
1071             (setf (fd-stream-unread stream) nil)
1072             (setf (fd-stream-listen stream) nil)
1073             (incf index)))
1074         (do ()
1075             (nil)
1076           (let* ((head (fd-stream-ibuf-head stream))
1077                  (tail (fd-stream-ibuf-tail stream))
1078                  (sap (fd-stream-ibuf-sap stream)))
1079             (declare (type index head tail)
1080                      (type system-area-pointer sap))
1081             ;; Copy data from stream buffer into user's buffer.
1082             (dotimes (i (min (truncate (- tail head) ,size)
1083                              (- end index)))
1084               (declare (optimize speed))
1085               (let* ((byte (sap-ref-8 sap head)))
1086                 (setf (aref buffer index) ,in-expr)
1087                 (incf index)
1088                 (incf head ,size)))
1089             (setf (fd-stream-ibuf-head stream) head)
1090             ;; Maybe we need to refill the stream buffer.
1091             (cond ( ;; If there was enough data in the stream buffer, we're done.
1092                    (= index end)
1093                    (return (- index start)))
1094                   ( ;; If EOF, we're done in another way.
1095                    (null (catch 'eof-input-catcher (refill-buffer/fd stream)))
1096                    (if eof-error-p
1097                        (error 'end-of-file :stream stream)
1098                        (return (- index start))))
1099                   ;; Otherwise we refilled the stream buffer, so fall
1100                   ;; through into another pass of the loop.
1101                   ))))
1102       (def-input-routine ,in-char-function (character ,size sap head)
1103         (let ((byte (sap-ref-8 sap head)))
1104           ,in-expr))
1105       (setf *external-formats*
1106        (cons '(,external-format ,in-function ,in-char-function ,out-function
1107                ,@(mapcar #'(lambda (buffering)
1108                              (intern (format nil format (string buffering))))
1109                          '(:none :line :full))
1110                nil ; no resync-function
1111                ,size-function)
1112         *external-formats*)))))
1113
1114 (defmacro define-external-format/variable-width
1115     (external-format output-restart out-size-expr
1116      out-expr in-size-expr in-expr)
1117   (let* ((name (first external-format))
1118          (out-function (symbolicate "OUTPUT-BYTES/" name))
1119          (format (format nil "OUTPUT-CHAR-~A-~~A-BUFFERED" (string name)))
1120          (in-function (symbolicate "FD-STREAM-READ-N-CHARACTERS/" name))
1121          (in-char-function (symbolicate "INPUT-CHAR/" name))
1122          (resync-function (symbolicate "RESYNC/" name))
1123          (size-function (symbolicate "BYTES-FOR-CHAR/" name)))
1124     `(progn
1125       (defun ,size-function (byte)
1126         ,out-size-expr)
1127       (defun ,out-function (stream string flush-p start end)
1128         (let ((start (or start 0))
1129               (end (or end (length string))))
1130           (declare (type index start end))
1131           (when (and (not (fd-stream-dual-channel-p stream))
1132                      (> (fd-stream-ibuf-tail stream)
1133                         (fd-stream-ibuf-head stream)))
1134             (file-position stream (file-position stream)))
1135           (unless (<= 0 start end (length string))
1136             (signal-bounding-indices-bad-error string start end))
1137           (do ()
1138               ((= end start))
1139             (setf (fd-stream-obuf-tail stream)
1140                   (string-dispatch (simple-base-string
1141                                     #!+sb-unicode
1142                                     (simple-array character)
1143                                     string)
1144                       string
1145                     (let ((len (fd-stream-obuf-length stream))
1146                           (sap (fd-stream-obuf-sap stream))
1147                           (tail (fd-stream-obuf-tail stream)))
1148                       (declare (type index tail)
1149                                ;; STRING bounds have already been checked.
1150                                (optimize (safety 0)))
1151                       (loop
1152                          (,@(if output-restart
1153                                 `(catch 'output-nothing)
1154                                 `(progn))
1155                             (do* ()
1156                                  ((or (= start end) (< (- len tail) 4)))
1157                               (let* ((byte (aref string start))
1158                                      (bits (char-code byte))
1159                                      (size ,out-size-expr))
1160                                 ,out-expr
1161                                 (incf tail size)
1162                                 (incf start)))
1163                             ;; Exited from the loop normally
1164                             (return tail))
1165                          ;; Exited via CATCH. Skip the current character
1166                          ;; and try the inner loop again.
1167                          (incf start)))))
1168             (when (< start end)
1169               (flush-output-buffer stream)))
1170           (when flush-p
1171             (flush-output-buffer stream))))
1172       (def-output-routines/variable-width (,format
1173                                            ,out-size-expr
1174                                            ,output-restart
1175                                            ,external-format
1176                                            (:none character)
1177                                            (:line character)
1178                                            (:full character))
1179           (if (char= byte #\Newline)
1180               (setf (fd-stream-char-pos stream) 0)
1181               (incf (fd-stream-char-pos stream)))
1182         (let ((bits (char-code byte))
1183               (sap (fd-stream-obuf-sap stream))
1184               (tail (fd-stream-obuf-tail stream)))
1185           ,out-expr))
1186       (defun ,in-function (stream buffer start requested eof-error-p
1187                            &aux (total-copied 0))
1188         (declare (type fd-stream stream))
1189         (declare (type index start requested total-copied))
1190         (declare (type (simple-array character (#.+ansi-stream-in-buffer-length+)) buffer))
1191         (let ((unread (fd-stream-unread stream)))
1192           (when unread
1193             (setf (aref buffer start) unread)
1194             (setf (fd-stream-unread stream) nil)
1195             (setf (fd-stream-listen stream) nil)
1196             (incf total-copied)))
1197         (do ()
1198             (nil)
1199           (let* ((head (fd-stream-ibuf-head stream))
1200                  (tail (fd-stream-ibuf-tail stream))
1201                  (sap (fd-stream-ibuf-sap stream))
1202                  (decode-break-reason nil))
1203             (declare (type index head tail))
1204             ;; Copy data from stream buffer into user's buffer.
1205             (do ((size nil nil))
1206                 ((or (= tail head) (= requested total-copied)))
1207               (setf decode-break-reason
1208                     (block decode-break-reason
1209                       (let ((byte (sap-ref-8 sap head)))
1210                         (setq size ,in-size-expr)
1211                         (when (> size (- tail head))
1212                           (return))
1213                         (setf (aref buffer (+ start total-copied)) ,in-expr)
1214                         (incf total-copied)
1215                         (incf head size))
1216                       nil))
1217               (setf (fd-stream-ibuf-head stream) head)
1218               (when decode-break-reason
1219                 ;; If we've already read some characters on when the invalid
1220                 ;; code sequence is detected, we return immediately. The
1221                 ;; handling of the error is deferred until the next call
1222                 ;; (where this check will be false). This allows establishing
1223                 ;; high-level handlers for decode errors (for example
1224                 ;; automatically resyncing in Lisp comments).
1225                 (when (plusp total-copied)
1226                   (return-from ,in-function total-copied))
1227                 (when (stream-decoding-error-and-handle
1228                        stream decode-break-reason)
1229                   (if eof-error-p
1230                       (error 'end-of-file :stream stream)
1231                       (return-from ,in-function total-copied)))
1232                 (setf head (fd-stream-ibuf-head stream))
1233                 (setf tail (fd-stream-ibuf-tail stream))))
1234             (setf (fd-stream-ibuf-head stream) head)
1235             ;; Maybe we need to refill the stream buffer.
1236             (cond ( ;; If there were enough data in the stream buffer, we're done.
1237                    (= total-copied requested)
1238                    (return total-copied))
1239                   ( ;; If EOF, we're done in another way.
1240                    (or (eq decode-break-reason 'eof)
1241                        (null (catch 'eof-input-catcher
1242                                (refill-buffer/fd stream))))
1243                    (if eof-error-p
1244                        (error 'end-of-file :stream stream)
1245                        (return total-copied)))
1246                   ;; Otherwise we refilled the stream buffer, so fall
1247                   ;; through into another pass of the loop.
1248                   ))))
1249       (def-input-routine/variable-width ,in-char-function (character
1250                                                            ,external-format
1251                                                            ,in-size-expr
1252                                                            sap head)
1253         (let ((byte (sap-ref-8 sap head)))
1254           ,in-expr))
1255       (defun ,resync-function (stream)
1256         (loop (input-at-least stream 1)
1257               (incf (fd-stream-ibuf-head stream))
1258               (unless (block decode-break-reason
1259                         (let* ((sap (fd-stream-ibuf-sap stream))
1260                                (head (fd-stream-ibuf-head stream))
1261                                (byte (sap-ref-8 sap head))
1262                                (size ,in-size-expr))
1263                           ,in-expr)
1264                         nil)
1265                 (return))))
1266       (setf *external-formats*
1267        (cons '(,external-format ,in-function ,in-char-function ,out-function
1268                ,@(mapcar #'(lambda (buffering)
1269                              (intern (format nil format (string buffering))))
1270                          '(:none :line :full))
1271                ,resync-function
1272                ,size-function)
1273         *external-formats*)))))
1274
1275 ;;; Multiple names for the :ISO{,-}8859-* families are needed because on
1276 ;;; FreeBSD (and maybe other BSD systems), nl_langinfo("LATIN-1") will
1277 ;;; return "ISO8859-1" instead of "ISO-8859-1".
1278 (define-external-format (:latin-1 :latin1 :iso-8859-1 :iso8859-1)
1279     1 t
1280   (if (>= bits 256)
1281       (stream-encoding-error-and-handle stream bits)
1282       (setf (sap-ref-8 sap tail) bits))
1283   (code-char byte))
1284
1285 (define-external-format (:ascii :us-ascii :ansi_x3.4-1968
1286                          :iso-646 :iso-646-us :|646|)
1287     1 t
1288   (if (>= bits 128)
1289       (stream-encoding-error-and-handle stream bits)
1290       (setf (sap-ref-8 sap tail) bits))
1291   (code-char byte))
1292
1293 (let* ((table (let ((s (make-string 256)))
1294                 (map-into s #'code-char
1295                           '(#x00 #x01 #x02 #x03 #x9c #x09 #x86 #x7f #x97 #x8d #x8e #x0b #x0c #x0d #x0e #x0f
1296                             #x10 #x11 #x12 #x13 #x9d #x85 #x08 #x87 #x18 #x19 #x92 #x8f #x1c #x1d #x1e #x1f
1297                             #x80 #x81 #x82 #x83 #x84 #x0a #x17 #x1b #x88 #x89 #x8a #x8b #x8c #x05 #x06 #x07
1298                             #x90 #x91 #x16 #x93 #x94 #x95 #x96 #x04 #x98 #x99 #x9a #x9b #x14 #x15 #x9e #x1a
1299                             #x20 #xa0 #xe2 #xe4 #xe0 #xe1 #xe3 #xe5 #xe7 #xf1 #xa2 #x2e #x3c #x28 #x2b #x7c
1300                             #x26 #xe9 #xea #xeb #xe8 #xed #xee #xef #xec #xdf #x21 #x24 #x2a #x29 #x3b #xac
1301                             #x2d #x2f #xc2 #xc4 #xc0 #xc1 #xc3 #xc5 #xc7 #xd1 #xa6 #x2c #x25 #x5f #x3e #x3f
1302                             #xf8 #xc9 #xca #xcb #xc8 #xcd #xce #xcf #xcc #x60 #x3a #x23 #x40 #x27 #x3d #x22
1303                             #xd8 #x61 #x62 #x63 #x64 #x65 #x66 #x67 #x68 #x69 #xab #xbb #xf0 #xfd #xfe #xb1
1304                             #xb0 #x6a #x6b #x6c #x6d #x6e #x6f #x70 #x71 #x72 #xaa #xba #xe6 #xb8 #xc6 #xa4
1305                             #xb5 #x7e #x73 #x74 #x75 #x76 #x77 #x78 #x79 #x7a #xa1 #xbf #xd0 #xdd #xde #xae
1306                             #x5e #xa3 #xa5 #xb7 #xa9 #xa7 #xb6 #xbc #xbd #xbe #x5b #x5d #xaf #xa8 #xb4 #xd7
1307                             #x7b #x41 #x42 #x43 #x44 #x45 #x46 #x47 #x48 #x49 #xad #xf4 #xf6 #xf2 #xf3 #xf5
1308                             #x7d #x4a #x4b #x4c #x4d #x4e #x4f #x50 #x51 #x52 #xb9 #xfb #xfc #xf9 #xfa #xff
1309                             #x5c #xf7 #x53 #x54 #x55 #x56 #x57 #x58 #x59 #x5a #xb2 #xd4 #xd6 #xd2 #xd3 #xd5
1310                             #x30 #x31 #x32 #x33 #x34 #x35 #x36 #x37 #x38 #x39 #xb3 #xdb #xdc #xd9 #xda #x9f))
1311                 s))
1312        (reverse-table (let ((rt (make-array 256 :element-type '(unsigned-byte 8) :initial-element 0)))
1313                           (loop for char across table for i from 0
1314                                do (aver (= 0 (aref rt (char-code char))))
1315                                do (setf (aref rt (char-code char)) i))
1316                           rt)))
1317   (define-external-format (:ebcdic-us :ibm-037 :ibm037)
1318       1 t
1319     (if (>= bits 256)
1320         (stream-encoding-error-and-handle stream bits)
1321         (setf (sap-ref-8 sap tail) (aref reverse-table bits)))
1322     (aref table byte)))
1323
1324
1325 #!+sb-unicode
1326 (let ((latin-9-table (let ((table (make-string 256)))
1327                        (do ((i 0 (1+ i)))
1328                            ((= i 256))
1329                          (setf (aref table i) (code-char i)))
1330                        (setf (aref table #xa4) (code-char #x20ac))
1331                        (setf (aref table #xa6) (code-char #x0160))
1332                        (setf (aref table #xa8) (code-char #x0161))
1333                        (setf (aref table #xb4) (code-char #x017d))
1334                        (setf (aref table #xb8) (code-char #x017e))
1335                        (setf (aref table #xbc) (code-char #x0152))
1336                        (setf (aref table #xbd) (code-char #x0153))
1337                        (setf (aref table #xbe) (code-char #x0178))
1338                        table))
1339       (latin-9-reverse-1 (make-array 16
1340                                      :element-type '(unsigned-byte 21)
1341                                      :initial-contents '(#x0160 #x0161 #x0152 #x0153 0 0 0 0 #x0178 0 0 0 #x20ac #x017d #x017e 0)))
1342       (latin-9-reverse-2 (make-array 16
1343                                      :element-type '(unsigned-byte 8)
1344                                      :initial-contents '(#xa6 #xa8 #xbc #xbd 0 0 0 0 #xbe 0 0 0 #xa4 #xb4 #xb8 0))))
1345   (define-external-format (:latin-9 :latin9 :iso-8859-15 :iso8859-15)
1346       1 t
1347     (setf (sap-ref-8 sap tail)
1348           (if (< bits 256)
1349               (if (= bits (char-code (aref latin-9-table bits)))
1350                   bits
1351                   (stream-encoding-error-and-handle stream byte))
1352               (if (= (aref latin-9-reverse-1 (logand bits 15)) bits)
1353                   (aref latin-9-reverse-2 (logand bits 15))
1354                   (stream-encoding-error-and-handle stream byte))))
1355     (aref latin-9-table byte)))
1356
1357 (define-external-format/variable-width (:utf-8 :utf8) nil
1358   (let ((bits (char-code byte)))
1359     (cond ((< bits #x80) 1)
1360           ((< bits #x800) 2)
1361           ((< bits #x10000) 3)
1362           (t 4)))
1363   (ecase size
1364     (1 (setf (sap-ref-8 sap tail) bits))
1365     (2 (setf (sap-ref-8 sap tail) (logior #xc0 (ldb (byte 5 6) bits))
1366              (sap-ref-8 sap (1+ tail)) (logior #x80 (ldb (byte 6 0) bits))))
1367     (3 (setf (sap-ref-8 sap tail) (logior #xe0 (ldb (byte 4 12) bits))
1368              (sap-ref-8 sap (1+ tail)) (logior #x80 (ldb (byte 6 6) bits))
1369              (sap-ref-8 sap (+ 2 tail)) (logior #x80 (ldb (byte 6 0) bits))))
1370     (4 (setf (sap-ref-8 sap tail) (logior #xf0 (ldb (byte 3 18) bits))
1371              (sap-ref-8 sap (1+ tail)) (logior #x80 (ldb (byte 6 12) bits))
1372              (sap-ref-8 sap (+ 2 tail)) (logior #x80 (ldb (byte 6 6) bits))
1373              (sap-ref-8 sap (+ 3 tail)) (logior #x80 (ldb (byte 6 0) bits)))))
1374   (cond ((< byte #x80) 1)
1375         ((< byte #xc2) (return-from decode-break-reason 1))
1376         ((< byte #xe0) 2)
1377         ((< byte #xf0) 3)
1378         (t 4))
1379   (code-char (ecase size
1380                (1 byte)
1381                (2 (let ((byte2 (sap-ref-8 sap (1+ head))))
1382                     (unless (<= #x80 byte2 #xbf)
1383                       (return-from decode-break-reason 2))
1384                     (dpb byte (byte 5 6) byte2)))
1385                (3 (let ((byte2 (sap-ref-8 sap (1+ head)))
1386                         (byte3 (sap-ref-8 sap (+ 2 head))))
1387                     (unless (and (<= #x80 byte2 #xbf)
1388                                  (<= #x80 byte3 #xbf))
1389                       (return-from decode-break-reason 3))
1390                     (dpb byte (byte 4 12) (dpb byte2 (byte 6 6) byte3))))
1391                (4 (let ((byte2 (sap-ref-8 sap (1+ head)))
1392                         (byte3 (sap-ref-8 sap (+ 2 head)))
1393                         (byte4 (sap-ref-8 sap (+ 3 head))))
1394                     (unless (and (<= #x80 byte2 #xbf)
1395                                  (<= #x80 byte3 #xbf)
1396                                  (<= #x80 byte4 #xbf))
1397                       (return-from decode-break-reason 4))
1398                     (dpb byte (byte 3 18)
1399                          (dpb byte2 (byte 6 12)
1400                               (dpb byte3 (byte 6 6) byte4))))))))
1401 \f
1402 ;;;; utility functions (misc routines, etc)
1403
1404 ;;; Fill in the various routine slots for the given type. INPUT-P and
1405 ;;; OUTPUT-P indicate what slots to fill. The buffering slot must be
1406 ;;; set prior to calling this routine.
1407 (defun set-fd-stream-routines (fd-stream element-type external-format
1408                                input-p output-p buffer-p)
1409   (let* ((target-type (case element-type
1410                         (unsigned-byte '(unsigned-byte 8))
1411                         (signed-byte '(signed-byte 8))
1412                         (:default 'character)
1413                         (t element-type)))
1414          (character-stream-p (subtypep target-type 'character))
1415          (bivalent-stream-p (eq element-type :default))
1416          normalized-external-format
1417          (bin-routine #'ill-bin)
1418          (bin-type nil)
1419          (bin-size nil)
1420          (cin-routine #'ill-in)
1421          (cin-type nil)
1422          (cin-size nil)
1423          (input-type nil)           ;calculated from bin-type/cin-type
1424          (input-size nil)           ;calculated from bin-size/cin-size
1425          (read-n-characters #'ill-in)
1426          (bout-routine #'ill-bout)
1427          (bout-type nil)
1428          (bout-size nil)
1429          (cout-routine #'ill-out)
1430          (cout-type nil)
1431          (cout-size nil)
1432          (output-type nil)
1433          (output-size nil)
1434          (output-bytes #'ill-bout))
1435
1436     ;; drop buffers when direction changes
1437     (when (and (fd-stream-obuf-sap fd-stream) (not output-p))
1438       (with-available-buffers-lock ()
1439         (push (fd-stream-obuf-sap fd-stream) *available-buffers*)
1440         (setf (fd-stream-obuf-sap fd-stream) nil)))
1441     (when (and (fd-stream-ibuf-sap fd-stream) (not input-p))
1442       (with-available-buffers-lock ()
1443         (push (fd-stream-ibuf-sap fd-stream) *available-buffers*)
1444         (setf (fd-stream-ibuf-sap fd-stream) nil)))
1445     (when input-p
1446       (setf (fd-stream-ibuf-sap fd-stream) (next-available-buffer))
1447       (setf (fd-stream-ibuf-length fd-stream) bytes-per-buffer)
1448       (setf (fd-stream-ibuf-tail fd-stream) 0))
1449     (when output-p
1450       (setf (fd-stream-obuf-sap fd-stream) (next-available-buffer))
1451       (setf (fd-stream-obuf-length fd-stream) bytes-per-buffer)
1452       (setf (fd-stream-obuf-tail fd-stream) 0)
1453       (setf (fd-stream-char-pos fd-stream) 0))
1454
1455     (when (and character-stream-p
1456                (eq external-format :default))
1457       (/show0 "/getting default external format")
1458       (setf external-format (default-external-format)))
1459
1460     (when input-p
1461       (when (or (not character-stream-p) bivalent-stream-p)
1462         (multiple-value-setq (bin-routine bin-type bin-size read-n-characters
1463                                           normalized-external-format)
1464           (pick-input-routine (if bivalent-stream-p '(unsigned-byte 8)
1465                                   target-type)
1466                               external-format))
1467         (unless bin-routine
1468           (error "could not find any input routine for ~S" target-type)))
1469       (when character-stream-p
1470         (multiple-value-setq (cin-routine cin-type cin-size read-n-characters
1471                                           normalized-external-format)
1472           (pick-input-routine target-type external-format))
1473         (unless cin-routine
1474           (error "could not find any input routine for ~S" target-type)))
1475       (setf (fd-stream-in fd-stream) cin-routine
1476             (fd-stream-bin fd-stream) bin-routine)
1477       ;; character type gets preferential treatment
1478       (setf input-size (or cin-size bin-size))
1479       (setf input-type (or cin-type bin-type))
1480       (when normalized-external-format
1481         (setf (fd-stream-external-format fd-stream)
1482               normalized-external-format))
1483       (when (= (or cin-size 1) (or bin-size 1) 1)
1484         (setf (fd-stream-n-bin fd-stream) ;XXX
1485               (if (and character-stream-p (not bivalent-stream-p))
1486                   read-n-characters
1487                   #'fd-stream-read-n-bytes))
1488         ;; Sometimes turn on fast-read-char/fast-read-byte.  Switch on
1489         ;; for character and (unsigned-byte 8) streams.  In these
1490         ;; cases, fast-read-* will read from the
1491         ;; ansi-stream-(c)in-buffer, saving function calls.
1492         ;; Otherwise, the various data-reading functions in the stream
1493         ;; structure will be called.
1494         (when (and buffer-p
1495                    (not bivalent-stream-p)
1496                    ;; temporary disable on :io streams
1497                    (not output-p))
1498           (cond (character-stream-p
1499                  (setf (ansi-stream-cin-buffer fd-stream)
1500                        (make-array +ansi-stream-in-buffer-length+
1501                                    :element-type 'character)))
1502                 ((equal target-type '(unsigned-byte 8))
1503                  (setf (ansi-stream-in-buffer fd-stream)
1504                        (make-array +ansi-stream-in-buffer-length+
1505                                    :element-type '(unsigned-byte 8))))))))
1506
1507     (when output-p
1508       (when (or (not character-stream-p) bivalent-stream-p)
1509         (multiple-value-setq (bout-routine bout-type bout-size output-bytes
1510                                            normalized-external-format)
1511           (pick-output-routine (if bivalent-stream-p
1512                                    '(unsigned-byte 8)
1513                                    target-type)
1514                                (fd-stream-buffering fd-stream)
1515                                external-format))
1516         (unless bout-routine
1517           (error "could not find any output routine for ~S buffered ~S"
1518                  (fd-stream-buffering fd-stream)
1519                  target-type)))
1520       (when character-stream-p
1521         (multiple-value-setq (cout-routine cout-type cout-size output-bytes
1522                                            normalized-external-format)
1523           (pick-output-routine target-type
1524                                (fd-stream-buffering fd-stream)
1525                                external-format))
1526         (unless cout-routine
1527           (error "could not find any output routine for ~S buffered ~S"
1528                  (fd-stream-buffering fd-stream)
1529                  target-type)))
1530       (when normalized-external-format
1531         (setf (fd-stream-external-format fd-stream)
1532               normalized-external-format))
1533       (when character-stream-p
1534         (setf (fd-stream-output-bytes fd-stream) output-bytes))
1535       (setf (fd-stream-out fd-stream) cout-routine
1536             (fd-stream-bout fd-stream) bout-routine
1537             (fd-stream-sout fd-stream) (if (eql cout-size 1)
1538                                            #'fd-sout #'ill-out))
1539       (setf output-size (or cout-size bout-size))
1540       (setf output-type (or cout-type bout-type)))
1541
1542     (when (and input-size output-size
1543                (not (eq input-size output-size)))
1544       (error "Element sizes for input (~S:~S) and output (~S:~S) differ?"
1545              input-type input-size
1546              output-type output-size))
1547     (setf (fd-stream-element-size fd-stream)
1548           (or input-size output-size))
1549
1550     (setf (fd-stream-element-type fd-stream)
1551           (cond ((equal input-type output-type)
1552                  input-type)
1553                 ((null output-type)
1554                  input-type)
1555                 ((null input-type)
1556                  output-type)
1557                 ((subtypep input-type output-type)
1558                  input-type)
1559                 ((subtypep output-type input-type)
1560                  output-type)
1561                 (t
1562                  (error "Input type (~S) and output type (~S) are unrelated?"
1563                         input-type
1564                         output-type))))))
1565
1566 ;;; Handle miscellaneous operations on FD-STREAM.
1567 (defun fd-stream-misc-routine (fd-stream operation &optional arg1 arg2)
1568   (declare (ignore arg2))
1569   (case operation
1570     (:listen
1571      (or (not (eql (fd-stream-ibuf-head fd-stream)
1572                    (fd-stream-ibuf-tail fd-stream)))
1573          (fd-stream-listen fd-stream)
1574          (setf (fd-stream-listen fd-stream)
1575                (eql (sb!unix:with-restarted-syscall ()
1576                       (sb!alien:with-alien ((read-fds (sb!alien:struct
1577                                                        sb!unix:fd-set)))
1578                         (sb!unix:fd-zero read-fds)
1579                         (sb!unix:fd-set (fd-stream-fd fd-stream) read-fds)
1580                         (sb!unix:unix-fast-select (1+ (fd-stream-fd fd-stream))
1581                                                   (sb!alien:addr read-fds)
1582                                                   nil nil 0 0)))
1583                     1))))
1584     (:unread
1585      (setf (fd-stream-unread fd-stream) arg1)
1586      (setf (fd-stream-listen fd-stream) t))
1587     (:close
1588      (cond (arg1 ; We got us an abort on our hands.
1589             (when (fd-stream-handler fd-stream)
1590               (sb!sys:remove-fd-handler (fd-stream-handler fd-stream))
1591               (setf (fd-stream-handler fd-stream) nil))
1592             ;; We can't do anything unless we know what file were
1593             ;; dealing with, and we don't want to do anything
1594             ;; strange unless we were writing to the file.
1595             (when (and (fd-stream-file fd-stream)
1596                        (fd-stream-obuf-sap fd-stream))
1597               (if (fd-stream-original fd-stream)
1598                   ;; If the original is EQ to file we are appending
1599                   ;; and can just close the file without renaming.
1600                   (unless (eq (fd-stream-original fd-stream)
1601                               (fd-stream-file fd-stream))
1602                     ;; We have a handle on the original, just revert.
1603                     (multiple-value-bind (okay err)
1604                         (sb!unix:unix-rename (fd-stream-original fd-stream)
1605                                              (fd-stream-file fd-stream))
1606                       (unless okay
1607                         (simple-stream-perror
1608                          "couldn't restore ~S to its original contents"
1609                          fd-stream
1610                          err))))
1611                   ;; We can't restore the original, and aren't
1612                   ;; appending, so nuke that puppy.
1613                   ;;
1614                   ;; FIXME: This is currently the fate of superseded
1615                   ;; files, and according to the CLOSE spec this is
1616                   ;; wrong. However, there seems to be no clean way to
1617                   ;; do that that doesn't involve either copying the
1618                   ;; data (bad if the :abort resulted from a full
1619                   ;; disk), or renaming the old file temporarily
1620                   ;; (probably bad because stream opening becomes more
1621                   ;; racy).
1622                   (multiple-value-bind (okay err)
1623                       (sb!unix:unix-unlink (fd-stream-file fd-stream))
1624                     (unless okay
1625                       (error 'simple-file-error
1626                              :pathname (fd-stream-file fd-stream)
1627                              :format-control
1628                              "~@<couldn't remove ~S: ~2I~_~A~:>"
1629                              :format-arguments (list (fd-stream-file fd-stream)
1630                                                      (strerror err))))))))
1631            (t
1632             (fd-stream-misc-routine fd-stream :finish-output)
1633             (when (and (fd-stream-original fd-stream)
1634                        (fd-stream-delete-original fd-stream))
1635               (multiple-value-bind (okay err)
1636                   (sb!unix:unix-unlink (fd-stream-original fd-stream))
1637                 (unless okay
1638                   (error 'simple-file-error
1639                          :pathname (fd-stream-original fd-stream)
1640                          :format-control
1641                          "~@<couldn't delete ~S during close of ~S: ~
1642                           ~2I~_~A~:>"
1643                          :format-arguments
1644                          (list (fd-stream-original fd-stream)
1645                                fd-stream
1646                                (strerror err))))))))
1647      (when (fboundp 'cancel-finalization)
1648        (cancel-finalization fd-stream))
1649      (sb!unix:unix-close (fd-stream-fd fd-stream))
1650      (when (fd-stream-obuf-sap fd-stream)
1651        (with-available-buffers-lock ()
1652          (push (fd-stream-obuf-sap fd-stream) *available-buffers*)
1653          (setf (fd-stream-obuf-sap fd-stream) nil)))
1654      (when (fd-stream-ibuf-sap fd-stream)
1655        (with-available-buffers-lock ()
1656          (push (fd-stream-ibuf-sap fd-stream) *available-buffers*)
1657          (setf (fd-stream-ibuf-sap fd-stream) nil)))
1658      (sb!impl::set-closed-flame fd-stream))
1659     (:clear-input
1660      (setf (fd-stream-unread fd-stream) nil)
1661      (setf (fd-stream-ibuf-head fd-stream) 0)
1662      (setf (fd-stream-ibuf-tail fd-stream) 0)
1663      (catch 'eof-input-catcher
1664        (loop
1665         (let ((count (sb!unix:with-restarted-syscall ()
1666                        (sb!alien:with-alien ((read-fds (sb!alien:struct
1667                                                         sb!unix:fd-set)))
1668                          (sb!unix:fd-zero read-fds)
1669                          (sb!unix:fd-set (fd-stream-fd fd-stream) read-fds)
1670                          (sb!unix:unix-fast-select (1+ (fd-stream-fd fd-stream))
1671                                                    (sb!alien:addr read-fds)
1672                                                    nil nil 0 0)))))
1673           (cond ((eql count 1)
1674                  (refill-buffer/fd fd-stream)
1675                  (setf (fd-stream-ibuf-head fd-stream) 0)
1676                  (setf (fd-stream-ibuf-tail fd-stream) 0))
1677                 (t
1678                  (return t)))))))
1679     (:force-output
1680      (flush-output-buffer fd-stream))
1681     (:finish-output
1682      (flush-output-buffer fd-stream)
1683      (do ()
1684          ((null (fd-stream-output-later fd-stream)))
1685        (sb!sys:serve-all-events)))
1686     (:element-type
1687      (fd-stream-element-type fd-stream))
1688     (:external-format
1689      (fd-stream-external-format fd-stream))
1690     (:interactive-p
1691      (= 1 (the (member 0 1)
1692             (sb!unix:unix-isatty (fd-stream-fd fd-stream)))))
1693     (:line-length
1694      80)
1695     (:charpos
1696      (fd-stream-char-pos fd-stream))
1697     (:file-length
1698      (unless (fd-stream-file fd-stream)
1699        ;; This is a TYPE-ERROR because ANSI's species FILE-LENGTH
1700        ;; "should signal an error of type TYPE-ERROR if stream is not
1701        ;; a stream associated with a file". Too bad there's no very
1702        ;; appropriate value for the EXPECTED-TYPE slot..
1703        (error 'simple-type-error
1704               :datum fd-stream
1705               :expected-type 'fd-stream
1706               :format-control "~S is not a stream associated with a file."
1707               :format-arguments (list fd-stream)))
1708      (multiple-value-bind (okay dev ino mode nlink uid gid rdev size
1709                            atime mtime ctime blksize blocks)
1710          (sb!unix:unix-fstat (fd-stream-fd fd-stream))
1711        (declare (ignore ino nlink uid gid rdev
1712                         atime mtime ctime blksize blocks))
1713        (unless okay
1714          (simple-stream-perror "failed Unix fstat(2) on ~S" fd-stream dev))
1715        (if (zerop mode)
1716            nil
1717            (truncate size (fd-stream-element-size fd-stream)))))
1718     (:file-string-length
1719      (etypecase arg1
1720        (character (fd-stream-character-size fd-stream arg1))
1721        (string (fd-stream-string-size fd-stream arg1))))
1722     (:file-position
1723      (fd-stream-file-position fd-stream arg1))))
1724
1725 (defun fd-stream-file-position (stream &optional newpos)
1726   (declare (type fd-stream stream)
1727            (type (or (alien sb!unix:off-t) (member nil :start :end)) newpos))
1728   (if (null newpos)
1729       (sb!sys:without-interrupts
1730         ;; First, find the position of the UNIX file descriptor in the file.
1731         (multiple-value-bind (posn errno)
1732             (sb!unix:unix-lseek (fd-stream-fd stream) 0 sb!unix:l_incr)
1733           (declare (type (or (alien sb!unix:off-t) null) posn))
1734           (cond ((integerp posn)
1735                  ;; Adjust for buffered output: If there is any output
1736                  ;; buffered, the *real* file position will be larger
1737                  ;; than reported by lseek() because lseek() obviously
1738                  ;; cannot take into account output we have not sent
1739                  ;; yet.
1740                  (dolist (later (fd-stream-output-later stream))
1741                    (incf posn (- (caddr later)
1742                                  (cadr later))))
1743                  (incf posn (fd-stream-obuf-tail stream))
1744                  ;; Adjust for unread input: If there is any input
1745                  ;; read from UNIX but not supplied to the user of the
1746                  ;; stream, the *real* file position will smaller than
1747                  ;; reported, because we want to look like the unread
1748                  ;; stuff is still available.
1749                  (decf posn (- (fd-stream-ibuf-tail stream)
1750                                (fd-stream-ibuf-head stream)))
1751                  (when (fd-stream-unread stream)
1752                    (decf posn))
1753                  ;; Divide bytes by element size.
1754                  (truncate posn (fd-stream-element-size stream)))
1755                 ((eq errno sb!unix:espipe)
1756                  nil)
1757                 (t
1758                  (sb!sys:with-interrupts
1759                    (simple-stream-perror "failure in Unix lseek() on ~S"
1760                                          stream
1761                                          errno))))))
1762       (let ((offset 0) origin)
1763         (declare (type (alien sb!unix:off-t) offset))
1764         ;; Make sure we don't have any output pending, because if we
1765         ;; move the file pointer before writing this stuff, it will be
1766         ;; written in the wrong location.
1767         (flush-output-buffer stream)
1768         (do ()
1769             ((null (fd-stream-output-later stream)))
1770           (sb!sys:serve-all-events))
1771         ;; Clear out any pending input to force the next read to go to
1772         ;; the disk.
1773         (setf (fd-stream-unread stream) nil)
1774         (setf (fd-stream-ibuf-head stream) 0)
1775         (setf (fd-stream-ibuf-tail stream) 0)
1776         ;; Trash cached value for listen, so that we check next time.
1777         (setf (fd-stream-listen stream) nil)
1778         ;; Now move it.
1779         (cond ((eq newpos :start)
1780                (setf offset 0 origin sb!unix:l_set))
1781               ((eq newpos :end)
1782                (setf offset 0 origin sb!unix:l_xtnd))
1783               ((typep newpos '(alien sb!unix:off-t))
1784                (setf offset (* newpos (fd-stream-element-size stream))
1785                      origin sb!unix:l_set))
1786               (t
1787                (error "invalid position given to FILE-POSITION: ~S" newpos)))
1788         (multiple-value-bind (posn errno)
1789             (sb!unix:unix-lseek (fd-stream-fd stream) offset origin)
1790           (cond ((typep posn '(alien sb!unix:off-t))
1791                  t)
1792                 ((eq errno sb!unix:espipe)
1793                  nil)
1794                 (t
1795                  (simple-stream-perror "error in Unix lseek() on ~S"
1796                                        stream
1797                                        errno)))))))
1798 \f
1799 ;;;; creation routines (MAKE-FD-STREAM and OPEN)
1800
1801 ;;; Create a stream for the given Unix file descriptor.
1802 ;;;
1803 ;;; If INPUT is non-NIL, allow input operations. If OUTPUT is non-nil,
1804 ;;; allow output operations. If neither INPUT nor OUTPUT is specified,
1805 ;;; default to allowing input.
1806 ;;;
1807 ;;; ELEMENT-TYPE indicates the element type to use (as for OPEN).
1808 ;;;
1809 ;;; BUFFERING indicates the kind of buffering to use.
1810 ;;;
1811 ;;; TIMEOUT (if true) is the number of seconds to wait for input. If
1812 ;;; NIL (the default), then wait forever. When we time out, we signal
1813 ;;; IO-TIMEOUT.
1814 ;;;
1815 ;;; FILE is the name of the file (will be returned by PATHNAME).
1816 ;;;
1817 ;;; NAME is used to identify the stream when printed.
1818 (defun make-fd-stream (fd
1819                        &key
1820                        (input nil input-p)
1821                        (output nil output-p)
1822                        (element-type 'base-char)
1823                        (buffering :full)
1824                        (external-format :default)
1825                        timeout
1826                        file
1827                        original
1828                        delete-original
1829                        pathname
1830                        input-buffer-p
1831                        dual-channel-p
1832                        (name (if file
1833                                  (format nil "file ~A" file)
1834                                  (format nil "descriptor ~W" fd)))
1835                        auto-close)
1836   (declare (type index fd) (type (or index null) timeout)
1837            (type (member :none :line :full) buffering))
1838   (cond ((not (or input-p output-p))
1839          (setf input t))
1840         ((not (or input output))
1841          (error "File descriptor must be opened either for input or output.")))
1842   (let ((stream (%make-fd-stream :fd fd
1843                                  :name name
1844                                  :file file
1845                                  :original original
1846                                  :delete-original delete-original
1847                                  :pathname pathname
1848                                  :buffering buffering
1849                                  :dual-channel-p dual-channel-p
1850                                  :external-format external-format
1851                                  :timeout timeout)))
1852     (set-fd-stream-routines stream element-type external-format
1853                             input output input-buffer-p)
1854     (when (and auto-close (fboundp 'finalize))
1855       (finalize stream
1856                 (lambda ()
1857                   (sb!unix:unix-close fd)
1858                   #!+sb-show
1859                   (format *terminal-io* "** closed file descriptor ~W **~%"
1860                           fd))))
1861     stream))
1862
1863 ;;; Pick a name to use for the backup file for the :IF-EXISTS
1864 ;;; :RENAME-AND-DELETE and :RENAME options.
1865 (defun pick-backup-name (name)
1866   (declare (type simple-base-string name))
1867   (concatenate 'simple-base-string name ".bak"))
1868
1869 ;;; Ensure that the given arg is one of the given list of valid
1870 ;;; things. Allow the user to fix any problems.
1871 (defun ensure-one-of (item list what)
1872   (unless (member item list)
1873     (error 'simple-type-error
1874            :datum item
1875            :expected-type `(member ,@list)
1876            :format-control "~@<~S is ~_invalid for ~S; ~_need one of~{ ~S~}~:>"
1877            :format-arguments (list item what list))))
1878
1879 ;;; Rename NAMESTRING to ORIGINAL. First, check whether we have write
1880 ;;; access, since we don't want to trash unwritable files even if we
1881 ;;; technically can. We return true if we succeed in renaming.
1882 (defun rename-the-old-one (namestring original)
1883   (unless (sb!unix:unix-access namestring sb!unix:w_ok)
1884     (error "~@<The file ~2I~_~S ~I~_is not writable.~:>" namestring))
1885   (multiple-value-bind (okay err) (sb!unix:unix-rename namestring original)
1886     (if okay
1887         t
1888         (error 'simple-file-error
1889                :pathname namestring
1890                :format-control
1891                "~@<couldn't rename ~2I~_~S ~I~_to ~2I~_~S: ~4I~_~A~:>"
1892                :format-arguments (list namestring original (strerror err))))))
1893
1894 (defun open (filename
1895              &key
1896              (direction :input)
1897              (element-type 'base-char)
1898              (if-exists nil if-exists-given)
1899              (if-does-not-exist nil if-does-not-exist-given)
1900              (external-format :default)
1901              &aux ; Squelch assignment warning.
1902              (direction direction)
1903              (if-does-not-exist if-does-not-exist)
1904              (if-exists if-exists))
1905   #!+sb-doc
1906   "Return a stream which reads from or writes to FILENAME.
1907   Defined keywords:
1908    :DIRECTION - one of :INPUT, :OUTPUT, :IO, or :PROBE
1909    :ELEMENT-TYPE - the type of object to read or write, default BASE-CHAR
1910    :IF-EXISTS - one of :ERROR, :NEW-VERSION, :RENAME, :RENAME-AND-DELETE,
1911                        :OVERWRITE, :APPEND, :SUPERSEDE or NIL
1912    :IF-DOES-NOT-EXIST - one of :ERROR, :CREATE or NIL
1913   See the manual for details."
1914
1915   ;; Calculate useful stuff.
1916   (multiple-value-bind (input output mask)
1917       (case direction
1918         (:input  (values   t nil sb!unix:o_rdonly))
1919         (:output (values nil   t sb!unix:o_wronly))
1920         (:io     (values   t   t sb!unix:o_rdwr))
1921         (:probe  (values   t nil sb!unix:o_rdonly)))
1922     (declare (type index mask))
1923     (let* ((pathname (merge-pathnames filename))
1924            (namestring
1925             (cond ((unix-namestring pathname input))
1926                   ((and input (eq if-does-not-exist :create))
1927                    (unix-namestring pathname nil))
1928                   ((and (eq direction :io) (not if-does-not-exist-given))
1929                    (unix-namestring pathname nil)))))
1930       ;; 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              (ensure-one-of if-exists
1938                             '(:error :new-version :rename
1939                                      :rename-and-delete :overwrite
1940                                      :append :supersede nil)
1941                             :if-exists)
1942              (case if-exists
1943                ((:new-version :error nil)
1944                 (setf mask (logior mask sb!unix:o_excl)))
1945                ((:rename :rename-and-delete)
1946                 (setf mask (logior mask sb!unix:o_creat)))
1947                ((:supersede)
1948                 (setf mask (logior mask sb!unix:o_trunc)))
1949                (:append
1950                 (setf mask (logior mask sb!unix:o_append)))))
1951             (t
1952              (setf if-exists :ignore-this-arg)))
1953
1954       (unless if-does-not-exist-given
1955         (setf if-does-not-exist
1956               (cond ((eq direction :input) :error)
1957                     ((and output
1958                           (member if-exists '(:overwrite :append)))
1959                      :error)
1960                     ((eq direction :probe)
1961                      nil)
1962                     (t
1963                      :create))))
1964       (ensure-one-of if-does-not-exist
1965                      '(:error :create nil)
1966                      :if-does-not-exist)
1967       (if (eq if-does-not-exist :create)
1968         (setf mask (logior mask sb!unix:o_creat)))
1969
1970       (let ((original (case if-exists
1971                         ((:rename :rename-and-delete)
1972                          (pick-backup-name namestring))
1973                         ((:append :overwrite)
1974                          ;; KLUDGE: Provent CLOSE from deleting
1975                          ;; appending streams when called with :ABORT T
1976                          namestring)))
1977             (delete-original (eq if-exists :rename-and-delete))
1978             (mode #o666))
1979         (when (and original (not (eq original namestring)))
1980           ;; We are doing a :RENAME or :RENAME-AND-DELETE. Determine
1981           ;; whether the file already exists, make sure the original
1982           ;; file is not a directory, and keep the mode.
1983           (let ((exists
1984                  (and namestring
1985                       (multiple-value-bind (okay err/dev inode orig-mode)
1986                           (sb!unix:unix-stat namestring)
1987                         (declare (ignore inode)
1988                                  (type (or index null) orig-mode))
1989                         (cond
1990                          (okay
1991                           (when (and output (= (logand orig-mode #o170000)
1992                                                #o40000))
1993                             (error 'simple-file-error
1994                                    :pathname namestring
1995                                    :format-control
1996                                    "can't open ~S for output: is a directory"
1997                                    :format-arguments (list namestring)))
1998                           (setf mode (logand orig-mode #o777))
1999                           t)
2000                          ((eql err/dev sb!unix:enoent)
2001                           nil)
2002                          (t
2003                           (simple-file-perror "can't find ~S"
2004                                               namestring
2005                                               err/dev)))))))
2006             (unless (and exists
2007                          (rename-the-old-one namestring original))
2008               (setf original nil)
2009               (setf delete-original nil)
2010               ;; In order to use :SUPERSEDE instead, we have to make
2011               ;; sure SB!UNIX:O_CREAT corresponds to
2012               ;; IF-DOES-NOT-EXIST. SB!UNIX:O_CREAT was set before
2013               ;; because of IF-EXISTS being :RENAME.
2014               (unless (eq if-does-not-exist :create)
2015                 (setf mask
2016                       (logior (logandc2 mask sb!unix:o_creat)
2017                               sb!unix:o_trunc)))
2018               (setf if-exists :supersede))))
2019
2020         ;; Now we can try the actual Unix open(2).
2021         (multiple-value-bind (fd errno)
2022             (if namestring
2023                 (sb!unix:unix-open namestring mask mode)
2024                 (values nil sb!unix:enoent))
2025           (labels ((open-error (format-control &rest format-arguments)
2026                      (error 'simple-file-error
2027                             :pathname pathname
2028                             :format-control format-control
2029                             :format-arguments format-arguments))
2030                    (vanilla-open-error ()
2031                      (simple-file-perror "error opening ~S" pathname errno)))
2032             (cond ((numberp fd)
2033                    (case direction
2034                      ((:input :output :io)
2035                       (make-fd-stream fd
2036                                       :input input
2037                                       :output output
2038                                       :element-type element-type
2039                                       :external-format external-format
2040                                       :file namestring
2041                                       :original original
2042                                       :delete-original delete-original
2043                                       :pathname pathname
2044                                       :dual-channel-p nil
2045                                       :input-buffer-p t
2046                                       :auto-close t))
2047                      (:probe
2048                       (let ((stream
2049                              (%make-fd-stream :name namestring
2050                                               :fd fd
2051                                               :pathname pathname
2052                                               :element-type element-type)))
2053                         (close stream)
2054                         stream))))
2055                   ((eql errno sb!unix:enoent)
2056                    (case if-does-not-exist
2057                      (:error (vanilla-open-error))
2058                      (:create
2059                       (open-error "~@<The path ~2I~_~S ~I~_does not exist.~:>"
2060                                   pathname))
2061                      (t nil)))
2062                   ((and (eql errno sb!unix:eexist) (null if-exists))
2063                    nil)
2064                   (t
2065                    (vanilla-open-error)))))))))
2066 \f
2067 ;;;; initialization
2068
2069 ;;; the stream connected to the controlling terminal, or NIL if there is none
2070 (defvar *tty*)
2071
2072 ;;; the stream connected to the standard input (file descriptor 0)
2073 (defvar *stdin*)
2074
2075 ;;; the stream connected to the standard output (file descriptor 1)
2076 (defvar *stdout*)
2077
2078 ;;; the stream connected to the standard error output (file descriptor 2)
2079 (defvar *stderr*)
2080
2081 ;;; This is called when the cold load is first started up, and may also
2082 ;;; be called in an attempt to recover from nested errors.
2083 (defun stream-cold-init-or-reset ()
2084   (stream-reinit)
2085   (setf *terminal-io* (make-synonym-stream '*tty*))
2086   (setf *standard-output* (make-synonym-stream '*stdout*))
2087   (setf *standard-input* (make-synonym-stream '*stdin*))
2088   (setf *error-output* (make-synonym-stream '*stderr*))
2089   (setf *query-io* (make-synonym-stream '*terminal-io*))
2090   (setf *debug-io* *query-io*)
2091   (setf *trace-output* *standard-output*)
2092   (values))
2093
2094 ;;; This is called whenever a saved core is restarted.
2095 (defun stream-reinit ()
2096   (setf *available-buffers* nil)
2097   (with-output-to-string (*error-output*)
2098     (setf *stdin*
2099           (make-fd-stream 0 :name "standard input" :input t :buffering :line))
2100     (setf *stdout*
2101           (make-fd-stream 1 :name "standard output" :output t :buffering :line))
2102     (setf *stderr*
2103           (make-fd-stream 2 :name "standard error" :output t :buffering :line))
2104     (let* ((ttyname #.(coerce "/dev/tty" 'simple-base-string))
2105            (tty (sb!unix:unix-open ttyname sb!unix:o_rdwr #o666)))
2106       (if tty
2107           (setf *tty*
2108                 (make-fd-stream tty
2109                                 :name "the terminal"
2110                                 :input t
2111                                 :output t
2112                                 :buffering :line
2113                                 :auto-close t))
2114           (setf *tty* (make-two-way-stream *stdin* *stdout*))))
2115     (princ (get-output-stream-string *error-output*) *stderr*))
2116   (values))
2117 \f
2118 ;;;; miscellany
2119
2120 ;;; the Unix way to beep
2121 (defun beep (stream)
2122   (write-char (code-char bell-char-code) stream)
2123   (finish-output stream))
2124
2125 ;;; This is kind of like FILE-POSITION, but is an internal hack used
2126 ;;; by the filesys stuff to get and set the file name.
2127 ;;;
2128 ;;; FIXME: misleading name, screwy interface
2129 (defun file-name (stream &optional new-name)
2130   (when (typep stream 'fd-stream)
2131       (cond (new-name
2132              (setf (fd-stream-pathname stream) new-name)
2133              (setf (fd-stream-file stream)
2134                    (unix-namestring new-name nil))
2135              t)
2136             (t
2137              (fd-stream-pathname stream)))))