2014-05-05 23:16:43 +00:00
|
|
|
/*
|
2017-06-30 07:22:17 +00:00
|
|
|
* This file is part of the MicroPython project, http://micropython.org/
|
2014-05-05 23:16:43 +00:00
|
|
|
*
|
|
|
|
* The MIT License (MIT)
|
|
|
|
*
|
|
|
|
* Copyright (c) 2013, 2014 Damien P. George
|
|
|
|
*
|
|
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
|
|
* of this software and associated documentation files (the "Software"), to deal
|
|
|
|
* in the Software without restriction, including without limitation the rights
|
|
|
|
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
|
|
* copies of the Software, and to permit persons to whom the Software is
|
|
|
|
* furnished to do so, subject to the following conditions:
|
|
|
|
*
|
|
|
|
* The above copyright notice and this permission notice shall be included in
|
|
|
|
* all copies or substantial portions of the Software.
|
|
|
|
*
|
|
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
|
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
|
|
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
|
|
* THE SOFTWARE.
|
|
|
|
*/
|
|
|
|
|
2015-01-01 23:30:53 +00:00
|
|
|
#include "py/mpstate.h"
|
2015-01-01 20:27:54 +00:00
|
|
|
#include "py/obj.h"
|
|
|
|
#include "py/gc.h"
|
2014-05-05 23:16:43 +00:00
|
|
|
|
2014-05-24 22:03:12 +00:00
|
|
|
#if MICROPY_PY_GC && MICROPY_ENABLE_GC
|
2014-05-05 23:16:43 +00:00
|
|
|
|
2017-08-30 11:02:00 +00:00
|
|
|
// collect(): run a garbage collection
|
2014-05-05 23:16:43 +00:00
|
|
|
STATIC mp_obj_t py_gc_collect(void) {
|
|
|
|
gc_collect();
|
2020-02-27 04:36:53 +00:00
|
|
|
#if MICROPY_PY_GC_COLLECT_RETVAL
|
2015-02-07 17:24:10 +00:00
|
|
|
return MP_OBJ_NEW_SMALL_INT(MP_STATE_MEM(gc_collected));
|
2020-02-27 04:36:53 +00:00
|
|
|
#else
|
2014-05-05 23:16:43 +00:00
|
|
|
return mp_const_none;
|
2020-02-27 04:36:53 +00:00
|
|
|
#endif
|
2014-05-05 23:16:43 +00:00
|
|
|
}
|
|
|
|
MP_DEFINE_CONST_FUN_OBJ_0(gc_collect_obj, py_gc_collect);
|
|
|
|
|
2017-08-30 11:02:00 +00:00
|
|
|
// disable(): disable the garbage collector
|
2014-05-08 22:04:49 +00:00
|
|
|
STATIC mp_obj_t gc_disable(void) {
|
2015-01-01 23:30:53 +00:00
|
|
|
MP_STATE_MEM(gc_auto_collect_enabled) = 0;
|
2014-05-08 22:04:49 +00:00
|
|
|
return mp_const_none;
|
|
|
|
}
|
|
|
|
MP_DEFINE_CONST_FUN_OBJ_0(gc_disable_obj, gc_disable);
|
|
|
|
|
2017-08-30 11:02:00 +00:00
|
|
|
// enable(): enable the garbage collector
|
2014-05-08 22:04:49 +00:00
|
|
|
STATIC mp_obj_t gc_enable(void) {
|
2015-01-01 23:30:53 +00:00
|
|
|
MP_STATE_MEM(gc_auto_collect_enabled) = 1;
|
2014-05-08 22:04:49 +00:00
|
|
|
return mp_const_none;
|
|
|
|
}
|
|
|
|
MP_DEFINE_CONST_FUN_OBJ_0(gc_enable_obj, gc_enable);
|
|
|
|
|
2014-10-31 21:30:46 +00:00
|
|
|
STATIC mp_obj_t gc_isenabled(void) {
|
2015-10-11 09:09:43 +00:00
|
|
|
return mp_obj_new_bool(MP_STATE_MEM(gc_auto_collect_enabled));
|
2014-10-31 21:30:46 +00:00
|
|
|
}
|
|
|
|
MP_DEFINE_CONST_FUN_OBJ_0(gc_isenabled_obj, gc_isenabled);
|
|
|
|
|
2017-08-30 11:02:00 +00:00
|
|
|
// mem_free(): return the number of bytes of available heap RAM
|
2014-06-24 18:23:40 +00:00
|
|
|
STATIC mp_obj_t gc_mem_free(void) {
|
|
|
|
gc_info_t info;
|
|
|
|
gc_info(&info);
|
2014-07-31 09:49:14 +00:00
|
|
|
return MP_OBJ_NEW_SMALL_INT(info.free);
|
2014-06-24 18:23:40 +00:00
|
|
|
}
|
|
|
|
MP_DEFINE_CONST_FUN_OBJ_0(gc_mem_free_obj, gc_mem_free);
|
|
|
|
|
2017-08-30 11:02:00 +00:00
|
|
|
// mem_alloc(): return the number of bytes of heap RAM that are allocated
|
2014-06-24 18:23:40 +00:00
|
|
|
STATIC mp_obj_t gc_mem_alloc(void) {
|
|
|
|
gc_info_t info;
|
|
|
|
gc_info(&info);
|
2014-07-31 09:49:14 +00:00
|
|
|
return MP_OBJ_NEW_SMALL_INT(info.used);
|
2014-06-24 18:23:40 +00:00
|
|
|
}
|
|
|
|
MP_DEFINE_CONST_FUN_OBJ_0(gc_mem_alloc_obj, gc_mem_alloc);
|
|
|
|
|
py/gc: Implement GC running by allocation threshold.
Currently, MicroPython runs GC when it could not allocate a block of memory,
which happens when heap is exhausted. However, that policy can't work well
with "inifinity" heaps, e.g. backed by a virtual memory - there will be a
lot of swap thrashing long before VM will be exhausted. Instead, in such
cases "allocation threshold" policy is used: a GC is run after some number of
allocations have been made. Details vary, for example, number or total amount
of allocations can be used, threshold may be self-adjusting based on GC
outcome, etc.
This change implements a simple variant of such policy for MicroPython. Amount
of allocated memory so far is used for threshold, to make it useful to typical
finite-size, and small, heaps as used with MicroPython ports. And such GC policy
is indeed useful for such types of heaps too, as it allows to better control
fragmentation. For example, if a threshold is set to half size of heap, then
for an application which usually makes big number of small allocations, that
will (try to) keep half of heap memory in a nice defragmented state for an
occasional large allocation.
For an application which doesn't exhibit such behavior, there won't be any
visible effects, except for GC running more frequently, which however may
affect performance. To address this, the GC threshold is configurable, and
by default is off so far. It's configured with gc.threshold(amount_in_bytes)
call (can be queries without an argument).
2016-07-20 21:37:30 +00:00
|
|
|
#if MICROPY_GC_ALLOC_THRESHOLD
|
|
|
|
STATIC mp_obj_t gc_threshold(size_t n_args, const mp_obj_t *args) {
|
|
|
|
if (n_args == 0) {
|
|
|
|
if (MP_STATE_MEM(gc_alloc_threshold) == (size_t)-1) {
|
|
|
|
return MP_OBJ_NEW_SMALL_INT(-1);
|
|
|
|
}
|
|
|
|
return mp_obj_new_int(MP_STATE_MEM(gc_alloc_threshold) * MICROPY_BYTES_PER_GC_BLOCK);
|
|
|
|
}
|
|
|
|
mp_int_t val = mp_obj_get_int(args[0]);
|
|
|
|
if (val < 0) {
|
|
|
|
MP_STATE_MEM(gc_alloc_threshold) = (size_t)-1;
|
|
|
|
} else {
|
|
|
|
MP_STATE_MEM(gc_alloc_threshold) = val / MICROPY_BYTES_PER_GC_BLOCK;
|
|
|
|
}
|
|
|
|
return mp_const_none;
|
|
|
|
}
|
|
|
|
MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(gc_threshold_obj, 0, 1, gc_threshold);
|
|
|
|
#endif
|
|
|
|
|
2015-11-27 13:38:15 +00:00
|
|
|
STATIC const mp_rom_map_elem_t mp_module_gc_globals_table[] = {
|
|
|
|
{ MP_ROM_QSTR(MP_QSTR___name__), MP_ROM_QSTR(MP_QSTR_gc) },
|
|
|
|
{ MP_ROM_QSTR(MP_QSTR_collect), MP_ROM_PTR(&gc_collect_obj) },
|
|
|
|
{ MP_ROM_QSTR(MP_QSTR_disable), MP_ROM_PTR(&gc_disable_obj) },
|
|
|
|
{ MP_ROM_QSTR(MP_QSTR_enable), MP_ROM_PTR(&gc_enable_obj) },
|
|
|
|
{ MP_ROM_QSTR(MP_QSTR_isenabled), MP_ROM_PTR(&gc_isenabled_obj) },
|
|
|
|
{ MP_ROM_QSTR(MP_QSTR_mem_free), MP_ROM_PTR(&gc_mem_free_obj) },
|
|
|
|
{ MP_ROM_QSTR(MP_QSTR_mem_alloc), MP_ROM_PTR(&gc_mem_alloc_obj) },
|
py/gc: Implement GC running by allocation threshold.
Currently, MicroPython runs GC when it could not allocate a block of memory,
which happens when heap is exhausted. However, that policy can't work well
with "inifinity" heaps, e.g. backed by a virtual memory - there will be a
lot of swap thrashing long before VM will be exhausted. Instead, in such
cases "allocation threshold" policy is used: a GC is run after some number of
allocations have been made. Details vary, for example, number or total amount
of allocations can be used, threshold may be self-adjusting based on GC
outcome, etc.
This change implements a simple variant of such policy for MicroPython. Amount
of allocated memory so far is used for threshold, to make it useful to typical
finite-size, and small, heaps as used with MicroPython ports. And such GC policy
is indeed useful for such types of heaps too, as it allows to better control
fragmentation. For example, if a threshold is set to half size of heap, then
for an application which usually makes big number of small allocations, that
will (try to) keep half of heap memory in a nice defragmented state for an
occasional large allocation.
For an application which doesn't exhibit such behavior, there won't be any
visible effects, except for GC running more frequently, which however may
affect performance. To address this, the GC threshold is configurable, and
by default is off so far. It's configured with gc.threshold(amount_in_bytes)
call (can be queries without an argument).
2016-07-20 21:37:30 +00:00
|
|
|
#if MICROPY_GC_ALLOC_THRESHOLD
|
|
|
|
{ MP_ROM_QSTR(MP_QSTR_threshold), MP_ROM_PTR(&gc_threshold_obj) },
|
|
|
|
#endif
|
2014-05-05 23:16:43 +00:00
|
|
|
};
|
|
|
|
|
2014-11-29 14:39:27 +00:00
|
|
|
STATIC MP_DEFINE_CONST_DICT(mp_module_gc_globals, mp_module_gc_globals_table);
|
2014-05-05 23:16:43 +00:00
|
|
|
|
|
|
|
const mp_obj_module_t mp_module_gc = {
|
|
|
|
.base = { &mp_type_module },
|
2020-02-27 04:36:53 +00:00
|
|
|
.globals = (mp_obj_dict_t *)&mp_module_gc_globals,
|
2014-05-05 23:16:43 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
#endif
|