Class: Async::Scheduler

Inherits:
Node
  • Object
show all
Defined in:
lib/async/scheduler.rb

Overview

Handles scheduling of fibers. Implements the fiber scheduler interface.

Direct Known Subclasses

Reactor

Defined Under Namespace

Classes: ClosedError

Instance Attribute Summary

Attributes inherited from Node

#A useful identifier for the current node., #Optional list of children., #annotation, #children, #head, #parent, #tail

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Node

#The parent node.=, #annotate, #backtrace, #children?, #consume, #description, #finished?, #print_hierarchy, #root, #stopped?, #transient=, #transient?, #traverse

Constructor Details

#initialize(parent = nil, selector: nil) ⇒ Scheduler

Create a new scheduler.



40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/async/scheduler.rb', line 40

def initialize(parent = nil, selector: nil)
	super(parent)
	
	@selector = selector || ::IO::Event::Selector.new(Fiber.current)
	@interrupted = false
	
	@blocked = 0
	
	@busy_time = 0.0
	@idle_time = 0.0
	
	@timers = ::IO::Event::Timers.new
end

Class Method Details

.supported? ⇒ Boolean

Whether the fiber scheduler is supported.

Returns:

  • (Boolean) 


31
32
33
 
# File 'lib/async/scheduler.rb', line 31

def self.supported?
	true
end

Instance Method Details

#address_resolve(hostname) ⇒ Object

Resolve the address of the given hostname.



233
234
235
236
237
238
 
# File 'lib/async/scheduler.rb', line 233

def address_resolve(hostname)
	# On some platforms, hostnames may contain a device-specific suffix (e.g. %en0). We need to strip this before resolving.
	# See <https://github.com/socketry/async/issues/180> for more details.
	hostname = hostname.split("%", 2).first
	::Resolv.getaddresses(hostname)
end

#async(*arguments, **options, &block) ⇒ Object

Deprecated.

Use #run or Task#async instead.

Start an asynchronous task within the specified reactor. The task will be executed until the first blocking call, at which point it will yield and and this method will return.



490
491
492
493
494
495
496
497
498
499
500
 
# File 'lib/async/scheduler.rb', line 490

def async(*arguments, **options, &block)
	# warn "Async::Scheduler#async is deprecated. Use `run` or `Task#async` instead.", uplevel: 1, category: :deprecated
	
	Kernel.raise ClosedError if @selector.nil?
	
	task = Task.new(Task.current? || self, **options, &block)
	
	task.run(*arguments)
	
	return task
end

#block(blocker, timeout) ⇒ Object 



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/async/scheduler.rb', line 174

def block(blocker, timeout)
	# $stderr.puts "block(#{blocker}, #{Fiber.current}, #{timeout})"
	fiber = Fiber.current
	
	if timeout
		timer = @timers.after(timeout) do
			if fiber.alive?
				fiber.transfer(false)
			end
		end
	end
	
	begin
		@blocked += 1
		@selector.transfer
	ensure
		@blocked -= 1
	end
ensure
	timer&.cancel!
end

#close ⇒ Object

Terminate all child tasks and close the scheduler.



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/async/scheduler.rb', line 100

def close
	self.run_loop do
		until self.terminate
			self.run_once!
		end
	end
	
	Kernel.raise "Closing scheduler with blocked operations!" if @blocked > 0
ensure
	# We want `@selector = nil` to be a visible side effect from this point forward, specifically in `#interrupt` and `#unblock`. If the selector is closed, then we don't want to push any fibers to it.
	selector = @selector
	@selector = nil
	
	selector&.close
	
	consume
end

#closed? ⇒ Boolean

Returns:

  • (Boolean) 


120
121
122
 
# File 'lib/async/scheduler.rb', line 120

def closed?
	@selector.nil?
end

#fiber ⇒ Object 



502
503
504
 
# File 'lib/async/scheduler.rb', line 502

def fiber(...)
	return async(...).fiber
end

#interrupt ⇒ Object

Interrupt the event loop and cause it to exit.



131
132
133
134
 
