Skip to content

Latest commit

 

History

History
441 lines (376 loc) · 18.3 KB

INSTALLATION.md

File metadata and controls

441 lines (376 loc) · 18.3 KB
Raw

Automated installation (Docker/Virtualbox) for interactive use

One can use a pre-installed virtual machine with rchk (or, more precisely, use an automated script that installs such machine without user intervention, into virtualbox or docker). Please note that this is conceptually the same thing as downloading the binary image from docker hub/virtualbox repository, it is just independent on such repositories and takes slightly longer (within 15 minutes on my laptop) to automatically install. The installation will create a virtual machine into which one can log in and perform the checks, all state is kept inside the machine.

Run vagrant up --provider virtualbox in image directory to use VirtualBox or vagrant up --provider docker to use Docker.

One needs to install Vagrant (apt-get install vagrant) and VirtualBox (apt-get install virtualbox) or Docker (apt-get install docker docker.io, add current user to the docker group).

If vagrant up --provider virtualbox fails or times out due to network connectivity issues, vagrant provision restarts it. To log into the installed machined, use vagrant ssh and check the first R package using instructions provided here. One can access the host file system in directory /vagrant inside the virtual installation, e.g. to copy package tarballs in and out.

Native installation on Linux for interactive use

Once the installation is finished, check the first R package using instructions provided here. The description below assumes that wllvm is installed via running pip as root; when run as a regular user, the installation directory will be different (e.g. ~/.local/bin).

Newer distributions (with LLVM > 14)

A major change in LLVM 15 removed pointee-type information from pointers, so pointers are now opaque. Rchk, however, heavily depends on that it can see which pointers are SEXP directly from the IR. Currently, one has to install LLVM 14 on systems that already distribute newer versions and use the llvm-14 branch of rchk as in the examples below. This includes Fedora Core 37 and Fedora Core 38.

LLVM 14 for use with rchk can be compiled from source as follow:

 cmake -S llvm -B build -G Ninja -DCMAKE_BUILD_TYPE=Release \
      -DLLVM_ENABLE_LIBCXX:BOOL=OFF \
      -DLLVM_ENABLE_PROJECTS="clang" \
      -DCMAKE_INSTALL_PREFIX=/opt/llvm14
 cmake --build build --target install

and then one has to arrange for src/Makefile to set LLVM = /opt/llvm14 and scripts/config.inc to set export LLVM = /opt/llvm14.

Ubuntu 22.04 (Jammy Jellyfish)

These instructions are for LLVM 14. Tested August 12, 2022 on a clean install of Ubuntu 22.04.

  1. Install build dependencies for R:
    • enable source repositories in /etc/apt/sources.list, e.g. using sed -i 's/^# deb-src/deb-src/g' /etc/apt/sources.list
    • apt-get update
    • apt-get build-dep -y r-base
  2. Install clang and llvm:
    • apt-get install clang llvm-dev '^clang++$' llvm libllvm14 libc++-dev libc++abi-dev
  3. Install WLLVM scripts:
    • apt-get install python3-pip
    • pip3 install wllvm (as root, a warning will be displayed)
  4. Install rchk:
    • apt-get install git
    • git clone -b llvm14 https://github.com/kalibera/rchk.git
    • cd rchk/src ; make ; cd ..
    • customize scripts/config.inc (set root of LLVM, WLLVM, and rchk), LLVM is /usr, WLLVM is /usr/local/bin, RCHK is the path to rchk directory created by git.

Debian (Bookworm)

These instructions are for LLVM 14. Tested August 12, 2022 on a clean install of Debian testing (bookworm).

  1. Install build dependencies for R:
    • enable source repositories in /etc/apt/sources.list
    • apt-get update
    • apt-get build-dep -y r-base
  2. Install clang and llvm:
    • apt-get install llvm clang libllvm14 libc\+\+-dev libc\+\+abi-dev
  3. Install WLLVM scripts:
    • apt-get install python3-pip
    • pip3 install wllvm (as root, a warning will be displayed)
  4. Install rchk:
    • apt-get install git
    • git clone -b llvm14 https://github.com/kalibera/rchk.git
    • cd rchk/src ; make ; cd ..
    • customize scripts/config.inc (set root of LLVM, WLLVM, and rchk), LLVM is /usr, WLLVM is /usr/local/bin, RCHK is the path to rchk directory created by git.

Ubuntu 20.04 (Focal Fossa)

