Sat, 23 Nov 2013 12:25:13 +0100
8028128: Add a type safe alternative for working with counter based data
Reviewed-by: dholmes, egahlin
1 /*
2 * Copyright (c) 2012, 2013, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.
8 *
9 * This code is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
12 * version 2 for more details (a copy is included in the LICENSE file that
13 * accompanied this code).
14 *
15 * You should have received a copy of the GNU General Public License version
16 * 2 along with this work; if not, write to the Free Software Foundation,
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18 *
19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20 * or visit www.oracle.com if you need additional information or have any
21 * questions.
22 *
23 */
25 #ifndef SHARE_VM_GC_IMPLEMENTATION_SHARED_GCTIMER_HPP
26 #define SHARE_VM_GC_IMPLEMENTATION_SHARED_GCTIMER_HPP
28 #include "memory/allocation.hpp"
29 #include "prims/jni_md.h"
30 #include "utilities/macros.hpp"
31 #include "utilities/ticks.hpp"
33 class ConcurrentPhase;
34 class GCPhase;
35 class PausePhase;
37 template <class E> class GrowableArray;
39 class PhaseVisitor {
40 public:
41 virtual void visit(GCPhase* phase) = 0;
42 virtual void visit(PausePhase* phase) { visit((GCPhase*)phase); }
43 virtual void visit(ConcurrentPhase* phase) { visit((GCPhase*)phase); }
44 };
46 class GCPhase {
47 const char* _name;
48 int _level;
49 Ticks _start;
50 Ticks _end;
52 public:
53 void set_name(const char* name) { _name = name; }
54 const char* name() const { return _name; }
56 int level() const { return _level; }
57 void set_level(int level) { _level = level; }
59 const Ticks start() const { return _start; }
60 void set_start(const Ticks& time) { _start = time; }
62 const Ticks end() const { return _end; }
63 void set_end(const Ticks& time) { _end = time; }
65 virtual void accept(PhaseVisitor* visitor) = 0;
66 };
68 class PausePhase : public GCPhase {
69 public:
70 void accept(PhaseVisitor* visitor) {
71 visitor->visit(this);
72 }
73 };
75 class ConcurrentPhase : public GCPhase {
76 void accept(PhaseVisitor* visitor) {
77 visitor->visit(this);
78 }
79 };
81 class PhasesStack {
82 public:
83 // FIXME: Temporary set to 5 (used to be 4), since Reference processing needs it.
84 static const int PHASE_LEVELS = 5;
86 private:
87 int _phase_indices[PHASE_LEVELS];
88 int _next_phase_level;
90 public:
91 PhasesStack() { clear(); }
92 void clear();
94 void push(int phase_index);
95 int pop();
96 int count() const;
97 };
99 class TimePartitions {
100 static const int INITIAL_CAPACITY = 10;
102 // Currently we only support pause phases.
103 GrowableArray<PausePhase>* _phases;
104 PhasesStack _active_phases;
106 Tickspan _sum_of_pauses;
107 Tickspan _longest_pause;
109 public:
110 TimePartitions();
111 ~TimePartitions();
112 void clear();
114 void report_gc_phase_start(const char* name, const Ticks& time);
115 void report_gc_phase_end(const Ticks& time);
117 int num_phases() const;
118 GCPhase* phase_at(int index) const;
120 const Tickspan sum_of_pauses() const { return _sum_of_pauses; }
121 const Tickspan longest_pause() const { return _longest_pause; }
123 bool has_active_phases();
124 private:
125 void update_statistics(GCPhase* phase);
126 };
128 class PhasesIterator {
129 public:
130 virtual bool has_next() = 0;
131 virtual GCPhase* next() = 0;
132 };
134 class GCTimer : public ResourceObj {
135 NOT_PRODUCT(friend class GCTimerTest;)
136 protected:
137 Ticks _gc_start;
138 Ticks _gc_end;
139 TimePartitions _time_partitions;
141 public:
142 virtual void register_gc_start(const Ticks& time = Ticks::now());
143 virtual void register_gc_end(const Ticks& time = Ticks::now());
145 void register_gc_phase_start(const char* name, const Ticks& time);
146 void register_gc_phase_end(const Ticks& time);
148 const Ticks gc_start() const { return _gc_start; }
149 const Ticks gc_end() const { return _gc_end; }
151 TimePartitions* time_partitions() { return &_time_partitions; }
153 protected:
154 void register_gc_pause_start(const char* name, const Ticks& time = Ticks::now());
155 void register_gc_pause_end(const Ticks& time = Ticks::now());
156 };
158 class STWGCTimer : public GCTimer {
159 public:
160 virtual void register_gc_start(const Ticks& time = Ticks::now());
161 virtual void register_gc_end(const Ticks& time = Ticks::now());
162 };
164 class ConcurrentGCTimer : public GCTimer {
165 public:
166 void register_gc_pause_start(const char* name);
167 void register_gc_pause_end();
168 };
170 class TimePartitionPhasesIterator {
171 TimePartitions* _time_partitions;
172 int _next;
174 public:
175 TimePartitionPhasesIterator(TimePartitions* time_partitions) : _time_partitions(time_partitions), _next(0) { }
177 virtual bool has_next();
178 virtual GCPhase* next();
179 };
182 /////////////// Unit tests ///////////////
184 #ifndef PRODUCT
186 class GCTimerAllTest {
187 public:
188 static void all();
189 };
191 #endif
193 #endif // SHARE_VM_GC_IMPLEMENTATION_SHARED_GCTIMER_HPP