-
Notifications
You must be signed in to change notification settings - Fork 412
/
Copy pathdbg_mlc.c
1274 lines (1145 loc) · 36.2 KB
/
dbg_mlc.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-1995 by Xerox Corporation. All rights reserved.
* Copyright (c) 1997 by Silicon Graphics. All rights reserved.
* Copyright (c) 1999-2004 Hewlett-Packard Development Company, L.P.
* Copyright (c) 2007 Free Software Foundation, Inc.
* 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/dbg_mlc.h"
#ifndef MSWINCE
# include <errno.h>
#endif
#include <string.h>
#ifndef SHORT_DBG_HDRS
/* Check whether object given by its base pointer has debugging */
/* info. base is assumed to point to a legitimate object in our */
/* heap. This excludes the check as to whether the back pointer */
/* is odd, which is added by the GC_HAS_DEBUG_INFO macro. */
/* Note that if DBG_HDRS_ALL is set, uncollectible objects on */
/* free lists may not have debug information set. Thus, it is */
/* not always safe to return TRUE (1), even if the client does */
/* its part. Return -1 if the object with debug info has been */
/* marked as deallocated. */
GC_INNER int
GC_has_other_debug_info(ptr_t base)
{
ptr_t body = (ptr_t)((oh *)base + 1);
size_t sz = GC_size(base);
if (HBLKPTR(base) != HBLKPTR(body) || sz < DEBUG_BYTES + EXTRA_BYTES) {
return 0;
}
if (((oh *)base)->oh_sf != (START_FLAG ^ (GC_uintptr_t)body)
&& ((GC_uintptr_t *)base)[BYTES_TO_PTRS(sz) - 1]
!= (END_FLAG ^ (GC_uintptr_t)body)) {
return 0;
}
if (((oh *)base)->oh_sz == (GC_uintptr_t)sz) {
/* Object may have had debug info, but has been deallocated. */
return -1;
}
return 1;
}
#endif /* !SHORT_DBG_HDRS */
#ifdef KEEP_BACK_PTRS
/* Use a custom trivial random() implementation as the standard */
/* one might lead to crashes (if used from a multi-threaded code) */
/* or to a compiler warning about the deterministic result. */
static int
GC_rand(void)
{
static GC_RAND_STATE_T seed;
return GC_RAND_NEXT(&seed);
}
# define RANDOM() (long)GC_rand()
/* Store back pointer to source in dest, if that appears to be possible. */
/* This is not completely safe, since we may mistakenly conclude that */
/* dest has a debugging wrapper. But the error probability is very */
/* small, and this shouldn't be used in production code. */
/* We assume that dest is the real base pointer. Source will usually */
/* be a pointer to the interior of an object. */
GC_INNER void
GC_store_back_pointer(ptr_t source, ptr_t dest)
{
if (GC_HAS_DEBUG_INFO(dest)) {
# ifdef PARALLEL_MARK
GC_cptr_store((volatile ptr_t *)&((oh *)dest)->oh_back_ptr,
(ptr_t)HIDE_BACK_PTR(source));
# else
((oh *)dest)->oh_back_ptr = HIDE_BACK_PTR(source);
# endif
}
}
GC_INNER void
GC_marked_for_finalization(ptr_t dest)
{
GC_store_back_pointer(MARKED_FOR_FINALIZATION, dest);
}
GC_API GC_ref_kind GC_CALL
GC_get_back_ptr_info(void *dest, void **base_p, size_t *offset_p)
{
oh *ohdr = (oh *)GC_base(dest);
ptr_t bp, bp_base;
# ifdef LINT2
/* Explicitly instruct the code analysis tool that */
/* GC_get_back_ptr_info is not expected to be called with an */
/* incorrect "dest" value. */
if (!ohdr)
ABORT("Invalid GC_get_back_ptr_info argument");
# endif
if (!GC_HAS_DEBUG_INFO((ptr_t)ohdr))
return GC_NO_SPACE;
bp = (ptr_t)GC_REVEAL_POINTER(ohdr->oh_back_ptr);
if (MARKED_FOR_FINALIZATION == bp)
return GC_FINALIZER_REFD;
if (MARKED_FROM_REGISTER == bp)
return GC_REFD_FROM_REG;
if (NOT_MARKED == bp)
return GC_UNREFERENCED;
# if ALIGNMENT == 1
/* Heuristically try to fix off-by-one errors we introduced by */
/* insisting on even addresses. */
{
ptr_t alternate_ptr = bp + 1;
ptr_t target = *(ptr_t *)bp;
ptr_t alternate_target = *(ptr_t *)alternate_ptr;
if (GC_least_real_heap_addr < ADDR(alternate_target)
&& ADDR(alternate_target) < GC_greatest_real_heap_addr
&& (GC_least_real_heap_addr >= ADDR(target)
|| ADDR(target) >= GC_greatest_real_heap_addr)) {
bp = alternate_ptr;
}
}
# endif
bp_base = (ptr_t)GC_base(bp);
if (NULL == bp_base) {
*base_p = bp;
*offset_p = 0;
return GC_REFD_FROM_ROOT;
} else {
if (GC_HAS_DEBUG_INFO(bp_base))
bp_base += sizeof(oh);
*base_p = bp_base;
*offset_p = (size_t)(bp - bp_base);
return GC_REFD_FROM_HEAP;
}
}
/* Generate a random heap address. The resulting address is in the */
/* heap, but not necessarily inside a valid object. */
GC_API void *GC_CALL
GC_generate_random_heap_address(void)
{
size_t i;
word heap_offset = (word)RANDOM();
if (GC_heapsize > (word)GC_RAND_MAX) {
heap_offset *= GC_RAND_MAX;
heap_offset += (word)RANDOM();
}
/* This does not yield a uniform distribution, especially if e.g. */
/* RAND_MAX is 1.5*GC_heapsize. But for typical cases, it is not */
/* too bad. */
heap_offset %= GC_heapsize;
for (i = 0;; ++i) {
size_t size;
if (i >= GC_n_heap_sects)
ABORT("GC_generate_random_heap_address: size inconsistency");
size = GC_heap_sects[i].hs_bytes;
if (heap_offset < size)
break;
heap_offset -= size;
}
return GC_heap_sects[i].hs_start + heap_offset;
}
/* Generate a random address inside a valid marked heap object. */
GC_API void *GC_CALL
GC_generate_random_valid_address(void)
{
ptr_t result;
ptr_t base;
do {
result = (ptr_t)GC_generate_random_heap_address();
base = (ptr_t)GC_base(result);
} while (NULL == base || !GC_is_marked(base));
return result;
}
GC_API void GC_CALL
GC_print_backtrace(void *p)
{
void *current = p;
int i;
GC_ASSERT(I_DONT_HOLD_LOCK());
GC_print_heap_obj((ptr_t)GC_base(current));
for (i = 0;; ++i) {
void *base;
size_t offset;
GC_ref_kind source = GC_get_back_ptr_info(current, &base, &offset);
if (GC_UNREFERENCED == source) {
GC_err_printf("Reference could not be found\n");
break;
}
if (GC_NO_SPACE == source) {
GC_err_printf("No debug info in object: Can't find reference\n");
break;
}
GC_err_printf("Reachable via %d levels of pointers from ", i);
switch (source) {
case GC_REFD_FROM_ROOT:
GC_err_printf("root at %p\n\n", base);
return;
case GC_REFD_FROM_REG:
GC_err_printf("root in register\n\n");
return;
case GC_FINALIZER_REFD:
GC_err_printf("list of finalizable objects\n\n");
return;
case GC_REFD_FROM_HEAP:
GC_err_printf("offset %ld in object:\n", (long)offset);
/* Take GC_base(base) to get real base, i.e. header. */
GC_print_heap_obj((ptr_t)GC_base(base));
break;
default:
GC_err_printf("INTERNAL ERROR: UNEXPECTED SOURCE!!!!\n");
return;
}
current = base;
}
}
GC_API void GC_CALL
GC_generate_random_backtrace(void)
{
void *current;
GC_ASSERT(I_DONT_HOLD_LOCK());
if (GC_try_to_collect(GC_never_stop_func) == 0) {
GC_err_printf("Cannot generate a backtrace: "
"garbage collection is disabled!\n");
return;
}
/* Generate/print a backtrace from a random heap address. */
LOCK();
current = GC_generate_random_valid_address();
UNLOCK();
GC_printf("\n***Chosen address %p in object\n", current);
GC_print_backtrace(current);
}
#endif /* KEEP_BACK_PTRS */
#define CROSSES_HBLK(p, sz) \
((ADDR((p) + (sizeof(oh) - 1) + (sz)) ^ ADDR(p)) >= HBLKSIZE)
GC_INNER void *
GC_store_debug_info_inner(void *base, size_t sz, const char *string,
int linenum)
{
GC_uintptr_t *result = (GC_uintptr_t *)((oh *)base + 1);
GC_ASSERT(I_HOLD_LOCK());
GC_ASSERT(GC_size(base) >= sizeof(oh) + sz);
GC_ASSERT(!(SMALL_OBJ(sz) && CROSSES_HBLK((ptr_t)base, sz)));
#ifdef KEEP_BACK_PTRS
((oh *)base)->oh_back_ptr = HIDE_BACK_PTR(NOT_MARKED);
#endif
#ifdef MAKE_BACK_GRAPH
((oh *)base)->oh_bg_ptr = HIDE_BACK_PTR((ptr_t)0);
#endif
((oh *)base)->oh_string = string;
((oh *)base)->oh_int = linenum;
#ifdef SHORT_DBG_HDRS
UNUSED_ARG(sz);
#else
((oh *)base)->oh_sz = (GC_uintptr_t)sz;
((oh *)base)->oh_sf = START_FLAG ^ (GC_uintptr_t)result;
((GC_uintptr_t *)base)[BYTES_TO_PTRS(GC_size(base)) - 1]
= result[BYTES_TO_PTRS_ROUNDUP(sz)] = END_FLAG ^ (GC_uintptr_t)result;
#endif
return result;
}
/* Check the allocation is successful, store debugging info into base, */
/* start the debugging mode (if not yet), and return displaced pointer. */
static void *
store_debug_info(void *base, size_t lb, const char *fn, GC_EXTRA_PARAMS)
{
void *result;
if (NULL == base) {
GC_err_printf("%s(%lu) returning NULL (%s:%d)\n", fn, (unsigned long)lb, s,
i);
return NULL;
}
LOCK();
if (!GC_debugging_started)
GC_start_debugging_inner();
result = GC_store_debug_info_inner(base, lb, s, i);
ADD_CALL_CHAIN(base, ra);
UNLOCK();
return result;
}
#ifndef SHORT_DBG_HDRS
/* Check the object with debugging info at ohdr. Return NULL if it */
/* is OK. Else return clobbered address. */
STATIC ptr_t
GC_check_annotated_obj(oh *ohdr)
{
ptr_t body = (ptr_t)(ohdr + 1);
size_t gc_sz = GC_size(ohdr);
size_t lpw_up;
if (ohdr->oh_sz + DEBUG_BYTES > (GC_uintptr_t)gc_sz) {
return (ptr_t)(&ohdr->oh_sz);
}
if (ohdr->oh_sf != (START_FLAG ^ (GC_uintptr_t)body)) {
return (ptr_t)(&ohdr->oh_sf);
}
{
size_t lpw_m1 = BYTES_TO_PTRS(gc_sz) - 1;
if (((GC_uintptr_t *)ohdr)[lpw_m1] != (END_FLAG ^ (GC_uintptr_t)body)) {
return (ptr_t)(&((GC_uintptr_t *)ohdr)[lpw_m1]);
}
}
lpw_up = BYTES_TO_PTRS_ROUNDUP((size_t)ohdr->oh_sz);
if (((GC_uintptr_t *)body)[lpw_up] != (END_FLAG ^ (GC_uintptr_t)body)) {
return (ptr_t)(&((GC_uintptr_t *)body)[lpw_up]);
}
return NULL;
}
#endif /* !SHORT_DBG_HDRS */
STATIC GC_describe_type_fn GC_describe_type_fns[MAXOBJKINDS] = { 0 };
GC_API void GC_CALL
GC_register_describe_type_fn(int k, GC_describe_type_fn fn)
{
GC_ASSERT((unsigned)k < MAXOBJKINDS);
GC_describe_type_fns[k] = fn;
}
#define GET_OH_LINENUM(ohdr) ((int)(ohdr)->oh_int)
#ifndef SHORT_DBG_HDRS
# define IF_NOT_SHORTDBG_HDRS(x) x
# define COMMA_IFNOT_SHORTDBG_HDRS(x) /* comma */ , x
#else
# define IF_NOT_SHORTDBG_HDRS(x)
# define COMMA_IFNOT_SHORTDBG_HDRS(x)
#endif
/* Print a human-readable description of the object to stderr. */
/* The object is assumed to have the debugging info. */
STATIC void
GC_print_obj(ptr_t base)
{
oh *ohdr = (oh *)base;
ptr_t q;
hdr *hhdr;
int k;
const char *kind_str;
char buffer[GC_TYPE_DESCR_LEN + 1];
GC_ASSERT(I_DONT_HOLD_LOCK());
#ifdef LINT2
if (!ohdr)
ABORT("Invalid GC_print_obj argument");
#endif
q = (ptr_t)(ohdr + 1);
/* Print a type description for the object whose client-visible */
/* address is q. */
hhdr = GC_find_header(q);
k = hhdr->hb_obj_kind;
if (GC_describe_type_fns[k] != 0 && GC_is_marked(ohdr)) {
/* This should preclude free-list objects except with */
/* thread-local allocation. */
buffer[GC_TYPE_DESCR_LEN] = 0;
(GC_describe_type_fns[k])(q, buffer);
GC_ASSERT(buffer[GC_TYPE_DESCR_LEN] == 0);
kind_str = buffer;
} else {
switch (k) {
case PTRFREE:
kind_str = "PTRFREE";
break;
case NORMAL:
kind_str = "NORMAL";
break;
case UNCOLLECTABLE:
kind_str = "UNCOLLECTABLE";
break;
#ifdef GC_ATOMIC_UNCOLLECTABLE
case AUNCOLLECTABLE:
kind_str = "ATOMIC_UNCOLLECTABLE";
break;
#endif
default:
kind_str = NULL;
/* The alternative is to use snprintf(buffer) but the */
/* latter is not quite portable (see vsnprintf in misc.c). */
}
}
if (NULL != kind_str) {
GC_err_printf("%p (%s:%d," IF_NOT_SHORTDBG_HDRS(" sz= %lu,") " %s)\n",
(void *)((ptr_t)ohdr + sizeof(oh)), ohdr->oh_string,
GET_OH_LINENUM(ohdr) /*, */
COMMA_IFNOT_SHORTDBG_HDRS((unsigned long)ohdr->oh_sz),
kind_str);
} else {
GC_err_printf("%p (%s:%d," IF_NOT_SHORTDBG_HDRS(
" sz= %lu,") " kind= %d, descr= 0x%lx)\n",
(void *)((ptr_t)ohdr + sizeof(oh)), ohdr->oh_string,
GET_OH_LINENUM(ohdr) /*, */
COMMA_IFNOT_SHORTDBG_HDRS((unsigned long)ohdr->oh_sz),
k, (unsigned long)hhdr->hb_descr);
}
PRINT_CALL_CHAIN(ohdr);
}
STATIC void
GC_default_print_heap_obj_proc(ptr_t p)
{
ptr_t base = (ptr_t)GC_base(p);
int kind = HDR(base)->hb_obj_kind;
GC_err_printf("object at %p of appr. %lu bytes (%s)\n", (void *)base,
(unsigned long)GC_size(base),
kind == PTRFREE ? "atomic"
: IS_UNCOLLECTABLE(kind) ? "uncollectable"
: "composite");
}
GC_INNER void (*GC_print_heap_obj)(ptr_t p) = GC_default_print_heap_obj_proc;
STATIC void
GC_debug_print_heap_obj_proc(ptr_t base)
{
GC_ASSERT(I_DONT_HOLD_LOCK());
if (GC_HAS_DEBUG_INFO(base)) {
GC_print_obj(base);
} else {
GC_default_print_heap_obj_proc(base);
}
}
#ifndef SHORT_DBG_HDRS
/* Use GC_err_printf and friends to print a description of the object */
/* whose client-visible address is p, and which was smashed at memory */
/* location pointed by clobbered. */
STATIC void
GC_print_smashed_obj(const char *msg, void *p, ptr_t clobbered)
{
oh *ohdr = (oh *)GC_base(p);
GC_ASSERT(I_DONT_HOLD_LOCK());
# ifdef LINT2
if (!ohdr)
ABORT("Invalid GC_print_smashed_obj argument");
# endif
if (ADDR_GE((ptr_t)(&ohdr->oh_sz), clobbered) || NULL == ohdr->oh_string) {
GC_err_printf("%s %p in or near object at %p(<smashed>, appr. sz= %lu)\n",
msg, (void *)clobbered, p,
(unsigned long)(GC_size(ohdr) - DEBUG_BYTES));
} else {
GC_err_printf("%s %p in or near object at %p (%s:%d, sz= %lu)\n", msg,
(void *)clobbered, p,
ADDR(ohdr->oh_string) < HBLKSIZE ? "(smashed string)"
: ohdr->oh_string[0] == '\0' ? "EMPTY(smashed?)"
: ohdr->oh_string,
GET_OH_LINENUM(ohdr), (unsigned long)ohdr->oh_sz);
PRINT_CALL_CHAIN(ohdr);
}
}
STATIC void GC_check_heap_proc(void);
STATIC void GC_print_all_smashed_proc(void);
#else
STATIC void
GC_do_nothing(void)
{
}
#endif /* SHORT_DBG_HDRS */
GC_INNER void
GC_start_debugging_inner(void)
{
GC_ASSERT(I_HOLD_LOCK());
#ifndef SHORT_DBG_HDRS
GC_check_heap = GC_check_heap_proc;
GC_print_all_smashed = GC_print_all_smashed_proc;
#else
GC_check_heap = GC_do_nothing;
GC_print_all_smashed = GC_do_nothing;
#endif
GC_print_heap_obj = GC_debug_print_heap_obj_proc;
GC_debugging_started = TRUE;
GC_register_displacement_inner(sizeof(oh));
#if defined(CPPCHECK)
GC_noop1(GC_debug_header_size);
#endif
}
const size_t GC_debug_header_size = sizeof(oh);
GC_API size_t GC_CALL
GC_get_debug_header_size(void)
{
return sizeof(oh);
}
GC_API void GC_CALL
GC_debug_register_displacement(size_t offset)
{
LOCK();
GC_register_displacement_inner(offset);
GC_register_displacement_inner(sizeof(oh) + offset);
UNLOCK();
}
#ifdef GC_ADD_CALLER
# if defined(HAVE_DLADDR) && defined(GC_HAVE_RETURN_ADDR_PARENT) \
&& defined(FUNCPTR_IS_DATAPTR)
# include <dlfcn.h>
STATIC void
GC_caller_func_offset(GC_return_addr_t ra, const char **symp, int *offp)
{
Dl_info caller;
if (ra != 0 && dladdr((void *)ra, &caller) && caller.dli_sname != NULL) {
*symp = caller.dli_sname;
*offp = (int)((ptr_t)ra - (ptr_t)caller.dli_saddr);
}
if (NULL == *symp) {
*symp = "unknown";
/* Note: *offp is unchanged. */
}
}
# else
# define GC_caller_func_offset(ra, symp, offp) (void)(*(symp) = "unknown")
# endif
#endif /* GC_ADD_CALLER */
GC_API GC_ATTR_MALLOC void *GC_CALL
GC_debug_malloc(size_t lb, GC_EXTRA_PARAMS)
{
void *base;
/* Note that according to malloc() specification, if size is 0 then */
/* malloc() returns either NULL, or a unique pointer value that can */
/* later be successfully passed to free(). We always do the latter. */
#if defined(_FORTIFY_SOURCE) && !defined(__clang__)
/* Workaround to avoid "exceeds maximum object size" gcc warning. */
base = GC_malloc(lb < GC_SIZE_MAX - DEBUG_BYTES ? lb + DEBUG_BYTES
: GC_SIZE_MAX >> 1);
#else
base = GC_malloc(SIZET_SAT_ADD(lb, DEBUG_BYTES));
#endif
#ifdef GC_ADD_CALLER
if (NULL == s) {
GC_caller_func_offset(ra, &s, &i);
}
#endif
return store_debug_info(base, lb, "GC_debug_malloc", OPT_RA s, i);
}
GC_API GC_ATTR_MALLOC void *GC_CALL
GC_debug_malloc_ignore_off_page(size_t lb, GC_EXTRA_PARAMS)
{
void *base = GC_malloc_ignore_off_page(SIZET_SAT_ADD(lb, DEBUG_BYTES));
return store_debug_info(base, lb, "GC_debug_malloc_ignore_off_page",
OPT_RA s, i);
}
GC_API GC_ATTR_MALLOC void *GC_CALL
GC_debug_malloc_atomic_ignore_off_page(size_t lb, GC_EXTRA_PARAMS)
{
void *base
= GC_malloc_atomic_ignore_off_page(SIZET_SAT_ADD(lb, DEBUG_BYTES));
return store_debug_info(base, lb, "GC_debug_malloc_atomic_ignore_off_page",
OPT_RA s, i);
}
STATIC void *
GC_debug_generic_malloc(size_t lb, int k, GC_EXTRA_PARAMS)
{
void *base = GC_generic_malloc_aligned(SIZET_SAT_ADD(lb, DEBUG_BYTES), k,
0 /* flags */, 0 /* align_m1 */);
return store_debug_info(base, lb, "GC_debug_generic_malloc", OPT_RA s, i);
}
#ifdef DBG_HDRS_ALL
/* An allocation function for internal use. Normally internally */
/* allocated objects do not have debug information. But in this */
/* case, we need to make sure that all objects have debug headers. */
GC_INNER void *
GC_debug_generic_malloc_inner(size_t lb, int k, unsigned flags)
{
void *base, *result;
GC_ASSERT(I_HOLD_LOCK());
base = GC_generic_malloc_inner(SIZET_SAT_ADD(lb, DEBUG_BYTES), k, flags);
if (NULL == base) {
GC_err_printf("GC internal allocation (%lu bytes) returning NULL\n",
(unsigned long)lb);
return NULL;
}
if (!GC_debugging_started)
GC_start_debugging_inner();
result = GC_store_debug_info_inner(base, lb, "INTERNAL", 0);
ADD_CALL_CHAIN_INNER(base);
return result;
}
#endif /* DBG_HDRS_ALL */
#ifndef CPPCHECK
GC_API void *GC_CALL
GC_debug_malloc_stubborn(size_t lb, GC_EXTRA_PARAMS)
{
return GC_debug_malloc(lb, OPT_RA s, i);
}
GC_API void GC_CALL
GC_debug_change_stubborn(const void *p)
{
UNUSED_ARG(p);
}
#endif /* !CPPCHECK */
GC_API void GC_CALL
GC_debug_end_stubborn_change(const void *p)
{
const void *q = GC_base_C(p);
if (NULL == q) {
ABORT_ARG1("GC_debug_end_stubborn_change: bad arg", ": %p", p);
}
GC_end_stubborn_change(q);
}
GC_API void GC_CALL
GC_debug_ptr_store_and_dirty(void *p, const void *q)
{
*(void **)GC_is_visible(p)
= GC_is_valid_displacement(GC_CAST_AWAY_CONST_PVOID(q));
GC_debug_end_stubborn_change(p);
REACHABLE_AFTER_DIRTY(q);
}
GC_API GC_ATTR_MALLOC void *GC_CALL
GC_debug_malloc_atomic(size_t lb, GC_EXTRA_PARAMS)
{
void *base = GC_malloc_atomic(SIZET_SAT_ADD(lb, DEBUG_BYTES));
return store_debug_info(base, lb, "GC_debug_malloc_atomic", OPT_RA s, i);
}
GC_API GC_ATTR_MALLOC char *GC_CALL
GC_debug_strdup(const char *str, GC_EXTRA_PARAMS)
{
char *copy;
size_t lb;
if (str == NULL) {
if (GC_find_leak)
GC_err_printf("strdup(NULL) behavior is undefined\n");
return NULL;
}
lb = strlen(str) + 1;
copy = (char *)GC_debug_malloc_atomic(lb, OPT_RA s, i);
if (copy == NULL) {
#ifndef MSWINCE
errno = ENOMEM;
#endif
return NULL;
}
BCOPY(str, copy, lb);
return copy;
}
GC_API GC_ATTR_MALLOC char *GC_CALL
GC_debug_strndup(const char *str, size_t size, GC_EXTRA_PARAMS)
{
char *copy;
size_t len = strlen(str); /* str is expected to be non-NULL */
if (len > size)
len = size;
copy = (char *)GC_debug_malloc_atomic(len + 1, OPT_RA s, i);
if (copy == NULL) {
#ifndef MSWINCE
errno = ENOMEM;
#endif
return NULL;
}
if (len > 0)
BCOPY(str, copy, len);
copy[len] = '\0';
return copy;
}
#ifdef GC_REQUIRE_WCSDUP
# include <wchar.h> /* for wcslen() */
GC_API GC_ATTR_MALLOC wchar_t *GC_CALL
GC_debug_wcsdup(const wchar_t *str, GC_EXTRA_PARAMS)
{
size_t lb = (wcslen(str) + 1) * sizeof(wchar_t);
wchar_t *copy = (wchar_t *)GC_debug_malloc_atomic(lb, OPT_RA s, i);
if (copy == NULL) {
# ifndef MSWINCE
errno = ENOMEM;
# endif
return NULL;
}
BCOPY(str, copy, lb);
return copy;
}
#endif /* GC_REQUIRE_WCSDUP */
GC_API GC_ATTR_MALLOC void *GC_CALL
GC_debug_malloc_uncollectable(size_t lb, GC_EXTRA_PARAMS)
{
void *base
= GC_malloc_uncollectable(SIZET_SAT_ADD(lb, UNCOLLECTABLE_DEBUG_BYTES));
return store_debug_info(base, lb, "GC_debug_malloc_uncollectable", OPT_RA s,
i);
}
#ifdef GC_ATOMIC_UNCOLLECTABLE
GC_API GC_ATTR_MALLOC void *GC_CALL
GC_debug_malloc_atomic_uncollectable(size_t lb, GC_EXTRA_PARAMS)
{
void *base = GC_malloc_atomic_uncollectable(
SIZET_SAT_ADD(lb, UNCOLLECTABLE_DEBUG_BYTES));
return store_debug_info(base, lb, "GC_debug_malloc_atomic_uncollectable",
OPT_RA s, i);
}
#endif /* GC_ATOMIC_UNCOLLECTABLE */
#ifdef LINT2
# include "private/gc_alloc_ptrs.h"
#endif
GC_API void GC_CALL
GC_debug_free(void *p)
{
ptr_t base;
if (0 == p)
return;
base = (ptr_t)GC_base(p);
if (NULL == base) {
#if defined(REDIRECT_MALLOC) \
&& ((defined(NEED_CALLINFO) && defined(GC_HAVE_BUILTIN_BACKTRACE)) \
|| defined(REDIR_MALLOC_AND_LINUXTHREADS) \
|| (defined(SOLARIS) && defined(THREADS)) || defined(MSWIN32))
/* In some cases, we should ignore objects that do not belong */
/* to the GC heap. See the comment in GC_free. */
if (!GC_is_heap_ptr(p))
return;
#endif
ABORT_ARG1("Invalid pointer passed to free()", ": %p", p);
}
if ((word)((ptr_t)p - base) != sizeof(oh)) {
#if defined(REDIRECT_FREE) && defined(USE_PROC_FOR_LIBRARIES)
/* TODO: Suppress the warning if free() caller is in libpthread */
/* or libdl. */
#endif
/* TODO: Suppress the warning for objects allocated by */
/* GC_memalign and friends (these ones do not have the debugging */
/* counterpart). */
GC_err_printf("GC_debug_free called on pointer %p w/o debugging info\n",
p);
} else {
#ifndef SHORT_DBG_HDRS
ptr_t clobbered = GC_check_annotated_obj((oh *)base);
size_t sz = GC_size(base);
if (clobbered != NULL) {
GC_SET_HAVE_ERRORS(); /* no "release" barrier is needed */
if (((oh *)base)->oh_sz == (GC_uintptr_t)sz) {
GC_print_smashed_obj(
"GC_debug_free: found previously deallocated (?) object at", p,
clobbered);
return; /* ignore double free */
} else {
GC_print_smashed_obj("GC_debug_free: found smashed location at", p,
clobbered);
}
}
/* Invalidate size (mark the object as deallocated). */
((oh *)base)->oh_sz = (GC_uintptr_t)sz;
#endif /* !SHORT_DBG_HDRS */
}
if (GC_find_leak
#ifndef SHORT_DBG_HDRS
&& ((word)((ptr_t)p - base) != sizeof(oh) || !GC_findleak_delay_free)
#endif
) {
GC_free(base);
} else {
const hdr *hhdr = HDR(p);
if (hhdr->hb_obj_kind == UNCOLLECTABLE
#ifdef GC_ATOMIC_UNCOLLECTABLE
|| hhdr->hb_obj_kind == AUNCOLLECTABLE
#endif
) {
GC_free(base);
} else {
size_t sz = hhdr->hb_sz;
size_t i;
size_t lpw = BYTES_TO_PTRS(sz - sizeof(oh));
for (i = 0; i < lpw; ++i)
((GC_uintptr_t *)p)[i] = GC_FREED_MEM_MARKER;
GC_ASSERT((GC_uintptr_t *)p + i == (GC_uintptr_t *)(base + sz));
/* Update the counter even though the real deallocation */
/* is deferred. */
LOCK();
#ifdef LINT2
GC_incr_bytes_freed(sz);
#else
GC_bytes_freed += sz;
#endif
UNLOCK();
}
} /* !GC_find_leak */
}
#if defined(THREADS) && defined(DBG_HDRS_ALL)
/* Used internally; we assume it's called correctly. */
GC_INNER void
GC_debug_free_inner(void *p)
{
ptr_t base = (ptr_t)GC_base(p);
GC_ASSERT(I_HOLD_LOCK());
GC_ASSERT((word)((ptr_t)p - base) == sizeof(oh));
# ifdef LINT2
if (!base)
ABORT("Invalid GC_debug_free_inner argument");
# endif
# ifndef SHORT_DBG_HDRS
/* Invalidate size. */
((oh *)base)->oh_sz = (GC_uintptr_t)GC_size(base);
# endif
GC_free_inner(base);
}
#endif
GC_API void *GC_CALL
GC_debug_realloc(void *p, size_t lb, GC_EXTRA_PARAMS)
{
ptr_t base;
void *result;
const hdr *hhdr;
if (NULL == p) {
return GC_debug_malloc(lb, OPT_RA s, i);
}
if (0 == lb) /* and p != NULL */ {
GC_debug_free(p);
return NULL;
}
#ifdef GC_ADD_CALLER
if (NULL == s) {
GC_caller_func_offset(ra, &s, &i);
}
#endif
base = (ptr_t)GC_base(p);
if (NULL == base) {
ABORT_ARG1("Invalid pointer passed to realloc()", ": %p", p);
}
if ((word)((ptr_t)p - base) != sizeof(oh)) {
GC_err_printf("GC_debug_realloc called on pointer %p w/o debugging info\n",
p);
return GC_realloc(p, lb);
}
hhdr = HDR(base);
result
= GC_debug_generic_or_special_malloc(lb, hhdr->hb_obj_kind, OPT_RA s, i);
if (result != NULL) {
size_t old_sz;
#ifdef SHORT_DBG_HDRS
old_sz = GC_size(base) - sizeof(oh);
#else
old_sz = (size_t)(((oh *)base)->oh_sz);
#endif
if (old_sz > 0)
BCOPY(p, result, old_sz < lb ? old_sz : lb);
GC_debug_free(p);
}
return result;
}
GC_API GC_ATTR_MALLOC void *GC_CALL
GC_debug_generic_or_special_malloc(size_t lb, int k, GC_EXTRA_PARAMS)
{
switch (k) {
case PTRFREE:
return GC_debug_malloc_atomic(lb, OPT_RA s, i);
case NORMAL:
return GC_debug_malloc(lb, OPT_RA s, i);
case UNCOLLECTABLE:
return GC_debug_malloc_uncollectable(lb, OPT_RA s, i);
#ifdef GC_ATOMIC_UNCOLLECTABLE
case AUNCOLLECTABLE:
return GC_debug_malloc_atomic_uncollectable(lb, OPT_RA s, i);
#endif
default:
return GC_debug_generic_malloc(lb, k, OPT_RA s, i);
}
}
#ifndef SHORT_DBG_HDRS
# ifndef MAX_SMASHED
# define MAX_SMASHED 20
# endif
/* List of smashed (clobbered) locations. We defer printing these, */
/* since we cannot always print them nicely with the allocator lock */
/* held. We put them here instead of in GC_arrays, since it may be */
/* useful to be able to look at them with the debugger. */
STATIC ptr_t GC_smashed[MAX_SMASHED] = { 0 };
STATIC unsigned GC_n_smashed = 0;
STATIC void
GC_add_smashed(ptr_t smashed)
{
GC_ASSERT(I_HOLD_LOCK());
GC_ASSERT(GC_is_marked(GC_base(smashed)));
/* FIXME: Prevent adding an object while printing smashed list. */
GC_smashed[GC_n_smashed] = smashed;
/* In case of overflow, we keep the first MAX_SMASHED-1 entries */
/* plus the last one. */
if (GC_n_smashed < MAX_SMASHED - 1)
++GC_n_smashed;
GC_SET_HAVE_ERRORS();
}
/* Print all objects on the list. Clear the list. */
STATIC void
GC_print_all_smashed_proc(void)
{
unsigned i;
GC_ASSERT(I_DONT_HOLD_LOCK());
if (GC_n_smashed == 0)
return;
GC_err_printf("GC_check_heap_block: found %u smashed heap objects:\n",
GC_n_smashed);
for (i = 0; i < GC_n_smashed; ++i) {
ptr_t base = (ptr_t)GC_base(GC_smashed[i]);
# ifdef LINT2
if (!base)
ABORT("Invalid GC_smashed element");
# endif
GC_print_smashed_obj("", base + sizeof(oh), GC_smashed[i]);
GC_smashed[i] = 0;
}
GC_n_smashed = 0;
}
/* Check all marked objects in the given block for validity */
/* Avoid GC_apply_to_each_object for performance reasons. */
STATIC void GC_CALLBACK
GC_check_heap_block(struct hblk *hbp, void *dummy)
{
const hdr *hhdr = HDR(hbp);
ptr_t p = hbp->hb_body;
ptr_t plim;
size_t sz = hhdr->hb_sz;
size_t bit_no;
UNUSED_ARG(dummy);