1 /* Built-in and inline functions for gcj
2 Copyright (C) 2001, 2003, 2004, 2005, 2006, 2007, 2009
3 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.
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 /* Written by Tom Tromey <tromey@redhat.com>. */
29 #include "coretypes.h"
34 #include "langhooks.h"
35 #include "java-tree.h"
39 #include "insn-codes.h"
43 static tree
max_builtin (tree
, tree
);
44 static tree
min_builtin (tree
, tree
);
45 static tree
abs_builtin (tree
, tree
);
46 static tree
convert_real (tree
, tree
);
48 static tree
java_build_function_call_expr (tree
, tree
);
50 static tree
putObject_builtin (tree
, tree
);
51 static tree
compareAndSwapInt_builtin (tree
, tree
);
52 static tree
compareAndSwapLong_builtin (tree
, tree
);
53 static tree
compareAndSwapObject_builtin (tree
, tree
);
54 static tree
putVolatile_builtin (tree
, tree
);
55 static tree
getVolatile_builtin (tree
, tree
);
56 static tree
VMSupportsCS8_builtin (tree
, tree
);
59 /* Functions of this type are used to inline a given call. Such a
60 function should either return an expression, if the call is to be
61 inlined, or NULL_TREE if a real call should be emitted. Arguments
62 are method return type and the original CALL_EXPR containing the
63 arguments to the call. */
64 typedef tree
builtin_creator_function (tree
, tree
);
66 /* Hold a char*, before initialization, or a tree, after
68 union GTY(()) string_or_tree
{
69 const char * GTY ((tag ("0"))) s
;
70 tree
GTY ((tag ("1"))) t
;
73 /* Used to hold a single builtin record. */
74 struct GTY(()) builtin_record
{
75 union string_or_tree
GTY ((desc ("1"))) class_name
;
76 union string_or_tree
GTY ((desc ("1"))) method_name
;
77 builtin_creator_function
* GTY((skip
)) creator
;
78 enum built_in_function builtin_code
;
81 static GTY(()) struct builtin_record java_builtins
[] =
83 { { "java.lang.Math" }, { "min" }, min_builtin
, 0 },
84 { { "java.lang.Math" }, { "max" }, max_builtin
, 0 },
85 { { "java.lang.Math" }, { "abs" }, abs_builtin
, 0 },
86 { { "java.lang.Math" }, { "acos" }, NULL
, BUILT_IN_ACOS
},
87 { { "java.lang.Math" }, { "asin" }, NULL
, BUILT_IN_ASIN
},
88 { { "java.lang.Math" }, { "atan" }, NULL
, BUILT_IN_ATAN
},
89 { { "java.lang.Math" }, { "atan2" }, NULL
, BUILT_IN_ATAN2
},
90 { { "java.lang.Math" }, { "ceil" }, NULL
, BUILT_IN_CEIL
},
91 { { "java.lang.Math" }, { "cos" }, NULL
, BUILT_IN_COS
},
92 { { "java.lang.Math" }, { "exp" }, NULL
, BUILT_IN_EXP
},
93 { { "java.lang.Math" }, { "floor" }, NULL
, BUILT_IN_FLOOR
},
94 { { "java.lang.Math" }, { "log" }, NULL
, BUILT_IN_LOG
},
95 { { "java.lang.Math" }, { "pow" }, NULL
, BUILT_IN_POW
},
96 { { "java.lang.Math" }, { "sin" }, NULL
, BUILT_IN_SIN
},
97 { { "java.lang.Math" }, { "sqrt" }, NULL
, BUILT_IN_SQRT
},
98 { { "java.lang.Math" }, { "tan" }, NULL
, BUILT_IN_TAN
},
99 { { "java.lang.Float" }, { "intBitsToFloat" }, convert_real
, 0 },
100 { { "java.lang.Double" }, { "longBitsToDouble" }, convert_real
, 0 },
101 { { "java.lang.Float" }, { "floatToRawIntBits" }, convert_real
, 0 },
102 { { "java.lang.Double" }, { "doubleToRawLongBits" }, convert_real
, 0 },
103 { { "sun.misc.Unsafe" }, { "putInt" }, putObject_builtin
, 0},
104 { { "sun.misc.Unsafe" }, { "putLong" }, putObject_builtin
, 0},
105 { { "sun.misc.Unsafe" }, { "putObject" }, putObject_builtin
, 0},
106 { { "sun.misc.Unsafe" }, { "compareAndSwapInt" },
107 compareAndSwapInt_builtin
, 0},
108 { { "sun.misc.Unsafe" }, { "compareAndSwapLong" },
109 compareAndSwapLong_builtin
, 0},
110 { { "sun.misc.Unsafe" }, { "compareAndSwapObject" },
111 compareAndSwapObject_builtin
, 0},
112 { { "sun.misc.Unsafe" }, { "putOrderedInt" }, putVolatile_builtin
, 0},
113 { { "sun.misc.Unsafe" }, { "putOrderedLong" }, putVolatile_builtin
, 0},
114 { { "sun.misc.Unsafe" }, { "putOrderedObject" }, putVolatile_builtin
, 0},
115 { { "sun.misc.Unsafe" }, { "putIntVolatile" }, putVolatile_builtin
, 0},
116 { { "sun.misc.Unsafe" }, { "putLongVolatile" }, putVolatile_builtin
, 0},
117 { { "sun.misc.Unsafe" }, { "putObjectVolatile" }, putVolatile_builtin
, 0},
118 { { "sun.misc.Unsafe" }, { "getObjectVolatile" }, getVolatile_builtin
, 0},
119 { { "sun.misc.Unsafe" }, { "getIntVolatile" }, getVolatile_builtin
, 0},
120 { { "sun.misc.Unsafe" }, { "getLongVolatile" }, getVolatile_builtin
, 0},
121 { { "sun.misc.Unsafe" }, { "getLong" }, getVolatile_builtin
, 0},
122 { { "java.util.concurrent.atomic.AtomicLong" }, { "VMSupportsCS8" },
123 VMSupportsCS8_builtin
, 0},
124 { { NULL
}, { NULL
}, NULL
, END_BUILTINS
}
128 /* Internal functions which implement various builtin conversions. */
131 max_builtin (tree method_return_type
, tree orig_call
)
133 /* MAX_EXPR does not handle -0.0 in the Java style. */
134 if (TREE_CODE (method_return_type
) == REAL_TYPE
)
136 return fold_build2 (MAX_EXPR
, method_return_type
,
137 CALL_EXPR_ARG (orig_call
, 0),
138 CALL_EXPR_ARG (orig_call
, 1));
142 min_builtin (tree method_return_type
, tree orig_call
)
144 /* MIN_EXPR does not handle -0.0 in the Java style. */
145 if (TREE_CODE (method_return_type
) == REAL_TYPE
)
147 return fold_build2 (MIN_EXPR
, method_return_type
,
148 CALL_EXPR_ARG (orig_call
, 0),
149 CALL_EXPR_ARG (orig_call
, 1));
153 abs_builtin (tree method_return_type
, tree orig_call
)
155 return fold_build1 (ABS_EXPR
, method_return_type
,
156 CALL_EXPR_ARG (orig_call
, 0));
159 /* Construct a new call to FN using the arguments from ORIG_CALL. */
162 java_build_function_call_expr (tree fn
, tree orig_call
)
164 int nargs
= call_expr_nargs (orig_call
);
167 /* Although we could handle the 0-3 argument cases using the general
168 logic in the default case, splitting them out permits folding to
169 be performed without constructing a temporary CALL_EXPR. */
171 return build_call_expr (fn
, 0);
173 return build_call_expr (fn
, 1, CALL_EXPR_ARG (orig_call
, 0));
175 return build_call_expr (fn
, 2,
176 CALL_EXPR_ARG (orig_call
, 0),
177 CALL_EXPR_ARG (orig_call
, 1));
179 return build_call_expr (fn
, 3,
180 CALL_EXPR_ARG (orig_call
, 0),
181 CALL_EXPR_ARG (orig_call
, 1),
182 CALL_EXPR_ARG (orig_call
, 2));
185 tree fntype
= TREE_TYPE (fn
);
186 fn
= build1 (ADDR_EXPR
, build_pointer_type (fntype
), fn
);
187 return fold (build_call_array (TREE_TYPE (fntype
),
188 fn
, nargs
, CALL_EXPR_ARGP (orig_call
)));
194 convert_real (tree method_return_type
, tree orig_call
)
196 return build1 (VIEW_CONVERT_EXPR
, method_return_type
,
197 CALL_EXPR_ARG (orig_call
, 0));
202 /* Provide builtin support for atomic operations. These are
203 documented at length in libjava/sun/misc/Unsafe.java. */
205 /* FIXME. There are still a few things wrong with this logic. In
206 particular, atomic writes of multi-word integers are not truly
207 atomic: this requires more work.
209 In general, double-word compare-and-swap cannot portably be
210 implemented, so we need some kind of fallback for 32-bit machines.
215 /* Macros to unmarshal arguments from a CALL_EXPR into a few
216 variables. We also convert the offset arg from a long to an
217 integer that is the same size as a pointer. */
219 #define UNMARSHAL3(METHOD_CALL) \
220 tree this_arg, obj_arg, offset_arg; \
223 tree orig_method_call = METHOD_CALL; \
224 this_arg = CALL_EXPR_ARG (orig_method_call, 0); \
225 obj_arg = CALL_EXPR_ARG (orig_method_call, 1); \
226 offset_arg = fold_convert (java_type_for_size (POINTER_SIZE, 0), \
227 CALL_EXPR_ARG (orig_method_call, 2)); \
231 #define UNMARSHAL4(METHOD_CALL) \
232 tree value_type, this_arg, obj_arg, offset_arg, value_arg; \
235 tree orig_method_call = METHOD_CALL; \
236 this_arg = CALL_EXPR_ARG (orig_method_call, 0); \
237 obj_arg = CALL_EXPR_ARG (orig_method_call, 1); \
238 offset_arg = fold_convert (java_type_for_size (POINTER_SIZE, 0), \
239 CALL_EXPR_ARG (orig_method_call, 2)); \
240 value_arg = CALL_EXPR_ARG (orig_method_call, 3); \
241 value_type = TREE_TYPE (value_arg); \
245 #define UNMARSHAL5(METHOD_CALL) \
246 tree value_type, this_arg, obj_arg, offset_arg, expected_arg, value_arg; \
249 tree orig_method_call = METHOD_CALL; \
250 this_arg = CALL_EXPR_ARG (orig_method_call, 0); \
251 obj_arg = CALL_EXPR_ARG (orig_method_call, 1); \
252 offset_arg = fold_convert (java_type_for_size (POINTER_SIZE, 0), \
253 CALL_EXPR_ARG (orig_method_call, 2)); \
254 expected_arg = CALL_EXPR_ARG (orig_method_call, 3); \
255 value_arg = CALL_EXPR_ARG (orig_method_call, 4); \
256 value_type = TREE_TYPE (value_arg); \
260 /* Add an address to an offset, forming a sum. */
263 build_addr_sum (tree type
, tree addr
, tree offset
)
265 tree ptr_type
= build_pointer_type (type
);
266 return fold_build2 (POINTER_PLUS_EXPR
,
268 fold_convert (ptr_type
, addr
),
269 fold_convert (sizetype
, offset
));
272 /* Make sure that this-arg is non-NULL. This is a security check. */
275 build_check_this (tree stmt
, tree this_arg
)
277 return build2 (COMPOUND_EXPR
, TREE_TYPE (stmt
),
278 java_check_reference (this_arg
, 1), stmt
);
281 /* Now the builtins. These correspond to the primitive functions in
282 libjava/sun/misc/natUnsafe.cc. */
285 putObject_builtin (tree method_return_type ATTRIBUTE_UNUSED
,
289 UNMARSHAL4 (orig_call
);
291 addr
= build_addr_sum (value_type
, obj_arg
, offset_arg
);
292 stmt
= fold_build2 (MODIFY_EXPR
, value_type
,
293 build_java_indirect_ref (value_type
, addr
,
294 flag_check_references
),
297 return build_check_this (stmt
, this_arg
);
301 compareAndSwapInt_builtin (tree method_return_type ATTRIBUTE_UNUSED
,
304 enum machine_mode mode
= TYPE_MODE (int_type_node
);
305 if (sync_compare_and_swap
[mode
] != CODE_FOR_nothing
)
308 UNMARSHAL5 (orig_call
);
310 addr
= build_addr_sum (int_type_node
, obj_arg
, offset_arg
);
311 stmt
= build_call_expr (built_in_decls
[BUILT_IN_BOOL_COMPARE_AND_SWAP_4
],
312 3, addr
, expected_arg
, value_arg
);
314 return build_check_this (stmt
, this_arg
);
320 compareAndSwapLong_builtin (tree method_return_type ATTRIBUTE_UNUSED
,
323 enum machine_mode mode
= TYPE_MODE (long_type_node
);
324 if (sync_compare_and_swap
[mode
] != CODE_FOR_nothing
)
327 UNMARSHAL5 (orig_call
);
329 addr
= build_addr_sum (long_type_node
, obj_arg
, offset_arg
);
330 stmt
= build_call_expr (built_in_decls
[BUILT_IN_BOOL_COMPARE_AND_SWAP_8
],
331 3, addr
, expected_arg
, value_arg
);
333 return build_check_this (stmt
, this_arg
);
338 compareAndSwapObject_builtin (tree method_return_type ATTRIBUTE_UNUSED
,
341 enum machine_mode mode
= TYPE_MODE (ptr_type_node
);
342 if (sync_compare_and_swap
[mode
] != CODE_FOR_nothing
)
347 UNMARSHAL5 (orig_call
);
348 builtin
= (POINTER_SIZE
== 32
349 ? BUILT_IN_BOOL_COMPARE_AND_SWAP_4
350 : BUILT_IN_BOOL_COMPARE_AND_SWAP_8
);
352 addr
= build_addr_sum (value_type
, obj_arg
, offset_arg
);
353 stmt
= build_call_expr (built_in_decls
[builtin
],
354 3, addr
, expected_arg
, value_arg
);
356 return build_check_this (stmt
, this_arg
);
362 putVolatile_builtin (tree method_return_type ATTRIBUTE_UNUSED
,
365 tree addr
, stmt
, modify_stmt
;
366 UNMARSHAL4 (orig_call
);
368 addr
= build_addr_sum (value_type
, obj_arg
, offset_arg
);
370 = fold_convert (build_pointer_type (build_type_variant (value_type
, 0, 1)),
373 stmt
= build_call_expr (built_in_decls
[BUILT_IN_SYNCHRONIZE
], 0);
374 modify_stmt
= fold_build2 (MODIFY_EXPR
, value_type
,
375 build_java_indirect_ref (value_type
, addr
,
376 flag_check_references
),
378 stmt
= build2 (COMPOUND_EXPR
, TREE_TYPE (modify_stmt
),
381 return build_check_this (stmt
, this_arg
);
385 getVolatile_builtin (tree method_return_type ATTRIBUTE_UNUSED
,
388 tree addr
, stmt
, modify_stmt
, tmp
;
389 UNMARSHAL3 (orig_call
);
391 addr
= build_addr_sum (method_return_type
, obj_arg
, offset_arg
);
393 = fold_convert (build_pointer_type (build_type_variant
394 (method_return_type
, 0, 1)), addr
);
396 stmt
= build_call_expr (built_in_decls
[BUILT_IN_SYNCHRONIZE
], 0);
398 tmp
= build_decl (VAR_DECL
, NULL
, method_return_type
);
399 DECL_IGNORED_P (tmp
) = 1;
400 DECL_ARTIFICIAL (tmp
) = 1;
403 modify_stmt
= fold_build2 (MODIFY_EXPR
, method_return_type
,
405 build_java_indirect_ref (method_return_type
, addr
,
406 flag_check_references
));
408 stmt
= build2 (COMPOUND_EXPR
, void_type_node
, modify_stmt
, stmt
);
409 stmt
= build2 (COMPOUND_EXPR
, method_return_type
, stmt
, tmp
);
415 VMSupportsCS8_builtin (tree method_return_type
,
416 tree orig_call ATTRIBUTE_UNUSED
)
418 enum machine_mode mode
= TYPE_MODE (long_type_node
);
419 gcc_assert (method_return_type
== boolean_type_node
);
420 if (sync_compare_and_swap
[mode
] != CODE_FOR_nothing
)
421 return boolean_true_node
;
423 return boolean_false_node
;
428 #define BUILTIN_NOTHROW 1
429 #define BUILTIN_CONST 2
430 /* Define a single builtin. */
432 define_builtin (enum built_in_function val
,
440 decl
= build_decl (FUNCTION_DECL
, get_identifier (name
), type
);
441 DECL_EXTERNAL (decl
) = 1;
442 TREE_PUBLIC (decl
) = 1;
443 SET_DECL_ASSEMBLER_NAME (decl
, get_identifier (libname
));
445 DECL_BUILT_IN_CLASS (decl
) = BUILT_IN_NORMAL
;
446 DECL_FUNCTION_CODE (decl
) = val
;
447 if (flags
& BUILTIN_NOTHROW
)
448 TREE_NOTHROW (decl
) = 1;
449 if (flags
& BUILTIN_CONST
)
450 TREE_READONLY (decl
) = 1;
452 implicit_built_in_decls
[val
] = decl
;
453 built_in_decls
[val
] = decl
;
458 /* Initialize the builtins. */
460 initialize_builtins (void)
462 tree double_ftype_double
, double_ftype_double_double
;
463 tree float_ftype_float
, float_ftype_float_float
;
464 tree boolean_ftype_boolean_boolean
;
468 for (i
= 0; java_builtins
[i
].builtin_code
!= END_BUILTINS
; ++i
)
470 tree klass_id
= get_identifier (java_builtins
[i
].class_name
.s
);
471 tree m
= get_identifier (java_builtins
[i
].method_name
.s
);
473 java_builtins
[i
].class_name
.t
= klass_id
;
474 java_builtins
[i
].method_name
.t
= m
;
477 void_list_node
= end_params_node
;
479 t
= tree_cons (NULL_TREE
, float_type_node
, end_params_node
);
480 float_ftype_float
= build_function_type (float_type_node
, t
);
481 t
= tree_cons (NULL_TREE
, float_type_node
, t
);
482 float_ftype_float_float
= build_function_type (float_type_node
, t
);
484 t
= tree_cons (NULL_TREE
, double_type_node
, end_params_node
);
485 double_ftype_double
= build_function_type (double_type_node
, t
);
486 t
= tree_cons (NULL_TREE
, double_type_node
, t
);
487 double_ftype_double_double
= build_function_type (double_type_node
, t
);
489 define_builtin (BUILT_IN_FMOD
, "__builtin_fmod",
490 double_ftype_double_double
, "fmod", BUILTIN_CONST
);
491 define_builtin (BUILT_IN_FMODF
, "__builtin_fmodf",
492 float_ftype_float_float
, "fmodf", BUILTIN_CONST
);
494 define_builtin (BUILT_IN_ACOS
, "__builtin_acos",
495 double_ftype_double
, "_ZN4java4lang4Math4acosEJdd",
497 define_builtin (BUILT_IN_ASIN
, "__builtin_asin",
498 double_ftype_double
, "_ZN4java4lang4Math4asinEJdd",
500 define_builtin (BUILT_IN_ATAN
, "__builtin_atan",
501 double_ftype_double
, "_ZN4java4lang4Math4atanEJdd",
503 define_builtin (BUILT_IN_ATAN2
, "__builtin_atan2",
504 double_ftype_double_double
, "_ZN4java4lang4Math5atan2EJddd",
506 define_builtin (BUILT_IN_CEIL
, "__builtin_ceil",
507 double_ftype_double
, "_ZN4java4lang4Math4ceilEJdd",
509 define_builtin (BUILT_IN_COS
, "__builtin_cos",
510 double_ftype_double
, "_ZN4java4lang4Math3cosEJdd",
512 define_builtin (BUILT_IN_EXP
, "__builtin_exp",
513 double_ftype_double
, "_ZN4java4lang4Math3expEJdd",
515 define_builtin (BUILT_IN_FLOOR
, "__builtin_floor",
516 double_ftype_double
, "_ZN4java4lang4Math5floorEJdd",
518 define_builtin (BUILT_IN_LOG
, "__builtin_log",
519 double_ftype_double
, "_ZN4java4lang4Math3logEJdd",
521 define_builtin (BUILT_IN_POW
, "__builtin_pow",
522 double_ftype_double_double
, "_ZN4java4lang4Math3powEJddd",
524 define_builtin (BUILT_IN_SIN
, "__builtin_sin",
525 double_ftype_double
, "_ZN4java4lang4Math3sinEJdd",
527 define_builtin (BUILT_IN_SQRT
, "__builtin_sqrt",
528 double_ftype_double
, "_ZN4java4lang4Math4sqrtEJdd",
530 define_builtin (BUILT_IN_TAN
, "__builtin_tan",
531 double_ftype_double
, "_ZN4java4lang4Math3tanEJdd",
534 t
= tree_cons (NULL_TREE
, boolean_type_node
, end_params_node
);
535 t
= tree_cons (NULL_TREE
, boolean_type_node
, t
);
536 boolean_ftype_boolean_boolean
= build_function_type (boolean_type_node
, t
);
537 define_builtin (BUILT_IN_EXPECT
, "__builtin_expect",
538 boolean_ftype_boolean_boolean
,
540 BUILTIN_CONST
| BUILTIN_NOTHROW
);
541 define_builtin (BUILT_IN_BOOL_COMPARE_AND_SWAP_4
,
542 "__sync_bool_compare_and_swap_4",
543 build_function_type_list (boolean_type_node
,
545 build_pointer_type (int_type_node
),
546 int_type_node
, NULL_TREE
),
547 "__sync_bool_compare_and_swap_4", 0);
548 define_builtin (BUILT_IN_BOOL_COMPARE_AND_SWAP_8
,
549 "__sync_bool_compare_and_swap_8",
550 build_function_type_list (boolean_type_node
,
552 build_pointer_type (long_type_node
),
553 int_type_node
, NULL_TREE
),
554 "__sync_bool_compare_and_swap_8", 0);
555 define_builtin (BUILT_IN_SYNCHRONIZE
, "__sync_synchronize",
556 build_function_type (void_type_node
, void_list_node
),
557 "__sync_synchronize", BUILTIN_NOTHROW
);
559 define_builtin (BUILT_IN_RETURN_ADDRESS
, "__builtin_return_address",
560 build_function_type_list (ptr_type_node
, int_type_node
, NULL_TREE
),
561 "__builtin_return_address", BUILTIN_NOTHROW
);
563 build_common_builtin_nodes ();
566 /* If the call matches a builtin, return the
567 appropriate builtin expression instead. */
569 check_for_builtin (tree method
, tree call
)
571 if (optimize
&& TREE_CODE (call
) == CALL_EXPR
)
574 tree method_class
= DECL_NAME (TYPE_NAME (DECL_CONTEXT (method
)));
575 tree method_name
= DECL_NAME (method
);
576 tree method_return_type
= TREE_TYPE (TREE_TYPE (method
));
578 for (i
= 0; java_builtins
[i
].builtin_code
!= END_BUILTINS
; ++i
)
580 if (method_class
== java_builtins
[i
].class_name
.t
581 && method_name
== java_builtins
[i
].method_name
.t
)
585 if (java_builtins
[i
].creator
!= NULL
)
588 = (*java_builtins
[i
].creator
) (method_return_type
, call
);
589 return result
== NULL_TREE
? call
: result
;
592 /* Builtin functions emit a direct call which is incompatible
594 if (flag_indirect_dispatch
)
596 fn
= built_in_decls
[java_builtins
[i
].builtin_code
];
599 return java_build_function_call_expr (fn
, call
);
606 #include "gt-java-builtins.h"