src/jdk.jfr/share/classes/jdk/jfr/consumer/RecordedEvent.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.time.Duration;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    29
import java.time.Instant;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    30
import java.util.List;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    31
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    32
import jdk.jfr.EventType;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    33
import jdk.jfr.ValueDescriptor;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    34
import jdk.jfr.internal.EventInstrumentation;
58863
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 52850
diff changeset
    35
import jdk.jfr.internal.consumer.ObjectContext;
50113
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    36
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    37
/**
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    38
 * A recorded event.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    39
 *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    40
 * @since 9
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    41
 */
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    42
public final class RecordedEvent extends RecordedObject {
58863
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 52850
diff changeset
    43
    long startTimeTicks;
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 52850
diff changeset
    44
    long endTimeTicks;
50113
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    45
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    46
    // package private
58863
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 52850
diff changeset
    47
    RecordedEvent(ObjectContext objectContext, Object[] values, long startTimeTicks, long endTimeTicks) {
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 52850
diff changeset
    48
        super(objectContext, values);
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 52850
diff changeset
    49
        this.startTimeTicks = startTimeTicks;
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 52850
diff changeset
    50
        this.endTimeTicks = endTimeTicks;
50113
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    51
    }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    52
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    53
    /**
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    54
     * Returns the stack trace that was created when the event was committed, or
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    55
     * {@code null} if the event lacks a stack trace.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    56
     *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    57
     * @return stack trace, or {@code null} if doesn't exist for the event
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    58
     */
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    59
    public RecordedStackTrace getStackTrace() {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    60
        return getTyped(EventInstrumentation.FIELD_STACK_TRACE, RecordedStackTrace.class, null);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    61
    }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    62
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    63
    /**
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    64
     * Returns the thread from which the event was committed, or {@code null} if
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    65
     * the thread was not recorded.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    66
     *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    67
     * @return thread, or {@code null} if doesn't exist for the event
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    68
     */
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    69
    public RecordedThread getThread() {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    70
        return getTyped(EventInstrumentation.FIELD_EVENT_THREAD, RecordedThread.class, null);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    71
    }
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
     * Returns the event type that describes the event.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    75
     *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    76
     * @return the event type, not {@code null}
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    77
     */
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    78
    public EventType getEventType() {
58863
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 52850
diff changeset
    79
        return objectContext.eventType;
50113
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    80
    }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    81
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    82
    /**
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    83
     * Returns the start time of the event.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    84
     * <p>
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    85
     * If the event is an instant event, then the start time and end time are the same.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    86
     *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    87
     * @return the start time, not {@code null}
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    88
     */
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    89
    public Instant getStartTime() {
58863
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 52850
diff changeset
    90
        return Instant.ofEpochSecond(0, getStartTimeNanos());
50113
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    91
    }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    92
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    93
    /**
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    94
     * Returns the end time of the event.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    95
     * <p>
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    96
     * If the event is an instant event, then the start time and end time are the same.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    97
     *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    98
     * @return the end time, not {@code null}
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    99
     */
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   100
    public Instant getEndTime() {
58863
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 52850
diff changeset
   101
        return Instant.ofEpochSecond(0, getEndTimeNanos());
50113
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   102
    }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   103
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   104
    /**
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   105
     * Returns the duration of the event, measured in nanoseconds.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   106
     *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   107
     * @return the duration in nanoseconds, not {@code null}
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   108
     */
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   109
    public Duration getDuration() {
58863
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 52850
diff changeset
   110
        return Duration.ofNanos(getEndTimeNanos() - getStartTimeNanos());
50113
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   111
    }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   112
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   113
    /**
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   114
     * Returns the list of descriptors that describes the fields of the event.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   115
     *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   116
     * @return descriptors, not {@code null}
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   117
     */
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   118
    @Override
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   119
    public List<ValueDescriptor> getFields() {
58863
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 52850
diff changeset
   120
        return objectContext.fields;
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 52850
diff changeset
   121
    }
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 52850
diff changeset
   122
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 52850
diff changeset
   123
    protected final Object objectAt(int index) {
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 52850
diff changeset
   124
        if (index == 0) {
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 52850
diff changeset
   125
            return startTimeTicks;
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 52850
diff changeset
   126
        }
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 52850
diff changeset
   127
        if (hasDuration()) {
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 52850
diff changeset
   128
            if (index == 1) {
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 52850
diff changeset
   129
                return endTimeTicks - startTimeTicks;
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 52850
diff changeset
   130
            }
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 52850
diff changeset
   131
            return objects[index - 2];
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 52850
diff changeset
   132
        }
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 52850
diff changeset
   133
        return objects[index - 1];
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 52850
diff changeset
   134
    }
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 52850
diff changeset
   135
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 52850
diff changeset
   136
    private boolean hasDuration() {
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 52850
diff changeset
   137
        return objects.length + 2 == objectContext.fields.size();
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 52850
diff changeset
   138
    }
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 52850
diff changeset
   139
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 52850
diff changeset
   140
    private long getStartTimeNanos() {
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 52850
diff changeset
   141
        return objectContext.convertTimestamp(startTimeTicks);
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 52850
diff changeset
   142
    }
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 52850
diff changeset
   143
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 52850
diff changeset
   144
    private long getEndTimeNanos() {
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 52850
diff changeset
   145
        return objectContext.convertTimestamp(endTimeTicks);
50113
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   146
    }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   147
}