Coverage Report

Created: 2026-09-14 07:34

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/ghostpdl/psi/igcref.c
Line
Count
Source
1
/* Copyright (C) 2001-2023 Artifex Software, Inc.
2
   All Rights Reserved.
3
4
   This software is provided AS-IS with no warranty, either express or
5
   implied.
6
7
   This software is distributed under license and may not be copied,
8
   modified or distributed except as expressly authorized under the terms
9
   of the license contained in the file LICENSE in this distribution.
10
11
   Refer to licensing information at http://www.artifex.com or contact
12
   Artifex Software, Inc.,  39 Mesa Street, Suite 108A, San Francisco,
13
   CA 94129, USA, for further information.
14
*/
15
16
17
/* ref garbage collector for Ghostscript */
18
#include "memory_.h"
19
#include "ghost.h"
20
#include "gsexit.h"
21
#include "gsstruct.h"   /* for gxalloc.h included by iastate.h */
22
#include "iname.h"
23
#include "iastate.h"
24
#include "idebug.h"
25
#include "igc.h"
26
#include "ipacked.h"
27
#include "store.h"    /* for ref_assign_inline */
28
29
/* Define whether to trace every step of relocating ref pointers. */
30
#if 0
31
#  define rputc(m,c) dmputc(m,c)
32
#else
33
97.7G
#  define rputc(m,c) DO_NOTHING
34
#endif
35
36
/* Forward references */
37
ptr_proc_reloc(igc_reloc_ref_ptr, ref_packed);
38
ptr_proc_reloc(igc_reloc_ref_ptr_nocheck, ref_packed);
39
refs_proc_reloc(igc_reloc_refs);
40
41
/*
42
 * Define the 'structure' type descriptor for refs.
43
 * This is special because it has different shared procs.
44
 */
45
static gc_proc_clear_reloc(refs_clear_reloc);
46
static gc_proc_set_reloc(refs_set_reloc);
47
static gc_proc_compact(refs_compact);
48
static const struct_shared_procs_t refs_shared_procs =
49
{refs_clear_reloc, refs_set_reloc, refs_compact};
50
static struct_proc_clear_marks(refs_clear_marks);
51
static struct_proc_reloc_ptrs(refs_do_reloc);
52
const gs_memory_struct_type_t st_refs =
53
{sizeof(ref), "refs", &refs_shared_procs, refs_clear_marks, 0, refs_do_reloc};
54
55
/*
56
 * Define the GC procedures for structs that actually contain refs.
57
 * These are special because the shared refs_* procedures
58
 * are never called.  Instead, we unmark the individual refs in clear_marks,
59
 * disregard refs_*_reloc (because we will never relocate a ptr_ref_type
60
 * pointer pointing into the structure), disregard refs_compact (because
61
 * compaction is never required), and remove the marks in reloc_ptrs.
62
 * See also the comment about ptr_ref_type in imemory.h.
63
 */
64
CLEAR_MARKS_PROC(ref_struct_clear_marks)
65
79.6M
{
66
79.6M
    ref *pref = (ref *) vptr;
67
79.6M
    ref *end = (ref *) ((char *)vptr + size);
68
69
2.98G
    for (; pref < end; pref++)
70
2.90G
        r_clear_attrs(pref, l_mark);
71
79.6M
}
72
ENUM_PTRS_BEGIN_PROC(ref_struct_enum_ptrs)
73
1.49G
{
74
1.49G
    if (index >= size / sizeof(ref))
75
39.8M
        return 0;
76
1.45G
    pep->ptr = (const ref *)vptr + index;
77
1.45G
    return ptr_ref_type;
78
1.49G
    ENUM_PTRS_END_PROC
79
1.49G
}
80
39.8M
RELOC_PTRS_BEGIN(ref_struct_reloc_ptrs)
81
39.8M
{
82
39.8M
    vm_spaces spaces = gcst->spaces;
83
39.8M
    const gs_memory_t *cmem = space_system->stable_memory;
84
85
39.8M
    ref *beg = vptr;
86
39.8M
    ref *end = (ref *) ((char *)vptr + size);
87
88
39.8M
    igc_reloc_refs((ref_packed *) beg, (ref_packed *) end, gcst);
89
39.8M
    ref_struct_clear_marks(cmem, vptr, size, pstype);
90
39.8M
} RELOC_PTRS_END
91
92
/* ------ Unmarking phase ------ */
93
94
/* Unmark a single ref. */
95
void
96
ptr_ref_unmark(enum_ptr_t *pep, gc_state_t * ignored)
97
156k
{
98
156k
    ref_packed *rpp = (ref_packed *)pep->ptr;
99
100
156k
    if (r_is_packed(rpp))
101
0
        r_clear_pmark(rpp);
102
156k
    else
103
156k
        r_clear_attrs((ref *)rpp, l_mark);
104
156k
}
105
106
/* Unmarking routine for ref objects. */
107
static void
108
refs_clear_marks(const gs_memory_t *cmem,
109
                 void /*obj_header_t */ *vptr, uint size,
110
                 const gs_memory_struct_type_t * pstype)
