Disable SDL debugging options and make them toggleable in debug.zig

This should get rid of lots of memory being used on keeping track of SDL's
internal allocations.

Author: peterix

Makefile

@@ -4,12 +4,12 @@ VERSION ?= "0.0.0"
 PREFIX ?= "./zig-out"
 
 debug_local_platform:
-	zig build --prefix $(PREFIX)
+	zig build -Dcpu=baseline --prefix $(PREFIX)
 
 release:
 	@echo "Building OpenTitus $(VERSION)"
-	zig build --release=small -Dtarget=x86_64-linux-gnu.2.27 -Dversion=$(VERSION) --prefix $(PREFIX)
-	zig build --release=small -Dtarget=x86_64-windows -Dversion=$(VERSION) --prefix $(PREFIX)
+	zig build --release=small -Dtarget=x86_64-linux-gnu.2.27 -Dcpu=baseline -Dversion=$(VERSION) --prefix $(PREFIX)
+	zig build --release=small -Dtarget=x86_64-windows -Dcpu=baseline -Dversion=$(VERSION) --prefix $(PREFIX)
 
 test:
 	@echo "Running tests..."

src/SDL.zig

@@ -82,7 +82,9 @@ const TrackingHashMap = std.AutoHashMap(*Surface, void);
 
 var tracking_map: TrackingHashMap = undefined;
 
-const sdl_gpa_type = std.heap.GeneralPurposeAllocator(.{ .retain_metadata = true, .never_unmap = true, .stack_trace_frames = 10 });
+const debug = @import("_debug.zig");
+
+const sdl_gpa_type = std.heap.GeneralPurposeAllocator(.{ .retain_metadata = true, .never_unmap = false, .stack_trace_frames = 10 });
 var sdl_gpa = sdl_gpa_type{};
 var sdl_allocator: std.mem.Allocator = undefined;
 var sdl_allocations: ?std.AutoHashMap(usize, usize) = null;
@@ -158,20 +160,29 @@ fn sdl_free(maybe_ptr: ?*anyopaque) callconv(.C) void {
 }
 
 pub fn init(allocator: Allocator) bool {
-    sdl_allocator = sdl_gpa.allocator();
-    tracking_map = TrackingHashMap.init(allocator);
-    sdl_allocations = std.AutoHashMap(usize, usize).init(allocator);
-    _ = @This().SDL_SetMemoryFunctions(sdl_malloc, sdl_calloc, sdl_realloc, sdl_free);
+    if(debug.track_sdl_surfaces) {
+        tracking_map = TrackingHashMap.init(allocator);
+    }
+    if(debug.track_sdl_allocations) {
+        sdl_allocator = sdl_gpa.allocator();
+        sdl_allocations = std.AutoHashMap(usize, usize).init(allocator);
+        _ = @This().SDL_SetMemoryFunctions(sdl_malloc, sdl_calloc, sdl_realloc, sdl_free);
+    }
+
     return @This().SDL_Init(@This().SDL_INIT_VIDEO | @This().SDL_INIT_EVENTS | @This().SDL_INIT_JOYSTICK | @This().SDL_INIT_GAMEPAD);
 }
 
 pub fn deinit() void {
-    tracking_map.deinit();
     @This().SDL_Quit();
-    sdl_allocations.?.deinit();
-    sdl_allocations = null;
-    if (sdl_gpa.deinit() == .leak) {
-        std.log.err("SDL memory leaked!", .{});
+    if(debug.track_sdl_surfaces) {
+        tracking_map.deinit();
+    }
+    if(debug.track_sdl_allocations) {
+        sdl_allocations.?.deinit();
+        sdl_allocations = null;
+        if (sdl_gpa.deinit() == .leak) {
+            std.log.err("SDL memory leaked!", .{});
+        }
     }
 }
 
@@ -188,22 +199,31 @@ pub fn getTicks() u64 {
 // Surfaces
 
 pub fn destroySurface(surface: [*c]Surface) void {
-    if (tracking_map.remove(surface)) {
+    if(debug.track_sdl_surfaces) {
+        if (tracking_map.remove(surface)) {
+            @This().SDL_DestroySurface(surface);
+        } else {
+            std.log.err("destroySurface: DOUBLE FREE OF {*}", .{surface});
+        }
+    }
+    else {
         @This().SDL_DestroySurface(surface);
-    } else {
-        std.log.err("destroySurface: DOUBLE FREE OF {*}", .{surface});
     }
 }
 
 pub fn duplicateSurface(surface: [*c]Surface) !*Surface {
+
     const result = @This().SDL_DuplicateSurface(surface);
     if (result == null) {
         return error.Failed;
     }
-    if (tracking_map.remove(result)) {
-        std.log.err("duplicateSurface: surface was already tracked! {*}", .{result});
+    if(debug.track_sdl_surfaces) {
+        if (tracking_map.remove(result)) {
+            std.log.err("duplicateSurface: surface was already tracked! {*}", .{result});
+        }
+        tracking_map.put(result, {}) catch {};
     }
-    tracking_map.put(result, {}) catch {};
+
     return result;
 }
 
@@ -212,19 +232,24 @@ pub fn convertSurface(src: *Surface, pixel_format: PixelFormat) !*Surface {
     if (result == null) {
         return error.Failed;
     }
-    if (tracking_map.remove(result)) {
-        std.log.err("convertSurface: surface was already tracked! {*}", .{result});
+    if(debug.track_sdl_surfaces) {
+        if (tracking_map.remove(result)) {
+            std.log.err("convertSurface: surface was already tracked! {*}", .{result});
+        }
+        tracking_map.put(result, {}) catch {};
     }
-    tracking_map.put(result, {}) catch {};
+
     return result;
 }
 
 pub fn createSurface(width: c_int, height: c_int, format: u32) [*c]Surface {
     const result = @This().SDL_CreateSurface(width, height, format);
-    if (tracking_map.remove(result)) {
-        std.log.err("createSurface: surface was already tracked! {*}", .{result});
+    if(debug.track_sdl_surfaces) {
+        if (tracking_map.remove(result)) {
+            std.log.err("createSurface: surface was already tracked! {*}", .{result});
+        }
+        tracking_map.put(result, {}) catch {};
     }
-    tracking_map.put(result, {}) catch {};
     return result;
 }
 
@@ -234,10 +259,12 @@ pub const createSurfacePalette = @This().SDL_CreateSurfacePalette;
 
 pub fn loadBMP_IO(src: ?*@This().SDL_IOStream, closeio: bool) [*c]@This().Surface {
     const result = @This().SDL_LoadBMP_IO(src, closeio);
-    if (tracking_map.remove(result)) {
-        std.log.err("loadBMP_IO: surface was already tracked! {*}", .{result});
+    if(debug.track_sdl_surfaces) {
+        if (tracking_map.remove(result)) {
+            std.log.err("loadBMP_IO: surface was already tracked! {*}", .{result});
+        }
+        tracking_map.put(result, {}) catch {};
     }
-    tracking_map.put(result, {}) catch {};
     return result;
 }
 pub const saveBMP = @This().SDL_SaveBMP;

src/_debug.zig

@@ -6,3 +6,6 @@ pub const ladder_flag: bool = false;
 pub const controller_osd: bool = false;
 pub const dump_sprites: bool = false;
 pub const enable_cheats: bool = false;
+
+pub const track_sdl_surfaces: bool = false;
+pub const track_sdl_allocations: bool = false;