Skip to content

Fix save overlap dangling reference #15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ScepticalRabbit merged 2 commits into from
Jul 21, 2026
Merged

Fix save overlap dangling reference #15

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bfb8062
Add failing test for save-overlap option
james-panayis Jul 20, 2026
b49c96e
Fix disk-save overlap coordinator lifetime issue
james-panayis Jul 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 43 additions & 23 deletions src/riley/zig/saveoverlap.zig
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ pub const SaveOverlap = struct {
enabled_flag: bool,
arena: std.heap.ArenaAllocator,
slot_buff: ?SaveSlotBuff = null,
coordinator: ?SaveCoordinator = null,
coordinator: ?*SaveCoordinator = null,
thread: ?std.Thread = null,

pub fn initMaybe(
Expand All @@ -122,44 +122,49 @@ pub const SaveOverlap = struct {
};

if (!is_enabled) return session;
errdefer session.arena.deinit();

session.slot_buff = try initSaveSlots(
session.arena.allocator(),
cameras,
num_fields,
@max(@as(usize, 1), config.save_frame_buff_count),
);
session.coordinator = .{ .slots = session.slot_buff.?.slots };

const coordinator = try outer_alloc.create(SaveCoordinator);
errdefer outer_alloc.destroy(coordinator);
coordinator.* = .{ .slots = session.slot_buff.?.slots };
session.coordinator = coordinator;
session.thread = try std.Thread.spawn(
.{},
saveWorkerLoop,
.{
outer_alloc,
save_io,
&session.coordinator.?,
coordinator,
config,
},
);
return session;
}

pub fn deinit(self: *SaveOverlap) void {
if (self.enabled_flag) {
if (self.coordinator) |*coordinator| {
coordinator.mutex.lockUncancelable(self.save_io);
coordinator.done_submitting = true;
coordinator.ready_cond.broadcast(self.save_io);
coordinator.free_cond.broadcast(self.save_io);
coordinator.mutex.unlock(self.save_io);
}
if (self.coordinator) |coordinator| {
coordinator.mutex.lockUncancelable(self.save_io);
coordinator.done_submitting = true;
coordinator.ready_cond.broadcast(self.save_io);
coordinator.free_cond.broadcast(self.save_io);
coordinator.mutex.unlock(self.save_io);

if (self.thread) |thread| {
thread.join();
self.thread = null;
}
if (self.coordinator) |*coordinator| {
for (coordinator.slots) |*slot| {
slot.resetReportStorage(self.outer_alloc, self.config);
}
for (coordinator.slots) |*slot| {
slot.resetReportStorage(self.outer_alloc, self.config);
}
self.outer_alloc.destroy(coordinator);
self.coordinator = null;
}
self.arena.deinit();
}
Expand All @@ -172,9 +177,9 @@ pub const SaveOverlap = struct {
self: *SaveOverlap,
io: std.Io,
) !*SaveSlot {
std.debug.assert(self.coordinator != null);
const slot_idx = try acquireSaveSlot(io, &self.coordinator.?);
return &self.coordinator.?.slots[slot_idx];
const coordinator = self.coordinator orelse unreachable;
const slot_idx = try acquireSaveSlot(io, coordinator);
return &coordinator.slots[slot_idx];
}

pub fn publishSlot(
Expand All @@ -185,22 +190,36 @@ pub const SaveOverlap = struct {
report_storage: *FrameReportStorage,
prep_meshes: []const mo.MeshPrepared,
) !void {
std.debug.assert(self.coordinator != null);
const coordinator = self.coordinator orelse unreachable;
try publishRenderedSlot(
io,
&self.coordinator.?,
coordinator,
slot,
meta,
report_storage,
prep_meshes,
);
}

fn releaseSlot(
self: *SaveOverlap,
io: std.Io,
slot: *SaveSlot,
) void {
const coordinator = self.coordinator orelse unreachable;
coordinator.mutex.lockUncancelable(io);
defer coordinator.mutex.unlock(io);
slot.resetReportStorage(self.outer_alloc, self.config);
slot.state = .free;
coordinator.free_cond.signal(io);
}

pub fn checkError(self: *SaveOverlap) !void {
if (!self.enabled_flag) return;
if (self.coordinator) |*coordinator| {
if (coordinator.first_err) |err| return err;
}
const coordinator = self.coordinator orelse unreachable;
coordinator.mutex.lockUncancelable(self.save_io);
defer coordinator.mutex.unlock(self.save_io);
if (coordinator.first_err) |err| return err;
}

pub fn runRasterStageAndQueue(
Expand All @@ -212,6 +231,7 @@ pub const SaveOverlap = struct {
comptime raster_stage_fn: anytype,
) !void {
const slot = try self.acquireSlot(io);
errdefer self.releaseSlot(io, slot);
job.desc.save_slot = slot;
try raster_stage_fn(
outer_alloc,
Expand Down
Loading