111
336M
{
112
336M
    ref_packed *rp = (ref_packed *) vptr;
113
336M
    ref_packed *end = (ref_packed *) ((byte *) vptr + size);
114
115
    /* Since the last ref is full-size, we only need to check for */
116
    /* the end of the block when we see one of those. */
117
60.6G
    for (;;) {
118
60.6G
        if (r_is_packed(rp)) {
119
#ifdef DEBUG
120
            if (gs_debug_c('8')) {
121
                dmlprintf1(cmem, "  [8]unmark packed "PRI_INTPTR" ", (intptr_t) rp);
122
                debug_print_ref(cmem, (const ref *)rp);
123
                dmputs(cmem, "\n");
124
            }
125
#endif
126
13.5G
            r_clear_pmark(rp);
127
13.5G
            rp++;
128
47.1G
        } else {   /* full-size ref */
129
47.1G
            ref *const pref = (ref *)rp;
130
131
#ifdef DEBUG
132
            if (gs_debug_c('8')) {
133
                dmlprintf1(cmem, "  [8]unmark ref "PRI_INTPTR" ", (intptr_t)rp);
134
                debug_print_ref(cmem, pref);
135
                dmputs(cmem, "\n");
136
            }
137
#endif
138
47.1G
            r_clear_attrs(pref, l_mark);
139
47.1G
            rp += packed_per_ref;
140
47.1G
            if (rp >= (ref_packed *) end)
141
336M
                break;
142
47.1G
        }
143
60.6G
    }
144
336M
}
145
146
/* ------ Marking phase ------ */
147
148
/* Mark a ref.  Return true if new mark. */
149
bool
150
ptr_ref_mark(enum_ptr_t *pep, gc_state_t * ignored)
151
0
{
152
0
    ref_packed *rpp = (void *)pep->ptr;
153
154
0
    if (r_is_packed(rpp)) {
155
0
        if (r_has_pmark(rpp))
156
0
            return false;
157
0
        r_set_pmark(rpp);
158
0
    } else {
159
0
        ref *const pref = (ref *)rpp;
160
161
0
        if (r_has_attr(pref, l_mark))
162
0
            return false;
163
0
        r_set_attrs(pref, l_mark);
164
0
    }
165
0
    return true;
166
0
}
167
168
/* ------ Relocation planning phase ------ */
169
170
/*
171
 * We store relocation in the size field of refs that don't use it,
172
 * so that we don't have to scan all the way to an unmarked object.
173
 * We must avoid nulls, which sometimes have useful information
174
 * in their size fields, and the types above t_next_index, which are
175
 * actually operators in disguise and also use the size field.
176
 */
