Skip to content

Improve compile time by making benchmarks optional #319

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tpadioleau wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Improve compile time by making benchmarks optional #319

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 5 additions & 50 deletions CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
cmake_minimum_required(VERSION 3.12)

# Options should be defined before they're used
option(GMGPOLAR_BUILD_BENCHMARKS "Build GMGPolar benchmarks." OFF)
option(GMGPOLAR_BUILD_TESTS "Build GMGPolar unit tests." ON)
option(GMGPOLAR_USE_LIKWID "Use LIKWID to measure code (regions)." OFF)
option(GMGPOLAR_USE_MUMPS "Use MUMPS to solve linear systems." OFF)
Expand Down Expand Up @@ -96,56 +97,6 @@ install(EXPORT GMGPolarTargets

add_subdirectory(src)

# Create the executables. These test specific cases and are not very useful
# without access to the source code so they are not installed with the
# library
add_executable(gmgpolar src/main.cpp)
add_executable(convergence_order src/convergence_order.cpp)
target_link_libraries(gmgpolar PRIVATE GMGPolarLib GMGPolarInterface)
target_link_libraries(convergence_order PRIVATE GMGPolarLib GMGPolarInterface)

# Builds a single-run inner executable (NAME_run) from SOURCE and generates a
# bash wrapper script NAME that owns the loop over configurations, calling the
# runner once per Kokkos::ScopeGuard lifetime. SCRIPT_BODY is shell code that
# uses $RUNNER (absolute path injected at cmake-generate time) and $OUTFILE.
function(add_scaling_wrapper NAME SOURCE SCRIPT_BODY)
set(runner_target ${NAME}_run)
add_executable(${runner_target} ${SOURCE})
target_link_libraries(${runner_target} PRIVATE GMGPolarLib GMGPolarInterface)

set(script "${CMAKE_BINARY_DIR}/${NAME}")
file(GENERATE
OUTPUT "${script}"
CONTENT "#!/bin/bash\nset -euo pipefail\nRUNNER=$<TARGET_FILE:${runner_target}>\n${SCRIPT_BODY}"
)
add_custom_target(${NAME} ALL
COMMAND chmod 755 "${script}"
COMMENT "Preparing ${NAME} wrapper script"
)
endfunction()

set(WEAK_SCALING_BODY
[=[OUTFILE="weak_scaling_results.csv"
echo "Threads,DivideBy2,nr,ntheta,geometry,stencil_method,cacheDensityProfileCoefficients,cacheDomainGeometry,FMG,extrapolation_int,TotalTime,t_setup_total,t_setup_createLevels,t_setup_smoother,t_setup_directSolver,t_solve_total,t_solve_initial_approximation,t_solve_multigrid_iterations,t_check_convergence,t_check_exact_error,t_avg_MGC_total,t_avg_MGC_preSmoothing,t_avg_MGC_postSmoothing,t_avg_MGC_residual,t_avg_MGC_directSolver" > "$OUTFILE"
"$RUNNER" "$OUTFILE" 5 --kokkos-threads=1
"$RUNNER" "$OUTFILE" 6 --kokkos-threads=4
"$RUNNER" "$OUTFILE" 7 --kokkos-threads=16
"$RUNNER" "$OUTFILE" 8 --kokkos-threads=56
echo "Results written to $OUTFILE"
]=])

set(STRONG_SCALING_BODY
[=[OUTFILE="strong_scaling_results.csv"
echo "Threads,DivideBy2,nr,ntheta,geometry,stencil_method,cacheDensityProfileCoefficients,cacheDomainGeometry,FMG,extrapolation_int,TotalTime,t_setup_total,t_setup_createLevels,t_setup_smoother,t_setup_directSolver,t_solve_total,t_solve_initial_approximation,t_solve_multigrid_iterations,t_check_convergence,t_check_exact_error,t_avg_MGC_total,t_avg_MGC_preSmoothing,t_avg_MGC_postSmoothing,t_avg_MGC_residual,t_avg_MGC_directSolver" > "$OUTFILE"
for threads in $(seq 1 56); do
"$RUNNER" "$OUTFILE" --kokkos-threads=$threads
done
echo "Results written to $OUTFILE"
]=])

add_scaling_wrapper(weak_scaling src/weak_scaling.cpp "${WEAK_SCALING_BODY}")
add_scaling_wrapper(strong_scaling src/strong_scaling.cpp "${STRONG_SCALING_BODY}")

if(GMGPOLAR_BUILD_TESTS)
enable_testing()
find_package(GTest 1.17 QUIET)
Expand Down Expand Up @@ -191,3 +142,7 @@ if(GMGPOLAR_BUILD_TESTS)
endif()
endif()
endif()

if(GMGPOLAR_BUILD_BENCHMARKS)
add_subdirectory(benchmarks)
endif()
47 changes: 47 additions & 0 deletions benchmarks/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# Create the executables. These test specific cases and are not very useful
# without access to the source code so they are not installed with the
# library
add_executable(gmgpolar main.cpp)
target_link_libraries(gmgpolar PRIVATE GMGPolarLib GMGPolarInterface)

# Builds a single-run inner executable (NAME_run) from SOURCE and generates a
# bash wrapper script NAME that owns the loop over configurations, calling the
# runner once per Kokkos::ScopeGuard lifetime. SCRIPT_BODY is shell code that
# uses $RUNNER (absolute path injected at cmake-generate time) and $OUTFILE.
function(add_scaling_wrapper NAME SOURCE SCRIPT_BODY)
set(runner_target ${NAME}_run)
add_executable(${runner_target} ${SOURCE})
target_link_libraries(${runner_target} PRIVATE GMGPolarLib GMGPolarInterface)

set(script "${CMAKE_BINARY_DIR}/${NAME}")
file(GENERATE
OUTPUT "${script}"
CONTENT "#!/bin/bash\nset -euo pipefail\nRUNNER=$<TARGET_FILE:${runner_target}>\n${SCRIPT_BODY}"
)
add_custom_target(${NAME} ALL
COMMAND chmod 755 "${script}"
COMMENT "Preparing ${NAME} wrapper script"
)
endfunction()

set(WEAK_SCALING_BODY
[=[OUTFILE="weak_scaling_results.csv"
echo "Threads,DivideBy2,nr,ntheta,geometry,stencil_method,cacheDensityProfileCoefficients,cacheDomainGeometry,FMG,extrapolation_int,TotalTime,t_setup_total,t_setup_createLevels,t_setup_smoother,t_setup_directSolver,t_solve_total,t_solve_initial_approximation,t_solve_multigrid_iterations,t_check_convergence,t_check_exact_error,t_avg_MGC_total,t_avg_MGC_preSmoothing,t_avg_MGC_postSmoothing,t_avg_MGC_residual,t_avg_MGC_directSolver" > "$OUTFILE"
"$RUNNER" "$OUTFILE" 5 --kokkos-threads=1
"$RUNNER" "$OUTFILE" 6 --kokkos-threads=4
"$RUNNER" "$OUTFILE" 7 --kokkos-threads=16
"$RUNNER" "$OUTFILE" 8 --kokkos-threads=56
echo "Results written to $OUTFILE"
]=])

set(STRONG_SCALING_BODY
[=[OUTFILE="strong_scaling_results.csv"
echo "Threads,DivideBy2,nr,ntheta,geometry,stencil_method,cacheDensityProfileCoefficients,cacheDomainGeometry,FMG,extrapolation_int,TotalTime,t_setup_total,t_setup_createLevels,t_setup_smoother,t_setup_directSolver,t_solve_total,t_solve_initial_approximation,t_solve_multigrid_iterations,t_check_convergence,t_check_exact_error,t_avg_MGC_total,t_avg_MGC_preSmoothing,t_avg_MGC_postSmoothing,t_avg_MGC_residual,t_avg_MGC_directSolver" > "$OUTFILE"
for threads in $(seq 1 56); do
"$RUNNER" "$OUTFILE" --kokkos-threads=$threads
done
echo "Results written to $OUTFILE"
]=])

add_scaling_wrapper(weak_scaling weak_scaling.cpp "${WEAK_SCALING_BODY}")
add_scaling_wrapper(strong_scaling strong_scaling.cpp "${STRONG_SCALING_BODY}")
0 src/main.cpp → benchmarks/main.cpp
View file
Open in desktop
File renamed without changes.
0 src/strong_scaling.cpp → benchmarks/strong_scaling.cpp
View file
Open in desktop
File renamed without changes.
0 src/weak_scaling.cpp → benchmarks/weak_scaling.cpp
View file
Open in desktop
File renamed without changes.
4 changes: 4 additions & 0 deletions tests/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,3 +29,7 @@ target_compile_features(gmgpolar_tests PRIVATE cxx_std_20)
target_link_libraries(gmgpolar_tests GMGPolarLib GMGPolarInterface GTest::gtest)

gtest_discover_tests(gmgpolar_tests DISCOVERY_MODE PRE_TEST)

add_executable(convergence_order ConvergenceOrder/convergence_order.cpp)
target_link_libraries(convergence_order PRIVATE GMGPolarLib GMGPolarInterface)
add_test(NAME convergence_order COMMAND convergence_order)
0 src/convergence_order.cpp → tests/ConvergenceOrder/convergence_order.cpp
View file
Open in desktop
File renamed without changes.
Loading