annotate jvmci/com.oracle.jvmci.hotspot/src/com/oracle/jvmci/hotspot/events/EventProvider.java @ 21798:395ac43a8578

moved JVMCI sources from graal/ to jvmci/ directory
author Doug Simon <doug.simon@oracle.com>
date Tue, 09 Jun 2015 00:22:49 +0200
parents graal/com.oracle.jvmci.hotspot/src/com/oracle/jvmci/hotspot/events/EventProvider.java@77acf6ba2fc0
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 */
21631
77acf6ba2fc0 Move EventProvider to jvmci.hotspot, make it a JVMCI Service
Gilles Duboscq <gilles.m.duboscq@oracle.com>
parents: 15663
diff changeset
23 package com.oracle.jvmci.hotspot.events;
77acf6ba2fc0 Move EventProvider to jvmci.hotspot, make it a JVMCI Service
Gilles Duboscq <gilles.m.duboscq@oracle.com>
parents: 15663
diff changeset
24
77acf6ba2fc0 Move EventProvider to jvmci.hotspot, make it a JVMCI Service
Gilles Duboscq <gilles.m.duboscq@oracle.com>
parents: 15663
diff changeset
25 import com.oracle.jvmci.service.*;
15663
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
26
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
27 /**
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
28 * 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
29 */
21631
77acf6ba2fc0 Move EventProvider to jvmci.hotspot, make it a JVMCI Service
Gilles Duboscq <gilles.m.duboscq@oracle.com>
parents: 15663
diff changeset
30 public interface EventProvider extends Service {
15663
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
31
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 * 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
34 */
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
35 interface InstantEvent {
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 * Commits the event.
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 void commit();
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
40
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
41 /**
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
42 * 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
43 * 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
44 * enabled and possible other factors.
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 * @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
47 */
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
48 boolean shouldWrite();
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
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 * Timed events describe an operation that somehow consumes time.
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 interface TimedEvent extends InstantEvent {
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 * Starts the timing for this event.
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 void begin();
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 /**
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
61 * Ends the timing period for this event.
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 void end();
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
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 * Creates a new {@link CompilationEvent}.
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 a compilation event
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 CompilationEvent newCompilationEvent();
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 * A compilation event.
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
75 */
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
76 interface CompilationEvent extends TimedEvent {
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
77 void setMethod(String method);
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 setCompileId(int compileId);
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 setCompileLevel(int compileLevel);
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 setSucceeded(boolean succeeded);
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 setIsOsr(boolean isOsr);
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 setCodeSize(int codeSize);
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 void setInlinedBytes(int inlinedBytes);
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
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 * Creates a new {@link CompilerFailureEvent}.
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 * @return a compiler failure event
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 CompilerFailureEvent newCompilerFailureEvent();
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
98
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 * A compiler failure event.
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 interface CompilerFailureEvent extends InstantEvent {
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
103 void setCompileId(int compileId);
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 void setMessage(String message);
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
106 }
7340fe377764 added Java Flight Recorder (JFR) event support
twisti
parents:
diff changeset
107 }