summaryrefslogtreecommitdiff
path: root/libjava/classpath/gnu/java/nio/FileChannelImpl.java
blob: c17227d3d151491a539feabc2b210b5dd49dd217 (plain)
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
/* FileChannelImpl.java --
   Copyright (C) 2002, 2004, 2005, 2006  Free Software Foundation, Inc.

This file is part of GNU Classpath.

GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.

GNU Classpath 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 for more details.

You should have received a copy of the GNU General Public License
along with GNU Classpath; see the file COPYING.  If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301 USA.

Linking this library statically or dynamically with other modules is
making a combined work based on this library.  Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.

As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under
terms of your choice, provided that you also meet, for each linked
independent module, the terms and conditions of the license of that
module.  An independent module is a module which is not derived from
or based on this library.  If you modify this library, you may extend
this exception to your version of the library, but you are not
obligated to do so.  If you do not wish to do so, delete this
exception statement from your version. */


package gnu.java.nio;

import gnu.classpath.Configuration;
import gnu.java.nio.FileLockImpl;
import gnu.java.nio.VMChannel;

import java.io.File;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.nio.ByteBuffer;
import java.nio.MappedByteBuffer;
import java.nio.channels.ClosedChannelException;
import java.nio.channels.FileChannel;
import java.nio.channels.FileLock;
import java.nio.channels.NonReadableChannelException;
import java.nio.channels.NonWritableChannelException;
import java.nio.channels.ReadableByteChannel;
import java.nio.channels.WritableByteChannel;

/**
 * This file is not user visible !
 * But alas, Java does not have a concept of friendly packages
 * so this class is public.
 * Instances of this class are created by invoking getChannel
 * Upon a Input/Output/RandomAccessFile object.
 */
public final class FileChannelImpl extends FileChannel
{
  // These are mode values for open().
  public static final int READ   = 1;
  public static final int WRITE  = 2;
  public static final int APPEND = 4;

  // EXCL is used only when making a temp file.
  public static final int EXCL   = 8;
  public static final int SYNC   = 16;
  public static final int DSYNC  = 32;

  public static final FileChannelImpl in;
  public static final FileChannelImpl out;
  public static final FileChannelImpl err;

  //private static native void init();

  static
  {
    if (Configuration.INIT_LOAD_LIBRARY)
      {
        System.loadLibrary("javanio");
      }

    //init();

    FileChannelImpl ch = null;
    try
      {
        ch = new FileChannelImpl(VMChannel.getStdin(), READ);
      }
    catch (IOException ioe)
      {
        throw new Error(ioe);
      }
    in = ch;

    ch = null;
    try
      {
        ch = new FileChannelImpl(VMChannel.getStdout(), WRITE);
      }
    catch (IOException ioe)
      {
        throw new Error(ioe);
      }
    out = ch;

    ch = null;
    try
      {
        ch = new FileChannelImpl(VMChannel.getStderr(), WRITE);
      }
    catch (IOException ioe)
      {
        throw new Error(ioe);
      }
    err = ch;
  }

  /**
   * This is the actual native file descriptor value
   */
  private VMChannel ch;

  private int mode;

  final String description;

  /* Open a file.  MODE is a combination of the above mode flags. */
  /* This is a static factory method, so that VM implementors can decide
   * substitute subclasses of FileChannelImpl. */
  public static FileChannelImpl create(File file, int mode)
    throws IOException
  {
    return new FileChannelImpl(file, mode);
  }

  private FileChannelImpl(File file, int mode)
    throws IOException
  {
    String path = file.getPath();
    description = path;
    this.mode = mode;
    this.ch = new VMChannel();
    ch.openFile(path, mode);

    // First open the file and then check if it is a a directory
    // to avoid race condition.
    if (file.isDirectory())
      {
        try
          {
            close();
          }
        catch (IOException e)
          {
            /* ignore it */
          }

        throw new FileNotFoundException(description + " is a directory");
      }
  }

  /**
   * Constructor for default channels in, out and err.
   *
   * Used by init() (native code).
   *
   * @param fd the file descriptor (0, 1, 2 for stdin, stdout, stderr).
   *
   * @param mode READ or WRITE
   */
  FileChannelImpl (VMChannel ch, int mode)
  {
    this.mode = mode;
    this.description = "descriptor(" + ch.getState() + ")";
    this.ch = ch;
  }

