1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547
|
# TODO: eliminate use of global variables
require "English"
require "logger"
require "set"
require "timeout"
# !!! DO NOT INTRODUCE ADDITIONAL GLOBAL VARIABLES !!!
# rubocop:disable Style/GlobalVars
$CELLULOID_DEBUG = false
$CELLULOID_MONITORING = false
# rubocop:enable Style/GlobalVars
require "celluloid/version"
module Celluloid
# Expose all instance methods as singleton methods
extend self
# Linking times out after 5 seconds
LINKING_TIMEOUT = 5
# Warning message added to Celluloid objects accessed outside their actors
BARE_OBJECT_WARNING_MESSAGE = "WARNING: BARE CELLULOID OBJECT ".freeze
class << self
attr_writer :actor_system # Default Actor System
attr_accessor :logger # Thread-safe logger class
attr_accessor :log_actor_crashes
attr_accessor :group_class # Default internal thread group to use
attr_accessor :task_class # Default task type to use
attr_accessor :shutdown_timeout # How long actors have to terminate
def actor_system
if Thread.current.celluloid?
Thread.current[:celluloid_actor_system] || raise(Error, "actor system not running")
else
Thread.current[:celluloid_actor_system] ||
@actor_system ||
raise(Error, "Celluloid is not yet started; use Celluloid.boot")
end
end
def included(klass)
klass.send :extend, ClassMethods
klass.send :include, InstanceMethods
klass.send :extend, Internals::Properties
klass.property :mailbox_class, default: Celluloid::Mailbox
klass.property :proxy_class, default: Celluloid::Proxy::Cell
klass.property :task_class, default: Celluloid.task_class
klass.property :group_class, default: Celluloid.group_class
klass.property :mailbox_size
klass.property :exclusive_actor, default: false
klass.property :exclusive_methods, multi: true
klass.property :execute_block_on_receiver,
default: %i[after every receive],
multi: true
klass.property :finalizer
klass.property :exit_handler_name
singleton = class << klass; self; end
begin
singleton.send(:remove_method, :trap_exit)
rescue
nil
end
begin
singleton.send(:remove_method, :exclusive)
rescue
nil
end
singleton.send(:define_method, :trap_exit) do |*args|
exit_handler_name(*args)
end
singleton.send(:define_method, :exclusive) do |*args|
if args.any?
exclusive_methods(*exclusive_methods, *args)
else
exclusive_actor true
end
end
end
# Are we currently inside of an actor?
def actor?
!!Thread.current[:celluloid_actor]
end
# Retrieve the mailbox for the current thread or lazily initialize it
def mailbox
Thread.current[:celluloid_mailbox] ||= Celluloid::Mailbox.new
end
# Generate a Universally Unique Identifier
def uuid
Internals::UUID.generate
end
# Obtain the number of CPUs in the system
def cores
Internals::CPUCounter.cores
end
alias cpus cores
alias ncpus cores
# Perform a stack dump of all actors to the given output object
def stack_dump(output = STDERR)
actor_system.stack_dump.print(output)
end
alias dump stack_dump
# Perform a stack summary of all actors to the given output object
def stack_summary(output = STDERR)
actor_system.stack_summary.print(output)
end
alias summarize stack_summary
def public_registry
actor_system.public_registry
end
# Detect if a particular call is recursing through multiple actors
def detect_recursion
actor = Thread.current[:celluloid_actor]
return unless actor
task = Thread.current[:celluloid_task]
return unless task
chain_id = Internals::CallChain.current_id
actor.tasks.to_a.any? { |t| t != task && t.chain_id == chain_id }
end
# Define an exception handler for actor crashes
def exception_handler(&block)
Internals::Logger.exception_handler(&block)
end
def suspend(status, waiter)
task = Thread.current[:celluloid_task]
if task && !Celluloid.exclusive?
waiter.before_suspend(task) if waiter.respond_to?(:before_suspend)
Task.suspend(status)
else
waiter.wait
end
end
def boot
init
start
end
def init
@actor_system ||= Actor::System.new
end
def start
actor_system.start
end
def running?
actor_system && actor_system.running?
rescue Error
false
end
# de TODO Anticipate outside process finalizer that would by-pass this.
def register_shutdown
return if defined?(@shutdown_registered) && @shutdown_registered
# Terminate all actors at exit, unless the exit is abnormal.
at_exit do
Celluloid.shutdown unless $ERROR_INFO
end
@shutdown_registered = true
end
# Shut down all running actors
def shutdown
actor_system.shutdown
@actor_system = nil
end
def version
VERSION
end
end
# Class methods added to classes which include Celluloid
module ClassMethods
def new(*args, &block)
proxy = Cell.new(allocate, behavior_options, actor_options).proxy
proxy._send_(:initialize, *args, &block)
proxy
end
alias spawn new
# Create a new actor and link to the current one
def new_link(*args, &block)
raise NotActorError, "can't link outside actor context" unless Celluloid.actor?
proxy = Cell.new(allocate, behavior_options, actor_options).proxy
Actor.link(proxy)
proxy._send_(:initialize, *args, &block)
proxy
end
alias spawn_link new_link
# Run an actor in the foreground
def run(*args, &block)
Actor.join(new(*args, &block))
end
def actor_system
Celluloid.actor_system
end
# Configuration options for Actor#new
def actor_options
{
actor_system: actor_system,
mailbox_class: mailbox_class,
mailbox_size: mailbox_size,
task_class: task_class,
exclusive: exclusive_actor
}
end
def behavior_options
{
proxy_class: proxy_class,
exclusive_methods: exclusive_methods,
exit_handler_name: exit_handler_name,
finalizer: finalizer,
receiver_block_executions: execute_block_on_receiver
}
end
def ===(other)
other.is_a? self
end
end
# These are methods we don't want added to the Celluloid singleton but to be
# defined on all classes that use Celluloid
module InstanceMethods
# Obtain the bare Ruby object the actor is wrapping. This is useful for
# only a limited set of use cases like runtime metaprogramming. Interacting
# directly with the bare object foregoes any kind of thread safety that
# Celluloid would ordinarily provide you, and the object is guaranteed to
# be shared with at least the actor thread. Tread carefully.
#
# Bare objects can be identified via #inspect output:
#
# >> actor
# => #<Celluloid::Actor(Foo:0x3fefcb77c194)>
# >> actor.bare_object
# => #<WARNING: BARE CELLULOID OBJECT (Foo:0x3fefcb77c194)>
#
def bare_object
self
end
alias wrapped_object bare_object
# Are we being invoked in a different thread from our owner?
def leaked?
@celluloid_owner != Thread.current[:celluloid_actor]
end
def tap
yield current_actor
current_actor
end
# Obtain the name of the current actor
def registered_name
Actor.registered_name
end
alias name registered_name
def inspect
return "..." if Celluloid.detect_recursion
str = "#<"
str << if leaked?
Celluloid::BARE_OBJECT_WARNING_MESSAGE
else
"Celluloid::Proxy::Cell"
end
str << "(#{self.class}:0x#{object_id.to_s(16)})"
str << " " unless instance_variables.empty?
instance_variables.each do |ivar|
next if ivar == Celluloid::OWNER_IVAR
str << "#{ivar}=#{instance_variable_get(ivar).inspect} "
end
str.sub!(/\s$/, ">")
end
def __arity
method(:initialize).arity
end
end
#
# The following methods are available on both the Celluloid singleton and
# directly inside of all classes that include Celluloid
#
# Raise an exception in sender context, but stay running
def abort(cause)
cause = case cause
when String then RuntimeError.new(cause)
when Exception then cause
else raise TypeError, "Exception object/String expected, but #{cause.class} received"
end
raise AbortError, cause
end
# Terminate this actor
def terminate
Thread.current[:celluloid_actor].behavior_proxy.terminate!
end
# Send a signal with the given name to all waiting methods
def signal(name, value = nil)
Thread.current[:celluloid_actor].signal name, value
end
# Wait for the given signal
def wait(name)
Thread.current[:celluloid_actor].wait name
end
# Obtain the current_actor
def current_actor
Actor.current
end
# Obtain the UUID of the current call chain
def call_chain_id
Internals::CallChain.current_id
end
# Obtain the running tasks for this actor
def tasks
Thread.current[:celluloid_actor].tasks.to_a
end
# Obtain the Celluloid::Links for this actor
def links
Thread.current[:celluloid_actor].links
end
# Watch for exit events from another actor
def monitor(actor)
Actor.monitor(actor)
end
# Stop waiting for exit events from another actor
def unmonitor(actor)
Actor.unmonitor(actor)
end
# Link this actor to another, allowing it to crash or react to errors
def link(actor)
Actor.link(actor)
end
# Remove links to another actor
def unlink(actor)
Actor.unlink(actor)
end
# Are we monitoring another actor?
def monitoring?(actor)
Actor.monitoring?(actor)
end
# Is this actor linked to another?
def linked_to?(actor)
Actor.linked_to?(actor)
end
# Receive an asynchronous message via the actor protocol
def receive(timeout = nil, &block)
actor = Thread.current[:celluloid_actor]
if actor
actor.receive(timeout, &block)
else
Celluloid.mailbox.receive(timeout, &block)
end
end
# Sleep letting the actor continue processing messages
def sleep(interval)
actor = Thread.current[:celluloid_actor]
if actor
actor.sleep(interval)
else
Kernel.sleep interval
end
end
# Timeout on task suspension (eg Sync calls to other actors)
def timeout(duration)
Thread.current[:celluloid_actor].timeout(duration) do
yield
end
end
# Run given block in an exclusive mode: all synchronous calls block the whole
# actor, not only current message processing.
def exclusive(&block)
Thread.current[:celluloid_task].exclusive(&block)
end
# Are we currently exclusive
def exclusive?
task = Thread.current[:celluloid_task]
task && task.exclusive?
end
# Call a block after a given interval, returning a Celluloid::Timer object
def after(interval, &block)
Thread.current[:celluloid_actor].after(interval, &block)
end
# Call a block every given interval, returning a Celluloid::Timer object
def every(interval, &block)
Thread.current[:celluloid_actor].every(interval, &block)
end
# Perform a blocking or computationally intensive action inside an
# asynchronous group of threads, allowing the sender to continue processing other
# messages in its mailbox in the meantime
def defer(&block)
# This implementation relies on the present implementation of
# Celluloid::Future, which uses a thread from InternalPool to run the block
Future.new(&block).value
end
# Handle async calls within an actor itself
def async(meth = nil, *args, &block)
Thread.current[:celluloid_actor].behavior_proxy.async meth, *args, &block
end
# Handle calls to future within an actor itself
def future(meth = nil, *args, &block)
Thread.current[:celluloid_actor].behavior_proxy.future meth, *args, &block
end
end
require "celluloid/exceptions"
Celluloid.logger = Logger.new(STDERR).tap do |logger|
# !!! DO NOT INTRODUCE ADDITIONAL GLOBAL VARIABLES !!!
# rubocop:disable Style/GlobalVars
logger.level = Logger::INFO unless $CELLULOID_DEBUG
# rubocop:enable Style/GlobalVars
end
Celluloid.shutdown_timeout = 10
Celluloid.log_actor_crashes = true
require "celluloid/calls"
require "celluloid/condition"
require "celluloid/thread"
require "celluloid/core_ext"
require "celluloid/system_events"
require "celluloid/proxies"
require "celluloid/mailbox"
require "celluloid/mailbox/evented"
require "celluloid/group"
require "celluloid/group/spawner"
require "celluloid/group/pool" # TODO: Find way to only load this if being used.
require "celluloid/task"
require "celluloid/task/fibered"
require "celluloid/task/threaded" # TODO: Find way to only load this if being used.
require "celluloid/actor"
require "celluloid/cell"
require "celluloid/future"
require "celluloid/internals/call_chain"
require "celluloid/internals/cpu_counter"
require "celluloid/internals/handlers"
require "celluloid/internals/links"
require "celluloid/internals/logger"
require "celluloid/internals/method"
require "celluloid/internals/properties"
require "celluloid/internals/receivers"
require "celluloid/internals/registry"
require "celluloid/internals/responses"
require "celluloid/internals/signals"
require "celluloid/internals/stack"
require "celluloid/internals/task_set"
require "celluloid/internals/thread_handle"
require "celluloid/internals/uuid"
require "celluloid/notifications"
require "celluloid/supervision"
require "celluloid/logging"
require "celluloid/actor/system"
# Configure default systemwide settings
Celluloid.task_class =
begin
str = ENV["CELLULOID_TASK_CLASS"] || "Fibered"
Kernel.const_get(str)
rescue NameError
begin
Celluloid.const_get(str)
rescue NameError
Celluloid::Task.const_get(str)
end
end
Celluloid.group_class =
begin
str = ENV["CELLULOID_GROUP_CLASS"] || "Spawner"
Kernel.const_get(str)
rescue NameError
begin
Celluloid.const_get(str)
rescue NameError
Celluloid::Group.const_get(str)
end
end
|