# File 'lib/async/scheduler.rb', line 131

def interrupt
	@interrupted = true
	@selector&.wakeup
end

#io_read(io, buffer, length, offset = 0) ⇒ Object

Read from the specified IO into the buffer.



288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/async/scheduler.rb', line 288

def io_read(io, buffer, length, offset = 0)
	fiber = Fiber.current
	
	if timeout = get_timeout(io)
		timer = @timers.after(timeout) do
			fiber.raise(::IO::TimeoutError, "Timeout (#{timeout}s) while waiting for IO to become readable!")
		end
	end
	
	@selector.io_read(fiber, io, buffer, length, offset)
ensure
	timer&.cancel!
end

#io_wait(io, events, timeout = nil) ⇒ Object

Wait for the specified IO to become ready for the specified events.



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/async/scheduler.rb', line 258

def io_wait(io, events, timeout = nil)
	fiber = Fiber.current
	
	if timeout
		# If an explicit timeout is specified, we expect that the user will handle it themselves:
		timer = @timers.after(timeout) do
			fiber.transfer
		end
	elsif timeout = get_timeout(io)
		# Otherwise, if we default to the io's timeout, we raise an exception:
		timer = @timers.after(timeout) do
			fiber.raise(::IO::TimeoutError, "Timeout (#{timeout}s) while waiting for IO to become ready!")
		end
	end
	
	return @selector.io_wait(fiber, io, events)
ensure
	timer&.cancel!
end

#io_write(io, buffer, length, offset = 0) ⇒ Object

Write the specified buffer to the IO.



312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/async/scheduler.rb', line 312

def io_write(io, buffer, length, offset = 0)
	fiber = Fiber.current
	
	if timeout = get_timeout(io)
		timer = @timers.after(timeout) do
			fiber.raise(::IO::TimeoutError, "Timeout (#{timeout}s) while waiting for IO to become writable!")
		end
	end
	
	@selector.io_write(fiber, io, buffer, length, offset)
ensure
	timer&.cancel!
end

#kernel_sleep(duration = nil) ⇒ Object

Sleep for the specified duration.



219
220
221
222
223
224
225
 
# File 'lib/async/scheduler.rb', line 219

def kernel_sleep(duration = nil)
	if duration
		self.block(nil, duration)
	else
		self.transfer
	end
end

#load ⇒ Object

Compute the scheduler load according to the busy and idle times that are updated by the run loop.



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/async/scheduler.rb', line 57

def load
	total_time = @busy_time + @idle_time
	
	# If the total time is zero, then the load is zero:
	return 0.0 if total_time.zero?
	
	# We normalize to a 1 second window:
	if total_time > 1.0
		ratio = 1.0 / total_time
		@busy_time *= ratio
		@idle_time *= ratio
		
		# We don't need to divide here as we've already normalised it to a 1s window:
		return @busy_time
	else
		return @busy_time / total_time
	end
end

#process_wait(pid, flags) ⇒ Object

Wait for the specified process ID to exit.



337
338
339
 
# File 'lib/async/scheduler.rb', line 337

def process_wait(pid, flags)
	return @selector.process_wait(Fiber.current, pid, flags)
end

#push(fiber) ⇒ Object

Schedule a fiber (or equivalent object) to be resumed on the next loop through the reactor.



148
149
150
 
# File 'lib/async/scheduler.rb', line 148

def push(fiber)
	@selector.push(fiber)
end

#raise ⇒ Object

Raise an exception on a specified fiber with the given arguments.

This internally schedules the current fiber to be ready, before raising the exception, so that it will later resume execution.



158
159
160
 
# File 'lib/async/scheduler.rb', line 158

def raise(...)
	@selector.raise(...)
end

#resume(fiber, *arguments) ⇒ Object

Resume execution of the specified fiber.



166
167
168
 
# File 'lib/async/scheduler.rb', line 166

def resume(fiber, *arguments)
	@selector.resume(fiber, *arguments)
end

#run ⇒ Object

Run the reactor until all tasks are finished. Proxies arguments to #async immediately before entering the loop, if a block is provided.

