passenger 5.0.0.beta3 → 5.0.0.rc1

data/lib/phusion_passenger/admin_tools/instance_registry.rb

@@ -26,73 +26,73 @@ require 'fileutils'
 PhusionPassenger.require_passenger_lib 'admin_tools/instance'
 
 module PhusionPassenger
-module AdminTools
+  module AdminTools
 
-class InstanceRegistry
-	def initialize(path = nil)
-		@path = path || default_path
-	end
+    class InstanceRegistry
+      def initialize(path = nil)
+        @path = path || default_path
+      end
 
-	def list(options = {})
-		options = {
-			:clean_stale_or_corrupted => true
-		}.merge(options)
-		instances = []
+      def list(options = {})
+        options = {
+          :clean_stale_or_corrupted => true
+        }.merge(options)
+        instances = []
 
-		Dir["#{@path}/passenger.*"].each do |dir|
-			instance = Instance.new(dir)
-			case instance.state
-			when :good
-				if instance.locked?
-					instances << instance
-				elsif options[:clean_stale_or_corrupted]
-					cleanup(dir)
-				end
-			when :structure_version_unsupported
-				next
-			when :corrupted
-				if !instance.locked? && options[:clean_stale_or_corrupted]
-					cleanup(dir)
-				end
-			when :not_finalized
-				if instance.stale? && options[:clean_stale_or_corrupted]
-					cleanup(dir)
-				end
-			end
-		end
-		return instances
-	end
+        Dir["#{@path}/passenger.*"].each do |dir|
+          instance = Instance.new(dir)
+          case instance.state
+          when :good
+            if instance.locked?
+              instances << instance
+            elsif options[:clean_stale_or_corrupted]
+              cleanup(dir)
+            end
+          when :structure_version_unsupported
+            next
+          when :corrupted
+            if !instance.locked? && options[:clean_stale_or_corrupted]
+              cleanup(dir)
+            end
+          when :not_finalized
+            if instance.stale? && options[:clean_stale_or_corrupted]
+              cleanup(dir)
+            end
+          end
+        end
+        return instances
+      end
 
-	def find_by_name(name, options = {})
-		return list(options).find { |instance| instance.name == name }
-	end
+      def find_by_name(name, options = {})
+        return list(options).find { |instance| instance.name == name }
+      end
 
-	def find_by_name_prefix(name, options = {})
-		prefix = /^#{Regexp.escape name}/
-		results = list(options).find_all { |instance| instance.name =~ prefix }
-		if results.size <= 1
-			return results.first
-		else
-			return :ambiguous
-		end
-	end
+      def find_by_name_prefix(name, options = {})
+        prefix = /^#{Regexp.escape name}/
+        results = list(options).find_all { |instance| instance.name =~ prefix }
+        if results.size <= 1
+          return results.first
+        else
+          return :ambiguous
+        end
+      end
 
-private
-	def default_path
-		["PASSENGER_INSTANCE_REGISTRY_DIR", "TMPDIR"].each do |name|
-			if ENV.has_key?(name) && !ENV[name].empty?
-				return ENV[name]
-			end
-		end
-		return "/tmp"
-	end
+    private
+      def default_path
+        ["PASSENGER_INSTANCE_REGISTRY_DIR", "TMPDIR"].each do |name|
+          if ENV.has_key?(name) && !ENV[name].empty?
+            return ENV[name]
+          end
+        end
+        return "/tmp"
+      end
 
-	def cleanup(path)
-		puts "*** Cleaning stale instance directory #{path}"
-		FileUtils.chmod_R(0700, path) rescue nil
-		FileUtils.remove_entry_secure(path)
-	end
-end
+      def cleanup(path)
+        puts "*** Cleaning stale instance directory #{path}"
+        FileUtils.chmod_R(0700, path) rescue nil
+        FileUtils.remove_entry_secure(path)
+      end
+    end
 
-end # module AdminTools
+  end # module AdminTools
 end # module PhusionPassenger

data/lib/phusion_passenger/admin_tools/memory_stats.rb

@@ -25,276 +25,276 @@ PhusionPassenger.require_passenger_lib 'platform_info/apache'
 PhusionPassenger.require_passenger_lib 'platform_info/operating_system'
 
 module PhusionPassenger
-module AdminTools
+  module AdminTools
 
