src/jdk.jfr/share/classes/jdk/jfr/consumer/RecordingFile.java
author mgronlun
Wed, 30 Oct 2019 19:43:52 +0100
changeset 58863 c16ac7a2eba4
parent 52850 f527b24990d7
permissions -rw-r--r--
8226511: Implement JFR Event Streaming Reviewed-by: egahlin, mseledtsov, mgronlun Contributed-by: erik.gahlin@oracle.com, mikhailo.seledtsov@oracle.com, markus.gronlund@oracle.com
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
50113
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     1
/*
58863
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 52850
diff changeset
     2
 * Copyright (c) 2016, 2019, Oracle and/or its affiliates. All rights reserved.
50113
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     4
 *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    10
 *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    15
 * accompanied this code).
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    16
 *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    20
 *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    23
 * questions.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    24
 */
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    25
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    26
package jdk.jfr.consumer;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    27
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    28
import java.io.Closeable;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    29
import java.io.EOFException;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    30
import java.io.File;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    31
import java.io.IOException;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    32
import java.nio.file.NoSuchFileException;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    33
import java.nio.file.Path;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    34
import java.util.ArrayList;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    35
import java.util.HashSet;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    36
import java.util.List;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    37
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    38
import jdk.jfr.EventType;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    39
import jdk.jfr.internal.MetadataDescriptor;
52850
f527b24990d7 8205516: JFR tool
egahlin
parents: 50113
diff changeset
    40
import jdk.jfr.internal.Type;
50113
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    41
import jdk.jfr.internal.consumer.ChunkHeader;
58863
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 52850
diff changeset
    42
import jdk.jfr.internal.consumer.ChunkParser;
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 52850
diff changeset
    43
import jdk.jfr.internal.consumer.FileAccess;
50113
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    44
import jdk.jfr.internal.consumer.RecordingInput;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    45
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    46
/**
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    47
 * A recording file.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    48
 * <p>
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    49
 * The following example shows how read and print all events in a recording file.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    50
 *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    51
 * <pre>
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    52
 * <code>
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    53
 * try (RecordingFile recordingFile = new RecordingFile(Paths.get("recording.jfr"))) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    54
 *   while (recordingFile.hasMoreEvents()) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    55
 *     RecordedEvent event = recordingFile.readEvent();
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    56
 *     System.out.println(event);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    57
 *   }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    58
 * }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    59
 * </code>
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    60
 * </pre>
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    61
 *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    62
 * @since 9
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    63
 */
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    64
public final class RecordingFile implements Closeable {
52850
f527b24990d7 8205516: JFR tool
egahlin
parents: 50113
diff changeset
    65
f527b24990d7 8205516: JFR tool
egahlin
parents: 50113
diff changeset
    66
    private boolean isLastEventInChunk;
50113
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    67
    private final File file;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    68
    private RecordingInput input;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    69
    private ChunkParser chunkParser;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    70
    private RecordedEvent nextEvent;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    71
    private boolean eof;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    72
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    73
    /**
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    74
     * Creates a recording file.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    75
     *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    76
     * @param file the path of the file to open, not {@code null}
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    77
     * @throws IOException if it's not a valid recording file, or an I/O error
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    78
     *         occurred
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    79
     * @throws NoSuchFileException if the {@code file} can't be located
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    80
     *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    81
     * @throws SecurityException if a security manager exists and its
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    82
     *         {@code checkRead} method denies read access to the file.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    83
     */
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    84
    public RecordingFile(Path file) throws IOException {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    85
        this.file = file.toFile();
58863
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 52850
diff changeset
    86
        this.input = new RecordingInput(this.file, FileAccess.UNPRIVILIGED);
50113
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    87
        findNext();
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    88
    }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    89
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    90
    /**
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    91
     * Reads the next event in the recording.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    92
     *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    93
     * @return the next event, not {@code null}
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    94
     *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    95
     * @throws EOFException if no more events exist in the recording file
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    96
     * @throws IOException if an I/O error occurs.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    97
     *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    98
     * @see #hasMoreEvents()
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    99
     */
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   100
    public RecordedEvent readEvent() throws IOException {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   101
        if (eof) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   102
            ensureOpen();
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   103
            throw new EOFException();
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   104
        }
52850
f527b24990d7 8205516: JFR tool
egahlin
parents: 50113
diff changeset
   105
        isLastEventInChunk = false;
50113
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   106
        RecordedEvent event = nextEvent;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   107
        nextEvent = chunkParser.readEvent();
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   108
        if (nextEvent == null) {
52850
f527b24990d7 8205516: JFR tool
egahlin
parents: 50113
diff changeset
   109
            isLastEventInChunk = true;
50113
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   110
            findNext();
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   111
        }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   112
        return event;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   113
    }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   114
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   115
    /**
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   116
     * Returns {@code true} if unread events exist in the recording file,
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   117
     * {@code false} otherwise.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   118
     *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   119
     * @return {@code true} if unread events exist in the recording, {@code false}
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   120
     *         otherwise.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   121
     */
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   122
    public boolean hasMoreEvents() {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   123
        return !eof;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   124
    }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   125
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   126
    /**
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   127
     * Returns a list of all event types in this recording.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   128
     *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   129
     * @return a list of event types, not {@code null}
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   130
     * @throws IOException if an I/O error occurred while reading from the file
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   131
     *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   132
     * @see #hasMoreEvents()
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   133
     */
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   134
    public List<EventType> readEventTypes() throws IOException {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   135
        ensureOpen();
58863
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 52850
diff changeset
   136
        MetadataDescriptor previous = null;
50113
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   137
        List<EventType> types = new ArrayList<>();
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   138
        HashSet<Long> foundIds = new HashSet<>();
58863
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 52850
diff changeset
   139
        try (RecordingInput ri = new RecordingInput(file, FileAccess.UNPRIVILIGED)) {
50113
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   140
            ChunkHeader ch = new ChunkHeader(ri);
58863
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 52850
diff changeset
   141
            aggregateEventTypeForChunk(ch, null, types, foundIds);
52850
f527b24990d7 8205516: JFR tool
egahlin
parents: 50113
diff changeset
   142
            while (!ch.isLastChunk()) {
f527b24990d7 8205516: JFR tool
egahlin
parents: 50113
diff changeset
   143
                ch = ch.nextHeader();
58863
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 52850
diff changeset
   144
                previous = aggregateEventTypeForChunk(ch, previous, types, foundIds);
52850
f527b24990d7 8205516: JFR tool
egahlin
parents: 50113
diff changeset
   145
            }
f527b24990d7 8205516: JFR tool
egahlin
parents: 50113
diff changeset
   146
        }
f527b24990d7 8205516: JFR tool
egahlin
parents: 50113
diff changeset
   147
        return types;
f527b24990d7 8205516: JFR tool
egahlin
parents: 50113
diff changeset
   148
    }
