Skip to content

Commit

Permalink
Merge remote-tracking branch 'upstream/dev' into oa-cleanups
Browse files Browse the repository at this point in the history
  • Loading branch information
@sleeepyjack
sleeepyjack committed Nov 21, 2023
2 parents e86c657 + e41bf45 commit f3b82b2
Show file tree
Hide file tree
Showing 12 changed files with 369 additions and 298 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/dispatch-build-and-test.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ jobs:
with:
cpu: ${{ matrix.cpu }}
test_name: ${{matrix.compiler.name}}${{matrix.compiler.version}}/C++${{matrix.std}}
build_script: "./ci/build.sh ${{matrix.compiler.exe}} ${{matrix.std}} ${{matrix.gpu_build_archs}}"
test_script: "./ci/test.sh ${{matrix.compiler.exe}} ${{matrix.std}} ${{matrix.gpu_build_archs}}"
build_script: "./ci/build.sh --cxx ${{matrix.compiler.exe}} --std ${{matrix.std}} --arch ${{matrix.gpu_build_archs}} --infix ${{matrix.cpu}}-${{matrix.compiler.name}}${{matrix.compiler.version}}-cuda${{matrix.cuda}}"
test_script: "./ci/test.sh --tests --cxx ${{matrix.compiler.exe}} --std ${{matrix.std}} --arch ${{matrix.gpu_build_archs}} --infix ${{matrix.cpu}}-${{matrix.compiler.name}}${{matrix.compiler.version}}-cuda${{matrix.cuda}}"
container_image: rapidsai/devcontainers:${{inputs.devcontainer_version}}-cpp-${{matrix.compiler.name}}${{matrix.compiler.version}}-cuda${{matrix.cuda}}-${{matrix.os}}
run_tests: ${{ contains(matrix.jobs, 'test') && !contains(github.event.head_commit.message, 'skip-tests') }}
21 changes: 16 additions & 5 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,7 @@ This will take care of downloading `cuCollections` from GitHub and making the he

`cuCollections` depends on the following libraries:

- [libcu++](https://github.com/NVIDIA/libcudacxx)
- [CUB](https://github.com/thrust/cub)
- [CUDA C++ Core Libraries (CCCL)](https://github.com/NVIDIA/cccl)

No action is required from the user to satisfy these dependencies. `cuCollections`'s CMake script is configured to first search the system for these libraries, and if they are not found, to automatically fetch them from GitHub.

Expand All @@ -75,14 +74,26 @@ To build the tests, benchmarks, and examples:
cd $CUCO_ROOT
mkdir -p build
cd build
cmake ..
make
cmake .. # configure
make # build
ctest --test-dir tests # run tests
```
Binaries will be built into:
- `build/tests/`
- `build/gbenchmarks/`
- `build/benchmarks/`
- `build/examples/`

### Build Script:

Alternatively, you can use the build script located at `ci/build.sh`. Calling this script with no arguments will trigger a full build which will be located at `build/local`.

```bash
cd $CUCO_ROOT
ci/build.sh # configure and build
ctest --test-dir build/local/tests # run tests
```

For a comprehensive list of all available options along with descriptions and examples, you can use the option `ci/build.sh -h`.

## Code Formatting
By default, `cuCollections` uses [`pre-commit.ci`](https://pre-commit.ci/) along with [`mirrors-clang-format`](https://github.com/pre-commit/mirrors-clang-format) to automatically format the C++/CUDA files in a pull request.
Expand Down
231 changes: 164 additions & 67 deletions ci/build.sh
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,108 +16,205 @@

set -eo pipefail

ORIGINAL_DIR=$(pwd)

resolve_path() {
local input_path=$1
# Check if the input is an absolute path
if [[ "$input_path" = /* ]]; then
echo "$input_path"
else
# Treat as a relative path or executable name
# Check if it's in the PATH
if command -v "$input_path" >/dev/null 2>&1; then
echo "$input_path"
else
echo "$ORIGINAL_DIR/$input_path"
fi
fi
}

# Ensure the script is being executed in its containing directory
cd "$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )";

# Script defaults
CUDA_COMPILER=nvcc
BUILD_TESTS=${BUILD_TESTS:-OFF}
BUILD_EXAMPLES=${BUILD_EXAMPLES:-OFF}
BUILD_BENCHMARKS=${BUILD_BENCHMARKS:-OFF}
CLEAN_BUILD=0 # Re-use existing artifacts by-default
BUILD_PREFIX=../build # <repo_root>/build
BUILD_INFIX=local # <repo_root>/build/local
DEBUG_BUILD=0 # Default build type is Release
PARALLEL_LEVEL=${PARALLEL_LEVEL:-$(nproc)} # defaults to number of cores in the system
CUDA_COMPILER=${CUDACXX:-nvcc} # $CUDACXX if set, otherwise `nvcc`
HOST_COMPILER=${CXX:-g++} # $CXX if set, otherwise `g++`
CUDA_ARCHS=native # detect system's GPU architectures
CXX_STANDARD=17

# Check if the correct number of arguments has been provided
function usage {
echo "Usage: $0 [OPTIONS] <HOST_COMPILER> <CXX_STANDARD> <GPU_ARCHS>"
echo "The PARALLEL_LEVEL environment variable controls the amount of build parallelism. Default is the number of cores."
echo "Example: PARALLEL_LEVEL=8 $0 g++-8 14 \"70\" "
echo "Example: $0 clang++-8 17 \"70;75;80-virtual\" "
echo "Possible options: "
echo " -nvcc: path/to/nvcc"
echo " -v/--verbose: enable shell echo for debugging"
echo "cuCollections build script"
echo "Usage: $0 [OPTIONS]"
echo "Options:"
echo " -t/--tests: Build tests"
echo " -e/--examples: Build examples"
echo " -b/--benchmarks: Build benchmarks"
echo " -c/--clean: Clean (re-)build"
echo " --prefix: Build directory prefix (Defaults to <repo_root>/build)"
echo " -i/--infix: Build directory infix (Defaults to local)"
echo " -d/--debug: Debug build"
echo " -p/--parallel: Build parallelism (Defaults to \$PARALLEL_LEVEL if set, otherwise the system's number of CPU cores)"
echo " --cuda: CUDA compiler (Defaults to \$CUDACXX if set, otherwise nvcc)"
echo " --cxx: Host compiler (Defaults to \$CXX if set, otherwise g++)"
echo " --arch: Target CUDA arches, e.g. \"60-real;70;80-virtual\" (Defaults to the system's native GPU archs)"
echo " --std: CUDA/C++ standard (Defaults to 17)"
echo " -v/-verbose/--verbose: Enable shell echo for debugging"
echo " -h/-help/--help: Show this usage message"
echo
echo "Examples:"
echo " Basic Build:"
echo " $ $0"
echo " Runs a basic build with default settings, i.e., builds tests, examples, and benchmarks."
echo " Build files will be written to <repo_root>/build/local and symlinked to <repo_root>/build/latest."
echo
echo " Custom Build Infix Directory:"
echo " $ $0 -i my_build"
echo " Build files will be written to the <repo_root>/build/my_build directory and symlinked to <repo_root>/build/latest."
echo
echo " Parallel Build with Specific CUDA Architecture and CUDA Compiler:"
echo " $ PARALLEL_LEVEL=8 $0 --cuda /my_cuda_compiler/nvcc --arch 70;80"
echo " $ $0 -p 8 --cuda /my_cuda_compiler/nvcc --arch 70;80"
echo " Specifies parallel build level of 8 and CUDA architecture 70 and 80 with the specified CUDA compiler."
echo " Build files will be written to <repo_root>/build/local and symlinked to <repo_root>/build/latest."
echo
echo " Debug Build with Tests and Examples:"
echo " $ CXX=g++-9 $0 -t -e -d"
echo " $ $0 --cxx g++-9 -t -e -d"
echo " Sets the host compiler to g++-9, builds tests and examples, and enables debug mode."
echo " Build files will be written to <repo_root>/build/local and symlinked to <repo_root>/build/latest."
echo
echo " Custom Build Directory with Benchmarks:"
echo " $ BUILD_BENCHMARKS=ON $0 --prefix /custom/build --infix my_build"
echo " $ $0 --prefix /custom/build --infix my_build -b"
echo " Builds benchmarks only."
echo " Build files will be written to /custom/build/my_build and symlinked to /custom/build/latest."
echo
echo " Verbose Mode for Debugging:"
echo " $ $0 -v --std 17"
echo " Enables verbose mode for detailed output and builds with C++17 standard."
echo " Build files will be written to <repo_root>/build/local and symlinked to <repo_root>/build/latest."
echo
exit 1
}

# Check for extra options
# While there are more than 3 arguments, parse switches/options
while [ "$#" -gt 3 ]
do
case "${1}" in
-h) usage ;;
-help) usage ;;
--help) usage ;;
--verbose) VERBOSE=1; shift ;;
-v) VERBOSE=1; shift ;;
-nvcc) CUDA_COMPILER="${2}"; shift 2;;
*) usage ;;
esac
# Parse options

# Copy the args into a temporary array, since we will modify them and
# the parent script may still need them.
args=("$@")
while [ "${#args[@]}" -ne 0 ]; do
case "${args[0]}" in
-t | --tests) BUILD_TESTS=ON; args=("${args[@]:1}");;
-e | --examples) BUILD_EXAMPLES=ON; args=("${args[@]:1}");;
-b | --benchmarks) BUILD_BENCHMARKS=ON; args=("${args[@]:1}");;
-c | --clean) CLEAN_BUILD=1; args=("${args[@]:1}");;
--prefix) BUILD_PREFIX=$(resolve_path "${args[1]}"); args=("${args[@]:2}");;
-i | --infix) BUILD_INFIX="${args[1]}"; args=("${args[@]:2}");;
-d | --debug) DEBUG_BUILD=1; args=("${args[@]:1}");;
-p | --parallel) PARALLEL_LEVEL="${args[1]}"; args=("${args[@]:2}");;
--cuda) CUDA_COMPILER=$(resolve_path "${args[1]}"); args=("${args[@]:2}");;
--cxx) HOST_COMPILER=$(resolve_path "${args[1]}"); args=("${args[@]:2}");;
--arch) CUDA_ARCHS="${args[1]}"; args=("${args[@]:2}");;
--std) CXX_STANDARD="${args[1]}"; args=("${args[@]:2}");;
-v | -verbose | --verbose) VERBOSE=1; args=("${args[@]:1}");;
-h | -help | --help) usage ;;
*) echo "Unrecognized option: ${args[0]}"; usage ;;
esac
done

# Convert to full paths:
HOST_COMPILER=$(which ${HOST_COMPILER})
CUDA_COMPILER=$(which ${CUDA_COMPILER})
# Make CUDA arch list compatible with cmake
CUDA_ARCHS=$(echo "$CUDA_ARCHS" | tr ' ,' ';;')

if [ $VERBOSE ]; then
set -x
fi

if [ "$#" -ne 3 ]; then
echo "Invalid number of arguments"
usage
fi

# Begin processing unsets after option parsing
set -u

# Assign command line arguments to variables
readonly HOST_COMPILER=$(which $1)
readonly CXX_STANDARD=$2

# Replace spaces, commas and semicolons with semicolons for CMake list
readonly GPU_ARCHS=$(echo $3 | tr ' ,' ';')
if [ "$BUILD_INFIX" = "latest" ] || [ -z "$BUILD_INFIX" ]; then
echo "Error: BUILD_INFIX cannot be empty or 'latest'" >&2
exit 1
fi

readonly PARALLEL_LEVEL=${PARALLEL_LEVEL:=$(nproc)}
readonly NVCC_VERSION=$($CUDA_COMPILER --version | grep release | awk '{print $6}' | cut -c2-)
# If no build target is specified, build all targets
if [ "$BUILD_TESTS" == "OFF" ] && [ "$BUILD_EXAMPLES" == "OFF" ] && [ "$BUILD_BENCHMARKS" == "OFF" ]; then
BUILD_TESTS=ON
BUILD_EXAMPLES=ON
BUILD_BENCHMARKS=ON
fi

if [ -z ${DEVCONTAINER_NAME+x} ]; then
BUILD_DIR=../build/local
else
BUILD_DIR=../build/${DEVCONTAINER_NAME}
# Trigger clean (re-)build
if [ "$CLEAN_BUILD" -eq 1 ]; then
rm -rf BUILD_DIR
fi

# The most recent build will always be symlinked to cuCollections/build/latest
BUILD_DIR="$BUILD_PREFIX/$BUILD_INFIX"
mkdir -p $BUILD_DIR
rm -f ../build/latest
ln -sf $BUILD_DIR ../build/latest
export BUILD_DIR
echo $BUILD_DIR
export BUILD_DIR # TODO remove

# The most recent build will be symlinked to cuCollections/build/latest
rm -f $BUILD_PREFIX/latest
ln -sf $BUILD_DIR $BUILD_PREFIX/latest

# Now that BUILD_DIR exists, use readlink to canonicalize the path:
BUILD_DIR=$(readlink -f "${BUILD_DIR}")

BUILD_TYPE=$( [ "$DEBUG_BUILD" -eq 1 ] && echo "Debug" || echo "Release" )

CMAKE_OPTIONS="
-DCMAKE_BUILD_TYPE=Release \
-DCMAKE_BUILD_TYPE=${BUILD_TYPE} \
-DCMAKE_CXX_STANDARD=${CXX_STANDARD} \
-DCMAKE_CUDA_STANDARD=${CXX_STANDARD} \
-DCMAKE_CXX_COMPILER=${HOST_COMPILER} \
-DCMAKE_CUDA_COMPILER=${CUDA_COMPILER} \
-DCMAKE_CUDA_HOST_COMPILER=${HOST_COMPILER} \
-DCMAKE_CUDA_ARCHITECTURES=${GPU_ARCHS} \
-DCMAKE_CUDA_ARCHITECTURES=${CUDA_ARCHS} \
-DCMAKE_EXPORT_COMPILE_COMMANDS=ON \
-DBUILD_TESTS=${BUILD_TESTS} \
-DBUILD_EXAMPLES=${BUILD_EXAMPLES} \
-DBUILD_BENCHMARKS=${BUILD_BENCHMARKS} \
"

echo "========================================"
echo "Begin build"
echo "pwd=$(pwd)"
echo "NVCC_VERSION=$NVCC_VERSION"
echo "HOST_COMPILER=$HOST_COMPILER"
echo "CXX_STANDARD=$CXX_STANDARD"
echo "GPU_ARCHS=$GPU_ARCHS"
echo "PARALLEL_LEVEL=$PARALLEL_LEVEL"
echo "BUILD_DIR=$BUILD_DIR"
echo "Current commit is:"
git log -1 || echo "Not a repository"
echo "-- START: $(date)"
echo "-- GIT_SHA: $(git rev-parse HEAD 2>/dev/null || echo 'Not a repository')"
echo "-- PWD: $(pwd)"
echo "-- BUILD_DIR: ${BUILD_DIR}"
echo "-- BUILD_TYPE: ${BUILD_TYPE}"
echo "-- PARALLEL_LEVEL: ${PARALLEL_LEVEL}"
echo "-- CUDA_ARCHS: ${CUDA_ARCHS}"
echo "-- BUILD_TESTS: ${BUILD_TESTS}"
echo "-- BUILD_EXAMPLES: ${BUILD_EXAMPLES}"
echo "-- BUILD_BENCHMARKS: ${BUILD_BENCHMARKS}"

# configure
cmake -S .. -B $BUILD_DIR $CMAKE_OPTIONS
echo "========================================"

function configure(){
cmake -S .. -B $BUILD_DIR $CMAKE_OPTIONS
}

function build(){
if command -v sccache >/dev/null; then
source "./sccache_stats.sh" start
cmake --build $BUILD_DIR --parallel $PARALLEL_LEVEL
echo "Build complete"
source "./sccache_stats.sh" end
}
fi

#build
cmake --build $BUILD_DIR --parallel $PARALLEL_LEVEL
echo "========================================"
echo "Build complete"

configure
build
if command -v sccache >/dev/null; then
source "./sccache_stats.sh" end
else
echo "sccache stats: N/A"
fi
Loading

0 comments on commit f3b82b2

Please sign in to comment.