celluloid-essentials 0.20.0.pre12

data/lib/celluloid/internals/stack/summary.rb

@@ -0,0 +1,14 @@
+module Celluloid
+  module Internals
+    class Stack
+      class Summary < Stack
+
+        def initialize(threads)
+          super(threads)
+          snapshot
+        end
+
+      end
+    end
+  end
+end

data/lib/celluloid/internals/task_set.rb

@@ -0,0 +1,51 @@
+require 'set'
+require 'forwardable'
+
+module Celluloid
+  module Internals
+    if RUBY_PLATFORM == 'java'
+      require 'jruby/synchronized'
+
+      class TaskSet
+        extend  Forwardable
+        include JRuby::Synchronized
+
+        def_delegators :@tasks, :<<, :delete, :first, :empty?, :to_a
+
+        def initialize
+          @tasks = Set.new
+        end
+      end
+    elsif RUBY_ENGINE == 'rbx'
+      class TaskSet
+        def initialize
+          @tasks = Set.new
+        end
+
+        def <<(task)
+          Rubinius.synchronize(self) { @tasks << task }
+        end
+
+        def delete(task)
+          Rubinius.synchronize(self) { @tasks.delete task }
+        end
+
+        def first
+          Rubinius.synchronize(self) { @tasks.first }
+        end
+
+        def empty?
+          Rubinius.synchronize(self) { @tasks.empty? }
+        end
+
+        def to_a
+          Rubinius.synchronize(self) { @tasks.to_a }
+        end
+      end
+    else
+      # Assume we're on MRI, where we have the GIL. But what about IronRuby?
+      # Or MacRuby. Do people care? This will break Celluloid::Internals::StackDumps
+      TaskSet = Set
+    end
+  end
+end

data/lib/celluloid/internals/thread_handle.rb

@@ -0,0 +1,52 @@
+module Celluloid
+  module Internals
+    # An abstraction around threads from the InternalPool which ensures we don't
+    # accidentally do things to threads which have been returned to the pool,
+    # such as, say, killing them
+    class ThreadHandle
+      def initialize(actor_system, role = nil)
+        @mutex = Mutex.new
+        @join  = ConditionVariable.new
+
+        @thread = actor_system.get_thread do
+          Thread.current.role = role
+          begin
+            yield
+          ensure
+            @mutex.synchronize do
+              @thread = nil
+              @join.broadcast
+            end
+          end
+        end
+      end
+
+      # Is the thread running?
+      def alive?
+        @mutex.synchronize { @thread.alive? if @thread }
+      end
+
+      # Forcibly kill the thread
+      def kill
+        !!@mutex.synchronize { @thread.kill if @thread }
+        self
+      end
+
+      # Join to a running thread, blocking until it terminates
+      def join(limit = nil)
+        raise ThreadError, "Target thread must not be current thread" if @thread == Thread.current
+        @mutex.synchronize { @join.wait(@mutex, limit) if @thread }
+        self
+      end
+
+      # Obtain the backtrace for this thread
+      def backtrace
+        @thread.backtrace
+      rescue NoMethodError
+        # undefined method `backtrace' for nil:NilClass
+        # Swallow this in case this ThreadHandle was terminated and @thread was
+        # set to nil
+      end
+    end
+  end
+end

data/lib/celluloid/internals/uuid.rb

@@ -0,0 +1,40 @@
+require 'securerandom'
+
+module Celluloid
+  module Internals
+    # Clearly Ruby doesn't have enough UUID libraries
+    # This one aims to be fast and simple with good support for multiple threads
+    # If there's a better UUID library I can use with similar multithreaded
+    # performance, I certainly wouldn't mind using a gem for this!
+    module UUID
+      values = SecureRandom.hex(9).match(/(.{8})(.{4})(.{3})(.{3})/)
+      PREFIX = "#{values[1]}-#{values[2]}-4#{values[3]}-8#{values[4]}".freeze
+      BLOCK_SIZE = 0x10000
+
+      @counter = 0
+      @counter_mutex = Mutex.new
+
+      def self.generate
+        thread = Thread.current
+
+        unless thread.uuid_limit
+          @counter_mutex.synchronize do
+            block_base = @counter
+            @counter += BLOCK_SIZE
+            thread.uuid_counter = block_base
+            thread.uuid_limit   = @counter - 1
+          end
+        end
+
+        counter = thread.uuid_counter
+        if thread.uuid_counter >= thread.uuid_limit
+          thread.uuid_counter = thread.uuid_limit = nil
+        else
+          thread.uuid_counter += 1
+        end
+
+        "#{PREFIX}-#{sprintf('%012x', counter)}".freeze
+      end
+    end
+  end
+end