f527b24990d7 8205516: JFR tool
egahlin
parents: 50113
diff changeset
   149
f527b24990d7 8205516: JFR tool
egahlin
parents: 50113
diff changeset
   150
    List<Type> readTypes() throws IOException  {
f527b24990d7 8205516: JFR tool
egahlin
parents: 50113
diff changeset
   151
        ensureOpen();
58863
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 52850
diff changeset
   152
        MetadataDescriptor previous = null;
52850
f527b24990d7 8205516: JFR tool
egahlin
parents: 50113
diff changeset
   153
        List<Type> types = new ArrayList<>();
f527b24990d7 8205516: JFR tool
egahlin
parents: 50113
diff changeset
   154
        HashSet<Long> foundIds = new HashSet<>();
58863
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 52850
diff changeset
   155
        try (RecordingInput ri = new RecordingInput(file, FileAccess.UNPRIVILIGED)) {
52850
f527b24990d7 8205516: JFR tool
egahlin
parents: 50113
diff changeset
   156
            ChunkHeader ch = new ChunkHeader(ri);
58863
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 52850
diff changeset
   157
            ch.awaitFinished();
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 52850
diff changeset
   158
            aggregateTypeForChunk(ch, null, types, foundIds);
50113
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   159
            while (!ch.isLastChunk()) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   160
                ch = ch.nextHeader();
58863
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 52850
diff changeset
   161
                previous = aggregateTypeForChunk(ch, previous, types, foundIds);
50113
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   162
            }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   163
        }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   164
        return types;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   165
    }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   166
