1 /*
2 * Copyright 1997-2008 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 */
24
25 # include "incls/_precompiled.incl"
26 # include "incls/_vmSymbols.cpp.incl"
27
28
29 symbolOop vmSymbols::_symbols[vmSymbols::SID_LIMIT];
30
31 symbolOop vmSymbols::_type_signatures[T_VOID+1] = { NULL /*, NULL...*/ };
32
33 inline int compare_symbol(symbolOop a, symbolOop b) {
34 if (a == b) return 0;
35 // follow the natural address order:
36 return (address)a > (address)b ? +1 : -1;
37 }
38
39 static vmSymbols::SID vm_symbol_index[vmSymbols::SID_LIMIT];
40 extern "C" {
41 static int compare_vmsymbol_sid(const void* void_a, const void* void_b) {
42 symbolOop a = vmSymbols::symbol_at(*((vmSymbols::SID*) void_a));
43 symbolOop b = vmSymbols::symbol_at(*((vmSymbols::SID*) void_b));
44 return compare_symbol(a, b);
45 }
46 }
47
48 #ifndef PRODUCT
49 #define VM_SYMBOL_ENUM_NAME_BODY(name, string) #name "\0"
50 static const char* vm_symbol_enum_names =
51 VM_SYMBOLS_DO(VM_SYMBOL_ENUM_NAME_BODY, VM_ALIAS_IGNORE)
52 "\0";
53 static const char* vm_symbol_enum_name(vmSymbols::SID sid) {
54 const char* string = &vm_symbol_enum_names[0];
55 int skip = (int)sid - (int)vmSymbols::FIRST_SID;
56 for (; skip != 0; skip--) {
57 size_t skiplen = strlen(string);
58 if (skiplen == 0) return "<unknown>"; // overflow
59 string += skiplen+1;
60 }
61 return string;
62 }
63 #endif //PRODUCT
64
65 // Put all the VM symbol strings in one place.
66 // Makes for a more compact libjvm.
67 #define VM_SYMBOL_BODY(name, string) string "\0"
68 static const char* vm_symbol_bodies = VM_SYMBOLS_DO(VM_SYMBOL_BODY, VM_ALIAS_IGNORE);
69
70 void vmSymbols::initialize(TRAPS) {
71 assert((int)SID_LIMIT <= (1<<log2_SID_LIMIT), "must fit in this bitfield");
72 assert((int)SID_LIMIT*5 > (1<<log2_SID_LIMIT), "make the bitfield smaller, please");
73 assert(vmIntrinsics::FLAG_LIMIT <= (1 << vmIntrinsics::log2_FLAG_LIMIT), "must fit in this bitfield");
74
75 if (!UseSharedSpaces) {
76 const char* string = &vm_symbol_bodies[0];
77 for (int index = (int)FIRST_SID; index < (int)SID_LIMIT; index++) {
78 symbolOop sym = oopFactory::new_symbol(string, CHECK);
79 _symbols[index] = sym;
80 string += strlen(string); // skip string body
81 string += 1; // skip trailing null
82 }
83
84 _type_signatures[T_BYTE] = byte_signature();
85 _type_signatures[T_CHAR] = char_signature();
86 _type_signatures[T_DOUBLE] = double_signature();
87 _type_signatures[T_FLOAT] = float_signature();
88 _type_signatures[T_INT] = int_signature();
89 _type_signatures[T_LONG] = long_signature();
90 _type_signatures[T_SHORT] = short_signature();
91 _type_signatures[T_BOOLEAN] = bool_signature();
92 _type_signatures[T_VOID] = void_signature();
93 // no single signatures for T_OBJECT or T_ARRAY
94 }
95
96 #ifdef ASSERT
97 // Check for duplicates:
98 for (int i1 = (int)FIRST_SID; i1 < (int)SID_LIMIT; i1++) {
99 symbolOop sym = symbol_at((SID)i1);
100 for (int i2 = (int)FIRST_SID; i2 < i1; i2++) {
101 if (symbol_at((SID)i2) == sym) {
102 tty->print("*** Duplicate VM symbol SIDs %s(%d) and %s(%d): \"",
103 vm_symbol_enum_name((SID)i2), i2,
104 vm_symbol_enum_name((SID)i1), i1);
105 sym->print_symbol_on(tty);
106 tty->print_cr("\"");
107 }
108 }
109 }
110 #endif //ASSERT
111
112 // Create an index for find_id:
113 {
114 for (int index = (int)FIRST_SID; index < (int)SID_LIMIT; index++) {
115 vm_symbol_index[index] = (SID)index;
116 }
117 int num_sids = SID_LIMIT-FIRST_SID;
118 qsort(&vm_symbol_index[FIRST_SID], num_sids, sizeof(vm_symbol_index[0]),
119 compare_vmsymbol_sid);
120 }
121
122 #ifdef ASSERT
123 {
124 // Spot-check correspondence between strings, symbols, and enums:
125 assert(_symbols[NO_SID] == NULL, "must be");
126 const char* str = "java/lang/Object";
127 symbolOop sym = oopFactory::new_symbol(str, CHECK);
128 assert(strcmp(str, (char*)sym->base()) == 0, "");
129 assert(sym == java_lang_Object(), "");
130 SID sid = VM_SYMBOL_ENUM_NAME(java_lang_Object);
131 assert(find_sid(sym) == sid, "");
132 assert(symbol_at(sid) == sym, "");
133
134 // Make sure find_sid produces the right answer in each case.
135 for (int index = (int)FIRST_SID; index < (int)SID_LIMIT; index++) {
136 sym = symbol_at((SID)index);
137 sid = find_sid(sym);
138 assert(sid == (SID)index, "symbol index works");
139 // Note: If there are duplicates, this assert will fail.
140 // A "Duplicate VM symbol" message will have already been printed.
141 }
142
143 // The string "format" happens (at the moment) not to be a vmSymbol,
144 // though it is a method name in java.lang.String.
145 str = "format";
146 sym = oopFactory::new_symbol(str, CHECK);
147 sid = find_sid(sym);
148 assert(sid == NO_SID, "symbol index works (negative test)");
149 }
150 #endif
151 }
152
153
154 #ifndef PRODUCT
155 const char* vmSymbols::name_for(vmSymbols::SID sid) {
156 if (sid == NO_SID)
157 return "NO_SID";
158 const char* string = &vm_symbol_bodies[0];
159 for (int index = (int)FIRST_SID; index < (int)SID_LIMIT; index++) {
160 if (index == (int)sid)
161 return string;
162 string += strlen(string); // skip string body
163 string += 1; // skip trailing null
164 }
165 return "BAD_SID";
166 }
167 #endif
168
169
170
171 void vmSymbols::oops_do(OopClosure* f, bool do_all) {
172 for (int index = (int)FIRST_SID; index < (int)SID_LIMIT; index++) {
173 f->do_oop((oop*) &_symbols[index]);
174 }
175 for (int i = 0; i < T_VOID+1; i++) {
176 if (_type_signatures[i] != NULL) {
177 assert(i >= T_BOOLEAN, "checking");
178 f->do_oop((oop*)&_type_signatures[i]);
179 } else if (do_all) {
180 f->do_oop((oop*)&_type_signatures[i]);
181 }
182 }
183 }
184
185
186 BasicType vmSymbols::signature_type(symbolOop s) {
187 assert(s != NULL, "checking");
188 for (int i = T_BOOLEAN; i < T_VOID+1; i++) {
189 if (s == _type_signatures[i]) {
190 return (BasicType)i;
191 }
192 }
193 return T_OBJECT;
194 }
195
196
197 static int mid_hint = (int)vmSymbols::FIRST_SID+1;
198
199 #ifndef PRODUCT
200 static int find_sid_calls, find_sid_probes;
201 // (Typical counts are calls=7000 and probes=17000.)
202 #endif
203
204 vmSymbols::SID vmSymbols::find_sid(symbolOop symbol) {
205 // Handle the majority of misses by a bounds check.
206 // Then, use a binary search over the index.
207 // Expected trip count is less than log2_SID_LIMIT, about eight.
208 // This is slow but acceptable, given that calls are not
209 // dynamically common. (methodOop::intrinsic_id has a cache.)
210 NOT_PRODUCT(find_sid_calls++);
211 int min = (int)FIRST_SID, max = (int)SID_LIMIT - 1;
212 SID sid = NO_SID, sid1;
213 int cmp1;
214 sid1 = vm_symbol_index[min];
215 cmp1 = compare_symbol(symbol, symbol_at(sid1));
216 if (cmp1 <= 0) { // before the first
217 if (cmp1 == 0) sid = sid1;
218 } else {
219 sid1 = vm_symbol_index[max];
220 cmp1 = compare_symbol(symbol, symbol_at(sid1));
221 if (cmp1 >= 0) { // after the last
222 if (cmp1 == 0) sid = sid1;
223 } else {
224 // After checking the extremes, do a binary search.
225 ++min; --max; // endpoints are done
226 int mid = mid_hint; // start at previous success
227 while (max >= min) {
228 assert(mid >= min && mid <= max, "");
229 NOT_PRODUCT(find_sid_probes++);
230 sid1 = vm_symbol_index[mid];
231 cmp1 = compare_symbol(symbol, symbol_at(sid1));
232 if (cmp1 == 0) {
233 mid_hint = mid;
234 sid = sid1;
235 break;
236 }
237 if (cmp1 < 0)
238 max = mid - 1; // symbol < symbol_at(sid)
239 else
240 min = mid + 1;
241
242 // Pick a new probe point:
243 mid = (max + min) / 2;
244 }
245 }
246 }
247
248 #ifdef ASSERT
249 // Perform the exhaustive self-check the first 1000 calls,
250 // and every 100 calls thereafter.
251 static int find_sid_check_count = -2000;
252 if ((uint)++find_sid_check_count > (uint)100) {
253 if (find_sid_check_count > 0) find_sid_check_count = 0;
254
255 // Make sure this is the right answer, using linear search.
256 // (We have already proven that there are no duplicates in the list.)
257 SID sid2 = NO_SID;
258 for (int index = (int)FIRST_SID; index < (int)SID_LIMIT; index++) {
259 symbolOop sym2 = symbol_at((SID)index);
260 if (sym2 == symbol) {
261 sid2 = (SID)index;
262 break;
263 }
264 }
265 // Unless it's a duplicate, assert that the sids are the same.
266 if (_symbols[sid] != _symbols[sid2]) {
267 assert(sid == sid2, "binary same as linear search");
268 }
269 }
270 #endif //ASSERT
271
272 return sid;
273 }
274
275 static vmIntrinsics::ID wrapper_intrinsic(BasicType type, bool unboxing) {
276 #define TYPE2(type, unboxing) ((int)(type)*2 + ((unboxing) ? 1 : 0))
277 switch (TYPE2(type, unboxing)) {
278 #define BASIC_TYPE_CASE(type, box, unbox) \
279 case TYPE2(type, false): return vmIntrinsics::box; \
280 case TYPE2(type, true): return vmIntrinsics::unbox
281 BASIC_TYPE_CASE(T_BOOLEAN, _Boolean_valueOf, _booleanValue);
282 BASIC_TYPE_CASE(T_BYTE, _Byte_valueOf, _byteValue);
283 BASIC_TYPE_CASE(T_CHAR, _Character_valueOf, _charValue);
284 BASIC_TYPE_CASE(T_SHORT, _Short_valueOf, _shortValue);
285 BASIC_TYPE_CASE(T_INT, _Integer_valueOf, _intValue);
286 BASIC_TYPE_CASE(T_LONG, _Long_valueOf, _longValue);
287 BASIC_TYPE_CASE(T_FLOAT, _Float_valueOf, _floatValue);
288 BASIC_TYPE_CASE(T_DOUBLE, _Double_valueOf, _doubleValue);
289 #undef BASIC_TYPE_CASE
290 }
291 #undef TYPE2
292 return vmIntrinsics::_none;
293 }
294
295 vmIntrinsics::ID vmIntrinsics::for_boxing(BasicType type) {
296 return wrapper_intrinsic(type, false);
297 }
298 vmIntrinsics::ID vmIntrinsics::for_unboxing(BasicType type) {
299 return wrapper_intrinsic(type, true);
300 }
301
302 methodOop vmIntrinsics::method_for(vmIntrinsics::ID id) {
303 if (id == _none) return NULL;
304 symbolOop cname = vmSymbols::symbol_at(class_for(id));
305 symbolOop mname = vmSymbols::symbol_at(name_for(id));
306 symbolOop msig = vmSymbols::symbol_at(signature_for(id));
307 if (cname == NULL || mname == NULL || msig == NULL) return NULL;
308 klassOop k = SystemDictionary::find_well_known_klass(cname);
309 if (k == NULL) return NULL;
310 return instanceKlass::cast(k)->find_method(mname, msig);
311 }
312
313
314 #define VM_INTRINSIC_INITIALIZE(id, klass, name, sig, flags) #id "\0"
315 static const char* vm_intrinsic_name_bodies =
316 VM_INTRINSICS_DO(VM_INTRINSIC_INITIALIZE,
317 VM_SYMBOL_IGNORE, VM_SYMBOL_IGNORE, VM_SYMBOL_IGNORE, VM_ALIAS_IGNORE);
318
319 static const char* vm_intrinsic_name_table[vmIntrinsics::ID_LIMIT];
320
321 const char* vmIntrinsics::name_at(vmIntrinsics::ID id) {
322 const char** nt = &vm_intrinsic_name_table[0];
323 if (nt[_none] == NULL) {
324 char* string = (char*) &vm_intrinsic_name_bodies[0];
325 for (int index = FIRST_ID; index < ID_LIMIT; index++) {
326 nt[index] = string;
327 string += strlen(string); // skip string body
328 string += 1; // skip trailing null
329 }
330 assert(!strcmp(nt[_hashCode], "_hashCode"), "lined up");
331 nt[_none] = "_none";
332 }
333 if ((uint)id < (uint)ID_LIMIT)
334 return vm_intrinsic_name_table[(uint)id];
335 else
336 return "(unknown intrinsic)";
337 }
338
339 // These are flag-matching functions:
340 inline bool match_F_R(jshort flags) {
341 const int req = 0;
342 const int neg = JVM_ACC_STATIC | JVM_ACC_SYNCHRONIZED;
343 return (flags & (req | neg)) == req;
344 }
345 inline bool match_F_RN(jshort flags) {
346 const int req = JVM_ACC_NATIVE;
347 const int neg = JVM_ACC_STATIC | JVM_ACC_SYNCHRONIZED;
348 return (flags & (req | neg)) == req;
349 }
350 inline bool match_F_S(jshort flags) {
351 const int req = JVM_ACC_STATIC;
352 const int neg = JVM_ACC_SYNCHRONIZED;
353 return (flags & (req | neg)) == req;
354 }
355 inline bool match_F_SN(jshort flags) {
356 const int req = JVM_ACC_STATIC | JVM_ACC_NATIVE;
357 const int neg = JVM_ACC_SYNCHRONIZED;
358 return (flags & (req | neg)) == req;
359 }
360 inline bool match_F_RNY(jshort flags) {
361 const int req = JVM_ACC_NATIVE | JVM_ACC_SYNCHRONIZED;
362 const int neg = JVM_ACC_STATIC;
363 return (flags & (req | neg)) == req;
364 }
365
366 // These are for forming case labels:
367 #define ID3(x, y, z) (( jint)(z) + \
368 ((jint)(y) << vmSymbols::log2_SID_LIMIT) + \
369 ((jint)(x) << (2*vmSymbols::log2_SID_LIMIT)) )
370 #define SID_ENUM(n) vmSymbols::VM_SYMBOL_ENUM_NAME(n)
371
372 vmIntrinsics::ID vmIntrinsics::find_id(vmSymbols::SID holder,
373 vmSymbols::SID name,
374 vmSymbols::SID sig,
375 jshort flags) {
376 assert((int)vmSymbols::SID_LIMIT <= (1<<vmSymbols::log2_SID_LIMIT), "must fit");
377
378 // Let the C compiler build the decision tree.
379
380 #define VM_INTRINSIC_CASE(id, klass, name, sig, fcode) \
381 case ID3(SID_ENUM(klass), SID_ENUM(name), SID_ENUM(sig)): \
382 if (!match_##fcode(flags)) break; \
383 return id;
384
385 switch (ID3(holder, name, sig)) {
386 VM_INTRINSICS_DO(VM_INTRINSIC_CASE,
387 VM_SYMBOL_IGNORE, VM_SYMBOL_IGNORE, VM_SYMBOL_IGNORE, VM_ALIAS_IGNORE);
388 }
389 return vmIntrinsics::_none;
390
391 #undef VM_INTRINSIC_CASE
392 }
393
394
395 const char* vmIntrinsics::short_name_as_C_string(vmIntrinsics::ID id, char* buf, int buflen) {
396 const char* str = name_at(id);
397 #ifndef PRODUCT
398 const char* kname = vmSymbols::name_for(class_for(id));
399 const char* mname = vmSymbols::name_for(name_for(id));
400 const char* sname = vmSymbols::name_for(signature_for(id));
401 const char* fname = "";
402 switch (flags_for(id)) {
403 case F_RN: fname = "native "; break;
404 case F_SN: fname = "native static "; break;
405 case F_S: fname = "static "; break;
406 case F_RNY:fname = "native synchronized "; break;
407 }
408 const char* kptr = strrchr(kname, '/');
409 if (kptr != NULL) kname = kptr + 1;
410 int len = jio_snprintf(buf, buflen, "%s: %s%s.%s%s",
411 str, fname, kname, mname, sname);
412 if (len < buflen)
413 str = buf;
414 #endif //PRODUCT
415 return str;
416 }
417
418
419 // These are to get information about intrinsics.
420
421 #define ID4(x, y, z, f) ((ID3(x, y, z) << vmIntrinsics::log2_FLAG_LIMIT) | (int)(f))
422
423 static const jint intrinsic_info_array[vmIntrinsics::ID_LIMIT+1] = {
424 #define VM_INTRINSIC_INFO(ignore_id, klass, name, sig, fcode) \
425 ID4(SID_ENUM(klass), SID_ENUM(name), SID_ENUM(sig), vmIntrinsics::fcode),
426
427 0, VM_INTRINSICS_DO(VM_INTRINSIC_INFO,
428 VM_SYMBOL_IGNORE, VM_SYMBOL_IGNORE, VM_SYMBOL_IGNORE, VM_ALIAS_IGNORE)
429 0
430 #undef VM_INTRINSIC_INFO
431 };
432
433 inline jint intrinsic_info(vmIntrinsics::ID id) {
434 return intrinsic_info_array[vmIntrinsics::ID_from((int)id)];
435 }
436
437 vmSymbols::SID vmIntrinsics::class_for(vmIntrinsics::ID id) {
438 jint info = intrinsic_info(id);
439 int shift = 2*vmSymbols::log2_SID_LIMIT + log2_FLAG_LIMIT, mask = right_n_bits(vmSymbols::log2_SID_LIMIT);
440 assert(((ID4(31,1022,1023,15) >> shift) & mask) == 31, "");
441 return vmSymbols::SID( (info >> shift) & mask );
442 }
443
444 vmSymbols::SID vmIntrinsics::name_for(vmIntrinsics::ID id) {
445 jint info = intrinsic_info(id);
446 int shift = vmSymbols::log2_SID_LIMIT + log2_FLAG_LIMIT, mask = right_n_bits(vmSymbols::log2_SID_LIMIT);
447 assert(((ID4(31,1022,1023,15) >> shift) & mask) == 1022, "");
448 return vmSymbols::SID( (info >> shift) & mask );
449 }
450
451 vmSymbols::SID vmIntrinsics::signature_for(vmIntrinsics::ID id) {
452 jint info = intrinsic_info(id);
453 int shift = log2_FLAG_LIMIT, mask = right_n_bits(vmSymbols::log2_SID_LIMIT);
454 assert(((ID4(31,1022,1023,15) >> shift) & mask) == 1023, "");
455 return vmSymbols::SID( (info >> shift) & mask );
456 }
457
458 vmIntrinsics::Flags vmIntrinsics::flags_for(vmIntrinsics::ID id) {
459 jint info = intrinsic_info(id);
460 int shift = 0, mask = right_n_bits(log2_FLAG_LIMIT);
461 assert(((ID4(31,1022,1023,15) >> shift) & mask) == 15, "");
462 return Flags( (info >> shift) & mask );
463 }
464
465
466 #ifndef PRODUCT
467 // verify_method performs an extra check on a matched intrinsic method
468
469 static bool match_method(methodOop m, symbolOop n, symbolOop s) {
470 return (m->name() == n &&
471 m->signature() == s);
472 }
473
474 static vmIntrinsics::ID match_method_with_klass(methodOop m, symbolOop mk) {
475 #define VM_INTRINSIC_MATCH(id, klassname, namepart, sigpart, flags) \
476 { symbolOop k = vmSymbols::klassname(); \
477 if (mk == k) { \
478 symbolOop n = vmSymbols::namepart(); \
479 symbolOop s = vmSymbols::sigpart(); \
480 if (match_method(m, n, s)) \
481 return vmIntrinsics::id; \
482 } }
483 VM_INTRINSICS_DO(VM_INTRINSIC_MATCH,
484 VM_SYMBOL_IGNORE, VM_SYMBOL_IGNORE, VM_SYMBOL_IGNORE, VM_ALIAS_IGNORE);
485 return vmIntrinsics::_none;
486 #undef VM_INTRINSIC_MATCH
487 }
488
489 void vmIntrinsics::verify_method(ID actual_id, methodOop m) {
490 symbolOop mk = Klass::cast(m->method_holder())->name();
491 ID declared_id = match_method_with_klass(m, mk);
492
493 if (declared_id == actual_id) return; // success
494
495 if (declared_id == _none && actual_id != _none && mk == vmSymbols::java_lang_StrictMath()) {
496 // Here are a few special cases in StrictMath not declared in vmSymbols.hpp.
497 switch (actual_id) {
498 case _min:
499 case _max:
500 case _dsqrt:
501 declared_id = match_method_with_klass(m, vmSymbols::java_lang_Math());
502 if (declared_id == actual_id) return; // acceptable alias
503 break;
504 }
505 }
506
507 const char* declared_name = name_at(declared_id);
508 const char* actual_name = name_at(actual_id);
509 methodHandle mh = m;
510 m = NULL;
511 ttyLocker ttyl;
512 if (xtty != NULL) {
513 xtty->begin_elem("intrinsic_misdeclared actual='%s' declared='%s'",
514 actual_name, declared_name);
515 xtty->method(mh);
516 xtty->end_elem("");
517 }
518 if (PrintMiscellaneous && (WizardMode || Verbose)) {
519 tty->print_cr("*** misidentified method; %s(%d) should be %s(%d):",
520 declared_name, declared_id, actual_name, actual_id);
521 mh()->print_short_name(tty);
522 tty->cr();
523 }
524 }
525 #endif //PRODUCT