Merge pull request adafruit#6238 from dhalbert/ringbuf-free-fix

jepler · web-flow · commit e0827eb52a5d · 2022-04-05T08:43:36.000-05:00
Free ringbuf buffer by relying on gc, not gc_free()
diff --git a/py/ringbuf.c b/py/ringbuf.c
@@ -28,7 +28,6 @@
 #include "ringbuf.h"
 
 bool ringbuf_init(ringbuf_t *r, uint8_t *buf, size_t capacity) {
-    r->heap = false;
     r->buf = buf;
     r->size = capacity;
     r->iget = r->iput = 0;
@@ -40,17 +39,15 @@ bool ringbuf_init(ringbuf_t *r, uint8_t *buf, size_t capacity) {
 // size of the buffer is one greater than that, due to how the buffer
 // handles empty and full statuses.
 bool ringbuf_alloc(ringbuf_t *r, size_t capacity, bool long_lived) {
-    r->heap = true;
     r->buf = gc_alloc(capacity + 1, false, long_lived);
     r->size = capacity + 1;
     r->iget = r->iput = 0;
     return r->buf != NULL;
 }
 
 void ringbuf_free(ringbuf_t *r) {
-    if (r->heap) {
-        gc_free(r->buf);
-    }
+    // Free buf by letting gc take care of it. If the VM has finished already,
+    // this will be safe.
     r->buf = (uint8_t *)NULL;
     r->size = 0;
     ringbuf_clear(r);
diff --git a/py/ringbuf.h b/py/ringbuf.h
@@ -37,7 +37,6 @@ typedef struct _ringbuf_t {
     uint32_t size;
     uint32_t iget;
     uint32_t iput;
-    bool heap;
 } ringbuf_t;
 
 // Note that the capacity of the buffer is N-1!