-class MemoryStats
-	# Information about a single process.
-	class Process
-		attr_accessor :pid
-		attr_accessor :ppid
-		attr_accessor :threads
-		attr_accessor :vm_size              # in KB
-		attr_accessor :rss                  # in KB
-		attr_accessor :cpu
-		attr_accessor :name
-		attr_accessor :private_dirty_rss    # in KB
-		
-		def vm_size_in_mb
-			return sprintf("%.1f MB", vm_size / 1024.0)
-		end
+    class MemoryStats
+      # Information about a single process.
+      class Process
+        attr_accessor :pid
+        attr_accessor :ppid
+        attr_accessor :threads
+        attr_accessor :vm_size              # in KB
+        attr_accessor :rss                  # in KB
+        attr_accessor :cpu
+        attr_accessor :name
+        attr_accessor :private_dirty_rss    # in KB
 
-		def rss_in_mb
-			return sprintf("%.1f MB", rss / 1024.0)
-		end
-		
-		def private_dirty_rss_in_mb
-			if private_dirty_rss.is_a?(Numeric)
-				return sprintf("%.1f MB", private_dirty_rss / 1024.0)
-			else
-				return "?"
-			end
-		end
-		
-		def to_a
-			return [pid, ppid, vm_size_in_mb, private_dirty_rss_in_mb, rss_in_mb, name]
-		end
-	end
-	
-	# Returns a list of Apache processes, which may be the empty list if Apache is
-	# not running. If the Apache executable name is unknown then nil will be returned.
-	def apache_processes
-		@apache_processes ||= begin
-			if PlatformInfo.httpd
-				processes = list_processes(:exe => PlatformInfo.httpd)
-				if processes.empty?
-					# On some Linux distros, the Apache worker processes
-					# are called "httpd.worker"
-					processes = list_processes(:exe => "#{PlatformInfo.httpd}.worker")
-				end
-				processes
-			else
-				nil
-			end
-		end
-	end
-	
-	# Returns a list of Nginx processes, which may be the empty list if
-	# Nginx is not running.
-	def nginx_processes
-		@nginx_processes ||= list_processes(:exe => "nginx")
-	end
-	
-	# Returns a list of Phusion Passenger processes, which may be the empty list if
-	# Phusion Passenger is not running.
-	def passenger_processes
-		@passenger_processes ||= list_processes(:match =>
-			/((^| )Passenger|(^| )Rails:|(^| )Rack:|wsgi-loader.py)/)
-	end
-	
-	# Returns the sum of the memory usages of all given processes.
-	# Returns a pair [usage, accurate]. +usage+ is the summed memory usage in KB,
-	# and +accurate+ indicates whether this sum is accurate. This may be false
-	# if some process's memory usage cannot be determined.
-	def sum_memory_usage(processes)
-		total = 0
-		if should_show_private_dirty_rss?
-			accurate = true
-			processes.each do |p|
-				if p.private_dirty_rss.is_a?(Numeric)
-					total += p.private_dirty_rss
-				else
-					accurate = true
-				end
-			end
-			return [total, accurate]
-		else
-			processes.each do |p|
-				total += p.rss
-			end
-			return [total, true]
-		end
-	end
-	
-	def platform_provides_private_dirty_rss_information?
-		return os_name == "linux"
-	end
-	
-	# Returns whether root privileges are required in order to measure private dirty RSS.
-	# Only meaningful if #platform_provides_private_dirty_rss_information? returns true.
-	def root_privileges_required_for_private_dirty_rss?
-		all_processes = (apache_processes || []) + nginx_processes + passenger_processes
-		return all_processes.any?{ |p| p.private_dirty_rss.nil? }
-	end
-	
-	def should_show_private_dirty_rss?
-		return platform_provides_private_dirty_rss_information? &&
-			(::Process.euid == 0 || root_privileges_required_for_private_dirty_rss?)
-	end
-	
-	# Determine the system's RAM usage, not including swap.
-	# Returns a tuple [total, used] where both numbers are in KB, or nil
-	# if the system's RAM usage cannot be determined.
-	def system_ram_usage
-		@total_system_ram ||= begin
-			case os_name
-			when /linux/
-				free_text = `free -k`
-				
-				free_text =~ %r{Mem:(.+)$}
-				line = $1.strip
-				total = line.split(/ +/).first.to_i
-				
-				free_text =~ %r{buffers/cache:(.+)$}
-				line = $1.strip
-				used = line.split(/ +/).first.to_i
-				
-				[total, used]
-			when /macosx/
-				vm_stat = `vm_stat`
-				vm_stat =~ /page size of (\d+) bytes/
-				page_size = $1
-				vm_stat =~ /Pages free: +(\d+)/
-				free = $1
-				vm_stat =~ /Pages active: +(\d+)/
-				active = $1
-				vm_stat =~ /Pages inactive: +(\d+)/
-				inactive = $1
-				vm_stat =~ /Pages wired down: +(\d+)/
-				wired = $1
-				
-				if page_size && free && active && inactive && wired
-					page_size = page_size.to_i
-					free = free.to_i * page_size / 1024
-					active = active.to_i * page_size / 1024
-					inactive = inactive.to_i * page_size / 1024
-					wired = wired.to_i * page_size / 1024
-					
-					used = active + wired
-					[free + inactive + used, used]
-				else
-					nil
-				end
-			else
-				`top` =~ /(\d+)(K|M) Active, (\d+)(K|M) Inact, (\d+)(K|M) Wired,.*?(\d+)(K|M) Free/
-				if $1 && $2 && $3 && $4 && $5 && $6 && $7 && $8
-					to_kb = lambda do |number, unit|
-						if unit == 'K'
-							number.to_i
-						else
-							number.to_i * 1024
-						end
-					end
-					
-					active = to_kb.call($1, $2)
-					inactive = to_kb.call($3, $4)
-					wired = to_kb.call($5, $6)
-					free = to_kb.call($7, $8)
-					
-					used = active + wired
-					[free + inactive + used, used]
-				else
-					nil
-				end
-			end
-		end
-	end
+        def vm_size_in_mb
+          return sprintf("%.1f MB", vm_size / 1024.0)
+        end
 
