forked from ivmai/bdwgc
-
Notifications
You must be signed in to change notification settings - Fork 1
/
misc.c
2752 lines (2425 loc) · 82.3 KB
/
misc.c
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Copyright 1988, 1989 Hans-J. Boehm, Alan J. Demers
* Copyright (c) 1991-1994 by Xerox Corporation. All rights reserved.
* Copyright (c) 1999-2001 by Hewlett-Packard Company. All rights reserved.
* Copyright (c) 2008-2022 Ivan Maidanski
*
* THIS MATERIAL IS PROVIDED AS IS, WITH ABSOLUTELY NO WARRANTY EXPRESSED
* OR IMPLIED. ANY USE IS AT YOUR OWN RISK.
*
* Permission is hereby granted to use or copy this program
* for any purpose, provided the above notices are retained on all copies.
* Permission to modify the code and to distribute modified code is granted,
* provided the above notices are retained, and a notice that the code was
* modified is included with the above copyright notice.
*/
#include "private/gc_pmark.h"
#include <limits.h>
#include <stdarg.h>
#ifdef GC_SOLARIS_THREADS
# include <sys/syscall.h>
#endif
#if defined(UNIX_LIKE) || defined(CYGWIN32) || defined(SYMBIAN) \
|| (defined(CONSOLE_LOG) && defined(MSWIN32))
# include <fcntl.h>
# include <sys/stat.h>
#endif
#if defined(CONSOLE_LOG) && defined(MSWIN32) && !defined(__GNUC__)
# include <io.h>
#endif
#ifdef NONSTOP
# include <floss.h>
#endif
#ifdef BUFFERED_FINALIZATION
# include "gc/gc_disclaim.h"
#endif
#ifdef THREADS
# ifdef PCR
# include "il/PCR_IL.h"
GC_INNER PCR_Th_ML GC_allocate_ml;
# elif defined(SN_TARGET_PSP2)
GC_INNER WapiMutex GC_allocate_ml_PSP2 = { 0, NULL };
# elif defined(GC_DEFN_ALLOCATE_ML) && !defined(USE_RWLOCK) \
|| defined(SN_TARGET_PS3)
# include <pthread.h>
GC_INNER pthread_mutex_t GC_allocate_ml;
# endif
/* For other platforms with threads, the allocator lock and possibly */
/* GC_lock_holder variables are defined in the thread support code. */
#endif /* THREADS */
#ifdef DYNAMIC_LOADING
/* We need to register the main data segment. Returns TRUE unless */
/* this is done implicitly as part of dynamic library registration. */
# define GC_REGISTER_MAIN_STATIC_DATA() GC_register_main_static_data()
#elif defined(GC_DONT_REGISTER_MAIN_STATIC_DATA)
# define GC_REGISTER_MAIN_STATIC_DATA() FALSE
#else
/* Don't unnecessarily call GC_register_main_static_data() in case */
/* dyn_load.c isn't linked in. */
# define GC_REGISTER_MAIN_STATIC_DATA() TRUE
#endif
#ifdef NEED_CANCEL_DISABLE_COUNT
__thread unsigned char GC_cancel_disable_count = 0;
#endif
GC_FAR struct _GC_arrays GC_arrays /* = { 0 } */;
GC_INNER unsigned GC_n_mark_procs = GC_RESERVED_MARK_PROCS;
GC_INNER unsigned GC_n_kinds = GC_N_KINDS_INITIAL_VALUE;
GC_INNER GC_bool GC_debugging_started = FALSE;
/* defined here so we don't have to load dbg_mlc.o */
ptr_t GC_stackbottom = 0;
#if defined(E2K) && defined(THREADS) || defined(IA64)
GC_INNER ptr_t GC_register_stackbottom = NULL;
#endif
int GC_dont_gc = FALSE;
int GC_dont_precollect = FALSE;
GC_bool GC_quiet = 0; /* used also in pcr_interface.c */
#if !defined(NO_CLOCK) || !defined(SMALL_CONFIG)
GC_INNER int GC_print_stats = 0;
#endif
#ifdef GC_PRINT_BACK_HEIGHT
GC_INNER GC_bool GC_print_back_height = TRUE;
#else
GC_INNER GC_bool GC_print_back_height = FALSE;
#endif
#ifndef NO_DEBUGGING
# ifdef GC_DUMP_REGULARLY
GC_INNER GC_bool GC_dump_regularly = TRUE;
/* Generate regular debugging dumps. */
# else
GC_INNER GC_bool GC_dump_regularly = FALSE;
# endif
# ifndef NO_CLOCK
STATIC CLOCK_TYPE GC_init_time;
/* The time that the GC was initialized at. */
# endif
#endif /* !NO_DEBUGGING */
#ifdef KEEP_BACK_PTRS
GC_INNER long GC_backtraces = 0;
/* Number of random backtraces to generate for each GC. */
#endif
#ifdef FIND_LEAK
int GC_find_leak = 1;
#else
int GC_find_leak = 0;
#endif
#ifndef SHORT_DBG_HDRS
# ifdef GC_FINDLEAK_DELAY_FREE
GC_INNER GC_bool GC_findleak_delay_free = TRUE;
# else
GC_INNER GC_bool GC_findleak_delay_free = FALSE;
# endif
#endif /* !SHORT_DBG_HDRS */
#ifdef ALL_INTERIOR_POINTERS
int GC_all_interior_pointers = 1;
#else
int GC_all_interior_pointers = 0;
#endif
#ifdef FINALIZE_ON_DEMAND
int GC_finalize_on_demand = 1;
#else
int GC_finalize_on_demand = 0;
#endif
#ifdef JAVA_FINALIZATION
int GC_java_finalization = 1;
#else
int GC_java_finalization = 0;
#endif
/* All accesses to it should be synchronized to avoid data race. */
GC_finalizer_notifier_proc GC_finalizer_notifier =
(GC_finalizer_notifier_proc)0;
#ifdef GC_FORCE_UNMAP_ON_GCOLLECT
/* Has no effect unless USE_MUNMAP. */
/* Has no effect on implicitly-initiated garbage collections. */
GC_INNER GC_bool GC_force_unmap_on_gcollect = TRUE;
#else
GC_INNER GC_bool GC_force_unmap_on_gcollect = FALSE;
#endif
#ifndef GC_LARGE_ALLOC_WARN_INTERVAL
# define GC_LARGE_ALLOC_WARN_INTERVAL 9999
#endif
GC_INNER long GC_large_alloc_warn_interval = GC_LARGE_ALLOC_WARN_INTERVAL;
/* Interval between unsuppressed warnings. */
STATIC void * GC_CALLBACK GC_default_oom_fn(size_t bytes_requested)
{
UNUSED_ARG(bytes_requested);
return NULL;
}
/* All accesses to it should be synchronized to avoid data race. */
GC_oom_func GC_oom_fn = GC_default_oom_fn;
#ifdef CAN_HANDLE_FORK
# ifdef HANDLE_FORK
GC_INNER int GC_handle_fork = 1;
/* The value is examined by GC_thr_init. */
# else
GC_INNER int GC_handle_fork = FALSE;
# endif
#elif !defined(HAVE_NO_FORK)
GC_API void GC_CALL GC_atfork_prepare(void)
{
# ifdef THREADS
ABORT("fork() handling unsupported");
# endif
}
GC_API void GC_CALL GC_atfork_parent(void)
{
/* empty */
}
GC_API void GC_CALL GC_atfork_child(void)
{
/* empty */
}
#endif /* !CAN_HANDLE_FORK && !HAVE_NO_FORK */
/* Overrides the default automatic handle-fork mode. Has effect only */
/* if called before GC_INIT. */
GC_API void GC_CALL GC_set_handle_fork(int value)
{
# ifdef CAN_HANDLE_FORK
if (!GC_is_initialized)
GC_handle_fork = value >= -1 ? value : 1;
/* Map all negative values except for -1 to a positive one. */
# elif defined(THREADS) || (defined(DARWIN) && defined(MPROTECT_VDB))
if (!GC_is_initialized && value) {
# ifndef SMALL_CONFIG
GC_init(); /* to initialize GC_manual_vdb and GC_stderr */
# ifndef THREADS
if (GC_manual_vdb)
return;
# endif
# endif
ABORT("fork() handling unsupported");
}
# else
/* No at-fork handler is needed in the single-threaded mode. */
UNUSED_ARG(value);
# endif
}
/* Set things up so that GC_size_map[i] >= granules(i), */
/* but not too much bigger */
/* and so that size_map contains relatively few distinct entries */
/* This was originally stolen from Russ Atkinson's Cedar */
/* quantization algorithm (but we precompute it). */
STATIC void GC_init_size_map(void)
{
size_t i = 1;
/* Map size 0 to something bigger. */
/* This avoids problems at lower levels. */
GC_size_map[0] = 1;
for (; i <= GRANULES_TO_BYTES(GC_TINY_FREELISTS-1) - EXTRA_BYTES; i++) {
GC_size_map[i] = ALLOC_REQUEST_GRANS(i);
# ifndef _MSC_VER
GC_ASSERT(GC_size_map[i] < GC_TINY_FREELISTS);
/* Seems to tickle bug in VC++ 2008 for x64 */
# endif
}
/* We leave the rest of the array to be filled in on demand. */
}
/*
* The following is a gross hack to deal with a problem that can occur
* on machines that are sloppy about stack frame sizes, notably SPARC.
* Bogus pointers may be written to the stack and not cleared for
* a LONG time, because they always fall into holes in stack frames
* that are not written. We partially address this by clearing
* sections of the stack whenever we get control.
*/
#ifndef SMALL_CLEAR_SIZE
# define SMALL_CLEAR_SIZE 256 /* Clear this much every time. */
#endif
#if defined(ALWAYS_SMALL_CLEAR_STACK) || defined(STACK_NOT_SCANNED)
GC_API void * GC_CALL GC_clear_stack(void *arg)
{
# ifndef STACK_NOT_SCANNED
word volatile dummy[SMALL_CLEAR_SIZE];
BZERO((/* no volatile */ word *)((word)dummy), sizeof(dummy));
# endif
return arg;
}
#else
# ifdef THREADS
# define BIG_CLEAR_SIZE 2048 /* Clear this much now and then. */
# else
STATIC word GC_stack_last_cleared = 0;
/* GC_gc_no value when we last did this. */
STATIC ptr_t GC_min_sp = NULL;
/* Coolest stack pointer value from which */
/* we've already cleared the stack. */
STATIC ptr_t GC_high_water = NULL;
/* "hottest" stack pointer value we have seen */
/* recently. Degrades over time. */
STATIC word GC_bytes_allocd_at_reset = 0;
# define DEGRADE_RATE 50
# endif
# if defined(__APPLE_CC__) && !GC_CLANG_PREREQ(6, 0)
# define CLEARSTACK_LIMIT_MODIFIER volatile /* to workaround some bug */
# else
# define CLEARSTACK_LIMIT_MODIFIER /* empty */
# endif
EXTERN_C_BEGIN
void *GC_clear_stack_inner(void *, CLEARSTACK_LIMIT_MODIFIER ptr_t);
EXTERN_C_END
# ifndef ASM_CLEAR_CODE
/* Clear the stack up to about limit. Return arg. This function */
/* is not static because it could also be erroneously defined in .S */
/* file, so this error would be caught by the linker. */
void *GC_clear_stack_inner(void *arg,
CLEARSTACK_LIMIT_MODIFIER ptr_t limit)
{
# define CLEAR_SIZE 213 /* granularity */
volatile word dummy[CLEAR_SIZE];
BZERO((/* no volatile */ word *)((word)dummy), sizeof(dummy));
if (HOTTER_THAN((/* no volatile */ ptr_t)limit, GC_approx_sp())) {
(void)GC_clear_stack_inner(arg, limit);
}
/* Make sure the recursive call is not a tail call, and the bzero */
/* call is not recognized as dead code. */
# if defined(CPPCHECK)
GC_noop1(dummy[0]);
# else
GC_noop1(COVERT_DATAFLOW(dummy));
# endif
return arg;
}
# endif /* !ASM_CLEAR_CODE */
# ifdef THREADS
/* Used to occasionally clear a bigger chunk. */
/* TODO: Should be more random than it is ... */
static unsigned next_random_no(void)
{
# ifdef AO_HAVE_fetch_and_add1
static volatile AO_t random_no;
return (unsigned)AO_fetch_and_add1(&random_no) % 13;
# else
static unsigned random_no = 0;
return (random_no++) % 13;
# endif
}
# endif /* THREADS */
/* Clear some of the inaccessible part of the stack. Returns its */
/* argument, so it can be used in a tail call position, hence clearing */
/* another frame. */
GC_API void * GC_CALL GC_clear_stack(void *arg)
{
ptr_t sp = GC_approx_sp(); /* Hotter than actual sp */
# ifdef THREADS
word volatile dummy[SMALL_CLEAR_SIZE];
# endif
# define SLOP 400
/* Extra bytes we clear every time. This clears our own */
/* activation record, and should cause more frequent */
/* clearing near the cold end of the stack, a good thing. */
# define GC_SLOP 4000
/* We make GC_high_water this much hotter than we really saw */
/* it, to cover for GC noise etc. above our current frame. */
# define CLEAR_THRESHOLD 100000
/* We restart the clearing process after this many bytes of */
/* allocation. Otherwise very heavily recursive programs */
/* with sparse stacks may result in heaps that grow almost */
/* without bounds. As the heap gets larger, collection */
/* frequency decreases, thus clearing frequency would decrease, */
/* thus more junk remains accessible, thus the heap gets */
/* larger ... */
# ifdef THREADS
if (next_random_no() == 0) {
ptr_t limit = sp;
MAKE_HOTTER(limit, BIG_CLEAR_SIZE * sizeof(word));
limit = PTR_ALIGN_DOWN(limit, 0x10);
/* Make it sufficiently aligned for assembly */
/* implementations of GC_clear_stack_inner. */
return GC_clear_stack_inner(arg, limit);
}
BZERO((/* no volatile */ void *)dummy, SMALL_CLEAR_SIZE * sizeof(word));
# else
if (GC_gc_no != GC_stack_last_cleared) {
/* Start things over, so we clear the entire stack again. */
if (EXPECT(NULL == GC_high_water, FALSE))
GC_high_water = (ptr_t)GC_stackbottom;
GC_min_sp = GC_high_water;
GC_stack_last_cleared = GC_gc_no;
GC_bytes_allocd_at_reset = GC_bytes_allocd;
}
/* Adjust GC_high_water. */
GC_ASSERT(GC_high_water != NULL);
MAKE_COOLER(GC_high_water, WORDS_TO_BYTES(DEGRADE_RATE) + GC_SLOP);
if (HOTTER_THAN(sp, GC_high_water))
GC_high_water = sp;
MAKE_HOTTER(GC_high_water, GC_SLOP);
{
ptr_t limit = GC_min_sp;
MAKE_HOTTER(limit, SLOP);
if (HOTTER_THAN(limit, sp)) {
limit = PTR_ALIGN_DOWN(limit, 0x10);
GC_min_sp = sp;
return GC_clear_stack_inner(arg, limit);
}
}
if (GC_bytes_allocd - GC_bytes_allocd_at_reset > CLEAR_THRESHOLD) {
/* Restart clearing process, but limit how much clearing we do. */
GC_min_sp = sp;
MAKE_HOTTER(GC_min_sp, CLEAR_THRESHOLD/4);
if (HOTTER_THAN(GC_min_sp, GC_high_water))
GC_min_sp = GC_high_water;
GC_bytes_allocd_at_reset = GC_bytes_allocd;
}
# endif
return arg;
}
#endif /* !ALWAYS_SMALL_CLEAR_STACK && !STACK_NOT_SCANNED */
/* Return a pointer to the base address of p, given a pointer to a */
/* an address within an object. Return 0 otherwise. */
GC_API void * GC_CALL GC_base(void * p)
{
ptr_t r = (ptr_t)p;
struct hblk *h;
bottom_index *bi;
hdr *hhdr;
ptr_t limit;
word sz;
if (!EXPECT(GC_is_initialized, TRUE)) return NULL;
h = HBLKPTR(r);
GET_BI(r, bi);
hhdr = HDR_FROM_BI(bi, r);
if (NULL == hhdr) return NULL;
/* If it's a pointer to the middle of a large object, move it */
/* to the beginning. */
if (IS_FORWARDING_ADDR_OR_NIL(hhdr)) {
h = GC_find_starting_hblk(h, &hhdr);
r = (ptr_t)h;
}
if (HBLK_IS_FREE(hhdr)) return NULL;
/* Make sure r points to the beginning of the object. */
r = PTR_ALIGN_DOWN(r, WORDS_TO_BYTES(1));
sz = hhdr -> hb_sz;
r -= HBLKDISPL(r) % sz;
limit = r + sz;
if ((ADDR_LT((ptr_t)(h + 1), limit) && sz <= HBLKSIZE)
|| ADDR_GE((ptr_t)p, limit))
return NULL;
return r;
}
/* Return TRUE if and only if p points to somewhere in GC heap. */
GC_API int GC_CALL GC_is_heap_ptr(const void *p)
{
bottom_index *bi;
GC_ASSERT(GC_is_initialized);
GET_BI(p, bi);
return HDR_FROM_BI(bi, p) != 0;
}
/* Return the size of an object, given a pointer to its base. */
/* (For small objects this also happens to work from interior pointers, */
/* but that shouldn't be relied upon.) */
GC_API size_t GC_CALL GC_size(const void * p)
{
const hdr *hhdr = HDR((/* no const */ void *)(word)p);
return (size_t)(hhdr -> hb_sz);
}
/* These getters remain unsynchronized for compatibility (since some */
/* clients could call some of them from a GC callback holding the */
/* allocator lock). */
GC_API size_t GC_CALL GC_get_heap_size(void)
{
/* ignore the memory space returned to OS (i.e. count only the */
/* space owned by the garbage collector) */
return (size_t)(GC_heapsize - GC_unmapped_bytes);
}
GC_API size_t GC_CALL GC_get_obtained_from_os_bytes(void)
{
return (size_t)GC_our_mem_bytes;
}
GC_API size_t GC_CALL GC_get_free_bytes(void)
{
/* ignore the memory space returned to OS */
return (size_t)(GC_large_free_bytes - GC_unmapped_bytes);
}
GC_API size_t GC_CALL GC_get_unmapped_bytes(void)
{
return (size_t)GC_unmapped_bytes;
}
GC_API size_t GC_CALL GC_get_bytes_since_gc(void)
{
return (size_t)GC_bytes_allocd;
}
GC_API size_t GC_CALL GC_get_total_bytes(void)
{
return (size_t)(GC_bytes_allocd + GC_bytes_allocd_before_gc);
}
#ifndef GC_GET_HEAP_USAGE_NOT_NEEDED
GC_API size_t GC_CALL GC_get_size_map_at(int i)
{
if ((unsigned)i > MAXOBJBYTES)
return GC_SIZE_MAX;
return GRANULES_TO_BYTES(GC_size_map[i]);
}
/* Return the heap usage information. This is a thread-safe (atomic) */
/* alternative for the five above getters. NULL pointer is allowed for */
/* any argument. Returned (filled in) values are of word type. */
GC_API void GC_CALL GC_get_heap_usage_safe(GC_word *pheap_size,
GC_word *pfree_bytes, GC_word *punmapped_bytes,
GC_word *pbytes_since_gc, GC_word *ptotal_bytes)
{
READER_LOCK();
if (pheap_size != NULL)
*pheap_size = GC_heapsize - GC_unmapped_bytes;
if (pfree_bytes != NULL)
*pfree_bytes = GC_large_free_bytes - GC_unmapped_bytes;
if (punmapped_bytes != NULL)
*punmapped_bytes = GC_unmapped_bytes;
if (pbytes_since_gc != NULL)
*pbytes_since_gc = GC_bytes_allocd;
if (ptotal_bytes != NULL)
*ptotal_bytes = GC_bytes_allocd + GC_bytes_allocd_before_gc;
READER_UNLOCK();
}
GC_INNER word GC_reclaimed_bytes_before_gc = 0;
/* Fill in GC statistics provided the destination is of enough size. */
static void fill_prof_stats(struct GC_prof_stats_s *pstats)
{
pstats->heapsize_full = GC_heapsize;
pstats->free_bytes_full = GC_large_free_bytes;
pstats->unmapped_bytes = GC_unmapped_bytes;
pstats->bytes_allocd_since_gc = GC_bytes_allocd;
pstats->allocd_bytes_before_gc = GC_bytes_allocd_before_gc;
pstats->non_gc_bytes = GC_non_gc_bytes;
pstats->gc_no = GC_gc_no; /* could be -1 */
# ifdef PARALLEL_MARK
pstats->markers_m1 = (word)((signed_word)GC_markers_m1);
# else
pstats->markers_m1 = 0; /* one marker */
# endif
pstats->bytes_reclaimed_since_gc = GC_bytes_found > 0 ?
(word)GC_bytes_found : 0;
pstats->reclaimed_bytes_before_gc = GC_reclaimed_bytes_before_gc;
pstats->expl_freed_bytes_since_gc = GC_bytes_freed; /* since gc-7.7 */
pstats->obtained_from_os_bytes = GC_our_mem_bytes; /* since gc-8.2 */
}
# include <string.h> /* for memset() */
GC_API size_t GC_CALL GC_get_prof_stats(struct GC_prof_stats_s *pstats,
size_t stats_sz)
{
struct GC_prof_stats_s stats;
READER_LOCK();
fill_prof_stats(stats_sz >= sizeof(stats) ? pstats : &stats);
READER_UNLOCK();
if (stats_sz == sizeof(stats)) {
return sizeof(stats);
} else if (stats_sz > sizeof(stats)) {
/* Fill in the remaining part with -1. */
memset((char *)pstats + sizeof(stats), 0xff, stats_sz - sizeof(stats));
return sizeof(stats);
} else {
if (EXPECT(stats_sz > 0, TRUE))
BCOPY(&stats, pstats, stats_sz);
return stats_sz;
}
}
# ifdef THREADS
/* The _unsafe version assumes the caller holds the allocator lock, */
/* at least in the reader mode. */
GC_API size_t GC_CALL GC_get_prof_stats_unsafe(
struct GC_prof_stats_s *pstats,
size_t stats_sz)
{
struct GC_prof_stats_s stats;
if (stats_sz >= sizeof(stats)) {
fill_prof_stats(pstats);
if (stats_sz > sizeof(stats))
memset((char *)pstats + sizeof(stats), 0xff,
stats_sz - sizeof(stats));
return sizeof(stats);
} else {
if (EXPECT(stats_sz > 0, TRUE)) {
fill_prof_stats(&stats);
BCOPY(&stats, pstats, stats_sz);
}
return stats_sz;
}
}
# endif /* THREADS */
#endif /* !GC_GET_HEAP_USAGE_NOT_NEEDED */
#if defined(THREADS) && !defined(SIGNAL_BASED_STOP_WORLD)
/* GC does not use signals to suspend and restart threads. */
GC_API void GC_CALL GC_set_suspend_signal(int sig)
{
UNUSED_ARG(sig);
}
GC_API void GC_CALL GC_set_thr_restart_signal(int sig)
{
UNUSED_ARG(sig);
}
GC_API int GC_CALL GC_get_suspend_signal(void)
{
return -1;
}
GC_API int GC_CALL GC_get_thr_restart_signal(void)
{
return -1;
}
#endif /* THREADS && !SIGNAL_BASED_STOP_WORLD */
#if !defined(_MAX_PATH) && defined(ANY_MSWIN)
# define _MAX_PATH MAX_PATH
#endif
#ifdef GC_READ_ENV_FILE
/* This works for Win32/WinCE for now. Really useful only for WinCE. */
STATIC char *GC_envfile_content = NULL;
/* The content of the GC "env" file with CR and */
/* LF replaced to '\0'. NULL if the file is */
/* missing or empty. Otherwise, always ends */
/* with '\0'. */
STATIC unsigned GC_envfile_length = 0;
/* Length of GC_envfile_content (if non-NULL). */
# ifndef GC_ENVFILE_MAXLEN
# define GC_ENVFILE_MAXLEN 0x4000
# endif
# define GC_ENV_FILE_EXT ".gc.env"
/* The routine initializes GC_envfile_content from the GC "env" file. */
STATIC void GC_envfile_init(void)
{
# ifdef ANY_MSWIN
HANDLE hFile;
char *content;
unsigned ofs;
unsigned len;
DWORD nBytesRead;
TCHAR path[_MAX_PATH + 0x10]; /* buffer for path + ext */
size_t bytes_to_get;
GC_ASSERT(I_HOLD_LOCK());
len = (unsigned)GetModuleFileName(NULL /* hModule */, path,
_MAX_PATH + 1);
/* If GetModuleFileName() has failed then len is 0. */
if (len > 4 && path[len - 4] == (TCHAR)'.') {
len -= 4; /* strip executable file extension */
}
BCOPY(TEXT(GC_ENV_FILE_EXT), &path[len], sizeof(TEXT(GC_ENV_FILE_EXT)));
hFile = CreateFile(path, GENERIC_READ,
FILE_SHARE_READ | FILE_SHARE_WRITE,
NULL /* lpSecurityAttributes */, OPEN_EXISTING,
FILE_ATTRIBUTE_NORMAL, NULL /* hTemplateFile */);
if (hFile == INVALID_HANDLE_VALUE)
return; /* the file is absent or the operation is failed */
len = (unsigned)GetFileSize(hFile, NULL);
if (len <= 1 || len >= GC_ENVFILE_MAXLEN) {
CloseHandle(hFile);
return; /* invalid file length - ignoring the file content */
}
/* At this execution point, GC_setpagesize() and GC_init_win32() */
/* must already be called (for GET_MEM() to work correctly). */
GC_ASSERT(GC_page_size != 0);
bytes_to_get = ROUNDUP_PAGESIZE_IF_MMAP((size_t)len + 1);
content = GC_os_get_mem(bytes_to_get);
if (content == NULL) {
CloseHandle(hFile);
return; /* allocation failure */
}
ofs = 0;
nBytesRead = (DWORD)-1L;
/* Last ReadFile() call should clear nBytesRead on success. */
while (ReadFile(hFile, content + ofs, len - ofs + 1, &nBytesRead,
NULL /* lpOverlapped */) && nBytesRead != 0) {
if ((ofs += nBytesRead) > len)
break;
}
CloseHandle(hFile);
if (ofs != len || nBytesRead != 0) {
/* TODO: recycle content */
return; /* read operation is failed - ignoring the file content */
}
content[ofs] = '\0';
while (ofs-- > 0) {
if (content[ofs] == '\r' || content[ofs] == '\n')
content[ofs] = '\0';
}
GC_ASSERT(NULL == GC_envfile_content);
GC_envfile_length = len + 1;
GC_envfile_content = content;
# endif
}
/* This routine scans GC_envfile_content for the specified */
/* environment variable (and returns its value if found). */
GC_INNER char * GC_envfile_getenv(const char *name)
{
char *p;
const char *end_of_content;
size_t namelen;
# ifndef NO_GETENV
p = getenv(name); /* try the standard getenv() first */
if (p != NULL)
return *p != '\0' ? p : NULL;
# endif
p = GC_envfile_content;
if (NULL == p)
return NULL; /* "env" file is absent (or empty) */
namelen = strlen(name);
if (0 == namelen) /* a sanity check */
return NULL;
for (end_of_content = p + GC_envfile_length;
ADDR_LT((ptr_t)p, (ptr_t)end_of_content); p += strlen(p) + 1) {
if (strncmp(p, name, namelen) == 0 && *(p += namelen) == '=') {
p++; /* the match is found; skip '=' */
return *p != '\0' ? p : NULL;
}
/* If not matching then skip to the next line. */
}
GC_ASSERT(p == end_of_content);
return NULL; /* no match found */
}
#endif /* GC_READ_ENV_FILE */
GC_INNER GC_bool GC_is_initialized = FALSE;
GC_API int GC_CALL GC_is_init_called(void)
{
return (int)GC_is_initialized;
}
#if defined(GC_WIN32_THREADS) \
&& ((defined(MSWIN32) && !defined(CONSOLE_LOG)) || defined(MSWINCE))
GC_INNER CRITICAL_SECTION GC_write_cs;
#endif
#ifndef DONT_USE_ATEXIT
# if !defined(PCR) && !defined(SMALL_CONFIG)
/* A dedicated variable to avoid a garbage collection on abort. */
/* GC_find_leak cannot be used for this purpose as otherwise */
/* TSan finds a data race (between GC_default_on_abort and, e.g., */
/* GC_finish_collection). */
static GC_bool skip_gc_atexit = FALSE;
# else
# define skip_gc_atexit FALSE
# endif
STATIC void GC_exit_check(void)
{
if (GC_find_leak && !skip_gc_atexit) {
# ifdef THREADS
/* Check that the thread executing at-exit functions is */
/* the same as the one performed the GC initialization, */
/* otherwise the latter thread might already be dead but */
/* still registered and this, as a consequence, might */
/* cause a signal delivery fail when suspending the threads */
/* on platforms that do not guarantee ESRCH returned if */
/* the signal is not delivered. */
/* It should also prevent "Collecting from unknown thread" */
/* abort in GC_push_all_stacks(). */
if (!GC_is_main_thread() || !GC_thread_is_registered()) return;
# endif
GC_gcollect();
}
}
#endif
#if defined(UNIX_LIKE) && !defined(NO_DEBUGGING)
static void looping_handler(int sig)
{
GC_err_printf("Caught signal %d: looping in handler\n", sig);
for (;;) {
/* empty */
}
}
static GC_bool installed_looping_handler = FALSE;
static void maybe_install_looping_handler(void)
{
/* Install looping handler before the write fault handler, so we */
/* handle write faults correctly. */
if (!installed_looping_handler && 0 != GETENV("GC_LOOP_ON_ABORT")) {
GC_set_and_save_fault_handler(looping_handler);
installed_looping_handler = TRUE;
}
}
#else /* !UNIX_LIKE */
# define maybe_install_looping_handler()
#endif
#define GC_DEFAULT_STDERR_FD 2
#ifdef KOS
# define GC_DEFAULT_STDOUT_FD GC_DEFAULT_STDERR_FD
#else
# define GC_DEFAULT_STDOUT_FD 1
#endif
#if !defined(OS2) && !defined(MACOS) && !defined(GC_ANDROID_LOG) \
&& !defined(NN_PLATFORM_CTR) && !defined(NINTENDO_SWITCH) \
&& (!defined(MSWIN32) || defined(CONSOLE_LOG)) && !defined(MSWINCE)
STATIC int GC_stdout = GC_DEFAULT_STDOUT_FD;
STATIC int GC_stderr = GC_DEFAULT_STDERR_FD;
STATIC int GC_log = GC_DEFAULT_STDERR_FD;
# ifndef MSWIN32
GC_API void GC_CALL GC_set_log_fd(int fd)
{
GC_log = fd;
}
# endif
#endif
#ifdef MSGBOX_ON_ERROR
STATIC void GC_win32_MessageBoxA(const char *msg, const char *caption,
unsigned flags)
{
# ifndef DONT_USE_USER32_DLL
/* Use static binding to "user32.dll". */
(void)MessageBoxA(NULL, msg, caption, flags);
# else
/* This simplifies linking - resolve "MessageBoxA" at run-time. */
HINSTANCE hU32 = LoadLibrary(TEXT("user32.dll"));
if (hU32) {
FARPROC pfn = GetProcAddress(hU32, "MessageBoxA");
if (pfn)
(void)(*(int (WINAPI *)(HWND, LPCSTR, LPCSTR, UINT))
(GC_funcptr_uint)pfn)(NULL /* hWnd */, msg, caption, flags);
(void)FreeLibrary(hU32);
}
# endif
}
#endif /* MSGBOX_ON_ERROR */
#if defined(THREADS) && defined(UNIX_LIKE) && !defined(NO_GETCONTEXT)
static void callee_saves_pushed_dummy_fn(ptr_t data, void *context)
{
UNUSED_ARG(data);
UNUSED_ARG(context);
}
#endif
#ifdef MANUAL_VDB
static GC_bool manual_vdb_allowed = TRUE;
#else
static GC_bool manual_vdb_allowed = FALSE;
#endif
GC_API void GC_CALL GC_set_manual_vdb_allowed(int value)
{
manual_vdb_allowed = (GC_bool)value;
}
GC_API int GC_CALL GC_get_manual_vdb_allowed(void)
{
return (int)manual_vdb_allowed;
}
GC_API unsigned GC_CALL GC_get_supported_vdbs(void)
{
# ifdef GC_DISABLE_INCREMENTAL
return GC_VDB_NONE;
# else
# if defined(CPPCHECK)
volatile unsigned zero = 0;
return zero /* workaround a warning of redundant "or 0" */
# else
return 0
# endif
# ifndef NO_MANUAL_VDB
| GC_VDB_MANUAL
# endif
# ifdef DEFAULT_VDB
| GC_VDB_DEFAULT
# endif
# ifdef MPROTECT_VDB
| GC_VDB_MPROTECT
# endif
# ifdef GWW_VDB
| GC_VDB_GWW
# endif
# ifdef PCR_VDB
| GC_VDB_PCR
# endif
# ifdef PROC_VDB
| GC_VDB_PROC
# endif
# ifdef SOFT_VDB
| GC_VDB_SOFT
# endif
;
# endif
}
#ifndef GC_DISABLE_INCREMENTAL
static void set_incremental_mode_on(void)
{
GC_ASSERT(I_HOLD_LOCK());
# ifndef NO_MANUAL_VDB
if (manual_vdb_allowed) {
GC_manual_vdb = TRUE;
GC_incremental = TRUE;
} else
# endif
/* else */ {
/* For GWW_VDB on Win32, this needs to happen before any */
/* heap memory is allocated. */
GC_incremental = GC_dirty_init();
}
}
#endif /* !GC_DISABLE_INCREMENTAL */
STATIC word GC_parse_mem_size_arg(const char *str)
{
word result;
char *endptr;
char ch;
if ('\0' == *str) return GC_WORD_MAX; /* bad value */
result = (word)STRTOULL(str, &endptr, 10);
ch = *endptr;
if (ch != '\0') {
if (*(endptr + 1) != '\0') return GC_WORD_MAX;
/* Allow k, M or G suffix. */
switch (ch) {
case 'K':
case 'k':
result <<= 10;
break;
# if CPP_WORDSZ >= 32
case 'M':
case 'm':
result <<= 20;
break;
case 'G':
case 'g':
result <<= 30;
break;
# endif
default:
result = GC_WORD_MAX;
}
}
return result;
}
#define GC_LOG_STD_NAME "gc.log"
GC_API void GC_CALL GC_init(void)
{
/* LOCK(); -- no longer does anything this early. */
word initial_heap_sz;
IF_CANCEL(int cancel_state;)
if (EXPECT(GC_is_initialized, TRUE)) return;
# ifdef REDIRECT_MALLOC
{
static GC_bool init_started = FALSE;