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