### Home Classes Methods

### In Files

- lib/phusion_passenger/platform_info.rb
- lib/phusion_passenger/platform_info/binary_compatibility.rb
- lib/phusion_passenger/platform_info/ruby.rb
- lib/phusion_passenger/platform_info/curl.rb
- lib/phusion_passenger/platform_info/apache_detector.rb
- lib/phusion_passenger/platform_info/cxx_portability.rb
- lib/phusion_passenger/platform_info/operating_system.rb
- lib/phusion_passenger/platform_info/apache.rb
- lib/phusion_passenger/platform_info/depcheck.rb
- lib/phusion_passenger/platform_info/compiler.rb
- lib/phusion_passenger/platform_info/zlib.rb
- lib/phusion_passenger/platform_info/linux.rb

### Namespace

- MODULE PhusionPassenger::PlatformInfo::Depcheck
- CLASS PhusionPassenger::PlatformInfo::ApacheDetector
- CLASS PhusionPassenger::PlatformInfo::RuntimeError

### Methods

- ::a2dismod
- ::a2enmod
- ::apache2_bindir
- ::apache2_module_cflags
- ::apache2_module_ldflags
- ::apache2_sbindir
- ::apache2ctl
- ::apr_config
- ::apr_config_needed_for_building_apache_modules?
- ::apr_flags
- ::apr_libs
- ::apu_config
- ::apu_flags
- ::apu_libs
- ::apxs2
- ::cache_dir
- ::cache_dir=
- ::cc
- ::cc_is_clang?
- ::compiler_supports_architecture?
- ::compiler_supports_feliminate_unused_debug?
- ::compiler_supports_no_tls_direct_seg_refs_option?
- ::compiler_supports_visibility_flag?
- ::compiler_supports_wno_ambiguous_member_template?
- ::compiler_supports_wno_attributes_flag?
- ::compiler_supports_wno_missing_field_initializers_flag?
- ::compiler_visibility_flag_generates_warnings?
- ::cpu_architectures
- ::curl_flags
- ::curl_libs
- ::curl_supports_ssl?
- ::cxx
- ::cxx_binary_compatibility_id
- ::cxx_is_clang?
- ::debugging_cflags
- ::dmalloc_ldflags
- ::electric_fence_ldflags
- ::env_defined?
- ::export_dynamic_flags
- ::find_all_commands
- ::find_apache2_executable
- ::find_command
- ::find_header
- ::gem_command
- ::gnu_make
- ::has_alloca_h?
- ::has_math_library?
- ::httpd
- ::httpd_actual_error_log
- ::httpd_default_config_file
- ::httpd_default_error_log
- ::httpd_envvars_file
- ::httpd_infer_envvar
- ::httpd_root
- ::httpd_supports_a2enmod?
- ::httpd_version
- ::in_rvm?
- ::library_extension
- ::linux_distro
- ::linux_distro_tags
- ::locate_ruby_tool
- ::log_implementation
- ::log_implementation=
- ::make
- ::os_name
- ::passenger_needs_ruby_dev_header?
- ::portability_cflags
- ::portability_ldflags
- ::rake
- ::rake_command
- ::rb_config
- ::read_file
- ::requires_no_tls_direct_seg_refs?
- ::rspec
- ::ruby_command
- ::ruby_executable
- ::ruby_extension_binary_compatibility_id
- ::ruby_sudo_command
- ::ruby_supports_fork?
- ::rvm_installation_mode
- ::rvm_paths
- ::rvm_ruby_string
- ::string_env
- ::supports_lfence_instruction?
- ::supports_sfence_instruction?
- ::tmpdir
- ::tmpexedir
- ::try_compile
- ::try_compile_and_run
- ::try_link
- ::verbose=
- ::verbose?
- ::zlib_flags
- ::zlib_libs

### Class/Module Index

Quicksearch

- PhusionPassenger
- PhusionPassenger::AbstractInstaller
- PhusionPassenger::AbstractInstaller::Abort
- PhusionPassenger::AbstractInstaller::CommandError
- PhusionPassenger::AdminTools
- PhusionPassenger::AdminTools::MemoryStats
- PhusionPassenger::AdminTools::MemoryStats::Process
- PhusionPassenger::AdminTools::ServerInstance
- PhusionPassenger::AdminTools::ServerInstance::CorruptedDirectoryError
- PhusionPassenger::AdminTools::ServerInstance::GenerationsAbsentError
- PhusionPassenger::AdminTools::ServerInstance::Group
- PhusionPassenger::AdminTools::ServerInstance::Process
- PhusionPassenger::AdminTools::ServerInstance::RoleDeniedError
- PhusionPassenger::AdminTools::ServerInstance::StaleDirectoryError
- PhusionPassenger::AdminTools::ServerInstance::Stats
- PhusionPassenger::AdminTools::ServerInstance::UnsupportedGenerationStructureVersionError
- PhusionPassenger::AnalyticsLogger
- PhusionPassenger::AnalyticsLogger::Connection
- PhusionPassenger::AnalyticsLogger::Lock
- PhusionPassenger::AnalyticsLogger::Log
- PhusionPassenger::ClassicRails
- PhusionPassenger::ClassicRails::CGIFixed
- PhusionPassenger::ClassicRails::ThreadHandlerExtension
- PhusionPassenger::ConsoleTextTemplate
- PhusionPassenger::DebugLogging
- PhusionPassenger::LoaderSharedHelpers
- PhusionPassenger::MessageChannel
- PhusionPassenger::MessageChannel::InvalidHashError
- PhusionPassenger::MessageClient
- PhusionPassenger::NativeSupportLoader
- PhusionPassenger::Packaging
- PhusionPassenger::PlatformInfo
- PhusionPassenger::PlatformInfo::ApacheDetector
- PhusionPassenger::PlatformInfo::ApacheDetector::Result
- PhusionPassenger::PlatformInfo::Depcheck
- PhusionPassenger::PlatformInfo::Depcheck::ConsoleRunner
- PhusionPassenger::PlatformInfo::Depcheck::Dependency
- PhusionPassenger::PlatformInfo::RuntimeError
- PhusionPassenger::Plugin
- PhusionPassenger::PreloaderSharedHelpers
- PhusionPassenger::Rack
- PhusionPassenger::Rack::OutOfBandGc
- PhusionPassenger::Rack::ThreadHandlerExtension
- PhusionPassenger::Rails3Extensions
- PhusionPassenger::Rails3Extensions::AnalyticsLogging
- PhusionPassenger::Rails3Extensions::AnalyticsLogging::ACExtension
- PhusionPassenger::Rails3Extensions::AnalyticsLogging::ASBenchmarkableExtension
- PhusionPassenger::Rails3Extensions::AnalyticsLogging::ExceptionLogger
- PhusionPassenger::RequestHandler
- PhusionPassenger::RequestHandler::ThreadHandler
- PhusionPassenger::RequestHandler::ThreadHandler::Interrupted
- PhusionPassenger::SharedConstants
- PhusionPassenger::Standalone
- PhusionPassenger::Standalone::AppFinder
- PhusionPassenger::Standalone::Command
- PhusionPassenger::Standalone::ConfigFile
- PhusionPassenger::Standalone::ConfigFile::DisallowedContextError
- PhusionPassenger::Standalone::HelpCommand
- PhusionPassenger::Standalone::Main
- PhusionPassenger::Standalone::PackageRuntimeCommand
- PhusionPassenger::Standalone::RuntimeInstaller
- PhusionPassenger::Standalone::RuntimeLocator
- PhusionPassenger::Standalone::StartCommand
- PhusionPassenger::Standalone::StatusCommand
- PhusionPassenger::Standalone::StopCommand
- PhusionPassenger::Standalone::Utils
- PhusionPassenger::Standalone::VersionCommand
- PhusionPassenger::Utils
- PhusionPassenger::Utils::AnsiColors
- PhusionPassenger::Utils::FileSystemWatcher
- PhusionPassenger::Utils::FileSystemWatcher::DirInfo
- PhusionPassenger::Utils::FileSystemWatcher::FileInfo
- PhusionPassenger::Utils::GeneratorTest
- PhusionPassenger::Utils::HostsFileParser
- PhusionPassenger::Utils::JSON
- PhusionPassenger::Utils::JSON::Generator
- PhusionPassenger::Utils::ParserTest
- PhusionPassenger::Utils::TeeInput
- PhusionPassenger::Utils::TmpIO
- PhusionPassenger::Utils::UnseekableSocket
- CommonLibraryBuilder
- Exception
- GC
- IO
- Object
- Signal

No matching classes.

# PhusionPassenger::PlatformInfo

This module autodetects various platform-specific information, and provides that information through constants.

Users can change the detection behavior by setting the environment variable `APXS2` to the correct 'apxs' (or 'apxs2') binary, as provided by Apache.

### Constants

GEM_HOME
RUBY_ENGINE

### Public Class Methods

a2dismod(options = {}) click to toggle source

The absolute path to the 'a2enmod' executable.

    # File lib/phusion_passenger/platform_info/apache.rb, line 266
    def self.a2dismod(options = {})
            apxs2 = options[:apxs2] || self.apxs2
            if env_defined?('A2DISMOD')
                    return ENV['A2DISMOD']
            else
                    return find_apache2_executable("a2dismod", options)
            end
    end

