From 8b5bf87aab6f7dc1a5cf3c8be25e990ae43a0679 Mon Sep 17 00:00:00 2001 From: Yiyao Yu Date: Tue, 4 May 2021 02:41:04 -0400 Subject: [PATCH] Updated README, fixed circular dependency in makefile --- README.md | 15 ++++++++++++--- omp/Makefile | 2 -- 2 files changed, 12 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index abebe14..9a9281c 100644 --- a/README.md +++ b/README.md @@ -14,11 +14,12 @@ library written in Rust. For more details, please see the project report. ## Building/Running RustMP requires the following dependencies to run: +- `hwloc2-v2.2.0`: C HWLoc wrapper used for NUMA aware process pinning +- `lazy_static-v1.4.0`: Lazy static macro used for delayed singleton init +- `num-v0.3`: Needed to run the Rust factorial benchmarks - `rand-v0.8.3`: Random number generation used for benchmarking examples - `rayon-v1.5.0`: Rayon parallel iterator library used in RustMP/Rayon.. comparision tests -- `hwloc2-v2.2.0`: C HWLoc wrapper used for NUMA aware process pinning -- `lazy_static-v1.4.0`: Lazy static macro used for delayed singleton init `src/` contains all code for the RustMP library, including `lib.rs`, `sysinfo.rs`, and `threadpool.rs`. `src/bin` contains benchmarking programs @@ -26,10 +27,18 @@ demonstrated in our paper. To run one of the benchmarks with cargo, execute the following command: ``` +# Set the RustMP, OpenMP, and Rayon thread pool thread count to +$ export RMP_NUM_THREADS= +$ export OMP_NUM_THREADS= +$ export RAYON_NUM_THREADS= + +# Run the test $ cargo run --release --bin ``` -C comparison benchmarks can be found in `omp/`. +C comparison benchmarks can be found in `omp/`. These can be compiled using +`make`. All matrix multiplication tests support one integer input as for the +square matrix dimensions (i.e. `./matmul `). Additional benchmarks are located in `benches`. These require Rust nightly and can be run with the following command: diff --git a/omp/Makefile b/omp/Makefile index 57373c9..7ef1395 100644 --- a/omp/Makefile +++ b/omp/Makefile @@ -42,8 +42,6 @@ $(BLDDIR)/$(BIN_OMP): $(BLDDIR) $(SRCS) $(BLDDIR)/$(BIN_OMP_SAFE): $(BLDDIR) $(SRCS) $(CC) $(CFLAGS_OMP_SAFE) $(SRCS) -o $@ -build: all - $(BLDDIR): @mkdir -p $(BLDDIR)