jdk/src/java.base/share/classes/jdk/internal/jimage/PReader.java
author chegar
Wed, 03 Dec 2014 14:22:58 +0000
changeset 27565 729f9700483a
permissions -rw-r--r--
8049367: Modular Run-Time Images Reviewed-by: chegar, dfuchs, ihse, joehw, mullan, psandoz, wetmore Contributed-by: alan.bateman@oracle.com, alex.buckley@oracle.com, bradford.wetmore@oracle.com, chris.hegarty@oracle.com, erik.joelsson@oracle.com, james.laskey@oracle.com, jonathan.gibbons@oracle.com, karen.kinnear@oracle.com, magnus.ihse.bursie@oracle.com, mandy.chung@oracle.com, mark.reinhold@oracle.com, paul.sandoz@oracle.com, sundararajan.athijegannathan@oracle.com
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
27565
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
     1
/*
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
     2
 * Copyright (c) 2014, Oracle and/or its affiliates. All rights reserved.
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
     4
 *
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    10
 *
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    15
 * accompanied this code).
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    16
 *
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    20
 *
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    23
 * questions.
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    24
 */
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    25
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    26
package jdk.internal.jimage;
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    27
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    28
import java.io.Closeable;
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    29
import java.io.IOException;
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    30
import java.io.RandomAccessFile;
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    31
import java.nio.channels.FileChannel;
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    32
import java.lang.reflect.Constructor;
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    33
import java.lang.reflect.InvocationTargetException;
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    34
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    35
/**
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    36
 * Supports reading a file from given positions (offsets) in the file.
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    37
 */
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    38
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    39
public abstract class PReader implements Closeable {
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    40
    private final FileChannel fc;
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    41
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    42
    protected PReader(FileChannel fc) {
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    43
        this.fc = fc;
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    44
    }
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    45
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    46
    /**
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    47
     * Returns the {@code FileChannel}.
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    48
     */
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    49
    final FileChannel channel() {
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    50
        return fc;
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    51
    }
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    52
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    53
    /**
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    54
     * Closes this {@code PReader} and the underlying file.
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    55
     */
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    56
    @Override
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    57
    public final void close() throws IOException {
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    58
        fc.close();
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    59
    }
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    60
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    61
    /**
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    62
     * Returns {@code true} if this {@code PReader} and the underlying file is
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    63
     * open.
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    64
     */
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    65
    public final boolean isOpen() {
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    66
        return fc.isOpen();
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    67
    }
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    68
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    69
    /**
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    70
     * Returns {@code len} bytes from a given position in the file. The bytes
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    71
     * are returned as a byte array.
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    72
     *
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    73
     * @throws IOException if an I/O error occurs
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    74
     */
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    75
    public abstract byte[] read(int len, long position) throws IOException;
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    76
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    77
    /**
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    78
     * Opens the given file, returning a {@code PReader} to read from the file.
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    79
     *
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    80
     * @implNote Returns a {@code PReader} that supports concurrent pread operations
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    81
     * if possible, otherwise a simple {@code PReader} that doesn't support
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    82
     * concurrent operations.
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    83
     */
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    84
    static PReader open(String file) throws IOException {
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    85
        Class<?> clazz;
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    86
        try {
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    87
            clazz = Class.forName("jdk.internal.jimage.concurrent.ConcurrentPReader");
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    88
        } catch (ClassNotFoundException e) {
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    89
            return new SimplePReader(file);
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    90
        }
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    91
        try {
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    92
            Constructor<?> ctor = clazz.getConstructor(String.class);
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    93
            return (PReader) ctor.newInstance(file);
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    94
        } catch (InvocationTargetException e) {
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    95
            Throwable cause = e.getCause();
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    96
            if (cause instanceof IOException)
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    97
                throw (IOException) cause;
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    98
            if (cause instanceof Error)
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    99
                throw (Error) cause;
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
   100
            if (cause instanceof RuntimeException)
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
   101
                throw (RuntimeException) cause;
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
   102
            throw new Error(e);
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
   103
        } catch (NoSuchMethodException | IllegalAccessException |
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
   104
                InstantiationException e) {
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
   105
            throw new InternalError(e);
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
   106
        }
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
   107
    }
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
   108
}
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
   109
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
   110
/**
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
   111
 * Simple PReader implementation based on {@code RandomAccessFile}.
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
   112
 *
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
   113
 * @implNote This class cannot use FileChannel read methods to do the
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
   114
 * positional reads because FileChannel is interruptible.
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
   115
 */
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
   116
class SimplePReader extends PReader {
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
   117
    private final RandomAccessFile raf;
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
   118
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
   119
    private SimplePReader(RandomAccessFile raf) throws IOException {
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
   120
        super(raf.getChannel());
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
   121
        this.raf = raf;
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
   122
    }
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
   123
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
   124
    SimplePReader(String file) throws IOException {
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
   125
        this(new RandomAccessFile(file, "r"));
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
   126
    }
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
   127
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
   128
    @Override
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
   129
    public byte[] read(int len, long position) throws IOException {
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
   130
        synchronized (this) {
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
   131
            byte[] bytes = new byte[len];
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
   132
            raf.seek(position);
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
   133
            int n = raf.read(bytes);
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
   134
            if (n != len)
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
   135
                throw new InternalError("short read, not handled yet");
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
   136
            return bytes;
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
   137
        }
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
   138
    }
729f9700483a 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
   139
}