1 /*
2 * Copyright (c) 1997, 2016, 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 */
24
25 #include "precompiled.hpp"
26 #include "classfile/symbolTable.hpp"
27 #include "classfile/systemDictionary.hpp"
28 #include "memory/oopFactory.hpp"
29 #include "memory/resourceArea.hpp"
30 #include "oops/instanceKlass.hpp"
31 #include "oops/oop.inline.hpp"
32 #include "oops/symbol.hpp"
33 #include "oops/typeArrayKlass.hpp"
34 #include "runtime/signature.hpp"
35
36 // Implementation of SignatureIterator
37
38 // Signature syntax:
39 //
40 // Signature = "(" {Parameter} ")" ReturnType.
41 // Parameter = FieldType.
42 // ReturnType = FieldType | "V".
43 // FieldType = "B" | "C" | "D" | "F" | "I" | "J" | "S" | "Z" | "L" ClassName ";" | "[" FieldType.
44 // ClassName = string.
45
46
47 SignatureIterator::SignatureIterator(Symbol* signature) {
48 _signature = signature;
49 _parameter_index = 0;
50 }
51
52 void SignatureIterator::expect(char c) {
53 if (_signature->byte_at(_index) != c) fatal("expecting %c", c);
54 _index++;
55 }
56
57
58 void SignatureIterator::skip_optional_size() {
59 Symbol* sig = _signature;
60 char c = sig->byte_at(_index);
61 while ('0' <= c && c <= '9') c = sig->byte_at(++_index);
62 }
63
64
65 int SignatureIterator::parse_type() {
66 // Note: This function could be simplified by using "return T_XXX_size;"
67 // instead of the assignment and the break statements. However, it
68 // seems that the product build for win32_i486 with MS VC++ 6.0 doesn't
69 // work (stack underflow for some tests) - this seems to be a VC++ 6.0
70 // compiler bug (was problem - gri 4/27/2000).
71 int size = -1;
72 switch(_signature->byte_at(_index)) {
73 case 'B': do_byte (); if (_parameter_index < 0 ) _return_type = T_BYTE;
74 _index++; size = T_BYTE_size ; break;
75 case 'C': do_char (); if (_parameter_index < 0 ) _return_type = T_CHAR;
76 _index++; size = T_CHAR_size ; break;
77 case 'D': do_double(); if (_parameter_index < 0 ) _return_type = T_DOUBLE;
78 _index++; size = T_DOUBLE_size ; break;
79 case 'F': do_float (); if (_parameter_index < 0 ) _return_type = T_FLOAT;
80 _index++; size = T_FLOAT_size ; break;
81 case 'I': do_int (); if (_parameter_index < 0 ) _return_type = T_INT;
82 _index++; size = T_INT_size ; break;
83 case 'J': do_long (); if (_parameter_index < 0 ) _return_type = T_LONG;
84 _index++; size = T_LONG_size ; break;
85 case 'S': do_short (); if (_parameter_index < 0 ) _return_type = T_SHORT;
86 _index++; size = T_SHORT_size ; break;
87 case 'Z': do_bool (); if (_parameter_index < 0 ) _return_type = T_BOOLEAN;
88 _index++; size = T_BOOLEAN_size; break;
89 case 'V': do_void (); if (_parameter_index < 0 ) _return_type = T_VOID;
90 _index++; size = T_VOID_size; ; break;
91 case 'L':
92 { int begin = ++_index;
93 Symbol* sig = _signature;
94 while (sig->byte_at(_index++) != ';') ;
95 do_object(begin, _index);
96 }
97 if (_parameter_index < 0 ) _return_type = T_OBJECT;
98 size = T_OBJECT_size;
99 break;
100 case '[':
101 { int begin = ++_index;
102 skip_optional_size();
103 Symbol* sig = _signature;
104 while (sig->byte_at(_index) == '[') {
105 _index++;
106 skip_optional_size();
107 }
108 if (sig->byte_at(_index) == 'L') {
109 while (sig->byte_at(_index++) != ';') ;
110 } else {
111 _index++;
112 }
113 do_array(begin, _index);
114 if (_parameter_index < 0 ) _return_type = T_ARRAY;
115 }
116 size = T_ARRAY_size;
117 break;
118 default:
119 ShouldNotReachHere();
120 break;
121 }
122 assert(size >= 0, "size must be set");
123 return size;
124 }
125
126
127 void SignatureIterator::check_signature_end() {
128 if (_index < _signature->utf8_length()) {
129 tty->print_cr("too many chars in signature");
130 _signature->print_value_on(tty);
131 tty->print_cr(" @ %d", _index);
132 }
133 }
134
135
136 void SignatureIterator::dispatch_field() {
137 // no '(', just one (field) type
138 _index = 0;
139 _parameter_index = 0;
140 parse_type();
141 check_signature_end();
142 }
143
144
145 void SignatureIterator::iterate_parameters() {
146 // Parse parameters
147 _index = 0;
148 _parameter_index = 0;
149 expect('(');
150 while (_signature->byte_at(_index) != ')') _parameter_index += parse_type();
151 expect(')');
152 _parameter_index = 0;
153 }
154
155 // Optimized version of iterate_parameters when fingerprint is known
156 void SignatureIterator::iterate_parameters( uint64_t fingerprint ) {
157 uint64_t saved_fingerprint = fingerprint;
158
159 // Check for too many arguments
160 if (fingerprint == (uint64_t)CONST64(-1)) {
161 SignatureIterator::iterate_parameters();
162 return;
163 }
164
165 assert(fingerprint, "Fingerprint should not be 0");
166
167 _parameter_index = 0;
168 fingerprint = fingerprint >> (static_feature_size + result_feature_size);
169 while ( 1 ) {
170 switch ( fingerprint & parameter_feature_mask ) {
171 case bool_parm:
172 do_bool();
173 _parameter_index += T_BOOLEAN_size;
174 break;
175 case byte_parm:
176 do_byte();
177 _parameter_index += T_BYTE_size;
178 break;
179 case char_parm:
180 do_char();
181 _parameter_index += T_CHAR_size;
182 break;
183 case short_parm:
184 do_short();
185 _parameter_index += T_SHORT_size;
186 break;
187 case int_parm:
188 do_int();
189 _parameter_index += T_INT_size;
190 break;
191 case obj_parm:
192 do_object(0, 0);
193 _parameter_index += T_OBJECT_size;
194 break;
195 case long_parm:
196 do_long();
197 _parameter_index += T_LONG_size;
198 break;
199 case float_parm:
200 do_float();
201 _parameter_index += T_FLOAT_size;
202 break;
203 case double_parm:
204 do_double();
205 _parameter_index += T_DOUBLE_size;
206 break;
207 case done_parm:
208 return;
209 break;
210 default:
211 tty->print_cr("*** parameter is " UINT64_FORMAT, fingerprint & parameter_feature_mask);
212 tty->print_cr("*** fingerprint is " PTR64_FORMAT, saved_fingerprint);
213 ShouldNotReachHere();
214 break;
215 }
216 fingerprint >>= parameter_feature_size;
217 }
218 _parameter_index = 0;
219 }
220
221
222 void SignatureIterator::iterate_returntype() {
223 // Ignore parameters
224 _index = 0;
225 expect('(');
226 Symbol* sig = _signature;
227 // Need to skip over each type in the signature's argument list until a
228 // closing ')' is found., then get the return type. We cannot just scan
229 // for the first ')' because ')' is a legal character in a type name.
230 while (sig->byte_at(_index) != ')') {
231 switch(sig->byte_at(_index)) {
232 case 'B':
233 case 'C':
234 case 'D':
235 case 'F':
236 case 'I':
237 case 'J':
238 case 'S':
239 case 'Z':
240 case 'V':
241 {
242 _index++;
243 }
244 break;
245 case 'L':
246 {
247 while (sig->byte_at(_index++) != ';') ;
248 }
249 break;
250 case '[':
251 {
252 int begin = ++_index;
253 skip_optional_size();
254 while (sig->byte_at(_index) == '[') {
255 _index++;
256 skip_optional_size();
257 }
258 if (sig->byte_at(_index) == 'L') {
259 while (sig->byte_at(_index++) != ';') ;
260 } else {
261 _index++;
262 }
263 }
264 break;
265 default:
266 ShouldNotReachHere();
267 break;
268 }
269 }
270 expect(')');
271 // Parse return type
272 _parameter_index = -1;
273 parse_type();
274 check_signature_end();
275 _parameter_index = 0;
276 }
277
278
279 void SignatureIterator::iterate() {
280 // Parse parameters
281 _parameter_index = 0;
282 _index = 0;
283 expect('(');
284 while (_signature->byte_at(_index) != ')') _parameter_index += parse_type();
285 expect(')');
286 // Parse return type
287 _parameter_index = -1;
288 parse_type();
289 check_signature_end();
290 _parameter_index = 0;
291 }
292
293
294 // Implementation of SignatureStream
295 SignatureStream::SignatureStream(Symbol* signature, bool is_method) :
296 _signature(signature), _at_return_type(false) {
297 _begin = _end = (is_method ? 1 : 0); // skip first '(' in method signatures
298 _names = new GrowableArray<Symbol*>(10);
299 next();
300 }
301
302 SignatureStream::~SignatureStream() {
303 // decrement refcount for names created during signature parsing
304 for (int i = 0; i < _names->length(); i++) {
305 _names->at(i)->decrement_refcount();
306 }
307 }
308
309 bool SignatureStream::is_done() const {
310 return _end > _signature->utf8_length();
311 }
312
313
314 void SignatureStream::next_non_primitive(int t) {
315 switch (t) {
316 case 'L': {
317 _type = T_OBJECT;
318 Symbol* sig = _signature;
319 while (sig->byte_at(_end++) != ';');
320 break;
321 }
322 case '[': {
323 _type = T_ARRAY;
324 Symbol* sig = _signature;
325 char c = sig->byte_at(_end);
326 while ('0' <= c && c <= '9') c = sig->byte_at(_end++);
327 while (sig->byte_at(_end) == '[') {
328 _end++;
329 c = sig->byte_at(_end);
330 while ('0' <= c && c <= '9') c = sig->byte_at(_end++);
331 }
332 switch(sig->byte_at(_end)) {
333 case 'B':
334 case 'C':
335 case 'D':
336 case 'F':
337 case 'I':
338 case 'J':
339 case 'S':
340 case 'Z':_end++; break;
341 default: {
342 while (sig->byte_at(_end++) != ';');
343 break;
344 }
345 }
346 break;
347 }
348 case ')': _end++; next(); _at_return_type = true; break;
349 default : ShouldNotReachHere();
350 }
351 }
352
353
354 bool SignatureStream::is_object() const {
355 return _type == T_OBJECT
356 || _type == T_ARRAY
357 || _type == T_VALUETYPE;
358 }
359
360 bool SignatureStream::is_array() const {
361 return _type == T_ARRAY;
362 }
363
364 Symbol* SignatureStream::as_symbol(TRAPS) {
365 // Create a symbol from for string _begin _end
366 int begin = _begin;
367 int end = _end;
368
369 if (_type == T_OBJECT || _type == T_VALUETYPE) {
370 begin++;
371 end--;
372 if (begin == end) {
373 return vmSymbols::java_lang_Object();
374 }
375 }
376
377 // Save names for cleaning up reference count at the end of
378 // SignatureStream scope.
379 Symbol* name = SymbolTable::new_symbol(_signature, begin, end, CHECK_NULL);
380 _names->push(name); // save new symbol for decrementing later
381 return name;
382 }
383
384 Klass* SignatureStream::as_klass(Handle class_loader, Handle protection_domain,
385 FailureMode failure_mode, TRAPS) {
386 if (!is_object()) return NULL;
387 Symbol* name = as_symbol(CHECK_NULL);
388 if (failure_mode == ReturnNull) {
389 return SystemDictionary::resolve_or_null(name, class_loader, protection_domain, THREAD);
390 } else {
391 bool throw_error = (failure_mode == NCDFError);
392 return SystemDictionary::resolve_or_fail(name, class_loader, protection_domain, throw_error, THREAD);
393 }
394 }
395
396 oop SignatureStream::as_java_mirror(Handle class_loader, Handle protection_domain,
397 FailureMode failure_mode, TRAPS) {
398 if (!is_object())
399 return Universe::java_mirror(type());
400 Klass* klass = as_klass(class_loader, protection_domain, failure_mode, CHECK_NULL);
401 if (klass == NULL) return NULL;
402 return klass->java_mirror();
403 }
404
405 Symbol* SignatureStream::as_symbol_or_null() {
406 // Create a symbol from for string _begin _end
407 ResourceMark rm;
408
409 int begin = _begin;
410 int end = _end;
411
412 if (_type == T_OBJECT || _type == T_VALUETYPE) {
413 begin++;
414 end--;
415 if (begin == end) {
416 return vmSymbols::java_lang_Object();
417 }
418 }
419
420 char* buffer = NEW_RESOURCE_ARRAY(char, end - begin);
421 for (int index = begin; index < end; index++) {
422 buffer[index - begin] = _signature->byte_at(index);
423 }
424 Symbol* result = SymbolTable::probe(buffer, end - begin);
425 return result;
426 }
427
428 int SignatureStream::reference_parameter_count() {
429 int args_count = 0;
430 for ( ; !at_return_type(); next()) {
431 if (is_object()) {
432 args_count++;
433 }
434 }
435 return args_count;
436 }
437
438 bool SignatureVerifier::is_valid_signature(Symbol* sig) {
439 const char* signature = (const char*)sig->bytes();
440 ssize_t len = sig->utf8_length();
441 if (signature == NULL || signature[0] == '\0' || len < 1) {
442 return false;
443 } else if (signature[0] == '(') {
444 return is_valid_method_signature(sig);
445 } else {
446 return is_valid_type_signature(sig);
447 }
448 }
449
450 bool SignatureVerifier::is_valid_method_signature(Symbol* sig) {
451 const char* method_sig = (const char*)sig->bytes();
452 ssize_t len = sig->utf8_length();
453 ssize_t index = 0;
454 if (method_sig != NULL && len > 1 && method_sig[index] == '(') {
455 ++index;
456 while (index < len && method_sig[index] != ')') {
457 ssize_t res = is_valid_type(&method_sig[index], len - index);
458 if (res == -1) {
459 return false;
460 } else {
461 index += res;
462 }
463 }
464 if (index < len && method_sig[index] == ')') {
465 // check the return type
466 ++index;
467 return (is_valid_type(&method_sig[index], len - index) == (len - index));
468 }
469 }
470 return false;
471 }
472
473 bool SignatureVerifier::is_valid_type_signature(Symbol* sig) {
474 const char* type_sig = (const char*)sig->bytes();
475 ssize_t len = sig->utf8_length();
476 return (type_sig != NULL && len >= 1 &&
477 (is_valid_type(type_sig, len) == len));
478 }
479
480 // Checks to see if the type (not to go beyond 'limit') refers to a valid type.
481 // Returns -1 if it is not, or the index of the next character that is not part
482 // of the type. The type encoding may end before 'limit' and that's ok.
483 ssize_t SignatureVerifier::is_valid_type(const char* type, ssize_t limit) {
484 ssize_t index = 0;
485
486 // Iterate over any number of array dimensions
487 while (index < limit && type[index] == '[') ++index;
488 if (index >= limit) {
489 return -1;
490 }
491 switch (type[index]) {
492 case 'B': case 'C': case 'D': case 'F': case 'I':
493 case 'J': case 'S': case 'Z': case 'V':
494 return index + 1;
495 case 'L':
496 for (index = index + 1; index < limit; ++index) {
497 char c = type[index];
498 if (c == ';') {
499 return index + 1;
500 }
501 if (invalid_name_char(c)) {
502 return -1;
503 }
504 }
505 // fall through
506 default: ; // fall through
507 }
508 return -1;
509 }
510
511 bool SignatureVerifier::invalid_name_char(char c) {
512 switch (c) {
513 case '\0': case '.': case ';': case '[':
514 return true;
515 default:
516 return false;
517 }
518 }
519
520 int SigEntry::count_fields(const GrowableArray<SigEntry>& sig_extended) {
521 int values = 0;
522 for (int i = 0; i < sig_extended.length(); i++) {
523 if (sig_extended.at(i)._bt == T_VALUETYPE) {
524 values++;
525 }
526 }
527 return sig_extended.length() - 2 * values;
528 }
529
530 void SigEntry::fill_sig_bt(const GrowableArray<SigEntry>& sig_extended, BasicType* sig_bt_cc, int total_args_passed_cc, bool skip_vt) {
531 int j = 0;
532 for (int i = 0; i < sig_extended.length(); i++) {
533 if (!skip_vt) {
534 BasicType bt = sig_extended.at(i)._bt;
535 assert(bt != T_VALUETYPE, "value types should be passed as fields or reference");
536 sig_bt_cc[j++] = bt;
537 } else if (sig_extended.at(i)._bt != T_VALUETYPE &&
538 (sig_extended.at(i)._bt != T_VOID ||
539 sig_extended.at(i-1)._bt == T_LONG ||
540 sig_extended.at(i-1)._bt == T_DOUBLE)) {
541 sig_bt_cc[j++] = sig_extended.at(i)._bt;
542 }
543 }
544 assert(j == total_args_passed_cc, "bad number of arguments");
545 }