gc.c 19.6 KB
Newer Older
Damien's avatar
Damien committed
1
2
#include <stdio.h>
#include <string.h>
mux's avatar
mux committed
3
#include <stdbool.h>
Damien's avatar
Damien committed
4

5
#include "mpconfig.h"
6
#include "misc.h"
Damien's avatar
Damien committed
7
8
#include "gc.h"

mux's avatar
mux committed
9
10
11
#include "misc.h"
#include "qstr.h"
#include "obj.h"
mux's avatar
mux committed
12
#include "runtime.h"
mux's avatar
mux committed
13

14
15
#if MICROPY_ENABLE_GC

16
17
#if 0 // print debugging info
#define DEBUG_PRINT (1)
18
#define DEBUG_printf DEBUG_printf
19
#else // don't print debugging info
20
#define DEBUG_printf(...) (void)0
21
22
#endif

Damien's avatar
Damien committed
23
24
25
26
#define WORDS_PER_BLOCK (4)
#define BYTES_PER_BLOCK (WORDS_PER_BLOCK * BYTES_PER_WORD)
#define STACK_SIZE (64) // tunable; minimum is 1

27
28
STATIC byte *gc_alloc_table_start;
STATIC machine_uint_t gc_alloc_table_byte_len;
29
30
31
#if MICROPY_ENABLE_FINALISER
STATIC byte *gc_finaliser_table_start;
#endif
32
33
STATIC machine_uint_t *gc_pool_start;
STATIC machine_uint_t *gc_pool_end;
Damien's avatar
Damien committed
34

35
36
37
STATIC int gc_stack_overflow;
STATIC machine_uint_t gc_stack[STACK_SIZE];
STATIC machine_uint_t *gc_sp;
38
STATIC machine_uint_t gc_lock_depth;
Damien's avatar
Damien committed
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

// ATB = allocation table byte
// 0b00 = FREE -- free block
// 0b01 = HEAD -- head of a chain of blocks
// 0b10 = TAIL -- in the tail of a chain of blocks
// 0b11 = MARK -- marked head block

#define AT_FREE (0)
#define AT_HEAD (1)
#define AT_TAIL (2)
#define AT_MARK (3)

#define BLOCKS_PER_ATB (4)
#define ATB_MASK_0 (0x03)
#define ATB_MASK_1 (0x0c)
#define ATB_MASK_2 (0x30)
#define ATB_MASK_3 (0xc0)

#define ATB_0_IS_FREE(a) (((a) & ATB_MASK_0) == 0)
#define ATB_1_IS_FREE(a) (((a) & ATB_MASK_1) == 0)
#define ATB_2_IS_FREE(a) (((a) & ATB_MASK_2) == 0)
#define ATB_3_IS_FREE(a) (((a) & ATB_MASK_3) == 0)

#define BLOCK_SHIFT(block) (2 * ((block) & (BLOCKS_PER_ATB - 1)))
#define ATB_GET_KIND(block) ((gc_alloc_table_start[(block) / BLOCKS_PER_ATB] >> BLOCK_SHIFT(block)) & 3)
#define ATB_ANY_TO_FREE(block) do { gc_alloc_table_start[(block) / BLOCKS_PER_ATB] &= (~(AT_MARK << BLOCK_SHIFT(block))); } while (0)
#define ATB_FREE_TO_HEAD(block) do { gc_alloc_table_start[(block) / BLOCKS_PER_ATB] |= (AT_HEAD << BLOCK_SHIFT(block)); } while (0)
#define ATB_FREE_TO_TAIL(block) do { gc_alloc_table_start[(block) / BLOCKS_PER_ATB] |= (AT_TAIL << BLOCK_SHIFT(block)); } while (0)
#define ATB_HEAD_TO_MARK(block) do { gc_alloc_table_start[(block) / BLOCKS_PER_ATB] |= (AT_MARK << BLOCK_SHIFT(block)); } while (0)
#define ATB_MARK_TO_HEAD(block) do { gc_alloc_table_start[(block) / BLOCKS_PER_ATB] &= (~(AT_TAIL << BLOCK_SHIFT(block))); } while (0)