58863
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 52850
diff changeset
   167
    private MetadataDescriptor aggregateTypeForChunk(ChunkHeader ch, MetadataDescriptor previous, List<Type> types, HashSet<Long> foundIds) throws IOException {
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 52850
diff changeset
   168
        MetadataDescriptor m = ch.readMetadata(previous);
52850
f527b24990d7 8205516: JFR tool
egahlin
parents: 50113
diff changeset
   169
        for (Type t : m.getTypes()) {
f527b24990d7 8205516: JFR tool
egahlin
parents: 50113
diff changeset
   170
            if (!foundIds.contains(t.getId())) {
f527b24990d7 8205516: JFR tool
egahlin
parents: 50113
diff changeset
   171
                types.add(t);
f527b24990d7 8205516: JFR tool
egahlin
parents: 50113
diff changeset
   172
                foundIds.add(t.getId());
f527b24990d7 8205516: JFR tool
egahlin
parents: 50113
diff changeset
   173
            }
f527b24990d7 8205516: JFR tool
egahlin
parents: 50113
diff changeset
   174
        }
58863
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 52850
diff changeset
   175
        return m;
52850
f527b24990d7 8205516: JFR tool
egahlin
parents: 50113
diff changeset
   176
    }
f527b24990d7 8205516: JFR tool
egahlin
parents: 50113
diff changeset
   177
58863
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 52850
diff changeset
   178
    private static MetadataDescriptor aggregateEventTypeForChunk(ChunkHeader ch,  MetadataDescriptor previous, List<EventType> types, HashSet<Long> foundIds) throws IOException {
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 52850
diff changeset
   179
        MetadataDescriptor m = ch.readMetadata(previous);
50113
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   180
        for (EventType t : m.getEventTypes()) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   181
            if (!foundIds.contains(t.getId())) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   182
                types.add(t);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   183
                foundIds.add(t.getId());
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   184
            }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   185
        }
58863
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 52850
diff changeset
   186
        return m;
50113
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   187
    }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   188
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   189
    /**
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   190
     * Closes this recording file and releases any system resources that are
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   191
     * associated with it.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   192
     *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   193
     * @throws IOException if an I/O error occurred
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   194
     */
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   195
    public void close() throws IOException {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   196
        if (input != null) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   197
            eof = true;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   198
            input.close();
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   199
            chunkParser = null;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   200
            input = null;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   201
            nextEvent = null;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   202
        }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   203
    }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   204
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   205
    /**
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   206
     * Returns a list of all events in a file.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   207
     * <p>
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   208
     * This method is intended for simple cases where it's convenient to read all
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   209
     * events in a single operation. It isn't intended for reading large files.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   210
     *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   211
     * @param path the path to the file, not {@code null}
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   212
     *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   213
     * @return the events from the file as a {@code List} object; whether the
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   214
     *         {@code List} is modifiable or not is implementation dependent and
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   215
     *         therefore not specified, not {@code null}
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   216
     *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   217
     * @throws IOException if an I/O error occurred, it's not a Flight Recorder
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   218
     *         file or a version of a JFR file that can't be parsed
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   219
     *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   220
     * @throws SecurityException if a security manager exists and its
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   221
     *         {@code checkRead} method denies read access to the file.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   222
     */
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   223
    public static List<RecordedEvent> readAllEvents(Path path) throws IOException {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   224
        try (RecordingFile r = new RecordingFile(path)) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   225
            List<RecordedEvent> list = new ArrayList<>();
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   226
            while (r.hasMoreEvents()) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   227
                list.add(r.readEvent());
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   228
            }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   229
            return list;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   230
        }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   231
    }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   232
58863
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 52850
diff changeset
   233
    // package protected
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 52850
diff changeset
   234
    File getFile() {
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 52850
diff changeset
   235
        return file;
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 52850
diff changeset
   236
    }
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 52850
diff changeset
   237
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 52850
diff changeset
   238
    // package protected
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 52850
diff changeset
   239
    boolean isLastEventInChunk() {
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 52850
diff changeset
   240
        return isLastEventInChunk;
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 52850
diff changeset
   241
    }
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 52850
diff changeset
   242
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 52850
diff changeset
   243
50113
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   244
    // either sets next to an event or sets eof to true
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   245
    private void findNext() throws IOException {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   246
        while (nextEvent == null) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   247
            if (chunkParser == null) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   248
                chunkParser = new ChunkParser(input);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   249
            } else if (!chunkParser.isLastChunk()) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   250
                chunkParser = chunkParser.nextChunkParser();
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   251
            } else {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   252
                eof = true;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   253
                return;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   254
            }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   255
            nextEvent = chunkParser.readEvent();
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   256
        }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   257
    }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   258
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   259
    private void ensureOpen() throws IOException {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   260
        if (input == null) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   261
            throw new IOException("Stream Closed");
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   262
        }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   263
    }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   264
}