annotate jvmci/jdk.vm.ci.hotspot/src/jdk/vm/ci/hotspot/events/EventProvider.java @ 22672:1bbd4a7c274b

Rename jdk.internal.jvmci to jdk.vm.ci
author Tom Rodriguez <tom.rodriguez@oracle.com>
date Thu, 08 Oct 2015 17:28:41 -0700
parents jvmci/jdk.internal.jvmci.hotspot/src/jdk/internal/jvmci/hotspot/events/EventProvider.java@0e095e2c24e2
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 */
22672
1bbd4a7c274b Rename jdk.internal.jvmci to jdk.vm.ci
Tom Rodriguez <tom.rodriguez@oracle.com>
parents: 22054
diff changeset
23 package jdk.vm.ci.hotspot.events;
21631
77acf6ba2fc0 Move EventProvider to jvmci.hotspot, make it a JVMCI Service
Gilles Duboscq <gilles.m.duboscq@oracle.com>
parents: 15663
diff changeset
24
15663
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
25 /**
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
26 * A provider that provides a specific implementation for events that can be logged in the compiler.
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
27 */
21937
3a292e8b9e51 replaced Service marker interface with non-standard META-INF directory names to differentiate JVMCI providers from standard service providers
Doug Simon <doug.simon@oracle.com>
parents: 21798
diff changeset
28 public interface EventProvider {
15663
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
29
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
30 /**
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
31 * 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
32 */
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
33 interface InstantEvent {
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
34 /**
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
35 * Commits the event.
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
36 */
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
37 void commit();
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
38
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
39 /**
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
40 * 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
41 * 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
42 * enabled and possible other factors.
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
43 *
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
44 * @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
45 */
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
46 boolean shouldWrite();
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
47 }
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
48
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
49 /**
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
50 * Timed events describe an operation that somehow consumes time.
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
51 */
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
52 interface TimedEvent extends InstantEvent {
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
53 /**
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
54 * Starts the timing for this event.
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 void begin();
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
57
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
58 /**
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
59 * Ends the timing period for this event.
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
60 */
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
61 void end();
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
62 }
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 * Creates a new {@link CompilationEvent}.
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
66 *
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
67 * @return a compilation event
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 CompilationEvent newCompilationEvent();
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 /**
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
72 * A compilation event.
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 interface CompilationEvent extends TimedEvent {
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
75 void setMethod(String method);
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
76
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
77 void setCompileId(int compileId);
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 void setCompileLevel(int compileLevel);
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 setSucceeded(boolean succeeded);
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 void setIsOsr(boolean isOsr);
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
84
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
85 void setCodeSize(int codeSize);
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
86
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
87 void setInlinedBytes(int inlinedBytes);
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 /**
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
91 * Creates a new {@link CompilerFailureEvent}.
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
92 *
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
93 * @return a compiler failure event
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
94 */
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
95 CompilerFailureEvent newCompilerFailureEvent();
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 /**
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
98 * A compiler failure event.
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
99 */
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
100 interface CompilerFailureEvent extends InstantEvent {
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
101 void setCompileId(int compileId);
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
102
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
103 void setMessage(String message);
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
104 }
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
105 }