-private
-	def os_name
-		return PlatformInfo.os_name
-	end
-	
-	# Returns a list of Process objects that match the given search criteria.
-	#
-	#  # Search by executable path.
-	#  list_processes(:exe => '/usr/sbin/apache2')
-	#  
-	#  # Search by executable name.
-	#  list_processes(:name => 'ruby1.8')
-	#  
-	#  # Search by process name.
-	#  list_processes(:match => 'Passenger FrameworkSpawner')
-	def list_processes(options)
-		if options[:exe]
-			name = options[:exe].sub(/.*\/(.*)/, '\1')
-			if os_name =~ /linux/
-				ps = "ps -C '#{name}'"
-			else
-				ps = "ps -A"
-				options[:match] = Regexp.new(Regexp.escape(name))
-			end
-		elsif options[:name]
-			if os_name =~ /linux/
-				ps = "ps -C '#{options[:name]}'"
-			else
-				ps = "ps -A"
-				options[:match] = Regexp.new(" #{Regexp.escape(options[:name])}")
-			end
-		elsif options[:match]
-			ps = "ps -A"
-		else
-			raise ArgumentError, "Invalid options."
-		end
-		
-		processes = []
-		case os_name
-		when /solaris/
-			list = `#{ps} -o pid,ppid,nlwp,vsz,rss,pcpu,comm`.split("\n")
-			threads_known = true
-		when /macosx/
-			list = `#{ps} -w -o pid,ppid,vsz,rss,%cpu,command`.split("\n")
-			threads_known = false
-		else
-			list = `#{ps} -w -o pid,ppid,nlwp,vsz,rss,%cpu,command`.split("\n")
-			threads_known = true
-		end
-		list.shift
-		list.each do |line|
-			line.gsub!(/^ */, '')
-			line.gsub!(/ *$/, '')
-			
-			p = Process.new
-			if threads_known
-				p.pid, p.ppid, p.threads, p.vm_size, p.rss, p.cpu, p.name = line.split(/ +/, 7)
-			else
-				p.pid, p.ppid, p.vm_size, p.rss, p.cpu, p.name = line.split(/ +/, 6)
-			end
-			p.name.sub!(/\Aruby: /, '')
-			p.name.sub!(/ \(ruby\)\Z/, '')
-			if p.name !~ /^ps/ && (!options[:match] || p.name.match(options[:match]))
-				# Convert some values to integer.
-				[:pid, :ppid, :vm_size, :rss].each do |attr|
-					p.send("#{attr}=", p.send(attr).to_i)
-				end
-				p.threads = p.threads.to_i if threads_known
+        def rss_in_mb
+          return sprintf("%.1f MB", rss / 1024.0)
+        end
 
