Thu, 05 Jun 2008 15:57:56 -0700
6711316: Open source the Garbage-First garbage collector
Summary: First mercurial integration of the code for the Garbage-First garbage collector.
Reviewed-by: apetrusenko, iveresov, jmasa, sgoldman, tonyp, ysr
1 /*
2 * Copyright 1997-2007 Sun Microsystems, Inc. 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
20 * CA 95054 USA or visit www.sun.com if you need additional information or
21 * have any questions.
22 *
23 */
25 # include "incls/_precompiled.incl"
26 # include "incls/_globals.cpp.incl"
29 RUNTIME_FLAGS(MATERIALIZE_DEVELOPER_FLAG, MATERIALIZE_PD_DEVELOPER_FLAG, \
30 MATERIALIZE_PRODUCT_FLAG, MATERIALIZE_PD_PRODUCT_FLAG, \
31 MATERIALIZE_DIAGNOSTIC_FLAG, MATERIALIZE_NOTPRODUCT_FLAG, \
32 MATERIALIZE_MANAGEABLE_FLAG, MATERIALIZE_PRODUCT_RW_FLAG, \
33 MATERIALIZE_LP64_PRODUCT_FLAG)
35 RUNTIME_OS_FLAGS(MATERIALIZE_DEVELOPER_FLAG, MATERIALIZE_PD_DEVELOPER_FLAG, \
36 MATERIALIZE_PRODUCT_FLAG, MATERIALIZE_PD_PRODUCT_FLAG, \
37 MATERIALIZE_DIAGNOSTIC_FLAG, MATERIALIZE_NOTPRODUCT_FLAG)
39 bool Flag::is_unlocker() const {
40 return strcmp(name, "UnlockDiagnosticVMOptions") == 0;
41 }
43 bool Flag::is_unlocked() const {
44 if (strcmp(kind, "{diagnostic}") == 0) {
45 return UnlockDiagnosticVMOptions;
46 } else {
47 return true;
48 }
49 }
51 bool Flag::is_writeable() const {
52 return (strcmp(kind, "{manageable}") == 0 || strcmp(kind, "{product rw}") == 0);
53 }
55 // All flags except "manageable" are assumed internal flags.
56 // Long term, we need to define a mechanism to specify which flags
57 // are external/stable and change this function accordingly.
58 bool Flag::is_external() const {
59 return (strcmp(kind, "{manageable}") == 0);
60 }
62 // Length of format string (e.g. "%.1234s") for printing ccstr below
63 #define FORMAT_BUFFER_LEN 16
65 void Flag::print_on(outputStream* st) {
66 st->print("%5s %-35s %c= ", type, name, (origin != DEFAULT ? ':' : ' '));
67 if (is_bool()) st->print("%-16s", get_bool() ? "true" : "false");
68 if (is_intx()) st->print("%-16ld", get_intx());
69 if (is_uintx()) st->print("%-16lu", get_uintx());
70 if (is_ccstr()) {
71 const char* cp = get_ccstr();
72 if (cp != NULL) {
73 const char* eol;
74 while ((eol = strchr(cp, '\n')) != NULL) {
75 char format_buffer[FORMAT_BUFFER_LEN];
76 size_t llen = pointer_delta(eol, cp, sizeof(char));
77 jio_snprintf(format_buffer, FORMAT_BUFFER_LEN,
78 "%%." SIZE_FORMAT "s", llen);
79 st->print(format_buffer, cp);
80 st->cr();
81 cp = eol+1;
82 st->print("%5s %-35s += ", "", name);
83 }
84 st->print("%-16s", cp);
85 }
86 }
87 st->print(" %s", kind);
88 st->cr();
89 }
91 void Flag::print_as_flag(outputStream* st) {
92 if (is_bool()) {
93 st->print("-XX:%s%s", get_bool() ? "+" : "-", name);
94 } else if (is_intx()) {
95 st->print("-XX:%s=" INTX_FORMAT, name, get_intx());
96 } else if (is_uintx()) {
97 st->print("-XX:%s=" UINTX_FORMAT, name, get_uintx());
98 } else if (is_ccstr()) {
99 st->print("-XX:%s=", name);
100 const char* cp = get_ccstr();
101 if (cp != NULL) {
102 // Need to turn embedded '\n's back into separate arguments
103 // Not so efficient to print one character at a time,
104 // but the choice is to do the transformation to a buffer
105 // and print that. And this need not be efficient.
106 for (; *cp != '\0'; cp += 1) {
107 switch (*cp) {
108 default:
109 st->print("%c", *cp);
110 break;
111 case '\n':
112 st->print(" -XX:%s=", name);
113 break;
114 }
115 }
116 }
117 } else {
118 ShouldNotReachHere();
119 }
120 }
122 // 4991491 do not "optimize out" the was_set false values: omitting them
123 // tickles a Microsoft compiler bug causing flagTable to be malformed
125 #define RUNTIME_PRODUCT_FLAG_STRUCT(type, name, value, doc) { #type, XSTR(name), &name, "{product}", DEFAULT },
126 #define RUNTIME_PD_PRODUCT_FLAG_STRUCT(type, name, doc) { #type, XSTR(name), &name, "{pd product}", DEFAULT },
127 #define RUNTIME_DIAGNOSTIC_FLAG_STRUCT(type, name, value, doc) { #type, XSTR(name), &name, "{diagnostic}", DEFAULT },
128 #define RUNTIME_MANAGEABLE_FLAG_STRUCT(type, name, value, doc) { #type, XSTR(name), &name, "{manageable}", DEFAULT },
129 #define RUNTIME_PRODUCT_RW_FLAG_STRUCT(type, name, value, doc) { #type, XSTR(name), &name, "{product rw}", DEFAULT },
131 #ifdef PRODUCT
132 #define RUNTIME_DEVELOP_FLAG_STRUCT(type, name, value, doc) /* flag is constant */
133 #define RUNTIME_PD_DEVELOP_FLAG_STRUCT(type, name, doc) /* flag is constant */
134 #define RUNTIME_NOTPRODUCT_FLAG_STRUCT(type, name, value, doc)
135 #else
136 #define RUNTIME_DEVELOP_FLAG_STRUCT(type, name, value, doc) { #type, XSTR(name), &name, "", DEFAULT },
137 #define RUNTIME_PD_DEVELOP_FLAG_STRUCT(type, name, doc) { #type, XSTR(name), &name, "{pd}", DEFAULT },
138 #define RUNTIME_NOTPRODUCT_FLAG_STRUCT(type, name, value, doc) { #type, XSTR(name), &name, "{notproduct}", DEFAULT },
139 #endif
141 #ifdef _LP64
142 #define RUNTIME_LP64_PRODUCT_FLAG_STRUCT(type, name, value, doc) { #type, XSTR(name), &name, "{lp64_product}", DEFAULT },
143 #else
144 #define RUNTIME_LP64_PRODUCT_FLAG_STRUCT(type, name, value, doc) /* flag is constant */
145 #endif // _LP64
147 #define C1_PRODUCT_FLAG_STRUCT(type, name, value, doc) { #type, XSTR(name), &name, "{C1 product}", DEFAULT },
148 #define C1_PD_PRODUCT_FLAG_STRUCT(type, name, doc) { #type, XSTR(name), &name, "{C1 pd product}", DEFAULT },
149 #ifdef PRODUCT
150 #define C1_DEVELOP_FLAG_STRUCT(type, name, value, doc) /* flag is constant */
151 #define C1_PD_DEVELOP_FLAG_STRUCT(type, name, doc) /* flag is constant */
152 #define C1_NOTPRODUCT_FLAG_STRUCT(type, name, value, doc)
153 #else
154 #define C1_DEVELOP_FLAG_STRUCT(type, name, value, doc) { #type, XSTR(name), &name, "{C1}", DEFAULT },
155 #define C1_PD_DEVELOP_FLAG_STRUCT(type, name, doc) { #type, XSTR(name), &name, "{C1 pd}", DEFAULT },
156 #define C1_NOTPRODUCT_FLAG_STRUCT(type, name, value, doc) { #type, XSTR(name), &name, "{C1 notproduct}", DEFAULT },
157 #endif
160 #define C2_PRODUCT_FLAG_STRUCT(type, name, value, doc) { #type, XSTR(name), &name, "{C2 product}", DEFAULT },
161 #define C2_PD_PRODUCT_FLAG_STRUCT(type, name, doc) { #type, XSTR(name), &name, "{C2 pd product}", DEFAULT },
162 #define C2_DIAGNOSTIC_FLAG_STRUCT(type, name, value, doc) { #type, XSTR(name), &name, "{C2 diagnostic}", DEFAULT },
163 #ifdef PRODUCT
164 #define C2_DEVELOP_FLAG_STRUCT(type, name, value, doc) /* flag is constant */
165 #define C2_PD_DEVELOP_FLAG_STRUCT(type, name, doc) /* flag is constant */
166 #define C2_NOTPRODUCT_FLAG_STRUCT(type, name, value, doc)
167 #else
168 #define C2_DEVELOP_FLAG_STRUCT(type, name, value, doc) { #type, XSTR(name), &name, "{C2}", DEFAULT },
169 #define C2_PD_DEVELOP_FLAG_STRUCT(type, name, doc) { #type, XSTR(name), &name, "{C2 pd}", DEFAULT },
170 #define C2_NOTPRODUCT_FLAG_STRUCT(type, name, value, doc) { #type, XSTR(name), &name, "{C2 notproduct}", DEFAULT },
171 #endif
174 static Flag flagTable[] = {
175 RUNTIME_FLAGS(RUNTIME_DEVELOP_FLAG_STRUCT, RUNTIME_PD_DEVELOP_FLAG_STRUCT, RUNTIME_PRODUCT_FLAG_STRUCT, RUNTIME_PD_PRODUCT_FLAG_STRUCT, RUNTIME_DIAGNOSTIC_FLAG_STRUCT, RUNTIME_NOTPRODUCT_FLAG_STRUCT, RUNTIME_MANAGEABLE_FLAG_STRUCT, RUNTIME_PRODUCT_RW_FLAG_STRUCT, RUNTIME_LP64_PRODUCT_FLAG_STRUCT)
176 RUNTIME_OS_FLAGS(RUNTIME_DEVELOP_FLAG_STRUCT, RUNTIME_PD_DEVELOP_FLAG_STRUCT, RUNTIME_PRODUCT_FLAG_STRUCT, RUNTIME_PD_PRODUCT_FLAG_STRUCT, RUNTIME_DIAGNOSTIC_FLAG_STRUCT, RUNTIME_NOTPRODUCT_FLAG_STRUCT)
177 #ifndef SERIALGC
178 G1_FLAGS(RUNTIME_DEVELOP_FLAG_STRUCT, RUNTIME_PD_DEVELOP_FLAG_STRUCT, RUNTIME_PRODUCT_FLAG_STRUCT, RUNTIME_PD_PRODUCT_FLAG_STRUCT, RUNTIME_DIAGNOSTIC_FLAG_STRUCT, RUNTIME_NOTPRODUCT_FLAG_STRUCT, RUNTIME_MANAGEABLE_FLAG_STRUCT, RUNTIME_PRODUCT_RW_FLAG_STRUCT)
179 #endif // SERIALGC
180 #ifdef COMPILER1
181 C1_FLAGS(C1_DEVELOP_FLAG_STRUCT, C1_PD_DEVELOP_FLAG_STRUCT, C1_PRODUCT_FLAG_STRUCT, C1_PD_PRODUCT_FLAG_STRUCT, C1_NOTPRODUCT_FLAG_STRUCT)
182 #endif
183 #ifdef COMPILER2
184 C2_FLAGS(C2_DEVELOP_FLAG_STRUCT, C2_PD_DEVELOP_FLAG_STRUCT, C2_PRODUCT_FLAG_STRUCT, C2_PD_PRODUCT_FLAG_STRUCT, C2_DIAGNOSTIC_FLAG_STRUCT, C2_NOTPRODUCT_FLAG_STRUCT)
185 #endif
186 {0, NULL, NULL}
187 };
189 Flag* Flag::flags = flagTable;
190 size_t Flag::numFlags = (sizeof(flagTable) / sizeof(Flag));
192 inline bool str_equal(const char* s, char* q, size_t len) {
193 // s is null terminated, q is not!
194 if (strlen(s) != (unsigned int) len) return false;
195 return strncmp(s, q, len) == 0;
196 }
198 Flag* Flag::find_flag(char* name, size_t length) {
199 for (Flag* current = &flagTable[0]; current->name; current++) {
200 if (str_equal(current->name, name, length)) {
201 if (!(current->is_unlocked() || current->is_unlocker())) {
202 // disable use of diagnostic flags until they are unlocked
203 return NULL;
204 }
205 return current;
206 }
207 }
208 return NULL;
209 }
211 // Returns the address of the index'th element
212 static Flag* address_of_flag(CommandLineFlagWithType flag) {
213 assert((size_t)flag < Flag::numFlags, "bad command line flag index");
214 return &Flag::flags[flag];
215 }
217 bool CommandLineFlagsEx::is_default(CommandLineFlag flag) {
218 assert((size_t)flag < Flag::numFlags, "bad command line flag index");
219 Flag* f = &Flag::flags[flag];
220 return (f->origin == DEFAULT);
221 }
223 bool CommandLineFlagsEx::is_ergo(CommandLineFlag flag) {
224 assert((size_t)flag < Flag::numFlags, "bad command line flag index");
225 Flag* f = &Flag::flags[flag];
226 return (f->origin == ERGONOMIC);
227 }
229 bool CommandLineFlagsEx::is_cmdline(CommandLineFlag flag) {
230 assert((size_t)flag < Flag::numFlags, "bad command line flag index");
231 Flag* f = &Flag::flags[flag];
232 return (f->origin == COMMAND_LINE);
233 }
235 bool CommandLineFlags::wasSetOnCmdline(const char* name, bool* value) {
236 Flag* result = Flag::find_flag((char*)name, strlen(name));
237 if (result == NULL) return false;
238 *value = (result->origin == COMMAND_LINE);
239 return true;
240 }
242 bool CommandLineFlags::boolAt(char* name, size_t len, bool* value) {
243 Flag* result = Flag::find_flag(name, len);
244 if (result == NULL) return false;
245 if (!result->is_bool()) return false;
246 *value = result->get_bool();
247 return true;
248 }
250 bool CommandLineFlags::boolAtPut(char* name, size_t len, bool* value, FlagValueOrigin origin) {
251 Flag* result = Flag::find_flag(name, len);
252 if (result == NULL) return false;
253 if (!result->is_bool()) return false;
254 bool old_value = result->get_bool();
255 result->set_bool(*value);
256 *value = old_value;
257 result->origin = origin;
258 return true;
259 }
261 void CommandLineFlagsEx::boolAtPut(CommandLineFlagWithType flag, bool value, FlagValueOrigin origin) {
262 Flag* faddr = address_of_flag(flag);
263 guarantee(faddr != NULL && faddr->is_bool(), "wrong flag type");
264 faddr->set_bool(value);
265 faddr->origin = origin;
266 }
268 bool CommandLineFlags::intxAt(char* name, size_t len, intx* value) {
269 Flag* result = Flag::find_flag(name, len);
270 if (result == NULL) return false;
271 if (!result->is_intx()) return false;
272 *value = result->get_intx();
273 return true;
274 }
276 bool CommandLineFlags::intxAtPut(char* name, size_t len, intx* value, FlagValueOrigin origin) {
277 Flag* result = Flag::find_flag(name, len);
278 if (result == NULL) return false;
279 if (!result->is_intx()) return false;
280 intx old_value = result->get_intx();
281 result->set_intx(*value);
282 *value = old_value;
283 result->origin = origin;
284 return true;
285 }
287 void CommandLineFlagsEx::intxAtPut(CommandLineFlagWithType flag, intx value, FlagValueOrigin origin) {
288 Flag* faddr = address_of_flag(flag);
289 guarantee(faddr != NULL && faddr->is_intx(), "wrong flag type");
290 faddr->set_intx(value);
291 faddr->origin = origin;
292 }
294 bool CommandLineFlags::uintxAt(char* name, size_t len, uintx* value) {
295 Flag* result = Flag::find_flag(name, len);
296 if (result == NULL) return false;
297 if (!result->is_uintx()) return false;
298 *value = result->get_uintx();
299 return true;
300 }
302 bool CommandLineFlags::uintxAtPut(char* name, size_t len, uintx* value, FlagValueOrigin origin) {
303 Flag* result = Flag::find_flag(name, len);
304 if (result == NULL) return false;
305 if (!result->is_uintx()) return false;
306 uintx old_value = result->get_uintx();
307 result->set_uintx(*value);
308 *value = old_value;
309 result->origin = origin;
310 return true;
311 }
313 void CommandLineFlagsEx::uintxAtPut(CommandLineFlagWithType flag, uintx value, FlagValueOrigin origin) {
314 Flag* faddr = address_of_flag(flag);
315 guarantee(faddr != NULL && faddr->is_uintx(), "wrong flag type");
316 faddr->set_uintx(value);
317 faddr->origin = origin;
318 }
320 bool CommandLineFlags::doubleAt(char* name, size_t len, double* value) {
321 Flag* result = Flag::find_flag(name, len);
322 if (result == NULL) return false;
323 if (!result->is_double()) return false;
324 *value = result->get_double();
325 return true;
326 }
328 bool CommandLineFlags::doubleAtPut(char* name, size_t len, double* value, FlagValueOrigin origin) {
329 Flag* result = Flag::find_flag(name, len);
330 if (result == NULL) return false;
331 if (!result->is_double()) return false;
332 double old_value = result->get_double();
333 result->set_double(*value);
334 *value = old_value;
335 result->origin = origin;
336 return true;
337 }
339 void CommandLineFlagsEx::doubleAtPut(CommandLineFlagWithType flag, double value, FlagValueOrigin origin) {
340 Flag* faddr = address_of_flag(flag);
341 guarantee(faddr != NULL && faddr->is_double(), "wrong flag type");
342 faddr->set_double(value);
343 faddr->origin = origin;
344 }
346 bool CommandLineFlags::ccstrAt(char* name, size_t len, ccstr* value) {
347 Flag* result = Flag::find_flag(name, len);
348 if (result == NULL) return false;
349 if (!result->is_ccstr()) return false;
350 *value = result->get_ccstr();
351 return true;
352 }
354 // Contract: Flag will make private copy of the incoming value.
355 // Outgoing value is always malloc-ed, and caller MUST call free.
356 bool CommandLineFlags::ccstrAtPut(char* name, size_t len, ccstr* value, FlagValueOrigin origin) {
357 Flag* result = Flag::find_flag(name, len);
358 if (result == NULL) return false;
359 if (!result->is_ccstr()) return false;
360 ccstr old_value = result->get_ccstr();
361 char* new_value = NEW_C_HEAP_ARRAY(char, strlen(*value)+1);
362 strcpy(new_value, *value);
363 result->set_ccstr(new_value);
364 if (result->origin == DEFAULT && old_value != NULL) {
365 // Prior value is NOT heap allocated, but was a literal constant.
366 char* old_value_to_free = NEW_C_HEAP_ARRAY(char, strlen(old_value)+1);
367 strcpy(old_value_to_free, old_value);
368 old_value = old_value_to_free;
369 }
370 *value = old_value;
371 result->origin = origin;
372 return true;
373 }
375 // Contract: Flag will make private copy of the incoming value.
376 void CommandLineFlagsEx::ccstrAtPut(CommandLineFlagWithType flag, ccstr value, FlagValueOrigin origin) {
377 Flag* faddr = address_of_flag(flag);
378 guarantee(faddr != NULL && faddr->is_ccstr(), "wrong flag type");
379 ccstr old_value = faddr->get_ccstr();
380 char* new_value = NEW_C_HEAP_ARRAY(char, strlen(value)+1);
381 strcpy(new_value, value);
382 faddr->set_ccstr(new_value);
383 if (faddr->origin != DEFAULT && old_value != NULL) {
384 // Prior value is heap allocated so free it.
385 FREE_C_HEAP_ARRAY(char, old_value);
386 }
387 faddr->origin = origin;
388 }
390 extern "C" {
391 static int compare_flags(const void* void_a, const void* void_b) {
392 return strcmp((*((Flag**) void_a))->name, (*((Flag**) void_b))->name);
393 }
394 }
396 void CommandLineFlags::printSetFlags() {
397 // Print which flags were set on the command line
398 // note: this method is called before the thread structure is in place
399 // which means resource allocation cannot be used.
401 // Compute size
402 int length= 0;
403 while (flagTable[length].name != NULL) length++;
405 // Sort
406 Flag** array = NEW_C_HEAP_ARRAY(Flag*, length);
407 for (int index = 0; index < length; index++) {
408 array[index] = &flagTable[index];
409 }
410 qsort(array, length, sizeof(Flag*), compare_flags);
412 // Print
413 for (int i = 0; i < length; i++) {
414 if (array[i]->origin /* naked field! */) {
415 array[i]->print_as_flag(tty);
416 tty->print(" ");
417 }
418 }
419 tty->cr();
420 FREE_C_HEAP_ARRAY(Flag*, array);
421 }
423 #ifndef PRODUCT
426 void CommandLineFlags::verify() {
427 assert(Arguments::check_vm_args_consistency(), "Some flag settings conflict");
428 }
430 void CommandLineFlags::printFlags() {
431 // Print the flags sorted by name
432 // note: this method is called before the thread structure is in place
433 // which means resource allocation cannot be used.
435 // Compute size
436 int length= 0;
437 while (flagTable[length].name != NULL) length++;
439 // Sort
440 Flag** array = NEW_C_HEAP_ARRAY(Flag*, length);
441 for (int index = 0; index < length; index++) {
442 array[index] = &flagTable[index];
443 }
444 qsort(array, length, sizeof(Flag*), compare_flags);
446 // Print
447 tty->print_cr("[Global flags]");
448 for (int i = 0; i < length; i++) {
449 if (array[i]->is_unlocked()) {
450 array[i]->print_on(tty);
451 }
452 }
453 FREE_C_HEAP_ARRAY(Flag*, array);
454 }
456 #endif