Merge pull request #5714 from alexischr/update_bockbuild
[mono.git] / libgc / mark_rts.c
1 /* 
2  * Copyright 1988, 1989 Hans-J. Boehm, Alan J. Demers
3  * Copyright (c) 1991-1994 by Xerox Corporation.  All rights reserved.
4  *
5  * THIS MATERIAL IS PROVIDED AS IS, WITH ABSOLUTELY NO WARRANTY EXPRESSED
6  * OR IMPLIED.  ANY USE IS AT YOUR OWN RISK.
7  *
8  * Permission is hereby granted to use or copy this program
9  * for any purpose,  provided the above notices are retained on all copies.
10  * Permission to modify the code and to distribute modified code is granted,
11  * provided the above notices are retained, and a notice that the code was
12  * modified is included with the above copyright notice.
13  */
14 # include <stdio.h>
15 # include "private/gc_priv.h"
16
17 /* Data structure for list of root sets.                                */
18 /* We keep a hash table, so that we can filter out duplicate additions. */
19 /* Under Win32, we need to do a better job of filtering overlaps, so    */
20 /* we resort to sequential search, and pay the price.                   */
21 /* This is really declared in gc_priv.h:
22 struct roots {
23         ptr_t r_start;
24         ptr_t r_end;
25  #      if !defined(MSWIN32) && !defined(MSWINCE)
26           struct roots * r_next;
27  #      endif
28         GC_bool r_tmp;
29                 -- Delete before registering new dynamic libraries
30 };
31
32 struct roots GC_static_roots[MAX_ROOT_SETS];
33 */
34
35 int GC_no_dls = 0;      /* Register dynamic library data segments.      */
36
37 static int n_root_sets = 0;
38
39         /* GC_static_roots[0..n_root_sets) contains the valid root sets. */
40
41 # if !defined(NO_DEBUGGING)
42 /* For debugging:       */
43 void GC_print_static_roots()
44 {
45     register int i;
46     size_t total = 0;
47     
48     for (i = 0; i < n_root_sets; i++) {
49         GC_printf2("From 0x%lx to 0x%lx ",
50                    (unsigned long) GC_static_roots[i].r_start,
51                    (unsigned long) GC_static_roots[i].r_end);
52         if (GC_static_roots[i].r_tmp) {
53             GC_printf0(" (temporary)\n");
54         } else {
55             GC_printf0("\n");
56         }
57         total += GC_static_roots[i].r_end - GC_static_roots[i].r_start;
58     }
59     GC_printf1("Total size: %ld\n", (unsigned long) total);
60     if (GC_root_size != total) {
61         GC_printf1("GC_root_size incorrect: %ld!!\n",
62                    (unsigned long) GC_root_size);
63     }
64 }
65 # endif /* NO_DEBUGGING */
66
67 /* Primarily for debugging support:     */
68 /* Is the address p in one of the registered static                     */
69 /* root sections?                                                       */
70 GC_bool GC_is_static_root(p)
71 ptr_t p;
72 {
73     static int last_root_set = MAX_ROOT_SETS;
74     register int i;
75     
76     
77     if (last_root_set < n_root_sets
78         && p >= GC_static_roots[last_root_set].r_start
79         && p < GC_static_roots[last_root_set].r_end) return(TRUE);
80     for (i = 0; i < n_root_sets; i++) {
81         if (p >= GC_static_roots[i].r_start
82             && p < GC_static_roots[i].r_end) {
83             last_root_set = i;
84             return(TRUE);
85         }
86     }
87     return(FALSE);
88 }
89
90 #if !defined(MSWIN32) && !defined(MSWINCE)
91 /* 
92 #   define LOG_RT_SIZE 6
93 #   define RT_SIZE (1 << LOG_RT_SIZE)  -- Power of 2, may be != MAX_ROOT_SETS
94
95     struct roots * GC_root_index[RT_SIZE];
96         -- Hash table header.  Used only to check whether a range is
97         -- already present.
98         -- really defined in gc_priv.h
99 */
100
101 static int rt_hash(addr)
102 char * addr;
103 {
104     word result = (word) addr;
105 #   if CPP_WORDSZ > 8*LOG_RT_SIZE
106         result ^= result >> 8*LOG_RT_SIZE;
107 #   endif
108 #   if CPP_WORDSZ > 4*LOG_RT_SIZE
109         result ^= result >> 4*LOG_RT_SIZE;
110 #   endif
111     result ^= result >> 2*LOG_RT_SIZE;
112     result ^= result >> LOG_RT_SIZE;
113     result &= (RT_SIZE-1);
114     return(result);
115 }
116
117 /* Is a range starting at b already in the table? If so return a        */
118 /* pointer to it, else NIL.                                             */
119 struct roots * GC_roots_present(b)
120 char *b;
121 {
122     register int h = rt_hash(b);
123     register struct roots *p = GC_root_index[h];
124     
125     while (p != 0) {
126         if (p -> r_start == (ptr_t)b) return(p);
127         p = p -> r_next;
128     }
129     return(FALSE);
130 }
131
132 /* Add the given root structure to the index. */
133 static void add_roots_to_index(p)
134 struct roots *p;
135 {
136     register int h = rt_hash(p -> r_start);
137     
138     p -> r_next = GC_root_index[h];
139     GC_root_index[h] = p;
140 }
141
142 # else /* MSWIN32 || MSWINCE */
143
144 #   define add_roots_to_index(p)
145
146 # endif
147
148
149
150
151 word GC_root_size = 0;
152
153 void GC_add_roots(b, e)
154 char * b; char * e;
155 {
156     DCL_LOCK_STATE;
157     
158     DISABLE_SIGNALS();
159     LOCK();
160     GC_add_roots_inner(b, e, FALSE);
161     UNLOCK();
162     ENABLE_SIGNALS();
163 }
164
165
166 /* Add [b,e) to the root set.  Adding the same interval a second time   */
167 /* is a moderately fast noop, and hence benign.  We do not handle       */
168 /* different but overlapping intervals efficiently.  (We do handle      */
169 /* them correctly.)                                                     */
170 /* Tmp specifies that the interval may be deleted before                */
171 /* reregistering dynamic libraries.                                     */ 
172 void GC_add_roots_inner(b, e, tmp)
173 char * b; char * e;
174 GC_bool tmp;
175 {
176     struct roots * old;
177     
178 #   if defined(MSWIN32) || defined(MSWINCE)
179       /* Spend the time to ensure that there are no overlapping */
180       /* or adjacent intervals.                                 */
181       /* This could be done faster with e.g. a                  */
182       /* balanced tree.  But the execution time here is         */
183       /* virtually guaranteed to be dominated by the time it    */
184       /* takes to scan the roots.                               */
185       {
186         register int i;
187         
188         for (i = 0; i < n_root_sets; i++) {
189             old = GC_static_roots + i;
190             if ((ptr_t)b <= old -> r_end && (ptr_t)e >= old -> r_start) {
191                 if ((ptr_t)b < old -> r_start) {
192                     old -> r_start = (ptr_t)b;
193                     GC_root_size += (old -> r_start - (ptr_t)b);
194                 }
195                 if ((ptr_t)e > old -> r_end) {
196                     old -> r_end = (ptr_t)e;
197                     GC_root_size += ((ptr_t)e - old -> r_end);
198                 }
199                 old -> r_tmp &= tmp;
200                 break;
201             }
202         }
203         if (i < n_root_sets) {
204           /* merge other overlapping intervals */
205             struct roots *other;
206             
207             for (i++; i < n_root_sets; i++) {
208               other = GC_static_roots + i;
209               b = (char *)(other -> r_start);
210               e = (char *)(other -> r_end);
211               if ((ptr_t)b <= old -> r_end && (ptr_t)e >= old -> r_start) {
212                 if ((ptr_t)b < old -> r_start) {
213                     old -> r_start = (ptr_t)b;
214                     GC_root_size += (old -> r_start - (ptr_t)b);
215                 }
216                 if ((ptr_t)e > old -> r_end) {
217                     old -> r_end = (ptr_t)e;
218                     GC_root_size += ((ptr_t)e - old -> r_end);
219                 }
220                 old -> r_tmp &= other -> r_tmp;
221                 /* Delete this entry. */
222                   GC_root_size -= (other -> r_end - other -> r_start);
223                   other -> r_start = GC_static_roots[n_root_sets-1].r_start;
224                   other -> r_end = GC_static_roots[n_root_sets-1].r_end;
225                                   n_root_sets--;
226               }
227             }
228           return;
229         }
230       }
231 #   else
232       old = GC_roots_present(b);
233       if (old != 0) {
234         if ((ptr_t)e <= old -> r_end) /* already there */ return;
235         /* else extend */
236         GC_root_size += (ptr_t)e - old -> r_end;
237         old -> r_end = (ptr_t)e;
238         return;
239       }
240 #   endif
241     if (n_root_sets == MAX_ROOT_SETS) {
242         ABORT("Too many root sets\n");
243     }
244     GC_static_roots[n_root_sets].r_start = (ptr_t)b;
245     GC_static_roots[n_root_sets].r_end = (ptr_t)e;
246     GC_static_roots[n_root_sets].r_tmp = tmp;
247 #   if !defined(MSWIN32) && !defined(MSWINCE)
248       GC_static_roots[n_root_sets].r_next = 0;
249 #   endif
250     add_roots_to_index(GC_static_roots + n_root_sets);
251     GC_root_size += (ptr_t)e - (ptr_t)b;
252     n_root_sets++;
253 }
254
255 static GC_bool roots_were_cleared = FALSE;
256
257 void GC_clear_roots GC_PROTO((void))
258 {
259     DCL_LOCK_STATE;
260     
261     DISABLE_SIGNALS();
262     LOCK();
263     roots_were_cleared = TRUE;
264     n_root_sets = 0;
265     GC_root_size = 0;
266 #   if !defined(MSWIN32) && !defined(MSWINCE)
267     {
268         register int i;
269         
270         for (i = 0; i < RT_SIZE; i++) GC_root_index[i] = 0;
271     }
272 #   endif
273     UNLOCK();
274     ENABLE_SIGNALS();
275 }
276
277 /* Internal use only; lock held.        */
278 static void GC_remove_root_at_pos(i) 
279 int i;
280 {
281     GC_root_size -= (GC_static_roots[i].r_end - GC_static_roots[i].r_start);
282     GC_static_roots[i].r_start = GC_static_roots[n_root_sets-1].r_start;
283     GC_static_roots[i].r_end = GC_static_roots[n_root_sets-1].r_end;
284     GC_static_roots[i].r_tmp = GC_static_roots[n_root_sets-1].r_tmp;
285     n_root_sets--;
286 }
287
288 #if !defined(MSWIN32) && !defined(MSWINCE)
289 static void GC_rebuild_root_index()
290 {
291     register int i;
292         
293     for (i = 0; i < RT_SIZE; i++) GC_root_index[i] = 0;
294     for (i = 0; i < n_root_sets; i++)
295         add_roots_to_index(GC_static_roots + i);
296 }
297 #endif
298
299 /* Internal use only; lock held.        */
300 void GC_remove_tmp_roots()
301 {
302     register int i;
303     
304     for (i = 0; i < n_root_sets; ) {
305         if (GC_static_roots[i].r_tmp) {
306             GC_remove_root_at_pos(i);
307         } else {
308             i++;
309     }
310     }
311     #if !defined(MSWIN32) && !defined(MSWINCE)
312     GC_rebuild_root_index();
313     #endif
314 }
315
316 #if !defined(MSWIN32) && !defined(MSWINCE)
317 void GC_remove_roots(b, e)
318 char * b; char * e;
319 {
320     DCL_LOCK_STATE;
321     
322     DISABLE_SIGNALS();
323     LOCK();
324     GC_remove_roots_inner(b, e);
325     UNLOCK();
326     ENABLE_SIGNALS();
327 }
328
329 /* Should only be called when the lock is held */
330 void GC_remove_roots_inner(b,e)
331 char * b; char * e;
332 {
333     int i;
334     for (i = 0; i < n_root_sets; ) {
335         if (GC_static_roots[i].r_start >= (ptr_t)b && GC_static_roots[i].r_end <= (ptr_t)e) {
336             GC_remove_root_at_pos(i);
337         } else {
338             i++;
339         }
340     }
341     GC_rebuild_root_index();
342 }
343 #endif /* !defined(MSWIN32) && !defined(MSWINCE) */
344
345 #if defined(MSWIN32) || defined(_WIN32_WCE_EMULATION)
346 /* Workaround for the OS mapping and unmapping behind our back:         */
347 /* Is the address p in one of the temporary static root sections?       */
348 GC_bool GC_is_tmp_root(p)
349 ptr_t p;
350 {
351     static int last_root_set = MAX_ROOT_SETS;
352     register int i;
353     
354     if (last_root_set < n_root_sets
355         && p >= GC_static_roots[last_root_set].r_start
356         && p < GC_static_roots[last_root_set].r_end)
357         return GC_static_roots[last_root_set].r_tmp;
358     for (i = 0; i < n_root_sets; i++) {
359         if (p >= GC_static_roots[i].r_start
360             && p < GC_static_roots[i].r_end) {
361             last_root_set = i;
362             return GC_static_roots[i].r_tmp;
363         }
364     }
365     return(FALSE);
366 }
367 #endif /* MSWIN32 || _WIN32_WCE_EMULATION */
368
369 ptr_t GC_approx_sp()
370 {
371 #if defined(__GNUC__)
372     return __builtin_frame_address(0);
373 #else
374     VOLATILE word dummy;
375
376     dummy = 42; /* Force stack to grow if necessary.    Otherwise the   */
377                 /* later accesses might cause the kernel to think we're */
378                 /* doing something wrong.                               */
379 #   ifdef _MSC_VER
380 #     pragma warning(disable:4172)
381 #   endif
382     return((ptr_t)(&dummy));
383 #   ifdef _MSC_VER
384 #     pragma warning(default:4172)
385 #   endif
386 #endif  // __GNUC__
387 }
388
389 /*
390  * Data structure for excluded static roots.
391  * Real declaration is in gc_priv.h.
392
393 struct exclusion {
394     ptr_t e_start;
395     ptr_t e_end;
396 };
397
398 struct exclusion GC_excl_table[MAX_EXCLUSIONS];
399                                         -- Array of exclusions, ascending
400                                         -- address order.
401 */
402
403 size_t GC_excl_table_entries = 0;       /* Number of entries in use.      */
404
405 /* Return the first exclusion range that includes an address >= start_addr */
406 /* Assumes the exclusion table contains at least one entry (namely the     */
407 /* GC data structures).                                                    */
408 struct exclusion * GC_next_exclusion(start_addr)
409 ptr_t start_addr;
410 {
411     size_t low = 0;
412     size_t high = GC_excl_table_entries - 1;
413     size_t mid;
414
415     while (high > low) {
416         mid = (low + high) >> 1;
417         /* low <= mid < high    */
418         if ((word) GC_excl_table[mid].e_end <= (word) start_addr) {
419             low = mid + 1;
420         } else {
421             high = mid;
422         }
423     }
424     if ((word) GC_excl_table[low].e_end <= (word) start_addr) return 0;
425     return GC_excl_table + low;
426 }
427
428 void GC_exclude_static_roots(start, finish)
429 GC_PTR start;
430 GC_PTR finish;
431 {
432     struct exclusion * next;
433     size_t next_index, i;
434
435     if (0 == GC_excl_table_entries) {
436         next = 0;
437     } else {
438         next = GC_next_exclusion(start);
439     }
440     if (0 != next) {
441       if ((word)(next -> e_start) < (word) finish) {
442         /* incomplete error check. */
443         ABORT("exclusion ranges overlap");
444       }  
445       if ((word)(next -> e_start) == (word) finish) {
446         /* extend old range backwards   */
447           next -> e_start = (ptr_t)start;
448           return;
449       }
450       next_index = next - GC_excl_table;
451       for (i = GC_excl_table_entries; i > next_index; --i) {
452         GC_excl_table[i] = GC_excl_table[i-1];
453       }
454     } else {
455       next_index = GC_excl_table_entries;
456     }
457     if (GC_excl_table_entries == MAX_EXCLUSIONS) ABORT("Too many exclusions");
458     GC_excl_table[next_index].e_start = (ptr_t)start;
459     GC_excl_table[next_index].e_end = (ptr_t)finish;
460     ++GC_excl_table_entries;
461 }
462
463 /* Invoke push_conditional on ranges that are not excluded. */
464 void GC_push_conditional_with_exclusions(bottom, top, all)
465 ptr_t bottom;
466 ptr_t top;
467 int all;
468 {
469     struct exclusion * next;
470     ptr_t excl_start;
471
472     while (bottom < top) {
473         next = GC_next_exclusion(bottom);
474         if (0 == next || (excl_start = next -> e_start) >= top) {
475             GC_push_conditional(bottom, top, all);
476             return;
477         }
478         if (excl_start > bottom) GC_push_conditional(bottom, excl_start, all);
479         bottom = next -> e_end;
480     }
481 }
482
483 /*
484  * In the absence of threads, push the stack contents.
485  * In the presence of threads, push enough of the current stack
486  * to ensure that callee-save registers saved in collector frames have been
487  * seen.
488  */
489 void GC_push_current_stack(cold_gc_frame)
490 ptr_t cold_gc_frame;
491 {
492 #   if defined(THREADS)
493         if (0 == cold_gc_frame) return;
494 #       ifdef STACK_GROWS_DOWN
495           GC_push_all_eager(GC_approx_sp(), cold_gc_frame);
496           /* For IA64, the register stack backing store is handled      */
497           /* in the thread-specific code.                               */
498 #       else
499           GC_push_all_eager( cold_gc_frame, GC_approx_sp() );
500 #       endif
501 #   else
502 #       ifdef STACK_GROWS_DOWN
503             GC_push_all_stack_partially_eager( GC_approx_sp(), GC_stackbottom,
504                                                cold_gc_frame );
505 #           ifdef IA64
506               /* We also need to push the register stack backing store. */
507               /* This should really be done in the same way as the      */
508               /* regular stack.  For now we fudge it a bit.             */
509               /* Note that the backing store grows up, so we can't use  */
510               /* GC_push_all_stack_partially_eager.                     */
511               {
512                 extern word GC_save_regs_ret_val;
513                         /* Previously set to backing store pointer.     */
514                 ptr_t bsp = (ptr_t) GC_save_regs_ret_val;
515                 ptr_t cold_gc_bs_pointer;
516                 if (GC_all_interior_pointers) {
517                   cold_gc_bs_pointer = bsp - 2048;
518                   if (cold_gc_bs_pointer < BACKING_STORE_BASE) {
519                     cold_gc_bs_pointer = BACKING_STORE_BASE;
520                   } else {
521                     GC_push_all_stack(BACKING_STORE_BASE, cold_gc_bs_pointer);
522                   }
523                 } else {
524                   cold_gc_bs_pointer = BACKING_STORE_BASE;
525                 }
526                 GC_push_all_eager(cold_gc_bs_pointer, bsp);
527                 /* All values should be sufficiently aligned that we    */
528                 /* dont have to worry about the boundary.               */
529               }
530 #           endif
531 #       else
532             GC_push_all_stack_partially_eager( GC_stackbottom, GC_approx_sp(),
533                                                cold_gc_frame );
534 #       endif
535 #   endif /* !THREADS */
536 }
537
538 /*
539  * Push GC internal roots.  Only called if there is some reason to believe
540  * these would not otherwise get registered.
541  */
542 void GC_push_gc_structures GC_PROTO((void))
543 {
544     GC_push_finalizer_structures();
545     GC_push_stubborn_structures();
546 #   if defined(THREADS)
547       GC_push_thread_structures();
548 #   endif
549 }
550
551 #ifdef THREAD_LOCAL_ALLOC
552   void GC_mark_thread_local_free_lists();
553 #endif
554
555 void GC_cond_register_dynamic_libraries()
556 {
557 # if (defined(DYNAMIC_LOADING) || defined(MSWIN32) || defined(MSWINCE) \
558      || defined(PCR)) && !defined(SRC_M3)
559     GC_remove_tmp_roots();
560     if (!GC_no_dls) GC_register_dynamic_libraries();
561 # else
562     GC_no_dls = TRUE;
563 # endif
564 }
565
566 /*
567  * Call the mark routines (GC_tl_push for a single pointer, GC_push_conditional
568  * on groups of pointers) on every top level accessible pointer.
569  * If all is FALSE, arrange to push only possibly altered values.
570  * Cold_gc_frame is an address inside a GC frame that
571  * remains valid until all marking is complete.
572  * A zero value indicates that it's OK to miss some
573  * register values.
574  */
575 void GC_push_roots(all, cold_gc_frame)
576 GC_bool all;
577 ptr_t cold_gc_frame;
578 {
579     int i;
580     int kind;
581
582     /*
583      * Next push static data.  This must happen early on, since it's
584      * not robust against mark stack overflow.
585      */
586      /* Reregister dynamic libraries, in case one got added.            */
587      /* There is some argument for doing this as late as possible,      */
588      /* especially on win32, where it can change asynchronously.        */
589      /* In those cases, we do it here.  But on other platforms, it's    */
590      /* not safe with the world stopped, so we do it earlier.           */
591 #      if !defined(REGISTER_LIBRARIES_EARLY)
592          GC_cond_register_dynamic_libraries();
593 #      endif
594
595      /* Mark everything in static data areas                             */
596        for (i = 0; i < n_root_sets; i++) {
597          GC_push_conditional_with_exclusions(
598                              GC_static_roots[i].r_start,
599                              GC_static_roots[i].r_end, all);
600        }
601
602      /* Mark all free list header blocks, if those were allocated from  */
603      /* the garbage collected heap.  This makes sure they don't         */
604      /* disappear if we are not marking from static data.  It also      */
605      /* saves us the trouble of scanning them, and possibly that of     */
606      /* marking the freelists.                                          */
607        for (kind = 0; kind < GC_n_kinds; kind++) {
608          GC_PTR base = GC_base(GC_obj_kinds[kind].ok_freelist);
609          if (0 != base) {
610            GC_set_mark_bit(base);
611          }
612        }
613        
614      /* Mark from GC internal roots if those might otherwise have       */
615      /* been excluded.                                                  */
616        if (GC_no_dls || roots_were_cleared) {
617            GC_push_gc_structures();
618        }
619
620      /* Mark thread local free lists, even if their mark        */
621      /* descriptor excludes the link field.                     */
622      /* If the world is not stopped, this is unsafe.  It is     */
623      /* also unnecessary, since we will do this again with the  */
624      /* world stopped.                                          */
625 #      ifdef THREAD_LOCAL_ALLOC
626          if (GC_world_stopped) GC_mark_thread_local_free_lists();
627 #      endif
628
629     /*
630      * Now traverse stacks, and mark from register contents.
631      * These must be done last, since they can legitimately overflow
632      * the mark stack.
633      */
634 #   ifdef USE_GENERIC_PUSH_REGS
635         GC_generic_push_regs(cold_gc_frame);
636         /* Also pushes stack, so that we catch callee-save registers    */
637         /* saved inside the GC_push_regs frame.                         */
638 #   else
639        /*
640         * push registers - i.e., call GC_push_one(r) for each
641         * register contents r.
642         */
643         GC_push_regs(); /* usually defined in machine_dep.c */
644         GC_push_current_stack(cold_gc_frame);
645         /* In the threads case, this only pushes collector frames.      */
646         /* In the case of linux threads on IA64, the hot section of     */
647         /* the main stack is marked here, but the register stack        */
648         /* backing store is handled in the threads-specific code.       */
649 #   endif
650     if (GC_push_other_roots != 0) (*GC_push_other_roots)();
651         /* In the threads case, this also pushes thread stacks. */
652         /* Note that without interior pointer recognition lots  */
653         /* of stuff may have been pushed already, and this      */
654         /* should be careful about mark stack overflows.        */
655 }
656