2 * Copyright (C) 1995-2008 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" /* for checking whether constant code is allocated
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_vrfy_failure_msg = #expr " && " string; \
61 #define ASSERT_AND_RET_DBG(expr, string, ret, blk) \
64 firm_vrfy_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_vrfy_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) {
86 ir_type *owner = get_entity_owner(ent);
87 ir_type *ov_own = get_entity_owner(ovw);
90 fprintf(stderr, "Type verification error:\n");
91 ir_fprintf(stderr, "Entity %+F::%+e owerwrites ", owner, ent);
92 ir_fprintf(stderr, "Entity %+F::%+e\n", ov_own, ovw);
94 ir_fprintf(stderr, "Supertypes of %+F:\n", owner);
95 for (i = 0; i < get_class_n_supertypes(owner); ++i) {
96 ir_type *super = get_class_supertype(owner, i);
97 ir_fprintf(stderr, " %+F:\n", super);
102 * Show diagnostic if an entity overwrites a wrong number of things.
104 static void show_ent_overwrite_cnt(ir_entity *ent) {
105 ir_type *owner = get_entity_owner(ent);
106 int i, j, k, found, show_stp = 0;
108 fprintf(stderr, "Type verification error:\n");
109 ir_fprintf(stderr, "Entity %t::%e owerwrites\n", owner, ent);
110 for (i = 0; i < get_entity_n_overwrites(ent); ++i) {
111 ir_entity *ovw = get_entity_overwrites(ent, i);
112 ir_type *ov_own = get_entity_owner(ovw);
114 ir_fprintf(stderr, " %t::%e\n", ov_own, ovw);
115 for (k = 0; k < i; ++k)
116 if (ovw == get_entity_overwrites(ent, k)) {
117 ir_fprintf(stderr, " ->%t::%e entered more than once\n", ov_own, ovw);
122 for (j = get_class_n_supertypes(owner) - 1; j >= 0; --j) {
123 if (ov_own == get_class_supertype(owner, j)) {
124 show_stp = found = 1;
129 ir_fprintf(stderr, " ->%t not in super types of %t\n", ov_own, owner);
133 ir_fprintf(stderr, "Supertypes of %t:\n", owner);
134 for (i = 0; i < get_class_n_supertypes(owner); ++i) {
135 ir_type *super = get_class_supertype(owner, i);
136 ir_fprintf(stderr, " %t:\n", super);
142 * Shows a wrong entity allocation
144 static void show_ent_alloc_error(ir_entity *ent) {
145 ir_fprintf(stderr, "%+e owner %t has allocation %s\n",
146 ent, get_entity_type(ent),
147 get_allocation_name(get_entity_allocation(ent)));
150 #endif /* #ifndef NDEBUG */
155 static int check_class(ir_type *tp) {
159 for (i = get_class_n_members(tp) - 1; i >= 0; --i) {
160 ir_entity *mem = get_class_member(tp, i);
163 tp == get_entity_owner(mem),
164 "class member with wrong owner",
165 error_ent_wrong_owner,
166 ir_fprintf(stderr, "Type verification error:\n%+F %+e(owner %+F)\n",tp, mem, get_entity_owner(mem))
170 "NULL members not allowed",
172 ir_fprintf(stderr, "Type verification error:\n%+F member %d is NULL\n", tp, i)
176 get_entity_n_overwrites(mem) <= get_class_n_supertypes(tp),
177 "wrong number of entity overwrites",
178 error_wrong_ent_overwrites,
179 show_ent_overwrite_cnt(mem)
182 for (j = get_entity_n_overwrites(mem) - 1; j >= 0; --j) {
183 ir_entity *ovw = get_entity_overwrites(mem, j);
184 /*printf(" overwrites: "); DDME(ovw);*/
185 /* Check whether ovw is member of one of tp's supertypes. If so,
186 the representation is correct. */
188 for (k = get_class_n_supertypes(tp) - 1; k >= 0; --k) {
189 if (get_class_member_index(get_class_supertype(tp, k), ovw) >= 0) {
196 "overwrites an entity not contained in direct supertype",
198 show_ent_not_supertp(mem, ovw)
208 static int check_array(ir_type *tp) {
209 int i, n_dim = get_array_n_dimensions(tp);
211 for (i = 0; i < n_dim; ++i) {
213 has_array_lower_bound(tp, i) || has_array_upper_bound(tp, i),
214 "array bound missing",
216 ir_fprintf(stderr, "%+F in dimension %d\n", tp, i)
226 static int check_primitive(ir_type *tp) {
228 is_mode(get_type_mode(tp)),
229 "Primitive type without mode",
231 ir_fprintf(stderr, "%+F\n", tp)
241 * 0 if no error encountered
243 int check_type(ir_type *tp) {
244 switch (get_type_tpop_code(tp)) {
246 return check_class(tp);
248 return check_array(tp);
250 return check_primitive(tp);
257 * checks the visited flag
259 static int check_visited_flag(ir_graph *irg, ir_node *n) {
261 get_irn_visited(n) <= get_irg_visited(irg),
262 "Visited flag of node is larger than that of corresponding irg.",
264 ir_fprintf(stderr, "%+F in %+F\n", n, irg)
270 * helper environment struct for constant_on_wrong_obstack()
278 * called by the walker
280 static void on_irg_storage(ir_node *n, void *env) {
281 struct myenv *myenv = env;
283 /* We also test whether the setting of the visited flag is legal. */
284 myenv->res = node_is_in_irgs_storage(myenv->irg, n) &&
285 check_visited_flag(myenv->irg, n);
289 * checks whether a given constant IR node is NOT on the
292 static int constant_on_wrong_irg(ir_node *n) {
295 env.res = 1; /* on right obstack */
296 env.irg = get_const_code_irg();
298 irg_walk(n, on_irg_storage, NULL, (void *)&env);
303 * Check if constants node are NOT on the constant IR graph.
305 * @return NON-zero if an entity initializer constant is NOT on
306 * the current_ir_graph's obstack.
308 static int constants_on_wrong_irg(ir_entity *ent) {
309 if (get_entity_variability(ent) == variability_uninitialized) return 0;
311 if (is_compound_entity(ent)) {
312 if(!ent->has_initializer) {
314 for (i = get_compound_ent_n_values(ent) - 1; i >= 0; --i) {
315 if (constant_on_wrong_irg(get_compound_ent_value(ent, i)))
320 /* Might not be set if entity belongs to a description or is external allocated. */
321 if (get_atomic_ent_value(ent))
322 return constant_on_wrong_irg(get_atomic_ent_value(ent));
323 else if (get_entity_visibility(ent) != visibility_external_allocated) {
325 is_Class_type(get_entity_owner(ent)) &&
326 get_class_peculiarity(get_entity_owner(ent)) == peculiarity_description,
327 "Value in constant atomic entity not set.",
329 ir_fprintf(stderr, "%+e, owner %+F\n", ent, get_entity_owner(ent))
337 * Check an entity. Currently, we check only if initialized constants
338 * are build on the const irg graph.
341 * 0 if no error encountered
342 * != 0 a trvrfy_error_codes code
344 int check_entity(ir_entity *ent) {
346 ir_type *tp = get_entity_type(ent);
347 ir_type *owner = get_entity_owner(ent);
349 current_ir_graph = get_const_code_irg();
351 constants_on_wrong_irg(ent) == 0,
352 "Contants placed on wrong IRG",
353 error_const_on_wrong_irg,
354 ir_fprintf(stderr, "%+e not on %+F\n", ent, current_ir_graph)
357 rem_vpi = get_visit_pseudo_irgs();
358 set_visit_pseudo_irgs(1);
359 if ((get_entity_peculiarity(ent) == peculiarity_existent) &&
360 (get_entity_visibility(ent) != visibility_external_allocated) &&
361 (is_Method_type(get_entity_type(ent))) &&
362 (!get_entity_irg(ent) || !(is_ir_graph(get_entity_irg(ent))))) {
365 "Method ents with pec_exist must have an irg",
366 error_existent_entity_without_irg,
367 ir_fprintf(stderr, "%+e\n", ent)
370 set_visit_pseudo_irgs(rem_vpi);
372 /* Originally, this test assumed, that only method entities have
373 pecularity_inherited. As I changed this, I have to test for method type before
375 if (get_entity_peculiarity(ent) == peculiarity_inherited) {
376 if (is_Method_type(get_entity_type(ent))) {
377 ir_entity *impl = get_SymConst_entity(get_atomic_ent_value(ent));
379 get_entity_peculiarity(impl) == peculiarity_existent,
380 "inherited method entities must have constant pointing to existent entity.",
381 error_inherited_ent_without_const,
382 ir_fprintf(stderr, "%+e points to %+e\n", ent, impl)
387 /* Entities in global type are not dynamic or automatic allocated. */
388 if (owner == get_glob_type()) {
390 get_entity_allocation(ent) != allocation_dynamic &&
391 get_entity_allocation(ent) != allocation_automatic,
392 "Entities in global type are not allowed to by dynamic or automatic allocated",
393 error_glob_ent_allocation,
394 show_ent_alloc_error(ent)
398 if (get_entity_variability(ent) != variability_uninitialized) {
399 if (is_atomic_type(tp)) {
400 ir_node *val = get_atomic_ent_value(ent);
403 get_irn_mode(val) == get_type_mode(tp),
404 "Mode of constant in entity must match type.",
405 error_ent_const_mode,
406 ir_fprintf(stderr, "%+e const %+F, type %+F(%+F)\n",
407 ent, val, tp, get_type_mode(tp))
416 * check types and entities
418 static void check_tore(type_or_ent tore, void *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.
435 type_walk(check_tore, NULL, &res);