Skip to content

Latest commit

 

History

History
98 lines (67 loc) · 2.25 KB

Build.md

File metadata and controls

98 lines (67 loc) · 2.25 KB

ddprof build

Environment setup

ddprof is meant to build on Linux. Local builds on macos do not work (you don't have access to perf events).

Native linux

Install the required libraries described in the app/base-env/Dockerfile. Checkout the Build Commands section.

Docker

Docker can be used if you are not already on a linux environment. You need an ssh configuration as some repositories are private. The following script create a docker container based on CI dockerfiles. It will:

  • Use your ssh configuration
  • Automatically pull down all dependencies (same as in CI)
  • Sync your files with the docker environment
./tools/launch_local_build.sh

To speed up builds, we recommend usage of docker-sync (shared filesystems are very slow).

1 - create a docker-sync.yml file in the root of the repo.

version: "2"
syncs:
  ddprof-sync:
    sync_strategy: "native_osx"
    src: "./"
    host_disk_mount_mode: "cached"

2 - Then create a docker volume and launch docker-sync

docker volume create ddprof-sync
docker-sync start # launchs a watcher that syncs the files (takes a long time on first run)

3 - Use the docker build environment as usual (it will pick up the docker volume from the docker-sync file)

./tools/launch_local_build.sh

4 - You can stop and clean these volumes after usage

docker-sync stop
docker-sync clean
docker volume rm ddprof-sync

Build commands

Building the native profiler

source setup_env.sh
mkdir -p build_Release
cd build_Release
RelCMake ../
make -j 4 .

Building the benchmark (collatz)

Add the argument -DBUILD_BENCHMARKS=ON to the cmake command line.

Run commands

Under construction 🏗️

Setup

Write your datadog keys in a .env_perso.yml file in the root of the repository. Refer to the .env.yml file as a template. Configurations are taken from the test/configs folder.

Run examples

A stress test examples is available (you need to build the bench/collatz folder first)

./bench/runners/runit.sh collatz

run.sh is a wrapper that helps give relevant arguments to the profiler. Profile your own apps using

./bench/runners/run.sh my_own_exe