-
Notifications
You must be signed in to change notification settings - Fork 318
/
fd-stream.lisp
2734 lines (2591 loc) · 121 KB
/
fd-stream.lisp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
;;;; streams for UNIX file descriptors
;;;; This software is part of the SBCL system. See the README file for
;;;; more information.
;;;;
;;;; This software is derived from the CMU CL system, which was
;;;; written at Carnegie Mellon University and released into the
;;;; public domain. The software is in the public domain and is
;;;; provided with absolutely no warranty. See the COPYING and CREDITS
;;;; files for more information.
(in-package "SB!IMPL")
;;;; BUFFER
;;;;
;;;; Streams hold BUFFER objects, which contain a SAP, size of the
;;;; memory area the SAP stands for (LENGTH bytes), and HEAD and TAIL
;;;; indexes which delimit the "valid", or "active" area of the
;;;; memory. HEAD is inclusive, TAIL is exclusive.
;;;;
;;;; Buffers get allocated lazily, and are recycled by returning them
;;;; to the *AVAILABLE-BUFFERS* list. Every buffer has it's own
;;;; finalizer, to take care of releasing the SAP memory when a stream
;;;; is not properly closed.
;;;;
;;;; The code aims to provide a limited form of thread and interrupt
;;;; safety: parallel writes and reads may lose output or input, cause
;;;; interleaved IO, etc -- but they should not corrupt memory. The
;;;; key to doing this is to read buffer state once, and update the
;;;; state based on the read state:
;;;;
;;;; (let ((tail (buffer-tail buffer)))
;;;; ...
;;;; (setf (buffer-tail buffer) (+ tail n)))
;;;;
;;;; NOT
;;;;
;;;; (let ((tail (buffer-tail buffer)))
;;;; ...
;;;; (incf (buffer-tail buffer) n))
;;;;
(defstruct (buffer (:constructor %make-buffer (sap length))
(:copier nil))
(sap (missing-arg) :type system-area-pointer :read-only t)
(length (missing-arg) :type index :read-only t)
(head 0 :type index)
(tail 0 :type index))
(declaim (freeze-type buffer))
(defglobal *available-buffers* ()
"List of available buffers.")
(defconstant +bytes-per-buffer+ (* 4 1024)
"Default number of bytes per buffer.")
(defun alloc-buffer (&optional (size +bytes-per-buffer+))
;; Don't want to allocate & unwind before the finalizer is in place.
(without-interrupts
(let* ((sap (allocate-system-memory size))
(buffer (%make-buffer sap size)))
(when (zerop (sap-int sap))
(error "Could not allocate ~D bytes for buffer." size))
(finalize buffer (lambda ()
(deallocate-system-memory sap size))
:dont-save t)
buffer)))
(defun get-buffer ()
(or (and *available-buffers* (atomic-pop *available-buffers*))
(alloc-buffer)))
(declaim (inline reset-buffer))
(defun reset-buffer (buffer)
(setf (buffer-head buffer) 0
(buffer-tail buffer) 0)
buffer)
(defun release-buffer (buffer)
(reset-buffer buffer)
(atomic-push buffer *available-buffers*))
;;;; the FD-STREAM structure
;;; Coarsely characterizes the element type of an FD-STREAM w.r.t.
;;; its SUBTYPEP relations to the relevant CHARACTER and
;;; ([UN]SIGNED-BYTE 8) types. This coarse characterization enables
;;; dispatching on the element type as needed by {READ,WRITE}-SEQUENCE
;;; without calling SUBTYPEP.
(deftype stream-element-mode ()
'(member character unsigned-byte signed-byte :bivalent))
(defstruct (fd-stream
(:constructor %make-fd-stream)
(:conc-name fd-stream-)
(:predicate fd-stream-p)
(:include ansi-stream
(misc #'fd-stream-misc-routine))
(:copier nil))
;; the name of this stream
(name nil)
;; the file this stream is for
(file nil)
;; the backup file namestring for the old file, for :IF-EXISTS
;; :RENAME or :RENAME-AND-DELETE.
(original nil :type (or simple-string null))
(delete-original nil) ; for :if-exists :rename-and-delete
;;; the number of bytes per element
(element-size 1 :type index)
;; the type of element being transfered
(element-type 'base-char)
;; coarse characterization of the element type. see description of
;; STREAM-ELEMENT-MODE type.
(element-mode :bivalent :type stream-element-mode)
;; the Unix file descriptor
(fd -1 :type #!-win32 fixnum #!+win32 sb!vm:signed-word)
;; What do we know about the FD?
(fd-type :unknown :type keyword)
;; controls when the output buffer is flushed
(buffering :full :type (member :full :line :none))
;; controls whether the input buffer must be cleared before output
;; (must be done for files, not for sockets, pipes and other data
;; sources where input and output aren't related). non-NIL means
;; don't clear input buffer.
(dual-channel-p nil)
;; character position if known -- this may run into bignums, but
;; we probably should flip it into null then for efficiency's sake...
(output-column nil :type (or (and unsigned-byte
#!+64-bit index)
null))
;; T if input is waiting on FD. :EOF if we hit EOF.
(listen nil :type (member nil t :eof))
;; T if serve-event is allowed when this stream blocks
(serve-events nil :type boolean)
;; the input buffer
(instead (make-array 0 :element-type 'character :adjustable t :fill-pointer t) :type (array character (*)))
(ibuf nil :type (or buffer null))
(eof-forced-p nil :type (member t nil))
;; the output buffer
(obuf nil :type (or buffer null))
;; output flushed, but not written due to non-blocking io?
(output-queue nil)
(handler nil)
;; timeout specified for this stream as seconds or NIL if none
(timeout nil :type (or single-float null))
;; pathname of the file this stream is opened to (returned by PATHNAME)
(pathname nil :type (or pathname null))
;; Not :DEFAULT, because we want to match CHAR-SIZE!
(external-format :latin-1)
;; fixed width, or function to call with a character
(char-size 1 :type (or fixnum function))
(output-bytes #'ill-out :type function))
(defun fd-stream-bivalent-p (stream)
(eq (fd-stream-element-mode stream) :bivalent))
(defmethod print-object ((fd-stream fd-stream) stream)
(declare (type stream stream))
(print-unreadable-object (fd-stream stream :type t :identity t)
(format stream "for ~S" (fd-stream-name fd-stream))))
;;; Release all of FD-STREAM's buffers. Originally the intent of this
;;; was to grab a mutex once only, but the buffer pool is lock-free now.
(defun release-fd-stream-buffers (fd-stream)
(awhen (fd-stream-ibuf fd-stream)
(setf (fd-stream-ibuf fd-stream) nil)
(release-buffer it))
(awhen (fd-stream-obuf fd-stream)
(setf (fd-stream-obuf fd-stream) nil)
(release-buffer it))
(dolist (buf (fd-stream-output-queue fd-stream))
(when (buffer-p buf)
(release-buffer buf)))
(setf (fd-stream-output-queue fd-stream) nil))
;;;; FORM-TRACKING-STREAM
;; The compiler uses this to record for each input subform the start and
;; end positions as character offsets. Measuring in characters rather than
;; bytes is both better suited to the task - in that it is consistent with
;; reporting of "point" by Emacs - and faster than querying FILE-POSITION.
;; The slowness of FILE-POSITION on an FD-STREAM is due to making a system
;; call every time, to ensure that the case of an append-only stream works
;; correctly (where the OS forces all writes to the end), and other factors.
(defstruct (form-tracking-stream
(:constructor %make-form-tracking-stream)
(:include fd-stream
(misc #'tracking-stream-misc)
(input-char-pos 0))
(:copier nil))
;; a function which is called for events on this stream.
(observer (lambda (x y z) (declare (ignore x y z))) :type function)
;; A vector of the character position of each #\Newline seen
(newlines (make-array 10 :fill-pointer 0 :adjustable t))
(last-newline -1 :type index-or-minus-1)
;; Better than reporting that a reader error occurred at a position
;; before any whitespace (or equivalently, a macro producing no value),
;; we can note the position at the first "good" character.
(form-start-byte-pos)
(form-start-char-pos))
(defun line/col-from-charpos
(stream &optional (charpos (ansi-stream-input-char-pos stream)))
(let* ((newlines (form-tracking-stream-newlines stream))
(index (position charpos newlines :test #'>= :from-end t)))
;; Line numbers traditionally begin at 1, columns at 0.
(if index
;; INDEX is 1 less than the number of newlines seen
;; up to and including this startpos.
;; e.g. index=0 => 1 newline seen => line=2
(cons (+ index 2)
;; 1 char after the newline = column 0
(- charpos (aref newlines index) 1))
;; zero newlines were seen
(cons 1 charpos))))
;;;; CORE OUTPUT FUNCTIONS
;;; Buffer the section of THING delimited by START and END by copying
;;; to output buffer(s) of stream.
(defun buffer-output (stream thing start end)
(declare (index start end))
(when (< end start)
(error ":END before :START!"))
(when (> end start)
;; Copy bytes from THING to buffers.
(flet ((copy-to-buffer (buffer tail count)
(declare (buffer buffer) (index tail count))
(aver (plusp count))
(let ((sap (buffer-sap buffer)))
(etypecase thing
(system-area-pointer
(system-area-ub8-copy thing start sap tail count))
((simple-unboxed-array (*))
(copy-ub8-to-system-area thing start sap tail count))))
;; Not INCF! If another thread has moved tail from under
;; us, we don't want to accidentally increment tail
;; beyond buffer-length.
(setf (buffer-tail buffer) (+ count tail))
(incf start count)))
(tagbody
;; First copy is special: the buffer may already contain
;; something, or be even full.
(let* ((obuf (fd-stream-obuf stream))
(tail (buffer-tail obuf))
(space (- (buffer-length obuf) tail)))
(when (plusp space)
(copy-to-buffer obuf tail (min space (- end start)))
(go :more-output-p)))
:flush-and-fill
;; Later copies should always have an empty buffer, since
;; they are freshly flushed, but if another thread is
;; stomping on the same buffer that might not be the case.
(let* ((obuf (flush-output-buffer stream))
(tail (buffer-tail obuf))
(space (- (buffer-length obuf) tail)))
(copy-to-buffer obuf tail (min space (- end start))))
:more-output-p
(when (> end start)
(go :flush-and-fill))))))
(define-symbol-macro +write-failed+ "Couldn't write to ~S")
;;; Flush the current output buffer of the stream, ensuring that the
;;; new buffer is empty. Returns (for convenience) the new output
;;; buffer -- which may or may not be EQ to the old one. If the is no
;;; queued output we try to write the buffer immediately -- otherwise
;;; we queue it for later.
(defun flush-output-buffer (stream)
(let ((obuf (fd-stream-obuf stream)))
(when obuf
(let ((head (buffer-head obuf))
(tail (buffer-tail obuf)))
(cond ((eql head tail)
;; Buffer is already empty -- just ensure that is is
;; set to zero as well.
(reset-buffer obuf))
((fd-stream-output-queue stream)
;; There is already stuff on the queue -- go directly
;; there.
(aver (< head tail))
(%queue-and-replace-output-buffer stream))
(t
;; Try a non-blocking write, if SERVE-EVENT is allowed, queue
;; whatever is left over. Otherwise wait until we can write.
(aver (< head tail))
(synchronize-stream-output stream)
(loop
(let ((length (- tail head)))
(multiple-value-bind (count errno)
(sb!unix:unix-write (fd-stream-fd stream) (buffer-sap obuf)
head length)
(flet ((queue-or-wait ()
(if (fd-stream-serve-events stream)
(return (%queue-and-replace-output-buffer stream))
(or (wait-until-fd-usable (fd-stream-fd stream) :output
(fd-stream-timeout stream)
nil)
(signal-timeout 'io-timeout
:stream stream
:direction :output
:seconds (fd-stream-timeout stream))))))
(cond ((eql count length)
;; Complete write -- we can use the same buffer.
(return (reset-buffer obuf)))
(count
;; Partial write -- update buffer status and
;; queue or wait.
(incf head count)
(setf (buffer-head obuf) head)
(queue-or-wait))
#!-win32
((eql errno sb!unix:ewouldblock)
;; Blocking, queue or wair.
(queue-or-wait))
;; if interrupted on win32, just try again
#!+win32 ((eql errno sb!unix:eintr))
(t
(simple-stream-perror +write-failed+
stream errno)))))))))))))
;;; Helper for FLUSH-OUTPUT-BUFFER -- returns the new buffer.
(defun %queue-and-replace-output-buffer (stream)
(aver (fd-stream-serve-events stream))
(let ((queue (fd-stream-output-queue stream))
(later (list (or (fd-stream-obuf stream) (bug "Missing obuf."))))
(new (get-buffer)))
;; Important: before putting the buffer on queue, give the stream
;; a new one. If we get an interrupt and unwind losing the buffer
;; is relatively OK, but having the same buffer in two places
;; would be bad.
(setf (fd-stream-obuf stream) new)
(cond (queue
(nconc queue later))
(t
(setf (fd-stream-output-queue stream) later)))
(unless (fd-stream-handler stream)
(setf (fd-stream-handler stream)
(add-fd-handler (fd-stream-fd stream)
:output
(lambda (fd)
(declare (ignore fd))
(write-output-from-queue stream)))))
new))
;;; This is called by the FD-HANDLER for the stream when output is
;;; possible.
(defun write-output-from-queue (stream)
(aver (fd-stream-serve-events stream))
(synchronize-stream-output stream)
(let (not-first-p)
(tagbody
:pop-buffer
(let* ((buffer (pop (fd-stream-output-queue stream)))
(head (buffer-head buffer))
(length (- (buffer-tail buffer) head)))
(declare (index head length))
(aver (>= length 0))
(multiple-value-bind (count errno)
(sb!unix:unix-write (fd-stream-fd stream) (buffer-sap buffer)
head length)
(cond ((eql count length)
;; Complete write, see if we can do another right
;; away, or remove the handler if we're done.
(release-buffer buffer)
(cond ((fd-stream-output-queue stream)
(setf not-first-p t)
(go :pop-buffer))
(t
(let ((handler (fd-stream-handler stream)))
(aver handler)
(setf (fd-stream-handler stream) nil)
(remove-fd-handler handler)))))
(count
;; Partial write. Update buffer status and requeue.
(aver (< count length))
;; Do not use INCF! Another thread might have moved head.
(setf (buffer-head buffer) (+ head count))
(push buffer (fd-stream-output-queue stream)))
(not-first-p
;; We tried to do multiple writes, and finally our
;; luck ran out. Requeue.
(push buffer (fd-stream-output-queue stream)))
(t
;; Could not write on the first try at all!
#!+win32
(simple-stream-perror +write-failed+ stream errno)
#!-win32
(if (= errno sb!unix:ewouldblock)
(bug "Unexpected blocking in WRITE-OUTPUT-FROM-QUEUE.")
(simple-stream-perror +write-failed+
stream errno))))))))
nil)
;;; Try to write THING directly to STREAM without buffering, if
;;; possible. If direct write doesn't happen, buffer.
(defun write-or-buffer-output (stream thing start end)
(declare (index start end))
(cond ((fd-stream-output-queue stream)
(buffer-output stream thing start end))
((< end start)
(error ":END before :START!"))
((> end start)
(let ((length (- end start)))
(synchronize-stream-output stream)
(multiple-value-bind (count errno)
(sb!unix:unix-write (fd-stream-fd stream) thing start length)
(cond ((eql count length)
;; Complete write -- done!
)
(count
(aver (< count length))
;; Partial write -- buffer the rest.
(buffer-output stream thing (+ start count) end))
(t
;; Could not write -- buffer or error.
#!+win32
(simple-stream-perror +write-failed+ stream errno)
#!-win32
(if (= errno sb!unix:ewouldblock)
(buffer-output stream thing start end)
(simple-stream-perror +write-failed+ stream errno)))))))))
;;; Deprecated -- can go away after 1.1 or so. Deprecated because
;;; this is not something we want to export. Nikodemus thinks the
;;; right thing is to support a low-level non-stream like IO layer,
;;; akin to java.nio.
(declaim (inline output-raw-bytes))
(define-deprecated-function :late "1.0.8.16" output-raw-bytes write-sequence
(stream thing &optional start end)
(write-or-buffer-output stream thing (or start 0) (or end (length thing))))
;;;; output routines and related noise
(defvar *output-routines* ()
"List of all available output routines. Each element is a list of the
element-type output, the kind of buffering, the function name, and the number
of bytes per element.")
;;; common idioms for reporting low-level stream and file problems
(defun simple-stream-perror (note-format stream errno)
(declare (optimize allow-non-returning-tail-call))
(error 'simple-stream-error
:stream stream
:format-control "~@<~?: ~2I~_~A~:>"
:format-arguments (list note-format (list stream) (strerror errno))))
(defun simple-file-perror (note-format pathname errno)
(declare (optimize allow-non-returning-tail-call))
(error 'simple-file-error
:pathname pathname
:format-control "~@<~?: ~2I~_~A~:>"
:format-arguments
(list note-format (list pathname) (strerror errno))))
(defun c-string-encoding-error (external-format code)
(declare (optimize allow-non-returning-tail-call))
(error 'c-string-encoding-error
:external-format external-format
:code code))
(defun c-string-decoding-error (external-format sap offset count)
(declare (optimize allow-non-returning-tail-call))
(error 'c-string-decoding-error
:external-format external-format
:octets (sap-ref-octets sap offset count)))
;;; Returning true goes into end of file handling, false will enter another
;;; round of input buffer filling followed by re-entering character decode.
(defun stream-decoding-error-and-handle (stream octet-count)
(restart-case
(error 'stream-decoding-error
:external-format (stream-external-format stream)
:stream stream
:octets (let ((buffer (fd-stream-ibuf stream)))
(sap-ref-octets (buffer-sap buffer)
(buffer-head buffer)
octet-count)))
(attempt-resync ()
:report (lambda (stream)
(format stream
"~@<Attempt to resync the stream at a ~
character boundary and continue.~@:>"))
(fd-stream-resync stream)
nil)
(force-end-of-file ()
:report (lambda (stream)
(format stream "~@<Force an end of file.~@:>"))
(setf (fd-stream-eof-forced-p stream) t))
(input-replacement (string)
:report (lambda (stream)
(format stream "~@<Use string as replacement input, ~
attempt to resync at a character ~
boundary and continue.~@:>"))
:interactive (lambda ()
(format *query-io* "~@<Enter a string: ~@:>")
(finish-output *query-io*)
(list (read *query-io*)))
(let ((string (reverse (string string)))
(instead (fd-stream-instead stream)))
(dotimes (i (length string))
(vector-push-extend (char string i) instead))
(fd-stream-resync stream)
(when (> (length string) 0)
(setf (fd-stream-listen stream) t)))
nil)))
(defun stream-encoding-error-and-handle (stream code)
(restart-case
(error 'stream-encoding-error
:external-format (stream-external-format stream)
:stream stream
:code code)
(output-nothing ()
:report (lambda (stream)
(format stream "~@<Skip output of this character.~@:>")))
(output-replacement (string)
:report (lambda (stream)
(format stream "~@<Output replacement string.~@:>"))
:interactive (lambda ()
(format *query-io* "~@<Enter a string: ~@:>")
(finish-output *query-io*)
(list (read *query-io*)))
(let ((string (string string)))
(fd-sout stream (string string) 0 (length string))))))
(defun %external-format-encoding-error (stream code)
(if (streamp stream)
(stream-encoding-error-and-handle stream code)
(c-string-encoding-error stream code)))
(defmacro external-format-encoding-error (stream code)
`(return-from output-nothing (%external-format-encoding-error ,stream ,code)))
(defun synchronize-stream-output (stream)
;; If we're reading and writing on the same file, flush buffered
;; input and rewind file position accordingly.
(unless (or (fd-stream-dual-channel-p stream)
(and
(eq (fd-stream-in stream) #'ill-in)
(eq (fd-stream-bin stream) #'ill-bin)))
(let ((adjust (nth-value 1 (flush-input-buffer stream))))
(unless (eql 0 adjust)
(sb!unix:unix-lseek (fd-stream-fd stream) (- adjust) sb!unix:l_incr)))))
(defun fd-stream-output-finished-p (stream)
(let ((obuf (fd-stream-obuf stream)))
(or (not obuf)
(and (zerop (buffer-tail obuf))
(not (fd-stream-output-queue stream))))))
(defmacro output-wrapper/variable-width ((stream size buffering restart)
&body body)
(let ((stream-var (gensym "STREAM")))
`(let* ((,stream-var ,stream)
(obuf (fd-stream-obuf ,stream-var))
(tail (buffer-tail obuf))
(size ,size))
,(unless (eq (car buffering) :none)
`(when (< (buffer-length obuf) (+ tail size))
(setf obuf (flush-output-buffer ,stream-var)
tail (buffer-tail obuf))))
,(unless (eq (car buffering) :none)
;; FIXME: Why this here? Doesn't seem necessary.
`(synchronize-stream-output ,stream-var))
,(if restart
`(block output-nothing
,@body
(setf (buffer-tail obuf) (+ tail size)))
`(progn
,@body
(setf (buffer-tail obuf) (+ tail size))))
,(ecase (car buffering)
(:none
`(flush-output-buffer ,stream-var))
(:line
`(when (eql byte #\Newline)
(flush-output-buffer ,stream-var)))
(:full))
(values))))
(defmacro output-wrapper ((stream size buffering restart) &body body)
(let ((stream-var (gensym "STREAM")))
`(let* ((,stream-var ,stream)
(obuf (fd-stream-obuf ,stream-var))
(tail (buffer-tail obuf)))
,(unless (eq (car buffering) :none)
`(when (< (buffer-length obuf) (+ tail ,size))
(setf obuf (flush-output-buffer ,stream-var)
tail (buffer-tail obuf))))
;; FIXME: Why this here? Doesn't seem necessary.
,(unless (eq (car buffering) :none)
`(synchronize-stream-output ,stream-var))
,(if restart
`(block output-nothing
,@body
(setf (buffer-tail obuf) (+ tail ,size)))
`(progn
,@body
(setf (buffer-tail obuf) (+ tail ,size))))
,(ecase (car buffering)
(:none
`(flush-output-buffer ,stream-var))
(:line
`(when (eql byte #\Newline)
(flush-output-buffer ,stream-var)))
(:full))
(values))))
(defmacro def-output-routines/variable-width
((name-fmt size restart external-format &rest bufferings)
&body body)
(declare (optimize (speed 1)))
(cons 'progn
(mapcar
(lambda (buffering)
(let ((function
(intern (format nil name-fmt (string (car buffering))))))
`(progn
(defun ,function (stream byte)
(declare (ignorable byte))
(output-wrapper/variable-width (stream ,size ,buffering ,restart)
,@body))
(setf *output-routines*
(nconc *output-routines*
',(mapcar
(lambda (type)
(list type
(car buffering)
function
1
external-format))
(cdr buffering)))))))
bufferings)))
;;; Define output routines that output numbers SIZE bytes long for the
;;; given bufferings. Use BODY to do the actual output.
(defmacro def-output-routines ((name-fmt size restart &rest bufferings)
&body body)
(declare (optimize (speed 1)))
(cons 'progn
(mapcar
(lambda (buffering)
(let ((function
(intern (format nil name-fmt (string (car buffering))))))
`(progn
(defun ,function (stream byte)
(output-wrapper (stream ,size ,buffering ,restart)
,@body))
(setf *output-routines*
(nconc *output-routines*
',(mapcar
(lambda (type)
(list type
(car buffering)
function
size
nil))
(cdr buffering)))))))
bufferings)))
;;; FIXME: is this used anywhere any more?
(def-output-routines ("OUTPUT-CHAR-~A-BUFFERED"
1
t
(:none character)
(:line character)
(:full character))
(if (eql byte #\Newline)
(setf (fd-stream-output-column stream) 0)
(incf (fd-stream-output-column stream)))
(setf (sap-ref-8 (buffer-sap obuf) tail)
(char-code byte)))
(def-output-routines ("OUTPUT-UNSIGNED-BYTE-~A-BUFFERED"
1
nil
(:none (unsigned-byte 8))
(:full (unsigned-byte 8)))
(setf (sap-ref-8 (buffer-sap obuf) tail)
byte))
(def-output-routines ("OUTPUT-SIGNED-BYTE-~A-BUFFERED"
1
nil
(:none (signed-byte 8))
(:full (signed-byte 8)))
(setf (signed-sap-ref-8 (buffer-sap obuf) tail)
byte))
(def-output-routines ("OUTPUT-UNSIGNED-SHORT-~A-BUFFERED"
2
nil
(:none (unsigned-byte 16))
(:full (unsigned-byte 16)))
(setf (sap-ref-16 (buffer-sap obuf) tail)
byte))
(def-output-routines ("OUTPUT-SIGNED-SHORT-~A-BUFFERED"
2
nil
(:none (signed-byte 16))
(:full (signed-byte 16)))
(setf (signed-sap-ref-16 (buffer-sap obuf) tail)
byte))
(def-output-routines ("OUTPUT-UNSIGNED-LONG-~A-BUFFERED"
4
nil
(:none (unsigned-byte 32))
(:full (unsigned-byte 32)))
(setf (sap-ref-32 (buffer-sap obuf) tail)
byte))
(def-output-routines ("OUTPUT-SIGNED-LONG-~A-BUFFERED"
4
nil
(:none (signed-byte 32))
(:full (signed-byte 32)))
(setf (signed-sap-ref-32 (buffer-sap obuf) tail)
byte))
#!+64-bit
(progn
(def-output-routines ("OUTPUT-UNSIGNED-LONG-LONG-~A-BUFFERED"
8
nil
(:none (unsigned-byte 64))
(:full (unsigned-byte 64)))
(setf (sap-ref-64 (buffer-sap obuf) tail)
byte))
(def-output-routines ("OUTPUT-SIGNED-LONG-LONG-~A-BUFFERED"
8
nil
(:none (signed-byte 64))
(:full (signed-byte 64)))
(setf (signed-sap-ref-64 (buffer-sap obuf) tail)
byte)))
;;; the routine to use to output a string. If the stream is
;;; unbuffered, slam the string down the file descriptor, otherwise
;;; use OUTPUT-RAW-BYTES to buffer the string. Update charpos by
;;; checking to see where the last newline was.
(defun fd-sout (stream thing start end)
(declare (type fd-stream stream) (type string thing))
(let ((start (or start 0))
(end (or end (length (the vector thing)))))
(declare (fixnum start end))
(let ((last-newline
(string-dispatch (simple-base-string
#!+sb-unicode
(simple-array character (*))
string)
thing
(position #\newline thing :from-end t
:start start :end end))))
(if (and (typep thing 'base-string)
(eq (fd-stream-external-format-keyword stream) :latin-1))
(ecase (fd-stream-buffering stream)
(:full
(buffer-output stream thing start end))
(:line
(buffer-output stream thing start end)
(when last-newline
(flush-output-buffer stream)))
(:none
(write-or-buffer-output stream thing start end)))
(ecase (fd-stream-buffering stream)
(:full (funcall (fd-stream-output-bytes stream)
stream thing nil start end))
(:line (funcall (fd-stream-output-bytes stream)
stream thing last-newline start end))
(:none (funcall (fd-stream-output-bytes stream)
stream thing t start end))))
(if last-newline
(setf (fd-stream-output-column stream) (- end last-newline 1))
(incf (fd-stream-output-column stream) (- end start))))))
(defstruct (external-format
(:constructor %make-external-format)
(:conc-name ef-)
(:predicate external-format-p)
(:copier %copy-external-format))
;; All the names that can refer to this external format. The first
;; one is the canonical name.
(names (missing-arg) :type list :read-only t)
(default-replacement-character (missing-arg) :type character)
(read-n-chars-fun (missing-arg) :type function)
(read-char-fun (missing-arg) :type function)
(write-n-bytes-fun (missing-arg) :type function)
(write-char-none-buffered-fun (missing-arg) :type function)
(write-char-line-buffered-fun (missing-arg) :type function)
(write-char-full-buffered-fun (missing-arg) :type function)
;; Can be nil for fixed-width formats.
(resync-fun nil :type (or function null))
(bytes-for-char-fun (missing-arg) :type function)
(read-c-string-fun (missing-arg) :type function)
(write-c-string-fun (missing-arg) :type function)
;; We indirect through symbols in these functions so that a
;; developer working on the octets code can easily redefine things
;; and use the new function definition without redefining the
;; external format as well. The slots above don't do any
;; indirection because a developer working with those slots would be
;; redefining the external format anyway.
(octets-to-string-fun (missing-arg) :type function)
(string-to-octets-fun (missing-arg) :type function))
(defun ef-char-size (ef-entry)
(if (variable-width-external-format-p ef-entry)
(bytes-for-char-fun ef-entry)
(funcall (bytes-for-char-fun ef-entry) #\x)))
(defun sb!alien::string-to-c-string (string external-format)
(declare (type simple-string string))
(locally
(declare (optimize (speed 3) (safety 0)))
(let ((external-format (get-external-format-or-lose external-format)))
(funcall (ef-write-c-string-fun external-format) string))))
(defun sb!alien::c-string-to-string (sap external-format element-type)
(declare (type system-area-pointer sap))
(locally
(declare (optimize (speed 3) (safety 0)))
(let ((external-format (get-external-format-or-lose external-format)))
(funcall (ef-read-c-string-fun external-format) sap element-type))))
(defun wrap-external-format-functions (external-format fun)
(let ((result (%copy-external-format external-format)))
(macrolet ((frob (accessor)
`(setf (,accessor result) (funcall fun (,accessor result)))))
(frob ef-read-n-chars-fun)
(frob ef-read-char-fun)
(frob ef-write-n-bytes-fun)
(frob ef-write-char-none-buffered-fun)
(frob ef-write-char-line-buffered-fun)
(frob ef-write-char-full-buffered-fun)
(frob ef-resync-fun)
(frob ef-bytes-for-char-fun)
(frob ef-read-c-string-fun)
(frob ef-write-c-string-fun)
(frob ef-octets-to-string-fun)
(frob ef-string-to-octets-fun))
result))
(define-load-time-global *external-formats* (make-hash-table)
"Hashtable of all available external formats. The table maps from
external-format names to EXTERNAL-FORMAT structures.")
(defun get-external-format-or-lose (external-format)
(or (get-external-format external-format)
(error "Undefined external-format: ~S" external-format)))
(defun external-format-keyword (external-format)
(typecase external-format
(keyword external-format)
((cons keyword) (car external-format))))
(defun fd-stream-external-format-keyword (stream)
(external-format-keyword (fd-stream-external-format stream)))
(defun canonize-external-format (external-format entry)
(typecase external-format
(keyword (first (ef-names entry)))
((cons keyword) (cons (first (ef-names entry)) (rest external-format)))))
;;; Find an output routine to use given the type and buffering. Return
;;; as multiple values the routine, the real type transfered, and the
;;; number of bytes per element.
(defun pick-output-routine (type buffering &optional external-format)
(when (subtypep type 'character)
(let ((entry (get-external-format-or-lose external-format)))
(return-from pick-output-routine
(values (ecase buffering
(:none (ef-write-char-none-buffered-fun entry))
(:line (ef-write-char-line-buffered-fun entry))
(:full (ef-write-char-full-buffered-fun entry)))
'character
1
(ef-write-n-bytes-fun entry)
(ef-char-size entry)
(canonize-external-format external-format entry)))))
(dolist (entry *output-routines*)
(when (and (subtypep type (first entry))
(eq buffering (second entry))
(or (not (fifth entry))
(eq external-format (fifth entry))))
(return-from pick-output-routine
(values (symbol-function (third entry))
(first entry)
(fourth entry)))))
;; KLUDGE: dealing with the buffering here leads to excessive code
;; explosion.
;;
;; KLUDGE: also see comments in PICK-INPUT-ROUTINE
(loop for i from 40 by 8 to 1024 ; ARB (KLUDGE)
if (subtypep type `(unsigned-byte ,i))
do (return-from pick-output-routine
(values
(ecase buffering
(:none
(lambda (stream byte)
(output-wrapper (stream (/ i 8) (:none) nil)
(loop for j from 0 below (/ i 8)
do (setf (sap-ref-8 (buffer-sap obuf)
(+ j tail))
(ldb (byte 8 (- i 8 (* j 8))) byte))))))
(:full
(lambda (stream byte)
(output-wrapper (stream (/ i 8) (:full) nil)
(loop for j from 0 below (/ i 8)
do (setf (sap-ref-8 (buffer-sap obuf)
(+ j tail))
(ldb (byte 8 (- i 8 (* j 8))) byte)))))))
`(unsigned-byte ,i)
(/ i 8))))
(loop for i from 40 by 8 to 1024 ; ARB (KLUDGE)
if (subtypep type `(signed-byte ,i))
do (return-from pick-output-routine
(values
(ecase buffering
(:none
(lambda (stream byte)
(output-wrapper (stream (/ i 8) (:none) nil)
(loop for j from 0 below (/ i 8)
do (setf (sap-ref-8 (buffer-sap obuf)
(+ j tail))
(ldb (byte 8 (- i 8 (* j 8))) byte))))))
(:full
(lambda (stream byte)
(output-wrapper (stream (/ i 8) (:full) nil)
(loop for j from 0 below (/ i 8)
do (setf (sap-ref-8 (buffer-sap obuf)
(+ j tail))
(ldb (byte 8 (- i 8 (* j 8))) byte)))))))
`(signed-byte ,i)
(/ i 8)))))
;;;; input routines and related noise
;;; a list of all available input routines. Each element is a list of
;;; the element-type input, the function name, and the number of bytes
;;; per element.
(defvar *input-routines* ())
;;; Return whether a primitive partial read operation on STREAM's FD
;;; would (probably) block. Signal a `simple-stream-error' if the
;;; system call implementing this operation fails.
;;;
;;; It is "may" instead of "would" because "would" is not quite
;;; correct on win32. However, none of the places that use it require
;;; further assurance than "may" versus "will definitely not".
(defun sysread-may-block-p (stream)
#!+win32
;; This answers T at EOF on win32, I think.
(not (sb!win32:handle-listen (fd-stream-fd stream)))
#!-win32
(not (sb!unix:unix-simple-poll (fd-stream-fd stream) :input 0)))
;;; If the read would block wait (using SERVE-EVENT) till input is available,
;;; then fill the input buffer, and return the number of bytes read. Throws
;;; to EOF-INPUT-CATCHER if the eof was reached.
(defun refill-input-buffer (stream)
(let ((fd (fd-stream-fd stream))
(errno 0)
(count 0))
(tagbody
#!+win32
(go :main)
;; Check for blocking input before touching the stream if we are to
;; serve events: if the FD is blocking, we don't want to try an uninterruptible
;; read(). Regular files should never block, so we can elide the check.
(if (and (neq :regular (fd-stream-fd-type stream))
(sysread-may-block-p stream))
(go :wait-for-input)
(go :main))
;; These (:CLOSED-FLAME and :READ-ERROR) tags are here so what
;; we can signal errors outside the WITHOUT-INTERRUPTS.
:closed-flame
(closed-flame stream)
:read-error
(simple-stream-perror "couldn't read from ~S" stream errno)
:wait-for-input
;; This tag is here so we can unwind outside the WITHOUT-INTERRUPTS
;; to wait for input if read tells us EWOULDBLOCK.
(unless (wait-until-fd-usable fd :input (fd-stream-timeout stream)
(fd-stream-serve-events stream))
(signal-timeout 'io-timeout
:stream stream
:direction :input
:seconds (fd-stream-timeout stream)))
:main
;; Since the read should not block, we'll disable the
;; interrupts here, so that we don't accidentally unwind and
;; leave the stream in an inconsistent state.