mcserep
commented
1 year ago :warning: Temporary fix: not including the prctl.h when compiling on macOS and omitting the behaviour described below. While it is useful, it is not crucial and parsing should basically work without it.
:exclamation: Issue: The functionality described by prctl.h in Linux does not exist on macOS.
This is used by the searchparser, so that if the parent process stops, the process running Lucene will also stop with it.
Compilation failure:
/Users/mate/Documents/Repos/CodeCompass/util/src/pipedprocess.cpp:6:10: fatal error: 'sys/prctl.h' file not found
#include <sys/prctl.h>
^~~~~~~~~~~~~
1 error generated.
Build Guide on macOS
Tested on:
In contrast to the official guide of the project, we will use not GNU, but Clang to build CodeCompass and - most of - its dependencies. It is crucial to build them with the same compiler, otherwise if you are lucky, then you will get link-time unresolved symbol errors. If you are unlucky, then you will get runtime crashes and only in certain situations.
Since we would like to install as many dependencies from HomeBrew, as possible, and they were compiled with Clang (e.g. the Boost Library), we also use Clang.
Apple macOs comes with Clang (installation of XCode could be required), at the time of writing this guide, with v15. It is important to note, that the standard
gccandg++binaries are linked to Clang instead as well.Install HomeBrew:
Install available dependencies from HomeBrew:
Note: the
gnu-sedandcoreutilspackages are required by GNU Bash scripts in CodeCompss.gnu-sedis required for expected GNU sed usage inwebgui-new/thrift-codegen.sh, for building the new web GUI.coreutilsis required for downloading and installing the latest Build2 byscripts/install_latest_build2.sh(e.g. commandsnprocandsha256sum).Download and install OpenJDK. At the time of writing this guide, JDK v21 is the current stable version. Download it from https://jdk.java.net/21/, and extract it to
/Library/Java/JavaVirtualMachines:Alternatively you could install OpenJDK from HomeBrew (
brew install java). Pay attention to the instructions displayed after install, as this package is keg-only, which means it was not symlinked into/opt/homebrew/(because it would shadow the macOSjavawrapper), therefore you must create a symlink in/Library/Java/JavaVirtualMachinesor add the installation directory to your PATH.Build and install Thrift as described in the guide. Extra steps to do before:
Make sure beforehand that
bisoninstalled through HomeBrew is available on your PATH:This package is keg-only, which means it was not symlinked into
/opt/homebrew/, because macOS already provides this software, but an older version (v2.3), not suitable for compiling Thrift.Homebrew installed several C++ related dependencies into the
/opt/homebrew/folder with the gcc package. We need to make these available for Thrift to successfully build its C++ library. (Before running the configuration script.)Thrift compiles with some warning, when built with Clang, which by default will be treated as errors. Therefore we need to set the
-Wno-errorflag before calling the configuration script.When executing the
./configurescript, pass the--with-openssl=/opt/homebrew/opt/opensslflag as well, so OpenSSL installed through HomeBrew could be found by Thrift.Build and install ODB as described in the guide, but while ODB runtime libraries (
libodb) have to be built with Clang (to avoid linking issues), the ODB Compiler itself can only be built with GNU.Therefore we will build ODB in 2 steps into the
<libodb_build_dir>and the<odb_build_dir>folders. A shared<odb_install_dir>installation destination can still be used though.Build the ODB runtime libraries. Note, that the
g++compiler is the default Clang compiler of macOS - if not, it should be modified accordingly.Build the ODB Compiler. Here the
g++-13GNU compiler is used, as at the time of writing this guide, GCC v13 is the default version installed by HomeBrew, but it could differ later.Furthermore, you need to add the
/opt/homebrew/folder to the include and link path as shown below, so dependencies installed through HomeBrew (like GMP) will be found. In case you receive a strange compilation errorAssertion failed: (resultIndex < sectData.atoms.size()), try adding-ld_classicto the link flags, due to an XCode ld linker incompatibility issue with GNU.Build CodeCompass.
Ongoing issues
prctl.hin Linux does not exist on macOS.libutilagainstlibodb-sqlite.sighandler_tis not included in the macOS.cpp_reparseservice, some types from the C++ standard library are not found.searchparserplugin in runtime._Pragmaoperator are double preprocessed, leading to parsing errors.compile_commands.jsonfor thefilefield are not handled properly..cppextension.