177
178
/* Clear the relocation for a ref object. */
179
static void
180
refs_clear_reloc(obj_header_t *hdr, uint size)
181
8.39M
{
182
8.39M
    ref_packed *rp = (ref_packed *) (hdr + 1);
183
8.39M
    ref_packed *end = (ref_packed *) ((byte *) rp + size);
184
185
941M
    while (rp < end) {
186
932M
        if (r_is_packed(rp))
187
312M
            rp++;
188
620M
        else {
189
            /* Full-size ref.  Store the relocation here if possible. */
190
620M
            ref *const pref = (ref *)rp;
191
192
620M
            if (!ref_type_uses_size_or_null(r_type(pref))) {
193
142M
                if_debug1('8', "  [8]clearing reloc at "PRI_INTPTR"\n", (intptr_t)rp);
194
142M
                r_set_size(pref, 0);
195
142M
            }
196
620M
            rp += packed_per_ref;
197
620M
        }
198
932M
    }
199
8.39M
}
200
201
/* Set the relocation for a ref object. */
202
static bool
203
refs_set_reloc(obj_header_t * hdr, uint reloc, uint size)
204
328M
{
205
328M
    ref_packed *rp = (ref_packed *) (hdr + 1);
206
328M
    ref_packed *end = (ref_packed *) ((byte *) rp + size);
207
328M
    uint freed = 0;
208
209
    /*
210
     * We have to be careful to keep refs aligned properly.
211
     * For the moment, we do this by either keeping or discarding
212
     * an entire (aligned) block of align_packed_per_ref packed elements
213
     * as a unit.  We know that align_packed_per_ref <= packed_per_ref,
214
     * and we also know that packed refs are always allocated in blocks
215
     * of align_packed_per_ref, so this makes things relatively easy.
216
     */
217
50.1G
    while (rp < end) {
218
49.8G
        if (r_is_packed(rp)) {
219
#if align_packed_per_ref == 1
220
            if (r_has_pmark(rp)) {
221
                if_debug1('8',
222
                          "  [8]packed ref "PRI_INTPTR" is marked\n",
223
                          (intptr_t)rp);
224
                rp++;
225
            } else {
226
#else
227
3.31G
            int i;
228
229
            /*
230
             * Note: align_packed_per_ref is typically
231
             * 2 or 4 for 32-bit processors.
232
             */
233
3.31G
#define all_marked (align_packed_per_ref * lp_mark)
234
# if align_packed_per_ref == 2
235
#  if ARCH_SIZEOF_INT == ARCH_SIZEOF_SHORT * 2
236
#    undef all_marked
237
#    define all_marked ( (lp_mark << (sizeof(short) * 8)) + lp_mark )
238
#    define marked (*(int *)rp & all_marked)
239
#  else
240
#    define marked ((*rp & lp_mark) + (rp[1] & lp_mark))
241
#  endif
242
# else
243
3.31G
#  if align_packed_per_ref == 4
244
3.31G
#    define marked ((*rp & lp_mark) + (rp[1] & lp_mark) +\
245
3.31G
                    (rp[2] & lp_mark) + (rp[3] & lp_mark))
246
#  else
247
            /*
248
             * The value of marked is logically a uint, not an int:
249
             * we declare it as int only to avoid a compiler warning
250
             * message about using a non-int value in a switch statement.
251
             */
252
            int marked = *rp & lp_mark;
253
254
            for (i = 1; i < align_packed_per_ref; i++)
255
                marked += rp[i] & lp_mark;
256
#  endif
257
3.31G
# endif
258
            /*
259
             * Now marked is lp_mark * the number of marked
260
             * packed refs in the aligned block, except for
261
             * a couple of special cases above.
262
             */
263
3.31G
            switch (marked) {
264
1.17G
                case all_marked:
265
1.17G
                    if_debug2('8',
266
1.17G
                              "  [8]packed refs "PRI_INTPTR".."PRI_INTPTR" are marked\n",
267
1.17G
                              (intptr_t)rp,
268
1.17G
                              (intptr_t)(rp + (align_packed_per_ref - 1)));
269
1.17G
                    rp += align_packed_per_ref;
270
1.17G
                    break;
271
1.34G
                default:
272
                    /* At least one packed ref in the block */
273
                    /* is marked: Keep the whole block. */
274
6.71G
                    for (i = align_packed_per_ref; i--; rp++) {
275
5.37G
                        r_set_pmark(rp);
276
5.37G
                        if_debug1('8',
277
5.37G
                                  "  [8]packed ref "PRI_INTPTR" is marked\n",
278
5.37G
                                  (intptr_t)rp);
279
5.37G
                    }
280
1.34G
                    break;
281
795M
                case 0:
282
795M
#endif
283
795M
                    if_debug2('8', "  [8]%d packed ref(s) at "PRI_INTPTR" are unmarked\n",
284
795M
                              align_packed_per_ref, (intptr_t)rp);
285
795M
                    {
286
795M
                        uint rel = reloc + freed;
287
288
                        /* Change this to an integer so we can */
289
                        /* store the relocation here. */
290
795M
                        *rp = pt_tag(pt_integer) +
291
795M
                            min(rel, packed_max_value);
292
795M
                    }
293
795M
                    rp += align_packed_per_ref;
294
795M
                    freed += sizeof(ref_packed) * align_packed_per_ref;
295
3.31G
            }
296
46.5G
        } else {   /* full-size ref */
297
46.5G
            uint rel = reloc + freed;
298
299
            /* The following assignment is logically */
300
            /* unnecessary; we do it only for convenience */
301
            /* in debugging. */
302
46.5G
            ref *pref = (ref *) rp;
303
304
46.5G
            if (!r_has_attr(pref, l_mark)) {
305
24.8G
                if_debug1('8', "  [8]ref "PRI_INTPTR" is unmarked\n",
306
24.8G
                          (intptr_t)pref);
307
                /* Change this to a mark so we can */
308
                /* store the relocation. */
309
24.8G
                r_set_type(pref, t_mark);
310
24.8G
                r_set_size(pref, rel);
311
24.8G
                freed += sizeof(ref);
312
24.8G
            } else {
313
21.6G
                if_debug1('8', "  [8]ref "PRI_INTPTR" is marked\n",
314
21.6G
                          (intptr_t)pref);
315
                /* Store the relocation here if possible. */
316
21.6G
                if (!ref_type_uses_size_or_null(r_type(pref))) {
317
4.28G
                    if_debug2('8', "  [8]storing reloc %u at "PRI_INTPTR"\n",
318
4.28G
                              rel, (intptr_t)pref);
319
4.28G
                    r_set_size(pref, rel);
320
4.28G
                }
321
21.6G
            }
322
46.5G
            rp += packed_per_ref;
323
46.5G
        }
324
49.8G
    }
325
328M
    if_debug3('7', " [7]at end of refs "PRI_INTPTR", size = %u, freed = %u\n",
326
328M
              (intptr_t)(hdr + 1), size, freed);
327
328M
    if (freed == size)
328
58.2M
        return false;
329
269M
#if ARCH_SIZEOF_INT > ARCH_SIZEOF_SHORT
330
    /*
331
     * If the final relocation can't fit in the r_size field
332
     * (which can't happen if the object shares a clump with
333
     * any other objects, so we know reloc = 0 in this case),
334
     * we have to keep the entire object unless there are no
335
     * references to any ref in it.
336
     */
337
269M
    if (freed <= max_ushort)
338
269M
        return true;
339
    /*
340
     * We have to mark all surviving refs, but we also must
341
     * overwrite any non-surviving refs with something that
342
     * doesn't contain any pointers.
343
     */
344
4
    rp = (ref_packed *) (hdr + 1);
345
32.5k
    while (rp < end) {
346
32.5k
        if (r_is_packed(rp)) {
347
0
            if (!r_has_pmark(rp))
348
0
                *rp = pt_tag(pt_integer) | lp_mark;
349
0
            ++rp;
350
32.5k
        } else {   /* The following assignment is logically */
351
            /* unnecessary; we do it only for convenience */
352
            /* in debugging. */
353
32.5k
            ref *pref = (ref *) rp;
354
355
32.5k
            if (!r_has_attr(pref, l_mark)) {
356
32.5k
                r_set_type_attrs(pref, t_mark, l_mark);
357
32.5k
                r_set_size(pref, reloc);
358
32.5k
            } else {
359
4
                if (!ref_type_uses_size_or_null(r_type(pref)))
360
0
                    r_set_size(pref, reloc);
361
4
            }
362
32.5k
            rp += packed_per_ref;
363
32.5k
        }
364
32.5k
    }
365
    /* The last ref has to remain unmarked. */
366
4
    r_clear_attrs((ref *) rp - 1, l_mark);
367
4
#endif
368
4
    return true;
369
269M
}
370
371
/* ------ Relocation phase ------ */
372
373
/* Relocate all the pointers in a block of refs. */
374
static void
375
refs_do_reloc(void /*obj_header_t */ *vptr, uint size,
376
              const gs_memory_struct_type_t * pstype, gc_state_t * gcst)
