Debian Codegraph @

gc/backgraph.c

raw
1 /*
2 * Copyright (c) 2001 by Hewlett-Packard Company. All rights reserved.
3 *
4 * THIS MATERIAL IS PROVIDED AS IS, WITH ABSOLUTELY NO WARRANTY EXPRESSED
5 * OR IMPLIED. ANY USE IS AT YOUR OWN RISK.
6 *
7 * Permission is hereby granted to use or copy this program
8 * for any purpose, provided the above notices are retained on all copies.
9 * Permission to modify the code and to distribute modified code is granted,
10 * provided the above notices are retained, and a notice that the code was
11 * modified is included with the above copyright notice.
12 *
13 */
14
15 #include "private/dbg_mlc.h"
16
17 /*
18 * This implements a full, though not well-tuned, representation of the
19 * backwards points-to graph. This is used to test for non-GC-robust
20 * data structures; the code is not used during normal garbage collection.
21 *
22 * One restriction is that we drop all back-edges from nodes with very
23 * high in-degree, and simply add them add them to a list of such
24 * nodes. They are then treated as permanent roots. If this by itself
25 * doesn't introduce a space leak, then such nodes can't contribute to
26 * a growing space leak.
27 */
28
29 #ifdef MAKE_BACK_GRAPH
30
31 #define MAX_IN 10 /* Maximum in-degree we handle directly */
32
33 /* #include <unistd.h> */
34
35 #if (!defined(DBG_HDRS_ALL) || (ALIGNMENT != CPP_WORDSZ/8) \
36 /* || !defined(UNIX_LIKE) */) && !defined(CPPCHECK)
37 # error The configuration does not support MAKE_BACK_GRAPH
38 #endif
39
40 /* We store single back pointers directly in the object's oh_bg_ptr field. */
41 /* If there is more than one ptr to an object, we store q | FLAG_MANY, */
42 /* where q is a pointer to a back_edges object. */
43 /* Every once in a while we use a back_edges object even for a single */
44 /* pointer, since we need the other fields in the back_edges structure to */
45 /* be present in some fraction of the objects. Otherwise we get serious */
46 /* performance issues. */
47 #define FLAG_MANY 2
48
49 typedef struct back_edges_struct {
50 word n_edges; /* Number of edges, including those in continuation */
51 /* structures. */
52 unsigned short flags;
53 # define RETAIN 1 /* Directly points to a reachable object; */
54 /* retain for next GC. */
55 unsigned short height_gc_no;
56 /* If height > 0, then the GC_gc_no value when it */
57 /* was computed. If it was computed this cycle, then */
58 /* it is current. If it was computed during the */
59 /* last cycle, then it represents the old height, */
60 /* which is only saved for live objects referenced by */
61 /* dead ones. This may grow due to refs from newly */
62 /* dead objects. */
63 signed_word height;
64 /* Longest path through unreachable nodes to this node */
65 /* that we found using depth first search. */
66 # define HEIGHT_UNKNOWN (-2)
67 # define HEIGHT_IN_PROGRESS (-1)
68
69 ptr_t edges[MAX_IN];
70 struct back_edges_struct *cont;
71 /* Pointer to continuation structure; we use only the */
72 /* edges field in the continuation. */
73 /* also used as free list link. */
74 } back_edges;
75
76 /* Allocate a new back edge structure. Should be more sophisticated */
77 /* if this were production code. */
78 #define MAX_BACK_EDGE_STRUCTS 100000
79 static back_edges *back_edge_space = 0;
80 STATIC int GC_n_back_edge_structs = 0;
81 /* Serves as pointer to never used */
82 /* back_edges space. */
83 static back_edges *avail_back_edges = 0;
84 /* Pointer to free list of deallocated */
85 /* back_edges structures. */
86
87 static back_edges * new_back_edges(void)
88 {
89 if (0 == back_edge_space) {
90 size_t bytes_to_get = ROUNDUP_PAGESIZE_IF_MMAP(MAX_BACK_EDGE_STRUCTS
91 * sizeof(back_edges));
92
93 GC_ASSERT(GC_page_size != 0);
94 back_edge_space = (back_edges *)GET_MEM(bytes_to_get);
95 if (NULL == back_edge_space)
96 ABORT("Insufficient memory for back edges");
97 GC_add_to_our_memory((ptr_t)back_edge_space, bytes_to_get);
98 }
99 if (0 != avail_back_edges) {
100 back_edges * result = avail_back_edges;
101 avail_back_edges = result -> cont;
102 result -> cont = 0;
103 return result;
104 }
105 if (GC_n_back_edge_structs >= MAX_BACK_EDGE_STRUCTS - 1) {
106 ABORT("Needed too much space for back edges: adjust "
107 "MAX_BACK_EDGE_STRUCTS");
108 }
109 return back_edge_space + (GC_n_back_edge_structs++);
110 }
111
112 /* Deallocate p and its associated continuation structures. */
113 static void deallocate_back_edges(back_edges *p)
114 {
115 back_edges *last = p;
116
117 while (0 != last -> cont) last = last -> cont;
118 last -> cont = avail_back_edges;
119 avail_back_edges = p;
120 }
121
122 /* Table of objects that are currently on the depth-first search */
123 /* stack. Only objects with in-degree one are in this table. */
124 /* Other objects are identified using HEIGHT_IN_PROGRESS. */
125 /* FIXME: This data structure NEEDS IMPROVEMENT. */
126 #define INITIAL_IN_PROGRESS 10000
127 static ptr_t * in_progress_space = 0;
128 static size_t in_progress_size = 0;
129 static size_t n_in_progress = 0;
130
131 static void push_in_progress(ptr_t p)
132 {
133 if (n_in_progress >= in_progress_size) {
134 ptr_t * new_in_progress_space;
135
136 GC_ASSERT(GC_page_size != 0);
137 if (NULL == in_progress_space) {
138 in_progress_size = ROUNDUP_PAGESIZE_IF_MMAP(INITIAL_IN_PROGRESS
139 * sizeof(ptr_t))
140 / sizeof(ptr_t);
141 new_in_progress_space =
142 (ptr_t *)GET_MEM(in_progress_size * sizeof(ptr_t));
143 } else {
144 in_progress_size *= 2;
145 new_in_progress_space = (ptr_t *)
146 GET_MEM(in_progress_size * sizeof(ptr_t));
147 if (new_in_progress_space != NULL)
148 BCOPY(in_progress_space, new_in_progress_space,
149 n_in_progress * sizeof(ptr_t));
150 }
151 if (EXPECT(new_in_progress_space != NULL, TRUE))
152 GC_add_to_our_memory((ptr_t)new_in_progress_space,
153 in_progress_size * sizeof(ptr_t));
154 # ifndef GWW_VDB
155 GC_scratch_recycle_no_gww(in_progress_space,
156 n_in_progress * sizeof(ptr_t));
157 # elif defined(LINT2)
158 /* TODO: implement GWW-aware recycling as in alloc_mark_stack */
159 GC_noop1((word)in_progress_space);
160 # endif
161 in_progress_space = new_in_progress_space;
162 }
163 if (in_progress_space == 0)
164 ABORT("MAKE_BACK_GRAPH: Out of in-progress space: "
165 "Huge linear data structure?");
166 in_progress_space[n_in_progress++] = p;
167 }
168
169 static GC_bool is_in_progress(ptr_t p)
170 {
171 size_t i;
172 for (i = 0; i < n_in_progress; ++i) {
173 if (in_progress_space[i] == p) return TRUE;
174 }
175 return FALSE;
176 }
177
178 GC_INLINE void pop_in_progress(ptr_t p GC_ATTR_UNUSED)
179 {
180 --n_in_progress;
181 GC_ASSERT(in_progress_space[n_in_progress] == p);
182 }
183
184 #define GET_OH_BG_PTR(p) \
185 (ptr_t)GC_REVEAL_POINTER(((oh *)(p)) -> oh_bg_ptr)
186 #define SET_OH_BG_PTR(p,q) (((oh *)(p)) -> oh_bg_ptr = GC_HIDE_POINTER(q))
187
188 /* Ensure that p has a back_edges structure associated with it. */
189 static void ensure_struct(ptr_t p)
190 {
191 ptr_t old_back_ptr = GET_OH_BG_PTR(p);
192
193 if (!((word)old_back_ptr & FLAG_MANY)) {
194 back_edges *be = new_back_edges();
195 be -> flags = 0;
196 if (0 == old_back_ptr) {
197 be -> n_edges = 0;
198 } else {
199 be -> n_edges = 1;
200 be -> edges[0] = old_back_ptr;
201 }
202 be -> height = HEIGHT_UNKNOWN;
203 be -> height_gc_no = (unsigned short)(GC_gc_no - 1);
204 GC_ASSERT((word)be >= (word)back_edge_space);
205 SET_OH_BG_PTR(p, (word)be | FLAG_MANY);
206 }
207 }
208
209 /* Add the (forward) edge from p to q to the backward graph. Both p */
210 /* q are pointers to the object base, i.e. pointers to an oh. */
211 static void add_edge(ptr_t p, ptr_t q)
212 {
213 ptr_t pred = GET_OH_BG_PTR(q);
214 back_edges * be, *be_cont;
215 word i;
216
217 GC_ASSERT(p == GC_base(p) && q == GC_base(q));
218 if (!GC_HAS_DEBUG_INFO(q) || !GC_HAS_DEBUG_INFO(p)) {
219 /* This is really a misinterpreted free list link, since we saw */
220 /* a pointer to a free list. Don't overwrite it! */
221 return;
222 }
223 if (NULL == pred) {
224 static unsigned random_number = 13;
225 # define GOT_LUCKY_NUMBER (((++random_number) & 0x7f) == 0)
226 /* A not very random number we use to occasionally allocate a */
227 /* back_edges structure even for a single backward edge. This */
228 /* prevents us from repeatedly tracing back through very long */
229 /* chains, since we will have some place to store height and */
230 /* in_progress flags along the way. */
231
232 SET_OH_BG_PTR(q, p);
233 if (GOT_LUCKY_NUMBER) ensure_struct(q);
234 return;
235 }
236
237 /* Check whether it was already in the list of predecessors. */
238 {
239 back_edges *e = (back_edges *)((word)pred & ~(word)FLAG_MANY);
240 word n_edges;
241 word total;
242 int local = 0;
243
244 if (((word)pred & FLAG_MANY) != 0) {
245 n_edges = e -> n_edges;
246 } else if (((word)COVERT_DATAFLOW(pred) & 1) == 0) {
247 /* A misinterpreted freelist link. */
248 n_edges = 1;
249 local = -1;
250 } else {
251 n_edges = 0;
252 }
253 for (total = 0; total < n_edges; ++total) {
254 if (local == MAX_IN) {
255 e = e -> cont;
256 local = 0;
257 }
258 if (local >= 0)
259 pred = e -> edges[local++];
260 if (pred == p)
261 return;
262 }
263 }
264
265 ensure_struct(q);
266 be = (back_edges *)((word)GET_OH_BG_PTR(q) & ~(word)FLAG_MANY);
267 for (i = be -> n_edges, be_cont = be; i > MAX_IN; i -= MAX_IN)
268 be_cont = be_cont -> cont;
269 if (i == MAX_IN) {
270 be_cont -> cont = new_back_edges();
271 be_cont = be_cont -> cont;
272 i = 0;
273 }
274 be_cont -> edges[i] = p;
275 be -> n_edges++;
276 # ifdef DEBUG_PRINT_BIG_N_EDGES
277 if (GC_print_stats == VERBOSE && be -> n_edges == 100) {
278 GC_err_printf("The following object has big in-degree:\n");
279 GC_print_heap_obj(q);
280 }
281 # endif
282 }
283
284 typedef void (*per_object_func)(ptr_t p, size_t n_bytes, word gc_descr);
285
286 static void per_object_helper(struct hblk *h, word fn)
287 {
288 hdr * hhdr = HDR(h);
289 size_t sz = (size_t)hhdr->hb_sz;
290 word descr = hhdr -> hb_descr;
291 per_object_func f = (per_object_func)fn;
292 size_t i = 0;
293
294 do {
295 f((ptr_t)(h -> hb_body + i), sz, descr);
296 i += sz;
297 } while (i + sz <= HBLKSIZE);
298 }
299
300 GC_INLINE void GC_apply_to_each_object(per_object_func f)
301 {
302 GC_apply_to_all_blocks(per_object_helper, (word)f);
303 }
304
305 static void reset_back_edge(ptr_t p, size_t n_bytes GC_ATTR_UNUSED,
306 word gc_descr GC_ATTR_UNUSED)
307 {
308 /* Skip any free list links, or dropped blocks */
309 if (GC_HAS_DEBUG_INFO(p)) {
310 ptr_t old_back_ptr = GET_OH_BG_PTR(p);
311 if ((word)old_back_ptr & FLAG_MANY) {
312 back_edges *be = (back_edges *)((word)old_back_ptr & ~(word)FLAG_MANY);
313 if (!(be -> flags & RETAIN)) {
314 deallocate_back_edges(be);
315 SET_OH_BG_PTR(p, 0);
316 } else {
317
318 GC_ASSERT(GC_is_marked(p));
319
320 /* Back edges may point to objects that will not be retained. */
321 /* Delete them for now, but remember the height. */
322 /* Some will be added back at next GC. */
323 be -> n_edges = 0;
324 if (0 != be -> cont) {
325 deallocate_back_edges(be -> cont);
326 be -> cont = 0;
327 }
328
329 GC_ASSERT(GC_is_marked(p));
330
331 /* We only retain things for one GC cycle at a time. */
332 be -> flags &= ~RETAIN;
333 }
334 } else /* Simple back pointer */ {
335 /* Clear to avoid dangling pointer. */
336 SET_OH_BG_PTR(p, 0);
337 }
338 }
339 }
340
341 static void add_back_edges(ptr_t p, size_t n_bytes, word gc_descr)
342 {
343 word *currentp = (word *)(p + sizeof(oh));
344
345 /* For now, fix up non-length descriptors conservatively. */
346 if((gc_descr & GC_DS_TAGS) != GC_DS_LENGTH) {
347 gc_descr = n_bytes;
348 }
349 while ((word)currentp < (word)(p + gc_descr)) {
350 word current = *currentp++;
351 FIXUP_POINTER(current);
352 if (current >= (word)GC_least_plausible_heap_addr &&
353 current <= (word)GC_greatest_plausible_heap_addr) {
354 ptr_t target = (ptr_t)GC_base((void *)current);
355 if (0 != target) {
356 add_edge(p, target);
357 }
358 }
359 }
360 }
361
362 /* Rebuild the representation of the backward reachability graph. */
363 /* Does not examine mark bits. Can be called before GC. */
364 GC_INNER void GC_build_back_graph(void)
365 {
366 GC_ASSERT(I_HOLD_LOCK());
367 GC_apply_to_each_object(add_back_edges);
368 }
369
370 /* Return an approximation to the length of the longest simple path */
371 /* through unreachable objects to p. We refer to this as the height */
372 /* of p. */
373 static word backwards_height(ptr_t p)
374 {
375 word result;
376 ptr_t pred = GET_OH_BG_PTR(p);
377 back_edges *be;
378
379 if (NULL == pred)
380 return 1;
381 if (((word)pred & FLAG_MANY) == 0) {
382 if (is_in_progress(p)) return 0; /* DFS back edge, i.e. we followed */
383 /* an edge to an object already */
384 /* on our stack: ignore */
385 push_in_progress(p);
386 result = backwards_height(pred) + 1;
387 pop_in_progress(p);
388 return result;
389 }
390 be = (back_edges *)((word)pred & ~(word)FLAG_MANY);
391 if (be -> height >= 0 && be -> height_gc_no == (unsigned short)GC_gc_no)
392 return be -> height;
393 /* Ignore back edges in DFS */
394 if (be -> height == HEIGHT_IN_PROGRESS) return 0;
395 result = (be -> height > 0? be -> height : 1);
396 be -> height = HEIGHT_IN_PROGRESS;
397
398 {
399 back_edges *e = be;
400 word n_edges;
401 word total;
402 int local = 0;
403
404 if (((word)pred & FLAG_MANY) != 0) {
405 n_edges = e -> n_edges;
406 } else if (((word)pred & 1) == 0) {
407 /* A misinterpreted freelist link. */
408 n_edges = 1;
409 local = -1;
410 } else {
411 n_edges = 0;
412 }
413 for (total = 0; total < n_edges; ++total) {
414 word this_height;
415 if (local == MAX_IN) {
416 e = e -> cont;
417 local = 0;
418 }
419 if (local >= 0)
420 pred = e -> edges[local++];
421
422 /* Execute the following once for each predecessor pred of p */
423 /* in the points-to graph. */
424 if (GC_is_marked(pred) && ((word)GET_OH_BG_PTR(p) & FLAG_MANY) == 0) {
425 GC_COND_LOG_PRINTF("Found bogus pointer from %p to %p\n",
426 (void *)pred, (void *)p);
427 /* Reachable object "points to" unreachable one. */
428 /* Could be caused by our lax treatment of GC descriptors. */
429 this_height = 1;
430 } else {
431 this_height = backwards_height(pred);
432 }
433 if (this_height >= result)
434 result = this_height + 1;
435 }
436 }
437
438 be -> height = result;
439 be -> height_gc_no = (unsigned short)GC_gc_no;
440 return result;
441 }
442
443 STATIC word GC_max_height = 0;
444 STATIC ptr_t GC_deepest_obj = NULL;
445
446 /* Compute the maximum height of every unreachable predecessor p of a */
447 /* reachable object. Arrange to save the heights of all such objects p */
448 /* so that they can be used in calculating the height of objects in the */
449 /* next GC. */
450 /* Set GC_max_height to be the maximum height we encounter, and */
451 /* GC_deepest_obj to be the corresponding object. */
452 static void update_max_height(ptr_t p, size_t n_bytes GC_ATTR_UNUSED,
453 word gc_descr GC_ATTR_UNUSED)
454 {
455 if (GC_is_marked(p) && GC_HAS_DEBUG_INFO(p)) {
456 word p_height = 0;
457 ptr_t p_deepest_obj = 0;
458 ptr_t back_ptr;
459 back_edges *be = 0;
460
461 /* If we remembered a height last time, use it as a minimum. */
462 /* It may have increased due to newly unreachable chains pointing */
463 /* to p, but it can't have decreased. */
464 back_ptr = GET_OH_BG_PTR(p);
465 if (0 != back_ptr && ((word)back_ptr & FLAG_MANY)) {
466 be = (back_edges *)((word)back_ptr & ~(word)FLAG_MANY);
467 if (be -> height != HEIGHT_UNKNOWN) p_height = be -> height;
468 }
469
470 {
471 ptr_t pred = GET_OH_BG_PTR(p);
472 back_edges *e = (back_edges *)((word)pred & ~(word)FLAG_MANY);
473 word n_edges;
474 word total;
475 int local = 0;
476
477 if (((word)pred & FLAG_MANY) != 0) {
478 n_edges = e -> n_edges;
479 } else if (pred != NULL && ((word)pred & 1) == 0) {
480 /* A misinterpreted freelist link. */
481 n_edges = 1;
482 local = -1;
483 } else {
484 n_edges = 0;
485 }
486 for (total = 0; total < n_edges; ++total) {
487 if (local == MAX_IN) {
488 e = e -> cont;
489 local = 0;
490 }
491 if (local >= 0)
492 pred = e -> edges[local++];
493
494 /* Execute the following once for each predecessor pred of p */
495 /* in the points-to graph. */
496 if (!GC_is_marked(pred) && GC_HAS_DEBUG_INFO(pred)) {
497 word this_height = backwards_height(pred);
498 if (this_height > p_height) {
499 p_height = this_height;
500 p_deepest_obj = pred;
501 }
502 }
503 }
504 }
505
506 if (p_height > 0) {
507 /* Remember the height for next time. */
508 if (be == 0) {
509 ensure_struct(p);
510 back_ptr = GET_OH_BG_PTR(p);
511 be = (back_edges *)((word)back_ptr & ~(word)FLAG_MANY);
512 }
513 be -> flags |= RETAIN;
514 be -> height = p_height;
515 be -> height_gc_no = (unsigned short)GC_gc_no;
516 }
517 if (p_height > GC_max_height) {
518 GC_max_height = p_height;
519 GC_deepest_obj = p_deepest_obj;
520 }
521 }
522 }
523
524 STATIC word GC_max_max_height = 0;
525
526 GC_INNER void GC_traverse_back_graph(void)
527 {
528 GC_ASSERT(I_HOLD_LOCK());
529 GC_max_height = 0;
530 GC_apply_to_each_object(update_max_height);
531 if (0 != GC_deepest_obj)
532 GC_set_mark_bit(GC_deepest_obj); /* Keep it until we can print it. */
533 }
534
535 void GC_print_back_graph_stats(void)
536 {
537 GC_ASSERT(I_HOLD_LOCK());
538 GC_printf("Maximum backwards height of reachable objects"
539 " at GC #%lu is %lu\n",
540 (unsigned long)GC_gc_no, (unsigned long)GC_max_height);
541 if (GC_max_height > GC_max_max_height) {
542 ptr_t obj = GC_deepest_obj;
543
544 GC_max_max_height = GC_max_height;
545 UNLOCK();
546 GC_err_printf(
547 "The following unreachable object is last in a longest chain "
548 "of unreachable objects:\n");
549 GC_print_heap_obj(obj);
550 LOCK();
551 }
552 GC_COND_LOG_PRINTF("Needed max total of %d back-edge structs\n",
553 GC_n_back_edge_structs);
554 GC_apply_to_each_object(reset_back_edge);
555 GC_deepest_obj = 0;
556 }
557
558 #endif /* MAKE_BACK_GRAPH */