Skip to content

Modern CMake and Eigen update #3

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
mhubii wants to merge 6 commits into
base: master
Choose a base branch
from
Open

Modern CMake and Eigen update #3

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
da1ef09
updated build
Sep 17, 2022
0e4597d
removed thirdparty in favor for fetch
Sep 17, 2022
ab06d40
updated readme
Sep 17, 2022
f734dac
updated readme with cmake instructions
Oct 3, 2022
ec22798
disable in source builds
Oct 3, 2022
ff938dc
added cuda as target property
Oct 3, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
116 changes: 32 additions & 84 deletions CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,93 +1,41 @@
######### CMake Version #####################
cmake_minimum_required(VERSION 2.8.11)
#############################################
project(eigen-cuda LANGUAGES CXX)
cmake_minimum_required(VERSION 3.14)

######### Options ###########################
option( CORE_USE_CUDA "Use CUDA to speed up certain parts of the code." ON )
#############################################
option(USE_CUDA "Whether to use CUDA" OFF)


######### CUDA decisions ####################
if (CORE_USE_CUDA)
MESSAGE( STATUS ">> -------------- USING CUDA --------------" )
set( CUDA_TOOLKIT_ROOT_DIR "/opt/cuda" )
if (APPLE OR UNIX)
set(CMAKE_C_COMPILER /opt/cuda/bin/gcc)
set(CMAKE_CXX_COMPILER /opt/cuda/bin/g++)
elseif (WIN32)
### By default we use VS
MESSAGE( STATUS ">> User compiler: MSVC" )
MESSAGE( STATUS ">> Choosing a different compiler is not yet implemented for Windows" )
endif()
endif()
#############################################


######### Info ##############################
MESSAGE( STATUS ">> CMAKE_C_COMPILER: " ${CMAKE_C_COMPILER} )
MESSAGE( STATUS ">> CMAKE_CXX_COMPILER: " ${CMAKE_CXX_COMPILER} )
#############################################


######### Project Name ######################
project(eigencuda)
SET( EXECUTABLE_NAME run )
#############################################


### Find includes in corresponding build directories
set( CMAKE_INCLUDE_CURRENT_DIR ON )
######### Have the binary placed into the source head

@GPMueller GPMueller Sep 18, 2022

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you remove this section, the build does not match the docs, which say

To run an example, do

./main

(on msvc, but also if you implement my comments on the readme)

@mhubii mhubii Oct 3, 2022

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oh okay, running Ubuntu here, not sure I can look into this

@GPMueller GPMueller Oct 17, 2022

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why did you remove the section placing the binary into the root cmake dir?

set( CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_SOURCE_DIR} )
### Output paths for multi-config builds (e.g. msvc)
foreach( OUTPUTCONFIG ${CMAKE_CONFIGURATION_TYPES} )
string( TOUPPER ${OUTPUTCONFIG} OUTPUTCONFIG )
set( CMAKE_RUNTIME_OUTPUT_DIRECTORY_${OUTPUTCONFIG} ${CMAKE_SOURCE_DIR} )
# set( CMAKE_LIBRARY_OUTPUT_DIRECTORY_${OUTPUTCONFIG} ${youroutputdirectory} )
# set( CMAKE_ARCHIVE_OUTPUT_DIRECTORY_${OUTPUTCONFIG} ${youroutputdirectory} )
endforeach( OUTPUTCONFIG CMAKE_CONFIGURATION_TYPES )
#############################################
set( CMAKE_DISABLE_SOURCE_CHANGES ON )
set( CMAKE_DISABLE_IN_SOURCE_BUILD ON )
Comment thread
mhubii marked this conversation as resolved.
#############################################


######### CUDA decisions ####################
if (CORE_USE_CUDA)
find_package(CUDA REQUIRED)
if (USE_CUDA)
enable_language(CUDA)
add_definitions(-DUSE_CUDA)

@GPMueller GPMueller Sep 18, 2022

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if you'd like to modernise the cmake here, you could place this further below with the set_property:

 target_compile_definitions(test PRIVATE
        USE_CUDA
    )

(also, I believe this if (USE_CUDA) could be merged with the one further below?)

@mhubii mhubii Oct 3, 2022

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

added USE_CUDA as private property.

On the other note: The language has to be enabled or Eigen won't compile with cuda support. Not sure how to do this differently

@GPMueller GPMueller Oct 17, 2022

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not suggesting to remove it, but it seems like it should be fine to place

    enable_language(CUDA)
    add_definitions(-DUSE_CUDA)

into the if-block further down,