data/lib/celluloid/logging/incident.rb

@@ -0,0 +1,21 @@
+module Celluloid
+  # Wraps all events and context for a single incident.
+  class Incident
+    attr_accessor :pid
+    attr_accessor :events, :triggering_event
+
+    def initialize(events, triggering_event=nil)
+      @events = events
+      @triggering_event = triggering_event
+      @pid = $$
+    end
+
+    # Merge two incidents together. This may be useful if two incidents occur at the same time.
+    def merge(*other_incidents)
+      merged_events = other_incidents.flatten.inject(events) do |events, incident|
+        events += incident.events
+      end
+      Incident.new(merged_events.sort, triggering_event)
+    end
+  end
+end

data/lib/celluloid/logging/incident_logger.rb

@@ -0,0 +1,128 @@
+require 'logger'
+module Celluloid
+  # A logger that holds all messages in circular buffers, then flushes the buffers
+  # when an event occurs at a configurable severity threshold.
+  #
+  # Unlike ruby's Logger, this class only supports a single progname.
+  class IncidentLogger
+    module Severity
+      include ::Logger::Severity
+
+      TRACE = -1
+
+      def severity_to_string(severity)
+        case severity
+        when TRACE   then 'TRACE'
+        when DEBUG   then 'DEBUG'
+        when INFO    then 'INFO'
+        when WARN    then 'WARN'
+        when ERROR   then 'ERROR'
+        when FATAL   then 'FATAL'
+        when UNKNOWN then 'UNKNOWN'
+        end
+      end
+    end
+    include Severity
+
+    # The progname (facility) for this instance.
+    attr_accessor :progname
+
+    # The logging level. Messages below this severity will not be logged at all.
+    attr_accessor :level
+
+    # The incident threshold. Messages at or above this severity will generate an
+    # incident and be published to incident reporters.
+    attr_accessor :threshold
+
+    # The buffer size limit. Each log level will retain this number of messages
+    # at maximum.
+    attr_accessor :sizelimit
+
+    attr_accessor :buffers
+
+    # Create a new IncidentLogger.
+    def initialize(progname=nil, options={})
+      @progname = progname || "default"
+      @level = options[:level] || DEBUG
+      @threshold = options[:threshold] || ERROR
+      @sizelimit = options[:sizelimit] || 100
+
+      @buffer_mutex = Mutex.new
+      @buffers = Hash.new do |progname_hash, _progname|
+        @buffer_mutex.synchronize do
+          progname_hash[_progname] = Hash.new do |severity_hash, severity|
+            severity_hash[severity] = RingBuffer.new(@sizelimit)
+          end
+        end
+      end
+
+      # When the IncidentLogger itself encounters an error, it falls back to logging to stderr
+      @fallback_logger = ::Logger.new(STDERR)
+      @fallback_logger.progname = "FALLBACK"
+    end
+
+    # add an event.
+    def add(severity, message=nil, progname=nil, &block)
+      progname ||= @progname
+      severity ||= UNKNOWN
+
+      if severity < @level
+        return event.id
+      end
+
+      if message.nil? && !block_given?
+        message = progname
+        progname = @progname
+      end
+
+      event = LogEvent.new(severity, message, progname, &block)
+
+      @buffers[progname][severity] << event
+
+      if severity >= @threshold
+        begin
+          Celluloid::Notifications.notifier.async.publish(incident_topic, create_incident(event))
+        rescue => ex
+          @fallback_logger.error(ex)
+        end
+      end
+      event.id
+    end
+    alias :log :add
+
+    # See docs for Logger#info
+    def trace   (progname=nil, &block); add(TRACE,   nil, progname, &block); end
+    def debug   (progname=nil, &block); add(DEBUG,   nil, progname, &block); end
+    def info    (progname=nil, &block); add(INFO,    nil, progname, &block); end
+    def warn    (progname=nil, &block); add(WARN,    nil, progname, &block); end
+    def error   (progname=nil, &block); add(ERROR,   nil, progname, &block); end
+    def fatal   (progname=nil, &block); add(FATAL,   nil, progname, &block); end
+    def unknown (progname=nil, &block); add(UNKNOWN, nil, progname, &block); end
+
+    def flush
+      messages = []
+      @buffer_mutex.synchronize do
+        @buffers.each do |progname, severities|
+          severities.each do |severity, buffer|
+            messages += buffer.flush
+          end
+        end
+      end
+      messages.sort
+    end
+
+    def clear
+      @buffer_mutex.synchronize do
+        @buffers.each(&:clear)
+      end
+    end
+
+    def create_incident(event=nil)
+      Incident.new(flush, event)
+    end
+
+    def incident_topic
+      "log.incident.#{@progname}"
+    end
+  end
+end