  public int available() throws IOException
  {
    return ch.available();
  }

  private long implPosition() throws IOException
  {
    return ch.position();
  }

  private void seek(long newPosition) throws IOException
  {
    ch.seek(newPosition);
  }

  private void implTruncate(long size) throws IOException
  {
    ch.truncate(size);
  }

  public void unlock(long pos, long len) throws IOException
  {
    ch.unlock(pos, len);
  }

  public long size () throws IOException
  {
    return ch.size();
  }

  protected void implCloseChannel() throws IOException
  {
    ch.close();
  }

  /**
   * Makes sure the Channel is properly closed.
   */
  protected void finalize() throws IOException
  {
    if (ch.getState().isValid())
      close();
  }

  public int read (ByteBuffer dst) throws IOException
  {
    return ch.read(dst);
  }

  public int read (ByteBuffer dst, long position)
    throws IOException
  {
    if (position < 0)
      throw new IllegalArgumentException ("position: " + position);
    long oldPosition = implPosition ();
    position (position);
    int result = read(dst);
    position (oldPosition);

    return result;
  }

  public int read() throws IOException
  {
    return ch.read();
  }

  public long read (ByteBuffer[] dsts, int offset, int length)
    throws IOException
  {
    return ch.readScattering(dsts, offset, length);
  }

  public int write (ByteBuffer src) throws IOException
  {
    return ch.write(src);
  }

  public int write (ByteBuffer src, long position)
    throws IOException
  {
    if (position < 0)
      throw new IllegalArgumentException ("position: " + position);

    if (!isOpen ())
      throw new ClosedChannelException ();

    if ((mode & WRITE) == 0)
       throw new NonWritableChannelException ();

    int result;
    long oldPosition;

    oldPosition = implPosition ();
    seek (position);
    result = write(src);
    seek (oldPosition);

    return result;
  }

  public void write (int b) throws IOException
  {
    ch.write(b);
  }

  public long write(ByteBuffer[] srcs, int offset, int length)
    throws IOException
  {
    return ch.writeGathering(srcs, offset, length);
  }

  public MappedByteBuffer map (FileChannel.MapMode mode,
                               long position, long size)
    throws IOException
  {
    char nmode = 0;
    if (mode == MapMode.READ_ONLY)
      {
        nmode = 'r';
        if ((this.mode & READ) == 0)
          throw new NonReadableChannelException();
      }
    else if (mode == MapMode.READ_WRITE || mode == MapMode.PRIVATE)
      {
        nmode = mode == MapMode.READ_WRITE ? '+' : 'c';
        if ((this.mode & WRITE) != WRITE)
          throw new NonWritableChannelException();
        if ((this.mode & READ) != READ)
          throw new NonReadableChannelException();
      }
    else
      throw new IllegalArgumentException ("mode: " + mode);

    if (position < 0 || size < 0 || size > Integer.MAX_VALUE)
      throw new IllegalArgumentException ("position: " + position
                                          + ", size: " + size);
    return ch.map(nmode, position, (int) size);
  }

  /**
   * msync with the disk
   */
  public void force (boolean metaData) throws IOException
  {
    if (!isOpen ())
      throw new ClosedChannelException ();

    ch.flush(metaData);
  }

  // like transferTo, but with a count of less than 2Gbytes
  private int smallTransferTo (long position, int count,
                               WritableByteChannel target)
    throws IOException
  {
    ByteBuffer buffer;
    try
      {
        // Try to use a mapped buffer if we can.  If this fails for
        // any reason we'll fall back to using a ByteBuffer.
        buffer = map (MapMode.READ_ONLY, position, count);
      }
    catch (IOException e)
      {
        buffer = ByteBuffer.allocate (count);
        read (buffer, position);
        buffer.flip();
      }

    return target.write (buffer);
  }