These instructions are for LLVM 10. Tested August 12, 2022 on a clean install of Ubuntu 20.04.

  1. Install build dependencies for R:
    • enable source repositories in /etc/apt/sources.list, e.g. using sed -i 's/^# deb-src/deb-src/g' /etc/apt/sources.list
    • apt-get update
    • apt-get build-dep -y r-base
  2. Install clang and llvm:
    • apt-get install clang llvm-dev '^clang++$' llvm libllvm10 libc++-dev libc++abi-dev
  3. Install WLLVM scripts:
    • apt-get install python3-pip
    • pip3 install wllvm (as root)
  4. Install rchk:
    • apt-get install git
    • git clone https://github.com/kalibera/rchk.git
    • cd rchk/src ; make ; cd ..
    • customize scripts/config.inc (set root of LLVM, WLLVM, and rchk), LLVM is /usr, WLLVM is /usr/local/bin, RCHK is the path to rchk directory created by git.

Debian (Bullseye)

These instructions are for LLVM 11. Tested August 12, 2022 on a clean install of Debian bullseye (11.4).

  1. Install build dependencies for R:
    • enable source repositories in /etc/apt/sources.list
    • apt-get update
    • apt-get build-dep -y r-base
  2. Install clang and llvm:
    • apt-get install llvm clang clang-11 llvm-11-dev llvm-11 libllvm11 libc\+\+-dev libc\+\+abi-dev
  3. Install WLLVM scripts:
    • apt-get install python3-pip
    • pip3 install wllvm (as root)
  4. Install rchk:
    • apt-get install git
    • git clone -b llvm11 https://github.com/kalibera/rchk.git
    • cd rchk/src ; make ; cd ..
    • customize scripts/config.inc (set root of LLVM, WLLVM, and rchk), LLVM is /usr, WLLVM is /usr/local/bin, RCHK is the path to rchk directory created by git.

Fedora 36

These instructions are for LLVM 14. Tested August 12, 2022 on a clean install of Fedora 36.

  1. Install development tools and build dependencies for R:
    • dnf install dnf-plugins-core diffutils which
    • dnf install redhat-rpm-config hostname java-11-openjdk-devel
      • dnf install 'dnf-command(builddep)'
    • dnf builddep R
    • dnf groupinstall "Development Tools"
    • dnf groupinstall "C Development Tools and Libraries"
  2. Install clang and llvm:
    • dnf install llvm llvm-devel clang
  3. Install WLLVM scripts:
    • dnf install python-pip
    • pip install wllvm (as root, a warning will be displayed)
  4. Install rchk:
    • dnf install git
    • git clone -b llvm14 https://github.com/kalibera/rchk.git
    • cd rchk/src ; make ; cd ..
    • customize scripts/config.inc (set root of LLVM, WLLVM, and rchk), LLVM is /usr, WLLVM is /usr/local/bin, RCHK is the path to rchk directory created by git.

Fedora 35

These instructions are for LLVM 13. Tested August 12, 2022 on a clean install of Fedora 35 (note: it is intentional to use branch named llvm11 as there were no incompatible API changes in LLVM 13 impacting rchk).

  1. Install development tools and build dependencies for R:
    • dnf install dnf-plugins-core diffutils which
    • dnf install redhat-rpm-config hostname java-11-openjdk-devel
      • dnf install 'dnf-command(builddep)'
    • dnf builddep R
    • dnf groupinstall "Development Tools"
    • dnf groupinstall "C Development Tools and Libraries"
  2. Install clang and llvm:
    • dnf install llvm llvm-devel clang
  3. Install WLLVM scripts:
    • dnf install python-pip
    • pip install wllvm (as root, a warning will be displayed)
  4. Install rchk:
    • dnf install git
    • git clone -b llvm11 https://github.com/kalibera/rchk.git
    • cd rchk/src ; make ; cd ..
    • customize scripts/config.inc (set root of LLVM, WLLVM, and rchk), LLVM is /usr, WLLVM is /usr/local/bin, RCHK is the path to rchk directory created by git.

Installing on older systems

There instructions will probably still work on older systems, but are not re-tested as those systems evolve.

Fedora 34