a2enmod(options = {}) click to toggle source

The absolute path to the 'a2enmod' executable.

    # File lib/phusion_passenger/platform_info/apache.rb, line 255
    def self.a2enmod(options = {})
            apxs2 = options[:apxs2] || self.apxs2
            if env_defined?('A2ENMOD')
                    return ENV['A2ENMOD']
            else
                    return find_apache2_executable("a2enmod", options)
            end
    end

apache2_bindir(options = {}) click to toggle source

The absolute path to the Apache 2 'bin' directory, or nil if unknown.

    # File lib/phusion_passenger/platform_info/apache.rb, line 367
    def self.apache2_bindir(options = {})
            apxs2 = options[:apxs2] || self.apxs2
            if apxs2.nil?
                    return nil
            else
                    return `#{apxs2} -q BINDIR 2>/dev/null`.strip
            end
    end

apache2_module_cflags(with_apr_flags = true) click to toggle source

The C compiler flags that are necessary to compile an Apache module. Also includes APR and APU compiler flags if with_apr_flags is true.

    # File lib/phusion_passenger/platform_info/apache.rb, line 393
    def self.apache2_module_cflags(with_apr_flags = true)
            flags = ["-fPIC"]
            if with_apr_flags
                    flags << apr_flags
                    flags << apu_flags
            end
            if !apxs2.nil?
                    apxs2_flags = `#{apxs2} -q CFLAGS`.strip << " -I" << `#{apxs2} -q INCLUDEDIR`.strip
                    apxs2_flags.gsub!(/-O\d? /, '')

                    # Remove flags not supported by GCC
                    if RUBY_PLATFORM =~ /solaris/ # TODO: Add support for people using SunStudio
                            # The big problem is Coolstack apxs includes a bunch of solaris -x directives.
                            options = apxs2_flags.split
                            options.reject! { |f| f =~ /^\-x/ }
                            options.reject! { |f| f =~ /^\-Xa/ }
                            options.reject! { |f| f =~ /^\-fast/ }
                            options.reject! { |f| f =~ /^\-mt/ }
                            apxs2_flags = options.join(' ')
                    end

                    apxs2_flags.strip!
                    flags << apxs2_flags
            end
            if !httpd.nil? && RUBY_PLATFORM =~ /darwin/
                    # The default Apache install on OS X is a universal binary.
                    # Figure out which architectures it's compiled for and do the same
                    # thing for mod_passenger. We use the 'file' utility to do this.
                    #
                    # Running 'file' on the Apache executable usually outputs something
                    # like this:
                    #
                    #   /usr/sbin/httpd: Mach-O universal binary with 4 architectures
                    #   /usr/sbin/httpd (for architecture ppc7400):     Mach-O executable ppc
                    #   /usr/sbin/httpd (for architecture ppc64):       Mach-O 64-bit executable ppc64
                    #   /usr/sbin/httpd (for architecture i386):        Mach-O executable i386
                    #   /usr/sbin/httpd (for architecture x86_64):      Mach-O 64-bit executable x86_64
                    #
                    # But on some machines, it may output just:
                    #
                    #   /usr/sbin/httpd: Mach-O fat file with 4 architectures
                    #
                    # (http://code.google.com/p/phusion-passenger/issues/detail?id=236)
                    output = `file "#{httpd}"`.strip
                    if output =~ /Mach-O fat file/ && output !~ /for architecture/
                            architectures = ["i386", "ppc", "x86_64", "ppc64"]
                    else
                            architectures = []
                            output.split("\n").grep(/for architecture/).each do |line|
                                    line =~ /for architecture (.*?)\)/
                                    architectures << $1
                            end
                    end
                    # The compiler may not support all architectures in the binary.
                    # XCode 4 seems to have removed support for the PPC architecture
                    # even though there are still plenty of Apache binaries around
                    # containing PPC components.
                    architectures.reject! do |arch|
                            !compiler_supports_architecture?(arch)
                    end
                    architectures.map! do |arch|
                            "-arch #{arch}"
                    end
                    flags << architectures.compact.join(' ')
            end
            return flags.compact.join(' ').strip
    end

apache2_module_ldflags() click to toggle source

Linker flags that are necessary for linking an Apache module. Already includes APR and APU linker flags.

    # File lib/phusion_passenger/platform_info/apache.rb, line 464
    def self.apache2_module_ldflags
            flags = "-fPIC #{apr_libs} #{apu_libs}"
            flags.strip!
            return flags
    end

apache2_sbindir(options = {}) click to toggle source

The absolute path to the Apache 2 'sbin' directory, or nil if unknown.

    # File lib/phusion_passenger/platform_info/apache.rb, line 378
    def self.apache2_sbindir(options = {})
            apxs2 = options[:apxs2] || self.apxs2
            if apxs2.nil?
                    return nil
            else
                    return `#{apxs2} -q SBINDIR`.strip
            end
    end

apache2ctl(options = {}) click to toggle source

The absolute path to the 'apachectl' or 'apache2ctl' binary, or nil if not found.

    # File lib/phusion_passenger/platform_info/apache.rb, line 60
    def self.apache2ctl(options = {})
            return find_apache2_executable('apache2ctl', 'apachectl2', 'apachectl', options)
    end

apr_config() click to toggle source

The absolute path to the 'apr-config' or 'apr-1-config' executable, or nil if not found.

    # File lib/phusion_passenger/platform_info/apache.rb, line 278
    def self.apr_config
            if env_defined?('APR_CONFIG')
                    return ENV['APR_CONFIG']
            elsif apxs2.nil?
                    return nil
            else
                    filename = `#{apxs2} -q APR_CONFIG 2>/dev/null`.strip
                    if filename.empty?
                            apr_bindir = `#{apxs2} -q APR_BINDIR 2>/dev/null`.strip
                            if apr_bindir.empty?
                                    return nil
                            else
                                    return select_executable(apr_bindir,
                                            "apr-1-config", "apr-config")
                            end
                    elsif File.exist?(filename)
                            return filename
                    else
                            return nil
                    end
            end
    end

apr_config_needed_for_building_apache_modules?() click to toggle source

Returns whether it is necessary to use information outputted by 'apr-config' and 'apu-config' in order to compile an Apache module. When Apache is installed with --with-included-apr, the APR/APU headers are placed into the same directory as the Apache headers, and so 'apr-config' and 'apu-config' won't be necessary in that case.

    # File lib/phusion_passenger/platform_info/apache.rb, line 499
    def self.apr_config_needed_for_building_apache_modules?
            return !try_compile("whether APR is needed for building Apache modules",
                    :c, "#include <apr.h>\n", apache2_module_cflags(false))
    end

apr_flags() click to toggle source

The C compiler flags that are necessary for programs that use APR.

    # File lib/phusion_passenger/platform_info/apache.rb, line 472
    def self.apr_flags
            return determine_apr_info[0]
    end

apr_libs() click to toggle source

The linker flags that are necessary for linking programs that use APR.

    # File lib/phusion_passenger/platform_info/apache.rb, line 477
    def self.apr_libs
            return determine_apr_info[1]
    end

apu_config() click to toggle source

The absolute path to the 'apu-config' or 'apu-1-config' executable, or nil if not found.

    # File lib/phusion_passenger/platform_info/apache.rb, line 304
    def self.apu_config
            if env_defined?('APU_CONFIG')
                    return ENV['APU_CONFIG']
            elsif apxs2.nil?
                    return nil
            else
                    filename = `#{apxs2} -q APU_CONFIG 2>/dev/null`.strip
                    if filename.empty?
                            apu_bindir = `#{apxs2} -q APU_BINDIR 2>/dev/null`.strip
                            if apu_bindir.empty?
                                    return nil
                            else
                                    return select_executable(apu_bindir,
                                            "apu-1-config", "apu-config")
                            end
                    elsif File.exist?(filename)
                            return filename
                    else
                            return nil
                    end
            end
    end

apu_flags() click to toggle source

The C compiler flags that are necessary for programs that use APR-Util.

    # File lib/phusion_passenger/platform_info/apache.rb, line 482
    def self.apu_flags
            return determine_apu_info[0]
    end

apu_libs() click to toggle source

The linker flags that are necessary for linking programs that use APR-Util.

    # File lib/phusion_passenger/platform_info/apache.rb, line 487
    def self.apu_libs
            return determine_apu_info[1]
    end

apxs2() click to toggle source

The absolute path to the 'apxs' or 'apxs2' executable, or nil if not found.

    # File lib/phusion_passenger/platform_info/apache.rb, line 44
    def self.apxs2
            if env_defined?("APXS2")
                    return ENV["APXS2"]
            end
            ['apxs2', 'apxs'].each do |name|
                    command = find_command(name)
                    if !command.nil?
                            return command
                    end
            end
            return nil
    end

cache_dir() click to toggle source

    # File lib/phusion_passenger/platform_info.rb, line 186
    def self.cache_dir
            return @@cache_dir
    end

cache_dir=(value) click to toggle source

    # File lib/phusion_passenger/platform_info.rb, line 182
    def self.cache_dir=(value)
            @@cache_dir = value
    end