data/lib/celluloid/logging/incident_reporter.rb

@@ -0,0 +1,48 @@
+require 'logger'
+module Celluloid
+  # Subscribes to log incident topics to report on them.
+  class IncidentReporter
+    include Celluloid
+    include Celluloid::Notifications
+
+    # get the time from the event
+    class Formatter < ::Logger::Formatter
+      def call(severity, time, progname, msg)
+        super(severity, msg.time, progname, msg.message)
+      end
+    end
+
+    def initialize(*args)
+      subscribe(/log\.incident/, :report)
+      @logger = ::Logger.new(*args)
+      @logger.formatter = Formatter.new
+      @silenced = false
+    end
+
+    def report(topic, incident)
+      return if @silenced
+
+      header = "INCIDENT"
+      header << " AT #{incident.triggering_event.time}" if incident.triggering_event
+      @logger << header
+      @logger << "\n"
+      @logger << "====================\n"
+      incident.events.each do |event|
+        @logger.add(event.severity, event, event.progname)
+      end
+      @logger << "====================\n"
+    end
+
+    def silence
+      @silenced = true
+    end
+
+    def unsilence
+      @silenced = false
+    end
+
+    def silenced?
+      @silenced
+    end
+  end
+end

data/lib/celluloid/logging/log_event.rb

@@ -0,0 +1,20 @@
+module Celluloid
+  # Wraps a single log event.
+  class LogEvent
+    attr_accessor :id, :severity, :message, :progname, :time
+
+    def initialize(severity, message, progname, time=Time.now, &block)
+      # This id should be ordered. For now relies on Celluloid::UUID to be ordered.
+      # May want to use a generation/counter strategy for independence of uuid.
+      @id = Internals::UUID.generate
+      @severity = severity
+      @message = block_given? ? yield : message
+      @progname = progname
+      @time = time
+    end
+
+    def <=>(other)
+      @id <=> other.id
+    end
+  end
+end

data/lib/celluloid/logging/ring_buffer.rb

@@ -0,0 +1,65 @@
+module Celluloid
+  class RingBuffer
+    def initialize(size)
+      @size = size
+      @start = 0
+      @count = 0
+      @buffer = Array.new(size)
+      @mutex = Mutex.new
+    end
+
+    def full?
+      @count == @size
+    end
+
+    def empty?
+      @count == 0
+    end
+
+    def push(value)
+      @mutex.synchronize do
+        stop = (@start + @count) % @size
+        @buffer[stop] = value
+        if full?
+          @start = (@start + 1) % @size
+        else
+          @count += 1
+        end
+        value
+      end
+    end
+    alias :<< :push
+
+    def shift
+      @mutex.synchronize do
+        remove_element
+      end
+    end
+
+    def flush
+      values = []
+      @mutex.synchronize do
+        while !empty?
+          values << remove_element
+        end
+      end
+      values
+    end
+
+    def clear
+      @buffer = Array.new(@size)
+      @start = 0
+      @count = 0
+    end
+
+    private
+
+    def remove_element
+      return nil if empty?
+      value, @buffer[@start] = @buffer[@start], nil
+      @start = (@start + 1) % @size
+      @count -= 1
+      value
+    end
+  end
+end