annotate jvmci/jdk.vm.ci.hotspot/src/jdk/vm/ci/hotspot/EventProvider.java @ 24225:a2dbb6fcc923

Added tag jvmci-0.33 for changeset 3aed4cb813f4
author Doug Simon <doug.simon@oracle.com>
date Fri, 18 Aug 2017 22:47:33 +0200
parents 5cf445d2acf6
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
15663
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
1 /*
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
2 * Copyright (c) 2014, Oracle and/or its affiliates. All rights reserved.
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
4 *
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
5 * This code is free software; you can redistribute it and/or modify it
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
6 * under the terms of the GNU General Public License version 2 only, as
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
7 * published by the Free Software Foundation.
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
8 *
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
9 * This code is distributed in the hope that it will be useful, but WITHOUT
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
12 * version 2 for more details (a copy is included in the LICENSE file that
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
13 * accompanied this code).
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
14 *
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
15 * You should have received a copy of the GNU General Public License version
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
16 * 2 along with this work; if not, write to the Free Software Foundation,
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
18 *
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
20 * or visit www.oracle.com if you need additional information or have any
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
21 * questions.
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
22 */
23785
5cf445d2acf6 Exported elements referring to inaccessible types in jdk.vm.ci (JDK-8167180)
Doug Simon <doug.simon@oracle.com>
parents: 23380
diff changeset
23 package jdk.vm.ci.hotspot;
23363
56479400913e jdk.vm.ci needs to securely export services (JDK-8155023)
Doug Simon <doug.simon@oracle.com>
parents: 22672
diff changeset
24
23785
5cf445d2acf6 Exported elements referring to inaccessible types in jdk.vm.ci (JDK-8167180)
Doug Simon <doug.simon@oracle.com>
parents: 23380
diff changeset
25 import jdk.vm.ci.hotspot.EmptyEventProvider.EmptyCompilationEvent;
5cf445d2acf6 Exported elements referring to inaccessible types in jdk.vm.ci (JDK-8167180)
Doug Simon <doug.simon@oracle.com>
parents: 23380
diff changeset
26 import jdk.vm.ci.hotspot.EmptyEventProvider.EmptyCompilerFailureEvent;
21631
77acf6ba2fc0 Move EventProvider to jvmci.hotspot, make it a JVMCI Service
Gilles Duboscq <gilles.m.duboscq@oracle.com>
parents: 15663
diff changeset
27
15663
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
28 /**
23785
5cf445d2acf6 Exported elements referring to inaccessible types in jdk.vm.ci (JDK-8167180)
Doug Simon <doug.simon@oracle.com>
parents: 23380
diff changeset
29 * Service for logging compiler related events.
15663
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
30 */
23785
5cf445d2acf6 Exported elements referring to inaccessible types in jdk.vm.ci (JDK-8167180)
Doug Simon <doug.simon@oracle.com>
parents: 23380
diff changeset
31 public interface EventProvider {
23363
56479400913e jdk.vm.ci needs to securely export services (JDK-8155023)
Doug Simon <doug.simon@oracle.com>
parents: 22672
diff changeset
32
56479400913e jdk.vm.ci needs to securely export services (JDK-8155023)
Doug Simon <doug.simon@oracle.com>
parents: 22672
diff changeset
33 /**
56479400913e jdk.vm.ci needs to securely export services (JDK-8155023)
Doug Simon <doug.simon@oracle.com>
parents: 22672
diff changeset
34 * Creates and returns an empty implementation for {@link EventProvider}. This implementation
56479400913e jdk.vm.ci needs to securely export services (JDK-8155023)
Doug Simon <doug.simon@oracle.com>
parents: 22672
diff changeset
35 * can be used when no logging is requested.
56479400913e jdk.vm.ci needs to securely export services (JDK-8155023)
Doug Simon <doug.simon@oracle.com>
parents: 22672
diff changeset
36 */
23785
5cf445d2acf6 Exported elements referring to inaccessible types in jdk.vm.ci (JDK-8167180)
Doug Simon <doug.simon@oracle.com>
parents: 23380
diff changeset
37 static EventProvider createEmptyEventProvider() {
23363
56479400913e jdk.vm.ci needs to securely export services (JDK-8155023)
Doug Simon <doug.simon@oracle.com>
parents: 22672
diff changeset
38 return new EmptyEventProvider();
56479400913e jdk.vm.ci needs to securely export services (JDK-8155023)
Doug Simon <doug.simon@oracle.com>
parents: 22672
diff changeset
39 }
56479400913e jdk.vm.ci needs to securely export services (JDK-8155023)
Doug Simon <doug.simon@oracle.com>
parents: 22672
diff changeset
40
56479400913e jdk.vm.ci needs to securely export services (JDK-8155023)
Doug Simon <doug.simon@oracle.com>
parents: 22672
diff changeset
41 /**
56479400913e jdk.vm.ci needs to securely export services (JDK-8155023)
Doug Simon <doug.simon@oracle.com>
parents: 22672
diff changeset
42 * Creates and returns an empty implementation for {@link CompilationEvent}.
56479400913e jdk.vm.ci needs to securely export services (JDK-8155023)
Doug Simon <doug.simon@oracle.com>
parents: 22672
diff changeset
43 */
23785
5cf445d2acf6 Exported elements referring to inaccessible types in jdk.vm.ci (JDK-8167180)
Doug Simon <doug.simon@oracle.com>
parents: 23380
diff changeset
44 static CompilationEvent createEmptyCompilationEvent() {
23363
56479400913e jdk.vm.ci needs to securely export services (JDK-8155023)
Doug Simon <doug.simon@oracle.com>
parents: 22672
diff changeset
45 return new EmptyCompilationEvent();
56479400913e jdk.vm.ci needs to securely export services (JDK-8155023)
Doug Simon <doug.simon@oracle.com>
parents: 22672
diff changeset
46 }
56479400913e jdk.vm.ci needs to securely export services (JDK-8155023)
Doug Simon <doug.simon@oracle.com>
parents: 22672
diff changeset
47
56479400913e jdk.vm.ci needs to securely export services (JDK-8155023)
Doug Simon <doug.simon@oracle.com>
parents: 22672
diff changeset
48 /**
56479400913e jdk.vm.ci needs to securely export services (JDK-8155023)
Doug Simon <doug.simon@oracle.com>
parents: 22672
diff changeset
49 * Creates and returns an empty implementation for {@link CompilationEvent}.
56479400913e jdk.vm.ci needs to securely export services (JDK-8155023)
Doug Simon <doug.simon@oracle.com>
parents: 22672
diff changeset
50 */
23785
5cf445d2acf6 Exported elements referring to inaccessible types in jdk.vm.ci (JDK-8167180)
Doug Simon <doug.simon@oracle.com>
parents: 23380
diff changeset
51 static CompilerFailureEvent createEmptyCompilerFailureEvent() {
23363
56479400913e jdk.vm.ci needs to securely export services (JDK-8155023)
Doug Simon <doug.simon@oracle.com>
parents: 22672
diff changeset
52 return new EmptyCompilerFailureEvent();
56479400913e jdk.vm.ci needs to securely export services (JDK-8155023)
Doug Simon <doug.simon@oracle.com>
parents: 22672
diff changeset
53 }
15663
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
54
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
55 /**
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
56 * An instant event is an event that is not considered to have taken any time.
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
57 */
23363
56479400913e jdk.vm.ci needs to securely export services (JDK-8155023)
Doug Simon <doug.simon@oracle.com>
parents: 22672
diff changeset
58 public interface InstantEvent {
15663
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
59 /**
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
60 * Commits the event.
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
61 */
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
62 void commit();
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
63
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
64 /**
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
65 * Determines if this particular event instance would be committed to the data stream right
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
66 * now if application called {@link #commit()}. This in turn depends on whether the event is
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
67 * enabled and possible other factors.
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
68 *
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
69 * @return if this event would be committed on a call to {@link #commit()}.
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
70 */
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
71 boolean shouldWrite();
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
72 }
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
73
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
74 /**
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
75 * Timed events describe an operation that somehow consumes time.
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
76 */
23363
56479400913e jdk.vm.ci needs to securely export services (JDK-8155023)
Doug Simon <doug.simon@oracle.com>
parents: 22672
diff changeset
77 public interface TimedEvent extends InstantEvent {
15663
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
78 /**
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
79 * Starts the timing for this event.
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
80 */
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
81 void begin();
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
82
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
83 /**
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
84 * Ends the timing period for this event.
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
85 */
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
86 void end();
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
87 }
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
88
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
89 /**
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
90 * Creates a new {@link CompilationEvent}.
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
91 *
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
92 * @return a compilation event
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
93 */
23785
5cf445d2acf6 Exported elements referring to inaccessible types in jdk.vm.ci (JDK-8167180)
Doug Simon <doug.simon@oracle.com>
parents: 23380
diff changeset
94 CompilationEvent newCompilationEvent();
15663
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
95
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
96 /**
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
97 * A compilation event.
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
98 */
23363
56479400913e jdk.vm.ci needs to securely export services (JDK-8155023)
Doug Simon <doug.simon@oracle.com>
parents: 22672
diff changeset
99 public interface CompilationEvent extends TimedEvent {
15663
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
100 void setMethod(String method);
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
101
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
102 void setCompileId(int compileId);
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
103
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
104 void setCompileLevel(int compileLevel);
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
105
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
106 void setSucceeded(boolean succeeded);
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
107
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
108 void setIsOsr(boolean isOsr);
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
109
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
110 void setCodeSize(int codeSize);
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
111
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
112 void setInlinedBytes(int inlinedBytes);
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
113 }
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
114
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
115 /**
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
116 * Creates a new {@link CompilerFailureEvent}.
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
117 *
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
118 * @return a compiler failure event
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
119 */
23785
5cf445d2acf6 Exported elements referring to inaccessible types in jdk.vm.ci (JDK-8167180)
Doug Simon <doug.simon@oracle.com>
parents: 23380
diff changeset
120 CompilerFailureEvent newCompilerFailureEvent();
15663
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
121
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
122 /**
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
123 * A compiler failure event.
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
124 */
23363
56479400913e jdk.vm.ci needs to securely export services (JDK-8155023)
Doug Simon <doug.simon@oracle.com>
parents: 22672
diff changeset
125 public interface CompilerFailureEvent extends InstantEvent {
15663
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
126 void setCompileId(int compileId);
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
127
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
128 void setMessage(String message);
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
129 }
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
130 }