cc() click to toggle source

    # File lib/phusion_passenger/platform_info/compiler.rb, line 108
    def self.cc
            return string_env('CC', 'gcc')
    end

cc_is_clang?() click to toggle source

    # File lib/phusion_passenger/platform_info/compiler.rb, line 116
    def self.cc_is_clang?
            `#{cc} --version 2>&1` =~ /clang version/
    end

compiler_supports_architecture?(arch) click to toggle source

Checks whether the compiler supports "-arch #{arch}".

    # File lib/phusion_passenger/platform_info/compiler.rb, line 225
    def self.compiler_supports_architecture?(arch)
            return try_compile("Checking for C compiler '-arch' support",
                    :c, '', "-arch #{arch}")
    end

compiler_supports_feliminate_unused_debug?() click to toggle source

    # File lib/phusion_passenger/platform_info/compiler.rb, line 261
    def self.compiler_supports_feliminate_unused_debug?
            create_temp_file("passenger-compile-check.c") do |filename, f|
                    f.close
                    begin
                            command = create_compiler_command(:c,
                                    "-c '#{filename}' -o '#{filename}.o'",
                                    '-feliminate-unused-debug-symbols -feliminate-unused-debug-types')
                            result = run_compiler("Checking for C compiler '--feliminate-unused-debug-{symbols,types}' support",
                                    command, filename, '', true)
                            return result && result[:output].empty?
                    ensure
                            File.unlink("#{filename}.o") rescue nil
                    end
            end
    end

compiler_supports_no_tls_direct_seg_refs_option?() click to toggle source

    # File lib/phusion_passenger/platform_info/compiler.rb, line 249
    def self.compiler_supports_no_tls_direct_seg_refs_option?
            return try_compile("Checking for C compiler '-mno-tls-direct-seg-refs' support",
                    :c, '', '-mno-tls-direct-seg-refs')
    end

compiler_supports_visibility_flag?() click to toggle source

    # File lib/phusion_passenger/platform_info/compiler.rb, line 230
    def self.compiler_supports_visibility_flag?
            return false if RUBY_PLATFORM =~ /aix/
            return try_compile("Checking for C compiler '-fvisibility' support",
                    :c, '', '-fvisibility=hidden')
    end

compiler_supports_wno_ambiguous_member_template?() click to toggle source

    # File lib/phusion_passenger/platform_info/compiler.rb, line 255
    def self.compiler_supports_wno_ambiguous_member_template?
            return try_compile("Checking for C compiler '-Wno-ambiguous-member-template' support",
                    :c, '', '-Wno-ambiguous-member-template')
    end

compiler_supports_wno_attributes_flag?() click to toggle source

    # File lib/phusion_passenger/platform_info/compiler.rb, line 237
    def self.compiler_supports_wno_attributes_flag?
            return try_compile("Checking for C compiler '-Wno-attributes' support",
                    :c, '', '-Wno-attributes')
    end

compiler_supports_wno_missing_field_initializers_flag?() click to toggle source

    # File lib/phusion_passenger/platform_info/compiler.rb, line 243
    def self.compiler_supports_wno_missing_field_initializers_flag?
            return try_compile("Checking for C compiler '-Wno-missing-field-initializers' support",
                    :c, '', '-Wno-missing-field-initializers')
    end

compiler_visibility_flag_generates_warnings?() click to toggle source

Returns whether compiling C++ with -fvisibility=hidden might result in tons of useless warnings, like this: code.google.com/p/phusion-passenger/issues/detail?id=526 This appears to be a bug in older g++ versions: gcc.gnu.org/ml/gcc-patches/2006-07/msg00861.html Warnings should be suppressed with -Wno-attributes.

    # File lib/phusion_passenger/platform_info/compiler.rb, line 283
    def self.compiler_visibility_flag_generates_warnings?
            if RUBY_PLATFORM =~ /linux/ && `#{cxx} -v 2>&1` =~ /gcc version (.*?)/
                    return $1 <= "4.1.2"
            else
                    return false
            end
    end

cpu_architectures() click to toggle source

Returns a list of all CPU architecture names that the current machine CPU supports. If there are multiple such architectures then the first item in the result denotes that OS runtime's main/preferred architecture.

This function normalizes some names. For example x86 is always reported as "x86" regardless of whether the OS reports it as "i386" or "i686". x86_64 is always reported as "x86_64" even if the OS reports it as "amd64".

Please note that even if the CPU supports multiple architectures, the operating system might not. For example most x86 CPUs nowadays also support x86_64, but x86_64 Linux systems require various x86 compatibility libraries to be installed before x86 executables can be run. This function does not detect whether these compatibility libraries are installed. The only guarantee that you have is that the OS can run executables in the architecture denoted by the first item in the result.

For example, on x86_64 Linux this function can return ["x86_64", "x86"]. This indicates that the CPU supports both of these architectures, and that the OS's main/preferred architecture is x86_64. Most executables on the system are thus be x86_64. It is guaranteed that the OS can run x86_64 executables, but not x86 executables per se.

Another example: on MacOS X this function can return either

"x86_64", "x86"

  or ["x86", "x86_64"]. The former result indicates

OS X 10.6 (Snow Leopard) and beyond because starting from that version everything is 64-bit by default. The latter result indicates an OS X version older than 10.6.

    # File lib/phusion_passenger/platform_info/operating_system.rb, line 77
    def self.cpu_architectures
            if os_name == "macosx"
                    arch = `uname -p`.strip
                    if arch == "i386"
                            # Macs have been x86 since around 2007. I think all of them come with
                            # a recent enough Intel CPU that supports both x86 and x86_64, and I
                            # think every OS X version has both the x86 and x86_64 runtime installed.
                            major, minor, *rest = `sw_vers -productVersion`.strip.split(".")
                            major = major.to_i
                            minor = minor.to_i
                            if major >= 10 || (major == 10 && minor >= 6)
                                    # Since Snow Leopard x86_64 is the default.
                                    ["x86_64", "x86"]
                            else
                                    # Before Snow Leopard x86 was the default.
                                    ["x86", "x86_64"]
                            end
                    else
                            arch
                    end
            else
                    arch = `uname -p`.strip
                    # On some systems 'uname -p' returns something like
                    # 'Intel(R) Pentium(R) M processor 1400MHz' or
                    # 'Intel(R)_Xeon(R)_CPU___________X7460__@_2.66GHz'.
                    if arch == "unknown" || arch =~ / / || arch =~ /Hz$/
                            arch = `uname -m`.strip
                    end
                    if arch =~ /^i.86$/
                            arch = "x86"
                    elsif arch == "amd64"
                            arch = "x86_64"
                    end

                    if arch == "x86"
                            # Most x86 operating systems nowadays are probably running on
                            # a CPU that supports both x86 and x86_64, but we're not gonna
                            # go through the trouble of checking that. The main architecture
                            # is what we usually care about.
                            ["x86"]
                    elsif arch == "x86_64"
                            # I don't think there's a single x86_64 CPU out there
                            # that doesn't support x86 as well.
                            ["x86_64", "x86"]
                    else
                            [arch]
                    end
            end
    end

curl_flags() click to toggle source

    # File lib/phusion_passenger/platform_info/curl.rb, line 29
    def self.curl_flags
            result = `(curl-config --cflags) 2>/dev/null`.strip
            if result.empty?
                    return nil
            else
                    version = `curl-config --vernum`.strip
                    if version >= '070c01'
                            # Curl >= 7.12.1 supports curl_easy_reset()
                            result << " -DHAS_CURL_EASY_RESET"
                    end
                    return result
            end
    end

curl_libs() click to toggle source

    # File lib/phusion_passenger/platform_info/curl.rb, line 44
    def self.curl_libs
            result = `(curl-config --libs) 2>/dev/null`.strip
            if result.empty?
                    return nil
            else
                    return result
            end
    end

curl_supports_ssl?() click to toggle source

    # File lib/phusion_passenger/platform_info/curl.rb, line 54
    def self.curl_supports_ssl?
            features = `(curl-config --feature) 2>/dev/null`
            return features =~ /SSL/
    end

cxx() click to toggle source

    # File lib/phusion_passenger/platform_info/compiler.rb, line 112
    def self.cxx
            return string_env('CXX', 'g++')
    end

cxx_binary_compatibility_id() click to toggle source

Returns an identifier string that describes the current platform's binary compatibility with regard to C/C++ binaries. Two systems with the same binary compatibility identifiers should be able to run the same C/C++ binaries.

The the string depends on the following factors:

- The operating system name.

- Operating system runtime identifier. This may include the kernel version, libc version, C++ ABI version, etc. Everything that is of interest for binary compatibility with regard to C/C++ binaries.

