2 * Copyright (C) 1995-2011 University of Karlsruhe. All right reserved.
4 * This file is part of libFirm.
6 * This file may be distributed and/or modified under the terms of the
7 * GNU General Public License version 2 as published by the Free Software
8 * Foundation and appearing in the file LICENSE.GPL included in the
9 * packaging of this file.
11 * Licensees holding valid libFirm Professional Edition licenses may use
12 * this file in accordance with the libFirm Commercial License.
13 * Agreement provided with the Software.
15 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
16 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21 * @file tr_inheritance.c
22 * @brief Check types and entities for correctness.
24 * @author Michael Beck, Goetz Lindenmaier
29 #include "irgraph_t.h"
38 * in RELEASE mode, returns ret if the expression expr evaluates to zero
39 * in ASSERT mode, asserts the expression expr (and the string string).
41 #define ASSERT_AND_RET(expr, string, ret) if (!(expr)) return (ret)
44 * in RELEASE mode, returns ret if the expression expr evaluates to zero
45 * in ASSERT mode, executes blk if the expression expr evaluates to zero and asserts expr
47 #define ASSERT_AND_RET_DBG(expr, string, ret, blk) if (!(expr)) return (ret)
49 #define ASSERT_AND_RET(expr, string, ret) \
51 if (opt_do_node_verification == FIRM_VERIFICATION_ON) {\
52 assert((expr) && string); } \
54 if (opt_do_node_verification == FIRM_VERIFICATION_REPORT) \
55 fprintf(stderr, #expr " : " string "\n"); \
56 firm_verify_failure_msg = #expr " && " string; \
61 #define ASSERT_AND_RET_DBG(expr, string, ret, blk) \
64 firm_verify_failure_msg = #expr " && " string; \
65 if (opt_do_node_verification != FIRM_VERIFICATION_ERROR_ONLY) { blk; } \
66 if (opt_do_node_verification == FIRM_VERIFICATION_REPORT) \
67 fprintf(stderr, #expr " : " string "\n"); \
68 else if (opt_do_node_verification == FIRM_VERIFICATION_ON) { \
69 assert((expr) && string); \
79 static const char *firm_verify_failure_msg;
82 * Show diagnostic if an entity overwrites another one not
83 * in direct superclasses.
85 static void show_ent_not_supertp(ir_entity *ent, ir_entity *ovw)
87 ir_type *owner = get_entity_owner(ent);
88 ir_type *ov_own = get_entity_owner(ovw);
91 fprintf(stderr, "Type verification error:\n");
92 ir_fprintf(stderr, "Entity %+F::%+e owerwrites ", owner, ent);
93 ir_fprintf(stderr, "Entity %+F::%+e\n", ov_own, ovw);
95 ir_fprintf(stderr, "Supertypes of %+F:\n", owner);
96 for (i = 0; i < get_class_n_supertypes(owner); ++i) {
97 ir_type *super = get_class_supertype(owner, i);
98 ir_fprintf(stderr, " %+F:\n", super);
103 * Show diagnostic if an entity overwrites a wrong number of things.
105 static void show_ent_overwrite_cnt(ir_entity *ent)
107 ir_type *owner = get_entity_owner(ent);
112 bool show_stp = false;
114 fprintf(stderr, "Type verification error:\n");
115 ir_fprintf(stderr, "Entity %t::%e owerwrites\n", owner, ent);
116 for (i = 0; i < get_entity_n_overwrites(ent); ++i) {
117 ir_entity *ovw = get_entity_overwrites(ent, i);
118 ir_type *ov_own = get_entity_owner(ovw);
119 size_t n_supertypes = get_class_n_supertypes(owner);
121 ir_fprintf(stderr, " %t::%e\n", ov_own, ovw);
122 for (k = 0; k < i; ++k) {
123 if (ovw == get_entity_overwrites(ent, k)) {
124 ir_fprintf(stderr, " ->%t::%e entered more than once\n", ov_own, ovw);
130 for (j = 0; j < n_supertypes; ++j) {
131 if (ov_own == get_class_supertype(owner, j)) {
132 show_stp = found = true;
137 ir_fprintf(stderr, " ->%t not in super types of %t\n", ov_own, owner);
141 ir_fprintf(stderr, "Supertypes of %t:\n", owner);
142 for (i = 0; i < get_class_n_supertypes(owner); ++i) {
143 ir_type *super = get_class_supertype(owner, i);
144 ir_fprintf(stderr, " %t:\n", super);
149 #endif /* #ifndef NDEBUG */
154 static int check_class(ir_type *tp)
158 for (i = 0, n = get_class_n_members(tp); i < n; ++i) {
159 ir_entity *mem = get_class_member(tp, i);
162 tp == get_entity_owner(mem),
163 "class member with wrong owner",
164 error_ent_wrong_owner,
165 ir_fprintf(stderr, "Type verification error:\n%+F %+e(owner %+F)\n",tp, mem, get_entity_owner(mem))
169 "NULL members not allowed",
171 ir_fprintf(stderr, "Type verification error:\n%+F member %zu is NULL\n", tp, i)
175 get_entity_n_overwrites(mem) <= get_class_n_supertypes(tp),
176 "wrong number of entity overwrites",
177 error_wrong_ent_overwrites,
178 show_ent_overwrite_cnt(mem)
183 /* check if the overwrite relation is flat, i.e. every overwrite
184 * is visible in every direct superclass. */
185 for (j = 0, m = get_entity_n_overwrites(mem); j < m; ++j) {
186 ir_entity *ovw = get_entity_overwrites(mem, j);
189 /* Check whether ovw is member of one of tp's supertypes. If so,
190 the representation is correct. */
191 for (k = 0, n_super = get_class_n_supertypes(tp); k < n_super; ++k) {
192 if (get_class_member_index(get_class_supertype(tp, k), ovw) != INVALID_MEMBER_INDEX) {
195 "overwrites an entity not contained in direct supertype",
197 show_ent_not_supertp(mem, ovw)
211 static int check_array(const ir_type *tp)
213 size_t i, n_dim = get_array_n_dimensions(tp);
215 for (i = 0; i < n_dim; ++i) {
217 has_array_lower_bound(tp, i) || has_array_upper_bound(tp, i),
218 "array bound missing",
220 ir_fprintf(stderr, "%+F in dimension %zu\n", tp, i)
230 static int check_primitive(ir_type *tp)
233 is_mode(get_type_mode(tp)),
234 "Primitive type without mode",
236 ir_fprintf(stderr, "%+F\n", tp)
246 * 0 if no error encountered
248 int check_type(ir_type *tp)
250 switch (get_type_tpop_code(tp)) {
252 return check_class(tp);
254 return check_array(tp);
256 return check_primitive(tp);
263 * checks the visited flag
265 static int check_visited_flag(ir_graph *irg, ir_node *n)
268 get_irn_visited(n) <= get_irg_visited(irg),
269 "Visited flag of node is larger than that of corresponding irg.",
271 ir_fprintf(stderr, "%+F in %+F\n", n, irg)
277 * helper environment struct for constant_on_wrong_obstack()
279 typedef struct myenv {
285 * called by the walker
287 static void on_irg_storage(ir_node *n, void *data)
289 myenv *env = (myenv*)data;
291 /* We also test whether the setting of the visited flag is legal. */
292 env->res = node_is_in_irgs_storage(env->irg, n) &&
293 check_visited_flag(env->irg, n);
297 * checks whether a given constant IR node is NOT on the
300 static int constant_on_wrong_irg(ir_node *n)
304 env.res = 1; /* on right obstack */
305 env.irg = get_const_code_irg();
307 irg_walk(n, on_irg_storage, NULL, (void *)&env);
311 static int initializer_constant_on_wrong_irg(ir_initializer_t *initializer)
313 switch (get_initializer_kind(initializer)) {
314 case IR_INITIALIZER_NULL:
316 case IR_INITIALIZER_TARVAL:
318 case IR_INITIALIZER_CONST:
319 return constant_on_wrong_irg(get_initializer_const_value(initializer));
320 case IR_INITIALIZER_COMPOUND: {
321 size_t i, n = get_initializer_compound_n_entries(initializer);
322 for (i = 0; i < n; ++i) {
323 ir_initializer_t *sub
324 = get_initializer_compound_value(initializer, i);
325 if (initializer_constant_on_wrong_irg(sub))
331 panic("invalid initializer in initializer_on_wrong_irg");
335 * Check if constants node are NOT on the constant IR graph.
337 * @return NON-zero if an entity initializer constant is NOT on
338 * the current_ir_graph's obstack.
340 static int constants_on_wrong_irg(ir_entity *ent)
342 if (ent->initializer != NULL) {
343 return initializer_constant_on_wrong_irg(ent->initializer);
344 } else if (entity_has_compound_ent_values(ent)) {
346 for (i = 0, n = get_compound_ent_n_values(ent); i < n; ++i) {
347 if (constant_on_wrong_irg(get_compound_ent_value(ent, i)))
355 * Check an entity. Currently, we check only if initialized constants
356 * are build on the const irg graph.
359 * 0 if no error encountered
360 * != 0 a trverify_error_codes code
362 int check_entity(ir_entity *ent)
364 ir_type *tp = get_entity_type(ent);
366 current_ir_graph = get_const_code_irg();
368 constants_on_wrong_irg(ent) == 0,
369 "Contants placed on wrong IRG",
370 error_const_on_wrong_irg,
371 ir_fprintf(stderr, "%+e not on %+F\n", ent, current_ir_graph)
374 /* Originally, this test assumed, that only method entities have
375 pecularity_inherited. As I changed this, I have to test for method type
376 before doing the test. */
377 if (get_entity_peculiarity(ent) == peculiarity_existent
378 && is_method_entity(ent)) {
380 ir_entity *impl = get_SymConst_entity(get_atomic_ent_value(ent));
383 "inherited method entities must have constant pointing to existent entity.",
384 error_inherited_ent_without_const,
385 ir_fprintf(stderr, "%+e points to %+e\n", ent, impl)
389 if (is_atomic_entity(ent) && ent->initializer != NULL) {
390 ir_mode *mode = NULL;
391 ir_initializer_t *initializer = ent->initializer;
392 switch (initializer->kind) {
393 case IR_INITIALIZER_CONST:
394 mode = get_irn_mode(get_initializer_const_value(initializer));
396 case IR_INITIALIZER_TARVAL:
397 mode = get_tarval_mode(get_initializer_tarval_value(initializer));
399 case IR_INITIALIZER_NULL:
400 case IR_INITIALIZER_COMPOUND:
404 mode == NULL || mode == get_type_mode(tp),
405 "Mode of constant in entity must match type.",
406 error_ent_const_mode,
407 ir_fprintf(stderr, "%+e, type %+F(%+F)\n",
408 ent, tp, get_type_mode(tp))
415 * check types and entities
417 static void check_tore(type_or_ent tore, void *env)
419 int *res = (int*)env;
421 if (is_type(tore.typ)) {
422 *res = check_type(tore.typ);
424 assert(is_entity(tore.ent));
425 *res = check_entity(tore.ent);
430 * Verify types and entities.
434 static ident *empty = NULL;
436 ir_type *constructors;
437 ir_type *destructors;
438 ir_type *thread_locals;
443 empty = new_id_from_chars("", 0);
445 type_walk(check_tore, NULL, &res);
447 for (s = IR_SEGMENT_FIRST; s <= IR_SEGMENT_LAST; ++s) {
448 const ir_type *type = get_segment_type(s);
450 for (e = 0; e < get_compound_n_members(type); ++e) {
451 ir_entity *entity = get_compound_member(type, e);
452 ASSERT_AND_RET(get_entity_ld_ident(entity) != NULL ||
453 get_entity_visibility(entity) == ir_visibility_private,
454 "segment members must have a name or visibility_private",
459 constructors = get_segment_type(IR_SEGMENT_CONSTRUCTORS);
460 for (i = 0, n = get_compound_n_members(constructors); i < n; ++i) {
461 const ir_entity *entity = get_compound_member(constructors, i);
462 ASSERT_AND_RET(get_entity_linkage(entity) & IR_LINKAGE_HIDDEN_USER,
463 "entity without LINKAGE_HIDDEN_USER in constructors is pointless",
465 /* Mach-O doesn't like labels in this section */
466 ASSERT_AND_RET(get_entity_ld_ident(entity),
467 "entity in constructors should have ld_ident=''", 1);
469 destructors = get_segment_type(IR_SEGMENT_DESTRUCTORS);
470 for (i = 0, n = get_compound_n_members(destructors); i < n; ++i) {
471 const ir_entity *entity = get_compound_member(destructors, i);
472 ASSERT_AND_RET(get_entity_linkage(entity) & IR_LINKAGE_HIDDEN_USER,
473 "entity without LINKAGE_HIDDEN_USER in destructors is pointless",
475 /* Mach-O doesn't like labels in this section */
476 ASSERT_AND_RET(get_entity_ld_ident(entity),
477 "entity in destructors should have ld_ident=''", 1);
479 thread_locals = get_segment_type(IR_SEGMENT_THREAD_LOCAL);
480 for (i = 0, n = get_compound_n_members(thread_locals); i < n; ++i) {
481 const ir_entity *entity = get_compound_member(thread_locals, i);
482 /* this is odd and should not be allowed I think */
483 ASSERT_AND_RET(!is_method_entity(entity),
484 "method in THREAD_LOCAL segment", 1);
485 ASSERT_AND_RET(! (get_entity_linkage(entity) & IR_LINKAGE_CONSTANT),
486 "thread locals must not be constant", 1);