PR sanitizer/82595
[official-gcc.git] / gcc / hooks.c
blobd383926c32933c335bdc392cfe06fe69335b423d
1 /* General-purpose hooks.
2 Copyright (C) 2002-2017 Free Software Foundation, Inc.
4 This program is free software; you can redistribute it and/or modify it
5 under the terms of the GNU General Public License as published by the
6 Free Software Foundation; either version 3, or (at your option) any
7 later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; see the file COPYING3. If not see
16 <http://www.gnu.org/licenses/>.
18 In other words, you are welcome to use, share and improve this program.
19 You are forbidden to forbid anyone else to use, share and improve
20 what you give them. Help stamp out software-hoarding! */
22 /* This file contains generic hooks that can be used as defaults for
23 target or language-dependent hook initializers. */
25 #include "config.h"
26 #include "system.h"
27 #include "coretypes.h"
28 #include "tm.h"
29 #include "hooks.h"
31 /* Generic hook that does absolutely zappo. */
32 void
33 hook_void_void (void)
37 /* Generic hook that takes no arguments and returns false. */
38 bool
39 hook_bool_void_false (void)
41 return false;
44 /* Generic hook that takes no arguments and returns true. */
45 bool
46 hook_bool_void_true (void)
48 return true;
51 /* Generic hook that takes (bool) and returns false. */
52 bool
53 hook_bool_bool_false (bool)
55 return false;
58 /* Generic hook that takes (bool, struct gcc_options *) and returns false. */
59 bool
60 hook_bool_bool_gcc_optionsp_false (bool, struct gcc_options *)
62 return false;
65 /* Generic hook that takes const int, const int) and returns true. */
66 bool hook_bool_const_int_const_int_true (const int, const int)
68 return true;
71 /* Generic hook that takes (machine_mode) and returns false. */
72 bool
73 hook_bool_mode_false (machine_mode)
75 return false;
78 /* Generic hook that takes (machine_mode) and returns true. */
79 bool
80 hook_bool_mode_true (machine_mode)
82 return true;
85 /* Generic hook that takes (machine_mode, machine_mode) and returns true. */
86 bool
87 hook_bool_mode_mode_true (machine_mode, machine_mode)
89 return true;
92 /* Generic hook that takes (machine_mode, const_rtx) and returns false. */
93 bool
94 hook_bool_mode_const_rtx_false (machine_mode, const_rtx)
96 return false;
99 /* Generic hook that takes (machine_mode, const_rtx) and returns true. */
100 bool
101 hook_bool_mode_const_rtx_true (machine_mode, const_rtx)
103 return true;
106 /* Generic hook that takes (machine_mode, rtx) and returns false. */
107 bool
108 hook_bool_mode_rtx_false (machine_mode, rtx)
110 return false;
113 /* Generic hook that takes (machine_mode, rtx) and returns true. */
114 bool
115 hook_bool_mode_rtx_true (machine_mode, rtx)
117 return true;
120 /* Generic hook that takes (const rtx_insn *, const rtx_insn *) and returns true. */
121 bool
122 hook_bool_const_rtx_insn_const_rtx_insn_true (const rtx_insn *,
123 const rtx_insn *)
125 return true;
128 /* Generic hook that takes (machine_mode, unsigned HOST_WIDE_INT)
129 and returns false. */
130 bool
131 hook_bool_mode_uhwi_false (machine_mode, unsigned HOST_WIDE_INT)
133 return false;
136 /* Generic hook that takes (unsigned int, unsigned int) and returns true. */
137 bool
138 hook_bool_uint_uint_true (unsigned int, unsigned int)
140 return true;
143 /* Generic hook that takes (unsigned int, machine_mode) and returns false. */
144 bool
145 hook_bool_uint_mode_false (unsigned int, machine_mode)
147 return false;
150 /* Generic hook that takes (unsigned int, machine_mode) and returns true. */
151 bool
152 hook_bool_uint_mode_true (unsigned int, machine_mode)
154 return true;
157 /* Generic hook that takes (FILE *, const char *) and does nothing. */
158 void
159 hook_void_FILEptr_constcharptr (FILE *, const char *)
163 /* Generic hook that takes (FILE *, const char *, constr_tree *) and does
164 nothing. */
165 void
166 hook_void_FILEptr_constcharptr_const_tree (FILE *, const char *, const_tree)
170 /* Generic hook that takes (FILE *, rtx) and returns false. */
171 bool
172 hook_bool_FILEptr_rtx_false (FILE *, rtx)
174 return false;
177 /* Generic hook that takes (gimple_stmt_iterator *) and returns
178 false. */
179 bool
180 hook_bool_gsiptr_false (gimple_stmt_iterator *)
182 return false;
185 /* Used for the TARGET_ASM_CAN_OUTPUT_MI_THUNK hook. */
186 bool
187 hook_bool_const_tree_hwi_hwi_const_tree_false (const_tree, HOST_WIDE_INT,
188 HOST_WIDE_INT, const_tree)
190 return false;
193 bool
194 hook_bool_const_tree_hwi_hwi_const_tree_true (const_tree, HOST_WIDE_INT,
195 HOST_WIDE_INT, const_tree)
197 return true;
200 bool
201 default_can_output_mi_thunk_no_vcall (const_tree, HOST_WIDE_INT,
202 HOST_WIDE_INT c, const_tree)
204 return c == 0;
208 hook_int_uint_mode_1 (unsigned int, machine_mode)
210 return 1;
214 hook_int_const_tree_0 (const_tree)
216 return 0;
219 /* ??? Used for comp_type_attributes, which ought to return bool. */
221 hook_int_const_tree_const_tree_1 (const_tree, const_tree)
223 return 1;
227 hook_int_rtx_0 (rtx)
229 return 0;
233 hook_int_rtx_1 (rtx)
235 return 1;
239 hook_int_rtx_insn_unreachable (rtx_insn *)
241 gcc_unreachable ();
245 hook_int_rtx_bool_0 (rtx, bool)
247 return 0;
251 hook_int_rtx_mode_as_bool_0 (rtx, machine_mode, addr_space_t, bool)
253 return 0;
256 unsigned int
257 hook_uint_void_0 (void)
259 return 0;
262 void
263 hook_void_tree (tree)
267 void
268 hook_void_rtx_tree (rtx, tree)
272 void
273 hook_void_constcharptr (const char *)
277 void
278 hook_void_tree_treeptr (tree, tree *)
282 void
283 hook_void_int_int (int, int)
287 bool
288 hook_bool_tree_false (tree)
290 return false;
293 bool
294 hook_bool_const_tree_false (const_tree)
296 return false;
299 bool
300 hook_bool_tree_true (tree)
302 return true;
305 bool
306 hook_bool_const_tree_true (const_tree)
308 return true;
311 bool
312 hook_bool_tree_tree_false (tree, tree)
314 return false;
317 bool
318 hook_bool_tree_tree_true (tree, tree)
320 return true;
323 bool
324 hook_bool_tree_bool_false (tree, bool)
326 return false;
329 bool
330 hook_bool_rtx_insn_true (rtx_insn *)
332 return true;
335 bool
336 hook_bool_rtx_false (rtx)
338 return false;
341 bool
342 hook_bool_uintp_uintp_false (unsigned int *, unsigned int *)
344 return false;
347 bool
348 hook_bool_rtx_mode_int_int_intp_bool_false (rtx, machine_mode, int, int,
349 int *, bool)
351 return false;
354 bool
355 hook_bool_wint_wint_uint_bool_true (const widest_int &, const widest_int &,
356 unsigned int, bool)
358 return true;
361 /* Generic hook that takes an rtx and returns it. */
363 hook_rtx_rtx_identity (rtx x)
365 return x;
368 /* Generic hook that takes an rtx and returns NULL_RTX. */
370 hook_rtx_rtx_null (rtx)
372 return NULL;
375 /* Generic hook that takes a tree and an int and returns NULL_RTX. */
377 hook_rtx_tree_int_null (tree, int)
379 return NULL;
382 /* Generic hook that takes a machine mode and returns an unsigned int 0. */
383 unsigned int
384 hook_uint_mode_0 (machine_mode)
386 return 0;
389 /* Generic hook that takes no arguments and returns a NULL const string. */
390 const char *
391 hook_constcharptr_void_null (void)
393 return NULL;
396 /* Generic hook that takes no arguments and returns a NULL string. */
397 char *
398 hook_charptr_void_null (void)
400 return NULL;
403 /* Generic hook that takes a tree and returns a NULL string. */
404 const char *
405 hook_constcharptr_const_tree_null (const_tree)
407 return NULL;
410 tree
411 hook_tree_tree_int_treep_bool_null (tree, int, tree *, bool)
413 return NULL;
416 tree
417 hook_tree_tree_tree_null (tree, tree)
419 return NULL;
422 tree
423 hook_tree_tree_tree_tree_null (tree, tree, tree)
425 return NULL;
428 /* Generic hook that takes an rtx_insn *and returns a NULL string. */
429 const char *
430 hook_constcharptr_const_rtx_insn_null (const rtx_insn *)
432 return NULL;
435 const char *
436 hook_constcharptr_const_tree_const_tree_null (const_tree, const_tree)
438 return NULL;
441 const char *
442 hook_constcharptr_int_const_tree_null (int, const_tree)
444 return NULL;
447 const char *
448 hook_constcharptr_int_const_tree_const_tree_null (int, const_tree, const_tree)
450 return NULL;
453 /* Generic hook that takes a const_tree and returns NULL_TREE. */
454 tree
455 hook_tree_const_tree_null (const_tree)
457 return NULL;
460 /* Generic hook that takes no arguments and returns a NULL_TREE. */
461 tree
462 hook_tree_void_null (void)
464 return NULL;
467 /* Generic hook that takes a rtx_insn * and an int and returns a bool. */
469 bool
470 hook_bool_rtx_insn_int_false (rtx_insn *, int)
472 return false;
475 /* Generic hook that takes a rtx_insn * and an int and returns void. */
477 void
478 hook_void_rtx_insn_int (rtx_insn *, int)
482 /* Generic hook that takes a struct gcc_options * and returns void. */
484 void
485 hook_void_gcc_optionsp (struct gcc_options *)
489 /* Generic hook that takes an unsigned int, an unsigned int pointer and
490 returns false. */
492 bool
493 hook_bool_uint_uintp_false (unsigned int, unsigned int *)
495 return false;
498 /* Generic hook that takes a register class and returns false. */
499 bool
500 hook_bool_reg_class_t_false (reg_class_t regclass ATTRIBUTE_UNUSED)
502 return false;
505 /* Generic hook that takes 2 machine_modes and a register class and
506 returns true. */
507 bool
508 hook_bool_mode_mode_reg_class_t_true (machine_mode, machine_mode, reg_class_t)
510 return true;
513 /* Generic hook that takes a machine_mode and 2 register classes
514 and returns false. */
515 bool
516 hook_bool_mode_reg_class_t_reg_class_t_false (machine_mode, reg_class_t,
517 reg_class_t)
519 return false;