#define BLOCK_FROM_PTR(ptr) (((ptr) - (machine_uint_t)gc_pool_start) / BYTES_PER_BLOCK)
#define PTR_FROM_BLOCK(block) (((block) * BYTES_PER_BLOCK + (machine_uint_t)gc_pool_start))
#define ATB_FROM_BLOCK(bl) ((bl) / BLOCKS_PER_ATB)

74
75
76
77
78
79
80
81
82
83
84
#if MICROPY_ENABLE_FINALISER
// FTB = finaliser table byte
// if set, then the corresponding block may have a finaliser

#define BLOCKS_PER_FTB (8)

#define FTB_GET(block) ((gc_finaliser_table_start[(block) / BLOCKS_PER_FTB] >> ((block) & 7)) & 1)
#define FTB_SET(block) do { gc_finaliser_table_start[(block) / BLOCKS_PER_FTB] |= (1 << ((block) & 7)); } while (0)
#define FTB_CLEAR(block) do { gc_finaliser_table_start[(block) / BLOCKS_PER_FTB] &= (~(1 << ((block) & 7))); } while (0)
#endif

85
86
87
88
// TODO waste less memory; currently requires that all entries in alloc_table have a corresponding block in pool
void gc_init(void *start, void *end) {
    // align end pointer on block boundary
    end = (void*)((machine_uint_t)end & (~(BYTES_PER_BLOCK - 1)));
89
90
91
92
93
94
95
96
97
98
99
100
101
102
    DEBUG_printf("Initializing GC heap: %p..%p = %ld bytes\n", start, end, end - start);

    // calculate parameters for GC (T=total, A=alloc table, F=finaliser table, P=pool; all in bytes):
    // T = A + F + P
    //     F = A * BLOCKS_PER_ATB / BLOCKS_PER_FTB
    //     P = A * BLOCKS_PER_ATB * BYTES_PER_BLOCK
    // => T = A * (1 + BLOCKS_PER_ATB / BLOCKS_PER_FTB + BLOCKS_PER_ATB * BYTES_PER_BLOCK)
    machine_uint_t total_byte_len = end - start;
#if MICROPY_ENABLE_FINALISER
    gc_alloc_table_byte_len = total_byte_len * BITS_PER_BYTE / (BITS_PER_BYTE + BITS_PER_BYTE * BLOCKS_PER_ATB / BLOCKS_PER_FTB + BITS_PER_BYTE * BLOCKS_PER_ATB * BYTES_PER_BLOCK);
#else
    gc_alloc_table_byte_len = total_byte_len / (1 + BITS_PER_BYTE / 2 * BYTES_PER_BLOCK);
#endif

103
104

    gc_alloc_table_start = (byte*)start;
mux's avatar
mux committed
105

106
107
108
109
#if MICROPY_ENABLE_FINALISER
    machine_uint_t gc_finaliser_table_byte_len = (gc_alloc_table_byte_len * BLOCKS_PER_ATB) / BLOCKS_PER_FTB;
    gc_finaliser_table_start = gc_alloc_table_start + gc_alloc_table_byte_len;
#endif
mux's avatar
mux committed
110

111
112
    machine_uint_t gc_pool_block_len = gc_alloc_table_byte_len * BLOCKS_PER_ATB;
    gc_pool_start = end - gc_pool_block_len * BYTES_PER_BLOCK;
113
114
115
116
117
    gc_pool_end = end;

    // clear ATBs
    memset(gc_alloc_table_start, 0, gc_alloc_table_byte_len);

118
119
120
121
#if MICROPY_ENABLE_FINALISER
    // clear FTBs
    memset(gc_finaliser_table_start, 0, gc_finaliser_table_byte_len);
#endif
mux's avatar
mux committed
122

123
124
125
126
127
128
129
    // allocate first block because gc_pool_start points there and it will never
    // be freed, so allocating 1 block with null pointers will minimise memory loss
    ATB_FREE_TO_HEAD(0);
    for (int i = 0; i < WORDS_PER_BLOCK; i++) {
        gc_pool_start[i] = 0;
    }

130
    // unlock the GC
131
    gc_lock_depth = 0;
132

133
    DEBUG_printf("GC layout:\n");
134
135
136
137
138
    DEBUG_printf("  alloc table at %p, length " UINT_FMT " bytes, " UINT_FMT " blocks\n", gc_alloc_table_start, gc_alloc_table_byte_len, gc_alloc_table_byte_len * BLOCKS_PER_ATB);
#if MICROPY_ENABLE_FINALISER
    DEBUG_printf("  finaliser table at %p, length " UINT_FMT " bytes, " UINT_FMT " blocks\n", gc_finaliser_table_start, gc_finaliser_table_byte_len, gc_finaliser_table_byte_len * BLOCKS_PER_FTB);
#endif
    DEBUG_printf("  pool at %p, length " UINT_FMT " bytes, " UINT_FMT " blocks\n", gc_pool_start, gc_pool_block_len * BYTES_PER_BLOCK, gc_pool_block_len);
139
140
}

