1 /* Java(TM) language-specific utility routines.
2 Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
3 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
5 This file is part of GCC.
7 GCC is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3, or (at your option)
12 GCC is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GCC; see the file COPYING3. If not see
19 <http://www.gnu.org/licenses/>.
21 Java and all Java-based marks are trademarks or registered trademarks
22 of Sun Microsystems, Inc. in the United States and other countries.
23 The Free Software Foundation is independent of Sun Microsystems, Inc. */
25 /* Hacked by Per Bothner <bothner@cygnus.com> February 1996. */
29 #include "coretypes.h"
35 #include "java-tree.h"
38 #include "langhooks.h"
39 #include "langhooks-def.h"
42 #include "diagnostic.h"
43 #include "tree-inline.h"
44 #include "splay-tree.h"
45 #include "tree-dump.h"
49 static bool java_init (void);
50 static void java_finish (void);
51 static unsigned int java_init_options (unsigned int, const char **);
52 static bool java_post_options (const char **);
54 static int java_handle_option (size_t scode, const char *arg, int value);
55 static void put_decl_string (const char *, int);
56 static void put_decl_node (tree);
57 static void java_print_error_function (diagnostic_context *, const char *,
59 static int merge_init_test_initialization (void * *, void *);
60 static int inline_init_test_initialization (void * *, void *);
61 static bool java_dump_tree (void *, tree);
62 static void dump_compound_expr (dump_info_p, tree);
63 static bool java_decl_ok_for_sibcall (const_tree);
65 static enum classify_record java_classify_record (tree type);
67 #ifndef TARGET_OBJECT_SUFFIX
68 # define TARGET_OBJECT_SUFFIX ".o"
71 /* Table of machine-independent attributes. */
72 const struct attribute_spec java_attribute_table[] =
74 { "nonnull", 0, -1, false, true, true,
76 { NULL, 0, 0, false, false, false, NULL }
79 /* Used to avoid printing error messages with bogus function
80 prototypes. Starts out false. */
81 static bool inhibit_error_function_printing;
83 const char *resource_name;
85 /* When nonzero, -Wall was turned on. */
88 /* When nonzero, report use of deprecated classes, methods, or fields. */
89 int flag_deprecated = 1;
91 /* When zero, don't optimize static class initialization. This flag shouldn't
92 be tested alone, use STATIC_CLASS_INITIALIZATION_OPTIMIZATION_P instead. */
93 /* FIXME: Make this work with gimplify. */
94 /* int flag_optimize_sci = 0; */
96 /* Don't attempt to verify invocations. */
97 int flag_verify_invocations = 0;
99 /* When nonzero, print extra version information. */
100 static int v_flag = 0;
104 /* Variable controlling how dependency tracking is enabled in
106 static int dependency_tracking = 0;
108 /* Flag values for DEPENDENCY_TRACKING. */
109 #define DEPEND_SET_FILE 1
110 #define DEPEND_ENABLE 2
111 #define DEPEND_TARGET_SET 4
112 #define DEPEND_FILE_ALREADY_SET 8
114 struct GTY(()) language_function {
118 #undef LANG_HOOKS_NAME
119 #define LANG_HOOKS_NAME "GNU Java"
120 #undef LANG_HOOKS_INIT
121 #define LANG_HOOKS_INIT java_init
122 #undef LANG_HOOKS_FINISH
123 #define LANG_HOOKS_FINISH java_finish
124 #undef LANG_HOOKS_INIT_OPTIONS
125 #define LANG_HOOKS_INIT_OPTIONS java_init_options
126 #undef LANG_HOOKS_HANDLE_OPTION
127 #define LANG_HOOKS_HANDLE_OPTION java_handle_option
128 #undef LANG_HOOKS_POST_OPTIONS
129 #define LANG_HOOKS_POST_OPTIONS java_post_options
130 #undef LANG_HOOKS_PARSE_FILE
131 #define LANG_HOOKS_PARSE_FILE java_parse_file
132 #undef LANG_HOOKS_MARK_ADDRESSABLE
133 #define LANG_HOOKS_MARK_ADDRESSABLE java_mark_addressable
134 #undef LANG_HOOKS_DUP_LANG_SPECIFIC_DECL
135 #define LANG_HOOKS_DUP_LANG_SPECIFIC_DECL java_dup_lang_specific_decl
136 #undef LANG_HOOKS_DECL_PRINTABLE_NAME
137 #define LANG_HOOKS_DECL_PRINTABLE_NAME lang_printable_name
138 #undef LANG_HOOKS_PRINT_ERROR_FUNCTION
139 #define LANG_HOOKS_PRINT_ERROR_FUNCTION java_print_error_function
141 #undef LANG_HOOKS_TYPE_FOR_MODE
142 #define LANG_HOOKS_TYPE_FOR_MODE java_type_for_mode
143 #undef LANG_HOOKS_TYPE_FOR_SIZE
144 #define LANG_HOOKS_TYPE_FOR_SIZE java_type_for_size
145 #undef LANG_HOOKS_CLASSIFY_RECORD
146 #define LANG_HOOKS_CLASSIFY_RECORD java_classify_record
148 #undef LANG_HOOKS_TREE_DUMP_DUMP_TREE_FN
149 #define LANG_HOOKS_TREE_DUMP_DUMP_TREE_FN java_dump_tree
151 #undef LANG_HOOKS_GIMPLIFY_EXPR
152 #define LANG_HOOKS_GIMPLIFY_EXPR java_gimplify_expr
154 #undef LANG_HOOKS_DECL_OK_FOR_SIBCALL
155 #define LANG_HOOKS_DECL_OK_FOR_SIBCALL java_decl_ok_for_sibcall
157 #undef LANG_HOOKS_SET_DECL_ASSEMBLER_NAME
158 #define LANG_HOOKS_SET_DECL_ASSEMBLER_NAME java_mangle_decl
160 #undef LANG_HOOKS_ATTRIBUTE_TABLE
161 #define LANG_HOOKS_ATTRIBUTE_TABLE java_attribute_table
163 /* Each front end provides its own. */
164 const struct lang_hooks lang_hooks = LANG_HOOKS_INITIALIZER;
167 * process java-specific compiler command-line options
168 * return 0, but do not complain if the option is not recognized.
171 java_handle_option (size_t scode, const char *arg, int value)
173 enum opt_code code = (enum opt_code) scode;
178 jcf_path_include_arg (arg);
182 jcf_dependency_init (1);
183 dependency_tracking |= DEPEND_ENABLE;
187 jcf_dependency_init (1);
188 dependency_tracking |= DEPEND_SET_FILE | DEPEND_ENABLE;
192 jcf_dependency_set_dep_file (arg);
193 dependency_tracking |= DEPEND_FILE_ALREADY_SET;
197 jcf_dependency_init (0);
198 dependency_tracking |= DEPEND_ENABLE;
202 jcf_dependency_init (0);
203 dependency_tracking |= DEPEND_SET_FILE | DEPEND_ENABLE;
207 jcf_dependency_print_dummies ();
211 jcf_dependency_set_target (arg);
212 dependency_tracking |= DEPEND_TARGET_SET;
217 /* When -Wall given, enable -Wunused. We do this because the C
218 compiler does it, and people expect it. */
222 case OPT_fenable_assertions_:
223 add_enable_assert (arg, value);
226 case OPT_fenable_assertions:
227 add_enable_assert ("", value);
230 case OPT_fdisable_assertions_:
231 add_enable_assert (arg, !value);
234 case OPT_fdisable_assertions:
235 add_enable_assert ("", !value);
238 case OPT_fassume_compiled_:
239 add_assume_compiled (arg, !value);
242 case OPT_fassume_compiled:
243 add_assume_compiled ("", !value);
246 case OPT_fbootclasspath_:
247 jcf_path_bootclasspath_arg (arg);
250 case OPT_faux_classpath:
251 case OPT_fclasspath_:
252 case OPT_fCLASSPATH_:
253 jcf_path_classpath_arg (arg);
256 case OPT_fcompile_resource_:
261 if (!dump_switch_p (arg))
270 jcf_path_extdirs_arg (arg);
273 case OPT_foutput_class_dir_:
274 /* FIXME: remove; this is handled by ecj1 now. */
281 case OPT_fsource_filename_:
282 java_read_sourcefilenames (arg);
286 if (cl_options[code].flags & CL_Java)
294 /* Global open file. */
300 /* FIXME: Indirect dispatch isn't yet compatible with static class
301 init optimization. */
302 if (flag_indirect_dispatch)
303 always_initialize_class_p = true;
305 if (!flag_indirect_dispatch)
306 flag_indirect_classes = false;
308 jcf_path_seal (v_flag);
310 java_init_decl_processing ();
312 using_eh_for_cleanups ();
320 jcf_dependency_write ();
323 /* Buffer used by lang_printable_name. */
324 static char *decl_buf = NULL;
326 /* Allocated size of decl_buf. */
327 static int decl_buflen = 0;
329 /* Length of used part of decl_buf; position for next character. */
330 static int decl_bufpos = 0;
332 /* Append the string STR to decl_buf.
333 It length is given by LEN; -1 means the string is nul-terminated. */
336 put_decl_string (const char *str, int len)
340 if (decl_bufpos + len >= decl_buflen)
342 if (decl_buf == NULL)
344 decl_buflen = len + 100;
345 decl_buf = XNEWVEC (char, decl_buflen);
350 decl_buf = XRESIZEVAR (char, decl_buf, decl_buflen);
353 strcpy (decl_buf + decl_bufpos, str);
357 /* Append to decl_buf a printable name for NODE. */
360 put_decl_node (tree node)
363 if (TREE_CODE (node) == POINTER_TYPE)
365 node = TREE_TYPE (node);
368 if (DECL_P (node) && DECL_NAME (node) != NULL_TREE)
370 if (TREE_CODE (node) == FUNCTION_DECL)
372 /* We want to print the type the DECL belongs to. We don't do
373 that when we handle constructors. */
374 if (! DECL_CONSTRUCTOR_P (node)
375 && ! DECL_ARTIFICIAL (node) && DECL_CONTEXT (node))
377 put_decl_node (TYPE_NAME (DECL_CONTEXT (node)));
378 put_decl_string (".", 1);
380 if (! DECL_CONSTRUCTOR_P (node))
381 put_decl_node (DECL_NAME (node));
382 if (TREE_TYPE (node) != NULL_TREE)
385 tree args = TYPE_ARG_TYPES (TREE_TYPE (node));
386 if (TREE_CODE (TREE_TYPE (node)) == METHOD_TYPE)
387 args = TREE_CHAIN (args);
388 put_decl_string ("(", 1);
389 for ( ; args != end_params_node; args = TREE_CHAIN (args), i++)
392 put_decl_string (",", 1);
393 put_decl_node (TREE_VALUE (args));
395 put_decl_string (")", 1);
399 put_decl_node (DECL_NAME (node));
401 else if (TYPE_P (node) && TYPE_NAME (node) != NULL_TREE)
403 if (TREE_CODE (node) == RECORD_TYPE && TYPE_ARRAY_P (node))
405 put_decl_node (TYPE_ARRAY_ELEMENT (node));
406 put_decl_string("[]", 2);
408 else if (node == promoted_byte_type_node)
409 put_decl_string ("byte", 4);
410 else if (node == promoted_short_type_node)
411 put_decl_string ("short", 5);
412 else if (node == promoted_char_type_node)
413 put_decl_string ("char", 4);
414 else if (node == promoted_boolean_type_node)
415 put_decl_string ("boolean", 7);
416 else if (node == void_type_node && was_pointer)
417 put_decl_string ("null", 4);
419 put_decl_node (TYPE_NAME (node));
421 else if (TREE_CODE (node) == IDENTIFIER_NODE)
422 put_decl_string (IDENTIFIER_POINTER (node), IDENTIFIER_LENGTH (node));
424 put_decl_string ("<unknown>", -1);
427 /* Return a user-friendly name for DECL.
428 The resulting string is only valid until the next call.
429 The value of the hook decl_printable_name is this function,
430 which is also called directly by java_print_error_function. */
433 lang_printable_name (tree decl, int v)
436 if (v == 0 && TREE_CODE (decl) == FUNCTION_DECL)
437 put_decl_node (DECL_NAME (decl));
439 put_decl_node (decl);
440 put_decl_string ("", 1);
444 /* Print on stderr the current class and method context. This function
445 is the value of the hook print_error_function. */
447 static GTY(()) tree last_error_function_context;
448 static GTY(()) tree last_error_function;
450 java_print_error_function (diagnostic_context *context ATTRIBUTE_UNUSED,
452 diagnostic_info *diagnostic ATTRIBUTE_UNUSED)
454 /* Don't print error messages with bogus function prototypes. */
455 if (inhibit_error_function_printing)
458 if (current_function_decl != NULL
459 && DECL_CONTEXT (current_function_decl) != last_error_function_context)
462 fprintf (stderr, "%s: ", file);
464 last_error_function_context = DECL_CONTEXT (current_function_decl);
465 fprintf (stderr, "In class '%s':\n",
466 lang_printable_name (last_error_function_context, 0));
468 if (last_error_function != current_function_decl)
471 fprintf (stderr, "%s: ", file);
473 if (current_function_decl == NULL)
474 fprintf (stderr, "At top level:\n");
477 const char *name = lang_printable_name (current_function_decl, 2);
478 fprintf (stderr, "In %s '%s':\n",
479 (DECL_CONSTRUCTOR_P (current_function_decl) ? "constructor"
484 last_error_function = current_function_decl;
489 /* Called to install the PRINT_ERROR_FUNCTION hook differently
490 according to LEVEL. LEVEL is 1 during early parsing, when function
491 prototypes aren't fully resolved. java_print_error_function is set
492 so it doesn't print incomplete function prototypes. When LEVEL is
493 2, function prototypes are fully resolved and can be printed when
497 lang_init_source (int level)
499 inhibit_error_function_printing = (level == 1);
503 java_init_options (unsigned int argc ATTRIBUTE_UNUSED,
504 const char **argv ATTRIBUTE_UNUSED)
506 flag_bounds_check = 1;
508 flag_non_call_exceptions = 1;
510 /* In Java floating point operations never trap. */
511 flag_trapping_math = 0;
513 /* In Java arithmetic overflow always wraps around. */
516 /* Java requires left-to-right evaluation of subexpressions. */
517 flag_evaluation_order = 1;
524 /* Post-switch processing. */
526 java_post_options (const char **pfilename)
528 const char *filename = *pfilename;
530 /* Excess precision other than "fast" requires front-end
532 if (flag_excess_precision_cmdline == EXCESS_PRECISION_STANDARD
533 && TARGET_FLT_EVAL_METHOD_NON_DEFAULT)
534 sorry ("-fexcess-precision=standard for Java");
535 flag_excess_precision_cmdline = EXCESS_PRECISION_FAST;
537 /* An absolute requirement: if we're not using indirect dispatch, we
538 must always verify everything. */
539 if (! flag_indirect_dispatch)
540 flag_verify_invocations = true;
542 if (flag_reduced_reflection)
544 if (flag_indirect_dispatch)
545 error ("-findirect-dispatch is incompatible "
546 "with -freduced-reflection");
548 error ("-fjni is incompatible with -freduced-reflection");
551 /* Open input file. */
553 if (filename == 0 || !strcmp (filename, "-"))
558 if (dependency_tracking)
559 error ("can't do dependency tracking with input from stdin");
563 if (dependency_tracking)
567 /* If the target is set and the output filename is set, then
568 there's no processing to do here. Otherwise we must
569 compute one or the other. */
570 if (! ((dependency_tracking & DEPEND_TARGET_SET)
571 && (dependency_tracking & DEPEND_FILE_ALREADY_SET)))
573 dot = strrchr (filename, '.');
575 error ("couldn't determine target name for dependency tracking");
578 char *buf = XNEWVEC (char, dot - filename +
579 3 + sizeof (TARGET_OBJECT_SUFFIX));
580 strncpy (buf, filename, dot - filename);
582 /* If emitting class files, we might have multiple
583 targets. The class generation code takes care of
584 registering them. Otherwise we compute the
586 if ((dependency_tracking & DEPEND_TARGET_SET))
590 strcpy (buf + (dot - filename), TARGET_OBJECT_SUFFIX);
591 jcf_dependency_set_target (buf);
594 if ((dependency_tracking & DEPEND_FILE_ALREADY_SET))
596 else if ((dependency_tracking & DEPEND_SET_FILE))
598 strcpy (buf + (dot - filename), ".d");
599 jcf_dependency_set_dep_file (buf);
602 jcf_dependency_set_dep_file ("-");
609 linemap_add (line_table, LC_ENTER, false, filename, 0);
610 linemap_add (line_table, LC_RENAME, false, "<built-in>", 0);
612 /* Initialize the compiler back end. */
616 /* Return either DECL or its known constant value (if it has one). */
619 decl_constant_value (tree decl)
621 if (/* Don't change a variable array bound or initial value to a constant
622 in a place where a variable is invalid. */
623 current_function_decl != 0
624 && ! TREE_THIS_VOLATILE (decl)
625 && TREE_READONLY (decl)
626 && DECL_INITIAL (decl) != 0
627 && TREE_CODE (DECL_INITIAL (decl)) != ERROR_MARK
628 /* This is invalid if initial value is not constant.
629 If it has either a function call, a memory reference,
630 or a variable, then re-evaluating it could give different results. */
631 && TREE_CONSTANT (DECL_INITIAL (decl))
632 /* Check for cases where this is sub-optimal, even though valid. */
633 && TREE_CODE (DECL_INITIAL (decl)) != CONSTRUCTOR)
634 return DECL_INITIAL (decl);
638 /* Every call to a static constructor has an associated boolean
639 variable which is in the outermost scope of the calling method.
640 This variable is used to avoid multiple calls to the static
641 constructor for each class.
643 It looks something like this:
647 boolean dummy = OtherClass.is_initialized;
652 OtherClass.initialize();
654 ... use OtherClass.data ...
657 Each of these boolean variables has an entry in the
658 DECL_FUNCTION_INIT_TEST_TABLE of a method. When inlining a method
659 we must merge the DECL_FUNCTION_INIT_TEST_TABLE from the function
660 being inlined and create the boolean variables in the outermost
661 scope of the method being inlined into. */
663 /* Create a mapping from a boolean variable in a method being inlined
664 to one in the scope of the method being inlined into. */
667 merge_init_test_initialization (void **entry, void *x)
669 struct treetreehash_entry *ite = (struct treetreehash_entry *) *entry;
670 splay_tree decl_map = (splay_tree)x;
672 tree *init_test_decl;
674 /* See if we have remapped this declaration. If we haven't there's
675 a bug in the inliner. */
676 n = splay_tree_lookup (decl_map, (splay_tree_key) ite->value);
679 /* Create a new entry for the class and its remapped boolean
680 variable. If we already have a mapping for this class we've
681 already initialized it, so don't overwrite the value. */
682 init_test_decl = java_treetreehash_new
683 (DECL_FUNCTION_INIT_TEST_TABLE (current_function_decl), ite->key);
684 if (!*init_test_decl)
685 *init_test_decl = (tree)n->value;
687 /* This fixes a weird case.
689 The front end assumes that once we have called a method that
690 initializes some class, we can assume the class is initialized. It
691 does this by setting the DECL_INITIAL of the init_test_decl for that
692 class, and no initializations are emitted for that class.
694 However, what if the method that is supposed to do the initialization
695 is itself inlined in the caller? When expanding the called method
696 we'll assume that the class initialization has already been done,
697 because the DECL_INITIAL of the init_test_decl is set.
699 To fix this we remove the DECL_INITIAL (in the caller scope) of all
700 the init_test_decls corresponding to classes initialized by the
701 inlined method. This makes the caller no longer assume that the
702 method being inlined does any class initializations. */
703 DECL_INITIAL (*init_test_decl) = NULL;
708 /* Merge the DECL_FUNCTION_INIT_TEST_TABLE from the function we're
712 java_inlining_merge_static_initializers (tree fn, void *decl_map)
715 (DECL_FUNCTION_INIT_TEST_TABLE (fn),
716 merge_init_test_initialization, decl_map);
719 /* Lookup a DECL_FUNCTION_INIT_TEST_TABLE entry in the method we're
720 inlining into. If we already have a corresponding entry in that
721 class we don't need to create another one, so we create a mapping
722 from the variable in the inlined class to the corresponding
726 inline_init_test_initialization (void **entry, void *x)
728 struct treetreehash_entry *ite = (struct treetreehash_entry *) *entry;
729 splay_tree decl_map = (splay_tree)x;
731 tree h = java_treetreehash_find
732 (DECL_FUNCTION_INIT_TEST_TABLE (current_function_decl), ite->key);
735 splay_tree_insert (decl_map,
736 (splay_tree_key) ite->value,
737 (splay_tree_value) h);
741 /* Look up the boolean variables in the DECL_FUNCTION_INIT_TEST_TABLE
742 of a method being inlined. For each hone, if we already have a
743 variable associated with the same class in the method being inlined
744 into, create a new mapping for it. */
747 java_inlining_map_static_initializers (tree fn, void *decl_map)
750 (DECL_FUNCTION_INIT_TEST_TABLE (fn),
751 inline_init_test_initialization, decl_map);
754 /* Avoid voluminous output for deep recursion of compound exprs. */
757 dump_compound_expr (dump_info_p di, tree t)
763 switch (TREE_CODE (TREE_OPERAND (t, i)))
766 dump_compound_expr (di, TREE_OPERAND (t, i));
770 dump_child ("expr", TREE_OPERAND (t, i));
776 java_dump_tree (void *dump_info, tree t)
779 dump_info_p di = (dump_info_p) dump_info;
781 /* Figure out what kind of node this is. */
782 code = TREE_CODE (t);
787 dump_child ("args", DECL_ARGUMENTS (t));
788 if (DECL_EXTERNAL (t))
789 dump_string (di, "undefined");
791 dump_string (di, "extern");
793 dump_string (di, "static");
794 if (DECL_LANG_SPECIFIC (t) && !dump_flag (di, TDF_SLIM, t))
795 dump_child ("inline body", DECL_SAVED_TREE (t));
799 dump_child ("expr", TREE_OPERAND (t, 0));
803 dump_child ("goto", TREE_OPERAND (t, 0));
807 dump_child ("label", TREE_OPERAND (t, 0));
811 if (BLOCK_EXPR_BODY (t))
813 tree local = BLOCK_VARS (t);
816 tree next = TREE_CHAIN (local);
817 dump_child ("var", local);
822 tree block = BLOCK_EXPR_BODY (t);
823 dump_child ("body", block);
824 block = TREE_CHAIN (block);
830 if (!dump_flag (di, TDF_SLIM, t))
832 dump_compound_expr (di, t);
841 /* Java calls can't, in general, be sibcalls because we need an
842 accurate stack trace in order to guarantee correct operation of
843 methods such as Class.forName(String) and
844 SecurityManager.getClassContext(). */
847 java_decl_ok_for_sibcall (const_tree decl)
849 return (decl != NULL && DECL_CONTEXT (decl) == output_class
850 && !DECL_UNINLINABLE (decl));
853 static enum classify_record
854 java_classify_record (tree type)
856 if (! CLASS_P (type))
857 return RECORD_IS_STRUCT;
859 /* ??? GDB does not support DW_TAG_interface_type as of December,
860 2007. Re-enable this at a later time. */
861 if (0 && CLASS_INTERFACE (TYPE_NAME (type)))
862 return RECORD_IS_INTERFACE;
864 return RECORD_IS_CLASS;
867 #include "gt-java-lang.h"