annotate src/share/vm/runtime/task.hpp @ 1972:f95d63e2154a

6989984: Use standard include model for Hospot Summary: Replaced MakeDeps and the includeDB files with more standardized solutions. Reviewed-by: coleenp, kvn, kamg
author stefank
date Tue, 23 Nov 2010 13:22:55 -0800
parents c18cbe5936b8
children d2a62e0f25eb
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
a61af66fc99e Initial load
duke
parents:
diff changeset
1 /*
1972
f95d63e2154a 6989984: Use standard include model for Hospot
stefank
parents: 1552
diff changeset
2 * Copyright (c) 1997, 2010, Oracle and/or its affiliates. All rights reserved.
0
a61af66fc99e Initial load
duke
parents:
diff changeset
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
a61af66fc99e Initial load
duke
parents:
diff changeset
4 *
a61af66fc99e Initial load
duke
parents:
diff changeset
5 * This code is free software; you can redistribute it and/or modify it
a61af66fc99e Initial load
duke
parents:
diff changeset
6 * under the terms of the GNU General Public License version 2 only, as
a61af66fc99e Initial load
duke
parents:
diff changeset
7 * published by the Free Software Foundation.
a61af66fc99e Initial load
duke
parents:
diff changeset
8 *
a61af66fc99e Initial load
duke
parents:
diff changeset
9 * This code is distributed in the hope that it will be useful, but WITHOUT
a61af66fc99e Initial load
duke
parents:
diff changeset
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
a61af66fc99e Initial load
duke
parents:
diff changeset
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
a61af66fc99e Initial load
duke
parents:
diff changeset
12 * version 2 for more details (a copy is included in the LICENSE file that
a61af66fc99e Initial load
duke
parents:
diff changeset
13 * accompanied this code).
a61af66fc99e Initial load
duke
parents:
diff changeset
14 *
a61af66fc99e Initial load
duke
parents:
diff changeset
15 * You should have received a copy of the GNU General Public License version
a61af66fc99e Initial load
duke
parents:
diff changeset
16 * 2 along with this work; if not, write to the Free Software Foundation,
a61af66fc99e Initial load
duke
parents:
diff changeset
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
a61af66fc99e Initial load
duke
parents:
diff changeset
18 *
1552
c18cbe5936b8 6941466: Oracle rebranding changes for Hotspot repositories
trims
parents: 196
diff changeset
19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
c18cbe5936b8 6941466: Oracle rebranding changes for Hotspot repositories
trims
parents: 196
diff changeset
20 * or visit www.oracle.com if you need additional information or have any
c18cbe5936b8 6941466: Oracle rebranding changes for Hotspot repositories
trims
parents: 196
diff changeset
21 * questions.
0
a61af66fc99e Initial load
duke
parents:
diff changeset
22 *
a61af66fc99e Initial load
duke
parents:
diff changeset
23 */
a61af66fc99e Initial load
duke
parents:
diff changeset
24
1972
f95d63e2154a 6989984: Use standard include model for Hospot
stefank
parents: 1552
diff changeset
25 #ifndef SHARE_VM_RUNTIME_TASK_HPP
f95d63e2154a 6989984: Use standard include model for Hospot
stefank
parents: 1552
diff changeset
26 #define SHARE_VM_RUNTIME_TASK_HPP
f95d63e2154a 6989984: Use standard include model for Hospot
stefank
parents: 1552
diff changeset
27
f95d63e2154a 6989984: Use standard include model for Hospot
stefank
parents: 1552
diff changeset
28 #include "utilities/top.hpp"
f95d63e2154a 6989984: Use standard include model for Hospot
stefank
parents: 1552
diff changeset
29
0
a61af66fc99e Initial load
duke
parents:
diff changeset
30 // A PeriodicTask has the sole purpose of executing its task
a61af66fc99e Initial load
duke
parents:
diff changeset
31 // function with regular intervals.
a61af66fc99e Initial load
duke
parents:
diff changeset
32 // Usage:
a61af66fc99e Initial load
duke
parents:
diff changeset
33 // PeriodicTask pf(10);
a61af66fc99e Initial load
duke
parents:
diff changeset
34 // pf.enroll();
a61af66fc99e Initial load
duke
parents:
diff changeset
35 // ...
a61af66fc99e Initial load
duke
parents:
diff changeset
36 // pf.disenroll();
a61af66fc99e Initial load
duke
parents:
diff changeset
37
a61af66fc99e Initial load
duke
parents:
diff changeset
38 class PeriodicTask: public CHeapObj {
a61af66fc99e Initial load
duke
parents:
diff changeset
39 public:
a61af66fc99e Initial load
duke
parents:
diff changeset
40 // Useful constants.
a61af66fc99e Initial load
duke
parents:
diff changeset
41 // The interval constants are used to ensure the declared interval
a61af66fc99e Initial load
duke
parents:
diff changeset
42 // is appropriate; it must be between min_interval and max_interval,
a61af66fc99e Initial load
duke
parents:
diff changeset
43 // and have a granularity of interval_gran (all in millis).
a61af66fc99e Initial load
duke
parents:
diff changeset
44 enum { max_tasks = 10, // Max number of periodic tasks in system
a61af66fc99e Initial load
duke
parents:
diff changeset
45 interval_gran = 10,
a61af66fc99e Initial load
duke
parents:
diff changeset
46 min_interval = 10,
a61af66fc99e Initial load
duke
parents:
diff changeset
47 max_interval = 10000 };
a61af66fc99e Initial load
duke
parents:
diff changeset
48
a61af66fc99e Initial load
duke
parents:
diff changeset
49 static int num_tasks() { return _num_tasks; }
a61af66fc99e Initial load
duke
parents:
diff changeset
50
a61af66fc99e Initial load
duke
parents:
diff changeset
51 private:
a61af66fc99e Initial load
duke
parents:
diff changeset
52 size_t _counter;
a61af66fc99e Initial load
duke
parents:
diff changeset
53 const size_t _interval;
a61af66fc99e Initial load
duke
parents:
diff changeset
54
a61af66fc99e Initial load
duke
parents:
diff changeset
55 static int _num_tasks;
a61af66fc99e Initial load
duke
parents:
diff changeset
56 static PeriodicTask* _tasks[PeriodicTask::max_tasks];
a61af66fc99e Initial load
duke
parents:
diff changeset
57 static void real_time_tick(size_t delay_time);
a61af66fc99e Initial load
duke
parents:
diff changeset
58
a61af66fc99e Initial load
duke
parents:
diff changeset
59 #ifndef PRODUCT
a61af66fc99e Initial load
duke
parents:
diff changeset
60 static elapsedTimer _timer; // measures time between ticks
a61af66fc99e Initial load
duke
parents:
diff changeset
61 static int _ticks; // total number of ticks
a61af66fc99e Initial load
duke
parents:
diff changeset
62 static int _intervalHistogram[max_interval]; // to check spacing of timer interrupts
a61af66fc99e Initial load
duke
parents:
diff changeset
63 public:
a61af66fc99e Initial load
duke
parents:
diff changeset
64 static void print_intervals();
a61af66fc99e Initial load
duke
parents:
diff changeset
65 #endif
a61af66fc99e Initial load
duke
parents:
diff changeset
66 // Only the WatcherThread can cause us to execute PeriodicTasks
a61af66fc99e Initial load
duke
parents:
diff changeset
67 friend class WatcherThread;
a61af66fc99e Initial load
duke
parents:
diff changeset
68 public:
a61af66fc99e Initial load
duke
parents:
diff changeset
69 PeriodicTask(size_t interval_time); // interval is in milliseconds of elapsed time
a61af66fc99e Initial load
duke
parents:
diff changeset
70 ~PeriodicTask();
a61af66fc99e Initial load
duke
parents:
diff changeset
71
a61af66fc99e Initial load
duke
parents:
diff changeset
72 // Tells whether is enrolled
a61af66fc99e Initial load
duke
parents:
diff changeset
73 bool is_enrolled() const;
a61af66fc99e Initial load
duke
parents:
diff changeset
74
a61af66fc99e Initial load
duke
parents:
diff changeset
75 // Make the task active
a61af66fc99e Initial load
duke
parents:
diff changeset
76 // NOTE: this may only be called before the WatcherThread has been started
a61af66fc99e Initial load
duke
parents:
diff changeset
77 void enroll();
a61af66fc99e Initial load
duke
parents:
diff changeset
78
a61af66fc99e Initial load
duke
parents:
diff changeset
79 // Make the task deactive
a61af66fc99e Initial load
duke
parents:
diff changeset
80 // NOTE: this may only be called either while the WatcherThread is
a61af66fc99e Initial load
duke
parents:
diff changeset
81 // inactive or by a task from within its task() method. One-shot or
a61af66fc99e Initial load
duke
parents:
diff changeset
82 // several-shot tasks may be implemented this way.
a61af66fc99e Initial load
duke
parents:
diff changeset
83 void disenroll();
a61af66fc99e Initial load
duke
parents:
diff changeset
84
a61af66fc99e Initial load
duke
parents:
diff changeset
85 void execute_if_pending(size_t delay_time) {
a61af66fc99e Initial load
duke
parents:
diff changeset
86 _counter += delay_time;
a61af66fc99e Initial load
duke
parents:
diff changeset
87 if (_counter >= _interval) {
a61af66fc99e Initial load
duke
parents:
diff changeset
88 _counter = 0;
a61af66fc99e Initial load
duke
parents:
diff changeset
89 task();
a61af66fc99e Initial load
duke
parents:
diff changeset
90 }
a61af66fc99e Initial load
duke
parents:
diff changeset
91 }
a61af66fc99e Initial load
duke
parents:
diff changeset
92
a61af66fc99e Initial load
duke
parents:
diff changeset
93 // Returns how long (time in milliseconds) before the next time we should
a61af66fc99e Initial load
duke
parents:
diff changeset
94 // execute this task.
a61af66fc99e Initial load
duke
parents:
diff changeset
95 size_t time_to_next_interval() const {
a61af66fc99e Initial load
duke
parents:
diff changeset
96 assert(_interval > _counter, "task counter greater than interval?");
a61af66fc99e Initial load
duke
parents:
diff changeset
97 return _interval - _counter;
a61af66fc99e Initial load
duke
parents:
diff changeset
98 }
a61af66fc99e Initial load
duke
parents:
diff changeset
99
a61af66fc99e Initial load
duke
parents:
diff changeset
100 // Calculate when the next periodic task will fire.
a61af66fc99e Initial load
duke
parents:
diff changeset
101 // Called by the WatcherThread's run method.
a61af66fc99e Initial load
duke
parents:
diff changeset
102 // This assumes that periodic tasks aren't entering the system
a61af66fc99e Initial load
duke
parents:
diff changeset
103 // dynamically, except for during startup.
a61af66fc99e Initial load
duke
parents:
diff changeset
104 static size_t time_to_wait() {
a61af66fc99e Initial load
duke
parents:
diff changeset
105 if (_num_tasks == 0) {
a61af66fc99e Initial load
duke
parents:
diff changeset
106 // Don't wait any more; shut down the thread since we don't
a61af66fc99e Initial load
duke
parents:
diff changeset
107 // currently support dynamic enrollment.
a61af66fc99e Initial load
duke
parents:
diff changeset
108 return 0;
a61af66fc99e Initial load
duke
parents:
diff changeset
109 }
a61af66fc99e Initial load
duke
parents:
diff changeset
110
a61af66fc99e Initial load
duke
parents:
diff changeset
111 size_t delay = _tasks[0]->time_to_next_interval();
a61af66fc99e Initial load
duke
parents:
diff changeset
112 for (int index = 1; index < _num_tasks; index++) {
a61af66fc99e Initial load
duke
parents:
diff changeset
113 delay = MIN2(delay, _tasks[index]->time_to_next_interval());
a61af66fc99e Initial load
duke
parents:
diff changeset
114 }
a61af66fc99e Initial load
duke
parents:
diff changeset
115 return delay;
a61af66fc99e Initial load
duke
parents:
diff changeset
116 }
a61af66fc99e Initial load
duke
parents:
diff changeset
117
a61af66fc99e Initial load
duke
parents:
diff changeset
118 // The task to perform at each period
a61af66fc99e Initial load
duke
parents:
diff changeset
119 virtual void task() = 0;
a61af66fc99e Initial load
duke
parents:
diff changeset
120 };
1972
f95d63e2154a 6989984: Use standard include model for Hospot
stefank
parents: 1552
diff changeset
121
f95d63e2154a 6989984: Use standard include model for Hospot
stefank
parents: 1552
diff changeset
122 #endif // SHARE_VM_RUNTIME_TASK_HPP