2014-05-06 00:16:43 +01:00
|
|
|
/*
|
|
|
|
* This file is part of the Micro Python project, http://micropython.org/
|
|
|
|
*
|
|
|
|
* 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-06 00:16:43 +01:00
|
|
|
|
2014-05-24 23:03:12 +01:00
|
|
|
#if MICROPY_PY_GC && MICROPY_ENABLE_GC
|
2014-05-06 00:16:43 +01:00
|
|
|
|
2014-08-10 17:50:28 +01:00
|
|
|
/// \module gc - control the garbage collector
|
|
|
|
|
2014-06-05 20:48:02 +01:00
|
|
|
extern uint gc_collected;
|
|
|
|
|
2014-08-10 17:50:28 +01:00
|
|
|
/// \function collect()
|
|
|
|
/// Run a garbage collection.
|
2014-05-06 00:16:43 +01:00
|
|
|
STATIC mp_obj_t py_gc_collect(void) {
|
|
|
|
gc_collect();
|
2014-06-05 20:48:02 +01: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));
|
2014-06-05 20:48:02 +01:00
|
|
|
#else
|
2014-05-06 00:16:43 +01:00
|
|
|
return mp_const_none;
|
2014-06-05 20:48:02 +01:00
|
|
|
#endif
|
2014-05-06 00:16:43 +01:00
|
|
|
}
|
|
|
|
MP_DEFINE_CONST_FUN_OBJ_0(gc_collect_obj, py_gc_collect);
|
|
|
|
|
2014-08-10 17:50:28 +01:00
|
|
|
/// \function disable()
|
|
|
|
/// Disable the garbage collector.
|
2014-05-08 23:04:49 +01: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 23:04:49 +01:00
|
|
|
return mp_const_none;
|
|
|
|
}
|
|
|
|
MP_DEFINE_CONST_FUN_OBJ_0(gc_disable_obj, gc_disable);
|
|
|
|
|
2014-08-10 17:50:28 +01:00
|
|
|
/// \function enable()
|
|
|
|
/// Enable the garbage collector.
|
2014-05-08 23:04:49 +01: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 23:04:49 +01: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-01-01 23:30:53 +00:00
|
|
|
return MP_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);
|
|
|
|
|
2014-08-10 17:50:28 +01:00
|
|
|
/// \function mem_free()
|
|
|
|
/// Return the number of bytes of available heap RAM.
|
2014-06-24 19:23:40 +01:00
|
|
|
STATIC mp_obj_t gc_mem_free(void) {
|
|
|
|
gc_info_t info;
|
|
|
|
gc_info(&info);
|
2014-07-31 10:49:14 +01:00
|
|
|
return MP_OBJ_NEW_SMALL_INT(info.free);
|
2014-06-24 19:23:40 +01:00
|
|
|
}
|
|
|
|
MP_DEFINE_CONST_FUN_OBJ_0(gc_mem_free_obj, gc_mem_free);
|
|
|
|
|
2014-08-10 17:50:28 +01:00
|
|
|
/// \function mem_alloc()
|
|
|
|
/// Return the number of bytes of heap RAM that are allocated.
|
2014-06-24 19:23:40 +01:00
|
|
|
STATIC mp_obj_t gc_mem_alloc(void) {
|
|
|
|
gc_info_t info;
|
|
|
|
gc_info(&info);
|
2014-07-31 10:49:14 +01:00
|
|
|
return MP_OBJ_NEW_SMALL_INT(info.used);
|
2014-06-24 19:23:40 +01:00
|
|
|
}
|
|
|
|
MP_DEFINE_CONST_FUN_OBJ_0(gc_mem_alloc_obj, gc_mem_alloc);
|
|
|
|
|
2014-05-06 00:16:43 +01:00
|
|
|
STATIC const mp_map_elem_t mp_module_gc_globals_table[] = {
|
|
|
|
{ MP_OBJ_NEW_QSTR(MP_QSTR___name__), MP_OBJ_NEW_QSTR(MP_QSTR_gc) },
|
|
|
|
{ MP_OBJ_NEW_QSTR(MP_QSTR_collect), (mp_obj_t)&gc_collect_obj },
|
2014-05-08 23:04:49 +01:00
|
|
|
{ MP_OBJ_NEW_QSTR(MP_QSTR_disable), (mp_obj_t)&gc_disable_obj },
|
|
|
|
{ MP_OBJ_NEW_QSTR(MP_QSTR_enable), (mp_obj_t)&gc_enable_obj },
|
2014-10-31 21:30:46 +00:00
|
|
|
{ MP_OBJ_NEW_QSTR(MP_QSTR_isenabled), (mp_obj_t)&gc_isenabled_obj },
|
2014-06-24 19:23:40 +01:00
|
|
|
{ MP_OBJ_NEW_QSTR(MP_QSTR_mem_free), (mp_obj_t)&gc_mem_free_obj },
|
|
|
|
{ MP_OBJ_NEW_QSTR(MP_QSTR_mem_alloc), (mp_obj_t)&gc_mem_alloc_obj },
|
2014-05-06 00:16:43 +01: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-06 00:16:43 +01:00
|
|
|
|
|
|
|
const mp_obj_module_t mp_module_gc = {
|
|
|
|
.base = { &mp_type_module },
|
|
|
|
.name = MP_QSTR_gc,
|
|
|
|
.globals = (mp_obj_dict_t*)&mp_module_gc_globals,
|
|
|
|
};
|
|
|
|
|
|
|
|
#endif
|