forked from kangjianwei/LearningJDK
-
Notifications
You must be signed in to change notification settings - Fork 0
/
FileChannelImpl.java
1813 lines (1433 loc) · 71.1 KB
/
FileChannelImpl.java
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
/*
* Copyright (c) 2000, 2018, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package sun.nio.ch;
import java.io.Closeable;
import java.io.FileDescriptor;
import java.io.IOException;
import java.io.UncheckedIOException;
import java.lang.ref.Cleaner.Cleanable;
import java.nio.ByteBuffer;
import java.nio.MappedByteBuffer;
import java.nio.channels.AsynchronousCloseException;
import java.nio.channels.ClosedByInterruptException;
import java.nio.channels.ClosedChannelException;
import java.nio.channels.FileChannel;
import java.nio.channels.FileLock;
import java.nio.channels.FileLockInterruptionException;
import java.nio.channels.NonReadableChannelException;
import java.nio.channels.NonWritableChannelException;
import java.nio.channels.ReadableByteChannel;
import java.nio.channels.SelectableChannel;
import java.nio.channels.WritableByteChannel;
import jdk.internal.misc.JavaIOFileDescriptorAccess;
import jdk.internal.misc.JavaNioAccess;
import jdk.internal.misc.SharedSecrets;
import jdk.internal.ref.Cleaner;
import jdk.internal.ref.CleanerFactory;
// 文件通道的本地实现
public class FileChannelImpl extends FileChannel {
/** Memory allocation size for mapping buffers */
// 系统分页大小
private static final long allocationGranularity;
/** Access to FileDescriptor internals */
// FileDescriptor类的后门
private static final JavaIOFileDescriptorAccess fdAccess = SharedSecrets.getJavaIOFileDescriptorAccess();
/** Thread-safe set of IDs of native threads, for signalling */
private final NativeThreadSet threads = new NativeThreadSet(2);
/** Lock for operations involving position and size */
// 对涉及更改通道游标这种敏感操作加锁
private final Object positionLock = new Object();
/** keeps track of locks on this file */
// 文件锁集合(单例)
private volatile FileLockTable fileLockTable;
/** Used to make native read and write calls */
private final FileDispatcher nd; // 文件操作分派器
/** File descriptor */
private final FileDescriptor fd; // 当前通道(文件)的文件描述符(一对一)
// File access mode (immutable)
private final boolean writable; // 通道是否可写
private final boolean readable; // 通道是否可读
/** Required to prevent finalization of creating stream (immutable) */
private final Object parent; // 打开此通道的流/文件
/** The path of the referenced file (null if the parent stream is created with a file descriptor) */
private final String path; // 此通道代表的文件的路径
/*
* 是否使用DirectIO
* 在一次性传输大量数据时,使用DirectIO可以减少CPU的中断开销,以及消除缓冲区的分配和复制对IO性能的影响
*/
private final boolean direct;
/** IO alignment value for DirectIO */
/*
* DirectIO的对齐粒度
* 使用DirectIO时,数据要求按块对齐,alignment就是该块的大小
*/
private final int alignment;
/** Cleanable with an action which closes this channel's file descriptor */
private final Cleanable closer; // 该通道关联的清理器
/** blocking operations are not interruptible */
private volatile boolean uninterruptible; // 设置该通道为忽略中断
/** Maximum size to map when using a mapped buffer */
private static final long MAPPED_TRANSFER_SIZE = 8L * 1024L * 1024L; // 8M
private static final int TRANSFER_SIZE = 8192; // 8KB
/**
* Assume at first that the underlying kernel supports sendfile();
* set this to false if we find out later that it doesn't
*/
// 指示系统内核是否支持通道间直接传输数据(预先假设它是支持的),如果后续发现不支持,则设置为false
private static volatile boolean transferSupported = true;
/**
* Assume that the underlying kernel sendfile() will work if the target fd is a file;
* set this to false if we find out later that it doesn't
*/
// 指示系统内核是否支持向文件通道直接写入数据(预先假设它是支持的),如果后续发现不支持,则设置为false
private static volatile boolean fileSupported = true;
/**
* Assume that the underlying kernel sendfile() will work if the target fd is a pipe;
* set this to false if we find out later that it doesn't
*/
// 指示系统内核是否支持向管道(本质还是socket通道)直接写入数据(预先假设它是支持的),如果后续发现不支持,则设置为false
private static volatile boolean pipeSupported = true;
private static final int MAP_RO = 0; // 只读映射
private static final int MAP_RW = 1; // 读写映射
private static final int MAP_PV = 2; // 写时拷贝映射
static {
// 触发IOUtil完成静态初始化(包括加载本地类库)
IOUtil.load();
// 获取系统分页大小
allocationGranularity = initIDs();
}
/*▼ 构造器 ████████████████████████████████████████████████████████████████████████████████┓ */
private FileChannelImpl(FileDescriptor fd, String path, boolean readable, boolean writable, boolean direct, Object parent) {
this.fd = fd;
this.readable = readable;
this.writable = writable;
this.parent = parent;
this.path = path;
this.direct = direct;
this.nd = new FileDispatcherImpl();
// 如果使用了DirectIO,则需要获取其对齐粒度
if(direct) {
assert path != null;
// 设置DirectIO的相关参数,返回DirectIO的对齐粒度
this.alignment = nd.setDirectIO(fd, path);
} else {
this.alignment = -1;
}
/*
* Register a cleaning action if and only if there is no parent as the parent will take care of closing the file descriptor.
* FileChannel is used by the LambdaMetaFactory so a lambda cannot be used here hence we use a nested class instead.
*/
// 如果当前通道没有关联流/文件,则需要为该通道关联一个清理器,以清理通道内的文件描述符
this.closer = parent != null ? null : CleanerFactory.cleaner().register(this, new Closer(fd));
}
/*▲ 构造器 ████████████████████████████████████████████████████████████████████████████████┛ */
/*▼ 工厂方法 ████████████████████████████████████████████████████████████████████████████████┓ */
/** Used by FileInputStream.getChannel(), FileOutputStream.getChannel and RandomAccessFile.getChannel() */
// 返回一个文件通道对象
public static FileChannel open(FileDescriptor fd, String path, boolean readable, boolean writable, boolean direct, Object parent) {
return new FileChannelImpl(fd, path, readable, writable, direct, parent);
}
/*▲ 工厂方法 ████████████████████████████████████████████████████████████████████████████████┛ */
/*▼ 读 ████████████████████████████████████████████████████████████████████████████████┓ */
/*
* 从当前文件通道(关联的文件)中起始处读取,读到的内容存入dst后,返回读到的字节数量
* 该方法是一次性地,即已经读完的流不可以重复读取
*/
public int read(ByteBuffer dst) throws IOException {
ensureOpen();
if(!readable) {
throw new NonReadableChannelException();
}
synchronized(positionLock) {
// 如果需要使用DirectIO
if(direct) {
// 确保position是alignment的整数倍,否则抛异常
Util.checkChannelPositionAligned(position(), alignment);
}
int n = 0;
int ti = -1;
try {
// 标记可能阻塞的IO操作的开始:需要为阻塞通道所在的线程设置中断回调,该回调在遇到线程中断时会关闭通道
beginBlocking();
ti = threads.add();
// 如果通道已关闭,直接返回
if(!isOpen()) {
return 0;
}
do {
// 从文件描述符fd(关联的文件)中起始处读取,读到的内容存入dst后,返回读到的字节数量
n = IOUtil.read(fd, dst, -1, direct, alignment, nd);
// 不会理会中断标记,会继续读取
} while((n == IOStatus.INTERRUPTED) && isOpen());
return IOStatus.normalize(n);
} finally {
threads.remove(ti);
// 标记可能阻塞的IO操作的结束:需要移除为阻塞通道所在的线程设置的中断回调
endBlocking(n>0);
assert IOStatus.check(n);
}
}
}
/*
* 从当前文件通道(关联的文件)中读取,读到的内容存入dst后,返回读到的字节数量
* 该方法可重复调用(因为position>=0),读取的位置是position指定的位置(支持随机读取)
*/
public int read(ByteBuffer dst, long position) throws IOException {
if(dst == null) {
throw new NullPointerException();
}
// 确保position不是负数
if(position<0) {
throw new IllegalArgumentException("Negative position");
}
if(!readable) {
throw new NonReadableChannelException();
}
// 如果需要使用DirectIO
if(direct) {
// 确保position是alignment的整数倍,否则抛异常
Util.checkChannelPositionAligned(position, alignment);
}
ensureOpen();
if(nd.needsPositionLock()) {
synchronized(positionLock) {
return readInternal(dst, position);
}
} else {
return readInternal(dst, position);
}
}
/*
* 从当前文件通道(关联的文件)中position位置处读取,读到的内容存入dst后,返回读到的字节数量
* 当position==-1时,该方法是一次性地,即已经读完的流不可以重复读取(不支持随机读取)
* 当position>=0时,该方法可重复调用,读取的位置是position指定的位置(支持随机读取)
*/
private int readInternal(ByteBuffer dst, long position) throws IOException {
assert !nd.needsPositionLock() || Thread.holdsLock(positionLock);
int n = 0;
int ti = -1;
try {
// 标记可能阻塞的IO操作的开始:需要为阻塞通道所在的线程设置中断回调,该回调在遇到线程中断时会关闭通道
beginBlocking();
ti = threads.add();
if(!isOpen()) {
return -1;
}
do {
// 从文件描述符fd(关联的文件)中position位置处读取,读到的内容存入dst后,返回读到的字节数量
n = IOUtil.read(fd, dst, position, direct, alignment, nd);
// 不会理会中断标记,会继续读取
} while((n == IOStatus.INTERRUPTED) && isOpen());
return IOStatus.normalize(n);
} finally {
threads.remove(ti);
// 标记可能阻塞的IO操作的结束:需要移除为阻塞通道所在的线程设置的中断回调
endBlocking(n>0);
assert IOStatus.check(n);
}
}
/*
* 【散射】从当前文件通道(关联的文件)中读取,读到的内容依次存入dsts中offset处起的length个缓冲区
* 该方法是一次性地,即已经读完的流不可以重复读取(不支持随机读取)
*/
public long read(ByteBuffer[] dsts, int offset, int length) throws IOException {
if((offset<0) || (length<0) || (offset>dsts.length - length)) {
throw new IndexOutOfBoundsException();
}
ensureOpen();
if(!readable) {
throw new NonReadableChannelException();
}
synchronized(positionLock) {
// 确保从字节对齐的地方开始读
if(direct) {
// 确保position是alignment的整数倍,否则抛异常
Util.checkChannelPositionAligned(position(), alignment);
}
long n = 0;
int ti = -1;
try {
// 标记可能阻塞的IO操作的开始:需要为阻塞通道所在的线程设置中断回调,该回调在遇到线程中断时会关闭通道
beginBlocking();
ti = threads.add();
if(!isOpen()) {
return 0;
}
do {
// 从文件描述符fd(关联的文件)中读取,读到的内容依次存入dsts中offset处起的length个缓冲区后,返回读到的字节数量
n = IOUtil.read(fd, dsts, offset, length, direct, alignment, nd);
// 不会理会中断标记,会继续读取
} while((n == IOStatus.INTERRUPTED) && isOpen());
return IOStatus.normalize(n);
} finally {
threads.remove(ti);
// 标记可能阻塞的IO操作的结束:需要移除为阻塞通道所在的线程设置的中断回调
endBlocking(n>0);
assert IOStatus.check(n);
}
}
}
/*▲ 读 ████████████████████████████████████████████████████████████████████████████████┛ */
/*▼ 写 ████████████████████████████████████████████████████████████████████████████████┓ */
/*
* 从缓冲区src读取,读到的内容向当前文件通道(关联的文件)中追加写入后,返回写入的字节数量
* 待写入内容从fd中上次position==-1时写完的末尾追加内容(不支持随机写入)
*/
public int write(ByteBuffer src) throws IOException {
ensureOpen();
if(!writable) {
throw new NonWritableChannelException();
}
synchronized(positionLock) {
// 确保向字节对齐的地方开始写
if(direct) {
// 确保position是alignment的整数倍,否则抛异常
Util.checkChannelPositionAligned(position(), alignment);
}
int n = 0;
int ti = -1;
try {
// 标记可能阻塞的IO操作的开始:需要为阻塞通道所在的线程设置中断回调,该回调在遇到线程中断时会关闭通道
beginBlocking();
ti = threads.add();
if(!isOpen()) {
return 0;
}
do {
// 从缓冲区src读取,读到的内容向文件描述符fd(关联的文件)中追加写入后,返回写入的字节数量
n = IOUtil.write(fd, src, -1, direct, alignment, nd);
} while((n == IOStatus.INTERRUPTED) && isOpen());
return IOStatus.normalize(n);
} finally {
threads.remove(ti);
// 标记可能阻塞的IO操作的结束:需要移除为阻塞通道所在的线程设置的中断回调
endBlocking(n>0);
assert IOStatus.check(n);
}
}
}
/*
* 【聚集】从缓冲区src读取,读到的内容向当前文件通道(关联的文件)中position位置处写入后,返回写入的字节数量
* 待写入内容从fd的position位置处开始写(支持随机写入)
*/
public int write(ByteBuffer src, long position) throws IOException {
if(src == null) {
throw new NullPointerException();
}
if(position<0) {
throw new IllegalArgumentException("Negative position");
}
if(!writable) {
throw new NonWritableChannelException();
}
// 确保向字节对齐的地方开始写
if(direct) {
// 确保position是alignment的整数倍,否则抛异常
Util.checkChannelPositionAligned(position, alignment);
}
ensureOpen();
// 以下完成写入操作
if(nd.needsPositionLock()) {
synchronized(positionLock) {
return writeInternal(src, position);
}
} else {
return writeInternal(src, position);
}
}
/*
* 从缓冲区src读取,读到的内容向当前文件通道(关联的文件)中position位置处写入后,返回写入的字节数量
* 当position==-1时,待写入内容从fd中上次position==-1时写完的末尾追加内容(不支持随机写入)
* 当position>=0时,待写入内容从fd的position位置处开始写(支持随机写入)
*/
private int writeInternal(ByteBuffer src, long position) throws IOException {
assert !nd.needsPositionLock() || Thread.holdsLock(positionLock);
int n = 0;
int ti = -1;
try {
// 标记可能阻塞的IO操作的开始:需要为阻塞通道所在的线程设置中断回调,该回调在遇到线程中断时会关闭通道
beginBlocking();
ti = threads.add();
if(!isOpen()) {
return -1;
}
do {
// 从缓冲区src读取,读到的内容向文件描述符fd(关联的文件)中position位置处写入后,返回写入的字节数量
n = IOUtil.write(fd, src, position, direct, alignment, nd);
} while((n == IOStatus.INTERRUPTED) && isOpen());
return IOStatus.normalize(n);
} finally {
threads.remove(ti);
// 标记可能阻塞的IO操作的结束:需要移除为阻塞通道所在的线程设置的中断回调
endBlocking(n>0);
assert IOStatus.check(n);
}
}
// 从srcs[offset, offset+length-1]中各个缓冲区读取,读到内容向当前文件通道(关联的文件)中起始位置处写入,返回写入的字节数量
public long write(ByteBuffer[] srcs, int offset, int length) throws IOException {
if((offset<0) || (length<0) || (offset>srcs.length - length)) {
throw new IndexOutOfBoundsException();
}
ensureOpen();
if(!writable) {
throw new NonWritableChannelException();
}
synchronized(positionLock) {
// 确保向字节对齐的地方开始写
if(direct) {
// 确保position是alignment的整数倍,否则抛异常
Util.checkChannelPositionAligned(position(), alignment);
}
long n = 0;
int ti = -1;
try {
// 标记可能阻塞的IO操作的开始:需要为阻塞通道所在的线程设置中断回调,该回调在遇到线程中断时会关闭通道
beginBlocking();
ti = threads.add();
if(!isOpen()) {
return 0;
}
do {
// 从srcs[offset, offset+length-1]中各个缓冲区读取数据,读到的内容向文件描述符fd(关联的文件)中起始位置处写入后,返回写入的字节数量
n = IOUtil.write(fd, srcs, offset, length, direct, alignment, nd);
} while((n == IOStatus.INTERRUPTED) && isOpen());
return IOStatus.normalize(n);
} finally {
threads.remove(ti);
// 标记可能阻塞的IO操作的结束:需要移除为阻塞通道所在的线程设置的中断回调
endBlocking(n>0);
assert IOStatus.check(n);
}
}
}
/*▲ 写 ████████████████████████████████████████████████████████████████████████████████┛ */
/*▼ 发送数据 ████████████████████████████████████████████████████████████████████████████████┓ */
/*
* 从当前文件通道的position位置起读取count个字节的数据(数量会经过修正),读到的数据会写入target通道,要求源通道可读,目标通道可写;返回实际传输的字节数量。
* 注:由于目标通道类型未知,因此将分别尝试直接传输、文件映射、普通NIO这三种方式传输数据
*/
public long transferTo(long position, long count, WritableByteChannel target) throws IOException {
ensureOpen();
if(!target.isOpen()) {
throw new ClosedChannelException();
}
// 要求源通道可读
if(!readable) {
throw new NonReadableChannelException();
}
// 要求目标通道可写
if(target instanceof FileChannelImpl && !((FileChannelImpl) target).writable) {
throw new NonWritableChannelException();
}
if((position<0) || (count<0)) {
throw new IllegalArgumentException();
}
// 获取当前文件通道的字节数量
long sz = size();
// 游标已经越界
if(position>sz) {
return 0;
}
// 待传输字节数量不能超过Integer.MAX_VALUE
int icount = (int) Math.min(count, Integer.MAX_VALUE);
// 如果已传输字节数量+待传输字节数量超出了通道字节总量,缩减待传输字节数量为一个合适的值
if((sz - position)<icount) {
icount = (int) (sz - position);
}
long n;
/* Attempt a direct transfer, if the kernel supports it */
// 1. 尝试直接从当前文件通道传输数据到目标通道,需要系统内核的支持
if((n = transferToDirectly(position, icount, target)) >= 0) {
return n;
}
/* Attempt a mapped transfer, but only to trusted channel types */
// 2. 尝试通过文件内存映射从当前文件通道向可信的目标通道传输数据
if((n = transferToTrustedChannel(position, icount, target)) >= 0) {
return n;
}
/* Slow path for untrusted targets */
// 3. 尝试通过NIO的方式从当前文件通道向目标通道传输数据
return transferToArbitraryChannel(position, icount, target);
}
// 1. 尝试直接从当前文件通道传输数据到目标通道,需要系统内核的支持
private long transferToDirectly(long position, int icount, WritableByteChannel target) throws IOException {
// 如果系统内核不支持通道间直接传输数据(预先假设它是支持的),直接返回
if(!transferSupported) {
return IOStatus.UNSUPPORTED;
}
// 目标通道的文件描述符
FileDescriptor targetFD = null;
// 如果目标通道是文件通道
if(target instanceof FileChannelImpl) {
// 如果系统内核不支持向文件通道直接写入数据(预先假设它是支持的),直接返回
if(!fileSupported) {
return IOStatus.UNSUPPORTED_CASE;
}
// 获取目标通道的文件描述符
targetFD = ((FileChannelImpl) target).fd;
// 如果目标通道是多路复用通道,主要指socket通道
} else if(target instanceof SelChImpl) {
/* Direct transfer to pipe causes EINVAL on some configurations */
// 如果目标通道是管道中的写通道,但系统内核不支持向管道(本质还是socket通道)直接写入数据,直接返回
if((target instanceof SinkChannelImpl) && !pipeSupported) {
return IOStatus.UNSUPPORTED_CASE;
}
/*
* Platform-specific restrictions.
* Now there is only one: Direct transfer to non-blocking channel could be forbidden
*/
SelectableChannel sc = (SelectableChannel) target;
// 如果系统不支持直接从文件通道向socket通道传输数据,直接返回(windows上默认不支持,类unix上默认支持)
if(!nd.canTransferToDirectly(sc)) {
return IOStatus.UNSUPPORTED_CASE;
}
// 获取目标通道的文件描述符
targetFD = ((SelChImpl) target).getFD();
}
// 如果目标通道类型未知,直接返回
if(targetFD == null) {
return IOStatus.UNSUPPORTED;
}
// 获取当前通道的文件描述符fd在本地(native层)的引用值
int thisFDVal = IOUtil.fdVal(fd);
// 获取目标通道的文件描述符targetFD在本地(native层)的引用值
int targetFDVal = IOUtil.fdVal(targetFD);
// 两值相等,说明是同一个(文件)通道,无需传输,直接返回
if(thisFDVal == targetFDVal) {
return IOStatus.UNSUPPORTED;
}
// 如果系统直接从文件通道向socket通道传输数据时需要锁定游标敏感的操作(windows上默认需要,类unix上默认不需要)
if(nd.transferToDirectlyNeedsPositionLock()) {
synchronized(positionLock) {
// 获取当前文件通道的游标
long pos = position();
try {
// 直接从当前文件通道传输数据到目标通道
return transferToDirectlyInternal(position, icount, target, targetFD);
} finally {
// 数据传输完毕后,恢复当前文件通道的游标
position(pos);
}
}
}
// 直接从当前文件通道传输数据到目标通道
return transferToDirectlyInternal(position, icount, target, targetFD);
}
// 2. 尝试通过文件内存映射从当前文件通道向可信的目标通道传输数据
private long transferToTrustedChannel(long position, long count, WritableByteChannel target) throws IOException {
boolean isSelChImpl = (target instanceof SelChImpl);
if(!((target instanceof FileChannelImpl) || isSelChImpl)) {
return IOStatus.UNSUPPORTED;
}
// Trusted target: Use a mapped buffer
long remaining = count;
// 分批传输数据
while(remaining>0L) {
// 本次传输的数据量
long size = Math.min(remaining, MAPPED_TRANSFER_SIZE);
try {
// 返回当前文件(通道)的只读映射
MappedByteBuffer dbb = map(MapMode.READ_ONLY, position, size);
try {
/* ## Bug: Closing this channel will not terminate the write */
// 向目标通道target中写入当前文件内存映射区dbb中包含的内容
int n = target.write(dbb);
assert n >= 0;
remaining -= n;
if(isSelChImpl) {
// one attempt to write to selectable channel
break;
}
assert n>0;
position += n;
} finally {
// 释放内存映射区
unmap(dbb);
}
} catch(ClosedByInterruptException e) {
// target closed by interrupt as ClosedByInterruptException needs to be thrown after closing this channel.
assert !target.isOpen();
try {
close();
} catch(Throwable suppressed) {
e.addSuppressed(suppressed);
}
throw e;
} catch(IOException ioe) {
// Only throw exception if no bytes have been written
if(remaining == count) {
throw ioe;
}
break;
}
} // while
return count - remaining;
}
// 3. 尝试通过NIO的方式从当前文件通道向目标通道传输数据
private long transferToArbitraryChannel(long position, int icount, WritableByteChannel target) throws IOException {
// Untrusted target: Use a newly-erased buffer
int size = Math.min(icount, TRANSFER_SIZE);
// 获取一块容量至少为size个字节的直接缓冲区(每次最多传输8KB)
ByteBuffer bb = Util.getTemporaryDirectBuffer(size);
long tw = 0; // Total bytes written
long pos = position;
try {
// 擦除Buffer中的数据(全部填充为0)
Util.erase(bb);
// 分批传输数据
while(tw<icount) {
// 设置新的上界limit
bb.limit(Math.min((int) (icount - tw), TRANSFER_SIZE));
// 从当前通道中pos位置起,将数据读到直接缓存区bb中
int nr = read(bb, pos);
if(nr<=0) {
break;
}
// 从写模式转入读模式
bb.flip();
/* ## Bug: Will block writing target if this channel is asynchronously closed */
// 向目标通道target中写入直接缓冲区bb包含的内容
int nw = target.write(bb);
tw += nw;
if(nw != nr) {
break;
}
pos += nw;
bb.clear();
}
return tw;
} catch(IOException x) {
if(tw>0) {
return tw;
}
throw x;
} finally {
// 采用FILO的形式(入栈模式)将bb放入Buffer缓存池以待复用
Util.releaseTemporaryDirectBuffer(bb);
}
}
// 直接从当前文件通道传输数据到目标通道,使用条件参见transferToDirectly()中的判断
private long transferToDirectlyInternal(long position, int icount, WritableByteChannel target, FileDescriptor targetFD) throws IOException {
assert !nd.transferToDirectlyNeedsPositionLock() || Thread.holdsLock(positionLock);
long n = -1;
int ti = -1;
try {
// 标记可能阻塞的IO操作的开始:需要为阻塞通道所在的线程设置中断回调,该回调在遇到线程中断时会关闭通道
beginBlocking();
ti = threads.add();
if(!isOpen()) {
return -1;
}
do {
// 直接从文件描述符fd所在的文件通道传输数据到目标通道
n = transferTo0(fd, position, icount, targetFD);
} while((n == IOStatus.INTERRUPTED) && isOpen());
// 如果平台不支持文件通道向socket通道传输数据(不一定不支持其他通道)
if(n == IOStatus.UNSUPPORTED_CASE) {
if(target instanceof SinkChannelImpl) {
pipeSupported = false;
}
if(target instanceof FileChannelImpl) {
fileSupported = false;
}
return IOStatus.UNSUPPORTED_CASE;
}
// 如果操作系统不支持通道间直接传输数据(不支持任何通道)
if(n == IOStatus.UNSUPPORTED) {
// Don't bother trying again
transferSupported = false;
return IOStatus.UNSUPPORTED;
}
return IOStatus.normalize(n);
} finally {
threads.remove(ti);
// 清除之前设置的线程中断回调
end(n>-1);
}
}
/*▲ 发送数据 ████████████████████████████████████████████████████████████████████████████████┛ */
/*▼ 接收数据 ████████████████████████████████████████████████████████████████████████████████┓ */
/*
* 从源通道src中起始位置处读取count个字节,读到的数据写入当前文件通道的position位置,要求源通道可读,当前文件通道可写;返回实际接收的字节数量。
* 注:由于本次写入的目标通道就是当前文件通道,所以不需要尝试直接传输技术(不支持直接向文件通道直接传输数据),这里只需要尝试文件映射和普通NIO这两种方式传输数据
*/
public long transferFrom(ReadableByteChannel src, long position, long count) throws IOException {
ensureOpen();
if(!src.isOpen()) {
throw new ClosedChannelException();
}
// 要求目标通道可写
if(!writable) {
throw new NonWritableChannelException();
}
if((position<0) || (count<0)) {
throw new IllegalArgumentException();
}
// 写入的位置超出了当前文件通道现有的字节数量,直接返回
if(position>size()) {
return 0;
}
// 如果源通道也是文件通道
if(src instanceof FileChannelImpl) {
// 1. 尝试通过文件内存映射从源通道向当前文件通道传输数据
return transferFromFileChannel((FileChannelImpl) src, position, count);
}
// 2. 尝试通过NIO的方式从源通道向当前文件通道传输数据
return transferFromArbitraryChannel(src, position, count);
}
// 1. 尝试通过文件内存映射从源通道向当前文件通道传输数据
private long transferFromFileChannel(FileChannelImpl src, long position, long count) throws IOException {
if(!src.readable) {
throw new NonReadableChannelException();
}
synchronized(src.positionLock) {
// 获取源通道的游标
long pos = src.position();
// 修正需要从源通道读取的字节数
long max = Math.min(count, src.size() - pos);
long remaining = max;
long p = pos;
while(remaining>0L) {
// 本次传输的数据量
long size = Math.min(remaining, MAPPED_TRANSFER_SIZE);
/* ## Bug: Closing this channel will not terminate the write */
// 返回源通道的只读文件映射内存
MappedByteBuffer bb = src.map(MapMode.READ_ONLY, p, size);
try {
// 向当前通道的position处写入源文件内存映射区bb中包含的数据
long n = write(bb, position);
assert n>0;
p += n;
position += n;
remaining -= n;
} catch(IOException ioe) {
// Only throw exception if no bytes have been written
if(remaining == max) {
throw ioe;
}
break;
} finally {
// 释放内存映射区
unmap(bb);
}
}
long nwritten = max - remaining;
src.position(pos + nwritten);
return nwritten;
}
}
// 2. 尝试通过NIO的方式从源通道向当前文件通道传输数据
private long transferFromArbitraryChannel(ReadableByteChannel src, long position, long count) throws IOException {
// Untrusted target: Use a newly-erased buffer
int size = (int) Math.min(count, TRANSFER_SIZE);
// 获取一块容量至少为size个字节的直接缓冲区(每次最多传输8KB)
ByteBuffer bb = Util.getTemporaryDirectBuffer(size);
long tw = 0; // Total bytes written
long pos = position;
try {
// 擦除Buffer中的数据(全部填充为0)
Util.erase(bb);
// 分批传输数据
while(tw<count) {
// 设置新的上界limit
bb.limit((int) Math.min((count - tw), (long) TRANSFER_SIZE));
/* ## Bug: Will block reading src if this channel is asynchronously closed */
// 从源通道src中读取,读到的内容存入直接缓冲区bb
int nr = src.read(bb);
if(nr<=0) {
break;
}
// 从写模式转入读模式
bb.flip();
// 向当前通道的pos处写入,写入的内容包含在直接缓冲区bb中
int nw = write(bb, pos);
tw += nw;
if(nw != nr) {
break;
}
pos += nw;
bb.clear();
}
return tw;
} catch(IOException x) {
if(tw>0) {
return tw;
}
throw x;
} finally {
// 采用FILO的形式(入栈模式)将bb放入Buffer缓存池以待复用
Util.releaseTemporaryDirectBuffer(bb);
}
}
/*▲ 接收数据 ████████████████████████████████████████████████████████████████████████████████┛ */
/*▼ 内存映射 ████████████████████████████████████████████████████████████████████████████████┓ */
/*
* 返回一块文件映射内存(经过了包装,加入了内存清理操作)
*