3 * File name: ir/tr/trvrfy.c
4 * Purpose: Check types and entities for correctness.
5 * Author: Michael Beck, Goetz Lindenmaier
9 * Copyright: (c) 2003 Universität Karlsruhe
10 * Licence: This file protected by GPL - GNU GENERAL PUBLIC LICENSE.
17 #include "irgraph_t.h" /* for checking whether constant code is allocated
24 static const char *firm_vrfy_failure_msg;
28 * in RELEASE mode, returns ret if the expression expr evaluates to zero
29 * in ASSERT mode, asserts the expression expr (and the string string).
31 #define ASSERT_AND_RET(expr, string, ret) if (!(expr)) return (ret)
34 * in RELEASE mode, returns ret if the expression expr evaluates to zero
35 * in ASSERT mode, executes blk if the expression expr evaluates to zero and asserts expr
37 #define ASSERT_AND_RET_DBG(expr, string, ret, blk) if (!(expr)) return (ret)
39 #define ASSERT_AND_RET(expr, string, ret) \
41 if (opt_do_node_verification == FIRM_VERIFICATION_ON) {\
42 assert((expr) && string); } \
44 if (opt_do_node_verification == FIRM_VERIFICATION_REPORT) \
45 fprintf(stderr, #expr " : " string "\n"); \
46 firm_vrfy_failure_msg = #expr " && " string; \
51 #define ASSERT_AND_RET_DBG(expr, string, ret, blk) \
54 firm_vrfy_failure_msg = #expr " && " string; \
55 if (opt_do_node_verification != FIRM_VERIFICATION_ERROR_ONLY) { blk; } \
56 if (opt_do_node_verification == FIRM_VERIFICATION_REPORT) \
57 fprintf(stderr, #expr " : " string "\n"); \
58 else if (opt_do_node_verification == FIRM_VERIFICATION_ON) { \
59 assert((expr) && string); \
68 * Show diagnostic if an entity overwrites another one not
69 * in direct superclasses.
71 static void show_ent_not_supertp(entity *ent, entity *ovw)
73 ir_type *owner = get_entity_owner(ent);
74 ir_type *ov_own = get_entity_owner(ovw);
77 fprintf(stderr, "Type verification error:\n");
78 ir_fprintf(stderr, "Entity %+F::%+e owerwrites ", owner, ent);
79 ir_fprintf(stderr, "Entity %+F::%+e\n", ov_own, ovw);
81 ir_fprintf(stderr, "Supertypes of %+F:\n", owner);
82 for (i = 0; i < get_class_n_supertypes(owner); ++i) {
83 ir_type *super = get_class_supertype(owner, i);
84 ir_fprintf(stderr, " %+F:\n", super);
89 * Show diagnostic if an entity owerwrites a wrong number of things.
91 static void show_ent_overwrite_cnt(entity *ent)
93 ir_type *owner = get_entity_owner(ent);
94 int i, j, k, found, show_stp = 0;
96 fprintf(stderr, "Type verification error:\n");
97 ir_fprintf(stderr, "Entity %+F::%+e owerwrites\n", owner, ent);
98 for (i = 0; i < get_entity_n_overwrites(ent); ++i) {
99 entity *ovw = get_entity_overwrites(ent, i);
100 ir_type *ov_own = get_entity_owner(ovw);
102 for (k = 0; k < i; ++k)
103 if (ovw == get_entity_overwrites(ent, k)) {
104 ir_fprintf(stderr, " %+F::%+e entered more than once\n", ov_own, ovw);
109 for (j = get_class_n_supertypes(owner) - 1; j >= 0; --j) {
110 if (ov_own == get_class_supertype(owner, j)) {
111 show_stp = found = 1;
116 ir_fprintf(stderr, " %+F::%+e not in super types of %t\n", ov_own, ovw, owner);
120 ir_fprintf(stderr, "Supertypes of %+F:\n", owner);
121 for (i = 0; i < get_class_n_supertypes(owner); ++i) {
122 ir_type *super = get_class_supertype(owner, i);
123 ir_fprintf(stderr, " %+F:\n", super);
131 static int check_class(ir_type *tp) {
135 /*printf("\n"); DDMT(tp);*/
137 for (i = get_class_n_members(tp) - 1; i >= 0; --i) {
138 entity *mem = get_class_member(tp, i);
141 tp == get_entity_owner(mem),
142 "class member with wrong owner",
143 error_ent_wrong_owner,
144 ir_fprintf(stderr, "Type verification error:\n%+F %+e(owner %+F)\n",tp, mem, get_entity_owner(mem))
148 "NULL members not allowed",
150 ir_fprintf(stderr, "Type verification error:\n%+F member %d is NULL\n", tp, i)
154 get_entity_n_overwrites(mem) <= get_class_n_supertypes(tp),
155 "wrong number of entity overwrites",
156 error_wrong_ent_overwrites,
157 show_ent_overwrite_cnt(mem)
160 for (j = get_entity_n_overwrites(mem) - 1; j >= 0; --j) {
161 entity *ovw = get_entity_overwrites(mem, j);
162 /*printf(" overwrites: "); DDME(ovw);*/
163 /* Check whether ovw is member of one of tp's supertypes. If so,
164 the representation is correct. */
166 for (k = get_class_n_supertypes(tp) - 1; k >= 0; --k) {
167 if (get_class_member_index(get_class_supertype(tp, k), ovw) >= 0) {
174 "overwrites an entity not contained in direct supertype",
176 show_ent_not_supertp(mem, ovw)
186 static int check_array(ir_type *tp) {
187 int i, n_dim = get_array_n_dimensions(tp);
188 for (i = 0; i < n_dim; ++i) {
190 has_array_lower_bound(tp, i) || has_array_upper_bound(tp, i),
191 "array bound missing",
193 ir_fprintf(stderr, "%+F in dimension %d\n", tp, i)
203 static int check_primitive(ir_type *tp) {
205 is_mode(get_type_mode(tp)),
206 "Primitive type without mode",
208 ir_fprintf(stderr, "%+F\n", tp)
218 * 0 if no error encountered
220 int check_type(ir_type *tp) {
221 switch (get_type_tpop_code(tp)) {
223 return check_class(tp);
225 return check_array(tp);
227 return check_primitive(tp);
234 * checks the visited flag
236 static int check_visited_flag(ir_graph *irg, ir_node *n) {
238 get_irn_visited(n) <= get_irg_visited(irg),
239 "Visited flag of node is larger than that of corresponding irg.",
241 ir_fprintf(stderr, "%+F in %+F\n", n, irg)
247 * helper environment struct for constant_on_wrong_obstack()
255 * called by the walker
257 static void on_irg_storage(ir_node *n, void *env) {
258 struct myenv *myenv = env;
260 /* We also test whether the setting of the visited flag is legal. */
261 myenv->res = node_is_in_irgs_storage(myenv->irg, n) &&
262 check_visited_flag(myenv->irg, n);
266 * checks whether a given constant IR node is NOT on the
269 static int constant_on_wrong_irg(ir_node *n) {
272 env.res = 1; /* on right obstack */
273 env.irg = get_const_code_irg();
275 irg_walk(n, on_irg_storage, NULL, (void *)&env);
280 * Check if constants node are NOT on the constant IR graph.
282 * @return NON-zero if an entity initializer constant is NOT on
283 * the current_ir_graph's obstack.
285 static int constants_on_wrong_irg(entity *ent) {
286 if (get_entity_variability(ent) == variability_uninitialized) return 0;
288 if (is_compound_entity(ent)) {
290 for (i = 0; i < get_compound_ent_n_values(ent); i++) {
291 if (constant_on_wrong_irg(get_compound_ent_value(ent, i)))
295 /* Might not be set if entity belongs to a description or is external allocated. */
296 if (get_atomic_ent_value(ent))
297 return constant_on_wrong_irg(get_atomic_ent_value(ent));
298 else if (get_entity_visibility(ent) != visibility_external_allocated) {
300 is_Class_type(get_entity_owner(ent)) &&
301 get_class_peculiarity(get_entity_owner(ent)) == peculiarity_description,
302 "Value in constant atomic entity not set.",
304 ir_fprintf(stderr, "%+e, owner %+F\n", ent, get_entity_owner(ent))
312 * Shows a wrong entity allocation
314 static void show_ent_alloc_error(entity *ent)
316 ir_fprintf(stderr, "%+e owner %t has allocation %s\n",
317 ent, get_entity_type(ent),
318 get_allocation_name(get_entity_allocation(ent)));
322 * Check an entity. Currently, we check only if initialized constants
323 * are build on the const irg graph.
326 * 0 if no error encountered
327 * != 0 a trvrfy_error_codes code
329 int check_entity(entity *ent) {
331 ir_type *tp = get_entity_type(ent);
332 ir_type *owner = get_entity_owner(ent);
334 current_ir_graph = get_const_code_irg();
336 constants_on_wrong_irg(ent) == 0,
337 "Contants placed on wrong IRG",
338 error_const_on_wrong_irg,
339 ir_fprintf(stderr, "%+e not on %+F\n", ent, current_ir_graph));
341 rem_vpi = get_visit_pseudo_irgs();
342 set_visit_pseudo_irgs(1);
343 if ((get_entity_peculiarity(ent) == peculiarity_existent) &&
344 (get_entity_visibility(ent) != visibility_external_allocated) &&
345 (is_Method_type(get_entity_type(ent))) &&
346 (!get_entity_irg(ent) || !(is_ir_graph(get_entity_irg(ent))))) {
349 "Method ents with pec_exist must have an irg",
350 error_existent_entity_without_irg,
351 ir_fprintf(stderr, "%+e\n", ent)
354 set_visit_pseudo_irgs(rem_vpi);
356 /* Originally, this test assumed, that only method entities have
357 pecularity_inherited. As I changed this, I have to test for method type before
359 if (get_entity_peculiarity(ent) == peculiarity_inherited) {
360 if (is_Method_type(get_entity_type(ent))) {
361 entity *impl = get_SymConst_entity(get_atomic_ent_value(ent));
363 get_entity_peculiarity(impl) == peculiarity_existent,
364 "inherited method entities must have constant pointing to existent entity.",
365 error_inherited_ent_without_const,
366 ir_fprintf(stderr, "%+e points to %+e\n", ent, impl)
371 /* Entities in global type are not dynamic or automatic allocated. */
372 if (owner == get_glob_type()) {
374 get_entity_allocation(ent) != allocation_dynamic &&
375 get_entity_allocation(ent) != allocation_automatic,
376 "Entities in global type are not allowed to by dynamic or automatic allocated",
377 error_glob_ent_allocation,
378 show_ent_alloc_error(ent)
382 if (get_entity_variability(ent) != variability_uninitialized) {
383 if (is_atomic_type(tp)) {
384 ir_node *val = get_atomic_ent_value(ent);
387 get_irn_mode(val) == get_type_mode(tp),
388 "Mode of constant in entity must match type.",
389 error_ent_const_mode,
390 ir_fprintf(stderr, "%+e const %+F, type %+F(%+F)\n",
391 ent, val, tp, get_type_mode(tp))
399 * check types and entities
401 static void check_tore(type_or_ent *tore, void *env) {
405 *res = check_type((ir_type *)tore);
407 assert(is_entity(tore));
408 *res = check_entity((entity *)tore);
413 * Verify types and entities.
418 type_walk(check_tore, NULL, &res);