py/gc: Make gc_dump_info/gc_dump_alloc_table take a printer as argument.

dpgeorge · dpgeorge · commit b3c8ab37ec86 · 2023-03-10T10:58:10.000+11:00
So that callers can redirect the output if needed.

Signed-off-by: Damien George &lt;damien@micropython.org&gt;
diff --git a/ports/minimal/main.c b/ports/minimal/main.c
@@ -69,7 +69,7 @@ void gc_collect(void) {
     gc_collect_start();
     gc_collect_root(&dummy, ((mp_uint_t)stack_top - (mp_uint_t)&dummy) / sizeof(mp_uint_t));
     gc_collect_end();
-    gc_dump_info();
+    gc_dump_info(&mp_plat_print);
 }
 #endif
 
diff --git a/ports/nrf/modules/machine/modmachine.c b/ports/nrf/modules/machine/modmachine.c
@@ -133,7 +133,7 @@ STATIC mp_obj_t machine_info(mp_uint_t n_args, const mp_obj_t *args) {
 
     if (n_args == 1) {
         // arg given means dump gc allocation table
-        gc_dump_alloc_table();
+        gc_dump_alloc_table(&mp_plat_print);
     }
 
     return mp_const_none;
diff --git a/ports/powerpc/main.c b/ports/powerpc/main.c
@@ -108,7 +108,7 @@ void gc_collect(void) {
     gc_collect_start();
     gc_collect_root(&dummy, ((mp_uint_t)stack_top - (mp_uint_t)&dummy) / sizeof(mp_uint_t));
     gc_collect_end();
-    gc_dump_info();
+    gc_dump_info(&mp_plat_print);
 }
 
 mp_lexer_t *mp_lexer_new_from_file(const char *filename) {
diff --git a/ports/renesas-ra/modmachine.c b/ports/renesas-ra/modmachine.c
@@ -154,7 +154,7 @@ STATIC mp_obj_t machine_info(size_t n_args, const mp_obj_t *args) {
 
     if (n_args == 1) {
         // arg given means dump gc allocation table
-        gc_dump_alloc_table();
+        gc_dump_alloc_table(&mp_plat_print);
     }
 
     return mp_const_none;
diff --git a/ports/stm32/modmachine.c b/ports/stm32/modmachine.c
@@ -244,7 +244,7 @@ STATIC mp_obj_t machine_info(size_t n_args, const mp_obj_t *args) {
 
     if (n_args == 1) {
         // arg given means dump gc allocation table
-        gc_dump_alloc_table();
+        gc_dump_alloc_table(print);
     }
 
     return mp_const_none;
diff --git a/ports/teensy/modpyb.c b/ports/teensy/modpyb.c
@@ -111,7 +111,7 @@ STATIC mp_obj_t pyb_info(uint n_args, const mp_obj_t *args) {
 
     if (n_args == 1) {
         // arg given means dump gc allocation table
-        gc_dump_alloc_table();
+        gc_dump_alloc_table(&mp_plat_print);
     }
 
     return mp_const_none;
diff --git a/ports/unix/gccollect.c b/ports/unix/gccollect.c
@@ -34,8 +34,6 @@
 #if MICROPY_ENABLE_GC
 
 void gc_collect(void) {
-    // gc_dump_info();
-
     gc_collect_start();
     gc_helper_collect_regs_and_stack();
     #if MICROPY_PY_THREAD
@@ -45,9 +43,6 @@ void gc_collect(void) {
     mp_unix_mark_exec();
     #endif
     gc_collect_end();
-
-    // printf("-----\n");
-    // gc_dump_info();
 }
 
 #endif // MICROPY_ENABLE_GC
diff --git a/ports/zephyr/main.c b/ports/zephyr/main.c
@@ -186,7 +186,6 @@ void gc_collect(void) {
     gc_collect_start();
     gc_collect_root(&dummy, ((mp_uint_t)MP_STATE_THREAD(stack_top) - (mp_uint_t)&dummy) / sizeof(mp_uint_t));
     gc_collect_end();
-    // gc_dump_info();
 }
 
 #if !MICROPY_READER_VFS
diff --git a/py/gc.c b/py/gc.c
@@ -726,7 +726,7 @@ void *gc_alloc(size_t n_bytes, unsigned int alloc_flags) {
     #endif
 
     #if EXTENSIVE_HEAP_PROFILING
-    gc_dump_alloc_table();
+    gc_dump_alloc_table(&mp_plat_print);
     #endif
 
     return ret_ptr;
@@ -806,7 +806,7 @@ void gc_free(void *ptr) {
     GC_EXIT();
 
     #if EXTENSIVE_HEAP_PROFILING
-    gc_dump_alloc_table();
+    gc_dump_alloc_table(&mp_plat_print);
     #endif
 }
 
@@ -960,7 +960,7 @@ void *gc_realloc(void *ptr_in, size_t n_bytes, bool allow_move) {
         GC_EXIT();
 
         #if EXTENSIVE_HEAP_PROFILING
-        gc_dump_alloc_table();
+        gc_dump_alloc_table(&mp_plat_print);
         #endif
 
         return ptr_in;
@@ -985,7 +985,7 @@ void *gc_realloc(void *ptr_in, size_t n_bytes, bool allow_move) {
         #endif
 
         #if EXTENSIVE_HEAP_PROFILING
-        gc_dump_alloc_table();
+        gc_dump_alloc_table(&mp_plat_print);
         #endif
 
         return ptr_in;
@@ -1019,23 +1019,23 @@ void *gc_realloc(void *ptr_in, size_t n_bytes, bool allow_move) {
 }
 #endif // Alternative gc_realloc impl
 
-void gc_dump_info(void) {
+void gc_dump_info(const mp_print_t *print) {
     gc_info_t info;
     gc_info(&info);
-    mp_printf(&mp_plat_print, "GC: total: %u, used: %u, free: %u\n",
+    mp_printf(print, "GC: total: %u, used: %u, free: %u\n",
         (uint)info.total, (uint)info.used, (uint)info.free);
-    mp_printf(&mp_plat_print, " No. of 1-blocks: %u, 2-blocks: %u, max blk sz: %u, max free sz: %u\n",
+    mp_printf(print, " No. of 1-blocks: %u, 2-blocks: %u, max blk sz: %u, max free sz: %u\n",
         (uint)info.num_1block, (uint)info.num_2block, (uint)info.max_block, (uint)info.max_free);
 }
 
-void gc_dump_alloc_table(void) {
+void gc_dump_alloc_table(const mp_print_t *print) {
     GC_ENTER();
     static const size_t DUMP_BYTES_PER_LINE = 64;
     for (mp_state_mem_area_t *area = &MP_STATE_MEM(area); area != NULL; area = NEXT_AREA(area)) {
         #if !EXTENSIVE_HEAP_PROFILING
         // When comparing heap output we don't want to print the starting
         // pointer of the heap because it changes from run to run.
-        mp_printf(&mp_plat_print, "GC memory layout; from %p:", area->gc_pool_start);
+        mp_printf(print, "GC memory layout; from %p:", area->gc_pool_start);
         #endif
         for (size_t bl = 0; bl < area->gc_alloc_table_byte_len * BLOCKS_PER_ATB; bl++) {
             if (bl % DUMP_BYTES_PER_LINE == 0) {
@@ -1048,7 +1048,7 @@ void gc_dump_alloc_table(void) {
                     }
                     if (bl2 - bl >= 2 * DUMP_BYTES_PER_LINE) {
                         // there are at least 2 lines containing only free blocks, so abbreviate their printing
-                        mp_printf(&mp_plat_print, "\n       (%u lines all free)", (uint)(bl2 - bl) / DUMP_BYTES_PER_LINE);
+                        mp_printf(print, "\n       (%u lines all free)", (uint)(bl2 - bl) / DUMP_BYTES_PER_LINE);
                         bl = bl2 & (~(DUMP_BYTES_PER_LINE - 1));
                         if (bl >= area->gc_alloc_table_byte_len * BLOCKS_PER_ATB) {
                             // got to end of heap
@@ -1058,7 +1058,7 @@ void gc_dump_alloc_table(void) {
                 }
                 // print header for new line of blocks
                 // (the cast to uint32_t is for 16-bit ports)
-                mp_printf(&mp_plat_print, "\n%08x: ", (uint)(bl * BYTES_PER_BLOCK));
+                mp_printf(print, "\n%08x: ", (uint)(bl * BYTES_PER_BLOCK));
             }
             int c = ' ';
             switch (ATB_GET_KIND(area, bl)) {
@@ -1151,9 +1151,9 @@ void gc_dump_alloc_table(void) {
                     c = 'm';
                     break;
             }
-            mp_printf(&mp_plat_print, "%c", c);
+            mp_printf(print, "%c", c);
         }
-        mp_print_str(&mp_plat_print, "\n");
+        mp_print_str(print, "\n");
     }
     GC_EXIT();
 }
@@ -1185,13 +1185,13 @@ void gc_test(void) {
     }
 
     printf("Before GC:\n");
-    gc_dump_alloc_table();
+    gc_dump_alloc_table(&mp_plat_print);
     printf("Starting GC...\n");
     gc_collect_start();
     gc_collect_root(ptrs, sizeof(ptrs) / sizeof(void *));
     gc_collect_end();
     printf("After GC:\n");
-    gc_dump_alloc_table();
+    gc_dump_alloc_table(&mp_plat_print);
 }
 #endif
 
diff --git a/py/gc.h b/py/gc.h
@@ -28,7 +28,7 @@
 
 #include <stdbool.h>
 #include <stddef.h>
-#include "py/mpconfig.h"
+#include "py/mpprint.h"
 
 void gc_init(void *start, void *end);
 
@@ -72,7 +72,7 @@ typedef struct _gc_info_t {
 } gc_info_t;
 
 void gc_info(gc_info_t *info);
-void gc_dump_info(void);
-void gc_dump_alloc_table(void);
+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
diff --git a/py/modmicropython.c b/py/modmicropython.c
@@ -81,10 +81,10 @@ mp_obj_t mp_micropython_mem_info(size_t n_args, const mp_obj_t *args) {
     mp_printf(&mp_plat_print, "stack: " UINT_FMT "\n", mp_stack_usage());
     #endif
     #if MICROPY_ENABLE_GC
-    gc_dump_info();
+    gc_dump_info(&mp_plat_print);
     if (n_args == 1) {
         // arg given means dump gc allocation table
-        gc_dump_alloc_table();
+        gc_dump_alloc_table(&mp_plat_print);
     }
     #else
     (void)n_args;
diff --git a/shared/runtime/pyexec.c b/shared/runtime/pyexec.c
@@ -167,7 +167,7 @@ STATIC int parse_compile_execute(const void *source, mp_parse_input_kind_t input
         #if MICROPY_ENABLE_GC
         // run collection and print GC info
         gc_collect();
-        gc_dump_info();
+        gc_dump_info(&mp_plat_print);
         #endif
     }
     #endif

Original file line number	Diff line number	Diff line change
`@@ -69,7 +69,7 @@ void gc_collect(void) {`
`69`	`69`	`gc_collect_start();`
`70`	`70`	`gc_collect_root(&dummy, ((mp_uint_t)stack_top - (mp_uint_t)&dummy) / sizeof(mp_uint_t));`
`71`	`71`	`gc_collect_end();`
`72`		`- gc_dump_info();`
	`72`	`+ gc_dump_info(&mp_plat_print);`
`73`	`73`	`}`
`74`	`74`	`#endif`
`75`	`75`
Original file line number	Diff line number	Diff line change
`@@ -133,7 +133,7 @@ STATIC mp_obj_t machine_info(mp_uint_t n_args, const mp_obj_t *args) {`
`133`	`133`
`134`	`134`	`if (n_args == 1) {`
`135`	`135`	`// arg given means dump gc allocation table`
`136`		`- gc_dump_alloc_table();`
	`136`	`+ gc_dump_alloc_table(&mp_plat_print);`
`137`	`137`	`}`
`138`	`138`
`139`	`139`	`return mp_const_none;`
Original file line number	Diff line number	Diff line change
`@@ -108,7 +108,7 @@ void gc_collect(void) {`
`108`	`108`	`gc_collect_start();`
`109`	`109`	`gc_collect_root(&dummy, ((mp_uint_t)stack_top - (mp_uint_t)&dummy) / sizeof(mp_uint_t));`
`110`	`110`	`gc_collect_end();`
`111`		`- gc_dump_info();`
	`111`	`+ gc_dump_info(&mp_plat_print);`
`112`	`112`	`}`
`113`	`113`
`114`	`114`	`mp_lexer_t mp_lexer_new_from_file(const char filename) {`
Original file line number	Diff line number	Diff line change
`@@ -154,7 +154,7 @@ STATIC mp_obj_t machine_info(size_t n_args, const mp_obj_t *args) {`
`154`	`154`
`155`	`155`	`if (n_args == 1) {`
`156`	`156`	`// arg given means dump gc allocation table`
`157`		`- gc_dump_alloc_table();`
	`157`	`+ gc_dump_alloc_table(&mp_plat_print);`
`158`	`158`	`}`
`159`	`159`
`160`	`160`	`return mp_const_none;`
Original file line number	Diff line number	Diff line change
`@@ -244,7 +244,7 @@ STATIC mp_obj_t machine_info(size_t n_args, const mp_obj_t *args) {`
`244`	`244`
`245`	`245`	`if (n_args == 1) {`
`246`	`246`	`// arg given means dump gc allocation table`
`247`		`- gc_dump_alloc_table();`
	`247`	`+ gc_dump_alloc_table(print);`
`248`	`248`	`}`
`249`	`249`
`250`	`250`	`return mp_const_none;`
Original file line number	Diff line number	Diff line change
`@@ -111,7 +111,7 @@ STATIC mp_obj_t pyb_info(uint n_args, const mp_obj_t *args) {`
`111`	`111`
`112`	`112`	`if (n_args == 1) {`
`113`	`113`	`// arg given means dump gc allocation table`
`114`		`- gc_dump_alloc_table();`
	`114`	`+ gc_dump_alloc_table(&mp_plat_print);`
`115`	`115`	`}`
`116`	`116`
`117`	`117`	`return mp_const_none;`
Original file line number	Diff line number	Diff line change
`@@ -186,7 +186,6 @@ void gc_collect(void) {`
`186`	`186`	`gc_collect_start();`
`187`	`187`	`gc_collect_root(&dummy, ((mp_uint_t)MP_STATE_THREAD(stack_top) - (mp_uint_t)&dummy) / sizeof(mp_uint_t));`
`188`	`188`	`gc_collect_end();`
`189`		`- // gc_dump_info();`
`190`	`189`	`}`
`191`	`190`
`192`	`191`	`#if !MICROPY_READER_VFS`
Original file line number	Diff line number	Diff line change
`@@ -167,7 +167,7 @@ STATIC int parse_compile_execute(const void *source, mp_parse_input_kind_t input`
`167`	`167`	`#if MICROPY_ENABLE_GC`
`168`	`168`	`// run collection and print GC info`
`169`	`169`	`gc_collect();`
`170`		`- gc_dump_info();`
	`170`	`+ gc_dump_info(&mp_plat_print);`
`171`	`171`	`#endif`
`172`	`172`	`}`
`173`	`173`	`#endif`