Skip to content

Latest commit

 

History

History
219 lines (149 loc) · 8.86 KB

macos.md

File metadata and controls

219 lines (149 loc) · 8.86 KB
Raw

Machine Learning Build Machine Setup for macOS

To ensure everything is consistent for redistributable builds we build all redistributable components from source.

NOTE: if you upgrade macOS then Xcode may need to be re-installed. Please ensure your Xcode is still valid after upgrades.

You will need the following environment variables to be defined:

  • JAVA_HOME - Should point to the JDK you want to use to run Gradle.
  • CPP_SRC_HOME - Only required if building the C++ code directly using make, as Gradle sets it automatically.
  • PATH - Must have /usr/local/bin before /usr/bin and /bin.

For example, you might create a .bashrc file in your home directory containing something like this:

umask 0002
export JAVA_HOME=/Library/Java/JavaVirtualMachines/jdk1.8.0_121.jdk/Contents/Home
export PATH=$JAVA_HOME/bin:/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin
# Only required if building the C++ code directly using make - adjust depending on the location of your Git clone
export CPP_SRC_HOME=$HOME/ml-cpp

Note, that bash doesn't read ~/.bashrc for login shells (which is what you get when you open a new Terminal window) - it reads ~/.bash_profile or ~/.profile so you should probably also create a .bash_profile file in your home directory which sources .bashrc.

General settings for building the tools

Most of the tools are built via a GNU "configure" script. There are some environment variables that affect the behaviour of this. Therefore, when building ANY tool on macOS, set the following environment variables:

export CPP='clang -E'
export CC=clang
export CFLAGS='-O3 -msse4.2'
export CXX='clang++ -std=c++14 -stdlib=libc++'
export CXXFLAGS='-O3 -msse4.2'
export CXXCPP='clang++ -std=c++14 -E'
export LDFLAGS=-Wl,-headerpad_max_install_names
unset CPATH
unset C_INCLUDE_PATH
unset CPLUS_INCLUDE_PATH
unset LIBRARY_PATH

The above environment variables only need to be set when building tools on macOS. They should NOT be set when compiling the Machine Learning source code (as this should pick up all settings from our Makefiles).

Xcode

The first major piece of development software to install is Apple's development environment, Xcode, which can be downloaded from http://developer.apple.com/technologies/xcode.html . You will need to register as a developer with Apple. Alternatively, you can get the latest version of Xcode from the App Store.

  • If you are using Yosemite, you must install Xcode 7.2.x
  • If you are using El Capitan, you must install Xcode 8.2.x
  • If you are using Sierra, you must install Xcode 9.2.x
  • If you are using High Sierra/Mojave, you must install Xcode 10.0.x

Older versions of Xcode are installed by dragging the app from the .dmg file to the /Applications directory on your Mac (or if you got it from the App Store it will already be in the /Applications directory). More modern versions of Xcode are distributed as a .xip file; simply double click the .xip file to expand it, then drag Xcode.app to your /Applications directory.

There are no command line tools out-of-the-box, so you'll need to install them following installation of Xcode. You can do this by running:

xcode-select --install

at the command prompt.

If you are using Mojave you must take the further step of installing the developer header files into /usr/include. Previous versions did this automatically when the command line tools were installed. Create /usr/include by installing /Library/Developer/CommandLineTools/Packages/macOS_SDK_headers_for_macOS_10.14.pkg this can be done with the command:

installer -pkg /Library/Developer/CommandLineTools/Packages/macOS_SDK_headers_for_macOS_10.14.pkg -target /

log4cxx

Download apache-log4cxx-0.10.0.tar.gz from one of the mirrors listed at http://www.apache.org/dyn/closer.cgi/logging/log4cxx/0.10.0/apache-log4cxx-0.10.0.tar.gz.

Extract it to a temporary directory, then configure the unzipped source using:

./configure --with-charset=utf-8 --with-logchar=utf-8

If you are running macOS Sierra or above this might fail due to not being able to find APR. To resolve this download the apr-1-config and apu-1-config files to a temporary directory. Remove any .txt extension that the download process might add, and add execute permissions to the apr-1-config and apu-1-config files. Then run:

./configure --with-charset=utf-8 --with-logchar=utf-8 --with-apr=$HOME/Downloads/apr-1-config --with-apr-util=$HOME/Downloads/apu-1-config

changing the locations of apr-1-config and apu-1-config as appropriate.

Next, when compiling with clang, it is necessary to make a couple of minor code alterations before building.

In src/main/include/log4cxx/helpers/simpledateformat.h on line 32 change the forward declaration of std::locale to include the header, i.e. replace:

namespace std { class locale; }

with:

#include <locale>

In src/main/cpp/stringhelper.cpp, after the last existing #include add:

#include <stdlib.h>

Note that the following 5 edits can be accomplished using these sed commands:

sed -i '' -e '152,163s/0x/(char)0x/g' src/main/cpp/locationinfo.cpp
sed -i '' -e '239,292s/0x/(char)0x/g' src/main/cpp/loggingevent.cpp
sed -i '' -e '39s/0x/(char)0x/g' src/main/cpp/objectoutputstream.cpp
sed -i '' -e '84,92s/0x/(char)0x/g' src/main/cpp/objectoutputstream.cpp
sed -i '' -e '193,214s/0x/(char)0x/g' src/test/cpp/xml/domtestcase.cpp

In src/main/cpp/locationinfo.cpp replace 0x with (char)0x on lines 152 to 163 - this can be done using the vim command:

:152,163s/0x/(char)0x/g

In src/main/cpp/loggingevent.cpp replace 0x with (char)0x on lines 239 to 292 - this can be done using the vim command:

:239,292s/0x/(char)0x/g

In src/main/cpp/objectoutputstream.cpp replace 0x with (char)0x on lines 39 and 84 to 92 - this can be done using the vim commands:

:39s/0x/(char)0x/g
:84,92s/0x/(char)0x/g

In src/test/cpp/xml/domtestcase.cpp replace 0x with (char)0x on lines 193 to 214 - this can be done using the vim command:

:193,214s/0x/(char)0x/g

Once these edits are done, complete the build using:

make
sudo make install
cd /usr/local/lib
sudo install_name_tool -id "@rpath/liblog4cxx.10.dylib" liblog4cxx.10.dylib

Boost 1.65.1

Download version 1.65.1 of Boost from http://sourceforge.net/projects/boost/files/boost/1.65.1/. You must get this exact version, as the Machine Learning Makefiles expect it.

Assuming you chose the .bz2 version, extract it to a temporary directory:

bzip2 -cd boost_1_65_1.tar.bz2 | tar xvf -

In the resulting boost_1_65_1 directory, run:

./bootstrap.sh --with-toolset=clang --without-libraries=context --without-libraries=coroutine --without-libraries=graph_parallel --without-libraries=log --without-libraries=mpi --without-libraries=python --without-icu

This should build the b2 program, which in turn is used to build Boost.

Edit boost/unordered/detail/implementation.hpp and change line 270 from:

    (17ul)(29ul)(37ul)(53ul)(67ul)(79ul) \

to:

    (3ul)(17ul)(29ul)(37ul)(53ul)(67ul)(79ul) \

To complete the build, type:

./b2 -j8 --layout=versioned --disable-icu cxxflags="-std=c++14 -stdlib=libc++" linkflags="-std=c++14 -stdlib=libc++ -Wl,-headerpad_max_install_names" optimization=speed inlining=full define=BOOST_MATH_NO_LONG_DOUBLE_MATH_FUNCTIONS
sudo ./b2 install --layout=versioned --disable-icu cxxflags="-std=c++14 -stdlib=libc++" linkflags="-std=c++14 -stdlib=libc++ -Wl,-headerpad_max_install_names" optimization=speed inlining=full define=BOOST_MATH_NO_LONG_DOUBLE_MATH_FUNCTIONS
cd /usr/local/lib
for FILE in libboost*1_65_1.dylib ; do sudo install_name_tool -id "@rpath/$FILE" $FILE ; done
sudo install_name_tool -change libboost_system-clang-darwin42-mt-1_65_1.dylib "@rpath/libboost_system-clang-darwin42-mt-1_65_1.dylib" -add_rpath "@loader_path/../lib" libboost_filesystem-clang-darwin42-mt-1_65_1.dylib
sudo install_name_tool -change libboost_system-clang-darwin42-mt-1_65_1.dylib "@rpath/libboost_system-clang-darwin42-mt-1_65_1.dylib" -add_rpath "@loader_path/../lib" libboost_thread-clang-darwin42-mt-1_65_1.dylib

to install the Boost headers and libraries.

cppunit

Download the latest version of cppunit from http://dev-www.libreoffice.org/src/cppunit-1.13.2.tar.gz (or if that no longer exists by the time you read this, find the relevant link on http://dev-www.libreoffice.org/src).

Assuming you get cppunit-1.13.2.tar.bz2, extract it using the commands:

bzip2 -cd cppunit-1.13.2.tar.bz2 | tar xvf -

In the resulting cppunit-1.13.2 directory, run the:

./configure

script. This should build an appropriate Makefile. Assuming it does, type:

make
sudo make install

to install the cppunit headers, libraries, binaries and documentation.