module PhusionPassenger::PlatformInfo

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

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

Constants

GEM_HOME
RUBY_ENGINE

Public Class Methods

apache2_bindir() 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 151
def self.apache2_bindir
        if apxs2.nil?
                return nil
        else
                return %x#{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 175
def self.apache2_module_cflags(with_apr_flags = true)
        flags = ["-fPIC"]
        if compiler_supports_visibility_flag?
                flags << "-fvisibility=hidden -DVISIBILITY_ATTRIBUTE_SUPPORTED"
                if compiler_visibility_flag_generates_warnings? && compiler_supports_wno_attributes_flag?
                        flags << "-Wno-attributes"
                end
        end
        if with_apr_flags
                flags << apr_flags
                flags << apu_flags
        end
        if !apxs2.nil?
                apxs2_flags = %x#{apxs2} -q CFLAGS`.strip << " -I" << %x#{apxs2} -q INCLUDEDIR`.strip
                apxs2_flags.gsub!(%r-O\d? /, '')

                # Remove flags not supported by GCC
                if RUBY_PLATFORM =~ %rsolaris/ # 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 =~ %r^\-x/ }
                        options.reject! { |f| f =~ %r^\-Xa/ }
                        options.reject! { |f| f =~ %r^\-fast/ }
                        options.reject! { |f| f =~ %r^\-mt/ }
                        apxs2_flags = options.join(' ')
                end
                
                apxs2_flags.strip!
                flags << apxs2_flags
        end
        if !httpd.nil? && RUBY_PLATFORM =~ %rdarwin/
                # 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 = %xfile "#{httpd}"`.strip
                if output =~ %rMach-O fat file/ && output !~ %rfor architecture/
                        architectures = ["i386", "ppc", "x86_64", "ppc64"]
                else
                        architectures = []
                        output.split("\n").grep(%rfor architecture/).each do |line|
                                line =~ %rfor 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 252
def self.apache2_module_ldflags
        flags = "-fPIC #{apr_libs} #{apu_libs}"
        flags.strip!
        return flags
end
apache2_sbindir() 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 161
def self.apache2_sbindir
        if apxs2.nil?
                return nil
        else
                return %x#{apxs2} -q SBINDIR`.strip
        end
end
apache2ctl() 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
        return find_apache2_executable('apache2ctl', 'apachectl2', 'apachectl')
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 97
def self.apr_config
        if env_defined?('APR_CONFIG')
                return ENV['APR_CONFIG']
        elsif apxs2.nil?
                return nil
        else
                filename = %x#{apxs2} -q APR_CONFIG 2>/dev/null`.strip
                if filename.empty?
                        apr_bindir = %x#{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 287
def self.apr_config_needed_for_building_apache_modules?
        filename = File.join("#{tmpexedir}/passenger-platform-check-#{Process.pid}.c")
        File.open(filename, "w") do |f|
                f.puts("#include <apr.h>")
        end
        begin
                return !system("(gcc #{apache2_module_cflags(false)} -c '#{filename}' -o '#{filename}.o') >/dev/null 2>/dev/null")
        ensure
                File.unlink(filename) rescue nil
                File.unlink("#{filename}.o") rescue nil
        end
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 260
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 265
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 123
def self.apu_config
        if env_defined?('APU_CONFIG')
                return ENV['APU_CONFIG']
        elsif apxs2.nil?
                return nil
        else
                filename = %x#{apxs2} -q APU_CONFIG 2>/dev/null`.strip
                if filename.empty?
                        apu_bindir = %x#{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 270
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 275
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
cc() click to toggle source
# File lib/phusion_passenger/platform_info.rb, line 250
def self.cc
        return ENV['CC'] || "gcc"
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 50
def self.compiler_supports_architecture?(arch)
        return try_compile(:c, '', "-arch #{arch}")
end
compiler_supports_no_tls_direct_seg_refs_option?() click to toggle source
# File lib/phusion_passenger/platform_info/compiler.rb, line 70
def self.compiler_supports_no_tls_direct_seg_refs_option?
        return try_compile(:c, '', '-mno-tls-direct-seg-refs')