141
142
143
144
145
146
147
148
void gc_lock(void) {
    gc_lock_depth++;
}

void gc_unlock(void) {
    gc_lock_depth--;
}

149
150
151
152
153
154
#define VERIFY_PTR(ptr) ( \
        (ptr & (BYTES_PER_BLOCK - 1)) == 0          /* must be aligned on a block */ \
        && ptr >= (machine_uint_t)gc_pool_start     /* must be above start of pool */ \
        && ptr < (machine_uint_t)gc_pool_end        /* must be below end of pool */ \
    )

Damien's avatar
Damien committed
155
156
#define VERIFY_MARK_AND_PUSH(ptr) \
    do { \
157
        if (VERIFY_PTR(ptr)) { \
Damien's avatar
Damien committed
158
159
160
161
162
163
164
165
166
167
168
169
170
            machine_uint_t _block = BLOCK_FROM_PTR(ptr); \
            if (ATB_GET_KIND(_block) == AT_HEAD) { \
                /* an unmarked head, mark it, and push it on gc stack */ \
                ATB_HEAD_TO_MARK(_block); \
                if (gc_sp < &gc_stack[STACK_SIZE]) { \
                    *gc_sp++ = _block; \
                } else { \
                    gc_stack_overflow = 1; \
                } \
            } \
        } \
    } while (0)

171
STATIC void gc_drain_stack(void) {
Damien's avatar
Damien committed
172
173
174
175
    while (gc_sp > gc_stack) {
        // pop the next block off the stack
        machine_uint_t block = *--gc_sp;

176
        // work out number of consecutive blocks in the chain starting with this one
Damien's avatar
Damien committed
177
178
179
180
181
182
183
184
185
186
187
188
189
190
        machine_uint_t n_blocks = 0;
        do {
            n_blocks += 1;
        } while (ATB_GET_KIND(block + n_blocks) == AT_TAIL);

        // check this block's children
        machine_uint_t *scan = (machine_uint_t*)PTR_FROM_BLOCK(block);
        for (machine_uint_t i = n_blocks * WORDS_PER_BLOCK; i > 0; i--, scan++) {
            machine_uint_t ptr2 = *scan;
            VERIFY_MARK_AND_PUSH(ptr2);
        }
    }
}

191
STATIC void gc_deal_with_stack_overflow(void) {
Damien's avatar
Damien committed
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
    while (gc_stack_overflow) {
        gc_stack_overflow = 0;
        gc_sp = gc_stack;

        // scan entire memory looking for blocks which have been marked but not their children
        for (machine_uint_t block = 0; block < gc_alloc_table_byte_len * BLOCKS_PER_ATB; block++) {
            // trace (again) if mark bit set
            if (ATB_GET_KIND(block) == AT_MARK) {
                *gc_sp++ = block;
                gc_drain_stack();
            }
        }
    }
}

