Skip to content
Snippets Groups Projects
Select Git revision
  • main default protected
  • blm_dev_chan
  • release/1.4.0 protected
  • widgets_draw
  • return_of_melodic_demo
  • task_cleanup
  • mixer2
  • dx/fb-save-restore
  • dx/dldldld
  • fpletz/flake
  • dx/jacksense-headset-mic-only
  • release/1.3.0 protected
  • fil3s-limit-filesize
  • allow-reloading-sunmenu
  • wifi-json-error-handling
  • app_text_viewer
  • shoegaze-fps
  • media_has_video_has_audio
  • fil3s-media
  • more-accurate-battery
  • v1.4.0
  • v1.3.0
  • v1.2.0
  • v1.2.0+rc1
  • v1.1.1
  • v1.1.0
  • v1.1.0+rc1
  • v1.0.0
  • v1.0.0+rc6
  • v1.0.0+rc5
  • v1.0.0+rc4
  • v1.0.0+rc3
  • v1.0.0+rc2
  • v1.0.0+rc1
34 results

gc.h

Blame
  • gc.h 2.88 KiB
    /*
     * This file is part of the MicroPython 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.
     */
    #ifndef MICROPY_INCLUDED_PY_GC_H
    #define MICROPY_INCLUDED_PY_GC_H
    
    #include <stdbool.h>
    #include <stddef.h>
    #include "py/mpprint.h"
    
    void gc_init(void *start, void *end);
    
    #if MICROPY_GC_SPLIT_HEAP
    // Used to add additional memory areas to the heap.
    void gc_add(void *start, void *end);
    
    #if MICROPY_GC_SPLIT_HEAP_AUTO
    // Port must implement this function to return the maximum available block of
    // RAM to allocate a new heap area into using MP_PLAT_ALLOC_HEAP.
    size_t gc_get_max_new_split(void);
    #endif // MICROPY_GC_SPLIT_HEAP_AUTO
    #endif // MICROPY_GC_SPLIT_HEAP
    
    // 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);
    bool gc_is_locked(void);
    
    // A given port must implement gc_collect by using the other collect functions.
    void gc_collect(void);
    void gc_collect_start(void);
    void gc_collect_root(void **ptrs, size_t len);
    void gc_collect_end(void);
    
    // Use this function to sweep the whole heap and run all finalisers
    void gc_sweep_all(void);
    
    enum {
        GC_ALLOC_FLAG_HAS_FINALISER = 1,
    };
    
    void *gc_alloc(size_t n_bytes, unsigned int alloc_flags);
    void gc_free(void *ptr); // does not call finaliser
    size_t gc_nbytes(const void *ptr);
    void *gc_realloc(void *ptr, size_t n_bytes, bool allow_move);
    
    typedef struct _gc_info_t {
        size_t total;
        size_t used;
        size_t free;
        size_t max_free;
        size_t num_1block;
        size_t num_2block;
        size_t max_block;
        #if MICROPY_GC_SPLIT_HEAP_AUTO
        size_t max_new_split;
        #endif
    } gc_info_t;
    
    void gc_info(gc_info_t *info);
    void gc_dump_info(const mp_print_t *print);
    void gc_dump_alloc_table(const mp_print_t *print);
    
    #endif // MICROPY_INCLUDED_PY_GC_H