-
Notifications
You must be signed in to change notification settings - Fork 314
/
memory.c
4998 lines (4422 loc) · 142 KB
/
memory.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
/*
* R : A Computer Language for Statistical Data Analysis
* Copyright (C) 1998--2024 The R Core Team.
* Copyright (C) 1995, 1996 Robert Gentleman and Ross Ihaka
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, a copy is available at
* https://www.R-project.org/Licenses/
*/
/*
* This code implements a non-moving generational collector
* with two or three generations.
*
* Memory allocated by R_alloc is maintained in a stack. Code
* that R_allocs memory must use vmaxget and vmaxset to obtain
* and reset the stack pointer.
*/
#define USE_RINTERNALS
#define COMPILING_MEMORY_C
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#include <stdarg.h>
#include <R_ext/RS.h> /* for S4 allocation */
#include <R_ext/Print.h>
/* Declarations for Valgrind.
These are controlled by the
--with-valgrind-instrumentation=
option to configure, which sets VALGRIND_LEVEL to the
supplied value (default 0) and defines NVALGRIND if
the value is 0.
level 0 is no additional instrumentation
level 1 marks uninitialized numeric, logical, integer, raw,
complex vectors and R_alloc memory
level 2 marks the data section of vector nodes as inaccessible
when they are freed.
level 3 was withdrawn in R 3.2.0.
It may be necessary to define NVALGRIND for a non-gcc
compiler on a supported architecture if it has different
syntax for inline assembly language from gcc.
For Win32, Valgrind is useful only if running under Wine.
*/
#ifdef Win32
# ifndef USE_VALGRIND_FOR_WINE
# define NVALGRIND 1
#endif
#endif
#ifndef VALGRIND_LEVEL
# define VALGRIND_LEVEL 0
#endif
#ifndef NVALGRIND
# include "valgrind/memcheck.h"
#endif
/* For speed in cases when the argument is known to not be an ALTREP list. */
#define VECTOR_ELT_0(x,i) ((SEXP *) STDVEC_DATAPTR(x))[i]
#define SET_VECTOR_ELT_0(x,i, v) (((SEXP *) STDVEC_DATAPTR(x))[i] = (v))
#define R_USE_SIGNALS 1
#include <Defn.h>
#include <Internal.h>
#include <R_ext/GraphicsEngine.h> /* GEDevDesc, GEgetDevice */
#include <R_ext/Rdynload.h>
#include <R_ext/Rallocators.h> /* for R_allocator_t structure */
#include <Rmath.h> // R_pow_di
#include <Print.h> // R_print
/* malloc uses size_t. We are assuming here that size_t is at least
as large as unsigned long. Changed from int at 1.6.0 to (i) allow
2-4Gb objects on 32-bit system and (ii) objects limited only by
length on a 64-bit system.
*/
static int gc_reporting = 0;
static int gc_count = 0;
/* Report error encountered during garbage collection where for detecting
problems it is better to abort, but for debugging (or some production runs,
where external validation of results is possible) it may be preferred to
continue. Configurable via _R_GC_FAIL_ON_ERROR_. Typically these problems
are due to memory corruption.
*/
static Rboolean gc_fail_on_error = FALSE;
static void gc_error(const char *msg)
{
if (gc_fail_on_error)
R_Suicide(msg);
else if (R_in_gc)
REprintf("%s", msg);
else
error("%s", msg);
}
/* These are used in profiling to separate out time in GC */
attribute_hidden int R_gc_running(void) { return R_in_gc; }
#ifdef TESTING_WRITE_BARRIER
# define PROTECTCHECK
#endif
#ifdef PROTECTCHECK
/* This is used to help detect unprotected SEXP values. It is most
useful if the strict barrier is enabled as well. The strategy is:
All GCs are full GCs
New nodes are marked as NEWSXP
After a GC all free nodes that are not of type NEWSXP are
marked as type FREESXP
Most calls to accessor functions check their SEXP inputs and
SEXP outputs with CHK() to see if a reachable node is a
FREESXP and signal an error if a FREESXP is found.
Combined with GC torture this can help locate where an unprotected
SEXP is being used.
This approach will miss cases where an unprotected node has been
re-allocated. For these cases it is possible to set
gc_inhibit_release to TRUE. FREESXP nodes will not be reallocated,
or large ones released, until gc_inhibit_release is set to FALSE
again. This will of course result in memory growth and should be
used with care and typically in combination with OS mechanisms to
limit process memory usage. LT */
/* Before a node is marked as a FREESXP by the collector the previous
type is recorded. For now using the LEVELS field seems
reasonable. */
#define OLDTYPE(s) LEVELS(s)
#define SETOLDTYPE(s, t) SETLEVELS(s, t)
static R_INLINE SEXP CHK(SEXP x)
{
/* **** NULL check because of R_CurrentExpr */
if (x != NULL && TYPEOF(x) == FREESXP)
error("unprotected object (%p) encountered (was %s)",
(void *)x, sexptype2char(OLDTYPE(x)));
return x;
}
#else
#define CHK(x) x
#endif
/* The following three variables definitions are used to record the
address and type of the first bad type seen during a collection,
and for FREESXP nodes they record the old type as well. */
static SEXPTYPE bad_sexp_type_seen = 0;
static SEXP bad_sexp_type_sexp = NULL;
#ifdef PROTECTCHECK
static SEXPTYPE bad_sexp_type_old_type = 0;
#endif
static int bad_sexp_type_line = 0;
static R_INLINE void register_bad_sexp_type(SEXP s, int line)
{
if (bad_sexp_type_seen == 0) {
bad_sexp_type_seen = TYPEOF(s);
bad_sexp_type_sexp = s;
bad_sexp_type_line = line;
#ifdef PROTECTCHECK
if (TYPEOF(s) == FREESXP)
bad_sexp_type_old_type = OLDTYPE(s);
#endif
}
}
/* also called from typename() in inspect.c */
attribute_hidden
const char *sexptype2char(SEXPTYPE type) {
switch (type) {
case NILSXP: return "NILSXP";
case SYMSXP: return "SYMSXP";
case LISTSXP: return "LISTSXP";
case CLOSXP: return "CLOSXP";
case ENVSXP: return "ENVSXP";
case PROMSXP: return "PROMSXP";
case LANGSXP: return "LANGSXP";
case SPECIALSXP: return "SPECIALSXP";
case BUILTINSXP: return "BUILTINSXP";
case CHARSXP: return "CHARSXP";
case LGLSXP: return "LGLSXP";
case INTSXP: return "INTSXP";
case REALSXP: return "REALSXP";
case CPLXSXP: return "CPLXSXP";
case STRSXP: return "STRSXP";
case DOTSXP: return "DOTSXP";
case ANYSXP: return "ANYSXP";
case VECSXP: return "VECSXP";
case EXPRSXP: return "EXPRSXP";
case BCODESXP: return "BCODESXP";
case EXTPTRSXP: return "EXTPTRSXP";
case WEAKREFSXP: return "WEAKREFSXP";
case OBJSXP: return "OBJSXP"; /* was S4SXP */
case RAWSXP: return "RAWSXP";
case NEWSXP: return "NEWSXP"; /* should never happen */
case FREESXP: return "FREESXP";
default: return "<unknown>";
}
}
#define GC_TORTURE
static int gc_pending = 0;
#ifdef GC_TORTURE
/* **** if the user specified a wait before starting to force
**** collections it might make sense to also wait before starting
**** to inhibit releases */
static int gc_force_wait = 0;
static int gc_force_gap = 0;
static Rboolean gc_inhibit_release = FALSE;
#define FORCE_GC (gc_pending || (gc_force_wait > 0 ? (--gc_force_wait > 0 ? 0 : (gc_force_wait = gc_force_gap, 1)) : 0))
#else
# define FORCE_GC gc_pending
#endif
#ifdef R_MEMORY_PROFILING
static void R_ReportAllocation(R_size_t);
static void R_ReportNewPage(void);
#endif
#define GC_PROT(X) do { \
int __wait__ = gc_force_wait; \
int __gap__ = gc_force_gap; \
Rboolean __release__ = gc_inhibit_release; \
X; \
gc_force_wait = __wait__; \
gc_force_gap = __gap__; \
gc_inhibit_release = __release__; \
} while(0)
static void R_gc_internal(R_size_t size_needed);
static void R_gc_no_finalizers(R_size_t size_needed);
static void R_gc_lite(void);
static void mem_err_heap(R_size_t size);
static void mem_err_malloc(R_size_t size);
static SEXPREC UnmarkedNodeTemplate;
#define NODE_IS_MARKED(s) (MARK(s)==1)
#define MARK_NODE(s) (MARK(s)=1)
#define UNMARK_NODE(s) (MARK(s)=0)
/* Tuning Constants. Most of these could be made settable from R,
within some reasonable constraints at least. Since there are quite
a lot of constants it would probably make sense to put together
several "packages" representing different space/speed tradeoffs
(e.g. very aggressive freeing and small increments to conserve
memory; much less frequent releasing and larger increments to
increase speed). */
/* There are three levels of collections. Level 0 collects only the
youngest generation, level 1 collects the two youngest generations,
and level 2 collects all generations. Higher level collections
occur at least after specified numbers of lower level ones. After
LEVEL_0_FREQ level zero collections a level 1 collection is done;
after every LEVEL_1_FREQ level 1 collections a level 2 collection
occurs. Thus, roughly, every LEVEL_0_FREQ-th collection is a level
1 collection and every (LEVEL_0_FREQ * LEVEL_1_FREQ)-th collection
is a level 2 collection. */
#define LEVEL_0_FREQ 20
#define LEVEL_1_FREQ 5
static int collect_counts_max[] = { LEVEL_0_FREQ, LEVEL_1_FREQ };
/* When a level N collection fails to produce at least MinFreeFrac *
R_NSize free nodes and MinFreeFrac * R_VSize free vector space, the
next collection will be a level N + 1 collection.
This constant is also used in heap size adjustment as a minimal
fraction of the minimal heap size levels that should be available
for allocation. */
static double R_MinFreeFrac = 0.2;
/* When pages are released, a number of free nodes equal to
R_MaxKeepFrac times the number of allocated nodes for each class is
retained. Pages not needed to meet this requirement are released.
An attempt to release pages is made every R_PageReleaseFreq level 1
or level 2 collections. */
static double R_MaxKeepFrac = 0.5;
static int R_PageReleaseFreq = 1;
/* The heap size constants R_NSize and R_VSize are used for triggering
collections. The initial values set by defaults or command line
arguments are used as minimal values. After full collections these
levels are adjusted up or down, though not below the minimal values
or above the maximum values, towards maintain heap occupancy within
a specified range. When the number of nodes in use reaches
R_NGrowFrac * R_NSize, the value of R_NSize is incremented by
R_NGrowIncrMin + R_NGrowIncrFrac * R_NSize. When the number of
nodes in use falls below R_NShrinkFrac, R_NSize is decremented by
R_NShrinkIncrMin + R_NShrinkFrac * R_NSize. Analogous adjustments
are made to R_VSize.
This mechanism for adjusting the heap size constants is very
primitive but hopefully adequate for now. Some modeling and
experimentation would be useful. We want the heap sizes to get set
at levels adequate for the current computations. The present
mechanism uses only the size of the current live heap to provide
information about the current needs; since the current live heap
size can be very volatile, the adjustment mechanism only makes
gradual adjustments. A more sophisticated strategy would use more
of the live heap history.
Some of the settings can now be adjusted by environment variables.
*/
static double R_NGrowFrac = 0.70;
static double R_NShrinkFrac = 0.30;
static double R_VGrowFrac = 0.70;
static double R_VShrinkFrac = 0.30;
#ifdef SMALL_MEMORY
/* On machines with only 32M of memory (or on a classic Mac OS port)
it might be a good idea to use settings like these that are more
aggressive at keeping memory usage down. */
static double R_NGrowIncrFrac = 0.0, R_NShrinkIncrFrac = 0.2;
static int R_NGrowIncrMin = 50000, R_NShrinkIncrMin = 0;
static double R_VGrowIncrFrac = 0.0, R_VShrinkIncrFrac = 0.2;
static int R_VGrowIncrMin = 100000, R_VShrinkIncrMin = 0;
#else
static double R_NGrowIncrFrac = 0.2, R_NShrinkIncrFrac = 0.2;
static int R_NGrowIncrMin = 40000, R_NShrinkIncrMin = 0;
static double R_VGrowIncrFrac = 0.2, R_VShrinkIncrFrac = 0.2;
static int R_VGrowIncrMin = 80000, R_VShrinkIncrMin = 0;
#endif
static void init_gc_grow_settings(void)
{
char *arg;
arg = getenv("R_GC_MEM_GROW");
if (arg != NULL) {
int which = (int) atof(arg);
switch (which) {
case 0: /* very conservative -- the SMALL_MEMORY settings */
R_NGrowIncrFrac = 0.0;
R_VGrowIncrFrac = 0.0;
break;
case 1: /* default */
break;
case 2: /* somewhat aggressive */
R_NGrowIncrFrac = 0.3;
R_VGrowIncrFrac = 0.3;
break;
case 3: /* more aggressive */
R_NGrowIncrFrac = 0.4;
R_VGrowIncrFrac = 0.4;
R_NGrowFrac = 0.5;
R_VGrowFrac = 0.5;
break;
}
}
arg = getenv("R_GC_GROWFRAC");
if (arg != NULL) {
double frac = atof(arg);
if (0.35 <= frac && frac <= 0.75) {
R_NGrowFrac = frac;
R_VGrowFrac = frac;
}
}
arg = getenv("R_GC_GROWINCRFRAC");
if (arg != NULL) {
double frac = atof(arg);
if (0.05 <= frac && frac <= 0.80) {
R_NGrowIncrFrac = frac;
R_VGrowIncrFrac = frac;
}
}
arg = getenv("R_GC_NGROWINCRFRAC");
if (arg != NULL) {
double frac = atof(arg);
if (0.05 <= frac && frac <= 0.80)
R_NGrowIncrFrac = frac;
}
arg = getenv("R_GC_VGROWINCRFRAC");
if (arg != NULL) {
double frac = atof(arg);
if (0.05 <= frac && frac <= 0.80)
R_VGrowIncrFrac = frac;
}
}
/* Maximal Heap Limits. These variables contain upper limits on the
heap sizes. They could be made adjustable from the R level,
perhaps by a handler for a recoverable error.
Access to these values is provided with reader and writer
functions; the writer function insures that the maximal values are
never set below the current ones. */
static R_size_t R_MaxVSize = R_SIZE_T_MAX;
static R_size_t R_MaxNSize = R_SIZE_T_MAX;
static int vsfac = 1; /* current units for vsize: changes at initialization */
R_size_t attribute_hidden R_GetMaxVSize(void)
{
if (R_MaxVSize == R_SIZE_T_MAX) return R_SIZE_T_MAX;
return R_MaxVSize * vsfac;
}
attribute_hidden Rboolean R_SetMaxVSize(R_size_t size)
{
if (size == R_SIZE_T_MAX) {
R_MaxVSize = R_SIZE_T_MAX;
return TRUE;
}
if (vsfac == 1) {
if (size >= R_VSize) {
R_MaxVSize = size;
return TRUE;
}
} else
if (size / vsfac >= R_VSize) {
R_MaxVSize = (size + 1) / vsfac;
return TRUE;
}
return FALSE;
}
R_size_t attribute_hidden R_GetMaxNSize(void)
{
return R_MaxNSize;
}
attribute_hidden Rboolean R_SetMaxNSize(R_size_t size)
{
if (size >= R_NSize) {
R_MaxNSize = size;
return TRUE;
}
return FALSE;
}
attribute_hidden void R_SetPPSize(R_size_t size)
{
R_PPStackSize = (int) size;
}
attribute_hidden SEXP do_maxVSize(SEXP call, SEXP op, SEXP args, SEXP rho)
{
const double MB = 1048576.0;
double newval = asReal(CAR(args));
if (newval > 0) {
if (newval == R_PosInf)
R_MaxVSize = R_SIZE_T_MAX;
else {
double newbytes = newval * MB;
if (newbytes >= (double) R_SIZE_T_MAX)
R_MaxVSize = R_SIZE_T_MAX;
else if (!R_SetMaxVSize((R_size_t) newbytes))
warning(_("a limit lower than current usage, so ignored"));
}
}
if (R_MaxVSize == R_SIZE_T_MAX)
return ScalarReal(R_PosInf);
else
return ScalarReal(R_GetMaxVSize() / MB);
}
attribute_hidden SEXP do_maxNSize(SEXP call, SEXP op, SEXP args, SEXP rho)
{
double newval = asReal(CAR(args));
if (newval > 0) {
if (newval == R_PosInf)
R_MaxNSize = R_SIZE_T_MAX;
else {
if (newval >= (double) R_SIZE_T_MAX)
R_MaxNSize = R_SIZE_T_MAX;
else if (!R_SetMaxNSize((R_size_t) newval))
warning(_("a limit lower than current usage, so ignored"));
}
}
if (R_MaxNSize == R_SIZE_T_MAX)
return ScalarReal(R_PosInf);
else
return ScalarReal(R_GetMaxNSize());
}
/* Miscellaneous Globals. */
static SEXP R_VStack = NULL; /* R_alloc stack pointer */
static SEXP R_PreciousList = NULL; /* List of Persistent Objects */
static R_size_t R_LargeVallocSize = 0;
static R_size_t R_SmallVallocSize = 0;
static R_size_t orig_R_NSize;
static R_size_t orig_R_VSize;
static R_size_t R_N_maxused=0;
static R_size_t R_V_maxused=0;
/* Node Classes. Non-vector nodes are of class zero. Small vector
nodes are in classes 1, ..., NUM_SMALL_NODE_CLASSES, and large
vector nodes are in class LARGE_NODE_CLASS. Vectors with
custom allocators are in CUSTOM_NODE_CLASS. For vector nodes the
node header is followed in memory by the vector data, offset from
the header by SEXPREC_ALIGN. */
#define NUM_NODE_CLASSES 8
/* sxpinfo allocates 3 bits for the node class, so at most 8 are allowed */
#if NUM_NODE_CLASSES > 8
# error NUM_NODE_CLASSES must be at most 8
#endif
#define LARGE_NODE_CLASS (NUM_NODE_CLASSES - 1)
#define CUSTOM_NODE_CLASS (NUM_NODE_CLASSES - 2)
#define NUM_SMALL_NODE_CLASSES (NUM_NODE_CLASSES - 2)
/* the number of VECREC's in nodes of the small node classes */
static int NodeClassSize[NUM_SMALL_NODE_CLASSES] = { 0, 1, 2, 4, 8, 16 };
#define NODE_CLASS(s) ((s)->sxpinfo.gccls)
#define SET_NODE_CLASS(s,v) (((s)->sxpinfo.gccls) = (v))
/* Node Generations. */
#define NUM_OLD_GENERATIONS 2
/* sxpinfo allocates one bit for the old generation count, so only 1
or 2 is allowed */
#if NUM_OLD_GENERATIONS > 2 || NUM_OLD_GENERATIONS < 1
# error number of old generations must be 1 or 2
#endif
#define NODE_GENERATION(s) ((s)->sxpinfo.gcgen)
#define SET_NODE_GENERATION(s,g) ((s)->sxpinfo.gcgen=(g))
#define NODE_GEN_IS_YOUNGER(s,g) \
(! NODE_IS_MARKED(s) || NODE_GENERATION(s) < (g))
#define NODE_IS_OLDER(x, y) \
(NODE_IS_MARKED(x) && (y) && \
(! NODE_IS_MARKED(y) || NODE_GENERATION(x) > NODE_GENERATION(y)))
static int num_old_gens_to_collect = 0;
static int gen_gc_counts[NUM_OLD_GENERATIONS + 1];
static int collect_counts[NUM_OLD_GENERATIONS];
/* Node Pages. Non-vector nodes and small vector nodes are allocated
from fixed size pages. The pages for each node class are kept in a
linked list. */
typedef union PAGE_HEADER {
union PAGE_HEADER *next;
double align;
} PAGE_HEADER;
#if ( SIZEOF_SIZE_T > 4 )
# define BASE_PAGE_SIZE 8000
#else
# define BASE_PAGE_SIZE 2000
#endif
#define R_PAGE_SIZE \
(((BASE_PAGE_SIZE - sizeof(PAGE_HEADER)) / sizeof(SEXPREC)) \
* sizeof(SEXPREC) \
+ sizeof(PAGE_HEADER))
#define NODE_SIZE(c) \
((c) == 0 ? sizeof(SEXPREC) : \
sizeof(SEXPREC_ALIGN) + NodeClassSize[c] * sizeof(VECREC))
#define PAGE_DATA(p) ((void *) (p + 1))
#define VHEAP_FREE() (R_VSize - R_LargeVallocSize - R_SmallVallocSize)
/* The Heap Structure. Nodes for each class/generation combination
are arranged in circular doubly-linked lists. The double linking
allows nodes to be removed in constant time; this is used by the
collector to move reachable nodes out of free space and into the
appropriate generation. The circularity eliminates the need for
end checks. In addition, each link is anchored at an artificial
node, the Peg SEXPREC's in the structure below, which simplifies
pointer maintenance. The circular doubly-linked arrangement is
taken from Baker's in-place incremental collector design; see
ftp://ftp.netcom.com/pub/hb/hbaker/NoMotionGC.html or the Jones and
Lins GC book. The linked lists are implemented by adding two
pointer fields to the SEXPREC structure, which increases its size
from 5 to 7 words. Other approaches are possible but don't seem
worth pursuing for R.
There are two options for dealing with old-to-new pointers. The
first option is to make sure they never occur by transferring all
referenced younger objects to the generation of the referrer when a
reference to a newer object is assigned to an older one. This is
enabled by defining EXPEL_OLD_TO_NEW. The second alternative is to
keep track of all nodes that may contain references to newer nodes
and to "age" the nodes they refer to at the beginning of each
collection. This is the default. The first option is simpler in
some ways, but will create more floating garbage and add a bit to
the execution time, though the difference is probably marginal on
both counts.*/
/*#define EXPEL_OLD_TO_NEW*/
static struct {
SEXP Old[NUM_OLD_GENERATIONS], New, Free;
SEXPREC OldPeg[NUM_OLD_GENERATIONS], NewPeg;
#ifndef EXPEL_OLD_TO_NEW
SEXP OldToNew[NUM_OLD_GENERATIONS];
SEXPREC OldToNewPeg[NUM_OLD_GENERATIONS];
#endif
int OldCount[NUM_OLD_GENERATIONS], AllocCount, PageCount;
PAGE_HEADER *pages;
} R_GenHeap[NUM_NODE_CLASSES];
static R_size_t R_NodesInUse = 0;
#define NEXT_NODE(s) (s)->gengc_next_node
#define PREV_NODE(s) (s)->gengc_prev_node
#define SET_NEXT_NODE(s,t) (NEXT_NODE(s) = (t))
#define SET_PREV_NODE(s,t) (PREV_NODE(s) = (t))
/* Node List Manipulation */
/* unsnap node s from its list */
#define UNSNAP_NODE(s) do { \
SEXP un__n__ = (s); \
SEXP next = NEXT_NODE(un__n__); \
SEXP prev = PREV_NODE(un__n__); \
SET_NEXT_NODE(prev, next); \
SET_PREV_NODE(next, prev); \
} while(0)
/* snap in node s before node t */
#define SNAP_NODE(s,t) do { \
SEXP sn__n__ = (s); \
SEXP next = (t); \
SEXP prev = PREV_NODE(next); \
SET_NEXT_NODE(sn__n__, next); \
SET_PREV_NODE(next, sn__n__); \
SET_NEXT_NODE(prev, sn__n__); \
SET_PREV_NODE(sn__n__, prev); \
} while (0)
/* move all nodes on from_peg to to_peg */
#define BULK_MOVE(from_peg,to_peg) do { \
SEXP __from__ = (from_peg); \
SEXP __to__ = (to_peg); \
SEXP first_old = NEXT_NODE(__from__); \
SEXP last_old = PREV_NODE(__from__); \
SEXP first_new = NEXT_NODE(__to__); \
SET_PREV_NODE(first_old, __to__); \
SET_NEXT_NODE(__to__, first_old); \
SET_PREV_NODE(first_new, last_old); \
SET_NEXT_NODE(last_old, first_new); \
SET_NEXT_NODE(__from__, __from__); \
SET_PREV_NODE(__from__, __from__); \
} while (0);
/* Processing Node Children */
/* This macro calls dc__action__ for each child of __n__, passing
dc__extra__ as a second argument for each call. */
/* When the CHARSXP hash chains are maintained through the ATTRIB
field it is important that we NOT trace those fields otherwise too
many CHARSXPs will be kept alive artificially. As a safety we don't
ignore all non-NULL ATTRIB values for CHARSXPs but only those that
are themselves CHARSXPs, which is what they will be if they are
part of a hash chain. Theoretically, for CHARSXPs the ATTRIB field
should always be either R_NilValue or a CHARSXP. */
#ifdef PROTECTCHECK
# define HAS_GENUINE_ATTRIB(x) \
(TYPEOF(x) != FREESXP && ATTRIB(x) != R_NilValue && \
(TYPEOF(x) != CHARSXP || TYPEOF(ATTRIB(x)) != CHARSXP))
#else
# define HAS_GENUINE_ATTRIB(x) \
(ATTRIB(x) != R_NilValue && \
(TYPEOF(x) != CHARSXP || TYPEOF(ATTRIB(x)) != CHARSXP))
#endif
#ifdef PROTECTCHECK
#define FREE_FORWARD_CASE case FREESXP: if (gc_inhibit_release) break;
#else
#define FREE_FORWARD_CASE
#endif
/*** assume for now all ALTREP nodes are based on CONS nodes */
#define DO_CHILDREN4(__n__,dc__action__,dc__str__action__,dc__extra__) do { \
if (HAS_GENUINE_ATTRIB(__n__)) \
dc__action__(ATTRIB(__n__), dc__extra__); \
if (ALTREP(__n__)) { \
dc__action__(TAG(__n__), dc__extra__); \
dc__action__(CAR(__n__), dc__extra__); \
dc__action__(CDR(__n__), dc__extra__); \
} \
else \
switch (TYPEOF(__n__)) { \
case NILSXP: \
case BUILTINSXP: \
case SPECIALSXP: \
case CHARSXP: \
case LGLSXP: \
case INTSXP: \
case REALSXP: \
case CPLXSXP: \
case WEAKREFSXP: \
case RAWSXP: \
case OBJSXP: \
break; \
case STRSXP: \
{ \
R_xlen_t i; \
for (i = 0; i < XLENGTH(__n__); i++) \
dc__str__action__(VECTOR_ELT_0(__n__, i), dc__extra__); \
} \
break; \
case EXPRSXP: \
case VECSXP: \
{ \
R_xlen_t i; \
for (i = 0; i < XLENGTH(__n__); i++) \
dc__action__(VECTOR_ELT_0(__n__, i), dc__extra__); \
} \
break; \
case ENVSXP: \
dc__action__(FRAME(__n__), dc__extra__); \
dc__action__(ENCLOS(__n__), dc__extra__); \
dc__action__(HASHTAB(__n__), dc__extra__); \
break; \
case LISTSXP: \
case PROMSXP: \
dc__action__(TAG(__n__), dc__extra__); \
if (BOXED_BINDING_CELLS || BNDCELL_TAG(__n__) == 0) \
dc__action__(CAR0(__n__), dc__extra__); \
dc__action__(CDR(__n__), dc__extra__); \
break; \
case CLOSXP: \
case LANGSXP: \
case DOTSXP: \
case SYMSXP: \
case BCODESXP: \
dc__action__(TAG(__n__), dc__extra__); \
dc__action__(CAR0(__n__), dc__extra__); \
dc__action__(CDR(__n__), dc__extra__); \
break; \
case EXTPTRSXP: \
dc__action__(EXTPTR_PROT(__n__), dc__extra__); \
dc__action__(EXTPTR_TAG(__n__), dc__extra__); \
break; \
FREE_FORWARD_CASE \
default: \
register_bad_sexp_type(__n__, __LINE__); \
} \
} while(0)
#define DO_CHILDREN(__n__,dc__action__,dc__extra__) \
DO_CHILDREN4(__n__,dc__action__,dc__action__,dc__extra__)
/* Forwarding Nodes. These macros mark nodes or children of nodes and
place them on the forwarding list. The forwarding list is assumed
to be in a local variable of the caller named named
forwarded_nodes. */
#define MARK_AND_UNSNAP_NODE(s) do { \
SEXP mu__n__ = (s); \
CHECK_FOR_FREE_NODE(mu__n__); \
MARK_NODE(mu__n__); \
UNSNAP_NODE(mu__n__); \
} while (0)
#define FORWARD_NODE(s) do { \
SEXP fn__n__ = (s); \
if (fn__n__ && ! NODE_IS_MARKED(fn__n__)) { \
MARK_AND_UNSNAP_NODE(fn__n__); \
SET_NEXT_NODE(fn__n__, forwarded_nodes); \
forwarded_nodes = fn__n__; \
} \
} while (0)
#define PROCESS_ONE_NODE(s) do { \
SEXP pn__n__ = (s); \
int __cls__ = NODE_CLASS(pn__n__); \
int __gen__ = NODE_GENERATION(pn__n__); \
SNAP_NODE(pn__n__, R_GenHeap[__cls__].Old[__gen__]); \
R_GenHeap[__cls__].OldCount[__gen__]++; \
} while (0)
/* avoid pushing on the forwarding stack when possible */
#define FORWARD_AND_PROCESS_ONE_NODE(s, tp) do { \
SEXP fpn__n__ = (s); \
int __tp__ = (tp); \
if (fpn__n__ && ! NODE_IS_MARKED(fpn__n__)) { \
if (TYPEOF(fpn__n__) == __tp__ && \
! HAS_GENUINE_ATTRIB(fpn__n__)) { \
MARK_AND_UNSNAP_NODE(fpn__n__); \
PROCESS_ONE_NODE(fpn__n__); \
} \
else FORWARD_NODE(fpn__n__); \
} \
} while (0)
#define PROCESS_CHARSXP(__n__) FORWARD_AND_PROCESS_ONE_NODE(__n__, CHARSXP)
#define FC_PROCESS_CHARSXP(__n__,__dummy__) PROCESS_CHARSXP(__n__)
#define FC_FORWARD_NODE(__n__,__dummy__) FORWARD_NODE(__n__)
#define FORWARD_CHILDREN(__n__) \
DO_CHILDREN4(__n__, FC_FORWARD_NODE, FC_PROCESS_CHARSXP, 0)
/* This macro should help localize where a FREESXP node is encountered
in the GC */
#ifdef PROTECTCHECK
#define CHECK_FOR_FREE_NODE(s) { \
SEXP cf__n__ = (s); \
if (TYPEOF(cf__n__) == FREESXP && ! gc_inhibit_release) \
register_bad_sexp_type(cf__n__, __LINE__); \
}
#else
#define CHECK_FOR_FREE_NODE(s)
#endif
/* Node Allocation. */
#define CLASS_GET_FREE_NODE(c,s) do { \
SEXP __n__ = R_GenHeap[c].Free; \
if (__n__ == R_GenHeap[c].New) { \
GetNewPage(c); \
__n__ = R_GenHeap[c].Free; \
} \
R_GenHeap[c].Free = NEXT_NODE(__n__); \
R_NodesInUse++; \
(s) = __n__; \
} while (0)
#define NO_FREE_NODES() (R_NodesInUse >= R_NSize)
#define GET_FREE_NODE(s) CLASS_GET_FREE_NODE(0,s)
/* versions that assume nodes are available without adding a new page */
#define CLASS_QUICK_GET_FREE_NODE(c,s) do { \
SEXP __n__ = R_GenHeap[c].Free; \
if (__n__ == R_GenHeap[c].New) \
error("need new page - should not happen"); \
R_GenHeap[c].Free = NEXT_NODE(__n__); \
R_NodesInUse++; \
(s) = __n__; \
} while (0)
#define QUICK_GET_FREE_NODE(s) CLASS_QUICK_GET_FREE_NODE(0,s)
/* QUICK versions can be used if (CLASS_)NEED_NEW_PAGE returns FALSE */
#define CLASS_NEED_NEW_PAGE(c) (R_GenHeap[c].Free == R_GenHeap[c].New)
#define NEED_NEW_PAGE() CLASS_NEED_NEW_PAGE(0)
/* Debugging Routines. */
#ifdef DEBUG_GC
static void CheckNodeGeneration(SEXP x, int g)
{
if (x && NODE_GENERATION(x) < g) {
gc_error("untraced old-to-new reference\n");
}
}
static void DEBUG_CHECK_NODE_COUNTS(char *where)
{
int i, OldCount, NewCount, OldToNewCount, gen;
SEXP s;
REprintf("Node counts %s:\n", where);
for (i = 0; i < NUM_NODE_CLASSES; i++) {
for (s = NEXT_NODE(R_GenHeap[i].New), NewCount = 0;
s != R_GenHeap[i].New;
s = NEXT_NODE(s)) {
NewCount++;
if (i != NODE_CLASS(s))
gc_error("Inconsistent class assignment for node!\n");
}
for (gen = 0, OldCount = 0, OldToNewCount = 0;
gen < NUM_OLD_GENERATIONS;
gen++) {
for (s = NEXT_NODE(R_GenHeap[i].Old[gen]);
s != R_GenHeap[i].Old[gen];
s = NEXT_NODE(s)) {
OldCount++;
if (i != NODE_CLASS(s))
gc_error("Inconsistent class assignment for node!\n");
if (gen != NODE_GENERATION(s))
gc_error("Inconsistent node generation\n");
DO_CHILDREN(s, CheckNodeGeneration, gen);
}
for (s = NEXT_NODE(R_GenHeap[i].OldToNew[gen]);
s != R_GenHeap[i].OldToNew[gen];
s = NEXT_NODE(s)) {
OldToNewCount++;
if (i != NODE_CLASS(s))
gc_error("Inconsistent class assignment for node!\n");
if (gen != NODE_GENERATION(s))
gc_error("Inconsistent node generation\n");
}
}
REprintf("Class: %d, New = %d, Old = %d, OldToNew = %d, Total = %d\n",
i,
NewCount, OldCount, OldToNewCount,
NewCount + OldCount + OldToNewCount);
}
}
static void DEBUG_GC_SUMMARY(int full_gc)
{
int i, gen, OldCount;
REprintf("\n%s, VSize = %lu", full_gc ? "Full" : "Minor",
R_SmallVallocSize + R_LargeVallocSize);
for (i = 1; i < NUM_NODE_CLASSES; i++) {
for (gen = 0, OldCount = 0; gen < NUM_OLD_GENERATIONS; gen++)
OldCount += R_GenHeap[i].OldCount[gen];
REprintf(", class %d: %d", i, OldCount);
}
}
#else
#define DEBUG_CHECK_NODE_COUNTS(s)
#define DEBUG_GC_SUMMARY(x)
#endif /* DEBUG_GC */
#ifdef DEBUG_ADJUST_HEAP
static void DEBUG_ADJUST_HEAP_PRINT(double node_occup, double vect_occup)
{
int i;
R_size_t alloc;
REprintf("Node occupancy: %.0f%%\nVector occupancy: %.0f%%\n",
100.0 * node_occup, 100.0 * vect_occup);
alloc = R_LargeVallocSize +
sizeof(SEXPREC_ALIGN) * R_GenHeap[LARGE_NODE_CLASS].AllocCount;
for (i = 0; i < NUM_SMALL_NODE_CLASSES; i++)
alloc += R_PAGE_SIZE * R_GenHeap[i].PageCount;
REprintf("Total allocation: %lu\n", alloc);
REprintf("Ncells %lu\nVcells %lu\n", R_NSize, R_VSize);
}
#else
#define DEBUG_ADJUST_HEAP_PRINT(node_occup, vect_occup)
#endif /* DEBUG_ADJUST_HEAP */
#ifdef DEBUG_RELEASE_MEM
static void DEBUG_RELEASE_PRINT(int rel_pages, int maxrel_pages, int i)
{
if (maxrel_pages > 0) {
int gen, n;
REprintf("Class: %d, pages = %d, maxrel = %d, released = %d\n", i,
R_GenHeap[i].PageCount, maxrel_pages, rel_pages);
for (gen = 0, n = 0; gen < NUM_OLD_GENERATIONS; gen++)
n += R_GenHeap[i].OldCount[gen];
REprintf("Allocated = %d, in use = %d\n", R_GenHeap[i].AllocCount, n);
}
}
#else
#define DEBUG_RELEASE_PRINT(rel_pages, maxrel_pages, i)
#endif /* DEBUG_RELEASE_MEM */
#ifdef COMPUTE_REFCNT_VALUES
#define INIT_REFCNT(x) do { \
SEXP __x__ = (x); \
SET_REFCNT(__x__, 0); \
SET_TRACKREFS(__x__, TRUE); \
} while (0)
#else
#define INIT_REFCNT(x) do {} while (0)
#endif
/* Page Allocation and Release. */
static void GetNewPage(int node_class)
{
SEXP s, base;
char *data;
PAGE_HEADER *page;
int node_size, page_count, i; // FIXME: longer type?
node_size = NODE_SIZE(node_class);
page_count = (R_PAGE_SIZE - sizeof(PAGE_HEADER)) / node_size;
page = malloc(R_PAGE_SIZE);
if (page == NULL) {
R_gc_no_finalizers(0);