207
STATIC void gc_sweep(void) {
Damien's avatar
Damien committed
208
209
210
211
212
    // free unmarked heads and their tails
    int free_tail = 0;
    for (machine_uint_t block = 0; block < gc_alloc_table_byte_len * BLOCKS_PER_ATB; block++) {
        switch (ATB_GET_KIND(block)) {
            case AT_HEAD:
213
214
215
216
217
218
219
220
221
222
223
#if MICROPY_ENABLE_FINALISER
                if (FTB_GET(block)) {
                    mp_obj_t obj = (mp_obj_t)PTR_FROM_BLOCK(block);
                    if (((mp_obj_base_t*)obj)->type != MP_OBJ_NULL) {
                        // if the object has a type then see if it has a __del__ method
                        mp_obj_t dest[2];
                        mp_load_method_maybe(obj, MP_QSTR___del__, dest);
                        if (dest[0] != MP_OBJ_NULL) {
                            // load_method returned a method
                            mp_call_method_n_kw(0, 0, dest);
                        }
mux's avatar
mux committed
224
                    }
225
226
                    // clear finaliser flag
                    FTB_CLEAR(block);
mux's avatar
mux committed
227
                }
228
#endif
Damien's avatar
Damien committed
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
                free_tail = 1;
                // fall through to free the head

            case AT_TAIL:
                if (free_tail) {
                    ATB_ANY_TO_FREE(block);
                }
                break;

            case AT_MARK:
                ATB_MARK_TO_HEAD(block);
                free_tail = 0;
                break;
        }
    }
}

246
void gc_collect_start(void) {
247
    gc_lock();
Damien's avatar
Damien committed
248
249
250
251
252
253
254
255
256
257
258
259
    gc_stack_overflow = 0;
    gc_sp = gc_stack;
}

void gc_collect_root(void **ptrs, machine_uint_t len) {
    for (machine_uint_t i = 0; i < len; i++) {
        machine_uint_t ptr = (machine_uint_t)ptrs[i];
        VERIFY_MARK_AND_PUSH(ptr);
        gc_drain_stack();
    }
}

260
void gc_collect_end(void) {
Damien's avatar
Damien committed
261
262
    gc_deal_with_stack_overflow();
    gc_sweep();
263
    gc_unlock();
264
}
Damien's avatar
Damien committed
265

266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
void gc_info(gc_info_t *info) {
    info->total = (gc_pool_end - gc_pool_start) * sizeof(machine_uint_t);
    info->used = 0;
    info->free = 0;
    info->num_1block = 0;
    info->num_2block = 0;
    info->max_block = 0;
    for (machine_uint_t block = 0, len = 0; block < gc_alloc_table_byte_len * BLOCKS_PER_ATB; block++) {
        machine_uint_t kind = ATB_GET_KIND(block);
        if (kind == AT_FREE || kind == AT_HEAD) {
            if (len == 1) {
                info->num_1block += 1;
            } else if (len == 2) {
                info->num_2block += 1;
            }
            if (len > info->max_block) {
                info->max_block = len;
            }
        }
        switch (kind) {
Damien's avatar
Damien committed
286
            case AT_FREE:
287
288
                info->free += 1;
                len = 0;
Damien's avatar
Damien committed
289
290
291
                break;

            case AT_HEAD:
292
293
294
295
                info->used += 1;
                len = 1;
                break;

Damien's avatar
Damien committed
296
            case AT_TAIL:
297
298
                info->used += 1;
                len += 1;
Damien's avatar
Damien committed
299
300
301
                break;

            case AT_MARK:
302
                // shouldn't happen
Damien's avatar
Damien committed
303
304
305
306
                break;
        }
    }

307
308
    info->used *= BYTES_PER_BLOCK;
    info->free *= BYTES_PER_BLOCK;
Damien's avatar
Damien committed
309
310
}

