2014-05-03 23:27:38 +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 20:27:54 +00:00
|
|
|
#ifndef __MICROPY_INCLUDED_PY_GC_H__
|
|
|
|
#define __MICROPY_INCLUDED_PY_GC_H__
|
|
|
|
|
|
|
|
#include <stdint.h>
|
|
|
|
|
|
|
|
#include "py/mpconfig.h"
|
|
|
|
#include "py/misc.h"
|
2014-05-03 23:27:38 +01:00
|
|
|
|
2013-10-21 23:45:08 +01:00
|
|
|
void gc_init(void *start, void *end);
|
2014-04-08 12:31:21 +01:00
|
|
|
|
|
|
|
// These lock/unlock functions can be nested.
|
|
|
|
// They can be used to prevent the GC from allocating/freeing.
|
|
|
|
void gc_lock(void);
|
|
|
|
void gc_unlock(void);
|
2014-07-01 06:49:21 +01:00
|
|
|
bool gc_is_locked(void);
|
2014-04-08 12:31:21 +01:00
|
|
|
|
|
|
|
// A given port must implement gc_collect by using the other collect functions.
|
|
|
|
void gc_collect(void);
|
2013-10-23 20:20:17 +01:00
|
|
|
void gc_collect_start(void);
|
2014-07-03 13:25:24 +01:00
|
|
|
void gc_collect_root(void **ptrs, mp_uint_t len);
|
2013-10-23 20:20:17 +01:00
|
|
|
void gc_collect_end(void);
|
2014-04-08 12:31:21 +01:00
|
|
|
|
2014-07-03 13:25:24 +01:00
|
|
|
void *gc_alloc(mp_uint_t n_bytes, bool has_finaliser);
|
2013-10-22 20:26:36 +01:00
|
|
|
void gc_free(void *ptr);
|
2014-10-24 23:12:25 +01:00
|
|
|
mp_uint_t gc_nbytes(const void *ptr);
|
2014-07-03 13:25:24 +01:00
|
|
|
void *gc_realloc(void *ptr, mp_uint_t n_bytes);
|
2013-10-22 15:25:25 +01:00
|
|
|
|
|
|
|
typedef struct _gc_info_t {
|
2014-07-03 13:25:24 +01:00
|
|
|
mp_uint_t total;
|
|
|
|
mp_uint_t used;
|
|
|
|
mp_uint_t free;
|
|
|
|
mp_uint_t num_1block;
|
|
|
|
mp_uint_t num_2block;
|
|
|
|
mp_uint_t max_block;
|
2013-10-22 15:25:25 +01:00
|
|
|
} gc_info_t;
|
|
|
|
|
|
|
|
void gc_info(gc_info_t *info);
|
2014-02-11 21:53:34 +00:00
|
|
|
void gc_dump_info(void);
|
2014-02-26 22:55:59 +00:00
|
|
|
void gc_dump_alloc_table(void);
|
2015-01-01 20:27:54 +00:00
|
|
|
|
|
|
|
#endif // __MICROPY_INCLUDED_PY_GC_H__
|