- Operating system default runtime architecture. This is not the same as the CPU architecture; some CPUs support multiple architectures, e.g. Intel Core 2 Duo supports x86 and x86_64. Some operating systems actually support multiple runtime architectures: a lot of x86_64 Linux distributions also include 32-bit runtimes, and OS X Snow Leopard is x86_64 by default but all system libraries also support x86. This component identifies the architecture that is used when compiling a binary with the system's C++ compiler with its default options.

    # File lib/phusion_passenger/platform_info/binary_compatibility.rb, line 110
    def self.cxx_binary_compatibility_id
            if os_name == "macosx"
                    # RUBY_PLATFORM gives us the kernel version, but we want
                    # the OS X version.
                    os_version_string = `sw_vers -productVersion`.strip
                    # sw_vers returns something like "10.6.2". We're only
                    # interested in the first two digits (MAJOR.MINOR) since
                    # tiny releases tend to be binary compatible with each
                    # other.
                    components = os_version_string.split(".")
                    os_version = "#{components[0]}.#{components[1]}"
                    os_runtime = os_version

                    os_arch = cpu_architectures[0]
                    if os_version >= "10.5" && os_arch =~ /^i.86$/
                            # On Snow Leopard, 'uname -m' returns i386 but
                            # we *know* that everything is x86_64 by default.
                            os_arch = "x86_64"
                    end
            else
                    os_arch = cpu_architectures[0]
                    os_runtime = nil
            end

            return [os_arch, os_name, os_runtime].compact.join("-")
    end

cxx_is_clang?() click to toggle source

    # File lib/phusion_passenger/platform_info/compiler.rb, line 121
    def self.cxx_is_clang?
            `#{cxx} --version 2>&1` =~ /clang version/
    end

debugging_cflags() click to toggle source

C compiler flags that should be passed in order to enable debugging information.

    # File lib/phusion_passenger/platform_info/compiler.rb, line 305
    def self.debugging_cflags
            # According to OpenBSD's pthreads man page, pthreads do not work
            # correctly when an app is compiled with -g. It recommends using
            # -ggdb instead.
            #
            # In any case we'll always want to use -ggdb for better GDB debugging.
            if cc_is_clang? || cxx_is_clang?
                    return '-g'
            else
                    return '-ggdb'
            end
    end

dmalloc_ldflags() click to toggle source

    # File lib/phusion_passenger/platform_info/compiler.rb, line 318
    def self.dmalloc_ldflags
            if !ENV['DMALLOC_LIBS'].to_s.empty?
                    return ENV['DMALLOC_LIBS']
            end
            if RUBY_PLATFORM =~ /darwin/
                    ['/opt/local', '/usr/local', '/usr'].each do |prefix|
                            filename = "#{prefix}/lib/libdmallocthcxx.a"
                            if File.exist?(filename)
                                    return filename
                            end
                    end
                    return nil
            else
                    return "-ldmallocthcxx"
            end
    end

electric_fence_ldflags() click to toggle source

    # File lib/phusion_passenger/platform_info/compiler.rb, line 336
    def self.electric_fence_ldflags
            if RUBY_PLATFORM =~ /darwin/
                    ['/opt/local', '/usr/local', '/usr'].each do |prefix|
                            filename = "#{prefix}/lib/libefence.a"
                            if File.exist?(filename)
                                    return filename
                            end
                    end
                    return nil
            else
                    return "-lefence"
            end
    end

env_defined?(name) click to toggle source

    # File lib/phusion_passenger/platform_info.rb, line 207
    def self.env_defined?(name)
            return !ENV[name].nil? && !ENV[name].empty?
    end

export_dynamic_flags() click to toggle source

    # File lib/phusion_passenger/platform_info/compiler.rb, line 351
    def self.export_dynamic_flags
            if RUBY_PLATFORM =~ /linux/
                    return '-rdynamic'
            else
                    return nil
            end
    end

find_all_commands(name) click to toggle source

    # File lib/phusion_passenger/platform_info.rb, line 360
    def self.find_all_commands(name)
            search_dirs = ENV['PATH'].to_s.split(File::PATH_SEPARATOR)
            search_dirs.concat(%(/bin /sbin /usr/bin /usr/sbin /usr/local/bin /usr/local/sbin))
            ["/opt/*/bin", "/usr/local/*/bin"].each do |glob|
                    search_dirs.concat(Dir[glob])
            end
            search_dirs.delete("")
            search_dirs.uniq!

            result = []
            search_dirs.each do |directory|
                    path = File.join(directory, name)
                    if !File.exist?(path)
                            log "Looking for #{path}: not found"
                    elsif !File.file?(path)
                            log "Looking for #{path}: found, but is not a file"
                    elsif !File.executable?(path)
                            log "Looking for #{path}: found, but is not executable"
                    else
                            log "Looking for #{path}: found"
                            result << path
                    end
            end
            return result
    end

find_apache2_executable(*possible_names) click to toggle source

Find an executable in the Apache 'bin' and 'sbin' directories. Returns nil if not found.

    # File lib/phusion_passenger/platform_info/apache.rb, line 330
    def self.find_apache2_executable(*possible_names)
            if possible_names.last.is_a?(Hash)
                    options = possible_names.pop
                    options = nil if options.empty?
            end

            if options
                    dirs = options[:dirs] || [apache2_bindir(options), apache2_sbindir(options)]
            else
                    dirs = [apache2_bindir, apache2_sbindir]
            end

            dirs.each do |bindir|
                    if bindir.nil?
                            next
                    end
                    possible_names.each do |name|
                            filename = "#{bindir}/#{name}"
                            if !File.exist?(filename)
                                    log "Looking for #{filename}: not found"
                            elsif !File.file?(filename)
                                    log "Looking for #{filename}: found, but is not a file"
                            elsif !File.executable?(filename)
                                    log "Looking for #{filename}: found, but is not executable"
                            else
                                    log "Looking for #{filename}: found"
                                    return filename
                            end
                    end
            end
            return nil
    end

find_command(name, is_executable = true) click to toggle source

Check whether the specified command is in $PATH, and return its absolute filename. Returns nil if the command is not found.

This function exists because system('which') doesn't always behave correctly, for some weird reason.

When `is_executable` is true, this function checks whether there is an executable named `name` in $PATH. When false, it assumes that `name` is not an executable name but a command string (e.g. "ccache gcc"). It then infers the executable name ("ccache") from the command string, and checks for that instead.

    # File lib/phusion_passenger/platform_info.rb, line 337
    def self.find_command(name, is_executable = true)
            name = name.to_s
            if !is_executable && name =~ / /
                    name = name.sub(/ .*/, '')
            end
            if name =~ /^\//
                    if File.executable?(name)
                            return name
                    else
                            return nil
                    end
            else
                    ENV['PATH'].to_s.split(File::PATH_SEPARATOR).each do |directory|
                            next if directory.empty?
                            path = File.join(directory, name)
                            if File.file?(path) && File.executable?(path)
                                    return path
                            end
                    end
                    return nil
            end
    end

find_header(header_name, language, flags = nil) click to toggle source

Looks for the given C or C++ header. This works by invoking the compiler and searching in the compiler's header search path. Returns its full filename, or true if this function knows that the header exists but can't find it (e.g. because the compiler cannot tell us what its header search path is). Returns nil if the header cannot be found.

    # File lib/phusion_passenger/platform_info/compiler.rb, line 132
    def self.find_header(header_name, language, flags = nil)
            extension = detect_language_extension(language)
            create_temp_file("passenger-compile-check.#{extension}") do |filename, f|
                    source = %{
                            #include <#{header_name}>
                    }
                    f.puts(source)
                    f.close
                    begin
                            command = create_compiler_command(language,
                                    "-v -c '#{filename}' -o '#{filename}.o'",
                                    flags)
                            if result = run_compiler("Checking for #{header_name}", command, filename, source, true)
                                    result[:output] =~ /^#include <...> search starts here:$(.+?)^End of search list\.$/
                                    search_paths = $1.to_s.strip.split("\n").map{ |line| line.strip }
                                    search_paths.each do |dir|
                                            if File.file?("#{dir}/#{header_name}")
                                                    return "#{dir}/#{header_name}"
                                            end
                                    end
                                    return true
                            else
                                    return nil
                            end
                    ensure
                            File.unlink("#{filename}.o") rescue nil
                    end
            end
    end

gem_command() click to toggle source

Returns the correct 'gem' command for this Ruby interpreter.

    # File lib/phusion_passenger/platform_info/ruby.rb, line 142
    def self.gem_command
            return locate_ruby_tool('gem')
    end

gnu_make() click to toggle source

    # File lib/phusion_passenger/platform_info/compiler.rb, line 365
    def self.gnu_make
            if result = string_env('GMAKE')
                    return result
            else
                    result = find_command('gmake')
                    if !result
                            result = find_command('make')
                            if result
                                    if `#{result} --version 2>&1` =~ /GNU/
                                            return result
                                    else
                                            return nil
                                    end
                            else
                                    return nil
                            end
                    else
                            return result
                    end
            end
    end

has_alloca_h?() click to toggle source

    # File lib/phusion_passenger/platform_info/compiler.rb, line 298
    def self.has_alloca_h?
            return try_compile("Checking for alloca.h",
                    :c, '#include <alloca.h>')
    end

has_math_library?() click to toggle source

    # File lib/phusion_passenger/platform_info/compiler.rb, line 292
    def self.has_math_library?
            return try_link("Checking for -lmath support",
                    :c, "int main() { return 0; }\n", '-lmath')
    end

httpd(options = {}) click to toggle source