311
void *gc_alloc(machine_uint_t n_bytes, bool has_finaliser) {
Damien's avatar
Damien committed
312
    machine_uint_t n_blocks = ((n_bytes + BYTES_PER_BLOCK - 1) & (~(BYTES_PER_BLOCK - 1))) / BYTES_PER_BLOCK;
313
    DEBUG_printf("gc_alloc(" UINT_FMT " bytes -> " UINT_FMT " blocks)\n", n_bytes, n_blocks);
Damien's avatar
Damien committed
314

315
316
317
    // check if GC is locked
    if (gc_lock_depth > 0) {
        return NULL;
318
319
    }

Damien's avatar
Damien committed
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
    // check for 0 allocation
    if (n_blocks == 0) {
        return NULL;
    }

    machine_uint_t i;
    machine_uint_t end_block;
    machine_uint_t start_block;
    machine_uint_t n_free = 0;
    int collected = 0;
    for (;;) {

        // look for a run of n_blocks available blocks
        for (i = 0; i < gc_alloc_table_byte_len; i++) {
            byte a = gc_alloc_table_start[i];
            if (ATB_0_IS_FREE(a)) { if (++n_free >= n_blocks) { i = i * BLOCKS_PER_ATB + 0; goto found; } } else { n_free = 0; }
            if (ATB_1_IS_FREE(a)) { if (++n_free >= n_blocks) { i = i * BLOCKS_PER_ATB + 1; goto found; } } else { n_free = 0; }
            if (ATB_2_IS_FREE(a)) { if (++n_free >= n_blocks) { i = i * BLOCKS_PER_ATB + 2; goto found; } } else { n_free = 0; }
            if (ATB_3_IS_FREE(a)) { if (++n_free >= n_blocks) { i = i * BLOCKS_PER_ATB + 3; goto found; } } else { n_free = 0; }
        }

        // nothing found!
        if (collected) {
            return NULL;
        }
345
        DEBUG_printf("gc_alloc(" UINT_FMT "): no free mem, triggering GC\n", n_bytes);
Damien's avatar
Damien committed
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
        gc_collect();
        collected = 1;
    }

    // found, ending at block i inclusive
found:
    // get starting and end blocks, both inclusive
    end_block = i;
    start_block = i - n_free + 1;

    // mark first block as used head
    ATB_FREE_TO_HEAD(start_block);

    // mark rest of blocks as used tail
    // TODO for a run of many blocks can make this more efficient
    for (machine_uint_t bl = start_block + 1; bl <= end_block; bl++) {
        ATB_FREE_TO_TAIL(bl);
    }

365
366
367
368
369
370
371
372
373
    // get pointer to first block
    void *ret_ptr = (void*)(gc_pool_start + start_block * WORDS_PER_BLOCK);

#if MICROPY_ENABLE_FINALISER
    if (has_finaliser) {
        // clear type pointer in case it is never set
        ((mp_obj_base_t*)ret_ptr)->type = MP_OBJ_NULL;
        // set mp_obj flag only if it has a finaliser
        FTB_SET(start_block);
mux's avatar
mux committed
374
    }
375
#endif
mux's avatar
mux committed
376

377
    return ret_ptr;
Damien's avatar
Damien committed
378
379
}

380
/*
mux's avatar
mux committed
381
382
383
384
void *gc_alloc(machine_uint_t n_bytes) {
    return _gc_alloc(n_bytes, false);
}

385
void *gc_alloc_with_finaliser(machine_uint_t n_bytes) {
mux's avatar
mux committed
386
387
    return _gc_alloc(n_bytes, true);
}
388
*/
mux's avatar
mux committed
389

390
391
// force the freeing of a piece of memory
void gc_free(void *ptr_in) {
392
393
394
    if (gc_lock_depth > 0) {
        // TODO how to deal with this error?
        return;
395
396
    }

397
398
399
400
401
402
403
404
405
406
407
408
409
410
    machine_uint_t ptr = (machine_uint_t)ptr_in;

    if (VERIFY_PTR(ptr)) {
        machine_uint_t block = BLOCK_FROM_PTR(ptr);
        if (ATB_GET_KIND(block) == AT_HEAD) {
            // free head and all of its tail blocks
            do {
                ATB_ANY_TO_FREE(block);
                block += 1;
            } while (ATB_GET_KIND(block) == AT_TAIL);
        }
    }
}

Damien's avatar
Damien committed
411
412
413
machine_uint_t gc_nbytes(void *ptr_in) {
    machine_uint_t ptr = (machine_uint_t)ptr_in;

414
    if (VERIFY_PTR(ptr)) {
Damien's avatar
Damien committed
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
        machine_uint_t block = BLOCK_FROM_PTR(ptr);
        if (ATB_GET_KIND(block) == AT_HEAD) {
            // work out number of consecutive blocks in the chain starting with this on
            machine_uint_t n_blocks = 0;
            do {
                n_blocks += 1;
            } while (ATB_GET_KIND(block + n_blocks) == AT_TAIL);
            return n_blocks * BYTES_PER_BLOCK;
        }
    }

    // invalid pointer
    return 0;
}