Forwards all parameters to #async if a block is given.



470
471
472
473
474
475
476
477
478
479
480
 
# File 'lib/async/scheduler.rb', line 470

def run(...)
	Kernel.raise ClosedError if @selector.nil?
	
	initial_task = self.async(...) if block_given?
	
	self.run_loop do
		run_once
	end
	
	return initial_task
end

#run_once(timeout = nil) ⇒ Object

Run one iteration of the event loop.



391
392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'lib/async/scheduler.rb', line 391

def run_once(timeout = nil)
	Kernel.raise "Running scheduler on non-blocking fiber!" unless Fiber.blocking?
	
	if self.finished?
		self.stop
	end
	
	# If we are finished, we stop the task tree and exit:
	if @children.nil?
		return false
	end
	
	return run_once!(timeout)
end

#scheduler_close(error = $!) ⇒ Object

Invoked when the fiber scheduler is being closed.

Executes the run loop until all tasks are finished, then closes the scheduler.



79
80
81
82
83
84
85
86
 
# File 'lib/async/scheduler.rb', line 79

def scheduler_close(error = $!)
	# If the execution context (thread) was handling an exception, we want to exit as quickly as possible:
	unless error
		self.run
	end
ensure
	self.close
end

#stop ⇒ Object

Stop all children, including transient children.



425
426
427
428
429
 
# File 'lib/async/scheduler.rb', line 425

def stop
	@children&.each do |child|
		child.stop
	end
end

#terminate ⇒ Object

Terminate all child tasks.



89
90
91
92
93
94
95
96
 
# File 'lib/async/scheduler.rb', line 89

def terminate
	# If that doesn't work, take more serious action:
	@children&.each do |child|
		child.terminate
	end
	
	return @children.nil?
end

#timeout_after(duration, exception, message, &block) ⇒ Object

Invoke the block, but after the specified timeout, raise the specified exception with the given message. If the block runs to completion before the timeout occurs or there are no non-blocking operations after the timeout expires, the code will complete without any exception.



538
539
540
541
542
 
# File 'lib/async/scheduler.rb', line 538

def timeout_after(duration, exception, message, &block)
	with_timeout(duration, exception, message) do |timer|
		yield duration
	end
end

#to_s ⇒ Object 



125
126
127
 
# File 'lib/async/scheduler.rb', line 125

def to_s
	"\#<#{self.description} #{@children&.size || 0} children (#{stopped? ? 'stopped' : 'running'})>"
end

#transfer ⇒ Object

Transfer from the calling fiber to the event loop.



137
138
139
 
# File 'lib/async/scheduler.rb', line 137

def transfer
	@selector.transfer
end

#unblock(blocker, fiber) ⇒ Object

Unblock a fiber that was previously blocked.



203
204
205
206
207
208
209
210
211
 
# File 'lib/async/scheduler.rb', line 203

def unblock(blocker, fiber)
	# $stderr.puts "unblock(#{blocker}, #{fiber})"
	
	# This operation is protected by the GVL:
	if selector = @selector
		selector.push(fiber)
		selector.wakeup
	end
end

#with_timeout(duration, exception = TimeoutError, message = "execution expired", &block) ⇒ Object

Invoke the block, but after the specified timeout, raise TimeoutError in any currenly blocking operation. If the block runs to completion before the timeout occurs or there are no non-blocking operations after the timeout expires, the code will complete without any exception.



515
516
517
518
519
520
521
522
523
524
525
526
527
 
# File 'lib/async/scheduler.rb', line 515

def with_timeout(duration, exception = TimeoutError, message = "execution expired", &block)
	fiber = Fiber.current
	
	timer = @timers.after(duration) do
		if fiber.alive?
			fiber.raise(exception, message)
		end
	end
	
	yield timer
ensure
	timer&.cancel!
end

#yield ⇒ Object

Yield the current fiber and resume it on the next iteration of the event loop.



142
143
144
 
# File 'lib/async/scheduler.rb', line 142

def yield
	@selector.yield
end