Skip to content

Fix memory leak by ensuring rb_call_super is called in Watcher_Detach #91

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
ioquatix merged 5 commits into from
Mar 20, 2026
+53 −12
Merged

Fix memory leak by ensuring rb_call_super is called in Watcher_Detach #91

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
89f8181
Fix memory leak by ensuring rb_call_super is called in Watcher_Detach
Watson1978 Mar 19, 2026
7a45665
Refactor Watcher_Detach to use Ruby-level disable method
Watson1978 Mar 19, 2026
bd27678
Disable fail-fast
Watson1978 Mar 19, 2026
b9d1416
Protect ev_stop with an enabled check in Watcher_Detach macro
Watson1978 Mar 19, 2026
7195b2e
Add test
Watson1978 Mar 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
1 change: 1 addition & 0 deletions .github/workflows/test.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ jobs:
continue-on-error: ${{matrix.experimental}}

strategy:
fail-fast: false
matrix:
os:
- ubuntu
Expand Down
19 changes: 7 additions & 12 deletions ext/cool.io/watcher.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,20 +26,15 @@

#define Watcher_Detach(watcher_type, watcher) \
Copy link
Copy Markdown
Member

@ioquatix ioquatix Mar 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you mind making a follow up PR to to make this an inline function? These macros are getting a bit out of control.

Copy link
Copy Markdown
Collaborator Author

@Watson1978 Watson1978 Mar 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I completely agree about the macros—they made debugging quite challenging this time!

struct Coolio_Watcher *watcher_data; \
struct Coolio_Loop *loop_data; \
\
watcher_data = Coolio_Watcher_ptr(watcher); \
\
if(watcher_data->loop == Qnil) \
rb_raise(rb_eRuntimeError, "not attached to a loop"); \
\
if (watcher_data->enabled == 0) { \
/* Ignore because watcher was already detached. */ \
return Qnil; \
if (watcher_data->enabled) { \
rb_funcall(watcher, rb_intern("disable"), 0); \
} \
loop_data = Coolio_Loop_ptr(watcher_data->loop); \
\
ev_##watcher_type##_stop(loop_data->ev_loop, &watcher_data->event_types.ev_##watcher_type); \
rb_call_super(0, 0)

#define Watcher_Enable(watcher_type, watcher) \
Expand All @@ -66,10 +61,10 @@
if(watcher_data->loop == Qnil) \
rb_raise(rb_eRuntimeError, "not attached to a loop"); \
\
rb_call_super(0, 0); \
\
loop_data = Coolio_Loop_ptr(watcher_data->loop); \
\
ev_##watcher_type##_stop(loop_data->ev_loop, &watcher_data->event_types.ev_##watcher_type)
if (watcher_data->enabled) { \
loop_data = Coolio_Loop_ptr(watcher_data->loop); \
ev_##watcher_type##_stop(loop_data->ev_loop, &watcher_data->event_types.ev_##watcher_type); \
} \
rb_call_super(0, 0);

#endif
45 changes: 45 additions & 0 deletions spec/detach_race_condition_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,4 +47,49 @@ def on_readable
end
}.not_to raise_error
end

class HttpHandler < Coolio::IO
RESPONSE = "HTTP/1.1 200 OK\r\nContent-Length: 1024\r\nConnection: close\r\n\r\n" + ("X" * 1024)

def on_connect
end

def on_read(data)
write(RESPONSE)
end

def on_write_complete
close
end
end

# https://github.com/socketry/cool.io/issues/89
it "does not cause memory leaks" do
port = 18989
loop = Coolio::Loop.default

server = Coolio::TCPServer.new('127.0.0.1', port, HttpHandler)
server.attach(loop)

event_thread = Thread.new { loop.run }

request = "GET / HTTP/1.1\r\nHost: localhost\r\n\r\n"

10.times do |iteration|
begin
sock = TCPSocket.new('127.0.0.1', port)
sock.write(request)
sock.read
sock.close
rescue => e
sleep 0.01
retry
end
end

server.close
event_thread.join

expect(loop.watchers).to be_empty
end
end