These instructions are for LLVM 12. Tested September 24, 2021 on a clean install of Fedora 34 (note: it is intentional to use branch named llvm11 as there were no incompatible API changes in LLVM 12 impacting rchk.

  1. Install development tools and build dependencies for R:
    • dnf install dnf-plugins-core diffutils which
    • dnf install redhat-rpm-config hostname java-11-openjdk-devel
      • dnf install 'dnf-command(builddep)'
    • dnf builddep R
    • dnf groupinstall "Development Tools"
    • dnf groupinstall "C Development Tools and Libraries"
  2. Install clang and llvm:
    • dnf install llvm llvm-devel clang
  3. Install WLLVM scripts:
    • dnf install python-pip
    • pip install wllvm (as root)
  4. Install rchk:
    • dnf install git
    • git clone -b llvm11 https://github.com/kalibera/rchk.git
    • cd rchk/src ; make ; cd ..
    • customize scripts/config.inc (set root of LLVM, WLLVM, and rchk), LLVM is /usr, WLLVM is /usr/local/bin, RCHK is the path to rchk directory created by git.

Fedora 33

These instructions are for LLVM 11. Tested September 24, 2021 on a clean install of Fedora 33.

  1. Install development tools and build dependencies for R:
    • dnf install dnf-plugins-core diffutils which
    • dnf install redhat-rpm-config hostname java-11-openjdk-devel
      • dnf install 'dnf-command(builddep)'
    • dnf builddep R
    • dnf groupinstall "Development Tools"
    • dnf groupinstall "C Development Tools and Libraries"
    • dnf install rsync
  2. Install clang and llvm:
    • dnf install llvm llvm-devel clang
  3. Install WLLVM scripts:
    • dnf install python-pip
    • pip install wllvm (as root)
  4. Install rchk:
    • dnf install git
    • git clone -b llvm11 https://github.com/kalibera/rchk.git
    • cd rchk/src ; make ; cd ..
    • customize scripts/config.inc (set root of LLVM, WLLVM, and rchk), LLVM is /usr, WLLVM is /usr/local/bin, RCHK is the path to rchk directory created by git.

Debian (Buster)

These instructions are for LLVM 7. Tested March 5, 2019 on a clean install of Debian testing (buster/sid).

  1. Install build dependencies for R:
    • enable source repositories in /etc/apt/sources.list
    • apt-get update
    • apt-get build-dep -y r-base-dev
  2. Install clang and llvm:
    • apt-get install llvm clang clang-7 llvm-7-dev llvm-7 libllvm7 libc\+\+-dev libc\+\+abi-dev
  3. Install WLLVM scripts:
    • apt-get install python-pip
    • pip install wllvm (as root)
  4. Install rchk:
    • apt-get install git
    • git clone https://github.com/kalibera/rchk.git
    • cd rchk/src ; env LLVM=/usr/lib/llvm-7 make ; cd ..
    • customize scripts/config.inc (set root of LLVM, WLLVM, and rchk), LLVM is /usr/lib/llvm-7, WLLVM is /usr/local/bin, RCHK is the path to rchk directory created by git.

Fedora 32

These instructions are for LLVM 10. Tested October 21, 2020 on a clean install of Fedora 32.

  1. Install development tools and build dependencies for R:
    • dnf install dnf-plugins-core diffutils which
    • dnf install redhat-rpm-config hostname java-1.8.0-openjdk-devel
      • dnf install 'dnf-command(builddep)'
    • dnf builddep R
    • dnf groupinstall "Development Tools"
    • dnf groupinstall "C Development Tools and Libraries"
  2. Install clang and llvm:
    • dnf install llvm llvm-devel clang
  3. Install WLLVM scripts:
    • dnf install python-pip
    • pip install wllvm (as root)
  4. Install rchk:
    • dnf install git
    • git clone https://github.com/kalibera/rchk.git
    • cd rchk/src ; make ; cd ..
    • customize scripts/config.inc (set root of LLVM, WLLVM, and rchk), LLVM is /usr, WLLVM is /usr/local/bin, RCHK is the path to rchk directory created by git.

Fedora 29 and 30

These instructions are for LLVM 7. Tested March 6, 2019 on a clean install of Fedora 29 and March 7 on Fedora 30. Note, however, there may be error messages like objcopy: xxx: failed to find link section for section (the problem has been discussed at WLLVM website and a bug filed against binutils). It seems these messages can be ignored.

  1. Install development tools and build dependencies for R:
    • dnf install dnf-plugins-core hostname
    • dnf install redhat-rpm-config hostname java-1.8.0-openjdk-devel
    • dnf builddep R
    • dnf groupinstall "Development Tools"
    • dnf groupinstall "C Development Tools and Libraries"
  2. Install clang and llvm:
    • dnf install llvm llvm-devel clang
  3. Install WLLVM scripts:
    • dnf install python-pip
    • pip install wllvm (as root)
  4. Install rchk:
    • dnf install git
    • git clone https://github.com/kalibera/rchk.git
    • cd rchk/src ; make ; cd ..
    • customize scripts/config.inc (set root of LLVM, WLLVM, and rchk), LLVM is /usr, WLLVM is /usr/bin, RCHK is the path to rchk directory created by git.

Ubuntu 18.04 (Bionic Beaver)

These instructions are for LLVM 4.

  1. Install build dependencies for R:
    • enable source repositories in /etc/apt/sources.list
    • apt-get update
    • apt-get build-dep -y r-base-dev
  2. Install clang and llvm:
    • apt-get install clang-4.0 llvm-4.0-dev clang\+\+-4.0 llvm-4.0 libllvm4.0 libc\+\+-dev libc\+\+abi-dev
  3. Install WLLVM scripts:
    • apt-get install python-pip
    • pip install wllvm (as root)
  4. Install rchk:
    • apt-get install git
    • git clone https://github.com/kalibera/rchk.git
    • cd rchk/src ; env LLVM=/usr/lib/llvm-4.0 make ; cd ..
    • customize scripts/config.inc (set root of LLVM, WLLVM, and rchk), LLVM is /usr/lib/llvm-4.0, WLLVM is /usr/local/bin, RCHK is the path to rchk directory created by git.

To use rchk with LLVM 6, modify the steps above as follows:

  • Install clang and llvm:
    • apt-get install llvm clang clang-6.0 llvm-6.0-dev llvm-6.0 libllvm6.0 libc\+\+-dev libc\+\+abi-dev
  • Install rchk:
    • cd rchk/src ; make ; cd ..
    • customize scripts/config.inc to include export LLVM=/usr

Ubuntu 19.04 (Disco Dingo)

These instructions are for LLVM 8.

  1. Install build dependencies for R:
    • enable source repositories in /etc/apt/sources.list
    • apt-get update
    • apt-get build-dep -y r-base-dev
  2. Install clang and llvm:
    • apt-get install clang-8 llvm-8-dev clang\+\+-8 llvm-8 libllvm8 libc\+\+-dev libc\+\+abi-dev
  3. Install WLLVM scripts:
    • apt-get install python-pip
    • pip install wllvm (as root)
  4. Install rchk:
    • apt-get install git
    • git clone https://github.com/kalibera/rchk.git
    • cd rchk/src ; env LLVM=/usr/lib/llvm-8 make ; cd ..
    • customize scripts/config.inc (set root of LLVM, WLLVM, and rchk), LLVM is /usr/lib/llvm-8, WLLVM is /usr/local/bin, RCHK is the path to rchk directory created by git.

Debian 9 (Stretch)

These instructions are for LLVM 3.8.

  1. Install build dependencies for R:
    • enable source repositories in /etc/apt/sources.list
    • apt-get update
    • apt-get build-dep -y r-base-dev
  2. Install clang and llvm:
    • apt-get install clang-3.8 llvm-3.8-dev clang\+\+-3.8 llvm-3.8 libllvm3.8 libc\+\+-dev libc\+\+abi-dev
  3. Install WLLVM scripts:
    • apt-get install python-pip
    • pip install wllvm (as root)
  4. Install rchk:
    • apt-get install git
    • git clone https://github.com/kalibera/rchk.git
    • cd rchk/src ; env LLVM=/usr/lib/llvm-3.8 make ; cd ..
    • customize scripts/config.inc (set root of LLVM, WLLVM, and rchk), LLVM is /usr/lib/llvm-3.8, WLLVM is /usr/local/bin, RCHK is the path to rchk directory created by git.

Fedora 28

These instructions are for LLVM 6.

  1. Install development tools and build dependencies for R:
    • yum install yum-utils
    • yum-builddep R
    • yum install redhat-rpm-config hostname java-1.8.0-openjdk-devel
    • yum groupinstall "Development Tools"
    • yum groupinstall "C Development Tools and Libraries"
  2. Install clang and llvm:
    • yum install llvm llvm-devel clang
  3. Install WLLVM scripts:
    • pip install wllvm (as root)
  4. Install rchk:
    • yum install git
    • git clone https://github.com/kalibera/rchk.git
    • cd rchk/src ; make ; cd ..
    • customize scripts/config.inc (set root of LLVM, WLLVM, and rchk), LLVM is /usr, WLLVM is /usr/bin, RCHK is the path to rchk directory created by git.

Installing on even older systems

While rchk used to work on older systems, it is not being backported to them and cannot be compiled with older versions of LLVM due to incompatibility of the API. One can get an old version of rchk to work with LLVM 3.6 (llvm-36 branch) and with LLVM 3.8 (llvm-38 branch), but these older versions of rchk do not include the latest fixes to work well with the latest (development) version of R, and hence they are not recommended for use. It should, however, be possible to install rchk on an older system with a working installation of LLVM 4, 5 or 6. I've been using rchk on many earlier versions of Ubuntu, so Ubuntu and Debian are likely to be easiest to use. Also I've used rchk regularly on several versions of Fedora. Particularly on older systems or with older versions of rchk, it is recommended to use GCC/g++ instead of LLVM/clang++ to compile rchk as crashes have been observed when compiled with clang++. Earlier version of rchk had an access-out-of-bounds bug that incidentally has been causing crashes on Gentoo but not other systems.