The absolute path to the Apache binary (that is, 'httpd', 'httpd2', 'apache' or 'apache2'), or nil if not found.

    # File lib/phusion_passenger/platform_info/apache.rb, line 67
    def self.httpd(options = {})
            apxs2 = options[:apxs2] || self.apxs2
            if env_defined?('HTTPD')
                    return ENV['HTTPD']
            elsif apxs2.nil?
                    ["apache2", "httpd2", "apache", "httpd"].each do |name|
                            command = find_command(name)
                            if !command.nil?
                                    return command
                            end
                    end
                    return nil
            else
                    return find_apache2_executable(`#{apxs2} -q TARGET`.strip, options)
            end
    end

httpd_actual_error_log(options = nil) click to toggle source

    # File lib/phusion_passenger/platform_info/apache.rb, line 159
    def self.httpd_actual_error_log(options = nil)
            if config_file = httpd_default_config_file(options)
                    contents = File.read(config_file)
                    # We don't want to match comments
                    contents.gsub!(/^[ \t]*#.*/, '')
                    if contents =~ /^ErrorLog (.+)$/
                            filename = $1.strip.sub(/^"/, '').sub(/"$/, '')
                            if filename.include?("${")
                                    log "Error log seems to be located in \"#{filename}\", " +
                                            "but value contains environment variables. " +
                                            "Attempting to substitute them..."
                            end
                            # The Apache config file supports environment variable
                            # substitution. Ubuntu uses this extensively.
                            filename.gsub!(/\$\{(.+?)\}/) do |varname|
                                    if value = httpd_infer_envvar($1, options)
                                            log "Substituted \"#{varname}\" -> \"#{value}\""
                                            value
                                    else
                                            log "Cannot substituted \"#{varname}\""
                                            varname
                                    end
                            end
                            if filename.include?("${")
                                    # We couldn't substitute everything.
                                    return nil
                            else
                                    return filename
                            end
                    elsif contents =~ /ErrorLog/
                            # The user apparently has ErrorLog set somewhere but
                            # we can't parse it. The default error log location,
                            # as reported by `httpd -V`, may be wrong (it is on OS X).
                            # So to be safe, let's assume that we don't know.
                            return nil
                    else
                            return httpd_default_error_log(options)
                    end
            else
                    return nil
            end
    end

httpd_default_config_file(options = nil) click to toggle source

The default Apache configuration file, or nil if Apache is not found.

    # File lib/phusion_passenger/platform_info/apache.rb, line 113
    def self.httpd_default_config_file(options = nil)
            if info = httpd_V(options)
                    info =~ /-D SERVER_CONFIG_FILE="(.+)"$/
                    filename = $1
                    if filename =~ /\A\//
                            return filename
                    else
                            # Not an absolute path. Infer from root.
                            if root = httpd_root(options)
                                    return "#{root}/#{filename}"
                            else
                                    return nil
                            end
                    end
            else
                    return nil
            end
    end

httpd_default_error_log(options = nil) click to toggle source

The default Apache error log's filename, as it is compiled into the Apache main executable. This may not be the actual error log that is used. The actual error log depends on the configuration file.

Returns nil if Apache is not detected, or if the default error log filename cannot be detected.

    # File lib/phusion_passenger/platform_info/apache.rb, line 139
    def self.httpd_default_error_log(options = nil)
            if info = httpd_V(options)
                    info =~ /-D DEFAULT_ERRORLOG="(.+)"$/
                    filename = $1
                    if filename =~ /\A\//
                            return filename
                    else
                            # Not an absolute path. Infer from root.
                            if root = httpd_root(options)
                                    return "#{root}/#{filename}"
                            else
                                    return nil
                            end
                    end
            else
                    return nil
            end
    end

httpd_envvars_file(options = nil) click to toggle source

The location of the Apache envvars file, which exists on some systems such as Ubuntu. Returns nil if Apache is not found or if the envvars file is not found.

    # File lib/phusion_passenger/platform_info/apache.rb, line 205
    def self.httpd_envvars_file(options = nil)
            if options
                    httpd = options[:httpd] || self.httpd(options)
            else
                    httpd = self.httpd
            end

            httpd_dir = File.dirname(httpd)
            if httpd_dir == "/usr/bin" || httpd_dir == "/usr/sbin"
                    if File.exist?("/etc/apache2/envvars")
                            return "/etc/apache2/envvars"
                    elsif File.exist?("/etc/httpd/envvars")
                            return "/etc/httpd/envvars"
                    end
            end

            conf_dir = File.expand_path(File.dirname(httpd) + "/../conf")
            if File.exist?("#{conf_dir}/envvars")
                    return "#{conf_dir}/envvars"
            end

            return nil
    end

httpd_infer_envvar(varname, options = nil) click to toggle source

    # File lib/phusion_passenger/platform_info/apache.rb, line 229
    def self.httpd_infer_envvar(varname, options = nil)
            if envfile = httpd_envvars_file(options)
                    result = `. '#{envfile}' && echo $#{varname}`.strip
                    if $? && $?.exitstatus == 0
                            return result
                    else
                            return nil
                    end
            else
                    return nil
            end
    end

httpd_root(options = nil) click to toggle source

The Apache root directory.

    # File lib/phusion_passenger/platform_info/apache.rb, line 102
    def self.httpd_root(options = nil)
            if info = httpd_V(options)
                    info =~ / -D HTTPD_ROOT="(.+)"$/
                    return $1
            else
                    return nil
            end
    end

httpd_supports_a2enmod?(options = nil) click to toggle source

Whether Apache appears to support a2enmod and a2dismod.

    # File lib/phusion_passenger/platform_info/apache.rb, line 243
    def self.httpd_supports_a2enmod?(options = nil)
            config_file = httpd_default_config_file(options)
            if config_file
                    config_dir = File.dirname(config_file)
                    return File.exist?("#{config_dir}/mods-available") &&
                            File.exist?("#{config_dir}/mods-enabled")
            else
                    return nil
            end
    end

httpd_version(options = nil) click to toggle source

The Apache version, or nil if Apache is not found.

    # File lib/phusion_passenger/platform_info/apache.rb, line 86
    def self.httpd_version(options = nil)
            if options
                    httpd = options[:httpd] || self.httpd(options)
            else
                    httpd = self.httpd
            end
            if httpd
                    `#{httpd} -v` =~ %{Apache/([\d\.]+)}
                    return $1
            else
                    return nil
            end
    end

in_rvm?() click to toggle source

Returns whether the current Ruby interpreter is managed by RVM.

    # File lib/phusion_passenger/platform_info/ruby.rb, line 186
    def self.in_rvm?
            bindir = rb_config['bindir']
            return bindir.include?('/.rvm/') || bindir.include?('/rvm/')
    end

library_extension() click to toggle source

The current platform's shared library extension ('so' on most Unices).

    # File lib/phusion_passenger/platform_info/operating_system.rb, line 42
    def self.library_extension
            if RUBY_PLATFORM =~ /darwin/
                    return "bundle"
            else
                    return "so"
            end
    end

linux_distro() click to toggle source

An identifier for the current Linux distribution. nil if the operating system is not Linux.

    # File lib/phusion_passenger/platform_info/linux.rb, line 30
    def self.linux_distro
            tags = linux_distro_tags
            if tags
                    return tags.first
            else
                    return nil
            end
    end

linux_distro_tags() click to toggle source

Autodetects the current Linux distribution and return a number of identifier tags. The first tag identifies the distribution while the other tags indicate which distributions it is likely compatible with. Returns nil if the operating system is not Linux.

    # File lib/phusion_passenger/platform_info/linux.rb, line 43
    def self.linux_distro_tags
            if RUBY_PLATFORM !~ /linux/
                    return nil
            end
            lsb_release = read_file("/etc/lsb-release")
            if lsb_release =~ /Ubuntu/
                    return [:ubuntu, :debian]
            elsif File.exist?("/etc/debian_version")
                    return [:debian]
            elsif File.exist?("/etc/redhat-release")
                    redhat_release = read_file("/etc/redhat-release")
                    if redhat_release =~ /CentOS/
                            return [:centos, :redhat]
                    elsif redhat_release =~ /Fedora/
                            return [:fedora, :redhat]
                    elsif redhat_release =~ /Mandriva/
                            return [:mandriva, :redhat]
                    else
                            # On official RHEL distros, the content is in the form of
                            # "Red Hat Enterprise Linux Server release 5.1 (Tikanga)"
                            return [:rhel, :redhat]
                    end
            elsif File.exist?("/etc/system-release")
                    system_release = read_file("/etc/system-release")
                    if system_release =~ /Amazon Linux/
                            return [:amazon, :redhat]
                    else
                            return [:unknown]
                    end
            elsif File.exist?("/etc/suse-release")
                    return [:suse]
            elsif File.exist?("/etc/gentoo-release")
                    return [:gentoo]
            else
                    return [:unknown]
            end
            # TODO: Slackware
    end

locate_ruby_tool(name) click to toggle source

Locates a Ruby tool command, e.g. 'gem', 'rake', 'bundle', etc. Instead of naively looking in $PATH, this function uses a variety of search heuristics to find the command that's really associated with the current Ruby interpreter. It should never locate a command that's actually associated with a different Ruby interpreter. Returns nil when nothing's found.

    # File lib/phusion_passenger/platform_info/ruby.rb, line 314
    def self.locate_ruby_tool(name)
            result = locate_ruby_tool_by_basename(name)
            if !result
                    exeext = rb_config['EXEEXT']
                    exeext = nil if exeext.empty?
                    if exeext
                            result = locate_ruby_tool_by_basename("#{name}#{exeext}")
                    end
                    if !result
                            result = locate_ruby_tool_by_basename(transform_according_to_ruby_exec_format(name))
                    end
                    if !result && exeext
                            result = locate_ruby_tool_by_basename(transform_according_to_ruby_exec_format(name) + exeext)
                    end
            end
            return result
    end

log_implementation() click to toggle source

    # File lib/phusion_passenger/platform_info.rb, line 202
    def self.log_implementation
            return @@log_implementation
    end

log_implementation=(impl) click to toggle source

    # File lib/phusion_passenger/platform_info.rb, line 198
    def self.log_implementation=(impl)
            @@log_implementation = impl
    end

make() click to toggle source

    # File lib/phusion_passenger/platform_info/compiler.rb, line 360
    def self.make
            return string_env('MAKE', find_command('make'))
    end

os_name() click to toggle source

Returns the operating system's name. This name is in lowercase and contains no spaces, and thus is suitable to be used in some kind of ID. E.g. "linux", "macosx".

    # File lib/phusion_passenger/platform_info/operating_system.rb, line 32
    def self.os_name
            if rb_config['target_os'] =~ /darwin/ && (sw_vers = find_command('sw_vers'))
                    return "macosx"
            else
                    return rb_config['target_os']
            end
    end

passenger_needs_ruby_dev_header?() click to toggle source

Returns whether Phusion Passenger needs Ruby development headers to be available for the current Ruby implementation.

    # File lib/phusion_passenger/platform_info/ruby.rb, line 136
    def self.passenger_needs_ruby_dev_header?
            # Too much of a trouble for JRuby. We can do without it.
            return RUBY_ENGINE != "jruby"
    end

portability_cflags() click to toggle source

Compiler flags that should be used for compiling every C/C++ program, for portability reasons. These flags should be specified as last when invoking the compiler.

    # File lib/phusion_passenger/platform_info/cxx_portability.rb, line 34
    def self.portability_cflags
            flags = ["-D_REENTRANT -I/usr/local/include"]

            # There are too many implementations of of the hash map!
            # Figure out the right one.
            ok = try_compile("Checking for tr1/unordered_map", :cxx, %{
                    #include <tr1/unordered_map>
                    int
                    main() {
                            std::tr1::unordered_map<int, int> m;
                            return 0;
                    }
            })
            if ok
                    flags << "-DHAS_TR1_UNORDERED_MAP"
            else
                    hash_namespace = nil
                    ok = false
                    ['__gnu_cxx', '', 'std', 'stdext'].each do |namespace|
                            ['hash_map', 'ext/hash_map'].each do |hash_map_header|
                                    ok = try_compile("Checking for #{hash_map_header}", :cxx, %{
                                            #include <#{hash_map_header}>
                                            int
                                            main() {
                                                    #{namespace}::hash_map<int, int> m;
                                                    return 0;
                                            }
                                    })
                                    if ok
                                            hash_namespace = namespace
                                            flags << "-DHASH_NAMESPACE=\"#{namespace}\""
                                            flags << "-DHASH_MAP_HEADER=\"<#{hash_map_header}>\""
                                            flags << "-DHASH_MAP_CLASS=\"hash_map\""
                                    end
                                    break if ok
                            end
                            break if ok
                    end
                    ['ext/hash_fun.h', 'functional', 'tr1/functional',
                     'ext/stl_hash_fun.h', 'hash_fun.h', 'stl_hash_fun.h',
                     'stl/_hash_fun.h'].each do |hash_function_header|
                            ok = try_compile("Checking for #{hash_function_header}", :cxx, %{
                                    #include <#{hash_function_header}>
                                    int
                                    main() {
                                            #{hash_namespace}::hash<int>()(5);
                                            return 0;
                                    }
                            })
                            if ok
                                    flags << "-DHASH_FUN_H=\"<#{hash_function_header}>\""
                                    break
                            end
                    end
            end

            ok = try_compile("Checking for accept4()", :c, %{
                    #define _GNU_SOURCE
                    #include <sys/socket.h>
                    static void *foo = accept4;
            })
            flags << '-DHAVE_ACCEPT4' if ok

            if RUBY_PLATFORM =~ /solaris/
                    flags << '-pthreads'
                    if RUBY_PLATFORM =~ /solaris2.11/
                            # skip the _XOPEN_SOURCE and _XPG4_2 definitions in later versions of Solaris / OpenIndiana
                            flags << '-D__EXTENSIONS__ -D__SOLARIS__ -D_FILE_OFFSET_BITS=64'
                    else
                            flags << '-D_XOPEN_SOURCE=500 -D_XPG4_2 -D__EXTENSIONS__ -D__SOLARIS__ -D_FILE_OFFSET_BITS=64'
                            flags << '-D__SOLARIS9__ -DBOOST__STDC_CONSTANT_MACROS_DEFINED' if RUBY_PLATFORM =~ /solaris2.9/
                    end
                    flags << '-DBOOST_HAS_STDINT_H' unless RUBY_PLATFORM =~ /solaris2.9/
                    flags << '-mcpu=ultrasparc' if RUBY_PLATFORM =~ /sparc/
            elsif RUBY_PLATFORM =~ /openbsd/
                    flags << '-DBOOST_HAS_STDINT_H -D_GLIBCPP__PTHREADS'
            elsif RUBY_PLATFORM =~ /aix/
                    flags << '-pthread'
                    flags << '-DOXT_DISABLE_BACKTRACES'
            elsif RUBY_PLATFORM =~ /(sparc-linux|arm-linux|^arm.*-linux|sh4-linux)/
                    # http://code.google.com/p/phusion-passenger/issues/detail?id=200
                    # http://groups.google.com/group/phusion-passenger/t/6b904a962ee28e5c
                    # http://groups.google.com/group/phusion-passenger/browse_thread/thread/aad4bd9d8d200561
                    flags << '-DBOOST_SP_USE_PTHREADS'
            end

            flags << '-DHAS_ALLOCA_H' if has_alloca_h?
            flags << '-DHAS_SFENCE' if supports_sfence_instruction?
            flags << '-DHAS_LFENCE' if supports_lfence_instruction?

            return flags.compact.join(" ").strip
    end

portability_ldflags() click to toggle source

Linker flags that should be used for linking every C/C++ program, for portability reasons. These flags should be specified as last when invoking the linker.

    # File lib/phusion_passenger/platform_info/cxx_portability.rb, line 131
    def self.portability_ldflags
            if RUBY_PLATFORM =~ /solaris/
                    result = '-lxnet -lrt -lsocket -lnsl -lpthread'
            else
                    result = '-lpthread'
            end
            flags << ' -lmath' if has_math_library?
            return result
    end

rake() click to toggle source

Returns the absolute path to the Rake executable that belongs to the current Ruby interpreter. Returns nil if it doesn't exist.

The return value may not be the actual correct invocation for Rake. Use rake_command for that.

    # File lib/phusion_passenger/platform_info/ruby.rb, line 153
    def self.rake
            return locate_ruby_tool('rake')
    end

rake_command() click to toggle source

Returns the correct command string for invoking the Rake executable that belongs to the current Ruby interpreter. Returns nil if Rake is not found.

    # File lib/phusion_passenger/platform_info/ruby.rb, line 161
    def self.rake_command
            filename = rake
            # If the Rake executable is a Ruby program then we need to run
            # it in the correct Ruby interpreter just in case Rake doesn't
            # have the correct shebang line; we don't want a totally different
            # Ruby than the current one to be invoked.
            if filename && is_ruby_program?(filename)
                    return "#{ruby_command} #{filename}"
            else
                    # If it's not a Ruby program then it's probably a wrapper
                    # script as is the case with e.g. RVM (~/.rvm/wrappers).
                    return filename
            end
    end

rb_config() click to toggle source

    # File lib/phusion_passenger/platform_info.rb, line 318
    def self.rb_config
            if defined?(::RbConfig)
                    return ::RbConfig::CONFIG
            else
                    return ::Config::CONFIG
            end
    end

read_file(filename) click to toggle source

    # File lib/phusion_passenger/platform_info.rb, line 220
    def self.read_file(filename)
            return File.read(filename)
    rescue
            return ""
    end

requires_no_tls_direct_seg_refs?() click to toggle source

    # File lib/phusion_passenger/platform_info/operating_system.rb, line 158
    def self.requires_no_tls_direct_seg_refs?
            return File.exists?("/proc/xen/capabilities") && cpu_architectures[0] == "x86"
    end

rspec() click to toggle source

Returns the absolute path to the RSpec runner program that belongs to the current Ruby interpreter. Returns nil if it doesn't exist.

    # File lib/phusion_passenger/platform_info/ruby.rb, line 180
    def self.rspec
            return locate_ruby_tool('rspec')
    end

ruby_command() click to toggle source

Returns correct command for invoking the current Ruby interpreter. In case of RVM this function will return the path to the RVM wrapper script that executes the current Ruby interpreter in the currently active gem set.

    # File lib/phusion_passenger/platform_info/ruby.rb, line 48
    def self.ruby_command
            if in_rvm?
                    name = rvm_ruby_string
                    dirs = rvm_paths
                    if name && dirs
                            dirs.each do |dir|
                                    filename = "#{dir}/wrappers/#{name}/ruby"
                                    if File.exist?(filename)
                                            contents = File.open(filename, 'rb') do |f|
                                                    f.read
                                            end
                                            # Old wrapper scripts reference $HOME which causes
                                            # things to blow up when run by a different user.
                                            if contents.include?("$HOME")
                                                    filename = nil
                                            end
                                    else
                                            filename = nil
                                    end
                                    if filename
                                            return filename
                                    end
                            end

                            # Correctness of these commands are confirmed by mpapis.
                            # If we ever encounter a case for which this logic is not sufficient,
                            # try mpapis' pseudo code:
                            #
                            #   rvm_update_prefix  = write_to rvm_path ? "" : "rvmsudo"
                            #   rvm_gemhome_prefix  = write_to GEM_HOME ? "" : "rvmsudo"
                            #   repair_command  = "#{rvm_update_prefix} rvm get stable && rvm reload && #{rvm_gemhome_prefix} rvm repair all"
                            #   wrapper_command = "#{rvm_gemhome_prefix} rvm wrapper #{rvm_ruby_string} --no-prefix --all"
                            case rvm_installation_mode
                            when :single
                                    repair_command  = "rvm get stable && rvm reload && rvm repair all"
                                    wrapper_command = "rvm wrapper #{rvm_ruby_string} --no-prefix --all"
                            when :multi
                                    repair_command  = "rvmsudo rvm get stable && rvm reload && rvmsudo rvm repair all"
                                    wrapper_command = "rvmsudo rvm wrapper #{rvm_ruby_string} --no-prefix --all"
                            when :mixed
                                    repair_command  = "rvmsudo rvm get stable && rvm reload && rvm repair all"
                                    wrapper_command = "rvm wrapper #{rvm_ruby_string} --no-prefix --all"
                            end

                            STDERR.puts "Your RVM wrapper scripts are too old, or some " +
                                    "wrapper scripts are missing. Please update/regenerate " +
                                    "them first by running:\n\n" +
                                    "  #{repair_command}\n\n" +
                                    "If that doesn't seem to work, please run:\n\n" +
                                    "  #{wrapper_command}"
                            exit 1
                    else
                            # Something's wrong with the user's RVM installation.
                            # Raise an error so that the user knows this instead of
                            # having things fail randomly later on.
                            # 'name' is guaranteed to be non-nil because rvm_ruby_string
                            # already raises an exception on error.
                            STDERR.puts "Your RVM installation appears to be broken: the RVM " +
                                    "path cannot be found. Please fix your RVM installation " +
                                    "or contact the RVM developers for support."
                            exit 1
                    end
            else
                    return ruby_executable
            end
    end

ruby_executable() click to toggle source

Returns the full path to the current Ruby interpreter's executable file. This might not be the actual correct command to use for invoking the Ruby interpreter; use ruby_command instead.

    # File lib/phusion_passenger/platform_info/ruby.rb, line 119
    def self.ruby_executable
            @@ruby_executable ||=
                    rb_config['bindir'] + '/' + rb_config['RUBY_INSTALL_NAME'] + rb_config['EXEEXT']
    end

ruby_extension_binary_compatibility_id() click to toggle source

Returns a string that describes the current Ruby interpreter's extension binary compatibility. A Ruby extension compiled for a certain Ruby interpreter can also be loaded on a different Ruby interpreter with the same binary compatibility identifier.

The result depends on the following factors:

- Ruby engine name.

- Ruby extension version. This is not the same as the Ruby language version, which identifies language-level compatibility. This is rather about binary compatibility of extensions. MRI seems to break source compatibility between tiny releases, though patchlevel releases tend to be source and binary compatible.

- Ruby extension architecture. This is not necessarily the same as the operating system runtime architecture or the CPU architecture. For example, in case of JRuby, the extension architecture is just "java" because all extensions target the Java platform; the architecture the JVM was compiled for has no effect on compatibility. On systems with universal binaries support there may be multiple architectures. In this case the architecture is "universal" because extensions must be able to support all of the Ruby executable's architectures.

- The operating system for which the Ruby interpreter was compiled.

    # File lib/phusion_passenger/platform_info/binary_compatibility.rb, line 59
    def self.ruby_extension_binary_compatibility_id
            ruby_engine = defined?(RUBY_ENGINE) ? RUBY_ENGINE : "ruby"
            ruby_ext_version = RUBY_VERSION
            if RUBY_PLATFORM =~ /darwin/
                    if RUBY_PLATFORM =~ /universal/
                            ruby_arch = "universal"
                    else
                            # OS X <  10.8: something like:
                            #   "/opt/ruby-enterprise/bin/ruby: Mach-O 64-bit executable x86_64"
                            output = `file -L "#{ruby_executable}"`.strip
                            ruby_arch = output.sub(/.* /, '')
                            if ruby_arch == "executable"
                                    # OS X >= 10.8: something like:
                                    #   "/opt/ruby-enterprise/bin/ruby: Mach-O 64-bit executable"
                                    if output =~ /Mach-O 64-bit/
                                            ruby_arch = "x86_64"
                                    else
                                            raise "Cannot autodetect the Ruby interpreter's architecture"
                                    end
                            end
                    end
            elsif RUBY_PLATFORM == "java"
                    ruby_arch = "java"
            else
                    ruby_arch = cpu_architectures[0]
            end
            return "#{ruby_engine}-#{ruby_ext_version}-#{ruby_arch}-#{os_name}"
    end

ruby_sudo_command() click to toggle source

Returns either 'sudo' or 'rvmsudo' depending on whether the current Ruby interpreter is managed by RVM.

    # File lib/phusion_passenger/platform_info/ruby.rb, line 300
    def self.ruby_sudo_command
            if in_rvm?
                    return "rvmsudo"
            else
                    return "sudo"
            end
    end

ruby_supports_fork?() click to toggle source

Returns whether the Ruby interpreter supports process forking.

    # File lib/phusion_passenger/platform_info/ruby.rb, line 125
    def self.ruby_supports_fork?
            # MRI >= 1.9.2's respond_to? returns false for methods
            # that are not implemented.
            return Process.respond_to?(:fork) &&
                    RUBY_ENGINE != "jruby" &&
                    RUBY_ENGINE != "macruby" &&
                    rb_config['target_os'] !~ /mswin|windows|mingw/
    end

rvm_installation_mode() click to toggle source

Returns the RVM installation mode: :single - RVM is installed in single-user mode. :multi - RVM is installed in multi-user mode. :mixed - RVM is in a mixed-mode installation. nil - The current Ruby interpreter is not using RVM.

    # File lib/phusion_passenger/platform_info/ruby.rb, line 282
    def self.rvm_installation_mode
            if in_rvm?
                    if ENV['rvm_path'] =~ /\.rvm/
                            return :single
                    else
                            if GEM_HOME =~ /\.rvm/
                                    return :mixed
                            else
                                    return :multi
                            end
                    end
            else
                    return nil
            end
    end

rvm_paths() click to toggle source

If the current Ruby interpreter is managed by RVM, returns all directories in which RVM places its working files. This is usually ~/.rvm or /usr/local/rvm, but in mixed-mode installations there can be multiple such paths.

Otherwise returns nil.

    # File lib/phusion_passenger/platform_info/ruby.rb, line 197
    def self.rvm_paths
            if in_rvm?
                    result = []
                    [ENV['rvm_path'], "~/.rvm", "/usr/local/rvm"].each do |path|
                            next if path.nil?
                            path = File.expand_path(path)
                            rubies_path = File.join(path, 'rubies')
                            if File.directory?(path) && File.directory?(rubies_path)
                                    result << path
                            end
                    end
                    if result.empty?
                            # Failure to locate the RVM path is probably caused by the
                            # user customizing $rvm_path. Older RVM versions don't
                            # export $rvm_path, making us unable to detect its value.
                            STDERR.puts "Unable to locate the RVM path. Your RVM installation " +
                                    "is probably too old. Please update it with " +
                                    "'rvm get head && rvm reload && rvm repair all'."
                            exit 1
                    else
                            return result
                    end
            else
                    return nil
            end
    end

rvm_ruby_string() click to toggle source

If the current Ruby interpreter is managed by RVM, returns the RVM name which identifies the current Ruby interpreter plus the currently active gemset, e.g. something like this: "ruby-1.9.2-p0@mygemset"

Returns nil otherwise.

    # File lib/phusion_passenger/platform_info/ruby.rb, line 231
    def self.rvm_ruby_string
            if in_rvm?
                    # RVM used to export the necessary information through
                    # environment variables, but doesn't always do that anymore
                    # in the latest versions in order to fight env var pollution.
                    # Scanning $LOAD_PATH seems to be the only way to obtain
                    # the information.

                    # Getting the RVM name of the Ruby interpreter ("ruby-1.9.2")
                    # isn't so hard, we can extract it from the #ruby_executable
                    # string. Getting the gemset name is a bit harder, so let's
                    # try various strategies...

                    # $GEM_HOME usually contains the gem set name.
                    # It may be something like:
                    #   /Users/hongli/.rvm/gems/ruby-1.9.3-p392
                    # But also:
                    #   /home/bitnami/.rvm/gems/ruby-1.9.3-p385-perf@njist325/ruby/1.9.1
                    if GEM_HOME && GEM_HOME =~ %{rvm/gems/(.+)}
                            return $1.sub(/\/.*/, '')
                    end

                    # User somehow managed to nuke $GEM_HOME. Extract info
                    # from $LOAD_PATH.
                    matching_path = $LOAD_PATH.find_all do |item|
                            item.include?("rvm/gems/")
                    end
                    if matching_path
                            subpath = matching_path.to_s.gsub(/^.*rvm\/gems\//, '')
                            result = subpath.split('/').first
                            return result if result
                    end

                    # On Ruby 1.9, $LOAD_PATH does not contain any gem paths until
                    # at least one gem has been required so the above can fail.
                    # We're out of options now, we can't detect the gem set.
                    # Raise an exception so that the user knows what's going on
                    # instead of having things fail in obscure ways later.
                    STDERR.puts "Unable to autodetect the currently active RVM gem " +
                            "set name. Please contact this program's author for support."
                    exit 1
            end
            return nil
    end

string_env(name, default_value = nil) click to toggle source

    # File lib/phusion_passenger/platform_info.rb, line 211
    def self.string_env(name, default_value = nil)
            value = ENV[name]
            if value.nil? || value.empty?
                    return default_value
            else
                    return value
            end
    end

supports_lfence_instruction?() click to toggle source

Returns whether the OS's main CPU architecture supports the x86/x86_64 lfence instruction.

    # File lib/phusion_passenger/platform_info/operating_system.rb, line 145
    def self.supports_lfence_instruction?
            arch = cpu_architectures[0]
            return arch == "x86_64" || (arch == "x86" &&
                    try_compile_and_run("Checking for lfence instruction support", :c, %{
                            int
                            main() {
                                    __asm__ __volatile__ ("lfence" ::: "memory");
                                    return 0;
                            }
                    }))
    end

supports_sfence_instruction?() click to toggle source

Returns whether the OS's main CPU architecture supports the x86/x86_64 sfence instruction.

    # File lib/phusion_passenger/platform_info/operating_system.rb, line 130
    def self.supports_sfence_instruction?
            arch = cpu_architectures[0]
            return arch == "x86_64" || (arch == "x86" &&
                    try_compile_and_run("Checking for sfence instruction support", :c, %{
                            int
                            main() {
                                    __asm__ __volatile__ ("sfence" ::: "memory");
                                    return 0;
                            }
                    }))
    end

tmpdir() click to toggle source

    # File lib/phusion_passenger/platform_info.rb, line 226
    def self.tmpdir
            result = ENV['TMPDIR']
            if result && !result.empty?
                    return result.sub(/\/+\Z/, '')
            else
                    return '/tmp'
            end
    end

tmpexedir() click to toggle source

Returns the directory in which test executables should be placed. The returned directory is guaranteed to be writable and guaranteed to not be mounted with the 'noexec' option. If no such directory can be found then it will raise a PlatformInfo::RuntimeError with an appropriate error message.

    # File lib/phusion_passenger/platform_info.rb, line 241
    def self.tmpexedir
            basename = "test-exe.#{Process.pid}.#{Thread.current.object_id}"
            attempts = []

            dir = tmpdir
            filename = "#{dir}/#{basename}"
            begin
                    File.open(filename, 'w') do |f|
                            f.puts("#!/bin/sh")
                    end
                    File.chmod(0700, filename)
                    if system(filename)
                            return dir
                    else
                            attempts << { :dir => dir,
                                    :error => "This directory's filesystem is mounted with the 'noexec' option." }
                    end
            rescue Errno::ENOENT
                    attempts << { :dir => dir, :error => "This directory doesn't exist." }
            rescue Errno::EACCES
                    attempts << { :dir => dir, :error => "This program doesn't have permission to write to this directory." }
            rescue SystemCallError => e
                    attempts << { :dir => dir, :error => e.message }
            ensure
                    File.unlink(filename) rescue nil
            end

            dir = Dir.pwd
            filename = "#{dir}/#{basename}"
            begin
                    File.open(filename, 'w') do |f|
                            f.puts("#!/bin/sh")
                    end
                    File.chmod(0700, filename)
                    if system(filename)
                            return dir
                    else
                            attempts << { :dir => dir,
                                    :error => "This directory's filesystem is mounted with the 'noexec' option." }
                    end
            rescue Errno::ENOENT
                    attempts << { :dir => dir, :error => "This directory doesn't exist." }
            rescue Errno::EACCES
                    attempts << { :dir => dir, :error => "This program doesn't have permission to write to this directory." }
            rescue SystemCallError => e
                    attempts << { :dir => dir, :error => e.message }
            ensure
                    File.unlink(filename) rescue nil
            end

            message = "ERROR: Cannot find suitable temporary directory\n" +
                    "In order to run certain tests, this program " +
                    "must be able to write temporary\n" +
                    "executable files to some directory. However no such " +
                    "directory can be found. \n" +
                    "The following directories have been tried:\n\n"
            attempts.each do |attempt|
                    message << " * #{attempt[:dir]}\n"
                    message << "   #{attempt[:error]}\n"
            end
            message << "\nYou can solve this problem by telling this program what directory to write\n" <<
                    "temporary executable files to, as follows:\n" <<
                    "\n" <<
                    "  Set the $TMPDIR environment variable to the desired directory's filename and\n" <<
                    "  re-run this program.\n" <<
                    "\n" <<
                    "Notes:\n" <<
                    "\n" <<
                    " * If you're using 'sudo'/'rvmsudo', remember that 'sudo'/'rvmsudo' unsets all\n" <<
                    "   environment variables, so you must set the environment variable *after*\n" <<
                    "   having gained root privileges.\n" <<
                    " * The directory you choose must writeable and must not be mounted with the\n" <<
                    "   'noexec' option."
            raise RuntimeError, message
    end

try_compile(description, language, source, flags = nil) click to toggle source

    # File lib/phusion_passenger/platform_info/compiler.rb, line 162
    def self.try_compile(description, language, source, flags = nil)
            extension = detect_language_extension(language)
            create_temp_file("passenger-compile-check.#{extension}") do |filename, f|
                    f.puts(source)
                    f.close
                    begin
                            command = create_compiler_command(language,
                                    "-c '#{filename}' -o '#{filename}.o'",
                                    flags)
                            return run_compiler(description, command, filename, source)
                    ensure
                            File.unlink("#{filename}.o") rescue nil
                    end
            end
    end

try_compile_and_run(description, language, source, flags = nil) click to toggle source

    # File lib/phusion_passenger/platform_info/compiler.rb, line 194
    def self.try_compile_and_run(description, language, source, flags = nil)
            extension = detect_language_extension(language)
            create_temp_file("passenger-run-check.#{extension}", tmpexedir) do |filename, f|
                    f.puts(source)
                    f.close
                    begin
                            command = create_compiler_command(language,
                                    "'#{filename}' -o '#{filename}.out'",
                                    flags, true)
                            if run_compiler(description, command, filename, source)
                                    log("Running #{filename}.out")
                                    begin
                                            output = `'#{filename}.out' 2>&1`
                                    rescue SystemCallError => e
                                            log("Command failed: #{e}")
                                            return false
                                    end
                                    status = $?.exitstatus
                                    log("Command exited with status #{status}. Output:\n--------------\n#{output}\n--------------")
                                    return status == 0
                            else
                                    return false
                            end
                    ensure
                            File.unlink("#{filename}.out") rescue nil
                    end
            end
    end

try_link(description, language, source, flags = nil) click to toggle source

    # File lib/phusion_passenger/platform_info/compiler.rb, line 178
    def self.try_link(description, language, source, flags = nil)
            extension = detect_language_extension(language)
            create_temp_file("passenger-link-check.#{extension}") do |filename, f|
                    f.puts(source)
                    f.close
                    begin
                            command = create_compiler_command(language,
                                    "'#{filename}' -o '#{filename}.out'",
                                    flags, true)
                            return run_compiler(description, command, filename, source)
                    ensure
                            File.unlink("#{filename}.out") rescue nil
                    end
            end
    end

verbose=(val) click to toggle source

    # File lib/phusion_passenger/platform_info.rb, line 190
    def self.verbose=(val)
            @@verbose = val
    end

verbose?() click to toggle source

    # File lib/phusion_passenger/platform_info.rb, line 194
    def self.verbose?
            return @@verbose
    end

zlib_flags() click to toggle source

    # File lib/phusion_passenger/platform_info/zlib.rb, line 29
    def self.zlib_flags
            return nil
    end

zlib_libs() click to toggle source

    # File lib/phusion_passenger/platform_info/zlib.rb, line 33
    def self.zlib_libs
            return '-lz'
    end

[Validate]

Generated with the Darkfish Rdoc Generator 2.