-
-
Notifications
You must be signed in to change notification settings - Fork 938
Expand file tree
/
Copy pathRubyGC.java
More file actions
207 lines (178 loc) · 8.28 KB
/
RubyGC.java
File metadata and controls
207 lines (178 loc) · 8.28 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
/***** BEGIN LICENSE BLOCK *****
* Version: EPL 2.0/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Eclipse Public
* License Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.eclipse.org/legal/epl-v20.html
*
* Software distributed under the License is distributed on an "AS
* IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
* implied. See the License for the specific language governing
* rights and limitations under the License.
*
* Copyright (C) 2002 Anders Bengtsson <ndrsbngtssn@yahoo.se>
* Copyright (C) 2002-2004 Jan Arne Petersen <jpetersen@uni-bonn.de>
* Copyright (C) 2004 Thomas E Enebo <enebo@acm.org>
* Copyright (C) 2004 Stefan Matthias Aust <sma@3plus4.de>
*
* Alternatively, the contents of this file may be used under the terms of
* either of the GNU General Public License Version 2 or later (the "GPL"),
* or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the EPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the EPL, the GPL or the LGPL.
***** END LICENSE BLOCK *****/
package org.jruby;
import java.lang.management.GarbageCollectorMXBean;
import java.lang.management.ManagementFactory;
import org.jruby.anno.JRubyMethod;
import org.jruby.anno.JRubyModule;
import org.jruby.common.IRubyWarnings.ID;
import org.jruby.runtime.Arity;
import org.jruby.runtime.ThreadContext;
import static org.jruby.api.Convert.asBoolean;
import static org.jruby.api.Convert.asFixnum;
import static org.jruby.api.Define.defineModule;
import org.jruby.runtime.builtin.IRubyObject;
/**
* GC (Garbage Collection) Module
*
* Note: Since we rely on Java's memory model we can't provide the
* kind of control over garbage collection that MRI provides. Also note
* that since all Ruby libraries make GC assumptions based on MRI's GC
* that we decided to no-op explicit collection through these APIs.
* You can use Java Integration in your libraries to force a Java
* GC (assuming you really want to).
*
*/
@JRubyModule(name="GC")
public class RubyGC {
private static volatile boolean gcDisabled = false;
private static volatile boolean stress = false;
private static volatile boolean autoCompact = false;
private static volatile boolean measureTotalTime = false;
public static RubyModule createGCModule(ThreadContext context) {
return defineModule(context, "GC").defineMethods(context, RubyGC.class);
}
@JRubyMethod(meta = true)
public static IRubyObject config(ThreadContext context, IRubyObject recv) {
return RubyHash.newHash(
context.runtime,
RubySymbol.newSymbol(context.runtime, "implementation"),
RubyString.newString(context.runtime, "java")
);
}
@JRubyMethod(meta = true)
public static IRubyObject config(ThreadContext context, IRubyObject recv, IRubyObject arg) {
if (arg.isNil()) {
return config(context, recv);
} else if (arg instanceof RubyHash) {
if (((RubyHash) arg).hasKey(RubySymbol.newSymbol(context.runtime, "implementation"))) {
throw context.runtime.newArgumentError("Attempting to set read-only key \"Implementation\"");
}
return config(context, recv);
} else {
throw context.runtime.newArgumentError("ArgumentError");
}
}
@JRubyMethod(meta = true, optional = 1, checkArity = false)
public static IRubyObject start(ThreadContext context, IRubyObject recv, IRubyObject[] args) {
Arity.checkArgumentCount(context, args, 0, 1);
return context.nil;
}
@JRubyMethod(optional = 1, checkArity = false)
public static IRubyObject garbage_collect(ThreadContext context, IRubyObject recv, IRubyObject[] args) {
Arity.checkArgumentCount(context, args, 0, 1);
return context.nil;
}
@JRubyMethod(meta = true)
public static IRubyObject measure_total_time(ThreadContext context, IRubyObject self) {
// JVM just keeps track of this so we do not have a toggle here. If we need to show incremental time
// from a particular point we will need to record time and do some extra math.
return asBoolean(context, measureTotalTime);
}
@JRubyMethod(meta = true, name = "measure_total_time=")
public static IRubyObject measure_total_time_set(ThreadContext context, IRubyObject self, IRubyObject value) {
// JVM just keeps track of this so we do not have a toggle here. If we need to show incremental time
// from a particular point we will need to record time and do some extra math.
measureTotalTime = value.isTrue();
return context.nil;
}
@JRubyMethod(meta = true)
public static IRubyObject total_time(ThreadContext context, IRubyObject self) {
return asFixnum(context, getCollectionTime());
}
@JRubyMethod(meta = true)
public static IRubyObject enable(ThreadContext context, IRubyObject recv) {
Ruby runtime = context.runtime;
emptyImplementationWarning(runtime, ID.GC_ENABLE_UNIMPLEMENTED, "GC.enable");
boolean old = gcDisabled;
gcDisabled = false;
return asBoolean(context, old);
}
@JRubyMethod(meta = true)
public static IRubyObject disable(ThreadContext context, IRubyObject recv) {
Ruby runtime = context.runtime;
emptyImplementationWarning(runtime, ID.GC_DISABLE_UNIMPLEMENTED, "GC.disable");
boolean old = gcDisabled;
gcDisabled = true;
return asBoolean(context, old);
}
@JRubyMethod(meta = true)
public static IRubyObject stress(ThreadContext context, IRubyObject recv) {
return asBoolean(context, stress);
}
@JRubyMethod(name = "stress=", meta = true)
public static IRubyObject stress_set(ThreadContext context, IRubyObject recv, IRubyObject arg) {
emptyImplementationWarning(context.runtime, ID.GC_STRESS_UNIMPLEMENTED, "GC.stress=");
stress = arg.isTrue();
return asBoolean(context, stress);
}
@JRubyMethod(meta = true)
public static IRubyObject count(ThreadContext context, IRubyObject recv) {
try {
return asFixnum(context, getCollectionCount());
} catch (Throwable t) {
return RubyFixnum.minus_one(context.runtime);
}
}
@JRubyMethod(meta = true)
public static IRubyObject auto_compact(ThreadContext context, IRubyObject recv) {
emptyImplementationWarning(context.runtime, ID.GC_ENABLE_UNIMPLEMENTED, "GC.auto_compact");
return asBoolean(context, autoCompact);
}
@JRubyMethod(name = "auto_compact=", meta = true)
public static IRubyObject auto_compact_set(ThreadContext context, IRubyObject recv, IRubyObject autoCompact) {
emptyImplementationWarning(context.runtime, ID.GC_ENABLE_UNIMPLEMENTED, "GC.auto_compact=");
RubyGC.autoCompact = autoCompact.isTrue();
return autoCompact;
}
@JRubyMethod(meta = true)
public static IRubyObject compact(ThreadContext context, IRubyObject recv) {
emptyImplementationWarning(context.runtime, ID.GC_ENABLE_UNIMPLEMENTED, "GC.compact");
return context.nil;
}
private static void emptyImplementationWarning(Ruby runtime, ID id, String name) {
runtime.getWarnings().warnOnce(id, name + " does nothing on JRuby");
}
public static int getCollectionCount() {
int count = 0;
for (GarbageCollectorMXBean bean : ManagementFactory.getGarbageCollectorMXBeans()) {
count += bean.getCollectionCount();
}
return count;
}
public static long getCollectionTime() {
long time = 0;
for (GarbageCollectorMXBean bean : ManagementFactory.getGarbageCollectorMXBeans()) {
time += bean.getCollectionTime();
}
return time;
}
}