if (USE_CUDA)
    add_library(test ........

Or do you mean enable_language(CUDA) needs to be called before FetchContent_MakeAvailable(Eigen3)? If that's the case it's fine like it is

endif()
#############################################

#############################################
set(SOURCE_FILES
src/test.cpp
src/kernel.cu
src/kernel.cpp
include(FetchContent)
FetchContent_Declare(
Eigen3
GIT_REPOSITORY git@gitlab.com:libeigen/eigen.git
GIT_TAG master

@GPMueller GPMueller Sep 18, 2022

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure about fetching a branch instead of a commit or tag. It will mean people will get varying results over time.

You say

couldn't build it due to changes in Eigen/CMake

But this would change the Eigen version for people over time, without any relation to the CUDA version -- assuming an old CUDA version I believe this example should still build, even on newer CMake. Newer CUDA versions will require newer Eigen versions, but unfortunately it is also my experience that newer Eigen versions break on older CUDA.
Maybe it would be better to specify with which CUDA versions a given Eigen version should work?

Unfortunately, I don't see a way to future-proof this except maybe using conan or vcpkg, which seems a bit overkill...

@mhubii mhubii Oct 3, 2022 •
edited
Loading

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

generally agreed that using a tag / hash is better than a plain branch.

Is there a table that maps cuda / eigen versions somehow?

@GPMueller GPMueller Oct 17, 2022

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not aware of one and I think it would be overkill to implement such a mapping here.
For me it would be fine to choose a version and write a short comment with the CUDA version with which this MWE works.

)

set(HEADER_FILES
include/test.hpp
include/kernel.hpp
FetchContent_MakeAvailable(Eigen3)

if (USE_CUDA)
add_library(test
${CMAKE_CURRENT_SOURCE_DIR}/src/kernel.cu
${CMAKE_CURRENT_SOURCE_DIR}/src/test.cpp
)
set_property(TARGET test
PROPERTY CUDA_SEPARABLE_COMPILATION ON
)
else ()
add_library(test
${CMAKE_CURRENT_SOURCE_DIR}/src/kernel.cpp
${CMAKE_CURRENT_SOURCE_DIR}/src/test.cpp
)
endif ()

target_include_directories(test
PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/include
)
#############################################



#############################################
if (CORE_USE_CUDA)
include_directories( ${EXECUTABLE_NAME} PUBLIC ${PROJECT_SOURCE_DIR}/include ${PROJECT_SOURCE_DIR}/thirdparty)
cuda_add_executable( ${EXECUTABLE_NAME} main.cpp ${SOURCE_FILES} )
else()
add_executable( ${EXECUTABLE_NAME} main.cpp ${SOURCE_FILES} )
endif()

target_link_libraries( ${EXECUTABLE_NAME} ${CUDA_LIBRARIES})

target_include_directories( ${EXECUTABLE_NAME} PUBLIC ${PROJECT_SOURCE_DIR}/include)
target_include_directories( ${EXECUTABLE_NAME} PRIVATE ${PROJECT_SOURCE_DIR}/thirdparty)
target_link_libraries(test Eigen3::Eigen)

set_property(TARGET ${EXECUTABLE_NAME} PROPERTY CXX_STANDARD 11)
set_property(TARGET ${EXECUTABLE_NAME} PROPERTY CXX_STANDARD_REQUIRED ON)
set_property(TARGET ${EXECUTABLE_NAME} PROPERTY CXX_EXTENSIONS OFF)
#############################################
add_executable(main main.cpp)
target_link_libraries(main test)
15 changes: 13 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,16 @@ Using the Eigen library in CUDA kernels

[Eigen](http://eigen.tuxfamily.org/) is a fantastic library, which since version 3.3 can be used inside CUDA kernels.
**This MWE** shows the calculation of a sum of dot products using a `std::vector<Eigen::Vector3d>`.
The `USE_CUDA` macro switches from the regular C++ (CPU) implementation to the CUDA implementation.
CMake is used to configure the build and `CORE_USE_CUDA` can be used to switch between implementations.
The `USE_CUDA` flag switches from the regular C++ (CPU) implementation to the CUDA implementation.

## Usage
Clone this repository, then
```shell
mkdir build && cd build
cmake -DUSE_CUDA=OFF .. # or -DUSE_CUDA=ON
make -j
```
Comment thread
mhubii marked this conversation as resolved.
To run an example, do
```shell
./main
```
Empty file removed build/.gitkeep
View file
Open in desktop
Empty file.
3 changes: 0 additions & 3 deletions clean.sh
View file
Open in desktop

This file was deleted.

26 changes: 0 additions & 26 deletions cmake.sh
View file
Open in desktop

This file was deleted.

3 changes: 0 additions & 3 deletions make.sh
View file
Open in desktop

This file was deleted.

19 changes: 0 additions & 19 deletions thirdparty/Eigen/CMakeLists.txt
View file
Open in desktop

This file was deleted.

26 changes: 0 additions & 26 deletions thirdparty/Eigen/COPYING.BSD
View file
Open in desktop

This file was deleted.

Loading