v3.9 update (#2203)
* v3.9 update * voidD --------- Co-authored-by: yuzhai <yuzhai@nvidia.com>
This commit is contained in:
Yujia Zhai
119
media/docs/cpp/build/building_in_windows_with_visual_studio.md
Normal file
119
media/docs/cpp/build/building_in_windows_with_visual_studio.md
Normal file
@@ -0,0 +1,119 @@
|
||||
# Building on Windows with Visual Studio
|
||||
|
||||
CUTLASS 3.2 reintroduces support for the Microsoft Visual Studio compiler on Windows.
|
||||
Users and developers may build either
|
||||
in Visual Studio's graphical integrated development environment,
|
||||
or on the command line with `cmake --build`.
|
||||
|
||||
# Software prerequisites
|
||||
|
||||
1. Windows 10 or 11
|
||||
|
||||
2. Visual Studio 2019 version 16.11.27, or Visual Studio 2022
|
||||
|
||||
3. CUDA Toolkit (at least 12.2; earlier 12.x versions may work)
|
||||
|
||||
4. CMake (at least 3.18)
|
||||
|
||||
5. git
|
||||
|
||||
6. Python (at least 3.6)
|
||||
|
||||
Visual Studio must be installed *before* the CUDA Toolkit.
|
||||
Otherwise, Visual Studio's build system won't know about CUDA.
|
||||
|
||||
# Operating system settings
|
||||
|
||||
By default, Windows restricts the maximum file path length (`MAX_PATH`) to 260 characters.
|
||||
CUTLASS has many files and directory paths that challenge this requirement.
|
||||
As a result, CUTLASS is unlikely to build with this default setting.
|
||||
The choice of source and build directories affect path lengths,
|
||||
so the kinds of errors and whether they occur may depend on this.
|
||||
Symptoms may vary, from errors when running `cmake`
|
||||
(e.g., during the "generating library instances" step) to build failures.
|
||||
|
||||
CUTLASS recommends changing the maximum file path length setting
|
||||
and rebooting the computer before attempting to clone or build CUTLASS.
|
||||
Windows 10 (as of version 1607) and 11 permit changing this setting
|
||||
by making sure that the following registry key exists,
|
||||
and that its value is set to 1.
|
||||
|
||||
```
|
||||
Computer\HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\FileSystem\LongPathsEnabled
|
||||
```
|
||||
|
||||
After changing the registry key's value, reboot the computer first
|
||||
before attempting to clone or build CUTLASS.
|
||||
|
||||
[This Microsoft help article](https://learn.microsoft.com/en-us/windows/win32/fileio/maximum-file-path-limitation?tabs=registry)
|
||||
explains different ways to change the registry setting.
|
||||
|
||||
# Set up build environment
|
||||
|
||||
1. Run "git bash" to get a familiar command-line interface
|
||||
|
||||
2. Edit `~/.profile` and set the environment variables as needed to access the CUTLASS repository
|
||||
|
||||
3. Clone the CUTLASS repository
|
||||
|
||||
4. Create the `build` subdirectory in the CUTLASS clone directory, and run CMake in it,
|
||||
specifying whatever CMake options are desired, e.g.,
|
||||
`cmake .. -DCUTLASS_NVCC_ARCHS=90a`
|
||||
|
||||
Alternate approaches may rely on the CMake GUI and/or Windows' native command line.
|
||||
|
||||
# Building
|
||||
|
||||
A successful CMake run will create a `CUTLASS.sln` Visual Studio "solution" file in the build directory.
|
||||
One can open this in Visual Studio and build the entire solution or any subset of projects as desired.
|
||||
It may be necessary to limit maximum build parallelism by setting the appropriate Visual Studio option.
|
||||
|
||||
Alternately, one can run `cmake --build . --config Release -j 4` in the build directory.
|
||||
Replace 4 with the desired maximum build parallelism.
|
||||
It's important to put the `--build` option before the period that signifies the build directory.
|
||||
The `--config` option specifies the kind of build;
|
||||
`--config Release` builds a Release build, while `--config Debug` builds a Debug build.
|
||||
Unlike with CMake's Makefile or Ninja generators,
|
||||
`CMAKE_BUILD_TYPE` has no effect on the Visual Studio generator,
|
||||
because the Visual Studio generator creates all build configurations.
|
||||
|
||||
# Tips
|
||||
|
||||
With Windows builds, one may find that CMake reruns unnecessarily.
|
||||
For example, cancelling a build and starting it again may rerun CMake.
|
||||
This will in turn touch build files that result in unnecessary rebuilds.
|
||||
One work-around is to set the CMake option `CMAKE_SUPPRESS_REGENERATION=ON`.
|
||||
However, this turns off CMake's ability to detect on its own when it needs to rerun.
|
||||
As a result, one will need to know when to rerun CMake by hand.
|
||||
|
||||
## Copyright
|
||||
|
||||
Copyright (c) 2017 - 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
|
||||
SPDX-License-Identifier: BSD-3-Clause
|
||||
|
||||
```
|
||||
Redistribution and use in source and binary forms, with or without
|
||||
modification, are permitted provided that the following conditions are met:
|
||||
|
||||
1. Redistributions of source code must retain the above copyright notice, this
|
||||
list of conditions and the following disclaimer.
|
||||
|
||||
2. Redistributions in binary form must reproduce the above copyright notice,
|
||||
this list of conditions and the following disclaimer in the documentation
|
||||
and/or other materials provided with the distribution.
|
||||
|
||||
3. Neither the name of the copyright holder nor the names of its
|
||||
contributors may be used to endorse or promote products derived from
|
||||
this software without specific prior written permission.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
||||
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
||||
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||||
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
||||
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
||||
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
||||
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
```
|
||||
88
media/docs/cpp/build/building_with_clang_as_host_compiler.md
Normal file
88
media/docs/cpp/build/building_with_clang_as_host_compiler.md
Normal file
@@ -0,0 +1,88 @@
|
||||
# Building with Clang as host compiler
|
||||
|
||||
CUTLASS 3.2(.1) reintroduces support for building with
|
||||
Clang as host compiler, and NVCC as device compiler.
|
||||
This is NOT the same as building with
|
||||
Clang as both host and device compiler ("CUDA Clang").
|
||||
|
||||
# Software prerequisites
|
||||
|
||||
1. Clang (regularly tested with Clang 17;
|
||||
occasionally tested with Clang 10 and greater)
|
||||
|
||||
2. CUDA Toolkit (tested with 12.2; other versions likely work)
|
||||
|
||||
3. CMake (at least 3.18)
|
||||
|
||||
4. git
|
||||
|
||||
5. Python (at least 3.6)
|
||||
|
||||
Experience with Ubuntu 22.04 LTS is that
|
||||
clang requires the following packages to be installed.
|
||||
|
||||
```bash
|
||||
$ sudo apt-get install clang cmake ninja-build pkg-config libgtk-3-dev liblzma-dev libstdc++-12-dev
|
||||
```
|
||||
|
||||
A symptom of not installing all needed dependencies
|
||||
is the following error when attempting to use clang:
|
||||
`"/usr/bin/ld: cannot find -lstdc++: No such file or directory"`.
|
||||
|
||||
# Running CMake
|
||||
|
||||
## Required CMake options
|
||||
|
||||
The Clang build requires specifying the following CMake options.
|
||||
Replace `<path-to-clang++>` with the path to your `clang++` executable.
|
||||
You may use `clang++` directly if it is in your `PATH`.
|
||||
|
||||
* `CMAKE_CXX_COMPILER=<path-to-clang++>`
|
||||
* `CMAKE_CUDA_HOST_COMPILER=<path-to-clang++>`
|
||||
|
||||
One must set both! It's not enough just to set the `CXX` environment
|
||||
variable, for example. Symptoms of only setting `CMAKE_CXX_COMPILER`
|
||||
(or only setting the `CXX` environment variable) include `cc1plus`
|
||||
(GCC's compiler executable) reporting build errors due to it not
|
||||
understanding Clang's command-line options.
|
||||
|
||||
Users can also specify a particular CUDA Toolkit version
|
||||
by setting the CMake option `CMAKE_CUDA_COMPILER`
|
||||
to the path to the `nvcc` executable
|
||||
that lives in the CUDA Toolkit's directory. For example,
|
||||
if `${PATH_TO_CUDA_TOOLKIT}` is the CUDA Toolkit directory,
|
||||
then one can set `CMAKE_CUDA_COMPILER` as follows.
|
||||
|
||||
* `CMAKE_CUDA_COMPILER=${PATH_TO_CUDA_TOOLKIT}/bin/nvcc`
|
||||
|
||||
## Copyright
|
||||
|
||||
Copyright (c) 2017 - 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
|
||||
SPDX-License-Identifier: BSD-3-Clause
|
||||
|
||||
```
|
||||
Redistribution and use in source and binary forms, with or without
|
||||
modification, are permitted provided that the following conditions are met:
|
||||
|
||||
1. Redistributions of source code must retain the above copyright notice, this
|
||||
list of conditions and the following disclaimer.
|
||||
|
||||
2. Redistributions in binary form must reproduce the above copyright notice,
|
||||
this list of conditions and the following disclaimer in the documentation
|
||||
and/or other materials provided with the distribution.
|
||||
|
||||
3. Neither the name of the copyright holder nor the names of its
|
||||
contributors may be used to endorse or promote products derived from
|
||||
this software without specific prior written permission.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
||||
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
||||
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||||
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
||||
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
||||
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
||||
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
```
|
||||
Reference in New Issue
Block a user