-				if platform_provides_private_dirty_rss_information?
-					p.private_dirty_rss = determine_private_dirty_rss(p.pid)
-				end
-				processes << p
-			end
-		end
-		return processes
-	end
-	
-	# Returns the private dirty RSS for the given process, in KB.
-	def determine_private_dirty_rss(pid)
-		total = 0
-		File.read("/proc/#{pid}/smaps").split("\n").each do |line|
-			line =~ /^(Private)_Dirty: +(\d+)/
-			if $2
-				total += $2.to_i
-			end
-		end
-		if total == 0
-			return nil
-		else
-			return total
-		end
-	rescue Errno::EACCES, Errno::ENOENT
-		return nil
-	end
-end
+        def private_dirty_rss_in_mb
+          if private_dirty_rss.is_a?(Numeric)
+            return sprintf("%.1f MB", private_dirty_rss / 1024.0)
+          else
+            return "?"
+          end
+        end
 
-end # module AdminTools
+        def to_a
+          return [pid, ppid, vm_size_in_mb, private_dirty_rss_in_mb, rss_in_mb, name]
+        end
+      end
+
+      # Returns a list of Apache processes, which may be the empty list if Apache is
+      # not running. If the Apache executable name is unknown then nil will be returned.
+      def apache_processes
+        @apache_processes ||= begin
+          if PlatformInfo.httpd
+            processes = list_processes(:exe => PlatformInfo.httpd)
+            if processes.empty?
+              # On some Linux distros, the Apache worker processes
+              # are called "httpd.worker"
+              processes = list_processes(:exe => "#{PlatformInfo.httpd}.worker")
+            end
+            processes
+          else
+            nil
+          end
+        end
+      end
+
+      # Returns a list of Nginx processes, which may be the empty list if
+      # Nginx is not running.
+      def nginx_processes
+        @nginx_processes ||= list_processes(:exe => "nginx")
+      end
+
+      # Returns a list of Phusion Passenger processes, which may be the empty list if
+      # Phusion Passenger is not running.
+      def passenger_processes
+        @passenger_processes ||= list_processes(:match =>
+          /((^| )Passenger|(^| )Rails:|(^| )Rack:|wsgi-loader.py)/)
+      end
+
+      # Returns the sum of the memory usages of all given processes.
+      # Returns a pair [usage, accurate]. +usage+ is the summed memory usage in KB,
+      # and +accurate+ indicates whether this sum is accurate. This may be false
+      # if some process's memory usage cannot be determined.
+      def sum_memory_usage(processes)
+        total = 0
+        if should_show_private_dirty_rss?
+          accurate = true
+          processes.each do |p|
+            if p.private_dirty_rss.is_a?(Numeric)
+              total += p.private_dirty_rss
+            else
+              accurate = true
+            end
+          end
+          return [total, accurate]
+        else
+          processes.each do |p|
+            total += p.rss
+          end
+          return [total, true]
+        end
+      end
+
+      def platform_provides_private_dirty_rss_information?
+        return os_name == "linux"
+      end
+
+      # Returns whether root privileges are required in order to measure private dirty RSS.
+      # Only meaningful if #platform_provides_private_dirty_rss_information? returns true.
+      def root_privileges_required_for_private_dirty_rss?
+        all_processes = (apache_processes || []) + nginx_processes + passenger_processes
+        return all_processes.any?{ |p| p.private_dirty_rss.nil? }
+      end
+
+      def should_show_private_dirty_rss?
+        return platform_provides_private_dirty_rss_information? &&
+          (::Process.euid == 0 || root_privileges_required_for_private_dirty_rss?)
+      end
+
+      # Determine the system's RAM usage, not including swap.
+      # Returns a tuple [total, used] where both numbers are in KB, or nil
+      # if the system's RAM usage cannot be determined.
+      def system_ram_usage
+        @total_system_ram ||= begin
+          case os_name
+          when /linux/
+            free_text = `free -k`
+
+            free_text =~ %r{Mem:(.+)$}
+            line = $1.strip
+            total = line.split(/ +/).first.to_i
+
+            free_text =~ %r{buffers/cache:(.+)$}
+            line = $1.strip
+            used = line.split(/ +/).first.to_i
+
+            [total, used]
+          when /macosx/
+            vm_stat = `vm_stat`
+            vm_stat =~ /page size of (\d+) bytes/
+            page_size = $1
+            vm_stat =~ /Pages free: +(\d+)/
+            free = $1
+            vm_stat =~ /Pages active: +(\d+)/
+            active = $1
+            vm_stat =~ /Pages inactive: +(\d+)/
+            inactive = $1
+            vm_stat =~ /Pages wired down: +(\d+)/
+            wired = $1
+
+            if page_size && free && active && inactive && wired
+              page_size = page_size.to_i
+              free = free.to_i * page_size / 1024
+              active = active.to_i * page_size / 1024
+              inactive = inactive.to_i * page_size / 1024
+              wired = wired.to_i * page_size / 1024
+
+              used = active + wired
+              [free + inactive + used, used]
+            else
+              nil
+            end
+          else
+            `top` =~ /(\d+)(K|M) Active, (\d+)(K|M) Inact, (\d+)(K|M) Wired,.*?(\d+)(K|M) Free/
+            if $1 && $2 && $3 && $4 && $5 && $6 && $7 && $8
+              to_kb = lambda do |number, unit|
+                if unit == 'K'
+                  number.to_i
+                else
+                  number.to_i * 1024
+                end
+              end
+
+              active = to_kb.call($1, $2)
+              inactive = to_kb.call($3, $4)
+              wired = to_kb.call($5, $6)
+              free = to_kb.call($7, $8)
+
+              used = active + wired
+              [free + inactive + used, used]
+            else
+              nil
+            end
+          end
+        end
+      end
+
+    private
+      def os_name
+        return PlatformInfo.os_name
+      end
+
+      # Returns a list of Process objects that match the given search criteria.
+      #
+      #  # Search by executable path.
+      #  list_processes(:exe => '/usr/sbin/apache2')
+      #
+      #  # Search by executable name.
+      #  list_processes(:name => 'ruby1.8')
+      #
+      #  # Search by process name.
+      #  list_processes(:match => 'Passenger FrameworkSpawner')
+      def list_processes(options)
+        if options[:exe]
+          name = options[:exe].sub(/.*\/(.*)/, '\1')
+          if os_name =~ /linux/
+            ps = "ps -C '#{name}'"
+          else
+            ps = "ps -A"
+            options[:match] = Regexp.new(Regexp.escape(name))
+          end
+        elsif options[:name]
+          if os_name =~ /linux/
+            ps = "ps -C '#{options[:name]}'"
+          else
+            ps = "ps -A"
+            options[:match] = Regexp.new(" #{Regexp.escape(options[:name])}")
+          end
+        elsif options[:match]
+          ps = "ps -A"
+        else
+          raise ArgumentError, "Invalid options."
+        end
+
+        processes = []
+        case os_name
+        when /solaris/
+          list = `#{ps} -o pid,ppid,nlwp,vsz,rss,pcpu,comm`.split("\n")
+          threads_known = true
+        when /macosx/
+          list = `#{ps} -w -o pid,ppid,vsz,rss,%cpu,command`.split("\n")
+          threads_known = false
+        else
+          list = `#{ps} -w -o pid,ppid,nlwp,vsz,rss,%cpu,command`.split("\n")
+          threads_known = true
+        end
+        list.shift
+        list.each do |line|
+          line.gsub!(/^ */, '')
+          line.gsub!(/ *$/, '')
+
+          p = Process.new
+          if threads_known
+            p.pid, p.ppid, p.threads, p.vm_size, p.rss, p.cpu, p.name = line.split(/ +/, 7)
+          else
+            p.pid, p.ppid, p.vm_size, p.rss, p.cpu, p.name = line.split(/ +/, 6)
+          end
+          p.name.sub!(/\Aruby: /, '')
+          p.name.sub!(/ \(ruby\)\Z/, '')
+          if p.name !~ /^ps/ && (!options[:match] || p.name.match(options[:match]))
+            # Convert some values to integer.
+            [:pid, :ppid, :vm_size, :rss].each do |attr|
+              p.send("#{attr}=", p.send(attr).to_i)
+            end
+            p.threads = p.threads.to_i if threads_known
+
+            if platform_provides_private_dirty_rss_information?
+              p.private_dirty_rss = determine_private_dirty_rss(p.pid)
+            end
+            processes << p
+          end
+        end
+        return processes
+      end
+
+      # Returns the private dirty RSS for the given process, in KB.
+      def determine_private_dirty_rss(pid)
+        total = 0
+        File.read("/proc/#{pid}/smaps").split("\n").each do |line|
+          line =~ /^(Private)_Dirty: +(\d+)/
+          if $2
+            total += $2.to_i
+          end
+        end
+        if total == 0
+          return nil
+        else
+          return total
+        end
+      rescue Errno::EACCES, Errno::ENOENT
+        return nil
+      end
+    end
+
+  end # module AdminTools
 end # module PhusionPassenger