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