2 * Copyright (C) 1995-2007 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
32 #include "irgraph_t.h" /* for checking whether constant code is allocated
39 static const char *firm_vrfy_failure_msg;
43 * in RELEASE mode, returns ret if the expression expr evaluates to zero
44 * in ASSERT mode, asserts the expression expr (and the string string).
46 #define ASSERT_AND_RET(expr, string, ret) if (!(expr)) return (ret)
49 * in RELEASE mode, returns ret if the expression expr evaluates to zero
50 * in ASSERT mode, executes blk if the expression expr evaluates to zero and asserts expr
52 #define ASSERT_AND_RET_DBG(expr, string, ret, blk) if (!(expr)) return (ret)
54 #define ASSERT_AND_RET(expr, string, ret) \
56 if (opt_do_node_verification == FIRM_VERIFICATION_ON) {\
57 assert((expr) && string); } \
59 if (opt_do_node_verification == FIRM_VERIFICATION_REPORT) \
60 fprintf(stderr, #expr " : " string "\n"); \
61 firm_vrfy_failure_msg = #expr " && " string; \
66 #define ASSERT_AND_RET_DBG(expr, string, ret, blk) \
69 firm_vrfy_failure_msg = #expr " && " string; \
70 if (opt_do_node_verification != FIRM_VERIFICATION_ERROR_ONLY) { blk; } \
71 if (opt_do_node_verification == FIRM_VERIFICATION_REPORT) \
72 fprintf(stderr, #expr " : " string "\n"); \
73 else if (opt_do_node_verification == FIRM_VERIFICATION_ON) { \
74 assert((expr) && string); \
83 * Show diagnostic if an entity overwrites another one not
84 * in direct superclasses.
86 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) {
106 ir_type *owner = get_entity_owner(ent);
107 int i, j, k, found, show_stp = 0;
109 fprintf(stderr, "Type verification error:\n");
110 ir_fprintf(stderr, "Entity %t::%e owerwrites\n", owner, ent);
111 for (i = 0; i < get_entity_n_overwrites(ent); ++i) {
112 ir_entity *ovw = get_entity_overwrites(ent, i);
113 ir_type *ov_own = get_entity_owner(ovw);
115 ir_fprintf(stderr, " %t::%e\n", ov_own, ovw);
116 for (k = 0; k < i; ++k)
117 if (ovw == get_entity_overwrites(ent, k)) {
118 ir_fprintf(stderr, " ->%t::%e entered more than once\n", ov_own, ovw);
123 for (j = get_class_n_supertypes(owner) - 1; j >= 0; --j) {
124 if (ov_own == get_class_supertype(owner, j)) {
125 show_stp = found = 1;
130 ir_fprintf(stderr, " ->%t not in super types of %t\n", ov_own, owner);
134 ir_fprintf(stderr, "Supertypes of %t:\n", owner);
135 for (i = 0; i < get_class_n_supertypes(owner); ++i) {
136 ir_type *super = get_class_supertype(owner, i);
137 ir_fprintf(stderr, " %t:\n", super);
145 static int check_class(ir_type *tp) {
149 for (i = get_class_n_members(tp) - 1; i >= 0; --i) {
150 ir_entity *mem = get_class_member(tp, i);
153 tp == get_entity_owner(mem),
154 "class member with wrong owner",
155 error_ent_wrong_owner,
156 ir_fprintf(stderr, "Type verification error:\n%+F %+e(owner %+F)\n",tp, mem, get_entity_owner(mem))
160 "NULL members not allowed",
162 ir_fprintf(stderr, "Type verification error:\n%+F member %d is NULL\n", tp, i)
166 get_entity_n_overwrites(mem) <= get_class_n_supertypes(tp),
167 "wrong number of entity overwrites",
168 error_wrong_ent_overwrites,
169 show_ent_overwrite_cnt(mem)
172 for (j = get_entity_n_overwrites(mem) - 1; j >= 0; --j) {
173 ir_entity *ovw = get_entity_overwrites(mem, j);
174 /*printf(" overwrites: "); DDME(ovw);*/
175 /* Check whether ovw is member of one of tp's supertypes. If so,
176 the representation is correct. */
178 for (k = get_class_n_supertypes(tp) - 1; k >= 0; --k) {
179 if (get_class_member_index(get_class_supertype(tp, k), ovw) >= 0) {
186 "overwrites an entity not contained in direct supertype",
188 show_ent_not_supertp(mem, ovw)
198 static int check_array(ir_type *tp) {
199 int i, n_dim = get_array_n_dimensions(tp);
201 for (i = 0; i < n_dim; ++i) {
203 has_array_lower_bound(tp, i) || has_array_upper_bound(tp, i),
204 "array bound missing",
206 ir_fprintf(stderr, "%+F in dimension %d\n", tp, i)
216 static int check_primitive(ir_type *tp) {
218 is_mode(get_type_mode(tp)),
219 "Primitive type without mode",
221 ir_fprintf(stderr, "%+F\n", tp)
231 * 0 if no error encountered
233 int check_type(ir_type *tp) {
234 switch (get_type_tpop_code(tp)) {
236 return check_class(tp);
238 return check_array(tp);
240 return check_primitive(tp);
247 * checks the visited flag
249 static int check_visited_flag(ir_graph *irg, ir_node *n) {
251 get_irn_visited(n) <= get_irg_visited(irg),
252 "Visited flag of node is larger than that of corresponding irg.",
254 ir_fprintf(stderr, "%+F in %+F\n", n, irg)
260 * helper environment struct for constant_on_wrong_obstack()
268 * called by the walker
270 static void on_irg_storage(ir_node *n, void *env) {
271 struct myenv *myenv = env;
273 /* We also test whether the setting of the visited flag is legal. */
274 myenv->res = node_is_in_irgs_storage(myenv->irg, n) &&
275 check_visited_flag(myenv->irg, n);
279 * checks whether a given constant IR node is NOT on the
282 static int constant_on_wrong_irg(ir_node *n) {
285 env.res = 1; /* on right obstack */
286 env.irg = get_const_code_irg();
288 irg_walk(n, on_irg_storage, NULL, (void *)&env);
293 * Check if constants node are NOT on the constant IR graph.
295 * @return NON-zero if an entity initializer constant is NOT on
296 * the current_ir_graph's obstack.
298 static int constants_on_wrong_irg(ir_entity *ent) {
299 if (get_entity_variability(ent) == variability_uninitialized) return 0;
301 if (is_compound_entity(ent)) {
303 for (i = 0; i < get_compound_ent_n_values(ent); i++) {
304 if (constant_on_wrong_irg(get_compound_ent_value(ent, i)))
308 /* Might not be set if entity belongs to a description or is external allocated. */
309 if (get_atomic_ent_value(ent))
310 return constant_on_wrong_irg(get_atomic_ent_value(ent));
311 else if (get_entity_visibility(ent) != visibility_external_allocated) {
313 is_Class_type(get_entity_owner(ent)) &&
314 get_class_peculiarity(get_entity_owner(ent)) == peculiarity_description,
315 "Value in constant atomic entity not set.",
317 ir_fprintf(stderr, "%+e, owner %+F\n", ent, get_entity_owner(ent))
325 * Shows a wrong entity allocation
327 static void show_ent_alloc_error(ir_entity *ent) {
328 ir_fprintf(stderr, "%+e owner %t has allocation %s\n",
329 ent, get_entity_type(ent),
330 get_allocation_name(get_entity_allocation(ent)));
334 * Check an entity. Currently, we check only if initialized constants
335 * are build on the const irg graph.
338 * 0 if no error encountered
339 * != 0 a trvrfy_error_codes code
341 int check_entity(ir_entity *ent) {
343 ir_type *tp = get_entity_type(ent);
344 ir_type *owner = get_entity_owner(ent);
346 current_ir_graph = get_const_code_irg();
348 constants_on_wrong_irg(ent) == 0,
349 "Contants placed on wrong IRG",
350 error_const_on_wrong_irg,
351 ir_fprintf(stderr, "%+e not on %+F\n", ent, current_ir_graph)
354 rem_vpi = get_visit_pseudo_irgs();
355 set_visit_pseudo_irgs(1);
356 if ((get_entity_peculiarity(ent) == peculiarity_existent) &&
357 (get_entity_visibility(ent) != visibility_external_allocated) &&
358 (is_Method_type(get_entity_type(ent))) &&
359 (!get_entity_irg(ent) || !(is_ir_graph(get_entity_irg(ent))))) {
362 "Method ents with pec_exist must have an irg",
363 error_existent_entity_without_irg,
364 ir_fprintf(stderr, "%+e\n", ent)
367 set_visit_pseudo_irgs(rem_vpi);
369 /* Originally, this test assumed, that only method entities have
370 pecularity_inherited. As I changed this, I have to test for method type before
372 if (get_entity_peculiarity(ent) == peculiarity_inherited) {
373 if (is_Method_type(get_entity_type(ent))) {
374 ir_entity *impl = get_SymConst_entity(get_atomic_ent_value(ent));
376 get_entity_peculiarity(impl) == peculiarity_existent,
377 "inherited method entities must have constant pointing to existent entity.",
378 error_inherited_ent_without_const,
379 ir_fprintf(stderr, "%+e points to %+e\n", ent, impl)
384 /* Entities in global type are not dynamic or automatic allocated. */
385 if (owner == get_glob_type()) {
387 get_entity_allocation(ent) != allocation_dynamic &&
388 get_entity_allocation(ent) != allocation_automatic,
389 "Entities in global type are not allowed to by dynamic or automatic allocated",
390 error_glob_ent_allocation,
391 show_ent_alloc_error(ent)
395 if (get_entity_variability(ent) != variability_uninitialized) {
396 if (is_atomic_type(tp)) {
397 ir_node *val = get_atomic_ent_value(ent);
400 get_irn_mode(val) == get_type_mode(tp),
401 "Mode of constant in entity must match type.",
402 error_ent_const_mode,
403 ir_fprintf(stderr, "%+e const %+F, type %+F(%+F)\n",
404 ent, val, tp, get_type_mode(tp))
413 * check types and entities
415 static void check_tore(type_or_ent *tore, void *env) {
419 *res = check_type((ir_type *)tore);
421 assert(is_entity(tore));
422 *res = check_entity((ir_entity *)tore);
427 * Verify types and entities.
432 type_walk(check_tore, NULL, &res);