377
278M
{
378
278M
    igc_reloc_refs((ref_packed *) vptr,
379
278M
                   (ref_packed *) ((char *)vptr + size),
380
278M
                   gcst);
381
278M
}
382
/* Relocate the contents of a block of refs. */
383
/* If gcst->relocating_untraced is true, we are relocating pointers from an */
384
/* untraced space, so relocate all refs, not just marked ones. */
385
void
386
igc_reloc_refs(ref_packed * from, ref_packed * to, gc_state_t * gcst)
387
347M
{
388
347M
    int min_trace = gcst->min_collect;
389
347M
    ref_packed *rp = from;
390
347M
    bool do_all = gcst->relocating_untraced;
391
392
347M
    vm_spaces spaces = gcst->spaces;
393
347M
    const gs_memory_t *cmem = space_system->stable_memory;
394
395
37.5G
    while (rp < to) {
396
37.1G
        ref *pref;
397
#ifdef DEBUG
398
        const void *before = 0;
399
        const void *after = 0;
400
# define DO_RELOC(var, stat)\
401
    BEGIN before = (var); stat; after = (var); END
402
# define SET_RELOC(var, expr)\
403
    BEGIN before = (var); after = (var) = (expr); END
404
#else
405
37.1G
# define DO_RELOC(var, stat) stat
406
37.1G
# define SET_RELOC(var, expr) var = expr
407
37.1G
#endif
408
409
37.1G
        if (r_is_packed(rp)) {
410
12.7G
            rp++;
411
12.7G
            continue;
412
12.7G
        }
413
        /* The following assignment is logically unnecessary; */
414
        /* we do it only for convenience in debugging. */
415
24.4G
        pref = (ref *) rp;
416
24.4G
        if_debug3m('8', gcst->heap, "  [8]relocating %s %d ref at "PRI_INTPTR"\n",
417
24.4G
                   (r_has_attr(pref, l_mark) ? "marked" : "unmarked"),
418
24.4G
                   r_btype(pref), (intptr_t)pref);
419
24.4G
        if ((r_has_attr(pref, l_mark) || do_all) &&
420
23.7G
            r_space(pref) >= min_trace
421
24.4G
            ) {
422
8.38G
            switch (r_type(pref)) {
423
                    /* Struct cases */
424
1.70M
                case t_file:
425
1.70M
                    DO_RELOC(pref->value.pfile, RELOC_VAR(pref->value.pfile));
426
1.70M
                    break;
427
6.44M
                case t_device:
428
6.44M
                    DO_RELOC(pref->value.pdevice,
429
6.44M
                             RELOC_VAR(pref->value.pdevice));
430
6.44M
                    break;
431
374k
                case t_fontID:
432
3.20M
                case t_struct:
433
3.49M
                case t_astruct:
434
3.49M
                case t_pdfctx:
435
3.49M
                    DO_RELOC(pref->value.pstruct,
436
3.49M
                             RELOC_VAR(pref->value.pstruct));
437
3.49M
                    break;
438
                    /* Non-trivial non-struct cases */
439
200M
                case t_dictionary:
440
200M
                    rputc(gcst->heap, 'd');
441
200M
                    SET_RELOC(pref->value.pdict,
442
200M
                              (dict *)igc_reloc_ref_ptr((ref_packed *)pref->value.pdict, gcst));
443
200M
                    break;
444
1.49G
                case t_array:
445
1.49G
                    {
446
1.49G
                        uint size = r_size(pref);
447
448
1.49G
                        if (size != 0) { /* value.refs might be NULL */
449
450
                            /*
451
                             * If the array is large, we allocated it in its
452
                             * own object (at least originally -- this might
453
                             * be a pointer to a subarray.)  In this case,
454
                             * we know it is the only object in its
455
                             * containing st_refs object, so we know that
456
                             * the mark containing the relocation appears
457
                             * just after it.
458
                             */
459
1.48G
                            if (size < max_size_st_refs / sizeof(ref)) {
460
1.45G
                                rputc(gcst->heap, 'a');
461
1.45G
                                SET_RELOC(pref->value.refs,
462
1.45G
                                    (ref *) igc_reloc_ref_ptr(
463
1.45G
                                     (ref_packed *) pref->value.refs, gcst));
464
1.45G
                            } else {
465
24.0M
                                rputc(gcst->heap, 'A');
466
                                /*
467
                                 * See the t_shortarray case below for why we
468
                                 * decrement size.
469
                                 */
470
24.0M
                                --size;
471
24.0M
                                SET_RELOC(pref->value.refs,
472
24.0M
                                    (ref *) igc_reloc_ref_ptr(
473
24.0M
                                   (ref_packed *) (pref->value.refs + size),
474
24.0M
                                                               gcst) - size);
475
24.0M
                            }
476
1.48G
                        }
477
1.49G
                    }
478
1.49G
                    break;
479
1.04G
                case t_mixedarray:
480
1.04G
                    if (r_size(pref) != 0) { /* value.refs might be NULL */
481
1.04G
                        rputc(gcst->heap, 'm');
482
1.04G
                        SET_RELOC(pref->value.packed,
483
1.04G
                                  igc_reloc_ref_ptr(pref->value.packed, gcst));
484
1.04G
                    }
485
1.04G
                    break;
486
466M
                case t_shortarray:
487
466M
                    {
488
466M
                        uint size = r_size(pref);
489
490
                        /*
491
                         * Since we know that igc_reloc_ref_ptr works by
492
                         * scanning forward, and we know that all the
493
                         * elements of this array itself are marked, we can
494
                         * save some scanning time by relocating the pointer
495
                         * to the end of the array rather than the
496
                         * beginning.
497
                         */
498
466M
                        if (size != 0) { /* value.refs might be NULL */
499
433M
                            rputc(gcst->heap, 's');
500
                            /*
501
                             * igc_reloc_ref_ptr has to be able to determine
502
                             * whether the pointer points into a space that
503
                             * isn't being collected.  It does this by
504
                             * checking whether the referent of the pointer
505
                             * is marked.  For this reason, we have to pass
506
                             * a pointer to the last real element of the
507
                             * array, rather than just beyond it.
508
                             */
509
433M
                            --size;
510
433M
                            SET_RELOC(pref->value.packed,
511
433M
                                igc_reloc_ref_ptr(pref->value.packed + size,
512
433M
                                                  gcst) - size);
513
433M
                        }
514
466M
                    }
515
466M
                    break;
516
4.77G
                case t_name:
517
4.77G
                    {
518
4.77G
                        void *psub = name_ref_sub_table(cmem, pref);
519
4.77G
                        void *rsub = RELOC_OBJ(psub); /* gcst implicit */
520
521
4.77G
                        SET_RELOC(pref->value.pname,
522
4.77G
                                  (name *)
523
4.77G
                                  ((char *)rsub + ((char *)pref->value.pname -
524
4.77G
                                                   (char *)psub)));
525
4.77G
                    } break;
526
278M
                case t_string:
527
278M
                    {
528
278M
                        gs_string str;
529
530
278M
                        str.data = pref->value.bytes;
531
278M
                        str.size = r_size(pref);
532
533
278M
                        DO_RELOC(str.data, RELOC_STRING_VAR(str));
534
278M
                        pref->value.bytes = str.data;
535
278M
                    }
536
278M
                    break;
537
106M
                case t_oparray:
538
106M
                    rputc(gcst->heap, 'o');
539
106M
                    SET_RELOC(pref->value.const_refs,
540
106M
                        (const ref *)igc_reloc_ref_ptr((const ref_packed *)pref->value.const_refs, gcst));
541
106M
                    break;
542
0
                default:
543
0
                    goto no_reloc; /* don't print trace message */
544
8.38G
            }
545
8.38G
            if_debug2m('8', gcst->heap, "  [8]relocated "PRI_INTPTR" => "PRI_INTPTR"\n",
546
8.38G
                       (intptr_t)before, (intptr_t)after);
547
8.38G
        }
548
24.4G
no_reloc:
549
24.4G
        rp += packed_per_ref;
550
24.4G
    }
551
347M
}
552
553
/* Relocate a pointer to a ref. */
554
/* See gsmemory.h for why the argument is const and the result is not. */
555
ref_packed *
556
igc_reloc_ref_ptr_nocheck(const ref_packed * prp, gc_state_t *gcst)
557
3.29G
{
558
    /*
559
     * Search forward for relocation.  This algorithm is intrinsically very
560
     * inefficient; we hope eventually to replace it with a better one.
561
     */
562
3.29G
    const ref_packed *rp = prp;
563
3.29G
    uint dec = 0;
564
#ifdef ALIGNMENT_ALIASING_BUG
565
    const ref *rpref;
566
# define RP_REF(rp) (rpref = (const ref *)rp, rpref)
567
#else
568
3.29G
# define RP_REF(rp) ((const ref *)rp)
569
3.29G
#endif
570
91.1G
    for (;;) {
571
572
91.1G
        if (r_is_packed(rp)) {
573
            /*
574
             * Normally, an unmarked packed ref will be an
575
             * integer whose value is the amount of relocation.
576
             * However, the relocation value might have been
577
             * too large to fit.  If this is the case, for
578
             * each such unmarked packed ref we pass over,
579
             * we have to decrement the final relocation.
580
             */
581
27.3G
            rputc(gcst->heap, (*rp & lp_mark ? '1' : '0'));
582
27.3G
            if (!(*rp & lp_mark)) {
583
705M
                if (*rp != pt_tag(pt_integer) + packed_max_value) {
584
                    /* This is a stored relocation value. */
585
589M
                    rputc(gcst->heap, '\n');
586
589M
                    rp = print_reloc(prp, "ref",
587
589M
                                     (const ref_packed *)
588
589M
                                     ((const char *)prp -
589
589M
                                      (*rp & packed_value_mask) + dec));
590
589M
                    break;
591
589M
                }
592
                /*
593
                 * We know this is the first of an aligned block
594
                 * of packed refs.  Skip over the entire block,
595
                 * decrementing the final relocation.
596
                 */
597
116M
                dec += sizeof(ref_packed) * align_packed_per_ref;
598
116M
                rp += align_packed_per_ref;
599
116M
            } else
600
26.6G
                rp++;
601
26.7G
            continue;
602
27.3G
        }
603
63.8G
        if (!ref_type_uses_size_or_null(r_type(RP_REF(rp)))) {
604
            /* reloc is in r_size */
605
2.70G
            rputc(gcst->heap, '\n');
606
2.70G
            rp = print_reloc(prp, "ref",
607
2.70G
                             (const ref_packed *)
608
2.70G
                             (r_size(RP_REF(rp)) == 0 ? prp :
609
2.70G
                              (const ref_packed *)((const char *)prp -
610
2.70G
                                                   r_size(RP_REF(rp)) + dec)));
611
2.70G
            break;
612
2.70G
        }
613
63.8G
        rputc(gcst->heap, 'u');
614
61.1G
        rp += packed_per_ref;
615
61.1G
    }
616
    /* Use a severely deprecated pun to remove the const property. */
617
3.29G
    {
618
3.29G
        union { const ref_packed *r; ref_packed *w; } u;
619
620
3.29G
        u.r = rp;
621
3.29G
        return u.w;
622
3.29G
    }
623
3.29G
#undef RP_REF
624
3.29G
}
625
ref_packed *
626
igc_reloc_ref_ptr(const ref_packed * prp, gc_state_t *gcst)
627
3.29G
{
628
    /*
629
     * Search forward for relocation.  This algorithm is intrinsically very
630
     * inefficient; we hope eventually to replace it with a better one.
631
     */
632
3.29G
    const ref_packed *rp = prp;
633
#ifdef ALIGNMENT_ALIASING_BUG
634
    const ref *rpref;
635
# define RP_REF(rp) (rpref = (const ref *)rp, rpref)
636
#else
637
3.29G
# define RP_REF(rp) ((const ref *)rp)
638
3.29G
#endif
639
    /*
640
     * Iff this pointer points into a space that wasn't traced,
641
     * the referent won't be marked.  In this case, we shouldn't
642
     * do any relocation.  Check for this first.
643
     */
644
3.29G
    if (r_is_packed(rp)) {
645
1.09G
        if (!r_has_pmark(rp))
646
167
            goto ret_rp;
647
2.19G
    } else {
648
2.19G
        if (!r_has_attr(RP_REF(rp), l_mark))
649
37.1k
            goto ret_rp;
650
2.19G
    }
651
3.29G
    return igc_reloc_ref_ptr_nocheck(prp, gcst);
652
37.2k
ret_rp:
653
    /* Use a severely deprecated pun to remove the const property. */
654
37.2k
    {
655
37.2k
        union { const ref_packed *r; ref_packed *w; } u;
656
657
37.2k
        u.r = rp;
658
37.2k
        return u.w;
659
3.29G
    }
660
3.29G
}
661
662
/* ------ Compaction phase ------ */
663
664
/* Compact a ref object. */
665
/* Remove the marks at the same time. */
666
static void
667
refs_compact(const gs_memory_t *mem, obj_header_t * pre, obj_header_t * dpre, uint size)
668
269M
{
669
269M
    ref_packed *dest;
670
269M
    ref_packed *src;
671
269M
    ref_packed *end;
672
269M
    uint new_size;
673
674
   /* The next switch controls an optimization
675
      for the loop termination condition.
676
      It was useful during the development,
677
      when some assumptions were temporary wrong.
678
      We keep it for records. */
679
680
269M
    src = (ref_packed *) (pre + 1);
681
269M
    end = (ref_packed *) ((byte *) src + size);
682
    /*
683
     * We know that a block of refs always ends with a
684
     * full-size ref, so we only need to check for reaching the end
685
     * of the block when we see one of those.
686
     */
687
269M
    if (dpre == pre)    /* Loop while we don't need to copy. */
688
16.7G
        for (;;) {
689
16.7G
            if (r_is_packed(src)) {
690
1.40G
                if (!r_has_pmark(src))
691
42.4M
                    break;
692
1.40G
                if_debug1m('8', mem, "  [8]packed ref "PRI_INTPTR" \"copied\"\n",
693
1.36G
                          (intptr_t)src);
694
1.36G
                *src &= ~lp_mark;
695
1.36G
                src++;
696
15.3G
            } else {   /* full-size ref */
697
15.3G
                ref *const pref = (ref *)src;
698
699
15.3G
                if (!r_has_attr(pref, l_mark))
700
62.0M
                    break;
701
15.3G
                if_debug1m('8', mem, "  [8]ref "PRI_INTPTR" \"copied\"\n", (intptr_t)src);
702
15.3G
                r_clear_attrs(pref, l_mark);
703
15.3G
                src += packed_per_ref;
704
15.3G
            }
705
16.7G
    } else
706
165M
        *dpre = *pre;
707
269M
    dest = (ref_packed *) ((char *)dpre + ((char *)src - (char *)pre));
708
18.0G
    for (;;) {
709
18.0G
        if (r_is_packed(src)) {
710
11.0G
            if (r_has_pmark(src)) {
711
8.72G
                if_debug2m('8', mem, "  [8]packed ref "PRI_INTPTR" copied to "PRI_INTPTR"\n",
712
8.72G
                          (intptr_t)src, (intptr_t)dest);
713
8.72G
                *dest++ = *src & ~lp_mark;
714
8.72G
            }
715
11.0G
            src++;
716
11.0G
        } else {   /* full-size ref */
717
7.03G
            if (r_has_attr((ref *) src, l_mark)) {
718
6.30G
                ref rtemp;
719
720
6.30G
                if_debug2m('8', mem, "  [8]ref "PRI_INTPTR" copied to "PRI_INTPTR"\n",
721
6.30G
                           (intptr_t)src, (intptr_t)dest);
722
                /* We can't just use ref_assign_inline, */
723
                /* because the source and destination */
724
                /* might overlap! */
725
6.30G
                ref_assign_inline(&rtemp, (ref *) src);
726
6.30G
                r_clear_attrs(&rtemp, l_mark);
727
6.30G
                ref_assign_inline((ref *) dest, &rtemp);
728
6.30G
                src += packed_per_ref;
729
6.30G
                dest += packed_per_ref;
730
6.30G
            } else {   /* check for end of block */
731
729M
                src += packed_per_ref;
732
729M
                if (src >= end)
733
269M
                    break;
734
729M
            }
735
7.03G
        }
736
18.0G
    }
737
269M
    new_size = (byte *) dest - (byte *) (dpre + 1) + sizeof(ref);
738
#ifdef DEBUG
739
    /* Check that the relocation came out OK. */
740
    /* NOTE: this check only works within a single clump. */
741
    if ((byte *) src - (byte *) dest != r_size((ref *) src - 1) + sizeof(ref)) {
742
        mlprintf3(mem, "Reloc error for refs "PRI_INTPTR": reloc = %lu, stored = %u\n",
743
                 (intptr_t) dpre, (ulong) ((byte *) src - (byte *) dest),
744
                 (uint) r_size((ref *) src - 1));
745
        gs_abort(mem);
746
    }
747
#endif
748
    /* Pad to a multiple of sizeof(ref). */
749
586M
    while (new_size % sizeof(ref))
750
317M
        *dest++ = pt_tag(pt_integer),
751
317M
            new_size += sizeof(ref_packed);
752
    /* We want to make the newly freed space into a free block, */
753
    /* but we can only do this if we have enough room. */
754
269M
    if (size - new_size < sizeof(obj_header_t)) { /* Not enough room.  Pad to original size. */
755
183M
        while (new_size < size)
756
0
            *dest++ = pt_tag(pt_integer),
757
0
                new_size += sizeof(ref_packed);
758
183M
    } else {
759
86.3M
        obj_header_t *pfree = (obj_header_t *) ((ref *) dest + 1);
760
761
86.3M
        pfree->o_pad = 0;
762
86.3M
        pfree->o_alone = 0;
763
86.3M
        pfree->o_size = size - new_size - sizeof(obj_header_t);
764
86.3M
        pfree->o_type = &st_bytes;
765
86.3M
    }
766
    /* Re-create the final ref. */
767
269M
    r_set_type((ref *) dest, t_integer);
768
269M
    dpre->o_size = new_size;
769
269M
}