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