  public long transferTo (long position, long count,
                          WritableByteChannel target)
    throws IOException
  {
    if (position < 0
        || count < 0)
      throw new IllegalArgumentException ("position: " + position
                                          + ", count: " + count);

    if (!isOpen ())
      throw new ClosedChannelException ();

    if ((mode & READ) == 0)
       throw new NonReadableChannelException ();

    final int pageSize = 65536;
    long total = 0;

    while (count > 0)
      {
        int transferred
          = smallTransferTo (position, (int)Math.min (count, pageSize),
                             target);
        if (transferred < 0)
          break;
        total += transferred;
        position += transferred;
        count -= transferred;
      }

    return total;
  }

  // like transferFrom, but with a count of less than 2Gbytes
  private int smallTransferFrom (ReadableByteChannel src, long position,
                                 int count)
    throws IOException
  {
    ByteBuffer buffer = null;

    if (src instanceof FileChannel)
      {
        try
          {
            // Try to use a mapped buffer if we can.  If this fails
            // for any reason we'll fall back to using a ByteBuffer.
            buffer = ((FileChannel)src).map (MapMode.READ_ONLY, position,
                                             count);
          }
        catch (IOException e)
          {
          }
      }

    if (buffer == null)
      {
        buffer = ByteBuffer.allocate (count);
        src.read (buffer);
        buffer.flip();
      }

    return write (buffer, position);
  }

  public long transferFrom (ReadableByteChannel src, long position,
                            long count)
    throws IOException
  {
    if (position < 0
        || count < 0)
      throw new IllegalArgumentException ("position: " + position
                                          + ", count: " + count);

    if (!isOpen ())
      throw new ClosedChannelException ();

    if ((mode & WRITE) == 0)
       throw new NonWritableChannelException ();

    final int pageSize = 65536;
    long total = 0;

    while (count > 0)
      {
        int transferred = smallTransferFrom (src, position,
                                             (int)Math.min (count, pageSize));
        if (transferred < 0)
          break;
        total += transferred;
        position += transferred;
        count -= transferred;
      }

    return total;
  }

  // Shared sanity checks between lock and tryLock methods.
  private void lockCheck(long position, long size, boolean shared)
    throws IOException
  {
    if (position < 0
        || size < 0)
      throw new IllegalArgumentException ("position: " + position
                                          + ", size: " + size);

    if (!isOpen ())
      throw new ClosedChannelException();

    if (shared && ((mode & READ) == 0))
      throw new NonReadableChannelException();

    if (!shared && ((mode & WRITE) == 0))
      throw new NonWritableChannelException();
  }

  public FileLock tryLock (long position, long size, boolean shared)
    throws IOException
  {
    lockCheck(position, size, shared);

    boolean completed = false;
    try
      {
        begin();
        boolean lockable = ch.lock(position, size, shared, false);
        completed = true;
        return (lockable
                ? new FileLockImpl(this, position, size, shared)
                : null);
      }
    finally
      {
        end(completed);
      }
  }

  public FileLock lock (long position, long size, boolean shared)
    throws IOException
  {
    lockCheck(position, size, shared);

    boolean completed = false;
    try
      {
        boolean lockable = ch.lock(position, size, shared, true);
        completed = true;
        return (lockable
                ? new FileLockImpl(this, position, size, shared)
                : null);
      }
    finally
      {
        end(completed);
      }
  }

  public long position ()
    throws IOException
  {
    if (!isOpen ())
      throw new ClosedChannelException ();

    return implPosition ();
  }

  public FileChannel position (long newPosition)
    throws IOException
  {
    if (newPosition < 0)
      throw new IllegalArgumentException ("newPosition: " + newPosition);

    if (!isOpen ())
      throw new ClosedChannelException ();

    // FIXME note semantics if seeking beyond eof.
    // We should seek lazily - only on a write.
    seek (newPosition);
    return this;
  }

  public FileChannel truncate (long size)
    throws IOException
  {
    if (size < 0)
      throw new IllegalArgumentException ("size: " + size);

    if (!isOpen ())
      throw new ClosedChannelException ();

    if ((mode & WRITE) == 0)
       throw new NonWritableChannelException ();

    if (size < size ())
      implTruncate (size);

    return this;
  }

  public String toString()
  {
    return (super.toString()
            + "[ fd: " + ch.getState()
            + "; mode: " + Integer.toOctalString(mode)
            + "; " + description + " ]");
  }

  /**
   * @return The native file descriptor.
   * /
  public int getNativeFD()
  {
    return fd;
  }*/
}