2016-08-24 Michael Collison <michael.collison@linaro.org>
[official-gcc.git] / gcc / function-tests.c
blob4152cd386d5aed5c59ec4f4c5ec430bc689566c7
1 /* Unit tests for function-handling.
2 Copyright (C) 2015-2016 Free Software Foundation, Inc.
4 This file is part of GCC.
6 GCC is free software; you can redistribute it and/or modify it under
7 the terms of the GNU General Public License as published by the Free
8 Software Foundation; either version 3, or (at your option) any later
9 version.
11 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
12 WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 for more details.
16 You should have received a copy of the GNU General Public License
17 along with GCC; see the file COPYING3. If not see
18 <http://www.gnu.org/licenses/>. */
20 #include "config.h"
21 #include "system.h"
22 #include "coretypes.h"
23 #include "tm.h"
24 #include "opts.h"
25 #include "signop.h"
26 #include "hash-set.h"
27 #include "fixed-value.h"
28 #include "alias.h"
29 #include "flags.h"
30 #include "symtab.h"
31 #include "tree-core.h"
32 #include "stor-layout.h"
33 #include "tree.h"
34 #include "stringpool.h"
35 #include "stor-layout.h"
36 #include "rtl.h"
37 #include "predict.h"
38 #include "vec.h"
39 #include "hashtab.h"
40 #include "hash-set.h"
41 #include "machmode.h"
42 #include "hard-reg-set.h"
43 #include "input.h"
44 #include "function.h"
45 #include "dominance.h"
46 #include "cfg.h"
47 #include "cfganal.h"
48 #include "basic-block.h"
49 #include "tree-ssa-alias.h"
50 #include "internal-fn.h"
51 #include "gimple-fold.h"
52 #include "gimple-expr.h"
53 #include "toplev.h"
54 #include "print-tree.h"
55 #include "tree-iterator.h"
56 #include "gimplify.h"
57 #include "tree-cfg.h"
58 #include "basic-block.h"
59 #include "double-int.h"
60 #include "alias.h"
61 #include "symtab.h"
62 #include "wide-int.h"
63 #include "inchash.h"
64 #include "tree.h"
65 #include "fold-const.h"
66 #include "stor-layout.h"
67 #include "stmt.h"
68 #include "hash-table.h"
69 #include "tree-ssa-alias.h"
70 #include "internal-fn.h"
71 #include "gimple-expr.h"
72 #include "is-a.h"
73 #include "gimple.h"
74 #include "tree-pass.h"
75 #include "context.h"
76 #include "hash-map.h"
77 #include "plugin-api.h"
78 #include "ipa-ref.h"
79 #include "cgraph.h"
80 #include "selftest.h"
82 #if CHECKING_P
84 namespace selftest {
86 /* Helper function for selftests of function-creation. */
88 static tree
89 make_fndecl (tree return_type,
90 const char *name,
91 vec <tree> &param_types,
92 bool is_variadic = false)
94 tree fn_type;
95 if (is_variadic)
96 fn_type = build_varargs_function_type_array (return_type,
97 param_types.length (),
98 param_types.address ());
99 else
100 fn_type = build_function_type_array (return_type,
101 param_types.length (),
102 param_types.address ());
103 /* FIXME: this uses input_location: */
104 tree fndecl = build_fn_decl (name, fn_type);
106 return fndecl;
109 /* Verify creating a function declaration equivalent to the following
110 int test_fndecl_int_void (void);
111 C declaration. */
113 static void
114 test_fndecl_int_void ()
116 auto_vec <tree> param_types;
117 const char *name = "test_fndecl_int_void";
118 tree fndecl = make_fndecl (integer_type_node,
119 name,
120 param_types);
121 ASSERT_TRUE (fndecl != NULL);
123 /* Verify name of decl. */
124 tree declname = DECL_NAME (fndecl);
125 ASSERT_TRUE (declname != NULL);
126 ASSERT_EQ (IDENTIFIER_NODE, TREE_CODE (declname));
127 /* We expect it to use a *copy* of the string we passed in. */
128 const char *identifier_ptr = IDENTIFIER_POINTER (declname);
129 ASSERT_NE (name, identifier_ptr);
130 ASSERT_EQ (0, strcmp ("test_fndecl_int_void", identifier_ptr));
132 /* Verify type of fndecl. */
133 ASSERT_EQ (FUNCTION_DECL, TREE_CODE (fndecl));
134 tree fntype = TREE_TYPE (fndecl);
135 ASSERT_EQ (FUNCTION_TYPE, TREE_CODE (fntype));
137 /* Verify return type. */
138 ASSERT_EQ (integer_type_node, TREE_TYPE (fntype));
140 /* Verify "void" args. */
141 tree argtypes = TYPE_ARG_TYPES (fntype);
142 ASSERT_EQ (TREE_LIST, TREE_CODE (argtypes));
143 ASSERT_EQ (void_type_node, TREE_VALUE (argtypes));
144 ASSERT_EQ (NULL, TREE_CHAIN (argtypes));
147 /* Verify creating a function declaration equivalent to the following
148 float test_fndecl_float_intchar (int, char);
149 C declaration. */
151 static void
152 test_fndecl_float_intchar ()
154 auto_vec <tree> param_types;
155 param_types.safe_push (integer_type_node);
156 param_types.safe_push (char_type_node);
157 const char *name = "test_fndecl_float_intchar";
158 tree fndecl = make_fndecl (float_type_node,
159 name,
160 param_types);
161 ASSERT_TRUE (fndecl != NULL);
163 /* Verify name of decl. */
164 tree declname = DECL_NAME (fndecl);
165 ASSERT_TRUE (declname != NULL);
166 ASSERT_EQ (IDENTIFIER_NODE, TREE_CODE (declname));
167 /* We expect it to use a *copy* of the string we passed in. */
168 const char *identifier_ptr = IDENTIFIER_POINTER (declname);
169 ASSERT_NE (name, identifier_ptr);
170 ASSERT_EQ (0, strcmp (name, identifier_ptr));
172 /* Verify type of fndecl. */
173 ASSERT_EQ (FUNCTION_DECL, TREE_CODE (fndecl));
174 tree fntype = TREE_TYPE (fndecl);
175 ASSERT_EQ (FUNCTION_TYPE, TREE_CODE (fntype));
177 /* Verify return type. */
178 ASSERT_EQ (float_type_node, TREE_TYPE (fntype));
180 /* Verify "(int, char)" args. */
181 tree arg0 = TYPE_ARG_TYPES (fntype);
182 ASSERT_EQ (TREE_LIST, TREE_CODE (arg0));
183 ASSERT_EQ (integer_type_node, TREE_VALUE (arg0));
184 tree arg1 = TREE_CHAIN (arg0);
185 ASSERT_TRUE (arg1 != NULL);
186 ASSERT_EQ (TREE_LIST, TREE_CODE (arg1));
187 ASSERT_EQ (char_type_node, TREE_VALUE (arg1));
188 tree argterm = TREE_CHAIN (arg1);
189 ASSERT_TRUE (argterm != NULL);
190 ASSERT_EQ (TREE_LIST, TREE_CODE (argterm));
191 ASSERT_EQ (void_type_node, TREE_VALUE (argterm));
192 ASSERT_EQ (NULL, TREE_CHAIN (argterm));
195 /* The test cases using these helper functions take a trivial function:
197 int test_fn (void) { return 42; }
199 and test various conversions done to it:
201 - gimplification
202 - construction of the CFG
203 - conversion to SSA form
204 - expansion to RTL form
206 In avoid having one overlong test case, this is broken
207 up into separate test cases for each stage, with helper functions
208 to minimize code duplication.
210 Another approach would be to attempt to directly construct a function
211 in the appropriate representation at each stage, though presumably
212 that would exhibit different kinds of failure compared to this
213 approach. */
215 /* Construct this function:
216 int test_fn (void) { return 42; }
217 in generic tree form. Return the fndecl. */
219 static tree
220 build_trivial_generic_function ()
222 auto_vec <tree> param_types;
223 tree fndecl = make_fndecl (integer_type_node,
224 "test_fn",
225 param_types);
226 ASSERT_TRUE (fndecl != NULL);
228 /* Populate the function. */
229 tree retval = build_decl (UNKNOWN_LOCATION, RESULT_DECL,
230 NULL_TREE, integer_type_node);
231 DECL_ARTIFICIAL (retval) = 1;
232 DECL_IGNORED_P (retval) = 1;
233 DECL_RESULT (fndecl) = retval;
235 /* Create a BIND_EXPR, and within it, a statement list. */
236 tree stmt_list = alloc_stmt_list ();
237 tree_stmt_iterator stmt_iter = tsi_start (stmt_list);
238 tree block = make_node (BLOCK);
239 tree bind_expr
240 = build3 (BIND_EXPR, void_type_node, NULL, stmt_list, block);
242 tree modify_retval = build2 (MODIFY_EXPR,
243 integer_type_node,
244 retval,
245 build_int_cst (integer_type_node, 42));
246 tree return_stmt = build1 (RETURN_EXPR,
247 integer_type_node,
248 modify_retval);
249 tsi_link_after (&stmt_iter, return_stmt, TSI_CONTINUE_LINKING);
251 DECL_INITIAL (fndecl) = block;
252 BLOCK_SUPERCONTEXT (block) = fndecl;
254 /* how to add to function? the following appears to be how to
255 set the body of a fndecl: */
256 DECL_SAVED_TREE(fndecl) = bind_expr;
258 /* Ensure that locals appear in the debuginfo. */
259 BLOCK_VARS (block) = BIND_EXPR_VARS (bind_expr);
261 return fndecl;
264 /* Construct this function:
265 int test_fn (void) { return 42; }
266 in "high gimple" form. Return the fndecl. */
268 static tree
269 build_trivial_high_gimple_function ()
271 /* Construct a trivial function, and gimplify it: */
272 tree fndecl = build_trivial_generic_function ();
273 gimplify_function_tree (fndecl);
274 return fndecl;
277 /* Build a CFG for a function in gimple form. */
279 static void
280 build_cfg (tree fndecl)
282 function *fun = DECL_STRUCT_FUNCTION (fndecl);
283 ASSERT_TRUE (fun != NULL);
284 ASSERT_EQ (fndecl, fun->decl);
286 /* We first have to lower control flow; for our trivial test function
287 this gives us:
288 test_fn ()
290 D.56 = 42;
291 goto <D.57>;
292 <D.57>:
293 return D.56;
296 gimple_opt_pass *lower_cf_pass = make_pass_lower_cf (g);
297 push_cfun (fun);
298 lower_cf_pass->execute (fun);
299 pop_cfun ();
300 delete lower_cf_pass;
302 /* We can now convert to CFG form; for our trivial test function this
303 gives us:
304 test_fn ()
306 <bb 2>:
307 D.56 = 42;
308 return D.56;
311 gimple_opt_pass *build_cfg_pass = make_pass_build_cfg (g);
312 push_cfun (fun);
313 build_cfg_pass->execute (fun);
314 pop_cfun ();
315 delete build_cfg_pass;
318 /* Convert a gimple+CFG function to SSA form. */
320 static void
321 convert_to_ssa (tree fndecl)
323 function *fun = DECL_STRUCT_FUNCTION (fndecl);
324 ASSERT_TRUE (fun != NULL);
325 ASSERT_EQ (fndecl, fun->decl);
327 gimple_opt_pass *build_ssa_pass = make_pass_build_ssa (g);
328 push_cfun (fun);
329 build_ssa_pass->execute (fun);
330 pop_cfun ();
331 delete build_ssa_pass;
334 /* Assuming we have a simple 3-block CFG like this:
335 [ENTRY] -> [block2] -> [EXIT]
336 get the "real" basic block (block 2). */
338 static basic_block
339 get_real_block (function *fun)
341 ASSERT_TRUE (fun->cfg != NULL);
342 ASSERT_EQ (3, n_basic_blocks_for_fn (fun));
343 basic_block bb2 = (*fun->cfg->x_basic_block_info)[2];
344 ASSERT_TRUE (bb2 != NULL);
345 return bb2;
348 /* Verify that we have a simple 3-block CFG: the two "fake" ones, and
349 a "real" one:
350 [ENTRY] -> [block2] -> [EXIT]. */
352 static void
353 verify_three_block_cfg (function *fun)
355 ASSERT_TRUE (fun->cfg != NULL);
356 ASSERT_EQ (3, n_basic_blocks_for_fn (fun));
357 ASSERT_EQ (2, n_edges_for_fn (fun));
359 /* The "fake" basic blocks. */
360 basic_block entry = ENTRY_BLOCK_PTR_FOR_FN (fun);
361 ASSERT_TRUE (entry != NULL);
362 ASSERT_EQ (ENTRY_BLOCK, entry->index);
364 basic_block exit = EXIT_BLOCK_PTR_FOR_FN (fun);
365 ASSERT_TRUE (exit != NULL);
366 ASSERT_EQ (EXIT_BLOCK, exit->index);
368 /* The "real" basic block. */
369 basic_block bb2 = get_real_block (fun);
370 ASSERT_TRUE (bb2 != NULL);
371 ASSERT_EQ (2, bb2->index);
373 /* Verify connectivity. */
374 ASSERT_EQ (NULL, entry->preds);
375 ASSERT_EQ (1, entry->succs->length ());
377 edge from_entry_to_bb2 = (*entry->succs)[0];
378 ASSERT_EQ (entry, from_entry_to_bb2->src);
379 ASSERT_EQ (bb2, from_entry_to_bb2->dest);
381 ASSERT_EQ (1, bb2->preds->length ());
382 ASSERT_EQ (from_entry_to_bb2, (*bb2->preds)[0]);
383 ASSERT_EQ (1, bb2->succs->length ());
385 edge from_bb2_to_exit = (*bb2->succs)[0];
386 ASSERT_EQ (bb2, from_bb2_to_exit->src);
387 ASSERT_EQ (exit, from_bb2_to_exit->dest);
389 ASSERT_EQ (1, exit->preds->length ());
390 ASSERT_EQ (from_bb2_to_exit, (*exit->preds)[0]);
391 ASSERT_EQ (NULL, exit->succs);
394 /* As above, but additionally verify the gimple statements are sane. */
396 static void
397 verify_three_block_gimple_cfg (function *fun)
399 verify_three_block_cfg (fun);
401 /* The "fake" basic blocks should be flagged as gimple, but with have no
402 statements. */
403 basic_block entry = ENTRY_BLOCK_PTR_FOR_FN (fun);
404 ASSERT_TRUE (entry != NULL);
405 ASSERT_EQ (0, entry->flags & BB_RTL);
406 ASSERT_EQ (NULL, bb_seq (entry));
408 basic_block exit = EXIT_BLOCK_PTR_FOR_FN (fun);
409 ASSERT_TRUE (exit != NULL);
410 ASSERT_EQ (0, entry->flags & BB_RTL);
411 ASSERT_EQ (NULL, bb_seq (exit));
413 /* The "real" basic block should be flagged as gimple, and have one
414 or more statements. */
415 basic_block bb2 = get_real_block (fun);
416 ASSERT_TRUE (bb2 != NULL);
417 ASSERT_EQ (0, entry->flags & BB_RTL);
418 ASSERT_TRUE (bb_seq (bb2) != NULL);
421 /* As above, but additionally verify the RTL insns are sane. */
423 static void
424 verify_three_block_rtl_cfg (function *fun)
426 verify_three_block_cfg (fun);
428 /* The "fake" basic blocks should be flagged as RTL, but with no
429 insns. */
430 basic_block entry = ENTRY_BLOCK_PTR_FOR_FN (fun);
431 ASSERT_TRUE (entry != NULL);
432 ASSERT_EQ (BB_RTL, entry->flags & BB_RTL);
433 ASSERT_EQ (NULL, BB_HEAD (entry));
435 basic_block exit = EXIT_BLOCK_PTR_FOR_FN (fun);
436 ASSERT_TRUE (exit != NULL);
437 ASSERT_EQ (BB_RTL, exit->flags & BB_RTL);
438 ASSERT_EQ (NULL, BB_HEAD (exit));
440 /* The "real" basic block should be flagged as RTL, and have one
441 or more insns. */
442 basic_block bb2 = get_real_block (fun);
443 ASSERT_TRUE (bb2 != NULL);
444 ASSERT_EQ (BB_RTL, bb2->flags & BB_RTL);
445 ASSERT_TRUE (BB_HEAD (bb2) != NULL);
448 /* Test converting our trivial function:
449 int test_fn (void) { return 42; }
450 to gimple form. */
452 static void
453 test_gimplification ()
455 tree fndecl = build_trivial_generic_function ();
457 /* Convert to gimple: */
458 gimplify_function_tree (fndecl);
460 /* Verify that we got gimple out of it. */
462 /* The function is now in GIMPLE form but the CFG has not been
463 built yet. */
465 /* We should have a struct function for the decl. */
466 function *fun = DECL_STRUCT_FUNCTION (fndecl);
467 ASSERT_TRUE (fun != NULL);
468 ASSERT_EQ (fndecl, fun->decl);
470 /* We expect a GIMPLE_BIND, with two gimple statements within it:
471 tmp = 42;
472 return tmp; */
474 gimple_seq seq_fn_body = gimple_body (fndecl);
475 ASSERT_TRUE (seq_fn_body != NULL);
476 gimple *bind_stmt = gimple_seq_first_stmt (seq_fn_body);
477 ASSERT_EQ (GIMPLE_BIND, gimple_code (bind_stmt));
478 ASSERT_EQ (NULL, bind_stmt->next);
480 gimple_seq seq_bind_body = gimple_bind_body (as_a <gbind *> (bind_stmt));
482 /* Verify that we have the 2 statements we expect. */
483 ASSERT_TRUE (seq_bind_body != NULL);
484 gimple *stmt1 = gimple_seq_first_stmt (seq_bind_body);
485 ASSERT_TRUE (stmt1 != NULL);
486 ASSERT_EQ (GIMPLE_ASSIGN, gimple_code (stmt1));
487 gimple *stmt2 = stmt1->next;
488 ASSERT_TRUE (stmt2 != NULL);
489 ASSERT_EQ (stmt1, stmt2->prev);
490 ASSERT_EQ (GIMPLE_RETURN, gimple_code (stmt2));
493 /* Test of building a CFG for a function in high gimple form. */
495 static void
496 test_building_cfg ()
498 /* Construct a trivial function, and gimplify it: */
499 tree fndecl = build_trivial_high_gimple_function ();
500 function *fun = DECL_STRUCT_FUNCTION (fndecl);
501 ASSERT_TRUE (fun != NULL);
503 /* Build a CFG. */
504 build_cfg (fndecl);
506 /* The CFG-building code constructs a 4-block cfg (with
507 ENTRY and EXIT):
508 test_fn ()
510 <bb 2>:
511 D.65 = 42;
513 <bb 3>:
514 return D.65;
516 and then ought to merge blocks 2 and 3 in cleanup_tree_cfg.
518 Hence we should end up with a simple 3-block cfg, the two "fake" ones,
519 and a "real" one:
520 [ENTRY] -> [block2] -> [EXIT]
521 with code like this:
522 test_fn ()
524 <bb 2>:
525 D.56 = 42;
526 return D.56;
529 verify_three_block_gimple_cfg (fun);
531 /* Verify the statements within the "real" block. */
532 basic_block bb2 = get_real_block (fun);
533 gimple *stmt_a = gimple_seq_first_stmt (bb_seq (bb2));
534 ASSERT_EQ (GIMPLE_ASSIGN, gimple_code (stmt_a));
535 gimple *stmt_b = stmt_a->next;
536 ASSERT_EQ (GIMPLE_RETURN, gimple_code (stmt_b));
537 ASSERT_EQ (NULL, stmt_b->next);
540 /* Test of conversion of gimple to SSA form. */
542 static void
543 test_conversion_to_ssa ()
545 /* As above, construct a trivial function, gimplify it, and build a CFG: */
546 tree fndecl = build_trivial_high_gimple_function ();
547 function *fun = DECL_STRUCT_FUNCTION (fndecl);
548 ASSERT_TRUE (fun != NULL);
549 build_cfg (fndecl);
551 convert_to_ssa (fndecl);
553 verify_three_block_gimple_cfg (fun);
555 /* For out trivial test function we should now have something like
556 this:
557 test_fn ()
559 <bb 2>:
560 _1 = 42;
561 return _1;
564 basic_block bb2 = get_real_block (fun);
565 gimple *stmt_a = gimple_seq_first_stmt (bb_seq (bb2));
566 ASSERT_EQ (GIMPLE_ASSIGN, gimple_code (stmt_a));
568 gimple *stmt_b = stmt_a->next;
569 ASSERT_EQ (GIMPLE_RETURN, gimple_code (stmt_b));
570 ASSERT_EQ (NULL, stmt_b->next);
572 greturn *return_stmt = as_a <greturn *> (stmt_b);
573 ASSERT_EQ (SSA_NAME, TREE_CODE (gimple_return_retval (return_stmt)));
576 /* Test of expansion from gimple-ssa to RTL. */
578 static void
579 test_expansion_to_rtl ()
581 /* As above, construct a trivial function, gimplify it, build a CFG,
582 and convert to SSA: */
583 tree fndecl = build_trivial_high_gimple_function ();
584 function *fun = DECL_STRUCT_FUNCTION (fndecl);
585 ASSERT_TRUE (fun != NULL);
586 build_cfg (fndecl);
587 convert_to_ssa (fndecl);
589 /* We need a cgraph_node for it. */
590 cgraph_node::get_create (fndecl);
591 /* Normally, cgraph_node::expand () would call
592 init_function_start (and a bunch of other stuff),
593 and invoke the expand pass, but it also runs
594 all of the other passes. So just do the minimum
595 needed to get from gimple-SSA to RTL. */
596 rtl_opt_pass *expand_pass = make_pass_expand (g);
597 push_cfun (fun);
598 init_function_start (fndecl);
599 expand_pass->execute (fun);
600 pop_cfun ();
601 delete expand_pass;
603 /* On x86_64, I get this:
604 (note 3 1 2 2 [bb 2] NOTE_INSN_BASIC_BLOCK)
605 (note 2 3 5 2 NOTE_INSN_FUNCTION_BEG)
606 (insn 5 2 6 2 (set (reg:SI 87 [ D.59 ])
607 (const_int 42 [0x2a])) -1 (nil))
608 (insn 6 5 10 2 (set (reg:SI 88 [ <retval> ])
609 (reg:SI 87 [ D.59 ])) -1 (nil))
610 (insn 10 6 11 2 (set (reg/i:SI 0 ax)
611 (reg:SI 88 [ <retval> ])) -1 (nil))
612 (insn 11 10 0 2 (use (reg/i:SI 0 ax)) -1 (nil))
614 On cr16-elf I get this:
615 (note 4 1 2 2 [bb 2] NOTE_INSN_BASIC_BLOCK)
616 (insn 2 4 3 2 (set (reg:SI 24)
617 (reg/f:SI 16 virtual-incoming-args)) -1
618 (nil))
619 (note 3 2 6 2 NOTE_INSN_FUNCTION_BEG)
620 (insn 6 3 7 2 (set (reg:HI 22 [ _1 ])
621 (const_int 42 [0x2a])) -1
622 (nil))
623 (insn 7 6 11 2 (set (reg:HI 23 [ <retval> ])
624 (reg:HI 22 [ _1 ])) -1
625 (nil))
626 (insn 11 7 12 2 (set (reg/i:HI 0 r0)
627 (reg:HI 23 [ <retval> ])) -1
628 (nil))
629 (insn 12 11 0 2 (use (reg/i:HI 0 r0)) -1
630 (nil)). */
631 verify_three_block_rtl_cfg (fun);
633 /* Verify as much of the RTL as we can whilst avoiding
634 target-specific behavior. */
635 basic_block bb2 = get_real_block (fun);
637 /* Expect a NOTE_INSN_BASIC_BLOCK... */
638 rtx_insn *insn = BB_HEAD (bb2);
639 ASSERT_TRUE (insn != NULL);
640 ASSERT_EQ (NOTE, insn->code);
641 ASSERT_EQ (NOTE_INSN_BASIC_BLOCK, NOTE_KIND (insn));
642 ASSERT_EQ (bb2, NOTE_BASIC_BLOCK (insn));
644 /* ...etc; any further checks are likely to over-specify things
645 and run us into target dependencies. */
648 /* Run all of the selftests within this file. */
650 void
651 function_tests_c_tests ()
653 test_fndecl_int_void ();
654 test_fndecl_float_intchar ();
655 test_gimplification ();
656 test_building_cfg ();
657 test_conversion_to_ssa ();
658 test_expansion_to_rtl ();
661 } // namespace selftest
663 #endif /* #if CHECKING_P */