mux's avatar
mux committed
430
#if 0
431
// old, simple realloc that didn't expand memory in place
432
433
434
435
436
void *gc_realloc(void *ptr, machine_uint_t n_bytes) {
    machine_uint_t n_existing = gc_nbytes(ptr);
    if (n_bytes <= n_existing) {
        return ptr;
    } else {
437
438
439
440
441
442
443
444
        // TODO false is incorrect! Should get value from current block!
        void *ptr2 = gc_alloc(n_bytes,
#if MICROPY_ENABLE_FINALISER
                        FTB_GET(BLOCK_FROM_PTR((machine_uint_t)ptr))
#else
                        false
#endif
        );
445
446
447
448
449
450
451
452
        if (ptr2 == NULL) {
            return ptr2;
        }
        memcpy(ptr2, ptr, n_existing);
        gc_free(ptr);
        return ptr2;
    }
}
453
454

#else // Alternative gc_realloc impl
455

mux's avatar
mux committed
456
void *gc_realloc(void *ptr_in, machine_uint_t n_bytes) {
457
458
    if (gc_lock_depth > 0) {
        return NULL;
459
460
    }

mux's avatar
mux committed
461
    void *ptr_out = NULL;
462
    machine_uint_t block = 0;
mux's avatar
mux committed
463
464
465
    machine_uint_t ptr = (machine_uint_t)ptr_in;

    if (ptr_in == NULL) {
466
        return gc_alloc(n_bytes, false);
mux's avatar
mux committed
467
468
    }

Damien George's avatar
Damien George committed
469
470
471
    if (VERIFY_PTR(ptr)                         // verify pointer
        && (block = BLOCK_FROM_PTR(ptr))        // get first block
        && ATB_GET_KIND(block) == AT_HEAD) {    // make sure it's a HEAD block
mux's avatar
mux committed
472
473
474

        byte block_type;
        machine_uint_t n_free   = 0;
Damien George's avatar
Damien George committed
475
        machine_uint_t n_blocks = 1; // counting HEAD block
mux's avatar
mux committed
476
        machine_uint_t max_block = gc_alloc_table_byte_len * BLOCKS_PER_ATB;
mux's avatar
mux committed
477

Damien George's avatar
Damien George committed
478
479
480
        // get the number of consecutive tail blocks and
        // the number of free blocks after last tail block
        // stop if we reach (or are at) end of heap
mux's avatar
mux committed
481
        while ((block + n_blocks + n_free) < max_block
Damien George's avatar
Damien George committed
482
                // stop as soon as we find enough blocks for n_bytes
mux's avatar
mux committed
483
                && (n_bytes > ((n_blocks+n_free) * BYTES_PER_BLOCK))
Damien George's avatar
Damien George committed
484
                // stop if block is HEAD
mux's avatar
mux committed
485
                && (block_type = ATB_GET_KIND(block + n_blocks + n_free)) != AT_HEAD) {
mux's avatar
mux committed
486
487
488
489
490
            switch (block_type) {
                case AT_FREE: n_free++; break;
                case AT_TAIL: n_blocks++; break;
                default: break;
            }
mux's avatar
mux committed
491
        }
Damien George's avatar
Damien George committed
492
        // number of allocated bytes
mux's avatar
mux committed
493
494
        machine_uint_t n_existing = n_blocks * BYTES_PER_BLOCK;

Damien George's avatar
Damien George committed
495
        // check if realloc'ing to a smaller size
mux's avatar
mux committed
496
497
        if (n_bytes <= n_existing) {
            ptr_out = ptr_in;
Damien George's avatar
Damien George committed
498
            // free unneeded tail blocks
499
500
            for (machine_uint_t bl = block + n_blocks; ATB_GET_KIND(bl) == AT_TAIL; bl++) {
                ATB_ANY_TO_FREE(bl);
mux's avatar
mux committed
501
502
            }

Damien George's avatar
Damien George committed
503
        // check if we can expand in place
mux's avatar
mux committed
504
        } else if (n_bytes <= (n_existing + (n_free * BYTES_PER_BLOCK))) {
Damien George's avatar
Damien George committed
505
            // number of blocks needed to expand +1 if there's a remainder
mux's avatar
mux committed
506
507
508
509
510
511
            machine_uint_t n_diff = ( n_bytes - n_existing)/BYTES_PER_BLOCK+
                                    ((n_bytes - n_existing)%BYTES_PER_BLOCK!=0);

            DEBUG_printf("gc_realloc: expanding " UINT_FMT " blocks (" UINT_FMT " bytes) to " UINT_FMT " blocks (" UINT_FMT " bytes)\n",
                    n_existing/BYTES_PER_BLOCK, n_existing, n_existing/BYTES_PER_BLOCK+n_diff, n_existing + n_diff*BYTES_PER_BLOCK);

Damien George's avatar
Damien George committed
512
            // mark rest of blocks as used tail
513
            for (machine_uint_t bl = block + n_blocks; bl < (block + n_blocks + n_diff); bl++) {
mux's avatar
mux committed
514
515
516
517
                ATB_FREE_TO_TAIL(bl);
            }
            ptr_out = ptr_in;

Damien George's avatar
Damien George committed
518
        // try to find a new contiguous chain
519
520
521
522
523
524
525
        } else if ((ptr_out = gc_alloc(n_bytes,
#if MICROPY_ENABLE_FINALISER
                        FTB_GET(block)
#else
                        false
#endif
                        )) != NULL) {
Damien George's avatar
Damien George committed
526
            DEBUG_printf("gc_realloc: allocating new block\n");
mux's avatar
mux committed
527
528
            memcpy(ptr_out, ptr_in, n_existing);
            gc_free(ptr_in);
529
        }
Damien's avatar
Damien committed
530
    }
mux's avatar
mux committed
531
532

    return ptr_out;
Damien's avatar
Damien committed
533
}
534
#endif // Alternative gc_realloc impl
mux's avatar
mux committed
535