end
compiler_supports_visibility_flag?() click to toggle source
# File lib/phusion_passenger/platform_info/compiler.rb, line 54
def self.compiler_supports_visibility_flag?
        return false if RUBY_PLATFORM =~ %raix/
        return try_compile(:c, '', '-fvisibility=hidden')
end
compiler_supports_wno_attributes_flag?() click to toggle source
# File lib/phusion_passenger/platform_info/compiler.rb, line 60
def self.compiler_supports_wno_attributes_flag?
        return try_compile(:c, '', '-Wno-attributes')
end
compiler_supports_wno_missing_field_initializers_flag?() click to toggle source
# File lib/phusion_passenger/platform_info/compiler.rb, line 65
def self.compiler_supports_wno_missing_field_initializers_flag?
        return try_compile(: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 81
def self.compiler_visibility_flag_generates_warnings?
        if RUBY_PLATFORM =~ %rlinux/ && %x#{cxx} -v 2>&1` =~ %rgcc 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 = %xuname -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 = %xsw_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 = %xuname -p`.strip
                # On some systems 'uname -p' returns something like
                # 'Intel(R) Pentium(R) M processor 1400MHz'.
                if arch == "unknown" || arch =~ %r /
                        arch = %xuname -m`.strip
                end
                if arch =~ %r^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 = %x(curl-config --cflags) 2>/dev/null`.strip
        if result.empty?
                return nil
        else
                version = %xcurl-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 = %x(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 = %x(curl-config --feature) 2>/dev/null`
        return features =~ %rSSL/
end
cxx() click to toggle source
# File lib/phusion_passenger/platform_info.rb, line 254
def self.cxx
        return ENV['CXX'] || "g++"
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 191
def self.debugging_cflags
        if RUBY_PLATFORM =~ %ropenbsd/
                # According to OpenBSD's pthreads man page, pthreads do not work
                # correctly when an app is compiled with -g. It recommends using
                # -ggdb instead.
                return '-ggdb'
        else
                return '-g'
        end
end
env_defined?(name) click to toggle source
# File lib/phusion_passenger/platform_info.rb, line 159
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 202
def self.export_dynamic_flags
        if RUBY_PLATFORM =~ %rlinux/
                return '-rdynamic'
        else
                return nil
        end
end
find_command(name) 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.

# File lib/phusion_passenger/platform_info.rb, line 148
def self.find_command(name)
        name = name.to_s
        ENV['PATH'].to_s.split(File::PATH_SEPARATOR).detect do |directory|
                path = File.join(directory, name)
                if File.file?(path) && File.executable?(path)
                        return path
                end
        end
        return nil
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 110
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 30
def self.gnu_make
        gmake = find_command('gmake')
        if !gmake
                gmake = find_command('make')
                if gmake
                        if %x#{gmake} --version 2>&1` =~ %rGNU/
                                return gmake
                        else
                                return nil
                        end
                else
                        return nil
                end
        else
                return gmake
        end
end
has_alloca_h?() click to toggle source
# File lib/phusion_passenger/platform_info/compiler.rb, line 95
def self.has_alloca_h?
        return try_compile(:c, '#include <alloca.h>')
end
has_math_library?() click to toggle source
# File lib/phusion_passenger/platform_info/compiler.rb, line 90
def self.has_math_library?
        return try_link(:c, "int main() { return 0; }\n", '-lmath')
end
httpd() 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
        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(%x#{apxs2} -q TARGET`.strip)
        end
end
httpd_version() click to toggle source

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

# File lib/phusion_passenger/platform_info/apache.rb, line 85
def self.httpd_version
        if httpd
                %x#{httpd} -v` =~ %r{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 154
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 =~ %rdarwin/
                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 !~ %rlinux/
                return nil
        end
        lsb_release = read_file("/etc/lsb-release")
        if lsb_release =~ %rUbuntu/
                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 =~ %rCentOS/
                        return [:centos, :redhat]
                elsif redhat_release =~ %rFedora/
                        return [:fedora, :redhat]
                elsif redhat_release =~ %rMandriva/
                        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/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 247
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
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'] =~ %rdarwin/ && (sw_vers = find_command('sw_vers'))
                return "macosx"
        else
                return RUBY_PLATFORM.sub(%r.*?-/, '')
        end
end
passenger_binary_compatibility_id() click to toggle source

Returns an identifier string that describes the current platform's binary compatibility with regard to Phusion Passenger binaries, both the Ruby extension and the C++ binaries. Two systems with the same binary compatibility identifiers are able to run the same Phusion Passenger binaries.

The the string depends on the following factors:

  • The Ruby extension binary compatibility identifiers.

  • 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 Phusion Passenger's C++ components.

  • 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 103
def self.passenger_binary_compatibility_id
        ruby_engine, ruby_ext_version, ruby_arch, os_name =
                ruby_extension_binary_compatibility_ids
        
        if os_name == "macosx"
                # RUBY_PLATFORM gives us the kernel version, but we want
                # the OS X version.
                os_version_string = %xsw_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 =~ %r^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]
                
                cpp = find_command('cpp')
                if cpp
                        macros = %x#{cpp} -dM < /dev/null`
                        
                        # Can be something like "4.3.2"
                        # or "4.2.1 20070719 (FreeBSD)"
                        macros =~ %r__VERSION__ "(.+)"/
                        compiler_version = $1
                        compiler_version.gsub!(%r .*/, '') if compiler_version
                        
                        macros =~ %r__GXX_ABI_VERSION (.+)$/
                        cxx_abi_version = $1
                else
                        compiler_version = nil
                        cxx_abi_version = nil
                end
                
                if compiler_version && cxx_abi_version
                        os_runtime = "gcc#{compiler_version}-#{cxx_abi_version}"
                else
                        os_runtime = [compiler_version, cxx_abi_version].compact.join("-")
                        if os_runtime.empty?
                                os_runtime = %xuname -r`.strip
                        end
                end
        end
        
        if ruby_engine == "jruby"
                # For JRuby it's kinda useless to prepend "java" as extension
                # architecture because JRuby doesn't allow any other extension
                # architecture.
                identifier = ""
        else
                identifier = "#{ruby_arch}-"
        end
        identifier << "#{ruby_engine}#{ruby_ext_version}-"
        # If the extension architecture is the same as the OS architecture
        # then there's no need to specify it twice.
        if ruby_arch != os_arch
                identifier << "#{os_arch}-"
        end
        identifier << "#{os_name}-#{os_runtime}"
        return identifier
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/compiler.rb, line 103
def self.portability_cflags
        flags = ["-D_REENTRANT -I/usr/local/include"]
        
        # Google SparseHash flags.
        # Figure out header for hash function object and its namespace.
        # Based on stl_hash.m4 and stl_hash_fun.m4 in the Google SparseHash sources.
        hash_namespace = nil
        ok = false
        ['__gnu_cxx', '', 'std', 'stdext'].each do |namespace|
                ['ext/hash_map', 'hash_map'].each do |hash_map_header|
                        ok = try_compile(:cxx, %Q{
                                #include <#{hash_map_header}>
                                int
                                main() {
                                        #{namespace}::hash_map<int, int> m;
                                        return 0;
                                }
                        })
                        if ok
                                hash_namespace = namespace
                                flags << "-DHASH_NAMESPACE=\"#{namespace}\""
                        end
                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(:cxx, %Q{
                        #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
        
        if RUBY_PLATFORM =~ %rsolaris/
                flags << '-pthreads'
                if RUBY_PLATFORM =~ %rsolaris2.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 =~ %rsolaris2.9/
                end
                flags << '-DBOOST_HAS_STDINT_H' unless RUBY_PLATFORM =~ %rsolaris2.9/
                flags << '-mcpu=ultrasparc' if RUBY_PLATFORM =~ %rsparc/
        elsif RUBY_PLATFORM =~ %ropenbsd/
                flags << '-DBOOST_HAS_STDINT_H -D_GLIBCPP__PTHREADS'
        elsif RUBY_PLATFORM =~ %raix/
                flags << '-pthread'
                flags << '-DOXT_DISABLE_BACKTRACES'
        elsif RUBY_PLATFORM =~ %r(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/compiler.rb, line 179
def self.portability_ldflags
        if RUBY_PLATFORM =~ %rsolaris/
                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 121
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 129
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
requires_no_tls_direct_seg_refs?() click to toggle source
# File lib/phusion_passenger/platform_info/operating_system.rb, line 157
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 148
def self.rspec
        return locate_ruby_tool('spec')
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
                dir = rvm_path
                if name && 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
                        else
                                STDERR.puts "Your RVM wrapper scripts are too old. Please " +
                                        "update them first by running 'rvm get head && " +
                                        "rvm reload && rvm repair all'."
                                exit 1
                        end
                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 94
def self.ruby_executable
        @@ruby_executable ||=
                rb_config['bindir'] + '/' + rb_config['RUBY_INSTALL_NAME'] + rb_config['EXEEXT']
end
ruby_extension_binary_compatibility_ids() click to toggle source

Returns an array of identifiers that describe 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 identifiers.

The identifiers depend 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_ids
        ruby_engine = defined?(RUBY_ENGINE) ? RUBY_ENGINE : "ruby"
        ruby_ext_version = RUBY_VERSION
        if RUBY_PLATFORM =~ %rdarwin/
                if RUBY_PLATFORM =~ %runiversal/
                        ruby_arch = "universal"
                else
                        # Something like:
                        # "/opt/ruby-enterprise/bin/ruby: Mach-O 64-bit executable x86_64"
                        ruby_arch = %xfile -L "#{ruby_executable}"`.strip
                        ruby_arch.sub!(%r.* /, '')
                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 233
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 100
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'] !~ %rmswin|windows|mingw/
end
rvm_path() click to toggle source

If the current Ruby interpreter is managed by RVM, returns the directory in which RVM places its working files. Otherwise returns nil.

# File lib/phusion_passenger/platform_info/ruby.rb, line 162
def self.rvm_path
        if in_rvm?
                [ENV['rvm_path'], "~/.rvm", "/usr/local/rvm"].each do |path|
                        next if path.nil?
                        path = File.expand_path(path)
                        script_path = File.join(path, 'scripts', 'rvm')
                        return path if File.directory?(path) && File.exist?(script_path)
                end
                # 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 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: "mygemset at ruby-1.9.2-p0"

Returns nil otherwise.

# File lib/phusion_passenger/platform_info/ruby.rb, line 189
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.
                if GEM_HOME && GEM_HOME.include?("rvm/gems/")
                        return File.basename(GEM_HOME)
                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(%r^.*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
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 144
def self.supports_lfence_instruction?
        arch = cpu_architectures[0]
        return arch == "x86_64" || (arch == "x86" &&
                try_compile_and_run(:c, %Q{
                        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 129
def self.supports_sfence_instruction?
        arch = cpu_architectures[0]
        return arch == "x86_64" || (arch == "x86" &&
                try_compile_and_run(:c, %Q{
                        int
                        main() {
                                __asm__ __volatile__ ("sfence" ::: "memory");
                                return 0;
                        }
                }))
end
tmpdir() click to toggle source
# File lib/phusion_passenger/platform_info.rb, line 163
def self.tmpdir
        result = ENV['TMPDIR']
        if result && !result.empty?
                return result.sub(%r\/+\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 178
def self.tmpexedir
        basename = "test-exe.#{Process.pid}.#{Thread.current.object_id}"
        attempts = []
        
        dir = tmpdir
        filename = "#{dir}/#{basename}"
        begin
                File.open(filename, 'w').close
                File.chmod(0700, filename)
                if File.executable?(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').close
                File.chmod(0700, filename)
                if File.executable?(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 = "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.\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
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