This file describes how to build and install Ice for Ruby from source code on Linux and macOS. If you prefer, you can also download binary distributions for the supported platforms.
- Ruby Build Requirements
- Building the Ruby Extension
- Installing Ice for Ruby
- Configuring your Environment for Ruby
- Running the Ruby Tests
- SELinux Notes for Ruby
Ice for Ruby is expected to build and run properly on macOS and on any recent Linux distribution for x86 and x86_64, and was extensively tested using the operating systems and Ruby versions listed for our supported platforms.
Ice for Ruby supports Ruby versions 2.0 or later. You can use a source or binary installation of Ruby.
If you use an RPM installation, the following packages are required:
- ruby
- ruby-devel
- ruby-libs (RHEL)
The instructions for compiling the Ice extension assume that you have already installed Ruby.
The build of Ice for Ruby requires that you first build Ice for C++ in the
cpp subdirectory.
From the top-level source directory, edit config/Make.rules to establish your
build configuration. The comments in the file provide more information.
Change to the Ice for Ruby source subdirectory:
cd rubyRun make to build the extension.
You can perform an automated installation with the following command:
make installThis process uses the prefix variable in ../config/Make.rules as the
installation's root directory. The subdirectory <prefix>/ruby is created as a
copy of the local ruby directory and contains the Ice for Ruby extension
library as well as Ruby source code. Using this installation method requires
that you modify your environment as described in Configuring your Environment
for Ruby below.
Another option is to copy the contents of the local ruby directory to your
Ruby installation's site_ruby directory. For example, if you installed Ruby
via RPM, you can use the steps below:
cd <Ice source directory>/ruby/ruby
sudo tar cf - * | (cd /usr/lib/ruby/site_ruby/1.8/i386-linux; tar xvf -)On x86_64 systems, change the last command to:
sudo tar cf - * | (cd /usr/lib64/ruby/site_ruby/1.8/x86_64-linux; tar xvf -)There is no need to modify your environment if you use this approach.
The Ruby interpreter must be able to locate the Ice extension. If you used the
automated installation described above, you need to define the RUBYLIB
environment variable as follows:
export RUBYLIB=/opt/Ice/ruby:$RUBYLIBThis example assumes that your Ice for Ruby installation is located in the
/opt/Ice directory.
You must also modify LD_LIBRARY_PATH or DYLD_LIBRARY_PATH to include the
directory /opt/Ice/lib:
export LD_LIBRARY_PATH=/opt/Ice/lib:$LD_LIBRARY_PATH (Linux)
export DYLD_LIBRARY_PATH=/opt/Ice/lib:$DYLD_LIBRARY_PATH (macOS)To verify that Ruby can load the Ice extension successfully, open a command
window and start the interpreter using irb.
At the prompt, enter:
require "Ice"If the interpreter responds with the value true, the Ice extension was loaded
successfully. Enter exit to quit the interpreter.
The test subdirectory contains Ruby implementations of the core Ice test
suite. Python is required to run the test suite.
The test suites require that the Ice for C++ tests be built in the cpp
subdirectory of this source distribution.
Open a command window and change to the top-level directory. At the command prompt, execute:
python allTests.pyYou can also run tests individually by changing to the test directory and running this command:
python run.pyIf everything worked out, you should see lots of ok messages. In case of a
failure, the tests abort with failed.
If SELinux is enabled on your RHEL system, you may encounter this error message when Ruby attempts to load the Ice extension:
cannot restore segment prot after reloc: Permission deniedThere are two ways to solve this problem:
- Change the default security context for the Ice extension using the following command:
chcon -t texrel_shlib_t /opt/Ice/ruby/IceRuby.soReplace /opt/Ice with your installation directory.
- Disable SELinux completely by adding the following line to your
/etc/sysconfig/selinuxfile:
SELINUX=disabled