536
537
538
539
540
541
542
543
void gc_dump_info() {
    gc_info_t info;
    gc_info(&info);
    printf("GC: total: " UINT_FMT ", used: " UINT_FMT ", free: " UINT_FMT "\n", info.total, info.used, info.free);
    printf(" No. of 1-blocks: " UINT_FMT ", 2-blocks: " UINT_FMT ", max blk sz: " UINT_FMT "\n",
           info.num_1block, info.num_2block, info.max_block);
}

544
545
void gc_dump_alloc_table(void) {
    printf("GC memory layout:");
546
    for (machine_uint_t bl = 0; bl < gc_alloc_table_byte_len * BLOCKS_PER_ATB; bl++) {
547
548
549
550
        if (bl % 64 == 0) {
            printf("\n%04x: ", (uint)bl);
        }
        int c = ' ';
551
        switch (ATB_GET_KIND(bl)) {
552
553
554
555
            case AT_FREE: c = '.'; break;
            case AT_HEAD: c = 'h'; break;
            case AT_TAIL: c = 't'; break;
            case AT_MARK: c = 'm'; break;
556
        }
557
        printf("%c", c);
558
    }
559
    printf("\n");
560
561
}

562
#if DEBUG_PRINT
563
564
void gc_test(void) {
    machine_uint_t len = 500;
Damien's avatar
Damien committed
565
566
567
568
    machine_uint_t *heap = malloc(len);
    gc_init(heap, heap + len / sizeof(machine_uint_t));
    void *ptrs[100];
    {
569
570
571
572
573
574
        machine_uint_t **p = gc_alloc(16, false);
        p[0] = gc_alloc(64, false);
        p[1] = gc_alloc(1, false);
        p[2] = gc_alloc(1, false);
        p[3] = gc_alloc(1, false);
        machine_uint_t ***p2 = gc_alloc(16, false);
Damien's avatar
Damien committed
575
576
577
578
        p2[0] = p;
        p2[1] = p;
        ptrs[0] = p2;
    }
579
    for (int i = 0; i < 25; i+=2) {
580
        machine_uint_t *p = gc_alloc(i, false);
Damien's avatar
Damien committed
581
582
583
584
585
586
        printf("p=%p\n", p);
        if (i & 3) {
            //ptrs[i] = p;
        }
    }

587
    printf("Before GC:\n");
588
    gc_dump_alloc_table();
589
590
591
592
593
    printf("Starting GC...\n");
    gc_collect_start();
    gc_collect_root(ptrs, sizeof(ptrs) / sizeof(void*));
    gc_collect_end();
    printf("After GC:\n");
594
    gc_dump_alloc_table();
Damien's avatar
Damien committed
595
}
596
#endif
597
598

#endif // MICROPY_ENABLE_GC